Skip to content

Commit

Permalink
Fix/bridge version export (#18)
Browse files Browse the repository at this point in the history 
* fix an export issue with BridgeVersion
* file organization
  • Loading branch information
@BryanChrisBrown
BryanChrisBrown authored Jan 22, 2024
1 parent ae6a83d commit 0fd7e4b
Show file tree
Hide file tree
Showing 41 changed files with 324 additions and 615 deletions.
5 changes: 2 additions & 3 deletions docs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,15 @@

### Modules

- [client](modules/client.md)
- [components](modules/components.md)
- [client/BridgeClient](modules/client_BridgeClient.md)
- [components/displays](modules/components_displays.md)
- [components/endpoints](modules/components_endpoints.md)
- [components/eventsource](modules/components_eventsource.md)
- [components/fallback](modules/components_fallback.md)
- [components/hologram](modules/components_hologram.md)
- [components/messageHandler](modules/components_messageHandler.md)
- [components/orchestration](modules/components_orchestration.md)
- [index](modules/index.md)
- [components/types](modules/components_types.md)
- [playlists/playlist](modules/playlists_playlist.md)
- [playlists/playlistItems](modules/playlists_playlistItems.md)
- [schemas/defaults](modules/schemas_defaults.md)
Expand Down
160 changes: 80 additions & 80 deletions docs/classes/client.BridgeClient.md → ...asses/client_BridgeClient.BridgeClient.md
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/classes/components_messageHandler.MessageHandler.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@
| :------ | :------ |
| `args` | `Object` |
| `args.bridgeEventName` | `E` |
| `args.client` | [`BridgeClient`](client.BridgeClient.md) |
| `args.client` | [`BridgeClient`](client_BridgeClient.BridgeClient.md) |

## Properties

Expand All @@ -83,7 +83,7 @@ ___

### client

• **client**: [`BridgeClient`](client.BridgeClient.md)
• **client**: [`BridgeClient`](client_BridgeClient.BridgeClient.md)

## Methods

Expand Down
10 changes: 5 additions & 5 deletions docs/classes/components_messageHandler.MonitorConnectedMessageHandler.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
| Name | Type |
| :------ | :------ |
| `args` | `Object` |
| `args.client` | [`BridgeClient`](client.BridgeClient.md) |
| `args.client` | [`BridgeClient`](client_BridgeClient.BridgeClient.md) |

#### Overrides

Expand All @@ -56,7 +56,7 @@ ___

### client

• **client**: [`BridgeClient`](client.BridgeClient.md)
• **client**: [`BridgeClient`](client_BridgeClient.BridgeClient.md)

#### Inherited from

Expand All @@ -74,9 +74,9 @@ ___
| :------ | :------ | :------ |
| `message` | `Object` | `undefined` |
| `message.name` | `string` | `schema.name` |
| `message.orchestration` | { value: string; type: "WSTRING"; name: string; } | `undefined` |
| `message.payload` | { value: { message: { value: string; type: "WSTRING"; name: string; }; head\_index: { value: number; type: "UNSIGNED\_INT"; name: string; }; name: { value: string; type: "WSTRING"; name: string; }; event: { value: "Monitor Connect" \| ... 10 more ... \| "Transport Control Pause"; type: "WSTRING"; name: string; }; ... 7 ... | `undefined` |
| `message.status` | { value: "Completion" \| "Pending" \| "Failure" \| "UnknownOrchestration"; type: "WSTRING"; name: string; } | `schema.status` |
| `message.orchestration` | { value: string; name: string; type: "WSTRING"; } | `undefined` |
| `message.payload` | { value: { name: { value: string; name: string; type: "WSTRING"; }; message: { value: string; name: string; type: "WSTRING"; }; x: { value: number; name: string; type: "INT"; }; y: { value: number; name: string; type: "INT"; }; ... 7 more ...; width: { ...; }; }; name: string; type: "VARIANT\_MAP"; } | `undefined` |
| `message.status` | { value: "Completion" \| "UnknownOrchestration" \| "Pending" \| "Failure"; name: string; type: "WSTRING"; } | `schema.status` |

#### Returns

Expand Down
10 changes: 5 additions & 5 deletions docs/classes/components_messageHandler.MonitorDisconnectedMessageHandler.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
| Name | Type |
| :------ | :------ |
| `args` | `Object` |
| `args.client` | [`BridgeClient`](client.BridgeClient.md) |
| `args.client` | [`BridgeClient`](client_BridgeClient.BridgeClient.md) |

#### Overrides

Expand All @@ -56,7 +56,7 @@ ___

### client

• **client**: [`BridgeClient`](client.BridgeClient.md)
• **client**: [`BridgeClient`](client_BridgeClient.BridgeClient.md)

#### Inherited from

Expand All @@ -74,9 +74,9 @@ ___
| :------ | :------ | :------ |
| `message` | `Object` | `undefined` |
| `message.name` | `string` | `schema.name` |
| `message.orchestration` | { value: string; type: "WSTRING"; name: string; } | `undefined` |
| `message.payload` | { value: { message: { value: string; type: "WSTRING"; name: string; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 6 more ... \| "Transport Control Pause"; type: "WSTRING"; name: string; }; progress: { ...; }; progress\_type: { ...; }; }... | `undefined` |
| `message.status` | { value: "Completion" \| "Pending" \| "Failure" \| "UnknownOrchestration"; type: "WSTRING"; name: string; } | `schema.status` |
| `message.orchestration` | { value: string; name: string; type: "WSTRING"; } | `undefined` |
| `message.payload` | { value: { message: { value: string; name: string; type: "WSTRING"; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 6 more ... \| "Transport Control Pause"; name: string; type: "WSTRING"; }; progress: { ...; }; progress\_type: { ...; }; }... | `undefined` |
| `message.status` | { value: "Completion" \| "UnknownOrchestration" \| "Pending" \| "Failure"; name: string; type: "WSTRING"; } | `schema.status` |

#### Returns

Expand Down
10 changes: 5 additions & 5 deletions docs/classes/components_messageHandler.NewItemPlayingMessageHandler.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
| Name | Type |
| :------ | :------ |
| `args` | `Object` |
| `args.client` | [`BridgeClient`](client.BridgeClient.md) |
| `args.client` | [`BridgeClient`](client_BridgeClient.BridgeClient.md) |

#### Overrides

Expand All @@ -56,7 +56,7 @@ ___

### client

• **client**: [`BridgeClient`](client.BridgeClient.md)
• **client**: [`BridgeClient`](client_BridgeClient.BridgeClient.md)

#### Inherited from

Expand All @@ -74,9 +74,9 @@ ___
| :------ | :------ | :------ |
| `message` | `Object` | `undefined` |
| `message.name` | `string` | `schema.name` |
| `message.orchestration` | { value: string; type: "WSTRING"; name: string; } | `undefined` |
| `message.payload` | { value: { playlist\_name: { value: string; type: "WSTRING"; name: string; }; index: { value: number; type: "UNSIGNED\_INT"; name: string; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| ... 9 more ... \| "Transport Control Pause"; type: "WSTRING"; name: string; }; }; type: "VARIANT\_MAP"; name: string; } | `undefined` |
| `message.status` | { value: "Completion" \| "Pending" \| "Failure" \| "UnknownOrchestration"; type: "WSTRING"; name: string; } | `schema.status` |
| `message.orchestration` | { value: string; name: string; type: "WSTRING"; } | `undefined` |
| `message.payload` | { value: { index: { value: number; name: string; type: "UNSIGNED\_INT"; }; playlist\_name: { value: string; name: string; type: "WSTRING"; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| ... 9 more ... \| "Transport Control Pause"; name: string; type: "WSTRING"; }; }; name: string; type: "VARIANT\_MAP"; } | `undefined` |
| `message.status` | { value: "Completion" \| "UnknownOrchestration" \| "Pending" \| "Failure"; name: string; type: "WSTRING"; } | `schema.status` |

#### Returns

Expand Down
10 changes: 5 additions & 5 deletions docs/classes/components_messageHandler.PlaylistDeleteMessageHandler.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
| Name | Type |
| :------ | :------ |
| `args` | `Object` |
| `args.client` | [`BridgeClient`](client.BridgeClient.md) |
| `args.client` | [`BridgeClient`](client_BridgeClient.BridgeClient.md) |

#### Overrides

Expand All @@ -56,7 +56,7 @@ ___

### client

• **client**: [`BridgeClient`](client.BridgeClient.md)
• **client**: [`BridgeClient`](client_BridgeClient.BridgeClient.md)

#### Inherited from

Expand All @@ -74,9 +74,9 @@ ___
| :------ | :------ | :------ |
| `message` | `Object` | `undefined` |
| `message.name` | `string` | `schema.name` |
| `message.orchestration` | { value: string; type: "WSTRING"; name: string; } | `undefined` |
| `message.payload` | { value: { message: { value: string; type: "WSTRING"; name: string; }; name: { value: string; type: "WSTRING"; name: string; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| ... 8 more ... \| "Transport Control Pause"; type: "WSTRING"; name: string; }; }; type: "VARIANT\_MAP"; name: str... | `undefined` |
| `message.status` | { value: "Completion" \| "Pending" \| "Failure" \| "UnknownOrchestration"; type: "WSTRING"; name: string; } | `schema.status` |
| `message.orchestration` | { value: string; name: string; type: "WSTRING"; } | `undefined` |
| `message.payload` | { value: { name: { value: string; name: string; type: "WSTRING"; }; message: { value: string; name: string; type: "WSTRING"; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| ... 8 more ... \| "Transport Control Pause"; name: string; type: "WSTRING"; }; }; name: string; type: "VARIANT\_M... | `undefined` |
| `message.status` | { value: "Completion" \| "UnknownOrchestration" \| "Pending" \| "Failure"; name: string; type: "WSTRING"; } | `schema.status` |

#### Returns

Expand Down
10 changes: 5 additions & 5 deletions docs/classes/components_messageHandler.PlaylistInsertMessageHandler.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
| Name | Type |
| :------ | :------ |
| `args` | `Object` |
| `args.client` | [`BridgeClient`](client.BridgeClient.md) |
| `args.client` | [`BridgeClient`](client_BridgeClient.BridgeClient.md) |

#### Overrides

Expand All @@ -56,7 +56,7 @@ ___

### client

• **client**: [`BridgeClient`](client.BridgeClient.md)
• **client**: [`BridgeClient`](client_BridgeClient.BridgeClient.md)

#### Inherited from

Expand All @@ -74,9 +74,9 @@ ___
| :------ | :------ | :------ |
| `message` | `Object` | `undefined` |
| `message.name` | `string` | `schema.name` |
| `message.orchestration` | { value: string; type: "WSTRING"; name: string; } | `undefined` |
| `message.payload` | { value: { message: { value: string; type: "WSTRING"; name: string; }; uri: { value: string; type: "WSTRING"; name: string; }; index: { value: number; type: "UNSIGNED\_INT"; name: string; }; event: { value: "Monitor Connect" \| ... 10 more ... \| "Transport Control Pause"; type: "WSTRING"; name: string; }; }; type: "VA... | `undefined` |
| `message.status` | { value: "Completion" \| "Pending" \| "Failure" \| "UnknownOrchestration"; type: "WSTRING"; name: string; } | `schema.status` |
| `message.orchestration` | { value: string; name: string; type: "WSTRING"; } | `undefined` |
| `message.payload` | { value: { message: { value: string; name: string; type: "WSTRING"; }; index: { value: number; name: string; type: "UNSIGNED\_INT"; }; uri: { value: string; name: string; type: "WSTRING"; }; event: { value: "Monitor Connect" \| ... 10 more ... \| "Transport Control Pause"; name: string; type: "WSTRING"; }; }; name: str... | `undefined` |
| `message.status` | { value: "Completion" \| "UnknownOrchestration" \| "Pending" \| "Failure"; name: string; type: "WSTRING"; } | `schema.status` |

#### Returns

Expand Down
10 changes: 5 additions & 5 deletions docs/classes/components_messageHandler.PlaylistInstanceMessageHandler.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
| Name | Type |
| :------ | :------ |
| `args` | `Object` |
| `args.client` | [`BridgeClient`](client.BridgeClient.md) |
| `args.client` | [`BridgeClient`](client_BridgeClient.BridgeClient.md) |

#### Overrides

Expand All @@ -56,7 +56,7 @@ ___

### client

• **client**: [`BridgeClient`](client.BridgeClient.md)
• **client**: [`BridgeClient`](client_BridgeClient.BridgeClient.md)

#### Inherited from

Expand All @@ -74,9 +74,9 @@ ___
| :------ | :------ | :------ |
| `message` | `Object` | `undefined` |
| `message.name` | `string` | `schema.name` |
| `message.orchestration` | { value: string; type: "WSTRING"; name: string; } | `undefined` |
| `message.payload` | { value: { message: { value: string; type: "WSTRING"; name: string; }; name: { value: string; type: "WSTRING"; name: string; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| ... 8 more ... \| "Transport Control Pause"; type: "WSTRING"; name: string; }; }; type: "VARIANT\_MAP"; name: str... | `undefined` |
| `message.status` | { value: "Completion" \| "Pending" \| "Failure" \| "UnknownOrchestration"; type: "WSTRING"; name: string; } | `schema.status` |
| `message.orchestration` | { value: string; name: string; type: "WSTRING"; } | `undefined` |
| `message.payload` | { value: { name: { value: string; name: string; type: "WSTRING"; }; message: { value: string; name: string; type: "WSTRING"; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| ... 8 more ... \| "Transport Control Pause"; name: string; type: "WSTRING"; }; }; name: string; type: "VARIANT\_M... | `undefined` |
| `message.status` | { value: "Completion" \| "UnknownOrchestration" \| "Pending" \| "Failure"; name: string; type: "WSTRING"; } | `schema.status` |

#### Returns

Expand Down
10 changes: 5 additions & 5 deletions docs/classes/components_messageHandler.ProgressCompletionMessageHandler.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
| Name | Type |
| :------ | :------ |
| `args` | `Object` |
| `args.client` | [`BridgeClient`](client.BridgeClient.md) |
| `args.client` | [`BridgeClient`](client_BridgeClient.BridgeClient.md) |

#### Overrides

Expand All @@ -56,7 +56,7 @@ ___

### client

• **client**: [`BridgeClient`](client.BridgeClient.md)
• **client**: [`BridgeClient`](client_BridgeClient.BridgeClient.md)

#### Inherited from

Expand All @@ -74,9 +74,9 @@ ___
| :------ | :------ | :------ |
| `message` | `Object` | `undefined` |
| `message.name` | `string` | `schema.name` |
| `message.orchestration` | { value: string; type: "WSTRING"; name: string; } | `undefined` |
| `message.payload` | { value: { message: { value: string; type: "WSTRING"; name: string; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 6 more ... \| "Transport Control Pause"; type: "WSTRING"; name: string; }; progress: { ...; }; progress\_type: { ...; }; }... | `undefined` |
| `message.status` | { value: "Completion" \| "Pending" \| "Failure" \| "UnknownOrchestration"; type: "WSTRING"; name: string; } | `schema.status` |
| `message.orchestration` | { value: string; name: string; type: "WSTRING"; } | `undefined` |
| `message.payload` | { value: { message: { value: string; name: string; type: "WSTRING"; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 6 more ... \| "Transport Control Pause"; name: string; type: "WSTRING"; }; progress: { ...; }; progress\_type: { ...; }; }... | `undefined` |
| `message.status` | { value: "Completion" \| "UnknownOrchestration" \| "Pending" \| "Failure"; name: string; type: "WSTRING"; } | `schema.status` |

#### Returns

Expand Down
10 changes: 5 additions & 5 deletions docs/classes/components_messageHandler.ProgressStartMessageHandler.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
| Name | Type |
| :------ | :------ |
| `args` | `Object` |
| `args.client` | [`BridgeClient`](client.BridgeClient.md) |
| `args.client` | [`BridgeClient`](client_BridgeClient.BridgeClient.md) |

#### Overrides

Expand All @@ -56,7 +56,7 @@ ___

### client

• **client**: [`BridgeClient`](client.BridgeClient.md)
• **client**: [`BridgeClient`](client_BridgeClient.BridgeClient.md)

#### Inherited from

Expand All @@ -74,9 +74,9 @@ ___
| :------ | :------ | :------ |
| `message` | `Object` | `undefined` |
| `message.name` | `string` | `schema.name` |
| `message.orchestration` | { value: string; type: "WSTRING"; name: string; } | `undefined` |
| `message.payload` | { value: { message: { value: string; type: "WSTRING"; name: string; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 6 more ... \| "Transport Control Pause"; type: "WSTRING"; name: string; }; progress: { ...; }; progress\_type: { ...; }; }... | `undefined` |
| `message.status` | { value: "Completion" \| "Pending" \| "Failure" \| "UnknownOrchestration"; type: "WSTRING"; name: string; } | `schema.status` |
| `message.orchestration` | { value: string; name: string; type: "WSTRING"; } | `undefined` |
| `message.payload` | { value: { message: { value: string; name: string; type: "WSTRING"; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 6 more ... \| "Transport Control Pause"; name: string; type: "WSTRING"; }; progress: { ...; }; progress\_type: { ...; }; }... | `undefined` |
| `message.status` | { value: "Completion" \| "UnknownOrchestration" \| "Pending" \| "Failure"; name: string; type: "WSTRING"; } | `schema.status` |

#### Returns

Expand Down
10 changes: 5 additions & 5 deletions docs/classes/components_messageHandler.ProgressUpdateMessageHandler.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
| Name | Type |
| :------ | :------ |
| `args` | `Object` |
| `args.client` | [`BridgeClient`](client.BridgeClient.md) |
| `args.client` | [`BridgeClient`](client_BridgeClient.BridgeClient.md) |

#### Overrides

Expand All @@ -56,7 +56,7 @@ ___

### client

• **client**: [`BridgeClient`](client.BridgeClient.md)
• **client**: [`BridgeClient`](client_BridgeClient.BridgeClient.md)

#### Inherited from

Expand All @@ -74,9 +74,9 @@ ___
| :------ | :------ | :------ |
| `message` | `Object` | `undefined` |
| `message.name` | `string` | `schema.name` |
| `message.orchestration` | { value: string; type: "WSTRING"; name: string; } | `undefined` |
| `message.payload` | { value: { message: { value: string; type: "WSTRING"; name: string; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 6 more ... \| "Transport Control Pause"; type: "WSTRING"; name: string; }; progress: { ...; }; progress\_type: { ...; }; }... | `undefined` |
| `message.status` | { value: "Completion" \| "Pending" \| "Failure" \| "UnknownOrchestration"; type: "WSTRING"; name: string; } | `schema.status` |
| `message.orchestration` | { value: string; name: string; type: "WSTRING"; } | `undefined` |
| `message.payload` | { value: { message: { value: string; name: string; type: "WSTRING"; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 6 more ... \| "Transport Control Pause"; name: string; type: "WSTRING"; }; progress: { ...; }; progress\_type: { ...; }; }... | `undefined` |
| `message.status` | { value: "Completion" \| "UnknownOrchestration" \| "Pending" \| "Failure"; name: string; type: "WSTRING"; } | `schema.status` |

#### Returns

Expand Down
10 changes: 5 additions & 5 deletions docs/classes/components_messageHandler.SyncPlayPlaylistCancelledMessageHandler.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
| Name | Type |
| :------ | :------ |
| `args` | `Object` |
| `args.client` | [`BridgeClient`](client.BridgeClient.md) |
| `args.client` | [`BridgeClient`](client_BridgeClient.BridgeClient.md) |

#### Overrides

Expand All @@ -56,7 +56,7 @@ ___

### client

• **client**: [`BridgeClient`](client.BridgeClient.md)
• **client**: [`BridgeClient`](client_BridgeClient.BridgeClient.md)

#### Inherited from

Expand All @@ -74,9 +74,9 @@ ___
| :------ | :------ | :------ |
| `message` | `Object` | `undefined` |
| `message.name` | `string` | `schema.name` |
| `message.orchestration` | { value: string; type: "WSTRING"; name: string; } | `undefined` |
| `message.payload` | { value: { message: { value: string; type: "WSTRING"; name: string; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 6 more ... \| "Transport Control Pause"; type: "WSTRING"; name: string; }; progress: { ...; }; progress\_type: { ...; }; }... | `undefined` |
| `message.status` | { value: "Completion" \| "Pending" \| "Failure" \| "UnknownOrchestration"; type: "WSTRING"; name: string; } | `schema.status` |
| `message.orchestration` | { value: string; name: string; type: "WSTRING"; } | `undefined` |
| `message.payload` | { value: { message: { value: string; name: string; type: "WSTRING"; }; event: { value: "Monitor Connect" \| "Monitor Disconnect" \| "Progress Start" \| "Progress Completion" \| "Progress Update" \| ... 6 more ... \| "Transport Control Pause"; name: string; type: "WSTRING"; }; progress: { ...; }; progress\_type: { ...; }; }... | `undefined` |
| `message.status` | { value: "Completion" \| "UnknownOrchestration" \| "Pending" \| "Failure"; name: string; type: "WSTRING"; } | `schema.status` |

#### Returns

Expand Down
Loading

0 comments on commit 0fd7e4b

Please sign in to comment.