@cyberskill/shared 1.6.0 → 1.7.0

package/dist/typescript/mongoose.d.ts

@@ -1,163 +0,0 @@
-import { Db, InsertOneResult, InsertManyResult, Filter, WithId, UpdateResult, DeleteResult, Collection, OptionalUnlessRequiredId } from 'mongodb';
-import mongoose, { Document, Model, PaginateModel, AggregatePaginateModel, FilterQuery, ProjectionType, QueryOptions, PopulateOptions, PaginateOptions, PopulateOption, PaginateResult, PipelineStage, AggregatePaginateResult, InsertManyOptions, UpdateQuery, ClientSession, QueryWithHelpers, Schema, SchemaDefinition } from 'mongoose';
-
-declare class C_Model extends Model {
-}
-declare class C_Db extends Db {
-}
-declare class C_Document extends Document {
-}
-declare class C_Collection<D extends Partial<C_Document>> extends Collection<D> {
-}
-interface I_GenericDocument extends Partial<C_Document> {
-    id?: string;
-    isDel?: boolean;
-    createdAt?: Date;
-    updatedAt?: Date;
-}
-interface I_VirtualNestedOptions {
-    [key: string]: I_VirtualNestedOptions | number | string | boolean;
-}
-interface I_HookNextFunction {
-    (error?: Error | null): void;
-}
-type T_MiddlewareContext<T> = T | QueryWithHelpers<T, T>;
-interface I_VirtualOptions {
-    ref: string;
-    localField: string;
-    foreignField: string;
-    count?: boolean;
-    justOne?: boolean;
-    options?: I_VirtualNestedOptions;
-}
-interface I_MongooseOptions<D extends Partial<C_Document>> {
-    mongoose: typeof mongoose;
-    virtuals?: {
-        name: keyof D | string;
-        options?: I_VirtualOptions;
-        get?: (this: D) => void;
-    }[];
-}
-type T_MongooseShema<D> = mongoose.Schema<D>;
-type T_MongoosePlugin = (schema: Schema, options?: Record<string, unknown>) => void;
-type T_Input_MongooseSchema<D> = SchemaDefinition<D>;
-interface I_GenerateSchemaOptions<D extends Partial<C_Document>> extends I_MongooseOptions<D> {
-    schema: T_Input_MongooseSchema<D>;
-    standalone?: boolean;
-}
-type T_MongooseModelMiddlewareFunction = (this: T_MiddlewareContext<C_Document>, next: I_HookNextFunction) => void;
-interface I_MongooseModelMiddleware {
-    method: string;
-    fn: T_MongooseModelMiddlewareFunction;
-}
-interface I_GenerateModelOptions<D extends Partial<C_Document>> extends I_MongooseOptions<D> {
-    schema: T_Input_MongooseSchema<D>;
-    name: string;
-    aggregate?: boolean;
-    middlewares?: I_MongooseModelMiddleware[];
-    pagination?: boolean;
-}
-interface I_ExtendedModel<D extends Partial<C_Document>> extends Model<D>, PaginateModel<D>, AggregatePaginateModel<D> {
-}
-interface I_ReturnSuccess<D, E = {}> {
-    success: true;
-    result: D & E;
-    message?: string;
-    code?: number | string;
-}
-interface I_ReturnFailure {
-    success: false;
-    message: string;
-    code: number | string;
-}
-type I_Return<D = void, E = {}> = I_ReturnSuccess<D, E> | I_ReturnFailure;
-type T_Filter<D> = Filter<D>;
-type T_InsertOneResult<D> = InsertOneResult<D>;
-type T_InsertManyResult<D> = InsertManyResult<D>;
-type T_FilterQuery<T> = FilterQuery<T>;
-type T_ProjectionType<T> = ProjectionType<T>;
-type T_QueryOptions<T> = QueryOptions<T>;
-type T_PaginateOptions = PaginateOptions;
-type T_PopulateOption = PopulateOption;
-type T_PopulateOptions = PopulateOptions;
-type T_PipelineStage = PipelineStage;
-type T_PaginateResult<T> = PaginateResult<T>;
-type T_AggregatePaginateResult<T> = AggregatePaginateResult<T>;
-type T_InsertManyOptions = InsertManyOptions;
-type T_UpdateQuery<T> = UpdateQuery<T>;
-type T_UpdateResult = UpdateResult;
-type T_DeleteResult = DeleteResult;
-type T_WithId<T> = WithId<T>;
-type T_OptionalUnlessRequiredId<T> = OptionalUnlessRequiredId<T>;
-type T_Input_Populate = string | string[] | T_PopulateOptions | T_PopulateOptions[];
-interface T_PaginateOptionsWithPopulate extends T_PaginateOptions, T_PopulateOption {
-}
-type T_GenerateSlugQueryResponse<D> = T_FilterQuery<D> & {
-    $or: Array<{
-        slug: string;
-    } | {
-        slugHistory: string;
-    }>;
-} & {
-    id?: {
-        $ne: string;
-    };
-};
-interface I_Input_FindOne<T> extends T_PopulateOption {
-    filter: T_FilterQuery<T>;
-    projection?: T_ProjectionType<T>;
-    options?: T_QueryOptions<T>;
-}
-interface I_Input_FindAll<T> extends T_PopulateOption {
-    filter: T_FilterQuery<T>;
-    projection?: T_ProjectionType<T>;
-    options?: T_QueryOptions<T>;
-}
-interface I_Input_FindPaging<T> {
-    filter?: T_FilterQuery<T>;
-    options?: T_PaginateOptionsWithPopulate;
-}
-interface I_Input_FindPagingAggregate {
-    pipeline: T_PipelineStage[];
-    options?: T_PaginateOptionsWithPopulate;
-}
-interface I_Input_CreateOne<T> {
-    doc: T;
-}
-interface I_Input_CreateMany<T> {
-    docs: T[];
-}
-interface I_Input_UpdateOne<T> extends T_PopulateOption {
-    filter: T_FilterQuery<T>;
-    update: T_UpdateQuery<T>;
-    options?: I_UpdateOptionsExtended;
-}
-interface I_Input_UpdateMany<T> extends T_PopulateOption {
-    filter: T_FilterQuery<T>;
-    update: T_UpdateQuery<T>;
-    options?: I_UpdateOptionsExtended;
-}
-interface I_Input_DeleteOne<T> {
-    filter: T_FilterQuery<T>;
-    options?: I_DeleteOptionsExtended;
-}
-interface I_Input_DeleteMany<T> {
-    filter: T_FilterQuery<T>;
-    options?: I_DeleteOptionsExtended;
-}
-interface I_UpdateOptionsExtended extends Omit<QueryOptions, 'session'> {
-    session?: ClientSession;
-}
-interface I_DeleteOptionsExtended extends Omit<QueryOptions, 'session'> {
-    session?: ClientSession;
-}
-interface I_SlugifyOptions {
-    replacement?: string;
-    remove?: RegExp;
-    lower?: boolean;
-    strict?: boolean;
-    locale?: string;
-    trim?: boolean;
-}
-
-export { C_Collection, C_Db, C_Document, C_Model, type I_DeleteOptionsExtended, type I_ExtendedModel, type I_GenerateModelOptions, type I_GenerateSchemaOptions, type I_GenericDocument, type I_HookNextFunction, type I_Input_CreateMany, type I_Input_CreateOne, type I_Input_DeleteMany, type I_Input_DeleteOne, type I_Input_FindAll, type I_Input_FindOne, type I_Input_FindPaging, type I_Input_FindPagingAggregate, type I_Input_UpdateMany, type I_Input_UpdateOne, type I_MongooseModelMiddleware, type I_MongooseOptions, type I_Return, type I_ReturnFailure, type I_ReturnSuccess, type I_SlugifyOptions, type I_UpdateOptionsExtended, type T_AggregatePaginateResult, type T_DeleteResult, type T_Filter, type T_FilterQuery, type T_GenerateSlugQueryResponse, type T_Input_MongooseSchema, type T_Input_Populate, type T_InsertManyOptions, type T_InsertManyResult, type T_InsertOneResult, type T_MiddlewareContext, type T_MongooseModelMiddlewareFunction, type T_MongoosePlugin, type T_MongooseShema, type T_OptionalUnlessRequiredId, type T_PaginateOptions, type T_PaginateOptionsWithPopulate, type T_PaginateResult, type T_PipelineStage, type T_PopulateOption, type T_PopulateOptions, type T_ProjectionType, type T_QueryOptions, type T_UpdateQuery, type T_UpdateResult, type T_WithId };

