@ne1410s/codl 0.1.2 → 0.1.4

package/dist/decorate/interception.d.ts

@@ -1,26 +1,26 @@
-import { Ctor, FunctionDecorator, TypedPropertyDecorator } from '../types';
-export declare abstract class Interception {
-    /**
-     * Calls a custom function each with new instance created.
-     * @param fn A custom function.
-     */
-    static readonly init: <T>(fn: (o: any) => void) => (c: Ctor<T>) => Ctor<any>;
-    /**
-     * Provides an initial / default value.
-     * @param val The initial value.
-     */
-    static readonly initial: <T>(val: T) => TypedPropertyDecorator<T>;
-    /**
-     * Intercepts the input of a function, preventing its execution.
-     * @param fn A custom function.
-     * @returns The result of the custom function.
-     */
-    static readonly input: (fn: (args: any[], o: any) => any) => FunctionDecorator;
-    /**
-     * Intercepts the output of a function, after it is executed.
-     * @param fn A custom function.
-     * @returns The result of the custom function.
-     */
-    static readonly output: <T>(fn: (val: T, args: any[], o: any) => T) => FunctionDecorator;
-    private static readonly expose;
-}
+import { Ctor, FunctionDecorator, TypedPropertyDecorator } from '../types';
+export declare abstract class Interception {
+    /**
+     * Calls a custom function each with new instance created.
+     * @param fn A custom function.
+     */
+    static readonly init: <T>(fn: (o: any) => void) => (c: Ctor<T>) => Ctor<any>;
+    /**
+     * Provides an initial / default value.
+     * @param val The initial value.
+     */
+    static readonly initial: <T>(val: T) => TypedPropertyDecorator<T>;
+    /**
+     * Intercepts the input of a function, preventing its execution.
+     * @param fn A custom function.
+     * @returns The result of the custom function.
+     */
+    static readonly input: (fn: (args: any[], o: any) => any) => FunctionDecorator;
+    /**
+     * Intercepts the output of a function, after it is executed.
+     * @param fn A custom function.
+     * @returns The result of the custom function.
+     */
+    static readonly output: <T>(fn: (val: T, args: any[], o: any) => T) => FunctionDecorator;
+    private static readonly expose;
+}

package/dist/decorate/metadata.d.ts

@@ -1,28 +1,28 @@
-import 'reflect-metadata';
-import { TypedPropertyDecorator, Ctor } from '../types';
-/** Decorators for metadata purposes. */
-export declare abstract class Metadata {
-    /**
-     * Associates a display name with the member to which it is applied.
-     * @param val The name.
-     */
-    static readonly displayName: (val: string) => {
-        (target: Function): void;
-        (target: Object, propertyKey: string | symbol): void;
-    };
-    /**
-     * Associates a description with the member to which it is applied.
-     * @param val The description.
-     */
-    static readonly description: (val: string) => {
-        (target: Function): void;
-        (target: Object, propertyKey: string | symbol): void;
-    };
-    /**
-     * Associates a format function with the member to which it is applied.
-     * @param fn The format function.
-     */
-    static readonly format: <T>(fn: (val: T) => string) => TypedPropertyDecorator<T>;
-    /** Associates a child's prototype data on the parent in which it appears. */
-    static readonly model: <T extends Object>(ctor: Ctor<T>) => TypedPropertyDecorator<T | T[]>;
-}
+import 'reflect-metadata';
+import { TypedPropertyDecorator, Ctor } from '../types';
+/** Decorators for metadata purposes. */
+export declare abstract class Metadata {
+    /**
+     * Associates a display name with the member to which it is applied.
+     * @param val The name.
+     */
+    static readonly displayName: (val: string) => {
+        (target: Function): void;
+        (target: Object, propertyKey: string | symbol): void;
+    };
+    /**
+     * Associates a description with the member to which it is applied.
+     * @param val The description.
+     */
+    static readonly description: (val: string) => {
+        (target: Function): void;
+        (target: Object, propertyKey: string | symbol): void;
+    };
+    /**
+     * Associates a format function with the member to which it is applied.
+     * @param fn The format function.
+     */
+    static readonly format: <T>(fn: (val: T) => string) => TypedPropertyDecorator<T>;
+    /** Associates a child's prototype data on the parent in which it appears. */
+    static readonly model: <T extends Object>(ctor: Ctor<T>) => TypedPropertyDecorator<T | T[]>;
+}

package/dist/decorate/type.d.ts

@@ -1,9 +1,9 @@
-import 'reflect-metadata';
-import { TypedPropertyDecorator } from '../types';
-/** Decorators for type purposes. */
-export declare abstract class Type {
-    static readonly boolean: TypedPropertyDecorator<boolean | number | string | Array<boolean | number | string>>;
-    static readonly date: TypedPropertyDecorator<Date | string | Array<Date | string>>;
-    static readonly integer: TypedPropertyDecorator<number | string | Array<number | string>>;
-    static readonly number: TypedPropertyDecorator<number | string | Array<number | string>>;
-}
+import 'reflect-metadata';
+import { TypedPropertyDecorator } from '../types';
+/** Decorators for type purposes. */
+export declare abstract class Type {
+    static readonly boolean: TypedPropertyDecorator<boolean | number | string | Array<boolean | number | string>>;
+    static readonly date: TypedPropertyDecorator<Date | string | Array<Date | string>>;
+    static readonly integer: TypedPropertyDecorator<number | string | Array<number | string>>;
+    static readonly number: TypedPropertyDecorator<number | string | Array<number | string>>;
+}

