UNPKG

2.26 kBTypeScriptView Raw
1import { FixtureState } from './fixtureState';
2export declare type RendererId = string;
3export declare type FixtureNamesByPath = {
4 [fixturePath: string]: null | string[];
5};
6export declare type FixtureId = {
7 path: string;
8 name: null | string;
9};
10export declare type PingRenderersRequest = {
11 type: 'pingRenderers';
12};
13export declare type SelectFixtureRequest = {
14 type: 'selectFixture';
15 payload: {
16 rendererId: RendererId;
17 fixtureId: FixtureId;
18 fixtureState: FixtureState;
19 };
20};
21export declare type UnselectFixtureRequest = {
22 type: 'unselectFixture';
23 payload: {
24 rendererId: RendererId;
25 };
26};
27export declare type SetFixtureStateRequest = {
28 type: 'setFixtureState';
29 payload: {
30 rendererId: RendererId;
31 fixtureId: FixtureId;
32 fixtureState: FixtureState;
33 };
34};
35export declare type RendererRequest = PingRenderersRequest | SelectFixtureRequest | UnselectFixtureRequest | SetFixtureStateRequest;
36export declare type RendererReadyResponse = {
37 type: 'rendererReady';
38 payload: {
39 rendererId: RendererId;
40 fixtures: FixtureNamesByPath;
41 };
42};
43export declare type RendererErrorResponse = {
44 type: 'rendererError';
45 payload: {
46 rendererId: RendererId;
47 };
48};
49export declare type FixtureListUpdateResponse = {
50 type: 'fixtureListUpdate';
51 payload: {
52 rendererId: RendererId;
53 fixtures: FixtureNamesByPath;
54 };
55};
56export declare type FixtureStateChangeResponse = {
57 type: 'fixtureStateChange';
58 payload: {
59 rendererId: RendererId;
60 fixtureId: FixtureId;
61 fixtureState: FixtureState;
62 };
63};
64export declare type PlaygroundCommandResponse = {
65 type: 'playgroundCommand';
66 payload: {
67 command: string;
68 };
69};
70export declare type RendererResponse = RendererReadyResponse | RendererErrorResponse | FixtureListUpdateResponse | FixtureStateChangeResponse | PlaygroundCommandResponse;
71export declare type RendererConnect<Request = RendererRequest, Response = RendererResponse> = {
72 postMessage: (msg: Response) => unknown;
73 onMessage(handler: (msg: Request) => unknown): () => unknown;
74};
75export declare const RENDERER_MESSAGE_EVENT_NAME = "cosmos-renderer-message";