@ocfl/ocfl 0.4.0 → 1.0.0-beta.1

package/dist/types.d.ts

@@ -0,0 +1,107 @@
+import type { ContentAlgorithm } from './digest.ts';
+export interface InventoryDigests {
+    [key: string]: string[];
+}
+export interface InventoryVersion {
+    created: string;
+    message?: string;
+    state: InventoryDigests;
+    user?: {
+        name: string;
+        address?: string;
+    };
+}
+export interface Inventory {
+    /** A unique identifier for the OCFL Object. */
+    id: string;
+    /** The URI of the inventory section of the specification version matching the object conformance declaration. */
+    type: 'https://ocfl.io/1.0/spec/#inventory' | 'https://ocfl.io/1.1/spec/#inventory';
+    /**
+     * The algorithm used for calculating digests for content-addressing
+     * within the OCFL Object and for the Inventory Digest.
+     * This MUST be the algorithm used in the manifest and state blocks
+     */
+    digestAlgorithm: ContentAlgorithm;
+    /** The version directory name of the most recent version of the object. */
+    head: string;
+    manifest: InventoryDigests;
+    versions: {
+        [key: string]: InventoryVersion;
+    };
+    fixity?: {
+        [key: string]: {
+            [key: string]: string[];
+        };
+    };
+    /**
+     * The name of the designated content directory within the version directories.
+     * @default content
+     */
+    contentDirectory?: string;
+}
+export type IDataType = string | ArrayBufferLike | Uint8Array | Uint16Array | Uint32Array;
+export interface CommonHasher {
+    init: () => CommonHasher;
+    update: (data: IDataType) => CommonHasher;
+    digest: {
+        (outputType: 'binary'): Uint8Array;
+        (outputType?: 'hex'): string;
+    };
+    digestSize: number;
+}
+export interface MultiHasher {
+    multi: true;
+    update: (data: IDataType) => MultiHasher;
+    digest: {
+        (outputType: 'binary'): {
+            [key: string]: Uint8Array;
+        };
+        (outputType?: 'hex'): {
+            [key: string]: string;
+        };
+    };
+}
+export type OcflVersion = '1.0' | '1.1';
+export type OcflExtensionConfig = {
+    extensionName?: string;
+    [key: string]: unknown;
+};
+type OcflStorageLayout = import('./extension.ts').OcflStorageLayout;
+/** Configuration options for an OCFL Object. */
+export type OcflStorageConfig = {
+    /** Absolute path to the ocfl storage root. */
+    root: string;
+    /** Absolute path to storage workspace directory. */
+    workspace?: string | undefined;
+    /** A layout that identifies an arrangement of directories and OCFL objects under the storage root */
+    layout?: OcflStorageLayout | OcflExtensionConfig | string | undefined;
+    /** A default list of digest algorithm names to be added to the fixity block of objects under this storage. */
+    fixityAlgorithms?: string[] | undefined;
+    /** Digest algorithm for content-addressing, must use either sha512 or sha256. Defaults to 'sha512'. */
+    digestAlgorithm?: ContentAlgorithm | undefined;
+    /** Content directory name. Only applies to a newly created object. @defaultValue `"content"` */
+    contentDirectory?: string | undefined;
+    /** Ocfl version. Only applies to a newly created object. @defaultValue {@link OcflConstants.OCFL_VERSION} */
+    ocflVersion?: OcflVersion | undefined;
+};
+/** Configuration options for an OCFL Object. */
+export type OcflObjectConfig = {
+    /** Absolute path to the ocfl object root. */
+    root: string;
+    /** Absolute path to object workspace directory. */
+    workspace?: string | undefined;
+    /** Identifier for the object.  Only be used in a newly created object. */
+    id?: string | undefined;
+    /** Reference to existing extensions defined outside of the object, such as in the storage root. */
+    extensions?: import('./extension.ts').OcflExtension[] | undefined;
+    /** Additional digest algorithms to be calculated for each file and added to the fixity block. */
+    fixityAlgorithms?: string[] | undefined;
+    /** Digest algorithm for content-addressing, must use either sha512 or sha256. Defaults to 'sha512'. */
+    digestAlgorithm?: ContentAlgorithm | undefined;
+    /** Content directory name. Only applies to a newly created object. @defaultValue `"content"` */
+    contentDirectory?: string | undefined;
+    /** Ocfl version. Only applies to a newly created object. @defaultValue {@link OcflConstants.OCFL_VERSION} */
+    ocflVersion?: OcflVersion | undefined;
+};
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAEpD,MAAM,WAAW,gBAAgB;IAC/B,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;CACzB;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,gBAAgB,CAAC;IACxB,IAAI,CAAC,EAAE;QACL,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;CACH;AAED,MAAM,WAAW,SAAS;IACxB,+CAA+C;IAC/C,EAAE,EAAE,MAAM,CAAC;IACX,iHAAiH;IACjH,IAAI,EAAE,qCAAqC,GAAG,qCAAqC,CAAC;IACpF;;;;OAIG;IACH,eAAe,EAAE,gBAAgB,CAAC;IAClC,2EAA2E;IAC3E,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,QAAQ,EAAE;QACR,CAAC,GAAG,EAAE,MAAM,GAAG,gBAAgB,CAAC;KACjC,CAAC;IACF,MAAM,CAAC,EAAE;QACP,CAAC,GAAG,EAAE,MAAM,GAAG;YACb,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;SACzB,CAAC;KACH,CAAC;IACF;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,eAAe,GAAG,UAAU,GAAG,WAAW,GAAG,WAAW,CAAC;AAE1F,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,MAAM,YAAY,CAAC;IACzB,MAAM,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,YAAY,CAAC;IAC1C,MAAM,EAAE;QACN,CAAC,UAAU,EAAE,QAAQ,GAAG,UAAU,CAAC;QACnC,CAAC,UAAU,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;KAC9B,CAAC;IACF,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,IAAI,CAAC;IACZ,MAAM,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,WAAW,CAAC;IACzC,MAAM,EAAE;QACN,CAAC,UAAU,EAAE,QAAQ,GAAG;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAAA;SAAE,CAAC;QACtD,CAAC,UAAU,CAAC,EAAE,KAAK,GAAG;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;KACjD,CAAC;CACH;AAED,MAAM,MAAM,WAAW,GAAG,KAAK,GAAG,KAAK,CAAC;AAExC,MAAM,MAAM,mBAAmB,GAAG;IAAE,aAAa,CAAC,EAAE,MAAM,CAAC;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAC;AACrF,KAAK,iBAAiB,GAAG,OAAO,gBAAgB,EAAE,iBAAiB,CAAC;AAEpE,gDAAgD;AAChD,MAAM,MAAM,iBAAiB,GAAG;IAC9B,8CAA8C;IAC9C,IAAI,EAAE,MAAM,CAAC;IACb,oDAAoD;IACpD,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,qGAAqG;IACrG,MAAM,CAAC,EAAE,iBAAiB,GAAG,mBAAmB,GAAG,MAAM,GAAG,SAAS,CAAC;IACtE,8GAA8G;IAC9G,gBAAgB,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IACxC,uGAAuG;IACvG,eAAe,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;IAC/C,gGAAgG;IAChG,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,6GAA6G;IAC7G,WAAW,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;CACvC,CAAC;AAEF,gDAAgD;AAChD,MAAM,MAAM,gBAAgB,GAAG;IAC7B,6CAA6C;IAC7C,IAAI,EAAE,MAAM,CAAC;IACb,mDAAmD;IACnD,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,0EAA0E;IAC1E,EAAE,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACxB,mGAAmG;IACnG,UAAU,CAAC,EAAE,OAAO,gBAAgB,EAAE,aAAa,EAAE,GAAG,SAAS,CAAC;IAClE,iGAAiG;IACjG,gBAAgB,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IACxC,uGAAuG;IACvG,eAAe,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;IAC/C,gGAAgG;IAChG,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACtC,6GAA6G;IAC7G,WAAW,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;CACvC,CAAC"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/dist/utils.d.ts

