@cap.core/ql 1.2.3 → 1.2.4

package/@types/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/@types/cqn.d.ts

@@ -0,0 +1,146 @@
+/**
+ * `INSERT` and `UPSERT` queries are represented by the same internal
+ * structures. The `UPSERT` keyword is used to indicate that the
+ * statement should be updated if the targeted data exists.
+ * The `into` property specifies the target entity.
+ *
+ * The data to be inserted or updated can be specified in different ways:
+ *
+ * - in the `entries` property as deeply nested records.
+ * - in the `columns` and `values` properties as in SQL.
+ * - in the `columns` and `rows` properties, with `rows` being array of `values`.
+ * - in the `from` property with a `SELECT` query to provide the data to be inserted.
+ *
+ * The latter is the equivalent of SQL's `INSERT INTO ... SELECT ...` statements.
+ */
+export class INSERT { INSERT: UPSERT['UPSERT'] }
+export class UPSERT { UPSERT: {
+  into      : ref
+  entries?  : data[]
+  columns?  : string[]
+  values?   : scalar[]
+  rows?     : scalar[][]
+  from?     : SELECT
+}}
+
+
+/**
+ * `UPDATE` queries are used to capture modifications to existing data.
+ * They support a `where` clause to specify the rows to be updated,
+ * and a `with` clause to specify the new values. Alternatively, the
+ * `data` property can be used to specify updates with plain data only.
+ */
+export class UPDATE { UPDATE: {
+  entity  : ref
+  where?  : expr
+  data    : data
+  with    : changes
+}}
+
+
+/**
+ * `DELETE` queries are used to remove data from a target datasource.
+ * They support a `where` clause to specify the rows to be deleted.
+ */
+export class DELETE { DELETE: {
+  from    : ref
+  where?  : expr
+}}
+
+
+/**
+ * `SELECT` queries are used to retrieve data from a target datasource,
+ * and very much resemble SQL's `SELECT` statements, with these noteworthy
+ * additions:
+ *
+ * - The `from` clause supports `{ref}` paths with infix filters.
+ * - The `columns` clause supports deeply nested projections.
+ * - The `count` property requests the total count, similar to OData's `$count`.
+ * - The `one` property indicates that only a single record object shall be
+ *   returned instead of an array.
+ *
+ * Also, CDS, and hence CQN, supports minimalistic `SELECT` statements with a `from`
+ * as the only mandatory property, which is equivalent to SQL's `SELECT * from ...`.
+ */
+export class SELECT { SELECT: {
+  distinct?   : true
+  count?      : true
+  one?        : true
+  from        : source
+  columns?    : column[]
+  where?      : xo[]
+  having?     : xo[]
+  groupBy?    : expr[]
+  orderBy?    : order[]
+  limit?      : { rows: val, offset: val }
+}}
+
+type source = OneOf< ref &as | SELECT | {
+  join : 'inner' | 'left' | 'right'
+  args : [ source, source ]
+  on?  : expr
+}>
+
+type column = OneOf< '*' | expr &as &cast | ref &as & OneOf<(
+  { expand?: column[] } |
+  { inline?: column[] }
+)> &infix >
+
+type order = expr & {
+  sort  : 'asc' | 'desc'
+  nulls : 'first' | 'last'
+}
+
+
+interface changes { [elm:string]: OneOf< scalar | expr | changes | changes[] >}
+interface data { [elm:string]: OneOf< scalar | data | data[] >}
+interface as { as?: name }
+interface cast { cast?: {type:name} }
+
+interface infix {
+  orderBy?  : order[]
+  where?    : expr
+  limit?    : { rows: val, offset: val }
+}
+
+
+/**
+ * Expressions can be entity or element references, query parameters,
+ * literal values, lists of all the former, function calls, sub selects,
+ * or compound expressions.
+ */
+export type expr  = OneOf< ref | val | xpr | list | func | param | SELECT >
+export type ref   = { ref: OneOf< name | { id:name } &infix >[] }
+export type val   = { val: scalar }
+export type xpr   = { xpr: xo[] }
+export type list  = { list: expr[] }
+export type func  = { func: string, args: expr[] }
+export type param = { ref: [ '?' | number | string ], param: true }
+
+/**
+ * This is used in `{xpr}` objects as well as in `SELECT.where` clauses to
+ * represent compound expressions as flat `xo` sequences.
+ * Note that CQN by intent does not _understand_ expressions and therefore
+ * keywords and operators are just represented as plain strings.
+ * This allows us to translate to and from any other query languages,
+ * including support for native SQL features.
+ */
+export type xo = OneOf< expr | keyword | operator >
+type operator = '=' | '==' | '!=' | '<' | '<=' | '>' | '>='
+type keyword  = 'in' | 'like' | 'and' | 'or' | 'not'
+type scalar   = number | string | boolean | null
+type name     = string
+
+
+
+// ---------------------------------------------------------------------------
+//  maybe coming later...
+
+declare class CREATE { CREATE: {} }
+declare class DROP { DROP: {} }
+
+
+// ---------------------------------------------------------------------------
+//  internal helpers...
+
+type OneOf<U> = Partial<(U extends any ? (k:U) => void : never) extends (k: infer I) => void ? I : never>

