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

package/dist/exports/types.d.ts

@@ -1,224 +1,3 @@
-import { OperationRegistry } from '@prisma-next/operations';
-import { ContractIR } from './ir.js';
-
-interface ContractBase {
-    readonly schemaVersion: string;
-    readonly target: string;
-    readonly targetFamily: string;
-    readonly coreHash: string;
-    readonly profileHash?: string;
-    readonly capabilities?: Record<string, Record<string, boolean>>;
-    readonly extensionPacks?: Record<string, unknown>;
-    readonly meta?: Record<string, unknown>;
-    readonly sources?: Record<string, Source>;
-}
-interface FieldType {
-    readonly type: string;
-    readonly nullable: boolean;
-    readonly items?: FieldType;
-    readonly properties?: Record<string, FieldType>;
-}
-interface Source {
-    readonly readOnly: boolean;
-    readonly projection: Record<string, FieldType>;
-    readonly origin?: Record<string, unknown>;
-    readonly capabilities?: Record<string, boolean>;
-}
-interface DocIndex {
-    readonly name: string;
-    readonly keys: Record<string, 'asc' | 'desc'>;
-    readonly unique?: boolean;
-    readonly where?: Expr;
-}
-type Expr = {
-    readonly kind: 'eq';
-    readonly path: ReadonlyArray<string>;
-    readonly value: unknown;
-} | {
-    readonly kind: 'exists';
-    readonly path: ReadonlyArray<string>;
-};
-interface DocCollection {
-    readonly name: string;
-    readonly id?: {
-        readonly strategy: 'auto' | 'client' | 'uuid' | 'cuid' | 'objectId';
-    };
-    readonly fields: Record<string, FieldType>;
-    readonly indexes?: ReadonlyArray<DocIndex>;
-    readonly readOnly?: boolean;
-}
-interface DocumentStorage {
-    readonly document: {
-        readonly collections: Record<string, DocCollection>;
-    };
-}
-interface DocumentContract extends ContractBase {
-    readonly targetFamily: string;
-    readonly storage: DocumentStorage;
-}
-interface ParamDescriptor {
-    readonly index?: number;
-    readonly name?: string;
-    readonly codecId?: string;
-    readonly nativeType?: string;
-    readonly nullable?: boolean;
-    readonly source: 'dsl' | 'raw';
-    readonly refs?: {
-        table: string;
-        column: string;
-    };
-}
-interface PlanRefs {
-    readonly tables?: readonly string[];
-    readonly columns?: ReadonlyArray<{
-        table: string;
-        column: string;
-    }>;
-    readonly indexes?: ReadonlyArray<{
-        readonly table: string;
-        readonly columns: ReadonlyArray<string>;
-        readonly name?: string;
-    }>;
-}
-interface PlanMeta {
-    readonly target: string;
-    readonly targetFamily?: string;
-    readonly coreHash: string;
-    readonly profileHash?: string;
-    readonly lane: string;
-    readonly annotations?: {
-        codecs?: Record<string, string>;
-        [key: string]: unknown;
-    };
-    readonly paramDescriptors: ReadonlyArray<ParamDescriptor>;
-    readonly refs?: PlanRefs;
-    readonly projection?: Record<string, string> | ReadonlyArray<string>;
-    /**
-     * Optional mapping of projection alias → column type ID (fully qualified ns/name@version).
-     * Used for codec resolution when AST+refs don't provide enough type info.
-     */
-    readonly projectionTypes?: Record<string, string>;
-}
-/**
- * Canonical execution plan shape used by runtimes.
- *
- * - Row is the inferred result row type (TypeScript-only).
- * - Ast is the optional, family-specific AST type (e.g. SQL QueryAst).
- *
- * The payload executed by the runtime is represented by the sql + params pair
- * for now; future families can specialize this via Ast or additional metadata.
- */
-interface ExecutionPlan<Row = unknown, Ast = unknown> {
-    readonly sql: string;
-    readonly params: readonly unknown[];
-    readonly ast?: Ast;
-    readonly meta: PlanMeta;
-    /**
-     * Phantom property to carry the Row generic for type-level utilities.
-     * Not set at runtime; used only for ResultType extraction.
-     */
-    readonly _row?: Row;
-}
-/**
- * Utility type to extract the Row type from an ExecutionPlan.
- * Example: `type Row = ResultType<typeof plan>`
- *
- * Works with both ExecutionPlan and SqlQueryPlan (SQL query plans before lowering).
- * SqlQueryPlan includes a phantom `_Row` property to preserve the generic parameter
- * for type extraction.
- */
-type ResultType<P> = P extends ExecutionPlan<infer R, unknown> ? R : P extends {
-    readonly _Row?: infer R;
-} ? R : never;
-/**
- * Type guard to check if a contract is a Document contract
- */
-declare function isDocumentContract(contract: unknown): contract is DocumentContract;
-/**
- * Contract marker record stored in the database.
- * Represents the current contract identity for a database.
- */
-interface ContractMarkerRecord {
-    readonly coreHash: string;
-    readonly profileHash: string;
-    readonly contractJson: unknown | null;
-    readonly canonicalVersion: number | null;
-    readonly updatedAt: Date;
-    readonly appTag: string | null;
-    readonly meta: Record<string, unknown>;
-}
-/**
- * Specifies how to import TypeScript types from a package.
- * Used in extension pack manifests to declare codec and operation type imports.
- */
-interface TypesImportSpec {
-    readonly package: string;
-    readonly named: string;
-    readonly alias: string;
-}
-/**
- * Validation context passed to TargetFamilyHook.validateTypes().
- * Contains pre-assembled operation registry, type imports, and extension IDs.
- */
-interface ValidationContext {
-    readonly operationRegistry?: OperationRegistry;
-    readonly codecTypeImports?: ReadonlyArray<TypesImportSpec>;
-    readonly operationTypeImports?: ReadonlyArray<TypesImportSpec>;
-    readonly extensionIds?: ReadonlyArray<string>;
-}
-/**
- * SPI interface for target family hooks that extend emission behavior.
- * Implemented by family-specific emitter hooks (e.g., SQL family).
- */
-interface TargetFamilyHook {
-    readonly id: string;
-    /**
-     * Validates that all type IDs in the contract come from referenced extension packs.
-     * @param ir - Contract IR to validate
-     * @param ctx - Validation context with operation registry and extension IDs
-     */
-    validateTypes(ir: ContractIR, ctx: ValidationContext): void;
-    /**
-     * Validates family-specific contract structure.
-     * @param ir - Contract IR to validate
-     */
-    validateStructure(ir: ContractIR): void;
-    /**
-     * Generates contract.d.ts file content.
-     * @param ir - Contract IR
-     * @param codecTypeImports - Array of codec type import specs
-     * @param operationTypeImports - Array of operation type import specs
-     * @returns Generated TypeScript type definitions as string
-     */
-    generateContractTypes(ir: ContractIR, codecTypeImports: ReadonlyArray<TypesImportSpec>, operationTypeImports: ReadonlyArray<TypesImportSpec>): string;
-}
-type ArgSpecManifest = {
-    readonly kind: 'typeId';
-    readonly type: string;
-} | {
-    readonly kind: 'param';
-} | {
-    readonly kind: 'literal';
-};
-type ReturnSpecManifest = {
-    readonly kind: 'typeId';
-    readonly type: string;
-} | {
-    readonly kind: 'builtin';
-    readonly type: 'number' | 'boolean' | 'string';
-};
-interface LoweringSpecManifest {
-    readonly targetFamily: 'sql';
-    readonly strategy: 'infix' | 'function';
-    readonly template: string;
-}
-interface OperationManifest {
-    readonly for: string;
-    readonly method: string;
-    readonly args: ReadonlyArray<ArgSpecManifest>;
-    readonly returns: ReturnSpecManifest;
-    readonly lowering: LoweringSpecManifest;
-    readonly capabilities?: ReadonlyArray<string>;
-}
-
-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 };
+export type { ContractBase, ContractMarkerRecord, DocCollection, DocIndex, DocumentContract, DocumentStorage, ExecutionPlan, Expr, FieldType, OperationManifest, ParamDescriptor, PlanMeta, PlanRefs, ResultType, Source, TargetFamilyHook, TypesImportSpec, ValidationContext, } from '../types';
+export { isDocumentContract } from '../types';
+//# sourceMappingURL=types.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/exports/types.ts"],"names":[],"mappings":"AAIA,YAAY,EACV,YAAY,EACZ,oBAAoB,EACpB,aAAa,EACb,QAAQ,EACR,gBAAgB,EAChB,eAAe,EACf,aAAa,EACb,IAAI,EACJ,SAAS,EACT,iBAAiB,EACjB,eAAe,EACf,QAAQ,EACR,QAAQ,EACR,UAAU,EACV,MAAM,EACN,gBAAgB,EAChB,eAAe,EACf,iBAAiB,GAClB,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC"}

