@kubex/zinc 1.1.3 → 1.1.5

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.
@@ -47,79 +47,6 @@
47
47
  }
48
48
  ]
49
49
  },
50
- {
51
- "kind": "javascript-module",
52
- "path": "components/action-bar/action-bar.js",
53
- "declarations": [
54
- {
55
- "kind": "class",
56
- "description": "",
57
- "name": "ZnActionBar",
58
- "cssProperties": [
59
- {
60
- "description": "An example CSS custom property.",
61
- "name": "--example"
62
- }
63
- ],
64
- "cssParts": [
65
- {
66
- "description": "The component's base wrapper.",
67
- "name": "base"
68
- }
69
- ],
70
- "slots": [
71
- {
72
- "description": "The default slot.",
73
- "name": ""
74
- },
75
- {
76
- "description": "An example slot.",
77
- "name": "example"
78
- }
79
- ],
80
- "members": [
81
- {
82
- "kind": "field",
83
- "name": "localize",
84
- "privacy": "private",
85
- "readonly": true,
86
- "default": "new LocalizeController(this)"
87
- }
88
- ],
89
- "events": [
90
- {
91
- "description": "Emitted as an example.",
92
- "name": "zn-event-name"
93
- }
94
- ],
95
- "superclass": {
96
- "name": "ZincElement",
97
- "module": "/src/internal/zinc-element"
98
- },
99
- "summary": "Short summary of the component's intended use.",
100
- "tagNameWithoutPrefix": "action-bar",
101
- "tagName": "zn-action-bar",
102
- "customElement": true,
103
- "jsDoc": "/**\n * @summary Short summary of the component's intended use.\n * @documentation https://zinc.style/components/action-bar\n * @status experimental\n * @since 1.0\n *\n * @dependency zn-example\n *\n * @event zn-event-name - Emitted as an example.\n *\n * @slot - The default slot.\n * @slot example - An example slot.\n *\n * @csspart base - The component's base wrapper.\n *\n * @cssproperty --example - An example CSS custom property.\n */",
104
- "documentation": "https://zinc.style/components/action-bar",
105
- "status": "experimental",
106
- "since": "1.0",
107
- "dependencies": [
108
- "zn-example"
109
- ]
110
- }
111
- ],
112
- "exports": [
113
- {
114
- "kind": "js",
115
- "name": "default",
116
- "declaration": {
117
- "name": "ZnActionBar",
118
- "module": "components/action-bar/action-bar.js"
119
- }
120
- }
121
- ]
122
- },
123
50
  {
124
51
  "kind": "javascript-module",
125
52
  "path": "components/alert/alert.js",
@@ -178,6 +105,16 @@
178
105
  "default": "false",
179
106
  "attribute": "collapse"
180
107
  },
108
+ {
109
+ "kind": "field",
110
+ "name": "appearance",
111
+ "type": {
112
+ "text": "'transparent' | 'solid'"
113
+ },
114
+ "default": "'transparent'",
115
+ "attribute": "appearance",
116
+ "reflects": true
117
+ },
181
118
  {
182
119
  "kind": "field",
183
120
  "name": "level",
@@ -233,6 +170,14 @@
233
170
  "default": "false",
234
171
  "fieldName": "collapse"
235
172
  },
173
+ {
174
+ "name": "appearance",
175
+ "type": {
176
+ "text": "'transparent' | 'solid'"
177
+ },
178
+ "default": "'transparent'",
179
+ "fieldName": "appearance"
180
+ },
236
181
  {
237
182
  "name": "level",
238
183
  "type": {
@@ -278,6 +223,79 @@
278
223
  }
279
224
  ]
280
225
  },
