@pitcher/js-api 1.21.0-beta.2 → 1.22.0-alpha.1

package/lib/util/location.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/util/location.util.d.ts

@@ -0,0 +1 @@
+export declare function isQueryParamTruthy(param: string, queryRecord: Record<string, string | null | (string | null)[]>): boolean;

package/lib/util/message-event.d.ts

@@ -0,0 +1 @@
+export declare function isOriginValid(event: MessageEvent, allowedOrigins?: string[], isDev?: boolean): boolean;

package/lib/util/message-event.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/util/navigation.util.d.ts

@@ -0,0 +1,7 @@
+import { Router, RouteLocationRaw } from 'vue-router';
+
+export declare function navigateTo(router: Router, routeData: RouteLocationRaw, client: 'admin' | 'impact', options?: {
+    newTab?: boolean;
+    target?: string;
+}): Promise<void>;
+export declare function isModifierClick(e?: MouseEvent): boolean | undefined;

package/lib/util/network.d.ts

@@ -0,0 +1,16 @@
+import { AxiosInstance, AxiosRequestConfig } from 'axios';
+import { PaginatedData } from '../types/paginatedData';
+import { PitcherInfo } from '../types/app';
+
+export declare const fetchAll: <T>(reqFunction: (reqParams: any) => Promise<PaginatedData<T>>, reqParams?: any) => Promise<T[]>;
+export declare function fetchFirstChunkAndRemainingAsync<T>(reqFunction: (reqParams: any) => Promise<PaginatedData<T>>, reqParams?: any): Promise<[T[], Promise<T[]>]>;
+export declare function urlSafeFetchInChunks<T>(ids: (string | number)[], fetchFunction: (chunk: (string | number)[]) => Promise<{
+    results: T[];
+} | T[]>, options?: {
+    chunkSize: number;
+}): Promise<T[]>;
+export declare function createAxiosInstance(config: AxiosRequestConfig<any> | undefined, pitcherInfo: PitcherInfo): AxiosInstance;
+export declare function derivePatchRequestFields<T extends object>(current: T, updated: Partial<T>, fieldsString?: string): {
+    updatedFields: string[];
+    payload: Partial<T>;
+};

package/lib/util/network.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/util/number.d.ts

@@ -0,0 +1,4 @@
+export declare const displayBytesWithMUnit: (bytes: number, decimals?: number) => string;
+export declare const displayIntegerWithMunit: (number: number, decimals?: number) => string;
+export declare const convertSecondsToMinutes: (number: number) => string;
+export declare const getNumberWithRegex: (string: string) => string;

package/lib/util/number.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/util/object.d.ts

@@ -0,0 +1 @@
+export declare function deepDiff(obj1: Record<string, any>, obj2: Record<string, any>, parentKey?: string): Record<string, any>;

package/lib/util/object.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/util/query.d.ts

@@ -0,0 +1,6 @@
+import { GetNextPageParamFunction } from '@tanstack/vue-query';
+import { PaginatedData } from '../types/paginatedData';
+
+export declare const DEFAULT_ITEMS_PER_PAGE = 15;
+export declare const getDefinedProps: <T extends object>(props: T) => Partial<T>;
+export declare const getNextPageParam: GetNextPageParamFunction<PaginatedData<any>>;

package/lib/util/reactive.d.ts

@@ -0,0 +1,4 @@
+import { Ref } from 'vue';
+
+export declare const waitForValue: (value: Ref, expectedValue?: any) => Promise<void>;
+export declare function deepToRaw<T>(obj: T): T;

package/lib/util/reactive.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/util/string.d.ts

@@ -0,0 +1,4 @@
+export declare function highlight(input: string, search: string): string;
+export declare function prefixHttps(url: string): string;
+export declare function stripHtmlTags(htmlString: string | undefined): string;
+export declare function stripHtmlTagsAndTrim(htmlString: string | undefined): string;

package/lib/util/timer.d.ts

@@ -0,0 +1,2 @@
+export declare const executeWithDoublingTime: (fn: () => void, initialDelay: number) => () => void;
+export declare function wait(ms?: number): Promise<void>;

package/lib/util/timer.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/util/translations.d.ts

