@app-connect/core 1.7.36 → 1.7.38

package/dist/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "rootDir": "."
+  },
+  "include": [
+    "**/*.ts"
+  ],
+  "exclude": [
+    "node_modules",
+    "coverage",
+    "mcp/ui"
+  ]
+}

package/dist/types/admin.d.ts

@@ -0,0 +1,141 @@
+import type { OAuthInfo } from './auth';
+import type { ReturnMessage } from './common';
+import type { ProxyConfig } from './connector';
+
+export interface AdminConfigRecord {
+  id?: string;
+  adminAccessToken?: string;
+  adminRefreshToken?: string;
+  adminTokenExpiry?: Date | string | number;
+  userMappings?: AdminUserMapping[];
+  update(values: Record<string, unknown>): Promise<unknown>;
+  [key: string]: any;
+}
+
+export interface AdminUserMapping {
+  crmUserId?: string | number;
+  rcExtensionId?: string | number | Array<string | number>;
+  [key: string]: any;
+}
+
+export interface AdminHandlerUser {
+  id?: string | number;
+  platform: string;
+  hostname?: string;
+  accessToken?: string | null;
+  rcAccountId?: string | number;
+  platformAdditionalInfo?: {
+    proxyId?: string;
+    tokenUrl?: string;
+    [key: string]: unknown;
+  } | null;
+  [key: string]: any;
+}
+
+export interface RcExtensionInfo {
+  id: string | number;
+  name?: string;
+  firstName?: string;
+  lastName?: string;
+  email?: string;
+  extensionNumber?: string | number;
+  [key: string]: any;
+}
+
+export interface CrmUserInfo {
+  id: string | number;
+  name?: string;
+  email?: string;
+  [key: string]: any;
+}
+
+export interface AdminConnectorImplementation {
+  getAuthType(params: { proxyId?: string; proxyConfig?: ProxyConfig | null }): string | Promise<string>;
+  getBasicAuth(params: { apiKey?: unknown }): string;
+  getOauthInfo(params: { tokenUrl?: unknown; hostname?: unknown; proxyId?: string; proxyConfig?: ProxyConfig | null }): OAuthInfo | Promise<OAuthInfo>;
+  getUserList?(params: { user: AdminHandlerUser; authHeader: string; proxyConfig?: ProxyConfig | null }): CrmUserInfo[] | Promise<CrmUserInfo[]>;
+  getServerLoggingSettings?(params: { user: AdminHandlerUser }): unknown | Promise<unknown>;
+  updateServerLoggingSettings?(params: { user: AdminHandlerUser; additionalFieldValues?: unknown; oauthApp?: unknown }): { successful?: boolean; returnMessage?: ReturnMessage } | Promise<{ successful?: boolean; returnMessage?: ReturnMessage }>;
+  [key: string]: unknown;
+}
+
+export interface ValidateRcUserTokenParams {
+  rcAccessToken?: string;
+}
+
+export interface ValidateRcUserTokenResult {
+  rcAccountId: string;
+  rcExtensionId: string;
+}
+
+export interface ValidateAdminRoleParams {
+  rcAccessToken: string;
+}
+
+export interface ValidateAdminRoleResult {
+  isValidated: boolean;
+  rcAccountId: string | number;
+}
+
+export interface UpsertAdminSettingsParams {
+  hashedRcAccountId: string;
+  adminSettings: Record<string, unknown>;
+}
+
+export interface AdminSettingsParams {
+  hashedRcAccountId: string;
+}
+
+export interface UpdateAdminRcTokensParams {
+  hashedRcAccountId: string;
+  adminAccessToken?: string;
+  adminRefreshToken?: string;
+  adminTokenExpiry?: Date | string | number;
+}
+
+export interface ServerLoggingSettingsParams {
+  user: AdminHandlerUser;
+}
+
+export interface UpdateServerLoggingSettingsParams extends ServerLoggingSettingsParams {
+  additionalFieldValues?: unknown;
+}
+
+export interface AdminReportParams {
+  rcAccountId: string | number;
+  timezone?: string;
+  timeFrom?: string;
+  timeTo?: string;
+  groupBy?: string;
+}
+
+export interface UserReportParams extends AdminReportParams {
+  rcExtensionId?: string | number;
+}
+
+export interface UserMappingParams {
+  user: AdminHandlerUser;
+  hashedRcAccountId: string;
+  rcExtensionList: RcExtensionInfo[];
+}
+
+export interface UserMappingResultItem {
+  crmUser: {
+    id: string | number;
+    name: string;
+    email: string;
+  };
+  rcUser: Array<{
+    extensionId: string | number;
+    name: string;
+    extensionNumber: string | number;
+    email: string;
+  }>;
+}
+
+export interface RingCentralSdkLike {
+  refreshToken(params: Record<string, unknown>): Promise<Record<string, any>>;
+  getCallsAggregationData(params: Record<string, unknown>): Promise<Record<string, any>>;
+  getCallLogData(params: Record<string, unknown>): Promise<{ records: any[] }>;
+  getSMSData(params: Record<string, unknown>): Promise<{ records: any[] }>;
+}

