@zajno/common 2.3.17 → 2.4.0

package/types/structures/promiseExtended.d.ts

@@ -0,0 +1,70 @@
+import type { Nullable } from '../types/misc';
+/**
+ * The idea here is to wrap a promise (or promise getter) so it will never throw natively, but still be able to provide success/fail results:
+ * - `onSuccess` for handling successful result: like `then` but to be called only if there was no error
+ * - `onError` for handling error: like `catch` but with extended error format
+ * - `expectError` adds a specific Error sub-class caster and adds it to the error data; useful when expecting some kind of specific error
+ *
+ * Important: all methods are chainable however will return the same PromiseExtended instance,
+ * while native Promise methods return a new Promise instance on each `then`/`catch`/`finally` call.
+ * Internally it just replaces the promise reference.
+ *
+ * Usage example:
+ *
+ * ```ts
+ * function doWork() {
+ *    return PromiseExtended
+ *      .run(async () => {
+ *          // return 42;
+ *          throw new Error('Some error');
+ *     });
+ * }
+ *
+ * dowWork()
+ *   // if no error, will return 42
+ *   .onSuccess(data => console.log('Success:', data))
+ *   // if error, will return { error: 'Some error', source: Error }
+ *   .onError(({ error, source }) => console.error('Error Message:', error, '; original:', source))
+ *   // this is possible to be called only if handlers throw
+ *   .catch(err => console.error('Really unexpected error:', err));
+ *
+ * ```
+ *
+ * NOTE: regular `then`/`catch` will still work, but they will go after `catch` in the chain,
+ * so basically every `then` will be called unless some previous handler throws,
+ * and every `catch` will NOT be called unless there was an error in any previous handler.
+ *
+ * If passed promise resolve is `PromiseExtended` instance, current instance will redirect everything to it.
+ *
+ */
+export declare class PromiseExtended<T, TCustomErrors extends Record<string, unknown> = Record<never, unknown>> implements Promise<T> {
+    protected _error: PromiseExtended.ErrorData | null;
+    private _promise;
+    private readonly _errorProcessors;
+    private constructor();
+    static run<T, TErrors extends Record<string, unknown> = Record<never, unknown>>(worker: Promise<T> | (() => Promise<T>)): PromiseExtended<T, TErrors>;
+    static succeeded<T>(data: T): PromiseExtended<T>;
+    static errored<T, TErrors extends Record<string, unknown>>(source: Error | Error[] | string): PromiseExtended<T, TErrors>;
+    onError(cb: Nullable<(data: PromiseExtended.ErrorData & TCustomErrors) => void>): this;
+    onSuccess(cb: Nullable<(data: T) => void>): this;
+    expectError<TName extends string, TError2 extends Error>(name: TName, ErrCtor: new (...args: any[]) => TError2, processor?: (value: TError2) => void | Partial<TCustomErrors & Record<TName, TError2>>): PromiseExtended<T, TCustomErrors & Record<TName, TError2>>;
+    then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null): PromiseExtended<TResult1 | TResult2, TCustomErrors>;
+    catch<TResult = never>(onrejected?: ((reason: unknown) => TResult | PromiseLike<TResult>) | null): PromiseExtended<T | TResult, TCustomErrors>;
+    finally(onfinally?: (() => void) | null): this;
+    toSuccessPromise(): Promise<boolean>;
+    get [Symbol.toStringTag](): string;
+    private getError;
+    private _catch;
+    /** Adds to the end of chain special marker that allow outer PromiseExtended to correctly process this instance with its own onSuccess/onError callbacks.
+     *
+     * See `example for combining` test case for more details.
+     */
+    pop(): PromiseExtended<T, TCustomErrors>;
+    protected onErrorCaught(data: PromiseExtended.ErrorData): void;
+}
+export declare namespace PromiseExtended {
+    type ErrorData = {
+        error: string;
+        source: Error;
+    };
+}

package/types/structures/promiseProxy.d.ts

@@ -0,0 +1,29 @@
+import { LazyPromise } from '../lazy/promise';
+import { AnyObject, FunctionKeys, StringKeys } from '../types';
+declare const PromiseGetter = "__promise";
+type AllowedFnKeys<T extends AnyObject> = FunctionKeys<T, any[], void>;
+type PromiseProxy<T extends AnyObject, TKeys extends StringKeys<T> = StringKeys<T>, TFnKeys = never, TWrap extends object = object> = {
+    [K in TKeys]: T[K] extends (...args: any) => any ? (K extends TFnKeys ? T[K] : never) : T[K];
+} & {
+    readonly [PromiseGetter]: Promise<T>;
+} & TWrap;
+type ForbiddenKeys = typeof PromiseGetter;
+type NoForbiddenKeys<T> = {
+    [K in keyof T]: K extends ForbiddenKeys ? never : T[K];
+};
+type Options<T, TFnKeys, TWrap, TLazy> = {
+    loader: () => Promise<T>;
+    fnKeys?: TFnKeys[];
+    wrap?: TWrap;
+    lazy?: TLazy;
+};
+/**
+ * Creates a proxy object that will be resolved to the object returned by the loader function. // Thanks CoPilot for this comment :)
+ *
+ * @param loader a function returning a promise that resolves to a proxied object
+ * @param fnKeys an array of keys that should be treated as functions so that they can be called before the object is resolved
+ * @param wrap an object that will be used as a wrapper for the proxied object. can contain any fields that will be copied to the resolved object
+ * @returns a proxy object that will be resolved to the object returned by the loader function
+ */
+export declare function createPromiseProxy<T extends NoForbiddenKeys<T>, TFnKeys extends AllowedFnKeys<T> = never, TWrap extends object = object>(options: Options<T, TFnKeys, TWrap, typeof LazyPromise>): PromiseProxy<T, StringKeys<T>, TFnKeys, TWrap>;
+export {};

