@ocfl/ocfl 0.2.0 → 0.3.0

package/lib/utils.js

@@ -6,24 +6,10 @@ const validation = require('./validation.js');
 const { OCFL_VERSIONS, NAMASTE_T } = require('./constants').OcflConstants;
 
 
-/** 
- * @typedef {import('./store').OcflStore} OcflStore
- */
+/** @typedef {import('./store').OcflStore} OcflStore */
+/** @typedef {import('./types.js').OcflVersion} OcflVersion */
+
 
-/**
- * 
- * @param {*} data 
- */
-function dataSourceAsIterable(data) {
-  let d = data;
-  if (ArrayBuffer.isView(data) && data.buffer) {
-    d = Buffer.from(data.buffer);
-  }
-  if (typeof data === 'string' || Buffer.isBuffer(data)) {
-    d = [data];
-  }
-  return d;
-}
 // 
 /**
  * @template T
@@ -69,7 +55,7 @@ async function isDirEmpty(store, dirPath) {
  * Check if there is any valid namaste in the rootPath and return the version number
  * @param {OcflStore} store 
  * @param {string} prefix 
- * @param {string} rootPath 
+ * @param {string} rootPath
  */
 async function findNamasteVersion(store, prefix, rootPath) {
   let namastePath = path.join(rootPath, NAMASTE_T + prefix);
@@ -81,12 +67,57 @@ async function findNamasteVersion(store, prefix, rootPath) {
   } catch (error) {
     if (!error.errors || error.errors.some(e => e.code !== 'ENOENT')) throw error;
   }
-  return version;
+  return /** @type {OcflVersion} */(version);
+}
+
+/** @typedef {ArrayLike<number> & { buffer: ArrayBuffer, byteLength: number, set(array: ArrayLike<number>, offset?: number): void }} TypedArray */
+/**
+ * @param {any} obj 
+ * @returns {obj is TypedArray}
+ */
+function isTypedArray(obj) {
+  return ArrayBuffer.isView(obj) && !(obj instanceof DataView);  
+} 
+
+/**
+ * 
+ * @param {ArrayBuffer|TypedArray} target 
+ * @param {ArrayBuffer|TypedArray} source 
+ * @returns {TypedArray}
+ */
+function joinTypedArray(target, source) {
+  const sourceArray = isTypedArray(source) ? source : new Uint8Array(source);
+  const [targetBuffer, targetArray] = isTypedArray(target) ? [/** @type {ArrayBuffer}*/(target.buffer), target] : [target, new Uint8Array(target)];
+  const targetLength = targetArray.byteLength;
+  const totalSize = targetLength + sourceArray.byteLength;
+  let mergedArray = targetArray;
+  if (targetBuffer.resizable && targetBuffer.maxByteLength >= totalSize) {
+    targetBuffer.resize(totalSize);
+  } else {
+    mergedArray = new Uint8Array(totalSize);
+    mergedArray.set(targetArray, 0);
+  }
+  mergedArray.set(sourceArray, targetLength);
+  return mergedArray;
 }
 
+  /**
+   * 
+   * @param {string} absOrRelPath 
+   * @return {string} 
+   */
+  // toAbsPath(absOrRelPath = '') {
+  //   if (!path.isAbsolute(absOrRelPath)) return path.join(this.root, absOrRelPath);
+  //   return absOrRelPath;
+  // }
+
+
+const testSymbol = Symbol('testSymbol');
+
 module.exports = {
   parallelize,
-  dataSourceAsIterable,
   isDirEmpty,
-  findNamasteVersion
+  findNamasteVersion,
+  joinTypedArray,
+  testSymbol
 };

package/lib/validation.js

