@sap/cds 6.0.3 → 6.1.1

package/lib/env/schemas/cds-rc.json

@@ -0,0 +1,614 @@
+{
+  "title": "JSON schema for CDS configuration",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "description": "This is a JSON schema representation for CDS project configuration",
+  "type": "object",
+  "additionalProperties": true,
+  "properties": {
+    "folders": {
+      "type": "object",
+      "description": "Set folders if you don't want to use the defaults 'app', 'db', 'srv'.",
+      "additionalProperties": true,
+      "properties": {
+        "app": {
+          "type": "string",
+          "format": "uri-reference",
+          "default": "app",
+          "description": "Path for app folder."
+        },
+        "db": {
+          "type": "string",
+          "format": "uri-reference",
+          "default": "db",
+          "description": "Path for db folder."
+        },
+        "srv": {
+          "type": "string",
+          "format": "uri-reference",
+          "default": "srv",
+          "description": "Path for srv folder."
+        }
+      },
+      "patternProperties": {
+        ".+": {
+          "description": "A static name identifying this folder."
+        }
+      }
+    },
+    "build": {
+      "type": "object",
+      "description": "CDS build settings.",
+      "additionalProperties": true,
+      "properties": {
+        "target": {
+          "type": "string",
+          "description": "The folder which contains generated build results. Defaults to 'gen'.",
+          "format": "uri-reference",
+          "default": "gen"
+        },
+        "tasks": {
+          "type": "array",
+          "description": "Controls which tasks cds build will execute on your project modules.",
+          "uniqueItems": true,
+          "items": {
+            "type": "object",
+            "additionalProperties": true,
+            "properties": {
+              "dest": {
+                "type": "string",
+                "description": "Destination folder for this build task relative to build target folder.",
+                "format": "uri-reference"
+              },
+              "src": {
+                "type": "string",
+                "description": "Source folder for this build task.",
+                "format": "uri-reference"
+              },
+              "for": {
+                "type": "string",
+                "description": "Target technology for this build task.",
+                "minLength": 1,
+                "enum": [
+                  "nodejs",
+                  "java",
+                  "hana",
+                  "mtx-sidecar",
+                  "mtx",
+                  "fiori",
+                  "node-cf",
+                  "java-cf"
+                ]
+              },
+              "options": {
+                "type": "object",
+                "description": "Set target technology specific options for this build task.",
+                "additionalProperties": true,
+                "properties": {
+                  "model": {
+                    "$ref": "#/$defs/foldersStringArray"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "i18n": {
+      "type": "object",
+      "description": "CDS translation settings.",
+      "additionalProperties": true,
+      "properties": {
+        "default_language": {
+          "type": "string",
+          "default": "en"
+        },
+        "folders": {
+          "description": "List of language file folders. First valid entry wins.",
+          "default": [
+            "_i18n",
+            "i18n",
+            "assets/i18n"
+          ],
+          "$ref": "#/$defs/foldersStringArray"
+        }
+      }
+    },
+    "deploy": {
+      "type": "object",
+      "description": "CDS deploy settings.",
+      "additionalProperties": true,
+      "properties": {
+        "no_save": {
+          "type": "boolean",
+          "description": "Do / don't update config in package.json.",
+          "default": true
+        }
+      }
+    },
+    "extends": {
+      "description": "Name of the application that shall be extended",
+      "type": "string"
+    },
+    "requires": {
+      "type": "object",
+      "description": "CDS Dependencies to databases and services can be configured by listing them within a requires section.",
+      "additionalProperties": true,
+      "properties": {
+        "auth": {
+          "oneOf": [
+            {
+              "type": "string",
+              "description": "Auth-specific settings via shortcut.",
+              "anyOf": [
+                {
+                  "$ref": "#/$defs/authType"
+                },
+                {
+                  "minLength": 1
+                }
+              ]
+            },
+            {
+              "type": "object",
+              "description": "Authentication settings.",
+              "default": {
+                "kind": "mocked"
+              },
+              "additionalProperties": true,
+              "properties": {
+                "kind": {
+                  "type": "string",
+                  "description": "Kind of dependency.",
+                  "anyOf": [
+                    {
+                      "$ref": "#/$defs/authType"
+                    },
+                    {
+                      "minLength": 1
+                    }
+                  ]
+                },
+                "users": {
+                  "$ref": "#/$defs/mockUsers"
+                },
+                "credentials": {
+                  "type": "object",
+                  "description": "Can be explicitly configured here, but will be overruled by VCAP_SERVICES if a matching entry is found therein.",
+                  "additionalProperties": true,
+                  "properties": {
+                    "database": {
+                      "type": "string",
+                      "format": "uri-reference"
+                    }
+                  }
+                }
+              }
+            }
+          ]
+        },
+        "db": {
+          "oneOf": [
+            {
+              "type": "string",
+              "description": "Database specific settings via shortcut.",
+              "anyOf": [
+                {
+                  "$ref": "#/$defs/databaseType"
+                },
+                {
+                  "minLength": 1
+                }
+              ]
+            },
+            {
+              "type": "object",
+              "description": "Database specific settings.",
+              "default": {
+                "kind": "sqlite"
+              },
+              "additionalProperties": true,
+              "properties": {
+                "kind": {
+                  "type": "string",
+                  "description": "Kind of dependency.",
+                  "anyOf": [
+                    {
+                      "$ref": "#/$defs/databaseType"
+                    },
+                    {
+                      "minLength": 1
+                    }
+                  ]
+                },
+                "model": {
+                  "description": "Assigned model. Interpreted like Node.js 'requires' logic.",
+                  "$ref": "#/$defs/foldersStringArray"
+                },
+                "credentials": {
+                  "type": "object",
+                  "description": "Can be explicitly configured here, but will be overruled by VCAP_SERVICES if a matching entry is found therein.",
+                  "additionalProperties": true,
+                  "properties": {
+                    "database": {
+                      "type": "string",
+                      "format": "uri-reference"
+                    }
+                  }
+                },
+                "vcap": {
+                  "type": "object",
+                  "description": "Can optionally be used to select entry in VCAP_SERVICES.",
+                  "additionalProperties": true,
+                  "properties": {
+                    "name": {
+                      "type": "string",
+                      "minLength": 1
+                    }
+                  }
+                }
+              }
+            }
+          ]
+        },
+        "multitenancy": {
+          "type": "boolean",
+          "description": "Shortcut to enable multitenancy"
+        },
+        "extensibility": {
+          "type": "boolean",
+          "description": "Shortcut to enable extensibility"
+        },
+        "toggles": {
+          "type": "boolean",
+          "description": "Shortcut to enable feature toggles"
+        },
+        "cds.xt.ModelProviderService": {
+          "description": "Serves model variants, which may include tenant-specific extensions and/or feature-toggled aspects",
+          "oneOf": [
+            {
+              "$ref": "#/$defs/serviceActivation"
+            },
+            {
+              "$ref": "#/$defs/servicePresetSidecar"
+            },
+            {
+              "type": "object",
+              "description": "Configuration options",
+              "additionalProperties": true,
+              "properties": {
+                "root": {
+                  "type": "string",
+                  "description": "A directory name, absolute or relative to the package.json’s location, specifying the location to search for models and resources to be served by the model provider services. Default is undefined, for embedded usage of model provider. In case of a sidecar, it refers to the main app’s model; usually '../..' during development, and '_main' in production",
+                  "format": "uri-reference"
+                }
+              }
+            }
+          ]
+        },
+        "cds.xt.ExtensibilityService": {
+          "description": "Allows to add and activate tenant-specific extensions at runtime",
+          "oneOf": [
+            {
+              "$ref": "#/$defs/serviceActivation"
+            },
+            {
+              "$ref": "#/$defs/extensionRestrictions"
+            }
+          ]
+        },
+        "cds.xt.DeploymentService": {
+          "description": "Handles subscribe, unsubscribe, and upgrade events for single tenants and single apps / micro-services",
+          "oneOf": [
+            {
+              "$ref": "#/$defs/serviceActivation"
+            },
+            {
+              "$ref": "#/$defs/servicePresetSidecar"
+            }
+          ]
+        },
+        "cds.xt.SaasProvisioningService": {
+          "description": "Facade for the DeploymentService to adapt to the API expected by SAP BTP’s SaaS Provisioning Service, hence providing out-of-the-box integration",
+          "oneOf": [
+            {
+              "$ref": "#/$defs/serviceActivation"
+            }
+          ]
+        }
+      },
+      "patternProperties": {
+        ".+": {
+          "oneOf": [
+            {
+              "type": "boolean",
+              "description": "Add this type with default settings during runtime."
+            },
+            {
+              "type": "string",
+              "description": "A shortcut referencing a predefined configuration.",
+              "anyOf": [
+                {
+                  "$ref": "#/$defs/authType"
+                },
+                {
+                  "$ref": "#/$defs/databaseType"
+                },
+                {
+                  "$ref": "#/$defs/serviceType"
+                },
+                {
+                  "minLength": 1
+                }
+              ]
+            },
+            {
+              "type": "object",
+              "default": {},
+              "additionalProperties": true,
+              "properties": {
+                "kind": {
+                  "type": "string",
+                  "description": "Kind of dependency.",
+                  "anyOf": [
+                    {
+                      "$ref": "#/$defs/authType"
+                    },
+                    {
+                      "$ref": "#/$defs/databaseType"
+                    },
+                    {
+                      "$ref": "#/$defs/serviceType"
+                    },
+                    {
+                      "minLength": 1
+                    }
+                  ]
+                },
+                "model": {
+                  "description": "Assigned model. Interpreted like Node.js 'requires' logic.",
+                  "$ref": "#/$defs/foldersStringArray"
+                }
+              }
+            }
+          ]
+        }
+      }
+    }
+  },
+  "$defs": {
+    "serviceType": {
+      "oneOf": [
+        {
+          "const": "app-service",
+          "description": "Standard app service"
+        },
+        {
+          "const": "odata",
+          "description": "Odata service"
+        },
+        {
+          "const": "odata-v2",
+          "description": "Odata service version 2"
+        },
+        {
+          "const": "odata-v4",
+          "description": "Odata service version 4"
+        },
+        {
+          "const": "rest",
+          "description": "REST service"
+        }
+      ]
+    },
+    "authType": {
+      "default": "mocked",
+      "oneOf": [
+        {
+          "const": "mocked",
+          "description": "Mocked authentication"
+        },
+        {
+          "const": "basic",
+          "description": "Basic authentication"
+        },
+        {
+          "const": "jwt",
+          "description": "JWT authentication"
+        },
+        {
+          "const": "xsuaa",
+          "description": "Authentication using XSUAA"
+        },
+        {
+          "const": "dummy",
+          "description": "Dummy authentication"
+        }
+      ]
+    },
+    "mockUsers": {
+      "type": "object",
+      "description": "List of users for local usage",
+      "properties": {
+        "*": {
+          "default": true,
+          "oneOf": [
+            {
+              "const": true,
+              "description": "Allow other users than the ones specified"
+            },
+            {
+              "const": false,
+              "description": "Block other users than the ones specified"
+            }
+          ]
+        }
+      },
+      "patternProperties": {
+        ".+": {
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "roles": {
+              "type": "array",
+              "description": "Roles of the user",
+              "uniqueItems": true,
+              "items": {
+                "type": "string"
+              }
+            },
+            "features": {
+              "type": "array",
+              "description": "Feature toggle values of the user",
+              "uniqueItems": true,
+              "items": {
+                "type": "string"
+              }
+            },
+            "tenant": {
+              "type": "string",
+              "description": "SaaS tenant of the user"
+            },
+            "userAttributes": {
+              "type": "object",
+              "description": "Additional user attributes",
+              "patternProperties": {
+                ".+": {
+                  "type": "string",
+                  "description": "Attribute value"
+                }
+              }
+            },
+            "password": {
+              "type": "string",
+              "description": "User password"
+            }
+          }
+        }
+      }
+    },
+    "databaseType": {
+      "default": "sqlite",
+      "oneOf": [
+        {
+          "const": "hana",
+          "description": "SAP HANA"
+        },
+        {
+          "const": "hana-cloud",
+          "description": "SAP HANA Cloud"
+        },
+        {
+          "const": "hana-mt",
+          "description": "Multi-tenant SAP HANA Cloud"
+        },
+        {
+          "const": "sql",
+          "description": "In-memory SQLite (development), SAP HANA (production)"
+        },
+        {
+          "const": "sql-mt",
+          "description": "File-based SQLite (development), Multi-tenant SAP HANA Cloud (production)"
+        },
+        {
+          "const": "sqlite",
+          "description": "File-based SQLite"
+        }
+      ]
+    },
+    "foldersStringArray": {
+      "oneOf": [
+        {
+          "type": "string",
+          "format": "uri-reference"
+        },
+        {
+          "type": "array",
+          "uniqueItems": true,
+          "items": {
+            "type": "string",
+            "format": "uri-reference"
+          }
+        }
+      ]
+    },
+    "serviceActivation": {
+      "type": "boolean",
+      "description": "Activate or deactivate this service"
+    },
+    "servicePresetSidecar": {
+      "type": "string",
+      "description": "'in-sidecar' preset provides defaults for usage in sidecars.\n'from-sidecar' preset is a shortcut for '{ kind: rest }'",
+      "enum": [
+        "in-sidecar",
+        "from-sidecar"
+      ]
+    },
+    "extensionRestrictions": {
+      "type": "object",
+      "description": "Extension restrictions",
+      "additionalProperties": false,
+      "properties": {
+        "element-prefix": {
+          "type": "array",
+          "description": "Field names must start with one of these strings",
+          "uniqueItems": true,
+          "items": {
+            "type": "string"
+          }
+        },
+        "namespace-blocklist": {
+          "type": "array",
+          "description": "Namespaces must not start with these strings",
+          "uniqueItems": true,
+          "items": {
+            "type": "string"
+          }
+        },
+        "extension-allowlist": {
+          "type": "array",
+          "description": "Restrictions for model entities, types, etc.",
+          "uniqueItems": true,
+          "items": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+              "for": {
+                "type": "array",
+                "description": "Restriction applies to these namespaces",
+                "uniqueItems": true,
+                "items": {
+                  "type": "string"
+                }
+              },
+              "kind": {
+                "type": "string",
+                "description": "Type of definition",
+                "default": "entity",
+                "enum": [
+                  "action",
+                  "annotation",
+                  "context",
+                  "entity",
+                  "function",
+                  "service",
+                  "type"
+                ]
+              },
+              "new-fields": {
+                "type": "integer",
+                "description": "Number of fields to be added at most",
+                "minimum": 1
+              },
+              "new-entities": {
+                "type": "integer",
+                "description": "Number of entities to be added at most",
+                "minimum": 1
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/lib/index.js

@@ -2,8 +2,8 @@
 
 const facade = class cds extends require('events') {
 
-  get env()      { return super.env = require('./env').for('cds',cds.root) }
-  get requires() { return super.requires = this.env.required_services_or_defs }
+  get env()      { return super.env = require('./env/cds-env').for('cds',cds.root) }
+  get requires() { return super.requires = this.env.requires._resolved() }
   get version()  { return super.version = require('../package.json').version }
   get builtin()  { return super.builtin = require('./core') }
   get service()  { return super.service = extend(this.builtin.classes.service) .with (_service) }
@@ -25,9 +25,9 @@ const _service = lazified ({ // nested facade for service-related modules
   /** @param x {(this:Service, srv:Service, ...etc) => any} */ impl: x=>x,
   /** @type {{ [path:string] : Service }} */ paths: {},
   /** @type Service[] */ providers: [],
-  factory: require ('./serve/factory'),
-  adapters: require ('./serve/adapters'),
-  bindings: require ('./connect/bindings'),
+  factory: require ('./srv/factory'),
+  adapters: require ('./srv/adapters'),
+  bindings: require ('./srv/bindings'),
 })
 
 /** cds is the central facade to all cds functions */
@@ -50,30 +50,30 @@ const cds = module.exports = extend (new facade) .with ({
   // Loading and Compiling Models
   model: undefined,
   compiler: require ('./compile/cdsc'),
-  compile: require ('./compile'),
+  compile: require ('./compile/cds-compile'),
   resolve: require ('./compile/resolve'),
   load: require ('./compile/load'), get: lazy => cds.load.parsed,
   parse: require ('./compile/parse'),
   minify: require ('./compile/minify'),
   extend: require ('./compile/extend'),
-  deploy: require ('./deploy'),
+  deploy: require ('./dbs/cds-deploy'),
 
   // Providing and Consuming Services
+  connect: require ('./srv/cds-connect'),
+  serve: require ('./srv/cds-serve'),
+  server: require ('../server'),
   services: new class IterableServices {
     *[Symbol.iterator]() {for (let e in this) yield this[e]}
     get _pending(){ let p={}; Object.defineProperty(this,'_pending',{value:p}); return p  }
   },
-  serve: require ('./serve'),
-  server: require ('../server'),
-  connect: require ('./connect'),
 
   // Core Services API
-  Service: require ('./serve/Service-api'),
+  Service: require ('./srv/srv-api'),
   EventContext: require ('./req/context'),
   Request: require ('./req/request'),
   Event: require ('./req/event'),
   User: require ('./req/user'),
-  ql: require ('./ql'),
+  ql: lazy => require ('./ql/cds-ql'),
   tx: (..._) => (cds.db || cds.Service.prototype) .tx (..._),
   /** @type Service */ db: undefined,
 
@@ -87,10 +87,10 @@ const cds = module.exports = extend (new facade) .with ({
 
   // Helpers
   localize: require ('./i18n/localize'),
-  error: require ('./log/errors'),
-  utils: require ('./utils'),
-  test: require ('./utils/tests'),
-  log: require ('./log'), debug: lazy => cds.log.debug,
+  error: require ('./log/cds-error'),
+  utils: require ('./utils/cds-utils'),
+  test: require ('./utils/cds-test'),
+  log: require ('./log/cds-log'), debug: lazy => cds.log.debug,
   exec: require ('../bin/cds'),
   clone: m => JSON.parse (JSON.stringify(m)),
   lazified, lazify,
@@ -151,3 +151,6 @@ if (process.env.CDS_GLOBAL) // TODO for stakeholder-tests only. Remove after cds
   Object.assign(module,{ exports: global.cds || (global.cds = cds)})
 else
   global.cds = cds
+
+// install jest util if jest is defined
+if (process.env.CDS_JEST_MEM_FIX && typeof jest !== 'undefined') require('./utils/jest.js')