@krischoichoi/channel-files 0.6.0

package/lib/migration/verify.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Compare the SHA-256 of the given bytes against the expected digest.
+ * Returns `false` on any mismatch (also when the digest format differs).
+ */
+export declare function verifyFileIntegrity(data: Uint8Array, expectedSha256: string): boolean;
+export interface ReadBackVerifiedOptions {
+    /** Read the (native) bytes back for verification. */
+    readBack: () => Promise<Uint8Array>;
+    /** Expected SHA-256; verification fails on mismatch. */
+    expectedSha256: string;
+    /** Expected byte length; a length mismatch also fails verification. */
+    expectedBytes?: number;
+}
+/**
+ * Read the copied bytes back and verify them: any read-back failure, byte
+ * length mismatch (when `expectedBytes` is given) or hash mismatch returns
+ * `false` — the migration must then stay legacy-authoritative.
+ */
+export declare function readBackVerified(options: ReadBackVerifiedOptions): Promise<boolean>;
+//# sourceMappingURL=verify.d.ts.map

package/lib/migration/verify.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"verify.d.ts","sourceRoot":"","sources":["../../src/migration/verify.ts"],"names":[],"mappings":"AAUA;;;GAGG;AACH,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,UAAU,EAChB,cAAc,EAAE,MAAM,GACrB,OAAO,CAET;AAED,MAAM,WAAW,uBAAuB;IACtC,qDAAqD;IACrD,QAAQ,EAAE,MAAM,OAAO,CAAC,UAAU,CAAC,CAAC;IACpC,wDAAwD;IACxD,cAAc,EAAE,MAAM,CAAC;IACvB,uEAAuE;IACvE,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;GAIG;AACH,wBAAsB,gBAAgB,CACpC,OAAO,EAAE,uBAAuB,GAC/B,OAAO,CAAC,OAAO,CAAC,CAWlB"}

package/lib/migration/verify.js

@@ -0,0 +1,35 @@
+/**
+ * Migration integrity verification.
+ *
+ * Lazy migration is COPY + VERIFY, never move: after the legacy bytes are
+ * copied into the native backend we read them back and compare the recomputed
+ * SHA-256 (and byte length) against the legacy record. Any mismatch means the
+ * native copy is NOT trusted and the legacy backend stays authoritative.
+ */
+import { sha256Hex } from '../attachments/hash.js';
+/**
+ * Compare the SHA-256 of the given bytes against the expected digest.
+ * Returns `false` on any mismatch (also when the digest format differs).
+ */
+export function verifyFileIntegrity(data, expectedSha256) {
+    return sha256Hex(data) === expectedSha256;
+}
+/**
+ * Read the copied bytes back and verify them: any read-back failure, byte
+ * length mismatch (when `expectedBytes` is given) or hash mismatch returns
+ * `false` — the migration must then stay legacy-authoritative.
+ */
+export async function readBackVerified(options) {
+    let data;
+    try {
+        data = await options.readBack();
+    }
+    catch {
+        return false;
+    }
+    if (options.expectedBytes !== undefined && data.byteLength !== options.expectedBytes) {
+        return false;
+    }
+    return verifyFileIntegrity(data, options.expectedSha256);
+}
+//# sourceMappingURL=verify.js.map

package/lib/migration/verify.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"verify.js","sourceRoot":"","sources":["../../src/migration/verify.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAEnD;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CACjC,IAAgB,EAChB,cAAsB;IAEtB,OAAO,SAAS,CAAC,IAAI,CAAC,KAAK,cAAc,CAAC;AAC5C,CAAC;AAWD;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,OAAgC;IAEhC,IAAI,IAAgB,CAAC;IACrB,IAAI,CAAC;QACH,IAAI,GAAG,MAAM,OAAO,CAAC,QAAQ,EAAE,CAAC;IAClC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS,IAAI,IAAI,CAAC,UAAU,KAAK,OAAO,CAAC,aAAa,EAAE,CAAC;QACrF,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,mBAAmB,CAAC,IAAI,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;AAC3D,CAAC"}