package/types/structures/queue/parallel.d.ts

@@ -0,0 +1,23 @@
+export type QueueItem = () => void | Promise<void>;
+export declare class ParallelQueue {
+    private readonly _queues;
+    private _inProgress;
+    private _currentIndex;
+    private _maxIndex;
+    private _logger;
+    private readonly _beforePriorityRun;
+    private readonly _afterPriorityRun;
+    private readonly _finished;
+    get currentPriority(): number;
+    get inProgress(): boolean;
+    get beforePriorityRun(): import("../../observing/event").IEvent<number>;
+    get afterPriorityRun(): import("../../observing/event").IEvent<number>;
+    get finished(): import("../../observing/event").IEvent<any>;
+    withLogger(name?: string): this;
+    /** @returns A callback that will try to cancel queued item */
+    enqueue(cb: QueueItem, priority?: number): () => void;
+    start(): Promise<boolean | undefined>;
+    private getQueue;
+    private tryStartQueue;
+    private _executeLoader;
+}

package/types/structures/queue/tasks.d.ts

@@ -0,0 +1,16 @@
+import type { ILogger } from '../../logger';
+type Factory<T> = () => Promise<T>;
+export declare class TasksQueue<T> {
+    readonly limit: number;
+    private readonly _items;
+    private _running;
+    private _logger;
+    constructor(limit: number);
+    get isFull(): boolean;
+    get running(): number;
+    addLogger(logger: ILogger): this;
+    enqueue(factory: Factory<T>, name?: string): Promise<T>;
+    private _runFactory;
+    private _tryRunNext;
+}
+export {};

package/types/structures/subscribersMap.d.ts

@@ -0,0 +1,22 @@
+import { IDisposable } from '../functions/disposer';
+type Unsub = () => void;
+export declare class SubscribersMap implements IDisposable {
+    readonly subscribe: null | ((key: string) => Promise<Unsub[]>);
+    readonly name?: string | undefined;
+    /** Unsubscribers map: key => unsub fn */
+    private readonly _map;
+    /** Timeouts map: key => timeout handle */
+    private readonly _timeouts;
+    private readonly _logger;
+    protected _count: number;
+    constructor(subscribe: null | ((key: string) => Promise<Unsub[]>), name?: string | undefined);
+    get count(): number;
+    getIsObserving(key: string): boolean;
+    getHasObserveTimeout(key: string): boolean;
+    enable(key: string, enable: boolean, clearAfter?: number | null, existingUnsubs?: Unsub[] | null): Promise<void>;
+    private refreshTimeout;
+    protected setCount(v: number): void;
+    clear(): void;
+    dispose(): void;
+}
+export {};

package/types/structures/tempoCache.d.ts

@@ -0,0 +1,29 @@
+import type { ILazy, ILazyPromise } from '../lazy/types';
+import { ExpireTracker } from './expire';
+/**
+ * Calls factory fn to fetch and store some value for a limited time.
+ *
+ * To factory method be called, `current` getter must be accessed.
+*/
+export declare class TempoCache<T> {
+    readonly factory: () => T;
+    private _current;
+    readonly tracker: ExpireTracker;
+    constructor(factory: () => T, lifetimeMs: number);
+    get isExpired(): boolean;
+    get current(): T | undefined;
+}
+export declare namespace TempoCache {
+    /**
+     * Creates a TempoCache instance which caches `ILazy.value` for a specified time.
+     *
+     * Note a limitation: calling `reset` (or changing the stored value directly in other way) on `lazy` will not affect the value cached by `TempoCache` instance.
+    */
+    function createFromLazy<T>(lazy: ILazy<T>, lifetimeMs: number): TempoCache<T>;
+    /**
+     * Creates a TempoCache instance which caches `ILazyPromise.promise` for a specified time.
+     *
+     * Note a limitation: calling `reset` (or changing the stored value directly in other way) on `lazy` will not affect the value cached by `TempoCache` instance.
+    */
+    function createFromLazyPromise<T>(lazy: ILazyPromise<T>, lifetimeMs: number): TempoCache<Promise<T>>;
+}

package/types/types/arrays.d.ts

@@ -0,0 +1,3 @@
+export declare function nonNullable<T>(value: T): value is NonNullable<T>;
+export type Truthy<T> = T extends false | '' | 0 | null | undefined ? never : T;
+export declare function truthy<T>(value: T): value is Truthy<T>;

package/types/types/comparator.d.ts

@@ -0,0 +1,4 @@
+export type Comparator<T, C = boolean> = (v1: T, v2: T) => C;
+export declare namespace Comparator {
+    const Default: Comparator<any>;
+}

package/types/types/deep.d.ts

