@ocfl/ocfl 0.4.0 → 1.0.0-beta.1

package/dist/extensions/0002-flat-direct-storage-layout.d.ts

@@ -0,0 +1,12 @@
+import { OcflStorageLayout } from '../extension.ts';
+/**
+ * OCFL object identifiers are mapped directly to directory names that are direct children of the OCFL storage root directory.
+ */
+declare class FlatDirectStorageLayout extends OcflStorageLayout {
+    static get NAME(): string;
+    static get DESCRIPTION(): string;
+    static create<T>(): T;
+    map(id: string): string;
+}
+export { FlatDirectStorageLayout };
+//# sourceMappingURL=0002-flat-direct-storage-layout.d.ts.map

package/dist/extensions/0002-flat-direct-storage-layout.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"0002-flat-direct-storage-layout.d.ts","sourceRoot":"","sources":["../../src/extensions/0002-flat-direct-storage-layout.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAMpD;;GAEG;AACH,cAAM,uBAAwB,SAAQ,iBAAiB;IACrD,MAAM,KAAK,IAAI,WAEd;IACD,MAAM,KAAK,WAAW,WAErB;IAED,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,CAGpB;IAED,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAWtB;CACF;AAED,OAAO,EAAE,uBAAuB,EAAE,CAAC"}

package/dist/extensions/0002-flat-direct-storage-layout.js

@@ -0,0 +1,34 @@
+import path from 'node:path';
+import { OcflConstants } from '../constants.js';
+import { OcflStorageLayout } from '../extension.js';
+const { EXTENSIONS_DIR } = OcflConstants;
+let instance;
+/**
+ * OCFL object identifiers are mapped directly to directory names that are direct children of the OCFL storage root directory.
+ */
+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() {
+        instance ??= new FlatDirectStorageLayout();
+        return instance;
+    }
+    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;
+    }
+}
+export { FlatDirectStorageLayout };
+//# sourceMappingURL=0002-flat-direct-storage-layout.js.map

package/dist/extensions/0002-flat-direct-storage-layout.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"0002-flat-direct-storage-layout.js","sourceRoot":"","sources":["../../src/extensions/0002-flat-direct-storage-layout.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEpD,MAAM,EAAE,cAAc,EAAE,GAAG,aAAa,CAAC;AAEzC,IAAI,QAAiC,CAAC;AAEtC;;GAEG;AACH,MAAM,uBAAwB,SAAQ,iBAAiB;IACrD,MAAM,KAAK,IAAI;QACb,OAAO,iCAAiC,CAAC;IAC3C,CAAC;IACD,MAAM,KAAK,WAAW;QACpB,OAAO,gEAAgE,GAAG,qDAAqD,CAAC;IAClI,CAAC;IAED,MAAM,CAAC,MAAM;QACX,QAAQ,KAAK,IAAI,uBAAuB,EAAE,CAAC;QAC3C,OAAO,QAAa,CAAC;IACvB,CAAC;IAED,GAAG,CAAC,EAAU;QACZ,IAAI,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC;YAC7B,MAAM,IAAI,KAAK,CAAC,kBAAkB,EAAE,2CAA2C,IAAI,CAAC,IAAI,oDAAoD,CAAC,CAAC;QAChJ,CAAC;aAAM,IAAI,EAAE,KAAK,cAAc,EAAE,CAAC;YACjC,MAAM,IAAI,KAAK,CAAC,kBAAkB,EAAE,2CAA2C,IAAI,CAAC,IAAI,sDAAsD,CAAC,CAAC;QAClJ,CAAC;QACD,IAAI,EAAE,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,kBAAkB,EAAE,2CAA2C,IAAI,CAAC,IAAI,2CAA2C,CAAC,CAAC;QACvI,CAAC;QAED,OAAO,EAAE,CAAC;IACZ,CAAC;CACF;AAED,OAAO,EAAE,uBAAuB,EAAE,CAAC"}

package/dist/extensions/0003-hash-and-id-n-tuple-storage-layout.d.ts

@@ -0,0 +1,15 @@
+import { OcflStorageLayout } from '../extension.ts';
+declare const DefaultConfig: {
+    extensionName: string;
+    digestAlgorithm: string;
+    tupleSize: number;
+    numberOfTuples: number;
+};
+declare class HashAndIdNTupleStorageLayout extends OcflStorageLayout<typeof DefaultConfig> {
+    static get NAME(): string;
+    static get DESCRIPTION(): string;
+    constructor(config?: Partial<typeof DefaultConfig>);
+    map(id: string): string;
+}
+export { HashAndIdNTupleStorageLayout };
+//# sourceMappingURL=0003-hash-and-id-n-tuple-storage-layout.d.ts.map

package/dist/extensions/0003-hash-and-id-n-tuple-storage-layout.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"0003-hash-and-id-n-tuple-storage-layout.d.ts","sourceRoot":"","sources":["../../src/extensions/0003-hash-and-id-n-tuple-storage-layout.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAMpD,QAAA,MAAM,aAAa;IACjB,aAAa;IACb,eAAe;IACf,SAAS;IACT,cAAc;CACf,CAAC;AAEF,cAAM,4BAA6B,SAAQ,iBAAiB,CAAC,OAAO,aAAa,CAAC;IAChF,MAAM,KAAK,IAAI,WAEd;IACD,MAAM,KAAK,WAAW,WAOrB;IAED,YAAY,MAAM,CAAC,EAAE,OAAO,CAAC,OAAO,aAAa,CAAC,EAWjD;IAED,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAWtB;CACF;AAED,OAAO,EAAE,4BAA4B,EAAE,CAAC"}

