@s-hirano-ist/s-core 1.2.0 → 1.3.0

package/dist/images/entities/image-entity.js

@@ -1,13 +1,52 @@
 import sharp from "sharp";
 import z from "zod";
-import { CreatedAt, ExportedStatus, Id, makeCreatedAt, makeExportedStatus, makeId, UnexportedStatus, UserId, } from "../../common/entities/common-entity";
+import { CreatedAt, ExportedStatus, Id, LastUpdatedStatus, makeCreatedAt, makeExportedStatus, makeId, UnexportedStatus, UserId, } from "../../common/entities/common-entity";
 import { createEntityWithErrorHandling } from "../../common/services/entity-factory";
 import { idGenerator } from "../../common/services/id-generator";
-// NOTE: sync with s-contents/update-db.ts
+/**
+ * Width of generated thumbnails in pixels.
+ * @internal
+ */
 const THUMBNAIL_WIDTH = 192;
+/**
+ * Height of generated thumbnails in pixels.
+ * @internal
+ */
 const THUMBNAIL_HEIGHT = 192;
 // Value objects
+/**
+ * Zod schema for validating image paths.
+ *
+ * @remarks
+ * Validates that the path is a non-empty string.
+ * Paths are stored in MinIO object storage.
+ *
+ * @example
+ * ```typescript
+ * const path = Path.parse("01912c9a-image.jpg");
+ * ```
+ *
+ * @see {@link makePath} for factory function
+ */
 export const Path = z.string().min(1).brand();
