@ocfl/ocfl 0.3.0 → 0.4.0

package/lib/file.js

@@ -9,6 +9,14 @@
  * @property {Object.<string, string>} [fixity] - Fixity information of the file.
  */
 
+/**
+ * @typedef {Object} FileStat
+ * @property {number} [size] - Size of the file in bytes.
+ * @property {Date} [atime] - Last access time of the file.
+ * @property {Date} [mtime] - Last modified time of the file.
+ * @property {Date} [ctime] - Creation time of the file.
+ */
+
 /**
  * Represent a file in an OCFL object
  */
@@ -122,6 +130,16 @@ class OcflObjectFile {
   async stream(options) {
     return this.#ocflObject.createReadable(await this.#resolveContentPath(), options);
   }
+
+  /**
+   * Get the file stat info
+   * @param {*} [options] Options to be passed to underlying data store specific implementation
+   * @return {Promise<FileStat>}
+   */
+  async stat(options) {
+    return this.#ocflObject.stat(await this.#resolveContentPath());
+  }
+
 }
 
 module.exports = {

package/lib/object.js

@@ -190,7 +190,7 @@ class OcflObject {
    * @param {*} inventory 
    * @param {*} version 
    */
-  _setInventory(inventory, version='latest') {
+  _setInventory(inventory, version = 'latest') {
     //this._inventory['latest'] = this._inventory[inventory.head] = inventory;
     this._inventory[version] = inventory;
     if (version === 'latest') this._inventory[inventory.head] = inventory;
@@ -347,25 +347,65 @@ class OcflObject {
   }
 
   /**
-   * Get a file by either the [logical path and version], digest, or content path.
+   * Return a file representation by the content path and version,
+   * @param { string } contentPath 
+   * @param { string } [version='latest']
+   */
+  async fileByContentPath(contentPath, version) {
+    const inv = await this.getInventory();
+    const fr = inv?.getFileByContentPath(contentPath, version);
+    if (fr) return new OcflObjectFile(this, fr);
+  };
+
+  /**
+   * Return a file representation by the digest and version,
+   * @param { string } digest 
+   * @param { string } [version='latest']
+   */
+  async fileByDigest(digest, version) {
+    const inv = await this.getInventory();
+    const fr = inv?.getFileByDigest(digest, version);
+    if (fr) return new OcflObjectFile(this, fr);
+  };
+
+  /**
+   * Return a file representation by the logical path and version,
+   * @param { string } logicalPath 
+   * @param { string } [version='latest']
+   */
+  async fileByLogicalPath(logicalPath, version) {
+    const inv = await this.getInventory();
+    const fr = inv?.getFile(logicalPath, version);
+    if (fr) return new OcflObjectFile(this, fr);
+  };
+
+  /**
+   * Return a file representation by either the [logical path and version], digest, or content path. 
+   * The returned file object can be used to retrieve the content of a file either as string, buffer, or stream.
+   * If the object inventory file is not loaded, this file object will not include the full file metadata information.
    * If version is omitted, it defaults to the last version.
    * @param { LogicalPath | FileRefLogical | FileRefDigest | FileRefContent } opt A choice of logical path (eg: 'test') and version (eg: 'v1'), 
    * digest of the file content, or content path (eg: 'v1/content/test')
    * @param {string} [version='latest'] The object version name, eg: 'v1', 'v2'. Default to 'latest'. Only used if opt is a LogicalPath.
-   * @returns {OcflObjectFile}
+   * @param {string} [lazy] If true, always return a file instance even if the object inventory file is not loaded.
    */
-  getFile(opt, version) {
+  getFile(opt, version, lazy) {
     const inv = this.inventory;
     /** @type {any} */
-    let file = typeof opt === 'string' ? { logicalPath: opt, version: version } : { ...opt };
-    if (file.logicalPath) {
-      file = inv?.getFile(file.logicalPath, file.version);
-    } else if (file.digest) {
-      file = inv?.getFileByDigest(file.digest, file.version);
-    } else if (file.contentPath) {
-      file = inv?.getFileByContentPath(file.contentPath, file.version);
+    const file = typeof opt === 'string' ? { logicalPath: opt, version: version } : { ...opt };
+    if (inv) {
+      let fr;
+      if (file.logicalPath) {
+        fr = inv?.getFile(file.logicalPath, file.version);
+      } else if (file.digest) {
+        fr = inv?.getFileByDigest(file.digest, file.version);
+      } else if (file.contentPath) {
+        fr = inv?.getFileByContentPath(file.contentPath, file.version);
+      }
+      if (fr) return new OcflObjectFile(this, fr);
+    } else if (lazy) {
+      return new OcflObjectFile(this, file);
     }
-    if (file) return new OcflObjectFile(this, file);
   };
 
   /**
@@ -407,6 +447,14 @@ class OcflObject {
     return this.#store.readFile(path.join(this.root, relPath), options);
   };
 
+  /** 
+   * Get the file metadata such as size and modification time.
+   * @param {string} relPath - The file path relative to the object root.
+   */
+  async stat(relPath) {
+    return this.#store.stat(path.join(this.root, relPath));
+  };
+
   toString() { return `OcflObject { root: ${this.root}, id: ${this.id} }`; }
 
   toJSON() { return { root: this.root, id: this.id }; }

package/lib/utils.js

@@ -1,8 +1,7 @@
 //@ts-check
 'use strict';
 
-const path = require('path');
-const validation = require('./validation.js');
+//const validation = require('./validation.js');
 const { OCFL_VERSIONS, NAMASTE_T } = require('./constants').OcflConstants;
 
 
@@ -58,7 +57,7 @@ async function isDirEmpty(store, dirPath) {
  * @param {string} rootPath
  */
 async function findNamasteVersion(store, prefix, rootPath) {
-  let namastePath = path.join(rootPath, NAMASTE_T + prefix);
+  let namastePath = rootPath + '/' + NAMASTE_T + prefix;
   let version;
   try {
     version = await Promise.any(OCFL_VERSIONS.map(async (v) =>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ocfl/ocfl",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Oxford Common File Layout (OCFL) JS library",
   "main": "index.js",
   "exports": {
@@ -15,6 +15,7 @@
   },
   "scripts": {
     "test": "mocha",
+    "build": "tsc",
     "build-docs": "typedoc --plugin typedoc-plugin-missing-exports"
   },
   "keywords": [
@@ -39,10 +40,10 @@
   },
   "devDependencies": {
     "@types/mocha": "^10.0.10",
-    "@types/node": "^24",
+    "@types/node": "^24.12.2",
     "memfs": "^4.50.0",
     "mocha": "^11.7.5",
-    "typedoc": "^0.28.15",
+    "typedoc": "^0.28.19",
     "typedoc-plugin-missing-exports": "^4.1.2"
   },
   "mocha": {
@@ -57,9 +58,6 @@
     "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"
-  },
   "directories": {
     "lib": "lib",
     "test": "test"
@@ -69,5 +67,8 @@
     "index.mjs",
     "lib",
     "resources"
-  ]
+  ],
+  "engines": {
+    "node": ">=18.0.0"
+  }
 }