@internetarchive/metadata-service 0.0.1-alpha.1

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 -0
  2. package/.eslintrc.js +14 -0
  3. package/.github/workflows/ci.yml +26 -0
  4. package/LICENSE +661 -0
  5. package/README.md +64 -0
  6. package/demo/app-root.ts +80 -0
  7. package/demo/index.html +27 -0
  8. package/dist/demo/app-root.d.ts +11 -0
  9. package/dist/demo/app-root.js +71 -0
  10. package/dist/demo/app-root.js.map +1 -0
  11. package/dist/index.d.ts +18 -0
  12. package/dist/index.js +17 -0
  13. package/dist/index.js.map +1 -0
  14. package/dist/src/backend/default-metadata-backend.d.ts +27 -0
  15. package/dist/src/backend/default-metadata-backend.js +101 -0
  16. package/dist/src/backend/default-metadata-backend.js.map +1 -0
  17. package/dist/src/backend/metadata-backend-interface.d.ts +20 -0
  18. package/dist/src/backend/metadata-backend-interface.js +2 -0
  19. package/dist/src/backend/metadata-backend-interface.js.map +1 -0
  20. package/dist/src/metadata-service-error.d.ts +11 -0
  21. package/dist/src/metadata-service-error.js +18 -0
  22. package/dist/src/metadata-service-error.js.map +1 -0
  23. package/dist/src/metadata-service-interface.d.ts +44 -0
  24. package/dist/src/metadata-service-interface.js +2 -0
  25. package/dist/src/metadata-service-interface.js.map +1 -0
  26. package/dist/src/metadata-service.d.ts +18 -0
  27. package/dist/src/metadata-service.js +43 -0
  28. package/dist/src/metadata-service.js.map +1 -0
  29. package/dist/src/models/file.d.ts +29 -0
  30. package/dist/src/models/file.js +95 -0
  31. package/dist/src/models/file.js.map +1 -0
  32. package/dist/src/models/metadata-fields/field-types/boolean.d.ts +5 -0
  33. package/dist/src/models/metadata-fields/field-types/boolean.js +8 -0
  34. package/dist/src/models/metadata-fields/field-types/boolean.js.map +1 -0
  35. package/dist/src/models/metadata-fields/field-types/byte.d.ts +13 -0
  36. package/dist/src/models/metadata-fields/field-types/byte.js +16 -0
  37. package/dist/src/models/metadata-fields/field-types/byte.js.map +1 -0
  38. package/dist/src/models/metadata-fields/field-types/date.d.ts +5 -0
  39. package/dist/src/models/metadata-fields/field-types/date.js +8 -0
  40. package/dist/src/models/metadata-fields/field-types/date.js.map +1 -0
  41. package/dist/src/models/metadata-fields/field-types/duration.d.ts +14 -0
  42. package/dist/src/models/metadata-fields/field-types/duration.js +17 -0
  43. package/dist/src/models/metadata-fields/field-types/duration.js.map +1 -0
  44. package/dist/src/models/metadata-fields/field-types/list.d.ts +25 -0
  45. package/dist/src/models/metadata-fields/field-types/list.js +34 -0
  46. package/dist/src/models/metadata-fields/field-types/list.js.map +1 -0
  47. package/dist/src/models/metadata-fields/field-types/mediatype.d.ts +5 -0
  48. package/dist/src/models/metadata-fields/field-types/mediatype.js +8 -0
  49. package/dist/src/models/metadata-fields/field-types/mediatype.js.map +1 -0
  50. package/dist/src/models/metadata-fields/field-types/number.d.ts +5 -0
  51. package/dist/src/models/metadata-fields/field-types/number.js +8 -0
  52. package/dist/src/models/metadata-fields/field-types/number.js.map +1 -0
  53. package/dist/src/models/metadata-fields/field-types/page-progression.d.ts +5 -0
  54. package/dist/src/models/metadata-fields/field-types/page-progression.js +8 -0
  55. package/dist/src/models/metadata-fields/field-types/page-progression.js.map +1 -0
  56. package/dist/src/models/metadata-fields/field-types/string.d.ts +5 -0
  57. package/dist/src/models/metadata-fields/field-types/string.js +8 -0
  58. package/dist/src/models/metadata-fields/field-types/string.js.map +1 -0
  59. package/dist/src/models/metadata-fields/metadata-field.d.ts +70 -0
  60. package/dist/src/models/metadata-fields/metadata-field.js +67 -0
  61. package/dist/src/models/metadata-fields/metadata-field.js.map +1 -0
  62. package/dist/src/models/metadata.d.ts +168 -0
  63. package/dist/src/models/metadata.js +618 -0
  64. package/dist/src/models/metadata.js.map +1 -0
  65. package/dist/src/models/review.d.ts +10 -0
  66. package/dist/src/models/review.js +43 -0
  67. package/dist/src/models/review.js.map +1 -0
  68. package/dist/src/models/speech-music-asr-entry.d.ts +10 -0
  69. package/dist/src/models/speech-music-asr-entry.js +2 -0
  70. package/dist/src/models/speech-music-asr-entry.js.map +1 -0
  71. package/dist/src/responses/metadata-response.d.ts +28 -0
  72. package/dist/src/responses/metadata-response.js +31 -0
  73. package/dist/src/responses/metadata-response.js.map +1 -0
  74. package/dist/test/default-metadata-backend.test.d.ts +1 -0
  75. package/dist/test/default-metadata-backend.test.js +91 -0
  76. package/dist/test/default-metadata-backend.test.js.map +1 -0
  77. package/dist/test/metadata-service.test.d.ts +1 -0
  78. package/dist/test/metadata-service.test.js +99 -0
  79. package/dist/test/metadata-service.test.js.map +1 -0
  80. package/dist/test/mock-response-generator.d.ts +3 -0
  81. package/dist/test/mock-response-generator.js +62 -0
  82. package/dist/test/mock-response-generator.js.map +1 -0
  83. package/dist/test/models/file.test.d.ts +1 -0
  84. package/dist/test/models/file.test.js +9 -0
  85. package/dist/test/models/file.test.js.map +1 -0
  86. package/dist/test/models/metadata-fields/list-field.test.d.ts +1 -0
  87. package/dist/test/models/metadata-fields/list-field.test.js +52 -0
  88. package/dist/test/models/metadata-fields/list-field.test.js.map +1 -0
  89. package/dist/test/models/metadata-fields/metadata-field.test.d.ts +1 -0
  90. package/dist/test/models/metadata-fields/metadata-field.test.js +121 -0
  91. package/dist/test/models/metadata-fields/metadata-field.test.js.map +1 -0
  92. package/dist/test/models/metadata.test.d.ts +1 -0
  93. package/dist/test/models/metadata.test.js +10 -0
  94. package/dist/test/models/metadata.test.js.map +1 -0
  95. package/index.ts +32 -0
  96. package/package.json +77 -0
  97. package/src/backend/default-metadata-backend.ts +141 -0
  98. package/src/backend/metadata-backend-interface.ts +25 -0
  99. package/src/metadata-service-error.ts +21 -0
  100. package/src/metadata-service-interface.ts +51 -0
  101. package/src/metadata-service.ts +63 -0
  102. package/src/models/file.ts +105 -0
  103. package/src/models/metadata-fields/field-types/boolean.ts +8 -0
  104. package/src/models/metadata-fields/field-types/byte.ts +16 -0
  105. package/src/models/metadata-fields/field-types/date.ts +8 -0
  106. package/src/models/metadata-fields/field-types/duration.ts +17 -0
  107. package/src/models/metadata-fields/field-types/list.ts +44 -0
  108. package/src/models/metadata-fields/field-types/mediatype.ts +8 -0
  109. package/src/models/metadata-fields/field-types/number.ts +8 -0
  110. package/src/models/metadata-fields/field-types/page-progression.ts +14 -0
  111. package/src/models/metadata-fields/field-types/string.ts +8 -0
  112. package/src/models/metadata-fields/metadata-field.ts +108 -0
  113. package/src/models/metadata.ts +457 -0
  114. package/src/models/review.ts +41 -0
  115. package/src/models/speech-music-asr-entry.ts +10 -0
  116. package/src/responses/metadata-response.ts +61 -0
  117. package/test/default-metadata-backend.test.ts +101 -0
  118. package/test/metadata-service.test.ts +150 -0
  119. package/test/mock-response-generator.ts +62 -0
  120. package/test/models/file.test.ts +10 -0
  121. package/test/models/metadata-fields/list-field.test.ts +64 -0
  122. package/test/models/metadata-fields/metadata-field.test.ts +151 -0
  123. package/test/models/metadata.test.ts +11 -0
  124. package/tsconfig.json +22 -0
  125. package/web-test-runner.config.mjs +7 -0
