storybooker 0.19.4 → 0.22.0-canary.0

package/dist/~internal/adapter/database.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"database.mjs","names":[],"sources":["../../../src/adapters/_internal/database.ts"],"sourcesContent":["// oxlint-disable max-classes-per-file\n\nimport { HTTPException } from \"hono/http-exception\";\nimport type { ContentfulStatusCode } from \"hono/utils/http-status\";\nimport type { StoryBookerAdapterMetadata } from \"../../utils/adapter-utils.ts\";\nimport type { LoggerAdapter } from \"./logger.ts\";\n\n/**\n * Service adapter to interact with database.\n *\n * @description\n * The adapter should provide callbacks to CRUD operations\n * to an existing database.\n *\n * - `collection`: A collection/container/table to hold items.\n * - `document`: A single entry in collection which contains key-value pairs (no nested data).\n *    Each document has a key 'id` which is unique in the collection.\n *\n * @throws {DatabaseNotInitializedError} if the DB service is not connected.\n * @throws {CollectionAlreadyExistsError} if the collection already exists.\n * @throws {CollectionDoesNotExistError} if the collection does not exist.\n * @throws {DocumentAlreadyExistsError} if the document already exists in the collection.\n * @throws {DocumentDoesNotExistError} if the document does not exist in the collection.\n * @throws {CustomError} if some other error occurs.\n */\nexport interface DatabaseAdapter<\n  DbDocument extends StoryBookerDatabaseDocument = StoryBookerDatabaseDocument,\n> {\n  /**\n   * Metadata about the adapter.\n   */\n  metadata: StoryBookerAdapterMetadata;\n\n  /**\n   * An optional method that is called on app boot-up\n   * to run async setup functions.\n   * @param options Common options like abortSignal.\n   * @throws if an error occur during initialisation.\n   */\n  init?: (options: DatabaseAdapterOptions) => Promise<void>;\n\n  // Collections (group of items. aka Tables)\n\n  /**\n   * List all collections available in the DB.\n   * @param options Common options like abortSignal.\n   * @returns A list of names/IDs of the collections.\n   * @throws {DatabaseNotInitializedError} if the DB service is not connected.\n   */\n  listCollections: (options: DatabaseAdapterOptions) => Promise<string[]>;\n\n  /**\n   * Create a collection used for different projects.\n   * @param collectionId ID of the collection\n   * @param options Common options like abortSignal.\n   * @throws {DatabaseNotInitializedError} if the DB service is not connected.\n   * @throws {CollectionAlreadyExistsError} if collection with ID already exists.\n   */\n  createCollection: (collectionId: string, options: DatabaseAdapterOptions) => Promise<void>;\n\n  /**\n   * Delete an existing collection.\n   * @param collectionId ID of the collection\n   * @param options Common options like abortSignal.\n   * @throws {DatabaseNotInitializedError} if the DB service is not connected.\n   * @throws {CollectionDoesNotExistError} if collection with ID does not exist.\n   */\n  deleteCollection: (collectionId: string, options: DatabaseAdapterOptions) => Promise<void>;\n\n  /**\n   * Check if collection exists.\n   * @param collectionId ID of the collection\n   * @param options Common options like abortSignal.\n   * @returns if collection is available of not\n   * @throws never.\n   */\n  hasCollection: (collectionId: string, options: DatabaseAdapterOptions) => Promise<boolean>;\n\n  // Documents (items, entries, rows, etc)\n\n  /**\n   * List all documents available in the requested collection.\n   * @param collectionId ID of the collection\n   * @param listOptions Options to format/sort the result\n   * @param options Common options like abortSignal.\n   * @returns List of documents\n   * @throws if the collection does not exist.\n   */\n  listDocuments: (\n    collectionId: string,\n    listOptions: DatabaseDocumentListOptions<DbDocument>,\n    options: DatabaseAdapterOptions,\n  ) => Promise<DbDocument[]>;\n\n  /**\n   * Create a new document in the collection.\n   * @param collectionId ID of the collection\n   * @param documentData Data to be stored\n   * @param options Common options like abortSignal.\n   * @throws if the collection does not exist.\n   */\n  createDocument: (\n    collectionId: string,\n    documentData: DbDocument,\n    options: DatabaseAdapterOptions,\n  ) => Promise<void>;\n\n  /**\n   * Get matching document data available in the requested collection.\n   * @param collectionId ID of the collection\n   * @param documentId ID of the document\n   * @param options Common options like abortSignal.\n   * @returns Data of the document\n   * @throws if the collection or document does not exist.\n   */\n  getDocument: (\n    collectionId: string,\n    documentId: string,\n    options: DatabaseAdapterOptions,\n  ) => Promise<DbDocument>;\n\n  /**\n   * Check matching document data available in the requested collection.\n   * @param collectionId ID of the collection\n   * @param documentId ID of the document\n   * @param options Common options like abortSignal.\n   * @returns if document is available of not\n   * @throws if the collection does not exists.\n   */\n  hasDocument: (\n    collectionId: string,\n    documentId: string,\n    options: DatabaseAdapterOptions,\n  ) => Promise<boolean>;\n\n  /**\n   * Update matching document data available in the requested collection.\n   * @param collectionId ID of the collection\n   * @param documentId ID of the document\n   * @param documentData Partial data to be updated.\n   * @param options Common options like abortSignal.\n   * @throws if the collection or document does not exist.\n   */\n  updateDocument: (\n    collectionId: string,\n    documentId: string,\n    documentData: Partial<Omit<DbDocument, \"id\">>,\n    options: DatabaseAdapterOptions,\n  ) => Promise<void>;\n\n  /**\n   * Delete matching document available in the requested collection.\n   * @param collectionId ID of the collection\n   * @param documentId ID of the document\n   * @param options Common options like abortSignal.\n   * @throws if the collection or document does not exist.\n   */\n  deleteDocument: (\n    collectionId: string,\n    documentId: string,\n    options: DatabaseAdapterOptions,\n  ) => Promise<void>;\n}\n\n/**\n * Base Document shape used in StoryBooker Database.\n * Should always contain a filed 'id' with string value.\n */\nexport interface StoryBookerDatabaseDocument {\n  id: string;\n  updatedAt: string;\n  createdAt: string;\n  [key: string]: unknown;\n}\n\n/** Common Database adapter options.  */\nexport interface DatabaseAdapterOptions {\n  /** A signal that can be used to cancel the request handling. */\n  abortSignal?: AbortSignal;\n  /** Logger */\n  logger: LoggerAdapter;\n}\n\nexport interface DatabaseDocumentListOptions<Item extends { id: string }> {\n  limit?: number;\n  filter?: string | ((item: Item) => boolean);\n  select?: string[];\n  sort?: \"latest\" | ((item1: Item, item2: Item) => number);\n}\n\n/**\n * Pre-defined Database adapter errors\n * that can be used across different adapters.\n *\n * Throws {HTTPException} with relevant status codes.\n */\nexport const DatabaseAdapterErrors = {\n  DatabaseNotInitializedError: class extends HTTPException {\n    constructor(cause?: unknown) {\n      super(500, { cause, message: \"Database adapter is not initialized.\" });\n    }\n  },\n  CollectionAlreadyExistsError: class extends HTTPException {\n    constructor(collectionId: string, cause?: unknown) {\n      super(409, {\n        cause,\n        message: `Database collection '${collectionId}' already exists.`,\n      });\n    }\n  },\n  CollectionDoesNotExistError: class extends HTTPException {\n    constructor(collectionId: string, cause?: unknown) {\n      super(404, {\n        cause,\n        message: `Database collection '${collectionId}' does not exist.`,\n      });\n    }\n  },\n  DocumentAlreadyExistsError: class extends HTTPException {\n    constructor(collectionId: string, documentId: string, cause?: unknown) {\n      super(409, {\n        cause,\n        message: `Database document '${documentId}' already exists in collection '${collectionId}'.`,\n      });\n    }\n  },\n  DocumentDoesNotExistError: class extends HTTPException {\n    constructor(collectionId: string, documentId: string, cause?: unknown) {\n      super(404, {\n        cause,\n        message: `Database document '${documentId}' does not exist in collection '${collectionId}'.`,\n      });\n    }\n  },\n  CustomError: class extends HTTPException {\n    constructor(status: number | undefined, message: string, cause?: unknown) {\n      super(status as ContentfulStatusCode, { cause, message });\n    }\n  },\n  // oxlint-disable-next-line no-explicit-any\n} satisfies Record<string, new (...args: any[]) => HTTPException>;\n"],"mappings":";;;;;;;;;AAoMA,MAAa,wBAAwB;CACnC,6BAA6B,cAAc,cAAc;EACvD,YAAY,OAAiB;AAC3B,SAAM,KAAK;IAAE;IAAO,SAAS;IAAwC,CAAC;;;CAG1E,8BAA8B,cAAc,cAAc;EACxD,YAAY,cAAsB,OAAiB;AACjD,SAAM,KAAK;IACT;IACA,SAAS,wBAAwB,aAAa;IAC/C,CAAC;;;CAGN,6BAA6B,cAAc,cAAc;EACvD,YAAY,cAAsB,OAAiB;AACjD,SAAM,KAAK;IACT;IACA,SAAS,wBAAwB,aAAa;IAC/C,CAAC;;;CAGN,4BAA4B,cAAc,cAAc;EACtD,YAAY,cAAsB,YAAoB,OAAiB;AACrE,SAAM,KAAK;IACT;IACA,SAAS,sBAAsB,WAAW,kCAAkC,aAAa;IAC1F,CAAC;;;CAGN,2BAA2B,cAAc,cAAc;EACrD,YAAY,cAAsB,YAAoB,OAAiB;AACrE,SAAM,KAAK;IACT;IACA,SAAS,sBAAsB,WAAW,kCAAkC,aAAa;IAC1F,CAAC;;;CAGN,aAAa,cAAc,cAAc;EACvC,YAAY,QAA4B,SAAiB,OAAiB;AACxE,SAAM,QAAgC;IAAE;IAAO;IAAS,CAAC;;;CAI9D"}

