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

package/dist/books/entities/books-entity.js

@@ -1,35 +1,198 @@
 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";
 // Value objects
-const ISBN = z
+/**
+ * Zod schema for validating ISBN identifiers.
+ *
+ * @remarks
+ * Validates that the ISBN is a string of 1-17 characters containing only
+ * digits and hyphens. Supports both ISBN-10 and ISBN-13 formats.
+ *
+ * @example
+ * ```typescript
+ * const isbn = ISBN.parse("978-4-06-521234-5");
+ * const isbn10 = ISBN.parse("4-06-521234-X");
+ * ```
+ *
+ * @see {@link makeISBN} for factory function
+ */
+export const ISBN = z
     .string({ message: "required" })
     .min(1, { message: "required" })
     .max(17, { message: "tooLong" })
     .regex(/^[\d-]+$/, { message: "invalidFormat" })
     .brand();
+/**
+ * Creates a validated ISBN from a string.
+ *
+ * @param v - The raw ISBN string
+ * @returns A branded ISBN value
+ * @throws {ZodError} When validation fails
+ *
+ * @example
+ * ```typescript
+ * const isbn = makeISBN("978-4-06-521234-5");
+ * ```
+ */
 export const makeISBN = (v) => ISBN.parse(v);
-const BookTitle = z
+/**
+ * Zod schema for validating book titles.
+ *
+ * @remarks
+ * Validates that the title is a non-empty string between 1 and 256 characters.
+ *
+ * @example
+ * ```typescript
+ * const title = BookTitle.parse("The Pragmatic Programmer");
+ * ```
+ *
+ * @see {@link makeBookTitle} for factory function
+ */
+export const BookTitle = z
     .string({ message: "required" })
     .min(1, { message: "required" })
     .max(256, { message: "tooLong" })
     .brand();
+/**
+ * Creates a validated BookTitle from a string.
+ *
+ * @param v - The raw title string
+ * @returns A branded BookTitle value
+ * @throws {ZodError} When validation fails (empty or exceeds 256 chars)
+ *
+ * @example
+ * ```typescript
+ * const title = makeBookTitle("The Pragmatic Programmer");
+ * ```
+ */
 export const makeBookTitle = (v) => BookTitle.parse(v);
-const GoogleTitle = z.string().nullable().brand();
+/**
+ * Zod schema for Google Books API title.
+ *
+ * @remarks
+ * Optional string for the title fetched from Google Books API.
+ * Null values are allowed when no Google Books data is available.
+ *
+ * @see {@link makeGoogleTitle} for factory function
+ */
+export const GoogleTitle = z.string().nullable().brand();
+/**
+ * Creates a validated GoogleTitle from a string or null.
+ *
+ * @param v - The Google Books title, null, or undefined
+ * @returns A branded GoogleTitle value
+ */
 export const makeGoogleTitle = (v) => GoogleTitle.parse(v);
-const GoogleSubtitle = z.string().nullable().brand();
+/**
+ * Zod schema for Google Books API subtitle.
+ *
+ * @remarks
+ * Optional string for the subtitle fetched from Google Books API.
+ *
+ * @see {@link makeGoogleSubTitle} for factory function
+ */
+export const GoogleSubtitle = z.string().nullable().brand();
+/**
+ * Creates a validated GoogleSubtitle from a string or null.
+ *
+ * @param v - The Google Books subtitle, null, or undefined
+ * @returns A branded GoogleSubtitle value
+ */
 export const makeGoogleSubTitle = (v) => GoogleSubtitle.parse(v);
-const GoogleAuthors = z.array(z.string()).nullable().brand();
+/**
+ * Zod schema for Google Books API authors list.
+ *
+ * @remarks
+ * Array of author names fetched from Google Books API.
+ * Null when no author information is available.
+ *
+ * @see {@link makeGoogleAuthors} for factory function
+ */
+export const GoogleAuthors = z
+    .array(z.string())
+    .nullable()
+    .brand();
+/**
+ * Creates a validated GoogleAuthors from an array or null.
+ *
+ * @param v - The authors array, null, or undefined
+ * @returns A branded GoogleAuthors value
+ */
 export const makeGoogleAuthors = (v) => GoogleAuthors.parse(v);
