chayns-api 1.0.0

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

@@ -0,0 +1,170 @@
+import { ReactChild, ReactChildren } from "react";
+import { ChaynsApiDevice, ChaynsApiSite, ChaynsReactValues, UserInfo } from "../types/IChaynsReact";
+interface TestChild {
+    children: ReactChild | ReactChildren;
+}
+declare const ChaynsProvider: ({ children, renderedByServer, ...props }: TestChild) => false | JSX.Element;
+export declare const useGeoLocation: (args_0?: {
+    enabled?: boolean | undefined;
+    timeout?: number | undefined;
+    silent?: boolean | undefined;
+} | undefined) => {
+    value: import("../types/IChaynsReact").GeoLocation | null;
+};
+export declare const addGeoLocationListener: (value: {
+    timeout?: number | undefined;
+    silent?: boolean | undefined;
+}, callback: (geoLocation: import("../types/IChaynsReact").GeoLocation) => void) => Promise<number>;
+export declare const addScrollListener: (value: {
+    throttle?: number | undefined;
+}, callback: (result: import("../types/IChaynsReact").ScrollListenerResult) => void) => Promise<number>;
+export declare const addVisibilityChangeListener: (callback: (result: import("../types/IChaynsReact").VisibilityChangeListenerResult) => void) => Promise<number>;
+export declare const addWindowMetricsListener: (callback: (result: import("../types/IChaynsReact").WindowMetricsListenerResult) => void) => Promise<number>;
+export declare const getAccessToken: (value?: import("../types/IChaynsReact").AccessToken | undefined) => Promise<import("../types/IChaynsReact").AccessTokenResult>;
+export declare const getAvailableSharingServices: () => Promise<import("../types/IChaynsReact").AvailableSharingServices>;
+export declare const getGeoLocation: (value: {
+    timeout?: number | undefined;
+    silent?: boolean | undefined;
+}) => Promise<import("../types/IChaynsReact").GeoLocation>;
+export declare const getUserInfo: (value: import("../types/IChaynsReact").UserInfoQuery) => Promise<UserInfo | null>;
+export declare const getScrollPosition: () => Promise<import("../types/IChaynsReact").ScrollListenerResult>;
+export declare const getWindowMetrics: () => Promise<import("../types/IChaynsReact").WindowMetricsListenerResult>;
+export declare const invokeCall: (value: import("../types/IChaynsReact").InvokeCall, callback?: ((result: any) => void) | undefined) => Promise<any>;
+export declare const invokeDialogCall: (value: import("../types/IChaynsReact").InvokeCall, callback?: ((result: any) => void) | undefined) => Promise<any>;
+export declare const login: (value?: import("../types/IChaynsReact").Login | undefined, callback?: ((result: boolean) => void) | undefined, closeCallback?: (() => void) | undefined) => Promise<import("../types/IChaynsReact").LoginResult>;
+export declare const logout: () => Promise<void>;
+export declare const navigateBack: () => Promise<void>;
+export declare const openImage: (value: import("../types/IChaynsReact").OpenImage) => Promise<void>;
+export declare const openUrl: (value: import("../types/IChaynsReact").OpenUrl) => Promise<void>;
+export declare const openVideo: (value: import("../types/IChaynsReact").OpenVideo) => Promise<void>;
+export declare const refreshAccessToken: () => Promise<void>;
+export declare const refreshData: (value: import("../types/IChaynsReact").RefreshData) => Promise<void>;
+export declare const removeGeoLocationListener: (value: number) => Promise<void>;
+export declare const removeScrollListener: (value: number) => Promise<void>;
+export declare const removeVisibilityChangeListener: (value: number) => Promise<void>;
+export declare const removeWindowMetricsListener: (value: number) => Promise<void>;
+export declare const selectPage: (value: import("../types/IChaynsReact").SelectPage) => Promise<void>;
+export declare const scrollToY: (position: number, duration: number) => Promise<void>;
+export declare const sendMessageToGroup: (groupId: number, message: import("../types/IChaynsReact").IntercomMessage) => Promise<Response>;
+export declare const sendMessageToPage: (message: import("../types/IChaynsReact").IntercomMessage) => Promise<Response>;
+export declare const sendMessageToUser: (userId: number, message: import("../types/IChaynsReact").IntercomMessage) => Promise<Response>;
+export declare const setAdminMode: (enabled: boolean) => Promise<void>;
+export declare const setDisplayTimeout: (enabled: boolean) => Promise<import("../types/IChaynsReact").DisplayTimeout>;
+export declare const setFloatingButton: (value: import("../types/IChaynsReact").FloatingButton, callback: () => void) => Promise<void>;
+export declare const setHeight: (height: number) => Promise<void>;
+export declare const setOverlay: (value: import("../types/IChaynsReact").ShowOverlay, callback: () => void) => Promise<void>;
+export declare const setRefreshScrollEnabled: (enabled: boolean) => Promise<import("../types/IChaynsReact").RefreshScrollEnabled>;
+export declare const setScanQrCode: (value: import("../types/IChaynsReact").ScanQrCodeRequest) => Promise<import("../types/IChaynsReact").ScanQrCodeResult>;
+export declare const setTempDesignSettings: (value: import("../types/IChaynsReact").DesignSettings) => Promise<void>;
+export declare const setWaitCursor: (value: import("../types/IChaynsReact").WaitCursor) => Promise<void>;
+export declare const storageGetItem: (key: string, accessMode: import("../types/IChaynsReact").AccessMode) => Promise<any>;
+export declare const storageRemoveItem: (key: string, accessMode: import("../types/IChaynsReact").AccessMode) => Promise<void>;
+export declare const storageSetItem: (key: string, value: any, accessMode: import("../types/IChaynsReact").AccessMode, tappIds: number[]) => Promise<void>;
+export declare const vibrate: (value: import("../types/IChaynsReact").Vibrate) => Promise<void>;
+export declare const useAccessToken: (accessToken?: import("../types/IChaynsReact").AccessToken | undefined) => string | undefined;
+export declare const useWindowMetrics: (args_0?: {
+    enabled?: boolean | undefined;
+} | undefined) => import("../types/IChaynsReact").WindowMetricsListenerResult;
+export declare const useScrollPosition: (args_0?: {
+    enabled?: boolean | undefined;
+    throttle?: number | undefined;
+} | undefined) => import("../types/IChaynsReact").ScrollListenerResult;
+export declare const useUser: () => import("../types/IChaynsReact").ChaynsApiUser;
+export declare const useIsAdminMode: () => boolean;
+export declare const useScrollOffsetTop: (args_0?: {
+    enabled?: boolean | undefined;
+    throttle?: number | undefined;
+} | undefined) => number;
+export declare const useScrollOffsetBottom: (args_0?: {
+    enabled?: boolean | undefined;
+    throttle?: number | undefined;
+} | undefined) => number;
+export declare const useScrollListener: () => (value: {
+    throttle?: number | undefined;
+}, callback: (result: import("../types/IChaynsReact").ScrollListenerResult) => void) => () => void;
+export declare const useWindowMetricsListener: () => (callback: (result: import("../types/IChaynsReact").WindowMetricsListenerResult) => void) => () => void;
+export declare const useGeoLocationListener: () => (value: {
+    timeout?: number | undefined;
+    silent?: boolean | undefined;
+}, callback: (result: import("../types/IChaynsReact").GeoLocation) => void) => () => void;
+export declare const WaitUntil: ({ children, ...props }: TestChild) => JSX.Element;
+export declare const getUser: () => import("../types/IChaynsReact").ChaynsApiUser | undefined;
+export declare const getSite: () => ChaynsApiSite;
+export declare const getDevice: () => ChaynsApiDevice;
+export declare const useDevice: () => ChaynsApiDevice;
+export declare const useSite: () => ChaynsApiSite;
+export declare const getLanguage: () => {
+    site: import("../types/IChaynsReact").Language;
+    translation: import("../types/IChaynsReact").Language;
+    device: import("../types/IChaynsReact").Language;
+    active: import("../types/IChaynsReact").Language;
+};
+export declare const getParameters: () => {
+    [key: string]: string;
+    [key: symbol]: string;
+};
+export declare const useParameters: () => {
+    [key: string]: string;
+    [key: symbol]: string;
+};
+export declare const usePages: () => import("../types/IChaynsReact").Page[];
+export declare const usePage: () => import("../types/IChaynsReact").Page | null;
+export declare const getPages: () => import("../types/IChaynsReact").Page[];
+export declare const useEnvironment: () => {
+    buildEnvironment: import("../types/IChaynsReact").Environment;
+    runtimeEnvironment: string | import("../types/IChaynsReact").RuntimeEnviroment;
+};
+export declare const useCustomData: () => any;
+export declare const getEnvironment: () => {
+    buildEnvironment: import("../types/IChaynsReact").Environment;
+    runtimeEnvironment: string | import("../types/IChaynsReact").RuntimeEnviroment;
+};
+export declare const useLanguage: () => {
+    site: import("../types/IChaynsReact").Language;
+    translation: import("../types/IChaynsReact").Language;
+    device: import("../types/IChaynsReact").Language;
+    active: import("../types/IChaynsReact").Language;
+};
+export declare const useValues: () => ChaynsReactValues;
+export declare const useFunctions: () => import("../types/IChaynsReact").ChaynsReactFunctions;
+export declare const useCurrentPage: () => any;
+/**
+ * @deprecated
+ */
+export declare const user: UserInfo;
+/**
+ * @deprecated
+ */
+export declare const site: ChaynsApiSite;
+/**
+ * @deprecated
+ */
+export declare const device: ChaynsApiDevice;
+/**
+ * @deprecated
+ */
+export declare const language: {
+    site: import("../types/IChaynsReact").Language;
+    translation: import("../types/IChaynsReact").Language;
+    device: import("../types/IChaynsReact").Language;
+    active: import("../types/IChaynsReact").Language;
+};
+/**
+ * @deprecated
+ */
+export declare const parameters: {
+    [key: string]: string;
+    [key: symbol]: string;
+};
+/**
+ * @deprecated
+ */
+export declare const pages: import("../types/IChaynsReact").Page[];
+/**
+ * @deprecated
+ */
+export declare const environment: {
+    buildEnvironment: import("../types/IChaynsReact").Environment;
+    runtimeEnvironment: string | import("../types/IChaynsReact").RuntimeEnviroment;
+};
+export default ChaynsProvider;

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

