commandbar 1.3.1 → 1.4.1

package/build/commandbar-js/src/index.d.ts

@@ -0,0 +1,10 @@
+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 };
+declare global {
+    interface Window {
+        CommandBar: CommandBarClientSDK;
+    }
+}

package/build/commandbar-js/src/index.js

@@ -0,0 +1 @@
+!function(t,r){"object"==typeof exports&&"object"==typeof module?module.exports=r():"function"==typeof define&&define.amd?define([],r):"object"==typeof exports?exports.commandbar=r():t.commandbar=r()}(self,(function(){return(()=>{var t={296:(t,r,e)=>{"use strict";var o=e(102),n=e(307),i=e(339),a=e(957),s=e(246),c=t.exports=function(t,r){var e,n,c,u,l;return arguments.length<2||"string"!=typeof t?(u=r,r=t,t=null):u=arguments[2],o(t)?(e=s.call(t,"c"),n=s.call(t,"e"),c=s.call(t,"w")):(e=c=!0,n=!1),l={value:r,configurable:e,enumerable:n,writable:c},u?i(a(u),l):l};c.gs=function(t,r,e){var c,u,l,p;return"string"!=typeof t?(l=e,e=r,r=t,t=null):l=arguments[3],o(r)?n(r)?o(e)?n(e)||(l=e,e=void 0):e=void 0:(l=r,r=e=void 0):r=void 0,o(t)?(c=s.call(t,"c"),u=s.call(t,"e")):(c=!0,u=!1),p={get:r,set:e,configurable:c,enumerable:u},l?i(a(l),p):p}},817:t=>{"use strict";t.exports=function(){}},339:(t,r,e)=>{"use strict";t.exports=e(994)()?Object.assign:e(963)},994:t=>{"use strict";t.exports=function(){var t,r=Object.assign;return"function"==typeof r&&(r(t={foo:"raz"},{bar:"dwa"},{trzy:"trzy"}),t.foo+t.bar+t.trzy==="razdwatrzy")}},963:(t,r,e)=>{"use strict";var o=e(450),n=e(836),i=Math.max;t.exports=function(t,r){var e,a,s,c=i(arguments.length,2);for(t=Object(n(t)),s=function(o){try{t[o]=r[o]}catch(t){e||(e=t)}},a=1;a<c;++a)o(r=arguments[a]).forEach(s);if(void 0!==e)throw e;return t}},349:(t,r,e)=>{"use strict";var o=e(817)();t.exports=function(t){return t!==o&&null!==t}},450:(t,r,e)=>{"use strict";t.exports=e(446)()?Object.keys:e(177)},446:t=>{"use strict";t.exports=function(){try{return Object.keys("primitive"),!0}catch(t){return!1}}},177:(t,r,e)=>{"use strict";var o=e(349),n=Object.keys;t.exports=function(t){return n(o(t)?Object(t):t)}},957:(t,r,e)=>{"use strict";var o=e(349),n=Array.prototype.forEach,i=Object.create,a=function(t,r){var e;for(e in t)r[e]=t[e]};t.exports=function(t){var r=i(null);return n.call(arguments,(function(t){o(t)&&a(Object(t),r)})),r}},836:(t,r,e)=>{"use strict";var o=e(349);t.exports=function(t){if(!o(t))throw new TypeError("Cannot use null or undefined");return t}},246:(t,r,e)=>{"use strict";t.exports=e(711)()?String.prototype.contains:e(370)},711:t=>{"use strict";var r="razdwatrzy";t.exports=function(){return"function"==typeof r.contains&&!0===r.contains("dwa")&&!1===r.contains("foo")}},370:t=>{"use strict";var r=String.prototype.indexOf;t.exports=function(t){return r.call(this,t,arguments[1])>-1}},992:(t,r,e)=>{"use strict";e(98).polyfill()},98:t=>{"use strict";function r(t,r){if(null==t)throw new TypeError("Cannot convert first argument to object");for(var e=Object(t),o=1;o<arguments.length;o++){var n=arguments[o];if(null!=n)for(var i=Object.keys(Object(n)),a=0,s=i.length;a<s;a++){var c=i[a],u=Object.getOwnPropertyDescriptor(n,c);void 0!==u&&u.enumerable&&(e[c]=n[c])}}return e}t.exports={assign:r,polyfill:function(){Object.assign||Object.defineProperty(Object,"assign",{enumerable:!1,configurable:!0,writable:!0,value:r})}}},769:(t,r,e)=>{"use strict";e(614)()||Object.defineProperty(e(119),"Symbol",{value:e(798),configurable:!0,enumerable:!1,writable:!0})},614:(t,r,e)=>{"use strict";var o=e(119),n={object:!0,symbol:!0};t.exports=function(){var t,r=o.Symbol;if("function"!=typeof r)return!1;t=r("test symbol");try{String(t)}catch(t){return!1}return!!n[typeof r.iterator]&&!!n[typeof r.toPrimitive]&&!!n[typeof r.toStringTag]}},64:t=>{"use strict";t.exports=function(t){return!!t&&("symbol"==typeof t||!!t.constructor&&"Symbol"===t.constructor.name&&"Symbol"===t[t.constructor.toStringTag])}},573:(t,r,e)=>{"use strict";var o=e(296),n=Object.create,i=Object.defineProperty,a=Object.prototype,s=n(null);t.exports=function(t){for(var r,e,n=0;s[t+(n||"")];)++n;return s[t+=n||""]=!0,i(a,r="@@"+t,o.gs(null,(function(t){e||(e=!0,i(this,r,o(t)),e=!1)}))),r}},572:(t,r,e)=>{"use strict";var o=e(296),n=e(119).Symbol;t.exports=function(t){return Object.defineProperties(t,{hasInstance:o("",n&&n.hasInstance||t("hasInstance")),isConcatSpreadable:o("",n&&n.isConcatSpreadable||t("isConcatSpreadable")),iterator:o("",n&&n.iterator||t("iterator")),match:o("",n&&n.match||t("match")),replace:o("",n&&n.replace||t("replace")),search:o("",n&&n.search||t("search")),species:o("",n&&n.species||t("species")),split:o("",n&&n.split||t("split")),toPrimitive:o("",n&&n.toPrimitive||t("toPrimitive")),toStringTag:o("",n&&n.toStringTag||t("toStringTag")),unscopables:o("",n&&n.unscopables||t("unscopables"))})}},781:(t,r,e)=>{"use strict";var o=e(296),n=e(11),i=Object.create(null);t.exports=function(t){return Object.defineProperties(t,{for:o((function(r){return i[r]?i[r]:i[r]=t(String(r))})),keyFor:o((function(t){var r;for(r in n(t),i)if(i[r]===t)return r}))})}},798:(t,r,e)=>{"use strict";var o,n,i,a=e(296),s=e(11),c=e(119).Symbol,u=e(573),l=e(572),p=e(781),f=Object.create,d=Object.defineProperties,y=Object.defineProperty;if("function"==typeof c)try{String(c()),i=!0}catch(t){}else c=null;n=function(t){if(this instanceof n)throw new TypeError("Symbol is not a constructor");return o(t)},t.exports=o=function t(r){var e;if(this instanceof t)throw new TypeError("Symbol is not a constructor");return i?c(r):(e=f(n.prototype),r=void 0===r?"":String(r),d(e,{__description__:a("",r),__name__:a("",u(r))}))},l(o),p(o),d(n.prototype,{constructor:a(o),toString:a("",(function(){return this.__name__}))}),d(o.prototype,{toString:a((function(){return"Symbol ("+s(this).__description__+")"})),valueOf:a((function(){return s(this)}))}),y(o.prototype,o.toPrimitive,a("",(function(){var t=s(this);return"symbol"==typeof t?t:t.toString()}))),y(o.prototype,o.toStringTag,a("c","Symbol")),y(n.prototype,o.toStringTag,a("c",o.prototype[o.toStringTag])),y(n.prototype,o.toPrimitive,a("c",o.prototype[o.toPrimitive]))},11:(t,r,e)=>{"use strict";var o=e(64);t.exports=function(t){if(!o(t))throw new TypeError(t+" is not a symbol");return t}},308:t=>{var r=function(){if("object"==typeof self&&self)return self;if("object"==typeof window&&window)return window;throw new Error("Unable to resolve global `this`")};t.exports=function(){if(this)return this;try{Object.defineProperty(Object.prototype,"__global__",{get:function(){return this},configurable:!0})}catch(t){return r()}try{return __global__||r()}finally{delete Object.prototype.__global__}}()},119:(t,r,e)=>{"use strict";t.exports=e(801)()?globalThis:e(308)},801:t=>{"use strict";t.exports=function(){return"object"==typeof globalThis&&!!globalThis&&globalThis.Array===Array}},656:(t,r,e)=>{"use strict";var o;(o="undefined"!=typeof process&&"[object process]"==={}.toString.call(process)||"undefined"!=typeof navigator&&"ReactNative"===navigator.product?e.g:self).Proxy||(o.Proxy=e(659)(),o.Proxy.revocable=o.Proxy.revocable)},659:t=>{t.exports=function(){let t,r=null;function e(t){return!!t&&("object"==typeof t||"function"==typeof t)}function o(t){if(null!==t&&!e(t))throw new TypeError("Object prototype may only be an Object or null: "+t)}const n=Object,i=Boolean(n.create)||!({__proto__:null}instanceof n),a=n.create||(i?function(t){return o(t),{__proto__:t}}:function(t){if(o(t),null===t)throw new SyntaxError("Native Object.create is required to create objects with null prototype");var r=function(){};return r.prototype=t,new r}),s=function(){return null},c=n.getPrototypeOf||([].__proto__===Array.prototype?function(t){const r=t.__proto__;return e(r)?r:null}:s);return t=function(u,l){if(void 0===(this&&this instanceof t?this.constructor:void 0))throw new TypeError("Constructor Proxy requires 'new'");if(!e(u)||!e(l))throw new TypeError("Cannot create proxy with a non-object as target or handler");let p=function(){};r=function(){u=null,p=function(t){throw new TypeError(`Cannot perform '${t}' on a proxy that has been revoked`)}},setTimeout((function(){r=null}),0);const f=l;l={get:null,set:null,apply:null,construct:null};for(let t in f){if(!(t in l))throw new TypeError(`Proxy polyfill does not support trap '${t}'`);l[t]=f[t]}"function"==typeof f&&(l.apply=f.apply.bind(f));const d=c(u);let y,m=!1,b=!1;"function"==typeof u?(y=function(){const t=this&&this.constructor===y,r=Array.prototype.slice.call(arguments);return p(t?"construct":"apply"),t&&l.construct?l.construct.call(this,u,r):!t&&l.apply?l.apply(u,this,r):t?(r.unshift(u),new(u.bind.apply(u,r))):u.apply(this,r)},m=!0):u instanceof Array?(y=[],b=!0):y=i||null!==d?a(d):{};const _=l.get?function(t){return p("get"),l.get(this,t,y)}:function(t){return p("get"),this[t]},v=l.set?function(t,r){p("set"),l.set(this,t,r,y)}:function(t,r){p("set"),this[t]=r},g=n.getOwnPropertyNames(u),h={};g.forEach((function(t){if((m||b)&&t in y)return;const r=n.getOwnPropertyDescriptor(u,t),e={enumerable:Boolean(r.enumerable),get:_.bind(u,t),set:v.bind(u,t)};n.defineProperty(y,t,e),h[t]=!0}));let w=!0;if(m||b){const t=n.setPrototypeOf||([].__proto__===Array.prototype?function(t,r){return o(r),t.__proto__=r,t}:s);d&&t(y,d)||(w=!1)}if(l.get||!w)for(let t in u)h[t]||n.defineProperty(y,t,{get:_.bind(u,t)});return n.seal(u),n.seal(y),y},t.revocable=function(e,o){return{proxy:new t(e,o),revoke:r}},t}},956:function(t,r,e){"use strict";var o=this&&this.__assign||function(){return o=Object.assign||function(t){for(var r,e=1,o=arguments.length;e<o;e++)for(var n in r=arguments[e])Object.prototype.hasOwnProperty.call(r,n)&&(t[n]=r[n]);return t},o.apply(this,arguments)};Object.defineProperty(r,"__esModule",{value:!0}),e(656),e(992),e(769);var n=e(737),i=e(207),a=function(t){if("complete"===document.readyState){var r=function(t){var r="https://api.commandbar.com",e=[],o=localStorage.getItem("commandbar.lc");o&&o.includes("local")?r="http://localhost:8000":o||"10d7dc04"!==t||(r="https://api-cu.commandbar.com");var n=r+"/latest/"+t;return o&&e.push("lc="+o),e.push("version=2"),n+"?"+e.join("&")}(t),e=document.createElement("script");e.type="text/javascript",e.async=!0,e.src=r,document.head.appendChild(e)}else window.addEventListener("load",a.bind(null,t),{capture:!1,once:!0})},s={debug:!1};r.default=function(t,r){void 0===r&&(r=s);var e=o(o({},s),r);t?(e.debug&&console.log("CommandBar init..."),n.getProxySDK()[i._configuration]={uuid:t},a(t)):console.error("No org specified for CommandBar.init")}},890:(t,r)=>{"use strict";Object.defineProperty(r,"__esModule",{value:!0}),r.snippet=void 0,r.snippet=function(t){var r=["Object.assign","Symbol","Symbol.for"].join("%2C"),e=window;function o(t,r){void 0===r&&(r=!1),"complete"!==document.readyState&&window.addEventListener("load",o.bind(null,t,r),{capture:!1,once:!0});var e=document.createElement("script");e.type="text/javascript",e.async=r,e.src=t,document.head.appendChild(e)}function n(){var r;if(void 0===e.CommandBar){delete e.__CommandBarBootstrap__;var n=Symbol.for("CommandBar::configuration"),i=Symbol.for("CommandBar::orgConfig"),a=Symbol.for("CommandBar::disposed"),s=Symbol.for("CommandBar::isProxy"),c=Symbol.for("CommandBar::queue"),u=Symbol.for("CommandBar::unwrap"),l=[],p=localStorage.getItem("commandbar.lc"),f=p&&p.includes("local")?"http://localhost:8000":"https://api.commandbar.com",d=Object.assign(((r={})[n]={uuid:t},r[i]={},r[a]=!1,r[s]=!0,r[c]=new Array,r[u]=function(){return d},r),e.CommandBar);e.CommandBar=new Proxy(d,{get:function(t,r){return r in d?d[r]:function(){var t=Array.prototype.slice.call(arguments);t.unshift(r),d[c].push(t)}}}),null!==p&&l.push("lc="+p),l.push("version=2"),o(f+"/latest/"+t+"?"+l.join("&"),!0)}}void 0===Object.assign||"undefined"==typeof Symbol||void 0===Symbol.for?(e.__CommandBarBootstrap__=n,o("https://polyfill.io/v3/polyfill.min.js?version=3.101.0&callback=__CommandBarBootstrap__&features="+r)):n()}},343:(t,r)=>{"use strict";Object.defineProperty(r,"__esModule",{value:!0})},737:(t,r,e)=>{"use strict";Object.defineProperty(r,"__esModule",{value:!0}),r.initProxySDK=r.getProxySDK=void 0;var o=e(314),n=e(207);function i(){var t,r,e,o,i=window.CommandBar,a=window.CommandBar;Array.isArray(null==i?void 0:i.q)||"string"==typeof(null==i?void 0:i.uid)?(e=null==i?void 0:i.uid,o=null==i?void 0:i.q):(e=null===(r=null==a?void 0:a[n._configuration])||void 0===r?void 0:r.uuid,o=null==a?void 0:a[n._queue]);var s=((t={})[n._configuration]={uuid:"string"==typeof e?e:""},t[n._disposed]=!1,t[n._isProxy]=!0,t[n._queue]=Array.isArray(o)?o:[],t[n._unwrap]=function(){return s},t);window.CommandBar=new Proxy(s,{get:function(t,r){return function(t,r){return r in t}(s,r)?s[r]:function(){var t=Array.prototype.slice.call(arguments);t.unshift(r),s[n._queue].push(t)}}})}r.getProxySDK=function(){var t=window.CommandBar;return(o.isDisposed(t)||"boolean"!=typeof t[n._isProxy])&&i(),window.CommandBar[n._unwrap]()},r.initProxySDK=i},207:(t,r)=>{"use strict";Object.defineProperty(r,"__esModule",{value:!0}),r._user=r._unwrap=r._state=r._showMessage=r._showGuide=r._setTestMode=r._setPreviewMode=r._setDashboard=r._search=r._reporter=r._report=r._reloadOrganization=r._reloadCommands=r._queue=r._programmaticTheme=r._perf=r._orgConfig=r._loadEditor=r._isProxy=r._eventMeta=r._disposed=r._dispose=r._dispatch=r._configUser=r._configure=r._configuration=r._access=void 0,r._access=Symbol.for("CommandBar::access"),r._configuration=Symbol.for("CommandBar::configuration"),r._configure=Symbol.for("CommandBar::configure"),r._configUser=Symbol.for("CommandBar::configUser"),r._dispatch=Symbol.for("CommandBar::dispatch"),r._dispose=Symbol.for("CommandBar::dispose"),r._disposed=Symbol.for("CommandBar::disposed"),r._eventMeta=Symbol.for("CommandBar::eventMeta"),r._isProxy=Symbol.for("CommandBar::isProxy"),r._loadEditor=Symbol.for("CommandBar::loadEditor"),r._orgConfig=Symbol.for("CommandBar::orgConfig"),r._perf=Symbol.for("CommandBar::perf"),r._programmaticTheme=Symbol.for("CommandBar::programmaticTheme"),r._queue=Symbol.for("CommandBar::queue"),r._reloadCommands=Symbol.for("CommandBar::reloadCommands"),r._reloadOrganization=Symbol.for("CommandBar::reloadOrganization"),r._report=Symbol.for("CommandBar::report"),r._reporter=Symbol.for("CommandBar::reporter"),r._search=Symbol.for("CommandBar::search"),r._setDashboard=Symbol.for("CommandBar::setDashboard"),r._setPreviewMode=Symbol.for("CommandBar::setPreviewMode"),r._setTestMode=Symbol.for("CommandBar::setTestMode"),r._showGuide=Symbol.for("CommandBar::showGuide"),r._showMessage=Symbol.for("CommandBar::showMessage"),r._state=Symbol.for("CommandBar::state"),r._unwrap=Symbol.for("CommandBar::unwrap"),r._user=Symbol.for("CommandBar::user")},314:(t,r,e)=>{"use strict";Object.defineProperty(r,"__esModule",{value:!0}),r.dispose=r.isDisposed=r.isDisposable=void 0;var o=e(207),n=function(t){return void 0!==t&&void 0!==t.dispose},i=function(t){return void 0!==t&&void 0!==t[o._dispose]};r.isDisposable=function(t){return void 0===t||n(t)||i(t)},r.isDisposed=function(t){return void 0===t||n(t)&&!0===t._disposed||i(t)&&!0===t[o._disposed]},r.dispose=function(t){void 0!==t&&(i(t)?t[o._dispose]():t.dispose())}},111:(t,r,e)=>{"use strict";var o=e(666);t.exports=function(t){if("function"!=typeof t)return!1;if(!hasOwnProperty.call(t,"length"))return!1;try{if("number"!=typeof t.length)return!1;if("function"!=typeof t.call)return!1;if("function"!=typeof t.apply)return!1}catch(t){return!1}return!o(t)}},617:(t,r,e)=>{"use strict";var o=e(102),n={object:!0,function:!0,undefined:!0};t.exports=function(t){return!!o(t)&&hasOwnProperty.call(n,typeof t)}},307:(t,r,e)=>{"use strict";var o=e(111),n=/^\s*class[\s{/}]/,i=Function.prototype.toString;t.exports=function(t){return!!o(t)&&!n.test(i.call(t))}},666:(t,r,e)=>{"use strict";var o=e(617);t.exports=function(t){if(!o(t))return!1;try{return!!t.constructor&&t.constructor.prototype===t}catch(t){return!1}}},102:t=>{"use strict";t.exports=function(t){return null!=t}}},r={};function e(o){var n=r[o];if(void 0!==n)return n.exports;var i=r[o]={exports:{}};return t[o].call(i.exports,i,i.exports,e),i.exports}e.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(t){if("object"==typeof window)return window}}();var o={};return(()=>{"use strict";var t=o;Object.defineProperty(t,"__esModule",{value:!0}),t.CommandBarClientSDK=void 0;var r=e(343);Object.defineProperty(t,"CommandBarClientSDK",{enumerable:!0,get:function(){return r.CommandBarClientSDK}});var n=e(956);Object.defineProperty(t,"init",{enumerable:!0,get:function(){return n.default}});var i=e(737);Object.defineProperty(t,"initProxy",{enumerable:!0,get:function(){return i.initProxySDK}});var a=e(890);Object.defineProperty(t,"snippet",{enumerable:!0,get:function(){return a.snippet}})})(),o})()}));

