@nicia-ai/typegraph 0.35.0 → 0.36.0

package/dist/{index-6CSUAq-x.d.ts → index-BFvdmBPV.d.ts}

@@ -501,6 +501,73 @@ declare class ConfigurationError extends TypeGraphError {
         suggestion?: string;
     });
 }
+/**
+ * The stable `details.code` values raised by the recorded-capture guards on a
+ * history- or revision-tracked store. These are the sanctioned branch points
+ * for a portable caller that must pick a transaction strategy without
+ * substring-matching {@link ConfigurationError} messages.
+ *
+ * - `RECORDED_CAPTURE_REQUIRES_CALLBACK_TRANSACTION`: `store.withTransaction`
+ *   was called on a history-enabled store, which has no flush point before the
+ *   caller commits — use `store.withRecordedTransaction` instead.
+ * - `RECORDED_CAPTURE_RAW_SQL_DISABLED`: a raw SQL escape (`tx.sql`,
+ *   `backend.executeStatement`/`executeDdl`) was reached on a history-enabled
+ *   store, where it would bypass recorded-time capture.
+ * - `REVISION_TRACKING_RAW_SQL_DISABLED`: the same raw SQL escape on a
+ *   revision-tracked store, where it would bypass the revision anchor.
+ *
+ * @see isRecordedCaptureGuardError
+ */
+declare const RECORDED_CAPTURE_GUARD_CODES: readonly ["RECORDED_CAPTURE_REQUIRES_CALLBACK_TRANSACTION", "RECORDED_CAPTURE_RAW_SQL_DISABLED", "REVISION_TRACKING_RAW_SQL_DISABLED"];
+/** A stable, branchable code raised by a recorded-capture guard. */
+type RecordedCaptureGuardCode = (typeof RECORDED_CAPTURE_GUARD_CODES)[number];
+/**
+ * A {@link ConfigurationError} narrowed to carry a {@link RecordedCaptureGuardCode}
+ * in `details.code` — the shape {@link isRecordedCaptureGuardError} guarantees.
+ * `C` narrows `details.code` to a single code when the guard was called with a
+ * specific one; it defaults to the full union.
+ */
+type RecordedCaptureGuardError<C extends RecordedCaptureGuardCode = RecordedCaptureGuardCode> = ConfigurationError & Readonly<{
+    details: Readonly<{
+        code: C;
+    }>;
+}>;
+/**
+ * Type guard for the recorded-capture guard errors, so a portable caller can
+ * branch on the invariant a store enforced instead of substring-matching the
+ * message. Pass `code` to narrow to a single guard; omit it to match any.
+ *
+ * Distinguishes "history capture forbids raw SQL here" from "this backend has
+ * no transactions" (the latter carries no guard code — see
+ * `TransactionContext.sqlAvailability` for the capability discriminant).
+ *
+ * Passing `code` also narrows `details.code` to that literal on the guarded
+ * branch, so a caller can read the payload without re-checking.
+ *
+ * @example
+ * ```typescript
+ * // `withTransaction` is a compile error on a history-enabled store, so widen
+ * // to the base Store surface to reach the runtime guard this branches on.
+ * const store: Store<typeof graph> = historyStore;
+ * try {
+ *   store.withTransaction(externalTx);
+ * } catch (error) {
+ *   if (
+ *     isRecordedCaptureGuardError(
+ *       error,
+ *       "RECORDED_CAPTURE_REQUIRES_CALLBACK_TRANSACTION",
+ *     )
+ *   ) {
+ *     // error.details.code is now the literal, not the union.
+ *     await historyStore.withRecordedTransaction(externalTx, run);
+ *   } else {
+ *     throw error;
+ *   }
+ * }
+ * ```
+ */
+declare function isRecordedCaptureGuardError<C extends RecordedCaptureGuardCode>(error: unknown, code: C): error is RecordedCaptureGuardError<C>;
+declare function isRecordedCaptureGuardError(error: unknown): error is RecordedCaptureGuardError;
 /**
  * Why a store's strategy-owned storage is not usable on the current
  * connection. Drives the {@link StoreNotInitializedError} message and
@@ -698,4 +765,4 @@ declare function isConstraintError(error: unknown): boolean;
  */
 declare function getErrorSuggestion(error: unknown): string | undefined;
 
