@internetarchive/metadata-service 0.0.1-alpha.1 → 0.1.1

package/dist/src/backend/metadata-backend-interface.d.ts

@@ -1,20 +1,20 @@
-import type { Result } from '@internetarchive/result-type';
-import { MetadataServiceError } from '../metadata-service-error';
-/**
- * An interface to provide the network layer to the `MetadataService`.
- *
- * Objects implementing this interface are responsible for making calls to the Internet Archive
- * `metadata` endpoint or otherwise providing a similar reponse in JSON format.
- *
- * @export
- * @interface MetadataBackendInterface
- */
-export interface MetadataBackendInterface {
-    /**
-     * Fetch metadata for a single item with an optional keypath
-     *
-     * @param identifier
-     * @param keypath
-     */
-    fetchMetadata(identifier: string, keypath?: string): Promise<Result<any, MetadataServiceError>>;
-}
+import type { Result } from '@internetarchive/result-type';
+import { MetadataServiceError } from '../metadata-service-error';
+/**
+ * An interface to provide the network layer to the `MetadataService`.
+ *
+ * Objects implementing this interface are responsible for making calls to the Internet Archive
+ * `metadata` endpoint or otherwise providing a similar reponse in JSON format.
+ *
+ * @export
+ * @interface MetadataBackendInterface
+ */
+export interface MetadataBackendInterface {
+    /**
+     * Fetch metadata for a single item with an optional keypath
+     *
+     * @param identifier
+     * @param keypath
+     */
+    fetchMetadata(identifier: string, keypath?: string): Promise<Result<any, MetadataServiceError>>;
+}

package/dist/src/backend/metadata-backend-interface.js

@@ -1,2 +1,2 @@
-export {};
+export {};
 //# sourceMappingURL=metadata-backend-interface.js.map

package/dist/src/metadata-service-error.d.ts

@@ -1,11 +1,11 @@
-export declare enum MetadataServiceErrorType {
-    networkError = "MetadataService.NetworkError",
-    itemNotFound = "MetadataService.ItemNotFound",
-    decodingError = "MetadataService.DecodingError",
-    searchEngineError = "MetadataService.SearchEngineError"
-}
-export declare class MetadataServiceError extends Error {
-    type: MetadataServiceErrorType;
-    details?: any;
-    constructor(type: MetadataServiceErrorType, message?: string, details?: any);
-}
+export declare enum MetadataServiceErrorType {
+    networkError = "MetadataService.NetworkError",
+    itemNotFound = "MetadataService.ItemNotFound",
+    decodingError = "MetadataService.DecodingError",
+    searchEngineError = "MetadataService.SearchEngineError"
+}
+export declare class MetadataServiceError extends Error {
+    type: MetadataServiceErrorType;
+    details?: any;
+    constructor(type: MetadataServiceErrorType, message?: string, details?: any);
+}

package/dist/src/metadata-service-error.js

@@ -1,18 +1,18 @@
-/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
-/* eslint-disable @typescript-eslint/no-explicit-any */
-export var MetadataServiceErrorType;
-(function (MetadataServiceErrorType) {
-    MetadataServiceErrorType["networkError"] = "MetadataService.NetworkError";
-    MetadataServiceErrorType["itemNotFound"] = "MetadataService.ItemNotFound";
-    MetadataServiceErrorType["decodingError"] = "MetadataService.DecodingError";
-    MetadataServiceErrorType["searchEngineError"] = "MetadataService.SearchEngineError";
-})(MetadataServiceErrorType || (MetadataServiceErrorType = {}));
-export class MetadataServiceError extends Error {
-    constructor(type, message, details) {
-        super(message);
-        this.name = type;
-        this.type = type;
-        this.details = details;
-    }
-}
+/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
+/* eslint-disable @typescript-eslint/no-explicit-any */
+export var MetadataServiceErrorType;
+(function (MetadataServiceErrorType) {
+    MetadataServiceErrorType["networkError"] = "MetadataService.NetworkError";
+    MetadataServiceErrorType["itemNotFound"] = "MetadataService.ItemNotFound";
+    MetadataServiceErrorType["decodingError"] = "MetadataService.DecodingError";
+    MetadataServiceErrorType["searchEngineError"] = "MetadataService.SearchEngineError";
+})(MetadataServiceErrorType || (MetadataServiceErrorType = {}));
+export class MetadataServiceError extends Error {
+    constructor(type, message, details) {
+        super(message);
+        this.name = type;
+        this.type = type;
+        this.details = details;
+    }
+}
 //# sourceMappingURL=metadata-service-error.js.map