@@ -0,0 +1,25 @@
+import { AnyFunction } from './misc';
+export type DeepReadonly<T> = T extends Array<infer U> ? ReadonlyArray<DeepReadonly<U>> : (T extends AnyFunction ? T : (T extends object ? {
+    readonly [P in keyof T]: DeepReadonly<T[P]>;
+} : T));
+export type DeepMutable<T> = T extends ReadonlyArray<infer U> ? Array<DeepMutable<U>> : (T extends AnyFunction ? T : (T extends object ? {
+    -readonly [P in keyof T]: DeepMutable<T[P]>;
+} : T));
+export type DeepReadonlyPartial<T> = T extends Array<infer U> ? ReadonlyArray<DeepReadonlyPartial<U>> : (T extends AnyFunction ? T : (T extends object ? {
+    readonly [P in keyof T]?: DeepReadonlyPartial<T[P]>;
+} : T));
+export type DeepPartial<T> = T extends Array<infer U> ? Array<DeepPartial<U>> : (T extends AnyFunction ? T : (T extends object ? {
+    [P in keyof T]?: DeepPartial<T[P]>;
+} : T));
+export type DeepRequired<T> = T extends Array<infer U> ? Array<DeepRequired<U>> : (T extends AnyFunction ? T : (T extends object ? {
+    [P in keyof T]-?: DeepRequired<T[P]>;
+} : T));
+export type DeepPickNullable<T, K extends keyof T> = {
+    [P in K]?: null | undefined | DeepPartialNullable<T[P]>;
+};
+export type DeepNullable<T> = T extends Array<infer U> ? Array<DeepNullable<U>> : (T extends AnyFunction ? T : (T extends object ? {
+    [P in keyof T]: null | DeepNullable<T[P]>;
+} : T));
+export type DeepPartialNullable<T> = T extends object ? {
+    [P in keyof T]?: null | undefined | DeepPartialNullable<T[P]>;
+} : (T extends Array<infer U> ? Array<DeepPartialNullable<U>> : T);

package/types/types/functions.d.ts

@@ -0,0 +1,15 @@
+import { AnyFunction } from './misc';
+export type TypedFn<A extends unknown[], R> = (...args: A) => R;
+export type Asyncify<T> = {
+    [P in keyof T]: T[P] extends TypedFn<unknown[], Promise<unknown>> ? T[P] : (T[P] extends TypedFn<infer A, infer R> ? (...args: A) => Promise<R> : T[P]);
+};
+export type Awaitify<T> = {
+    [P in keyof T]: T[P] extends TypedFn<infer A, Promise<infer R>> ? (...args: A) => R : T[P];
+};
+export type PropertiesOf<T> = Exclude<{
+    [K in keyof T]: T[K] extends AnyFunction ? never : K;
+}[keyof T], undefined>;
+export type RemoveFunctionFields<T> = {
+    readonly [P in PropertiesOf<T>]: T[P];
+};
+export type RemoveFirstParameter<T> = T extends (a: any, ...args: infer A) => infer R ? (...args: A) => R : T;

package/types/types/getter.d.ts

@@ -0,0 +1,9 @@
+type Fn<T> = () => T;
+export type Getter<T> = Fn<T> | T;
+export declare namespace Getter {
+    /** @deprecated use {@link toValue} instead */
+    function getValue<T>(getter: Getter<T>): T;
+    function toValue<T>(getter: Getter<T>): T;
+    function toFn<T>(getter: Getter<T>): Fn<T>;
+}
+export {};

package/types/types/ident.d.ts

@@ -0,0 +1,5 @@
+export type Ident<T, K extends keyof any = string> = T & {
+    id: K;
+};
+export type IdentAny = Ident<object>;
+export default Ident;

package/types/types/index.d.ts

@@ -0,0 +1,4 @@
+export * from './deep';
+export * from './getter';
+export * from './comparator';
+export * from './misc';

package/types/types/misc.d.ts

@@ -0,0 +1,37 @@
+export type Predicate<T> = (value: T) => boolean;
+/** Type for extracting only string keys from T (skips number & symbol keys) */
+export type StringKeys<T extends AnyObject> = {
+    [K in keyof T]: K extends string ? K : never;
+}[keyof T];
+/** Type for extracting string keys of type `T` values of each are of certain type `K` */
+export type TypedKeys<T extends AnyObject, K> = {
+    [P in StringKeys<T>]: T[P] extends K ? P : never;
+}[StringKeys<T>];
+/** Type for extraction only keys, values of which are functions with certain args and return result */
+export type FunctionKeys<T extends AnyObject, TArgs extends any[] = any[], TRes = any> = TypedKeys<T, (...args: TArgs) => TRes>;
+export type ArrayTail<T> = T extends [any, ...infer P] ? [...P] : T;
+export type NestedPick<T, K extends ReadonlyArray<any>> = K extends ReadonlyArray<never> ? T : {
+    [P in K[0]]: P extends keyof T ? NestedPick<T[P], ArrayTail<K>> : never;
+};
+export type Mutable<T> = {
+    -readonly [P in keyof T]: T[P];
+};
+export type LengthArray<T, N extends number, R extends T[] = []> = number extends N ? T[] : (R['length'] extends N ? R : LengthArray<T, N, [T, ...R]>);
+export type EmptyArray = [] & {
+    length: 0;
+};
+export type NonEmptyArray<T = any> = T[] & {
+    0: T;
+};
+export type AnyObject = Record<string, any>;
+export type EmptyObject = Record<PropertyKey, never>;
+export type AnyFunction = (...args: any[]) => any;
+export type Primitive = number | string | symbol | boolean | null | undefined | bigint;
+export type ObjectOrPrimitive = AnyObject | Primitive;
+export type ToPlainObject<T> = T extends (AnyFunction | Primitive) ? never : (T extends AnyObject ? T : never);
+export type Nullable<T> = T | null | undefined;
+export type PickNullable<T, K extends keyof T> = {
+    [P in K]?: Nullable<T[P]>;
+};
+export type EmptyObjectNullable = (EmptyObject | null | undefined);
+export type Coalesce<T, TReplace = EmptyObjectNullable> = [T] extends [never] | [null] | [undefined] ? TReplace : T;