package/dist/extensions/0003-hash-and-id-n-tuple-storage-layout.js

@@ -0,0 +1,49 @@
+import path from 'node:path';
+import { OcflDigest } from '../digest.js';
+import { OcflStorageLayout } from '../extension.js';
+function encodeIdentifier(id) {
+    return encodeURIComponent(id).toLowerCase().replace(/\./g, '%2e');
+}
+const DefaultConfig = {
+    extensionName: '0003-hash-and-id-n-tuple-storage-layout',
+    digestAlgorithm: 'sha256',
+    tupleSize: 3,
+    numberOfTuples: 3,
+};
+class HashAndIdNTupleStorageLayout extends OcflStorageLayout {
+    static get NAME() {
+        return DefaultConfig.extensionName;
+    }
+    static get DESCRIPTION() {
+        return ('OCFL object identifiers are hashed and encoded as lowercase hex strings.' +
+            ' These digests are then divided into N n-tuple segments,' +
+            ' which are used to create nested paths under the OCFL storage root.' +
+            ' Finally, the OCFL object identifier is percent-encoded to create a directory name for the OCFL object root.');
+    }
+    constructor(config) {
+        super(config, DefaultConfig);
+        const c = this.parameters;
+        const digestLength = OcflDigest.getHexDigestLength(c.digestAlgorithm);
+        if (!digestLength) {
+            throw new Error('Invalid digestAlgorithm');
+        }
+        const p = c.numberOfTuples * c.tupleSize;
+        if (p > digestLength) {
+            throw new Error('Product of numberOfTuples and tupleSize is greater than the number of characters in the hex encoded digest.');
+        }
+    }
+    map(id) {
+        const digest = OcflDigest.digestSync(this.parameters.digestAlgorithm, id);
+        const segments = [];
+        const s = this.parameters.tupleSize;
+        const n = this.parameters.numberOfTuples;
+        let i;
+        for (i = 0; i < n; ++i) {
+            segments.push(digest.slice(s * i, s * i + s));
+        }
+        segments.push(encodeIdentifier(id));
+        return segments.join(path.sep);
+    }
+}
+export { HashAndIdNTupleStorageLayout };
+//# sourceMappingURL=0003-hash-and-id-n-tuple-storage-layout.js.map

package/dist/extensions/0003-hash-and-id-n-tuple-storage-layout.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"0003-hash-and-id-n-tuple-storage-layout.js","sourceRoot":"","sources":["../../src/extensions/0003-hash-and-id-n-tuple-storage-layout.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEpD,SAAS,gBAAgB,CAAC,EAAU;IAClC,OAAO,kBAAkB,CAAC,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AACpE,CAAC;AAED,MAAM,aAAa,GAAG;IACpB,aAAa,EAAE,yCAAyC;IACxD,eAAe,EAAE,QAAQ;IACzB,SAAS,EAAE,CAAC;IACZ,cAAc,EAAE,CAAC;CAClB,CAAC;AAEF,MAAM,4BAA6B,SAAQ,iBAAuC;IAChF,MAAM,KAAK,IAAI;QACb,OAAO,aAAa,CAAC,aAAa,CAAC;IACrC,CAAC;IACD,MAAM,KAAK,WAAW;QACpB,OAAO,CACL,0EAA0E;YAC1E,0DAA0D;YAC1D,qEAAqE;YACrE,8GAA8G,CAC/G,CAAC;IACJ,CAAC;IAED,YAAY,MAAsC;QAChD,KAAK,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;QAC7B,MAAM,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC;QAC1B,MAAM,YAAY,GAAG,UAAU,CAAC,kBAAkB,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC;QACtE,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC7C,CAAC;QACD,MAAM,CAAC,GAAG,CAAC,CAAC,cAAc,GAAG,CAAC,CAAC,SAAS,CAAC;QACzC,IAAI,CAAC,GAAG,YAAY,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,6GAA6G,CAAC,CAAC;QACjI,CAAC;IACH,CAAC;IAED,GAAG,CAAC,EAAU;QACZ,MAAM,MAAM,GAAG,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;QAC1E,MAAM,QAAQ,GAAG,EAAE,CAAC;QACpB,MAAM,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;QACpC,MAAM,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;QACzC,IAAI,CAAS,CAAC;QACd,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC;YACvB,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAChD,CAAC;QACD,QAAQ,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC,CAAC;QACpC,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACjC,CAAC;CACF;AAED,OAAO,EAAE,4BAA4B,EAAE,CAAC"}

package/dist/extensions/0004-hashed-n-tuple-storage-layout.d.ts

@@ -0,0 +1,17 @@
+import { OcflStorageLayout } from '../extension.ts';
+declare const DefaultConfig: {
+    extensionName: string;
+    digestAlgorithm: string;
+    tupleSize: number;
+    numberOfTuples: number;
+    shortObjectRoot: boolean;
+};
+export type HashedNTupleStorageLayoutConfig = Partial<typeof DefaultConfig>;
+declare class HashedNTupleStorageLayout extends OcflStorageLayout<typeof DefaultConfig> {
+    static get NAME(): string;
+    static get DESCRIPTION(): string;
+    constructor(config?: HashedNTupleStorageLayoutConfig);
+    map(id: string): string;
+}
+export { HashedNTupleStorageLayout };
+//# sourceMappingURL=0004-hashed-n-tuple-storage-layout.d.ts.map

