@powerlines/core 0.11.0 → 0.11.1

package/dist/storage/file-system.d.cts

@@ -0,0 +1,129 @@
+import { Context } from "../types/context.cjs";
+import { BaseStorageAdapter, StorageAdapterOptions } from "./base.cjs";
+import { writeFile, writeFileSync } from "@stryke/fs/write-file";
+
+//#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: 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;
+}
+declare type __ΩSetSyncOptions = any[];
+declare type __ΩSetOptions = any[];
+//#endregion
+export { FileSystemStorageAdapter, SetOptions, SetSyncOptions, __ΩSetOptions, __ΩSetSyncOptions };
+//# sourceMappingURL=file-system.d.cts.map

package/dist/storage/file-system.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-system.d.cts","names":[],"sources":["../../src/storage/file-system.ts"],"mappings":";;;;;KAgCY,cAAA,GAAiB,UAAA,QAAkB,aAAA;AAAA,KACnC,UAAA,GAAa,UAAA,QAAkB,SAAA;AAD3C;;;AAAA,cAMa,wBAAA,SAAiC,kBAAA;EANc;AAC5D;;EASS,IAAA;EATgB;;AAKzB;;;;EALyB,SAiBE,MAAA;EA4BkB;;;;;;cApBxB,OAAA,EAAS,OAAA,EAAS,OAAA,GAAU,qBAAA;EApBe;;;;;;EA8BvD,UAAA,CAAW,GAAA;EAVC;;;;;;EAoBG,MAAA,CAAO,GAAA,WAAc,OAAA;EAAA;;;;;;EAUpC,OAAA,CAAQ,GAAA;EAoBA;;;;;;EAVO,GAAA,CAAI,GAAA,WAAc,OAAA;EAuFtB;;;;;;EA7EX,OAAA,CAAQ,GAAA,UAAa,KAAA;EAgHA;;;;;;EAzEN,GAAA,CAAI,GAAA,UAAa,KAAA,WAAgB,OAAA;EAiHvC;;;;;EA3ET,UAAA,CAAW,GAAA;;;;;;EAeI,MAAA,CAAO,GAAA,WAAc,OAAA;;;;;;EAW3B,SAAA,CAAU,OAAA;;;;;;EASJ,KAAA,CAAM,OAAA,WAAkB,OAAA;;;;;;;EAUvC,QAAA,CAAS,IAAA;;;;;;;EAgBM,IAAA,CAAK,IAAA,YAAgB,OAAA;;;;;;;EAc3B,eAAA,CAAgB,GAAA;;;;;;;EAUhB,UAAA,CAAW,GAAA;AAAA;AAAA"}

package/dist/storage/file-system.d.mts

@@ -0,0 +1,129 @@
+import { Context } from "../types/context.mjs";
+import { BaseStorageAdapter, StorageAdapterOptions } from "./base.mjs";
+import { writeFile, writeFileSync } from "@stryke/fs/write-file";
+
+//#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: 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;
+}
+declare type __ΩSetSyncOptions = any[];
+declare type __ΩSetOptions = any[];
+//#endregion
+export { FileSystemStorageAdapter, SetOptions, SetSyncOptions, __ΩSetOptions, __ΩSetSyncOptions };
+//# sourceMappingURL=file-system.d.mts.map

