@ocfl/ocfl 0.4.0 → 1.0.0-beta.1

package/dist/storage.d.ts

@@ -0,0 +1,94 @@
+import { OcflObject } from './object.ts';
+import type { OcflStore } from './store.ts';
+import type { OcflStorageConfig, OcflVersion } from './types.ts';
+/**
+ * An abstraction to represent the OCFL Storage Root, which is
+ * a base directory used to store OCFL Objects, identified by a [NAMASTE] file “0=ocfl_1.1”.
+ */
+declare class OcflStorage {
+    ocflVersion: OcflVersion;
+    /**
+     * Get the storage root
+     */
+    get root(): string;
+    /**
+     * Construct the path of the object root relative to the storage root
+     * The path is mapped from the object identifier using the algorithm defined in the chosen
+     * storage layout extension (specified in {@link OcflStorageConfig}).
+     * @param id - Identifier of the object
+     */
+    objectRoot(_id: string): string;
+    /**
+     * Absolute path to the object root
+     * @param id - Identifier of the object
+     */
+    objectRootAbs(id: string): string;
+    /**
+     * Get an existing object in the Storage or create a new one.
+     * @param opt - A unique identifier for the OCFL Object, should be a URI
+     */
+    object(_opt: string | {
+        id?: string | undefined;
+        root?: string | undefined;
+    }): OcflObject;
+    /**
+     * Check if the storage has already the object with the given id.
+     */
+    has(id: string): Promise<boolean>;
+    /**
+     * Create the storage root in the underlying storage backend
+     * @param options - Additional options for creating storage root
+     */
+    create(_options?: {
+        ocflSpecText?: boolean | undefined;
+    }): Promise<OcflStorage>;
+    /**
+     * Check namaste, retrieve storage layout extension, and read its config file.
+     */
+    load(): Promise<OcflStorage>;
+    /**
+     * Check if the storage root path points to an existing file or non-empty directory in the underlying backend store.
+     * The existing directory may or may not be a valid OCFL Storage.
+     */
+    exists(): Promise<boolean>;
+    [Symbol.asyncIterator](): AsyncIterableIterator<OcflObject>;
+    /**
+     * Return a new AsyncIterator that contains all the OCFL objects in this Storage.
+     */
+    objects(): AsyncIterableIterator<OcflObject>;
+    delete(id: string): Promise<void>;
+    purge(id: string): Promise<void>;
+    remove(_id: string): Promise<void>;
+}
+/**
+ * General implementation of {@link OcflStorage} that can uses different datastore backends.
+ * This class provides common functionalities for the subclasses and
+ * at the same provide encapsulation emulating private and protected methods.
+ */
+declare class OcflStorageImpl extends OcflStorage {
+    #private;
+    constructor(config: OcflStorageConfig, store: OcflStore);
+    get root(): string;
+    objectRoot(id: string): string;
+    /**
+     * The root param is a relative path to the storage root.
+     */
+    object(opt: string | {
+        id?: string | undefined;
+        root?: string | undefined;
+    }): OcflObject;
+    exists(): Promise<boolean>;
+    load(): Promise<this>;
+    /**
+     * @param options - Additional options for creating storage root
+     */
+    create(options?: {
+        ocflSpecText?: boolean | undefined;
+    }): Promise<this>;
+    /**
+     * Allow async iteration over all OCFL objects in this storage.
+     */
+    [Symbol.asyncIterator](): AsyncIterableIterator<OcflObject>;
+}
+export { OcflStorage, OcflStorageImpl };
+//# sourceMappingURL=storage.d.ts.map

package/dist/storage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAUzC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,KAAK,EAAyC,iBAAiB,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAExG;;;GAGG;AAEH,cAAM,WAAW;IACf,WAAW,EAAE,WAAW,CAAgB;IAExC;;OAEG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;;;;OAKG;IACH,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE9B;IAED;;;OAGG;IACH,aAAa,CAAC,EAAE,EAAE,MAAM,UAEvB;IAED;;;OAGG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG;QAAE,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,GAAG,UAAU,CAExF;IAED;;OAEG;IACG,GAAG,CAAC,EAAE,EAAE,MAAM,oBAEnB;IAED;;;OAGG;IACG,MAAM,CAAC,QAAQ,CAAC,EAAE;QAAE,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;KAAE,GAAG,OAAO,CAAC,WAAW,CAAC,CAEpF;IAED;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,WAAW,CAAC,CAEjC;IAED;;;OAGG;IACG,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,CAE/B;IAED,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,qBAAqB,CAAC,UAAU,CAAC,CAE1D;IAED;;OAEG;IACH,OAAO,IAAI,qBAAqB,CAAC,UAAU,CAAC,CAK3C;IAEK,MAAM,CAAC,EAAE,EAAE,MAAM,iBAEtB;IAEK,KAAK,CAAC,EAAE,EAAE,MAAM,iBAErB;IAEK,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAEvC;CACF;AAED;;;;GAIG;AACH,cAAM,eAAgB,SAAQ,WAAW;;IAOvC,YAAY,MAAM,EAAE,iBAAiB,EAAE,KAAK,EAAE,SAAS,EAsBtD;IAaD,IAAI,IAAI,WAEP;IAED,UAAU,CAAC,EAAE,EAAE,MAAM,UAKpB;IAED;;OAEG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG;QAAE,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;KAAE,cAuB1E;IAEK,MAAM,qBAEX;IAEK,IAAI,kBAkCT;IAED;;OAEG;IACG,MAAM,CAAC,OAAO,CAAC,EAAE;QAAE,YAAY,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;KAAE,iBAmC5D;IAED;;OAEG;IACH,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,qBAAqB,CAAC,UAAU,CAAC,CAoD1D;CACF;AAED,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,CAAC"}

