@xmobitea/gn-typescript-client 2.6.13 → 2.6.14

package/dist/runtime/entity/models/CloudScriptRequestModels.d.ts

@@ -2,75 +2,182 @@ import { RequestRole } from "./../../constant/enumType/RequestRole";
 import { RequestType } from "./../../constant/enumType/RequestType";
 import { CustomOperationRequestAbstract } from "./../request/CustomOperationRequest";
 import { CloudScriptModels } from "./CloudScriptModels";
+/**
+ * Typed request wrappers for the CloudScript domain.
+ *
+ * Each class extends {@link CustomOperationRequestAbstract} and
+ * binds a typed `*RequestData` DTO from
+ * {@link CloudScriptModels} to:
+ * - the matching {@link OperationCode};
+ * - the {@link RequestType.CloudScript} domain;
+ * - the appropriate {@link RequestRole} based on the wrapper
+ *   name prefix.
+ *
+ * Both execution wrappers (`ExecuteFunction*`) and management
+ * wrappers (`AddFunction*`, `SetFunction*`, etc.) share the
+ * same {@link RequestType.CloudScript} value — they are
+ * distinguished only by their operation code and required
+ * role.
+ */
 export declare namespace CloudScriptRequestModels {
+    /**
+     * Maps the AddFunction operation to a typed request wrapper.
+     */
     class AddFunctionOperationRequest extends CustomOperationRequestAbstract<CloudScriptModels.AddFunctionRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new AddFunctionOperationRequest instance.
+         */
         constructor(requestData: CloudScriptModels.AddFunctionRequestData, timeout: number);
     }
+    /**
+     * Maps the ServerAddFunction operation to a typed request wrapper.
+     */
     class ServerAddFunctionOperationRequest extends AddFunctionOperationRequest {
         protected role: RequestRole;
+        /**
+         * Creates a new ServerAddFunctionOperationRequest instance.
+         */
         constructor(requestData: CloudScriptModels.ServerAddFunctionRequestData, timeout: number);
     }
+    /**
+     * Maps the AdminAddFunction operation to a typed request wrapper.
+     */
     class AdminAddFunctionOperationRequest extends AddFunctionOperationRequest {
         protected role: RequestRole;
+        /**
+         * Creates a new AdminAddFunctionOperationRequest instance.
+         */
         constructor(requestData: CloudScriptModels.AdminAddFunctionRequestData, timeout: number);
     }
+    /**
+     * Maps the EditFunction operation to a typed request wrapper.
+     */
     class EditFunctionOperationRequest extends CustomOperationRequestAbstract<CloudScriptModels.EditFunctionRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new EditFunctionOperationRequest instance.
+         */
         constructor(requestData: CloudScriptModels.EditFunctionRequestData, timeout: number);
     }
+    /**
+     * Maps the ServerEditFunction operation to a typed request wrapper.
+     */
     class ServerEditFunctionOperationRequest extends EditFunctionOperationRequest {
         protected role: RequestRole;
+        /**
+         * Creates a new ServerEditFunctionOperationRequest instance.
+         */
         constructor(requestData: CloudScriptModels.ServerEditFunctionRequestData, timeout: number);
     }
+    /**
+     * Maps the AdminEditFunction operation to a typed request wrapper.
+     */
     class AdminEditFunctionOperationRequest extends EditFunctionOperationRequest {
         protected role: RequestRole;
+        /**
+         * Creates a new AdminEditFunctionOperationRequest instance.
+         */
         constructor(requestData: CloudScriptModels.AdminEditFunctionRequestData, timeout: number);
     }
+    /**
+     * Maps the ExecuteFunction operation to a typed request wrapper.
+     */
     class ExecuteFunctionOperationRequest extends CustomOperationRequestAbstract<CloudScriptModels.ExecuteFunctionRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new ExecuteFunctionOperationRequest instance.
+         */
         constructor(requestData: CloudScriptModels.ExecuteFunctionRequestData, timeout: number);
     }
+    /**
+     * Maps the ServerExecuteFunction operation to a typed request wrapper.
+     */
     class ServerExecuteFunctionOperationRequest extends ExecuteFunctionOperationRequest {
         protected role: RequestRole;
+        /**
+         * Creates a new ServerExecuteFunctionOperationRequest instance.
+         */
         constructor(requestData: CloudScriptModels.ServerExecuteFunctionRequestData, timeout: number);
     }
