@sap/cds 7.5.2 → 7.6.1

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

@@ -0,0 +1,693 @@
+const cds = require('../../index')
+
+module.exports = {
+  _version: cds.version,
+
+  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,
+
+  allOf: [
+    // allow cds configuration in root of .cds-rc.js...
+    {
+      $ref: '#/$defs/cdsRoot'
+    },
+
+    // ...and underneath cds section
+    {
+      properties: {
+        cds: {
+          $ref: '#/$defs/cdsRoot'
+        }
+      }
+    }
+  ],
+
+  $defs: {
+    cdsRoot: {
+      properties: {
+        '[development]': {
+          type: 'object'
+        },
+        '[production]': {
+          type: 'object'
+        },
+        '[hybrid]': {
+          type: 'object'
+        },
+        profile: {
+          description: 'A single static profile',
+          anyOf: [
+            {
+              enum: [
+                'mtx-sidecar',
+                'with-mtx-sidecar',
+                'java'
+              ]
+            },
+            {
+              type: 'string'
+            }
+          ]
+        },
+        profiles: {
+          description: 'An array of profiles',
+          type: 'array',
+          uniqueItems: true,
+          items: {
+            $ref: '#/$defs/cdsRoot/properties/profile'
+          }
+        },
+        folders: {
+          type: 'object',
+          description: 'Only set folders if you don\'t want to use the defaults \'app/\', \'db/\', \'srv/\'.',
+          additionalProperties: true,
+          properties: {
+            app: {
+              type: 'string',
+              format: 'uri-reference',
+              description: 'Add a custom path for the app property, which becomes \'cds.roots\'.'
+            },
+            db: {
+              type: 'string',
+              format: 'uri-reference',
+              description: 'Add a custom path for the db property, which becomes \'cds.roots\'.'
+            },
+            srv: {
+              type: 'string',
+              format: 'uri-reference',
+              description: 'Add a custom path for the srv property, which becomes \'cds.roots\'.'
+            }
+          },
+          patternProperties: {
+            '.+': {
+              description: 'A static name identifying this folder.'
+            }
+          }
+        },
+        i18n: {
+          type: 'object',
+          description: 'Customize CDS translation settings.',
+          additionalProperties: true,
+          properties: {
+            default_language: {
+              type: 'string'
+            },
+            folders: {
+              description: 'Define the list of folders containing language files. Defaults are \'_i18n/\', \'i18n/\', and \'assets/i18n/\'. First valid entry wins.',
+              default: [],
+              $ref: '#/$defs/foldersStringArray'
+            }
+          }
+        },
+        requires: {
+          type: 'object',
+          description: 'List CDS dependencies to databases and services within the requires section.',
+          additionalProperties: true,
+          properties: {
+            auth: {
+              oneOf: [
+                {
+                  type: 'string',
+                  description: 'Use standard auth-specific settings via shortcut.',
+                  anyOf: [
+                    {
+                      $ref: '#/$defs/authType'
+                    },
+                    {
+                      minLength: 1
+                    }
+                  ]
+                },
+                {
+                  type: 'object',
+                  description: 'Use custom authentication settings.',
+                  default: {},
+                  additionalProperties: true,
+                  properties: {
+                    kind: {
+                      type: 'string',
+                      description: 'Define the kind of strategy.',
+                      anyOf: [
+                        {
+                          $ref: '#/$defs/authType'
+                        },
+                        {
+                          minLength: 1
+                        }
+                      ]
+                    },
+                    users: {
+                      $ref: '#/$defs/mockUsers'
+                    },
+                    credentials: {
+                      type: 'object',
+                      description: 'You can explicitly configure credentials, but this is 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: 'Use standard database-specific settings via shortcut.',
+                  anyOf: [
+                    {
+                      $ref: '#/$defs/databaseType'
+                    },
+                    {
+                      minLength: 1
+                    }
+                  ]
+                },
+                {
+                  type: 'object',
+                  description: 'Use custom database-specific settings.',
+                  default: {},
+                  additionalProperties: true,
+                  properties: {
+                    kind: {
+                      type: 'string',
+                      description: 'Define the kind of dependency.',
+                      anyOf: [
+                        {
+                          $ref: '#/$defs/databaseType'
+                        },
+                        {
+                          minLength: 1
+                        }
+                      ]
+                    },
+                    model: {
+                      description: 'Define the assigned model. Interpreted like Node.js \'requires\' logic.',
+                      $ref: '#/$defs/foldersStringArray'
+                    },
+                    credentials: {
+                      type: 'object',
+                      description: 'You can explicitly configure credentials, but this is overruled by VCAP_SERVICES if a matching entry is found therein.',
+                      additionalProperties: true,
+                      properties: {
+                        database: {
+                          type: 'string',
+                          format: 'uri-reference'
+                        }
+                      }
+                    },
+                    vcap: {
+                      type: 'object',
+                      description: 'Optional: Used to select an entry in VCAP_SERVICES.',
+                      additionalProperties: true,
+                      properties: {
+                        name: {
+                          type: 'string',
+                          minLength: 1
+                        }
+                      }
+                    }
+                  }
+                }
+              ]
+            },
+            middlewares: {
+              type: 'boolean',
+              description: 'Enables new middlewares support (experimental).'
+            },
+            multitenancy: {
+              oneOf: [
+                {
+                  type: 'boolean',
+                  description: 'Shortcut to enable multitenancy.'
+                },
+                {
+                  type: 'object',
+                  description: 'Multitenancy configuration options.',
+                  properties: {
+                    jobs: {
+                      type: 'object',
+                      description: 'Configuration options for the built-in async job executor.',
+                      properties: {
+                        workerSize: {
+                          type: 'number',
+                          description: 'Number of workers running in parallel per database.'
+                        },
+                        clusterSize: {
+                          type: 'number',
+                          description: 'Number of databases executing parallel tasks.'
+                        }
+                      }
+                    }
+                  }
+                }
+              ]
+            },
+            extensibility: {
+              oneOf: [
+                {
+                  type: 'boolean',
+                  description: 'Shortcut to enable extensibility.'
+                },
+                {
+                  type: 'object',
+                  description: 'Extensibility configuration options.',
+                  properties: {
+                    tenantCheckInterval: {
+                      type: 'number',
+                      description: 'Time interval in ms to check for new extensions and refreshed models.'
+                    },
+                    evictionInterval: {
+                      type: 'number',
+                      description: 'Time interval in ms after which to evict models for inactive tenants.'
+                    }
+                  }
+                }
+              ]
+            },
+            toggles: {
+              type: 'boolean',
+              description: 'Shortcut to enable feature toggles.'
+            },
+            'cds.xt.ModelProviderService': {
+              description: 'Configure if/how the ModelProviderService serves model variants that may include tenant-specific extensions and/or feature-toggled aspects.',
+              oneOf: [
+                {
+                  $ref: '#/$defs/serviceActivation'
+                },
+                {
+                  $ref: '#/$defs/servicePresetSidecar'
+                },
+                {
+                  type: 'object',
+                  description: 'ModelProviderService 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: 'Configure if/how the ExtensibilityService allows to add and activate tenant-specific extensions at runtime.',
+              oneOf: [
+                {
+                  $ref: '#/$defs/serviceActivation'
+                },
+                {
+                  $ref: '#/$defs/extensionRestrictions'
+                }
+              ]
+            },
+            'cds.xt.DeploymentService': {
+              description: 'Configure if/how the DeploymentService handles subscribe, unsubscribe, and upgrade events for single tenants and single apps/micro-services.',
+              oneOf: [
+                {
+                  $ref: '#/$defs/serviceActivation'
+                },
+                {
+                  $ref: '#/$defs/servicePresetSidecar'
+                },
+                {
+                  type: 'object',
+                  description: 'DeploymentService configuration options.',
+                  properties: {
+                    hdi: {
+                      type: 'object',
+                      description: 'Bundles HDI-specific settings.',
+                      properties: {
+                        create: {
+                          type: 'object',
+                          description: 'HDI container provisioning parameters.',
+                          properties: {
+                            database_id: {
+                              type: 'string',
+                              description: 'HANA Cloud instance ID.'
+                            },
+                            additionalProperties: true
+                          }
+                        },
+                        bind: {
+                          type: 'object',
+                          description: 'HDI container binding parameters.'
+                        },
+                        deploy: {
+                          type: 'object',
+                          description: 'HDI deployment parameters as defined on https://www.npmjs.com/package/@sap/hdi-deploy#supported-features'
+                        }
+                      }
+                    },
+                    lazyT0: {
+                      type: 'boolean',
+                      description: 'Onboard bookkeeping t0 container at the first subscription.'
+                    }
+                  }
+                }
+              ]
+            },
+            'cds.xt.SaasProvisioningService': {
+              description: 'De-/Activate the 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'
+                },
+                {
+                  type: 'object',
+                  description: 'SaasProvisioningService configuration options.',
+                  additionalProperties: true,
+                  properties: {
+                    jobs: {
+                      type: 'object',
+                      description: 'Configuration options for the built-in async job executor.',
+                      properties: {
+                        workerSize: {
+                          type: 'number',
+                          description: 'Number of workers running in parallel per database.'
+                        },
+                        clusterSize: {
+                          type: 'number',
+                          description: 'Number of databases executing parallel tasks.'
+                        }
+                      },
+                      additionalProperties: true
+                    }
+                  }
+                }
+              ]
+            }
+          },
+          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'
+                    }
+                  }
+                }
+              ]
+            }
+          }
+        },
+        protocols: {
+          type: 'object',
+          description: 'List protocols to enable in addition to the default protocol adaptors.',
+          additionalProperties: true,
+          patternProperties: {
+            '.+': {
+              oneOf: [
+                {
+                  type: 'boolean',
+                  description: 'Enables a built-in protocol adapter with defaults'
+                },
+                {
+                  type: 'string',
+                  description: 'The endpoint to serve this protocol at.'
+                },
+                {
+                  type: 'object',
+                  default: {},
+                  additionalProperties: true,
+                  properties: {
+                    path: {
+                      type: 'string',
+                      description: 'The endpoint to serve this protocol at.'
+                    },
+                    impl: {
+                      type: 'string',
+                      description: 'The module pathname of the protocol adapter implementation.'
+                    }
+                  }
+                }
+              ]
+            }
+          }
+        }
+      }
+    },
+
+    serviceType: {
+      enum: [
+        'app-service',
+        'odata',
+        'odata-v2',
+        'odata-v4',
+        'rest'
+      ],
+      enumDescriptions: [
+        'Standard app service',
+        'OData service',
+        'OData service version 2',
+        'OData service version 4',
+        'REST service'
+      ]
+    },
+
+    authType: {
+      default: 'mocked',
+      enum: [
+        'mocked',
+        'basic',
+        'jwt',
+        'xsuaa',
+        'dummy'
+      ],
+      enumDescriptions: [
+        'Mocked authentication',
+        'Basic authentication',
+        'JWT authentication',
+        'Authentication using XSUAA',
+        'Dummy authentication'
+      ]
+    },
+
+    mockUsers: {
+      type: 'object',
+      description: 'List of users for local usage.',
+      properties: {
+        '*': {
+          default: true,
+          enum: [
+            true,
+            false
+          ],
+          enumDescriptions: [
+            'Allow other users than the ones specified.',
+            'Block other users than the ones specified.'
+          ]
+        }
+      },
+      patternProperties: {
+        '.+': {
+          type: 'object',
+          additionalProperties: true,
+          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.'
+            },
+            attr: {
+              type: 'object',
+              description: 'Additional user attributes.',
+              patternProperties: {
+                '.+': {
+                  type: 'string',
+                  description: 'Attribute value'
+                }
+              }
+            },
+            password: {
+              type: 'string',
+              description: 'User password'
+            }
+          }
+        }
+      }
+    },
+
+    databaseType: {
+      default: 'sqlite',
+      enum: [
+        'hana',
+        'sql',
+        'sqlite'
+      ],
+      enumDescriptions: [
+        'SAP HANA',
+        'In-memory SQLite (development), SAP HANA (production)',
+        'File-based SQLite'
+      ]
+    },
+
+    foldersStringArray: {
+      oneOf: [
+        {
+          type: 'string',
+          format: 'uri-reference'
+        },
+        {
+          type: 'array',
+          uniqueItems: true,
+          items: {
+            type: 'string',
+            format: 'uri-reference'
+          }
+        }
+      ]
+    },
+
+    serviceActivation: {
+      type: 'boolean',
+      description: 'De-/Activate 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/env/schemas/index.js

@@ -1,10 +1,12 @@
-const { readFile } = require('fs').promises
 const { join } = require('path')
 
 module.exports = new class {
     async default4(name) {
-        let file = join(__dirname, name)
-        let json = await readFile(file, 'utf8')
-        return JSON.parse(json)
+        const file = join(__dirname, name.replace(/\.\w+$/, ''))
+        try {
+            return structuredClone(require(file))
+        } catch (err) {
+            throw new Error(`ENOENT: Could not load schema '${name}' from ${file}`)
+        }
     }
 }