chayns-api 1.0.0

package/dist/types/calls/dialogs/date.d.ts

@@ -0,0 +1,96 @@
+import { DialogButton, DialogTextBlock, IntervalItem, WeekDayIntervalObject } from "../../types/dialog";
+/**
+ * The config object for date dialog
+ * @typedef {Object} dateConfig
+ * @property {Date} preSelect  - The date object which should be preselected.
+ * @property {Date} minDate   - The min date which you could select.
+ * @property {Date} maxDate  - The max date which you could select.
+ * @property {dateDialogType} dateType  - The type of dialog you want to display.
+ * @property {number} minuteIntervall - The interval for special minutes, possible are 2, 3, 4, 5, 6, 12, 15, 20, 30. Default is 1.
+ * @property {string} message - The message that is displayed above the date dialog, only in apps supported
+ * @property {string} title - The title that is displayed above the message, only in apps supported
+ */
+/**
+ * This call will open a date select dialog.
+ * <div>Call: 30</div>
+ * @param {dateConfig} config - Define the configuration of this call
+ * @return {Promise} contains a timestamp as result
+ * @example chayns.dialog.date({
+ *  'dateType': chayns.dialog.dateType.DATE_TIME,
+ *  'preSelect': new Date(2018, 6, 14, 0, 0, 0),
+ *  'minDate':  new Date(2018, 6, 1, 15, 0, 0),
+ *  'maxDate': new Date(2019, 6, 1, 0, 23, 0),
+ *  'minuteInterval': 15
+ * ).then(function (data) {
+ *  console.log(data);
+ * });
+ */
+type DateConfig = {
+    title?: string;
+    message?: string;
+    buttons?: DialogButton[];
+    minDate?: Date | number;
+    maxDate?: Date | number;
+    minuteInterval?: number;
+    preSelect?: Date | undefined | number;
+    multiselect?: boolean;
+    disabledDates?: Date[] | number[];
+    textBlocks?: DialogTextBlock[];
+    yearSelect?: boolean;
+    monthSelect?: boolean;
+    interval?: boolean;
+    minInterval?: number;
+    maxInterval?: number;
+    disabledIntervals?: Array<IntervalItem>;
+    disabledWeekDayIntervals?: Array<WeekDayIntervalObject>[7];
+    getLocalTime?: boolean;
+    dateType?: number;
+    autoSelectDate?: boolean;
+};
+export declare function date(config?: DateConfig): Promise<any>;
+type preSelectObj = {
+    start?: number | undefined | Date;
+    end?: number | undefined | Date;
+};
+type preSelect = preSelectObj | Date | undefined | number | number[];
+type AdvancedDateConfig = {
+    title?: string;
+    message?: string;
+    buttons?: DialogButton[];
+    minDate?: Date | number;
+    maxDate?: Date | number;
+    minuteInterval?: number;
+    preSelect?: preSelect;
+    multiselect?: boolean;
+    disabledDates?: Date[] | number[];
+    textBlocks?: DialogTextBlock[];
+    yearSelect?: boolean;
+    monthSelect?: boolean;
+    interval?: boolean;
+    minInterval?: number;
+    maxInterval?: number;
+    disabledIntervals?: Array<IntervalItem>;
+    disabledWeekDayIntervals?: Array<WeekDayIntervalObject>[7];
+    getLocalTime?: boolean;
+    dateType?: number;
+    autoSelectDate?: boolean;
+};
+export declare function advancedDate(config?: AdvancedDateConfig): Promise<unknown>;
+/**
+ * @typedef {number} dateDialogType
+ */
+/**
+ * Enum for date dialog
+ * <div>DATE will open a dialog where you can select a special day</div>
+ * <div>TIME will open a dialog where you can only select a special time</div>
+ * <div>DATE_TIME will open a dialog where you can select a special time on a special day</div>
+ * @readonly
+ * @enum {dateDialogType}
+ * @type {{DATE: number, TIME: number, DATE_TIME: number}}
+ */
+export declare const dateType: {
+    DATE: number;
+    TIME: number;
+    DATE_TIME: number;
+};
+export {};

package/dist/types/calls/dialogs/dropUpAlert.d.ts

