@app-connect/core 1.7.37 → 1.7.38

package/{handlers → dist/handlers}/admin.js

@@ -1,67 +1,107 @@
-const axios = require('axios');
-const { AdminConfigModel } = require('../models/adminConfigModel');
-const connectorRegistry = require('../connector/registry');
-const oauth = require('../lib/oauth');
-const { RingCentral } = require('../lib/ringcentral');
-const { Connector } = require('../models/dynamo/connectorSchema');
-const logger = require('../lib/logger');
-const { handleDatabaseError } = require('../lib/errorHandler');
-const { getHashValue } = require('../lib/util');
-
-const CALL_AGGREGATION_GROUPS = ["Company", "CompanyNumbers", "Users", "Queues", "IVRs", "IVAs", "SharedLines", "UserGroups", "Sites", "Departments"]
+"use strict";
+// @ts-check
+Object.defineProperty(exports, "__esModule", { value: true });
+/** @typedef {import('../types').AdminConfigRecord} AdminConfigRecord */
+/** @typedef {import('../types').AdminConnectorImplementation} AdminConnectorImplementation */
+/** @typedef {import('../types').AdminHandlerUser} AdminHandlerUser */
+/** @typedef {import('../types').AdminReportParams} AdminReportParams */
+/** @typedef {import('../types').AdminSettingsParams} AdminSettingsParams */
+/** @typedef {import('../types').CrmUserInfo} CrmUserInfo */
+/** @typedef {import('../types').OAuthInfo} OAuthInfo */
+/** @typedef {import('../types').ProxyConfig} ProxyConfig */
+/** @typedef {import('../types').RcExtensionInfo} RcExtensionInfo */
+/** @typedef {import('../types').RingCentralSdkLike} RingCentralSdkLike */
+/** @typedef {import('../types').ServerLoggingSettingsParams} ServerLoggingSettingsParams */
+/** @typedef {import('../types').UpdateAdminRcTokensParams} UpdateAdminRcTokensParams */
+/** @typedef {import('../types').UpdateServerLoggingSettingsParams} UpdateServerLoggingSettingsParams */
+/** @typedef {import('../types').UpsertAdminSettingsParams} UpsertAdminSettingsParams */
+/** @typedef {import('../types').UserMappingParams} UserMappingParams */
+/** @typedef {import('../types').UserMappingResultItem} UserMappingResultItem */
+/** @typedef {import('../types').UserReportParams} UserReportParams */
+/** @typedef {import('../types').ValidateAdminRoleParams} ValidateAdminRoleParams */
+/** @typedef {import('../types').ValidateAdminRoleResult} ValidateAdminRoleResult */
+/** @typedef {import('../types').ValidateRcUserTokenParams} ValidateRcUserTokenParams */
+/** @typedef {import('../types').ValidateRcUserTokenResult} ValidateRcUserTokenResult */
+const axios = /** @type {{ get(url: string, config?: Record<string, unknown>): Promise<{ data?: any }> }} */ ( /** @type {unknown} */(require('axios')));
+const { AdminConfigModel: RawAdminConfigModel } = require('../models/adminConfigModel');
+const AdminConfigModel = /** @type {{ findByPk(id: string): Promise<AdminConfigRecord | null>, create(values: Record<string, unknown>): Promise<AdminConfigRecord>, update(values: Record<string, unknown>, options?: Record<string, unknown>): Promise<any> }} */ (RawAdminConfigModel);
+const connectorRegistry = /** @type {{ getConnector(platform: string): AdminConnectorImplementation }} */ ( /** @type {unknown} */(require('../connector/registry')));
+const oauth = /** @type {{ getOAuthApp(info: OAuthInfo): any, checkAndRefreshAccessToken(oauthApp: any, user: AdminHandlerUser): Promise<AdminHandlerUser | null> }} */ (require('../lib/oauth'));
+const { RingCentral: RawRingCentral } = require('../lib/ringcentral');
+const RingCentral = /** @type {new (options: Record<string, unknown>) => RingCentralSdkLike} */ ( /** @type {unknown} */(RawRingCentral));
+const { Connector: RawConnector } = require('../models/dynamo/connectorSchema');
+const Connector = /** @type {{ getProxyConfig(proxyId: string): Promise<ProxyConfig | null> }} */ ( /** @type {unknown} */(RawConnector));
+const logger = /** @type {{ error(message: string, context?: Record<string, unknown>): void }} */ (require('../lib/logger'));
+const { handleDatabaseError: rawHandleDatabaseError } = require('../lib/errorHandler');
+const handleDatabaseError = /** @type {(error: unknown, message: string) => any} */ (rawHandleDatabaseError);
+const { getHashValue: rawGetHashValue } = require('../lib/util');
+const getHashValue = /** @type {(value: string | number, key?: string) => string} */ (rawGetHashValue);
+const CALL_AGGREGATION_GROUPS = ["Company", "CompanyNumbers", "Users", "Queues", "IVRs", "IVAs", "SharedLines", "UserGroups", "Sites", "Departments"];
 const RC_EXTENSION_ENDPOINT = 'https://platform.ringcentral.com/restapi/v1.0/account/~/extension/~';