package/types/validation/ValidationErrors.d.ts

@@ -0,0 +1,25 @@
+import EnumHelper from '../structures/helpers/enum';
+export declare enum ValidationErrors {
+    None = 0,
+    ShouldBeNonEmpty = 1,
+    ShouldBeEqualTo = 2,
+    InvalidFormat = 3,
+    Inconsistent = 4,
+    InvalidNameFormat = 5,
+    InvalidEmailFormat = 6,
+    InvalidPasswordFormat = 7,
+    OnlyEnglishLetters = 8,
+    InvalidPhoneFormat = 9,
+    InvalidCreditCardFormat = 10,
+    InvalidCreditCardExpiryDateFormat = 11,
+    InvalidCreditCardCvvFormat = 12,
+    OnlyDigit = 13,
+    EmailIsInUse = 14,
+    FirstName = 15,
+    LastName = 16,
+    Website = 17,
+    Linkedin = 18
+}
+export declare namespace ValidationErrors {
+    const Helper: EnumHelper<ValidationErrors>;
+}

package/types/validation/creditCard.d.ts

@@ -0,0 +1,8 @@
+declare function getDigitsCount(val: string): number;
+declare function getType(cardNumber: string): string;
+declare const _default: {
+    DEFAULT: string;
+    getDigitsCount: typeof getDigitsCount;
+    getType: typeof getType;
+};
+export default _default;

package/types/validation/emails.d.ts

@@ -0,0 +1,3 @@
+export declare function prepareEmail(email: string): string;
+export declare function prepareEmail(email: '' | null | undefined): null;
+export declare function prepareEmail(email: string | null | undefined): string | null;

package/types/validation/helpers.d.ts

@@ -0,0 +1,10 @@
+import { AnyObject } from '../types';
+import { ValidationErrors } from './ValidationErrors';
+import { ValidationConfig, ValidationResults, ValidationVoid, ValidatorFunction, ValidatorFunctionAsync } from './types';
+export declare function createShouldBeEqualTo<T = string>(getter: () => T): ValidatorFunction<T>;
+export declare function throwNotOk(result: ValidationErrors, message?: string): void;
+export declare function validateObject<T extends AnyObject, TErrors = ValidationErrors>(obj: T, validators: ValidationConfig<T, TErrors>, onlyTruthy?: boolean, context?: T): ValidationResults<T, TErrors>;
+export declare function combineValidators<T = string, TErrors = ValidationErrors, TContext = any>(...validators: ValidatorFunction<T, TErrors, TContext>[]): (val: T, ctx?: TContext) => ValidationErrors.None | NonNullable<TErrors>;
+export declare function combineValidatorsAsync<T = string, TErrors = ValidationErrors, TContext = any>(...validators: ValidatorFunctionAsync<T, TErrors, TContext>[]): Promise<(val: T, ctx?: TContext) => Promise<ValidationErrors.None | NonNullable<Awaited<TErrors>>>>;
+export declare function IsSomeInvalid(validatables: ReadonlyArray<ValidationVoid>, stopOnFail?: boolean): Promise<boolean>;
+export declare function getFirstValidationError(...validatables: ValidationVoid[]): Promise<string | null | undefined>;

package/types/validation/index.d.ts

@@ -0,0 +1,5 @@
+export * from './ValidationErrors';
+export * from './types';
+export * from './validators';
+export * from './wrappers';
+export * from './helpers';

package/types/validation/throwers.d.ts

@@ -0,0 +1,14 @@
+/** A validation method that is not tied to ValidationErrors but instead should just throw an Error with error messages */
+export type ValidationThrower<T> = (value: T) => Promise<void> | void;
+export declare namespace ValidationThrower {
+    function isValid<T>(value: T, validator: ValidationThrower<T>): Promise<boolean>;
+}
+export interface ValidationGenericLike<T> {
+    validate(value: T): Promise<unknown>;
+}
+export type ValidatorsSchema = Record<string, ValidationGenericLike<any>>;
+export type ValidatorThrowers<T extends ValidatorsSchema> = {
+    [P in (string & keyof T)]: T[P] extends ValidationGenericLike<infer K> ? ValidationThrower<K> : never;
+};
+export declare function createThrower<T>(schema: ValidationGenericLike<T>): ValidationThrower<T>;
+export declare function createThrowers<T extends ValidatorsSchema>(validators: T): ValidatorThrowers<T>;

package/types/validation/types.d.ts

@@ -0,0 +1,18 @@
+import { ValidationErrors } from './ValidationErrors';
+export type ValidatorFunction<T = string, TErrors = ValidationErrors, TContext = any> = (val: T, ctx?: TContext) => TErrors;
+export type ValidatorFunctionAsync<T = string, TErrors = ValidationErrors, TContext = any> = (val: T, ctx?: TContext) => Promise<TErrors>;
+export type ValidationConfig<T, TErrors> = {
+    [P in keyof T]?: ValidatorFunction<T[P], TErrors, T>;
+};
+export type ValidationResults<T, TErrors> = {
+    [P in keyof T]?: TErrors;
+};
+export type WrapperFunction = (val: ValidatorFunction) => ValidatorFunction;
+export declare class ValidationError<TErrors = ValidationErrors> extends Error {
+    readonly code: TErrors;
+    constructor(message: string, code: TErrors);
+}
+export interface ValidationVoid {
+    readonly error?: string | null | undefined;
+    validate(): Promise<boolean>;
+}

