@nicia-ai/typegraph 0.34.0 → 0.35.0

package/dist/{extension-types-YGFJPrzK.d.cts → extension-types-ixRpJVUp.d.cts}

@@ -81,6 +81,18 @@ type NodeType<K extends string = string, S extends z.ZodObject<z.ZodRawShape> =
 type NodeId<N extends NodeType> = string & Readonly<{
     [__nodeId]: N;
 }>;
+/**
+ * Brands a non-empty string as a {@link NodeId}.
+ *
+ * Use this when a persisted node id has round-tripped through untyped storage
+ * or an external boundary and must be passed back to read/update/delete
+ * surfaces such as `getById`, `getByIds`, `update`, or `delete`.
+ * Write surfaces that mint or claim ids, such as `create({ id })` and
+ * `upsertById`, intentionally accept plain strings.
+ *
+ * @throws {ValidationError} when `value` is empty.
+ */
+declare function asNodeId<N extends NodeType = NodeType>(value: string): NodeId<N>;
 /**
  * Infer the props type from a NodeType.
  */
@@ -120,6 +132,17 @@ type EdgeTypeWithEndpoints = EdgeType<string, z.ZodObject<z.ZodRawShape>, readon
 type EdgeId<E extends AnyEdgeType = AnyEdgeType> = string & Readonly<{
     [__edgeId]: E;
 }>;
+/**
+ * Brands a non-empty string as an {@link EdgeId}.
+ *
+ * Use this when a persisted edge id has round-tripped through untyped storage
+ * or an external boundary and must be passed back to read/update/delete
+ * surfaces such as `getById`, `getByIds`, `update`, or `delete`.
+ * Write surfaces that mint ids intentionally accept plain strings.
+ *
+ * @throws {ValidationError} when `value` is empty.
+ */
+declare function asEdgeId<E extends AnyEdgeType = AnyEdgeType>(value: string): EdgeId<E>;
 /**
  * Infer the props type from an EdgeType.
  */
