arocapi 1.0.5 → 1.2.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 (165) hide show
  1. package/README.md +597 -29
  2. package/dist/app.d.ts +27 -6
  3. package/dist/app.js +76 -17
  4. package/dist/app.js.map +1 -1
  5. package/dist/app.test.js +124 -0
  6. package/dist/app.test.js.map +1 -0
  7. package/dist/express.d.ts +3 -2
  8. package/dist/express.js +11 -11
  9. package/dist/express.js.map +1 -1
  10. package/dist/index.dev.d.ts +8 -0
  11. package/dist/index.dev.js +146 -0
  12. package/dist/index.dev.js.map +1 -0
  13. package/dist/routes/crate.d.ts +7 -0
  14. package/dist/routes/crate.js +99 -0
  15. package/dist/routes/crate.js.map +1 -0
  16. package/dist/routes/crate.test.d.ts +1 -0
  17. package/dist/routes/crate.test.js +360 -0
  18. package/dist/routes/crate.test.js.map +1 -0
  19. package/dist/routes/entities.d.ts +8 -0
  20. package/dist/routes/entities.js +75 -0
  21. package/dist/routes/entities.js.map +1 -0
  22. package/dist/routes/entities.test.d.ts +1 -0
  23. package/dist/routes/entities.test.js +245 -0
  24. package/dist/routes/entities.test.js.map +1 -0
  25. package/dist/routes/entity.d.ts +8 -0
  26. package/dist/routes/entity.js +45 -0
  27. package/dist/routes/entity.js.map +1 -0
  28. package/dist/routes/entity.test.d.ts +1 -0
  29. package/dist/routes/entity.test.js +109 -0
  30. package/dist/routes/entity.test.js.map +1 -0
  31. package/dist/routes/file.d.ts +7 -0
  32. package/dist/routes/file.js +111 -0
  33. package/dist/routes/file.js.map +1 -0
  34. package/dist/routes/file.test.d.ts +1 -0
  35. package/dist/routes/file.test.js +319 -0
  36. package/dist/routes/file.test.js.map +1 -0
  37. package/dist/routes/files.d.ts +8 -0
  38. package/dist/routes/files.js +61 -0
  39. package/dist/routes/files.js.map +1 -0
  40. package/dist/routes/files.test.d.ts +1 -0
  41. package/dist/routes/files.test.js +244 -0
  42. package/dist/routes/files.test.js.map +1 -0
  43. package/dist/routes/search.d.ts +8 -0
  44. package/dist/routes/{search/index.js → search.js} +45 -19
  45. package/dist/routes/search.js.map +1 -0
  46. package/dist/routes/search.test.d.ts +1 -0
  47. package/dist/routes/search.test.js +698 -0
  48. package/dist/routes/search.test.js.map +1 -0
  49. package/dist/test/helpers/fastify.d.ts +9 -0
  50. package/dist/test/helpers/fastify.js +24 -0
  51. package/dist/test/helpers/fastify.js.map +1 -0
  52. package/dist/test/integration.setup.d.ts +58 -0
  53. package/dist/test/integration.setup.js +181 -0
  54. package/dist/test/integration.setup.js.map +1 -0
  55. package/dist/test/integration.test.d.ts +1 -0
  56. package/dist/test/integration.test.js +337 -0
  57. package/dist/test/integration.test.js.map +1 -0
  58. package/dist/transformers/default.d.ts +45 -0
  59. package/dist/transformers/default.js +46 -0
  60. package/dist/transformers/default.js.map +1 -0
  61. package/dist/transformers/default.test.d.ts +1 -0
  62. package/dist/transformers/default.test.js +177 -0
  63. package/dist/transformers/default.test.js.map +1 -0
  64. package/dist/transformers/transformer.test.d.ts +1 -0
  65. package/dist/transformers/transformer.test.js +176 -0
  66. package/dist/transformers/transformer.test.js.map +1 -0
  67. package/dist/types/fileHandlers.d.ts +41 -0
  68. package/dist/types/fileHandlers.js +2 -0
  69. package/dist/types/fileHandlers.js.map +1 -0
  70. package/dist/types/transformers.d.ts +10 -0
  71. package/dist/types/transformers.js +2 -0
  72. package/dist/types/transformers.js.map +1 -0
  73. package/dist/utils/errors.d.ts +23 -0
  74. package/dist/utils/errors.js +21 -0
  75. package/dist/utils/errors.js.map +1 -0
  76. package/dist/utils/errors.test.d.ts +1 -0
  77. package/dist/utils/errors.test.js +66 -0
  78. package/dist/utils/errors.test.js.map +1 -0
  79. package/package.json +34 -25
  80. package/prisma/migrations/20250827033956_record_type_scalar/migration.sql +10 -0
  81. package/prisma/migrations/20250923032753_api_refactor/migration.sql +39 -0
  82. package/prisma/migrations/20250923223119_entity_type_to_string/migration.sql +8 -0
  83. package/prisma/migrations/20251020140329_add_meta_column/migration.sql +2 -0
  84. package/prisma/migrations/20251027010713_add_file_table/migration.sql +17 -0
  85. package/prisma/migrations/20251027221138_add_file_id_to_entity/migration.sql +2 -0
  86. package/prisma/models/entity.prisma +16 -12
  87. package/prisma/models/file.prisma +20 -0
  88. package/prisma/schema.prisma +1 -20
  89. package/prisma.config.ts +6 -7
  90. package/src/__snapshots__/app.test.ts.snap +8 -0
  91. package/src/app.test.ts +158 -0
  92. package/src/app.ts +150 -30
  93. package/src/express.ts +12 -11
  94. package/src/index.dev.ts +196 -0
  95. package/src/reset.d.ts +1 -0
  96. package/src/routes/__snapshots__/entities.test.ts.snap +68 -0
  97. package/src/routes/__snapshots__/entity.test.ts.snap +66 -0
  98. package/src/routes/__snapshots__/search.test.ts.snap +139 -0
  99. package/src/routes/crate.test.ts +441 -0
  100. package/src/routes/crate.ts +141 -0
  101. package/src/routes/entities.test.ts +284 -0
  102. package/src/routes/entities.ts +101 -0
  103. package/src/routes/entity.test.ts +132 -0
  104. package/src/routes/entity.ts +63 -0
  105. package/src/routes/file.test.ts +399 -0
  106. package/src/routes/file.ts +153 -0
  107. package/src/routes/files.test.ts +303 -0
  108. package/src/routes/files.ts +87 -0
  109. package/src/routes/search.test.ts +807 -0
  110. package/src/routes/{search/index.ts → search.ts} +67 -24
  111. package/src/test/__snapshots__/integration.test.ts.snap +18 -0
  112. package/src/test/helpers/fastify.ts +39 -0
  113. package/src/test/integration.setup.ts +200 -0
  114. package/src/test/integration.test.ts +411 -0
  115. package/src/transformers/default.test.ts +199 -0
  116. package/src/transformers/default.ts +165 -0
  117. package/src/transformers/transformer.test.ts +233 -0
  118. package/src/types/fileHandlers.ts +65 -0
  119. package/src/types/transformers.ts +52 -0
  120. package/src/utils/errors.test.ts +75 -0
  121. package/src/utils/errors.ts +45 -0
  122. package/dist/plugins/cors.d.ts +0 -3
  123. package/dist/plugins/cors.js +0 -6
  124. package/dist/plugins/cors.js.map +0 -1
  125. package/dist/plugins/opensearch.d.ts +0 -9
  126. package/dist/plugins/opensearch.js +0 -22
  127. package/dist/plugins/opensearch.js.map +0 -1
  128. package/dist/plugins/prisma.d.ts +0 -8
  129. package/dist/plugins/prisma.js +0 -11
  130. package/dist/plugins/prisma.js.map +0 -1
  131. package/dist/plugins/sensible.d.ts +0 -3
  132. package/dist/plugins/sensible.js +0 -6
  133. package/dist/plugins/sensible.js.map +0 -1
  134. package/dist/plugins/support.d.ts +0 -9
  135. package/dist/plugins/support.js +0 -5
  136. package/dist/plugins/support.js.map +0 -1
  137. package/dist/plugins/validation.d.ts +0 -3
  138. package/dist/plugins/validation.js +0 -32
  139. package/dist/plugins/validation.js.map +0 -1
  140. package/dist/routes/entities/index.d.ts +0 -3
  141. package/dist/routes/entities/index.js +0 -63
  142. package/dist/routes/entities/index.js.map +0 -1
  143. package/dist/routes/entity/index.d.ts +0 -3
  144. package/dist/routes/entity/index.js +0 -24
  145. package/dist/routes/entity/index.js.map +0 -1
  146. package/dist/routes/search/index.d.ts +0 -3
  147. package/dist/routes/search/index.js.map +0 -1
  148. package/dist/scripts/loadEntities.js +0 -170
  149. package/dist/scripts/loadEntities.js.map +0 -1
  150. package/dist/type.d.ts +0 -6
  151. package/dist/type.js +0 -2
  152. package/dist/type.js.map +0 -1
  153. package/src/plugins/README.md +0 -16
  154. package/src/plugins/cors.ts +0 -11
  155. package/src/plugins/opensearch.ts +0 -32
  156. package/src/plugins/prisma.ts +0 -23
  157. package/src/plugins/sensible.ts +0 -11
  158. package/src/plugins/support.ts +0 -20
  159. package/src/plugins/validation.ts +0 -48
  160. package/src/routes/README.md +0 -29
  161. package/src/routes/entities/index.ts +0 -83
  162. package/src/routes/entity/index.ts +0 -28
  163. package/src/scripts/loadEntities.ts +0 -223
  164. package/src/type.ts +0 -7
  165. /package/dist/{scripts/loadEntities.d.ts → app.test.d.ts} +0 -0
