@remit/storage-service 0.0.14 → 0.0.16

package/dist/backends/filesystem.js

@@ -168,8 +168,10 @@ export const createFilesystemStorageService = (basePath, uploadUrls) => {
         };
     };
     const deleteOutboxAttachments = async (accountConfigId, accountId, outboxMessageId) => {
-        const dirPath = join(basePath, buildOutboxAttachmentPrefix(accountConfigId, accountId, outboxMessageId));
-        await rm(dirPath, { recursive: true, force: true });
+        await deletePrefix(buildOutboxAttachmentPrefix(accountConfigId, accountId, outboxMessageId));
+    };
+    const deletePrefix = async (prefix) => {
+        await rm(join(basePath, prefix), { recursive: true, force: true });
     };
     const storeDeduplicated = (params) => {
         const { accountConfigId, accountId, content } = params;
@@ -242,6 +244,7 @@ export const createFilesystemStorageService = (basePath, uploadUrls) => {
         listOutboxAttachments,
         listOutboxDraftsWithAttachments,
         deleteOutboxAttachments,
+        deletePrefix,
         deleteOutboxAttachment,
         statOutboxAttachment,
         retrieveOutboxAttachment,
@@ -289,6 +292,9 @@ export const createFilesystemStorageService = (basePath, uploadUrls) => {
             await pipeline(body, createWriteStream(fullPath));
             return key;
         },
+        deleteExportArchive: (accountConfigId, exportRequestId) => rm(join(basePath, buildExportArchiveKey(accountConfigId, exportRequestId)), {
+            force: true,
+        }),
         getPresignedDownloadUrl: (_key, _expiresInSeconds) => {
             throw new Error("getPresignedDownloadUrl is not supported on the filesystem backend");
         },

package/dist/backends/s3.js

@@ -194,8 +194,7 @@ export const createS3StorageService = (client, bucketName) => {
         }), { expiresIn });
         return { uploadUrl };
     };
