commandbar 1.7.1 → 1.7.3

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

@@ -4,7 +4,8 @@ import { BatchEditorCommandResponseV, BatchOperationV, CommandV, HelpSyncCommand
 import { ArgumentMapV, ArgumentTypeV, ConditionV, ConditionOperatorV, StepArgumentTypeV, ContextArgumentV, SetArgumentV, DynamicArgumentV, DependentArgumentV, FunctionArgumentV } from './helpers/argument';
 import { GenericBatchRequest } from './generics';
 import { OptionGroupRenderAsV } from './helpers/optionGroup';
-import { TemplateV, TemplateOptionsV, RequestTemplateV, RequestV } from './helpers/commandTemplate';
+import { TemplateV, TemplateOptionsV, RequestTemplateV } from './helpers/commandTemplate';
+import { RequestV } from './helpers/actions';
 import { CommandCategoryV } from './commandCategory';
 import { OrganizationStatusV, KeyEventV, ResourceSettingsByContextKeyV, InternalSettingsV, OrganizationSettingsV } from './organization';
 import { UserV } from './user';
@@ -19,9 +20,18 @@ import { ProfileV } from './profile';
 import { PlaceholderV } from './placeholder';
 import { EnvReleaseInfoV, ReleaseStepV, ReleaseV } from './releases';
 import { EnvironmentV } from './environment';
-import { NudgeV } from './nudge';
+import { NudgeContentBlockV, NudgeContentButtonBlockV, NudgeContentHelpDocBlockV, NudgeContentImageBlockV, NudgeContentMarkdownBlockV, NudgeContentVideoBlockV, NudgeStepV, NudgeV, OldNudgeV } from './nudge';
 import { TabV } from './tab';
 import { RuleExpressionAndV, RuleExpressionOrV, RuleExpressionV } from './helpers/rules';
+import { ChecklistItemV, ChecklistV } from './checklist';
+import { DashboardFlagsV } from './dashboardFlags';
+/*******************************************************************************/
+export declare type IInitOptions = {
+    debug?: boolean;
+    environment?: string;
+    version?: string;
+    config?: IConfigEndpointResponse;
+};
 /*******************************************************************************/
 export declare type IContextType = t.TypeOf<typeof ContextV> & unknown;
 export declare type IUserType = t.TypeOf<typeof UserV> & unknown;
@@ -39,6 +49,7 @@ export declare type IHelpDocsIntegrationType = t.TypeOf<typeof HelpDocsIntegrati
 export type { IOrganizationType } from './OrganizationV';
 export declare type IOrganizationStatusType = t.TypeOf<typeof OrganizationStatusV> & unknown;
 export declare type IInternalSettingsType = t.TypeOf<typeof InternalSettingsV> & unknown;
+export declare type IDashboardFlagsType = t.TypeOf<typeof DashboardFlagsV> & unknown;
 export declare type ISkinType = t.TypeOf<typeof SkinV> & unknown;
 export declare type IProfileType = t.TypeOf<typeof ProfileV> & unknown;
 export declare type IOrganizationSettingsType = t.TypeOf<typeof OrganizationSettingsV> & unknown;
@@ -73,12 +84,22 @@ export declare type IDynamicArgumentType = t.TypeOf<typeof DynamicArgumentV> & u
 export declare type IDependentArgumentType = t.TypeOf<typeof DependentArgumentV> & unknown;
 export declare type IFunctionArgumentType = t.TypeOf<typeof FunctionArgumentV> & unknown;
 export declare type OptionGroupRenderAsType = t.TypeOf<typeof OptionGroupRenderAsV> & unknown;
+export declare type IOldNudgeType = t.TypeOf<typeof OldNudgeV> & unknown;
 export declare type INudgeType = t.TypeOf<typeof NudgeV> & unknown;
-export interface INudgeClientType {
+export declare type INudgeStepType = t.TypeOf<typeof NudgeStepV> & unknown;
+export declare type INudgeStepContentBlockType = t.TypeOf<typeof NudgeContentBlockV> & unknown;
+export declare type INudgeStepContentMarkdownBlockType = t.TypeOf<typeof NudgeContentMarkdownBlockV> & unknown;
+export declare type INudgeStepContentImageBlockType = t.TypeOf<typeof NudgeContentImageBlockV> & unknown;
+export declare type INudgeStepContentVideoBlockType = t.TypeOf<typeof NudgeContentVideoBlockV> & unknown;
+export declare type INudgeStepContentHelpDocBlockType = t.TypeOf<typeof NudgeContentHelpDocBlockV> & unknown;
+export declare type INudgeStepContentButtonBlockType = t.TypeOf<typeof NudgeContentButtonBlockV> & unknown;
+export declare type INudgeClientType = {
     nudge: INudgeType;
-    active: boolean;
+    passedConditionsInLastEvaluation: boolean;
     lastTriggeredTs?: number;
-}
+};
+export declare type IChecklist = t.TypeOf<typeof ChecklistV> & unknown;
+export declare type IChecklistItem = t.TypeOf<typeof ChecklistItemV> & unknown;
 export interface ICommandInput {
     text: string;
     command: ICommandType;
@@ -94,6 +115,15 @@ export declare type IHistoryType = Array<{
 export interface IUserContext {
     [variable: string]: any;
 }
+export interface IEndUserAnalytics {
+    num_command_executions: number;
+    num_shortcut_command_executions: number;
+    num_sessions: number;
+    num_opens: number;
+    num_deadends: number;
+    first_seen_at: string;
+    last_seen_at: string;
+}
 export interface ICallbackMap {
     [variable: string]: (...args: any[]) => unknown;
 }
@@ -109,8 +139,10 @@ export declare type IConfigEndpointResponse = {
     organization: any;
     environments_with_versions?: any[];
     placeholders?: any[];
-    nudges?: INudgeType[];
+    nudges?: IOldNudgeType[];
+    nudges_v2?: INudgeType[];
     tabs?: ITabType[];
+    checklists?: IChecklist[];
 };
 export type { IResourceSettings } from './IResourceSettings';
 export declare type IResourceSettingsByContextKey = t.TypeOf<typeof ResourceSettingsByContextKeyV> & unknown;

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

@@ -5,10 +5,11 @@ export declare const UserV: t.IntersectionC<[t.TypeC<{
     token: t.StringC;
     email: t.StringC;
     organization: t.StringC;
+    organization_name: t.StringC;
     api_token: t.UnionC<[t.StringC, t.NullC]>;
     profile: t.NumberC;
     has_updated_password: t.BooleanC;
     is_active: t.BooleanC;
 }>, t.PartialC<{
-    atlas_hash: t.StringC;
+    intercom_hash: t.StringC;
 }>]>;

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

@@ -1,6 +1,6 @@
 declare const LocalStorage: {
     set: (label: string, value: string | boolean | number) => string | number | boolean;
-    get: (label: string, defaultValue: string | boolean | number) => string | number | boolean;
+    get: (label: string, defaultValue: string | boolean | number, prefixOverride?: string | undefined) => string | number | boolean;
     remove: (label: string) => void;
 };
 export default LocalStorage;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "commandbar",
-  "version": "1.7.1",
+  "version": "1.7.3",
   "description": "Javascript Utility for CommandBar",
   "main": "build/commandbar-js/src/index.js",
   "types": "build/commandbar-js/src/index.d.ts",
@@ -20,12 +20,11 @@
   "dependencies": {
     "commandbar-launcher": "^1.1.9",
     "fp-ts": "2.10.5",
-    "io-ts": "2.2.13",
-    "react-hot-toast": "^2.3.0"
+    "io-ts": "^2.2.14"
   },
   "devDependencies": {
     "rimraf": "3.0.2",
     "typescript": "4.6.2",
-    "webpack": "5.74.0"
+    "webpack": "^5.74.0"
   }
 }

package/src/init.ts

@@ -3,14 +3,7 @@ import 'es6-object-assign/auto';
 import 'es6-symbol/implement';
 import { getProxySDK } from '../../internal/src/client/proxy';
 import { _configuration } from '../../internal/src/client/symbols';
-import { IConfigEndpointResponse } from '../../internal/src/middleware/types';
-
-interface IInitOptions {
-  debug?: boolean;
-  environment?: string;
-  version?: string;
-  config?: IConfigEndpointResponse;
-}
+import { IInitOptions } from '../../internal/src/middleware/types';
 
 const getSrc = (org: string) => {
   let origin = 'https://api.commandbar.com';
@@ -58,7 +51,7 @@ const DEFAULT_OPTS = { debug: false };
  * 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#step-1:-install-commandbar).
+ * @param {string} org Your organization ID, which can be found [here](https://commandbar.com/docs/dev/installation).
  * @param {IInitOptions} [opts] Additional options to use for initialization: `debug` will enable additional logging, `environment` specifies the environment to load config from
  * output.
  */

package/src/snippet.ts

@@ -46,7 +46,7 @@ export const snippet = (org: string) => {
       w.CommandBar,
     );
 
-    const ASYNC_METHODS = ['addCommand', 'boot', 'addEventSubscriber'];
+    const ASYNC_METHODS_SNIPPET = ['addCommand', 'boot', 'addEventSubscriber', 'addRecordAction', 'setFormFactor'];
 
     const sdk = proxy;
 
@@ -58,7 +58,7 @@ export const snippet = (org: string) => {
     w.CommandBar = new Proxy(proxy, {
       get: function (_, prop) {
         if (prop in sdk) return proxy[prop];
-        if (ASYNC_METHODS.includes(prop as string)) {
+        if (ASYNC_METHODS_SNIPPET.includes(prop as string)) {
           return function () {
             // eslint-disable-next-line prefer-rest-params
             const a = Array.prototype.slice.call(arguments);

package/webpack.config.js

@@ -1,4 +1,5 @@
 const path = require('path');
+const { BundleAnalyzerPlugin } = require('webpack-bundle-analyzer');
 
 module.exports = {
   mode: 'production',
@@ -27,4 +28,8 @@ module.exports = {
     extensions: ['.ts', '.js', '.json', '.tsx'],
   },
   stats: 'minimal',
+  plugins: [process.env.ENABLE_STATSFILE_GENERATION && new BundleAnalyzerPlugin({
+    analyzerMode: 'disabled',
+    generateStatsFile: true
+  })].filter(Boolean),
 };