commandbar 1.6.9 → 1.6.10

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,5 +1,6 @@
1
1
  /*******************************************************************************/
2
2
  import * as t from 'io-ts';
3
+ import { GenericBatchRequest } from './generics';
3
4
  export declare const CommandCategoryV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
4
5
  id: t.NumberC;
5
6
  organization: t.UnionC<[t.NumberC, t.StringC]>;
@@ -14,7 +15,26 @@ export declare const CommandCategoryV: t.IntersectionC<[t.IntersectionC<[t.TypeC
14
15
  search_tab_enabled: t.BooleanC;
15
16
  search_tab_name: t.StringC;
16
17
  search_tab_instruction: t.StringC;
18
+ track_recents: t.BooleanC;
17
19
  }>]>;
20
+ export declare const BatchEditorCategoryResponseV: t.TypeC<{
21
+ batch: t.ArrayC<t.IntersectionC<[t.IntersectionC<[t.TypeC<{
22
+ id: t.NumberC;
23
+ organization: t.UnionC<[t.NumberC, t.StringC]>;
24
+ name: t.StringC;
25
+ }>, t.PartialC<{}>]>, t.TypeC<{
26
+ sort_key: t.UnionC<[t.NumberC, t.NullC]>;
27
+ icon: t.UnionC<[t.StringC, t.NullC]>;
28
+ render_as: t.UnionC<[t.LiteralC<"list">, t.LiteralC<"grid">]>;
29
+ setting_hide_before_search: t.BooleanC;
30
+ setting_max_options_count: t.UnionC<[t.NumberC, t.NullC]>;
31
+ setting_pin_to_bottom: t.BooleanC;
32
+ search_tab_enabled: t.BooleanC;
33
+ search_tab_name: t.StringC;
34
+ search_tab_instruction: t.StringC;
35
+ track_recents: t.BooleanC;
36
+ }>]>>;
37
+ }>;
18
38
  export declare class CommandCategory {
19
39
  static create: (object: {
20
40
  id: number;
@@ -30,6 +50,7 @@ export declare class CommandCategory {
30
50
  search_tab_enabled: boolean;
31
51
  search_tab_name: string;
32
52
  search_tab_instruction: string;
53
+ track_recents: boolean;
33
54
  }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
34
55
  id: number;
35
56
  organization: string | number;
@@ -44,6 +65,7 @@ export declare class CommandCategory {
44
65
  search_tab_enabled: boolean;
45
66
  search_tab_name: string;
46
67
  search_tab_instruction: string;
68
+ track_recents: boolean;
47
69
  }>;
48
70
  static update: (object: {
49
71
  id: number;
@@ -59,6 +81,7 @@ export declare class CommandCategory {
59
81
  search_tab_enabled: boolean;
60
82
  search_tab_name: string;
61
83
  search_tab_instruction: string;
84
+ track_recents: boolean;
62
85
  }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
63
86
  id: number;
64
87
  organization: string | number;
@@ -73,6 +96,7 @@ export declare class CommandCategory {
73
96
  search_tab_enabled: boolean;
74
97
  search_tab_name: string;
75
98
  search_tab_instruction: string;
99
+ track_recents: boolean;
76
100
  }>;
77
101
  static delete: (id: string | number, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<void>;
78
102
  static decode: (data: any) => {
@@ -89,5 +113,24 @@ export declare class CommandCategory {
89
113
  search_tab_enabled: boolean;
90
114
  search_tab_name: string;
91
115
  search_tab_instruction: string;
116
+ track_recents: boolean;
92
117
  };
118
+ static batch: (request: t.TypeOf<typeof GenericBatchRequest>) => Promise<{
119
+ batch: ({
120
+ id: number;
121
+ organization: string | number;
122
+ name: string;
123
+ } & {} & {
124
+ sort_key: number | null;
125
+ icon: string | null;
126
+ render_as: "grid" | "list";
127
+ setting_hide_before_search: boolean;
128
+ setting_max_options_count: number | null;
129
+ setting_pin_to_bottom: boolean;
130
+ search_tab_enabled: boolean;
131
+ search_tab_name: string;
132
+ search_tab_instruction: string;
133
+ track_recents: boolean;
134
+ })[];
135
+ }>;
93
136
  }
@@ -1,7 +1,7 @@
1
1
  /*******************************************************************************/
2
2
  import * as t from 'io-ts';
3
3
  export declare const DetailPreviewObjectV: t.TypeC<{
4
- type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"reader">, t.LiteralC<"react">]>;
4
+ type: t.UnionC<[t.LiteralC<"plaintext">, t.LiteralC<"markdown">, t.LiteralC<"html">, t.LiteralC<"react">, t.LiteralC<"video">, t.NullC]>;
5
5
  value: t.StringC;
6
6
  }>;
7
7
  export declare type DetailPreviewObjectType = t.TypeOf<typeof DetailPreviewObjectV>;
@@ -14,4 +14,8 @@ export declare type DataRowMedata = {
14
14
  uid?: string;
15
15
  };
16
16
  export declare const DEFAULT_DETAIL_PREVIEW_TYPE: DetailPreviewObjectType['type'];
17
- export declare const standardize: (item: undefined | null | DetailPreviewType) => undefined | DetailPreviewObjectType[];
17
+ export declare const standardize: (item: undefined | null | DetailPreviewType) => null | DetailPreviewObjectType[];
18
+ export declare const getFirstDetail: (detail?: DetailPreviewType | null | undefined) => DetailPreviewObjectType | {
19
+ type: null;
20
+ value: null;
21
+ };
@@ -5,6 +5,10 @@ declare const GenericObject: t.TypeC<{
5
5
  id: t.UnionC<[t.NumberC, t.StringC]>;
6
6
  }>;
7
7
  export declare type GenericObjectType = t.TypeOf<typeof GenericObject>;
8
+ export declare const GenericBatchRequest: t.TypeC<{
9
+ batch: t.ArrayC<t.UnknownC>;
10
+ note: t.StringC;
11
+ }>;
8
12
  declare function createObject<T, Q, O, I>(output: t.Type<T, O, I>, input: t.Type<Q, O, I>, url: string, params?: Record<string, string>): (object: Q, onSuccess?: () => void, onError?: (err: string) => void) => Promise<T>;
9
13
  declare function readObject<T, O, I>(arg: t.Type<T, O, I>, url: string): (arg0: string, params?: Record<string, string>, callbacks?: {
10
14
  onSuccess?: () => void;
@@ -0,0 +1,66 @@
1
+ import * as t from 'io-ts';
2
+ export declare const HelpDocsIntegrationV: t.IntersectionC<[t.TypeC<{
3
+ id: t.NumberC;
4
+ organization: t.StringC;
5
+ type: t.StringC;
6
+ schedule: t.StringC;
7
+ meta: t.UnionC<[t.RecordC<t.StringC, t.AnyC>, t.NullC]>;
8
+ }>, t.PartialC<{}>]>;
9
+ export declare class HelpDocsIntegration {
10
+ static create: (object: {
11
+ id: number;
12
+ organization: string;
13
+ type: string;
14
+ schedule: string;
15
+ meta: {
16
+ [x: string]: any;
17
+ } | null;
18
+ } & {}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
19
+ id: number;
20
+ organization: string;
21
+ type: string;
22
+ schedule: string;
23
+ meta: {
24
+ [x: string]: any;
25
+ } | null;
26
+ } & {}>;
27
+ static read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
28
+ onSuccess?: (() => void) | undefined;
29
+ onError?: ((err: string) => void) | undefined;
30
+ } | undefined) => Promise<{
31
+ id: number;
32
+ organization: string;
33
+ type: string;
34
+ schedule: string;
35
+ meta: {
36
+ [x: string]: any;
37
+ } | null;
38
+ } & {}>;
39
+ static list: (onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<({
40
+ id: number;
41
+ organization: string;
42
+ type: string;
43
+ schedule: string;
44
+ meta: {
45
+ [x: string]: any;
46
+ } | null;
47
+ } & {})[]>;
48
+ static update: (object: {
49
+ id: number;
50
+ organization: string;
51
+ type: string;
52
+ schedule: string;
53
+ meta: {
54
+ [x: string]: any;
55
+ } | null;
56
+ } & {}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
57
+ id: number;
58
+ organization: string;
59
+ type: string;
60
+ schedule: string;
61
+ meta: {
62
+ [x: string]: any;
63
+ } | null;
64
+ } & {}>;
65
+ static delete: (id: string | number, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<void>;
66
+ }
@@ -0,0 +1,42 @@
1
+ import * as t from 'io-ts';
2
+ export declare const HelpDocsSyncV: t.IntersectionC<[t.TypeC<{
3
+ id: t.NumberC;
4
+ integration: t.NumberC;
5
+ scheduled: t.BooleanC;
6
+ }>, t.PartialC<{
7
+ commands: t.ArrayC<t.NumberC>;
8
+ started: t.StringC;
9
+ ended: t.StringC;
10
+ log: t.ArrayC<t.ArrayC<t.AnyC>>;
11
+ }>]>;
12
+ export declare class HelpDocsSync {
13
+ static create: (object: {
14
+ id: number;
15
+ integration: number;
16
+ scheduled: boolean;
17
+ } & {
18
+ commands?: number[] | undefined;
19
+ started?: string | undefined;
20
+ ended?: string | undefined;
21
+ log?: any[][] | undefined;
22
+ }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
23
+ id: number;
24
+ integration: number;
25
+ scheduled: boolean;
26
+ } & {
27
+ commands?: number[] | undefined;
28
+ started?: string | undefined;
29
+ ended?: string | undefined;
30
+ log?: any[][] | undefined;
31
+ }>;
32
+ static list: (onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<({
33
+ id: number;
34
+ integration: number;
35
+ scheduled: boolean;
36
+ } & {
37
+ commands?: number[] | undefined;
38
+ started?: string | undefined;
39
+ ended?: string | undefined;
40
+ log?: any[][] | undefined;
41
+ })[]>;
42
+ }
@@ -32,6 +32,8 @@ export declare const OrganizationSettingsV: t.TypeC<{
32
32
  in_bar_feedback: t.BooleanC;
33
33
  summon_hotkey_override: t.UnionC<[t.StringC, t.NullC]>;
34
34
  end_user_shortcuts_enabled: t.BooleanC;
35
+ fallback_commands: t.ArrayC<t.NumberC>;
36
+ end_user_recents_enabled: t.BooleanC;
35
37
  }>;
36
38
  export declare class Organization {
37
39
  static read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
@@ -78,6 +80,7 @@ export declare class Organization {
78
80
  search_tab_name?: string | null | undefined;
79
81
  search_tab_instruction?: string | null | undefined;
80
82
  setting_pin_to_bottom?: boolean | undefined;
83
+ track_recents?: boolean | undefined;
81
84
  };
82
85
  };
83
86
  should_show_onboarding: boolean;
@@ -92,8 +95,11 @@ export declare class Organization {
92
95
  summon_hotkey_override: string | null;
93
96
  end_user_hotkeys: boolean | undefined;
94
97
  end_user_shortcuts_enabled: boolean;
98
+ end_user_recents_enabled: boolean;
95
99
  releases_available: boolean;
96
100
  releases_enabled: boolean;
101
+ fallback_commands: number[];
102
+ tab_direction: "horizontal" | "vertical";
97
103
  }>;
98
104
  static update: (object: {
99
105
  id: string | number;
@@ -136,6 +142,7 @@ export declare class Organization {
136
142
  search_tab_name?: string | null | undefined;
137
143
  search_tab_instruction?: string | null | undefined;
138
144
  setting_pin_to_bottom?: boolean | undefined;
145
+ track_recents?: boolean | undefined;
139
146
  };
140
147
  };
141
148
  should_show_onboarding: boolean;
@@ -150,8 +157,11 @@ export declare class Organization {
150
157
  summon_hotkey_override: string | null;
151
158
  end_user_hotkeys: boolean | undefined;
152
159
  end_user_shortcuts_enabled: boolean;
160
+ end_user_recents_enabled: boolean;
153
161
  releases_available: boolean;
154
162
  releases_enabled: boolean;
163
+ fallback_commands: number[];
164
+ tab_direction: "horizontal" | "vertical";
155
165
  }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
156
166
  id: string | number;
157
167
  name: string;
@@ -193,6 +203,7 @@ export declare class Organization {
193
203
  search_tab_name?: string | null | undefined;
194
204
  search_tab_instruction?: string | null | undefined;
195
205
  setting_pin_to_bottom?: boolean | undefined;
206
+ track_recents?: boolean | undefined;
196
207
  };
197
208
  };
198
209
  should_show_onboarding: boolean;
@@ -207,8 +218,11 @@ export declare class Organization {
207
218
  summon_hotkey_override: string | null;
208
219
  end_user_hotkeys: boolean | undefined;
209
220
  end_user_shortcuts_enabled: boolean;
221
+ end_user_recents_enabled: boolean;
210
222
  releases_available: boolean;
211
223
  releases_enabled: boolean;
224
+ fallback_commands: number[];
225
+ tab_direction: "horizontal" | "vertical";
212
226
  }>;
213
227
  static listCommands: (orgUID: string) => Promise<({
214
228
  id: number;
@@ -239,7 +253,7 @@ export declare class Organization {
239
253
  hoverTooltip?: boolean | undefined;
240
254
  operation?: "self" | "router" | "blank" | undefined;
241
255
  }) | ({
242
- type: "click" | "clickBySelector" | "clickByXpath";
256
+ type: "click" | "clickByXpath" | "clickBySelector";
243
257
  value: string[];
244
258
  } & {} & {
245
259
  commandType?: "object" | "independent" | "help" | undefined;
@@ -306,13 +320,6 @@ export declare class Organization {
306
320
  name?: string | undefined;
307
321
  last_available?: string | null | undefined;
308
322
  modified?: string | undefined;
309
- detail?: string | {
310
- type: "html" | "plaintext" | "markdown" | "reader" | "react";
311
- value: string;
312
- } | {
313
- type: "html" | "plaintext" | "markdown" | "reader" | "react";
314
- value: string;
315
- }[] | undefined;
316
323
  } & {
317
324
  arguments: {
318
325
  [x: string]: ({
@@ -467,6 +474,13 @@ export declare class Organization {
467
474
  shortcut_win: string[];
468
475
  hotkey_mac: string;
469
476
  hotkey_win: string;
477
+ detail: string | {
478
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
479
+ value: string;
480
+ } | (string | {
481
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
482
+ value: string;
483
+ })[] | null;
470
484
  })[]>;
471
485
  static listCommandCategories: (orgUID: string) => Promise<({
472
486
  id: number;
@@ -482,6 +496,7 @@ export declare class Organization {
482
496
  search_tab_enabled: boolean;
483
497
  search_tab_name: string;
484
498
  search_tab_instruction: string;
499
+ track_recents: boolean;
485
500
  })[]>;
486
501
  static listGuides: (orgUID: string) => Promise<({
487
502
  id: number;
@@ -583,6 +598,8 @@ export declare class Organization {
583
598
  in_bar_feedback: boolean;
584
599
  summon_hotkey_override: string | null;
585
600
  end_user_shortcuts_enabled: boolean;
601
+ fallback_commands: number[];
602
+ end_user_recents_enabled: boolean;
586
603
  }>;
587
604
  static updateSetting: (object: {
588
605
  end_user_limit?: number | undefined;
@@ -602,6 +619,8 @@ export declare class Organization {
602
619
  in_bar_feedback?: boolean | undefined;
603
620
  summon_hotkey_override?: string | null | undefined;
604
621
  end_user_shortcuts_enabled?: boolean | undefined;
622
+ fallback_commands?: number[] | undefined;
623
+ end_user_recents_enabled?: boolean | undefined;
605
624
  }, params?: Record<string, string> | undefined, callbacks?: {
606
625
  onSuccess?: (() => void) | undefined;
607
626
  onError?: ((err: string) => void) | undefined;
@@ -623,6 +642,8 @@ export declare class Organization {
623
642
  in_bar_feedback: boolean;
624
643
  summon_hotkey_override: string | null;
625
644
  end_user_shortcuts_enabled: boolean;
645
+ fallback_commands: number[];
646
+ end_user_recents_enabled: boolean;
626
647
  }>;
627
648
  static decode: (data: any) => {
628
649
  id: string | number;
@@ -665,6 +686,7 @@ export declare class Organization {
665
686
  search_tab_name?: string | null | undefined;
666
687
  search_tab_instruction?: string | null | undefined;
667
688
  setting_pin_to_bottom?: boolean | undefined;
689
+ track_recents?: boolean | undefined;
668
690
  };
669
691
  };
670
692
  should_show_onboarding: boolean;
@@ -679,7 +701,10 @@ export declare class Organization {
679
701
  summon_hotkey_override: string | null;
680
702
  end_user_hotkeys: boolean | undefined;
681
703
  end_user_shortcuts_enabled: boolean;
704
+ end_user_recents_enabled: boolean;
682
705
  releases_available: boolean;
683
706
  releases_enabled: boolean;
707
+ fallback_commands: number[];
708
+ tab_direction: "horizontal" | "vertical";
684
709
  };
685
710
  }
@@ -1,7 +1,8 @@
1
1
  /*******************************************************************************/
2
2
  import * as t from 'io-ts';
3
- import { BatchEditorCommandRequestV, BatchEditorCommandResponseV, BatchOperationV, CommandV, EditorCommandV } from './command';
3
+ import { BatchEditorCommandResponseV, BatchOperationV, CommandV, HelpSyncCommandV, EditorCommandV } from './command';
4
4
  import { ArgumentMapV, ArgumentTypeV, ConditionV, ConditionOperatorV, StepArgumentTypeV, ContextArgumentV, SetArgumentV, DynamicArgumentV, DependentArgumentV, FunctionArgumentV } from './helpers/argument';
5
+ import { GenericBatchRequest } from './generics';
5
6
  import { OptionGroupRenderAsV } from './helpers/optionGroup';
6
7
  import { TemplateV, TemplateOptionsV, RequestTemplateV, RequestV } from './helpers/commandTemplate';
7
8
  import { CommandCategoryV } from './commandCategory';
@@ -10,6 +11,8 @@ import { UserV } from './user';
10
11
  import { ContextV } from './context';
11
12
  import { GuideV } from './guide';
12
13
  import { HistoryEventV } from './historyEvent';
14
+ import { HelpDocsSyncV } from './helpDocsSync';
15
+ import { HelpDocsIntegrationV } from './helpDocsIntegration';
13
16
  import { EndUserV } from './helpers/endUser';
14
17
  import { SkinV } from './skin';
15
18
  import { ProfileV } from './profile';
@@ -21,12 +24,15 @@ export declare type IContextType = t.TypeOf<typeof ContextV>;
21
24
  export declare type IUserType = t.TypeOf<typeof UserV>;
22
25
  export declare type ICommandType = t.TypeOf<typeof CommandV>;
23
26
  export declare type IEditorCommandType = t.TypeOf<typeof EditorCommandV>;
27
+ export declare type IHelpSyncCommandType = t.TypeOf<typeof HelpSyncCommandV>;
24
28
  export type { ICommandFromClientType } from './ICommandFromClientType';
25
29
  export declare type ICommandCategoryType = t.TypeOf<typeof CommandCategoryV>;
26
30
  export declare type IGuideType = t.TypeOf<typeof GuideV> & {
27
31
  preview?: boolean;
28
32
  };
29
33
  export declare type IHistoryEventType = t.TypeOf<typeof HistoryEventV>;
34
+ export declare type IHelpDocsSyncType = t.TypeOf<typeof HelpDocsSyncV>;
35
+ export declare type IHelpDocsIntegrationType = t.TypeOf<typeof HelpDocsIntegrationV>;
30
36
  export type { IOrganizationType } from './OrganizationV';
31
37
  export declare type IOrganizationStatusType = t.TypeOf<typeof OrganizationStatusV>;
32
38
  export declare type IInternalSettingsType = t.TypeOf<typeof InternalSettingsV>;
@@ -40,7 +46,7 @@ export declare type IRelease = t.TypeOf<typeof ReleaseV>;
40
46
  export declare type IEnvReleaseInfo = t.TypeOf<typeof EnvReleaseInfoV>;
41
47
  /*******************************************************************************/
42
48
  export declare type IBatchOperation = t.TypeOf<typeof BatchOperationV>;
43
- export declare type IBatchEditorCommandRequst = t.TypeOf<typeof BatchEditorCommandRequestV>;
49
+ export declare type IBatchEditorCommandRequst = t.TypeOf<typeof GenericBatchRequest>;
44
50
  export declare type IBatchEditorCommandResponse = t.TypeOf<typeof BatchEditorCommandResponseV>;
45
51
  /*******************************************************************************/
46
52
  export declare type IKeyEventCategory = t.TypeOf<typeof KeyEventV>;
@@ -124,7 +130,7 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
124
130
  hoverTooltip?: boolean | undefined;
125
131
  operation?: "self" | "router" | "blank" | undefined;
126
132
  }) | ({
127
- type: "click" | "clickBySelector" | "clickByXpath";
133
+ type: "click" | "clickByXpath" | "clickBySelector";
128
134
  value: string[];
129
135
  } & {} & {
130
136
  commandType?: "object" | "independent" | "help" | undefined;
@@ -191,13 +197,6 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
191
197
  name?: string | undefined;
192
198
  last_available?: string | null | undefined;
193
199
  modified?: string | undefined;
194
- detail?: string | {
195
- type: "html" | "plaintext" | "markdown" | "reader" | "react";
196
- value: string;
197
- } | {
198
- type: "html" | "plaintext" | "markdown" | "reader" | "react";
199
- value: string;
200
- }[] | undefined;
201
200
  } & {
202
201
  arguments: {
203
202
  [x: string]: ({
@@ -352,6 +351,13 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
352
351
  shortcut_win: string[];
353
352
  hotkey_mac: string;
354
353
  hotkey_win: string;
354
+ detail: string | {
355
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
356
+ value: string;
357
+ } | (string | {
358
+ type: "html" | "video" | "plaintext" | "markdown" | "react" | null;
359
+ value: string;
360
+ })[] | null;
355
361
  };
356
362
  export declare const isResource: (option: any) => option is IResourceType;
357
363
  export declare const isContextArgument: (argument: IArgumentType) => argument is {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "commandbar",
3
- "version": "1.6.9",
3
+ "version": "1.6.10",
4
4
  "description": "Javascript Utility for CommandBar",
5
5
  "main": "build/commandbar-js/src/index.js",
6
6
  "types": "build/commandbar-js/src/index.d.ts",