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

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

@@ -1,7 +1,44 @@
 import type { Id, Status, UserId } from "../../common/entities/common-entity";
 import type { UnexportedArticle } from "../entities/article-entity";
+/**
+ * Command repository interface for the Article domain.
+ *
+ * @remarks
+ * Follows the CQRS pattern - this interface handles write operations only.
+ * Implementations should be provided by the infrastructure layer (e.g., Prisma).
+ *
+ * @example
+ * ```typescript
+ * // Infrastructure implementation
+ * class PrismaArticlesCommandRepository implements IArticlesCommandRepository {
+ *   async create(data: UnexportedArticle) {
+ *     await prisma.article.create({ data });
+ *   }
+ *
+ *   async deleteById(id: Id, userId: UserId, status: Status) {
+ *     await prisma.article.delete({
+ *       where: { id, userId, status }
+ *     });
+ *   }
+ * }
+ * ```
+ *
+ * @see {@link IArticlesQueryRepository} for read operations
+ */
 export type IArticlesCommandRepository = {
+    /**
+     * Creates a new article in the repository.
+     *
+     * @param data - The unexported article entity to persist
+     */
     create(data: UnexportedArticle): Promise<void>;
+    /**
+     * Deletes an article by its ID.
+     *
+     * @param id - The article ID to delete
+     * @param userId - The user ID for tenant isolation
+     * @param status - The expected status of the article
+     */
     deleteById(id: Id, userId: UserId, status: Status): Promise<void>;
 };
 //# sourceMappingURL=articles-command-repository.interface.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"articles-command-repository.interface.d.ts","sourceRoot":"","sources":["../../../articles/repositories/articles-command-repository.interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAEpE,MAAM,MAAM,0BAA0B,GAAG;IACxC,MAAM,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/C,UAAU,CAAC,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAClE,CAAC"}