package/dist/~internal/adapter/logger.d.mts

@@ -0,0 +1,34 @@
+import { StoryBookerAdapterMetadata } from "../../utils/adapter-utils.mjs";
+
+//#region src/adapters/_internal/logger.d.ts
+
+/**
+ * Service adapter to log to desired destination.
+ *
+ * The service should contain method to `log` and report `error`.
+ * It can optionally have `debug` callback for debug messages.
+ *
+ * @default NodeJS.console
+ */
+interface LoggerAdapter {
+  /**
+   * Metadata about the adapter.
+   */
+  metadata: StoryBookerAdapterMetadata;
+  /**
+   * Optional debug logs
+   */
+  debug?: (...args: unknown[]) => void;
+  /**
+   * Error logs
+   */
+  error: (...args: unknown[]) => void;
+  /**
+   * Normal logs
+   */
+  log: (...args: unknown[]) => void;
+}
+declare function createConsoleLoggerAdapter(): LoggerAdapter;
+//#endregion
+export { LoggerAdapter, createConsoleLoggerAdapter };
+//# sourceMappingURL=logger.d.mts.map

package/dist/~internal/adapter/logger.mjs

@@ -0,0 +1,13 @@
+//#region src/adapters/_internal/logger.ts
+function createConsoleLoggerAdapter() {
+	return {
+		metadata: { name: "console" },
+		debug: console.debug.bind(console),
+		error: console.error.bind(console),
+		log: console.log.bind(console)
+	};
+}
+
+//#endregion
+export { createConsoleLoggerAdapter };
+//# sourceMappingURL=logger.mjs.map