package/dist/types/analytics.d.ts

@@ -0,0 +1,14 @@
+export interface AnalyticsTrackParams {
+  eventName: string;
+  interfaceName?: string;
+  connectorName?: string;
+  accountId?: string | number;
+  extensionId?: string | number;
+  success?: boolean;
+  requestDuration?: number;
+  userAgent?: string;
+  ip?: string;
+  author?: string;
+  eventAddedVia?: string;
+  extras?: Record<string, unknown> | null;
+}

package/dist/types/appointment.d.ts

@@ -0,0 +1,50 @@
+import type { AppConnectUser, ReturnMessage } from './common';
+
+export interface AppointmentAuthParams {
+  platform: string;
+  userId: string | number;
+}
+
+export interface AppointmentAuthFailure {
+  successful: false;
+  returnMessage?: ReturnMessage;
+  isRevokeUserSession?: boolean;
+  [key: string]: unknown;
+}
+
+export interface AppointmentResolvedAuth {
+  successful: true;
+  user: AppConnectUser;
+  platformModule: any;
+  authHeader: string;
+  proxyConfig?: unknown | null;
+  [key: string]: unknown;
+}
+
+export type AppointmentAuthResult = AppointmentAuthFailure | AppointmentResolvedAuth;
+
+export interface AppointmentHandlerResult {
+  successful: boolean;
+  returnMessage?: ReturnMessage;
+  isRevokeUserSession?: boolean;
+  [key: string]: unknown;
+}
+
+export interface ListAppointmentsParams extends AppointmentAuthParams {
+  range?: unknown;
+  mineOnly?: boolean;
+  forceSync?: boolean;
+}
+
+export interface AppointmentPayloadParams extends AppointmentAuthParams {
+  payload?: unknown;
+}
+
+export interface AppointmentPatchParams extends AppointmentAuthParams {
+  appointmentId: string | number;
+  patchBody?: unknown;
+}
+
+export interface AppointmentRecordParams extends AppointmentAuthParams {
+  appointmentId: string | number;
+}

package/dist/types/auth.d.ts

