powerlines 0.42.41 → 0.43.0

package/dist/storage/index.d.cts

@@ -1,419 +0,0 @@
-import { t as types_d_exports } from "../types-DerAvFjs.cjs";
-import { MaybePromise } from "@stryke/types/base";
-import { writeFile, writeFileSync } from "@stryke/fs/write-file";
-
-//#region src/storage/base.d.ts
-interface StorageAdapterOptions {
-  base: string;
-  isReadOnly?: boolean;
-  ignore?: string | string[];
-}
-/**
- * Abstract base class for storage adapters, providing a template for storage operations.
- */
-declare abstract class BaseStorageAdapter<TOptions extends StorageAdapterOptions = StorageAdapterOptions> implements types_d_exports.StorageAdapter {
-  #private;
-  protected context: types_d_exports.Context;
-  /**
-   * A name identifying the storage adapter type.
-   */
-  abstract name: string;
-  /**
-   * Configuration options for the storage adapter.
-   */
-  options: TOptions;
-  /**
-   * The storage preset for the adapter.
-   *
-   * @remarks
-   * This can be used as an alternate way to identify the type of storage being used.
-   */
-  readonly preset?: types_d_exports.StoragePreset | null;
-  /**
-   * Constructor for the BaseStorageAdapter.
-   *
-   * @param context - The Powerlines context.
-   * @param options - Configuration options for the storage adapter.
-   */
-  constructor(context: types_d_exports.Context, options?: TOptions);
-  /**
-   * Synchronously checks if a key exists in the storage.
-   *
-   * @param key - The key to check for existence.
-   * @returns Returns `true` if the key exists, otherwise `false`.
-   */
-  abstract existsSync(key: string): boolean;
-  /**
-   * Asynchronously checks if a key exists in the storage.
-   *
-   * @param key - The key to check for existence.
-   * @returns A promise that resolves to `true` if the key exists, otherwise `false`.
-   */
-  exists(key: string): Promise<boolean>;
-  /**
-   * Synchronously retrieves the value associated with a given key.
-   *
-   * @param key - The key whose value is to be retrieved.
-   * @returns The value associated with the key, or `null` if the key does not exist.
-   */
-  abstract getSync(key: string): string | null;
-  /**
-   * Asynchronously retrieves the value associated with a given key.
-   *
-   * @param key - The key whose value is to be retrieved.
-   * @returns A promise that resolves to the value associated with the key, or `null` if the key does not exist.
-   */
-  get(key: string): Promise<string | null>;
-  /**
-   * Synchronously sets the value for a given key.
-   *
-   * @param key - The key to set the value for.
-   * @param value - The value to set.
-   */
-  abstract setSync(key: string, value: string): void;
-  /**
-   * Asynchronously sets the value for a given key.
-   *
-   * @param key - The key to set the value for.
-   * @param value - The value to set.
-   */
-  set(key: string, value: string): Promise<void>;
-  /**
-   * Synchronously creates a directory at the specified path.
-   *
-   * @param _ - The path of the directory to create.
-   */
-  mkdirSync(_: string): void;
-  /**
-   * Creates a directory at the specified path.
-   *
-   * @param dirPath - The path of the directory to create.
-   */
-  mkdir(dirPath: string): Promise<void>;
-  /**
-   * Synchronously removes a key from the storage.
-   *
-   * @param key - The key to remove.
-   */
-  abstract removeSync(key: string): void;
-  /**
-   * Asynchronously removes a key from the storage.
-   *
-   * @param key - The key to remove.
-   */
-  remove(key: string): Promise<void>;
-  /**
-   * Synchronously removes all entries from the storage that match the provided base path.
-   *
-   * @param base - The base path to clear keys from.
-   */
-  clearSync(base?: string): void;
-  /**
-   * Asynchronously removes all entries from the storage that match the provided base path.
-   *
-   * @param base - The base path to clear keys from.
-   * @returns A promise that resolves when the operation is complete.
-   */
-  clear(base?: string): Promise<void>;
-  /**
-   * Lists all keys under a given base path synchronously.
-   *
-   * @param base - The base path to list keys from.
-   * @returns An array of keys under the specified base path.
-   */
-  abstract listSync(base?: string): string[];
-  /**
-   * Asynchronously lists all keys under a given base path.
-   *
-   * @param base - The base path to list keys from.
-   * @returns A promise that resolves to an array of keys under the specified base path.
-   */
-  list(base?: string): Promise<string[]>;
-  /**
-   * Synchronously checks if the given key is a directory.
-   *
-   * @param _ - The key to check.
-   * @returns `true` if the key is a directory, otherwise `false`.
-   */
-  isDirectorySync(_: string): boolean;
-  /**
-   * Checks if the given key is a directory.
-   *
-   * @param key - The key to check.
-   * @returns A promise that resolves to `true` if the key is a directory, otherwise `false`.
-   */
-  isDirectory(key: string): Promise<boolean>;
-  /**
-   * Synchronously checks if the given key is a file.
-   *
-   * @param key - The key to check.
-   * @returns `true` if the key is a file, otherwise `false`.
-   */
-  isFileSync(key: string): boolean;
-  /**
-   * Checks if the given key is a file.
-   *
-   * @param key - The key to check.
-   * @returns A promise that resolves to `true` if the key is a file, otherwise `false`.
-   */
-  isFile(key: string): Promise<boolean>;
-  /**
-   * Disposes of the storage adapter, releasing any held resources.
-   *
-   * @returns A promise that resolves when the disposal is complete.
-   */
-  dispose(): MaybePromise<void>;
-  /**
-   * Async dispose method to clean up resources.
-   *
-   * @returns A promise that resolves when disposal is complete.
-   */
-  [Symbol.asyncDispose](): Promise<void>;
-  /**
-   * Determines if the storage adapter is read-only based on the provided options.
-   *
-   * @returns `true` if the storage adapter is read-only, otherwise `false`.
-   */
-  protected get isReadOnly(): boolean;
-  /**
-   * Determines if the storage adapter should overwrite existing keys based on the provided options and context configuration.
-   *
-   * @returns `true` if the storage adapter should overwrite existing keys, otherwise `false`.
-   */
-  protected get overwrite(): boolean;
-  /**
-   * Resolves a given key to its full path within the storage adapter.
-   *
-   * @param key - The key to resolve.
-   * @returns The resolved full path for the key.
-   */
-  protected resolve(key?: string): string;
-  /**
-   * Disposes of the storage adapter, releasing any held resources.
-   *
-   * @returns A promise that resolves when the disposal is complete.
-   */
-  protected _dispose(): Promise<void>;
-}
-//#endregion
-//#region src/storage/file-system.d.ts
-type SetSyncOptions = Parameters<typeof writeFileSync>[2];
-type SetOptions = Parameters<typeof writeFile>[2];
-/**
- * File system storage adapter implementation.
- */
-declare class FileSystemStorageAdapter extends BaseStorageAdapter {
-  /**
-   * A name identifying the storage adapter type.
-   */
-  name: string;
-  /**
-   * The storage preset for the adapter.
-   *
-   * @remarks
-   * This can be used as an alternate way to identify the type of storage being used.
-   */
-  readonly preset = "fs";
-  /**
-   * Constructor for the FileSystemStorageAdapter.
-   *
-   * @param context - The Powerlines context.
-   * @param options - Configuration options for the storage adapter.
-   */
-  constructor(context: types_d_exports.Context, options?: StorageAdapterOptions);
-  /**
-   * Synchronously checks if a key exists in the storage.
-   *
-   * @param key - The key to check for existence.
-   * @returns Returns `true` if the key exists, otherwise `false`.
-   */
-  existsSync(key: string): boolean;
-  /**
-   * Asynchronously checks if a key exists in the storage.
-   *
-   * @param key - The key to check for existence.
-   * @returns A promise that resolves to `true` if the key exists, otherwise `false`.
-   */
-  exists(key: string): Promise<boolean>;
-  /**
-   * Synchronously retrieves the value associated with a given key.
-   *
-   * @param key - The key whose value is to be retrieved.
-   * @returns The value associated with the key, or `null` if the key does not exist.
-   */
-  getSync(key: string): string | null;
-  /**
-   * Asynchronously retrieves the value associated with a given key.
-   *
-   * @param key - The key whose value is to be retrieved.
-   * @returns A promise that resolves to the value associated with the key, or `null` if the key does not exist.
-   */
-  get(key: string): Promise<string | null>;
-  /**
-   * Synchronously sets the value for a given key.
-   *
-   * @param key - The key to set the value for.
-   * @param value - The value to set.
-   */
-  setSync(key: string, value: string): void;
-  /**
-   * Asynchronously sets the value for a given key.
-   *
-   * @param key - The key to set the value for.
-   * @param value - The value to set.
-   */
-  set(key: string, value: string): Promise<void>;
-  /**
-   * Synchronously removes a key from the storage.
-   *
-   * @param key - The key to remove.
-   */
-  removeSync(key: string): any;
-  /**
-   * Asynchronously removes a key from the storage.
-   *
-   * @param key - The key to remove.
-   */
-  remove(key: string): Promise<void>;
-  /**
-   * Synchronously creates a directory at the specified path.
-   *
-   * @param dirPath - The path of the directory to create.
-   */
-  mkdirSync(dirPath: string): void;
-  /**
-   * Creates a directory at the specified path.
-   *
-   * @param dirPath - The path of the directory to create.
-   */
-  mkdir(dirPath: string): Promise<void>;
-  /**
-   * Lists all keys under a given base path synchronously.
-   *
-   * @param base - The base path to list keys from.
-   * @returns An array of keys under the specified base path.
-   */
-  listSync(base?: string): string[];
-  /**
-   * Asynchronously lists all keys under a given base path.
-   *
-   * @param base - The base path to list keys from.
-   * @returns A promise that resolves to an array of keys under the specified base path.
-   */
-  list(base?: string): Promise<string[]>;
-  /**
-   * Synchronously checks if the given key is a directory.
-   *
-   * @param key - The key to check.
-   * @returns `true` if the key is a directory, otherwise `false`.
-   */
-  isDirectorySync(key: string): boolean;
-  /**
-   * Synchronously checks if the given key is a file.
-   *
-   * @param key - The key to check.
-   * @returns `true` if the key is a file, otherwise `false`.
-   */
-  isFileSync(key: string): boolean;
-}
-//#endregion
-//#region src/storage/helpers.d.ts
-/**
- * Checks if an error is a file system error.
- *
- * @param err - The error to check.
- * @returns `true` if the error is a file system error, otherwise `false`.
- */
-declare function isFileError(err: any): unknown;
-/**
- * Ignores file not found errors.
- *
- * @param err - The error to check.
- * @returns `null` if the error is a file not found error, otherwise returns the error.
- */
-declare function ignoreNotfound(err: any): any;
-/**
- * Ignores file exists errors.
- *
- * @param err - The error to check.
- * @returns `null` if the error is a file exists error, otherwise returns the error.
- */
-declare function ignoreExists(err: any): any;
-//#endregion
-//#region src/storage/virtual.d.ts
-/**
- * Virtual/in-memory storage adapter implementation.
- */
-declare class VirtualStorageAdapter extends BaseStorageAdapter {
-  /**
-   * A name identifying the storage adapter type.
-   */
-  name: string;
-  /**
-   * The storage preset for the adapter.
-   *
-   * @remarks
-   * This can be used as an alternate way to identify the type of storage being used.
-   */
-  readonly preset = "virtual";
-  /**
-   * In-memory data storage.
-   */
-  protected data: Map<string, any>;
-  /**
-   * Constructor for the VirtualStorageAdapter.
-   *
-   * @param context - The Powerlines context.
-   * @param options - Configuration options for the storage adapter.
-   */
-  constructor(context: types_d_exports.Context, options?: StorageAdapterOptions);
-  /**
-   * Synchronously checks if a key exists in the storage.
-   *
-   * @param key - The key to check for existence.
-   * @returns Returns `true` if the key exists, otherwise `false`.
-   */
-  existsSync(key: string): boolean;
-  /**
-   * Synchronously retrieves the value associated with a given key.
-   *
-   * @param key - The key whose value is to be retrieved.
-   * @returns The value associated with the key, or `null` if the key does not exist.
-   */
-  getSync(key: string): string | null;
-  /**
-   * Synchronously sets the value for a given key.
-   *
-   * @param key - The key to set the value for.
-   * @param value - The value to set.
-   */
-  setSync(key: string, value: string): void;
-  /**
-   * Synchronously removes a key from the storage.
-   *
-   * @param key - The key to remove.
-   */
-  removeSync(key: string): void;
-  /**
-   * Lists all keys under a given base path synchronously.
-   *
-   * @param base - The base path to list keys from.
-   * @returns An array of keys under the specified base path.
-   */
-  listSync(base?: string): string[];
-  /**
-   * Disposes of the storage adapter, releasing any held resources.
-   *
-   * @returns A promise that resolves when the disposal is complete.
-   */
-  dispose(): Promise<void>;
-  /**
-   * Determines if the storage adapter should overwrite existing keys based on the provided options and context configuration.
-   *
-   * @returns `true` if the storage adapter should overwrite existing keys, otherwise `false`.
-   */
-  protected get overwrite(): boolean;
-}
-//#endregion
-export { BaseStorageAdapter, FileSystemStorageAdapter, SetOptions, SetSyncOptions, StorageAdapterOptions, VirtualStorageAdapter, ignoreExists, ignoreNotfound, isFileError };
-//# sourceMappingURL=index.d.cts.map

