@dcl/sdk 7.0.0-2982061039.commit-9cc9ea8 → 7.0.0-3008112906.commit-524d1bd

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dcl/sdk",
-  "version": "7.0.0-2982061039.commit-9cc9ea8",
+  "version": "7.0.0-3008112906.commit-524d1bd",
   "description": "",
   "main": "dist/src/index.js",
   "typings": "dist/index.d.ts",
@@ -27,9 +27,9 @@
     "src/cli/**/*.js"
   ],
   "dependencies": {
-    "@dcl/amd": "6.11.7-2982061039.commit-9cc9ea8",
-    "@dcl/build-ecs": "6.11.7-2982061039.commit-9cc9ea8",
-    "@dcl/kernel": "1.0.0-2638443584.commit-696a74b",
+    "@dcl/amd": "6.11.7-3008112906.commit-524d1bd",
+    "@dcl/build-ecs": "6.11.7-3008112906.commit-524d1bd",
+    "@dcl/kernel": "1.0.0-2994874542.commit-c3ae489",
     "@dcl/posix": "^1.0.4",
     "@dcl/schemas": "4.8.0",
     "@dcl/unity-renderer": "^1.0.40531-20220621125654.commit-472137e",
@@ -38,5 +38,5 @@
     "ignore": "^5.1.8"
   },
   "minCliVersion": "3.10.2",
-  "commit": "9cc9ea8eafb942a535f33ed483b653c88720ecb2"
+  "commit": "524d1bd3c7f72f177f73f7cf5298aaaf1d79f4c7"
 }

package/types/ecs7/index.d.ts