@@ -0,0 +1,137 @@
+import type { JsonObject } from './json';
+import type { ReturnMessage } from './common';
+
+export interface OAuthInfo {
+  authUrl?: string;
+  accessTokenUri?: string;
+  authorizationUri?: string;
+  clientId?: string;
+  clientSecret?: string;
+  redirectUri?: string;
+  scope?: string;
+  scopes?: string[] | string;
+  customState?: string;
+  hostname?: string;
+  failMessage?: string;
+  [key: string]: unknown;
+}
+
+export interface OAuthRefreshResult {
+  accessToken?: unknown;
+  refreshToken?: unknown;
+  expires?: unknown;
+  [key: string]: unknown;
+}
+
+export interface OAuthTokenLike {
+  refresh(): Promise<OAuthRefreshResult>;
+  [key: string]: unknown;
+}
+
+export interface OAuthAppLike {
+  createToken(accessToken?: unknown, refreshToken?: unknown): OAuthTokenLike;
+  [key: string]: unknown;
+}
+
+export interface RefreshableOAuthUser {
+  id: string;
+  platform?: string;
+  accessToken?: unknown;
+  refreshToken?: unknown;
+  tokenExpiry?: unknown;
+  save(): Promise<unknown>;
+  [key: string]: unknown;
+}
+
+export interface PlatformUserInfo {
+  id?: string | number;
+  name?: string;
+  email?: string;
+  overridingHostname?: string;
+  additionalInfo?: JsonObject;
+  [key: string]: unknown;
+}
+
+export interface ConnectorAuthResult {
+  successful: boolean;
+  platformUserInfo?: PlatformUserInfo;
+  returnMessage?: ReturnMessage;
+  [key: string]: unknown;
+}
+
+export interface AuthHandlerResult {
+  userInfo?: unknown | null;
+  returnMessage?: ReturnMessage;
+}
+
+export interface OAuthCallbackQuery {
+  callbackUri: string;
+  apiUrl?: string;
+  username?: string;
+  proxyId?: string;
+  userEmail?: string;
+  rcAccountId?: string | number;
+  [key: string]: unknown;
+}
+
+export interface OAuthCallbackParams {
+  platform: string;
+  hostname?: string;
+  tokenUrl?: string;
+  query: OAuthCallbackQuery;
+  hashedRcExtensionId?: string;
+  isFromMCP?: boolean;
+}
+
+export interface ApiKeyLoginParams {
+  platform: string;
+  hostname?: string;
+  apiKey?: string;
+  proxyId?: string;
+  rcAccountId?: string | number;
+  rcExtensionId?: string | number;
+  connectorId?: string;
+  isPrivate?: boolean;
+  hashedRcExtensionId?: string;
+  additionalInfo?: Record<string, unknown>;
+}
+
+export interface SaveUserInfoParams {
+  platformUserInfo: PlatformUserInfo & {
+    id: string | number;
+    name?: string;
+    platformAdditionalInfo?: Record<string, unknown>;
+  };
+  platform: string;
+  hostname?: string;
+  accessToken?: unknown;
+  refreshToken?: unknown;
+  tokenExpiry?: unknown;
+  rcAccountId?: string | number;
+  hashedRcExtensionId?: string;
+  proxyId?: string;
+  [key: string]: unknown;
+}
+
+export interface LicenseStatusParams {
+  userId: string | number;
+  platform: string;
+}
+
+export interface AuthValidationParams {
+  platform: string;
+  userId: string | number;
+}
+
+export interface AuthValidationResult {
+  successful: boolean;
+  returnMessage?: ReturnMessage;
+  status?: number;
+  failReason: string;
+  [key: string]: unknown;
+}
+
+export interface RingcentralOAuthCallbackParams {
+  code: string;
+  rcAccountId?: string | number;
+}

package/dist/types/authSession.d.ts

@@ -0,0 +1,35 @@
+export type AuthSessionStatus =
+  | 'pending'
+  | 'completed'
+  | 'expired'
+  | (string & {});
+
+export interface AuthSessionData {
+  platform?: string;
+  hostname?: string;
+  createdAt?: string;
+  updatedAt?: string;
+  status?: AuthSessionStatus;
+  jwtToken?: string;
+  rcExtensionId?: string;
+  openaiSessionId?: string;
+  [key: string]: unknown;
+}
+
+export type AuthSessionCreateData = Pick<AuthSessionData, 'platform' | 'hostname'> & Record<string, unknown>;
+
+export interface AuthSessionUpdateData extends AuthSessionData {}
+
+export interface AuthSessionRecord {
+  userId?: string;
+  status?: AuthSessionStatus;
+  data?: AuthSessionData | null;
+  expiry?: Date | null;
+  update(values: Record<string, unknown>): Promise<unknown>;
+  [key: string]: unknown;
+}
+
+export interface AuthSessionResult extends AuthSessionData {
+  sessionId?: string;
+  status?: AuthSessionStatus;
+}