@@ -0,0 +1,5 @@
+type DropUpAlert = {
+    callType?: number;
+};
+export declare function dropUpAlert(dialog?: DropUpAlert): Promise<unknown>;
+export {};

package/dist/types/calls/dialogs/fileSelect.d.ts

@@ -0,0 +1,16 @@
+import { DialogButton } from "../../types/dialog";
+export declare const fileType: {
+    IMAGE: string;
+    VIDEO: string;
+    AUDIO: string;
+    DOCUMENT: string[];
+};
+type FileSelectInput = {
+    buttons?: DialogButton[];
+    callType?: number;
+    multiselect?: boolean;
+    directory?: boolean;
+    chaynsToken?: string;
+};
+export declare function fileSelect(dialog?: FileSelectInput): Promise<unknown>;
+export {};

package/dist/types/calls/dialogs/iFrame.d.ts

@@ -0,0 +1,10 @@
+import { DialogButton } from "../../types/dialog";
+type iFrameDialog = {
+    buttons?: DialogButton[];
+    callType?: number;
+    tappIframeName?: string;
+    url: string;
+};
+export declare function iFrame(dialog?: iFrameDialog): Promise<unknown>;
+export declare function _chaynsCallResponder(obj: any): void;
+export {};

package/dist/types/calls/dialogs/index.d.ts

@@ -0,0 +1,14 @@
+export { buttonText, buttonType } from './chaynsDialog';
+export * from './alert';
+export * from './confirm';
+export * from './select';
+export * from './date';
+export * from './input';
+export * from './close';
+export * from './dropUpAlert';
+export * from './iFrame';
+export * from './mediaSelect';
+export * from './fileSelect';
+export * from './communication';
+export * from './toast';
+export * from './signature';

package/dist/types/calls/dialogs/input.d.ts

@@ -0,0 +1,15 @@
+import { DialogButton } from "../../types/dialog";
+type InputDialog = {
+    buttons?: DialogButton[];
+    callType?: number;
+    formatter?: string;
+};
+export declare function input(dialog?: InputDialog): Promise<unknown>;
+export declare const inputType: {
+    DEFAULT: number;
+    PASSWORD: number;
+    TEXTAREA: number;
+    INPUT: number;
+    NUMBER: number;
+};
+export {};

package/dist/types/calls/dialogs/mediaSelect.d.ts

@@ -0,0 +1,8 @@
+import { DialogButton } from "../../types/dialog";
+type MediaSelectInput = {
+    buttons?: DialogButton[];
+    callType?: number;
+    chaynsToken?: string;
+};
+export declare function mediaSelect(dialog?: MediaSelectInput): Promise<unknown>;
+export {};

package/dist/types/calls/dialogs/open.d.ts

@@ -0,0 +1 @@
+export declare function open(json: any): Promise<unknown>;

package/dist/types/calls/dialogs/select.d.ts

@@ -0,0 +1,6 @@
+import { SelectInput } from '../../types/IChaynsReact';
+export declare function select(config: SelectInput): Promise<unknown>;
+export declare const selectType: {
+    DEFAULT: number;
+    ICON: number;
+};

package/dist/types/calls/dialogs/signature.d.ts

@@ -0,0 +1,7 @@
+import { DialogButton } from "../../types/dialog";
+type SignatureInput = {
+    buttons?: DialogButton[];
+    callType?: number;
+};
+export declare function signature(dialog?: SignatureInput): Promise<unknown>;
+export {};

package/dist/types/calls/dialogs/toast.d.ts

@@ -0,0 +1 @@
+export declare function toast(config?: {}): Promise<any>;

package/dist/types/calls/dialogs/utils/callback.d.ts

@@ -0,0 +1 @@
+export declare function getCallbackName(fnName: any, framePrefix?: string): string;

package/dist/types/calls/dialogs/utils/environment.d.ts

@@ -0,0 +1,3 @@
+export declare let environment: {
+    language: string;
+};

package/dist/types/calls/dialogs/utils/is.d.ts

@@ -0,0 +1,4 @@
+export declare function isObject(value: any): boolean;
+export declare function isNumber(value: any): boolean;
+export declare function isDate(value: any): boolean;
+export declare function isPresent(value: any): boolean;

package/dist/types/calls/getUserInfo.d.ts