package/dist/typescript/react.d.cts

@@ -1,26 +0,0 @@
-import { ApolloClientOptions, ApolloCache } from '@apollo/client';
-import { ReactNode, ReactElement, JSX } from 'react';
-
-type T_Children = ReactNode | ReactNode[] | ReactElement | JSX.Element | null;
-interface I_ApolloOptions extends Omit<ApolloClientOptions<unknown>, 'cache'> {
-    cache?: ApolloCache<unknown>;
-    url?: string;
-}
-interface I_GraphqlCodegenConfig {
-    uri: string;
-    from: string;
-    to: string;
-    withComponent?: boolean;
-    withHOC?: boolean;
-    withHooks?: boolean;
-    withMutationFn?: boolean;
-    withRefetchFn?: boolean;
-}
-interface I_LoadingContext {
-    isLoading: boolean;
-    isGlobalLoading: boolean;
-    showLoading: (global?: boolean) => void;
-    hideLoading: () => void;
-}
-
-export type { I_ApolloOptions, I_GraphqlCodegenConfig, I_LoadingContext, T_Children };

package/dist/typescript/react.d.ts

@@ -1,26 +0,0 @@
-import { ApolloClientOptions, ApolloCache } from '@apollo/client';
-import { ReactNode, ReactElement, JSX } from 'react';
-
-type T_Children = ReactNode | ReactNode[] | ReactElement | JSX.Element | null;
-interface I_ApolloOptions extends Omit<ApolloClientOptions<unknown>, 'cache'> {
-    cache?: ApolloCache<unknown>;
-    url?: string;
-}
-interface I_GraphqlCodegenConfig {
-    uri: string;
-    from: string;
-    to: string;
-    withComponent?: boolean;
-    withHOC?: boolean;
-    withHooks?: boolean;
-    withMutationFn?: boolean;
-    withRefetchFn?: boolean;
-}
-interface I_LoadingContext {
-    isLoading: boolean;
-    isGlobalLoading: boolean;
-    showLoading: (global?: boolean) => void;
-    hideLoading: () => void;
-}
-
-export type { I_ApolloOptions, I_GraphqlCodegenConfig, I_LoadingContext, T_Children };

