@mdbase-dev/pickle 0.1.0-beta.76 → 0.1.0-beta.77

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { type CollectionContractDescriptor, type CollectionDescription, type CollectionTypeDescriptor, type JsonObject, type RecordDocument, type ConnectRequestOptions, type MdbaseConnection, type PendingMutation } from "@mdbase-dev/connect";
-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 { PICKLE_ACK_RESPONSE_TYPE_DOCUMENT, PICKLE_ATTACHMENT_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";
@@ -46,6 +46,13 @@ export interface PickleAttachment {
     path: string;
     filename: string;
 }
+export interface PickleAttachmentContent {
+    path: string;
+    filename: string;
+    mediaType: string;
+    size: number;
+    blob: Blob;
+}
 export interface PickleResponse {
     path: string;
     type: string;
@@ -92,6 +99,8 @@ export interface PickleClient {
     describe(options?: ConnectRequestOptions): ReturnType<MdbaseConnection<PickleFrontmatter>["describe"]>;
     queryAll(input: Parameters<MdbaseConnection<PickleFrontmatter>["queryAll"]>[0], options?: Parameters<MdbaseConnection<PickleFrontmatter>["queryAll"]>[1]): ReturnType<MdbaseConnection<PickleFrontmatter>["queryAll"]>;
     create(input: Parameters<MdbaseConnection<PickleFrontmatter>["create"]>[0], options?: ConnectRequestOptions): ReturnType<MdbaseConnection<PickleFrontmatter>["create"]>;
+    read(input: Parameters<MdbaseConnection<PickleFrontmatter>["read"]>[0], options?: ConnectRequestOptions): ReturnType<MdbaseConnection<PickleFrontmatter>["read"]>;
+    files: MdbaseConnection<PickleFrontmatter>["files"];
     pendingMutations<Result = unknown>(): readonly PendingMutation<Result>[];
     pendingMutation<Result = unknown>(requestId: string): PendingMutation<Result> | null;
 }
@@ -111,6 +120,7 @@ export declare class PickleCollection {
     }>;
     list(options?: ConnectRequestOptions): Promise<PickleRequest[]>;
     respond(request: PickleRequest, payload: JsonObject, options?: RespondOptions): Promise<PickleResponseSubmission>;
+    readAttachment(attachment: PickleAttachment, options?: ConnectRequestOptions): Promise<PickleAttachmentContent | null>;
     pendingResponses(): readonly PicklePendingResponse[];
     recoverResponse(requestId: string, options?: ConnectRequestOptions): Promise<PickleResponseSubmission>;
 }

package/dist/index.js

@@ -1,6 +1,6 @@
 import { MDBASE_RECORD_CREATED_CONTRACT, MdbaseConnectError } from "@mdbase-dev/connect";
 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 { PICKLE_ACK_RESPONSE_TYPE_DOCUMENT, PICKLE_ATTACHMENT_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";
@@ -105,6 +105,49 @@ export class PickleCollection {
         }, requestOptions);
         return responseSubmission(created);
     }
