@cap-js/cds-typer 0.33.1 → 0.34.0

package/cds-plugin.js

@@ -5,9 +5,12 @@ const util = require('util')
 const exec = util.promisify(require('child_process').exec)
 const typer = require('./lib/compile')
 const { fs, path } = cds.utils
+const { configuration } = require('./lib/config')
+
 const DEBUG = cds.debug('cli|build')
 const BUILD_CONFIG = 'tsconfig.cdsbuild.json'
-const { configuration } = require('./lib/config')
+const DEFAULT_MODEL_DIRECTORY_NAME = '@cds-models'
+
 
 /**
  * Check if the project is a TypeScript project by looking for a dependency on TypeScript.
@@ -54,6 +57,15 @@ const rmFiles = async (dir, exts) => fs.existsSync(dir)
 
 // IIFE to be able to return early
 ;(() => {
+    if (cds.watched) {
+        if (fs.existsSync(cds.env.typer.output_directory)) return
+        DEBUG?.('>> start cds-typer before cds watch')
+        module.exports = typer.compileFromFile('*')
+            .then(() => DEBUG?.('<< end cds-typer before cds watch'))
+            .catch(e => DEBUG?.(e))
+        return
+    }
+
     // FIXME: remove once cds7 has been phased out
     if (!cds?.version || cds.version < '8.0.0') {
         DEBUG?.('typescript build task requires @sap/cds-dk version >= 8.0.0, skipping registration')
@@ -94,7 +106,7 @@ const rmFiles = async (dir, exts) => fs.existsSync(dir)
             } catch {
                 DEBUG?.('tsconfig.json not found, not parsable, or inconclusive. Using default model directory name')
             }
-            return '@cds-models'
+            return DEFAULT_MODEL_DIRECTORY_NAME
         }
 
         init() {
@@ -151,4 +163,4 @@ const rmFiles = async (dir, exts) => fs.existsSync(dir)
             this.#copyCleanModel(buildDirCdsModels)
         }
     })
-})()
+})()

package/lib/cli.js

@@ -174,7 +174,7 @@ const flags = enrichFlagSchema({
     },
     useEntitiesProxy: parameterTypes.boolean({
         desc: `If set to true the 'cds.entities' exports in the generated 'index.js'${EOL}files will be wrapped in 'Proxy' objects\nso static import/require calls can be used everywhere.${EOL}${EOL}WARNING: entity properties can still only be accessed after${EOL}'cds.entities' has been loaded`,
-        default: 'false'
+        default: 'true'
     }),
     version: {
         desc: 'Prints the version of this tool.'
@@ -185,7 +185,7 @@ const flags = enrichFlagSchema({
         default: 'flat'
     },
     propertiesOptional: parameterTypes.boolean({
-        desc: `If set to true, properties in entities are${EOL}always generated as optional (a?: T).`,
+        desc: `If set to true, properties in entities are${EOL}always generated as optional (a?: T).${EOL}Setting it to false makes properties non-optional instead (a: T).`,
         default: 'true'
     }),
     IEEE754Compatible: parameterTypes.boolean({
@@ -204,7 +204,12 @@ const flags = enrichFlagSchema({
     buildTask: parameterTypes.boolean({
         desc: `If set to true, the typescript build task will not be registered/ executed.${EOL}This value must be set in your project configuration.${EOL}Passing it as parameter to the cds-typer CLI has no effect.`,
         default: 'true'
-    })
+    }),
+    cache: {
+        desc: `How to cache typer runs.${EOL}none: fully run cds-typer whenever it is called${EOL}blake2s256: only run if the blake2s256-hash of the model has changed. Hash is stored in a file between runs.`,
+        allowed: ['none', 'blake2s256'],
+        default: 'none'
+    }
 })
 
 const hint = () => 'Missing or invalid parameter(s). Call with --help for more details.'

package/lib/compile.js

@@ -1,13 +1,35 @@
 'use strict'
 
 const fs = require('fs')
-const { normalize } = require('path')
+const { normalize, join } = require('path')
 const cds = require(require.resolve('@sap/cds', { paths: [process.cwd(), __dirname] }))
 const util = require('./util')
 const { writeout } = require('./file')
 const { Visitor } = require('./visitor')
 const { LOG, setLevel } = require('./logging')
 const { configuration } = require('./config')
+const cdsTyperVersion = process.env.npm_package_version
+    ?? require('../package.json').version
+
+/**
+ * @param {JSON} csn - the model
+ * @param {string} hashFile - path to the hash file
+ * @returns {[boolean, string]}
+ */
+const checkHash = (csn, hashFile) => {
+    const crypto = require('crypto')
+    const currentHash = crypto
+        .createHash('blake2s256')
+        .update(JSON.stringify({'cds-typer-version': cdsTyperVersion, csn}))
+        .digest('hex')
+    if (fs.existsSync(hashFile)) {
+        const oldHash = fs.readFileSync(hashFile, 'utf8')
+        if (oldHash === currentHash) {
+            return [false, currentHash]
+        }
+    }
+    return [true, currentHash]
+}
 
 /**
  * Writes the accompanying jsconfig.json file to the specified paths.
@@ -39,11 +61,11 @@ const writeJsConfig = path => {
  * @param {{xtended: import('./typedefs').resolver.CSN, inferred: import('./typedefs').resolver.CSN}} csn - csn tuple
  */
 const compileFromCSN = async csn => {
-
     setLevel(configuration.logLevel)
     if (configuration.jsConfigPath) {
         writeJsConfig(configuration.jsConfigPath)
     }
+
     return writeout(
         configuration.outputDirectory,
         Object.values(new Visitor(csn).getWriteoutFiles())
@@ -55,10 +77,31 @@ const compileFromCSN = async csn => {
  * @param {string | string[]} inputFile - path to input .cds file
  */
 const compileFromFile = async inputFile => {
+    const hashFile = join(configuration.outputDirectory, '.hash')
     const paths = typeof inputFile === 'string' ? normalize(inputFile) : inputFile.map(f => normalize(f))
-    const xtended = await cds.linked(await cds.load(paths, { docs: true, flavor: 'xtended' }))
+    const xtendedPlain = await cds.load(paths, { docs: true, flavor: 'xtended' })
+    let modelHash
+
+    if (configuration.cache === 'blake2s256') {
+        const [shouldCompile, hash] = checkHash(xtendedPlain, hashFile)
+        if (!shouldCompile) {
+            LOG.info('Model has not changed. Skipping generation.')
+            return
+        }
+        modelHash = hash
+    }
+
+    const xtended = await cds.linked(xtendedPlain)
     const inferred = await cds.linked(await cds.load(paths, { docs: true }))
-    return compileFromCSN({xtended, inferred})
+    const result = await compileFromCSN({xtended, inferred})
+
+    if (modelHash) {
+        // write hash as last thing before returning,
+        // so that we don't write it if an error occurs,
+        // which would block the next run although the model has changed
+        fs.writeFileSync(hashFile, modelHash)
+    }
+    return result
 }
 
 module.exports = {

package/lib/typedefs.d.ts

@@ -188,6 +188,7 @@ export module config {
 
     export type Configuration = {
         outputDirectory: string,
+        cache: 'none' | 'blake2s256'
         logLevel: number,
         /**
          * `useEntitiesProxy = true` will wrap the `module.exports.<entityName>` in `Proxy` objects

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js/cds-typer",
-  "version": "0.33.1",
+  "version": "0.34.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",
@@ -16,8 +16,8 @@
     "test:unit": "node test/testRunner.js ./test/unit ./test/unit/setup.mjs",
     "test:integration": "node test/testRunner.js ./test/integration ./test/integration/setup.mjs",
     "test:smoke": "node test/testRunner.js ./test/smoke ./test/smoke/setup.mjs",
-    "test:all": "npm run test:smoke && npm run test:unit",
-    "test": "npm run test:smoke && npm run test:unit",
+    "test:all": "npm run test:smoke && npm run test:unit && npm run test:integration",
+    "test": "npm run test:all",
     "lint": "npx eslint .",
     "lint:fix": "npx eslint . --fix",
     "cli": "node lib/cli.js",
@@ -45,7 +45,6 @@
   },
   "devDependencies": {
     "@cap-js/cds-types": "^0",
-    "@sap/cds": "^8",
     "@stylistic/eslint-plugin-js": "^4.2.0",
     "acorn": "^8.10.0",
     "eslint": "^9",
@@ -58,7 +57,7 @@
       "inline_declarations": "flat",
       "target_module_type": "auto",
       "properties_optional": true,
-      "use_entities_proxy": false,
+      "use_entities_proxy": true,
       "build_task": true
     },
     "schema": {
@@ -71,6 +70,15 @@
           "type": "object",
           "description": "Configuration for CDS Typer",
           "properties": {
+            "cache": {
+              "type": "string",
+              "description": "How to cache typer runs.\nnone: fully run cds-typer whenever it is called\nblake2s256: only run if the blake2s256-hash of the model has changed. Hash is stored in a file between runs.",
+              "enum": [
+                "none",
+                "blake2s256"
+              ],
+              "default": "none"
+            },
             "output_directory": {
               "type": "string",
               "description": "Root directory to write the generated files to.",
@@ -101,7 +109,7 @@
             "use_entities_proxy": {
               "type": "boolean",
               "description": "If set to true the 'cds.entities' exports in the generated 'index.js'\nfiles will be wrapped in 'Proxy' objects\nso static import/require calls can be used everywhere.\n\nWARNING: entity properties can still only be accessed after\n'cds.entities' has been loaded",
-              "default": false
+              "default": true
             },
             "inline_declarations": {
               "type": "string",
@@ -114,7 +122,7 @@
             },
             "properties_optional": {
               "type": "boolean",
-              "description": "If set to true, properties in entities are\nalways generated as optional (a?: T).",
+              "description": "If set to true, properties in entities are\nalways generated as optional (a?: T).\nSetting it to false makes properties non-optional instead (a: T).",
               "default": true
             },
             "ieee754compatible": {