@prisma-next/contract 0.3.0-dev.3 → 0.3.0-dev.5

package/dist/exports/framework-components.d.ts

@@ -1,412 +1,3 @@
-import { TypesImportSpec, OperationManifest } from './types.js';
-import '@prisma-next/operations';
-import './ir.js';
-
-/**
- * Declarative fields that describe component metadata.
- * These fields are owned directly by descriptors (not nested under a manifest).
- */
-interface ComponentMetadata {
-    /** Component version (semver) */
-    readonly version: string;
-    /**
-     * Capabilities this component provides.
-     *
-     * For adapters, capabilities must be declared on the adapter descriptor (so they are emitted into
-     * the contract) and also exposed in runtime adapter code (e.g. `adapter.profile.capabilities`);
-     * keep these declarations in sync. Targets are identifiers/descriptors and typically do not
-     * declare capabilities.
-     */
-    readonly capabilities?: Record<string, unknown>;
-    /** Type imports for contract.d.ts generation */
-    readonly types?: {
-        readonly codecTypes?: {
-            readonly import: TypesImportSpec;
-        };
-        readonly operationTypes?: {
-            readonly import: TypesImportSpec;
-        };
-        readonly storage?: ReadonlyArray<{
-            readonly typeId: string;
-            readonly familyId: string;
-            readonly targetId: string;
-            readonly nativeType?: string;
-        }>;
-    };
-    /** Operation manifests for building operation registries */
-    readonly operations?: ReadonlyArray<OperationManifest>;
-}
-/**
- * Base descriptor for any framework component.
- *
- * All component descriptors share these fundamental properties that identify
- * the component and provide its metadata. This interface is extended by
- * specific descriptor types (FamilyDescriptor, TargetDescriptor, etc.).
- *
- * @template Kind - Discriminator literal identifying the component type.
- *   Built-in kinds are 'family', 'target', 'adapter', 'driver', 'extension',
- *   but the type accepts any string to allow ecosystem extensions.
- *
- * @example
- * ```ts
- * // All descriptors have these properties
- * descriptor.kind     // The Kind type parameter (e.g., 'family', 'target', or custom kinds)
- * descriptor.id       // Unique string identifier (e.g., 'sql', 'postgres')
- * descriptor.version  // Component version (semver)
- * ```
- */
-interface ComponentDescriptor<Kind extends string> extends ComponentMetadata {
-    /** Discriminator identifying the component type */
-    readonly kind: Kind;
-    /** Unique identifier for this component (e.g., 'sql', 'postgres', 'pgvector') */
-    readonly id: string;
-}
-interface ContractComponentRequirementsCheckInput {
-    readonly contract: {
-        readonly target: string;
-        readonly targetFamily?: string | undefined;
-        readonly extensionPacks?: Record<string, unknown> | undefined;
-    };
-    readonly expectedTargetFamily?: string | undefined;
-    readonly expectedTargetId?: string | undefined;
-    readonly providedComponentIds: Iterable<string>;
-}
-interface ContractComponentRequirementsCheckResult {
-    readonly familyMismatch?: {
-        readonly expected: string;
-        readonly actual: string;
-    } | undefined;
-    readonly targetMismatch?: {
-        readonly expected: string;
-        readonly actual: string;
-    } | undefined;
-    readonly missingExtensionPackIds: readonly string[];
-}
-declare function checkContractComponentRequirements(input: ContractComponentRequirementsCheckInput): ContractComponentRequirementsCheckResult;
-/**
- * Descriptor for a family component.
- *
- * A "family" represents a category of data sources with shared semantics
- * (e.g., SQL databases, document stores). Families define:
- * - Query semantics and operations (SELECT, INSERT, find, aggregate, etc.)
- * - Contract structure (tables vs collections, columns vs fields)
- * - Type system and codecs
- *
- * Families are the top-level grouping. Each family contains multiple targets
- * (e.g., SQL family contains Postgres, MySQL, SQLite targets).
- *
- * Extended by plane-specific descriptors:
- * - `ControlFamilyDescriptor` - adds `hook` for CLI/tooling operations
- * - `RuntimeFamilyDescriptor` - adds runtime-specific factory methods
- *
- * @template TFamilyId - Literal type for the family identifier (e.g., 'sql', 'document')
- *
- * @example
- * ```ts
- * import sql from '@prisma-next/family-sql/control';
- *
- * sql.kind     // 'family'
- * sql.familyId // 'sql'
- * sql.id       // 'sql'
- * ```
- */
-interface FamilyDescriptor<TFamilyId extends string> extends ComponentDescriptor<'family'> {
-    /** The family identifier (e.g., 'sql', 'document') */
-    readonly familyId: TFamilyId;
-}
-/**
- * Descriptor for a target component.
- *
- * A "target" represents a specific database or data store within a family
- * (e.g., Postgres, MySQL, MongoDB). Targets define:
- * - Native type mappings (e.g., Postgres int4 → TypeScript number)
- * - Target-specific capabilities (e.g., RETURNING, LATERAL joins)
- *
- * Targets are bound to a family and provide the target-specific implementation
- * details that adapters and drivers use.
- *
- * Extended by plane-specific descriptors:
- * - `ControlTargetDescriptor` - adds optional `migrations` capability
- * - `RuntimeTargetDescriptor` - adds runtime factory method
- *
- * @template TFamilyId - Literal type for the family identifier
- * @template TTargetId - Literal type for the target identifier (e.g., 'postgres', 'mysql')
- *
- * @example
- * ```ts
- * import postgres from '@prisma-next/target-postgres/control';
- *
- * postgres.kind     // 'target'
- * postgres.familyId // 'sql'
- * postgres.targetId // 'postgres'
- * ```
- */
-interface TargetDescriptor<TFamilyId extends string, TTargetId extends string> extends ComponentDescriptor<'target'> {
-    /** The family this target belongs to */
-    readonly familyId: TFamilyId;
-    /** The target identifier (e.g., 'postgres', 'mysql', 'mongodb') */
-    readonly targetId: TTargetId;
-}
-/**
- * Base shape for any pack reference.
- * Pack refs are pure JSON-friendly objects safe to import in authoring flows.
- */
-interface PackRefBase<Kind extends string, TFamilyId extends string> extends ComponentMetadata {
-    readonly kind: Kind;
-    readonly id: string;
-    readonly familyId: TFamilyId;
-    readonly targetId?: string;
-}
-type TargetPackRef<TFamilyId extends string = string, TTargetId extends string = string> = PackRefBase<'target', TFamilyId> & {
-    readonly targetId: TTargetId;
-};
-type AdapterPackRef<TFamilyId extends string = string, TTargetId extends string = string> = PackRefBase<'adapter', TFamilyId> & {
-    readonly targetId: TTargetId;
-};
-type ExtensionPackRef<TFamilyId extends string = string, TTargetId extends string = string> = PackRefBase<'extension', TFamilyId> & {
-    readonly targetId: TTargetId;
-};
-type DriverPackRef<TFamilyId extends string = string, TTargetId extends string = string> = PackRefBase<'driver', TFamilyId> & {
-    readonly targetId: TTargetId;
-};
-/**
- * Descriptor for an adapter component.
- *
- * An "adapter" provides the protocol and dialect implementation for a target.
- * Adapters handle:
- * - SQL/query generation (lowering AST to target-specific syntax)
- * - Codec registration (encoding/decoding between JS and wire types)
- * - Type mappings and coercions
- *
- * Adapters are bound to a specific family+target combination and work with
- * any compatible driver for that target.
- *
- * Extended by plane-specific descriptors:
- * - `ControlAdapterDescriptor` - control-plane factory
- * - `RuntimeAdapterDescriptor` - runtime factory
- *
- * @template TFamilyId - Literal type for the family identifier
- * @template TTargetId - Literal type for the target identifier
- *
- * @example
- * ```ts
- * import postgresAdapter from '@prisma-next/adapter-postgres/control';
- *
- * postgresAdapter.kind     // 'adapter'
- * postgresAdapter.familyId // 'sql'
- * postgresAdapter.targetId // 'postgres'
- * ```
- */
-interface AdapterDescriptor<TFamilyId extends string, TTargetId extends string> extends ComponentDescriptor<'adapter'> {
-    /** The family this adapter belongs to */
-    readonly familyId: TFamilyId;
-    /** The target this adapter is designed for */
-    readonly targetId: TTargetId;
-}
-/**
- * Descriptor for a driver component.
- *
- * A "driver" provides the connection and execution layer for a target.
- * Drivers handle:
- * - Connection management (pooling, timeouts, retries)
- * - Query execution (sending SQL/commands, receiving results)
- * - Transaction management
- * - Wire protocol communication
- *
- * Drivers are bound to a specific family+target and work with any compatible
- * adapter. Multiple drivers can exist for the same target (e.g., node-postgres
- * vs postgres.js for Postgres).
- *
- * Extended by plane-specific descriptors:
- * - `ControlDriverDescriptor` - creates driver from connection URL
- * - `RuntimeDriverDescriptor` - creates driver with runtime options
- *
- * @template TFamilyId - Literal type for the family identifier
- * @template TTargetId - Literal type for the target identifier
- *
- * @example
- * ```ts
- * import postgresDriver from '@prisma-next/driver-postgres/control';
- *
- * postgresDriver.kind     // 'driver'
- * postgresDriver.familyId // 'sql'
- * postgresDriver.targetId // 'postgres'
- * ```
- */
-interface DriverDescriptor<TFamilyId extends string, TTargetId extends string> extends ComponentDescriptor<'driver'> {
-    /** The family this driver belongs to */
-    readonly familyId: TFamilyId;
-    /** The target this driver connects to */
-    readonly targetId: TTargetId;
-}
-/**
- * Descriptor for an extension component.
- *
- * An "extension" adds optional capabilities to a target. Extensions can provide:
- * - Additional operations (e.g., vector similarity search with pgvector)
- * - Custom types and codecs (e.g., vector type)
- * - Extended query capabilities
- *
- * Extensions are bound to a specific family+target and are registered in the
- * config alongside the core components. Multiple extensions can be used together.
- *
- * Extended by plane-specific descriptors:
- * - `ControlExtensionDescriptor` - control-plane extension factory
- * - `RuntimeExtensionDescriptor` - runtime extension factory
- *
- * @template TFamilyId - Literal type for the family identifier
- * @template TTargetId - Literal type for the target identifier
- *
- * @example
- * ```ts
- * import pgvector from '@prisma-next/extension-pgvector/control';
- *
- * pgvector.kind     // 'extension'
- * pgvector.familyId // 'sql'
- * pgvector.targetId // 'postgres'
- * ```
- */
-interface ExtensionDescriptor<TFamilyId extends string, TTargetId extends string> extends ComponentDescriptor<'extension'> {
-    /** The family this extension belongs to */
-    readonly familyId: TFamilyId;
-    /** The target this extension is designed for */
-    readonly targetId: TTargetId;
-}
-/**
- * Union type for target-bound component descriptors.
- *
- * Target-bound components are those that must be compatible with a specific
- * family+target combination. This includes targets, adapters, drivers, and
- * extensions. Families are not target-bound.
- *
- * This type is used in migration and verification interfaces to enforce
- * type-level compatibility between components.
- *
- * @template TFamilyId - Literal type for the family identifier
- * @template TTargetId - Literal type for the target identifier
- *
- * @example
- * ```ts
- * // All these components must have matching familyId and targetId
- * const components: TargetBoundComponentDescriptor<'sql', 'postgres'>[] = [
- *   postgresTarget,
- *   postgresAdapter,
- *   postgresDriver,
- *   pgvectorExtension,
- * ];
- * ```
- */
-type TargetBoundComponentDescriptor<TFamilyId extends string, TTargetId extends string> = TargetDescriptor<TFamilyId, TTargetId> | AdapterDescriptor<TFamilyId, TTargetId> | DriverDescriptor<TFamilyId, TTargetId> | ExtensionDescriptor<TFamilyId, TTargetId>;
-/**
- * Base interface for family instances.
- *
- * A family instance is created by a family descriptor's `create()` method.
- * This base interface carries only the identity; plane-specific interfaces
- * add domain actions (e.g., `emitContract`, `verify` on ControlFamilyInstance).
- *
- * @template TFamilyId - Literal type for the family identifier (e.g., 'sql', 'document')
- *
- * @example
- * ```ts
- * const instance = sql.create({ target, adapter, driver, extensions });
- * instance.familyId // 'sql'
- * ```
- */
-interface FamilyInstance<TFamilyId extends string> {
-    /** The family identifier (e.g., 'sql', 'document') */
-    readonly familyId: TFamilyId;
-}
-/**
- * Base interface for target instances.
- *
- * A target instance is created by a target descriptor's `create()` method.
- * This base interface carries only the identity; plane-specific interfaces
- * add target-specific behavior.
- *
- * @template TFamilyId - Literal type for the family identifier
- * @template TTargetId - Literal type for the target identifier (e.g., 'postgres', 'mysql')
- *
- * @example
- * ```ts
- * const instance = postgres.create();
- * instance.familyId // 'sql'
- * instance.targetId // 'postgres'
- * ```
- */
-interface TargetInstance<TFamilyId extends string, TTargetId extends string> {
-    /** The family this target belongs to */
-    readonly familyId: TFamilyId;
-    /** The target identifier (e.g., 'postgres', 'mysql', 'mongodb') */
-    readonly targetId: TTargetId;
-}
-/**
- * Base interface for adapter instances.
- *
- * An adapter instance is created by an adapter descriptor's `create()` method.
- * This base interface carries only the identity; plane-specific interfaces
- * add adapter-specific behavior (e.g., codec registration, query lowering).
- *
- * @template TFamilyId - Literal type for the family identifier
- * @template TTargetId - Literal type for the target identifier
- *
- * @example
- * ```ts
- * const instance = postgresAdapter.create();
- * instance.familyId // 'sql'
- * instance.targetId // 'postgres'
- * ```
- */
-interface AdapterInstance<TFamilyId extends string, TTargetId extends string> {
-    /** The family this adapter belongs to */
-    readonly familyId: TFamilyId;
-    /** The target this adapter is designed for */
-    readonly targetId: TTargetId;
-}
-/**
- * Base interface for driver instances.
- *
- * A driver instance is created by a driver descriptor's `create()` method.
- * This base interface carries only the identity; plane-specific interfaces
- * add driver-specific behavior (e.g., `query`, `close` on ControlDriverInstance).
- *
- * @template TFamilyId - Literal type for the family identifier
- * @template TTargetId - Literal type for the target identifier
- *
- * @example
- * ```ts
- * const instance = postgresDriver.create({ databaseUrl });
- * instance.familyId // 'sql'
- * instance.targetId // 'postgres'
- * ```
- */
-interface DriverInstance<TFamilyId extends string, TTargetId extends string> {
-    /** The family this driver belongs to */
-    readonly familyId: TFamilyId;
-    /** The target this driver connects to */
-    readonly targetId: TTargetId;
-}
-/**
- * Base interface for extension instances.
- *
- * An extension instance is created by an extension descriptor's `create()` method.
- * This base interface carries only the identity; plane-specific interfaces
- * add extension-specific behavior.
- *
- * @template TFamilyId - Literal type for the family identifier
- * @template TTargetId - Literal type for the target identifier
- *
- * @example
- * ```ts
- * const instance = pgvector.create();
- * instance.familyId // 'sql'
- * instance.targetId // 'postgres'
- * ```
- */
-interface ExtensionInstance<TFamilyId extends string, TTargetId extends string> {
-    /** The family this extension belongs to */
-    readonly familyId: TFamilyId;
-    /** The target this extension is designed for */
-    readonly targetId: TTargetId;
-}
-
-export { type AdapterDescriptor, type AdapterInstance, type AdapterPackRef, type ComponentDescriptor, type ComponentMetadata, type ContractComponentRequirementsCheckInput, type ContractComponentRequirementsCheckResult, type DriverDescriptor, type DriverInstance, type DriverPackRef, type ExtensionDescriptor, type ExtensionInstance, type ExtensionPackRef, type FamilyDescriptor, type FamilyInstance, type PackRefBase, type TargetBoundComponentDescriptor, type TargetDescriptor, type TargetInstance, type TargetPackRef, checkContractComponentRequirements };
+export type { AdapterDescriptor, AdapterInstance, AdapterPackRef, ComponentDescriptor, ComponentMetadata, ContractComponentRequirementsCheckInput, ContractComponentRequirementsCheckResult, DriverDescriptor, DriverInstance, DriverPackRef, ExtensionDescriptor, ExtensionInstance, ExtensionPackRef, FamilyDescriptor, FamilyInstance, PackRefBase, TargetBoundComponentDescriptor, TargetDescriptor, TargetInstance, TargetPackRef, } from '../framework-components';
+export { checkContractComponentRequirements } from '../framework-components';
+//# sourceMappingURL=framework-components.d.ts.map

