@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
@@ -1,101 +1,101 @@
1
- import { MetadataServiceError, MetadataServiceErrorType, } from '../metadata-service-error';
2
- /**
3
- * The DefaultSearchBackend performs a `window.fetch` request to archive.org
4
- */
5
- export class DefaultMetadataBackend {
6
- constructor(options) {
7
- var _a;
8
- this.baseUrl = (_a = options === null || options === void 0 ? void 0 : options.baseUrl) !== null && _a !== void 0 ? _a : 'archive.org';
9
- if ((options === null || options === void 0 ? void 0 : options.includeCredentials) !== undefined) {
10
- this.includeCredentials = options.includeCredentials;
11
- }
12
- else {
13
- // include credentials if the request is coming from an archive.org domain
14
- // since credentialed requests are only allowed from archive.org domains
15
- // due to CORS restrictions, see
16
- // https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS/Errors/CORSNotSupportingCredentials
17
- this.includeCredentials =
18
- window.location.href.match(/^https?:\/\/.*archive\.org(:[0-9]+)?/) !==
19
- null;
20
- }
21
- if ((options === null || options === void 0 ? void 0 : options.scope) !== undefined) {
22
- this.requestScope = options.scope;
23
- }
24
- else {
25
- const currentUrl = new URL(window.location.href);
26
- const scope = currentUrl.searchParams.get('scope');
27
- if (scope) {
28
- this.requestScope = scope;
29
- }
30
- }
31
- }
32
- /** @inheritdoc */
33
- async fetchMetadata(identifier, keypath) {
34
- const path = keypath ? `/${keypath}` : '';
35
- const url = `https://${this.baseUrl}/metadata/${identifier}${path}`;
36
- // the metadata endpoint doesn't currently support credentialed requests
37
- // so don't include credentials until that is fixed
38
- return this.fetchUrl(url, {
39
- requestOptions: {
40
- credentials: 'omit',
41
- },
42
- });
43
- }
44
- /**
45
- * Fires a request to the URL (with this backend's options applied) and
46
- * asynchronously returns a Result object containing either the raw response
47
- * JSON or a MetadataServiceError.
48
- */
49
- async fetchUrl(url, options) {
50
- var _a;
51
- const finalUrl = new URL(url);
52
- if (this.requestScope) {
53
- finalUrl.searchParams.set('scope', this.requestScope);
54
- }
55
- let response;
56
- // first try the fetch and return a networkError if it fails
57
- try {
58
- const fetchOptions = (_a = options === null || options === void 0 ? void 0 : options.requestOptions) !== null && _a !== void 0 ? _a : {
59
- credentials: this.includeCredentials ? 'include' : 'same-origin',
60
- };
61
- response = await fetch(finalUrl.href, fetchOptions);
62
- }
63
- catch (err) {
64
- const message = err instanceof Error
65
- ? err.message
66
- : typeof err === 'string'
67
- ? err
68
- : 'Unknown error';
69
- return this.getErrorResult(MetadataServiceErrorType.networkError, message);
70
- }
71
- // then try json decoding and return a decodingError if it fails
72
- try {
73
- const json = await response.json();
74
- // the advanced search endpoint doesn't return an HTTP Error 400
75
- // and instead returns an HTTP 200 with an `error` key in the payload
76
- const error = json['error'];
77
- if (error) {
78
- const forensics = json['forensics'];
79
- return this.getErrorResult(MetadataServiceErrorType.searchEngineError, error, forensics);
80
- }
81
- else {
82
- // success
83
- return { success: json };
84
- }
85
- }
86
- catch (err) {
87
- const message = err instanceof Error
88
- ? err.message
89
- : typeof err === 'string'
90
- ? err
91
- : 'Unknown error';
92
- return this.getErrorResult(MetadataServiceErrorType.decodingError, message);
93
- }
94
- }
95
- getErrorResult(errorType, message, details) {
96
- const error = new MetadataServiceError(errorType, message, details);
97
- const result = { error };
98
- return result;
99
- }
100
- }
1
+ import { MetadataServiceError, MetadataServiceErrorType, } from '../metadata-service-error';
2
+ /**
3
+ * The DefaultSearchBackend performs a `window.fetch` request to archive.org
4
+ */
5
+ export class DefaultMetadataBackend {
6
+ constructor(options) {
7
+ var _a;
8
+ this.baseUrl = (_a = options === null || options === void 0 ? void 0 : options.baseUrl) !== null && _a !== void 0 ? _a : 'archive.org';
9
+ if ((options === null || options === void 0 ? void 0 : options.includeCredentials) !== undefined) {
10
+ this.includeCredentials = options.includeCredentials;
11
+ }
12
+ else {
13
+ // include credentials if the request is coming from an archive.org domain
14
+ // since credentialed requests are only allowed from archive.org domains
15
+ // due to CORS restrictions, see
16
+ // https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS/Errors/CORSNotSupportingCredentials
17
+ this.includeCredentials =
18
+ window.location.href.match(/^https?:\/\/.*archive\.org(:[0-9]+)?/) !==
19
+ null;
20
+ }
21
+ if ((options === null || options === void 0 ? void 0 : options.scope) !== undefined) {
22
+ this.requestScope = options.scope;
23
+ }
24
+ else {
25
+ const currentUrl = new URL(window.location.href);
26
+ const scope = currentUrl.searchParams.get('scope');
27
+ if (scope) {
28
+ this.requestScope = scope;
29
+ }
30
+ }
31
+ }
32
+ /** @inheritdoc */
33
+ async fetchMetadata(identifier, keypath) {
34
+ const path = keypath ? `/${keypath}` : '';
35
+ const url = `https://${this.baseUrl}/metadata/${identifier}${path}`;
36
+ // the metadata endpoint doesn't currently support credentialed requests
37
+ // so don't include credentials until that is fixed
38
+ return this.fetchUrl(url, {
39
+ requestOptions: {
40
+ credentials: 'omit',
41
+ },
42
+ });
43
+ }
44
+ /**
45
+ * Fires a request to the URL (with this backend's options applied) and
46
+ * asynchronously returns a Result object containing either the raw response
47
+ * JSON or a MetadataServiceError.
48
+ */
49
+ async fetchUrl(url, options) {
50
+ var _a;
51
+ const finalUrl = new URL(url);
52
+ if (this.requestScope) {
53
+ finalUrl.searchParams.set('scope', this.requestScope);
54
+ }
55
+ let response;
56
+ // first try the fetch and return a networkError if it fails
57
+ try {
58
+ const fetchOptions = (_a = options === null || options === void 0 ? void 0 : options.requestOptions) !== null && _a !== void 0 ? _a : {
59
+ credentials: this.includeCredentials ? 'include' : 'same-origin',
60
+ };
61
+ response = await fetch(finalUrl.href, fetchOptions);
62
+ }
63
+ catch (err) {
64
+ const message = err instanceof Error
65
+ ? err.message
66
+ : typeof err === 'string'
67
+ ? err
68
+ : 'Unknown error';
69
+ return this.getErrorResult(MetadataServiceErrorType.networkError, message);
70
+ }
71
+ // then try json decoding and return a decodingError if it fails
72
+ try {
73
+ const json = await response.json();
74
+ // the advanced search endpoint doesn't return an HTTP Error 400
75
+ // and instead returns an HTTP 200 with an `error` key in the payload
76
+ const error = json['error'];
77
+ if (error) {
78
+ const forensics = json['forensics'];
79
+ return this.getErrorResult(MetadataServiceErrorType.searchEngineError, error, forensics);
80
+ }
81
+ else {
82
+ // success
83
+ return { success: json };
84
+ }
85
+ }
86
+ catch (err) {
87
+ const message = err instanceof Error
88
+ ? err.message
89
+ : typeof err === 'string'
90
+ ? err
91
+ : 'Unknown error';
92
+ return this.getErrorResult(MetadataServiceErrorType.decodingError, message);
93
+ }
94
+ }
95
+ getErrorResult(errorType, message, details) {
96
+ const error = new MetadataServiceError(errorType, message, details);
97
+ const result = { error };
98
+ return result;
99
+ }
100
+ }
101
101
  //# sourceMappingURL=default-metadata-backend.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"default-metadata-backend.js","sourceRoot":"","sources":["../../../src/backend/default-metadata-backend.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,oBAAoB,EACpB,wBAAwB,GACzB,MAAM,2BAA2B,CAAC;AAEnC;;GAEG;AACH,MAAM,OAAO,sBAAsB;IAOjC,YAAY,OAIX;;QACC,IAAI,CAAC,OAAO,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,mCAAI,aAAa,CAAC;QAEjD,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,kBAAkB,MAAK,SAAS,EAAE;YAC7C,IAAI,CAAC,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC;SACtD;aAAM;YACL,0EAA0E;YAC1E,wEAAwE;YACxE,gCAAgC;YAChC,6FAA6F;YAC7F,IAAI,CAAC,kBAAkB;gBACrB,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,sCAAsC,CAAC;oBAClE,IAAI,CAAC;SACR;QAED,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,MAAK,SAAS,EAAE;YAChC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC;SACnC;aAAM;YACL,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACjD,MAAM,KAAK,GAAG,UAAU,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YACnD,IAAI,KAAK,EAAE;gBACT,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;aAC3B;SACF;IACH,CAAC;IAED,kBAAkB;IAClB,KAAK,CAAC,aAAa,CACjB,UAAkB,EAClB,OAAgB;QAEhB,MAAM,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1C,MAAM,GAAG,GAAG,WAAW,IAAI,CAAC,OAAO,aAAa,UAAU,GAAG,IAAI,EAAE,CAAC;QACpE,wEAAwE;QACxE,mDAAmD;QACnD,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE;YACxB,cAAc,EAAE;gBACd,WAAW,EAAE,MAAM;aACpB;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,QAAQ,CACtB,GAAW,EACX,OAEC;;QAED,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;QAC9B,IAAI,IAAI,CAAC,YAAY,EAAE;YACrB,QAAQ,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;SACvD;QAED,IAAI,QAAkB,CAAC;QACvB,4DAA4D;QAC5D,IAAI;YACF,MAAM,YAAY,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,cAAc,mCAAI;gBAC9C,WAAW,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,aAAa;aACjE,CAAC;YACF,QAAQ,GAAG,MAAM,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;SACrD;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,OAAO,GACX,GAAG,YAAY,KAAK;gBAClB,CAAC,CAAC,GAAG,CAAC,OAAO;gBACb,CAAC,CAAC,OAAO,GAAG,KAAK,QAAQ;oBACzB,CAAC,CAAC,GAAG;oBACL,CAAC,CAAC,eAAe,CAAC;YACtB,OAAO,IAAI,CAAC,cAAc,CACxB,wBAAwB,CAAC,YAAY,EACrC,OAAO,CACR,CAAC;SACH;QAED,gEAAgE;QAChE,IAAI;YACF,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YACnC,gEAAgE;YAChE,qEAAqE;YACrE,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;YAC5B,IAAI,KAAK,EAAE;gBACT,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC;gBACpC,OAAO,IAAI,CAAC,cAAc,CACxB,wBAAwB,CAAC,iBAAiB,EAC1C,KAAK,EACL,SAAS,CACV,CAAC;aACH;iBAAM;gBACL,UAAU;gBACV,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;aAC1B;SACF;QAAC,OAAO,GAAG,EAAE;YACZ,MAAM,OAAO,GACX,GAAG,YAAY,KAAK;gBAClB,CAAC,CAAC,GAAG,CAAC,OAAO;gBACb,CAAC,CAAC,OAAO,GAAG,KAAK,QAAQ;oBACzB,CAAC,CAAC,GAAG;oBACL,CAAC,CAAC,eAAe,CAAC;YACtB,OAAO,IAAI,CAAC,cAAc,CACxB,wBAAwB,CAAC,aAAa,EACtC,OAAO,CACR,CAAC;SACH;IACH,CAAC;IAEO,cAAc,CACpB,SAAmC,EACnC,OAAgB,EAChB,OAAa;QAEb,MAAM,KAAK,GAAG,IAAI,oBAAoB,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QACpE,MAAM,MAAM,GAAG,EAAE,KAAK,EAAE,CAAC;QACzB,OAAO,MAAM,CAAC;IAChB,CAAC;CACF","sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\nimport type { Result } from '@internetarchive/result-type';\nimport { MetadataBackendInterface } from './metadata-backend-interface';\nimport {\n MetadataServiceError,\n MetadataServiceErrorType,\n} from '../metadata-service-error';\n\n/**\n * The DefaultSearchBackend performs a `window.fetch` request to archive.org\n */\nexport class DefaultMetadataBackend implements MetadataBackendInterface {\n private baseUrl: string;\n\n private includeCredentials: boolean;\n\n private requestScope?: string;\n\n constructor(options?: {\n baseUrl?: string;\n includeCredentials?: boolean;\n scope?: string;\n }) {\n this.baseUrl = options?.baseUrl ?? 'archive.org';\n\n if (options?.includeCredentials !== undefined) {\n this.includeCredentials = options.includeCredentials;\n } else {\n // include credentials if the request is coming from an archive.org domain\n // since credentialed requests are only allowed from archive.org domains\n // due to CORS restrictions, see\n // https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS/Errors/CORSNotSupportingCredentials\n this.includeCredentials =\n window.location.href.match(/^https?:\\/\\/.*archive\\.org(:[0-9]+)?/) !==\n null;\n }\n\n if (options?.scope !== undefined) {\n this.requestScope = options.scope;\n } else {\n const currentUrl = new URL(window.location.href);\n const scope = currentUrl.searchParams.get('scope');\n if (scope) {\n this.requestScope = scope;\n }\n }\n }\n\n /** @inheritdoc */\n async fetchMetadata(\n identifier: string,\n keypath?: string\n ): Promise<Result<any, MetadataServiceError>> {\n const path = keypath ? `/${keypath}` : '';\n const url = `https://${this.baseUrl}/metadata/${identifier}${path}`;\n // the metadata endpoint doesn't currently support credentialed requests\n // so don't include credentials until that is fixed\n return this.fetchUrl(url, {\n requestOptions: {\n credentials: 'omit',\n },\n });\n }\n\n /**\n * Fires a request to the URL (with this backend's options applied) and\n * asynchronously returns a Result object containing either the raw response\n * JSON or a MetadataServiceError.\n */\n protected async fetchUrl(\n url: string,\n options?: {\n requestOptions?: RequestInit;\n }\n ): Promise<Result<any, MetadataServiceError>> {\n const finalUrl = new URL(url);\n if (this.requestScope) {\n finalUrl.searchParams.set('scope', this.requestScope);\n }\n\n let response: Response;\n // first try the fetch and return a networkError if it fails\n try {\n const fetchOptions = options?.requestOptions ?? {\n credentials: this.includeCredentials ? 'include' : 'same-origin',\n };\n response = await fetch(finalUrl.href, fetchOptions);\n } catch (err) {\n const message =\n err instanceof Error\n ? err.message\n : typeof err === 'string'\n ? err\n : 'Unknown error';\n return this.getErrorResult(\n MetadataServiceErrorType.networkError,\n message\n );\n }\n\n // then try json decoding and return a decodingError if it fails\n try {\n const json = await response.json();\n // the advanced search endpoint doesn't return an HTTP Error 400\n // and instead returns an HTTP 200 with an `error` key in the payload\n const error = json['error'];\n if (error) {\n const forensics = json['forensics'];\n return this.getErrorResult(\n MetadataServiceErrorType.searchEngineError,\n error,\n forensics\n );\n } else {\n // success\n return { success: json };\n }\n } catch (err) {\n const message =\n err instanceof Error\n ? err.message\n : typeof err === 'string'\n ? err\n : 'Unknown error';\n return this.getErrorResult(\n MetadataServiceErrorType.decodingError,\n message\n );\n }\n }\n\n private getErrorResult(\n errorType: MetadataServiceErrorType,\n message?: string,\n details?: any\n ): Result<any, MetadataServiceError> {\n const error = new MetadataServiceError(errorType, message, details);\n const result = { error };\n return result;\n }\n}\n"]}
