@nicia-ai/typegraph 0.34.0 → 0.36.0

package/dist/chunk-4BCU6VFZ.cjs

@@ -0,0 +1,100 @@
+'use strict';
+
+var chunkDIK74MXX_cjs = require('./chunk-DIK74MXX.cjs');
+
+// src/store/reserved-keys.ts
+var RESERVED_NODE_KEYS = /* @__PURE__ */ new Set([
+  "id",
+  "kind",
+  "meta"
+]);
+var RESERVED_EDGE_KEYS = /* @__PURE__ */ new Set([
+  "id",
+  "kind",
+  "meta",
+  "fromKind",
+  "fromId",
+  "toKind",
+  "toId"
+]);
+var PROTOTYPE_POLLUTION_KEYS = /* @__PURE__ */ new Set([
+  "__proto__",
+  "constructor",
+  "prototype"
+]);
+var RESERVED_PROPERTY_PREFIX = "$";
+function isReservedPropertyName(name) {
+  return name.startsWith(RESERVED_PROPERTY_PREFIX);
+}
+function assertSchemaKeysAreFree(entityKind, name, keys, reservedStructuralKeys) {
+  const structuralConflicts = keys.filter(
+    (key) => reservedStructuralKeys.has(key)
+  );
+  if (structuralConflicts.length > 0) {
+    const label = entityKind.toLowerCase();
+    throw new chunkDIK74MXX_cjs.ConfigurationError(
+      `${entityKind} "${name}" schema contains reserved property names: ${structuralConflicts.join(", ")}`,
+      {
+        [`${label}Type`]: name,
+        conflicts: structuralConflicts,
+        reservedKeys: [...reservedStructuralKeys]
+      },
+      {
+        suggestion: `Rename the conflicting properties. Reserved names (${[...reservedStructuralKeys].join(", ")}) are added automatically to all ${label}s.`
+      }
+    );
+  }
+  const prefixConflicts = keys.filter((key) => isReservedPropertyName(key));
+  if (prefixConflicts.length > 0) {
+    const label = entityKind.toLowerCase();
+    throw new chunkDIK74MXX_cjs.ConfigurationError(
+      `${entityKind} "${name}" schema uses the reserved "${RESERVED_PROPERTY_PREFIX}" prefix on: ${prefixConflicts.join(", ")}`,
+      {
+        [`${label}Type`]: name,
+        conflicts: prefixConflicts,
+        reservedPrefix: RESERVED_PROPERTY_PREFIX
+      },
+      {
+        suggestion: `Property names starting with "${RESERVED_PROPERTY_PREFIX}" are reserved for TypeGraph accessors (e.g. $fulltext). Rename each field.`
+      }
+    );
+  }
+}
+function validateProjectionField(field, entityType, kind) {
+  const reserved = entityType === "node" ? RESERVED_NODE_KEYS : RESERVED_EDGE_KEYS;
+  if (reserved.has(field)) {
+    throw new chunkDIK74MXX_cjs.ConfigurationError(
+      `Projection field "${field}" on ${entityType} kind "${kind}" conflicts with a reserved structural key`,
+      { field, kind, entityType, reservedKeys: [...reserved] },
+      {
+        suggestion: `Remove "${field}" from the projection. Structural fields (${[...reserved].join(", ")}) are included automatically when relevant.`
+      }
+    );
+  }
+  if (PROTOTYPE_POLLUTION_KEYS.has(field)) {
+    throw new chunkDIK74MXX_cjs.ConfigurationError(
+      `Projection field "${field}" on ${entityType} kind "${kind}" is not allowed`,
+      { field, kind, entityType },
+      {
+        suggestion: `"${field}" cannot be used as a projection field name.`
+      }
+    );
+  }
+}
+function filterReservedKeys(props, reservedKeys) {
+  const filtered = {};
+  for (const [key, value] of Object.entries(props)) {
+    if (!reservedKeys.has(key)) {
+      filtered[key] = value;
+    }
+  }
+  return filtered;
+}
+
+exports.RESERVED_EDGE_KEYS = RESERVED_EDGE_KEYS;
+exports.RESERVED_NODE_KEYS = RESERVED_NODE_KEYS;
+exports.assertSchemaKeysAreFree = assertSchemaKeysAreFree;
+exports.filterReservedKeys = filterReservedKeys;
+exports.validateProjectionField = validateProjectionField;
+//# sourceMappingURL=chunk-4BCU6VFZ.cjs.map
+//# sourceMappingURL=chunk-4BCU6VFZ.cjs.map