package/dist/~internal/adapter/logger.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.mjs","names":[],"sources":["../../../src/adapters/_internal/logger.ts"],"sourcesContent":["import type { StoryBookerAdapterMetadata } from \"../../utils/adapter-utils.ts\";\n\n// oxlint-disable no-console\n/**\n * Service adapter to log to desired destination.\n *\n * The service should contain method to `log` and report `error`.\n * It can optionally have `debug` callback for debug messages.\n *\n * @default NodeJS.console\n */\nexport interface LoggerAdapter {\n  /**\n   * Metadata about the adapter.\n   */\n  metadata: StoryBookerAdapterMetadata;\n  /**\n   * Optional debug logs\n   */\n  debug?: (...args: unknown[]) => void;\n  /**\n   * Error logs\n   */\n  error: (...args: unknown[]) => void;\n  /**\n   * Normal logs\n   */\n  log: (...args: unknown[]) => void;\n}\n\nexport function createConsoleLoggerAdapter(): LoggerAdapter {\n  return {\n    metadata: {\n      name: \"console\",\n    },\n\n    debug: console.debug.bind(console),\n    error: console.error.bind(console),\n    log: console.log.bind(console),\n  };\n}\n"],"mappings":";AA8BA,SAAgB,6BAA4C;AAC1D,QAAO;EACL,UAAU,EACR,MAAM,WACP;EAED,OAAO,QAAQ,MAAM,KAAK,QAAQ;EAClC,OAAO,QAAQ,MAAM,KAAK,QAAQ;EAClC,KAAK,QAAQ,IAAI,KAAK,QAAQ;EAC/B"}

package/dist/~internal/adapter/storage.d.mts