package/dist/typescript/serializer.d.cts

@@ -1,6 +0,0 @@
-interface Serializer<T> {
-    serialize: (value: T) => string;
-    deserialize: (value: string) => T;
-}
-
-export type { Serializer };

package/dist/typescript/serializer.d.ts

@@ -1,6 +0,0 @@
-interface Serializer<T> {
-    serialize: (value: T) => string;
-    deserialize: (value: string) => T;
-}
-
-export type { Serializer };

package/dist/utils/index.d.cts

@@ -1,19 +0,0 @@
-import { I_Config } from '../typescript/config.cjs';
-export { localStorage } from './localStorage.cjs';
-export { throwResponse } from './log.cjs';
-export { generateModel, generateSchema, generateShortId, generateSlug, generateSlugQuery } from './mongoose.cjs';
-export { serializer } from './serializer.cjs';
-export { validate } from './validate.cjs';
-export { default as aggregatePaginate } from 'mongoose-aggregate-paginate-v2';
-export { default as mongoosePaginate } from 'mongoose-paginate-v2';
-import '../typescript/log.cjs';
-import '../typescript/mongoose.cjs';
-import 'mongodb';
-import 'mongoose';
-
-declare function deepMerge(...configs: (I_Config | I_Config[])[]): I_Config;
-declare function isJson(str: string): boolean;
-declare function regexSearchMapper(str: string): string;
-declare const removeAccent: (str: string) => string;
-
-export { deepMerge, isJson, regexSearchMapper, removeAccent };

package/dist/utils/index.d.ts

