@prisma-next/contract - npm Package Compare versions

Comparing version 0.0.1 to 0.1.0-pr.32.1

dist/exports/types.d.ts

@@ -62,3 +62,4 @@ import { OperationRegistry } from '@prisma-next/operations';
     readonly name?: string;
-    readonly type?: string;
+    readonly codecId?: string;
+    readonly nativeType?: string;
     readonly nullable?: boolean;
@@ -65,0 +66,0 @@ readonly source: 'dsl' | 'raw';

dist/exports/types.js.map

@@ -1,1 +0,1 @@
-{"version":3,"sources":["../../src/types.ts"],"sourcesContent":["import type { OperationRegistry } from '@prisma-next/operations';\nimport type { ContractIR } from './ir';\n\n// Shared header and neutral types\n// Note: Fields like targetFamily accept string to work with JSON imports,\n// which don't preserve literal types. Runtime validation ensures correct values\nexport interface ContractBase {\n  readonly schemaVersion: string;\n  readonly target: string;\n  readonly targetFamily: string;\n  readonly coreHash: string;\n  readonly profileHash?: string;\n  readonly capabilities?: Record<string, Record<string, boolean>>;\n  readonly extensions?: Record<string, unknown>;\n  readonly meta?: Record<string, unknown>;\n  readonly sources?: Record<string, Source>;\n}\n\nexport interface FieldType {\n  readonly type: string;\n  readonly nullable: boolean;\n  readonly items?: FieldType;\n  readonly properties?: Record<string, FieldType>;\n}\n\nexport interface Source {\n  readonly readOnly: boolean;\n  readonly projection: Record<string, FieldType>;\n  readonly origin?: Record<string, unknown>;\n  readonly capabilities?: Record<string, boolean>;\n}\n\n// Document family types\nexport interface DocIndex {\n  readonly name: string;\n  readonly keys: Record<string, 'asc' | 'desc'>;\n  readonly unique?: boolean;\n  readonly where?: Expr;\n}\n\nexport type Expr =\n  | { readonly kind: 'eq'; readonly path: ReadonlyArray<string>; readonly value: unknown }\n  | { readonly kind: 'exists'; readonly path: ReadonlyArray<string> };\n\nexport interface DocCollection {\n  readonly name: string;\n  readonly id?: {\n    readonly strategy: 'auto' | 'client' | 'uuid' | 'cuid' | 'objectId';\n  };\n  readonly fields: Record<string, FieldType>;\n  readonly indexes?: ReadonlyArray<DocIndex>;\n  readonly readOnly?: boolean;\n}\n\nexport interface DocumentStorage {\n  readonly document: {\n    readonly collections: Record<string, DocCollection>;\n  };\n}\n\nexport interface DocumentContract extends ContractBase {\n  // Accept string to work with JSON imports; runtime validation ensures 'document'\n  readonly targetFamily: string;\n  readonly storage: DocumentStorage;\n}\n\n// Plan types - target-family agnostic execution types\nexport interface ParamDescriptor {\n  readonly index?: number;\n  readonly name?: string;\n  readonly type?: string;\n  readonly nullable?: boolean;\n  readonly source: 'dsl' | 'raw';\n  readonly refs?: { table: string; column: string };\n}\n\nexport interface PlanRefs {\n  readonly tables?: readonly string[];\n  readonly columns?: ReadonlyArray<{ table: string; column: string }>;\n  readonly indexes?: ReadonlyArray<{\n    readonly table: string;\n    readonly columns: ReadonlyArray<string>;\n    readonly name?: string;\n  }>;\n}\n\nexport interface PlanMeta {\n  readonly target: string;\n  readonly targetFamily?: string;\n  readonly coreHash: string;\n  readonly profileHash?: string;\n  readonly lane: string;\n  readonly annotations?: {\n    codecs?: Record<string, string>; // alias/param → codec id ('ns/name@v')\n    [key: string]: unknown;\n  };\n  readonly paramDescriptors: ReadonlyArray<ParamDescriptor>;\n  readonly refs?: PlanRefs;\n  readonly projection?: Record<string, string> | ReadonlyArray<string>;\n  /**\n   * Optional mapping of projection alias → column type ID (fully qualified ns/name@version).\n   * Used for codec resolution when AST+refs don't provide enough type info.\n   */\n  readonly projectionTypes?: Record<string, string>;\n}\n\n/**\n * Canonical execution plan shape used by runtimes.\n *\n * - Row is the inferred result row type (TypeScript-only).\n * - Ast is the optional, family-specific AST type (e.g. SQL QueryAst).\n *\n * The payload executed by the runtime is represented by the sql + params pair\n * for now; future families can specialize this via Ast or additional metadata.\n */\nexport interface ExecutionPlan<Row = unknown, Ast = unknown> {\n  readonly sql: string;\n  readonly params: readonly unknown[];\n  readonly ast?: Ast;\n  readonly meta: PlanMeta;\n  /**\n   * Phantom property to carry the Row generic for type-level utilities.\n   * Not set at runtime; used only for ResultType extraction.\n   */\n  readonly _row?: Row;\n}\n\n/**\n * Utility type to extract the Row type from an ExecutionPlan.\n * Example: `type Row = ResultType<typeof plan>`\n *\n * Works with both ExecutionPlan and SqlQueryPlan (SQL query plans before lowering).\n * SqlQueryPlan includes a phantom `_Row` property to preserve the generic parameter\n * for type extraction.\n */\nexport type ResultType<P> = P extends ExecutionPlan<infer R, unknown>\n  ? R\n  : P extends { readonly _Row?: infer R }\n    ? R\n    : never;\n\n/**\n * Type guard to check if a contract is a Document contract\n */\nexport function isDocumentContract(contract: unknown): contract is DocumentContract {\n  return (\n    typeof contract === 'object' &&\n    contract !== null &&\n    'targetFamily' in contract &&\n    contract.targetFamily === 'document'\n  );\n}\n\n/**\n * Contract marker record stored in the database.\n * Represents the current contract identity for a database.\n */\nexport interface ContractMarkerRecord {\n  readonly coreHash: string;\n  readonly profileHash: string;\n  readonly contractJson: unknown | null;\n  readonly canonicalVersion: number | null;\n  readonly updatedAt: Date;\n  readonly appTag: string | null;\n  readonly meta: Record<string, unknown>;\n}\n\n// Emitter types - moved from @prisma-next/emitter to shared location\n/**\n * Specifies how to import TypeScript types from a package.\n * Used in extension pack manifests to declare codec and operation type imports.\n */\nexport interface TypesImportSpec {\n  readonly package: string;\n  readonly named: string;\n  readonly alias: string;\n}\n\n/**\n * Validation context passed to TargetFamilyHook.validateTypes().\n * Contains pre-assembled operation registry, type imports, and extension IDs.\n */\nexport interface ValidationContext {\n  readonly operationRegistry?: OperationRegistry;\n  readonly codecTypeImports?: ReadonlyArray<TypesImportSpec>;\n  readonly operationTypeImports?: ReadonlyArray<TypesImportSpec>;\n  readonly extensionIds?: ReadonlyArray<string>;\n}\n\n/**\n * SPI interface for target family hooks that extend emission behavior.\n * Implemented by family-specific emitter hooks (e.g., SQL family).\n */\nexport interface TargetFamilyHook {\n  readonly id: string;\n\n  /**\n   * Validates that all type IDs in the contract come from referenced extensions.\n   * @param ir - Contract IR to validate\n   * @param ctx - Validation context with operation registry and extension IDs\n   */\n  validateTypes(ir: ContractIR, ctx: ValidationContext): void;\n\n  /**\n   * Validates family-specific contract structure.\n   * @param ir - Contract IR to validate\n   */\n  validateStructure(ir: ContractIR): void;\n\n  /**\n   * Generates contract.d.ts file content.\n   * @param ir - Contract IR\n   * @param codecTypeImports - Array of codec type import specs\n   * @param operationTypeImports - Array of operation type import specs\n   * @returns Generated TypeScript type definitions as string\n   */\n  generateContractTypes(\n    ir: ContractIR,\n    codecTypeImports: ReadonlyArray<TypesImportSpec>,\n    operationTypeImports: ReadonlyArray<TypesImportSpec>,\n  ): string;\n}\n\n// Extension pack manifest types - moved from @prisma-next/core-control-plane to shared location\nexport type ArgSpecManifest =\n  | { readonly kind: 'typeId'; readonly type: string }\n  | { readonly kind: 'param' }\n  | { readonly kind: 'literal' };\n\nexport type ReturnSpecManifest =\n  | { readonly kind: 'typeId'; readonly type: string }\n  | { readonly kind: 'builtin'; readonly type: 'number' | 'boolean' | 'string' };\n\nexport interface LoweringSpecManifest {\n  readonly targetFamily: 'sql';\n  readonly strategy: 'infix' | 'function';\n  readonly template: string;\n}\n\nexport interface OperationManifest {\n  readonly for: string;\n  readonly method: string;\n  readonly args: ReadonlyArray<ArgSpecManifest>;\n  readonly returns: ReturnSpecManifest;\n  readonly lowering: LoweringSpecManifest;\n  readonly capabilities?: ReadonlyArray<string>;\n}\n\nexport interface ExtensionPackManifest {\n  readonly id: string;\n  readonly version: string;\n  readonly targets?: Record<string, { readonly minVersion?: string }>;\n  readonly capabilities?: Record<string, unknown>;\n  readonly types?: {\n    readonly codecTypes?: {\n      readonly import: TypesImportSpec;\n    };\n    readonly operationTypes?: {\n      readonly import: TypesImportSpec;\n    };\n    readonly storage?: readonly {\n      readonly typeId: string;\n      readonly familyId: string;\n      readonly targetId: string;\n      readonly nativeType?: string;\n    }[];\n  };\n  readonly operations?: ReadonlyArray<OperationManifest>;\n}\n\nexport interface ExtensionPack {\n  readonly manifest: ExtensionPackManifest;\n  readonly path: string;\n}\n"],"mappings":";AAgJO,SAAS,mBAAmB,UAAiD;AAClF,SACE,OAAO,aAAa,YACpB,aAAa,QACb,kBAAkB,YAClB,SAAS,iBAAiB;AAE9B;","names":[]}
+{"version":3,"sources":["../../src/types.ts"],"sourcesContent":["import type { OperationRegistry } from '@prisma-next/operations';\nimport type { ContractIR } from './ir';\n\n// Shared header and neutral types\n// Note: Fields like targetFamily accept string to work with JSON imports,\n// which don't preserve literal types. Runtime validation ensures correct values\nexport interface ContractBase {\n  readonly schemaVersion: string;\n  readonly target: string;\n  readonly targetFamily: string;\n  readonly coreHash: string;\n  readonly profileHash?: string;\n  readonly capabilities?: Record<string, Record<string, boolean>>;\n  readonly extensions?: Record<string, unknown>;\n  readonly meta?: Record<string, unknown>;\n  readonly sources?: Record<string, Source>;\n}\n\nexport interface FieldType {\n  readonly type: string;\n  readonly nullable: boolean;\n  readonly items?: FieldType;\n  readonly properties?: Record<string, FieldType>;\n}\n\nexport interface Source {\n  readonly readOnly: boolean;\n  readonly projection: Record<string, FieldType>;\n  readonly origin?: Record<string, unknown>;\n  readonly capabilities?: Record<string, boolean>;\n}\n\n// Document family types\nexport interface DocIndex {\n  readonly name: string;\n  readonly keys: Record<string, 'asc' | 'desc'>;\n  readonly unique?: boolean;\n  readonly where?: Expr;\n}\n\nexport type Expr =\n  | { readonly kind: 'eq'; readonly path: ReadonlyArray<string>; readonly value: unknown }\n  | { readonly kind: 'exists'; readonly path: ReadonlyArray<string> };\n\nexport interface DocCollection {\n  readonly name: string;\n  readonly id?: {\n    readonly strategy: 'auto' | 'client' | 'uuid' | 'cuid' | 'objectId';\n  };\n  readonly fields: Record<string, FieldType>;\n  readonly indexes?: ReadonlyArray<DocIndex>;\n  readonly readOnly?: boolean;\n}\n\nexport interface DocumentStorage {\n  readonly document: {\n    readonly collections: Record<string, DocCollection>;\n  };\n}\n\nexport interface DocumentContract extends ContractBase {\n  // Accept string to work with JSON imports; runtime validation ensures 'document'\n  readonly targetFamily: string;\n  readonly storage: DocumentStorage;\n}\n\n// Plan types - target-family agnostic execution types\nexport interface ParamDescriptor {\n  readonly index?: number;\n  readonly name?: string;\n  readonly codecId?: string;\n  readonly nativeType?: string;\n  readonly nullable?: boolean;\n  readonly source: 'dsl' | 'raw';\n  readonly refs?: { table: string; column: string };\n}\n\nexport interface PlanRefs {\n  readonly tables?: readonly string[];\n  readonly columns?: ReadonlyArray<{ table: string; column: string }>;\n  readonly indexes?: ReadonlyArray<{\n    readonly table: string;\n    readonly columns: ReadonlyArray<string>;\n    readonly name?: string;\n  }>;\n}\n\nexport interface PlanMeta {\n  readonly target: string;\n  readonly targetFamily?: string;\n  readonly coreHash: string;\n  readonly profileHash?: string;\n  readonly lane: string;\n  readonly annotations?: {\n    codecs?: Record<string, string>; // alias/param → codec id ('ns/name@v')\n    [key: string]: unknown;\n  };\n  readonly paramDescriptors: ReadonlyArray<ParamDescriptor>;\n  readonly refs?: PlanRefs;\n  readonly projection?: Record<string, string> | ReadonlyArray<string>;\n  /**\n   * Optional mapping of projection alias → column type ID (fully qualified ns/name@version).\n   * Used for codec resolution when AST+refs don't provide enough type info.\n   */\n  readonly projectionTypes?: Record<string, string>;\n}\n\n/**\n * Canonical execution plan shape used by runtimes.\n *\n * - Row is the inferred result row type (TypeScript-only).\n * - Ast is the optional, family-specific AST type (e.g. SQL QueryAst).\n *\n * The payload executed by the runtime is represented by the sql + params pair\n * for now; future families can specialize this via Ast or additional metadata.\n */\nexport interface ExecutionPlan<Row = unknown, Ast = unknown> {\n  readonly sql: string;\n  readonly params: readonly unknown[];\n  readonly ast?: Ast;\n  readonly meta: PlanMeta;\n  /**\n   * Phantom property to carry the Row generic for type-level utilities.\n   * Not set at runtime; used only for ResultType extraction.\n   */\n  readonly _row?: Row;\n}\n\n/**\n * Utility type to extract the Row type from an ExecutionPlan.\n * Example: `type Row = ResultType<typeof plan>`\n *\n * Works with both ExecutionPlan and SqlQueryPlan (SQL query plans before lowering).\n * SqlQueryPlan includes a phantom `_Row` property to preserve the generic parameter\n * for type extraction.\n */\nexport type ResultType<P> = P extends ExecutionPlan<infer R, unknown>\n  ? R\n  : P extends { readonly _Row?: infer R }\n    ? R\n    : never;\n\n/**\n * Type guard to check if a contract is a Document contract\n */\nexport function isDocumentContract(contract: unknown): contract is DocumentContract {\n  return (\n    typeof contract === 'object' &&\n    contract !== null &&\n    'targetFamily' in contract &&\n    contract.targetFamily === 'document'\n  );\n}\n\n/**\n * Contract marker record stored in the database.\n * Represents the current contract identity for a database.\n */\nexport interface ContractMarkerRecord {\n  readonly coreHash: string;\n  readonly profileHash: string;\n  readonly contractJson: unknown | null;\n  readonly canonicalVersion: number | null;\n  readonly updatedAt: Date;\n  readonly appTag: string | null;\n  readonly meta: Record<string, unknown>;\n}\n\n// Emitter types - moved from @prisma-next/emitter to shared location\n/**\n * Specifies how to import TypeScript types from a package.\n * Used in extension pack manifests to declare codec and operation type imports.\n */\nexport interface TypesImportSpec {\n  readonly package: string;\n  readonly named: string;\n  readonly alias: string;\n}\n\n/**\n * Validation context passed to TargetFamilyHook.validateTypes().\n * Contains pre-assembled operation registry, type imports, and extension IDs.\n */\nexport interface ValidationContext {\n  readonly operationRegistry?: OperationRegistry;\n  readonly codecTypeImports?: ReadonlyArray<TypesImportSpec>;\n  readonly operationTypeImports?: ReadonlyArray<TypesImportSpec>;\n  readonly extensionIds?: ReadonlyArray<string>;\n}\n\n/**\n * SPI interface for target family hooks that extend emission behavior.\n * Implemented by family-specific emitter hooks (e.g., SQL family).\n */\nexport interface TargetFamilyHook {\n  readonly id: string;\n\n  /**\n   * Validates that all type IDs in the contract come from referenced extensions.\n   * @param ir - Contract IR to validate\n   * @param ctx - Validation context with operation registry and extension IDs\n   */\n  validateTypes(ir: ContractIR, ctx: ValidationContext): void;\n\n  /**\n   * Validates family-specific contract structure.\n   * @param ir - Contract IR to validate\n   */\n  validateStructure(ir: ContractIR): void;\n\n  /**\n   * Generates contract.d.ts file content.\n   * @param ir - Contract IR\n   * @param codecTypeImports - Array of codec type import specs\n   * @param operationTypeImports - Array of operation type import specs\n   * @returns Generated TypeScript type definitions as string\n   */\n  generateContractTypes(\n    ir: ContractIR,\n    codecTypeImports: ReadonlyArray<TypesImportSpec>,\n    operationTypeImports: ReadonlyArray<TypesImportSpec>,\n  ): string;\n}\n\n// Extension pack manifest types - moved from @prisma-next/core-control-plane to shared location\nexport type ArgSpecManifest =\n  | { readonly kind: 'typeId'; readonly type: string }\n  | { readonly kind: 'param' }\n  | { readonly kind: 'literal' };\n\nexport type ReturnSpecManifest =\n  | { readonly kind: 'typeId'; readonly type: string }\n  | { readonly kind: 'builtin'; readonly type: 'number' | 'boolean' | 'string' };\n\nexport interface LoweringSpecManifest {\n  readonly targetFamily: 'sql';\n  readonly strategy: 'infix' | 'function';\n  readonly template: string;\n}\n\nexport interface OperationManifest {\n  readonly for: string;\n  readonly method: string;\n  readonly args: ReadonlyArray<ArgSpecManifest>;\n  readonly returns: ReturnSpecManifest;\n  readonly lowering: LoweringSpecManifest;\n  readonly capabilities?: ReadonlyArray<string>;\n}\n\nexport interface ExtensionPackManifest {\n  readonly id: string;\n  readonly version: string;\n  readonly targets?: Record<string, { readonly minVersion?: string }>;\n  readonly capabilities?: Record<string, unknown>;\n  readonly types?: {\n    readonly codecTypes?: {\n      readonly import: TypesImportSpec;\n    };\n    readonly operationTypes?: {\n      readonly import: TypesImportSpec;\n    };\n    readonly storage?: readonly {\n      readonly typeId: string;\n      readonly familyId: string;\n      readonly targetId: string;\n      readonly nativeType?: string;\n    }[];\n  };\n  readonly operations?: ReadonlyArray<OperationManifest>;\n}\n\nexport interface ExtensionPack {\n  readonly manifest: ExtensionPackManifest;\n  readonly path: string;\n}\n"],"mappings":";AAiJO,SAAS,mBAAmB,UAAiD;AAClF,SACE,OAAO,aAAa,YACpB,aAAa,QACb,kBAAkB,YAClB,SAAS,iBAAiB;AAE9B;","names":[]}

package.json

 {
   "name": "@prisma-next/contract",
-  "version": "0.0.1",
+  "version": "0.1.0-pr.32.1",
   "type": "module",
@@ -8,3 +8,3 @@ "sideEffects": false,
   "dependencies": {
-    "@prisma-next/operations": "0.0.1"
+    "@prisma-next/operations": "0.1.0-pr.32.1"
   },
@@ -11,0 +11,0 @@ "devDependencies": {

No alert changes

Improved metrics

Total package byte prevSize

44393

0.2%

Lines of code

632

0.16%

Dependency changes

• + Added

  @prisma-next/operations@0.1.0-pr.32.1
  (transitive)

• + Added

  @prisma-next/plan@0.1.0-pr.32.1
  (transitive)

• - Removed

  @prisma-next/operations@0.0.1
  (transitive)

• - Removed

  @prisma-next/plan@0.0.1
  (transitive)

• Updated

  @prisma-next/operations@0.1.0-pr.32.1