package/build/commandbar-js/src/init.d.ts

@@ -0,0 +1,17 @@
+import 'proxy-polyfill';
+import 'es6-object-assign/auto';
+import 'es6-symbol/implement';
+interface IInitOptions {
+    debug?: boolean;
+}
+/**
+ * Initializes CommandBar and injects the scripts required to load it into the <head> of the document. After calling
+ * this function it will be possible to access window.CommandBar and call the SDK methods, even if the scripts have not
+ * finished loading yet.
+ *
+ * @param {string} org Your organization ID, which can be found [here](https://app.commandbar.com/docs/getting-started/installation#option-b:-use-npm-or-yarn).
+ * @param {IInitOptions} [opts] Additional options to use for initialization: `debug` will enable additional logging
+ * output.
+ */
+declare const init: (org: string, opts?: IInitOptions) => void;
+export default init;

package/build/commandbar-js/src/snippet.d.ts

@@ -0,0 +1 @@
+export declare const snippet: (org: string) => void;

package/build/internal/src/client/AddContextOptions.d.ts

@@ -0,0 +1,57 @@
+export interface SearchResultsPaginated {
+    pagination: unknown;
+    data: unknown[];
+}
+export declare type SearchFunction = (input: string) => unknown[] | Promise<unknown[]>;
+export declare type SearchFunctionPaginated = (input: string, pagination?: unknown) => SearchResultsPaginated | Promise<SearchResultsPaginated>;
+/** Options to customize CommandBar properties for `key`. */
+export interface AddContextOptions {
+    /** quickFind allows the `key` to be searchable from the top-level of the Bar, alongside commands. */
+    quickFindOptions?: {
+        /**
+         * Turn on autoExecute for `key`. If only one command is available for an option from this `key`, that command will
+         * automatically be executed when a user selects the option.
+         */
+        autoExecute?: boolean;
+        /** The category header name for `key` objects shown during search (not used if `unfurl` is on). */
+        categoryName?: string;
+        /** Turn on quickFind for `key`. */
+        quickFind?: boolean;
+        /** Turn on unfurling for `key`. */
+        unfurl?: boolean;
+    };
+    /** Options to customize the style of `key` objects. */
+    renderOptions?: {
+        /**
+         * Default icon to show alongside `key` objects. Can be a URL (absolute or relative) or emoji character. You can
+         * specify a custom icon for every object by setting an `.icon` field.
+         */
+        defaultIcon?: string;
+        /** The value key of `key` objects you want to use to display the object's description (subtext under label). */
+        descriptionKey?: string;
+        /** The value key of `key` objects you want to use to display the object's label. */
+        labelKey?: string;
+    };
+    /** Options to customize the search behavior for `key`. */
+    searchOptions?: {
+        /**
+         * A list of object fields to be searched. If a custom `searchFunction` is provided, matches will be highlighted in
+         * these fields. Field names will be transformed from _camelCase_ or _snake_case_ into _Sentence case_.
+         */
+        fields?: string[];
+        /**
+         * Adds a custom search function to CommandBar for `key`. This custom search function should take a single argument `input` and return an array of results.
+         *
+         * The function will be called whenever a user types in a scenario where they might be searching for `context.key`:
+         *
+         * * A command has been selected and the user is prompted for an argument referencing `context.key`
+         * * Quickfind is turned on for `context.key`.
+         *
+         * Results from the custom search function should be filtered; they will not be filtered by CommandBar. This means
+         * that the search results will be identical to those returned by the function.
+         *
+         * @param input What the user has typed into CommandBar
+         */
+        searchFunction?: SearchFunction | SearchFunctionPaginated;
+    };
+}