226
+ {
227
+ "kind": "javascript-module",
228
+ "path": "components/action-bar/action-bar.js",
229
+ "declarations": [
230
+ {
231
+ "kind": "class",
232
+ "description": "",
233
+ "name": "ZnActionBar",
234
+ "cssProperties": [
235
+ {
236
+ "description": "An example CSS custom property.",
237
+ "name": "--example"
238
+ }
239
+ ],
240
+ "cssParts": [
241
+ {
242
+ "description": "The component's base wrapper.",
243
+ "name": "base"
244
+ }
245
+ ],
246
+ "slots": [
247
+ {
248
+ "description": "The default slot.",
249
+ "name": ""
250
+ },
251
+ {
252
+ "description": "An example slot.",
253
+ "name": "example"
254
+ }
255
+ ],
256
+ "members": [
257
+ {
258
+ "kind": "field",
259
+ "name": "localize",
260
+ "privacy": "private",
261
+ "readonly": true,
262
+ "default": "new LocalizeController(this)"
263
+ }
264
+ ],
265
+ "events": [
266
+ {
267
+ "description": "Emitted as an example.",
268
+ "name": "zn-event-name"
269
+ }
270
+ ],
271
+ "superclass": {
272
+ "name": "ZincElement",
273
+ "module": "/src/internal/zinc-element"
274
+ },
275
+ "summary": "Short summary of the component's intended use.",
276
+ "tagNameWithoutPrefix": "action-bar",
277
+ "tagName": "zn-action-bar",
278
+ "customElement": true,
279
+ "jsDoc": "/**\n * @summary Short summary of the component's intended use.\n * @documentation https://zinc.style/components/action-bar\n * @status experimental\n * @since 1.0\n *\n * @dependency zn-example\n *\n * @event zn-event-name - Emitted as an example.\n *\n * @slot - The default slot.\n * @slot example - An example slot.\n *\n * @csspart base - The component's base wrapper.\n *\n * @cssproperty --example - An example CSS custom property.\n */",
280
+ "documentation": "https://zinc.style/components/action-bar",
281
+ "status": "experimental",
282
+ "since": "1.0",
283
+ "dependencies": [
284
+ "zn-example"
285
+ ]
286
+ }
287
+ ],
288
+ "exports": [
289
+ {
290
+ "kind": "js",
291
+ "name": "default",
292
+ "declaration": {
293
+ "name": "ZnActionBar",
294
+ "module": "components/action-bar/action-bar.js"
295
+ }
296
+ }
297
+ ]
298
+ },
281
299
  {
282
300
  "kind": "javascript-module",
283
301
  "path": "components/animated-button/animated-button.js",
@@ -2960,11 +2978,15 @@
2960
2978
  {
2961
2979
  "description": "The message content within the bubble.",
2962
2980
  "name": "content"
2981
+ },
2982
+ {
2983
+ "description": "The card rendered for system action types.",
2984
+ "name": "system-card"
2963
2985
  }
2964
2986
  ],
2965
2987
  "slots": [
2966
2988
  {
2967
- "description": "The message content.",
2989
+ "description": "The message content. Ignored when the `message` attribute is set.",
2968
2990
  "name": ""
2969
2991
  },
2970
2992
  {
@@ -2990,6 +3012,27 @@
2990
3012
  "static": true,
2991
3013
  "default": "{ 'zn-icon': ZnIcon }"
2992
3014
  },
3015
+ {
3016
+ "kind": "field",
3017
+ "name": "SYSTEM_ACTION_TYPES",
3018
+ "type": {
3019
+ "text": "readonly string[]"
3020
+ },
3021
+ "static": true,
3022
+ "readonly": true,
3023
+ "default": "[ 'connected.agent', 'attachment.added', 'transfer', 'ended', 'customer.ended', 'customer.connected', 'customer.disconnected', ]"
3024
+ },
3025
+ {
3026
+ "kind": "field",
3027
+ "name": "DISPLAYED_ACTION_TYPES",
3028
+ "type": {
3029
+ "text": "readonly string[]"
3030
+ },
3031
+ "privacy": "private",
3032
+ "static": true,
3033
+ "readonly": true,
3034
+ "default": "[ '', 'connected.agent', 'attachment.added', 'multi.answer', 'transfer', 'ended', 'error', 'customer.ended', 'message-sending', 'customer.connected', 'customer.disconnected', 'internal', ]"
3035
+ },
2993
3036
  {
2994
3037
  "kind": "field",
2995
3038
  "name": "sender",
@@ -2997,9 +3040,19 @@
2997
3040
  "text": "string"
2998
3041
  },
2999
3042
  "default": "''",
3000
- "description": "The sender's name, also used for the avatar initials.",
3043
+ "description": "The sender's name, also used for the avatar.",
3001
3044
  "attribute": "sender"
3002
3045
  },
