@pitcher/js-api 1.21.0-beta.14 → 1.21.0-beta.15

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 (98) hide show
  1. package/js-api.esm.js +101 -8
  2. package/js-api.esm.js.map +1 -1
  3. package/js-api.umd.min.js +10 -10
  4. package/js-api.umd.min.js.map +1 -1
  5. package/lib/apps/browser/stores/api.d.ts +164 -104
  6. package/lib/apps/browser/stores/app.d.ts +6 -1
  7. package/lib/apps/browser/stores/upload.d.ts +30 -30
  8. package/lib/apps/canvas-builder/composables/useCanvas.d.ts +508 -421
  9. package/lib/apps/canvas-builder/composables/useCanvasHistory.d.ts +86 -74
  10. package/lib/apps/canvas-builder/composables/useCanvasTheme.d.ts +18 -20
  11. package/lib/apps/canvas-builder/composables/useContentSelector.d.ts +5 -5
  12. package/lib/apps/canvas-builder/composables/useInstalledEmbeddables.d.ts +4 -1
  13. package/lib/apps/canvas-builder/types/canvas.d.ts +1 -0
  14. package/lib/apps/canvas-builder/util/canvas.util.d.ts +1 -0
  15. package/lib/apps/content-selector/stores/app.d.ts +8 -1
  16. package/lib/components/CFileViewer/CFileViewer.use.d.ts +2 -4
  17. package/lib/components/CFileViewer/CFileViewerFullScreen.use.d.ts +1 -1
  18. package/lib/components/filters/filter.util.d.ts +1 -1
  19. package/lib/composables/instanceTagsActions.use.d.ts +14 -0
  20. package/lib/composables/recentFiles.use.d.ts +1 -1
  21. package/lib/composables/suggestedTags.use.d.ts +3 -0
  22. package/lib/composables/tableColumnsSettings.use.d.ts +25 -0
  23. package/lib/composables/useCanvasOverlay.d.ts +4 -4
  24. package/lib/composables/useConfirmation.d.ts +1 -0
  25. package/lib/composables/useElementHeightResize.d.ts +5 -0
  26. package/lib/composables/useFiles.d.ts +11 -0
  27. package/lib/constants/pitcherSettings.const.d.ts +4 -0
  28. package/lib/main.lib.d.ts +23 -20
  29. package/lib/sdk/api/HighLevelApi.d.ts +95 -2
  30. package/lib/sdk/api/modules/admin/canvas.admin.d.ts +4 -8
  31. package/lib/sdk/api/modules/admin/env.admin.d.ts +3 -2
  32. package/lib/sdk/api/modules/admin/files.admin.d.ts +10 -10
  33. package/lib/sdk/api/modules/admin/index.d.ts +13 -0
  34. package/lib/sdk/api/modules/admin/metadataTemplates.admin.d.ts +1 -2
  35. package/lib/sdk/api/modules/admin/types.admin.d.ts +93 -0
  36. package/lib/sdk/api/modules/canvas.d.ts +2 -4
  37. package/lib/sdk/api/modules/dsr/env.dsr.d.ts +4 -3
  38. package/lib/sdk/api/modules/dsr/index.d.ts +7 -0
  39. package/lib/sdk/api/modules/dsr/loading.dsr.d.ts +6 -0
  40. package/lib/sdk/api/modules/env.d.ts +16 -0
  41. package/lib/sdk/api/modules/favorites.d.ts +9 -0
  42. package/lib/sdk/api/modules/feedback.d.ts +3 -0
  43. package/lib/sdk/api/modules/files.d.ts +1 -2
  44. package/lib/sdk/api/modules/folders.d.ts +29 -0
  45. package/lib/sdk/api/modules/open.d.ts +6 -0
  46. package/lib/sdk/api/modules/sync.d.ts +1 -2
  47. package/lib/sdk/api/modules/ui/app-errors.ui.d.ts +12 -0
  48. package/lib/sdk/api/modules/ui/canvas.ui.d.ts +53 -0
  49. package/lib/sdk/api/modules/ui/content.ui.d.ts +36 -3
  50. package/lib/sdk/api/modules/ui/index.d.ts +107 -0
  51. package/lib/sdk/api/modules/ui/loading.ui.d.ts +15 -0
  52. package/lib/sdk/api/modules/ui/location.ui.d.ts +17 -0
  53. package/lib/sdk/api/modules/ui/post-call.ui.d.ts +25 -0
  54. package/lib/sdk/api/modules/ui/types.ui.d.ts +59 -0
  55. package/lib/sdk/api/modules/users.d.ts +4 -0
  56. package/lib/sdk/interfaces.d.ts +117 -0
  57. package/lib/sdk/main.d.ts +67 -6
  58. package/lib/sdk/payload.types.d.ts +132 -0
  59. package/lib/types/app.d.ts +11 -0
  60. package/lib/types/filter.d.ts +5 -0
  61. package/lib/types/instanceSettings.types.d.ts +8 -2
  62. package/lib/types/launchDarkly.types.d.ts +4 -4
  63. package/lib/types/organizationSettings.types.d.ts +4 -0
  64. package/lib/types/recentFiles.types.d.ts +4 -1
  65. package/lib/types/users.d.ts +13 -0
  66. package/lib/util/fullscreen.util.d.ts +1 -1
  67. package/lib/util/string.d.ts +1 -0
  68. package/package.json +1 -1
  69. package/types/openapi/index.d.ts +4 -5
  70. package/types/openapi/models/AccessTypeEnum.d.ts +3 -1
  71. package/types/openapi/models/Canvas.d.ts +1 -0
  72. package/types/openapi/models/CanvasCreate.d.ts +1 -0
  73. package/types/openapi/models/CanvasCreateRequest.d.ts +1 -0
  74. package/types/openapi/models/CanvasRetrieve.d.ts +1 -0
  75. package/types/openapi/models/CanvasUpdate.d.ts +1 -0
  76. package/types/openapi/models/CanvasUpdateRequest.d.ts +1 -0
  77. package/types/openapi/models/DeletedCanvas.d.ts +1 -0
  78. package/types/openapi/models/DeletedFolder.d.ts +3 -3
  79. package/types/openapi/models/Folder.d.ts +3 -3
  80. package/types/openapi/models/FolderCanvas.d.ts +11 -0
  81. package/types/openapi/models/FolderCreate.d.ts +7 -7
  82. package/types/openapi/models/FolderCreateRequest.d.ts +3 -2
  83. package/types/openapi/models/FolderFile.d.ts +2 -0
  84. package/types/openapi/models/FolderFolder.d.ts +4 -2
  85. package/types/openapi/models/FolderRetrieve.d.ts +7 -8
  86. package/types/openapi/models/FolderRule.d.ts +7 -0
  87. package/types/openapi/models/FolderRuleRequest.d.ts +7 -0
  88. package/types/openapi/models/FolderUpdate.d.ts +7 -8
  89. package/types/openapi/models/FolderUpdateRequest.d.ts +2 -0
  90. package/types/openapi/models/OperatorEnum.d.ts +64 -0
  91. package/types/openapi/models/PatchedCanvasUpdateRequest.d.ts +1 -0
  92. package/types/openapi/models/PatchedFolderUpdateRequest.d.ts +2 -0
  93. package/lib/composables/useDetailsView.d.ts +0 -19
  94. package/types/openapi/models/FileRequest.d.ts +0 -16
  95. package/types/openapi/models/PSPDFKitAuthPayload.d.ts +0 -3
  96. package/types/openapi/models/PSPDFKitAuthPayloadRequest.d.ts +0 -3
  97. package/types/openapi/models/PSPDFKitToken.d.ts +0 -7
  98. package/types/openapi/models/PSPDFKitTokenRequest.d.ts +0 -3