-export { isConstraintError as $, SchemaMismatchError as A, BackendDisposedError as B, CardinalityError as C, DatabaseOperationError as D, EagerMaterializationError as E, type SchemaMismatchErrorDetails as F, StaleVersionError as G, type StaleVersionErrorDetails as H, StoreNotInitializedError as I, type StoreNotInitializedErrorDetails as J, KindNotFoundError as K, type StoreNotInitializedReason as L, MigrationError as M, NodeConstraintNotFoundError as N, TransactionClosedError as O, type TypeGraphErrorOptions as P, type UniquenessErrorDetails as Q, RestrictedDeleteError as R, SchemaContentConflictError as S, TypeGraphError as T, UniquenessError as U, type ValidationIssue as V, UnsupportedPredicateError as W, type ValidationErrorDetails as X, VersionConflictError as Y, type VersionConflictErrorDetails as Z, getErrorSuggestion as _, ValidationError as a, isSystemError as a0, isTypeGraphError as a1, isUserRecoverable as a2, type CardinalityErrorDetails as b, CompilerInvariantError as c, ConfigurationError as d, type DatabaseOperationErrorDetails as e, DisjointError as f, type DisjointErrorDetails as g, type EagerMaterializationErrorDetails as h, EdgeNotFoundError as i, type EdgeNotFoundErrorDetails as j, EmbeddingDimensionChangedError as k, type EmbeddingDimensionChangedErrorDetails as l, EndpointError as m, type EndpointErrorDetails as n, EndpointNotFoundError as o, type EndpointNotFoundErrorDetails as p, type ErrorCategory as q, type KindNotFoundErrorDetails as r, type MigrationErrorDetails as s, type NodeConstraintNotFoundErrorDetails as t, NodeIndexNotFoundError as u, type NodeIndexNotFoundErrorDetails as v, NodeNotFoundError as w, type NodeNotFoundErrorDetails as x, type RestrictedDeleteErrorDetails as y, type SchemaContentConflictErrorDetails as z };
+export { VersionConflictError as $, RestrictedDeleteError as A, BackendDisposedError as B, CardinalityError as C, DatabaseOperationError as D, EagerMaterializationError as E, type RestrictedDeleteErrorDetails as F, type SchemaContentConflictErrorDetails as G, SchemaMismatchError as H, type SchemaMismatchErrorDetails as I, StaleVersionError as J, KindNotFoundError as K, type StaleVersionErrorDetails as L, MigrationError as M, NodeConstraintNotFoundError as N, StoreNotInitializedError as O, type StoreNotInitializedErrorDetails as P, type StoreNotInitializedReason as Q, RECORDED_CAPTURE_GUARD_CODES as R, SchemaContentConflictError as S, TypeGraphError as T, TransactionClosedError as U, type ValidationIssue as V, type TypeGraphErrorOptions as W, UniquenessError as X, type UniquenessErrorDetails as Y, UnsupportedPredicateError as Z, type ValidationErrorDetails as _, ValidationError as a, type VersionConflictErrorDetails as a0, getErrorSuggestion as a1, isConstraintError as a2, isRecordedCaptureGuardError as a3, isSystemError as a4, isTypeGraphError as a5, isUserRecoverable as a6, type CardinalityErrorDetails as b, CompilerInvariantError as c, ConfigurationError as d, type DatabaseOperationErrorDetails as e, DisjointError as f, type DisjointErrorDetails as g, type EagerMaterializationErrorDetails as h, EdgeNotFoundError as i, type EdgeNotFoundErrorDetails as j, EmbeddingDimensionChangedError as k, type EmbeddingDimensionChangedErrorDetails as l, EndpointError as m, type EndpointErrorDetails as n, EndpointNotFoundError as o, type EndpointNotFoundErrorDetails as p, type ErrorCategory as q, type KindNotFoundErrorDetails as r, type MigrationErrorDetails as s, type NodeConstraintNotFoundErrorDetails as t, NodeIndexNotFoundError as u, type NodeIndexNotFoundErrorDetails as v, NodeNotFoundError as w, type NodeNotFoundErrorDetails as x, type RecordedCaptureGuardCode as y, type RecordedCaptureGuardError as z };