3046
+ {
3047
+ "kind": "field",
3048
+ "name": "message",
3049
+ "type": {
3050
+ "text": "string"
3051
+ },
3052
+ "default": "''",
3053
+ "description": "The message body as an HTML string. When set, it is sanitized (scripts and event\nhandlers stripped), newlines become line breaks and bare URLs become links. When\nomitted the default slot is rendered instead.",
3054
+ "attribute": "message"
3055
+ },
3003
3056
  {
3004
3057
  "kind": "field",
3005
3058
  "name": "time",
@@ -3007,21 +3060,88 @@
3007
3060
  "text": "string"
3008
3061
  },
3009
3062
  "default": "''",
3010
- "description": "Unix timestamp (seconds) of the message, shown as HH:MM.",
3063
+ "description": "Unix timestamp (seconds) of the message, shown as HH:MM (with date if not today).",
3011
3064
  "attribute": "time"
3012
3065
  },
3066
+ {
3067
+ "kind": "field",
3068
+ "name": "avatar",
3069
+ "type": {
3070
+ "text": "string"
3071
+ },
3072
+ "default": "''",
3073
+ "description": "Overrides the avatar source. Defaults to `sender`.",
3074
+ "attribute": "avatar"
3075
+ },
3076
+ {
3077
+ "kind": "field",
3078
+ "name": "actionType",
3079
+ "type": {
3080
+ "text": "ChatMessageActionType"
3081
+ },
3082
+ "default": "''",
3083
+ "description": "The kind of message. Drives system-card rendering, the sending state and badges.",
3084
+ "attribute": "action-type",
3085
+ "reflects": true
3086
+ },
3087
+ {
3088
+ "kind": "field",
3089
+ "name": "customerInitiated",
3090
+ "type": {
3091
+ "text": "boolean"
3092
+ },
3093
+ "default": "false",
3094
+ "description": "Marks the message as initiated by the customer (affects styling and grouping).",
3095
+ "attribute": "customer-initiated",
3096
+ "reflects": true
3097
+ },
3098
+ {
3099
+ "kind": "field",
3100
+ "name": "agentInitiated",
3101
+ "type": {
3102
+ "text": "boolean"
3103
+ },
3104
+ "default": "false",
3105
+ "description": "Marks the message as initiated by an agent (affects styling and grouping).",
3106
+ "attribute": "agent-initiated",
3107
+ "reflects": true
3108
+ },
3109
+ {
3110
+ "kind": "method",
3111
+ "name": "isSystemMessage",
3112
+ "privacy": "private"
3113
+ },
3114
+ {
3115
+ "kind": "method",
3116
+ "name": "renderSystemCard",
3117
+ "privacy": "private"
3118
+ },
3119
+ {
3120
+ "kind": "method",
3121
+ "name": "systemLabel",
3122
+ "privacy": "private"
3123
+ },
3124
+ {
3125
+ "kind": "method",
3126
+ "name": "renderHeader",
3127
+ "privacy": "private"
3128
+ },
3129
+ {
3130
+ "kind": "method",
3131
+ "name": "renderContent",
3132
+ "privacy": "private"
3133
+ },
3013
3134
  {
3014
3135
  "kind": "method",
3015
3136
  "name": "getTime",
3016
3137
  "privacy": "private",
3017
- "parameters": [
3018
- {
3019
- "name": "time",
3020
- "type": {
3021
- "text": "string"
3022
- }
3023
- }
3024
- ]
3138
+ "description": "HH:MM only — used on the system card."
3139
+ },
3140
+ {
3141
+ "kind": "method",
3142
+ "name": "getSentTime",
3143
+ "privacy": "private",
3144
+ "description": "HH:MM, prefixed with the date when the message is not from today."
3025
3145
  }
