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

package/dist/notes/entities/note-entity.d.ts

@@ -1,11 +1,77 @@
 import { z } from "zod";
 import { UserId } from "../../common/entities/common-entity";
-declare const NoteTitle: z.core.$ZodBranded<z.ZodString, "NoteTitle">;
+/**
+ * Zod schema for validating note titles.
+ *
+ * @remarks
+ * Validates that the title is a non-empty string between 1 and 64 characters.
+ *
+ * @example
+ * ```typescript
+ * const title = NoteTitle.parse("Meeting Notes");
+ * ```
+ *
+ * @see {@link makeNoteTitle} for factory function
+ */
+export declare const NoteTitle: z.core.$ZodBranded<z.ZodString, "NoteTitle">;
+/**
+ * Branded type for validated note titles.
+ */
 export type NoteTitle = z.infer<typeof NoteTitle>;
+/**
+ * Creates a validated NoteTitle from a string.
+ *
+ * @param v - The raw title string
+ * @returns A branded NoteTitle value
+ * @throws {ZodError} When validation fails (empty or exceeds 64 chars)
+ *
+ * @example
+ * ```typescript
+ * const title = makeNoteTitle("Meeting Notes");
+ * ```
+ */
 export declare const makeNoteTitle: (v: string) => NoteTitle;
-declare const Markdown: z.core.$ZodBranded<z.ZodString, "Markdown">;
+/**
+ * Zod schema for validating markdown content.
+ *
+ * @remarks
+ * Validates that the markdown is a non-empty string.
+ * No maximum length is enforced to allow for long-form content.
+ *
+ * @example
+ * ```typescript
+ * const content = Markdown.parse("# Heading\n\nParagraph text");
+ * ```
+ *
+ * @see {@link makeMarkdown} for factory function
+ */
+export declare const Markdown: z.core.$ZodBranded<z.ZodString, "Markdown">;
+/**
+ * Branded type for validated markdown content.
+ */
 export type Markdown = z.infer<typeof Markdown>;
+/**
+ * Creates a validated Markdown from a string.
+ *
+ * @param v - The raw markdown string
+ * @returns A branded Markdown value
+ * @throws {ZodError} When the string is empty
+ *
+ * @example
+ * ```typescript
+ * const content = makeMarkdown("# Heading\n\nParagraph text");
+ * ```
+ */
 export declare const makeMarkdown: (v: string) => Markdown;
