@pitcher/js-api 1.25.0-beta.0 → 1.25.0-beta.2

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

@@ -2,6 +2,7 @@ import { ComputedRef } from 'vue';
 import { BrowserSectionType } from './stores/app';
 import { FileRetrieve, FolderRetrieve } from '../../../types/openapi';
 import { BrowserAppProps } from './appTypes';
+declare function refreshSelectedFolderDetails(folderId?: string): Promise<void> | Promise<FolderRetrieve> | undefined;
 declare function __VLS_template(): {
     attrs: Partial<{}>;
     slots: {
@@ -26,6 +27,7 @@ declare const __VLS_component: import('vue').DefineComponent<BrowserAppProps, {
     folderItemsFetcher: import('vue').Ref<import('./stores/api').FolderItemsFetcher | null, import('./stores/api').FolderItemsFetcher | null>;
     recentFilesFetcher: import('vue').Ref<import('./stores/api').RecentFilesFetcher | null, import('./stores/api').RecentFilesFetcher | null>;
     favoritesFetcher: import('vue').Ref<import('./stores/api').FavoritesFetcher | null, import('./stores/api').FavoritesFetcher | null>;
+    refreshSelectedFolderDetails: typeof refreshSelectedFolderDetails;
 }, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
     viewFileDetails: (id: string) => any;
     generateKeypoints: (id: string) => any;

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

@@ -1,5 +1,5 @@
 import { AppName } from './stores/app';
-import { FolderItemsFetcher, FolderCreator, FolderUpdater, FolderDeleter, FileCreator, FileUpdater, FileOpener, FileFetcher, FileListFetcher, FavoriteCreator, FavoriteDeleter, FavoritesFetcher, RecentFilesFetcher, ItemsMover, SelectDeviceFile, MetadataTemplateFetcher, FileDeleter } from './stores/api';
+import { FolderItemsFetcher, FolderCreator, FolderUpdater, FolderDeleter, FileCreator, FileUpdater, FileOpener, FileFetcher, FileListFetcher, FavoriteCreator, FavoriteDeleter, FavoritesFetcher, RecentFilesFetcher, ItemsMover, SelectDeviceFile, FileDeleter, FolderLister } from './stores/api';
 export interface BrowserAppProps {
     appName: AppName;
     onFolderFetch: FolderItemsFetcher;
@@ -18,5 +18,5 @@ export interface BrowserAppProps {
     onRecentFilesFetch: RecentFilesFetcher;
     onItemsMove: ItemsMover;
     onSelectDeviceFile?: SelectDeviceFile;
-    onMetadataTemplateFetch?: MetadataTemplateFetcher;
+    onFolderList: FolderLister;
 }

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

@@ -1,13 +1,23 @@
-import { Folder, FileRetrieve, FolderRetrieve, MiniFile, MiniPage, FolderFolder, File, FavoriteCreateRequest, Favorite, FolderCreateRequest, FolderUpdateRequest, FileUpdateRequest, MetadataTemplate, BulkDeleteRequest, BulkDeleteResponse, FileStatusEnum } from '../../../../types/openapi';
+import { PaginatedFolderList, Folder, FileRetrieve, FolderRetrieve, MiniFile, MiniPage, FolderFolder, File, FavoriteCreateRequest, Favorite, FolderCreateRequest, FolderUpdateRequest, FileUpdateRequest, BulkDeleteRequest, BulkDeleteResponse, FolderFile, 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';
+import { FolderListRequest } from '../../../sdk/payload.types';
 type CompactFolder = Mutable<FolderFolder>;
+type FolderFileWithFolder = FolderFile & {
+    folder_id?: string;
+} & {
+    folder: {
+        id: string;
+        name: string;
+    };
+};
 type FolderItemsFetcher = (folderId: Folder['id'] | undefined, options?: {
     justFetch: boolean;
     setSelectedFolder: boolean;
+    forceRefresh?: boolean;
 }) => Promise<FolderRetrieve>;
 type FolderCreator = (payload: Omit<FolderCreateRequest, 'instance_id'>) => Promise<FolderRetrieve>;
 type FolderUpdater = (payload: FolderUpdateRequest & {
@@ -16,6 +26,7 @@ type FolderUpdater = (payload: FolderUpdateRequest & {
 type FolderDeleter = (payload: Folder['id']) => Promise<void>;
 type FolderFetcher = (payload: Folder['id']) => Promise<FolderRetrieve>;
 type FoldersDeleter = (payload: BulkDeleteRequest) => Promise<BulkDeleteResponse>;
+type FolderLister = (payload: FolderListRequest) => Promise<PaginatedFolderList>;
 type FileCreator = (payload: Omit<AllFileCreateRequest, 'instance_id'>) => Promise<FileRetrieve>;
 type FileUpdater = (payload: FileUpdateRequest & {
     id: File['id'];
@@ -44,15 +55,15 @@ type ItemsMoverItem = {
     type: 'file' | 'folder';
 };
 type ItemsMover = (folderId: Folder['id'], items: ItemsMoverItem[]) => Promise<FolderRetrieve>;
-type MetadataTemplateFetcher = () => Promise<PaginatedData<MetadataTemplate> | null>;
 declare function setFavorites(favorites: Favorite[]): void;
 declare function setCurrentFolder(folderId?: FolderRetrieve['id'], folderName?: FolderRetrieve['name'], folderPath?: FolderRetrieve['path']): void;
 declare function setSearchQuery(searchQuery: string): void;
 declare function setIsFetchingListFiles(value: boolean): void;
 declare function setSearchMetadataFilters(filters: Record<string, any>): void;
+declare function setFilteredItems(items: FolderFileWithFolder[]): void;
 declare function onUpsertFolder(name: string, initialName?: string): Promise<void>;
 declare function clearTimeouts(): void;
-declare function init({ onFolderFetch, onFolderCreate, onFolderUpdate, onFolderDelete, onFoldersDelete, onFileCreate, onFileUpdate, onFileOpen, onFileDelete, onFilesDelete, onFileFetch, onFilesList, onItemsMove, onFavoriteCreate, onFavoriteDelete, onFavoritesDelete, onFavoritesFetch, onRecentFilesFetch, onSelectDeviceFile, onMetadataTemplateFetch, }: {
+declare function init({ onFolderFetch, onFolderCreate, onFolderUpdate, onFolderDelete, onFoldersDelete, onFileCreate, onFileUpdate, onFileOpen, onFileDelete, onFilesDelete, onFileFetch, onFilesList, onItemsMove, onFavoriteCreate, onFavoriteDelete, onFavoritesDelete, onFavoritesFetch, onRecentFilesFetch, onSelectDeviceFile, onFolderList, }: {
     onFolderFetch: FolderItemsFetcher;
     onFolderCreate: FolderCreator;
     onFolderUpdate: FolderUpdater;
@@ -72,9 +83,9 @@ declare function init({ onFolderFetch, onFolderCreate, onFolderUpdate, onFolderD
     onFavoritesFetch: FavoritesFetcher;
     onRecentFilesFetch: RecentFilesFetcher;
     onSelectDeviceFile?: SelectDeviceFile;
-    onMetadataTemplateFetch?: MetadataTemplateFetcher;
+    onFolderList: FolderLister;
 }): void;
-export type { FolderItemsFetcher, FolderCreator, FolderUpdater, FolderDeleter, FoldersDeleter, FileCreator, FileUpdater, FileOpener, FileDeleter, FilesDeleter, FileFetcher, FileListFetcher, ItemsMoverItem, ItemsMover, FavoritesFetcher, FavoriteCreator, FavoriteDeleter, FavoritesDeleter, FavoritesSetter, CompactFile, CompactFolder, RecentFilesFetcher, SelectDeviceFile, MetadataTemplateFetcher, };
+export type { FolderItemsFetcher, FolderCreator, FolderUpdater, FolderDeleter, FoldersDeleter, FileCreator, FileUpdater, FileOpener, FileDeleter, FilesDeleter, FileFetcher, FileListFetcher, ItemsMoverItem, ItemsMover, FavoritesFetcher, FavoriteCreator, FavoriteDeleter, FavoritesDeleter, FavoritesSetter, CompactFile, CompactFolder, RecentFilesFetcher, SelectDeviceFile, FolderLister, };
 declare const _default: () => {
     state: {
         readonly fileOpener: FileOpener | null;
@@ -98,8 +109,8 @@ declare const _default: () => {
         readonly favoritesSetter: FavoritesSetter | null;
         readonly recentFilesFetcher: RecentFilesFetcher | null;
         readonly selectDeviceFile?: (SelectDeviceFile | null) | undefined;
-        readonly metadataTemplateFetcher?: (MetadataTemplateFetcher | null) | undefined;
         readonly itemsMover: ItemsMover | null;
+        readonly folderLister: FolderLister | null;
         readonly convertingFileIdsTimeout: {
             readonly ref: () => NodeJS.Timeout;
             readonly unref: () => NodeJS.Timeout;
@@ -118,7 +129,6 @@ declare const _default: () => {
         readonly isFetchingFavorites: boolean;
         readonly isCreatingFavorite: boolean;
         readonly isDeletingFavorite: boolean;
-        readonly isMetadataTemplateLoaded: boolean;
         readonly folders: readonly {
             readonly id: string;
             readonly name: string;
@@ -462,6 +472,7 @@ declare const _default: () => {
             favoritesSetter: null;
             recentFilesFetcher: null;
             itemsMover: null;
+            folderLister: null;
             convertingFileIdsTimeout: null;
             isFetchingFolderItems: boolean;
             fetchingFolderId: string;
@@ -473,8 +484,6 @@ declare const _default: () => {
             isCreatingFavorite: boolean;
             isDeletingFavorite: boolean;
             isFetchingRecentFiles: boolean;
-            isMetadataTemplateLoaded: boolean;
-            metadataTemplateFetcher: null;
             folders: never[];
             files: never[];
             recent: never[];
@@ -494,6 +503,7 @@ declare const _default: () => {
         setSearchQuery: typeof setSearchQuery;
         setIsFetchingListFiles: typeof setIsFetchingListFiles;
         setSearchMetadataFilters: typeof setSearchMetadataFilters;
+        setFilteredItems: typeof setFilteredItems;
         onUpsertFolder: typeof onUpsertFolder;
         onUploadFilesRefetchFolder: import('lodash').DebouncedFunc<() => Promise<void>>;
         clearTimeouts: typeof clearTimeouts;
@@ -519,8 +529,8 @@ declare const _default: () => {
             favoritesSetter: FavoritesSetter | null;
             recentFilesFetcher: RecentFilesFetcher | null;
             selectDeviceFile?: (SelectDeviceFile | null) | undefined;
-            metadataTemplateFetcher?: (MetadataTemplateFetcher | null) | undefined;
             itemsMover: ItemsMover | null;
+            folderLister: FolderLister | null;
             convertingFileIdsTimeout: {
                 ref: () => NodeJS.Timeout;
                 unref: () => NodeJS.Timeout;
@@ -539,7 +549,6 @@ declare const _default: () => {
             isFetchingFavorites: boolean;
             isCreatingFavorite: boolean;
             isDeletingFavorite: boolean;
-            isMetadataTemplateLoaded: boolean;
             folders: {
                 id: string;
                 name: string;
@@ -806,6 +815,7 @@ declare const _default: () => {
             favoritesSetter: null;
             recentFilesFetcher: null;
             itemsMover: null;
+            folderLister: null;
             convertingFileIdsTimeout: null;
             isFetchingFolderItems: boolean;
             fetchingFolderId: string;
@@ -817,8 +827,6 @@ declare const _default: () => {
             isCreatingFavorite: boolean;
             isDeletingFavorite: boolean;
             isFetchingRecentFiles: boolean;
-            isMetadataTemplateLoaded: boolean;
-            metadataTemplateFetcher: null;
             folders: never[];
             files: never[];
             recent: never[];

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

@@ -40,7 +40,7 @@ export default function (): {
     setSelectedSection(section: BrowserSectionType, folderId?: string): void;
     toggleSelectedView(): void;
     setSearch(search: string): void;
-    toggleSidebar(isOpen?: boolean): void;
+    setIsLocalSearch(isLocal: boolean): void;
     toggleContentPanel(isOpen?: boolean): void;
     selectAndOpenContentPanel(item: ViewCompactFileFolder): void;
     setCurrentState(stateName: AppCurrentState, itemId?: Folder["id"] | File["id"]): void;
@@ -58,7 +58,6 @@ export default function (): {
     displayedFavorites: ComputedRef<FavoriteExtended[]>;
     filteredRecentFiles: ComputedRef<RecentFileWithFavoriteId[]>;
     displayedRecentFiles: ComputedRef<RecentFileWithFavoriteId[]>;
-    isSidebarOpen: Ref<boolean>;
     isContentPanelOpen: Ref<boolean>;
     updatingFolderId: Ref<Folder["id"] | null>;
     selectedFileId: ComputedRef<File["id"] | null>;
@@ -72,5 +71,6 @@ export default function (): {
     isAdmin: ComputedRef<boolean>;
     enabledFavorites: Ref<boolean>;
     enabledRecents: Ref<boolean>;
+    isLocalSearch: Ref<boolean>;
 };
 export {};

package/lib/apps/canvas-builder/composables/useSectionPopularity.d.ts

@@ -13,8 +13,9 @@ export default function useSectionPopularity(filters?: ComputedRef<Record<string
         engagement: import('../../../types/sectionPopularity').SectionEngagement;
         views: number;
     }[]>;
-    getOrderingConfiguration: ({ sortByMetadata }?: {
+    getOrderingConfiguration: ({ sortByMetadata, sequencingKey, }?: {
         sortByMetadata?: boolean;
+        sequencingKey?: string;
     }) => [SorterFunction, OrderDirection][];
     getPopularityCategory: typeof getPopularityCategory;
     getSystemFilterSectionIds: () => string[] | null;

package/lib/apps/canvas-selector/App.vue.d.ts

@@ -6,5 +6,7 @@ declare const _default: import('vue').DefineComponent<AppProps, {}, {}, {}, {},
 }, string, import('vue').PublicProps, Readonly<AppProps> & Readonly<{
     onCancel?: (() => any) | undefined;
     "onPrimary-action"?: ((selection: Canvas[]) => any) | undefined;
-}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+}>, {
+    sequencingKey: string;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
 export default _default;

package/lib/apps/canvas-selector/appTypes.d.ts

@@ -12,4 +12,5 @@ export type AppProps = {
     allowedSelectorTypes?: CanvasSelectionType[];
     selections?: CanvasSelection[];
     allowedIds?: Canvas['id'][];
+    sequencingKey?: string;
 };