acs-ui-common.api.md

API Report File for "@internal/acs-ui-common"

Do not edit this file. It is a report generated by API Extractor.

/// <reference types="react" />

import { AzureLogger } from '@azure/logger';
import { AzureLogLevel } from '@azure/logger';
import { CommunicationIdentifier } from '@azure/communication-common';

// @public
export type AreEqual<A extends (props: any) => JSX.Element | undefined, B extends (props: any) => JSX.Element | undefined> = true extends AreTypeEqual<A, B> & AreParamEqual<A, B> ? true : false;

// @public
export type AreParamEqual<A extends (props: any) => JSX.Element | undefined, B extends (props: any) => JSX.Element | undefined> = AreTypeEqual<Required<Parameters<A>[0]>, Required<Parameters<B>[0]>>;

// @public
export type AreTypeEqual<A, B> = A extends B ? (B extends A ? true : false) : false;

// @public
export type CallbackType<KeyT, ArgsT extends unknown[], FnRetT> = (memoizedFn: FunctionWithKey<KeyT, ArgsT, FnRetT>) => FnRetT[];

// @public
export type Common<A, B> = Pick<A, CommonProperties<A, B>>;

// @public
export type CommonProperties<A, B> = {
    [P in keyof A & keyof B]: A[P] extends B[P] ? P : never;
}[keyof A & keyof B];

// @internal
export const _convertRemToPx: (rem: number) => number;

// @internal
export const _formatString: (str: string, vars: _IObjectMap<string>) => string;

// @public
export const fromFlatCommunicationIdentifier: (id: string) => CommunicationIdentifier;

// @public
export type FunctionWithKey<KeyT, ArgsT extends unknown[], RetT> = (key: KeyT, ...args: ArgsT) => RetT;

// @internal
export const _generateUniqueId: () => string;

// @internal
export const _getApplicationId: () => string;

// @internal (undocumented)
export interface _IObjectMap<T> {
    // (undocumented)
    [key: string]: T;
}

// @internal
export const _isValidIdentifier: (identifier: CommunicationIdentifier) => boolean;

// @internal
export const _logEvent: (logger: AzureLogger, event: TelemetryEvent) => void;

// @internal
export const _MAX_EVENT_LISTENERS = 50;

// @public
export const memoizeFnAll: <KeyT, ArgsT extends unknown[], FnRetT, CallBackT extends CallbackType<KeyT, ArgsT, FnRetT>>(fnToMemoize: FunctionWithKey<KeyT, ArgsT, FnRetT>, shouldCacheUpdate?: (args1: unknown, args2: unknown) => boolean) => (callback: CallBackT) => FnRetT[];

// @public
export type MessageStatus = 'delivered' | 'sending' | 'seen' | 'failed';

// @internal
export const _preventDismissOnEvent: (ev: Event | React.FocusEvent | React.KeyboardEvent | React.MouseEvent) => boolean;

// @internal
export const _pxToRem: (px: number) => string;

// @internal
export const _safeJSONStringify: (value: unknown, replacer?: ((this: unknown, key: string, value: unknown) => unknown) | undefined, space?: string | number | undefined) => string | undefined;

// Warning: (ae-internal-missing-underscore) The name "TelemetryEvent" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal (undocumented)
export type TelemetryEvent = {
    name: string;
    message: string;
    level: AzureLogLevel;
    data?: Record<string, unknown>;
};

// @internal
export const _toCommunicationIdentifier: (id: string | CommunicationIdentifier) => CommunicationIdentifier;

// @public
export const toFlatCommunicationIdentifier: (identifier: CommunicationIdentifier) => string;

// (No @packageDocumentation comment for this package)