package/lib/paths.d.ts

@@ -0,0 +1,13 @@
+/**
+ * One on-disk directory segment for an attachment id.
+ *
+ * Raw harness attachment ids may carry characters that are illegal in
+ * Windows path segments (the content-addressed `sha256:...` form, issue #7).
+ * Only the unsafe set is encoded deterministically - legacy `att-*` ids and
+ * every plain id map to themselves, so existing stores keep their on-disk
+ * layout. Must stay in sync with every path this store derives from an id.
+ */
+export declare function assetPathSegment(attachmentId: string): string;
+export declare function resolveAttachmentsRoot(): string;
+export declare function resolveAssetDirectory(attachmentId: string, sessionId: string, messageId: string): string;
+//# sourceMappingURL=paths.d.ts.map

package/lib/paths.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"paths.d.ts","sourceRoot":"","sources":["../src/paths.ts"],"names":[],"mappings":"AAGA;;;;;;;;GAQG;AACH,wBAAgB,gBAAgB,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAI7D;AAED,wBAAgB,sBAAsB,IAAI,MAAM,CAE/C;AAED,wBAAgB,qBAAqB,CACnC,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,GAChB,MAAM,CAER"}

package/lib/paths.js

@@ -0,0 +1,23 @@
+import { join } from 'node:path';
+import { resolveChannelDataDirectory } from '@krischoichoi/channel-core';
+/**
+ * One on-disk directory segment for an attachment id.
+ *
+ * Raw harness attachment ids may carry characters that are illegal in
+ * Windows path segments (the content-addressed `sha256:...` form, issue #7).
+ * Only the unsafe set is encoded deterministically - legacy `att-*` ids and
+ * every plain id map to themselves, so existing stores keep their on-disk
+ * layout. Must stay in sync with every path this store derives from an id.
+ */
+export function assetPathSegment(attachmentId) {
+    return attachmentId.replace(/[<>:"/\|?*\u0000-\u001f]/g, (char) => {
+        return '_' + char.charCodeAt(0).toString(16).padStart(2, '0') + '_';
+    });
+}
+export function resolveAttachmentsRoot() {
+    return join(resolveChannelDataDirectory(), 'attachments', 'v1');
+}
+export function resolveAssetDirectory(attachmentId, sessionId, messageId) {
+    return join(resolveAttachmentsRoot(), 'sessions', sessionId, messageId, assetPathSegment(attachmentId));
+}
+//# sourceMappingURL=paths.js.map

package/lib/paths.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"paths.js","sourceRoot":"","sources":["../src/paths.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,2BAA2B,EAAE,MAAM,4BAA4B,CAAC;AAEzE;;;;;;;;GAQG;AACH,MAAM,UAAU,gBAAgB,CAAC,YAAoB;IACnD,OAAO,YAAY,CAAC,OAAO,CAAC,2BAA2B,EAAE,CAAC,IAAI,EAAE,EAAE;QAChE,OAAO,GAAG,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,GAAG,CAAC;IACtE,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,sBAAsB;IACpC,OAAO,IAAI,CAAC,2BAA2B,EAAE,EAAE,aAAa,EAAE,IAAI,CAAC,CAAC;AAClE,CAAC;AAED,MAAM,UAAU,qBAAqB,CACnC,YAAoB,EACpB,SAAiB,EACjB,SAAiB;IAEjB,OAAO,IAAI,CAAC,sBAAsB,EAAE,EAAE,UAAU,EAAE,SAAS,EAAE,SAAS,EAAE,gBAAgB,CAAC,YAAY,CAAC,CAAC,CAAC;AAC1G,CAAC"}

package/lib/plugin.d.ts