@@ -0,0 +1,66 @@
1
+ import { describe, expect, it } from 'vitest';
2
+ import { createInternalError, createNotFoundError } from './errors.js';
3
+ describe('Error Utilities', () => {
4
+ describe('createInternalError', () => {
5
+ it('should create a default internal error', () => {
6
+ const error = createInternalError();
7
+ expect(error).toEqual({
8
+ error: {
9
+ code: 'INTERNAL_ERROR',
10
+ message: 'Internal server error',
11
+ details: undefined,
12
+ },
13
+ });
14
+ });
15
+ it('should create an internal error with custom message', () => {
16
+ const customMessage = 'Database connection failed';
17
+ const error = createInternalError(customMessage);
18
+ expect(error).toEqual({
19
+ error: {
20
+ code: 'INTERNAL_ERROR',
21
+ message: customMessage,
22
+ details: undefined,
23
+ },
24
+ });
25
+ });
26
+ });
27
+ describe('createNotFoundError', () => {
28
+ it('should create a not found error with message', () => {
29
+ const message = 'Entity not found';
30
+ const error = createNotFoundError(message);
31
+ expect(error).toEqual({
32
+ error: {
33
+ code: 'NOT_FOUND',
34
+ message,
35
+ details: undefined,
36
+ },
37
+ });
38
+ });
39
+ it('should create a not found error with message and entityId', () => {
40
+ const message = 'Entity not found';
41
+ const entityId = 'http://example.com/entity/123';
42
+ const error = createNotFoundError(message, entityId);
43
+ expect(error).toEqual({
44
+ error: {
45
+ code: 'NOT_FOUND',
46
+ message,
47
+ details: {
48
+ entityId,
49
+ },
50
+ },
51
+ });
52
+ });
53
+ it('should handle undefined entityId', () => {
54
+ const message = 'Entity not found';
55
+ const error = createNotFoundError(message, undefined);
56
+ expect(error).toEqual({
57
+ error: {
58
+ code: 'NOT_FOUND',
59
+ message,
60
+ details: undefined,
61
+ },
62
+ });
63
+ });
64
+ });
65
+ });
66
+ //# sourceMappingURL=errors.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"errors.test.js","sourceRoot":"","sources":["../../src/utils/errors.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAEvE,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;QACnC,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;YAChD,MAAM,KAAK,GAAG,mBAAmB,EAAE,CAAC;YAEpC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;gBACpB,KAAK,EAAE;oBACL,IAAI,EAAE,gBAAgB;oBACtB,OAAO,EAAE,uBAAuB;oBAChC,OAAO,EAAE,SAAS;iBACnB;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qDAAqD,EAAE,GAAG,EAAE;YAC7D,MAAM,aAAa,GAAG,4BAA4B,CAAC;YACnD,MAAM,KAAK,GAAG,mBAAmB,CAAC,aAAa,CAAC,CAAC;YAEjD,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;gBACpB,KAAK,EAAE;oBACL,IAAI,EAAE,gBAAgB;oBACtB,OAAO,EAAE,aAAa;oBACtB,OAAO,EAAE,SAAS;iBACnB;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;QACnC,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;YACtD,MAAM,OAAO,GAAG,kBAAkB,CAAC;YACnC,MAAM,KAAK,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;YAE3C,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;gBACpB,KAAK,EAAE;oBACL,IAAI,EAAE,WAAW;oBACjB,OAAO;oBACP,OAAO,EAAE,SAAS;iBACnB;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;YACnE,MAAM,OAAO,GAAG,kBAAkB,CAAC;YACnC,MAAM,QAAQ,GAAG,+BAA+B,CAAC;YACjD,MAAM,KAAK,GAAG,mBAAmB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;YAErD,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;gBACpB,KAAK,EAAE;oBACL,IAAI,EAAE,WAAW;oBACjB,OAAO;oBACP,OAAO,EAAE;wBACP,QAAQ;qBACT;iBACF;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;YAC1C,MAAM,OAAO,GAAG,kBAAkB,CAAC;YACnC,MAAM,KAAK,GAAG,mBAAmB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;YAEtD,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC;gBACpB,KAAK,EAAE;oBACL,IAAI,EAAE,WAAW;oBACjB,OAAO;oBACP,OAAO,EAAE,SAAS;iBACnB;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "type": "module",
3
3
  "name": "arocapi",
