@channel.io/app-sdk-core 0.4.2 → 0.6.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.
- package/dist/extensions/command.d.ts +642 -0
- package/dist/extensions/command.d.ts.map +1 -1
- package/dist/extensions/command.js +77 -0
- package/dist/extensions/command.js.map +1 -1
- package/dist/extensions/customtab.d.ts +84 -22
- package/dist/extensions/customtab.d.ts.map +1 -1
- package/dist/extensions/customtab.js +26 -16
- package/dist/extensions/customtab.js.map +1 -1
- package/dist/extensions/index.d.ts +4 -3
- package/dist/extensions/index.d.ts.map +1 -1
- package/dist/extensions/index.js +5 -3
- package/dist/extensions/index.js.map +1 -1
- package/dist/extensions/interfaces/command.d.ts +108 -59
- package/dist/extensions/interfaces/command.d.ts.map +1 -1
- package/dist/extensions/interfaces/command.js +1 -0
- package/dist/extensions/interfaces/command.js.map +1 -1
- package/dist/extensions/interfaces/customtab.d.ts +67 -45
- package/dist/extensions/interfaces/customtab.d.ts.map +1 -1
- package/dist/extensions/interfaces/customtab.js +2 -2
- package/dist/extensions/interfaces/customtab.js.map +1 -1
- package/dist/extensions/interfaces/index.d.ts +1 -0
- package/dist/extensions/interfaces/index.d.ts.map +1 -1
- package/dist/extensions/interfaces/index.js +1 -0
- package/dist/extensions/interfaces/index.js.map +1 -1
- package/dist/extensions/interfaces/widget.d.ts +68 -50
- package/dist/extensions/interfaces/widget.d.ts.map +1 -1
- package/dist/extensions/interfaces/widget.js +1 -1
- package/dist/extensions/interfaces/widget.js.map +1 -1
- package/dist/extensions/interfaces/wms.d.ts +98 -0
- package/dist/extensions/interfaces/wms.d.ts.map +1 -0
- package/dist/extensions/interfaces/wms.js +14 -0
- package/dist/extensions/interfaces/wms.js.map +1 -0
- package/dist/extensions/widget.d.ts +281 -31
- package/dist/extensions/widget.d.ts.map +1 -1
- package/dist/extensions/widget.js +53 -19
- package/dist/extensions/widget.js.map +1 -1
- package/dist/extensions/wms.d.ts +318 -0
- package/dist/extensions/wms.d.ts.map +1 -0
- package/dist/extensions/wms.js +51 -0
- package/dist/extensions/wms.js.map +1 -0
- package/dist/types/extension.d.ts +1 -1
- package/dist/types/extension.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -24,17 +24,34 @@ export declare const NameDescI18nSchema: z.ZodObject<{
|
|
|
24
24
|
}>;
|
|
25
25
|
export type NameDescI18n = z.infer<typeof NameDescI18nSchema>;
|
|
26
26
|
/**
|
|
27
|
-
* Widget
|
|
27
|
+
* Widget metadata schema returned from extension.widget.metadata.getWidgets.
|
|
28
|
+
*
|
|
29
|
+
* This matches ch-app-store's metadata registration contract. Snippet widgets
|
|
30
|
+
* that rely on `snippetApiUrl` should use the dedicated snippet registration
|
|
31
|
+
* APIs instead of metadata discovery.
|
|
28
32
|
*/
|
|
29
|
-
export declare const WidgetConfigSchema: z.ZodObject<{
|
|
33
|
+
export declare const WidgetConfigSchema: z.ZodUnion<[z.ZodObject<{
|
|
30
34
|
name: z.ZodString;
|
|
31
|
-
description: z.ZodOptional<z.ZodString>;
|
|
32
|
-
scope: z.ZodEnum<["front", "desk"]>;
|
|
33
|
-
widgetType: z.ZodDefault<z.ZodEnum<["wam", "snippet"]>>;
|
|
34
35
|
/**
|
|
35
|
-
*
|
|
36
|
+
* App function invoked when the widget is opened or triggered.
|
|
36
37
|
*/
|
|
37
|
-
|
|
38
|
+
actionFunctionName: z.ZodString;
|
|
39
|
+
/**
|
|
40
|
+
* System version used when invoking widget functions
|
|
41
|
+
*/
|
|
42
|
+
systemVersion: z.ZodOptional<z.ZodString>;
|
|
43
|
+
/**
|
|
44
|
+
* Default widget title displayed by AppStore/Desk.
|
|
45
|
+
*/
|
|
46
|
+
defaultName: z.ZodOptional<z.ZodString>;
|
|
47
|
+
/**
|
|
48
|
+
* Default widget description displayed by AppStore/Desk.
|
|
49
|
+
*/
|
|
50
|
+
defaultDescription: z.ZodOptional<z.ZodString>;
|
|
51
|
+
/**
|
|
52
|
+
* i18n default name/description map keyed by language code.
|
|
53
|
+
*/
|
|
54
|
+
defaultNameDescI18nMap: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
38
55
|
name: z.ZodString;
|
|
39
56
|
description: z.ZodOptional<z.ZodString>;
|
|
40
57
|
}, "strip", z.ZodTypeAny, {
|
|
@@ -44,47 +61,280 @@ export declare const WidgetConfigSchema: z.ZodObject<{
|
|
|
44
61
|
name: string;
|
|
45
62
|
description?: string | undefined;
|
|
46
63
|
}>>>;
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
snippetApiUrl: z.ZodOptional<z.ZodString>;
|
|
64
|
+
} & {
|
|
65
|
+
scope: z.ZodEnum<["front", "desk"]>;
|
|
66
|
+
widgetType: z.ZodOptional<z.ZodLiteral<"wam">>;
|
|
51
67
|
}, "strip", z.ZodTypeAny, {
|
|
52
68
|
name: string;
|
|
53
69
|
scope: "front" | "desk";
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
70
|
+
actionFunctionName: string;
|
|
71
|
+
systemVersion?: string | undefined;
|
|
72
|
+
defaultName?: string | undefined;
|
|
73
|
+
defaultDescription?: string | undefined;
|
|
74
|
+
defaultNameDescI18nMap?: Record<string, {
|
|
57
75
|
name: string;
|
|
58
76
|
description?: string | undefined;
|
|
59
77
|
}> | undefined;
|
|
60
|
-
|
|
78
|
+
widgetType?: "wam" | undefined;
|
|
61
79
|
}, {
|
|
62
80
|
name: string;
|
|
63
81
|
scope: "front" | "desk";
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
82
|
+
actionFunctionName: string;
|
|
83
|
+
systemVersion?: string | undefined;
|
|
84
|
+
defaultName?: string | undefined;
|
|
85
|
+
defaultDescription?: string | undefined;
|
|
86
|
+
defaultNameDescI18nMap?: Record<string, {
|
|
67
87
|
name: string;
|
|
68
88
|
description?: string | undefined;
|
|
69
89
|
}> | undefined;
|
|
70
|
-
|
|
71
|
-
}
|
|
90
|
+
widgetType?: "wam" | undefined;
|
|
91
|
+
}>, z.ZodObject<{
|
|
92
|
+
name: z.ZodString;
|
|
93
|
+
/**
|
|
94
|
+
* App function invoked when the widget is opened or triggered.
|
|
95
|
+
*/
|
|
96
|
+
actionFunctionName: z.ZodString;
|
|
97
|
+
/**
|
|
98
|
+
* System version used when invoking widget functions
|
|
99
|
+
*/
|
|
100
|
+
systemVersion: z.ZodOptional<z.ZodString>;
|
|
101
|
+
/**
|
|
102
|
+
* Default widget title displayed by AppStore/Desk.
|
|
103
|
+
*/
|
|
104
|
+
defaultName: z.ZodOptional<z.ZodString>;
|
|
105
|
+
/**
|
|
106
|
+
* Default widget description displayed by AppStore/Desk.
|
|
107
|
+
*/
|
|
108
|
+
defaultDescription: z.ZodOptional<z.ZodString>;
|
|
109
|
+
/**
|
|
110
|
+
* i18n default name/description map keyed by language code.
|
|
111
|
+
*/
|
|
112
|
+
defaultNameDescI18nMap: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
113
|
+
name: z.ZodString;
|
|
114
|
+
description: z.ZodOptional<z.ZodString>;
|
|
115
|
+
}, "strip", z.ZodTypeAny, {
|
|
116
|
+
name: string;
|
|
117
|
+
description?: string | undefined;
|
|
118
|
+
}, {
|
|
119
|
+
name: string;
|
|
120
|
+
description?: string | undefined;
|
|
121
|
+
}>>>;
|
|
122
|
+
} & {
|
|
123
|
+
scope: z.ZodLiteral<"desk">;
|
|
124
|
+
widgetType: z.ZodLiteral<"snippet">;
|
|
125
|
+
}, "strip", z.ZodTypeAny, {
|
|
126
|
+
name: string;
|
|
127
|
+
scope: "desk";
|
|
128
|
+
actionFunctionName: string;
|
|
129
|
+
widgetType: "snippet";
|
|
130
|
+
systemVersion?: string | undefined;
|
|
131
|
+
defaultName?: string | undefined;
|
|
132
|
+
defaultDescription?: string | undefined;
|
|
133
|
+
defaultNameDescI18nMap?: Record<string, {
|
|
134
|
+
name: string;
|
|
135
|
+
description?: string | undefined;
|
|
136
|
+
}> | undefined;
|
|
137
|
+
}, {
|
|
138
|
+
name: string;
|
|
139
|
+
scope: "desk";
|
|
140
|
+
actionFunctionName: string;
|
|
141
|
+
widgetType: "snippet";
|
|
142
|
+
systemVersion?: string | undefined;
|
|
143
|
+
defaultName?: string | undefined;
|
|
144
|
+
defaultDescription?: string | undefined;
|
|
145
|
+
defaultNameDescI18nMap?: Record<string, {
|
|
146
|
+
name: string;
|
|
147
|
+
description?: string | undefined;
|
|
148
|
+
}> | undefined;
|
|
149
|
+
}>]>;
|
|
72
150
|
export type WidgetConfig = z.infer<typeof WidgetConfigSchema>;
|
|
73
151
|
/**
|
|
74
|
-
*
|
|
152
|
+
* Metadata response schema for widget registration
|
|
75
153
|
*/
|
|
76
|
-
export declare const
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
154
|
+
export declare const GetWidgetsOutputSchema: z.ZodObject<{
|
|
155
|
+
widgets: z.ZodArray<z.ZodUnion<[z.ZodObject<{
|
|
156
|
+
name: z.ZodString;
|
|
157
|
+
/**
|
|
158
|
+
* App function invoked when the widget is opened or triggered.
|
|
159
|
+
*/
|
|
160
|
+
actionFunctionName: z.ZodString;
|
|
161
|
+
/**
|
|
162
|
+
* System version used when invoking widget functions
|
|
163
|
+
*/
|
|
164
|
+
systemVersion: z.ZodOptional<z.ZodString>;
|
|
165
|
+
/**
|
|
166
|
+
* Default widget title displayed by AppStore/Desk.
|
|
167
|
+
*/
|
|
168
|
+
defaultName: z.ZodOptional<z.ZodString>;
|
|
169
|
+
/**
|
|
170
|
+
* Default widget description displayed by AppStore/Desk.
|
|
171
|
+
*/
|
|
172
|
+
defaultDescription: z.ZodOptional<z.ZodString>;
|
|
173
|
+
/**
|
|
174
|
+
* i18n default name/description map keyed by language code.
|
|
175
|
+
*/
|
|
176
|
+
defaultNameDescI18nMap: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
177
|
+
name: z.ZodString;
|
|
178
|
+
description: z.ZodOptional<z.ZodString>;
|
|
179
|
+
}, "strip", z.ZodTypeAny, {
|
|
180
|
+
name: string;
|
|
181
|
+
description?: string | undefined;
|
|
182
|
+
}, {
|
|
183
|
+
name: string;
|
|
184
|
+
description?: string | undefined;
|
|
185
|
+
}>>>;
|
|
186
|
+
} & {
|
|
187
|
+
scope: z.ZodEnum<["front", "desk"]>;
|
|
188
|
+
widgetType: z.ZodOptional<z.ZodLiteral<"wam">>;
|
|
189
|
+
}, "strip", z.ZodTypeAny, {
|
|
190
|
+
name: string;
|
|
191
|
+
scope: "front" | "desk";
|
|
192
|
+
actionFunctionName: string;
|
|
193
|
+
systemVersion?: string | undefined;
|
|
194
|
+
defaultName?: string | undefined;
|
|
195
|
+
defaultDescription?: string | undefined;
|
|
196
|
+
defaultNameDescI18nMap?: Record<string, {
|
|
197
|
+
name: string;
|
|
198
|
+
description?: string | undefined;
|
|
199
|
+
}> | undefined;
|
|
200
|
+
widgetType?: "wam" | undefined;
|
|
201
|
+
}, {
|
|
202
|
+
name: string;
|
|
203
|
+
scope: "front" | "desk";
|
|
204
|
+
actionFunctionName: string;
|
|
205
|
+
systemVersion?: string | undefined;
|
|
206
|
+
defaultName?: string | undefined;
|
|
207
|
+
defaultDescription?: string | undefined;
|
|
208
|
+
defaultNameDescI18nMap?: Record<string, {
|
|
209
|
+
name: string;
|
|
210
|
+
description?: string | undefined;
|
|
211
|
+
}> | undefined;
|
|
212
|
+
widgetType?: "wam" | undefined;
|
|
213
|
+
}>, z.ZodObject<{
|
|
214
|
+
name: z.ZodString;
|
|
215
|
+
/**
|
|
216
|
+
* App function invoked when the widget is opened or triggered.
|
|
217
|
+
*/
|
|
218
|
+
actionFunctionName: z.ZodString;
|
|
219
|
+
/**
|
|
220
|
+
* System version used when invoking widget functions
|
|
221
|
+
*/
|
|
222
|
+
systemVersion: z.ZodOptional<z.ZodString>;
|
|
223
|
+
/**
|
|
224
|
+
* Default widget title displayed by AppStore/Desk.
|
|
225
|
+
*/
|
|
226
|
+
defaultName: z.ZodOptional<z.ZodString>;
|
|
227
|
+
/**
|
|
228
|
+
* Default widget description displayed by AppStore/Desk.
|
|
229
|
+
*/
|
|
230
|
+
defaultDescription: z.ZodOptional<z.ZodString>;
|
|
231
|
+
/**
|
|
232
|
+
* i18n default name/description map keyed by language code.
|
|
233
|
+
*/
|
|
234
|
+
defaultNameDescI18nMap: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
235
|
+
name: z.ZodString;
|
|
236
|
+
description: z.ZodOptional<z.ZodString>;
|
|
237
|
+
}, "strip", z.ZodTypeAny, {
|
|
238
|
+
name: string;
|
|
239
|
+
description?: string | undefined;
|
|
240
|
+
}, {
|
|
241
|
+
name: string;
|
|
242
|
+
description?: string | undefined;
|
|
243
|
+
}>>>;
|
|
244
|
+
} & {
|
|
245
|
+
scope: z.ZodLiteral<"desk">;
|
|
246
|
+
widgetType: z.ZodLiteral<"snippet">;
|
|
247
|
+
}, "strip", z.ZodTypeAny, {
|
|
248
|
+
name: string;
|
|
249
|
+
scope: "desk";
|
|
250
|
+
actionFunctionName: string;
|
|
251
|
+
widgetType: "snippet";
|
|
252
|
+
systemVersion?: string | undefined;
|
|
253
|
+
defaultName?: string | undefined;
|
|
254
|
+
defaultDescription?: string | undefined;
|
|
255
|
+
defaultNameDescI18nMap?: Record<string, {
|
|
256
|
+
name: string;
|
|
257
|
+
description?: string | undefined;
|
|
258
|
+
}> | undefined;
|
|
259
|
+
}, {
|
|
260
|
+
name: string;
|
|
261
|
+
scope: "desk";
|
|
262
|
+
actionFunctionName: string;
|
|
263
|
+
widgetType: "snippet";
|
|
264
|
+
systemVersion?: string | undefined;
|
|
265
|
+
defaultName?: string | undefined;
|
|
266
|
+
defaultDescription?: string | undefined;
|
|
267
|
+
defaultNameDescI18nMap?: Record<string, {
|
|
268
|
+
name: string;
|
|
269
|
+
description?: string | undefined;
|
|
270
|
+
}> | undefined;
|
|
271
|
+
}>]>, "many">;
|
|
80
272
|
}, "strip", z.ZodTypeAny, {
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
273
|
+
widgets: ({
|
|
274
|
+
name: string;
|
|
275
|
+
scope: "front" | "desk";
|
|
276
|
+
actionFunctionName: string;
|
|
277
|
+
systemVersion?: string | undefined;
|
|
278
|
+
defaultName?: string | undefined;
|
|
279
|
+
defaultDescription?: string | undefined;
|
|
280
|
+
defaultNameDescI18nMap?: Record<string, {
|
|
281
|
+
name: string;
|
|
282
|
+
description?: string | undefined;
|
|
283
|
+
}> | undefined;
|
|
284
|
+
widgetType?: "wam" | undefined;
|
|
285
|
+
} | {
|
|
286
|
+
name: string;
|
|
287
|
+
scope: "desk";
|
|
288
|
+
actionFunctionName: string;
|
|
289
|
+
widgetType: "snippet";
|
|
290
|
+
systemVersion?: string | undefined;
|
|
291
|
+
defaultName?: string | undefined;
|
|
292
|
+
defaultDescription?: string | undefined;
|
|
293
|
+
defaultNameDescI18nMap?: Record<string, {
|
|
294
|
+
name: string;
|
|
295
|
+
description?: string | undefined;
|
|
296
|
+
}> | undefined;
|
|
297
|
+
})[];
|
|
298
|
+
}, {
|
|
299
|
+
widgets: ({
|
|
300
|
+
name: string;
|
|
301
|
+
scope: "front" | "desk";
|
|
302
|
+
actionFunctionName: string;
|
|
303
|
+
systemVersion?: string | undefined;
|
|
304
|
+
defaultName?: string | undefined;
|
|
305
|
+
defaultDescription?: string | undefined;
|
|
306
|
+
defaultNameDescI18nMap?: Record<string, {
|
|
307
|
+
name: string;
|
|
308
|
+
description?: string | undefined;
|
|
309
|
+
}> | undefined;
|
|
310
|
+
widgetType?: "wam" | undefined;
|
|
311
|
+
} | {
|
|
312
|
+
name: string;
|
|
313
|
+
scope: "desk";
|
|
314
|
+
actionFunctionName: string;
|
|
315
|
+
widgetType: "snippet";
|
|
316
|
+
systemVersion?: string | undefined;
|
|
317
|
+
defaultName?: string | undefined;
|
|
318
|
+
defaultDescription?: string | undefined;
|
|
319
|
+
defaultNameDescI18nMap?: Record<string, {
|
|
320
|
+
name: string;
|
|
321
|
+
description?: string | undefined;
|
|
322
|
+
}> | undefined;
|
|
323
|
+
})[];
|
|
324
|
+
}>;
|
|
325
|
+
export type GetWidgetsOutput = z.infer<typeof GetWidgetsOutputSchema>;
|
|
326
|
+
/**
|
|
327
|
+
* Widget action result schema — matches AppStore action payloads.
|
|
328
|
+
*/
|
|
329
|
+
export declare const WidgetActionResultSchema: z.ZodObject<{
|
|
330
|
+
type: z.ZodString;
|
|
331
|
+
attributes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
332
|
+
}, "strict", z.ZodTypeAny, {
|
|
333
|
+
type: string;
|
|
334
|
+
attributes?: Record<string, unknown> | undefined;
|
|
84
335
|
}, {
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
data?: Record<string, unknown> | undefined;
|
|
336
|
+
type: string;
|
|
337
|
+
attributes?: Record<string, unknown> | undefined;
|
|
88
338
|
}>;
|
|
89
339
|
export type WidgetActionResult = z.infer<typeof WidgetActionResultSchema>;
|
|
90
340
|
//# sourceMappingURL=widget.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"widget.d.ts","sourceRoot":"","sources":["../../src/extensions/widget.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AACH,eAAO,MAAM,WAAW,8BAA4B,CAAC;AACrD,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC;AAEtD;;GAEG;AACH,eAAO,MAAM,UAAU,+BAA6B,CAAC;AACrD,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC;AAEpD;;GAEG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;EAG7B,CAAC;AAEH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"widget.d.ts","sourceRoot":"","sources":["../../src/extensions/widget.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AACH,eAAO,MAAM,WAAW,8BAA4B,CAAC;AACrD,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,CAAC;AAEtD;;GAEG;AACH,eAAO,MAAM,UAAU,+BAA6B,CAAC;AACrD,MAAM,MAAM,UAAU,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,UAAU,CAAC,CAAC;AAEpD;;GAEG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;EAG7B,CAAC;AAEH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AA8B9D;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB;;IA7B7B;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAlBH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAoBH,CAAC;AAEH,MAAM,MAAM,YAAY,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAC;AAE9D;;GAEG;AACH,eAAO,MAAM,sBAAsB;;;QA7CjC;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAlBH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;QAEH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA6BH,CAAC;AAEH,MAAM,MAAM,gBAAgB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAEtE;;GAEG;AACH,eAAO,MAAM,wBAAwB;;;;;;;;;EAK1B,CAAC;AAEZ,MAAM,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAC"}
|
|
@@ -11,32 +11,66 @@ export const WidgetType = z.enum(["wam", "snippet"]);
|
|
|
11
11
|
* I18n name/description pair
|
|
12
12
|
*/
|
|
13
13
|
export const NameDescI18nSchema = z.object({
|
|
14
|
-
name: z.string(),
|
|
15
|
-
description: z.string().optional(),
|
|
14
|
+
name: z.string().min(1).max(30),
|
|
15
|
+
description: z.string().max(100).optional(),
|
|
16
16
|
});
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
17
|
+
const WidgetMetadataBaseSchema = z.object({
|
|
18
|
+
name: z
|
|
19
|
+
.string()
|
|
20
|
+
.min(1)
|
|
21
|
+
.max(20)
|
|
22
|
+
.regex(/^[a-zA-Z_-]*$/),
|
|
23
|
+
/**
|
|
24
|
+
* App function invoked when the widget is opened or triggered.
|
|
25
|
+
*/
|
|
26
|
+
actionFunctionName: z.string().min(1),
|
|
27
|
+
/**
|
|
28
|
+
* System version used when invoking widget functions
|
|
29
|
+
*/
|
|
30
|
+
systemVersion: z.string().optional(),
|
|
25
31
|
/**
|
|
26
|
-
*
|
|
32
|
+
* Default widget title displayed by AppStore/Desk.
|
|
27
33
|
*/
|
|
28
|
-
|
|
34
|
+
defaultName: z.string().max(30).optional(),
|
|
29
35
|
/**
|
|
30
|
-
*
|
|
36
|
+
* Default widget description displayed by AppStore/Desk.
|
|
31
37
|
*/
|
|
32
|
-
|
|
38
|
+
defaultDescription: z.string().max(100).optional(),
|
|
39
|
+
/**
|
|
40
|
+
* i18n default name/description map keyed by language code.
|
|
41
|
+
*/
|
|
42
|
+
defaultNameDescI18nMap: z.record(NameDescI18nSchema).optional(),
|
|
33
43
|
});
|
|
34
44
|
/**
|
|
35
|
-
* Widget
|
|
45
|
+
* Widget metadata schema returned from extension.widget.metadata.getWidgets.
|
|
46
|
+
*
|
|
47
|
+
* This matches ch-app-store's metadata registration contract. Snippet widgets
|
|
48
|
+
* that rely on `snippetApiUrl` should use the dedicated snippet registration
|
|
49
|
+
* APIs instead of metadata discovery.
|
|
50
|
+
*/
|
|
51
|
+
export const WidgetConfigSchema = z.union([
|
|
52
|
+
WidgetMetadataBaseSchema.extend({
|
|
53
|
+
scope: WidgetScope,
|
|
54
|
+
widgetType: z.literal("wam").optional(),
|
|
55
|
+
}),
|
|
56
|
+
WidgetMetadataBaseSchema.extend({
|
|
57
|
+
scope: z.literal("desk"),
|
|
58
|
+
widgetType: z.literal("snippet"),
|
|
59
|
+
}),
|
|
60
|
+
]);
|
|
61
|
+
/**
|
|
62
|
+
* Metadata response schema for widget registration
|
|
36
63
|
*/
|
|
37
|
-
export const
|
|
38
|
-
|
|
39
|
-
message: z.string().optional(),
|
|
40
|
-
data: z.record(z.unknown()).optional(),
|
|
64
|
+
export const GetWidgetsOutputSchema = z.object({
|
|
65
|
+
widgets: z.array(WidgetConfigSchema).max(30),
|
|
41
66
|
});
|
|
67
|
+
/**
|
|
68
|
+
* Widget action result schema — matches AppStore action payloads.
|
|
69
|
+
*/
|
|
70
|
+
export const WidgetActionResultSchema = z
|
|
71
|
+
.object({
|
|
72
|
+
type: z.string().min(1),
|
|
73
|
+
attributes: z.record(z.unknown()).optional(),
|
|
74
|
+
})
|
|
75
|
+
.strict();
|
|
42
76
|
//# sourceMappingURL=widget.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"widget.js","sourceRoot":"","sources":["../../src/extensions/widget.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;AAGrD;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC;AAGrD;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;
|
|
1
|
+
{"version":3,"file":"widget.js","sourceRoot":"","sources":["../../src/extensions/widget.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;GAEG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;AAGrD;;GAEG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC;AAGrD;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,CAAC;IACzC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;IAC/B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;CAC5C,CAAC,CAAC;AAIH,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,IAAI,EAAE,CAAC;SACJ,MAAM,EAAE;SACR,GAAG,CAAC,CAAC,CAAC;SACN,GAAG,CAAC,EAAE,CAAC;SACP,KAAK,CAAC,eAAe,CAAC;IACzB;;OAEG;IACH,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACrC;;OAEG;IACH,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACpC;;OAEG;IACH,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE;IAC1C;;OAEG;IACH,kBAAkB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;IAClD;;OAEG;IACH,sBAAsB,EAAE,CAAC,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,QAAQ,EAAE;CAChE,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC,KAAK,CAAC;IACxC,wBAAwB,CAAC,MAAM,CAAC;QAC9B,KAAK,EAAE,WAAW;QAClB,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE;KACxC,CAAC;IACF,wBAAwB,CAAC,MAAM,CAAC;QAC9B,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;QACxB,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC;KACjC,CAAC;CACH,CAAC,CAAC;AAIH;;GAEG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7C,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;CAC7C,CAAC,CAAC;AAIH;;GAEG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC;KACtC,MAAM,CAAC;IACN,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACvB,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;CAC7C,CAAC;KACD,MAAM,EAAE,CAAC"}
|