@prisma-next/core-control-plane 0.1.0-dev.14 → 0.1.0-dev.15

package/dist/exports/result.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Generic Result type for representing success or failure outcomes.
+ *
+ * This is the standard way to return "expected failures" as values rather than
+ * throwing exceptions. See docs/Error Handling.md for the full taxonomy.
+ *
+ * Naming rationale:
+ * - `Ok<T>` / `NotOk<F>` mirror the `ok: true/false` discriminator
+ * - `NotOk` avoids collision with domain types like "Failure" or "Error"
+ * - `failure` property distinguishes from JS Error semantics
+ */
+/**
+ * Represents a successful result containing a value.
+ */
+interface Ok<T> {
+    readonly ok: true;
+    readonly value: T;
+}
+/**
+ * Represents an unsuccessful result containing failure details.
+ */
+interface NotOk<F> {
+    readonly ok: false;
+    readonly failure: F;
+}
+/**
+ * A discriminated union representing either success (Ok) or failure (NotOk).
+ *
+ * @typeParam T - The success value type
+ * @typeParam F - The failure details type
+ */
+type Result<T, F> = Ok<T> | NotOk<F>;
+/**
+ * Creates a successful result.
+ */
+declare function ok<T>(value: T): Ok<T>;
+/**
+ * Creates an unsuccessful result.
+ */
+declare function notOk<F>(failure: F): NotOk<F>;
+/**
+ * Returns a successful void result.
+ * Use this for validation checks that don't produce a value.
+ */
+declare function okVoid(): Ok<void>;
+
+export { type NotOk, type Ok, type Result, notOk, ok, okVoid };

package/dist/exports/result.js

@@ -0,0 +1,17 @@
+// src/result.ts
+function ok(value) {
+  return Object.freeze({ ok: true, value });
+}
+function notOk(failure) {
+  return Object.freeze({ ok: false, failure });
+}
+var OK_VOID = Object.freeze({ ok: true, value: void 0 });
+function okVoid() {
+  return OK_VOID;
+}
+export {
+  notOk,
+  ok,
+  okVoid
+};
+//# sourceMappingURL=result.js.map

package/dist/exports/result.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/result.ts"],"sourcesContent":["/**\n * Generic Result type for representing success or failure outcomes.\n *\n * This is the standard way to return \"expected failures\" as values rather than\n * throwing exceptions. See docs/Error Handling.md for the full taxonomy.\n *\n * Naming rationale:\n * - `Ok<T>` / `NotOk<F>` mirror the `ok: true/false` discriminator\n * - `NotOk` avoids collision with domain types like \"Failure\" or \"Error\"\n * - `failure` property distinguishes from JS Error semantics\n */\n\n/**\n * Represents a successful result containing a value.\n */\nexport interface Ok<T> {\n  readonly ok: true;\n  readonly value: T;\n}\n\n/**\n * Represents an unsuccessful result containing failure details.\n */\nexport interface NotOk<F> {\n  readonly ok: false;\n  readonly failure: F;\n}\n\n/**\n * A discriminated union representing either success (Ok) or failure (NotOk).\n *\n * @typeParam T - The success value type\n * @typeParam F - The failure details type\n */\nexport type Result<T, F> = Ok<T> | NotOk<F>;\n\n/**\n * Creates a successful result.\n */\nexport function ok<T>(value: T): Ok<T> {\n  return Object.freeze({ ok: true, value });\n}\n\n/**\n * Creates an unsuccessful result.\n */\nexport function notOk<F>(failure: F): NotOk<F> {\n  return Object.freeze({ ok: false, failure });\n}\n\n/**\n * Singleton for void success results.\n * Use this for validation checks that don't produce a value.\n */\nconst OK_VOID: Ok<void> = Object.freeze({ ok: true, value: undefined });\n\n/**\n * Returns a successful void result.\n * Use this for validation checks that don't produce a value.\n */\nexport function okVoid(): Ok<void> {\n  return OK_VOID;\n}\n"],"mappings":";AAuCO,SAAS,GAAM,OAAiB;AACrC,SAAO,OAAO,OAAO,EAAE,IAAI,MAAM,MAAM,CAAC;AAC1C;AAKO,SAAS,MAAS,SAAsB;AAC7C,SAAO,OAAO,OAAO,EAAE,IAAI,OAAO,QAAQ,CAAC;AAC7C;AAMA,IAAM,UAAoB,OAAO,OAAO,EAAE,IAAI,MAAM,OAAO,OAAU,CAAC;AAM/D,SAAS,SAAmB;AACjC,SAAO;AACT;","names":[]}

