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

package/dist/index.d.ts

@@ -1,13 +1,12 @@
 import { z } from 'zod';
 
-export declare class Button<TName extends CtrlId = CtrlId> {
+export declare class Button {
     #private;
-    readonly name: TName;
-    readonly sdkBridgeVersion = "v1";
-    constructor(name: TName);
+    readonly id: CtrlId;
+    constructor(id: CtrlId);
     onRendered(callback: OnRenderedCallback<HTMLButtonElement>): CallbackUnsubscribeOption;
     onClick(callback: OnClickCallback): CallbackUnsubscribeOption;
-    setVisible(visible: boolean): void;
+    setVisible(visible: boolean): Promise<void>;
     setText(text: string): void;
 }
 
@@ -15,31 +14,21 @@ declare type CallbackUnsubscribeOption = {
     unsubscribe: () => void;
 };
 
-/**
- * Why we need this?
- *
- * Our custom code SDK is using the `ConfiguratorClient` as its main gateway to communicate with cmps. It comes with the
- * `ConfiguratorClient` built in and only knows about the API of the version is was built with.
- *
- * Therefore, we'll always have to support older versions of the public API for custom code as well at "system runtime".
- *
- * Custom code shall always access the `ConfiguratorClient` via some well defined "gateway fn" like
- * `window.Cbn.getCustomCodeSdkBridge().createCfgrClient` which is responsible for returning the correct versioned API
- * e.g. by "hotpatching" the returned runtime object based on the requested version.
- */
+declare type CfgrClient = NonNullable<typeof client>;
+
 declare interface CfgrClientApi_v1 {
+    finishConfiguration: (input?: string) => Promise<FinishResult>;
     onAnyCmpValueChanged<TInput extends ValueComponent_2>(listener: CmpValuesChangedListener<TInput['name']>, components: TInput[], lazy?: boolean): Promise<void>;
     getCmpValue<T extends CmpValue_2>(cmpName: CmpName_2): Promise<T | undefined>;
     onCmpValueChanged<TValue extends CmpValue_2>(cmpName: CmpName_2, listener: CmpValueChangedListener_2<TValue>, condition?: CmpValueChangedCondition_2<TValue>, callImmediately?: boolean): Promise<void>;
 }
 
-export declare class Checkbox<TName extends CtrlId = CtrlId> {
+export declare class Checkbox {
     #private;
-    readonly name: TName;
-    readonly sdkBridgeVersion = "v1";
-    constructor(name: TName);
+    readonly id: CtrlId;
+    constructor(id: CtrlId);
     onRendered(callback: OnRenderedCallback<HTMLLabelElement>): CallbackUnsubscribeOption;
-    setVisible(visible: boolean): void;
+    setVisible(visible: boolean): Promise<void>;
 }
 
 declare const client: CfgrClientApi_v1 | undefined;
@@ -76,73 +65,102 @@ declare interface CmpValuesChangedListener<TName extends string = string> {
     (changedCmps: CmpValueChangedMap<TName>): void;
 }
 
-export declare class Collapsible<TName extends CtrlId = CtrlId> {
+export declare class Collapsible {
     #private;
-    readonly name: TName;
-    readonly sdkBridgeVersion = "v1";
-    constructor(name: TName);
+    readonly id: CtrlId;
+    constructor(id: CtrlId);
     onRendered(callback: OnRenderedCallback<HTMLDivElement>): CallbackUnsubscribeOption;
-    setVisible(visible: boolean): void;
+    setVisible(visible: boolean): Promise<void>;
 }
 
 declare type CtrlId = z.infer<typeof ZCtrlId>;
 
-export declare class CustomControl<TName extends CtrlId = CtrlId> {
+export declare class CustomControl {
     #private;
-    readonly name: TName;
-    readonly sdkBridgeVersion = "v1";
-    constructor(name: TName);
-    set render(callback: CustomCtrlRenderCallback);
+    readonly id: CtrlId;
+    constructor(id: CtrlId);
+    /**
+     * Things to mention when writing docs:
+     *   - Given `el` is only disconnected when ctrl is hidden
+     *     -> Event listener on that element shall only be installed once in custom code
+     *     Explicitly mention that this is only the case for `customCtrl.renderFn` and not for `otherCtrls.onRendered`.
+     *   - Assigning a new fn does not trigger a re-render
+     *   - Explain, when this fn is being called (automatically on show, manually on `.render()`)
+     *   - Explain, why this should be used instead of a pattern like the following:
+     *     ```ts
+     *     const el = myCtrl.getElement();
+     *     el.innerHTML = '...';
+     *     ```
+     *   - Explain difference to `onRendered` (see comments on `useCustomCodeSdkBridgeStoreBase`)
+     *   - ...
+     */
+    set renderFn(callback: CustomCtrlRenderFn);
+    /**
+     * @param renderFn Convenience param which allows setting the `renderFn` and triggering a render in one call.
+     *                 The `renderFn` will be permanently installed and will override any existing `renderFn`.
+     */
+    render(renderFn?: CustomCtrlRenderFn): Promise<void>;
     getElement(): HTMLElement | undefined;
-    setVisible(visible: boolean): void;
+    setVisible(visible: boolean): Promise<void>;
 }
 
-/** See {@link useCustomCodeSdkBridgeStoreBase} for details about `render` & `onRendered` callbacks */
-declare type CustomCtrlRenderCallback = (element: HTMLDivElement, rawHtml: string | undefined) => void;
+declare type CustomCtrlRenderFn = (element: HTMLDivElement, rawHtml: string | undefined) => void | Promise<void>;
 
-export declare class Dataview<TName extends CtrlId = CtrlId> {
+export declare class Dataview {
     #private;
-    readonly name: TName;
-    readonly sdkBridgeVersion = "v1";
-    constructor(name: TName);
+    readonly id: CtrlId;
+    constructor(id: CtrlId);
     onRendered(callback: OnRenderedCallback<HTMLDivElement>): CallbackUnsubscribeOption;
-    setVisible(visible: boolean): void;
+    setVisible(visible: boolean): Promise<void>;
 }
 
-export declare class Input<TName extends CtrlId = CtrlId> {
+export declare const finishConfiguration: CfgrClient['finishConfiguration'];
+
+/**
+ * Why we need this?
+ *
+ * Our custom code SDK is using the `ConfiguratorClient` as its main gateway to communicate with cmps. It comes with the
+ * `ConfiguratorClient` built in and only knows about the API of the version is was built with.
+ *
+ * Therefore, we'll always have to support older versions of the public API for custom code as well at "system runtime".
+ *
+ * Custom code shall always access the `ConfiguratorClient` via some well defined "gateway fn" like
+ * `window.Cbn.getCustomCodeSdkBridge().createCfgrClient` which is responsible for returning the correct versioned API
+ * e.g. by "hotpatching" the returned runtime object based on the requested version.
+ */
+declare type FinishResult = {
+    newEditCfgnUrl: string;
+    actionResults: {};
+};
+
+export declare class Input {
     #private;
-    readonly name: TName;
-    readonly sdkBridgeVersion = "v1";
-    constructor(name: TName);
+    readonly id: CtrlId;
+    constructor(id: CtrlId);
     onRendered(callback: OnRenderedCallback<HTMLDivElement>): CallbackUnsubscribeOption;
-    setVisible(visible: boolean): void;
+    setVisible(visible: boolean): Promise<void>;
 }
 
-declare type OnAnyCmpValueChanged = NonNullable<typeof client>['onAnyCmpValueChanged'];
-
-export declare const onAnyCmpValueChanged: OnAnyCmpValueChanged;
+export declare const onAnyCmpValueChanged: CfgrClient['onAnyCmpValueChanged'];
 
 declare type OnClickCallback = () => void;
 
-/** See {@link useCustomCodeSdkBridgeStoreBase} for details about `render` & `onRendered` callbacks */
 declare type OnRenderedCallback<T extends HTMLElement = HTMLElement> = (element: T) => void;
 
-export declare class Panel<TName extends CtrlId = CtrlId> {
+export declare class Panel {
     #private;
-    readonly name: TName;
-    readonly sdkBridgeVersion = "v1";
-    constructor(name: TName);
+    readonly id: CtrlId;
+    constructor(id: CtrlId);
     onRendered(callback: OnRenderedCallback<HTMLDivElement>): CallbackUnsubscribeOption;
-    setVisible(visible: boolean): void;
+    setVisible(visible: boolean): Promise<void>;
 }
 
-declare class Text_2<TName extends CtrlId = CtrlId> {
+declare class Text_2 {
     #private;
-    readonly name: TName;
-    readonly sdkBridgeVersion = "v1";
-    constructor(name: TName);
+    readonly id: CtrlId;
+    constructor(id: CtrlId);
     onRendered(callback: OnRenderedCallback<HTMLSpanElement>): CallbackUnsubscribeOption;
-    setVisible(visible: boolean): void;
+    setVisible(visible: boolean): Promise<void>;
     setText(text: string): void;
 }
 export { Text_2 as Text }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@combeenation/custom-code-sdk",
-  "version": "0.0.1-alpha2",
+  "version": "0.0.1-alpha4",
   "description": "Combeenation custom code SDK package",
   "keywords": [],
   "homepage": "",