package/build/internal/src/client/CommandBarClientSDK.d.ts

@@ -0,0 +1,182 @@
+import { AddContextOptions } from './AddContextOptions';
+import { EventHandler } from './EventHandler';
+import { ICommandFromClientType } from '../middleware/ICommandFromClientType';
+import { IResourceSettings } from '../middleware/IResourceSettings';
+export declare type BootOptions = string | (Metadata & {
+    id: string;
+});
+export declare type Metadata = Record<string, unknown>;
+export declare type CallbackFunction<T, U = Metadata> = (args: T, context: U) => void;
+export declare type ContextLoader = (chosenValues?: undefined | Record<string, unknown[]>) => unknown;
+export declare type CommandBarClientSDK = Readonly<{
+    /**
+     * Adds a callback function to CommandBar. The callback function provided is mapped to `callbackKey`, and can be
+     * attached to commands by referencing `callbackKey` in a command config.
+     *
+     * @param callbackKey Key to reference the provided function
+     * @param callbackFn Callback function, with the following signature:
+     * * `args`: Depends on the callback, but typically a dictionary of argument keys and the values entered by the user.
+     * * `context`: A dictionary reflecting the state of context when the callback was triggered by a command execution
+     */
+    addCallback<T, U>(callbackKey: string, callbackFn: CallbackFunction<T, U>): void;
+    addCallbacks(callbacks: {
+        [name: string]: (...args: unknown[]) => unknown;
+    }): void;
+    /**
+     * Add a command to CommandBar.
+     *
+     * @param command The command schema
+     */
+    addCommand(command: ICommandFromClientType): Promise<void>;
+    /**
+     * Adds any new (key, value) pairs to context. For any existing keys, updates values. Conceptually, `addContext` does
+     * the following:
+     * ```typescript
+     * newContext = {...oldContext, ...ctx}
+     * ```
+     *
+     * To replace context, use [setContext](#CommandBarClientApi.setContext).
+     *
+     * @param key Key for the object to be added to context, or an object containing multiple context keys to update.
+     *
+     * @param initialValue The initial value of `key` in context.
+     *
+     * There are two options:
+     * * Static: A literal value (e.g. `["foo", "bar"]`)
+     * * Dynamic: A function to load a set of values for `key`, used to lazily load a list of values. This function will
+     * be passed as an argument a dictionary of the previously selected argument values, if there are any. Useful for
+     * lazily loading longer lists, or loading lists that are dependent on previous arguments.
+     *
+     * If an array of objects is provided (statically or dynamically) the following reserved keys in those objects will
+     * trigger special behavior:
+     * * `category`: Used to visually group the list of values with others that have the same category value.
+     * * `icon`: Icon to be shown next to each value. Can be a URL (absolute or relative), emoji character, or an SVG
+     * string (which *must* begin with `<svg` ). Specifying a `.icon` property will override any default set in
+     * `options.renderOptions.defaultIcon`.
+     *
+     * @param options Options to customize CommandBar properties for `key`.
+     *
+     * @see [AddContextOptions](#AddContextOptions).
+     */
+    addContext(key: string, initialValue: ContextLoader, options?: AddContextOptions): void;
+    addContext(key: string, initialValue: unknown, options?: AddContextOptions): void;
+    /** @deprecated Use setContext instead. */
+    addContext(ctx: Metadata): void;
+    /**
+     * Captures CommandBar events to be handled in your code / stored in your database. Ask the CommandBar team if you're
+     * interested in this feature.
+     *
+     * @param eventHandler A function for handling events generated by CommandBar. It should have the following signature:
+     * * `eventName`: The name of the event type. Here are the different event types:
+     *    * `opened`: Bar open
+     *    * `closed`: Bar close. When the bar is closed with input text, it triggers both a `closed` event and a
+     *      `deadend`. Executions do not trigger `closed` events.
+     *    * `abandoned_search`: A deadend
+     *    * `command_suggestion`: A command suggestion
+     *    * `command_execution`: A command execution
+     * * `eventData`: Event attributes (will differ based on the type of event). In addition to the data below, any
+     *   [eventData you pass to .boot()](https://app.commandbar.com/sdk#boot-eventdata) will be added to each event.
+     */
+    addEventHandler(eventHandler: EventHandler): void;
+    /**
+     * Sets a router function that link command can use to update the page's URL without triggering a reload. To lean more about using `addRouter` see [Adding a router](https://app.commandbar.com/docs/commands/actions/link#link-types).
+     *
+     * @param routerFn The router function. It should accept the following arguments:
+     * * `url` {string} The url to navigate to
+     */
+    addRouter(routerFn: (url: string) => void): void;
+    /** @deprecated Use addContext instead. */
+    addSearch(name: string, func: (...args: unknown[]) => unknown): void;
+    /**
+     * Make CommandBar available to the user. CommandBar will not be available before `.boot` is called, even if the
+     * snippet has been run on the page they are on.
+     *
+     * @param id ID corresponding to the currently logged-in end user. Used to tag analytics events.
+     * @param metadata Key-value pairs to be associated with the end user for whom CommandBar is being booted. You can
+     * filter on these attributes from the analytics page in your dashboard. In addition, events passed to a supplied
+     * event handler will include metadata you provide via `boot`.
+     */
+    boot(id: string, metadata?: Metadata): Promise<void>;
+    /**
+     * @deprecated Passing an object to boot will be deprecated in a future version of CommandBar.
+     */
+    boot(opts: BootOptions): Promise<void>;
+    clearActiveObject(contextKey: string): void;
+    close(): void;
+    /**
+     * Executes a command. If this command has arguments, the Bar will open so the user can complete those arguments.
+     *
+     * @param id The command id to execute. For commands defined via the Editor, you can find this id in the Editor by selecting "Copy code" in the command's ellipsis menu. For commands defined via the SDK, this is the `name` field.
+     */
+    execute(id: number | string): void;
+    /**
+     * Returns `true` if the Bar is currently open, `false` if it is not, or `undefined` if the CommandBar is not fully
+     * initialized yet.
+     */
+    isOpen(): boolean | undefined;
+    onboard(): void;
+    /**
+     * Open the Bar. If an input is supplied, will prefill the search input with that value.
+     *
+     * @param input Optional input ot prefill the Bar's search field.
+     * @param options FIXME: UNDOCUMENTED
+     */
+    open(input?: string, options?: {
+        categoryFilter?: number;
+    }): void;
+    /**
+     * Removes the callback function referenced by `callbackKey` from CommandBar.
+     *
+     * When you remove a callback, any commands for which the callback is a dependency will become unavailable. Learn
+     * more about availability [here](https://app.commandbar.com/docs/commands/availability).
+     *
+     * @param callbackKey Callback key for the callback to be removed.
+     */
+    removeCallback(callbackKey: string): void;
+    /**
+     * Remove a command, making it unavailable to a user.
+     *
+     * @param commandName The `name` field of the command
+     */
+    removeCommand(commandName: string): void;
+    /**
+     * Removes a key and its corresponding value from context. When you remove a context key, any commands for which the
+     * key was a depencdency will become unavailable. To learn more about availability, see
+     * [When are commands available to users?](https://app.commandbar.com/docs/commands/availability#when-are-commands-available-to-users?)
+     *
+     * @param keyToRemove Context key to remove
+     */
+    removeContext(keyToRemove: string): void;
+    setActiveObject(contextKey: string, objectLabel: string | string[], categoryName?: string): void;
+    /**
+     * Similar to `addContext`, but also removes any keys that are omitted from the supplied `ctx` from context. It may be
+     * helpful to use this to make large context changes, such as when a user logs out.
+     *
+     * @param context Dictionary to overwrite context
+     * @param meta FIXME: UNDOCUMENTED
+     */
+    setContext(context: Metadata, meta?: Metadata & {
+        useCustom?: boolean;
+        customID?: string | number;
+    }): void;
+    /**
+     * Changes the background of the CommandBar to the supplied color.
+     *
+     * @param color A hex color. Using 'light' or 'dark' will trigger CommandBar's default light or dark theme.
+     */
+    setTheme(color: string | 'light' | 'dark'): void;
+    /**
+     * Returns dictionary representing the current callbacks currently stored within CommandBar. The keys represent
+     * callback keys, and the values are the supplied functions.
+     */
+    shareCallbacks(): Record<string, CallbackFunction<unknown>>;
+    /** Returns the key value dictionary representing the current state of context */
+    shareContext(): Metadata;
+    /**
+     * Make CommandBar unavailable to the user. Does nothing unless `.boot` has been called. `shutdown` is typically used
+     * to make CommandBar unavailable after logout.
+     */
+    shutdown(): void;
+    /** @deprecated Use addContext instead. */
+    updateContextSettings(key: string, settings: IResourceSettings): void;
+}>;

