chayns-api 1.0.0

package/dist/types/types/IChaynsReact.d.ts

@@ -0,0 +1,590 @@
+import { Browser, OperatingSystem } from 'detect-browser';
+import { DialogButton, SelectDialogItem } from "./dialog";
+export type ChaynsApiUser = {
+    firstName: string;
+    lastName: string;
+    gender: Gender;
+    uacGroups: UacGroup[];
+    userId: number;
+    personId: string;
+};
+export type ChaynsApiSite = {
+    id: string;
+    locationId: number;
+    locationPersonId: string;
+    color: string;
+    colorMode: ColorMode;
+    dynamicFontSize: boolean;
+    layoutDisposition: LayoutDisposition;
+    domain: string;
+    font: {
+        id: Font;
+        dynamicFontSize: boolean;
+        headlineFont: Font;
+    };
+    title: string;
+    url: string;
+    urlHash: string;
+};
+export declare enum ScreenSize {
+    XS = 0,
+    SM = 1,
+    MD = 2,
+    LG = 3,
+    XL = 4
+}
+export type ChaynsApiDevice = {
+    app?: {
+        name: AppName;
+        version: number;
+        storePackageName?: string;
+    };
+    browser?: {
+        name?: Browser | 'bot' | null;
+        version?: string | null;
+        majorVersion: number;
+        isWebPSupported: boolean;
+    };
+    imei?: string;
+    accessToken?: string;
+    os?: OperatingSystem | null;
+    isTouch: boolean;
+    screenSize: ScreenSize;
+};
+/**
+ * @ignore
+ */
+export interface ChaynsReactValues {
+    site: ChaynsApiSite;
+    user: ChaynsApiUser | undefined;
+    isAdminModeActive: boolean;
+    pages: Page[];
+    currentPage: {
+        id: number;
+        siteId: string;
+    };
+    device: ChaynsApiDevice;
+    language: {
+        site: Language;
+        translation: Language | null;
+        device: Language;
+        active: Language;
+    };
+    /**
+     * keys are in lower case
+     */
+    parameters: {
+        [key: string | symbol]: string;
+    };
+    environment: {
+        buildEnvironment: Environment;
+        runtimeEnvironment: RuntimeEnviroment | string;
+    };
+    customData: any;
+}
+/**
+ * @ignore
+ */
+export interface ChaynsReactFunctions {
+    addGeoLocationListener: (value: {
+        timeout?: number;
+        silent?: boolean;
+    }, callback: (geoLocation: GeoLocation) => void) => Promise<number>;
+    addScrollListener: (value: {
+        throttle?: number;
+    }, callback: (result: ScrollListenerResult) => void) => Promise<number>;
+    addVisibilityChangeListener: (callback: (result: VisibilityChangeListenerResult) => void) => Promise<number>;
+    addWindowMetricsListener: (callback: (result: WindowMetricsListenerResult) => void) => Promise<number>;
+    customCallbackFunction: (type: string, data: unknown) => Promise<unknown>;
+    getAvailableSharingServices: () => Promise<AvailableSharingServices>;
+    getAccessToken: (value?: AccessToken) => Promise<AccessTokenResult>;
+    getGeoLocation: (value: {
+        timeout?: number;
+        silent?: boolean;
+    }) => Promise<GeoLocation>;
+    getUserInfo: (value: UserInfoQuery) => Promise<UserInfo | null>;
+    getScrollPosition: () => Promise<ScrollListenerResult>;
+    getWindowMetrics: () => Promise<WindowMetricsListenerResult>;
+    invokeCall: (value: InvokeCall, callback?: (result: any) => void) => Promise<any>;
+    invokeDialogCall: (value: InvokeCall, callback?: (result: any) => void) => Promise<any>;
+    login: (value?: Login, callback?: (result: boolean) => void, closeCallback?: () => void) => Promise<LoginResult>;
+    logout: () => Promise<void>;
+    navigateBack: () => Promise<void>;
+    openImage: (value: OpenImage) => Promise<void>;
+    openUrl: (value: OpenUrl) => Promise<void>;
+    openVideo: (value: OpenVideo) => Promise<void>;
+    refreshData: (value: RefreshData) => Promise<void>;
+    refreshAccessToken: () => Promise<void>;
+    removeGeoLocationListener: (value: number) => Promise<void>;
+    removeScrollListener: (value: number) => Promise<void>;
+    removeVisibilityChangeListener: (value: number) => Promise<void>;
+    removeWindowMetricsListener: (value: number) => Promise<void>;
+    selectPage: (value: SelectPage) => Promise<void>;
+    scrollToY: (position: number, duration: number) => Promise<void>;
+    sendMessageToGroup: (groupId: number, message: IntercomMessage) => Promise<Response>;
+    sendMessageToPage: (message: IntercomMessage) => Promise<Response>;
+    sendMessageToUser: (userId: number, message: IntercomMessage) => Promise<Response>;
+    setAdminMode: (enabled: boolean) => Promise<void>;
+    setDisplayTimeout: (enabled: boolean) => Promise<DisplayTimeout>;
+    setFloatingButton: (value: FloatingButton, callback: () => void) => Promise<void>;
+    setHeight: (height: number) => Promise<void>;
+    setRefreshScrollEnabled: (enabled: boolean) => Promise<RefreshScrollEnabled>;
+    setScanQrCode: (value: ScanQrCodeRequest) => Promise<ScanQrCodeResult>;
+    setTempDesignSettings: (value: DesignSettings) => Promise<void>;
+    setWaitCursor: (value: WaitCursor) => Promise<void>;
+    storageGetItem: (key: string, accessMode?: AccessMode) => Promise<any>;
+    storageRemoveItem: (key: string, accessMode?: AccessMode) => Promise<void>;
+    storageSetItem: (key: string, value: any, accessMode?: AccessMode, tappIds?: number[]) => Promise<void>;
+    vibrate: (value: Vibrate) => Promise<void>;
+    setOverlay: (value: ShowOverlay, callback: () => void) => Promise<void>;
+}
+export type SelectPage = {
+    id?: number;
+    position?: number;
+    path?: string;
+    showName?: string;
+    forceSelect?: boolean;
+    params?: {
+        [key: string]: string;
+    };
+    preventHistory?: boolean;
+    siteId?: string;
+    isAdminMode?: boolean;
+};
+export type AccessToken = {
+    external?: boolean;
+};
+export type AccessTokenResult = {
+    accessToken: string | undefined;
+};
+export declare enum AccessMode {
+    public = 0,
+    protected = 1,
+    'private' = 2
+}
+export interface RefreshData {
+    suffix?: boolean;
+    tapps?: boolean;
+    user?: boolean;
+}
+export type IntercomMessage = {
+    text: string;
+    images?: string[];
+};
+export type ScanQrCodeRequest = {
+    cancel: boolean;
+    timeout?: number;
+    cameraType: 0 | 1 | 2;
+};
+export type ScanQrCodeResult = {
+    qrCode: string;
+    geoLocation?: {
+        latitude: number;
+        longitude: number;
+        speed: number;
+    };
+    status: number;
+    resultType: number;
+};
+declare enum IOSFeedbackVibration {
+    Unknown = 0,
+    SelectionChanged = 1,
+    NotificationError = 2,
+    NotificationSuccess = 3,
+    NotificationWarning = 4,
+    Light = 5,
+    Medium = 6,
+    Heavy = 7,
+    Soft = 8,
+    Rigid = 9
+}
+export interface Vibrate {
+    pattern: number[];
+    iOSFeedbackVibration?: IOSFeedbackVibration;
+}
+export interface ShowOverlay {
+    show?: boolean;
+    header?: boolean;
+    url: string;
+    background?: boolean;
+    height?: string | number;
+    login?: boolean;
+}
+declare enum SnapshotType {
+    Background = "background",
+    Settings = "settings",
+    ColorScheme = "colorScheme",
+    Cover = "cover",
+    Tapp = "tapp"
+}
+declare enum DesignSettingsUpdateBackgroundType {
+    None = 0,
+    Image = 1,
+    Video = 2,
+    Color = 3
+}
+interface DesignSettingsUpdateGradient {
+    startColor?: string;
+    endColor: string;
+    type: number;
+}
+interface DesignSettingsUpdateBackground {
+    canvasBlur?: number;
+    canvasOpacity?: number;
+    color?: string;
+    filter?: string;
+    isRepeat?: boolean;
+    type?: DesignSettingsUpdateBackgroundType;
+    url?: string;
+    gradient?: DesignSettingsUpdateGradient;
+}
+declare enum DesignSettingsUpdateSeasonTypes {
+    None = 0,
+    Snowm = 1,
+    Confetti = 2,
+    Leaf = 3,
+    Heart = 4,
+    Balloon = 5,
+    Eastern = 6,
+    Clover = 7,
+    Coins = 8
+}
+declare enum DesignSettingsUpdateGalleryAnimationTypes {
+    Swipe = 0,
+    Fade = 1,
+    Parallax = 2,
+    KenBurns = 3
+}
+declare enum DesignSettingsUpdateCoverTypes {
+    Image = 0,
+    Video = 1,
+    Slideshow = 2,
+    Frame = 3,
+    None = 4
+}
+interface DesignSettingsUpdateCover {
+    animationType: DesignSettingsUpdateGalleryAnimationTypes;
+    seasonAnimation?: DesignSettingsUpdateSeasonTypes;
+    fallbackUrl?: string;
+    hide?: boolean;
+    overlayUrl?: string;
+    type: DesignSettingsUpdateCoverTypes;
+    urls: string[];
+}
+declare enum DesignSettingsUpdateColorSchemeMode {
+    Normal = 0,
+    Dark = 1,
+    Bright = 2
+}
+interface DesignSettingsUpdateColorScheme {
+    color: string;
+    mode: DesignSettingsUpdateColorSchemeMode;
+}
+interface DesignSettingsUpdateGlobalSettings {
+    useChatHead?: boolean;
+    addBackgroundColorInHeader?: boolean;
+    enableStagingSwitch?: boolean;
+    hideNavigationButton?: boolean;
+}
+declare enum DesignSettingsUpdateTappViewModes {
+    Normal = 0,
+    Exclusive = 1,
+    Wide = 2,
+    Fullscreen = 3,
+    FullscreenWithBackground = 4
+}
+interface DesignSettingsUpdateTapp {
+    viewMode?: DesignSettingsUpdateTappViewModes;
+    removeLocationBarHeight?: boolean;
+}
+export interface DesignSettings {
+    snapshot?: boolean;
+    resetOnTappChange?: boolean;
+    reset?: boolean;
+    updates: DesignSettingsUpdateItem[];
+}
+interface DesignSettingsUpdateItem {
+    type: SnapshotType;
+    value: DesignSettingsUpdateBackground | DesignSettingsUpdateCover | DesignSettingsUpdateColorScheme | DesignSettingsUpdateGlobalSettings | DesignSettingsUpdateTapp;
+}
+export interface IChaynsReact {
+    values: ChaynsReactValues;
+    functions: ChaynsReactFunctions;
+    addDataListener: (cb: DataChangeCallback) => CleanupCallback;
+    getSSRData: () => ChaynsReactValues | null;
+    init: () => Promise<void>;
+    getInitialData: () => ChaynsReactValues;
+}
+export interface OpenUrl {
+    sameWindow?: boolean;
+    url: string;
+    openInApp?: boolean;
+    overlay?: boolean;
+}
+export interface UserInfo {
+    personId: string;
+    userId: number;
+    firstName: string;
+    lastName: string;
+    name: string;
+}
+export type UserInfoQuery = {
+    personId: string;
+    userId?: never;
+} | {
+    personId?: string;
+    userId: number;
+};
+type OpenImageItem = {
+    url: string;
+    title?: string;
+    description?: string;
+    preventCache?: boolean;
+};
+export interface OpenImage {
+    items: [OpenImageItem, ...OpenImageItem[]];
+    startIndex?: number;
+}
+export interface OpenVideo {
+    url: string;
+}
+declare enum LoginState {
+    LoginFailed = 2,
+    AlreadyLoggedIn = 3
+}
+export interface LoginResult {
+    loginState: LoginState;
+}
+export interface Login {
+    ignoreAuthenticated: boolean;
+}
+export interface InvokeCall {
+    action: number;
+    value: object;
+}
+export interface WaitCursor {
+    isEnabled: boolean;
+    text?: string;
+    timeout?: number;
+    progress?: number;
+    progressText?: string;
+}
+export declare enum FloatingButtonPosition {
+    Right = 0,
+    Center = 1,
+    Left = 2
+}
+export interface FloatingButton {
+    isEnabled: boolean;
+    position: FloatingButtonPosition;
+    zIndex: number;
+    badge: string;
+    textSize: number;
+    color: string;
+    colorText: string;
+    icon: string;
+    text: string;
+    rotateIcon: boolean;
+    items: {
+        onClick?: () => Promise<void>;
+        text: string;
+        icon: string;
+    }[];
+}
+export declare enum SharingApp {
+    Mail = 0,
+    WhatsApp = 1,
+    Facebook = 2,
+    FacebookMessenger = 3,
+    GooglePlus = 4,
+    Twitter = 5
+}
+export interface AvailableSharingServices {
+    availableSharingApps: SharingApp[];
+    availableAndroidApps?: string[];
+}
+export interface DisplayTimeout {
+    isEnabled: boolean;
+}
+export interface AdminMode {
+    isEnabled: boolean;
+}
+export interface RefreshScrollEnabled {
+    isEnabled: boolean;
+}
+export interface GeoLocation {
+    accuracy: number | null;
+    latitude: number;
+    longitude: number;
+    speed: number;
+    code: number;
+}
+export type DataChangeValue = {
+    type: 'page';
+    value: Page[];
+} | {
+    type: 'user';
+    value: ChaynsApiUser | undefined;
+} | {
+    type: 'site';
+    value: ChaynsApiSite;
+} | {
+    type: 'isAdminModeActive';
+    value: ChaynsReactValues["isAdminModeActive"];
+};
+export type DataChangeCallback = ((value: DataChangeValue) => void);
+export type CleanupCallback = (() => void);
+export interface WindowMetricsListenerResult {
+    bottomBarHeight: number;
+    topBarHeight: number;
+    offsetTop: number;
+    windowHeight: number;
+    pageHeight: number;
+    pageWidth: number;
+    pageSize: ScreenSize;
+}
+export interface VisibilityChangeListenerResult {
+    isVisible: boolean;
+}
+export interface ScrollListenerResult {
+    scrollX: number | null;
+    scrollY: number | null;
+}
+interface LayoutDisposition {
+    barOnTop: boolean;
+    barWide: boolean;
+    contentWide: boolean;
+    coverDetached: boolean;
+    coverHidden: boolean;
+    coverWide: boolean;
+    docked: boolean;
+}
+interface UacGroup {
+    id: number;
+}
+export declare enum IconType {
+    Font = 0,
+    Base64 = 1,
+    Url = 2
+}
+export interface Page {
+    id: number;
+    icon: string;
+    iconType: IconType;
+    customUrl: string;
+    isExclusive: boolean;
+    isHiddenFromMenu: boolean;
+    minAge: number;
+    name: string;
+    sortId: number;
+    siteId: string;
+    uacGroups: UacGroup[];
+}
+export declare enum Gender {
+    Unknown = 0,
+    male = 1,
+    female = 2,
+    diverse = 9
+}
+export declare enum ColorMode {
+    Classic = 0,
+    Dark = 1,
+    Light = 2
+}
+export declare enum Language {
+    Unknown = "unknown",
+    German = "de",
+    English = "en",
+    Dutch = "nl",
+    French = "fr",
+    Spanish = "es",
+    Italian = "it",
+    Portuguese = "pt",
+    Turkish = "tr",
+    Polish = "pl",
+    Ukrainian = "uk"
+}
+export declare enum RuntimeEnviroment {
+    Unknown = 0,
+    ChaynsDe = 1,
+    ChaynsWeb = 2,
+    ChaynsRuntime = 3,
+    IntercomPlugin = 4,
+    PagemakerPlugin = 5
+}
+export declare enum DeviceOs {
+    Unknown = "unknown",
+    Android = "android",
+    IOS = "ios",
+    Windows = "windows",
+    MacOs = "macos",
+    Linux = "linux"
+}
+export declare enum AppName {
+    Unknown = 0,
+    David = 1,
+    Chayns = 2,
+    Location = 3,
+    Intercom = 4,
+    ChaynsLauncher = 5
+}
+export declare enum BrowserName {
+    Unknown = "unknown",
+    Chrome = "chrome",
+    Safari = "safari",
+    Firefox = "firefox",
+    Edge = "edge"
+}
+export declare enum Environment {
+    Development = 0,
+    Qa = 1,
+    Staging = 2,
+    Production = 3
+}
+export declare enum Font {
+    Unknown = 0,
+    Roboto = 1,
+    OpenSans = 2,
+    Lato = 3,
+    SourceSansPro = 4,
+    Ubuntu = 5,
+    Cabin = 6,
+    Merriweather = 7,
+    NotoSerif = 8,
+    PTSerif = 9,
+    DroidSerif = 10,
+    Muli = 11,
+    Poppins = 12,
+    RobotoCondensed = 13,
+    Anton = 14,
+    ArchitectsDaughter = 15,
+    DMSerifDisplay = 16,
+    Pacifico = 17,
+    PermanentMarker = 18,
+    Questrial = 19,
+    RobotoSlab = 20,
+    ShadowsIntoLightTwo = 21,
+    WaitingForTheSunrise = 22,
+    RobotoMedium = 23,
+    TobitHeadline = 24,
+    RobotoBold = 25,
+    RobotoRegular = 26,
+    Inter = 27
+}
+export interface SelectInput {
+    title?: string;
+    message?: string;
+    list: Array<SelectDialogItem>;
+    multiselect?: boolean;
+    quickfind?: boolean;
+    type?: selectType;
+    preventCloseOnClick?: boolean;
+    buttons?: DialogButton[];
+    links?: DialogButton[];
+    selectAllButton?: string;
+}
+declare enum selectType {
+    DEFAULT = 0,
+    ICON = 1
+}
+export {};