1
+ {"version":3,"file":"default-metadata-backend.js","sourceRoot":"","sources":["../../../src/backend/default-metadata-backend.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,oBAAoB,EACpB,wBAAwB,GACzB,MAAM,2BAA2B,CAAC;AAGnC;;GAEG;AACH,MAAM,OAAO,sBAAsB;IAOjC,YAAY,OAIX;;QACC,IAAI,CAAC,OAAO,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,mCAAI,aAAa,CAAC;QAEjD,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,kBAAkB,MAAK,SAAS,EAAE,CAAC;YAC9C,IAAI,CAAC,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC;QACvD,CAAC;aAAM,CAAC;YACN,0EAA0E;YAC1E,wEAAwE;YACxE,gCAAgC;YAChC,6FAA6F;YAC7F,IAAI,CAAC,kBAAkB;gBACrB,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,sCAAsC,CAAC;oBAClE,IAAI,CAAC;QACT,CAAC;QAED,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,MAAK,SAAS,EAAE,CAAC;YACjC,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC;QACpC,CAAC;aAAM,CAAC;YACN,MAAM,UAAU,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YACjD,MAAM,KAAK,GAAG,UAAU,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YACnD,IAAI,KAAK,EAAE,CAAC;gBACV,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;YAC5B,CAAC;QACH,CAAC;IACH,CAAC;IAED,kBAAkB;IAClB,KAAK,CAAC,aAAa,CACjB,UAAkB,EAClB,OAAgB;QAEhB,MAAM,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,IAAI,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1C,MAAM,GAAG,GAAG,WAAW,IAAI,CAAC,OAAO,aAAa,UAAU,GAAG,IAAI,EAAE,CAAC;QACpE,wEAAwE;QACxE,mDAAmD;QACnD,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE;YACxB,cAAc,EAAE;gBACd,WAAW,EAAE,MAAM;aACpB;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,QAAQ,CACtB,GAAW,EACX,OAEC;;QAED,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;QAC9B,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YACtB,QAAQ,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QACxD,CAAC;QAED,IAAI,QAAkB,CAAC;QACvB,4DAA4D;QAC5D,IAAI,CAAC;YACH,MAAM,YAAY,GAAG,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,cAAc,mCAAI;gBAC9C,WAAW,EAAE,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,aAAa;aACjE,CAAC;YACF,QAAQ,GAAG,MAAM,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;QACtD,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,OAAO,GACX,GAAG,YAAY,KAAK;gBAClB,CAAC,CAAC,GAAG,CAAC,OAAO;gBACb,CAAC,CAAC,OAAO,GAAG,KAAK,QAAQ;oBACvB,CAAC,CAAC,GAAG;oBACL,CAAC,CAAC,eAAe,CAAC;YACxB,OAAO,IAAI,CAAC,cAAc,CACxB,wBAAwB,CAAC,YAAY,EACrC,OAAO,CACR,CAAC;QACJ,CAAC;QAED,gEAAgE;QAChE,IAAI,CAAC;YACH,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YACnC,gEAAgE;YAChE,qEAAqE;YACrE,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;YAC5B,IAAI,KAAK,EAAE,CAAC;gBACV,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC;gBACpC,OAAO,IAAI,CAAC,cAAc,CACxB,wBAAwB,CAAC,iBAAiB,EAC1C,KAAK,EACL,SAAS,CACV,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,UAAU;gBACV,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;YAC3B,CAAC;QACH,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,OAAO,GACX,GAAG,YAAY,KAAK;gBAClB,CAAC,CAAC,GAAG,CAAC,OAAO;gBACb,CAAC,CAAC,OAAO,GAAG,KAAK,QAAQ;oBACvB,CAAC,CAAC,GAAG;oBACL,CAAC,CAAC,eAAe,CAAC;YACxB,OAAO,IAAI,CAAC,cAAc,CACxB,wBAAwB,CAAC,aAAa,EACtC,OAAO,CACR,CAAC;QACJ,CAAC;IACH,CAAC;IAEO,cAAc,CACpB,SAAmC,EACnC,OAAgB,EAChB,OAAa;QAEb,MAAM,KAAK,GAAG,IAAI,oBAAoB,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QACpE,MAAM,MAAM,GAAG,EAAE,KAAK,EAAE,CAAC;QACzB,OAAO,MAAM,CAAC;IAChB,CAAC;CACF","sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\nimport type { Result } from '@internetarchive/result-type';\nimport {\n MetadataServiceError,\n MetadataServiceErrorType,\n} from '../metadata-service-error';\nimport { MetadataBackendInterface } from './metadata-backend-interface';\n\n/**\n * The DefaultSearchBackend performs a `window.fetch` request to archive.org\n */\nexport class DefaultMetadataBackend implements MetadataBackendInterface {\n private baseUrl: string;\n\n private includeCredentials: boolean;\n\n private requestScope?: string;\n\n constructor(options?: {\n baseUrl?: string;\n includeCredentials?: boolean;\n scope?: string;\n }) {\n this.baseUrl = options?.baseUrl ?? 'archive.org';\n\n if (options?.includeCredentials !== undefined) {\n this.includeCredentials = options.includeCredentials;\n } else {\n // include credentials if the request is coming from an archive.org domain\n // since credentialed requests are only allowed from archive.org domains\n // due to CORS restrictions, see\n // https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS/Errors/CORSNotSupportingCredentials\n this.includeCredentials =\n window.location.href.match(/^https?:\\/\\/.*archive\\.org(:[0-9]+)?/) !==\n null;\n }\n\n if (options?.scope !== undefined) {\n this.requestScope = options.scope;\n } else {\n const currentUrl = new URL(window.location.href);\n const scope = currentUrl.searchParams.get('scope');\n if (scope) {\n this.requestScope = scope;\n }\n }\n }\n\n /** @inheritdoc */\n async fetchMetadata(\n identifier: string,\n keypath?: string,\n ): Promise<Result<any, MetadataServiceError>> {\n const path = keypath ? `/${keypath}` : '';\n const url = `https://${this.baseUrl}/metadata/${identifier}${path}`;\n // the metadata endpoint doesn't currently support credentialed requests\n // so don't include credentials until that is fixed\n return this.fetchUrl(url, {\n requestOptions: {\n credentials: 'omit',\n },\n });\n }\n\n /**\n * Fires a request to the URL (with this backend's options applied) and\n * asynchronously returns a Result object containing either the raw response\n * JSON or a MetadataServiceError.\n */\n protected async fetchUrl(\n url: string,\n options?: {\n requestOptions?: RequestInit;\n },\n ): Promise<Result<any, MetadataServiceError>> {\n const finalUrl = new URL(url);\n if (this.requestScope) {\n finalUrl.searchParams.set('scope', this.requestScope);\n }\n\n let response: Response;\n // first try the fetch and return a networkError if it fails\n try {\n const fetchOptions = options?.requestOptions ?? {\n credentials: this.includeCredentials ? 'include' : 'same-origin',\n };\n response = await fetch(finalUrl.href, fetchOptions);\n } catch (err) {\n const message =\n err instanceof Error\n ? err.message\n : typeof err === 'string'\n ? err\n : 'Unknown error';\n return this.getErrorResult(\n MetadataServiceErrorType.networkError,\n message,\n );\n }\n\n // then try json decoding and return a decodingError if it fails\n try {\n const json = await response.json();\n // the advanced search endpoint doesn't return an HTTP Error 400\n // and instead returns an HTTP 200 with an `error` key in the payload\n const error = json['error'];\n if (error) {\n const forensics = json['forensics'];\n return this.getErrorResult(\n MetadataServiceErrorType.searchEngineError,\n error,\n forensics,\n );\n } else {\n // success\n return { success: json };\n }\n } catch (err) {\n const message =\n err instanceof Error\n ? err.message\n : typeof err === 'string'\n ? err\n : 'Unknown error';\n return this.getErrorResult(\n MetadataServiceErrorType.decodingError,\n message,\n );\n }\n }\n\n private getErrorResult(\n errorType: MetadataServiceErrorType,\n message?: string,\n details?: any,\n ): Result<any, MetadataServiceError> {\n const error = new MetadataServiceError(errorType, message, details);\n const result = { error };\n return result;\n }\n}\n"]}
@@ -1,20 +1,20 @@
1
- import type { Result } from '@internetarchive/result-type';
2
- import { MetadataServiceError } from '../metadata-service-error';
3
- /**
4
- * An interface to provide the network layer to the `MetadataService`.
5
- *
6
- * Objects implementing this interface are responsible for making calls to the Internet Archive
7
- * `metadata` endpoint or otherwise providing a similar reponse in JSON format.
8
- *
9
- * @export
10
- * @interface MetadataBackendInterface
11
- */
12
- export interface MetadataBackendInterface {
13
- /**
14
- * Fetch metadata for a single item with an optional keypath
15
- *
16
- * @param identifier
17
- * @param keypath
18
- */
19
- fetchMetadata(identifier: string, keypath?: string): Promise<Result<any, MetadataServiceError>>;
20
- }
1
+ import type { Result } from '@internetarchive/result-type';
2
+ import { MetadataServiceError } from '../metadata-service-error';
3
+ /**
4
+ * An interface to provide the network layer to the `MetadataService`.
5
+ *
6
+ * Objects implementing this interface are responsible for making calls to the Internet Archive
7
+ * `metadata` endpoint or otherwise providing a similar reponse in JSON format.
8
+ *
9
+ * @export
10
+ * @interface MetadataBackendInterface
11
+ */
12
+ export interface MetadataBackendInterface {
13
+ /**
14
+ * Fetch metadata for a single item with an optional keypath
15
+ *
16
+ * @param identifier
17
+ * @param keypath
18
+ */
19
+ fetchMetadata(identifier: string, keypath?: string): Promise<Result<any, MetadataServiceError>>;
20
+ }
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=metadata-backend-interface.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"metadata-backend-interface.js","sourceRoot":"","sources":["../../../src/backend/metadata-backend-interface.ts"],"names":[],"mappings":"","sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\nimport type { Result } from '@internetarchive/result-type';\nimport { MetadataServiceError } from '../metadata-service-error';\n\n/**\n * An interface to provide the network layer to the `MetadataService`.\n *\n * Objects implementing this interface are responsible for making calls to the Internet Archive\n * `metadata` endpoint or otherwise providing a similar reponse in JSON format.\n *\n * @export\n * @interface MetadataBackendInterface\n */\nexport interface MetadataBackendInterface {\n /**\n * Fetch metadata for a single item with an optional keypath\n *\n * @param identifier\n * @param keypath\n */\n fetchMetadata(\n identifier: string,\n keypath?: string\n ): Promise<Result<any, MetadataServiceError>>;\n}\n"]}
1
+ {"version":3,"file":"metadata-backend-interface.js","sourceRoot":"","sources":["../../../src/backend/metadata-backend-interface.ts"],"names":[],"mappings":"","sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\nimport type { Result } from '@internetarchive/result-type';\nimport { MetadataServiceError } from '../metadata-service-error';\n\n/**\n * An interface to provide the network layer to the `MetadataService`.\n *\n * Objects implementing this interface are responsible for making calls to the Internet Archive\n * `metadata` endpoint or otherwise providing a similar reponse in JSON format.\n *\n * @export\n * @interface MetadataBackendInterface\n */\nexport interface MetadataBackendInterface {\n /**\n * Fetch metadata for a single item with an optional keypath\n *\n * @param identifier\n * @param keypath\n */\n fetchMetadata(\n identifier: string,\n keypath?: string,\n ): Promise<Result<any, MetadataServiceError>>;\n}\n"]}
@@ -1,11 +1,11 @@
1
- export declare enum MetadataServiceErrorType {
2
- networkError = "MetadataService.NetworkError",
3
- itemNotFound = "MetadataService.ItemNotFound",
4
- decodingError = "MetadataService.DecodingError",
5
- searchEngineError = "MetadataService.SearchEngineError"
6
- }
7
- export declare class MetadataServiceError extends Error {
8
- type: MetadataServiceErrorType;
9
- details?: any;
10
- constructor(type: MetadataServiceErrorType, message?: string, details?: any);
11
- }
1
+ export declare enum MetadataServiceErrorType {
2
+ networkError = "MetadataService.NetworkError",
3
+ itemNotFound = "MetadataService.ItemNotFound",
4
+ decodingError = "MetadataService.DecodingError",
5
+ searchEngineError = "MetadataService.SearchEngineError"
6
+ }
7
+ export declare class MetadataServiceError extends Error {
8
+ type: MetadataServiceErrorType;
9
+ details?: any;
10
+ constructor(type: MetadataServiceErrorType, message?: string, details?: any);
11
+ }
@@ -1,18 +1,17 @@
1
- /* eslint-disable @typescript-eslint/explicit-module-boundary-types */
2
- /* eslint-disable @typescript-eslint/no-explicit-any */
3
- export var MetadataServiceErrorType;
4
- (function (MetadataServiceErrorType) {
5
- MetadataServiceErrorType["networkError"] = "MetadataService.NetworkError";
6
- MetadataServiceErrorType["itemNotFound"] = "MetadataService.ItemNotFound";
7
- MetadataServiceErrorType["decodingError"] = "MetadataService.DecodingError";
8
- MetadataServiceErrorType["searchEngineError"] = "MetadataService.SearchEngineError";
9
- })(MetadataServiceErrorType || (MetadataServiceErrorType = {}));
10
- export class MetadataServiceError extends Error {
11
- constructor(type, message, details) {
12
- super(message);
13
- this.name = type;
14
- this.type = type;
15
- this.details = details;
16
- }
17
- }
1
+ export var MetadataServiceErrorType;
2
+ (function (MetadataServiceErrorType) {
3
+ MetadataServiceErrorType["networkError"] = "MetadataService.NetworkError";
4
+ MetadataServiceErrorType["itemNotFound"] = "MetadataService.ItemNotFound";
5
+ MetadataServiceErrorType["decodingError"] = "MetadataService.DecodingError";
6
+ MetadataServiceErrorType["searchEngineError"] = "MetadataService.SearchEngineError";
7
+ })(MetadataServiceErrorType || (MetadataServiceErrorType = {}));
8
+ export class MetadataServiceError extends Error {
9
+ /* eslint-disable-next-line @typescript-eslint/no-explicit-any */
10
+ constructor(type, message, details) {
11
+ super(message);
12
+ this.name = type;
13
+ this.type = type;
14
+ this.details = details;
15
+ }
16
+ }
18
17
  //# sourceMappingURL=metadata-service-error.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"metadata-service-error.js","sourceRoot":"","sources":["../../src/metadata-service-error.ts"],"names":[],"mappings":"AAAA,sEAAsE;AACtE,uDAAuD;AACvD,MAAM,CAAN,IAAY,wBAKX;AALD,WAAY,wBAAwB;IAClC,yEAA6C,CAAA;IAC7C,yEAA6C,CAAA;IAC7C,2EAA+C,CAAA;IAC/C,mFAAuD,CAAA;AACzD,CAAC,EALW,wBAAwB,KAAxB,wBAAwB,QAKnC;AAED,MAAM,OAAO,oBAAqB,SAAQ,KAAK;IAK7C,YAAY,IAA8B,EAAE,OAAgB,EAAE,OAAa;QACzE,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;CACF","sourcesContent":["/* eslint-disable @typescript-eslint/explicit-module-boundary-types */\n/* eslint-disable @typescript-eslint/no-explicit-any */\nexport enum MetadataServiceErrorType {\n networkError = 'MetadataService.NetworkError',\n itemNotFound = 'MetadataService.ItemNotFound',\n decodingError = 'MetadataService.DecodingError',\n searchEngineError = 'MetadataService.SearchEngineError',\n}\n\nexport class MetadataServiceError extends Error {\n type: MetadataServiceErrorType;\n\n details?: any;\n\n constructor(type: MetadataServiceErrorType, message?: string, details?: any) {\n super(message);\n this.name = type;\n this.type = type;\n this.details = details;\n }\n}\n"]}