-
+/**
+ * @param {ValidateRcUserTokenParams} params
+ * @returns {Promise<ValidateRcUserTokenResult>}
+ */
 async function validateRcUserToken({ rcAccessToken }) {
     if (!rcAccessToken) {
         throw new Error('rcAccessToken is required');
     }
-    const rcExtensionResponse = await axios.get(
-        RC_EXTENSION_ENDPOINT,
-        {
-            headers: {
-                Authorization: `Bearer ${rcAccessToken}`,
-            },
-        });
+    const rcExtensionResponse = await axios.get(RC_EXTENSION_ENDPOINT, {
+        headers: {
+            Authorization: `Bearer ${rcAccessToken}`,
+        },
+    });
     const extensionData = rcExtensionResponse.data ?? {};
     return {
         rcAccountId: extensionData?.account?.id?.toString() ?? '',
         rcExtensionId: extensionData?.id?.toString() ?? ''
     };
 }
-
+/**
+ * @param {ValidateAdminRoleParams} params
+ * @returns {Promise<ValidateAdminRoleResult>}
+ */
 async function validateAdminRole({ rcAccessToken }) {
-    const rcExtensionResponse = await axios.get(
-        RC_EXTENSION_ENDPOINT,
-        {
-            headers: {
-                Authorization: `Bearer ${rcAccessToken}`,
-            },
-        });
+    const rcExtensionResponse = await axios.get(RC_EXTENSION_ENDPOINT, {
+        headers: {
+            Authorization: `Bearer ${rcAccessToken}`,
+        },
+    });
     return {
         isValidated: !!rcExtensionResponse.data?.permissions?.admin?.enabled || (!!process.env.ADMIN_EXTENSION_ID_DEV_PASS_LIST && process.env.ADMIN_EXTENSION_ID_DEV_PASS_LIST.split(',').includes(rcExtensionResponse.data.id.toString())),
         rcAccountId: rcExtensionResponse.data.account.id
     };
 }
-
+/**
+ * @param {UpsertAdminSettingsParams} params
+ * @returns {Promise<void>}
+ */
 async function upsertAdminSettings({ hashedRcAccountId, adminSettings }) {
     let existingAdminConfig = await AdminConfigModel.findByPk(hashedRcAccountId);
     if (existingAdminConfig) {
         await existingAdminConfig.update({
             ...adminSettings
         });
-    } else {
+    }
+    else {
         await AdminConfigModel.create({
             id: hashedRcAccountId,
             ...adminSettings
         });
     }
 }
-
+/**
+ * @param {AdminSettingsParams} params
+ * @returns {Promise<AdminConfigRecord | null>}
+ */
 async function getAdminSettings({ hashedRcAccountId }) {
     const existingAdminConfig = await AdminConfigModel.findByPk(hashedRcAccountId);
     return existingAdminConfig;
 }