-const GoogleDescription = z.string().nullable().brand();
+/**
+ * Zod schema for Google Books API description.
+ *
+ * @remarks
+ * Book description/synopsis fetched from Google Books API.
+ *
+ * @see {@link makeGoogleDescription} for factory function
+ */
+export const GoogleDescription = z
+    .string()
+    .nullable()
+    .brand();
+/**
+ * Creates a validated GoogleDescription from a string or null.
+ *
+ * @param v - The description, null, or undefined
+ * @returns A branded GoogleDescription value
+ */
 export const makeGoogleDescription = (v) => GoogleDescription.parse(v);
-const GoogleImgSrc = z.string().nullable().brand();
+/**
+ * Zod schema for Google Books API cover image URL.
+ *
+ * @remarks
+ * URL to the book cover image from Google Books API.
+ *
+ * @see {@link makeGoogleImgSrc} for factory function
+ */
+export const GoogleImgSrc = z.string().nullable().brand();
+/**
+ * Creates a validated GoogleImgSrc from a string or null.
+ *
+ * @param v - The image URL, null, or undefined
+ * @returns A branded GoogleImgSrc value
+ */
 export const makeGoogleImgSrc = (v) => GoogleImgSrc.parse(v);
-const GoogleHref = z.string().nullable().brand();
+/**
+ * Zod schema for Google Books API link URL.
+ *
+ * @remarks
+ * URL to the book's page on Google Books.
+ *
+ * @see {@link makeGoogleHref} for factory function
+ */
+export const GoogleHref = z.string().nullable().brand();
+/**
+ * Creates a validated GoogleHref from a string or null.
+ *
+ * @param v - The link URL, null, or undefined
+ * @returns A branded GoogleHref value
+ */
 export const makeGoogleHref = (v) => GoogleHref.parse(v);
-const BookMarkdown = z.string().nullable().brand();
+/**
+ * Zod schema for book markdown content.
+ *
+ * @remarks
+ * Markdown-formatted notes or review content for the book.
+ *
+ * @see {@link makeBookMarkdown} for factory function
+ */
+export const BookMarkdown = z.string().nullable().brand();
+/**
+ * Creates a validated BookMarkdown from a string or null.
+ *
+ * @param v - The markdown content or null
+ * @returns A branded BookMarkdown value
+ */
 export const makeBookMarkdown = (v) => BookMarkdown.parse(v);
 // Entities