package/dist/exports/types.d.ts

@@ -56,6 +56,41 @@ interface ControlExtensionInstance<TFamilyId extends string = string, TTargetId
     readonly familyId: TFamilyId;
     readonly targetId: TTargetId;
 }
+/**
+ * Operation context for propagating metadata through control-plane operation call chains.
+ * Inspired by OpenTelemetry's Context and Sentry's Scope patterns.
+ *
+ * This context carries informational metadata (like file paths) that can be used for
+ * error reporting, logging, and debugging, but is not required for structural correctness.
+ * It allows subsystems to propagate context without coupling to file I/O concerns.
+ *
+ * @example
+ * ```typescript
+ * const context: OperationContext = {
+ *   contractPath: './contract.json',
+ *   configPath: './prisma-next.config.ts',
+ * };
+ *
+ * await runner.execute({ plan, driver, destinationContract: contract, context });
+ * ```
+ */
+interface OperationContext {
+    /**
+     * Path to the contract file (if applicable).
+     * Used for error reporting and metadata, not for file I/O.
+     */
+    readonly contractPath?: string;
+    /**
+     * Path to the configuration file (if applicable).
+     * Used for error reporting and metadata, not for file I/O.
+     */
+    readonly configPath?: string;
+    /**
+     * Additional metadata that can be propagated through the call chain.
+     * Extensible for future needs without breaking changes.
+     */
+    readonly meta?: Readonly<Record<string, unknown>>;
+}
 /**
  * Descriptor for a control-plane family (e.g., SQL).
  * Provides the family hook and factory method.
@@ -298,7 +333,7 @@ interface VerifyDatabaseSchemaResult {
     };
     readonly meta?: {
         readonly configPath?: string;
-        readonly contractPath: string;
+        readonly contractPath?: string;
         readonly strict: boolean;
     };
     readonly timings: {
@@ -368,4 +403,4 @@ interface SignDatabaseResult {
     };
 }
 
-export type { ControlAdapterDescriptor, ControlAdapterInstance, ControlDriverDescriptor, ControlDriverInstance, ControlExtensionDescriptor, ControlExtensionInstance, ControlFamilyDescriptor, ControlFamilyInstance, ControlTargetDescriptor, ControlTargetInstance, EmitContractResult, FamilyInstance, IntrospectSchemaResult, SchemaIssue, SchemaVerificationNode, SignDatabaseResult, VerifyDatabaseResult, VerifyDatabaseSchemaResult };
+export type { ControlAdapterDescriptor, ControlAdapterInstance, ControlDriverDescriptor, ControlDriverInstance, ControlExtensionDescriptor, ControlExtensionInstance, ControlFamilyDescriptor, ControlFamilyInstance, ControlTargetDescriptor, ControlTargetInstance, EmitContractResult, FamilyInstance, IntrospectSchemaResult, OperationContext, SchemaIssue, SchemaVerificationNode, SignDatabaseResult, VerifyDatabaseResult, VerifyDatabaseSchemaResult };

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@prisma-next/core-control-plane",
-  "version": "0.1.0-dev.14",
+  "version": "0.1.0-dev.15",
   "type": "module",
   "sideEffects": false,
   "description": "Control plane domain actions, config types, validation, and error factories for Prisma Next",
   "dependencies": {
     "arktype": "^2.1.26",
     "prettier": "^3.3.3",
-    "@prisma-next/contract": "0.1.0-dev.14",
-    "@prisma-next/operations": "0.1.0-dev.14"
+    "@prisma-next/contract": "0.1.0-dev.15",
+    "@prisma-next/operations": "0.1.0-dev.15"
   },
   "devDependencies": {
     "tsup": "^8.3.0",
@@ -43,6 +43,10 @@
     "./schema-view": {
       "types": "./dist/exports/schema-view.d.ts",
       "import": "./dist/exports/schema-view.js"
+    },
+    "./result": {
+      "types": "./dist/exports/result.d.ts",
+      "import": "./dist/exports/result.js"
     }
   },
   "scripts": {