-    const deleteOutboxAttachments = async (accountConfigId, accountId, outboxMessageId) => {
-        const prefix = buildOutboxAttachmentPrefix(accountConfigId, accountId, outboxMessageId);
+    const deletePrefix = async (prefix) => {
         let continuationToken;
         do {
             const response = await client.send(new ListObjectsV2Command({
@@ -217,6 +216,7 @@ export const createS3StorageService = (client, bucketName) => {
                 : undefined;
         } while (continuationToken);
     };
+    const deleteOutboxAttachments = (accountConfigId, accountId, outboxMessageId) => deletePrefix(buildOutboxAttachmentPrefix(accountConfigId, accountId, outboxMessageId));
     const storeDeduplicated = (params) => {
         const { accountConfigId, accountId, content, contentType } = params;
         const checksumSha256 = computeChecksum(content);
@@ -342,6 +342,12 @@ export const createS3StorageService = (client, bucketName) => {
         });
         return key;
     };
+    const deleteExportArchive = async (accountConfigId, exportRequestId) => {
+        await client.send(new DeleteObjectCommand({
+            Bucket: bucketName,
+            Key: buildExportArchiveKey(accountConfigId, exportRequestId),
+        }));
+    };
     const getPresignedDownloadUrl = (key, expiresInSeconds) => getSignedUrl(client, new GetObjectCommand({ Bucket: bucketName, Key: key }), { expiresIn: expiresInSeconds });
     return {
         storeMessageBody,
@@ -352,6 +358,7 @@ export const createS3StorageService = (client, bucketName) => {
         listOutboxAttachments,
         listOutboxDraftsWithAttachments,
         deleteOutboxAttachments,
+        deletePrefix,
         deleteOutboxAttachment,
         statOutboxAttachment,
         retrieveOutboxAttachment,
@@ -365,6 +372,7 @@ export const createS3StorageService = (client, bucketName) => {
         exists,
         delete: del,
         storeExportArchiveStream,
+        deleteExportArchive,
         getPresignedDownloadUrl,
     };
 };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export { type OutboxSweepResult, sweepAbandonedOutboxAttachments, } from "./outbox-sweep.js";
 export { type AuthorizeUploadInput, type AuthorizeUploadResult, authorizeUploadRequest, UPLOAD_ROUTE_PREFIX, UPLOAD_URL_SIGNING_LABEL, UPLOAD_URL_TTL_SECONDS, } from "./outbox-upload-url.js";
 export { type SignedPathFailure, type SignedPathResult, signStoragePath, verifyStoragePath, } from "./signed-path.js";
-export { buildBodyPartKey, buildDeduplicatedKey, buildExportArchiveKey, buildMessageBodyKey, buildOutboxAttachmentKey, buildOutboxAttachmentPrefix, buildParsedBodyKey, type ContentEncodingValue, type CreateOutboxAttachmentUploadUrlParams, computeChecksum, createMockStorageService, isStorageNotFoundError, type OutboxAttachmentListItem, type OutboxAttachmentUploadTarget, type ParsedAttachmentMeta, type ParsedBody, type ParsedContentStorageKey, type ParsedOutboxAttachmentKey, parseContentStorageKey, parseOutboxAttachmentKey, type StorageReference, type StorageService, type StorageTypeValue, type StoreBodyPartParams, type StoreDeduplicatedParams, type StoreMessageBodyParams, type StoreOutboxAttachmentParams, type StoreParsedBodyParams, } from "./storage.js";
+export { buildBodyPartKey, buildDeduplicatedKey, buildExportArchiveKey, buildMessageBodyKey, buildOutboxAttachmentKey, buildOutboxAttachmentPrefix, buildParsedBodyKey, type ContentEncodingValue, type CreateOutboxAttachmentUploadUrlParams, computeChecksum, createMockStorageService, isStorageNotFoundError, messageObjectPrefixOf, type OutboxAttachmentListItem, type OutboxAttachmentUploadTarget, type ParsedAttachmentMeta, type ParsedBody, type ParsedContentStorageKey, type ParsedOutboxAttachmentKey, parseContentStorageKey, parseOutboxAttachmentKey, type StorageReference, type StorageService, type StorageTypeValue, type StoreBodyPartParams, type StoreDeduplicatedParams, type StoreMessageBodyParams, type StoreOutboxAttachmentParams, type StoreParsedBodyParams, } from "./storage.js";
 export { buildStorageUri, type ParsedStorageUri, parseStorageUri, } from "./uri.js";

package/dist/index.js

@@ -1,5 +1,5 @@
 export { sweepAbandonedOutboxAttachments, } from "./outbox-sweep.js";
 export { authorizeUploadRequest, UPLOAD_ROUTE_PREFIX, UPLOAD_URL_SIGNING_LABEL, UPLOAD_URL_TTL_SECONDS, } from "./outbox-upload-url.js";
 export { signStoragePath, verifyStoragePath, } from "./signed-path.js";
-export { buildBodyPartKey, buildDeduplicatedKey, buildExportArchiveKey, buildMessageBodyKey, buildOutboxAttachmentKey, buildOutboxAttachmentPrefix, buildParsedBodyKey, computeChecksum, createMockStorageService, isStorageNotFoundError, parseContentStorageKey, parseOutboxAttachmentKey, } from "./storage.js";
+export { buildBodyPartKey, buildDeduplicatedKey, buildExportArchiveKey, buildMessageBodyKey, buildOutboxAttachmentKey, buildOutboxAttachmentPrefix, buildParsedBodyKey, computeChecksum, createMockStorageService, isStorageNotFoundError, messageObjectPrefixOf, parseContentStorageKey, parseOutboxAttachmentKey, } from "./storage.js";
 export { buildStorageUri, parseStorageUri, } from "./uri.js";

package/dist/storage.d.ts

@@ -190,6 +190,11 @@ export interface StorageService {
     exists(uri: string): Promise<boolean>;
     /** Delete content by URI */
     delete(uri: string): Promise<void>;
+    /**
+     * Delete every object whose key starts with `keyPrefix`, a key path ending
+     * in `/`. Deleting a prefix that holds nothing is a no-op.
+     */
+    deletePrefix(keyPrefix: string): Promise<void>;
     /**
      * Stream a finished export archive (already-compressed ZIP) to the export
      * key for the given config + request, uncompressed at rest. The body is
@@ -197,6 +202,11 @@ export interface StorageService {
      * storage key, which `getPresignedDownloadUrl` can then sign.
      */
     storeExportArchiveStream(accountConfigId: string, exportRequestId: string, body: Readable): Promise<string>;
+    /**
+     * Delete the export archive of the given config + request. Deleting a
+     * missing archive is a no-op.
+     */
+    deleteExportArchive(accountConfigId: string, exportRequestId: string): Promise<void>;
     /**
      * Generate a presigned URL that grants temporary GET access to a raw S3 key.
      * Use for export archives — the key must already exist in the bucket.
@@ -235,6 +245,7 @@ export interface ParsedContentStorageKey {
  * above). Returns null when the shape doesn't match.
  */
 export declare const parseContentStorageKey: (storageKey: string) => ParsedContentStorageKey | null;
+export declare const messageObjectPrefixOf: (bodyStorageUri: string) => string;
 export declare const computeChecksum: (content: Buffer) => string;
 export declare const buildExportArchiveKey: (accountConfigId: string, exportRequestId: string) => string;
 export declare const isStorageNotFoundError: (error: unknown) => boolean;

package/dist/storage.js

@@ -1,6 +1,7 @@
 import { createHash } from "node:crypto";
 import { Readable } from "node:stream";
 import { ContentEncoding, StorageType } from "@remit/domain-enums";
+import { parseStorageUri } from "./uri.js";
 // Path builders - centralized path formatting per RFC 011 + #224.
 // The outer segment is `accountConfigId` (Cognito-derived tenant scope) so
 // the edge can verify cross-tenant isolation at the URL prefix without
@@ -51,6 +52,14 @@ export const parseContentStorageKey = (storageKey) => {
         messageId: match[3],
     };
 };
+const MESSAGE_OBJECT_PREFIX = /(?:^|\/)(accounts\/[^/]+\/(?:[^/]+\/)?messages\/[^/]+\/)[^/]+$/;
+export const messageObjectPrefixOf = (bodyStorageUri) => {
+    const match = parseStorageUri(bodyStorageUri).storageKey.match(MESSAGE_OBJECT_PREFIX);
+    if (!match) {
+        throw new Error(`${bodyStorageUri} is not a message body key; its objects cannot be found to delete`);
+    }
+    return match[1];
+};
 export const computeChecksum = (content) => createHash("sha256").update(content).digest("hex");
 export const buildExportArchiveKey = (accountConfigId, exportRequestId) => `exports/${accountConfigId}/${exportRequestId}/export.zip`;
 export const isStorageNotFoundError = (error) => {
@@ -65,15 +74,16 @@ export const isStorageNotFoundError = (error) => {
         return true;
     return false;
 };
+const MOCK_ROOT = "s3://mock/";
 export const createMockStorageService = () => {
     const storage = new Map();
     const storeInternal = (key, content) => {
         const checksumSha256 = computeChecksum(content);
-        const uri = `mock://${key}`;
+        const uri = `${MOCK_ROOT}${key}`;
         storage.set(uri, content);
         return {
             uri,
-            storageType: StorageType.Filesystem,
+            storageType: StorageType.S3,
             storageLocation: "mock",
             storageKey: key,
             sizeBytes: content.length,
@@ -94,21 +104,21 @@ export const createMockStorageService = () => {
         return storeInternal(buildOutboxAttachmentKey(accountConfigId, accountId, outboxMessageId, outboxAttachmentId), content);
     };
     const listOutboxAttachments = async (accountConfigId, accountId, outboxMessageId) => {
-        const prefix = `mock://${buildOutboxAttachmentPrefix(accountConfigId, accountId, outboxMessageId)}`;
+        const prefix = `${MOCK_ROOT}${buildOutboxAttachmentPrefix(accountConfigId, accountId, outboxMessageId)}`;
         const items = [];
         for (const [uri, content] of storage.entries()) {
             if (!uri.startsWith(prefix))
                 continue;
             items.push({
                 outboxAttachmentId: uri.slice(prefix.length),
-                key: uri.slice("mock://".length),
+                key: uri.slice(MOCK_ROOT.length),
                 sizeBytes: content.length,
             });
         }
         return items;
     };
     const listOutboxDraftsWithAttachments = async (accountConfigId, accountId) => {
-        const root = `mock://accounts/${accountConfigId}/${accountId}/outbox/`;
+        const root = `${MOCK_ROOT}accounts/${accountConfigId}/${accountId}/outbox/`;
         const drafts = new Set();
         for (const uri of storage.keys()) {
             if (!uri.startsWith(root))
@@ -121,23 +131,23 @@ export const createMockStorageService = () => {
         return [...drafts];
     };
     const deleteOutboxAttachment = async (accountConfigId, accountId, outboxMessageId, outboxAttachmentId) => {
-        storage.delete(`mock://${buildOutboxAttachmentKey(accountConfigId, accountId, outboxMessageId, outboxAttachmentId)}`);
+        storage.delete(`${MOCK_ROOT}${buildOutboxAttachmentKey(accountConfigId, accountId, outboxMessageId, outboxAttachmentId)}`);
     };
     const statOutboxAttachment = async (accountConfigId, accountId, outboxMessageId, outboxAttachmentId) => {
-        const content = storage.get(`mock://${buildOutboxAttachmentKey(accountConfigId, accountId, outboxMessageId, outboxAttachmentId)}`);
+        const content = storage.get(`${MOCK_ROOT}${buildOutboxAttachmentKey(accountConfigId, accountId, outboxMessageId, outboxAttachmentId)}`);
         return content ? { sizeBytes: content.length } : null;
     };
-    const retrieveOutboxAttachment = async (accountConfigId, accountId, outboxMessageId, outboxAttachmentId) => storage.get(`mock://${buildOutboxAttachmentKey(accountConfigId, accountId, outboxMessageId, outboxAttachmentId)}`) ?? null;
+    const retrieveOutboxAttachment = async (accountConfigId, accountId, outboxMessageId, outboxAttachmentId) => storage.get(`${MOCK_ROOT}${buildOutboxAttachmentKey(accountConfigId, accountId, outboxMessageId, outboxAttachmentId)}`) ?? null;
     const createOutboxAttachmentUploadUrl = async (params) => ({
         uploadUrl: `mock://upload/${buildOutboxAttachmentKey(params.accountConfigId, params.accountId, params.outboxMessageId, params.outboxAttachmentId)}?max=${params.sizeBytes}&exp=${params.expiresAt}`,
     });
-    const deleteOutboxAttachments = async (accountConfigId, accountId, outboxMessageId) => {
-        const prefix = `mock://${buildOutboxAttachmentPrefix(accountConfigId, accountId, outboxMessageId)}`;
+    const deletePrefix = async (keyPrefix) => {
         for (const uri of [...storage.keys()]) {
-            if (uri.startsWith(prefix))
+            if (uri.startsWith(`${MOCK_ROOT}${keyPrefix}`))
                 storage.delete(uri);
         }
     };
+    const deleteOutboxAttachments = (accountConfigId, accountId, outboxMessageId) => deletePrefix(buildOutboxAttachmentPrefix(accountConfigId, accountId, outboxMessageId));
     const storeDeduplicated = async (params) => {
         const { accountConfigId, accountId, content } = params;
         const checksumSha256 = computeChecksum(content);
@@ -149,29 +159,29 @@ export const createMockStorageService = () => {
         return storeInternal(buildParsedBodyKey(accountConfigId, accountId, messageId), content);
     };
     const retrieveParsedBody = async (accountConfigId, accountId, messageId) => {
-        const uri = `mock://${buildParsedBodyKey(accountConfigId, accountId, messageId)}`;
+        const uri = `${MOCK_ROOT}${buildParsedBodyKey(accountConfigId, accountId, messageId)}`;
         const content = storage.get(uri);
         if (!content)
             return null;
         return JSON.parse(content.toString("utf8"));
     };
     const retrieveBodyPart = async (accountConfigId, accountId, messageId, partPath) => {
-        const uri = `mock://${buildBodyPartKey(accountConfigId, accountId, messageId, partPath)}`;
+        const uri = `${MOCK_ROOT}${buildBodyPartKey(accountConfigId, accountId, messageId, partPath)}`;
         return storage.get(uri) ?? null;
     };
     const retrieveMessageBody = async (accountConfigId, accountId, messageId) => {
-        const uri = `mock://${buildMessageBodyKey(accountConfigId, accountId, messageId)}`;
+        const uri = `${MOCK_ROOT}${buildMessageBodyKey(accountConfigId, accountId, messageId)}`;
         return storage.get(uri) ?? null;
     };
     const retrieveMessageBodyStream = async (accountConfigId, accountId, messageId) => {
-        const uri = `mock://${buildMessageBodyKey(accountConfigId, accountId, messageId)}`;
+        const uri = `${MOCK_ROOT}${buildMessageBodyKey(accountConfigId, accountId, messageId)}`;
         const content = storage.get(uri);
         if (!content)
             return null;
         return Readable.from(content);
     };
     const bodyPartExists = async (accountConfigId, accountId, messageId, partPath) => {
-        const uri = `mock://${buildBodyPartKey(accountConfigId, accountId, messageId, partPath)}`;
+        const uri = `${MOCK_ROOT}${buildBodyPartKey(accountConfigId, accountId, messageId, partPath)}`;
         return storage.has(uri);
     };
     return {
@@ -183,6 +193,7 @@ export const createMockStorageService = () => {
         listOutboxAttachments,
         listOutboxDraftsWithAttachments,
         deleteOutboxAttachments,
+        deletePrefix,
         deleteOutboxAttachment,
         statOutboxAttachment,
         retrieveOutboxAttachment,
@@ -211,9 +222,12 @@ export const createMockStorageService = () => {
             for await (const chunk of body) {
                 chunks.push(Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk));
             }
-            storage.set(`mock://${key}`, Buffer.concat(chunks));
+            storage.set(`${MOCK_ROOT}${key}`, Buffer.concat(chunks));
             return key;
         },
+        deleteExportArchive: async (accountConfigId, exportRequestId) => {
+            storage.delete(`${MOCK_ROOT}${buildExportArchiveKey(accountConfigId, exportRequestId)}`);
+        },
         getPresignedDownloadUrl: async (key, _expiresInSeconds) => `mock://presigned/${key}`,
     };
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@remit/storage-service",
-	"version": "0.0.14",
+	"version": "0.0.16",
 	"type": "module",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",