commandbar 1.8.6 → 1.9.0

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

@@ -5,7 +5,7 @@ import { ArgumentMapV, ArgumentTypeV, ConditionV, ConditionOperatorV, StepArgume
 import { GenericBatchRequest } from './generics';
 import { OptionGroupRenderAsV } from './helpers/optionGroup';
 import { TemplateV, TemplateOptionsV, RequestTemplateV } from './helpers/commandTemplate';
-import { ActionV, LabeledActionV, RequestV } from './helpers/actions';
+import { ActionV, CommandActionV, LabeledActionV, OpenChatActionV, NudgeActionV, QuestlistActionV, RequestV } from './helpers/actions';
 import { CommandCategoryV } from './commandCategory';
 import { OrganizationStatusV, KeyEventV, ResourceSettingsByContextKeyV, InternalSettingsV, OrganizationV } from './organization';
 import { OrganizationSettingsV } from './organizationSettings';
@@ -15,14 +15,13 @@ import { GuideV } from './guide';
 import { HistoryEventV } from './historyEvent';
 import { HelpDocSyncLogMessageV, HelpDocsSyncV } from './helpDocsSync';
 import { HelpDocsIntegrationV } from './helpDocsIntegration';
-import { EndUserV } from './helpers/endUser';
+import { EndUserStoreDataV, EndUserV, NudgeInteractionStateV, NudgeInteractionsV, QuestlistInteractionStateV, QuestlistInteractionsV, DecideResponseV } from './endUser';
 import { SkinV } from './skin';
 import { ProfileV } from './profile';
 import { PlaceholderV } from './placeholder';
 import { EnvReleaseInfoV, ReleaseStepV, ReleaseV } from './releases';
 import { EnvironmentV } from './environment';
-import { NudgeContentBlockV, NudgeContentButtonBlockV, NudgeContentHelpDocBlockV, NudgeContentImageBlockV, NudgeContentMarkdownBlockV, NudgeContentVideoBlockV, NudgeContentSurveyTextBlockV, NudgeContentSurveyRatingBlockV, NudgeStepV, NudgeV, OldNudgeV } from './nudge';
-import { InstantAnswerV } from './qaPair';
+import { NudgeContentBlockV, NudgeContentButtonBlockV, NudgeContentHelpDocBlockV, NudgeContentImageBlockV, NudgeContentMarkdownBlockV, NudgeContentVideoBlockV, NudgeContentSurveyTextBlockV, NudgeStepContentSurveyTextShortBlockTypeV, NudgeContentSurveyRatingBlockV, NudgeContentListBlockV, NudgeStepV, NudgeV, OldNudgeV, NudgeButtonActionV, NudgeConditionalActionV } from './nudge';
 import { TabV } from './tab';
 import { RuleExpressionAndV, RuleExpressionOrV, RuleExpressionV } from './helpers/rules';
 import { ChecklistItemV, ChecklistV } from './checklist';
@@ -31,9 +30,11 @@ import { PushTriggerV } from './helpers/pushTrigger';
 import { FrequencyLimitV } from './helpers/frequencyLimit';
 import { AudienceV } from './helpers/audience';
 import { AdditionalResourceV } from './additionalResource';
-import { EditorRecommendationSetV, RecommendationSetV } from './recommendationSet';
-import { UsageV } from './billing';
-import { UserMessageV, AIMessageV, MessageV } from './chatAnalytics';
+import { RecommendationSetV } from './recommendationSet';
+import { BillingProfileV, UsageV } from './billing';
+import { UserMessageV, AIMessageV, MessageV, AIAnswerPayloadV, AIAnswerV, ContinuationsPayloadV, ContinuationV, CreateAnswerFeedbackPayloadV, QuestionSuggestionsPayloadV, QuestionSuggestionsV, ExperienceV, CreateChatPayloadV } from './chat';
+import { HelpDocHitV, SearchHelpDocsPayloadV, SearchHelpDocsResponseV } from './helpDocsSearch';
+import { HelpHubLauncherSettingsV } from './helpHub';
 /*******************************************************************************/
 export type IInitOptions = {
     debug?: boolean;
@@ -41,6 +42,12 @@ export type IInitOptions = {
     version?: string;
     config?: IConfigEndpointResponse;
 };
+/** Additional foobar init options */
+export declare const SUPPORTED_FOOBAR_INIT_DEPLOYMENT_OPTIONS: readonly ["labs", "prod"];
+export type IInitOptionsFoobar = IInitOptions & {
+    deployment?: (typeof SUPPORTED_FOOBAR_INIT_DEPLOYMENT_OPTIONS)[number];
+    disable_analytics?: boolean;
+};
 /*******************************************************************************/
 export type IContextType = t.TypeOf<typeof ContextV> & unknown;
 export type IUserType = t.TypeOf<typeof UserV> & unknown;
@@ -58,6 +65,7 @@ export type IHistoryEventType = t.TypeOf<typeof HistoryEventV> & unknown;
 export type IHelpDocsSyncType = t.TypeOf<typeof HelpDocsSyncV> & unknown;
 export type IHelpDocsSyncLogMessageType = t.TypeOf<typeof HelpDocSyncLogMessageV> & unknown;
 export type IHelpDocsIntegrationType = t.TypeOf<typeof HelpDocsIntegrationV> & unknown;
+export type IHelpHubLauncherSettingsType = t.TypeOf<typeof HelpHubLauncherSettingsV> & unknown;
 export type IOrganizationType = t.TypeOf<typeof OrganizationV> & unknown;
 export type IOrganizationStatusType = t.TypeOf<typeof OrganizationStatusV> & unknown;
 export type IInternalSettingsType = t.TypeOf<typeof InternalSettingsV> & unknown;
@@ -86,7 +94,6 @@ export type ITemplate = t.TypeOf<typeof TemplateV> & unknown;
 export type RequestTemplateType = t.TypeOf<typeof RequestTemplateV> & unknown;
 export type RequestType = t.TypeOf<typeof RequestV> & unknown;
 export type ITemplateOptions = t.TypeOf<typeof TemplateOptionsV> & unknown;
-export type IEndUserType = t.TypeOf<typeof EndUserV> & unknown;
 export type IRuleExpression = t.TypeOf<typeof RuleExpressionV> & unknown;
 export type IRuleExpressionAnd = t.TypeOf<typeof RuleExpressionAndV> & unknown;
 export type IRuleExpressionOr = t.TypeOf<typeof RuleExpressionOrV> & unknown;
@@ -108,30 +115,24 @@ export type INudgeStepContentImageBlockType = t.TypeOf<typeof NudgeContentImageB
 export type INudgeStepContentVideoBlockType = t.TypeOf<typeof NudgeContentVideoBlockV> & unknown;
 export type INudgeStepContentHelpDocBlockType = t.TypeOf<typeof NudgeContentHelpDocBlockV> & unknown;
 export type INudgeStepContentSurveyTextBlockType = t.TypeOf<typeof NudgeContentSurveyTextBlockV> & unknown;
+export type INudgeStepContentSurveyTextShortBlockType = t.TypeOf<typeof NudgeStepContentSurveyTextShortBlockTypeV> & unknown;
 export type INudgeContentSurveyRatingBlockType = t.TypeOf<typeof NudgeContentSurveyRatingBlockV> & unknown;
+export type INudgeContentListBlock = t.TypeOf<typeof NudgeContentListBlockV> & unknown;
 export type INudgeStepContentButtonBlockType = t.TypeOf<typeof NudgeContentButtonBlockV> & unknown;
+export type INudgeButtonAction = t.TypeOf<typeof NudgeButtonActionV> & unknown;
+export type INudgeButtonConditionalAction = t.TypeOf<typeof NudgeConditionalActionV> & unknown;
 export type INudgeClientType = {
     nudge: INudgeType;
     passedConditionsInLastEvaluation: boolean;
     lastTriggeredTs?: number;
 };
 export type LabeledAction = t.TypeOf<typeof LabeledActionV> & unknown;
+export type OpenChatAction = t.TypeOf<typeof OpenChatActionV> & unknown;
+export type QuestlistAction = t.TypeOf<typeof QuestlistActionV> & unknown;
+export type NudgeAction = t.TypeOf<typeof NudgeActionV> & unknown;
+export type CommandAction = t.TypeOf<typeof CommandActionV> & unknown;
 export type Action = t.TypeOf<typeof ActionV> & unknown;
-export type IBillingProfile = {
-    organization: string;
-    price_cents: number;
-    tier: string;
-    discount_cents: number;
-    name: string;
-    invoice_description: string;
-    customer_id: string | null;
-    publishable_key: string;
-    balance: number | null;
-    currency: string | null;
-    on_free_trial: boolean;
-    free_trial_end_date: string | null;
-    appsumo_invoice_item_id: string | null;
-};
+export type IBillingProfile = t.TypeOf<typeof BillingProfileV> & unknown;
 export type IChecklist = t.TypeOf<typeof ChecklistV> & {
     _editorState?: {
         timestamp?: number;
@@ -140,10 +141,25 @@ export type IChecklist = t.TypeOf<typeof ChecklistV> & {
     };
 } & unknown;
 export type IChecklistItem = t.TypeOf<typeof ChecklistItemV> & unknown;
-export type IInstantAnswerType = t.TypeOf<typeof InstantAnswerV> & unknown;
+export type ChecklistInteractionState = t.TypeOf<typeof QuestlistInteractionStateV> & unknown;
+export type ChecklistInteractions = t.TypeOf<typeof QuestlistInteractionsV> & unknown;
+export type NudgeInteractionState = t.TypeOf<typeof NudgeInteractionStateV> & unknown;
+export type NudgeInteractions = t.TypeOf<typeof NudgeInteractionsV> & unknown;
 export type IMessageType = t.TypeOf<typeof MessageV> & unknown;
 export type IUserMessageType = t.TypeOf<typeof UserMessageV> & unknown;
 export type IAIMessageType = t.TypeOf<typeof AIMessageV> & unknown;
+export type IQuestionSuggestionsType = t.TypeOf<typeof QuestionSuggestionsV> & unknown;
+export type IQuestionSuggestionsPayloadType = t.TypeOf<typeof QuestionSuggestionsPayloadV> & unknown;
+export type ICreateChatPayloadType = t.TypeOf<typeof CreateChatPayloadV> & unknown;
+export type IContinuationType = t.TypeOf<typeof ContinuationV> & unknown;
+export type IExperienceType = t.TypeOf<typeof ExperienceV> & unknown;
+export type IContinuationsPayloadType = t.TypeOf<typeof ContinuationsPayloadV> & unknown;
+export type IAIAnswerType = t.TypeOf<typeof AIAnswerV> & unknown;
+export type IAIAnswerPayloadType = t.TypeOf<typeof AIAnswerPayloadV> & unknown;
+export type ICreateAnswerFeedbackPayloadType = t.TypeOf<typeof CreateAnswerFeedbackPayloadV> & unknown;
+export type ISearchHelpDocsPayloadType = t.TypeOf<typeof SearchHelpDocsPayloadV> & unknown;
+export type ISearchHelpDocsResponseType = t.TypeOf<typeof SearchHelpDocsResponseV> & unknown;
+export type IHelpDocHitType = t.TypeOf<typeof HelpDocHitV> & unknown;
 export interface ICommandInput {
     text: string;
     command: ICommandType;
@@ -162,6 +178,9 @@ export interface IUserContext {
 export interface IUserRemoteProperties {
     [variable: string]: any;
 }
+export type IEndUserType = t.TypeOf<typeof EndUserV> & unknown;
+export type IEndUserStoreData = t.TypeOf<typeof EndUserStoreDataV> & unknown;
+export type IDecideResponseType = t.TypeOf<typeof DecideResponseV> & unknown;
 export interface IEndUserAnalytics {
     num_command_executions: number;
     num_shortcut_command_executions: number;
@@ -182,7 +201,6 @@ export interface IResourceType extends IUserContext {
 }
 export type IAdditionalResource = t.TypeOf<typeof AdditionalResourceV> & unknown;
 export type IRecommendationSet = t.TypeOf<typeof RecommendationSetV> & unknown;
-export type IEditorRecommendationSet = t.TypeOf<typeof EditorRecommendationSetV> & unknown;
 export type IConfigEndpointResponse = {
     commands: any[];
     categories: any[];

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

@@ -1,12 +1,14 @@
+import { INudgeType } from '../middleware/types';
 export type TUpdateEditorRouteDetails = {
     type: 'nudge';
+    nudge: INudgeType;
     nudgeId: string | number;
     stepId: string | number;
 } | {
     type: 'checklist';
     checklistId: string | number;
 } | {
-    type: 'theme';
+    type: 'route';
     route_replacement: 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,13 @@
+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: number;
+export declare const EDITOR_MOBILE_PREVIEW_SCREEN_WIDTH: number;
+export declare const EDITOR_MOBILE_PREVIEW_TOP_BAR_HEIGHT = 48;
+export declare const EDITOR_MOBILE_PREVIEW_BOTTOM_BAR_HEIGHT = 48;
+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,24 +1,24 @@
 {
   "name": "commandbar",
-  "version": "1.8.6",
+  "version": "1.9.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": "",
   "license": "ISC",
   "dependencies": {
-    "commandbar-launcher": "^1.1.9",
+    "commandbar-launcher": "^1.1.10",
     "fp-ts": "2.10.5",
     "io-ts": "^2.2.14"
   },

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 {};