@prisma-next/contract 0.1.0-pr.64.6 → 0.1.0-pr.65.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -104,7 +104,7 @@ const sqlFamily: FamilyDescriptor<'sql'> = {
104
104
  kind: 'family',
105
105
  id: 'sql',
106
106
  familyId: 'sql',
107
- manifest: { /* ... */ },
107
+ version: '0.0.1',
108
108
  };
109
109
 
110
110
  // Use TargetDescriptor for target components
@@ -113,7 +113,8 @@ const postgresTarget: TargetDescriptor<'sql', 'postgres'> = {
113
113
  id: 'postgres',
114
114
  familyId: 'sql',
115
115
  targetId: 'postgres',
116
- manifest: { /* ... */ },
116
+ version: '0.0.1',
117
+ capabilities: { postgres: { returning: true } },
117
118
  };
118
119
 
119
120
  // Identity instance bases are extended by plane-specific instances
@@ -1,7 +1,34 @@
1
- import { E as ExtensionPackManifest } from './pack-manifest-types-BYh8H2fb.js';
1
+ import { TypesImportSpec, OperationManifest } from './types.js';
2
2
  import '@prisma-next/operations';
3
3
  import './ir.js';
4
4
 
5
+ /**
6
+ * Declarative fields that describe component metadata.
7
+ * These fields are owned directly by descriptors (not nested under a manifest).
8
+ */
9
+ interface DescriptorDeclarativeFields {
10
+ /** Component version (semver) */
11
+ readonly version: string;
12
+ /** Capabilities this component provides */
13
+ readonly capabilities?: Record<string, unknown>;
14
+ /** Type imports for contract.d.ts generation */
15
+ readonly types?: {
16
+ readonly codecTypes?: {
17
+ readonly import: TypesImportSpec;
18
+ };
19
+ readonly operationTypes?: {
20
+ readonly import: TypesImportSpec;
21
+ };
22
+ readonly storage?: ReadonlyArray<{
23
+ readonly typeId: string;
24
+ readonly familyId: string;
25
+ readonly targetId: string;
26
+ readonly nativeType?: string;
27
+ }>;
28
+ };
29
+ /** Operation manifests for building operation registries */
30
+ readonly operations?: ReadonlyArray<OperationManifest>;
31
+ }
5
32
  /**
6
33
  * Base descriptor for any framework component.
7
34
  *
@@ -18,16 +45,14 @@ import './ir.js';
18
45
  * // All descriptors have these properties
19
46
  * descriptor.kind // The Kind type parameter (e.g., 'family', 'target', or custom kinds)
20
47
  * descriptor.id // Unique string identifier (e.g., 'sql', 'postgres')
21
- * descriptor.manifest // Package metadata (version, capabilities, types, etc.)
48
+ * descriptor.version // Component version (semver)
22
49
  * ```
23
50
  */
24
- interface ComponentDescriptor<Kind extends string> {
51
+ interface ComponentDescriptor<Kind extends string> extends DescriptorDeclarativeFields {
25
52
  /** Discriminator identifying the component type */
26
53
  readonly kind: Kind;
27
54
  /** Unique identifier for this component (e.g., 'sql', 'postgres', 'pgvector') */
28
55
  readonly id: string;
29
- /** Package manifest containing version, capabilities, type imports, and operations */
30
- readonly manifest: ExtensionPackManifest;
31
56
  }
32
57
  /**
33
58
  * Descriptor for a family component.
@@ -67,7 +92,6 @@ interface FamilyDescriptor<TFamilyId extends string> extends ComponentDescriptor
67
92
  * (e.g., Postgres, MySQL, MongoDB). Targets define:
68
93
  * - Native type mappings (e.g., Postgres int4 → TypeScript number)
69
94
  * - Target-specific capabilities (e.g., RETURNING, LATERAL joins)
70
- * - Version constraints and compatibility
71
95
  *
72
96
  * Targets are bound to a family and provide the target-specific implementation
73
97
  * details that adapters and drivers use.
@@ -94,6 +118,16 @@ interface TargetDescriptor<TFamilyId extends string, TTargetId extends string> e
94
118
  /** The target identifier (e.g., 'postgres', 'mysql', 'mongodb') */
95
119
  readonly targetId: TTargetId;
96
120
  }
