@creator.co/wapi 1.2.5 → 1.2.6

package/src/Config/Configuration.ts

@@ -6,17 +6,19 @@ import EnvironmentVar, { EnvironmentType } from './EnvironmentVar'
 // Hold cached values at nodeVM level
 // eslint-disable-next-line no-var
 /**
- * ${1:Description placeholder}
- *
- * @type {*}
+ * Creates a new instance of a memory cache store.
+ * @returns {MemCache} A new instance of a memory cache store.
  */
 let cacheStore = new MemCache()
 
 /**
- * ${1:Description placeholder}
- *
- * @export
- * @typedef {ConfigurationSchema}
+ * Represents the schema for the configuration object.
+ * @typedef {Object} ConfigurationSchema
+ * @property {Object} [name] - The name of the configuration property.
+ * @property {boolean} [name.isLocal] - Indicates if the property is for local use.
+ * @property {boolean} [name.isRemote] - Indicates if the property is for remote use.
+ * @property {boolean} [name.required] - Indicates if the property is required.
+ * @property {string} [name.cachingPolicy] - The caching policy for the property.
  */
 export type ConfigurationSchema = {
   [name: string]: {
@@ -27,13 +29,12 @@ export type ConfigurationSchema = {
   }
 }
 
-// runtime type infer to ConfigurationSchema keys, which type is remote
 /**
- * ${1:Description placeholder}
- *
- * @typedef {ExtractRemote}
- * @template Type
+ * Extracts the properties from a given type that have the `isRemote` property set to `true`.
+ * @param {Type} - The type to extract properties from.
+ * @returns An object type with the extracted properties.
  */
+// runtime type infer to ConfigurationSchema keys, which type is remote
 type ExtractRemote<Type> = {
   [Property in keyof Type]-?: Type[Property] extends {
     isRemote: true
@@ -41,13 +42,12 @@ type ExtractRemote<Type> = {
     ? Property
     : null
 }
-// runtime type infer to ConfigurationSchema keys, which type is local
 /**
- * ${1:Description placeholder}
- *
- * @typedef {ExtractLocal}
- * @template Type
+ * Extracts the properties from a given type that have the `isLocal` property set to `true`.
+ * @typeparam Type - The type to extract properties from.
+ * @returns An object type with the extracted properties as keys and their corresponding types.
  */
+// runtime type infer to ConfigurationSchema keys, which type is local
 type ExtractLocal<Type> = {
   [Property in keyof Type]-?: Type[Property] extends {
     isLocal: true
@@ -56,24 +56,24 @@ type ExtractLocal<Type> = {
     : null
 }
 
-// Helpers to filter null keys
 /**
- * ${1:Description placeholder}
- *
- * @typedef {OmitKeysByValueType}
- * @template T
- * @template U
+ * Creates a new type by omitting keys from type T whose values are of type U.
+ * @param {T} - The original type
+ * @param {U} - The type to omit from T
+ * @returns A new type with the omitted keys
  */
+// Helpers to filter null keys
 type OmitKeysByValueType<T, U> = {
   [P in keyof T]: T[P] extends U ? never : P
 }[keyof T]
-
 /**
- * ${1:Description placeholder}
- *
- * @typedef {OmitByValueType}
- * @template T
- * @template V
+ * Omit properties from an object type by their value type.
+ * @template T - The object type to omit properties from.
+ * @template V - The value type of properties to omit.
+ * @typedef OmitByValueType
+ * @property {T} T - The object type to omit properties from.
+ * @property {V} V - The value type of properties to omit.
+ * @returns {OmitKeysByValueType<T, V>} - The resulting object type after omitting properties.
  */
 // eslint-disable-next-line @typescript-eslint/no-unused-vars, prettier/prettier
 type OmitByValueType<T, V> = T extends infer _ 
@@ -83,36 +83,26 @@ type OmitByValueType<T, V> = T extends infer _
   : never
 
 /**
- * ${1:Description placeholder}
- *
- * @export
- * @class Configuration
- * @typedef {Configuration}
- * @template {ConfigurationSchema} T
+ * Represents a configuration object with a specified schema and remote prefix.
+ * @template T - The type of the configuration schema.
  */
 export default class Configuration<T extends ConfigurationSchema> {
   /**
-   * ${1:Description placeholder}
-   *
-   * @private
-   * @readonly
+   * The schema for the private readonly property.
    * @type {T}
    */
   private readonly schema: T
   /**
-   * ${1:Description placeholder}
-   *
-   * @private
-   * @readonly
+   * The prefix used for remote resources.
    * @type {string}
    */
   private readonly remotePrefix: string
+
   /**
-   * Creates an instance of Configuration.
-   *
-   * @constructor
-   * @param {T} schema
-   * @param {string} remotePrefix
+   * Constructs a new instance of the class.
+   * @param {T} schema - The schema object.
+   * @param {string} remotePrefix - The remote prefix string.
+   * @returns None
    */
   constructor(schema: T, remotePrefix: string) {
     this.schema = schema
@@ -120,11 +110,9 @@ export default class Configuration<T extends ConfigurationSchema> {
   }
 
   /**
-   * ${1:Description placeholder}
-   *
-   * @public
-   * @param {keyof OmitByValueType<ExtractLocal<T>, null>} propName
-   * @returns {*}
+   * Retrieves the value of a property from the environment variables or cache.
+   * @param {keyof OmitByValueType<ExtractLocal<T>, null>} propName - The name of the property to retrieve.
+   * @returns The value of the property.
    */
   public get(propName: keyof OmitByValueType<ExtractLocal<T>, null>): any {
     const propString = propName as string
@@ -141,13 +129,11 @@ export default class Configuration<T extends ConfigurationSchema> {
     this.cacheValue(propString, v, propSchema.cachingPolicy)
     return v
   }
+
   /**
-   * ${1:Description placeholder}
-   *
-   * @public
-   * @async
-   * @param {keyof OmitByValueType<ExtractRemote<T>, null>} propName
-   * @returns {Promise<any>}
+   * Asynchronously retrieves the value of a property from the remote environment.
+   * @param {keyof OmitByValueType<ExtractRemote<T>, null>} propName - The name of the property to retrieve.
+   * @returns {Promise<any>} - A promise that resolves to the value of the property.
    */
   public async asyncGet(propName: keyof OmitByValueType<ExtractRemote<T>, null>): Promise<any> {
     const propString = propName as string
@@ -164,33 +150,30 @@ export default class Configuration<T extends ConfigurationSchema> {
     this.cacheValue(propString, v, propSchema.cachingPolicy)
     return v
   }
-  // caching layer
+
   /**
-   * ${1:Description placeholder}
-   *
-   * @private
-   * @param {string} valueKey
-   * @returns {*}
+   * Retrieves the cached value associated with the given key from the cache store.
+   * @param {string} valueKey - The key of the value to retrieve from the cache.
+   * @returns The cached value associated with the given key, or undefined if the key does not exist in the cache.
    */
   private getCachedValue(valueKey: string): any {
     return cacheStore.get(valueKey)
   }
+
   /**
-   * ${1:Description placeholder}
-   *
-   * @private
-   * @param {string} valueKey
-   * @param {*} value
-   * @param {string} [policy="1d"]
+   * Caches a value with the specified key and expiration policy.
+   * @param {string} valueKey - The key to associate with the cached value.
+   * @param {any} value - The value to be cached.
+   * @param {string} [policy='1d'] - The expiration policy for the cached value. Defaults to '1d' (1 day).
+   * @returns None
    */
   private cacheValue(valueKey: string, value: any, policy: string = '1d'): void {
-    cacheStore.set(valueKey, value, DurationParser(policy, 's'))
+    cacheStore.set(valueKey, value, DurationParser(policy, 's') || '')
   }
-  // unit-test support
+
   /**
-   * ${1:Description placeholder}
-   *
-   * @private
+   * Resets the cache by creating a new instance of the MemCache class and assigning it to the cacheStore variable.
+   * @returns None
    */
   private resetCache() {
     cacheStore = new MemCache()

package/src/Config/EnvironmentVar.ts

@@ -9,14 +9,16 @@ import { SSMClient, GetParameterCommand } from '@aws-sdk/client-ssm'
  *
  * @type {*}
  */
-let ssmClient = null,
-  secretsClient = null
+let ssmClient: SSMClient | null = null,
+  secretsClient: SecretsManagerClient | null = null
 
 /**
- * ${1:Description placeholder}
- *
- * @export
+ * An enumeration representing different types of environments.
  * @enum {number}
+ * @readonly
+ * @property {number} PlainRemote - Represents a plain remote environment.
+ * @property {number} SecureRemote - Represents a secure remote environment.
+ * @property {number} Local - Represents a local environment.
  */
 export enum EnvironmentType {
   PlainRemote,
@@ -24,54 +26,35 @@ export enum EnvironmentType {
   Local,
 }
 /**
- * ${1:Description placeholder}
- *
- * @export
- * @class EnvironmentVar
- * @typedef {EnvironmentVar}
- * @template T
+ * Represents an environment variable with methods to resolve its value based on the environment type.
+ * @template T - The type of the environment variable value.
  */
 export default class EnvironmentVar<T> {
   /**
-   * ${1:Description placeholder}
-   *
-   * @private
-   * @readonly
-   * @type {string}
+   * The name of the parameter.
    */
   private readonly paramName: string
   /**
-   * ${1:Description placeholder}
-   *
-   * @private
+   * The type of environment.
    * @readonly
-   * @type {EnvironmentType}
    */
   private readonly type: EnvironmentType
   /**
-   * ${1:Description placeholder}
-   *
-   * @private
-   * @readonly
-   * @type {boolean}
+   * A boolean flag indicating whether the field is optional or not.
    */
   private readonly optional: boolean
   /**
-   * ${1:Description placeholder}
-   *
-   * @private
-   * @readonly
+   * The prefix used for parameters in the class.
    * @type {string}
    */
   private readonly paramPrefix: string
+
   /**
-   * Creates an instance of EnvironmentVar.
-   *
-   * @constructor
-   * @param {string} paramName
-   * @param {EnvironmentType} type
-   * @param {?boolean} [optional]
-   * @param {string} [paramPrefix=`/creatorco-api-\${process.env.STAGE\}/env/`]
+   * Constructs a new instance of the EnvironmentVar class.
+   * @param {string} paramName - The name of the environment variable.
+   * @param {EnvironmentType} type - The type of the environment.
+   * @param {boolean} [optional] - Indicates whether the environment variable is optional.
+   * @param {string} [paramPrefix] - The prefix to be added to the environment variable name.
    */
   constructor(
     paramName: string,
@@ -86,10 +69,9 @@ export default class EnvironmentVar<T> {
   }
 
   /**
-   * ${1:Description placeholder}
-   *
-   * @public
-   * @returns {T}
+   * Resolves the value of the environment variable synchronously.
+   * @returns {T} - The resolved value of the environment variable.
+   * @throws {Error} - If the environment type is not 'Local'.
    */
   public syncResolve(): T {
     if (this.type == EnvironmentType.Local) return this.getLocalValue()
@@ -99,12 +81,10 @@ export default class EnvironmentVar<T> {
       )
     }
   }
+
   /**
-   * ${1:Description placeholder}
-   *
-   * @public
-   * @async
-   * @returns {unknown}
+   * Resolves the value based on the environment type.
+   * @returns {Promise<any>} - The resolved value.
    */
   public async resolve() {
     if (this.type == EnvironmentType.Local) return this.getLocalValue()
@@ -113,10 +93,9 @@ export default class EnvironmentVar<T> {
   }
 
   /**
-   * ${1:Description placeholder}
-   *
-   * @private
-   * @returns {T}
+   * Retrieves the value of a local environment variable.
+   * @returns {T} - The value of the local environment variable.
+   * @throws {Error} - If the local environment variable is not defined and is not optional.
    */
   private getLocalValue(): T {
     const value = process.env[this.paramName]
@@ -127,14 +106,13 @@ export default class EnvironmentVar<T> {
     }
     return value as T
   }
+
   /**
-   * ${1:Description placeholder}
-   *
-   * @private
-   * @async
-   * @returns {Promise<T>}
+   * Retrieves the plain value of a remote environment parameter.
+   * @returns {Promise<T>} - A promise that resolves to the plain value of the parameter.
+   * @throws {Error} - If the parameter cannot be retrieved and is not optional.
    */
-  private async getPlainValue(): Promise<T> {
+  private async getPlainValue(): Promise<T | undefined> {
     if (!ssmClient) ssmClient = new SSMClient()
     const pName = `${this.paramPrefix}${this.paramName}`
     try {
@@ -147,19 +125,18 @@ export default class EnvironmentVar<T> {
       throw new Error(`Unable to retrieve plain remote env value: ${pName}`)
     }
   }
+
   /**
-   * ${1:Description placeholder}
-   *
-   * @private
-   * @async
-   * @returns {Promise<T>}
+   * Retrieves a secure value from the secrets manager.
+   * @returns {Promise<T>} - A promise that resolves to the secure value.
+   * @throws {Error} - Throws an error if the secure value cannot be retrieved and is not optional.
    */
-  private async getSecureValue(): Promise<T> {
+  private async getSecureValue(): Promise<T | undefined> {
     if (!secretsClient) secretsClient = new SecretsManagerClient()
     const pName = `${this.paramPrefix}${this.paramName}`
     try {
       const data = await secretsClient.send(new GetSecretValueCommand({ SecretId: pName }))
-      if (data.Parameter && data.Parameter.Value) return data.Parameter.Value as T
+      if (data.SecretString) return data.SecretString as T
     } catch (error) {
       console.error(error)
     }

package/src/Crypto/Crypto.ts

@@ -1,58 +1,42 @@
 import { KMSClient, EncryptCommand, DecryptCommand } from '@aws-sdk/client-kms'
 
 /**
- * ${1:Description placeholder}
- *
- * @export
- * @class Crypto
- * @typedef {Crypto}
+ * Represents a Crypto class that provides encryption and decryption functionality using AWS KMS.
  */
 export default class Crypto {
   /**
-   * ${1:Description placeholder}
-   *
-   * @private
-   * @readonly
-   * @type {KMSClient}
+   * The KMSClient instance used for making requests to the Key Management Service (KMS).
    */
   private readonly client: KMSClient
   /**
-   * ${1:Description placeholder}
-   *
-   * @private
-   * @readonly
-   * @type {string}
+   * The AWS region of the object. This property is readonly and cannot be modified once set.
    */
   private readonly region: string
   /**
-   * ${1:Description placeholder}
-   *
-   * @private
+   * The unique identifier for the KMS.
    * @readonly
    * @type {string}
    */
   private readonly keyId: string
+
   /**
-   * Creates an instance of Crypto.
-   *
-   * @constructor
-   * @param {string} region
-   * @param {string} keyId
+   * Constructs a new instance of the KMSClient class.
+   * @param {string} region - The AWS region to use for the client.
+   * @param {string} keyId - The AWS KMS key ID to use for encryption and decryption operations.
+   * @returns None
    */
   constructor(region: string, keyId: string) {
     this.region = region
     this.keyId = keyId
     this.client = new KMSClient({ region: this.region })
   }
-  //
+
   /**
-   * ${1:Description placeholder}
-   *
-   * @async
-   * @param {(string | any)} data
-   * @returns {Promise<string>}
+   * Encrypts the given data using RSAES_OAEP_SHA_256 encryption algorithm.
+   * @param {string | any} data - The data to be encrypted.
+   * @returns {Promise<string | null>} - A promise that resolves to the encrypted data as a hexadecimal string.
    */
-  async encryptData(data: string | any): Promise<string> {
+  public async encryptData(data: string | any): Promise<string | null> {
     try {
       const resp = await this.client.send(
         new EncryptCommand({
@@ -69,14 +53,14 @@ export default class Crypto {
       return null
     }
   }
+
   /**
-   * ${1:Description placeholder}
-   *
-   * @async
-   * @param {string} data
-   * @returns {Promise<string>}
+   * Decrypts the given data using the RSAES_OAEP_SHA_256 encryption algorithm.
+   * @param {string} data - The encrypted data to decrypt.
+   * @returns {Promise<string | null>} - A promise that resolves to the decrypted plaintext string.
+   * If decryption fails, null is returned.
    */
-  async decryptData(data: string): Promise<string> {
+  public async decryptData(data: string): Promise<string | null> {
     try {
       const resp = await this.client.send(
         new DecryptCommand({

package/src/Crypto/JWT.ts

@@ -1,9 +1,11 @@
 import * as jwt from 'jsonwebtoken'
 
 /**
- * ${1:Description placeholder}
- *
- * @typedef {JWTValidationResponse}
+ * Represents the response of a JWT validation.
+ * @typedef {Object} JWTValidationResponse
+ * @property {boolean} isValid - Indicates whether the JWT is valid or not.
+ * @property {jwt.JwtPayload} [decodedToken] - The decoded JWT payload if the JWT is valid.
+ * @property {boolean} [isExpired] - Indicates whether the JWT is expired or not, only present if isValid is false.
  */
 type JWTValidationResponse =
   | { isValid: true; decodedToken: jwt.JwtPayload }
@@ -13,51 +15,45 @@ type JWTValidationResponse =
     }
 
 /**
- * ${1:Description placeholder}
- *
- * @export
- * @class JWT
- * @typedef {JWT}
+ * Represents a JSON Web Token (JWT) utility class.
  */
 export default class JWT {
   /**
-   * ${1:Description placeholder}
-   *
-   * @private
-   * @readonly
+   * The secret key used for generating and verifying tokens.
    * @type {string}
    */
   private readonly tokenSecret: string
   /**
-   * ${1:Description placeholder}
-   *
-   * @private
-   * @readonly
+   * The default expiration time for a cache entry.
    * @type {string}
    */
   private readonly defaultExpiration: string
+
   /**
-   * Creates an instance of JWT.
-   *
-   * @constructor
-   * @param {string} tokenSecret
-   * @param {?string} [defaultExpiration]
+   * Constructs a new instance of the class.
+   * @param {string} tokenSecret - The secret used to sign the tokens.
+   * @param {string} [defaultExpiration] - The default expiration time for the tokens.
+   * @returns None
    */
   constructor(tokenSecret: string, defaultExpiration?: string) {
     this.tokenSecret = tokenSecret
     this.defaultExpiration = defaultExpiration
   }
-  //
+
   /**
-   * ${1:Description placeholder}
-   *
-   * @param {object} data
-   * @param {?string} [expiration]
-   * @param {?string} [overrideToken]
-   * @param {?*} [opts]
-   * @returns {string}
+   * Creates a JSON Web Token (JWT) using the provided data and options.
+   * @param {object} data - The data to be included in the token payload.
+   * @param {string} [expiration] - The expiration time for the token. If not provided, the default expiration time will be used.
+   * @param {string} [overrideToken] - An optional token secret to override the default token secret.
+   * @param {any} [opts] - Additional options to be passed to the jwt.sign() function.
+   * @returns {string} - The generated JWT.
    */
-  createToken(data: object, expiration?: string, overrideToken?: string, opts?: any): string {
+  public createToken(
+    data: object,
+    expiration?: string,
+    overrideToken?: string,
+    opts?: any
+  ): string {
     const exp = expiration || this.defaultExpiration
     return jwt.sign(
       data,
@@ -65,13 +61,13 @@ export default class JWT {
       exp ? { expiresIn: exp, ...(opts || {}) } : opts || {}
     )
   }
+
   /**
-   * ${1:Description placeholder}
-   *
-   * @param {string} token
-   * @returns {JWTValidationResponse}
+   * Validates a JSON Web Token (JWT) and returns the validation response.
+   * @param {string} token - The JWT to validate.
+   * @returns {JWTValidationResponse} - The validation response object.
    */
-  validateToken(token: string): JWTValidationResponse {
+  public validateToken(token: string): JWTValidationResponse {
     try {
       // Check if is valid
       const isValid = jwt.verify(token, this.tokenSecret)