package/build/internal/src/client/CommandBarProxySDK.d.ts

@@ -0,0 +1,48 @@
+import { SentryReporter } from './SentryReporter';
+import { SDKConfig, OrgConfig } from './CommandBarSDK';
+import { _configuration, _disposed, _isProxy, _queue, _reporter, _unwrap, _orgConfig } from './symbols';
+/**
+ * A proxy object that absorbs function calls into a queue that can be later consumed. The queue contains the name of
+ * properties accessed for function calls including any arguments passed.
+ *
+ * This is useful to allow clients to "queue up" calls to the SDK before it can be "upgraded" with state and callbacks
+ * from the React component tree.
+ */
+export declare type CommandBarProxySDK = CommandBarProxyGlobal & Record<string, Function> & {
+    [_configuration]?: Function | Partial<SDKConfig>;
+    [_orgConfig]?: Function | OrgConfig;
+    [_reporter]?: Function | SentryReporter;
+};
+/**
+ * The global SDK object, which is usually hidden behind a Proxy at `window.CommandBar`. Use
+ * `window.CommandBar[_unwrap]()` (or ideally `getProxySDK()`) from anywhere to access this.
+ *
+ * The properties defined here are the minimal properties that can always be expected to be present in the global
+ * object. Many more are added once "upgraded" using `initSDK`.
+ */
+export interface CommandBarProxyGlobal {
+    /**
+     * Marks the proxy as disposed when true; this will cause a new global object to be created with the next `getSDK()`
+     * or `getProxySDK()` call.
+     */
+    [_disposed]: boolean;
+    [_isProxy]: true;
+    /**
+     * A command queue that builds up commands executed early in the application lifecycle, before the App component has
+     * had a chance to render.
+     */
+    [_queue]: unknown[][];
+    /**
+     * A sneaky way to get access to the object that's being proxied, the one that holds the real global state. Use this
+     * to avoid triggering unwanted proxy behavior when accessing properties that are unassigned.
+     *
+     * The typedefs of the optional properties (_org, _reporter) in CommandBarProxySDK illustrate the risk of working with
+     * a wrapped proxy global.
+     */
+    [_unwrap]: () => CommandBarProxyGlobal;
+    [_configuration]?: Partial<SDKConfig>;
+    [_orgConfig]?: OrgConfig;
+    [_reporter]?: SentryReporter;
+}
+/** Tests if the given object is a "proxy" SDK object that has not yet been upgraded to a client SDK object. */
+export declare function isProxySDK(x: unknown): x is CommandBarProxySDK;

