@mdbase-dev/connect-protocol 0.1.0-beta.25 → 0.1.0-beta.27

package/dist/index.d.ts

@@ -1,11 +1,13 @@
 import type { ConnectProblem } from "./connect-problems.generated.js";
 import type { ApplicationFileRequirement, CollectionFileDescriptor, FileCapability } from "./files.js";
 import type { CollectionOperation } from "./operations.js";
+import type { ContractRequirement, ContractSetupChoice, TypePackProvision } from "./type-packs.js";
 import type { ApplicationAuthorizationProof } from "./application-authorization.js";
 export * from "./connect-problems.generated.js";
 export * from "./files.js";
 export * from "./operations.js";
 export * from "./application-authorization.js";
+export * from "./type-packs.js";
 export declare const CONTROL_PROTOCOL_VERSION: 1;
 export declare const ENCRYPTED_RELAY_PROTOCOL_VERSION: 1;
 export declare const FIRST_CONTACT_PROTOCOL_VERSION: 1;
@@ -142,11 +144,6 @@ export interface NotificationWebhook {
     connection_id: string;
     notification: MdbaseNotification;
 }
-export interface ContractRequirement {
-    id: string;
-    /** Exact semantic version of the collection-local mdbase data contract. */
-    version: string;
-}
 export interface ApplicationRequirements {
     contracts: ContractRequirement[];
     /** Access boundary requested after compatibility and provisioning checks. */
@@ -156,60 +153,9 @@ export interface ApplicationRequirements {
     /** First-class non-Markdown file access requested independently of records. */
     files?: ApplicationFileRequirement;
 }
-export interface TypePackManifestResource {
-    kind: "contract" | "type" | "schema";
-    source: string;
-    target: string;
-    digest: string;
-}
-export interface TypePackManifest {
-    kind: "mdbase.type-pack";
-    id: string;
-    version: string;
-    name?: string;
-    description?: string;
-    resources: TypePackManifestResource[];
-    [extension: `x-${string}`]: unknown;
-}
-export interface TypePackSourceResource {
-    source: string;
-    document: string;
-}
-export interface TypePackProvision {
-    /** Canonical type-pack manifest shown during approval and verified on install. */
-    manifest: TypePackManifest;
-    /** Exact UTF-8 resource bytes, keyed by each manifest source path. */
-    resources: TypePackSourceResource[];
-    /** Data contracts expected after the complete pack is installed. */
-    provides: ContractRequirement[];
-}
-export interface TypePackResourceDiff {
-    target: string;
-    kind: "contract" | "type" | "schema";
-    action: "create" | "replace" | "unchanged";
-    digest: string;
-}
-export interface TypePackInstallResult {
-    id: string;
-    version: string;
-    resources: TypePackResourceDiff[];
-    cleanup_deferred: boolean;
-}
 export interface ApplicationProvisions {
     type_packs: TypePackProvision[];
 }
-export type ContractSetupChoice = {
-    contract: ContractRequirement;
-    mode: "starter";
-} | {
-    contract: ContractRequirement;
-    mode: "existing";
-    type_name: string;
-    /** Exact type source revision shown during approval. */
-    type_revision: string;
-    fields: Record<string, string>;
-    binding?: JsonObject;
-};
 export interface GrantScope {
     /**
      * Exact contract definitions and sorted implementation sets approved by the
@@ -336,7 +282,7 @@ export interface SyncCollectionResources {
 }
 export interface SyncResourceDocument {
     path: string;
-    kind: "configuration" | "type" | "contract" | "schema" | "view";
+    kind: "configuration" | "lock" | "type" | "contract" | "schema" | "view";
     /** SHA-256 revision of the exact UTF-8 document (`sha256:<lowercase hex>`). */
     revision: string;
     document: string;

package/dist/index.js

@@ -2,6 +2,7 @@ export * from "./connect-problems.generated.js";
 export * from "./files.js";
 export * from "./operations.js";
 export * from "./application-authorization.js";
+export * from "./type-packs.js";
 export const CONTROL_PROTOCOL_VERSION = 1;
 export const ENCRYPTED_RELAY_PROTOCOL_VERSION = 1;
 export const FIRST_CONTACT_PROTOCOL_VERSION = 1;

package/dist/operations.d.ts

@@ -1 +1 @@
-export type CollectionOperation = "describe" | "changes" | "read" | "query" | "list_views" | "execute_view" | "read_view_source" | "create_view_source" | "update_view_source" | "delete_view_source" | "validate" | "create" | "update" | "delete" | "rename" | "read_type" | "create_type" | "update_type" | "install_type_pack" | "list_timers" | "put_timer" | "cancel_timer" | "reconcile_timers" | "sync";
+export type CollectionOperation = "describe" | "changes" | "read" | "query" | "list_views" | "execute_view" | "read_view_source" | "create_view_source" | "update_view_source" | "delete_view_source" | "validate" | "create" | "update" | "delete" | "rename" | "read_type" | "create_type" | "update_type" | "assess_type_pack" | "apply_type_pack" | "list_timers" | "put_timer" | "cancel_timer" | "reconcile_timers" | "sync";

package/dist/type-packs.d.ts

@@ -0,0 +1,133 @@
+export interface ContractRequirement {
+    id: string;
+    /** Exact semantic version of the collection-local mdbase data contract. */
+    version: string;
+    /** Exact digest of the resolved portable contract identity. */
+    digest: string;
+}
+/** Exact identity of the standard record-created runtime event contract. */
+export declare const MDBASE_RECORD_CREATED_CONTRACT: {
+    readonly id: "mdbase.record.created";
+    readonly version: "1.0.0";
+    readonly digest: "sha256:7f3bed6baa356ee9389e977ae7b77a102e2bee871a7c1d9f2026fc21cacdbfc9";
+};
+/** Exact identity of the standard record-modified runtime event contract. */
+export declare const MDBASE_RECORD_MODIFIED_CONTRACT: {
+    readonly id: "mdbase.record.modified";
+    readonly version: "1.0.0";
+    readonly digest: "sha256:064187148a95701a1f5c749643d306d3c6708470b6b7ab0bf0c698d38dbcabe3";
+};
+/** Exact identity of the standard record-deleted runtime event contract. */
+export declare const MDBASE_RECORD_DELETED_CONTRACT: {
+    readonly id: "mdbase.record.deleted";
+    readonly version: "1.0.0";
+    readonly digest: "sha256:84e5fb0f9d3bfdcd53f76cdc5035f94c7693fdea39a8ead190b10b422dd2ee09";
+};
+/** Exact identity of the standard record-renamed runtime event contract. */
+export declare const MDBASE_RECORD_RENAMED_CONTRACT: {
+    readonly id: "mdbase.record.renamed";
+    readonly version: "1.0.0";
+    readonly digest: "sha256:c825ef8d7db775b784d7af27e6acdf6f2799d2c6440d486f5bfa78afcca71471";
+};
+/** Exact identity of the standard timer-fired runtime event contract. */
+export declare const MDBASE_TIMER_FIRED_CONTRACT: {
+    readonly id: "mdbase.runtime.timer.fired";
+    readonly version: "1.0.0";
+    readonly digest: "sha256:41105be7a7abf33b31ced47e1e1965242236e40ccaea286b959b0a8c591f5642";
+};
+export interface TypePackManifestResource {
+    kind: "contract" | "type" | "schema";
+    mode: "managed" | "seed";
+    source: string;
+    target: string;
+    digest: string;
+}
+export interface TypePackManifest {
+    kind: "mdbase.type-pack";
+    id: string;
+    version: string;
+    name?: string;
+    description?: string;
+    resources: TypePackManifestResource[];
+    [extension: `x-${string}`]: unknown;
+}
+export interface TypePackSourceResource {
+    source: string;
+    document: string;
+}
+export interface TypePackProvision {
+    /** Canonical type-pack manifest shown during approval and verified on install. */
+    manifest: TypePackManifest;
+    /** Exact UTF-8 resource bytes, keyed by each manifest source path. */
+    resources: TypePackSourceResource[];
+    /** Data contracts expected after the complete pack is installed. */
+    provides: ContractRequirement[];
+}
+export interface TypePackResourceDiff {
+    source: string;
+    target: string;
+    kind: "contract" | "type" | "schema";
+    mode: "managed" | "seed";
+    action: "create" | "update" | "delete" | "adopt" | "unchanged" | "preserve" | "conflict";
+    digest: string;
+    current_digest?: string;
+    installed_digest?: string;
+    adopted_from_digest?: string;
+    reason?: string;
+}
+export interface TypePackReceipt {
+    id: string;
+    version: string;
+    digest: string;
+    installed_by: string;
+    resources: Omit<TypePackResourceDiff, "action" | "current_digest" | "installed_digest" | "reason">[];
+}
+export interface TypePackAssessment {
+    status: "current" | "install" | "upgrade" | "downgrade" | "reconfigure" | "conflict";
+    applicable: boolean;
+    assessment_digest: string;
+    current?: TypePackReceipt;
+    desired: TypePackReceipt;
+    resources: TypePackResourceDiff[];
+    lock: {
+        target: "mdbase.lock.yaml";
+        action: "create" | "update" | "unchanged";
+        digest: string;
+    };
+    contract_setups: {
+        choices: ContractSetupChoice[];
+        resources: TypePackResourceDiff[];
+    };
+}
+export interface TypePackApplyResult extends TypePackAssessment {
+    receipt: TypePackReceipt;
+    cleanup_deferred: boolean;
+}
+export interface AssessTypePackInput {
+    provision: TypePackProvision;
+    installed_by: string;
+    /** Explicit digest-pinned consent to claim differing unmanaged managed targets. */
+    adopt_resources?: Record<string, string>;
+    /** Seed resources deliberately omitted because the user selected an existing implementation. */
+    preserve_seed_targets?: string[];
+    /** Resolve canonical manifest targets to collection-specific paths. */
+    target_overrides?: Record<string, string>;
+    /** Reviewed edits to user-owned types, committed atomically with the pack. */
+    contract_setups?: ContractSetupChoice[];
+}
+export interface ApplyTypePackInput extends AssessTypePackInput {
+    expected_assessment_digest: string;
+    allow_downgrade?: boolean;
+}
+export type ContractSetupChoice = {
+    contract: ContractRequirement;
+    mode: "starter";
+} | {
+    contract: ContractRequirement;
+    mode: "existing";
+    type_name: string;
+    /** Exact type source revision shown during approval. */
+    type_revision: string;
+    fields: Record<string, string>;
+    binding?: Record<string, unknown>;
+};

package/dist/type-packs.js

@@ -0,0 +1,30 @@
+/** Exact identity of the standard record-created runtime event contract. */
+export const MDBASE_RECORD_CREATED_CONTRACT = {
+    id: "mdbase.record.created",
+    version: "1.0.0",
+    digest: "sha256:7f3bed6baa356ee9389e977ae7b77a102e2bee871a7c1d9f2026fc21cacdbfc9",
+};
+/** Exact identity of the standard record-modified runtime event contract. */
+export const MDBASE_RECORD_MODIFIED_CONTRACT = {
+    id: "mdbase.record.modified",
+    version: "1.0.0",
+    digest: "sha256:064187148a95701a1f5c749643d306d3c6708470b6b7ab0bf0c698d38dbcabe3",
+};
+/** Exact identity of the standard record-deleted runtime event contract. */
+export const MDBASE_RECORD_DELETED_CONTRACT = {
+    id: "mdbase.record.deleted",
+    version: "1.0.0",
+    digest: "sha256:84e5fb0f9d3bfdcd53f76cdc5035f94c7693fdea39a8ead190b10b422dd2ee09",
+};
+/** Exact identity of the standard record-renamed runtime event contract. */
+export const MDBASE_RECORD_RENAMED_CONTRACT = {
+    id: "mdbase.record.renamed",
+    version: "1.0.0",
+    digest: "sha256:c825ef8d7db775b784d7af27e6acdf6f2799d2c6440d486f5bfa78afcca71471",
+};
+/** Exact identity of the standard timer-fired runtime event contract. */
+export const MDBASE_TIMER_FIRED_CONTRACT = {
+    id: "mdbase.runtime.timer.fired",
+    version: "1.0.0",
+    digest: "sha256:41105be7a7abf33b31ced47e1e1965242236e40ccaea286b959b0a8c591f5642",
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mdbase-dev/connect-protocol",
-  "version": "0.1.0-beta.25",
+  "version": "0.1.0-beta.27",
   "private": false,
   "type": "module",
   "license": "MIT",

package/schemas/connect-protocol.v1.schema.json

@@ -22,15 +22,16 @@
       "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
     },
     "operation": {
-      "enum": ["describe", "changes", "read", "query", "list_views", "execute_view", "read_view_source", "create_view_source", "update_view_source", "delete_view_source", "validate", "create", "update", "delete", "rename", "read_type", "create_type", "update_type", "install_type_pack", "list_timers", "put_timer", "cancel_timer", "reconcile_timers", "sync"]
+      "enum": ["describe", "changes", "read", "query", "list_views", "execute_view", "read_view_source", "create_view_source", "update_view_source", "delete_view_source", "validate", "create", "update", "delete", "rename", "read_type", "create_type", "update_type", "assess_type_pack", "apply_type_pack", "list_timers", "put_timer", "cancel_timer", "reconcile_timers", "sync"]
     },
     "contractRequirement": {
       "type": "object",
       "additionalProperties": false,
-      "required": ["id", "version"],
+      "required": ["id", "version", "digest"],
       "properties": {
         "id": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "^[a-z0-9]+(?:[._-][a-z0-9]+)*$" },
-        "version": { "$ref": "#/$defs/semanticVersion" }
+        "version": { "$ref": "#/$defs/semanticVersion" },
+        "digest": { "$ref": "#/$defs/digest" }
       }
     },
     "semanticVersion": {
@@ -371,9 +372,10 @@
     "typePackManifestResource": {
       "type": "object",
       "additionalProperties": false,
-      "required": ["kind", "source", "target", "digest"],
+      "required": ["kind", "mode", "source", "target", "digest"],
       "properties": {
         "kind": { "enum": ["contract", "type", "schema"] },
+        "mode": { "enum": ["managed", "seed"] },
         "source": { "type": "string", "minLength": 1, "maxLength": 500 },
         "target": { "type": "string", "minLength": 1, "maxLength": 500 },
         "digest": { "$ref": "#/$defs/digest" }

package/schemas/encrypted-relay.v1.schema.json

@@ -14,7 +14,7 @@
       "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
     },
     "operation": {
-      "enum": ["describe", "changes", "read", "query", "list_views", "execute_view", "read_view_source", "create_view_source", "update_view_source", "delete_view_source", "validate", "create", "update", "delete", "rename", "read_type", "create_type", "update_type", "install_type_pack", "list_timers", "put_timer", "cancel_timer", "reconcile_timers", "file_control"]
+      "enum": ["describe", "changes", "read", "query", "list_views", "execute_view", "read_view_source", "create_view_source", "update_view_source", "delete_view_source", "validate", "create", "update", "delete", "rename", "read_type", "create_type", "update_type", "assess_type_pack", "apply_type_pack", "list_timers", "put_timer", "cancel_timer", "reconcile_timers", "file_control"]
     },
     "envelope": {
       "type": "object",

package/schemas/mdbase-app.schema.json

@@ -93,13 +93,14 @@
     "contract": {
       "type": "object",
       "additionalProperties": false,
-      "required": ["id", "version"],
+      "required": ["id", "version", "digest"],
       "properties": {
         "id": { "$ref": "#/$defs/identifier" },
         "version": {
           "type": "string",
           "pattern": "^(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)(?:-[0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*)?(?:\\+[0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*)?$"
-        }
+        },
+        "digest": { "type": "string", "pattern": "^sha256:[0-9a-f]{64}$" }
       }
     },
     "requirements": {
@@ -213,9 +214,10 @@
     "typePackManifestResource": {
       "type": "object",
       "additionalProperties": false,
-      "required": ["kind", "source", "target", "digest"],
+      "required": ["kind", "mode", "source", "target", "digest"],
       "properties": {
         "kind": { "enum": ["contract", "type", "schema"] },
+        "mode": { "enum": ["managed", "seed"] },
         "source": { "type": "string", "minLength": 1, "maxLength": 240 },
         "target": { "type": "string", "minLength": 1, "maxLength": 240 },
         "digest": { "type": "string", "pattern": "^sha256:[0-9a-f]{64}$" }

package/schemas/sync.v1.schema.json

@@ -89,7 +89,7 @@
       "required": ["path", "kind", "revision", "document"],
       "properties": {
         "path": { "type": "string", "minLength": 1 },
-        "kind": { "enum": ["configuration", "type", "contract", "schema", "view"] },
+        "kind": { "enum": ["configuration", "lock", "type", "contract", "schema", "view"] },
         "revision": { "$ref": "#/$defs/digest" },
         "document": { "type": "string" }
       }