@internetarchive/metadata-service 0.1.0 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (125) hide show
  1. package/.editorconfig +29 -29
  2. package/.github/workflows/ci.yml +27 -26
  3. package/.prettierignore +2 -0
  4. package/LICENSE +661 -661
  5. package/README.md +64 -64
  6. package/demo/app-root.ts +6 -6
  7. package/demo/index.html +27 -27
  8. package/dist/demo/app-root.d.ts +11 -11
  9. package/dist/demo/app-root.js +41 -41
  10. package/dist/demo/app-root.js.map +1 -1
  11. package/dist/index.d.ts +5 -18
  12. package/dist/index.js +4 -16
  13. package/dist/index.js.map +1 -1
  14. package/dist/src/backend/default-metadata-backend.d.ts +27 -27
  15. package/dist/src/backend/default-metadata-backend.js +100 -100
  16. package/dist/src/backend/default-metadata-backend.js.map +1 -1
  17. package/dist/src/backend/metadata-backend-interface.d.ts +20 -20
  18. package/dist/src/backend/metadata-backend-interface.js +1 -1
  19. package/dist/src/backend/metadata-backend-interface.js.map +1 -1
  20. package/dist/src/metadata-service-error.d.ts +11 -11
  21. package/dist/src/metadata-service-error.js +16 -17
  22. package/dist/src/metadata-service-error.js.map +1 -1
  23. package/dist/src/metadata-service-interface.d.ts +44 -44
  24. package/dist/src/metadata-service-interface.js +1 -1
  25. package/dist/src/metadata-service-interface.js.map +1 -1
  26. package/dist/src/metadata-service.d.ts +18 -18
  27. package/dist/src/metadata-service.js +42 -42
  28. package/dist/src/metadata-service.js.map +1 -1
  29. package/dist/src/responses/metadata-response.d.ts +25 -28
  30. package/dist/src/responses/metadata-response.js +31 -30
  31. package/dist/src/responses/metadata-response.js.map +1 -1
  32. package/dist/test/default-metadata-backend.test.d.ts +1 -1
  33. package/dist/test/default-metadata-backend.test.js +89 -90
  34. package/dist/test/default-metadata-backend.test.js.map +1 -1
  35. package/dist/test/metadata-service.test.d.ts +1 -1
  36. package/dist/test/metadata-service.test.js +98 -98
  37. package/dist/test/metadata-service.test.js.map +1 -1
  38. package/dist/test/mock-response-generator.d.ts +3 -3
  39. package/dist/test/mock-response-generator.js +61 -61
  40. package/eslint.config.mjs +53 -0
  41. package/index.ts +1 -27
  42. package/package.json +76 -77
  43. package/src/backend/default-metadata-backend.ts +11 -11
  44. package/src/backend/metadata-backend-interface.ts +1 -1
  45. package/src/metadata-service-error.ts +2 -2
  46. package/src/metadata-service-interface.ts +3 -3
  47. package/src/metadata-service.ts +7 -7
  48. package/src/responses/metadata-response.ts +29 -22
  49. package/test/default-metadata-backend.test.ts +11 -8
  50. package/test/metadata-service.test.ts +16 -16
  51. package/tsconfig.json +22 -22
  52. package/web-test-runner.config.mjs +7 -7
  53. package/.eslintrc.js +0 -14
  54. package/dist/src/models/file.d.ts +0 -29
  55. package/dist/src/models/file.js +0 -95
  56. package/dist/src/models/file.js.map +0 -1
  57. package/dist/src/models/metadata-fields/field-types/boolean.d.ts +0 -5
  58. package/dist/src/models/metadata-fields/field-types/boolean.js +0 -8
  59. package/dist/src/models/metadata-fields/field-types/boolean.js.map +0 -1
  60. package/dist/src/models/metadata-fields/field-types/byte.d.ts +0 -13
  61. package/dist/src/models/metadata-fields/field-types/byte.js +0 -16
  62. package/dist/src/models/metadata-fields/field-types/byte.js.map +0 -1
  63. package/dist/src/models/metadata-fields/field-types/date.d.ts +0 -5
  64. package/dist/src/models/metadata-fields/field-types/date.js +0 -8
  65. package/dist/src/models/metadata-fields/field-types/date.js.map +0 -1
  66. package/dist/src/models/metadata-fields/field-types/duration.d.ts +0 -14
  67. package/dist/src/models/metadata-fields/field-types/duration.js +0 -17
  68. package/dist/src/models/metadata-fields/field-types/duration.js.map +0 -1
  69. package/dist/src/models/metadata-fields/field-types/list.d.ts +0 -25
  70. package/dist/src/models/metadata-fields/field-types/list.js +0 -34
  71. package/dist/src/models/metadata-fields/field-types/list.js.map +0 -1
  72. package/dist/src/models/metadata-fields/field-types/mediatype.d.ts +0 -5
  73. package/dist/src/models/metadata-fields/field-types/mediatype.js +0 -8
  74. package/dist/src/models/metadata-fields/field-types/mediatype.js.map +0 -1
  75. package/dist/src/models/metadata-fields/field-types/number.d.ts +0 -5
  76. package/dist/src/models/metadata-fields/field-types/number.js +0 -8
  77. package/dist/src/models/metadata-fields/field-types/number.js.map +0 -1
  78. package/dist/src/models/metadata-fields/field-types/page-progression.d.ts +0 -5
  79. package/dist/src/models/metadata-fields/field-types/page-progression.js +0 -8
  80. package/dist/src/models/metadata-fields/field-types/page-progression.js.map +0 -1
  81. package/dist/src/models/metadata-fields/field-types/string.d.ts +0 -5
  82. package/dist/src/models/metadata-fields/field-types/string.js +0 -8
  83. package/dist/src/models/metadata-fields/field-types/string.js.map +0 -1
  84. package/dist/src/models/metadata-fields/metadata-field.d.ts +0 -70
  85. package/dist/src/models/metadata-fields/metadata-field.js +0 -67
  86. package/dist/src/models/metadata-fields/metadata-field.js.map +0 -1
  87. package/dist/src/models/metadata.d.ts +0 -168
  88. package/dist/src/models/metadata.js +0 -618
  89. package/dist/src/models/metadata.js.map +0 -1
  90. package/dist/src/models/review.d.ts +0 -10
  91. package/dist/src/models/review.js +0 -43
  92. package/dist/src/models/review.js.map +0 -1
  93. package/dist/src/models/speech-music-asr-entry.d.ts +0 -10
  94. package/dist/src/models/speech-music-asr-entry.js +0 -2
  95. package/dist/src/models/speech-music-asr-entry.js.map +0 -1
  96. package/dist/test/models/file.test.d.ts +0 -1
  97. package/dist/test/models/file.test.js +0 -9
  98. package/dist/test/models/file.test.js.map +0 -1
  99. package/dist/test/models/metadata-fields/list-field.test.d.ts +0 -1
  100. package/dist/test/models/metadata-fields/list-field.test.js +0 -52
  101. package/dist/test/models/metadata-fields/list-field.test.js.map +0 -1
  102. package/dist/test/models/metadata-fields/metadata-field.test.d.ts +0 -1
  103. package/dist/test/models/metadata-fields/metadata-field.test.js +0 -121
  104. package/dist/test/models/metadata-fields/metadata-field.test.js.map +0 -1
  105. package/dist/test/models/metadata.test.d.ts +0 -1
  106. package/dist/test/models/metadata.test.js +0 -10
  107. package/dist/test/models/metadata.test.js.map +0 -1
  108. package/src/models/file.ts +0 -105
  109. package/src/models/metadata-fields/field-types/boolean.ts +0 -8
  110. package/src/models/metadata-fields/field-types/byte.ts +0 -16
  111. package/src/models/metadata-fields/field-types/date.ts +0 -8
  112. package/src/models/metadata-fields/field-types/duration.ts +0 -17
  113. package/src/models/metadata-fields/field-types/list.ts +0 -44
  114. package/src/models/metadata-fields/field-types/mediatype.ts +0 -8
  115. package/src/models/metadata-fields/field-types/number.ts +0 -8
  116. package/src/models/metadata-fields/field-types/page-progression.ts +0 -14
  117. package/src/models/metadata-fields/field-types/string.ts +0 -8
  118. package/src/models/metadata-fields/metadata-field.ts +0 -108
  119. package/src/models/metadata.ts +0 -457
  120. package/src/models/review.ts +0 -41
  121. package/src/models/speech-music-asr-entry.ts +0 -10
  122. package/test/models/file.test.ts +0 -10
  123. package/test/models/metadata-fields/list-field.test.ts +0 -64
  124. package/test/models/metadata-fields/metadata-field.test.ts +0 -151
  125. package/test/models/metadata.test.ts +0 -11
