@ocfl/ocfl-fs 0.1.0

package/README.md

@@ -0,0 +1,4 @@
+# ocfl-js - Filesystem storage implementation
+This is JavaScript/Node.js 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.
+

package/index.js

@@ -0,0 +1,10 @@
+//@ts-check
+const { OcflFsStore } = require('./lib/store.js');
+const { Ocfl } = require('ocfl');
+//const { default: ocfl } = require('./index.mjs');
+
+/** @type {import('./lib/store.js').OcflFsStoreConfig} */
+let defaultOptions;
+
+module.exports = new Ocfl(OcflFsStore, defaultOptions);
+//module.exports.default = module.exports;

package/index.mjs

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

package/lib/store.js

@@ -0,0 +1,106 @@
+//@ts-check
+const path = require('path');
+const fs = require('fs');
+const { mkdir, copyFile, rename, unlink } = fs.promises;
+
+const { OcflStore, OcflConstants } = require('ocfl');
+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();
+
+  /**
+   * 
+   * @param {Object} options 
+   * @param {typeof fs} [options.fs]
+   */
+  // 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 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 });
+    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); 
+  }
+
+  async mkdir(filePath, options = { recursive: true }) {
+    return this.fs.promises.mkdir(filePath, options);
+  }
+
+  async move(source, target) {
+    try {
+      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

@@ -0,0 +1,3 @@
+type TestType = {
+  name: string;
+};

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@ocfl/ocfl-fs",
+  "version": "0.1.0",
+  "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-docs2": "typedoc --tsconfig tsconfig.json",
+    "build-docs": "jsdoc -c jsdoc.json"
+  },
+  "keywords": [
+    "ocfl",
+    "Oxford Common File Layout",
+    "preservation",
+    "storage",
+    "filesystem"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Arkisto-Platform/ocfl-js"
+  },
+  "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": {
+    "@types/fs-extra": "^9.0.13",
+    "clean-jsdoc-theme": "^3.3.4",
+    "jsdoc": "^3.6.10",
+    "mocha": "^10.0.0",
+    "typedoc": "^0.22.15",
+    "@ocfl/ocfl-tests": "0.1.0"
+  },
+  "dependencies": {
+    "@ocfl/ocfl": "0.1.0"
+  },
+  "files": [ "index.js", "index.mjs", "lib" ]
+}