@pitcher/js-api 1.26.0-beta.1 → 1.26.0-beta.2

package/lib/apps/assets-manager/App.vue.d.ts

@@ -0,0 +1,75 @@
+import { AxiosInstance } from 'axios';
+import { File } from '../../../types/openapi';
+export interface AppProps {
+    fileListFetcher?: (params: {
+        filters: Record<string, any>;
+        page_size: number;
+    }) => Promise<File[]>;
+    fileDeleter?: (fileId: string) => Promise<any>;
+    coreRestApiAxios?: AxiosInstance;
+    allowedAssetContentTypes?: string[];
+    enableThemeAssetProtection?: boolean;
+    instanceId?: string;
+    title?: string;
+    showHeader?: boolean;
+}
+declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: {
+        'header-actions'?(_: {}): any;
+    };
+    refs: {
+        assetsTabRef: import('vue').CreateComponentPublicInstanceWithMixins<Readonly<import('./AssetsTab.vue').Props> & Readonly<{}>, {
+            fetchAssets: (afterUpload?: boolean) => Promise<void>;
+            clearFilters: () => void;
+        }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, import('vue').PublicProps, {
+            enableThemeAssetProtection: boolean;
+        }, false, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {}, HTMLDivElement, import('vue').ComponentProvideOptions, {
+            P: {};
+            B: {};
+            D: {};
+            C: {};
+            M: {};
+            Defaults: {};
+        }, Readonly<import('./AssetsTab.vue').Props> & Readonly<{}>, {
+            fetchAssets: (afterUpload?: boolean) => Promise<void>;
+            clearFilters: () => void;
+        }, {}, {}, {}, {
+            enableThemeAssetProtection: boolean;
+        }> | null;
+    };
+    rootEl: HTMLDivElement;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: import('vue').DefineComponent<AppProps, {
+    fetchAssets: () => any;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<AppProps> & Readonly<{}>, {
+    enableThemeAssetProtection: boolean;
+    showHeader: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
+    assetsTabRef: import('vue').CreateComponentPublicInstanceWithMixins<Readonly<import('./AssetsTab.vue').Props> & Readonly<{}>, {
+        fetchAssets: (afterUpload?: boolean) => Promise<void>;
+        clearFilters: () => void;
+    }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, import('vue').PublicProps, {
+        enableThemeAssetProtection: boolean;
+    }, false, {}, {}, import('vue').GlobalComponents, import('vue').GlobalDirectives, string, {}, HTMLDivElement, import('vue').ComponentProvideOptions, {
+        P: {};
+        B: {};
+        D: {};
+        C: {};
+        M: {};
+        Defaults: {};
+    }, Readonly<import('./AssetsTab.vue').Props> & Readonly<{}>, {
+        fetchAssets: (afterUpload?: boolean) => Promise<void>;
+        clearFilters: () => void;
+    }, {}, {}, {}, {
+        enableThemeAssetProtection: boolean;
+    }> | null;
+}, HTMLDivElement>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/lib/apps/assets-manager/AssetsTab.vue.d.ts

@@ -0,0 +1,22 @@
+import { AxiosInstance } from 'axios';
+import { File } from '../../../types/openapi';
+export interface Props {
+    fileListFetcher?: (params: {
+        filters: Record<string, any>;
+        page_size: number;
+    }) => Promise<File[]>;
+    fileDeleter?: (fileId: string) => Promise<void>;
+    coreRestApiAxios?: AxiosInstance;
+    allowedAssetContentTypes?: string[];
+    enableThemeAssetProtection?: boolean;
+    instanceId?: string;
+}
+declare function clearFilters(): void;
+declare function fetchAssets(afterUpload?: boolean): Promise<void>;
+declare const _default: import('vue').DefineComponent<Props, {
+    fetchAssets: typeof fetchAssets;
+    clearFilters: typeof clearFilters;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<Props> & Readonly<{}>, {
+    enableThemeAssetProtection: boolean;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/lib/apps/assets-manager/components/AssetGridItem.vue.d.ts

@@ -0,0 +1,16 @@
+import { File } from '../../../../types/openapi';
+interface GridItemProps {
+    item: File;
+    isDeleteDisabled?: boolean;
+    deleteDisabledTooltip?: string;
+}
+declare const _default: import('vue').DefineComponent<GridItemProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    itemDeleted: (...args: any[]) => void;
+}, string, import('vue').PublicProps, Readonly<GridItemProps> & Readonly<{
+    onItemDeleted?: ((...args: any[]) => any) | undefined;
+}>, {
+    item: File;
+    isDeleteDisabled: boolean;
+    deleteDisabledTooltip: string;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
+export default _default;

package/lib/apps/browser/App.vue.d.ts

@@ -17,7 +17,7 @@ declare function __VLS_template(): {
 };
 type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
 declare const __VLS_component: import('vue').DefineComponent<BrowserAppProps, {
-    onUploadComplete: import('lodash').DebouncedFunc<() => Promise<void>>;
+    onUploadComplete: () => Promise<void> | undefined;
     onFavoritesChanged: (favorites: import('../../../types/openapi').Favorite[]) => void;
     onUploadClearCompletedAndFailed: () => void;
     setSelectedSection: (section: BrowserSectionType, folderId?: string) => void;
@@ -36,6 +36,7 @@ declare const __VLS_component: import('vue').DefineComponent<BrowserAppProps, {
         type: "file";
         thumbnailUrl?: string;
     }) => any;
+    filesDeleted: (ids: string[]) => any;
     onSectionChange: (params: {
         section: BrowserSectionType;
         folderId: string;
@@ -50,6 +51,7 @@ declare const __VLS_component: import('vue').DefineComponent<BrowserAppProps, {
         type: "file";
         thumbnailUrl?: string;
     }) => any) | undefined;
+    onFilesDeleted?: ((ids: string[]) => any) | undefined;
     onOnSectionChange?: ((params: {
         section: BrowserSectionType;
         folderId: string;

package/lib/apps/browser/appTypes.d.ts

@@ -19,4 +19,8 @@ export interface BrowserAppProps {
     onItemsMove: ItemsMover;
     onSelectDeviceFile?: SelectDeviceFile;
     onFolderList: FolderLister;
+    onMetadataFilterFetch?: (params: any) => Promise<Record<string, string | string[]>>;
+    onDeleteCanvases?: (payload: {
+        ids: string[];
+    }) => Promise<any>;
 }

package/lib/apps/browser/components/UploadFilesModal/UploadFilesModal.vue.d.ts

@@ -33,14 +33,16 @@ declare const _default: import('vue').DefineComponent<{}, {}, {}, {}, {}, import
     }>, {
         validate: () => Promise<{
             config: Record<string, any>;
-            success: boolean;
+            success: true;
             errors?: undefined;
+            firstErrorFieldName?: undefined;
         } | {
             config: Record<string, any>;
             errors: unknown;
-            success: boolean;
+            firstErrorFieldName: string | undefined;
+            success: false;
         }>;
-    }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
+    }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
         change: (config: Record<string, any>) => any;
     }, import('vue').PublicProps, {
         loading: boolean;
@@ -355,12 +357,14 @@ declare const _default: import('vue').DefineComponent<{}, {}, {}, {}, {}, import
     }>, {
         validate: () => Promise<{
             config: Record<string, any>;
-            success: boolean;
+            success: true;
             errors?: undefined;
+            firstErrorFieldName?: undefined;
         } | {
             config: Record<string, any>;
             errors: unknown;
-            success: boolean;
+            firstErrorFieldName: string | undefined;
+            success: false;
         }>;
     }, {}, {}, {}, {
         loading: boolean;

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

@@ -112,10 +112,12 @@ declare const _default: () => {
         readonly itemsMover: ItemsMover | null;
         readonly folderLister: FolderLister | null;
         readonly convertingFileIdsTimeout: {
-            readonly ref: () => NodeJS.Timeout;
-            readonly unref: () => NodeJS.Timeout;
+            readonly close: () => NodeJS.Timeout;
             readonly hasRef: () => boolean;
+            readonly ref: () => NodeJS.Timeout;
             readonly refresh: () => NodeJS.Timeout;
+            readonly unref: () => NodeJS.Timeout;
+            readonly _onTimeout: (...args: any[]) => void;
             readonly [Symbol.toPrimitive]: () => number;
             readonly [Symbol.dispose]: () => void;
         } | null;
@@ -135,6 +137,8 @@ declare const _default: () => {
             readonly thumbnail_url: string | null;
             readonly folders_count: number;
             readonly files_count: number;
+            readonly available_files_count: number;
+            readonly available_folders_count: number;
             readonly file_thumbnail_urls: readonly string[];
             readonly canvases_count: number;
             readonly canvas_thumbnail_urls: readonly string[];
@@ -208,8 +212,6 @@ declare const _default: () => {
                 readonly [x: string]: any;
             } | undefined;
             readonly tags?: readonly string[] | undefined;
-            readonly transcript?: string | undefined;
-            readonly search: string | null;
             readonly published_at: string | null;
             readonly expires_at?: string | null | undefined;
             readonly instance_id: string;
@@ -255,23 +257,28 @@ declare const _default: () => {
                 readonly name: string;
                 readonly email?: string | undefined;
             };
+            readonly file_thumbnail_urls: readonly string[];
+            readonly thumbnail_url: string | null;
             readonly path: readonly {
                 readonly id: string;
                 readonly name: string;
                 readonly thumbnail_url: string | null;
                 readonly folders_count: number;
                 readonly files_count: number;
+                readonly available_files_count: number;
+                readonly available_folders_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 available_files_count: number;
+                readonly available_folders_count: number;
                 readonly file_thumbnail_urls: readonly string[];
                 readonly canvases_count: number;
                 readonly canvas_thumbnail_urls: readonly string[];
@@ -382,6 +389,8 @@ declare const _default: () => {
             readonly thumbnail_url: string | null;
             readonly folders_count: number;
             readonly files_count: number;
+            readonly available_files_count: number;
+            readonly available_folders_count: number;
             readonly file_thumbnail_urls: readonly string[];
             readonly canvases_count: number;
             readonly canvas_thumbnail_urls: readonly string[];
@@ -510,7 +519,7 @@ declare const _default: () => {
         setSearchMetadataFilters: typeof setSearchMetadataFilters;
         setFilteredItems: typeof setFilteredItems;
         onUpsertFolder: typeof onUpsertFolder;
-        onUploadFilesRefetchFolder: import('lodash').DebouncedFunc<() => Promise<void>>;
+        onUploadFilesRefetchFolder: () => Promise<void> | undefined;
         clearTimeouts: typeof clearTimeouts;
         reset: () => {
             fileOpener: FileOpener | null;
@@ -537,10 +546,12 @@ declare const _default: () => {
             itemsMover: ItemsMover | null;
             folderLister: FolderLister | null;
             convertingFileIdsTimeout: {
-                ref: () => NodeJS.Timeout;
-                unref: () => NodeJS.Timeout;
+                close: () => NodeJS.Timeout;
                 hasRef: () => boolean;
+                ref: () => NodeJS.Timeout;
                 refresh: () => NodeJS.Timeout;
+                unref: () => NodeJS.Timeout;
+                _onTimeout: (...args: any[]) => void;
                 [Symbol.toPrimitive]: () => number;
                 [Symbol.dispose]: () => void;
             } | null;
@@ -560,6 +571,8 @@ declare const _default: () => {
                 thumbnail_url: string | null;
                 folders_count: number;
                 files_count: number;
+                available_files_count: number;
+                available_folders_count: number;
                 file_thumbnail_urls: Array<string>;
                 canvases_count: number;
                 canvas_thumbnail_urls: Array<string>;
@@ -627,8 +640,6 @@ declare const _default: () => {
                 metadata?: Record<string, any> | undefined;
                 app_metadata?: Record<string, any> | undefined;
                 tags?: Array<string> | undefined;
-                transcript?: string | undefined;
-                readonly search: string | null;
                 readonly published_at: string | null;
                 expires_at?: string | null | undefined;
                 readonly instance_id: string;
@@ -674,23 +685,28 @@ declare const _default: () => {
                     readonly name: string;
                     email?: string | undefined;
                 };
+                readonly file_thumbnail_urls: Array<string>;
+                readonly thumbnail_url: string | null;
                 readonly path: {
                     readonly id: string;
                     name: string;
                     readonly thumbnail_url: string | null;
                     readonly folders_count: number;
                     readonly files_count: number;
+                    readonly available_files_count: number;
+                    readonly available_folders_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 available_files_count: number;
+                    readonly available_folders_count: number;
                     readonly file_thumbnail_urls: Array<string>;
                     readonly canvases_count: number;
                     readonly canvas_thumbnail_urls: Array<string>;
@@ -759,6 +775,8 @@ declare const _default: () => {
                 readonly thumbnail_url: string | null;
                 readonly folders_count: number;
                 readonly files_count: number;
+                readonly available_files_count: number;
+                readonly available_folders_count: number;
                 readonly file_thumbnail_urls: Array<string>;
                 readonly canvases_count: number;
                 readonly canvas_thumbnail_urls: Array<string>;

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

@@ -7,6 +7,7 @@ import { InstanceSettings } from '../../../types/instanceSettings.types';
 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 SortOption = 'nameAsc' | 'nameDesc' | 'modifiedAsc' | 'modifiedDesc';
 export type StateSelectedItem = Partial<File | Folder | Favorite> & {
     type: string | null | undefined;
     thumbnail_url: string | null | undefined;
@@ -27,6 +28,7 @@ type FavoriteExtended = Favorite & {
 };
 export default function (): {
     setAppName(appName: AppName): void;
+    setSortOption(sortOption: SortOption): void;
     resetSelectedItems(): void;
     removeSelectedItems(removeIds: SelectedItemId[]): void;
     selectAll(): void;
@@ -52,6 +54,7 @@ export default function (): {
     selectedItemIds: Ref<SelectedItemId[]>;
     selectedSection: Ref<BrowserSectionType>;
     selectedView: Ref<View>;
+    selectedSortOption: Ref<SortOption>;
     search: Ref<string>;
     displayedFiles: ComputedRef<ViewCompactFile[]>;
     displayedFolders: ComputedRef<ViewCompactFolder[]>;

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

@@ -28,7 +28,6 @@ export default function (): {
             download_type?: import('../../../../types/openapi').DownloadTypeEnum | undefined;
             access_type?: AccessTypeEnum | undefined;
             app_metadata?: Record<string, any> | undefined;
-            transcript?: string | undefined;
             expires_at?: string | null | undefined;
             folder_id?: string | undefined;
             url?: string | undefined;
@@ -39,9 +38,9 @@ export default function (): {
                 readonly size: number;
                 readonly type: string;
                 arrayBuffer: () => Promise<ArrayBuffer>;
-                bytes: () => Promise<Uint8Array>;
+                bytes: () => Promise<Uint8Array<ArrayBuffer>>;
                 slice: (start?: number, end?: number, contentType?: string) => Blob;
-                stream: () => ReadableStream<Uint8Array>;
+                stream: () => ReadableStream<Uint8Array<ArrayBuffer>>;
                 text: () => Promise<string>;
             } | undefined;
             thumbnail_upload_id?: string | undefined;
@@ -56,9 +55,9 @@ export default function (): {
                 readonly size: number;
                 readonly type: string;
                 arrayBuffer: () => Promise<ArrayBuffer>;
-                bytes: () => Promise<Uint8Array>;
+                bytes: () => Promise<Uint8Array<ArrayBuffer>>;
                 slice: (start?: number, end?: number, contentType?: string) => Blob;
-                stream: () => ReadableStream<Uint8Array>;
+                stream: () => ReadableStream<Uint8Array<ArrayBuffer>>;
                 text: () => Promise<string>;
             } | undefined;
             metadata?: Record<string, any> | undefined;
@@ -72,7 +71,6 @@ export default function (): {
             download_type?: import('../../../../types/openapi').DownloadTypeEnum | undefined;
             access_type?: AccessTypeEnum | undefined;
             app_metadata?: Record<string, any> | undefined;
-            transcript?: string | undefined;
             expires_at?: string | null | undefined;
             folder_id?: string | undefined;
             url?: string | undefined;
@@ -83,9 +81,9 @@ export default function (): {
                 readonly size: number;
                 readonly type: string;
                 arrayBuffer: () => Promise<ArrayBuffer>;
-                bytes: () => Promise<Uint8Array>;
+                bytes: () => Promise<Uint8Array<ArrayBuffer>>;
                 slice: (start?: number, end?: number, contentType?: string) => Blob;
-                stream: () => ReadableStream<Uint8Array>;
+                stream: () => ReadableStream<Uint8Array<ArrayBuffer>>;
                 text: () => Promise<string>;
             } | undefined;
             thumbnail_upload_id?: string | undefined;
@@ -114,7 +112,6 @@ export default function (): {
             download_type?: import('../../../../types/openapi').DownloadTypeEnum | undefined;
             access_type?: AccessTypeEnum | undefined;
             app_metadata?: Record<string, any> | undefined;
-            transcript?: string | undefined;
             expires_at?: string | null | undefined;
             folder_id?: string | undefined;
             url?: string | undefined;
@@ -125,9 +122,9 @@ export default function (): {
                 readonly size: number;
                 readonly type: string;
                 arrayBuffer: () => Promise<ArrayBuffer>;
-                bytes: () => Promise<Uint8Array>;
+                bytes: () => Promise<Uint8Array<ArrayBuffer>>;
                 slice: (start?: number, end?: number, contentType?: string) => Blob;
-                stream: () => ReadableStream<Uint8Array>;
+                stream: () => ReadableStream<Uint8Array<ArrayBuffer>>;
                 text: () => Promise<string>;
             } | undefined;
             thumbnail_upload_id?: string | undefined;
@@ -142,9 +139,9 @@ export default function (): {
                 readonly size: number;
                 readonly type: string;
                 arrayBuffer: () => Promise<ArrayBuffer>;
-                bytes: () => Promise<Uint8Array>;
+                bytes: () => Promise<Uint8Array<ArrayBuffer>>;
                 slice: (start?: number, end?: number, contentType?: string) => Blob;
-                stream: () => ReadableStream<Uint8Array>;
+                stream: () => ReadableStream<Uint8Array<ArrayBuffer>>;
                 text: () => Promise<string>;
             } | undefined;
             metadata?: Record<string, any> | undefined;
@@ -158,7 +155,6 @@ export default function (): {
             download_type?: import('../../../../types/openapi').DownloadTypeEnum | undefined;
             access_type?: AccessTypeEnum | undefined;
             app_metadata?: Record<string, any> | undefined;
-            transcript?: string | undefined;
             expires_at?: string | null | undefined;
             folder_id?: string | undefined;
             url?: string | undefined;
@@ -169,9 +165,9 @@ export default function (): {
                 readonly size: number;
                 readonly type: string;
                 arrayBuffer: () => Promise<ArrayBuffer>;
-                bytes: () => Promise<Uint8Array>;
+                bytes: () => Promise<Uint8Array<ArrayBuffer>>;
                 slice: (start?: number, end?: number, contentType?: string) => Blob;
-                stream: () => ReadableStream<Uint8Array>;
+                stream: () => ReadableStream<Uint8Array<ArrayBuffer>>;
                 text: () => Promise<string>;
             } | undefined;
             thumbnail_upload_id?: string | undefined;
@@ -184,9 +180,9 @@ export default function (): {
             readonly size: number;
             readonly type: string;
             arrayBuffer: () => Promise<ArrayBuffer>;
-            bytes: () => Promise<Uint8Array>;
+            bytes: () => Promise<Uint8Array<ArrayBuffer>>;
             slice: (start?: number, end?: number, contentType?: string) => Blob;
-            stream: () => ReadableStream<Uint8Array>;
+            stream: () => ReadableStream<Uint8Array<ArrayBuffer>>;
             text: () => Promise<string>;
         }[] | {
             name: string;
@@ -200,9 +196,9 @@ export default function (): {
             readonly size: number;
             readonly type: string;
             arrayBuffer: () => Promise<ArrayBuffer>;
-            bytes: () => Promise<Uint8Array>;
+            bytes: () => Promise<Uint8Array<ArrayBuffer>>;
             slice: (start?: number, end?: number, contentType?: string) => Blob;
-            stream: () => ReadableStream<Uint8Array>;
+            stream: () => ReadableStream<Uint8Array<ArrayBuffer>>;
             text: () => Promise<string>;
         }[] | {
             name: string;

package/lib/apps/browser/types/actionKeys.d.ts

@@ -0,0 +1,22 @@
+export declare enum ActionKeys {
+    ViewFile = "viewFile",
+    ViewFileNewTab = "viewFileNewTab",
+    ViewFolder = "viewFolder",
+    ViewFolderNewTab = "viewFolderNewTab",
+    AddToFavorites = "addToFavorites",
+    RemoveFromFavorites = "removeFromFavorites",
+    ViewFileDetails = "viewFileDetails",
+    ViewFolderDetails = "viewFolderDetails",
+    OpenDetailsPanel = "openFileDetailsPanel",
+    Move = "move",
+    Edit = "edit",
+    Copy = "copy",
+    Share = "share",
+    DeleteFile = "deleteFile",
+    DeleteFolder = "deleteFolder",
+    RenameFolder = "renameFolder",
+    RenameFile = "renameFile",
+    EditFileTags = "editFileTags",
+    GenerateKeypoints = "generateKeypoints",
+    AddToSharebox = "addToSharebox"
+}