package/dist/extensions/0004-hashed-n-tuple-storage-layout.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"0004-hashed-n-tuple-storage-layout.d.ts","sourceRoot":"","sources":["../../src/extensions/0004-hashed-n-tuple-storage-layout.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEpD,QAAA,MAAM,aAAa;IACjB,aAAa;IACb,eAAe;IACf,SAAS;IACT,cAAc;IACd,eAAe;CAChB,CAAC;AACF,MAAM,MAAM,+BAA+B,GAAG,OAAO,CAAC,OAAO,aAAa,CAAC,CAAC;AAE5E,cAAM,yBAA0B,SAAQ,iBAAiB,CAAC,OAAO,aAAa,CAAC;IAC7E,MAAM,KAAK,IAAI,WAEd;IACD,MAAM,KAAK,WAAW,WAMrB;IAED,YAAY,MAAM,CAAC,EAAE,+BAA+B,EAanD;IAED,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAetB;CACF;AAED,OAAO,EAAE,yBAAyB,EAAE,CAAC"}

package/dist/extensions/0004-hashed-n-tuple-storage-layout.js

@@ -0,0 +1,54 @@
+import path from 'node:path';
+import { OcflDigest } from '../digest.js';
+import { OcflStorageLayout } from '../extension.js';
+const DefaultConfig = {
+    extensionName: '0004-hashed-n-tuple-storage-layout',
+    digestAlgorithm: 'sha256',
+    tupleSize: 3,
+    numberOfTuples: 3,
+    shortObjectRoot: false,
+};
+class HashedNTupleStorageLayout extends OcflStorageLayout {
+    static get NAME() {
+        return DefaultConfig.extensionName;
+    }
+    static get DESCRIPTION() {
+        return ('OCFL object identifiers are hashed and encoded as lowercase hex strings.' +
+            ' These digests are then divided into N n-tuple segments,' +
+            ' which are used to create nested paths under the OCFL storage root.');
+    }
+    constructor(config) {
+        super(config, DefaultConfig);
+        const c = this.parameters;
+        const digestLength = OcflDigest.getHexDigestLength(c.digestAlgorithm);
+        if (!digestLength) {
+            throw new Error('Invalid digestAlgorithm');
+        }
+        const p = c.numberOfTuples * c.tupleSize;
+        if (p > digestLength) {
+            throw new Error('Product of numberOfTuples and tupleSize is greater than the number of characters in the hex encoded digest.');
+        }
+        else if (p === digestLength && c.shortObjectRoot) {
+            throw new Error('shortObjectRoot cannot be set to true');
+        }
+    }
+    map(id) {
+        const digest = OcflDigest.digestSync(this.parameters.digestAlgorithm, id);
+        const segments = [];
+        const s = this.parameters.tupleSize;
+        const n = this.parameters.numberOfTuples;
+        let i;
+        for (i = 0; i < n; ++i) {
+            segments.push(digest.slice(s * i, s * i + s));
+        }
+        if (this.parameters.shortObjectRoot) {
+            segments.push(digest.slice(s * i));
+        }
+        else {
+            segments.push(digest);
+        }
+        return segments.join(path.sep);
+    }
+}
+export { HashedNTupleStorageLayout };
+//# sourceMappingURL=0004-hashed-n-tuple-storage-layout.js.map

package/dist/extensions/0004-hashed-n-tuple-storage-layout.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"0004-hashed-n-tuple-storage-layout.js","sourceRoot":"","sources":["../../src/extensions/0004-hashed-n-tuple-storage-layout.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEpD,MAAM,aAAa,GAAG;IACpB,aAAa,EAAE,oCAAoC;IACnD,eAAe,EAAE,QAAQ;IACzB,SAAS,EAAE,CAAC;IACZ,cAAc,EAAE,CAAC;IACjB,eAAe,EAAE,KAAK;CACvB,CAAC;AAGF,MAAM,yBAA0B,SAAQ,iBAAuC;IAC7E,MAAM,KAAK,IAAI;QACb,OAAO,aAAa,CAAC,aAAa,CAAC;IACrC,CAAC;IACD,MAAM,KAAK,WAAW;QACpB,OAAO,CACL,0EAA0E;YAC1E,0DAA0D;YAC1D,qEAAqE,CACtE,CAAC;IACJ,CAAC;IAED,YAAY,MAAwC;QAClD,KAAK,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;QAC7B,MAAM,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC;QAC1B,MAAM,YAAY,GAAG,UAAU,CAAC,kBAAkB,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC;QACtE,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;QAC7C,CAAC;QACD,MAAM,CAAC,GAAG,CAAC,CAAC,cAAc,GAAG,CAAC,CAAC,SAAS,CAAC;QACzC,IAAI,CAAC,GAAG,YAAY,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,6GAA6G,CAAC,CAAC;QACjI,CAAC;aAAM,IAAI,CAAC,KAAK,YAAY,IAAI,CAAC,CAAC,eAAe,EAAE,CAAC;YACnD,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC;IAED,GAAG,CAAC,EAAU;QACZ,MAAM,MAAM,GAAG,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;QAC1E,MAAM,QAAQ,GAAG,EAAE,CAAC;QACpB,MAAM,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;QACpC,MAAM,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;QACzC,IAAI,CAAS,CAAC;QACd,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC;YACvB,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QAChD,CAAC;QACD,IAAI,IAAI,CAAC,UAAU,CAAC,eAAe,EAAE,CAAC;YACpC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACrC,CAAC;aAAM,CAAC;YACN,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACxB,CAAC;QACD,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACjC,CAAC;CACF;AAED,OAAO,EAAE,yBAAyB,EAAE,CAAC"}

