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

package/dist/articles/entities/article-entity.js

@@ -1,28 +1,121 @@
 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 CategoryName = z
+/**
+ * Zod schema for validating category names.
+ *
+ * @remarks
+ * Validates that the category name is a trimmed string between 1 and 16 characters.
+ * Used for organizing articles into logical groups.
+ *
+ * @example
+ * ```typescript
+ * const name = CategoryName.parse("Technology");
+ * ```
+ *
+ * @see {@link makeCategoryName} for factory function
+ */
+export const CategoryName = z
     .string({ message: "required" })
     .trim()
     .min(1, { message: "required" })
     .max(16, { message: "tooLong" })
     .brand();
+/**
+ * Creates a validated CategoryName from a string.
+ *
+ * @param v - The raw string value to validate
+ * @returns A branded CategoryName value
+ * @throws {ZodError} When validation fails (empty or exceeds 16 chars)
+ *
+ * @example
+ * ```typescript
+ * const name = makeCategoryName("Technology");
+ * ```
+ */
 export const makeCategoryName = (v) => CategoryName.parse(v);
-const ArticleTitle = z
+/**
+ * Zod schema for validating article titles.
+ *
+ * @remarks
+ * Validates that the title is a non-empty string between 1 and 128 characters.
+ *
+ * @example
+ * ```typescript
+ * const title = ArticleTitle.parse("Introduction to TypeScript");
+ * ```
+ *
+ * @see {@link makeArticleTitle} for factory function
+ */
+export const ArticleTitle = z
     .string({ message: "required" })
     .min(1, { message: "required" })
     .max(128, { message: "tooLong" })
     .brand();
+/**
+ * Creates a validated ArticleTitle from a string.
+ *
+ * @param v - The raw string value to validate
+ * @returns A branded ArticleTitle value
+ * @throws {ZodError} When validation fails (empty or exceeds 128 chars)
+ *
+ * @example
+ * ```typescript
+ * const title = makeArticleTitle("Introduction to TypeScript");
+ * ```
+ */
 export const makeArticleTitle = (v) => ArticleTitle.parse(v);
-const Quote = z
+/**
+ * Zod schema for validating article quotes.
+ *
+ * @remarks
+ * Validates an optional quote with maximum 512 characters.
+ * Null and undefined values are allowed.
+ *
+ * @example
+ * ```typescript
+ * const quote = Quote.parse("This is a notable excerpt from the article.");
+ * const empty = Quote.parse(null);
+ * ```
+ *
+ * @see {@link makeQuote} for factory function
+ */
+export const Quote = z
     .string()
     .max(512, { message: "tooLong" })
     .nullable()
     .optional()
     .brand();
+/**
+ * Creates a validated Quote from a string or null/undefined.
+ *
+ * @param v - The raw string value, null, or undefined
+ * @returns A branded Quote value
+ * @throws {ZodError} When string exceeds 512 characters
+ *
+ * @example
+ * ```typescript
+ * const quote = makeQuote("Notable excerpt");
+ * const noQuote = makeQuote(null);
+ * ```
+ */
 export const makeQuote = (v) => Quote.parse(v);
-const Url = z
+/**
+ * Zod schema for validating article URLs.
+ *
+ * @remarks
+ * Validates that the URL is a valid HTTP or HTTPS URL.
+ * Other protocols are not allowed.
+ *
+ * @example
+ * ```typescript
+ * const url = Url.parse("https://example.com/article");
+ * ```
+ *
+ * @see {@link makeUrl} for factory function
+ */
+export const Url = z
     .url({ message: "invalidFormat" })
     .min(1, { message: "required" })
     .refine((url) => {
@@ -35,14 +128,84 @@ const Url = z
     }
 }, { message: "invalidFormat" })
     .brand();
+/**
+ * Creates a validated Url from a string.
+ *
+ * @param v - The raw URL string
+ * @returns A branded Url value
+ * @throws {ZodError} When URL is invalid or not HTTP/HTTPS
+ *
+ * @example
+ * ```typescript
+ * const url = makeUrl("https://example.com/article");
+ * ```
+ */
 export const makeUrl = (v) => Url.parse(v);
