@dbsp/types 1.1.0 → 1.2.0

package/dist/internal.d.ts

@@ -44,5 +44,22 @@ type IntentBuilder<T, TRequired extends keyof T> = Pick<T, TRequired> & Partial<
  * not let callers forge the marker through the global symbol registry.
  */
 declare const NQL_INTERNAL_COMPILER_OPTIONS: unique symbol;
+declare const NQL_BINDING_REF: unique symbol;
+/**
+ * @internal Opaque marker for NQL compiler-created binding references.
+ *
+ * The brand is a module-private Symbol(), so JSON/plain object inputs cannot
+ * forge it by shape.
+ */
+interface NqlBindingRef {
+    readonly name: string;
+    readonly [NQL_BINDING_REF]: true;
+}
+/** @internal */
+declare function createNqlBindingRef(name: string): NqlBindingRef;
+/** @internal */
+declare function isNqlBindingRef(value: unknown): value is NqlBindingRef;
+/** @internal */
+declare function getNqlBindingRefName(ref: NqlBindingRef): string;
 
-export { type IntentBuilder, type Mutable, NQL_INTERNAL_COMPILER_OPTIONS };
+export { type IntentBuilder, type Mutable, NQL_INTERNAL_COMPILER_OPTIONS, type NqlBindingRef, createNqlBindingRef, getNqlBindingRefName, isNqlBindingRef };

package/dist/internal.js