package/README.md CHANGED
@@ -1,64 +1,64 @@
1
- # Internet Archive Metadata Service
2
-
3
- A service for retrieving metadata about items in the Internet Archive.
4
-
5
- ## Installation
6
- ```bash
7
- npm install @internetarchive/metadata-service
8
- ```
9
-
10
- ## Usage
11
-
12
- ### Fetch Metadata
13
-
14
- ```ts
15
- const metadataResponse: MetadataResponse = await metadataService.fetchMetadata('some-identifier');
16
-
17
- metadataResponse.metadata.identifier // => 'some-identifier'
18
- metadataResponse.metadata.collection.value // => 'some-collection'
19
- metadataResponse.metadata.collection.values // => ['some-collection', 'another-collection', 'more-collections']
20
- ```
21
-
22
- ## Metadata Values
23
-
24
- Internet Archive Metadata is expansive and nearly all metadata fields can be returned as either an array, string, or number.
25
-
26
- 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.
27
-
28
- There are parsers for several different field types, like `Number`, `String`, `Date`, and `Duration` and others can be added for other field types.
29
-
30
- See `src/models/metadata-fields/field-types.ts`
31
-
32
- ### Usage
33
-
34
- ```ts
35
- metadata.collection.value // return just the first item of the `values` array, ie. 'my-collection'
36
- metadata.collection.values // returns all values of the array, ie. ['my-collection', 'other-collection']
37
- metadata.collection.rawValue // return the rawValue. This is useful for inspecting the raw response received.
38
-
39
- metadata.date.value // return the date as a javascript `Date` object
40
-
41
- 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
42
- ```
43
-
44
- # Development
45
-
46
- ## Prerequisite
47
- ```bash
48
- npm install
49
- ```
50
-
51
- ## Testing
52
- ```bash
53
- npm run test
54
- ```
55
-
56
- ## Demo
57
- ```bash
58
- npm run start
59
- ```
60
-
61
- ## Linting
62
- ```bash
63
- npm run format
64
- ```
1
+ # Internet Archive Metadata Service
2
+
3
+ A service for retrieving metadata about items in the Internet Archive.
4
+
5
+ ## Installation
6
+ ```bash
7
+ npm install @internetarchive/metadata-service
8
+ ```
9
+
10
+ ## Usage
11
+
12
+ ### Fetch Metadata
13
+
14
+ ```ts
15
+ const metadataResponse: MetadataResponse = await metadataService.fetchMetadata('some-identifier');
16
+
17
+ metadataResponse.metadata.identifier // => 'some-identifier'
18
+ metadataResponse.metadata.collection.value // => 'some-collection'
19
+ metadataResponse.metadata.collection.values // => ['some-collection', 'another-collection', 'more-collections']
20
+ ```
21
+
22
+ ## Metadata Values
23
+
24
+ Internet Archive Metadata is expansive and nearly all metadata fields can be returned as either an array, string, or number.
25
+
26
+ 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.
27
+
28
+ There are parsers for several different field types, like `Number`, `String`, `Date`, and `Duration` and others can be added for other field types.
29
+
30
+ See `src/models/metadata-fields/field-types.ts`
31
+
32
+ ### Usage
33
+
34
+ ```ts
35
+ metadata.collection.value // return just the first item of the `values` array, ie. 'my-collection'
36
+ metadata.collection.values // returns all values of the array, ie. ['my-collection', 'other-collection']
37
+ metadata.collection.rawValue // return the rawValue. This is useful for inspecting the raw response received.
38
+
39
+ metadata.date.value // return the date as a javascript `Date` object
40
+
41
+ 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
42
+ ```
43
+
44
+ # Development
45
+
46
+ ## Prerequisite
47
+ ```bash
48
+ npm install
49
+ ```
50
+
51
+ ## Testing
52
+ ```bash
53
+ npm run test
54
+ ```
55
+
56
+ ## Demo
57
+ ```bash
58
+ npm run start
59
+ ```
60
+
61
+ ## Linting
62
+ ```bash
63
+ npm run format
64
+ ```
package/demo/app-root.ts CHANGED
@@ -3,16 +3,16 @@ import {
3
3
  CSSResult,
4
4
  customElement,
5
5
  html,
6
- internalProperty,
7
6
  LitElement,
8
7
  query,
8
+ state,
9
9
  TemplateResult,
10
10
  } from 'lit-element';