@@ -0,0 +1,24 @@
+import type { OcflStore } from './store.ts';
+import type { OcflVersion } from './types.ts';
+declare function isErrnoException(error: unknown): error is NodeJS.ErrnoException;
+/**
+ * Run `asyncFn` over every element of `inputStack` with at most `count` calls in flight.
+ * Rejections are returned in the result array rather than thrown.
+ * @param inputStack - Consumed during the process.
+ * @param count - Maximum number of concurrency
+ */
+declare function parallelize<T, R>(inputStack: T[], asyncFn: (input: T) => Promise<R>, count?: number): Promise<(R | Error)[]>;
+declare function isDirEmpty(store: OcflStore, dirPath: string): Promise<boolean>;
+/**
+ * Check if there is any valid namaste in the rootPath and return the version number.
+ * @returns The version, `''` if a namaste exists but is invalid, or `undefined` if there is none.
+ */
+declare function findNamasteVersion(store: OcflStore, prefix: string, rootPath: string): Promise<OcflVersion | '' | undefined>;
+type TypedArray = ArrayLike<number> & {
+    buffer: ArrayBufferLike;
+    byteLength: number;
+    set(array: ArrayLike<number>, offset?: number): void;
+};
+declare function joinTypedArray(target: ArrayBuffer | TypedArray, source: ArrayBuffer | TypedArray): TypedArray;
+export { findNamasteVersion, isDirEmpty, isErrnoException, joinTypedArray, parallelize };
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAI9C,iBAAS,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAAC,cAAc,CAExE;AAED;;;;;GAKG;AACH,iBAAe,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,EAAE,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK,SAAK,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,EAAE,CAAC,CAqBvH;AAED,iBAAe,UAAU,CAAC,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAU7E;AAED;;;GAGG;AACH,iBAAe,kBAAkB,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,GAAG,EAAE,GAAG,SAAS,CAAC,CAc3H;AAED,KAAK,UAAU,GAAG,SAAS,CAAC,MAAM,CAAC,GAAG;IAAE,MAAM,EAAE,eAAe,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,KAAK,EAAE,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,CAAC;AAM5I,iBAAS,cAAc,CAAC,MAAM,EAAE,WAAW,GAAG,UAAU,EAAE,MAAM,EAAE,WAAW,GAAG,UAAU,GAAG,UAAU,CActG;AAED,OAAO,EAAE,kBAAkB,EAAE,UAAU,EAAE,gBAAgB,EAAE,cAAc,EAAE,WAAW,EAAE,CAAC"}

