@cap-js/cds-types 0.0.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,30 @@
+# cds-types
+
+<!-- [![REUSE status](https://api.reuse.software/badge/github.com/cap-js/cds-types)](https://api.reuse.software/info/github.com/cap-js/cds-types)
+![Unit Tests passing](https://github.com/cap-js/cds-types/actions/workflows/test.yml/badge.svg) -->
+
+## About this project
+
+Contains type definitions for the [Node.js SDK](https://cap.cloud.sap/docs/node.js/) of the SAP Cloud Application Programming Model (CAP).
+
+## Requirements and Setup
+
+Just install package `@sap/cds` into a Javascript or Typescript project, and the types will automatically be available in modern IDEs like VS Code.
+
+Find more information on the APIs in the [Node.js SDK documentation](https://cap.cloud.sap/docs/node.js/).
+
+## Support, Feedback, Contributing
+
+This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/cap-js/cds-types/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).
+
+## Security / Disclosure
+
+If you find any bug that may be a security problem, please follow our instructions at [in our security policy](https://github.com/SAP/.github/blob/main/SECURITY.md) on how to report it. Please do not create GitHub issues for security-related doubts or problems.
+
+## Code of Conduct
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its [Code of Conduct](https://github.com/SAP/.github/blob/main/CODE_OF_CONDUCT.md) at all times.
+
+## Licensing
+
+Copyright 2019-2024 SAP SE or an SAP affiliate company and `cds-types` contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/cap-js/cds-types).

package/apis/cds.d.ts

@@ -0,0 +1,40 @@
+import * as ql from './ql'
+
+declare global {
+	const cds : cds_facade
+}
+
+export = cds
+
+type cds_facade = {}
+& import('./core').default
+& import('./env').default
+& import('./models').default
+& import('./server').default
+& import('./services').QueryAPI
+& import('./services').default
+& import('./events').default
+& import('./ql').cds_ql
+& import('./log')
+& import('./utils')
+& import('./test')
+
+declare global {
+	// these provide the functionality from SELECT, INSERT, etc in the global facade
+	const SELECT: typeof cds.ql.SELECT
+	const INSERT: typeof cds.ql.INSERT
+	const UPSERT: typeof cds.ql.UPSERT
+	const UPDATE: typeof cds.ql.UPDATE
+	const DELETE: typeof cds.ql.DELETE
+	const CREATE: typeof cds.ql.CREATE
+	const DROP: typeof cds.ql.DROP
+
+	// and these allow us to use them as type too, i.e. `const q: SELECT<Book> = ...`
+	type SELECT<T> = ql.SELECT<T>
+	type INSERT<T> = ql.INSERT<T>
+	type UPSERT<T> = ql.UPSERT<T>
+	type UPDATE<T> = ql.UPDATE<T>
+	type DELETE<T> = ql.DELETE<T>
+	type CREATE<T> = ql.CREATE<T>
+	type DROP<T>   = ql.DROP<T>
+}

package/apis/core.d.ts

@@ -0,0 +1,101 @@
+import { LinkedAssociation, LinkedEntity, linked } from './linked'
+import * as csn from './csn'
+import { service } from './server'
+
+// These are classes actually -> using the new() => interface trick
+export type Association = new(_?:object) => LinkedAssociation
+export type Composition = new(_?:object) => LinkedAssociation
+export type entity = new(_?:object) => LinkedEntity
+export type event = new(_?:object) => linked & csn.struct
+export type type = new(_?:object) => linked & csn.type
+export type array = new(_?:object) => linked & csn.type
+export type struct = new(_?:object) => linked & csn.struct
+
+export default class cds {
+  // infer (query : cqn, model : csn) : LinkedDefinition
+
+  builtin: {
+    /**
+     * Base classes of linked definitions from reflected models.
+     * @see [capire](https://cap.cloud.sap/docs/node.js/cds-reflect#cds-builtin-classes)
+     */
+    classes: {
+      Association: Association
+      Composition: Composition
+      entity: entity
+      event: event
+      type: type
+      array: array
+      struct: struct
+      service: service
+    }
+    types: {}
+  }
+
+  /**
+   * Base class for linked Associations from reflected models.
+   * @see [capire](https://cap.cloud.sap/docs/node.js/cds-reflect#cds-Association)
+   */
+  Association: Association
+
+  /**
+   * Base class for linked Compositions from reflected models.
+   * @see [capire](https://cap.cloud.sap/docs/node.js/cds-reflect#cds-Association)
+   */
+  Composition: Composition
+
+  /**
+   * Base class for linked entities from reflected models.
+   * @see [capire](https://cap.cloud.sap/docs/node.js/cds-reflect#cds-entity)
+   */
+  entity: entity
+
+  event: event
+  type: type
+  array: array
+  struct: struct
+
+  /**
+   * Add aspects to a given object, for example:
+   *
+   *    extend (Object.prototype) .with (class {
+   *       get foo() { return ... }
+   *       bar() {...}
+   *    }.prototype)
+   */
+  extend<T>(target: T): {
+    with<E extends readonly unknown[]>(...ext: E): T & Intersect<E>
+  }
+
+  /**
+   * Equip a given facade object with getters for lazy-loading modules instead
+   * of static requires. Example:
+   *
+   *    const facade = lazify ({
+   *       sub: lazy => require ('./sub-module')
+   *    })
+   *
+   * The first usage of `facade.sub` will load the sub module
+   * using standard Node.js's `module.require` functions.
+   */
+  lazify <T>(target: T) : T
+
+  /**
+   * Prepare a node module for lazy-loading submodules instead
+   * of static requires. Example:
+   *
+   *    require = lazify (module) //> turns require into a lazy one
+   *    const facade = module.exports = {
+   *       sub: require ('./sub-module')
+   *    })
+   *
+   * The first usage of `facade.sub` will load the sub module
+   * using standard Node.js's `module.require` functions.
+   */
+  lazified <T>(target: T) : T
+
+}
+
+type Intersect<T extends readonly unknown[]> = T extends [infer Head, ...infer Tail]
+  ? Head & Intersect<Tail>
+  : unknown

package/apis/cqn.d.ts

@@ -0,0 +1,76 @@
+import { entity } from "./csn" // cyclic dependency
+
+// FIXME: a union type would be more appropriate here
+export type Query = Partial<SELECT & INSERT & UPDATE & DELETE & CREATE & DROP & UPSERT>
+
+export type SELECT = {SELECT:{
+	distinct?: true
+	one? : boolean
+	from : source
+	mixin?: {[key:string]: expr}
+	columns? : column_expr[]
+	excluding? : string[]
+	where? : predicate
+	having? : predicate
+	groupBy? : expr[]
+	orderBy? : ordering_term[]
+	limit?: { rows:val, offset:val }
+}}
+
+export type INSERT = {INSERT:{
+	into : ref | name
+	entries : data[]
+	columns : string[]
+	values : scalar[]
+	rows : scalar[][]
+	as : SELECT
+}}
+
+export type UPSERT = {UPSERT:{
+	into : ref | name
+	columns : string[]
+	entries : data[]
+	values : scalar[]
+	rows : scalar[][]
+}}
+
+export type UPDATE = {UPDATE:{
+	entity : ref | name
+	data : { [key:string] : expr }
+	where? : predicate
+}}
+
+export type DELETE = {DELETE:{
+	from : ref | name
+	where? : predicate
+}}
+
+export type CREATE = {CREATE:{
+	entity : entity | name
+	as: SELECT
+}}
+
+export type DROP = {DROP:{
+	entity : name
+	table: ref
+	view: ref
+}}
+
+type scalar = number | string | boolean | null
+type data = Record<string,any>
+type name = string
+type source = ( ref | SELECT ) & { as?: name, join?:name, on?:xpr }
+export type column_expr = expr & { as?: name, cast?:any, expand?: column_expr[], inline?: column_expr[] }
+export type predicate = _xpr
+type ordering_term = expr & { sort?: "asc"|"desc", nulls?: "first"|"last" }
+
+export type expr = ref | val | xpr | function_call | SELECT
+type ref = {ref:( name & { id?:string, where?:expr, args?:expr[] } )[]}
+type val = {val:any}
+type xpr = {xpr:_xpr}
+type _xpr = ( expr | operator ) []
+type operator = string
+type function_call = {func: string, args: {[key: string]: unknown}[]}
+
+export type enum_literal = {"#": string}
+export type expr_literal = {"=": string}

package/apis/csn.d.ts

@@ -0,0 +1,117 @@
+import { SELECT, ref, predicate } from './cqn'
+
+/**
+ * A parsed CDS model in CSN object notation.
+ */
+export interface CSN {
+  /**
+   * The assigned namespace. If parsed from multiple sources,
+   * this is the topmost model's namespace, if any, not the
+   * ones of imported models.
+   */
+  namespace?: string
+
+  /**
+   * The list of usings in this parsed model. Not available after
+   * imports have been resolved into a merged model.
+   */
+  requires?: string[]
+
+  /**
+   * All definitions in the model including those from imported models.
+   */
+  definitions?: Record<FQN, Definition>
+
+  /**
+   * All extensions in the model including those from imported models.
+   * Not available after extensions have been applied.
+   */
+  extensions?: Extension[]
+
+  /**
+   * The names of the files from which this model has been loaded.
+   */
+  $sources?: string[]
+}
+
+/**
+ * The fully-quality name of a definition.
+ */
+export type FQN = string
+
+/**
+ * Definitions are the central elements of a CDS model.
+ */
+export type Definition = context & service & type & struct & entity & Association
+// NOTE: If we use & instead of | CSN.definitions values would be reduced to <never>
+
+/**
+ * Extensions capture extend Foo with { ... } directives.
+ */
+export type Extension = {
+  extend: FQN
+  elements?: { [name: string]: Element }
+  includes?: FQN[]
+}
+
+export type Element = type & struct & Association
+
+export type kinds = 'type' | 'entity' | 'event' | 'service' | 'context' | 'struct'
+
+export interface any_ { kind?: kinds }
+export interface context extends any_ { }
+export interface service extends any_ { }
+
+export interface type extends any_ {
+  type?: FQN
+  items?: type
+}
+
+export interface struct extends type {
+  /**
+   * References to definitions to be included.
+   * Not available after extensions have been applied.
+  */
+  includes?: FQN[]
+  elements: { [name: string]: Element }
+}
+
+export interface entity extends Omit<struct,'elements'> {
+  /**
+   * Entities with a query signify a view
+   */
+  query?: SELECT
+  /**
+   * Elements of entities may have additional qualifiers
+   */
+  elements : EntityElements
+  // REVISIT: following should move to LinkedCSN
+  keys: { [name: string]: Definition }
+  drafts: entity
+}
+
+export type EntityElements = {
+    [name:string]: Element & {
+        key? : boolean
+        virtual? : boolean
+        unique? : boolean
+        notNull? : boolean
+    }
+}
+
+export interface Association extends type {
+  type: 'cds.Association' | 'cds.Composition'
+  target: FQN
+  /**
+   * The specified cardinality. to-one = {max:1}, to-many = {max:'*'}
+   */
+  cardinality?: { src?: 1; min?: 1 | 0; max?: 1 | '*' }
+  /**
+   * The parsed on condition in case of unmanaged Associations
+   */
+  on?: predicate
+  /**
+   * The optionally specified keys in case of managed Associations
+   */
+  keys?: (ref & { as: string })[]
+}

package/apis/env.d.ts

@@ -0,0 +1,25 @@
+export default class {
+  /**
+   * Access to the configuration for Node.js runtime and tools.
+   * The object is the effective result of configuration merged from various sources,
+   * filtered through the currently active profiles, thus highly dependent on the current working
+   * directory and process environment.
+   */
+  env : {
+    build: any,
+    hana: any,
+    i18n: any,
+    mtx: any,
+    requires: any,
+    folders: any,
+    odata: any,
+    query: any,
+    sql: any
+  }
+
+  requires: any
+  version: string
+  home: string
+  root: string
+
+}