@app-connect/core 1.7.37 → 1.7.38

package/dist/types/contact.d.ts

@@ -0,0 +1,125 @@
+import type { OAuthInfo } from './auth';
+import type { ContactInfo, ReturnMessage } from './common';
+import type { ProxyConfig } from './connector';
+import type { TraceLogger } from './user';
+
+export interface ContactHandlerUser {
+  id: string | number;
+  platform?: string;
+  accessToken?: string | null;
+  refreshToken?: unknown;
+  tokenExpiry?: unknown;
+  hostname?: string;
+  rcAccountId?: string | number;
+  platformAdditionalInfo?: {
+    proxyId?: string;
+    tokenUrl?: string;
+    [key: string]: unknown;
+  } | null;
+  save?(): Promise<unknown>;
+  [key: string]: any;
+}
+
+export interface AccountContactDataRecord {
+  data?: ContactInfo[] | unknown;
+  update(values: { data: unknown }): Promise<unknown>;
+  destroy(): Promise<unknown>;
+  [key: string]: any;
+}
+
+export type ContactAuthType = 'oauth' | 'apiKey' | (string & {});
+
+export interface ContactAuthParams {
+  proxyId?: string;
+  proxyConfig?: ProxyConfig | null;
+}
+
+export interface ContactOAuthInfoParams extends ContactAuthParams {
+  tokenUrl?: unknown;
+  hostname?: unknown;
+}
+
+export interface FindContactParams {
+  platform: string;
+  userId: string | number;
+  phoneNumber: string;
+  overridingFormat?: unknown;
+  isExtension?: boolean;
+  tracer?: TraceLogger;
+  isForceRefreshAccountData?: boolean;
+}
+
+export interface CreateContactParams {
+  platform: string;
+  userId: string | number;
+  phoneNumber: string;
+  newContactName?: string;
+  newContactType?: string;
+  additionalSubmission?: unknown;
+}
+
+export interface FindContactWithNameParams {
+  platform: string;
+  userId: string | number;
+  name: string;
+}
+
+export interface ContactHandlerResult {
+  successful: boolean;
+  returnMessage?: ReturnMessage | null;
+  message?: string;
+  contact?: ContactInfo[] | ContactInfo | null | unknown;
+  extraDataTracking?: unknown;
+  isRevokeUserSession?: boolean;
+  [key: string]: unknown;
+}
+
+export interface FindContactConnectorParams {
+  user: ContactHandlerUser;
+  authHeader: string;
+  phoneNumber: string;
+  overridingFormat?: unknown;
+  isExtension?: boolean;
+  proxyConfig?: ProxyConfig | null;
+  tracer?: TraceLogger;
+  isForceRefreshAccountData?: boolean;
+}
+
+export interface FindContactConnectorResult {
+  successful: boolean;
+  matchedContactInfo?: ContactInfo[] | null;
+  returnMessage?: ReturnMessage | null;
+  extraDataTracking?: unknown;
+}
+
+export interface CreateContactConnectorParams {
+  user: ContactHandlerUser;
+  authHeader: string;
+  phoneNumber: string;
+  newContactName?: string;
+  newContactType?: string;
+  additionalSubmission?: unknown;
+  proxyConfig?: ProxyConfig | null;
+}
+
+export interface CreateContactConnectorResult {
+  contactInfo?: ContactInfo | ContactInfo[] | null;
+  returnMessage?: ReturnMessage | null;
+  extraDataTracking?: unknown;
+}
+
+export interface FindContactWithNameConnectorParams {
+  user: ContactHandlerUser;
+  authHeader: string;
+  name: string;
+  proxyConfig?: ProxyConfig | null;
+}
+
+export interface ContactConnectorImplementation {
+  getAuthType(params: ContactAuthParams): ContactAuthType | Promise<ContactAuthType>;
+  getBasicAuth(params: { apiKey?: unknown }): string;
+  getOauthInfo(params: ContactOAuthInfoParams): OAuthInfo | Promise<OAuthInfo>;
+  findContact(params: FindContactConnectorParams): FindContactConnectorResult | Promise<FindContactConnectorResult>;
+  createContact(params: CreateContactConnectorParams): CreateContactConnectorResult | Promise<CreateContactConnectorResult>;
+  findContactWithName(params: FindContactWithNameConnectorParams): FindContactConnectorResult | Promise<FindContactConnectorResult>;
+}

package/dist/types/errorHandler.d.ts