121
+ /**
122
+ * Base pack reference for target components.
123
+ * Pack refs are JSON-friendly representations used by authoring flows.
124
+ */
125
+ interface TargetPackRef<TFamilyId extends string = string, TTargetId extends string = string> extends DescriptorDeclarativeFields {
126
+ readonly kind: 'target';
127
+ readonly id: string;
128
+ readonly familyId: TFamilyId;
129
+ readonly targetId: TTargetId;
130
+ }
97
131
  /**
98
132
  * Descriptor for an adapter component.
99
133
  *
@@ -334,4 +368,4 @@ interface ExtensionInstance<TFamilyId extends string, TTargetId extends string>
334
368
  readonly targetId: TTargetId;
335
369
  }
336
370
 
337
- export type { AdapterDescriptor, AdapterInstance, ComponentDescriptor, DriverDescriptor, DriverInstance, ExtensionDescriptor, ExtensionInstance, FamilyDescriptor, FamilyInstance, TargetBoundComponentDescriptor, TargetDescriptor, TargetInstance };
371
+ export type { AdapterDescriptor, AdapterInstance, ComponentDescriptor, DescriptorDeclarativeFields, DriverDescriptor, DriverInstance, ExtensionDescriptor, ExtensionInstance, FamilyDescriptor, FamilyInstance, TargetBoundComponentDescriptor, TargetDescriptor, TargetInstance, TargetPackRef };
@@ -14,7 +14,7 @@ interface ContractIR<TStorage extends Record<string, unknown> = Record<string, u
14
14
  readonly models: TModels;
15
15
  readonly relations: TRelations;
16
16
  readonly storage: TStorage;
17
- readonly extensions: Record<string, unknown>;
17
+ readonly extensionPacks: Record<string, unknown>;
18
18
  readonly capabilities: Record<string, Record<string, boolean>>;
19
19
  readonly meta: Record<string, unknown>;
20
20
  readonly sources: Record<string, unknown>;
@@ -42,12 +42,12 @@ declare function irHeader(opts: {
42
42
  */
43
43
  declare function irMeta(opts?: {
44
44
  capabilities?: Record<string, Record<string, boolean>> | undefined;
45
- extensions?: Record<string, unknown> | undefined;
45
+ extensionPacks?: Record<string, unknown> | undefined;
46
46
  meta?: Record<string, unknown> | undefined;
47
47
  sources?: Record<string, unknown> | undefined;
48
48
  }): {
49
49
  readonly capabilities: Record<string, Record<string, boolean>>;
50
- readonly extensions: Record<string, unknown>;
50
+ readonly extensionPacks: Record<string, unknown>;
51
51
  readonly meta: Record<string, unknown>;
52
52
  readonly sources: Record<string, unknown>;
53
53
  };
@@ -65,7 +65,7 @@ declare function contractIR<TStorage extends Record<string, unknown>, TModels ex
65
65
  };
66
66
  meta: {
67
67
  readonly capabilities: Record<string, Record<string, boolean>>;
68
- readonly extensions: Record<string, unknown>;
68
+ readonly extensionPacks: Record<string, unknown>;
69
69
  readonly meta: Record<string, unknown>;
70
70
  readonly sources: Record<string, unknown>;
71
71
  };
