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

package/dist/notes/index.d.ts

@@ -1,3 +1,35 @@
+/**
+ * @packageDocumentation
+ *
+ * Notes domain for markdown-based content creation.
+ *
+ * @remarks
+ * Provides complete domain implementation for note management including:
+ *
+ * - **Entities** - Note 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
+ *
+ * Notes support markdown content with titles for organizing personal knowledge.
+ *
+ * @example
+ * ```typescript
+ * import {
+ *   noteEntity,
+ *   makeNoteTitle,
+ *   makeMarkdown,
+ *   NoteCreatedEvent,
+ * } from "@repo/core/notes";
+ *
+ * const note = noteEntity.create({
+ *   userId: makeUserId("user-123"),
+ *   title: makeNoteTitle("Meeting Notes"),
+ *   content: makeMarkdown("# Agenda\n- Item 1\n- Item 2"),
+ * });
+ * ```
+ */
 export * from "./entities/note-entity";
 export * from "./events/note-created-event";
 export * from "./events/note-deleted-event";

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../notes/index.ts"],"names":[],"mappings":"AACA,cAAc,wBAAwB,CAAC;AAGvC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,6BAA6B,CAAC;AAG5C,cAAc,mDAAmD,CAAC;AAClE,cAAc,iDAAiD,CAAC;AAGhE,cAAc,iCAAiC,CAAC;AAGhD,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../notes/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AAGH,cAAc,wBAAwB,CAAC;AAGvC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,6BAA6B,CAAC;AAG5C,cAAc,mDAAmD,CAAC;AAClE,cAAc,iDAAiD,CAAC;AAGhE,cAAc,iCAAiC,CAAC;AAGhD,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC"}

package/dist/notes/index.js

@@ -1,3 +1,35 @@
+/**
+ * @packageDocumentation
+ *
+ * Notes domain for markdown-based content creation.
+ *
+ * @remarks
+ * Provides complete domain implementation for note management including:
+ *
+ * - **Entities** - Note 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
+ *
+ * Notes support markdown content with titles for organizing personal knowledge.
+ *
+ * @example
+ * ```typescript
+ * import {
+ *   noteEntity,
+ *   makeNoteTitle,
+ *   makeMarkdown,
+ *   NoteCreatedEvent,
+ * } from "@repo/core/notes";
+ *
+ * const note = noteEntity.create({
+ *   userId: makeUserId("user-123"),
+ *   title: makeNoteTitle("Meeting Notes"),
+ *   content: makeMarkdown("# Agenda\n- Item 1\n- Item 2"),
+ * });
+ * ```
+ */
 // Entities
 export * from "./entities/note-entity";
 // Events

package/dist/notes/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../notes/index.ts"],"names":[],"mappings":"AAAA,WAAW;AACX,cAAc,wBAAwB,CAAC;AAEvC,SAAS;AACT,cAAc,6BAA6B,CAAC;AAC5C,cAAc,6BAA6B,CAAC;AAE5C,eAAe;AACf,cAAc,mDAAmD,CAAC;AAClE,cAAc,iDAAiD,CAAC;AAEhE,WAAW;AACX,cAAc,iCAAiC,CAAC;AAEhD,QAAQ;AACR,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../notes/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AAEH,WAAW;AACX,cAAc,wBAAwB,CAAC;AAEvC,SAAS;AACT,cAAc,6BAA6B,CAAC;AAC5C,cAAc,6BAA6B,CAAC;AAE5C,eAAe;AACf,cAAc,mDAAmD,CAAC;AAClE,cAAc,iDAAiD,CAAC;AAEhE,WAAW;AACX,cAAc,iCAAiC,CAAC;AAEhD,QAAQ;AACR,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC"}

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

@@ -1,7 +1,44 @@
 import type { Id, Status, UserId } from "../../common/entities/common-entity";
 import type { UnexportedNote } from "../entities/note-entity";
+/**
+ * Command repository interface for the Note 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 PrismaNotesCommandRepository implements INotesCommandRepository {
+ *   async create(data: UnexportedNote) {
+ *     await prisma.note.create({ data });
+ *   }
+ *
+ *   async deleteById(id: Id, userId: UserId, status: Status) {
+ *     await prisma.note.delete({
+ *       where: { id, userId, status }
+ *     });
+ *   }
+ * }
+ * ```
+ *
+ * @see {@link INotesQueryRepository} for read operations
+ */
 export type INotesCommandRepository = {
+    /**
+     * Creates a new note in the repository.
+     *
+     * @param data - The unexported note entity to persist
+     */
     create(data: UnexportedNote): Promise<void>;
+    /**
+     * Deletes a note by its ID.
+     *
+     * @param id - The note ID to delete
+     * @param userId - The user ID for tenant isolation
+     * @param status - The expected status of the note
+     */
     deleteById(id: Id, userId: UserId, status: Status): Promise<void>;
 };
 //# sourceMappingURL=notes-command-repository.interface.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"notes-command-repository.interface.d.ts","sourceRoot":"","sources":["../../../notes/repositories/notes-command-repository.interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAE9D,MAAM,MAAM,uBAAuB,GAAG;IACrC,MAAM,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5C,UAAU,CAAC,EAAE,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAClE,CAAC"}