package/dist/framework-components.d.ts

@@ -0,0 +1,408 @@
+import type { OperationManifest, TypesImportSpec } from './types';
+/**
+ * Declarative fields that describe component metadata.
+ * These fields are owned directly by descriptors (not nested under a manifest).
+ */
+export 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)
+ * ```
+ */
+export 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;
+}
+export 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>;
+}
+export interface ContractComponentRequirementsCheckResult {
+    readonly familyMismatch?: {
+        readonly expected: string;
+        readonly actual: string;
+    } | undefined;
+    readonly targetMismatch?: {
+        readonly expected: string;
+        readonly actual: string;
+    } | undefined;
+    readonly missingExtensionPackIds: readonly string[];
+}
+export 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'
+ * ```
+ */
+export 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'
+ * ```
+ */
+export 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.
+ */
+export interface PackRefBase<Kind extends string, TFamilyId extends string> extends ComponentMetadata {
+    readonly kind: Kind;
+    readonly id: string;
+    readonly familyId: TFamilyId;
+    readonly targetId?: string;
+}
+export type TargetPackRef<TFamilyId extends string = string, TTargetId extends string = string> = PackRefBase<'target', TFamilyId> & {
+    readonly targetId: TTargetId;
+};
+export type AdapterPackRef<TFamilyId extends string = string, TTargetId extends string = string> = PackRefBase<'adapter', TFamilyId> & {
+    readonly targetId: TTargetId;
+};
+export type ExtensionPackRef<TFamilyId extends string = string, TTargetId extends string = string> = PackRefBase<'extension', TFamilyId> & {
+    readonly targetId: TTargetId;
+};
+export 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'
+ * ```
+ */
+export 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'
+ * ```
+ */
+export 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'
+ * ```
+ */
+export 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,
+ * ];
+ * ```
+ */
+export 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'
+ * ```
+ */
+export 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'
+ * ```
+ */
+export 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'
+ * ```
+ */
+export 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'
+ * ```
+ */
+export 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'
+ * ```
+ */
+export 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;
+}
+//# sourceMappingURL=framework-components.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"framework-components.d.ts","sourceRoot":"","sources":["../src/framework-components.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AA+BlE;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAChC,iCAAiC;IACjC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB;;;;;;;OAOG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEhD,gDAAgD;IAChD,QAAQ,CAAC,KAAK,CAAC,EAAE;QACf,QAAQ,CAAC,UAAU,CAAC,EAAE;YAAE,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAA;SAAE,CAAC;QAC3D,QAAQ,CAAC,cAAc,CAAC,EAAE;YAAE,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAA;SAAE,CAAC;QAC/D,QAAQ,CAAC,OAAO,CAAC,EAAE,aAAa,CAAC;YAC/B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;YACxB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;YAC1B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;YAC1B,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;SAC9B,CAAC,CAAC;KACJ,CAAC;IAEF,4DAA4D;IAC5D,QAAQ,CAAC,UAAU,CAAC,EAAE,aAAa,CAAC,iBAAiB,CAAC,CAAC;CACxD;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,mBAAmB,CAAC,IAAI,SAAS,MAAM,CAAE,SAAQ,iBAAiB;IACjF,mDAAmD;IACnD,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IAEpB,iFAAiF;IACjF,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,uCAAuC;IACtD,QAAQ,CAAC,QAAQ,EAAE;QACjB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QACxB,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAC3C,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC;KAC/D,CAAC;IACF,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACnD,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/C,QAAQ,CAAC,oBAAoB,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;CACjD;AAED,MAAM,WAAW,wCAAwC;IACvD,QAAQ,CAAC,cAAc,CAAC,EAAE;QAAE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,SAAS,CAAC;IAC7F,QAAQ,CAAC,cAAc,CAAC,EAAE;QAAE,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,SAAS,CAAC;IAC7F,QAAQ,CAAC,uBAAuB,EAAE,SAAS,MAAM,EAAE,CAAC;CACrD;AAED,wBAAgB,kCAAkC,CAChD,KAAK,EAAE,uCAAuC,GAC7C,wCAAwC,CAgC1C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,WAAW,gBAAgB,CAAC,SAAS,SAAS,MAAM,CAAE,SAAQ,mBAAmB,CAAC,QAAQ,CAAC;IAC/F,sDAAsD;IACtD,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;CAC9B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,WAAW,gBAAgB,CAAC,SAAS,SAAS,MAAM,EAAE,SAAS,SAAS,MAAM,CAClF,SAAQ,mBAAmB,CAAC,QAAQ,CAAC;IACrC,wCAAwC;IACxC,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;IAE7B,mEAAmE;IACnE,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW,CAAC,IAAI,SAAS,MAAM,EAAE,SAAS,SAAS,MAAM,CACxE,SAAQ,iBAAiB;IACzB,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;IAC7B,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,MAAM,MAAM,aAAa,CACvB,SAAS,SAAS,MAAM,GAAG,MAAM,EACjC,SAAS,SAAS,MAAM,GAAG,MAAM,IAC/B,WAAW,CAAC,QAAQ,EAAE,SAAS,CAAC,GAAG;IACrC,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,cAAc,CACxB,SAAS,SAAS,MAAM,GAAG,MAAM,EACjC,SAAS,SAAS,MAAM,GAAG,MAAM,IAC/B,WAAW,CAAC,SAAS,EAAE,SAAS,CAAC,GAAG;IACtC,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,gBAAgB,CAC1B,SAAS,SAAS,MAAM,GAAG,MAAM,EACjC,SAAS,SAAS,MAAM,GAAG,MAAM,IAC/B,WAAW,CAAC,WAAW,EAAE,SAAS,CAAC,GAAG;IACxC,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,aAAa,CACvB,SAAS,SAAS,MAAM,GAAG,MAAM,EACjC,SAAS,SAAS,MAAM,GAAG,MAAM,IAC/B,WAAW,CAAC,QAAQ,EAAE,SAAS,CAAC,GAAG;IACrC,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;CAC9B,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,WAAW,iBAAiB,CAAC,SAAS,SAAS,MAAM,EAAE,SAAS,SAAS,MAAM,CACnF,SAAQ,mBAAmB,CAAC,SAAS,CAAC;IACtC,yCAAyC;IACzC,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;IAE7B,8CAA8C;IAC9C,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;CAC9B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,WAAW,gBAAgB,CAAC,SAAS,SAAS,MAAM,EAAE,SAAS,SAAS,MAAM,CAClF,SAAQ,mBAAmB,CAAC,QAAQ,CAAC;IACrC,wCAAwC;IACxC,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;IAE7B,yCAAyC;IACzC,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;CAC9B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,WAAW,mBAAmB,CAAC,SAAS,SAAS,MAAM,EAAE,SAAS,SAAS,MAAM,CACrF,SAAQ,mBAAmB,CAAC,WAAW,CAAC;IACxC,2CAA2C;IAC3C,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;IAE7B,gDAAgD;IAChD,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;CAC9B;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,MAAM,8BAA8B,CAAC,SAAS,SAAS,MAAM,EAAE,SAAS,SAAS,MAAM,IACzF,gBAAgB,CAAC,SAAS,EAAE,SAAS,CAAC,GACtC,iBAAiB,CAAC,SAAS,EAAE,SAAS,CAAC,GACvC,gBAAgB,CAAC,SAAS,EAAE,SAAS,CAAC,GACtC,mBAAmB,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;AAa9C;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,cAAc,CAAC,SAAS,SAAS,MAAM;IACtD,sDAAsD;IACtD,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;CAC9B;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,cAAc,CAAC,SAAS,SAAS,MAAM,EAAE,SAAS,SAAS,MAAM;IAChF,wCAAwC;IACxC,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;IAE7B,mEAAmE;IACnE,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;CAC9B;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,eAAe,CAAC,SAAS,SAAS,MAAM,EAAE,SAAS,SAAS,MAAM;IACjF,yCAAyC;IACzC,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;IAE7B,8CAA8C;IAC9C,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;CAC9B;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,cAAc,CAAC,SAAS,SAAS,MAAM,EAAE,SAAS,SAAS,MAAM;IAChF,wCAAwC;IACxC,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;IAE7B,yCAAyC;IACzC,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;CAC9B;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,iBAAiB,CAAC,SAAS,SAAS,MAAM,EAAE,SAAS,SAAS,MAAM;IACnF,2CAA2C;IAC3C,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;IAE7B,gDAAgD;IAChD,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;CAC9B"}