1
+ {"version":3,"file":"metadata-service-error.js","sourceRoot":"","sources":["../../src/metadata-service-error.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,wBAKX;AALD,WAAY,wBAAwB;IAClC,yEAA6C,CAAA;IAC7C,yEAA6C,CAAA;IAC7C,2EAA+C,CAAA;IAC/C,mFAAuD,CAAA;AACzD,CAAC,EALW,wBAAwB,KAAxB,wBAAwB,QAKnC;AAED,MAAM,OAAO,oBAAqB,SAAQ,KAAK;IAM7C,iEAAiE;IACjE,YAAY,IAA8B,EAAE,OAAgB,EAAE,OAAa;QACzE,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;CACF","sourcesContent":["export enum MetadataServiceErrorType {\n networkError = 'MetadataService.NetworkError',\n itemNotFound = 'MetadataService.ItemNotFound',\n decodingError = 'MetadataService.DecodingError',\n searchEngineError = 'MetadataService.SearchEngineError',\n}\n\nexport class MetadataServiceError extends Error {\n type: MetadataServiceErrorType;\n\n /* eslint-disable-next-line @typescript-eslint/no-explicit-any */\n details?: any;\n\n /* eslint-disable-next-line @typescript-eslint/no-explicit-any */\n constructor(type: MetadataServiceErrorType, message?: string, details?: any) {\n super(message);\n this.name = type;\n this.type = type;\n this.details = details;\n }\n}\n"]}
@@ -1,44 +1,44 @@
1
- import type { MetadataResponse } from './responses/metadata-response';
2
- import type { Result } from '@internetarchive/result-type';
3
- import type { MetadataServiceError } from './metadata-service-error';
4
- export interface MetadataServiceInterface {
5
- /**
6
- * Fetch metadata for a given identifier
7
- *
8
- * @param {string} identifier
9
- * @returns {Promise<Result<MetadataResponse, MetadataServiceError>>}
10
- */
11
- fetchMetadata(identifier: string): Promise<Result<MetadataResponse, MetadataServiceError>>;
12
- /**
13
- * Fetch the metadata value for a given identifier and keypath
14
- *
15
- * The response from this request can take any form, object, array, string, etc.
16
- * depending on the query. You can provide return typing in the response by
17
- * specifying the type. Note, there is no automatic type conversion since it can be anything.
18
- *
19
- * For example:
20
- *
21
- * ```ts
22
- * const collection = await searchService.fetchMetadataValue<string>('goody', 'metadata/collection/0');
23
- * console.debug('collection:', collection); => 'Goody Collection'
24
- *
25
- * const files_count = await searchService.fetchMetadataValue<number>('goody', 'files_count');
26
- * console.debug('files_count:', files_count); => 12
27
- * ```
28
- *
29
- * Keypath examples:
30
- *
31
- * /metadata/:identifier/metadata // returns the entire metadata object
32
- * /metadata/:identifier/server // returns the server for the given identifier
33
- * /metadata/:identifier/files_count
34
- * /metadata/:identifier/files?start=1&count=2 // query for files
35
- * /metadata/:identifier/metadata/collection // all collections
36
- * /metadata/:identifier/metadata/collection/0 // first collection
37
- * /metadata/:identifier/metadata/title
38
- * /metadata/:identifier/files/0/name // first file name
39
- *
40
- * @param identifier
41
- * @param keypath
42
- */
43
- fetchMetadataValue<T>(identifier: string, keypath: string): Promise<Result<T, MetadataServiceError>>;
44
- }
1
+ import type { Result } from '@internetarchive/result-type';
2
+ import type { MetadataServiceError } from './metadata-service-error';
3
+ import type { MetadataResponse } from './responses/metadata-response';
4
+ export interface MetadataServiceInterface {
5
+ /**
6
+ * Fetch metadata for a given identifier
7
+ *
8
+ * @param {string} identifier
9
+ * @returns {Promise<Result<MetadataResponse, MetadataServiceError>>}
10
+ */
11
+ fetchMetadata(identifier: string): Promise<Result<MetadataResponse, MetadataServiceError>>;
12
+ /**
13
+ * Fetch the metadata value for a given identifier and keypath
14
+ *
15
+ * The response from this request can take any form, object, array, string, etc.
16
+ * depending on the query. You can provide return typing in the response by
17
+ * specifying the type. Note, there is no automatic type conversion since it can be anything.
18
+ *
19
+ * For example:
20
+ *
21
+ * ```ts
22
+ * const collection = await searchService.fetchMetadataValue<string>('goody', 'metadata/collection/0');
23
+ * console.debug('collection:', collection); => 'Goody Collection'
24
+ *
25
+ * const files_count = await searchService.fetchMetadataValue<number>('goody', 'files_count');
26
+ * console.debug('files_count:', files_count); => 12
27
+ * ```
28
+ *
29
+ * Keypath examples:
30
+ *
31
+ * /metadata/:identifier/metadata // returns the entire metadata object
32
+ * /metadata/:identifier/server // returns the server for the given identifier
33
+ * /metadata/:identifier/files_count
34
+ * /metadata/:identifier/files?start=1&count=2 // query for files
35
+ * /metadata/:identifier/metadata/collection // all collections
36
+ * /metadata/:identifier/metadata/collection/0 // first collection
37
+ * /metadata/:identifier/metadata/title
38
+ * /metadata/:identifier/files/0/name // first file name
39
+ *
40
+ * @param identifier
41
+ * @param keypath
42
+ */
43
+ fetchMetadataValue<T>(identifier: string, keypath: string): Promise<Result<T, MetadataServiceError>>;
44
+ }
@@ -1,2 +1,2 @@
1
- export {};
1
+ export {};
2
2
  //# sourceMappingURL=metadata-service-interface.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"metadata-service-interface.js","sourceRoot":"","sources":["../../src/metadata-service-interface.ts"],"names":[],"mappings":"","sourcesContent":["import type { MetadataResponse } from './responses/metadata-response';\nimport type { Result } from '@internetarchive/result-type';\nimport type { MetadataServiceError } from './metadata-service-error';\n\nexport interface MetadataServiceInterface {\n /**\n * Fetch metadata for a given identifier\n *\n * @param {string} identifier\n * @returns {Promise<Result<MetadataResponse, MetadataServiceError>>}\n */\n fetchMetadata(\n identifier: string\n ): Promise<Result<MetadataResponse, MetadataServiceError>>;\n\n /**\n * Fetch the metadata value for a given identifier and keypath\n *\n * The response from this request can take any form, object, array, string, etc.\n * depending on the query. You can provide return typing in the response by\n * specifying the type. Note, there is no automatic type conversion since it can be anything.\n *\n * For example:\n *\n * ```ts\n * const collection = await searchService.fetchMetadataValue<string>('goody', 'metadata/collection/0');\n * console.debug('collection:', collection); => 'Goody Collection'\n *\n * const files_count = await searchService.fetchMetadataValue<number>('goody', 'files_count');\n * console.debug('files_count:', files_count); => 12\n * ```\n *\n * Keypath examples:\n *\n * /metadata/:identifier/metadata // returns the entire metadata object\n * /metadata/:identifier/server // returns the server for the given identifier\n * /metadata/:identifier/files_count\n * /metadata/:identifier/files?start=1&count=2 // query for files\n * /metadata/:identifier/metadata/collection // all collections\n * /metadata/:identifier/metadata/collection/0 // first collection\n * /metadata/:identifier/metadata/title\n * /metadata/:identifier/files/0/name // first file name\n *\n * @param identifier\n * @param keypath\n */\n fetchMetadataValue<T>(\n identifier: string,\n keypath: string\n ): Promise<Result<T, MetadataServiceError>>;\n}\n"]}
1
+ {"version":3,"file":"metadata-service-interface.js","sourceRoot":"","sources":["../../src/metadata-service-interface.ts"],"names":[],"mappings":"","sourcesContent":["import type { Result } from '@internetarchive/result-type';\nimport type { MetadataServiceError } from './metadata-service-error';\nimport type { MetadataResponse } from './responses/metadata-response';\n\nexport interface MetadataServiceInterface {\n /**\n * Fetch metadata for a given identifier\n *\n * @param {string} identifier\n * @returns {Promise<Result<MetadataResponse, MetadataServiceError>>}\n */\n fetchMetadata(\n identifier: string,\n ): Promise<Result<MetadataResponse, MetadataServiceError>>;\n\n /**\n * Fetch the metadata value for a given identifier and keypath\n *\n * The response from this request can take any form, object, array, string, etc.\n * depending on the query. You can provide return typing in the response by\n * specifying the type. Note, there is no automatic type conversion since it can be anything.\n *\n * For example:\n *\n * ```ts\n * const collection = await searchService.fetchMetadataValue<string>('goody', 'metadata/collection/0');\n * console.debug('collection:', collection); => 'Goody Collection'\n *\n * const files_count = await searchService.fetchMetadataValue<number>('goody', 'files_count');\n * console.debug('files_count:', files_count); => 12\n * ```\n *\n * Keypath examples:\n *\n * /metadata/:identifier/metadata // returns the entire metadata object\n * /metadata/:identifier/server // returns the server for the given identifier\n * /metadata/:identifier/files_count\n * /metadata/:identifier/files?start=1&count=2 // query for files\n * /metadata/:identifier/metadata/collection // all collections\n * /metadata/:identifier/metadata/collection/0 // first collection\n * /metadata/:identifier/metadata/title\n * /metadata/:identifier/files/0/name // first file name\n *\n * @param identifier\n * @param keypath\n */\n fetchMetadataValue<T>(\n identifier: string,\n keypath: string,\n ): Promise<Result<T, MetadataServiceError>>;\n}\n"]}
@@ -1,18 +1,18 @@
1
- import { MetadataResponse } from './responses/metadata-response';
2
- import { MetadataServiceError } from './metadata-service-error';
3
- import type { MetadataServiceInterface } from './metadata-service-interface';
4
- import type { Result } from '@internetarchive/result-type';
5
- import { MetadataBackendInterface } from './backend/metadata-backend-interface';
6
- /**
7
- * The Metadata Service is responsible for taking the raw response provided by
8
- * the backend and modeling it as a `MetadataResponse` object.
9
- */
10
- export declare class MetadataService implements MetadataServiceInterface {
11
- static default: MetadataServiceInterface;
12
- private backend;
13
- constructor(backend: MetadataBackendInterface);
14
- /** @inheritdoc */
15
- fetchMetadata(identifier: string): Promise<Result<MetadataResponse, MetadataServiceError>>;
16
- /** @inheritdoc */
17
- fetchMetadataValue<T>(identifier: string, keypath: string): Promise<Result<T, MetadataServiceError>>;
18
- }
1
+ import type { Result } from '@internetarchive/result-type';
2
+ import { MetadataBackendInterface } from './backend/metadata-backend-interface';
3
+ import { MetadataServiceError } from './metadata-service-error';
4
+ import type { MetadataServiceInterface } from './metadata-service-interface';
5
+ import { MetadataResponse } from './responses/metadata-response';
6
+ /**
7
+ * The Metadata Service is responsible for taking the raw response provided by
8
+ * the backend and modeling it as a `MetadataResponse` object.
9
+ */
10
+ export declare class MetadataService implements MetadataServiceInterface {
11
+ static default: MetadataServiceInterface;
12
+ private backend;
13
+ constructor(backend: MetadataBackendInterface);
14
+ /** @inheritdoc */
15
+ fetchMetadata(identifier: string): Promise<Result<MetadataResponse, MetadataServiceError>>;
16
+ /** @inheritdoc */
17
+ fetchMetadataValue<T>(identifier: string, keypath: string): Promise<Result<T, MetadataServiceError>>;
18
+ }
@@ -1,43 +1,43 @@
1
- import { MetadataResponse } from './responses/metadata-response';
2
- import { MetadataServiceError, MetadataServiceErrorType, } from './metadata-service-error';
3
- import { DefaultMetadataBackend } from './backend/default-metadata-backend';
4
- /**
5
- * The Metadata Service is responsible for taking the raw response provided by
6
- * the backend and modeling it as a `MetadataResponse` object.
7
- */
8
- export class MetadataService {
9
- constructor(backend) {
10
- this.backend = backend;
11
- }
12
- /** @inheritdoc */
13
- async fetchMetadata(identifier) {
14
- var _a;
15
- const rawResponse = await this.backend.fetchMetadata(identifier);
16
- if (rawResponse.error) {
17
- return rawResponse;
18
- }
19
- if (((_a = rawResponse.success) === null || _a === void 0 ? void 0 : _a.metadata) === undefined) {
20
- return {
21
- error: new MetadataServiceError(MetadataServiceErrorType.itemNotFound),
22
- };
23
- }
24
- const modeledResponse = new MetadataResponse(rawResponse.success);
25
- return { success: modeledResponse };
26
- }
27
- /** @inheritdoc */
28
- async fetchMetadataValue(identifier, keypath) {
29
- var _a;
30
- const result = await this.backend.fetchMetadata(identifier, keypath);
31
- if (result.error) {
32
- return result;
33
- }
34
- if (((_a = result.success) === null || _a === void 0 ? void 0 : _a.result) === undefined) {
35
- return {
36
- error: new MetadataServiceError(MetadataServiceErrorType.itemNotFound),
37
- };
38
- }
39
- return { success: result.success.result };
40
- }
41
- }
42
- MetadataService.default = new MetadataService(new DefaultMetadataBackend());
1
+ import { DefaultMetadataBackend } from './backend/default-metadata-backend';
2
+ import { MetadataServiceError, MetadataServiceErrorType, } from './metadata-service-error';
3
+ import { MetadataResponse } from './responses/metadata-response';
4
+ /**
5
+ * The Metadata Service is responsible for taking the raw response provided by
6
+ * the backend and modeling it as a `MetadataResponse` object.
7
+ */
8
+ export class MetadataService {
9
+ constructor(backend) {
10
+ this.backend = backend;
11
+ }
12
+ /** @inheritdoc */
13
+ async fetchMetadata(identifier) {
14
+ var _a;
15
+ const rawResponse = await this.backend.fetchMetadata(identifier);
16
+ if (rawResponse.error) {
17
+ return rawResponse;
18
+ }
19
+ if (((_a = rawResponse.success) === null || _a === void 0 ? void 0 : _a.metadata) === undefined) {
20
+ return {
21
+ error: new MetadataServiceError(MetadataServiceErrorType.itemNotFound),
22
+ };
23
+ }
24
+ const modeledResponse = new MetadataResponse(rawResponse.success);
25
+ return { success: modeledResponse };
26
+ }
27
+ /** @inheritdoc */
28
+ async fetchMetadataValue(identifier, keypath) {
29
+ var _a;
30
+ const result = await this.backend.fetchMetadata(identifier, keypath);
31
+ if (result.error) {
32
+ return result;
33
+ }
34
+ if (((_a = result.success) === null || _a === void 0 ? void 0 : _a.result) === undefined) {
35
+ return {
36
+ error: new MetadataServiceError(MetadataServiceErrorType.itemNotFound),
37
+ };
38
+ }
39
+ return { success: result.success.result };
40
+ }
41
+ }
42
+ MetadataService.default = new MetadataService(new DefaultMetadataBackend());
43
43
  //# sourceMappingURL=metadata-service.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"metadata-service.js","sourceRoot":"","sources":["../../src/metadata-service.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AACjE,OAAO,EACL,oBAAoB,EACpB,wBAAwB,GACzB,MAAM,0BAA0B,CAAC;AAGlC,OAAO,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAG5E;;;GAGG;AACH,MAAM,OAAO,eAAe;IAO1B,YAAY,OAAiC;QAC3C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED,kBAAkB;IAClB,KAAK,CAAC,aAAa,CACjB,UAAkB;;QAElB,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QACjE,IAAI,WAAW,CAAC,KAAK,EAAE;YACrB,OAAO,WAAW,CAAC;SACpB;QAED,IAAI,CAAA,MAAA,WAAW,CAAC,OAAO,0CAAE,QAAQ,MAAK,SAAS,EAAE;YAC/C,OAAO;gBACL,KAAK,EAAE,IAAI,oBAAoB,CAAC,wBAAwB,CAAC,YAAY,CAAC;aACvE,CAAC;SACH;QAED,MAAM,eAAe,GAAG,IAAI,gBAAgB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAClE,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC;IACtC,CAAC;IAED,kBAAkB;IAClB,KAAK,CAAC,kBAAkB,CACtB,UAAkB,EAClB,OAAe;;QAEf,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QACrE,IAAI,MAAM,CAAC,KAAK,EAAE;YAChB,OAAO,MAAM,CAAC;SACf;QAED,IAAI,CAAA,MAAA,MAAM,CAAC,OAAO,0CAAE,MAAM,MAAK,SAAS,EAAE;YACxC,OAAO;gBACL,KAAK,EAAE,IAAI,oBAAoB,CAAC,wBAAwB,CAAC,YAAY,CAAC;aACvE,CAAC;SACH;QAED,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;IAC5C,CAAC;;AA9Ca,uBAAO,GAA6B,IAAI,eAAe,CACnE,IAAI,sBAAsB,EAAE,CAC7B,CAAC","sourcesContent":["import { MetadataResponse } from './responses/metadata-response';\nimport {\n MetadataServiceError,\n MetadataServiceErrorType,\n} from './metadata-service-error';\nimport type { MetadataServiceInterface } from './metadata-service-interface';\nimport type { Result } from '@internetarchive/result-type';\nimport { DefaultMetadataBackend } from './backend/default-metadata-backend';\nimport { MetadataBackendInterface } from './backend/metadata-backend-interface';\n\n/**\n * The Metadata Service is responsible for taking the raw response provided by\n * the backend and modeling it as a `MetadataResponse` object.\n */\nexport class MetadataService implements MetadataServiceInterface {\n public static default: MetadataServiceInterface = new MetadataService(\n new DefaultMetadataBackend()\n );\n\n private backend: MetadataBackendInterface;\n\n constructor(backend: MetadataBackendInterface) {\n this.backend = backend;\n }\n\n /** @inheritdoc */\n async fetchMetadata(\n identifier: string\n ): Promise<Result<MetadataResponse, MetadataServiceError>> {\n const rawResponse = await this.backend.fetchMetadata(identifier);\n if (rawResponse.error) {\n return rawResponse;\n }\n\n if (rawResponse.success?.metadata === undefined) {\n return {\n error: new MetadataServiceError(MetadataServiceErrorType.itemNotFound),\n };\n }\n\n const modeledResponse = new MetadataResponse(rawResponse.success);\n return { success: modeledResponse };\n }\n\n /** @inheritdoc */\n async fetchMetadataValue<T>(\n identifier: string,\n keypath: string\n ): Promise<Result<T, MetadataServiceError>> {\n const result = await this.backend.fetchMetadata(identifier, keypath);\n if (result.error) {\n return result;\n }\n\n if (result.success?.result === undefined) {\n return {\n error: new MetadataServiceError(MetadataServiceErrorType.itemNotFound),\n };\n }\n\n return { success: result.success.result };\n }\n}\n"]}
1
+ {"version":3,"file":"metadata-service.js","sourceRoot":"","sources":["../../src/metadata-service.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAE5E,OAAO,EACL,oBAAoB,EACpB,wBAAwB,GACzB,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAEjE;;;GAGG;AACH,MAAM,OAAO,eAAe;IAO1B,YAAY,OAAiC;QAC3C,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAED,kBAAkB;IAClB,KAAK,CAAC,aAAa,CACjB,UAAkB;;QAElB,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QACjE,IAAI,WAAW,CAAC,KAAK,EAAE,CAAC;YACtB,OAAO,WAAW,CAAC;QACrB,CAAC;QAED,IAAI,CAAA,MAAA,WAAW,CAAC,OAAO,0CAAE,QAAQ,MAAK,SAAS,EAAE,CAAC;YAChD,OAAO;gBACL,KAAK,EAAE,IAAI,oBAAoB,CAAC,wBAAwB,CAAC,YAAY,CAAC;aACvE,CAAC;QACJ,CAAC;QAED,MAAM,eAAe,GAAG,IAAI,gBAAgB,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAClE,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC;IACtC,CAAC;IAED,kBAAkB;IAClB,KAAK,CAAC,kBAAkB,CACtB,UAAkB,EAClB,OAAe;;QAEf,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QACrE,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YACjB,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,IAAI,CAAA,MAAA,MAAM,CAAC,OAAO,0CAAE,MAAM,MAAK,SAAS,EAAE,CAAC;YACzC,OAAO;gBACL,KAAK,EAAE,IAAI,oBAAoB,CAAC,wBAAwB,CAAC,YAAY,CAAC;aACvE,CAAC;QACJ,CAAC;QAED,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;IAC5C,CAAC;;AA9Ca,uBAAO,GAA6B,IAAI,eAAe,CACnE,IAAI,sBAAsB,EAAE,CAC7B,CAAC","sourcesContent":["import type { Result } from '@internetarchive/result-type';\nimport { DefaultMetadataBackend } from './backend/default-metadata-backend';\nimport { MetadataBackendInterface } from './backend/metadata-backend-interface';\nimport {\n MetadataServiceError,\n MetadataServiceErrorType,\n} from './metadata-service-error';\nimport type { MetadataServiceInterface } from './metadata-service-interface';\nimport { MetadataResponse } from './responses/metadata-response';\n\n/**\n * The Metadata Service is responsible for taking the raw response provided by\n * the backend and modeling it as a `MetadataResponse` object.\n */\nexport class MetadataService implements MetadataServiceInterface {\n public static default: MetadataServiceInterface = new MetadataService(\n new DefaultMetadataBackend(),\n );\n\n private backend: MetadataBackendInterface;\n\n constructor(backend: MetadataBackendInterface) {\n this.backend = backend;\n }\n\n /** @inheritdoc */\n async fetchMetadata(\n identifier: string,\n ): Promise<Result<MetadataResponse, MetadataServiceError>> {\n const rawResponse = await this.backend.fetchMetadata(identifier);\n if (rawResponse.error) {\n return rawResponse;\n }\n\n if (rawResponse.success?.metadata === undefined) {\n return {\n error: new MetadataServiceError(MetadataServiceErrorType.itemNotFound),\n };\n }\n\n const modeledResponse = new MetadataResponse(rawResponse.success);\n return { success: modeledResponse };\n }\n\n /** @inheritdoc */\n async fetchMetadataValue<T>(\n identifier: string,\n keypath: string,\n ): Promise<Result<T, MetadataServiceError>> {\n const result = await this.backend.fetchMetadata(identifier, keypath);\n if (result.error) {\n return result;\n }\n\n if (result.success?.result === undefined) {\n return {\n error: new MetadataServiceError(MetadataServiceErrorType.itemNotFound),\n };\n }\n\n return { success: result.success.result };\n }\n}\n"]}