@internetarchive/metadata-service 0.0.0-bc6513-0

package/dist/test/models/metadata-fields/metadata-field.test.js

@@ -0,0 +1,121 @@
+import { expect } from '@open-wc/testing';
+import { MetadataField } from '../../../src/models/metadata-fields/metadata-field';
+describe('Metadata Field', () => {
+    it('can be properly instantiated with single value', () => {
+        class MockParser {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            parseValue(rawValue) {
+                return rawValue;
+            }
+        }
+        const parser = new MockParser();
+        const metadataField = new MetadataField(parser, 'foo');
+        expect(metadataField.rawValue).to.equal('foo');
+        expect(metadataField.value).to.equal('foo');
+        expect(metadataField.values).to.deep.equal(['foo']);
+    });
+    it('can be properly instantiated with array value', () => {
+        class MockParser {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            parseValue(rawValue) {
+                return rawValue;
+            }
+        }
+        const parser = new MockParser();
+        const metadataField = new MetadataField(parser, ['foo', 'bar', 'baz']);
+        expect(metadataField.rawValue).to.deep.equal(['foo', 'bar', 'baz']);
+        expect(metadataField.value).to.equal('foo');
+        expect(metadataField.values).to.deep.equal(['foo', 'bar', 'baz']);
+    });
+    it('properly casts values to expected parser type for single values', () => {
+        class MockFloatParser {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            parseValue(rawValue) {
+                return parseFloat(rawValue);
+            }
+        }
+        const parser = new MockFloatParser();
+        const metadataField = new MetadataField(parser, '1.3');
+        expect(metadataField.rawValue).to.equal('1.3');
+        expect(metadataField.value).to.equal(1.3);
+        expect(metadataField.values).to.deep.equal([1.3]);
+    });
+    it('properly casts values to expected parser type for array values', () => {
+        class MockFloatParser {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            parseValue(rawValue) {
+                return parseFloat(rawValue);
+            }
+        }
+        const parser = new MockFloatParser();
+        const metadataField = new MetadataField(parser, ['1.3', '2.4', '4.5']);
+        expect(metadataField.rawValue).to.deep.equal(['1.3', '2.4', '4.5']);
+        expect(metadataField.value).to.equal(1.3);
+        expect(metadataField.values).to.deep.equal([1.3, 2.4, 4.5]);
+    });
+    it('has no value if a raw value was not passed in', () => {
+        class MockFloatParser {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            parseValue(rawValue) {
+                return rawValue;
+            }
+        }
+        const parser = new MockFloatParser();
+        const metadataField = new MetadataField(parser);
+        expect(metadataField.rawValue).to.equal(undefined);
+        expect(metadataField.value).to.equal(undefined);
+        expect(metadataField.values).to.deep.equal([]);
+    });
+    it('does not add value to values array if parsed value is undefined', () => {
+        class MockFloatParser {
+            parseValue(rawValue) {
+                return undefined;
+            }
+        }
+        const parser = new MockFloatParser();
+        const metadataField = new MetadataField(parser);
+        expect(metadataField.rawValue).to.equal(undefined);
+        expect(metadataField.value).to.equal(undefined);
+        expect(metadataField.values).to.deep.equal([]);
+    });
+    it('handles falsy `0` return values properly', () => {
+        class MockFloatParser {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            parseValue(rawValue) {
+                return rawValue;
+            }
+        }
+        const parser = new MockFloatParser();
+        const metadataField = new MetadataField(parser, 0);
+        expect(metadataField.rawValue).to.equal(0);
+        expect(metadataField.value).to.equal(0);
+        expect(metadataField.values).to.deep.equal([0]);
+    });
+    it('handles falsy `false` return values properly', () => {
+        class MockFloatParser {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            parseValue(rawValue) {
+                return rawValue;
+            }
+        }
+        const parser = new MockFloatParser();
+        const metadataField = new MetadataField(parser, false);
+        expect(metadataField.rawValue).to.equal(false);
+        expect(metadataField.value).to.equal(false);
+        expect(metadataField.values).to.deep.equal([false]);
+    });
+    it('handles falsy empty string return values properly', () => {
+        class MockFloatParser {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            parseValue(rawValue) {
+                return rawValue;
+            }
+        }
+        const parser = new MockFloatParser();
+        const metadataField = new MetadataField(parser, '');
+        expect(metadataField.rawValue).to.equal('');
+        expect(metadataField.value).to.equal('');
+        expect(metadataField.values).to.deep.equal(['']);
+    });
+});
+//# sourceMappingURL=metadata-field.test.js.map

