@prisma-next/core-execution-plane 0.0.1

package/README.md

@@ -0,0 +1,93 @@
+# @prisma-next/core-execution-plane
+
+Execution/runtime plane descriptor and instance types for Prisma Next.
+
+## Overview
+
+This package provides TypeScript type definitions for execution/runtime-plane descriptors and instances. These types define the structure for runtime components (families, targets, adapters, drivers, extensions) that are used during query execution.
+
+## Responsibilities
+
+- **Runtime Instance Types**: Base interfaces for runtime plane instances (`RuntimeFamilyInstance`, `RuntimeTargetInstance`, `RuntimeAdapterInstance`, `RuntimeDriverInstance`, `RuntimeExtensionInstance`)
+- **Runtime Descriptor Types**: Type definitions for runtime plane descriptors (`RuntimeFamilyDescriptor`, `RuntimeTargetDescriptor`, `RuntimeAdapterDescriptor`, `RuntimeDriverDescriptor`, `RuntimeExtensionDescriptor`)
+
+## Dependencies
+
+- **Depends on**:
+  - `@prisma-next/contract` - Extension pack manifest types (`ExtensionPackManifest`)
+
+- **Depended on by**:
+  - Runtime plane packages (adapters, drivers, targets) - Use descriptor and instance types
+  - SQL family runtime - Uses runtime family descriptor types
+
+## Architecture
+
+```mermaid
+flowchart TD
+    subgraph "Core Layer - Runtime Plane"
+        CEP[@prisma-next/core-execution-plane]
+    end
+
+    subgraph "Runtime Plane Packages"
+        ADAPTER[Adapters]
+        DRIVER[Drivers]
+        TARGET[Targets]
+        FAMILY[SQL Family Runtime]
+    end
+
+    ADAPTER -->|uses| CEP
+    DRIVER -->|uses| CEP
+    TARGET -->|uses| CEP
+    FAMILY -->|uses| CEP
+```
+
+## Usage
+
+### Runtime Descriptors
+
+Runtime descriptors provide factory methods to create runtime instances:
+
+```typescript
+import type {
+  RuntimeAdapterDescriptor,
+  RuntimeAdapterInstance,
+} from '@prisma-next/core-execution-plane/types';
+
+// Adapter descriptor provides create() method
+const adapterDescriptor: RuntimeAdapterDescriptor<'sql', 'postgres', SqlAdapter> = {
+  kind: 'adapter',
+  id: 'postgres',
+  familyId: 'sql',
+  targetId: 'postgres',
+  manifest: adapterManifest,
+  create(): SqlAdapter {
+    return createPostgresAdapter();
+  },
+};
+```
+
+### Runtime Instances
+
+Runtime instances are created from descriptors and used during query execution:
+
+```typescript
+import type { RuntimeAdapterInstance } from '@prisma-next/core-execution-plane/types';
+
+// Adapter instance used at runtime
+const adapter: RuntimeAdapterInstance<'sql', 'postgres'> = adapterDescriptor.create();
+```
+
+## Package Location
+
+This package is part of the **framework domain**, **core layer**, **runtime plane**:
+- **Domain**: framework (target-agnostic)
+- **Layer**: core
+- **Plane**: runtime
+- **Path**: `packages/framework/core-execution-plane`
+
+## Related Documentation
+
+- `docs/architecture docs/adrs/ADR 152 - Runtime Plane Descriptors and Instances.md`: Complete ADR specification
+- `.cursor/rules/multi-plane-packages.mdc`: Multi-plane package structure
+- `packages/framework/core-control-plane/README.md`: Control plane counterpart
+

package/dist/exports/types.d.ts