@@ -1,19 +0,0 @@
-import { I_Config } from '../typescript/config.js';
-export { localStorage } from './localStorage.js';
-export { throwResponse } from './log.js';
-export { generateModel, generateSchema, generateShortId, generateSlug, generateSlugQuery } from './mongoose.js';
-export { serializer } from './serializer.js';
-export { validate } from './validate.js';
-export { default as aggregatePaginate } from 'mongoose-aggregate-paginate-v2';
-export { default as mongoosePaginate } from 'mongoose-paginate-v2';
-import '../typescript/log.js';
-import '../typescript/mongoose.js';
-import 'mongodb';
-import 'mongoose';
-
-declare function deepMerge(...configs: (I_Config | I_Config[])[]): I_Config;
-declare function isJson(str: string): boolean;
-declare function regexSearchMapper(str: string): string;
-declare const removeAccent: (str: string) => string;
-
-export { deepMerge, isJson, regexSearchMapper, removeAccent };

package/dist/utils/localStorage.d.cts

@@ -1,50 +0,0 @@
-declare const localStorage: {
-    /**
-     * Get the value of a key.
-     * @param key The key to retrieve.
-     * @returns A promise that resolves to the value associated with the key, or `null` if the key doesn't exist.
-     */
-    get<T = unknown>(key: string): Promise<T | null>;
-    /**
-     * Set the value for a key.
-     * @param key The key to set.
-     * @param value The value to store. Can be any serializable type.
-     * @returns A promise that resolves once the value is stored.
-     */
-    set<T = unknown>(key: string, value: T): Promise<void>;
-    /**
-     * Remove the value associated with a key.
-     * @param key The key to remove.
-     * @returns A promise that resolves once the key is removed.
-     */
-    remove(key: string): Promise<void>;
-    /**
-     * Clear all keys and values in the storage.
-     * @returns A promise that resolves once the storage is cleared.
-     */
-    clear(): Promise<void>;
-    /**
-     * Get the name of the key at a specific index.
-     * @param index The index of the key.
-     * @returns A promise that resolves to the key name or `null` if the index is out of bounds.
-     */
-    key(index: number): Promise<string | null>;
-    /**
-     * Get all keys in the storage.
-     * @returns A promise that resolves to an array of all keys.
-     */
-    keys(): Promise<string[]>;
-    /**
-     * Get the number of items in the storage.
-     * @returns A promise that resolves to the number of keys stored.
-     */
-    length(): Promise<number>;
-    /**
-     * Iterates over all key-value pairs in the storage.
-     * @param iteratee A callback function that receives the value, key, and iteration number.
-     * @returns A promise that resolves once iteration is complete.
-     */
-    iterate<T = unknown>(iteratee: (value: T, key: string, iterationNumber: number) => void): Promise<void>;
-};
-
-export { localStorage };

package/dist/utils/localStorage.d.ts

@@ -1,50 +0,0 @@
-declare const localStorage: {
-    /**
-     * Get the value of a key.
-     * @param key The key to retrieve.
-     * @returns A promise that resolves to the value associated with the key, or `null` if the key doesn't exist.
-     */
-    get<T = unknown>(key: string): Promise<T | null>;
-    /**
-     * Set the value for a key.
-     * @param key The key to set.
-     * @param value The value to store. Can be any serializable type.
-     * @returns A promise that resolves once the value is stored.
-     */
-    set<T = unknown>(key: string, value: T): Promise<void>;
-    /**
-     * Remove the value associated with a key.
-     * @param key The key to remove.
-     * @returns A promise that resolves once the key is removed.
-     */
-    remove(key: string): Promise<void>;
-    /**
-     * Clear all keys and values in the storage.
-     * @returns A promise that resolves once the storage is cleared.
-     */
-    clear(): Promise<void>;
-    /**
-     * Get the name of the key at a specific index.
-     * @param index The index of the key.
-     * @returns A promise that resolves to the key name or `null` if the index is out of bounds.
-     */
-    key(index: number): Promise<string | null>;
-    /**
-     * Get all keys in the storage.
-     * @returns A promise that resolves to an array of all keys.
-     */
-    keys(): Promise<string[]>;
-    /**
-     * Get the number of items in the storage.
-     * @returns A promise that resolves to the number of keys stored.
-     */
-    length(): Promise<number>;
-    /**
-     * Iterates over all key-value pairs in the storage.
-     * @param iteratee A callback function that receives the value, key, and iteration number.
-     * @returns A promise that resolves once iteration is complete.
-     */
-    iterate<T = unknown>(iteratee: (value: T, key: string, iterationNumber: number) => void): Promise<void>;
-};
-
-export { localStorage };