@@ -0,0 +1,4 @@
+import type { Context } from '@deepseek-ai/cordis';
+export declare const name = "channel-files";
+export declare function apply(ctx: Context): void;
+//# sourceMappingURL=plugin.d.ts.map

package/lib/plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAGnD,eAAO,MAAM,IAAI,kBAAkB,CAAC;AAEpC,wBAAgB,KAAK,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI,CAExC"}

package/lib/plugin.js

@@ -0,0 +1,6 @@
+import { ChannelFileService } from './service.js';
+export const name = 'channel-files';
+export function apply(ctx) {
+    new ChannelFileService(ctx);
+}
+//# sourceMappingURL=plugin.js.map

package/lib/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAElD,MAAM,CAAC,MAAM,IAAI,GAAG,eAAe,CAAC;AAEpC,MAAM,UAAU,KAAK,CAAC,GAAY;IAChC,IAAI,kBAAkB,CAAC,GAAG,CAAC,CAAC;AAC9B,CAAC"}

package/lib/service.d.ts

@@ -0,0 +1,27 @@
+import { Service, type Context } from '@deepseek-ai/cordis';
+import type { ChannelAttachmentContext, ChannelAttachmentDescriptor, ChannelAttachmentProvider, ChannelImageStoreInput, ResolvedChannelAttachment, StoredBinaryPart } from '@krischoichoi/channel-harness';
+import { FileChannelInboundAssetStore } from './attachments/store.js';
+declare module '@deepseek-ai/cordis' {
+    interface Context {
+        channelFiles: ChannelFileService;
+    }
+}
+export declare class ChannelFileService extends Service implements ChannelAttachmentProvider {
+    readonly storeBackend: FileChannelInboundAssetStore;
+    private readonly extractor;
+    constructor(ctx: Context);
+    store(context: ChannelAttachmentContext, part: StoredBinaryPart): Promise<import("./index.js").StoredAssetDescriptor | undefined>;
+    /**
+     * Mirror one inbound image into the private asset store under the HARNESS
+     * attachmentId (the model-visible `sha256:…` ref id) so the outbox can
+     * resolve it for outbound sends (issue #7). The harness image seam stays
+     * authoritative; images are content assets with no text extraction, so the
+     * stored asset is born `readable: false` / `not-needed`.
+     */
+    storeImage(context: ChannelAttachmentContext, image: ChannelImageStoreInput): Promise<ChannelAttachmentDescriptor | undefined>;
+    installCompatibilityTools(agentContext: Context): Promise<void>;
+    /** @deprecated use installCompatibilityTools. */
+    installTools(agentContext: Context): Promise<void>;
+    resolveAttachment(attachmentId: string, sessionId: string): Promise<ResolvedChannelAttachment>;
+}
+//# sourceMappingURL=service.d.ts.map

package/lib/service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC5D,OAAO,KAAK,EACV,wBAAwB,EACxB,2BAA2B,EAC3B,yBAAyB,EACzB,sBAAsB,EACtB,yBAAyB,EACzB,gBAAgB,EACjB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,4BAA4B,EAAE,MAAM,wBAAwB,CAAC;AAQtE,OAAO,QAAQ,qBAAqB,CAAC;IACnC,UAAU,OAAO;QACf,YAAY,EAAE,kBAAkB,CAAC;KAClC;CACF;AAED,qBAAa,kBAAmB,SAAQ,OAAQ,YAAW,yBAAyB;IAClF,QAAQ,CAAC,YAAY,EAAE,4BAA4B,CAAC;IACpD,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAwD;gBAEtE,GAAG,EAAE,OAAO;IAKxB,KAAK,CAAC,OAAO,EAAE,wBAAwB,EAAE,IAAI,EAAE,gBAAgB;IAM/D;;;;;;OAMG;IACG,UAAU,CACd,OAAO,EAAE,wBAAwB,EACjC,KAAK,EAAE,sBAAsB,GAC5B,OAAO,CAAC,2BAA2B,GAAG,SAAS,CAAC;IAyBnD,yBAAyB,CAAC,YAAY,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAM/D,iDAAiD;IACjD,YAAY,CAAC,YAAY,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAIlD,iBAAiB,CACf,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,yBAAyB,CAAC;CAKtC"}