@@ -1,3 +1,5 @@
+/// <reference types="@dcl/posix" />
+
 declare const enum ActionButton {
     POINTER = 0,
     PRIMARY = 1,
@@ -1434,6 +1436,248 @@ declare const NFTShape: ComponentDefinition<ISchema<PBNFTShape>, PBNFTShape>;
 /** @public */
 declare type Nullable<T> = T | null;
 
+/**
+ * The Observable class is a simple implementation of the Observable pattern.
+ *
+ * There's one slight particularity though: a given Observable can notify its observer using a particular mask value, only the Observers registered with this mask value will be notified.
+ * This enable a more fine grained execution without having to rely on multiple different Observable objects.
+ * For instance you may have a given Observable that have four different types of notifications: Move (mask = 0x01), Stop (mask = 0x02), Turn Right (mask = 0X04), Turn Left (mask = 0X08).
+ * A given observer can register itself with only Move and Stop (mask = 0x03), then it will only be notified when one of these two occurs and will never be for Turn Left/Right.
+ *
+ * @deprecated This function is an inheritance of ECS6, it's here temporary for the feature parity, please read the news and docs to know how handle when it's removed
+ */
+declare class Observable<T> {
+    private _observers;
+    private _eventState;
+    private _onObserverAdded;
+    /**
+     * Creates a new observable
+     * @param onObserverAdded - defines a callback to call when a new observer is added
+     */
+    constructor(onObserverAdded?: (observer: Observer<T>) => void);
+    /**
+     * Create a new Observer with the specified callback
+     * @param callback - the callback that will be executed for that Observer
+     * @param mask - the mask used to filter observers
+     * @param insertFirst - if true the callback will be inserted at the first position, hence executed before the others ones. If false (default behavior) the callback will be inserted at the last position, executed after all the others already present.
+     * @param scope - optional scope for the callback to be called from
+     * @param unregisterOnFirstCall - defines if the observer as to be unregistered after the next notification
+     * @returns the new observer created for the callback
+     */
+    add(callback: (eventData: T, eventState: ObserverEventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): null | Observer<T>;
+    /**
+     * Create a new Observer with the specified callback and unregisters after the next notification
+     * @param callback - the callback that will be executed for that Observer
+     * @returns the new observer created for the callback
+     */
+    addOnce(callback: (eventData: T, eventState: ObserverEventState) => void): null | Observer<T>;
+    /**
+     * Remove an Observer from the Observable object
+     * @param observer - the instance of the Observer to remove
+     * @returns false if it doesn't belong to this Observable
+     */
+    remove(observer: null | Observer<T>): boolean;
+    /**
+     * Remove a callback from the Observable object
+     * @param callback - the callback to remove
+     * @param scope - optional scope. If used only the callbacks with this scope will be removed
+     * @returns false if it doesn't belong to this Observable
+     */
+    removeCallback(callback: (eventData: T, eventState: ObserverEventState) => void, scope?: any): boolean;
+    /**
+     * Notify all Observers by calling their respective callback with the given data
+     * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
+     * @param eventData - defines the data to send to all observers
+     * @param mask - defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
+     * @param target - defines the original target of the state
+     * @param currentTarget - defines the current target of the state
+     * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
+     */
+    notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
+    /**
+     * Calling this will execute each callback, expecting it to be a promise or return a value.
+     * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
+     * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
+     * and it is crucial that all callbacks will be executed.
+     * The order of the callbacks is kept, callbacks are not executed parallel.
+     *
+     * @param eventData - The data to be sent to each callback
+     * @param mask - is used to filter observers defaults to -1
+     * @param target - defines the callback target (see EventState)
+     * @param currentTarget - defines he current object in the bubbling phase
+     * @returns will return a Promise than resolves when all callbacks executed successfully.
+     */
+    notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
+    /**
+     * Notify a specific observer
+     * @param observer - defines the observer to notify
+     * @param eventData - defines the data to be sent to each callback
+     * @param mask - is used to filter observers defaults to -1
+     */
+    notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
+    /**
+     * Gets a boolean indicating if the observable has at least one observer
+     * @returns true is the Observable has at least one Observer registered
+     */
+    hasObservers(): boolean;
+    /**
+     * Clear the list of observers
+     */
+    clear(): void;
+    /**
+     * Clone the current observable
+     * @returns a new observable
+     */
+    clone(): Observable<T>;
+    /**
+     * Does this observable handles observer registered with a given mask
+     * @param mask - defines the mask to be tested
+     * @returns whether or not one observer registered with the given mask is handeled
+     */
+    hasSpecificMask(mask?: number): boolean;
+    private _deferUnregister;
+    private _remove;
+}
+
+/**
+ * Represent an Observer registered to a given Observable object.
+ * @deprecated This function is an inheritance of ECS6, it's here temporary for the feature parity, please read the news and docs to know how handle when it's removed
+ */
+declare class Observer<T> {
+    /**
+     * Defines the callback to call when the observer is notified
+     */
+    callback: (eventData: T, eventState: ObserverEventState) => void;
+    /**
+     * Defines the mask of the observer (used to filter notifications)
+     */
+    mask: number;
+    /**
+     * Defines the current scope used to restore the JS context
+     */
+    scope: any;
+    /**
+     * Gets or sets a property defining that the observer as to be unregistered after the next notification
+     */
+    unregisterOnNextCall: boolean;
+    /** For internal usage */
+    _willBeUnregistered: boolean;
+    /**
+     * Creates a new observer
+     * @param callback - defines the callback to call when the observer is notified
+     * @param mask - defines the mask of the observer (used to filter notifications)
+     * @param scope - defines the current scope used to restore the JS context
+     */
+    constructor(
+    /**
+     * Defines the callback to call when the observer is notified
+     */
+    callback: (eventData: T, eventState: ObserverEventState) => void, 
+    /**
+     * Defines the mask of the observer (used to filter notifications)
+     */
+    mask: number, 
+    /**
+     * Defines the current scope used to restore the JS context
+     */
+    scope?: any);
+}
+
+/**
+ * A class serves as a medium between the observable and its observers
+ * @deprecated This function is an inheritance of ECS6, it's here temporary for the feature parity, please read the news and docs to know how handle when it's removed
+ */
+declare class ObserverEventState {
+    /**
+     * An Observer can set this property to true to prevent subsequent observers of being notified
+     */
+    skipNextObservers: boolean;
+    /**
+     * Get the mask value that were used to trigger the event corresponding to this EventState object
+     */
+    mask: number;
+    /**
+     * The object that originally notified the event
+     */
+    target?: any;
+    /**
+     * The current object in the bubbling phase
+     */
+    currentTarget?: any;
+    /**
+     * This will be populated with the return value of the last function that was executed.
+     * If it is the first function in the callback chain it will be the event data.
+     */
+    lastReturnValue?: any;
+    /**
+     * Create a new EventState
+     * @param mask - defines the mask associated with this state
+     * @param skipNextObservers - defines a flag which will instruct the observable to skip following observers when set to true
+     * @param target - defines the original target of the state
+     * @param currentTarget - defines the current target of the state
+     */
+    constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
+    /**
+     * Initialize the current event state
+     * @param mask - defines the mask associated with this state
+     * @param skipNextObservers - defines a flag which will instruct the observable to skip following observers when set to true
+     * @param target - defines the original target of the state
+     * @param currentTarget - defines the current target of the state
+     * @returns the current event state
+     */
+    initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): ObserverEventState;
+}
+
+/**
+ * This event is triggered when you change your camera between 1st and 3rd person
+ * @public
+ * @deprecated This function is an inheritance of ECS6, it's here temporary for the feature parity, please read the news and docs to know how handle when it's removed.
+ */
+declare const onCameraModeChangedObservable: Observable<{
+    cameraMode: 0 | 1 | 2;
+}>;
+
+/** @public
+ * @deprecated This function is an inheritance of ECS6, it's here temporary for the feature parity, please read the news and docs to know how handle when it's removed.
+ * @deprecated This function is an inheritance of ECS6, it's here temporary for the feature parity, please read the news and docs to know how handle when it's removed. Use onEnterSceneObservable instead. */
+declare const onEnterScene: Observable<{
+    userId: string;
+}>;
+
+/**
+ * These events are triggered after your character enters the scene.
+ * @public
+ * @deprecated This function is an inheritance of ECS6, it's here temporary for the feature parity, please read the news and docs to know how handle when it's removed.
+ */
+declare const onEnterSceneObservable: Observable<{
+    userId: string;
+}>;
+
+/**
+ * This event is triggered when you change your camera between 1st and 3rd person
+ * @public
+ * @deprecated This function is an inheritance of ECS6, it's here temporary for the feature parity, please read the news and docs to know how handle when it's removed.
+ */
+declare const onIdleStateChangedObservable: Observable<{
+    isIdle: boolean;
+}>;
+
+/** @public
+ * @deprecated This function is an inheritance of ECS6, it's here temporary for the feature parity, please read the news and docs to know how handle when it's removed.
+ * @deprecated This function is an inheritance of ECS6, it's here temporary for the feature parity, please read the news and docs to know how handle when it's removed. Use onLeaveSceneObservable instead. */
+declare const onLeaveScene: Observable<{
+    userId: string;
+}>;
+
+/**
+ * These events are triggered after your character leaves the scene.
+ * @public
+ * @deprecated This function is an inheritance of ECS6, it's here temporary for the feature parity, please read the news and docs to know how handle when it's removed.
+ */
+declare const onLeaveSceneObservable: Observable<{
+    userId: string;
+}>;
+
 declare type OnlyNonUndefinedTypes<T> = {
     [K in ExcludeUndefined<T>]: T[K];
 };
@@ -1442,18 +1686,102 @@ declare type OnlyOptionalUndefinedTypes<T> = {
     [K in IncludeUndefined<T>]?: T[K];
 };
 
+/**
+ * @public
+ * @deprecated This function is an inheritance of ECS6, it's here temporary for the feature parity, please read the news and docs to know how handle when it's removed.
+ */
+declare const onPlayerClickedObservable: Observable<{
+    userId: string;
+    ray: {
+        origin: ReadOnlyVector3;
+        direction: ReadOnlyVector3;
+        distance: number;
+    };
+}>;
+
+/**
+ * @public
+ * @deprecated This function is an inheritance of ECS6, it's here temporary for the feature parity, please read the news and docs to know how handle when it's removed.
+ */
+declare const onPlayerConnectedObservable: Observable<{
+    userId: string;
+}>;
+
+/**
+ * @public
+ * @deprecated This function is an inheritance of ECS6, it's here temporary for the feature parity, please read the news and docs to know how handle when it's removed.
+ */
+declare const onPlayerDisconnectedObservable: Observable<{
+    userId: string;
+}>;
+
+/**
+ * @public
+ * @deprecated This function is an inheritance of ECS6, it's here temporary for the feature parity, please read the news and docs to know how handle when it's removed.
+ */
+declare const onPlayerExpressionObservable: Observable<{
+    expressionId: string;
+}>;
+
 /** @public */
 declare const OnPointerDown: ComponentDefinition<ISchema<PBOnPointerDown>, PBOnPointerDown>;
 
 /** @public */
 declare const OnPointerDownResult: ComponentDefinition<ISchema<PBOnPointerDownResult>, PBOnPointerDownResult>;
 
+/**
+ * @public
+ * @deprecated This function is an inheritance of ECS6, it's here temporary for the feature parity, please read the news and docs to know how handle when it's removed.
+ */
+declare const onPointerLockedStateChange: Observable<{
+    locked?: boolean | undefined;
+}>;
+
 /** @public */
 declare const OnPointerUp: ComponentDefinition<ISchema<PBOnPointerUp>, PBOnPointerUp>;
 
 /** @public */
 declare const OnPointerUpResult: ComponentDefinition<ISchema<PBOnPointerUpResult>, PBOnPointerUpResult>;
 
+/**
+ * @public
+ * @deprecated This function is an inheritance of ECS6, it's here temporary for the feature parity, please read the news and docs to know how handle when it's removed.
+ */
+declare const onProfileChanged: Observable<{
+    ethAddress: string;
+    version: number;
+}>;
+
+/**
+ * @public
+ * @deprecated This function is an inheritance of ECS6, it's here temporary for the feature parity, please read the news and docs to know how handle when it's removed.
+ */
+declare const onRealmChangedObservable: Observable<{
+    domain: string;
+    room: string;
+    serverName: string;
+    displayName: string;
+}>;
+
+/**
+ * This event is triggered after all the resources of the scene were loaded (models, textures, etc...)
+ * @public
+ * @deprecated This function is an inheritance of ECS6, it's here temporary for the feature parity, please read the news and docs to know how handle when it's removed.
+ */
+declare const onSceneReadyObservable: Observable<{}>;
+
+/**
+ * @public
+ * @deprecated This function is an inheritance of ECS6, it's here temporary for the feature parity, please read the news and docs to know how handle when it's removed.
+ */
+declare const onVideoEvent: Observable<{
+    componentId: string;
+    videoClipId: string;
+    videoStatus: number;
+    currentOffset: number;
+    totalVideoLength: number;
+}>;
+
 /**
  * Defines potential orientation for back face culling
  * @public

package/types/rpc-modules/CommunicationsController/index.d.ts

@@ -0,0 +1,14 @@
+declare module "~system/CommunicationsController" {
+
+    export interface RealSendRequest {
+        message: string;
+    }
+    export interface RealSendResponse {
+    }
+
+// ########### BLOCK 
+
+    // importtype { RealSendRequest, RealSendResponse } from "proto/CommunicationsController.gen";
+    export function send(body: RealSendRequest): Promise<RealSendResponse>;
+
+}

package/types/rpc-modules/DevTools/index.d.ts

@@ -0,0 +1,15 @@
+declare module "~system/DevTools" {
+
+    export interface DevToolsBody {
+        type: string;
+        jsonPayload: string;
+    }
+    export interface EventResponse {
+    }
+
+// ########### BLOCK 
+
+    // importtype { DevToolsBody, EventResponse } from "proto/DevTools.gen";
+    export function event(body: DevToolsBody): Promise<EventResponse>;
+
+}

package/types/rpc-modules/EngineAPI/index.d.ts

@@ -0,0 +1,160 @@
+declare module "~system/EngineAPI" {
+
+    export enum QueryType {
+        InvalidQueryType = 0,
+        HitFirst = 1,
+        HitAll = 2,
+        HitFirstAvatar = 3,
+        HitAllAvatars = 4,
+        UNRECOGNIZED = -1
+    }
+    export enum EAType {
+        InvalidEAType = 0,
+        OpenExternalUrl = 1,
+        OpenNFTDialog = 2,
+        CreateEntity = 3,
+        RemoveEntity = 4,
+        UpdateEntityComponent = 5,
+        AttachEntityComponent = 6,
+        ComponentRemoved = 7,
+        SetEntityParent = 8,
+        Query = 9,
+        ComponentCreated = 10,
+        ComponentDisposed = 11,
+        ComponentUpdated = 12,
+        InitMessagesFinished = 13,
+        UNRECOGNIZED = -1
+    }
+    /** Events */
+    export enum EventDataType {
+        Generic = 0,
+        PositionChanged = 1,
+        RotationChanged = 2,
+        UNRECOGNIZED = -1
+    }
+    export interface OpenExternalUrlBody {
+        url: string;
+    }
+    export interface OpenNFTDialogBody {
+        assetContractAddress: string;
+        tokenId: string;
+        comment?: string | undefined;
+    }
+    export interface CreateEntityBody {
+        id: string;
+    }
+    export interface RemoveEntityBody {
+        id: string;
+    }
+    export interface UpdateEntityComponentBody {
+        entityId: string;
+        classId: number;
+        name: string;
+        json: string;
+    }
+    export interface AttachEntityComponentBody {
+        entityId: string;
+        name: string;
+        id: string;
+    }
+    export interface ComponentRemovedBody {
+        entityId: string;
+        name: string;
+    }
+    export interface SetEntityParentBody {
+        entityId: string;
+        parentId: string;
+    }
+    export interface QueryBody {
+        queryId: QueryType;
+        payload: string;
+    }
+    export interface ComponentCreatedBody {
+        id: string;
+        classId: number;
+        name: string;
+    }
+    export interface ComponentDisposedBody {
+        id: string;
+    }
+    export interface ComponentUpdatedBody {
+        id: string;
+        json: string;
+    }
+    export interface InitMessagesFinishedBody {
+    }
+    export interface Payload {
+        openExternalUrl?: OpenExternalUrlBody | undefined;
+        openNftDialog?: OpenNFTDialogBody | undefined;
+        createEntity?: CreateEntityBody | undefined;
+        removeEntity?: RemoveEntityBody | undefined;
+        updateEntityComponent?: UpdateEntityComponentBody | undefined;
+        attachEntityComponent?: AttachEntityComponentBody | undefined;
+        componentRemoved?: ComponentRemovedBody | undefined;
+        setEntityParent?: SetEntityParentBody | undefined;
+        query?: QueryBody | undefined;
+        componentCreated?: ComponentCreatedBody | undefined;
+        componentDisposed?: ComponentDisposedBody | undefined;
+        componentUpdated?: ComponentUpdatedBody | undefined;
+        initMessagesFinished?: InitMessagesFinishedBody | undefined;
+    }
+    export interface EntityAction {
+        type: EAType;
+        tag?: string | undefined;
+        payload: Payload | undefined;
+    }
+    export interface ManyEntityAction {
+        actions: EntityAction[];
+    }
+    export interface SendBatchResponse {
+        events: EventData[];
+    }
+    export interface UnsubscribeRequest {
+        eventId: string;
+    }
+    export interface SubscribeRequest {
+        eventId: string;
+    }
+    export interface SubscribeResponse {
+    }
+    export interface UnsubscribeResponse {
+    }
+    export interface GenericPayload {
+        eventId: string;
+        eventData: string;
+    }
+    export interface ReadOnlyVector3 {
+        x: number;
+        y: number;
+        z: number;
+    }
+    export interface ReadOnlyQuaternion {
+        x: number;
+        y: number;
+        z: number;
+        w: number;
+    }
+    export interface PositionChangedPayload {
+        position: ReadOnlyVector3 | undefined;
+        cameraPosition: ReadOnlyVector3 | undefined;
+        playerHeight: number;
+    }
+    export interface RotationChangedPayload {
+        rotation: ReadOnlyVector3 | undefined;
+        quaternion: ReadOnlyQuaternion | undefined;
+    }
+    export interface EventData {
+        type: EventDataType;
+        generic?: GenericPayload | undefined;
+        positionChanged?: PositionChangedPayload | undefined;
+        rotationChanged?: RotationChangedPayload | undefined;
+    }
+
+// ########### BLOCK 
+
+    // importtype { ManyEntityAction, SendBatchResponse, SubscribeRequest, SubscribeResponse, UnsubscribeRequest, UnsubscribeResponse } from "proto/EngineAPI.gen";
+    export function sendBatch(body: ManyEntityAction): Promise<SendBatchResponse>;
+    export function subscribe(body: SubscribeRequest): Promise<SubscribeResponse>;
+    export function unsubscribe(body: UnsubscribeRequest): Promise<UnsubscribeResponse>;
+
+}

