commandbar 1.8.7 → 1.10.0

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

@@ -10,6 +10,7 @@ export declare const UserV: t.IntersectionC<[t.TypeC<{
     profile: t.NumberC;
     has_updated_password: t.BooleanC;
     is_active: t.BooleanC;
+    is_hijacked: t.BooleanC;
 }>, t.PartialC<{
     intercom_hash: t.StringC;
 }>]>;

package/build/internal/src/util/dispatchCustomEvent.d.ts

@@ -1,12 +1,14 @@
+import type { INudgeType } from '../middleware/types';
 export type TUpdateEditorRouteDetails = {
     type: 'nudge';
-    nudgeId: string | number;
-    stepId: string | number;
+    nudge: INudgeType;
+    stepIndex: number;
 } | {
     type: 'checklist';
     checklistId: string | number;
 } | {
-    type: 'theme';
+    type: 'route';
     route_replacement: string;
+    action?: string;
 };
 export declare function dispatchCustomEvent<T>(eventType: string, detail: T, canBubble?: boolean, cancelable?: boolean): CustomEvent<T>;

package/build/internal/src/util/operatingSystem.d.ts

@@ -0,0 +1,11 @@
+export type PlatformType = 'mac' | 'ios' | 'windows' | 'android' | 'linux';
+export type BrowserType = 'chrome' | 'firefox' | 'safari' | 'opera' | 'edge' | 'brave' | 'arc' | 'ie10' | 'ie11';
+export type DeviceType = 'mobile' | 'desktop';
+export declare const EDITOR_MOBILE_PREVIEW_SCREEN_HEIGHT = 932;
+export declare const EDITOR_MOBILE_PREVIEW_SCREEN_WIDTH = 430;
+export declare const isMobileDevice: () => boolean;
+export declare const getDeviceType: () => DeviceType;
+export declare const getBrowser: () => BrowserType | null;
+export declare const getOperatingSystem: () => PlatformType;
+export declare const getTriggerKey: (event: any) => any;
+export declare const osControlKey: (suffix?: string) => string;

package/build/internal/src/util/sentry.d.ts

@@ -0,0 +1,23 @@
+import React from 'react';
+import { Hub } from '@sentry/core';
+export declare const SENTRY_COMMANDBAR_DSN = "https://ebf252b62885436e858a66d157aee9ea@o451734.ingest.sentry.io/5608348";
+export declare const sentryHubFactory: (dsn: string) => Hub | undefined;
+export declare const initSentryAndAddToSdk: () => void;
+export declare const getSentry: () => Hub | undefined;
+export declare const startSentryTransaction: (context: import("@sentry/types").TransactionContext, customSamplingContext?: import("@sentry/types").CustomSamplingContext | undefined) => import("@sentry/browser").Transaction | null | undefined;
+interface Props {
+    children: React.ReactNode;
+}
+interface State {
+    hasError: boolean;
+}
+export declare class SentryErrorBoundary extends React.Component<Props, State> {
+    constructor(props: Props);
+    captureRejection: (ev: PromiseRejectionEvent) => void;
+    static getDerivedStateFromError(_error: Error): {
+        hasError: boolean;
+    };
+    componentDidCatch(error: Error, errorInfo: React.ErrorInfo): void;
+    render(): React.ReactNode;
+}
+export {};

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "commandbar",
-  "version": "1.8.7",
+  "version": "1.10.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": "webpack build && tsc",
+    "build": "NODE_ENV=production webpack build && tsc",
     "minify-snippet": "ts-node scripts/minify-snippet.ts",
     "prepublishOnly": "yarn run clean && yarn run build",
     "test": "jest --runInBand",
     "test:watch": "jest --watch --verbose false --silent false",
-    "watch": "scripts/watch.ts"
+    "watch": "NODE_ENV=development scripts/watch.ts"
   },
   "keywords": [],
   "author": "",

package/src/index.ts

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

package/src/init.ts

@@ -5,7 +5,7 @@ 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) => {
+const getSrc = (org: string, nonce?: string) => {
   let origin = 'https://api.commandbar.com';
   const params = [];
 
@@ -21,6 +21,10 @@ const getSrc = (org: string) => {
     params.push('lc=' + lc);
   }
 
+  if (nonce) {
+    params.push('nonce=' + nonce);
+  }
+
   const version = 2;
   params.push('version=' + version);
 
@@ -28,14 +32,14 @@ const getSrc = (org: string) => {
   return src;
 };
 
-const loadLatest = (org: string) => {
+const loadLatest = (org: string, nonce?: string) => {
   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), { capture: false, once: true });
+    window.addEventListener('load', loadLatest.bind(null, org, nonce), { capture: false, once: true });
     return;
   }
 
-  const src = getSrc(org);
+  const src = getSrc(org, nonce);
 
   const el = document.createElement('script');
   el.type = 'text/javascript';
@@ -75,9 +79,10 @@ const init = (org: string, opts: IInitOptions = DEFAULT_OPTS) => {
     uuid: org,
     environment: opts.environment,
     version: opts.version,
-    config: opts.config,
+    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
   };
-  loadLatest(org);
+
+  loadLatest(org, opts.nonce);
 };
 
 export default init;

package/src/snippet.ts

@@ -1,8 +1,6 @@
 /* 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');
@@ -29,6 +27,8 @@ export const snippet = (org: string) => {
     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 origin = lc && lc.includes('local') ? 'http://localhost:8000' : 'https://api.commandbar.com';

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

@@ -1 +0,0 @@
-export 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' | 'No results for query' | 'Command suggestion' | 'Command execution' | 'Unavailable shortcut' | 'Clicked branding' | 'Survey response' | 'Client-Error' | 'Internal-Error' | 'Internal-Event' | 'Sentry-Event' | 'User changed shortcut' | 'Preview shown' | 'Next step selected' | 'Preview link opened' | 'Preview engagement' | 'Nudge shown' | 'Nudge clicked' | 'Nudge completed' | 'Nudge dismissed' | 'Questlist shown' | 'Questlist engagement' | 'Questlist item engagement' | 'HelpHub opened' | 'HelpHub closed' | 'HelpHub doc opened' | 'HelpHub doc closed' | 'HelpHub doc engagement' | 'HelpHub engagement' | 'No chat response';

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

@@ -1,63 +0,0 @@
-import { IOrganizationType } from '../middleware/types';
-import { PublicDisposable } from '../util/Disposable';
-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;
-}
-declare enum Severity {
-    Fatal = "fatal",
-    Error = "error",
-    Warning = "warning",
-    Log = "log",
-    Info = "info",
-    Debug = "debug",
-    Critical = "critical"
-}
-export interface Breadcrumb {
-    type?: string;
-    level?: Severity;
-    event_id?: string;
-    category?: string;
-    message?: string;
-    data?: {
-        [key: string]: any;
-    };
-    timestamp?: number;
-    hint?: BreadcrumbHint;
-}
-export interface BreadcrumbHint {
-    [key: string]: any;
-}
-export declare abstract class SentryReporter implements PublicDisposable {
-    _disposed: boolean;
-    breadcrumb: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void;
-    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/middleware/IResourceSettings.d.ts

@@ -1,3 +0,0 @@
-import * as t from 'io-ts';
-import { ResourceSettingsV } from './ResourceSettingsV';
-export type IResourceSettings = t.TypeOf<typeof ResourceSettingsV> & unknown;