@@ -0,0 +1,11 @@
1
+ import { MiniUser } from './MiniUser';
2
+
3
+ export type FolderCanvas = {
4
+ readonly id: string;
5
+ name: string;
6
+ thumbnail_url?: string | null;
7
+ readonly tags: Array<string>;
8
+ readonly created_by: MiniUser;
9
+ readonly owned_by: MiniUser;
10
+ readonly modified_at: string;
11
+ };
@@ -1,6 +1,8 @@
1
1
  import { AccessTypeEnum } from './AccessTypeEnum';
2
+ import { FolderCanvas } from './FolderCanvas';
2
3
  import { FolderFile } from './FolderFile';
3
4
  import { FolderFolder } from './FolderFolder';
5
+ import { FolderRule } from './FolderRule';
4
6
  import { MiniUser } from './MiniUser';
5
7
 
6
8
  /**
@@ -14,17 +16,15 @@ import { MiniUser } from './MiniUser';
14
16
  export type FolderCreate = {
15
17
  id?: string;
16
18
  name: string;
19
+ readonly content_type: string;
17
20
  access_type?: AccessTypeEnum;
18
- readonly materialized_path: string;
19
- readonly depth: number;
21
+ rules?: Array<FolderRule>;
20
22
  readonly owned_by: MiniUser;
21
- readonly files: Array<FolderFile>;
22
- readonly files_count: number;
23
- readonly file_thumbnail_urls: Array<string>;
23
+ readonly path: Array<FolderFolder>;
24
24
  readonly thumbnail_url: string | null;
25
25
  readonly folders: Array<FolderFolder>;
26
- readonly folders_count: number;
27
- readonly path: Array<FolderFolder>;
26
+ readonly files: Array<FolderFile>;
27
+ readonly canvases: Array<FolderCanvas>;
28
28
  readonly created_at: string;
29
29
  readonly created_by: MiniUser;
30
30
  readonly modified_at: string;
@@ -1,4 +1,5 @@
1
1
  import { AccessTypeEnum } from './AccessTypeEnum';
2
+ import { FolderRuleRequest } from './FolderRuleRequest';
2
3
 
3
4
  /**
4
5
  * Serializer class for creating folder records.
@@ -11,9 +12,9 @@ import { AccessTypeEnum } from './AccessTypeEnum';
11
12
  export type FolderCreateRequest = {
12
13
  id?: string;
13
14
  name: string;
14
- instance_id: string;
15
15
  access_type?: AccessTypeEnum;
16
- parent_folder_id?: string;
16
+ rules?: Array<FolderRuleRequest>;
17
+ parent_folder_id: string;
17
18
  thumbnail_id?: string;
18
19
  owned_by_id?: number | null;
19
20
  };
@@ -1,4 +1,5 @@
1
1
  import { FileContentTypeEnum } from './FileContentTypeEnum';
2
+ import { FilePermission } from './FilePermission';
2
3
  import { FileStatusEnum } from './FileStatusEnum';
3
4
  import { MiniUser } from './MiniUser';
4
5
 
@@ -9,6 +10,7 @@ export type FolderFile = {
9
10
  readonly content_type: FileContentTypeEnum;
10
11
  readonly thumbnail_url: string;
11
12
  readonly tags: Array<string>;
13
+ permissions?: FilePermission;
12
14
  readonly created_by: MiniUser;
13
15
  readonly owned_by: MiniUser;
14
16
  readonly modified_at: string;
@@ -1,8 +1,10 @@
1
1
  export type FolderFolder = {
2
2
  readonly id: string;
3
3
  name: string;
4
- readonly files_count: number;
5
- readonly folders_count: number;
6
4
  readonly thumbnail_url: string | null;
5
+ readonly folders_count: number;
6
+ readonly files_count: number;
7
7
  readonly file_thumbnail_urls: Array<string>;
8
+ readonly canvases_count: number;
9
+ readonly canvas_thumbnail_urls: Array<string>;
8
10
  };
@@ -1,23 +1,22 @@
1
1
  import { AccessTypeEnum } from './AccessTypeEnum';
2
+ import { FolderCanvas } from './FolderCanvas';
2
3
  import { FolderFile } from './FolderFile';
3
4
  import { FolderFolder } from './FolderFolder';
5
+ import { FolderRule } from './FolderRule';
4
6
  import { MiniUser } from './MiniUser';
5
7
 
6
8
  export type FolderRetrieve = {
7
9
  readonly id: string;
8
10
  name: string;
9
- readonly instance_id: string;
11
+ readonly content_type: string;
10
12
  access_type?: AccessTypeEnum;
11
- readonly materialized_path: string;
12
- readonly depth: number;
13
+ rules?: Array<FolderRule>;
13
14
  readonly owned_by: MiniUser;
14
- readonly files: Array<FolderFile>;
15
- readonly files_count: number;
16
- readonly file_thumbnail_urls: Array<string>;
15
+ readonly path: Array<FolderFolder>;
17
16
  readonly thumbnail_url: string | null;
18
17
  readonly folders: Array<FolderFolder>;
19
- readonly folders_count: number;
20
- readonly path: Array<FolderFolder>;
18
+ readonly files: Array<FolderFile>;
19
+ readonly canvases: Array<FolderCanvas>;
21
20
  readonly created_at: string;
22
21
  readonly created_by: MiniUser;
23
22
  readonly modified_at: string;
@@ -0,0 +1,7 @@
1
+ import { OperatorEnum } from './OperatorEnum';
2
+
3
+ export type FolderRule = {
4
+ field: string;
5
+ operator: OperatorEnum;
6
+ value: string;
7
+ };
@@ -0,0 +1,7 @@
1
+ import { OperatorEnum } from './OperatorEnum';
2
+
3
+ export type FolderRuleRequest = {
4
+ field: string;
5
+ operator: OperatorEnum;
6
+ value: string;
7
+ };
@@ -1,6 +1,8 @@
1
1
  import { AccessTypeEnum } from './AccessTypeEnum';
2
+ import { FolderCanvas } from './FolderCanvas';
2
3
  import { FolderFile } from './FolderFile';
3
4
  import { FolderFolder } from './FolderFolder';
5
+ import { FolderRule } from './FolderRule';
4
6
  import { MiniUser } from './MiniUser';
5
7
 
6
8
  /**
@@ -13,18 +15,15 @@ import { MiniUser } from './MiniUser';
13
15
  export type FolderUpdate = {
14
16
  readonly id: string;
15
17
  name: string;
16
- readonly instance_id: string;
18
+ readonly content_type: string;
17
19
  access_type?: AccessTypeEnum;
18
- readonly materialized_path: string;
19
- readonly depth: number;
20
+ rules?: Array<FolderRule>;
20
21
  readonly owned_by: MiniUser;
21
- readonly files: Array<FolderFile>;
22
- readonly files_count: number;
23
- readonly file_thumbnail_urls: Array<string>;
22
+ readonly path: Array<FolderFolder>;
24
23
  readonly thumbnail_url: string | null;
25
24
  readonly folders: Array<FolderFolder>;
26
- readonly folders_count: number;
27
- readonly path: Array<FolderFolder>;
25
+ readonly files: Array<FolderFile>;
26
+ readonly canvases: Array<FolderCanvas>;
28
27
  readonly created_at: string;
29
28
  readonly created_by: MiniUser;
30
29
  readonly modified_at: string;
@@ -1,4 +1,5 @@
1
1
  import { AccessTypeEnum } from './AccessTypeEnum';
2
+ import { FolderRuleRequest } from './FolderRuleRequest';
2
3
 
3
4
  /**
4
5
  * Serializer class for updating folder records.
@@ -10,6 +11,7 @@ import { AccessTypeEnum } from './AccessTypeEnum';
10
11
  export type FolderUpdateRequest = {
11
12
  name: string;
12
13
  access_type?: AccessTypeEnum;
14
+ rules?: Array<FolderRuleRequest>;
13
15
  parent_folder_id?: string;
14
16
  thumbnail_id?: string;
15
17
  owned_by_id?: number | null;
@@ -0,0 +1,64 @@
1
+ /**
2
+ * * `exact` - exact
3
+ * * `iexact` - iexact
4
+ * * `contains` - contains
5
+ * * `icontains` - icontains
6
+ * * `in` - in
7
+ * * `gt` - gt
8
+ * * `gte` - gte
9
+ * * `lt` - lt
10
+ * * `lte` - lte
11
+ * * `startswith` - startswith
12
+ * * `istartswith` - istartswith
13
+ * * `endswith` - endswith
14
+ * * `iendswith` - iendswith
15
+ * * `range` - range
16
+ * * `date` - date
17
+ * * `year` - year
18
+ * * `iso_year` - iso_year
19
+ * * `month` - month
20
+ * * `day` - day
21
+ * * `week` - week
22
+ * * `week_day` - week_day
23
+ * * `iso_week_day` - iso_week_day
24
+ * * `quarter` - quarter
25
+ * * `time` - time
26
+ * * `hour` - hour
27
+ * * `minute` - minute
28
+ * * `second` - second
29
+ * * `isnull` - isnull
30
+ * * `regex` - regex
31
+ * * `iregex` - iregex
32
+ */
33
+ export declare enum OperatorEnum {
34
+ EXACT = "exact",
35
+ IEXACT = "iexact",
36
+ CONTAINS = "contains",
37
+ ICONTAINS = "icontains",
38
+ IN = "in",
39
+ GT = "gt",
40
+ GTE = "gte",
41
+ LT = "lt",
42
+ LTE = "lte",
43
+ STARTSWITH = "startswith",
44
+ ISTARTSWITH = "istartswith",
45
+ ENDSWITH = "endswith",
46
+ IENDSWITH = "iendswith",
47
+ RANGE = "range",
48
+ DATE = "date",
49
+ YEAR = "year",
50
+ ISO_YEAR = "iso_year",
51
+ MONTH = "month",
52
+ DAY = "day",
53
+ WEEK = "week",
54
+ WEEK_DAY = "week_day",
55
+ ISO_WEEK_DAY = "iso_week_day",
56
+ QUARTER = "quarter",
57
+ TIME = "time",
58
+ HOUR = "hour",
59
+ MINUTE = "minute",
60
+ SECOND = "second",
61
+ ISNULL = "isnull",
62
+ REGEX = "regex",
63
+ IREGEX = "iregex"
64
+ }
@@ -18,5 +18,6 @@ export type PatchedCanvasUpdateRequest = {
18
18
  access_type?: AccessTypeEnum;
19
19
  thumbnail_url?: string | null;
20
20
  account?: AccountRequest | null;
21
+ folder_id?: string | null;
21
22
  owned_by_id?: number | null;
22
23
  };
