commandbar 1.6.16 → 1.7.0

package/build/internal/src/middleware/nudge.d.ts

@@ -21,8 +21,9 @@ export declare const NudgeV: t.IntersectionC<[t.TypeC<{
     }>;
     timeout_ms: t.UnionC<[t.NumberC, t.NullC]>;
     frequency_limit: t.UnionC<[t.LiteralC<"no_limit">, t.LiteralC<"once_per_session">, t.LiteralC<"once_per_user">]>;
+}>, t.PartialC<{
     is_live: t.BooleanC;
-}>, t.PartialC<{}>]>;
+}>]>;
 export declare class Nudge {
     static decode: (data: any) => {
         id: number;
@@ -46,8 +47,9 @@ export declare class Nudge {
         };
         timeout_ms: number | null;
         frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
-        is_live: boolean;
-    } & {};
+    } & {
+        is_live?: boolean | undefined;
+    };
     static create: (object: {
         id: number;
         organization: string;
@@ -70,8 +72,9 @@ export declare class Nudge {
         };
         timeout_ms: number | null;
         frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
-        is_live: boolean;
-    } & {}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
+    } & {
+        is_live?: boolean | undefined;
+    }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
         id: number;
         organization: string;
         slug: string;
@@ -93,8 +96,9 @@ export declare class Nudge {
         };
         timeout_ms: number | null;
         frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
-        is_live: boolean;
-    } & {}>;
+    } & {
+        is_live?: boolean | undefined;
+    }>;
     static update: (object: {
         id: number;
         organization: string;
@@ -117,8 +121,9 @@ export declare class Nudge {
         };
         timeout_ms: number | null;
         frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
-        is_live: boolean;
-    } & {}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
+    } & {
+        is_live?: boolean | undefined;
+    }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
         id: number;
         organization: string;
         slug: string;
@@ -140,8 +145,9 @@ export declare class Nudge {
         };
         timeout_ms: number | null;
         frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
-        is_live: boolean;
-    } & {}>;
+    } & {
+        is_live?: boolean | undefined;
+    }>;
     static delete: (id: string | number, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<void>;
     static list: (onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<({
         id: number;
@@ -165,8 +171,9 @@ export declare class Nudge {
         };
         timeout_ms: number | null;
         frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
-        is_live: boolean;
-    } & {})[]>;
+    } & {
+        is_live?: boolean | undefined;
+    })[]>;
     static read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
         onSuccess?: (() => void) | undefined;
         onError?: ((err: string) => void) | undefined;
@@ -192,6 +199,7 @@ export declare class Nudge {
         };
         timeout_ms: number | null;
         frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
-        is_live: boolean;
-    } & {}>;
+    } & {
+        is_live?: boolean | undefined;
+    }>;
 }

package/build/internal/src/middleware/organization.d.ts