package/lib/service.js

@@ -0,0 +1,67 @@
+import { Service } from '@deepseek-ai/cordis';
+import { FileChannelInboundAssetStore } from './attachments/store.js';
+import { DEFAULT_ATTACHMENT_POLICY } from './attachments/policy.js';
+import { createAttachmentExtractor } from './attachments/pipeline-extractor.js';
+import { storeBinaryPart } from './attachments/pipeline.js';
+import { installReadChannelAttachmentTool } from './attachments/tool-read.js';
+import { resolveAttachment } from './attachment-resolver.js';
+import { sanitizeFilename } from './attachments/filename.js';
+export class ChannelFileService extends Service {
+    storeBackend;
+    extractor = createAttachmentExtractor(DEFAULT_ATTACHMENT_POLICY);
+    constructor(ctx) {
+        super(ctx, 'channelFiles');
+        this.storeBackend = new FileChannelInboundAssetStore();
+    }
+    store(context, part) {
+        return storeBinaryPart(this.storeBackend, context, part, {
+            extractor: this.extractor,
+        });
+    }
+    /**
+     * Mirror one inbound image into the private asset store under the HARNESS
+     * attachmentId (the model-visible `sha256:…` ref id) so the outbox can
+     * resolve it for outbound sends (issue #7). The harness image seam stays
+     * authoritative; images are content assets with no text extraction, so the
+     * stored asset is born `readable: false` / `not-needed`.
+     */
+    async storeImage(context, image) {
+        const asset = await this.storeBackend.put({
+            attachmentId: image.attachmentId,
+            sessionId: context.sessionId,
+            channelId: context.channelId,
+            accountId: context.accountId,
+            conversationId: context.conversationId,
+            ...(context.conversationType ? { conversationType: context.conversationType } : {}),
+            ...(context.threadId ? { threadId: context.threadId } : {}),
+            messageId: context.messageId,
+            kind: 'image',
+            name: sanitizeFilename(image.name ?? 'image'),
+            ...(image.mimeType ? { mimeType: image.mimeType } : {}),
+            data: image.data,
+        });
+        return {
+            attachmentId: asset.attachmentId,
+            name: asset.name,
+            mimeType: asset.mimeType,
+            bytes: asset.bytes,
+            durable: true,
+            readable: false,
+        };
+    }
+    installCompatibilityTools(agentContext) {
+        return installReadChannelAttachmentTool(agentContext, {
+            store: this.storeBackend,
+        });
+    }
+    /** @deprecated use installCompatibilityTools. */
+    installTools(agentContext) {
+        return this.installCompatibilityTools(agentContext);
+    }
+    resolveAttachment(attachmentId, sessionId) {
+        return resolveAttachment(attachmentId, sessionId, this.storeBackend, {
+            policy: DEFAULT_ATTACHMENT_POLICY,
+        });
+    }
+}
+//# sourceMappingURL=service.js.map

