@callembed/vue 0.0.0-stage → 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,241 @@
+import * as vue from 'vue';
+import { PropType, SlotsType, Plugin } from 'vue';
+import { CallStatus, Locale, StartCallOptions, ActiveCall, InitOptions, CallEmbedError } from '@callembed/sdk';
+export { ActiveCall, CallStatus, InitOptions, Locale, StartCallOptions } from '@callembed/sdk';
+import { PanelCopy } from '@callembed/sdk/ui';
+export { PanelCopy, enCopy, friendlyErrorMessage, resolveCopy, zhTwCopy } from '@callembed/sdk/ui';
+
+/**
+ * Simplified UI lifecycle for `<CallEmbedButton />`.
+ * Maps onto SDK {@link CallStatus}:
+ * - `connecting` | `ringing` → `ringing`
+ * - `answered` → `connected`
+ */
+type CallEmbedUiState = "idle" | "ringing" | "connected" | "ended" | "error";
+declare function toUiState(status: CallStatus | "idle"): CallEmbedUiState;
+interface CallEmbedErrorState {
+    code: string;
+    message: string;
+}
+interface CallEmbedContextValue {
+    /** SDK call status (includes `connecting` / `answered`). */
+    status: CallStatus | "idle";
+    /** Button-oriented status (`answered` → `connected`). */
+    uiState: CallEmbedUiState;
+    callId: string | null;
+    muted: boolean;
+    error: CallEmbedErrorState | null;
+    locale: Locale;
+    /** Start a queue call (customer-service ring → agent answers). */
+    start: (options?: Partial<StartCallOptions> & {
+        queue?: string;
+    }) => Promise<ActiveCall>;
+    /** Hang up the active call (idempotent). */
+    end: () => Promise<void>;
+    setMuted: (muted: boolean) => Promise<void>;
+    /** Default queue from the provider when button/composable omit `queue`. */
+    defaultQueue: string | undefined;
+}
+type CallEmbedProviderProps = InitOptions & {
+    /**
+     * Default queue name for `<CallEmbedButton />` / `useCallEmbed().start()`
+     * when callers omit `queue`.
+     */
+    queue?: string;
+};
+declare const CALL_EMBED_KEY: unique symbol;
+
+/**
+ * Initializes `@callembed/sdk` once for the subtree and exposes call state.
+ * Safe for Nuxt / Vue SSR: no `window` access at module evaluate time;
+ * `CallEmbed.init` runs in a client-only watcher (skipped when `window` is undefined).
+ *
+ * Unmount or `publishableKey` / `apiBaseUrl` change hangs up any active call
+ * so an SPA route change cannot leave a billed call running.
+ */
+declare const CallEmbedProvider: vue.DefineComponent<vue.ExtractPropTypes<{
+    publishableKey: {
+        type: StringConstructor;
+        required: true;
+    };
+    apiBaseUrl: {
+        type: StringConstructor;
+        required: true;
+    };
+    locale: {
+        type: PropType<Locale>;
+        default: undefined;
+    };
+    copy: {
+        type: PropType<Partial<Record<string, string>>>;
+        default: undefined;
+    };
+    branding: {
+        type: BooleanConstructor;
+        default: undefined;
+    };
+    debug: {
+        type: BooleanConstructor;
+        default: undefined;
+    };
+    queue: {
+        type: StringConstructor;
+        default: undefined;
+    };
+}>, () => unknown, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    publishableKey: {
+        type: StringConstructor;
+        required: true;
+    };
+    apiBaseUrl: {
+        type: StringConstructor;
+        required: true;
+    };
+    locale: {
+        type: PropType<Locale>;
+        default: undefined;
+    };
+    copy: {
+        type: PropType<Partial<Record<string, string>>>;
+        default: undefined;
+    };
+    branding: {
+        type: BooleanConstructor;
+        default: undefined;
+    };
+    debug: {
+        type: BooleanConstructor;
+        default: undefined;
+    };
+    queue: {
+        type: StringConstructor;
+        default: undefined;
+    };
+}>> & Readonly<{}>, {
+    locale: Locale;
+    copy: Partial<Record<string, string>>;
+    branding: boolean;
+    debug: boolean;
+    queue: string;
+}, SlotsType<{
+    default: () => unknown;
+}>, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+/**
+ * Access CallEmbed state and controls. Must be used under {@link CallEmbedProvider}.
+ */
+declare function useCallEmbed(): CallEmbedContextValue;
+
+/**
+ * Start / end call button for a customer-service queue.
+ * States: `idle` → `ringing` → `connected` → `ended` | `error`.
+ */
+declare const CallEmbedButton: vue.DefineComponent<vue.ExtractPropTypes<{
+    /** Queue to ring. Falls back to `CallEmbedProvider` `queue`. */
+    queue: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /** Idle-state label; defaults to locale `launchDefault`. */
+    label: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /** Optional metadata forwarded to `startCall`. */
+    metadata: {
+        type: PropType<Record<string, unknown>>;
+        default: undefined;
+    };
+    /** Optional caller display name. */
+    displayName: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /** Show a status line under the button. Default: `true`. */
+    showStatus: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Show mute control while ringing/connected. Default: `true`. */
+    showMute: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
+    error: (_error: CallEmbedError) => true;
+}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    /** Queue to ring. Falls back to `CallEmbedProvider` `queue`. */
+    queue: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /** Idle-state label; defaults to locale `launchDefault`. */
+    label: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /** Optional metadata forwarded to `startCall`. */
+    metadata: {
+        type: PropType<Record<string, unknown>>;
+        default: undefined;
+    };
+    /** Optional caller display name. */
+    displayName: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /** Show a status line under the button. Default: `true`. */
+    showStatus: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Show mute control while ringing/connected. Default: `true`. */
+    showMute: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & Readonly<{
+    onError?: ((_error: CallEmbedError) => any) | undefined;
+}>, {
+    queue: string;
+    metadata: Record<string, unknown>;
+    displayName: string;
+    label: string;
+    showStatus: boolean;
+    showMute: boolean;
+    disabled: boolean;
+}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+type CallEmbedButtonProps = {
+    queue?: string;
+    label?: string;
+    metadata?: Record<string, unknown>;
+    displayName?: string;
+    showStatus?: boolean;
+    showMute?: boolean;
+    disabled?: boolean;
+};
+
+interface CallEmbedPluginOptions {
+    /** Register components under these names (defaults shown). */
+    providerName?: string;
+    buttonName?: string;
+}
+/**
+ * Vue plugin: registers `<CallEmbedProvider>` and `<CallEmbedButton>` globally.
+ * Prefer local imports in tree-shaken apps; use the plugin for Nuxt plugins / quick demos.
+ */
+declare const CallEmbedPlugin: Plugin<CallEmbedPluginOptions>;
+
+/** Status line for the Vue button / composable consumers. */
+declare function statusLabel(copy: PanelCopy, uiState: CallEmbedUiState, sdkStatus: string): string;
+
+export { CALL_EMBED_KEY, CallEmbedButton, type CallEmbedButtonProps, type CallEmbedContextValue, type CallEmbedErrorState, CallEmbedPlugin, type CallEmbedPluginOptions, CallEmbedProvider, type CallEmbedProviderProps, type CallEmbedUiState, statusLabel, toUiState, useCallEmbed };