@@ -0,0 +1,13 @@
+import React from 'react';
+import { ChaynsReactFunctions, ChaynsReactValues, IChaynsReact } from '../types/IChaynsReact';
+export declare const moduleWrapper: {
+    current: IChaynsReact;
+};
+type ChaynsProviderProps = {
+    data?: ChaynsReactValues;
+    functions?: ChaynsReactFunctions;
+    renderedByServer?: boolean;
+    isModule?: boolean;
+};
+declare const ChaynsProvider: React.FC<ChaynsProviderProps>;
+export default ChaynsProvider;

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

@@ -0,0 +1,7 @@
+import { FC, ReactNode } from "react";
+type TaskList = (TaskList | Promise<unknown> | (() => Promise<unknown>))[];
+export declare const WaitUntil: FC<{
+    tasks: TaskList;
+    loadingComponent?: ReactNode;
+}>;
+export {};

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

@@ -0,0 +1,13 @@
+import React, { RefObject } from 'react';
+type Props = {
+    innerRef?: RefObject<unknown>;
+} & object;
+export declare const withCompatMode: <P extends Props>(Component: React.ComponentType<P>) => {
+    Component: React.ForwardRefExoticComponent<React.RefAttributes<unknown>>;
+    CompatComponent: React.ForwardRefExoticComponent<React.RefAttributes<unknown>>;
+    requiredVersion: any;
+    environment: string | undefined;
+    buildEnv: string | undefined;
+    appVersion: string | undefined;
+};
+export {};

