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

package/lib/apps/browser/stores/api.d.ts

@@ -89,8 +89,8 @@ declare const _default: () => {
         readonly favoritesDeleter: FavoritesDeleter | null;
         readonly favoritesSetter: FavoritesSetter | null;
         readonly recentFilesFetcher: RecentFilesFetcher | null;
-        readonly selectDeviceFile?: SelectDeviceFile | null;
-        readonly metadataTemplateFetcher?: MetadataTemplateFetcher | null;
+        readonly selectDeviceFile?: (SelectDeviceFile | null) | undefined;
+        readonly metadataTemplateFetcher?: (MetadataTemplateFetcher | null) | undefined;
         readonly itemsMover: ItemsMover | null;
         readonly convertingFileIdsTimeout: {
             readonly ref: () => NodeJS.Timeout;
@@ -113,14 +113,16 @@ declare const _default: () => {
         readonly folders: readonly {
             readonly id: string;
             readonly 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: readonly string[];
+            readonly canvases_count: number;
+            readonly canvas_thumbnail_urls: readonly string[];
         }[];
         readonly files: readonly {
             readonly status: FileStatusEnum;
-            readonly name?: string;
+            readonly name?: string | undefined;
             readonly id: string;
             readonly content_type: import('../../../../types/openapi').FileContentTypeEnum;
             readonly thumbnail_url: string | null;
@@ -128,21 +130,22 @@ declare const _default: () => {
             readonly created_by: {
                 readonly id: number;
                 readonly name: string;
-                readonly email?: string;
+                readonly email?: string | undefined;
             };
             readonly modified_at: string;
         }[];
         readonly recent: readonly {
-            readonly name?: string;
+            readonly name?: string | undefined;
             readonly id: string;
             readonly content_type: import('../../../../types/openapi').FileContentTypeEnum;
-            readonly thumbnail_url: string | null;
             readonly instance_id: string;
+            readonly tags?: Readonly<File["tags"]>;
+            readonly thumbnail_url?: (string | null) | undefined;
         }[];
         readonly selectedFile: {
             readonly id: string;
             readonly global_id: string;
-            readonly name?: string;
+            readonly name?: string | undefined;
             readonly type: import('../../../../types/openapi').FileTypeEnum;
             readonly size: number | null;
             readonly status: FileStatusEnum;
@@ -158,14 +161,14 @@ declare const _default: () => {
             readonly content_thumbnails: readonly string[];
             readonly original_extension: string | null;
             readonly thumbnail_url: string | null;
-            readonly download_type?: import('../../../../types/openapi').DownloadTypeEnum;
+            readonly download_type?: import('../../../../types/openapi').DownloadTypeEnum | undefined;
             readonly zip_size: number | null;
             readonly zip_url: string | null;
-            readonly access_type?: import('../../../../types/openapi').AccessTypeEnum;
+            readonly access_type?: import('../../../../types/openapi').AccessTypeEnum | undefined;
             readonly role: import('../../../../types/openapi').CollaborationRoleEnum;
             readonly permissions?: {
-                readonly can_download?: boolean;
-                readonly can_share?: boolean;
+                readonly can_download?: boolean | undefined;
+                readonly can_share?: boolean | undefined;
             } | undefined;
             readonly pspdfkit_server_url: string | null;
             readonly pspdfkit_auth_payload: {
@@ -179,43 +182,67 @@ declare const _default: () => {
             } | undefined;
             readonly tags?: readonly string[] | undefined;
             readonly published_at: string | null;
-            readonly expires_at?: string | null;
+            readonly expires_at?: (string | null) | undefined;
             readonly instance_id: string;
-            readonly folder_id?: string;
+            readonly folder_id?: string | undefined;
             readonly shared_link: {
                 readonly url: string;
-                readonly short_url?: string | null;
+                readonly short_url?: (string | null) | undefined;
             };
             readonly owned_by: {
                 readonly id: number;
                 readonly name: string;
-                readonly email?: string;
+                readonly email?: string | undefined;
             };
             readonly created_at: string;
             readonly created_by: {
                 readonly id: number;
                 readonly name: string;
-                readonly email?: string;
+                readonly email?: string | undefined;
             };
             readonly modified_at: string;
             readonly modified_by: {
                 readonly id: number;
                 readonly name: string;
-                readonly email?: string;
+                readonly email?: string | undefined;
             };
         } | null;
         readonly selectedFolder: {
             readonly id: string;
             readonly name: string;
-            readonly instance_id: string;
-            readonly access_type?: import('../../../../types/openapi').AccessTypeEnum;
-            readonly materialized_path: string;
-            readonly depth: number;
+            readonly content_type: string;
+            readonly access_type?: import('../../../../types/openapi').AccessTypeEnum | undefined;
+            readonly rules?: readonly {
+                readonly field: string;
+                readonly operator: import('../../../../types/openapi').OperatorEnum;
+                readonly value: string;
+            }[] | undefined;
             readonly owned_by: {
                 readonly id: number;
                 readonly name: string;
-                readonly email?: string;
+                readonly email?: string | undefined;
             };
+            readonly path: readonly {
+                readonly id: string;
+                readonly name: string;
+                readonly thumbnail_url: string | null;
+                readonly folders_count: number;
+                readonly files_count: number;
+                readonly file_thumbnail_urls: readonly string[];
+                readonly canvases_count: number;
+                readonly canvas_thumbnail_urls: readonly string[];
+            }[];
+            readonly thumbnail_url: string | null;
+            readonly folders: readonly {
+                readonly id: string;
+                readonly name: string;
+                readonly thumbnail_url: string | null;
+                readonly folders_count: number;
+                readonly files_count: number;
+                readonly file_thumbnail_urls: readonly string[];
+                readonly canvases_count: number;
+                readonly canvas_thumbnail_urls: readonly string[];
+            }[];
             readonly files: readonly {
                 readonly id: string;
                 readonly name: string;
@@ -223,49 +250,50 @@ declare const _default: () => {
                 readonly content_type: import('../../../../types/openapi').FileContentTypeEnum;
                 readonly thumbnail_url: string;
                 readonly tags: readonly string[];
+                readonly permissions?: {
+                    readonly can_download?: boolean | undefined;
+                    readonly can_share?: boolean | undefined;
+                } | undefined;
                 readonly created_by: {
                     readonly id: number;
                     readonly name: string;
-                    readonly email?: string;
+                    readonly email?: string | undefined;
                 };
                 readonly owned_by: {
                     readonly id: number;
                     readonly name: string;
-                    readonly email?: string;
+                    readonly email?: string | undefined;
                 };
                 readonly modified_at: string;
             }[];
-            readonly files_count: number;
-            readonly file_thumbnail_urls: readonly string[];
-            readonly thumbnail_url: string | null;
-            readonly folders: readonly {
+            readonly canvases: readonly {
                 readonly id: string;
                 readonly name: string;
-                readonly files_count: number;
-                readonly folders_count: number;
-                readonly thumbnail_url: string | null;
-                readonly file_thumbnail_urls: readonly string[];
-            }[];
-            readonly folders_count: number;
-            readonly path: readonly {
-                readonly id: string;
-                readonly name: string;
-                readonly files_count: number;
-                readonly folders_count: number;
-                readonly thumbnail_url: string | null;
-                readonly file_thumbnail_urls: readonly string[];
+                readonly thumbnail_url?: (string | null) | undefined;
+                readonly tags: readonly string[];
+                readonly created_by: {
+                    readonly id: number;
+                    readonly name: string;
+                    readonly email?: string | undefined;
+                };
+                readonly owned_by: {
+                    readonly id: number;
+                    readonly name: string;
+                    readonly email?: string | undefined;
+                };
+                readonly modified_at: string;
             }[];
             readonly created_at: string;
             readonly created_by: {
                 readonly id: number;
                 readonly name: string;
-                readonly email?: string;
+                readonly email?: string | undefined;
             };
             readonly modified_at: string;
             readonly modified_by: {
                 readonly id: number;
                 readonly name: string;
-                readonly email?: string;
+                readonly email?: string | undefined;
             };
         } | null;
         readonly favorites: {
@@ -281,7 +309,7 @@ declare const _default: () => {
                 } | null;
                 readonly page: {
                     readonly id: string;
-                    readonly page_index?: number;
+                    readonly page_index?: number | undefined;
                 } | null;
                 readonly folder: {
                     readonly id: string;
@@ -291,28 +319,30 @@ declare const _default: () => {
                 readonly created_by: {
                     readonly id: number;
                     readonly name: string;
-                    readonly email?: string;
+                    readonly email?: string | undefined;
                 };
                 readonly modified_at: string;
                 readonly modified_by: {
                     readonly id: number;
                     readonly name: string;
-                    readonly email?: string;
+                    readonly email?: string | undefined;
                 };
                 readonly owned_by: {
                     readonly id: number;
                     readonly name: string;
-                    readonly email?: string;
+                    readonly email?: string | undefined;
                 };
             };
         };
         readonly currentFolderPath: readonly {
             readonly id: string;
             readonly 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: readonly string[];
+            readonly canvases_count: number;
+            readonly canvas_thumbnail_urls: readonly string[];
         }[];
         readonly currentFolderName: Awaited<ReturnType<FolderItemsFetcher>>["name"];
         readonly currentFolderId: Awaited<ReturnType<FolderItemsFetcher>>["id"];
@@ -324,7 +354,7 @@ declare const _default: () => {
     getters: {
         readonly sortedFiles: readonly {
             readonly status: FileStatusEnum;
-            readonly name?: string;
+            readonly name?: string | undefined;
             readonly id: string;
             readonly content_type: import('../../../../types/openapi').FileContentTypeEnum;
             readonly thumbnail_url: string | null;
@@ -332,7 +362,7 @@ declare const _default: () => {
             readonly created_by: {
                 readonly id: number;
                 readonly name: string;
-                readonly email?: string;
+                readonly email?: string | undefined;
             };
             readonly modified_at: string;
         }[];
@@ -411,8 +441,8 @@ declare const _default: () => {
             favoritesDeleter: FavoritesDeleter | null;
             favoritesSetter: FavoritesSetter | null;
             recentFilesFetcher: RecentFilesFetcher | null;
-            selectDeviceFile?: SelectDeviceFile | null;
-            metadataTemplateFetcher?: MetadataTemplateFetcher | null;
+            selectDeviceFile?: (SelectDeviceFile | null) | undefined;
+            metadataTemplateFetcher?: (MetadataTemplateFetcher | null) | undefined;
             itemsMover: ItemsMover | null;
             convertingFileIdsTimeout: {
                 ref: () => NodeJS.Timeout;
@@ -435,36 +465,39 @@ declare const _default: () => {
             folders: {
                 id: string;
                 name: string;
-                files_count: number;
-                folders_count: number;
                 thumbnail_url: string | null;
+                folders_count: number;
+                files_count: number;
                 file_thumbnail_urls: Array<string>;
+                canvases_count: number;
+                canvas_thumbnail_urls: Array<string>;
             }[];
             files: {
                 readonly status: FileStatusEnum;
-                name?: string;
+                name?: string | undefined;
                 readonly id: string;
                 readonly content_type: import('../../../../types/openapi').FileContentTypeEnum;
                 readonly thumbnail_url: string | null;
-                tags?: Array<string>;
+                tags?: Array<string> | undefined;
                 readonly created_by: {
                     readonly id: number;
                     readonly name: string;
-                    email?: string;
+                    email?: string | undefined;
                 };
                 readonly modified_at: string;
             }[];
             recent: {
-                name?: string;
+                name?: string | undefined;
                 readonly id: string;
                 readonly content_type: import('../../../../types/openapi').FileContentTypeEnum;
-                readonly thumbnail_url: string | null;
                 readonly instance_id: string;
+                tags?: Readonly<File["tags"]>;
+                thumbnail_url?: (string | null) | undefined;
             }[];
             selectedFile: {
                 readonly id: string;
                 readonly global_id: string;
-                name?: string;
+                name?: string | undefined;
                 readonly type: import('../../../../types/openapi').FileTypeEnum;
                 readonly size: number | null;
                 readonly status: FileStatusEnum;
@@ -480,58 +513,82 @@ declare const _default: () => {
                 readonly content_thumbnails: Array<string>;
                 readonly original_extension: string | null;
                 readonly thumbnail_url: string | null;
-                download_type?: import('../../../../types/openapi').DownloadTypeEnum;
+                download_type?: import('../../../../types/openapi').DownloadTypeEnum | undefined;
                 readonly zip_size: number | null;
                 readonly zip_url: string | null;
-                access_type?: import('../../../../types/openapi').AccessTypeEnum;
+                access_type?: import('../../../../types/openapi').AccessTypeEnum | undefined;
                 readonly role: import('../../../../types/openapi').CollaborationRoleEnum;
                 permissions?: {
-                    can_download?: boolean;
-                    can_share?: boolean;
+                    can_download?: boolean | undefined;
+                    can_share?: boolean | undefined;
                 } | undefined;
                 readonly pspdfkit_server_url: string | null;
                 readonly pspdfkit_auth_payload: Record<string, any> | null;
-                metadata?: Record<string, any>;
-                app_metadata?: Record<string, any>;
-                tags?: Array<string>;
+                metadata?: Record<string, any> | undefined;
+                app_metadata?: Record<string, any> | undefined;
+                tags?: Array<string> | undefined;
                 readonly published_at: string | null;
-                expires_at?: string | null;
+                expires_at?: (string | null) | undefined;
                 readonly instance_id: string;
-                folder_id?: string;
+                folder_id?: string | undefined;
                 readonly shared_link: {
                     readonly url: string;
-                    short_url?: string | null;
+                    short_url?: (string | null) | undefined;
                 };
                 readonly owned_by: {
                     readonly id: number;
                     readonly name: string;
-                    email?: string;
+                    email?: string | undefined;
                 };
                 readonly created_at: string;
                 readonly created_by: {
                     readonly id: number;
                     readonly name: string;
-                    email?: string;
+                    email?: string | undefined;
                 };
                 readonly modified_at: string;
                 readonly modified_by: {
                     readonly id: number;
                     readonly name: string;
-                    email?: string;
+                    email?: string | undefined;
                 };
             } | null;
             selectedFolder: {
                 readonly id: string;
                 name: string;
-                readonly instance_id: string;
-                access_type?: import('../../../../types/openapi').AccessTypeEnum;
-                readonly materialized_path: string;
-                readonly depth: number;
+                readonly content_type: string;
+                access_type?: import('../../../../types/openapi').AccessTypeEnum | undefined;
+                rules?: {
+                    field: string;
+                    operator: import('../../../../types/openapi').OperatorEnum;
+                    value: string;
+                }[] | undefined;
                 readonly owned_by: {
                     readonly id: number;
                     readonly name: string;
-                    email?: string;
+                    email?: string | undefined;
                 };
+                readonly path: {
+                    readonly id: string;
+                    name: string;
+                    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>;
+                }[];
+                readonly thumbnail_url: string | null;
+                readonly folders: {
+                    readonly id: string;
+                    name: string;
+                    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>;
+                }[];
                 readonly files: {
                     readonly id: string;
                     readonly name: string;
@@ -539,59 +596,62 @@ declare const _default: () => {
                     readonly content_type: import('../../../../types/openapi').FileContentTypeEnum;
                     readonly thumbnail_url: string;
                     readonly tags: Array<string>;
+                    permissions?: {
+                        can_download?: boolean | undefined;
+                        can_share?: boolean | undefined;
+                    } | undefined;
                     readonly created_by: {
                         readonly id: number;
                         readonly name: string;
-                        email?: string;
+                        email?: string | undefined;
                     };
                     readonly owned_by: {
                         readonly id: number;
                         readonly name: string;
-                        email?: string;
+                        email?: string | undefined;
                     };
                     readonly modified_at: string;
                 }[];
-                readonly files_count: number;
-                readonly file_thumbnail_urls: Array<string>;
-                readonly thumbnail_url: string | null;
-                readonly folders: {
-                    readonly id: string;
-                    name: string;
-                    readonly files_count: number;
-                    readonly folders_count: number;
-                    readonly thumbnail_url: string | null;
-                    readonly file_thumbnail_urls: Array<string>;
-                }[];
-                readonly folders_count: number;
-                readonly path: {
+                readonly canvases: {
                     readonly id: string;
                     name: string;
-                    readonly files_count: number;
-                    readonly folders_count: number;
-                    readonly thumbnail_url: string | null;
-                    readonly file_thumbnail_urls: Array<string>;
+                    thumbnail_url?: (string | null) | undefined;
+                    readonly tags: Array<string>;
+                    readonly created_by: {
+                        readonly id: number;
+                        readonly name: string;
+                        email?: string | undefined;
+                    };
+                    readonly owned_by: {
+                        readonly id: number;
+                        readonly name: string;
+                        email?: string | undefined;
+                    };
+                    readonly modified_at: string;
                 }[];
                 readonly created_at: string;
                 readonly created_by: {
                     readonly id: number;
                     readonly name: string;
-                    email?: string;
+                    email?: string | undefined;
                 };
                 readonly modified_at: string;
                 readonly modified_by: {
                     readonly id: number;
                     readonly name: string;
-                    email?: string;
+                    email?: string | undefined;
                 };
             } | null;
             favorites: Record<MiniPage["id"] | File["id"] | Folder["id"], Favorite>;
             currentFolderPath: {
                 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>;
             }[];
             currentFolderName: Awaited<ReturnType<FolderItemsFetcher>>["name"];
             currentFolderId: Awaited<ReturnType<FolderItemsFetcher>>["id"];

package/lib/apps/browser/stores/app.d.ts

@@ -6,6 +6,11 @@ import { ViewCompactFile, ViewCompactFileFolder, ViewCompactFolder } from '../..
 export type AppName = 'admin' | 'impact';
 export type AppCurrentState = 'browse' | 'create-folder' | 'upload-files' | 'update-folder' | 'update-file' | 'batch-move';
 export type BrowserSectionType = 'all' | 'favorites' | 'recent' | 'trash';
+export type StateSelectedItem = Partial<File | Folder | Favorite> & {
+    type: string | null | undefined;
+    thumbnail_url: string | null | undefined;
+    content_type: string | null | undefined;
+};
 type SelectedItemId = Folder['id'] | File['id'] | RecentFile['id'] | (Favorite['page'] extends {
     id: any;
 } ? Favorite['page']['id'] : never);
@@ -19,7 +24,7 @@ export default function (): {
     removeSelectedItems(removeIds: SelectedItemId[]): void;
     selectAll(): void;
     toggleSelectAll(value: boolean): void;
-    toggleItemSelection(item: Partial<File | Folder | Favorite>, { isSelected, disableMultiple }?: {
+    toggleItemSelection(item: StateSelectedItem, { isSelected, disableMultiple }?: {
         isSelected?: boolean;
         disableMultiple?: boolean;
     }): void;

package/lib/apps/browser/stores/upload.d.ts

@@ -18,20 +18,22 @@ export default function (): {
                 path: string;
                 size: number;
             };
-            type?: import('../../../../types/openapi').FileTypeEnum;
-            metadata?: Record<string, any>;
-            name?: string;
-            download_type?: import('../../../../types/openapi').DownloadTypeEnum;
-            access_type?: AccessTypeEnum;
+            type?: import('../../../../types/openapi').FileTypeEnum | undefined;
+            metadata?: Record<string, any> | undefined;
+            name?: string | undefined;
+            download_type?: import('../../../../types/openapi').DownloadTypeEnum | undefined;
+            access_type?: AccessTypeEnum | undefined;
             permissions?: {
-                can_download?: boolean;
-                can_share?: boolean;
+                can_download?: boolean | undefined;
+                can_share?: boolean | undefined;
             } | undefined;
-            app_metadata?: Record<string, any>;
-            tags?: Array<string>;
-            expires_at?: string | null;
-            folder_id?: string;
-            owned_by_id?: number | null;
+            app_metadata?: Record<string, any> | undefined;
+            tags?: Array<string> | undefined;
+            expires_at?: (string | null) | undefined;
+            folder_id?: string | undefined;
+            owned_by_id?: (number | null) | undefined;
+            is_asset?: boolean | undefined;
+            content_upload_id?: string | undefined;
             thumbnail?: {
                 readonly size: number;
                 readonly type: string;
@@ -40,9 +42,7 @@ export default function (): {
                 stream: () => ReadableStream<Uint8Array>;
                 text: () => Promise<string>;
             } | undefined;
-            is_asset?: boolean;
-            content_upload_id?: string;
-            thumbnail_upload_id?: string;
+            thumbnail_upload_id?: string | undefined;
         } | {
             id: string;
             isSupported: boolean;
@@ -51,8 +51,8 @@ export default function (): {
             error: string | null;
             cancelErrorMessage: string;
             genericErrorMessage: string;
-            type?: import('../../../../types/openapi').FileTypeEnum;
-            metadata?: Record<string, any>;
+            type?: import('../../../../types/openapi').FileTypeEnum | undefined;
+            metadata?: Record<string, any> | undefined;
             content?: {
                 readonly size: number;
                 readonly type: string;
@@ -61,18 +61,20 @@ export default function (): {
                 stream: () => ReadableStream<Uint8Array>;
                 text: () => Promise<string>;
             } | undefined;
-            name?: string;
-            download_type?: import('../../../../types/openapi').DownloadTypeEnum;
-            access_type?: AccessTypeEnum;
+            name?: string | undefined;
+            download_type?: import('../../../../types/openapi').DownloadTypeEnum | undefined;
+            access_type?: AccessTypeEnum | undefined;
             permissions?: {
-                can_download?: boolean;
-                can_share?: boolean;
+                can_download?: boolean | undefined;
+                can_share?: boolean | undefined;
             } | undefined;
-            app_metadata?: Record<string, any>;
-            tags?: Array<string>;
-            expires_at?: string | null;
-            folder_id?: string;
-            owned_by_id?: number | null;
+            app_metadata?: Record<string, any> | undefined;
+            tags?: Array<string> | undefined;
+            expires_at?: (string | null) | undefined;
+            folder_id?: string | undefined;
+            owned_by_id?: (number | null) | undefined;
+            is_asset?: boolean | undefined;
+            content_upload_id?: string | undefined;
             thumbnail?: {
                 readonly size: number;
                 readonly type: string;
@@ -81,9 +83,7 @@ export default function (): {
                 stream: () => ReadableStream<Uint8Array>;
                 text: () => Promise<string>;
             } | undefined;
-            is_asset?: boolean;
-            content_upload_id?: string;
-            thumbnail_upload_id?: string;
+            thumbnail_upload_id?: string | undefined;
         })[]>;
         isQueueBusy: import('vue').ComputedRef<boolean>;
         uploadSelectedFiles: import('vue').Ref<{