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

package/lib/components/CSwitch/CSwitch.vue.d.ts

@@ -1,7 +1,8 @@
 type __VLS_Props = {
-    checked: boolean;
+    checked?: boolean;
     disabled?: boolean;
     themeOverrides?: Record<string, any>;
+    size?: string;
 };
 declare function __VLS_template(): {
     attrs: Partial<{}>;
@@ -12,8 +13,10 @@ declare function __VLS_template(): {
 type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
 declare const __VLS_component: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
     change: (value: boolean) => any;
+    "update:checked": (value: boolean) => any;
 }, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
     onChange?: ((value: boolean) => any) | undefined;
+    "onUpdate:checked"?: ((value: boolean) => any) | undefined;
 }>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
 declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
 export default _default;

package/lib/components/canvases/CanvasesManagementToolbarFilters.use.d.ts

@@ -15,5 +15,5 @@ export declare function useCanvasesManagementFiltersToolbar(filters: Ref<Filters
     isAnyFilterActive: import('vue').ComputedRef<boolean>;
     showClearFilters: import('vue').ComputedRef<boolean>;
     clearFilters: () => void;
-    updateFilters: (filterName: string, newValue: string | string[] | boolean) => void;
+    updateFilters: (filterName: string, newValue: string | string[] | boolean | null) => void;
 };

package/lib/components/filters/CCheckboxFilter.vue.d.ts

