@abyss-project/tools 3.2.0 → 3.3.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 (17) hide show
  1. package/dist/types/enum/index.d.ts +1 -0
  2. package/dist/types/enum/index.js +1 -0
  3. package/dist/types/enum/index.js.map +1 -1
  4. package/dist/types/enum/tool-document-sort.enum.d.ts +9 -0
  5. package/dist/types/enum/tool-document-sort.enum.js +15 -0
  6. package/dist/types/enum/tool-document-sort.enum.js.map +1 -0
  7. package/dist/types/interface/api/requests/atlas.request.d.ts +3 -1
  8. package/dist/types/interface/api/requests/board.request.d.ts +3 -1
  9. package/dist/types/interface/api/requests/draw.request.d.ts +3 -1
  10. package/dist/types/interface/api/requests/retrospective.request.d.ts +3 -1
  11. package/package.json +1 -1
  12. package/src/types/enum/index.ts +1 -0
  13. package/src/types/enum/tool-document-sort.enum.ts +11 -0
  14. package/src/types/interface/api/requests/atlas.request.ts +3 -1
  15. package/src/types/interface/api/requests/board.request.ts +3 -1
  16. package/src/types/interface/api/requests/draw.request.ts +3 -1
  17. package/src/types/interface/api/requests/retrospective.request.ts +3 -1
package/dist/types/enum/index.d.ts CHANGED
@@ -16,3 +16,4 @@ export * from './combine-strategy.enum';
16
16
  export * from './extraction-step-status.enum';
17
17
  export * from './probe-scan.enum';
18
18
  export * from './file-scan-status.enum';
19
+ export * from './tool-document-sort.enum';
package/dist/types/enum/index.js CHANGED
@@ -32,4 +32,5 @@ __exportStar(require("./combine-strategy.enum"), exports);
32
32
  __exportStar(require("./extraction-step-status.enum"), exports);
33
33
  __exportStar(require("./probe-scan.enum"), exports);
34
34
  __exportStar(require("./file-scan-status.enum"), exports);
35
+ __exportStar(require("./tool-document-sort.enum"), exports);
35
36
  //# sourceMappingURL=index.js.map
package/dist/types/enum/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/enum/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,wDAAsC;AACtC,2DAAyC;AACzC,uDAAqC;AACrC,8CAA4B;AAC5B,uDAAqC;AACrC,uDAAqC;AACrC,kDAAgC;AAChC,4DAA0C;AAC1C,2DAAyC;AACzC,8DAA4C;AAC5C,wEAAsD;AACtD,uDAAqC;AACrC,0DAAwC;AACxC,0DAAwC;AACxC,gEAA8C;AAC9C,oDAAkC;AAClC,0DAAwC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/enum/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,wDAAsC;AACtC,2DAAyC;AACzC,uDAAqC;AACrC,8CAA4B;AAC5B,uDAAqC;AACrC,uDAAqC;AACrC,kDAAgC;AAChC,4DAA0C;AAC1C,2DAAyC;AACzC,8DAA4C;AAC5C,wEAAsD;AACtD,uDAAqC;AACrC,0DAAwC;AACxC,0DAAwC;AACxC,gEAA8C;AAC9C,oDAAkC;AAClC,0DAAwC;AACxC,4DAA0C"}
package/dist/types/enum/tool-document-sort.enum.d.ts ADDED
@@ -0,0 +1,9 @@
1
+ export declare enum ToolDocumentSortBy {
2
+ UPDATED_AT = "updatedAt",
3
+ CREATED_AT = "createdAt",
4
+ TITLE = "title"
5
+ }
6
+ export declare enum SortDirection {
7
+ ASC = "ASC",
8
+ DESC = "DESC"
9
+ }
package/dist/types/enum/tool-document-sort.enum.js ADDED
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.SortDirection = exports.ToolDocumentSortBy = void 0;
4
+ var ToolDocumentSortBy;
5
+ (function (ToolDocumentSortBy) {
6
+ ToolDocumentSortBy["UPDATED_AT"] = "updatedAt";
7
+ ToolDocumentSortBy["CREATED_AT"] = "createdAt";
8
+ ToolDocumentSortBy["TITLE"] = "title";
9
+ })(ToolDocumentSortBy || (exports.ToolDocumentSortBy = ToolDocumentSortBy = {}));
10
+ var SortDirection;
11
+ (function (SortDirection) {
12
+ SortDirection["ASC"] = "ASC";
13
+ SortDirection["DESC"] = "DESC";
14
+ })(SortDirection || (exports.SortDirection = SortDirection = {}));
15
+ //# sourceMappingURL=tool-document-sort.enum.js.map
package/dist/types/enum/tool-document-sort.enum.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"tool-document-sort.enum.js","sourceRoot":"","sources":["../../../src/types/enum/tool-document-sort.enum.ts"],"names":[],"mappings":";;;AACA,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC5B,8CAAwB,CAAA;IACxB,8CAAwB,CAAA;IACxB,qCAAe,CAAA;AACjB,CAAC,EAJW,kBAAkB,kCAAlB,kBAAkB,QAI7B;AAED,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,4BAAW,CAAA;IACX,8BAAa,CAAA;AACf,CAAC,EAHW,aAAa,6BAAb,aAAa,QAGxB"}
package/dist/types/interface/api/requests/atlas.request.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { ContentShareScope } from '../../../enum';
1
+ import { ContentShareScope, SortDirection, ToolDocumentSortBy } from '../../../enum';
2
2
  import { QueryPaginate } from '../type-message/base-paginate';