package/dist/storage.js

@@ -0,0 +1,302 @@
+//@todo add default layout
+import path from 'node:path';
+import { OcflConstants } from './constants.js';
+import { NotImplementedError } from './error.js';
+import { createByName, OcflStorageLayout } from './extension.js';
+import { HashedNTupleStorageLayout } from './extensions/0004-hashed-n-tuple-storage-layout.js';
+import { OcflObject } from './object.js';
+import { findNamasteVersion, isDirEmpty } from './utils.js';
+import { createError } from './validation.js';
+const { OCFL_VERSION, OCFL_LAYOUT, EXTENSIONS_DIR, EXTENSION_CONFIG, NAMASTE_PREFIX_STORAGE, NAMASTE_PREFIX_OBJECT, NAMASTE_T } = OcflConstants;
+import { OcflDigest } from './digest.js';
+const DEFAULT_LAYOUT = HashedNTupleStorageLayout;
+/**
+ * An abstraction to represent the OCFL Storage Root, which is
+ * a base directory used to store OCFL Objects, identified by a [NAMASTE] file “0=ocfl_1.1”.
+ */
+class OcflStorage {
+    ocflVersion = OCFL_VERSION;
+    /**
+     * Get the storage root
+     */
+    get root() {
+        throw new NotImplementedError();
+    }
+    /**
+     * Construct the path of the object root relative to the storage root
+     * The path is mapped from the object identifier using the algorithm defined in the chosen
+     * storage layout extension (specified in {@link OcflStorageConfig}).
+     * @param id - Identifier of the object
+     */
+    objectRoot(_id) {
+        throw new NotImplementedError();
+    }
+    /**
+     * Absolute path to the object root
+     * @param id - Identifier of the object
+     */
+    objectRootAbs(id) {
+        return path.join(this.root, this.objectRoot(id));
+    }
+    /**
+     * Get an existing object in the Storage or create a new one.
+     * @param opt - A unique identifier for the OCFL Object, should be a URI
+     */
+    object(_opt) {
+        throw new NotImplementedError();
+    }
+    /**
+     * Check if the storage has already the object with the given id.
+     */
+    async has(id) {
+        return this.object(id).exists();
+    }
+    /**
+     * Create the storage root in the underlying storage backend
+     * @param options - Additional options for creating storage root
+     */
+    async create(_options) {
+        throw new NotImplementedError();
+    }
+    /**
+     * Check namaste, retrieve storage layout extension, and read its config file.
+     */
+    async load() {
+        throw new NotImplementedError();
+    }
+    /**
+     * Check if the storage root path points to an existing file or non-empty directory in the underlying backend store.
+     * The existing directory may or may not be a valid OCFL Storage.
+     */
+    async exists() {
+        throw new NotImplementedError();
+    }
+    [Symbol.asyncIterator]() {
+        throw new NotImplementedError();
+    }
+    /**
+     * Return a new AsyncIterator that contains all the OCFL objects in this Storage.
+     */
+    objects() {
+        return this[Symbol.asyncIterator]();
+        // const objects = [];
+        // for await (const o of this) objects.push(o);
+        // return objects;
+    }
+    async delete(id) {
+        return this.remove(id);
+    }
+    async purge(id) {
+        return this.remove(id);
+    }
+    async remove(_id) {
+        throw new NotImplementedError();
+    }
+}
+/**
+ * General implementation of {@link OcflStorage} that can uses different datastore backends.
+ * This class provides common functionalities for the subclasses and
+ * at the same provide encapsulation emulating private and protected methods.
+ */
+class OcflStorageImpl extends OcflStorage {
+    #root;
+    #workspace;
+    #layout;
+    #store;
+    #objectConfig;
+    constructor(config, store) {
+        super();
+        if (!store) {
+            throw new TypeError('[OcflStorage] store is required.');
+        }
+        if (!config.root) {
+            throw new TypeError('[OcflStorage] config.root is required.');
+        }
+        this.#store = store;
+        const { root, workspace, layout, ocflVersion, ...objectConfig } = config;
+        this.#root = path.resolve(root);
+        this.#workspace = workspace ? path.resolve(workspace) : path.join(this.#root, 'extensions/workspace');
+        if (this.#workspace?.startsWith(this.#root + path.sep) && !this.#workspace.startsWith(`${this.#root + path.sep}extensions${path.sep}`)) {
+            throw new Error('[OcflStorage] config.workspace cannot be the same as or a subpath of config.root');
+        }
+        if (layout) {
+            this.#layout = layout instanceof OcflStorageLayout ? layout : this.#createLayout(layout);
+        }
+        if (ocflVersion) {
+            this.ocflVersion = ocflVersion;
+        }
+        this.#objectConfig = objectConfig;
+    }
+    #createLayout(option) {
+        const name = typeof option === 'string' ? option : option?.extensionName;
+        const config = typeof option === 'object' ? option : undefined;
+        if (name) {
+            return createByName(OcflStorageLayout, 'Layout', name, config);
+        }
+        // else if (useDefault) {
+        //   return DEFAULT_LAYOUT.create(config);
+        // }
+    }
+    get root() {
+        return this.#root;
+    }
+    objectRoot(id) {
+        if (!this.#layout) {
+            throw new Error('[OcflStorage] No layout defined');
+        }
+        return this.#layout.map(id);
+    }
+    /**
+     * The root param is a relative path to the storage root.
+     */
+    object(opt) {
+        let id;
+        let root;
+        if (typeof opt === 'string') {
+            id = opt;
+        }
+        else {
+            ({ id, root } = opt);
+        }
+        const relObjectRoot = root || (id && this.objectRoot(id));
+        if (!relObjectRoot) {
+            throw new TypeError('[OcflStorage] object id or root is required.');
+        }
+        return new OcflObject({
+            id,
+            root: path.join(this.root, relObjectRoot),
+            // @todo:use extension workspace if not defined
+            workspace: this.#workspace ? path.join(this.#workspace, relObjectRoot) : undefined,
+            ocflVersion: this.ocflVersion,
+            ...this.#objectConfig,
+        }, this.#store);
+    }
+    async exists() {
+        return !(await isDirEmpty(this.#store, this.root));
+    }
+    async load() {
+        const prefix = NAMASTE_PREFIX_STORAGE;
+        const [ocflVersion, layout] = (await Promise.allSettled([findNamasteVersion(this.#store, prefix, this.root), this.#store.readFile(path.join(this.root, OCFL_LAYOUT), 'utf8')])).map((r) => (r.status === 'fulfilled' ? r.value : undefined));
+        if (ocflVersion === '') {
+            throw createError('E080', this.root);
+        }
+        if (!ocflVersion) {
+            throw createError('E069', this.root);
+        }
+        let layoutName;
+        let layoutConfig;
+        // load layout
+        try {
+            if (layout) {
+                layoutName = JSON.parse(layout).extension;
+            }
+        }
+        catch (_error) { }
+        // load ext config if exists
+        if (layoutName) {
+            try {
+                const cfgstr = await this.#store.readFile(path.join(this.root, EXTENSIONS_DIR, layoutName, EXTENSION_CONFIG), 'utf8');
+                layoutConfig = JSON.parse(cfgstr);
+            }
+            catch (_error) { }
+        }
+        this.#layout = this.#createLayout(layoutConfig || layoutName);
+        const layoutDigestAlgorithm = this.#layout?.get('digestAlgorithm');
+        if (layoutDigestAlgorithm) {
+            await OcflDigest.initSync(layoutDigestAlgorithm);
+        }
+        //@todo: load storage level extensions
+        return this;
+    }
+    /**
+     * @param options - Additional options for creating storage root
+     */
+    async create(options) {
+        if (await this.exists()) {
+            //cannot create, storage root already exists .
+            throw new Error('[OcflStorage] Cannot create storage root in a non-empty directory');
+        }
+        else {
+            await this.#store.mkdir(this.root);
+        }
+        // create namaste
+        const prefix = NAMASTE_PREFIX_STORAGE;
+        const filenamePrefix = NAMASTE_T + prefix;
+        const filePath = path.join(this.root, filenamePrefix + this.ocflVersion);
+        await this.#store.writeFile(filePath, `${prefix + this.ocflVersion}\n`, 'utf8');
+        // create layout
+        if (!this.#layout) {
+            this.#layout = new DEFAULT_LAYOUT();
+        }
+        const layoutDigestAlgorithm = this.#layout.get('digestAlgorithm');
+        if (layoutDigestAlgorithm) {
+            await OcflDigest.initSync(layoutDigestAlgorithm);
+        }
+        const layout = { extension: this.#layout.name, description: this.#layout.description };
+        await this.#store.writeFile(path.join(this.root, OCFL_LAYOUT), JSON.stringify(layout, null, 2), 'utf8');
+        if (this.#layout.config) {
+            await this.#store.writeFile(path.join(this.root, EXTENSIONS_DIR, this.#layout.name, EXTENSION_CONFIG), JSON.stringify(this.#layout.config, null, 2), 'utf8');
+        }
+        // todo: create other extensions
+        if (options?.ocflSpecText) {
+        }
+        return this;
+    }
+    /**
+     * Allow async iteration over all OCFL objects in this storage.
+     */
+    [Symbol.asyncIterator]() {
+        const store = this.#store;
+        const workspace = this.#workspace;
+        const config = this.#objectConfig;
+        const root = this.root;
+        const stack = [this.#store.opendir(this.root)];
+        return {
+            [Symbol.asyncIterator]() {
+                return this;
+            },
+            async next() {
+                for (let dirp = stack.pop(); dirp; dirp = stack.pop()) {
+                    const dir = await dirp;
+                    const dirent = await dir.read();
+                    if (!dirent) {
+                        await dir.close();
+                        continue;
+                    }
+                    stack.push(dirp);
+                    if (!dirent.isDirectory()) {
+                        continue;
+                    }
+                    const basePath = path.join(dir.path, dirent.name);
+                    let nv;
+                    try {
+                        nv = await findNamasteVersion(store, NAMASTE_PREFIX_OBJECT, basePath);
+                    }
+                    catch (_err) { }
+                    if (nv) {
+                        //ocfl object exists
+                        // inventory exists
+                        const object = new OcflObject({
+                            root: basePath,
+                            workspace: workspace ? path.join(workspace, path.relative(root, basePath)) : undefined,
+                            ocflVersion: nv,
+                            ...config,
+                        }, store);
+                        //await object.load();
+                        return { done: false, value: object };
+                    }
+                    else {
+                        //ocfl object does not exist, process subdir
+                        stack.push(store.opendir(basePath));
+                    }
+                }
+                return { done: true, value: null };
+            },
+            // return() {
+            //   return { done: true };
+            // }
+        };
+    }
+}
+export { OcflStorage, OcflStorageImpl };
+//# sourceMappingURL=storage.js.map

package/dist/storage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage.js","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":"AAAA,0BAA0B;AAC1B,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACjE,OAAO,EAAE,yBAAyB,EAAE,MAAM,oDAAoD,CAAC;AAC/F,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,kBAAkB,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAE9C,MAAM,EAAE,YAAY,EAAE,WAAW,EAAE,cAAc,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,SAAS,EAAE,GAAG,aAAa,CAAC;AAEhJ,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEzC,MAAM,cAAc,GAAG,yBAAyB,CAAC;AAKjD;;;GAGG;AAEH,MAAM,WAAW;IACf,WAAW,GAAgB,YAAY,CAAC;IAExC;;OAEG;IACH,IAAI,IAAI;QACN,MAAM,IAAI,mBAAmB,EAAE,CAAC;IAClC,CAAC;IAED;;;;;OAKG;IACH,UAAU,CAAC,GAAW;QACpB,MAAM,IAAI,mBAAmB,EAAE,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,aAAa,CAAC,EAAU;QACtB,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACH,MAAM,CAAC,IAAqE;QAC1E,MAAM,IAAI,mBAAmB,EAAE,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,GAAG,CAAC,EAAU;QAClB,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM,CAAC,QAAiD;QAC5D,MAAM,IAAI,mBAAmB,EAAE,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI;QACR,MAAM,IAAI,mBAAmB,EAAE,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM;QACV,MAAM,IAAI,mBAAmB,EAAE,CAAC;IAClC,CAAC;IAED,CAAC,MAAM,CAAC,aAAa,CAAC;QACpB,MAAM,IAAI,mBAAmB,EAAE,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC;QACpC,sBAAsB;QACtB,+CAA+C;QAC/C,kBAAkB;IACpB,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,EAAU;QACrB,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACzB,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,EAAU;QACpB,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACzB,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,GAAW;QACtB,MAAM,IAAI,mBAAmB,EAAE,CAAC;IAClC,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,eAAgB,SAAQ,WAAW;IACvC,KAAK,CAAS;IACd,UAAU,CAAS;IACnB,OAAO,CAAgC;IACvC,MAAM,CAAY;IAClB,aAAa,CAAsE;IAEnF,YAAY,MAAyB,EAAE,KAAgB;QACrD,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,SAAS,CAAC,kCAAkC,CAAC,CAAC;QAC1D,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;YACjB,MAAM,IAAI,SAAS,CAAC,wCAAwC,CAAC,CAAC;QAChE,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,YAAY,EAAE,GAAG,MAAM,CAAC;QACzE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAChC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,sBAAsB,CAAC,CAAC;QACtG,IAAI,IAAI,CAAC,UAAU,EAAE,UAAU,CAAC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,GAAG,aAAa,IAAI,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC;YACvI,MAAM,IAAI,KAAK,CAAC,kFAAkF,CAAC,CAAC;QACtG,CAAC;QACD,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,CAAC,OAAO,GAAG,MAAM,YAAY,iBAAiB,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC;QAC3F,CAAC;QACD,IAAI,WAAW,EAAE,CAAC;YAChB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QACjC,CAAC;QACD,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;IACpC,CAAC;IAED,aAAa,CAAC,MAAgD;QAC5D,MAAM,IAAI,GAAG,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,aAAa,CAAC;QACzE,MAAM,MAAM,GAAG,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;QAC/D,IAAI,IAAI,EAAE,CAAC;YACT,OAAO,YAAY,CAAoB,iBAAiB,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;QACpF,CAAC;QACD,yBAAyB;QACzB,0CAA0C;QAC1C,IAAI;IACN,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,UAAU,CAAC,EAAU;QACnB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;QACrD,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,GAAoE;QACzE,IAAI,EAAsB,CAAC;QAC3B,IAAI,IAAwB,CAAC;QAC7B,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YAC5B,EAAE,GAAG,GAAG,CAAC;QACX,CAAC;aAAM,CAAC;YACN,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,GAAG,CAAC,CAAC;QACvB,CAAC;QACD,MAAM,aAAa,GAAG,IAAI,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;QAC1D,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,MAAM,IAAI,SAAS,CAAC,8CAA8C,CAAC,CAAC;QACtE,CAAC;QACD,OAAO,IAAI,UAAU,CACnB;YACE,EAAE;YACF,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,aAAa,CAAC;YACzC,+CAA+C;YAC/C,SAAS,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,SAAS;YAClF,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,GAAG,IAAI,CAAC,aAAa;SACtB,EACD,IAAI,CAAC,MAAM,CACZ,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,MAAM;QACV,OAAO,CAAC,CAAC,MAAM,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACrD,CAAC;IAED,KAAK,CAAC,IAAI;QACR,MAAM,MAAM,GAAG,sBAAsB,CAAC;QACtC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,GAAG,CAC5B,MAAM,OAAO,CAAC,UAAU,CAAC,CAAC,kBAAkB,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAChJ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,KAAK,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;QAC/D,IAAI,WAAW,KAAK,EAAE,EAAE,CAAC;YACvB,MAAM,WAAW,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACvC,CAAC;QACD,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,MAAM,WAAW,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACvC,CAAC;QACD,IAAI,UAA8B,CAAC;QACnC,IAAI,YAA6C,CAAC;QAClD,cAAc;QACd,IAAI,CAAC;YACH,IAAI,MAAM,EAAE,CAAC;gBACX,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC;YAC5C,CAAC;QACH,CAAC;QAAC,OAAO,MAAM,EAAE,CAAC,CAAA,CAAC;QACnB,4BAA4B;QAC5B,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,EAAE,UAAU,EAAE,gBAAgB,CAAC,EAAE,MAAM,CAAC,CAAC;gBACtH,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,MAAgB,CAAC,CAAC;YAC9C,CAAC;YAAC,OAAO,MAAM,EAAE,CAAC,CAAA,CAAC;QACrB,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,YAAY,IAAI,UAAU,CAAC,CAAC;QAC9D,MAAM,qBAAqB,GAAG,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,iBAAiB,CAAC,CAAC;QACnE,IAAI,qBAAqB,EAAE,CAAC;YAC1B,MAAM,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAAC;QACnD,CAAC;QACD,sCAAsC;QAEtC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,OAAgD;QAC3D,IAAI,MAAM,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;YACxB,8CAA8C;YAC9C,MAAM,IAAI,KAAK,CAAC,mEAAmE,CAAC,CAAC;QACvF,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACrC,CAAC;QACD,iBAAiB;QACjB,MAAM,MAAM,GAAG,sBAAsB,CAAC;QACtC,MAAM,cAAc,GAAG,SAAS,GAAG,MAAM,CAAC;QAC1C,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC;QACzE,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,GAAG,MAAM,GAAG,IAAI,CAAC,WAAW,IAAI,EAAE,MAAM,CAAC,CAAC;QAEhF,gBAAgB;QAChB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,IAAI,CAAC,OAAO,GAAG,IAAI,cAAc,EAAE,CAAC;QACtC,CAAC;QACD,MAAM,qBAAqB,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;QAClE,IAAI,qBAAqB,EAAE,CAAC;YAC1B,MAAM,UAAU,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAAC;QACnD,CAAC;QACD,MAAM,MAAM,GAAG,EAAE,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;QACvF,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QACxG,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YACxB,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CACzB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,gBAAgB,CAAC,EACzE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,EAC5C,MAAM,CACP,CAAC;QACJ,CAAC;QAED,gCAAgC;QAChC,IAAI,OAAO,EAAE,YAAY,EAAE,CAAC;QAC5B,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,CAAC,MAAM,CAAC,aAAa,CAAC;QACpB,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC;QAC1B,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC;QAClC,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC;QAClC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACvB,MAAM,KAAK,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC/C,OAAO;YACL,CAAC,MAAM,CAAC,aAAa,CAAC;gBACpB,OAAO,IAAI,CAAC;YACd,CAAC;YACD,KAAK,CAAC,IAAI;gBACR,KAAK,IAAI,IAAI,GAAG,KAAK,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,IAAI,GAAG,KAAK,CAAC,GAAG,EAAE,EAAE,CAAC;oBACtD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC;oBACvB,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;oBAChC,IAAI,CAAC,MAAM,EAAE,CAAC;wBACZ,MAAM,GAAG,CAAC,KAAK,EAAE,CAAC;wBAClB,SAAS;oBACX,CAAC;oBACD,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBACjB,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,EAAE,CAAC;wBAC1B,SAAS;oBACX,CAAC;oBACD,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;oBAClD,IAAI,EAAgC,CAAC;oBACrC,IAAI,CAAC;wBACH,EAAE,GAAG,MAAM,kBAAkB,CAAC,KAAK,EAAE,qBAAqB,EAAE,QAAQ,CAAC,CAAC;oBACxE,CAAC;oBAAC,OAAO,IAAI,EAAE,CAAC,CAAA,CAAC;oBACjB,IAAI,EAAE,EAAE,CAAC;wBACP,oBAAoB;wBACpB,mBAAmB;wBACnB,MAAM,MAAM,GAAG,IAAI,UAAU,CAC3B;4BACE,IAAI,EAAE,QAAQ;4BACd,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;4BACtF,WAAW,EAAE,EAAE;4BACf,GAAG,MAAM;yBACV,EACD,KAAK,CACN,CAAC;wBACF,sBAAsB;wBACtB,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;oBACxC,CAAC;yBAAM,CAAC;wBACN,4CAA4C;wBAC5C,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;oBACtC,CAAC;gBACH,CAAC;gBACD,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;YACrC,CAAC;YACD,aAAa;YACb,2BAA2B;YAC3B,IAAI;SACL,CAAC;IACJ,CAAC;CACF;AAED,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,CAAC"}

package/dist/store.d.ts

@@ -0,0 +1,100 @@
+import type { Dir, ReadStream, Stats, WriteStream } from 'node:fs';
+type Encoding = BufferEncoding | {
+    encoding: BufferEncoding;
+};
+export type WriteFileData = string | Uint8Array | DataView | ArrayBuffer | ReadableStream;
+export interface ListedFile {
+    name: string;
+    path: string;
+    size: number;
+    lastModified: Date;
+}
+export interface ListOptions {
+    encoding?: BufferEncoding;
+    bufferSize?: number;
+    recursive?: boolean;
+}
+/**
+ * Abstract class to provide common APIs to access and modify the actual data store backend
+ * such as local file system and cloud storage
+ */
+declare class OcflStore {
+    static instances: Map<object, OcflStore>;
+    static getInstance<T extends OcflStore>(this: new (options?: object) => T, options?: object): T;
+    constructor(_options?: object);
+    /**
+     * Get file information.
+     */
+    stat(_filePath: string): Promise<Stats>;
+    /**
+     * Check if file exists
+     */
+    exists(filePath: string): Promise<boolean>;
+    /**
+     * Create a readable stream to get the content of a file
+     * @deprecated Use {@link OcflStore.createReadable} instead
+     */
+    createReadStream(_filePath: string, _options?: unknown): Promise<ReadStream>;
+    /**
+     * Create a stream that writes data to `filePath`.
+     * @deprecated Use {@link OcflStore.createWritable} instead
+     */
+    createWriteStream(_filePath: string, _options?: unknown): Promise<WriteStream>;
+    /**
+     * Create a ReadableStream to get the content of a file
+     * @param filePath - Absolute path
+     */
+    createReadable(_filePath: string, _options?: unknown): Promise<ReadableStream>;
+    /**
+     * Create a WritableStream that writes data to `filePath`.
+     */
+    createWritable(_filePath: string, _options?: unknown): Promise<WritableStream>;
+    /**
+     * Provide a common interface to read a file inside an object.
+     * A concrete subclass MAY implement this method to provide read access to its underlying storage backend.
+     * The default implementation uses the {@linkcode OcflStore#createReadable} method.
+     */
+    readFile(filePath: string, options: Encoding): Promise<string>;
+    readFile(filePath: string, options?: unknown): Promise<Uint8Array>;
+    /**
+     * Provide a common interface to write a file inside an object.
+     * A concrete subclass MAY implement this method to provide write access to its underlying storage backend.
+     * The default implementation uses the {@link OcflStore.createWritable} method.
+     * @param filePath - Absolute path to the file.
+     * @param data - The data to be written to the file.
+     */
+    writeFile(filePath: string, data: WriteFileData, options?: object | string): Promise<void>;
+    /**
+     * Copy file from `source` to `target`.
+     * By default, target is overwritten if it already exists.
+     */
+    copyFile(source: string, target: string): Promise<void>;
+    /**
+     * Open a directory
+     */
+    opendir(_filePath: string, _options?: unknown): Promise<Dir>;
+    /**
+     * Read a directory
+     */
+    readdir(_filePath: string, _options?: unknown): Promise<string[]>;
+    /**
+     * List all files contained in a directory including the metadata such as size and last modified date.
+     * The returned file.path is a relative path to the dirPath
+     */
+    list(_dirPath: string, _options?: ListOptions): Promise<AsyncIterableIterator<ListedFile>>;
+    /**
+     * Recursively create a directory if the storage backend supports it, otherwise do nothing
+     * @returns The first directory path created
+     */
+    mkdir(_filePath: string, _options?: unknown): Promise<string | undefined>;
+    /**
+     * Rename or move a file or directory
+     */
+    move(_source: string, _target: string): Promise<void>;
+    /**
+     * Remove a file or directory recursively
+     */
+    remove(_filePath: string): Promise<void>;
+}
+export { OcflStore };
+//# sourceMappingURL=store.d.ts.map

package/dist/store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"store.d.ts","sourceRoot":"","sources":["../src/store.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAMnE,KAAK,QAAQ,GAAG,cAAc,GAAG;IAAE,QAAQ,EAAE,cAAc,CAAA;CAAE,CAAC;AAE9D,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,UAAU,GAAG,QAAQ,GAAG,WAAW,GAAG,cAAc,CAAC;AAE1F,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,IAAI,CAAC;CACpB;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,EAAE,cAAc,CAAC;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;;GAGG;AACH,cAAM,SAAS;IACb,MAAM,CAAC,SAAS,EAAE,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAEzC,MAAM,CAAC,WAAW,CAAC,CAAC,SAAS,SAAS,EAAE,IAAI,EAAE,KAAK,OAAO,CAAC,EAAE,MAAM,KAAK,CAAC,EAAE,OAAO,GAAE,MAAqB,GAAG,CAAC,CAY5G;IAGD,YAAY,QAAQ,CAAC,EAAE,MAAM,EAAI;IAEjC;;OAEG;IACG,IAAI,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC,CAE5C;IAED;;OAEG;IACG,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAO/C;IAED;;;OAGG;IACG,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,CAEjF;IAED;;;OAGG;IACG,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,WAAW,CAAC,CAEnF;IAED;;;OAGG;IACG,cAAc,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,cAAc,CAAC,CAEnF;IAED;;OAEG;IACG,cAAc,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,cAAc,CAAC,CAEnF;IAED;;;;OAIG;IACG,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC/D,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAuBzE;;;;;;OAMG;IACG,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAU/F;IAED;;;OAGG;IACG,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAE5D;IAED;;OAEG;IACG,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAEjE;IAED;;OAEG;IACG,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAEtE;IAED;;;OAGG;IACG,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC,CAE/F;IAED;;;OAGG;IACG,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAE9E;IAED;;OAEG;IACG,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAE1D;IAED;;OAEG;IACG,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAE7C;CACF;AAED,OAAO,EAAE,SAAS,EAAE,CAAC"}

package/dist/store.js

@@ -0,0 +1,157 @@
+import path from 'node:path';
+import { joinTypedArray } from './utils.js';
+const emptyOptions = {};
+/**
+ * Abstract class to provide common APIs to access and modify the actual data store backend
+ * such as local file system and cloud storage
+ */
+class OcflStore {
+    static instances;
+    static getInstance(options = emptyOptions) {
+        // biome-ignore lint/complexity/noThisInStatic: reads the subclass's own instances map
+        const instances = this.instances;
+        if (!instances) {
+            return new this(options);
+        }
+        let store = instances.get(options);
+        if (!store) {
+            store = new this(options);
+            instances.set(options, store);
+        }
+        return store;
+    }
+    // biome-ignore lint/complexity/noUselessConstructor: documents the constructor signature subclasses receive from getInstance()
+    constructor(_options) { }
+    /**
+     * Get file information.
+     */
+    async stat(_filePath) {
+        throw new Error('Not Implemented');
+    }
+    /**
+     * Check if file exists
+     */
+    async exists(filePath) {
+        try {
+            await this.stat(filePath);
+            return true;
+        }
+        catch {
+            return false;
+        }
+    }
+    /**
+     * Create a readable stream to get the content of a file
+     * @deprecated Use {@link OcflStore.createReadable} instead
+     */
+    async createReadStream(_filePath, _options) {
+        throw new Error('Not Implemented');
+    }
+    /**
+     * Create a stream that writes data to `filePath`.
+     * @deprecated Use {@link OcflStore.createWritable} instead
+     */
+    async createWriteStream(_filePath, _options) {
+        throw new Error('Not Implemented');
+    }
+    /**
+     * Create a ReadableStream to get the content of a file
+     * @param filePath - Absolute path
+     */
+    async createReadable(_filePath, _options) {
+        throw new Error('Not Implemented');
+    }
+    /**
+     * Create a WritableStream that writes data to `filePath`.
+     */
+    async createWritable(_filePath, _options) {
+        throw new Error('Not Implemented');
+    }
+    async readFile(filePath, options) {
+        const rs = await this.createReadable(filePath, options);
+        let buffer = typeof options === 'string' || options?.encoding
+            ? ''
+            : new Uint8Array(new ArrayBuffer(0, { maxByteLength: 16 * 1024 }));
+        for await (const chunk of rs) {
+            if (typeof chunk === 'string') {
+                if (typeof buffer !== 'string') {
+                    buffer = new TextDecoder().decode(buffer);
+                }
+                buffer += chunk;
+            }
+            else {
+                if (typeof buffer === 'string') {
+                    buffer = new TextEncoder().encode(buffer);
+                }
+                buffer = joinTypedArray(buffer, chunk);
+            }
+        }
+        return buffer;
+    }
+    /**
+     * Provide a common interface to write a file inside an object.
+     * A concrete subclass MAY implement this method to provide write access to its underlying storage backend.
+     * The default implementation uses the {@link OcflStore.createWritable} method.
+     * @param filePath - Absolute path to the file.
+     * @param data - The data to be written to the file.
+     */
+    async writeFile(filePath, data, options) {
+        await this.mkdir(path.dirname(filePath));
+        const target = await this.createWritable(filePath, options);
+        if (data instanceof ReadableStream) {
+            await data.pipeTo(target);
+        }
+        else {
+            const w = target.getWriter();
+            await w.write(data);
+            await w.close();
+        }
+    }
+    /**
+     * Copy file from `source` to `target`.
+     * By default, target is overwritten if it already exists.
+     */
+    async copyFile(source, target) {
+        await this.writeFile(target, await this.createReadable(source));
+    }
+    /**
+     * Open a directory
+     */
+    async opendir(_filePath, _options) {
+        throw new Error('Not Implemented');
+    }
+    /**
+     * Read a directory
+     */
+    async readdir(_filePath, _options) {
+        throw new Error('Not Implemented');
+    }
+    /**
+     * List all files contained in a directory including the metadata such as size and last modified date.
+     * The returned file.path is a relative path to the dirPath
+     */
+    async list(_dirPath, _options) {
+        throw new Error('Not Implemented');
+    }
+    /**
+     * Recursively create a directory if the storage backend supports it, otherwise do nothing
+     * @returns The first directory path created
+     */
+    async mkdir(_filePath, _options) {
+        throw new Error('Not Implemented');
+    }
+    /**
+     * Rename or move a file or directory
+     */
+    async move(_source, _target) {
+        throw new Error('Not Implemented');
+    }
+    /**
+     * Remove a file or directory recursively
+     */
+    async remove(_filePath) {
+        throw new Error('Not Implemented');
+    }
+}
+export { OcflStore };
+//# sourceMappingURL=store.js.map