@@ -0,0 +1,208 @@
+import { StoryBookerAdapterMetadata } from "../../utils/adapter-utils.mjs";
+import { LoggerAdapter } from "./logger.mjs";
+import { ContentfulStatusCode } from "hono/utils/http-status";
+
+//#region src/adapters/_internal/storage.d.ts
+
+/**
+ * Service adapter to interact with file-storage.
+ *
+ * @description
+ * The adapter should provide callbacks to perform operations
+ * to an existing storage like upload and download files.
+ *
+ * - `container`: A container/group/bucket to hold files. Each project has one container.
+ * - `file`: A single binary that can individually stored and retrieved.
+ *
+ * @throws {StorageNotInitializedError} if the Storage service is not connected.
+ * @throws {ContainerAlreadyExistsError} if the container already exists.
+ * @throws {ContainerDoesNotExistError} if the container does not exist.
+ * @throws {FileDoesNotExistError} if the file does not exist in the container.
+ * @throws {CustomError} if some other error occurs.
+ */
+interface StorageAdapter {
+  /**
+   * Metadata about the adapter.
+   */
+  metadata: StoryBookerAdapterMetadata;
+  /**
+   * An optional method that is called on app boot-up
+   * to run async setup functions.
+   * @param options Common options like abortSignal.
+   * @throws If the Storage service fails to initialize.
+   */
+  init?: (options: StorageAdapterOptions) => Promise<void>;
+  /**
+   * List all containers available in the storage.
+   * @param options Common options like abortSignal.
+   * @returns A list of names/IDs of the containers.
+   * @throws {StorageNotInitializedError} if the Storage service is not connected.
+   */
+  listContainers: (options: StorageAdapterOptions) => Promise<string[]>;
+  /**
+   * Create a container used for different projects.
+   * @param containerId ID of the container
+   * @param options Common options like abortSignal.
+   * @throws if container with ID already exists.
+   */
+  createContainer: (containerId: string, options: StorageAdapterOptions) => Promise<void>;
+  /**
+   * Delete an existing container.
+   * @param containerId ID of the container
+   * @param options Common options like abortSignal.
+   * @throws if container with ID does not exist.
+   */
+  deleteContainer: (containerId: string, options: StorageAdapterOptions) => Promise<void>;
+  /**
+   * Check if container exists.
+   * @param containerId ID of the container
+   * @param options Common options like abortSignal.
+   * @returns if container is available of not
+   * @throws never.
+   */
+  hasContainer: (containerId: string, options: StorageAdapterOptions) => Promise<boolean>;
+  /**
+   * Upload multiple files to the storage container
+   * @param containerId ID of the container
+   * @param files List of files with path, data and metadata
+   * @param options Common options like abortSignal
+   * @throws if the the container does not exists
+   */
+  uploadFiles: (containerId: string, files: StoryBookerFile[], options: StorageAdapterOptions) => Promise<void>;
+  /**
+   * Delete multiple files by their paths or a shared prefix.
+   * @param containerId ID of the container
+   * @param filePathsOrPrefix
+   * Either a list of complete filepaths or
+   * a single string representing the shared path (prefix).
+   * @param options Common options like abortSignal
+   * @throws if the the container does not exists but NOT if file(s) does not exists
+   */
+  deleteFiles: (containerId: string, filePathsOrPrefix: string | string[], options: StorageAdapterOptions) => Promise<void>;
+  /**
+   * Check if a file exists in the storage container
+   * @param containerId ID of the container
+   * @param filepath Path of the file
+   * @param options Common options like abortSignal
+   * @returns if the file exists or not
+   * @throws if the the container does not exists
+   */
+  hasFile: (containerId: string, filepath: string, options: StorageAdapterOptions) => Promise<boolean>;
+  /**
+   * Download a single file from the storage container
+   * @param containerId ID of the container
+   * @param filepath Path of the file
+   * @param options Common options like abortSignal
+   * @returns StoryBooker file data
+   * @throws if the the container or file does not exists
+   */
+  downloadFile: (containerId: string, filepath: string, options: StorageAdapterOptions) => Promise<Partial<StoryBookerFile>>;
+}
+/** Common Storage adapter options.  */
+interface StorageAdapterOptions {
+  /** A signal that can be used to cancel the request handling. */
+  abortSignal?: AbortSignal;
+  /** Logger */
+  logger: LoggerAdapter;
+}
+/** Shape of file/blob */
+interface StoryBookerFile {
+  content: Blob | ReadableStream | string;
+  mimeType: string;
+  path: string;
+}
+/**
+ * Pre-defined Storage adapter errors
+ * that can be used across different adapters.
+ *
+ * Throws {HTTPException} with relevant status codes.
+ */
+declare const StorageAdapterErrors: {
+  StorageNotInitializedError: {
+    new (cause?: unknown): {
+      name: string;
+      message: string;
+      stack?: string | undefined;
+      cause?: unknown;
+      readonly res?: Response | undefined;
+      readonly status: ContentfulStatusCode;
+      getResponse(): Response;
+    };
+    captureStackTrace(targetObject: object, constructorOpt?: Function | undefined): void;
+    prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
+    stackTraceLimit: number;
+  };
+  ContainerAlreadyExistsError: {
+    new (containerId: string, cause?: unknown): {
+      name: string;
+      message: string;
+      stack?: string | undefined;
+      cause?: unknown;
+      readonly res?: Response | undefined;
+      readonly status: ContentfulStatusCode;
+      getResponse(): Response;
+    };
+    captureStackTrace(targetObject: object, constructorOpt?: Function | undefined): void;
+    prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
+    stackTraceLimit: number;
+  };
+  ContainerDoesNotExistError: {
+    new (containerId: string, cause?: unknown): {
+      name: string;
+      message: string;
+      stack?: string | undefined;
+      cause?: unknown;
+      readonly res?: Response | undefined;
+      readonly status: ContentfulStatusCode;
+      getResponse(): Response;
+    };
+    captureStackTrace(targetObject: object, constructorOpt?: Function | undefined): void;
+    prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
+    stackTraceLimit: number;
+  };
+  FileDoesNotExistError: {
+    new (containerId: string, filepath: string, cause?: unknown): {
+      name: string;
+      message: string;
+      stack?: string | undefined;
+      cause?: unknown;
+      readonly res?: Response | undefined;
+      readonly status: ContentfulStatusCode;
+      getResponse(): Response;
+    };
+    captureStackTrace(targetObject: object, constructorOpt?: Function | undefined): void;
+    prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
+    stackTraceLimit: number;
+  };
+  FileMalformedError: {
+    new (containerId: string, filepath: string, cause?: unknown): {
+      name: string;
+      message: string;
+      stack?: string | undefined;
+      cause?: unknown;
+      readonly res?: Response | undefined;
+      readonly status: ContentfulStatusCode;
+      getResponse(): Response;
+    };
+    captureStackTrace(targetObject: object, constructorOpt?: Function | undefined): void;
+    prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
+    stackTraceLimit: number;
+  };
+  CustomError: {
+    new (status: number | undefined, message: string, cause?: unknown): {
+      name: string;
+      message: string;
+      stack?: string | undefined;
+      cause?: unknown;
+      readonly res?: Response | undefined;
+      readonly status: ContentfulStatusCode;
+      getResponse(): Response;
+    };
+    captureStackTrace(targetObject: object, constructorOpt?: Function | undefined): void;
+    prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any;
+    stackTraceLimit: number;
+  };
+};
+//#endregion
+export { StorageAdapter, StorageAdapterErrors, StorageAdapterOptions, StoryBookerFile };
+//# sourceMappingURL=storage.d.mts.map

package/dist/~internal/adapter/storage.mjs