package/dist/src/metadata-service-interface.d.ts

@@ -1,44 +1,44 @@
-import type { MetadataResponse } from './responses/metadata-response';
-import type { Result } from '@internetarchive/result-type';
-import type { MetadataServiceError } from './metadata-service-error';
-export interface MetadataServiceInterface {
-    /**
-     * Fetch metadata for a given identifier
-     *
-     * @param {string} identifier
-     * @returns {Promise<Result<MetadataResponse, MetadataServiceError>>}
-     */
-    fetchMetadata(identifier: string): Promise<Result<MetadataResponse, MetadataServiceError>>;
-    /**
-     * Fetch the metadata value for a given identifier and keypath
-     *
-     * The response from this request can take any form, object, array, string, etc.
-     * depending on the query. You can provide return typing in the response by
-     * specifying the type. Note, there is no automatic type conversion since it can be anything.
-     *
-     * For example:
-     *
-     * ```ts
-     * const collection = await searchService.fetchMetadataValue<string>('goody', 'metadata/collection/0');
-     * console.debug('collection:', collection); => 'Goody Collection'
-     *
-     * const files_count = await searchService.fetchMetadataValue<number>('goody', 'files_count');
-     * console.debug('files_count:', files_count); => 12
-     * ```
-     *
-     * Keypath examples:
-     *
-     * /metadata/:identifier/metadata // returns the entire metadata object
-     * /metadata/:identifier/server // returns the server for the given identifier
-     * /metadata/:identifier/files_count
-     * /metadata/:identifier/files?start=1&count=2 // query for files
-     * /metadata/:identifier/metadata/collection // all collections
-     * /metadata/:identifier/metadata/collection/0 // first collection
-     * /metadata/:identifier/metadata/title
-     * /metadata/:identifier/files/0/name // first file name
-     *
-     * @param identifier
-     * @param keypath
-     */
-    fetchMetadataValue<T>(identifier: string, keypath: string): Promise<Result<T, MetadataServiceError>>;
-}
+import type { MetadataResponse } from './responses/metadata-response';
+import type { Result } from '@internetarchive/result-type';
+import type { MetadataServiceError } from './metadata-service-error';
+export interface MetadataServiceInterface {
+    /**
+     * Fetch metadata for a given identifier
+     *
+     * @param {string} identifier
+     * @returns {Promise<Result<MetadataResponse, MetadataServiceError>>}
+     */
+    fetchMetadata(identifier: string): Promise<Result<MetadataResponse, MetadataServiceError>>;
+    /**
+     * Fetch the metadata value for a given identifier and keypath
+     *
+     * The response from this request can take any form, object, array, string, etc.
+     * depending on the query. You can provide return typing in the response by
+     * specifying the type. Note, there is no automatic type conversion since it can be anything.
+     *
+     * For example:
+     *
+     * ```ts
+     * const collection = await searchService.fetchMetadataValue<string>('goody', 'metadata/collection/0');
+     * console.debug('collection:', collection); => 'Goody Collection'
+     *
+     * const files_count = await searchService.fetchMetadataValue<number>('goody', 'files_count');
+     * console.debug('files_count:', files_count); => 12
+     * ```
+     *
+     * Keypath examples:
+     *
+     * /metadata/:identifier/metadata // returns the entire metadata object
+     * /metadata/:identifier/server // returns the server for the given identifier
+     * /metadata/:identifier/files_count
+     * /metadata/:identifier/files?start=1&count=2 // query for files
+     * /metadata/:identifier/metadata/collection // all collections
+     * /metadata/:identifier/metadata/collection/0 // first collection
+     * /metadata/:identifier/metadata/title
+     * /metadata/:identifier/files/0/name // first file name
+     *
+     * @param identifier
+     * @param keypath
+     */
+    fetchMetadataValue<T>(identifier: string, keypath: string): Promise<Result<T, MetadataServiceError>>;
+}

package/dist/src/metadata-service-interface.js

@@ -1,2 +1,2 @@
-export {};
+export {};
 //# sourceMappingURL=metadata-service-interface.js.map

package/dist/src/metadata-service.d.ts

