@dcl/protocol 1.0.0-3548510624.commit-7609438 → 1.0.0-35600014993.commit-874bb91

package/out-js/decentraland/kernel/apis/restricted_actions.gen.d.ts

@@ -0,0 +1,383 @@
+import _m0 from "protobufjs/minimal";
+import { Vector2, Vector3 } from "../../common/vectors.gen";
+import { AvatarMask } from "../../sdk/components/common/avatar_mask.gen";
+import { ExplorerUi } from "../../sdk/components/common/explorer_ui.gen";
+export declare const protobufPackage = "decentraland.kernel.apis";
+/** Verdict of an OpenExplorerUi request (enum rather than a bool so new outcomes stay expressible). */
+export declare enum OpenExplorerUiResult {
+    UNSPECIFIED = 0,
+    OPENED = 1,
+    /** WAS_ALREADY_OPEN - the slot the requested panel occupies is already in use; panels sharing a slot exclude each other */
+    WAS_ALREADY_OPEN = 2,
+    /** REJECTED_NOT_CURRENT_SCENE - the standard restricted-actions current-scene gate rejected the call */
+    REJECTED_NOT_CURRENT_SCENE = 3,
+    /** REJECTED_FEATURE_DISABLED - the requested section is hidden by feature flags or client doesn't have that feature */
+    REJECTED_FEATURE_DISABLED = 4,
+    /** REJECTED_NO_USER_GESTURE - rejected: the call did not originate from a user gesture */
+    REJECTED_NO_USER_GESTURE = 5,
+    UNRECOGNIZED = -1
+}
+export declare function openExplorerUiResultFromJSON(object: any): OpenExplorerUiResult;
+export declare function openExplorerUiResultToJSON(object: OpenExplorerUiResult): string;
+export interface MovePlayerToRequest {
+    newRelativePosition: Vector3 | undefined;
+    cameraTarget?: Vector3 | undefined;
+    avatarTarget?: Vector3 | undefined;
+    /** by default (no duration param) the player is instantly moved and not interpolated */
+    duration?: number | undefined;
+}
+export interface TeleportToRequest {
+    /** The parcel to land on. Omitted: the realm's default spawn (only meaningful with `realm`). */
+    worldCoordinates?: Vector2 | undefined;
+    /**
+     * The realm the parcel belongs to: a world name (`foo.dcl.eth`) or a realm url. When set, the
+     * client changes realm (a full reconnect, even to the realm the player is in) and lands on the
+     * parcel there. Omitted: the parcel is in the player's current realm.
+     */
+    realm?: string | undefined;
+}
+export interface TriggerEmoteRequest {
+    predefinedEmote: string;
+    mask?: AvatarMask | undefined;
+}
+export interface ChangeRealmRequest {
+    realm: string;
+    message?: string | undefined;
+}
+export interface OpenExternalUrlRequest {
+    url: string;
+}
+export interface OpenNftDialogRequest {
+    urn: string;
+}
+export interface UnblockPointerRequest {
+}
+export interface CommsAdapterRequest {
+    connectionString: string;
+}
+export interface TriggerSceneEmoteRequest {
+    src: string;
+    loop?: boolean | undefined;
+    mask?: AvatarMask | undefined;
+}
+export interface SuccessResponse {
+    success: boolean;
+}
+export interface TriggerEmoteResponse {
+}
+export interface MovePlayerToResponse {
+    success: boolean;
+}
+export interface TeleportToResponse {
+}
+export interface CopyToClipboardRequest {
+    text: string;
+}
+export interface EmptyResponse {
+}
+export interface StopEmoteRequest {
+}
+export interface OpenExplorerUiRequest {
+    ui: ExplorerUi;
+    /**
+     * Echoed back in the events this request produces, so they can be matched to their call.
+     * Unset means no correlation, and 0 is reserved for the same meaning on the result, so ids start at 1.
+     */
+    requestId?: number | undefined;
+    params?: {
+        $case: "itemPurchase";
+        itemPurchase: OpenExplorerUiRequest_ItemPurchaseParams;
+    } | undefined;
+}
+export interface OpenExplorerUiRequest_ItemPurchaseParams {
+    urn: string;
+}
+export interface OpenExplorerUiResponse {
+    /** Carries only the verdict of the open action. */
+    openResult: OpenExplorerUiResult;
+}
+export declare namespace MovePlayerToRequest {
+    function encode(message: MovePlayerToRequest, writer?: _m0.Writer): _m0.Writer;
+    function decode(input: _m0.Reader | Uint8Array, length?: number): MovePlayerToRequest;
+    function fromJSON(object: any): MovePlayerToRequest;
+    function toJSON(message: MovePlayerToRequest): unknown;
+    function create<I extends Exact<DeepPartial<MovePlayerToRequest>, I>>(base?: I): MovePlayerToRequest;
+    function fromPartial<I extends Exact<DeepPartial<MovePlayerToRequest>, I>>(object: I): MovePlayerToRequest;
+}
+export declare namespace TeleportToRequest {
+    function encode(message: TeleportToRequest, writer?: _m0.Writer): _m0.Writer;
+    function decode(input: _m0.Reader | Uint8Array, length?: number): TeleportToRequest;
+    function fromJSON(object: any): TeleportToRequest;
+    function toJSON(message: TeleportToRequest): unknown;
+    function create<I extends Exact<DeepPartial<TeleportToRequest>, I>>(base?: I): TeleportToRequest;
+    function fromPartial<I extends Exact<DeepPartial<TeleportToRequest>, I>>(object: I): TeleportToRequest;
+}
+export declare namespace TriggerEmoteRequest {
+    function encode(message: TriggerEmoteRequest, writer?: _m0.Writer): _m0.Writer;
+    function decode(input: _m0.Reader | Uint8Array, length?: number): TriggerEmoteRequest;
+    function fromJSON(object: any): TriggerEmoteRequest;
+    function toJSON(message: TriggerEmoteRequest): unknown;
+    function create<I extends Exact<DeepPartial<TriggerEmoteRequest>, I>>(base?: I): TriggerEmoteRequest;
+    function fromPartial<I extends Exact<DeepPartial<TriggerEmoteRequest>, I>>(object: I): TriggerEmoteRequest;
+}
+export declare namespace ChangeRealmRequest {
+    function encode(message: ChangeRealmRequest, writer?: _m0.Writer): _m0.Writer;
+    function decode(input: _m0.Reader | Uint8Array, length?: number): ChangeRealmRequest;
+    function fromJSON(object: any): ChangeRealmRequest;
+    function toJSON(message: ChangeRealmRequest): unknown;
+    function create<I extends Exact<DeepPartial<ChangeRealmRequest>, I>>(base?: I): ChangeRealmRequest;
+    function fromPartial<I extends Exact<DeepPartial<ChangeRealmRequest>, I>>(object: I): ChangeRealmRequest;
+}
+export declare namespace OpenExternalUrlRequest {
+    function encode(message: OpenExternalUrlRequest, writer?: _m0.Writer): _m0.Writer;
+    function decode(input: _m0.Reader | Uint8Array, length?: number): OpenExternalUrlRequest;
+    function fromJSON(object: any): OpenExternalUrlRequest;
+    function toJSON(message: OpenExternalUrlRequest): unknown;
+    function create<I extends Exact<DeepPartial<OpenExternalUrlRequest>, I>>(base?: I): OpenExternalUrlRequest;
+    function fromPartial<I extends Exact<DeepPartial<OpenExternalUrlRequest>, I>>(object: I): OpenExternalUrlRequest;
+}
+export declare namespace OpenNftDialogRequest {
+    function encode(message: OpenNftDialogRequest, writer?: _m0.Writer): _m0.Writer;
+    function decode(input: _m0.Reader | Uint8Array, length?: number): OpenNftDialogRequest;
+    function fromJSON(object: any): OpenNftDialogRequest;
+    function toJSON(message: OpenNftDialogRequest): unknown;
+    function create<I extends Exact<DeepPartial<OpenNftDialogRequest>, I>>(base?: I): OpenNftDialogRequest;
+    function fromPartial<I extends Exact<DeepPartial<OpenNftDialogRequest>, I>>(object: I): OpenNftDialogRequest;
+}
+export declare namespace UnblockPointerRequest {
+    function encode(_: UnblockPointerRequest, writer?: _m0.Writer): _m0.Writer;
+    function decode(input: _m0.Reader | Uint8Array, length?: number): UnblockPointerRequest;
+    function fromJSON(_: any): UnblockPointerRequest;
+    function toJSON(_: UnblockPointerRequest): unknown;
+    function create<I extends Exact<DeepPartial<UnblockPointerRequest>, I>>(base?: I): UnblockPointerRequest;
+    function fromPartial<I extends Exact<DeepPartial<UnblockPointerRequest>, I>>(_: I): UnblockPointerRequest;
+}
+export declare namespace CommsAdapterRequest {
+    function encode(message: CommsAdapterRequest, writer?: _m0.Writer): _m0.Writer;
+    function decode(input: _m0.Reader | Uint8Array, length?: number): CommsAdapterRequest;
+    function fromJSON(object: any): CommsAdapterRequest;
+    function toJSON(message: CommsAdapterRequest): unknown;
+    function create<I extends Exact<DeepPartial<CommsAdapterRequest>, I>>(base?: I): CommsAdapterRequest;
+    function fromPartial<I extends Exact<DeepPartial<CommsAdapterRequest>, I>>(object: I): CommsAdapterRequest;
+}
+export declare namespace TriggerSceneEmoteRequest {
+    function encode(message: TriggerSceneEmoteRequest, writer?: _m0.Writer): _m0.Writer;
+    function decode(input: _m0.Reader | Uint8Array, length?: number): TriggerSceneEmoteRequest;
+    function fromJSON(object: any): TriggerSceneEmoteRequest;
+    function toJSON(message: TriggerSceneEmoteRequest): unknown;
+    function create<I extends Exact<DeepPartial<TriggerSceneEmoteRequest>, I>>(base?: I): TriggerSceneEmoteRequest;
+    function fromPartial<I extends Exact<DeepPartial<TriggerSceneEmoteRequest>, I>>(object: I): TriggerSceneEmoteRequest;
+}
+export declare namespace SuccessResponse {
+    function encode(message: SuccessResponse, writer?: _m0.Writer): _m0.Writer;
+    function decode(input: _m0.Reader | Uint8Array, length?: number): SuccessResponse;
+    function fromJSON(object: any): SuccessResponse;
+    function toJSON(message: SuccessResponse): unknown;
+    function create<I extends Exact<DeepPartial<SuccessResponse>, I>>(base?: I): SuccessResponse;
+    function fromPartial<I extends Exact<DeepPartial<SuccessResponse>, I>>(object: I): SuccessResponse;
+}
+export declare namespace TriggerEmoteResponse {
+    function encode(_: TriggerEmoteResponse, writer?: _m0.Writer): _m0.Writer;
+    function decode(input: _m0.Reader | Uint8Array, length?: number): TriggerEmoteResponse;
+    function fromJSON(_: any): TriggerEmoteResponse;
+    function toJSON(_: TriggerEmoteResponse): unknown;
+    function create<I extends Exact<DeepPartial<TriggerEmoteResponse>, I>>(base?: I): TriggerEmoteResponse;
+    function fromPartial<I extends Exact<DeepPartial<TriggerEmoteResponse>, I>>(_: I): TriggerEmoteResponse;
+}
+export declare namespace MovePlayerToResponse {
+    function encode(message: MovePlayerToResponse, writer?: _m0.Writer): _m0.Writer;
+    function decode(input: _m0.Reader | Uint8Array, length?: number): MovePlayerToResponse;
+    function fromJSON(object: any): MovePlayerToResponse;
+    function toJSON(message: MovePlayerToResponse): unknown;
+    function create<I extends Exact<DeepPartial<MovePlayerToResponse>, I>>(base?: I): MovePlayerToResponse;
+    function fromPartial<I extends Exact<DeepPartial<MovePlayerToResponse>, I>>(object: I): MovePlayerToResponse;
+}
+export declare namespace TeleportToResponse {
+    function encode(_: TeleportToResponse, writer?: _m0.Writer): _m0.Writer;
+    function decode(input: _m0.Reader | Uint8Array, length?: number): TeleportToResponse;
+    function fromJSON(_: any): TeleportToResponse;
+    function toJSON(_: TeleportToResponse): unknown;
+    function create<I extends Exact<DeepPartial<TeleportToResponse>, I>>(base?: I): TeleportToResponse;
+    function fromPartial<I extends Exact<DeepPartial<TeleportToResponse>, I>>(_: I): TeleportToResponse;
+}
+export declare namespace CopyToClipboardRequest {
+    function encode(message: CopyToClipboardRequest, writer?: _m0.Writer): _m0.Writer;
+    function decode(input: _m0.Reader | Uint8Array, length?: number): CopyToClipboardRequest;
+    function fromJSON(object: any): CopyToClipboardRequest;
+    function toJSON(message: CopyToClipboardRequest): unknown;
+    function create<I extends Exact<DeepPartial<CopyToClipboardRequest>, I>>(base?: I): CopyToClipboardRequest;
+    function fromPartial<I extends Exact<DeepPartial<CopyToClipboardRequest>, I>>(object: I): CopyToClipboardRequest;
+}
+export declare namespace EmptyResponse {
+    function encode(_: EmptyResponse, writer?: _m0.Writer): _m0.Writer;
+    function decode(input: _m0.Reader | Uint8Array, length?: number): EmptyResponse;
+    function fromJSON(_: any): EmptyResponse;
+    function toJSON(_: EmptyResponse): unknown;
+    function create<I extends Exact<DeepPartial<EmptyResponse>, I>>(base?: I): EmptyResponse;
+    function fromPartial<I extends Exact<DeepPartial<EmptyResponse>, I>>(_: I): EmptyResponse;
+}
+export declare namespace StopEmoteRequest {
+    function encode(_: StopEmoteRequest, writer?: _m0.Writer): _m0.Writer;
+    function decode(input: _m0.Reader | Uint8Array, length?: number): StopEmoteRequest;
+    function fromJSON(_: any): StopEmoteRequest;
+    function toJSON(_: StopEmoteRequest): unknown;
+    function create<I extends Exact<DeepPartial<StopEmoteRequest>, I>>(base?: I): StopEmoteRequest;
+    function fromPartial<I extends Exact<DeepPartial<StopEmoteRequest>, I>>(_: I): StopEmoteRequest;
+}
+export declare namespace OpenExplorerUiRequest {
+    function encode(message: OpenExplorerUiRequest, writer?: _m0.Writer): _m0.Writer;
+    function decode(input: _m0.Reader | Uint8Array, length?: number): OpenExplorerUiRequest;
+    function fromJSON(object: any): OpenExplorerUiRequest;
+    function toJSON(message: OpenExplorerUiRequest): unknown;
+    function create<I extends Exact<DeepPartial<OpenExplorerUiRequest>, I>>(base?: I): OpenExplorerUiRequest;
+    function fromPartial<I extends Exact<DeepPartial<OpenExplorerUiRequest>, I>>(object: I): OpenExplorerUiRequest;
+}
+export declare namespace OpenExplorerUiRequest_ItemPurchaseParams {
+    function encode(message: OpenExplorerUiRequest_ItemPurchaseParams, writer?: _m0.Writer): _m0.Writer;
+    function decode(input: _m0.Reader | Uint8Array, length?: number): OpenExplorerUiRequest_ItemPurchaseParams;
+    function fromJSON(object: any): OpenExplorerUiRequest_ItemPurchaseParams;
+    function toJSON(message: OpenExplorerUiRequest_ItemPurchaseParams): unknown;
+    function create<I extends Exact<DeepPartial<OpenExplorerUiRequest_ItemPurchaseParams>, I>>(base?: I): OpenExplorerUiRequest_ItemPurchaseParams;
+    function fromPartial<I extends Exact<DeepPartial<OpenExplorerUiRequest_ItemPurchaseParams>, I>>(object: I): OpenExplorerUiRequest_ItemPurchaseParams;
+}
+export declare namespace OpenExplorerUiResponse {
+    function encode(message: OpenExplorerUiResponse, writer?: _m0.Writer): _m0.Writer;
+    function decode(input: _m0.Reader | Uint8Array, length?: number): OpenExplorerUiResponse;
+    function fromJSON(object: any): OpenExplorerUiResponse;
+    function toJSON(message: OpenExplorerUiResponse): unknown;
+    function create<I extends Exact<DeepPartial<OpenExplorerUiResponse>, I>>(base?: I): OpenExplorerUiResponse;
+    function fromPartial<I extends Exact<DeepPartial<OpenExplorerUiResponse>, I>>(object: I): OpenExplorerUiResponse;
+}
+export type RestrictedActionsServiceDefinition = typeof RestrictedActionsServiceDefinition;
+export declare const RestrictedActionsServiceDefinition: {
+    readonly name: "RestrictedActionsService";
+    readonly fullName: "decentraland.kernel.apis.RestrictedActionsService";
+    readonly methods: {
+        /**
+         * MovePlayerTo will move the player to a position relative to the current scene.
+         * If 'duration' field is used in the request, the success response depends on the
+         * whole interpolation being completed or interrupted (e.g: by input movement)
+         */
+        readonly movePlayerTo: {
+            readonly name: "MovePlayerTo";
+            readonly requestType: typeof MovePlayerToRequest;
+            readonly requestStream: false;
+            readonly responseType: typeof MovePlayerToResponse;
+            readonly responseStream: false;
+            readonly options: {};
+        };
+        /** TeleportTo will move the user to the specified world LAND parcel coordinates */
+        readonly teleportTo: {
+            readonly name: "TeleportTo";
+            readonly requestType: typeof TeleportToRequest;
+            readonly requestStream: false;
+            readonly responseType: typeof TeleportToResponse;
+            readonly responseStream: false;
+            readonly options: {};
+        };
+        /** TriggerEmote will trigger an emote in this current user */
+        readonly triggerEmote: {
+            readonly name: "TriggerEmote";
+            readonly requestType: typeof TriggerEmoteRequest;
+            readonly requestStream: false;
+            readonly responseType: typeof TriggerEmoteResponse;
+            readonly responseStream: false;
+            readonly options: {};
+        };
+        /**
+         * @deprecated, use TeleportTo with `realm` (and no `world_coordinates` for the realm's default spawn)
+         * ChangeRealm prompts the user to change to a specific realm
+         */
+        readonly changeRealm: {
+            readonly name: "ChangeRealm";
+            readonly requestType: typeof ChangeRealmRequest;
+            readonly requestStream: false;
+            readonly responseType: typeof SuccessResponse;
+            readonly responseStream: false;
+            readonly options: {};
+        };
+        /** OpenExternalUrl prompts the user to open an external link */
+        readonly openExternalUrl: {
+            readonly name: "OpenExternalUrl";
+            readonly requestType: typeof OpenExternalUrlRequest;
+            readonly requestStream: false;
+            readonly responseType: typeof SuccessResponse;
+            readonly responseStream: false;
+            readonly options: {};
+        };
+        /** OpenNftDialog opens an NFT dialog. */
+        readonly openNftDialog: {
+            readonly name: "OpenNftDialog";
+            readonly requestType: typeof OpenNftDialogRequest;
+            readonly requestStream: false;
+            readonly responseType: typeof SuccessResponse;
+            readonly responseStream: false;
+            readonly options: {};
+        };
+        /**
+         * Asks the explorer to connect to other communications adapter, this feature
+         * can be used to join private game servers
+         */
+        readonly setCommunicationsAdapter: {
+            readonly name: "SetCommunicationsAdapter";
+            readonly requestType: typeof CommsAdapterRequest;
+            readonly requestStream: false;
+            readonly responseType: typeof SuccessResponse;
+            readonly responseStream: false;
+            readonly options: {};
+        };
+        /** TriggerSceneEmote will trigger an scene emote file in this current user */
+        readonly triggerSceneEmote: {
+            readonly name: "TriggerSceneEmote";
+            readonly requestType: typeof TriggerSceneEmoteRequest;
+            readonly requestStream: false;
+            readonly responseType: typeof SuccessResponse;
+            readonly responseStream: false;
+            readonly options: {};
+        };
+        /** CopyToClipboard copies the provided text into the clipboard */
+        readonly copyToClipboard: {
+            readonly name: "CopyToClipboard";
+            readonly requestType: typeof CopyToClipboardRequest;
+            readonly requestStream: false;
+            readonly responseType: typeof EmptyResponse;
+            readonly responseStream: false;
+            readonly options: {};
+        };
+        /** StopEmote will stop the current emote */
+        readonly stopEmote: {
+            readonly name: "StopEmote";
+            readonly requestType: typeof StopEmoteRequest;
+            readonly requestStream: false;
+            readonly responseType: typeof SuccessResponse;
+            readonly responseStream: false;
+            readonly options: {};
+        };
+        /** OpenExplorerUi opens an explorer panel, fullscreen or modal, and returns the open verdict. */
+        readonly openExplorerUi: {
+            readonly name: "OpenExplorerUi";
+            readonly requestType: typeof OpenExplorerUiRequest;
+            readonly requestStream: false;
+            readonly responseType: typeof OpenExplorerUiResponse;
+            readonly responseStream: false;
+            readonly options: {};
+        };
+    };
+};
+type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
+export type DeepPartial<T> = T extends Builtin ? T : T extends Array<infer U> ? Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {
+    $case: string;
+} ? {
+    [K in keyof Omit<T, "$case">]?: DeepPartial<T[K]>;
+} & {
+    $case: T["$case"];
+} : T extends {} ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : Partial<T>;
+type KeysOfUnion<T> = T extends T ? keyof T : never;
+export type Exact<P, I extends P> = P extends Builtin ? P : P & {
+    [K in keyof P]: Exact<P[K], I[K]>;
+} & {
+    [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
+};
+export {};