@community-fabs/playfab-web-sdk 1.193.250606-1

package/dist/CloudScript.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/Data.d.ts

@@ -0,0 +1,347 @@
+import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon } from './PlayFabCommon-Dnp_xHg5.js';
+
+interface AbortFileUploadsRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The entity to perform this action on. */
+    Entity: EntityKey;
+    /** Names of the files to have their pending uploads aborted. */
+    FileNames: string[];
+    /**
+     * The expected version of the profile, if set and doesn&#39;t match the current version of the profile the operation will not
+     * be performed.
+     */
+    ProfileVersion?: number;
+}
+interface AbortFileUploadsResponse extends IPlayFabResultCommon {
+    /** The entity id and type. */
+    Entity?: EntityKey;
+    /** The current version of the profile, can be used for concurrency control during updates. */
+    ProfileVersion: number;
+}
+interface DeleteFilesRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The entity to perform this action on. */
+    Entity: EntityKey;
+    /** Names of the files to be deleted. */
+    FileNames: string[];
+    /**
+     * The expected version of the profile, if set and doesn&#39;t match the current version of the profile the operation will not
+     * be performed.
+     */
+    ProfileVersion?: number;
+}
+interface DeleteFilesResponse extends IPlayFabResultCommon {
+    /** The entity id and type. */
+    Entity?: EntityKey;
+    /** The current version of the profile, can be used for concurrency control during updates. */
+    ProfileVersion: number;
+}
+interface EntityKey {
+    /** Unique ID of the entity. */
+    Id: string;
+    /** Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types */
+    Type?: string;
+    /**
+     * Alternate name for Type.
+     * @deprecated Please use Type instead.
+     */
+    TypeString?: string;
+}
+interface FinalizeFileUploadsRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The entity to perform this action on. */
+    Entity: EntityKey;
+    /** Names of the files to be finalized. Restricted to a-Z, 0-9, &#39;(&#39;, &#39;)&#39;, &#39;_&#39;, &#39;-&#39; and &#39;.&#39; */
+    FileNames: string[];
+    /** The current version of the profile, can be used for concurrency control during updates. */
+    ProfileVersion: number;
+}
+interface FinalizeFileUploadsResponse extends IPlayFabResultCommon {
+    /** The entity id and type. */
+    Entity?: EntityKey;
+    /** Collection of metadata for the entity&#39;s files */
+    Metadata?: Record<string, GetFileMetadata>;
+    /** The current version of the profile, can be used for concurrency control during updates. */
+    ProfileVersion: number;
+}
+interface GetFileMetadata {
+    /** Checksum value for the file, can be used to check if the file on the server has changed. */
+    Checksum?: string;
+    /** Download URL where the file can be retrieved */
+    DownloadUrl?: string;
+    /** Name of the file */
+    FileName?: string;
+    /** Last UTC time the file was modified */
+    LastModified: string;
+    /** Storage service&#39;s reported byte count */
+    Size: number;
+}
+interface GetFilesRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The entity to perform this action on. */
+    Entity: EntityKey;
+}
+interface GetFilesResponse extends IPlayFabResultCommon {
+    /** The entity id and type. */
+    Entity?: EntityKey;
+    /** Collection of metadata for the entity&#39;s files */
+    Metadata?: Record<string, GetFileMetadata>;
+    /** The current version of the profile, can be used for concurrency control during updates. */
+    ProfileVersion: number;
+}
+interface GetObjectsRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The entity to perform this action on. */
+    Entity: EntityKey;
+    /**
+     * Determines whether the object will be returned as an escaped JSON string or as a un-escaped JSON object. Default is JSON
+     * object.
+     */
+    EscapeObject?: boolean;
+}
+interface GetObjectsResponse extends IPlayFabResultCommon {
+    /** The entity id and type. */
+    Entity?: EntityKey;
+    /** Requested objects that the calling entity has access to */
+    Objects?: Record<string, ObjectResult>;
+    /** The current version of the profile, can be used for concurrency control during updates. */
+    ProfileVersion: number;
+}
+interface InitiateFileUploadMetadata {
+    /** Name of the file. */
+    FileName?: string;
+    /** Location the data should be sent to via an HTTP PUT operation. */
+    UploadUrl?: string;
+}
+interface InitiateFileUploadsRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The entity to perform this action on. */
+    Entity: EntityKey;
+    /** Names of the files to be set. Restricted to a-Z, 0-9, &#39;(&#39;, &#39;)&#39;, &#39;_&#39;, &#39;-&#39; and &#39;.&#39; */
+    FileNames: string[];
+    /**
+     * The expected version of the profile, if set and doesn&#39;t match the current version of the profile the operation will not
+     * be performed.
+     */
+    ProfileVersion?: number;
+}
+interface InitiateFileUploadsResponse extends IPlayFabResultCommon {
+    /** The entity id and type. */
+    Entity?: EntityKey;
+    /** The current version of the profile, can be used for concurrency control during updates. */
+    ProfileVersion: number;
+    /** Collection of file names and upload urls */
+    UploadDetails?: InitiateFileUploadMetadata[];
+}
+interface ObjectResult {
+    /** Un-escaped JSON object, if EscapeObject false or default. */
+    DataObject?: any;
+    /** Escaped string JSON body of the object, if EscapeObject is true. */
+    EscapedDataObject?: string;
+    /** Name of the object. Restricted to a-Z, 0-9, &#39;(&#39;, &#39;)&#39;, &#39;_&#39;, &#39;-&#39; and &#39;.&#39; */
+    ObjectName?: string;
+}
+interface SetObject {
+    /**
+     * Body of the object to be saved. If empty and DeleteObject is true object will be deleted if it exists, or no operation
+     * will occur if it does not exist. Only one of Object or EscapedDataObject fields may be used.
+     */
+    DataObject?: any;
+    /** Flag to indicate that this object should be deleted. Both DataObject and EscapedDataObject must not be set as well. */
+    DeleteObject?: boolean;
+    /**
+     * Body of the object to be saved as an escaped JSON string. If empty and DeleteObject is true object will be deleted if it
+     * exists, or no operation will occur if it does not exist. Only one of DataObject or EscapedDataObject fields may be used.
+     */
+    EscapedDataObject?: string;
+    /** Name of object. Restricted to a-Z, 0-9, &#39;(&#39;, &#39;)&#39;, &#39;_&#39;, &#39;-&#39; and &#39;.&#39;. */
+    ObjectName: string;
+}
+interface SetObjectInfo {
+    /** Name of the object */
+    ObjectName?: string;
+    /** Optional reason to explain why the operation was the result that it was. */
+    OperationReason?: string;
+    /** Indicates which operation was completed, either Created, Updated, Deleted or None. */
+    SetResult?: string;
+}
+interface SetObjectsRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The entity to perform this action on. */
+    Entity: EntityKey;
+    /**
+     * Optional field used for concurrency control. By specifying the previously returned value of ProfileVersion from
+     * GetProfile API, you can ensure that the object set will only be performed if the profile has not been updated by any
+     * other clients since the version you last loaded.
+     */
+    ExpectedProfileVersion?: number;
+    /** Collection of objects to set on the profile. */
+    Objects: SetObject[];
+}
+interface SetObjectsResponse extends IPlayFabResultCommon {
+    /** New version of the entity profile. */
+    ProfileVersion: number;
+    /** New version of the entity profile. */
+    SetResults?: SetObjectInfo[];
+}
+
+declare class PlayFabDataApi extends PlayFabCommon {
+    /**
+     * Abort pending file uploads to an entity's profile.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/file/file/abortfileuploads Microsoft Documentation}
+     * @example
+     * await fileClient.AbortFileUploads({
+     *   "FileNames": [
+     *     "avatar",
+     *     "game_state"
+     *   ],
+     *   "Entity": {
+     *     "Id": "ID",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
+     */
+    AbortFileUploads(request: AbortFileUploadsRequest, extraHeaders?: Record<string, string>): Promise<AbortFileUploadsResponse>;
+    /**
+     * Delete files on an entity's profile.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/file/file/deletefiles Microsoft Documentation}
+     * @example
+     * await fileClient.DeleteFiles({
+     *   "FileNames": [
+     *     "game_state",
+     *     "avatar"
+     *   ],
+     *   "Entity": {
+     *     "Id": "ID",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
+     */
+    DeleteFiles(request: DeleteFilesRequest, extraHeaders?: Record<string, string>): Promise<DeleteFilesResponse>;
+    /**
+     * Finalize file uploads to an entity's profile.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/file/file/finalizefileuploads Microsoft Documentation}
+     * @example
+     * await fileClient.FinalizeFileUploads({
+     *   "ProfileVersion": 0,
+     *   "FileNames": [
+     *     "avatar",
+     *     "game_state"
+     *   ],
+     *   "Entity": {
+     *     "Id": "ID",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
+     */
+    FinalizeFileUploads(request: FinalizeFileUploadsRequest, extraHeaders?: Record<string, string>): Promise<FinalizeFileUploadsResponse>;
+    /**
+     * Retrieves file metadata from an entity's profile.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/file/file/getfiles Microsoft Documentation}
+     * @example
+     * await fileClient.GetFiles({
+     *   "Entity": {
+     *     "Id": "ID",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
+     */
+    GetFiles(request: GetFilesRequest, extraHeaders?: Record<string, string>): Promise<GetFilesResponse>;
+    /**
+     * Retrieves objects from an entity's profile.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/object/object/getobjects Microsoft Documentation}
+     * @example
+     * await objectClient.GetObjects({
+     *   "Entity": {
+     *     "Id": "ABC90712ABC",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
+     */
+    GetObjects(request: GetObjectsRequest, extraHeaders?: Record<string, string>): Promise<GetObjectsResponse>;
+    /**
+     * Initiates file uploads to an entity's profile.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/file/file/initiatefileuploads Microsoft Documentation}
+     * @example
+     * await fileClient.InitiateFileUploads({
+     *   "FileNames": [
+     *     "avatar",
+     *     "game_state"
+     *   ],
+     *   "Entity": {
+     *     "Id": "ID",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
+     */
+    InitiateFileUploads(request: InitiateFileUploadsRequest, extraHeaders?: Record<string, string>): Promise<InitiateFileUploadsResponse>;
+    /**
+     * Sets objects on an entity's profile.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/object/object/setobjects Microsoft Documentation}
+     * @example
+     * await objectClient.SetObjects({
+     *   "ExpectedProfileVersion": 5,
+     *   "Objects": [
+     *     {
+     *       "ObjectName": "SaveSate",
+     *       "DataObject": {
+     *         "PlayerDetails": {
+     *           "LastMissionSuccess": "2017-06-15T11:05:19Z",
+     *           "LastMissionFailure": "2017-06-12T11:05:19Z",
+     *           "MapPosition": [
+     *             22.0,
+     *             37.78
+     *           ],
+     *           "IsPaidUpgrade": true
+     *         },
+     *         "GameSettings": {
+     *           "Screen": "FriendsList",
+     *           "Favorites": [
+     *             "Place 1",
+     *             "Place 2"
+     *           ]
+     *         }
+     *       },
+     *       "SimpleStatements": {
+     *         "Read": [
+     *           {
+     *             "Friend": true
+     *           }
+     *         ],
+     *         "Write": [
+     *           "Self"
+     *         ]
+     *       }
+     *     }
+     *   ],
+     *   "Entity": {
+     *     "Id": "A8140AB9109712B",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
+     */
+    SetObjects(request: SetObjectsRequest, extraHeaders?: Record<string, string>): Promise<SetObjectsResponse>;
+}
+
+export { PlayFabDataApi as default };

package/dist/Data.js

@@ -0,0 +1,8 @@
+import {
+  PlayFabDataApi
+} from "./chunk-P4FCADAY.js";
+import "./chunk-6OZSERVG.js";
+export {
+  PlayFabDataApi as default
+};
+//# sourceMappingURL=Data.js.map

package/dist/Data.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}