@@ -0,0 +1,63 @@
+import { HTTPException } from "hono/http-exception";
+
+//#region src/adapters/_internal/storage.ts
+/**
+* Pre-defined Storage adapter errors
+* that can be used across different adapters.
+*
+* Throws {HTTPException} with relevant status codes.
+*/
+const StorageAdapterErrors = {
+	StorageNotInitializedError: class extends HTTPException {
+		constructor(cause) {
+			super(500, {
+				cause,
+				message: "Storage adapter is not initialized."
+			});
+		}
+	},
+	ContainerAlreadyExistsError: class extends HTTPException {
+		constructor(containerId, cause) {
+			super(409, {
+				cause,
+				message: `Storage container '${containerId}' already exists.`
+			});
+		}
+	},
+	ContainerDoesNotExistError: class extends HTTPException {
+		constructor(containerId, cause) {
+			super(404, {
+				cause,
+				message: `Storage container '${containerId}' does not exist.`
+			});
+		}
+	},
+	FileDoesNotExistError: class extends HTTPException {
+		constructor(containerId, filepath, cause) {
+			super(404, {
+				cause,
+				message: `Storage file '${filepath}' does not exist in container '${containerId}'.`
+			});
+		}
+	},
+	FileMalformedError: class extends HTTPException {
+		constructor(containerId, filepath, cause) {
+			super(415, {
+				cause,
+				message: `Storage file '${filepath}' is malformed in container '${containerId}'.`
+			});
+		}
+	},
+	CustomError: class extends HTTPException {
+		constructor(status, message, cause) {
+			super(status, {
+				cause,
+				message
+			});
+		}
+	}
+};
+
+//#endregion
+export { StorageAdapterErrors };
+//# sourceMappingURL=storage.mjs.map

package/dist/~internal/adapter/storage.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage.mjs","names":[],"sources":["../../../src/adapters/_internal/storage.ts"],"sourcesContent":["// oxlint-disable max-classes-per-file\n\nimport { HTTPException } from \"hono/http-exception\";\nimport type { ContentfulStatusCode } from \"hono/utils/http-status\";\nimport type { StoryBookerAdapterMetadata } from \"../../utils/adapter-utils.ts\";\nimport type { LoggerAdapter } from \"./logger.ts\";\n\n/**\n * Service adapter to interact with file-storage.\n *\n * @description\n * The adapter should provide callbacks to perform operations\n * to an existing storage like upload and download files.\n *\n * - `container`: A container/group/bucket to hold files. Each project has one container.\n * - `file`: A single binary that can individually stored and retrieved.\n *\n * @throws {StorageNotInitializedError} if the Storage service is not connected.\n * @throws {ContainerAlreadyExistsError} if the container already exists.\n * @throws {ContainerDoesNotExistError} if the container does not exist.\n * @throws {FileDoesNotExistError} if the file does not exist in the container.\n * @throws {CustomError} if some other error occurs.\n */\nexport interface StorageAdapter {\n  /**\n   * Metadata about the adapter.\n   */\n  metadata: StoryBookerAdapterMetadata;\n\n  /**\n   * An optional method that is called on app boot-up\n   * to run async setup functions.\n   * @param options Common options like abortSignal.\n   * @throws If the Storage service fails to initialize.\n   */\n  init?: (options: StorageAdapterOptions) => Promise<void>;\n\n  // Containers\n\n  /**\n   * List all containers available in the storage.\n   * @param options Common options like abortSignal.\n   * @returns A list of names/IDs of the containers.\n   * @throws {StorageNotInitializedError} if the Storage service is not connected.\n   */\n  listContainers: (options: StorageAdapterOptions) => Promise<string[]>;\n\n  /**\n   * Create a container used for different projects.\n   * @param containerId ID of the container\n   * @param options Common options like abortSignal.\n   * @throws if container with ID already exists.\n   */\n  createContainer: (containerId: string, options: StorageAdapterOptions) => Promise<void>;\n\n  /**\n   * Delete an existing container.\n   * @param containerId ID of the container\n   * @param options Common options like abortSignal.\n   * @throws if container with ID does not exist.\n   */\n  deleteContainer: (containerId: string, options: StorageAdapterOptions) => Promise<void>;\n\n  /**\n   * Check if container exists.\n   * @param containerId ID of the container\n   * @param options Common options like abortSignal.\n   * @returns if container is available of not\n   * @throws never.\n   */\n  hasContainer: (containerId: string, options: StorageAdapterOptions) => Promise<boolean>;\n\n  // Files\n\n  /**\n   * Upload multiple files to the storage container\n   * @param containerId ID of the container\n   * @param files List of files with path, data and metadata\n   * @param options Common options like abortSignal\n   * @throws if the the container does not exists\n   */\n  uploadFiles: (\n    containerId: string,\n    files: StoryBookerFile[],\n    options: StorageAdapterOptions,\n  ) => Promise<void>;\n\n  /**\n   * Delete multiple files by their paths or a shared prefix.\n   * @param containerId ID of the container\n   * @param filePathsOrPrefix\n   * Either a list of complete filepaths or\n   * a single string representing the shared path (prefix).\n   * @param options Common options like abortSignal\n   * @throws if the the container does not exists but NOT if file(s) does not exists\n   */\n  deleteFiles: (\n    containerId: string,\n    filePathsOrPrefix: string | string[],\n    options: StorageAdapterOptions,\n  ) => Promise<void>;\n\n  /**\n   * Check if a file exists in the storage container\n   * @param containerId ID of the container\n   * @param filepath Path of the file\n   * @param options Common options like abortSignal\n   * @returns if the file exists or not\n   * @throws if the the container does not exists\n   */\n  hasFile: (\n    containerId: string,\n    filepath: string,\n    options: StorageAdapterOptions,\n  ) => Promise<boolean>;\n\n  /**\n   * Download a single file from the storage container\n   * @param containerId ID of the container\n   * @param filepath Path of the file\n   * @param options Common options like abortSignal\n   * @returns StoryBooker file data\n   * @throws if the the container or file does not exists\n   */\n  downloadFile: (\n    containerId: string,\n    filepath: string,\n    options: StorageAdapterOptions,\n  ) => Promise<Partial<StoryBookerFile>>;\n}\n\n/** Common Storage adapter options.  */\nexport interface StorageAdapterOptions {\n  /** A signal that can be used to cancel the request handling. */\n  abortSignal?: AbortSignal;\n  /** Logger */\n  logger: LoggerAdapter;\n}\n\n/** Shape of file/blob */\nexport interface StoryBookerFile {\n  content: Blob | ReadableStream | string;\n  mimeType: string;\n  path: string;\n}\n\n/**\n * Pre-defined Storage adapter errors\n * that can be used across different adapters.\n *\n * Throws {HTTPException} with relevant status codes.\n */\nexport const StorageAdapterErrors = {\n  StorageNotInitializedError: class extends HTTPException {\n    constructor(cause?: unknown) {\n      super(500, { cause, message: \"Storage adapter is not initialized.\" });\n    }\n  },\n  ContainerAlreadyExistsError: class extends HTTPException {\n    constructor(containerId: string, cause?: unknown) {\n      super(409, {\n        cause,\n        message: `Storage container '${containerId}' already exists.`,\n      });\n    }\n  },\n  ContainerDoesNotExistError: class extends HTTPException {\n    constructor(containerId: string, cause?: unknown) {\n      super(404, {\n        cause,\n        message: `Storage container '${containerId}' does not exist.`,\n      });\n    }\n  },\n  FileDoesNotExistError: class extends HTTPException {\n    constructor(containerId: string, filepath: string, cause?: unknown) {\n      super(404, {\n        cause,\n        message: `Storage file '${filepath}' does not exist in container '${containerId}'.`,\n      });\n    }\n  },\n  FileMalformedError: class extends HTTPException {\n    constructor(containerId: string, filepath: string, cause?: unknown) {\n      super(415, {\n        cause,\n        message: `Storage file '${filepath}' is malformed in container '${containerId}'.`,\n      });\n    }\n  },\n  CustomError: class extends HTTPException {\n    constructor(status: number | undefined, message: string, cause?: unknown) {\n      super(status as ContentfulStatusCode, { cause, message });\n    }\n  },\n  // oxlint-disable-next-line no-explicit-any\n} satisfies Record<string, new (...args: any[]) => HTTPException>;\n"],"mappings":";;;;;;;;;AAwJA,MAAa,uBAAuB;CAClC,4BAA4B,cAAc,cAAc;EACtD,YAAY,OAAiB;AAC3B,SAAM,KAAK;IAAE;IAAO,SAAS;IAAuC,CAAC;;;CAGzE,6BAA6B,cAAc,cAAc;EACvD,YAAY,aAAqB,OAAiB;AAChD,SAAM,KAAK;IACT;IACA,SAAS,sBAAsB,YAAY;IAC5C,CAAC;;;CAGN,4BAA4B,cAAc,cAAc;EACtD,YAAY,aAAqB,OAAiB;AAChD,SAAM,KAAK;IACT;IACA,SAAS,sBAAsB,YAAY;IAC5C,CAAC;;;CAGN,uBAAuB,cAAc,cAAc;EACjD,YAAY,aAAqB,UAAkB,OAAiB;AAClE,SAAM,KAAK;IACT;IACA,SAAS,iBAAiB,SAAS,iCAAiC,YAAY;IACjF,CAAC;;;CAGN,oBAAoB,cAAc,cAAc;EAC9C,YAAY,aAAqB,UAAkB,OAAiB;AAClE,SAAM,KAAK;IACT;IACA,SAAS,iBAAiB,SAAS,+BAA+B,YAAY;IAC/E,CAAC;;;CAGN,aAAa,cAAc,cAAc;EACvC,YAAY,QAA4B,SAAiB,OAAiB;AACxE,SAAM,QAAgC;IAAE;IAAO;IAAS,CAAC;;;CAI9D"}

