@pitcher/js-api 1.21.0-beta.8 → 1.21.0

package/types/openapi/models/FileUpdate.d.ts

@@ -2,8 +2,10 @@ import { AccessTypeEnum } from './AccessTypeEnum';
 import { CollaborationRoleEnum } from './CollaborationRoleEnum';
 import { DownloadTypeEnum } from './DownloadTypeEnum';
 import { FileContentTypeEnum } from './FileContentTypeEnum';
+import { FilePermission } from './FilePermission';
 import { FileStatusEnum } from './FileStatusEnum';
 import { FileTypeEnum } from './FileTypeEnum';
+import { FileVersion } from './FileVersion';
 import { MiniSharedLink } from './MiniSharedLink';
 import { MiniUser } from './MiniUser';
 
@@ -14,6 +16,7 @@ export type FileUpdate = {
     readonly type: FileTypeEnum;
     readonly size: number | null;
     readonly status: FileStatusEnum;
+    readonly version: FileVersion;
     readonly content_type: FileContentTypeEnum;
     readonly content_extension: string | null;
     readonly content_length: number | null;
@@ -25,7 +28,11 @@ export type FileUpdate = {
     readonly zip_size: number | null;
     readonly zip_url: string | null;
     access_type?: AccessTypeEnum;
+    /**
+     * Deprecated: Please use the 'permissions' field instead. This field is maintained for backward compatibility and may be removed in future releases.
+     */
     readonly role: CollaborationRoleEnum;
+    permissions?: FilePermission;
     readonly pspdfkit_server_url: string | null;
     readonly pspdfkit_auth_payload: Record<string, any> | null;
     metadata?: Record<string, any>;
@@ -36,6 +43,7 @@ export type FileUpdate = {
     readonly instance_id: string;
     folder_id?: string;
     readonly shared_link: MiniSharedLink;
+    readonly owned_by: MiniUser;
     readonly created_at: string;
     readonly created_by: MiniUser;
     readonly modified_at: string;

package/types/openapi/models/FileUpdateRequest.d.ts

@@ -1,5 +1,6 @@
 import { AccessTypeEnum } from './AccessTypeEnum';
 import { DownloadTypeEnum } from './DownloadTypeEnum';
+import { FilePermissionRequest } from './FilePermissionRequest';
 
 export type FileUpdateRequest = {
     name?: string;
@@ -9,9 +10,11 @@ export type FileUpdateRequest = {
     thumbnail_upload_id?: string;
     download_type?: DownloadTypeEnum;
     access_type?: AccessTypeEnum;
+    permissions?: FilePermissionRequest;
     metadata?: Record<string, any>;
     app_metadata?: Record<string, any>;
     tags?: Array<string>;
     expires_at?: string | null;
     folder_id?: string;
+    owned_by_id?: number | null;
 };

package/types/openapi/models/FileVersion.d.ts

@@ -0,0 +1,5 @@
+export type FileVersion = {
+    readonly id: string;
+    readonly comment: string;
+    readonly created_at: string;
+};

package/types/openapi/models/Folder.d.ts

@@ -1,13 +1,14 @@
 import { AccessTypeEnum } from './AccessTypeEnum';
+import { FolderRule } from './FolderRule';
 import { MiniUser } from './MiniUser';
 
 export type Folder = {
     readonly id: string;
     name: string;
-    readonly instance_id: string;
+    readonly content_type: string;
     access_type?: AccessTypeEnum;
-    readonly materialized_path: string;
-    readonly depth: number;
+    rules?: Array<FolderRule>;
+    readonly owned_by: MiniUser;
     readonly created_at: string;
     readonly created_by: MiniUser;
     readonly modified_at: string;

package/types/openapi/models/FolderCanvas.d.ts

@@ -0,0 +1,11 @@
+import { MiniUser } from './MiniUser';
+
+export type FolderCanvas = {
+    readonly id: string;
+    name: string;
+    thumbnail_url?: string | null;
+    readonly tags: Array<string>;
+    readonly created_by: MiniUser;
+    readonly owned_by: MiniUser;
+    readonly modified_at: string;
+};

package/types/openapi/models/FolderCreate.d.ts

@@ -1,6 +1,8 @@
 import { AccessTypeEnum } from './AccessTypeEnum';
+import { FolderCanvas } from './FolderCanvas';
 import { FolderFile } from './FolderFile';
 import { FolderFolder } from './FolderFolder';
+import { FolderRule } from './FolderRule';
 import { MiniUser } from './MiniUser';
 
 /**
@@ -14,16 +16,15 @@ import { MiniUser } from './MiniUser';
 export type FolderCreate = {
     id?: string;
     name: string;
+    readonly content_type: string;
     access_type?: AccessTypeEnum;
-    readonly materialized_path: string;
-    readonly depth: number;
-    readonly files: Array<FolderFile>;
-    readonly files_count: number;
-    readonly file_thumbnail_urls: Array<string>;
+    rules?: Array<FolderRule>;
+    readonly owned_by: MiniUser;
+    readonly path: Array<FolderFolder>;
     readonly thumbnail_url: string | null;
     readonly folders: Array<FolderFolder>;
-    readonly folders_count: number;
-    readonly path: Array<FolderFolder>;
+    readonly files: Array<FolderFile>;
+    readonly canvases: Array<FolderCanvas>;
     readonly created_at: string;
     readonly created_by: MiniUser;
     readonly modified_at: string;

package/types/openapi/models/FolderCreateRequest.d.ts

@@ -1,4 +1,5 @@
 import { AccessTypeEnum } from './AccessTypeEnum';
+import { FolderRuleRequest } from './FolderRuleRequest';
 
 /**
  * Serializer class for creating folder records.
@@ -11,8 +12,9 @@ import { AccessTypeEnum } from './AccessTypeEnum';
 export type FolderCreateRequest = {
     id?: string;
     name: string;
-    instance_id: string;
     access_type?: AccessTypeEnum;
-    parent_folder_id?: string;
+    rules?: Array<FolderRuleRequest>;
+    parent_folder_id: string;
     thumbnail_id?: string;
+    owned_by_id?: number | null;
 };

package/types/openapi/models/FolderFile.d.ts

@@ -1,4 +1,5 @@
 import { FileContentTypeEnum } from './FileContentTypeEnum';
+import { FilePermission } from './FilePermission';
 import { FileStatusEnum } from './FileStatusEnum';
 import { MiniUser } from './MiniUser';
 
@@ -9,6 +10,8 @@ export type FolderFile = {
     readonly content_type: FileContentTypeEnum;
     readonly thumbnail_url: string;
     readonly tags: Array<string>;
+    permissions?: FilePermission;
     readonly created_by: MiniUser;
+    readonly owned_by: MiniUser;
     readonly modified_at: string;
 };

package/types/openapi/models/FolderFolder.d.ts

@@ -1,6 +1,10 @@
 export type FolderFolder = {
     readonly id: string;
     name: string;
-    readonly files_count: number;
+    readonly thumbnail_url: string | null;
     readonly folders_count: number;
+    readonly files_count: number;
+    readonly file_thumbnail_urls: Array<string>;
+    readonly canvases_count: number;
+    readonly canvas_thumbnail_urls: Array<string>;
 };

package/types/openapi/models/FolderRetrieve.d.ts

@@ -1,22 +1,22 @@
 import { AccessTypeEnum } from './AccessTypeEnum';
+import { FolderCanvas } from './FolderCanvas';
 import { FolderFile } from './FolderFile';
 import { FolderFolder } from './FolderFolder';
+import { FolderRule } from './FolderRule';
 import { MiniUser } from './MiniUser';
 
 export type FolderRetrieve = {
     readonly id: string;
     name: string;
-    readonly instance_id: string;
+    readonly content_type: string;
     access_type?: AccessTypeEnum;
-    readonly materialized_path: string;
-    readonly depth: number;
-    readonly files: Array<FolderFile>;
-    readonly files_count: number;
-    readonly file_thumbnail_urls: Array<string>;
+    rules?: Array<FolderRule>;
+    readonly owned_by: MiniUser;
+    readonly path: Array<FolderFolder>;
     readonly thumbnail_url: string | null;
     readonly folders: Array<FolderFolder>;
-    readonly folders_count: number;
-    readonly path: Array<FolderFolder>;
+    readonly files: Array<FolderFile>;
+    readonly canvases: Array<FolderCanvas>;
     readonly created_at: string;
     readonly created_by: MiniUser;
     readonly modified_at: string;

package/types/openapi/models/FolderRule.d.ts

@@ -0,0 +1,7 @@
+import { OperatorEnum } from './OperatorEnum';
+
+export type FolderRule = {
+    field: string;
+    operator: OperatorEnum;
+    value: string;
+};

package/types/openapi/models/FolderRuleRequest.d.ts

@@ -0,0 +1,7 @@
+import { OperatorEnum } from './OperatorEnum';
+
+export type FolderRuleRequest = {
+    field: string;
+    operator: OperatorEnum;
+    value: string;
+};

package/types/openapi/models/FolderUpdate.d.ts

@@ -1,6 +1,8 @@
 import { AccessTypeEnum } from './AccessTypeEnum';
+import { FolderCanvas } from './FolderCanvas';
 import { FolderFile } from './FolderFile';
 import { FolderFolder } from './FolderFolder';
+import { FolderRule } from './FolderRule';
 import { MiniUser } from './MiniUser';
 
 /**
@@ -13,17 +15,15 @@ import { MiniUser } from './MiniUser';
 export type FolderUpdate = {
     readonly id: string;
     name: string;
-    readonly instance_id: string;
+    readonly content_type: string;
     access_type?: AccessTypeEnum;
-    readonly materialized_path: string;
-    readonly depth: number;
-    readonly files: Array<FolderFile>;
-    readonly files_count: number;
-    readonly file_thumbnail_urls: Array<string>;
+    rules?: Array<FolderRule>;
+    readonly owned_by: MiniUser;
+    readonly path: Array<FolderFolder>;
     readonly thumbnail_url: string | null;
     readonly folders: Array<FolderFolder>;
-    readonly folders_count: number;
-    readonly path: Array<FolderFolder>;
+    readonly files: Array<FolderFile>;
+    readonly canvases: Array<FolderCanvas>;
     readonly created_at: string;
     readonly created_by: MiniUser;
     readonly modified_at: string;

package/types/openapi/models/FolderUpdateRequest.d.ts

@@ -1,4 +1,5 @@
 import { AccessTypeEnum } from './AccessTypeEnum';
+import { FolderRuleRequest } from './FolderRuleRequest';
 
 /**
  * Serializer class for updating folder records.
@@ -10,6 +11,8 @@ import { AccessTypeEnum } from './AccessTypeEnum';
 export type FolderUpdateRequest = {
     name: string;
     access_type?: AccessTypeEnum;
+    rules?: Array<FolderRuleRequest>;
     parent_folder_id?: string;
     thumbnail_id?: string;
+    owned_by_id?: number | null;
 };

package/types/openapi/models/Instance.d.ts

@@ -19,4 +19,5 @@ export type Instance = {
     readonly created_by: MiniUser;
     readonly modified_at: string;
     readonly modified_by: MiniUser;
+    readonly owned_by: MiniUser;
 };

package/types/openapi/models/InstanceUpdate.d.ts

@@ -15,4 +15,5 @@ export type InstanceUpdate = {
     readonly created_by: MiniUser;
     readonly modified_at: string;
     readonly modified_by: MiniUser;
+    readonly owned_by: MiniUser;
 };

package/types/openapi/models/MetadataTemplate.d.ts

@@ -12,4 +12,5 @@ export type MetadataTemplate = {
     readonly created_by: MiniUser;
     readonly modified_at: string;
     readonly modified_by: MiniUser;
+    readonly owned_by: MiniUser;
 };

package/types/openapi/models/OfflineSyncFolder.d.ts

@@ -0,0 +1,17 @@
+import { AccessTypeEnum } from './AccessTypeEnum';
+import { MiniUser } from './MiniUser';
+
+export type OfflineSyncFolder = {
+    readonly id: string;
+    name: string;
+    readonly instance_id: string;
+    access_type?: AccessTypeEnum;
+    readonly materialized_path: string;
+    readonly depth: number;
+    readonly owned_by: MiniUser;
+    readonly thumbnail_id: string | null;
+    readonly created_at: string;
+    readonly created_by: MiniUser;
+    readonly modified_at: string;
+    readonly modified_by: MiniUser;
+};

package/types/openapi/models/OperatorEnum.d.ts

@@ -0,0 +1,64 @@
+/**
+ * * `exact` - exact
+ * * `iexact` - iexact
+ * * `contains` - contains
+ * * `icontains` - icontains
+ * * `in` - in
+ * * `gt` - gt
+ * * `gte` - gte
+ * * `lt` - lt
+ * * `lte` - lte
+ * * `startswith` - startswith
+ * * `istartswith` - istartswith
+ * * `endswith` - endswith
+ * * `iendswith` - iendswith
+ * * `range` - range
+ * * `date` - date
+ * * `year` - year
+ * * `iso_year` - iso_year
+ * * `month` - month
+ * * `day` - day
+ * * `week` - week
+ * * `week_day` - week_day
+ * * `iso_week_day` - iso_week_day
+ * * `quarter` - quarter
+ * * `time` - time
+ * * `hour` - hour
+ * * `minute` - minute
+ * * `second` - second
+ * * `isnull` - isnull
+ * * `regex` - regex
+ * * `iregex` - iregex
+ */
+export declare enum OperatorEnum {
+    EXACT = "exact",
+    IEXACT = "iexact",
+    CONTAINS = "contains",
+    ICONTAINS = "icontains",
+    IN = "in",
+    GT = "gt",
+    GTE = "gte",
+    LT = "lt",
+    LTE = "lte",
+    STARTSWITH = "startswith",
+    ISTARTSWITH = "istartswith",
+    ENDSWITH = "endswith",
+    IENDSWITH = "iendswith",
+    RANGE = "range",
+    DATE = "date",
+    YEAR = "year",
+    ISO_YEAR = "iso_year",
+    MONTH = "month",
+    DAY = "day",
+    WEEK = "week",
+    WEEK_DAY = "week_day",
+    ISO_WEEK_DAY = "iso_week_day",
+    QUARTER = "quarter",
+    TIME = "time",
+    HOUR = "hour",
+    MINUTE = "minute",
+    SECOND = "second",
+    ISNULL = "isnull",
+    REGEX = "regex",
+    IREGEX = "iregex"
+}

package/types/openapi/models/PaginatedCanvasList.d.ts

@@ -0,0 +1,8 @@
+import { Canvas } from './Canvas';
+
+export type PaginatedCanvasList = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<Canvas>;
+};

package/types/openapi/models/PaginatedFileRevisionList.d.ts

@@ -0,0 +1,8 @@
+import { FileRevision } from './FileRevision';
+
+export type PaginatedFileRevisionList = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<FileRevision>;
+};

package/types/openapi/models/PaginatedOfflineSyncFolderList.d.ts

@@ -0,0 +1,8 @@
+import { OfflineSyncFolder } from './OfflineSyncFolder';
+
+export type PaginatedOfflineSyncFolderList = {
+    count?: number;
+    next?: string | null;
+    previous?: string | null;
+    results?: Array<OfflineSyncFolder>;
+};

package/types/openapi/models/PatchedCanvasUpdateRequest.d.ts

@@ -3,20 +3,21 @@ import { AccountRequest } from './AccountRequest';
 
 export type PatchedCanvasUpdateRequest = {
     name?: string;
+    content?: Record<string, any>;
+    context?: Record<string, any>;
+    theme?: Record<string, any> | null;
     is_draft?: boolean;
     is_template?: boolean;
     is_section?: boolean;
     is_editable?: boolean;
     is_default?: boolean;
-    account?: AccountRequest | null;
     metadata?: Record<string, any>;
     tags?: Array<string>;
     start_at?: string | null;
     expires_at?: string | null;
     access_type?: AccessTypeEnum;
     thumbnail_url?: string | null;
-    content?: any;
-    context?: any;
-    theme?: any;
+    account?: AccountRequest | null;
+    folder_id?: string | null;
     owned_by_id?: number | null;
 };

package/types/openapi/models/PatchedFileRequest.d.ts

@@ -1,13 +1,16 @@
 import { AccessTypeEnum } from './AccessTypeEnum';
 import { DownloadTypeEnum } from './DownloadTypeEnum';
+import { FilePermissionRequest } from './FilePermissionRequest';
 
 export type PatchedFileRequest = {
     name?: string;
     download_type?: DownloadTypeEnum;
     access_type?: AccessTypeEnum;
+    permissions?: FilePermissionRequest;
     metadata?: Record<string, any>;
     app_metadata?: Record<string, any>;
     tags?: Array<string>;
     expires_at?: string | null;
     folder_id?: string;
+    owned_by_id?: number | null;
 };

package/types/openapi/models/PatchedFileRevisionRequest.d.ts

@@ -0,0 +1,3 @@
+export type PatchedFileRevisionRequest = {
+    name?: string;
+};

package/types/openapi/models/PatchedFileUpdateRequest.d.ts

@@ -1,5 +1,6 @@
 import { AccessTypeEnum } from './AccessTypeEnum';
 import { DownloadTypeEnum } from './DownloadTypeEnum';
+import { FilePermissionRequest } from './FilePermissionRequest';
 
 export type PatchedFileUpdateRequest = {
     name?: string;
@@ -9,9 +10,11 @@ export type PatchedFileUpdateRequest = {
     thumbnail_upload_id?: string;
     download_type?: DownloadTypeEnum;
     access_type?: AccessTypeEnum;
+    permissions?: FilePermissionRequest;
     metadata?: Record<string, any>;
     app_metadata?: Record<string, any>;
     tags?: Array<string>;
     expires_at?: string | null;
     folder_id?: string;
+    owned_by_id?: number | null;
 };

package/types/openapi/models/PatchedFolderUpdateRequest.d.ts

@@ -1,4 +1,5 @@
 import { AccessTypeEnum } from './AccessTypeEnum';
+import { FolderRuleRequest } from './FolderRuleRequest';
 
 /**
  * Serializer class for updating folder records.
@@ -10,6 +11,8 @@ import { AccessTypeEnum } from './AccessTypeEnum';
 export type PatchedFolderUpdateRequest = {
     name?: string;
     access_type?: AccessTypeEnum;
+    rules?: Array<FolderRuleRequest>;
     parent_folder_id?: string;
     thumbnail_id?: string;
+    owned_by_id?: number | null;
 };

package/types/openapi/models/Region.d.ts

@@ -7,4 +7,5 @@ export type Region = {
     readonly created_by: MiniUser;
     readonly modified_at: string;
     readonly modified_by: MiniUser;
+    readonly owned_by: MiniUser;
 };

package/types/openapi/models/SearchFile.d.ts

@@ -1,6 +1,9 @@
+import { MiniFolder } from './MiniFolder';
+
 export type SearchFile = {
     readonly id: string;
     name: string;
     readonly headline: string;
     readonly picture_url: string;
+    readonly folder: MiniFolder;
 };

package/types/openapi/models/SharedLink.d.ts

@@ -1,14 +1,15 @@
-import { SharedLinkInstanceSerialzier } from './SharedLinkInstanceSerialzier';
-import { SharedLinkOrganizationSerialzier } from './SharedLinkOrganizationSerialzier';
+import { SharedLinkCanvas } from './SharedLinkCanvas';
+import { SharedLinkInstance } from './SharedLinkInstance';
+import { SharedLinkOrganization } from './SharedLinkOrganization';
 
 export type SharedLink = {
     readonly id: string;
     readonly type: string;
     is_snapshot?: boolean;
     readonly file: Record<string, any> | null;
-    readonly canvas: Record<string, any> | null;
-    readonly instance: SharedLinkInstanceSerialzier;
-    readonly organization: SharedLinkOrganizationSerialzier;
+    readonly canvas: SharedLinkCanvas;
+    readonly instance: SharedLinkInstance;
+    readonly organization: SharedLinkOrganization;
     readonly status: string;
     readonly url: string;
     short_url?: string | null;

package/types/openapi/models/SharedLinkCanvas.d.ts

@@ -0,0 +1,11 @@
+import { CanvasSection } from './CanvasSection';
+
+export type SharedLinkCanvas = {
+    readonly id: string;
+    name: string;
+    content?: Record<string, any>;
+    context?: Record<string, any>;
+    theme?: Record<string, any> | null;
+    thumbnail_url?: string | null;
+    readonly sections: Array<CanvasSection>;
+};

package/types/openapi/models/SharedLinkCanvasRequest.d.ts

@@ -0,0 +1,8 @@
+export type SharedLinkCanvasRequest = {
+    name: string;
+    content?: Record<string, any>;
+    context?: Record<string, any>;
+    theme?: Record<string, any> | null;
+    thumbnail_url?: string | null;
+    owned_by_id?: number | null;
+};

package/types/openapi/models/SharedLinkCreate.d.ts

@@ -1,14 +1,15 @@
-import { SharedLinkInstanceSerialzier } from './SharedLinkInstanceSerialzier';
-import { SharedLinkOrganizationSerialzier } from './SharedLinkOrganizationSerialzier';
+import { SharedLinkCanvas } from './SharedLinkCanvas';
+import { SharedLinkInstance } from './SharedLinkInstance';
+import { SharedLinkOrganization } from './SharedLinkOrganization';
 
 export type SharedLinkCreate = {
     readonly id: string;
     readonly type: string;
     is_snapshot?: boolean;
     readonly file: Record<string, any> | null;
-    readonly canvas: Record<string, any> | null;
-    readonly instance: SharedLinkInstanceSerialzier;
-    readonly organization: SharedLinkOrganizationSerialzier;
+    readonly canvas: SharedLinkCanvas;
+    readonly instance: SharedLinkInstance;
+    readonly organization: SharedLinkOrganization;
     readonly status: string;
     readonly url: string;
     short_url?: string | null;

package/types/openapi/models/{SharedLinkInstanceSerialzier.d.ts → SharedLinkInstance.d.ts}

@@ -1,4 +1,4 @@
-export type SharedLinkInstanceSerialzier = {
+export type SharedLinkInstance = {
     readonly id: string;
     name: string;
     logo?: string | null;

package/types/openapi/models/SharedLinkInstanceRequest.d.ts

@@ -0,0 +1,5 @@
+export type SharedLinkInstanceRequest = {
+    name: string;
+    logo?: Blob | null;
+    color?: string | null;
+};

package/types/openapi/models/{SharedLinkOrganizationSerialzier.d.ts → SharedLinkOrganization.d.ts}

@@ -1,4 +1,4 @@
-export type SharedLinkOrganizationSerialzier = {
+export type SharedLinkOrganization = {
     id: string;
     name: string;
     display_name?: string | null;

package/types/openapi/models/SharedLinkOrganizationRequest.d.ts

@@ -0,0 +1,6 @@
+export type SharedLinkOrganizationRequest = {
+    id: string;
+    name: string;
+    display_name?: string | null;
+    metadata?: any;
+};

package/lib/apps/canvas-builder/util/tsUtils.d.ts

@@ -1,3 +0,0 @@
-export type WithRequiredProperty<Type, Key extends keyof Type> = Type & {
-    [Property in Key]-?: Type[Property];
-};

package/lib/composables/useDetailsView.d.ts

@@ -1,19 +0,0 @@
-import { ComputedRef, Ref } from 'vue';
-import { NavigationFailure } from 'vue-router';
-import * as Waypoint from 'vue-waypoint';
-export default function <T extends string>(sectionIdList: T[]): {
-    onScrollToWaypoint: ({ el, going, direction, }: {
-        el: Element;
-        going: Waypoint.Going;
-        direction: Waypoint.Direction;
-    }) => void;
-    onClose: (sectionId: T) => void;
-    onClickMenu: (sectionId: T) => void;
-    selectedSectionId: Ref<string>;
-    sectionsEditStates: import('vue').Reactive<Record<T, boolean>>;
-    routerGuard: (guard: ComputedRef<boolean>, goBack: () => Promise<void | NavigationFailure | undefined>) => void;
-    waypointOptions: {
-        threshold: number;
-    };
-    MENU_WIDTH: string;
-};

package/lib/types/templateActions.d.ts

@@ -1,10 +0,0 @@
-export declare enum TemplateActions {
-    Copy = "duplicate",
-    Share = "share",
-    CreateTemplate = "createTemplate",
-    Delete = "delete",
-    Revisions = "revisions",
-    Insights = "insights",
-    Edit = "edit",
-    Preview = "preview"
-}

package/lib/util/gesture.util.d.ts

@@ -1,6 +0,0 @@
-export declare function setupPinchGesture({ target, onPinchIn, onPinchOut, touches, }: {
-    target: HTMLElement | Window;
-    onPinchIn: () => void;
-    onPinchOut: () => void;
-    touches?: number;
-}): () => void;