package/build/internal/src/client/CommandBarSDK.d.ts

@@ -0,0 +1,42 @@
+import { CommandBarClientSDK, Metadata } from './CommandBarClientSDK';
+import { EVENT_NAME } from './Reporting';
+import { SentryReporter } from './SentryReporter';
+import { _access, _configuration, _configure, _configUser, _dispatch, _dispose, _disposed, _eventMeta, _isProxy, _loadEditor, _orgConfig, _perf, _programmaticTheme, _reloadCommands, _reloadOrganization, _report, _reporter, _search, _setDashboard, _setPreviewMode, _setTestMode, _showGuide, _showMessage, _state, _user } from './symbols';
+import { SDKConfig } from './SDKConfig';
+export interface OrgConfig {
+    name?: string;
+    silent?: boolean;
+}
+export { SDKConfig } from './SDKConfig';
+export interface CommandBarSDK<State = unknown, Dispatch = unknown> extends CommandBarClientSDK {
+    [_access]: string | undefined;
+    [_dispatch]: Dispatch;
+    [_eventMeta]: Metadata | undefined;
+    [_perf]: boolean;
+    [_programmaticTheme]: string | undefined;
+    [_reporter]: SentryReporter | undefined;
+    [_search]: string;
+    [_state]: State;
+    [_user]: string | undefined;
+    /** @deprecated */
+    readonly [_configure]: (uuid: string) => void;
+    readonly [_configuration]: SDKConfig;
+    readonly [_configUser]: () => Promise<void>;
+    readonly [_dispose]: () => void;
+    readonly [_disposed]: false;
+    readonly [_isProxy]: false;
+    readonly [_loadEditor]: () => void;
+    readonly [_orgConfig]: OrgConfig;
+    readonly [_reloadCommands]: () => void;
+    readonly [_reloadOrganization]: () => void;
+    /** @deprecated Vinay: Always thought this could be cool, but seems unlikely */
+    readonly [_report]: (event: EVENT_NAME, data?: Metadata) => void;
+    /** @deprecated Vinay: One day maybe but not now */
+    readonly [_setDashboard]: (element: HTMLElement) => void;
+    readonly [_setPreviewMode]: (on: boolean) => void;
+    readonly [_setTestMode]: (on: boolean) => void;
+    /** @deprecated Vinay: Should ditch this feature */
+    readonly [_showGuide]: (eventName: string, preview?: boolean) => void;
+    /** @deprecated */
+    readonly [_showMessage]: (eventName: string, preview?: boolean) => void;
+}

