@abyss-project/tools 1.0.5 → 1.1.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 (195) hide show
  1. package/dist/api/beam.api.d.ts +48 -0
  2. package/dist/api/beam.api.js +104 -0
  3. package/dist/api/beam.api.js.map +1 -0
  4. package/dist/api/extraction-plan-preset.api.d.ts +9 -0
  5. package/dist/api/extraction-plan-preset.api.js +23 -0
  6. package/dist/api/extraction-plan-preset.api.js.map +1 -0
  7. package/dist/api/extraction-plan-preset.api.test.d.ts +1 -0
  8. package/dist/api/extraction-plan-preset.api.test.js +41 -0
  9. package/dist/api/extraction-plan-preset.api.test.js.map +1 -0
  10. package/dist/api/extraction-settings.api.d.ts +4 -0
  11. package/dist/api/extraction-settings.api.js +22 -0
  12. package/dist/api/extraction-settings.api.js.map +1 -0
  13. package/dist/api/extraction.api.d.ts +74 -0
  14. package/dist/api/extraction.api.js +416 -0
  15. package/dist/api/extraction.api.js.map +1 -0
  16. package/dist/api/index.d.ts +4 -1
  17. package/dist/api/index.js +4 -1
  18. package/dist/api/index.js.map +1 -1
  19. package/dist/constants/beam.constants.d.ts +1 -0
  20. package/dist/constants/beam.constants.js +5 -0
  21. package/dist/constants/beam.constants.js.map +1 -0
  22. package/dist/constants/index.d.ts +1 -0
  23. package/dist/constants/index.js +1 -0
  24. package/dist/constants/index.js.map +1 -1
  25. package/dist/index.d.ts +107 -58
  26. package/dist/index.js +105 -58
  27. package/dist/index.js.map +1 -1
  28. package/dist/types/enum/beam.enum.d.ts +12 -0
  29. package/dist/types/enum/beam.enum.js +18 -0
  30. package/dist/types/enum/beam.enum.js.map +1 -0
  31. package/dist/types/enum/combine-strategy.enum.d.ts +5 -0
  32. package/dist/types/enum/combine-strategy.enum.js +10 -0
  33. package/dist/types/enum/combine-strategy.enum.js.map +1 -0
  34. package/dist/types/enum/content-share.enum.d.ts +3 -1
  35. package/dist/types/enum/content-share.enum.js +2 -0
  36. package/dist/types/enum/content-share.enum.js.map +1 -1
  37. package/dist/types/enum/document-type.enum.d.ts +9 -0
  38. package/dist/types/enum/document-type.enum.js +14 -0
  39. package/dist/types/enum/document-type.enum.js.map +1 -0
  40. package/dist/types/enum/extraction-feedback-issue-type.enum.d.ts +8 -0
  41. package/dist/types/enum/extraction-feedback-issue-type.enum.js +13 -0
  42. package/dist/types/enum/extraction-feedback-issue-type.enum.js.map +1 -0
  43. package/dist/types/enum/extraction-warning.enum.d.ts +7 -0
  44. package/dist/types/enum/extraction-warning.enum.js +12 -0
  45. package/dist/types/enum/extraction-warning.enum.js.map +1 -0
  46. package/dist/types/enum/index.d.ts +7 -0
  47. package/dist/types/enum/index.js +7 -0
  48. package/dist/types/enum/index.js.map +1 -1
  49. package/dist/types/enum/interpreter-kind.enum.d.ts +5 -0
  50. package/dist/types/enum/interpreter-kind.enum.js +10 -0
  51. package/dist/types/enum/interpreter-kind.enum.js.map +1 -0
  52. package/dist/types/enum/provider-kind.enum.d.ts +10 -0
  53. package/dist/types/enum/provider-kind.enum.js +16 -0
  54. package/dist/types/enum/provider-kind.enum.js.map +1 -0
  55. package/dist/types/interface/api/requests/beam.request.d.ts +122 -0
  56. package/dist/types/interface/api/{responses/pdf.response.js → requests/beam.request.js} +1 -1
  57. package/dist/types/interface/api/requests/beam.request.js.map +1 -0
  58. package/dist/types/interface/api/requests/{rcb.request.d.ts → extraction.request.d.ts} +81 -52
  59. package/dist/types/interface/api/requests/{pdf.public.request.js → extraction.request.js} +1 -1
  60. package/dist/types/interface/api/requests/extraction.request.js.map +1 -0
  61. package/dist/types/interface/api/requests/index.d.ts +2 -1
  62. package/dist/types/interface/api/requests/index.js +2 -1
  63. package/dist/types/interface/api/requests/index.js.map +1 -1
  64. package/dist/types/interface/api/responses/beam.response.d.ts +92 -0
  65. package/dist/types/interface/api/responses/{rcb.response.js → beam.response.js} +1 -1
  66. package/dist/types/interface/api/responses/beam.response.js.map +1 -0
  67. package/dist/types/interface/api/responses/extraction.response.d.ts +403 -0
  68. package/dist/types/interface/api/{requests/user-tag.request.js → responses/extraction.response.js} +1 -1
  69. package/dist/types/interface/api/responses/extraction.response.js.map +1 -0
  70. package/dist/types/interface/api/responses/index.d.ts +2 -1
  71. package/dist/types/interface/api/responses/index.js +2 -1
  72. package/dist/types/interface/api/responses/index.js.map +1 -1
  73. package/dist/types/interface/models/beam.dto.d.ts +58 -0
  74. package/dist/types/interface/{api/requests/pdf.request.js → models/beam.dto.js} +1 -1
  75. package/dist/types/interface/models/beam.dto.js.map +1 -0
  76. package/dist/types/interface/models/extraction-fetched-provenance.dto.test.d.ts +1 -0
  77. package/dist/types/interface/models/extraction-fetched-provenance.dto.test.js +159 -0
  78. package/dist/types/interface/models/extraction-fetched-provenance.dto.test.js.map +1 -0
  79. package/dist/types/interface/models/extraction-plan.dto.d.ts +163 -0
  80. package/dist/types/interface/models/extraction-plan.dto.js +11 -0
  81. package/dist/types/interface/models/extraction-plan.dto.js.map +1 -0
  82. package/dist/types/interface/models/extraction-plan.dto.test.d.ts +1 -0
  83. package/dist/types/interface/models/extraction-plan.dto.test.js +35 -0
  84. package/dist/types/interface/models/extraction-plan.dto.test.js.map +1 -0
  85. package/dist/types/interface/models/extraction-spatial-template.dto.d.ts +37 -0
  86. package/dist/types/interface/{api/requests/rcb.request.js → models/extraction-spatial-template.dto.js} +1 -1
  87. package/dist/types/interface/models/extraction-spatial-template.dto.js.map +1 -0
  88. package/dist/types/interface/models/extraction-spatial-template.dto.test.d.ts +1 -0
  89. package/dist/types/interface/models/extraction-spatial-template.dto.test.js +15 -0
  90. package/dist/types/interface/models/extraction-spatial-template.dto.test.js.map +1 -0
  91. package/dist/types/interface/models/{rcb.dto.d.ts → extraction.dto.d.ts} +64 -48
  92. package/dist/types/interface/models/extraction.dto.js +28 -0
  93. package/dist/types/interface/models/extraction.dto.js.map +1 -0
  94. package/dist/types/interface/models/index.d.ts +4 -1
  95. package/dist/types/interface/models/index.js +4 -1
  96. package/dist/types/interface/models/index.js.map +1 -1
  97. package/dist/types/interface/models/organization.dto.d.ts +2 -0
  98. package/dist/utils/{rcb-webhook.utils.d.ts → extraction-webhook.utils.d.ts} +2 -2
  99. package/dist/utils/{rcb-webhook.utils.js → extraction-webhook.utils.js} +4 -4
  100. package/dist/utils/extraction-webhook.utils.js.map +1 -0
  101. package/dist/utils/index.d.ts +1 -1
  102. package/dist/utils/index.js +1 -1
  103. package/dist/utils/index.js.map +1 -1
  104. package/package.json +1 -1
  105. package/src/api/beam.api.ts +300 -0
  106. package/src/api/extraction-plan-preset.api.test.ts +24 -0
  107. package/src/api/extraction-plan-preset.api.ts +51 -0
  108. package/src/api/extraction-settings.api.ts +59 -0
  109. package/src/api/extraction.api.ts +899 -0
  110. package/src/api/index.ts +56 -51
  111. package/src/api/tests/beam.api.spec.ts +42 -0
  112. package/src/constants/beam.constants.ts +4 -0
  113. package/src/constants/index.ts +6 -5
  114. package/src/index.ts +840 -747
  115. package/src/types/enum/beam.enum.ts +24 -0
  116. package/src/types/enum/combine-strategy.enum.ts +7 -0
  117. package/src/types/enum/content-share.enum.ts +38 -36
  118. package/src/types/enum/document-type.enum.ts +10 -0
  119. package/src/types/enum/extraction-feedback-issue-type.enum.ts +10 -0
  120. package/src/types/enum/extraction-warning.enum.ts +21 -0
  121. package/src/types/enum/index.ts +13 -6
  122. package/src/types/enum/interpreter-kind.enum.ts +7 -0
  123. package/src/types/enum/provider-kind.enum.ts +13 -0
  124. package/src/types/interface/api/requests/beam.request.ts +152 -0
  125. package/src/types/interface/api/requests/extraction.request.ts +366 -0
  126. package/src/types/interface/api/requests/index.ts +29 -28
  127. package/src/types/interface/api/responses/beam.response.ts +122 -0
  128. package/src/types/interface/api/responses/extraction.response.ts +454 -0
  129. package/src/types/interface/api/responses/index.ts +33 -32
  130. package/src/types/interface/models/beam.dto.ts +67 -0
  131. package/src/types/interface/models/extraction-fetched-provenance.dto.test.ts +193 -0
  132. package/src/types/interface/models/extraction-plan.dto.test.ts +47 -0
  133. package/src/types/interface/models/extraction-plan.dto.ts +241 -0
  134. package/src/types/interface/models/extraction-spatial-template.dto.test.ts +27 -0
  135. package/src/types/interface/models/extraction-spatial-template.dto.ts +48 -0
  136. package/src/types/interface/models/{rcb.dto.ts → extraction.dto.ts} +317 -267
  137. package/src/types/interface/models/index.ts +34 -31
  138. package/src/types/interface/models/organization.dto.ts +21 -12
  139. package/src/types/tests/beam-management-types.spec.ts +38 -0
  140. package/src/types/tests/beam-share-enums.spec.ts +11 -0
  141. package/src/types/tests/beam.dto.spec.ts +61 -0
  142. package/src/types/tests/beam.request-response.spec.ts +43 -0
  143. package/src/utils/{rcb-webhook.utils.ts → extraction-webhook.utils.ts} +30 -30
  144. package/src/utils/index.ts +6 -6
  145. package/tsconfig.json +36 -35
  146. package/dist/api/atlas-page-content.api.d.ts +0 -0
  147. package/dist/api/atlas-page-content.api.js +0 -2
  148. package/dist/api/atlas-page-content.api.js.map +0 -1
  149. package/dist/api/pdf.api.d.ts +0 -15
  150. package/dist/api/pdf.api.js +0 -61
  151. package/dist/api/pdf.api.js.map +0 -1
  152. package/dist/api/pdf.public.api.d.ts +0 -8
  153. package/dist/api/pdf.public.api.js +0 -33
  154. package/dist/api/pdf.public.api.js.map +0 -1
  155. package/dist/api/rcb.api.d.ts +0 -72
  156. package/dist/api/rcb.api.js +0 -400
  157. package/dist/api/rcb.api.js.map +0 -1
  158. package/dist/api/user-tag.api.d.ts +0 -9
  159. package/dist/api/user-tag.api.js +0 -37
  160. package/dist/api/user-tag.api.js.map +0 -1
  161. package/dist/constants/user-tag.constants.d.ts +0 -3
  162. package/dist/constants/user-tag.constants.js +0 -7
  163. package/dist/constants/user-tag.constants.js.map +0 -1
  164. package/dist/types/enum/pdf-session.enum.d.ts +0 -10
  165. package/dist/types/enum/pdf-session.enum.js +0 -16
  166. package/dist/types/enum/pdf-session.enum.js.map +0 -1
  167. package/dist/types/interface/api/requests/pdf.public.request.d.ts +0 -19
  168. package/dist/types/interface/api/requests/pdf.public.request.js.map +0 -1
  169. package/dist/types/interface/api/requests/pdf.request.d.ts +0 -50
  170. package/dist/types/interface/api/requests/pdf.request.js.map +0 -1
  171. package/dist/types/interface/api/requests/rcb.request.js.map +0 -1
  172. package/dist/types/interface/api/requests/user-tag.request.d.ts +0 -44
  173. package/dist/types/interface/api/requests/user-tag.request.js.map +0 -1
  174. package/dist/types/interface/api/responses/pdf.public.response.d.ts +0 -33
  175. package/dist/types/interface/api/responses/pdf.public.response.js +0 -3
  176. package/dist/types/interface/api/responses/pdf.public.response.js.map +0 -1
  177. package/dist/types/interface/api/responses/pdf.response.d.ts +0 -35
  178. package/dist/types/interface/api/responses/pdf.response.js.map +0 -1
  179. package/dist/types/interface/api/responses/rcb.response.d.ts +0 -376
  180. package/dist/types/interface/api/responses/rcb.response.js.map +0 -1
  181. package/dist/types/interface/api/responses/user-tag.response.d.ts +0 -32
  182. package/dist/types/interface/api/responses/user-tag.response.js +0 -3
  183. package/dist/types/interface/api/responses/user-tag.response.js.map +0 -1
  184. package/dist/types/interface/models/pdf-session.dto.d.ts +0 -28
  185. package/dist/types/interface/models/pdf-session.dto.js +0 -3
  186. package/dist/types/interface/models/pdf-session.dto.js.map +0 -1
  187. package/dist/types/interface/models/rcb.dto.js +0 -26
  188. package/dist/types/interface/models/rcb.dto.js.map +0 -1
  189. package/dist/types/interface/models/user-tag.dto.d.ts +0 -22
  190. package/dist/types/interface/models/user-tag.dto.js +0 -3
  191. package/dist/types/interface/models/user-tag.dto.js.map +0 -1
  192. package/dist/utils/rcb-webhook.utils.js.map +0 -1
  193. package/src/api/rcb.api.ts +0 -829
  194. package/src/types/interface/api/requests/rcb.request.ts +0 -267
  195. package/src/types/interface/api/responses/rcb.response.ts +0 -399