package/dist/storage/file-system.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-system.d.mts","names":[],"sources":["../../src/storage/file-system.ts"],"mappings":";;;;;KAgCY,cAAA,GAAiB,UAAA,QAAkB,aAAA;AAAA,KACnC,UAAA,GAAa,UAAA,QAAkB,SAAA;AAD3C;;;AAAA,cAMa,wBAAA,SAAiC,kBAAA;EANc;AAC5D;;EASS,IAAA;EATgB;;AAKzB;;;;EALyB,SAiBE,MAAA;EA4BkB;;;;;;cApBxB,OAAA,EAAS,OAAA,EAAS,OAAA,GAAU,qBAAA;EApBe;;;;;;EA8BvD,UAAA,CAAW,GAAA;EAVC;;;;;;EAoBG,MAAA,CAAO,GAAA,WAAc,OAAA;EAAA;;;;;;EAUpC,OAAA,CAAQ,GAAA;EAoBA;;;;;;EAVO,GAAA,CAAI,GAAA,WAAc,OAAA;EAuFtB;;;;;;EA7EX,OAAA,CAAQ,GAAA,UAAa,KAAA;EAgHA;;;;;;EAzEN,GAAA,CAAI,GAAA,UAAa,KAAA,WAAgB,OAAA;EAiHvC;;;;;EA3ET,UAAA,CAAW,GAAA;;;;;;EAeI,MAAA,CAAO,GAAA,WAAc,OAAA;;;;;;EAW3B,SAAA,CAAU,OAAA;;;;;;EASJ,KAAA,CAAM,OAAA,WAAkB,OAAA;;;;;;;EAUvC,QAAA,CAAS,IAAA;;;;;;;EAgBM,IAAA,CAAK,IAAA,YAAgB,OAAA;;;;;;;EAc3B,eAAA,CAAgB,GAAA;;;;;;;EAUhB,UAAA,CAAW,GAAA;AAAA;AAAA"}

package/dist/storage/file-system.mjs

