@decaf-ts/db-decorators 0.6.1 → 0.6.2

package/lib/validation/constants.d.ts

@@ -1,8 +1,18 @@
 /**
- * @summary holds the default error messages
+ * @description Collection of default error messages used by validators.
+ * @summary Holds the default error messages for various validation scenarios including ID validation, readonly properties, and timestamps.
+ * @typedef {Object} ErrorMessages
+ * @property {Object} ID - Error messages for ID validation
+ * @property {string} ID.INVALID - Error message when an ID is invalid
+ * @property {string} ID.REQUIRED - Error message when an ID is missing
+ * @property {Object} READONLY - Error messages for readonly properties
+ * @property {string} READONLY.INVALID - Error message when attempting to update a readonly property
+ * @property {Object} TIMESTAMP - Error messages for timestamp validation
+ * @property {string} TIMESTAMP.REQUIRED - Error message when a timestamp is missing
+ * @property {string} TIMESTAMP.DATE - Error message when a timestamp is not a valid date
+ * @property {string} TIMESTAMP.INVALID - Error message when a timestamp is not increasing
  * @const DEFAULT_ERROR_MESSAGES
- *
- * @memberOf module:db-decorators.Model
+ * @memberOf module:validation
  */
 export declare const DEFAULT_ERROR_MESSAGES: {
     ID: {
@@ -19,9 +29,14 @@ export declare const DEFAULT_ERROR_MESSAGES: {
     };
 };
 /**
- * @summary Update reflection keys
+ * @description Constants used for reflection-based validation during update operations.
+ * @summary Keys used for storing and retrieving validation metadata on model properties during update operations.
+ * @typedef {Object} ValidationKeys
+ * @property {string} REFLECT - Base reflection key prefix for update validation
+ * @property {string} TIMESTAMP - Key for timestamp validation
+ * @property {string} READONLY - Key for readonly property validation
  * @const UpdateValidationKeys
- * @memberOf module:db-decorators.Operations
+ * @memberOf module:validation
  */
 export declare const UpdateValidationKeys: {
     REFLECT: string;

package/lib/validation/decorators.cjs

@@ -16,13 +16,12 @@ const errors_1 = require("./../repository/errors.cjs");
 const reflection_1 = require("@decaf-ts/reflection");
 const repository_1 = require("./../repository/index.cjs");
 /**
- * Marks the property as readonly.
- *
- * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES.READONLY.INVALID}
- *
- * @decorator readonly
- *
- * @category Decorators
+ * @description Prevents a property from being modified after initial creation.
+ * @summary Marks the property as readonly, causing validation errors if attempts are made to modify it during updates.
+ * @param {string} [message] - The error message to display when validation fails. Defaults to {@link DEFAULT_ERROR_MESSAGES.READONLY.INVALID}
+ * @return {PropertyDecorator} A decorator function that can be applied to class properties
+ * @function readonly
+ * @category Property Decorators
  */
 function readonly(message = constants_2.DEFAULT_ERROR_MESSAGES.READONLY.INVALID) {
     const key = decorator_validation_1.Validation.updateKey(constants_1.DBKeys.READONLY);
@@ -32,13 +31,28 @@ function readonly(message = constants_2.DEFAULT_ERROR_MESSAGES.READONLY.INVALID)
     }))
         .apply();
 }