package/dist/types/types/dialog.d.ts

@@ -0,0 +1,41 @@
+export interface DialogTextBlock {
+    headline: string;
+    text: string;
+    position: number;
+}
+export interface WeekDayIntervalObject {
+    start: number;
+    end: number;
+}
+export interface IntervalItem {
+    start: Date | number;
+    end: Date | number;
+}
+export interface SelectDialogItem {
+    name: string;
+    value: string | number | Record<string, any> | boolean;
+    backgroundColor?: string;
+    className?: string;
+    url?: string;
+    isSelected?: boolean;
+    icon?: string;
+}
+export interface DialogButton {
+    text: buttonText | string;
+    buttonType: buttonType | number;
+    collapseTime?: number;
+    textColor?: string;
+    backgroundColor?: string;
+}
+declare enum buttonType {
+    CANCEL = -1,
+    NEGATIVE = 0,
+    POSITIVE = 1
+}
+declare enum buttonText {
+    CANCEL = "Abbrechen",
+    NO = "Nein",
+    OK = "OK",
+    YES = "Ja"
+}
+export {};

package/dist/types/util/appCall.d.ts

@@ -0,0 +1,2 @@
+declare const invokeAppCall: (call: any) => void;
+export default invokeAppCall;

package/dist/types/util/deviceHelper.d.ts