package/dist/test/models/metadata-fields/metadata-field.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata-field.test.js","sourceRoot":"","sources":["../../../../test/models/metadata-fields/metadata-field.test.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,aAAa,EAAE,MAAM,oDAAoD,CAAC;AAEnF,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;IAC9B,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;QACxD,MAAM,UAAU;YACd,8DAA8D;YAC9D,UAAU,CAAC,QAAa;gBACtB,OAAO,QAAQ,CAAC;YAClB,CAAC;SACF;QAED,MAAM,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;QAChC,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAEvD,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC/C,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC5C,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;QACvD,MAAM,UAAU;YACd,8DAA8D;YAC9D,UAAU,CAAC,QAAa;gBACtB,OAAO,QAAQ,CAAC;YAClB,CAAC;SACF;QAED,MAAM,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;QAChC,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;QAEvE,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;QACpE,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC5C,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;IACpE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;QACzE,MAAM,eAAe;YACnB,8DAA8D;YAC9D,UAAU,CAAC,QAAa;gBACtB,OAAO,UAAU,CAAC,QAAQ,CAAC,CAAC;YAC9B,CAAC;SACF;QAED,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;QACrC,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAEvD,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC/C,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC1C,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACxE,MAAM,eAAe;YACnB,8DAA8D;YAC9D,UAAU,CAAC,QAAa;gBACtB,OAAO,UAAU,CAAC,QAAQ,CAAC,CAAC;YAC9B,CAAC;SACF;QAED,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;QACrC,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;QAEvE,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC;QACpE,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC1C,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;QACvD,MAAM,eAAe;YACnB,8DAA8D;YAC9D,UAAU,CAAC,QAAa;gBACtB,OAAO,QAAQ,CAAC;YAClB,CAAC;SACF;QAED,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;QACrC,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC,MAAM,CAAC,CAAC;QAEhD,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACnD,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAChD,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;QACzE,MAAM,eAAe;YACnB,UAAU,CAAC,QAA6B;gBACtC,OAAO,SAAS,CAAC;YACnB,CAAC;SACF;QAED,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;QACrC,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC,MAAM,CAAC,CAAC;QAEhD,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACnD,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAChD,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;QAClD,MAAM,eAAe;YACnB,8DAA8D;YAC9D,UAAU,CAAC,QAAa;gBACtB,OAAO,QAAQ,CAAC;YAClB,CAAC;SACF;QAED,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;QACrC,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QAEnD,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC3C,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACxC,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACtD,MAAM,eAAe;YACnB,8DAA8D;YAC9D,UAAU,CAAC,QAAa;gBACtB,OAAO,QAAQ,CAAC;YAClB,CAAC;SACF;QAED,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;QACrC,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAEvD,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC/C,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC5C,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;QAC3D,MAAM,eAAe;YACnB,8DAA8D;YAC9D,UAAU,CAAC,QAAa;gBACtB,OAAO,QAAQ,CAAC;YAClB,CAAC;SACF;QAED,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;QACrC,MAAM,aAAa,GAAG,IAAI,aAAa,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAEpD,MAAM,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAC5C,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACzC,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import {\n  FieldParserInterface,\n  FieldParserRawValue,\n} from '@internetarchive/field-parsers';\nimport { expect } from '@open-wc/testing';\nimport { MetadataField } from '../../../src/models/metadata-fields/metadata-field';\n\ndescribe('Metadata Field', () => {\n  it('can be properly instantiated with single value', () => {\n    class MockParser implements FieldParserInterface<string> {\n      // eslint-disable-next-line @typescript-eslint/no-explicit-any\n      parseValue(rawValue: any): string {\n        return rawValue;\n      }\n    }\n\n    const parser = new MockParser();\n    const metadataField = new MetadataField(parser, 'foo');\n\n    expect(metadataField.rawValue).to.equal('foo');\n    expect(metadataField.value).to.equal('foo');\n    expect(metadataField.values).to.deep.equal(['foo']);\n  });\n\n  it('can be properly instantiated with array value', () => {\n    class MockParser implements FieldParserInterface<string> {\n      // eslint-disable-next-line @typescript-eslint/no-explicit-any\n      parseValue(rawValue: any): string {\n        return rawValue;\n      }\n    }\n\n    const parser = new MockParser();\n    const metadataField = new MetadataField(parser, ['foo', 'bar', 'baz']);\n\n    expect(metadataField.rawValue).to.deep.equal(['foo', 'bar', 'baz']);\n    expect(metadataField.value).to.equal('foo');\n    expect(metadataField.values).to.deep.equal(['foo', 'bar', 'baz']);\n  });\n\n  it('properly casts values to expected parser type for single values', () => {\n    class MockFloatParser implements FieldParserInterface<number> {\n      // eslint-disable-next-line @typescript-eslint/no-explicit-any\n      parseValue(rawValue: any): number {\n        return parseFloat(rawValue);\n      }\n    }\n\n    const parser = new MockFloatParser();\n    const metadataField = new MetadataField(parser, '1.3');\n\n    expect(metadataField.rawValue).to.equal('1.3');\n    expect(metadataField.value).to.equal(1.3);\n    expect(metadataField.values).to.deep.equal([1.3]);\n  });\n\n  it('properly casts values to expected parser type for array values', () => {\n    class MockFloatParser implements FieldParserInterface<number> {\n      // eslint-disable-next-line @typescript-eslint/no-explicit-any\n      parseValue(rawValue: any): number {\n        return parseFloat(rawValue);\n      }\n    }\n\n    const parser = new MockFloatParser();\n    const metadataField = new MetadataField(parser, ['1.3', '2.4', '4.5']);\n\n    expect(metadataField.rawValue).to.deep.equal(['1.3', '2.4', '4.5']);\n    expect(metadataField.value).to.equal(1.3);\n    expect(metadataField.values).to.deep.equal([1.3, 2.4, 4.5]);\n  });\n\n  it('has no value if a raw value was not passed in', () => {\n    class MockFloatParser implements FieldParserInterface<number> {\n      // eslint-disable-next-line @typescript-eslint/no-explicit-any\n      parseValue(rawValue: any): number {\n        return rawValue;\n      }\n    }\n\n    const parser = new MockFloatParser();\n    const metadataField = new MetadataField(parser);\n\n    expect(metadataField.rawValue).to.equal(undefined);\n    expect(metadataField.value).to.equal(undefined);\n    expect(metadataField.values).to.deep.equal([]);\n  });\n\n  it('does not add value to values array if parsed value is undefined', () => {\n    class MockFloatParser implements FieldParserInterface<number> {\n      parseValue(rawValue: FieldParserRawValue): number | undefined {\n        return undefined;\n      }\n    }\n\n    const parser = new MockFloatParser();\n    const metadataField = new MetadataField(parser);\n\n    expect(metadataField.rawValue).to.equal(undefined);\n    expect(metadataField.value).to.equal(undefined);\n    expect(metadataField.values).to.deep.equal([]);\n  });\n\n  it('handles falsy `0` return values properly', () => {\n    class MockFloatParser implements FieldParserInterface<number> {\n      // eslint-disable-next-line @typescript-eslint/no-explicit-any\n      parseValue(rawValue: any): number {\n        return rawValue;\n      }\n    }\n\n    const parser = new MockFloatParser();\n    const metadataField = new MetadataField(parser, 0);\n\n    expect(metadataField.rawValue).to.equal(0);\n    expect(metadataField.value).to.equal(0);\n    expect(metadataField.values).to.deep.equal([0]);\n  });\n\n  it('handles falsy `false` return values properly', () => {\n    class MockFloatParser implements FieldParserInterface<number> {\n      // eslint-disable-next-line @typescript-eslint/no-explicit-any\n      parseValue(rawValue: any): number {\n        return rawValue;\n      }\n    }\n\n    const parser = new MockFloatParser();\n    const metadataField = new MetadataField(parser, false);\n\n    expect(metadataField.rawValue).to.equal(false);\n    expect(metadataField.value).to.equal(false);\n    expect(metadataField.values).to.deep.equal([false]);\n  });\n\n  it('handles falsy empty string return values properly', () => {\n    class MockFloatParser implements FieldParserInterface<number> {\n      // eslint-disable-next-line @typescript-eslint/no-explicit-any\n      parseValue(rawValue: any): number {\n        return rawValue;\n      }\n    }\n\n    const parser = new MockFloatParser();\n    const metadataField = new MetadataField(parser, '');\n\n    expect(metadataField.rawValue).to.equal('');\n    expect(metadataField.value).to.equal('');\n    expect(metadataField.values).to.deep.equal(['']);\n  });\n});\n"]}

package/dist/test/models/metadata.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/test/models/metadata.test.js

@@ -0,0 +1,10 @@
+import { expect } from '@open-wc/testing';
+import { Metadata } from '../../src/models/metadata';
+describe('Metadata', () => {
+    it('properly instantiates metadata with identifier', async () => {
+        const json = { identifier: 'foo', collection: 'bar' };
+        const metadata = new Metadata(json);
+        expect(metadata.identifier).to.equal('foo');
+    });
+});
+//# sourceMappingURL=metadata.test.js.map

package/dist/test/models/metadata.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadata.test.js","sourceRoot":"","sources":["../../../test/models/metadata.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE1C,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AAErD,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;IACxB,EAAE,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;QAC9D,MAAM,IAAI,GAAG,EAAE,UAAU,EAAE,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC;QACtD,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,CAAC;QACpC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { expect } from '@open-wc/testing';\n\nimport { Metadata } from '../../src/models/metadata';\n\ndescribe('Metadata', () => {\n  it('properly instantiates metadata with identifier', async () => {\n    const json = { identifier: 'foo', collection: 'bar' };\n    const metadata = new Metadata(json);\n    expect(metadata.identifier).to.equal('foo');\n  });\n});\n"]}

package/index.ts

@@ -0,0 +1,32 @@
+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/package.json

@@ -0,0 +1,77 @@
+{
+  "name": "@internetarchive/metadata-service",
+  "version": "0.0.0-bc6513-0",
+  "description": "A service for fetching metadata about items in the Internet Archive",
+  "license": "AGPL-3.0-only",
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "start": "concurrently --kill-others --names tsc,web-dev-server \"npm run tsc:watch\" \"web-dev-server --app-index demo/index.html --node-resolve --open --watch\"",
+    "tsc:watch": "tsc --watch",
+    "docs": "typedoc ./index.ts",
+    "prepare": "tsc",
+    "lint:eslint": "eslint --ext .ts,.html . --ignore-path .gitignore",
+    "format:eslint": "eslint --ext .ts,.html . --fix --ignore-path .gitignore",
+    "lint:prettier": "prettier \"**/*.js\" \"**/*.ts\" --check --ignore-path .gitignore",
+    "format:prettier": "prettier \"**/*.js\" \"**/*.ts\" --write --ignore-path .gitignore",
+    "lint": "npm run lint:eslint && npm run lint:prettier",
+    "format": "npm run format:eslint && npm run format:prettier",
+    "circular": "madge --circular --extensions ts .",
+    "test": "tsc && npm run lint && npm run circular && web-test-runner --coverage",
+    "test:watch": "web-test-runner --watch",
+    "codecov": "npx codecov"
+  },
+  "devDependencies": {
+    "@open-wc/eslint-config": "^4.2.0",
+    "@open-wc/testing": "^2.0.0",
+    "@types/node": "13.11.1",
+    "@typescript-eslint/eslint-plugin": "^4.16.1",
+    "@typescript-eslint/parser": "^4.16.1",
+    "@web/dev-server": "^0.0.12",
+    "@web/test-runner": "^0.13.23",
+    "concurrently": "^5.1.0",
+    "eslint": "^7.21.0",
+    "eslint-config-prettier": "^6.11.0",
+    "husky": "^1.0.0",
+    "lint-staged": "^10.0.0",
+    "lit-element": "^2.4.0",
+    "lit-html": "^1.3.0",
+    "madge": "^3.12.0",
+    "prettier": "^2.0.4",
+    "tslib": "^1.14.1",
+    "typedoc": "^0.20.29",
+    "typescript": "^4.2.2"
+  },
+  "eslintConfig": {
+    "extends": [
+      "@open-wc/eslint-config",
+      "eslint-config-prettier"
+    ]
+  },
+  "prettier": {
+    "singleQuote": true,
+    "arrowParens": "avoid"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
+  },
+  "lint-staged": {
+    "*.ts": [
+      "eslint --fix",
+      "prettier --write",
+      "git add"
+    ]
+  },
+  "dependencies": {
+    "@internetarchive/field-parsers": "^0.1.3",
+    "@internetarchive/result-type": "^0.0.1",
+    "decorator-cache-getter": "^1.0.0",
+    "typescript-memoize": "^1.1.0"
+  }
+}

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

@@ -0,0 +1,141 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import type { Result } from '@internetarchive/result-type';
+import { MetadataBackendInterface } from './metadata-backend-interface';
+import {
+  MetadataServiceError,
+  MetadataServiceErrorType,
+} from '../metadata-service-error';
+
+/**
+ * The DefaultSearchBackend performs a `window.fetch` request to archive.org
+ */
+export class DefaultMetadataBackend implements MetadataBackendInterface {
+  private baseUrl: string;
+
+  private includeCredentials: boolean;
+
+  private requestScope?: string;
+
+  constructor(options?: {
+    baseUrl?: string;
+    includeCredentials?: boolean;
+    scope?: string;
+  }) {
+    this.baseUrl = options?.baseUrl ?? 'archive.org';
+
+    if (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?.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: string,
+    keypath?: string
+  ): Promise<Result<any, MetadataServiceError>> {
+    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.
+   */
+  protected async fetchUrl(
+    url: string,
+    options?: {
+      requestOptions?: RequestInit;
+    }
+  ): Promise<Result<any, MetadataServiceError>> {
+    const finalUrl = new URL(url);
+    if (this.requestScope) {
+      finalUrl.searchParams.set('scope', this.requestScope);
+    }
+
+    let response: Response;
+    // first try the fetch and return a networkError if it fails
+    try {
+      const fetchOptions = options?.requestOptions ?? {
+        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
+      );
+    }
+  }
+
+  private getErrorResult(
+    errorType: MetadataServiceErrorType,
+    message?: string,
+    details?: any
+  ): Result<any, MetadataServiceError> {
+    const error = new MetadataServiceError(errorType, message, details);
+    const result = { error };
+    return result;
+  }
+}

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

@@ -0,0 +1,25 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+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/src/metadata-service-error.ts

@@ -0,0 +1,21 @@
+/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
+/* eslint-disable @typescript-eslint/no-explicit-any */
+export enum MetadataServiceErrorType {
+  networkError = 'MetadataService.NetworkError',
+  itemNotFound = 'MetadataService.ItemNotFound',
+  decodingError = 'MetadataService.DecodingError',
+  searchEngineError = 'MetadataService.SearchEngineError',
+}
+
+export class MetadataServiceError extends Error {
+  type: MetadataServiceErrorType;
+
+  details?: any;
+
+  constructor(type: MetadataServiceErrorType, message?: string, details?: any) {
+    super(message);
+    this.name = type;
+    this.type = type;
+    this.details = details;
+  }
+}

package/src/metadata-service-interface.ts

@@ -0,0 +1,51 @@
+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/src/metadata-service.ts

@@ -0,0 +1,63 @@
+import { MetadataResponse } from './responses/metadata-response';
+import {
+  MetadataServiceError,
+  MetadataServiceErrorType,
+} from './metadata-service-error';
+import type { MetadataServiceInterface } from './metadata-service-interface';
+import type { Result } from '@internetarchive/result-type';
+import { DefaultMetadataBackend } from './backend/default-metadata-backend';
+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 class MetadataService implements MetadataServiceInterface {
+  public static default: MetadataServiceInterface = new MetadataService(
+    new DefaultMetadataBackend()
+  );
+
+  private backend: MetadataBackendInterface;
+
+  constructor(backend: MetadataBackendInterface) {
+    this.backend = backend;
+  }
+
+  /** @inheritdoc */
+  async fetchMetadata(
+    identifier: string
+  ): Promise<Result<MetadataResponse, MetadataServiceError>> {
+    const rawResponse = await this.backend.fetchMetadata(identifier);
+    if (rawResponse.error) {
+      return rawResponse;
+    }
+
+    if (rawResponse.success?.metadata === undefined) {
+      return {
+        error: new MetadataServiceError(MetadataServiceErrorType.itemNotFound),
+      };
+    }
+
+    const modeledResponse = new MetadataResponse(rawResponse.success);
+    return { success: modeledResponse };
+  }
+
+  /** @inheritdoc */
+  async fetchMetadataValue<T>(
+    identifier: string,
+    keypath: string
+  ): Promise<Result<T, MetadataServiceError>> {
+    const result = await this.backend.fetchMetadata(identifier, keypath);
+    if (result.error) {
+      return result;
+    }
+
+    if (result.success?.result === undefined) {
+      return {
+        error: new MetadataServiceError(MetadataServiceErrorType.itemNotFound),
+      };
+    }
+
+    return { success: result.success.result };
+  }
+}