package/dist/chunk-4BCU6VFZ.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/store/reserved-keys.ts"],"names":["ConfigurationError"],"mappings":";;;;;AASO,IAAM,kBAAA,uBAA8C,GAAA,CAAI;AAAA,EAC7D,IAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAC;AAEM,IAAM,kBAAA,uBAA8C,GAAA,CAAI;AAAA,EAC7D,IAAA;AAAA,EACA,MAAA;AAAA,EACA,MAAA;AAAA,EACA,UAAA;AAAA,EACA,QAAA;AAAA,EACA,QAAA;AAAA,EACA;AACF,CAAC;AAED,IAAM,wBAAA,uBAAoD,GAAA,CAAI;AAAA,EAC5D,WAAA;AAAA,EACA,aAAA;AAAA,EACA;AACF,CAAC,CAAA;AAQD,IAAM,wBAAA,GAA2B,GAAA;AAQjC,SAAS,uBAAuB,IAAA,EAAuB;AACrD,EAAA,OAAO,IAAA,CAAK,WAAW,wBAAwB,CAAA;AACjD;AAQO,SAAS,uBAAA,CACd,UAAA,EACA,IAAA,EACA,IAAA,EACA,sBAAA,EACM;AACN,EAAA,MAAM,sBAAsB,IAAA,CAAK,MAAA;AAAA,IAAO,CAAC,GAAA,KACvC,sBAAA,CAAuB,GAAA,CAAI,GAAG;AAAA,GAChC;AACA,EAAA,IAAI,mBAAA,CAAoB,SAAS,CAAA,EAAG;AAClC,IAAA,MAAM,KAAA,GAAQ,WAAW,WAAA,EAAY;AACrC,IAAA,MAAM,IAAIA,oCAAA;AAAA,MACR,CAAA,EAAG,UAAU,CAAA,EAAA,EAAK,IAAI,8CAA8C,mBAAA,CAAoB,IAAA,CAAK,IAAI,CAAC,CAAA,CAAA;AAAA,MAClG;AAAA,QACE,CAAC,CAAA,EAAG,KAAK,CAAA,IAAA,CAAM,GAAG,IAAA;AAAA,QAClB,SAAA,EAAW,mBAAA;AAAA,QACX,YAAA,EAAc,CAAC,GAAG,sBAAsB;AAAA,OAC1C;AAAA,MACA;AAAA,QACE,UAAA,EAAY,CAAA,mDAAA,EAAsD,CAAC,GAAG,sBAAsB,EAAE,IAAA,CAAK,IAAI,CAAC,CAAA,iCAAA,EAAoC,KAAK,CAAA,EAAA;AAAA;AACnJ,KACF;AAAA,EACF;AAEA,EAAA,MAAM,kBAAkB,IAAA,CAAK,MAAA,CAAO,CAAC,GAAA,KAAQ,sBAAA,CAAuB,GAAG,CAAC,CAAA;AACxE,EAAA,IAAI,eAAA,CAAgB,SAAS,CAAA,EAAG;AAC9B,IAAA,MAAM,KAAA,GAAQ,WAAW,WAAA,EAAY;AACrC,IAAA,MAAM,IAAIA,oCAAA;AAAA,MACR,CAAA,EAAG,UAAU,CAAA,EAAA,EAAK,IAAI,CAAA,4BAAA,EAA+B,wBAAwB,CAAA,aAAA,EAAgB,eAAA,CAAgB,IAAA,CAAK,IAAI,CAAC,CAAA,CAAA;AAAA,MACvH;AAAA,QACE,CAAC,CAAA,EAAG,KAAK,CAAA,IAAA,CAAM,GAAG,IAAA;AAAA,QAClB,SAAA,EAAW,eAAA;AAAA,QACX,cAAA,EAAgB;AAAA,OAClB;AAAA,MACA;AAAA,QACE,UAAA,EAAY,iCAAiC,wBAAwB,CAAA,2EAAA;AAAA;AACvE,KACF;AAAA,EACF;AACF;AAQO,SAAS,uBAAA,CACd,KAAA,EACA,UAAA,EACA,IAAA,EACM;AACN,EAAA,MAAM,QAAA,GACJ,UAAA,KAAe,MAAA,GAAS,kBAAA,GAAqB,kBAAA;AAE/C,EAAA,IAAI,QAAA,CAAS,GAAA,CAAI,KAAK,CAAA,EAAG;AACvB,IAAA,MAAM,IAAIA,oCAAA;AAAA,MACR,CAAA,kBAAA,EAAqB,KAAK,CAAA,KAAA,EAAQ,UAAU,UAAU,IAAI,CAAA,0CAAA,CAAA;AAAA,MAC1D,EAAE,OAAO,IAAA,EAAM,UAAA,EAAY,cAAc,CAAC,GAAG,QAAQ,CAAA,EAAE;AAAA,MACvD;AAAA,QACE,UAAA,EAAY,CAAA,QAAA,EAAW,KAAK,CAAA,0CAAA,EAA6C,CAAC,GAAG,QAAQ,CAAA,CAAE,IAAA,CAAK,IAAI,CAAC,CAAA,2CAAA;AAAA;AACnG,KACF;AAAA,EACF;AAEA,EAAA,IAAI,wBAAA,CAAyB,GAAA,CAAI,KAAK,CAAA,EAAG;AACvC,IAAA,MAAM,IAAIA,oCAAA;AAAA,MACR,CAAA,kBAAA,EAAqB,KAAK,CAAA,KAAA,EAAQ,UAAU,UAAU,IAAI,CAAA,gBAAA,CAAA;AAAA,MAC1D,EAAE,KAAA,EAAO,IAAA,EAAM,UAAA,EAAW;AAAA,MAC1B;AAAA,QACE,UAAA,EAAY,IAAI,KAAK,CAAA,4CAAA;AAAA;AACvB,KACF;AAAA,EACF;AACF;AAKO,SAAS,kBAAA,CACd,OACA,YAAA,EACyB;AACzB,EAAA,MAAM,WAAoC,EAAC;AAC3C,EAAA,KAAA,MAAW,CAAC,GAAA,EAAK,KAAK,KAAK,MAAA,CAAO,OAAA,CAAQ,KAAK,CAAA,EAAG;AAChD,IAAA,IAAI,CAAC,YAAA,CAAa,GAAA,CAAI,GAAG,CAAA,EAAG;AAC1B,MAAA,QAAA,CAAS,GAAG,CAAA,GAAI,KAAA;AAAA,IAClB;AAAA,EACF;AACA,EAAA,OAAO,QAAA;AACT","file":"chunk-4BCU6VFZ.cjs","sourcesContent":["/**\n * Reserved Keys for Store Entities\n *\n * Structural keys that cannot be overwritten by user-defined properties.\n * Shared across row-mappers, subgraph projection, and schema validation.\n */\nimport type { KindEntity } from \"../core/types\";\nimport { ConfigurationError } from \"../errors\";\n\nexport const RESERVED_NODE_KEYS: ReadonlySet<string> = new Set([\n  \"id\",\n  \"kind\",\n  \"meta\",\n]);\n\nexport const RESERVED_EDGE_KEYS: ReadonlySet<string> = new Set([\n  \"id\",\n  \"kind\",\n  \"meta\",\n  \"fromKind\",\n  \"fromId\",\n  \"toKind\",\n  \"toId\",\n]);\n\nconst PROTOTYPE_POLLUTION_KEYS: ReadonlySet<string> = new Set([\n  \"__proto__\",\n  \"constructor\",\n  \"prototype\",\n]);\n\n/**\n * Properties starting with `$` are reserved for TypeGraph-owned accessors\n * on the query-builder node/edge proxies (today: `$fulltext`). Reserving\n * the whole prefix — not just the currently-used names — keeps future\n * accessors (e.g. `$vector`, `$json`) from colliding with user fields.\n */\nconst RESERVED_PROPERTY_PREFIX = \"$\";\n\n/**\n * True if a user-defined field name is reserved by TypeGraph's accessor\n * namespace. `defineNode` / `defineEdge` call this against schema keys so\n * the collision fails fast at graph-definition time rather than silently\n * at query time.\n */\nfunction isReservedPropertyName(name: string): boolean {\n  return name.startsWith(RESERVED_PROPERTY_PREFIX);\n}\n\n/**\n * Validates that a node or edge schema does not use any reserved property\n * name. Covers both the structural keys (`id`, `kind`, etc.) and the\n * `$`-prefix accessor namespace. Throws a single `ConfigurationError`\n * per conflict class so the user sees all collisions in one pass.\n */\nexport function assertSchemaKeysAreFree(\n  entityKind: \"Node\" | \"Edge\",\n  name: string,\n  keys: readonly string[],\n  reservedStructuralKeys: ReadonlySet<string>,\n): void {\n  const structuralConflicts = keys.filter((key) =>\n    reservedStructuralKeys.has(key),\n  );\n  if (structuralConflicts.length > 0) {\n    const label = entityKind.toLowerCase();\n    throw new ConfigurationError(\n      `${entityKind} \"${name}\" schema contains reserved property names: ${structuralConflicts.join(\", \")}`,\n      {\n        [`${label}Type`]: name,\n        conflicts: structuralConflicts,\n        reservedKeys: [...reservedStructuralKeys],\n      },\n      {\n        suggestion: `Rename the conflicting properties. Reserved names (${[...reservedStructuralKeys].join(\", \")}) are added automatically to all ${label}s.`,\n      },\n    );\n  }\n\n  const prefixConflicts = keys.filter((key) => isReservedPropertyName(key));\n  if (prefixConflicts.length > 0) {\n    const label = entityKind.toLowerCase();\n    throw new ConfigurationError(\n      `${entityKind} \"${name}\" schema uses the reserved \"${RESERVED_PROPERTY_PREFIX}\" prefix on: ${prefixConflicts.join(\", \")}`,\n      {\n        [`${label}Type`]: name,\n        conflicts: prefixConflicts,\n        reservedPrefix: RESERVED_PROPERTY_PREFIX,\n      },\n      {\n        suggestion: `Property names starting with \"${RESERVED_PROPERTY_PREFIX}\" are reserved for TypeGraph accessors (e.g. $fulltext). Rename each field.`,\n      },\n    );\n  }\n}\n\n/**\n * Validates that a projection field name is safe to assign onto a result object.\n * Rejects reserved structural keys and prototype-pollution vectors.\n *\n * @throws ConfigurationError if the field is reserved or dangerous\n */\nexport function validateProjectionField(\n  field: string,\n  entityType: KindEntity,\n  kind: string,\n): void {\n  const reserved =\n    entityType === \"node\" ? RESERVED_NODE_KEYS : RESERVED_EDGE_KEYS;\n\n  if (reserved.has(field)) {\n    throw new ConfigurationError(\n      `Projection field \"${field}\" on ${entityType} kind \"${kind}\" conflicts with a reserved structural key`,\n      { field, kind, entityType, reservedKeys: [...reserved] },\n      {\n        suggestion: `Remove \"${field}\" from the projection. Structural fields (${[...reserved].join(\", \")}) are included automatically when relevant.`,\n      },\n    );\n  }\n\n  if (PROTOTYPE_POLLUTION_KEYS.has(field)) {\n    throw new ConfigurationError(\n      `Projection field \"${field}\" on ${entityType} kind \"${kind}\" is not allowed`,\n      { field, kind, entityType },\n      {\n        suggestion: `\"${field}\" cannot be used as a projection field name.`,\n      },\n    );\n  }\n}\n\n/**\n * Filters out reserved keys from a props object to prevent runtime collisions.\n */\nexport function filterReservedKeys(\n  props: Record<string, unknown>,\n  reservedKeys: ReadonlySet<string>,\n): Record<string, unknown> {\n  const filtered: Record<string, unknown> = {};\n  for (const [key, value] of Object.entries(props)) {\n    if (!reservedKeys.has(key)) {\n      filtered[key] = value;\n    }\n  }\n  return filtered;\n}\n"]}