package/.editorconfig ADDED
@@ -0,0 +1,29 @@
1
+ # EditorConfig helps developers define and maintain consistent
2
+ # coding styles between different editors and IDEs
3
+ # editorconfig.org
4
+
5
+ root = true
6
+
7
+
8
+ [*]
9
+
10
+ # Change these settings to your own preference
11
+ indent_style = space
12
+ indent_size = 2
13
+
14
+ # We recommend you to keep these unchanged
15
+ end_of_line = lf
16
+ charset = utf-8
17
+ trim_trailing_whitespace = true
18
+ insert_final_newline = true
19
+
20
+ [*.md]
21
+ trim_trailing_whitespace = false
22
+
23
+ [*.json]
24
+ indent_size = 2
25
+
26
+ [*.{html,js,md}]
27
+ block_comment_start = /**
28
+ block_comment = *
29
+ block_comment_end = */
package/.eslintrc.js ADDED
@@ -0,0 +1,14 @@
1
+ module.exports = {
2
+ root: true,
3
+ parser: '@typescript-eslint/parser',
4
+ plugins: ['@typescript-eslint', 'html'],
5
+ extends: ['plugin:@typescript-eslint/recommended'],
6
+ settings: {
7
+ 'import/resolver': {
8
+ node: {
9
+ extensions: ['.js', '.jsx', '.ts', '.tsx'],
10
+ moduleDirectory: ['node_modules', 'src', 'demo'],
11
+ },
12
+ },
13
+ },
14
+ };
@@ -0,0 +1,26 @@
1
+ name: App CI
2
+
3
+ on:
4
+ push:
5
+ branches: [ main ]
6
+ pull_request:
7
+ branches: [ main ]
8
+
9
+ jobs:
10
+ build:
11
+ runs-on: ubuntu-latest
12
+
13
+ steps:
14
+ - uses: actions/checkout@v2
15
+ - uses: actions/setup-node@v1
16
+ with:
17
+ node-version: 15.x
18
+
19
+ - name: Install dependencies
20
+ run: npm install
21
+
22
+ - name: Run tests
23
+ run: npm run test
24
+
25
+ - name: Upload CodeCov
26
+ run: npm run codecov