+/**
+ * @description Handler function that sets a timestamp property to the current timestamp.
+ * @summary Updates a model property with the current timestamp from the repository context.
+ * @template M - The model type extending Model
+ * @template R - The repository type extending IRepository
+ * @template V - The data type for the operation
+ * @template F - The repository flags type
+ * @template C - The context type
+ * @param {C} context - The repository context containing the current timestamp
+ * @param {V} data - The data being processed
+ * @param key - The property key to update
+ * @param {M} model - The model instance being updated
+ * @return {Promise<void>} A promise that resolves when the timestamp has been set
+ * @function timestampHandler
+ * @memberOf module:db-decorators
+ */
 async function timestampHandler(context, data, key, model) {
     model[key] = context.timestamp;
 }
 /**
- * Marks the property as timestamp.
- * Makes it {@link required}
- * Makes it a {@link date}
+ * @description Automatically manages timestamp properties for tracking creation and update times.
+ * @summary Marks the property as a timestamp, making it required and ensuring it's a valid date. The property will be automatically updated with the current timestamp during specified operations.
  *
  * Date Format:
  *
@@ -58,13 +72,30 @@ async function timestampHandler(context, data, key, model) {
  *      S = miliseconds
  * </pre>
  *
- * @param {string[]} operation The {@link DBOperations} to act on. Defaults to {@link DBOperations.CREATE_UPDATE}
- * @param {string} [format] The TimeStamp format. defaults to {@link DEFAULT_TIMESTAMP_FORMAT}
- * @param {{new: UpdateValidator}} [validator] defaults to {@link TimestampValidator}
+ * @param {OperationKeys[]} operation - The operations to act on. Defaults to {@link DBOperations.CREATE_UPDATE}
+ * @param {string} [format] - The timestamp format. Defaults to {@link DEFAULT_TIMESTAMP_FORMAT}
+ * @return {PropertyDecorator} A decorator function that can be applied to class properties
+ * @function timestamp
+ * @category Property Decorators
+ * @mermaid
+ * sequenceDiagram
+ *   participant C as Client
+ *   participant M as Model
+ *   participant T as TimestampDecorator
+ *   participant V as Validator
+ *
+ *   C->>M: Create/Update model
+ *   M->>T: Process timestamp property
+ *   T->>M: Apply required validation
+ *   T->>M: Apply date format validation
  *
- * @decorator timestamp
+ *   alt Update operation
+ *     T->>V: Register timestamp validator
+ *     V->>M: Validate timestamp is newer
+ *   end
  *
- * @category Decorators
+ *   T->>M: Set current timestamp
+ *   M->>C: Return updated model
  */
 function timestamp(operation = constants_3.DBOperations.CREATE_UPDATE, format = constants_1.DEFAULT_TIMESTAMP_FORMAT) {
     const key = decorator_validation_1.Validation.updateKey(constants_1.DBKeys.TIMESTAMP);
@@ -81,6 +112,22 @@ function timestamp(operation = constants_3.DBOperations.CREATE_UPDATE, format =
         .define(...decorators)
         .apply();
 }
+/**
+ * @description Handler function that serializes a property to JSON string during create and update operations.
+ * @summary Converts a complex object property to a JSON string before storing it in the database.
+ * @template M - The model type extending Model
+ * @template R - The repository type extending IRepository
+ * @template V - The data type for the operation
+ * @template F - The repository flags type
+ * @template C - The context type
+ * @param {C} context - The repository context
+ * @param {V} data - The data being processed
+ * @param key - The property key to serialize
+ * @param {M} model - The model instance being processed
+ * @return {Promise<void>} A promise that resolves when the property has been serialized
+ * @function serializeOnCreateUpdate
+ * @memberOf module:db-decorators
+ */
 async function serializeOnCreateUpdate(context, data, key, model) {
     if (!model[key])
         return;
@@ -92,6 +139,22 @@ async function serializeOnCreateUpdate(context, data, key, model) {
         throw new errors_1.SerializationError(`Failed to serialize ${key.toString()} property of model ${model.constructor.name}: e`);
     }
 }
+/**
+ * @description Handler function that deserializes a property from JSON string after database operations.
+ * @summary Converts a JSON string property back to its original complex object form after retrieving it from the database.
+ * @template M - The model type extending Model
+ * @template R - The repository type extending IRepository
+ * @template V - The data type for the operation
+ * @template F - The repository flags type
+ * @template C - The context type
+ * @param {C} context - The repository context
+ * @param {V} data - The data being processed
+ * @param key - The property key to deserialize
+ * @param {M} model - The model instance being processed
+ * @return {Promise<void>} A promise that resolves when the property has been deserialized
+ * @function serializeAfterAll
+ * @memberOf module:db-decorators
+ */
 async function serializeAfterAll(context, data, key, model) {
     if (!model[key])
         return;
@@ -105,14 +168,33 @@ async function serializeAfterAll(context, data, key, model) {
     }
 }
 /**
- * @summary Serialize Decorator
- * @description properties decorated will the serialized before stored in the db
- *
+ * @description Enables automatic JSON serialization and deserialization for complex object properties.
+ * @summary Decorator that automatically converts complex objects to JSON strings before storing in the database and back to objects when retrieving them.
+ * @return {PropertyDecorator} A decorator function that can be applied to class properties
  * @function serialize
+ * @category Property Decorators
+ * @mermaid
+ * sequenceDiagram
+ *   participant C as Client
+ *   participant M as Model
+ *   participant S as SerializeDecorator
+ *   participant DB as Database
+ *
+ *   Note over C,DB: Create/Update Flow
+ *   C->>M: Set complex object property
+ *   M->>S: Process property (create/update)
+ *   S->>M: Convert to JSON string
+ *   M->>DB: Store serialized data
  *
- * @memberOf module:wallet-db.Decorators
+ *   Note over C,DB: Retrieval Flow
+ *   C->>M: Request model
+ *   M->>DB: Fetch data
+ *   DB->>M: Return with serialized property
+ *   M->>S: Process property (after all ops)
+ *   S->>M: Parse JSON back to object
+ *   M->>C: Return model with deserialized property
  */
 function serialize() {
     return (0, reflection_1.apply)((0, decorators_1.onCreateUpdate)(serializeOnCreateUpdate), (0, decorators_1.after)(constants_3.DBOperations.ALL, serializeAfterAll), (0, decorator_validation_1.type)([String.name, Object.name]), (0, reflection_1.metadata)(repository_1.Repository.key(constants_1.DBKeys.SERIALIZE), {}));
 }
-//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"decorators.js","sourceRoot":"","sources":["../../src/validation/decorators.ts"],"names":[],"mappings":";;AA8BA,4BAWC;AAED,4CAQC;AAiCD,8BAqBC;AAED,0DAgBC;AAED,8CAiBC;AAUD,8BAOC;AA/JD,4BAAsB;AACtB,yEAQwC;AACxC,wDAAsE;AACtE,+CAAqD;AACrD,6DAAsE;AACtE,+DAAqE;AAErE,uDAA0D;AAC1D,qDAAuD;AACvD,0DAA2C;AAI3C;;;;;;;;GAQG;AACH,SAAgB,QAAQ,CACtB,UAAkB,kCAAsB,CAAC,QAAQ,CAAC,OAAO;IAEzD,MAAM,GAAG,GAAG,iCAAU,CAAC,SAAS,CAAC,kBAAM,CAAC,QAAQ,CAAC,CAAC;IAClD,OAAO,iCAAU,CAAC,GAAG,CAAC,GAAG,CAAC;SACvB,MAAM,CACL,IAAA,mCAAY,EAAC,GAAG,EAAE;QAChB,OAAO,EAAE,OAAO;KACjB,CAAC,CACH;SACA,KAAK,EAAE,CAAC;AACb,CAAC;AAEM,KAAK,UAAU,gBAAgB,CAM3B,OAAU,EAAE,IAAO,EAAE,GAAY,EAAE,KAAQ;IACnD,KAAa,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC;AAC1C,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,SAAgB,SAAS,CACvB,YAA6B,wBAAY,CAAC,aAA2C,EACrF,SAAiB,oCAAwB;IAEzC,MAAM,GAAG,GAAG,iCAAU,CAAC,SAAS,CAAC,kBAAM,CAAC,SAAS,CAAC,CAAC;IAEnD,MAAM,UAAU,GAAU;QACxB,IAAA,2BAAI,EAAC,MAAM,EAAE,kCAAsB,CAAC,SAAS,CAAC,IAAI,CAAC;QACnD,IAAA,+BAAQ,EAAC,kCAAsB,CAAC,SAAS,CAAC,QAAQ,CAAC;QACnD,IAAA,eAAE,EAAC,SAAS,EAAE,gBAAgB,CAAC;KAChC,CAAC;IAEF,IAAI,SAAS,CAAC,OAAO,CAAC,yBAAa,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAChD,UAAU,CAAC,IAAI,CACb,IAAA,mCAAY,EAAC,iCAAU,CAAC,SAAS,CAAC,kBAAM,CAAC,SAAS,CAAC,EAAE;YACnD,OAAO,EAAE,kCAAsB,CAAC,SAAS,CAAC,OAAO;SAClD,CAAC,CACH,CAAC;IACJ,OAAO,iCAAU,CAAC,GAAG,CAAC,GAAG,CAAC;SACvB,MAAM,CAAC,GAAG,UAAU,CAAC;SACrB,KAAK,EAAE,CAAC;AACb,CAAC;AAEM,KAAK,UAAU,uBAAuB,CAMlC,OAAU,EAAE,IAAO,EAAE,GAAY,EAAE,KAAQ;IACpD,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC;QAAE,OAAO;IACxB,IAAI,CAAC;QACH,KAAK,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAe,CAAC;QACtD,6DAA6D;IAC/D,CAAC;IAAC,OAAO,CAAU,EAAE,CAAC;QACpB,MAAM,IAAI,2BAAkB,CAC1B,uBAAuB,GAAG,CAAC,QAAQ,EAAE,sBAAsB,KAAK,CAAC,WAAW,CAAC,IAAI,KAAK,CACvF,CAAC;IACJ,CAAC;AACH,CAAC;AAEM,KAAK,UAAU,iBAAiB,CAM5B,OAAU,EAAE,IAAO,EAAE,GAAY,EAAE,KAAQ;IACpD,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC;QAAE,OAAO;IACxB,IAAI,OAAO,KAAK,CAAC,GAAG,CAAC,KAAK,QAAQ;QAAE,OAAO;IAE3C,IAAI,CAAC;QACH,KAAK,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IACtC,CAAC;IAAC,OAAO,CAAU,EAAE,CAAC;QACpB,MAAM,IAAI,2BAAkB,CAC1B,yBAAyB,GAAG,CAAC,QAAQ,EAAE,sBAAsB,KAAK,CAAC,WAAW,CAAC,IAAI,KAAK,CAAC,EAAE,CAC5F,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,SAAS;IACvB,OAAO,IAAA,kBAAK,EACV,IAAA,2BAAc,EAAC,uBAAuB,CAAC,EACvC,IAAA,kBAAK,EAAC,wBAAY,CAAC,GAAG,EAAE,iBAAiB,CAAC,EAC1C,IAAA,2BAAI,EAAC,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,EAChC,IAAA,qBAAQ,EAAC,uBAAU,CAAC,GAAG,CAAC,kBAAM,CAAC,SAAS,CAAC,EAAE,EAAE,CAAC,CAC/C,CAAC;AACJ,CAAC","sourcesContent":["import \"./validation\";\nimport {\n  date,\n  Decoration,\n  Model,\n  propMetadata,\n  required,\n  type,\n  Validation,\n} from \"@decaf-ts/decorator-validation\";\nimport { DBKeys, DEFAULT_TIMESTAMP_FORMAT } from \"../model/constants\";\nimport { DEFAULT_ERROR_MESSAGES } from \"./constants\";\nimport { DBOperations, OperationKeys } from \"../operations/constants\";\nimport { after, on, onCreateUpdate } from \"../operations/decorators\";\nimport { IRepository } from \"../interfaces/IRepository\";\nimport { SerializationError } from \"../repository/errors\";\nimport { apply, metadata } from \"@decaf-ts/reflection\";\nimport { Repository } from \"../repository\";\nimport { Context } from \"../repository/Context\";\nimport { RepositoryFlags } from \"../repository/types\";\n\n/**\n * Marks the property as readonly.\n *\n * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES.READONLY.INVALID}\n *\n * @decorator readonly\n *\n * @category Decorators\n */\nexport function readonly(\n  message: string = DEFAULT_ERROR_MESSAGES.READONLY.INVALID\n) {\n  const key = Validation.updateKey(DBKeys.READONLY);\n  return Decoration.for(key)\n    .define(\n      propMetadata(key, {\n        message: message,\n      })\n    )\n    .apply();\n}\n\nexport async function timestampHandler<\n  M extends Model,\n  R extends IRepository<M, F, C>,\n  V,\n  F extends RepositoryFlags = RepositoryFlags,\n  C extends Context<F> = Context<F>,\n>(this: R, context: C, data: V, key: keyof M, model: M): Promise<void> {\n  (model as any)[key] = context.timestamp;\n}\n\n/**\n * Marks the property as timestamp.\n * Makes it {@link required}\n * Makes it a {@link date}\n *\n * Date Format:\n *\n * <pre>\n *      Using similar formatting as Moment.js, Class DateTimeFormatter (Java), and Class SimpleDateFormat (Java),\n *      I implemented a comprehensive solution formatDate(date, patternStr) where the code is easy to read and modify.\n *      You can display date, time, AM/PM, etc.\n *\n *      Date and Time Patterns\n *      yy = 2-digit year; yyyy = full year\n *      M = digit month; MM = 2-digit month; MMM = short month name; MMMM = full month name\n *      EEEE = full weekday name; EEE = short weekday name\n *      d = digit day; dd = 2-digit day\n *      h = hours am/pm; hh = 2-digit hours am/pm; H = hours; HH = 2-digit hours\n *      m = minutes; mm = 2-digit minutes; aaa = AM/PM\n *      s = seconds; ss = 2-digit seconds\n *      S = miliseconds\n * </pre>\n *\n * @param {string[]} operation The {@link DBOperations} to act on. Defaults to {@link DBOperations.CREATE_UPDATE}\n * @param {string} [format] The TimeStamp format. defaults to {@link DEFAULT_TIMESTAMP_FORMAT}\n * @param {{new: UpdateValidator}} [validator] defaults to {@link TimestampValidator}\n *\n * @decorator timestamp\n *\n * @category Decorators\n */\nexport function timestamp(\n  operation: OperationKeys[] = DBOperations.CREATE_UPDATE as unknown as OperationKeys[],\n  format: string = DEFAULT_TIMESTAMP_FORMAT\n) {\n  const key = Validation.updateKey(DBKeys.TIMESTAMP);\n\n  const decorators: any[] = [\n    date(format, DEFAULT_ERROR_MESSAGES.TIMESTAMP.DATE),\n    required(DEFAULT_ERROR_MESSAGES.TIMESTAMP.REQUIRED),\n    on(operation, timestampHandler),\n  ];\n\n  if (operation.indexOf(OperationKeys.UPDATE) !== -1)\n    decorators.push(\n      propMetadata(Validation.updateKey(DBKeys.TIMESTAMP), {\n        message: DEFAULT_ERROR_MESSAGES.TIMESTAMP.INVALID,\n      })\n    );\n  return Decoration.for(key)\n    .define(...decorators)\n    .apply();\n}\n\nexport async function serializeOnCreateUpdate<\n  M extends Model,\n  R extends IRepository<M, F, C>,\n  V,\n  F extends RepositoryFlags = RepositoryFlags,\n  C extends Context<F> = Context<F>,\n>(this: R, context: C, data: V, key: keyof M, model: M): Promise<void> {\n  if (!model[key]) return;\n  try {\n    model[key] = JSON.stringify(model[key]) as M[keyof M];\n    // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  } catch (e: unknown) {\n    throw new SerializationError(\n      `Failed to serialize ${key.toString()} property of model ${model.constructor.name}: e`\n    );\n  }\n}\n\nexport async function serializeAfterAll<\n  M extends Model,\n  R extends IRepository<M, F, C>,\n  V,\n  F extends RepositoryFlags = RepositoryFlags,\n  C extends Context<F> = Context<F>,\n>(this: R, context: C, data: V, key: keyof M, model: M): Promise<void> {\n  if (!model[key]) return;\n  if (typeof model[key] !== \"string\") return;\n\n  try {\n    model[key] = JSON.parse(model[key]);\n  } catch (e: unknown) {\n    throw new SerializationError(\n      `Failed to deserialize ${key.toString()} property of model ${model.constructor.name}: ${e}`\n    );\n  }\n}\n\n/**\n * @summary Serialize Decorator\n * @description properties decorated will the serialized before stored in the db\n *\n * @function serialize\n *\n * @memberOf module:wallet-db.Decorators\n */\nexport function serialize() {\n  return apply(\n    onCreateUpdate(serializeOnCreateUpdate),\n    after(DBOperations.ALL, serializeAfterAll),\n    type([String.name, Object.name]),\n    metadata(Repository.key(DBKeys.SERIALIZE), {})\n  );\n}\n"]}
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"decorators.js","sourceRoot":"","sources":["../../src/validation/decorators.ts"],"names":[],"mappings":";;AA6BA,4BAWC;AAkBD,4CAQC;AAiDD,8BAqBC;AAkBD,0DAgBC;AAkBD,8CAiBC;AA6BD,8BAOC;AAjPD,4BAAsB;AACtB,yEAQwC;AACxC,wDAAsE;AACtE,+CAAqD;AACrD,6DAAsE;AACtE,+DAAqE;AAErE,uDAA0D;AAC1D,qDAAuD;AACvD,0DAA2C;AAI3C;;;;;;;GAOG;AACH,SAAgB,QAAQ,CACtB,UAAkB,kCAAsB,CAAC,QAAQ,CAAC,OAAO;IAEzD,MAAM,GAAG,GAAG,iCAAU,CAAC,SAAS,CAAC,kBAAM,CAAC,QAAQ,CAAC,CAAC;IAClD,OAAO,iCAAU,CAAC,GAAG,CAAC,GAAG,CAAC;SACvB,MAAM,CACL,IAAA,mCAAY,EAAC,GAAG,EAAE;QAChB,OAAO,EAAE,OAAO;KACjB,CAAC,CACH;SACA,KAAK,EAAE,CAAC;AACb,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACI,KAAK,UAAU,gBAAgB,CAM3B,OAAU,EAAE,IAAO,EAAE,GAAY,EAAE,KAAQ;IACnD,KAAa,CAAC,GAAG,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC;AAC1C,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8CG;AACH,SAAgB,SAAS,CACvB,YAA6B,wBAAY,CAAC,aAA2C,EACrF,SAAiB,oCAAwB;IAEzC,MAAM,GAAG,GAAG,iCAAU,CAAC,SAAS,CAAC,kBAAM,CAAC,SAAS,CAAC,CAAC;IAEnD,MAAM,UAAU,GAAU;QACxB,IAAA,2BAAI,EAAC,MAAM,EAAE,kCAAsB,CAAC,SAAS,CAAC,IAAI,CAAC;QACnD,IAAA,+BAAQ,EAAC,kCAAsB,CAAC,SAAS,CAAC,QAAQ,CAAC;QACnD,IAAA,eAAE,EAAC,SAAS,EAAE,gBAAgB,CAAC;KAChC,CAAC;IAEF,IAAI,SAAS,CAAC,OAAO,CAAC,yBAAa,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAChD,UAAU,CAAC,IAAI,CACb,IAAA,mCAAY,EAAC,iCAAU,CAAC,SAAS,CAAC,kBAAM,CAAC,SAAS,CAAC,EAAE;YACnD,OAAO,EAAE,kCAAsB,CAAC,SAAS,CAAC,OAAO;SAClD,CAAC,CACH,CAAC;IACJ,OAAO,iCAAU,CAAC,GAAG,CAAC,GAAG,CAAC;SACvB,MAAM,CAAC,GAAG,UAAU,CAAC;SACrB,KAAK,EAAE,CAAC;AACb,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACI,KAAK,UAAU,uBAAuB,CAMlC,OAAU,EAAE,IAAO,EAAE,GAAY,EAAE,KAAQ;IACpD,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC;QAAE,OAAO;IACxB,IAAI,CAAC;QACH,KAAK,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAe,CAAC;QACtD,6DAA6D;IAC/D,CAAC;IAAC,OAAO,CAAU,EAAE,CAAC;QACpB,MAAM,IAAI,2BAAkB,CAC1B,uBAAuB,GAAG,CAAC,QAAQ,EAAE,sBAAsB,KAAK,CAAC,WAAW,CAAC,IAAI,KAAK,CACvF,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACI,KAAK,UAAU,iBAAiB,CAM5B,OAAU,EAAE,IAAO,EAAE,GAAY,EAAE,KAAQ;IACpD,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC;QAAE,OAAO;IACxB,IAAI,OAAO,KAAK,CAAC,GAAG,CAAC,KAAK,QAAQ;QAAE,OAAO;IAE3C,IAAI,CAAC;QACH,KAAK,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IACtC,CAAC;IAAC,OAAO,CAAU,EAAE,CAAC;QACpB,MAAM,IAAI,2BAAkB,CAC1B,yBAAyB,GAAG,CAAC,QAAQ,EAAE,sBAAsB,KAAK,CAAC,WAAW,CAAC,IAAI,KAAK,CAAC,EAAE,CAC5F,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,SAAgB,SAAS;IACvB,OAAO,IAAA,kBAAK,EACV,IAAA,2BAAc,EAAC,uBAAuB,CAAC,EACvC,IAAA,kBAAK,EAAC,wBAAY,CAAC,GAAG,EAAE,iBAAiB,CAAC,EAC1C,IAAA,2BAAI,EAAC,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,EAChC,IAAA,qBAAQ,EAAC,uBAAU,CAAC,GAAG,CAAC,kBAAM,CAAC,SAAS,CAAC,EAAE,EAAE,CAAC,CAC/C,CAAC;AACJ,CAAC","sourcesContent":["import \"./validation\";\nimport {\n  date,\n  Decoration,\n  Model,\n  propMetadata,\n  required,\n  type,\n  Validation,\n} from \"@decaf-ts/decorator-validation\";\nimport { DBKeys, DEFAULT_TIMESTAMP_FORMAT } from \"../model/constants\";\nimport { DEFAULT_ERROR_MESSAGES } from \"./constants\";\nimport { DBOperations, OperationKeys } from \"../operations/constants\";\nimport { after, on, onCreateUpdate } from \"../operations/decorators\";\nimport { IRepository } from \"../interfaces/IRepository\";\nimport { SerializationError } from \"../repository/errors\";\nimport { apply, metadata } from \"@decaf-ts/reflection\";\nimport { Repository } from \"../repository\";\nimport { Context } from \"../repository/Context\";\nimport { RepositoryFlags } from \"../repository/types\";\n\n/**\n * @description Prevents a property from being modified after initial creation.\n * @summary Marks the property as readonly, causing validation errors if attempts are made to modify it during updates.\n * @param {string} [message] - The error message to display when validation fails. Defaults to {@link DEFAULT_ERROR_MESSAGES.READONLY.INVALID}\n * @return {PropertyDecorator} A decorator function that can be applied to class properties\n * @function readonly\n * @category Property Decorators\n */\nexport function readonly(\n  message: string = DEFAULT_ERROR_MESSAGES.READONLY.INVALID\n) {\n  const key = Validation.updateKey(DBKeys.READONLY);\n  return Decoration.for(key)\n    .define(\n      propMetadata(key, {\n        message: message,\n      })\n    )\n    .apply();\n}\n\n/**\n * @description Handler function that sets a timestamp property to the current timestamp.\n * @summary Updates a model property with the current timestamp from the repository context.\n * @template M - The model type extending Model\n * @template R - The repository type extending IRepository\n * @template V - The data type for the operation\n * @template F - The repository flags type\n * @template C - The context type\n * @param {C} context - The repository context containing the current timestamp\n * @param {V} data - The data being processed\n * @param key - The property key to update\n * @param {M} model - The model instance being updated\n * @return {Promise<void>} A promise that resolves when the timestamp has been set\n * @function timestampHandler\n * @memberOf module:db-decorators\n */\nexport async function timestampHandler<\n  M extends Model,\n  R extends IRepository<M, F, C>,\n  V,\n  F extends RepositoryFlags = RepositoryFlags,\n  C extends Context<F> = Context<F>,\n>(this: R, context: C, data: V, key: keyof M, model: M): Promise<void> {\n  (model as any)[key] = context.timestamp;\n}\n\n/**\n * @description Automatically manages timestamp properties for tracking creation and update times.\n * @summary Marks the property as a timestamp, making it required and ensuring it's a valid date. The property will be automatically updated with the current timestamp during specified operations.\n *\n * Date Format:\n *\n * <pre>\n *      Using similar formatting as Moment.js, Class DateTimeFormatter (Java), and Class SimpleDateFormat (Java),\n *      I implemented a comprehensive solution formatDate(date, patternStr) where the code is easy to read and modify.\n *      You can display date, time, AM/PM, etc.\n *\n *      Date and Time Patterns\n *      yy = 2-digit year; yyyy = full year\n *      M = digit month; MM = 2-digit month; MMM = short month name; MMMM = full month name\n *      EEEE = full weekday name; EEE = short weekday name\n *      d = digit day; dd = 2-digit day\n *      h = hours am/pm; hh = 2-digit hours am/pm; H = hours; HH = 2-digit hours\n *      m = minutes; mm = 2-digit minutes; aaa = AM/PM\n *      s = seconds; ss = 2-digit seconds\n *      S = miliseconds\n * </pre>\n *\n * @param {OperationKeys[]} operation - The operations to act on. Defaults to {@link DBOperations.CREATE_UPDATE}\n * @param {string} [format] - The timestamp format. Defaults to {@link DEFAULT_TIMESTAMP_FORMAT}\n * @return {PropertyDecorator} A decorator function that can be applied to class properties\n * @function timestamp\n * @category Property Decorators\n * @mermaid\n * sequenceDiagram\n *   participant C as Client\n *   participant M as Model\n *   participant T as TimestampDecorator\n *   participant V as Validator\n *\n *   C->>M: Create/Update model\n *   M->>T: Process timestamp property\n *   T->>M: Apply required validation\n *   T->>M: Apply date format validation\n *\n *   alt Update operation\n *     T->>V: Register timestamp validator\n *     V->>M: Validate timestamp is newer\n *   end\n *\n *   T->>M: Set current timestamp\n *   M->>C: Return updated model\n */\nexport function timestamp(\n  operation: OperationKeys[] = DBOperations.CREATE_UPDATE as unknown as OperationKeys[],\n  format: string = DEFAULT_TIMESTAMP_FORMAT\n) {\n  const key = Validation.updateKey(DBKeys.TIMESTAMP);\n\n  const decorators: any[] = [\n    date(format, DEFAULT_ERROR_MESSAGES.TIMESTAMP.DATE),\n    required(DEFAULT_ERROR_MESSAGES.TIMESTAMP.REQUIRED),\n    on(operation, timestampHandler),\n  ];\n\n  if (operation.indexOf(OperationKeys.UPDATE) !== -1)\n    decorators.push(\n      propMetadata(Validation.updateKey(DBKeys.TIMESTAMP), {\n        message: DEFAULT_ERROR_MESSAGES.TIMESTAMP.INVALID,\n      })\n    );\n  return Decoration.for(key)\n    .define(...decorators)\n    .apply();\n}\n\n/**\n * @description Handler function that serializes a property to JSON string during create and update operations.\n * @summary Converts a complex object property to a JSON string before storing it in the database.\n * @template M - The model type extending Model\n * @template R - The repository type extending IRepository\n * @template V - The data type for the operation\n * @template F - The repository flags type\n * @template C - The context type\n * @param {C} context - The repository context\n * @param {V} data - The data being processed\n * @param key - The property key to serialize\n * @param {M} model - The model instance being processed\n * @return {Promise<void>} A promise that resolves when the property has been serialized\n * @function serializeOnCreateUpdate\n * @memberOf module:db-decorators\n */\nexport async function serializeOnCreateUpdate<\n  M extends Model,\n  R extends IRepository<M, F, C>,\n  V,\n  F extends RepositoryFlags = RepositoryFlags,\n  C extends Context<F> = Context<F>,\n>(this: R, context: C, data: V, key: keyof M, model: M): Promise<void> {\n  if (!model[key]) return;\n  try {\n    model[key] = JSON.stringify(model[key]) as M[keyof M];\n    // eslint-disable-next-line @typescript-eslint/no-unused-vars\n  } catch (e: unknown) {\n    throw new SerializationError(\n      `Failed to serialize ${key.toString()} property of model ${model.constructor.name}: e`\n    );\n  }\n}\n\n/**\n * @description Handler function that deserializes a property from JSON string after database operations.\n * @summary Converts a JSON string property back to its original complex object form after retrieving it from the database.\n * @template M - The model type extending Model\n * @template R - The repository type extending IRepository\n * @template V - The data type for the operation\n * @template F - The repository flags type\n * @template C - The context type\n * @param {C} context - The repository context\n * @param {V} data - The data being processed\n * @param key - The property key to deserialize\n * @param {M} model - The model instance being processed\n * @return {Promise<void>} A promise that resolves when the property has been deserialized\n * @function serializeAfterAll\n * @memberOf module:db-decorators\n */\nexport async function serializeAfterAll<\n  M extends Model,\n  R extends IRepository<M, F, C>,\n  V,\n  F extends RepositoryFlags = RepositoryFlags,\n  C extends Context<F> = Context<F>,\n>(this: R, context: C, data: V, key: keyof M, model: M): Promise<void> {\n  if (!model[key]) return;\n  if (typeof model[key] !== \"string\") return;\n\n  try {\n    model[key] = JSON.parse(model[key]);\n  } catch (e: unknown) {\n    throw new SerializationError(\n      `Failed to deserialize ${key.toString()} property of model ${model.constructor.name}: ${e}`\n    );\n  }\n}\n\n/**\n * @description Enables automatic JSON serialization and deserialization for complex object properties.\n * @summary Decorator that automatically converts complex objects to JSON strings before storing in the database and back to objects when retrieving them.\n * @return {PropertyDecorator} A decorator function that can be applied to class properties\n * @function serialize\n * @category Property Decorators\n * @mermaid\n * sequenceDiagram\n *   participant C as Client\n *   participant M as Model\n *   participant S as SerializeDecorator\n *   participant DB as Database\n *\n *   Note over C,DB: Create/Update Flow\n *   C->>M: Set complex object property\n *   M->>S: Process property (create/update)\n *   S->>M: Convert to JSON string\n *   M->>DB: Store serialized data\n *\n *   Note over C,DB: Retrieval Flow\n *   C->>M: Request model\n *   M->>DB: Fetch data\n *   DB->>M: Return with serialized property\n *   M->>S: Process property (after all ops)\n *   S->>M: Parse JSON back to object\n *   M->>C: Return model with deserialized property\n */\nexport function serialize() {\n  return apply(\n    onCreateUpdate(serializeOnCreateUpdate),\n    after(DBOperations.ALL, serializeAfterAll),\n    type([String.name, Object.name]),\n    metadata(Repository.key(DBKeys.SERIALIZE), {})\n  );\n}\n"]}