package/dist/utils.js

@@ -0,0 +1,85 @@
+import { OcflConstants } from './constants.js';
+const { OCFL_VERSIONS, NAMASTE_T } = OcflConstants;
+function isErrnoException(error) {
+    return error instanceof Error && 'code' in error;
+}
+/**
+ * Run `asyncFn` over every element of `inputStack` with at most `count` calls in flight.
+ * Rejections are returned in the result array rather than thrown.
+ * @param inputStack - Consumed during the process.
+ * @param count - Maximum number of concurrency
+ */
+async function parallelize(inputStack, asyncFn, count = 10) {
+    const promises = [];
+    let len = Math.min(inputStack.length, count);
+    const result = [];
+    while (len--) {
+        promises.push((async () => {
+            while (inputStack.length) {
+                const input = inputStack.pop();
+                const index = inputStack.length;
+                try {
+                    result[index] = await asyncFn(input);
+                }
+                catch (error) {
+                    result[index] = error instanceof Error ? error : new Error(String(error), { cause: error });
+                }
+            }
+        })().catch(() => { }));
+    }
+    await Promise.all(promises);
+    return result;
+}
+async function isDirEmpty(store, dirPath) {
+    let de;
+    try {
+        const dir = await store.opendir(dirPath);
+        de = await dir.read();
+        await dir.close();
+    }
+    catch (error) {
+        return isErrnoException(error) && error.code === 'ENOENT';
+    }
+    return !de;
+}
+/**
+ * Check if there is any valid namaste in the rootPath and return the version number.
+ * @returns The version, `''` if a namaste exists but is invalid, or `undefined` if there is none.
+ */
+async function findNamasteVersion(store, prefix, rootPath) {
+    const namastePath = `${rootPath}/${NAMASTE_T}${prefix}`;
+    let version;
+    try {
+        version = await Promise.any(OCFL_VERSIONS.map(async (v) => ((await store.readFile(namastePath + v, 'utf8')) === `${prefix}${v}\n` ? v : null)));
+        if (!version) {
+            return '';
+        }
+    }
+    catch (error) {
+        if (!(error instanceof AggregateError) || error.errors.some((e) => !isErrnoException(e) || e.code !== 'ENOENT')) {
+            throw error;
+        }
+    }
+    return version ?? undefined;
+}
+function isTypedArray(obj) {
+    return ArrayBuffer.isView(obj) && !(obj instanceof DataView);
+}
+function joinTypedArray(target, source) {
+    const sourceArray = isTypedArray(source) ? source : new Uint8Array(source);
+    const [targetBuffer, targetArray] = isTypedArray(target) ? [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;
+}
+export { findNamasteVersion, isDirEmpty, isErrnoException, joinTypedArray, parallelize };
+//# sourceMappingURL=utils.js.map

package/dist/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAI/C,MAAM,EAAE,aAAa,EAAE,SAAS,EAAE,GAAG,aAAa,CAAC;AAEnD,SAAS,gBAAgB,CAAC,KAAc;IACtC,OAAO,KAAK,YAAY,KAAK,IAAI,MAAM,IAAI,KAAK,CAAC;AACnD,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,WAAW,CAAO,UAAe,EAAE,OAAiC,EAAE,KAAK,GAAG,EAAE;IAC7F,MAAM,QAAQ,GAAoB,EAAE,CAAC;IACrC,IAAI,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IAC7C,MAAM,MAAM,GAAkB,EAAE,CAAC;IACjC,OAAO,GAAG,EAAE,EAAE,CAAC;QACb,QAAQ,CAAC,IAAI,CACX,CAAC,KAAK,IAAI,EAAE;YACV,OAAO,UAAU,CAAC,MAAM,EAAE,CAAC;gBACzB,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAO,CAAC;gBACpC,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,CAAC;gBAChC,IAAI,CAAC;oBACH,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,CAAC;gBACvC,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;gBAC9F,CAAC;YACH,CAAC;QACH,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CACrB,CAAC;IACJ,CAAC;IACD,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;IAC5B,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,KAAK,UAAU,UAAU,CAAC,KAAgB,EAAE,OAAe;IACzD,IAAI,EAAW,CAAC;IAChB,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACzC,EAAE,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;QACtB,MAAM,GAAG,CAAC,KAAK,EAAE,CAAC;IACpB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,gBAAgB,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC;IAC5D,CAAC;IACD,OAAO,CAAC,EAAE,CAAC;AACb,CAAC;AAED;;;GAGG;AACH,KAAK,UAAU,kBAAkB,CAAC,KAAgB,EAAE,MAAc,EAAE,QAAgB;IAClF,MAAM,WAAW,GAAG,GAAG,QAAQ,IAAI,SAAS,GAAG,MAAM,EAAE,CAAC;IACxD,IAAI,OAAuC,CAAC;IAC5C,IAAI,CAAC;QACH,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,QAAQ,CAAC,WAAW,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC,KAAK,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAChJ,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,EAAE,CAAC;QACZ,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,CAAC,CAAC,KAAK,YAAY,cAAc,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,EAAE,CAAC;YAChH,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;IACD,OAAO,OAAO,IAAI,SAAS,CAAC;AAC9B,CAAC;AAID,SAAS,YAAY,CAAC,GAAY;IAChC,OAAO,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,YAAY,QAAQ,CAAC,CAAC;AAC/D,CAAC;AAED,SAAS,cAAc,CAAC,MAAgC,EAAE,MAAgC;IACxF,MAAM,WAAW,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;IAC3E,MAAM,CAAC,YAAY,EAAE,WAAW,CAAC,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAqB,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;IACrI,MAAM,YAAY,GAAG,WAAW,CAAC,UAAU,CAAC;IAC5C,MAAM,SAAS,GAAG,YAAY,GAAG,WAAW,CAAC,UAAU,CAAC;IACxD,IAAI,WAAW,GAAG,WAAW,CAAC;IAC9B,IAAI,YAAY,CAAC,SAAS,IAAI,YAAY,CAAC,aAAa,IAAI,SAAS,EAAE,CAAC;QACtE,YAAY,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IACjC,CAAC;SAAM,CAAC;QACN,WAAW,GAAG,IAAI,UAAU,CAAC,SAAS,CAAC,CAAC;QACxC,WAAW,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;IAClC,CAAC;IACD,WAAW,CAAC,GAAG,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;IAC3C,OAAO,WAAW,CAAC;AACrB,CAAC;AAED,OAAO,EAAE,kBAAkB,EAAE,UAAU,EAAE,gBAAgB,EAAE,cAAc,EAAE,WAAW,EAAE,CAAC"}

package/dist/validation.d.ts

@@ -0,0 +1,32 @@
+declare const ERRORS: {
+    E007: string;
+    E036: string;
+    E040: string;
+    E050: string;
+    E060: string;
+    E069: string;
+    E080: string;
+    E082: string;
+};
+type ErrorCode = keyof typeof ERRORS;
+interface ValidationErrorOptions {
+    code: ErrorCode;
+    description: string;
+    path: string;
+    detail?: string | undefined;
+}
+declare class ValidationError extends Error {
+    code: ErrorCode;
+    description: string;
+    path: string;
+    detail?: string | undefined;
+    constructor(options: ValidationErrorOptions);
+}
+/**
+ * @param code - OCFL validation code, eg 'E060'
+ * @param path - Path the problem was found at
+ * @param detail - Extra context appended to the message
+ */
+export declare const createError: (code: ErrorCode, path: string, detail?: string) => ValidationError;
+export {};
+//# sourceMappingURL=validation.d.ts.map

package/dist/validation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../src/validation.ts"],"names":[],"mappings":"AACA,QAAA,MAAM,MAAM;IACV,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;CACL,CAAC;AAEF,KAAK,SAAS,GAAG,MAAM,OAAO,MAAM,CAAC;AAErC,UAAU,sBAAsB;IAC9B,IAAI,EAAE,SAAS,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B;AAED,cAAM,eAAgB,SAAQ,KAAK;IACzB,IAAI,EAAE,SAAS,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEpC,YAAY,OAAO,EAAE,sBAAsB,EAI1C;CACF;AAED;;;;GAIG;AACH,eAAO,MAAM,WAAW,SAAU,SAAS,QAAQ,MAAM,WAAW,MAAM,oBAMzE,CAAC"}

package/dist/validation.js

@@ -0,0 +1,31 @@
+// Messages for the OCFL 1.1 validation codes this library raises: https://ocfl.io/1.1/spec/validation-codes.html
+const ERRORS = {
+    E007: 'The text contents of the [version declaration] file must be the same as dvalue, followed by a newline (\\n).',
+    E036: 'An OCFL Object Inventory MUST include the following keys: [id, type, digestAlgorithm, head].',
+    E040: '[head] MUST be the version directory name with the highest version number.',
+    E050: 'The keys of [the state JSON object] are digest values, each of which MUST correspond to an entry in the manifest of the inventory.',
+    E060: 'The digest sidecar file must contain the digest of the inventory file.',
+    E069: 'An OCFL Storage Root MUST contain a Root Conformance Declaration identifying it as such.',
+    E080: 'The text contents of [the OCFL version declaration file] MUST be the same as dvalue, followed by a newline (\\n).',
+    E082: 'OCFL Object Roots MUST be stored either as the terminal resource at the end of a directory storage hierarchy or as direct children of a containing OCFL Storage Root.',
+};
+class ValidationError extends Error {
+    constructor(options) {
+        super(`${options.code}: ${options.description} At ${options.path}${options.detail ? ` (${options.detail})` : ''}`);
+        this.name = 'ValidationError';
+        Object.assign(this, options);
+    }
+}
+/**
+ * @param code - OCFL validation code, eg 'E060'
+ * @param path - Path the problem was found at
+ * @param detail - Extra context appended to the message
+ */
+export const createError = (code, path, detail) => {
+    const description = Object.hasOwn(ERRORS, code) ? ERRORS[code] : undefined;
+    if (!description) {
+        throw new RangeError(`Unknown OCFL validation code ${code}`);
+    }
+    return new ValidationError({ code, description, path, detail });
+};
+//# sourceMappingURL=validation.js.map

package/dist/validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.js","sourceRoot":"","sources":["../src/validation.ts"],"names":[],"mappings":"AAAA,iHAAiH;AACjH,MAAM,MAAM,GAAG;IACb,IAAI,EAAE,8GAA8G;IACpH,IAAI,EAAE,8FAA8F;IACpG,IAAI,EAAE,4EAA4E;IAClF,IAAI,EAAE,oIAAoI;IAC1I,IAAI,EAAE,wEAAwE;IAC9E,IAAI,EAAE,0FAA0F;IAChG,IAAI,EAAE,mHAAmH;IACzH,IAAI,EAAE,uKAAuK;CAC9K,CAAC;AAWF,MAAM,eAAgB,SAAQ,KAAK;IAMjC,YAAY,OAA+B;QACzC,KAAK,CAAC,GAAG,OAAO,CAAC,IAAI,KAAK,OAAO,CAAC,WAAW,OAAO,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACnH,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC;QAC9B,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC/B,CAAC;CACF;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,IAAe,EAAE,IAAY,EAAE,MAAe,EAAE,EAAE;IAC5E,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3E,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,MAAM,IAAI,UAAU,CAAC,gCAAgC,IAAI,EAAE,CAAC,CAAC;IAC/D,CAAC;IACD,OAAO,IAAI,eAAe,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;AAClE,CAAC,CAAC"}

package/package.json

@@ -1,74 +1,54 @@
 {
   "name": "@ocfl/ocfl",
-  "version": "0.4.0",
+  "version": "1.0.0-beta.1",
   "description": "Oxford Common File Layout (OCFL) JS library",
-  "main": "index.js",
-  "exports": {
-    ".": [
-      {
-        "import": "./index.mjs",
-        "require": "./index.js",
-        "default": "./index.js"
-      },
-      "./index.js"
-    ]
-  },
-  "scripts": {
-    "test": "mocha",
-    "build": "tsc",
-    "build-docs": "typedoc --plugin typedoc-plugin-missing-exports"
-  },
   "keywords": [
     "ocfl",
     "Oxford Common File Layout",
     "preservation",
     "storage"
   ],
+  "homepage": "https://github.com/Language-Research-Technology/ocfl-js#readme",
+  "bugs": {
+    "url": "https://github.com/Language-Research-Technology/ocfl-js/issues"
+  },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/Language-Research-Technology/ocfl-js.git"
+    "url": "https://github.com/Language-Research-Technology/ocfl-js",
+    "directory": "ocfl"
   },
+  "license": "GPL-3.0-or-later",
   "author": "Alvin Sebastian (https://orcid.org/0000-0002-9086-1722)",
   "contributors": [
     "Moises Sacal Bonequi (https://orcid.org/0000-0002-4438-2755)",
     "Peter Sefton (https://orcid.org/0000-0002-3545-944X)"
   ],
-  "license": "GPL-3.0-or-later",
-  "dependencies": {
-    "hash-wasm": "^4.12.0",
-    "js-sha512": "^0.9.0"
-  },
-  "devDependencies": {
-    "@types/mocha": "^10.0.10",
-    "@types/node": "^24.12.2",
-    "memfs": "^4.50.0",
-    "mocha": "^11.7.5",
-    "typedoc": "^0.28.19",
-    "typedoc-plugin-missing-exports": "^4.1.2"
-  },
-  "mocha": {
-    "extension": [
-      ".spec.js",
-      ".spec.cjs",
-      ".spec.mjs"
-    ],
-    "recursive": true
-  },
-  "bugs": {
-    "url": "https://github.com/Language-Research-Technology/ocfl-js/issues"
-  },
-  "homepage": "https://github.com/Language-Research-Technology/ocfl-js#readme",
-  "directories": {
-    "lib": "lib",
-    "test": "test"
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
   },
   "files": [
-    "index.js",
-    "index.mjs",
-    "lib",
+    "dist",
+    "src",
     "resources"
   ],
+  "devDependencies": {
+    "@types/node": "^22.20.5",
+    "typescript": "^7.0.2"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
   "engines": {
-    "node": ">=18.0.0"
+    "node": ">=22.12.0"
+  },
+  "scripts": {
+    "test": "node --test 'test/**/*.spec.ts'",
+    "build": "tsc",
+    "typecheck": "tsc --noEmit && tsc -p test"
   }
-}
+}

package/src/constants.ts

@@ -0,0 +1,16 @@
+import type { OcflVersion } from './types.ts';
+
+const OcflConstants = {
+  OCFL_VERSION: '1.1' as OcflVersion,
+  OCFL_VERSIONS: Object.freeze(['1.1', '1.0'] as const),
+  OCFL_LAYOUT: 'ocfl_layout.json',
+  NAMASTE_T: '0=',
+  NAMASTE_PREFIX_OBJECT: 'ocfl_object_',
+  NAMASTE_PREFIX_STORAGE: 'ocfl_',
+  INVENTORY_NAME: 'inventory.json',
+  EXTENSIONS_DIR: 'extensions',
+  EXTENSION_CONFIG: 'config.json',
+  DIGEST_ALGORITHM: 'sha512',
+};
+
+export { OcflConstants };