package/dist/~internal/adapter/ui.d.mts

@@ -0,0 +1,109 @@
+import { StoryBookerAdapterMetadata } from "../../utils/adapter-utils.mjs";
+import { LoggerAdapter } from "./logger.mjs";
+import { StoryBookerUser } from "./auth.mjs";
+import { ParsedError } from "../../utils/error.mjs";
+import { BuildStoryType, BuildType, BuildUploadVariant } from "../../models/builds-schema.mjs";
+import { ProjectType } from "../../models/projects-schema.mjs";
+import { TagType } from "../../models/tags-schema.mjs";
+import { UrlBuilder } from "../../urls.mjs";
+import "../types.mjs";
+
+//#region src/adapters/_internal/ui.d.ts
+type RenderedContent = string | Promise<string>;
+type UIResult = Response | Promise<Response> | RenderedContent;
+/**
+ * Adapter for creating UI for StoryBooker service.
+ *
+ * The render methods are called asynchronously and can return promise of HTML.
+ */
+interface UIAdapter {
+  /**
+   * Metadata about the adapter.
+   */
+  metadata: StoryBookerAdapterMetadata;
+  /**
+   * A special handler that is invoked when no existing StoryBooker route is matched.
+   *
+   * This can be used to serve special routes and/or static files from disk.
+   */
+  handleUnhandledRoute?(filepath: string, options: UIAdapterOptions): Response | Promise<Response>;
+  renderHomePage?(props: {
+    projects: ProjectType[];
+  }, options: UIAdapterOptions): UIResult;
+  renderErrorPage?(props: ParsedError, options: UIAdapterOptions): UIResult;
+  renderAccountsPage?(props: {
+    children: string | undefined;
+  }, options: UIAdapterOptions): UIResult;
+  renderProjectsListPage?(props: {
+    projects: ProjectType[];
+  }, options: UIAdapterOptions): UIResult;
+  renderProjectDetailsPage?(props: {
+    project: ProjectType;
+    recentBuilds: BuildType[];
+    recentTags: TagType[];
+  }, options: UIAdapterOptions): UIResult;
+  renderProjectCreatePage?(props: unknown, options: UIAdapterOptions): UIResult;
+  renderProjectUpdatePage?(props: {
+    project: ProjectType;
+  }, options: UIAdapterOptions): UIResult;
+  renderTagsListPage?(props: {
+    tags: TagType[];
+    project: ProjectType;
+    defaultType?: string | null;
+  }, options: UIAdapterOptions): UIResult;
+  renderTagDetailsPage?(props: {
+    tag: TagType;
+    project: ProjectType;
+    builds: BuildType[];
+  }, options: UIAdapterOptions): UIResult;
+  renderTagCreatePage?(props: {
+    project: ProjectType;
+  }, options: UIAdapterOptions): UIResult;
+  renderTagUpdatePage?(props: {
+    tag: TagType;
+    project: ProjectType;
+  }, options: UIAdapterOptions): UIResult;
+  renderBuildsListPage?(props: {
+    builds: BuildType[];
+    project: ProjectType;
+  }, options: UIAdapterOptions): UIResult;
+  renderBuildDetailsPage?(props: {
+    build: BuildType;
+    project: ProjectType;
+    stories: BuildStoryType[] | null;
+  }, options: UIAdapterOptions): UIResult;
+  renderBuildCreatePage?(props: {
+    project: ProjectType;
+    tagId?: string;
+  }, options: UIAdapterOptions): UIResult;
+  renderBuildUploadPage?(props: {
+    build: BuildType;
+    project: ProjectType;
+    uploadVariant?: BuildUploadVariant;
+  }, options: UIAdapterOptions): UIResult;
+}
+/** Common UI adapter options.  */
+interface UIAdapterOptions {
+  isAuthEnabled: boolean;
+  /** Logger */
+  logger: LoggerAdapter;
+  /** Logged-in user */
+  user: StoryBookerUser | null | undefined;
+  /** Current url */
+  url: string;
+  /** Current locale */
+  locale: string;
+  /** URL builder */
+  urlBuilder: UrlBuilder;
+  /** Metadata about all adapters */
+  adaptersMetadata: {
+    auth?: StoryBookerAdapterMetadata;
+    database?: StoryBookerAdapterMetadata;
+    logger?: StoryBookerAdapterMetadata;
+    storage?: StoryBookerAdapterMetadata;
+    ui?: StoryBookerAdapterMetadata;
+  };
+}
+//#endregion
+export { RenderedContent, UIAdapter, UIAdapterOptions, UIResult };
+//# sourceMappingURL=ui.d.mts.map

