cbcore-ts 1.1.16 → 1.1.18

package/scripts/CBCore.ts

@@ -41,17 +41,17 @@ declare const CBCoreInitializerObject: any
  *        // Additional session-level state goes here.
  *        mySessionData: MySessionData | undefined = undefined
  *
- *        // Override didSetUserProfile to fetch session data before the
+ *        // Override userProfileDidChange to fetch session data before the
  *        // userDidLogIn broadcast fires. Call super only after your data
  *        // is ready so that every listener receives a fully populated core.
- *        override async didSetUserProfile() {
+ *        override async userProfileDidChange() {
  *            if (IS(this.userProfile)) {
  *                this.mySessionData = await fetchMySessionData()
  *            }
  *            else {
  *                this.mySessionData = undefined
  *            }
- *            super.didSetUserProfile()
+ *            super.userProfileDidChange()
  *        }
  *
  *        // Expose a typed singleton so callers never need CBCore.sharedInstance.
@@ -65,7 +65,7 @@ declare const CBCoreInitializerObject: any
  * 2. Register the subclass at app startup, before UICore is initialised:
  *
  *    ```typescript
- *    CBCore.setSharedInstance(new MyAppCore())
+ *    CBCore.registerSharedInstance(new MyAppCore())
  *    CBCore.initIfNeededWithViewCore(new UICore(...))
  *    ```
  *
@@ -108,13 +108,13 @@ export class CBCore extends UIObject {
             }
             
             if (event.key == "CBLanguageKey") {
-                this.didSetLanguageKey()
+                this.languageKeyDidChange()
             }
             
         }.bind(this))
         
         
-        this.didSetLanguageKey()
+        this.languageKeyDidChange()
         
         
     }
