commandbar 1.10.2 → 1.12.0

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "commandbar",
-  "version": "1.10.2",
+  "version": "1.12.0",
   "description": "Javascript Utility for CommandBar",
   "main": "build/commandbar-js/src/index.js",
   "types": "build/commandbar-js/src/index.d.ts",
   "sideEffects": false,
   "scripts": {
     "clean": "rimraf build",
-    "build": "NODE_ENV=production webpack build && tsc",
-    "minify-snippet": "ts-node scripts/minify-snippet.ts",
+    "build": "NODE_ENV=production webpack build && tsc && tsc-alias",
+    "minify-snippet": "tsx scripts/minify-snippet.ts",
     "prepublishOnly": "yarn run clean && yarn run build",
     "test": "jest --runInBand",
     "test:watch": "jest --watch --verbose false --silent false",
@@ -23,7 +23,12 @@
     "io-ts": "^2.2.14"
   },
   "devDependencies": {
+    "@types/jest": "^29.5.3",
+    "jest": "^29.7.0",
     "rimraf": "3.0.2",
+    "tsc-alias": "^1.8.8",
+    "tsconfig-paths-webpack-plugin": "^4.1.0",
+    "tsx": "^4.9.3",
     "typescript": "5.1.5",
     "webpack": "^5.74.0"
   }

package/src/index.ts

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

package/src/init.ts

@@ -5,15 +5,19 @@ import { getProxySDK } from '../../internal/src/client/proxy';
 import { _configuration } from '../../internal/src/client/symbols';
 import { IInitOptions } from '../../internal/src/middleware/types';
 