@@ -0,0 +1,60 @@
+import type { ReturnMessage } from './common';
+
+export type ErrorStatusCode = number | 'unknown';
+
+export interface ProviderError extends Error {
+  response?: {
+    status?: number;
+    data?: unknown;
+    [key: string]: unknown;
+  };
+  statusCode?: number;
+  [key: string]: unknown;
+}
+
+export interface OperationFailureResult {
+  successful: false;
+  returnMessage: ReturnMessage;
+  extraDataTracking?: {
+    statusCode: ErrorStatusCode;
+    [key: string]: unknown;
+  };
+  [key: string]: unknown;
+}
+
+export interface OperationErrorMessageConfig {
+  message: string;
+  details: string[];
+}
+
+export type OperationMessageMap = Record<string, OperationErrorMessageConfig>;
+
+export interface ExpressLikeRequest {
+  platform?: string;
+  query?: {
+    platform?: string;
+    [key: string]: unknown;
+  };
+  route?: {
+    path?: string;
+    [key: string]: unknown;
+  };
+  method?: string;
+  path?: string;
+  correlationId?: string;
+  [key: string]: unknown;
+}
+
+export interface ExpressLikeResponse {
+  status(code: number): ExpressLikeResponse;
+  json(body: unknown): unknown;
+  [key: string]: unknown;
+}
+
+export type ExpressLikeNext = (error?: unknown) => void;
+
+export type AsyncRouteHandler = (
+  req: ExpressLikeRequest,
+  res: ExpressLikeResponse,
+  next: ExpressLikeNext,
+) => unknown | Promise<unknown>;

package/dist/types/index.d.ts

@@ -0,0 +1,76 @@
+import type { Application, RequestHandler, Router } from 'express';
+import type {
+  ConnectorCapabilities,
+  ConnectorImplementation,
+  ConnectorInterfaceFunction,
+  ConnectorManifest,
+} from './connector';
+
+export interface CoreInitializationOptions {
+  skipDatabaseInit?: boolean;
+  skipAnalyticsInit?: boolean;
+}
+
+export interface ConnectorRegistry {
+  readonly connectors: Map<string, ConnectorImplementation>;
+  readonly manifests: Map<string, ConnectorManifest>;
+  readonly releaseNotes: unknown;
+  readonly platformInterfaces: Map<string, Map<string, ConnectorInterfaceFunction>>;
+  setDefaultManifest(manifest: ConnectorManifest): void;
+  registerConnectorInterface(
+    platformName: string,
+    interfaceName: string,
+    interfaceFunction: ConnectorInterfaceFunction,
+  ): void;
+  getPlatformInterfaces(platformName: string): Map<string, ConnectorInterfaceFunction>;
+  hasPlatformInterface(platformName: string, interfaceName: string): boolean;
+  unregisterConnectorInterface(platformName: string, interfaceName: string): void;
+  registerConnector(
+    platform: string,
+    connector: ConnectorImplementation,
+    manifest?: ConnectorManifest | null,
+  ): void;
+  getConnector(platform: string): ConnectorImplementation;
+  getOriginalConnector(platform: string): ConnectorImplementation;
+  getManifest(platform: string, fallbackToDefault?: boolean): ConnectorManifest;
+  getRegisteredPlatforms(): string[];
+  isRegistered(platform: string): boolean;
+  validateConnectorInterface(platform: string, connector: ConnectorImplementation): void;
+  unregisterConnector(platform: string): void;
+  setReleaseNotes(releaseNotes: unknown): void;
+  getReleaseNotes(): unknown;
+  getConnectorCapabilities(platform: string): Promise<ConnectorCapabilities>;
+}
+
+export function createCoreRouter(): Router;
+export function createCoreMiddleware(): RequestHandler[];
+export function initializeCore(options?: CoreInitializationOptions): Promise<void>;
+export function createCoreApp(options?: CoreInitializationOptions): Application;
+export const connectorRegistry: ConnectorRegistry;
+export const proxyConnector: ConnectorImplementation;
+export { DebugTracer } from '../lib/debugTracer';
+
+export * from './analytics';
+export * from './admin';
+export * from './appointment';
+export * from './auth';
+export * from './authSession';
+export * from './calldown';
+export * from './cacheCleanup';
+export * from './common';
+export * from './connector';
+export * from './contact';
+export * from './errorHandler';
+export * from './json';
+export * from './jwt';
+export * from './logging';
+export * from './managedAuth';
+export * from './managedOAuth';
+export * from './manifest';
+export * from './migration';
+export * from './plugin';
+export * from './ringcentral';
+export * from './s3ErrorLogReport';
+export * from './sharedSMSComposer';
+export * from './user';
+export * from './util';

