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

package/dist/images/repositories/images-command-repository.interface.d.ts

@@ -1,8 +1,51 @@
 import type { Status } from "../../common/entities/common-entity";
 import type { Path, UnexportedImage } from "../entities/image-entity";
+/**
+ * Command repository interface for the Image domain.
+ *
+ * @remarks
+ * Follows the CQRS pattern - this interface handles write operations only.
+ * Implementations should be provided by the infrastructure layer (e.g., Prisma + MinIO).
+ *
+ * @example
+ * ```typescript
+ * // Infrastructure implementation
+ * class PrismaImagesCommandRepository implements IImagesCommandRepository {
+ *   async create(data: UnexportedImage) {
+ *     await prisma.image.create({ data });
+ *   }
+ *
+ *   async uploadToStorage(path: Path, buffer: Buffer, isThumbnail: boolean) {
+ *     const bucketPath = isThumbnail ? `thumbnails/${path}` : path;
+ *     await minio.putObject(bucket, bucketPath, buffer);
+ *   }
+ * }
+ * ```
+ *
+ * @see {@link IImagesQueryRepository} for read operations
+ */
 export type IImagesCommandRepository = {
+    /**
+     * Creates a new image in the repository.
+     *
+     * @param data - The unexported image entity to persist
+     */
     create(data: UnexportedImage): Promise<void>;
+    /**
+     * Uploads an image buffer to object storage.
+     *
+     * @param path - The storage path for the image
+     * @param buffer - The image data buffer
+     * @param isThumbnail - Whether this is a thumbnail upload
+     */
     uploadToStorage(path: Path, buffer: Buffer, isThumbnail: boolean): Promise<void>;
+    /**
+     * Deletes an image by its ID.
+     *
+     * @param id - The image ID to delete
+     * @param userId - The user ID for tenant isolation
+     * @param status - The expected status of the image
+     */
     deleteById(id: string, userId: string, status: Status): Promise<void>;
 };
 //# sourceMappingURL=images-command-repository.interface.d.ts.map