-const OgTitle = z.string().nullable().optional().brand();
+/**
+ * Zod schema for validating Open Graph titles.
+ *
+ * @remarks
+ * Optional string for the OG title fetched from the article URL.
+ * Null and undefined values are allowed.
+ *
+ * @see {@link makeOgTitle} for factory function
+ */
+export const OgTitle = z.string().nullable().optional().brand();
+/**
+ * Creates a validated OgTitle from a string or null/undefined.
+ *
+ * @param v - The raw OG title string, null, or undefined
+ * @returns A branded OgTitle value
+ */
 export const makeOgTitle = (v) => OgTitle.parse(v);
-const OgDescription = z.string().nullable().optional().brand();
+/**
+ * Zod schema for validating Open Graph descriptions.
+ *
+ * @remarks
+ * Optional string for the OG description fetched from the article URL.
+ * Null and undefined values are allowed.
+ *
+ * @see {@link makeOgDescription} for factory function
+ */
+export const OgDescription = z
+    .string()
+    .nullable()
+    .optional()
+    .brand();
+/**
+ * Creates a validated OgDescription from a string or null/undefined.
+ *
+ * @param v - The raw OG description string, null, or undefined
+ * @returns A branded OgDescription value
+ */
 export const makeOgDescription = (v) => OgDescription.parse(v);
-const OgImageUrl = z.string().nullable().optional().brand();
+/**
+ * Zod schema for validating Open Graph image URLs.
+ *
+ * @remarks
+ * Optional string for the OG image URL fetched from the article URL.
+ * Null and undefined values are allowed.
+ *
+ * @see {@link makeOgImageUrl} for factory function
+ */
+export const OgImageUrl = z
+    .string()
+    .nullable()
+    .optional()
+    .brand();
+/**
+ * Creates a validated OgImageUrl from a string or null/undefined.
+ *
+ * @param v - The raw OG image URL string, null, or undefined
+ * @returns A branded OgImageUrl value
+ */
 export const makeOgImageUrl = (v) => OgImageUrl.parse(v);
 // Entities
