@ocfl/ocfl 0.1.2 → 0.2.0

package/index.js

@@ -21,11 +21,12 @@ const { OcflConstants, OcflDigest, OcflExtension, OcflStorageLayout, OcflStore,
 
 /**
  * @typedef {Object} StorageLayout
- * @property {typeof extensions.FlatDirectStorageLayout} [FlatDirectStorageLayout]
- * @property {typeof extensions.FlatOmitPrefixStorageLayout} [FlatOmitPrefixStorageLayout]
- * @property {typeof extensions.HashAndIdNTupleStorageLayout} [HashAndIdNTupleStorageLayout]
- * @property {typeof extensions.HashedNTupleStorageLayout} [HashedNTupleStorageLayout]
- * @property {typeof extensions.NTupleOmitPrefixStorageLayout} [NTupleOmitPrefixStorageLayout]
+ * @property {typeof extensions.FlatDirectStorageLayout} FlatDirectStorageLayout
+ * @property {typeof extensions.FlatOmitPrefixStorageLayout} FlatOmitPrefixStorageLayout
+ * @property {typeof extensions.HashAndIdNTupleStorageLayout} HashAndIdNTupleStorageLayout
+ * @property {typeof extensions.HashedNTupleStorageLayout} HashedNTupleStorageLayout
+ * @property {typeof extensions.NTupleOmitPrefixStorageLayout} NTupleOmitPrefixStorageLayout
+ * @property {typeof extensions.PathDirectStorageLayout} PathDirectStorageLayout
  */
 /** @typedef {import('./lib/extension.js').OcflExtensionConfig} OcflExtensionConfig */
 

package/lib/extension.js

@@ -7,7 +7,7 @@ const { NotImplementedError } = require("./error");
 const extensionByName = {};
 /** Index by extension class name */
 const extensionByClassName = {};
-/** @type {Object.<string, typeof OcflStorageLayout>} */
+
 const storageLayout = {};
 
 /** @typedef {{ extensionName?: string;[key: string]: any; }} OcflExtensionConfig */
@@ -110,7 +110,7 @@ class OcflExtension {
    */
   constructor(config, defaultConfig) {
     /** @type {C} */
-    this.parameters = defaultConfig ? Object.create(/**@type{object}*/(defaultConfig)) : {};
+    this.parameters = typeof defaultConfig === 'object' ? Object.create(/**@type{object}*/(defaultConfig)) : {};
     if (typeof config === 'object') {
       for (let k in config) {
         if (k in defaultConfig) this.parameters[k] = config[k];
@@ -157,7 +157,7 @@ class OcflExtension {
 class OcflStorageLayout extends OcflExtension {
 
   static get layout() {
-    return storageLayout;
+    return /** @type StorageLayout */(storageLayout);
   }
 
   /**

package/lib/extensions/000N-path-direct-storage-layout.js

@@ -0,0 +1,61 @@
+const { OcflStorageLayout } = require("../extension");
+const { OcflDigest } = require("../digest");
+const path = require("path");
+
+const DefaultConfig = {
+  extensionName: '000N-path-direct-storage-layout',
+  omitScheme: false,
+  /** @type {any} */
+  replace: [],
+  suffix: '/__object__'
+};
+
+/** @typedef {Partial<typeof DefaultConfig>} PathDirectStorageLayoutConfig */
+/**
+ * @extends {OcflStorageLayout<typeof DefaultConfig>}
+ */
+class PathDirectStorageLayout extends OcflStorageLayout {
+  static get NAME() { return DefaultConfig.extensionName; }
+  static get DESCRIPTION() {
+    return "OCFL object identifiers are used directly as the path.";
+  }
+
+  /**
+   * 
+   * @param {PathDirectStorageLayoutConfig} [config] 
+   */
+  constructor(config) {
+    super(config, DefaultConfig);
+  }
+
+  /**
+   * @param {string} id
+   * @return {string} 
+   */
+  map(id) {
+    var suffix = this.parameters.suffix;
+    if (suffix && id.endsWith(suffix)) throw new Error(`Identifier cannot end with '${suffix}'`);
+    var p = id ?? '';
+    for (const r of this.parameters.replace) {
+      p = p.replace(r[0], r[1]);
+    }
+    try {
+      let u = new URL(p);
+      let parts = [];
+      if (!this.parameters.omitScheme && u.protocol !== 'file:') {
+        parts.push(u.protocol.replace(':', ''));
+      }
+      if (u.hostname) {
+        parts.push(u.hostname.replace(',', '_').replace(';', '/'));
+      }
+      p = path.join(parts.join('_'), u.pathname + u.search + u.hash);
+    } catch (error) {
+    }
+    p = p.replace(/^\/+/, '').replace(/\/+$/, '');
+    return path.join(p, this.parameters.suffix);
+    //if (/^\w+:/.test(id)) {
+  }
+
+}
+
+module.exports = { PathDirectStorageLayout };

package/lib/extensions/index.js

@@ -6,7 +6,8 @@ module.exports = {
   ...require('./0004-hashed-n-tuple-storage-layout'),
 //  ...require('./0005-mutable-head'),
   ...require('./0006-flat-omit-prefix-storage-layout'),
-  ...require('./0007-n-tuple-omit-prefix-storage-layout')
+  ...require('./0007-n-tuple-omit-prefix-storage-layout'),
+  ...require('./000N-path-direct-storage-layout')
   //...require('./0008-schema-registry')
 };
 //const { DigestAlgorithm } = require('./0001-digest-algorithms.js');

package/lib/object.js

@@ -123,13 +123,19 @@ class OcflObject {
    * Identifier of the OCFL Object
    * @return {string} 
    */
-  get id() { throw new NotImplementedError() }
+  get id() { throw new NotImplementedError(); }
 
   /** 
-  * The non-storage specific absolute path to the root of this OCFL Object
+  * The absolute path to the root of this OCFL Object
   * @return {string} 
   */
-  get root() { throw new NotImplementedError() }
+  get root() { throw new NotImplementedError(); }
+
+  /** 
+  * The absolute path to the temporary workspace of this OCFL Object
+  * @return {string} 
+  */
+  get workspace() { throw new NotImplementedError(); }
 
   toString() { return `OcflObject { root: ${this.root}, id: ${this.id} }`; }
 
@@ -140,7 +146,7 @@ class OcflObject {
    * @param {string} [version] - Full name of the version, eg: v1, v2, v3  
    * @returns {Promise<OcflObjectInventory>}
    */
-  async getInventory(version = 'latest') { throw new NotImplementedError() }
+  async getInventory(version = 'latest') { throw new NotImplementedError(); }
 
   /**
    * Update the content files or directories as one transaction and commit the changes as a new version.
@@ -150,7 +156,7 @@ class OcflObject {
    * @param {ObjectUpdateMode} [mode=UPDATE_MODE.MERGE]
    * @return {Promise<?OcflObjectTransaction>}
    */
-  async update(updater, mode) { throw new NotImplementedError() }
+  async update(updater, mode) { throw new NotImplementedError(); }
 
   /**
    * Import one or more content files or directories to the object 
@@ -225,7 +231,7 @@ class OcflObject {
    * @type { GetFileByLogical & GetFileByOpt }
    */
   // @ts-ignore
-  getFile = function (opt, version) { }
+  getFile = function (opt, version) { };
 
   /**
    * Count the number of files contained in this object
@@ -259,6 +265,8 @@ class OcflObjectImpl extends OcflObject {
   /** @type {string} */
   #root;
   /** @type {string} */
+  #workspace;
+  /** @type {string} */
   #id;
   /** @type {OcflExtension[]} */
   #extensions;
@@ -284,13 +292,14 @@ class OcflObjectImpl extends OcflObject {
     this.digestAlgorithm = DIGEST.of(config.digestAlgorithm || 'sha512');
     if (!this.digestAlgorithm) throw new Error('Invalid digest algorithm. Must be one of `sha256` or `sha512`.');
     //this.fixityDigest = config.fixityDigest ?? this.digestAlgorithm;
-    this.workspace = config.workspace ? path.resolve(config.workspace) : undefined;
+    this.#workspace = config.workspace ? path.resolve(config.workspace) : undefined;
     this.contentDirectory = config.contentDirectory ?? 'content';
     /** @type Object.<string, OcflObjectInventory> */
     this._inventory = {};
   }
   get id() { return this._inventory?.latest?.id || this.#id; }
   get root() { return this.#root; }
+  get workspace() { return this.#workspace; }
 
   async getInventory(version = 'latest') {
     if (!this._inventory[version]) {
@@ -325,7 +334,7 @@ class OcflObjectImpl extends OcflObject {
       OcflDigest.digestAsync(data.digestAlgorithm, datastr)
     ]));
     digest = digest.match(/[^\s]+/)?.[0];
-    if (digest !== actualDigest) throw new Error('corrupted file');
+    if (digest !== actualDigest) throw new Error(`Inventory file ${this.root}/${invPath} digest mismatch: recorded=${digest} actual=${actualDigest}`);
     //return new OcflObjectInventory({ data, digest });
     return new OcflObjectInventory(data);
   }
@@ -374,13 +383,13 @@ class OcflObjectImpl extends OcflObject {
    */
   readFile = async function (relPath, options) {
     return this.#store.readFile(path.join(this.root, relPath), options);
-  }
+  };
 
   getFile = function (opt, version) {
     var obj = this;
     var opt_ = typeof opt === 'string' ? { logicalPath: opt, version: version } : opt;
     return new OcflObjectFile(this, opt_);
-  }
+  };
 
   // async _resolveContentPath({ logicalPath = '', contentPath = '', digest = '', version = '' }) {
   //   if (!contentPath) {
@@ -478,6 +487,7 @@ class OcflObjectImpl extends OcflObject {
       // workspace dir exists, abort update
       throw new Error('Uncommitted changes detected. Object is being updated by other process or there has been a failed update attempt');
     }
+    await this._validateObjectPath();
     let createdDir = await this.#store.mkdir(workspacePath);
     if (!this.workspace) await this._ensureNamaste();
     return createTransactionProxy(new OcflObjectTransactionImpl(this, this.#store, inventory, workspaceVersionPath, createdDir));
@@ -492,16 +502,27 @@ class OcflObjectImpl extends OcflObject {
       return;
     }
     // namaste not found, check if object root is not empty
+    let files;
     try {
-      let files = await this.#store.readdir(this.root);
-      if (files.length > 0) throw new Error('Cannot create an OCFL Object in a non-empty directory');
+      files = await this.#store.readdir(this.root);
     } catch (error) {
     }
+    if (files && files.length > 0) throw new Error('Cannot create an OCFL Object in a non-empty directory');
     //create the namaste file
     let filePath = path.join(this.root, NAMASTE_T + prefix + this.ocflVersion);
     await this.#store.writeFile(filePath, prefix + this.ocflVersion + '\n', 'utf8');
   }
 
+  // all the parent directories cannot be an ocfl object
+  async _validateObjectPath() {
+    var p = this.root;
+    while (p !== '.' && p !== '/' ) {
+      p = path.dirname(p);
+      let nv = await findNamasteVersion(this.#store, NAMASTE_PREFIX_OBJECT, p);
+      if (nv) throw new Error(`Object root cannot be nested under another object ${p}`);
+    }
+  }
+  
   async isObject(aPath) { }
   getVersionString(i) { }
   async determineVersion() { }
@@ -540,7 +561,7 @@ const proxyHandler = {
       }
     }
   }
-}
+};
 
 /**
  * Return any OcflObject implementation as OcflObject.

package/lib/types.d.ts

@@ -42,3 +42,12 @@ interface ReadFile {
       | BufferEncoding
   ): Promise<string>;
 }
+
+type StorageLayout = {
+  FlatDirectStorageLayout: typeof import('./extensions/0002-flat-direct-storage-layout').FlatDirectStorageLayout
+  HashAndIdNTupleStorageLayout: typeof import('./extensions/0003-hash-and-id-n-tuple-storage-layout').HashAndIdNTupleStorageLayout
+  HashedNTupleStorageLayout: typeof import('./extensions/0004-hashed-n-tuple-storage-layout').HashedNTupleStorageLayout
+  FlatOmitPrefixStorageLayout: typeof import('./extensions/0006-flat-omit-prefix-storage-layout').FlatOmitPrefixStorageLayout
+  NTupleOmitPrefixStorageLayout: typeof import('./extensions/0007-n-tuple-omit-prefix-storage-layout').NTupleOmitPrefixStorageLayout
+  PathDirectStorageLayout: typeof import('./extensions/000N-path-direct-storage-layout').PathDirectStorageLayout
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ocfl/ocfl",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "Oxford Common File Layout (OCFL) JS library",
   "main": "index.js",
   "exports": {
@@ -33,11 +33,13 @@
     "Peter Sefton (https://orcid.org/0000-0002-3545-944X)"
   ],
   "license": "GPL-3.0-or-later",
+  "dependencies": {
+    "blake2": "^4.1.1"
+  },
   "devDependencies": {
     "@types/mocha": "^9.1.1",
     "@types/node": "^17.0.33",
-    "clean-jsdoc-theme": "^3.3.4",
-    "jsdoc": "^3.6.10",
+    "typedoc": "^0.23.15",
     "mocha": "^10.0.0"
   },
   "mocha": {
@@ -48,9 +50,6 @@
     ],
     "recursive": true
   },
-  "dependencies": {
-    "blake2": "^4.1.1"
-  },
   "bugs": {
     "url": "https://github.com/Arkisto-Platform/ocfl-js/issues"
   },
@@ -59,5 +58,10 @@
     "lib": "lib",
     "test": "test"
   },
-  "files": [ "index.js", "index.mjs", "lib", "resources" ]
+  "files": [
+    "index.js",
+    "index.mjs",
+    "lib",
+    "resources"
+  ]
 }