@cap.core/ql 1.2.4 → 1.2.6

package/@types/exprs.d.ts

@@ -1,8 +1,13 @@
 import * as cqn from './cqn'
+
+export function subject (...args: any[]): cqn.ref;
 export function columns () : cqn.column[]
-export function orderBy () : cqn.order[]
-export function entity () : cqn.ref
+export function values(...args: any[]): (string|number|boolean|null)[];
 export function where () : cqn.xo[]
+export function having () : cqn.xo[]
+export function groupBy () : cqn.column[]
+export function orderBy () : cqn.order[]
+
 
 /**
  * This is the template string variant of `expr`. The argument is a template string,

package/@types/index.d.ts

@@ -1 +1,29 @@
+import { Query } from './ql/base-class.js';
+import { SELECT as SELECT_ } from './ql/select.js';
+import { INSERT as INSERT_ } from './ql/insert.js';
+import { UPSERT as UPSERT_ } from './ql/insert.js';
+import { UPDATE as UPDATE_ } from './ql/update.js';
+import { DELETE as DELETE_ } from './ql/delete.js';
+
+/**
+ * This is the central entry point for creating queries from various types of input:
+ * - If the input is a `Query` instance already, it's returned as-is.
+ * - If the input is a `string` or a template literal, it's parsed into a CQN object.
+ * - If the input is an `object` with a recognized query kind, it's cast into an instance of
+ *   the corresponding query class.
+ * @param { Query | string | object } qso - The input, as described above, to be converted into an instance of a Query subclass.
+ * @param { ...any } args - Optional arguments for template literals or parameterized queries.
+ * @returns { SELECT & INSERT & UPSERT & UPDATE & DELETE }
+ */
+export function cql (
+  qso: Query | string | object, ...args: any[]
+): SELECT_ & INSERT_ & UPSERT_ & UPDATE_ & DELETE_;
+
 export * from './exprs'
+export { Query };
+export const SELECT: (() => typeof SELECT_) & typeof SELECT_;
+export const INSERT: (() => typeof INSERT_) & typeof INSERT_;
+export const UPSERT: (() => typeof UPSERT_) & typeof UPSERT_;
+export const UPDATE: (() => typeof UPDATE_) & typeof UPDATE_;
+export const DELETE: (() => typeof DELETE_) & typeof DELETE_;
+export default cql;

package/@types/ql/base-class.d.ts

@@ -0,0 +1,18 @@
+import * as cqn from '../cqn'
+
+export class Query {
+  /**
+  * - Fills in any binding `{param}`s with corresponding `{val}`s from given `args`.
+  * - If no `args` are provided, the ones collected during parsing are used.
+  */
+  bind(...args: any[]): this;
+
+  /**
+  * Returns the main subject `{ref}` of the query, which refers to the entity being queried or modified.
+  * - For `SELECT` and `DELETE` queries, this is the `from` clause.
+  * - For `INSERT` and `UPSERT` queries, this is the `into` clause.
+  * - For `UPDATE` queries, this is the `entity` clause.
+  * @returns {ref:string[]} The main subject of the query.
+  */
+  get subject(): cqn.ref;
+}

package/@types/ql/delete.d.ts

@@ -0,0 +1,8 @@
+import { Query } from './base-class.js';
+import * as cqn from '../cqn'
+
+export class DELETE extends Query {
+  static from(...args: any[]): DELETE;
+  DELETE: cqn.DELETE;
+  where(...args: any[]): this;
+}

package/@types/ql/insert.d.ts

@@ -0,0 +1,20 @@
+import { Query } from './base-class.js';
+import * as cqn from '../cqn'
+
+export class XSERT extends Query {
+  static entries(...args: any[]): XSERT;
+  static into(x: any, ...tail: any[]): XSERT;
+  _entries(...tail: any[]): this;
+  into(...args: any[]): this;
+  entries(...args: any[]): this;
+  columns(...args: any[]): this;
+  values(...args: any[]): this;
+  rows(...args: any[]): this;
+  from(...args: any[]): this;
+}
+export class INSERT extends XSERT {
+  INSERT: cqn.INSERT;
+}
+export class UPSERT extends XSERT {
+  UPSERT: cqn.UPSERT;
+}

package/@types/ql/select.d.ts

@@ -0,0 +1,24 @@
+import { Query } from './base-class.js';
+import * as cqn from '../cqn'
+
+export class SELECT extends Query {
+  static from(...args: any[]): SELECT;
+  static columns(...args: any[]): SELECT;
+  static get localized(): SELECT;
+  static get distinct(): SELECT;
+  static get one(): SELECT;
+  SELECT: cqn.SELECT;
+  get localized(): this;
+  get distinct(): this;
+  get one(): this;
+  columns(...args: any[]): this;
+  from(...args: any[]): this;
+  where(...args: any[]): this;
+  having(...args: any[]): this;
+  groupBy(...args: any[]): this;
+  orderBy(...args: any[]): this;
+  limit(...args: any[]): this;
+  top(...args: any[]): this;
+  skip(...args: any[]): this;
+  offset(...args: any[]): this;
+}