3026
3146
  ],
3027
3147
  "attributes": [
@@ -3031,28 +3151,73 @@
3031
3151
  "text": "string"
3032
3152
  },
3033
3153
  "default": "''",
3034
- "description": "The sender's name, also used for the avatar initials.",
3154
+ "description": "The sender's name, also used for the avatar.",
3035
3155
  "fieldName": "sender"
3036
3156
  },
3157
+ {
3158
+ "name": "message",
3159
+ "type": {
3160
+ "text": "string"
3161
+ },
3162
+ "default": "''",
3163
+ "description": "The message body as an HTML string. When set, it is sanitized (scripts and event\nhandlers stripped), newlines become line breaks and bare URLs become links. When\nomitted the default slot is rendered instead.",
3164
+ "fieldName": "message"
3165
+ },
3037
3166
  {
3038
3167
  "name": "time",
3039
3168
  "type": {
3040
3169
  "text": "string"
3041
3170
  },
3042
3171
  "default": "''",
3043
- "description": "Unix timestamp (seconds) of the message, shown as HH:MM.",
3172
+ "description": "Unix timestamp (seconds) of the message, shown as HH:MM (with date if not today).",
3044
3173
  "fieldName": "time"
3174
+ },
3175
+ {
3176
+ "name": "avatar",
3177
+ "type": {
3178
+ "text": "string"
3179
+ },
3180
+ "default": "''",
3181
+ "description": "Overrides the avatar source. Defaults to `sender`.",
3182
+ "fieldName": "avatar"
3183
+ },
3184
+ {
3185
+ "name": "action-type",
3186
+ "type": {
3187
+ "text": "ChatMessageActionType"
3188
+ },
3189
+ "default": "''",
3190
+ "description": "The kind of message. Drives system-card rendering, the sending state and badges.",
3191
+ "fieldName": "actionType"
3192
+ },
3193
+ {
3194
+ "name": "customer-initiated",
3195
+ "type": {
3196
+ "text": "boolean"
3197
+ },
3198
+ "default": "false",
3199
+ "description": "Marks the message as initiated by the customer (affects styling and grouping).",
3200
+ "fieldName": "customerInitiated"
3201
+ },
3202
+ {
3203
+ "name": "agent-initiated",
3204
+ "type": {
3205
+ "text": "boolean"
3206
+ },
3207
+ "default": "false",
3208
+ "description": "Marks the message as initiated by an agent (affects styling and grouping).",
3209
+ "fieldName": "agentInitiated"
3045
3210
  }
3046
3211
  ],
3047
3212
  "superclass": {
3048
3213
  "name": "ZincElement",
3049
3214
  "module": "/src/internal/zinc-element"
3050
3215
  },
3051
- "summary": "A single message in a chat-style conversation: avatar, sender,\ntime, optional badge, and a message bubble with optional actions.",
3216
+ "summary": "A single message in a chat-style conversation: avatar, sender,\ntime, optional badge, and a message bubble with optional actions. Also renders\nsystem events (connections, transfers, etc.) as a centred card.",
3052
3217
  "tagNameWithoutPrefix": "chat-message",
3053
3218
  "tagName": "zn-chat-message",
3054
3219
  "customElement": true,