package/dist/types/helper/apiListenerHelper.d.ts

@@ -0,0 +1,6 @@
+export declare const addApiListener: (key: string, callback: (result: any) => unknown | void) => {
+    id: number;
+    shouldInitialize: boolean;
+};
+export declare const removeApiListener: (key: string, id: number) => boolean;
+export declare const dispatchApiEvent: (key: string, value: unknown) => void;

package/dist/types/hooks/geoLocationListener.d.ts

@@ -0,0 +1,18 @@
+import { GeoLocation } from '../types/IChaynsReact';
+/**
+ * @category Hooks
+ */
+export declare const useGeoLocationListener: () => (value: {
+    timeout?: number;
+    silent?: boolean;
+}, callback: (result: GeoLocation) => void) => () => void;
+/**
+ * @category Hooks
+ */
+export declare const useGeoLocation: ({ enabled, timeout, silent }?: {
+    enabled?: boolean | undefined;
+    timeout?: number | undefined;
+    silent?: boolean | undefined;
+}) => {
+    value: GeoLocation | null;
+};

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

@@ -0,0 +1,16 @@
+export { useGeoLocation, useGeoLocationListener } from './geoLocationListener';
+export { useScrollPosition, useScrollListener, useScrollOffsetBottom, useScrollOffsetTop, } from './scrollListener';
+export { useIsAdminMode } from './useIsAdminMode';
+export { useUser } from './useUser';
+export { useAccessToken } from './useAccessToken';
+export { useWindowMetrics, useWindowMetricsListener } from './windowMetricsListener';
+export { useDevice } from './useDevice';
+export { useSite } from './useSite';
+export { useParameters } from './useParameters';
+export { usePages, usePage } from './usePages';
+export { useEnvironment } from './useEnvironment';
+export { useLanguage } from './useLanguage';
+export { useValues } from './useValues';
+export { useFunctions } from './useFunctions';
+export { useCurrentPage } from './useCurrentPage';
+export { useCustomData } from './useCustomData';

