@abyss-project/beam 0.0.0-stage → 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 (123) hide show
  1. package/.eslintrc.js +32 -0
  2. package/.prettierrc +5 -0
  3. package/README.md +21 -2
  4. package/dist/api/beam.api.d.ts +49 -0
  5. package/dist/api/beam.api.js +110 -0
  6. package/dist/api/beam.api.js.map +1 -0
  7. package/dist/api/index.d.ts +1 -0
  8. package/dist/api/index.js +18 -0
  9. package/dist/api/index.js.map +1 -0
  10. package/dist/constants/beam.constants.d.ts +1 -0
  11. package/dist/constants/beam.constants.js +5 -0
  12. package/dist/constants/beam.constants.js.map +1 -0
  13. package/dist/constants/index.d.ts +1 -0
  14. package/dist/constants/index.js +18 -0
  15. package/dist/constants/index.js.map +1 -0
  16. package/dist/index.d.ts +62 -0
  17. package/dist/index.js +149 -0
  18. package/dist/index.js.map +1 -0
  19. package/dist/types/enum/api-error.enum.d.ts +31 -0
  20. package/dist/types/enum/api-error.enum.js +37 -0
  21. package/dist/types/enum/api-error.enum.js.map +1 -0
  22. package/dist/types/enum/beam.enum.d.ts +22 -0
  23. package/dist/types/enum/beam.enum.js +30 -0
  24. package/dist/types/enum/beam.enum.js.map +1 -0
  25. package/dist/types/enum/content-share.enum.d.ts +34 -0
  26. package/dist/types/enum/content-share.enum.js +42 -0
  27. package/dist/types/enum/content-share.enum.js.map +1 -0
  28. package/dist/types/enum/index.d.ts +3 -0
  29. package/dist/types/enum/index.js +20 -0
  30. package/dist/types/enum/index.js.map +1 -0
  31. package/dist/types/index.d.ts +2 -0
  32. package/dist/types/index.js +19 -0
  33. package/dist/types/index.js.map +1 -0
  34. package/dist/types/interface/api/index.d.ts +5 -0
  35. package/dist/types/interface/api/index.js +22 -0
  36. package/dist/types/interface/api/index.js.map +1 -0
  37. package/dist/types/interface/api/requests/beam.request.d.ts +139 -0
  38. package/dist/types/interface/api/requests/beam.request.js +3 -0
  39. package/dist/types/interface/api/requests/beam.request.js.map +1 -0
  40. package/dist/types/interface/api/requests/index.d.ts +1 -0
  41. package/dist/types/interface/api/requests/index.js +18 -0
  42. package/dist/types/interface/api/requests/index.js.map +1 -0
  43. package/dist/types/interface/api/responses/beam.response.d.ts +115 -0
  44. package/dist/types/interface/api/responses/beam.response.js +3 -0
  45. package/dist/types/interface/api/responses/beam.response.js.map +1 -0
  46. package/dist/types/interface/api/responses/index.d.ts +1 -0
  47. package/dist/types/interface/api/responses/index.js +18 -0
  48. package/dist/types/interface/api/responses/index.js.map +1 -0
  49. package/dist/types/interface/api/type-message/api-error.d.ts +6 -0
  50. package/dist/types/interface/api/type-message/api-error.js +3 -0
  51. package/dist/types/interface/api/type-message/api-error.js.map +1 -0
  52. package/dist/types/interface/api/type-message/base-paginate.d.ts +10 -0
  53. package/dist/types/interface/api/type-message/base-paginate.js +3 -0
  54. package/dist/types/interface/api/type-message/base-paginate.js.map +1 -0
  55. package/dist/types/interface/api/type-message/response.d.ts +5 -0
  56. package/dist/types/interface/api/type-message/response.js +3 -0
  57. package/dist/types/interface/api/type-message/response.js.map +1 -0
  58. package/dist/types/interface/index.d.ts +2 -0
  59. package/dist/types/interface/index.js +19 -0
  60. package/dist/types/interface/index.js.map +1 -0
  61. package/dist/types/interface/models/beam.dto.d.ts +70 -0
  62. package/dist/types/interface/models/beam.dto.js +3 -0
  63. package/dist/types/interface/models/beam.dto.js.map +1 -0
  64. package/dist/types/interface/models/content-share.dto.d.ts +15 -0
  65. package/dist/types/interface/models/content-share.dto.js +3 -0
  66. package/dist/types/interface/models/content-share.dto.js.map +1 -0
  67. package/dist/types/interface/models/index.d.ts +5 -0
  68. package/dist/types/interface/models/index.js +22 -0
  69. package/dist/types/interface/models/index.js.map +1 -0
  70. package/dist/types/interface/models/organization.dto.d.ts +11 -0
  71. package/dist/types/interface/models/organization.dto.js +3 -0
  72. package/dist/types/interface/models/organization.dto.js.map +1 -0
  73. package/dist/types/interface/models/project.dto.d.ts +12 -0
  74. package/dist/types/interface/models/project.dto.js +3 -0
  75. package/dist/types/interface/models/project.dto.js.map +1 -0
  76. package/dist/types/interface/models/user.dto.d.ts +11 -0
  77. package/dist/types/interface/models/user.dto.js +3 -0
  78. package/dist/types/interface/models/user.dto.js.map +1 -0
  79. package/dist/utils/enum.utils.d.ts +1 -0
  80. package/dist/utils/enum.utils.js +3 -0
  81. package/dist/utils/enum.utils.js.map +1 -0
  82. package/dist/utils/error.utils.d.ts +15 -0
  83. package/dist/utils/error.utils.js +25 -0
  84. package/dist/utils/error.utils.js.map +1 -0
  85. package/dist/utils/index.d.ts +2 -0
  86. package/dist/utils/index.js +19 -0
  87. package/dist/utils/index.js.map +1 -0
  88. package/package.json +58 -4
  89. package/src/api/beam.api.ts +325 -0
  90. package/src/api/index.ts +1 -0
  91. package/src/api/tests/beam.api.spec.ts +106 -0
  92. package/src/constants/beam.constants.ts +4 -0
  93. package/src/constants/index.ts +1 -0
  94. package/src/index.ts +167 -0
  95. package/src/types/enum/api-error.enum.ts +33 -0
  96. package/src/types/enum/beam.enum.ts +48 -0
  97. package/src/types/enum/content-share.enum.ts +37 -0
  98. package/src/types/enum/index.ts +3 -0
  99. package/src/types/index.ts +2 -0
  100. package/src/types/interface/api/index.ts +5 -0
  101. package/src/types/interface/api/requests/beam.request.ts +180 -0
  102. package/src/types/interface/api/requests/index.ts +1 -0
  103. package/src/types/interface/api/responses/beam.response.ts +162 -0
  104. package/src/types/interface/api/responses/index.ts +1 -0
  105. package/src/types/interface/api/type-message/api-error.ts +7 -0
  106. package/src/types/interface/api/type-message/base-paginate.ts +11 -0
  107. package/src/types/interface/api/type-message/response.ts +6 -0
  108. package/src/types/interface/index.ts +2 -0
  109. package/src/types/interface/models/beam.dto.ts +86 -0
  110. package/src/types/interface/models/content-share.dto.ts +20 -0
  111. package/src/types/interface/models/index.ts +5 -0
  112. package/src/types/interface/models/organization.dto.ts +21 -0
  113. package/src/types/interface/models/project.dto.ts +16 -0
  114. package/src/types/interface/models/user.dto.ts +19 -0
  115. package/src/types/tests/beam-management-types.spec.ts +38 -0
  116. package/src/types/tests/beam-share-enums.spec.ts +11 -0
  117. package/src/types/tests/beam.dto.spec.ts +61 -0
  118. package/src/types/tests/beam.request-response.spec.ts +43 -0
  119. package/src/utils/enum.utils.ts +1 -0
  120. package/src/utils/error.utils.ts +30 -0
  121. package/src/utils/index.ts +2 -0
  122. package/tsconfig.check.json +15 -0
  123. package/tsconfig.json +36 -0
