@cap-js/cds-types 0.9.0 → 0.10.0

package/dist/cds-types.d.ts

@@ -378,7 +378,13 @@ namespace cds {
         operator,
         function_call,
         enum_literal,
-        expr_literal
+        expr_literal,
+        Texts,
+        I18nBundle,
+        I18nFacade,
+        I18nFilesOptions,
+        I18nFiles,
+        i18n
     }
 }
 
@@ -458,6 +464,7 @@ namespace classes {
         TimeStamp,
         array,
         struct,
+        Map_3 as Map,
         context_,
         service_,
         action,
@@ -644,7 +651,7 @@ class ConstructedQuery<T> {
     // that don't make explicit use of the generic. So `UPDATE<Books> !<: UPDATE<number>`
     private _: T
     then (_resolved: (x: any) => any, _rejected: (e: Error) => any): any
-
+    bind (service: Service): this
 }
 
 /**
@@ -760,6 +767,7 @@ namespace csn {
         service_2 as service,
         type_2 as type,
         struct_2 as struct,
+        Map_2 as Map,
         entity_2 as entity,
         EntityElements,
         Association_2 as Association
@@ -982,7 +990,13 @@ export namespace default_2 {
         operator,
         function_call,
         enum_literal,
-        expr_literal
+        expr_literal,
+        Texts,
+        I18nBundle,
+        I18nFacade,
+        I18nFilesOptions,
+        I18nFiles,
+        i18n
     }
 }
 
@@ -1430,8 +1444,57 @@ type HavingWhere<This, E> =
 & ((...expr: string[]) => This)
 & TaggedTemplateQueryPart<This>
 
+interface Hints {
+    hints: ((...hints: string[]) => this)
+    & ((hints: string[]) => this)
+}
+
 export const home: string;
 
+export const i18n: I18nFacade;
+
+export class I18nBundle {
+    constructor(options: I18nFilesOptions)
+    for(key: number | string | object, locale?: string | object, args?: object): string | undefined
+    at(key: number | string | object, locale?: string | object, args?: object): string | undefined
+    files: I18nFiles
+    get defaults(): Record<string, string>
+    get fallback(): Record<string, string>
+    key4(definition: entity): string
+    texts4 (locale: string): Texts
+    translations4 (...locales : string[]) : { [locale: string]: Texts }
+    translations4 (locale : 'all' ) : { [locale: string]: Texts }
+    all () : Record<string, Texts>
+}
+
+export interface I18nFacade {
+    Bundle: typeof I18nBundle
+    Facade: I18nFacade
+    Files: typeof I18nFiles
+    get file(): string
+    get folders(): string[]
+    get labels(): I18nBundle
+    get messages(): I18nBundle
+
+    bundle4 (file: string, options?: I18nFilesOptions): I18nBundle
+    bundle4 (model: csn.CSN): I18nBundle
+}
+
+export class I18nFiles {
+    constructor (options: I18nFilesOptions)
+    get options(): I18nFilesOptions
+    get basename(): string
+    content4(locale: string, suffix: string): Array<object>
+}
+
+export interface I18nFilesOptions {
+    file?    : string   
+    model?   : csn.CSN     
+    roots?   : string[] 
+    leafs?   : string[] 
+    folders? : string[]
+}
+
 export const insert: Service['insert'];
 
 type INSERT_2 = { INSERT: {
@@ -1874,6 +1937,17 @@ type ManagedAssociation = Association & {
     keys: Column[],
 }
 
+interface Map_2 extends Omit<struct_2, 'includes' | 'items'> {
+    elements: Record<string,never>
+}
+
+/**
+ * @since 8.6.0
+ */
+interface Map_3 extends csn.Map {}
+
+class Map_3 {}
+
 export class MessagingService extends Service {}
 
 export type Middlewares = 'context' | 'trace' | 'auth' | 'ctx_model' | string
@@ -2437,7 +2511,7 @@ type SELECT_2 = { SELECT: {
     }, }
 export { SELECT_2 as SELECT }
 
-interface SELECT_3<T> extends Where<T>, And, Having<T>, GroupBy, OrderBy<T>, Limit {
+interface SELECT_3<T> extends Where<T>, And, Having<T>, GroupBy, OrderBy<T>, Limit, Hints {
     // overload specific to SELECT
     columns: Columns<T, this>['columns'] & ((projection: Projection<T>) => this)
 }
@@ -2962,6 +3036,8 @@ export const test: {
     log: Test['log'],
 };
 
+export type Texts = Record<string, string>
+
 class Time extends date { }
 
 class TimeStamp extends DateTime { }
@@ -3006,7 +3082,7 @@ interface type_2 extends any__2 {
     'cds.UUID' | 'cds.String' | 'cds.LargeString' | 'cds.Binary' | 'cds.LargeBinary' | 'cds.Vector' |
     'cds.Integer' | 'cds.UInt8' | 'cds.Int16' | 'cds.Int32' | 'cds.Int64' | 'cds.Double' | 'cds.Decimal' |
     'cds.Date' | 'cds.Time' | 'cds.DateTime' | 'cds.Timestamp' |
-    'cds.Association' | 'cds.Composition' |
+    'cds.Association' | 'cds.Composition' | 'cds.Map' |
     FQN & Record<never,never> // allow any other CDS type as well (e.g. 'User')
     items?: type_2
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cap-js/cds-types",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "description": "Type definitions for main packages of CAP, like `@sap/cds`",
   "repository": "github:cap-js/cds-types",
   "homepage": "https://cap.cloud.sap/",
@@ -10,18 +10,25 @@
     "Node.js"
   ],
   "author": "SAP SE (https://www.sap.com)",
-  "license": "SEE LICENSE IN LICENSE",
+  "license": "Apache-2.0",
   "typings": "dist/cds-types.d.ts",
   "files": [
     "dist/",
     "scripts/",
-    "LICENSE",
     "README.md"
   ],
   "scripts": {
-    "test": "jest --silent",
-    "test:integration": "jest --testMatch \"**/test/**/*.integrationtest.js\"",
-    "test:rollup": "npm run rollup; npm run rollup:on; npm run test; npm run rollup:off",
+    "test:integration": "node --test ./test/postinstall.integrationtest.js",
+    "test:runtime": "npm run test:runtime:post-mortem; rm -rf test/typescript/_out",
+    "test:runtime:tsc": "npx tsc test/typescript/runtime.test.ts --outDir test/typescript/_out --target ES2020 --module commonjs --esModuleInterop",
+    "test:runtime:post-mortem": "npm run test:runtime:tsc && node --test './test/typescript/_out/runtime.test.js'",
+    "test:api-calls": "node --test './test/typescript/apis/cds-api-calls.test.js'",
+    "test:typings": "node --test './test/typescript/cds-typings.test.js'",
+    "test:all": "npm run test:runtime && npm run test:api-calls && npm run test:typings",
+    "test:setup": "npm install file:. --no-save --force && npm run prerelease:ci-fix",
+    "test": "npm run test:setup && npm run test:rollup-on",
+    "test:rollup-on": "npm run rollup && npm run rollup:on && npm run test:all --silent",
+    "test:rollup-off": "npm run rollup:off && npm run test:all --silent",
     "rollup": "rm -rf dist/ && mkdir -p etc/ && npx -y @microsoft/api-extractor run --local --verbose && .github/rollup-patch.js",
     "rollup:on": "npm pkg set typings=dist/cds-types.d.ts && [ -d 'apis' ] && mv -- apis -apis || true",
     "rollup:off": "npm pkg set typings=apis/cds.d.ts  && [ -d '-apis' ] && mv -- -apis apis || true",
@@ -33,28 +40,16 @@
     "dependencies": "node ./scripts/postinstall.js"
   },
   "peerDependencies": {
-    "@sap/cds": "^8.0.0",
+    "@sap/cds": ">=8.0.0",
     "@types/express": ">=4"
   },
   "devDependencies": {
-    "@eslint/js": "^9.2.0",
-    "@sap/cds": ">=8.0.0",
-    "@stylistic/eslint-plugin-js": "^2.1.0",
-    "@stylistic/eslint-plugin-ts": "^2.1.0",
-    "@types/jest": "^29.5.11",
-    "@types/node": "^22",
+    "@cap-js/cds-test": "^0",
+    "@stylistic/eslint-plugin-js": "^4.0.1",
+    "@stylistic/eslint-plugin-ts": "^4.0.1",
     "axios": "^1.6.2",
-    "chai": "^4.3.10",
     "eslint": "^9.2.0",
-    "jest": "^29.7.0",
-    "ts-jest": "^29.1.1",
     "typescript": "^5.4.5",
-    "typescript-eslint": "^8.0.0-alpha.51",
-    "winston": "^3.13.0"
-  },
-  "jest": {
-    "transform": {
-      "^.+\\.(ts|tsx)$": "ts-jest"
-    }
+    "typescript-eslint": "^8.0.0-alpha.51"
   }
 }