@seatschart/vue 0.1.0 → 0.2.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/LICENSE CHANGED
@@ -1,21 +1,21 @@
1
- MIT License
2
-
3
- Copyright (c) 2026 SeatsChart
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
1
+ MIT License
2
+
3
+ Copyright (c) 2026 SeatsChart
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,135 +1,135 @@
1
- # @seatschart/vue
2
-
3
- Vue 3 components for SeatsChart: the buyer seat chart, the Event Manager and the map designer. They are thin wrappers
4
- over the script-tag host API of [`@seatschart/embed`](https://www.npmjs.com/package/@seatschart/embed) (`SeatsChart`,
5
- `SeatsChartEventManager`, `SeatsChartDesigner`): same options, seats.io-compatible callback names and the same
6
- commands. Works with Nuxt: nothing touches `window` at import and the iframe is created on mount only.
7
-
8
- ## Install
9
-
10
- ```bash
11
- npm install @seatschart/vue @seatschart/embed
12
- ```
13
-
14
- Vue 3.3 or newer.
15
-
16
- ## Buyer seat chart
17
-
18
- `token` is a short-lived buyer JWT minted by your server with the API key (`POST /api/viewer-tokens`). Never pass an
19
- API key or a secret to the browser.
20
-
21
- ```vue
22
- <script setup lang="ts">
23
- import { ref } from "vue";
24
- import { SeatChart, useSeatChart } from "@seatschart/vue";
25
-
26
- const props = defineProps<{ eventId: string; jwt: string }>();
27
- const chart = useSeatChart(); // typed template ref (SeatChartHandle | null)
28
- const cart = ref<string[]>([]);
29
- const maxSeats = ref(4);
30
- </script>
31
-
32
- <template>
33
- <SeatChart
34
- ref="chart"
35
- class="seat-map"
36
- web-base="https://your-tenant.seatschart.com"
37
- :event="props.eventId"
38
- :token="props.jwt"
39
- language="pt"
40
- :height="640"
41
- :max-selected-objects="maxSeats"
42
- :object-color="{ byStatus: { locked: '#f59e0b' } }"
43
- :settings3d="{ lightPreset: 'exteriorSunset' }"
44
- @chart-rendered="(e) => console.log('ready', e.objectCount)"
45
- @object-selected="(e) => cart.push(e.label)"
46
- @object-deselected="(e) => (cart = cart.filter((l) => l !== e.label))"
47
- @session-hold="(e) => console.log('hold token', e.holdToken)"
48
- @hold-failed="(e) => console.error(e.objectIds, e.message)"
49
- />
50
- <button type="button" @click="chart?.clearSelection()">Clear</button>
51
- <button type="button" @click="chart?.selectBestAvailable({ number: 2, categories: ['VIP'] })">Best 2 VIP</button>
52
- <button type="button" @click="chart?.showViewFromSeat(cart[0] ?? '')">View from seat</button>
53
- </template>
54
- ```
55
-
56
- - **Props** are the `SeatsChart` options of `@seatschart/embed` (`event`, `token`, `webBase`, `parentOrigin`,
57
- `channel`, `channelKey(s)`, `holdToken`, `pricing`, `language`, `theme`, `defaultRenderer`, …) and every declarative
58
- renderer option (`objectColor`, `objectLabel`, `tooltip`, `maxSelectedObjects`, `legend`, `filterControls`,
59
- `settings3d`, …). The chart `style` option (`{ font, cornerRadius, buttonShape }`) is **`chart-style`**: `class` and
60
- `style` style the wrapper `<div data-seatschart-chart>`; `class-name` styles the iframe.
61
- - **Reactive updates**: values are compared, not identities (nested changes count). Declarative options and `pricing`
62
- are applied live with `changeConfig` (no reload); `height`, `title` and `class-name` update the iframe in place; any
63
- other prop re-renders the iframe and the hold session continues.
64
- - **Events**: every chart callback, kebab-case without `on`: `@object-selected`, `@object-clicked`,
65
- `@hold-succeeded`, `@hold-confirmed`, `@selection-invalid`, `@best-available-selected`, `@floor-changed`,
66
- `@full-screen-opened`, `@hold-created` (`SEATSCHART_RESERVATION_SUCCESS`), … (payloads as in `@seatschart/embed`).
67
- - **Host-drawn prompts**: a `@places-prompt`, `@ticket-type-prompt` or `@places-with-ticket-types-prompt` handler
68
- switches that viewer prompt to your page; it gets `(params, confirm, cancel)`.
69
- - **Template ref** (`SeatChartHandle`): every `SeatsChart` command — `selectObjects`, `deselectObjects`,
70
- `clearSelection`, `trySelectObjects`, `selectBestAvailable`, `changeConfig`, `setFilters`, `zoomToObjects`,
71
- `zoomToSection`, `goToFloor`, `showViewFromSeat`, `getHoldToken`, `releaseHoldToken`, `exportImage`, … Each resolves
72
- once the chart rendered and rejects with `ChartCommandError`. Also `selectedObjects`, `holdToken`, `chart` (the
73
- `SeatsChart` instance), `getIframe()` and `rerender()`.
74
- - **Cleanup**: unmounting removes the iframe and its message listener; pending commands reject.
75
-
76
- ## Event Manager (back office)
77
-
78
- ```vue
79
- <script setup lang="ts">
80
- import { EventManager, useEventManager } from "@seatschart/vue";
81
- const manager = useEventManager();
82
- </script>
83
-
84
- <template>
85
- <EventManager
86
- ref="manager"
87
- web-base="https://your-tenant.seatschart.com"
88
- :event="eventId"
89
- :token="managerEmbedToken"
90
- mode="select"
91
- color-scheme="auto"
92
- :max-selected-objects="8"
93
- @selection-changed="(objects) => (cart = objects.map((o) => o.label))"
94
- />
95
- <button type="button" @click="manager?.setHighlightedObjects(['A-1'])">Highlight A-1</button>
96
- </template>
97
- ```
98
-
99
- Selectability rules, `max-selected-objects`, `selected-objects`, `order`, `filters`, `language` and `color-scheme`
100
- change live (`changeConfig`); `mode`, `event` or `token` re-render the iframe. The ref has every
101
- `SeatsChartEventManager` command (`listSelectedObjects`, `selectObjects`, `listOrderChanges`, `zoomToObjects`, …).
102
-
103
- ## Designer
104
-
105
- ```vue
106
- <script setup lang="ts">
107
- import { Designer, useDesigner } from "@seatschart/vue";
108
- const designer = useDesigner();
109
- </script>
110
-
111
- <template>
112
- <Designer
113
- ref="designer"
114
- web-base="https://your-tenant.seatschart.com"
115
- :token="designerEmbedToken"
116
- :chart-id="chartId"
117
- mode="safe"
118
- canvas-color-scheme="dark"
119
- @chart-updated="(id) => (saved = true)"
120
- @exit-requested="router.back()"
121
- />
122
- <button type="button" @click="designer?.publish('Summer layout')">Publish</button>
123
- </template>
124
- ```
125
-
126
- Without `chart-id` the designer creates a chart (`@chart-created`). The Exit button shows only with an
127
- `@exit-requested` handler. `language`, `color-scheme`, `canvas-color-scheme`, `mode` and `safe-mode-options` change
128
- live. The ref has `save()`, `publish(note?)`, `getState()`, `changeConfig()` and `chartId`.
129
-
130
- ## Documentation
131
-
132
- - [Embed guide](https://github.com/seatschart/seatschart-prod/blob/main/docs/locales/en/README.md) and
133
- [Quickstart](https://github.com/seatschart/seatschart-prod/blob/main/docs/locales/en/QUICKSTART.md)
134
- - Every option, callback and command: `@seatschart/embed` (`SeatsChartConfig`, `SeatsChartEventManagerConfig`,
135
- `SeatsChartDesignerConfig`).
1
+ # @seatschart/vue
2
+
3
+ Vue 3 components for SeatsChart: the buyer seat chart, the Event Manager and the map designer. They are thin wrappers
4
+ over the script-tag host API of [`@seatschart/embed`](https://www.npmjs.com/package/@seatschart/embed) (`SeatsChart`,
5
+ `SeatsChartEventManager`, `SeatsChartDesigner`): same options, seats.io-compatible callback names and the same
6
+ commands. Works with Nuxt: nothing touches `window` at import and the iframe is created on mount only.
7
+
8
+ ## Install
9
+
10
+ ```bash
11
+ npm install @seatschart/vue @seatschart/embed
12
+ ```
13
+
14
+ Vue 3.3 or newer.
15
+
16
+ ## Buyer seat chart
17
+
18
+ `token` is a short-lived buyer JWT minted by your server with the API key (`POST /api/viewer-tokens`). Never pass an
19
+ API key or a secret to the browser.
20
+
21
+ ```vue
22
+ <script setup lang="ts">
23
+ import { ref } from "vue";
24
+ import { SeatChart, useSeatChart } from "@seatschart/vue";
25
+
26
+ const props = defineProps<{ eventId: string; jwt: string }>();
27
+ const chart = useSeatChart(); // typed template ref (SeatChartHandle | null)
28
+ const cart = ref<string[]>([]);
29
+ const maxSeats = ref(4);
30
+ </script>
31
+
32
+ <template>
33
+ <SeatChart
34
+ ref="chart"
35
+ class="seat-map"
36
+ web-base="https://your-tenant.seatschart.com"
37
+ :event="props.eventId"
38
+ :token="props.jwt"
39
+ language="pt"
40
+ :height="640"
41
+ :max-selected-objects="maxSeats"
42
+ :object-color="{ byStatus: { locked: '#f59e0b' } }"
43
+ :settings3d="{ lightPreset: 'exteriorSunset' }"
44
+ @chart-rendered="(e) => console.log('ready', e.objectCount)"
45
+ @object-selected="(e) => cart.push(e.label)"
46
+ @object-deselected="(e) => (cart = cart.filter((l) => l !== e.label))"
47
+ @session-hold="(e) => console.log('hold token', e.holdToken)"
48
+ @hold-failed="(e) => console.error(e.objectIds, e.message)"
49
+ />
50
+ <button type="button" @click="chart?.clearSelection()">Clear</button>
51
+ <button type="button" @click="chart?.selectBestAvailable({ number: 2, categories: ['VIP'] })">Best 2 VIP</button>
52
+ <button type="button" @click="chart?.showViewFromSeat(cart[0] ?? '')">View from seat</button>
53
+ </template>
54
+ ```
55
+
56
+ - **Props** are the `SeatsChart` options of `@seatschart/embed` (`event`, `token`, `webBase`, `parentOrigin`,
57
+ `channel`, `channelKey(s)`, `holdToken`, `pricing`, `language`, `theme`, `defaultRenderer`, …) and every declarative
58
+ renderer option (`objectColor`, `objectLabel`, `tooltip`, `maxSelectedObjects`, `legend`, `filterControls`,
59
+ `settings3d`, …). The chart `style` option (`{ font, cornerRadius, buttonShape }`) is **`chart-style`**: `class` and
60
+ `style` style the wrapper `<div data-seatschart-chart>`; `class-name` styles the iframe.
61
+ - **Reactive updates**: values are compared, not identities (nested changes count). Declarative options and `pricing`
62
+ are applied live with `changeConfig` (no reload); `height`, `title` and `class-name` update the iframe in place; any
63
+ other prop re-renders the iframe and the hold session continues.
64
+ - **Events**: every chart callback, kebab-case without `on`: `@object-selected`, `@object-clicked`,
65
+ `@hold-succeeded`, `@hold-confirmed`, `@selection-invalid`, `@best-available-selected`, `@floor-changed`,
66
+ `@full-screen-opened`, `@hold-created` (`SEATSCHART_RESERVATION_SUCCESS`), … (payloads as in `@seatschart/embed`).
67
+ - **Host-drawn prompts**: a `@places-prompt`, `@ticket-type-prompt` or `@places-with-ticket-types-prompt` handler
68
+ switches that viewer prompt to your page; it gets `(params, confirm, cancel)`.
69
+ - **Template ref** (`SeatChartHandle`): every `SeatsChart` command — `selectObjects`, `deselectObjects`,
70
+ `clearSelection`, `trySelectObjects`, `selectBestAvailable`, `changeConfig`, `setFilters`, `zoomToObjects`,
71
+ `zoomToSection`, `goToFloor`, `showViewFromSeat`, `getHoldToken`, `releaseHoldToken`, `exportImage`, … Each resolves
72
+ once the chart rendered and rejects with `ChartCommandError`. Also `selectedObjects`, `holdToken`, `chart` (the
73
+ `SeatsChart` instance), `getIframe()` and `rerender()`.
74
+ - **Cleanup**: unmounting removes the iframe and its message listener; pending commands reject.
75
+
76
+ ## Event Manager (back office)
77
+
78
+ ```vue
79
+ <script setup lang="ts">
80
+ import { EventManager, useEventManager } from "@seatschart/vue";
81
+ const manager = useEventManager();
82
+ </script>
83
+
84
+ <template>
85
+ <EventManager
86
+ ref="manager"
87
+ web-base="https://your-tenant.seatschart.com"
88
+ :event="eventId"
89
+ :token="managerEmbedToken"
90
+ mode="select"
91
+ color-scheme="auto"
92
+ :max-selected-objects="8"
93
+ @selection-changed="(objects) => (cart = objects.map((o) => o.label))"
94
+ />
95
+ <button type="button" @click="manager?.setHighlightedObjects(['A-1'])">Highlight A-1</button>
96
+ </template>
97
+ ```
98
+
99
+ Selectability rules, `max-selected-objects`, `selected-objects`, `order`, `filters`, `language` and `color-scheme`
100
+ change live (`changeConfig`); `mode`, `event` or `token` re-render the iframe. The ref has every
101
+ `SeatsChartEventManager` command (`listSelectedObjects`, `selectObjects`, `listOrderChanges`, `zoomToObjects`, …).
102
+
103
+ ## Designer
104
+
105
+ ```vue
106
+ <script setup lang="ts">
107
+ import { Designer, useDesigner } from "@seatschart/vue";
108
+ const designer = useDesigner();
109
+ </script>
110
+
111
+ <template>
112
+ <Designer
113
+ ref="designer"
114
+ web-base="https://your-tenant.seatschart.com"
115
+ :token="designerEmbedToken"
116
+ :chart-id="chartId"
117
+ mode="safe"
118
+ canvas-color-scheme="dark"
119
+ @chart-updated="(id) => (saved = true)"
120
+ @exit-requested="router.back()"
121
+ />
122
+ <button type="button" @click="designer?.publish('Summer layout')">Publish</button>
123
+ </template>
124
+ ```
125
+
126
+ Without `chart-id` the designer creates a chart (`@chart-created`). The Exit button shows only with an
127
+ `@exit-requested` handler. `language`, `color-scheme`, `canvas-color-scheme`, `mode` and `safe-mode-options` change
128
+ live. The ref has `save()`, `publish(note?)`, `getState()`, `changeConfig()` and `chartId`.
129
+
130
+ ## Documentation
131
+
132
+ - [Embed guide](https://github.com/seatschart/seatschart-prod/blob/main/docs/locales/en/README.md) and
133
+ [Quickstart](https://github.com/seatschart/seatschart-prod/blob/main/docs/locales/en/QUICKSTART.md)
134
+ - Every option, callback and command: `@seatschart/embed` (`SeatsChartConfig`, `SeatsChartEventManagerConfig`,
135
+ `SeatsChartDesignerConfig`).
@@ -37,7 +37,7 @@ export declare const Designer: import("vue").DefineSetupFnComponent<DesignerProp
37
37
  colorScheme?: "auto" | "dark" | "light" | undefined;
38
38
  features?: import("@seatschart/embed").DesignerFeatureGates | undefined;
39
39
  height?: string | number | undefined;
40
- language?: "de" | "en" | "es" | "fr" | "it" | "ja" | "ko" | "nl" | "pl" | "pt" | "tr" | "zh" | undefined;
40
+ language?: "ar" | "az" | "bn" | "de" | "en" | "es" | "fa" | "fr" | "gu" | "hi" | "id" | "it" | "ja" | "kk" | "kn" | "ko" | "ml" | "mr" | "ms" | "nl" | "pl" | "ps" | "pt" | "ru" | "ta" | "te" | "th" | "tr" | "uk" | "ur" | "vi" | "zh" | undefined;
41
41
  mode?: "normal" | "readOnly" | "safe" | undefined;
42
42
  openDraftDrawing?: boolean | undefined;
43
43
  openLatestDrawing?: boolean | undefined;
@@ -63,7 +63,7 @@ export declare const SeatChart: import("vue").DefineSetupFnComponent<SeatChartPr
63
63
  holdToken?: string | undefined;
64
64
  holdTokenInputName?: string | undefined;
65
65
  isObjectVisible?: import("@seatschart/embed").ObjectOverrides<boolean> | undefined;
66
- language?: "de" | "en" | "es" | "fr" | "it" | "ja" | "ko" | "nl" | "pl" | "pt" | "tr" | "zh" | undefined;
66
+ language?: "ar" | "az" | "bn" | "de" | "en" | "es" | "fa" | "fr" | "gu" | "hi" | "id" | "it" | "ja" | "kk" | "kn" | "ko" | "ml" | "mr" | "ms" | "nl" | "pl" | "ps" | "pt" | "ru" | "ta" | "te" | "th" | "tr" | "uk" | "ur" | "vi" | "zh" | undefined;
67
67
  legend?: import("@seatschart/embed").LegendConfig | undefined;
68
68
  loading?: import("@seatschart/embed").ChartLoadingConfig | undefined;
69
69
  lockActiveFloor?: boolean | undefined;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seatschart/vue",
3
- "version": "0.1.0",
3
+ "version": "0.2.0",
4
4
  "description": "Vue 3 components for SeatsChart seat maps: buyer chart, Event Manager and designer embeds",
5
5
  "type": "module",
6
6
  "license": "MIT",
@@ -41,7 +41,7 @@
41
41
  "vue": ">=3.3.0"
42
42
  },
43
43
  "dependencies": {
44
- "@seatschart/embed": "^0.5.0"
44
+ "@seatschart/embed": "^0.6.0"
45
45
  },
46
46
  "devDependencies": {
47
47
  "@happy-dom/global-registrator": "^21.0.4",