package/build/internal/src/client/EventHandler.d.ts

@@ -0,0 +1,54 @@
+export interface AbandonedSearchEvent {
+    /** Event data passed for `abandoned_search` events (deadends). */
+    /** The id of the currently active command, if there is one. */
+    command?: number;
+    /** The text of the deadend. */
+    inputText: string;
+    /** The context key of the currently active resource, if there is one. */
+    resource?: string;
+    /** The trigger for the deadend. */
+    type: 'Backspaced' | 'Closed with text' | 'Resetting search';
+}
+export interface ClosedEvent {
+    /** Event data passed for `command_execution` events. */
+    /** The user's input text when the bar was closed. */
+    inputText: string;
+}
+export interface CommandExecutionEvent {
+    /** Event data passed for `command_execution` events. */
+    /** The category id of the command. Only provided if the command has a category. */
+    category?: number;
+    /**
+     * The unique id of the command. For commands defined via the Editor, the value will be a number. For programmatic
+     * commands, the `name` (string) provided will be used.
+     */
+    command: number | string;
+    /** The text of the command */
+    commandText: string;
+    /** True if this command was triggered by a shortcut. */
+    shortcut?: boolean;
+}
+export interface CommandSuggestionEvent {
+    /** Event data passed for `command_suggestion` events. */
+    /** The title of the suggestion. */
+    title: string;
+    /** The text of the suggestion. */
+    text: string;
+}
+export interface OpenedEvent {
+    /** Event data passed for `command_execution` events. */
+    /**
+     * The entrypoint through which the bar was opened.
+     *
+     * * `launcher`: Click on the provided CommandBar launcher
+     * * `keyboard`: Cmd/Ctrl+K
+     * * `programmatic`: Call to `window.CommandBar.open()`. Clicks on the
+     *   [commandbar-launcher](https://www.npmjs.com/package/commandbar-launcher) component register as programmatic
+     *   opens.
+     * * `onboarding`: Completion of the onboarding tutorial, which opens the bar.
+     */
+    trigger: 'launcher' | 'keyboard' | 'programmatic' | 'onboarding';
+}
+export declare type EventData = AbandonedSearchEvent | ClosedEvent | CommandExecutionEvent | CommandSuggestionEvent | OpenedEvent;
+export declare type EventHandler = (eventName: EventType, eventData: EventData) => void;
+export declare type EventType = 'abandoned_search' | 'closed' | 'command_suggestion' | 'command_execution' | 'opened';

