@internetarchive/metadata-service 0.1.0 → 0.1.1

package/README.md

@@ -1,64 +1,64 @@
-# Internet Archive Metadata Service
-
-A service for retrieving metadata about items in the Internet Archive.
-
-## Installation
-```bash
-npm install @internetarchive/metadata-service
-```
-
-## Usage
-
-### Fetch Metadata
-
-```ts
-const metadataResponse: MetadataResponse = await metadataService.fetchMetadata('some-identifier');
-
-metadataResponse.metadata.identifier // => 'some-identifier'
-metadataResponse.metadata.collection.value // => 'some-collection'
-metadataResponse.metadata.collection.values // => ['some-collection', 'another-collection', 'more-collections']
-```
-
-## Metadata Values
-
-Internet Archive Metadata is expansive and nearly all metadata fields can be returned as either an array, string, or number.
-
-The Metadata Service handles all of the possible variations in data formats and converts them to their appropriate types. For instance on date fields, like `date`, it takes the string returned and converts it into a native javascript `Date` value. Similarly for duration-type fields, like `length`, it takes the duration, which can be seconds `324.34` or `hh:mm:ss.ms` and converts them to a `number` in seconds.
-
-There are parsers for several different field types, like `Number`, `String`, `Date`, and `Duration` and others can be added for other field types.
-
-See `src/models/metadata-fields/field-types.ts`
-
-### Usage
-
-```ts
-metadata.collection.value // return just the first item of the `values` array, ie. 'my-collection'
-metadata.collection.values // returns all values of the array, ie. ['my-collection', 'other-collection']
-metadata.collection.rawValue // return the rawValue. This is useful for inspecting the raw response received.
-
-metadata.date.value  // return the date as a javascript `Date` object
-
-metadata.length.value  // return the length (duration) of the item as a number of seconds, can be in the format "hh:mm:ss" or decimal seconds
-```
-
-# Development
-
-## Prerequisite
-```bash
-npm install
-```
-
-## Testing
-```bash
-npm run test
-```
-
-## Demo
-```bash
-npm run start
-```
-
-## Linting
-```bash
-npm run format
-```
+# Internet Archive Metadata Service
+
+A service for retrieving metadata about items in the Internet Archive.
+
+## Installation
+```bash
+npm install @internetarchive/metadata-service
+```
+
+## Usage
+
+### Fetch Metadata
+
+```ts
+const metadataResponse: MetadataResponse = await metadataService.fetchMetadata('some-identifier');
+
+metadataResponse.metadata.identifier // => 'some-identifier'
+metadataResponse.metadata.collection.value // => 'some-collection'
+metadataResponse.metadata.collection.values // => ['some-collection', 'another-collection', 'more-collections']
+```
+
+## Metadata Values
+
+Internet Archive Metadata is expansive and nearly all metadata fields can be returned as either an array, string, or number.
+
+The Metadata Service handles all of the possible variations in data formats and converts them to their appropriate types. For instance on date fields, like `date`, it takes the string returned and converts it into a native javascript `Date` value. Similarly for duration-type fields, like `length`, it takes the duration, which can be seconds `324.34` or `hh:mm:ss.ms` and converts them to a `number` in seconds.
+
+There are parsers for several different field types, like `Number`, `String`, `Date`, and `Duration` and others can be added for other field types.
+
+See `src/models/metadata-fields/field-types.ts`
+
+### Usage
+
+```ts
+metadata.collection.value // return just the first item of the `values` array, ie. 'my-collection'
+metadata.collection.values // returns all values of the array, ie. ['my-collection', 'other-collection']
+metadata.collection.rawValue // return the rawValue. This is useful for inspecting the raw response received.
+
+metadata.date.value  // return the date as a javascript `Date` object
+
+metadata.length.value  // return the length (duration) of the item as a number of seconds, can be in the format "hh:mm:ss" or decimal seconds
+```
+
+# Development
+
+## Prerequisite
+```bash
+npm install
+```
+
+## Testing
+```bash
+npm run test
+```
+
+## Demo
+```bash
+npm run start
+```
+
+## Linting
+```bash
+npm run format
+```