package/dist/storage/index.d.cts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.cts","names":[],"sources":["../../src/storage/base.ts","../../src/storage/file-system.ts","../../src/storage/helpers.ts","../../src/storage/virtual.ts"],"mappings":";;;;;UAyBiB,qBAAA;EACf,IAAA;EACA,UAAA;EACA,MAAA;AAAA;;;;uBAMoB,kBAAA,kBACH,qBAAA,GAAwB,qBAAA,aAC9B,eAAA,CAAA,cAAA;EAAA;YA+BC,OAAA,EAAS,eAAA,CAAA,OAAA;EAvCf;AAMR;;EANQ,SAiBU,IAAA;EAVC;;;EAeV,OAAA,EAAS,QAAA;EAQS;;;;;;EAAA,SAAT,MAAA,GAAS,eAAA,CAAA,aAAA;EAqGS;;;;;;cA5FtB,OAAA,EAAS,eAAA,CAAA,OAAA,EACnB,OAAA,GAAS,QAAA;EAoNG;;;;;;EAAA,SAvME,UAAA,CAAW,GAAA;EA9Cc;;;;;;EAsD5B,MAAA,CAAO,GAAA,WAAc,OAAA;EAvClB;;;;;;EAAA,SAiDA,OAAA,CAAQ,GAAA;EA/BtB;;;;;;EAuCW,GAAA,CAAI,GAAA,WAAc,OAAA;EARP;;;;;;EAAA,SAkBR,OAAA,CAAQ,GAAA,UAAa,KAAA;EAQxB;;;;;;EAAA,GAAA,CAAI,GAAA,UAAa,KAAA,WAAgB,OAAA;EAkB3B;;;;;EAPZ,SAAA,CAAU,CAAA;EAuBiB;;;;;EAhBrB,KAAA,CAAM,OAAA,WAAkB,OAAA;EAuErB;;;;;EAAA,SA9DA,UAAA,CAAW,GAAA;EAgFJ;;;;;EAzEV,MAAA,CAAO,GAAA,WAAc,OAAA;EAuGrB;;;;;EA5FN,SAAA,CAAU,IAAA;EA8GI;;;;;;EAzFR,KAAA,CAAM,IAAA,YAAgB,OAAA;EAwIP;;;;;;EAAA,SAjHZ,QAAA,CAAS,IAAA;ECtLD;;;;AAC1B;;ED6Le,IAAA,CAAK,IAAA,YAAgB,OAAA;EC7LX;;AAKzB;;;;EDkMS,eAAA,CAAgB,CAAA;EC1JoB;;;;;;EDoK9B,WAAA,CAAY,GAAA,WAAW,OAAA;EC5M0B;;;;;;EDsNvD,UAAA,CAAW,GAAA;EClMC;;;;;;ED4MN,MAAA,CAAO,GAAA,WAAW,OAAA;ECxLY;;;;;EDiMpC,OAAA,CAAA,GAAW,YAAA;ECnKX;;;;;EAAA,CD4KO,MAAA,CAAO,YAAA,KAAa,OAAA;EC9IqB;;;;;EAAA,cDuJzC,UAAA,CAAA;EChGE;;;;;EAAA,cDyGF,SAAA,CAAA;ECtFE;;;;;;EAAA,UDgGN,OAAA,CAAQ,GAAA;ECxDS;;;;;EAAA,UD2EX,QAAA,CAAA,GAAY,OAAA;AAAA;;;KCvSlB,cAAA,GAAiB,UAAA,QAAkB,aAAA;AAAA,KACnC,UAAA,GAAa,UAAA,QAAkB,SAAA;ADR3C;;;AAAA,cCaa,wBAAA,SAAiC,kBAAA;EDZ5C;;;ECgBO,IAAA;EDdD;AAMR;;;;;EANQ,SCsBmB,MAAA;EDAT;;;;;;cCQG,OAAA,EAAS,eAAA,CAAA,OAAA,EAAS,OAAA,GAAU,qBAAA;EDqFV;;;;;;EC3E9B,UAAA,CAAW,GAAA;EDoNgB;;;;;;EC1MZ,MAAA,CAAO,GAAA,WAAc,OAAA;ED3C1B;;;;;;ECqDV,OAAA,CAAQ,GAAA;EDtCR;;;;;;ECgDe,GAAA,CAAI,GAAA,WAAc,OAAA;ED9B7B;;;;;;ECwCJ,OAAA,CAAQ,GAAA,UAAa,KAAA;EDTZ;;;;;;ECuCM,GAAA,CAAI,GAAA,UAAa,KAAA,WAAgB,OAAA;EDrBlB;;;;;ECkD9B,UAAA,CAAW,GAAA;ED/BD;;;;;EC8CK,MAAA,CAAO,GAAA,WAAc,OAAA;EDvB9B;;;;;ECkCG,SAAA,CAAU,OAAA;EDFP;;;;;ECWG,KAAA,CAAM,OAAA,WAAkB,OAAA;EDoBZ;;;;;;ECV3B,QAAA,CAAS,IAAA;EDwCE;;;;;;ECxBI,IAAA,CAAK,IAAA,YAAgB,OAAA;EDoDtB;;;;;;ECtCL,eAAA,CAAgB,GAAA;EDqFJ;;;;;;EC3EZ,UAAA,CAAW,GAAA;AAAA;;;;;;;;ADnO7B;iBECgB,WAAA,CAAY,GAAA;;;;;;;iBAUZ,cAAA,CAAe,GAAA;AFF/B;;;;;;AAAA,iBEegB,YAAA,CAAa,GAAA;;;;;;cCxBhB,qBAAA,SAA8B,kBAAA;EHAL;;;EGI7B,IAAA;EHFP;;;;AAOF;;EAPE,SGUyB,MAAA;EHFR;;;EAAA,UGOP,IAAA,EAAI,GAAA;EHgBW;;;;;;cGRN,OAAA,EAAS,eAAA,CAAA,OAAA,EAAS,OAAA,GAAU,qBAAA;EH6Gb;;;;;;EGnG3B,UAAA,CAAW,GAAA;EH4NJ;;;;;;EGlNP,OAAA,CAAQ,GAAA;EHnC0B;;;;;;EG6ClC,OAAA,CAAQ,GAAA,UAAa,KAAA;EH9BZ;;;;;EGyCT,UAAA,CAAW,GAAA;EHvBP;;;;;;EGmCJ,QAAA,CAAS,IAAA;EHJA;;;;;EGiBM,OAAA,CAAA,GAAW,OAAA;EHCT;;;;;EAAA,cGQD,SAAA,CAAA;AAAA"}