@webex/calling 3.12.0-next.93 → 3.12.0-next.94

package/dist/CallingClient/registration/types.js.map

@@ -1 +1 @@
-{"version":3,"names":["HARD_STOP_REASON","exports"],"sources":["types.ts"],"sourcesContent":["import {Devices, IDeviceInfo, RegistrationStatus} from '../../common/types';\nimport {LineError} from '../../Errors/catalog/LineError';\nimport {MobiusAsyncEvent} from '../calling/types';\n\nexport type Header = {\n  [key: string]: string;\n};\n\n/**\n * Reason a registration is torn down without any re-registration attempt.\n * The values double as the label used in hard-stop log messages.\n */\nexport enum HARD_STOP_REASON {\n  REGISTRATION_DOWN = 'registration-down',\n  SESSION_SUPERSEDED = 'session-superseded',\n}\n\n/**\n * Describes a hard stop of the registration. A superseded session must carry the\n * {@link LineError} that is handed to the SDK consumer as the reason on\n * `LINE_EVENTS.UNREGISTERED`; a registration-down stop carries no reason.\n */\nexport type HardStop =\n  | {reason: HARD_STOP_REASON.REGISTRATION_DOWN; error?: undefined}\n  | {reason: HARD_STOP_REASON.SESSION_SUPERSEDED; error: LineError};\n\nexport type restoreRegistrationCallBack = (\n  restoreData: IDeviceInfo,\n  caller: string\n) => Promise<boolean>;\n\nexport type retry429CallBack = (retryAfter: number, caller: string) => Promise<void>;\n\nexport type sessionSupersededCallBack = (clientError: LineError) => Promise<void>;\n\n/**\n * Specialized handlers a caller of `handleRegistrationErrors` opts into. A flow only\n * passes the handlers for the status codes it can act on, which is what keeps handling\n * such as the `409` session-superseded hard stop scoped to the keepalive flow.\n */\nexport type RegistrationErrorHandlers = {\n  /** Invoked on `429` so the caller can reschedule its own flow after `Retry-After`. */\n  retry429Cb?: retry429CallBack;\n  /** Invoked on `403` device-limit so the caller can restore the existing registration. */\n  restoreRegCb?: restoreRegistrationCallBack;\n  /** Invoked on `409` so the caller can hard stop a superseded calling session. */\n  sessionSupersededCb?: sessionSupersededCallBack;\n};\n\n/**\n * Outcome of `handleRegistrationErrors`.\n */\nexport type RegistrationErrorResult = {\n  /** The error is terminal — the caller must not retry. */\n  finalError: boolean;\n  /** The Mobius WebSocket of the failed server must be torn down before moving on. */\n  shouldDisconnect: boolean;\n  /**\n   * One of the {@link RegistrationErrorHandlers} fully owned the outcome, including\n   * cleanup and notifying the consumer. The caller must skip its own failure handling so\n   * that events are not emitted twice.\n   */\n  handledByCallback: boolean;\n};\n\nexport type FailoverCacheState = {\n  attempt: number;\n  timeElapsed: number;\n  retryScheduledTime: number;\n  serverType: 'primary' | 'backup';\n};\n\n/**\n * Represents an interface for managing registration-related operations.\n */\nexport interface IRegistration {\n  /**\n   * Sets the primary and backup Mobius server URLs.\n   *\n   * @param primaryMobiusUris - An array of primary Mobius server URLs.\n   * @param backupMobiusUris - An array of backup Mobius server URLs.\n   */\n  setMobiusServers(primaryMobiusUris: string[], backupMobiusUris: string[]): void;\n\n  /**\n   * Triggers the registration process with the given list of servers\n   * Registration is attempted with primary and backup until it succeeds or the list is exhausted\n   */\n  triggerRegistration(): Promise<void>;\n\n  /**\n   * Checks if the device is currently registered.\n   *\n   */\n  isDeviceRegistered(): boolean;\n\n  /**\n   * Sets the status of the registration.\n   *\n   * @param value - The registration status to set.\n   */\n  setStatus(value: RegistrationStatus): void;\n\n  /**\n   * Retrieves the current registration status.\n   *\n   */\n  getStatus(): RegistrationStatus;\n\n  /**\n   * Retrieves information about the device as {@link IDeviceInfo}.\n   *\n   */\n  getDeviceInfo(): IDeviceInfo;\n\n  /**\n   * Clears the keep-alive timer used for registration.\n   */\n  clearKeepaliveTimer(): void;\n\n  /**\n   * Deregisters the device.\n   */\n  deregister(closeMobiusWss: boolean): void;\n\n  /**\n   * Sets the active Mobius server URL to use for registration.\n   *\n   * @param url - The Mobius server URL to set as active.\n   */\n  setActiveMobiusUrl(url: string): void;\n\n  /**\n   * Retrieves the active Mobius server URL.\n   *\n   */\n  getActiveMobiusUrl(): string;\n\n  /**\n   * Attempts to reconnect after a connection failure.\n   *\n   * @param caller - The caller's identifier for reconnection.\n   */\n  reconnectOnFailure(caller: string): Promise<void>;\n\n  /**\n   * Checks if a reconnection attempt is pending.\n   *\n   */\n  isReconnectPending(): boolean;\n\n  /**\n   * Restores the connection and attempts refreshing existing registration with server.\n   * Allows retry if not restored in the first attempt.\n   *\n   * @param retry - Set to `true` to trigger a retry after restoration.\n   */\n  handleConnectionRestoration(retry: boolean): Promise<boolean>;\n\n  /**\n   * Populate deviceInfo from a devices response (e.g., getDevices API).\n   */\n  setDeviceInfo(body: Devices): void;\n\n  /**\n   * Handles a Mobius REGISTRATION_DOWN async event. Ends the first active\n   * call (if any) and runs registration-side cleanup.\n   *\n   * @param event - The Mobius async event payload (optional).\n   */\n  handleRegistrationDownEvent(event?: MobiusAsyncEvent): Promise<void>;\n}\n"],"mappings":";;;;;;;AAQA;AACA;AACA;AACA;AAHA,IAIYA,gBAAgB,GAAAC,OAAA,CAAAD,gBAAA,0BAAhBA,gBAAgB;EAAhBA,gBAAgB;EAAhBA,gBAAgB;EAAA,OAAhBA,gBAAgB;AAAA;AAK5B;AACA;AACA;AACA;AACA;AAcA;AACA;AACA;AACA;AACA;AAUA;AACA;AACA;AAqBA;AACA;AACA","ignoreList":[]}
+{"version":3,"names":["HARD_STOP_REASON","exports"],"sources":["types.ts"],"sourcesContent":["import {Devices, IDeviceInfo, RegistrationStatus} from '../../common/types';\nimport {LineError} from '../../Errors/catalog/LineError';\nimport {MobiusAsyncEvent} from '../calling/types';\n\nexport type Header = {\n  [key: string]: string;\n};\n\n/**\n * Reason a registration is torn down without any re-registration attempt.\n * The values double as the label used in hard-stop log messages.\n */\nexport enum HARD_STOP_REASON {\n  REGISTRATION_DOWN = 'registration-down',\n  SESSION_SUPERSEDED = 'session-superseded',\n}\n\n/**\n * Describes a hard stop of the registration. A superseded session must carry the\n * {@link LineError} that is handed to the SDK consumer as the reason on\n * `LINE_EVENTS.UNREGISTERED`; a registration-down stop carries no reason.\n */\nexport type HardStop =\n  | {reason: HARD_STOP_REASON.REGISTRATION_DOWN; error?: undefined}\n  | {reason: HARD_STOP_REASON.SESSION_SUPERSEDED; error: LineError};\n\nexport type restoreRegistrationCallBack = (\n  restoreData: IDeviceInfo,\n  caller: string\n) => Promise<boolean>;\n\nexport type retry429CallBack = (retryAfter: number, caller: string) => Promise<void>;\n\nexport type sessionSupersededCallBack = (clientError: LineError) => Promise<void>;\n\n/**\n * Specialized handlers a caller of `handleRegistrationErrors` opts into. A flow only\n * passes the handlers for the status codes it can act on, which is what keeps handling\n * such as the `409` session-superseded hard stop scoped to the keepalive flow.\n */\nexport type RegistrationErrorHandlers = {\n  /** Invoked on `429` so the caller can reschedule its own flow after `Retry-After`. */\n  retry429Cb?: retry429CallBack;\n  /** Invoked on `403` device-limit so the caller can restore the existing registration. */\n  restoreRegCb?: restoreRegistrationCallBack;\n  /** Invoked on `409` so the caller can hard stop a superseded calling session. */\n  sessionSupersededCb?: sessionSupersededCallBack;\n};\n\n/**\n * Outcome of `handleRegistrationErrors`.\n */\nexport type RegistrationErrorResult = {\n  /** The error is terminal — the caller must not retry. */\n  finalError: boolean;\n  /** The Mobius WebSocket of the failed server must be torn down before moving on. */\n  shouldDisconnect: boolean;\n};\n\nexport type FailoverCacheState = {\n  attempt: number;\n  timeElapsed: number;\n  retryScheduledTime: number;\n  serverType: 'primary' | 'backup';\n};\n\n/**\n * Represents an interface for managing registration-related operations.\n */\nexport interface IRegistration {\n  /**\n   * Sets the primary and backup Mobius server URLs.\n   *\n   * @param primaryMobiusUris - An array of primary Mobius server URLs.\n   * @param backupMobiusUris - An array of backup Mobius server URLs.\n   */\n  setMobiusServers(primaryMobiusUris: string[], backupMobiusUris: string[]): void;\n\n  /**\n   * Triggers the registration process with the given list of servers\n   * Registration is attempted with primary and backup until it succeeds or the list is exhausted\n   */\n  triggerRegistration(): Promise<void>;\n\n  /**\n   * Checks if the device is currently registered.\n   *\n   */\n  isDeviceRegistered(): boolean;\n\n  /**\n   * Sets the status of the registration.\n   *\n   * @param value - The registration status to set.\n   */\n  setStatus(value: RegistrationStatus): void;\n\n  /**\n   * Retrieves the current registration status.\n   *\n   */\n  getStatus(): RegistrationStatus;\n\n  /**\n   * Retrieves information about the device as {@link IDeviceInfo}.\n   *\n   */\n  getDeviceInfo(): IDeviceInfo;\n\n  /**\n   * Clears the keep-alive timer used for registration.\n   */\n  clearKeepaliveTimer(): void;\n\n  /**\n   * Deregisters the device.\n   */\n  deregister(closeMobiusWss: boolean): void;\n\n  /**\n   * Sets the active Mobius server URL to use for registration.\n   *\n   * @param url - The Mobius server URL to set as active.\n   */\n  setActiveMobiusUrl(url: string): void;\n\n  /**\n   * Retrieves the active Mobius server URL.\n   *\n   */\n  getActiveMobiusUrl(): string;\n\n  /**\n   * Attempts to reconnect after a connection failure.\n   *\n   * @param caller - The caller's identifier for reconnection.\n   */\n  reconnectOnFailure(caller: string): Promise<void>;\n\n  /**\n   * Checks if a reconnection attempt is pending.\n   *\n   */\n  isReconnectPending(): boolean;\n\n  /**\n   * Restores the connection and attempts refreshing existing registration with server.\n   * Allows retry if not restored in the first attempt.\n   *\n   * @param retry - Set to `true` to trigger a retry after restoration.\n   */\n  handleConnectionRestoration(retry: boolean): Promise<boolean>;\n\n  /**\n   * Populate deviceInfo from a devices response (e.g., getDevices API).\n   */\n  setDeviceInfo(body: Devices): void;\n\n  /**\n   * Handles a Mobius REGISTRATION_DOWN async event. Ends the first active\n   * call (if any) and runs registration-side cleanup.\n   *\n   * @param event - The Mobius async event payload (optional).\n   */\n  handleRegistrationDownEvent(event?: MobiusAsyncEvent): Promise<void>;\n}\n"],"mappings":";;;;;;;AAQA;AACA;AACA;AACA;AAHA,IAIYA,gBAAgB,GAAAC,OAAA,CAAAD,gBAAA,0BAAhBA,gBAAgB;EAAhBA,gBAAgB;EAAhBA,gBAAgB;EAAA,OAAhBA,gBAAgB;AAAA;AAK5B;AACA;AACA;AACA;AACA;AAcA;AACA;AACA;AACA;AACA;AAUA;AACA;AACA;AAeA;AACA;AACA","ignoreList":[]}