package/dist/extensions/0006-flat-omit-prefix-storage-layout.d.ts

@@ -0,0 +1,6 @@
+import { OcflStorageLayout } from '../extension.ts';
+declare class FlatOmitPrefixStorageLayout extends OcflStorageLayout {
+    static get NAME(): string;
+}
+export { FlatOmitPrefixStorageLayout };
+//# sourceMappingURL=0006-flat-omit-prefix-storage-layout.d.ts.map

package/dist/extensions/0006-flat-omit-prefix-storage-layout.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"0006-flat-omit-prefix-storage-layout.d.ts","sourceRoot":"","sources":["../../src/extensions/0006-flat-omit-prefix-storage-layout.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEpD,cAAM,2BAA4B,SAAQ,iBAAiB;IACzD,MAAM,KAAK,IAAI,WAEd;CACF;AAED,OAAO,EAAE,2BAA2B,EAAE,CAAC"}

package/dist/extensions/0006-flat-omit-prefix-storage-layout.js

@@ -0,0 +1,8 @@
+import { OcflStorageLayout } from '../extension.js';
+class FlatOmitPrefixStorageLayout extends OcflStorageLayout {
+    static get NAME() {
+        return '0006-flat-omit-prefix-storage-layout';
+    }
+}
+export { FlatOmitPrefixStorageLayout };
+//# sourceMappingURL=0006-flat-omit-prefix-storage-layout.js.map

package/dist/extensions/0006-flat-omit-prefix-storage-layout.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"0006-flat-omit-prefix-storage-layout.js","sourceRoot":"","sources":["../../src/extensions/0006-flat-omit-prefix-storage-layout.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEpD,MAAM,2BAA4B,SAAQ,iBAAiB;IACzD,MAAM,KAAK,IAAI;QACb,OAAO,sCAAsC,CAAC;IAChD,CAAC;CACF;AAED,OAAO,EAAE,2BAA2B,EAAE,CAAC"}

package/dist/extensions/0007-n-tuple-omit-prefix-storage-layout.d.ts

@@ -0,0 +1,6 @@
+import { OcflStorageLayout } from '../extension.ts';
+declare class NTupleOmitPrefixStorageLayout extends OcflStorageLayout {
+    static get NAME(): string;
+}
+export { NTupleOmitPrefixStorageLayout };
+//# sourceMappingURL=0007-n-tuple-omit-prefix-storage-layout.d.ts.map

package/dist/extensions/0007-n-tuple-omit-prefix-storage-layout.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"0007-n-tuple-omit-prefix-storage-layout.d.ts","sourceRoot":"","sources":["../../src/extensions/0007-n-tuple-omit-prefix-storage-layout.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEpD,cAAM,6BAA8B,SAAQ,iBAAiB;IAC3D,MAAM,KAAK,IAAI,WAEd;CACF;AAED,OAAO,EAAE,6BAA6B,EAAE,CAAC"}

package/dist/extensions/0007-n-tuple-omit-prefix-storage-layout.js

@@ -0,0 +1,8 @@
+import { OcflStorageLayout } from '../extension.js';
+class NTupleOmitPrefixStorageLayout extends OcflStorageLayout {
+    static get NAME() {
+        return '0007-n-tuple-omit-prefix-storage-layout';
+    }
+}
+export { NTupleOmitPrefixStorageLayout };
+//# sourceMappingURL=0007-n-tuple-omit-prefix-storage-layout.js.map

package/dist/extensions/0007-n-tuple-omit-prefix-storage-layout.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"0007-n-tuple-omit-prefix-storage-layout.js","sourceRoot":"","sources":["../../src/extensions/0007-n-tuple-omit-prefix-storage-layout.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEpD,MAAM,6BAA8B,SAAQ,iBAAiB;IAC3D,MAAM,KAAK,IAAI;QACb,OAAO,yCAAyC,CAAC;IACnD,CAAC;CACF;AAED,OAAO,EAAE,6BAA6B,EAAE,CAAC"}

package/dist/extensions/0009-digest-algorithms.d.ts

@@ -0,0 +1,9 @@
+import { OcflExtension } from '../extension.ts';
+/**
+ * Notes: this implementation does nothing because the 0009 extension is implemented directly in the OcflDigest class.
+ */
+declare class DigestAlgorithm extends OcflExtension {
+    static get NAME(): string;
+}
+export { DigestAlgorithm };
+//# sourceMappingURL=0009-digest-algorithms.d.ts.map

package/dist/extensions/0009-digest-algorithms.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"0009-digest-algorithms.d.ts","sourceRoot":"","sources":["../../src/extensions/0009-digest-algorithms.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD;;GAEG;AACH,cAAM,eAAgB,SAAQ,aAAa;IACzC,MAAM,KAAK,IAAI,WAEd;CACF;AAED,OAAO,EAAE,eAAe,EAAE,CAAC"}

package/dist/extensions/0009-digest-algorithms.js

@@ -0,0 +1,11 @@
+import { OcflExtension } from '../extension.js';
+/**
+ * Notes: this implementation does nothing because the 0009 extension is implemented directly in the OcflDigest class.
+ */
+class DigestAlgorithm extends OcflExtension {
+    static get NAME() {
+        return '0009-digest-algorithms';
+    }
+}
+export { DigestAlgorithm };
+//# sourceMappingURL=0009-digest-algorithms.js.map