package/dist/~internal/adapter/ui.mjs

@@ -0,0 +1 @@
+export {  };

package/dist/~internal/adapter.d.mts

@@ -0,0 +1,8 @@
+import { StoryBookerAdapterMetadata } from "../utils/adapter-utils.mjs";
+import { LoggerAdapter, createConsoleLoggerAdapter } from "./adapter/logger.mjs";
+import { AuthAdapter, AuthAdapterAuthorise, AuthAdapterOptions, StoryBookerPermission, StoryBookerPermissionAction, StoryBookerPermissionKey, StoryBookerPermissionResource, StoryBookerPermissionWithKey, StoryBookerPermissionsAllEnabled, StoryBookerPermissionsList, StoryBookerUser } from "./adapter/auth.mjs";
+import { DatabaseAdapter, DatabaseAdapterErrors, DatabaseAdapterOptions, DatabaseDocumentListOptions, StoryBookerDatabaseDocument } from "./adapter/database.mjs";
+import { QueueAdapter, QueueAdapterOptions, QueueMessageReceiveOptions, StoryBookerQueueMessage } from "../adapters/_internal/queue.mjs";
+import { StorageAdapter, StorageAdapterErrors, StorageAdapterOptions, StoryBookerFile } from "./adapter/storage.mjs";
+import { RenderedContent, UIAdapter, UIAdapterOptions, UIResult } from "./adapter/ui.mjs";
+export { AuthAdapter, AuthAdapterAuthorise, AuthAdapterOptions, DatabaseAdapter, DatabaseAdapterErrors, DatabaseAdapterOptions, DatabaseDocumentListOptions, LoggerAdapter, QueueAdapter, QueueAdapterOptions, QueueMessageReceiveOptions, RenderedContent, StorageAdapter, StorageAdapterErrors, StorageAdapterOptions, type StoryBookerAdapterMetadata, StoryBookerDatabaseDocument, StoryBookerFile, StoryBookerPermission, StoryBookerPermissionAction, StoryBookerPermissionKey, StoryBookerPermissionResource, StoryBookerPermissionWithKey, StoryBookerPermissionsAllEnabled, StoryBookerPermissionsList, StoryBookerQueueMessage, StoryBookerUser, UIAdapter, UIAdapterOptions, UIResult, createConsoleLoggerAdapter };

package/dist/~internal/adapter.mjs

@@ -0,0 +1,6 @@
+import { StoryBookerPermissionsAllEnabled, StoryBookerPermissionsList } from "./adapter/auth.mjs";
+import { DatabaseAdapterErrors } from "./adapter/database.mjs";
+import { createConsoleLoggerAdapter } from "./adapter/logger.mjs";
+import { StorageAdapterErrors } from "./adapter/storage.mjs";
+
+export { DatabaseAdapterErrors, StorageAdapterErrors, StoryBookerPermissionsAllEnabled, StoryBookerPermissionsList, createConsoleLoggerAdapter };