package/build/internal/src/client/Reporting.d.ts

@@ -0,0 +1 @@
+export declare type EVENT_NAME = 'Identify' | 'New session' | 'End session' | 'Load Performance' | 'New search' | 'Exited' | 'Search input' | 'Onboarding tooltip shown' | 'Tooltip shown' | 'Onboarding started' | 'Onboarding exited' | 'Onboarding completed' | 'Abandoned search' | 'Command suggestion' | 'Command execution' | 'Unavailable shortcut' | 'Game played' | 'Clicked branding' | 'Survey response' | 'Client-Error' | 'Internal-Error';

package/build/internal/src/client/SDKConfig.d.ts

@@ -0,0 +1,7 @@
+export interface SDKConfig {
+    api: string;
+    editor: string;
+    proxy: string;
+    session: string;
+    uuid: string;
+}

package/build/internal/src/client/SentryReporter.d.ts

@@ -0,0 +1,41 @@
+import { Hub } from '@sentry/react';
+import { IOrganizationType } from '../middleware/OrganizationV';
+import { PublicDisposable } from '../util/Disposable';
+declare type HubInstance = InstanceType<typeof Hub>;
+declare type ExtraData = Record<string, unknown>;
+export interface UserScopeOptions {
+    configuration: {
+        uuid?: string;
+        api: string;
+        editor: string;
+        proxy: string;
+        session: string;
+    };
+    organization?: IOrganizationType;
+    organizationId: string | number;
+    organizationName?: string;
+    session: string;
+    userId?: string;
+}
+export declare abstract class SentryReporter implements PublicDisposable {
+    _disposed: boolean;
+    breadcrumb: HubInstance['addBreadcrumb'];
+    dispose(): void;
+    /**
+     * Report an error to Sentry. The first argument must either be a string or error object, and optionally an error
+     * object and extra data (in the form of an object) may be provided as well.
+     *
+     * If a string message is provided instead of an Error object a new Error will be generated. This will cause the
+     * stacktrace to begin at this function; for that reason it is **strongly** recommended to provide an error object
+     * so that the original stack trace can be preserved (as originalException).
+     */
+    abstract exception(message: string, err?: Error, extra?: ExtraData): void;
+    abstract exception(message: string, extra?: ExtraData): void;
+    abstract exception(err: Error, extra?: ExtraData): void;
+    /**
+     * Assigns various scope properties related to the currently active user and organization so that error events can
+     * be easily associated with them.
+     */
+    abstract setUserScope(opts: UserScopeOptions): void;
+}
+export {};

