@3dverse/livelink.core 0.8.0 → 1.0.1

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.
Files changed (99) hide show
  1. package/README.md +61 -17
  2. package/dist/_prebuild/EditorConnection.d.ts +1 -29
  3. package/dist/_prebuild/EditorMessageHandler.d.ts +1 -139
  4. package/dist/_prebuild/GatewayConnection.d.ts +1 -64
  5. package/dist/_prebuild/GatewayMessageHandler.d.ts +1 -197
  6. package/dist/_prebuild/engine_types/ComponentsHashes.d.ts +5 -0
  7. package/dist/_prebuild/{types → engine_types}/ComponentsRecord.d.ts +65 -44
  8. package/dist/_prebuild/{types → engine_types}/assets.d.ts +69 -0
  9. package/dist/_prebuild/{types → engine_types}/components.d.ts +164 -164
  10. package/dist/_prebuild/messages/editor/ConnectConfirmation.d.ts +1 -71
  11. package/dist/_prebuild/messages/editor/EditorEntity.d.ts +1 -75
  12. package/dist/_prebuild/messages/editor/EntityUpdatedEvent.d.ts +1 -7
  13. package/dist/_prebuild/messages/editor/EntityVisibilityChangedEvent.d.ts +1 -8
  14. package/dist/_prebuild/messages/editor/UpdateComponentsCommand.d.ts +1 -6
  15. package/dist/_prebuild/messages/editor/index.d.ts +0 -1
  16. package/dist/_prebuild/messages/gateway/commands/AssignClientToScriptCommand.d.ts +9 -0
  17. package/dist/_prebuild/messages/gateway/commands/AuthenticationCommand.d.ts +1 -0
  18. package/dist/_prebuild/messages/gateway/{ClientConfig.d.ts → commands/ConfigureClientCommand.d.ts} +11 -13
  19. package/dist/_prebuild/messages/gateway/commands/FireEventCommand.d.ts +11 -0
  20. package/dist/_prebuild/messages/gateway/commands/HighlightEntitiesCommand.d.ts +8 -0
  21. package/dist/_prebuild/messages/gateway/commands/InputStateCommand.d.ts +8 -0
  22. package/dist/_prebuild/messages/gateway/commands/RemoveComponentsCommand.d.ts +1 -0
  23. package/dist/_prebuild/messages/gateway/commands/RemoveFilterCommand.d.ts +7 -0
  24. package/dist/_prebuild/messages/gateway/commands/ResizeCommand.d.ts +13 -0
  25. package/dist/_prebuild/messages/gateway/commands/SendSkeletonPoseCommand.d.ts +25 -0
  26. package/dist/_prebuild/messages/gateway/commands/SetFilterCommand.d.ts +8 -0
  27. package/dist/_prebuild/messages/gateway/commands/ToggleFilterCommand.d.ts +8 -0
  28. package/dist/_prebuild/messages/gateway/commands/UpdateEntitiesFromBytesCommand.d.ts +1 -0
  29. package/dist/_prebuild/messages/gateway/commands/UpdateEntitiesFromJsonCommand.d.ts +1 -0
  30. package/dist/_prebuild/messages/gateway/commands/ViewportConfigCommand.d.ts +16 -0
  31. package/dist/_prebuild/messages/gateway/commands/index.d.ts +15 -0
  32. package/dist/_prebuild/messages/gateway/enums.d.ts +8 -115
  33. package/dist/_prebuild/messages/gateway/events/AssetLoadingEvent.d.ts +1 -0
  34. package/dist/_prebuild/messages/gateway/events/FrameDataEvent.d.ts +26 -0
  35. package/dist/_prebuild/messages/gateway/events/ScriptEvent.d.ts +10 -0
  36. package/dist/_prebuild/messages/gateway/events/index.d.ts +3 -0
  37. package/dist/_prebuild/messages/gateway/index.d.ts +16 -22
  38. package/dist/_prebuild/messages/gateway/queries/ScreenSpaceRayQuery.d.ts +18 -0
  39. package/dist/_prebuild/messages/gateway/queries/index.d.ts +1 -0
  40. package/dist/_prebuild/messages/index.d.ts +2 -0
  41. package/dist/library.cjs +1 -1
  42. package/dist/library.cjs.map +4 -4
  43. package/dist/library.mjs +1 -1
  44. package/dist/library.mjs.map +4 -4
  45. package/dist/sources/ActivityWatcher.d.ts +40 -21
  46. package/dist/sources/CoreEvents.d.ts +35 -0
  47. package/dist/sources/DynamicLoader.d.ts +38 -0
  48. package/dist/sources/EntityUtils.d.ts +117 -0
  49. package/dist/sources/LivelinkCore.d.ts +131 -127
  50. package/dist/sources/{interfaces/SessionInterface.d.ts → SessionInterface.d.ts} +2 -6
  51. package/dist/sources/TypedEventTarget.d.ts +14 -0
  52. package/dist/sources/controllers/EditorController.d.ts +1 -21
  53. package/dist/sources/controllers/EditorEvents.d.ts +27 -0
  54. package/dist/sources/controllers/GatewayController.d.ts +1 -60
  55. package/dist/sources/controllers/GatewayEvents.d.ts +54 -0
  56. package/dist/sources/core.d.ts +12 -11
  57. package/dist/sources/internal/RequestHandler.d.ts +1 -0
  58. package/dist/sources/internal/Serializer.d.ts +1 -0
  59. package/dist/sources/library.d.ts +1 -1
  60. package/dist/sources/types/RTID.d.ts +6 -21
  61. package/dist/sources/types/UUID.d.ts +11 -21
  62. package/dist/sources/types/dataObjects.d.ts +1 -1
  63. package/dist/sources/types/index.d.ts +1 -0
  64. package/dist/sources/types/math.d.ts +1 -105
  65. package/dist/sources/types/nativeTypes.d.ts +0 -132
  66. package/dist/sources/types/utils.d.ts +19 -0
  67. package/package.json +6 -4
  68. package/dist/_prebuild/enums.d.ts +0 -6
  69. package/dist/_prebuild/messages/editor/EntityCreationCoreOptions.d.ts +0 -6
  70. package/dist/_prebuild/messages/gateway/AssetLoadingEvent.d.ts +0 -14
  71. package/dist/_prebuild/messages/gateway/AssignClientToScriptMessage.d.ts +0 -22
  72. package/dist/_prebuild/messages/gateway/AuthenticationResponse.d.ts +0 -31
  73. package/dist/_prebuild/messages/gateway/ClientConfigResponse.d.ts +0 -16
  74. package/dist/_prebuild/messages/gateway/FireEventMessage.d.ts +0 -23
  75. package/dist/_prebuild/messages/gateway/FrameData.d.ts +0 -42
  76. package/dist/_prebuild/messages/gateway/HighlightEntitiesMessage.d.ts +0 -22
  77. package/dist/_prebuild/messages/gateway/InputState.d.ts +0 -22
  78. package/dist/_prebuild/messages/gateway/RemoveComponentsCommand.d.ts +0 -23
  79. package/dist/_prebuild/messages/gateway/RemoveFilterMessage.d.ts +0 -19
  80. package/dist/_prebuild/messages/gateway/ResizeResponse.d.ts +0 -14
  81. package/dist/_prebuild/messages/gateway/ScreenSpaceRayQuery.d.ts +0 -30
  82. package/dist/_prebuild/messages/gateway/ScreenSpaceRayResult.d.ts +0 -16
  83. package/dist/_prebuild/messages/gateway/ScriptEvent.d.ts +0 -17
  84. package/dist/_prebuild/messages/gateway/SendSkeletonPoseMessage.d.ts +0 -28
  85. package/dist/_prebuild/messages/gateway/SessionAuth.d.ts +0 -8
  86. package/dist/_prebuild/messages/gateway/SetFilterMessage.d.ts +0 -20
  87. package/dist/_prebuild/messages/gateway/ToggleFilterMessage.d.ts +0 -20
  88. package/dist/_prebuild/messages/gateway/UpdateEntitiesFromBytesMessage.d.ts +0 -25
  89. package/dist/_prebuild/messages/gateway/UpdateEntitiesFromJsonMessage.d.ts +0 -23
  90. package/dist/_prebuild/messages/gateway/ViewportConfig.d.ts +0 -30
  91. package/dist/_prebuild/types/ComponentsHashes.d.ts +0 -53
  92. package/dist/sources/LivelinkCoreModule.d.ts +0 -39
  93. package/dist/sources/RequestHandler.d.ts +0 -49
  94. package/dist/sources/Serializer.d.ts +0 -34
  95. package/dist/sources/interfaces/ClientInterface.d.ts +0 -12
  96. package/dist/sources/interfaces/EntityInterface.d.ts +0 -20
  97. package/dist/sources/interfaces/index.d.ts +0 -3
  98. /package/dist/_prebuild/{types → engine_types}/SceneSettingsRecord.d.ts +0 -0
  99. /package/dist/_prebuild/{types → engine_types}/sceneSettings.d.ts +0 -0