package/dist/~internal/constants.d.mts

@@ -0,0 +1,24 @@
+//#region src/utils/constants.d.ts
+declare const SERVICE_NAME = "StoryBooker";
+declare const SERVICE_SHORT_NAME = "SBR";
+declare const CACHE_CONTROL_PUBLIC_YEAR = "public, max-age=31536000, immutable";
+declare const DEFAULT_PURGE_AFTER_DAYS = 30;
+declare const DEFAULT_GITHUB_BRANCH = "main";
+declare const ONE_DAY_IN_MS: number;
+declare const DEFAULT_LOCALE = "en";
+declare const QUERY_PARAMS: {
+  readonly tagId: "tagId";
+  readonly uploadVariant: "variant";
+  readonly redirect: "redirect";
+};
+declare const PATTERNS: {
+  projectId: {
+    message: string;
+    pattern: string;
+  };
+};
+declare const TagTypes: readonly ["branch", "pr", "jira"];
+declare const buildUploadVariants: readonly ["storybook", "testReport", "coverage", "screenshots"];
+//#endregion
+export { CACHE_CONTROL_PUBLIC_YEAR, DEFAULT_GITHUB_BRANCH, DEFAULT_LOCALE, DEFAULT_PURGE_AFTER_DAYS, ONE_DAY_IN_MS, PATTERNS, QUERY_PARAMS, SERVICE_NAME, SERVICE_SHORT_NAME, TagTypes, buildUploadVariants };
+//# sourceMappingURL=constants.d.mts.map

package/dist/~internal/constants.mjs

@@ -0,0 +1,32 @@
+//#region src/utils/constants.ts
+const SERVICE_NAME = "StoryBooker";
+const SERVICE_SHORT_NAME = "SBR";
+const CACHE_CONTROL_PUBLIC_YEAR = "public, max-age=31536000, immutable";
+const DEFAULT_PURGE_AFTER_DAYS = 30;
+const DEFAULT_GITHUB_BRANCH = "main";
+const ONE_DAY_IN_MS = 1440 * 60 * 1e3;
+const DEFAULT_LOCALE = "en";
+const QUERY_PARAMS = {
+	tagId: "tagId",
+	uploadVariant: "variant",
+	redirect: "redirect"
+};
+const PATTERNS = { projectId: {
+	message: "Should contain only lowercase alphabets, numbers and hyphen.",
+	pattern: "^[a-z0-9][a-z0-9-]{0,60}$"
+} };
+const TagTypes = [
+	"branch",
+	"pr",
+	"jira"
+];
+const buildUploadVariants = [
+	"storybook",
+	"testReport",
+	"coverage",
+	"screenshots"
+];
+
+//#endregion
+export { CACHE_CONTROL_PUBLIC_YEAR, DEFAULT_GITHUB_BRANCH, DEFAULT_LOCALE, DEFAULT_PURGE_AFTER_DAYS, ONE_DAY_IN_MS, PATTERNS, QUERY_PARAMS, SERVICE_NAME, SERVICE_SHORT_NAME, TagTypes, buildUploadVariants };
+//# sourceMappingURL=constants.mjs.map

package/dist/~internal/constants.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.mjs","names":["ONE_DAY_IN_MS: number"],"sources":["../../src/utils/constants.ts"],"sourcesContent":["export const SERVICE_NAME = \"StoryBooker\";\nexport const SERVICE_SHORT_NAME = \"SBR\";\nexport const CACHE_CONTROL_PUBLIC_YEAR = \"public, max-age=31536000, immutable\";\n\nexport const DEFAULT_PURGE_AFTER_DAYS = 30;\nexport const DEFAULT_GITHUB_BRANCH = \"main\";\nexport const ONE_DAY_IN_MS: number = 24 * 60 * 60 * 1000;\nexport const DEFAULT_LOCALE = \"en\";\n\nexport const QUERY_PARAMS = {\n  tagId: \"tagId\",\n  uploadVariant: \"variant\",\n  redirect: \"redirect\",\n} as const;\n\nexport const PATTERNS = {\n  projectId: {\n    message: \"Should contain only lowercase alphabets, numbers and hyphen.\",\n    pattern: \"^[a-z0-9][a-z0-9-]{0,60}$\",\n  },\n} satisfies Record<\n  string,\n  {\n    pattern: string | RegExp;\n    patternGlobal?: string | RegExp;\n    message?: string;\n  }\n>;\n\nexport const TagTypes = [\"branch\", \"pr\", \"jira\"] as const;\nexport const buildUploadVariants = [\"storybook\", \"testReport\", \"coverage\", \"screenshots\"] as const;\n"],"mappings":";AAAA,MAAa,eAAe;AAC5B,MAAa,qBAAqB;AAClC,MAAa,4BAA4B;AAEzC,MAAa,2BAA2B;AACxC,MAAa,wBAAwB;AACrC,MAAaA,gBAAwB,OAAU,KAAK;AACpD,MAAa,iBAAiB;AAE9B,MAAa,eAAe;CAC1B,OAAO;CACP,eAAe;CACf,UAAU;CACX;AAED,MAAa,WAAW,EACtB,WAAW;CACT,SAAS;CACT,SAAS;CACV,EACF;AASD,MAAa,WAAW;CAAC;CAAU;CAAM;CAAO;AAChD,MAAa,sBAAsB;CAAC;CAAa;CAAc;CAAY;CAAc"}