@mdbase-dev/pickle 0.1.0-beta.26 → 0.1.0-beta.28

package/dist/index.d.ts

@@ -1,9 +1,14 @@
 import type { CollectionContractDescriptor, CollectionDescription, CollectionTypeDescriptor, JsonObject, RecordDocument } from "@mdbase-dev/connect-protocol";
 import { type MdbaseConnection } from "@mdbase-dev/connect";
-export { PICKLE_ACK_RESPONSE_TYPE_DOCUMENT, PICKLE_APPROVAL_RESPONSE_TYPE_DOCUMENT, PICKLE_REQUEST_CONTRACT_DOCUMENT, PICKLE_TYPE_PACK_PROVISION, PICKLE_REQUEST_TYPE_DOCUMENT } from "./resources.js";
+export { PICKLE_ACK_RESPONSE_TYPE_DOCUMENT, PICKLE_APPROVAL_RESPONSE_TYPE_DOCUMENT, PICKLE_REQUEST_CONTRACT_DOCUMENT, PICKLE_REQUEST_CONTRACT_DIGEST, PICKLE_TYPE_PACK_PROVISION, PICKLE_REQUEST_TYPE_DOCUMENT } from "./resources.js";
 export declare const PICKLE_REQUEST_CONTRACT = "pickle.request";
 export declare const PICKLE_REQUEST_CONTRACT_VERSION = "1.0.0";
 export declare const PICKLE_NOTIFICATION_CRITERION = "pickle.request.created";