@@ -0,0 +1,9 @@
+import type { IChaynsReact, UserInfoQuery } from '../types/IChaynsReact';
+declare const getUserInfo: (api: IChaynsReact, value: UserInfoQuery) => Promise<{
+    firstName: string;
+    lastName: string;
+    userId: number;
+    personId: string;
+    name: string;
+} | null>;
+export default getUserInfo;

package/dist/types/calls/index.d.ts

@@ -0,0 +1,231 @@
+import { ChaynsApiDevice, ChaynsApiSite, UserInfo } from '../types/IChaynsReact';
+/**
+ * This adds a listener to determine your location.
+ * @category Event listener
+ */
+export declare const addGeoLocationListener: (value: {
+    timeout?: number | undefined;
+    silent?: boolean | undefined;
+}, callback: (geoLocation: import("../types/IChaynsReact").GeoLocation) => void) => Promise<number>;
+/**
+ * Adds a listener for scroll event by user.
+ * @category Event listener
+ */
+export declare const addScrollListener: (value: {
+    throttle?: number | undefined;
+}, callback: (result: import("../types/IChaynsReact").ScrollListenerResult) => void) => Promise<number>;
+/**
+ * This method will be executed when the page gets displayed or hidden.
+ * @category Event listener
+ */
+export declare const addVisibilityChangeListener: (callback: (result: import("../types/IChaynsReact").VisibilityChangeListenerResult) => void) => Promise<number>;
+/**
+ * This adds a listener to get the actual height of the page.
+ * @category Event listener
+ */
+export declare const addWindowMetricsListener: (callback: (result: import("../types/IChaynsReact").WindowMetricsListenerResult) => void) => Promise<number>; /**
+ * Allows a custom callback function to be defined
+ */
+export declare const customCallbackFunction: (type: string, data: unknown) => Promise<unknown>;
+/**
+ * Get the accessToken from the user.
+ */
+export declare const getAccessToken: (value?: import("../types/IChaynsReact").AccessToken | undefined) => Promise<import("../types/IChaynsReact").AccessTokenResult>;
+/**
+ * This method returns a list of installed share/social media apps.
+ */
+export declare const getAvailableSharingServices: () => Promise<import("../types/IChaynsReact").AvailableSharingServices>;
+/**
+ * This method determines your location. If you want to track a route, use addGeoLocationListener.
+ */
+export declare const getGeoLocation: (value: {
+    timeout?: number | undefined;
+    silent?: boolean | undefined;
+}) => Promise<import("../types/IChaynsReact").GeoLocation>;
+/**
+ * This method returns user information for a specific user.
+ * @category User functions
+ */
+export declare const getUserInfo: (value: import("../types/IChaynsReact").UserInfoQuery) => Promise<UserInfo | null>;
+/**
+ * Return the current scroll position of the top frame
+ */
+export declare const getScrollPosition: () => Promise<import("../types/IChaynsReact").ScrollListenerResult>;
+/**
+ * Returns the window metrics.
+ */
+export declare const getWindowMetrics: () => Promise<import("../types/IChaynsReact").WindowMetricsListenerResult>;
+/** @internal */
+export declare const invokeCall: (value: import("../types/IChaynsReact").InvokeCall, callback?: ((result: any) => void) | undefined) => Promise<any>;
+/** @internal */
+export declare const invokeDialogCall: (value: import("../types/IChaynsReact").InvokeCall, callback?: ((result: any) => void) | undefined) => Promise<any>;
+/**
+ * This method will show a login dialog where the user has the opportunity to log in.
+ */
+export declare const login: (value?: import("../types/IChaynsReact").Login | undefined, callback?: ((result: boolean) => void) | undefined, closeCallback?: (() => void) | undefined) => Promise<import("../types/IChaynsReact").LoginResult>;
+/**
+ * This method will logout the user
+ */
+export declare const logout: () => Promise<void>;
+/**
+ * This function navigates you to the previous site.
+ */
+export declare const navigateBack: () => Promise<void>;
+/**
+ * The images specified in the url array is shown in gallery mode.
+ */
+export declare const openImage: (value: import("../types/IChaynsReact").OpenImage) => Promise<void>;
+/**
+ * Opens an URL in the chayns environment.
+ */
+export declare const openUrl: (value: import("../types/IChaynsReact").OpenUrl) => Promise<void>;
+/**
+ * The video specified in the URL is shown in video mode.
+ */
+export declare const openVideo: (value: import("../types/IChaynsReact").OpenVideo) => Promise<void>;
+/**
+ * Refresh badge count in navigation, user information and pages
+ */
+export declare const refreshData: (value: import("../types/IChaynsReact").RefreshData) => Promise<void>;
+/**
+ * Refresh accesstoken, should only be used when user object changes, not when token is invalid
+ */
+export declare const refreshAccessToken: () => Promise<void>;
+/**
+ * This removes a listener to determine your location.
+ * @category Event listener
+ */
+export declare const removeGeoLocationListener: (value: number) => Promise<void>;
+/**
+ * Removes scroll listener.
+ * @category Event listener
+ */
+export declare const removeScrollListener: (value: number) => Promise<void>;
+/**
+ * Removes visibility change listener.
+ * @category Event listener
+ */
+export declare const removeVisibilityChangeListener: (value: number) => Promise<void>;
+/**
+ * Removes window metrics listener.
+ * @category Event listener
+ */
+export declare const removeWindowMetricsListener: (value: number) => Promise<void>;
+/**
+ * Select other page on chayns site.
+ */
+export declare const selectPage: (value: import("../types/IChaynsReact").SelectPage) => Promise<void>;
+/**
+ * Scrolls to specific position.
+ */
+export declare const scrollToY: (position: number, duration: number) => Promise<void>;
+/**
+ * Sends intercom message to group.
+ */
+export declare const sendMessageToGroup: (groupId: number, message: import("../types/IChaynsReact").IntercomMessage) => Promise<Response>;
+/**
+ * Sends intercom message to page.
+ */
+export declare const sendMessageToPage: (message: import("../types/IChaynsReact").IntercomMessage) => Promise<Response>;
+/**
+ * Sends intercom message to an user.
+ */
+export declare const sendMessageToUser: (userId: number, message: import("../types/IChaynsReact").IntercomMessage) => Promise<Response>;
+/**
+ * Switches admin mode, also toggles admin switch in top frame.
+ */
+export declare const setAdminMode: (enabled: boolean) => Promise<void>;
+/**
+ * Sets the display timeout, only works in chayns App.
+ */
+export declare const setDisplayTimeout: (enabled: boolean) => Promise<import("../types/IChaynsReact").DisplayTimeout>;
+/**
+ * Enables or disables a button which floats over the page.
+ */
+export declare const setFloatingButton: (value: import("../types/IChaynsReact").FloatingButton, callback: () => void) => Promise<void>;
+/**
+ * Sets the height of the page.
+ */
+export declare const setHeight: (height: number) => Promise<void>;
+/**
+ * Enables or disables the ability to refresh a page
+ */
+export declare const setRefreshScrollEnabled: (enabled: boolean) => Promise<import("../types/IChaynsReact").RefreshScrollEnabled>;
+/**
+ * Scans a qr-code and returns the result
+ */
+export declare const setScanQrCode: (value: import("../types/IChaynsReact").ScanQrCodeRequest) => Promise<import("../types/IChaynsReact").ScanQrCodeResult>;
+/**
+ * Temporarily change design settings in top frame
+ */
+export declare const setTempDesignSettings: (value: import("../types/IChaynsReact").DesignSettings) => Promise<void>;
+/**
+ * Shows or hide a waitcursor
+ */
+export declare const setWaitCursor: (value: import("../types/IChaynsReact").WaitCursor) => Promise<void>;
+/**
+ * Retrieves the value that is assigned to the key from a storage outside the frame
+ */
+export declare const storageGetItem: (key: string, accessMode?: import("../types/IChaynsReact").AccessMode | undefined) => Promise<any>;
+/**
+ * Removes the value that is assigned to the key from a storage outside the frame
+ */
+export declare const storageRemoveItem: (key: string, accessMode?: import("../types/IChaynsReact").AccessMode | undefined) => Promise<void>;
+/**
+ * Sets the value that is assigned to the key from a storage outside the frame
+ */
+export declare const storageSetItem: (key: string, value: any, accessMode?: import("../types/IChaynsReact").AccessMode | undefined, tappIds?: number[] | undefined) => Promise<void>;
+/**
+ * This method lets a smartphone vibrate for the given time.
+ */
+export declare const vibrate: (value: import("../types/IChaynsReact").Vibrate) => Promise<void>;
+/**
+ * Displays an overlay
+ */
+export declare const setOverlay: (value: import("../types/IChaynsReact").ShowOverlay, callback: () => void) => Promise<void>;
+/**
+ * Returns user information, only when user is logged in
+ * @category User functions
+ */
+export declare const getUser: () => import("../types/IChaynsReact").ChaynsApiUser | undefined;
+export declare const getSite: () => ChaynsApiSite;
+export declare const getDevice: () => ChaynsApiDevice;
+export declare const getLanguage: () => {
+    site: import("../types/IChaynsReact").Language;
+    translation: import("../types/IChaynsReact").Language | null;
+    /**
+     * This method returns a list of installed share/social media apps.
+     */
+    device: import("../types/IChaynsReact").Language;
+    active: import("../types/IChaynsReact").Language;
+};
+export declare const getParameters: () => {
+    [key: string]: string;
+    [key: symbol]: string;
+};
+export declare const getPages: () => import("../types/IChaynsReact").Page[];
+export declare const getEnvironment: () => {
+    buildEnvironment: import("../types/IChaynsReact").Environment;
+    runtimeEnvironment: string | import("../types/IChaynsReact").RuntimeEnviroment;
+};
+export declare const user: UserInfo;
+export declare const site: ChaynsApiSite;
+export declare const device: ChaynsApiDevice;
+export declare const language: {
+    site: import("../types/IChaynsReact").Language;
+    translation: import("../types/IChaynsReact").Language | null;
+    /**
+     * This method returns a list of installed share/social media apps.
+     */
+    device: import("../types/IChaynsReact").Language;
+    active: import("../types/IChaynsReact").Language;
+};
+export declare const parameters: {
+    [key: string]: string;
+    [key: symbol]: string;
+};
+export declare const pages: import("../types/IChaynsReact").Page[];
+export declare const environment: {
+    buildEnvironment: import("../types/IChaynsReact").Environment;
+    runtimeEnvironment: string | import("../types/IChaynsReact").RuntimeEnviroment;
+};

