connected-spaces-platform.web 6.3.0 → 6.4.0

package/connectedspacesplatform.ts

@@ -1623,6 +1623,14 @@ function csp_systems_TokenInfoParamsFactory(
 ProxyClassFactories["csp_systems_TokenInfoParams"] =
   csp_systems_TokenInfoParamsFactory;
 
+function csp_systems_TokenOptionsFactory(
+  nativePointer: NativePointer,
+): NativeClassWrapper {
+  return new Systems.TokenOptions(nativePointer);
+}
+ProxyClassFactories["csp_systems_TokenOptions"] =
+  csp_systems_TokenOptionsFactory;
+
 function csp_systems_BasicProfileFactory(
   nativePointer: NativePointer,
 ): NativeClassWrapper {
@@ -1989,6 +1997,14 @@ function csp_systems_HTTPHeadersResultFactory(
 ProxyClassFactories["csp_systems_HTTPHeadersResult"] =
   csp_systems_HTTPHeadersResultFactory;
 
+function csp_systems_AnalyticsSystemFactory(
+  nativePointer: NativePointer,
+): NativeClassWrapper {
+  return new Systems.AnalyticsSystem(nativePointer);
+}
+ProxyClassFactories["csp_systems_AnalyticsSystem"] =
+  csp_systems_AnalyticsSystemFactory;
+
 function csp_systems_AlphaVideoMaterialFactory(
   nativePointer: NativePointer,
 ): NativeClassWrapper {
@@ -23980,18 +23996,21 @@ export namespace Multiplayer {
     }
 
     /**
-     * @description Constructor for CSPSceneDescription by deserializing a SceneDescription json file.
-     * @param sceneDescriptionJson - The SceneDescription to deserialize.
+     * @description Constructor for CSPSceneDescription by deserializing a SceneDescription json file.  
+     * @param sceneDescriptionJson - The SceneDescription to parse.
+    @warning The expression of this interface as a list is a wrapper generator workaround, so
+     * whilst you may split your string into many elements, it is not advisable. You should prefer  
+     * inserting your entire string as the first, single, and only element of the list.  
      */
     static create_sceneDescriptionJson(
-      sceneDescriptionJson: string,
+      sceneDescriptionJson: Common.List<string>,
     ): CSPSceneDescription {
       var _ptr = Module._malloc(8);
       Module.ccall(
-        "csp_multiplayer_CSPSceneDescription_Ctor_StringRC",
+        "csp_multiplayer_CSPSceneDescription_Ctor_ListRC",
         "void",
-        ["number", "string"],
-        [_ptr, sceneDescriptionJson],
+        ["number", "number"],
+        [_ptr, sceneDescriptionJson.pointer],
       );
       var _nPtr = getNativePointer(_ptr);
 
@@ -26678,18 +26697,21 @@ export namespace Systems {
     }
 
     /**
-     * @description Constructor for CSPSceneData by deserializing a SceneDescription json file.
-     * @param sceneDescriptionJson - The SceneDescription to deserialize.
+     * @description Constructor for CSPSceneData by deserializing a SceneDescription json file.  
+     * @param sceneDescriptionJson - The SceneDescription to parse.
+    @warning The expression of this interface as a list is a wrapper generator workaround, so
+     * whilst you may split your string into many elements, it is not advisable. You should prefer  
+     * inserting your entire string as the first, single, and only element of the list.  
      */
     static create_sceneDescriptionJson(
-      sceneDescriptionJson: string,
+      sceneDescriptionJson: Common.List<string>,
     ): CSPSceneData {
       var _ptr = Module._malloc(8);
       Module.ccall(
-        "csp_systems_CSPSceneData_Ctor_StringRC",
+        "csp_systems_CSPSceneData_Ctor_ListRC",
         "void",
-        ["number", "string"],
-        [_ptr, sceneDescriptionJson],
+        ["number", "number"],
+        [_ptr, sceneDescriptionJson.pointer],
       );
       var _nPtr = getNativePointer(_ptr);
 
@@ -27544,6 +27566,26 @@ export namespace Systems {
       return _nPtr;
     }
 
+    /**
+     * @description Retrieves the AnalyticsSystem system.
+     * @return Pointer to the analyticssystem system class
+     */
+
+    getAnalyticsSystem(): Systems.AnalyticsSystem {
+      var _ret = Module._malloc(8);
+
+      Module.ccall(
+        "csp_systems_SystemsManager_GetAnalyticsSystem_AnalyticsSystemP",
+        "void",
+        ["number", "number"],
+        [_ret, this.pointer],
+      );
+      var _nPtr = new Systems.AnalyticsSystem(getNativePointer(_ret));
+      Module._free(_ret);
+
+      return _nPtr;
+    }
+
     getMultiplayerConnection(): Multiplayer.MultiplayerConnection {
       var _ret = Module._malloc(8);
 
@@ -34218,6 +34260,62 @@ export namespace Systems {
   }
 }
 
+export namespace Systems {
+  /**
+   * @description Data structure for overrides to the default token options
+   */
+  export class TokenOptions
+    extends NativeClassWrapper
+    implements INativeResource
+  {
+    /** @internal */
+    constructor(pointer: NativePointer) {
+      super(pointer);
+    }
+
+    static create(): TokenOptions {
+      var _ptr = Module._malloc(8);
+      Module.ccall("csp_systems_TokenOptions_Ctor", "void", ["number"], [_ptr]);
+      var _nPtr = getNativePointer(_ptr);
+
+      return new TokenOptions(_nPtr);
+    }
+
+    delete(): void {
+      if (this.ownsPointer && !this.disposed) {
+        Module.ccall(
+          "csp_systems_TokenOptions_Dtor",
+          "void",
+          ["number"],
+          [this.pointer],
+        );
+
+        this.disposed = true;
+      }
+    }
+
+    get expiryLength(): string {
+      let _result = Module.ccall(
+        "csp_systems_TokenOptions__Get_ExpiryLength",
+        "string",
+        ["number"],
+        [this.pointer],
+      );
+
+      return _result;
+    }
+
+    set expiryLength(value: string) {
+      Module.ccall(
+        "csp_systems_TokenOptions__Set_ExpiryLength",
+        "void",
+        ["number", "string"],
+        [this.pointer, value],
+      );
+    }
+  }
+}
+
 export namespace Systems {
   /**
    * @description A basic class abstraction for a user profile, including User Id and name, a display name, avatar information
@@ -48134,6 +48232,62 @@ export namespace Systems {
   }
 }
 
+export namespace Systems {
+  /**
+@ingroup Analytics System
+ * @description Public facing system that allows AnalyticsRecords to be sent to MCS.  
+ */
+  export class AnalyticsSystem extends Systems.SystemBase {
+    /** @internal */
+    constructor(pointer: NativePointer) {
+      super(pointer);
+    }
+
+    static fromSystemBase(
+      baseInstance: Systems.SystemBase,
+    ): Systems.AnalyticsSystem {
+      const nativeClassWrapper = baseInstance as unknown as NativeClassWrapper;
+      return new Systems.AnalyticsSystem(
+        new NativePointer(
+          nativeClassWrapper.pointer,
+          nativeClassWrapper.ownsPointer,
+        ),
+      );
+    }
+
+    sendAnalyticsEvent(
+      productContextSection: string,
+      category: string,
+      interactionType: string,
+      subCategory: string,
+      metadata: Common.Map<string, string>,
+      callback: (result: Systems.NullResult) => void,
+    ): void {
+      var _callback = (_stateObject__: number, result) => {
+        var _result = new Systems.NullResult(getNativePointer(result));
+        callback(_result);
+      };
+
+      var callbackPtr = Module.addFunction(_callback, "vii");
+
+      Module.ccall(
+        "csp_systems_AnalyticsSystem_SendAnalyticsEvent_void_StringRC_StringRC_StringRC_StringRC_MapRC_NullResultCallback",
+        "void",
+        ["number", "string", "string", "string", "string", "number", "number"],
+        [
+          this.pointer,
+          productContextSection,
+          category,
+          interactionType,
+          subCategory,
+          metadata.pointer,
+          callbackPtr,
+        ],
+      );
+    }
+  }
+}
+
 export namespace Systems {
   /**
 @ingroup Asset System
@@ -60651,7 +60805,7 @@ export namespace Systems {
 export namespace Systems {
   /**
 @ingroup User System
- * @description Public facing system that allows interfacing with Magnopus Connected Services' user service.  
+ * @description Public facing system that allows interfacing with Magnopus Cloud Services' user service.  
  * Offers methods for creating accounts, authenticating, and retrieving user profiles.  
  */
   export class UserSystem extends Systems.SystemBase {
@@ -60722,7 +60876,7 @@ export namespace Systems {
     }
 
     /**
-     * @description Log in to Magnopus Connected Services services using a username-password or email-password combination.  
+     * @description Log in to Magnopus Cloud Services services using a username-password or email-password combination.  
      * @param userName - Csp::common::string
      * @param email - Csp::common::string
      * @param password - Csp::common::string
@@ -60730,6 +60884,9 @@ export namespace Systems {
      * connection to backend services, and thus be unable to receive messages or events. This session will also be unable to enter online spaces via  
      * a csp::multiplayer::OnlineRealtimeEngine. If true, this session will receive events, and may enter both online and offline spaces.  
      * @param userHasVerifiedAge - An optional bool to specify whether or not the user has verified that they are over 18
+     * @param tokenOptions - Optional override for default token options.
+     * The default token expiry length is configured by MCS and defaults to 30 minutes. Value must be less than the default expiry length, or it will  
+     * be ignored.  
      * @param callback - Callback to call when a response is received
     @pre One of either UserName or Email must not be empty.
     @pre Password must not be empty.
@@ -60741,6 +60898,7 @@ export namespace Systems {
       password: string,
       createMultiplayerConnection: boolean,
       userHasVerifiedAge: boolean | null,
+      tokenOptions: Systems.TokenOptions | null,
     ): Promise<Systems.LoginStateResult> {
       var _resolve;
 
@@ -60775,7 +60933,7 @@ export namespace Systems {
       }
 
       Module.ccall(
-        "csp_systems_UserSystem_Login_void_StringRC_StringRC_StringRC_bool_boolRC_LoginStateResultCallback",
+        "csp_systems_UserSystem_Login_void_StringRC_StringRC_StringRC_bool_boolRC_TokenOptionsRC_LoginStateResultCallback",
         "void",
         [
           "number",
@@ -60786,6 +60944,7 @@ export namespace Systems {
           "boolean",
           "number",
           "number",
+          "number",
         ],
         [
           this.pointer,
@@ -60794,6 +60953,7 @@ export namespace Systems {
           password,
           createMultiplayerConnection,
           userHasVerifiedAgePointer,
+          tokenOptions != null ? tokenOptions.pointer : 0,
           _callbackPtr,
           0,
         ],
@@ -60814,6 +60974,9 @@ export namespace Systems {
      * @param createMultiplayerConnection - Whether to create a multiplayer connection. If false, this session will not establish a SignalR
      * connection to backend services, and thus be unable to receive messages or events. This session will also be unable to enter online spaces via  
      * a csp::multiplayer::OnlineRealtimeEngine. If true, this session will receive events, and may enter both online and offline spaces.  
+     * @param tokenOptions - Optional override for default token options.
+     * The default token expiry length is configured by MCS and defaults to 30 minutes. Value must be less than the default expiry length, or it will  
+     * be ignored.  
      * @param callback - Callback when asynchronous task finishes
     @pre UserId must not be empty.
      */
@@ -60822,6 +60985,7 @@ export namespace Systems {
       userId: string,
       refreshToken: string,
       createMultiplayerConnection: boolean,
+      tokenOptions: Systems.TokenOptions | null,
     ): Promise<Systems.LoginStateResult> {
       var _resolve;
 
@@ -60846,14 +61010,15 @@ export namespace Systems {
       _callbackPtr = Module.addFunction(_callback, "vii");
 
       Module.ccall(
-        "csp_systems_UserSystem_LoginWithRefreshToken_void_StringRC_StringRC_bool_LoginStateResultCallback",
+        "csp_systems_UserSystem_LoginWithRefreshToken_void_StringRC_StringRC_bool_TokenOptionsRC_LoginStateResultCallback",
         "void",
-        ["number", "string", "string", "boolean", "number", "number"],
+        ["number", "string", "string", "boolean", "number", "number", "number"],
         [
           this.pointer,
           userId,
           refreshToken,
           createMultiplayerConnection,
+          tokenOptions != null ? tokenOptions.pointer : 0,
           _callbackPtr,
           0,
         ],
@@ -60863,17 +61028,21 @@ export namespace Systems {
     }
 
     /**
-     * @description Log in to Magnopus Connected Services as a guest.
+     * @description Log in to Magnopus Cloud Services as a guest.
      * @param createMultiplayerConnection - Whether to create a multiplayer connection. If false, this session will not establish a SignalR
      * connection to backend services, and thus be unable to receive messages or events. This session will also be unable to enter online spaces via
      * a csp::multiplayer::OnlineRealtimeEngine. If true, this session will receive events, and may enter both online and offline spaces.
      * @param userHasVerifiedAge - An optional bool to specify whether or not the user has verified that they are over 18
+     * @param tokenOptions - Optional override for default token options.
+     * The default token expiry length is configured by MCS and defaults to 30 minutes. Value must be less than the default expiry length, or it will
+     * be ignored.
      * @param callback - Callback to call when a response is received
      */
 
     async loginAsGuest(
       createMultiplayerConnection: boolean,
       userHasVerifiedAge: boolean | null,
+      tokenOptions: Systems.TokenOptions | null,
     ): Promise<Systems.LoginStateResult> {
       var _resolve;
 
@@ -60908,13 +61077,14 @@ export namespace Systems {
       }
 
       Module.ccall(
-        "csp_systems_UserSystem_LoginAsGuest_void_bool_boolRC_LoginStateResultCallback",
+        "csp_systems_UserSystem_LoginAsGuest_void_bool_boolRC_TokenOptionsRC_LoginStateResultCallback",
         "void",
-        ["number", "boolean", "boolean", "number", "number"],
+        ["number", "boolean", "boolean", "number", "number", "number"],
         [
           this.pointer,
           createMultiplayerConnection,
           userHasVerifiedAgePointer,
+          tokenOptions != null ? tokenOptions.pointer : 0,
           _callbackPtr,
           0,
         ],
@@ -60927,6 +61097,67 @@ export namespace Systems {
       return _promise;
     }
 
+    /**
+     * @description Log in to Magnopus Cloud Services as a guest, allowing the backend to defer profile creation and perform other optimizations.  
+     * This login method is intended only for use with offline realtime engines, and as such does not start a multiplayer connection.  
+    @warning Unless you have a good reason, you should prefer the regular LoginAsGuest function. This method is designed for specific
+     * non-multiplayer cases where the backend services are expecting a huge amount of anonymous profiles and wish to be allowed to buffer profile  
+     * creation. For this reason, there is an undefined delay after calling this function until the session can be thought to be conceptually "logged  
+     * in". Beware if you are calling user system methods after having logged in using this method. If you find yourself doing that, you may wish to  
+     * use the regular LoginAsGuest method instead.  
+     * @param userHasVerifiedAge - An optional bool to specify whether or not the user has verified that they are over 18
+     * @param callback - Callback to call when a response is received
+     */
+
+    async loginAsGuestWithDeferredProfileCreation(
+      userHasVerifiedAge: boolean | null,
+    ): Promise<Systems.LoginStateResult> {
+      var _resolve;
+
+      var _promise = new Promise<Systems.LoginStateResult>((_r) => {
+        _resolve = _r;
+      });
+
+      var _callbackPtr: number;
+      var _callback = (_stateObject__: number, result) => {
+        var _resultPtr = getNativePointer(result);
+        var _resultInstance = new Systems.LoginStateResult(_resultPtr);
+
+        if (_resultInstance.getResultCode() == Systems.EResultCode.InProgress) {
+          return;
+        }
+
+        _resolve(_resultInstance);
+
+        Module.removeFunction(_callbackPtr);
+      };
+
+      _callbackPtr = Module.addFunction(_callback, "vii");
+
+      var userHasVerifiedAgePointer = 0;
+      if (userHasVerifiedAge != null) {
+        userHasVerifiedAgePointer = Module._malloc(4);
+        Module.setValue(
+          userHasVerifiedAgePointer,
+          userHasVerifiedAge ? 1 : 0,
+          "i32",
+        );
+      }
+
+      Module.ccall(
+        "csp_systems_UserSystem_LoginAsGuestWithDeferredProfileCreation_void_boolRC_LoginStateResultCallback",
+        "void",
+        ["number", "boolean", "number", "number"],
+        [this.pointer, userHasVerifiedAgePointer, _callbackPtr, 0],
+      );
+
+      if (userHasVerifiedAgePointer) {
+        Module._free(userHasVerifiedAgePointer);
+      }
+
+      return _promise;
+    }
+
     /**
     @ingroup Third Party Authentication
      * @description As a Connected Spaces Platform user the 3rd party authentication flow consists of two steps, first calling  
@@ -61009,7 +61240,10 @@ export namespace Systems {
      * connection to backend services, and thus be unable to receive messages or events. This session will also be unable to enter online spaces via
      * a csp::multiplayer::OnlineRealtimeEngine. If true, this session will receive events, and may enter both online and offline spaces.
      * @param userHasVerifiedAge - An optional bool to specify whether or not the user has verified that they are over 18
-     * @param callback - Callback that contains the result of the magnopus connected services authentication operation
+     * @param tokenOptions - Optional override for default token options.
+     * The default token expiry length is configured by MCS and defaults to 30 minutes. Value must be less than the default expiry length, or it will
+     * be ignored.
+     * @param callback - Callback that contains the result of the magnopus cloud services authentication operation
      */
 
     async loginToThirdPartyAuthenticationProvider(
@@ -61017,6 +61251,7 @@ export namespace Systems {
       thirdPartyStateId: string,
       createMultiplayerConnection: boolean,
       userHasVerifiedAge: boolean | null,
+      tokenOptions: Systems.TokenOptions | null,
     ): Promise<Systems.LoginStateResult> {
       var _resolve;
 
@@ -61051,7 +61286,7 @@ export namespace Systems {
       }
 
       Module.ccall(
-        "csp_systems_UserSystem_LoginToThirdPartyAuthenticationProvider_void_StringRC_StringRC_bool_boolRC_LoginStateResultCallback",
+        "csp_systems_UserSystem_LoginToThirdPartyAuthenticationProvider_void_StringRC_StringRC_bool_boolRC_TokenOptionsRC_LoginStateResultCallback",
         "void",
         [
           "number",
@@ -61061,6 +61296,7 @@ export namespace Systems {
           "boolean",
           "number",
           "number",
+          "number",
         ],
         [
           this.pointer,
@@ -61068,6 +61304,7 @@ export namespace Systems {
           thirdPartyStateId,
           createMultiplayerConnection,
           userHasVerifiedAgePointer,
+          tokenOptions != null ? tokenOptions.pointer : 0,
           _callbackPtr,
           0,
         ],
@@ -61081,7 +61318,7 @@ export namespace Systems {
     }
 
     /**
-     * @description Logout from Magnopus Connected Services.
+     * @description Logout from Magnopus Cloud Services.
      * @param callback - Callback to call when a response is received
      */
 
@@ -61124,7 +61361,7 @@ export namespace Systems {
      * @param displayName - User display name associated with the new profile
      * @param email - Email address associated with the new profile
      * @param password - Password associated with the new profile
-     * @param receiveNewsletter - `true` if the user wants to receive the Magnopus Connected Services newsletter
+     * @param receiveNewsletter - `true` if the user wants to receive the Magnopus Cloud Services newsletter
      * @param userHasVerifiedAge - An optional bool to specify whether or not the user has verified that they are over 18
      * @param redirectUrl - The url to redirect the user to after they have registered
      * @param inviteToken - A token provided to the user that can be used to auto-confirm their account
@@ -61584,7 +61821,7 @@ export namespace Systems {
     }
 
     /**
-     * @description Ping Magnopus Connected Services
+     * @description Ping Magnopus Cloud Services
      * @param callback - Callback to call when a response is received
      */
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "connected-spaces-platform.web",
   "displayName": "connected-spaces-platform.web",
-  "version": "6.3.0+611",
+  "version": "6.4.0+612",
   "description": "This package provides the binaries required to interface with the Connected Spaces Platform API.",
   "license": "Apache-2.0",
   "dependencies": {