package/dist/types/cacheCleanup.d.ts

@@ -0,0 +1,12 @@
+export interface CacheCleanupOptions {
+  now?: Date;
+}
+
+export interface AccountContactCleanupOptions extends CacheCleanupOptions {
+  retentionMonths?: number;
+}
+
+export interface AccountContactCutoffOptions {
+  now: Date;
+  retentionMonths: number;
+}

package/dist/types/calldown.d.ts

@@ -0,0 +1,54 @@
+import type { ReturnMessage } from './common';
+
+export interface CallDownJwtData {
+  id?: string | number;
+  [key: string]: unknown;
+}
+
+export interface CallDownScheduleBody {
+  contactId?: string | number | null;
+  contactType?: string | null;
+  contactName?: string | null;
+  phoneNumber?: string | null;
+  scheduledAt?: string | number | Date | null;
+  [key: string]: unknown;
+}
+
+export interface CallDownScheduleParams {
+  jwtToken: string;
+  body: CallDownScheduleBody;
+  rcAccessToken?: string;
+}
+
+export interface CallDownScheduleResult {
+  id: string;
+}
+
+export interface CallDownListParams {
+  jwtToken: string;
+  status?: string | number | null;
+}
+
+export interface CallDownListResult {
+  items: unknown[];
+}
+
+export interface CallDownRecordParams {
+  jwtToken: string;
+  id: string;
+}
+
+export interface CallDownMarkCalledParams extends CallDownRecordParams {
+  lastCallAt?: string | number | Date | null;
+}
+
+export type CallDownUpdateData = Record<string, unknown>;
+
+export interface CallDownUpdateParams extends CallDownRecordParams {
+  updateData: CallDownUpdateData;
+}
+
+export interface CallDownOperationResult {
+  successful: boolean;
+  returnMessage?: ReturnMessage;
+}

package/dist/types/common.d.ts

@@ -0,0 +1,46 @@
+import type { JsonObject, JsonValue } from './json';
+
+export type MessageType =
+  | 'success'
+  | 'info'
+  | 'warning'
+  | 'danger'
+  | 'error'
+  | (string & {});
+
+export interface ReturnMessage {
+  message?: string;
+  messageType?: MessageType;
+  ttl?: number;
+  [key: string]: JsonValue | undefined;
+}
+
+export interface UserSetting<TValue = unknown> {
+  value?: TValue;
+  isCustomizable?: boolean;
+  [key: string]: unknown;
+}
+
+export type UserSettings = Record<string, UserSetting>;
+
+export interface AppConnectUser {
+  id: string;
+  rcAccountId?: string | number;
+  accountId?: string | number;
+  hashedRcExtensionId?: string;
+  crmPlatform?: string;
+  hostname?: string;
+  token?: string;
+  timezoneOffset?: string | number;
+  userSettings?: UserSettings;
+  platformAdditionalInfo?: JsonObject;
+  [key: string]: unknown;
+}
+
+export interface ContactInfo {
+  id?: string | number;
+  name?: string;
+  type?: string;
+  phoneNumber?: string;
+  [key: string]: unknown;
+}

package/dist/types/connector.d.ts