package/dist/images/repositories/images-command-repository.interface.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"images-command-repository.interface.d.ts","sourceRoot":"","sources":["../../../images/repositories/images-command-repository.interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAClE,OAAO,KAAK,EAAE,IAAI,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAEtE,MAAM,MAAM,wBAAwB,GAAG;IACtC,MAAM,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7C,eAAe,CACd,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,OAAO,GAClB,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACtE,CAAC"}
+{"version":3,"file":"images-command-repository.interface.d.ts","sourceRoot":"","sources":["../../../images/repositories/images-command-repository.interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAClE,OAAO,KAAK,EAAE,IAAI,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACtC;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7C;;;;;;OAMG;IACH,eAAe,CACd,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,OAAO,GAClB,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACtE,CAAC"}

package/dist/images/repositories/images-query-repository.interface.d.ts

@@ -1,7 +1,35 @@
 import type { Status, UserId } from "../../common/entities/common-entity";
 import type { Path } from "../entities/image-entity";
 import type { ImagesFindManyParams } from "../types/query-params";
+/**
+ * Query repository interface for the Image domain.
+ *
+ * @remarks
+ * Follows the CQRS pattern - this interface handles read operations only.
+ * Implementations should be provided by the infrastructure layer (e.g., Prisma + MinIO).
+ *
+ * @example
+ * ```typescript
+ * // Infrastructure implementation
+ * class PrismaImagesQueryRepository implements IImagesQueryRepository {
+ *   async findByPath(path: Path, userId: UserId) {
+ *     return await prisma.image.findUnique({
+ *       where: { path, userId }
+ *     });
+ *   }
+ * }
+ * ```
+ *
+ * @see {@link IImagesCommandRepository} for write operations
+ */
 export type IImagesQueryRepository = {
+    /**
+     * Finds an image by its path for a specific user.
+     *
+     * @param path - The validated path to search for
+     * @param userId - The user ID for tenant isolation
+     * @returns The image data if found, null otherwise
+     */
     findByPath(path: Path, userId: UserId): Promise<{
         id: string;
         path: string;
@@ -13,14 +41,45 @@ export type IImagesQueryRepository = {
         status: string;
         description: string | null;
     } | null>;
+    /**
+     * Retrieves multiple images with pagination and filtering.
+     *
+     * @param userId - The user ID for tenant isolation
+     * @param status - Filter by UNEXPORTED or EXPORTED status
+     * @param params - Optional pagination, sorting, and caching parameters
+     * @returns Array of image data objects
+     *
+     * @see {@link ImagesFindManyParams} for parameter options
+     */
     findMany(userId: UserId, status: Status, params?: ImagesFindManyParams): Promise<{
         id: string;
         path: string;
         height: number | null;
         width: number | null;
     }[]>;
+    /**
+     * Counts images matching the given criteria.
+     *
+     * @param userId - The user ID for tenant isolation
+     * @param status - Filter by status
+     * @returns The count of matching images
+     */
     count(userId: UserId, status: Status): Promise<number>;
+    /**
+     * Retrieves an image from object storage.
+     *
+     * @param path - The storage path of the image
+     * @param isThumbnail - Whether to retrieve the thumbnail version
+     * @returns A readable stream of the image data
+     */
     getFromStorage(path: string, isThumbnail: boolean): Promise<NodeJS.ReadableStream>;
+    /**
+     * Verifies an image exists in storage or throws an error.
+     *
+     * @param path - The storage path of the image
+     * @param isThumbnail - Whether to check the thumbnail version
+     * @throws When the image is not found in storage
+     */
     getFromStorageOrThrow(path: string, isThumbnail: boolean): Promise<void>;
 };
 //# sourceMappingURL=images-query-repository.interface.d.ts.map

package/dist/images/repositories/images-query-repository.interface.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"images-query-repository.interface.d.ts","sourceRoot":"","sources":["../../../images/repositories/images-query-repository.interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAC1E,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAElE,MAAM,MAAM,sBAAsB,GAAG;IACpC,UAAU,CACT,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,MAAM,GACZ,OAAO,CAAC;QACV,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;QACpB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QACxB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QACrB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QACtB,IAAI,EAAE,MAAM,EAAE,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;QACf,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B,GAAG,IAAI,CAAC,CAAC;IACV,QAAQ,CACP,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,oBAAoB,GAC3B,OAAO,CACT;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,EAAE,CAC3E,CAAC;IACF,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACvD,cAAc,CACb,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,OAAO,GAClB,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;IAClC,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACzE,CAAC"}
+{"version":3,"file":"images-query-repository.interface.d.ts","sourceRoot":"","sources":["../../../images/repositories/images-query-repository.interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAC1E,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAElE;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACpC;;;;;;OAMG;IACH,UAAU,CACT,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,MAAM,GACZ,OAAO,CAAC;QACV,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;QACpB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QACxB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QACrB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QACtB,IAAI,EAAE,MAAM,EAAE,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;QACf,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;KAC3B,GAAG,IAAI,CAAC,CAAC;IAEV;;;;;;;;;OASG;IACH,QAAQ,CACP,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,oBAAoB,GAC3B,OAAO,CACT;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,EAAE,CAC3E,CAAC;IAEF;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAEvD;;;;;;OAMG;IACH,cAAc,CACb,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,OAAO,GAClB,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;IAElC;;;;;;OAMG;IACH,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACzE,CAAC"}

package/dist/images/services/images-domain-service.d.ts

@@ -1,9 +1,49 @@
 import type { UserId } from "../../common/entities/common-entity";
 import type { Path } from "../entities/image-entity";
 import type { IImagesQueryRepository } from "../repositories/images-query-repository.interface";
+/**
+ * Domain service for Image business logic.
+ *
+ * @remarks
+ * Encapsulates complex business rules that don't belong to a single entity.
+ * Uses dependency injection for repository access.
+ *
+ * @example
+ * ```typescript
+ * const queryRepo: IImagesQueryRepository = new PrismaImagesQueryRepository();
+ * const domainService = new ImagesDomainService(queryRepo);
+ *
+ * try {
+ *   await domainService.ensureNoDuplicate(path, userId);
+ *   // Safe to create the image
+ * } catch (error) {
+ *   if (error instanceof DuplicateError) {
+ *     // Handle duplicate path
+ *   }
+ * }
+ * ```
+ *
+ * @see {@link IImagesQueryRepository} for repository interface
+ * @see {@link DuplicateError} for duplicate handling
+ */
 export declare class ImagesDomainService {
     private readonly imagesQueryRepository;
+    /**
+     * Creates a new ImagesDomainService instance.
+     *
+     * @param imagesQueryRepository - The query repository for checking duplicates
+     */
     constructor(imagesQueryRepository: IImagesQueryRepository);
+    /**
+     * Validates that no image with the same path exists for the user.
+     *
+     * @param path - The path to check for duplicates
+     * @param userId - The user ID for tenant isolation
+     * @throws {DuplicateError} When an image with this path already exists
+     *
+     * @remarks
+     * This is a domain invariant check that should be called before creating images.
+     */
     ensureNoDuplicate(path: Path, userId: UserId): Promise<void>;
 }
 //# sourceMappingURL=images-domain-service.d.ts.map

package/dist/images/services/images-domain-service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"images-domain-service.d.ts","sourceRoot":"","sources":["../../../images/services/images-domain-service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAElE,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,mDAAmD,CAAC;AAWhG,qBAAa,mBAAmB;IACnB,OAAO,CAAC,QAAQ,CAAC,qBAAqB;gBAArB,qBAAqB,EAAE,sBAAsB;IAE7D,iBAAiB,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM;CAGzD"}
+{"version":3,"file":"images-domain-service.d.ts","sourceRoot":"","sources":["../../../images/services/images-domain-service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAElE,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,mDAAmD,CAAC;AAqBhG;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,qBAAa,mBAAmB;IAMnB,OAAO,CAAC,QAAQ,CAAC,qBAAqB;IALlD;;;;OAIG;gBAC0B,qBAAqB,EAAE,sBAAsB;IAE1E;;;;;;;;;OASG;IACU,iBAAiB,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM;CAGzD"}

package/dist/images/services/images-domain-service.js

@@ -1,14 +1,64 @@
 import { DuplicateError } from "../../errors/error-classes";
+/**
+ * Checks if an image with the given path already exists.
+ *
+ * @param imagesQueryRepository - The query repository to check against
+ * @param path - The path to check for duplicates
+ * @param userId - The user ID for tenant isolation
+ * @throws {DuplicateError} When an image with this path already exists
+ *
+ * @internal
+ */
 async function ensureNoDuplicateImage(imagesQueryRepository, path, userId) {
     const exists = await imagesQueryRepository.findByPath(path, userId);
     if (exists !== null)
         throw new DuplicateError();
 }
+/**
+ * Domain service for Image business logic.
+ *
+ * @remarks
+ * Encapsulates complex business rules that don't belong to a single entity.
+ * Uses dependency injection for repository access.
+ *
+ * @example
+ * ```typescript
+ * const queryRepo: IImagesQueryRepository = new PrismaImagesQueryRepository();
+ * const domainService = new ImagesDomainService(queryRepo);
+ *
+ * try {
+ *   await domainService.ensureNoDuplicate(path, userId);
+ *   // Safe to create the image
+ * } catch (error) {
+ *   if (error instanceof DuplicateError) {
+ *     // Handle duplicate path
+ *   }
+ * }
+ * ```
+ *
+ * @see {@link IImagesQueryRepository} for repository interface
+ * @see {@link DuplicateError} for duplicate handling
+ */
 export class ImagesDomainService {
     imagesQueryRepository;
+    /**
+     * Creates a new ImagesDomainService instance.
+     *
+     * @param imagesQueryRepository - The query repository for checking duplicates
+     */
     constructor(imagesQueryRepository) {
         this.imagesQueryRepository = imagesQueryRepository;
     }
+    /**
+     * Validates that no image with the same path exists for the user.
+     *
+     * @param path - The path to check for duplicates
+     * @param userId - The user ID for tenant isolation
+     * @throws {DuplicateError} When an image with this path already exists
+     *
+     * @remarks
+     * This is a domain invariant check that should be called before creating images.
+     */
     async ensureNoDuplicate(path, userId) {
         return ensureNoDuplicateImage(this.imagesQueryRepository, path, userId);
     }

package/dist/images/services/images-domain-service.js.map

@@ -1 +1 @@
-{"version":3,"file":"images-domain-service.js","sourceRoot":"","sources":["../../../images/services/images-domain-service.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAI5D,KAAK,UAAU,sBAAsB,CACpC,qBAA6C,EAC7C,IAAU,EACV,MAAc;IAEd,MAAM,MAAM,GAAG,MAAM,qBAAqB,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACpE,IAAI,MAAM,KAAK,IAAI;QAAE,MAAM,IAAI,cAAc,EAAE,CAAC;AACjD,CAAC;AAED,MAAM,OAAO,mBAAmB;IACF;IAA7B,YAA6B,qBAA6C;QAA7C,0BAAqB,GAArB,qBAAqB,CAAwB;IAAG,CAAC;IAEvE,KAAK,CAAC,iBAAiB,CAAC,IAAU,EAAE,MAAc;QACxD,OAAO,sBAAsB,CAAC,IAAI,CAAC,qBAAqB,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IACzE,CAAC;CACD"}
+{"version":3,"file":"images-domain-service.js","sourceRoot":"","sources":["../../../images/services/images-domain-service.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAI5D;;;;;;;;;GASG;AACH,KAAK,UAAU,sBAAsB,CACpC,qBAA6C,EAC7C,IAAU,EACV,MAAc;IAEd,MAAM,MAAM,GAAG,MAAM,qBAAqB,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACpE,IAAI,MAAM,KAAK,IAAI;QAAE,MAAM,IAAI,cAAc,EAAE,CAAC;AACjD,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,OAAO,mBAAmB;IAMF;IAL7B;;;;OAIG;IACH,YAA6B,qBAA6C;QAA7C,0BAAqB,GAArB,qBAAqB,CAAwB;IAAG,CAAC;IAE9E;;;;;;;;;OASG;IACI,KAAK,CAAC,iBAAiB,CAAC,IAAU,EAAE,MAAc;QACxD,OAAO,sBAAsB,CAAC,IAAI,CAAC,qBAAqB,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;IACzE,CAAC;CACD"}

package/dist/images/types/cache-strategy.d.ts

@@ -1,6 +1,25 @@
+/**
+ * Cache configuration for repository queries.
+ *
+ * @remarks
+ * Provides fine-grained control over caching behavior.
+ * Uses stale-while-revalidate (SWR) pattern for optimal performance.
+ *
+ * @example
+ * ```typescript
+ * const strategy: CacheStrategy = {
+ *   ttl: 60,         // Cache for 60 seconds
+ *   swr: 300,        // Serve stale for 5 minutes while revalidating
+ *   tags: ["images"] // Cache tags for invalidation
+ * };
+ * ```
+ */
 export type CacheStrategy = {
+    /** Time-to-live in seconds */
     ttl?: number;
+    /** Stale-while-revalidate duration in seconds */
     swr?: number;
+    /** Cache tags for targeted invalidation */
     tags?: string[];
 };
 //# sourceMappingURL=cache-strategy.d.ts.map

package/dist/images/types/cache-strategy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cache-strategy.d.ts","sourceRoot":"","sources":["../../../images/types/cache-strategy.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,aAAa,GAAG;IAC3B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CAChB,CAAC"}
+{"version":3,"file":"cache-strategy.d.ts","sourceRoot":"","sources":["../../../images/types/cache-strategy.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,aAAa,GAAG;IAC3B,8BAA8B;IAC9B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,iDAAiD;IACjD,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,2CAA2C;IAC3C,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CAChB,CAAC"}

package/dist/images/types/query-params.d.ts

@@ -1,14 +1,55 @@
 import type { CacheStrategy } from "./cache-strategy";
 import type { SortOrder } from "./sort-order";
-type ImagesOrderByField = "id" | "path" | "contentType" | "fileSize" | "width" | "height" | "tags" | "description" | "status" | "createdAt" | "updatedAt" | "exportedAt";
-type ImagesOrderBy = {
+/**
+ * Available fields for sorting image queries.
+ *
+ * @remarks
+ * All fields correspond to Image entity properties.
+ * Used with {@link ImagesOrderBy} to specify sort criteria.
+ */
+export type ImagesOrderByField = "id" | "path" | "contentType" | "fileSize" | "width" | "height" | "tags" | "description" | "status" | "createdAt" | "updatedAt" | "exportedAt";
+/**
+ * Sort configuration for image queries.
+ *
+ * @remarks
+ * Maps field names to sort directions.
+ * Typically only one field should be specified at a time.
+ *
+ * @example
+ * ```typescript
+ * const orderBy: ImagesOrderBy = { createdAt: "desc" };
+ * ```
+ *
+ * @see {@link ImagesOrderByField} for available fields
+ * @see {@link SortOrder} for sort directions
+ */
+export type ImagesOrderBy = {
     [K in ImagesOrderByField]?: SortOrder;
 };
+/**
+ * Parameters for paginated image queries.
+ *
+ * @example
+ * ```typescript
+ * const params: ImagesFindManyParams = {
+ *   orderBy: { createdAt: "desc" },
+ *   take: 20,
+ *   skip: 0,
+ *   cacheStrategy: { ttl: 60, tags: ["images"] },
+ * };
+ * ```
+ *
+ * @see {@link ImagesOrderBy} for sorting options
+ * @see {@link CacheStrategy} for caching configuration
+ */
 export type ImagesFindManyParams = {
+    /** Sort configuration */
     orderBy?: ImagesOrderBy;
+    /** Maximum number of results to return */
     take?: number;
+    /** Number of results to skip (for pagination) */
     skip?: number;
+    /** Caching configuration for the query */
     cacheStrategy?: CacheStrategy;
 };
-export {};
 //# sourceMappingURL=query-params.d.ts.map

package/dist/images/types/query-params.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"query-params.d.ts","sourceRoot":"","sources":["../../../images/types/query-params.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAE9C,KAAK,kBAAkB,GACpB,IAAI,GACJ,MAAM,GACN,aAAa,GACb,UAAU,GACV,OAAO,GACP,QAAQ,GACR,MAAM,GACN,aAAa,GACb,QAAQ,GACR,WAAW,GACX,WAAW,GACX,YAAY,CAAC;AAEhB,KAAK,aAAa,GAAG;KACnB,CAAC,IAAI,kBAAkB,CAAC,CAAC,EAAE,SAAS;CACrC,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IAClC,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE,aAAa,CAAC;CAC9B,CAAC"}
+{"version":3,"file":"query-params.d.ts","sourceRoot":"","sources":["../../../images/types/query-params.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACtD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAE9C;;;;;;GAMG;AACH,MAAM,MAAM,kBAAkB,GAC3B,IAAI,GACJ,MAAM,GACN,aAAa,GACb,UAAU,GACV,OAAO,GACP,QAAQ,GACR,MAAM,GACN,aAAa,GACb,QAAQ,GACR,WAAW,GACX,WAAW,GACX,YAAY,CAAC;AAEhB;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,aAAa,GAAG;KAC1B,CAAC,IAAI,kBAAkB,CAAC,CAAC,EAAE,SAAS;CACrC,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,oBAAoB,GAAG;IAClC,yBAAyB;IACzB,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,0CAA0C;IAC1C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,iDAAiD;IACjD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,0CAA0C;IAC1C,aAAa,CAAC,EAAE,aAAa,CAAC;CAC9B,CAAC"}

package/dist/images/types/sort-order.d.ts

@@ -1,2 +1,14 @@
+/**
+ * Sort direction for query ordering.
+ *
+ * @remarks
+ * Standard SQL-style sort order used across all domain queries.
+ *
+ * @example
+ * ```typescript
+ * const ascending: SortOrder = "asc";
+ * const descending: SortOrder = "desc";
+ * ```
+ */
 export type SortOrder = "asc" | "desc";
 //# sourceMappingURL=sort-order.d.ts.map

package/dist/images/types/sort-order.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sort-order.d.ts","sourceRoot":"","sources":["../../../images/types/sort-order.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG,KAAK,GAAG,MAAM,CAAC"}
+{"version":3,"file":"sort-order.d.ts","sourceRoot":"","sources":["../../../images/types/sort-order.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,SAAS,GAAG,KAAK,GAAG,MAAM,CAAC"}

package/dist/index.d.ts

@@ -1,3 +1,33 @@
+/**
+ * @packageDocumentation
+ *
+ * Core domain library for the content management system.
+ *
+ * @remarks
+ * This package provides domain entities, repositories, services, and events
+ * following Domain-Driven Design (DDD) and Clean Architecture principles.
+ *
+ * ## Domains
+ *
+ * - **Articles** - News and link management with OG metadata
+ * - **Books** - ISBN-based book tracking with Google Books integration
+ * - **Notes** - Markdown-based content creation
+ * - **Images** - File metadata and image processing
+ * - **Common** - Shared entities, events, and services
+ * - **Errors** - Domain-specific error classes
+ *
+ * @example
+ * ```typescript
+ * import { Articles, Books, Notes, Images, Common, Errors } from "@repo/core";
+ *
+ * // Create an article
+ * const article = Articles.articleEntity.create({
+ *   userId: Common.makeUserId("user-123"),
+ *   title: Articles.makeArticleTitle("My Article"),
+ *   url: Articles.makeUrl("https://example.com"),
+ * });
+ * ```
+ */
 export * as Articles from "./articles";
 export * as Books from "./books";
 export * as Common from "./common";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AACjC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAGH,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AACjC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC"}

package/dist/index.js

@@ -1,3 +1,33 @@
+/**
+ * @packageDocumentation
+ *
+ * Core domain library for the content management system.
+ *
+ * @remarks
+ * This package provides domain entities, repositories, services, and events
+ * following Domain-Driven Design (DDD) and Clean Architecture principles.
+ *
+ * ## Domains
+ *
+ * - **Articles** - News and link management with OG metadata
+ * - **Books** - ISBN-based book tracking with Google Books integration
+ * - **Notes** - Markdown-based content creation
+ * - **Images** - File metadata and image processing
+ * - **Common** - Shared entities, events, and services
+ * - **Errors** - Domain-specific error classes
+ *
+ * @example
+ * ```typescript
+ * import { Articles, Books, Notes, Images, Common, Errors } from "@repo/core";
+ *
+ * // Create an article
+ * const article = Articles.articleEntity.create({
+ *   userId: Common.makeUserId("user-123"),
+ *   title: Articles.makeArticleTitle("My Article"),
+ *   url: Articles.makeUrl("https://example.com"),
+ * });
+ * ```
+ */
 // Domain exports with namespaces
 export * as Articles from "./articles";
 export * as Books from "./books";

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,iCAAiC;AACjC,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AACjC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AAEH,iCAAiC;AACjC,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AACvC,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AACjC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,KAAK,MAAM,MAAM,UAAU,CAAC;AACnC,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC"}