+    /**
+     * Maps the AdminExecuteFunction operation to a typed request wrapper.
+     */
     class AdminExecuteFunctionOperationRequest extends ExecuteFunctionOperationRequest {
         protected role: RequestRole;
+        /**
+         * Creates a new AdminExecuteFunctionOperationRequest instance.
+         */
         constructor(requestData: CloudScriptModels.AdminExecuteFunctionRequestData, timeout: number);
     }
+    /**
+     * Maps the GetFunction operation to a typed request wrapper.
+     */
     class GetFunctionOperationRequest extends CustomOperationRequestAbstract<CloudScriptModels.GetFunctionRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new GetFunctionOperationRequest instance.
+         */
         constructor(requestData: CloudScriptModels.GetFunctionRequestData, timeout: number);
     }
+    /**
+     * Maps the ServerGetFunction operation to a typed request wrapper.
+     */
     class ServerGetFunctionOperationRequest extends GetFunctionOperationRequest {
         protected role: RequestRole;
+        /**
+         * Creates a new ServerGetFunctionOperationRequest instance.
+         */
         constructor(requestData: CloudScriptModels.ServerGetFunctionRequestData, timeout: number);
     }
+    /**
+     * Maps the AdminGetFunction operation to a typed request wrapper.
+     */
     class AdminGetFunctionOperationRequest extends GetFunctionOperationRequest {
         protected role: RequestRole;
+        /**
+         * Creates a new AdminGetFunctionOperationRequest instance.
+         */
         constructor(requestData: CloudScriptModels.AdminGetFunctionRequestData, timeout: number);
     }
+    /**
+     * Maps the GetFunctions operation to a typed request wrapper.
+     */
     class GetFunctionsOperationRequest extends CustomOperationRequestAbstract<CloudScriptModels.GetFunctionsRequestData> {
         protected operationCode: string;
         protected requestType: RequestType;
         protected role: RequestRole;
+        /**
+         * Creates a new GetFunctionsOperationRequest instance.
+         */
         constructor(requestData: CloudScriptModels.GetFunctionsRequestData, timeout: number);
     }
+    /**
+     * Maps the ServerGetFunctions operation to a typed request wrapper.
+     */
     class ServerGetFunctionsOperationRequest extends GetFunctionsOperationRequest {
         protected role: RequestRole;
+        /**
+         * Creates a new ServerGetFunctionsOperationRequest instance.
+         */
         constructor(requestData: CloudScriptModels.ServerGetFunctionsRequestData, timeout: number);
     }
+    /**
+     * Maps the AdminGetFunctions operation to a typed request wrapper.
+     */
     class AdminGetFunctionsOperationRequest extends GetFunctionsOperationRequest {
         protected role: RequestRole;
+        /**
+         * Creates a new AdminGetFunctionsOperationRequest instance.
+         */
         constructor(requestData: CloudScriptModels.AdminGetFunctionsRequestData, timeout: number);
     }
 }

package/dist/runtime/entity/models/CloudScriptResponseModels.d.ts

@@ -1,19 +1,65 @@
 import { CustomOperationResponseAbstract } from "./../response/CustomOperationResponse";
 import { CloudScriptModels } from "./CloudScriptModels";