package/demo/index.html

@@ -1,27 +1,27 @@
-<!doctype html>
-<html lang="en-GB">
-<head>
-  <meta charset="utf-8">
-  <style>
-    body {
-      background: #fff;
-      font-family: sans-serif;
-    }
-  </style>
-</head>
-<body>
-  <div id="demo"></div>
-
-  <script type="module">
-    import { html, render } from 'lit-html';
-    import '../dist/demo/app-root.js';
-
-    render(
-      html`
-        <app-root></app-root>
-      `,
-      document.querySelector('#demo')
-    );
-  </script>
-</body>
-</html>
+<!doctype html>
+<html lang="en-GB">
+<head>
+  <meta charset="utf-8">
+  <style>
+    body {
+      background: #fff;
+      font-family: sans-serif;
+    }
+  </style>
+</head>
+<body>
+  <div id="demo"></div>
+
+  <script type="module">
+    import { html, render } from 'lit-html';
+    import '../dist/demo/app-root.js';
+
+    render(
+      html`
+        <app-root></app-root>
+      `,
+      document.querySelector('#demo')
+    );
+  </script>
+</body>
+</html>

package/dist/demo/app-root.d.ts

@@ -1,11 +1,11 @@
-import { CSSResult, LitElement, TemplateResult } from 'lit-element';
-export declare class AppRoot extends LitElement {
-    private metadataService;
-    private metadataInput;
-    private metadataResponse?;
-    /** @inheritdoc */
-    render(): TemplateResult;
-    private get metadataTemplate();
-    getMetadata(e: Event): Promise<void>;
-    static get styles(): CSSResult;
-}
+import { CSSResult, LitElement, TemplateResult } from 'lit-element';
+export declare class AppRoot extends LitElement {
+    private metadataService;
+    private metadataInput;
+    private metadataResponse?;
+    /** @inheritdoc */
+    render(): TemplateResult;
+    private get metadataTemplate();
+    getMetadata(e: Event): Promise<void>;
+    static get styles(): CSSResult;
+}

package/dist/demo/app-root.js

