Feature/env

.commitlintrc.ts

@@ -4,11 +4,6 @@ import { RuleConfigSeverity } from '@commitlint/types';
 const Configuration: UserConfig = {
   extends: ['@commitlint/config-conventional'],
   rules: {
-    'type-enum': [
-      RuleConfigSeverity.Error,
-      'always',
-      ['build', 'chore', 'ci', 'docs', 'feat', 'fix', 'perf', 'refactor', 'revert', 'style', 'test', 'delete'],
-    ],
     'scope-empty': [RuleConfigSeverity.Error, 'never'],
     'subject-empty': [RuleConfigSeverity.Error, 'never'],
   },

.github/workflows/enforce-labels.yml

@@ -22,10 +22,10 @@ jobs:
         with:
           REQUIRED_LABELS_ANY: 'patch,minor,major,norelease'
           REQUIRED_LABELS_ANY_DESCRIPTION: "Select at least one label ['patch', 'minor', 'major', 'norelease']"
-  
+
   if-label-norelease-stop:
     name: No bump version if label 'norelease'
-    needs: enforce-label-version-release 
+    needs: enforce-label-version-release
     if: ${{ !contains(github.event.pull_request.labels.*.name, 'norelease') }}
     runs-on: ubuntu-latest
     steps:

.github/workflows/tests.yml

@@ -48,13 +48,41 @@ jobs:
         uses: actions/checkout@v4
 
       - name: Install dependencies
-        run: npm install
+        run: |
+          npm install -g @sap/cds-dk ts-node typescript
+          npm install
 
-      - name: Instal SAP CDS-DK
-        run: npm i -g @sap/cds-dk ts-node
-
-      - name: Instal Globally typescript
-        run: npm i -g typescript
+      - name: Build project
+        run: npm run build
 
       - name: Start server and start e2e tests
         run: npm run test:e2e
+
+  # This decorator is a special decorator which needs an extensive testing due to creation of:
+  # - @dispatcher folder
+  # - injection of @dispatcher folder inside of the package.json - imports
+  # - injection of @dispatcher folder inside of the tsconfig.json - include
+  # - injection of @dispatcher folder inside of the .gitignore
+  test-env-decorator:
+    name: Test @Env decorator
+    strategy:
+      matrix:
+        version: [20, 18]
+        platform: [ubuntu-latest, windows-latest, macos-latest]
+
+    runs-on: ${{ matrix.platform }}
+
+    steps:
+      - name: Get code
+        uses: actions/checkout@v4
+
+      - name: Install dependencies
+        run: |
+          npm install -g @sap/cds-dk ts-node typescript
+          npm install
+
+      - name: Build project
+        run: npm run build
+
+      - name: Verify @decorator folder, index.ts file, and content
+        run: ts-node ./postinstall/util/Verifier.ts

.gitignore

@@ -92,7 +92,12 @@ out
 
 # Nuxt.js build / generate output
 .nuxt
-dist
+
+# Ignore everything in dist
+/dist/*
+
+# But not the postinstall folder
+!/dist/postinstall/
 
 # Gatsby files
 .cache/
@@ -132,4 +137,8 @@ dist
 .yarn/install-state.gz
 .pnp.*
 .npmrc
-@cds-models
+@cds-models
+@dispatcher
+
+# But not the @dispatcher folder from the test
+!/test/bookshop/@dispatcher

README.md

@@ -61,6 +61,7 @@ The goal of **CDS-TS-Dispatcher** is to significantly reduce the boilerplate cod
       - [@SingleInstanceSwitch](#singleinstanceswitch)
       - [@ValidationResults](#validationresults)
       - [@Locale](#locale)
+      - [@Env](#env)
     - [`Method`-`active entity`](#method-active-entity)
       - [`Before`](#before)
         - [@BeforeCreate](#beforecreate)
@@ -169,26 +170,32 @@ npm install @dxfrontier/cds-ts-dispatcher
     "esModuleInterop": true,
     "skipLibCheck": true,
     "allowJs": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "strictNullChecks": true,
     "strictPropertyInitialization": false,
     "forceConsistentCasingInFileNames": true,
     "allowSyntheticDefaultImports": true,
-    "strictNullChecks": true,
-    "target": "ES2022",
-    "module": "NodeNext",
-    "moduleResolution": "NodeNext",
 
-    /* Allow decorators */
+    /* Strictness */
+    "strict": true,
+
+    /* Decorators */
     "experimentalDecorators": true,
     "emitDecoratorMetadata": true,
 
-    /* Strictness */
-    "strict": true,
+    "target": "ES2021",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
 
-    "lib": ["es2022"],
+    "outDir": "./gen/srv",
+    "rootDir": ".",
 
-    "outDir": "./gen/srv"
+    "paths": {
+      "#cds-models/*": ["./@cds-models/*/index.ts"]
+    }
   },