@@ -136,7 +136,7 @@ function getWarning(id) {
 
 function genValObj(arr, id) {
   return {
-    code: 'E' + ('' + id).padStart(3, 0),
+    code: 'E' + ('' + id).padStart(3, '0'),
     description: arr[id - 1]
   };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ocfl/ocfl",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Oxford Common File Layout (OCFL) JS library",
   "main": "index.js",
   "exports": {
@@ -15,7 +15,7 @@
   },
   "scripts": {
     "test": "mocha",
-    "build-docs": "jsdoc -c jsdoc.json"
+    "build-docs": "typedoc --plugin typedoc-plugin-missing-exports"
   },
   "keywords": [
     "ocfl",
@@ -25,7 +25,7 @@
   ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/Arkisto-Platform/ocfl-js.git"
+    "url": "git+https://github.com/Language-Research-Technology/ocfl-js.git"
   },
   "author": "Alvin Sebastian (https://orcid.org/0000-0002-9086-1722)",
   "contributors": [
@@ -34,13 +34,16 @@
   ],
   "license": "GPL-3.0-or-later",
   "dependencies": {
-    "blake2": "^4.1.1"
+    "hash-wasm": "^4.12.0",
+    "js-sha512": "^0.9.0"
   },
   "devDependencies": {
-    "@types/mocha": "^9.1.1",
-    "@types/node": "^17.0.33",
-    "typedoc": "^0.23.15",
-    "mocha": "^10.0.0"
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^24",
+    "memfs": "^4.50.0",
+    "mocha": "^11.7.5",
+    "typedoc": "^0.28.15",
+    "typedoc-plugin-missing-exports": "^4.1.2"
   },
   "mocha": {
     "extension": [
@@ -51,9 +54,12 @@
     "recursive": true
   },
   "bugs": {
-    "url": "https://github.com/Arkisto-Platform/ocfl-js/issues"
+    "url": "https://github.com/Language-Research-Technology/ocfl-js/issues"
+  },
+  "homepage": "https://github.com/Language-Research-Technology/ocfl-js#readme",
+  "engines": {
+    "node": ">=18.0.0"
   },
-  "homepage": "https://github.com/Arkisto-Platform/ocfl-js#readme",
   "directories": {
     "lib": "lib",
     "test": "test"

package/lib/extensions/0001-digest-algorithms.js

@@ -1,41 +0,0 @@
-//@ts-check
-
-const {OcflExtension} = require("../extension");
-const crypto = require('crypto');
-const blake2 = require('blake2');
-
-class DigestAlgorithm extends OcflExtension {
-  static get NAME() { return '0001-digest-algorithms' }
-
-  // static create() {
-  //   if (!instance) instance = new DigestAlgorithm();
-  //   return instance;
-  // }
-  /**
-   * 
-   * @param {import('ocfl')} ocfl 
-   */
-  static setup(ocfl) {
-    let {OcflDigest} = ocfl;
-    let { FIXITY } = OcflDigest;
-    class FIXITY_EX extends FIXITY {
-      static blake2b160 = new this('blake2b-160');
-      static blake2b256 = new this('blake2b-256');
-      static blake2b384 = new this('blake2b-384');
-      static ['sha512-256'] = new this('sha512/256');
-    };
-    OcflDigest.FIXITY = FIXITY_EX;
-    //console.log(OcflDigest.FIXITY);
-    for (let len of [160, 256, 384]) {
-      OcflDigest.algorithms['blake2b-' + len] = function() { 
-        return blake2.createHash('blake2b', {digestLength: len/8}); 
-      }
-    }
-    OcflDigest.algorithms['sha512/256'] = function() { 
-      return crypto.createHash('sha512-256'); 
-    }
-    //console.log(OcflDigest.algorithms);
-  }
-}
-
-module.exports = { DigestAlgorithm };

package/lib/temp.js

@@ -1,264 +0,0 @@
-const fs = require('fs-extra');
-const path = require('path');
-const hasha = require('hasha');
-const uuidv5 = require('uuid/v5');
-const _ = require('lodash');
-const DIGEST_ALGORITHM = 'sha512';
-
-class OcflObject {
-
-
-  constructor(path) {
-    this.path = path;
-    this.ocflVersion = '1.0';
-    this.contentVersion = null; // No content yet
-    this.id = null; // Not set yet
-    this.DIGEST_ALGORITHM = DIGEST_ALGORITHM;
-
-  }
-
-  async writeInventories(inv, version) {
-    const main_inv = await fs.writeJson(path.join(this.path, 'inventory.json'), inv, { spaces: 2 });
-    const version_inv = await fs.writeJson(path.join(this.path, version, 'inventory.json'), inv, { spaces: 2 });
-    const inv_hash = await this.hash_file(path.join(this.path, 'inventory.json'))
-    const digest_file_v1 = await fs.writeFile(path.join(this.path, version, 'inventory.json.' + DIGEST_ALGORITHM), inv_hash + "   inventory.json");
-    const digest_file = await fs.writeFile(path.join(this.path, 'inventory.json.' + DIGEST_ALGORITHM), inv_hash + "   inventory.json");
-
-  }
-
-  // addContent is passed an id and a callback - this takes one argument, the
-  // directory into which content is to be written.
-  // This is called for both new and merged versions: the incoming version is
-  // written as v1 of a new object in the deposit directory, and if it's not the
-  // first version it's then merged with the existing most recent version
-
-  async addContent(id, writeContent) {
-    // Copy files into v1
-
-    const version = "v1" // Always a fresh start as we're not touching an existing repo object
-    const versionPath = path.join(this.path, version, "content");
-    await fs.ensureDir(versionPath);
-    await writeContent(versionPath);
-
-    // Make an inventory
-    const inv = await this.inventory(id, versionPath);
-
-    // Put the inventory in the root AND version dir
-    await this.writeInventories(inv, version)
-    this.contentVersion = await this.determineVersion();
-    this.id = id;
-  }
-
-  // preserving the old interface here
-
-  async importDir(id, sourceDir) {
-    await this.addContent(id, async (targetDir) => {
-      await fs.copy(sourceDir, targetDir);
-    })
-  }
-
-
-  async create(path) {
-    // Creates a blank object with a content dir but no content at <path>
-    if (this.path) {
-      throw new Error("This object has already been initialized at: " + this.path)
-    }
-    this.path = path;
-    const stats = await fs.stat(this.path);
-    if (await fs.pathExists(this.path) && stats.isDirectory()) {
-      const readDir = await fs.readdir(this.path);
-      if (readDir.length <= 0) { // empty so initialise an object here
-        const generateNamaste = await this.generateNamaste(this.path, this.ocflVersion);
-      } else {
-          throw new Error('can\'t initialise an object here as there are already files')
-        }
-    } else {
-      //else if it doesnt it dies
-      throw new Error('directory does not exist');
-    }
-  }
-
-  async load(path) {
-    // Tries to load an existing object residing at <path>
-    if (this.path) {
-      throw new Error("This object has already been initialized at: " + this.path)
-    }
-    this.path = path;
-    const stats = await fs.stat(this.path);
-    if (await fs.pathExists(this.path) && stats.isDirectory()) {
-    
-        const ocflVersion = await this.isObject(this.path);
-        if (!ocflVersion) {
-          throw new Error('can\'t initialise an object here as there are already files')
-        }
-    } else {
-      throw new Error(path + ' does not exist or is not a directory');
-    }
-  }
-
-  getVersionString(i) {
-    // Make a version name as per the SHOULD in the spec v1..vn
-    // TODO have an option for zero padding
-    return "v" + i
-  }
-
-  async getInventory() {
-    const inventoryPath = path.join(this.path, "inventory.json");
-    if (await fs.exists(inventoryPath)) {
-      return await JSON.parse(fs.readFileSync(inventoryPath));
-    }
-    else {
-      return null;
-    }
-  }
-
-  async determineVersion() {
-    const inv = await this.getInventory();
-    if (inv) {
-      return inv.head;
-    }
-    else {
-      return null;
-    }
-    // Here's not how to do it: 
-    /* var version = 0;
-    const dirContents = await fs.readdir(this.path);
-    for (let f of dirContents.filter(function(d){return d.match(/^v\d+$/)})){    
-        const v =  parseInt(f.replace("v",""));
-        if (v > version) {
-            version = v;
-        }
-    }
-    return version;10. */
-    // Look at each dir that matches v\d+
-
-  }
-
-  async isObject(aPath) {
-    // TODO: Check if this content root with NAMASTE and returns ocfl version
-    // 0=ocfl_object_1.0
-    // looks at path and see if the content of the file is
-    // TODO: Make this look for a namaste file beginning with 0=ocfl_object_ and extract the version
-    const theFile = path.join(aPath, "0=" + this.nameVersion(this.ocflVersion));
-    return await fs.pathExists(theFile);
-  }
-
-  nameVersion(version) {
-    return 'ocfl_object_' + version;
-  }
-
-  async generateNamaste(aPath, version) {
-    const fileName = '0=' + this.nameVersion(version);
-    const thePath = path.join(aPath, fileName);
-    const writeFile = await fs.writeFile(thePath, this.nameVersion(version));
-    const contentDir = await fs.mkdir(path.join(aPath, "v1"));
-  }
-
-
-  async digest_dir(dir) {
-    var items = {};
-    const contents = await fs.readdir(dir);
-    items = _.flatten(await Promise.all(contents.map(async (p1) => {
-      const p = path.join(dir, p1);
-      const stats = await fs.stat(p);
-      if (stats.isDirectory()) {
-        return await this.digest_dir(p);
-      } else {
-        const h = await this.hash_file(p);
-        return [p, h];
-      }
-    })));
-    return items;
-  }
-
-  async hash_file(p) {
-    const hash = await hasha.fromFile(p, { algorithm: DIGEST_ALGORITHM })
-    return hash;
-  }
-
-
-  async removeEmptyDirectories(folder) {
-    // Remove empty directories
-    // Adapted (nade async) from: https://gist.github.com/jakub-g/5903dc7e4028133704a4
-    if (!folder) {
-      folder = this.path;
-    }
-    const stats = await fs.stat(folder);
-    var isDir = await stats.isDirectory();
-    if (isDir) {
-      var files = await fs.readdir(folder);
-      if (files.length > 0) {
-        for (let f of files) {
-          var fullPath = path.join(folder, f);
-          await this.removeEmptyDirectories(fullPath);
-        }
-        files = await fs.readdir(folder);
-      }
-      if (files.length == 0) {
-        const rm = await fs.rmdir(folder);
-        return;
-      }
-    }
-  }
-
-  async inventory(id, dir) {
-    const versionId = "v1";
-    const inv = {
-      'id': id,
-      'type': 'https://ocfl.io/1.0/spec/#inventory',
-      'digestAlgorithm': DIGEST_ALGORITHM,
-      'head': versionId,
-      'versions': {
-
-      }
-    };
-    inv.versions[versionId] = {
-      "created": new Date().toISOString(),
-      "state": {}
-    }
-    // TODO Message and state keys in version
-    var hashpairs = await this.digest_dir(dir);
-    var versionState = inv.versions[versionId].state;
-    inv['manifest'] = {};
-    for (let i = 0; i < hashpairs.length; i += 2) {
-      const thisHash = hashpairs[i + 1]
-      const thisPath = path.relative(this.path, hashpairs[i])
-      const versionPath = path.relative(path.join("v1", "content"), thisPath)
-      if (!inv['manifest'][thisHash]) {
-        //Store only ONE path
-        inv['manifest'][thisHash] = [thisPath]
-      }
-      else {
-        // TODO DELETE THIS FILE FROM THE OBJECT BEFORE WE STORE IT
-      }
-
-      if (versionState[thisHash]) {
-        // Store all 
-        versionState[thisHash].push(versionPath)
-      }
-      else {
-        versionState[thisHash] = [versionPath]
-
-      }
-
-    }
-    return inv
-  }
-
-  async getFilePath(filePath, version) {
-    const inv = await this.getInventory();
-    if (!version) {
-      version = inv.head;
-    }
-    const state = inv.versions[version].state;
-    for (let hash of Object.keys(state)) {
-      const aPath = state[hash];
-      const findPath = _.find(aPath, (p) => p === filePath);
-      if (findPath) {
-        return inv.manifest[hash][0];
-      }
-    }
-    throw new Error('cannot find file');
-  }
-
-}