@pitcher/js-api 1.22.0-alpha.4 → 1.22.0-alpha.6

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

@@ -11,5 +11,5 @@ export declare const useCanvasesAsInfinity: (params: MaybeRef<GetCanvasesParams>
 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>;
+export declare const useCanvasById: (id: MaybeRef<Canvas["id"]>) => import('@tanstack/vue-query').UseQueryReturnType<Canvas, unknown>;
 export {};

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

@@ -87,8 +87,8 @@ declare const _default: () => {
         readonly favoritesDeleter: FavoritesDeleter | null;
         readonly favoritesSetter: FavoritesSetter | null;
         readonly recentFilesFetcher: RecentFilesFetcher | null;
-        readonly selectDeviceFile?: SelectDeviceFile | null | undefined;
-        readonly metadataTemplateFetcher?: MetadataTemplateFetcher | null | undefined;
+        readonly selectDeviceFile?: SelectDeviceFile | null;
+        readonly metadataTemplateFetcher?: MetadataTemplateFetcher | null;
         readonly itemsMover: ItemsMover | null;
         readonly convertingFileIdsTimeout: {
             readonly ref: () => NodeJS.Timeout;
@@ -100,7 +100,7 @@ declare const _default: () => {
         } | null;
         readonly isUpdatingFolderItems: boolean;
         readonly isFetchingFolderItems: boolean;
-        readonly fetchingFolderId: string;
+        readonly fetchingFolderId: Folder["id"];
         readonly isFetchingSelectedFile: boolean;
         readonly isFetchingSelectedFolder: boolean;
         readonly isFetchingRecentFiles: boolean;
@@ -116,7 +116,7 @@ declare const _default: () => {
         }[];
         readonly files: readonly {
             readonly status: FileStatusEnum;
-            readonly name?: string | undefined;
+            readonly name?: string;
             readonly id: string;
             readonly content_type: import('../../../../types/openapi').FileContentTypeEnum;
             readonly thumbnail_url: string | null;
@@ -124,12 +124,12 @@ declare const _default: () => {
             readonly created_by: {
                 readonly id: number;
                 readonly name: string;
-                readonly email?: string | undefined;
+                readonly email?: string;
             };
             readonly modified_at: string;
         }[];
         readonly recent: readonly {
-            readonly name?: string | undefined;
+            readonly name?: string;
             readonly id: string;
             readonly content_type: import('../../../../types/openapi').FileContentTypeEnum;
             readonly thumbnail_url: string | null;
@@ -138,7 +138,7 @@ declare const _default: () => {
         readonly selectedFile: {
             readonly id: string;
             readonly global_id: string;
-            readonly name?: string | undefined;
+            readonly name?: string;
             readonly type: import('../../../../types/openapi').FileTypeEnum;
             readonly size: number | null;
             readonly status: FileStatusEnum;
@@ -149,10 +149,10 @@ 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 | undefined;
+            readonly download_type?: import('../../../../types/openapi').DownloadTypeEnum;
             readonly zip_size: number | null;
             readonly zip_url: string | null;
-            readonly access_type?: import('../../../../types/openapi').AccessTypeEnum | undefined;
+            readonly access_type?: import('../../../../types/openapi').AccessTypeEnum;
             readonly role: import('../../../../types/openapi').CollaborationRoleEnum;
             readonly pspdfkit_server_url: string | null;
             readonly pspdfkit_auth_payload: {
@@ -166,31 +166,31 @@ declare const _default: () => {
             } | undefined;
             readonly tags?: readonly string[] | undefined;
             readonly published_at: string | null;
-            readonly expires_at?: string | null | undefined;
+            readonly expires_at?: string | null;
             readonly instance_id: string;
-            readonly folder_id?: string | undefined;
+            readonly folder_id?: string;
             readonly shared_link: {
                 readonly url: string;
-                readonly short_url?: string | null | undefined;
+                readonly short_url?: string | null;
             };
             readonly created_at: string;
             readonly created_by: {
                 readonly id: number;
                 readonly name: string;
-                readonly email?: string | undefined;
+                readonly email?: string;
             };
             readonly modified_at: string;
             readonly modified_by: {
                 readonly id: number;
                 readonly name: string;
-                readonly email?: string | undefined;
+                readonly email?: string;
             };
         } | null;
         readonly selectedFolder: {
             readonly id: string;
             readonly name: string;
             readonly instance_id: string;
-            readonly access_type?: import('../../../../types/openapi').AccessTypeEnum | undefined;
+            readonly access_type?: import('../../../../types/openapi').AccessTypeEnum;
             readonly materialized_path: string;
             readonly depth: number;
             readonly files: readonly {
@@ -203,7 +203,7 @@ declare const _default: () => {
                 readonly created_by: {
                     readonly id: number;
                     readonly name: string;
-                    readonly email?: string | undefined;
+                    readonly email?: string;
                 };
                 readonly modified_at: string;
             }[];
@@ -227,13 +227,13 @@ declare const _default: () => {
             readonly created_by: {
                 readonly id: number;
                 readonly name: string;
-                readonly email?: string | undefined;
+                readonly email?: string;
             };
             readonly modified_at: string;
             readonly modified_by: {
                 readonly id: number;
                 readonly name: string;
-                readonly email?: string | undefined;
+                readonly email?: string;
             };
         } | null;
         readonly favorites: {
@@ -249,7 +249,7 @@ declare const _default: () => {
                 } | null;
                 readonly page: {
                     readonly id: string;
-                    readonly page_index?: number | undefined;
+                    readonly page_index?: number;
                 } | null;
                 readonly folder: {
                     readonly id: string;
@@ -259,13 +259,13 @@ declare const _default: () => {
                 readonly created_by: {
                     readonly id: number;
                     readonly name: string;
-                    readonly email?: string | undefined;
+                    readonly email?: string;
                 };
                 readonly modified_at: string;
                 readonly modified_by: {
                     readonly id: number;
                     readonly name: string;
-                    readonly email?: string | undefined;
+                    readonly email?: string;
                 };
             };
         };
@@ -275,8 +275,8 @@ declare const _default: () => {
             readonly files_count: number;
             readonly folders_count: number;
         }[];
-        readonly currentFolderName: string;
-        readonly currentFolderId: string;
+        readonly currentFolderName: Awaited<ReturnType<FolderItemsFetcher>>["name"];
+        readonly currentFolderId: Awaited<ReturnType<FolderItemsFetcher>>["id"];
         readonly sectionFieldsDict: {
             readonly [x: string]: any;
         };
@@ -285,7 +285,7 @@ declare const _default: () => {
     getters: {
         readonly sortedFiles: readonly {
             readonly status: FileStatusEnum;
-            readonly name?: string | undefined;
+            readonly name?: string;
             readonly id: string;
             readonly content_type: import('../../../../types/openapi').FileContentTypeEnum;
             readonly thumbnail_url: string | null;
@@ -293,7 +293,7 @@ declare const _default: () => {
             readonly created_by: {
                 readonly id: number;
                 readonly name: string;
-                readonly email?: string | undefined;
+                readonly email?: string;
             };
             readonly modified_at: string;
         }[];
@@ -372,8 +372,8 @@ declare const _default: () => {
             favoritesDeleter: FavoritesDeleter | null;
             favoritesSetter: FavoritesSetter | null;
             recentFilesFetcher: RecentFilesFetcher | null;
-            selectDeviceFile?: SelectDeviceFile | null | undefined;
-            metadataTemplateFetcher?: MetadataTemplateFetcher | null | undefined;
+            selectDeviceFile?: SelectDeviceFile | null;
+            metadataTemplateFetcher?: MetadataTemplateFetcher | null;
             itemsMover: ItemsMover | null;
             convertingFileIdsTimeout: {
                 ref: () => NodeJS.Timeout;
@@ -385,7 +385,7 @@ declare const _default: () => {
             } | null;
             isUpdatingFolderItems: boolean;
             isFetchingFolderItems: boolean;
-            fetchingFolderId: string;
+            fetchingFolderId: Folder["id"];
             isFetchingSelectedFile: boolean;
             isFetchingSelectedFolder: boolean;
             isFetchingRecentFiles: boolean;
@@ -401,20 +401,20 @@ declare const _default: () => {
             }[];
             files: {
                 readonly status: FileStatusEnum;
-                name?: string | undefined;
+                name?: string;
                 readonly id: string;
                 readonly content_type: import('../../../../types/openapi').FileContentTypeEnum;
                 readonly thumbnail_url: string | null;
-                tags?: string[] | undefined;
+                tags?: Array<string>;
                 readonly created_by: {
                     readonly id: number;
                     readonly name: string;
-                    email?: string | undefined;
+                    email?: string;
                 };
                 readonly modified_at: string;
             }[];
             recent: {
-                name?: string | undefined;
+                name?: string;
                 readonly id: string;
                 readonly content_type: import('../../../../types/openapi').FileContentTypeEnum;
                 readonly thumbnail_url: string | null;
@@ -423,7 +423,7 @@ declare const _default: () => {
             selectedFile: {
                 readonly id: string;
                 readonly global_id: string;
-                name?: string | undefined;
+                name?: string;
                 readonly type: import('../../../../types/openapi').FileTypeEnum;
                 readonly size: number | null;
                 readonly status: FileStatusEnum;
@@ -431,45 +431,45 @@ declare const _default: () => {
                 readonly content_extension: string | null;
                 readonly content_length: number | null;
                 readonly content_url: string | null;
-                readonly content_thumbnails: string[];
+                readonly content_thumbnails: Array<string>;
                 readonly original_extension: string | null;
                 readonly thumbnail_url: string | null;
-                download_type?: import('../../../../types/openapi').DownloadTypeEnum | undefined;
+                download_type?: import('../../../../types/openapi').DownloadTypeEnum;
                 readonly zip_size: number | null;
                 readonly zip_url: string | null;
-                access_type?: import('../../../../types/openapi').AccessTypeEnum | undefined;
+                access_type?: import('../../../../types/openapi').AccessTypeEnum;
                 readonly role: import('../../../../types/openapi').CollaborationRoleEnum;
                 readonly pspdfkit_server_url: string | null;
                 readonly pspdfkit_auth_payload: Record<string, any> | null;
-                metadata?: Record<string, any> | undefined;
-                app_metadata?: Record<string, any> | undefined;
-                tags?: string[] | undefined;
+                metadata?: Record<string, any>;
+                app_metadata?: Record<string, any>;
+                tags?: Array<string>;
                 readonly published_at: string | null;
-                expires_at?: string | null | undefined;
+                expires_at?: string | null;
                 readonly instance_id: string;
-                folder_id?: string | undefined;
+                folder_id?: string;
                 readonly shared_link: {
                     readonly url: string;
-                    short_url?: string | null | undefined;
+                    short_url?: string | null;
                 };
                 readonly created_at: string;
                 readonly created_by: {
                     readonly id: number;
                     readonly name: string;
-                    email?: string | undefined;
+                    email?: string;
                 };
                 readonly modified_at: string;
                 readonly modified_by: {
                     readonly id: number;
                     readonly name: string;
-                    email?: string | undefined;
+                    email?: string;
                 };
             } | null;
             selectedFolder: {
                 readonly id: string;
                 name: string;
                 readonly instance_id: string;
-                access_type?: import('../../../../types/openapi').AccessTypeEnum | undefined;
+                access_type?: import('../../../../types/openapi').AccessTypeEnum;
                 readonly materialized_path: string;
                 readonly depth: number;
                 readonly files: {
@@ -478,16 +478,16 @@ declare const _default: () => {
                     readonly status: FileStatusEnum;
                     readonly content_type: import('../../../../types/openapi').FileContentTypeEnum;
                     readonly thumbnail_url: string;
-                    readonly tags: string[];
+                    readonly tags: Array<string>;
                     readonly created_by: {
                         readonly id: number;
                         readonly name: string;
-                        email?: string | undefined;
+                        email?: string;
                     };
                     readonly modified_at: string;
                 }[];
                 readonly files_count: number;
-                readonly file_thumbnail_urls: string[];
+                readonly file_thumbnail_urls: Array<string>;
                 readonly thumbnail_url: string | null;
                 readonly folders: {
                     readonly id: string;
@@ -506,24 +506,24 @@ declare const _default: () => {
                 readonly created_by: {
                     readonly id: number;
                     readonly name: string;
-                    email?: string | undefined;
+                    email?: string;
                 };
                 readonly modified_at: string;
                 readonly modified_by: {
                     readonly id: number;
                     readonly name: string;
-                    email?: string | undefined;
+                    email?: string;
                 };
             } | null;
-            favorites: Record<string, Favorite>;
+            favorites: Record<MiniPage["id"] | File["id"] | Folder["id"], Favorite>;
             currentFolderPath: {
                 readonly id: string;
                 name: string;
                 readonly files_count: number;
                 readonly folders_count: number;
             }[];
-            currentFolderName: string;
-            currentFolderId: string;
+            currentFolderName: Awaited<ReturnType<FolderItemsFetcher>>["name"];
+            currentFolderId: Awaited<ReturnType<FolderItemsFetcher>>["id"];
             sectionFieldsDict: Record<string, any>;
             searchQuery: string;
         } & {

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

@@ -30,6 +30,9 @@ export type RenderableFile = (Favorite & {
 }) | RecentFile | ViewCompactFileFolder;
 export type AppCurrentState = 'browse' | 'create-folder' | 'upload-files' | 'update-folder' | 'update-file' | 'batch-move';
 export type BrowserSectionType = 'all' | 'favorites' | 'recent' | 'trash';
+type SelectedItemId = Folder['id'] | File['id'] | RecentFile['id'] | (Favorite['page'] extends {
+    id: any;
+} ? Favorite['page']['id'] : never);
 type View = 'grid' | 'table';
 type RecentFileWithFavoriteId = RecentFile & {
     favoriteId: string;
@@ -37,29 +40,29 @@ type RecentFileWithFavoriteId = RecentFile & {
 export default function (): {
     setAppName(appName: AppName): void;
     resetSelectedItems(): void;
-    removeSelectedItems(removeIds: string[]): void;
+    removeSelectedItems(removeIds: SelectedItemId[]): void;
     selectAll(): void;
     toggleSelectAll(value: boolean): void;
-    toggleItemSelection(item: Partial<Favorite | File | Folder>, { isSelected, disableMultiple }?: {
-        isSelected?: boolean | undefined;
-        disableMultiple?: boolean | undefined;
+    toggleItemSelection(item: Partial<File | Folder | Favorite>, { isSelected, disableMultiple }?: {
+        isSelected?: boolean;
+        disableMultiple?: boolean;
     }): void;
-    toggleSingleItemSelection(item: Partial<Favorite | File | Folder>): void;
+    toggleSingleItemSelection(item: Partial<File | Folder | Favorite>): void;
     toggleItemFavorite(item: ViewCompactFileFolder & {
-        favoriteId?: string | undefined;
+        favoriteId?: string;
     }): void;
-    setSelectedSection(section: BrowserSectionType, folderId?: string | undefined): void;
+    setSelectedSection(section: BrowserSectionType, folderId?: string): void;
     toggleSelectedView(): void;
     setSearch(search: string): void;
-    toggleSidebar(isOpen?: boolean | undefined): void;
-    toggleContentPanel(isOpen?: boolean | undefined): void;
+    toggleSidebar(isOpen?: boolean): void;
+    toggleContentPanel(isOpen?: boolean): void;
     selectAndOpenContentPanel(item: ViewCompactFileFolder): void;
-    setCurrentState(stateName: AppCurrentState, itemId?: string | undefined): void;
+    setCurrentState(stateName: AppCurrentState, itemId?: Folder["id"] | File["id"]): void;
     clearFilters(): void;
     clearInlineEditingItem(): void;
-    appName: Ref<"" | AppName>;
+    appName: Ref<AppName | "">;
     currentState: Ref<AppCurrentState>;
-    selectedItemIds: Ref<string[]>;
+    selectedItemIds: Ref<SelectedItemId[]>;
     selectedSection: Ref<BrowserSectionType>;
     selectedView: Ref<View>;
     search: Ref<string>;
@@ -103,9 +106,9 @@ export default function (): {
     };
     isSidebarOpen: Ref<boolean>;
     isContentPanelOpen: Ref<boolean>;
-    updatingFolderId: Ref<string | null>;
-    selectedFileId: ComputedRef<string | null>;
-    selectedFolderId: ComputedRef<string | null>;
+    updatingFolderId: Ref<Folder["id"] | null>;
+    selectedFileId: ComputedRef<File["id"] | null>;
+    selectedFolderId: ComputedRef<Folder["id"] | null>;
     updatingFolder: ComputedRef<MiniFolder | null>;
     inlineEditingItem: Ref<{
         id: string | number;

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

@@ -18,26 +18,26 @@ export default function (): {
                 path: string;
                 size: number;
             };
-            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;
-            app_metadata?: Record<string, any> | undefined;
-            tags?: string[] | undefined;
-            expires_at?: string | null | undefined;
-            folder_id?: string | undefined;
+            type?: import('../../../../types/openapi').FileTypeEnum;
+            metadata?: Record<string, any>;
+            name?: string;
+            download_type?: import('../../../../types/openapi').DownloadTypeEnum;
+            access_type?: AccessTypeEnum;
+            app_metadata?: Record<string, any>;
+            tags?: Array<string>;
+            expires_at?: string | null;
+            folder_id?: string;
             thumbnail?: {
                 readonly size: number;
                 readonly type: string;
                 arrayBuffer: () => Promise<ArrayBuffer>;
-                slice: (start?: number | undefined, end?: number | undefined, contentType?: string | undefined) => Blob;
+                slice: (start?: number, end?: number, contentType?: string) => Blob;
                 stream: () => ReadableStream<Uint8Array>;
                 text: () => Promise<string>;
             } | undefined;
-            is_asset?: boolean | undefined;
-            content_upload_id?: string | undefined;
-            thumbnail_upload_id?: string | undefined;
+            is_asset?: boolean;
+            content_upload_id?: string;
+            thumbnail_upload_id?: string;
         } | {
             id: string;
             isSupported: boolean;
@@ -46,34 +46,34 @@ export default function (): {
             error: string | null;
             cancelErrorMessage: string;
             genericErrorMessage: string;
-            type?: import('../../../../types/openapi').FileTypeEnum | undefined;
-            metadata?: Record<string, any> | undefined;
+            type?: import('../../../../types/openapi').FileTypeEnum;
+            metadata?: Record<string, any>;
             content?: {
                 readonly size: number;
                 readonly type: string;
                 arrayBuffer: () => Promise<ArrayBuffer>;
-                slice: (start?: number | undefined, end?: number | undefined, contentType?: string | undefined) => Blob;
+                slice: (start?: number, end?: number, contentType?: string) => Blob;
                 stream: () => ReadableStream<Uint8Array>;
                 text: () => Promise<string>;
             } | undefined;
-            name?: string | undefined;
-            download_type?: import('../../../../types/openapi').DownloadTypeEnum | undefined;
-            access_type?: AccessTypeEnum | undefined;
-            app_metadata?: Record<string, any> | undefined;
-            tags?: string[] | undefined;
-            expires_at?: string | null | undefined;
-            folder_id?: string | undefined;
+            name?: string;
+            download_type?: import('../../../../types/openapi').DownloadTypeEnum;
+            access_type?: AccessTypeEnum;
+            app_metadata?: Record<string, any>;
+            tags?: Array<string>;
+            expires_at?: string | null;
+            folder_id?: string;
             thumbnail?: {
                 readonly size: number;
                 readonly type: string;
                 arrayBuffer: () => Promise<ArrayBuffer>;
-                slice: (start?: number | undefined, end?: number | undefined, contentType?: string | undefined) => Blob;
+                slice: (start?: number, end?: number, contentType?: string) => Blob;
                 stream: () => ReadableStream<Uint8Array>;
                 text: () => Promise<string>;
             } | undefined;
-            is_asset?: boolean | undefined;
-            content_upload_id?: string | undefined;
-            thumbnail_upload_id?: string | undefined;
+            is_asset?: boolean;
+            content_upload_id?: string;
+            thumbnail_upload_id?: string;
         })[]>;
         isQueueBusy: import('vue').ComputedRef<boolean>;
         uploadSelectedFiles: import('vue').Ref<{
@@ -83,7 +83,7 @@ export default function (): {
             readonly size: number;
             readonly type: string;
             arrayBuffer: () => Promise<ArrayBuffer>;
-            slice: (start?: number | undefined, end?: number | undefined, contentType?: string | undefined) => Blob;
+            slice: (start?: number, end?: number, contentType?: string) => Blob;
             stream: () => ReadableStream<Uint8Array>;
             text: () => Promise<string>;
         }[] | {
@@ -95,7 +95,7 @@ export default function (): {
     };
     actions: {
         addUploads: (uploads: Upload[], onUploadCompleteCb?: any) => void;
-        removeUpload: (id: string) => void;
+        removeUpload: (id: Upload["id"]) => void;
         clearCompletedAndFailed: () => void;
     };
 };