@@ -0,0 +1,179 @@
+import { getFileHeaderWarningText } from "../lib/utilities/file-header.mjs";
+import { BaseStorageAdapter } from "./base.mjs";
+import { ignoreNotfound } from "./helpers.mjs";
+import { exists, existsSync } from "@stryke/fs/exists";
+import { isDirectory, isFile } from "@stryke/fs/is-file";
+import { isSetString } from "@stryke/type-checks/is-set-string";
+import { listFiles, listFilesSync } from "@stryke/fs/list-files";
+import { unlinkSync } from "node:fs";
+import { readFile, readFileSync } from "@stryke/fs/read-file";
+import { writeFile, writeFileSync } from "@stryke/fs/write-file";
+import { createDirectory, createDirectorySync } from "@stryke/fs/helpers";
+import { unlink } from "node:fs/promises";
+
+//#region src/storage/file-system.ts
+/**
+* File system storage adapter implementation.
+*/
+var FileSystemStorageAdapter = class extends BaseStorageAdapter {
+	/**
+	* A name identifying the storage adapter type.
+	*/
+	name = "file-system";
+	/**
+	* The storage preset for the adapter.
+	*
+	* @remarks
+	* This can be used as an alternate way to identify the type of storage being used.
+	*/
+	preset = "fs";
+	/**
+	* Constructor for the FileSystemStorageAdapter.
+	*
+	* @param context - The Powerlines context.
+	* @param options - Configuration options for the storage adapter.
+	*/
+	constructor(context, options) {
+		super(context, options);
+	}
+	/**
+	* 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) {
+		return existsSync(this.resolve(key));
+	}
+	/**
+	* 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`.
+	*/
+	async exists(key) {
+		return exists(this.resolve(key));
+	}
+	/**
+	* 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) {
+		return readFileSync(this.resolve(key));
+	}
+	/**
+	* 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.
+	*/
+	async get(key) {
+		return readFile(this.resolve(key));
+	}
+	/**
+	* 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, value) {
+		if (!this.isReadOnly) if (this.existsSync(this.resolve(key)) && !this.overwrite) {
+			const existingValue = this.getSync(this.resolve(key));
+			if (isSetString(existingValue) && existingValue.includes(getFileHeaderWarningText(true, this.context.config.framework?.name || "powerlines"))) return writeFileSync(this.resolve(key), existingValue.replace(getFileHeaderWarningText(true, this.context.config.framework?.name || "powerlines"), getFileHeaderWarningText(false, this.context.config.framework?.name || "powerlines")));
+		} else return writeFileSync(this.resolve(key), value);
+	}
+	/**
+	* Asynchronously sets the value for a given key.
+	*
+	* @param key - The key to set the value for.
+	* @param value - The value to set.
+	*/
+	async set(key, value) {
+		if (!this.isReadOnly) if (this.existsSync(this.resolve(key)) && !this.overwrite) {
+			const existingValue = await this.get(this.resolve(key));
+			if (isSetString(existingValue) && existingValue.includes(getFileHeaderWarningText(true, this.context.config.framework?.name || "powerlines"))) return writeFile(this.resolve(key), existingValue.replace(getFileHeaderWarningText(true, this.context.config.framework?.name || "powerlines"), getFileHeaderWarningText(false, this.context.config.framework?.name || "powerlines")));
+		} else return writeFile(this.resolve(key), value);
+	}
+	/**
+	* Synchronously removes a key from the storage.
+	*
+	* @param key - The key to remove.
+	*/
+	removeSync(key) {
+		if (!this.isReadOnly && this.overwrite) try {
+			return unlinkSync(this.resolve(key));
+		} catch (err) {
+			return ignoreNotfound(err);
+		}
+	}
+	/**
+	* Asynchronously removes a key from the storage.
+	*
+	* @param key - The key to remove.
+	*/
+	async remove(key) {
+		if (!this.isReadOnly && this.overwrite) return unlink(this.resolve(key)).catch(ignoreNotfound);
+	}
+	/**
+	* Synchronously creates a directory at the specified path.
+	*
+	* @param dirPath - The path of the directory to create.
+	*/
+	mkdirSync(dirPath) {
+		createDirectorySync(this.resolve(dirPath));
+	}
+	/**
+	* Creates a directory at the specified path.
+	*
+	* @param dirPath - The path of the directory to create.
+	*/
+	async mkdir(dirPath) {
+		await createDirectory(this.resolve(dirPath));
+	}
+	/**
+	* 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) {
+		try {
+			return listFilesSync(this.resolve(base), { ignore: this.options.ignore });
+		} catch (err) {
+			return ignoreNotfound(err) ?? [];
+		}
+	}
+	/**
+	* 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.
+	*/
+	async list(base) {
+		return listFiles(this.resolve(base), { ignore: this.options.ignore }).catch(ignoreNotfound).then((r) => r || []);
+	}
+	/**
+	* 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) {
+		return isDirectory(this.resolve(key));
+	}
+	/**
+	* 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) {
+		return isFile(this.resolve(key));
+	}
+};
+
+//#endregion
+export { FileSystemStorageAdapter };
+//# sourceMappingURL=file-system.mjs.map

package/dist/storage/file-system.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-system.mjs","names":[],"sources":["../../src/storage/file-system.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                   ⚡ Storm Software - Powerlines\n\n This code was released as part of the Powerlines project. Powerlines\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/powerlines.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/powerlines\n Documentation:            https://docs.stormsoftware.com/projects/powerlines\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { exists, existsSync } from \"@stryke/fs/exists\";\nimport { createDirectory, createDirectorySync } from \"@stryke/fs/helpers\";\nimport { isDirectory, isFile } from \"@stryke/fs/is-file\";\nimport { listFiles, listFilesSync } from \"@stryke/fs/list-files\";\nimport { readFile, readFileSync } from \"@stryke/fs/read-file\";\nimport { writeFile, writeFileSync } from \"@stryke/fs/write-file\";\nimport { isSetString } from \"@stryke/type-checks/is-set-string\";\nimport { unlinkSync } from \"node:fs\";\nimport { unlink } from \"node:fs/promises\";\nimport { getFileHeaderWarningText } from \"../lib/utilities/file-header\";\nimport type { Context } from \"../types/context\";\nimport { BaseStorageAdapter, StorageAdapterOptions } from \"./base\";\nimport { ignoreNotfound } from \"./helpers\";\n\nexport type SetSyncOptions = Parameters<typeof writeFileSync>[2];\nexport type SetOptions = Parameters<typeof writeFile>[2];\n\n/**\n * File system storage adapter implementation.\n */\nexport class FileSystemStorageAdapter extends BaseStorageAdapter {\n  /**\n   * A name identifying the storage adapter type.\n   */\n  public name = \"file-system\";\n\n  /**\n   * The storage preset for the adapter.\n   *\n   * @remarks\n   * This can be used as an alternate way to identify the type of storage being used.\n   */\n  public override readonly preset = \"fs\";\n\n  /**\n   * Constructor for the FileSystemStorageAdapter.\n   *\n   * @param context - The Powerlines context.\n   * @param options - Configuration options for the storage adapter.\n   */\n  public constructor(context: Context, options?: StorageAdapterOptions) {\n    super(context, options);\n  }\n\n  /**\n   * Synchronously checks if a key exists in the storage.\n   *\n   * @param key - The key to check for existence.\n   * @returns Returns `true` if the key exists, otherwise `false`.\n   */\n  public existsSync(key: string): boolean {\n    return existsSync(this.resolve(key));\n  }\n\n  /**\n   * Asynchronously checks if a key exists in the storage.\n   *\n   * @param key - The key to check for existence.\n   * @returns A promise that resolves to `true` if the key exists, otherwise `false`.\n   */\n  public override async exists(key: string): Promise<boolean> {\n    return exists(this.resolve(key));\n  }\n\n  /**\n   * Synchronously retrieves the value associated with a given key.\n   *\n   * @param key - The key whose value is to be retrieved.\n   * @returns The value associated with the key, or `null` if the key does not exist.\n   */\n  public getSync(key: string): string | null {\n    return readFileSync(this.resolve(key));\n  }\n\n  /**\n   * Asynchronously retrieves the value associated with a given key.\n   *\n   * @param key - The key whose value is to be retrieved.\n   * @returns A promise that resolves to the value associated with the key, or `null` if the key does not exist.\n   */\n  public override async get(key: string): Promise<string | null> {\n    return readFile(this.resolve(key));\n  }\n\n  /**\n   * Synchronously sets the value for a given key.\n   *\n   * @param key - The key to set the value for.\n   * @param value - The value to set.\n   */\n  public setSync(key: string, value: string) {\n    if (!this.isReadOnly) {\n      if (this.existsSync(this.resolve(key)) && !this.overwrite) {\n        const existingValue = this.getSync(this.resolve(key));\n        if (\n          isSetString(existingValue) &&\n          existingValue.includes(\n            getFileHeaderWarningText(\n              true,\n              this.context.config.framework?.name || \"powerlines\"\n            )\n          )\n        ) {\n          return writeFileSync(\n            this.resolve(key),\n            existingValue.replace(\n              getFileHeaderWarningText(\n                true,\n                this.context.config.framework?.name || \"powerlines\"\n              ),\n              getFileHeaderWarningText(\n                false,\n                this.context.config.framework?.name || \"powerlines\"\n              )\n            )\n          );\n        }\n      } else {\n        return writeFileSync(this.resolve(key), value);\n      }\n    }\n  }\n\n  /**\n   * Asynchronously sets the value for a given key.\n   *\n   * @param key - The key to set the value for.\n   * @param value - The value to set.\n   */\n  public override async set(key: string, value: string): Promise<void> {\n    if (!this.isReadOnly) {\n      if (this.existsSync(this.resolve(key)) && !this.overwrite) {\n        const existingValue = await this.get(this.resolve(key));\n        if (\n          isSetString(existingValue) &&\n          existingValue.includes(\n            getFileHeaderWarningText(\n              true,\n              this.context.config.framework?.name || \"powerlines\"\n            )\n          )\n        ) {\n          return writeFile(\n            this.resolve(key),\n            existingValue.replace(\n              getFileHeaderWarningText(\n                true,\n                this.context.config.framework?.name || \"powerlines\"\n              ),\n              getFileHeaderWarningText(\n                false,\n                this.context.config.framework?.name || \"powerlines\"\n              )\n            )\n          );\n        }\n      } else {\n        return writeFile(this.resolve(key), value);\n      }\n    }\n  }\n\n  /**\n   * Synchronously removes a key from the storage.\n   *\n   * @param key - The key to remove.\n   */\n  public removeSync(key: string) {\n    if (!this.isReadOnly && this.overwrite) {\n      try {\n        return unlinkSync(this.resolve(key));\n      } catch (err) {\n        return ignoreNotfound(err);\n      }\n    }\n  }\n\n  /**\n   * Asynchronously removes a key from the storage.\n   *\n   * @param key - The key to remove.\n   */\n  public override async remove(key: string): Promise<void> {\n    if (!this.isReadOnly && this.overwrite) {\n      return unlink(this.resolve(key)).catch(ignoreNotfound);\n    }\n  }\n\n  /**\n   * Synchronously creates a directory at the specified path.\n   *\n   * @param dirPath - The path of the directory to create.\n   */\n  public override mkdirSync(dirPath: string) {\n    createDirectorySync(this.resolve(dirPath));\n  }\n\n  /**\n   * Creates a directory at the specified path.\n   *\n   * @param dirPath - The path of the directory to create.\n   */\n  public override async mkdir(dirPath: string): Promise<void> {\n    await createDirectory(this.resolve(dirPath));\n  }\n\n  /**\n   * Lists all keys under a given base path synchronously.\n   *\n   * @param base - The base path to list keys from.\n   * @returns An array of keys under the specified base path.\n   */\n  public listSync(base?: string): string[] {\n    try {\n      return listFilesSync(this.resolve(base), {\n        ignore: this.options.ignore\n      });\n    } catch (err) {\n      return ignoreNotfound(err) ?? [];\n    }\n  }\n\n  /**\n   * Asynchronously lists all keys under a given base path.\n   *\n   * @param base - The base path to list keys from.\n   * @returns A promise that resolves to an array of keys under the specified base path.\n   */\n  public override async list(base?: string): Promise<string[]> {\n    return listFiles(this.resolve(base), {\n      ignore: this.options.ignore\n    })\n      .catch(ignoreNotfound)\n      .then(r => r || []);\n  }\n\n  /**\n   * Synchronously checks if the given key is a directory.\n   *\n   * @param key - The key to check.\n   * @returns `true` if the key is a directory, otherwise `false`.\n   */\n  public override isDirectorySync(key: string): boolean {\n    return isDirectory(this.resolve(key));\n  }\n\n  /**\n   * Synchronously checks if the given key is a file.\n   *\n   * @param key - The key to check.\n   * @returns `true` if the key is a file, otherwise `false`.\n   */\n  public override isFileSync(key: string): boolean {\n    return isFile(this.resolve(key));\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;AAsCA,IAAa,2BAAb,cAA8C,mBAAmB;;;;CAI/D,AAAO,OAAO;;;;;;;CAQd,AAAyB,SAAS;;;;;;;CAQlC,AAAO,YAAY,SAAkB,SAAiC;AACpE,QAAM,SAAS,QAAQ;;;;;;;;CASzB,AAAO,WAAW,KAAsB;AACtC,SAAO,WAAW,KAAK,QAAQ,IAAI,CAAC;;;;;;;;CAStC,MAAsB,OAAO,KAA+B;AAC1D,SAAO,OAAO,KAAK,QAAQ,IAAI,CAAC;;;;;;;;CASlC,AAAO,QAAQ,KAA4B;AACzC,SAAO,aAAa,KAAK,QAAQ,IAAI,CAAC;;;;;;;;CASxC,MAAsB,IAAI,KAAqC;AAC7D,SAAO,SAAS,KAAK,QAAQ,IAAI,CAAC;;;;;;;;CASpC,AAAO,QAAQ,KAAa,OAAe;AACzC,MAAI,CAAC,KAAK,WACR,KAAI,KAAK,WAAW,KAAK,QAAQ,IAAI,CAAC,IAAI,CAAC,KAAK,WAAW;GACzD,MAAM,gBAAgB,KAAK,QAAQ,KAAK,QAAQ,IAAI,CAAC;AACrD,OACE,YAAY,cAAc,IAC1B,cAAc,SACZ,yBACE,MACA,KAAK,QAAQ,OAAO,WAAW,QAAQ,aACxC,CACF,CAED,QAAO,cACL,KAAK,QAAQ,IAAI,EACjB,cAAc,QACZ,yBACE,MACA,KAAK,QAAQ,OAAO,WAAW,QAAQ,aACxC,EACD,yBACE,OACA,KAAK,QAAQ,OAAO,WAAW,QAAQ,aACxC,CACF,CACF;QAGH,QAAO,cAAc,KAAK,QAAQ,IAAI,EAAE,MAAM;;;;;;;;CAWpD,MAAsB,IAAI,KAAa,OAA8B;AACnE,MAAI,CAAC,KAAK,WACR,KAAI,KAAK,WAAW,KAAK,QAAQ,IAAI,CAAC,IAAI,CAAC,KAAK,WAAW;GACzD,MAAM,gBAAgB,MAAM,KAAK,IAAI,KAAK,QAAQ,IAAI,CAAC;AACvD,OACE,YAAY,cAAc,IAC1B,cAAc,SACZ,yBACE,MACA,KAAK,QAAQ,OAAO,WAAW,QAAQ,aACxC,CACF,CAED,QAAO,UACL,KAAK,QAAQ,IAAI,EACjB,cAAc,QACZ,yBACE,MACA,KAAK,QAAQ,OAAO,WAAW,QAAQ,aACxC,EACD,yBACE,OACA,KAAK,QAAQ,OAAO,WAAW,QAAQ,aACxC,CACF,CACF;QAGH,QAAO,UAAU,KAAK,QAAQ,IAAI,EAAE,MAAM;;;;;;;CAUhD,AAAO,WAAW,KAAa;AAC7B,MAAI,CAAC,KAAK,cAAc,KAAK,UAC3B,KAAI;AACF,UAAO,WAAW,KAAK,QAAQ,IAAI,CAAC;WAC7B,KAAK;AACZ,UAAO,eAAe,IAAI;;;;;;;;CAUhC,MAAsB,OAAO,KAA4B;AACvD,MAAI,CAAC,KAAK,cAAc,KAAK,UAC3B,QAAO,OAAO,KAAK,QAAQ,IAAI,CAAC,CAAC,MAAM,eAAe;;;;;;;CAS1D,AAAgB,UAAU,SAAiB;AACzC,sBAAoB,KAAK,QAAQ,QAAQ,CAAC;;;;;;;CAQ5C,MAAsB,MAAM,SAAgC;AAC1D,QAAM,gBAAgB,KAAK,QAAQ,QAAQ,CAAC;;;;;;;;CAS9C,AAAO,SAAS,MAAyB;AACvC,MAAI;AACF,UAAO,cAAc,KAAK,QAAQ,KAAK,EAAE,EACvC,QAAQ,KAAK,QAAQ,QACtB,CAAC;WACK,KAAK;AACZ,UAAO,eAAe,IAAI,IAAI,EAAE;;;;;;;;;CAUpC,MAAsB,KAAK,MAAkC;AAC3D,SAAO,UAAU,KAAK,QAAQ,KAAK,EAAE,EACnC,QAAQ,KAAK,QAAQ,QACtB,CAAC,CACC,MAAM,eAAe,CACrB,MAAK,MAAK,KAAK,EAAE,CAAC;;;;;;;;CASvB,AAAgB,gBAAgB,KAAsB;AACpD,SAAO,YAAY,KAAK,QAAQ,IAAI,CAAC;;;;;;;;CASvC,AAAgB,WAAW,KAAsB;AAC/C,SAAO,OAAO,KAAK,QAAQ,IAAI,CAAC"}

package/dist/storage/helpers.cjs

@@ -0,0 +1,37 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_runtime = require('../_virtual/_rolldown/runtime.cjs');
+let _stryke_type_checks_is_error = require("@stryke/type-checks/is-error");
+
+//#region src/storage/helpers.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`.
+*/
+function isFileError(err) {
+	return (0, _stryke_type_checks_is_error.isError)(err) && "code" in err && err.code;
+}
+/**
+* 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.
+*/
+function ignoreNotfound(err) {
+	return isFileError(err) && (err.code === "ENOENT" || err.code === "EISDIR" ? null : err);
+}
+/**
+* Ignores file exists errors.
+*
+* @param err - The error to check.
+* @returns `null` if the error is a file exists error, otherwise returns the error.
+*/
+function ignoreExists(err) {
+	return isFileError(err) && err.code === "EEXIST" ? null : err;
+}
+
+//#endregion
+exports.ignoreExists = ignoreExists;
+exports.ignoreNotfound = ignoreNotfound;
+exports.isFileError = isFileError;

package/dist/storage/helpers.d.cts

@@ -0,0 +1,25 @@
+//#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
+export { ignoreExists, ignoreNotfound, isFileError };
+//# sourceMappingURL=helpers.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.cts","names":[],"sources":["../../src/storage/helpers.ts"],"mappings":";;AA0BA;;;;;iBAAgB,WAAA,CAAY,GAAA;;;;;AAuB5B;;iBAbgB,cAAA,CAAe,GAAA;;;;;;;iBAaf,YAAA,CAAa,GAAA"}

package/dist/storage/helpers.d.mts

@@ -0,0 +1,25 @@
+//#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
+export { ignoreExists, ignoreNotfound, isFileError };
+//# sourceMappingURL=helpers.d.mts.map

package/dist/storage/helpers.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.d.mts","names":[],"sources":["../../src/storage/helpers.ts"],"mappings":";;AA0BA;;;;;iBAAgB,WAAA,CAAY,GAAA;;;;;AAuB5B;;iBAbgB,cAAA,CAAe,GAAA;;;;;;;iBAaf,YAAA,CAAa,GAAA"}

package/dist/storage/helpers.mjs

@@ -0,0 +1,34 @@
+import { isError } from "@stryke/type-checks/is-error";
+
+//#region src/storage/helpers.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`.
+*/
+function isFileError(err) {
+	return isError(err) && "code" in err && err.code;
+}
+/**
+* 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.
+*/
+function ignoreNotfound(err) {
+	return isFileError(err) && (err.code === "ENOENT" || err.code === "EISDIR" ? null : err);
+}
+/**
+* Ignores file exists errors.
+*
+* @param err - The error to check.
+* @returns `null` if the error is a file exists error, otherwise returns the error.
+*/
+function ignoreExists(err) {
+	return isFileError(err) && err.code === "EEXIST" ? null : err;
+}
+
+//#endregion
+export { ignoreExists, ignoreNotfound, isFileError };
+//# sourceMappingURL=helpers.mjs.map

package/dist/storage/helpers.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.mjs","names":[],"sources":["../../src/storage/helpers.ts"],"sourcesContent":["/* -------------------------------------------------------------------\n\n                   ⚡ Storm Software - Powerlines\n\n This code was released as part of the Powerlines project. Powerlines\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/powerlines.\n\n Website:                  https://stormsoftware.com\n Repository:               https://github.com/storm-software/powerlines\n Documentation:            https://docs.stormsoftware.com/projects/powerlines\n Contact:                  https://stormsoftware.com/contact\n\n SPDX-License-Identifier:  Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport { isError } from \"@stryke/type-checks/is-error\";\n\n/**\n * Checks if an error is a file system error.\n *\n * @param err - The error to check.\n * @returns `true` if the error is a file system error, otherwise `false`.\n */\nexport function isFileError(err: any) {\n  return isError(err) && \"code\" in err && err.code;\n}\n\n/**\n * Ignores file not found errors.\n *\n * @param err - The error to check.\n * @returns `null` if the error is a file not found error, otherwise returns the error.\n */\nexport function ignoreNotfound(err: any) {\n  return (\n    isFileError(err) &&\n    (err.code === \"ENOENT\" || err.code === \"EISDIR\" ? null : err)\n  );\n}\n\n/**\n * Ignores file exists errors.\n *\n * @param err - The error to check.\n * @returns `null` if the error is a file exists error, otherwise returns the error.\n */\nexport function ignoreExists(err: any) {\n  return isFileError(err) && err.code === \"EEXIST\" ? null : err;\n}\n"],"mappings":";;;;;;;;;AA0BA,SAAgB,YAAY,KAAU;AACpC,QAAO,QAAQ,IAAI,IAAI,UAAU,OAAO,IAAI;;;;;;;;AAS9C,SAAgB,eAAe,KAAU;AACvC,QACE,YAAY,IAAI,KACf,IAAI,SAAS,YAAY,IAAI,SAAS,WAAW,OAAO;;;;;;;;AAU7D,SAAgB,aAAa,KAAU;AACrC,QAAO,YAAY,IAAI,IAAI,IAAI,SAAS,WAAW,OAAO"}