package/dist/common/Utils.js

@@ -291,11 +291,9 @@ function _handleRegistrationErrors() {
       restoreRegCb,
       sessionSupersededCb,
       shouldDisconnect,
-      handledByCallback,
       lineError,
       errorCode,
       finalError,
-      handleUnknownError,
       caller,
       retryAfter,
       errorBody,
@@ -315,18 +313,9 @@ function _handleRegistrationErrors() {
           serverCount = _args.length > 4 && _args[4] !== undefined ? _args[4] : 1;
           retry429Cb = handlers.retry429Cb, restoreRegCb = handlers.restoreRegCb, sessionSupersededCb = handlers.sessionSupersededCb;
           shouldDisconnect = false;
-          handledByCallback = false;
           lineError = (0, _LineError.createLineError)('', {}, _types2.ERROR_TYPE.DEFAULT, _types3.RegistrationStatus.INACTIVE);
           errorCode = Number(err.statusCode);
           finalError = false;
-          /* Treatment for a status code this handler has no specific rule for: notify the
-           * consumer and leave the retry decision to the caller. */
-          handleUnknownError = function handleUnknownError() {
-            updateLineErrorContext(loggerContext, _types2.ERROR_TYPE.DEFAULT, 'Unknown error', _types3.RegistrationStatus.INACTIVE, lineError);
-            _Logger.default.warn("Unknown Error", loggerContext);
-            emitterCb(lineError, finalError);
-            shouldDisconnect = serverCount > 1;
-          };
           _Logger.default.warn("Status code: -> ".concat(errorCode), loggerContext);
           _t = errorCode;
           _context.next = _t === _types2.ERROR_CODE.BAD_REQUEST ? 1 : _t === _types2.ERROR_CODE.UNAUTHORIZED ? 2 : _t === _types2.ERROR_CODE.DEVICE_NOT_FOUND ? 3 : _t === _types2.ERROR_CODE.CONFLICT ? 4 : _t === _types2.ERROR_CODE.TOO_MANY_REQUESTS ? 7 : _t === _types2.ERROR_CODE.INTERNAL_SERVER_ERROR ? 9 : _t === _types2.ERROR_CODE.SERVICE_UNAVAILABLE ? 10 : _t === _types2.ERROR_CODE.FORBIDDEN ? 11 : 19;
@@ -358,11 +347,10 @@ function _handleRegistrationErrors() {
             _context.next = 5;
             break;
           }
-          handleUnknownError();
+          _Logger.default.warn("409 Conflict: ignored, caller does not handle a superseded session", loggerContext);
           return _context.abrupt("continue", 20);
         case 5:
           finalError = true;
-          handledByCallback = true;
           _Logger.default.warn("409 Conflict: session superseded by another device for this user", loggerContext);
           updateLineErrorContext(loggerContext, _types2.ERROR_TYPE.SESSION_SUPERSEDED, _constants.SESSION_SUPERSEDED_MESSAGE, _types3.RegistrationStatus.INACTIVE, lineError);
           _context.next = 6;
@@ -409,8 +397,7 @@ function _handleRegistrationErrors() {
           shouldDisconnect = serverCount > 1;
           return _context.abrupt("return", {
             finalError: finalError,
-            shouldDisconnect: shouldDisconnect,
-            handledByCallback: handledByCallback
+            shouldDisconnect: shouldDisconnect
           });
         case 12:
           code = Number(errorBody.errorCode);
@@ -455,12 +442,14 @@ function _handleRegistrationErrors() {
         case 18:
           return _context.abrupt("continue", 20);
         case 19:
-          handleUnknownError();
+          updateLineErrorContext(loggerContext, _types2.ERROR_TYPE.DEFAULT, 'Unknown error', _types3.RegistrationStatus.INACTIVE, lineError);
+          _Logger.default.warn("Unknown Error", loggerContext);
+          emitterCb(lineError, finalError);
+          shouldDisconnect = serverCount > 1;
         case 20:
           return _context.abrupt("return", {
             finalError: finalError,
-            shouldDisconnect: shouldDisconnect,
-            handledByCallback: handledByCallback
+            shouldDisconnect: shouldDisconnect
           });
         case 21:
         case "end":