3055
- "jsDoc": "/**\n * @summary A single message in a chat-style conversation: avatar, sender,\n * time, optional badge, and a message bubble with optional actions.\n * @documentation https://zinc.style/components/chat-message\n * @status experimental\n * @since 1.0\n *\n * @dependency zn-icon\n *\n * @slot - The message content.\n * @slot badge - Rendered in the header after the sender and time (e.g. an INTERNAL NOTE chip).\n * @slot edit-dialog-trigger - Action rendered at the end of the bubble (e.g. a remove icon button).\n * @slot edit-dialog - Pass-through for an associated dialog element.\n *\n * @csspart base - The component's base wrapper.\n * @csspart avatar - The avatar column.\n * @csspart body - The header and bubble column.\n * @csspart header - The sender/time/badge row.\n * @csspart bubble - The message bubble.\n * @csspart content - The message content within the bubble.\n *\n * @cssproperty --message-background - The bubble's background colour.\n */",
3220
+ "jsDoc": "/**\n * @summary A single message in a chat-style conversation: avatar, sender,\n * time, optional badge, and a message bubble with optional actions. Also renders\n * system events (connections, transfers, etc.) as a centred card.\n * @documentation https://zinc.style/components/chat-message\n * @status experimental\n * @since 1.0\n *\n * @dependency zn-icon\n *\n * @slot - The message content. Ignored when the `message` attribute is set.\n * @slot badge - Rendered in the header after the sender and time (e.g. an INTERNAL NOTE chip).\n * @slot edit-dialog-trigger - Action rendered at the end of the bubble (e.g. a remove icon button).\n * @slot edit-dialog - Pass-through for an associated dialog element.\n *\n * @csspart base - The component's base wrapper.\n * @csspart avatar - The avatar column.\n * @csspart body - The header and bubble column.\n * @csspart header - The sender/time/badge row.\n * @csspart bubble - The message bubble.\n * @csspart content - The message content within the bubble.\n * @csspart system-card - The card rendered for system action types.\n *\n * @cssproperty --message-background - The bubble's background colour.\n */",
3056
3221
  "documentation": "https://zinc.style/components/chat-message",
3057
3222
  "status": "experimental",
3058
3223
  "since": "1.0",
@@ -36151,7 +36316,7 @@
36151
36316
  "package": {
36152
36317
  "name": "@kubex/zinc",
36153
36318
  "description": "A collection of web components for building web applications based off of @shoelace-style/Shoelace",
36154
- "version": "1.1.3",
36319
+ "version": "1.1.5",
36155
36320
  "author": "",
36156
36321
  "license": "MIT"
36157
36322
  }
@@ -13,17 +13,6 @@
13
13
  }
14
14
  ]
15
15
  },
16
- {
17
- "name": "zn-action-bar",
18
- "description": "Short summary of the component's intended use.\n---\n\n\n### **Events:**\n - **zn-event-name** - Emitted as an example.\n\n### **Slots:**\n - _default_ - The default slot.\n- **example** - An example slot.\n\n### **CSS Properties:**\n - **--example** - An example CSS custom property. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
19
- "attributes": [],
20
- "references": [
21
- {
22
- "name": "Documentation",
23
- "url": "https://zinc.style/components/action-bar"
24
- }
25
- ]
26
- },
27
16
  {
28
17
  "name": "zn-alert",
29
18
  "description": "Short summary of the component's intended use.\n---\n\n\n### **Events:**\n - **zn-event-name** - Emitted as an example.\n\n### **Slots:**\n - _default_ - The default slot.\n- **example** - An example slot.\n\n### **CSS Properties:**\n - **--example** - An example CSS custom property. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
@@ -31,6 +20,10 @@
31
20
  { "name": "icon", "values": [] },
32
21
  { "name": "caption", "values": [] },
33
22
  { "name": "collapse", "values": [] },
23
+ {
24
+ "name": "appearance",
25
+ "values": [{ "name": "transparent" }, { "name": "solid" }]
26
+ },
34
27
  {
35
28
  "name": "level",
36
29
  "values": [
@@ -59,6 +52,17 @@
59
52
  }
60
53
  ]
61
54
  },
