@3dverse/livelink.core 0.8.0 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +61 -17
- package/dist/_prebuild/EditorConnection.d.ts +1 -29
- package/dist/_prebuild/EditorMessageHandler.d.ts +1 -139
- package/dist/_prebuild/GatewayConnection.d.ts +1 -64
- package/dist/_prebuild/GatewayMessageHandler.d.ts +1 -197
- package/dist/_prebuild/engine_types/ComponentsHashes.d.ts +5 -0
- package/dist/_prebuild/{types → engine_types}/ComponentsRecord.d.ts +65 -44
- package/dist/_prebuild/{types → engine_types}/assets.d.ts +69 -0
- package/dist/_prebuild/{types → engine_types}/components.d.ts +164 -164
- package/dist/_prebuild/messages/editor/ConnectConfirmation.d.ts +1 -71
- package/dist/_prebuild/messages/editor/EditorEntity.d.ts +1 -75
- package/dist/_prebuild/messages/editor/EntityUpdatedEvent.d.ts +1 -7
- package/dist/_prebuild/messages/editor/EntityVisibilityChangedEvent.d.ts +1 -8
- package/dist/_prebuild/messages/editor/UpdateComponentsCommand.d.ts +1 -6
- package/dist/_prebuild/messages/editor/index.d.ts +0 -1
- package/dist/_prebuild/messages/gateway/commands/AssignClientToScriptCommand.d.ts +9 -0
- package/dist/_prebuild/messages/gateway/commands/AuthenticationCommand.d.ts +1 -0
- package/dist/_prebuild/messages/gateway/{ClientConfig.d.ts → commands/ConfigureClientCommand.d.ts} +11 -13
- package/dist/_prebuild/messages/gateway/commands/FireEventCommand.d.ts +11 -0
- package/dist/_prebuild/messages/gateway/commands/HighlightEntitiesCommand.d.ts +8 -0
- package/dist/_prebuild/messages/gateway/commands/InputStateCommand.d.ts +8 -0
- package/dist/_prebuild/messages/gateway/commands/RemoveComponentsCommand.d.ts +1 -0
- package/dist/_prebuild/messages/gateway/commands/RemoveFilterCommand.d.ts +7 -0
- package/dist/_prebuild/messages/gateway/commands/ResizeCommand.d.ts +13 -0
- package/dist/_prebuild/messages/gateway/commands/SendSkeletonPoseCommand.d.ts +25 -0
- package/dist/_prebuild/messages/gateway/commands/SetFilterCommand.d.ts +8 -0
- package/dist/_prebuild/messages/gateway/commands/ToggleFilterCommand.d.ts +8 -0
- package/dist/_prebuild/messages/gateway/commands/UpdateEntitiesFromBytesCommand.d.ts +1 -0
- package/dist/_prebuild/messages/gateway/commands/UpdateEntitiesFromJsonCommand.d.ts +1 -0
- package/dist/_prebuild/messages/gateway/commands/ViewportConfigCommand.d.ts +16 -0
- package/dist/_prebuild/messages/gateway/commands/index.d.ts +15 -0
- package/dist/_prebuild/messages/gateway/enums.d.ts +8 -115
- package/dist/_prebuild/messages/gateway/events/AssetLoadingEvent.d.ts +1 -0
- package/dist/_prebuild/messages/gateway/events/FrameDataEvent.d.ts +26 -0
- package/dist/_prebuild/messages/gateway/events/ScriptEvent.d.ts +10 -0
- package/dist/_prebuild/messages/gateway/events/index.d.ts +3 -0
- package/dist/_prebuild/messages/gateway/index.d.ts +16 -22
- package/dist/_prebuild/messages/gateway/queries/ScreenSpaceRayQuery.d.ts +18 -0
- package/dist/_prebuild/messages/gateway/queries/index.d.ts +1 -0
- package/dist/_prebuild/messages/index.d.ts +2 -0
- package/dist/library.cjs +1 -1
- package/dist/library.cjs.map +4 -4
- package/dist/library.mjs +1 -1
- package/dist/library.mjs.map +4 -4
- package/dist/sources/ActivityWatcher.d.ts +40 -21
- package/dist/sources/CoreEvents.d.ts +35 -0
- package/dist/sources/DynamicLoader.d.ts +38 -0
- package/dist/sources/EntityUtils.d.ts +117 -0
- package/dist/sources/LivelinkCore.d.ts +130 -126
- package/dist/sources/{interfaces/SessionInterface.d.ts → SessionInterface.d.ts} +2 -6
- package/dist/sources/TypedEventTarget.d.ts +14 -0
- package/dist/sources/controllers/EditorController.d.ts +1 -21
- package/dist/sources/controllers/EditorEvents.d.ts +27 -0
- package/dist/sources/controllers/GatewayController.d.ts +1 -60
- package/dist/sources/controllers/GatewayEvents.d.ts +54 -0
- package/dist/sources/core.d.ts +12 -11
- package/dist/sources/internal/RequestHandler.d.ts +1 -0
- package/dist/sources/internal/Serializer.d.ts +1 -0
- package/dist/sources/library.d.ts +1 -1
- package/dist/sources/types/RTID.d.ts +6 -21
- package/dist/sources/types/UUID.d.ts +11 -21
- package/dist/sources/types/dataObjects.d.ts +1 -1
- package/dist/sources/types/index.d.ts +1 -0
- package/dist/sources/types/math.d.ts +1 -105
- package/dist/sources/types/nativeTypes.d.ts +0 -132
- package/dist/sources/types/utils.d.ts +19 -0
- package/package.json +6 -4
- package/dist/_prebuild/enums.d.ts +0 -6
- package/dist/_prebuild/messages/editor/EntityCreationCoreOptions.d.ts +0 -6
- package/dist/_prebuild/messages/gateway/AssetLoadingEvent.d.ts +0 -14
- package/dist/_prebuild/messages/gateway/AssignClientToScriptMessage.d.ts +0 -22
- package/dist/_prebuild/messages/gateway/AuthenticationResponse.d.ts +0 -31
- package/dist/_prebuild/messages/gateway/ClientConfigResponse.d.ts +0 -16
- package/dist/_prebuild/messages/gateway/FireEventMessage.d.ts +0 -23
- package/dist/_prebuild/messages/gateway/FrameData.d.ts +0 -42
- package/dist/_prebuild/messages/gateway/HighlightEntitiesMessage.d.ts +0 -22
- package/dist/_prebuild/messages/gateway/InputState.d.ts +0 -22
- package/dist/_prebuild/messages/gateway/RemoveComponentsCommand.d.ts +0 -23
- package/dist/_prebuild/messages/gateway/RemoveFilterMessage.d.ts +0 -19
- package/dist/_prebuild/messages/gateway/ResizeResponse.d.ts +0 -14
- package/dist/_prebuild/messages/gateway/ScreenSpaceRayQuery.d.ts +0 -30
- package/dist/_prebuild/messages/gateway/ScreenSpaceRayResult.d.ts +0 -16
- package/dist/_prebuild/messages/gateway/ScriptEvent.d.ts +0 -17
- package/dist/_prebuild/messages/gateway/SendSkeletonPoseMessage.d.ts +0 -28
- package/dist/_prebuild/messages/gateway/SessionAuth.d.ts +0 -8
- package/dist/_prebuild/messages/gateway/SetFilterMessage.d.ts +0 -20
- package/dist/_prebuild/messages/gateway/ToggleFilterMessage.d.ts +0 -20
- package/dist/_prebuild/messages/gateway/UpdateEntitiesFromBytesMessage.d.ts +0 -25
- package/dist/_prebuild/messages/gateway/UpdateEntitiesFromJsonMessage.d.ts +0 -23
- package/dist/_prebuild/messages/gateway/ViewportConfig.d.ts +0 -30
- package/dist/_prebuild/types/ComponentsHashes.d.ts +0 -53
- package/dist/sources/LivelinkCoreModule.d.ts +0 -39
- package/dist/sources/RequestHandler.d.ts +0 -49
- package/dist/sources/Serializer.d.ts +0 -34
- package/dist/sources/interfaces/ClientInterface.d.ts +0 -12
- package/dist/sources/interfaces/EntityInterface.d.ts +0 -20
- package/dist/sources/interfaces/index.d.ts +0 -3
- /package/dist/_prebuild/{types → engine_types}/SceneSettingsRecord.d.ts +0 -0
- /package/dist/_prebuild/{types → engine_types}/sceneSettings.d.ts +0 -0
package/README.md
CHANGED
|
@@ -1,26 +1,70 @@
|
|
|
1
|
-
# Livelink
|
|
1
|
+
# Livelink Core Library
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://badge.fury.io/js/@3dverse%2Flivelink.core)
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
## Overview
|
|
6
6
|
|
|
7
|
-
-
|
|
8
|
-
- Client
|
|
9
|
-
- Entity
|
|
7
|
+
The **Livelink protocol** enables communication between a client and a 3dverse server using a message-based, binary format. This protocol evolves alongside server updates, necessitating a dynamically loaded implementation rather than embedding it directly in client applications.
|
|
10
8
|
|
|
11
|
-
|
|
9
|
+
This package, the **Livelink Core library**, provides:
|
|
12
10
|
|
|
13
|
-
-
|
|
14
|
-
-
|
|
15
|
-
- Math
|
|
11
|
+
- Minimal code to dynamically load the full library from a CDN.
|
|
12
|
+
- TypeScript type definitions for protocol integration.
|
|
16
13
|
|
|
17
|
-
|
|
14
|
+
## How It Works
|
|
18
15
|
|
|
19
|
-
|
|
20
|
-
- Editor
|
|
21
|
-
- Enums
|
|
16
|
+
The **Livelink Core library** package primarily offers TypeScript type definitions. The only functional code it includes is the `DynamicLoader` module, which dynamically retrieves the remaining library code from the CDN.
|
|
22
17
|
|
|
23
|
-
###
|
|
18
|
+
### Key Features:
|
|
24
19
|
|
|
25
|
-
-
|
|
26
|
-
-
|
|
20
|
+
- Always loads an up-to-date version of the Livelink protocol.
|
|
21
|
+
- Ensures **forward compatibility** for all client applications.
|
|
22
|
+
|
|
23
|
+
By dynamically loading the library, this system guarantees smooth communication with the server, regardless of server-side updates.
|
|
24
|
+
|
|
25
|
+
## Usage
|
|
26
|
+
|
|
27
|
+
> **⚠ Warning: This library is not meant for direct use.**
|
|
28
|
+
> Refer to the [@3dverse/livelink](https://www.npmjs.com/package/@3dverse/livelink) package for a practical implementation.
|
|
29
|
+
|
|
30
|
+
### Installation
|
|
31
|
+
|
|
32
|
+
To install the package, run:
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
npm install @3dverse/livelink.core
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### Loading the Library
|
|
39
|
+
|
|
40
|
+
Import the DynamicLoader module:
|
|
41
|
+
|
|
42
|
+
```typescript
|
|
43
|
+
import { DynamicLoader } from "@3dverse/livelink.core";
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Before using any other features, call the load static method:
|
|
47
|
+
|
|
48
|
+
```typescript
|
|
49
|
+
await DynamicLoader.load();
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### Using the Core
|
|
53
|
+
|
|
54
|
+
Once the library is loaded, create a new instance of the core using the `Core()` static method:
|
|
55
|
+
|
|
56
|
+
```typescript
|
|
57
|
+
const core = new DynamicLoader.Core();
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
This instance contains the full implementation of the Livelink protocol.
|
|
61
|
+
|
|
62
|
+
## Protocol
|
|
63
|
+
|
|
64
|
+
A formal specification of the Livelink protocol is not yet published. The protocol primarily revolves around:
|
|
65
|
+
|
|
66
|
+
- Commands: Instructions sent to the server.
|
|
67
|
+
- Queries: Requests for information addressed to the server.
|
|
68
|
+
- Events: Notifications received from the server.
|
|
69
|
+
|
|
70
|
+
Stay tuned for updates as the protocol evolves.
|
|
@@ -3,32 +3,4 @@
|
|
|
3
3
|
* This file has been generated automatically from its AsyncAPI spec file.
|
|
4
4
|
* See : https://gitlab.com/3dverse/platform/libs/js/asyncapi-server-generator
|
|
5
5
|
*/
|
|
6
|
-
|
|
7
|
-
/**
|
|
8
|
-
* Holds the connection to the Livelink Broadcast & Persistence server.
|
|
9
|
-
*/
|
|
10
|
-
export declare class EditorConnection {
|
|
11
|
-
#private;
|
|
12
|
-
/**
|
|
13
|
-
* Constructs a connection linked to the specified message handler.
|
|
14
|
-
*/
|
|
15
|
-
constructor({ handler }: {
|
|
16
|
-
handler: EditorMessageHandler;
|
|
17
|
-
});
|
|
18
|
-
/**
|
|
19
|
-
* Opens a connection to the Livelink server.
|
|
20
|
-
*/
|
|
21
|
-
connect({ livelink_url }: {
|
|
22
|
-
livelink_url: string;
|
|
23
|
-
}): Promise<void>;
|
|
24
|
-
/**
|
|
25
|
-
*
|
|
26
|
-
*/
|
|
27
|
-
send({ data }: {
|
|
28
|
-
data: ArrayBufferLike | string;
|
|
29
|
-
}): void;
|
|
30
|
-
/**
|
|
31
|
-
*
|
|
32
|
-
*/
|
|
33
|
-
disconnect(): void;
|
|
34
|
-
}
|
|
6
|
+
export {};
|
|
@@ -1,139 +1 @@
|
|
|
1
|
-
|
|
2
|
-
import { EntityInterface } from "../sources/interfaces/EntityInterface";
|
|
3
|
-
import { ConnectConfirmation, EditorEntity, EntityCreationCoreOptions, EntityUpdatedEvent, EntityVisibilityChangedEvent, UpdateComponentsCommand } from "./messages/editor";
|
|
4
|
-
import { ComponentType } from "./types/ComponentsRecord";
|
|
5
|
-
/**
|
|
6
|
-
* This follows the Livelink protocol specifications for the broker messages.
|
|
7
|
-
*/
|
|
8
|
-
export declare class EditorMessageHandler extends EventTarget {
|
|
9
|
-
#private;
|
|
10
|
-
/**
|
|
11
|
-
*
|
|
12
|
-
*/
|
|
13
|
-
protected _client_id: UUID | null;
|
|
14
|
-
/**
|
|
15
|
-
*
|
|
16
|
-
*/
|
|
17
|
-
get client_id(): string | null;
|
|
18
|
-
/**
|
|
19
|
-
*
|
|
20
|
-
*/
|
|
21
|
-
protected _connect({ livelink_url }: {
|
|
22
|
-
livelink_url: string;
|
|
23
|
-
}): void;
|
|
24
|
-
/**
|
|
25
|
-
*
|
|
26
|
-
*/
|
|
27
|
-
protected _disconnect(): void;
|
|
28
|
-
/**
|
|
29
|
-
*
|
|
30
|
-
*/
|
|
31
|
-
spawnEntity({ entity, options }: {
|
|
32
|
-
entity: EntityInterface;
|
|
33
|
-
options?: EntityCreationCoreOptions;
|
|
34
|
-
}): Promise<EditorEntity[]>;
|
|
35
|
-
/**
|
|
36
|
-
*
|
|
37
|
-
*/
|
|
38
|
-
createEntities({ entities, options }: {
|
|
39
|
-
entities: Array<EntityInterface>;
|
|
40
|
-
options?: EntityCreationCoreOptions;
|
|
41
|
-
}): Promise<EditorEntity[]>;
|
|
42
|
-
onEntitiesCreated(data: Array<EditorEntity>): void;
|
|
43
|
-
/**
|
|
44
|
-
*
|
|
45
|
-
*/
|
|
46
|
-
attachComponents(): void;
|
|
47
|
-
/**
|
|
48
|
-
*
|
|
49
|
-
*/
|
|
50
|
-
updateComponents(data: UpdateComponentsCommand): void;
|
|
51
|
-
/**
|
|
52
|
-
*
|
|
53
|
-
*/
|
|
54
|
-
findEntitiesByEUID({ entity_uuid }: {
|
|
55
|
-
entity_uuid: UUID;
|
|
56
|
-
}): Promise<Array<EditorEntity>>;
|
|
57
|
-
onFindEntitiesByEUID(data: Array<EditorEntity>): void;
|
|
58
|
-
/**
|
|
59
|
-
*
|
|
60
|
-
*/
|
|
61
|
-
getEntity({ entity_uuid, linkage }: {
|
|
62
|
-
entity_uuid: UUID;
|
|
63
|
-
linkage: Array<UUID>;
|
|
64
|
-
}): Promise<EditorEntity | null>;
|
|
65
|
-
onGetEntity(data: EditorEntity | null): void;
|
|
66
|
-
/**
|
|
67
|
-
*
|
|
68
|
-
*/
|
|
69
|
-
onConnectConfirmation({ connect_confirmation }: {
|
|
70
|
-
connect_confirmation: ConnectConfirmation;
|
|
71
|
-
}): void;
|
|
72
|
-
/**
|
|
73
|
-
*
|
|
74
|
-
*/
|
|
75
|
-
retrieveChildren({ entity_rtid }: {
|
|
76
|
-
entity_rtid: RTID;
|
|
77
|
-
}): Promise<Record<string, EditorEntity>>;
|
|
78
|
-
onRetrieveChildren(data: Record<string, EditorEntity>): void;
|
|
79
|
-
/**
|
|
80
|
-
*
|
|
81
|
-
*/
|
|
82
|
-
findEntitiesWithComponents({ mandatory_components, forbidden_components, }: {
|
|
83
|
-
mandatory_components: Array<ComponentType>;
|
|
84
|
-
forbidden_components?: Array<ComponentType>;
|
|
85
|
-
}): Promise<Record<string, EditorEntity>>;
|
|
86
|
-
onFindEntitiesWithComponents(data: Record<string, EditorEntity>): void;
|
|
87
|
-
/**
|
|
88
|
-
*
|
|
89
|
-
*/
|
|
90
|
-
resolveAncestors({ entity_rtid }: {
|
|
91
|
-
entity_rtid: RTID;
|
|
92
|
-
}): Promise<Array<EditorEntity>>;
|
|
93
|
-
onResolveAncestors(data: Array<EditorEntity>): void;
|
|
94
|
-
/**
|
|
95
|
-
*
|
|
96
|
-
*/
|
|
97
|
-
findEntitiesByNames({ entity_names }: {
|
|
98
|
-
entity_names: Array<string>;
|
|
99
|
-
}): Promise<Array<EditorEntity>>;
|
|
100
|
-
/**
|
|
101
|
-
*
|
|
102
|
-
*/
|
|
103
|
-
setEntityVisibility({ entity_rtid, is_visible }: {
|
|
104
|
-
entity_rtid: RTID;
|
|
105
|
-
is_visible: boolean;
|
|
106
|
-
}): void;
|
|
107
|
-
onFindEntitiesByNames(data: Record<string, EditorEntity>): void;
|
|
108
|
-
/**
|
|
109
|
-
*
|
|
110
|
-
*/
|
|
111
|
-
onFilterEntities(data: any): void;
|
|
112
|
-
onExportEntityToScene(data: any): void;
|
|
113
|
-
onNextUndoRedo(data: any): void;
|
|
114
|
-
onClientColor(data: any): void;
|
|
115
|
-
onSceneStatsUpdate(data: any): void;
|
|
116
|
-
onServerError(data: any): void;
|
|
117
|
-
onCreateEntity(data: any): void;
|
|
118
|
-
onCreateEntities(data: any): void;
|
|
119
|
-
onRestoreEntities(data: any): void;
|
|
120
|
-
onSpawnEntity(data: any): void;
|
|
121
|
-
onEntityReparented(data: any): void;
|
|
122
|
-
deleteEntities({ entity_uuids }: {
|
|
123
|
-
entity_uuids: Array<UUID>;
|
|
124
|
-
}): Promise<Array<UUID>>;
|
|
125
|
-
onEntitiesDeleted(data: Array<UUID>): void;
|
|
126
|
-
onEntityVisibilityChanged(data: EntityVisibilityChangedEvent): void;
|
|
127
|
-
onActionError(data: any): void;
|
|
128
|
-
onAttachComponents(data: any): void;
|
|
129
|
-
onUpdateComponents(emitter_id: UUID | null, entitiesUpdatedEvent: Record<UUID, EntityUpdatedEvent>): void;
|
|
130
|
-
onDetachComponents(data: any): void;
|
|
131
|
-
onDeleteEntities(data: any): void;
|
|
132
|
-
onDeleteEntitiesWithRtid(data: any): void;
|
|
133
|
-
onReparentEntity(data: any): void;
|
|
134
|
-
onEntitiesOverridden(data: any): void;
|
|
135
|
-
onUpdateSettings(data: any): void;
|
|
136
|
-
onSelectEntities(data: any): void;
|
|
137
|
-
onSetEntityVisibility(data: any): void;
|
|
138
|
-
onUnhandledMessage(type: string, data: any): void;
|
|
139
|
-
}
|
|
1
|
+
export {};
|
|
@@ -3,67 +3,4 @@
|
|
|
3
3
|
* This file has been generated automatically from its AsyncAPI spec file.
|
|
4
4
|
* See : https://gitlab.com/3dverse/platform/libs/js/asyncapi-server-generator
|
|
5
5
|
*/
|
|
6
|
-
|
|
7
|
-
/**
|
|
8
|
-
* The reason why the gateway has disconnected.
|
|
9
|
-
*
|
|
10
|
-
* @category Core
|
|
11
|
-
*/
|
|
12
|
-
export type GatewayDisconnectedReason = "closed" | "forcibly_closed" | "inactivity";
|
|
13
|
-
/**
|
|
14
|
-
* Holds the connection to the cluster gateway hosting the renderer and the viewer handling the
|
|
15
|
-
* session.
|
|
16
|
-
*
|
|
17
|
-
* ┌─────────┬──────────────┐
|
|
18
|
-
* │ │ │
|
|
19
|
-
* │ │ ┌──────────┐ │
|
|
20
|
-
* │ │ │ Renderer │ │
|
|
21
|
-
* │ │ └─────┬────┘ │
|
|
22
|
-
* ┌────────┐ │ │ │ │
|
|
23
|
-
* │ Client │◄──────► Gateway ◄───────┤ │
|
|
24
|
-
* └────────┘ │ │ │ │
|
|
25
|
-
* ▲ │ │ ┌────┴───┐ │
|
|
26
|
-
* | │ │ │ Viewer │ │
|
|
27
|
-
* GatewayConnection │ │ └────────┘ │
|
|
28
|
-
* │ │ │
|
|
29
|
-
* └─────────┴──────────────┘
|
|
30
|
-
*
|
|
31
|
-
* Responsibilities of this class are threefold:
|
|
32
|
-
* - Open, maintain, and handle any error in the connection to the gateway.
|
|
33
|
-
*
|
|
34
|
-
* - Apply the authentication protocol when the first message is received.
|
|
35
|
-
* Note that initiating the authentication doesn't fall under this class's purview.
|
|
36
|
-
*
|
|
37
|
-
* - Demultiplex messages following the gateway Livelink Protocol.
|
|
38
|
-
* It is only responsible for deserializing the multiplexer binary header data according to the
|
|
39
|
-
* Livelink protocol specifications; in no case is it supposed to apply any kind of logic beyond
|
|
40
|
-
* routing messages to the appropriate handler.
|
|
41
|
-
*/
|
|
42
|
-
export declare class GatewayConnection {
|
|
43
|
-
#private;
|
|
44
|
-
/**
|
|
45
|
-
* Constructs a connection linked to the specified message handler.
|
|
46
|
-
*/
|
|
47
|
-
constructor({ handler }: {
|
|
48
|
-
handler: GatewayMessageHandler;
|
|
49
|
-
});
|
|
50
|
-
/**
|
|
51
|
-
* Opens a connection to the gateway.
|
|
52
|
-
*
|
|
53
|
-
* @throws {Error} Socket errors
|
|
54
|
-
*/
|
|
55
|
-
connect({ gateway_url }: {
|
|
56
|
-
gateway_url: string;
|
|
57
|
-
}): Promise<void>;
|
|
58
|
-
/**
|
|
59
|
-
*
|
|
60
|
-
*/
|
|
61
|
-
send({ data, is_heart_beat }: {
|
|
62
|
-
data: ArrayBufferLike | string;
|
|
63
|
-
is_heart_beat?: boolean;
|
|
64
|
-
}): void;
|
|
65
|
-
/**
|
|
66
|
-
*
|
|
67
|
-
*/
|
|
68
|
-
disconnect(): void;
|
|
69
|
-
}
|
|
6
|
+
export {};
|
|
@@ -3,200 +3,4 @@
|
|
|
3
3
|
* This file has been generated automatically from its AsyncAPI spec file.
|
|
4
4
|
* See : https://gitlab.com/3dverse/platform/libs/js/asyncapi-server-generator
|
|
5
5
|
*/
|
|
6
|
-
|
|
7
|
-
import { GatewayDisconnectedReason } from "./GatewayConnection";
|
|
8
|
-
import { UUID, Vec2ui16 } from "../sources/types";
|
|
9
|
-
/**
|
|
10
|
-
* Message handlers interface.
|
|
11
|
-
* This follows the Livelink protocol specifications for the gateway messages.
|
|
12
|
-
*/
|
|
13
|
-
export declare abstract class GatewayMessageHandler extends EventTarget {
|
|
14
|
-
#private;
|
|
15
|
-
/**
|
|
16
|
-
* Opens the connection to the specified gateway.
|
|
17
|
-
*/
|
|
18
|
-
protected _connect({ gateway_url }: {
|
|
19
|
-
gateway_url: string;
|
|
20
|
-
}): Promise<void>;
|
|
21
|
-
/**
|
|
22
|
-
* Closes any ongoing connection with the gateway.
|
|
23
|
-
*/
|
|
24
|
-
protected _disconnect(): void;
|
|
25
|
-
/**
|
|
26
|
-
*
|
|
27
|
-
*/
|
|
28
|
-
_onConnected(): void;
|
|
29
|
-
/**
|
|
30
|
-
*
|
|
31
|
-
*/
|
|
32
|
-
_onDisconnected({ reason }: {
|
|
33
|
-
reason: GatewayDisconnectedReason;
|
|
34
|
-
}): void;
|
|
35
|
-
/**
|
|
36
|
-
*
|
|
37
|
-
*/
|
|
38
|
-
abstract _onMessageSent({ is_heart_beat }: {
|
|
39
|
-
is_heart_beat?: boolean;
|
|
40
|
-
}): void;
|
|
41
|
-
/***************************************************************************
|
|
42
|
-
* AUTHENTICATION (0)
|
|
43
|
-
**************************************************************************/
|
|
44
|
-
/**
|
|
45
|
-
* Request
|
|
46
|
-
*/
|
|
47
|
-
authenticateClient({ session_auth }: {
|
|
48
|
-
session_auth: SessionAuth;
|
|
49
|
-
}): Promise<AuthenticationResponse>;
|
|
50
|
-
/**
|
|
51
|
-
* Reply
|
|
52
|
-
*/
|
|
53
|
-
_on_authenticateClient_response({ data_view }: {
|
|
54
|
-
data_view: DataView;
|
|
55
|
-
}): void;
|
|
56
|
-
/***************************************************************************
|
|
57
|
-
* HEARTBEAT (11)
|
|
58
|
-
**************************************************************************/
|
|
59
|
-
/**
|
|
60
|
-
* Request
|
|
61
|
-
*/
|
|
62
|
-
pulseHeartbeat(): Promise<void>;
|
|
63
|
-
/**
|
|
64
|
-
* Reply
|
|
65
|
-
*/
|
|
66
|
-
_on_pulseHeartbeat_response(): void;
|
|
67
|
-
/***************************************************************************
|
|
68
|
-
* REGISTRATION (1)
|
|
69
|
-
**************************************************************************/
|
|
70
|
-
/**
|
|
71
|
-
* Request
|
|
72
|
-
*/
|
|
73
|
-
configureClient(client_config: ClientConfig): Promise<ClientConfigResponse>;
|
|
74
|
-
/**
|
|
75
|
-
* Reply
|
|
76
|
-
*/
|
|
77
|
-
_on_configureClient_response({ data_view }: {
|
|
78
|
-
data_view: DataView;
|
|
79
|
-
}): void;
|
|
80
|
-
/***************************************************************************
|
|
81
|
-
* INPUTS (2)
|
|
82
|
-
**************************************************************************/
|
|
83
|
-
/**
|
|
84
|
-
* Send
|
|
85
|
-
*/
|
|
86
|
-
sendInputState(input_state: InputState): void;
|
|
87
|
-
/***************************************************************************
|
|
88
|
-
* VIDEO STREAM (3)
|
|
89
|
-
**************************************************************************/
|
|
90
|
-
/**
|
|
91
|
-
* Receive
|
|
92
|
-
*/
|
|
93
|
-
_onFrameReceived({ data_view }: {
|
|
94
|
-
data_view: DataView;
|
|
95
|
-
}): void;
|
|
96
|
-
/***************************************************************************
|
|
97
|
-
* VIEWER CONTROL (4)
|
|
98
|
-
**************************************************************************/
|
|
99
|
-
/**
|
|
100
|
-
* Send
|
|
101
|
-
*/
|
|
102
|
-
setViewports({ viewport_configs }: {
|
|
103
|
-
viewport_configs: ViewportConfigs;
|
|
104
|
-
}): void;
|
|
105
|
-
/**
|
|
106
|
-
* Send
|
|
107
|
-
*/
|
|
108
|
-
resume(): void;
|
|
109
|
-
/**
|
|
110
|
-
* Send
|
|
111
|
-
*/
|
|
112
|
-
suspend(): void;
|
|
113
|
-
/**
|
|
114
|
-
* Request
|
|
115
|
-
*/
|
|
116
|
-
resize({ size }: {
|
|
117
|
-
size: Vec2ui16;
|
|
118
|
-
}): Promise<ResizeResponse>;
|
|
119
|
-
/**
|
|
120
|
-
* Reply
|
|
121
|
-
*/
|
|
122
|
-
_on_resize_response({ data_view }: {
|
|
123
|
-
data_view: DataView;
|
|
124
|
-
}): void;
|
|
125
|
-
/***************************************************************************
|
|
126
|
-
* CLIENT REMOTE OPERATIONS (5)
|
|
127
|
-
**************************************************************************/
|
|
128
|
-
/**
|
|
129
|
-
* Request
|
|
130
|
-
*/
|
|
131
|
-
castScreenSpaceRay(screenSpaceRayQuery: ScreenSpaceRayQuery): Promise<ScreenSpaceRayResult>;
|
|
132
|
-
/**
|
|
133
|
-
* Send
|
|
134
|
-
*/
|
|
135
|
-
highlightEntities(highlightEntitiesMessage: HighlightEntitiesMessage): void;
|
|
136
|
-
/**
|
|
137
|
-
* Reply
|
|
138
|
-
*/
|
|
139
|
-
_on_clientRemoteOperation_response({ client_id, request_id, data_view, }: {
|
|
140
|
-
client_id: UUID;
|
|
141
|
-
request_id: number;
|
|
142
|
-
size: number;
|
|
143
|
-
data_view: DataView;
|
|
144
|
-
}): void;
|
|
145
|
-
/***************************************************************************
|
|
146
|
-
* EDITOR REMOTE OPERATIONS (6)
|
|
147
|
-
**************************************************************************/
|
|
148
|
-
/**
|
|
149
|
-
* Send
|
|
150
|
-
*/
|
|
151
|
-
fireEvent(fireEventMessage: FireEventMessage): void;
|
|
152
|
-
/**
|
|
153
|
-
* Send
|
|
154
|
-
*/
|
|
155
|
-
sendSkeletonPose(sendSkeletonPoseMessage: SkeletonPoseMessage): void;
|
|
156
|
-
/**
|
|
157
|
-
* Send
|
|
158
|
-
*/
|
|
159
|
-
assignClientToScript(assignClientToScriptMessage: AssignClientToScriptMessage): void;
|
|
160
|
-
/**
|
|
161
|
-
* Send
|
|
162
|
-
*/
|
|
163
|
-
updateEntitiesFromBytes(updateEntitiesFromBytesMessage: UpdateEntitiesFromBytesMessage): void;
|
|
164
|
-
/**
|
|
165
|
-
* Send
|
|
166
|
-
*/
|
|
167
|
-
updateEntitiesFromJson(updateEntitiesFromJsonMessage: UpdateEntitiesFromJsonMessage): void;
|
|
168
|
-
/**
|
|
169
|
-
* Send
|
|
170
|
-
*/
|
|
171
|
-
removeComponents(removeComponentsCommand: RemoveComponentsCommand): void;
|
|
172
|
-
/**
|
|
173
|
-
* Send
|
|
174
|
-
*/
|
|
175
|
-
setFilter(setFilterMessage: SetFilterMessage): void;
|
|
176
|
-
/**
|
|
177
|
-
* Send
|
|
178
|
-
*/
|
|
179
|
-
toggleFilter(toggleFilterMessage: ToggleFilterMessage): void;
|
|
180
|
-
/**
|
|
181
|
-
* Send
|
|
182
|
-
*/
|
|
183
|
-
removeFilter(removeFilterMessage: RemoveFilterMessage): void;
|
|
184
|
-
/***************************************************************************
|
|
185
|
-
* SCRIPT EVENTS (14)
|
|
186
|
-
**************************************************************************/
|
|
187
|
-
/**
|
|
188
|
-
* Receive
|
|
189
|
-
*/
|
|
190
|
-
_onScriptEventReceived({ data_view }: {
|
|
191
|
-
data_view: DataView;
|
|
192
|
-
}): void;
|
|
193
|
-
/***************************************************************************
|
|
194
|
-
* ASSET LOADING EVENT (15)
|
|
195
|
-
**************************************************************************/
|
|
196
|
-
/**
|
|
197
|
-
* Receive
|
|
198
|
-
*/
|
|
199
|
-
_onAssetLoadingEventReceived({ data_view }: {
|
|
200
|
-
data_view: DataView;
|
|
201
|
-
}): void;
|
|
202
|
-
}
|
|
6
|
+
export {};
|