+/**
+ * Base schema containing common article fields.
+ *
+ * @internal
+ */
 const Base = z.object({
     id: Id,
     userId: UserId,
@@ -56,9 +219,69 @@ const Base = z.object({
     ogDescription: OgDescription,
     ogImageUrl: OgImageUrl,
 });
+/**
+ * Zod schema for an unexported article.
+ *
+ * @remarks
+ * Represents an article that has not yet been published.
+ * This is the initial state of all newly created articles.
+ *
+ * @see {@link ExportedArticle} for the published state
+ */
 export const UnexportedArticle = Base.extend({ status: UnexportedStatus });
-const ExportedArticle = Base.extend(ExportedStatus.shape);
+/**
+ * Zod schema for an exported article.
+ *
+ * @remarks
+ * Represents an article that has been published.
+ * Includes the exportedAt timestamp.
+ *
+ * @see {@link UnexportedArticle} for the initial state
+ */
+export const ExportedArticle = Base.extend(ExportedStatus.shape);
+/**
+ * Zod schema for an article marked for export in the current batch.
+ *
+ * @remarks
+ * Represents an article that has been marked for export but not yet finalized.
+ * This intermediate state allows for batch processing with revert capability.
+ *
+ * @see {@link UnexportedArticle} for the initial state
+ * @see {@link ExportedArticle} for the final state
+ */
+export const LastUpdatedArticle = Base.extend({ status: LastUpdatedStatus });
+/**
+ * Factory object for Article 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 article
+ * const article = articleEntity.create({
+ *   userId: makeUserId("user-123"),
+ *   categoryName: makeCategoryName("Tech"),
+ *   title: makeArticleTitle("Article Title"),
+ *   url: makeUrl("https://example.com"),
+ * });
+ *
+ * // Export the article (changes status to EXPORTED)
+ * const exported = articleEntity.export(article);
+ * ```
+ *
+ * @see {@link CreateArticleArgs} for creation parameters
+ */
 export const articleEntity = {
+    /**
+     * Creates a new unexported article entity.
+     *
+     * @param args - The creation arguments containing required fields
+     * @returns A frozen UnexportedArticle 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(),
@@ -68,6 +291,14 @@ export const articleEntity = {
             ...args,
         }));
     },
+    /**
+     * Transitions an article from UNEXPORTED to EXPORTED status.
+     *
+     * @param article - The unexported article to export
+     * @returns A frozen ExportedArticle with exportedAt timestamp
+     * @throws {InvalidFormatError} When the article state is invalid
+     * @throws {UnexpectedError} For unexpected errors during export
+     */
     export: (article) => {
         return createEntityWithErrorHandling(() => {
             const exportedStatus = makeExportedStatus();
@@ -77,5 +308,60 @@ export const articleEntity = {
             });
         });
     },
+    /**
+     * Marks an article for export in the current batch.
+     *
+     * @remarks
+     * Transitions from UNEXPORTED to LAST_UPDATED status.
+     * This allows for batch processing with revert capability.
+     *
+     * @param article - The unexported article to mark
+     * @returns A frozen LastUpdatedArticle
+     * @throws {InvalidFormatError} When the article state is invalid
+     * @throws {UnexpectedError} For unexpected errors
+     */
+    markAsLastUpdated: (article) => {
+        return createEntityWithErrorHandling(() => Object.freeze({
+            ...article,
+            status: "LAST_UPDATED",
+        }));
+    },
+    /**
+     * Reverts an article from LAST_UPDATED back to UNEXPORTED.
+     *
+     * @remarks
+     * Use this when batch processing fails and needs to be rolled back.
+     *
+     * @param article - The last updated article to revert
+     * @returns A frozen UnexportedArticle
+     * @throws {InvalidFormatError} When the article state is invalid
+     * @throws {UnexpectedError} For unexpected errors
+     */
+    revert: (article) => {
+        return createEntityWithErrorHandling(() => Object.freeze({
+            ...article,
+            status: "UNEXPORTED",
+        }));
+    },
+    /**
+     * Finalizes an article from LAST_UPDATED to EXPORTED.
+     *
+     * @remarks
+     * Use this after batch processing succeeds to confirm the export.
+     *
+     * @param article - The last updated article to finalize
+     * @returns A frozen ExportedArticle with exportedAt timestamp
+     * @throws {InvalidFormatError} When the article state is invalid
+     * @throws {UnexpectedError} For unexpected errors
+     */
+    finalize: (article) => {
+        return createEntityWithErrorHandling(() => {
+            const exportedStatus = makeExportedStatus();
+            return Object.freeze({
+                ...article,
+                ...exportedStatus,
+            });
+        });
+    },
 };
 //# sourceMappingURL=article-entity.js.map

package/dist/articles/entities/article-entity.js.map

@@ -1 +1 @@
-{"version":3,"file":"article-entity.js","sourceRoot":"","sources":["../../../articles/entities/article-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,YAAY,GAAG,CAAC;KACpB,MAAM,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;KAC/B,IAAI,EAAE;KACN,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,EAAkB,CAAC;AAE1B,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAS,EAAgB,EAAE,CAC3D,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAEvB,MAAM,YAAY,GAAG,CAAC;KACpB,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,EAAkB,CAAC;AAE1B,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAS,EAAgB,EAAE,CAC3D,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAEvB,MAAM,KAAK,GAAG,CAAC;KACb,MAAM,EAAE;KACR,GAAG,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;KAChC,QAAQ,EAAE;KACV,QAAQ,EAAE;KACV,KAAK,EAAW,CAAC;AAEnB,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,CAA4B,EAAS,EAAE,CAChE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAEhB,MAAM,GAAG,GAAG,CAAC;KACX,GAAG,CAAC,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC;KACjC,GAAG,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;KAC/B,MAAM,CACN,CAAC,GAAW,EAAE,EAAE;IACf,IAAI,CAAC;QACJ,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/B,OAAO,CACN,SAAS,CAAC,QAAQ,KAAK,OAAO,IAAI,SAAS,CAAC,QAAQ,KAAK,QAAQ,CACjE,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;QACR,OAAO,KAAK,CAAC;IACd,CAAC;AACF,CAAC,EACD,EAAE,OAAO,EAAE,eAAe,EAAE,CAC5B;KACA,KAAK,EAAS,CAAC;AAEjB,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,CAAS,EAAO,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAExD,MAAM,OAAO,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAa,CAAC;AAEpE,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAA4B,EAAW,EAAE,CACpE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAElB,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAmB,CAAC;AAEhF,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAChC,CAA4B,EACZ,EAAE,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAE3C,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAgB,CAAC;AAE1E,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAA4B,EAAc,EAAE,CAC1E,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAErB,WAAW;AAEX,MAAM,IAAI,GAAG,CAAC,CAAC,MAAM,CAAC;IACrB,EAAE,EAAE,EAAE;IACN,MAAM,EAAE,MAAM;IACd,YAAY,EAAE,YAAY;IAC1B,UAAU,EAAE,EAAE;IACd,KAAK,EAAE,YAAY;IACnB,KAAK,EAAE,KAAK;IACZ,GAAG,EAAE,GAAG;IACR,SAAS,EAAE,SAAS;IACpB,OAAO,EAAE,OAAO;IAChB,aAAa,EAAE,aAAa;IAC5B,UAAU,EAAE,UAAU;CACtB,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,iBAAiB,GAAG,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,gBAAgB,EAAE,CAAC,CAAC;AAG3E,MAAM,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;AAW1D,MAAM,CAAC,MAAM,aAAa,GAAG;IAC5B,MAAM,EAAE,CAAC,IAAuB,EAAqB,EAAE;QACtD,OAAO,6BAA6B,CAAC,GAAG,EAAE,CACzC,MAAM,CAAC,MAAM,CAAC;YACb,EAAE,EAAE,MAAM,EAAE;YACZ,MAAM,EAAE,YAAY;YACpB,UAAU,EAAE,MAAM,EAAE;YACpB,SAAS,EAAE,aAAa,EAAE;YAC1B,GAAG,IAAI;SACP,CAAC,CACF,CAAC;IACH,CAAC;IACD,MAAM,EAAE,CAAC,OAA0B,EAAmB,EAAE;QACvD,OAAO,6BAA6B,CAAC,GAAG,EAAE;YACzC,MAAM,cAAc,GAAG,kBAAkB,EAAE,CAAC;YAC5C,OAAO,MAAM,CAAC,MAAM,CAAC;gBACpB,GAAG,OAAO;gBACV,GAAG,cAAc;aACjB,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;IACJ,CAAC;CACD,CAAC"}
+{"version":3,"file":"article-entity.js","sourceRoot":"","sources":["../../../articles/entities/article-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;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC;KAC3B,MAAM,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;KAC/B,IAAI,EAAE;KACN,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,EAAkB,CAAC;AAO1B;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAS,EAAgB,EAAE,CAC3D,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAEvB;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC;KAC3B,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,EAAkB,CAAC;AAO1B;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAS,EAAgB,EAAE,CAC3D,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAEvB;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,KAAK,GAAG,CAAC;KACpB,MAAM,EAAE;KACR,GAAG,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;KAChC,QAAQ,EAAE;KACV,QAAQ,EAAE;KACV,KAAK,EAAW,CAAC;AAOnB;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,CAA4B,EAAS,EAAE,CAChE,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAEhB;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,GAAG,GAAG,CAAC;KAClB,GAAG,CAAC,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC;KACjC,GAAG,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;KAC/B,MAAM,CACN,CAAC,GAAW,EAAE,EAAE;IACf,IAAI,CAAC;QACJ,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/B,OAAO,CACN,SAAS,CAAC,QAAQ,KAAK,OAAO,IAAI,SAAS,CAAC,QAAQ,KAAK,QAAQ,CACjE,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;QACR,OAAO,KAAK,CAAC;IACd,CAAC;AACF,CAAC,EACD,EAAE,OAAO,EAAE,eAAe,EAAE,CAC5B;KACA,KAAK,EAAS,CAAC;AAOjB;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,CAAS,EAAO,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAExD;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAa,CAAC;AAO3E;;;;;GAKG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAA4B,EAAW,EAAE,CACpE,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAElB;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC;KAC5B,MAAM,EAAE;KACR,QAAQ,EAAE;KACV,QAAQ,EAAE;KACV,KAAK,EAAmB,CAAC;AAO3B;;;;;GAKG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAChC,CAA4B,EACZ,EAAE,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAE3C;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC;KACzB,MAAM,EAAE;KACR,QAAQ,EAAE;KACV,QAAQ,EAAE;KACV,KAAK,EAAgB,CAAC;AAOxB;;;;;GAKG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,CAA4B,EAAc,EAAE,CAC1E,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAErB,WAAW;AAEX;;;;GAIG;AACH,MAAM,IAAI,GAAG,CAAC,CAAC,MAAM,CAAC;IACrB,EAAE,EAAE,EAAE;IACN,MAAM,EAAE,MAAM;IACd,YAAY,EAAE,YAAY;IAC1B,UAAU,EAAE,EAAE;IACd,KAAK,EAAE,YAAY;IACnB,KAAK,EAAE,KAAK;IACZ,GAAG,EAAE,GAAG;IACR,SAAS,EAAE,SAAS;IACpB,OAAO,EAAE,OAAO;IAChB,aAAa,EAAE,aAAa;IAC5B,UAAU,EAAE,UAAU;CACtB,CAAC,CAAC;AAEH;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,gBAAgB,EAAE,CAAC,CAAC;AAU3E;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;AAUjE;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,EAAE,iBAAiB,EAAE,CAAC,CAAC;AA0C7E;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC5B;;;;;;;OAOG;IACH,MAAM,EAAE,CAAC,IAAuB,EAAqB,EAAE;QACtD,OAAO,6BAA6B,CAAC,GAAG,EAAE,CACzC,MAAM,CAAC,MAAM,CAAC;YACb,EAAE,EAAE,MAAM,EAAE;YACZ,MAAM,EAAE,YAAY;YACpB,UAAU,EAAE,MAAM,EAAE;YACpB,SAAS,EAAE,aAAa,EAAE;YAC1B,GAAG,IAAI;SACP,CAAC,CACF,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,EAAE,CAAC,OAA0B,EAAmB,EAAE;QACvD,OAAO,6BAA6B,CAAC,GAAG,EAAE;YACzC,MAAM,cAAc,GAAG,kBAAkB,EAAE,CAAC;YAC5C,OAAO,MAAM,CAAC,MAAM,CAAC;gBACpB,GAAG,OAAO;gBACV,GAAG,cAAc;aACjB,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;OAWG;IACH,iBAAiB,EAAE,CAAC,OAA0B,EAAsB,EAAE;QACrE,OAAO,6BAA6B,CAAC,GAAG,EAAE,CACzC,MAAM,CAAC,MAAM,CAAC;YACb,GAAG,OAAO;YACV,MAAM,EAAE,cAAuB;SAC/B,CAAC,CACF,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,MAAM,EAAE,CAAC,OAA2B,EAAqB,EAAE;QAC1D,OAAO,6BAA6B,CAAC,GAAG,EAAE,CACzC,MAAM,CAAC,MAAM,CAAC;YACb,GAAG,OAAO;YACV,MAAM,EAAE,YAAqB;SAC7B,CAAC,CACF,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,EAAE,CAAC,OAA2B,EAAmB,EAAE;QAC1D,OAAO,6BAA6B,CAAC,GAAG,EAAE;YACzC,MAAM,cAAc,GAAG,kBAAkB,EAAE,CAAC;YAC5C,OAAO,MAAM,CAAC,MAAM,CAAC;gBACpB,GAAG,OAAO;gBACV,GAAG,cAAc;aACjB,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;IACJ,CAAC;CACD,CAAC"}

package/dist/articles/events/article-created-event.d.ts

@@ -1,5 +1,41 @@
 import { BaseDomainEvent } from "../../common/events/base-domain-event";
+/**
+ * Domain event emitted when an article is created.
+ *
+ * @remarks
+ * Part of the event-driven architecture for cross-cutting concerns
+ * like notifications, logging, and analytics.
+ *
+ * @example
+ * ```typescript
+ * const event = new ArticleCreatedEvent({
+ *   title: "New Article",
+ *   url: "https://example.com",
+ *   quote: "Important quote",
+ *   categoryName: "Technology",
+ *   userId: "user-123",
+ *   caller: "addArticle",
+ * });
+ *
+ * // event.eventType === "article.created"
+ * await eventHandler.handle(event);
+ * ```
+ *
+ * @see {@link BaseDomainEvent} for base class
+ * @see {@link ArticleDeletedEvent} for deletion event
+ */
 export declare class ArticleCreatedEvent extends BaseDomainEvent {
+    /**
+     * Creates a new ArticleCreatedEvent.
+     *
+     * @param data - Event data containing article details and metadata
+     * @param data.title - The article title
+     * @param data.url - The article URL
+     * @param data.quote - Quote/excerpt from the article
+     * @param data.categoryName - The category name
+     * @param data.userId - The user who created the article
+     * @param data.caller - The function/method that triggered the event
+     */
     constructor(data: {
         title: string;
         url: string;

package/dist/articles/events/article-created-event.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"article-created-event.d.ts","sourceRoot":"","sources":["../../../articles/events/article-created-event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AAExE,qBAAa,mBAAoB,SAAQ,eAAe;gBAC3C,IAAI,EAAE;QACjB,KAAK,EAAE,MAAM,CAAC;QACd,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,CAAC;QACd,YAAY,EAAE,MAAM,CAAC;QACrB,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;KACf;CAeD"}
+{"version":3,"file":"article-created-event.d.ts","sourceRoot":"","sources":["../../../articles/events/article-created-event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AAExE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,qBAAa,mBAAoB,SAAQ,eAAe;IACvD;;;;;;;;;;OAUG;gBACS,IAAI,EAAE;QACjB,KAAK,EAAE,MAAM,CAAC;QACd,GAAG,EAAE,MAAM,CAAC;QACZ,KAAK,EAAE,MAAM,CAAC;QACd,YAAY,EAAE,MAAM,CAAC;QACrB,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;KACf;CAeD"}

package/dist/articles/events/article-created-event.js

@@ -1,5 +1,41 @@
 import { BaseDomainEvent } from "../../common/events/base-domain-event";
+/**
+ * Domain event emitted when an article is created.
+ *
+ * @remarks
+ * Part of the event-driven architecture for cross-cutting concerns
+ * like notifications, logging, and analytics.
+ *
+ * @example
+ * ```typescript
+ * const event = new ArticleCreatedEvent({
+ *   title: "New Article",
+ *   url: "https://example.com",
+ *   quote: "Important quote",
+ *   categoryName: "Technology",
+ *   userId: "user-123",
+ *   caller: "addArticle",
+ * });
+ *
+ * // event.eventType === "article.created"
+ * await eventHandler.handle(event);
+ * ```
+ *
+ * @see {@link BaseDomainEvent} for base class
+ * @see {@link ArticleDeletedEvent} for deletion event
+ */
 export class ArticleCreatedEvent extends BaseDomainEvent {
+    /**
+     * Creates a new ArticleCreatedEvent.
+     *
+     * @param data - Event data containing article details and metadata
+     * @param data.title - The article title
+     * @param data.url - The article URL
+     * @param data.quote - Quote/excerpt from the article
+     * @param data.categoryName - The category name
+     * @param data.userId - The user who created the article
+     * @param data.caller - The function/method that triggered the event
+     */
     constructor(data) {
         super("article.created", {
             title: data.title,

package/dist/articles/events/article-created-event.js.map

@@ -1 +1 @@
-{"version":3,"file":"article-created-event.js","sourceRoot":"","sources":["../../../articles/events/article-created-event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AAExE,MAAM,OAAO,mBAAoB,SAAQ,eAAe;IACvD,YAAY,IAOX;QACA,KAAK,CACJ,iBAAiB,EACjB;YACC,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,YAAY,EAAE,IAAI,CAAC,YAAY;SAC/B,EACD;YACC,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,MAAM,EAAE,IAAI,CAAC,MAAM;SACnB,CACD,CAAC;IACH,CAAC;CACD"}
+{"version":3,"file":"article-created-event.js","sourceRoot":"","sources":["../../../articles/events/article-created-event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AAExE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,OAAO,mBAAoB,SAAQ,eAAe;IACvD;;;;;;;;;;OAUG;IACH,YAAY,IAOX;QACA,KAAK,CACJ,iBAAiB,EACjB;YACC,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,YAAY,EAAE,IAAI,CAAC,YAAY;SAC/B,EACD;YACC,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,MAAM,EAAE,IAAI,CAAC,MAAM;SACnB,CACD,CAAC;IACH,CAAC;CACD"}

package/dist/articles/events/article-deleted-event.d.ts

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

package/dist/articles/events/article-deleted-event.d.ts.map

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

package/dist/articles/events/article-deleted-event.js

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

package/dist/articles/events/article-deleted-event.js.map

@@ -1 +1 @@
-{"version":3,"file":"article-deleted-event.js","sourceRoot":"","sources":["../../../articles/events/article-deleted-event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AAExE,MAAM,OAAO,mBAAoB,SAAQ,eAAe;IACvD,YAAY,IAIX;QACA,KAAK,CACJ,iBAAiB,EACjB;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":"article-deleted-event.js","sourceRoot":"","sources":["../../../articles/events/article-deleted-event.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AAExE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,OAAO,mBAAoB,SAAQ,eAAe;IACvD;;;;;;;OAOG;IACH,YAAY,IAIX;QACA,KAAK,CACJ,iBAAiB,EACjB;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/articles/index.d.ts

@@ -1,3 +1,36 @@
+/**
+ * @packageDocumentation
+ *
+ * Articles domain for news and link management.
+ *
+ * @remarks
+ * Provides complete domain implementation for article management including:
+ *
+ * - **Entities** - Article 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
+ *
+ * Articles support Open Graph metadata extraction (title, description, image URL)
+ * and can be organized into categories.
+ *
+ * @example
+ * ```typescript
+ * import {
+ *   articleEntity,
+ *   makeArticleTitle,
+ *   makeUrl,
+ *   ArticleCreatedEvent,
+ * } from "@repo/core/articles";
+ *
+ * const article = articleEntity.create({
+ *   userId: makeUserId("user-123"),
+ *   title: makeArticleTitle("Breaking News"),
+ *   url: makeUrl("https://example.com/news"),
+ * });
+ * ```
+ */
 export * from "./entities/article-entity";
 export * from "./events/article-created-event";
 export * from "./events/article-deleted-event";

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../articles/index.ts"],"names":[],"mappings":"AACA,cAAc,2BAA2B,CAAC;AAG1C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,gCAAgC,CAAC;AAG/C,cAAc,sDAAsD,CAAC;AACrE,cAAc,oDAAoD,CAAC;AACnE,cAAc,oDAAoD,CAAC;AAGnE,cAAc,oCAAoC,CAAC;AAGnD,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../articles/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AAGH,cAAc,2BAA2B,CAAC;AAG1C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,gCAAgC,CAAC;AAG/C,cAAc,sDAAsD,CAAC;AACrE,cAAc,oDAAoD,CAAC;AACnE,cAAc,oDAAoD,CAAC;AAGnE,cAAc,oCAAoC,CAAC;AAGnD,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC"}

package/dist/articles/index.js

@@ -1,3 +1,36 @@
+/**
+ * @packageDocumentation
+ *
+ * Articles domain for news and link management.
+ *
+ * @remarks
+ * Provides complete domain implementation for article management including:
+ *
+ * - **Entities** - Article 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
+ *
+ * Articles support Open Graph metadata extraction (title, description, image URL)
+ * and can be organized into categories.
+ *
+ * @example
+ * ```typescript
+ * import {
+ *   articleEntity,
+ *   makeArticleTitle,
+ *   makeUrl,
+ *   ArticleCreatedEvent,
+ * } from "@repo/core/articles";
+ *
+ * const article = articleEntity.create({
+ *   userId: makeUserId("user-123"),
+ *   title: makeArticleTitle("Breaking News"),
+ *   url: makeUrl("https://example.com/news"),
+ * });
+ * ```
+ */
 // Entities
 export * from "./entities/article-entity";
 // Events

package/dist/articles/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../articles/index.ts"],"names":[],"mappings":"AAAA,WAAW;AACX,cAAc,2BAA2B,CAAC;AAE1C,SAAS;AACT,cAAc,gCAAgC,CAAC;AAC/C,cAAc,gCAAgC,CAAC;AAE/C,eAAe;AACf,cAAc,sDAAsD,CAAC;AACrE,cAAc,oDAAoD,CAAC;AACnE,cAAc,oDAAoD,CAAC;AAEnE,WAAW;AACX,cAAc,oCAAoC,CAAC;AAEnD,QAAQ;AACR,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../articles/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AAEH,WAAW;AACX,cAAc,2BAA2B,CAAC;AAE1C,SAAS;AACT,cAAc,gCAAgC,CAAC;AAC/C,cAAc,gCAAgC,CAAC;AAE/C,eAAe;AACf,cAAc,sDAAsD,CAAC;AACrE,cAAc,oDAAoD,CAAC;AACnE,cAAc,oDAAoD,CAAC;AAEnE,WAAW;AACX,cAAc,oCAAoC,CAAC;AAEnD,QAAQ;AACR,cAAc,wBAAwB,CAAC;AACvC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC"}