package/types/rpc-modules/EnvironmentAPI/index.d.ts

@@ -0,0 +1,81 @@
+declare module "~system/EnvironmentAPI" {
+
+    
+    export interface ContentMapping {
+        file: string;
+        hash: string;
+    }
+
+// ########### BLOCK 
+
+    // importtype { ContentMapping } from "proto/common/ContentMapping.gen";
+    export interface MinimalRunnableEntity {
+        content: ContentMapping[];
+        metadataJson: string;
+    }
+    export interface BootstrapDataResponse {
+        id: string;
+        baseUrl: string;
+        entity: MinimalRunnableEntity | undefined;
+        useFPSThrottling: boolean;
+    }
+    export interface PreviewModeResponse {
+        isPreview: boolean;
+    }
+    export interface AreUnsafeRequestAllowedResponse {
+        status: boolean;
+    }
+    export interface GetPlatformResponse {
+        platform: string;
+    }
+    export interface EnvironmentRealm {
+        domain: string;
+        layer: string;
+        room: string;
+        serverName: string;
+        displayName: string;
+        protocol: string;
+    }
+    export interface GetCurrentRealmResponse {
+        currentRealm?: EnvironmentRealm | undefined;
+    }
+    export interface GetExplorerConfigurationResponse {
+        clientUri: string;
+        configurations: {
+            [key: string]: string;
+        };
+    }
+    export interface GetExplorerConfigurationResponse_ConfigurationsEntry {
+        key: string;
+        value: string;
+    }
+    export interface GetDecentralandTimeResponse {
+        seconds: number;
+    }
+    export interface GetBootstrapDataRequest {
+    }
+    export interface IsPreviewModeRequest {
+    }
+    export interface GetPlatformRequest {
+    }
+    export interface AreUnsafeRequestAllowedRequest {
+    }
+    export interface GetCurrentRealmRequest {
+    }
+    export interface GetExplorerConfigurationRequest {
+    }
+    export interface GetDecentralandTimeRequest {
+    }
+
+// ########### BLOCK 
+
+    // importtype { GetBootstrapDataRequest, BootstrapDataResponse, IsPreviewModeRequest, PreviewModeResponse, GetPlatformRequest, GetPlatformResponse, AreUnsafeRequestAllowedRequest, AreUnsafeRequestAllowedResponse, GetCurrentRealmRequest, GetCurrentRealmResponse, GetExplorerConfigurationRequest, GetExplorerConfigurationResponse, GetDecentralandTimeRequest, GetDecentralandTimeResponse } from "proto/EnvironmentAPI.gen";
+    export function getBootstrapData(body: GetBootstrapDataRequest): Promise<BootstrapDataResponse>;
+    export function isPreviewMode(body: IsPreviewModeRequest): Promise<PreviewModeResponse>;
+    export function getPlatform(body: GetPlatformRequest): Promise<GetPlatformResponse>;
+    export function areUnsafeRequestAllowed(body: AreUnsafeRequestAllowedRequest): Promise<AreUnsafeRequestAllowedResponse>;
+    export function getCurrentRealm(body: GetCurrentRealmRequest): Promise<GetCurrentRealmResponse>;
+    export function getExplorerConfiguration(body: GetExplorerConfigurationRequest): Promise<GetExplorerConfigurationResponse>;
+    export function getDecentralandTime(body: GetDecentralandTimeRequest): Promise<GetDecentralandTimeResponse>;
+
+}