package/src/api/index.ts CHANGED
@@ -1,51 +1,56 @@
1
- export * from './abyss.admin.api';
2
-
3
- // Atlas
4
- export * from './atlas.api';
5
- export * from './atlas.public.api';
6
- export * from './atlas-document.api';
7
- export * from './atlas-group.api';
8
- export * from './atlas-page.api';
9
-
10
- // Board
11
- export * from './board.api';
12
- export * from './board-card.api';
13
- export * from './board-card-checklist.api';
14
- export * from './board-card-comment.api';
15
- export * from './board-card-document.api';
16
- export * from './board-column.api';
17
- export * from './board-label.api';
18
-
19
- // Draw
20
- export * from './draw.api';
21
- export * from './draw.public.api';
22
-
23
- // Memo
24
- export * from './memo.api';
25
-
26
- // Retrospective
27
- export * from './retrospective.api';
28
- export * from './retrospective.public.api';
29
- export * from './retrospective-card.api';
30
- export * from './retrospective-member.api';
31
- export * from './retrospective-section.api';
32
-
33
- // Short Link
34
- export * from './short-link.api';
35
- export * from './short-link.public.api';
36
- export * from './short-link.admin.api';
37
-
38
- // Metrics
39
- export * from './metrics.api';
40
-
41
- // Organization
42
- export * from './organization.api';
43
-
44
- // Tag
45
- export * from './tag.api';
46
-
47
- // RCB (bank statement extraction)
48
- export * from './rcb.api';
49
-
50
- // Monitor (liveness)
51
- export * from './monitor.api';
1
+ export * from './abyss.admin.api';
2
+
3
+ // Atlas
4
+ export * from './atlas.api';
5
+ export * from './atlas.public.api';
6
+ export * from './atlas-document.api';
7
+ export * from './atlas-group.api';
8
+ export * from './atlas-page.api';
9
+
10
+ // Board
11
+ export * from './board.api';
12
+ export * from './board-card.api';
13
+ export * from './board-card-checklist.api';
14
+ export * from './board-card-comment.api';
15
+ export * from './board-card-document.api';
16
+ export * from './board-column.api';
17
+ export * from './board-label.api';
18
+
19
+ // Draw
20
+ export * from './draw.api';
21
+ export * from './draw.public.api';
22
+
23
+ // Memo
24
+ export * from './memo.api';
25
+
26
+ // Retrospective
27
+ export * from './retrospective.api';
28
+ export * from './retrospective.public.api';
29
+ export * from './retrospective-card.api';
30
+ export * from './retrospective-member.api';
31
+ export * from './retrospective-section.api';
32
+
33
+ // Short Link
34
+ export * from './short-link.api';
35
+ export * from './short-link.public.api';
36
+ export * from './short-link.admin.api';
37
+
38
+ // Beam (file transfer)
39
+ export * from './beam.api';
40
+
41
+ // Metrics
42
+ export * from './metrics.api';
43
+
44
+ // Organization
45
+ export * from './organization.api';
46
+
47
+ // Tag
48
+ export * from './tag.api';
49
+
50
+ // Extraction
51
+ export * from './extraction.api';
52
+ export * from './extraction-settings.api';
53
+ export * from './extraction-plan-preset.api';
54
+
55
+ // Monitor (liveness)
56
+ export * from './monitor.api';
@@ -0,0 +1,42 @@
1
+ import { AbyssToolsCore } from '../../index';
2
+ import { BeamVisibility } from '../../types';
3
+
4
+ describe('beamApi', () => {
5
+ it('exposes the beam CRUD namespace on the SDK facade', () => {
6
+ const beam = AbyssToolsCore.sdk.beam;
7
+ expect(typeof beam.get).toBe('function');
8
+ expect(typeof beam.getBySlug).toBe('function');
9
+ expect(typeof beam.paginate).toBe('function');
10
+ expect(typeof beam.paginateProject).toBe('function');
11
+ expect(typeof beam.paginateOrganization).toBe('function');
12
+ expect(typeof beam.create).toBe('function');
13
+ expect(typeof beam.update).toBe('function');
14
+ expect(typeof beam.delete).toBe('function');
15
+ });
16
+
17
+ it('create posts to /beam and returns the wrapped transfer', async () => {
18
+ const post = jest
19
+ .spyOn(AbyssToolsCore.axios, 'post')
20
+ .mockResolvedValue({ data: { data: { beamTransfer: { id: 't1' } } } });
21
+
22
+ const res = await AbyssToolsCore.sdk.beam.create({
23
+ title: 'T',
24
+ visibility: BeamVisibility.PUBLIC,
25
+ });
26
+
27
+ expect(post).toHaveBeenCalledWith('/beam', { title: 'T', visibility: BeamVisibility.PUBLIC });
28
+ expect(res.data.beamTransfer.id).toBe('t1');
29
+ post.mockRestore();
30
+ });
31
+
32
+ it('getBySlug reads the public /b/:slug path', async () => {
33
+ const get = jest
34
+ .spyOn(AbyssToolsCore.axios, 'get')
35
+ .mockResolvedValue({ data: { data: { beamTransfer: { id: 't1', slug: 'abcdefghij' } } } });
36
+
37
+ await AbyssToolsCore.sdk.beam.getBySlug({ slug: 'abcdefghij' });
38
+
39
+ expect(get).toHaveBeenCalledWith('/b/abcdefghij');
40
+ get.mockRestore();
41
+ });
42
+ });
@@ -0,0 +1,4 @@
1
+ // Header carrying the anonymous transfer management secret (spec §7). The front
2
+ // keeps the plaintext manageToken in the URL fragment and sends it here; the API
3
+ // (BeamMiddleware) compares sha256(header) to beam_transfers.manageTokenHash.
4
+ export const BEAM_MANAGE_TOKEN_HEADER = 'x-beam-manage-token';
@@ -1,5 +1,6 @@
1
- export * from './memo.constants';
2
- export * from './atlas.constants';
3
- export * from './board.constants';
4
- export * from './short-link.constants';
5
- export * from './tag.constants';
1
+ export * from './memo.constants';
2
+ export * from './atlas.constants';
3
+ export * from './board.constants';
4
+ export * from './short-link.constants';
5
+ export * from './tag.constants';
6
+ export * from './beam.constants';