package/dist/decorate/validation.d.ts

@@ -1,71 +1,71 @@
-import 'reflect-metadata';
-import { TypedPropertyDecorator, CustomValidator } from '../types';
-/** Decorators for validation purposes. */
-export declare abstract class Validation {
-    /**
-     * Makes a property required. 'Unprovided' values (null, undefined, '') are
-     * invalid, as is NaN. Anything else is valid (including: 0, 0n, false).
-     */
-    static readonly required: PropertyDecorator;
-    /**
-     * Makes a property forbidden. 'Unprovided' values (null, undefined, '') are
-     * valid. Anything else is considered invalid (including: 0, 0n, false).
-     */
-    static readonly forbidden: PropertyDecorator;
-    /**
-     * Associates a string or array with a minimum length. 'Unprovided' values
-     * (null, undefined, '') are not tested hence valid. Otherwise the string
-     * length must not be less than the bound supplied.
-     * @param lBound The minimum length.
-     */
-    static readonly minLength: <T>(lBound: number) => TypedPropertyDecorator<ArrayLike<T>>;
-    /**
-     * Associates a string or array with a maximum length. 'Unprovided' values
-     * (null, undefined, '') are not tested hence valid. Otherwise the string
-     * length must not exceed the upper bound supplied.
-     * @param uBound The maximum length.
-     */
-    static readonly maxLength: <T>(uBound: number) => TypedPropertyDecorator<ArrayLike<T>>;
-    /**
-     * Associates a property with a minimum value. 'Unprovided' values (null,
-     * undefined, '') are not tested hence valid. Otherwise the value must not be
-     * less than the lower bound supplied to be valid.
-     * @param lBound The minimum value.
-     */
-    static readonly min: <T extends Number | Date>(lBound: T) => TypedPropertyDecorator<T | ArrayLike<T>>;
-    /**
-     * Associates a number or date property with a maximum value. 'Unprovided'
-     * values (null, undefined, '') are not tested hence valid. Otherwise the
-     * value must not exceed the upper bound supplied to be valid.
-     * @param uBound The maximum value.
-     */
-    static readonly max: <T extends Number | Date>(uBound: T) => TypedPropertyDecorator<T | ArrayLike<T>>;
-    /**
-     * Associates a property with minimum and maximum values. 'Unprovided' values
-     * (null, undefined, '') are not tested hence valid. Otherwise the value must
-     * be (inclusively) between the lower and upper bounds.
-     * @param lBound The minimum value.
-     */
-    static readonly range: <T extends Number | Date>(lBound: T, uBound: T) => TypedPropertyDecorator<T | ArrayLike<T>>;
-    /**
-     * Associates a property with a pattern. 'Unprovided' values (null, undefined,
-     * '') are not tested hence valid. Otherwise the result of .toString() must
-     * match the regex supplied to be valid.
-     * @param regex The validation pattern.
-     */
-    static readonly regex: (regex: string | RegExp) => PropertyDecorator;
-    /**
-     * Associates a property with a predefined set of allowed values. Primitive
-     * types, enums and arrays thereof are all supported.
-     */
-    static readonly options: <T extends String | Number | Boolean>(...opts: T[]) => TypedPropertyDecorator<T | ArrayLike<T>>;
-    /**
-     * Associates a property with a custom validator. Unlike most other validation
-     * decorators, ALL values will be tested (rather than being skipped if it was
-     * deemed 'unprovided') - the decision is not taken on the caller's behalf. If
-     * the function returns false, the value is deemed invalid and a generic error
-     * is used. Else if it returns a string, this string is used as the message,
-     * with null or empty strings taken to indicate that the value is valid).
-     */
-    static readonly custom: <T>(fn: CustomValidator) => TypedPropertyDecorator<T>;
-}
+import 'reflect-metadata';
+import { TypedPropertyDecorator, CustomValidator } from '../types';
+/** Decorators for validation purposes. */
+export declare abstract class Validation {
+    /**
+     * Makes a property required. 'Unprovided' values (null, undefined, '') are
+     * invalid, as is NaN. Anything else is valid (including: 0, 0n, false).
+     */
+    static readonly required: PropertyDecorator;
+    /**
+     * Makes a property forbidden. 'Unprovided' values (null, undefined, '') are
+     * valid. Anything else is considered invalid (including: 0, 0n, false).
+     */
+    static readonly forbidden: PropertyDecorator;
+    /**
+     * Associates a string or array with a minimum length. 'Unprovided' values
+     * (null, undefined, '') are not tested hence valid. Otherwise the string
+     * length must not be less than the bound supplied.
+     * @param lBound The minimum length.
+     */
+    static readonly minLength: <T>(lBound: number) => TypedPropertyDecorator<ArrayLike<T>>;
+    /**
+     * Associates a string or array with a maximum length. 'Unprovided' values
+     * (null, undefined, '') are not tested hence valid. Otherwise the string
+     * length must not exceed the upper bound supplied.
+     * @param uBound The maximum length.
+     */
+    static readonly maxLength: <T>(uBound: number) => TypedPropertyDecorator<ArrayLike<T>>;
+    /**
+     * Associates a property with a minimum value. 'Unprovided' values (null,
+     * undefined, '') are not tested hence valid. Otherwise the value must not be
+     * less than the lower bound supplied to be valid.
+     * @param lBound The minimum value.
+     */
+    static readonly min: <T extends Number | Date>(lBound: T) => TypedPropertyDecorator<T | ArrayLike<T>>;
+    /**
+     * Associates a number or date property with a maximum value. 'Unprovided'
+     * values (null, undefined, '') are not tested hence valid. Otherwise the
+     * value must not exceed the upper bound supplied to be valid.
+     * @param uBound The maximum value.
+     */
+    static readonly max: <T extends Number | Date>(uBound: T) => TypedPropertyDecorator<T | ArrayLike<T>>;
+    /**
+     * Associates a property with minimum and maximum values. 'Unprovided' values
+     * (null, undefined, '') are not tested hence valid. Otherwise the value must
+     * be (inclusively) between the lower and upper bounds.
+     * @param lBound The minimum value.
+     */
+    static readonly range: <T extends Number | Date>(lBound: T, uBound: T) => TypedPropertyDecorator<T | ArrayLike<T>>;
+    /**
+     * Associates a property with a pattern. 'Unprovided' values (null, undefined,
+     * '') are not tested hence valid. Otherwise the result of .toString() must
+     * match the regex supplied to be valid.
+     * @param regex The validation pattern.
+     */
+    static readonly regex: (regex: string | RegExp) => PropertyDecorator;
+    /**
+     * Associates a property with a predefined set of allowed values. Primitive
+     * types, enums and arrays thereof are all supported.
+     */
+    static readonly options: <T extends String | Number | Boolean>(...opts: T[]) => TypedPropertyDecorator<T | ArrayLike<T>>;
+    /**
+     * Associates a property with a custom validator. Unlike most other validation
+     * decorators, ALL values will be tested (rather than being skipped if it was
+     * deemed 'unprovided') - the decision is not taken on the caller's behalf. If
+     * the function returns false, the value is deemed invalid and a generic error
+     * is used. Else if it returns a string, this string is used as the message,
+     * with null or empty strings taken to indicate that the value is valid).
+     */
+    static readonly custom: <T>(fn: CustomValidator) => TypedPropertyDecorator<T>;
+}

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-export * from './types';
-export * from './decorate/interception';
-export * from './decorate/metadata';
-export * from './decorate/type';
-export * from './decorate/validation';
-export * from './reflect/metadata';
-export * from './reflect/validation/validation';
+export * from './types';
+export * from './decorate/interception';
+export * from './decorate/metadata';
+export * from './decorate/type';
+export * from './decorate/validation';
+export * from './reflect/metadata';
+export * from './reflect/validation/validation';