@@ -0,0 +1,7 @@
+import { ChaynsApiDevice } from '../types/IChaynsReact';
+declare const getDeviceInfo: (userAgent: string, acceptHeader: string) => ChaynsApiDevice;
+export declare const getClientDeviceInfo: () => {
+    isTouch: false | MediaQueryList;
+};
+export declare const getScreenSize: (width: any) => any;
+export default getDeviceInfo;

package/dist/types/util/heightHelper.d.ts

@@ -0,0 +1 @@
+export declare const setTappHeight: (setHeight: (height: number) => Promise<void>) => void;

package/dist/types/util/postIframeForm.d.ts

@@ -0,0 +1 @@
+export default function postIframeForm(url: string, value: string, fieldName: string, frameId: string): Promise<boolean>;

package/dist/types/wrapper/AppWrapper.d.ts

@@ -0,0 +1,16 @@
+import { ChaynsReactFunctions, ChaynsReactValues, CleanupCallback, DataChangeCallback, IChaynsReact } from '../types/IChaynsReact';
+export declare class AppWrapper implements IChaynsReact {
+    values: ChaynsReactValues;
+    accessToken: string;
+    mapOldApiToNew({ retVal }: {
+        retVal: any;
+    }): ChaynsReactValues;
+    constructor();
+    counter: number;
+    appCall(call: any): void;
+    functions: ChaynsReactFunctions;
+    init(): Promise<undefined>;
+    getSSRData(): null;
+    addDataListener(cb: DataChangeCallback): CleanupCallback;
+    getInitialData(): ChaynsReactValues;
+}