package/dist/storage/index.cjs

@@ -0,0 +1,12 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
+const require_storage_base = require('./base.cjs');
+const require_storage_helpers = require('./helpers.cjs');
+const require_storage_file_system = require('./file-system.cjs');
+const require_storage_virtual = require('./virtual.cjs');
+
+exports.BaseStorageAdapter = require_storage_base.BaseStorageAdapter;
+exports.FileSystemStorageAdapter = require_storage_file_system.FileSystemStorageAdapter;
+exports.VirtualStorageAdapter = require_storage_virtual.VirtualStorageAdapter;
+exports.ignoreExists = require_storage_helpers.ignoreExists;
+exports.ignoreNotfound = require_storage_helpers.ignoreNotfound;
+exports.isFileError = require_storage_helpers.isFileError;

package/dist/storage/index.d.cts

@@ -0,0 +1,5 @@
+import { BaseStorageAdapter, StorageAdapterOptions, __ΩStorageAdapterOptions } from "./base.cjs";
+import { FileSystemStorageAdapter, SetOptions, SetSyncOptions, __ΩSetOptions, __ΩSetSyncOptions } from "./file-system.cjs";
+import { ignoreExists, ignoreNotfound, isFileError } from "./helpers.cjs";
+import { VirtualStorageAdapter } from "./virtual.cjs";
+export { BaseStorageAdapter, FileSystemStorageAdapter, SetOptions, SetSyncOptions, StorageAdapterOptions, VirtualStorageAdapter, __ΩSetOptions, __ΩSetSyncOptions, __ΩStorageAdapterOptions, ignoreExists, ignoreNotfound, isFileError };

