@cyberskill/shared 1.7.0 → 1.8.0

package/dist/index.d.cts

@@ -581,7 +581,7 @@ declare class MongooseController<D extends Partial<C_Document>> {
 
 declare function useLoading(): I_LoadingContext;
 
-declare function useLocalStorage<T>(key: string, initialValue: T, serializer?: Serializer$1<T>): readonly [T, (value: T | ((val: T) => T)) => Promise<void>];
+declare function useStorage<T>(key: string, initialValue: T, serializer?: Serializer$1<T>): readonly [T, (value: T | ((val: T) => T)) => Promise<void>];
 
 declare function ApolloProvider({ options, children }: {
     options: I_ApolloOptions;
@@ -593,7 +593,7 @@ declare function LoadingProvider({ children }: {
 }): react_jsx_runtime.JSX.Element;
 
 /**
- * Save the entire error list to local storage.
+ * Save the entire error list to storage.
  * @param errorList Array of I_ErrorEntry objects.
  */
 declare function saveErrorListToStorage(errorList: I_ErrorEntry[]): Promise<void>;
@@ -621,55 +621,6 @@ declare function logProcessStep(message: string, icon?: string): void;
 declare function parseCommandOutput(output: string): void;
 declare function executeCommand(command: string, description: string, parser?: typeof parseCommandOutput): Promise<void>;
 
-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>;
-};
-
 declare function throwResponse({ message, status, type, }: T_ThrowResponseArgs): never;
 
 /**
@@ -712,6 +663,7 @@ declare function isPackageOutdated(packageName: string, forceRefresh?: boolean):
  * @param packageName Name of the package.
  */
 declare function updatePackage(packageName: string): Promise<void>;
+declare function isCurrentProject(INIT_CWD: string, PACKAGE_NAME: string): boolean;
 
 interface Serializer<T> {
     serialize: (value: T) => string;
@@ -719,6 +671,53 @@ interface Serializer<T> {
 }
 declare const serializer: Serializer<any>;
 
+declare const storage: {
+    /**
+     * 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.
+     * @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>;
+    /**
+     * Get all keys in the storage.
+     * @returns A promise that resolves to an array of all keys.
+     */
+    keys(): Promise<string[]>;
+    /**
+     * Get all values in the storage.
+     * @returns A promise that resolves to an array of all values.
+     */
+    values<T = unknown>(): Promise<T[]>;
+    /**
+     * Get all entries in the storage as [key, value] tuples.
+     * @returns A promise that resolves to an array of entries.
+     */
+    entries<T = unknown>(): Promise<[string, T][]>;
+    /**
+     * Clear all keys and values in the storage.
+     * @returns A promise that resolves once the storage is cleared.
+     */
+    clear(): Promise<void>;
+    /**
+     * Get the number of items in the storage.
+     * @returns A promise that resolves to the number of keys stored.
+     */
+    length(): Promise<number>;
+};
+
 declare const validate: {
     common: {
         /**
@@ -756,4 +755,4 @@ declare function isJson(str: string): boolean;
 declare function regexSearchMapper(str: string): string;
 declare const removeAccent: (str: string) => string;
 
-export { ApolloProvider, C_Collection, C_Db, C_Document, C_Model, DIRNAME, E_ErrorType, E_SpinnerMessage, type I_ApolloOptions, type I_Config, type I_DeleteOptionsExtended, type I_ErrorEntry, type I_EslintError, type I_ExtendedModel, type I_GenerateModelOptions, type I_GenerateSchemaOptions, type I_GenericDocument, type I_GraphqlCodegenConfig, 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_LoadingContext, type I_LoadingProps, type I_MongooseModelMiddleware, type I_MongooseOptions, type I_Return, type I_ReturnFailure, type I_ReturnSuccess, type I_SlugifyOptions, type I_SpinnerOptions, type I_UpdateOptionsExtended, Loading, LoadingContext, LoadingProvider, MigrationController, MongooseController, RESPONSE_STATUS, type Serializer$1 as Serializer, type T_AggregatePaginateResult, type T_Children, 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_ThrowResponseArgs, type T_UpdateQuery, type T_UpdateResult, type T_WithId, clearExpiredErrorLists, deepMerge, displayResults, executeCommand, generateModel, generateSchema, generateShortId, generateSlug, generateSlugQuery, getLatestPackageVersion, getStoredErrorLists, isJson, isPackageOutdated, localStorage, logProcessStep, regexSearchMapper, removeAccent, runWithSpinner, saveErrorListToStorage, serializer, throwResponse, updatePackage, useLoading, useLocalStorage, validate };
+export { ApolloProvider, C_Collection, C_Db, C_Document, C_Model, DIRNAME, E_ErrorType, E_SpinnerMessage, type I_ApolloOptions, type I_Config, type I_DeleteOptionsExtended, type I_ErrorEntry, type I_EslintError, type I_ExtendedModel, type I_GenerateModelOptions, type I_GenerateSchemaOptions, type I_GenericDocument, type I_GraphqlCodegenConfig, 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_LoadingContext, type I_LoadingProps, type I_MongooseModelMiddleware, type I_MongooseOptions, type I_Return, type I_ReturnFailure, type I_ReturnSuccess, type I_SlugifyOptions, type I_SpinnerOptions, type I_UpdateOptionsExtended, Loading, LoadingContext, LoadingProvider, MigrationController, MongooseController, RESPONSE_STATUS, type Serializer$1 as Serializer, type T_AggregatePaginateResult, type T_Children, 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_ThrowResponseArgs, type T_UpdateQuery, type T_UpdateResult, type T_WithId, clearExpiredErrorLists, deepMerge, displayResults, executeCommand, generateModel, generateSchema, generateShortId, generateSlug, generateSlugQuery, getLatestPackageVersion, getStoredErrorLists, isCurrentProject, isJson, isPackageOutdated, logProcessStep, regexSearchMapper, removeAccent, runWithSpinner, saveErrorListToStorage, serializer, storage, throwResponse, updatePackage, useLoading, useStorage, validate };

package/dist/index.d.ts

@@ -581,7 +581,7 @@ declare class MongooseController<D extends Partial<C_Document>> {
 
 declare function useLoading(): I_LoadingContext;
 
-declare function useLocalStorage<T>(key: string, initialValue: T, serializer?: Serializer$1<T>): readonly [T, (value: T | ((val: T) => T)) => Promise<void>];
+declare function useStorage<T>(key: string, initialValue: T, serializer?: Serializer$1<T>): readonly [T, (value: T | ((val: T) => T)) => Promise<void>];
 
 declare function ApolloProvider({ options, children }: {
     options: I_ApolloOptions;
@@ -593,7 +593,7 @@ declare function LoadingProvider({ children }: {
 }): react_jsx_runtime.JSX.Element;
 
 /**
- * Save the entire error list to local storage.
+ * Save the entire error list to storage.
  * @param errorList Array of I_ErrorEntry objects.
  */
 declare function saveErrorListToStorage(errorList: I_ErrorEntry[]): Promise<void>;
@@ -621,55 +621,6 @@ declare function logProcessStep(message: string, icon?: string): void;
 declare function parseCommandOutput(output: string): void;
 declare function executeCommand(command: string, description: string, parser?: typeof parseCommandOutput): Promise<void>;
 
-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>;
-};
-
 declare function throwResponse({ message, status, type, }: T_ThrowResponseArgs): never;
 
 /**
@@ -712,6 +663,7 @@ declare function isPackageOutdated(packageName: string, forceRefresh?: boolean):
  * @param packageName Name of the package.
  */
 declare function updatePackage(packageName: string): Promise<void>;
+declare function isCurrentProject(INIT_CWD: string, PACKAGE_NAME: string): boolean;
 
 interface Serializer<T> {
     serialize: (value: T) => string;
@@ -719,6 +671,53 @@ interface Serializer<T> {
 }
 declare const serializer: Serializer<any>;
 
+declare const storage: {
+    /**
+     * 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.
+     * @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>;
+    /**
+     * Get all keys in the storage.
+     * @returns A promise that resolves to an array of all keys.
+     */
+    keys(): Promise<string[]>;
+    /**
+     * Get all values in the storage.
+     * @returns A promise that resolves to an array of all values.
+     */
+    values<T = unknown>(): Promise<T[]>;
+    /**
+     * Get all entries in the storage as [key, value] tuples.
+     * @returns A promise that resolves to an array of entries.
+     */
+    entries<T = unknown>(): Promise<[string, T][]>;
+    /**
+     * Clear all keys and values in the storage.
+     * @returns A promise that resolves once the storage is cleared.
+     */
+    clear(): Promise<void>;
+    /**
+     * Get the number of items in the storage.
+     * @returns A promise that resolves to the number of keys stored.
+     */
+    length(): Promise<number>;
+};
+
 declare const validate: {
     common: {
         /**
@@ -756,4 +755,4 @@ declare function isJson(str: string): boolean;
 declare function regexSearchMapper(str: string): string;
 declare const removeAccent: (str: string) => string;
 
-export { ApolloProvider, C_Collection, C_Db, C_Document, C_Model, DIRNAME, E_ErrorType, E_SpinnerMessage, type I_ApolloOptions, type I_Config, type I_DeleteOptionsExtended, type I_ErrorEntry, type I_EslintError, type I_ExtendedModel, type I_GenerateModelOptions, type I_GenerateSchemaOptions, type I_GenericDocument, type I_GraphqlCodegenConfig, 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_LoadingContext, type I_LoadingProps, type I_MongooseModelMiddleware, type I_MongooseOptions, type I_Return, type I_ReturnFailure, type I_ReturnSuccess, type I_SlugifyOptions, type I_SpinnerOptions, type I_UpdateOptionsExtended, Loading, LoadingContext, LoadingProvider, MigrationController, MongooseController, RESPONSE_STATUS, type Serializer$1 as Serializer, type T_AggregatePaginateResult, type T_Children, 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_ThrowResponseArgs, type T_UpdateQuery, type T_UpdateResult, type T_WithId, clearExpiredErrorLists, deepMerge, displayResults, executeCommand, generateModel, generateSchema, generateShortId, generateSlug, generateSlugQuery, getLatestPackageVersion, getStoredErrorLists, isJson, isPackageOutdated, localStorage, logProcessStep, regexSearchMapper, removeAccent, runWithSpinner, saveErrorListToStorage, serializer, throwResponse, updatePackage, useLoading, useLocalStorage, validate };
+export { ApolloProvider, C_Collection, C_Db, C_Document, C_Model, DIRNAME, E_ErrorType, E_SpinnerMessage, type I_ApolloOptions, type I_Config, type I_DeleteOptionsExtended, type I_ErrorEntry, type I_EslintError, type I_ExtendedModel, type I_GenerateModelOptions, type I_GenerateSchemaOptions, type I_GenericDocument, type I_GraphqlCodegenConfig, 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_LoadingContext, type I_LoadingProps, type I_MongooseModelMiddleware, type I_MongooseOptions, type I_Return, type I_ReturnFailure, type I_ReturnSuccess, type I_SlugifyOptions, type I_SpinnerOptions, type I_UpdateOptionsExtended, Loading, LoadingContext, LoadingProvider, MigrationController, MongooseController, RESPONSE_STATUS, type Serializer$1 as Serializer, type T_AggregatePaginateResult, type T_Children, 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_ThrowResponseArgs, type T_UpdateQuery, type T_UpdateResult, type T_WithId, clearExpiredErrorLists, deepMerge, displayResults, executeCommand, generateModel, generateSchema, generateShortId, generateSlug, generateSlugQuery, getLatestPackageVersion, getStoredErrorLists, isCurrentProject, isJson, isPackageOutdated, logProcessStep, regexSearchMapper, removeAccent, runWithSpinner, saveErrorListToStorage, serializer, storage, throwResponse, updatePackage, useLoading, useStorage, validate };