-  "include": ["./srv"]
+  "include": ["./srv", "./@dispatcher"]
 }
 ```
 
@@ -256,27 +263,34 @@ tsc --init
     "esModuleInterop": true,
     "skipLibCheck": true,
     "allowJs": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "strictNullChecks": true,
     "strictPropertyInitialization": false,
     "forceConsistentCasingInFileNames": true,
     "allowSyntheticDefaultImports": true,
-    "strictNullChecks": true,
-    "target": "ES2022",
-    "module": "NodeNext",
-    "moduleResolution": "NodeNext",
 
-    /* Allow decorators */
+    /* Strictness */
+    "strict": true,
+
+    /* Decorators */
     "experimentalDecorators": true,
     "emitDecoratorMetadata": true,
 
-    /* Strictness */
-    "strict": true,
+    "target": "ES2021",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
 
-    "lib": ["es2022"],
+    "outDir": "./gen/srv",
+    "rootDir": ".",
 
-    "outDir": "./gen/srv"
+    "paths": {
+      "#cds-models/*": ["./@cds-models/*/index.ts"]
+    }
   },
-  "include": ["./srv"]
+  "include": ["./srv", "./@dispatcher"]
 }
+
 ```
 
 7. Run the `CDS-TS` server
@@ -1670,6 +1684,74 @@ public async beforeCreate(
 ```
 <p align="right">(<a href="#table-of-contents">back to top</a>)</p>
 
+##### @Env
+
+**@Env**
+
+The `@Env` decorator is a parameter decorator used to inject values from the cds.env configuration object directly into a method parameter.
+
+`Parameters`
+
+- `env (string)`: A string path representing a property from `cds.env`. This path follows the format `property string path`, which allows access to deeply nested configuration properties.
+  - E.g. : `'requires.db.credentials.url'` corresponds to **cds.env.requires.db.credentials.url** object.
+
+
+`Return` :
+
+- The decorator returns the value of the specified `cds.env` property value.
+
+`Example`
+
+```ts
+// Generated import inside of your package.json when you run 'npm install' or install the cds-ts-dispatcher
+import { CDS_ENV } from '@dispatcher';  
+
+@BeforeCreate()
+public async beforeCreate(
+  @Req() req: TypedRequest<MyEntity>,
+  @Env<CDS_ENV>('requires.db.credentials.url') dbUrl: CDS_ENV['requires']['db']['credentials']['url'],
+  // or @Env<CDS_ENV>('requires.db.credentials.url') dbUrl: string
+  // or @Env<CDS_ENV>('requires.db.credentials.url') dbUrl: any
+  // or any other type if you do not want to use the CDS_ENV generated types
+) {
+  if (dbUrl) {
+    // handle logic using dbUrl
+  }
+}
+```
+> [!NOTE]
+> When you install cds-ts-dispatcher `(e.g. npm install @dxfrontier/cds-ts-dispatcher)` or run a general `npm install`, the following will be generated or updated : 
+> - New `@dispatcher` folder is generated at the project ***root***. 
+> This folder contains the `CDS ENV TS interfaces`, generated based on the structure of your current `cds.env` project specific configuration (retrieved from `cds env get` cli command).
+> ```text
+> ...
+> @dispatcher
+> ...
+> ```
+> - `package.json` will be updated with a new `import`:
+> ```json
+>  "imports": {
+>    "#dispatcher": "./@dispatcher/index.js"
+>  }
+> ```
+> - `tsconfig.json` will be updated:  
+> ```json
+>  "include": [
+>    "...",
+>    "./@dispatcher"
+>  ]
+> ```
+> - `.gitignore` will be updated::
+> ```text
+> ...
+> @dispatcher
+> ```
+
+> [!NOTE] 
+> The `@dispatcher` folder is ***regenerated each time you run npm install.***
+
+<p align="right">(<a href="#table-of-contents">back to top</a>)</p>
+
 #### `Method`-`active entity`
 
 ##### `Before`