@@ -540,4 +563,4 @@ type GraphExtension = Readonly<{
 declare const GRAPH_EXTENSION_TOP_LEVEL_KEYS: readonly ["version", "nodes", "edges", "ontology", "indexes"];
 type GraphExtensionTopLevelKey = (typeof GRAPH_EXTENSION_TOP_LEVEL_KEYS)[number];
 
-export { type AnyEdgeType as A, type ExtensionEmbeddingModifier as B, CURRENT_GRAPH_EXTENSION_VERSION as C, type DeleteBehavior as D, type EdgeRegistration as E, type ExtensionEnumProperty as F, type GraphExtension as G, type ExtensionIndexWhere as H, type IndexEntity as I, type JsonValue as J, type KindEntity as K, LEGACY_GRAPH_EXTENSION_VERSION as L, type ExtensionNodeIndex as M, type NodeType as N, type ExtensionNumberProperty as O, type ExtensionObjectFieldProperty as P, type ExtensionObjectProperty as Q, type ExtensionPropertyType as R, type ExtensionSearchableModifier as S, type TemporalMode as T, type UniqueConstraint as U, type ExtensionStringProperty as V, type ExtensionUniqueConstraint as W, type ExtensionUniqueWhere as X, GRAPH_EXTENSION_TOP_LEVEL_KEYS as Y, type GraphExtensionTopLevelKey as Z, type NullCheckOp as a, type NodeRegistration as b, type GraphDefaults as c, type NodeId as d, type EdgeId as e, type KindAnnotations as f, type EdgeType as g, type GraphExtensionVersion as h, type ExtensionNodeDef as i, type ExtensionEdgeDef as j, type ExtensionOntologyRelation as k, type ExtensionIndex as l, type Cardinality as m, type Collation as n, type EdgeProps as o, type EdgeTypeWithEndpoints as p, type EndpointExistence as q, type NodeProps as r, type UniquenessScope as s, isEdgeType as t, isEdgeTypeWithEndpoints as u, isNodeType as v, type ExtensionArrayItemType as w, type ExtensionArrayProperty as x, type ExtensionBooleanProperty as y, type ExtensionEdgeIndex as z };
+export { type GraphExtensionTopLevelKey as $, type AnyEdgeType as A, type ExtensionBooleanProperty as B, CURRENT_GRAPH_EXTENSION_VERSION as C, type DeleteBehavior as D, type EdgeRegistration as E, type ExtensionEdgeIndex as F, type GraphExtension as G, type ExtensionEmbeddingModifier as H, type IndexEntity as I, type JsonValue as J, type KindEntity as K, LEGACY_GRAPH_EXTENSION_VERSION as L, type ExtensionEnumProperty as M, type NodeType as N, type ExtensionIndexWhere as O, type ExtensionNodeIndex as P, type ExtensionNumberProperty as Q, type ExtensionObjectFieldProperty as R, type ExtensionObjectProperty as S, type TemporalMode as T, type UniqueConstraint as U, type ExtensionPropertyType as V, type ExtensionSearchableModifier as W, type ExtensionStringProperty as X, type ExtensionUniqueConstraint as Y, type ExtensionUniqueWhere as Z, GRAPH_EXTENSION_TOP_LEVEL_KEYS as _, type NullCheckOp as a, type NodeRegistration as b, type GraphDefaults as c, type NodeId as d, type EdgeId as e, type KindAnnotations as f, type EdgeType as g, type GraphExtensionVersion as h, type ExtensionNodeDef as i, type ExtensionEdgeDef as j, type ExtensionOntologyRelation as k, type ExtensionIndex as l, type Cardinality as m, type Collation as n, type EdgeProps as o, type EdgeTypeWithEndpoints as p, type EndpointExistence as q, type NodeProps as r, type UniquenessScope as s, asEdgeId as t, asNodeId as u, isEdgeType as v, isEdgeTypeWithEndpoints as w, isNodeType as x, type ExtensionArrayItemType as y, type ExtensionArrayProperty as z };

package/dist/{extension-types-YGFJPrzK.d.ts → extension-types-ixRpJVUp.d.ts}

@@ -81,6 +81,18 @@ type NodeType<K extends string = string, S extends z.ZodObject<z.ZodRawShape> =
 type NodeId<N extends NodeType> = string & Readonly<{
     [__nodeId]: N;
 }>;
+/**
+ * Brands a non-empty string as a {@link NodeId}.
+ *
+ * Use this when a persisted node id has round-tripped through untyped storage
+ * or an external boundary and must be passed back to read/update/delete
+ * surfaces such as `getById`, `getByIds`, `update`, or `delete`.
+ * Write surfaces that mint or claim ids, such as `create({ id })` and
+ * `upsertById`, intentionally accept plain strings.
+ *
+ * @throws {ValidationError} when `value` is empty.
+ */
+declare function asNodeId<N extends NodeType = NodeType>(value: string): NodeId<N>;
 /**
  * Infer the props type from a NodeType.
  */
@@ -120,6 +132,17 @@ type EdgeTypeWithEndpoints = EdgeType<string, z.ZodObject<z.ZodRawShape>, readon
 type EdgeId<E extends AnyEdgeType = AnyEdgeType> = string & Readonly<{
     [__edgeId]: E;
 }>;
+/**
+ * Brands a non-empty string as an {@link EdgeId}.
+ *
+ * Use this when a persisted edge id has round-tripped through untyped storage
+ * or an external boundary and must be passed back to read/update/delete
+ * surfaces such as `getById`, `getByIds`, `update`, or `delete`.
+ * Write surfaces that mint ids intentionally accept plain strings.
+ *
+ * @throws {ValidationError} when `value` is empty.
+ */
+declare function asEdgeId<E extends AnyEdgeType = AnyEdgeType>(value: string): EdgeId<E>;
 /**
  * Infer the props type from an EdgeType.
  */
@@ -540,4 +563,4 @@ type GraphExtension = Readonly<{
 declare const GRAPH_EXTENSION_TOP_LEVEL_KEYS: readonly ["version", "nodes", "edges", "ontology", "indexes"];
 type GraphExtensionTopLevelKey = (typeof GRAPH_EXTENSION_TOP_LEVEL_KEYS)[number];
 
-export { type AnyEdgeType as A, type ExtensionEmbeddingModifier as B, CURRENT_GRAPH_EXTENSION_VERSION as C, type DeleteBehavior as D, type EdgeRegistration as E, type ExtensionEnumProperty as F, type GraphExtension as G, type ExtensionIndexWhere as H, type IndexEntity as I, type JsonValue as J, type KindEntity as K, LEGACY_GRAPH_EXTENSION_VERSION as L, type ExtensionNodeIndex as M, type NodeType as N, type ExtensionNumberProperty as O, type ExtensionObjectFieldProperty as P, type ExtensionObjectProperty as Q, type ExtensionPropertyType as R, type ExtensionSearchableModifier as S, type TemporalMode as T, type UniqueConstraint as U, type ExtensionStringProperty as V, type ExtensionUniqueConstraint as W, type ExtensionUniqueWhere as X, GRAPH_EXTENSION_TOP_LEVEL_KEYS as Y, type GraphExtensionTopLevelKey as Z, type NullCheckOp as a, type NodeRegistration as b, type GraphDefaults as c, type NodeId as d, type EdgeId as e, type KindAnnotations as f, type EdgeType as g, type GraphExtensionVersion as h, type ExtensionNodeDef as i, type ExtensionEdgeDef as j, type ExtensionOntologyRelation as k, type ExtensionIndex as l, type Cardinality as m, type Collation as n, type EdgeProps as o, type EdgeTypeWithEndpoints as p, type EndpointExistence as q, type NodeProps as r, type UniquenessScope as s, isEdgeType as t, isEdgeTypeWithEndpoints as u, isNodeType as v, type ExtensionArrayItemType as w, type ExtensionArrayProperty as x, type ExtensionBooleanProperty as y, type ExtensionEdgeIndex as z };
+export { type GraphExtensionTopLevelKey as $, type AnyEdgeType as A, type ExtensionBooleanProperty as B, CURRENT_GRAPH_EXTENSION_VERSION as C, type DeleteBehavior as D, type EdgeRegistration as E, type ExtensionEdgeIndex as F, type GraphExtension as G, type ExtensionEmbeddingModifier as H, type IndexEntity as I, type JsonValue as J, type KindEntity as K, LEGACY_GRAPH_EXTENSION_VERSION as L, type ExtensionEnumProperty as M, type NodeType as N, type ExtensionIndexWhere as O, type ExtensionNodeIndex as P, type ExtensionNumberProperty as Q, type ExtensionObjectFieldProperty as R, type ExtensionObjectProperty as S, type TemporalMode as T, type UniqueConstraint as U, type ExtensionPropertyType as V, type ExtensionSearchableModifier as W, type ExtensionStringProperty as X, type ExtensionUniqueConstraint as Y, type ExtensionUniqueWhere as Z, GRAPH_EXTENSION_TOP_LEVEL_KEYS as _, type NullCheckOp as a, type NodeRegistration as b, type GraphDefaults as c, type NodeId as d, type EdgeId as e, type KindAnnotations as f, type EdgeType as g, type GraphExtensionVersion as h, type ExtensionNodeDef as i, type ExtensionEdgeDef as j, type ExtensionOntologyRelation as k, type ExtensionIndex as l, type Cardinality as m, type Collation as n, type EdgeProps as o, type EdgeTypeWithEndpoints as p, type EndpointExistence as q, type NodeProps as r, type UniquenessScope as s, asEdgeId as t, asNodeId as u, isEdgeType as v, isEdgeTypeWithEndpoints as w, isNodeType as x, type ExtensionArrayItemType as y, type ExtensionArrayProperty as z };