@ocfl/ocfl-fs 0.4.0 → 1.0.0-beta.1

package/README.md

@@ -1,5 +1,6 @@
-# ocfl-fs - OCFL implementation using Filesystem storage backend for Node.js
-This is JavaScript/Node.js library to create and interact with Oxford Common File Layout (OCFL) storage and objects within it. 
+# @ocfl/ocfl-fs - OCFL implementation using Filesystem storage backend for Node.js
+
+TypeScript library to create and interact with Oxford Common File Layout (OCFL) storage and objects within it.
 This package implements the OCFL client that stores storage root and its objects on a locally attached filesystem.
 
 ## Installation
@@ -10,13 +11,13 @@ This package implements the OCFL client that stores storage root and its objects
 
 The storage and object methods accept an optional fs parameter, which can be any module that implements Node.js fs module API. By default, it will use the built in fs module.
 
-    const ocfl = require('@ocfl/ocfl-fs');
+    import ocfl from '@ocfl/ocfl-fs';
     const storage = ocfl.storage({root: '/var/data/myocfl'});
 
-For example, by passing it memfs (https://www.npmjs.com/package/memfs) the OCFL storage will be created in memory using the memfs module: 
+For example, by passing it memfs (https://www.npmjs.com/package/memfs) the OCFL storage will be created in memory using the memfs module:
 
-    const ocfl = require('@ocfl/ocfl-fs');
-    const fs = require('memfs');
+    import ocfl from '@ocfl/ocfl-fs';
+    import { fs } from 'memfs';
     const storage = ocfl.storage({root: '/var/data/myocfl'}, {fs});
 
-For common usage documentation please refer to the [README.md in GitHub](https://github.com/Arkisto-Platform/ocfl-js)
+For common usage documentation please refer to the [README.md in GitHub](https://github.com/Language-Research-Technology/ocfl-js)

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+import { type OcflFsStoreConfig } from './store.ts';
+export type { OcflFsStoreConfig } from './store.ts';
+export { OcflFsStore } from './store.ts';
+declare const ocfl: {
+    OCFL_VERSIONS: readonly ["1.1", "1.0"];
+    StorageLayout: import("@ocfl/ocfl").StorageLayout;
+    storageLayout(config: string | import("@ocfl/ocfl").OcflExtensionConfig): import("@ocfl/ocfl").OcflStorageLayout;
+    object(config: import("@ocfl/ocfl").OcflObjectConfig, storeOptions?: OcflFsStoreConfig | undefined): import("@ocfl/ocfl").OcflObject;
+    storage(config: import("@ocfl/ocfl").OcflStorageConfig, storeOptions?: OcflFsStoreConfig | undefined): import("@ocfl/ocfl").OcflStorage;
+    createStorage(config: import("@ocfl/ocfl").OcflStorageConfig, storeOptions?: OcflFsStoreConfig | undefined): Promise<import("@ocfl/ocfl").OcflStorage>;
+    loadStorage(config: import("@ocfl/ocfl").OcflStorageConfig, storeOptions?: OcflFsStoreConfig | undefined): Promise<import("@ocfl/ocfl").OcflStorage>;
+};
+export declare const OCFL_VERSIONS: readonly ["1.1", "1.0"], StorageLayout: import("@ocfl/ocfl").StorageLayout, createStorage: (config: import("@ocfl/ocfl").OcflStorageConfig, storeOptions?: OcflFsStoreConfig | undefined) => Promise<import("@ocfl/ocfl").OcflStorage>, loadStorage: (config: import("@ocfl/ocfl").OcflStorageConfig, storeOptions?: OcflFsStoreConfig | undefined) => Promise<import("@ocfl/ocfl").OcflStorage>, object: (config: import("@ocfl/ocfl").OcflObjectConfig, storeOptions?: OcflFsStoreConfig | undefined) => import("@ocfl/ocfl").OcflObject, storage: (config: import("@ocfl/ocfl").OcflStorageConfig, storeOptions?: OcflFsStoreConfig | undefined) => import("@ocfl/ocfl").OcflStorage, storageLayout: (config: string | import("@ocfl/ocfl").OcflExtensionConfig) => import("@ocfl/ocfl").OcflStorageLayout;
+export default ocfl;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAe,KAAK,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAEjE,YAAY,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AACpD,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,QAAA,MAAM,IAAI;;;;;;;;CAAgD,CAAC;AAE3D,eAAO,MAAQ,aAAa,2BAAE,aAAa,sCAAE,aAAa,+IAAE,WAAW,+IAAE,MAAM,oIAAE,OAAO,sIAAE,aAAa,uGAAS,CAAC;eAClG,IAAI"}

package/dist/index.js

@@ -0,0 +1,7 @@
+import { implementOcfl } from '@ocfl/ocfl';
+import { OcflFsStore } from './store.js';
+export { OcflFsStore } from './store.js';
+const ocfl = implementOcfl(OcflFsStore);
+export const { OCFL_VERSIONS, StorageLayout, createStorage, loadStorage, object, storage, storageLayout } = ocfl;
+export default ocfl;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,EAAE,WAAW,EAA0B,MAAM,YAAY,CAAC;AAGjE,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,MAAM,IAAI,GAAG,aAAa,CAAoB,WAAW,CAAC,CAAC;AAE3D,MAAM,CAAC,MAAM,EAAE,aAAa,EAAE,aAAa,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,GAAG,IAAI,CAAC;AACjH,eAAe,IAAI,CAAC"}

package/dist/store.d.ts

@@ -0,0 +1,37 @@
+import fs from 'node:fs';
+import { type ListedFile, type ListOptions, OcflStore, type WriteFileData } from '@ocfl/ocfl';
+export interface OcflFsStoreConfig {
+    /** Custom fs module to use for any file operation */
+    fs?: typeof fs | undefined;
+}
+/**
+ * OCFL Object backed by local filesystem
+ */
+declare class OcflFsStore extends OcflStore {
+    static instances: Map<object, OcflFsStore>;
+    fs: typeof fs;
+    /**
+     * Create a new backend store that uses the given fs api.
+     * A typical use case would be a locally mounted file system.
+     */
+    constructor(config?: OcflFsStoreConfig);
+    stat(filePath: string): Promise<fs.Stats>;
+    createReadStream(filePath: string, options?: Parameters<typeof fs.createReadStream>[1]): Promise<fs.ReadStream>;
+    createWriteStream(filePath: string, options?: Parameters<typeof fs.createWriteStream>[1]): Promise<fs.WriteStream>;
+    createReadable(filePath: string, options?: Parameters<typeof fs.createReadStream>[1]): Promise<ReadableStream<any>>;
+    createWritable(filePath: string, options?: Parameters<typeof fs.createWriteStream>[1]): Promise<import("stream/web").WritableStream<any>>;
+    readFile(filePath: string, options: BufferEncoding | {
+        encoding: BufferEncoding;
+    }): Promise<string>;
+    readFile(filePath: string, options?: unknown): Promise<Uint8Array>;
+    writeFile(filePath: string, data: WriteFileData, options?: object | string): Promise<void>;
+    copyFile(source: string, target: string): Promise<void>;
+    opendir(filePath: string, options?: fs.OpenDirOptions): Promise<fs.Dir>;
+    readdir(filePath: string): Promise<string[]>;
+    list(dirPath: string, { encoding, bufferSize, recursive }?: ListOptions): Promise<AsyncGenerator<ListedFile, any, any>>;
+    mkdir(filePath: string, options?: fs.MakeDirectoryOptions): Promise<string | undefined>;
+    move(source: string, target: string): Promise<void>;
+    remove(filePath: string): Promise<void>;
+}
+export { OcflFsStore };
+//# 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,EAAE,MAAM,SAAS,CAAC;AAGzB,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,WAAW,EAAE,SAAS,EAAE,KAAK,aAAa,EAAE,MAAM,YAAY,CAAC;AAE9F,MAAM,WAAW,iBAAiB;IAChC,qDAAqD;IACrD,EAAE,CAAC,EAAE,OAAO,EAAE,GAAG,SAAS,CAAC;CAC5B;AAED;;GAEG;AACH,cAAM,WAAY,SAAQ,SAAS;IACjC,MAAM,CAAC,SAAS,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAa;IAEvD,EAAE,EAAE,OAAO,EAAE,CAAC;IAEd;;;OAGG;IACH,YAAY,MAAM,CAAC,EAAE,iBAAiB,EAGrC;IAEK,IAAI,CAAC,QAAQ,EAAE,MAAM,qBAE1B;IAEK,gBAAgB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,CAAC,OAAO,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,0BAE3F;IAEK,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,CAAC,OAAO,EAAE,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,2BAG7F;IAEK,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,CAAC,OAAO,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,gCAEzF;IAEK,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,UAAU,CAAC,OAAO,EAAE,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,qDAG1F;IAEK,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,GAAG;QAAE,QAAQ,EAAE,cAAc,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACpG,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IAKnE,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,iBAI/E;IAEK,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,iBAG5C;IAEK,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,cAAc,mBAE1D;IAEK,OAAO,CAAC,QAAQ,EAAE,MAAM,qBAE7B;IAEK,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,QAAiB,EAAE,UAAe,EAAE,SAAiB,EAAE,GAAE,WAAgB,iDA8BtG;IAEK,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,GAAE,EAAE,CAAC,oBAA0C,+BAEnF;IAEK,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,iBAWxC;IAEK,MAAM,CAAC,QAAQ,EAAE,MAAM,iBAE5B;CACF;AAED,OAAO,EAAE,WAAW,EAAE,CAAC"}

package/dist/store.js

@@ -0,0 +1,107 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { Readable, Writable } from 'node:stream';
+import { OcflStore } from '@ocfl/ocfl';
+/**
+ * OCFL Object backed by local filesystem
+ */
+class OcflFsStore extends OcflStore {
+    static instances = new Map();
+    fs;
+    /**
+     * Create a new backend store that uses the given fs api.
+     * A typical use case would be a locally mounted file system.
+     */
+    constructor(config) {
+        super();
+        this.fs = config?.fs ?? fs;
+    }
+    async stat(filePath) {
+        return this.fs.promises.stat(filePath);
+    }
+    async createReadStream(filePath, options) {
+        return this.fs.createReadStream(filePath, options);
+    }
+    async createWriteStream(filePath, options) {
+        await this.fs.promises.mkdir(path.dirname(filePath), { recursive: true });
+        return this.fs.createWriteStream(filePath, options);
+    }
+    async createReadable(filePath, options) {
+        return Readable.toWeb(this.fs.createReadStream(filePath, options));
+    }
+    async createWritable(filePath, options) {
+        await this.fs.promises.mkdir(path.dirname(filePath), { recursive: true });
+        return Writable.toWeb(this.fs.createWriteStream(filePath, options));
+    }
+    async readFile(filePath, options) {
+        return this.fs.promises.readFile(filePath, options);
+    }
+    async writeFile(filePath, data, options) {
+        await this.fs.promises.mkdir(path.dirname(filePath), { recursive: true });
+        const content = data instanceof ReadableStream ? Readable.fromWeb(data) : data instanceof ArrayBuffer ? new Uint8Array(data) : data;
+        await this.fs.promises.writeFile(filePath, content, options);
+    }
+    async copyFile(source, target) {
+        await this.fs.promises.mkdir(path.dirname(target), { recursive: true });
+        await this.fs.promises.copyFile(source, target);
+    }
+    async opendir(filePath, options) {
+        return this.fs.promises.opendir(filePath, options);
+    }
+    async readdir(filePath) {
+        return this.fs.promises.readdir(filePath);
+    }
+    async list(dirPath, { encoding = 'utf8', bufferSize = 32, recursive = false } = {}) {
+        const { opendir, stat } = this.fs.promises;
+        const maxBuffer = bufferSize || 1;
+        async function* generator() {
+            const buffer = [];
+            const dirQueue = [opendir(dirPath, { encoding, bufferSize })];
+            for (let dirp = dirQueue.shift(); dirp; dirp = dirQueue.shift()) {
+                const dir = await dirp;
+                for await (const de of dir) {
+                    const cdp = path.join(dir.path, de.name);
+                    if (recursive && de.isDirectory()) {
+                        dirQueue.push(opendir(cdp, { encoding, bufferSize }));
+                    }
+                    else {
+                        const f = stat(cdp).then((stats) => ({
+                            name: de.name,
+                            path: path.relative(dirPath, cdp),
+                            size: stats.size,
+                            lastModified: stats.mtime,
+                        }));
+                        buffer.push(f);
+                        if (buffer.length > maxBuffer) {
+                            // biome-ignore lint/style/noNonNullAssertion: an item was just pushed
+                            yield buffer.shift();
+                        }
+                    }
+                }
+            }
+            yield* buffer;
+        }
+        return generator();
+    }
+    async mkdir(filePath, options = { recursive: true }) {
+        return this.fs.promises.mkdir(filePath, options);
+    }
+    async move(source, target) {
+        try {
+            await this.fs.promises.mkdir(path.dirname(target), { recursive: true });
+            return this.fs.promises.rename(source, target);
+        }
+        catch (error) {
+            if (error instanceof Error && 'code' in error && error.code === 'EXDEV') {
+                await this.fs.promises.cp(source, path.dirname(target), { recursive: true, preserveTimestamps: true });
+                return this.fs.promises.rm(target, { recursive: true, force: true });
+            }
+            throw error;
+        }
+    }
+    async remove(filePath) {
+        return this.fs.promises.rm(filePath, { recursive: true, force: true });
+    }
+}
+export { OcflFsStore };
+//# sourceMappingURL=store.js.map

package/dist/store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"store.js","sourceRoot":"","sources":["../src/store.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,EAAqC,SAAS,EAAsB,MAAM,YAAY,CAAC;AAO9F;;GAEG;AACH,MAAM,WAAY,SAAQ,SAAS;IACjC,MAAM,CAAC,SAAS,GAA6B,IAAI,GAAG,EAAE,CAAC;IAEvD,EAAE,CAAY;IAEd;;;OAGG;IACH,YAAY,MAA0B;QACpC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,EAAE,GAAG,MAAM,EAAE,EAAE,IAAI,EAAE,CAAC;IAC7B,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,QAAgB;QACzB,OAAO,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,QAAgB,EAAE,OAAmD;QAC1F,OAAO,IAAI,CAAC,EAAE,CAAC,gBAAgB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,QAAgB,EAAE,OAAoD;QAC5F,MAAM,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC1E,OAAO,IAAI,CAAC,EAAE,CAAC,iBAAiB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACtD,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,QAAgB,EAAE,OAAmD;QACxF,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,gBAAgB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAmB,CAAC;IACvF,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,QAAgB,EAAE,OAAoD;QACzF,MAAM,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC1E,OAAO,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,iBAAiB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;IACtE,CAAC;IAID,KAAK,CAAC,QAAQ,CAAC,QAAgB,EAAE,OAAiB;QAChD,OAAO,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAqD,CAAC,CAAC;IACpG,CAAC;IAED,KAAK,CAAC,SAAS,CAAC,QAAgB,EAAE,IAAmB,EAAE,OAAyB;QAC9E,MAAM,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC1E,MAAM,OAAO,GAAG,IAAI,YAAY,cAAc,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,YAAY,WAAW,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACpI,MAAM,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE,OAAsD,CAAC,CAAC;IAC9G,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,MAAc,EAAE,MAAc;QAC3C,MAAM,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACxE,MAAM,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClD,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,QAAgB,EAAE,OAA2B;QACzD,OAAO,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACrD,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,QAAgB;QAC5B,OAAO,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC5C,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,OAAe,EAAE,EAAE,QAAQ,GAAG,MAAM,EAAE,UAAU,GAAG,EAAE,EAAE,SAAS,GAAG,KAAK,EAAE,GAAgB,EAAE;QACrG,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC;QAC3C,MAAM,SAAS,GAAG,UAAU,IAAI,CAAC,CAAC;QAClC,KAAK,SAAS,CAAC,CAAC,SAAS;YACvB,MAAM,MAAM,GAA0B,EAAE,CAAC;YACzC,MAAM,QAAQ,GAAG,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;YAC9D,KAAK,IAAI,IAAI,GAAG,QAAQ,CAAC,KAAK,EAAE,EAAE,IAAI,EAAE,IAAI,GAAG,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC;gBAChE,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC;gBACvB,IAAI,KAAK,EAAE,MAAM,EAAE,IAAI,GAAG,EAAE,CAAC;oBAC3B,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;oBACzC,IAAI,SAAS,IAAI,EAAE,CAAC,WAAW,EAAE,EAAE,CAAC;wBAClC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;oBACxD,CAAC;yBAAM,CAAC;wBACN,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;4BACnC,IAAI,EAAE,EAAE,CAAC,IAAI;4BACb,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC;4BACjC,IAAI,EAAE,KAAK,CAAC,IAAI;4BAChB,YAAY,EAAE,KAAK,CAAC,KAAK;yBAC1B,CAAC,CAAC,CAAC;wBACJ,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;wBACf,IAAI,MAAM,CAAC,MAAM,GAAG,SAAS,EAAE,CAAC;4BAC9B,sEAAsE;4BACtE,MAAM,MAAM,CAAC,KAAK,EAAG,CAAC;wBACxB,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;YACD,KAAK,CAAC,CAAC,MAAM,CAAC;QAChB,CAAC;QACD,OAAO,SAAS,EAAE,CAAC;IACrB,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,QAAgB,EAAE,OAAO,GAA4B,EAAE,SAAS,EAAE,IAAI,EAAE;QAClF,OAAO,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,MAAc,EAAE,MAAc;QACvC,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YACxE,OAAO,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACjD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,KAAK,IAAI,MAAM,IAAI,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;gBACxE,MAAM,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,kBAAkB,EAAE,IAAI,EAAE,CAAC,CAAC;gBACvG,OAAO,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;YACvE,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,QAAgB;QAC3B,OAAO,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACzE,CAAC;CACF;AAED,OAAO,EAAE,WAAW,EAAE,CAAC"}

package/package.json

@@ -1,22 +1,7 @@
 {
   "name": "@ocfl/ocfl-fs",
-  "version": "0.4.0",
+  "version": "1.0.0-beta.1",
   "description": "Oxford Common File Layout (OCFL) JS client library for filesystem storage",
-  "main": "index.js",
-  "exports": {
-    ".": [
-      {
-        "import": "./index.mjs",
-        "require": "./index.js",
-        "default": "./index.js"
-      },
-      "./index.js"
-    ]
-  },
-  "scripts": {
-    "test": "mocha",
-    "build-docs": "typedoc --plugin typedoc-plugin-missing-exports"
-  },
   "keywords": [
     "ocfl",
     "Oxford Common File Layout",
@@ -26,28 +11,47 @@
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/Language-Research-Technology/ocfl-js.git"
+    "url": "https://github.com/Language-Research-Technology/ocfl-js",
+    "directory": "ocfl-fs"
   },
+  "license": "GPL-3.0-or-later",
   "author": "Alvin Sebastian (https://orcid.org/0000-0002-9086-1722)",
   "contributors": [
     "Moises Sacal Bonequi (https://orcid.org/0000-0002-4438-2755)",
     "Peter Sefton (https://orcid.org/0000-0002-3545-944X)"
   ],
-  "license": "GPL-3.0-or-later",
-  "devDependencies": {
-    "@ocfl/ocfl-tests": "*",
-    "@types/fs-extra": "^11.0.4",
-    "@types/node": "^24",
-    "mocha": "^11.7.5",
-    "typedoc": "^0.28.19",
-    "typedoc-plugin-missing-exports": "^4.1.2"
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
   },
+  "files": [
+    "dist",
+    "src"
+  ],
   "dependencies": {
-    "@ocfl/ocfl": "0.4.0"
+    "@ocfl/ocfl": "1.0.0-beta.1"
   },
-  "files": [
-    "index.js",
-    "index.mjs",
-    "lib"
-  ]
-}
+  "devDependencies": {
+    "@ocfl/ocfl-tests": "0.0.0",
+    "@types/node": "^22.20.5",
+    "memfs": "^4.80.0",
+    "typescript": "^7.0.2"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "engines": {
+    "node": ">=22.12.0"
+  },
+  "scripts": {
+    "pretest": "pnpm --filter @ocfl/ocfl build",
+    "test": "node --test 'test/**/*.spec.ts'",
+    "build": "tsc",
+    "pretypecheck": "pnpm --filter @ocfl/ocfl build",
+    "typecheck": "tsc --noEmit && tsc -p test"
+  }
+}

package/src/index.ts

@@ -0,0 +1,10 @@
+import { implementOcfl } from '@ocfl/ocfl';
+import { OcflFsStore, type OcflFsStoreConfig } from './store.ts';
+
+export type { OcflFsStoreConfig } from './store.ts';
+export { OcflFsStore } from './store.ts';
+
+const ocfl = implementOcfl<OcflFsStoreConfig>(OcflFsStore);
+
+export const { OCFL_VERSIONS, StorageLayout, createStorage, loadStorage, object, storage, storageLayout } = ocfl;
+export default ocfl;

package/src/store.ts

@@ -0,0 +1,129 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { Readable, Writable } from 'node:stream';
+import { type ListedFile, type ListOptions, OcflStore, type WriteFileData } from '@ocfl/ocfl';
+
+export interface OcflFsStoreConfig {
+  /** Custom fs module to use for any file operation */
+  fs?: typeof fs | undefined;
+}
+
+/**
+ * OCFL Object backed by local filesystem
+ */
+class OcflFsStore extends OcflStore {
+  static instances: Map<object, OcflFsStore> = new Map();
+
+  fs: typeof fs;
+
+  /**
+   * Create a new backend store that uses the given fs api.
+   * A typical use case would be a locally mounted file system.
+   */
+  constructor(config?: OcflFsStoreConfig) {
+    super();
+    this.fs = config?.fs ?? fs;
+  }
+
+  async stat(filePath: string) {
+    return this.fs.promises.stat(filePath);
+  }
+
+  async createReadStream(filePath: string, options?: Parameters<typeof fs.createReadStream>[1]) {
+    return this.fs.createReadStream(filePath, options);
+  }
+
+  async createWriteStream(filePath: string, options?: Parameters<typeof fs.createWriteStream>[1]) {
+    await this.fs.promises.mkdir(path.dirname(filePath), { recursive: true });
+    return this.fs.createWriteStream(filePath, options);
+  }
+
+  async createReadable(filePath: string, options?: Parameters<typeof fs.createReadStream>[1]) {
+    return Readable.toWeb(this.fs.createReadStream(filePath, options)) as ReadableStream;
+  }
+
+  async createWritable(filePath: string, options?: Parameters<typeof fs.createWriteStream>[1]) {
+    await this.fs.promises.mkdir(path.dirname(filePath), { recursive: true });
+    return Writable.toWeb(this.fs.createWriteStream(filePath, options));
+  }
+
+  async readFile(filePath: string, options: BufferEncoding | { encoding: BufferEncoding }): Promise<string>;
+  async readFile(filePath: string, options?: unknown): Promise<Uint8Array>;
+  async readFile(filePath: string, options?: unknown): Promise<string | Uint8Array> {
+    return this.fs.promises.readFile(filePath, options as Parameters<typeof fs.promises.readFile>[1]);
+  }
+
+  async writeFile(filePath: string, data: WriteFileData, options?: object | string) {
+    await this.fs.promises.mkdir(path.dirname(filePath), { recursive: true });
+    const content = data instanceof ReadableStream ? Readable.fromWeb(data) : data instanceof ArrayBuffer ? new Uint8Array(data) : data;
+    await this.fs.promises.writeFile(filePath, content, options as Parameters<typeof fs.promises.writeFile>[2]);
+  }
+
+  async copyFile(source: string, target: string) {
+    await this.fs.promises.mkdir(path.dirname(target), { recursive: true });
+    await this.fs.promises.copyFile(source, target);
+  }
+
+  async opendir(filePath: string, options?: fs.OpenDirOptions) {
+    return this.fs.promises.opendir(filePath, options);
+  }
+
+  async readdir(filePath: string) {
+    return this.fs.promises.readdir(filePath);
+  }
+
+  async list(dirPath: string, { encoding = 'utf8', bufferSize = 32, recursive = false }: ListOptions = {}) {
+    const { opendir, stat } = this.fs.promises;
+    const maxBuffer = bufferSize || 1;
+    async function* generator(): AsyncGenerator<ListedFile> {
+      const buffer: Promise<ListedFile>[] = [];
+      const dirQueue = [opendir(dirPath, { encoding, bufferSize })];
+      for (let dirp = dirQueue.shift(); dirp; dirp = dirQueue.shift()) {
+        const dir = await dirp;
+        for await (const de of dir) {
+          const cdp = path.join(dir.path, de.name);
+          if (recursive && de.isDirectory()) {
+            dirQueue.push(opendir(cdp, { encoding, bufferSize }));
+          } else {
+            const f = stat(cdp).then((stats) => ({
+              name: de.name,
+              path: path.relative(dirPath, cdp),
+              size: stats.size,
+              lastModified: stats.mtime,
+            }));
+            buffer.push(f);
+            if (buffer.length > maxBuffer) {
+              // biome-ignore lint/style/noNonNullAssertion: an item was just pushed
+              yield buffer.shift()!;
+            }
+          }
+        }
+      }
+      yield* buffer;
+    }
+    return generator();
+  }
+
+  async mkdir(filePath: string, options: fs.MakeDirectoryOptions = { recursive: true }) {
+    return this.fs.promises.mkdir(filePath, options);
+  }
+
+  async move(source: string, target: string) {
+    try {
+      await this.fs.promises.mkdir(path.dirname(target), { recursive: true });
+      return this.fs.promises.rename(source, target);
+    } catch (error) {
+      if (error instanceof Error && 'code' in error && error.code === 'EXDEV') {
+        await this.fs.promises.cp(source, path.dirname(target), { recursive: true, preserveTimestamps: true });
+        return this.fs.promises.rm(target, { recursive: true, force: true });
+      }
+      throw error;
+    }
+  }
+
+  async remove(filePath: string) {
+    return this.fs.promises.rm(filePath, { recursive: true, force: true });
+  }
+}
+
+export { OcflFsStore };

package/index.js

@@ -1,14 +0,0 @@
-//@ts-check
-const { OcflFsStore } = require('./lib/store.js');
-const { implementOcfl } = require('@ocfl/ocfl');
-//const { default: ocfl } = require('./index.mjs');
-
-/** @type {import('./lib/store.js').OcflFsStoreConfig} */
-let defaultOptions;
-
-const ocfl = implementOcfl(OcflFsStore, defaultOptions);
-const { OCFL_VERSIONS, StorageLayout, createStorage, loadStorage, object, storage, storageLayout } = ocfl;
-module.exports = {
-  OCFL_VERSIONS, StorageLayout, createStorage, loadStorage, object, storage, storageLayout 
-};
-//module.exports.default = module.exports;

package/index.mjs

@@ -1,4 +0,0 @@
-export * from './index.js'; 
-import * as ocfl from './index.js';
-export default ocfl;
-

package/lib/store.js

@@ -1,156 +0,0 @@
-//@ts-check
-const path = require('path');
-const fs = require('node:fs');
-const { Readable, Writable } = require('node:stream');
-
-const { OcflStore, OcflConstants } = require('@ocfl/ocfl');
-const { opendir } = require('./utils.js');
-const { INVENTORY_NAME } = OcflConstants;
-
-/**
- * @typedef {Object} OcflFsStoreConfig
- * @property {typeof fs} [fs] - Custom fs module to use for any file operation 
- */
-
-/**
- * OCFL Object backed by local filesystem
- */
-class OcflFsStore extends OcflStore {
-  /** @type {Map<Object, OcflFsStore>} */
-  static instances = new Map();
-
-  // static getInstance({fs = require('fs')} = {}) {
-  //   let store = OcflFsStore.instances.get(fs);
-  //   if (!store) {
-  //     store = new OcflFsStore({fs});
-  //     OcflFsStore.instances.set(fs, store);
-  //   }
-  //   return store;
-  // }
-
-  /**
-   * Create a new backend store that uses the given fs api.
-   * A typical use case would be a locally mounted file system.
-   * @param {OcflFsStoreConfig} [config]
-   */
-  constructor(config) {
-    super();
-    this.fs = config?.fs ?? fs;
-  }
-
-  async stat(filePath) {
-    return this.fs.promises.stat(filePath);
-  }
-
-  async createReadStream(filePath, options) {
-    //await this.fs.promises.mkdir(path.dirname(filePath), { recursive: true });
-    return this.fs.createReadStream(filePath, options);
-  }
-
-  async createWriteStream(filePath, options) {
-    await this.fs.promises.mkdir(path.dirname(filePath), { recursive: true });
-    return this.fs.createWriteStream(filePath, options);
-  }
-
-  async createReadable(filePath, options) {
-    return /** @type {ReadableStream} */ (Readable.toWeb(this.fs.createReadStream(filePath, options)));
-  }
-
-  async createWritable(filePath, options) {
-    await this.fs.promises.mkdir(path.dirname(filePath), { recursive: true });
-    return Writable.toWeb(this.fs.createWriteStream(filePath, options));
-  }
-
-  async readFile(filePath, options) {
-    return this.fs.promises.readFile(filePath, options);
-    //if (err.code !== 'ENOENT') throw validation.createError(34, invPath);
-  }
-
-  async writeFile(filePath, data, options) {
-    await this.fs.promises.mkdir(path.dirname(filePath), { recursive: true });
-    if (data instanceof ReadableStream) data = fs.ReadStream.fromWeb(data);
-    await this.fs.promises.writeFile(filePath, data, options);
-  }
-
-  async copyFile(source, target) {
-    await this.fs.promises.mkdir(path.dirname(target), { recursive: true });
-    await this.fs.promises.copyFile(source, target);
-  }
-
-  async opendir(filePath, options) {
-    return this.fs.promises.opendir(filePath, options);
-  }
-
-  async readdir(filePath, options) {
-    return this.fs.promises.readdir(filePath, options);
-  }
-
-  /**
-   * @param {string} dirPath 
-   * @param {OpenDirOptions} [options]
-   * @return {Promise<AsyncIterableIterator<{name: string, path: string, size: number, lastModified: Date}>> }
-   */
-  async list(dirPath, { encoding = 'utf8', bufferSize = 32, recursive = false } = {}) {
-    const {opendir, stat} = this.fs.promises;
-    const maxBuffer = bufferSize || 1;
-    async function* generator() {
-      /** @type Promise<{ name: string, path: string, size: number, lastModified: Date}>[] */
-      let buffer = [];
-      let dirp;
-      const dirQueue = [opendir(dirPath, { encoding, bufferSize })];
-      while (dirp = dirQueue.shift()) {
-        const dir = await dirp;
-        for await (const de of dir) {
-          const cdp = path.join(dir.path, de.name);
-          if (recursive && de.isDirectory()) {
-            dirQueue.push(opendir(cdp, { encoding, bufferSize }));
-          } else {
-            let f = stat(cdp).then(stats => ({
-              name: de.name,
-              path: path.relative(dirPath, cdp),
-              size: stats.size,
-              lastModified: stats.mtime
-            }));
-            if (buffer.length < maxBuffer) {
-              buffer.push(f);
-            } else {
-              yield buffer.shift();
-              buffer.push(f);
-            }
-          }
-        }
-      }
-      let file;
-      while (file = buffer.shift()) {
-        yield file;
-      }
-    }
-    return generator();
-  }
-
-  async mkdir(filePath, options = { recursive: true }) {
-    return this.fs.promises.mkdir(filePath, options);
-  }
-
-  async move(source, target) {
-    try {
-      await this.fs.promises.mkdir(path.dirname(target), { recursive: true });
-      return this.fs.promises.rename(source, target);
-    } catch (error) {
-      if (error.code === 'EXDEV') {
-        await this.fs.promises.cp(source, path.dirname(target), { recursive: true, preserveTimestamps: true });
-        return this.fs.promises.rm(target, { recursive: true, force: true });
-      } else {
-        throw error;
-      }
-    }
-  }
-
-  async remove(filePath) {
-    return this.fs.promises.rm(filePath, { recursive: true, force: true });
-  }
-
-
-};
-
-module.exports = { OcflFsStore };

package/lib/types.d.ts

@@ -1,5 +0,0 @@
-interface OpenDirOptions {
-  encoding?: BufferEncoding | undefined;
-  bufferSize?: number | undefined;
-  recursive?: boolean | undefined;
-}