package/dist/types/hooks/scrollListener.d.ts

@@ -0,0 +1,28 @@
+import { ScrollListenerResult } from '../types/IChaynsReact';
+/**
+ * @category Hooks
+ */
+export declare const useScrollListener: () => (value: {
+    throttle?: number;
+}, callback: (result: ScrollListenerResult) => void) => () => void;
+/**
+ * @category Hooks
+ */
+export declare const useScrollPosition: ({ enabled, throttle }?: {
+    enabled?: boolean | undefined;
+    throttle?: number | undefined;
+}) => ScrollListenerResult;
+/**
+ * @category Hooks
+ */
+export declare const useScrollOffsetTop: ({ enabled, throttle }?: {
+    enabled?: boolean | undefined;
+    throttle?: number | undefined;
+}) => number;
+/**
+ * @category Hooks
+ */
+export declare const useScrollOffsetBottom: ({ enabled, throttle }?: {
+    enabled?: boolean | undefined;
+    throttle?: number | undefined;
+}) => number;

package/dist/types/hooks/useAccessToken.d.ts

@@ -0,0 +1,5 @@
+import { AccessToken } from "../types/IChaynsReact";
+/**
+ * @category Hooks
+ */
+export declare const useAccessToken: (accessToken?: AccessToken) => string | undefined;

package/dist/types/hooks/useCurrentPage.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @category Hooks
+ */
+export declare const useCurrentPage: () => any;

package/dist/types/hooks/useCustomData.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @category Hooks
+ */
+export declare const useCustomData: () => any;

package/dist/types/hooks/useDevice.d.ts

@@ -0,0 +1,5 @@
+import { ChaynsApiDevice } from '../types/IChaynsReact';
+/**
+ * @category Hooks
+ */
+export declare const useDevice: () => ChaynsApiDevice;

package/dist/types/hooks/useEnvironment.d.ts

@@ -0,0 +1,5 @@
+import { ChaynsReactValues } from '../types/IChaynsReact';
+/**
+ * @category Hooks
+ */
+export declare const useEnvironment: () => ChaynsReactValues["environment"];

package/dist/types/hooks/useFunctions.d.ts

@@ -0,0 +1,5 @@
+import { ChaynsReactFunctions } from "../types/IChaynsReact";
+/**
+ * @category Hooks
+ */
+export declare const useFunctions: () => ChaynsReactFunctions;

package/dist/types/hooks/useIsAdminMode.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @category Hooks
+ */
+export declare const useIsAdminMode: () => boolean;

package/dist/types/hooks/useLanguage.d.ts

@@ -0,0 +1,5 @@
+import { ChaynsReactValues } from '../types/IChaynsReact';
+/**
+ * @category Hooks
+ */
+export declare const useLanguage: () => ChaynsReactValues["language"];