@@ -0,0 +1,8 @@
+import { TranslationOverrides } from '../types/translations';
+import { SupportedLocale } from '../types/i18n.types';
+
+export declare const replaceTranslationMessagesWithOverrides: ({ overrides, messages, locale, }: {
+    overrides: TranslationOverrides;
+    messages?: any;
+    locale: SupportedLocale;
+}) => void;

package/lib/util/translations.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/util/tsHelpers.d.ts

@@ -0,0 +1,14 @@
+export type RequireOnlyOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclude<keyof T, Keys>> & {
+    [K in Keys]-?: Required<Pick<T, K>> & Partial<Record<Exclude<Keys, K>, undefined>>;
+}[Keys];
+export type RequireAtLeastOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclude<keyof T, Keys>> & {
+    [K in Keys]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<Keys, K>>>;
+}[Keys];
+type Enumerate<N extends number, Acc extends number[] = []> = Acc['length'] extends N ? Acc[number] : Enumerate<N, [...Acc, Acc['length']]>;
+export type Range<F extends number, T extends number> = Exclude<Enumerate<T>, Enumerate<F>> | T;
+export type Without<T, U> = {
+    [P in Exclude<keyof T, keyof U>]?: never;
+};
+export type XOR<T extends any[], U = T[number]> = U & Record<Exclude<keyof U, keyof T[number]>, never>;
+export type Include<T, K> = T extends K ? T : never;
+export {};

package/lib/util/user.d.ts

@@ -0,0 +1,4 @@
+export declare const splitUserName: (name?: string) => {
+    first_name: string;
+    last_name: string;
+};

package/lib/util/userAgents.d.ts

@@ -0,0 +1,8 @@
+export declare const isMobile: boolean;
+export declare const isPitcherWkWebView: boolean;
+export declare const isIosDevice: boolean;
+export declare const isSafariOnIosDevice: boolean;
+export declare const isPitcherOrIosDevice: boolean;
+export declare const isTouchScreen: boolean;
+export declare const isMac: boolean;
+export declare const isWindows: boolean;

package/package.json

@@ -1,7 +1,11 @@
 {
   "name": "@pitcher/js-api",
-  "version": "1.21.0-beta.2",
+  "version": "1.22.0-alpha.1",
   "type": "module",
   "main": "js-api.umd.min.js",
-  "sideEffects": false
+  "module": "js-api.esm.js",
+  "sideEffects": false,
+  "peerDependencies": {
+    "lodash-es": "4"
+  }
 }

package/types/js-api.esm.d.ts

@@ -0,0 +1 @@
+export * from './lib/sdk/main.umd-esm'

package/types/lib/api/apps/apps.queries.d.ts

@@ -0,0 +1,3 @@
+import { AppFile } from '../../types/app';
+
+export declare const useFetchApps: (fetcher: (params: any) => Promise<AppFile[]>) => import('@tanstack/vue-query').UseQueryReturnType<AppFile[], unknown>;

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

@@ -0,0 +1,15 @@
+import { Canvas } from '../../../types/openapi';
+import { GetCanvasesParams } from '../../types/canvases';
+import { PaginatedData } from '../../types/paginatedData';
+import { MaybeRef } from '@vueuse/core';
+
+export declare const CANVASES = "canvases";
+type Options = {
+    apiFn?: (params: GetCanvasesParams) => Promise<PaginatedData<Canvas>>;
+};
+export declare const useCanvasesAsInfinity: (params: MaybeRef<GetCanvasesParams>, options?: Options) => import('@tanstack/vue-query').UseInfiniteQueryReturnType<PaginatedData<Canvas>, unknown>;
+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 {};

package/types/lib/api/events/events.helpers.d.ts