@@ -1,16 +0,0 @@
1
- import { RTID, Vec3 } from "../../../sources/types";
2
- /**
3
- * @category Gateway
4
- */
5
- export type ScreenSpaceRayResult = {
6
- entity_rtid: RTID;
7
- position: Vec3;
8
- normal: Vec3;
9
- };
10
- /**
11
- * @internal
12
- */
13
- export declare function deserialize_ScreenSpaceRayResult({ data_view, offset, }: {
14
- data_view: DataView;
15
- offset: number;
16
- }): ScreenSpaceRayResult;
@@ -1,17 +0,0 @@
1
- import { RTID, ScriptDataObject } from "../../../sources/types";
2
- /**
3
- * @category Gateway
4
- */
5
- export type ScriptEvent = {
6
- emitter_rtid: RTID;
7
- event_name: string;
8
- target_rtids: Array<RTID>;
9
- data_object: ScriptDataObject;
10
- };
11
- /**
12
- * @internal
13
- */
14
- export declare function deserialize_ScriptEvent({ data_view, offset, }: {
15
- data_view: DataView;
16
- offset?: number;
17
- }): ScriptEvent;
@@ -1,28 +0,0 @@
1
- import { RTID, Quat, Vec3 } from "../../../sources/types";
2
- /**
3
- * @category Gateway
4
- */
5
- export type SkeletonPartialPose = {
6
- positions?: Map<number, Vec3>;
7
- orientations?: Map<number, Quat>;
8
- scales?: Map<number, Vec3>;
9
- };
10
- /**
11
- * @category Gateway
12
- */
13
- export type SkeletonPoseMessage = {
14
- controller_rtid: RTID;
15
- partial_pose: SkeletonPartialPose;
16
- };
17
- /**
18
- * @internal
19
- */
20
- export declare function compute_SkeletonPoseMessage_size(skeletonPoseMessage: SkeletonPoseMessage): number;
21
- /**
22
- * @internal
23
- */
24
- export declare function serialize_SkeletonPoseMessage({ data_view, offset, skeletonPoseMessage, }: {
25
- data_view: DataView;
26
- offset?: number;
27
- skeletonPoseMessage: SkeletonPoseMessage;
28
- }): number;
@@ -1,8 +0,0 @@
1
- /**
2
- * @internal
3
- */
4
- export type SessionAuth = {
5
- session_key: string;
6
- client_app: string;
7
- os: string;
8
- };
@@ -1,20 +0,0 @@
1
- /**
2
- * @experimental
3
- * @category Gateway
4
- */
5
- export type SetFilterMessage = {
6
- name: string;
7
- rpn: string;
8
- };
9
- /**
10
- * @internal
11
- */
12
- export declare function compute_SetFilterMessage_size(setFilterCommand: SetFilterMessage): number;
13
- /**
14
- * @internal
15
- */
16
- export declare function serialize_SetFilterMessage({ data_view, offset, setFilterMessage, }: {
17
- data_view: DataView;
18
- offset?: number;
19
- setFilterMessage: SetFilterMessage;
20
- }): void;
@@ -1,20 +0,0 @@
1
- /**
2
- * @experimental
3
- * @category Gateway
4
- */
5
- export type ToggleFilterMessage = {
6
- name: string;
7
- enabled: boolean;
8
- };
9
- /**
10
- * @internal
11
- */
12
- export declare function compute_ToggleFilterMessage_size(toggleFilterMessage: ToggleFilterMessage): number;
13
- /**
14
- * @internal
15
- */
16
- export declare function serialize_ToggleFilterMessage({ data_view, offset, toggleFilterMessage, }: {
17
- data_view: DataView;
18
- offset?: number;
19
- toggleFilterMessage: ToggleFilterMessage;
20
- }): void;
@@ -1,25 +0,0 @@
1
- import { EntityInterface } from "../../../sources/interfaces/EntityInterface";
2
- import { ComponentSerializer } from "../../../sources/Serializer";
3
- import { ComponentType } from "../../types/ComponentsRecord";
4
- /**
5
- * @category Gateway
6
- */
7
- export type UpdateEntitiesFromBytesMessage = {
8
- components: Array<{
9
- component_type: ComponentType;
10
- component_serializer: ComponentSerializer;
11
- entities: Set<EntityInterface>;
12
- }>;
13
- };
14
- /**
15
- * @internal
16
- */
17
- export declare function compute_UpdateEntitiesFromBytes_size(updateEntitiesFromBytesMessage: UpdateEntitiesFromBytesMessage): number;
18
- /**
19
- * @internal
20
- */
21
- export declare function serialize_UpdateEntitiesFromBytes({ data_view, offset, updateEntitiesFromBytesMessage, }: {
22
- data_view: DataView;
23
- offset?: number;
24
- updateEntitiesFromBytesMessage: UpdateEntitiesFromBytesMessage;
25
- }): void;
@@ -1,23 +0,0 @@
1
- import { EntityInterface } from "../../../sources/interfaces/EntityInterface";
2
- import { ComponentType } from "../../types/ComponentsRecord";
3
- /**
4
- * @category Gateway
5
- */
6
- export type UpdateEntitiesFromJsonMessage = {
7
- components: Array<{
8
- component_type: ComponentType;
9
- entities: Set<EntityInterface>;
10
- }>;
11
- };
12
- /**
13
- * @internal
14
- */
15
- export declare function compute_UpdateEntitiesFromJsonMessage_size(updateEntitiesFromJsonMessage: UpdateEntitiesFromJsonMessage): number;
16
- /**
17
- * @internal
18
- */
19
- export declare function serialize_UpdateEntitiesFromJsonMessage({ data_view, offset, updateEntitiesFromJsonMessage, }: {
20
- data_view: DataView;
21
- offset?: number;
22
- updateEntitiesFromJsonMessage: UpdateEntitiesFromJsonMessage;
23
- }): void;
@@ -1,30 +0,0 @@
1
- import { Float, Int32, RTID } from "../../../sources/types";
2
- /**
3
- * @category Gateway
4
- */
5
- export type ViewportConfig = {
6
- left: Float;
7
- top: Float;
8
- width: Float;
9
- height: Float;
10
- camera_rtid: RTID;
11
- render_target_index?: Int32;
12
- };
13
- /**
14
- * @category Gateway
15
- */
16
- export type ViewportConfigs = Array<ViewportConfig>;
17
- /**
18
- * @internal
19
- */
20
- export declare function compute_ViewportConfigs_size({ viewport_configs }: {
21
- viewport_configs: ViewportConfigs;
22
- }): number;
23
- /**
24
- * @internal
25
- */
26
- export declare function serialize_ViewportConfigs({ data_view, offset, viewport_configs, }: {
27
- data_view: DataView;
28
- offset: number;
29
- viewport_configs: ViewportConfigs;
30
- }): number;
@@ -1,53 +0,0 @@
1
- /**
2
- * DO NOT EDIT THIS FILE MANUALLY.
3
- * This file has been generated automatically from ftl-schemas
4
- */
5
- /**
6
- * @category Engine Schemas
7
- */
8
- export declare enum ComponentsHashes {
9
- animation_controller = 2978761622,
10
- animation_sequence_controller = 1078130395,
11
- bone = 1352454807,
12
- box_geometry = 3718707752,
13
- camera = 1515175333,
14
- capsule_geometry = 3996568839,
15
- character_controller = 304568171,
16
- collision_geometry_ref = 3193374355,
17
- constraint = 3735282166,
18
- culling_geometry = 611599156,
19
- cylinder_geometry = 2497701877,
20
- debug_name = 2737255849,
21
- decal_projector = 2842087135,
22
- environment = 227427331,
23
- joint = 2286235554,
24
- lineage = 2698448560,
25
- local_aabb = 4132624459,
26
- local_transform = 64958624,
27
- material = 4100970527,
28
- material_ref = 2816861126,
29
- mesh_ref = 1660697531,
30
- orthographic_lens = 3326403741,
31
- overrider = 2758112134,
32
- perspective_lens = 1113360699,
33
- physics_material = 1550394949,
34
- plane_geometry = 4075752378,
35
- point_cloud_ref = 457361603,
36
- point_light = 3624222817,
37
- reflection_probe = 3879689944,
38
- rigid_body = 3452128059,
39
- scene_ref = 371342060,
40
- script_map = 3291722836,
41
- shadow_caster = 3403528636,
42
- skeleton_ref = 36879215,
43
- sound_ref = 369352309,
44
- sphere_geometry = 1159992935,
45
- spot_light = 1508811228,
46
- stereoscopic_lens = 698679321,
47
- tags = 163258925,
48
- vehicle_controller = 1287796174,
49
- volume_filter = 2625356468,
50
- volume_material_ref = 3229245461,
51
- volume_ref = 2808449574
52
- }
53
- export { ComponentsHashes as ComponentHash };
@@ -1,39 +0,0 @@
1
- import type { LivelinkCore, CoreEnums } from "./core";
2
- /**
3
- *
4
- */
5
- type LivelinkCoreType = typeof LivelinkCore;
6
- /**
7
- *
8
- */
9
- type CoreEnumsType = typeof CoreEnums;
10
- /**
11
- *
12
- */
13
- type CoreImporter = () => Promise<{
14
- LivelinkCore: LivelinkCoreType;
15
- CoreEnums: CoreEnumsType;
16
- }>;
17
- /**
18
- *
19
- */
20
- export declare class LivelinkCoreModule {
21
- #private;
22
- /**
23
- *
24
- */
25
- static init(): Promise<void>;
26
- /**
27
- *
28
- */
29
- static createImporter(): Promise<CoreImporter>;
30
- /**
31
- *
32
- */
33
- static get Core(): LivelinkCoreType;
34
- /**
35
- *
36
- */
37
- static get Enums(): CoreEnumsType;
38
- }
39
- export {};
@@ -1,49 +0,0 @@
1
- /**
2
- * Holds the resolve/reject pair of a Promise alongside some metadata associated with the request.
3
- */
4
- type RequestResolver<MetaDataType> = {
5
- resolve: (u?: any) => void;
6
- reject: (reason?: unknown) => void;
7
- meta_data?: MetaDataType;
8
- };
9
- /**
10
- * A helper class to handle asynchronous communication with a server in a request/response model.
11
- *
12
- * The requests are expected to be sequential, i.e. sending request 1 then request 2 on channel C is
13
- * expected to receive response 1 then response 2 on channel C.
14
- * This is a big limitation of the system for now.
15
- *
16
- * Usage:
17
- *
18
- * Start by sending the request message on a specific channel.
19
- * Then call makeRequestResolver<ResponseType>() generic function specifiying the channel,
20
- * an optional meta data associated with the request, and the type of the expected response.
21
- *
22
- * When receiving a message on the same channel call getNextRequestResolver() specifing the channel,
23
- * which will return the instance of MessageResolver<MetaDataType> containing the pair of
24
- * resolve/reject functions and the provided meta data associated with the request.
25
- *
26
- * From there you can call either resolver.resolve() providing the expected response or
27
- * resolver.reject().
28
- *
29
- * @category Utils
30
- *
31
- */
32
- export declare class RequestHandler<ChannelType, MetaDataType> {
33
- #private;
34
- /**
35
- * Creates a promise for handling a request, associating it with a specific channel and some
36
- * optional meta_data.
37
- */
38
- makeRequestResolver<ResponseType>({ channel_id, meta_data, }: {
39
- channel_id: ChannelType;
40
- meta_data?: MetaDataType;
41
- }): Promise<ResponseType>;
42
- /**
43
- * Retrieves and removes the next request resolver from the list of resolvers for a given channel.
44
- */
45
- getNextRequestResolver({ channel_id }: {
46
- channel_id: ChannelType;
47
- }): RequestResolver<MetaDataType>;
48
- }
49
- export {};
@@ -1,34 +0,0 @@
1
- import { ComponentDescriptor, SettingDescriptor } from "../_prebuild/messages/editor";
2
- import { ComponentType } from "../_prebuild/types/ComponentsRecord";
3
- import { SceneSettingType } from "./core";
4
- /**
5
- * @category Core
6
- */
7
- export type ComponentSerializer = ((args: {
8
- data_view: DataView;
9
- offset: number;
10
- component: ComponentType;
11
- }) => number) & {
12
- size: number;
13
- };
14
- /**
15
- * @category Core
16
- */
17
- export declare class Serializer {
18
- #private;
19
- /**
20
- *
21
- */
22
- readonly component_names: Array<ComponentType>;
23
- /**
24
- *
25
- */
26
- constructor({ component_descriptors, settings_descriptors, }: {
27
- component_descriptors: Record<string, ComponentDescriptor>;
28
- settings_descriptors: Record<string, SettingDescriptor<SceneSettingType>>;
29
- });
30
- /**
31
- *
32
- */
33
- getComponentSerializer(componentName: ComponentType): ComponentSerializer | undefined;
34
- }
@@ -1,12 +0,0 @@
1
- import { UUID } from "../../sources/types";
2
- /**
3
- * Client interface.
4
- *
5
- * @category Core
6
- */
7
- export interface ClientInterface {
8
- /**
9
- * Must return the client unique identifier in UUID format.
10
- */
11
- get id(): UUID;
12
- }
@@ -1,20 +0,0 @@
1
- import { UUID, RTID } from "../types";
2
- /**
3
- * Entity interface.
4
- *
5
- * @category Core
6
- */
7
- export interface EntityInterface {
8
- /**
9
- * Must return the entity Real-Time Identifier or null if the entity has not been instantiated yet.
10
- */
11
- get rtid(): RTID | null;
12
- /**
13
- * Must return the entity unique identifier in UUID format.
14
- */
15
- get id(): UUID | null;
16
- /**
17
- * Must serialize the entity to JSON format.
18
- */
19
- toJSON(): Record<string, unknown>;
20
- }
@@ -1,3 +0,0 @@
1
- export * from "./ClientInterface";
2
- export * from "./EntityInterface";
3
- export * from "./SessionInterface";