@@ -1,18 +1,18 @@
-import { MetadataResponse } from './responses/metadata-response';
-import { MetadataServiceError } from './metadata-service-error';
-import type { MetadataServiceInterface } from './metadata-service-interface';
-import type { Result } from '@internetarchive/result-type';
-import { MetadataBackendInterface } from './backend/metadata-backend-interface';
-/**
- * The Metadata Service is responsible for taking the raw response provided by
- * the backend and modeling it as a `MetadataResponse` object.
- */
-export declare class MetadataService implements MetadataServiceInterface {
-    static default: MetadataServiceInterface;
-    private backend;
-    constructor(backend: MetadataBackendInterface);
-    /** @inheritdoc */
-    fetchMetadata(identifier: string): Promise<Result<MetadataResponse, MetadataServiceError>>;
-    /** @inheritdoc */
-    fetchMetadataValue<T>(identifier: string, keypath: string): Promise<Result<T, MetadataServiceError>>;
-}
+import { MetadataResponse } from './responses/metadata-response';
+import { MetadataServiceError } from './metadata-service-error';
+import type { MetadataServiceInterface } from './metadata-service-interface';
+import type { Result } from '@internetarchive/result-type';
+import { MetadataBackendInterface } from './backend/metadata-backend-interface';
+/**
+ * The Metadata Service is responsible for taking the raw response provided by
+ * the backend and modeling it as a `MetadataResponse` object.
+ */
+export declare class MetadataService implements MetadataServiceInterface {
+    static default: MetadataServiceInterface;
+    private backend;
+    constructor(backend: MetadataBackendInterface);
+    /** @inheritdoc */
+    fetchMetadata(identifier: string): Promise<Result<MetadataResponse, MetadataServiceError>>;
+    /** @inheritdoc */
+    fetchMetadataValue<T>(identifier: string, keypath: string): Promise<Result<T, MetadataServiceError>>;
+}

package/dist/src/metadata-service.js

@@ -1,43 +1,43 @@
-import { MetadataResponse } from './responses/metadata-response';
-import { MetadataServiceError, MetadataServiceErrorType, } from './metadata-service-error';
-import { DefaultMetadataBackend } from './backend/default-metadata-backend';
-/**
- * The Metadata Service is responsible for taking the raw response provided by
- * the backend and modeling it as a `MetadataResponse` object.
- */
-export class MetadataService {
-    constructor(backend) {
-        this.backend = backend;
-    }
-    /** @inheritdoc */
-    async fetchMetadata(identifier) {
-        var _a;
-        const rawResponse = await this.backend.fetchMetadata(identifier);
-        if (rawResponse.error) {
-            return rawResponse;
-        }
-        if (((_a = rawResponse.success) === null || _a === void 0 ? void 0 : _a.metadata) === undefined) {
-            return {
-                error: new MetadataServiceError(MetadataServiceErrorType.itemNotFound),
-            };
-        }
-        const modeledResponse = new MetadataResponse(rawResponse.success);
-        return { success: modeledResponse };
-    }
-    /** @inheritdoc */
-    async fetchMetadataValue(identifier, keypath) {
-        var _a;
-        const result = await this.backend.fetchMetadata(identifier, keypath);
-        if (result.error) {
-            return result;
-        }
-        if (((_a = result.success) === null || _a === void 0 ? void 0 : _a.result) === undefined) {
-            return {
-                error: new MetadataServiceError(MetadataServiceErrorType.itemNotFound),
-            };
-        }
-        return { success: result.success.result };
-    }
-}
-MetadataService.default = new MetadataService(new DefaultMetadataBackend());
+import { MetadataResponse } from './responses/metadata-response';
+import { MetadataServiceError, MetadataServiceErrorType, } from './metadata-service-error';
+import { DefaultMetadataBackend } from './backend/default-metadata-backend';
+/**
+ * The Metadata Service is responsible for taking the raw response provided by
+ * the backend and modeling it as a `MetadataResponse` object.
+ */
+export class MetadataService {
+    constructor(backend) {
+        this.backend = backend;
+    }
+    /** @inheritdoc */
+    async fetchMetadata(identifier) {
+        var _a;
+        const rawResponse = await this.backend.fetchMetadata(identifier);
+        if (rawResponse.error) {
+            return rawResponse;
+        }
+        if (((_a = rawResponse.success) === null || _a === void 0 ? void 0 : _a.metadata) === undefined) {
+            return {
+                error: new MetadataServiceError(MetadataServiceErrorType.itemNotFound),
+            };
+        }
+        const modeledResponse = new MetadataResponse(rawResponse.success);
+        return { success: modeledResponse };
+    }
+    /** @inheritdoc */
+    async fetchMetadataValue(identifier, keypath) {
+        var _a;
+        const result = await this.backend.fetchMetadata(identifier, keypath);
+        if (result.error) {
+            return result;
+        }
+        if (((_a = result.success) === null || _a === void 0 ? void 0 : _a.result) === undefined) {
+            return {
+                error: new MetadataServiceError(MetadataServiceErrorType.itemNotFound),
+            };
+        }
+        return { success: result.success.result };
+    }
+}
+MetadataService.default = new MetadataService(new DefaultMetadataBackend());
 //# sourceMappingURL=metadata-service.js.map