package/lib/service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"service.js","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAgB,MAAM,qBAAqB,CAAC;AAS5D,OAAO,EAAE,4BAA4B,EAAE,MAAM,wBAAwB,CAAC;AACtE,OAAO,EAAE,yBAAyB,EAAE,MAAM,yBAAyB,CAAC;AACpE,OAAO,EAAE,yBAAyB,EAAE,MAAM,qCAAqC,CAAC;AAChF,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAE,gCAAgC,EAAE,MAAM,4BAA4B,CAAC;AAC9E,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAQ7D,MAAM,OAAO,kBAAmB,SAAQ,OAAO;IACpC,YAAY,CAA+B;IACnC,SAAS,GAAG,yBAAyB,CAAC,yBAAyB,CAAC,CAAC;IAElF,YAAY,GAAY;QACtB,KAAK,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;QAC3B,IAAI,CAAC,YAAY,GAAG,IAAI,4BAA4B,EAAE,CAAC;IACzD,CAAC;IAED,KAAK,CAAC,OAAiC,EAAE,IAAsB;QAC7D,OAAO,eAAe,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,EAAE,IAAI,EAAE;YACvD,SAAS,EAAE,IAAI,CAAC,SAAS;SAC1B,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,UAAU,CACd,OAAiC,EACjC,KAA6B;QAE7B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC;YACxC,YAAY,EAAE,KAAK,CAAC,YAAY;YAChC,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,cAAc,EAAE,OAAO,CAAC,cAAc;YACtC,GAAG,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,EAAE,gBAAgB,EAAE,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACnF,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC3D,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,IAAI,EAAE,OAAO;YACb,IAAI,EAAE,gBAAgB,CAAC,KAAK,CAAC,IAAI,IAAI,OAAO,CAAC;YAC7C,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACvD,IAAI,EAAE,KAAK,CAAC,IAAI;SACjB,CAAC,CAAC;QACH,OAAO;YACL,YAAY,EAAE,KAAK,CAAC,YAAY;YAChC,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,QAAQ,EAAE,KAAK,CAAC,QAAQ;YACxB,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,KAAK;SAChB,CAAC;IACJ,CAAC;IAED,yBAAyB,CAAC,YAAqB;QAC7C,OAAO,gCAAgC,CAAC,YAAY,EAAE;YACpD,KAAK,EAAE,IAAI,CAAC,YAAY;SACzB,CAAC,CAAC;IACL,CAAC;IAED,iDAAiD;IACjD,YAAY,CAAC,YAAqB;QAChC,OAAO,IAAI,CAAC,yBAAyB,CAAC,YAAY,CAAC,CAAC;IACtD,CAAC;IAED,iBAAiB,CACf,YAAoB,EACpB,SAAiB;QAEjB,OAAO,iBAAiB,CAAC,YAAY,EAAE,SAAS,EAAE,IAAI,CAAC,YAAY,EAAE;YACnE,MAAM,EAAE,yBAAyB;SAClC,CAAC,CAAC;IACL,CAAC;CACF"}

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@krischoichoi/channel-files",
+  "version": "0.6.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/krischoichoi/dsh-channels.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "Optional generic file storage and document extraction for dsh-channels",
+  "type": "module",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "default": "./lib/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "lib"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "test": "vitest run",
+    "clean": "rimraf lib"
+  },
+  "dependencies": {
+    "@deepseek-ai/cordis": "^4.0.4",
+    "@deepseek-ai/dsh-atomic-write": "0.2.0-rc.2",
+    "@deepseek-ai/dsh-home-paths": "0.2.0-rc.2",
+    "@deepseek-ai/dsh-llm": "0.2.0-rc.2",
+    "@krischoichoi/channel-core": "workspace:*",
+    "@krischoichoi/channel-harness": "workspace:*",
+    "mammoth": "1.12.1",
+    "unpdf": "1.8.1",
+    "xlsx": "0.18.5",
+    "zod": "^4.4.3"
+  },
+  "devDependencies": {
+    "@deepseek-ai/dsh-session-projection": "0.2.0-rc.2",
+    "@deepseek-ai/dsh-timeout": "0.2.0-rc.2",
+    "@deepseek-ai/dsh-tools": "0.2.0-rc.2",
+    "@deepseek-ai/dsh-user-approval": "0.2.0-rc.2",
+    "rimraf": "^6.0.0"
+  },
+  "peerDependencies": {
+    "@deepseek-ai/dsh-tools": "0.2.0-rc.2"
+  },
+  "peerDependenciesMeta": {
+    "@deepseek-ai/dsh-tools": {
+      "optional": true
+    }
+  },
+  "license": "MIT"
+}