55
+ {
56
+ "name": "zn-action-bar",
57
+ "description": "Short summary of the component's intended use.\n---\n\n\n### **Events:**\n - **zn-event-name** - Emitted as an example.\n\n### **Slots:**\n - _default_ - The default slot.\n- **example** - An example slot.\n\n### **CSS Properties:**\n - **--example** - An example CSS custom property. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
58
+ "attributes": [],
59
+ "references": [
60
+ {
61
+ "name": "Documentation",
62
+ "url": "https://zinc.style/components/action-bar"
63
+ }
64
+ ]
65
+ },
62
66
  {
63
67
  "name": "zn-animated-button",
64
68
  "description": "\n---\n\n\n### **Methods:**\n - **purchase(): _void_** - Programmatically trigger the purchase flow\n- **setSuccess(): _void_** - Set the button to success state manually\n- **setFailure(message): _void_** - Set the button to failure state manually with optional error message\n- **reset(): _void_** - Reset the button to idle state",
@@ -357,16 +361,41 @@
357
361
  },
358
362
  {
359
363
  "name": "zn-chat-message",
360
- "description": "A single message in a chat-style conversation: avatar, sender,\ntime, optional badge, and a message bubble with optional actions.\n---\n\n\n### **Slots:**\n - _default_ - The message content.\n- **badge** - Rendered in the header after the sender and time (e.g. an INTERNAL NOTE chip).\n- **edit-dialog-trigger** - Action rendered at the end of the bubble (e.g. a remove icon button).\n- **edit-dialog** - Pass-through for an associated dialog element.\n\n### **CSS Properties:**\n - **--message-background** - The bubble's background colour. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **avatar** - The avatar column.\n- **body** - The header and bubble column.\n- **header** - The sender/time/badge row.\n- **bubble** - The message bubble.\n- **content** - The message content within the bubble.",
364
+ "description": "A single message in a chat-style conversation: avatar, sender,\ntime, optional badge, and a message bubble with optional actions. Also renders\nsystem events (connections, transfers, etc.) as a centred card.\n---\n\n\n### **Slots:**\n - _default_ - The message content. Ignored when the `message` attribute is set.\n- **badge** - Rendered in the header after the sender and time (e.g. an INTERNAL NOTE chip).\n- **edit-dialog-trigger** - Action rendered at the end of the bubble (e.g. a remove icon button).\n- **edit-dialog** - Pass-through for an associated dialog element.\n\n### **CSS Properties:**\n - **--message-background** - The bubble's background colour. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **avatar** - The avatar column.\n- **body** - The header and bubble column.\n- **header** - The sender/time/badge row.\n- **bubble** - The message bubble.\n- **content** - The message content within the bubble.\n- **system-card** - The card rendered for system action types.",
361
365
  "attributes": [
362
366
  {
363
367
  "name": "sender",
364
- "description": "The sender's name, also used for the avatar initials.",
368
+ "description": "The sender's name, also used for the avatar.",
369
+ "values": []
370
+ },
371
+ {
372
+ "name": "message",
373
+ "description": "The message body as an HTML string. When set, it is sanitized (scripts and event\nhandlers stripped), newlines become line breaks and bare URLs become links. When\nomitted the default slot is rendered instead.",
365
374
  "values": []
366
375
  },
367
376
  {
368
377
  "name": "time",
369
- "description": "Unix timestamp (seconds) of the message, shown as HH:MM.",
378
+ "description": "Unix timestamp (seconds) of the message, shown as HH:MM (with date if not today).",
379
+ "values": []
380
+ },
381
+ {
382
+ "name": "avatar",
383
+ "description": "Overrides the avatar source. Defaults to `sender`.",
384
+ "values": []
385
+ },
386
+ {
387
+ "name": "action-type",
388
+ "description": "The kind of message. Drives system-card rendering, the sending state and badges.",
389
+ "values": [{ "name": "ChatMessageActionType" }]
390
+ },
391
+ {
392
+ "name": "customer-initiated",
393
+ "description": "Marks the message as initiated by the customer (affects styling and grouping).",
394
+ "values": []
395
+ },
396
+ {
397
+ "name": "agent-initiated",
398
+ "description": "Marks the message as initiated by an agent (affects styling and grouping).",
370
399
  "values": []
371
400
  }
372
401
  ],