package/types/validation/validators.d.ts

@@ -0,0 +1,30 @@
+import { ValidationErrors } from './ValidationErrors';
+export declare const ValidatorsRegExps: {
+    name: RegExp;
+    englishLetters: RegExp;
+    email: RegExp;
+    password: RegExp;
+    phoneNumber: RegExp;
+    onlyDigit: RegExp;
+    creditCardNumber: RegExp;
+    expiryDateCard: RegExp;
+    cvv: RegExp;
+    website: RegExp;
+    linkedin: RegExp;
+};
+export declare const Validators: {
+    notEmpty: <T = string>(val: T) => ValidationErrors.None | ValidationErrors.ShouldBeNonEmpty;
+    firstName: <T = string>(val: T) => ValidationErrors.None | ValidationErrors.FirstName;
+    lastName: <T = string>(val: T) => ValidationErrors.None | ValidationErrors.LastName;
+    fullName: (val: string) => ValidationErrors.None | ValidationErrors.InvalidNameFormat;
+    onlyEnglish: (val: string) => ValidationErrors.None | ValidationErrors.OnlyEnglishLetters;
+    email: (val: string) => ValidationErrors.None | ValidationErrors.InvalidEmailFormat;
+    password: (val: string) => ValidationErrors.None | ValidationErrors.InvalidPasswordFormat;
+    onlyDigit: (val: string) => ValidationErrors.None | ValidationErrors.OnlyDigit;
+    creditCardNumber: (val: string) => ValidationErrors.None | ValidationErrors.InvalidCreditCardFormat;
+    creditCardExpiryDate: (val: string) => ValidationErrors.None | ValidationErrors.InvalidCreditCardExpiryDateFormat;
+    creditCardCvv: (val: string) => ValidationErrors.None | ValidationErrors.InvalidCreditCardCvvFormat;
+    website: (val: string) => ValidationErrors.None | ValidationErrors.Website;
+    linkedin: (val: string) => ValidationErrors.None | ValidationErrors.Linkedin;
+    regex: (regex: RegExp) => (val: string) => ValidationErrors.None | ValidationErrors.InvalidFormat;
+};

package/types/validation/wrappers.d.ts

@@ -0,0 +1,6 @@
+import { ValidatorFunction } from './types';
+export declare const Wrappers: {
+    required<T = string>(validator: ValidatorFunction<T>): ValidatorFunction<T>;
+    notRequired<T = string>(validator: ValidatorFunction<T>): ValidatorFunction<T>;
+    thrower<T = string>(validator: ValidatorFunction<T>): (val: T) => void;
+};

package/api/call.d.ts

@@ -1,36 +0,0 @@
-import { AnyObject } from '../types';
-import { IEndpointInfo } from './endpoint';
-import { EndpointMethods } from './methods';
-import { LogTypes } from './logging';
-/** Request options to be used by call implementation (e.g. interceptor). Passed as separate object argument to the call method.  */
-type Extra<T> = {
-    headers?: IEndpointInfo.ExtractHeaders<T>;
-    log?: LogTypes<IEndpointInfo.ExtractIn<T>, IEndpointInfo.ExtractOut<T>>;
-    noLoader?: boolean;
-};
-export type RequestConfig<TIn> = {
-    method: EndpointMethods | string & Record<never, never>;
-    url: string;
-    data: TIn | null | undefined;
-    headers: AnyObject;
-};
-/** Compiled request config object passed to `request` implementation */
-export type RequestConfigDetails<T extends IEndpointInfo = IEndpointInfo, TIn = IEndpointInfo.ExtractIn<T>, TExtra extends object = Record<string, any>> = RequestConfig<TIn> & {
-    _api: T;
-    _noLoader?: boolean;
-    _log?: LogTypes;
-    /** Additional data passed to the request implementation */
-    _extra?: TExtra;
-};
-type CallerOptions<TExtra extends object = Record<string, any>> = {
-    /** Additional hook before hading request config to implementation */
-    bodyValidation?: (api: IEndpointInfo, input: any) => Promise<void>;
-    /** Request implementation */
-    request: <TIn, TOut>(config: RequestConfigDetails<IEndpointInfo, TIn, TExtra>) => Promise<{
-        data: TOut;
-    }>;
-};
-export type EndpointCallArgs<T extends IEndpointInfo> = IEndpointInfo.ExtractIn<T> | IEndpointInfo.ExtractPath<T> | IEndpointInfo.ExtractQuery<T>;
-export declare function buildApiCaller<TExtra extends object = Record<string, any>>(options: CallerOptions<TExtra>): <T extends IEndpointInfo>(api: T, data: EndpointCallArgs<T>, extra?: Extra<T> & TExtra) => Promise<IEndpointInfo.ExtractOut<T>>;
-export {};
-//# sourceMappingURL=call.d.ts.map