package/lib/validation/decorators.d.ts

@@ -5,20 +5,34 @@ import { IRepository } from "../interfaces/IRepository";
 import { Context } from "../repository/Context";
 import { RepositoryFlags } from "../repository/types";
 /**
- * Marks the property as readonly.
- *
- * @param {string} [message] the error message. Defaults to {@link DEFAULT_ERROR_MESSAGES.READONLY.INVALID}
- *
- * @decorator readonly
- *
- * @category Decorators
+ * @description Prevents a property from being modified after initial creation.
+ * @summary Marks the property as readonly, causing validation errors if attempts are made to modify it during updates.
+ * @param {string} [message] - The error message to display when validation fails. Defaults to {@link DEFAULT_ERROR_MESSAGES.READONLY.INVALID}
+ * @return {PropertyDecorator} A decorator function that can be applied to class properties
+ * @function readonly
+ * @category Property Decorators
  */
 export declare function readonly(message?: string): (target: any, propertyKey?: any, descriptor?: TypedPropertyDescriptor<any>) => any;
+/**
+ * @description Handler function that sets a timestamp property to the current timestamp.
+ * @summary Updates a model property with the current timestamp from the repository context.
+ * @template M - The model type extending Model
+ * @template R - The repository type extending IRepository
+ * @template V - The data type for the operation
+ * @template F - The repository flags type
+ * @template C - The context type
+ * @param {C} context - The repository context containing the current timestamp
+ * @param {V} data - The data being processed
+ * @param key - The property key to update
+ * @param {M} model - The model instance being updated
+ * @return {Promise<void>} A promise that resolves when the timestamp has been set
+ * @function timestampHandler
+ * @memberOf module:db-decorators
+ */
 export declare function timestampHandler<M extends Model, R extends IRepository<M, F, C>, V, F extends RepositoryFlags = RepositoryFlags, C extends Context<F> = Context<F>>(this: R, context: C, data: V, key: keyof M, model: M): Promise<void>;
 /**
- * Marks the property as timestamp.
- * Makes it {@link required}
- * Makes it a {@link date}
+ * @description Automatically manages timestamp properties for tracking creation and update times.
+ * @summary Marks the property as a timestamp, making it required and ensuring it's a valid date. The property will be automatically updated with the current timestamp during specified operations.
  *
  * Date Format:
  *
@@ -38,23 +52,91 @@ export declare function timestampHandler<M extends Model, R extends IRepository<
  *      S = miliseconds
  * </pre>
  *
- * @param {string[]} operation The {@link DBOperations} to act on. Defaults to {@link DBOperations.CREATE_UPDATE}
- * @param {string} [format] The TimeStamp format. defaults to {@link DEFAULT_TIMESTAMP_FORMAT}
- * @param {{new: UpdateValidator}} [validator] defaults to {@link TimestampValidator}
+ * @param {OperationKeys[]} operation - The operations to act on. Defaults to {@link DBOperations.CREATE_UPDATE}
+ * @param {string} [format] - The timestamp format. Defaults to {@link DEFAULT_TIMESTAMP_FORMAT}
+ * @return {PropertyDecorator} A decorator function that can be applied to class properties
+ * @function timestamp
+ * @category Property Decorators
+ * @mermaid
+ * sequenceDiagram
+ *   participant C as Client
+ *   participant M as Model
+ *   participant T as TimestampDecorator
+ *   participant V as Validator
+ *
+ *   C->>M: Create/Update model
+ *   M->>T: Process timestamp property
+ *   T->>M: Apply required validation
+ *   T->>M: Apply date format validation
  *
- * @decorator timestamp
+ *   alt Update operation
+ *     T->>V: Register timestamp validator
+ *     V->>M: Validate timestamp is newer
+ *   end
  *
- * @category Decorators
+ *   T->>M: Set current timestamp
+ *   M->>C: Return updated model
  */
 export declare function timestamp(operation?: OperationKeys[], format?: string): (target: any, propertyKey?: any, descriptor?: TypedPropertyDescriptor<any>) => any;