@@ -11,7 +11,7 @@ function irHeader(opts) {
11
11
  function irMeta(opts) {
12
12
  return {
13
13
  capabilities: opts?.capabilities ?? {},
14
- extensions: opts?.extensions ?? {},
14
+ extensionPacks: opts?.extensionPacks ?? {},
15
15
  meta: opts?.meta ?? {},
16
16
  sources: opts?.sources ?? {}
17
17
  };
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/ir.ts"],"sourcesContent":["/**\n * ContractIR types and factories for building contract intermediate representation.\n * ContractIR is family-agnostic and used by authoring, emitter, and no-emit runtime.\n */\n\n/**\n * ContractIR represents the intermediate representation of a contract.\n * It is family-agnostic and contains generic storage, models, and relations.\n * Note: coreHash and profileHash are computed by the emitter, not part of the IR.\n */\nexport interface ContractIR<\n TStorage extends Record<string, unknown> = Record<string, unknown>,\n TModels extends Record<string, unknown> = Record<string, unknown>,\n TRelations extends Record<string, unknown> = Record<string, unknown>,\n> {\n readonly schemaVersion: string;\n readonly targetFamily: string;\n readonly target: string;\n readonly models: TModels;\n readonly relations: TRelations;\n readonly storage: TStorage;\n readonly extensions: Record<string, unknown>;\n readonly capabilities: Record<string, Record<string, boolean>>;\n readonly meta: Record<string, unknown>;\n readonly sources: Record<string, unknown>;\n}\n\n/**\n * Creates the header portion of a ContractIR.\n * Contains schema version, target, target family, core hash, and optional profile hash.\n */\nexport function irHeader(opts: {\n target: string;\n targetFamily: string;\n coreHash: string;\n profileHash?: string;\n}): {\n readonly schemaVersion: string;\n readonly target: string;\n readonly targetFamily: string;\n readonly coreHash: string;\n readonly profileHash?: string;\n} {\n return {\n schemaVersion: '1',\n target: opts.target,\n targetFamily: opts.targetFamily,\n coreHash: opts.coreHash,\n ...(opts.profileHash !== undefined && { profileHash: opts.profileHash }),\n };\n}\n\n/**\n * Creates the meta portion of a ContractIR.\n * Contains capabilities, extensions, meta, and sources with empty object defaults.\n * If a field is explicitly `undefined`, it will be omitted (for testing validation).\n */\nexport function irMeta(opts?: {\n capabilities?: Record<string, Record<string, boolean>> | undefined;\n extensions?: Record<string, unknown> | undefined;\n meta?: Record<string, unknown> | undefined;\n sources?: Record<string, unknown> | undefined;\n}): {\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, unknown>;\n} {\n return {\n capabilities: opts?.capabilities ?? {},\n extensions: opts?.extensions ?? {},\n meta: opts?.meta ?? {},\n sources: opts?.sources ?? {},\n };\n}\n\n/**\n * Creates a complete ContractIR by combining header, meta, and family-specific sections.\n * This is a family-agnostic factory that accepts generic storage, models, and relations.\n */\nexport function contractIR<\n TStorage extends Record<string, unknown>,\n TModels extends Record<string, unknown>,\n TRelations extends Record<string, unknown>,\n>(opts: {\n header: {\n readonly schemaVersion: string;\n readonly target: string;\n readonly targetFamily: string;\n readonly coreHash: string;\n readonly profileHash?: string;\n };\n meta: {\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, unknown>;\n };\n storage: TStorage;\n models: TModels;\n relations: TRelations;\n}): ContractIR<TStorage, TModels, TRelations> {\n // ContractIR doesn't include coreHash or profileHash (those are computed by emitter)\n return {\n schemaVersion: opts.header.schemaVersion,\n target: opts.header.target,\n targetFamily: opts.header.targetFamily,\n ...opts.meta,\n storage: opts.storage,\n models: opts.models,\n relations: opts.relations,\n };\n}\n"],"mappings":";AA+BO,SAAS,SAAS,MAWvB;AACA,SAAO;AAAA,IACL,eAAe;AAAA,IACf,QAAQ,KAAK;AAAA,IACb,cAAc,KAAK;AAAA,IACnB,UAAU,KAAK;AAAA,IACf,GAAI,KAAK,gBAAgB,UAAa,EAAE,aAAa,KAAK,YAAY;AAAA,EACxE;AACF;AAOO,SAAS,OAAO,MAUrB;AACA,SAAO;AAAA,IACL,cAAc,MAAM,gBAAgB,CAAC;AAAA,IACrC,YAAY,MAAM,cAAc,CAAC;AAAA,IACjC,MAAM,MAAM,QAAQ,CAAC;AAAA,IACrB,SAAS,MAAM,WAAW,CAAC;AAAA,EAC7B;AACF;AAMO,SAAS,WAId,MAiB4C;AAE5C,SAAO;AAAA,IACL,eAAe,KAAK,OAAO;AAAA,IAC3B,QAAQ,KAAK,OAAO;AAAA,IACpB,cAAc,KAAK,OAAO;AAAA,IAC1B,GAAG,KAAK;AAAA,IACR,SAAS,KAAK;AAAA,IACd,QAAQ,KAAK;AAAA,IACb,WAAW,KAAK;AAAA,EAClB;AACF;","names":[]}
1
+ {"version":3,"sources":["../../src/ir.ts"],"sourcesContent":["/**\n * ContractIR types and factories for building contract intermediate representation.\n * ContractIR is family-agnostic and used by authoring, emitter, and no-emit runtime.\n */\n\n/**\n * ContractIR represents the intermediate representation of a contract.\n * It is family-agnostic and contains generic storage, models, and relations.\n * Note: coreHash and profileHash are computed by the emitter, not part of the IR.\n */\nexport interface ContractIR<\n TStorage extends Record<string, unknown> = Record<string, unknown>,\n TModels extends Record<string, unknown> = Record<string, unknown>,\n TRelations extends Record<string, unknown> = Record<string, unknown>,\n> {\n readonly schemaVersion: string;\n readonly targetFamily: string;\n readonly target: string;\n readonly models: TModels;\n readonly relations: TRelations;\n readonly storage: TStorage;\n readonly extensionPacks: Record<string, unknown>;\n readonly capabilities: Record<string, Record<string, boolean>>;\n readonly meta: Record<string, unknown>;\n readonly sources: Record<string, unknown>;\n}\n\n/**\n * Creates the header portion of a ContractIR.\n * Contains schema version, target, target family, core hash, and optional profile hash.\n */\nexport function irHeader(opts: {\n target: string;\n targetFamily: string;\n coreHash: string;\n profileHash?: string;\n}): {\n readonly schemaVersion: string;\n readonly target: string;\n readonly targetFamily: string;\n readonly coreHash: string;\n readonly profileHash?: string;\n} {\n return {\n schemaVersion: '1',\n target: opts.target,\n targetFamily: opts.targetFamily,\n coreHash: opts.coreHash,\n ...(opts.profileHash !== undefined && { profileHash: opts.profileHash }),\n };\n}\n\n/**\n * Creates the meta portion of a ContractIR.\n * Contains capabilities, extensions, meta, and sources with empty object defaults.\n * If a field is explicitly `undefined`, it will be omitted (for testing validation).\n */\nexport function irMeta(opts?: {\n capabilities?: Record<string, Record<string, boolean>> | undefined;\n extensionPacks?: Record<string, unknown> | undefined;\n meta?: Record<string, unknown> | undefined;\n sources?: Record<string, unknown> | undefined;\n}): {\n readonly capabilities: Record<string, Record<string, boolean>>;\n readonly extensionPacks: Record<string, unknown>;\n readonly meta: Record<string, unknown>;\n readonly sources: Record<string, unknown>;\n} {\n return {\n capabilities: opts?.capabilities ?? {},\n extensionPacks: opts?.extensionPacks ?? {},\n meta: opts?.meta ?? {},\n sources: opts?.sources ?? {},\n };\n}\n\n/**\n * Creates a complete ContractIR by combining header, meta, and family-specific sections.\n * This is a family-agnostic factory that accepts generic storage, models, and relations.\n */\nexport function contractIR<\n TStorage extends Record<string, unknown>,\n TModels extends Record<string, unknown>,\n TRelations extends Record<string, unknown>,\n>(opts: {\n header: {\n readonly schemaVersion: string;\n readonly target: string;\n readonly targetFamily: string;\n readonly coreHash: string;\n readonly profileHash?: string;\n };\n meta: {\n readonly capabilities: Record<string, Record<string, boolean>>;\n readonly extensionPacks: Record<string, unknown>;\n readonly meta: Record<string, unknown>;\n readonly sources: Record<string, unknown>;\n };\n storage: TStorage;\n models: TModels;\n relations: TRelations;\n}): ContractIR<TStorage, TModels, TRelations> {\n // ContractIR doesn't include coreHash or profileHash (those are computed by emitter)\n return {\n schemaVersion: opts.header.schemaVersion,\n target: opts.header.target,\n targetFamily: opts.header.targetFamily,\n ...opts.meta,\n storage: opts.storage,\n models: opts.models,\n relations: opts.relations,\n };\n}\n"],"mappings":";AA+BO,SAAS,SAAS,MAWvB;AACA,SAAO;AAAA,IACL,eAAe;AAAA,IACf,QAAQ,KAAK;AAAA,IACb,cAAc,KAAK;AAAA,IACnB,UAAU,KAAK;AAAA,IACf,GAAI,KAAK,gBAAgB,UAAa,EAAE,aAAa,KAAK,YAAY;AAAA,EACxE;AACF;AAOO,SAAS,OAAO,MAUrB;AACA,SAAO;AAAA,IACL,cAAc,MAAM,gBAAgB,CAAC;AAAA,IACrC,gBAAgB,MAAM,kBAAkB,CAAC;AAAA,IACzC,MAAM,MAAM,QAAQ,CAAC;AAAA,IACrB,SAAS,MAAM,WAAW,CAAC;AAAA,EAC7B;AACF;AAMO,SAAS,WAId,MAiB4C;AAE5C,SAAO;AAAA,IACL,eAAe,KAAK,OAAO;AAAA,IAC3B,QAAQ,KAAK,OAAO;AAAA,IACpB,cAAc,KAAK,OAAO;AAAA,IAC1B,GAAG,KAAK;AAAA,IACR,SAAS,KAAK;AAAA,IACd,QAAQ,KAAK;AAAA,IACb,WAAW,KAAK;AAAA,EAClB;AACF;","names":[]}
@@ -1,3 +1,3 @@
1
- export { A as ArgSpecManifest, k as ExtensionPack, E as ExtensionPackManifest, L as LoweringSpecManifest, O as OperationManifest, l as ReturnSpecManifest } from './pack-manifest-types-BYh8H2fb.js';
1
+ export { A as ArgSpecManifest, L as LoweringSpecManifest, OperationManifest, R as ReturnSpecManifest } from './types.js';
2
2
  import '@prisma-next/operations';
3
3
  import './ir.js';
@@ -1,3 +1,224 @@
1
- export { C as ContractBase, a as ContractMarkerRecord, D as DocCollection, b as DocIndex, c as DocumentContract, d as DocumentStorage, e as ExecutionPlan, f as Expr, F as FieldType, P as ParamDescriptor, g as PlanMeta, h as PlanRefs, R as ResultType, S as Source, T as TargetFamilyHook, i as TypesImportSpec, V as ValidationContext, j as isDocumentContract } from './pack-manifest-types-BYh8H2fb.js';
2
- import '@prisma-next/operations';
3
- import './ir.js';
1
+ import { OperationRegistry } from '@prisma-next/operations';
2
+ import { ContractIR } from './ir.js';
3
+
4
+ interface ContractBase {
5
+ readonly schemaVersion: string;
6
+ readonly target: string;
7
+ readonly targetFamily: string;
8
+ readonly coreHash: string;
9
+ readonly profileHash?: string;
10
+ readonly capabilities?: Record<string, Record<string, boolean>>;
11
+ readonly extensionPacks?: Record<string, unknown>;
12
+ readonly meta?: Record<string, unknown>;
13
+ readonly sources?: Record<string, Source>;
14
+ }
15
+ interface FieldType {
16
+ readonly type: string;
17
+ readonly nullable: boolean;
18
+ readonly items?: FieldType;
19
+ readonly properties?: Record<string, FieldType>;
20
+ }
21
+ interface Source {
22
+ readonly readOnly: boolean;
23
+ readonly projection: Record<string, FieldType>;
24
+ readonly origin?: Record<string, unknown>;
25
+ readonly capabilities?: Record<string, boolean>;
26
+ }
27
+ interface DocIndex {
28
+ readonly name: string;
29
+ readonly keys: Record<string, 'asc' | 'desc'>;
30
+ readonly unique?: boolean;
31
+ readonly where?: Expr;
32
+ }
33
+ type Expr = {
34
+ readonly kind: 'eq';
35
+ readonly path: ReadonlyArray<string>;
36
+ readonly value: unknown;
37
+ } | {
38
+ readonly kind: 'exists';
39
+ readonly path: ReadonlyArray<string>;
40
+ };
41
+ interface DocCollection {
42
+ readonly name: string;
43
+ readonly id?: {
44
+ readonly strategy: 'auto' | 'client' | 'uuid' | 'cuid' | 'objectId';
45
+ };
46
+ readonly fields: Record<string, FieldType>;
47
+ readonly indexes?: ReadonlyArray<DocIndex>;
48
+ readonly readOnly?: boolean;
49
+ }
50
+ interface DocumentStorage {
51
+ readonly document: {
52
+ readonly collections: Record<string, DocCollection>;
53
+ };
54
+ }
55
+ interface DocumentContract extends ContractBase {
56
+ readonly targetFamily: string;
57
+ readonly storage: DocumentStorage;
58
+ }
59
+ interface ParamDescriptor {
60
+ readonly index?: number;
61
+ readonly name?: string;
62
+ readonly codecId?: string;
63
+ readonly nativeType?: string;
64
+ readonly nullable?: boolean;
65
+ readonly source: 'dsl' | 'raw';
66
+ readonly refs?: {
67
+ table: string;
68
+ column: string;
69
+ };
70
+ }
71
+ interface PlanRefs {
72
+ readonly tables?: readonly string[];
73
+ readonly columns?: ReadonlyArray<{
74
+ table: string;
75
+ column: string;
76
+ }>;
77
+ readonly indexes?: ReadonlyArray<{
78
+ readonly table: string;
79
+ readonly columns: ReadonlyArray<string>;
80
+ readonly name?: string;
81
+ }>;
82
+ }
83
+ interface PlanMeta {
84
+ readonly target: string;
85
+ readonly targetFamily?: string;
86
+ readonly coreHash: string;
87
+ readonly profileHash?: string;
88
+ readonly lane: string;
89
+ readonly annotations?: {
90
+ codecs?: Record<string, string>;
91
+ [key: string]: unknown;
92
+ };
93
+ readonly paramDescriptors: ReadonlyArray<ParamDescriptor>;
94
+ readonly refs?: PlanRefs;
95
+ readonly projection?: Record<string, string> | ReadonlyArray<string>;
96
+ /**
97
+ * Optional mapping of projection alias → column type ID (fully qualified ns/name@version).
98
+ * Used for codec resolution when AST+refs don't provide enough type info.
99
+ */
100
+ readonly projectionTypes?: Record<string, string>;
101
+ }
102
+ /**
103
+ * Canonical execution plan shape used by runtimes.
104
+ *
105
+ * - Row is the inferred result row type (TypeScript-only).
106
+ * - Ast is the optional, family-specific AST type (e.g. SQL QueryAst).
107
+ *
108
+ * The payload executed by the runtime is represented by the sql + params pair
109
+ * for now; future families can specialize this via Ast or additional metadata.
110
+ */
111
+ interface ExecutionPlan<Row = unknown, Ast = unknown> {
112
+ readonly sql: string;
113
+ readonly params: readonly unknown[];
114
+ readonly ast?: Ast;
115
+ readonly meta: PlanMeta;
116
+ /**
117
+ * Phantom property to carry the Row generic for type-level utilities.
118
+ * Not set at runtime; used only for ResultType extraction.
119
+ */
120
+ readonly _row?: Row;
121
+ }
122
+ /**
123
+ * Utility type to extract the Row type from an ExecutionPlan.
124
+ * Example: `type Row = ResultType<typeof plan>`
125
+ *
126
+ * Works with both ExecutionPlan and SqlQueryPlan (SQL query plans before lowering).
127
+ * SqlQueryPlan includes a phantom `_Row` property to preserve the generic parameter
128
+ * for type extraction.
129
+ */
130
+ type ResultType<P> = P extends ExecutionPlan<infer R, unknown> ? R : P extends {
131
+ readonly _Row?: infer R;
132
+ } ? R : never;
133
+ /**
134
+ * Type guard to check if a contract is a Document contract
135
+ */
136
+ declare function isDocumentContract(contract: unknown): contract is DocumentContract;
137
+ /**
138
+ * Contract marker record stored in the database.
139
+ * Represents the current contract identity for a database.
140
+ */
141
+ interface ContractMarkerRecord {
142
+ readonly coreHash: string;
143
+ readonly profileHash: string;
144
+ readonly contractJson: unknown | null;
145
+ readonly canonicalVersion: number | null;
146
+ readonly updatedAt: Date;
147
+ readonly appTag: string | null;
148
+ readonly meta: Record<string, unknown>;
149
+ }
150
+ /**
151
+ * Specifies how to import TypeScript types from a package.
152
+ * Used in extension pack manifests to declare codec and operation type imports.
153
+ */
154
+ interface TypesImportSpec {
155
+ readonly package: string;
156
+ readonly named: string;
157
+ readonly alias: string;
158
+ }
159
+ /**
160
+ * Validation context passed to TargetFamilyHook.validateTypes().
161
+ * Contains pre-assembled operation registry, type imports, and extension IDs.
162
+ */
163
+ interface ValidationContext {
164
+ readonly operationRegistry?: OperationRegistry;
165
+ readonly codecTypeImports?: ReadonlyArray<TypesImportSpec>;
166
+ readonly operationTypeImports?: ReadonlyArray<TypesImportSpec>;
167
+ readonly extensionIds?: ReadonlyArray<string>;
168
+ }
169
+ /**
170
+ * SPI interface for target family hooks that extend emission behavior.
171
+ * Implemented by family-specific emitter hooks (e.g., SQL family).
172
+ */
173
+ interface TargetFamilyHook {
174
+ readonly id: string;
175
+ /**
176
+ * Validates that all type IDs in the contract come from referenced extension packs.
177
+ * @param ir - Contract IR to validate
178
+ * @param ctx - Validation context with operation registry and extension IDs
179
+ */
180
+ validateTypes(ir: ContractIR, ctx: ValidationContext): void;
181
+ /**
182
+ * Validates family-specific contract structure.
183
+ * @param ir - Contract IR to validate
184
+ */
185
+ validateStructure(ir: ContractIR): void;
186
+ /**
187
+ * Generates contract.d.ts file content.
188
+ * @param ir - Contract IR
189
+ * @param codecTypeImports - Array of codec type import specs
190
+ * @param operationTypeImports - Array of operation type import specs
191
+ * @returns Generated TypeScript type definitions as string
192
+ */
193
+ generateContractTypes(ir: ContractIR, codecTypeImports: ReadonlyArray<TypesImportSpec>, operationTypeImports: ReadonlyArray<TypesImportSpec>): string;
194
+ }
195
+ type ArgSpecManifest = {
196
+ readonly kind: 'typeId';
197
+ readonly type: string;
198
+ } | {
199
+ readonly kind: 'param';
200
+ } | {
201
+ readonly kind: 'literal';
202
+ };
203
+ type ReturnSpecManifest = {
204
+ readonly kind: 'typeId';
205
+ readonly type: string;
206
+ } | {
207
+ readonly kind: 'builtin';
208
+ readonly type: 'number' | 'boolean' | 'string';
209
+ };
210
+ interface LoweringSpecManifest {
211
+ readonly targetFamily: 'sql';
212
+ readonly strategy: 'infix' | 'function';
213
+ readonly template: string;
214
+ }
215
+ interface OperationManifest {
216
+ readonly for: string;
217
+ readonly method: string;
218
+ readonly args: ReadonlyArray<ArgSpecManifest>;
219
+ readonly returns: ReturnSpecManifest;
220
+ readonly lowering: LoweringSpecManifest;
221
+ readonly capabilities?: ReadonlyArray<string>;
222
+ }
223
+
224
+ export { type ArgSpecManifest as A, type ContractBase, type ContractMarkerRecord, type DocCollection, type DocIndex, type DocumentContract, type DocumentStorage, type ExecutionPlan, type Expr, type FieldType, type LoweringSpecManifest as L, type OperationManifest, type ParamDescriptor, type PlanMeta, type PlanRefs, type ReturnSpecManifest as R, type ResultType, type Source, type TargetFamilyHook, type TypesImportSpec, type ValidationContext, isDocumentContract };
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/types.ts"],"sourcesContent":["import type { OperationRegistry } from '@prisma-next/operations';\nimport type { ContractIR } from './ir';\n\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":";AA8IO,SAAS,mBAAmB,UAAiD;AAClF,SACE,OAAO,aAAa,YACpB,aAAa,QACb,kBAAkB,YAClB,SAAS,iBAAiB;AAE9B;","names":[]}
1
+ {"version":3,"sources":["../../src/types.ts"],"sourcesContent":["import type { OperationRegistry } from '@prisma-next/operations';\nimport type { ContractIR } from './ir';\n\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 extensionPacks?: 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 extension packs.\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"],"mappings":";AA8IO,SAAS,mBAAmB,UAAiD;AAClF,SACE,OAAO,aAAa,YACpB,aAAa,QACb,kBAAkB,YAClB,SAAS,iBAAiB;AAE9B;","names":[]}
package/package.json CHANGED
@@ -1,11 +1,11 @@
1
1
  {
2
2
  "name": "@prisma-next/contract",
3
- "version": "0.1.0-pr.64.6",
3
+ "version": "0.1.0-pr.65.2",
4
4
  "type": "module",
5
5
  "sideEffects": false,
6
6
  "description": "Data contract type definitions and JSON schema for Prisma Next",
7
7
  "dependencies": {
8
- "@prisma-next/operations": "0.1.0-pr.64.6"
8
+ "@prisma-next/operations": "0.1.0-pr.65.2"
9
9
  },
10
10
  "devDependencies": {
11
11
  "@vitest/coverage-v8": "^4.0.0",
@@ -1,251 +0,0 @@
1
- import { OperationRegistry } from '@prisma-next/operations';
2
- import { ContractIR } from './ir.js';
3
-
4
- interface ContractBase {
5
- readonly schemaVersion: string;
6
- readonly target: string;
7
- readonly targetFamily: string;
8
- readonly coreHash: string;
9
- readonly profileHash?: string;
10
- readonly capabilities?: Record<string, Record<string, boolean>>;
11
- readonly extensions?: Record<string, unknown>;
12
- readonly meta?: Record<string, unknown>;
13
- readonly sources?: Record<string, Source>;
14
- }
15
- interface FieldType {
16
- readonly type: string;
17
- readonly nullable: boolean;
18
- readonly items?: FieldType;
19
- readonly properties?: Record<string, FieldType>;
20
- }
21
- interface Source {
22
- readonly readOnly: boolean;
23
- readonly projection: Record<string, FieldType>;
24
- readonly origin?: Record<string, unknown>;
25
- readonly capabilities?: Record<string, boolean>;
26
- }
27
- interface DocIndex {
28
- readonly name: string;
29
- readonly keys: Record<string, 'asc' | 'desc'>;
30
- readonly unique?: boolean;
31
- readonly where?: Expr;
32
- }
33
- type Expr = {
34
- readonly kind: 'eq';
35
- readonly path: ReadonlyArray<string>;
36
- readonly value: unknown;
37
- } | {
38
- readonly kind: 'exists';
39
- readonly path: ReadonlyArray<string>;
40
- };
41
- interface DocCollection {
42
- readonly name: string;
43
- readonly id?: {
44
- readonly strategy: 'auto' | 'client' | 'uuid' | 'cuid' | 'objectId';
45
- };
46
- readonly fields: Record<string, FieldType>;
47
- readonly indexes?: ReadonlyArray<DocIndex>;
48
- readonly readOnly?: boolean;
49
- }
50
- interface DocumentStorage {
51
- readonly document: {
52
- readonly collections: Record<string, DocCollection>;
53
- };
54
- }
55
- interface DocumentContract extends ContractBase {
56
- readonly targetFamily: string;
57
- readonly storage: DocumentStorage;
58
- }
59
- interface ParamDescriptor {
60
- readonly index?: number;
61
- readonly name?: string;
62
- readonly codecId?: string;
63
- readonly nativeType?: string;
64
- readonly nullable?: boolean;
65
- readonly source: 'dsl' | 'raw';
66
- readonly refs?: {
67
- table: string;
68
- column: string;
69
- };
70
- }
71
- interface PlanRefs {
72
- readonly tables?: readonly string[];
73
- readonly columns?: ReadonlyArray<{
74
- table: string;
75
- column: string;
76
- }>;
77
- readonly indexes?: ReadonlyArray<{
78
- readonly table: string;
79
- readonly columns: ReadonlyArray<string>;
80
- readonly name?: string;
81
- }>;
82
- }
83
- interface PlanMeta {
84
- readonly target: string;
85
- readonly targetFamily?: string;
86
- readonly coreHash: string;
87
- readonly profileHash?: string;
88
- readonly lane: string;
89
- readonly annotations?: {
90
- codecs?: Record<string, string>;
91
- [key: string]: unknown;
92
- };
93
- readonly paramDescriptors: ReadonlyArray<ParamDescriptor>;
94
- readonly refs?: PlanRefs;
95
- readonly projection?: Record<string, string> | ReadonlyArray<string>;
96
- /**
97
- * Optional mapping of projection alias → column type ID (fully qualified ns/name@version).
98
- * Used for codec resolution when AST+refs don't provide enough type info.
99
- */
100
- readonly projectionTypes?: Record<string, string>;
101
- }
102
- /**
103
- * Canonical execution plan shape used by runtimes.
104
- *
105
- * - Row is the inferred result row type (TypeScript-only).
106
- * - Ast is the optional, family-specific AST type (e.g. SQL QueryAst).
107
- *
108
- * The payload executed by the runtime is represented by the sql + params pair
109
- * for now; future families can specialize this via Ast or additional metadata.
110
- */
111
- interface ExecutionPlan<Row = unknown, Ast = unknown> {
112
- readonly sql: string;
113
- readonly params: readonly unknown[];
114
- readonly ast?: Ast;
115
- readonly meta: PlanMeta;
116
- /**
117
- * Phantom property to carry the Row generic for type-level utilities.
118
- * Not set at runtime; used only for ResultType extraction.
119
- */
120
- readonly _row?: Row;
121
- }
122
- /**
123
- * Utility type to extract the Row type from an ExecutionPlan.
124
- * Example: `type Row = ResultType<typeof plan>`
125
- *
126
- * Works with both ExecutionPlan and SqlQueryPlan (SQL query plans before lowering).
127
- * SqlQueryPlan includes a phantom `_Row` property to preserve the generic parameter
128
- * for type extraction.
129
- */
130
- type ResultType<P> = P extends ExecutionPlan<infer R, unknown> ? R : P extends {
131
- readonly _Row?: infer R;
132
- } ? R : never;
133
- /**
134
- * Type guard to check if a contract is a Document contract
135
- */
136
- declare function isDocumentContract(contract: unknown): contract is DocumentContract;
137
- /**
138
- * Contract marker record stored in the database.
139
- * Represents the current contract identity for a database.
140
- */
141
- interface ContractMarkerRecord {
142
- readonly coreHash: string;
143
- readonly profileHash: string;
144
- readonly contractJson: unknown | null;
145
- readonly canonicalVersion: number | null;
146
- readonly updatedAt: Date;
147
- readonly appTag: string | null;
148
- readonly meta: Record<string, unknown>;
149
- }
150
- /**
151
- * Specifies how to import TypeScript types from a package.
152
- * Used in extension pack manifests to declare codec and operation type imports.
153
- */
154
- interface TypesImportSpec {
155
- readonly package: string;
156
- readonly named: string;
157
- readonly alias: string;
158
- }
159
- /**
160
- * Validation context passed to TargetFamilyHook.validateTypes().
161
- * Contains pre-assembled operation registry, type imports, and extension IDs.
162
- */
163
- interface ValidationContext {
164
- readonly operationRegistry?: OperationRegistry;
165
- readonly codecTypeImports?: ReadonlyArray<TypesImportSpec>;
166
- readonly operationTypeImports?: ReadonlyArray<TypesImportSpec>;
167
- readonly extensionIds?: ReadonlyArray<string>;
168
- }
169
- /**
170
- * SPI interface for target family hooks that extend emission behavior.
171
- * Implemented by family-specific emitter hooks (e.g., SQL family).
172
- */
173
- interface TargetFamilyHook {
174
- readonly id: string;
175
- /**
176
- * Validates that all type IDs in the contract come from referenced extensions.
177
- * @param ir - Contract IR to validate
178
- * @param ctx - Validation context with operation registry and extension IDs
179
- */
180
- validateTypes(ir: ContractIR, ctx: ValidationContext): void;
181
- /**
182
- * Validates family-specific contract structure.
183
- * @param ir - Contract IR to validate
184
- */
185
- validateStructure(ir: ContractIR): void;
186
- /**
187
- * Generates contract.d.ts file content.
188
- * @param ir - Contract IR
189
- * @param codecTypeImports - Array of codec type import specs
190
- * @param operationTypeImports - Array of operation type import specs
191
- * @returns Generated TypeScript type definitions as string
192
- */
193
- generateContractTypes(ir: ContractIR, codecTypeImports: ReadonlyArray<TypesImportSpec>, operationTypeImports: ReadonlyArray<TypesImportSpec>): string;
194
- }
195
- type ArgSpecManifest = {
196
- readonly kind: 'typeId';
197
- readonly type: string;
198
- } | {
199
- readonly kind: 'param';
200
- } | {
201
- readonly kind: 'literal';
202
- };
203
- type ReturnSpecManifest = {
204
- readonly kind: 'typeId';
205
- readonly type: string;
206
- } | {
207
- readonly kind: 'builtin';
208
- readonly type: 'number' | 'boolean' | 'string';
209
- };
210
- interface LoweringSpecManifest {
211
- readonly targetFamily: 'sql';
212
- readonly strategy: 'infix' | 'function';
213
- readonly template: string;
214
- }
215
- interface OperationManifest {
216
- readonly for: string;
217
- readonly method: string;
218
- readonly args: ReadonlyArray<ArgSpecManifest>;
219
- readonly returns: ReturnSpecManifest;
220
- readonly lowering: LoweringSpecManifest;
221
- readonly capabilities?: ReadonlyArray<string>;
222
- }
223
- interface ExtensionPackManifest {
224
- readonly id: string;
225
- readonly version: string;
226
- readonly targets?: Record<string, {
227
- readonly minVersion?: string;
228
- }>;
229
- readonly capabilities?: Record<string, unknown>;
230
- readonly types?: {
231
- readonly codecTypes?: {
232
- readonly import: TypesImportSpec;
233
- };
234
- readonly operationTypes?: {
235
- readonly import: TypesImportSpec;
236
- };
237
- readonly storage?: readonly {
238
- readonly typeId: string;
239
- readonly familyId: string;
240
- readonly targetId: string;
241
- readonly nativeType?: string;
242
- }[];
243
- };
244
- readonly operations?: ReadonlyArray<OperationManifest>;
245
- }
246
- interface ExtensionPack {
247
- readonly manifest: ExtensionPackManifest;
248
- readonly path: string;
249
- }
250
-
251
- export { type ArgSpecManifest as A, type ContractBase as C, type DocCollection as D, type ExtensionPackManifest as E, type FieldType as F, type LoweringSpecManifest as L, type OperationManifest as O, type ParamDescriptor as P, type ResultType as R, type Source as S, type TargetFamilyHook as T, type ValidationContext as V, type ContractMarkerRecord as a, type DocIndex as b, type DocumentContract as c, type DocumentStorage as d, type ExecutionPlan as e, type Expr as f, type PlanMeta as g, type PlanRefs as h, type TypesImportSpec as i, isDocumentContract as j, type ExtensionPack as k, type ReturnSpecManifest as l };