package/api/call.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"call.d.ts","sourceRoot":"","sources":["../../src/api/call.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAGrC,oIAAoI;AACpI,KAAK,KAAK,CAAC,CAAC,IAAI;IACZ,OAAO,CAAC,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IAC1C,GAAG,CAAC,EAAE,QAAQ,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,aAAa,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;IACxE,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,aAAa,CAAC,GAAG,IAAI;IAC7B,MAAM,EAAE,eAAe,GAAG,MAAM,GAAG,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACxD,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,GAAG,GAAG,IAAI,GAAG,SAAS,CAAC;IAC7B,OAAO,EAAE,SAAS,CAAC;CACtB,CAAC;AAEF,wEAAwE;AACxE,MAAM,MAAM,oBAAoB,CAC5B,CAAC,SAAS,aAAa,GAAG,aAAa,EACvC,GAAG,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,EAChC,MAAM,SAAS,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAC3C,aAAa,CAAC,GAAG,CAAC,GAAG;IACrB,IAAI,EAAE,CAAC,CAAC;IACR,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,2DAA2D;IAC3D,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,KAAK,aAAa,CAAC,MAAM,SAAS,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI;IAC9D,qEAAqE;IACrE,cAAc,CAAC,EAAE,CAAC,GAAG,EAAE,aAAa,EAAE,KAAK,EAAE,GAAG,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnE,6BAA6B;IAC7B,OAAO,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,oBAAoB,CAAC,aAAa,EAAE,GAAG,EAAE,MAAM,CAAC,KAAK,OAAO,CAAC;QAAE,IAAI,EAAE,IAAI,CAAA;KAAE,CAAC,CAAC;CAC7G,CAAC;AAEF,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,aAAa,IAAI,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;AAElJ,wBAAgB,cAAc,CAAC,MAAM,SAAS,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,kCAK7F,CAAC,QACA,iBAAiB,CAAC,CAAC,UACjB,MAAM,CAAC,CAAC,GAAG,MAAM,0CAwEhC"}

package/api/call.js

@@ -1,62 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildApiCaller = void 0;
-const register_1 = require("./register");
-const helpers_1 = require("./helpers");
-function buildApiCaller(options) {
-    const { bodyValidation, request } = options;
-    return async function callApi(api, data, extra) {
-        const { headers, log = 'res', noLoader, ...restExtra } = extra || {};
-        const resultInput = data && { ...data };
-        const pathInputs = {};
-        let queryStr = '';
-        const pathKeys = api.pathBuilder.args;
-        if (resultInput && pathKeys?.length) {
-            for (const key of pathKeys) {
-                pathInputs[key] = resultInput[key];
-                delete resultInput[key];
-            }
-        }
-        const queryKeysExpected = api.queryKeys;
-        if (resultInput && queryKeysExpected?.length) {
-            const queryInputs = {};
-            let empty = true;
-            for (const key of queryKeysExpected) {
-                const v = resultInput[key];
-                if (v != null) {
-                    queryInputs[key] = v;
-                    empty = false;
-                }
-                delete resultInput[key];
-            }
-            if (!empty) {
-                const params = new URLSearchParams(queryInputs);
-                queryStr = '?' + params.toString();
-            }
-        }
-        if (resultInput && bodyValidation) {
-            await bodyValidation(api, resultInput);
-        }
-        const sendingData = resultInput && Object.keys(resultInput).length > 0
-            ? resultInput
-            : undefined;
-        const method = api.method || 'GET';
-        const config = {
-            method,
-            url: (0, helpers_1.getPath)(api, pathInputs) + queryStr,
-            data: register_1.PreProcessors.process(api, sendingData) || undefined,
-            headers: headers || {},
-            _api: api,
-            _noLoader: noLoader ?? method === 'GET',
-            _log: log,
-            _extra: restExtra,
-        };
-        if (api.isForm) {
-            config.headers['Content-Type'] = 'multipart/form-data';
-        }
-        const response = await request(config);
-        return register_1.PostProcessors.process(api, response.data);
-    };
-}
-exports.buildApiCaller = buildApiCaller;
-//# sourceMappingURL=call.js.map

package/api/call.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"call.js","sourceRoot":"","sources":["../../src/api/call.ts"],"names":[],"mappings":";;;AAAA,yCAA2D;AAK3D,uCAAoC;AAuCpC,SAAgB,cAAc,CAA8C,OAA8B;IAEtG,MAAM,EAAE,cAAc,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;IAE5C,OAAO,KAAK,UAAU,OAAO,CACzB,GAAM,EACN,IAAyB,EACzB,KAAyB;QAMzB,MAAM,EACF,OAAO,EACP,GAAG,GAAG,KAAK,EACX,QAAQ,EACR,GAAG,SAAS,EACf,GAAG,KAAK,IAAI,EAAE,CAAC;QAEhB,MAAM,WAAW,GAAG,IAAI,IAAI,EAAE,GAAG,IAAI,EAAS,CAAC;QAC/C,MAAM,UAAU,GAAoC,EAAE,CAAC;QACvD,IAAI,QAAQ,GAAW,EAAE,CAAC;QAE1B,MAAM,QAAQ,GAAG,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC;QACtC,IAAI,WAAW,IAAI,QAAQ,EAAE,MAAM,EAAE,CAAC;YAClC,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;gBACzB,UAAU,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;gBACnC,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC;YAC5B,CAAC;QACL,CAAC;QAED,MAAM,iBAAiB,GAAG,GAAG,CAAC,SAAS,CAAC;QACxC,IAAI,WAAW,IAAI,iBAAiB,EAAE,MAAM,EAAE,CAAC;YAC3C,MAAM,WAAW,GAAc,EAAE,CAAC;YAClC,IAAI,KAAK,GAAG,IAAI,CAAC;YACjB,KAAK,MAAM,GAAG,IAAI,iBAAiB,EAAE,CAAC;gBAClC,MAAM,CAAC,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;gBAC3B,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC;oBACZ,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;oBACrB,KAAK,GAAG,KAAK,CAAC;gBAClB,CAAC;gBACD,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC;YAC5B,CAAC;YAED,IAAI,CAAC,KAAK,EAAE,CAAC;gBACT,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,WAAW,CAAC,CAAC;gBAChD,QAAQ,GAAG,GAAG,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC;YACvC,CAAC;QACL,CAAC;QAED,IAAI,WAAW,IAAI,cAAc,EAAE,CAAC;YAChC,MAAM,cAAc,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;QAC3C,CAAC;QAED,MAAM,WAAW,GAAG,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,MAAM,GAAG,CAAC;YAClE,CAAC,CAAC,WAAW;YACb,CAAC,CAAC,SAAS,CAAC;QAEhB,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,IAAI,KAAK,CAAC;QACnC,MAAM,MAAM,GAAyC;YACjD,MAAM;YACN,GAAG,EAAE,IAAA,iBAAO,EAAC,GAAG,EAAE,UAA0C,CAAC,GAAG,QAAQ;YACxE,IAAI,EAAE,wBAAa,CAAC,OAAO,CAAC,GAAG,EAAE,WAAW,CAAC,IAAI,SAAS;YAC1D,OAAO,EAAE,OAAoB,IAAI,EAAE;YACnC,IAAI,EAAE,GAAG;YAET,SAAS,EAAE,QAAQ,IAAI,MAAgB,KAAK,KAAK;YACjD,IAAI,EAAE,GAAG;YACT,MAAM,EAAE,SAAmB;SAC9B,CAAC;QAEF,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;YACb,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,qBAAqB,CAAC;QAC3D,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,MAAM,CAAmB,CAAC;QACzD,OAAO,yBAAc,CAAC,OAAO,CAAC,GAAG,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;IACtD,CAAC,CAAC;AACN,CAAC;AA/ED,wCA+EC"}

