@combeenation/custom-code-sdk 0.0.1-alpha2 → 0.0.1-alpha3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -1,13 +1,13 @@
1
1
  import { z } from 'zod';
2
2
 
3
- export declare class Button<TName extends CtrlId = CtrlId> {
3
+ export declare class Button {
4
4
  #private;
5
- readonly name: TName;
5
+ readonly id: CtrlId;
6
6
  readonly sdkBridgeVersion = "v1";
7
- constructor(name: TName);
7
+ constructor(id: CtrlId);
8
8
  onRendered(callback: OnRenderedCallback<HTMLButtonElement>): CallbackUnsubscribeOption;
9
9
  onClick(callback: OnClickCallback): CallbackUnsubscribeOption;
10
- setVisible(visible: boolean): void;
10
+ setVisible(visible: boolean): Promise<void>;
11
11
  setText(text: string): void;
12
12
  }
13
13
 
@@ -33,13 +33,13 @@ declare interface CfgrClientApi_v1 {
33
33
  onCmpValueChanged<TValue extends CmpValue_2>(cmpName: CmpName_2, listener: CmpValueChangedListener_2<TValue>, condition?: CmpValueChangedCondition_2<TValue>, callImmediately?: boolean): Promise<void>;
34
34
  }
35
35
 
36
- export declare class Checkbox<TName extends CtrlId = CtrlId> {
36
+ export declare class Checkbox {
37
37
  #private;
38
- readonly name: TName;
38
+ readonly id: CtrlId;
39
39
  readonly sdkBridgeVersion = "v1";
40
- constructor(name: TName);
40
+ constructor(id: CtrlId);
41
41
  onRendered(callback: OnRenderedCallback<HTMLLabelElement>): CallbackUnsubscribeOption;
42
- setVisible(visible: boolean): void;
42
+ setVisible(visible: boolean): Promise<void>;
43
43
  }
44
44
 
45
45
  declare const client: CfgrClientApi_v1 | undefined;
@@ -76,46 +76,46 @@ declare interface CmpValuesChangedListener<TName extends string = string> {
76
76
  (changedCmps: CmpValueChangedMap<TName>): void;
77
77
  }
78
78
 
79
- export declare class Collapsible<TName extends CtrlId = CtrlId> {
79
+ export declare class Collapsible {
80
80
  #private;
81
- readonly name: TName;
81
+ readonly id: CtrlId;
82
82
  readonly sdkBridgeVersion = "v1";
83
- constructor(name: TName);
83
+ constructor(id: CtrlId);
84
84
  onRendered(callback: OnRenderedCallback<HTMLDivElement>): CallbackUnsubscribeOption;
85
- setVisible(visible: boolean): void;
85
+ setVisible(visible: boolean): Promise<void>;
86
86
  }
87
87
 
88
88
  declare type CtrlId = z.infer<typeof ZCtrlId>;
89
89
 
90
- export declare class CustomControl<TName extends CtrlId = CtrlId> {
90
+ export declare class CustomControl {
91
91
  #private;
92
- readonly name: TName;
92
+ readonly id: CtrlId;
93
93
  readonly sdkBridgeVersion = "v1";
94
- constructor(name: TName);
95
- set render(callback: CustomCtrlRenderCallback);
94
+ constructor(id: CtrlId);
95
+ set renderFn(callback: CustomCtrlRenderFn);
96
+ render(): Promise<void>;
96
97
  getElement(): HTMLElement | undefined;
97
- setVisible(visible: boolean): void;
98
+ setVisible(visible: boolean): Promise<void>;
98
99
  }
99
100
 
100
- /** See {@link useCustomCodeSdkBridgeStoreBase} for details about `render` & `onRendered` callbacks */
101
- declare type CustomCtrlRenderCallback = (element: HTMLDivElement, rawHtml: string | undefined) => void;
101
+ declare type CustomCtrlRenderFn = (element: HTMLDivElement, rawHtml: string | undefined) => void | Promise<void>;
102
102
 
103
- export declare class Dataview<TName extends CtrlId = CtrlId> {
103
+ export declare class Dataview {
104
104
  #private;
105
- readonly name: TName;
105
+ readonly id: CtrlId;
106
106
  readonly sdkBridgeVersion = "v1";
107
- constructor(name: TName);
107
+ constructor(id: CtrlId);
108
108
  onRendered(callback: OnRenderedCallback<HTMLDivElement>): CallbackUnsubscribeOption;
109
- setVisible(visible: boolean): void;
109
+ setVisible(visible: boolean): Promise<void>;
110
110
  }
111
111
 
112
- export declare class Input<TName extends CtrlId = CtrlId> {
112
+ export declare class Input {
113
113
  #private;
114
- readonly name: TName;
114
+ readonly id: CtrlId;
115
115
  readonly sdkBridgeVersion = "v1";
116
- constructor(name: TName);
116
+ constructor(id: CtrlId);
117
117
  onRendered(callback: OnRenderedCallback<HTMLDivElement>): CallbackUnsubscribeOption;
118
- setVisible(visible: boolean): void;
118
+ setVisible(visible: boolean): Promise<void>;
119
119
  }
120
120
 
121
121
  declare type OnAnyCmpValueChanged = NonNullable<typeof client>['onAnyCmpValueChanged'];
@@ -124,25 +124,24 @@ export declare const onAnyCmpValueChanged: OnAnyCmpValueChanged;
124
124
 
125
125
  declare type OnClickCallback = () => void;
126
126
 
127
- /** See {@link useCustomCodeSdkBridgeStoreBase} for details about `render` & `onRendered` callbacks */
128
127
  declare type OnRenderedCallback<T extends HTMLElement = HTMLElement> = (element: T) => void;
129
128
 
130
- export declare class Panel<TName extends CtrlId = CtrlId> {
129
+ export declare class Panel {
131
130
  #private;
132
- readonly name: TName;
131
+ readonly id: CtrlId;
133
132
  readonly sdkBridgeVersion = "v1";
134
- constructor(name: TName);
133
+ constructor(id: CtrlId);
135
134
  onRendered(callback: OnRenderedCallback<HTMLDivElement>): CallbackUnsubscribeOption;
136
- setVisible(visible: boolean): void;
135
+ setVisible(visible: boolean): Promise<void>;
137
136
  }
138
137
 
139
- declare class Text_2<TName extends CtrlId = CtrlId> {
138
+ declare class Text_2 {
140
139
  #private;
141
- readonly name: TName;
140
+ readonly id: CtrlId;
142
141
  readonly sdkBridgeVersion = "v1";
143
- constructor(name: TName);
142
+ constructor(id: CtrlId);
144
143
  onRendered(callback: OnRenderedCallback<HTMLSpanElement>): CallbackUnsubscribeOption;
145
- setVisible(visible: boolean): void;
144
+ setVisible(visible: boolean): Promise<void>;
146
145
  setText(text: string): void;
147
146
  }
148
147
  export { Text_2 as Text }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@combeenation/custom-code-sdk",
3
- "version": "0.0.1-alpha2",
3
+ "version": "0.0.1-alpha3",
4
4
  "description": "Combeenation custom code SDK package",
5
5
  "keywords": [],
6
6
  "homepage": "",