+{"version":3,"file":"articles-command-repository.interface.d.ts","sourceRoot":"","sources":["../../../articles/repositories/articles-command-repository.interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAEpE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACxC;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/C;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAClE,CAAC"}

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

@@ -1,7 +1,35 @@
 import type { Status, UserId } from "../../common/entities/common-entity";
 import type { Url } from "../entities/article-entity";
 import type { ArticlesFindManyParams } from "../types/query-params";
+/**
+ * Query repository interface for the Article domain.
+ *
+ * @remarks
+ * Follows the CQRS pattern - this interface handles read operations only.
+ * Implementations should be provided by the infrastructure layer (e.g., Prisma).
+ *
+ * @example
+ * ```typescript
+ * // Infrastructure implementation
+ * class PrismaArticlesQueryRepository implements IArticlesQueryRepository {
+ *   async findByUrl(url: Url, userId: UserId) {
+ *     return await prisma.article.findUnique({
+ *       where: { url, userId }
+ *     });
+ *   }
+ * }
+ * ```
+ *
+ * @see {@link IArticlesCommandRepository} for write operations
+ */
 export type IArticlesQueryRepository = {
+    /**
+     * Finds an article by its URL for a specific user.
+     *
+     * @param url - The validated URL to search for
+     * @param userId - The user ID for tenant isolation
+     * @returns The article data if found, null otherwise
+     */
     findByUrl(url: Url, userId: UserId): Promise<{
         title: string;
         url: string;
@@ -15,6 +43,16 @@ export type IArticlesQueryRepository = {
             name: string;
         };
     } | null>;
+    /**
+     * Retrieves multiple articles with pagination and filtering.
+     *
+     * @param userId - The user ID for tenant isolation
+     * @param status - Filter by UNEXPORTED or EXPORTED status
+     * @param params - Pagination, sorting, and caching parameters
+     * @returns Array of article data objects
+     *
+     * @see {@link ArticlesFindManyParams} for parameter options
+     */
     findMany(userId: UserId, status: Status, params: ArticlesFindManyParams): Promise<{
         id: string;
         title: string;
@@ -27,7 +65,22 @@ export type IArticlesQueryRepository = {
             name: string;
         };
     }[]>;
+    /**
+     * Counts articles matching the given criteria.
+     *
+     * @param userId - The user ID for tenant isolation
+     * @param status - Filter by status
+     * @returns The count of matching articles
+     */
     count(userId: UserId, status: Status): Promise<number>;
+    /**
+     * Searches articles by text query.
+     *
+     * @param query - The search query string
+     * @param userId - The user ID for tenant isolation
+     * @param limit - Optional maximum number of results (default varies by implementation)
+     * @returns Array of matching article data objects
+     */
     search(query: string, userId: UserId, limit?: number): Promise<{
         id: string;
         title: string;

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

@@ -1 +1 @@
-{"version":3,"file":"articles-query-repository.interface.d.ts","sourceRoot":"","sources":["../../../articles/repositories/articles-query-repository.interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAC1E,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAEpE,MAAM,MAAM,wBAAwB,GAAG;IACtC,SAAS,CACR,GAAG,EAAE,GAAG,EACR,MAAM,EAAE,MAAM,GACZ,OAAO,CAAC;QACV,KAAK,EAAE,MAAM,CAAC;QACd,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QACrB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QACvB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAC7B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAC1B,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE;YACT,EAAE,EAAE,MAAM,CAAC;YACX,IAAI,EAAE,MAAM,CAAC;SACb,CAAC;KACF,GAAG,IAAI,CAAC,CAAC;IACV,QAAQ,CACP,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,sBAAsB,GAC5B,OAAO,CACT;QACC,EAAE,EAAE,MAAM,CAAC;QACX,KAAK,EAAE,MAAM,CAAC;QACd,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QACrB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QACvB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAC7B,QAAQ,EAAE;YACT,EAAE,EAAE,MAAM,CAAC;YACX,IAAI,EAAE,MAAM,CAAC;SACb,CAAC;KACF,EAAE,CACH,CAAC;IACF,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACvD,MAAM,CACL,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,KAAK,CAAC,EAAE,MAAM,GACZ,OAAO,CACT;QACC,EAAE,EAAE,MAAM,CAAC;QACX,KAAK,EAAE,MAAM,CAAC;QACd,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QACrB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QACvB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAC7B,QAAQ,EAAE;YAAE,EAAE,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAA;SAAE,CAAC;KACvC,EAAE,CACH,CAAC;CACF,CAAC"}
+{"version":3,"file":"articles-query-repository.interface.d.ts","sourceRoot":"","sources":["../../../articles/repositories/articles-query-repository.interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAC1E,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAEpE;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACtC;;;;;;OAMG;IACH,SAAS,CACR,GAAG,EAAE,GAAG,EACR,MAAM,EAAE,MAAM,GACZ,OAAO,CAAC;QACV,KAAK,EAAE,MAAM,CAAC;QACd,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QACrB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QACvB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAC7B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;QAC1B,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE;YACT,EAAE,EAAE,MAAM,CAAC;YACX,IAAI,EAAE,MAAM,CAAC;SACb,CAAC;KACF,GAAG,IAAI,CAAC,CAAC;IAEV;;;;;;;;;OASG;IACH,QAAQ,CACP,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,sBAAsB,GAC5B,OAAO,CACT;QACC,EAAE,EAAE,MAAM,CAAC;QACX,KAAK,EAAE,MAAM,CAAC;QACd,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QACrB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QACvB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAC7B,QAAQ,EAAE;YACT,EAAE,EAAE,MAAM,CAAC;YACX,IAAI,EAAE,MAAM,CAAC;SACb,CAAC;KACF,EAAE,CACH,CAAC;IAEF;;;;;;OAMG;IACH,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAEvD;;;;;;;OAOG;IACH,MAAM,CACL,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,KAAK,CAAC,EAAE,MAAM,GACZ,OAAO,CACT;QACC,EAAE,EAAE,MAAM,CAAC;QACX,KAAK,EAAE,MAAM,CAAC;QACd,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QACrB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;QACvB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAC7B,QAAQ,EAAE;YAAE,EAAE,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAA;SAAE,CAAC;KACvC,EAAE,CACH,CAAC;CACF,CAAC"}

package/dist/articles/repositories/category-query-repository.interface.d.ts

@@ -1,6 +1,35 @@
 import type { UserId } from "../../common/entities/common-entity";
 import type { CategoryFindManyParams } from "../types/query-params";
+/**
+ * Query repository interface for the Category domain.
+ *
+ * @remarks
+ * Provides read-only access to categories.
+ * Categories are used to organize articles into logical groups.
+ *
+ * @example
+ * ```typescript
+ * // Infrastructure implementation
+ * class PrismaCategoryQueryRepository implements ICategoryQueryRepository {
+ *   async findMany(userId: UserId, params?: CategoryFindManyParams) {
+ *     return await prisma.category.findMany({
+ *       where: { userId },
+ *       ...params
+ *     });
+ *   }
+ * }
+ * ```
+ *
+ * @see {@link CategoryFindManyParams} for query parameters
+ */
 export type ICategoryQueryRepository = {
+    /**
+     * Retrieves multiple categories with optional pagination and sorting.
+     *
+     * @param userId - The user ID for tenant isolation
+     * @param params - Optional pagination and sorting parameters
+     * @returns Array of category data objects
+     */
     findMany(userId: UserId, params?: CategoryFindManyParams): Promise<{
         id: string;
         name: string;

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

@@ -1 +1 @@
-{"version":3,"file":"category-query-repository.interface.d.ts","sourceRoot":"","sources":["../../../articles/repositories/category-query-repository.interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAClE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAEpE,MAAM,MAAM,wBAAwB,GAAG;IACtC,QAAQ,CACP,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,sBAAsB,GAC7B,OAAO,CACT;QACC,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;KACb,EAAE,CACH,CAAC;CACF,CAAC"}
+{"version":3,"file":"category-query-repository.interface.d.ts","sourceRoot":"","sources":["../../../articles/repositories/category-query-repository.interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAClE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,uBAAuB,CAAC;AAEpE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACtC;;;;;;OAMG;IACH,QAAQ,CACP,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,sBAAsB,GAC7B,OAAO,CACT;QACC,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;KACb,EAAE,CACH,CAAC;CACF,CAAC"}

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

@@ -1,9 +1,49 @@
 import type { UserId } from "../../common/entities/common-entity";
 import type { Url } from "../entities/article-entity";
 import type { IArticlesQueryRepository } from "../repositories/articles-query-repository.interface";
+/**
+ * Domain service for Article 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: IArticlesQueryRepository = new PrismaArticlesQueryRepository();
+ * const domainService = new ArticlesDomainService(queryRepo);
+ *
+ * try {
+ *   await domainService.ensureNoDuplicate(url, userId);
+ *   // Safe to create the article
+ * } catch (error) {
+ *   if (error instanceof DuplicateError) {
+ *     // Handle duplicate URL
+ *   }
+ * }
+ * ```
+ *
+ * @see {@link IArticlesQueryRepository} for repository interface
+ * @see {@link DuplicateError} for duplicate handling
+ */
 export declare class ArticlesDomainService {
     private readonly articlesQueryRepository;
+    /**
+     * Creates a new ArticlesDomainService instance.
+     *
+     * @param articlesQueryRepository - The query repository for checking duplicates
+     */
     constructor(articlesQueryRepository: IArticlesQueryRepository);
+    /**
+     * Validates that no article with the same URL exists for the user.
+     *
+     * @param url - The URL to check for duplicates
+     * @param userId - The user ID for tenant isolation
+     * @throws {DuplicateError} When an article with this URL already exists
+     *
+     * @remarks
+     * This is a domain invariant check that should be called before creating articles.
+     */
     ensureNoDuplicate(url: Url, userId: UserId): Promise<void>;
 }
 //# sourceMappingURL=articles-domain-service.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"articles-domain-service.d.ts","sourceRoot":"","sources":["../../../articles/services/articles-domain-service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAElE,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,qDAAqD,CAAC;AAapG,qBAAa,qBAAqB;IAEhC,OAAO,CAAC,QAAQ,CAAC,uBAAuB;gBAAvB,uBAAuB,EAAE,wBAAwB;IAGtD,iBAAiB,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM;CAGvD"}
+{"version":3,"file":"articles-domain-service.d.ts","sourceRoot":"","sources":["../../../articles/services/articles-domain-service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAElE,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,4BAA4B,CAAC;AACtD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,qDAAqD,CAAC;AAuBpG;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,qBAAa,qBAAqB;IAOhC,OAAO,CAAC,QAAQ,CAAC,uBAAuB;IANzC;;;;OAIG;gBAEe,uBAAuB,EAAE,wBAAwB;IAGnE;;;;;;;;;OASG;IACU,iBAAiB,CAAC,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM;CAGvD"}

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

@@ -1,15 +1,65 @@
 import { DuplicateError } from "../../errors/error-classes";
+/**
+ * Checks if an article with the given URL already exists.
+ *
+ * @param articlesQueryRepository - The query repository to check against
+ * @param url - The URL to check for duplicates
+ * @param userId - The user ID for tenant isolation
+ * @throws {DuplicateError} When an article with this URL already exists
+ *
+ * @internal
+ */
 async function ensureNoDuplicateArticle(articlesQueryRepository, url, userId) {
     const exists = await articlesQueryRepository.findByUrl(url, userId);
     if (exists !== null) {
         throw new DuplicateError();
     }
 }
+/**
+ * Domain service for Article 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: IArticlesQueryRepository = new PrismaArticlesQueryRepository();
+ * const domainService = new ArticlesDomainService(queryRepo);
+ *
+ * try {
+ *   await domainService.ensureNoDuplicate(url, userId);
+ *   // Safe to create the article
+ * } catch (error) {
+ *   if (error instanceof DuplicateError) {
+ *     // Handle duplicate URL
+ *   }
+ * }
+ * ```
+ *
+ * @see {@link IArticlesQueryRepository} for repository interface
+ * @see {@link DuplicateError} for duplicate handling
+ */
 export class ArticlesDomainService {
     articlesQueryRepository;
+    /**
+     * Creates a new ArticlesDomainService instance.
+     *
+     * @param articlesQueryRepository - The query repository for checking duplicates
+     */
     constructor(articlesQueryRepository) {
         this.articlesQueryRepository = articlesQueryRepository;
     }
+    /**
+     * Validates that no article with the same URL exists for the user.
+     *
+     * @param url - The URL to check for duplicates
+     * @param userId - The user ID for tenant isolation
+     * @throws {DuplicateError} When an article with this URL already exists
+     *
+     * @remarks
+     * This is a domain invariant check that should be called before creating articles.
+     */
     async ensureNoDuplicate(url, userId) {
         return ensureNoDuplicateArticle(this.articlesQueryRepository, url, userId);
     }

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

@@ -1 +1 @@
-{"version":3,"file":"articles-domain-service.js","sourceRoot":"","sources":["../../../articles/services/articles-domain-service.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAI5D,KAAK,UAAU,wBAAwB,CACtC,uBAAiD,EACjD,GAAQ,EACR,MAAc;IAEd,MAAM,MAAM,GAAG,MAAM,uBAAuB,CAAC,SAAS,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACpE,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QACrB,MAAM,IAAI,cAAc,EAAE,CAAC;IAC5B,CAAC;AACF,CAAC;AAED,MAAM,OAAO,qBAAqB;IAEf;IADlB,YACkB,uBAAiD;QAAjD,4BAAuB,GAAvB,uBAAuB,CAA0B;IAChE,CAAC;IAEG,KAAK,CAAC,iBAAiB,CAAC,GAAQ,EAAE,MAAc;QACtD,OAAO,wBAAwB,CAAC,IAAI,CAAC,uBAAuB,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;IAC5E,CAAC;CACD"}
+{"version":3,"file":"articles-domain-service.js","sourceRoot":"","sources":["../../../articles/services/articles-domain-service.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAI5D;;;;;;;;;GASG;AACH,KAAK,UAAU,wBAAwB,CACtC,uBAAiD,EACjD,GAAQ,EACR,MAAc;IAEd,MAAM,MAAM,GAAG,MAAM,uBAAuB,CAAC,SAAS,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACpE,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QACrB,MAAM,IAAI,cAAc,EAAE,CAAC;IAC5B,CAAC;AACF,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,OAAO,qBAAqB;IAOf;IANlB;;;;OAIG;IACH,YACkB,uBAAiD;QAAjD,4BAAuB,GAAvB,uBAAuB,CAA0B;IAChE,CAAC;IAEJ;;;;;;;;;OASG;IACI,KAAK,CAAC,iBAAiB,CAAC,GAAQ,EAAE,MAAc;QACtD,OAAO,wBAAwB,CAAC,IAAI,CAAC,uBAAuB,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;IAC5E,CAAC;CACD"}

package/dist/articles/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: ["articles"] // 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/articles/types/cache-strategy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cache-strategy.d.ts","sourceRoot":"","sources":["../../../articles/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":["../../../articles/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/articles/types/query-params.d.ts

@@ -1,23 +1,101 @@
 import type { CacheStrategy } from "./cache-strategy";
 import type { SortOrder } from "./sort-order";
-type ArticleOrderByField = "id" | "title" | "url" | "quote" | "ogImageUrl" | "ogTitle" | "ogDescription" | "status" | "createdAt" | "updatedAt" | "exportedAt";
-type CategoryOrderByField = "id" | "name" | "createdAt" | "updatedAt";
-type ArticleOrderBy = {
+/**
+ * Available fields for sorting article queries.
+ *
+ * @remarks
+ * All fields correspond to Article entity properties.
+ * Used with {@link ArticleOrderBy} to specify sort criteria.
+ */
+export type ArticleOrderByField = "id" | "title" | "url" | "quote" | "ogImageUrl" | "ogTitle" | "ogDescription" | "status" | "createdAt" | "updatedAt" | "exportedAt";
+/**
+ * Available fields for sorting category queries.
+ *
+ * @remarks
+ * Used with {@link CategoryOrderBy} to specify sort criteria.
+ */
+export type CategoryOrderByField = "id" | "name" | "createdAt" | "updatedAt";
+/**
+ * Sort configuration for article queries.
+ *
+ * @remarks
+ * Maps field names to sort directions.
+ * Typically only one field should be specified at a time.
+ *
+ * @example
+ * ```typescript
+ * const orderBy: ArticleOrderBy = { createdAt: "desc" };
+ * ```
+ *
+ * @see {@link ArticleOrderByField} for available fields
+ * @see {@link SortOrder} for sort directions
+ */
+export type ArticleOrderBy = {
     [K in ArticleOrderByField]?: SortOrder;
 };
-type CategoryOrderBy = {
+/**
+ * Sort configuration for category queries.
+ *
+ * @remarks
+ * Maps field names to sort directions.
+ *
+ * @example
+ * ```typescript
+ * const orderBy: CategoryOrderBy = { name: "asc" };
+ * ```
+ *
+ * @see {@link CategoryOrderByField} for available fields
+ * @see {@link SortOrder} for sort directions
+ */
+export type CategoryOrderBy = {
     [K in CategoryOrderByField]?: SortOrder;
 };
+/**
+ * Parameters for paginated article queries.
+ *
+ * @example
+ * ```typescript
+ * const params: ArticlesFindManyParams = {
+ *   orderBy: { createdAt: "desc" },
+ *   take: 20,
+ *   skip: 0,
+ *   cacheStrategy: { ttl: 60, tags: ["articles"] },
+ * };
+ * ```
+ *
+ * @see {@link ArticleOrderBy} for sorting options
+ * @see {@link CacheStrategy} for caching configuration
+ */
 export type ArticlesFindManyParams = {
+    /** Sort configuration */
     orderBy?: ArticleOrderBy;
+    /** Maximum number of results to return */
     take?: number;
+    /** Number of results to skip (for pagination) */
     skip?: number;
+    /** Caching configuration for the query */
     cacheStrategy?: CacheStrategy;
 };
+/**
+ * Parameters for paginated category queries.
+ *
+ * @example
+ * ```typescript
+ * const params: CategoryFindManyParams = {
+ *   orderBy: { name: "asc" },
+ *   take: 50,
+ *   skip: 0,
+ * };
+ * ```
+ *
+ * @see {@link CategoryOrderBy} for sorting options
+ */
 export type CategoryFindManyParams = {
+    /** Sort configuration */
     orderBy?: CategoryOrderBy;
+    /** Maximum number of results to return */
     take?: number;
+    /** Number of results to skip (for pagination) */
     skip?: number;
 };
-export {};
 //# sourceMappingURL=query-params.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"query-params.d.ts","sourceRoot":"","sources":["../../../articles/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,mBAAmB,GACrB,IAAI,GACJ,OAAO,GACP,KAAK,GACL,OAAO,GACP,YAAY,GACZ,SAAS,GACT,eAAe,GACf,QAAQ,GACR,WAAW,GACX,WAAW,GACX,YAAY,CAAC;AAEhB,KAAK,oBAAoB,GAAG,IAAI,GAAG,MAAM,GAAG,WAAW,GAAG,WAAW,CAAC;AAEtE,KAAK,cAAc,GAAG;KACpB,CAAC,IAAI,mBAAmB,CAAC,CAAC,EAAE,SAAS;CACtC,CAAC;AAEF,KAAK,eAAe,GAAG;KACrB,CAAC,IAAI,oBAAoB,CAAC,CAAC,EAAE,SAAS;CACvC,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACpC,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,aAAa,CAAC,EAAE,aAAa,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG;IACpC,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACd,CAAC"}
+{"version":3,"file":"query-params.d.ts","sourceRoot":"","sources":["../../../articles/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,mBAAmB,GAC5B,IAAI,GACJ,OAAO,GACP,KAAK,GACL,OAAO,GACP,YAAY,GACZ,SAAS,GACT,eAAe,GACf,QAAQ,GACR,WAAW,GACX,WAAW,GACX,YAAY,CAAC;AAEhB;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,GAAG,IAAI,GAAG,MAAM,GAAG,WAAW,GAAG,WAAW,CAAC;AAE7E;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,cAAc,GAAG;KAC3B,CAAC,IAAI,mBAAmB,CAAC,CAAC,EAAE,SAAS;CACtC,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,eAAe,GAAG;KAC5B,CAAC,IAAI,oBAAoB,CAAC,CAAC,EAAE,SAAS;CACvC,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACpC,yBAAyB;IACzB,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,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;AAEF;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACpC,yBAAyB;IACzB,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B,0CAA0C;IAC1C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,iDAAiD;IACjD,IAAI,CAAC,EAAE,MAAM,CAAC;CACd,CAAC"}

package/dist/articles/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/articles/types/sort-order.d.ts.map

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