@ocfl/ocfl/lib/extensions/0002-flat-direct-storage-layout.js

Oxford Common File Layout (OCFL) JS library

const path = require("path");
const { OcflStorageLayout } = require("../extension");
const { EXTENSIONS_DIR } = require("../constants").OcflConstants;

/** @type {FlatDirectStorageLayout} */
var instance;

/**
 * OCFL object identifiers are mapped directly to directory names that are direct children of the OCFL storage root directory.
 */
// @ts-ignore
class FlatDirectStorageLayout extends OcflStorageLayout {
  static get NAME() { return '0002-flat-direct-storage-layout' }
  static get DESCRIPTION() {
    return "OCFL object identifiers are mapped directly to directory names" +
      " that are direct children of the OCFL storage root.";
  }

  static create() {
    if (!instance) instance = new FlatDirectStorageLayout();
    return instance;
  }
  
  constructor() {
    super()
  }

  /**
   * @param {string} id
   * @return {string} 
   */
  map(id) {
    if (path.basename(id) !== id) {
      throw new Error(`The object id <${id}> is incompatible with layout extension ${this.name} because it contains the path separator character.`);
    } else if (id === EXTENSIONS_DIR) {
      throw new Error(`The object id <${id}> is incompatible with layout extension ${this.name} because it conflicts with the extensions directory.`);
    }
    if (id.length > 255) {
      throw new Error(`The object id <${id}> is incompatible with layout extension ${this.name} because it has more than 255 characters.`);
    }

    return id;
  }
}

module.exports = { FlatDirectStorageLayout };