@@ -1,15 +1,15 @@
-import { __decorate } from "tslib";
-import { css, customElement, html, internalProperty, LitElement, query, } from 'lit-element';
-import { unsafeHTML } from 'lit-html/directives/unsafe-html';
-import { nothing } from 'lit-html';
-import { MetadataService } from '../src/metadata-service';
-let AppRoot = class AppRoot extends LitElement {
-    constructor() {
-        super(...arguments);
-        this.metadataService = MetadataService.default;
-    }
-    /** @inheritdoc */
-    render() {
+import { __decorate } from "tslib";
+import { css, customElement, html, internalProperty, LitElement, query, } from 'lit-element';
+import { unsafeHTML } from 'lit-html/directives/unsafe-html';
+import { nothing } from 'lit-html';
+import { MetadataService } from '../src/metadata-service';
+let AppRoot = class AppRoot extends LitElement {
+    constructor() {
+        super(...arguments);
+        this.metadataService = MetadataService.default;
+    }
+    /** @inheritdoc */
+    render() {
         return html `
       <fieldset>
         <legend>Metadata Fetch</legend>
@@ -25,13 +25,13 @@ let AppRoot = class AppRoot extends LitElement {
       </fieldset>
 
       ${this.metadataResponse ? this.metadataTemplate : nothing}
-    `;
-    }
-    get metadataTemplate() {
-        var _a;
-        const rawMetadata = (_a = this.metadataResponse) === null || _a === void 0 ? void 0 : _a.metadata.rawMetadata;
-        if (!rawMetadata)
-            return html `${nothing}`;
+    `;
+    }
+    get metadataTemplate() {
+        var _a;
+        const rawMetadata = (_a = this.metadataResponse) === null || _a === void 0 ? void 0 : _a.metadata.rawMetadata;
+        if (!rawMetadata)
+            return html `${nothing}`;
         return html `
       <h2>Metadata Response</h2>
       <table>
@@ -42,30 +42,30 @@ let AppRoot = class AppRoot extends LitElement {
             </tr>
           `)}
       </table>
-    `;
-    }
-    async getMetadata(e) {
-        e.preventDefault();
-        const identifier = this.metadataInput.value;
-        const result = await this.metadataService.fetchMetadata(identifier);
-        this.metadataResponse = result === null || result === void 0 ? void 0 : result.success;
-    }
-    static get styles() {
+    `;
+    }
+    async getMetadata(e) {
+        e.preventDefault();
+        const identifier = this.metadataInput.value;
+        const result = await this.metadataService.fetchMetadata(identifier);
+        this.metadataResponse = result === null || result === void 0 ? void 0 : result.success;
+    }
+    static get styles() {
         return css `
       /* th {
         font-weight: bold;
       } */
-    `;
-    }
-};
-__decorate([
-    query('#metadata-input')
-], AppRoot.prototype, "metadataInput", void 0);
-__decorate([
-    internalProperty()
-], AppRoot.prototype, "metadataResponse", void 0);
-AppRoot = __decorate([
-    customElement('app-root')
-], AppRoot);
-export { AppRoot };
+    `;
+    }
+};
+__decorate([
+    query('#metadata-input')
+], AppRoot.prototype, "metadataInput", void 0);
+__decorate([
+    internalProperty()
+], AppRoot.prototype, "metadataResponse", void 0);
+AppRoot = __decorate([
+    customElement('app-root')
+], AppRoot);
+export { AppRoot };
 //# sourceMappingURL=app-root.js.map

package/dist/index.d.ts

@@ -1,18 +1,18 @@
-export { Metadata } from './src/models/metadata';
-export { File } from './src/models/file';
-export { Review } from './src/models/review';
-export { SpeechMusicASREntry } from './src/models/speech-music-asr-entry';
-export { DateField } from './src/models/metadata-fields/field-types/date';
-export { NumberField } from './src/models/metadata-fields/field-types/number';
-export { StringField } from './src/models/metadata-fields/field-types/string';
-export { BooleanField } from './src/models/metadata-fields/field-types/boolean';
-export { ByteField } from './src/models/metadata-fields/field-types/byte';
-export { DurationField } from './src/models/metadata-fields/field-types/duration';
-export { PageProgressionField } from './src/models/metadata-fields/field-types/page-progression';
-export { MediaTypeField } from './src/models/metadata-fields/field-types/mediatype';
-export { MetadataFieldInterface, MetadataField, } from './src/models/metadata-fields/metadata-field';
-export { MetadataResponse } from './src/responses/metadata-response';
-export { DefaultMetadataBackend } from './src/backend/default-metadata-backend';
-export { MetadataServiceInterface } from './src/metadata-service-interface';
-export { MetadataService } from './src/metadata-service';
-export { MetadataServiceError } from './src/metadata-service-error';
+export { Metadata } from './src/models/metadata';
+export { File } from './src/models/file';
+export { Review } from './src/models/review';
+export { SpeechMusicASREntry } from './src/models/speech-music-asr-entry';
+export { DateField } from './src/models/metadata-fields/field-types/date';
+export { NumberField } from './src/models/metadata-fields/field-types/number';
+export { StringField } from './src/models/metadata-fields/field-types/string';
+export { BooleanField } from './src/models/metadata-fields/field-types/boolean';
+export { ByteField } from './src/models/metadata-fields/field-types/byte';
+export { DurationField } from './src/models/metadata-fields/field-types/duration';
+export { PageProgressionField } from './src/models/metadata-fields/field-types/page-progression';
+export { MediaTypeField } from './src/models/metadata-fields/field-types/mediatype';
+export { MetadataFieldInterface, MetadataField, } from './src/models/metadata-fields/metadata-field';
+export { MetadataResponse } from './src/responses/metadata-response';
+export { DefaultMetadataBackend } from './src/backend/default-metadata-backend';
+export { MetadataServiceInterface } from './src/metadata-service-interface';
+export { MetadataService } from './src/metadata-service';
+export { MetadataServiceError } from './src/metadata-service-error';

package/dist/index.js

@@ -1,17 +1,17 @@
-export { Metadata } from './src/models/metadata';
-export { File } from './src/models/file';
-export { Review } from './src/models/review';
-export { DateField } from './src/models/metadata-fields/field-types/date';
-export { NumberField } from './src/models/metadata-fields/field-types/number';
-export { StringField } from './src/models/metadata-fields/field-types/string';
-export { BooleanField } from './src/models/metadata-fields/field-types/boolean';
-export { ByteField } from './src/models/metadata-fields/field-types/byte';
-export { DurationField } from './src/models/metadata-fields/field-types/duration';
-export { PageProgressionField } from './src/models/metadata-fields/field-types/page-progression';
-export { MediaTypeField } from './src/models/metadata-fields/field-types/mediatype';
-export { MetadataField, } from './src/models/metadata-fields/metadata-field';
-export { MetadataResponse } from './src/responses/metadata-response';
-export { DefaultMetadataBackend } from './src/backend/default-metadata-backend';
-export { MetadataService } from './src/metadata-service';
-export { MetadataServiceError } from './src/metadata-service-error';
+export { Metadata } from './src/models/metadata';
+export { File } from './src/models/file';
+export { Review } from './src/models/review';
+export { DateField } from './src/models/metadata-fields/field-types/date';
+export { NumberField } from './src/models/metadata-fields/field-types/number';
+export { StringField } from './src/models/metadata-fields/field-types/string';
+export { BooleanField } from './src/models/metadata-fields/field-types/boolean';
+export { ByteField } from './src/models/metadata-fields/field-types/byte';
+export { DurationField } from './src/models/metadata-fields/field-types/duration';
+export { PageProgressionField } from './src/models/metadata-fields/field-types/page-progression';
+export { MediaTypeField } from './src/models/metadata-fields/field-types/mediatype';
+export { MetadataField, } from './src/models/metadata-fields/metadata-field';
+export { MetadataResponse } from './src/responses/metadata-response';
+export { DefaultMetadataBackend } from './src/backend/default-metadata-backend';
+export { MetadataService } from './src/metadata-service';
+export { MetadataServiceError } from './src/metadata-service-error';
 //# sourceMappingURL=index.js.map

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

@@ -1,27 +1,27 @@
-import type { Result } from '@internetarchive/result-type';
-import { MetadataBackendInterface } from './metadata-backend-interface';
-import { MetadataServiceError } from '../metadata-service-error';
-/**
- * The DefaultSearchBackend performs a `window.fetch` request to archive.org
- */
-export declare class DefaultMetadataBackend implements MetadataBackendInterface {
-    private baseUrl;
-    private includeCredentials;
-    private requestScope?;
-    constructor(options?: {
-        baseUrl?: string;
-        includeCredentials?: boolean;
-        scope?: string;
-    });
-    /** @inheritdoc */
-    fetchMetadata(identifier: string, keypath?: string): Promise<Result<any, MetadataServiceError>>;
-    /**
-     * Fires a request to the URL (with this backend's options applied) and
-     * asynchronously returns a Result object containing either the raw response
-     * JSON or a MetadataServiceError.
-     */
-    protected fetchUrl(url: string, options?: {
-        requestOptions?: RequestInit;
-    }): Promise<Result<any, MetadataServiceError>>;
-    private getErrorResult;
-}
+import type { Result } from '@internetarchive/result-type';
+import { MetadataBackendInterface } from './metadata-backend-interface';
+import { MetadataServiceError } from '../metadata-service-error';
+/**
+ * The DefaultSearchBackend performs a `window.fetch` request to archive.org
+ */
+export declare class DefaultMetadataBackend implements MetadataBackendInterface {
+    private baseUrl;
+    private includeCredentials;
+    private requestScope?;
+    constructor(options?: {
+        baseUrl?: string;
+        includeCredentials?: boolean;
+        scope?: string;
+    });
+    /** @inheritdoc */
+    fetchMetadata(identifier: string, keypath?: string): Promise<Result<any, MetadataServiceError>>;
+    /**
+     * Fires a request to the URL (with this backend's options applied) and
+     * asynchronously returns a Result object containing either the raw response
+     * JSON or a MetadataServiceError.
+     */
+    protected fetchUrl(url: string, options?: {
+        requestOptions?: RequestInit;
+    }): Promise<Result<any, MetadataServiceError>>;
+    private getErrorResult;
+}

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

@@ -1,101 +1,101 @@
-import { MetadataServiceError, MetadataServiceErrorType, } from '../metadata-service-error';
-/**
- * The DefaultSearchBackend performs a `window.fetch` request to archive.org
- */
-export class DefaultMetadataBackend {
-    constructor(options) {
-        var _a;
-        this.baseUrl = (_a = options === null || options === void 0 ? void 0 : options.baseUrl) !== null && _a !== void 0 ? _a : 'archive.org';
-        if ((options === null || options === void 0 ? void 0 : options.includeCredentials) !== undefined) {
-            this.includeCredentials = options.includeCredentials;
-        }
-        else {
-            // include credentials if the request is coming from an archive.org domain
-            // since credentialed requests are only allowed from archive.org domains
-            // due to CORS restrictions, see
-            // https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS/Errors/CORSNotSupportingCredentials
-            this.includeCredentials =
-                window.location.href.match(/^https?:\/\/.*archive\.org(:[0-9]+)?/) !==
-                    null;
-        }
-        if ((options === null || options === void 0 ? void 0 : options.scope) !== undefined) {
-            this.requestScope = options.scope;
-        }
-        else {
-            const currentUrl = new URL(window.location.href);
-            const scope = currentUrl.searchParams.get('scope');
-            if (scope) {
-                this.requestScope = scope;
-            }
-        }
-    }
-    /** @inheritdoc */
-    async fetchMetadata(identifier, keypath) {
-        const path = keypath ? `/${keypath}` : '';
-        const url = `https://${this.baseUrl}/metadata/${identifier}${path}`;
-        // the metadata endpoint doesn't currently support credentialed requests
-        // so don't include credentials until that is fixed
-        return this.fetchUrl(url, {
-            requestOptions: {
-                credentials: 'omit',
-            },
-        });
-    }
-    /**
-     * Fires a request to the URL (with this backend's options applied) and
-     * asynchronously returns a Result object containing either the raw response
-     * JSON or a MetadataServiceError.
-     */
-    async fetchUrl(url, options) {
-        var _a;
-        const finalUrl = new URL(url);
-        if (this.requestScope) {
-            finalUrl.searchParams.set('scope', this.requestScope);
-        }
-        let response;
-        // first try the fetch and return a networkError if it fails
-        try {
-            const fetchOptions = (_a = options === null || options === void 0 ? void 0 : options.requestOptions) !== null && _a !== void 0 ? _a : {
-                credentials: this.includeCredentials ? 'include' : 'same-origin',
-            };
-            response = await fetch(finalUrl.href, fetchOptions);
-        }
-        catch (err) {
-            const message = err instanceof Error
-                ? err.message
-                : typeof err === 'string'
-                    ? err
-                    : 'Unknown error';
-            return this.getErrorResult(MetadataServiceErrorType.networkError, message);
-        }
-        // then try json decoding and return a decodingError if it fails
-        try {
-            const json = await response.json();
-            // the advanced search endpoint doesn't return an HTTP Error 400
-            // and instead returns an HTTP 200 with an `error` key in the payload
-            const error = json['error'];
-            if (error) {
-                const forensics = json['forensics'];
-                return this.getErrorResult(MetadataServiceErrorType.searchEngineError, error, forensics);
-            }
-            else {
-                // success
-                return { success: json };
-            }
-        }
-        catch (err) {
-            const message = err instanceof Error
-                ? err.message
-                : typeof err === 'string'
-                    ? err
-                    : 'Unknown error';
-            return this.getErrorResult(MetadataServiceErrorType.decodingError, message);
-        }
-    }
-    getErrorResult(errorType, message, details) {
-        const error = new MetadataServiceError(errorType, message, details);
-        const result = { error };
-        return result;
-    }
-}
+import { MetadataServiceError, MetadataServiceErrorType, } from '../metadata-service-error';
+/**
+ * The DefaultSearchBackend performs a `window.fetch` request to archive.org
+ */
+export class DefaultMetadataBackend {
+    constructor(options) {
+        var _a;
+        this.baseUrl = (_a = options === null || options === void 0 ? void 0 : options.baseUrl) !== null && _a !== void 0 ? _a : 'archive.org';
+        if ((options === null || options === void 0 ? void 0 : options.includeCredentials) !== undefined) {
+            this.includeCredentials = options.includeCredentials;
+        }
+        else {
+            // include credentials if the request is coming from an archive.org domain
+            // since credentialed requests are only allowed from archive.org domains
+            // due to CORS restrictions, see
+            // https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS/Errors/CORSNotSupportingCredentials
+            this.includeCredentials =
+                window.location.href.match(/^https?:\/\/.*archive\.org(:[0-9]+)?/) !==
+                    null;
+        }
+        if ((options === null || options === void 0 ? void 0 : options.scope) !== undefined) {
+            this.requestScope = options.scope;
+        }
+        else {
+            const currentUrl = new URL(window.location.href);
+            const scope = currentUrl.searchParams.get('scope');
+            if (scope) {
+                this.requestScope = scope;
+            }
+        }
+    }
+    /** @inheritdoc */
+    async fetchMetadata(identifier, keypath) {
+        const path = keypath ? `/${keypath}` : '';
+        const url = `https://${this.baseUrl}/metadata/${identifier}${path}`;
+        // the metadata endpoint doesn't currently support credentialed requests
+        // so don't include credentials until that is fixed
+        return this.fetchUrl(url, {
+            requestOptions: {
+                credentials: 'omit',
+            },
+        });
+    }
+    /**
+     * Fires a request to the URL (with this backend's options applied) and
+     * asynchronously returns a Result object containing either the raw response
+     * JSON or a MetadataServiceError.
+     */
+    async fetchUrl(url, options) {
+        var _a;
+        const finalUrl = new URL(url);
+        if (this.requestScope) {
+            finalUrl.searchParams.set('scope', this.requestScope);
+        }
+        let response;
+        // first try the fetch and return a networkError if it fails
+        try {
+            const fetchOptions = (_a = options === null || options === void 0 ? void 0 : options.requestOptions) !== null && _a !== void 0 ? _a : {
+                credentials: this.includeCredentials ? 'include' : 'same-origin',
+            };
+            response = await fetch(finalUrl.href, fetchOptions);
+        }
+        catch (err) {
+            const message = err instanceof Error
+                ? err.message
+                : typeof err === 'string'
+                    ? err
+                    : 'Unknown error';
+            return this.getErrorResult(MetadataServiceErrorType.networkError, message);
+        }
+        // then try json decoding and return a decodingError if it fails
+        try {
+            const json = await response.json();
+            // the advanced search endpoint doesn't return an HTTP Error 400
+            // and instead returns an HTTP 200 with an `error` key in the payload
+            const error = json['error'];
+            if (error) {
+                const forensics = json['forensics'];
+                return this.getErrorResult(MetadataServiceErrorType.searchEngineError, error, forensics);
+            }
+            else {
+                // success
+                return { success: json };
+            }
+        }
+        catch (err) {
+            const message = err instanceof Error
+                ? err.message
+                : typeof err === 'string'
+                    ? err
+                    : 'Unknown error';
+            return this.getErrorResult(MetadataServiceErrorType.decodingError, message);
+        }
+    }
+    getErrorResult(errorType, message, details) {
+        const error = new MetadataServiceError(errorType, message, details);
+        const result = { error };
+        return result;
+    }
+}
 //# sourceMappingURL=default-metadata-backend.js.map