@pitcher/js-api 1.22.0-alpha.5 → 1.22.0-beta.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.
- package/js-api.esm.js +693 -184
- package/js-api.esm.js.map +1 -1
- package/js-api.umd.min.js +10 -10
- package/js-api.umd.min.js.map +1 -1
- package/lib/api/canvases/canvases.queries.d.ts +5 -5
- package/lib/apps/browser/stores/api.d.ts +215 -84
- package/lib/apps/browser/stores/app.d.ts +7 -26
- package/lib/apps/browser/stores/upload.d.ts +34 -24
- package/lib/apps/browser/util/file.d.ts +2 -2
- package/lib/apps/canvas-builder/composables/useCanvas.d.ts +550 -460
- package/lib/apps/canvas-builder/composables/useCanvasExit.d.ts +3 -0
- package/lib/apps/canvas-builder/composables/useCanvasHistory.d.ts +86 -74
- package/lib/apps/canvas-builder/composables/useCanvasHooks.d.ts +4 -4
- package/lib/apps/canvas-builder/composables/useCanvasPages.d.ts +3 -3
- package/lib/apps/canvas-builder/composables/useCanvasSectionOverrides.d.ts +3 -3
- package/lib/apps/canvas-builder/composables/useCanvasTheme.d.ts +24 -17
- package/lib/apps/canvas-builder/composables/useCanvasVisibility.d.ts +2 -2
- package/lib/apps/canvas-builder/composables/useCollapsibles.d.ts +3 -3
- package/lib/apps/canvas-builder/composables/useComponentPermissions.d.ts +2 -2
- package/lib/apps/canvas-builder/composables/useContentSelector.d.ts +6 -4
- package/lib/apps/canvas-builder/composables/useInstalledEmbeddables.d.ts +15 -0
- package/lib/apps/canvas-builder/composables/useRecommendations.d.ts +6 -5
- package/lib/apps/canvas-builder/composables/useSectionPopularity.d.ts +2 -2
- package/lib/apps/canvas-builder/types/canvas.d.ts +19 -18
- package/lib/apps/canvas-builder/types/recommendations.types.d.ts +3 -3
- package/lib/apps/canvas-builder/util/canvas.util.d.ts +5 -4
- package/lib/apps/canvas-selector/appTypes.d.ts +9 -0
- package/lib/apps/content-selector/appTypes.d.ts +1 -0
- package/lib/apps/content-selector/stores/app.d.ts +8 -1
- package/lib/components/CFileViewer/CFileViewer.use.d.ts +2 -4
- package/lib/components/CFileViewer/CFileViewerFullScreen.use.d.ts +1 -1
- package/lib/components/canvases/CanvasesManagementBulk.use.d.ts +5 -5
- package/lib/components/filters/filter.util.d.ts +1 -1
- package/lib/components/savedCanvases/CSavedCanvasesManagementShareCanvas.use.d.ts +5 -3
- package/lib/composables/instanceTagsActions.use.d.ts +14 -0
- package/lib/composables/recentFiles.use.d.ts +1 -1
- package/lib/composables/suggestedTags.use.d.ts +3 -0
- package/lib/composables/tableColumnsSettings.use.d.ts +25 -0
- package/lib/composables/useCanvasOverlay.d.ts +20 -0
- package/lib/composables/useCanvasTablesPagination.d.ts +13 -0
- package/lib/composables/useConfirmation.d.ts +1 -0
- package/lib/composables/useElementHeightResize.d.ts +5 -0
- package/lib/composables/useFiles.d.ts +11 -0
- package/lib/composables/useWindowEvents.d.ts +1 -1
- package/lib/constants/pitcherSettings.const.d.ts +4 -0
- package/lib/main.lib.d.ts +31 -21
- package/lib/sdk/api/HighLevelApi.d.ts +112 -14
- package/lib/sdk/api/modules/admin/canvas.admin.d.ts +53 -15
- package/lib/sdk/api/modules/admin/env.admin.d.ts +3 -2
- package/lib/sdk/api/modules/admin/files.admin.d.ts +43 -4
- package/lib/sdk/api/modules/admin/index.d.ts +53 -5
- package/lib/sdk/api/modules/admin/metadataTemplates.admin.d.ts +1 -2
- package/lib/sdk/api/modules/admin/types.admin.d.ts +132 -3
- package/lib/sdk/api/modules/canvas.d.ts +12 -14
- package/lib/sdk/api/modules/dsr/env.dsr.d.ts +4 -3
- package/lib/sdk/api/modules/dsr/index.d.ts +14 -3
- package/lib/sdk/api/modules/dsr/loading.dsr.d.ts +7 -1
- package/lib/sdk/api/modules/env.d.ts +16 -0
- package/lib/sdk/api/modules/favorites.d.ts +9 -0
- package/lib/sdk/api/modules/feedback.d.ts +3 -0
- package/lib/sdk/api/modules/files.d.ts +7 -4
- package/lib/sdk/api/modules/folders.d.ts +29 -0
- package/lib/sdk/api/modules/open.d.ts +6 -0
- package/lib/sdk/api/modules/sync.d.ts +1 -2
- package/lib/sdk/api/modules/ui/app-errors.ui.d.ts +13 -1
- package/lib/sdk/api/modules/ui/canvas.ui.d.ts +102 -8
- package/lib/sdk/api/modules/ui/content.ui.d.ts +52 -2
- package/lib/sdk/api/modules/ui/index.d.ts +150 -13
- package/lib/sdk/api/modules/ui/loading.ui.d.ts +9 -1
- package/lib/sdk/api/modules/ui/location.ui.d.ts +18 -1
- package/lib/sdk/api/modules/ui/post-call.ui.d.ts +35 -4
- package/lib/sdk/api/modules/ui/types.ui.d.ts +86 -8
- package/lib/sdk/api/modules/users.d.ts +6 -1
- package/lib/sdk/api/onlineRestApiHandlers.d.ts +4 -0
- package/lib/sdk/interfaces.d.ts +124 -3
- package/lib/sdk/main.d.ts +297 -151
- package/lib/sdk/payload.types.d.ts +134 -2
- package/lib/sdk/utils/httpFetch.d.ts +15 -0
- package/lib/sdk/utils/object.d.ts +1 -0
- package/lib/sdk/utils/object.spec.d.ts +1 -0
- package/lib/theme/light.d.ts +12 -0
- package/lib/types/app.d.ts +11 -0
- package/lib/types/call.d.ts +4 -3
- package/lib/types/files.d.ts +27 -1
- package/lib/types/filter.d.ts +5 -0
- package/lib/types/instance.types.d.ts +18 -0
- package/lib/types/{instanceSettings.d.ts → instanceSettings.types.d.ts} +10 -2
- package/lib/types/launchDarkly.types.d.ts +4 -4
- package/lib/types/organization.types.d.ts +2 -2
- package/lib/types/organizationSettings.types.d.ts +4 -0
- package/lib/types/recentFiles.types.d.ts +4 -1
- package/lib/types/users.d.ts +13 -0
- package/lib/util/fullscreen.util.d.ts +1 -1
- package/lib/util/string.d.ts +1 -0
- package/package.json +1 -1
- package/types/openapi/index.d.ts +23 -17
- package/types/openapi/models/AccessTypeEnum.d.ts +3 -1
- package/types/openapi/models/App.d.ts +1 -0
- package/types/openapi/models/AppRelease.d.ts +1 -0
- package/types/openapi/models/AppsDBEntry.d.ts +4 -0
- package/types/openapi/models/AppsDBEntryRequest.d.ts +3 -0
- package/types/openapi/models/Canvas.d.ts +10 -15
- package/types/openapi/models/CanvasCreate.d.ts +14 -12
- package/types/openapi/models/CanvasCreateRequest.d.ts +6 -5
- package/types/openapi/models/CanvasRecommendedFile.d.ts +6 -0
- package/types/openapi/models/CanvasRetrieve.d.ts +15 -13
- package/types/openapi/models/CanvasSection.d.ts +5 -2
- package/types/openapi/models/CanvasUpdate.d.ts +14 -12
- package/types/openapi/models/CanvasUpdateRequest.d.ts +5 -4
- package/types/openapi/models/CollaborationRoleEnum.d.ts +0 -4
- package/types/openapi/models/ContentDistributionGroupCreate.d.ts +1 -0
- package/types/openapi/models/DeletedApp.d.ts +1 -0
- package/types/openapi/models/{CanvasList.d.ts → DeletedCanvas.d.ts} +13 -9
- package/types/openapi/models/DeletedContentDistributionGroup.d.ts +1 -0
- package/types/openapi/models/DeletedEnvironment.d.ts +1 -0
- package/types/openapi/models/DeletedFavorite.d.ts +1 -0
- package/types/openapi/models/DeletedFile.d.ts +6 -0
- package/types/openapi/models/DeletedFolder.d.ts +4 -3
- package/types/openapi/models/DeletedInstance.d.ts +1 -0
- package/types/openapi/models/DeletedInstanceAssignmentGroup.d.ts +1 -0
- package/types/openapi/models/DeletedMetadataTemplate.d.ts +1 -0
- package/types/openapi/models/DeletedRegion.d.ts +1 -0
- package/types/openapi/models/Environment.d.ts +1 -0
- package/types/openapi/models/Favorite.d.ts +1 -0
- package/types/openapi/models/File.d.ts +6 -0
- package/types/openapi/models/FileCreate.d.ts +8 -0
- package/types/openapi/models/FileCreateRequest.d.ts +3 -0
- package/types/openapi/models/FilePermission.d.ts +4 -0
- package/types/openapi/models/FilePermissionRequest.d.ts +4 -0
- package/types/openapi/models/FileRetrieve.d.ts +8 -0
- package/types/openapi/models/FileRevision.d.ts +8 -0
- package/types/openapi/models/FileRevisionRequest.d.ts +3 -0
- package/types/openapi/models/FileUpdate.d.ts +8 -0
- package/types/openapi/models/FileUpdateRequest.d.ts +3 -0
- package/types/openapi/models/FileVersion.d.ts +5 -0
- package/types/openapi/models/Folder.d.ts +4 -3
- package/types/openapi/models/FolderCanvas.d.ts +11 -0
- package/types/openapi/models/FolderCreate.d.ts +8 -7
- package/types/openapi/models/FolderCreateRequest.d.ts +4 -2
- package/types/openapi/models/FolderFile.d.ts +3 -0
- package/types/openapi/models/FolderFolder.d.ts +5 -1
- package/types/openapi/models/FolderRetrieve.d.ts +8 -8
- package/types/openapi/models/FolderRule.d.ts +7 -0
- package/types/openapi/models/FolderRuleRequest.d.ts +7 -0
- package/types/openapi/models/FolderUpdate.d.ts +8 -8
- package/types/openapi/models/FolderUpdateRequest.d.ts +3 -0
- package/types/openapi/models/Instance.d.ts +1 -0
- package/types/openapi/models/InstanceUpdate.d.ts +1 -0
- package/types/openapi/models/MetadataTemplate.d.ts +1 -0
- package/types/openapi/models/OfflineSyncFolder.d.ts +17 -0
- package/types/openapi/models/OperatorEnum.d.ts +64 -0
- package/types/openapi/models/PaginatedCanvasList.d.ts +8 -0
- package/types/openapi/models/PaginatedFileRevisionList.d.ts +8 -0
- package/types/openapi/models/PaginatedOfflineSyncFolderList.d.ts +8 -0
- package/types/openapi/models/PatchedCanvasUpdateRequest.d.ts +5 -4
- package/types/openapi/models/PatchedFileRequest.d.ts +3 -0
- package/types/openapi/models/PatchedFileRevisionRequest.d.ts +3 -0
- package/types/openapi/models/PatchedFileUpdateRequest.d.ts +3 -0
- package/types/openapi/models/PatchedFolderUpdateRequest.d.ts +3 -0
- package/types/openapi/models/Region.d.ts +1 -0
- package/types/openapi/models/SearchFile.d.ts +3 -0
- package/types/openapi/models/SharedLink.d.ts +6 -5
- package/types/openapi/models/SharedLinkCanvas.d.ts +11 -0
- package/types/openapi/models/SharedLinkCanvasRequest.d.ts +8 -0
- package/types/openapi/models/SharedLinkCreate.d.ts +6 -5
- package/types/openapi/models/{SharedLinkInstanceSerialzier.d.ts → SharedLinkInstance.d.ts} +1 -1
- package/types/openapi/models/SharedLinkInstanceRequest.d.ts +5 -0
- package/types/openapi/models/{SharedLinkOrganizationSerialzier.d.ts → SharedLinkOrganization.d.ts} +1 -1
- package/types/openapi/models/SharedLinkOrganizationRequest.d.ts +6 -0
- package/lib/apps/canvas-builder/util/tsUtils.d.ts +0 -3
- package/lib/composables/useDetailsView.d.ts +0 -19
- package/lib/types/templateActions.d.ts +0 -10
- package/lib/util/gesture.util.d.ts +0 -6
- package/types/openapi/models/AppsDBGlobalEntry.d.ts +0 -8
- package/types/openapi/models/AppsDBGlobalEntryRequest.d.ts +0 -3
- package/types/openapi/models/AppsDBUserEntry.d.ts +0 -9
- package/types/openapi/models/AppsDBUserEntryRequest.d.ts +0 -3
- package/types/openapi/models/CanvasSectionRetrieve.d.ts +0 -7
- package/types/openapi/models/CanvasSectionRetrieveRequest.d.ts +0 -5
- package/types/openapi/models/FileRequest.d.ts +0 -13
- package/types/openapi/models/InstanceStorageCredentials.d.ts +0 -6
- package/types/openapi/models/MiniAccount.d.ts +0 -4
- package/types/openapi/models/PSPDFKitAuthPayload.d.ts +0 -3
- package/types/openapi/models/PSPDFKitAuthPayloadRequest.d.ts +0 -3
- package/types/openapi/models/PSPDFKitToken.d.ts +0 -7
- package/types/openapi/models/PSPDFKitTokenRequest.d.ts +0 -3
- package/types/openapi/models/PaginatedCanvasListList.d.ts +0 -8
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { AccessTypeEnum } from './AccessTypeEnum';
|
|
2
2
|
import { DownloadTypeEnum } from './DownloadTypeEnum';
|
|
3
|
+
import { FilePermissionRequest } from './FilePermissionRequest';
|
|
3
4
|
|
|
4
5
|
export type PatchedFileUpdateRequest = {
|
|
5
6
|
name?: string;
|
|
@@ -9,9 +10,11 @@ export type PatchedFileUpdateRequest = {
|
|
|
9
10
|
thumbnail_upload_id?: string;
|
|
10
11
|
download_type?: DownloadTypeEnum;
|
|
11
12
|
access_type?: AccessTypeEnum;
|
|
13
|
+
permissions?: FilePermissionRequest;
|
|
12
14
|
metadata?: Record<string, any>;
|
|
13
15
|
app_metadata?: Record<string, any>;
|
|
14
16
|
tags?: Array<string>;
|
|
15
17
|
expires_at?: string | null;
|
|
16
18
|
folder_id?: string;
|
|
19
|
+
owned_by_id?: number | null;
|
|
17
20
|
};
|
|
@@ -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,8 @@ 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;
|
|
17
|
+
owned_by_id?: number | null;
|
|
15
18
|
};
|
|
@@ -1,14 +1,15 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
1
|
+
import { SharedLinkCanvas } from './SharedLinkCanvas';
|
|
2
|
+
import { SharedLinkInstance } from './SharedLinkInstance';
|
|
3
|
+
import { SharedLinkOrganization } from './SharedLinkOrganization';
|
|
3
4
|
|
|
4
5
|
export type SharedLink = {
|
|
5
6
|
readonly id: string;
|
|
6
7
|
readonly type: string;
|
|
7
8
|
is_snapshot?: boolean;
|
|
8
9
|
readonly file: Record<string, any> | null;
|
|
9
|
-
readonly canvas:
|
|
10
|
-
readonly instance:
|
|
11
|
-
readonly organization:
|
|
10
|
+
readonly canvas: SharedLinkCanvas;
|
|
11
|
+
readonly instance: SharedLinkInstance;
|
|
12
|
+
readonly organization: SharedLinkOrganization;
|
|
12
13
|
readonly status: string;
|
|
13
14
|
readonly url: string;
|
|
14
15
|
short_url?: string | null;
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { CanvasSection } from './CanvasSection';
|
|
2
|
+
|
|
3
|
+
export type SharedLinkCanvas = {
|
|
4
|
+
readonly id: string;
|
|
5
|
+
name: string;
|
|
6
|
+
content?: Record<string, any>;
|
|
7
|
+
context?: Record<string, any>;
|
|
8
|
+
theme?: Record<string, any> | null;
|
|
9
|
+
thumbnail_url?: string | null;
|
|
10
|
+
readonly sections: Array<CanvasSection>;
|
|
11
|
+
};
|
|
@@ -1,14 +1,15 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
1
|
+
import { SharedLinkCanvas } from './SharedLinkCanvas';
|
|
2
|
+
import { SharedLinkInstance } from './SharedLinkInstance';
|
|
3
|
+
import { SharedLinkOrganization } from './SharedLinkOrganization';
|
|
3
4
|
|
|
4
5
|
export type SharedLinkCreate = {
|
|
5
6
|
readonly id: string;
|
|
6
7
|
readonly type: string;
|
|
7
8
|
is_snapshot?: boolean;
|
|
8
9
|
readonly file: Record<string, any> | null;
|
|
9
|
-
readonly canvas:
|
|
10
|
-
readonly instance:
|
|
11
|
-
readonly organization:
|
|
10
|
+
readonly canvas: SharedLinkCanvas;
|
|
11
|
+
readonly instance: SharedLinkInstance;
|
|
12
|
+
readonly organization: SharedLinkOrganization;
|
|
12
13
|
readonly status: string;
|
|
13
14
|
readonly url: string;
|
|
14
15
|
short_url?: string | 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,13 +0,0 @@
|
|
|
1
|
-
import { AccessTypeEnum } from './AccessTypeEnum';
|
|
2
|
-
import { DownloadTypeEnum } from './DownloadTypeEnum';
|
|
3
|
-
|
|
4
|
-
export type FileRequest = {
|
|
5
|
-
name?: string;
|
|
6
|
-
download_type?: DownloadTypeEnum;
|
|
7
|
-
access_type?: AccessTypeEnum;
|
|
8
|
-
metadata?: Record<string, any>;
|
|
9
|
-
app_metadata?: Record<string, any>;
|
|
10
|
-
tags?: Array<string>;
|
|
11
|
-
expires_at?: string | null;
|
|
12
|
-
folder_id?: string;
|
|
13
|
-
};
|