+/**
+ * @description Handler function that serializes a property to JSON string during create and update operations.
+ * @summary Converts a complex object property to a JSON string before storing it in the database.
+ * @template M - The model type extending Model
+ * @template R - The repository type extending IRepository
+ * @template V - The data type for the operation
+ * @template F - The repository flags type
+ * @template C - The context type
+ * @param {C} context - The repository context
+ * @param {V} data - The data being processed
+ * @param key - The property key to serialize
+ * @param {M} model - The model instance being processed
+ * @return {Promise<void>} A promise that resolves when the property has been serialized
+ * @function serializeOnCreateUpdate
+ * @memberOf module:db-decorators
+ */
 export declare function serializeOnCreateUpdate<M extends Model, R extends IRepository<M, F, C>, V, F extends RepositoryFlags = RepositoryFlags, C extends Context<F> = Context<F>>(this: R, context: C, data: V, key: keyof M, model: M): Promise<void>;
+/**
+ * @description Handler function that deserializes a property from JSON string after database operations.
+ * @summary Converts a JSON string property back to its original complex object form after retrieving it from the database.
+ * @template M - The model type extending Model
+ * @template R - The repository type extending IRepository
+ * @template V - The data type for the operation
+ * @template F - The repository flags type
+ * @template C - The context type
+ * @param {C} context - The repository context
+ * @param {V} data - The data being processed
+ * @param key - The property key to deserialize
+ * @param {M} model - The model instance being processed
+ * @return {Promise<void>} A promise that resolves when the property has been deserialized
+ * @function serializeAfterAll
+ * @memberOf module:db-decorators
+ */
 export declare function serializeAfterAll<M extends Model, R extends IRepository<M, F, C>, V, F extends RepositoryFlags = RepositoryFlags, C extends Context<F> = Context<F>>(this: R, context: C, data: V, key: keyof M, model: M): Promise<void>;
 /**
- * @summary Serialize Decorator
- * @description properties decorated will the serialized before stored in the db
- *
+ * @description Enables automatic JSON serialization and deserialization for complex object properties.
+ * @summary Decorator that automatically converts complex objects to JSON strings before storing in the database and back to objects when retrieving them.
+ * @return {PropertyDecorator} A decorator function that can be applied to class properties
  * @function serialize
+ * @category Property Decorators
+ * @mermaid
+ * sequenceDiagram
+ *   participant C as Client
+ *   participant M as Model
+ *   participant S as SerializeDecorator
+ *   participant DB as Database
+ *
+ *   Note over C,DB: Create/Update Flow
+ *   C->>M: Set complex object property
+ *   M->>S: Process property (create/update)
+ *   S->>M: Convert to JSON string
+ *   M->>DB: Store serialized data
  *
- * @memberOf module:wallet-db.Decorators
+ *   Note over C,DB: Retrieval Flow
+ *   C->>M: Request model
+ *   M->>DB: Fetch data
+ *   DB->>M: Return with serialized property
+ *   M->>S: Process property (after all ops)
+ *   S->>M: Parse JSON back to object
+ *   M->>C: Return model with deserialized property
  */
 export declare function serialize(): (target: object, propertyKey?: string | symbol | unknown, descriptor?: PropertyDescriptor) => void;