package/dist/types/json.d.ts

@@ -0,0 +1,9 @@
+export type JsonPrimitive = string | number | boolean | null;
+
+export type JsonValue = JsonPrimitive | JsonObject | JsonArray;
+
+export interface JsonObject {
+  [key: string]: JsonValue | undefined;
+}
+
+export interface JsonArray extends Array<JsonValue> {}

package/dist/types/jwt.d.ts

@@ -0,0 +1,8 @@
+export interface JwtPayloadData {
+  [key: string]: unknown;
+}
+
+export interface DecodedJwtPayload extends JwtPayloadData {
+  exp?: number;
+  iat?: number;
+}

package/dist/types/logging.d.ts

@@ -0,0 +1,224 @@
+import type { AppConnectUser, ContactInfo, ReturnMessage } from './common';
+import type { JsonObject, JsonValue } from './json';
+
+export type LoggerLevelName = 'ERROR' | 'WARN' | 'INFO' | 'DEBUG';
+
+export type LoggerContext = Record<string, any>;
+
+export interface LoggerOptions {
+  level?: string;
+}
+
+export interface ChildLogger {
+  error(message: string, context?: LoggerContext): void;
+  warn(message: string, context?: LoggerContext): void;
+  info(message: string, context?: LoggerContext): void;
+  debug(message: string, context?: LoggerContext): void;
+  child(additionalContext?: LoggerContext): ChildLogger;
+}
+
+export interface ApiRequestLogOptions {
+  method?: string;
+  url?: string;
+  status?: number;
+  duration?: number;
+  platform?: string;
+  error?: unknown;
+}
+
+export interface DatabaseQueryLogOptions {
+  operation?: string;
+  table?: string;
+  duration?: number;
+  error?: unknown;
+}
+
+export type TraceLevel = 'info' | 'warn' | 'error' | (string & {});
+
+export interface TraceOptions {
+  includeStack?: boolean;
+  level?: TraceLevel;
+}
+
+export interface TraceEntry {
+  timestamp: string;
+  elapsed: number;
+  methodName: string;
+  level: TraceLevel;
+  data: unknown;
+  stackTrace?: string[];
+}
+
+export interface TraceActionSummary {
+  index: number;
+  timestamp: string;
+  level: string;
+  method: string;
+  elapsedMs: number;
+}
+
+export interface DebugTraceData {
+  sum: TraceActionSummary[];
+  requestId: string;
+  totalDuration: string;
+  traceCount: number;
+  traces: TraceEntry[];
+}
+
+export interface RequestWithHeaders {
+  headers?: Record<string, unknown>;
+  [key: string]: unknown;
+}
+
+export type LogDetailsFormatType = 'text/plain' | 'text/html' | 'text/markdown';
+
+export type CallDirection = 'Inbound' | 'Outbound' | (string & {});
+
+export interface PhoneParty {
+  phoneNumber?: string;
+  extensionNumber?: string;
+  name?: string;
+  [key: string]: unknown;
+}
+
+export interface RingCentralCallLog {
+  id?: string;
+  telephonySessionId?: string;
+  sessionId?: string;
+  direction?: CallDirection;
+  from?: PhoneParty;
+  to?: PhoneParty;
+  startTime?: string | Date;
+  duration?: number;
+  result?: string;
+  legs?: JsonObject[];
+  [key: string]: unknown;
+}
+
+export interface CallLogLookupInput {
+  extensionNumber?: string | number | null;
+  hashedExtensionId?: string | number | null;
+  rcExtensionId?: string | number | null;
+  logInfo?: {
+    extensionNumber?: string | number | null;
+    hashedExtensionId?: string | number | null;
+    rcExtensionId?: string | number | null;
+    [key: string]: unknown;
+  } | null;
+  [key: string]: unknown;
+}
+
+export interface PersistedCallLogIdentity {
+  sessionId?: string;
+  extensionNumber?: string | number | null;
+  hashedExtensionId?: string | number | null;
+  [key: string]: unknown;
+}
+
+export interface BuildCallLogSessionWhereParams {
+  sessionId?: string;
+  sessionIds?: string[];
+  extensionNumber?: string | number | null;
+  hashedExtensionId?: string | number | null;
+}
+
+export interface CallLogSubmission {
+  logInfo?: JsonObject;
+  callLog?: RingCentralCallLog;
+  contactInfo?: ContactInfo;
+  contactId?: string | number;
+  note?: string;
+  aiNote?: string;
+  transcript?: string;
+  recordingLink?: string;
+  subject?: string;
+  startTime?: string | Date;
+  duration?: number;
+  result?: string;
+  [key: string]: unknown;
+}
+
+export interface ComposeCallLogParams {
+  logFormat?: LogDetailsFormatType;
+  existingBody?: string;
+  callLog?: RingCentralCallLog;
+  contactInfo?: ContactInfo;
+  user: AppConnectUser;
+  note?: string;
+  aiNote?: string;
+  transcript?: string;
+  recordingLink?: string;
+  subject?: string;
+  startTime?: string | Date;
+  duration?: number;
+  result?: string;
+  ringSenseTranscript?: string;
+  ringSenseSummary?: string;
+  ringSenseAIScore?: string | number;
+  ringSenseBulletedSummary?: string;
+  ringSenseLink?: string;
+  [key: string]: unknown;
+}
+
+export interface MessageLogSubmission {
+  messageId?: string;
+  conversationId?: string;
+  direction?: CallDirection;
+  from?: PhoneParty;
+  to?: PhoneParty[];
+  text?: string;
+  attachments?: JsonValue[];
+  [key: string]: unknown;
+}
+
+export interface AppointmentSubmission {
+  id?: string;
+  subject?: string;
+  startTime?: string | Date;
+  endTime?: string | Date;
+  contactId?: string | number;
+  thirdPartyAppointmentId?: string | number;
+  [key: string]: unknown;
+}
+
+export interface CallDispositionItem {
+  id?: string | number;
+  value?: unknown;
+  [key: string]: unknown;
+}
+
+export interface UpsertCallDispositionParams {
+  platform: string;
+  userId: string | number;
+  sessionId: string;
+  extensionNumber?: string | number | null;
+  hashedExtensionId?: string | number | null;
+  dispositions?: CallDispositionItem[];
+}
+
+export interface UpsertCallDispositionResult {
+  successful: boolean;
+  logId?: string | number;
+  returnMessage?: ReturnMessage;
+  extraDataTracking?: unknown;
+  isRevokeUserSession?: boolean;
+  [key: string]: unknown;
+}
+
+export interface MockGetCallLogParams {
+  sessionIds: string;
+  extensionNumber?: string | number | null;
+  hashedExtensionId?: string | number | null;
+}
+
+export interface MockCreateCallLogParams {
+  sessionId: string;
+  extensionNumber?: string | number | null;
+  hashedExtensionId?: string | number | null;
+}
+
+export interface MockCallLogMatchResult {
+  sessionId: string;
+  matched: boolean;
+  logId?: string;
+}