@@ -57,6 +57,25 @@ import {
 var NQL_INTERNAL_COMPILER_OPTIONS = /* @__PURE__ */ Symbol(
   "@dbsp/nql/internalCompilerOptions"
 );
+var NQL_BINDING_REF = /* @__PURE__ */ Symbol("@dbsp/nql/bindingRef");
+function createNqlBindingRef(name) {
+  const ref = { name };
+  Object.defineProperty(ref, NQL_BINDING_REF, {
+    value: true,
+    enumerable: false
+  });
+  return ref;
+}
+function isNqlBindingRef(value) {
+  if (value === null || typeof value !== "object") {
+    return false;
+  }
+  const record = value;
+  return Object.hasOwn(record, NQL_BINDING_REF) && record[NQL_BINDING_REF] === true && typeof record.name === "string";
+}
+function getNqlBindingRefName(ref) {
+  return ref.name;
+}
 export {
   NQL_INTERNAL_COMPILER_OPTIONS,
   NQL_SELECT_AGGREGATE_FUNCTIONS,
@@ -68,7 +87,9 @@ export {
   NQL_SELECT_WINDOW_FUNCTIONS,
   NQL_SELECT_WINDOW_FUNCTION_ALLOWLIST,
   NQL_SELECT_WINDOW_ONLY_FUNCTIONS,
+  createNqlBindingRef,
   getNodeIdAlias,
+  getNqlBindingRefName,
   isAdjacencyTraversal,
   isAggregateWindowFunction,
   isCoalesceExpression,
@@ -79,6 +100,7 @@ export {
   isFieldRef,
   isInsertIntent,
   isMutationIntent,
+  isNqlBindingRef,
   isNqlSelectFunctionAllowed,
   isNqlSelectScalarFunctionAllowed,
   isNqlSelectWindowFunctionAllowed,

package/dist/internal.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/internal.ts"],"sourcesContent":["/**\n * @dbsp/types/internal - Internal type definitions\n *\n * These types are for internal use by @dbsp package implementations.\n * They are NOT part of the public API and may change without notice.\n *\n * @module @dbsp/types/internal\n * @internal\n */\n\n// Internal-only build utilities (NOT part of public API)\nexport type { IntentBuilder, Mutable } from './builders.js';\n\n/**\n * @internal Shared compiler-options marker for trusted NQL package internals.\n *\n * Deliberately uses Symbol(), not Symbol.for(), so knowing the description does\n * not let callers forge the marker through the global symbol registry.\n */\nexport const NQL_INTERNAL_COMPILER_OPTIONS: unique symbol = Symbol(\n\t'@dbsp/nql/internalCompilerOptions',\n);\n\n// Re-export all public types for convenience\nexport * from './index.js';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmBO,IAAM,gCAA+C;AAAA,EAC3D;AACD;","names":[]}
+{"version":3,"sources":["../src/internal.ts"],"sourcesContent":["/**\n * @dbsp/types/internal - Internal type definitions\n *\n * These types are for internal use by @dbsp package implementations.\n * They are NOT part of the public API and may change without notice.\n *\n * @module @dbsp/types/internal\n * @internal\n */\n\n// Internal-only build utilities (NOT part of public API)\nexport type { IntentBuilder, Mutable } from './builders.js';\n\n/**\n * @internal Shared compiler-options marker for trusted NQL package internals.\n *\n * Deliberately uses Symbol(), not Symbol.for(), so knowing the description does\n * not let callers forge the marker through the global symbol registry.\n */\nexport const NQL_INTERNAL_COMPILER_OPTIONS: unique symbol = Symbol(\n\t'@dbsp/nql/internalCompilerOptions',\n);\n\nconst NQL_BINDING_REF = Symbol('@dbsp/nql/bindingRef');\n\n/**\n * @internal Opaque marker for NQL compiler-created binding references.\n *\n * The brand is a module-private Symbol(), so JSON/plain object inputs cannot\n * forge it by shape.\n */\nexport interface NqlBindingRef {\n\treadonly name: string;\n\treadonly [NQL_BINDING_REF]: true;\n}\n\n/** @internal */\nexport function createNqlBindingRef(name: string): NqlBindingRef {\n\tconst ref = { name } as { name: string; [NQL_BINDING_REF]?: true };\n\tObject.defineProperty(ref, NQL_BINDING_REF, {\n\t\tvalue: true,\n\t\tenumerable: false,\n\t});\n\treturn ref as NqlBindingRef;\n}\n\n/** @internal */\nexport function isNqlBindingRef(value: unknown): value is NqlBindingRef {\n\tif (value === null || typeof value !== 'object') {\n\t\treturn false;\n\t}\n\tconst record = value as {\n\t\treadonly name?: unknown;\n\t\treadonly [NQL_BINDING_REF]?: unknown;\n\t};\n\treturn (\n\t\tObject.hasOwn(record, NQL_BINDING_REF) &&\n\t\trecord[NQL_BINDING_REF] === true &&\n\t\ttypeof record.name === 'string'\n\t);\n}\n\n/** @internal */\nexport function getNqlBindingRefName(ref: NqlBindingRef): string {\n\treturn ref.name;\n}\n\n// Re-export all public types for convenience\nexport * from './index.js';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmBO,IAAM,gCAA+C;AAAA,EAC3D;AACD;AAEA,IAAM,kBAAkB,uBAAO,sBAAsB;AAc9C,SAAS,oBAAoB,MAA6B;AAChE,QAAM,MAAM,EAAE,KAAK;AACnB,SAAO,eAAe,KAAK,iBAAiB;AAAA,IAC3C,OAAO;AAAA,IACP,YAAY;AAAA,EACb,CAAC;AACD,SAAO;AACR;AAGO,SAAS,gBAAgB,OAAwC;AACvE,MAAI,UAAU,QAAQ,OAAO,UAAU,UAAU;AAChD,WAAO;AAAA,EACR;AACA,QAAM,SAAS;AAIf,SACC,OAAO,OAAO,QAAQ,eAAe,KACrC,OAAO,eAAe,MAAM,QAC5B,OAAO,OAAO,SAAS;AAEzB;AAGO,SAAS,qBAAqB,KAA4B;AAChE,SAAO,IAAI;AACZ;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dbsp/types",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Shared type definitions for the db-semantic-planner ecosystem",
   "author": "Olivier Orabona <oorabona@users.noreply.github.com>",
   "license": "MIT",