@cap-js/db-service 1.0.1 → 1.1.0

package/lib/infer/join-tree.js

@@ -1,50 +1,92 @@
 'use strict'
 
+// REVISIT: define following unknown types
+
+/**
+ * @typedef {unknown} $refLink
+ */
+
+/**
+ * @typedef {unknown} parent
+ */
+
+/**
+ * @typedef {unknown} where
+ */
+
+/**
+ * @typedef {unknown} children
+ */
+
+/**
+ * @typedef {unknown} queryArtifact
+ */
+
+/**
+ * @typedef {string} alias
+ */
+
+/**
+ * @typedef {Map<alias,Root>} _roots
+ */
+
+/**
+ * @typedef {Object.<string, unknown>} sources
+ */
+
 /**
  * A class representing a Node in the join tree.
- *
- * @property {$refLink} - A reference link to this node.
- * @property {parent} - The parent Node of this node.
- * @property {where} - An optional condition to be applied to this node.
- * @property {children} - A Map of children nodes belonging to this node.
  */
 class Node {
+  /**
+   * @param {$refLink} $refLink
+   * @param {parent} parent
+   * @param {where} where
+   */
   constructor($refLink, parent, where = null) {
+    /** @type {$refLink} - A reference link to this node. */
     this.$refLink = $refLink
+    /** @type {parent} - The parent Node of this node. */
     this.parent = parent
+    /** @type {where} - An optional condition to be applied to this node. */
     this.where = where
+    /** @type {children} - A Map of children nodes belonging to this node. */
     this.children = new Map()
   }
 }
 
 /**
  * A class representing the root of the join tree.
- *
- * @property {queryArtifact} - The artifact used to make the query.
- * @property {alias} - The alias of the artifact.
- * @property {parent} - The parent Node of this root, null for the root Node.
- * @property {children} - A Map of children nodes belonging to this root.
  */
 class Root {
+  /**
+   * @param {[alias, queryArtifact]} querySource
+   */
   constructor(querySource) {
     const [alias, queryArtifact] = querySource
+    /** @type {queryArtifact} - The artifact used to make the query. */
     this.queryArtifact = queryArtifact
+    /** @type {alias} - The alias of the artifact. */
     this.alias = alias
+    /** @type {parent} - The parent Node of this root, null for the root Node. */
     this.parent = null
+    /** @type {children} - A Map of children nodes belonging to this root. */
     this.children = new Map()
   }
 }
 
 /**
  * A class representing a Join Tree.
- *
- * @property {_roots} - A Map of root nodes.
- * @property {isInitial} - A boolean indicating if the join tree is in its initial state.
- * @property {_queryAliases} - A Map of query aliases, which is used during the association to join translation.
  */
 class JoinTree {
+  /**
+   *
+   * @param {sources} sources
+   */
   constructor(sources) {
+    /** @type {_roots} - A Map of root nodes. */
     this._roots = new Map()
+    /** @type {boolean} - A boolean indicating if the join tree is in its initial state. */
     this.isInitial = true
     /**
      * A map that holds query aliases which are used during the
@@ -53,6 +95,7 @@ class JoinTree {
      *
      * The table aliases are treated case insensitive. The index of each
      * table alias entry, is the capitalized version of the alias.
+     * @type {Map<string, string>}
      */
     this._queryAliases = new Map()
     Object.entries(sources).forEach(entry => {
@@ -82,6 +125,7 @@ class JoinTree {
    * Calculates and adds the next available table alias to the alias map.
    *
    * @param {string} alias - The original alias name.
+   * @param {unknown[]} outerQueries - An array of outer queries.
    * @returns {string} - The next unambiguous table alias.
    */
   addNextAvailableTableAlias(alias, outerQueries) {
@@ -107,7 +151,7 @@ class JoinTree {
    * For each step, it checks whether it has been seen before. If so, it resets the $refLink to point to the already merged $refLink.
    * If not, it creates a new Node and ensures proper aliasing and foreign key access.
    *
-   * @param {Object} col - The column object to be merged into the existing join tree. This object should have the properties $refLinks and ref.
+   * @param {object} col - The column object to be merged into the existing join tree. This object should have the properties $refLinks and ref.
    * @returns {boolean} - Always returns true, indicating the column has been successfully merged into the join tree.
    */
   mergeColumn(col) {
@@ -145,8 +189,9 @@ class JoinTree {
         }
         const child = new Node($refLink, node, where)
         if (child.$refLink.definition.isAssociation) {
-          if (child.where) {
-            // always join relevant
+          if (child.where || col.inline) {
+            // filter is always join relevant
+            // if the column ends up in an `inline` -> each assoc step is join relevant
             child.$refLink.onlyForeignKeyAccess = false
           } else {
             child.$refLink.onlyForeignKeyAccess = true

package/package.json

@@ -1,14 +1,22 @@
 {
   "name": "@cap-js/db-service",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "CDS base database service",
-  "homepage": "https://cap.cloud.sap/",
+  "homepage": "https://github.com/cap-js/cds-dbs/tree/main/db-service#cds-base-database-service",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/cap-js/cds-dbs"
+  },
+  "bugs": {
+    "url": "https://github.com/cap-js/cds-dbs/issues"
+  },
   "keywords": [
     "CAP",
     "CDS"
   ],
   "author": "SAP SE (https://www.sap.com)",
   "main": "index.js",
+  "types": "./dist/index.d.ts",
   "files": [
     "lib",
     "CHANGELOG.md"
@@ -19,12 +27,16 @@
   },
   "scripts": {
     "prettier": "npx prettier --write .",
-    "test": "npx jest --silent",
+    "test": "npm run build && npx jest --silent",
+    "build": "tsc && find lib/ -type f -name '*.d.ts' -exec cp '{}' 'dist/{}' ';' && cp ts.eslintrc.cjs dist/.eslintrc.cjs && npx eslint ./dist --ext .d.ts",
     "lint": "npx eslint . && npx prettier --check . "
   },
-  "dependencies": {},
   "peerDependencies": {
-    "@sap/cds": ">=7"
+    "@sap/cds": ">=7.1.1"
   },
-  "license": "SEE LICENSE"
+  "license": "SEE LICENSE",
+  "devDependencies": {
+    "@typescript-eslint/eslint-plugin": "^6.2.0",
+    "typescript": "^5.1.6"
+  }
 }