package/dist/exports/framework-components.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"framework-components.d.ts","sourceRoot":"","sources":["../../src/exports/framework-components.ts"],"names":[],"mappings":"AAAA,YAAY,EAEV,iBAAiB,EAEjB,eAAe,EACf,cAAc,EACd,mBAAmB,EACnB,iBAAiB,EACjB,uCAAuC,EACvC,wCAAwC,EACxC,gBAAgB,EAChB,cAAc,EACd,aAAa,EACb,mBAAmB,EACnB,iBAAiB,EACjB,gBAAgB,EAChB,gBAAgB,EAChB,cAAc,EACd,WAAW,EACX,8BAA8B,EAC9B,gBAAgB,EAChB,cAAc,EACd,aAAa,GACd,MAAM,yBAAyB,CAAC;AAEjC,OAAO,EAAE,kCAAkC,EAAE,MAAM,yBAAyB,CAAC"}

package/dist/exports/ir.d.ts

@@ -1,77 +1,2 @@
-/**
- * ContractIR types and factories for building contract intermediate representation.
- * ContractIR is family-agnostic and used by authoring, emitter, and no-emit runtime.
- */
-/**
- * ContractIR represents the intermediate representation of a contract.
- * It is family-agnostic and contains generic storage, models, and relations.
- * Note: coreHash and profileHash are computed by the emitter, not part of the IR.
- */
-interface ContractIR<TStorage extends Record<string, unknown> = Record<string, unknown>, TModels extends Record<string, unknown> = Record<string, unknown>, TRelations extends Record<string, unknown> = Record<string, unknown>> {
-    readonly schemaVersion: string;
-    readonly targetFamily: string;
-    readonly target: string;
-    readonly models: TModels;
-    readonly relations: TRelations;
-    readonly storage: TStorage;
-    readonly extensionPacks: Record<string, unknown>;
-    readonly capabilities: Record<string, Record<string, boolean>>;
-    readonly meta: Record<string, unknown>;
-    readonly sources: Record<string, unknown>;
-}
-/**
- * Creates the header portion of a ContractIR.
- * Contains schema version, target, target family, core hash, and optional profile hash.
- */
-declare function irHeader(opts: {
-    target: string;
-    targetFamily: string;
-    coreHash: string;
-    profileHash?: string;
-}): {
-    readonly schemaVersion: string;
-    readonly target: string;
-    readonly targetFamily: string;
-    readonly coreHash: string;
-    readonly profileHash?: string;
-};
-/**
- * Creates the meta portion of a ContractIR.
- * Contains capabilities, extensionPacks, meta, and sources with empty object defaults.
- * If a field is explicitly `undefined`, it will be omitted (for testing validation).
- */
-declare function irMeta(opts?: {
-    capabilities?: Record<string, Record<string, boolean>> | undefined;
-    extensionPacks?: Record<string, unknown> | undefined;
-    meta?: Record<string, unknown> | undefined;
-    sources?: Record<string, unknown> | undefined;
-}): {
-    readonly capabilities: Record<string, Record<string, boolean>>;
-    readonly extensionPacks: Record<string, unknown>;
-    readonly meta: Record<string, unknown>;
-    readonly sources: Record<string, unknown>;
-};
-/**
- * Creates a complete ContractIR by combining header, meta, and family-specific sections.
- * This is a family-agnostic factory that accepts generic storage, models, and relations.
- */
-declare function contractIR<TStorage extends Record<string, unknown>, TModels extends Record<string, unknown>, TRelations extends Record<string, unknown>>(opts: {
-    header: {
-        readonly schemaVersion: string;
-        readonly target: string;
-        readonly targetFamily: string;
-        readonly coreHash: string;
-        readonly profileHash?: string;
-    };
-    meta: {
-        readonly capabilities: Record<string, Record<string, boolean>>;
-        readonly extensionPacks: Record<string, unknown>;
-        readonly meta: Record<string, unknown>;
-        readonly sources: Record<string, unknown>;
-    };
-    storage: TStorage;
-    models: TModels;
-    relations: TRelations;
-}): ContractIR<TStorage, TModels, TRelations>;
-
-export { type ContractIR, contractIR, irHeader, irMeta };
+export * from '../ir';
+//# sourceMappingURL=ir.d.ts.map

package/dist/exports/ir.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ir.d.ts","sourceRoot":"","sources":["../../src/exports/ir.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAC"}

package/dist/exports/pack-manifest-types.d.ts

@@ -1,3 +1,2 @@
-export { A as ArgSpecManifest, L as LoweringSpecManifest, OperationManifest, R as ReturnSpecManifest } from './types.js';
-import '@prisma-next/operations';
-import './ir.js';
+export type { ArgSpecManifest, LoweringSpecManifest, OperationManifest, ReturnSpecManifest, } from '../types';
+//# sourceMappingURL=pack-manifest-types.d.ts.map

package/dist/exports/pack-manifest-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pack-manifest-types.d.ts","sourceRoot":"","sources":["../../src/exports/pack-manifest-types.ts"],"names":[],"mappings":"AAAA,YAAY,EACV,eAAe,EACf,oBAAoB,EACpB,iBAAiB,EACjB,kBAAkB,GACnB,MAAM,UAAU,CAAC"}