@livechat/platform-workflows 0.0.2 → 0.0.4

package/dist/index.d.cts

@@ -0,0 +1,206 @@
+import React, { ReactNode } from 'react';
+import { IntegrationNames, GithubClientAuthorization, NetlifyClientAuthorization, VercelClientAuthorization, NeonClientAuthorization, MailchimpClientAuthorization, ShopifyClientAuthorization, HubspotClientAuthorization, BigCommerceClientAuthorization, TextClientAuthorization, initApi as initApi$1, UserSurveyDto, UserDto, ClientInfoDto, AccountDto, AgentDto } from '@livechat/developer-studio-api';
+import AccountsSDK from '@livechat/accounts-sdk';
+
+interface WorkflowsConfigBase {
+    env: string;
+    publicUrl: string;
+}
+interface WorkflowsConfig extends WorkflowsConfigBase {
+    accountsUrl: string;
+    platformUrl: string;
+    adapterUrl: string;
+    workflowsApiUr: string;
+    dpsApiUrl: string;
+    billingApiUrl: string;
+    adapterApiUrl: string;
+    livechatApiUrl: string;
+    textApiUrl: string;
+    accountsClientId: string;
+    bigcommerceClientId: string;
+    githubAppClientId: string;
+    githubOauthClientId: string;
+    hubpotClientId: string;
+    mailchimpClientId: string;
+    neonClientId: string;
+    netlifyClientId: string;
+    shopifyClientId: string;
+    vercelClientId: string;
+    textClientId: string;
+    workflowsAppId: string;
+    workflowsWebhooksAppId: string;
+    aiAgentId: string;
+    pusherKey: string;
+    amplitudeKey: string;
+}
+declare function setWorkflowsConfig(newConfig: Partial<WorkflowsConfigBase>): void;
+declare function getWorkflowsConfig(): WorkflowsConfig;
+declare const getWorkflowEnv: (key: keyof WorkflowsConfig) => string;
+
+type AuthSource = IntegrationNames.Accounts | IntegrationNames.GitHub | IntegrationNames.Vercel | IntegrationNames.Netlify | IntegrationNames.Neon | IntegrationNames.Mailchimp | IntegrationNames.Shopify | IntegrationNames.HubSpot | IntegrationNames.BigCommerce | IntegrationNames.Text;
+interface AuthState {
+    github: {
+        raw: GithubClientAuthorization;
+        data: {
+            isAuthorized?: boolean;
+        };
+    };
+    netlify: {
+        raw: NetlifyClientAuthorization;
+        data: {
+            isAuthorized?: boolean;
+        };
+    };
+    vercel: {
+        raw: VercelClientAuthorization;
+        data: {
+            isAuthorized?: boolean;
+        };
+    };
+    neon: {
+        raw: NeonClientAuthorization;
+        data: {
+            isAuthorized?: boolean;
+        };
+    };
+    mailchimp: {
+        raw: MailchimpClientAuthorization;
+        data: {
+            isAuthorized?: boolean;
+        };
+    };
+    shopify: {
+        raw: ShopifyClientAuthorization;
+        data: {
+            isAuthorized?: boolean;
+        };
+    };
+    hubspot: {
+        raw: HubspotClientAuthorization;
+        data: {
+            isAuthorized?: boolean;
+        };
+    };
+    bigcommerce: {
+        raw: BigCommerceClientAuthorization;
+        data: {
+            isAuthorized?: boolean;
+        };
+    };
+    text: {
+        raw: TextClientAuthorization;
+        data: {
+            isAuthorized?: boolean;
+        };
+    };
+    context: {
+        appId?: string;
+    };
+}
+type AuthStateActionParams = {
+    [K in keyof Omit<AuthState, "context">]: {
+        source: K;
+        data: AuthState[K]["raw"];
+    };
+}[keyof Omit<AuthState, "context">];
+interface IAuthContext {
+    state: AuthState;
+    login: ({ source, data }: AuthStateActionParams) => void;
+    logout: (source: keyof Omit<AuthState, "context">) => void;
+}
+declare const AuthContext: React.Context<IAuthContext>;
+declare function AuthProvider({ children }: {
+    children: React.ReactNode;
+}): JSX.Element;
+
+interface ModeContextProps {
+    mode: Mode;
+    isMarketplaceFullscreenApp: boolean;
+}
+declare const PATHS: {
+    MARKETPLACE_FULLSCREEN_APP: string;
+};
+declare enum Mode {
+    MarketplaceFullscreenApp = "marketplace-fullscreen-app",
+    Regular = "regular"
+}
+declare const ModeContext: React.Context<ModeContextProps>;
+declare function ModeProvider({ children }: {
+    children: ReactNode;
+}): JSX.Element;
+declare const useMode: () => ModeContextProps;
+
+declare const initApi: (tokens: Parameters<typeof initApi$1>[1]) => void;
+
+declare const accountsSDK: AccountsSDK;
+declare const clearRootData: () => void;
+declare const setRootData: ({ access_token, scope, expires_in, }: {
+    access_token: string;
+    scope?: string | undefined;
+    expires_in?: string | undefined;
+}) => void;
+interface RootContextProps {
+    isAuthenticated: boolean;
+    hasLoginFailed: boolean;
+    login: (tokens: Parameters<typeof initApi>[0]) => Promise<void>;
+    logout: () => void;
+    authorize: (manually?: boolean) => void;
+    bootstrap: () => void;
+}
+declare const RootContext: React.Context<RootContextProps>;
+declare function RootProvider({ children }: {
+    children: ReactNode;
+}): JSX.Element;
+declare const useRootContext: () => RootContextProps;
+
+interface UserAggregate {
+    profile: {
+        id: string;
+        surveys: UserSurveyDto[];
+    } & UserDto["profile"];
+    auth: ClientInfoDto | Record<string, unknown>;
+    features: UserDto["features"];
+    meta: {
+        name?: string;
+        email?: string;
+        links: UserDto["links"];
+        organization_id: ClientInfoDto["organization_id"];
+        license: number;
+        roles?: {
+            role: string;
+            product: string;
+        }[];
+        avatar_url?: string;
+        properties?: {
+            avatar_url?: string;
+        };
+    } & Partial<AccountDto> & Partial<AgentDto>;
+}
+
+interface UserContextProps {
+    user: UserAggregate;
+    isUserFetching: boolean;
+    updateUser: unknown;
+    isUserUpdating: boolean;
+    isUserLoaded: boolean;
+    isUserAdmin: boolean;
+    isUserOwnerOrViceOwner: boolean;
+    isUserAgentInLiveChat: boolean;
+    userHasAccessToWorkflows: boolean;
+}
+declare const isUserLiveChatAgent: (userInfo: UserAggregate) => boolean;
+declare const isUserOrgAdmin: (userInfo: UserAggregate) => boolean;
+declare const isUserLivechatAdmin: (userInfo: UserAggregate) => boolean;
+declare const isUserOrgOwnerOrViceOwner: (userInfo: UserAggregate) => boolean;
+declare const UserContext: React.Context<UserContextProps>;
+declare function UserProvider({ children }: {
+    children: ReactNode;
+}): JSX.Element;
+declare const useUserContext: () => UserContextProps;
+
+declare function Flows(): JSX.Element;
+
+declare function SettingsSubNav(): JSX.Element;
+declare function Settings(): JSX.Element;
+
+export { AuthContext, AuthProvider, type AuthSource, type AuthState, Flows, type IAuthContext, Mode, ModeContext, ModeProvider, PATHS, RootContext, RootProvider, Settings, SettingsSubNav, UserContext, UserProvider, type WorkflowsConfig, type WorkflowsConfigBase, accountsSDK, clearRootData, getWorkflowEnv, getWorkflowsConfig, isUserLiveChatAgent, isUserLivechatAdmin, isUserOrgAdmin, isUserOrgOwnerOrViceOwner, setRootData, setWorkflowsConfig, useMode, useRootContext, useUserContext };