package/dist/types/calls/sendMessage.d.ts

@@ -0,0 +1,13 @@
+import type { IChaynsReact, IntercomMessage } from '../types/IChaynsReact';
+/**
+ * @category Intercom functions
+ */
+export declare const sendMessageToUser: (api: IChaynsReact, object: IntercomMessage, receiverUserId: number) => Promise<Response>;
+/**
+ * @category Intercom functions
+ */
+export declare const sendMessageToPage: (api: IChaynsReact, object: IntercomMessage) => Promise<Response>;
+/**
+ * @category Intercom functions
+ */
+export declare const sendMessageToGroup: (api: IChaynsReact, object: IntercomMessage, groupId: number) => Promise<Response>;

package/dist/types/calls/visibilityChangeListener.d.ts

@@ -0,0 +1,9 @@
+import { VisibilityChangeListenerResult } from '../types/IChaynsReact';
+/**
+ * @category Event listener
+ */
+export declare const addVisibilityChangeListener: (callback: (result: VisibilityChangeListenerResult) => void) => number;
+/**
+ * @category Event listener
+ */
+export declare const removeVisibilityChangeListener: (id: number) => void;

package/dist/types/client.d.ts

@@ -0,0 +1,7 @@
+export { default as ChaynsProvider } from './components/ChaynsModuleProvider';
+export { default as ChaynsHost } from './host/ChaynsHost';
+export { default as getDeviceInfo, getScreenSize } from './util/deviceHelper';
+export * from './components/ChaynsModuleProvider';
+export * from './components/withCompatMode';
+export * as dialog from './calls/dialogs/index';
+export * from './types/IChaynsReact';

package/dist/types/components/ChaynsContext.d.ts

@@ -0,0 +1,3 @@
+import { ChaynsReactFunctions, ChaynsReactValues } from '../types/IChaynsReact';
+export declare const ChaynsContext: import("use-context-selector").Context<ChaynsReactValues | null>;
+export declare const ChaynsFunctionsContext: import("use-context-selector").Context<ChaynsReactFunctions>;