+/**
+ * Typed response wrappers for the CloudScript domain.
+ *
+ * Each class extends {@link CustomOperationResponseAbstract}
+ * and binds a response DTO from {@link CloudScriptModels}.
+ *
+ * - **Execute flows** return the function result plus runtime
+ *   telemetry: execution time, memory used, log lines emitted
+ *   by the script, and an {@link ExecuteResponseStatus}
+ *   discriminator describing the outcome
+ *   (`Ok` / `Exception` / `FunctionNameNotFound` /
+ *   `VersionInvalid` / `Timeout`).
+ * - **Management flows** return version metadata and any
+ *   validation feedback the backend produced when accepting
+ *   the new function source.
+ */
 export declare namespace CloudScriptResponseModels {
+    /**
+     * Maps the AddFunction operation to a typed response wrapper.
+     */
     class AddFunctionOperationResponse extends CustomOperationResponseAbstract<CloudScriptModels.AddFunctionResponseData> {
+        /**
+         * Creates a new AddFunctionOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the EditFunction operation to a typed response wrapper.
+     */
     class EditFunctionOperationResponse extends CustomOperationResponseAbstract<CloudScriptModels.EditFunctionResponseData> {
+        /**
+         * Creates a new EditFunctionOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the ExecuteFunction operation to a typed response wrapper.
+     */
     class ExecuteFunctionOperationResponse extends CustomOperationResponseAbstract<CloudScriptModels.ExecuteFunctionResponseData> {
+        /**
+         * Creates a new ExecuteFunctionOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetFunction operation to a typed response wrapper.
+     */
     class GetFunctionOperationResponse extends CustomOperationResponseAbstract<CloudScriptModels.GetFunctionResponseData> {
+        /**
+         * Creates a new GetFunctionOperationResponse instance.
+         */
         constructor();
     }
+    /**
+     * Maps the GetFunctions operation to a typed response wrapper.
+     */
     class GetFunctionsOperationResponse extends CustomOperationResponseAbstract<CloudScriptModels.GetFunctionsResponseData> {
+        /**
+         * Creates a new GetFunctionsOperationResponse instance.
+         */
         constructor();
     }
 }

package/dist/runtime/entity/models/ContentModels.d.ts

@@ -1,87 +1,211 @@
 import { GNHashtable } from "./../../common/GNData";
 import { GenericModels } from "./GenericModels";
+/**
+ * Reusable request and response DTOs for the Content domain.
+ *
+ * The Content domain manages two distinct kinds of content:
+ *
+ * 1. **`contentData` blobs** — small structured values keyed by
+ *    a content key (`ContentDataParam.key`, `minLength: 2,
+ *    maxLength: 32, mustNonNull: true`). Useful for game-wide
+ *    config, MOTD strings, remote config flags. Manipulated via
+ *    `getContentData` / `setContentData`.
+ *
+ * 2. **File uploads** — binary blobs identified by a `fileId`.
+ *    The typed operations only manage the **metadata** slot;
+ *    the actual byte transfer happens through
+ *    {@link GNNetwork.uploadFile} (push) and
+ *    {@link GNNetwork.getDownloadFileUrl} (pull). The standard
+ *    workflow is:
+ *
+ *    ```
+ *    create upload info  → returns fileId + upload token
+ *      ↓
+ *    GNNetwork.uploadFile (out of band, multipart POST)
+ *      ↓
+ *    request download info → returns short-lived download token
+ *      ↓
+ *    GNNetwork.getDownloadFileUrl (out of band, plain GET)
+ *    ```
+ *
+ * Each request DTO has three role variants
+ * (`Client*`, `Server*`, `Admin*`) corresponding to the matching
+ * sub-namespace on `GNNetwork.content`. Server / Admin variants
+ * usually accept additional `userId` / `ownerId` parameters so
+ * trusted callers can act on behalf of any player.
+ */
 export declare namespace ContentModels {
+    /**
+     * Defines the reusable parameter block ContentDataParam.
+     */
     class ContentDataParam {
         key: string;
         data: GNHashtable;
     }
+    /**
+     * Allocates a new upload slot before the binary payload is uploaded through the separate upload helper.
+     */
     class CreateNewFileUploadInfoRequestData {
         fileName: string;
     }
+    /**
+     * Defines the request payload for ServerCreateNewFileUploadInfo.
+     */
     class ServerCreateNewFileUploadInfoRequestData extends CreateNewFileUploadInfoRequestData {
     }
+    /**
+     * Defines the request payload for AdminCreateNewFileUploadInfo.
+     */
     class AdminCreateNewFileUploadInfoRequestData extends ServerCreateNewFileUploadInfoRequestData {
     }
+    /**
+     * Reads content configuration blobs, optionally filtered by key list and label.
+     */
     class GetContentDataRequestData {
         keys?: Array<string>;
         label?: string;
     }
+    /**
+     * Defines the request payload for ServerGetContentData.
+     */
     class ServerGetContentDataRequestData extends GetContentDataRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetContentData.
+     */
     class AdminGetContentDataRequestData extends ServerGetContentDataRequestData {
     }
+    /**
+     * Defines the request payload for GetFileUploadInfoList.
+     */
     class GetFileUploadInfoListRequestData {
         skip?: number;
         limit?: number;
     }
+    /**
+     * Defines the request payload for ServerGetFileUploadInfoList.
+     */
     class ServerGetFileUploadInfoListRequestData extends GetFileUploadInfoListRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetFileUploadInfoList.
+     */
     class AdminGetFileUploadInfoListRequestData extends ServerGetFileUploadInfoListRequestData {
     }
+    /**
+     * Defines the request payload for GetFileUploadInfo.
+     */
     class GetFileUploadInfoRequestData {
         fileId: string;
     }
+    /**
+     * Defines the request payload for ServerGetFileUploadInfo.
+     */
     class ServerGetFileUploadInfoRequestData extends GetFileUploadInfoRequestData {
     }
+    /**
+     * Defines the request payload for AdminGetFileUploadInfo.
+     */
     class AdminGetFileUploadInfoRequestData extends ServerGetFileUploadInfoRequestData {
     }
+    /**
+     * Defines the request payload for RemoveFileUploadInfo.
+     */
     class RemoveFileUploadInfoRequestData {
         fileId: string;
         reason?: string;
     }
+    /**
+     * Defines the request payload for ServerRemoveFileUploadInfo.
+     */
     class ServerRemoveFileUploadInfoRequestData extends RemoveFileUploadInfoRequestData {
     }
+    /**
+     * Defines the request payload for AdminRemoveFileUploadInfo.
+     */
     class AdminRemoveFileUploadInfoRequestData extends ServerRemoveFileUploadInfoRequestData {
     }
+    /**
+     * Requests a short-lived download token for an existing uploaded file.
+     */
     class RequestDownloadFileUploadInfoRequestData {
         fileId: string;
     }
+    /**
+     * Defines the request payload for ServerRequestDownloadFileUploadInfo.
+     */
     class ServerRequestDownloadFileUploadInfoRequestData extends RequestDownloadFileUploadInfoRequestData {
     }
+    /**
+     * Defines the request payload for AdminRequestDownloadFileUploadInfo.
+     */
     class AdminRequestDownloadFileUploadInfoRequestData extends ServerRequestDownloadFileUploadInfoRequestData {
     }
+    /**
+     * Defines the request payload for SetContentData.
+     */
     class SetContentDataRequestData {
         configs: Array<ContentDataParam>;
         label?: string;
     }
+    /**
+     * Defines the request payload for ServerSetContentData.
+     */
     class ServerSetContentDataRequestData extends SetContentDataRequestData {
     }
+    /**
+     * Defines the request payload for AdminSetContentData.
+     */
     class AdminSetContentDataRequestData extends ServerSetContentDataRequestData {
     }
+    /**
+     * Returns the backend-generated file ID for follow-up upload or download workflows.
+     */
     class FileIdUploadResponseData {
         fileId: string;
     }
+    /**
+     * Defines the response payload for GetContentData.
+     */
     class GetContentDataResponseData {
         configs: Array<ContentDataParam>;
     }
+    /**
+     * Defines the response payload for GetFileUploadInfoList.
+     */
     class GetFileUploadInfoListResponseData {
         results: Array<FileIdUploadResponseData>;
     }
+    /**
+     * Describes upload metadata stored for one file entry.
+     */
     class FileUploadItem {
         mimeType: string;
         size: number;
         folderFileName: string;
     }
+    /**
+     * Returns metadata for one uploaded file entry.
+     */
     class GetFileUploadInfoResponseData extends FileIdUploadResponseData {
         fileName: string;
         tsCreate: number;
         removeStatus: GenericModels.RemoveStatusItem;
+        /**
+         * Upload-expiration timestamp for unfinished uploads when present.
+         */
         tsUploadExpire?: number;
         fileUpload?: FileUploadItem;
     }
+    /**
+     * Returns the download token consumed by the SDK download helper.
+     */
     class RequestDownloadFileUploadInfoResponseData {
         downloadToken: string;
     }
+    /**
+     * Defines an intentionally empty response payload.
+     */
     class EmptyResponseData {
     }
 }