package/dist/extensions/0009-digest-algorithms.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"0009-digest-algorithms.js","sourceRoot":"","sources":["../../src/extensions/0009-digest-algorithms.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAEhD;;GAEG;AACH,MAAM,eAAgB,SAAQ,aAAa;IACzC,MAAM,KAAK,IAAI;QACb,OAAO,wBAAwB,CAAC;IAClC,CAAC;CACF;AAED,OAAO,EAAE,eAAe,EAAE,CAAC"}

package/dist/extensions/000N-path-direct-storage-layout.d.ts

@@ -0,0 +1,16 @@
+import { OcflStorageLayout } from '../extension.ts';
+declare const DefaultConfig: {
+    extensionName: string;
+    omitScheme: boolean;
+    replace: [string | RegExp, string][];
+    suffix: string;
+};
+export type PathDirectStorageLayoutConfig = Partial<typeof DefaultConfig>;
+declare class PathDirectStorageLayout extends OcflStorageLayout<typeof DefaultConfig> {
+    static get NAME(): string;
+    static get DESCRIPTION(): string;
+    constructor(config?: PathDirectStorageLayoutConfig);
+    map(id: string): string;
+}
+export { PathDirectStorageLayout };
+//# sourceMappingURL=000N-path-direct-storage-layout.d.ts.map

package/dist/extensions/000N-path-direct-storage-layout.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"000N-path-direct-storage-layout.d.ts","sourceRoot":"","sources":["../../src/extensions/000N-path-direct-storage-layout.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEpD,QAAA,MAAM,aAAa;IACjB,aAAa;IACb,UAAU;IACV,OAAO,EAAQ,CAAC,MAAM,GAAG,MAAM,EAAE,MAAM,CAAC,EAAE;IAC1C,MAAM;CACP,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG,OAAO,CAAC,OAAO,aAAa,CAAC,CAAC;AAE1E,cAAM,uBAAwB,SAAQ,iBAAiB,CAAC,OAAO,aAAa,CAAC;IAC3E,MAAM,KAAK,IAAI,WAEd;IACD,MAAM,KAAK,WAAW,WAErB;IAED,YAAY,MAAM,CAAC,EAAE,6BAA6B,EAEjD;IAED,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,CAuBtB;CACF;AAED,OAAO,EAAE,uBAAuB,EAAE,CAAC"}

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

@@ -0,0 +1,46 @@
+import path from 'node:path';
+import { OcflStorageLayout } from '../extension.js';
+const DefaultConfig = {
+    extensionName: '000N-path-direct-storage-layout',
+    omitScheme: false,
+    replace: [],
+    suffix: '/__object__',
+};
+class PathDirectStorageLayout extends OcflStorageLayout {
+    static get NAME() {
+        return DefaultConfig.extensionName;
+    }
+    static get DESCRIPTION() {
+        return 'OCFL object identifiers are used directly as the path.';
+    }
+    constructor(config) {
+        super(config, DefaultConfig);
+    }
+    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 {
+            const u = new URL(p);
+            const 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)) {
+    }
+}
+export { PathDirectStorageLayout };
+//# sourceMappingURL=000N-path-direct-storage-layout.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"000N-path-direct-storage-layout.js","sourceRoot":"","sources":["../../src/extensions/000N-path-direct-storage-layout.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAEpD,MAAM,aAAa,GAAG;IACpB,aAAa,EAAE,iCAAiC;IAChD,UAAU,EAAE,KAAK;IACjB,OAAO,EAAE,EAAiC;IAC1C,MAAM,EAAE,aAAa;CACtB,CAAC;AAIF,MAAM,uBAAwB,SAAQ,iBAAuC;IAC3E,MAAM,KAAK,IAAI;QACb,OAAO,aAAa,CAAC,aAAa,CAAC;IACrC,CAAC;IACD,MAAM,KAAK,WAAW;QACpB,OAAO,wDAAwD,CAAC;IAClE,CAAC;IAED,YAAY,MAAsC;QAChD,KAAK,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAC/B,CAAC;IAED,GAAG,CAAC,EAAU;QACZ,IAAI,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;QACpC,IAAI,MAAM,IAAI,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,+BAA+B,MAAM,GAAG,CAAC,CAAC;QAC5D,CAAC;QACD,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC;QACjB,KAAK,MAAM,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;YACxC,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5B,CAAC;QACD,IAAI,CAAC;YACH,MAAM,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC;YACrB,MAAM,KAAK,GAAG,EAAE,CAAC;YACjB,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,IAAI,CAAC,CAAC,QAAQ,KAAK,OAAO,EAAE,CAAC;gBAC1D,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,CAAC;YAC1C,CAAC;YACD,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC;gBACf,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;YAC7D,CAAC;YACD,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;QACjE,CAAC;QAAC,OAAO,MAAM,EAAE,CAAC,CAAA,CAAC;QACnB,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAC5C,yBAAyB;IAC3B,CAAC;CACF;AAED,OAAO,EAAE,uBAAuB,EAAE,CAAC"}

package/dist/extensions/index.d.ts