package/dist/mdkeys.d.ts

@@ -1,20 +1,20 @@
-/** Metadata keys. */
-export declare enum MetadataKey {
-    DISPLAY_NAME = "ne-codl:metadata:display-name",
-    DESCRIPTION = "ne-codl:metadata:description",
-    FORMAT = "ne-codl:metadata:format",
-    MODEL = "ne-codl:metadata:model"
-}
-/** Validation keys. */
-export declare enum ValidationKey {
-    REQUIRED = "ne-codl:validation:required",
-    FORBIDDEN = "ne-codl:validation:forbidden",
-    MIN_LENGTH = "ne-codl:validation:min-length",
-    MAX_LENGTH = "ne-codl:validation:max-length",
-    MIN = "ne-codl:validation:min",
-    MAX = "ne-codl:validation:max",
-    REGEX = "ne-codl:validation:regex",
-    TYPE = "ne-codl:validation:type",
-    OPTIONS = "ne-codl:validation:options",
-    CUSTOM = "ne-codl:validation:custom"
-}
+/** Metadata keys. */
+export declare enum MetadataKey {
+    DISPLAY_NAME = "ne-codl:metadata:display-name",
+    DESCRIPTION = "ne-codl:metadata:description",
+    FORMAT = "ne-codl:metadata:format",
+    MODEL = "ne-codl:metadata:model"
+}
+/** Validation keys. */
+export declare enum ValidationKey {
+    REQUIRED = "ne-codl:validation:required",
+    FORBIDDEN = "ne-codl:validation:forbidden",
+    MIN_LENGTH = "ne-codl:validation:min-length",
+    MAX_LENGTH = "ne-codl:validation:max-length",
+    MIN = "ne-codl:validation:min",
+    MAX = "ne-codl:validation:max",
+    REGEX = "ne-codl:validation:regex",
+    TYPE = "ne-codl:validation:type",
+    OPTIONS = "ne-codl:validation:options",
+    CUSTOM = "ne-codl:validation:custom"
+}