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

package/dist/Multiplayer.js

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

package/dist/Multiplayer.js.map

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

package/dist/PlayFabCommon-Dnp_xHg5.d.ts

@@ -0,0 +1,68 @@
+interface IPlayFabRequestCommon {
+}
+interface IPlayFabError {
+    code: number;
+    status: string;
+    error: string;
+    errorCode: number;
+    errorMessage: string;
+    errorDetails?: Record<string, string[]>;
+    request?: any;
+    retryAfterSeconds?: number;
+}
+interface IPlayFabResultCommon extends IPlayFabError {
+}
+interface EmptyResponse extends IPlayFabResultCommon {
+}
+
+interface ISettings {
+    /** You must set this value for PlayFabSdk to work properly (Found in the Game Manager for your title, at the PlayFab Website) */
+    titleId: string;
+    /** For security reasons you must never expose this value to the client or players - You must set this value for Server-APIs to work properly (Found in the Game Manager for your title, at the PlayFab Website) */
+    developerSecretKey: string;
+    productionServerUrl: string;
+    /** Headers to apply to every request */
+    globalHeaders?: Record<string, string>;
+    /** The name of a customer vertical. This is only for customers running a private cluster. Generally you shouldn't touch this */
+    verticalName?: string | null;
+}
+
+type AuthContext = {
+    PlayFabId: string | null;
+    EntityId: string | null;
+    EntityType: string | null;
+    SessionTicket: string | null;
+    EntityToken: string | null;
+};
+
+declare class PlayFabCommon {
+    buildIdentifier: string;
+    requestGetParams: {
+        readonly sdk: string;
+    };
+    errorTitleId: string;
+    private _context;
+    constructor(settings?: Partial<ISettings> | undefined);
+    get settings(): ISettings;
+    get authenticationContext(): AuthContext;
+    get sessionTicket(): string | null;
+    set sessionTicket(value: string | null);
+    get entityToken(): string | null;
+    set entityToken(value: string | null);
+    GetServerUrl(): string;
+    InjectHeaders(xhr: XMLHttpRequest, headersObj: Record<string, string> | undefined): void;
+    ExecuteRequest<T extends IPlayFabResultCommon>(url: string, body: any, authkey: string | null, authValue: string | null, extraHeaders?: Record<string, string>): Promise<{
+        data: T;
+    }>;
+    UpdateAuthenticationContext(currentAuthContext: AuthContext, result: any): AuthContext;
+    GetAuthInfo(request: any, authKey: string): {
+        authKey: string;
+        authValue: any;
+        authError: string;
+    };
+    ExecuteRequestWrapper<T extends IPlayFabResultCommon>(apiURL: string, request: any, authKey: string | null, extraHeaders?: Record<string, string>): Promise<T>;
+    GenerateErrorReport(error: IPlayFabError | null): string;
+    ForgetAllCredentials(): void;
+}
+
+export { type EmptyResponse as E, type IPlayFabRequestCommon as I, PlayFabCommon as P, type IPlayFabResultCommon as a };

package/dist/Profiles.d.ts