package/dist/src/models/file.d.ts

@@ -1,29 +1,29 @@
-import { Byte, Duration } from '@internetarchive/field-parsers';
-/**
- * This represents an Internet Archive File
- *
- * @export
- * @class File
- */
-export declare class File {
-    rawValue: Record<string, any>;
-    get name(): string;
-    get source(): string;
-    get btih(): string;
-    get md5(): string;
-    get format(): string;
-    get mtime(): string;
-    get crc32(): string;
-    get sha1(): string;
-    get original(): string | undefined;
-    get size(): Byte | undefined;
-    get title(): string | undefined;
-    get length(): Duration | undefined;
-    get height(): number | undefined;
-    get width(): number | undefined;
-    get track(): number | undefined;
-    get external_identifier(): string | string[] | undefined;
-    get creator(): string | undefined;
-    get album(): string | undefined;
-    constructor(json: Record<string, any>);
-}
+import { Byte, Duration } from '@internetarchive/field-parsers';
+/**
+ * This represents an Internet Archive File
+ *
+ * @export
+ * @class File
+ */
+export declare class File {
+    rawValue: Record<string, any>;
+    get name(): string;
+    get source(): string;
+    get btih(): string;
+    get md5(): string;
+    get format(): string;
+    get mtime(): string;
+    get crc32(): string;
+    get sha1(): string;
+    get original(): string | undefined;
+    get size(): Byte | undefined;
+    get title(): string | undefined;
+    get length(): Duration | undefined;
+    get height(): number | undefined;
+    get width(): number | undefined;
+    get track(): number | undefined;
+    get external_identifier(): string | string[] | undefined;
+    get creator(): string | undefined;
+    get album(): string | undefined;
+    constructor(json: Record<string, any>);
+}

package/dist/src/models/file.js

@@ -1,95 +1,95 @@
-import { __decorate } from "tslib";
-/* eslint-disable @typescript-eslint/no-explicit-any */
-import { Memoize } from 'typescript-memoize';
-import { ByteParser, DurationParser, NumberParser, } from '@internetarchive/field-parsers';
-/**
- * This represents an Internet Archive File
- *
- * @export
- * @class File
- */
-export class File {
-    constructor(json) {
-        this.rawValue = json;
-    }
-    get name() {
-        return this.rawValue.name;
-    }
-    get source() {
-        return this.rawValue.source;
-    }
-    get btih() {
-        return this.rawValue.btih;
-    }
-    get md5() {
-        return this.rawValue.md5;
-    }
-    get format() {
-        return this.rawValue.format;
-    }
-    get mtime() {
-        return this.rawValue.mtime;
-    }
-    get crc32() {
-        return this.rawValue.crc32;
-    }
-    get sha1() {
-        return this.rawValue.sha1;
-    }
-    get original() {
-        return this.rawValue.original;
-    }
-    get size() {
-        return this.rawValue.size
-            ? ByteParser.shared.parseValue(this.rawValue.size)
-            : undefined;
-    }
-    get title() {
-        return this.rawValue.title;
-    }
-    get length() {
-        return this.rawValue.length
-            ? DurationParser.shared.parseValue(this.rawValue.length)
-            : undefined;
-    }
-    get height() {
-        return this.rawValue.height
-            ? NumberParser.shared.parseValue(this.rawValue.height)
-            : undefined;
-    }
-    get width() {
-        return this.rawValue.width
-            ? NumberParser.shared.parseValue(this.rawValue.width)
-            : undefined;
-    }
-    get track() {
-        return this.rawValue.track
-            ? NumberParser.shared.parseValue(this.rawValue.track)
-            : undefined;
-    }
-    get external_identifier() {
-        return this.rawValue.external_identifier;
-    }
-    get creator() {
-        return this.rawValue.creator;
-    }
-    get album() {
-        return this.rawValue.album;
-    }
-}
-__decorate([
-    Memoize()
-], File.prototype, "size", null);
-__decorate([
-    Memoize()
-], File.prototype, "length", null);
-__decorate([
-    Memoize()
-], File.prototype, "height", null);
-__decorate([
-    Memoize()
-], File.prototype, "width", null);
-__decorate([
-    Memoize()
-], File.prototype, "track", null);
+import { __decorate } from "tslib";
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { Memoize } from 'typescript-memoize';
+import { ByteParser, DurationParser, NumberParser, } from '@internetarchive/field-parsers';
+/**
+ * This represents an Internet Archive File
+ *
+ * @export
+ * @class File
+ */
+export class File {
+    constructor(json) {
+        this.rawValue = json;
+    }
+    get name() {
+        return this.rawValue.name;
+    }
+    get source() {
+        return this.rawValue.source;
+    }
+    get btih() {
+        return this.rawValue.btih;
+    }
+    get md5() {
+        return this.rawValue.md5;
+    }
+    get format() {
+        return this.rawValue.format;
+    }
+    get mtime() {
+        return this.rawValue.mtime;
+    }
+    get crc32() {
+        return this.rawValue.crc32;
+    }
+    get sha1() {
+        return this.rawValue.sha1;
+    }
+    get original() {
+        return this.rawValue.original;
+    }
+    get size() {
+        return this.rawValue.size
+            ? ByteParser.shared.parseValue(this.rawValue.size)
+            : undefined;
+    }
+    get title() {
+        return this.rawValue.title;
+    }
+    get length() {
+        return this.rawValue.length
+            ? DurationParser.shared.parseValue(this.rawValue.length)
+            : undefined;
+    }
+    get height() {
+        return this.rawValue.height
+            ? NumberParser.shared.parseValue(this.rawValue.height)
+            : undefined;
+    }
+    get width() {
+        return this.rawValue.width
+            ? NumberParser.shared.parseValue(this.rawValue.width)
+            : undefined;
+    }
+    get track() {
+        return this.rawValue.track
+            ? NumberParser.shared.parseValue(this.rawValue.track)
+            : undefined;
+    }
+    get external_identifier() {
+        return this.rawValue.external_identifier;
+    }
+    get creator() {
+        return this.rawValue.creator;
+    }
+    get album() {
+        return this.rawValue.album;
+    }
+}
+__decorate([
+    Memoize()
+], File.prototype, "size", null);
+__decorate([
+    Memoize()
+], File.prototype, "length", null);
+__decorate([
+    Memoize()
+], File.prototype, "height", null);
+__decorate([
+    Memoize()
+], File.prototype, "width", null);
+__decorate([
+    Memoize()
+], File.prototype, "track", null);
 //# sourceMappingURL=file.js.map