+/**
+ * Base schema containing common book fields.
+ *
+ * @internal
+ */
 const Base = z.object({
     id: Id,
     userId: UserId,
@@ -44,9 +207,68 @@ const Base = z.object({
     markdown: BookMarkdown.optional(),
     createdAt: CreatedAt,
 });
+/**
+ * Zod schema for an unexported book.
+ *
+ * @remarks
+ * Represents a book that has not yet been published.
+ * This is the initial state of all newly created books.
+ *
+ * @see {@link ExportedBook} for the published state
+ */
 export const UnexportedBook = Base.extend({ status: UnexportedStatus });
-const ExportedBook = Base.extend(ExportedStatus.shape);
+/**
+ * Zod schema for an exported book.
+ *
+ * @remarks
+ * Represents a book that has been published.
+ * Includes the exportedAt timestamp.
+ *
+ * @see {@link UnexportedBook} for the initial state
+ */
+export const ExportedBook = Base.extend(ExportedStatus.shape);
+/**
+ * Zod schema for a book marked for export in the current batch.
+ *
+ * @remarks
+ * Represents a book that has been marked for export but not yet finalized.
+ * This intermediate state allows for batch processing with revert capability.
+ *
+ * @see {@link UnexportedBook} for the initial state
+ * @see {@link ExportedBook} for the final state
+ */
+export const LastUpdatedBook = Base.extend({ status: LastUpdatedStatus });
+/**
+ * Factory object for Book 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 book
+ * const book = bookEntity.create({
+ *   userId: makeUserId("user-123"),
+ *   ISBN: makeISBN("978-4-06-521234-5"),
+ *   title: makeBookTitle("The Pragmatic Programmer"),
+ * });
+ *
+ * // Export the book (changes status to EXPORTED)
+ * const exported = bookEntity.export(book);
+ * ```
+ *
+ * @see {@link CreateBookArgs} for creation parameters
+ */
 export const bookEntity = {
+    /**
+     * Creates a new unexported book entity.
+     *
+     * @param args - The creation arguments containing required fields
+     * @returns A frozen UnexportedBook 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(),
@@ -55,6 +277,14 @@ export const bookEntity = {
             ...args,
         }));
     },
+    /**
+     * Transitions a book from UNEXPORTED to EXPORTED status.
+     *
+     * @param book - The unexported book to export
+     * @returns A frozen ExportedBook with exportedAt timestamp
+     * @throws {InvalidFormatError} When the book state is invalid
+     * @throws {UnexpectedError} For unexpected errors during export
+     */
     export: (book) => {
         return createEntityWithErrorHandling(() => {
             const exportedStatus = makeExportedStatus();
@@ -64,5 +294,60 @@ export const bookEntity = {
             });
         });
     },
+    /**
+     * Marks a book for export in the current batch.
+     *
+     * @remarks
+     * Transitions from UNEXPORTED to LAST_UPDATED status.
+     * This allows for batch processing with revert capability.
+     *
+     * @param book - The unexported book to mark
+     * @returns A frozen LastUpdatedBook
+     * @throws {InvalidFormatError} When the book state is invalid
+     * @throws {UnexpectedError} For unexpected errors
+     */
+    markAsLastUpdated: (book) => {
+        return createEntityWithErrorHandling(() => Object.freeze({
+            ...book,
+            status: "LAST_UPDATED",
+        }));
+    },
+    /**
+     * Reverts a book from LAST_UPDATED back to UNEXPORTED.
+     *
+     * @remarks
+     * Use this when batch processing fails and needs to be rolled back.
+     *
+     * @param book - The last updated book to revert
+     * @returns A frozen UnexportedBook
+     * @throws {InvalidFormatError} When the book state is invalid
+     * @throws {UnexpectedError} For unexpected errors
+     */
+    revert: (book) => {
+        return createEntityWithErrorHandling(() => Object.freeze({
+            ...book,
+            status: "UNEXPORTED",
+        }));
+    },
+    /**
+     * Finalizes a book from LAST_UPDATED to EXPORTED.
+     *
+     * @remarks
+     * Use this after batch processing succeeds to confirm the export.
+     *
+     * @param book - The last updated book to finalize
+     * @returns A frozen ExportedBook with exportedAt timestamp
+     * @throws {InvalidFormatError} When the book state is invalid
+     * @throws {UnexpectedError} For unexpected errors
+     */
+    finalize: (book) => {
+        return createEntityWithErrorHandling(() => {
+            const exportedStatus = makeExportedStatus();
+            return Object.freeze({
+                ...book,
+                ...exportedStatus,
+            });
+        });
+    },
 };
 //# sourceMappingURL=books-entity.js.map

package/dist/books/entities/books-entity.js.map

@@ -1 +1 @@
-{"version":3,"file":"books-entity.js","sourceRoot":"","sources":["../../../books/entities/books-entity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,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;AAErF,gBAAgB;AAEhB,MAAM,IAAI,GAAG,CAAC;KACZ,MAAM,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;KAC/B,GAAG,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;KAC/B,GAAG,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;KAC/B,KAAK,CAAC,UAAU,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC;KAC/C,KAAK,EAAU,CAAC;AAElB,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,CAAS,EAAQ,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAE3D,MAAM,SAAS,GAAG,CAAC;KACjB,MAAM,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;KAC/B,GAAG,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;KAC/B,GAAG,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;KAChC,KAAK,EAAe,CAAC;AAEvB,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAS,EAAa,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAE1E,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAiB,CAAC;AAEjE,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAA4B,EAAe,EAAE,CAC5E,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAEtB,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAoB,CAAC;AAEvE,MAAM,CAAC,MAAM,kBAAkB,GAAG,CACjC,CAA4B,EACX,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAE7C,MAAM,aAAa,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAmB,CAAC;AAE9E,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAChC,CAA8B,EACd,EAAE,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAE3C,MAAM,iBAAiB,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAuB,CAAC;AAE7E,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACpC,CAA4B,EACR,EAAE,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAEnD,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAkB,CAAC;AAEnE,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAA4B,EAAgB,EAAE,CAC9E,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAEvB,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAgB,CAAC;AAE/D,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAA4B,EAAc,EAAE,CAC1E,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAErB,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAkB,CAAC;AAEnE,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAgB,EAAgB,EAAE,CAClE,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAEvB,WAAW;AAEX,MAAM,IAAI,GAAG,CAAC,CAAC,MAAM,CAAC;IACrB,EAAE,EAAE,EAAE;IACN,MAAM,EAAE,MAAM;IACd,IAAI,EAAE,IAAI;IACV,KAAK,EAAE,SAAS;IAChB,WAAW,EAAE,WAAW,CAAC,QAAQ,EAAE;IACnC,cAAc,EAAE,cAAc,CAAC,QAAQ,EAAE;IACzC,aAAa,EAAE,aAAa,CAAC,QAAQ,EAAE;IACvC,iBAAiB,EAAE,iBAAiB,CAAC,QAAQ,EAAE;IAC/C,YAAY,EAAE,YAAY,CAAC,QAAQ,EAAE;IACrC,UAAU,EAAE,UAAU,CAAC,QAAQ,EAAE;IACjC,QAAQ,EAAE,YAAY,CAAC,QAAQ,EAAE;IACjC,SAAS,EAAE,SAAS;CACpB,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,gBAAgB,EAAE,CAAC,CAAC;AAGxE,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;AASvD,MAAM,CAAC,MAAM,UAAU,GAAG;IACzB,MAAM,EAAE,CAAC,IAAoB,EAAkB,EAAE;QAChD,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,IAAoB,EAAgB,EAAE;QAC9C,OAAO,6BAA6B,CAAC,GAAG,EAAE;YACzC,MAAM,cAAc,GAAG,kBAAkB,EAAE,CAAC;YAC5C,OAAO,MAAM,CAAC,MAAM,CAAC;gBACpB,GAAG,IAAI;gBACP,GAAG,cAAc;aACjB,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;IACJ,CAAC;CACD,CAAC"}
+{"version":3,"file":"books-entity.js","sourceRoot":"","sources":["../../../books/entities/books-entity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,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;AAErF,gBAAgB;AAEhB;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC;KACnB,MAAM,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;KAC/B,GAAG,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;KAC/B,GAAG,CAAC,EAAE,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;KAC/B,KAAK,CAAC,UAAU,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC;KAC/C,KAAK,EAAU,CAAC;AAOlB;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,CAAS,EAAQ,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAE3D;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC;KACxB,MAAM,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;KAC/B,GAAG,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;KAC/B,GAAG,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;KAChC,KAAK,EAAe,CAAC;AAOvB;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAS,EAAa,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAE1E;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAiB,CAAC;AAOxE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAA4B,EAAe,EAAE,CAC5E,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAEtB;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAoB,CAAC;AAO9E;;;;;GAKG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CACjC,CAA4B,EACX,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAE7C;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC;KAC5B,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;KACjB,QAAQ,EAAE;KACV,KAAK,EAAmB,CAAC;AAO3B;;;;;GAKG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAChC,CAA8B,EACd,EAAE,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAE3C;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC;KAChC,MAAM,EAAE;KACR,QAAQ,EAAE;KACV,KAAK,EAAuB,CAAC;AAO/B;;;;;GAKG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,CACpC,CAA4B,EACR,EAAE,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAEnD;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAkB,CAAC;AAO1E;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAA4B,EAAgB,EAAE,CAC9E,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAEvB;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAgB,CAAC;AAOtE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAA4B,EAAc,EAAE,CAC1E,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAErB;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAkB,CAAC;AAO1E;;;;;GAKG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAgB,EAAgB,EAAE,CAClE,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAEvB,WAAW;AAEX;;;;GAIG;AACH,MAAM,IAAI,GAAG,CAAC,CAAC,MAAM,CAAC;IACrB,EAAE,EAAE,EAAE;IACN,MAAM,EAAE,MAAM;IACd,IAAI,EAAE,IAAI;IACV,KAAK,EAAE,SAAS;IAChB,WAAW,EAAE,WAAW,CAAC,QAAQ,EAAE;IACnC,cAAc,EAAE,cAAc,CAAC,QAAQ,EAAE;IACzC,aAAa,EAAE,aAAa,CAAC,QAAQ,EAAE;IACvC,iBAAiB,EAAE,iBAAiB,CAAC,QAAQ,EAAE;IAC/C,YAAY,EAAE,YAAY,CAAC,QAAQ,EAAE;IACrC,UAAU,EAAE,UAAU,CAAC,QAAQ,EAAE;IACjC,QAAQ,EAAE,YAAY,CAAC,QAAQ,EAAE;IACjC,SAAS,EAAE,SAAS;CACpB,CAAC,CAAC;AAEH;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,gBAAgB,EAAE,CAAC,CAAC;AAUxE;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;AAU9D;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAC,CAAC;AAoC1E;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG;IACzB;;;;;;;OAOG;IACH,MAAM,EAAE,CAAC,IAAoB,EAAkB,EAAE;QAChD,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,IAAoB,EAAgB,EAAE;QAC9C,OAAO,6BAA6B,CAAC,GAAG,EAAE;YACzC,MAAM,cAAc,GAAG,kBAAkB,EAAE,CAAC;YAC5C,OAAO,MAAM,CAAC,MAAM,CAAC;gBACpB,GAAG,IAAI;gBACP,GAAG,cAAc;aACjB,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,iBAAiB,EAAE,CAAC,IAAoB,EAAmB,EAAE;QAC5D,OAAO,6BAA6B,CAAC,GAAG,EAAE,CACzC,MAAM,CAAC,MAAM,CAAC;YACb,GAAG,IAAI;YACP,MAAM,EAAE,cAAuB;SAC/B,CAAC,CACF,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,EAAE,CAAC,IAAqB,EAAkB,EAAE;QACjD,OAAO,6BAA6B,CAAC,GAAG,EAAE,CACzC,MAAM,CAAC,MAAM,CAAC;YACb,GAAG,IAAI;YACP,MAAM,EAAE,YAAqB;SAC7B,CAAC,CACF,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,EAAE,CAAC,IAAqB,EAAgB,EAAE;QACjD,OAAO,6BAA6B,CAAC,GAAG,EAAE;YACzC,MAAM,cAAc,GAAG,kBAAkB,EAAE,CAAC;YAC5C,OAAO,MAAM,CAAC,MAAM,CAAC;gBACpB,GAAG,IAAI;gBACP,GAAG,cAAc;aACjB,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;IACJ,CAAC;CACD,CAAC"}

package/dist/books/events/book-created-event.d.ts

@@ -1,5 +1,37 @@
 import { BaseDomainEvent } from "../../common/events/base-domain-event";
+/**
+ * Domain event emitted when a book is created.
+ *
+ * @remarks
+ * Part of the event-driven architecture for cross-cutting concerns
+ * like notifications, logging, and analytics.
+ *
+ * @example
+ * ```typescript
+ * const event = new BookCreatedEvent({
+ *   ISBN: "978-4-06-521234-5",
+ *   title: "The Pragmatic Programmer",
+ *   userId: "user-123",
+ *   caller: "addBook",
+ * });
+ *
+ * // event.eventType === "book.created"
+ * await eventHandler.handle(event);
+ * ```
+ *
+ * @see {@link BaseDomainEvent} for base class
+ * @see {@link BookDeletedEvent} for deletion event
+ */
 export declare class BookCreatedEvent extends BaseDomainEvent {
+    /**
+     * Creates a new BookCreatedEvent.
+     *
+     * @param data - Event data containing book details and metadata
+     * @param data.ISBN - The book's ISBN identifier
+     * @param data.title - The book title
+     * @param data.userId - The user who created the book
+     * @param data.caller - The function/method that triggered the event
+     */
     constructor(data: {
         ISBN: string;
         title: string;

package/dist/books/events/book-created-event.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"book-created-event.d.ts","sourceRoot":"","sources":["../../../books/events/book-created-event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AAExE,qBAAa,gBAAiB,SAAQ,eAAe;gBACxC,IAAI,EAAE;QACjB,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;KACf;CAaD"}
+{"version":3,"file":"book-created-event.d.ts","sourceRoot":"","sources":["../../../books/events/book-created-event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AAExE;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,gBAAiB,SAAQ,eAAe;IACpD;;;;;;;;OAQG;gBACS,IAAI,EAAE;QACjB,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;KACf;CAaD"}

package/dist/books/events/book-created-event.js

@@ -1,5 +1,37 @@
 import { BaseDomainEvent } from "../../common/events/base-domain-event";
+/**
+ * Domain event emitted when a book is created.
+ *
+ * @remarks
+ * Part of the event-driven architecture for cross-cutting concerns
+ * like notifications, logging, and analytics.
+ *
+ * @example
+ * ```typescript
+ * const event = new BookCreatedEvent({
+ *   ISBN: "978-4-06-521234-5",
+ *   title: "The Pragmatic Programmer",
+ *   userId: "user-123",
+ *   caller: "addBook",
+ * });
+ *
+ * // event.eventType === "book.created"
+ * await eventHandler.handle(event);
+ * ```
+ *
+ * @see {@link BaseDomainEvent} for base class
+ * @see {@link BookDeletedEvent} for deletion event
+ */
 export class BookCreatedEvent extends BaseDomainEvent {
+    /**
+     * Creates a new BookCreatedEvent.
+     *
+     * @param data - Event data containing book details and metadata
+     * @param data.ISBN - The book's ISBN identifier
+     * @param data.title - The book title
+     * @param data.userId - The user who created the book
+     * @param data.caller - The function/method that triggered the event
+     */
     constructor(data) {
         super("book.created", {
             ISBN: data.ISBN,

package/dist/books/events/book-created-event.js.map

@@ -1 +1 @@
-{"version":3,"file":"book-created-event.js","sourceRoot":"","sources":["../../../books/events/book-created-event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AAExE,MAAM,OAAO,gBAAiB,SAAQ,eAAe;IACpD,YAAY,IAKX;QACA,KAAK,CACJ,cAAc,EACd;YACC,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,KAAK,EAAE,IAAI,CAAC,KAAK;SACjB,EACD;YACC,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,MAAM,EAAE,IAAI,CAAC,MAAM;SACnB,CACD,CAAC;IACH,CAAC;CACD"}
+{"version":3,"file":"book-created-event.js","sourceRoot":"","sources":["../../../books/events/book-created-event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AAExE;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,OAAO,gBAAiB,SAAQ,eAAe;IACpD;;;;;;;;OAQG;IACH,YAAY,IAKX;QACA,KAAK,CACJ,cAAc,EACd;YACC,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,KAAK,EAAE,IAAI,CAAC,KAAK;SACjB,EACD;YACC,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,MAAM,EAAE,IAAI,CAAC,MAAM;SACnB,CACD,CAAC;IACH,CAAC;CACD"}

package/dist/books/events/book-deleted-event.d.ts

@@ -1,5 +1,35 @@
 import { BaseDomainEvent } from "../../common/events/base-domain-event";
+/**
+ * Domain event emitted when a book is deleted.
+ *
+ * @remarks
+ * Part of the event-driven architecture for cross-cutting concerns
+ * like notifications, logging, and analytics.
+ *
+ * @example
+ * ```typescript
+ * const event = new BookDeletedEvent({
+ *   title: "Deleted Book",
+ *   userId: "user-123",
+ *   caller: "deleteBook",
+ * });
+ *
+ * // event.eventType === "book.deleted"
+ * await eventHandler.handle(event);
+ * ```
+ *
+ * @see {@link BaseDomainEvent} for base class
+ * @see {@link BookCreatedEvent} for creation event
+ */
 export declare class BookDeletedEvent extends BaseDomainEvent {
+    /**
+     * Creates a new BookDeletedEvent.
+     *
+     * @param data - Event data containing deletion details
+     * @param data.title - The title of the deleted book
+     * @param data.userId - The user who deleted the book
+     * @param data.caller - The function/method that triggered the event
+     */
     constructor(data: {
         title: string;
         userId: string;

package/dist/books/events/book-deleted-event.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"book-deleted-event.d.ts","sourceRoot":"","sources":["../../../books/events/book-deleted-event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AAExE,qBAAa,gBAAiB,SAAQ,eAAe;gBACxC,IAAI,EAAE;QACjB,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;KACf;CAYD"}
+{"version":3,"file":"book-deleted-event.d.ts","sourceRoot":"","sources":["../../../books/events/book-deleted-event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AAExE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,gBAAiB,SAAQ,eAAe;IACpD;;;;;;;OAOG;gBACS,IAAI,EAAE;QACjB,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;KACf;CAYD"}

package/dist/books/events/book-deleted-event.js

@@ -1,5 +1,35 @@
 import { BaseDomainEvent } from "../../common/events/base-domain-event";
+/**
+ * Domain event emitted when a book is deleted.
+ *
+ * @remarks
+ * Part of the event-driven architecture for cross-cutting concerns
+ * like notifications, logging, and analytics.
+ *
+ * @example
+ * ```typescript
+ * const event = new BookDeletedEvent({
+ *   title: "Deleted Book",
+ *   userId: "user-123",
+ *   caller: "deleteBook",
+ * });
+ *
+ * // event.eventType === "book.deleted"
+ * await eventHandler.handle(event);
+ * ```
+ *
+ * @see {@link BaseDomainEvent} for base class
+ * @see {@link BookCreatedEvent} for creation event
+ */
 export class BookDeletedEvent extends BaseDomainEvent {
+    /**
+     * Creates a new BookDeletedEvent.
+     *
+     * @param data - Event data containing deletion details
+     * @param data.title - The title of the deleted book
+     * @param data.userId - The user who deleted the book
+     * @param data.caller - The function/method that triggered the event
+     */
     constructor(data) {
         super("book.deleted", {
             title: data.title,

package/dist/books/events/book-deleted-event.js.map

@@ -1 +1 @@
-{"version":3,"file":"book-deleted-event.js","sourceRoot":"","sources":["../../../books/events/book-deleted-event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AAExE,MAAM,OAAO,gBAAiB,SAAQ,eAAe;IACpD,YAAY,IAIX;QACA,KAAK,CACJ,cAAc,EACd;YACC,KAAK,EAAE,IAAI,CAAC,KAAK;SACjB,EACD;YACC,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,MAAM,EAAE,IAAI,CAAC,MAAM;SACnB,CACD,CAAC;IACH,CAAC;CACD"}
+{"version":3,"file":"book-deleted-event.js","sourceRoot":"","sources":["../../../books/events/book-deleted-event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AAExE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,OAAO,gBAAiB,SAAQ,eAAe;IACpD;;;;;;;OAOG;IACH,YAAY,IAIX;QACA,KAAK,CACJ,cAAc,EACd;YACC,KAAK,EAAE,IAAI,CAAC,KAAK;SACjB,EACD;YACC,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,MAAM,EAAE,IAAI,CAAC,MAAM;SACnB,CACD,CAAC;IACH,CAAC;CACD"}

package/dist/books/index.d.ts

@@ -1,3 +1,36 @@
+/**
+ * @packageDocumentation
+ *
+ * Books domain for ISBN-based book tracking.
+ *
+ * @remarks
+ * Provides complete domain implementation for book management including:
+ *
+ * - **Entities** - Book 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
+ *
+ * Books integrate with Google Books API for metadata enrichment
+ * (title, authors, thumbnail, page count, published date).
+ *
+ * @example
+ * ```typescript
+ * import {
+ *   bookEntity,
+ *   makeISBN,
+ *   makeRating,
+ *   BookCreatedEvent,
+ * } from "@repo/core/books";
+ *
+ * const book = bookEntity.create({
+ *   userId: makeUserId("user-123"),
+ *   isbn: makeISBN("978-4-12-345678-9"),
+ *   rating: makeRating(4),
+ * });
+ * ```
+ */
 export * from "./entities/books-entity";
 export * from "./events/book-created-event";
 export * from "./events/book-deleted-event";

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../books/index.ts"],"names":[],"mappings":"AACA,cAAc,yBAAyB,CAAC;AAGxC,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":["../../books/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AAGH,cAAc,yBAAyB,CAAC;AAGxC,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/books/index.js

@@ -1,3 +1,36 @@
+/**
+ * @packageDocumentation
+ *
+ * Books domain for ISBN-based book tracking.
+ *
+ * @remarks
+ * Provides complete domain implementation for book management including:
+ *
+ * - **Entities** - Book 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
+ *
+ * Books integrate with Google Books API for metadata enrichment
+ * (title, authors, thumbnail, page count, published date).
+ *
+ * @example
+ * ```typescript
+ * import {
+ *   bookEntity,
+ *   makeISBN,
+ *   makeRating,
+ *   BookCreatedEvent,
+ * } from "@repo/core/books";
+ *
+ * const book = bookEntity.create({
+ *   userId: makeUserId("user-123"),
+ *   isbn: makeISBN("978-4-12-345678-9"),
+ *   rating: makeRating(4),
+ * });
+ * ```
+ */
 // Entities
 export * from "./entities/books-entity";
 // Events

package/dist/books/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../books/index.ts"],"names":[],"mappings":"AAAA,WAAW;AACX,cAAc,yBAAyB,CAAC;AAExC,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":["../../books/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AAEH,WAAW;AACX,cAAc,yBAAyB,CAAC;AAExC,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/books/repositories/books-command-repository.interface.d.ts

@@ -1,8 +1,53 @@
 import type { Id, Status, UserId } from "../../common/entities/common-entity";
 import type { UnexportedBook } from "../entities/books-entity";
+/**
+ * Command repository interface for the Book 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 PrismaBooksCommandRepository implements IBooksCommandRepository {
+ *   async create(data: UnexportedBook) {
+ *     await prisma.book.create({ data });
+ *   }
+ *
+ *   async deleteById(id: Id, userId: UserId, status: Status) {
+ *     await prisma.book.delete({
+ *       where: { id, userId, status }
+ *     });
+ *   }
+ * }
+ * ```
+ *
+ * @see {@link IBooksQueryRepository} for read operations
+ */
 export type IBooksCommandRepository = {
+    /**
+     * Creates a new book in the repository.
+     *
+     * @param data - The unexported book entity to persist
+     */
     create(data: UnexportedBook): Promise<void>;
+    /**
+     * Deletes a book by its ID.
+     *
+     * @param id - The book ID to delete
+     * @param userId - The user ID for tenant isolation
+     * @param status - The expected status of the book
+     */
     deleteById(id: Id, userId: UserId, status: Status): Promise<void>;
+    /**
+     * Fetches books from an external GitHub repository.
+     *
+     * @remarks
+     * Used for importing book data from external sources.
+     *
+     * @returns Array of unexported book entities
+     */
     fetchBookFromGitHub(): Promise<UnexportedBook[]>;
 };
 //# sourceMappingURL=books-command-repository.interface.d.ts.map