@@ -0,0 +1,30 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.BeamDownloadKind = exports.BeamFileScanStatus = exports.BeamServeDenyReasonCode = exports.BeamVisibility = void 0;
4
+ var BeamVisibility;
5
+ (function (BeamVisibility) {
6
+ BeamVisibility["PUBLIC"] = "PUBLIC";
7
+ BeamVisibility["RESTRICTED"] = "RESTRICTED";
8
+ })(BeamVisibility || (exports.BeamVisibility = BeamVisibility = {}));
9
+ var BeamServeDenyReasonCode;
10
+ (function (BeamServeDenyReasonCode) {
11
+ BeamServeDenyReasonCode["NOT_FOUND"] = "not_found";
12
+ BeamServeDenyReasonCode["EXPIRED"] = "expired";
13
+ BeamServeDenyReasonCode["FORBIDDEN_VISIBILITY"] = "forbidden_visibility";
14
+ BeamServeDenyReasonCode["MAX_DOWNLOADS"] = "max_downloads";
15
+ BeamServeDenyReasonCode["SCAN_PENDING"] = "scan_pending";
16
+ })(BeamServeDenyReasonCode || (exports.BeamServeDenyReasonCode = BeamServeDenyReasonCode = {}));
17
+ var BeamFileScanStatus;
18
+ (function (BeamFileScanStatus) {
19
+ BeamFileScanStatus["PENDING_SCAN"] = "pending_scan";
20
+ BeamFileScanStatus["CLEAN"] = "clean";
21
+ BeamFileScanStatus["INFECTED"] = "infected";
22
+ BeamFileScanStatus["SKIPPED"] = "skipped";
23
+ BeamFileScanStatus["ERROR"] = "error";
24
+ })(BeamFileScanStatus || (exports.BeamFileScanStatus = BeamFileScanStatus = {}));
25
+ var BeamDownloadKind;
26
+ (function (BeamDownloadKind) {
27
+ BeamDownloadKind["FILE"] = "file";
28
+ BeamDownloadKind["ZIP"] = "zip";
29
+ })(BeamDownloadKind || (exports.BeamDownloadKind = BeamDownloadKind = {}));
30
+ //# sourceMappingURL=beam.enum.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"beam.enum.js","sourceRoot":"","sources":["../../../src/types/enum/beam.enum.ts"],"names":[],"mappings":";;;AAIA,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,mCAAiB,CAAA;IACjB,2CAAyB,CAAA;AAC3B,CAAC,EAHW,cAAc,8BAAd,cAAc,QAGzB;AASD,IAAY,uBAMX;AAND,WAAY,uBAAuB;IACjC,kDAAuB,CAAA;IACvB,8CAAmB,CAAA;IACnB,wEAA6C,CAAA;IAC7C,0DAA+B,CAAA;IAC/B,wDAA6B,CAAA;AAC/B,CAAC,EANW,uBAAuB,uCAAvB,uBAAuB,QAMlC;AAWD,IAAY,kBAMX;AAND,WAAY,kBAAkB;IAC5B,mDAA6B,CAAA;IAC7B,qCAAe,CAAA;IACf,2CAAqB,CAAA;IACrB,yCAAmB,CAAA;IACnB,qCAAe,CAAA;AACjB,CAAC,EANW,kBAAkB,kCAAlB,kBAAkB,QAM7B;AAKD,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,iCAAa,CAAA;IACb,+BAAW,CAAA;AACb,CAAC,EAHW,gBAAgB,gCAAhB,gBAAgB,QAG3B"}
@@ -0,0 +1,34 @@
1
+ export declare enum ShareableContentType {
2
+ DRAW = "draw",
3
+ BOARD = "board",
4
+ ATLAS = "atlas",
5
+ RETROSPECTIVE = "retrospective",
6
+ SHORT_LINK = "short_link",
7
+ CLOUD_FILE = "cloud_file",
8
+ CLOUD_FOLDER = "cloud_folder",
9
+ CLOUD_GALLERY = "cloud_gallery",
10
+ FORM = "form",
11
+ SPOTLIGHT_PROJECT = "spotlight_project",
12
+ EVENT = "event",
13
+ REPORT = "report",
14
+ PDF = "pdf",
15
+ BEAM = "beam"
16
+ }
17
+ export declare enum ShareTargetType {
18
+ USER = "USER",
19
+ TEAM = "TEAM",
20
+ ORGANIZATION = "ORGANIZATION",
21
+ PROJECT = "PROJECT",
22
+ LINK = "LINK"
23
+ }
24
+ export declare enum SharePermission {
25
+ VIEW = "VIEW",
26
+ EDIT = "EDIT",
27
+ MANAGE = "MANAGE"
28
+ }
29
+ export declare enum ContentShareScope {
30
+ ORGANIZATION = "ORGANIZATION",
31
+ ORG_USER = "ORG_USER",
32
+ ORG_TEAM = "ORG_TEAM",
33
+ ORG_PROJECT = "ORG_PROJECT"
34
+ }
@@ -0,0 +1,42 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ContentShareScope = exports.SharePermission = exports.ShareTargetType = exports.ShareableContentType = void 0;
4
+ var ShareableContentType;
5
+ (function (ShareableContentType) {
6
+ ShareableContentType["DRAW"] = "draw";
7
+ ShareableContentType["BOARD"] = "board";
8
+ ShareableContentType["ATLAS"] = "atlas";
9
+ ShareableContentType["RETROSPECTIVE"] = "retrospective";
10
+ ShareableContentType["SHORT_LINK"] = "short_link";
11
+ ShareableContentType["CLOUD_FILE"] = "cloud_file";
12
+ ShareableContentType["CLOUD_FOLDER"] = "cloud_folder";
13
+ ShareableContentType["CLOUD_GALLERY"] = "cloud_gallery";
14
+ ShareableContentType["FORM"] = "form";
15
+ ShareableContentType["SPOTLIGHT_PROJECT"] = "spotlight_project";
16
+ ShareableContentType["EVENT"] = "event";
17
+ ShareableContentType["REPORT"] = "report";
18
+ ShareableContentType["PDF"] = "pdf";
19
+ ShareableContentType["BEAM"] = "beam";
20
+ })(ShareableContentType || (exports.ShareableContentType = ShareableContentType = {}));
21
+ var ShareTargetType;
22
+ (function (ShareTargetType) {
23
+ ShareTargetType["USER"] = "USER";
24
+ ShareTargetType["TEAM"] = "TEAM";
25
+ ShareTargetType["ORGANIZATION"] = "ORGANIZATION";
26
+ ShareTargetType["PROJECT"] = "PROJECT";
27
+ ShareTargetType["LINK"] = "LINK";
28
+ })(ShareTargetType || (exports.ShareTargetType = ShareTargetType = {}));
29
+ var SharePermission;
30
+ (function (SharePermission) {
31
+ SharePermission["VIEW"] = "VIEW";
32
+ SharePermission["EDIT"] = "EDIT";
33
+ SharePermission["MANAGE"] = "MANAGE";
34
+ })(SharePermission || (exports.SharePermission = SharePermission = {}));
35
+ var ContentShareScope;
36
+ (function (ContentShareScope) {
37
+ ContentShareScope["ORGANIZATION"] = "ORGANIZATION";
38
+ ContentShareScope["ORG_USER"] = "ORG_USER";
39
+ ContentShareScope["ORG_TEAM"] = "ORG_TEAM";
40
+ ContentShareScope["ORG_PROJECT"] = "ORG_PROJECT";
41
+ })(ContentShareScope || (exports.ContentShareScope = ContentShareScope = {}));
42
+ //# sourceMappingURL=content-share.enum.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"content-share.enum.js","sourceRoot":"","sources":["../../../src/types/enum/content-share.enum.ts"],"names":[],"mappings":";;;AAAA,IAAY,oBAeX;AAfD,WAAY,oBAAoB;IAC9B,qCAAa,CAAA;IACb,uCAAe,CAAA;IACf,uCAAe,CAAA;IACf,uDAA+B,CAAA;IAC/B,iDAAyB,CAAA;IACzB,iDAAyB,CAAA;IACzB,qDAA6B,CAAA;IAC7B,uDAA+B,CAAA;IAC/B,qCAAa,CAAA;IACb,+DAAuC,CAAA;IACvC,uCAAe,CAAA;IACf,yCAAiB,CAAA;IACjB,mCAAW,CAAA;IACX,qCAAa,CAAA;AACf,CAAC,EAfW,oBAAoB,oCAApB,oBAAoB,QAe/B;AAED,IAAY,eAMX;AAND,WAAY,eAAe;IACzB,gCAAa,CAAA;IACb,gCAAa,CAAA;IACb,gDAA6B,CAAA;IAC7B,sCAAmB,CAAA;IACnB,gCAAa,CAAA;AACf,CAAC,EANW,eAAe,+BAAf,eAAe,QAM1B;AAED,IAAY,eAIX;AAJD,WAAY,eAAe;IACzB,gCAAa,CAAA;IACb,gCAAa,CAAA;IACb,oCAAiB,CAAA;AACnB,CAAC,EAJW,eAAe,+BAAf,eAAe,QAI1B;AAED,IAAY,iBAKX;AALD,WAAY,iBAAiB;IAC3B,kDAA6B,CAAA;IAC7B,0CAAqB,CAAA;IACrB,0CAAqB,CAAA;IACrB,gDAA2B,CAAA;AAC7B,CAAC,EALW,iBAAiB,iCAAjB,iBAAiB,QAK5B"}
@@ -0,0 +1,3 @@
1
+ export * from './api-error.enum';
2
+ export * from './content-share.enum';
3
+ export * from './beam.enum';
@@ -0,0 +1,20 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./api-error.enum"), exports);
18
+ __exportStar(require("./content-share.enum"), exports);
19
+ __exportStar(require("./beam.enum"), exports);
20
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/enum/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,uDAAqC;AACrC,8CAA4B"}
@@ -0,0 +1,2 @@
1
+ export * from './interface';
2
+ export * from './enum';
@@ -0,0 +1,19 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./interface"), exports);
18
+ __exportStar(require("./enum"), exports);
19
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,yCAAuB"}
@@ -0,0 +1,5 @@
1
+ export * from './requests';
2
+ export * from './responses';
3
+ export * from './type-message/response';
4
+ export * from './type-message/api-error';
5
+ export * from './type-message/base-paginate';
@@ -0,0 +1,22 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./requests"), exports);
18
+ __exportStar(require("./responses"), exports);
19
+ __exportStar(require("./type-message/response"), exports);
20
+ __exportStar(require("./type-message/api-error"), exports);
21
+ __exportStar(require("./type-message/base-paginate"), exports);
22
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/types/interface/api/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,8CAA4B;AAC5B,0DAAwC;AACxC,2DAAyC;AACzC,+DAA6C"}
@@ -0,0 +1,139 @@
1
+ import { ContentShareScope } from '../../../enum';
2
+ import { ShareTargetType, SharePermission } from '../../../enum/content-share.enum';
3
+ import { BeamVisibility } from '../../../enum/beam.enum';
4
+ import { QueryPaginate } from '../type-message/base-paginate';
5
+ export type IGetBeamParams = {
6
+ beamId: string;
7
+ };
8
+ export type IGetBeamBySlugParams = {
9
+ slug: string;
10
+ };
11
+ export type IPaginateBeamQuery = {
12
+ title?: string;
13
+ isActive?: boolean;
14
+ scope?: ContentShareScope;
15
+ teamId?: string;
16
+ projectId?: string;
17
+ adminView?: boolean;
18
+ sharedWithMe?: boolean;
19
+ } & QueryPaginate;
20
+ export type IPaginateProjectBeamParams = {
21
+ projectId: string;
22
+ };
23
+ export type IPaginateOrganizationBeamParams = {
24
+ organizationId: string;
25
+ };
26
+ export type ICreateBeamBody = {
27
+ title?: string;
28
+ message?: string;
29
+ visibility?: BeamVisibility;
30
+ expiresInDays?: number;
31
+ password?: string;
32
+ maxDownloads?: number;
33
+ recipients?: {
34
+ email: string;
35
+ locale?: string;
36
+ }[];
37
+ };
38
+ export type ICreateBeamPublicBody = {
39
+ title?: string;
40
+ message?: string;
41
+ visibility?: BeamVisibility;
42
+ password?: string;
43
+ expiresInDays?: number;
44
+ maxDownloads?: number;
45
+ recipients?: {
46
+ email: string;
47
+ locale?: string;
48
+ }[];
49
+ };
50
+ export interface IAddBeamFilesParams {
51
+ beamId: string;
52
+ }
53
+ export interface IAddBeamFilesBody {
54
+ files: {
55
+ storageFileId: string;
56
+ }[];
57
+ }
58
+ export interface IImportCloudBeamFilesParams {
59
+ beamId: string;
60
+ }
61
+ export interface IImportCloudBeamFilesBody {
62
+ cloudFileIds: string[];
63
+ }
64
+ export interface IFinalizeBeamParams {
65
+ beamId: string;
66
+ }
67
+ export type IFinalizeBeamBody = Record<string, never>;
68
+ export type ICreateForOrganizationBeamParams = {
69
+ organizationId: string;
70
+ };
71
+ export type IUpdateBeamParams = {
72
+ beamId: string;
73
+ };
74
+ export type IUpdateBeamBody = {
75
+ title?: string;
76
+ message?: string;
77
+ visibility?: BeamVisibility;
78
+ isActive?: boolean;
79
+ expiresAt?: Date | null;
80
+ maxDownloads?: number | null;
81
+ };
82
+ export type IDeleteBeamParams = {
83
+ beamId: string;
84
+ };
85
+ export interface IUnlockBeamPublicParams {
86
+ slug: string;
87
+ }
88
+ export interface IUnlockBeamPublicBody {
89
+ password: string;
90
+ }
91
+ export interface IRenewBeamParams {
92
+ beamId: string;
93
+ days?: number;
94
+ }
95
+ export interface IRenewBeamBody {
96
+ days?: number;
97
+ }
98
+ export interface IReactivateBeamParams {
99
+ beamId: string;
100
+ days?: number;
101
+ }
102
+ export interface IReactivateBeamBody {
103
+ days?: number;
104
+ }
105
+ export interface ICreateBeamShareParams {
106
+ beamId: string;
107
+ }
108
+ export interface ICreateBeamShareBody {
109
+ targetType: ShareTargetType;
110
+ targetId?: string | null;
111
+ permission: SharePermission;
112
+ }
113
+ export interface IListBeamSharesParams {
114
+ beamId: string;
115
+ }
116
+ export interface IRevokeBeamShareParams {
117
+ beamId: string;
118
+ shareId: string;
119
+ }
120
+ export interface IAddRecipientsBeamParams {
121
+ beamId: string;
122
+ }
123
+ export interface IAddRecipientsBeamBody {
124
+ recipients: {
125
+ email: string;
126
+ locale?: string | null;
127
+ }[];
128
+ }
129
+ export interface IListRecipientsBeamParams {
130
+ beamId: string;
131
+ }
132
+ export interface IGetBeamStatsParams {
133
+ beamId: string;
134
+ }
135
+ export interface IGetBeamStatsQuery {
136
+ days?: number;
137
+ limit?: number;
138
+ offset?: number;
139
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=beam.request.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"beam.request.js","sourceRoot":"","sources":["../../../../../src/types/interface/api/requests/beam.request.ts"],"names":[],"mappings":""}
@@ -0,0 +1 @@
1
+ export * from './beam.request';
@@ -0,0 +1,18 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./beam.request"), exports);
18
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/types/interface/api/requests/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,iDAA+B"}
@@ -0,0 +1,115 @@
1
+ import { BasePaginate } from '../type-message/base-paginate';
2
+ import { IResponse } from '../type-message/response';
3
+ import { IBeamTransfer, IBeamFile, IBeamRecipient } from '../../models/beam.dto';
4
+ import { IContentShare } from '../../models/content-share.dto';
5
+ import { BeamVisibility, BeamServeDenyReasonCode, BeamDownloadKind, BeamFileScanStatus } from '../../../enum/beam.enum';
6
+ export interface IGetBeamData {
7
+ beamTransfer: IBeamTransfer;
8
+ }
9
+ export type IGetBeamResponse = IResponse<IGetBeamData>;
10
+ export type IPaginateBeamResponse = IResponse<BasePaginate<IBeamTransfer>>;
11
+ export interface ICreateBeamData {
12
+ beamTransfer: IBeamTransfer;
13
+ }
14
+ export type ICreateBeamResponse = IResponse<ICreateBeamData>;
15
+ export interface IUpdateBeamData {
16
+ beamTransfer: IBeamTransfer;
17
+ }
18
+ export type IUpdateBeamResponse = IResponse<IUpdateBeamData>;
19
+ export interface IDeleteBeamData {
20
+ }
21
+ export type IDeleteBeamResponse = IResponse<IDeleteBeamData>;
22
+ export type IAddBeamFilesResponse = IResponse<{
23
+ files: IBeamFile[];
24
+ }>;
25
+ export interface IFinalizeBeamData {
26
+ slug: string;
27
+ viewUrl: string;
28
+ manageToken: string;
29
+ manageUrl: string;
30
+ expiresAt: string;
31
+ }
32
+ export type IFinalizeBeamResponse = IResponse<IFinalizeBeamData>;
33
+ export interface IBeamPublicFile {
34
+ id: string;
35
+ name: string;
36
+ sizeOctet: number;
37
+ mimeType: string | null;
38
+ isImage: boolean;
39
+ hasThumbnail: boolean;
40
+ width: number | null;
41
+ height: number | null;
42
+ scanStatus: BeamFileScanStatus;
43
+ }
44
+ export interface IBeamPublicView {
45
+ slug: string;
46
+ title: string | null;
47
+ message: string | null;
48
+ visibility: BeamVisibility;
49
+ hasPassword: boolean;
50
+ isLocked: boolean;
51
+ expiresAt: string | null;
52
+ fileCount: number;
53
+ totalSizeOctet: number;
54
+ downloadCount: number;
55
+ files: IBeamPublicFile[];
56
+ }
57
+ export type IGetBeamPublicResponse = IResponse<{
58
+ transfer: IBeamPublicView | null;
59
+ reason?: BeamServeDenyReasonCode;
60
+ }>;
61
+ export interface IUnlockBeamPublicData {
62
+ unlockToken: string;
63
+ expiresIn: number;
64
+ }
65
+ export type IUnlockBeamPublicResponse = IResponse<IUnlockBeamPublicData>;
66
+ export interface IRenewBeamData {
67
+ beamTransfer: IBeamTransfer;
68
+ }
69
+ export type IRenewBeamResponse = IResponse<IRenewBeamData>;
70
+ export interface IReactivateBeamData {
71
+ beamTransfer: IBeamTransfer;
72
+ }
73
+ export type IReactivateBeamResponse = IResponse<IReactivateBeamData>;
74
+ export interface ICreateBeamShareData {
75
+ contentShare: IContentShare;
76
+ }
77
+ export type ICreateBeamShareResponse = IResponse<ICreateBeamShareData>;
78
+ export interface IListBeamSharesData {
79
+ contentShares: IContentShare[];
80
+ }
81
+ export type IListBeamSharesResponse = IResponse<IListBeamSharesData>;
82
+ export interface IRevokeBeamShareData {
83
+ }
84
+ export type IRevokeBeamShareResponse = IResponse<IRevokeBeamShareData>;
85
+ export interface IAddRecipientsBeamData {
86
+ enqueued: number;
87
+ rateLimited: number;
88
+ }
89
+ export type IAddRecipientsBeamResponse = IResponse<IAddRecipientsBeamData>;
90
+ export interface IListRecipientsBeamData {
91
+ recipients: IBeamRecipient[];
92
+ }
93
+ export type IListRecipientsBeamResponse = IResponse<IListRecipientsBeamData>;
94
+ export interface IBeamStatsDayBucket {
95
+ day: string;
96
+ count: number;
97
+ zipCount: number;
98
+ }
99
+ export interface IBeamStatsRecentEvent {
100
+ downloadedAt: string;
101
+ kind: BeamDownloadKind;
102
+ fileId: string | null;
103
+ fileName: string | null;
104
+ userId: string | null;
105
+ ipHash: string;
106
+ }
107
+ export interface IGetBeamStatsData {
108
+ byDay: IBeamStatsDayBucket[];
109
+ recent: IBeamStatsRecentEvent[];
110
+ totals: {
111
+ downloadCount: number;
112
+ lastDownloadedAt: string | null;
113
+ };
114
+ }
115
+ export type IGetBeamStatsResponse = IResponse<IGetBeamStatsData>;
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=beam.response.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"beam.response.js","sourceRoot":"","sources":["../../../../../src/types/interface/api/responses/beam.response.ts"],"names":[],"mappings":""}
@@ -0,0 +1 @@
1
+ export * from './beam.response';
@@ -0,0 +1,18 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./beam.response"), exports);
18
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/types/interface/api/responses/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kDAAgC"}
@@ -0,0 +1,6 @@
1
+ import { Code, ErrorType } from '../../../enum';
2
+ export interface IApiError {
3
+ code: Code;
4
+ type: ErrorType;
5
+ message?: string;
6
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=api-error.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"api-error.js","sourceRoot":"","sources":["../../../../../src/types/interface/api/type-message/api-error.ts"],"names":[],"mappings":""}
@@ -0,0 +1,10 @@
1
+ export interface BasePaginate<T> {
2
+ maxPages: number;
3
+ currentPage: number;
4
+ data: T[];
5
+ totalItems: number;
6
+ }
7
+ export interface QueryPaginate {
8
+ page?: number;
9
+ limit?: number;
10
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=base-paginate.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"base-paginate.js","sourceRoot":"","sources":["../../../../../src/types/interface/api/type-message/base-paginate.ts"],"names":[],"mappings":""}
@@ -0,0 +1,5 @@
1
+ import { IApiError } from './api-error';
2
+ export interface IResponse<T> {
3
+ data: T;
4
+ error?: IApiError | Error;
5
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=response.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"response.js","sourceRoot":"","sources":["../../../../../src/types/interface/api/type-message/response.ts"],"names":[],"mappings":""}
@@ -0,0 +1,2 @@
1
+ export * from './models';
2
+ export * from './api';
@@ -0,0 +1,19 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./models"), exports);
18
+ __exportStar(require("./api"), exports);
19
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/interface/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,wCAAsB"}