@ocfl/ocfl-fs 0.2.2 → 0.4.0

package/index.js

@@ -1,10 +1,14 @@
 //@ts-check
 const { OcflFsStore } = require('./lib/store.js');
-const { Ocfl } = require('@ocfl/ocfl');
+const { implementOcfl } = require('@ocfl/ocfl');
 //const { default: ocfl } = require('./index.mjs');
 
 /** @type {import('./lib/store.js').OcflFsStoreConfig} */
 let defaultOptions;
 
-module.exports = new Ocfl(OcflFsStore, 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,3 +1,4 @@
 export * from './index.js'; 
-import ocfl from './index.js';
+import * as ocfl from './index.js';
 export default ocfl;
+

package/lib/store.js

@@ -53,7 +53,7 @@ class OcflFsStore extends OcflStore {
   }
 
   async createReadable(filePath, options) {
-    return Readable.toWeb(this.fs.createReadStream(filePath, options));
+    return /** @type {ReadableStream} */ (Readable.toWeb(this.fs.createReadStream(filePath, options)));
   }
 
   async createWritable(filePath, options) {
@@ -68,6 +68,7 @@ class OcflFsStore extends OcflStore {
 
   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);
   }
 
@@ -133,6 +134,7 @@ class OcflFsStore extends OcflStore {
 
   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') {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ocfl/ocfl-fs",
-  "version": "0.2.2",
+  "version": "0.4.0",
   "description": "Oxford Common File Layout (OCFL) JS client library for filesystem storage",
   "main": "index.js",
   "exports": {
@@ -15,8 +15,7 @@
   },
   "scripts": {
     "test": "mocha",
-    "build-docs2": "typedoc --tsconfig tsconfig.json",
-    "build-docs": "jsdoc -c jsdoc.json"
+    "build-docs": "typedoc --plugin typedoc-plugin-missing-exports"
   },
   "keywords": [
     "ocfl",
@@ -27,7 +26,7 @@
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/Arkisto-Platform/ocfl-js"
+    "url": "https://github.com/Language-Research-Technology/ocfl-js.git"
   },
   "author": "Alvin Sebastian (https://orcid.org/0000-0002-9086-1722)",
   "contributors": [
@@ -36,16 +35,15 @@
   ],
   "license": "GPL-3.0-or-later",
   "devDependencies": {
-    "@types/fs-extra": "^9.0.13",
-    "@types/node": "^18",
-    "clean-jsdoc-theme": "^4.3.0",
-    "jsdoc": "^4.0.3",
-    "mocha": "^10.7.3",
-    "typedoc": "^0.22.15",
-    "@ocfl/ocfl-tests": "*"
+    "@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"
   },
   "dependencies": {
-    "@ocfl/ocfl": "0.2.2"
+    "@ocfl/ocfl": "0.4.0"
   },
   "files": [
     "index.js",