@@ -130,10 +130,10 @@ export class CBCore extends UIObject {
     /**
      * Returns the shared singleton instance.
      *
-     * If `setSharedInstance` was called before this getter was first accessed,
+     * If `registerSharedInstance` was called before this getter was first accessed,
      * that instance is returned. Otherwise a default `CBCore` is created.
      * Library-internal code always goes through this getter, so registering a
-     * subclass via `setSharedInstance` is sufficient to replace the singleton
+     * subclass via `registerSharedInstance` is sufficient to replace the singleton
      * for the entire session.
      */
     static get sharedInstance() {
@@ -154,16 +154,16 @@ export class CBCore extends UIObject {
      *
      * ```typescript
      * // App entry point — must be the very first thing that runs.
-     * CBCore.setSharedInstance(new MyAppCore())
+     * CBCore.registerSharedInstance(new MyAppCore())
      * CBCore.initIfNeededWithViewCore(new UICore("root", RootViewController))
      * ```
      */
-    static setSharedInstance(instance: CBCore) {
+    static registerSharedInstance(instance: CBCore) {
         
         if (CBCore._sharedInstance) {
             /// #if DEV
             throw new Error(
-                "CBCore.setSharedInstance must be called before sharedInstance is first accessed. " +
+                "CBCore.registerSharedInstance must be called before sharedInstance is first accessed. " +
                 "Move the call to the very top of your app entry point."
             )
             /// #endif
@@ -201,10 +201,10 @@ export class CBCore extends UIObject {
     set isUserLoggedIn(isUserLoggedIn: boolean) {
         const previousValue = this.isUserLoggedIn
         this._isUserLoggedIn = isUserLoggedIn
-        this.didSetIsUserLoggedIn(previousValue)
+        this.userLoginStateDidChange(previousValue)
     }
     
-    didSetIsUserLoggedIn(previousValue: boolean) {
+    userLoginStateDidChange(previousValue: boolean) {
         
         const isUserLoggedIn = this.isUserLoggedIn
         
@@ -221,7 +221,7 @@ export class CBCore extends UIObject {
         }
         else if (previousValue != isUserLoggedIn) {
             
-            this.didLogOut()
+            this.userDidLogOut()
             
         }
         
@@ -233,7 +233,7 @@ export class CBCore extends UIObject {
      * Subclasses may override this to suppress the route change when they intend
      * to navigate somewhere specific immediately after logout.
      */
-    didLogOut() {
+    userDidLogOut() {
         
         this.performFunctionWithDelay(0.01, function (this: CBCore) {
             
@@ -273,33 +273,33 @@ export class CBCore extends UIObject {
     
     set userProfile(userProfile: CBUserProfile) {
         this._userProfile = userProfile
-        this.didSetUserProfile()
+        this.userProfileDidChange()
     }
     
     /**
      * Called whenever `userProfile` is assigned.
      *
      * The default implementation derives `isUserLoggedIn` from the profile
-     * and triggers the login/logout broadcast via `didSetIsUserLoggedIn`.
+     * and triggers the login/logout broadcast via `userLoginStateDidChange`.
      *
      * Subclasses may override this to fetch additional session data before
      * the broadcast fires. The override must be `async` and must call
-     * `super.didSetUserProfile()` after it has finished populating any
+     * `super.userProfileDidChange()` after it has finished populating any
      * extra state, so that all broadcast listeners receive a complete core:
      *
      * ```typescript
-     * override async didSetUserProfile() {
+     * override async userProfileDidChange() {
      *     if (IS(this.userProfile)) {
      *         this.companyStatus = (await SocketClient.CurrentUserStatusInCompany()).result
      *     }
      *     else {
      *         this.companyStatus = undefined
      *     }
-     *     super.didSetUserProfile()   // broadcast fires here
+     *     super.userProfileDidChange()   // broadcast fires here
      * }
      * ```
      */
-    didSetUserProfile() {
+    userProfileDidChange() {
         this.isUserLoggedIn = IS(this.userProfile)
     }
     
@@ -309,7 +309,7 @@ export class CBCore extends UIObject {
             localStorage.removeItem("CBLanguageKey")
         }
         localStorage.setItem("CBLanguageKey", JSON.stringify(languageKey))
-        this.didSetLanguageKey()
+        this.languageKeyDidChange()
     }
     
     get languageKey() {
@@ -319,7 +319,7 @@ export class CBCore extends UIObject {
         ).replace("\"", "")
     }
     
-    didSetLanguageKey() {
+    languageKeyDidChange() {
         UIRoute.currentRoute.routeWithComponent(
             "settings",
             { "language": this.languageKey },

package/scripts/CBSocketCallbackHolder.ts

@@ -38,15 +38,15 @@ interface CBSocketCallbackHolderMessageDescriptor {
     
     /**
      * Called when a keepalive frame arrives for this descriptor's request.
-     * Registered via CBSocketRequestPromise.didReceiveKeepalive().
+     * Registered via CBSocketRequestPromise.addKeepaliveHandler().
      */
     keepaliveHandler?: (payload: CBSocketKeepalivePayload) => void;
     
     /**
-     * When true the defaultKeepaliveHandler on CBSocketClient is NOT called
+     * When true the default keepalive handler on CBSocketClient is NOT called
      * for this descriptor — only keepaliveHandler fires.
      */
-    keepaliveHandlerOverridesDefault: boolean;
+    skipsDefaultKeepaliveHandler: boolean;
     
 }
 
@@ -72,7 +72,7 @@ export class CBSocketCallbackHolder extends UIObject {
         [x: string]: CBSocketMessageHandlerFunction[]
     } = {}
     
-    onetimeHandlers: {
+    oneTimeHandlers: {
         [x: string]: CBSocketMessageHandlerFunction[]
     } = {}
     
@@ -164,15 +164,15 @@ export class CBSocketCallbackHolder extends UIObject {
         
     }
     
-    registerOnetimeHandler(key: string, handlerFunction: CBSocketMessageHandlerFunction) {
+    registerOneTimeHandler(key: string, handlerFunction: CBSocketMessageHandlerFunction) {
         
-        if (!this.onetimeHandlers[key]) {
+        if (!this.oneTimeHandlers[key]) {
             
-            this.onetimeHandlers[key] = []
+            this.oneTimeHandlers[key] = []
             
         }
         
-        this.onetimeHandlers[key].push(handlerFunction)
+        this.oneTimeHandlers[key].push(handlerFunction)
         
     }
     
@@ -503,7 +503,7 @@ export class CBSocketCallbackHolder extends UIObject {
                 completionFunction: completionFunction,
                 
                 keepaliveHandler: undefined,
-                keepaliveHandlerOverridesDefault: NO
+                skipsDefaultKeepaliveHandler: NO
                 
             })
             
@@ -625,7 +625,7 @@ export class CBSocketCallbackHolder extends UIObject {
             }.bind(this),
             
             keepaliveHandler: undefined,
-            keepaliveHandlerOverridesDefault: NO
+            skipsDefaultKeepaliveHandler: NO
             
         })
         
@@ -664,9 +664,9 @@ export class CBSocketCallbackHolder extends UIObject {
             
         }
         
-        if (this.onetimeHandlers[key]) {
+        if (this.oneTimeHandlers[key]) {
             
-            this.onetimeHandlers[key].forEach(function (
+            this.oneTimeHandlers[key].forEach(function (
                 this: CBSocketCallbackHolder,
                 handler: CBSocketMessageHandlerFunction
             ) {
@@ -675,7 +675,7 @@ export class CBSocketCallbackHolder extends UIObject {
                 
             }.bind(this))
             
-            delete this.onetimeHandlers[key]
+            delete this.oneTimeHandlers[key]
             
         }
         
@@ -706,8 +706,8 @@ export class CBSocketCallbackHolder extends UIObject {
                     this._resetTimeoutForDescriptor(descriptor)
                     
                     // Fire the default handler unless the per-call handler overrides it
-                    if (!descriptor.keepaliveHandlerOverridesDefault) {
-                        this._socketClient.defaultKeepaliveHandler?.(payload)
+                    if (!descriptor.skipsDefaultKeepaliveHandler) {
+                        this._socketClient.keepaliveDidArrive?.(payload)
                     }
                     
                     // Fire the per-call handler if one was registered

package/scripts/CBSocketClient.ts

@@ -65,7 +65,7 @@ export function IS_NOT_SOCKET_ERROR(object: any) {
 
 /**
  * A Promise returned by resultForMessageForKey.
- * Exposes didReceiveKeepalive() for registering a keepalive callback
+ * Exposes addKeepaliveHandler() for registering a keepalive callback
  * in the same fluent style as the rest of the API.
  */
 export interface CBSocketRequestPromise<T> extends Promise<T> {
@@ -73,16 +73,15 @@ export interface CBSocketRequestPromise<T> extends Promise<T> {
      * Register a handler to be called each time a keepalive frame arrives
      * for this request.
      *
-     * @param handler               Called with the payload sent by the server.
-     * @param extendsDefaultHandler When true (default) the application-level
-     *                              defaultKeepaliveHandler fires first, then
-     *                              this handler. When false this handler fires
-     *                              alone and the default is suppressed for this
-     *                              request.
+     * @param handler             Called with the payload sent by the server.
+     * @param callsDefaultHandler When true (default) the application-level
+     *                            keepaliveDidArrive fires first, then this
+     *                            handler. When false this handler fires alone
+     *                            and the default is suppressed for this request.
      */
-    didReceiveKeepalive(
+    addKeepaliveHandler(
         handler: (payload: CBSocketKeepalivePayload) => void,
-        extendsDefaultHandler?: boolean
+        callsDefaultHandler?: boolean
     ): CBSocketRequestPromise<T>
 }
 
@@ -142,12 +141,12 @@ export class CBSocketClient extends UIObject {
     /**
      * Application-level keepalive handler. Called for every keepalive frame
      * received on any request, unless the per-call handler was registered with
-     * extendsDefaultHandler = false.
+     * callsDefaultHandler = false.
      *
      * Configure once at application startup:
-     *   CBSocketClient.sharedInstance.defaultKeepaliveHandler = payload => { ... }
+     *   CBSocketClient.sharedInstance.keepaliveDidArrive = payload => { ... }
      */
-    defaultKeepaliveHandler?: (payload: CBSocketKeepalivePayload) => void
+    keepaliveDidArrive?: (payload: CBSocketKeepalivePayload) => void
     
     
     constructor(core: CBCore) {
@@ -490,15 +489,15 @@ export class CBSocketClient extends UIObject {
         
         const requestPromise = basePromise as CBSocketRequestPromise<any>
         
-        requestPromise.didReceiveKeepalive = (
+        requestPromise.addKeepaliveHandler = (
             handler: (payload: CBSocketKeepalivePayload) => void,
-            extendsDefaultHandler = YES
+            callsDefaultHandler = YES
         ): CBSocketRequestPromise<any> => {
             
             // The descriptor is pushed synchronously before _sendMessageForKey returns,
             // so capturedIdentifier is already set at this point.
             if (capturedIdentifier) {
-                this._attachKeepaliveHandlerForIdentifier(capturedIdentifier, handler, extendsDefaultHandler)
+                this._attachKeepaliveHandlerForRequestIdentifier(capturedIdentifier, handler, callsDefaultHandler)
             }
             
             return requestPromise
@@ -514,10 +513,10 @@ export class CBSocketClient extends UIObject {
      * Finds the descriptor for the given request identifier and attaches the
      * keepalive handler fields to it.
      */
-    _attachKeepaliveHandlerForIdentifier(
+    _attachKeepaliveHandlerForRequestIdentifier(
         identifier: string,
         handler: (payload: CBSocketKeepalivePayload) => void,
-        extendsDefaultHandler: boolean
+        callsDefaultHandler: boolean
     ) {
         
         const descriptorKey = this._callbackHolder.keysForIdentifiers[identifier]
@@ -536,7 +535,7 @@ export class CBSocketClient extends UIObject {
         }
         
         descriptor.keepaliveHandler = handler
-        descriptor.keepaliveHandlerOverridesDefault = !extendsDefaultHandler
+        descriptor.skipsDefaultKeepaliveHandler = !callsDefaultHandler
         
     }
     
@@ -780,7 +779,7 @@ export class CBSocketClient extends UIObject {
     
     addTargetForOneMessageForKey(key: string, handlerFunction: CBSocketMessageHandlerFunction) {
         
-        this._callbackHolder.registerOnetimeHandler(key, handlerFunction)
+        this._callbackHolder.registerOneTimeHandler(key, handlerFunction)
         
         if (IS_NOT(this._subscribedKeys[key])) {