package/dist/{index-Bks_3HHK.d.cts → index-BLtQWKRj.d.cts}

@@ -501,6 +501,73 @@ declare class ConfigurationError extends TypeGraphError {
         suggestion?: string;
     });
 }
+/**
+ * The stable `details.code` values raised by the recorded-capture guards on a
+ * history- or revision-tracked store. These are the sanctioned branch points
+ * for a portable caller that must pick a transaction strategy without
+ * substring-matching {@link ConfigurationError} messages.
+ *
+ * - `RECORDED_CAPTURE_REQUIRES_CALLBACK_TRANSACTION`: `store.withTransaction`
+ *   was called on a history-enabled store, which has no flush point before the
+ *   caller commits — use `store.withRecordedTransaction` instead.
+ * - `RECORDED_CAPTURE_RAW_SQL_DISABLED`: a raw SQL escape (`tx.sql`,
+ *   `backend.executeStatement`/`executeDdl`) was reached on a history-enabled
+ *   store, where it would bypass recorded-time capture.
+ * - `REVISION_TRACKING_RAW_SQL_DISABLED`: the same raw SQL escape on a
+ *   revision-tracked store, where it would bypass the revision anchor.
+ *
+ * @see isRecordedCaptureGuardError
+ */
+declare const RECORDED_CAPTURE_GUARD_CODES: readonly ["RECORDED_CAPTURE_REQUIRES_CALLBACK_TRANSACTION", "RECORDED_CAPTURE_RAW_SQL_DISABLED", "REVISION_TRACKING_RAW_SQL_DISABLED"];
+/** A stable, branchable code raised by a recorded-capture guard. */
+type RecordedCaptureGuardCode = (typeof RECORDED_CAPTURE_GUARD_CODES)[number];
+/**
+ * A {@link ConfigurationError} narrowed to carry a {@link RecordedCaptureGuardCode}
+ * in `details.code` — the shape {@link isRecordedCaptureGuardError} guarantees.
+ * `C` narrows `details.code` to a single code when the guard was called with a
+ * specific one; it defaults to the full union.
+ */
+type RecordedCaptureGuardError<C extends RecordedCaptureGuardCode = RecordedCaptureGuardCode> = ConfigurationError & Readonly<{
+    details: Readonly<{
+        code: C;
+    }>;
+}>;
+/**
+ * Type guard for the recorded-capture guard errors, so a portable caller can
+ * branch on the invariant a store enforced instead of substring-matching the
+ * message. Pass `code` to narrow to a single guard; omit it to match any.
+ *
+ * Distinguishes "history capture forbids raw SQL here" from "this backend has
+ * no transactions" (the latter carries no guard code — see
+ * `TransactionContext.sqlAvailability` for the capability discriminant).
+ *
+ * Passing `code` also narrows `details.code` to that literal on the guarded
+ * branch, so a caller can read the payload without re-checking.
+ *
+ * @example
+ * ```typescript
+ * // `withTransaction` is a compile error on a history-enabled store, so widen
+ * // to the base Store surface to reach the runtime guard this branches on.
+ * const store: Store<typeof graph> = historyStore;
+ * try {
+ *   store.withTransaction(externalTx);
+ * } catch (error) {
+ *   if (
+ *     isRecordedCaptureGuardError(
+ *       error,
+ *       "RECORDED_CAPTURE_REQUIRES_CALLBACK_TRANSACTION",
+ *     )
+ *   ) {
+ *     // error.details.code is now the literal, not the union.
+ *     await historyStore.withRecordedTransaction(externalTx, run);
+ *   } else {
+ *     throw error;
+ *   }
+ * }
+ * ```
+ */
+declare function isRecordedCaptureGuardError<C extends RecordedCaptureGuardCode>(error: unknown, code: C): error is RecordedCaptureGuardError<C>;
+declare function isRecordedCaptureGuardError(error: unknown): error is RecordedCaptureGuardError;
 /**
  * Why a store's strategy-owned storage is not usable on the current
  * connection. Drives the {@link StoreNotInitializedError} message and
@@ -698,4 +765,4 @@ declare function isConstraintError(error: unknown): boolean;
  */
 declare function getErrorSuggestion(error: unknown): string | undefined;
 