package/dist/index.d.ts

@@ -0,0 +1,241 @@
+import * as vue from 'vue';
+import { PropType, SlotsType, Plugin } from 'vue';
+import { CallStatus, Locale, StartCallOptions, ActiveCall, InitOptions, CallEmbedError } from '@callembed/sdk';
+export { ActiveCall, CallStatus, InitOptions, Locale, StartCallOptions } from '@callembed/sdk';
+import { PanelCopy } from '@callembed/sdk/ui';
+export { PanelCopy, enCopy, friendlyErrorMessage, resolveCopy, zhTwCopy } from '@callembed/sdk/ui';
+
+/**
+ * Simplified UI lifecycle for `<CallEmbedButton />`.
+ * Maps onto SDK {@link CallStatus}:
+ * - `connecting` | `ringing` → `ringing`
+ * - `answered` → `connected`
+ */
+type CallEmbedUiState = "idle" | "ringing" | "connected" | "ended" | "error";
+declare function toUiState(status: CallStatus | "idle"): CallEmbedUiState;
+interface CallEmbedErrorState {
+    code: string;
+    message: string;
+}
+interface CallEmbedContextValue {
+    /** SDK call status (includes `connecting` / `answered`). */
+    status: CallStatus | "idle";
+    /** Button-oriented status (`answered` → `connected`). */
+    uiState: CallEmbedUiState;
+    callId: string | null;
+    muted: boolean;
+    error: CallEmbedErrorState | null;
+    locale: Locale;
+    /** Start a queue call (customer-service ring → agent answers). */
+    start: (options?: Partial<StartCallOptions> & {
+        queue?: string;
+    }) => Promise<ActiveCall>;
+    /** Hang up the active call (idempotent). */
+    end: () => Promise<void>;
+    setMuted: (muted: boolean) => Promise<void>;
+    /** Default queue from the provider when button/composable omit `queue`. */
+    defaultQueue: string | undefined;
+}
+type CallEmbedProviderProps = InitOptions & {
+    /**
+     * Default queue name for `<CallEmbedButton />` / `useCallEmbed().start()`
+     * when callers omit `queue`.
+     */
+    queue?: string;
+};
+declare const CALL_EMBED_KEY: unique symbol;
+
+/**
+ * Initializes `@callembed/sdk` once for the subtree and exposes call state.
+ * Safe for Nuxt / Vue SSR: no `window` access at module evaluate time;
+ * `CallEmbed.init` runs in a client-only watcher (skipped when `window` is undefined).
+ *
+ * Unmount or `publishableKey` / `apiBaseUrl` change hangs up any active call
+ * so an SPA route change cannot leave a billed call running.
+ */
+declare const CallEmbedProvider: vue.DefineComponent<vue.ExtractPropTypes<{
+    publishableKey: {
+        type: StringConstructor;
+        required: true;
+    };
+    apiBaseUrl: {
+        type: StringConstructor;
+        required: true;
+    };
+    locale: {
+        type: PropType<Locale>;
+        default: undefined;
+    };
+    copy: {
+        type: PropType<Partial<Record<string, string>>>;
+        default: undefined;
+    };
+    branding: {
+        type: BooleanConstructor;
+        default: undefined;
+    };
+    debug: {
+        type: BooleanConstructor;
+        default: undefined;
+    };
+    queue: {
+        type: StringConstructor;
+        default: undefined;
+    };
+}>, () => unknown, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    publishableKey: {
+        type: StringConstructor;
+        required: true;
+    };
+    apiBaseUrl: {
+        type: StringConstructor;
+        required: true;
+    };
+    locale: {
+        type: PropType<Locale>;
+        default: undefined;
+    };
+    copy: {
+        type: PropType<Partial<Record<string, string>>>;
+        default: undefined;
+    };
+    branding: {
+        type: BooleanConstructor;
+        default: undefined;
+    };
+    debug: {
+        type: BooleanConstructor;
+        default: undefined;
+    };
+    queue: {
+        type: StringConstructor;
+        default: undefined;
+    };
+}>> & Readonly<{}>, {
+    locale: Locale;
+    copy: Partial<Record<string, string>>;
+    branding: boolean;
+    debug: boolean;
+    queue: string;
+}, SlotsType<{
+    default: () => unknown;
+}>, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+/**
+ * Access CallEmbed state and controls. Must be used under {@link CallEmbedProvider}.
+ */
+declare function useCallEmbed(): CallEmbedContextValue;
+
+/**
+ * Start / end call button for a customer-service queue.
+ * States: `idle` → `ringing` → `connected` → `ended` | `error`.
+ */
+declare const CallEmbedButton: vue.DefineComponent<vue.ExtractPropTypes<{
+    /** Queue to ring. Falls back to `CallEmbedProvider` `queue`. */
+    queue: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /** Idle-state label; defaults to locale `launchDefault`. */
+    label: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /** Optional metadata forwarded to `startCall`. */
+    metadata: {
+        type: PropType<Record<string, unknown>>;
+        default: undefined;
+    };
+    /** Optional caller display name. */
+    displayName: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /** Show a status line under the button. Default: `true`. */
+    showStatus: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Show mute control while ringing/connected. Default: `true`. */
+    showMute: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {
+    error: (_error: CallEmbedError) => true;
+}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+    /** Queue to ring. Falls back to `CallEmbedProvider` `queue`. */
+    queue: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /** Idle-state label; defaults to locale `launchDefault`. */
+    label: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /** Optional metadata forwarded to `startCall`. */
+    metadata: {
+        type: PropType<Record<string, unknown>>;
+        default: undefined;
+    };
+    /** Optional caller display name. */
+    displayName: {
+        type: StringConstructor;
+        default: undefined;
+    };
+    /** Show a status line under the button. Default: `true`. */
+    showStatus: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    /** Show mute control while ringing/connected. Default: `true`. */
+    showMute: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & Readonly<{
+    onError?: ((_error: CallEmbedError) => any) | undefined;
+}>, {
+    queue: string;
+    metadata: Record<string, unknown>;
+    displayName: string;
+    label: string;
+    showStatus: boolean;
+    showMute: boolean;
+    disabled: boolean;
+}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+type CallEmbedButtonProps = {
+    queue?: string;
+    label?: string;
+    metadata?: Record<string, unknown>;
+    displayName?: string;
+    showStatus?: boolean;
+    showMute?: boolean;
+    disabled?: boolean;
+};
+
+interface CallEmbedPluginOptions {
+    /** Register components under these names (defaults shown). */
+    providerName?: string;
+    buttonName?: string;
+}
+/**
+ * Vue plugin: registers `<CallEmbedProvider>` and `<CallEmbedButton>` globally.
+ * Prefer local imports in tree-shaken apps; use the plugin for Nuxt plugins / quick demos.
+ */
+declare const CallEmbedPlugin: Plugin<CallEmbedPluginOptions>;
+
+/** Status line for the Vue button / composable consumers. */
+declare function statusLabel(copy: PanelCopy, uiState: CallEmbedUiState, sdkStatus: string): string;
+
+export { CALL_EMBED_KEY, CallEmbedButton, type CallEmbedButtonProps, type CallEmbedContextValue, type CallEmbedErrorState, CallEmbedPlugin, type CallEmbedPluginOptions, CallEmbedProvider, type CallEmbedProviderProps, type CallEmbedUiState, statusLabel, toUiState, useCallEmbed };