@@ -0,0 +1,23 @@
+export { PathDirectStorageLayout } from './000N-path-direct-storage-layout.ts';
+export { FlatDirectStorageLayout } from './0002-flat-direct-storage-layout.ts';
+export { HashAndIdNTupleStorageLayout } from './0003-hash-and-id-n-tuple-storage-layout.ts';
+export { HashedNTupleStorageLayout } from './0004-hashed-n-tuple-storage-layout.ts';
+export { FlatOmitPrefixStorageLayout } from './0006-flat-omit-prefix-storage-layout.ts';
+export { NTupleOmitPrefixStorageLayout } from './0007-n-tuple-omit-prefix-storage-layout.ts';
+export { DigestAlgorithm } from './0009-digest-algorithms.ts';
+import type { PathDirectStorageLayout } from './000N-path-direct-storage-layout.ts';
+import type { FlatDirectStorageLayout } from './0002-flat-direct-storage-layout.ts';
+import type { HashAndIdNTupleStorageLayout } from './0003-hash-and-id-n-tuple-storage-layout.ts';
+import type { HashedNTupleStorageLayout } from './0004-hashed-n-tuple-storage-layout.ts';
+import type { FlatOmitPrefixStorageLayout } from './0006-flat-omit-prefix-storage-layout.ts';
+import type { NTupleOmitPrefixStorageLayout } from './0007-n-tuple-omit-prefix-storage-layout.ts';
+/** Built-in storage layout classes, keyed by class name */
+export type StorageLayout = {
+    FlatDirectStorageLayout: typeof FlatDirectStorageLayout;
+    FlatOmitPrefixStorageLayout: typeof FlatOmitPrefixStorageLayout;
+    HashAndIdNTupleStorageLayout: typeof HashAndIdNTupleStorageLayout;
+    HashedNTupleStorageLayout: typeof HashedNTupleStorageLayout;
+    NTupleOmitPrefixStorageLayout: typeof NTupleOmitPrefixStorageLayout;
+    PathDirectStorageLayout: typeof PathDirectStorageLayout;
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/extensions/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/extensions/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAC;AAC/E,OAAO,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAC;AAC/E,OAAO,EAAE,4BAA4B,EAAE,MAAM,8CAA8C,CAAC;AAC5F,OAAO,EAAE,yBAAyB,EAAE,MAAM,yCAAyC,CAAC;AACpF,OAAO,EAAE,2BAA2B,EAAE,MAAM,2CAA2C,CAAC;AACxF,OAAO,EAAE,6BAA6B,EAAE,MAAM,8CAA8C,CAAC;AAC7F,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAE9D,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAC;AACpF,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAC;AACpF,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,8CAA8C,CAAC;AACjG,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,yCAAyC,CAAC;AACzF,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,2CAA2C,CAAC;AAC7F,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,8CAA8C,CAAC;AAElG,2DAA2D;AAC3D,MAAM,MAAM,aAAa,GAAG;IAC1B,uBAAuB,EAAE,OAAO,uBAAuB,CAAC;IACxD,2BAA2B,EAAE,OAAO,2BAA2B,CAAC;IAChE,4BAA4B,EAAE,OAAO,4BAA4B,CAAC;IAClE,yBAAyB,EAAE,OAAO,yBAAyB,CAAC;IAC5D,6BAA6B,EAAE,OAAO,6BAA6B,CAAC;IACpE,uBAAuB,EAAE,OAAO,uBAAuB,CAAC;CACzD,CAAC"}

package/dist/extensions/index.js

@@ -0,0 +1,8 @@
+export { PathDirectStorageLayout } from './000N-path-direct-storage-layout.js';
+export { FlatDirectStorageLayout } from './0002-flat-direct-storage-layout.js';
+export { HashAndIdNTupleStorageLayout } from './0003-hash-and-id-n-tuple-storage-layout.js';
+export { HashedNTupleStorageLayout } from './0004-hashed-n-tuple-storage-layout.js';
+export { FlatOmitPrefixStorageLayout } from './0006-flat-omit-prefix-storage-layout.js';
+export { NTupleOmitPrefixStorageLayout } from './0007-n-tuple-omit-prefix-storage-layout.js';
+export { DigestAlgorithm } from './0009-digest-algorithms.js';
+//# sourceMappingURL=index.js.map

package/dist/extensions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/extensions/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAC;AAC/E,OAAO,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAC;AAC/E,OAAO,EAAE,4BAA4B,EAAE,MAAM,8CAA8C,CAAC;AAC5F,OAAO,EAAE,yBAAyB,EAAE,MAAM,yCAAyC,CAAC;AACpF,OAAO,EAAE,2BAA2B,EAAE,MAAM,2CAA2C,CAAC;AACxF,OAAO,EAAE,6BAA6B,EAAE,MAAM,8CAA8C,CAAC;AAC7F,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC"}

package/dist/file.d.ts

@@ -0,0 +1,87 @@
+import type { OcflObject } from './object.ts';
+export interface FileRef {
+    /** Actual path to the file location relative to the ocfl object root. */
+    contentPath?: string;
+    /** A path that represents a file’s location in the logical state of an object. */
+    logicalPath?: string;
+    /** An algorithmic characterization of the contents of a file conforming to a standard digest algorithm. */
+    digest?: string;
+    /** Version of the OCFL object. */
+    version?: string | undefined;
+    /** Last modified time of the file, in milliseconds since the UNIX epoch. */
+    lastModified?: number;
+    /** Size of the file in bytes. */
+    size?: number;
+    /** Fixity information of the file. */
+    fixity?: {
+        [algorithm: string]: string;
+    };
+}
+export interface FileStat {
+    /** Size of the file in bytes. */
+    size?: number;
+    /** Last access time of the file. */
+    atime?: Date;
+    /** Last modified time of the file. */
+    mtime?: Date;
+    /** Creation time of the file. */
+    ctime?: Date;
+}
+/**
+ * Represent a file in an OCFL object
+ */
+declare class OcflObjectFile {
+    #private;
+    logicalPath?: string;
+    contentPath?: string;
+    digest?: string;
+    version?: string;
+    fixity?: {
+        [algorithm: string]: string;
+    };
+    constructor(ocflObject: OcflObject, fileRef: FileRef);
+    /**
+     * Returns the last modified time of the file, in millisecond since the UNIX epoch (January 1st, 1970 at Midnight).
+     */
+    get lastModified(): number | undefined;
+    /**
+     * Returns the file size in bytes.
+     */
+    get size(): number | undefined;
+    toString(): string;
+    /**
+     * Get the file content as a buffer
+     * @param options Options to be passed to underlying data store specific implementation
+     */
+    buffer(options?: unknown): Promise<Uint8Array>;
+    /**
+     * @deprecated Use {@link OcflObjectFile.buffer}
+     */
+    asBuffer(options?: unknown): Promise<Uint8Array<ArrayBufferLike>>;
+    /**
+     * Get the file content as a string
+     * @param encoding String encoding, default to utf8
+     */
+    text(encoding?: BufferEncoding): Promise<string>;
+    /**
+     * @deprecated Use {@link OcflObjectFile.text}
+     */
+    asString(encoding?: BufferEncoding): Promise<string>;
+    /**
+     * Get the file content as a ReadableStream
+     * @param options Options to be passed to underlying data store specific implementation
+     * @deprecated Use {@link OcflObjectFile.stream}
+     */
+    asStream(options?: unknown): Promise<ReadableStream>;
+    /**
+     * Get the file content as a ES Streams standard ReadableStream
+     * @param options Options to be passed to underlying data store specific implementation
+     */
+    stream(options?: unknown): Promise<ReadableStream>;
+    /**
+     * Get the file stat info
+     */
+    stat(_options?: unknown): Promise<FileStat>;
+}
+export { OcflObjectFile };
+//# sourceMappingURL=file.d.ts.map

package/dist/file.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"file.d.ts","sourceRoot":"","sources":["../src/file.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE9C,MAAM,WAAW,OAAO;IACtB,yEAAyE;IACzE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kFAAkF;IAClF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,2GAA2G;IAC3G,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,kCAAkC;IAClC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,4EAA4E;IAC5E,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iCAAiC;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,sCAAsC;IACtC,MAAM,CAAC,EAAE;QAAE,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CAC1C;AAED,MAAM,WAAW,QAAQ;IACvB,iCAAiC;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,oCAAoC;IACpC,KAAK,CAAC,EAAE,IAAI,CAAC;IACb,sCAAsC;IACtC,KAAK,CAAC,EAAE,IAAI,CAAC;IACb,iCAAiC;IACjC,KAAK,CAAC,EAAE,IAAI,CAAC;CACd;AAID;;GAEG;AACH,cAAM,cAAc;;IAIlB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE;QAAE,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAEzC,YAAY,UAAU,EAAE,UAAU,EAAE,OAAO,EAAE,OAAO,EAuBnD;IAkBD;;OAEG;IACH,IAAI,YAAY,uBAEf;IAED;;OAEG;IACH,IAAI,IAAI,uBAEP;IAED,QAAQ,WAGP;IAED;;;OAGG;IACG,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC,CAEnD;IAED;;OAEG;IACG,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,wCAE/B;IAED;;;OAGG;IACG,IAAI,CAAC,QAAQ,GAAE,cAAuB,GAAG,OAAO,CAAC,MAAM,CAAC,CAE7D;IAED;;OAEG;IACG,QAAQ,CAAC,QAAQ,GAAE,cAAuB,mBAE/C;IAED;;;;OAIG;IACG,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,cAAc,CAAC,CAEzD;IAED;;;OAGG;IACG,MAAM,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,cAAc,CAAC,CAEvD;IAED;;OAEG;IACG,IAAI,CAAC,QAAQ,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,CAEhD;CACF;AAED,OAAO,EAAE,cAAc,EAAE,CAAC"}

package/dist/file.js

@@ -0,0 +1,118 @@
+const REF_KEYS = ['logicalPath', 'version', 'digest', 'contentPath'];
+/**
+ * Represent a file in an OCFL object
+ */
+class OcflObjectFile {
+    #ocflObject;
+    #lastModified;
+    #size;
+    logicalPath;
+    contentPath;
+    digest;
+    version;
+    fixity;
+    constructor(ocflObject, fileRef) {
+        this.#ocflObject = ocflObject;
+        if (fileRef.logicalPath) {
+            this.logicalPath = fileRef.logicalPath;
+        }
+        if (fileRef.contentPath) {
+            this.contentPath = fileRef.contentPath;
+        }
+        if (fileRef.digest) {
+            this.digest = fileRef.digest;
+        }
+        if (fileRef.version) {
+            this.version = fileRef.version;
+        }
+        if (fileRef.lastModified != null) {
+            this.#lastModified = fileRef.lastModified;
+        }
+        if (fileRef.size != null) {
+            this.#size = fileRef.size;
+        }
+        if (fileRef.fixity != null) {
+            this.fixity = fileRef.fixity;
+        }
+    }
+    /**
+     * Resolve contentPath given either the `logicalPath` and `version`, `digest`, or `contentPath`.
+     */
+    async #resolveContentPath() {
+        let contentPath = this.contentPath;
+        if (!contentPath) {
+            const inv = await this.#ocflObject._requireInventory();
+            const version = !this.version || this.version === 'latest' ? inv.head : this.version;
+            contentPath = this.digest ? inv.getContentPath(this.digest) : this.logicalPath && inv.getFile(this.logicalPath, version)?.contentPath;
+            if (!contentPath) {
+                throw new Error(`Cannot find content "${this.toString()}" in the OCFL Object "${this.#ocflObject.id}" version "${this.version || 'latest'}"`);
+            }
+        }
+        return contentPath;
+    }
+    /**
+     * Returns the last modified time of the file, in millisecond since the UNIX epoch (January 1st, 1970 at Midnight).
+     */
+    get lastModified() {
+        return this.#lastModified;
+    }
+    /**
+     * Returns the file size in bytes.
+     */
+    get size() {
+        return this.#size;
+    }
+    toString() {
+        const props = REF_KEYS.filter((key) => this[key]).map((key) => `${key}: '${this[key]}'`);
+        return `{ ${props.join(', ')} }`;
+    }
+    /**
+     * Get the file content as a buffer
+     * @param options Options to be passed to underlying data store specific implementation
+     */
+    async buffer(options) {
+        return this.#ocflObject.readFile(await this.#resolveContentPath(), options);
+    }
+    /**
+     * @deprecated Use {@link OcflObjectFile.buffer}
+     */
+    async asBuffer(options) {
+        return this.buffer(options);
+    }
+    /**
+     * Get the file content as a string
+     * @param encoding String encoding, default to utf8
+     */
+    async text(encoding = 'utf8') {
+        return this.#ocflObject.readFile(await this.#resolveContentPath(), encoding);
+    }
+    /**
+     * @deprecated Use {@link OcflObjectFile.text}
+     */
+    async asString(encoding = 'utf8') {
+        return this.text(encoding);
+    }
+    /**
+     * Get the file content as a ReadableStream
+     * @param options Options to be passed to underlying data store specific implementation
+     * @deprecated Use {@link OcflObjectFile.stream}
+     */
+    async asStream(options) {
+        return this.stream(options);
+    }
+    /**
+     * Get the file content as a ES Streams standard ReadableStream
+     * @param options Options to be passed to underlying data store specific implementation
+     */
+    async stream(options) {
+        return this.#ocflObject.createReadable(await this.#resolveContentPath(), options);
+    }
+    /**
+     * Get the file stat info
+     */
+    async stat(_options) {
+        return this.#ocflObject.stat(await this.#resolveContentPath());
+    }
+}
+export { OcflObjectFile };
+//# sourceMappingURL=file.js.map