package/@types/ql/update.d.ts

@@ -0,0 +1,10 @@
+import { Query } from './base-class.js';
+import * as cqn from '../cqn'
+
+export class UPDATE extends Query {
+  static entity(...args: any[]): UPDATE;
+  UPDATE: cqn.UPDATE;
+  where(...args: any[]): this;
+  with(data: any, x: any): this;
+  set(data: any, x: any): this;
+}

package/lib/index.js

@@ -1,21 +1,21 @@
+// Re-export all the helper functions and classes from the xl module
+export * from './xl/ttl.js'
+import * as peg from '../cql/parser.min.js'
+import { Query } from './ql/base-class.js'
+export { Query }
+
+// Export the fluent interface variants of the query classes
 import { SELECT as SELECT_ } from './ql/select.js'
 import { INSERT as INSERT_ } from './ql/insert.js'
 import { UPSERT as UPSERT_ } from './ql/insert.js'
 import { UPDATE as UPDATE_ } from './ql/update.js'
 import { DELETE as DELETE_ } from './ql/delete.js'
 
-// Re-export the query classes with fluent interfaces
-export const SELECT = SELECT_.chimera (SELECT_.columns)
-export const INSERT = INSERT_.chimera (INSERT_.entries)
-export const UPSERT = UPSERT_.chimera (UPSERT_.entries)
-export const UPDATE = UPDATE_.chimera (UPDATE_.entity)
-export const DELETE = DELETE_.chimera (DELETE_.from)
-
-// Re-export all the helper functions and classes from the xl module
-export * from './xl/ttl.js'
-import * as peg from '../cql/parser.min.js'
-import { Query } from './ql/base-class.js'
-export { Query }
+export const SELECT = global.SELECT = SELECT_.chimera (SELECT_.columns)
+export const INSERT = global.INSERT = INSERT_.chimera (INSERT_.entries)
+export const UPSERT = global.UPSERT = UPSERT_.chimera (UPSERT_.entries)
+export const UPDATE = global.UPDATE = UPDATE_.chimera (UPDATE_.entity)
+export const DELETE = global.DELETE = DELETE_.chimera (DELETE_.from)
 
 
 /**

package/lib/ql/base-class.js

@@ -84,9 +84,6 @@ export class Query {
 
   /**
    * Returns the main subject `{ref}` of the query, which refers to the entity being queried or modified.
-   * - For `SELECT` and `DELETE` queries, this is the `from` clause.
-   * - For `INSERT` and `UPSERT` queries, this is the `into` clause.
-   * - For `UPDATE` queries, this is the `entity` clause.
    * @returns {ref:string[]} The main subject of the query.
    */
   get subject() { return this._.from }
@@ -95,4 +92,9 @@ export class Query {
   /** @private */ set source (cql) { Object.defineProperty (this, 'source', { value: cql, writable: true }) }
   /** @private */ set params (arr) { Object.defineProperty (this, 'params', { value: arr, writable: true }) }
   /** @private */ set args (arr)   { Object.defineProperty (this, 'args',   { value: arr, writable: true }) }
+
+  // Custom inspect method to improve the output, e.g. in repl, console.log,
+  [Symbol.for('nodejs.util.inspect.custom')] = function (depth, options, inspect) {
+    return `${this.kind} ${inspect(this[this.kind], options)}`
+  }
 }

package/lib/ql/insert.js

@@ -2,7 +2,7 @@ import { subject, columns, values, fluent, unwrapped } from '../xl/ttl.js'
 import { Query } from './base-class.js'
 import { cql } from '../index.js'
 
-export class XSERT extends Query { INSERT = {}
+export class XSERT extends Query {
   static entries (...args) { return (new this).entries(...args) }
   static into (x,...tail) {
     if (x.raw) return (new this)._set ('into', subject(x,...tail))  //> INSERT.into`Foo`

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@cap.core/ql",
-  "version": "1.2.4",
-  "description": "Minimalistic implementation of `cds.ql`, carved out from CAP.",
+  "version": "1.2.6",
+  "description": "Minimalistic implementation of cds.ql, carved out from CAP.",
+  "repository": "https://github.com/cap-js/ql.git",
   "author": "daniel.hutzel@sap.com",
   "type": "module",
   "main": "lib/index.js",