package/api/endpoint.d.ts

@@ -1,39 +0,0 @@
-import { AnyObject } from '../types';
-import { Path } from '../structures/path';
-import { EndpointMethods } from './methods';
-import { IEndpointInfo } from './endpoint.types';
-export type { IEndpointInfo };
-export declare class ApiEndpoint<TIn extends object | null, TOut, TPath extends readonly string[], TQuery extends object, TErrors, THeaders> implements IEndpointInfo, IEndpointInfo.IIn<TIn>, IEndpointInfo.IOut<TOut>, IEndpointInfo.IPath<TPath>, IEndpointInfo.IQuery<TQuery>, IEndpointInfo.IErrors<TErrors>, IEndpointInfo.IHeaders<THeaders> {
-    method: EndpointMethods;
-    path: Path.SwitchBuilder<TPath>;
-    isForm?: boolean;
-    displayName?: string;
-    in?: TIn;
-    out?: TOut;
-    queryKeys?: (string & keyof TQuery)[];
-    queryTemplate?: TQuery;
-    errorProcessor?: (err: TErrors) => void;
-    headers?: THeaders;
-    get pathBuilder(): Path.IBuilder;
-    static construct<TIn extends object | null, TOut>(method?: EndpointMethods, displayName?: string): ApiEndpoint<TIn, TOut, readonly [], object, any, AnyObject>;
-    /** Creates an instance and applies 'GET' method for it. */
-    static get<TOut>(displayName?: string): ApiEndpoint<null, TOut, readonly [], object, any, AnyObject>;
-    /** Creates an instance and applies 'POST' method for it. */
-    static post<TIn extends object | null, TOut = void>(displayName?: string): ApiEndpoint<TIn, TOut, readonly [], object, any, AnyObject>;
-    /** Creates an instance and applies 'DELETE' method for it. */
-    static delete<TOut>(displayName?: string): ApiEndpoint<null, TOut, readonly [], object, any, AnyObject>;
-    /** Applies a type based on {@link Path.IBuilder} type by accepting arguments for {@link Path.construct} function */
-    withPath<P extends Path.BaseInput[]>(...path: P): ApiEndpoint<TIn, TOut, Path.ExtractArgs<Path.CombineBuilders<P>>, TQuery, TErrors, THeaders>;
-    /** Applies query type and also store query keys to make api caller be able to distinguish which keys should be ejected from request body. */
-    withQuery<TQ extends object>(...queryKeys: (string & keyof TQ)[]): ApiEndpoint<TIn, TOut, TPath, TQ, TErrors, THeaders>;
-    /** Applies error type, optionally stores error processor. */
-    withErrors<TErr>(errorProcessor?: (err: TErr) => void): ApiEndpoint<TIn, TOut, TPath, TQuery, TErr, THeaders>;
-    /** Applies headers type. */
-    withHeaders<THeads>(_headersMarker?: THeads): ApiEndpoint<TIn, TOut, TPath, TQuery, TErrors, THeads>;
-    /** Marks this instance as one has to be sent as form.
-     *
-     * TODO: introduce more content types support.
-     */
-    asForm(): this;
-}
-//# sourceMappingURL=endpoint.d.ts.map