package/dist/utils/log.d.cts

@@ -1,5 +0,0 @@
-import { T_ThrowResponseArgs } from '../typescript/log.cjs';
-
-declare function throwResponse({ message, status, type, }: T_ThrowResponseArgs): never;
-
-export { throwResponse };

package/dist/utils/log.d.ts

@@ -1,5 +0,0 @@
-import { T_ThrowResponseArgs } from '../typescript/log.js';
-
-declare function throwResponse({ message, status, type, }: T_ThrowResponseArgs): never;
-
-export { throwResponse };

package/dist/utils/mongoose.d.cts

@@ -1,34 +0,0 @@
-export { default as aggregatePaginate } from 'mongoose-aggregate-paginate-v2';
-export { default as mongoosePaginate } from 'mongoose-paginate-v2';
-import { C_Document, I_GenerateSchemaOptions, T_MongooseShema, I_GenerateModelOptions, I_ExtendedModel, I_SlugifyOptions, T_FilterQuery, T_GenerateSlugQueryResponse } from '../typescript/mongoose.cjs';
-import 'mongodb';
-import 'mongoose';
-
-/**
- * Generate a mongoose schema with optional virtuals and generic fields.
- * @param options - Schema generation options.
- * @param options.mongoose - The mongoose instance.
- * @param options.schema - The schema definition.
- * @param options.virtuals - List of virtual fields.
- * @param options.standalone - Whether to include generic fields.
- * @returns Enhanced schema.
- */
-declare function generateSchema<D extends Partial<C_Document>>({ mongoose, schema, virtuals, standalone, }: I_GenerateSchemaOptions<D>): T_MongooseShema<D>;
-/**
- * Generate a mongoose model with optional pagination, aggregation, and middleware.
- * @param options - Model generation options.
- * @param options.mongoose - The mongoose instance.
- * @param options.name - The name of the model.
- * @param options.schema - The schema definition.
- * @param options.pagination - Whether to enable pagination plugin.
- * @param options.aggregate - Whether to enable aggregate pagination plugin.
- * @param options.virtuals - List of virtual fields.
- * @param options.middlewares - Middleware functions to add.
- * @returns Mongoose model.
- */
-declare function generateModel<D extends Partial<C_Document>>({ mongoose, name, schema, pagination, aggregate, virtuals, middlewares, }: I_GenerateModelOptions<D>): I_ExtendedModel<D>;
-declare function generateSlug(str?: string, options?: I_SlugifyOptions): string;
-declare function generateShortId(uuid: string, length?: number): string;
-declare function generateSlugQuery<D>(slug: string, filters?: T_FilterQuery<D>, id?: string): T_GenerateSlugQueryResponse<D>;
-
-export { generateModel, generateSchema, generateShortId, generateSlug, generateSlugQuery };

package/dist/utils/mongoose.d.ts

@@ -1,34 +0,0 @@
-export { default as aggregatePaginate } from 'mongoose-aggregate-paginate-v2';
-export { default as mongoosePaginate } from 'mongoose-paginate-v2';
-import { C_Document, I_GenerateSchemaOptions, T_MongooseShema, I_GenerateModelOptions, I_ExtendedModel, I_SlugifyOptions, T_FilterQuery, T_GenerateSlugQueryResponse } from '../typescript/mongoose.js';
-import 'mongodb';
-import 'mongoose';
-
-/**
- * Generate a mongoose schema with optional virtuals and generic fields.
- * @param options - Schema generation options.
- * @param options.mongoose - The mongoose instance.
- * @param options.schema - The schema definition.
- * @param options.virtuals - List of virtual fields.
- * @param options.standalone - Whether to include generic fields.
- * @returns Enhanced schema.
- */
-declare function generateSchema<D extends Partial<C_Document>>({ mongoose, schema, virtuals, standalone, }: I_GenerateSchemaOptions<D>): T_MongooseShema<D>;
-/**
- * Generate a mongoose model with optional pagination, aggregation, and middleware.
- * @param options - Model generation options.
- * @param options.mongoose - The mongoose instance.
- * @param options.name - The name of the model.
- * @param options.schema - The schema definition.
- * @param options.pagination - Whether to enable pagination plugin.
- * @param options.aggregate - Whether to enable aggregate pagination plugin.
- * @param options.virtuals - List of virtual fields.
- * @param options.middlewares - Middleware functions to add.
- * @returns Mongoose model.
- */
-declare function generateModel<D extends Partial<C_Document>>({ mongoose, name, schema, pagination, aggregate, virtuals, middlewares, }: I_GenerateModelOptions<D>): I_ExtendedModel<D>;
-declare function generateSlug(str?: string, options?: I_SlugifyOptions): string;
-declare function generateShortId(uuid: string, length?: number): string;
-declare function generateSlugQuery<D>(slug: string, filters?: T_FilterQuery<D>, id?: string): T_GenerateSlugQueryResponse<D>;
-
-export { generateModel, generateSchema, generateShortId, generateSlug, generateSlugQuery };