+{"version":3,"file":"notes-command-repository.interface.d.ts","sourceRoot":"","sources":["../../../notes/repositories/notes-command-repository.interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAE9D;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACrC;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5C;;;;;;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/notes/repositories/notes-query-repository.interface.d.ts

@@ -1,18 +1,71 @@
 import type { Status, UserId } from "../../common/entities/common-entity";
 import type { NoteTitle } from "../entities/note-entity";
 import type { NotesFindManyParams } from "../types/query-params";
+/**
+ * Query repository interface for the Note 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 PrismaNotesQueryRepository implements INotesQueryRepository {
+ *   async findByTitle(title: NoteTitle, userId: UserId) {
+ *     return await prisma.note.findUnique({
+ *       where: { title, userId }
+ *     });
+ *   }
+ * }
+ * ```
+ *
+ * @see {@link INotesCommandRepository} for write operations
+ */
 export type INotesQueryRepository = {
+    /**
+     * Finds a note by its title for a specific user.
+     *
+     * @param title - The validated title to search for
+     * @param userId - The user ID for tenant isolation
+     * @returns The note data if found, null otherwise
+     */
     findByTitle(title: NoteTitle, userId: UserId): Promise<{
         id: string;
         title: string;
         markdown: string;
         status: string;
     } | null>;
+    /**
+     * Retrieves multiple notes 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 note data objects
+     *
+     * @see {@link NotesFindManyParams} for parameter options
+     */
     findMany(userId: UserId, status: Status, params: NotesFindManyParams): Promise<Array<{
         id: string;
         title: string;
     }>>;
+    /**
+     * Counts notes matching the given criteria.
+     *
+     * @param userId - The user ID for tenant isolation
+     * @param status - Filter by status
+     * @returns The count of matching notes
+     */
     count(userId: UserId, status: Status): Promise<number>;
+    /**
+     * Searches notes by text query.
+     *
+     * @param query - The search query string
+     * @param userId - The user ID for tenant isolation
+     * @param limit - Optional maximum number of results
+     * @returns Array of matching note data objects
+     */
     search(query: string, userId: UserId, limit?: number): Promise<{
         id: string;
         title: string;

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

@@ -1 +1 @@
-{"version":3,"file":"notes-query-repository.interface.d.ts","sourceRoot":"","sources":["../../../notes/repositories/notes-query-repository.interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAC1E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,MAAM,MAAM,qBAAqB,GAAG;IACnC,WAAW,CACV,KAAK,EAAE,SAAS,EAChB,MAAM,EAAE,MAAM,GACZ,OAAO,CAAC;QACV,EAAE,EAAE,MAAM,CAAC;QACX,KAAK,EAAE,MAAM,CAAC;QACd,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,MAAM,CAAC;KACf,GAAG,IAAI,CAAC,CAAC;IACV,QAAQ,CACP,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,mBAAmB,GACzB,OAAO,CAAC,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC,CAAC;IACjD,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,QAAQ,EAAE,MAAM,CAAC;KACjB,EAAE,CACH,CAAC;CACF,CAAC"}
+{"version":3,"file":"notes-query-repository.interface.d.ts","sourceRoot":"","sources":["../../../notes/repositories/notes-query-repository.interface.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAC1E,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,MAAM,qBAAqB,GAAG;IACnC;;;;;;OAMG;IACH,WAAW,CACV,KAAK,EAAE,SAAS,EAChB,MAAM,EAAE,MAAM,GACZ,OAAO,CAAC;QACV,EAAE,EAAE,MAAM,CAAC;QACX,KAAK,EAAE,MAAM,CAAC;QACd,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,MAAM,CAAC;KACf,GAAG,IAAI,CAAC,CAAC;IAEV;;;;;;;;;OASG;IACH,QAAQ,CACP,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,mBAAmB,GACzB,OAAO,CAAC,KAAK,CAAC;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC,CAAC;IAEjD;;;;;;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,QAAQ,EAAE,MAAM,CAAC;KACjB,EAAE,CACH,CAAC;CACF,CAAC"}

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

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

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

@@ -1 +1 @@
-{"version":3,"file":"notes-domain-service.d.ts","sourceRoot":"","sources":["../../../notes/services/notes-domain-service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAElE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,kDAAkD,CAAC;AAa9F,qBAAa,kBAAkB;IAClB,OAAO,CAAC,QAAQ,CAAC,oBAAoB;gBAApB,oBAAoB,EAAE,qBAAqB;IAE3D,iBAAiB,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM;CAG/D"}
+{"version":3,"file":"notes-domain-service.d.ts","sourceRoot":"","sources":["../../../notes/services/notes-domain-service.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAElE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,kDAAkD,CAAC;AAuB9F;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,qBAAa,kBAAkB;IAMlB,OAAO,CAAC,QAAQ,CAAC,oBAAoB;IALjD;;;;OAIG;gBAC0B,oBAAoB,EAAE,qBAAqB;IAExE;;;;;;;;;OASG;IACU,iBAAiB,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM;CAG/D"}

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

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

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

@@ -1 +1 @@
-{"version":3,"file":"notes-domain-service.js","sourceRoot":"","sources":["../../../notes/services/notes-domain-service.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAI5D,KAAK,UAAU,qBAAqB,CACnC,oBAA2C,EAC3C,KAAgB,EAChB,MAAc;IAEd,MAAM,MAAM,GAAG,MAAM,oBAAoB,CAAC,WAAW,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACrE,IAAI,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,cAAc,EAAE,CAAC;IAC5B,CAAC;AACF,CAAC;AAED,MAAM,OAAO,kBAAkB;IACD;IAA7B,YAA6B,oBAA2C;QAA3C,yBAAoB,GAApB,oBAAoB,CAAuB;IAAG,CAAC;IAErE,KAAK,CAAC,iBAAiB,CAAC,KAAgB,EAAE,MAAc;QAC9D,OAAO,qBAAqB,CAAC,IAAI,CAAC,oBAAoB,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;IACxE,CAAC;CACD"}
+{"version":3,"file":"notes-domain-service.js","sourceRoot":"","sources":["../../../notes/services/notes-domain-service.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAI5D;;;;;;;;;GASG;AACH,KAAK,UAAU,qBAAqB,CACnC,oBAA2C,EAC3C,KAAgB,EAChB,MAAc;IAEd,MAAM,MAAM,GAAG,MAAM,oBAAoB,CAAC,WAAW,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACrE,IAAI,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,cAAc,EAAE,CAAC;IAC5B,CAAC;AACF,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,OAAO,kBAAkB;IAMD;IAL7B;;;;OAIG;IACH,YAA6B,oBAA2C;QAA3C,yBAAoB,GAApB,oBAAoB,CAAuB;IAAG,CAAC;IAE5E;;;;;;;;;OASG;IACI,KAAK,CAAC,iBAAiB,CAAC,KAAgB,EAAE,MAAc;QAC9D,OAAO,qBAAqB,CAAC,IAAI,CAAC,oBAAoB,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;IACxE,CAAC;CACD"}

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

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

@@ -1,14 +1,55 @@
 import type { CacheStrategy } from "./cache-strategy";
 import type { SortOrder } from "./sort-order";
-type NotesOrderByField = "id" | "title" | "markdown" | "status" | "createdAt" | "updatedAt" | "exportedAt";
-type NotesOrderBy = {
+/**
+ * Available fields for sorting note queries.
+ *
+ * @remarks
+ * All fields correspond to Note entity properties.
+ * Used with {@link NotesOrderBy} to specify sort criteria.
+ */
+export type NotesOrderByField = "id" | "title" | "markdown" | "status" | "createdAt" | "updatedAt" | "exportedAt";
+/**
+ * Sort configuration for note queries.
+ *
+ * @remarks
+ * Maps field names to sort directions.
+ * Typically only one field should be specified at a time.
+ *
+ * @example
+ * ```typescript
+ * const orderBy: NotesOrderBy = { createdAt: "desc" };
+ * ```
+ *
+ * @see {@link NotesOrderByField} for available fields
+ * @see {@link SortOrder} for sort directions
+ */
+export type NotesOrderBy = {
     [K in NotesOrderByField]?: SortOrder;
 };
+/**
+ * Parameters for paginated note queries.
+ *
+ * @example
+ * ```typescript
+ * const params: NotesFindManyParams = {
+ *   orderBy: { createdAt: "desc" },
+ *   take: 20,
+ *   skip: 0,
+ *   cacheStrategy: { ttl: 60, tags: ["notes"] },
+ * };
+ * ```
+ *
+ * @see {@link NotesOrderBy} for sorting options
+ * @see {@link CacheStrategy} for caching configuration
+ */
 export type NotesFindManyParams = {
+    /** Sort configuration */
     orderBy?: NotesOrderBy;
+    /** 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/notes/types/query-params.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"query-params.d.ts","sourceRoot":"","sources":["../../../notes/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,iBAAiB,GACnB,IAAI,GACJ,OAAO,GACP,UAAU,GACV,QAAQ,GACR,WAAW,GACX,WAAW,GACX,YAAY,CAAC;AAEhB,KAAK,YAAY,GAAG;KAClB,CAAC,IAAI,iBAAiB,CAAC,CAAC,EAAE,SAAS;CACpC,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IACjC,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB,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":["../../../notes/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,iBAAiB,GAC1B,IAAI,GACJ,OAAO,GACP,UAAU,GACV,QAAQ,GACR,WAAW,GACX,WAAW,GACX,YAAY,CAAC;AAEhB;;;;;;;;;;;;;;GAcG;AACH,MAAM,MAAM,YAAY,GAAG;KACzB,CAAC,IAAI,iBAAiB,CAAC,CAAC,EAAE,SAAS;CACpC,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,mBAAmB,GAAG;IACjC,yBAAyB;IACzB,OAAO,CAAC,EAAE,YAAY,CAAC;IACvB,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/notes/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/notes/types/sort-order.d.ts.map

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