+    async readAttachment(attachment, options = {}) {
+        const path = attachment.path.replace(/^\/+/, "");
+        if (isMarkdownPath(path)) {
+            const outcome = await this.connect.read({ path }, options);
+            if (outcome.ok) {
+                const frontmatter = outcome.value.frontmatter;
+                if (stringField(frontmatter, "type") === "pickle_attachment") {
+                    const body = outcome.value.body ?? "";
+                    const filename = stringField(frontmatter, "filename") || attachment.filename;
+                    const mediaType = stringField(frontmatter, "content_type") || "text/markdown";
+                    return {
+                        path,
+                        filename,
+                        mediaType,
+                        size: new TextEncoder().encode(body).byteLength,
+                        blob: new Blob([body], { type: mediaType })
+                    };
+                }
+            }
+        }
+        const separator = path.lastIndexOf("/");
+        const folder = separator < 0 ? undefined : path.slice(0, separator);
+        let match = null;
+        for await (const file of this.connect.files.list({
+            ...options,
+            ...(folder ? { folder } : {})
+        })) {
+            if (file.path === path) {
+                match = file;
+                break;
+            }
+        }
+        if (!match)
+            return null;
+        const blob = await this.connect.files.download(match, options);
+        return {
+            path,
+            filename: attachment.filename,
+            mediaType: match.mediaType || blob.type || "application/octet-stream",
+            size: match.size,
+            blob
+        };
+    }
     pendingResponses() {
         return this.connect
             .pendingMutations()
@@ -291,6 +334,9 @@ function validFieldPath(value) {
 function trimSlashes(value) {
     return value.replace(/^\/+|\/+$/g, "");
 }
+function isMarkdownPath(path) {
+    return /\.(?:md|markdown|mdown|mkd|mkdn)$/i.test(path);
+}
 function asObject(value) {
     return value !== null && typeof value === "object" && !Array.isArray(value)
         ? value

package/dist/resources.d.ts

@@ -4,11 +4,12 @@ export declare const PICKLE_REQUEST_CONTRACT_DIGEST = "sha256:5a96bbda301de6ec2f
 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";
+export declare const PICKLE_ATTACHMENT_TYPE_DOCUMENT = "---\nkind: mdbase.type\nname: pickle_attachment\nversion: 1\ndescription: Markdown content attached to 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_id, filename, content_type, size_bytes, sha256]\n    properties:\n      type: { const: pickle_attachment }\n      request_id: { type: string, minLength: 1 }\n      filename: { type: string, minLength: 1 }\n      content_type: { type: string, minLength: 1 }\n      size_bytes: { type: integer, minimum: 0 }\n      sha256: { type: string, pattern: '^sha256:[0-9a-f]{64}$' }\n      created_at: { type: string, format: date-time }\ncollection:\n  display:\n    name_field: filename\n---\n";
 export declare const PICKLE_TYPE_PACK_PROVISION: {
     readonly manifest: {
         readonly kind: "mdbase.type-pack";
         readonly id: "pickle.requests";
-        readonly version: "1.0.0";
+        readonly version: "1.1.0";
         readonly name: "Pickle requests";
         readonly description: "Pickle request and response record types.";
         readonly resources: readonly [{
@@ -35,6 +36,12 @@ export declare const PICKLE_TYPE_PACK_PROVISION: {
             readonly source: "types/pickle_response_ack.md";
             readonly target: "_types/pickle_response_ack.md";
             readonly digest: "sha256:2530c8d21bb711889f20e0d096045cb6c9a7618583b1e2afff7ada72367de41f";
+        }, {
+            readonly kind: "type";
+            readonly mode: "seed";
+            readonly source: "types/pickle_attachment.md";
+            readonly target: "_types/pickle_attachment.md";
+            readonly digest: "sha256:67f14eeee2c126e99d8b37b7508fa148955b924367e2d2941b1793d1c814ec25";
         }];
     };
     readonly resources: readonly [{
@@ -49,6 +56,9 @@ export declare const PICKLE_TYPE_PACK_PROVISION: {
     }, {
         readonly source: "types/pickle_response_ack.md";
         readonly 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";
+    }, {
+        readonly source: "types/pickle_attachment.md";
+        readonly document: "---\nkind: mdbase.type\nname: pickle_attachment\nversion: 1\ndescription: Markdown content attached to 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_id, filename, content_type, size_bytes, sha256]\n    properties:\n      type: { const: pickle_attachment }\n      request_id: { type: string, minLength: 1 }\n      filename: { type: string, minLength: 1 }\n      content_type: { type: string, minLength: 1 }\n      size_bytes: { type: integer, minimum: 0 }\n      sha256: { type: string, pattern: '^sha256:[0-9a-f]{64}$' }\n      created_at: { type: string, format: date-time }\ncollection:\n  display:\n    name_field: filename\n---\n";
     }];
     readonly provides: readonly [{
         readonly id: "pickle.request";

package/dist/resources.js

@@ -204,11 +204,36 @@ lifecycle:
       responded_at: { now: true }
 ---
 `;
+export const PICKLE_ATTACHMENT_TYPE_DOCUMENT = `---
+kind: mdbase.type
+name: pickle_attachment
+version: 1
+description: Markdown content attached to a Pickle request.
+schema:
+  dialect: json-schema-2020-12
+  value:
+    $schema: "https://json-schema.org/draft/2020-12/schema"
+    type: object
+    additionalProperties: true
+    required: [request_id, filename, content_type, size_bytes, sha256]
+    properties:
+      type: { const: pickle_attachment }
+      request_id: { type: string, minLength: 1 }
+      filename: { type: string, minLength: 1 }
+      content_type: { type: string, minLength: 1 }
+      size_bytes: { type: integer, minimum: 0 }
+      sha256: { type: string, pattern: '^sha256:[0-9a-f]{64}$' }
+      created_at: { type: string, format: date-time }
+collection:
+  display:
+    name_field: filename
+---
+`;
 export const PICKLE_TYPE_PACK_PROVISION = {
     manifest: {
         kind: "mdbase.type-pack",
         id: "pickle.requests",
-        version: "1.0.0",
+        version: "1.1.0",
         name: "Pickle requests",
         description: "Pickle request and response record types.",
         resources: [
@@ -239,6 +264,13 @@ export const PICKLE_TYPE_PACK_PROVISION = {
                 source: "types/pickle_response_ack.md",
                 target: "_types/pickle_response_ack.md",
                 digest: "sha256:2530c8d21bb711889f20e0d096045cb6c9a7618583b1e2afff7ada72367de41f"
+            },
+            {
+                kind: "type",
+                mode: "seed",
+                source: "types/pickle_attachment.md",
+                target: "_types/pickle_attachment.md",
+                digest: "sha256:67f14eeee2c126e99d8b37b7508fa148955b924367e2d2941b1793d1c814ec25"
             }
         ]
     },
@@ -258,6 +290,10 @@ export const PICKLE_TYPE_PACK_PROVISION = {
         {
             source: "types/pickle_response_ack.md",
             document: PICKLE_ACK_RESPONSE_TYPE_DOCUMENT
+        },
+        {
+            source: "types/pickle_attachment.md",
+            document: PICKLE_ATTACHMENT_TYPE_DOCUMENT
         }
     ],
     provides: [{

package/package.json

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