package/dist/types/hooks/usePages.d.ts

@@ -0,0 +1,14 @@
+import { ChaynsReactValues, Page } from '../types/IChaynsReact';
+/**
+ * @category Hooks
+ */
+export declare const usePages: ({ siteId }?: {
+    siteId: undefined;
+}) => ChaynsReactValues["pages"];
+/**
+ * @category Hooks
+ */
+export declare const usePage: ({ id, siteId }: {
+    id: any;
+    siteId: any;
+}) => Page | null;

package/dist/types/hooks/useParameters.d.ts

@@ -0,0 +1,5 @@
+import { ChaynsReactValues } from '../types/IChaynsReact';
+/**
+ * @category Hooks
+ */
+export declare const useParameters: () => ChaynsReactValues['parameters'];

package/dist/types/hooks/useSite.d.ts

@@ -0,0 +1,5 @@
+import { ChaynsApiSite } from '../types/IChaynsReact';
+/**
+ * @category Hooks
+ */
+export declare const useSite: () => ChaynsApiSite;

package/dist/types/hooks/useUser.d.ts

@@ -0,0 +1,5 @@
+import { ChaynsApiUser } from '../types/IChaynsReact';
+/**
+ * @category Hooks
+ */
+export declare const useUser: () => ChaynsApiUser;

package/dist/types/hooks/useValues.d.ts

@@ -0,0 +1,5 @@
+import { ChaynsReactValues } from '../types/IChaynsReact';
+/**
+ * @category Hooks
+ */
+export declare const useValues: () => ChaynsReactValues;

package/dist/types/hooks/windowMetricsListener.d.ts

@@ -0,0 +1,11 @@
+import { WindowMetricsListenerResult } from '../types/IChaynsReact';
+/**
+ * @category Hooks
+ */
+export declare const useWindowMetricsListener: () => (callback: (result: WindowMetricsListenerResult) => void) => () => void;
+/**
+ * @category Hooks
+ */
+export declare const useWindowMetrics: ({ enabled }?: {
+    enabled?: boolean | undefined;
+}) => WindowMetricsListenerResult;

package/dist/types/host/ChaynsHost.d.ts

@@ -0,0 +1,27 @@
+import React, { FC } from 'react';
+import { TypeSystem } from './module/ModuleHost';
+import { ChaynsApiDevice, ChaynsApiSite, ChaynsApiUser, ChaynsReactFunctions, ChaynsReactValues, Page } from '../types/IChaynsReact';
+type ChaynsHostType = {
+    type: string;
+    iFrameProps: {
+        [key: string]: unknown;
+        name: string;
+    };
+    functions: ChaynsReactFunctions;
+    src: string;
+    iFrameRef: React.MutableRefObject<HTMLIFrameElement | null> | undefined;
+    children?: JSX.Element;
+    system: TypeSystem;
+    pages: Page[];
+    isAdminModeActive: boolean;
+    site: ChaynsApiSite;
+    user: ChaynsApiUser | undefined;
+    currentPage: ChaynsReactValues["currentPage"];
+    device: ChaynsApiDevice;
+    language: ChaynsReactValues["language"];
+    parameters: ChaynsReactValues["parameters"];
+    customData: any;
+    environment: ChaynsReactValues["environment"];
+};
+declare const ChaynsHost: FC<ChaynsHostType>;
+export default ChaynsHost;

package/dist/types/host/iframe/HostIframe.d.ts

@@ -0,0 +1,24 @@
+import React, { FC } from 'react';
+import { ChaynsApiDevice, ChaynsApiSite, ChaynsApiUser, ChaynsReactFunctions, ChaynsReactValues, Page } from '../../types/IChaynsReact';
+type HostIframeProps = {
+    iFrameProps: {
+        [key: string]: unknown;
+        name: string;
+    };
+    src: string;
+    postForm?: boolean;
+    iFrameRef: React.MutableRefObject<HTMLIFrameElement | null> | undefined;
+    pages: Page[];
+    isAdminModeActive: boolean;
+    site: ChaynsApiSite;
+    user: ChaynsApiUser | undefined;
+    currentPage: ChaynsReactValues["currentPage"];
+    functions: ChaynsReactFunctions;
+    device: ChaynsApiDevice;
+    language: ChaynsReactValues["language"];
+    parameters: ChaynsReactValues["parameters"];
+    environment: ChaynsReactValues["environment"];
+    customData: ChaynsReactValues["customData"];
+};
+declare const HostIframe: FC<HostIframeProps>;
+export default HostIframe;