-const getSrc = (org: string, nonce?: string) => {
-  let origin = 'https://api.commandbar.com';
+const getSrc = (org: string, opts: IInitOptions) => {
+  let origin = opts.apiOrigin || 'https://api.commandbar.com';
   const params = [];
 
   const lc = localStorage.getItem('commandbar.lc');
-  if (lc && lc.includes('local')) {
+  if (lc && lc.includes('api=local')) {
     // for debugging purposes
     origin = 'http://localhost:8000';
   }
+  if (lc && lc.includes('api=preview_')) {
+    const branchIdentifier = /api=preview_([^;$]+)/.exec(lc)?.[1];
+    origin = `https://${branchIdentifier}.commandbar.xyz:8000`;
+  }
 
   let src = origin + '/latest/' + org;
 
@@ -21,8 +25,16 @@ const getSrc = (org: string, nonce?: string) => {
     params.push('lc=' + lc);
   }
 
-  if (nonce) {
-    params.push('nonce=' + encodeURIComponent(nonce));
+  if (opts.nonce) {
+    params.push('nonce=' + encodeURIComponent(opts.nonce));
+  }
+
+  if (opts.silentMode) {
+    params.push('silent=true');
+  }
+
+  if (opts.cdnOrigin) {
+    params.push('cdn=' + encodeURIComponent(opts.cdnOrigin));
   }
 
   const version = 2;
@@ -32,14 +44,14 @@ const getSrc = (org: string, nonce?: string) => {
   return src;
 };
 
-const loadLatest = (org: string, nonce?: string) => {
+const loadLatest = (org: string, opts: IInitOptions) => {
   if (document.readyState !== 'complete') {
     // NOTE: `once` is not supported by IE11 and this will cause a (minor!) memory leak.
-    window.addEventListener('load', loadLatest.bind(null, org, nonce), { capture: false, once: true });
+    window.addEventListener('load', loadLatest.bind(null, org, opts), { capture: false, once: true });
     return;
   }
 
-  const src = getSrc(org, nonce);
+  const src = getSrc(org, opts);
 
   const el = document.createElement('script');
   el.type = 'text/javascript';
@@ -48,7 +60,10 @@ const loadLatest = (org: string, nonce?: string) => {
   document.head.appendChild(el);
 };
 
-const DEFAULT_OPTS = { debug: false };
+const DEFAULT_OPTS = {
+  debug: false,
+  silentMode: false,
+} as const;
 
 /**
  * Initializes CommandBar and injects the scripts required to load it into the <head> of the document. After calling
@@ -76,14 +91,17 @@ const init = (org: string, opts: IInitOptions = DEFAULT_OPTS) => {
   config.debug && console.log('CommandBar init...', { environment: opts.environment, version: opts.version });
 
   getProxySDK()[_configuration] = {
+    api: config.apiOrigin,
+    cdn: config.cdnOrigin,
     uuid: org,
-    environment: opts.environment,
-    version: opts.version,
-    config: opts.config, // TODO: We should update this type to correctly reflect the structure of the response from /config/ https://cmd-k.slack.com/archives/C0315KNU7FY/p1711558822136239?thread_ts=1711554558.063509&cid=C0315KNU7FY
-    nonce: opts.nonce,
+    environment: config.environment,
+    version: config.version,
+    config: config.config, // TODO: We should update this type to correctly reflect the structure of the response from /config/ https://cmd-k.slack.com/archives/C0315KNU7FY/p1711558822136239?thread_ts=1711554558.063509&cid=C0315KNU7FY
+    nonce: config.nonce,
+    silent: config.silentMode,
   };
 
-  loadLatest(org, opts.nonce);
+  loadLatest(org, config);
 };
 
 export default init;

package/src/snippet.ts

@@ -2,94 +2,104 @@
 /* eslint-disable prefer-rest-params */
 
 /* eslint-disable @typescript-eslint/no-inferrable-types */
-export const snippet = (org: string) => {
-  const polyfills = ['Object.assign', 'Symbol', 'Symbol.for'].join('%2C');
-  const w = window as unknown as Record<string, unknown>;
+const org = '<org_id>';
+let api = 'https://api.commandbar.com';
+let cdn: string | undefined = undefined;
 
-  function loadScript(src: string, async = false) {
-    if (document.readyState !== 'complete') {
-      window.addEventListener('load', loadScript.bind(null, src, async), { capture: false, once: true });
-    }
-    const el = document.createElement('script');
-    el.type = 'text/javascript';
-    el.async = async;
-    el.src = src;
-    document.head.appendChild(el);
+const polyfills = ['Object.assign', 'Symbol', 'Symbol.for'].join('%2C');
+const w = window as unknown as Record<string, unknown>;
+
+function loadScript(src: string, async = false) {
+  if (document.readyState !== 'complete') {
+    window.addEventListener('load', loadScript.bind(null, src, async), { capture: false, once: true });
   }
+  const el = document.createElement('script');
+  el.type = 'text/javascript';
+  el.async = async;
+  el.src = src;
+  document.head.appendChild(el);
+}
+
+function bootstrap() {
+  if (w.CommandBar !== undefined) return;
+  delete w.__CommandBarBootstrap__;
 
-  function bootstrap() {
-    if (w.CommandBar !== undefined) return;
-    delete w.__CommandBarBootstrap__;
+  const _configuration = Symbol.for('CommandBar::configuration');
+  const _disposed = Symbol.for('CommandBar::disposed');
+  const _isProxy = Symbol.for('CommandBar::isProxy');
+  const _queue = Symbol.for('CommandBar::queue');
+  const _unwrap = Symbol.for('CommandBar::unwrap');
+  const _eventSubscriptions = Symbol.for('CommandBar::eventSubscriptions');
 
-    const _configuration = Symbol.for('CommandBar::configuration');
-    const _orgConfig = Symbol.for('CommandBar::orgConfig');
-    const _disposed = Symbol.for('CommandBar::disposed');
-    const _isProxy = Symbol.for('CommandBar::isProxy');
-    const _queue = Symbol.for('CommandBar::queue');
-    const _unwrap = Symbol.for('CommandBar::unwrap');
-    const _eventSubscriptions = Symbol.for('CommandBar::eventSubscriptions');
+  const params = [];
+  const lc = localStorage.getItem('commandbar.lc');
 
-    const params = [];
-    const lc = localStorage.getItem('commandbar.lc');
-    const origin = lc && lc.includes('local') ? 'http://localhost:8000' : 'https://api.commandbar.com';
+  if (lc && lc.includes('local')) {
+    api = 'http://localhost:8000';
+    cdn = undefined;
+  }
+  if (lc && lc.includes('api=preview_')) {
+    const branchIdentifier = /api=preview_([^;$]+)/.exec(lc)?.[1];
+    api = `https://${branchIdentifier}.commandbar.xyz:8000`;
+    cdn = undefined;
+  }
 
-    const proxy = Object.assign(
-      {
-        [_configuration]: { uuid: org },
-        [_orgConfig]: {},
-        [_disposed]: false,
-        [_isProxy]: true,
-        [_queue]: new Array<unknown>(),
-        [_unwrap]: () => proxy,
-        [_eventSubscriptions]: undefined,
-      },
-      w.CommandBar,
-    );
+  const proxy = Object.assign(
+    {
+      [_configuration]: { uuid: org, api, cdn },
+      [_disposed]: false,
+      [_isProxy]: true,
+      [_queue]: new Array<unknown>(),
+      [_unwrap]: () => proxy,
+      [_eventSubscriptions]: undefined,
+    },
+    w.CommandBar,
+  );
 
-    const ASYNC_METHODS_SNIPPET = ['addCommand', 'boot', 'addEventSubscriber', 'addRecordAction', 'setFormFactor'];
+  const ASYNC_METHODS_SNIPPET = ['addCommand', 'boot', 'addEventSubscriber', 'addRecordAction', 'setFormFactor'];
 
-    const sdk = proxy;
+  const sdk = proxy;
 
-    Object.assign(proxy, {
-      shareCallbacks: () => ({}),
-      shareContext: () => ({}),
-    });
+  Object.assign(proxy, {
+    shareCallbacks: () => ({}),
+    shareContext: () => ({}),
+  });
 
-    w.CommandBar = new Proxy(proxy, {
-      get: function (_, prop) {
-        if (prop in sdk) return proxy[prop];
-        if ((prop as any) === 'then') return undefined;
-        if (ASYNC_METHODS_SNIPPET.includes(prop as string)) {
-          return function () {
-            // eslint-disable-next-line prefer-rest-params
-            const a = Array.prototype.slice.call(arguments);
-            return new Promise((resolve, reject) => {
-              a.unshift(prop, resolve, reject);
-              (proxy[_queue] as Array<unknown>).push(a);
-            });
-          };
-        }
+  w.CommandBar = new Proxy(proxy, {
+    get: function (_, prop) {
+      if (prop in sdk) return proxy[prop];
+      if ((prop as any) === 'then') return undefined;
+      if (ASYNC_METHODS_SNIPPET.includes(prop as string)) {
         return function () {
           // eslint-disable-next-line prefer-rest-params
           const a = Array.prototype.slice.call(arguments);
-          a.unshift(prop);
-          (proxy[_queue] as Array<unknown>).push(a);
+          return new Promise((resolve, reject) => {
+            a.unshift(prop, resolve, reject);
+            (proxy[_queue] as Array<unknown>).push(a);
+          });
         };
-      },
-    });
+      }
+      return function () {
+        // eslint-disable-next-line prefer-rest-params
+        const a = Array.prototype.slice.call(arguments);
+        a.unshift(prop);
+        (proxy[_queue] as Array<unknown>).push(a);
+      };
+    },
+  });
 
-    if (lc !== null) params.push(`lc=${lc}`);
-    params.push('version=2');
+  if (lc !== null) params.push(`lc=${lc}`);
+  params.push('version=2');
+  if (cdn) params.push(`cdn=${encodeURIComponent(cdn)}`);
 
-    loadScript(`${origin}/latest/${org}?${params.join('&')}`, true);
-  }
+  loadScript(`${api}/latest/${org}?${params.join('&')}`, true);
+}
 
-  if (typeof Object.assign === 'undefined' || typeof Symbol === 'undefined' || typeof Symbol.for === 'undefined') {
-    w.__CommandBarBootstrap__ = bootstrap;
-    loadScript(
-      'https://polyfill.io/v3/polyfill.min.js?version=3.101.0&callback=__CommandBarBootstrap__&features=' + polyfills,
-    );
-  } else {
-    bootstrap();
-  }
-};
+if (typeof Object.assign === 'undefined' || typeof Symbol === 'undefined' || typeof Symbol.for === 'undefined') {
+  w.__CommandBarBootstrap__ = bootstrap;
+  loadScript(
+    'https://polyfill.io/v3/polyfill.min.js?version=3.101.0&callback=__CommandBarBootstrap__&features=' + polyfills,
+  );
+} else {
+  bootstrap();
+}

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

@@ -1,5 +0,0 @@
-export interface OrgConfig {
-    name?: string;
-    silent?: boolean;
-    eventAttributeBlockList?: string[];
-}

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

@@ -1,37 +0,0 @@
-import * as t from 'io-ts';
-export declare const GuideV: t.IntersectionC<[t.TypeC<{
-    id: t.NumberC;
-    organization: t.StringC;
-    event: t.StringC;
-    nudge: t.StringC;
-    guidance: t.StringC;
-}>, t.PartialC<{}>]>;
-export declare class Guide {
-    static create: (object: {
-        id: number;
-        organization: string;
-        event: string;
-        nudge: string;
-        guidance: string;
-    } & {}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
-        id: number;
-        organization: string;
-        event: string;
-        nudge: string;
-        guidance: string;
-    } & {}>;
-    static update: (object: {
-        id: number;
-        organization: string;
-        event: string;
-        nudge: string;
-        guidance: string;
-    } & {}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
-        id: number;
-        organization: string;
-        event: string;
-        nudge: string;
-        guidance: string;
-    } & {}>;
-    static delete: (id: string | number, params?: Record<string, string> | undefined, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<void>;
-}