package/build/internal/src/client/proxy.d.ts

@@ -0,0 +1,15 @@
+import { CommandBarProxyGlobal } from './CommandBarProxySDK';
+/**
+ * Returns the "pre-boot" proxied SDK object, creating it if necessary. This object might actually be a full SDK if it
+ * was already upgraded using `initSDK`. In either case, the returned object will _not_ itself be a proxy.
+ *
+ * The proxy SDK will only be created if one of the following hold:
+ * - window.CommandBar === undefined
+ * - window.CommandBar[_disposed] === true
+ * - window.CommandBar.disposed === true
+ *
+ * Otherwise the existing value of `window.CommandBar` is returned, whatever that may be.
+ */
+export declare function getProxySDK(): CommandBarProxyGlobal;
+/** Replaces `window.CommandBar` with a new Proxy SDK object. */
+export declare function initProxySDK(): void;

package/build/internal/src/client/symbols.d.ts

@@ -0,0 +1,27 @@
+export declare const _access: unique symbol;
+export declare const _configuration: unique symbol;
+export declare const _configure: unique symbol;
+export declare const _configUser: unique symbol;
+export declare const _dispatch: unique symbol;
+export declare const _dispose: unique symbol;
+export declare const _disposed: unique symbol;
+export declare const _eventMeta: unique symbol;
+export declare const _isProxy: unique symbol;
+export declare const _loadEditor: unique symbol;
+export declare const _orgConfig: unique symbol;
+export declare const _perf: unique symbol;
+export declare const _programmaticTheme: unique symbol;
+export declare const _queue: unique symbol;
+export declare const _reloadCommands: unique symbol;
+export declare const _reloadOrganization: unique symbol;
+export declare const _report: unique symbol;
+export declare const _reporter: unique symbol;
+export declare const _search: unique symbol;
+export declare const _setDashboard: unique symbol;
+export declare const _setPreviewMode: unique symbol;
+export declare const _setTestMode: unique symbol;
+export declare const _showGuide: unique symbol;
+export declare const _showMessage: unique symbol;
+export declare const _state: unique symbol;
+export declare const _unwrap: unique symbol;
+export declare const _user: unique symbol;