package/@types/exprs.d.ts

@@ -0,0 +1,59 @@
+import * as cqn from './cqn'
+export function columns () : cqn.column[]
+export function orderBy () : cqn.order[]
+export function entity () : cqn.ref
+export function where () : cqn.xo[]
+
+/**
+ * This is the template string variant of `expr`. The argument is a template string,
+ * which can contain interpolations of other CQN expressions, references, and values.
+ */
+export function expr (strings: TemplateStringsArray, ...values: any[]) : cqn.expr
+
+/**
+ * This is a fluent variant of `expr` for the case where the argument is a simple
+ * array of scalar values. In this case, it constructs a CQN `{list}` expression.
+ */
+export function expr (list: cqn.scalar[]) : cqn.list
+
+/**
+ * This is a fluent variant of `expr` for the case where the argument is a single
+ * scalar value. In this case, it constructs a CQN `{val}` expression.
+ */
+export function expr (val: cqn.scalar) : cqn.val
+
+
+/**
+ * This is the template string variant of `ref`. The argument is a template string,
+ * which forms a path expression, with optional infix filters.
+ */
+export function ref (strings: TemplateStringsArray, ...values: any[]) : cqn.ref
+
+/**
+ * This is the fluent variant of `ref` for the case where the arguments are simple
+ * path segments. It constructs a CQN `{ref}` expression.
+ */
+export function ref (...path: string[]) : cqn.ref
+
+
+/**
+ * This is the template string variant of `val`. The argument is a template string,
+ * which can contain interpolations of strings, numbers, booleans, null.
+ */
+export function val (strings: TemplateStringsArray, ...values: any[]) : cqn.val
+
+/**
+ * This is the fluent variant of `val` for the case where the argument is a single
+ * scalar value. In this case, it constructs a CQN `{val}` expression.
+ */
+export function val (val: cqn.scalar) : cqn.val
+
+
+
+export interface fluent {
+  expr : typeof expr
+  entity : typeof entity
+  columns : typeof columns
+  orderBy : typeof orderBy
+  where : typeof where
+}

package/@types/index.d.ts

@@ -0,0 +1 @@
+export * from './exprs'

package/@types/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "@types/cap.core__ql",
+  "version": "1.2.3",
+  "description": "Type declarations for @cap.core/ql",
+  "author": "daniel.hutzel@sap.com",
+  "license": "Apache-2.0"
+}

package/package.json

@@ -1,15 +1,16 @@
 {
   "name": "@cap.core/ql",
-  "version": "1.2.3",
+  "version": "1.2.4",
   "description": "Minimalistic implementation of `cds.ql`, carved out from CAP.",
   "author": "daniel.hutzel@sap.com",
   "type": "module",
   "main": "lib/index.js",
   "files": [
+    "lib",
     "cql/parser.min.js",
-    "lib"
+    "@types"
   ],
-  "devDependencies": {
+  "dependencies": {
     "@types/cap.core__ql": "file:./@types"
   },
   "scripts": {

package/readme.md

@@ -7,12 +7,6 @@ This is a minimalistic implementation of `cds.ql` that supports parsing and cons
 ```shell
 npm add cap-js/ql
 ```
-In addition, you may want to install the type declarations for better IntelliSense in VSCode:
-
-```shell
-npm add -D cap-js/ql-types
-```
-
 ### Usage
 
 Import from ESM modules, or from CommonJS modules:
@@ -68,11 +62,10 @@ cql`DELETE Books[${ID}]` // → same as above
 Feel invited to contribute.
 
 ```sh
-git clone --recursive https://github.com/cap-js/ql
-cd cds.ql
+git clone https://github.com/cap-js/ql cap/core/ql
+cd cap/core/ql
 npm i
 ```
-> The `--recursive` flag clones the `@types` submodule as well, which contains the type declarations.
 
 
 ### Try it in REPL or Browser