4
- "version": "1.0.5",
4
+ "version": "1.2.0",
5
5
  "description": "An RO-Crate API",
6
6
  "main": "dist/app.js",
7
7
  "exports": {
@@ -15,35 +15,38 @@
15
15
  "author": "John Ferlito <johnf@inodes.org>",
16
16
  "license": "ISC",
17
17
  "dependencies": {
18
- "@fastify/autoload": "^6.3.1",
19
18
  "@fastify/cors": "^11.1.0",
20
- "@fastify/routes": "^6.0.2",
21
19
  "@fastify/sensible": "^6.0.0",
22
20
  "@opensearch-project/opensearch": "^3.5.1",
23
- "@prisma/config": "^6.14.0",
24
- "dotenv": "^17.2.1",
21
+ "@prisma/config": "^6.18.0",
22
+ "dotenv": "^17.2.3",
25
23
  "express": "^5.1.0",
26
- "fastify": "^5.4.0",
27
- "fastify-cli": "^7.4.0",
28
- "fastify-plugin": "^5.0.0",
29
- "fastify-type-provider-zod": "^5.0.3",
30
- "zod": "^4.1.3"
24
+ "fastify": "^5.6.1",
25
+ "fastify-plugin": "^5.1.0",
26
+ "fastify-type-provider-zod": "^6.1.0",
27
+ "zod": "^4.1.12"
31
28
  },
32
29
  "devDependencies": {
33
- "@biomejs/biome": "^2.2.2",
34
- "@prisma/client": "^6.14.0",
30
+ "@biomejs/biome": "^2.3.2",
31
+ "@prisma/client": "^6.18.0",
35
32
  "@semantic-release/changelog": "^6.0.3",
36
33
  "@semantic-release/git": "^10.0.1",
37
- "@types/express": "^5.0.3",
38
- "@types/node": "^22.18.0",
34
+ "@total-typescript/ts-reset": "^0.6.1",
35
+ "@types/express": "^5.0.5",
36
+ "@types/node": "^22.18.13",
37
+ "@vitest/coverage-v8": "^4.0.5",
38
+ "@vitest/ui": "^4.0.5",
39
39
  "concurrently": "^9.2.1",
40
40
  "conventional-changelog-conventionalcommits": "^9.1.0",
41
41
  "fastify-tsconfig": "^3.0.0",
42
- "prisma": "^6.14.0",
43
- "prisma-json-types-generator": "^3.6.0",
44
- "semantic-release": "^24.2.7",
45
- "tsx": "^4.20.5",
46
- "typescript": "^5.9.2"
42
+ "knip": "^5.66.4",
43
+ "prisma": "^6.18.0",
44
+ "prisma-json-types-generator": "^3.6.2",
45
+ "semantic-release": "^25.0.1",
46
+ "tsx": "^4.20.6",
47
+ "typescript": "^5.9.3",
48
+ "vitest": "^4.0.5",
49
+ "vitest-mock-extended": "^3.1.0"
47
50
  },
48
51
  "peerDependencies": {
49
52
  "@prisma/client": ">=6"
@@ -58,21 +61,27 @@
58
61
  "prisma.config.ts"
59
62
  ],
60
63
  "scripts": {
61
- "start": "npm run build:ts && fastify start -l info dist/app.js",
62
64
  "build:ts": "tsc",
63
65
  "watch:ts": "tsc -w",
64
- "dev": "npm run dev:clean && npm run build:ts && concurrently -k -p \"[{name}]\" -n \"TypeScript,App\" -c \"yellow.bold,cyan.bold\" \"npm:watch:ts\" \"npm:dev:start\"",
65
- "dev:start": "fastify start --ignore-watch=.ts$ -w -l info -P dist/app.js",
66
+ "dev": "pnpm run dev:clean && pnpm run build:ts && concurrently -k -p \"[{name}]\" -n \"TypeScript,App\" -c \"yellow.bold,cyan.bold\" \"pnpm:dev:start\" \"pnpm:watch:ts\" ",
67
+ "dev:start": "node --watch --env-file=.env dist/index.dev.js",
66
68
  "dev:clean": "rm -rf dist",
67
69
  "dbconsole": "docker compose exec db mysql --password=password catalog",
68
70
  "load-test-data": "tsx src/scripts/loadEntities.ts",
69
71
  "lint:biome": "biome check",
70
72
  "lint:types": "tsc --noEmit",
71
- "prepublishOnly": "npm run lint:biome && npm run lint:types && npm run build:ts",
73
+ "lint:knip": "knip",
74
+ "lint": "concurrently -p \"[{name}]\" -n \"biome,types,knip\" -c \"yellow.bold,cyan.bold,magenta.bold\" \"pnpm:lint:biome\" \"pnpm:lint:types\" \"pnpm:lint:knip\"",
75
+ "test": "vitest run",
76
+ "test:watch": "./scripts/setup-integration.sh && vitest",
77
+ "test:ui": "./scripts/setup-integration.sh && vitest --ui",
78
+ "test:coverage": "./scripts/setup-integration.sh && vitest run --coverage",
79
+ "prepublishOnly": "pnpm run lint:biome && pnpm run lint:types && pnpm run build:ts",
72
80
  "generate": "npx prisma generate",
73
- "postinstall": "npm run generate",
81
+ "postinstall": "pnpm run generate",
74
82
  "db:generate": "prisma generate",
75
- "db:migrate": "prisma migrate deploy"
83
+ "db:migrate": "prisma migrate deploy",
84
+ "seed": "rm -rf dist && pnpm run build:ts && node --env-file=.env example/data/seed.ts"
76
85
  },
77
86
  "repository": {
78
87
  "type": "git",
@@ -0,0 +1,10 @@
1
+ /*
2
+ Warnings:
3
+
4
+ - You are about to alter the column `recordType` on the `Entity` table. The data in that column could be lost. The data in that column will be cast from `Json` to `Enum(EnumId(0))`.
5
+ - Made the column `rocrate` on table `Entity` required. This step will fail if there are existing NULL values in that column.
6
+
7
+ */
8
+ -- AlterTable
9
+ ALTER TABLE `Entity` MODIFY `recordType` ENUM('RepositoryCollection', 'RepositoryObject') NOT NULL,
10
+ MODIFY `rocrate` JSON NOT NULL;
@@ -0,0 +1,39 @@
1
+ /*
2
+ Phased migration to preserve data while renaming and remapping fields:
3
+ 1. Add new columns with defaults
4
+ 2. Copy and transform data from old columns to new ones
5
+ 3. Drop old columns
6
+ 4. Remove defaults from new columns where appropriate
7
+ */
8
+
9
+ -- Step 1: Add new columns with temporary defaults
10
+ ALTER TABLE `Entity`
11
+ ADD COLUMN `entityType` ENUM('http://pcdm.org/models#Collection', 'http://pcdm.org/models#Object', 'http://schema.org/MediaObject', 'http://schema.org/Person') NOT NULL DEFAULT 'http://pcdm.org/models#Collection',
12
+ ADD COLUMN `rootCollection` VARCHAR(2048) NULL,
13
+ ADD COLUMN `metadataLicenseId` VARCHAR(2048) NOT NULL DEFAULT 'FIXME',
14
+ ADD COLUMN `contentLicenseId` VARCHAR(2048) NOT NULL DEFAULT 'FIXME';
15
+
16
+ -- Step 2: Copy and transform data from old columns
17
+ -- Map conformsTo URLs to new entityType enum values
18
+ UPDATE `Entity` SET `entityType` =
19
+ CASE
20
+ WHEN `conformsTo` LIKE '%Collection%' THEN 'http://pcdm.org/models#Collection'
21
+ WHEN `conformsTo` LIKE '%Object%' THEN 'http://pcdm.org/models#Object'
22
+ WHEN `conformsTo` LIKE '%File%' THEN 'http://schema.org/MediaObject'
23
+ ELSE 'http://pcdm.org/models#Person' -- Default fallback
24
+ END;
25
+
26
+ -- Copy root to rootCollection
27
+ UPDATE `Entity` SET `rootCollection` = `root`;
28
+
29
+ -- Step 3: Drop old columns
30
+ ALTER TABLE `Entity`
31
+ DROP COLUMN `conformsTo`,
32
+ DROP COLUMN `recordType`,
33
+ DROP COLUMN `root`;
34
+
35
+ -- Step 4: Remove temporary default from entityType (keep defaults for license fields)
36
+ ALTER TABLE `Entity`
37
+ ALTER COLUMN `entityType` DROP DEFAULT,
38
+ ALTER COLUMN `metadataLicenseId` DROP DEFAULT,
39
+ ALTER COLUMN `contentLicenseId` DROP DEFAULT;
@@ -0,0 +1,8 @@
1
+ /*
2
+ Warnings:
3
+
4
+ - You are about to alter the column `entityType` on the `Entity` table. The data in that column could be lost. The data in that column will be cast from `Enum(EnumId(0))` to `VarChar(1024)`.
5
+
6
+ */
7
+ -- AlterTable
8
+ ALTER TABLE `Entity` MODIFY `entityType` VARCHAR(1024) NOT NULL;
@@ -0,0 +1,2 @@
1
+ -- AlterTable
2
+ ALTER TABLE `Entity` ADD COLUMN `meta` JSON NULL;
@@ -0,0 +1,17 @@
1
+ -- CreateTable
2
+ CREATE TABLE `File` (
3
+ `id` INTEGER NOT NULL AUTO_INCREMENT,
4
+ `fileId` VARCHAR(2048) NOT NULL,
5
+ `filename` VARCHAR(255) NOT NULL,
6
+ `mediaType` VARCHAR(127) NOT NULL,
7
+ `size` BIGINT NOT NULL,
8
+ `memberOf` VARCHAR(2048) NOT NULL,
9
+ `rootCollection` VARCHAR(2048) NOT NULL,
10
+ `contentLicenseId` VARCHAR(2048) NOT NULL,
11
+ `meta` JSON NULL,
12
+ `createdAt` DATETIME(3) NOT NULL DEFAULT CURRENT_TIMESTAMP(3),
13
+ `updatedAt` DATETIME(3) NOT NULL,
14
+
15
+ UNIQUE INDEX `File_fileId_key`(`fileId`(768)),
16
+ PRIMARY KEY (`id`)
17
+ ) DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
@@ -0,0 +1,2 @@
1
+ -- AlterTable
2
+ ALTER TABLE `Entity` ADD COLUMN `fileId` VARCHAR(2048) NULL;
@@ -1,16 +1,20 @@
1
1
  model Entity {
2
- id Int @id @default(autoincrement())
3
- rocrateId String @db.VarChar(2048)
4
- name String @db.VarChar(1024)
5
- description String @db.Text
6
- conformsTo String @db.VarChar(2048)
7
- // NOTE: How should we do recordType, can we infer it from conformsTo?
8
- // recordType String??
9
- memberOf String? @db.VarChar(2048)
10
- root String? @db.VarChar(2048)
11
- /// RecordType[]
12
- recordType Json
13
- rocrate Json
2
+ id Int @id @default(autoincrement())
3
+
4
+ rocrateId String @db.VarChar(2048)
5
+
6
+ name String @db.VarChar(1024)
7
+ description String @db.Text
8
+
9
+ entityType String @db.VarChar(1024)
10
+ memberOf String? @db.VarChar(2048)
11
+ rootCollection String? @db.VarChar(2048)
12
+ metadataLicenseId String @db.VarChar(2048)
13
+ contentLicenseId String @db.VarChar(2048)
14
+ fileId String? @db.VarChar(2048)
15
+
16
+ rocrate Json
17
+ meta Json?
14
18
 
15
19
  createdAt DateTime @default(now())
16
20
  updatedAt DateTime @updatedAt
@@ -0,0 +1,20 @@
1
+ model File {
2
+ id Int @id @default(autoincrement())
3
+
4
+ fileId String @db.VarChar(2048)
5
+
6
+ filename String @db.VarChar(255)
7
+ mediaType String @db.VarChar(127)
8
+ size BigInt
9
+
10
+ memberOf String @db.VarChar(2048)
11
+ rootCollection String @db.VarChar(2048)
12
+ contentLicenseId String @db.VarChar(2048)
13
+
14
+ meta Json?
15
+
16
+ createdAt DateTime @default(now())
17
+ updatedAt DateTime @updatedAt
18
+
19
+ @@unique([fileId(length: 768)])
20
+ }
@@ -4,6 +4,7 @@
4
4
  generator client {
5
5
  provider = "prisma-client"
6
6
  output = "../src/generated/prisma"
7
+ importFileExtension = "js"
7
8
  }
8
9
 
9
10
  generator json {
@@ -14,23 +15,3 @@ datasource db {
14
15
  provider = "mysql"
15
16
  url = env("DATABASE_URL")
16
17
  }
17
-
18
- model Entity {
19
- id Int @id @default(autoincrement())
20
- rocrateId String @db.VarChar(2048)
21
- name String @db.VarChar(1024)
22
- description String @db.Text
23
- conformsTo String @db.VarChar(2048)
24
- // NOTE: How should we do recordType, can we infer it from conformsTo?
25
- // recordType String??
26
- memberOf String? @db.VarChar(2048)
27
- root String? @db.VarChar(2048)
28
- /// RecordType[]
29
- recordType Json
30
- rocrate Json
31
-
32
- createdAt DateTime @default(now())
33
- updatedAt DateTime @updatedAt
34
-
35
- // TODO: How will we handle permissions?
36
- }
package/prisma.config.ts CHANGED
@@ -1,12 +1,11 @@
1
- import path from 'node:path';
2
-
3
1
  import 'dotenv/config';
4
- import { defineConfig } from 'prisma/config';
2
+ import { defineConfig, env } from '@prisma/config';
5
3
 
6
4
  export default defineConfig({
7
- schema: path.join('prisma', 'schema.prisma'),
8
- migrations: {
9
- path: path.join('prisma', 'migrations'),
10
- // seed: "prisma/seed.ts"
5
+ schema: 'prisma',
6
+ engine: 'classic',
7
+ datasource: {
8
+ // provider: "mysql",
9
+ url: env('DATABASE_URL'),
11
10
  },
12
11
  });
@@ -0,0 +1,8 @@
1
+ // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
2
+
3
+ exports[`Entity Route > App Registration > should handle random errors 1`] = `
4
+ {
5
+ "error": "Internal Server Error",
6
+ "message": "Random",
7
+ }
8
+ `;
@@ -0,0 +1,158 @@
1
+ import Fastify from 'fastify';
2
+ import { beforeEach, describe, expect, it, vi } from 'vitest';
3
+ import { mockReset } from 'vitest-mock-extended';
4
+
5
+ import app, { AllPublicAccessTransformer, AllPublicFileAccessTransformer } from './app.js';
6
+
7
+ import { opensearch, prisma } from './test/helpers/fastify.js';
8
+
9
+ describe('Entity Route', () => {
10
+ beforeEach(() => {
11
+ mockReset(prisma);
12
+ mockReset(opensearch);
13
+ });
14
+
15
+ describe('App Registration', () => {
16
+ it('should handle missing prisma', async () => {
17
+ const fastify = Fastify({ logger: false });
18
+
19
+ // @ts-expect-error we are testing missing options
20
+ fastify.register(app, {
21
+ opensearch,
22
+ disableCors: false,
23
+ });
24
+
25
+ await expect(() => fastify.ready()).rejects.toThrowError('Prisma client is required');
26
+ });
27
+
28
+ it('should handle missing opensearch', async () => {
29
+ const fastify = Fastify({ logger: false });
30
+
31
+ // @ts-expect-error we are testing missing options
32
+ fastify.register(app, {
33
+ prisma,
34
+ disableCors: false,
35
+ });
36
+
37
+ await expect(() => fastify.ready()).rejects.toThrowError('OpenSearch client is required');
38
+ });
39
+
40
+ it('should handle missing accessTransformer', async () => {
41
+ const fastify = Fastify({ logger: false });
42
+
43
+ // @ts-expect-error we are testing missing options
44
+ fastify.register(app, {
45
+ prisma,
46
+ opensearch,
47
+ disableCors: false,
48
+ });
49
+
50
+ await expect(() => fastify.ready()).rejects.toThrowError('accessTransformer is required');
51
+ });
52
+
53
+ it('should handle missing fileAccessTransformer', async () => {
54
+ const fastify = Fastify({ logger: false });
55
+
56
+ // @ts-expect-error we are testing missing options
57
+ fastify.register(app, {
58
+ prisma,
59
+ opensearch,
60
+ disableCors: false,
61
+ accessTransformer: AllPublicAccessTransformer,
62
+ });
63
+
64
+ await expect(() => fastify.ready()).rejects.toThrowError('fileAccessTransformer is required');
65
+ });
66
+
67
+ it('should handle missing fileHandler', async () => {
68
+ const fastify = Fastify({ logger: false });
69
+
70
+ // @ts-expect-error we are testing missing options
71
+ fastify.register(app, {
72
+ prisma,
73
+ opensearch,
74
+ disableCors: false,
75
+ accessTransformer: AllPublicAccessTransformer,
76
+ fileAccessTransformer: AllPublicFileAccessTransformer,
77
+ });
78
+
79
+ await expect(() => fastify.ready()).rejects.toThrowError('fileHandler is required');
80
+ });
81
+
82
+ it('should handle missing roCrateHandler', async () => {
83
+ const fastify = Fastify({ logger: false });
84
+
85
+ // @ts-expect-error we are testing missing options
86
+ fastify.register(app, {
87
+ prisma,
88
+ opensearch,
89
+ disableCors: false,
90
+ accessTransformer: AllPublicAccessTransformer,
91
+ fileAccessTransformer: AllPublicFileAccessTransformer,
92
+ fileHandler: {
93
+ get: vi.fn(),
94
+ head: vi.fn(),
95
+ },
96
+ });
97
+
98
+ await expect(() => fastify.ready()).rejects.toThrowError('roCrateHandler is required');
99
+ });
100
+
101
+ it('should handle broken opensearch', async () => {
102
+ opensearch.ping.mockRejectedValue(new Error('Connection failed'));
103
+
104
+ const fastify = Fastify({ logger: false });
105
+
106
+ fastify.register(app, {
107
+ prisma,
108
+ opensearch,
109
+ disableCors: false,
110
+ accessTransformer: AllPublicAccessTransformer,
111
+ fileAccessTransformer: AllPublicFileAccessTransformer,
112
+ fileHandler: {
113
+ get: vi.fn(),
114
+ head: vi.fn(),
115
+ },
116
+ roCrateHandler: {
117
+ get: vi.fn(),
118
+ head: vi.fn(),
119
+ },
120
+ });
121
+
122
+ await expect(() => fastify.ready()).rejects.toThrowError('Connection failed');
123
+ });
124
+
125
+ it('should handle random errors', async () => {
126
+ const fastify = Fastify({ logger: false });
127
+ await fastify.register(app, {
128
+ prisma,
129
+ opensearch,
130
+ disableCors: false,
131
+ accessTransformer: AllPublicAccessTransformer,
132
+ fileAccessTransformer: AllPublicFileAccessTransformer,
133
+ fileHandler: {
134
+ get: vi.fn(),
135
+ head: vi.fn(),
136
+ },
137
+ roCrateHandler: {
138
+ get: vi.fn(),
139
+ head: vi.fn(),
140
+ },
141
+ });
142
+ fastify.get('/error', async () => {
143
+ throw new Error('Random');
144
+ });
145
+
146
+ await fastify.ready();
147
+
148
+ const response = await fastify.inject({
149
+ method: 'GET',
150
+ url: '/error',
151
+ });
152
+ const body = JSON.parse(response.body);
153
+
154
+ expect(response.statusCode).toBe(500);
155
+ expect(body).toMatchSnapshot();
156
+ });
157
+ });
158
+ });