@@ -0,0 +1,165 @@
+import type { JsonObject } from './json';
+
+export type ConnectorInterfaceFunction = (...args: any[]) => unknown;
+
+export interface ConnectorImplementation {
+  createCallLog?: ConnectorInterfaceFunction;
+  updateCallLog?: ConnectorInterfaceFunction;
+  getAuthType?: ConnectorInterfaceFunction;
+  [key: string]: unknown;
+}
+
+export type ConnectorManifest = JsonObject;
+
+export interface ConnectorCapabilities {
+  platform: string;
+  originalMethods: string[];
+  composedMethods: string[];
+  registeredInterfaces: string[];
+  authType: string | null;
+}
+
+export interface DeveloperPortalConnectorSummary {
+  id?: string;
+  accountId?: string | number;
+  [key: string]: unknown;
+}
+
+export interface DeveloperPortalConnectorList {
+  connectors?: DeveloperPortalConnectorSummary[];
+  [key: string]: unknown;
+}
+
+export interface DeveloperPortalPrivateConnectorList {
+  privateConnectors: DeveloperPortalConnectorSummary[];
+  sharedConnectors: DeveloperPortalConnectorSummary[];
+  [key: string]: unknown;
+}
+
+export interface GetPrivateConnectorListParams {
+  rcAccountId?: string | number;
+}
+
+export interface GetConnectorManifestParams extends GetPrivateConnectorListParams {
+  connectorId: string;
+  isPrivate?: boolean;
+}
+
+export interface ProxyAuthConfig {
+  type?: string;
+  scheme?: string;
+  credentialTemplate?: string;
+  encode?: string;
+  headerName?: string;
+  [key: string]: unknown;
+}
+
+export interface ProxyResponseItemMapping {
+  idPath?: string;
+  namePath?: string;
+  phonePath?: string;
+  typePath?: string;
+  titlePath?: string;
+  companyPath?: string;
+  createdDatePath?: string;
+  mostRecentActivityDatePath?: string;
+  additionalInfoPath?: string;
+  [key: string]: unknown;
+}
+
+export interface ProxyResponseMapping {
+  listPath?: string;
+  item?: ProxyResponseItemMapping;
+  idPath?: string;
+  namePath?: string;
+  emailPath?: string;
+  typePath?: string;
+  subjectPath?: string;
+  notePath?: string;
+  fullBodyPath?: string;
+  timezoneNamePath?: string;
+  overridingApiKeyPath?: string;
+  messagePath?: string;
+  platformAdditionalInfoPaths?: Record<string, string>;
+  isLicenseValidPath?: string;
+  licenseStatusPath?: string;
+  licenseStatusDescriptionPath?: string;
+  [key: string]: unknown;
+}
+
+export interface ProxyOperationConfig {
+  method?: string;
+  url?: string;
+  headers?: Record<string, unknown>;
+  query?: unknown;
+  body?: unknown;
+  auth?: ProxyAuthConfig;
+  responseMapping?: ProxyResponseMapping;
+  [key: string]: unknown;
+}
+
+export interface ProxyRequestDefaults {
+  baseUrl?: string;
+  timeoutSeconds?: number;
+  defaultHeaders?: Record<string, unknown>;
+  [key: string]: unknown;
+}
+
+export interface ProxyConfig {
+  secretKey?: string;
+  auth?: ProxyAuthConfig;
+  meta?: {
+    logFormat?: string;
+    [key: string]: unknown;
+  };
+  requestDefaults?: ProxyRequestDefaults;
+  operations?: Record<string, ProxyOperationConfig>;
+  [key: string]: unknown;
+}
+
+export interface ProxyUserContext {
+  accessToken?: string;
+  id?: string;
+  hostname?: string;
+  timezoneName?: string;
+  timezoneOffset?: string | number;
+  platform?: string;
+  platformAdditionalInfo?: unknown;
+  refreshToken?: unknown;
+  tokenExpiry?: unknown;
+  [key: string]: unknown;
+}
+
+export interface PerformProxyRequestParams {
+  config: ProxyConfig;
+  opName: string;
+  inputs?: Record<string, any>;
+  user?: ProxyUserContext | null;
+  authHeader?: string;
+}
+
+export interface ProxyResponse<TData = unknown> {
+  data: TData;
+  [key: string]: unknown;
+}
+
+export interface ProxyContactInfo {
+  id: unknown;
+  name: unknown;
+  phone?: unknown;
+  type: unknown;
+  title: unknown;
+  company: unknown;
+  createdDate?: unknown;
+  mostRecentActivityDate?: unknown;
+  additionalInfo: unknown;
+}
+
+export interface MapProxyResponseParams {
+  config: ProxyConfig;
+  response: ProxyResponse;
+}
+
+export interface MapFindContactResponseParams extends MapProxyResponseParams {
+  opName?: string;
+}