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

package/lib/types/users.d.ts

@@ -1,12 +1,25 @@
 import { Ref } from 'vue';
 
+/**
+ * Parameters for getting users
+ */
 export interface GetUsersParams {
+    /** Search term, can be a string or a Vue ref to a string */
     search?: Ref<string> | string;
+    /** Filters for the user query, can be any type of Vue ref */
     filters?: Ref<any>;
 }
+/**
+ * Request parameters for refreshing a service token
+ */
 export interface RefreshServiceTokenRequest {
+    /** Optional provider for the service token */
     provider?: string;
 }
+/**
+ * Response from refreshing a service token
+ */
 export interface RefreshServiceTokenResponse {
+    /** The new access token */
     access_token: string;
 }

package/lib/util/fullscreen.util.d.ts

@@ -11,6 +11,6 @@ export type DocumentWithFullscreen = Document & {
     msExitFullscreen?: () => Promise<void>;
 };
 export declare function requestFullscreen(el?: FullscreenElement | null): Promise<void>;
-export declare function exitFullscreen(): void;
+export declare function exitFullscreen(): Promise<void>;
 export declare function toggleFullscreen(element: FullscreenElement): void;
 export declare function isFullscreen(): boolean;

package/lib/util/string.d.ts

@@ -1,4 +1,5 @@
 export declare function highlight(input: string, search: string): string;
 export declare function prefixHttps(url: string): string;
 export declare function stripHtmlTags(htmlString: string | undefined): string;
+export declare function stripHtmlPreservingLineBreaks(htmlString: string | undefined): string;
 export declare function stripHtmlTagsAndTrim(htmlString: string | undefined): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pitcher/js-api",
-  "version": "1.21.0-beta.13",
+  "version": "1.21.0-beta.15",
   "type": "module",
   "main": "js-api.umd.min.js",
   "module": "js-api.esm.js",

package/types/openapi/index.d.ts

@@ -84,7 +84,6 @@ export type { FileCreate } from './models/FileCreate';
 export type { FileCreateRequest } from './models/FileCreateRequest';
 export type { FilePermission } from './models/FilePermission';
 export type { FilePermissionRequest } from './models/FilePermissionRequest';
-export type { FileRequest } from './models/FileRequest';
 export type { FileRetrieve } from './models/FileRetrieve';
 export type { FileRevision } from './models/FileRevision';
 export type { FileRevisionRequest } from './models/FileRevisionRequest';
@@ -94,11 +93,14 @@ export type { FileUpdate } from './models/FileUpdate';
 export type { FileUpdateRequest } from './models/FileUpdateRequest';
 export type { FileVersion } from './models/FileVersion';
 export type { Folder } from './models/Folder';
+export type { FolderCanvas } from './models/FolderCanvas';
 export type { FolderCreate } from './models/FolderCreate';
 export type { FolderCreateRequest } from './models/FolderCreateRequest';
 export type { FolderFile } from './models/FolderFile';
 export type { FolderFolder } from './models/FolderFolder';
 export type { FolderRetrieve } from './models/FolderRetrieve';
+export type { FolderRule } from './models/FolderRule';
+export type { FolderRuleRequest } from './models/FolderRuleRequest';
 export type { FolderUpdate } from './models/FolderUpdate';
 export type { FolderUpdateRequest } from './models/FolderUpdateRequest';
 export type { Instance } from './models/Instance';
@@ -166,6 +168,7 @@ export type { MiniUser } from './models/MiniUser';
 export type { MiniUserRequest } from './models/MiniUserRequest';
 export type { MostActiveUser } from './models/MostActiveUser';
 export type { OfflineSyncFolder } from './models/OfflineSyncFolder';
+export { OperatorEnum } from './models/OperatorEnum';
 export type { Organization } from './models/Organization';
 export type { OrganizationAnalytics } from './models/OrganizationAnalytics';
 export type { OrganizationAnalyticsCurrentPeriod } from './models/OrganizationAnalyticsCurrentPeriod';
@@ -222,10 +225,6 @@ export type { PatchedMetadataTemplateRequest } from './models/PatchedMetadataTem
 export type { PatchedOrganizationUpdateRequest } from './models/PatchedOrganizationUpdateRequest';
 export type { PatchedRegionRequest } from './models/PatchedRegionRequest';
 export type { PatchedUserRequest } from './models/PatchedUserRequest';
-export type { PSPDFKitAuthPayload } from './models/PSPDFKitAuthPayload';
-export type { PSPDFKitAuthPayloadRequest } from './models/PSPDFKitAuthPayloadRequest';
-export type { PSPDFKitToken } from './models/PSPDFKitToken';
-export type { PSPDFKitTokenRequest } from './models/PSPDFKitTokenRequest';
 export type { Region } from './models/Region';
 export type { RegionRequest } from './models/RegionRequest';
 export type { Revision } from './models/Revision';

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

