connected-spaces-platform.web 5.10.0 → 5.12.0

package/connectedspacesplatform.d.ts

@@ -1762,6 +1762,12 @@ export declare class CSPFoundation {
      * @return The EndpointURIs class with current endpoint data
      */
     static getEndpoints(): EndpointURIs;
+    /**
+     * @description Create an EndpointsURIs object containing URIs to the various services needed by CSP.
+     * @param endpointRootURI - URI to the root of the cloud services.
+     * @return EndpointURIs class with deduced endpoint URIs.
+     */
+    static createEndpointsFromRoot(endpointRootURI: string): EndpointURIs;
     /**
      * @description Sets a class containing all relevant Client info currently set for Foundation.
      * Used internally to generate ClientUserAgentString.
@@ -4575,13 +4581,6 @@ export declare namespace Multiplayer {
          * @return The id of the leader.
          */
         getLeaderId(): bigint;
-        /**
-         * @description Finds a component by the given id.
-         * /// Searchs through all components of all entites so should be used sparingly.
-         * /// @param Id The id of the component to find.
-         * @return A pointer to the found component which can be nullptr if the component is not found.
-         */
-        findComponentById(id: number): Multiplayer.ComponentBase;
         /**
          * @description Retrieve the state of the patch rate limiter. If true, patches are limited for each individual entity to a fixed rate.
          * @return True if enabled, false otherwise.
@@ -6139,6 +6138,25 @@ export declare namespace Systems {
         set shareScreen(value: boolean);
     }
 }
+export declare namespace Systems {
+    /**
+     * @description Data structure for a custom service proxy posting, giving service name, operation name, set help and parameters
+     */
+    class TokenInfoParams extends NativeClassWrapper implements INativeResource {
+        /** @internal */
+        constructor(pointer: NativePointer);
+        static create(): TokenInfoParams;
+        delete(): void;
+        get serviceName(): string;
+        set serviceName(value: string);
+        get operationName(): string;
+        set operationName(value: string);
+        get setHelp(): boolean;
+        set setHelp(value: boolean);
+        get parameters(): Common.Map<string, string>;
+        set parameters(value: Common.Map<string, string>);
+    }
+}
 export declare namespace Systems {
     /**
      * @description A basic class abstraction for a user profile, including User Id and name, a display name, avatar information
@@ -6157,8 +6175,6 @@ export declare namespace Systems {
         set displayName(value: string);
         get avatarId(): string;
         set avatarId(value: string);
-        get lastPlatform(): string;
-        set lastPlatform(value: string);
     }
 }
 export declare namespace Systems {
@@ -9032,14 +9048,6 @@ export declare namespace Multiplayer {
          * @param value - The type of video source used by this component.
          */
         setVideoPlayerSourceType(value: Multiplayer.VideoPlayerSourceType): void;
-        /**
-         * @description Gets the Id of the mesh component that the video should be rendered to
-         */
-        getMeshComponentId(): number;
-        /**
-         * @description Sets the Id of the mesh component that the video should be rendered to
-         */
-        setMeshComponentId(id: number): void;
         /**
          * \addtogroup IVisibleComponent
         @{
@@ -11712,6 +11720,8 @@ export declare namespace Systems {
          * @param password - Csp::common::string
          * @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
+        @pre One of either UserName or Email must not be empty.
+        @pre Password must not be empty.
          */
         login(userName: string, email: string, password: string, userHasVerifiedAge: boolean | null): Promise<Systems.LoginStateResult>;
         /**
@@ -11720,6 +11730,7 @@ export declare namespace Systems {
          * @param userId - User ID for the previous session
          * @param refreshToken - Refresh token to be used for refreshing the authentication token
          * @param callback - Callback when asynchronous task finishes
+        @pre UserId must not be empty.
          */
         loginWithRefreshToken(userId: string, refreshToken: string): Promise<Systems.LoginStateResult>;
         /**
@@ -11845,6 +11856,12 @@ export declare namespace Systems {
          * @param callback - Callback to call when a response is received
          */
         getAgoraUserToken(params: Systems.AgoraUserTokenParams): Promise<Systems.StringResult>;
+        /**
+         * @description Post Service Proxy to perform specified operation of specified service
+         * @param params - Params to specify service, operation, set help and parameters
+         * @param callback - Callback to call when a response is received
+         */
+        postServiceProxy(params: Systems.TokenInfoParams): Promise<Systems.StringResult>;
         /**
          * @description Re-send user verification email
          * @param inEmail - User's email address

package/connectedspacesplatform.js

@@ -992,6 +992,11 @@ function csp_systems_AgoraUserTokenParamsFactory(nativePointer) {
 }
 ProxyClassFactories["csp_systems_AgoraUserTokenParams"] =
     csp_systems_AgoraUserTokenParamsFactory;
+function csp_systems_TokenInfoParamsFactory(nativePointer) {
+    return new Systems.TokenInfoParams(nativePointer);
+}
+ProxyClassFactories["csp_systems_TokenInfoParams"] =
+    csp_systems_TokenInfoParamsFactory;
 function csp_systems_BasicProfileFactory(nativePointer) {
     return new Systems.BasicProfile(nativePointer);
 }
@@ -3224,6 +3229,18 @@ export class CSPFoundation {
         Module._free(_ret);
         return _nPtr;
     }
+    /**
+     * @description Create an EndpointsURIs object containing URIs to the various services needed by CSP.
+     * @param endpointRootURI - URI to the root of the cloud services.
+     * @return EndpointURIs class with deduced endpoint URIs.
+     */
+    static createEndpointsFromRoot(endpointRootURI) {
+        var _ret = Module._malloc(8);
+        Module.ccall("csp_CSPFoundation_CreateEndpointsFromRoot_EndpointURIs_StringRC", "void", ["number", "string"], [_ret, endpointRootURI]);
+        var _nPtr = new EndpointURIs(getNativePointer(_ret));
+        Module._free(_ret);
+        return _nPtr;
+    }
     /**
      * @description Sets a class containing all relevant Client info currently set for Foundation.
      * Used internally to generate ClientUserAgentString.
@@ -11096,22 +11113,6 @@ export class CSPFoundation {
             _result = _fixedValue;
             return _result;
         }
-        /**
-         * @description Finds a component by the given id.
-         * /// Searchs through all components of all entites so should be used sparingly.
-         * /// @param Id The id of the component to find.
-         * @return A pointer to the found component which can be nullptr if the component is not found.
-         */
-        findComponentById(id) {
-            assert(Number.isInteger(id));
-            assert(id >= Limits.UINT16_MIN);
-            assert(id <= Limits.UINT16_MAX);
-            var _ret = Module._malloc(8);
-            Module.ccall("csp_multiplayer_SpaceEntitySystem_FindComponentById_ComponentBaseP_uint16_t", "void", ["number", "number", "number"], [_ret, this.pointer, id]);
-            var _nPtr = new Multiplayer.ComponentBase(getNativePointer(_ret));
-            Module._free(_ret);
-            return _nPtr;
-        }
         /**
          * @description Retrieve the state of the patch rate limiter. If true, patches are limited for each individual entity to a fixed rate.
          * @return True if enabled, false otherwise.
@@ -14909,6 +14910,60 @@ export class CSPFoundation {
     }
     Systems.AgoraUserTokenParams = AgoraUserTokenParams;
 })(Systems || (Systems = {}));
+(function (Systems) {
+    /**
+     * @description Data structure for a custom service proxy posting, giving service name, operation name, set help and parameters
+     */
+    class TokenInfoParams extends NativeClassWrapper {
+        /** @internal */
+        constructor(pointer) {
+            super(pointer);
+        }
+        static create() {
+            var _ptr = Module._malloc(8);
+            Module.ccall("csp_systems_TokenInfoParams_Ctor", "void", ["number"], [_ptr]);
+            var _nPtr = getNativePointer(_ptr);
+            return new TokenInfoParams(_nPtr);
+        }
+        delete() {
+            if (this.ownsPointer && !this.disposed) {
+                Module.ccall("csp_systems_TokenInfoParams_Dtor", "void", ["number"], [this.pointer]);
+                this.disposed = true;
+            }
+        }
+        get serviceName() {
+            let _result = Module.ccall("csp_systems_TokenInfoParams__Get_ServiceName", "string", ["number"], [this.pointer]);
+            return _result;
+        }
+        set serviceName(value) {
+            Module.ccall("csp_systems_TokenInfoParams__Set_ServiceName", "void", ["number", "string"], [this.pointer, value]);
+        }
+        get operationName() {
+            let _result = Module.ccall("csp_systems_TokenInfoParams__Get_OperationName", "string", ["number"], [this.pointer]);
+            return _result;
+        }
+        set operationName(value) {
+            Module.ccall("csp_systems_TokenInfoParams__Set_OperationName", "void", ["number", "string"], [this.pointer, value]);
+        }
+        get setHelp() {
+            let _result = Module.ccall("csp_systems_TokenInfoParams__Get_SetHelp", "boolean", ["number"], [this.pointer]);
+            return _result;
+        }
+        set setHelp(value) {
+            Module.ccall("csp_systems_TokenInfoParams__Set_SetHelp", "void", ["number", "boolean"], [this.pointer, value]);
+        }
+        get parameters() {
+            const _ptr = Module._malloc(8);
+            Module.ccall("csp_systems_TokenInfoParams__Get_Parameters", "void", ["number", "number"], [_ptr, this.pointer]);
+            const _nPtr = getNativePointer(_ptr);
+            return new Common.Map(_nPtr, StringFactory, "String", StringFactory, "String");
+        }
+        set parameters(value) {
+            Module.ccall("csp_systems_TokenInfoParams__Set_Parameters", "void", ["number", "number"], [this.pointer, value.pointer]);
+        }
+    }
+    Systems.TokenInfoParams = TokenInfoParams;
+})(Systems || (Systems = {}));
 (function (Systems) {
     /**
      * @description A basic class abstraction for a user profile, including User Id and name, a display name, avatar information
@@ -14959,13 +15014,6 @@ export class CSPFoundation {
         set avatarId(value) {
             Module.ccall("csp_systems_BasicProfile__Set_AvatarId", "void", ["number", "string"], [this.pointer, value]);
         }
-        get lastPlatform() {
-            let _result = Module.ccall("csp_systems_BasicProfile__Get_LastPlatform", "string", ["number"], [this.pointer]);
-            return _result;
-        }
-        set lastPlatform(value) {
-            Module.ccall("csp_systems_BasicProfile__Set_LastPlatform", "void", ["number", "string"], [this.pointer, value]);
-        }
     }
     Systems.BasicProfile = BasicProfile;
 })(Systems || (Systems = {}));
@@ -20033,25 +20081,6 @@ export class CSPFoundation {
         setVideoPlayerSourceType(value) {
             Module.ccall("csp_multiplayer_VideoPlayerSpaceComponent_SetVideoPlayerSourceType_void_VideoPlayerSourceType", "void", ["number", "number"], [this.pointer, value]);
         }
-        /**
-         * @description Gets the Id of the mesh component that the video should be rendered to
-         */
-        getMeshComponentId() {
-            let _result = Module.ccall("csp_multiplayer_VideoPlayerSpaceComponent_GetMeshComponentIdC_uint16_t", "number", ["number"], [this.pointer]);
-            const _unfixedValue = _result;
-            let _fixedValue = _unfixedValue < 0 ? _unfixedValue + 2 ** 16 : _unfixedValue;
-            _result = _fixedValue;
-            return _result;
-        }
-        /**
-         * @description Sets the Id of the mesh component that the video should be rendered to
-         */
-        setMeshComponentId(id) {
-            assert(Number.isInteger(id));
-            assert(id >= Limits.UINT16_MIN);
-            assert(id <= Limits.UINT16_MAX);
-            Module.ccall("csp_multiplayer_VideoPlayerSpaceComponent_SetMeshComponentId_void_uint16_t", "void", ["number", "number"], [this.pointer, id]);
-        }
         /**
          * \addtogroup IVisibleComponent
         @{
@@ -27628,6 +27657,8 @@ export class CSPFoundation {
          * @param password - Csp::common::string
          * @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
+        @pre One of either UserName or Email must not be empty.
+        @pre Password must not be empty.
          */
         async login(userName, email, password, userHasVerifiedAge) {
             var _resolve;
@@ -27670,6 +27701,7 @@ export class CSPFoundation {
          * @param userId - User ID for the previous session
          * @param refreshToken - Refresh token to be used for refreshing the authentication token
          * @param callback - Callback when asynchronous task finishes
+        @pre UserId must not be empty.
          */
         async loginWithRefreshToken(userId, refreshToken) {
             var _resolve;
@@ -28162,6 +28194,30 @@ export class CSPFoundation {
             Module.ccall("csp_systems_UserSystem_GetAgoraUserToken_void_AgoraUserTokenParamsRC_StringResultCallback", "void", ["number", "number", "number", "number"], [this.pointer, params.pointer, _callbackPtr, 0]);
             return _promise;
         }
+        /**
+         * @description Post Service Proxy to perform specified operation of specified service
+         * @param params - Params to specify service, operation, set help and parameters
+         * @param callback - Callback to call when a response is received
+         */
+        async postServiceProxy(params) {
+            var _resolve;
+            var _promise = new Promise((_r) => {
+                _resolve = _r;
+            });
+            var _callbackPtr;
+            var _callback = (_stateObject__, result) => {
+                var _resultPtr = getNativePointer(result);
+                var _resultInstance = new Systems.StringResult(_resultPtr);
+                if (_resultInstance.getResultCode() == Systems.EResultCode.InProgress) {
+                    return;
+                }
+                _resolve(_resultInstance);
+                Module.removeFunction(_callbackPtr);
+            };
+            _callbackPtr = Module.addFunction(_callback, "vii");
+            Module.ccall("csp_systems_UserSystem_PostServiceProxy_void_TokenInfoParamsRC_StringResultCallback", "void", ["number", "number", "number", "number"], [this.pointer, params.pointer, _callbackPtr, 0]);
+            return _promise;
+        }
         /**
          * @description Re-send user verification email
          * @param inEmail - User's email address