-
+/**
+ * @param {UpdateAdminRcTokensParams} params
+ * @returns {Promise<void>}
+ */
 async function updateAdminRcTokens({ hashedRcAccountId, adminAccessToken, adminRefreshToken, adminTokenExpiry }) {
     const existingAdminConfig = await AdminConfigModel.findByPk(hashedRcAccountId);
     if (existingAdminConfig) {
@@ -76,7 +116,10 @@ async function updateAdminRcTokens({ hashedRcAccountId, adminAccessToken, adminR
         });
     }
 }
-
+/**
+ * @param {ServerLoggingSettingsParams} params
+ * @returns {Promise<unknown>}
+ */
 async function getServerLoggingSettings({ user }) {
     const platformModule = connectorRegistry.getConnector(user.platform);
     if (platformModule.getServerLoggingSettings) {
@@ -85,7 +128,10 @@ async function getServerLoggingSettings({ user }) {
     }
     return {};
 }
-
+/**
+ * @param {UpdateServerLoggingSettingsParams} params
+ * @returns {Promise<unknown>}
+ */
 async function updateServerLoggingSettings({ user, additionalFieldValues }) {
     const platformModule = connectorRegistry.getConnector(user.platform);
     const oauthApp = oauth.getOAuthApp((await platformModule.getOauthInfo({ tokenUrl: user?.platformAdditionalInfo?.tokenUrl, hostname: user?.hostname })));
@@ -95,7 +141,10 @@ async function updateServerLoggingSettings({ user, additionalFieldValues }) {
     }
     return {};
 }
-
+/**
+ * @param {AdminReportParams} params
+ * @returns {Promise<Record<string, unknown>>}
+ */
 async function getAdminReport({ rcAccountId, timezone, timeFrom, timeTo, groupBy }) {
     try {
         if (!process.env.RINGCENTRAL_SERVER || !process.env.RINGCENTRAL_CLIENT_ID || !process.env.RINGCENTRAL_CLIENT_SECRET) {
@@ -110,7 +159,7 @@ async function getAdminReport({ rcAccountId, timezone, timeFrom, timeTo, groupBy
             redirectUri: `${process.env.APP_SERVER}/ringcentral/oauth/callback`
         });
         const hashedRcAccountId = getHashValue(rcAccountId, process.env.HASH_KEY);
-        let adminConfig = await AdminConfigModel.findByPk(hashedRcAccountId);
+        let adminConfig = /** @type {any} */ (await AdminConfigModel.findByPk(hashedRcAccountId));
         const isTokenExpired = adminConfig.adminTokenExpiry < new Date();
         if (isTokenExpired) {
             const { access_token, refresh_token, expire_time } = await rcSDK.refreshToken({
@@ -127,7 +176,9 @@ async function getAdminReport({ rcAccountId, timezone, timeFrom, timeTo, groupBy
             timeTo,
             groupBy: groupBy == 'undefined' ? CALL_AGGREGATION_GROUPS[0] : groupBy
         });
+        /** @type {Record<string, unknown>[]} */
         var callLogStats = [];
+        /** @type {string[]} */
         var itemKeys = [];
         for (const record of callsAggregationData.data.records) {
             if (!record?.info?.name) {
@@ -158,14 +209,18 @@ async function getAdminReport({ rcAccountId, timezone, timeFrom, timeTo, groupBy
             groupedBy: callsAggregationData.data.groupedBy,
             groupKeys: CALL_AGGREGATION_GROUPS
         };
-    } catch (error) {
+    }
+    catch (error) {
         logger.error('Error getting admin report', { error });
         return {
             callLogStats: {}
         };
     }
 }
-
+/**
+ * @param {UserReportParams} params
+ * @returns {Promise<Record<string, unknown> | null>}
+ */
 async function getUserReport({ rcAccountId, rcExtensionId, timezone, timeFrom, timeTo }) {
     try {
         if (!process.env.RINGCENTRAL_SERVER || !process.env.RINGCENTRAL_CLIENT_ID || !process.env.RINGCENTRAL_CLIENT_SECRET) {
@@ -180,7 +235,7 @@ async function getUserReport({ rcAccountId, rcExtensionId, timezone, timeFrom, t
             redirectUri: `${process.env.APP_SERVER}/ringcentral/oauth/callback`
         });
         const hashedRcAccountId = getHashValue(rcAccountId, process.env.HASH_KEY);
-        let adminConfig = await AdminConfigModel.findByPk(hashedRcAccountId);
+        let adminConfig = /** @type {any} */ (await AdminConfigModel.findByPk(hashedRcAccountId));
         const isTokenExpired = adminConfig.adminTokenExpiry < new Date();
         if (isTokenExpired) {
             const { access_token, refresh_token, expire_time } = await rcSDK.refreshToken({
@@ -229,12 +284,16 @@ async function getUserReport({ rcAccountId, rcExtensionId, timezone, timeFrom, t
             }
         };
         return reportStats;
-    } catch (error) {
+    }
+    catch (error) {
         logger.error('Error getting user report', { error });
         return null;
     }
 }
-
+/**
+ * @param {UserMappingParams} params
+ * @returns {Promise<UserMappingResultItem[] | any>}
+ */
 async function getUserMapping({ user, hashedRcAccountId, rcExtensionList }) {
     let adminConfig = null;
     try {
@@ -259,8 +318,8 @@ async function getUserMapping({ user, hashedRcAccountId, rcExtensionList }) {
             case 'oauth':
                 const oauthApp = oauth.getOAuthApp((await platformModule.getOauthInfo({ tokenUrl: user?.platformAdditionalInfo?.tokenUrl, hostname: user?.hostname, proxyId, proxyConfig })));
                 // eslint-disable-next-line no-param-reassign
-                user = await oauth.checkAndRefreshAccessToken(oauthApp, user);
-                if (!user) {
+                const refreshedUser = await oauth.checkAndRefreshAccessToken(oauthApp, user);
+                if (!refreshedUser) {
                     return {
                         successful: false,
                         returnMessage: {
@@ -269,8 +328,9 @@ async function getUserMapping({ user, hashedRcAccountId, rcExtensionList }) {
                             ttl: 5000
                         },
                         isRevokeUserSession: true
-                    }
+                    };
                 }
+                user = refreshedUser;
                 authHeader = `Bearer ${user.accessToken}`;
                 break;
             case 'apiKey':
@@ -279,10 +339,13 @@ async function getUserMapping({ user, hashedRcAccountId, rcExtensionList }) {
                 break;
         }
         const crmUserList = await platformModule.getUserList({ user, authHeader, proxyConfig });
+        /** @type {UserMappingResultItem[]} */
         const userMappingResult = [];
+        /** @type {Array<{ crmUserId: string, rcExtensionId: string[] }>} */
         const newUserMappings = [];
         for (const crmUser of crmUserList) {
             const existingMapping = adminConfig?.userMappings?.find(u => u.crmUserId == crmUser.id);
+            /** @type {Array<string | number>} */
             let existingMappingRcExtensionIds = [];
             // TEMP: backward compatibility for string value
             if (existingMapping?.rcExtensionId) {
@@ -290,7 +353,7 @@ async function getUserMapping({ user, hashedRcAccountId, rcExtensionList }) {
                     existingMappingRcExtensionIds = [existingMapping.rcExtensionId];
                 }
                 else {
-                    existingMappingRcExtensionIds = existingMapping.rcExtensionId;
+                    existingMappingRcExtensionIds = /** @type {Array<string | number>} */ (existingMapping.rcExtensionId);
                 }
             }
             const rcExtension = rcExtensionList.filter(e => existingMappingRcExtensionIds.includes(e.id));
@@ -312,11 +375,9 @@ async function getUserMapping({ user, hashedRcAccountId, rcExtensionList }) {
             }
             // Case: new mapping
             else {
-                const rcExtensionForNewMapping = rcExtensionList.find(u =>
-                    u.email === crmUser.email ||
+                const rcExtensionForNewMapping = rcExtensionList.find(u => u.email === crmUser.email ||
                     u.name === crmUser.name ||
-                    (`${u.firstName} ${u.lastName}` === crmUser.name)
-                );
+                    (`${u.firstName} ${u.lastName}` === crmUser.name));
                 if (rcExtensionForNewMapping) {
                     userMappingResult.push({
                         crmUser: {
@@ -325,11 +386,11 @@ async function getUserMapping({ user, hashedRcAccountId, rcExtensionList }) {
                             email: crmUser.email ?? '',
                         },
                         rcUser: [{
-                            extensionId: rcExtensionForNewMapping.id,
-                            name: rcExtensionForNewMapping.name || `${rcExtensionForNewMapping.firstName} ${rcExtensionForNewMapping.lastName}`,
-                            extensionNumber: rcExtensionForNewMapping?.extensionNumber ?? '',
-                            email: rcExtensionForNewMapping?.email ?? ''
-                        }]
+                                extensionId: rcExtensionForNewMapping.id,
+                                name: rcExtensionForNewMapping.name || `${rcExtensionForNewMapping.firstName} ${rcExtensionForNewMapping.lastName}`,
+                                extensionNumber: rcExtensionForNewMapping?.extensionNumber ?? '',
+                                email: rcExtensionForNewMapping?.email ?? ''
+                            }]
                     });
                     newUserMappings.push({
                         crmUserId: crmUser.id.toString(),
@@ -350,12 +411,14 @@ async function getUserMapping({ user, hashedRcAccountId, rcExtensionList }) {
         }
         // One-time init
         if (!adminConfig?.userMappings) {
+            /** @type {Array<{ crmUserId: string, rcExtensionId: string[] }>} */
             const initialUserMappings = [];
             for (const userMapping of userMappingResult) {
-                if (userMapping.rcUser?.extensionId) {
+                const rcUser = /** @type {any} */ (userMapping.rcUser);
+                if (rcUser?.extensionId) {
                     initialUserMappings.push({
                         crmUserId: userMapping.crmUser.id.toString(),
-                        rcExtensionId: [userMapping.rcUser.extensionId.toString()]
+                        rcExtensionId: [rcUser.extensionId.toString()]
                     });
                 }
             }
@@ -375,10 +438,10 @@ async function getUserMapping({ user, hashedRcAccountId, rcExtensionList }) {
         if (newUserMappings.length > 0) {
             // TEMP: convert string to array
             if (adminConfig?.userMappings) {
-                adminConfig.userMappings = adminConfig.userMappings.map(u => ({
+                adminConfig.userMappings = /** @type {any} */ (adminConfig.userMappings.map(u => ({
                     ...u,
                     rcExtensionId: [u.rcExtensionId]
-                }));
+                })));
                 try {
                     await upsertAdminSettings({
                         hashedRcAccountId,
@@ -409,13 +472,15 @@ async function getUserMapping({ user, hashedRcAccountId, rcExtensionList }) {
     }
     return [];
 }
-
+/**
+ * @param {UserMappingParams} params
+ * @returns {Promise<UserMappingResultItem[] | any>}
+ */
 async function reinitializeUserMapping({ user, hashedRcAccountId, rcExtensionList }) {
     const platformModule = connectorRegistry.getConnector(user.platform);
     if (!platformModule.getUserList) {
         return [];
     }
-
     const proxyId = user.platformAdditionalInfo?.proxyId;
     let proxyConfig = null;
     if (proxyId) {
@@ -424,15 +489,14 @@ async function reinitializeUserMapping({ user, hashedRcAccountId, rcExtensionLis
             return [];
         }
     }
-
     const authType = await platformModule.getAuthType({ proxyId, proxyConfig });
     let authHeader = '';
     switch (authType) {
         case 'oauth':
             const oauthApp = oauth.getOAuthApp((await platformModule.getOauthInfo({ tokenUrl: user?.platformAdditionalInfo?.tokenUrl, hostname: user?.hostname, proxyId, proxyConfig })));
             // eslint-disable-next-line no-param-reassign
-            user = await oauth.checkAndRefreshAccessToken(oauthApp, user);
-            if (!user) {
+            const refreshedUser = await oauth.checkAndRefreshAccessToken(oauthApp, user);
+            if (!refreshedUser) {
                 return {
                     successful: false,
                     returnMessage: {
@@ -441,8 +505,9 @@ async function reinitializeUserMapping({ user, hashedRcAccountId, rcExtensionLis
                         ttl: 5000
                     },
                     isRevokeUserSession: true
-                }
+                };
             }
+            user = refreshedUser;
             authHeader = `Bearer ${user.accessToken}`;
             break;
         case 'apiKey':
@@ -450,19 +515,16 @@ async function reinitializeUserMapping({ user, hashedRcAccountId, rcExtensionLis
             authHeader = `Basic ${basicAuth}`;
             break;
     }
-
     const crmUserList = await platformModule.getUserList({ user, authHeader, proxyConfig });
+    /** @type {UserMappingResultItem[]} */
     const userMappingResult = [];
+    /** @type {Array<{ crmUserId: string, rcExtensionId: string[] }>} */
     const initialUserMappings = [];
-
     // Auto-match CRM users with RC extensions by email or name
     for (const crmUser of crmUserList) {
-        const rcExtensionForMapping = rcExtensionList.find(u =>
-            u.email === crmUser.email ||
+        const rcExtensionForMapping = rcExtensionList.find(u => u.email === crmUser.email ||
             u.name === crmUser.name ||
-            (`${u.firstName} ${u.lastName}` === crmUser.name)
-        );
-
+            (`${u.firstName} ${u.lastName}` === crmUser.name));
         if (rcExtensionForMapping) {
             userMappingResult.push({
                 crmUser: {
@@ -471,11 +533,11 @@ async function reinitializeUserMapping({ user, hashedRcAccountId, rcExtensionLis
                     email: crmUser.email ?? '',
                 },
                 rcUser: [{
-                    extensionId: rcExtensionForMapping.id,
-                    name: rcExtensionForMapping.name || `${rcExtensionForMapping.firstName} ${rcExtensionForMapping.lastName}`,
-                    extensionNumber: rcExtensionForMapping?.extensionNumber ?? '',
-                    email: rcExtensionForMapping?.email ?? ''
-                }]
+                        extensionId: rcExtensionForMapping.id,
+                        name: rcExtensionForMapping.name || `${rcExtensionForMapping.firstName} ${rcExtensionForMapping.lastName}`,
+                        extensionNumber: rcExtensionForMapping?.extensionNumber ?? '',
+                        email: rcExtensionForMapping?.email ?? ''
+                    }]
             });
             initialUserMappings.push({
                 crmUserId: crmUser.id.toString(),
@@ -493,7 +555,6 @@ async function reinitializeUserMapping({ user, hashedRcAccountId, rcExtensionLis
             });
         }
     }
-
     // Overwrite existing mappings with fresh auto-matched mappings
     try {
         await upsertAdminSettings({
@@ -506,10 +567,8 @@ async function reinitializeUserMapping({ user, hashedRcAccountId, rcExtensionLis
     catch (error) {
         return handleDatabaseError(error, 'Error reinitializing user mapping');
     }
-
     return userMappingResult;
 }
-
 exports.validateAdminRole = validateAdminRole;
 exports.validateRcUserToken = validateRcUserToken;
 exports.upsertAdminSettings = upsertAdminSettings;

package/dist/handlers/appointment.d.ts

@@ -0,0 +1,9 @@
+/** @typedef {import('../types').AppointmentAuthParams} AppointmentAuthParams */
+/** @typedef {import('../types').AppointmentAuthFailure} AppointmentAuthFailure */
+/** @typedef {import('../types').AppointmentAuthResult} AppointmentAuthResult */
+/** @typedef {import('../types').AppointmentHandlerResult} AppointmentHandlerResult */
+/** @typedef {import('../types').AppointmentPayloadParams} AppointmentPayloadParams */
+/** @typedef {import('../types').AppointmentPatchParams} AppointmentPatchParams */
+/** @typedef {import('../types').AppointmentRecordParams} AppointmentRecordParams */
+/** @typedef {import('../types').ListAppointmentsParams} ListAppointmentsParams */
+export {};

package/{handlers → dist/handlers}/appointment.js

@@ -1,16 +1,32 @@
-const { UserModel } = require('../models/userModel');
-const oauth = require('../lib/oauth');
-const connectorRegistry = require('../connector/registry');
-const { Connector } = require('../models/dynamo/connectorSchema');
+"use strict";
+// @ts-check
+/** @typedef {import('../types').AppointmentAuthParams} AppointmentAuthParams */
+/** @typedef {import('../types').AppointmentAuthFailure} AppointmentAuthFailure */
+/** @typedef {import('../types').AppointmentAuthResult} AppointmentAuthResult */
+/** @typedef {import('../types').AppointmentHandlerResult} AppointmentHandlerResult */
+/** @typedef {import('../types').AppointmentPayloadParams} AppointmentPayloadParams */
+/** @typedef {import('../types').AppointmentPatchParams} AppointmentPatchParams */
+/** @typedef {import('../types').AppointmentRecordParams} AppointmentRecordParams */
+/** @typedef {import('../types').ListAppointmentsParams} ListAppointmentsParams */
+Object.defineProperty(exports, "__esModule", { value: true });
+const { UserModel: UserModelImport } = require('../models/userModel');
+const UserModel = /** @type {any} */ (UserModelImport);
+const oauth = /** @type {any} */ (require('../lib/oauth'));
+const connectorRegistry = /** @type {any} */ (require('../connector/registry'));
+const { Connector: ConnectorImport } = require('../models/dynamo/connectorSchema');
+const Connector = /** @type {any} */ (ConnectorImport);
 const { handleApiError, handleDatabaseError } = require('../lib/errorHandler');
-
+/**
+ * @param {AppointmentAuthParams} params
+ * @returns {Promise<AppointmentAuthResult>}
+ */
 async function resolveAuth({ platform, userId }) {
     let user = null;
     try {
         user = await UserModel.findByPk(userId);
     }
     catch (error) {
-        return handleDatabaseError(error, 'Error finding user');
+        return /** @type {AppointmentAuthFailure} */ (handleDatabaseError(error, 'Error finding user'));
     }
     if (!user || !user.accessToken) {
         return {
@@ -22,14 +38,12 @@ async function resolveAuth({ platform, userId }) {
             }
         };
     }
-
     const platformModule = connectorRegistry.getConnector(platform);
     const proxyId = user.platformAdditionalInfo?.proxyId;
     let proxyConfig = null;
     if (proxyId) {
         proxyConfig = await Connector.getProxyConfig(proxyId);
     }
-
     const authType = await platformModule.getAuthType({ proxyId, proxyConfig });
     let authHeader = '';
     switch (authType) {
@@ -63,7 +77,6 @@ async function resolveAuth({ platform, userId }) {
         default:
             break;
     }
-
     return {
         successful: true,
         user,
@@ -72,12 +85,15 @@ async function resolveAuth({ platform, userId }) {
         proxyConfig
     };
 }
-
+/**
+ * @param {ListAppointmentsParams} params
+ * @returns {Promise<AppointmentHandlerResult>}
+ */
 async function listAppointments({ platform, userId, range, mineOnly, forceSync }) {
     try {
         const authResult = await resolveAuth({ platform, userId });
-        if (!authResult.successful) return authResult;
-
+        if (!authResult.successful)
+            return authResult;
         const result = await authResult.platformModule.listAppointments({
             user: authResult.user,
             authHeader: authResult.authHeader,
@@ -92,12 +108,15 @@ async function listAppointments({ platform, userId, range, mineOnly, forceSync }
         return handleApiError(e, platform, 'listAppointments', { userId });
     }
 }
-
+/**
+ * @param {AppointmentPayloadParams} params
+ * @returns {Promise<AppointmentHandlerResult>}
+ */
 async function createAppointment({ platform, userId, payload }) {
     try {
         const authResult = await resolveAuth({ platform, userId });
-        if (!authResult.successful) return authResult;
-
+        if (!authResult.successful)
+            return authResult;
         const result = await authResult.platformModule.createAppointment({
             user: authResult.user,
             authHeader: authResult.authHeader,
@@ -110,12 +129,15 @@ async function createAppointment({ platform, userId, payload }) {
         return handleApiError(e, platform, 'createAppointment', { userId });
     }
 }
-
+/**
+ * @param {AppointmentPatchParams} params
+ * @returns {Promise<AppointmentHandlerResult>}
+ */
 async function updateAppointment({ platform, userId, appointmentId, patchBody }) {
     try {
         const authResult = await resolveAuth({ platform, userId });
-        if (!authResult.successful) return authResult;
-
+        if (!authResult.successful)
+            return authResult;
         const result = await authResult.platformModule.updateAppointment({
             user: authResult.user,
             authHeader: authResult.authHeader,
@@ -129,12 +151,15 @@ async function updateAppointment({ platform, userId, appointmentId, patchBody })
         return handleApiError(e, platform, 'updateAppointment', { userId, appointmentId });
     }
 }
-
+/**
+ * @param {AppointmentRecordParams} params
+ * @returns {Promise<AppointmentHandlerResult>}
+ */
 async function refreshAppointment({ platform, userId, appointmentId }) {
     try {
         const authResult = await resolveAuth({ platform, userId });
-        if (!authResult.successful) return authResult;
-
+        if (!authResult.successful)
+            return authResult;
         const result = await authResult.platformModule.refreshAppointment({
             user: authResult.user,
             authHeader: authResult.authHeader,
@@ -147,12 +172,15 @@ async function refreshAppointment({ platform, userId, appointmentId }) {
         return handleApiError(e, platform, 'refreshAppointment', { userId, appointmentId });
     }
 }
-
+/**
+ * @param {AppointmentRecordParams} params
+ * @returns {Promise<AppointmentHandlerResult>}
+ */
 async function confirmAppointment({ platform, userId, appointmentId }) {
     try {
         const authResult = await resolveAuth({ platform, userId });
-        if (!authResult.successful) return authResult;
-
+        if (!authResult.successful)
+            return authResult;
         const result = await authResult.platformModule.confirmAppointment({
             user: authResult.user,
             authHeader: authResult.authHeader,
@@ -165,12 +193,15 @@ async function confirmAppointment({ platform, userId, appointmentId }) {
         return handleApiError(e, platform, 'confirmAppointment', { userId, appointmentId });
     }
 }
-
+/**
+ * @param {AppointmentRecordParams} params
+ * @returns {Promise<AppointmentHandlerResult>}
+ */
 async function cancelAppointment({ platform, userId, appointmentId }) {
     try {
         const authResult = await resolveAuth({ platform, userId });
-        if (!authResult.successful) return authResult;
-
+        if (!authResult.successful)
+            return authResult;
         const result = await authResult.platformModule.cancelAppointment({
             user: authResult.user,
             authHeader: authResult.authHeader,
@@ -183,11 +214,9 @@ async function cancelAppointment({ platform, userId, appointmentId }) {
         return handleApiError(e, platform, 'cancelAppointment', { userId, appointmentId });
     }
 }
-
 exports.listAppointments = listAppointments;
 exports.createAppointment = createAppointment;
 exports.updateAppointment = updateAppointment;
 exports.refreshAppointment = refreshAppointment;
 exports.confirmAppointment = confirmAppointment;
 exports.cancelAppointment = cancelAppointment;
-

package/dist/handlers/auth.d.ts

@@ -0,0 +1,9 @@
+/** @typedef {import('../types').ApiKeyLoginParams} ApiKeyLoginParams */
+/** @typedef {import('../types').AuthHandlerResult} AuthHandlerResult */
+/** @typedef {import('../types').AuthValidationParams} AuthValidationParams */
+/** @typedef {import('../types').AuthValidationResult} AuthValidationResult */
+/** @typedef {import('../types').LicenseStatusParams} LicenseStatusParams */
+/** @typedef {import('../types').OAuthCallbackParams} OAuthCallbackParams */
+/** @typedef {import('../types').RingcentralOAuthCallbackParams} RingcentralOAuthCallbackParams */
+/** @typedef {import('../types').SaveUserInfoParams} SaveUserInfoParams */
+export {};