package/dist/file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file.js","sourceRoot":"","sources":["../src/file.ts"],"names":[],"mappings":"AA8BA,MAAM,QAAQ,GAAG,CAAC,aAAa,EAAE,SAAS,EAAE,QAAQ,EAAE,aAAa,CAAU,CAAC;AAE9E;;GAEG;AACH,MAAM,cAAc;IAClB,WAAW,CAAa;IACxB,aAAa,CAAqB;IAClC,KAAK,CAAqB;IAC1B,WAAW,CAAU;IACrB,WAAW,CAAU;IACrB,MAAM,CAAU;IAChB,OAAO,CAAU;IACjB,MAAM,CAAmC;IAEzC,YAAY,UAAsB,EAAE,OAAgB;QAClD,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;YACxB,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACzC,CAAC;QACD,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;YACxB,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;QACzC,CAAC;QACD,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;YACnB,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC/B,CAAC;QACD,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YACpB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QACjC,CAAC;QACD,IAAI,OAAO,CAAC,YAAY,IAAI,IAAI,EAAE,CAAC;YACjC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,YAAY,CAAC;QAC5C,CAAC;QACD,IAAI,OAAO,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;YACzB,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;QAC5B,CAAC;QACD,IAAI,OAAO,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC;YAC3B,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QAC/B,CAAC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,mBAAmB;QACvB,IAAI,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;QACnC,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,iBAAiB,EAAE,CAAC;YACvD,MAAM,OAAO,GAAG,CAAC,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC;YACrF,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,EAAE,WAAW,CAAC;YACtI,IAAI,CAAC,WAAW,EAAE,CAAC;gBACjB,MAAM,IAAI,KAAK,CAAC,wBAAwB,IAAI,CAAC,QAAQ,EAAE,yBAAyB,IAAI,CAAC,WAAW,CAAC,EAAE,cAAc,IAAI,CAAC,OAAO,IAAI,QAAQ,GAAG,CAAC,CAAC;YAChJ,CAAC;QACH,CAAC;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;OAEG;IACH,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,QAAQ;QACN,MAAM,KAAK,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACzF,OAAO,KAAK,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;IACnC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM,CAAC,OAAiB;QAC5B,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,IAAI,CAAC,mBAAmB,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CAAC,OAAiB;QAC9B,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,IAAI,CAAC,QAAQ,GAAmB,MAAM;QAC1C,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,MAAM,IAAI,CAAC,mBAAmB,EAAE,EAAE,QAAQ,CAAC,CAAC;IAC/E,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CAAC,QAAQ,GAAmB,MAAM;QAC9C,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,QAAQ,CAAC,OAAiB;QAC9B,OAAO,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,MAAM,CAAC,OAAiB;QAC5B,OAAO,IAAI,CAAC,WAAW,CAAC,cAAc,CAAC,MAAM,IAAI,CAAC,mBAAmB,EAAE,EAAE,OAAO,CAAC,CAAC;IACpF,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,QAAkB;QAC3B,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC;IACjE,CAAC;CACF;AAED,OAAO,EAAE,cAAc,EAAE,CAAC"}