package/lib/validation/validation.cjs

@@ -2,7 +2,15 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const decorator_validation_1 = require("@decaf-ts/decorator-validation");
 const constants_1 = require("./constants.cjs");
+/**
+ * @description Generates a key for update validation metadata.
+ * @summary Builds the key to store as metadata under Reflections for update validation by prefixing the provided key with the update validation prefix.
+ * @param {string} key - The base key to be prefixed
+ * @return {string} The complete metadata key for update validation
+ * @function updateKey
+ * @memberOf module:db-decorators
+ */
 decorator_validation_1.Validation.updateKey = function (key) {
     return constants_1.UpdateValidationKeys.REFLECT + key;
 };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidmFsaWRhdGlvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy92YWxpZGF0aW9uL3ZhbGlkYXRpb24udHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSx5RUFLd0M7QUFDeEMsK0NBQW1EO0FBRW5ELGlDQUFVLENBQUMsU0FBUyxHQUFHLFVBQVUsR0FBVztJQUMxQyxPQUFPLGdDQUFvQixDQUFDLE9BQU8sR0FBRyxHQUFHLENBQUM7QUFDNUMsQ0FBQyxDQUFDIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHtcbiAgVmFsaWRhdG9yLFxuICBWYWxpZGF0aW9uLFxuICBWYWxpZGF0b3JEZWZpbml0aW9uLFxuICBJVmFsaWRhdG9yUmVnaXN0cnksXG59IGZyb20gXCJAZGVjYWYtdHMvZGVjb3JhdG9yLXZhbGlkYXRpb25cIjtcbmltcG9ydCB7IFVwZGF0ZVZhbGlkYXRpb25LZXlzIH0gZnJvbSBcIi4vY29uc3RhbnRzXCI7XG5cblZhbGlkYXRpb24udXBkYXRlS2V5ID0gZnVuY3Rpb24gKGtleTogc3RyaW5nKSB7XG4gIHJldHVybiBVcGRhdGVWYWxpZGF0aW9uS2V5cy5SRUZMRUNUICsga2V5O1xufTtcblxuZGVjbGFyZSBtb2R1bGUgXCJAZGVjYWYtdHMvZGVjb3JhdG9yLXZhbGlkYXRpb25cIiB7XG4gIC8vIGVzbGludC1kaXNhYmxlLW5leHQtbGluZSBAdHlwZXNjcmlwdC1lc2xpbnQvYmFuLXRzLWNvbW1lbnRcbiAgLy8gQHRzLWV4cGVjdC1lcnJvclxuICBkZWNsYXJlIGNsYXNzIFZhbGlkYXRpb24ge1xuICAgIHByaXZhdGUgc3RhdGljIGFjdGluZ1ZhbGlkYXRvclJlZ2lzdHJ5PztcbiAgICBwcml2YXRlIGNvbnN0cnVjdG9yKCk7XG4gICAgLyoqXG4gICAgICogQHN1bW1hcnkgRGVmaW5lcyB0aGUgYWN0aW5nIFZhbGlkYXRvclJlZ2lzdHJ5XG4gICAgICpcbiAgICAgKiBAcGFyYW0ge0lWYWxpZGF0b3JSZWdpc3RyeX0gdmFsaWRhdG9yUmVnaXN0cnkgdGhlIG5ldyBpbXBsZW1lbnRhdGlvbiBvZiB0aGUgdmFsaWRhdG9yIFJlZ2lzdHJ5XG4gICAgICogQHBhcmFtIHtmdW5jdGlvbihWYWxpZGF0b3IpOiBWYWxpZGF0b3J9IFttaWdyYXRpb25IYW5kbGVyXSB0aGUgbWV0aG9kIHRvIG1hcCB0aGUgdmFsaWRhdG9yIGlmIHJlcXVpcmVkO1xuICAgICAqL1xuICAgIHN0YXRpYyBzZXRSZWdpc3RyeShcbiAgICAgIHZhbGlkYXRvclJlZ2lzdHJ5OiBJVmFsaWRhdG9yUmVnaXN0cnk8VmFsaWRhdG9yPixcbiAgICAgIG1pZ3JhdGlvbkhhbmRsZXI/OiAodmFsaWRhdG9yOiBWYWxpZGF0b3IpID0+IFZhbGlkYXRvclxuICAgICk6IHZvaWQ7XG4gICAgLyoqXG4gICAgICogQHN1bW1hcnkgUmV0dXJucyB0aGUgY3VycmVudCBWYWxpZGF0b3JSZWdpc3RyeVxuICAgICAqXG4gICAgICogQHJldHVybiBJVmFsaWRhdG9yUmVnaXN0cnksIGRlZmF1bHRzIHRvIHtAbGluayBWYWxpZGF0b3JSZWdpc3RyeX1cbiAgICAgKi9cbiAgICBwcml2YXRlIHN0YXRpYyBnZXRSZWdpc3RyeTtcbiAgICAvKipcbiAgICAgKiBAc3VtbWFyeSBSZXRyaWV2ZXMgYSB2YWxpZGF0b3JcbiAgICAgKlxuICAgICAqIEBwYXJhbSB7c3RyaW5nfSB2YWxpZGF0b3JLZXkgb25lIG9mIHRoZSB7QGxpbmsgVmFsaWRhdGlvbktleXN9XG4gICAgICogQHJldHVybiB7VmFsaWRhdG9yIHwgdW5kZWZpbmVkfSB0aGUgcmVnaXN0ZXJlZCBWYWxpZGF0b3Igb3IgdW5kZWZpbmVkIGlmIHRoZXJlIGlzIG5vbm8gbWF0Y2hpbmcgdGhlIHByb3ZpZGVkIGtleVxuICAgICAqL1xuICAgIHN0YXRpYyBnZXQ8VCBleHRlbmRzIFZhbGlkYXRvcj4odmFsaWRhdG9yS2V5OiBzdHJpbmcpOiBUIHwgdW5kZWZpbmVkO1xuICAgIC8qKlxuICAgICAqIEBzdW1tYXJ5IFJlZ2lzdGVycyB0aGUgcHJvdmlkZWQgdmFsaWRhdG9ycyBvbnRvIHRoZSByZWdpc3RyeVxuICAgICAqXG4gICAgICogQHBhcmFtIHtUW10gfCBWYWxpZGF0b3JEZWZpbml0aW9uW119IHZhbGlkYXRvclxuICAgICAqL1xuICAgIHN0YXRpYyByZWdpc3RlcjxUIGV4dGVuZHMgVmFsaWRhdG9yPihcbiAgICAgIC4uLnZhbGlkYXRvcjogKFZhbGlkYXRvckRlZmluaXRpb24gfCBUKVtdXG4gICAgKTogdm9pZDtcbiAgICAvKipcbiAgICAgKiBAc3VtbWFyeSBCdWlsZHMgdGhlIGtleSB0byBzdG9yZSBhcyBNZXRhZGF0YSB1bmRlciBSZWZsZWN0aW9uc1xuICAgICAqIEBkZXNjcmlwdGlvbiBjb25jYXRlbmF0ZXMge0BsaW5rIFZhbGlkYXRpb25LZXlzI1JFRkxFQ1R9IHdpdGggdGhlIHByb3ZpZGVkIGtleVxuICAgICAqXG4gICAgICogQHBhcmFtIHtzdHJpbmd9IGtleVxuICAgICAqL1xuICAgIHN0YXRpYyBrZXkoa2V5OiBzdHJpbmcpOiBzdHJpbmc7XG5cbiAgICBzdGF0aWMgdXBkYXRlS2V5KGtleTogc3RyaW5nKTogc3RyaW5nO1xuICB9XG59XG4iXX0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidmFsaWRhdGlvbi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy92YWxpZGF0aW9uL3ZhbGlkYXRpb24udHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSx5RUFLd0M7QUFDeEMsK0NBQW1EO0FBRW5EOzs7Ozs7O0dBT0c7QUFDSCxpQ0FBVSxDQUFDLFNBQVMsR0FBRyxVQUFVLEdBQVc7SUFDMUMsT0FBTyxnQ0FBb0IsQ0FBQyxPQUFPLEdBQUcsR0FBRyxDQUFDO0FBQzVDLENBQUMsQ0FBQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7XG4gIFZhbGlkYXRvcixcbiAgVmFsaWRhdGlvbixcbiAgVmFsaWRhdG9yRGVmaW5pdGlvbixcbiAgSVZhbGlkYXRvclJlZ2lzdHJ5LFxufSBmcm9tIFwiQGRlY2FmLXRzL2RlY29yYXRvci12YWxpZGF0aW9uXCI7XG5pbXBvcnQgeyBVcGRhdGVWYWxpZGF0aW9uS2V5cyB9IGZyb20gXCIuL2NvbnN0YW50c1wiO1xuXG4vKipcbiAqIEBkZXNjcmlwdGlvbiBHZW5lcmF0ZXMgYSBrZXkgZm9yIHVwZGF0ZSB2YWxpZGF0aW9uIG1ldGFkYXRhLlxuICogQHN1bW1hcnkgQnVpbGRzIHRoZSBrZXkgdG8gc3RvcmUgYXMgbWV0YWRhdGEgdW5kZXIgUmVmbGVjdGlvbnMgZm9yIHVwZGF0ZSB2YWxpZGF0aW9uIGJ5IHByZWZpeGluZyB0aGUgcHJvdmlkZWQga2V5IHdpdGggdGhlIHVwZGF0ZSB2YWxpZGF0aW9uIHByZWZpeC5cbiAqIEBwYXJhbSB7c3RyaW5nfSBrZXkgLSBUaGUgYmFzZSBrZXkgdG8gYmUgcHJlZml4ZWRcbiAqIEByZXR1cm4ge3N0cmluZ30gVGhlIGNvbXBsZXRlIG1ldGFkYXRhIGtleSBmb3IgdXBkYXRlIHZhbGlkYXRpb25cbiAqIEBmdW5jdGlvbiB1cGRhdGVLZXlcbiAqIEBtZW1iZXJPZiBtb2R1bGU6ZGItZGVjb3JhdG9yc1xuICovXG5WYWxpZGF0aW9uLnVwZGF0ZUtleSA9IGZ1bmN0aW9uIChrZXk6IHN0cmluZykge1xuICByZXR1cm4gVXBkYXRlVmFsaWRhdGlvbktleXMuUkVGTEVDVCArIGtleTtcbn07XG5cbmRlY2xhcmUgbW9kdWxlIFwiQGRlY2FmLXRzL2RlY29yYXRvci12YWxpZGF0aW9uXCIge1xuICAvLyBlc2xpbnQtZGlzYWJsZS1uZXh0LWxpbmUgQHR5cGVzY3JpcHQtZXNsaW50L2Jhbi10cy1jb21tZW50XG4gIC8vIEB0cy1leHBlY3QtZXJyb3JcbiAgZGVjbGFyZSBjbGFzcyBWYWxpZGF0aW9uIHtcbiAgICBwcml2YXRlIHN0YXRpYyBhY3RpbmdWYWxpZGF0b3JSZWdpc3RyeT87XG4gICAgcHJpdmF0ZSBjb25zdHJ1Y3RvcigpO1xuICAgIC8qKlxuICAgICAqIEBzdW1tYXJ5IERlZmluZXMgdGhlIGFjdGluZyBWYWxpZGF0b3JSZWdpc3RyeVxuICAgICAqXG4gICAgICogQHBhcmFtIHtJVmFsaWRhdG9yUmVnaXN0cnl9IHZhbGlkYXRvclJlZ2lzdHJ5IHRoZSBuZXcgaW1wbGVtZW50YXRpb24gb2YgdGhlIHZhbGlkYXRvciBSZWdpc3RyeVxuICAgICAqIEBwYXJhbSB7ZnVuY3Rpb24oVmFsaWRhdG9yKTogVmFsaWRhdG9yfSBbbWlncmF0aW9uSGFuZGxlcl0gdGhlIG1ldGhvZCB0byBtYXAgdGhlIHZhbGlkYXRvciBpZiByZXF1aXJlZDtcbiAgICAgKi9cbiAgICBzdGF0aWMgc2V0UmVnaXN0cnkoXG4gICAgICB2YWxpZGF0b3JSZWdpc3RyeTogSVZhbGlkYXRvclJlZ2lzdHJ5PFZhbGlkYXRvcj4sXG4gICAgICBtaWdyYXRpb25IYW5kbGVyPzogKHZhbGlkYXRvcjogVmFsaWRhdG9yKSA9PiBWYWxpZGF0b3JcbiAgICApOiB2b2lkO1xuICAgIC8qKlxuICAgICAqIEBzdW1tYXJ5IFJldHVybnMgdGhlIGN1cnJlbnQgVmFsaWRhdG9yUmVnaXN0cnlcbiAgICAgKlxuICAgICAqIEByZXR1cm4gSVZhbGlkYXRvclJlZ2lzdHJ5LCBkZWZhdWx0cyB0byB7QGxpbmsgVmFsaWRhdG9yUmVnaXN0cnl9XG4gICAgICovXG4gICAgcHJpdmF0ZSBzdGF0aWMgZ2V0UmVnaXN0cnk7XG4gICAgLyoqXG4gICAgICogQHN1bW1hcnkgUmV0cmlldmVzIGEgdmFsaWRhdG9yXG4gICAgICpcbiAgICAgKiBAcGFyYW0ge3N0cmluZ30gdmFsaWRhdG9yS2V5IG9uZSBvZiB0aGUge0BsaW5rIFZhbGlkYXRpb25LZXlzfVxuICAgICAqIEByZXR1cm4ge1ZhbGlkYXRvciB8IHVuZGVmaW5lZH0gdGhlIHJlZ2lzdGVyZWQgVmFsaWRhdG9yIG9yIHVuZGVmaW5lZCBpZiB0aGVyZSBpcyBub25vIG1hdGNoaW5nIHRoZSBwcm92aWRlZCBrZXlcbiAgICAgKi9cbiAgICBzdGF0aWMgZ2V0PFQgZXh0ZW5kcyBWYWxpZGF0b3I+KHZhbGlkYXRvcktleTogc3RyaW5nKTogVCB8IHVuZGVmaW5lZDtcbiAgICAvKipcbiAgICAgKiBAc3VtbWFyeSBSZWdpc3RlcnMgdGhlIHByb3ZpZGVkIHZhbGlkYXRvcnMgb250byB0aGUgcmVnaXN0cnlcbiAgICAgKlxuICAgICAqIEBwYXJhbSB7VFtdIHwgVmFsaWRhdG9yRGVmaW5pdGlvbltdfSB2YWxpZGF0b3JcbiAgICAgKi9cbiAgICBzdGF0aWMgcmVnaXN0ZXI8VCBleHRlbmRzIFZhbGlkYXRvcj4oXG4gICAgICAuLi52YWxpZGF0b3I6IChWYWxpZGF0b3JEZWZpbml0aW9uIHwgVClbXVxuICAgICk6IHZvaWQ7XG4gICAgLyoqXG4gICAgICogQHN1bW1hcnkgQnVpbGRzIHRoZSBrZXkgdG8gc3RvcmUgYXMgTWV0YWRhdGEgdW5kZXIgUmVmbGVjdGlvbnNcbiAgICAgKiBAZGVzY3JpcHRpb24gY29uY2F0ZW5hdGVzIHtAbGluayBWYWxpZGF0aW9uS2V5cyNSRUZMRUNUfSB3aXRoIHRoZSBwcm92aWRlZCBrZXlcbiAgICAgKlxuICAgICAqIEBwYXJhbSB7c3RyaW5nfSBrZXlcbiAgICAgKi9cbiAgICBzdGF0aWMga2V5KGtleTogc3RyaW5nKTogc3RyaW5nO1xuXG4gICAgc3RhdGljIHVwZGF0ZUtleShrZXk6IHN0cmluZyk6IHN0cmluZztcbiAgfVxufVxuIl19

