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

package/lib/api/canvases/canvases.queries.d.ts

@@ -1,15 +1,15 @@
-import { Canvas } from '../../../types/openapi';
+import { CanvasRetrieve } from '../../../types/openapi';
 import { GetCanvasesParams } from '../../types/canvases';
 import { PaginatedData } from '../../types/paginatedData';
 import { MaybeRef } from '@vueuse/core';
 
 export declare const CANVASES = "canvases";
 type Options = {
-    apiFn?: (params: GetCanvasesParams) => Promise<PaginatedData<Canvas>>;
+    apiFn?: (params: GetCanvasesParams) => Promise<PaginatedData<CanvasRetrieve>>;
 };
-export declare const useCanvasesAsInfinity: (params: MaybeRef<GetCanvasesParams>, options?: Options) => import('@tanstack/vue-query').UseInfiniteQueryReturnType<PaginatedData<Canvas>, unknown>;
+export declare const useCanvasesAsInfinity: (params: MaybeRef<GetCanvasesParams>, options?: Options) => import('@tanstack/vue-query').UseInfiniteQueryReturnType<PaginatedData<CanvasRetrieve>, unknown>;
 export declare const useFetchCanvases: (params: MaybeRef<GetCanvasesParams>, options?: {
     enabled?: boolean;
-}) => import('@tanstack/vue-query').UseQueryReturnType<PaginatedData<Canvas>, unknown>;
-export declare const useCanvasById: (id: MaybeRef<Canvas["id"]>) => import('@tanstack/vue-query').UseQueryReturnType<Canvas, unknown>;
+}) => import('@tanstack/vue-query').UseQueryReturnType<PaginatedData<CanvasRetrieve>, unknown>;
+export declare const useCanvasById: (id: MaybeRef<CanvasRetrieve["id"]>) => import('@tanstack/vue-query').UseQueryReturnType<CanvasRetrieve, unknown>;
 export {};

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

@@ -1,9 +1,11 @@
-import { Folder, FileRetrieve, FolderRetrieve, MiniFile, MiniPage, FolderFolder as CompactFolder, File, FavoriteCreateRequest, Favorite, FolderCreateRequest, FolderUpdateRequest, FileUpdateRequest, MetadataTemplate, BulkDeleteRequest, BulkDeleteResponse, FileStatusEnum } from '../../../../types/openapi';
+import { Folder, FileRetrieve, FolderRetrieve, MiniFile, MiniPage, FolderFolder, File, FavoriteCreateRequest, Favorite, FolderCreateRequest, FolderUpdateRequest, FileUpdateRequest, MetadataTemplate, BulkDeleteRequest, BulkDeleteResponse, FileStatusEnum } from '../../../../types/openapi';
 import { GetFavoritesParams } from '../../../types/favorites';
 import { PaginatedData } from '../../../types/paginatedData';
 import { AllFileCreateRequest, DeviceFile } from '../../../types/files';
 import { RecentFile } from '../../../types/recentFiles.types';
+import { Mutable } from '../../../types/ts';
 
+type CompactFolder = Mutable<FolderFolder>;
 type FolderItemsFetcher = (folderId: Folder['id'] | undefined, options?: {
     justFetch: boolean;
     setSelectedFolder: boolean;
@@ -87,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;
@@ -111,12 +113,16 @@ declare const _default: () => {
         readonly folders: readonly {
             readonly id: string;
             readonly name: string;
-            readonly files_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;
@@ -124,24 +130,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 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;
+            readonly version: {
+                readonly id: string;
+                readonly comment: string;
+                readonly created_at: string;
+            };
             readonly content_type: import('../../../../types/openapi').FileContentTypeEnum;
             readonly content_extension: string | null;
             readonly content_length: number | null;
@@ -149,11 +161,15 @@ 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 | undefined;
+                readonly can_share?: boolean | undefined;
+            } | undefined;
             readonly pspdfkit_server_url: string | null;
             readonly pspdfkit_auth_payload: {
                 readonly [x: string]: any;
@@ -166,33 +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 | 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 | 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;
@@ -200,40 +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 | undefined;
                 };
                 readonly modified_at: string;
             }[];
-            readonly files_count: number;
-            readonly file_thumbnail_urls: readonly string[];
-            readonly thumbnail_url: string | null;
-            readonly folders: readonly {
-                readonly id: string;
-                readonly name: string;
-                readonly files_count: number;
-                readonly folders_count: number;
-            }[];
-            readonly folders_count: number;
-            readonly path: readonly {
+            readonly canvases: readonly {
                 readonly id: string;
                 readonly name: string;
-                readonly files_count: number;
-                readonly folders_count: number;
+                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: {
@@ -249,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;
@@ -259,21 +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 | undefined;
                 };
             };
         };
         readonly currentFolderPath: readonly {
             readonly id: string;
             readonly name: string;
-            readonly files_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"];
@@ -285,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;
@@ -293,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;
         }[];
@@ -372,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;
@@ -394,39 +463,49 @@ declare const _default: () => {
             isDeletingFavorite: boolean;
             isMetadataTemplateLoaded: boolean;
             folders: {
-                readonly id: string;
+                id: string;
                 name: string;
-                readonly files_count: number;
-                readonly 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;
+                readonly version: {
+                    readonly id: string;
+                    readonly comment: string;
+                    readonly created_at: string;
+                };
                 readonly content_type: import('../../../../types/openapi').FileContentTypeEnum;
                 readonly content_extension: string | null;
                 readonly content_length: number | null;
@@ -434,44 +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 | 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 | 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 | 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;
@@ -479,48 +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 | undefined;
                     };
                     readonly modified_at: string;
                 }[];
-                readonly files_count: number;
-                readonly file_thumbnail_urls: Array<string>;
-                readonly thumbnail_url: string | null;
-                readonly folders: {
+                readonly canvases: {
                     readonly id: string;
                     name: string;
-                    readonly files_count: number;
-                    readonly folders_count: number;
-                }[];
-                readonly folders_count: number;
-                readonly path: {
-                    readonly id: string;
-                    name: string;
-                    readonly files_count: number;
-                    readonly folders_count: number;
+                    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 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

@@ -1,35 +1,16 @@
 import { Ref, ComputedRef } from 'vue';
 import { File, Folder, Favorite, MiniFolder, FileContentTypeEnum, FileStatusEnum } from '../../../../types/openapi';
-import { CompactFile, CompactFolder } from '@browser/stores/api';
 import { RecentFile } from '../../../types/recentFiles.types';
+import { ViewCompactFile, ViewCompactFileFolder, ViewCompactFolder } from '../../../types/files';
 
 export type AppName = 'admin' | 'impact';
-export declare enum ViewCompactItemType {
-    File = "file",
-    Folder = "folder"
-}
-export type ViewCompactFolder = Omit<CompactFolder, 'created_by'> & {
-    type: ViewCompactItemType.Folder;
-    favoriteId?: Favorite['id'];
-    content_type?: null;
-    thubmnail_url?: null;
-    file_thumbnail_urls?: string[];
-    folders_count?: number;
-    files_count?: number;
-};
-export type ViewCompactFile = Omit<CompactFile, 'created_by'> & {
-    type: ViewCompactItemType.File;
-    favoriteId?: Favorite['id'];
-    createdBy: string;
-    content_type?: string;
-};
-export type ViewCompactFileFolder = ViewCompactFolder | ViewCompactFile;
-export type RenderableFile = (Favorite & {
-    thumbnail_url?: string;
-    file_thumbnail_urls?: string[];
-}) | RecentFile | ViewCompactFileFolder;
 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);
@@ -43,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;