package/dist/storage/index.d.mts

@@ -0,0 +1,5 @@
+import { BaseStorageAdapter, StorageAdapterOptions, __ΩStorageAdapterOptions } from "./base.mjs";
+import { FileSystemStorageAdapter, SetOptions, SetSyncOptions, __ΩSetOptions, __ΩSetSyncOptions } from "./file-system.mjs";
+import { ignoreExists, ignoreNotfound, isFileError } from "./helpers.mjs";
+import { VirtualStorageAdapter } from "./virtual.mjs";
+export { BaseStorageAdapter, FileSystemStorageAdapter, SetOptions, SetSyncOptions, StorageAdapterOptions, VirtualStorageAdapter, __ΩSetOptions, __ΩSetSyncOptions, __ΩStorageAdapterOptions, ignoreExists, ignoreNotfound, isFileError };

package/dist/storage/index.mjs

@@ -0,0 +1,6 @@
+import { BaseStorageAdapter } from "./base.mjs";
+import { ignoreExists, ignoreNotfound, isFileError } from "./helpers.mjs";
+import { FileSystemStorageAdapter } from "./file-system.mjs";
+import { VirtualStorageAdapter } from "./virtual.mjs";
+
+export { BaseStorageAdapter, FileSystemStorageAdapter, VirtualStorageAdapter, ignoreExists, ignoreNotfound, isFileError };