package/dist/chunk-4BMPGT35.cjs

@@ -0,0 +1,12 @@
+'use strict';
+
+var chunkJ3LEGNQB_cjs = require('./chunk-J3LEGNQB.cjs');
+
+// src/graph-extension/define-graph-extension.ts
+function defineGraphExtension(input) {
+  return chunkJ3LEGNQB_cjs.unwrap(chunkJ3LEGNQB_cjs.validateGraphExtension(input, { strict: true }));
+}
+
+exports.defineGraphExtension = defineGraphExtension;
+//# sourceMappingURL=chunk-4BMPGT35.cjs.map
+//# sourceMappingURL=chunk-4BMPGT35.cjs.map

package/dist/{chunk-HMFK4BXR.cjs.map → chunk-4BMPGT35.cjs.map}

@@ -1 +1 @@
-{"version":3,"sources":["../src/graph-extension/define-graph-extension.ts"],"names":["unwrap","validateGraphExtension"],"mappings":";;;;;AAyDO,SAAS,qBAAqB,KAAA,EAAuC;AAC1E,EAAA,OAAOA,yBAAOC,wCAAA,CAAuB,KAAA,EAAO,EAAE,MAAA,EAAQ,IAAA,EAAM,CAAC,CAAA;AAC/D","file":"chunk-HMFK4BXR.cjs","sourcesContent":["/**\n * Public entry for declaring a graph extension.\n *\n * Pure value: validates the input, deeply freezes the result, and returns\n * a `GraphExtension`. Invalid documents throw\n * `GraphExtensionValidationError` carrying every issue with a\n * JSON-pointer `path` to the offending field.\n */\nimport { unwrap } from \"../utils/result\";\nimport { type GraphExtension } from \"./extension-types\";\nimport { validateGraphExtension } from \"./validation\";\n\n/**\n * Validates and freezes a graph-extension document.\n *\n * Authoring entry point — runs validation in **strict** mode: unknown\n * top-level keys (e.g. `node` instead of `nodes`) and unsupported\n * string formats (e.g. `\"date-time\"` with a hyphen instead of\n * `\"datetime\"`) fail loudly with `UNKNOWN_DOCUMENT_KEY` /\n * `UNSUPPORTED_STRING_FORMAT`. The persistence-load path leaves both\n * checks off so a document committed by a future v1.x writer with\n * additive fields still parses on an older v1 reader. Callers\n * accepting raw JSON from an untyped source (e.g. an LLM proposal)\n * should validate first via `validateGraphExtension` and surface\n * the structured issues, then pass the validated document here.\n *\n * @param input - Document describing additional node kinds, edge\n *   kinds, and ontology relations. Must satisfy the v1 property-type\n *   subset documented in `ExtensionPropertyType`.\n *\n * @returns The same document, deeply frozen and shape-checked.\n *\n * @throws {GraphExtensionValidationError} when the document violates\n *   the v1 property-type subset, references undeclared kinds, contains\n *   ontology cycles, etc. The thrown error's `details.issues` array\n *   carries every failure with a JSON-pointer path.\n * @throws {GraphExtensionVersionUnsupportedError} when the document\n *   declares a future major version this library cannot safely decode.\n *\n * @example\n * ```typescript\n * const extension = defineGraphExtension({\n *   nodes: {\n *     Paper: {\n *       properties: {\n *         doi:   { type: \"string\" },\n *         title: { type: \"string\", searchable: { language: \"english\" } },\n *       },\n *       unique: [{ name: \"paper_doi\", fields: [\"doi\"] }],\n *     },\n *   },\n * });\n *\n * const evolved = await store.evolve(extension);\n * const papers = evolved.getNodeCollectionOrThrow(\"Paper\");\n * ```\n */\nexport function defineGraphExtension(input: GraphExtension): GraphExtension {\n  return unwrap(validateGraphExtension(input, { strict: true }));\n}\n"]}
+{"version":3,"sources":["../src/graph-extension/define-graph-extension.ts"],"names":["unwrap","validateGraphExtension"],"mappings":";;;;;AAyDO,SAAS,qBAAqB,KAAA,EAAuC;AAC1E,EAAA,OAAOA,yBAAOC,wCAAA,CAAuB,KAAA,EAAO,EAAE,MAAA,EAAQ,IAAA,EAAM,CAAC,CAAA;AAC/D","file":"chunk-4BMPGT35.cjs","sourcesContent":["/**\n * Public entry for declaring a graph extension.\n *\n * Pure value: validates the input, deeply freezes the result, and returns\n * a `GraphExtension`. Invalid documents throw\n * `GraphExtensionValidationError` carrying every issue with a\n * JSON-pointer `path` to the offending field.\n */\nimport { unwrap } from \"../utils/result\";\nimport { type GraphExtension } from \"./extension-types\";\nimport { validateGraphExtension } from \"./validation\";\n\n/**\n * Validates and freezes a graph-extension document.\n *\n * Authoring entry point — runs validation in **strict** mode: unknown\n * top-level keys (e.g. `node` instead of `nodes`) and unsupported\n * string formats (e.g. `\"date-time\"` with a hyphen instead of\n * `\"datetime\"`) fail loudly with `UNKNOWN_DOCUMENT_KEY` /\n * `UNSUPPORTED_STRING_FORMAT`. The persistence-load path leaves both\n * checks off so a document committed by a future v1.x writer with\n * additive fields still parses on an older v1 reader. Callers\n * accepting raw JSON from an untyped source (e.g. an LLM proposal)\n * should validate first via `validateGraphExtension` and surface\n * the structured issues, then pass the validated document here.\n *\n * @param input - Document describing additional node kinds, edge\n *   kinds, and ontology relations. Must satisfy the v1 property-type\n *   subset documented in `ExtensionPropertyType`.\n *\n * @returns The same document, deeply frozen and shape-checked.\n *\n * @throws {GraphExtensionValidationError} when the document violates\n *   the v1 property-type subset, references undeclared kinds, contains\n *   ontology cycles, etc. The thrown error's `details.issues` array\n *   carries every failure with a JSON-pointer path.\n * @throws {GraphExtensionVersionUnsupportedError} when the document\n *   declares a future major version this library cannot safely decode.\n *\n * @example\n * ```typescript\n * const extension = defineGraphExtension({\n *   nodes: {\n *     Paper: {\n *       properties: {\n *         doi:   { type: \"string\" },\n *         title: { type: \"string\", searchable: { language: \"english\" } },\n *       },\n *       unique: [{ name: \"paper_doi\", fields: [\"doi\"] }],\n *     },\n *   },\n * });\n *\n * const evolved = await store.evolve(extension);\n * const papers = evolved.getNodeCollectionOrThrow(\"Paper\");\n * ```\n */\nexport function defineGraphExtension(input: GraphExtension): GraphExtension {\n  return unwrap(validateGraphExtension(input, { strict: true }));\n}\n"]}