@@ -1,8 +1,10 @@
 /**
  * * `public` - Public
  * * `restricted` - Restricted
+ * * `personal` - Personal
  */
 export declare enum AccessTypeEnum {
     PUBLIC = "public",
-    RESTRICTED = "restricted"
+    RESTRICTED = "restricted",
+    PERSONAL = "personal"
 }

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

@@ -21,6 +21,7 @@ export type Canvas = {
     readonly template: MiniCanvas;
     readonly shared_link: MiniSharedLink;
     account?: Account | null;
+    folder_id?: string | null;
     readonly owned_by: MiniUser;
     readonly created_at: string;
     readonly created_by: MiniUser;

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

@@ -28,6 +28,7 @@ export type CanvasCreate = {
     readonly shared_link: MiniSharedLink;
     account?: Account | null;
     readonly events: Array<MiniEvent>;
+    folder_id?: string | null;
     readonly owned_by: MiniUser;
     readonly created_at: string;
     readonly created_by: MiniUser;

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

@@ -21,5 +21,6 @@ export type CanvasCreateRequest = {
     instance_id: string;
     template_id?: string | null;
     account?: AccountRequest | null;
+    folder_id?: string | null;
     owned_by_id?: number | null;
 };

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

@@ -28,6 +28,7 @@ export type CanvasRetrieve = {
     readonly shared_link: MiniSharedLink;
     account?: Account | null;
     readonly events: Array<MiniEvent>;
+    folder_id?: string | null;
     readonly owned_by: MiniUser;
     readonly created_at: string;
     readonly created_by: MiniUser;

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

@@ -28,6 +28,7 @@ export type CanvasUpdate = {
     readonly shared_link: MiniSharedLink;
     account?: Account | null;
     readonly events: Array<MiniEvent>;
+    folder_id?: string | null;
     readonly owned_by: MiniUser;
     readonly created_at: string;
     readonly created_by: MiniUser;

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

@@ -18,5 +18,6 @@ export type CanvasUpdateRequest = {
     access_type?: AccessTypeEnum;
     thumbnail_url?: string | null;
     account?: AccountRequest | null;
+    folder_id?: string | null;
     owned_by_id?: number | null;
 };

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

@@ -21,6 +21,7 @@ export type DeletedCanvas = {
     readonly template: MiniCanvas;
     readonly shared_link: MiniSharedLink;
     account?: Account | null;
+    folder_id?: string | null;
     readonly owned_by: MiniUser;
     readonly created_at: string;
     readonly created_by: MiniUser;

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

@@ -1,13 +1,13 @@
 import { AccessTypeEnum } from './AccessTypeEnum';
+import { FolderRule } from './FolderRule';
 import { MiniUser } from './MiniUser';
 
 export type DeletedFolder = {
     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;

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

@@ -1,13 +1,13 @@
 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;

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,17 +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;
+    rules?: Array<FolderRule>;
     readonly owned_by: MiniUser;
-    readonly files: Array<FolderFile>;
-    readonly files_count: number;
-    readonly file_thumbnail_urls: Array<string>;
+    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,9 +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,7 @@ 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,8 +1,10 @@
 export type FolderFolder = {
     readonly id: string;
     name: string;
-    readonly files_count: number;
-    readonly folders_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,23 +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;
+    rules?: Array<FolderRule>;
     readonly owned_by: MiniUser;
-    readonly files: Array<FolderFile>;
-    readonly files_count: number;
-    readonly file_thumbnail_urls: Array<string>;
+    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,18 +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;
+    rules?: Array<FolderRule>;
     readonly owned_by: MiniUser;
-    readonly files: Array<FolderFile>;
-    readonly files_count: number;
-    readonly file_thumbnail_urls: Array<string>;
+    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,7 @@ 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/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/PatchedCanvasUpdateRequest.d.ts

@@ -18,5 +18,6 @@ export type PatchedCanvasUpdateRequest = {
     access_type?: AccessTypeEnum;
     thumbnail_url?: string | null;
     account?: AccountRequest | null;
+    folder_id?: string | null;
     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,7 @@ 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/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;

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

@@ -1,16 +0,0 @@
-import { AccessTypeEnum } from './AccessTypeEnum';
-import { DownloadTypeEnum } from './DownloadTypeEnum';
-import { FilePermissionRequest } from './FilePermissionRequest';
-
-export type FileRequest = {
-    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/PSPDFKitAuthPayload.d.ts

@@ -1,3 +0,0 @@
-export type PSPDFKitAuthPayload = {
-    jwt: string;
-};

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

@@ -1,3 +0,0 @@
-export type PSPDFKitAuthPayloadRequest = {
-    jwt: string;
-};

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

@@ -1,7 +0,0 @@
-import { PSPDFKitAuthPayload } from './PSPDFKitAuthPayload';
-
-export type PSPDFKitToken = {
-    readonly documentId: string;
-    readonly authPayload: PSPDFKitAuthPayload;
-    readonly instant: boolean;
-};

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

@@ -1,3 +0,0 @@
-export type PSPDFKitTokenRequest = {
-    file_id: string;
-};