-export { isConstraintError as $, SchemaMismatchError as A, BackendDisposedError as B, CardinalityError as C, DatabaseOperationError as D, EagerMaterializationError as E, type SchemaMismatchErrorDetails as F, StaleVersionError as G, type StaleVersionErrorDetails as H, StoreNotInitializedError as I, type StoreNotInitializedErrorDetails as J, KindNotFoundError as K, type StoreNotInitializedReason as L, MigrationError as M, NodeConstraintNotFoundError as N, TransactionClosedError as O, type TypeGraphErrorOptions as P, type UniquenessErrorDetails as Q, RestrictedDeleteError as R, SchemaContentConflictError as S, TypeGraphError as T, UniquenessError as U, type ValidationIssue as V, UnsupportedPredicateError as W, type ValidationErrorDetails as X, VersionConflictError as Y, type VersionConflictErrorDetails as Z, getErrorSuggestion as _, ValidationError as a, isSystemError as a0, isTypeGraphError as a1, isUserRecoverable as a2, type CardinalityErrorDetails as b, CompilerInvariantError as c, ConfigurationError as d, type DatabaseOperationErrorDetails as e, DisjointError as f, type DisjointErrorDetails as g, type EagerMaterializationErrorDetails as h, EdgeNotFoundError as i, type EdgeNotFoundErrorDetails as j, EmbeddingDimensionChangedError as k, type EmbeddingDimensionChangedErrorDetails as l, EndpointError as m, type EndpointErrorDetails as n, EndpointNotFoundError as o, type EndpointNotFoundErrorDetails as p, type ErrorCategory as q, type KindNotFoundErrorDetails as r, type MigrationErrorDetails as s, type NodeConstraintNotFoundErrorDetails as t, NodeIndexNotFoundError as u, type NodeIndexNotFoundErrorDetails as v, NodeNotFoundError as w, type NodeNotFoundErrorDetails as x, type RestrictedDeleteErrorDetails as y, type SchemaContentConflictErrorDetails as z };
+export { VersionConflictError as $, RestrictedDeleteError as A, BackendDisposedError as B, CardinalityError as C, DatabaseOperationError as D, EagerMaterializationError as E, type RestrictedDeleteErrorDetails as F, type SchemaContentConflictErrorDetails as G, SchemaMismatchError as H, type SchemaMismatchErrorDetails as I, StaleVersionError as J, KindNotFoundError as K, type StaleVersionErrorDetails as L, MigrationError as M, NodeConstraintNotFoundError as N, StoreNotInitializedError as O, type StoreNotInitializedErrorDetails as P, type StoreNotInitializedReason as Q, RECORDED_CAPTURE_GUARD_CODES as R, SchemaContentConflictError as S, TypeGraphError as T, TransactionClosedError as U, type ValidationIssue as V, type TypeGraphErrorOptions as W, UniquenessError as X, type UniquenessErrorDetails as Y, UnsupportedPredicateError as Z, type ValidationErrorDetails as _, ValidationError as a, type VersionConflictErrorDetails as a0, getErrorSuggestion as a1, isConstraintError as a2, isRecordedCaptureGuardError as a3, isSystemError as a4, isTypeGraphError as a5, isUserRecoverable as a6, type CardinalityErrorDetails as b, CompilerInvariantError as c, ConfigurationError as d, type DatabaseOperationErrorDetails as e, DisjointError as f, type DisjointErrorDetails as g, type EagerMaterializationErrorDetails as h, EdgeNotFoundError as i, type EdgeNotFoundErrorDetails as j, EmbeddingDimensionChangedError as k, type EmbeddingDimensionChangedErrorDetails as l, EndpointError as m, type EndpointErrorDetails as n, EndpointNotFoundError as o, type EndpointNotFoundErrorDetails as p, type ErrorCategory as q, type KindNotFoundErrorDetails as r, type MigrationErrorDetails as s, type NodeConstraintNotFoundErrorDetails as t, NodeIndexNotFoundError as u, type NodeIndexNotFoundErrorDetails as v, NodeNotFoundError as w, type NodeNotFoundErrorDetails as x, type RecordedCaptureGuardCode as y, type RecordedCaptureGuardError as z };