@plaidev/karte-action-sdk 1.1.113 → 1.1.114-27926953.05c19bb7

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.
@@ -1,9 +1,7 @@
1
- import { Writable as Writable_ } from "svelte/store";
2
1
  import { get as get_ } from "svelte/store";
2
+ import { Writable as Writable_ } from "svelte/store";
3
3
  import { SvelteComponentDev } from "svelte/internal";
4
- /**
5
- * @internal
6
- */
4
+ /** @internal */
7
5
  declare const PropTypes: readonly [
8
6
  "BooleanKeyword",
9
7
  "NumberKeyword",
@@ -25,38 +23,24 @@ declare const PropTypes: readonly [
25
23
  "ModalPlacement",
26
24
  "OnClick"
27
25
  ];
28
- /**
29
- * @internal
30
- */
26
+ /** @internal */
31
27
  type PropType = (typeof PropTypes)[number];
32
- /**
33
- * @internal
34
- */
28
+ /** @internal */
35
29
  type Code = string;
36
- /**
37
- * @internal
38
- */
30
+ /** @internal */
39
31
  declare const MediaQueries: {
40
32
  [key: string]: string;
41
33
  };
42
- /**
43
- * @internal
44
- */
34
+ /** @internal */
45
35
  type MediaQuery = string;
46
- /**
47
- * @internal
48
- */
36
+ /** @internal */
49
37
  declare const Directions: readonly [
50
38
  "row",
51
39
  "column"
52
40
  ];
53
- /**
54
- * @internal
55
- */
41
+ /** @internal */
56
42
  type Direction = (typeof Directions)[number];
57
- /**
58
- * @internal
59
- */
43
+ /** @internal */
60
44
  declare const AnimationStyles: readonly [
61
45
  "none",
62
46
  "fade",
@@ -66,13 +50,9 @@ declare const AnimationStyles: readonly [
66
50
  "slide-left",
67
51
  "slide-right"
68
52
  ];
69
- /**
70
- * @internal
71
- */
53
+ /** @internal */
72
54
  type AnimationStyle = (typeof AnimationStyles)[number];
73
- /**
74
- * @internal
75
- */
55
+ /** @internal */
76
56
  declare const ModalPositions: readonly [
77
57
  "top-left",
78
58
  "top-center",
@@ -85,62 +65,44 @@ declare const ModalPositions: readonly [
85
65
  "bottom-right",
86
66
  "none"
87
67
  ];
88
- /**
89
- * @internal
90
- */
68
+ /** @internal */
91
69
  type ModalPosition = (typeof ModalPositions)[number];
92
- /**
93
- * @internal
94
- */
70
+ /** @internal */
95
71
  type ModalMargin = {
96
72
  left?: string;
97
73
  right?: string;
98
74
  top?: string;
99
75
  bottom?: string;
100
76
  };
101
- /**
102
- * @internal
103
- */
77
+ /** @internal */
104
78
  type ModalPlacement<M = ModalMargin> = {
105
79
  position?: ModalPosition;
106
80
  margin?: M;
107
81
  backgroundOverlay?: boolean;
108
82
  backgroundClick?: OnClickOperation;
109
83
  };
110
- /**
111
- * @internal
112
- */
84
+ /** @internal */
113
85
  declare const DefaultModalPlacement: Required<ModalPlacement<Required<ModalMargin>>>;
114
- /**
115
- * @internal
116
- */
86
+ /** @internal */
117
87
  declare const Elasticities: readonly [
118
88
  "none",
119
89
  "vertical",
120
90
  "horizontal"
121
91
  ];
122
- /**
123
- * @internal
124
- */
92
+ /** @internal */
125
93
  type Elasticity = (typeof Elasticities)[number];
126
- /**
127
- * @internal
128
- */
94
+ /** @internal */
129
95
  declare const ElasticityStyle: {
130
96
  none: string;
131
97
  vertical: string;
132
98
  horizontal: string;
133
99
  };
134
- /**
135
- * @internal
136
- */
100
+ /** @internal */
137
101
  declare const TextDirections: readonly [
138
102
  "horizontal",
139
103
  "vertical"
140
104
  ];
141
- /**
142
- * @internal
143
- */
105
+ /** @internal */
144
106
  type TextDirection = (typeof TextDirections)[number];
145
107
  type OperationArgumentTypes = {
146
108
  StringKeyword: string;
@@ -151,9 +113,7 @@ type OperationArgumentTypes = {
151
113
  Handler: string;
152
114
  Trigger: string;
153
115
  };
154
- /**
155
- * @internal
156
- */
116
+ /** @internal */
157
117
  type OperationArgumentType = keyof OperationArgumentTypes;
158
118
  type BaseOperationOptions = ReadonlyArray<{
159
119
  operation: string;
@@ -170,13 +130,9 @@ type ConvertOperationOption<Option extends BaseOperationOptions[number]> = Optio
170
130
  type ConvertOperationOptionArguments<Arguments extends BaseOperationOptions[number]["args"]> = {
171
131
  -readonly [Index in keyof Arguments]: Arguments[Index] extends BaseOperationOptions[number]["args"][number] ? OperationArgumentTypes[Arguments[Index]["type"]] : never;
172
132
  };
173
- /**
174
- * @internal
175
- */
133
+ /** @internal */
176
134
  type Operation = ConvertOperationOptions<ReadonlyArray<any>>;
177
- /**
178
- * @internal
179
- */
135
+ /** @internal */
180
136
  declare const OnClickOperationOptions: readonly [
181
137
  {
182
138
  readonly operation: "none";
@@ -224,13 +180,9 @@ declare const OnClickOperationOptions: readonly [
224
180
  ];
225
181
  }
226
182
  ];
227
- /**
228
- * @internal
229
- */
183
+ /** @internal */
230
184
  type OnClickOperation = ConvertOperationOptions<typeof OnClickOperationOptions>;
231
- /**
232
- * @internal
233
- */
185
+ /** @internal */
234
186
  declare const FormOperationOptions: readonly [
235
187
  {
236
188
  readonly operation: "submit";
@@ -260,25 +212,15 @@ declare const FormOperationOptions: readonly [
260
212
  ];
261
213
  }
262
214
  ];
263
- /**
264
- * @internal
265
- */
215
+ /** @internal */
266
216
  type FormOperation = ConvertOperationOptions<typeof FormOperationOptions>;
267
- /**
268
- * @internal
269
- */
217
+ /** @internal */
270
218
  type LongText = string;
271
- /**
272
- * @internal
273
- */
219
+ /** @internal */
274
220
  type Url = string;
275
- /**
276
- * @internal
277
- */
221
+ /** @internal */
278
222
  type Image = string;
279
- /**
280
- * @internal
281
- */
223
+ /** @internal */
282
224
  declare const LengthUnits: readonly [
283
225
  "px",
284
226
  "em",
@@ -287,147 +229,93 @@ declare const LengthUnits: readonly [
287
229
  "fr",
288
230
  "%"
289
231
  ];
290
- /**
291
- * @internal
292
- */
232
+ /** @internal */
293
233
  type LengthUnit = (typeof LengthUnits)[number];
294
- /**
295
- * @internal
296
- */
234
+ /** @internal */
297
235
  type Length = `${number}${LengthUnit}` | "auto";
298
- /**
299
- * @internal
300
- */
236
+ /** @internal */
301
237
  type Color = `#${string}` | `rgba(${string})`;
302
- /**
303
- * @internal
304
- */
238
+ /** @internal */
305
239
  declare const Justifies: readonly [
306
240
  "flex-start",
307
241
  "center",
308
242
  "flex-end"
309
243
  ];
310
- /**
311
- * @internal
312
- */
244
+ /** @internal */
313
245
  type Justify = (typeof Justifies)[number];
314
- /**
315
- * @internal
316
- */
246
+ /** @internal */
317
247
  declare const Alignments: readonly [
318
248
  "flex-start",
319
249
  "center",
320
250
  "flex-end"
321
251
  ];
322
- /**
323
- * @internal
324
- */
252
+ /** @internal */
325
253
  type Alignment = (typeof Alignments)[number];
326
- /**
327
- * @internal
328
- */
254
+ /** @internal */
329
255
  declare const ObjectFits: readonly [
330
256
  "fill",
331
257
  "contain",
332
258
  "cover"
333
259
  ];
334
- /**
335
- * @internal
336
- */
260
+ /** @internal */
337
261
  type ObjectFit = (typeof ObjectFits)[number];
338
- /**
339
- * @internal
340
- */
262
+ /** @internal */
341
263
  declare const ClipPaths: readonly [
342
264
  "none",
343
265
  "circle(closest-side)"
344
266
  ];
345
- /**
346
- * @internal
347
- */
267
+ /** @internal */
348
268
  type ClipPath = (typeof ClipPaths)[number];
349
- /**
350
- * @internal
351
- */
269
+ /** @internal */
352
270
  declare const Repeats: readonly [
353
271
  "repeat",
354
272
  "space",
355
273
  "round",
356
274
  "no-repeat"
357
275
  ];
358
- /**
359
- * @internal
360
- */
276
+ /** @internal */
361
277
  type Repeat = (typeof Repeats)[number];
362
- /**
363
- * @internal
364
- */
278
+ /** @internal */
365
279
  declare const BackgroundSizes: readonly [
366
280
  "cover",
367
281
  "contain",
368
282
  "auto"
369
283
  ];
370
- /**
371
- * @internal
372
- */
284
+ /** @internal */
373
285
  type BackgroundSize = (typeof BackgroundSizes)[number];
374
- /**
375
- * @internal
376
- */
286
+ /** @internal */
377
287
  declare const Cursors: readonly [
378
288
  "default",
379
289
  "pointer"
380
290
  ];
381
- /**
382
- * @internal
383
- */
291
+ /** @internal */
384
292
  type Cursor = (typeof Cursors)[number];
385
- /**
386
- * @internal
387
- */
293
+ /** @internal */
388
294
  declare const Overflows: readonly [
389
295
  "visible",
390
296
  "auto",
391
297
  "hidden"
392
298
  ];
393
- /**
394
- * @internal
395
- */
299
+ /** @internal */
396
300
  type Overflow = (typeof Overflows)[number];
397
- /**
398
- * @internal
399
- */
301
+ /** @internal */
400
302
  type Border = string;
401
- /**
402
- * @internal
403
- */
303
+ /** @internal */
404
304
  type BorderStyle = string;
405
- /**
406
- * @internal
407
- */
305
+ /** @internal */
408
306
  type BorderWidth = `${number}px`;
409
- /**
410
- * @internal
411
- */
307
+ /** @internal */
412
308
  type Style = string;
413
- /**
414
- * @internal
415
- */
309
+ /** @internal */
416
310
  type StateName = string;
417
- /**
418
- * @internal
419
- */
311
+ /** @internal */
420
312
  declare const WritingModes: readonly [
421
313
  "horizontal-tb",
422
314
  "vertical-lr"
423
315
  ];
424
- /**
425
- * @internal
426
- */
316
+ /** @internal */
427
317
  type WritingMode = (typeof WritingModes)[number];
428
- /**
429
- * @internal
430
- */
318
+ /** @internal */
431
319
  declare const ListSeparatorTypes: readonly [
432
320
  "none",
433
321
  "border",
@@ -437,51 +325,33 @@ type ListSeparatorType = (typeof ListSeparatorTypes)[number];
437
325
  interface BaseListSeparator {
438
326
  type: ListSeparatorType;
439
327
  }
440
- /**
441
- * @internal
442
- */
328
+ /** @internal */
443
329
  interface ListSeparatorNone extends BaseListSeparator {
444
330
  type: "none";
445
331
  }
446
- /**
447
- * @internal
448
- */
332
+ /** @internal */
449
333
  interface ListSeparatorBorder extends BaseListSeparator {
450
334
  type: "border";
451
335
  borderStyle: BorderStyle;
452
336
  borderWidth?: BorderWidth;
453
337
  borderColor?: Color;
454
338
  }
455
- /**
456
- * @internal
457
- */
339
+ /** @internal */
458
340
  interface ListSeparatorGap extends BaseListSeparator {
459
341
  type: "gap";
460
342
  gap: Length;
461
343
  }
462
- /**
463
- * @internal
464
- */
344
+ /** @internal */
465
345
  type ListSeparator = ListSeparatorNone | ListSeparatorBorder | ListSeparatorGap;
466
- /**
467
- * @internal
468
- */
346
+ /** @internal */
469
347
  declare const DefaultListSeparatorNone: Required<ListSeparatorNone>;
470
- /**
471
- * @internal
472
- */
348
+ /** @internal */
473
349
  declare const DefaultListSeparatorBorder: Required<ListSeparatorBorder>;
474
- /**
475
- * @internal
476
- */
350
+ /** @internal */
477
351
  declare const DefaultListSeparatorGap: Required<ListSeparatorGap>;
478
- /**
479
- * @internal
480
- */
352
+ /** @internal */
481
353
  declare const DefaultListSeparator: Required<ListSeparatorBorder>;
482
- /**
483
- * @internal
484
- */
354
+ /** @internal */
485
355
  declare const ListBackgroundTypes: readonly [
486
356
  "none",
487
357
  "stripe"
@@ -490,15 +360,11 @@ type ListBackgroundType = (typeof ListBackgroundTypes)[number];
490
360
  interface BaseListBackground {
491
361
  type: ListBackgroundType;
492
362
  }
493
- /**
494
- * @internal
495
- */
363
+ /** @internal */
496
364
  interface ListBackgroundNone extends BaseListBackground {
497
365
  type: "none";
498
366
  }
499
- /**
500
- * @internal
501
- */
367
+ /** @internal */
502
368
  interface ListBackgroundStripe extends BaseListBackground {
503
369
  type: "stripe";
504
370
  background1?: Color;
@@ -508,32 +374,20 @@ interface ListBackgroundStripe extends BaseListBackground {
508
374
  * @internal
509
375
  */
510
376
  type ListBackground = ListBackgroundNone | ListBackgroundStripe;
511
- /**
512
- * @internal
513
- */
377
+ /** @internal */
514
378
  declare const DefaultListBackgroundNone: Required<ListBackgroundNone>;
515
- /**
516
- * @internal
517
- */
379
+ /** @internal */
518
380
  declare const DefaultListBackgroundStripe: Required<ListBackgroundStripe>;
519
- /**
520
- * @internal
521
- */
381
+ /** @internal */
522
382
  declare const DefaultListBackground: Required<ListBackgroundNone>;
523
- /**
524
- * @internal
525
- */
383
+ /** @internal */
526
384
  declare const ListDirections: readonly [
527
385
  "vertical",
528
386
  "horizontal"
529
387
  ];
530
- /**
531
- * @internal
532
- */
388
+ /** @internal */
533
389
  type ListDirection = (typeof ListDirections)[number];
534
- /**
535
- * @internal
536
- */
390
+ /** @internal */
537
391
  type ListContext = {
538
392
  separator: ListSeparator;
539
393
  background: ListBackground;
@@ -546,115 +400,177 @@ type ListContext = {
546
400
  }) => string;
547
401
  unregisterItem: (id: string) => void;
548
402
  };
549
- // Wrap svelte tools
550
- type Store<T> = Writable_<T>;
403
+ type SliderButtonType = "icon" | "text";
404
+ type BaseSliderButton = {
405
+ type: SliderButtonType;
406
+ };
407
+ interface SliderButtonIcon extends BaseSliderButton {
408
+ type: "icon";
409
+ icon: string;
410
+ size: Length;
411
+ color: Color;
412
+ fill: Color;
413
+ }
414
+ interface SliderButtonText extends BaseSliderButton {
415
+ type: "text";
416
+ text: string;
417
+ }
418
+ type SliderButton = SliderButtonIcon | SliderButtonText;
419
+ declare const DefaultSliderButton: {
420
+ readonly type: "icon";
421
+ readonly icon: "chevron-left";
422
+ readonly color: "#999";
423
+ readonly fill: "#999";
424
+ readonly size: "20px";
425
+ };
426
+ type SliderButtonPosition = "top" | "middle" | "bottom";
427
+ interface SliderNavigationButton {
428
+ type: "circle";
429
+ size: Length;
430
+ color: Color;
431
+ colorActive: Color;
432
+ }
433
+ declare const DefaultSliderNavigationButton: {
434
+ readonly type: "circle";
435
+ readonly size: "8px";
436
+ readonly color: "#ddd";
437
+ readonly colorActive: "#666";
438
+ };
439
+ /** @internal */
440
+ type Store<T> = Writable_<T>; // Wrap svelte tools
551
441
  /**
552
442
  * get store state value
553
443
  *
554
444
  * @deprecated 非推奨
445
+ *
446
+ * @internal
555
447
  */
556
448
  declare const getStoreState: typeof get_;
449
+ /**
450
+ * KARTE のシステム設定情報
451
+ *
452
+ * @public
453
+ */
557
454
  type SystemConfig = {
455
+ /**
456
+ * API キー
457
+ */
558
458
  apiKey?: string;
459
+ /**
460
+ * 接客ID
461
+ */
559
462
  campaignId?: string;
560
463
  shortenId?: string;
561
464
  };
465
+ /**
466
+ * アクションのイベントハンドラ
467
+ *
468
+ * @public
469
+ */
562
470
  type ActionEventHandler = (...args: any[]) => any | Promise<any>;
471
+ /**
472
+ * アクション設定
473
+ *
474
+ * @public
475
+ */
563
476
  type ActionSetting = {
564
477
  send?: (event_name: string, values?: any) => void;
565
478
  initialState?: string;
566
479
  autoStart?: boolean;
567
480
  };
481
+ /**
482
+ * カスタム変数
483
+ *
484
+ * @public
485
+ */
568
486
  type CustomVariables = {
569
487
  [key: string]: any;
570
488
  };
571
489
  /**
572
- * Store to handle action setting
573
- */
574
- declare const actionSetting: Store<ActionSetting>;
575
- /**
576
- * {@link getActionSetting} function to get action setting.
490
+ * アクション設定を更新する
577
491
  *
578
- * @returns Current action setting
579
- */
580
- declare function getActionSetting(): ActionSetting;
581
- /**
582
- * {@link setActionSetting} function to "update" action setting
492
+ * @remarks
493
+ * アクションの自動起動 (autoStart) を設定できます。
583
494
  *
584
- * @param setting - Updated action setting
495
+ * @param setting - 更新するアクション設定
585
496
  *
586
- * @returns New action setting
497
+ * @returns 新しいアクション設定
498
+ *
499
+ * @public
587
500
  */
588
501
  declare function setActionSetting(setting: ActionSetting): ActionSetting;
589
502
  /**
590
- * {@link resetActionSetting} function to reset action setting
591
- */
592
- declare function resetActionSetting(): void;
593
- /**
594
- * Store to read KARTE system config
595
- */
596
- declare const system: Store<SystemConfig>;
597
- /**
598
- * {@link getSystem} function to get KARTE system config.
503
+ * KARTE の設定を取得する
504
+ *
505
+ * @remarks
506
+ * アクションが表示されて設定されるため、{@link onShow} フック関数で利用できます。
507
+ * 取得できる設定は、APIキー、接客ID、アクションショートIDなどです。
599
508
  *
600
- * @returns Current karte system config
509
+ * @returns 現在の KARTE システムの設定を返します
510
+ *
511
+ * @public
601
512
  */
602
513
  declare function getSystem(): SystemConfig;
603
- /**
604
- * {@link setSystem} function to set KARTE system config.
605
- */
606
- declare function setSystem(config: SystemConfig): void;
607
514
  /**
608
515
  * Store to handle current state ID
609
516
  *
610
517
  * This is exported becase of compatible interface for App.svelte.
611
518
  * Don't use directly.
519
+ *
520
+ * @internal
612
521
  */
613
522
  declare const state: Store<string>;
614
523
  /**
615
- * {@link setState} function to set current state ID.
524
+ * 現在のステートを設定する
525
+ *
526
+ * @param stateId - 表示するステートID
527
+ * @param force - 強制的にステートを設定するフラグ。デフォルトは `false`
528
+ *
529
+ * @public
616
530
  */
617
531
  declare function setState(stateId: string, force?: boolean): void;
618
532
  /**
619
- * {@link getState} function to get current state ID.
533
+ * 現在のステートを取得する
534
+ *
535
+ * @remarks
536
+ * アクションが表示されて設定されるため、{@link onShow} フック関数で利用できます。
537
+ *
538
+ * @returns 現在のステートID
620
539
  *
621
- * @returns Current state ID
540
+ * @public
622
541
  */
623
542
  declare function getState(): string;
624
543
  /**
625
- * Store to handle all state IDs
626
- */
627
- declare const states: Store<string[]>;
628
- /**
629
- * {@link getStates} function to add new state ID to list of state IDs.
544
+ * ステートID一覧を取得する
630
545
  *
631
- * @param stateId - New state ID
632
- */
633
- declare function addState(stateId: string): void;
634
- /**
635
- * {@link getStates} function to get a list of all state IDs.
546
+ * @remarks
547
+ * アクションが表示されて設定されるため、{@link onShow} フック関数で利用できます。
548
+ *
549
+ * @returns すべてのステートID
636
550
  *
637
- * @returns All state IDs
551
+ * @public
638
552
  */
639
553
  declare function getStates(): string[];
640
554
  /**
641
555
  * Store to handle visibility of action
556
+ *
557
+ * @internal
642
558
  */
643
559
  declare const opened: Store<boolean>;
644
560
  /**
645
- * {@link isOpened} function to check if action is opened.
561
+ * アクションの表示・非表示の状態を取得する
562
+ *
563
+ * @returns アクションが表示されているときは `true`、非表示のときは `false` を返します。
646
564
  *
647
- * @returns Flag if action is opend / true: Opend, false: Not opened
565
+ * @public
648
566
  */
649
567
  declare function isOpened(): boolean;
650
- /**
651
- * {@link setOpened} function to set if action is opened.
652
- */
653
- declare function setOpened(on: boolean): void;
654
568
  /**
655
569
  * Store to handle visibility of action
656
570
  *
657
571
  * @deprecated 非推奨
572
+ *
573
+ * @internal
658
574
  */
659
575
  declare const closed: Store<boolean>; // deprecated
660
576
  /**
@@ -663,86 +579,59 @@ declare const closed: Store<boolean>; // deprecated
663
579
  * @returns Flag if action is closed / true: Closed, false: Not closed
664
580
  *
665
581
  * @deprecated 非推奨
582
+ *
583
+ * @internal
666
584
  */
667
585
  declare function isClosed(): boolean;
668
586
  /**
669
587
  * {@link setClosed} function to set if action is closed.
670
588
  *
671
589
  * @deprecated 非推奨
672
- */
673
- declare function setClosed(on: boolean): void;
674
- /**
675
- * Store to handle max z-index for grid items
676
- */
677
- declare const maximumZindex: Store<number>;
678
- /**
679
- * Set maximum z-index.
680
- */
681
- declare const setMaximumZindex: (zindex?: number) => void;
682
- /**
683
- * Store to handle internal event handlers
684
590
  *
685
- * This is used internally.
686
- */
687
- declare const internalHandlers: Store<{
688
- [key: string]: ActionEventHandler[];
689
- }>;
690
- /**
691
- * {@link getInternalHandlers} function to get internal event handlers.
692
- *
693
- * @returns Current internal handlers
694
- */
695
- declare function getInternalHandlers(): {
696
- [key: string]: ActionEventHandler[];
697
- };
698
- /**
699
- * {@link setInternalHandlers} function to set internal event handlers.
700
- */
701
- declare function setInternalHandlers(handlers: {
702
- [key: string]: ActionEventHandler[];
703
- }): void;
704
- /**
705
- * {@link updateInternalHandlers} function to update internal event handlers.
706
- *
707
- * @param handlers - Updated internal event handlers
708
- *
709
- * @returns New internal handlers
591
+ * @internal
710
592
  */
711
- declare function updateInternalHandlers(handlers: {
712
- [key: string]: ActionEventHandler[];
713
- }): {
714
- [key: string]: ActionEventHandler[];
715
- };
593
+ declare function setClosed(on: boolean): void;
716
594
  /**
717
595
  * Store to handle custom event handlers
718
596
  *
719
597
  * This is used internally.
598
+ *
599
+ * @internal
720
600
  */
721
601
  declare const customHandlers: Store<{
722
602
  [key: string]: ActionEventHandler;
723
603
  }>;
724
604
  /**
725
- * {@link getCustomHandlers} function to get custom event handlers.
605
+ * カスタムイベントハンドラーの一覧を取得する
726
606
  *
727
- * @returns Current custom event handlers
607
+ * @returns 現在のカスタムイベントハンドラー
608
+ *
609
+ * @public
728
610
  */
729
611
  declare function getCustomHandlers(): {
730
612
  [key: string]: ActionEventHandler;
731
613
  };
732
614
  /**
733
- * {@link setCustomHandlers} function to set custom event handlers.
615
+ * カスタムイベントハンドラーを登録する
616
+ *
617
+ * @remarks
618
+ * 登録したカスタムイベントハンドラーは、ビジュアルエディタでアクション本体とのテキストボタンのクリック時の動作で利用できます。
619
+ *
620
+ * @param handlers - 登録するカスタムイベントハンドラー
734
621
  *
735
- * @param handlers - New custom event handlers
622
+ * @public
736
623
  */
737
624
  declare function setCustomHandlers(handlers: {
738
625
  [key: string]: ActionEventHandler;
739
626
  }): void;
740
627
  /**
741
- * {@link updateCustomHandlers} function to update custom event handlers.
628
+ * カスタムイベントハンドラーを更新する
629
+ *
630
+ * @param handlers - 対象となるカスタムイベントハンドラー
742
631
  *
743
- * @param handlers - Updated custom event handlers
632
+ * @returns 新しいカスタムイベントハンドラーを返します。
744
633
  *
745
- * @returns New custom event handlers
634
+ * @public
746
635
  */
747
636
  declare function updateCustomHandlers(handlers: {
748
637
  [key: string]: ActionEventHandler;
@@ -751,57 +640,54 @@ declare function updateCustomHandlers(handlers: {
751
640
  };
752
641
  /**
753
642
  * Store to handle destruction of action
754
- */
755
- declare const destroyed: Store<boolean>;
756
- /**
757
- * {@link isDestroyed} function to check if action is destroyed.
758
643
  *
759
- * @returns Flag if action is destoryed / true: Destroyed, false: Not Destroyed
644
+ * @internal
760
645
  */
761
- declare function isDestroyed(): boolean;
762
- /**
763
- * {@link setDestroyed} function to set if action is destroyed. */
764
- declare function setDestroyed(on: boolean): void;
646
+ declare const destroyed: Store<boolean>;
765
647
  /**
766
648
  * Store to handle stopping action
767
- */
768
- declare const stopped: Store<boolean>;
769
- /**
770
- * {@link isStopped} function to check if action is stopped.
771
649
  *
772
- * @returns Flag if action is stopped / true: Stopped, false: Not stopped
773
- */
774
- declare function isStopped(): boolean;
775
- /**
776
- * {@link setStopped} function to set if action is stopped.
650
+ * @internal
777
651
  */
778
- declare function setStopped(on: boolean): void;
652
+ declare const stopped: Store<boolean>;
779
653
  /**
780
654
  * Store to handle custom variables
655
+ *
656
+ * @internal
781
657
  */
782
658
  declare const customVariables: Store<{
783
659
  [key: string]: any;
784
660
  }>;
785
661
  /**
786
- * {@link getCustomVariables} function to get custom variables.
662
+ * カスタム変数の一覧を取得する
663
+ *
664
+ * @returns 現在のカスタム変数の一覧
787
665
  *
788
- * @returns Current custom variables
666
+ * @public
789
667
  */
790
668
  declare function getCustomVariables(): CustomVariables;
791
669
  /**
792
- * {@link setCustomVariables} function to set custom variables.
670
+ * カスタム変数を設定する
671
+ *
672
+ * @remarks
673
+ * 設定した変数は、ビジュアルエディタのテキストフォームなどで利用できます。
793
674
  *
794
- * @param variables - New custom variables
675
+ * @param variables - カスタム変数
676
+ *
677
+ * @public
795
678
  */
796
679
  declare function setCustomVariables(variables: CustomVariables): void;
797
680
  /**
798
- * {@link updateCustomVariables} function to update custom variables.
681
+ * カスタム変数を更新する
682
+ *
683
+ * @param variables - 更新するカスタム変数
799
684
  *
800
- * @param variables - Updated custom variables
685
+ * @returns 新しいカスタム変数を返します。
801
686
  *
802
- * @returns New custom variables
687
+ * @public
803
688
  */
804
689
  declare function updateCustomVariables(variables: CustomVariables): CustomVariables;
690
+ /** @internal */
805
691
  interface FormData {
806
692
  [name: string]: {
807
693
  statePath: string;
@@ -811,28 +697,20 @@ interface FormData {
811
697
  }
812
698
  /**
813
699
  * Store for form data
700
+ *
701
+ * @internal
814
702
  */
815
703
  declare const formData: Writable_<FormData>;
704
+ /**
705
+ * 閉じるアクショントリガー
706
+ *
707
+ * @public
708
+ */
816
709
  type CloseTrigger = "button" | "overlay" | "auto" | "none";
817
- declare const ALL_ACTION_ID = "KARTE_ALL_ACTION_ID";
818
- declare const ALL_ACTION_SHORTEN_ID = "KARTE_ALL_ACTION_SHORTEN_ID";
819
- declare const actionId: string;
820
- declare const ACTION_SHOW_EVENT: string;
821
- declare const ACTION_CLOSE_EVENT: string;
822
- declare const ACTION_DESTROY_EVENT: string;
823
- declare const ACTION_CHANGE_STATE_EVENT: string;
824
- declare const handleState: (event: any) => void;
710
+ /** @internal */
825
711
  declare const initialize: (setting?: ActionSetting) => () => void;
712
+ /** @internal */
826
713
  declare const finalize: () => void;
827
- declare const send_event: (event_name: string, values?: any) => void;
828
- // eslint-disable-next-line @typescript-eslint/no-empty-function
829
- declare const none: () => () => void;
830
- declare const moveTo: (to: string) => () => void;
831
- declare const linkTo: (to: string, targetBlank?: boolean) => () => void;
832
- declare const closeApp: (trigger: CloseTrigger) => () => void;
833
- declare const runScript: (handlerName: string) => () => void;
834
- declare const execOnClickOperation: (onClickOperation: OnClickOperation) => void;
835
- declare const haveFunction: (onClickOperation: OnClickOperation) => boolean;
836
714
  /**
837
715
  * An option for svelte custom animation
838
716
  */
@@ -862,81 +740,45 @@ interface CustomAnimationOptions {
862
740
  duration?: number;
863
741
  }
864
742
  /**
865
- * The function to activate svelte animation.
743
+ * ES Modules に対応していない JavaScript をページに読み込む
866
744
  *
867
- * @param node - A target node of animation. This argument is passed by svelte, by default.
868
- * @param customAnimationOptions - A custom animation option object
745
+ * @param src - JavaScript ファイルのリンク URL
869
746
  *
870
- * @see {@link https://svelte.dev/docs#template-syntax-element-directives-transition-fn-custom-transition-functions| Custom transition functions} for detail documentation
871
- */
872
- declare function customAnimation(node: Element, { transform, animationStyle, delay, duration }: CustomAnimationOptions): {
873
- delay?: undefined;
874
- duration?: undefined;
875
- easing?: undefined;
876
- css?: undefined;
877
- } | {
878
- delay: number;
879
- duration: number;
880
- easing: (t: any) => any;
881
- css: (progress: number) => string;
882
- };
883
- /**
884
- * {@link loadGlobalScript} load JavaScript that does not support ESM.
885
- *
886
- * @param src - Link of JavaScript file
747
+ * @public
887
748
  */
888
749
  declare function loadGlobalScript(src: string): Promise<any>;
889
750
  /**
890
- * {@link applyGlobalCss} apply global CSS to WEB page.
751
+ * グローバル CSS をページに適用する
891
752
  *
892
753
  * @param css - CSS
893
- */
894
- declare function applyGlobalCss(css: string): Promise<any>;
895
- /**
896
- * {@link loadGlobalStyle} load global style to WEB page.
897
754
  *
898
- * @param href - Link of style file
755
+ * @public
899
756
  */
900
- declare function loadGlobalStyle(href: string): Promise<any>;
757
+ declare function applyGlobalCss(css: string): Promise<any>;
901
758
  /**
902
- * {@link hashCode} generate hash with FNV-1a hash
759
+ * style ファイルをページに読み込む
903
760
  *
904
- * @param s - Inputed string
761
+ * @param href - style ファイルのリンク URL
905
762
  *
906
- * @returns Hashed string
907
- *
908
- * @see https://stackoverflow.com/a/22429679
763
+ * @public
909
764
  */
910
- declare function hashCode(s: string): string;
765
+ declare function loadGlobalStyle(href: string): Promise<any>;
911
766
  /**
912
767
  * {@link setAutoStart} function to set auto start flag.
913
768
  *
914
769
  * @param on - true: auto start, false: not auto start
915
770
  *
916
771
  * @deprecated 非推奨。`setActionConfig({ autoStart: false })` を使ってください。
917
- */
918
- declare const setAutoStart: (on?: boolean) => void;
919
- /**
920
- * @internal
921
- */
922
- declare const NOOP: Function; // eslint-disable-line @typescript-eslint/no-unused-vars
923
- /**
772
+ *
924
773
  * @internal
925
774
  */
926
- declare const isPreview: () => boolean;
927
- declare const handleFocus: (node: HTMLElement | null) => (e: any) => void;
928
- declare const setPreviousFocus: () => void;
929
- declare const handleKeydown: (handlers: {
930
- [eventName: string]: (e: any) => void;
931
- }) => (e: any) => void;
932
- declare const getPositionStyle: (position: ModalPosition) => string;
933
- declare const getTransform: (position: ModalPosition) => [
934
- number,
935
- number
936
- ];
937
- declare const getMarginStyle: (margin: ModalMargin) => string;
775
+ declare const setAutoStart: (on?: boolean) => void;
938
776
  /**
939
777
  * スクロール方向
778
+ *
779
+ * @public
780
+ *
781
+ * @see {@link onScroll}
940
782
  */
941
783
  type ScrollDirection = "up" | "down";
942
784
  /**
@@ -944,6 +786,10 @@ type ScrollDirection = "up" | "down";
944
786
  *
945
787
  * @remarks
946
788
  * このコンテキスト情報は、{@link OnScrollFunction} が呼び出されたタイミングの情報が格納されています
789
+ *
790
+ * @see {@link onScroll}
791
+ *
792
+ * @public
947
793
  */
948
794
  interface OnScrollContext {
949
795
  /**
@@ -969,6 +815,10 @@ interface OnScrollContext {
969
815
  }
970
816
  /**
971
817
  * {@link onScroll} によって呼び出されるコールバック関数
818
+ *
819
+ * @see {@link onScroll}
820
+ *
821
+ * @public
972
822
  */
973
823
  type OnScrollFunction = (ctx: OnScrollContext) => boolean;
974
824
  /**
@@ -978,6 +828,8 @@ type OnScrollFunction = (ctx: OnScrollContext) => boolean;
978
828
  * @param fn - スクロール率が達したときに呼び出されるコールバック関数
979
829
  *
980
830
  * @returns スクロール率によって呼び出されるコールバックを停止する関数を返します
831
+ *
832
+ * @public
981
833
  */
982
834
  declare function onScroll(rate: number | number[], fn: OnScrollFunction): () => void;
983
835
  /**
@@ -987,26 +839,66 @@ declare function onScroll(rate: number | number[], fn: OnScrollFunction): () =>
987
839
  * @param fn - 指定した時間が経過後に呼び出されるコールバック関数
988
840
  *
989
841
  * @returns コールバックを呼び出すためのタイマーを停止する関数を返します
842
+ *
843
+ * @public
990
844
  */
991
845
  declare function onTime(time: number, fn: Function): () => void;
992
- declare function hasSuffix<Suffix extends "px" | "em" | "rem" | "%" | "fr" | "vw" | "vh" | "">(value: string, suffix: Suffix): value is `${number}${Suffix}`;
993
- declare function toBr(text: string): string;
994
- declare function randStr(digit?: number): string;
995
- // types of props to reference for internaly
996
- interface _Props {
846
+ /**
847
+ * プロパティ
848
+ *
849
+ * @internal
850
+ */
851
+ interface Props {
852
+ /**
853
+ * 全ての条件を満たしたら表示するかどうか
854
+ */
997
855
  show_and_condition?: boolean;
856
+ /**
857
+ * スクロール率による表示を有効化するかどうか
858
+ */
998
859
  show_on_scroll?: boolean;
860
+ /**
861
+ * 表示するスクロール率
862
+ */
999
863
  show_on_scroll_rate?: number;
864
+ /**
865
+ * 条件を満たした時に再表示するかどうか
866
+ */
1000
867
  show_on_scroll_reenter?: boolean;
868
+ /**
869
+ * 時間による表示を有効化するかどうか
870
+ */
1001
871
  show_on_time?: boolean;
872
+ /**
873
+ * 表示する秒数
874
+ */
1002
875
  show_on_time_count?: number;
876
+ /**
877
+ * 全ての条件を満たしたら非表示するかどうか
878
+ */
1003
879
  hide_and_condition?: boolean;
880
+ /**
881
+ * スクロール率で非表示を有効化するかどうか
882
+ */
1004
883
  hide_on_scroll?: boolean;
884
+ /**
885
+ * 非表示にするスクロール率
886
+ */
1005
887
  hide_on_scroll_rate?: number;
888
+ /**
889
+ * 条件を満たした時に表示するかどうか
890
+ */
1006
891
  hide_on_scroll_releave?: boolean;
892
+ /**
893
+ * 時間による非表示を有効化するかどうか
894
+ */
1007
895
  hide_on_time?: boolean;
896
+ /**
897
+ * 非表示にする秒数
898
+ */
1008
899
  hide_on_time_count?: number;
1009
900
  }
901
+ type _Props = Props;
1010
902
  /**
1011
903
  * スクロールに応じてアクションを非表示にするトリガー関数
1012
904
  *
@@ -1020,6 +912,8 @@ interface _Props {
1020
912
  *
1021
913
  * @returns
1022
914
  * スクロールが開始された場合は、クリーンアップする関数を返します。そうでない場合は `null` を返します。
915
+ *
916
+ * @internal
1023
917
  */
1024
918
  declare function hideOnScroll<Props extends Pick<_Props, "hide_on_scroll" | "hide_on_scroll_rate" | "show_on_scroll_reenter">>(props: Props, hide?: Function, show?: Function): (() => void) | null;
1025
919
  /**
@@ -1033,6 +927,8 @@ declare function hideOnScroll<Props extends Pick<_Props, "hide_on_scroll" | "hid
1033
927
  *
1034
928
  * @returns
1035
929
  * タイマーが開始された場合、タイマーをクリーンアップする関数を返します。それ以外は `null` を返します。
930
+ *
931
+ * @internal
1036
932
  */
1037
933
  declare function hideOnTime<Props extends Pick<_Props, "hide_on_time" | "hide_on_time_count">>(props: Props, hide?: Function): (() => void) | null;
1038
934
  /**
@@ -1048,6 +944,8 @@ declare function hideOnTime<Props extends Pick<_Props, "hide_on_time" | "hide_on
1048
944
  *
1049
945
  * @returns
1050
946
  * スクロールが開始されている場合は、クリーンアップ関数を返します。そうでない場合は `null` を返します
947
+ *
948
+ * @internal
1051
949
  */
1052
950
  declare function showOnScroll<Props extends Pick<_Props, "show_on_scroll" | "show_on_scroll_rate" | "hide_on_scroll_releave">>(props: Props, show?: Function, hide?: Function): (() => void) | null;
1053
951
  /**
@@ -1061,16 +959,105 @@ declare function showOnScroll<Props extends Pick<_Props, "show_on_scroll" | "sho
1061
959
  *
1062
960
  * @returns
1063
961
  * タイマーが開始された場合、タイマーをクリーンアップする関数を返します。それ以外は `null` を返します。
962
+ *
963
+ * @internal
1064
964
  */
1065
965
  declare function showOnTime<Props extends Pick<_Props, "show_on_time" | "show_on_time_count">>(props: Props, show?: Function): (() => void) | null;
966
+ type _Props$0 = Props;
1066
967
  /**
1067
- * @internal
968
+ * アクションのライフサイクルで呼び出されるフック
969
+ *
970
+ * @param props - アクションのプロパティ
971
+ *
972
+ * @public
973
+ */
974
+ type ActionHook<Props extends _Props$0, Variables> = (props: ActionProps<Props, Variables & CustomVariables>) => void | Promise<void>;
975
+ /**
976
+ * アクションが作成 (create) される前にフックする関数
977
+ *
978
+ * @param fn - 呼び出されるフック関数
979
+ *
980
+ * @public
981
+ */
982
+ declare function onCreate<Props extends _Props$0, Variables>(fn: ActionHook<Props, Variables & CustomVariables>): void;
983
+ /**
984
+ * アクションが表示 (show) された後にフックする関数
985
+ *
986
+ * @param fn - 呼び出されるフック関数
987
+ *
988
+ * @public
989
+ */
990
+ declare function onShow<Props extends _Props$0, Variables>(fn: ActionHook<Props, Variables & CustomVariables>): void;
991
+ /**
992
+ * アクションのライフサイクル close で呼び出されるフックする関数
993
+ *
994
+ * @param props - アクションのプロパティ
995
+ * @param trigger - Close トリガー
996
+ *
997
+ * @public
998
+ */
999
+ type ActionCloseHook<Props extends _Props$0, Variables> = (props: Parameters<ActionHook<Props, Variables & CustomVariables>>[0], trigger: CloseTrigger) => void | Promise<void>;
1000
+ /**
1001
+ * アクションがクローズ (close) される前にフックする関数
1002
+ *
1003
+ * @param fn - 呼び出されるフック関数
1004
+ *
1005
+ * @public
1006
+ */
1007
+ declare function onClose<Props extends _Props$0, Variables>(fn: ActionCloseHook<Props, Variables & CustomVariables>): void;
1008
+ /**
1009
+ * アクションが破棄 (destroy) される前にフックする関数
1010
+ *
1011
+ * @param fn - 呼び出されるフック関数
1012
+ *
1013
+ * @public
1014
+ */
1015
+ declare function onDestroy<Props extends _Props$0, Variables>(fn: ActionHook<Props, Variables & CustomVariables>): void;
1016
+ /**
1017
+ * アクションのライフサイクル changeState で呼び出されるフック関数
1018
+ *
1019
+ * @param props - アクションのプロパティ
1020
+ * @param newState - アクションの新しいステート
1021
+ *
1022
+ * @public
1023
+ */
1024
+ type ActionChangeStateHook<Props extends _Props$0, Variables> = (props: Parameters<ActionHook<Props, Variables & CustomVariables>>[0], newState: string) => void | Promise<void>;
1025
+ /**
1026
+ * アクションのステートが変更された (changeState) 後にフックする関数
1027
+ *
1028
+ * @param fn - 呼び出されるフック関数
1029
+ *
1030
+ * @public
1031
+ */
1032
+ declare function onChangeState<Props extends _Props$0, Variables>(fn: ActionChangeStateHook<Props, Variables & CustomVariables>): void;
1033
+ /**
1034
+ * アクションの send 関数
1035
+ *
1036
+ * @public
1037
+ */
1038
+ type SendFunction = (event_name: string, values?: any) => void;
1039
+ /**
1040
+ * アクションのプロパティ
1041
+ *
1042
+ * @public
1068
1043
  */
1069
1044
  interface ActionProps<Props, Variables> {
1070
- send: (event_name: string, values?: any) => void;
1045
+ /**
1046
+ * アクションでイベントがトリガーされたときに受信するための関数
1047
+ */
1048
+ send: SendFunction;
1049
+ /**
1050
+ * アクションで使用されるデータ
1051
+ */
1071
1052
  data: Props & Variables & CustomVariables;
1072
- onShow?: (props: ActionProps<Props, Variables & CustomVariables>) => void | Promise<void>;
1073
- onChangeState?: (props: ActionProps<Props, Variables & CustomVariables>, newState: string) => void | Promise<void>;
1053
+ /**
1054
+ * アクションが表示されたときにフックされる {@link onShow}
1055
+ */
1056
+ onShow?: ActionHook<Props, Variables & CustomVariables>;
1057
+ /**
1058
+ * アクションのステートが変更されたときにフックされる {@link onChangeState}
1059
+ */
1060
+ onChangeState?: ActionChangeStateHook<Props, Variables & CustomVariables>;
1074
1061
  }
1075
1062
  /**
1076
1063
  * {@link create} 向けのオプション
@@ -1079,172 +1066,155 @@ interface ActionProps<Props, Variables> {
1079
1066
  */
1080
1067
  interface ActionOptions<Props, Variables> {
1081
1068
  /**
1082
- * KARTE アクションでイベントがトリガーされたときに受信するための関数
1069
+ * アクションでイベントがトリガーされたときに受信するための関数
1083
1070
  *
1084
1071
  * @defaultValue `() => {}`
1085
1072
  */
1086
- send?: (event_name: string, values?: any) => void;
1073
+ send?: SendFunction;
1087
1074
  /**
1088
- * KARTE アクションで使用されるプロパティ
1075
+ * アクションで使用されるプロパティ
1089
1076
  *
1090
1077
  * @defaultValue `{}`
1091
1078
  */
1092
1079
  props?: Props;
1093
1080
  /**
1094
- * KARTE アクションで使用されるアクションテーブルのユーザー環境変数
1081
+ * アクションで使用されるアクションテーブルのユーザー環境変数
1095
1082
  *
1096
1083
  * @defaultValue `{}`
1097
1084
  */
1098
1085
  variables?: Variables;
1099
1086
  /**
1100
- * KARTE アクションでアクションが作成されているときにフックされる {@link onCreate}
1087
+ * アクションが作成されているときにフックされる {@link onCreate}
1101
1088
  *
1102
1089
  * @defaultValue `() => {}`
1103
1090
  */
1104
- onCreate?: (props: ActionProps<Props, Variables & CustomVariables>) => void | Promise<void>;
1091
+ onCreate?: ActionHook<Props, Variables & CustomVariables>;
1105
1092
  }
1106
1093
  /**
1107
- * KARTE アクションを作成する
1094
+ * アクションを作成する
1108
1095
  *
1109
1096
  * @param App - Svelte コンポーネントのエントリポイント
1110
1097
  * @param options - {@link ActionOptions | オプション}
1111
1098
  *
1112
- * @returns KARTE アクションを破棄する関数
1099
+ * @returns アクションを破棄する関数
1113
1100
  *
1114
1101
  * @public
1115
1102
  */
1116
- declare function create<Props extends _Props, Variables>(App: typeof SvelteComponentDev, options?: ActionOptions<Props, Variables & CustomVariables>): () => void;
1103
+ declare function create<Props extends _Props$0, Variables>(App: typeof SvelteComponentDev, options?: ActionOptions<Props, Variables & CustomVariables>): () => void;
1117
1104
  /**
1118
- * Dispatch the event to destroy KARTE action
1105
+ * アクションの破棄する
1119
1106
  *
1120
- * @internal
1121
- */
1122
- declare function dispatchDestroyEvent(): void;
1123
- /**
1124
- * Destory KARTE action
1107
+ * @public
1125
1108
  */
1126
1109
  declare function destroy(): void;
1127
1110
  /**
1128
- * Show KARTE action
1129
- */
1130
- declare function showAction(): void;
1131
- /**
1132
- * Close KARTE action
1133
- */
1134
- declare function closeAction(trigger?: CloseTrigger): void;
1135
- declare const KARTE_ACTION_ROOT = "karte-action-root";
1136
- declare const KARTE_ACTION_RID = "karte-action-rid";
1137
- declare const KARTE_ACTION_SHORTEN_ID = "karte-action-id";
1138
- declare function ensureActionRoot(useShadow?: boolean): ShadowRoot | HTMLElement;
1139
- /**
1140
- * KARTE アクションのライフサイクルで呼び出されるフック
1141
- *
1142
- * @param props - KARTE アクションのプロパティ
1111
+ * アクションを表示する
1143
1112
  *
1144
1113
  * @public
1145
1114
  */
1146
- type ActionHook<Props extends _Props, Variables> = (props: ActionProps<Props, Variables & CustomVariables>) => void | Promise<void>;
1115
+ declare function showAction(): void;
1147
1116
  /**
1148
- * アクションが作成 (create) される前にフックする
1117
+ * アクションを閉じる
1149
1118
  *
1150
- * @param fn - 呼び出されるフック関数
1119
+ * @param trigger - 閉じた時のトリガー。デフォルト `'none'`
1151
1120
  *
1152
1121
  * @public
1153
1122
  */
1154
- declare function onCreate<Props extends _Props, Variables>(fn: ActionHook<Props, Variables & CustomVariables>): void;
1123
+ declare function closeAction(trigger?: CloseTrigger): void;
1124
+ /** @internal */
1125
+ declare function ensureActionRoot(useShadow?: boolean): ShadowRoot | HTMLElement;
1155
1126
  /**
1156
- * アクションが表示 (show) された後にフックする
1127
+ * create a fog element
1157
1128
  *
1158
- * @param fn - 呼び出されるフック関数
1129
+ * @deprecated 非推奨
1159
1130
  *
1160
- * @public
1131
+ * @internal
1161
1132
  */
1162
- declare function onShow<Props extends _Props, Variables>(fn: ActionHook<Props, Variables & CustomVariables>): void;
1133
+ declare function createFog({ color, opacity, zIndex, onclick }: {
1134
+ color?: string;
1135
+ opacity?: string;
1136
+ zIndex?: number;
1137
+ onclick: () => void;
1138
+ }): {
1139
+ fog: HTMLDivElement;
1140
+ close: () => void;
1141
+ };
1142
+ /** @internal */
1143
+ type EmbedLogic = "replace" | "append" | "prepend" | "after" | "before";
1163
1144
  /**
1164
- * KARTE アクションのライフサイクル close で呼び出されるフック
1145
+ * アクションの Shadow Root の Element を取得する
1165
1146
  *
1166
- * @param props - KARTE アクションのプロパティ
1167
- * @param trigger - Close トリガー
1147
+ * @returns
1148
+ * アクションが Shadow Root を持つ場合は Shadow Root の Element 返します。ない場合は `null` を返します
1168
1149
  *
1169
1150
  * @public
1170
1151
  */
1171
- type ActionCloseHook<Props extends _Props, Variables> = (props: ActionProps<Props, Variables & CustomVariables>, trigger: CloseTrigger) => void | Promise<void>;
1152
+ declare function getActionShadowRoot(): ShadowRoot | null;
1172
1153
  /**
1173
- * アクションがクローズ (close) される前にフックする
1154
+ * アクションに CSS を適用する
1174
1155
  *
1175
- * @param fn - 呼び出されるフック関数
1156
+ * @param css - 適用する CSS
1157
+ *
1158
+ * @returns 適用された style 要素を返す Promise
1176
1159
  *
1177
1160
  * @public
1178
1161
  */
1179
- declare function onClose<Props extends _Props, Variables>(fn: ActionCloseHook<Props, Variables & CustomVariables>): void;
1162
+ declare function applyCss(css: string): Promise<HTMLStyleElement>;
1180
1163
  /**
1181
- * アクションが破棄 (destroy) される前にフックする
1164
+ * アクションにグローバルなスタイルを読み込む
1182
1165
  *
1183
- * @param fn - 呼び出されるフック関数
1166
+ * @param href - style ファイルのリンク URL
1184
1167
  *
1185
1168
  * @public
1186
1169
  */
1187
- declare function onDestroy<Props extends _Props, Variables>(fn: ActionHook<Props, Variables & CustomVariables>): void;
1170
+ declare function loadStyle(href: string): Promise<void>;
1171
+ // -------- The following codes are deprecated --------
1188
1172
  /**
1189
- * KARTE アクションのライフサイクル changeState で呼び出されるフック関数
1173
+ * 非推奨です
1190
1174
  *
1191
- * @param props - KARTE アクションのプロパティ
1192
- * @param newState - KARTE アクションの新しいステート
1175
+ * @deprecated 非推奨
1193
1176
  *
1194
- * @public
1177
+ * @internal
1195
1178
  */
1196
- type ActionChangeStateHook<Props extends _Props, Variables> = (props: ActionProps<Props, Variables & CustomVariables>, newState: string) => void | Promise<void>;
1179
+ declare const showModal: typeof create;
1197
1180
  /**
1198
- * アクションのステートが変更された (changeState) 後にフックする
1181
+ * 非推奨です
1199
1182
  *
1200
- * @param fn - 呼び出されるフック関数
1183
+ * @deprecated 非推奨
1201
1184
  *
1202
- * @public
1185
+ * @internal
1203
1186
  */
1204
- declare function onChangeState<Props extends _Props, Variables>(fn: ActionChangeStateHook<Props, Variables & CustomVariables>): void;
1205
- declare const h: (type: string, props: any, ...children: Array<any>) => HTMLElement;
1187
+ declare const KARTE_MODAL_ROOT = "karte-modal-root";
1206
1188
  /**
1207
- * create a fog element
1189
+ * 非推奨です
1208
1190
  *
1209
1191
  * @deprecated 非推奨
1192
+ *
1193
+ * @internal
1210
1194
  */
1211
- declare function createFog({ color, opacity, zIndex, onclick }: {
1212
- color?: string;
1213
- opacity?: string;
1214
- zIndex?: number;
1215
- onclick: () => void;
1216
- }): {
1217
- fog: HTMLDivElement;
1218
- close: () => void;
1219
- };
1220
- type EmbedLogic = "replace" | "append" | "prepend" | "after" | "before";
1221
- declare function embed(target: HTMLElement, replace: HTMLElement, embed_method: EmbedLogic): void;
1222
- declare function getActionShadowRoot(): ShadowRoot | null;
1195
+ declare const ensureModalRoot: typeof ensureActionRoot;
1223
1196
  /**
1224
- * KARTE アクションに CSS を適用する
1197
+ * 非推奨です
1225
1198
  *
1226
- * @param css - 適用する CSS
1199
+ * @deprecated 非推奨
1227
1200
  *
1228
- * @returns 適用された style 要素を返す Promise
1201
+ * @internal
1229
1202
  */
1230
- declare function applyCss(css: string): Promise<HTMLStyleElement>;
1203
+ declare const show: typeof showAction;
1231
1204
  /**
1232
- * KARTE アクションにグローバルなスタイルをロードする
1205
+ * 非推奨です
1206
+ *
1207
+ * @deprecated 非推奨
1233
1208
  *
1234
- * @param href - style ファイルのリンク先 URL
1209
+ * @internal
1235
1210
  */
1236
- declare function loadStyle(href: string): Promise<void>;
1237
- // -------- The following codes are deprecated --------
1238
- declare const showModal: typeof create; // @deprecated
1239
- type ModalOptions<Props, Variables> = ActionOptions<Props, Variables>; // @deprecated
1240
- declare const KARTE_MODAL_ROOT = "karte-modal-root"; // @deprecated
1241
- declare const ensureModalRoot: typeof ensureActionRoot; // @deprecated
1242
- declare const show: typeof showAction; // deprecated
1243
- declare const close: typeof closeAction; // deprecated
1211
+ declare const close: typeof closeAction;
1244
1212
  /**
1245
1213
  * An options for {@link createApp}
1246
1214
  *
1247
1215
  * @deprecated 非推奨
1216
+ *
1217
+ * @internal
1248
1218
  */
1249
1219
  type AppOptions<Props, Variables> = ActionOptions<Props, Variables>;
1250
1220
  /**
@@ -1253,6 +1223,8 @@ type AppOptions<Props, Variables> = ActionOptions<Props, Variables>;
1253
1223
  * @remarks Currently, svelte component is supported only.
1254
1224
  *
1255
1225
  * @deprecated 非推奨
1226
+ *
1227
+ * @internal
1256
1228
  */
1257
1229
  interface App {
1258
1230
  /**
@@ -1273,13 +1245,39 @@ interface App {
1273
1245
  * @returns A function to close the modal
1274
1246
  *
1275
1247
  * @deprecated 非推奨
1248
+ *
1249
+ * @internal
1276
1250
  */
1277
1251
  declare function createApp<Props, Variables>(App: typeof SvelteComponentDev, options?: AppOptions<Props, Variables>): App;
1278
- declare const collection: (config: {
1252
+ /**
1253
+ * アクションテーブルの設定情報
1254
+ *
1255
+ * @public
1256
+ */
1257
+ type CollectionConfig = {
1258
+ /**
1259
+ * APIキー
1260
+ */
1279
1261
  api_key: string;
1262
+ /**
1263
+ * テーブル名
1264
+ */
1280
1265
  table: string;
1266
+ /**
1267
+ * エンドポイント
1268
+ */
1281
1269
  endpoint?: string;
1282
- }) => {
1270
+ };
1271
+ /**
1272
+ * アクションテーブルを管理するメソッドを取得する
1273
+ *
1274
+ * @param config - 設定情報
1275
+ *
1276
+ * @returns メソッドを返します
1277
+ *
1278
+ * @public
1279
+ */
1280
+ declare function collection(config: CollectionConfig): {
1283
1281
  get(key: string | string[], cb: (err: Error | null, items?: any) => void): void;
1284
1282
  getByQuery(query_name: string, params: {
1285
1283
  [p: string]: string | number | boolean | (string | number | boolean)[];
@@ -1289,9 +1287,7 @@ declare const collection: (config: {
1289
1287
  set(key: string, value: string, cb: (err: Error | null) => void): void;
1290
1288
  };
1291
1289
  declare namespace widget {
1292
- /**
1293
- * @internal
1294
- */
1290
+ /** @internal */
1295
1291
  const PropTypes: readonly [
1296
1292
  "BooleanKeyword",
1297
1293
  "NumberKeyword",
@@ -1313,38 +1309,24 @@ declare namespace widget {
1313
1309
  "ModalPlacement",
1314
1310
  "OnClick"
1315
1311
  ];
1316
- /**
1317
- * @internal
1318
- */
1312
+ /** @internal */
1319
1313
  type PropType = (typeof PropTypes)[number];
1320
- /**
1321
- * @internal
1322
- */
1314
+ /** @internal */
1323
1315
  type Code = string;
1324
- /**
1325
- * @internal
1326
- */
1316
+ /** @internal */
1327
1317
  const MediaQueries: {
1328
1318
  [key: string]: string;
1329
1319
  };
1330
- /**
1331
- * @internal
1332
- */
1320
+ /** @internal */
1333
1321
  type MediaQuery = string;
1334
- /**
1335
- * @internal
1336
- */
1322
+ /** @internal */
1337
1323
  const Directions: readonly [
1338
1324
  "row",
1339
1325
  "column"
1340
- ];
1341
- /**
1342
- * @internal
1343
- */
1344
- type Direction = (typeof Directions)[number];
1345
- /**
1346
- * @internal
1347
- */
1326
+ ];
1327
+ /** @internal */
1328
+ type Direction = (typeof Directions)[number];
1329
+ /** @internal */
1348
1330
  const AnimationStyles: readonly [
1349
1331
  "none",
1350
1332
  "fade",
@@ -1354,13 +1336,9 @@ declare namespace widget {
1354
1336
  "slide-left",
1355
1337
  "slide-right"
1356
1338
  ];
1357
- /**
1358
- * @internal
1359
- */
1339
+ /** @internal */
1360
1340
  type AnimationStyle = (typeof AnimationStyles)[number];
1361
- /**
1362
- * @internal
1363
- */
1341
+ /** @internal */
1364
1342
  const ModalPositions: readonly [
1365
1343
  "top-left",
1366
1344
  "top-center",
@@ -1373,62 +1351,44 @@ declare namespace widget {
1373
1351
  "bottom-right",
1374
1352
  "none"
1375
1353
  ];
1376
- /**
1377
- * @internal
1378
- */
1354
+ /** @internal */
1379
1355
  type ModalPosition = (typeof ModalPositions)[number];
1380
- /**
1381
- * @internal
1382
- */
1356
+ /** @internal */
1383
1357
  type ModalMargin = {
1384
1358
  left?: string;
1385
1359
  right?: string;
1386
1360
  top?: string;
1387
1361
  bottom?: string;
1388
1362
  };
1389
- /**
1390
- * @internal
1391
- */
1363
+ /** @internal */
1392
1364
  type ModalPlacement<M = ModalMargin> = {
1393
1365
  position?: ModalPosition;
1394
1366
  margin?: M;
1395
1367
  backgroundOverlay?: boolean;
1396
1368
  backgroundClick?: OnClickOperation;
1397
1369
  };
1398
- /**
1399
- * @internal
1400
- */
1370
+ /** @internal */
1401
1371
  const DefaultModalPlacement: Required<ModalPlacement<Required<ModalMargin>>>;
1402
- /**
1403
- * @internal
1404
- */
1372
+ /** @internal */
1405
1373
  const Elasticities: readonly [
1406
1374
  "none",
1407
1375
  "vertical",
1408
1376
  "horizontal"
1409
1377
  ];
1410
- /**
1411
- * @internal
1412
- */
1378
+ /** @internal */
1413
1379
  type Elasticity = (typeof Elasticities)[number];
1414
- /**
1415
- * @internal
1416
- */
1380
+ /** @internal */
1417
1381
  const ElasticityStyle: {
1418
1382
  none: string;
1419
1383
  vertical: string;
1420
1384
  horizontal: string;
1421
1385
  };
1422
- /**
1423
- * @internal
1424
- */
1386
+ /** @internal */
1425
1387
  const TextDirections: readonly [
1426
1388
  "horizontal",
1427
1389
  "vertical"
1428
1390
  ];
1429
- /**
1430
- * @internal
1431
- */
1391
+ /** @internal */
1432
1392
  type TextDirection = (typeof TextDirections)[number];
1433
1393
  type OperationArgumentTypes = {
1434
1394
  StringKeyword: string;
@@ -1439,9 +1399,7 @@ declare namespace widget {
1439
1399
  Handler: string;
1440
1400
  Trigger: string;
1441
1401
  };
1442
- /**
1443
- * @internal
1444
- */
1402
+ /** @internal */
1445
1403
  type OperationArgumentType = keyof OperationArgumentTypes;
1446
1404
  type BaseOperationOptions = ReadonlyArray<{
1447
1405
  operation: string;
@@ -1458,13 +1416,9 @@ declare namespace widget {
1458
1416
  type ConvertOperationOptionArguments<Arguments extends BaseOperationOptions[number]["args"]> = {
1459
1417
  -readonly [Index in keyof Arguments]: Arguments[Index] extends BaseOperationOptions[number]["args"][number] ? OperationArgumentTypes[Arguments[Index]["type"]] : never;
1460
1418
  };
1461
- /**
1462
- * @internal
1463
- */
1419
+ /** @internal */
1464
1420
  type Operation = ConvertOperationOptions<ReadonlyArray<any>>;
1465
- /**
1466
- * @internal
1467
- */
1421
+ /** @internal */
1468
1422
  const OnClickOperationOptions: readonly [
1469
1423
  {
1470
1424
  readonly operation: "none";
@@ -1512,13 +1466,9 @@ declare namespace widget {
1512
1466
  ];
1513
1467
  }
1514
1468
  ];
1515
- /**
1516
- * @internal
1517
- */
1469
+ /** @internal */
1518
1470
  type OnClickOperation = ConvertOperationOptions<typeof OnClickOperationOptions>;
1519
- /**
1520
- * @internal
1521
- */
1471
+ /** @internal */
1522
1472
  const FormOperationOptions: readonly [
1523
1473
  {
1524
1474
  readonly operation: "submit";
@@ -1548,25 +1498,15 @@ declare namespace widget {
1548
1498
  ];
1549
1499
  }
1550
1500
  ];
1551
- /**
1552
- * @internal
1553
- */
1501
+ /** @internal */
1554
1502
  type FormOperation = ConvertOperationOptions<typeof FormOperationOptions>;
1555
- /**
1556
- * @internal
1557
- */
1503
+ /** @internal */
1558
1504
  type LongText = string;
1559
- /**
1560
- * @internal
1561
- */
1505
+ /** @internal */
1562
1506
  type Url = string;
1563
- /**
1564
- * @internal
1565
- */
1507
+ /** @internal */
1566
1508
  type Image = string;
1567
- /**
1568
- * @internal
1569
- */
1509
+ /** @internal */
1570
1510
  const LengthUnits: readonly [
1571
1511
  "px",
1572
1512
  "em",
@@ -1575,147 +1515,93 @@ declare namespace widget {
1575
1515
  "fr",
1576
1516
  "%"
1577
1517
  ];
1578
- /**
1579
- * @internal
1580
- */
1518
+ /** @internal */
1581
1519
  type LengthUnit = (typeof LengthUnits)[number];
1582
- /**
1583
- * @internal
1584
- */
1520
+ /** @internal */
1585
1521
  type Length = `${number}${LengthUnit}` | "auto";
1586
- /**
1587
- * @internal
1588
- */
1522
+ /** @internal */
1589
1523
  type Color = `#${string}` | `rgba(${string})`;
1590
- /**
1591
- * @internal
1592
- */
1524
+ /** @internal */
1593
1525
  const Justifies: readonly [
1594
1526
  "flex-start",
1595
1527
  "center",
1596
1528
  "flex-end"
1597
1529
  ];
1598
- /**
1599
- * @internal
1600
- */
1530
+ /** @internal */
1601
1531
  type Justify = (typeof Justifies)[number];
1602
- /**
1603
- * @internal
1604
- */
1532
+ /** @internal */
1605
1533
  const Alignments: readonly [
1606
1534
  "flex-start",
1607
1535
  "center",
1608
1536
  "flex-end"
1609
1537
  ];
1610
- /**
1611
- * @internal
1612
- */
1538
+ /** @internal */
1613
1539
  type Alignment = (typeof Alignments)[number];
1614
- /**
1615
- * @internal
1616
- */
1540
+ /** @internal */
1617
1541
  const ObjectFits: readonly [
1618
1542
  "fill",
1619
1543
  "contain",
1620
1544
  "cover"
1621
1545
  ];
1622
- /**
1623
- * @internal
1624
- */
1546
+ /** @internal */
1625
1547
  type ObjectFit = (typeof ObjectFits)[number];
1626
- /**
1627
- * @internal
1628
- */
1548
+ /** @internal */
1629
1549
  const ClipPaths: readonly [
1630
1550
  "none",
1631
1551
  "circle(closest-side)"
1632
1552
  ];
1633
- /**
1634
- * @internal
1635
- */
1553
+ /** @internal */
1636
1554
  type ClipPath = (typeof ClipPaths)[number];
1637
- /**
1638
- * @internal
1639
- */
1555
+ /** @internal */
1640
1556
  const Repeats: readonly [
1641
1557
  "repeat",
1642
1558
  "space",
1643
1559
  "round",
1644
1560
  "no-repeat"
1645
1561
  ];
1646
- /**
1647
- * @internal
1648
- */
1562
+ /** @internal */
1649
1563
  type Repeat = (typeof Repeats)[number];
1650
- /**
1651
- * @internal
1652
- */
1564
+ /** @internal */
1653
1565
  const BackgroundSizes: readonly [
1654
1566
  "cover",
1655
1567
  "contain",
1656
1568
  "auto"
1657
1569
  ];
1658
- /**
1659
- * @internal
1660
- */
1570
+ /** @internal */
1661
1571
  type BackgroundSize = (typeof BackgroundSizes)[number];
1662
- /**
1663
- * @internal
1664
- */
1572
+ /** @internal */
1665
1573
  const Cursors: readonly [
1666
1574
  "default",
1667
1575
  "pointer"
1668
1576
  ];
1669
- /**
1670
- * @internal
1671
- */
1577
+ /** @internal */
1672
1578
  type Cursor = (typeof Cursors)[number];
1673
- /**
1674
- * @internal
1675
- */
1579
+ /** @internal */
1676
1580
  const Overflows: readonly [
1677
1581
  "visible",
1678
1582
  "auto",
1679
1583
  "hidden"
1680
1584
  ];
1681
- /**
1682
- * @internal
1683
- */
1585
+ /** @internal */
1684
1586
  type Overflow = (typeof Overflows)[number];
1685
- /**
1686
- * @internal
1687
- */
1587
+ /** @internal */
1688
1588
  type Border = string;
1689
- /**
1690
- * @internal
1691
- */
1589
+ /** @internal */
1692
1590
  type BorderStyle = string;
1693
- /**
1694
- * @internal
1695
- */
1591
+ /** @internal */
1696
1592
  type BorderWidth = `${number}px`;
1697
- /**
1698
- * @internal
1699
- */
1593
+ /** @internal */
1700
1594
  type Style = string;
1701
- /**
1702
- * @internal
1703
- */
1595
+ /** @internal */
1704
1596
  type StateName = string;
1705
- /**
1706
- * @internal
1707
- */
1597
+ /** @internal */
1708
1598
  const WritingModes: readonly [
1709
1599
  "horizontal-tb",
1710
1600
  "vertical-lr"
1711
1601
  ];
1712
- /**
1713
- * @internal
1714
- */
1602
+ /** @internal */
1715
1603
  type WritingMode = (typeof WritingModes)[number];
1716
- /**
1717
- * @internal
1718
- */
1604
+ /** @internal */
1719
1605
  const ListSeparatorTypes: readonly [
1720
1606
  "none",
1721
1607
  "border",
@@ -1725,51 +1611,33 @@ declare namespace widget {
1725
1611
  interface BaseListSeparator {
1726
1612
  type: ListSeparatorType;
1727
1613
  }
1728
- /**
1729
- * @internal
1730
- */
1614
+ /** @internal */
1731
1615
  interface ListSeparatorNone extends BaseListSeparator {
1732
1616
  type: "none";
1733
1617
  }
1734
- /**
1735
- * @internal
1736
- */
1618
+ /** @internal */
1737
1619
  interface ListSeparatorBorder extends BaseListSeparator {
1738
1620
  type: "border";
1739
1621
  borderStyle: BorderStyle;
1740
1622
  borderWidth?: BorderWidth;
1741
1623
  borderColor?: Color;
1742
1624
  }
1743
- /**
1744
- * @internal
1745
- */
1625
+ /** @internal */
1746
1626
  interface ListSeparatorGap extends BaseListSeparator {
1747
1627
  type: "gap";
1748
1628
  gap: Length;
1749
1629
  }
1750
- /**
1751
- * @internal
1752
- */
1630
+ /** @internal */
1753
1631
  type ListSeparator = ListSeparatorNone | ListSeparatorBorder | ListSeparatorGap;
1754
- /**
1755
- * @internal
1756
- */
1632
+ /** @internal */
1757
1633
  const DefaultListSeparatorNone: Required<ListSeparatorNone>;
1758
- /**
1759
- * @internal
1760
- */
1634
+ /** @internal */
1761
1635
  const DefaultListSeparatorBorder: Required<ListSeparatorBorder>;
1762
- /**
1763
- * @internal
1764
- */
1636
+ /** @internal */
1765
1637
  const DefaultListSeparatorGap: Required<ListSeparatorGap>;
1766
- /**
1767
- * @internal
1768
- */
1638
+ /** @internal */
1769
1639
  const DefaultListSeparator: Required<ListSeparatorBorder>;
1770
- /**
1771
- * @internal
1772
- */
1640
+ /** @internal */
1773
1641
  const ListBackgroundTypes: readonly [
1774
1642
  "none",
1775
1643
  "stripe"
@@ -1778,15 +1646,11 @@ declare namespace widget {
1778
1646
  interface BaseListBackground {
1779
1647
  type: ListBackgroundType;
1780
1648
  }
1781
- /**
1782
- * @internal
1783
- */
1649
+ /** @internal */
1784
1650
  interface ListBackgroundNone extends BaseListBackground {
1785
1651
  type: "none";
1786
1652
  }
1787
- /**
1788
- * @internal
1789
- */
1653
+ /** @internal */
1790
1654
  interface ListBackgroundStripe extends BaseListBackground {
1791
1655
  type: "stripe";
1792
1656
  background1?: Color;
@@ -1796,32 +1660,20 @@ declare namespace widget {
1796
1660
  * @internal
1797
1661
  */
1798
1662
  type ListBackground = ListBackgroundNone | ListBackgroundStripe;
1799
- /**
1800
- * @internal
1801
- */
1663
+ /** @internal */
1802
1664
  const DefaultListBackgroundNone: Required<ListBackgroundNone>;
1803
- /**
1804
- * @internal
1805
- */
1665
+ /** @internal */
1806
1666
  const DefaultListBackgroundStripe: Required<ListBackgroundStripe>;
1807
- /**
1808
- * @internal
1809
- */
1667
+ /** @internal */
1810
1668
  const DefaultListBackground: Required<ListBackgroundNone>;
1811
- /**
1812
- * @internal
1813
- */
1669
+ /** @internal */
1814
1670
  const ListDirections: readonly [
1815
1671
  "vertical",
1816
1672
  "horizontal"
1817
1673
  ];
1818
- /**
1819
- * @internal
1820
- */
1674
+ /** @internal */
1821
1675
  type ListDirection = (typeof ListDirections)[number];
1822
- /**
1823
- * @internal
1824
- */
1676
+ /** @internal */
1825
1677
  type ListContext = {
1826
1678
  separator: ListSeparator;
1827
1679
  background: ListBackground;
@@ -1834,25 +1686,89 @@ declare namespace widget {
1834
1686
  }) => string;
1835
1687
  unregisterItem: (id: string) => void;
1836
1688
  };
1837
- // Wrap svelte tools
1838
- type Store<T> = Writable_<T>;
1689
+ type SliderButtonType = "icon" | "text";
1690
+ type BaseSliderButton = {
1691
+ type: SliderButtonType;
1692
+ };
1693
+ interface SliderButtonIcon extends BaseSliderButton {
1694
+ type: "icon";
1695
+ icon: string;
1696
+ size: Length;
1697
+ color: Color;
1698
+ fill: Color;
1699
+ }
1700
+ interface SliderButtonText extends BaseSliderButton {
1701
+ type: "text";
1702
+ text: string;
1703
+ }
1704
+ type SliderButton = SliderButtonIcon | SliderButtonText;
1705
+ const DefaultSliderButton: {
1706
+ readonly type: "icon";
1707
+ readonly icon: "chevron-left";
1708
+ readonly color: "#999";
1709
+ readonly fill: "#999";
1710
+ readonly size: "20px";
1711
+ };
1712
+ type SliderButtonPosition = "top" | "middle" | "bottom";
1713
+ interface SliderNavigationButton {
1714
+ type: "circle";
1715
+ size: Length;
1716
+ color: Color;
1717
+ colorActive: Color;
1718
+ }
1719
+ const DefaultSliderNavigationButton: {
1720
+ readonly type: "circle";
1721
+ readonly size: "8px";
1722
+ readonly color: "#ddd";
1723
+ readonly colorActive: "#666";
1724
+ };
1725
+ /** @internal */
1726
+ type Store<T> = Writable_<T>; // Wrap svelte tools
1839
1727
  /**
1840
1728
  * get store state value
1841
1729
  *
1842
1730
  * @deprecated 非推奨
1731
+ *
1732
+ * @internal
1843
1733
  */
1844
1734
  const getStoreState: typeof get_;
1735
+ /**
1736
+ * KARTE のシステム設定情報
1737
+ *
1738
+ * @public
1739
+ */
1845
1740
  type SystemConfig = {
1741
+ /**
1742
+ * API キー
1743
+ */
1846
1744
  apiKey?: string;
1745
+ /**
1746
+ * 接客ID
1747
+ */
1847
1748
  campaignId?: string;
1848
1749
  shortenId?: string;
1849
1750
  };
1751
+ /**
1752
+ * アクションのイベントハンドラ
1753
+ *
1754
+ * @public
1755
+ */
1850
1756
  type ActionEventHandler = (...args: any[]) => any | Promise<any>;
1757
+ /**
1758
+ * アクション設定
1759
+ *
1760
+ * @public
1761
+ */
1851
1762
  type ActionSetting = {
1852
1763
  send?: (event_name: string, values?: any) => void;
1853
1764
  initialState?: string;
1854
1765
  autoStart?: boolean;
1855
1766
  };
1767
+ /**
1768
+ * カスタム変数
1769
+ *
1770
+ * @public
1771
+ */
1856
1772
  type CustomVariables = {
1857
1773
  [key: string]: any;
1858
1774
  };
@@ -1864,18 +1780,27 @@ declare namespace widget {
1864
1780
  * {@link getActionSetting} function to get action setting.
1865
1781
  *
1866
1782
  * @returns Current action setting
1783
+ *
1784
+ * @internal
1867
1785
  */
1868
1786
  function getActionSetting(): ActionSetting;
1869
1787
  /**
1870
- * {@link setActionSetting} function to "update" action setting
1788
+ * アクション設定を更新する
1789
+ *
1790
+ * @remarks
1791
+ * アクションの自動起動 (autoStart) を設定できます。
1792
+ *
1793
+ * @param setting - 更新するアクション設定
1871
1794
  *
1872
- * @param setting - Updated action setting
1795
+ * @returns 新しいアクション設定
1873
1796
  *
1874
- * @returns New action setting
1797
+ * @public
1875
1798
  */
1876
1799
  function setActionSetting(setting: ActionSetting): ActionSetting;
1877
1800
  /**
1878
1801
  * {@link resetActionSetting} function to reset action setting
1802
+ *
1803
+ * @internal
1879
1804
  */
1880
1805
  function resetActionSetting(): void;
1881
1806
  /**
@@ -1883,13 +1808,21 @@ declare namespace widget {
1883
1808
  */
1884
1809
  const system: Store<SystemConfig>;
1885
1810
  /**
1886
- * {@link getSystem} function to get KARTE system config.
1811
+ * KARTE の設定を取得する
1812
+ *
1813
+ * @remarks
1814
+ * アクションが表示されて設定されるため、{@link onShow} フック関数で利用できます。
1815
+ * 取得できる設定は、APIキー、接客ID、アクションショートIDなどです。
1816
+ *
1817
+ * @returns 現在の KARTE システムの設定を返します
1887
1818
  *
1888
- * @returns Current karte system config
1819
+ * @public
1889
1820
  */
1890
1821
  function getSystem(): SystemConfig;
1891
1822
  /**
1892
1823
  * {@link setSystem} function to set KARTE system config.
1824
+ *
1825
+ * @internal
1893
1826
  */
1894
1827
  function setSystem(config: SystemConfig): void;
1895
1828
  /**
@@ -1897,52 +1830,81 @@ declare namespace widget {
1897
1830
  *
1898
1831
  * This is exported becase of compatible interface for App.svelte.
1899
1832
  * Don't use directly.
1833
+ *
1834
+ * @internal
1900
1835
  */
1901
1836
  const state: Store<string>;
1902
1837
  /**
1903
- * {@link setState} function to set current state ID.
1838
+ * 現在のステートを設定する
1839
+ *
1840
+ * @param stateId - 表示するステートID
1841
+ * @param force - 強制的にステートを設定するフラグ。デフォルトは `false`
1842
+ *
1843
+ * @public
1904
1844
  */
1905
1845
  function setState(stateId: string, force?: boolean): void;
1906
1846
  /**
1907
- * {@link getState} function to get current state ID.
1847
+ * 現在のステートを取得する
1848
+ *
1849
+ * @remarks
1850
+ * アクションが表示されて設定されるため、{@link onShow} フック関数で利用できます。
1908
1851
  *
1909
- * @returns Current state ID
1852
+ * @returns 現在のステートID
1853
+ *
1854
+ * @public
1910
1855
  */
1911
1856
  function getState(): string;
1912
1857
  /**
1913
1858
  * Store to handle all state IDs
1859
+ *
1860
+ * @internal
1914
1861
  */
1915
1862
  const states: Store<string[]>;
1916
1863
  /**
1917
1864
  * {@link getStates} function to add new state ID to list of state IDs.
1918
1865
  *
1919
1866
  * @param stateId - New state ID
1867
+ *
1868
+ * @internal
1920
1869
  */
1921
1870
  function addState(stateId: string): void;
1922
1871
  /**
1923
- * {@link getStates} function to get a list of all state IDs.
1872
+ * ステートID一覧を取得する
1873
+ *
1874
+ * @remarks
1875
+ * アクションが表示されて設定されるため、{@link onShow} フック関数で利用できます。
1924
1876
  *
1925
- * @returns All state IDs
1877
+ * @returns すべてのステートID
1878
+ *
1879
+ * @public
1926
1880
  */
1927
1881
  function getStates(): string[];
1928
1882
  /**
1929
1883
  * Store to handle visibility of action
1884
+ *
1885
+ * @internal
1930
1886
  */
1931
1887
  const opened: Store<boolean>;
1932
1888
  /**
1933
- * {@link isOpened} function to check if action is opened.
1889
+ * アクションの表示・非表示の状態を取得する
1934
1890
  *
1935
- * @returns Flag if action is opend / true: Opend, false: Not opened
1891
+ * @returns アクションが表示されているときは `true`、非表示のときは `false` を返します。
1892
+ *
1893
+ * @public
1936
1894
  */
1937
1895
  function isOpened(): boolean;
1938
1896
  /**
1939
1897
  * {@link setOpened} function to set if action is opened.
1898
+ *
1899
+ * @internal
1940
1900
  */
1941
1901
  function setOpened(on: boolean): void;
1942
1902
  /**
1943
1903
  * Store to handle visibility of action
1944
1904
  *
1945
1905
  * @deprecated 非推奨
1906
+ *
1907
+ * @internal
1946
1908
  */
1947
1909
  const closed: Store<boolean>; // deprecated
1948
1910
  /**
@@ -1951,26 +1913,34 @@ declare namespace widget {
1951
1913
  * @returns Flag if action is closed / true: Closed, false: Not closed
1952
1914
  *
1953
1915
  * @deprecated 非推奨
1916
+ *
1917
+ * @internal
1954
1918
  */
1955
1919
  function isClosed(): boolean;
1956
1920
  /**
1957
1921
  * {@link setClosed} function to set if action is closed.
1958
1922
  *
1959
1923
  * @deprecated 非推奨
1924
+ *
1925
+ * @internal
1960
1926
  */
1961
1927
  function setClosed(on: boolean): void;
1962
1928
  /**
1963
1929
  * Store to handle max z-index for grid items
1930
+ *
1931
+ * @internal
1964
1932
  */
1965
1933
  const maximumZindex: Store<number>;
1966
1934
  /**
1967
1935
  * Set maximum z-index.
1936
+ *
1937
+ * @internal
1968
1938
  */
1969
1939
  const setMaximumZindex: (zindex?: number) => void;
1970
1940
  /**
1971
1941
  * Store to handle internal event handlers
1972
1942
  *
1973
- * This is used internally.
1943
+ * @internal
1974
1944
  */
1975
1945
  const internalHandlers: Store<{
1976
1946
  [key: string]: ActionEventHandler[];
@@ -1979,12 +1949,16 @@ declare namespace widget {
1979
1949
  * {@link getInternalHandlers} function to get internal event handlers.
1980
1950
  *
1981
1951
  * @returns Current internal handlers
1952
+ *
1953
+ * @internal
1982
1954
  */
1983
1955
  function getInternalHandlers(): {
1984
1956
  [key: string]: ActionEventHandler[];
1985
1957
  };
1986
1958
  /**
1987
1959
  * {@link setInternalHandlers} function to set internal event handlers.
1960
+ *
1961
+ * @internal
1988
1962
  */
1989
1963
  function setInternalHandlers(handlers: {
1990
1964
  [key: string]: ActionEventHandler[];
@@ -2005,32 +1979,43 @@ declare namespace widget {
2005
1979
  * Store to handle custom event handlers
2006
1980
  *
2007
1981
  * This is used internally.
1982
+ *
1983
+ * @internal
2008
1984
  */
2009
1985
  const customHandlers: Store<{
2010
1986
  [key: string]: ActionEventHandler;
2011
1987
  }>;
2012
1988
  /**
2013
- * {@link getCustomHandlers} function to get custom event handlers.
1989
+ * カスタムイベントハンドラーの一覧を取得する
2014
1990
  *
2015
- * @returns Current custom event handlers
1991
+ * @returns 現在のカスタムイベントハンドラー
1992
+ *
1993
+ * @public
2016
1994
  */
2017
1995
  function getCustomHandlers(): {
2018
1996
  [key: string]: ActionEventHandler;
2019
1997
  };
2020
1998
  /**
2021
- * {@link setCustomHandlers} function to set custom event handlers.
1999
+ * カスタムイベントハンドラーを登録する
2022
2000
  *
2023
- * @param handlers - New custom event handlers
2001
+ * @remarks
2002
+ * 登録したカスタムイベントハンドラーは、ビジュアルエディタでアクション本体とのテキストボタンのクリック時の動作で利用できます。
2003
+ *
2004
+ * @param handlers - 登録するカスタムイベントハンドラー
2005
+ *
2006
+ * @public
2024
2007
  */
2025
2008
  function setCustomHandlers(handlers: {
2026
2009
  [key: string]: ActionEventHandler;
2027
2010
  }): void;
2028
2011
  /**
2029
- * {@link updateCustomHandlers} function to update custom event handlers.
2012
+ * カスタムイベントハンドラーを更新する
2030
2013
  *
2031
- * @param handlers - Updated custom event handlers
2014
+ * @param handlers - 対象となるカスタムイベントハンドラー
2032
2015
  *
2033
- * @returns New custom event handlers
2016
+ * @returns 新しいカスタムイベントハンドラーを返します。
2017
+ *
2018
+ * @public
2034
2019
  */
2035
2020
  function updateCustomHandlers(handlers: {
2036
2021
  [key: string]: ActionEventHandler;
@@ -2039,19 +2024,28 @@ declare namespace widget {
2039
2024
  };
2040
2025
  /**
2041
2026
  * Store to handle destruction of action
2027
+ *
2028
+ * @internal
2042
2029
  */
2043
2030
  const destroyed: Store<boolean>;
2044
2031
  /**
2045
2032
  * {@link isDestroyed} function to check if action is destroyed.
2046
2033
  *
2047
2034
  * @returns Flag if action is destoryed / true: Destroyed, false: Not Destroyed
2035
+ *
2036
+ * @internal
2048
2037
  */
2049
2038
  function isDestroyed(): boolean;
2050
2039
  /**
2051
- * {@link setDestroyed} function to set if action is destroyed. */
2040
+ * {@link setDestroyed} function to set if action is destroyed.
2041
+ *
2042
+ * @internal
2043
+ */
2052
2044
  function setDestroyed(on: boolean): void;
2053
2045
  /**
2054
2046
  * Store to handle stopping action
2047
+ *
2048
+ * @internal
2055
2049
  */
2056
2050
  const stopped: Store<boolean>;
2057
2051
  /**
@@ -2062,34 +2056,48 @@ declare namespace widget {
2062
2056
  function isStopped(): boolean;
2063
2057
  /**
2064
2058
  * {@link setStopped} function to set if action is stopped.
2059
+ *
2060
+ * @internal
2065
2061
  */
2066
2062
  function setStopped(on: boolean): void;
2067
2063
  /**
2068
2064
  * Store to handle custom variables
2065
+ *
2066
+ * @internal
2069
2067
  */
2070
2068
  const customVariables: Store<{
2071
2069
  [key: string]: any;
2072
2070
  }>;
2073
2071
  /**
2074
- * {@link getCustomVariables} function to get custom variables.
2072
+ * カスタム変数の一覧を取得する
2073
+ *
2074
+ * @returns 現在のカスタム変数の一覧
2075
2075
  *
2076
- * @returns Current custom variables
2076
+ * @public
2077
2077
  */
2078
2078
  function getCustomVariables(): CustomVariables;
2079
2079
  /**
2080
- * {@link setCustomVariables} function to set custom variables.
2080
+ * カスタム変数を設定する
2081
+ *
2082
+ * @remarks
2083
+ * 設定した変数は、ビジュアルエディタのテキストフォームなどで利用できます。
2084
+ *
2085
+ * @param variables - カスタム変数
2081
2086
  *
2082
- * @param variables - New custom variables
2087
+ * @public
2083
2088
  */
2084
2089
  function setCustomVariables(variables: CustomVariables): void;
2085
2090
  /**
2086
- * {@link updateCustomVariables} function to update custom variables.
2091
+ * カスタム変数を更新する
2092
+ *
2093
+ * @param variables - 更新するカスタム変数
2087
2094
  *
2088
- * @param variables - Updated custom variables
2095
+ * @returns 新しいカスタム変数を返します。
2089
2096
  *
2090
- * @returns New custom variables
2097
+ * @public
2091
2098
  */
2092
2099
  function updateCustomVariables(variables: CustomVariables): CustomVariables;
2100
+ /** @internal */
2093
2101
  interface FormData {
2094
2102
  [name: string]: {
2095
2103
  statePath: string;
@@ -2099,27 +2107,51 @@ declare namespace widget {
2099
2107
  }
2100
2108
  /**
2101
2109
  * Store for form data
2110
+ *
2111
+ * @internal
2102
2112
  */
2103
2113
  const formData: Writable_<FormData>;
2114
+ /**
2115
+ * 閉じるアクショントリガー
2116
+ *
2117
+ * @public
2118
+ */
2104
2119
  type CloseTrigger = "button" | "overlay" | "auto" | "none";
2120
+ /** @internal */
2105
2121
  const ALL_ACTION_ID = "KARTE_ALL_ACTION_ID";
2122
+ /** @internal */
2106
2123
  const ALL_ACTION_SHORTEN_ID = "KARTE_ALL_ACTION_SHORTEN_ID";
2124
+ /** @internal */
2107
2125
  const actionId: string;
2126
+ /** @internal */
2108
2127
  const ACTION_SHOW_EVENT: string;
2128
+ /** @internal */
2109
2129
  const ACTION_CLOSE_EVENT: string;
2130
+ /** @internal */
2110
2131
  const ACTION_DESTROY_EVENT: string;
2132
+ /** @internal */
2111
2133
  const ACTION_CHANGE_STATE_EVENT: string;
2134
+ /** @internal */
2112
2135
  const handleState: (event: any) => void;
2136
+ /** @internal */
2113
2137
  const initialize: (setting?: ActionSetting) => () => void;
2138
+ /** @internal */
2114
2139
  const finalize: () => void;
2140
+ /** @internal */
2115
2141
  const send_event: (event_name: string, values?: any) => void;
2116
- // eslint-disable-next-line @typescript-eslint/no-empty-function
2117
- const none: () => () => void;
2142
+ /** @internal */
2143
+ const none: () => () => void; // eslint-disable-next @typescript-eslint/no-empty-function
2144
+ /** @internal */
2118
2145
  const moveTo: (to: string) => () => void;
2146
+ /** @internal */
2119
2147
  const linkTo: (to: string, targetBlank?: boolean) => () => void;
2148
+ /** @internal */
2120
2149
  const closeApp: (trigger: CloseTrigger) => () => void;
2150
+ /** @internal */
2121
2151
  const runScript: (handlerName: string) => () => void;
2152
+ /** @internal */
2122
2153
  const execOnClickOperation: (onClickOperation: OnClickOperation) => void;
2154
+ /** @internal */
2123
2155
  const haveFunction: (onClickOperation: OnClickOperation) => boolean;
2124
2156
  /**
2125
2157
  * An option for svelte custom animation
@@ -2156,6 +2188,8 @@ declare namespace widget {
2156
2188
  * @param customAnimationOptions - A custom animation option object
2157
2189
  *
2158
2190
  * @see {@link https://svelte.dev/docs#template-syntax-element-directives-transition-fn-custom-transition-functions| Custom transition functions} for detail documentation
2191
+ *
2192
+ * @internal
2159
2193
  */
2160
2194
  function customAnimation(node: Element, { transform, animationStyle, delay, duration }: CustomAnimationOptions): {
2161
2195
  delay?: undefined;
@@ -2169,21 +2203,27 @@ declare namespace widget {
2169
2203
  css: (progress: number) => string;
2170
2204
  };
2171
2205
  /**
2172
- * {@link loadGlobalScript} load JavaScript that does not support ESM.
2206
+ * ES Modules に対応していない JavaScript をページに読み込む
2207
+ *
2208
+ * @param src - JavaScript ファイルのリンク URL
2173
2209
  *
2174
- * @param src - Link of JavaScript file
2210
+ * @public
2175
2211
  */
2176
2212
  function loadGlobalScript(src: string): Promise<any>;
2177
2213
  /**
2178
- * {@link applyGlobalCss} apply global CSS to WEB page.
2214
+ * グローバル CSS をページに適用する
2179
2215
  *
2180
2216
  * @param css - CSS
2217
+ *
2218
+ * @public
2181
2219
  */
2182
2220
  function applyGlobalCss(css: string): Promise<any>;
2183
2221
  /**
2184
- * {@link loadGlobalStyle} load global style to WEB page.
2222
+ * style ファイルをページに読み込む
2223
+ *
2224
+ * @param href - style ファイルのリンク URL
2185
2225
  *
2186
- * @param href - Link of style file
2226
+ * @public
2187
2227
  */
2188
2228
  function loadGlobalStyle(href: string): Promise<any>;
2189
2229
  /**
@@ -2194,6 +2234,8 @@ declare namespace widget {
2194
2234
  * @returns Hashed string
2195
2235
  *
2196
2236
  * @see https://stackoverflow.com/a/22429679
2237
+ *
2238
+ * @internal
2197
2239
  */
2198
2240
  function hashCode(s: string): string;
2199
2241
  /**
@@ -2202,31 +2244,160 @@ declare namespace widget {
2202
2244
  * @param on - true: auto start, false: not auto start
2203
2245
  *
2204
2246
  * @deprecated 非推奨。`setActionConfig({ autoStart: false })` を使ってください。
2247
+ *
2248
+ * @internal
2205
2249
  */
2206
2250
  const setAutoStart: (on?: boolean) => void;
2207
- // types of props to reference for internaly
2208
- interface _Props {
2251
+ /**
2252
+ * プロパティ
2253
+ *
2254
+ * @internal
2255
+ */
2256
+ interface Props {
2257
+ /**
2258
+ * 全ての条件を満たしたら表示するかどうか
2259
+ */
2209
2260
  show_and_condition?: boolean;
2261
+ /**
2262
+ * スクロール率による表示を有効化するかどうか
2263
+ */
2210
2264
  show_on_scroll?: boolean;
2265
+ /**
2266
+ * 表示するスクロール率
2267
+ */
2211
2268
  show_on_scroll_rate?: number;
2269
+ /**
2270
+ * 条件を満たした時に再表示するかどうか
2271
+ */
2212
2272
  show_on_scroll_reenter?: boolean;
2273
+ /**
2274
+ * 時間による表示を有効化するかどうか
2275
+ */
2213
2276
  show_on_time?: boolean;
2277
+ /**
2278
+ * 表示する秒数
2279
+ */
2214
2280
  show_on_time_count?: number;
2281
+ /**
2282
+ * 全ての条件を満たしたら非表示するかどうか
2283
+ */
2215
2284
  hide_and_condition?: boolean;
2285
+ /**
2286
+ * スクロール率で非表示を有効化するかどうか
2287
+ */
2216
2288
  hide_on_scroll?: boolean;
2289
+ /**
2290
+ * 非表示にするスクロール率
2291
+ */
2217
2292
  hide_on_scroll_rate?: number;
2293
+ /**
2294
+ * 条件を満たした時に表示するかどうか
2295
+ */
2218
2296
  hide_on_scroll_releave?: boolean;
2297
+ /**
2298
+ * 時間による非表示を有効化するかどうか
2299
+ */
2219
2300
  hide_on_time?: boolean;
2301
+ /**
2302
+ * 非表示にする秒数
2303
+ */
2220
2304
  hide_on_time_count?: number;
2221
2305
  }
2306
+ type _Props = Props;
2222
2307
  /**
2223
- * @internal
2308
+ * アクションのライフサイクルで呼び出されるフック
2309
+ *
2310
+ * @param props - アクションのプロパティ
2311
+ *
2312
+ * @public
2313
+ */
2314
+ type ActionHook<Props extends _Props, Variables> = (props: ActionProps<Props, Variables & CustomVariables>) => void | Promise<void>;
2315
+ /**
2316
+ * アクションが作成 (create) される前にフックする関数
2317
+ *
2318
+ * @param fn - 呼び出されるフック関数
2319
+ *
2320
+ * @public
2321
+ */
2322
+ function onCreate<Props extends _Props, Variables>(fn: ActionHook<Props, Variables & CustomVariables>): void;
2323
+ /**
2324
+ * アクションが表示 (show) された後にフックする関数
2325
+ *
2326
+ * @param fn - 呼び出されるフック関数
2327
+ *
2328
+ * @public
2329
+ */
2330
+ function onShow<Props extends _Props, Variables>(fn: ActionHook<Props, Variables & CustomVariables>): void;
2331
+ /**
2332
+ * アクションのライフサイクル close で呼び出されるフックする関数
2333
+ *
2334
+ * @param props - アクションのプロパティ
2335
+ * @param trigger - Close トリガー
2336
+ *
2337
+ * @public
2338
+ */
2339
+ type ActionCloseHook<Props extends _Props, Variables> = (props: Parameters<ActionHook<Props, Variables & CustomVariables>>[0], trigger: CloseTrigger) => void | Promise<void>;
2340
+ /**
2341
+ * アクションがクローズ (close) される前にフックする関数
2342
+ *
2343
+ * @param fn - 呼び出されるフック関数
2344
+ *
2345
+ * @public
2346
+ */
2347
+ function onClose<Props extends _Props, Variables>(fn: ActionCloseHook<Props, Variables & CustomVariables>): void;
2348
+ /**
2349
+ * アクションが破棄 (destroy) される前にフックする関数
2350
+ *
2351
+ * @param fn - 呼び出されるフック関数
2352
+ *
2353
+ * @public
2354
+ */
2355
+ function onDestroy<Props extends _Props, Variables>(fn: ActionHook<Props, Variables & CustomVariables>): void;
2356
+ /**
2357
+ * アクションのライフサイクル changeState で呼び出されるフック関数
2358
+ *
2359
+ * @param props - アクションのプロパティ
2360
+ * @param newState - アクションの新しいステート
2361
+ *
2362
+ * @public
2363
+ */
2364
+ type ActionChangeStateHook<Props extends _Props, Variables> = (props: Parameters<ActionHook<Props, Variables & CustomVariables>>[0], newState: string) => void | Promise<void>;
2365
+ /**
2366
+ * アクションのステートが変更された (changeState) 後にフックする関数
2367
+ *
2368
+ * @param fn - 呼び出されるフック関数
2369
+ *
2370
+ * @public
2371
+ */
2372
+ function onChangeState<Props extends _Props, Variables>(fn: ActionChangeStateHook<Props, Variables & CustomVariables>): void;
2373
+ /**
2374
+ * アクションの send 関数
2375
+ *
2376
+ * @public
2377
+ */
2378
+ type SendFunction = (event_name: string, values?: any) => void;
2379
+ /**
2380
+ * アクションのプロパティ
2381
+ *
2382
+ * @public
2224
2383
  */
2225
2384
  interface ActionProps<Props, Variables> {
2226
- send: (event_name: string, values?: any) => void;
2385
+ /**
2386
+ * アクションでイベントがトリガーされたときに受信するための関数
2387
+ */
2388
+ send: SendFunction;
2389
+ /**
2390
+ * アクションで使用されるデータ
2391
+ */
2227
2392
  data: Props & Variables & CustomVariables;
2228
- onShow?: (props: ActionProps<Props, Variables & CustomVariables>) => void | Promise<void>;
2229
- onChangeState?: (props: ActionProps<Props, Variables & CustomVariables>, newState: string) => void | Promise<void>;
2393
+ /**
2394
+ * アクションが表示されたときにフックされる {@link onShow}
2395
+ */
2396
+ onShow?: ActionHook<Props, Variables & CustomVariables>;
2397
+ /**
2398
+ * アクションのステートが変更されたときにフックされる {@link onChangeState}
2399
+ */
2400
+ onChangeState?: ActionChangeStateHook<Props, Variables & CustomVariables>;
2230
2401
  }
2231
2402
  /**
2232
2403
  * {@link create} 向けのオプション
@@ -2235,37 +2406,37 @@ declare namespace widget {
2235
2406
  */
2236
2407
  interface ActionOptions<Props, Variables> {
2237
2408
  /**
2238
- * KARTE アクションでイベントがトリガーされたときに受信するための関数
2409
+ * アクションでイベントがトリガーされたときに受信するための関数
2239
2410
  *
2240
2411
  * @defaultValue `() => {}`
2241
2412
  */
2242
- send?: (event_name: string, values?: any) => void;
2413
+ send?: SendFunction;
2243
2414
  /**
2244
- * KARTE アクションで使用されるプロパティ
2415
+ * アクションで使用されるプロパティ
2245
2416
  *
2246
2417
  * @defaultValue `{}`
2247
2418
  */
2248
2419
  props?: Props;
2249
2420
  /**
2250
- * KARTE アクションで使用されるアクションテーブルのユーザー環境変数
2421
+ * アクションで使用されるアクションテーブルのユーザー環境変数
2251
2422
  *
2252
2423
  * @defaultValue `{}`
2253
2424
  */
2254
2425
  variables?: Variables;
2255
2426
  /**
2256
- * KARTE アクションでアクションが作成されているときにフックされる {@link onCreate}
2427
+ * アクションが作成されているときにフックされる {@link onCreate}
2257
2428
  *
2258
2429
  * @defaultValue `() => {}`
2259
2430
  */
2260
- onCreate?: (props: ActionProps<Props, Variables & CustomVariables>) => void | Promise<void>;
2431
+ onCreate?: ActionHook<Props, Variables & CustomVariables>;
2261
2432
  }
2262
2433
  /**
2263
- * KARTE アクションを作成する
2434
+ * アクションを作成する
2264
2435
  *
2265
2436
  * @param App - Svelte コンポーネントのエントリポイント
2266
2437
  * @param options - {@link ActionOptions | オプション}
2267
2438
  *
2268
- * @returns KARTE アクションを破棄する関数
2439
+ * @returns アクションを破棄する関数
2269
2440
  *
2270
2441
  * @public
2271
2442
  */
@@ -2277,130 +2448,137 @@ declare namespace widget {
2277
2448
  */
2278
2449
  function dispatchDestroyEvent(): void;
2279
2450
  /**
2280
- * Destory KARTE action
2451
+ * アクションの破棄する
2452
+ *
2453
+ * @public
2281
2454
  */
2282
2455
  function destroy(): void;
2283
2456
  /**
2284
- * Show KARTE action
2457
+ * アクションを表示する
2458
+ *
2459
+ * @public
2285
2460
  */
2286
2461
  function showAction(): void;
2287
2462
  /**
2288
- * Close KARTE action
2463
+ * アクションを閉じる
2464
+ *
2465
+ * @param trigger - 閉じた時のトリガー。デフォルト `'none'`
2466
+ *
2467
+ * @public
2289
2468
  */
2290
2469
  function closeAction(trigger?: CloseTrigger): void;
2470
+ /** @internal */
2291
2471
  const KARTE_ACTION_ROOT = "karte-action-root";
2472
+ /** @internal */
2292
2473
  const KARTE_ACTION_RID = "karte-action-rid";
2474
+ /** @internal */
2293
2475
  const KARTE_ACTION_SHORTEN_ID = "karte-action-id";
2476
+ /** @internal */
2294
2477
  function ensureActionRoot(useShadow?: boolean): ShadowRoot | HTMLElement;
2478
+ /** @internal */
2479
+ const h: (type: string, props: any, ...children: Array<any>) => HTMLElement;
2295
2480
  /**
2296
- * KARTE アクションのライフサイクルで呼び出されるフック
2481
+ * create a fog element
2297
2482
  *
2298
- * @param props - KARTE アクションのプロパティ
2483
+ * @deprecated 非推奨
2299
2484
  *
2300
- * @public
2485
+ * @internal
2301
2486
  */
2302
- type ActionHook<Props extends _Props, Variables> = (props: ActionProps<Props, Variables & CustomVariables>) => void | Promise<void>;
2487
+ function createFog({ color, opacity, zIndex, onclick }: {
2488
+ color?: string;
2489
+ opacity?: string;
2490
+ zIndex?: number;
2491
+ onclick: () => void;
2492
+ }): {
2493
+ fog: HTMLDivElement;
2494
+ close: () => void;
2495
+ };
2496
+ /** @internal */
2497
+ type EmbedLogic = "replace" | "append" | "prepend" | "after" | "before";
2498
+ /** @internal */
2499
+ function embed(target: HTMLElement, replace: HTMLElement, embed_method: EmbedLogic): void;
2303
2500
  /**
2304
- * アクションが作成 (create) される前にフックする
2501
+ * アクションの Shadow Root の Element を取得する
2305
2502
  *
2306
- * @param fn - 呼び出されるフック関数
2503
+ * @returns
2504
+ * アクションが Shadow Root を持つ場合は Shadow Root の Element 返します。ない場合は `null` を返します
2307
2505
  *
2308
2506
  * @public
2309
2507
  */
2310
- function onCreate<Props extends _Props, Variables>(fn: ActionHook<Props, Variables & CustomVariables>): void;
2508
+ function getActionShadowRoot(): ShadowRoot | null;
2311
2509
  /**
2312
- * アクションが表示 (show) された後にフックする
2313
- *
2314
- * @param fn - 呼び出されるフック関数
2510
+ * アクションに CSS を適用する
2315
2511
  *
2316
- * @public
2317
- */
2318
- function onShow<Props extends _Props, Variables>(fn: ActionHook<Props, Variables & CustomVariables>): void;
2319
- /**
2320
- * KARTE アクションのライフサイクル close で呼び出されるフック
2512
+ * @param css - 適用する CSS
2321
2513
  *
2322
- * @param props - KARTE アクションのプロパティ
2323
- * @param trigger - Close トリガー
2514
+ * @returns 適用された style 要素を返す Promise
2324
2515
  *
2325
2516
  * @public
2326
2517
  */
2327
- type ActionCloseHook<Props extends _Props, Variables> = (props: ActionProps<Props, Variables & CustomVariables>, trigger: CloseTrigger) => void | Promise<void>;
2518
+ function applyCss(css: string): Promise<HTMLStyleElement>;
2328
2519
  /**
2329
- * アクションがクローズ (close) される前にフックする
2520
+ * アクションにグローバルなスタイルを読み込む
2330
2521
  *
2331
- * @param fn - 呼び出されるフック関数
2522
+ * @param href - style ファイルのリンク URL
2332
2523
  *
2333
2524
  * @public
2334
2525
  */
2335
- function onClose<Props extends _Props, Variables>(fn: ActionCloseHook<Props, Variables & CustomVariables>): void;
2526
+ function loadStyle(href: string): Promise<void>;
2527
+ // -------- The following codes are deprecated --------
2336
2528
  /**
2337
- * アクションが破棄 (destroy) される前にフックする
2529
+ * 非推奨です
2338
2530
  *
2339
- * @param fn - 呼び出されるフック関数
2531
+ * @deprecated 非推奨
2340
2532
  *
2341
- * @public
2533
+ * @internal
2342
2534
  */
2343
- function onDestroy<Props extends _Props, Variables>(fn: ActionHook<Props, Variables & CustomVariables>): void;
2535
+ const showModal: typeof create;
2344
2536
  /**
2345
- * KARTE アクションのライフサイクル changeState で呼び出されるフック関数
2537
+ * 非推奨です
2346
2538
  *
2347
- * @param props - KARTE アクションのプロパティ
2348
- * @param newState - KARTE アクションの新しいステート
2539
+ * @deprecated 非推奨
2349
2540
  *
2350
- * @public
2541
+ * @internal
2351
2542
  */
2352
- type ActionChangeStateHook<Props extends _Props, Variables> = (props: ActionProps<Props, Variables & CustomVariables>, newState: string) => void | Promise<void>;
2543
+ type ModalOptions<Props, Variables> = ActionOptions<Props, Variables>;
2353
2544
  /**
2354
- * アクションのステートが変更された (changeState) 後にフックする
2545
+ * 非推奨です
2355
2546
  *
2356
- * @param fn - 呼び出されるフック関数
2547
+ * @deprecated 非推奨
2357
2548
  *
2358
- * @public
2549
+ * @internal
2359
2550
  */
2360
- function onChangeState<Props extends _Props, Variables>(fn: ActionChangeStateHook<Props, Variables & CustomVariables>): void;
2361
- const h: (type: string, props: any, ...children: Array<any>) => HTMLElement;
2551
+ const KARTE_MODAL_ROOT = "karte-modal-root";
2362
2552
  /**
2363
- * create a fog element
2553
+ * 非推奨です
2364
2554
  *
2365
2555
  * @deprecated 非推奨
2556
+ *
2557
+ * @internal
2366
2558
  */
2367
- function createFog({ color, opacity, zIndex, onclick }: {
2368
- color?: string;
2369
- opacity?: string;
2370
- zIndex?: number;
2371
- onclick: () => void;
2372
- }): {
2373
- fog: HTMLDivElement;
2374
- close: () => void;
2375
- };
2376
- type EmbedLogic = "replace" | "append" | "prepend" | "after" | "before";
2377
- function embed(target: HTMLElement, replace: HTMLElement, embed_method: EmbedLogic): void;
2378
- function getActionShadowRoot(): ShadowRoot | null;
2559
+ const ensureModalRoot: typeof ensureActionRoot;
2379
2560
  /**
2380
- * KARTE アクションに CSS を適用する
2561
+ * 非推奨です
2381
2562
  *
2382
- * @param css - 適用する CSS
2563
+ * @deprecated 非推奨
2383
2564
  *
2384
- * @returns 適用された style 要素を返す Promise
2565
+ * @internal
2385
2566
  */
2386
- function applyCss(css: string): Promise<HTMLStyleElement>;
2567
+ const show: typeof showAction;
2387
2568
  /**
2388
- * KARTE アクションにグローバルなスタイルをロードする
2569
+ * 非推奨です
2570
+ *
2571
+ * @deprecated 非推奨
2389
2572
  *
2390
- * @param href - style ファイルのリンク先 URL
2573
+ * @internal
2391
2574
  */
2392
- function loadStyle(href: string): Promise<void>;
2393
- // -------- The following codes are deprecated --------
2394
- const showModal: typeof create; // @deprecated
2395
- type ModalOptions<Props, Variables> = ActionOptions<Props, Variables>; // @deprecated
2396
- const KARTE_MODAL_ROOT = "karte-modal-root"; // @deprecated
2397
- const ensureModalRoot: typeof ensureActionRoot; // @deprecated
2398
- const show: typeof showAction; // deprecated
2399
- const close: typeof closeAction; // deprecated
2575
+ const close: typeof closeAction;
2400
2576
  /**
2401
2577
  * An options for {@link createApp}
2402
2578
  *
2403
2579
  * @deprecated 非推奨
2580
+ *
2581
+ * @internal
2404
2582
  */
2405
2583
  type AppOptions<Props, Variables> = ActionOptions<Props, Variables>;
2406
2584
  /**
@@ -2409,6 +2587,8 @@ declare namespace widget {
2409
2587
  * @remarks Currently, svelte component is supported only.
2410
2588
  *
2411
2589
  * @deprecated 非推奨
2590
+ *
2591
+ * @internal
2412
2592
  */
2413
2593
  interface App {
2414
2594
  /**
@@ -2429,6 +2609,8 @@ declare namespace widget {
2429
2609
  * @returns A function to close the modal
2430
2610
  *
2431
2611
  * @deprecated 非推奨
2612
+ *
2613
+ * @internal
2432
2614
  */
2433
2615
  function createApp<Props, Variables>(App: typeof SvelteComponentDev, options?: AppOptions<Props, Variables>): App;
2434
2616
  // @ts-ignore
@@ -2577,7 +2759,8 @@ declare namespace widget {
2577
2759
  */
2578
2760
  export { showAction as show, closeAction as hide };
2579
2761
  }
2580
- export { CloseTrigger, ALL_ACTION_ID, ALL_ACTION_SHORTEN_ID, actionId, ACTION_SHOW_EVENT, ACTION_CLOSE_EVENT, ACTION_DESTROY_EVENT, ACTION_CHANGE_STATE_EVENT, handleState, initialize, finalize, send_event, none, moveTo, linkTo, closeApp, runScript, execOnClickOperation, haveFunction, customAnimation, loadGlobalScript, applyGlobalCss, loadGlobalStyle, hashCode, setAutoStart, Store, getStoreState, SystemConfig, ActionEventHandler, ActionSetting, CustomVariables, actionSetting, getActionSetting, setActionSetting, resetActionSetting, system, getSystem, setSystem, state, setState, getState, states, addState, getStates, opened, isOpened, setOpened, closed, isClosed, setClosed, maximumZindex, setMaximumZindex, internalHandlers, getInternalHandlers, setInternalHandlers, updateInternalHandlers, customHandlers, getCustomHandlers, setCustomHandlers, updateCustomHandlers, destroyed, isDestroyed, setDestroyed, stopped, isStopped, setStopped, customVariables, getCustomVariables, setCustomVariables, updateCustomVariables, FormData, formData, NOOP, isPreview, handleFocus, setPreviousFocus, handleKeydown, getPositionStyle, getTransform, getMarginStyle, ScrollDirection, OnScrollContext, OnScrollFunction, onScroll, onTime, hasSuffix, toBr, randStr, PropTypes, PropType, Code, MediaQueries, MediaQuery, Directions, Direction, AnimationStyles, AnimationStyle, ModalPositions, ModalPosition, ModalMargin, ModalPlacement, DefaultModalPlacement, Elasticities, Elasticity, ElasticityStyle, TextDirections, TextDirection, OperationArgumentType, Operation, OnClickOperationOptions, OnClickOperation, FormOperationOptions, FormOperation, LongText, Url, Image, LengthUnits, LengthUnit, Length, Color, Justifies, Justify, Alignments, Alignment, ObjectFits, ObjectFit, ClipPaths, ClipPath, Repeats, Repeat, BackgroundSizes, BackgroundSize, Cursors, Cursor, Overflows, Overflow, Border, BorderStyle, BorderWidth, Style, StateName, WritingModes, WritingMode, ListSeparatorTypes, ListSeparatorNone, ListSeparatorBorder, ListSeparatorGap, ListSeparator, DefaultListSeparatorNone, DefaultListSeparatorBorder, DefaultListSeparatorGap, DefaultListSeparator, ListBackgroundTypes, ListBackgroundNone, ListBackgroundStripe, ListBackground, DefaultListBackgroundNone, DefaultListBackgroundStripe, DefaultListBackground, ListDirections, ListDirection, ListContext, hideOnScroll, hideOnTime, showOnScroll, showOnTime, ActionProps, ActionOptions, create, dispatchDestroyEvent, destroy, showAction, closeAction, KARTE_ACTION_ROOT, KARTE_ACTION_RID, KARTE_ACTION_SHORTEN_ID, ensureActionRoot, ActionHook, onCreate, onShow, ActionCloseHook, onClose, onDestroy, ActionChangeStateHook, onChangeState, h, createFog, EmbedLogic, embed, getActionShadowRoot, applyCss, loadStyle, showModal, ModalOptions, KARTE_MODAL_ROOT, ensureModalRoot, show, close, AppOptions, App, createApp, collection, widget };
2762
+ export { loadGlobalScript, loadGlobalStyle, applyGlobalCss, initialize, finalize, setAutoStart, getState, setState, getStates, isOpened, getCustomVariables, setCustomVariables, updateCustomVariables, getCustomHandlers, setCustomHandlers, updateCustomHandlers, getSystem, setActionSetting, customHandlers, customVariables, formData, state, opened, closed, destroyed, stopped, isClosed, setClosed, getStoreState, onScroll, onTime, hideOnScroll, hideOnTime, showOnScroll, showOnTime, PropTypes, PropType, Code, MediaQueries, MediaQuery, Directions, Direction, AnimationStyles, AnimationStyle, ModalPositions, ModalPosition, ModalMargin, ModalPlacement, DefaultModalPlacement, Elasticities, Elasticity, ElasticityStyle, TextDirections, TextDirection, OperationArgumentType, Operation, OnClickOperationOptions, OnClickOperation, FormOperationOptions, FormOperation, LongText, Url, Image, LengthUnits, LengthUnit, Length, Color, Justifies, Justify, Alignments, Alignment, ObjectFits, ObjectFit, ClipPaths, ClipPath, Repeats, Repeat, BackgroundSizes, BackgroundSize, Cursors, Cursor, Overflows, Overflow, Border, BorderStyle, BorderWidth, Style, StateName, WritingModes, WritingMode, ListSeparatorTypes, ListSeparatorNone, ListSeparatorBorder, ListSeparatorGap, ListSeparator, DefaultListSeparatorNone, DefaultListSeparatorBorder, DefaultListSeparatorGap, DefaultListSeparator, ListBackgroundTypes, ListBackgroundNone, ListBackgroundStripe, ListBackground, DefaultListBackgroundNone, DefaultListBackgroundStripe, DefaultListBackground, ListDirections, ListDirection, ListContext, SliderButtonIcon, SliderButtonText, SliderButton, DefaultSliderButton, SliderButtonPosition, SliderNavigationButton, DefaultSliderNavigationButton, create, destroy, closeAction, showAction, loadStyle, applyCss, getActionShadowRoot, onCreate, onShow, onClose, onDestroy, onChangeState, showModal, ensureModalRoot, show, close, createApp, createFog, KARTE_MODAL_ROOT, collection, widget };
2763
+ export type { CloseTrigger, CustomVariables, ActionEventHandler, SystemConfig, OnScrollContext, OnScrollFunction, ScrollDirection, ActionProps, ActionOptions, ActionHook, ActionCloseHook, ActionChangeStateHook, SendFunction, CollectionConfig };
2581
2764
  export { default as State } from './components/State.svelte';
2582
2765
  export { default as StateItem } from './components/StateItem.svelte';
2583
2766
  export { default as Modal } from './components/Modal.svelte';