@cap-js/cds-typer 0.37.0 → 0.38.0

package/lib/cli.js

@@ -149,6 +149,10 @@ const flags = enrichFlagSchema({
         default: './',
         type: 'string'
     },
+    outputDTsFiles: parameterTypes.boolean({
+        desc: '(experimental) If set to true, emits .d.ts files for each generated .js file. If set to false (default), emits .ts files instead. Note: skipLibCheck must be set to true in your tsconfig for this option to work properly.',
+        default: 'false',
+    }),
     help: {
         desc: 'This text.',
     },

package/lib/file.js

@@ -162,7 +162,7 @@ class SourceFile extends File {
      * @param {string} options.name - name of the lambda
      * @param {import('./typedefs').visitor.ParamInfo[]} [options.parameters] - list of parameters, passed as [name, modifier, type, doc] pairs
      * @param {string} [options.returns] - the return type of the function
-     * @param {string} [options.self] - what is set as "__self", which is used for bound actions
+     * @param {string} [options.self] - what is set as "__self", which is used for bound actions. For unbound actions, this will be `never` (null would lead to incorrect type reduction)
      * @param {'action' | 'function'} options.kind - kind of the lambda
      * @param {string} [options.initialiser] - the initialiser expression
      * @param {boolean} [options.isStatic] - whether the lambda is static
@@ -188,7 +188,7 @@ class SourceFile extends File {
      * stringifyLambda({name: 'f', parameters: [{name:'p',type:'T'}], returns: 'number'})  // { (p: T): number, __parameters: { p: T } }
      * ```
      */
-    static stringifyLambda({name, parameters=[], returns='any', kind, initialiser, self='null', isStatic=false, callStyles={positional:true, named:true}, doc}) {
+    static stringifyLambda({name, parameters=[], returns='any', kind, initialiser, self='never', isStatic=false, callStyles={positional:true, named:true}, doc}) {
         let docStr = doc?.length ? doc.join('\n')+'\n' : ''
         const parameterTypes = parameters.map(({name, modifier, type, doc}) => `${doc?'\n'+doc:''}${normalise(name)}${modifier}: ${type}`).join(', ')
         const parameterTypeAsObject = parameterTypes.length
@@ -825,10 +825,11 @@ const writeout = async (root, sources) =>
     Promise.all(
         sources.map(async source => {
             const dir = path.join(root, source.path.asDirectory({local: false, posix: false}))
+            const outputFile = configuration.outputDTsFiles ? 'index.d.ts' : 'index.ts'
             try {
                 await fs.mkdir(dir, { recursive: true })
                 await Promise.all([
-                    fs.writeFile(path.join(dir, 'index.ts'), source.toTypeDefs()),
+                    fs.writeFile(path.join(dir, outputFile), source.toTypeDefs()),
                     fs.writeFile(path.join(dir, 'index.js'), source.toJSExports()),
                 ])
 

package/lib/resolution/entity.js

@@ -184,7 +184,7 @@ class EntityRepository {
 
 /**
  * Derives an identifier from an entity info.
- * That identifier can be used to refer to a specific entity within an index.ts file.
+ * That identifier can be used to refer to a specific entity within an index.ts / index.d.ts file.
  * By passing a relative file, the identifier will be preceeded with a scope if needed.
  * @param {object} options - the options
  * @param {EntityInfo} options.info - the entity info

package/lib/typedefs.d.ts

@@ -189,6 +189,7 @@ export module config {
 
     export type Configuration = {
         outputDirectory: string,
+        outputDTsFiles: boolean,
         cache: 'none' | 'blake2s256'
         logLevel: number,
         /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js/cds-typer",
-  "version": "0.37.0",
+  "version": "0.38.0",
   "description": "Generates .ts files for a CDS model to receive code completion in VS Code",
   "main": "index.js",
   "repository": "github:cap-js/cds-typer",
@@ -45,7 +45,7 @@
   },
   "devDependencies": {
     "@cap-js/cds-types": "^0",
-    "@stylistic/eslint-plugin-js": "^4.2.0",
+    "@stylistic/eslint-plugin": "^5.3.1",
     "acorn": "^8.10.0",
     "eslint": "^9",
     "eslint-plugin-jsdoc": "^51.2.1",
@@ -54,6 +54,7 @@
   "cds": {
     "typer": {
       "output_directory": "@cds-models",
+      "output_d_ts_files": false,
       "inline_declarations": "flat",
       "target_module_type": "auto",
       "properties_optional": true,
@@ -84,6 +85,11 @@
               "description": "Root directory to write the generated files to.",
               "default": "@cds-models"
             },
+            "output_d_ts_files": {
+              "type": "boolean",
+              "description": "(experimental) If set to true, emits .d.ts files for each generated .js file. If set to false (default), emits .ts files instead. Note: skipLibCheck must be set to true in your tsconfig for this option to work properly.",
+              "default": false
+            },
             "log_level": {
               "type": "string",
               "description": "Minimum log level that is printed.\nThe default is only used if no explicit value is passed\nand there is no configuration passed via cds.env either.",