package/dist/types/wrapper/FrameWrapper.d.ts

@@ -0,0 +1,15 @@
+import { ChaynsReactFunctions, ChaynsReactValues, DataChangeCallback, IChaynsReact } from '../types/IChaynsReact';
+export declare class FrameWrapper implements IChaynsReact {
+    private resolve;
+    private exposedFunctions;
+    private resizeListener;
+    ready: Promise<unknown>;
+    values: ChaynsReactValues;
+    functions: ChaynsReactFunctions;
+    initialized: boolean;
+    constructor();
+    init(): Promise<void>;
+    addDataListener(cb: DataChangeCallback): () => void;
+    getSSRData(): null;
+    getInitialData(): ChaynsReactValues;
+}

package/dist/types/wrapper/ModuleFederationWrapper.d.ts

@@ -0,0 +1,10 @@
+import { ChaynsReactFunctions, ChaynsReactValues, DataChangeCallback, IChaynsReact } from '../types/IChaynsReact';
+export declare class ModuleFederationWrapper implements IChaynsReact {
+    values: ChaynsReactValues;
+    functions: ChaynsReactFunctions;
+    constructor(values: ChaynsReactValues, functions: ChaynsReactFunctions);
+    init(): Promise<undefined>;
+    addDataListener(cb: DataChangeCallback): () => void;
+    getSSRData(): null;
+    getInitialData(): ChaynsReactValues;
+}

package/dist/types/wrapper/SsrWrapper.d.ts

@@ -0,0 +1,11 @@
+import { ChaynsReactFunctions, ChaynsReactValues, CleanupCallback, DataChangeCallback, IChaynsReact } from '../types/IChaynsReact';
+export declare class SsrWrapper implements IChaynsReact {
+    private readonly initialData;
+    values: ChaynsReactValues;
+    functions: ChaynsReactFunctions;
+    constructor(values: ChaynsReactValues, functions: ChaynsReactFunctions);
+    init(): Promise<undefined>;
+    addDataListener(cb: DataChangeCallback): CleanupCallback;
+    getSSRData(): ChaynsReactValues;
+    getInitialData(): ChaynsReactValues;
+}