@internetarchive/metadata-service 0.1.0 → 0.1.1

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

@@ -1,121 +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(['']);
-    });
-});
+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.test.d.ts

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

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

@@ -1,10 +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');
-    });
-});
+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/package.json

@@ -1,77 +1,77 @@
-{
-  "name": "@internetarchive/metadata-service",
-  "version": "0.1.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"
-  }
-}
+{
+  "name": "@internetarchive/metadata-service",
+  "version": "0.1.1",
+  "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/models/metadata.ts

@@ -127,6 +127,12 @@ export class Metadata {
       : undefined;
   }
 
+  @Memoize() get collection_layout(): StringField | undefined {
+    return this.rawMetadata?.collection_layout
+      ? new StringField(this.rawMetadata.collection_layout)
+      : undefined;
+  }
+
   @Memoize() get date(): DateField | undefined {
     return this.rawMetadata?.date
       ? new DateField(this.rawMetadata.date)

package/tsconfig.json

@@ -1,22 +1,22 @@
-{
-  "compilerOptions": {
-    "target": "es2018",
-    "module": "esnext",
-    "moduleResolution": "node",
-    "noEmitOnError": true,
-    "lib": ["es2017", "dom"],
-    "strict": true,
-    "esModuleInterop": false,
-    "allowSyntheticDefaultImports": true,
-    "experimentalDecorators": true,
-    "importHelpers": true,
-    "outDir": "dist",
-    "sourceMap": true,
-    "inlineSources": true,
-    "declaration": true,
-    "rootDir": "./",
-  },
-  "include": [
-    "**/*.ts"
-  ],
-}
+{
+  "compilerOptions": {
+    "target": "es2018",
+    "module": "esnext",
+    "moduleResolution": "node",
+    "noEmitOnError": true,
+    "lib": ["es2017", "dom"],
+    "strict": true,
+    "esModuleInterop": false,
+    "allowSyntheticDefaultImports": true,
+    "experimentalDecorators": true,
+    "importHelpers": true,
+    "outDir": "dist",
+    "sourceMap": true,
+    "inlineSources": true,
+    "declaration": true,
+    "rootDir": "./",
+  },
+  "include": [
+    "**/*.ts"
+  ],
+}

package/web-test-runner.config.mjs

@@ -1,7 +1,7 @@
-export default {
-  files: 'dist/**/test/**/*.test.js',
-  nodeResolve: true,
-  coverageConfig: {
-    exclude: ['./dist/test/**/*', './node_modules/**/*'],
-  },
-};
+export default {
+  files: 'dist/**/test/**/*.test.js',
+  nodeResolve: true,
+  coverageConfig: {
+    exclude: ['./dist/test/**/*', './node_modules/**/*'],
+  },
+};