+/**
+ * Zod schema for an unexported note.
+ *
+ * @remarks
+ * Represents a note that has not yet been published.
+ * This is the initial state of all newly created notes.
+ *
+ * @see {@link ExportedNote} for the published state
+ */
 export declare const UnexportedNote: z.ZodObject<{
     id: z.core.$ZodBranded<z.ZodDefault<z.ZodUUID>, "Id">;
     userId: z.core.$ZodBranded<z.ZodString, "UserId">;
@@ -14,8 +80,23 @@ export declare const UnexportedNote: z.ZodObject<{
     createdAt: z.core.$ZodBranded<z.ZodDate, "CreatedAt">;
     status: z.ZodLiteral<"UNEXPORTED">;
 }, z.core.$strip>;
+/**
+ * Type for an unexported note entity.
+ *
+ * @remarks
+ * Immutable entity representing a note pending export.
+ */
 export type UnexportedNote = Readonly<z.infer<typeof UnexportedNote>>;
-declare const ExportedNote: z.ZodObject<{
+/**
+ * Zod schema for an exported note.
+ *
+ * @remarks
+ * Represents a note that has been published.
+ * Includes the exportedAt timestamp.
+ *
+ * @see {@link UnexportedNote} for the initial state
+ */
+export declare const ExportedNote: z.ZodObject<{
     id: z.core.$ZodBranded<z.ZodDefault<z.ZodUUID>, "Id">;
     userId: z.core.$ZodBranded<z.ZodString, "UserId">;
     title: z.core.$ZodBranded<z.ZodString, "NoteTitle">;
@@ -24,15 +105,140 @@ declare const ExportedNote: z.ZodObject<{
     status: z.ZodLiteral<"EXPORTED">;
     exportedAt: z.core.$ZodBranded<z.ZodDate, "ExportedAt">;
 }, z.core.$strip>;
-type ExportedNote = Readonly<z.infer<typeof ExportedNote>>;
-type CreateNoteArgs = Readonly<{
+/**
+ * Type for an exported note entity.
+ *
+ * @remarks
+ * Immutable entity representing a published note.
+ */
+export type ExportedNote = Readonly<z.infer<typeof ExportedNote>>;
+/**
+ * Zod schema for a note marked for export in the current batch.
+ *
+ * @remarks
+ * Represents a note that has been marked for export but not yet finalized.
+ * This intermediate state allows for batch processing with revert capability.
+ *
+ * @see {@link UnexportedNote} for the initial state
+ * @see {@link ExportedNote} for the final state
+ */
+export declare const LastUpdatedNote: z.ZodObject<{
+    id: z.core.$ZodBranded<z.ZodDefault<z.ZodUUID>, "Id">;
+    userId: z.core.$ZodBranded<z.ZodString, "UserId">;
+    title: z.core.$ZodBranded<z.ZodString, "NoteTitle">;
+    markdown: z.core.$ZodBranded<z.ZodString, "Markdown">;
+    createdAt: z.core.$ZodBranded<z.ZodDate, "CreatedAt">;
+    status: z.ZodLiteral<"LAST_UPDATED">;
+}, z.core.$strip>;
+/**
+ * Type for a note marked for export.
+ *
+ * @remarks
+ * Immutable entity representing a note in the current export batch.
+ * Can be reverted back to UnexportedNote or finalized to ExportedNote.
+ */
+export type LastUpdatedNote = Readonly<z.infer<typeof LastUpdatedNote>>;
+/**
+ * Arguments for creating a new note.
+ *
+ * @remarks
+ * Provides the required fields for note creation.
+ * The id, createdAt, and status are auto-generated.
+ *
+ * @example
+ * ```typescript
+ * const args: CreateNoteArgs = {
+ *   userId: makeUserId("user-123"),
+ *   title: makeNoteTitle("Meeting Notes"),
+ *   markdown: makeMarkdown("# Meeting Notes\n\n- Item 1\n- Item 2"),
+ * };
+ * ```
+ */
+export type CreateNoteArgs = Readonly<{
+    /** The user who owns the note */
     userId: UserId;
+    /** The note title */
     title: NoteTitle;
+    /** The markdown content */
     markdown: Markdown;
 }>;
+/**
+ * Factory object for Note 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 note
+ * const note = noteEntity.create({
+ *   userId: makeUserId("user-123"),
+ *   title: makeNoteTitle("Meeting Notes"),
+ *   markdown: makeMarkdown("# Content"),
+ * });
+ *
+ * // Export the note (changes status to EXPORTED)
+ * const exported = noteEntity.export(note);
+ * ```
+ *
+ * @see {@link CreateNoteArgs} for creation parameters
+ */
 export declare const noteEntity: {
+    /**
+     * Creates a new unexported note entity.
+     *
+     * @param args - The creation arguments containing required fields
+     * @returns A frozen UnexportedNote instance with generated id and timestamps
+     * @throws {InvalidFormatError} When validation of any field fails
+     * @throws {UnexpectedError} For unexpected errors during creation
+     */
     create: (args: CreateNoteArgs) => UnexportedNote;
+    /**
+     * Transitions a note from UNEXPORTED to EXPORTED status.
+     *
+     * @param note - The unexported note to export
+     * @returns A frozen ExportedNote with exportedAt timestamp
+     * @throws {InvalidFormatError} When the note state is invalid
+     * @throws {UnexpectedError} For unexpected errors during export
+     */
     export: (note: UnexportedNote) => ExportedNote;
+    /**
+     * Marks a note for export in the current batch.
+     *
+     * @remarks
+     * Transitions from UNEXPORTED to LAST_UPDATED status.
+     * This allows for batch processing with revert capability.
+     *
+     * @param note - The unexported note to mark
+     * @returns A frozen LastUpdatedNote
+     * @throws {InvalidFormatError} When the note state is invalid
+     * @throws {UnexpectedError} For unexpected errors
+     */
+    markAsLastUpdated: (note: UnexportedNote) => LastUpdatedNote;
+    /**
+     * Reverts a note from LAST_UPDATED back to UNEXPORTED.
+     *
+     * @remarks
+     * Use this when batch processing fails and needs to be rolled back.
+     *
+     * @param note - The last updated note to revert
+     * @returns A frozen UnexportedNote
+     * @throws {InvalidFormatError} When the note state is invalid
+     * @throws {UnexpectedError} For unexpected errors
+     */
+    revert: (note: LastUpdatedNote) => UnexportedNote;
+    /**
+     * Finalizes a note from LAST_UPDATED to EXPORTED.
+     *
+     * @remarks
+     * Use this after batch processing succeeds to confirm the export.
+     *
+     * @param note - The last updated note to finalize
+     * @returns A frozen ExportedNote with exportedAt timestamp
+     * @throws {InvalidFormatError} When the note state is invalid
+     * @throws {UnexpectedError} For unexpected errors
+     */
+    finalize: (note: LastUpdatedNote) => ExportedNote;
 };
-export {};
 //# sourceMappingURL=note-entity.d.ts.map

package/dist/notes/entities/note-entity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"note-entity.d.ts","sourceRoot":"","sources":["../../../notes/entities/note-entity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAQN,MAAM,EACN,MAAM,qCAAqC,CAAC;AAK7C,QAAA,MAAM,SAAS,8CAIO,CAAC;AACvB,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,SAAS,CAAC,CAAC;AAClD,eAAO,MAAM,aAAa,GAAI,GAAG,MAAM,KAAG,SAA+B,CAAC;AAE1E,QAAA,MAAM,QAAQ,6CAGO,CAAC;AACtB,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,QAAQ,CAAC,CAAC;AAChD,eAAO,MAAM,YAAY,GAAI,GAAG,MAAM,KAAG,QAA6B,CAAC;AAYvE,eAAO,MAAM,cAAc;;;;;;;iBAA4C,CAAC;AACxE,MAAM,MAAM,cAAc,GAAG,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC,CAAC;AAEtE,QAAA,MAAM,YAAY;;;;;;;;iBAAoC,CAAC;AACvD,KAAK,YAAY,GAAG,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC,CAAC;AAE3D,KAAK,cAAc,GAAG,QAAQ,CAAC;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,SAAS,CAAC;IACjB,QAAQ,EAAE,QAAQ,CAAC;CACnB,CAAC,CAAC;AAEH,eAAO,MAAM,UAAU;mBACP,cAAc,KAAG,cAAc;mBAW/B,cAAc,KAAG,YAAY;CAS5C,CAAC"}
+{"version":3,"file":"note-entity.d.ts","sourceRoot":"","sources":["../../../notes/entities/note-entity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EASN,MAAM,EACN,MAAM,qCAAqC,CAAC;AAK7C;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,SAAS,8CAIA,CAAC;AAEvB;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,SAAS,CAAC,CAAC;AAElD;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,aAAa,GAAI,GAAG,MAAM,KAAG,SAA+B,CAAC;AAE1E;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,QAAQ,6CAGA,CAAC;AAEtB;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,QAAQ,CAAC,CAAC;AAEhD;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,YAAY,GAAI,GAAG,MAAM,KAAG,QAA6B,CAAC;AAiBvE;;;;;;;;GAQG;AACH,eAAO,MAAM,cAAc;;;;;;;iBAA4C,CAAC;AAExE;;;;;GAKG;AACH,MAAM,MAAM,cAAc,GAAG,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC,CAAC;AAEtE;;;;;;;;GAQG;AACH,eAAO,MAAM,YAAY;;;;;;;;iBAAoC,CAAC;AAE9D;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC,CAAC;AAElE;;;;;;;;;GASG;AACH,eAAO,MAAM,eAAe;;;;;;;iBAA6C,CAAC;AAE1E;;;;;;GAMG;AACH,MAAM,MAAM,eAAe,GAAG,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,CAAC,CAAC;AAExE;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,cAAc,GAAG,QAAQ,CAAC;IACrC,iCAAiC;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,qBAAqB;IACrB,KAAK,EAAE,SAAS,CAAC;IACjB,2BAA2B;IAC3B,QAAQ,EAAE,QAAQ,CAAC;CACnB,CAAC,CAAC;AAEH;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,UAAU;IACtB;;;;;;;OAOG;mBACY,cAAc,KAAG,cAAc;IAW9C;;;;;;;OAOG;mBACY,cAAc,KAAG,YAAY;IAU5C;;;;;;;;;;;OAWG;8BACuB,cAAc,KAAG,eAAe;IAS1D;;;;;;;;;;OAUG;mBACY,eAAe,KAAG,cAAc;IAS/C;;;;;;;;;;OAUG;qBACc,eAAe,KAAG,YAAY;CAS/C,CAAC"}

package/dist/notes/entities/note-entity.js

@@ -1,19 +1,75 @@
 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 NoteTitle = z
+/**
+ * Zod schema for validating note titles.
+ *
+ * @remarks
+ * Validates that the title is a non-empty string between 1 and 64 characters.
+ *
+ * @example
+ * ```typescript
+ * const title = NoteTitle.parse("Meeting Notes");
+ * ```
+ *
+ * @see {@link makeNoteTitle} for factory function
+ */
+export const NoteTitle = z
     .string({ message: "required" })
     .min(1, { message: "required" })
     .max(64, { message: "tooLong" })
     .brand();
+/**
+ * Creates a validated NoteTitle from a string.
+ *
+ * @param v - The raw title string
+ * @returns A branded NoteTitle value
+ * @throws {ZodError} When validation fails (empty or exceeds 64 chars)
+ *
+ * @example
+ * ```typescript
+ * const title = makeNoteTitle("Meeting Notes");
+ * ```
+ */
 export const makeNoteTitle = (v) => NoteTitle.parse(v);
-const Markdown = z
+/**
+ * Zod schema for validating markdown content.
+ *
+ * @remarks
+ * Validates that the markdown is a non-empty string.
+ * No maximum length is enforced to allow for long-form content.
+ *
+ * @example
+ * ```typescript
+ * const content = Markdown.parse("# Heading\n\nParagraph text");
+ * ```
+ *
+ * @see {@link makeMarkdown} for factory function
+ */
+export const Markdown = z
     .string({ message: "required" })
     .min(1, { message: "required" })
     .brand();
+/**
+ * Creates a validated Markdown from a string.
+ *
+ * @param v - The raw markdown string
+ * @returns A branded Markdown value
+ * @throws {ZodError} When the string is empty
+ *
+ * @example
+ * ```typescript
+ * const content = makeMarkdown("# Heading\n\nParagraph text");
+ * ```
+ */
 export const makeMarkdown = (v) => Markdown.parse(v);
 // Entities
+/**
+ * Base schema containing common note fields.
+ *
+ * @internal
+ */
 const Base = z.object({
     id: Id,
     userId: UserId,
@@ -21,9 +77,68 @@ const Base = z.object({
     markdown: Markdown,
     createdAt: CreatedAt,
 });
+/**
+ * Zod schema for an unexported note.
+ *
+ * @remarks
+ * Represents a note that has not yet been published.
+ * This is the initial state of all newly created notes.
+ *
+ * @see {@link ExportedNote} for the published state
+ */
 export const UnexportedNote = Base.extend({ status: UnexportedStatus });
-const ExportedNote = Base.extend(ExportedStatus.shape);
+/**
+ * Zod schema for an exported note.
+ *
+ * @remarks
+ * Represents a note that has been published.
+ * Includes the exportedAt timestamp.
+ *
+ * @see {@link UnexportedNote} for the initial state
+ */
+export const ExportedNote = Base.extend(ExportedStatus.shape);
+/**
+ * Zod schema for a note marked for export in the current batch.
+ *
+ * @remarks
+ * Represents a note that has been marked for export but not yet finalized.
+ * This intermediate state allows for batch processing with revert capability.
+ *
+ * @see {@link UnexportedNote} for the initial state
+ * @see {@link ExportedNote} for the final state
+ */
+export const LastUpdatedNote = Base.extend({ status: LastUpdatedStatus });
+/**
+ * Factory object for Note 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 note
+ * const note = noteEntity.create({
+ *   userId: makeUserId("user-123"),
+ *   title: makeNoteTitle("Meeting Notes"),
+ *   markdown: makeMarkdown("# Content"),
+ * });
+ *
+ * // Export the note (changes status to EXPORTED)
+ * const exported = noteEntity.export(note);
+ * ```
+ *
+ * @see {@link CreateNoteArgs} for creation parameters
+ */
 export const noteEntity = {
+    /**
+     * Creates a new unexported note entity.
+     *
+     * @param args - The creation arguments containing required fields
+     * @returns A frozen UnexportedNote 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(),
@@ -32,6 +147,14 @@ export const noteEntity = {
             ...args,
         }));
     },
+    /**
+     * Transitions a note from UNEXPORTED to EXPORTED status.
+     *
+     * @param note - The unexported note to export
+     * @returns A frozen ExportedNote with exportedAt timestamp
+     * @throws {InvalidFormatError} When the note state is invalid
+     * @throws {UnexpectedError} For unexpected errors during export
+     */
     export: (note) => {
         return createEntityWithErrorHandling(() => {
             const exportedStatus = makeExportedStatus();
@@ -41,5 +164,60 @@ export const noteEntity = {
             });
         });
     },
+    /**
+     * Marks a note for export in the current batch.
+     *
+     * @remarks
+     * Transitions from UNEXPORTED to LAST_UPDATED status.
+     * This allows for batch processing with revert capability.
+     *
+     * @param note - The unexported note to mark
+     * @returns A frozen LastUpdatedNote
+     * @throws {InvalidFormatError} When the note state is invalid
+     * @throws {UnexpectedError} For unexpected errors
+     */
+    markAsLastUpdated: (note) => {
+        return createEntityWithErrorHandling(() => Object.freeze({
+            ...note,
+            status: "LAST_UPDATED",
+        }));
+    },
+    /**
+     * Reverts a note from LAST_UPDATED back to UNEXPORTED.
+     *
+     * @remarks
+     * Use this when batch processing fails and needs to be rolled back.
+     *
+     * @param note - The last updated note to revert
+     * @returns A frozen UnexportedNote
+     * @throws {InvalidFormatError} When the note state is invalid
+     * @throws {UnexpectedError} For unexpected errors
+     */
+    revert: (note) => {
+        return createEntityWithErrorHandling(() => Object.freeze({
+            ...note,
+            status: "UNEXPORTED",
+        }));
+    },
+    /**
+     * Finalizes a note from LAST_UPDATED to EXPORTED.
+     *
+     * @remarks
+     * Use this after batch processing succeeds to confirm the export.
+     *
+     * @param note - The last updated note to finalize
+     * @returns A frozen ExportedNote with exportedAt timestamp
+     * @throws {InvalidFormatError} When the note state is invalid
+     * @throws {UnexpectedError} For unexpected errors
+     */
+    finalize: (note) => {
+        return createEntityWithErrorHandling(() => {
+            const exportedStatus = makeExportedStatus();
+            return Object.freeze({
+                ...note,
+                ...exportedStatus,
+            });
+        });
+    },
 };
 //# sourceMappingURL=note-entity.js.map

package/dist/notes/entities/note-entity.js.map

@@ -1 +1 @@
-{"version":3,"file":"note-entity.js","sourceRoot":"","sources":["../../../notes/entities/note-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,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,EAAE,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;KAC/B,KAAK,EAAe,CAAC;AAEvB,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAS,EAAa,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAE1E,MAAM,QAAQ,GAAG,CAAC;KAChB,MAAM,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;KAC/B,GAAG,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;KAC/B,KAAK,EAAc,CAAC;AAEtB,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAS,EAAY,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAEvE,WAAW;AAEX,MAAM,IAAI,GAAG,CAAC,CAAC,MAAM,CAAC;IACrB,EAAE,EAAE,EAAE;IACN,MAAM,EAAE,MAAM;IACd,KAAK,EAAE,SAAS;IAChB,QAAQ,EAAE,QAAQ;IAClB,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":"note-entity.js","sourceRoot":"","sources":["../../../notes/entities/note-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;;;;;;;;;;;;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,EAAE,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;KAC/B,KAAK,EAAe,CAAC;AAOvB;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAS,EAAa,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAE1E;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC;KACvB,MAAM,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;KAC/B,GAAG,CAAC,CAAC,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC;KAC/B,KAAK,EAAc,CAAC;AAOtB;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAS,EAAY,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AAEvE,WAAW;AAEX;;;;GAIG;AACH,MAAM,IAAI,GAAG,CAAC,CAAC,MAAM,CAAC;IACrB,EAAE,EAAE,EAAE;IACN,MAAM,EAAE,MAAM;IACd,KAAK,EAAE,SAAS;IAChB,QAAQ,EAAE,QAAQ;IAClB,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/notes/events/note-created-event.d.ts

@@ -1,5 +1,37 @@
 import { BaseDomainEvent } from "../../common/events/base-domain-event";
+/**
+ * Domain event emitted when a note is created.
+ *
+ * @remarks
+ * Part of the event-driven architecture for cross-cutting concerns
+ * like notifications, logging, and analytics.
+ *
+ * @example
+ * ```typescript
+ * const event = new NoteCreatedEvent({
+ *   title: "Meeting Notes",
+ *   markdown: "# Meeting Notes\n\n- Item 1",
+ *   userId: "user-123",
+ *   caller: "addNote",
+ * });
+ *
+ * // event.eventType === "note.created"
+ * await eventHandler.handle(event);
+ * ```
+ *
+ * @see {@link BaseDomainEvent} for base class
+ * @see {@link NoteDeletedEvent} for deletion event
+ */
 export declare class NoteCreatedEvent extends BaseDomainEvent {
+    /**
+     * Creates a new NoteCreatedEvent.
+     *
+     * @param data - Event data containing note details and metadata
+     * @param data.title - The note title
+     * @param data.markdown - The markdown content
+     * @param data.userId - The user who created the note
+     * @param data.caller - The function/method that triggered the event
+     */
     constructor(data: {
         title: string;
         markdown: string;

package/dist/notes/events/note-created-event.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"note-created-event.d.ts","sourceRoot":"","sources":["../../../notes/events/note-created-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,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;KACf;CAaD"}
+{"version":3,"file":"note-created-event.d.ts","sourceRoot":"","sources":["../../../notes/events/note-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,KAAK,EAAE,MAAM,CAAC;QACd,QAAQ,EAAE,MAAM,CAAC;QACjB,MAAM,EAAE,MAAM,CAAC;QACf,MAAM,EAAE,MAAM,CAAC;KACf;CAaD"}

package/dist/notes/events/note-created-event.js

@@ -1,5 +1,37 @@
 import { BaseDomainEvent } from "../../common/events/base-domain-event";
+/**
+ * Domain event emitted when a note is created.
+ *
+ * @remarks
+ * Part of the event-driven architecture for cross-cutting concerns
+ * like notifications, logging, and analytics.
+ *
+ * @example
+ * ```typescript
+ * const event = new NoteCreatedEvent({
+ *   title: "Meeting Notes",
+ *   markdown: "# Meeting Notes\n\n- Item 1",
+ *   userId: "user-123",
+ *   caller: "addNote",
+ * });
+ *
+ * // event.eventType === "note.created"
+ * await eventHandler.handle(event);
+ * ```
+ *
+ * @see {@link BaseDomainEvent} for base class
+ * @see {@link NoteDeletedEvent} for deletion event
+ */
 export class NoteCreatedEvent extends BaseDomainEvent {
+    /**
+     * Creates a new NoteCreatedEvent.
+     *
+     * @param data - Event data containing note details and metadata
+     * @param data.title - The note title
+     * @param data.markdown - The markdown content
+     * @param data.userId - The user who created the note
+     * @param data.caller - The function/method that triggered the event
+     */
     constructor(data) {
         super("note.created", {
             title: data.title,

package/dist/notes/events/note-created-event.js.map

@@ -1 +1 @@
-{"version":3,"file":"note-created-event.js","sourceRoot":"","sources":["../../../notes/events/note-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,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACvB,EACD;YACC,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,MAAM,EAAE,IAAI,CAAC,MAAM;SACnB,CACD,CAAC;IACH,CAAC;CACD"}
+{"version":3,"file":"note-created-event.js","sourceRoot":"","sources":["../../../notes/events/note-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,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACvB,EACD;YACC,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,MAAM,EAAE,IAAI,CAAC,MAAM;SACnB,CACD,CAAC;IACH,CAAC;CACD"}

package/dist/notes/events/note-deleted-event.d.ts

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

package/dist/notes/events/note-deleted-event.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"note-deleted-event.d.ts","sourceRoot":"","sources":["../../../notes/events/note-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":"note-deleted-event.d.ts","sourceRoot":"","sources":["../../../notes/events/note-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/notes/events/note-deleted-event.js

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

package/dist/notes/events/note-deleted-event.js.map

@@ -1 +1 @@
-{"version":3,"file":"note-deleted-event.js","sourceRoot":"","sources":["../../../notes/events/note-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":"note-deleted-event.js","sourceRoot":"","sources":["../../../notes/events/note-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"}