package/dist/types/managedAuth.d.ts

@@ -0,0 +1,114 @@
+import type { AppConnectManifest } from './manifest';
+
+export type ManagedAuthValue = unknown;
+
+export type ManagedAuthValues = Record<string, ManagedAuthValue>;
+
+export interface ManagedAuthStoredValue {
+  version?: number;
+  encrypted?: boolean;
+  value?: string;
+  [key: string]: unknown;
+}
+
+export interface ManagedAuthStoredData {
+  rcExtensionId?: string | number;
+  rcUserName?: string;
+  fields?: Record<string, ManagedAuthStoredValue | unknown>;
+  failedAt?: string;
+  [key: string]: unknown;
+}
+
+export interface ManagedAuthRecord {
+  id?: string;
+  dataKey?: string;
+  data?: ManagedAuthStoredData;
+  update(values: Record<string, unknown>): Promise<unknown>;
+  destroy?(): Promise<unknown>;
+  [key: string]: any;
+}
+
+export interface ManagedAuthFieldDefinition {
+  const: string;
+  required?: boolean;
+  managed?: boolean;
+  managedScope?: 'account' | 'user' | (string & {});
+  [key: string]: unknown;
+}
+
+export interface ManagedAuthAccountParams {
+  rcAccountId?: string | number;
+  platform?: string;
+}
+
+export interface ManagedAuthFieldDefinitionParams extends ManagedAuthAccountParams {
+  connectorId?: string;
+  isPrivate?: boolean;
+}
+
+export interface ManagedAuthUserParams extends ManagedAuthAccountParams {
+  rcExtensionId?: string | number;
+}
+
+export interface ManagedAuthLoginFailureParams extends ManagedAuthUserParams {}
+
+export interface UpsertOrgManagedAuthValuesParams extends ManagedAuthAccountParams {
+  values?: ManagedAuthValues;
+  fieldsToRemove?: string[];
+}
+
+export interface UpsertUserManagedAuthValuesParams extends ManagedAuthUserParams {
+  rcUserName?: string;
+  values?: ManagedAuthValues;
+  fieldsToRemove?: string[];
+}
+
+export interface ManagedAuthAdminSettingsParams extends ManagedAuthFieldDefinitionParams {}
+
+export interface ManagedAuthStateParams extends ManagedAuthFieldDefinitionParams {
+  rcExtensionId?: string | number;
+}
+
+export interface ResolveApiKeyLoginFieldsParams extends ManagedAuthStateParams {
+  apiKey?: unknown;
+  additionalInfo?: ManagedAuthValues;
+  preferSubmittedValuesForManagedFields?: boolean;
+}
+
+export interface PersistSubmittedManagedValuesParams extends ManagedAuthUserParams {
+  rcUserName?: string;
+  submittedManagedValues?: {
+    org?: ManagedAuthValues;
+    user?: ManagedAuthValues;
+    [key: string]: unknown;
+  };
+}
+
+export interface StoredFieldValue {
+  hasValue: boolean;
+  value: unknown;
+}
+
+export interface ManagedAuthAdminUserEntry {
+  rcExtensionId: string | number;
+  rcUserName: string;
+  fields: Record<string, ManagedAuthStoredValue | unknown>;
+}
+
+export interface ManagedAuthState {
+  hasManagedAuth: boolean;
+  allRequiredFieldsSatisfied: boolean;
+  visibleFieldConsts: string[] | null;
+  missingRequiredFieldConsts: string[];
+  fallbackToManualAuth: boolean;
+}
+
+export interface ResolveApiKeyLoginFieldsResult {
+  resolvedAdditionalInfo: ManagedAuthValues;
+  resolvedApiKey?: unknown;
+  missingRequiredFieldConsts: string[];
+}
+
+export interface DeveloperPortalManifestProvider {
+  getConnectorManifest(params: ManagedAuthFieldDefinitionParams): Promise<AppConnectManifest | null | undefined>;
+}