11
- import { unsafeHTML } from 'lit-html/directives/unsafe-html';
12
11
  import { nothing } from 'lit-html';
13
- import { MetadataResponse } from '../src/responses/metadata-response';
14
- import { MetadataServiceInterface } from '../src/metadata-service-interface';
12
+ import { unsafeHTML } from 'lit-html/directives/unsafe-html';
15
13
  import { MetadataService } from '../src/metadata-service';
14
+ import { MetadataServiceInterface } from '../src/metadata-service-interface';
15
+ import { MetadataResponse } from '../src/responses/metadata-response';
16
16
 
17
17
  @customElement('app-root')
18
18
  export class AppRoot extends LitElement {
@@ -21,7 +21,7 @@ export class AppRoot extends LitElement {
21
21
  @query('#metadata-input')
22
22
  private metadataInput!: HTMLInputElement;
23
23
 
24
- @internalProperty()
24
+ @state()
25
25
  private metadataResponse?: MetadataResponse;
26
26
 
27
27
  /** @inheritdoc */
@@ -57,7 +57,7 @@ export class AppRoot extends LitElement {
57
57
  <td>${key}</td>
58
58
  <td>${unsafeHTML(rawMetadata[key])}</td>
59
59
  </tr>
60
- `
60
+ `,
61
61
  )}
62
62
  </table>
63
63
  `;
package/demo/index.html CHANGED
@@ -1,27 +1,27 @@
1
- <!doctype html>
2
- <html lang="en-GB">
3
- <head>
4
- <meta charset="utf-8">
5
- <style>
6
- body {
7
- background: #fff;
8
- font-family: sans-serif;
9
- }
10
- </style>
11
- </head>
12
- <body>
13
- <div id="demo"></div>
14
-
15
- <script type="module">
16
- import { html, render } from 'lit-html';
17
- import '../dist/demo/app-root.js';
18
-
19
- render(
20
- html`
21
- <app-root></app-root>
22
- `,
23
- document.querySelector('#demo')
24
- );
25
- </script>
26
- </body>
27
- </html>
1
+ <!doctype html>
2
+ <html lang="en-GB">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <style>
6
+ body {
7
+ background: #fff;
8
+ font-family: sans-serif;
9
+ }
10
+ </style>
11
+ </head>
12
+ <body>
13
+ <div id="demo"></div>
14
+
15
+ <script type="module">
16
+ import { html, render } from 'lit-html';
17
+ import '../dist/demo/app-root.js';
18
+
19
+ render(
20
+ html`
21
+ <app-root></app-root>
22
+ `,
23
+ document.querySelector('#demo')
24
+ );
25
+ </script>
26
+ </body>
27
+ </html>
@@ -1,11 +1,11 @@
1
- import { CSSResult, LitElement, TemplateResult } from 'lit-element';
2
- export declare class AppRoot extends LitElement {
3
- private metadataService;
4
- private metadataInput;
5
- private metadataResponse?;
6
- /** @inheritdoc */
7
- render(): TemplateResult;
8
- private get metadataTemplate();
9
- getMetadata(e: Event): Promise<void>;
10
- static get styles(): CSSResult;
11
- }
1
+ import { CSSResult, LitElement, TemplateResult } from 'lit-element';
2
+ export declare class AppRoot extends LitElement {
3
+ private metadataService;
4
+ private metadataInput;
5
+ private metadataResponse?;
6
+ /** @inheritdoc */
7
+ render(): TemplateResult;
8
+ private get metadataTemplate();
9
+ getMetadata(e: Event): Promise<void>;
10
+ static get styles(): CSSResult;
11
+ }
@@ -1,15 +1,15 @@
1
- import { __decorate } from "tslib";
2
- import { css, customElement, html, internalProperty, LitElement, query, } from 'lit-element';
3
- import { unsafeHTML } from 'lit-html/directives/unsafe-html';
4
- import { nothing } from 'lit-html';
5
- import { MetadataService } from '../src/metadata-service';
6
- let AppRoot = class AppRoot extends LitElement {
7
- constructor() {
8
- super(...arguments);
9
- this.metadataService = MetadataService.default;
10
- }
11
- /** @inheritdoc */
12
- render() {
1
+ import { __decorate } from "tslib";
2
+ import { css, customElement, html, LitElement, query, state, } from 'lit-element';
3
+ import { nothing } from 'lit-html';
4
+ import { unsafeHTML } from 'lit-html/directives/unsafe-html';
5
+ import { MetadataService } from '../src/metadata-service';
6
+ let AppRoot = class AppRoot extends LitElement {
7
+ constructor() {
8
+ super(...arguments);
9
+ this.metadataService = MetadataService.default;
10
+ }
11
+ /** @inheritdoc */
12
+ render() {
13
13
  return html `
14
14
  <fieldset>
15
15
  <legend>Metadata Fetch</legend>
@@ -25,13 +25,13 @@ let AppRoot = class AppRoot extends LitElement {
25
25
  </fieldset>
26
26
 
27
27
  ${this.metadataResponse ? this.metadataTemplate : nothing}
28
- `;
29
- }
30
- get metadataTemplate() {
31
- var _a;
32
- const rawMetadata = (_a = this.metadataResponse) === null || _a === void 0 ? void 0 : _a.metadata.rawMetadata;
33
- if (!rawMetadata)
34
- return html `${nothing}`;
28
+ `;
29
+ }
30
+ get metadataTemplate() {
31
+ var _a;
32
+ const rawMetadata = (_a = this.metadataResponse) === null || _a === void 0 ? void 0 : _a.metadata.rawMetadata;
33
+ if (!rawMetadata)
34
+ return html `${nothing}`;
35
35
  return html `
36
36
  <h2>Metadata Response</h2>
37
37
  <table>
@@ -42,30 +42,30 @@ let AppRoot = class AppRoot extends LitElement {
42
42
  </tr>
43
43
  `)}