@@ -299,7 +299,7 @@ export declare class Organization {
             type: "admin";
             value: string;
         } & {} & {
-            commandType?: "object" | "independent" | "help" | undefined;
+            commandType?: "object" | "help" | "independent" | undefined;
             object?: string | undefined;
             hoverTooltip?: boolean | undefined;
             operation?: "self" | "router" | "blank" | undefined;
@@ -307,7 +307,7 @@ export declare class Organization {
             type: "callback";
             value: string;
         } & {} & {
-            commandType?: "object" | "independent" | "help" | undefined;
+            commandType?: "object" | "help" | "independent" | undefined;
             object?: string | undefined;
             hoverTooltip?: boolean | undefined;
             operation?: "self" | "router" | "blank" | undefined;
@@ -315,7 +315,7 @@ export declare class Organization {
             type: "link";
             value: string;
         } & {} & {
-            commandType?: "object" | "independent" | "help" | undefined;
+            commandType?: "object" | "help" | "independent" | undefined;
             object?: string | undefined;
             hoverTooltip?: boolean | undefined;
             operation?: "self" | "router" | "blank" | undefined;
@@ -323,7 +323,7 @@ export declare class Organization {
             type: "click" | "clickByXpath" | "clickBySelector";
             value: string[];
         } & {} & {
-            commandType?: "object" | "independent" | "help" | undefined;
+            commandType?: "object" | "help" | "independent" | undefined;
             object?: string | undefined;
             hoverTooltip?: boolean | undefined;
             operation?: "self" | "router" | "blank" | undefined;
@@ -331,7 +331,7 @@ export declare class Organization {
             type: "builtin";
             value: string;
         } & {} & {
-            commandType?: "object" | "independent" | "help" | undefined;
+            commandType?: "object" | "help" | "independent" | undefined;
             object?: string | undefined;
             hoverTooltip?: boolean | undefined;
             operation?: "self" | "router" | "blank" | undefined;
@@ -339,7 +339,7 @@ export declare class Organization {
             type: "webhook";
             value: string;
         } & {} & {
-            commandType?: "object" | "independent" | "help" | undefined;
+            commandType?: "object" | "help" | "independent" | undefined;
             object?: string | undefined;
             hoverTooltip?: boolean | undefined;
             operation?: "self" | "router" | "blank" | undefined;
@@ -347,7 +347,7 @@ export declare class Organization {
             type: "script";
             value: string;
         } & {} & {
-            commandType?: "object" | "independent" | "help" | undefined;
+            commandType?: "object" | "help" | "independent" | undefined;
             object?: string | undefined;
             hoverTooltip?: boolean | undefined;
             operation?: "self" | "router" | "blank" | undefined;
@@ -368,7 +368,7 @@ export declare class Organization {
                 onError?: string | undefined;
             };
         } & {} & {
-            commandType?: "object" | "independent" | "help" | undefined;
+            commandType?: "object" | "help" | "independent" | undefined;
             object?: string | undefined;
             hoverTooltip?: boolean | undefined;
             operation?: "self" | "router" | "blank" | undefined;
@@ -376,7 +376,7 @@ export declare class Organization {
             type: "appcues";
             value: string;
         } & {} & {
-            commandType?: "object" | "independent" | "help" | undefined;
+            commandType?: "object" | "help" | "independent" | undefined;
             object?: string | undefined;
             hoverTooltip?: boolean | undefined;
             operation?: "self" | "router" | "blank" | undefined;
@@ -384,7 +384,7 @@ export declare class Organization {
             type: "video";
             value: string;
         } & {} & {
-            commandType?: "object" | "independent" | "help" | undefined;
+            commandType?: "object" | "help" | "independent" | undefined;
             object?: string | undefined;
             hoverTooltip?: boolean | undefined;
             operation?: "self" | "router" | "blank" | undefined;
@@ -392,7 +392,7 @@ export declare class Organization {
             type: "helpdoc";
             value: string;
         } & {} & {
-            commandType?: "object" | "independent" | "help" | undefined;
+            commandType?: "object" | "help" | "independent" | undefined;
             object?: string | undefined;
             hoverTooltip?: boolean | undefined;
             operation?: "self" | "router" | "blank" | undefined;
@@ -547,14 +547,14 @@ export declare class Organization {
         };
         tags: string[];
         availability_rules: ({
-            type: "url" | "context" | "element";
+            type: "url" | "element" | "context";
             operator: "includes" | "endsWith" | "startsWith" | "is" | "isTruthy" | "isFalsy" | "isNot" | "isTrue" | "isFalse" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage";
         } & {
             field?: string | undefined;
             value?: string | undefined;
             reason?: string | undefined;
         })[] | (({
-            type: "url" | "context" | "element";
+            type: "url" | "element" | "context";
             operator: "includes" | "endsWith" | "startsWith" | "is" | "isTruthy" | "isFalsy" | "isNot" | "isTrue" | "isFalse" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage";
         } & {
             field?: string | undefined;
@@ -567,7 +567,7 @@ export declare class Organization {
             reason?: string | undefined;
         }))[];
         recommend_rules: (({
-            type: "url" | "context" | "element";
+            type: "url" | "element" | "context";
             operator: "includes" | "endsWith" | "startsWith" | "is" | "isTruthy" | "isFalsy" | "isNot" | "isTrue" | "isFalse" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage";
         } & {
             field?: string | undefined;
@@ -581,7 +581,7 @@ export declare class Organization {
             value?: null | undefined;
             reason?: null | undefined;
         }))[] | (({
-            type: "url" | "context" | "element";
+            type: "url" | "element" | "context";
             operator: "includes" | "endsWith" | "startsWith" | "is" | "isTruthy" | "isFalsy" | "isNot" | "isTrue" | "isFalse" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage";
         } & {
             field?: string | undefined;

package/build/internal/src/middleware/types.d.ts

@@ -124,7 +124,7 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
         type: "admin";
         value: string;
     } & {} & {
-        commandType?: "object" | "independent" | "help" | undefined;
+        commandType?: "object" | "help" | "independent" | undefined;
         object?: string | undefined;
         hoverTooltip?: boolean | undefined;
         operation?: "self" | "router" | "blank" | undefined;
@@ -132,7 +132,7 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
         type: "callback";
         value: string;
     } & {} & {
-        commandType?: "object" | "independent" | "help" | undefined;
+        commandType?: "object" | "help" | "independent" | undefined;
         object?: string | undefined;
         hoverTooltip?: boolean | undefined;
         operation?: "self" | "router" | "blank" | undefined;
@@ -140,7 +140,7 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
         type: "link";
         value: string;
     } & {} & {
-        commandType?: "object" | "independent" | "help" | undefined;
+        commandType?: "object" | "help" | "independent" | undefined;
         object?: string | undefined;
         hoverTooltip?: boolean | undefined;
         operation?: "self" | "router" | "blank" | undefined;
@@ -148,7 +148,7 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
         type: "click" | "clickByXpath" | "clickBySelector";
         value: string[];
     } & {} & {
-        commandType?: "object" | "independent" | "help" | undefined;
+        commandType?: "object" | "help" | "independent" | undefined;
         object?: string | undefined;
         hoverTooltip?: boolean | undefined;
         operation?: "self" | "router" | "blank" | undefined;
@@ -156,7 +156,7 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
         type: "builtin";
         value: string;
     } & {} & {
-        commandType?: "object" | "independent" | "help" | undefined;
+        commandType?: "object" | "help" | "independent" | undefined;
         object?: string | undefined;
         hoverTooltip?: boolean | undefined;
         operation?: "self" | "router" | "blank" | undefined;
@@ -164,7 +164,7 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
         type: "webhook";
         value: string;
     } & {} & {
-        commandType?: "object" | "independent" | "help" | undefined;
+        commandType?: "object" | "help" | "independent" | undefined;
         object?: string | undefined;
         hoverTooltip?: boolean | undefined;
         operation?: "self" | "router" | "blank" | undefined;
@@ -172,7 +172,7 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
         type: "script";
         value: string;
     } & {} & {
-        commandType?: "object" | "independent" | "help" | undefined;
+        commandType?: "object" | "help" | "independent" | undefined;
         object?: string | undefined;
         hoverTooltip?: boolean | undefined;
         operation?: "self" | "router" | "blank" | undefined;
@@ -193,7 +193,7 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
             onError?: string | undefined;
         };
     } & {} & {
-        commandType?: "object" | "independent" | "help" | undefined;
+        commandType?: "object" | "help" | "independent" | undefined;
         object?: string | undefined;
         hoverTooltip?: boolean | undefined;
         operation?: "self" | "router" | "blank" | undefined;
@@ -201,7 +201,7 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
         type: "appcues";
         value: string;
     } & {} & {
-        commandType?: "object" | "independent" | "help" | undefined;
+        commandType?: "object" | "help" | "independent" | undefined;
         object?: string | undefined;
         hoverTooltip?: boolean | undefined;
         operation?: "self" | "router" | "blank" | undefined;
@@ -209,7 +209,7 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
         type: "video";
         value: string;
     } & {} & {
-        commandType?: "object" | "independent" | "help" | undefined;
+        commandType?: "object" | "help" | "independent" | undefined;
         object?: string | undefined;
         hoverTooltip?: boolean | undefined;
         operation?: "self" | "router" | "blank" | undefined;
@@ -217,7 +217,7 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
         type: "helpdoc";
         value: string;
     } & {} & {
-        commandType?: "object" | "independent" | "help" | undefined;
+        commandType?: "object" | "help" | "independent" | undefined;
         object?: string | undefined;
         hoverTooltip?: boolean | undefined;
         operation?: "self" | "router" | "blank" | undefined;
@@ -372,7 +372,7 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
     };
     tags: string[];
     availability_rules: ({
-        type: "url" | "context" | "element";
+        type: "url" | "element" | "context";
         operator: "includes" | "endsWith" | "startsWith" | "is" | "isTruthy" | "isFalsy" | "isNot" | "isTrue" | "isFalse" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage";
     } & {
         field?: string | undefined;
@@ -380,7 +380,7 @@ export declare const isCommand: (command?: ICommandType | any) => command is {
         reason?: string | undefined;
     })[];
     recommend_rules: (({
-        type: "url" | "context" | "element";
+        type: "url" | "element" | "context";
         operator: "includes" | "endsWith" | "startsWith" | "is" | "isTruthy" | "isFalsy" | "isNot" | "isTrue" | "isFalse" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage";
     } & {
         field?: string | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "commandbar",
-  "version": "1.6.16",
+  "version": "1.7.0",
   "description": "Javascript Utility for CommandBar",
   "main": "build/commandbar-js/src/index.js",
   "types": "build/commandbar-js/src/index.d.ts",
@@ -18,9 +18,13 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
+    "commandbar-launcher": "^1.1.9",
     "fp-ts": "2.10.5",
     "io-ts": "2.2.13"
   },
-  "devDependencies": {},
-  "peerDependencies": {}
+  "devDependencies": {
+    "rimraf": "3.0.2",
+    "typescript": "4.6.2",
+    "webpack": "5.74.0"
+  }
 }

package/src/commandbar-launcher.d.ts

@@ -0,0 +1,7 @@
+declare module 'commandbar-launcher' {
+  import { CSSProperties, FC } from 'react';
+
+  export const getControlKey: () => string;
+  const Launcher: FC<{ text: string; style: CSSProperties }>;
+  export default Launcher;
+}

package/src/index.ts

@@ -1,9 +1,11 @@
+import Launcher, { getControlKey } from 'commandbar-launcher';
 import { CommandBarClientSDK } from '../../internal/src/client/CommandBarClientSDK';
 
 export { default as init } from './init';
 export { initProxySDK as initProxy } from '../../internal/src/client/proxy';
 export { snippet } from './snippet';
 export { CommandBarClientSDK };
+export { Launcher, getControlKey };
 
 declare global {
   interface Window {

package/src/snippet.ts

@@ -1,5 +1,8 @@
 /* eslint-disable no-template-curly-in-string */
 /* eslint-disable prefer-rest-params */
+
+import { _eventSubscriptions } from '../../internal/src/client/symbols';
+
 /* eslint-disable @typescript-eslint/no-inferrable-types */
 export const snippet = (org: string) => {
   const polyfills = ['Object.assign', 'Symbol', 'Symbol.for'].join('%2C');
@@ -38,11 +41,12 @@ export const snippet = (org: string) => {
         [_isProxy]: true,
         [_queue]: new Array<unknown>(),
         [_unwrap]: () => proxy,
+        [_eventSubscriptions]: undefined,
       },
       w.CommandBar,
     );
 
-    const ASYNC_METHODS = ['addCommand', 'boot'];
+    const ASYNC_METHODS = ['addCommand', 'boot', 'addEventSubscriber'];
 
     const sdk = proxy;