@@ -0,0 +1,422 @@
+import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon } from './PlayFabCommon-Dnp_xHg5.js';
+
+interface EntityDataObject {
+    /** Un-escaped JSON object, if DataAsObject is true. */
+    DataObject?: any;
+    /** Escaped string JSON body of the object, if DataAsObject is default or false. */
+    EscapedDataObject?: string;
+    /** Name of this object. */
+    ObjectName?: string;
+}
+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 EntityLineage {
+    /** The Character Id of the associated entity. */
+    CharacterId?: string;
+    /** The Group Id of the associated entity. */
+    GroupId?: string;
+    /** The Master Player Account Id of the associated entity. */
+    MasterPlayerAccountId?: string;
+    /** The Namespace Id of the associated entity. */
+    NamespaceId?: string;
+    /** The Title Id of the associated entity. */
+    TitleId?: string;
+    /** The Title Player Account Id of the associated entity. */
+    TitlePlayerAccountId?: string;
+}
+interface EntityPermissionStatement {
+    /** The action this statement effects. May be 'Read', 'Write' or '*' for both read and write. */
+    Action: string;
+    /** A comment about the statement. Intended solely for bookkeeping and debugging. */
+    Comment?: string;
+    /** Additional conditions to be applied for entity resources. */
+    Condition?: any;
+    /** The effect this statement will have. It may be either Allow or Deny */
+    Effect: string;
+    /** The principal this statement will effect. */
+    Principal: any;
+    /** The resource this statements effects. Similar to 'pfrn:data--title![Title ID]/Profile/*' */
+    Resource: string;
+}
+interface EntityProfileBody {
+    /** Avatar URL for the entity. */
+    AvatarUrl?: string;
+    /** The creation time of this profile in UTC. */
+    Created: string;
+    /**
+     * The display name of the entity. This field may serve different purposes for different entity types. i.e.: for a title
+     * player account it could represent the display name of the player, whereas on a character it could be character's name.
+     */
+    DisplayName?: string;
+    /** The entity id and type. */
+    Entity?: EntityKey;
+    /** The chain of responsibility for this entity. Use Lineage. */
+    EntityChain?: string;
+    /** The experiment variants of this profile. */
+    ExperimentVariants?: string[];
+    /** The files on this profile. */
+    Files?: Record<string, EntityProfileFileMetadata>;
+    /** The language on this profile. */
+    Language?: string;
+    /** The lineage of this profile. */
+    Lineage?: EntityLineage;
+    /** The objects on this profile. */
+    Objects?: Record<string, EntityDataObject>;
+    /**
+     * The permissions that govern access to this entity profile and its properties. Only includes permissions set on this
+     * profile, not global statements from titles and namespaces.
+     */
+    Permissions?: EntityPermissionStatement[];
+    /** The statistics on this profile. */
+    Statistics?: Record<string, EntityStatisticValue>;
+    /**
+     * The version number of the profile in persistent storage at the time of the read. Used for optional optimistic
+     * concurrency during update.
+     */
+    VersionNumber: number;
+}
+interface EntityProfileFileMetadata {
+    /** Checksum value for the file, can be used to check if the file on the server has changed. */
+    Checksum?: 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 EntityStatisticValue {
+    /** Metadata associated with the Statistic. */
+    Metadata?: string;
+    /** Statistic name */
+    Name?: string;
+    /** Statistic scores */
+    Scores?: string[];
+    /** Statistic version */
+    Version: number;
+}
+interface GetEntityProfileRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /**
+     * Determines whether the objects will be returned as an escaped JSON string or as a un-escaped JSON object. Default is
+     * JSON string.
+     */
+    DataAsObject?: boolean;
+    /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
+    Entity?: EntityKey;
+}
+interface GetEntityProfileResponse extends IPlayFabResultCommon {
+    /** Entity profile */
+    Profile?: EntityProfileBody;
+}
+interface GetEntityProfilesRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /**
+     * Determines whether the objects will be returned as an escaped JSON string or as a un-escaped JSON object. Default is
+     * JSON string.
+     */
+    DataAsObject?: boolean;
+    /** Entity keys of the profiles to load. Must be between 1 and 25 */
+    Entities: EntityKey[];
+}
+interface GetEntityProfilesResponse extends IPlayFabResultCommon {
+    /** Entity profiles */
+    Profiles?: EntityProfileBody[];
+}
+interface GetGlobalPolicyRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
+    Entity?: EntityKey;
+}
+interface GetGlobalPolicyResponse extends IPlayFabResultCommon {
+    /** The permissions that govern access to all entities under this title or namespace. */
+    Permissions?: EntityPermissionStatement[];
+}
+interface GetTitlePlayersFromMasterPlayerAccountIdsRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** Master player account ids. */
+    MasterPlayerAccountIds: string[];
+    /** Id of title to get players from. */
+    TitleId?: string;
+}
+interface GetTitlePlayersFromMasterPlayerAccountIdsResponse extends IPlayFabResultCommon {
+    /** Optional id of title to get players from, required if calling using a master_player_account. */
+    TitleId?: string;
+    /** Dictionary of master player ids mapped to title player entity keys and id pairs */
+    TitlePlayerAccounts?: Record<string, EntityKey>;
+}
+interface GetTitlePlayersFromProviderIDsResponse extends IPlayFabResultCommon {
+    /**
+     * Dictionary of provider identifiers mapped to title_player_account lineage. Missing lineage indicates the player either
+     * doesn&#39;t exist or doesn&#39;t play the requested title.
+     */
+    TitlePlayerAccounts?: Record<string, EntityLineage>;
+}
+interface GetTitlePlayersFromXboxLiveIDsRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** Xbox Sandbox the players had on their Xbox tokens. */
+    Sandbox: string;
+    /** Optional ID of title to get players from, required if calling using a master_player_account. */
+    TitleId?: string;
+    /** List of Xbox Live XUIDs */
+    XboxLiveIds: string[];
+}
+interface SetAvatarUrlRequest extends IPlayFabRequestCommon {
+    /** URL of the avatar image. If empty, it removes the existing avatar URL */
+    AvatarUrl: string;
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
+    Entity?: EntityKey;
+    /** The expected version of the profile to perform this update on */
+    ProfileVersion?: number;
+}
+interface SetAvatarUrlResponse extends IPlayFabResultCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
+    Entity?: EntityKey;
+    /** The type of operation that occurred on the profile&#39;s avatar URL */
+    OperationResult?: string;
+    /** The updated version of the profile after the avatar URL update */
+    ProfileVersion?: number;
+}
+interface SetDisplayNameRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The new value to be set on Entity Profile&#39;s display name */
+    DisplayName?: string;
+    /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
+    Entity?: EntityKey;
+    /** The expected version of a profile to perform this update on */
+    ExpectedVersion?: number;
+}
+interface SetDisplayNameResponse extends IPlayFabResultCommon {
+    /** The type of operation that occured on the profile&#39;s display name */
+    OperationResult?: string;
+    /** The updated version of the profile after the display name update */
+    VersionNumber?: number;
+}
+interface SetEntityProfilePolicyRequest 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;
+    /** The statements to include in the access policy. */
+    Statements: EntityPermissionStatement[];
+}
+interface SetEntityProfilePolicyResponse extends IPlayFabResultCommon {
+    /**
+     * The permissions that govern access to this entity profile and its properties. Only includes permissions set on this
+     * profile, not global statements from titles and namespaces.
+     */
+    Permissions?: EntityPermissionStatement[];
+}
+interface SetGlobalPolicyRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The permissions that govern access to all entities under this title or namespace. */
+    Permissions?: EntityPermissionStatement[];
+}
+interface SetGlobalPolicyResponse extends IPlayFabResultCommon {
+}
+interface SetProfileLanguageRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
+    Entity?: EntityKey;
+    /** The expected version of a profile to perform this update on */
+    ExpectedVersion?: number;
+    /** The language to set on the given entity. Deletes the profile&#39;s language if passed in a null string. */
+    Language?: string;
+}
+interface SetProfileLanguageResponse extends IPlayFabResultCommon {
+    /** The type of operation that occured on the profile&#39;s language */
+    OperationResult?: string;
+    /** The updated version of the profile after the language update */
+    VersionNumber?: number;
+}
+
+declare class PlayFabProfilesApi extends PlayFabCommon {
+    /**
+     * Gets the global title access policy
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/getglobalpolicy Microsoft Documentation}
+     * @example
+     * await profileClient.GetGlobalPolicy({});
+     */
+    GetGlobalPolicy(request: GetGlobalPolicyRequest, extraHeaders?: Record<string, string>): Promise<GetGlobalPolicyResponse>;
+    /**
+     * Retrieves the entity's profile.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/getprofile Microsoft Documentation}
+     * @example
+     * await profileClient.GetProfile({
+     *   "Entity": {
+     *     "Id": "1234567787392",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
+     */
+    GetProfile(request: GetEntityProfileRequest, extraHeaders?: Record<string, string>): Promise<GetEntityProfileResponse>;
+    /**
+     * Retrieves the entity's profile.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/getprofiles Microsoft Documentation}
+     * @example
+     * await profileClient.GetProfiles({
+     *   "Entities": [
+     *     {
+     *       "Id": "1234567787392",
+     *       "Type": "title_player_account",
+     *       "TypeString": "title_player_account"
+     *     },
+     *     {
+     *       "Id": "42434567785265",
+     *       "Type": "title_player_account",
+     *       "TypeString": "title_player_account"
+     *     }
+     *   ]
+     * });
+     */
+    GetProfiles(request: GetEntityProfilesRequest, extraHeaders?: Record<string, string>): Promise<GetEntityProfilesResponse>;
+    /**
+     * Retrieves the title player accounts associated with the given master player account.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/gettitleplayersfrommasterplayeraccountids Microsoft Documentation}
+     * @example
+     * await profileClient.GetTitlePlayersFromMasterPlayerAccountIds({
+     *   "MasterPlayerAccountIds": [
+     *     "1233455677"
+     *   ],
+     *   "TitleId": "abc123"
+     * });
+     */
+    GetTitlePlayersFromMasterPlayerAccountIds(request: GetTitlePlayersFromMasterPlayerAccountIdsRequest, extraHeaders?: Record<string, string>): Promise<GetTitlePlayersFromMasterPlayerAccountIdsResponse>;
+    /**
+     * Retrieves the title player accounts associated with the given XUIDs.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/gettitleplayersfromxboxliveids Microsoft Documentation}
+     * @example
+     * await profileClient.GetTitlePlayersFromXboxLiveIDs({
+     *   "XboxLiveIds": [
+     *     "1233455677"
+     *   ],
+     *   "Sandbox": "RETAIL"
+     * });
+     */
+    GetTitlePlayersFromXboxLiveIDs(request: GetTitlePlayersFromXboxLiveIDsRequest, extraHeaders?: Record<string, string>): Promise<GetTitlePlayersFromProviderIDsResponse>;
+    /**
+     * Update the avatar url of the entity
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/setavatarurl Microsoft Documentation}
+     * @example
+     * await profileClient.SetAvatarUrl({
+     *   "AvatarUrl": "https://test.com/image.png",
+     *   "ProfileVersion": 123,
+     *   "Entity": {
+     *     "Id": "90901000",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
+     */
+    SetAvatarUrl(request: SetAvatarUrlRequest, extraHeaders?: Record<string, string>): Promise<SetAvatarUrlResponse>;
+    /**
+     * Update the display name of the entity
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/setdisplayname Microsoft Documentation}
+     * @example
+     * await profileClient.SetDisplayName({
+     *   "DisplayName": "My new display name",
+     *   "ExpectedVersion": 123,
+     *   "Entity": {
+     *     "Id": "90901000",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
+     */
+    SetDisplayName(request: SetDisplayNameRequest, extraHeaders?: Record<string, string>): Promise<SetDisplayNameResponse>;
+    /**
+     * Sets the global title access policy
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/setglobalpolicy Microsoft Documentation}
+     * @example
+     * await profileClient.SetGlobalPolicy({
+     *   "Permissions": [
+     *     {
+     *       "Resource": "pfrn:data--title_player_account!90901000/Profile/SomethingCool",
+     *       "Action": "*",
+     *       "Effect": "Allow",
+     *       "Principal": {
+     *         "ChildOf": {
+     *           "EntityType": "[SELF]"
+     *         }
+     *       },
+     *       "Comment": "An example policy"
+     *     }
+     *   ]
+     * });
+     */
+    SetGlobalPolicy(request: SetGlobalPolicyRequest, extraHeaders?: Record<string, string>): Promise<SetGlobalPolicyResponse>;
+    /**
+     * Updates the entity's language. The precedence hierarchy for communication to the player is Title Player Account
+     * language, Master Player Account language, and then title default language if the first two aren't set or supported.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/setprofilelanguage Microsoft Documentation}
+     * @example
+     * await profileClient.SetProfileLanguage({
+     *   "Language": "en",
+     *   "ExpectedVersion": 123,
+     *   "Entity": {
+     *     "Id": "1234",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
+     */
+    SetProfileLanguage(request: SetProfileLanguageRequest, extraHeaders?: Record<string, string>): Promise<SetProfileLanguageResponse>;
+    /**
+     * Sets the profiles access policy
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/profile/account-management/setprofilepolicy Microsoft Documentation}
+     * @example
+     * await profileClient.SetProfilePolicy({
+     *   "Statements": [
+     *     {
+     *       "Resource": "pfrn:data--*!*\/Profile/Files/avatar.png",
+     *       "Action": "Read",
+     *       "Effect": "Allow",
+     *       "Principal": {
+     *         "FriendOf": "true"
+     *       },
+     *       "Comment": "Allow my friends to read my avatar"
+     *     }
+     *   ],
+     *   "Entity": {
+     *     "Id": "90901000",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
+     */
+    SetProfilePolicy(request: SetEntityProfilePolicyRequest, extraHeaders?: Record<string, string>): Promise<SetEntityProfilePolicyResponse>;
+}
+
+export { PlayFabProfilesApi as default };

package/dist/Profiles.js

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

package/dist/Profiles.js.map

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