44
44
  </table>
45
- `;
46
- }
47
- async getMetadata(e) {
48
- e.preventDefault();
49
- const identifier = this.metadataInput.value;
50
- const result = await this.metadataService.fetchMetadata(identifier);
51
- this.metadataResponse = result === null || result === void 0 ? void 0 : result.success;
52
- }
53
- static get styles() {
45
+ `;
46
+ }
47
+ async getMetadata(e) {
48
+ e.preventDefault();
49
+ const identifier = this.metadataInput.value;
50
+ const result = await this.metadataService.fetchMetadata(identifier);
51
+ this.metadataResponse = result === null || result === void 0 ? void 0 : result.success;
52
+ }
53
+ static get styles() {
54
54
  return css `
55
55
  /* th {
56
56
  font-weight: bold;
57
57
  } */
58
- `;
59
- }
60
- };
61
- __decorate([
62
- query('#metadata-input')
63
- ], AppRoot.prototype, "metadataInput", void 0);
64
- __decorate([
65
- internalProperty()
66
- ], AppRoot.prototype, "metadataResponse", void 0);
67
- AppRoot = __decorate([
68
- customElement('app-root')
69
- ], AppRoot);
70
- export { AppRoot };
58
+ `;
59
+ }
60
+ };
61
+ __decorate([
62
+ query('#metadata-input')
63
+ ], AppRoot.prototype, "metadataInput", void 0);
64
+ __decorate([
65
+ state()
66
+ ], AppRoot.prototype, "metadataResponse", void 0);
67
+ AppRoot = __decorate([
68
+ customElement('app-root')
69
+ ], AppRoot);
70
+ export { AppRoot };
71
71
  //# sourceMappingURL=app-root.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"app-root.js","sourceRoot":"","sources":["../../demo/app-root.ts"],"names":[],"mappings":";AAAA,OAAO,EACL,GAAG,EAEH,aAAa,EACb,IAAI,EACJ,gBAAgB,EAChB,UAAU,EACV,KAAK,GAEN,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAC7D,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAGnC,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAG1D,IAAa,OAAO,GAApB,MAAa,OAAQ,SAAQ,UAAU;IAAvC;;QACU,oBAAe,GAA6B,eAAe,CAAC,OAAO,CAAC;IA6D9E,CAAC;IArDC,kBAAkB;IAClB,MAAM;QACJ,OAAO,IAAI,CAAA;;;;;;;;;qBASM,IAAI,CAAC,WAAW;;;;;QAK7B,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,OAAO;KAC1D,CAAC;IACJ,CAAC;IAED,IAAY,gBAAgB;;QAC1B,MAAM,WAAW,GAAG,MAAA,IAAI,CAAC,gBAAgB,0CAAE,QAAQ,CAAC,WAAW,CAAC;QAChE,IAAI,CAAC,WAAW;YAAE,OAAO,IAAI,CAAA,GAAG,OAAO,EAAE,CAAC;QAE1C,OAAO,IAAI,CAAA;;;UAGL,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,GAAG,CAC5B,GAAG,CAAC,EAAE,CAAC,IAAI,CAAA;;oBAED,GAAG;oBACH,UAAU,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;;WAErC,CACF;;KAEJ,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,CAAQ;QACxB,CAAC,CAAC,cAAc,EAAE,CAAC;QACnB,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC;QAC5C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QACpE,IAAI,CAAC,gBAAgB,GAAG,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,OAAO,CAAC;IAC1C,CAAC;IAED,MAAM,KAAK,MAAM;QACf,OAAO,GAAG,CAAA;;;;KAIT,CAAC;IACJ,CAAC;CACF,CAAA;AA1DC;IADC,KAAK,CAAC,iBAAiB,CAAC;8CACgB;AAGzC;IADC,gBAAgB,EAAE;iDACyB;AAPjC,OAAO;IADnB,aAAa,CAAC,UAAU,CAAC;GACb,OAAO,CA8DnB;SA9DY,OAAO","sourcesContent":["import {\n css,\n CSSResult,\n customElement,\n html,\n internalProperty,\n LitElement,\n query,\n TemplateResult,\n} from 'lit-element';\nimport { unsafeHTML } from 'lit-html/directives/unsafe-html';\nimport { nothing } from 'lit-html';\nimport { MetadataResponse } from '../src/responses/metadata-response';\nimport { MetadataServiceInterface } from '../src/metadata-service-interface';\nimport { MetadataService } from '../src/metadata-service';\n\n@customElement('app-root')\nexport class AppRoot extends LitElement {\n private metadataService: MetadataServiceInterface = MetadataService.default;\n\n @query('#metadata-input')\n private metadataInput!: HTMLInputElement;\n\n @internalProperty()\n private metadataResponse?: MetadataResponse;\n\n /** @inheritdoc */\n render(): TemplateResult {\n return html`\n <fieldset>\n <legend>Metadata Fetch</legend>\n <form>\n <label>Metadata</label>\n <input type=\"text\" id=\"metadata-input\" placeholder=\"Identifier\" />\n <input\n type=\"submit\"\n value=\"Get Metadata\"\n @click=${this.getMetadata}\n />\n </form>\n </fieldset>\n\n ${this.metadataResponse ? this.metadataTemplate : nothing}\n `;\n }\n\n private get metadataTemplate(): TemplateResult {\n const rawMetadata = this.metadataResponse?.metadata.rawMetadata;\n if (!rawMetadata) return html`${nothing}`;\n\n return html`\n <h2>Metadata Response</h2>\n <table>\n ${Object.keys(rawMetadata).map(\n key => html`\n <tr>\n <td>${key}</td>\n <td>${unsafeHTML(rawMetadata[key])}</td>\n </tr>\n `\n )}\n </table>\n `;\n }\n\n async getMetadata(e: Event): Promise<void> {\n e.preventDefault();\n const identifier = this.metadataInput.value;\n const result = await this.metadataService.fetchMetadata(identifier);\n this.metadataResponse = result?.success;\n }\n\n static get styles(): CSSResult {\n return css`\n /* th {\n font-weight: bold;\n } */\n `;\n }\n}\n"]}