package/dist/types/managedOAuth.d.ts

@@ -0,0 +1,59 @@
+export type ManagedOAuthValue = unknown;
+
+export type ManagedOAuthValues = Record<string, ManagedOAuthValue>;
+
+export interface ManagedOAuthStoredValue {
+  version?: number;
+  encrypted?: boolean;
+  value?: string;
+  [key: string]: unknown;
+}
+
+export interface ManagedOAuthStoredData {
+  fields?: Record<string, ManagedOAuthStoredValue | unknown>;
+  [key: string]: unknown;
+}
+
+export interface ManagedOAuthRecord {
+  id?: string;
+  data?: ManagedOAuthStoredData;
+  expiry?: Date | string | number;
+  update(values: Record<string, unknown>): Promise<unknown>;
+  destroy(): Promise<unknown>;
+  [key: string]: unknown;
+}
+
+export interface ManagedOAuthAccountParams {
+  rcAccountId?: string | number;
+  platform?: string;
+}
+
+export interface ManagedOAuthPendingParams {
+  rcAccountId?: string | number;
+}
+
+export interface ManagedOAuthStateParams extends ManagedOAuthAccountParams {
+  isAdmin?: boolean;
+}
+
+export interface UpsertPendingManagedOAuthParams extends ManagedOAuthPendingParams {
+  values?: ManagedOAuthValues;
+}
+
+export interface ManagedOAuthState {
+  isAdmin: boolean;
+  hasAccountOAuth: boolean;
+  hasPendingOAuth: boolean;
+  oauthValues?: ManagedOAuthValues;
+  pendingValues?: ManagedOAuthValues;
+}
+
+export interface ManagedOAuthResolution {
+  source: 'account' | 'pending' | null;
+  oauthInfo: ManagedOAuthValues | null;
+}
+
+export interface ResetManagedOAuthResult {
+  deletedAccountCount: number;
+  deletedPendingCount: number;
+}