@pitcher/js-api 1.22.0-beta.6 → 1.22.0-rc.0

package/types/openapi/models/InstanceMembershipRoleEnum.d.ts

@@ -1,8 +1,10 @@
 /**
  * * `admin` - Admin
+ * * `editor` - Editor
  * * `member` - Member
  */
 export declare enum InstanceMembershipRoleEnum {
     ADMIN = "admin",
+    EDITOR = "editor",
     MEMBER = "member"
 }

package/types/openapi/models/InstanceRequest.d.ts

@@ -1,9 +1,7 @@
-import { StorageRegionEnum } from './StorageRegionEnum';
 export type InstanceRequest = {
     name: string;
     color?: string | null;
     logo?: Blob | null;
-    storage_region?: StorageRegionEnum;
     environment_id: number;
     region_id: number;
     settings?: Record<string, any> | null;

package/types/openapi/models/MetadataTemplateField.d.ts

@@ -10,4 +10,5 @@ export type MetadataTemplateField = {
     is_sortable?: boolean;
     is_visible_in_lists?: boolean;
     options?: Array<MetadataTemplateOption>;
+    default?: (string | boolean | number) | null;
 };

package/types/openapi/models/MetadataTemplateFieldRequest.d.ts

@@ -10,4 +10,5 @@ export type MetadataTemplateFieldRequest = {
     is_sortable?: boolean;
     is_visible_in_lists?: boolean;
     options?: Array<MetadataTemplateOptionRequest>;
+    default?: (string | boolean | number) | null;
 };

package/types/openapi/models/PSPDFKitAuthPayload.d.ts

@@ -0,0 +1,3 @@
+export type PSPDFKitAuthPayload = {
+    jwt: string;
+};

package/types/openapi/models/PSPDFKitAuthPayloadRequest.d.ts

@@ -0,0 +1,3 @@
+export type PSPDFKitAuthPayloadRequest = {
+    jwt: string;
+};

package/types/openapi/models/PSPDFKitToken.d.ts

@@ -0,0 +1,6 @@
+import { PSPDFKitAuthPayload } from './PSPDFKitAuthPayload';
+export type PSPDFKitToken = {
+    readonly documentId: string;
+    readonly authPayload: PSPDFKitAuthPayload;
+    readonly instant: boolean;
+};

package/types/openapi/models/PSPDFKitTokenRequest.d.ts

@@ -0,0 +1,3 @@
+export type PSPDFKitTokenRequest = {
+    file_id: string;
+};

package/types/openapi/models/PatchedFavoriteUpdateRequest.d.ts

@@ -1,6 +1,3 @@
 export type PatchedFavoriteUpdateRequest = {
     name?: string;
-    file_id?: string;
-    page_index?: number;
-    folder_id?: string;
 };

package/types/openapi/models/PatchedUserRequest.d.ts

@@ -1,9 +1,9 @@
-import { InstanceMembershipRoleEnum } from './InstanceMembershipRoleEnum';
 import { LanguageEnum } from './LanguageEnum';
+import { UserRoleEnum } from './UserRoleEnum';
 export type PatchedUserRequest = {
     first_name?: string;
     last_name?: string;
-    role?: InstanceMembershipRoleEnum;
+    role?: UserRoleEnum;
     language?: LanguageEnum;
     dark_mode?: boolean;
     preferred_username?: string;

package/types/openapi/models/User.d.ts

@@ -1,13 +1,13 @@
 import { ConnectedService } from './ConnectedService';
-import { InstanceMembershipRoleEnum } from './InstanceMembershipRoleEnum';
 import { LanguageEnum } from './LanguageEnum';
+import { UserRoleEnum } from './UserRoleEnum';
 export type User = {
     readonly id: number;
     readonly name: string;
     first_name?: string;
     last_name?: string;
     readonly email: string;
-    role?: InstanceMembershipRoleEnum;
+    role?: UserRoleEnum;
     readonly last_login_date: string | null;
     readonly joined_date: string;
     readonly deactivated_at: string | null;

package/types/openapi/models/UserRequest.d.ts

@@ -1,9 +1,9 @@
-import { InstanceMembershipRoleEnum } from './InstanceMembershipRoleEnum';
 import { LanguageEnum } from './LanguageEnum';
+import { UserRoleEnum } from './UserRoleEnum';
 export type UserRequest = {
     first_name?: string;
     last_name?: string;
-    role?: InstanceMembershipRoleEnum;
+    role?: UserRoleEnum;
     language?: LanguageEnum;
     dark_mode?: boolean;
     preferred_username?: string;

package/types/openapi/models/UserRoleEnum.d.ts

@@ -0,0 +1,10 @@
+/**
+ * * `admin` - Admin
+ * * `member` - Member
+ * * `developer` - Developer
+ */
+export declare enum UserRoleEnum {
+    ADMIN = "admin",
+    MEMBER = "member",
+    DEVELOPER = "developer"
+}

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

@@ -1,3 +0,0 @@
-export declare function useFetchSectionAnalytics(): {
-    fetchSectionAnalytics: () => Promise<Record<string, import('../../../types/sectionPopularity').SectionExtra> | undefined>;
-};

package/lib/components/CFileViewer/CFileViewer.use.d.ts

@@ -1,51 +0,0 @@
-import { Ref, ComputedRef } from 'vue';
-import { I18n } from 'vue-i18n';
-import { Instance, AnnotationsUnion } from 'pspdfkit';
-import { FileModel } from './CFileViewer.types';
-import { Favorite, MiniPage } from '../../../types/openapi';
-import { CLIENT_TYPE } from '../../constants/cdp.const';
-import { default as CFileViewerBottomPdf } from './CFileViewerBottomPdf.vue';
-import { CanvasFile } from '@canvas-builder/types/canvas';
-import { SupportedLocale } from '../../types/i18n.types';
-import { OrganizationSettings } from '../../types/organizationSettings.types';
-import { InstanceSettings } from '../../types/instanceSettings.types';
-import { LaunchDarklyEnv } from '../../types/launchDarkly.types';
-interface FileViewerActions {
-    onCloseFile: () => void;
-    onToggleFavoriteFilePage: (pageIndex: number) => void;
-}
-declare function getAllAnnotations(instance: Instance): Promise<AnnotationsUnion[]>;
-declare const _default: ({ pdfViewerEl, bottomBarRef, i18n, appLocale, actions, filePagesFavorites, assetsPrefix, isFavoriteEnabled, clientType, context, pitcherSettings, launchDarkly, }: {
-    pdfViewerEl: Ref<HTMLElement | null>;
-    bottomBarRef: Ref<InstanceType<typeof CFileViewerBottomPdf> | null>;
-    filePagesFavorites: ComputedRef<Favorite[] | null>;
-    i18n: I18n;
-    appLocale?: SupportedLocale;
-    actions: FileViewerActions;
-    assetsPrefix: string;
-    isFavoriteEnabled: boolean;
-    clientType: (typeof CLIENT_TYPE)[keyof typeof CLIENT_TYPE];
-    context?: Record<string, any>;
-    pitcherSettings?: ComputedRef<OrganizationSettings & InstanceSettings>;
-    launchDarkly: ComputedRef<LaunchDarklyEnv>;
-}) => {
-    viewPdf: (file: FileModel | CanvasFile | null, pageIndex: MiniPage["page_index"]) => Promise<void | Instance>;
-    onPdfFullScreen: (forceEnter?: boolean) => Promise<void>;
-    updateFileViewerSettings: (partialSettings: Partial<import('../../types/fileViewerSettings.types').FileViewerSettings>) => void;
-    cleanupPspdfKit: () => void;
-    isSearchOpen: Ref<boolean>;
-    isThumbnailsOpen: Ref<boolean>;
-    isTextAnnotationOpen: Ref<boolean>;
-    currentPageIndex: Ref<number>;
-    toggleFavoritePageIndex: Ref<number | null>;
-    isAnnotationOpen: Ref<boolean>;
-    isAnnotationModified: Ref<boolean>;
-    selectedAnnotation: Ref<"drawing" | "freeformHighlight" | "textHighlight" | "eraser">;
-    isSwitchingInteractionMode: Ref<boolean>;
-    fileViewerSettings: Readonly<Ref<{
-        readonly fitMode: "width" | "viewport";
-    }>>;
-    isFullscreen: Ref<boolean>;
-    getAllAnnotations: typeof getAllAnnotations;
-};
-export default _default;

package/lib/components/CFileViewer/CFileViewerBottomPdf.vue.d.ts

@@ -1,70 +0,0 @@
-import { SelectBaseOption } from 'naive-ui/lib/select/src/interface';
-import { FileViewerSettings } from '../../types/fileViewerSettings.types';
-import { AnnotationType, FileModel } from './CFileViewer.types';
-interface Props {
-    totalPages: number;
-    page?: number;
-    fileViewerSettings: FileViewerSettings;
-    file: FileModel | null;
-    isTextAnnotationSelected: boolean;
-    isAnnotationsSelected: boolean;
-    selectedAnnotation: Exclude<AnnotationType, 'text'>;
-    isSearchSelected: boolean;
-    isThumbnailsSelected: boolean;
-    hideActions: boolean;
-    isFullscreen: boolean;
-}
-export interface AnnotationOption extends SelectBaseOption {
-    label: string;
-    icon: string;
-    value: string;
-}
-declare const _default: import('vue').DefineComponent<__VLS_WithDefaults<__VLS_TypePropsToOption<Props>, {
-    page: number;
-}>, {}, unknown, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
-    click: () => void;
-    exitFullscreen: () => void;
-    zoomOut: () => void;
-    zoomIn: () => void;
-    setPage: (p: number) => void;
-    fitModeToggle: () => void;
-    searchFile: () => void;
-    showThumbnails: () => void;
-    showTextAnnotation: () => void;
-    showAnnotations: () => void;
-    selectAnnotation: (a: "drawing" | "freeformHighlight" | "textHighlight" | "eraser") => void;
-}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToOption<Props>, {
-    page: number;
-}>>> & {
-    onClick?: (() => any) | undefined;
-    onExitFullscreen?: (() => any) | undefined;
-    onZoomOut?: (() => any) | undefined;
-    onZoomIn?: (() => any) | undefined;
-    onSetPage?: ((p: number) => any) | undefined;
-    onFitModeToggle?: (() => any) | undefined;
-    onSearchFile?: (() => any) | undefined;
-    onShowThumbnails?: (() => any) | undefined;
-    onShowTextAnnotation?: (() => any) | undefined;
-    onShowAnnotations?: (() => any) | undefined;
-    onSelectAnnotation?: ((a: "drawing" | "freeformHighlight" | "textHighlight" | "eraser") => any) | undefined;
-}, {
-    page: number;
-}, {}>;
-export default _default;
-type __VLS_WithDefaults<P, D> = {
-    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
-        default: D[K];
-    }> : P[K];
-};
-type __VLS_Prettify<T> = {
-    [K in keyof T]: T[K];
-} & {};
-type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
-type __VLS_TypePropsToOption<T> = {
-    [K in keyof T]-?: {} extends Pick<T, K> ? {
-        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
-    } : {
-        type: import('vue').PropType<T[K]>;
-        required: true;
-    };
-};

package/lib/components/CFileViewer/CFileViewerSearchResultsSidebar.vue.d.ts

@@ -1,14 +0,0 @@
-interface Props {
-    instance: any;
-}
-declare const _default: import('vue').DefineComponent<__VLS_TypePropsToOption<Props>, {}, unknown, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<import('vue').ExtractPropTypes<__VLS_TypePropsToOption<Props>>>, {}, {}>;
-export default _default;
-type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
-type __VLS_TypePropsToOption<T> = {
-    [K in keyof T]-?: {} extends Pick<T, K> ? {
-        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
-    } : {
-        type: import('vue').PropType<T[K]>;
-        required: true;
-    };
-};

package/lib/composables/useFiles.d.ts

@@ -1,10 +0,0 @@
-import { ViewCompactFolder } from '../types/files';
-import { FileContentTypeEnum } from '../../types/openapi';
-export declare function renderContentType(contentType: FileContentTypeEnum): import('vue').VNode<import('vue').RendererNode, import('vue').RendererElement, {
-    [key: string]: any;
-}>;
-export declare function getFolderDescription(item: Partial<ViewCompactFolder>): string;
-export default function useFiles(): {
-    getFolderDescription: typeof getFolderDescription;
-    renderContentType: typeof renderContentType;
-};

package/types/openapi/models/AppOrganizationRequest.d.ts

@@ -1,4 +0,0 @@
-export type AppOrganizationRequest = {
-    id: string;
-    display_name?: string | null;
-};

package/types/openapi/models/AppRequest.d.ts

@@ -1,8 +0,0 @@
-import { AppTypeEnum } from './AppTypeEnum';
-export type AppRequest = {
-    name: string;
-    type: AppTypeEnum;
-    description?: string | null;
-    display_name?: string | null;
-    logo?: Blob | null;
-};

package/types/openapi/models/DeletedApp.d.ts

@@ -1,22 +0,0 @@
-import { AppOrganization } from './AppOrganization';
-import { AppTypeEnum } from './AppTypeEnum';
-import { MiniUser } from './MiniUser';
-export type DeletedApp = {
-    readonly id: number;
-    readonly uid: string;
-    name: string;
-    type: AppTypeEnum;
-    readonly organization: AppOrganization;
-    description?: string | null;
-    display_name?: string | null;
-    readonly latest_version: string | null;
-    logo?: string | null;
-    readonly is_published: boolean;
-    readonly created_at: string;
-    readonly created_by: MiniUser;
-    readonly modified_at: string;
-    readonly modified_by: MiniUser;
-    readonly owned_by: MiniUser;
-    readonly deleted_at: string;
-    readonly deleted_by: MiniUser;
-};

package/types/openapi/models/MiniPageRequest.d.ts

@@ -1,3 +0,0 @@
-export type MiniPageRequest = {
-    page_index?: number;
-};

package/types/openapi/models/PaginatedAppReleaseList.d.ts

@@ -1,7 +0,0 @@
-import { AppRelease } from './AppRelease';
-export type PaginatedAppReleaseList = {
-    count?: number;
-    next?: string | null;
-    previous?: string | null;
-    results?: Array<AppRelease>;
-};

package/types/openapi/models/PatchedAppRequest.d.ts

@@ -1,8 +0,0 @@
-import { AppTypeEnum } from './AppTypeEnum';
-export type PatchedAppRequest = {
-    name?: string;
-    type?: AppTypeEnum;
-    description?: string | null;
-    display_name?: string | null;
-    logo?: Blob | null;
-};