3
3
  export interface IGetAtlasParams {
4
4
  atlasId: string;
@@ -13,6 +13,8 @@ export type IPaginateAtlasQuery = {
13
13
  projectId?: string;
14
14
  adminView?: boolean;
15
15
  sharedWithMe?: boolean;
16
+ sortBy?: ToolDocumentSortBy;
17
+ sortDirection?: SortDirection;
16
18
  } & QueryPaginate;
17
19
  export interface ICreateForOrganizationAtlasParams {
18
20
  organizationId: string;
package/dist/types/interface/api/requests/board.request.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { ContentShareScope } from '../../../enum';
1
+ import { ContentShareScope, SortDirection, ToolDocumentSortBy } from '../../../enum';
2
2
  import { QueryPaginate } from '../type-message/base-paginate';
3
3
  export type ICreateForOrganizationBoardParams = {
4
4
  organizationId: string;
@@ -41,6 +41,8 @@ export type IPaginateBoardQuery = {
41
41
  projectId?: string;
42
42
  adminView?: boolean;
43
43
  sharedWithMe?: boolean;
44
+ sortBy?: ToolDocumentSortBy;
45
+ sortDirection?: SortDirection;
44
46
  } & QueryPaginate;
45
47
  export type IPaginateOrganizationBoardParams = {
46
48
  organizationId: string;
package/dist/types/interface/api/requests/draw.request.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { ContentShareScope } from '../../../enum';
1
+ import { ContentShareScope, SortDirection, ToolDocumentSortBy } from '../../../enum';
2
2
  import { QueryPaginate } from '../type-message/base-paginate';
3
3
  export type ICreateForOrganizationDrawParams = {
4
4
  organizationId: string;
@@ -29,6 +29,8 @@ export type IPaginateDrawQuery = {
29
29
  projectId?: string;
30
30
  adminView?: boolean;
31
31
  sharedWithMe?: boolean;
32
+ sortBy?: ToolDocumentSortBy;
33
+ sortDirection?: SortDirection;
32
34
  } & QueryPaginate;
33
35
  export type IPaginateProjectDrawParams = {
34
36
  projectId: string;
package/dist/types/interface/api/requests/retrospective.request.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { ContentShareScope } from '../../../enum';
1
+ import { ContentShareScope, SortDirection, ToolDocumentSortBy } from '../../../enum';
2
2
  import { QueryPaginate } from '../type-message/base-paginate';
3
3
  export interface IGetRetrospectiveParams {
4
4
  retrospectiveId: string;
@@ -14,6 +14,8 @@ export type IPaginateRetrospectiveQuery = {
14
14
  projectId?: string;
15
15
  adminView?: boolean;
16
16
  sharedWithMe?: boolean;
17
+ sortBy?: ToolDocumentSortBy;
18
+ sortDirection?: SortDirection;
17
19
  } & QueryPaginate;
18
20
  export interface ICreateForOrganizationRetrospectiveParams {
19
21
  organizationId: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@abyss-project/tools",
3
- "version": "3.2.0",
3
+ "version": "3.3.0",
4
4
  "description": "Core package to interact with Abyss-Project Tools",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
package/src/types/enum/index.ts CHANGED
@@ -16,3 +16,4 @@ export * from './combine-strategy.enum';
16
16
  export * from './extraction-step-status.enum';
17
17
  export * from './probe-scan.enum';
18
18
  export * from './file-scan-status.enum';
19
+ export * from './tool-document-sort.enum';
package/src/types/enum/tool-document-sort.enum.ts ADDED
@@ -0,0 +1,11 @@
1
+ // Sort criteria accepted by the paginated document lists of the tools (boards, atlas, draws, retrospectives).
2
+ export enum ToolDocumentSortBy {
3
+ UPDATED_AT = 'updatedAt',
4
+ CREATED_AT = 'createdAt',
5
+ TITLE = 'title',
6
+ }
7
+
8
+ export enum SortDirection {
9
+ ASC = 'ASC',
10
+ DESC = 'DESC',
11
+ }
package/src/types/interface/api/requests/atlas.request.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { ContentShareScope } from '../../../enum';
1
+ import { ContentShareScope, SortDirection, ToolDocumentSortBy } from '../../../enum';
2
2
  import { QueryPaginate } from '../type-message/base-paginate';
3
3
 
4
4
  export interface IGetAtlasParams {
@@ -16,6 +16,8 @@ export type IPaginateAtlasQuery = {
16
16
  projectId?: string;
17
17
  adminView?: boolean;
18
18
  sharedWithMe?: boolean;
19
+ sortBy?: ToolDocumentSortBy;
20
+ sortDirection?: SortDirection;
19
21
  } & QueryPaginate;
20
22
 
21
23
  export interface ICreateForOrganizationAtlasParams {
package/src/types/interface/api/requests/board.request.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { ContentShareScope } from '../../../enum';
1
+ import { ContentShareScope, SortDirection, ToolDocumentSortBy } from '../../../enum';
2
2
  import { QueryPaginate } from '../type-message/base-paginate';
3
3
 
4
4
  export type ICreateForOrganizationBoardParams = {
@@ -50,6 +50,8 @@ export type IPaginateBoardQuery = {
50
50
  projectId?: string;
51
51
  adminView?: boolean;
52
52
  sharedWithMe?: boolean;
53
+ sortBy?: ToolDocumentSortBy;
54
+ sortDirection?: SortDirection;
53
55
  } & QueryPaginate;
54
56
 
55
57
  export type IPaginateOrganizationBoardParams = {
package/src/types/interface/api/requests/draw.request.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { ContentShareScope } from '../../../enum';
1
+ import { ContentShareScope, SortDirection, ToolDocumentSortBy } from '../../../enum';
2
2
  import { QueryPaginate } from '../type-message/base-paginate';
3
3
 
4
4
  export type ICreateForOrganizationDrawParams = {
@@ -34,6 +34,8 @@ export type IPaginateDrawQuery = {
34
34
  projectId?: string;
35
35
  adminView?: boolean;
36
36
  sharedWithMe?: boolean;
37
+ sortBy?: ToolDocumentSortBy;
38
+ sortDirection?: SortDirection;
37
39
  } & QueryPaginate;
38
40
 
39
41
  export type IPaginateProjectDrawParams = {
package/src/types/interface/api/requests/retrospective.request.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { ContentShareScope } from '../../../enum';
1
+ import { ContentShareScope, SortDirection, ToolDocumentSortBy } from '../../../enum';
2
2
  import { QueryPaginate } from '../type-message/base-paginate';
3
3
 
4
4
  export interface IGetRetrospectiveParams {
@@ -17,6 +17,8 @@ export type IPaginateRetrospectiveQuery = {
17
17
  projectId?: string;
18
18
  adminView?: boolean;
19
19
  sharedWithMe?: boolean;
20
+ sortBy?: ToolDocumentSortBy;
21
+ sortDirection?: SortDirection;
20
22
  } & QueryPaginate;
21
23
 
22
24
  export interface ICreateForOrganizationRetrospectiveParams {