@@ -1,4 +1,5 @@
1
1
  import { AccessTypeEnum } from './AccessTypeEnum';
2
+ import { FolderRuleRequest } from './FolderRuleRequest';
2
3
 
3
4
  /**
4
5
  * Serializer class for updating folder records.
@@ -10,6 +11,7 @@ import { AccessTypeEnum } from './AccessTypeEnum';
10
11
  export type PatchedFolderUpdateRequest = {
11
12
  name?: string;
12
13
  access_type?: AccessTypeEnum;
14
+ rules?: Array<FolderRuleRequest>;
13
15
  parent_folder_id?: string;
14
16
  thumbnail_id?: string;
15
17
  owned_by_id?: number | null;
@@ -1,19 +0,0 @@
1
- import { ComputedRef, Ref } from 'vue';
2
- import { NavigationFailure } from 'vue-router';
3
- import * as Waypoint from 'vue-waypoint';
4
- export default function <T extends string>(sectionIdList: T[]): {
5
- onScrollToWaypoint: ({ el, going, direction, }: {
6
- el: Element;
7
- going: Waypoint.Going;
8
- direction: Waypoint.Direction;
9
- }) => void;
10
- onClose: (sectionId: T) => void;
11
- onClickMenu: (sectionId: T) => void;
12
- selectedSectionId: Ref<string>;
13
- sectionsEditStates: import('vue').Reactive<Record<T, boolean>>;
14
- routerGuard: (guard: ComputedRef<boolean>, goBack: () => Promise<void | NavigationFailure | undefined>) => void;
15
- waypointOptions: {
16
- threshold: number;
17
- };
18
- MENU_WIDTH: string;
19
- };
@@ -1,16 +0,0 @@
1
- import { AccessTypeEnum } from './AccessTypeEnum';
2
- import { DownloadTypeEnum } from './DownloadTypeEnum';
3
- import { FilePermissionRequest } from './FilePermissionRequest';
4
-
5
- export type FileRequest = {
6
- name?: string;
7
- download_type?: DownloadTypeEnum;
8
- access_type?: AccessTypeEnum;
9
- permissions?: FilePermissionRequest;
10
- metadata?: Record<string, any>;
11
- app_metadata?: Record<string, any>;
12
- tags?: Array<string>;
13
- expires_at?: string | null;
14
- folder_id?: string;
15
- owned_by_id?: number | null;
16
- };
@@ -1,3 +0,0 @@
1
- export type PSPDFKitAuthPayload = {
2
- jwt: string;
3
- };
@@ -1,3 +0,0 @@
1
- export type PSPDFKitAuthPayloadRequest = {
2
- jwt: string;
3
- };
@@ -1,7 +0,0 @@
1
- import { PSPDFKitAuthPayload } from './PSPDFKitAuthPayload';
2
-
3
- export type PSPDFKitToken = {
4
- readonly documentId: string;
5
- readonly authPayload: PSPDFKitAuthPayload;
6
- readonly instant: boolean;
7
- };
@@ -1,3 +0,0 @@
1
- export type PSPDFKitTokenRequest = {
2
- file_id: string;
3
- };