package/api/endpoint.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"endpoint.d.ts","sourceRoot":"","sources":["../../src/api/endpoint.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AACrC,OAAO,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AAC1C,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAC5C,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEjD,YAAY,EAAE,aAAa,EAAE,CAAC;AAE9B,qBAAa,WAAW,CACpB,GAAG,SAAS,MAAM,GAAG,IAAI,EACzB,IAAI,EACJ,KAAK,SAAS,SAAS,MAAM,EAAE,EAC/B,MAAM,SAAS,MAAM,EACrB,OAAO,EACP,QAAQ,CACV,YACF,aAAa,EACb,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,EACtB,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,EACxB,aAAa,CAAC,KAAK,CAAC,KAAK,CAAC,EAC1B,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,EAC5B,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC,EAC9B,aAAa,CAAC,QAAQ,CAAC,QAAQ,CAAC;IAE5B,MAAM,EAAE,eAAe,CAAuB;IAC9C,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAA0B;IAEzD,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,EAAE,CAAC,EAAE,GAAG,CAAC;IACT,GAAG,CAAC,EAAE,IAAI,CAAC;IACX,SAAS,CAAC,EAAE,CAAC,MAAM,GAAG,MAAM,MAAM,CAAC,EAAE,CAAC;IACtC,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB,cAAc,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,IAAI,CAAC;IACxC,OAAO,CAAC,EAAE,QAAQ,CAAC;IAEnB,IAAW,WAAW,kBAA4C;IAElE,MAAM,CAAC,SAAS,CAAC,GAAG,SAAS,MAAM,GAAG,IAAI,EAAE,IAAI,EAAE,MAAM,GAAE,eAAqC,EAAE,WAAW,CAAC,EAAE,MAAM;IAOrH,2DAA2D;IAC3D,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,WAAW,CAAC,EAAE,MAAM;IAIrC,4DAA4D;IAC5D,MAAM,CAAC,IAAI,CAAC,GAAG,SAAS,MAAM,GAAG,IAAI,EAAE,IAAI,GAAG,IAAI,EAAE,WAAW,CAAC,EAAE,MAAM;IAIxE,8DAA8D;IAC9D,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,EAAE,MAAM;IAIxC,oHAAoH;IAC7G,QAAQ,CAAC,CAAC,SAAS,IAAI,CAAC,SAAS,EAAE,EAAE,GAAG,IAAI,EAAE,CAAC,GAAG,WAAW,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC;IASrJ,6IAA6I;IACtI,SAAS,CAAC,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,EAAE,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC,EAAE,GAAG,WAAW,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,QAAQ,CAAC;IAM9H,6DAA6D;IACtD,UAAU,CAAC,IAAI,EAAE,cAAc,CAAC,EAAE,CAAC,GAAG,EAAE,IAAI,KAAK,IAAI,GAAG,WAAW,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC;IAMpH,4BAA4B;IACrB,WAAW,CAAC,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC;IAI3G;;;OAGG;IACI,MAAM;CAIhB"}

package/api/endpoint.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"endpoint.js","sourceRoot":"","sources":["../../src/api/endpoint.ts"],"names":[],"mappings":";;;AACA,6CAA0C;AAC1C,uCAA4C;AAK5C,MAAa,WAAW;IAgBpB,MAAM,GAAoB,yBAAe,CAAC,GAAG,CAAC;IAC9C,IAAI,GAA8B,WAAI,CAAC,KAAK,CAAC,EAAE,EAAS,CAAC;IAEzD,MAAM,CAAW;IACjB,WAAW,CAAU;IAErB,EAAE,CAAO;IACT,GAAG,CAAQ;IACX,SAAS,CAA6B;IACtC,aAAa,CAAU;IAEvB,cAAc,CAA0B;IACxC,OAAO,CAAY;IAEnB,IAAW,WAAW,KAAK,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,EAAiB,CAAC,CAAC,CAAC;IAElE,MAAM,CAAC,SAAS,CAAkC,SAA0B,yBAAe,CAAC,GAAG,EAAE,WAAoB;QACjH,MAAM,GAAG,GAAG,IAAI,WAAW,EAAkD,CAAC;QAC9E,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC;QACpB,GAAG,CAAC,WAAW,GAAG,WAAW,CAAC;QAC9B,OAAO,GAAG,CAAC;IACf,CAAC;IAED,2DAA2D;IAC3D,MAAM,CAAC,GAAG,CAAO,WAAoB;QACjC,OAAO,WAAW,CAAC,SAAS,CAAa,yBAAe,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;IAC/E,CAAC;IAED,4DAA4D;IAC5D,MAAM,CAAC,IAAI,CAAyC,WAAoB;QACpE,OAAO,WAAW,CAAC,SAAS,CAAY,yBAAe,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IAC/E,CAAC;IAED,8DAA8D;IAC9D,MAAM,CAAC,MAAM,CAAO,WAAoB;QACpC,OAAO,WAAW,CAAC,SAAS,CAAa,yBAAe,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAClF,CAAC;IAED,oHAAoH;IAC7G,QAAQ,CAA6B,GAAG,IAAO;QAGlD,MAAM,GAAG,GAAG,IAA0E,CAAC;QACvF,MAAM,CAAC,GAAG,WAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC;QAClC,GAAG,CAAC,IAAI,GAAG,CAAwC,CAAC;QACpD,OAAO,GAAG,CAAC;IACf,CAAC;IAED,6IAA6I;IACtI,SAAS,CAAoB,GAAG,SAAgC;QACnE,MAAM,GAAG,GAAG,IAAuE,CAAC;QACpF,GAAG,CAAC,SAAS,GAAG,SAAS,CAAC;QAC1B,OAAO,GAAG,CAAC;IACf,CAAC;IAED,6DAA6D;IACtD,UAAU,CAAO,cAAoC;QACxD,MAAM,GAAG,GAAG,IAAwE,CAAC;QACrF,GAAG,CAAC,cAAc,GAAG,cAAc,CAAC;QACpC,OAAO,GAAG,CAAC;IACf,CAAC;IAED,4BAA4B;IACrB,WAAW,CAAS,cAAuB;QAC9C,OAAO,IAAyE,CAAC;IACrF,CAAC;IAED;;;OAGG;IACI,MAAM;QACT,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;QACnB,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AA3FD,kCA2FC"}