@@ -1,7 +1,7 @@
 type Props = {
     disabled?: boolean;
     name?: string;
-    modelValue?: boolean | null;
+    modelValue?: boolean | string | null;
 };
 declare const _default: import('vue').DefineComponent<Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {} & {
     "update:modelValue": (value: boolean) => any;

package/lib/components/filters/CSelectFilter.vue.d.ts

@@ -1,10 +1,10 @@
 declare const _default: <FilterValue extends string>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_expose?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
     props: __VLS_PrettifyLocal<Pick<Partial<{}> & Omit<{
-        readonly "onUpdate:modelValue"?: ((v: "" | FilterValue | FilterValue[]) => any) | undefined;
+        readonly "onUpdate:modelValue"?: ((v: "" | FilterValue | FilterValue[] | null) => any) | undefined;
     } & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps, never>, "onUpdate:modelValue"> & {
         disabled?: boolean;
         name?: string;
-        modelValue: FilterValue[] | FilterValue | "";
+        modelValue: FilterValue[] | FilterValue | null | "";
         inline?: boolean;
         options: {
             label: string;
@@ -17,7 +17,7 @@ declare const _default: <FilterValue extends string>(__VLS_props: NonNullable<Aw
     slots: {
         footer?(_: {}): any;
     };
-    emit: (e: "update:modelValue", v: "" | FilterValue | FilterValue[]) => void;
+    emit: (e: "update:modelValue", v: "" | FilterValue | FilterValue[] | null) => void;
 }>) => import('vue').VNode & {
     __ctx?: Awaited<typeof __VLS_setup>;
 };

package/lib/sdk/api/HighLevelApi.d.ts

@@ -210,6 +210,7 @@ export declare function createHighLevelApi(options?: ApiOptions): {
         message: string;
     }): Promise<void>;
     query(payload: import('../payload.types').QueryPayload): Promise<any>;
+    getFolders(payload: import('../payload.types').FolderListRequest): Promise<import('../../main.lib').PaginatedFolderList>;
     getFolder(payload?: {
         id: import('../../main.lib').FolderRetrieve["id"];
     }): Promise<import('../../main.lib').FolderRetrieve>;

package/lib/sdk/api/modules/admin/app-errors.admin.d.ts

@@ -0,0 +1,17 @@
+import { AdminCaptureAppErrorRequest } from './types.admin';
+/**
+ * Send an app error to Pitcher sentry instance.
+ *
+ * @example
+ * try {
+ *   throw new Error('This is an error')
+ * } catch (error) {
+ *   useAdmin().captureAppError({
+ *     error,
+ *     message: 'This is an app error',
+ *   })
+ * }
+ *
+ * @param payload error object to send to Pitcher sentry instance
+ */
+export declare function captureAppError(payload: AdminCaptureAppErrorRequest): Promise<void>;

package/lib/sdk/api/modules/admin/index.d.ts

@@ -59,6 +59,7 @@ declare const _default: {
     selectCollectionContent(payload?: import('./types.admin').AdminSelectCollectionPlayerRequest): Promise<import('./types.admin').AdminSelectCollectionPlayerResponse>;
     selectAgendaContent(payload?: import('./types.admin').AdminSelectAgendaRequest): Promise<import('./types.admin').AdminSelectAgendaResponse>;
     selectContent(payload: import('./types.admin').AdminSelectContentRequest): Promise<import('./types.admin').AdminSelectContentResponse>;
+    captureAppError(payload: import('./types.admin').AdminCaptureAppErrorRequest): Promise<void>;
     on: typeof on;
     toast: typeof toast;
 };

package/lib/sdk/api/modules/admin/types.admin.d.ts

@@ -17,6 +17,7 @@ export declare const ADMIN_API_TYPES: {
     readonly ADMIN_RESPONSE: "ADMIN_RESPONSE";
 };
 export declare const ADMIN_API_METHOD_TYPES: {
+    readonly CAPTURE_APP_ERROR: "admin_capture_app_error";
     readonly CREATE_CANVAS: "admin_create_canvas";
     readonly GET_APP_CONFIG: "admin_get_app_config";
     readonly GET_CANVAS: "admin_get_canvas";
@@ -38,6 +39,10 @@ export declare const ADMIN_API_METHOD_TYPES: {
 export type AdminMessagePayloads = {
     [ADMIN_MESSAGE_TYPES.ENV_CHANGED]: AdminEnv;
 };
+/**
+ * Error object to send to Pitcher sentry instance
+ */
+export type AdminCaptureAppErrorRequest = Record<string, any>;
 /**
  * Represents an admin request with a specific payload.
  * @template Payload - The type of the payload data.
@@ -173,6 +178,10 @@ export type AdminSelectCanvasesRequest = {
      * Initial metadata filters to apply to the picker (optional).
      */
     initial_metadata_filters?: Record<string, any>;
+    /**
+     * The sequencing key to use for ordering the canvases (optional).
+     */
+    sequencing_key?: string;
 };
 export type AdminSelectCanvasesResponse = {
     /** User action result */

package/lib/sdk/api/modules/folders.d.ts

@@ -1,4 +1,11 @@
-import { File, Folder, FolderRetrieve, FolderCreateRequest, FolderUpdateRequest } from '../../../../types/openapi';
+import { File, Folder, FolderRetrieve, FolderCreateRequest, FolderUpdateRequest, PaginatedFolderList } from '../../../../types/openapi';
+import { FolderListRequest } from '../../payload.types';
+/**
+ * Retrieves a list of folders.
+ * @param payload - The payload containing the search, ordering, filters, fields, name, page, and page_size.
+ * @returns A promise that resolves to the list of folders.
+ */
+export declare function getFolders(payload: FolderListRequest): Promise<PaginatedFolderList>;
 /**
  * Retrieves a folder by its ID.
  * @param payload - An object containing the folder ID.

package/lib/sdk/main.d.ts

@@ -129,6 +129,7 @@ export declare function useAdmin(): {
     selectCollectionContent(payload?: import('./api/modules/admin/types.admin').AdminSelectCollectionPlayerRequest): Promise<import('./api/modules/admin/types.admin').AdminSelectCollectionPlayerResponse>;
     selectAgendaContent(payload?: import('./api/modules/admin/types.admin').AdminSelectAgendaRequest): Promise<import('./api/modules/admin/types.admin').AdminSelectAgendaResponse>;
     selectContent(payload: import('./api/modules/admin/types.admin').AdminSelectContentRequest): Promise<import('./api/modules/admin/types.admin').AdminSelectContentResponse>;
+    captureAppError(payload: import('./api/modules/admin/types.admin').AdminCaptureAppErrorRequest): Promise<void>;
     on: (type: typeof import('./api/modules/admin/types.admin').ADMIN_MESSAGE_TYPES[keyof typeof import('./api/modules/admin/types.admin').ADMIN_MESSAGE_TYPES], handler: (data: import('./api/modules/admin/types.admin').AdminMessagePayloads[typeof type]) => Promise<void>) => Promise<() => void>;
     toast: (payload: import('./api/modules/admin/types.admin').AdminToastRequest) => Promise<void>;
 };
@@ -286,6 +287,7 @@ export declare function useApi(options?: ApiOptions): {
         message: string;
     }): Promise<void>;
     query(payload: import('./payload.types').QueryPayload): Promise<any>;
+    getFolders(payload: import('./payload.types').FolderListRequest): Promise<import('../main.lib').PaginatedFolderList>;
     getFolder(payload?: {
         id: import('../main.lib').FolderRetrieve["id"];
     }): Promise<import('../main.lib').FolderRetrieve>;
@@ -379,6 +381,7 @@ export declare function useApi(options?: ApiOptions): {
     selectCollectionContent(payload?: import('./api/modules/admin/types.admin').AdminSelectCollectionPlayerRequest): Promise<import('./api/modules/admin/types.admin').AdminSelectCollectionPlayerResponse>;
     selectAgendaContent(payload?: import('./api/modules/admin/types.admin').AdminSelectAgendaRequest): Promise<import('./api/modules/admin/types.admin').AdminSelectAgendaResponse>;
     selectContent(payload: import('./api/modules/admin/types.admin').AdminSelectContentRequest): Promise<import('./api/modules/admin/types.admin').AdminSelectContentResponse>;
+    captureAppError(payload: import('./api/modules/admin/types.admin').AdminCaptureAppErrorRequest): Promise<void>;
     on: (type: typeof import('./api/modules/admin/types.admin').ADMIN_MESSAGE_TYPES[keyof typeof import('./api/modules/admin/types.admin').ADMIN_MESSAGE_TYPES], handler: (data: import('./api/modules/admin/types.admin').AdminMessagePayloads[typeof type]) => Promise<void>) => Promise<() => void>;
     toast: (payload: import('./api/modules/admin/types.admin').AdminToastRequest) => Promise<void>;
 } | {
@@ -555,6 +558,7 @@ export declare function useApi(options?: ApiOptions): {
             message: string;
         }): Promise<void>;
         query(payload: import('./payload.types').QueryPayload): Promise<any>;
+        getFolders(payload: import('./payload.types').FolderListRequest): Promise<import('../main.lib').PaginatedFolderList>;
         getFolder(payload?: {
             id: import('../main.lib').FolderRetrieve["id"];
         }): Promise<import('../main.lib').FolderRetrieve>;
@@ -755,6 +759,7 @@ export declare function useApi(options?: ApiOptions): {
         };
     }): Promise<ArrayBuffer>;
     query(payload: import('./payload.types').QueryPayload): Promise<any>;
+    getFolders(payload: import('./payload.types').FolderListRequest): Promise<import('../main.lib').PaginatedFolderList>;
     getFolder(payload?: {
         id: import('../main.lib').FolderRetrieve["id"];
     }): Promise<import('../main.lib').FolderRetrieve>;

package/lib/sdk/payload.types.d.ts

@@ -234,3 +234,13 @@ export type ShareResponse = {
      */
     activity_type?: string;
 };
+export type FolderListRequest = {
+    search?: string;
+    ordering?: string;
+    filters?: Record<string, any>;
+    fields?: string;
+    name?: string;
+    page?: number;
+    page_size?: number;
+    id__in?: string[];
+};

package/lib/sdk/utils/window.d.ts

@@ -0,0 +1,3 @@
+type WindowType = Window & typeof globalThis;
+export declare function getTopPitcherWindow(current?: WindowType): WindowType;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pitcher/js-api",
-  "version": "1.25.0-beta.0",
+  "version": "1.25.0-beta.2",
   "type": "module",
   "main": "js-api.umd.min.js",
   "module": "js-api.esm.js",