+export declare const PICKLE_NOTIFICATION_EVENT: {
+    readonly id: "mdbase.record.created";
+    readonly version: "1.0.0";
+    readonly digest: "sha256:7f3bed6baa356ee9389e977ae7b77a102e2bee871a7c1d9f2026fc21cacdbfc9";
+};
 export type PickleRequestState = "pending" | "answered" | "conflict" | "cancelled";
 export interface PickleFrontmatter extends JsonObject {
     type?: string;

package/dist/index.js

@@ -1,8 +1,11 @@
+import { MDBASE_RECORD_CREATED_CONTRACT } from "@mdbase-dev/connect-protocol";
 import { unwrapConnectOutcome } from "@mdbase-dev/connect";
-export { PICKLE_ACK_RESPONSE_TYPE_DOCUMENT, PICKLE_APPROVAL_RESPONSE_TYPE_DOCUMENT, PICKLE_REQUEST_CONTRACT_DOCUMENT, PICKLE_TYPE_PACK_PROVISION, PICKLE_REQUEST_TYPE_DOCUMENT } from "./resources.js";
+import { PICKLE_REQUEST_CONTRACT_DIGEST } from "./resources.js";
+export { PICKLE_ACK_RESPONSE_TYPE_DOCUMENT, PICKLE_APPROVAL_RESPONSE_TYPE_DOCUMENT, PICKLE_REQUEST_CONTRACT_DOCUMENT, PICKLE_REQUEST_CONTRACT_DIGEST, PICKLE_TYPE_PACK_PROVISION, PICKLE_REQUEST_TYPE_DOCUMENT } from "./resources.js";
 export const PICKLE_REQUEST_CONTRACT = "pickle.request";
 export const PICKLE_REQUEST_CONTRACT_VERSION = "1.0.0";
 export const PICKLE_NOTIFICATION_CRITERION = "pickle.request.created";
+export const PICKLE_NOTIFICATION_EVENT = MDBASE_RECORD_CREATED_CONTRACT;
 const SYSTEM_RESPONSE_FIELDS = new Set([
     "type",
     "types",
@@ -14,7 +17,8 @@ const SYSTEM_RESPONSE_FIELDS = new Set([
 ]);
 export function resolvePickleContract(description) {
     const descriptor = description.contracts.find((contract) => contract.id === PICKLE_REQUEST_CONTRACT &&
-        contract.version === PICKLE_REQUEST_CONTRACT_VERSION);
+        contract.version === PICKLE_REQUEST_CONTRACT_VERSION &&
+        contract.digest === PICKLE_REQUEST_CONTRACT_DIGEST);
     if (!descriptor) {
         throw new PickleContractError("This collection does not provide the Pickle request contract.");
     }

package/dist/resources.d.ts

@@ -1,4 +1,6 @@
 export declare const PICKLE_REQUEST_CONTRACT_DOCUMENT = "---\nkind: mdbase.contract\ncontract_type: record\nid: pickle.request\nversion: 1.0.0\nname: Pickle request\ndescription: A portable asynchronous request that needs a human response.\nrecord_schema:\n  dialect: json-schema-2020-12\n  value:\n    $schema: \"https://json-schema.org/draft/2020-12/schema\"\n    type: object\n    additionalProperties: true\n    required: [title, response_type]\n    properties:\n      id: { type: string }\n      title: { type: string, minLength: 1 }\n      source: { type: string }\n      message: { type: string }\n      kind: { enum: [approval, choice, input, notice, message] }\n      status: { enum: [pending, answered, cancelled] }\n      priority: { enum: [low, normal, high, urgent] }\n      response_type: { type: string }\n      created_at: { type: string, format: date-time }\n      tags:\n        type: array\n        items: { type: string }\n      links:\n        type: array\n        items:\n          type: object\n          additionalProperties: false\n          properties:\n            label: { type: string }\n            url: { type: string }\n            path: { type: string }\n      attachment_paths:\n        type: array\n        items: { type: string }\n      metadata:\n        type: object\n        additionalProperties: true\n---\n";
+/** Semantic digest of the resolved Pickle request contract, pinned by consumers. */
+export declare const PICKLE_REQUEST_CONTRACT_DIGEST = "sha256:5a96bbda301de6ec2f71a5083f62769463b4e613ed8ba860d62170b8c810db61";
 export declare const PICKLE_REQUEST_TYPE_DOCUMENT = "---\nkind: mdbase.type\nname: pickle_request\nversion: 1\ndescription: Async request that needs a human response.\nschema:\n  dialect: json-schema-2020-12\n  value:\n    $schema: \"https://json-schema.org/draft/2020-12/schema\"\n    type: object\n    additionalProperties: true\n    required: [title, response_type]\n    properties:\n      type: { const: pickle_request }\n      id: { type: string }\n      title: { type: string, minLength: 1 }\n      source: { type: string }\n      message: { type: string }\n      kind: { enum: [approval, choice, input, notice, message] }\n      status:\n        enum: [pending, answered, cancelled]\n        description: Legacy lifecycle marker. Response links are authoritative for answered state.\n      priority: { enum: [low, normal, high, urgent] }\n      response_type: { type: string }\n      created_at: { type: string, format: date-time }\n      due_at: { type: string, format: date-time }\n      dedupe_key: { type: string }\n      tags:\n        type: array\n        items: { type: string }\n      links:\n        type: array\n        items:\n          type: object\n          additionalProperties: false\n          properties:\n            label: { type: string }\n            url: { type: string }\n            path: { type: string }\n      attachment_paths:\n        type: array\n        items: { type: string }\n      metadata:\n        type: object\n        additionalProperties: true\n      context:\n        type: object\n        additionalProperties: false\n        properties:\n          cwd: { type: string }\n          repo: { type: string }\n          task: { type: string }\ncollection:\n  display:\n    name_field: title\n  unique:\n    - field: id\n      scope: collection\nlifecycle:\n  on_create:\n    set:\n      created_at: { now: true }\nimplements:\n  - contract: pickle.request\n    version: 1.0.0\n    fields:\n      id: id\n      title: title\n      source: source\n      message: message\n      kind: kind\n      status: status\n      priority: priority\n      response_type: response_type\n      created_at: created_at\n      tags: tags\n      links: links\n      attachment_paths: attachment_paths\n      metadata: metadata\n---\n";
 export declare const PICKLE_APPROVAL_RESPONSE_TYPE_DOCUMENT = "---\nkind: mdbase.type\nname: pickle_response_approval\nversion: 1\ndescription: Approve, reject, or request revision for a Pickle request.\nschema:\n  dialect: json-schema-2020-12\n  value:\n    $schema: \"https://json-schema.org/draft/2020-12/schema\"\n    type: object\n    additionalProperties: true\n    required: [request, decision]\n    properties:\n      type: { const: pickle_response_approval }\n      id: { type: string }\n      request: { type: string }\n      decision: { enum: [approve, reject, revise] }\n      comment: { type: string }\n      responded_at: { type: string, format: date-time }\n      responder: { type: string }\n      attachment_paths:\n        type: array\n        items: { type: string }\ncollection:\n  display:\n    name_field: decision\n  links:\n    request:\n      target_type: pickle_request\n      validate_exists: true\n  unique:\n    - field: id\n      scope: collection\nlifecycle:\n  on_create:\n    set:\n      id: { ulid: true }\n      responded_at: { now: true }\n---\n";
 export declare const PICKLE_ACK_RESPONSE_TYPE_DOCUMENT = "---\nkind: mdbase.type\nname: pickle_response_ack\nversion: 1\ndescription: Acknowledge that a Pickle message was read.\nschema:\n  dialect: json-schema-2020-12\n  value:\n    $schema: \"https://json-schema.org/draft/2020-12/schema\"\n    type: object\n    additionalProperties: true\n    required: [request]\n    properties:\n      type: { const: pickle_response_ack }\n      id: { type: string }\n      request: { type: string }\n      message: { type: string }\n      responded_at: { type: string, format: date-time }\n      responder: { type: string }\n      attachment_paths:\n        type: array\n        items: { type: string }\ncollection:\n  display:\n    name_field: message\n  links:\n    request:\n      target_type: pickle_request\n      validate_exists: true\n  unique:\n    - field: id\n      scope: collection\nlifecycle:\n  on_create:\n    set:\n      id: { ulid: true }\n      responded_at: { now: true }\n---\n";
@@ -11,21 +13,25 @@ export declare const PICKLE_TYPE_PACK_PROVISION: {
         readonly description: "Pickle request and response record types.";
         readonly resources: readonly [{
             readonly kind: "contract";
+            readonly mode: "managed";
             readonly source: "contracts/pickle.request.md";
             readonly target: "_contracts/pickle.request.md";
             readonly digest: "sha256:caf9ee290e98ef51f871a1237b38531168aa1b74640241ce6edece4c2bff66f1";
         }, {
             readonly kind: "type";
+            readonly mode: "seed";
             readonly source: "types/pickle_request.md";
             readonly target: "_types/pickle_request.md";
             readonly digest: "sha256:7f84e359a5a3b7d23dd3471c7557f67cb8a80eb553184db83c4750b2af5761e4";
         }, {
             readonly kind: "type";
+            readonly mode: "seed";
             readonly source: "types/pickle_response_approval.md";
             readonly target: "_types/pickle_response_approval.md";
             readonly digest: "sha256:944d2b68c158297f5d2a035fa6ff3c81a7098531f77a9bc3342dc9435ffcb8b8";
         }, {
             readonly kind: "type";
+            readonly mode: "seed";
             readonly source: "types/pickle_response_ack.md";
             readonly target: "_types/pickle_response_ack.md";
             readonly digest: "sha256:2530c8d21bb711889f20e0d096045cb6c9a7618583b1e2afff7ada72367de41f";
@@ -47,5 +53,6 @@ export declare const PICKLE_TYPE_PACK_PROVISION: {
     readonly provides: readonly [{
         readonly id: "pickle.request";
         readonly version: "1.0.0";
+        readonly digest: "sha256:5a96bbda301de6ec2f71a5083f62769463b4e613ed8ba860d62170b8c810db61";
     }];
 };

package/dist/resources.js

@@ -42,6 +42,8 @@ record_schema:
         additionalProperties: true
 ---
 `;
+/** Semantic digest of the resolved Pickle request contract, pinned by consumers. */
+export const PICKLE_REQUEST_CONTRACT_DIGEST = "sha256:5a96bbda301de6ec2f71a5083f62769463b4e613ed8ba860d62170b8c810db61";
 export const PICKLE_REQUEST_TYPE_DOCUMENT = `---
 kind: mdbase.type
 name: pickle_request
@@ -212,24 +214,28 @@ export const PICKLE_TYPE_PACK_PROVISION = {
         resources: [
             {
                 kind: "contract",
+                mode: "managed",
                 source: "contracts/pickle.request.md",
                 target: "_contracts/pickle.request.md",
                 digest: "sha256:caf9ee290e98ef51f871a1237b38531168aa1b74640241ce6edece4c2bff66f1"
             },
             {
                 kind: "type",
+                mode: "seed",
                 source: "types/pickle_request.md",
                 target: "_types/pickle_request.md",
                 digest: "sha256:7f84e359a5a3b7d23dd3471c7557f67cb8a80eb553184db83c4750b2af5761e4"
             },
             {
                 kind: "type",
+                mode: "seed",
                 source: "types/pickle_response_approval.md",
                 target: "_types/pickle_response_approval.md",
                 digest: "sha256:944d2b68c158297f5d2a035fa6ff3c81a7098531f77a9bc3342dc9435ffcb8b8"
             },
             {
                 kind: "type",
+                mode: "seed",
                 source: "types/pickle_response_ack.md",
                 target: "_types/pickle_response_ack.md",
                 digest: "sha256:2530c8d21bb711889f20e0d096045cb6c9a7618583b1e2afff7ada72367de41f"
@@ -254,5 +260,9 @@ export const PICKLE_TYPE_PACK_PROVISION = {
             document: PICKLE_ACK_RESPONSE_TYPE_DOCUMENT
         }
     ],
-    provides: [{ id: "pickle.request", version: "1.0.0" }]
+    provides: [{
+            id: "pickle.request",
+            version: "1.0.0",
+            digest: PICKLE_REQUEST_CONTRACT_DIGEST
+        }]
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mdbase-dev/pickle",
-  "version": "0.1.0-beta.26",
+  "version": "0.1.0-beta.28",
   "private": false,
   "type": "module",
   "license": "MIT",
@@ -22,13 +22,13 @@
     "README.md"
   ],
   "dependencies": {
-    "@mdbase-dev/connect": "0.1.0-beta.26",
-    "@mdbase-dev/connect-protocol": "0.1.0-beta.26"
+    "@mdbase-dev/connect": "0.1.0-beta.28",
+    "@mdbase-dev/connect-protocol": "0.1.0-beta.28"
   },
   "devDependencies": {
     "typescript": "^7.0.2",
     "vitest": "^4.1.10",
-    "@mdbase-dev/connect-dev": "0.1.0-beta.26"
+    "@mdbase-dev/connect-dev": "0.1.0-beta.28"
   },
   "scripts": {
     "build": "node -e \"require('node:fs').rmSync('dist',{recursive:true,force:true})\" && tsc -p tsconfig.json",