package/dist/src/models/metadata-fields/field-types/boolean.d.ts

@@ -1,5 +1,5 @@
-import { BooleanParser } from '@internetarchive/field-parsers';
-import { MetadataField, MetadataRawValue } from '../metadata-field';
-export declare class BooleanField extends MetadataField<boolean, BooleanParser> {
-    constructor(rawValue: MetadataRawValue);
-}
+import { BooleanParser } from '@internetarchive/field-parsers';
+import { MetadataField, MetadataRawValue } from '../metadata-field';
+export declare class BooleanField extends MetadataField<boolean, BooleanParser> {
+    constructor(rawValue: MetadataRawValue);
+}

package/dist/src/models/metadata-fields/field-types/boolean.js

@@ -1,8 +1,8 @@
-import { BooleanParser } from '@internetarchive/field-parsers';
-import { MetadataField } from '../metadata-field';
-export class BooleanField extends MetadataField {
-    constructor(rawValue) {
-        super(BooleanParser.shared, rawValue);
-    }
-}
+import { BooleanParser } from '@internetarchive/field-parsers';
+import { MetadataField } from '../metadata-field';
+export class BooleanField extends MetadataField {
+    constructor(rawValue) {
+        super(BooleanParser.shared, rawValue);
+    }
+}
 //# sourceMappingURL=boolean.js.map

package/dist/src/models/metadata-fields/field-types/byte.d.ts

@@ -1,13 +1,13 @@
-import { Byte, ByteParser } from '@internetarchive/field-parsers';
-import { MetadataField, MetadataRawValue } from '../metadata-field';
-/**
- * ByteField is a unit-specific number field that
- * returns a value in bytes
- *
- * @export
- * @class ByteField
- * @extends {MetadataField<Byte, ByteParser>}
- */
-export declare class ByteField extends MetadataField<Byte, ByteParser> {
-    constructor(rawValue: MetadataRawValue);
-}
+import { Byte, ByteParser } from '@internetarchive/field-parsers';
+import { MetadataField, MetadataRawValue } from '../metadata-field';
+/**
+ * ByteField is a unit-specific number field that
+ * returns a value in bytes
+ *
+ * @export
+ * @class ByteField
+ * @extends {MetadataField<Byte, ByteParser>}
+ */
+export declare class ByteField extends MetadataField<Byte, ByteParser> {
+    constructor(rawValue: MetadataRawValue);
+}