@@ -0,0 +1,131 @@
+import { ExtensionPackManifest } from '@prisma-next/contract/pack-manifest-types';
+
+/**
+ * Base interface for execution/runtime-plane family instances.
+ * Families extend this with domain-specific methods.
+ *
+ * @template TFamilyId - The family ID (e.g., 'sql', 'document')
+ */
+interface RuntimeFamilyInstance<TFamilyId extends string = string> {
+    readonly familyId: TFamilyId;
+}
+/**
+ * Base interface for execution/runtime-plane target instances.
+ *
+ * @template TFamilyId - The family ID (e.g., 'sql', 'document')
+ * @template TTargetId - The target ID (e.g., 'postgres', 'mysql')
+ */
+interface RuntimeTargetInstance<TFamilyId extends string = string, TTargetId extends string = string> {
+    readonly familyId: TFamilyId;
+    readonly targetId: TTargetId;
+}
+/**
+ * Base interface for execution/runtime-plane adapter instances.
+ * Families extend this with family-specific adapter interfaces.
+ *
+ * @template TFamilyId - The family ID (e.g., 'sql', 'document')
+ * @template TTargetId - The target ID (e.g., 'postgres', 'mysql')
+ */
+interface RuntimeAdapterInstance<TFamilyId extends string = string, TTargetId extends string = string> {
+    readonly familyId: TFamilyId;
+    readonly targetId: TTargetId;
+}
+/**
+ * Base interface for execution/runtime-plane driver instances.
+ *
+ * @template TTargetId - The target ID (e.g., 'postgres', 'mysql')
+ */
+interface RuntimeDriverInstance<TTargetId extends string = string> {
+    readonly targetId?: TTargetId;
+}
+/**
+ * Base interface for execution/runtime-plane extension instances.
+ *
+ * @template TFamilyId - The family ID (e.g., 'sql', 'document')
+ * @template TTargetId - The target ID (e.g., 'postgres', 'mysql')
+ */
+interface RuntimeExtensionInstance<TFamilyId extends string = string, TTargetId extends string = string> {
+    readonly familyId: TFamilyId;
+    readonly targetId: TTargetId;
+}
+/**
+ * Descriptor for an execution/runtime-plane family (e.g., SQL).
+ * Provides factory method to create runtime family instance.
+ *
+ * @template TFamilyId - The family ID (e.g., 'sql', 'document')
+ * @template TFamilyInstance - The family instance type
+ */
+interface RuntimeFamilyDescriptor<TFamilyId extends string, TFamilyInstance extends RuntimeFamilyInstance<TFamilyId> = RuntimeFamilyInstance<TFamilyId>> {
+    readonly kind: 'family';
+    readonly id: string;
+    readonly familyId: TFamilyId;
+    readonly manifest: ExtensionPackManifest;
+    create<TTargetId extends string>(options: {
+        readonly target: RuntimeTargetDescriptor<TFamilyId, TTargetId>;
+        readonly adapter: RuntimeAdapterDescriptor<TFamilyId, TTargetId>;
+        readonly driver: RuntimeDriverDescriptor<TFamilyId, TTargetId>;
+        readonly extensions: readonly RuntimeExtensionDescriptor<TFamilyId, TTargetId>[];
+    }): TFamilyInstance;
+}
+/**
+ * Descriptor for an execution/runtime-plane target pack (e.g., Postgres target).
+ *
+ * @template TFamilyId - The family ID (e.g., 'sql', 'document')
+ * @template TTargetId - The target ID (e.g., 'postgres', 'mysql')
+ * @template TTargetInstance - The target instance type
+ */
+interface RuntimeTargetDescriptor<TFamilyId extends string, TTargetId extends string, TTargetInstance extends RuntimeTargetInstance<TFamilyId, TTargetId> = RuntimeTargetInstance<TFamilyId, TTargetId>> {
+    readonly kind: 'target';
+    readonly id: string;
+    readonly familyId: TFamilyId;
+    readonly targetId: TTargetId;
+    readonly manifest: ExtensionPackManifest;
+    create(): TTargetInstance;
+}
+/**
+ * Descriptor for an execution/runtime-plane adapter pack (e.g., Postgres adapter).
+ *
+ * @template TFamilyId - The family ID (e.g., 'sql', 'document')
+ * @template TTargetId - The target ID (e.g., 'postgres', 'mysql')
+ * @template TAdapterInstance - The adapter instance type
+ */
+interface RuntimeAdapterDescriptor<TFamilyId extends string, TTargetId extends string, TAdapterInstance extends RuntimeAdapterInstance<TFamilyId, TTargetId> = RuntimeAdapterInstance<TFamilyId, TTargetId>> {
+    readonly kind: 'adapter';
+    readonly id: string;
+    readonly familyId: TFamilyId;
+    readonly targetId: TTargetId;
+    readonly manifest: ExtensionPackManifest;
+    create(): TAdapterInstance;
+}
+/**
+ * Descriptor for an execution/runtime-plane driver pack (e.g., Postgres driver).
+ *
+ * @template TFamilyId - The family ID (e.g., 'sql', 'document')
+ * @template TTargetId - The target ID (e.g., 'postgres', 'mysql')
+ * @template TDriverInstance - The driver instance type
+ */
+interface RuntimeDriverDescriptor<TFamilyId extends string, TTargetId extends string, TDriverInstance extends RuntimeDriverInstance<TTargetId> = RuntimeDriverInstance<TTargetId>> {
+    readonly kind: 'driver';
+    readonly id: string;
+    readonly familyId: TFamilyId;
+    readonly targetId: TTargetId;
+    readonly manifest: ExtensionPackManifest;
+    create(options: unknown): TDriverInstance;
+}
+/**
+ * Descriptor for an execution/runtime-plane extension pack (e.g., pgvector).
+ *
+ * @template TFamilyId - The family ID (e.g., 'sql', 'document')
+ * @template TTargetId - The target ID (e.g., 'postgres', 'mysql')
+ * @template TExtensionInstance - The extension instance type
+ */
+interface RuntimeExtensionDescriptor<TFamilyId extends string, TTargetId extends string, TExtensionInstance extends RuntimeExtensionInstance<TFamilyId, TTargetId> = RuntimeExtensionInstance<TFamilyId, TTargetId>> {
+    readonly kind: 'extension';
+    readonly id: string;
+    readonly familyId: TFamilyId;
+    readonly targetId: TTargetId;
+    readonly manifest: ExtensionPackManifest;
+    create(): TExtensionInstance;
+}
+
+export type { RuntimeAdapterDescriptor, RuntimeAdapterInstance, RuntimeDriverDescriptor, RuntimeDriverInstance, RuntimeExtensionDescriptor, RuntimeExtensionInstance, RuntimeFamilyDescriptor, RuntimeFamilyInstance, RuntimeTargetDescriptor, RuntimeTargetInstance };

package/dist/exports/types.js

@@ -0,0 +1 @@
+//# sourceMappingURL=types.js.map

package/dist/exports/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@prisma-next/core-execution-plane",
+  "version": "0.0.1",
+  "type": "module",
+  "sideEffects": false,
+  "description": "Execution/runtime plane descriptor and instance types for Prisma Next",
+  "dependencies": {
+    "@prisma-next/contract": "0.0.1",
+    "@prisma-next/core-control-plane": "0.0.1"
+  },
+  "devDependencies": {
+    "tsup": "^8.3.0",
+    "typescript": "^5.9.3",
+    "vitest": "^2.1.1",
+    "@prisma-next/test-utils": "0.0.1"
+  },
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    "./types": {
+      "types": "./dist/exports/types.d.ts",
+      "import": "./dist/exports/types.js"
+    }
+  },
+  "scripts": {
+    "build": "tsup --config tsup.config.ts",
+    "test": "vitest run --passWithNoTests",
+    "test:coverage": "vitest run --coverage --passWithNoTests",
+    "typecheck": "tsc --project tsconfig.json --noEmit",
+    "lint": "biome check . --config-path ../../../biome.json --error-on-warnings",
+    "clean": "node ../../../scripts/clean.mjs"
+  }
+}