package/dist/types/host/iframe/utils/useUpdateData.d.ts

@@ -0,0 +1,3 @@
+import { ChaynsReactValues } from '../../../types/IChaynsReact';
+declare const useUpdateData: <T extends keyof ChaynsReactValues>(target: EventTarget | undefined, type: T, value: ChaynsReactValues[T]) => void;
+export default useUpdateData;

package/dist/types/host/module/ModuleHost.d.ts

@@ -0,0 +1,23 @@
+import { FC } from 'react';
+import { ChaynsApiDevice, ChaynsApiSite, ChaynsApiUser, ChaynsReactFunctions, ChaynsReactValues, Page } from '../../types/IChaynsReact';
+export type TypeSystem = {
+    scope: string;
+    url: string;
+    module: string;
+};
+type ModulePropTypes = {
+    system: TypeSystem;
+    functions: ChaynsReactFunctions;
+    pages: Page[];
+    isAdminModeActive: boolean;
+    site: ChaynsApiSite;
+    user: ChaynsApiUser | undefined;
+    currentPage: ChaynsReactValues["currentPage"];
+    device: ChaynsApiDevice;
+    language: ChaynsReactValues["language"];
+    parameters: ChaynsReactValues["parameters"];
+    customData: any;
+    environment: ChaynsReactValues["environment"];
+};
+declare const ModuleHost: FC<ModulePropTypes>;
+export default ModuleHost;

package/dist/types/host/module/PagemakerFrame.d.ts

@@ -0,0 +1,22 @@
+import React, { FC } from 'react';
+import { ChaynsApiDevice, ChaynsApiSite, ChaynsApiUser, ChaynsReactFunctions, ChaynsReactValues, Page } from '../../types/IChaynsReact';
+declare type PagemakerFrameProps = {
+    iFrameProps: {
+        [key: string]: unknown;
+        name: string;
+    };
+    postForm?: boolean;
+    iFrameRef: React.MutableRefObject<HTMLIFrameElement | null> | undefined;
+    pages: Page[];
+    isAdminModeActive: boolean;
+    site: ChaynsApiSite;
+    user: ChaynsApiUser;
+    currentPage: ChaynsReactValues["currentPage"];
+    functions: ChaynsReactFunctions;
+    device: ChaynsApiDevice;
+    language: ChaynsReactValues["language"];
+    parameters: ChaynsReactValues["parameters"];
+    environment: ChaynsReactValues["environment"];
+};
+declare const PagemakerFrame: FC<PagemakerFrameProps>;
+export default PagemakerFrame;

package/dist/types/host/module/utils/loadComponent.d.ts

@@ -0,0 +1 @@
+export default function loadComponent(scope: any, module: any, url: any, skipCompatMode?: boolean): () => Promise<any>;

package/dist/types/host/module/utils/useDynamicScript.d.ts

@@ -0,0 +1,9 @@
+export declare const semaphore: {};
+declare const useDynamicScript: (args: {
+    url: string | undefined;
+    scope: string | undefined;
+}) => {
+    ready: boolean;
+    failed: boolean;
+};
+export default useDynamicScript;

package/dist/types/index.d.ts

@@ -0,0 +1,16 @@
+export { default as ChaynsProvider } from './components/ChaynsProvider';
+export { default as getDeviceInfo, getScreenSize } from './util/deviceHelper';
+export { default as ChaynsHost } from './host/ChaynsHost';
+export { withCompatMode } from './components/withCompatMode';
+export * from './calls';
+export * from './hooks';
+export * from './components/WaitUntil';
+export * from './types/IChaynsReact';
+export * from './components/withCompatMode';
+export * as dialog from './calls/dialogs/index';
+export * from './types/IChaynsReact';
+declare const _default: {
+    buildEnv: string | undefined;
+    appVersion: string | undefined;
+};
+export default _default;