package/dist/utils/serializer.d.cts

@@ -1,7 +0,0 @@
-interface Serializer<T> {
-    serialize: (value: T) => string;
-    deserialize: (value: string) => T;
-}
-declare const serializer: Serializer<any>;
-
-export { serializer };

package/dist/utils/serializer.d.ts

@@ -1,7 +0,0 @@
-interface Serializer<T> {
-    serialize: (value: T) => string;
-    deserialize: (value: string) => T;
-}
-declare const serializer: Serializer<any>;
-
-export { serializer };

package/dist/utils/validate.d.cts

@@ -1,33 +0,0 @@
-declare const validate: {
-    common: {
-        /**
-         * Check if a value is empty (null, undefined, empty string, empty array, or empty object).
-         * @param {unknown} value - The value to check.
-         * @returns {boolean} - True if the value is empty; otherwise, false.
-         */
-        isEmpty(value: unknown): boolean;
-        /**
-         * Validator to check if a value is not empty.
-         * @returns {(value: unknown) => Promise<boolean>} - The validation function.
-         */
-        isEmptyValidator<T>(): (this: T, value: unknown) => Promise<boolean>;
-        /**
-         * Validator to check if a value is unique in specified fields.
-         * @param {string[]} fields - Fields to check for uniqueness.
-         * @returns {(value: unknown) => Promise<boolean>} - The validation function.
-         */
-        isUniqueValidator<T extends {
-            constructor: {
-                findOne: (query: Record<string, unknown>) => Promise<unknown>;
-            };
-        }>(fields: string[]): (this: T, value: unknown) => Promise<boolean>;
-        /**
-         * Validator to check if a value matches all regex patterns in an array.
-         * @param {RegExp[]} regexArray - Array of regex patterns.
-         * @returns {(value: string) => Promise<boolean>} - The validation function.
-         */
-        matchesRegexValidator(regexArray: RegExp[]): (value: string) => Promise<boolean>;
-    };
-};
-
-export { validate };

package/dist/utils/validate.d.ts

@@ -1,33 +0,0 @@
-declare const validate: {
-    common: {
-        /**
-         * Check if a value is empty (null, undefined, empty string, empty array, or empty object).
-         * @param {unknown} value - The value to check.
-         * @returns {boolean} - True if the value is empty; otherwise, false.
-         */
-        isEmpty(value: unknown): boolean;
-        /**
-         * Validator to check if a value is not empty.
-         * @returns {(value: unknown) => Promise<boolean>} - The validation function.
-         */
-        isEmptyValidator<T>(): (this: T, value: unknown) => Promise<boolean>;
-        /**
-         * Validator to check if a value is unique in specified fields.
-         * @param {string[]} fields - Fields to check for uniqueness.
-         * @returns {(value: unknown) => Promise<boolean>} - The validation function.
-         */
-        isUniqueValidator<T extends {
-            constructor: {
-                findOne: (query: Record<string, unknown>) => Promise<unknown>;
-            };
-        }>(fields: string[]): (this: T, value: unknown) => Promise<boolean>;
-        /**
-         * Validator to check if a value matches all regex patterns in an array.
-         * @param {RegExp[]} regexArray - Array of regex patterns.
-         * @returns {(value: string) => Promise<boolean>} - The validation function.
-         */
-        matchesRegexValidator(regexArray: RegExp[]): (value: string) => Promise<boolean>;
-    };
-};
-
-export { validate };