package/lib/validation/validators/ReadOnlyValidator.cjs

@@ -14,11 +14,29 @@ const decorator_validation_1 = require("@decaf-ts/decorator-validation");
 const constants_1 = require("./../constants.cjs");
 const reflection_1 = require("@decaf-ts/reflection");
 /**
- * @summary Validator for the {@link readonly} decorator
- *
+ * @description A validator that ensures properties marked as readonly cannot be modified during updates.
+ * @summary Validator for the {@link readonly} decorator that checks if a value has been changed during an update operation. It compares the new value with the old value and returns an error message if they are not equal.
+ * @param {any} value - The value to be validated
+ * @param {any} oldValue - The previous value to compare against
+ * @param {string} [message] - Optional custom error message
  * @class ReadOnlyValidator
- * @extends Validator
+ * @example
+ * // Using ReadOnlyValidator with a readonly property
+ * class User {
+ *   @readonly()
+ *   id: string;
+ *
+ *   name: string;
+ *
+ *   constructor(id: string, name: string) {
+ *     this.id = id;
+ *     this.name = name;
+ *   }
+ * }
  *
+ * // This will trigger validation error when trying to update
+ * const user = new User('123', 'John');
+ * user.id = '456'; // Will be prevented by ReadOnlyValidator
  * @category Validators
  */
 let ReadOnlyValidator = class ReadOnlyValidator extends decorator_validation_1.Validator {
@@ -26,17 +44,23 @@ let ReadOnlyValidator = class ReadOnlyValidator extends decorator_validation_1.V
         super(constants_1.DEFAULT_ERROR_MESSAGES.READONLY.INVALID);
     }
     /**
-     * @inheritDoc
+     * @description Implementation of the base validator's hasErrors method.
+     * @summary This method is required by the Validator interface but not used in this validator as validation only happens during updates.
+     * @param {any} value - The value to validate
+     * @param {any[]} args - Additional arguments
+     * @return {string | undefined} Always returns undefined as this validator only works during updates
      */
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     hasErrors(value, ...args) {
         return undefined;
     }
     /**
-     * @summary Validates a value has not changed
-     * @param {any} value
-     * @param {any} oldValue
-     * @param {string} [message] the error message override
+     * @description Checks if a value has been modified during an update operation.
+     * @summary Validates a value has not changed by comparing it with the previous value using deep equality.
+     * @param {any} value - The new value to validate
+     * @param {any} oldValue - The original value to compare against
+     * @param {string} [message] - Optional custom error message to override the default
+     * @return {string | undefined} An error message if validation fails, undefined otherwise
      */
     updateHasErrors(value, oldValue, message) {
         if (value === undefined)
@@ -51,4 +75,4 @@ exports.ReadOnlyValidator = ReadOnlyValidator = __decorate([
     (0, decorator_validation_1.validator)(constants_1.UpdateValidationKeys.READONLY),
     __metadata("design:paramtypes", [])
 ], ReadOnlyValidator);
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiUmVhZE9ubHlWYWxpZGF0b3IuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvdmFsaWRhdGlvbi92YWxpZGF0b3JzL1JlYWRPbmx5VmFsaWRhdG9yLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7OztBQUFBLHlFQUFzRTtBQUN0RSxrREFBNEU7QUFDNUUscURBQStDO0FBRS9DOzs7Ozs7O0dBT0c7QUFFSSxJQUFNLGlCQUFpQixHQUF2QixNQUFNLGlCQUFrQixTQUFRLGdDQUFTO0lBQzlDO1FBQ0UsS0FBSyxDQUFDLGtDQUFzQixDQUFDLFFBQVEsQ0FBQyxPQUFPLENBQUMsQ0FBQztJQUNqRCxDQUFDO0lBRUQ7O09BRUc7SUFDSCw2REFBNkQ7SUFDN0QsU0FBUyxDQUFDLEtBQVUsRUFBRSxHQUFHLElBQVc7UUFDbEMsT0FBTyxTQUFTLENBQUM7SUFDbkIsQ0FBQztJQUVEOzs7OztPQUtHO0lBQ0ksZUFBZSxDQUNwQixLQUFVLEVBQ1YsUUFBYSxFQUNiLE9BQWdCO1FBRWhCLElBQUksS0FBSyxLQUFLLFNBQVM7WUFBRSxPQUFPO1FBRWhDLE9BQU8sSUFBQSxvQkFBTyxFQUFDLEtBQUssRUFBRSxRQUFRLENBQUM7WUFDN0IsQ0FBQyxDQUFDLFNBQVM7WUFDWCxDQUFDLENBQUMsSUFBSSxDQUFDLFVBQVUsQ0FBQyxPQUFPLElBQUksSUFBSSxDQUFDLE9BQU8sQ0FBQyxDQUFDO0lBQy9DLENBQUM7Q0FDRixDQUFBO0FBOUJZLDhDQUFpQjs0QkFBakIsaUJBQWlCO0lBRDdCLElBQUEsZ0NBQVMsRUFBQyxnQ0FBb0IsQ0FBQyxRQUFRLENBQUM7O0dBQzVCLGlCQUFpQixDQThCN0IiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgeyB2YWxpZGF0b3IsIFZhbGlkYXRvciB9IGZyb20gXCJAZGVjYWYtdHMvZGVjb3JhdG9yLXZhbGlkYXRpb25cIjtcbmltcG9ydCB7IERFRkFVTFRfRVJST1JfTUVTU0FHRVMsIFVwZGF0ZVZhbGlkYXRpb25LZXlzIH0gZnJvbSBcIi4uL2NvbnN0YW50c1wiO1xuaW1wb3J0IHsgaXNFcXVhbCB9IGZyb20gXCJAZGVjYWYtdHMvcmVmbGVjdGlvblwiO1xuXG4vKipcbiAqIEBzdW1tYXJ5IFZhbGlkYXRvciBmb3IgdGhlIHtAbGluayByZWFkb25seX0gZGVjb3JhdG9yXG4gKlxuICogQGNsYXNzIFJlYWRPbmx5VmFsaWRhdG9yXG4gKiBAZXh0ZW5kcyBWYWxpZGF0b3JcbiAqXG4gKiBAY2F0ZWdvcnkgVmFsaWRhdG9yc1xuICovXG5AdmFsaWRhdG9yKFVwZGF0ZVZhbGlkYXRpb25LZXlzLlJFQURPTkxZKVxuZXhwb3J0IGNsYXNzIFJlYWRPbmx5VmFsaWRhdG9yIGV4dGVuZHMgVmFsaWRhdG9yIHtcbiAgY29uc3RydWN0b3IoKSB7XG4gICAgc3VwZXIoREVGQVVMVF9FUlJPUl9NRVNTQUdFUy5SRUFET05MWS5JTlZBTElEKTtcbiAgfVxuXG4gIC8qKlxuICAgKiBAaW5oZXJpdERvY1xuICAgKi9cbiAgLy8gZXNsaW50LWRpc2FibGUtbmV4dC1saW5lIEB0eXBlc2NyaXB0LWVzbGludC9uby11bnVzZWQtdmFyc1xuICBoYXNFcnJvcnModmFsdWU6IGFueSwgLi4uYXJnczogYW55W10pOiBzdHJpbmcgfCB1bmRlZmluZWQge1xuICAgIHJldHVybiB1bmRlZmluZWQ7XG4gIH1cblxuICAvKipcbiAgICogQHN1bW1hcnkgVmFsaWRhdGVzIGEgdmFsdWUgaGFzIG5vdCBjaGFuZ2VkXG4gICAqIEBwYXJhbSB7YW55fSB2YWx1ZVxuICAgKiBAcGFyYW0ge2FueX0gb2xkVmFsdWVcbiAgICogQHBhcmFtIHtzdHJpbmd9IFttZXNzYWdlXSB0aGUgZXJyb3IgbWVzc2FnZSBvdmVycmlkZVxuICAgKi9cbiAgcHVibGljIHVwZGF0ZUhhc0Vycm9ycyhcbiAgICB2YWx1ZTogYW55LFxuICAgIG9sZFZhbHVlOiBhbnksXG4gICAgbWVzc2FnZT86IHN0cmluZyxcbiAgKTogc3RyaW5nIHwgdW5kZWZpbmVkIHtcbiAgICBpZiAodmFsdWUgPT09IHVuZGVmaW5lZCkgcmV0dXJuO1xuXG4gICAgcmV0dXJuIGlzRXF1YWwodmFsdWUsIG9sZFZhbHVlKVxuICAgICAgPyB1bmRlZmluZWRcbiAgICAgIDogdGhpcy5nZXRNZXNzYWdlKG1lc3NhZ2UgfHwgdGhpcy5tZXNzYWdlKTtcbiAgfVxufVxuIl19
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiUmVhZE9ubHlWYWxpZGF0b3IuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvdmFsaWRhdGlvbi92YWxpZGF0b3JzL1JlYWRPbmx5VmFsaWRhdG9yLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7OztBQUFBLHlFQUFzRTtBQUN0RSxrREFBNEU7QUFDNUUscURBQStDO0FBRS9DOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0dBeUJHO0FBRUksSUFBTSxpQkFBaUIsR0FBdkIsTUFBTSxpQkFBa0IsU0FBUSxnQ0FBUztJQUM5QztRQUNFLEtBQUssQ0FBQyxrQ0FBc0IsQ0FBQyxRQUFRLENBQUMsT0FBTyxDQUFDLENBQUM7SUFDakQsQ0FBQztJQUVEOzs7Ozs7T0FNRztJQUNILDZEQUE2RDtJQUM3RCxTQUFTLENBQUMsS0FBVSxFQUFFLEdBQUcsSUFBVztRQUNsQyxPQUFPLFNBQVMsQ0FBQztJQUNuQixDQUFDO0lBRUQ7Ozs7Ozs7T0FPRztJQUNJLGVBQWUsQ0FDcEIsS0FBVSxFQUNWLFFBQWEsRUFDYixPQUFnQjtRQUVoQixJQUFJLEtBQUssS0FBSyxTQUFTO1lBQUUsT0FBTztRQUVoQyxPQUFPLElBQUEsb0JBQU8sRUFBQyxLQUFLLEVBQUUsUUFBUSxDQUFDO1lBQzdCLENBQUMsQ0FBQyxTQUFTO1lBQ1gsQ0FBQyxDQUFDLElBQUksQ0FBQyxVQUFVLENBQUMsT0FBTyxJQUFJLElBQUksQ0FBQyxPQUFPLENBQUMsQ0FBQztJQUMvQyxDQUFDO0NBQ0YsQ0FBQTtBQXBDWSw4Q0FBaUI7NEJBQWpCLGlCQUFpQjtJQUQ3QixJQUFBLGdDQUFTLEVBQUMsZ0NBQW9CLENBQUMsUUFBUSxDQUFDOztHQUM1QixpQkFBaUIsQ0FvQzdCIiwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgdmFsaWRhdG9yLCBWYWxpZGF0b3IgfSBmcm9tIFwiQGRlY2FmLXRzL2RlY29yYXRvci12YWxpZGF0aW9uXCI7XG5pbXBvcnQgeyBERUZBVUxUX0VSUk9SX01FU1NBR0VTLCBVcGRhdGVWYWxpZGF0aW9uS2V5cyB9IGZyb20gXCIuLi9jb25zdGFudHNcIjtcbmltcG9ydCB7IGlzRXF1YWwgfSBmcm9tIFwiQGRlY2FmLXRzL3JlZmxlY3Rpb25cIjtcblxuLyoqXG4gKiBAZGVzY3JpcHRpb24gQSB2YWxpZGF0b3IgdGhhdCBlbnN1cmVzIHByb3BlcnRpZXMgbWFya2VkIGFzIHJlYWRvbmx5IGNhbm5vdCBiZSBtb2RpZmllZCBkdXJpbmcgdXBkYXRlcy5cbiAqIEBzdW1tYXJ5IFZhbGlkYXRvciBmb3IgdGhlIHtAbGluayByZWFkb25seX0gZGVjb3JhdG9yIHRoYXQgY2hlY2tzIGlmIGEgdmFsdWUgaGFzIGJlZW4gY2hhbmdlZCBkdXJpbmcgYW4gdXBkYXRlIG9wZXJhdGlvbi4gSXQgY29tcGFyZXMgdGhlIG5ldyB2YWx1ZSB3aXRoIHRoZSBvbGQgdmFsdWUgYW5kIHJldHVybnMgYW4gZXJyb3IgbWVzc2FnZSBpZiB0aGV5IGFyZSBub3QgZXF1YWwuXG4gKiBAcGFyYW0ge2FueX0gdmFsdWUgLSBUaGUgdmFsdWUgdG8gYmUgdmFsaWRhdGVkXG4gKiBAcGFyYW0ge2FueX0gb2xkVmFsdWUgLSBUaGUgcHJldmlvdXMgdmFsdWUgdG8gY29tcGFyZSBhZ2FpbnN0XG4gKiBAcGFyYW0ge3N0cmluZ30gW21lc3NhZ2VdIC0gT3B0aW9uYWwgY3VzdG9tIGVycm9yIG1lc3NhZ2VcbiAqIEBjbGFzcyBSZWFkT25seVZhbGlkYXRvclxuICogQGV4YW1wbGVcbiAqIC8vIFVzaW5nIFJlYWRPbmx5VmFsaWRhdG9yIHdpdGggYSByZWFkb25seSBwcm9wZXJ0eVxuICogY2xhc3MgVXNlciB7XG4gKiAgIEByZWFkb25seSgpXG4gKiAgIGlkOiBzdHJpbmc7XG4gKiAgIFxuICogICBuYW1lOiBzdHJpbmc7XG4gKiAgIFxuICogICBjb25zdHJ1Y3RvcihpZDogc3RyaW5nLCBuYW1lOiBzdHJpbmcpIHtcbiAqICAgICB0aGlzLmlkID0gaWQ7XG4gKiAgICAgdGhpcy5uYW1lID0gbmFtZTtcbiAqICAgfVxuICogfVxuICogXG4gKiAvLyBUaGlzIHdpbGwgdHJpZ2dlciB2YWxpZGF0aW9uIGVycm9yIHdoZW4gdHJ5aW5nIHRvIHVwZGF0ZVxuICogY29uc3QgdXNlciA9IG5ldyBVc2VyKCcxMjMnLCAnSm9obicpO1xuICogdXNlci5pZCA9ICc0NTYnOyAvLyBXaWxsIGJlIHByZXZlbnRlZCBieSBSZWFkT25seVZhbGlkYXRvclxuICogQGNhdGVnb3J5IFZhbGlkYXRvcnNcbiAqL1xuQHZhbGlkYXRvcihVcGRhdGVWYWxpZGF0aW9uS2V5cy5SRUFET05MWSlcbmV4cG9ydCBjbGFzcyBSZWFkT25seVZhbGlkYXRvciBleHRlbmRzIFZhbGlkYXRvciB7XG4gIGNvbnN0cnVjdG9yKCkge1xuICAgIHN1cGVyKERFRkFVTFRfRVJST1JfTUVTU0FHRVMuUkVBRE9OTFkuSU5WQUxJRCk7XG4gIH1cblxuICAvKipcbiAgICogQGRlc2NyaXB0aW9uIEltcGxlbWVudGF0aW9uIG9mIHRoZSBiYXNlIHZhbGlkYXRvcidzIGhhc0Vycm9ycyBtZXRob2QuXG4gICAqIEBzdW1tYXJ5IFRoaXMgbWV0aG9kIGlzIHJlcXVpcmVkIGJ5IHRoZSBWYWxpZGF0b3IgaW50ZXJmYWNlIGJ1dCBub3QgdXNlZCBpbiB0aGlzIHZhbGlkYXRvciBhcyB2YWxpZGF0aW9uIG9ubHkgaGFwcGVucyBkdXJpbmcgdXBkYXRlcy5cbiAgICogQHBhcmFtIHthbnl9IHZhbHVlIC0gVGhlIHZhbHVlIHRvIHZhbGlkYXRlXG4gICAqIEBwYXJhbSB7YW55W119IGFyZ3MgLSBBZGRpdGlvbmFsIGFyZ3VtZW50c1xuICAgKiBAcmV0dXJuIHtzdHJpbmcgfCB1bmRlZmluZWR9IEFsd2F5cyByZXR1cm5zIHVuZGVmaW5lZCBhcyB0aGlzIHZhbGlkYXRvciBvbmx5IHdvcmtzIGR1cmluZyB1cGRhdGVzXG4gICAqL1xuICAvLyBlc2xpbnQtZGlzYWJsZS1uZXh0LWxpbmUgQHR5cGVzY3JpcHQtZXNsaW50L25vLXVudXNlZC12YXJzXG4gIGhhc0Vycm9ycyh2YWx1ZTogYW55LCAuLi5hcmdzOiBhbnlbXSk6IHN0cmluZyB8IHVuZGVmaW5lZCB7XG4gICAgcmV0dXJuIHVuZGVmaW5lZDtcbiAgfVxuXG4gIC8qKlxuICAgKiBAZGVzY3JpcHRpb24gQ2hlY2tzIGlmIGEgdmFsdWUgaGFzIGJlZW4gbW9kaWZpZWQgZHVyaW5nIGFuIHVwZGF0ZSBvcGVyYXRpb24uXG4gICAqIEBzdW1tYXJ5IFZhbGlkYXRlcyBhIHZhbHVlIGhhcyBub3QgY2hhbmdlZCBieSBjb21wYXJpbmcgaXQgd2l0aCB0aGUgcHJldmlvdXMgdmFsdWUgdXNpbmcgZGVlcCBlcXVhbGl0eS5cbiAgICogQHBhcmFtIHthbnl9IHZhbHVlIC0gVGhlIG5ldyB2YWx1ZSB0byB2YWxpZGF0ZVxuICAgKiBAcGFyYW0ge2FueX0gb2xkVmFsdWUgLSBUaGUgb3JpZ2luYWwgdmFsdWUgdG8gY29tcGFyZSBhZ2FpbnN0XG4gICAqIEBwYXJhbSB7c3RyaW5nfSBbbWVzc2FnZV0gLSBPcHRpb25hbCBjdXN0b20gZXJyb3IgbWVzc2FnZSB0byBvdmVycmlkZSB0aGUgZGVmYXVsdFxuICAgKiBAcmV0dXJuIHtzdHJpbmcgfCB1bmRlZmluZWR9IEFuIGVycm9yIG1lc3NhZ2UgaWYgdmFsaWRhdGlvbiBmYWlscywgdW5kZWZpbmVkIG90aGVyd2lzZVxuICAgKi9cbiAgcHVibGljIHVwZGF0ZUhhc0Vycm9ycyhcbiAgICB2YWx1ZTogYW55LFxuICAgIG9sZFZhbHVlOiBhbnksXG4gICAgbWVzc2FnZT86IHN0cmluZyxcbiAgKTogc3RyaW5nIHwgdW5kZWZpbmVkIHtcbiAgICBpZiAodmFsdWUgPT09IHVuZGVmaW5lZCkgcmV0dXJuO1xuXG4gICAgcmV0dXJuIGlzRXF1YWwodmFsdWUsIG9sZFZhbHVlKVxuICAgICAgPyB1bmRlZmluZWRcbiAgICAgIDogdGhpcy5nZXRNZXNzYWdlKG1lc3NhZ2UgfHwgdGhpcy5tZXNzYWdlKTtcbiAgfVxufVxuIl19

package/lib/validation/validators/ReadOnlyValidator.d.ts

@@ -1,23 +1,47 @@
 import { Validator } from "@decaf-ts/decorator-validation";
 /**
- * @summary Validator for the {@link readonly} decorator
- *
+ * @description A validator that ensures properties marked as readonly cannot be modified during updates.
+ * @summary Validator for the {@link readonly} decorator that checks if a value has been changed during an update operation. It compares the new value with the old value and returns an error message if they are not equal.
+ * @param {any} value - The value to be validated
+ * @param {any} oldValue - The previous value to compare against
+ * @param {string} [message] - Optional custom error message
  * @class ReadOnlyValidator
- * @extends Validator
+ * @example
+ * // Using ReadOnlyValidator with a readonly property
+ * class User {
+ *   @readonly()
+ *   id: string;
+ *
+ *   name: string;
+ *
+ *   constructor(id: string, name: string) {
+ *     this.id = id;
+ *     this.name = name;
+ *   }
+ * }
  *
+ * // This will trigger validation error when trying to update
+ * const user = new User('123', 'John');
+ * user.id = '456'; // Will be prevented by ReadOnlyValidator
  * @category Validators
  */
 export declare class ReadOnlyValidator extends Validator {
     constructor();
     /**
-     * @inheritDoc
+     * @description Implementation of the base validator's hasErrors method.
+     * @summary This method is required by the Validator interface but not used in this validator as validation only happens during updates.
+     * @param {any} value - The value to validate
+     * @param {any[]} args - Additional arguments
+     * @return {string | undefined} Always returns undefined as this validator only works during updates
      */
     hasErrors(value: any, ...args: any[]): string | undefined;
     /**
-     * @summary Validates a value has not changed
-     * @param {any} value
-     * @param {any} oldValue
-     * @param {string} [message] the error message override
+     * @description Checks if a value has been modified during an update operation.
+     * @summary Validates a value has not changed by comparing it with the previous value using deep equality.
+     * @param {any} value - The new value to validate
+     * @param {any} oldValue - The original value to compare against
+     * @param {string} [message] - Optional custom error message to override the default
+     * @return {string | undefined} An error message if validation fails, undefined otherwise
      */
     updateHasErrors(value: any, oldValue: any, message?: string): string | undefined;
 }