+/**
+ * Creates a validated Path from a string.
+ *
+ * @param v - The raw path or filename string
+ * @param sanitizeAndUnique - If true, sanitizes the filename and prepends a UUIDv7
+ * @returns A branded Path value
+ * @throws {ZodError} When the path is empty
+ *
+ * @example
+ * ```typescript
+ * // Create unique path from user-uploaded filename
+ * const path = makePath("my image.jpg", true);
+ * // Result: "01912c9a-5e8a-7b5c-8a1b-2c3d4e5f6a7b-myimage.jpg"
+ *
+ * // Use existing path as-is
+ * const existingPath = makePath("existing-path.jpg", false);
+ * ```
+ */
 export const makePath = (v, sanitizeAndUnique) => {
     if (sanitizeAndUnique) {
         const sanitizedFileName = v.replaceAll(/[^a-zA-Z0-9._-]/g, "");
@@ -16,41 +55,196 @@ export const makePath = (v, sanitizeAndUnique) => {
     }
     return Path.parse(v);
 };
+/**
+ * Zod schema for validating image content types.
+ *
+ * @remarks
+ * Only allows JPEG, PNG, and GIF formats.
+ *
+ * @example
+ * ```typescript
+ * const type = ContentType.parse("image/jpeg");
+ * ```
+ *
+ * @see {@link makeContentType} for factory function
+ */
 export const ContentType = z
     .enum(["image/jpeg", "image/png", "image/gif", "jpeg", "png"])
     .brand();
+/**
+ * Creates a validated ContentType from a string.
+ *
+ * @param v - The MIME type or format string
+ * @returns A branded ContentType value
+ * @throws {ZodError} When the content type is not supported
+ *
+ * @example
+ * ```typescript
+ * const type = makeContentType("image/jpeg");
+ * ```
+ */
 export const makeContentType = (v) => ContentType.parse(v);
+/**
+ * Zod schema for validating file sizes.
+ *
+ * @remarks
+ * Validates that the size is a non-negative integer up to 100MB.
+ *
+ * @example
+ * ```typescript
+ * const size = FileSize.parse(1024 * 1024); // 1MB
+ * ```
+ *
+ * @see {@link makeFileSize} for factory function
+ */
 export const FileSize = z
     .number()
     .int()
     .nonnegative()
     .max(100 * 1024 * 1024) // 100MB
     .brand();
+/**
+ * Creates a validated FileSize from a number.
+ *
+ * @param v - The file size in bytes
+ * @returns A branded FileSize value
+ * @throws {ZodError} When the size exceeds 100MB or is negative
+ *
+ * @example
+ * ```typescript
+ * const size = makeFileSize(1024 * 1024); // 1MB
+ * ```
+ */
 export const makeFileSize = (v) => FileSize.parse(v);
+/**
+ * Zod schema for validating pixel dimensions.
+ *
+ * @remarks
+ * Validates that the value is a positive integer.
+ * Optional to handle cases where dimensions cannot be determined.
+ *
+ * @see {@link makePixel} for factory function
+ */
 export const Pixel = z.number().int().positive().optional().brand();
+/**
+ * Creates a validated Pixel from a number.
+ *
+ * @param v - The pixel dimension value
+ * @returns A branded Pixel value
+ * @throws {ZodError} When the value is not a positive integer
+ */
 export const makePixel = (v) => Pixel.parse(v);
+/**
+ * Zod schema for validating image tags.
+ *
+ * @remarks
+ * Tags are non-empty strings used for organizing images.
+ *
+ * @see {@link makeTag} for factory function
+ */
 export const Tag = z.string().min(1).brand();
+/**
+ * Creates a validated Tag from a string.
+ *
+ * @param v - The tag string
+ * @returns A branded Tag value
+ * @throws {ZodError} When the tag is empty
+ */
 export const makeTag = (v) => Tag.parse(v);
+/**
+ * Zod schema for validating image descriptions.
+ *
+ * @remarks
+ * Optional non-empty string for describing the image content.
+ *
+ * @see {@link makeDescription} for factory function
+ */
 export const Description = z.string().min(1).optional().brand();
+/**
+ * Creates a validated Description from a string.
+ *
+ * @param v - The description string
+ * @returns A branded Description value
+ * @throws {ZodError} When the description is empty
+ */
 export const makeDescription = (v) => Description.parse(v);
+/**
+ * Converts a File object to a Buffer.
+ *
+ * @param file - The File object to convert
+ * @returns A Buffer containing the file data
+ *
+ * @example
+ * ```typescript
+ * const buffer = await makeOriginalBuffer(uploadedFile);
+ * ```
+ */
 export const makeOriginalBuffer = async (file) => {
     return Buffer.from(await file.arrayBuffer());
 };
+/**
+ * Creates a thumbnail buffer from a File object.
+ *
+ * @remarks
+ * Resizes the image to 192x192 pixels using sharp.
+ *
+ * @param file - The File object to create a thumbnail from
+ * @returns A Buffer containing the thumbnail image data
+ *
+ * @example
+ * ```typescript
+ * const thumbnail = await makeThumbnailBufferFromFile(uploadedFile);
+ * ```
+ */
 export const makeThumbnailBufferFromFile = async (file) => {
     const originalBuffer = Buffer.from(await file.arrayBuffer());
     return await sharp(originalBuffer)
         .resize(THUMBNAIL_WIDTH, THUMBNAIL_HEIGHT)
         .toBuffer();
 };
+/**
+ * Creates a thumbnail buffer from an existing Buffer.
+ *
+ * @remarks
+ * Resizes the image to 192x192 pixels using sharp.
+ *
+ * @param buffer - The Buffer to create a thumbnail from
+ * @returns A Buffer containing the thumbnail image data
+ *
+ * @example
+ * ```typescript
+ * const thumbnail = await makeThumbnailBufferFromBuffer(imageBuffer);
+ * ```
+ */
 export const makeThumbnailBufferFromBuffer = async (buffer) => {
     return await sharp(buffer)
         .resize(THUMBNAIL_WIDTH, THUMBNAIL_HEIGHT)
         .toBuffer();
 };
+/**
+ * Extracts metadata from an image buffer.
+ *
+ * @remarks
+ * Uses sharp to extract image metadata including dimensions, format, etc.
+ *
+ * @param buffer - The image buffer to analyze
+ * @returns The image metadata from sharp
+ *
+ * @example
+ * ```typescript
+ * const metadata = await makeMetadata(imageBuffer);
+ * console.log(metadata.width, metadata.height);
+ * ```
+ */
 export const makeMetadata = async (buffer) => {
     return sharp(buffer).metadata();
 };
 // Entities
+/**
+ * Base schema containing common image fields.
+ *
+ * @internal
+ */
 const Base = z.object({
     id: Id,
     userId: UserId,
@@ -63,9 +257,69 @@ const Base = z.object({
     description: Description,
     createdAt: CreatedAt,
 });
+/**
+ * Zod schema for an unexported image.
+ *
+ * @remarks
+ * Represents an image that has not yet been published.
+ * This is the initial state of all newly created images.
+ *
+ * @see {@link ExportedImage} for the published state
+ */
 export const UnexportedImage = Base.extend({ status: UnexportedStatus });
-const ExportedImage = Base.extend(ExportedStatus.shape);
+/**
+ * Zod schema for an exported image.
+ *
+ * @remarks
+ * Represents an image that has been published.
+ * Includes the exportedAt timestamp.
+ *
+ * @see {@link UnexportedImage} for the initial state
+ */
+export const ExportedImage = Base.extend(ExportedStatus.shape);
+/**
+ * Zod schema for an image marked for export in the current batch.
+ *
+ * @remarks
+ * Represents an image that has been marked for export but not yet finalized.
+ * This intermediate state allows for batch processing with revert capability.
+ *
+ * @see {@link UnexportedImage} for the initial state
+ * @see {@link ExportedImage} for the final state
+ */
+export const LastUpdatedImage = Base.extend({ status: LastUpdatedStatus });
+/**
+ * Factory object for Image domain entity operations.
+ *
+ * @remarks
+ * Provides immutable entity creation following DDD patterns.
+ * All returned entities are frozen using Object.freeze().
+ *
+ * @example
+ * ```typescript
+ * // Create a new unexported image
+ * const image = imageEntity.create({
+ *   userId: makeUserId("user-123"),
+ *   path: makePath("image.jpg", true),
+ *   contentType: makeContentType("image/jpeg"),
+ *   fileSize: makeFileSize(1024),
+ * });
+ *
+ * // Export the image (changes status to EXPORTED)
+ * const exported = imageEntity.export(image);
+ * ```
+ *
+ * @see {@link CreateImageArgs} for creation parameters
+ */
 export const imageEntity = {
+    /**
+     * Creates a new unexported image entity.
+     *
+     * @param args - The creation arguments containing required fields
+     * @returns A frozen UnexportedImage instance with generated id and timestamps
+     * @throws {InvalidFormatError} When validation of any field fails
+     * @throws {UnexpectedError} For unexpected errors during creation
+     */
     create: (args) => {
         return createEntityWithErrorHandling(() => Object.freeze({
             id: makeId(),
@@ -74,6 +328,14 @@ export const imageEntity = {
             ...args,
         }));
     },
+    /**
+     * Transitions an image from UNEXPORTED to EXPORTED status.
+     *
+     * @param image - The unexported image to export
+     * @returns A frozen ExportedImage with exportedAt timestamp
+     * @throws {InvalidFormatError} When the image state is invalid
+     * @throws {UnexpectedError} For unexpected errors during export
+     */
     export: (image) => {
         return createEntityWithErrorHandling(() => {
             const exportedStatus = makeExportedStatus();
@@ -83,5 +345,60 @@ export const imageEntity = {
             });
         });
     },
+    /**
+     * Marks an image for export in the current batch.
+     *
+     * @remarks
+     * Transitions from UNEXPORTED to LAST_UPDATED status.
+     * This allows for batch processing with revert capability.
+     *
+     * @param image - The unexported image to mark
+     * @returns A frozen LastUpdatedImage
+     * @throws {InvalidFormatError} When the image state is invalid
+     * @throws {UnexpectedError} For unexpected errors
+     */
+    markAsLastUpdated: (image) => {
+        return createEntityWithErrorHandling(() => Object.freeze({
+            ...image,
+            status: "LAST_UPDATED",
+        }));
+    },
+    /**
+     * Reverts an image from LAST_UPDATED back to UNEXPORTED.
+     *
+     * @remarks
+     * Use this when batch processing fails and needs to be rolled back.
+     *
+     * @param image - The last updated image to revert
+     * @returns A frozen UnexportedImage
+     * @throws {InvalidFormatError} When the image state is invalid
+     * @throws {UnexpectedError} For unexpected errors
+     */
+    revert: (image) => {
+        return createEntityWithErrorHandling(() => Object.freeze({
+            ...image,
+            status: "UNEXPORTED",
+        }));
+    },
+    /**
+     * Finalizes an image from LAST_UPDATED to EXPORTED.
+     *
+     * @remarks
+     * Use this after batch processing succeeds to confirm the export.
+     *
+     * @param image - The last updated image to finalize
+     * @returns A frozen ExportedImage with exportedAt timestamp
+     * @throws {InvalidFormatError} When the image state is invalid
+     * @throws {UnexpectedError} For unexpected errors
+     */
+    finalize: (image) => {
+        return createEntityWithErrorHandling(() => {
+            const exportedStatus = makeExportedStatus();
+            return Object.freeze({
+                ...image,
+                ...exportedStatus,
+            });
+        });
+    },
 };
 //# sourceMappingURL=image-entity.js.map

package/dist/images/entities/image-entity.js.map

@@ -1 +1 @@
-{"version":3,"file":"image-entity.js","sourceRoot":"","sources":["../../../images/entities/image-entity.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,CAAC,MAAM,KAAK,CAAC;AACpB,OAAO,EACN,SAAS,EACT,cAAc,EACd,EAAE,EACF,aAAa,EACb,kBAAkB,EAClB,MAAM,EACN,gBAAgB,EAChB,MAAM,GACN,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,6BAA6B,EAAE,MAAM,sCAAsC,CAAC;AACrF,OAAO,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AAEjE,0CAA0C;AAC1C,MAAM,eAAe,GAAG,GAAG,CAAC;AAC5B,MAAM,gBAAgB,GAAG,GAAG,CAAC;AAE7B,gBAAgB;AAEhB,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,EAAU,CAAC;AAEtD,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,CAAS,EAAE,iBAA0B,EAAQ,EAAE;IACvE,IAAI,iBAAiB,EAAE,CAAC;QACvB,MAAM,iBAAiB,GAAG,CAAC,CAAC,UAAU,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAC;QAC/D,MAAM,IAAI,GAAG,GAAG,WAAW,CAAC,MAAM,EAAE,IAAI,iBAAiB,EAAE,CAAC;QAC5D,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IACD,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACtB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC;KAC1B,IAAI,CAAC,CAAC,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;KAC7D,KAAK,EAAiB,CAAC;AAEzB,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAS,EAAe,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAEhF,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC;KACvB,MAAM,EAAE;KACR,GAAG,EAAE;KACL,WAAW,EAAE;KACb,GAAG,CAAC,GAAG,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC,QAAQ;KAC/B,KAAK,EAAc,CAAC;AAEtB,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAS,EAAY,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAEvE,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAW,CAAC;AAE7E,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,CAAS,EAAS,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAE9D,MAAM,CAAC,MAAM,GAAG,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,EAAS,CAAC;AAEpD,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,CAAS,EAAO,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAExD,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAiB,CAAC;AAE/E,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAS,EAAe,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAEhF,MAAM,CAAC,MAAM,kBAAkB,GAAG,KAAK,EAAE,IAAU,EAAE,EAAE;IACtD,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;AAC9C,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,2BAA2B,GAAG,KAAK,EAAE,IAAU,EAAE,EAAE;IAC/D,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IAC7D,OAAO,MAAM,KAAK,CAAC,cAAc,CAAC;SAChC,MAAM,CAAC,eAAe,EAAE,gBAAgB,CAAC;SACzC,QAAQ,EAAE,CAAC;AACd,CAAC,CAAC;AACF,MAAM,CAAC,MAAM,6BAA6B,GAAG,KAAK,EAAE,MAAc,EAAE,EAAE;IACrE,OAAO,MAAM,KAAK,CAAC,MAAM,CAAC;SACxB,MAAM,CAAC,eAAe,EAAE,gBAAgB,CAAC;SACzC,QAAQ,EAAE,CAAC;AACd,CAAC,CAAC;AACF,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,EAAE,MAAc,EAAE,EAAE;IACpD,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;AACjC,CAAC,CAAC;AAEF,WAAW;AAEX,MAAM,IAAI,GAAG,CAAC,CAAC,MAAM,CAAC;IACrB,EAAE,EAAE,EAAE;IACN,MAAM,EAAE,MAAM;IACd,IAAI,EAAE,IAAI;IACV,WAAW,EAAE,WAAW;IACxB,QAAQ,EAAE,QAAQ;IAClB,KAAK,EAAE,KAAK;IACZ,MAAM,EAAE,KAAK;IACb,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;IAC7B,WAAW,EAAE,WAAW;IACxB,SAAS,EAAE,SAAS;CACpB,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,gBAAgB,EAAE,CAAC,CAAC;AAGzE,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;AAcxD,MAAM,CAAC,MAAM,WAAW,GAAG;IAC1B,MAAM,EAAE,CAAC,IAAqB,EAAmB,EAAE;QAClD,OAAO,6BAA6B,CAAC,GAAG,EAAE,CACzC,MAAM,CAAC,MAAM,CAAC;YACb,EAAE,EAAE,MAAM,EAAE;YACZ,MAAM,EAAE,YAAY;YACpB,SAAS,EAAE,aAAa,EAAE;YAC1B,GAAG,IAAI;SACP,CAAC,CACF,CAAC;IACH,CAAC;IAED,MAAM,EAAE,CAAC,KAAsB,EAAiB,EAAE;QACjD,OAAO,6BAA6B,CAAC,GAAG,EAAE;YACzC,MAAM,cAAc,GAAG,kBAAkB,EAAE,CAAC;YAC5C,OAAO,MAAM,CAAC,MAAM,CAAC;gBACpB,GAAG,KAAK;gBACR,GAAG,cAAc;aACjB,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;IACJ,CAAC;CACD,CAAC"}
+{"version":3,"file":"image-entity.js","sourceRoot":"","sources":["../../../images/entities/image-entity.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,CAAC,MAAM,KAAK,CAAC;AACpB,OAAO,EACN,SAAS,EACT,cAAc,EACd,EAAE,EACF,iBAAiB,EACjB,aAAa,EACb,kBAAkB,EAClB,MAAM,EACN,gBAAgB,EAChB,MAAM,GACN,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,6BAA6B,EAAE,MAAM,sCAAsC,CAAC;AACrF,OAAO,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AAEjE;;;GAGG;AACH,MAAM,eAAe,GAAG,GAAG,CAAC;AAE5B;;;GAGG;AACH,MAAM,gBAAgB,GAAG,GAAG,CAAC;AAE7B,gBAAgB;AAEhB;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,EAAU,CAAC;AAOtD;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,CAAS,EAAE,iBAA0B,EAAQ,EAAE;IACvE,IAAI,iBAAiB,EAAE,CAAC;QACvB,MAAM,iBAAiB,GAAG,CAAC,CAAC,UAAU,CAAC,kBAAkB,EAAE,EAAE,CAAC,CAAC;QAC/D,MAAM,IAAI,GAAG,GAAG,WAAW,CAAC,MAAM,EAAE,IAAI,iBAAiB,EAAE,CAAC;QAC5D,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACzB,CAAC;IACD,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACtB,CAAC,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC;KAC1B,IAAI,CAAC,CAAC,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;KAC7D,KAAK,EAAiB,CAAC;AAOzB;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAS,EAAe,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAEhF;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC;KACvB,MAAM,EAAE;KACR,GAAG,EAAE;KACL,WAAW,EAAE;KACb,GAAG,CAAC,GAAG,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC,QAAQ;KAC/B,KAAK,EAAc,CAAC;AAOtB;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAS,EAAY,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAEvE;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAW,CAAC;AAO7E;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,CAAS,EAAS,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAE9D;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,GAAG,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,EAAS,CAAC;AAOpD;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,CAAS,EAAO,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAExD;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAiB,CAAC;AAO/E;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAS,EAAe,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAEhF;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,KAAK,EAAE,IAAU,EAAE,EAAE;IACtD,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;AAC9C,CAAC,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAG,KAAK,EAAE,IAAU,EAAE,EAAE;IAC/D,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IAC7D,OAAO,MAAM,KAAK,CAAC,cAAc,CAAC;SAChC,MAAM,CAAC,eAAe,EAAE,gBAAgB,CAAC;SACzC,QAAQ,EAAE,CAAC;AACd,CAAC,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,KAAK,EAAE,MAAc,EAAE,EAAE;IACrE,OAAO,MAAM,KAAK,CAAC,MAAM,CAAC;SACxB,MAAM,CAAC,eAAe,EAAE,gBAAgB,CAAC;SACzC,QAAQ,EAAE,CAAC;AACd,CAAC,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,EAAE,MAAc,EAAE,EAAE;IACpD,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;AACjC,CAAC,CAAC;AAEF,WAAW;AAEX;;;;GAIG;AACH,MAAM,IAAI,GAAG,CAAC,CAAC,MAAM,CAAC;IACrB,EAAE,EAAE,EAAE;IACN,MAAM,EAAE,MAAM;IACd,IAAI,EAAE,IAAI;IACV,WAAW,EAAE,WAAW;IACxB,QAAQ,EAAE,QAAQ;IAClB,KAAK,EAAE,KAAK;IACZ,MAAM,EAAE,KAAK;IACb,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;IAC7B,WAAW,EAAE,WAAW;IACxB,SAAS,EAAE,SAAS;CACpB,CAAC,CAAC;AAEH;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,gBAAgB,EAAE,CAAC,CAAC;AAUzE;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;AAU/D;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAC,CAAC;AAiD3E;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG;IAC1B;;;;;;;OAOG;IACH,MAAM,EAAE,CAAC,IAAqB,EAAmB,EAAE;QAClD,OAAO,6BAA6B,CAAC,GAAG,EAAE,CACzC,MAAM,CAAC,MAAM,CAAC;YACb,EAAE,EAAE,MAAM,EAAE;YACZ,MAAM,EAAE,YAAY;YACpB,SAAS,EAAE,aAAa,EAAE;YAC1B,GAAG,IAAI;SACP,CAAC,CACF,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,EAAE,CAAC,KAAsB,EAAiB,EAAE;QACjD,OAAO,6BAA6B,CAAC,GAAG,EAAE;YACzC,MAAM,cAAc,GAAG,kBAAkB,EAAE,CAAC;YAC5C,OAAO,MAAM,CAAC,MAAM,CAAC;gBACpB,GAAG,KAAK;gBACR,GAAG,cAAc;aACjB,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,iBAAiB,EAAE,CAAC,KAAsB,EAAoB,EAAE;QAC/D,OAAO,6BAA6B,CAAC,GAAG,EAAE,CACzC,MAAM,CAAC,MAAM,CAAC;YACb,GAAG,KAAK;YACR,MAAM,EAAE,cAAuB;SAC/B,CAAC,CACF,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,EAAE,CAAC,KAAuB,EAAmB,EAAE;QACpD,OAAO,6BAA6B,CAAC,GAAG,EAAE,CACzC,MAAM,CAAC,MAAM,CAAC;YACb,GAAG,KAAK;YACR,MAAM,EAAE,YAAqB;SAC7B,CAAC,CACF,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,EAAE,CAAC,KAAuB,EAAiB,EAAE;QACpD,OAAO,6BAA6B,CAAC,GAAG,EAAE;YACzC,MAAM,cAAc,GAAG,kBAAkB,EAAE,CAAC;YAC5C,OAAO,MAAM,CAAC,MAAM,CAAC;gBACpB,GAAG,KAAK;gBACR,GAAG,cAAc;aACjB,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;IACJ,CAAC;CACD,CAAC"}

package/dist/images/events/image-created-event.d.ts

@@ -1,5 +1,35 @@
 import { BaseDomainEvent } from "../../common/events/base-domain-event";
+/**
+ * Domain event emitted when an image is created.
+ *
+ * @remarks
+ * Part of the event-driven architecture for cross-cutting concerns
+ * like notifications, logging, and analytics.
+ *
+ * @example
+ * ```typescript
+ * const event = new ImageCreatedEvent({
+ *   id: "01912c9a-5e8a-7b5c-8a1b-2c3d4e5f6a7b-image.jpg",
+ *   userId: "user-123",
+ *   caller: "addImage",
+ * });
+ *
+ * // event.eventType === "image.created"
+ * await eventHandler.handle(event);
+ * ```
+ *
+ * @see {@link BaseDomainEvent} for base class
+ * @see {@link ImageDeletedEvent} for deletion event
+ */
 export declare class ImageCreatedEvent extends BaseDomainEvent {
+    /**
+     * Creates a new ImageCreatedEvent.
+     *
+     * @param data - Event data containing image details and metadata
+     * @param data.id - The image ID (used as filename in payload)
+     * @param data.userId - The user who created the image
+     * @param data.caller - The function/method that triggered the event
+     */
     constructor(data: {
         id: string;
         userId: string;

package/dist/images/events/image-created-event.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"image-created-event.d.ts","sourceRoot":"","sources":["../../../images/events/image-created-event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AAExE,qBAAa,iBAAkB,SAAQ,eAAe;gBACzC,IAAI,EAAE;QACjB,EAAE,EAAE,MAAM,CAAC;QACX,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;KACf;CAYD"}
+{"version":3,"file":"image-created-event.d.ts","sourceRoot":"","sources":["../../../images/events/image-created-event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AAExE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,iBAAkB,SAAQ,eAAe;IACrD;;;;;;;OAOG;gBACS,IAAI,EAAE;QACjB,EAAE,EAAE,MAAM,CAAC;QACX,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;KACf;CAYD"}

package/dist/images/events/image-created-event.js

@@ -1,5 +1,35 @@
 import { BaseDomainEvent } from "../../common/events/base-domain-event";
+/**
+ * Domain event emitted when an image is created.
+ *
+ * @remarks
+ * Part of the event-driven architecture for cross-cutting concerns
+ * like notifications, logging, and analytics.
+ *
+ * @example
+ * ```typescript
+ * const event = new ImageCreatedEvent({
+ *   id: "01912c9a-5e8a-7b5c-8a1b-2c3d4e5f6a7b-image.jpg",
+ *   userId: "user-123",
+ *   caller: "addImage",
+ * });
+ *
+ * // event.eventType === "image.created"
+ * await eventHandler.handle(event);
+ * ```
+ *
+ * @see {@link BaseDomainEvent} for base class
+ * @see {@link ImageDeletedEvent} for deletion event
+ */
 export class ImageCreatedEvent extends BaseDomainEvent {
+    /**
+     * Creates a new ImageCreatedEvent.
+     *
+     * @param data - Event data containing image details and metadata
+     * @param data.id - The image ID (used as filename in payload)
+     * @param data.userId - The user who created the image
+     * @param data.caller - The function/method that triggered the event
+     */
     constructor(data) {
         super("image.created", {
             fileName: data.id,

package/dist/images/events/image-created-event.js.map

@@ -1 +1 @@
-{"version":3,"file":"image-created-event.js","sourceRoot":"","sources":["../../../images/events/image-created-event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AAExE,MAAM,OAAO,iBAAkB,SAAQ,eAAe;IACrD,YAAY,IAIX;QACA,KAAK,CACJ,eAAe,EACf;YACC,QAAQ,EAAE,IAAI,CAAC,EAAE;SACjB,EACD;YACC,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,MAAM,EAAE,IAAI,CAAC,MAAM;SACnB,CACD,CAAC;IACH,CAAC;CACD"}
+{"version":3,"file":"image-created-event.js","sourceRoot":"","sources":["../../../images/events/image-created-event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AAExE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,OAAO,iBAAkB,SAAQ,eAAe;IACrD;;;;;;;OAOG;IACH,YAAY,IAIX;QACA,KAAK,CACJ,eAAe,EACf;YACC,QAAQ,EAAE,IAAI,CAAC,EAAE;SACjB,EACD;YACC,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,MAAM,EAAE,IAAI,CAAC,MAAM;SACnB,CACD,CAAC;IACH,CAAC;CACD"}

package/dist/images/events/image-deleted-event.d.ts

@@ -1,5 +1,35 @@
 import { BaseDomainEvent } from "../../common/events/base-domain-event";
+/**
+ * Domain event emitted when an image is deleted.
+ *
+ * @remarks
+ * Part of the event-driven architecture for cross-cutting concerns
+ * like notifications, logging, and analytics.
+ *
+ * @example
+ * ```typescript
+ * const event = new ImageDeletedEvent({
+ *   path: "01912c9a-5e8a-7b5c-8a1b-2c3d4e5f6a7b-image.jpg",
+ *   userId: "user-123",
+ *   caller: "deleteImage",
+ * });
+ *
+ * // event.eventType === "image.deleted"
+ * await eventHandler.handle(event);
+ * ```
+ *
+ * @see {@link BaseDomainEvent} for base class
+ * @see {@link ImageCreatedEvent} for creation event
+ */
 export declare class ImageDeletedEvent extends BaseDomainEvent {
+    /**
+     * Creates a new ImageDeletedEvent.
+     *
+     * @param data - Event data containing deletion details
+     * @param data.path - The storage path of the deleted image
+     * @param data.userId - The user who deleted the image
+     * @param data.caller - The function/method that triggered the event
+     */
     constructor(data: {
         path: string;
         userId: string;

package/dist/images/events/image-deleted-event.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"image-deleted-event.d.ts","sourceRoot":"","sources":["../../../images/events/image-deleted-event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AAExE,qBAAa,iBAAkB,SAAQ,eAAe;gBACzC,IAAI,EAAE;QACjB,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;KACf;CAYD"}
+{"version":3,"file":"image-deleted-event.d.ts","sourceRoot":"","sources":["../../../images/events/image-deleted-event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AAExE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,iBAAkB,SAAQ,eAAe;IACrD;;;;;;;OAOG;gBACS,IAAI,EAAE;QACjB,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;KACf;CAYD"}

package/dist/images/events/image-deleted-event.js

@@ -1,5 +1,35 @@
 import { BaseDomainEvent } from "../../common/events/base-domain-event";
+/**
+ * Domain event emitted when an image is deleted.
+ *
+ * @remarks
+ * Part of the event-driven architecture for cross-cutting concerns
+ * like notifications, logging, and analytics.
+ *
+ * @example
+ * ```typescript
+ * const event = new ImageDeletedEvent({
+ *   path: "01912c9a-5e8a-7b5c-8a1b-2c3d4e5f6a7b-image.jpg",
+ *   userId: "user-123",
+ *   caller: "deleteImage",
+ * });
+ *
+ * // event.eventType === "image.deleted"
+ * await eventHandler.handle(event);
+ * ```
+ *
+ * @see {@link BaseDomainEvent} for base class
+ * @see {@link ImageCreatedEvent} for creation event
+ */
 export class ImageDeletedEvent extends BaseDomainEvent {
+    /**
+     * Creates a new ImageDeletedEvent.
+     *
+     * @param data - Event data containing deletion details
+     * @param data.path - The storage path of the deleted image
+     * @param data.userId - The user who deleted the image
+     * @param data.caller - The function/method that triggered the event
+     */
     constructor(data) {
         super("image.deleted", {
             path: data.path,

package/dist/images/events/image-deleted-event.js.map

@@ -1 +1 @@
-{"version":3,"file":"image-deleted-event.js","sourceRoot":"","sources":["../../../images/events/image-deleted-event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AAExE,MAAM,OAAO,iBAAkB,SAAQ,eAAe;IACrD,YAAY,IAIX;QACA,KAAK,CACJ,eAAe,EACf;YACC,IAAI,EAAE,IAAI,CAAC,IAAI;SACf,EACD;YACC,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,MAAM,EAAE,IAAI,CAAC,MAAM;SACnB,CACD,CAAC;IACH,CAAC;CACD"}
+{"version":3,"file":"image-deleted-event.js","sourceRoot":"","sources":["../../../images/events/image-deleted-event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AAExE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,OAAO,iBAAkB,SAAQ,eAAe;IACrD;;;;;;;OAOG;IACH,YAAY,IAIX;QACA,KAAK,CACJ,eAAe,EACf;YACC,IAAI,EAAE,IAAI,CAAC,IAAI;SACf,EACD;YACC,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,MAAM,EAAE,IAAI,CAAC,MAAM;SACnB,CACD,CAAC;IACH,CAAC;CACD"}

package/dist/images/index.d.ts

@@ -1,3 +1,38 @@
+/**
+ * @packageDocumentation
+ *
+ * Images domain for file metadata and image processing.
+ *
+ * @remarks
+ * Provides complete domain implementation for image management including:
+ *
+ * - **Entities** - Image value objects and entity factory
+ * - **Repositories** - Query and command repository interfaces (CQRS)
+ * - **Services** - Domain service for business logic
+ * - **Events** - Domain events for cross-cutting concerns
+ * - **Types** - Query parameters and cache strategies
+ *
+ * Images support metadata extraction (dimensions, file size, content type),
+ * thumbnail generation, and tag-based organization.
+ *
+ * @example
+ * ```typescript
+ * import {
+ *   imageEntity,
+ *   makePath,
+ *   makeTag,
+ *   makeThumbnailBufferFromFile,
+ *   ImageCreatedEvent,
+ * } from "@repo/core/images";
+ *
+ * const thumbnail = await makeThumbnailBufferFromFile(file);
+ * const image = imageEntity.create({
+ *   userId: makeUserId("user-123"),
+ *   path: makePath("uuid-image.jpg"),
+ *   tags: [makeTag("nature"), makeTag("landscape")],
+ * });
+ * ```
+ */
 export * from "./entities/image-entity";
 export * from "./events/image-created-event";
 export * from "./events/image-deleted-event";

package/dist/images/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../images/index.ts"],"names":[],"mappings":"AACA,cAAc,yBAAyB,CAAC;AAGxC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,8BAA8B,CAAC;AAG7C,cAAc,oDAAoD,CAAC;AACnE,cAAc,kDAAkD,CAAC;AAGjE,cAAc,kCAAkC,CAAC;AAGjD,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../images/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AAGH,cAAc,yBAAyB,CAAC;AAGxC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,8BAA8B,CAAC;AAG7C,cAAc,oDAAoD,CAAC;AACnE,cAAc,kDAAkD,CAAC;AAGjE,cAAc,kCAAkC,CAAC;AAGjD,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC"}

package/dist/images/index.js

@@ -1,3 +1,38 @@
+/**
+ * @packageDocumentation
+ *
+ * Images domain for file metadata and image processing.
+ *
+ * @remarks
+ * Provides complete domain implementation for image management including:
+ *
+ * - **Entities** - Image value objects and entity factory
+ * - **Repositories** - Query and command repository interfaces (CQRS)
+ * - **Services** - Domain service for business logic
+ * - **Events** - Domain events for cross-cutting concerns
+ * - **Types** - Query parameters and cache strategies
+ *
+ * Images support metadata extraction (dimensions, file size, content type),
+ * thumbnail generation, and tag-based organization.
+ *
+ * @example
+ * ```typescript
+ * import {
+ *   imageEntity,
+ *   makePath,
+ *   makeTag,
+ *   makeThumbnailBufferFromFile,
+ *   ImageCreatedEvent,
+ * } from "@repo/core/images";
+ *
+ * const thumbnail = await makeThumbnailBufferFromFile(file);
+ * const image = imageEntity.create({
+ *   userId: makeUserId("user-123"),
+ *   path: makePath("uuid-image.jpg"),
+ *   tags: [makeTag("nature"), makeTag("landscape")],
+ * });
+ * ```
+ */
 // Entities
 export * from "./entities/image-entity";
 // Events

package/dist/images/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../images/index.ts"],"names":[],"mappings":"AAAA,WAAW;AACX,cAAc,yBAAyB,CAAC;AAExC,SAAS;AACT,cAAc,8BAA8B,CAAC;AAC7C,cAAc,8BAA8B,CAAC;AAE7C,eAAe;AACf,cAAc,oDAAoD,CAAC;AACnE,cAAc,kDAAkD,CAAC;AAEjE,WAAW;AACX,cAAc,kCAAkC,CAAC;AAEjD,QAAQ;AACR,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../images/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AAEH,WAAW;AACX,cAAc,yBAAyB,CAAC;AAExC,SAAS;AACT,cAAc,8BAA8B,CAAC;AAC7C,cAAc,8BAA8B,CAAC;AAE7C,eAAe;AACf,cAAc,oDAAoD,CAAC;AACnE,cAAc,kDAAkD,CAAC;AAEjE,WAAW;AACX,cAAc,kCAAkC,CAAC;AAEjD,QAAQ;AACR,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC"}