@@ -0,0 +1,29 @@
+import { Event, MiniCanvas } from '../../../types/openapi';
+import { SfAccountMini, SfEvent, SfUser } from '../../types/sfdc';
+import { ComputedRef } from 'vue';
+
+export declare function getEventColor(pEvent: Event, sfEvent: SfEvent): string;
+export declare const minFutureDate: (date?: Date) => Date;
+export declare const minPastDate: (date?: Date) => Date;
+export declare const setDateTime: (date: number | Date) => number;
+export declare const isPastMaxDate: (date: number | Date, afterDate: number | Date) => boolean;
+export declare const isBeforeMinDate: (date: number | Date, beforeDate: number | Date) => boolean;
+export declare const DATE_TIME_FORMAT = "yyyy / MM / dd - HH:mm";
+export declare const MIN_DIFFERENCE_IN_MINUTES = 15;
+export interface BaseEventForm {
+    title: string;
+    notes: string;
+    event: {
+        start: number | null;
+        end: number | null;
+    };
+    account: ComputedRef<SfAccountMini | null>;
+    contacts: ComputedRef<never[]>;
+    users: ComputedRef<SfUser[]>;
+    canvas: MiniCanvas;
+}
+export interface PostCallForm extends BaseEventForm {
+    account: ComputedRef<SfAccountMini | null>;
+    contacts: ComputedRef<never[]>;
+    users: ComputedRef<SfUser[]>;
+}

package/types/lib/api/events/events.queries.d.ts

@@ -0,0 +1,10 @@
+import { Ref } from 'vue';
+import { Event, EventRequest, PatchedEventRequest } from '../../../types/openapi';
+import { EventsFetchRequest } from '../../types/sfdc';
+
+export declare const useFetchEvents: (params: Ref<EventsFetchRequest>, options?: {
+    enabled?: boolean;
+}) => import('@tanstack/vue-query').UseQueryReturnType<Event[], unknown>;
+export declare const useCreateEvent: () => import('@tanstack/vue-query').UseMutationReturnType<Event, unknown, EventRequest, unknown, Omit<import('@tanstack/vue-query').MutationObserverIdleResult<Event, unknown, EventRequest, unknown>, "reset" | "mutate"> | Omit<import('@tanstack/vue-query').MutationObserverLoadingResult<Event, unknown, EventRequest, unknown>, "reset" | "mutate"> | Omit<import('@tanstack/vue-query').MutationObserverErrorResult<Event, unknown, EventRequest, unknown>, "reset" | "mutate"> | Omit<import('@tanstack/vue-query').MutationObserverSuccessResult<Event, unknown, EventRequest, unknown>, "reset" | "mutate">>;
+export declare const useDeleteEvent: () => import('@tanstack/vue-query').UseMutationReturnType<void, unknown, Event, unknown, Omit<import('@tanstack/vue-query').MutationObserverIdleResult<void, unknown, Event, unknown>, "reset" | "mutate"> | Omit<import('@tanstack/vue-query').MutationObserverLoadingResult<void, unknown, Event, unknown>, "reset" | "mutate"> | Omit<import('@tanstack/vue-query').MutationObserverErrorResult<void, unknown, Event, unknown>, "reset" | "mutate"> | Omit<import('@tanstack/vue-query').MutationObserverSuccessResult<void, unknown, Event, unknown>, "reset" | "mutate">>;
+export declare const useUpdateEvent: () => import('@tanstack/vue-query').UseMutationReturnType<Event, unknown, PatchedEventRequest, unknown, Omit<import('@tanstack/vue-query').MutationObserverIdleResult<Event, unknown, PatchedEventRequest, unknown>, "reset" | "mutate"> | Omit<import('@tanstack/vue-query').MutationObserverLoadingResult<Event, unknown, PatchedEventRequest, unknown>, "reset" | "mutate"> | Omit<import('@tanstack/vue-query').MutationObserverErrorResult<Event, unknown, PatchedEventRequest, unknown>, "reset" | "mutate"> | Omit<import('@tanstack/vue-query').MutationObserverSuccessResult<Event, unknown, PatchedEventRequest, unknown>, "reset" | "mutate">>;

package/types/lib/api/users/users.queries.d.ts

@@ -0,0 +1,5 @@
+import { Ref } from 'vue';
+
+export declare const useFetchUsers: (params: Ref<any>, options?: {
+    enabled?: boolean;
+}) => import('@tanstack/vue-query').UseQueryReturnType<import('../../main.lib').PaginatedData<import('../../main.lib').User>, unknown>;

package/types/lib/apps/browser/composables/useAppEmit.d.ts

@@ -0,0 +1,3 @@
+export default function useAppEmit<T>(emit?: T): {
+    appEmit: (...args: any) => T | undefined;
+};