1
+ {"version":3,"file":"app-root.js","sourceRoot":"","sources":["../../demo/app-root.ts"],"names":[],"mappings":";AAAA,OAAO,EACL,GAAG,EAEH,aAAa,EACb,IAAI,EACJ,UAAU,EACV,KAAK,EACL,KAAK,GAEN,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACnC,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAKnD,IAAM,OAAO,GAAb,MAAM,OAAQ,SAAQ,UAAU;IAAhC;;QACG,oBAAe,GAA6B,eAAe,CAAC,OAAO,CAAC;IA6D9E,CAAC;IArDC,kBAAkB;IAClB,MAAM;QACJ,OAAO,IAAI,CAAA;;;;;;;;;qBASM,IAAI,CAAC,WAAW;;;;;QAK7B,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC,OAAO;KAC1D,CAAC;IACJ,CAAC;IAED,IAAY,gBAAgB;;QAC1B,MAAM,WAAW,GAAG,MAAA,IAAI,CAAC,gBAAgB,0CAAE,QAAQ,CAAC,WAAW,CAAC;QAChE,IAAI,CAAC,WAAW;YAAE,OAAO,IAAI,CAAA,GAAG,OAAO,EAAE,CAAC;QAE1C,OAAO,IAAI,CAAA;;;UAGL,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,GAAG,CAC5B,GAAG,CAAC,EAAE,CAAC,IAAI,CAAA;;oBAED,GAAG;oBACH,UAAU,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;;WAErC,CACF;;KAEJ,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,CAAQ;QACxB,CAAC,CAAC,cAAc,EAAE,CAAC;QACnB,MAAM,UAAU,GAAG,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC;QAC5C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QACpE,IAAI,CAAC,gBAAgB,GAAG,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,OAAO,CAAC;IAC1C,CAAC;IAED,MAAM,KAAK,MAAM;QACf,OAAO,GAAG,CAAA;;;;KAIT,CAAC;IACJ,CAAC;CACF,CAAA;AA1DS;IADP,KAAK,CAAC,iBAAiB,CAAC;8CACgB;AAGjC;IADP,KAAK,EAAE;iDACoC;AAPjC,OAAO;IADnB,aAAa,CAAC,UAAU,CAAC;GACb,OAAO,CA8DnB","sourcesContent":["import {\n css,\n CSSResult,\n customElement,\n html,\n LitElement,\n query,\n state,\n TemplateResult,\n} from 'lit-element';\nimport { nothing } from 'lit-html';\nimport { unsafeHTML } from 'lit-html/directives/unsafe-html';\nimport { MetadataService } from '../src/metadata-service';\nimport { MetadataServiceInterface } from '../src/metadata-service-interface';\nimport { MetadataResponse } from '../src/responses/metadata-response';\n\n@customElement('app-root')\nexport class AppRoot extends LitElement {\n private metadataService: MetadataServiceInterface = MetadataService.default;\n\n @query('#metadata-input')\n private metadataInput!: HTMLInputElement;\n\n @state()\n private metadataResponse?: MetadataResponse;\n\n /** @inheritdoc */\n render(): TemplateResult {\n return html`\n <fieldset>\n <legend>Metadata Fetch</legend>\n <form>\n <label>Metadata</label>\n <input type=\"text\" id=\"metadata-input\" placeholder=\"Identifier\" />\n <input\n type=\"submit\"\n value=\"Get Metadata\"\n @click=${this.getMetadata}\n />\n </form>\n </fieldset>\n\n ${this.metadataResponse ? this.metadataTemplate : nothing}\n `;\n }\n\n private get metadataTemplate(): TemplateResult {\n const rawMetadata = this.metadataResponse?.metadata.rawMetadata;\n if (!rawMetadata) return html`${nothing}`;\n\n return html`\n <h2>Metadata Response</h2>\n <table>\n ${Object.keys(rawMetadata).map(\n key => html`\n <tr>\n <td>${key}</td>\n <td>${unsafeHTML(rawMetadata[key])}</td>\n </tr>\n `,\n )}\n </table>\n `;\n }\n\n async getMetadata(e: Event): Promise<void> {\n e.preventDefault();\n const identifier = this.metadataInput.value;\n const result = await this.metadataService.fetchMetadata(identifier);\n this.metadataResponse = result?.success;\n }\n\n static get styles(): CSSResult {\n return css`\n /* th {\n font-weight: bold;\n } */\n `;\n }\n}\n"]}
package/dist/index.d.ts CHANGED
@@ -1,18 +1,5 @@
1
- export { Metadata } from './src/models/metadata';
2
- export { File } from './src/models/file';
3
- export { Review } from './src/models/review';
4
- export { SpeechMusicASREntry } from './src/models/speech-music-asr-entry';
5
- export { DateField } from './src/models/metadata-fields/field-types/date';
6
- export { NumberField } from './src/models/metadata-fields/field-types/number';
7
- export { StringField } from './src/models/metadata-fields/field-types/string';
8
- export { BooleanField } from './src/models/metadata-fields/field-types/boolean';
9
- export { ByteField } from './src/models/metadata-fields/field-types/byte';
10
- export { DurationField } from './src/models/metadata-fields/field-types/duration';
11
- export { PageProgressionField } from './src/models/metadata-fields/field-types/page-progression';
12
- export { MediaTypeField } from './src/models/metadata-fields/field-types/mediatype';
13
- export { MetadataFieldInterface, MetadataField, } from './src/models/metadata-fields/metadata-field';
14
- export { MetadataResponse } from './src/responses/metadata-response';
15
- export { DefaultMetadataBackend } from './src/backend/default-metadata-backend';
16
- export { MetadataServiceInterface } from './src/metadata-service-interface';
17
- export { MetadataService } from './src/metadata-service';
18
- export { MetadataServiceError } from './src/metadata-service-error';
1
+ export { MetadataResponse } from './src/responses/metadata-response';
2
+ export { DefaultMetadataBackend } from './src/backend/default-metadata-backend';
3
+ export { MetadataService } from './src/metadata-service';
4
+ export { MetadataServiceError } from './src/metadata-service-error';
5
+ export { MetadataServiceInterface } from './src/metadata-service-interface';
package/dist/index.js CHANGED
@@ -1,17 +1,5 @@
1
- export { Metadata } from './src/models/metadata';
2
- export { File } from './src/models/file';
3
- export { Review } from './src/models/review';
4
- export { DateField } from './src/models/metadata-fields/field-types/date';
5
- export { NumberField } from './src/models/metadata-fields/field-types/number';
6
- export { StringField } from './src/models/metadata-fields/field-types/string';
7
- export { BooleanField } from './src/models/metadata-fields/field-types/boolean';
8
- export { ByteField } from './src/models/metadata-fields/field-types/byte';
9
- export { DurationField } from './src/models/metadata-fields/field-types/duration';
10
- export { PageProgressionField } from './src/models/metadata-fields/field-types/page-progression';
11
- export { MediaTypeField } from './src/models/metadata-fields/field-types/mediatype';
12
- export { MetadataField, } from './src/models/metadata-fields/metadata-field';
13
- export { MetadataResponse } from './src/responses/metadata-response';
14
- export { DefaultMetadataBackend } from './src/backend/default-metadata-backend';
15
- export { MetadataService } from './src/metadata-service';
16
- export { MetadataServiceError } from './src/metadata-service-error';
1
+ export { MetadataResponse } from './src/responses/metadata-response';
2
+ export { DefaultMetadataBackend } from './src/backend/default-metadata-backend';
3
+ export { MetadataService } from './src/metadata-service';
4
+ export { MetadataServiceError } from './src/metadata-service-error';
17
5
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAG7C,OAAO,EAAE,SAAS,EAAE,MAAM,+CAA+C,CAAC;AAE1E,OAAO,EAAE,WAAW,EAAE,MAAM,iDAAiD,CAAC;AAE9E,OAAO,EAAE,WAAW,EAAE,MAAM,iDAAiD,CAAC;AAE9E,OAAO,EAAE,YAAY,EAAE,MAAM,kDAAkD,CAAC;AAEhF,OAAO,EAAE,SAAS,EAAE,MAAM,+CAA+C,CAAC;AAE1E,OAAO,EAAE,aAAa,EAAE,MAAM,mDAAmD,CAAC;AAElF,OAAO,EAAE,oBAAoB,EAAE,MAAM,2DAA2D,CAAC;AAEjG,OAAO,EAAE,cAAc,EAAE,MAAM,oDAAoD,CAAC;AAEpF,OAAO,EAEL,aAAa,GACd,MAAM,6CAA6C,CAAC;AAErD,OAAO,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAC;AAErE,OAAO,EAAE,sBAAsB,EAAE,MAAM,wCAAwC,CAAC;AAEhF,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC","sourcesContent":["export { Metadata } from './src/models/metadata';\nexport { File } from './src/models/file';\nexport { Review } from './src/models/review';\nexport { SpeechMusicASREntry } from './src/models/speech-music-asr-entry';\n\nexport { DateField } from './src/models/metadata-fields/field-types/date';\n\nexport { NumberField } from './src/models/metadata-fields/field-types/number';\n\nexport { StringField } from './src/models/metadata-fields/field-types/string';\n\nexport { BooleanField } from './src/models/metadata-fields/field-types/boolean';\n\nexport { ByteField } from './src/models/metadata-fields/field-types/byte';\n\nexport { DurationField } from './src/models/metadata-fields/field-types/duration';\n\nexport { PageProgressionField } from './src/models/metadata-fields/field-types/page-progression';\n\nexport { MediaTypeField } from './src/models/metadata-fields/field-types/mediatype';\n\nexport {\n MetadataFieldInterface,\n MetadataField,\n} from './src/models/metadata-fields/metadata-field';\n\nexport { MetadataResponse } from './src/responses/metadata-response';\n\nexport { DefaultMetadataBackend } from './src/backend/default-metadata-backend';\nexport { MetadataServiceInterface } from './src/metadata-service-interface';\nexport { MetadataService } from './src/metadata-service';\nexport { MetadataServiceError } from './src/metadata-service-error';\n"]}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAC;AAErE,OAAO,EAAE,sBAAsB,EAAE,MAAM,wCAAwC,CAAC;AAChF,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC","sourcesContent":["export { MetadataResponse } from './src/responses/metadata-response';\n\nexport { DefaultMetadataBackend } from './src/backend/default-metadata-backend';\nexport { MetadataService } from './src/metadata-service';\nexport { MetadataServiceError } from './src/metadata-service-error';\nexport { MetadataServiceInterface } from './src/metadata-service-interface';\n"]}
@@ -1,27 +1,27 @@
1
- import type { Result } from '@internetarchive/result-type';
2
- import { MetadataBackendInterface } from './metadata-backend-interface';
3
- import { MetadataServiceError } from '../metadata-service-error';
4
- /**
5
- * The DefaultSearchBackend performs a `window.fetch` request to archive.org
6
- */
7
- export declare class DefaultMetadataBackend implements MetadataBackendInterface {
8
- private baseUrl;
9
- private includeCredentials;
10
- private requestScope?;
11
- constructor(options?: {
12
- baseUrl?: string;
13
- includeCredentials?: boolean;
14
- scope?: string;
15
- });
16
- /** @inheritdoc */
17
- fetchMetadata(identifier: string, keypath?: string): Promise<Result<any, MetadataServiceError>>;
18
- /**
19
- * Fires a request to the URL (with this backend's options applied) and
20
- * asynchronously returns a Result object containing either the raw response
21
- * JSON or a MetadataServiceError.
22
- */
23
- protected fetchUrl(url: string, options?: {
24
- requestOptions?: RequestInit;
25
- }): Promise<Result<any, MetadataServiceError>>;
26
- private getErrorResult;
27
- }
1
+ import type { Result } from '@internetarchive/result-type';
2
+ import { MetadataServiceError } from '../metadata-service-error';
3
+ import { MetadataBackendInterface } from './metadata-backend-interface';
4
+ /**
5
+ * The DefaultSearchBackend performs a `window.fetch` request to archive.org
6
+ */
7
+ export declare class DefaultMetadataBackend implements MetadataBackendInterface {
8
+ private baseUrl;
9
+ private includeCredentials;
10
+ private requestScope?;
11
+ constructor(options?: {
12
+ baseUrl?: string;
13
+ includeCredentials?: boolean;
14
+ scope?: string;
15
+ });
16
+ /** @inheritdoc */
17
+ fetchMetadata(identifier: string, keypath?: string): Promise<Result<any, MetadataServiceError>>;
18
+ /**
19
+ * Fires a request to the URL (with this backend's options applied) and
20
+ * asynchronously returns a Result object containing either the raw response
21
+ * JSON or a MetadataServiceError.
22
+ */
23
+ protected fetchUrl(url: string, options?: {
24
+ requestOptions?: RequestInit;
25
+ }): Promise<Result<any, MetadataServiceError>>;
26
+ private getErrorResult;
27
+ }