@hiver/connector-admin 4.19.0 → 4.19.1-appsEventTracking-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hiver/connector-admin",
-  "version": "4.19.0",
+  "version": "4.19.1-appsEventTracking-beta.1",
   "main": "index.es.js",
   "module": "index.es.js",
   "types": "index.d.ts",

package/v2/app/connectors/pages/api-view/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../src/v2/app/connectors/pages/api-view/index.tsx"],"names":[],"mappings":"AAgCA,eAAO,MAAM,OAAO,+CAgGnB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../src/v2/app/connectors/pages/api-view/index.tsx"],"names":[],"mappings":"AAkCA,eAAO,MAAM,OAAO,+CA0GnB,CAAC"}

package/v2/app/connectors/pages/initial-setup/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../src/v2/app/connectors/pages/initial-setup/index.tsx"],"names":[],"mappings":"AA2BA,eAAO,MAAM,YAAY,+CA8FxB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../src/v2/app/connectors/pages/initial-setup/index.tsx"],"names":[],"mappings":"AA6BA,eAAO,MAAM,YAAY,+CAmIxB,CAAC"}

package/v2/app/connectors/pages/settings/auth/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../src/v2/app/connectors/pages/settings/auth/index.tsx"],"names":[],"mappings":"AAqCA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAE9D,UAAU,YAAY;IACpB,aAAa,EAAE,iBAAiB,GAAG,IAAI,CAAC;CACzC;AAED,eAAO,MAAM,YAAY,sBAAuB,YAAY,4CA0Q3D,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../src/v2/app/connectors/pages/settings/auth/index.tsx"],"names":[],"mappings":"AAwCA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAE9D,UAAU,YAAY;IACpB,aAAa,EAAE,iBAAiB,GAAG,IAAI,CAAC;CACzC;AAED,eAAO,MAAM,YAAY,sBAAuB,YAAY,4CA8S3D,CAAC"}

package/v2/app/connectors/pages/settings/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../src/v2/app/connectors/pages/settings/index.tsx"],"names":[],"mappings":"AA6CA,eAAO,MAAM,QAAQ,+CAgJpB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../src/v2/app/connectors/pages/settings/index.tsx"],"names":[],"mappings":"AA+CA,eAAO,MAAM,QAAQ,+CAmKpB,CAAC"}

package/v2/constants/gainsight.d.ts

@@ -39,6 +39,32 @@ export declare const GAINSIGHTEVENT: {
     FIELD_MAP_BUTTON_CLICKED: string;
     FIELD_MAP_CONFIG_SAVED: string;
 };
+/**
+ * The Apps onboarding funnel. Separate event names rather than one event with a
+ * step param, because half of these are outcomes (`*_success` / `*_failure`)
+ * which are not page views and cannot be values of a `page` field.
+ *
+ * Every `*_viewed` event fires when its screen RENDERS, never on the click that
+ * navigates there — a click can be followed by a redirect or a failed fetch, and
+ * counting it would inflate every step above the one actually reached.
+ */
+export declare const APP_ONBOARDING_EVENTS: {
+    /** App overview screen (the api-view surface) rendered. */
+    readonly APP_OVERVIEW_VIEWED: "app_overview_viewed";
+    /** Marketplace auth screen rendered: /connector/settings/:id without isEdit. */
+    readonly MARKETPLACE_AUTH_PAGE_VIEWED: "marketplace_auth_page_viewed";
+    /** Inbox + role visibility screen rendered. */
+    readonly INITIAL_SETUP_VIEWED: "initial_setup_viewed";
+    readonly INITIAL_SETUP_SUCCESS: "initial_setup_success";
+    readonly INITIAL_SETUP_FAILURE: "initial_setup_failure";
+    /** Auth outcome. Carries setup_context to separate marketplace from installed. */
+    readonly AUTHENTICATION_SUCCESS: "authentication_success";
+    readonly AUTHENTICATION_FAILURE: "authentication_failure";
+    /** Post-install Settings tabs (?isEdit=true). */
+    readonly AUTHENTICATION_TAB_VIEWED: "authentication_tab_viewed";
+    readonly VISIBILITY_TAB_VIEWED: "visibility_tab_viewed";
+};
+export type AppOnboardingEvent = (typeof APP_ONBOARDING_EVENTS)[keyof typeof APP_ONBOARDING_EVENTS];
 export declare const GAINSIGHT_CONSTANTS: {
     AUTH_PAGE: string;
     DETAILS_PAGE: string;

package/v2/constants/gainsight.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"gainsight.d.ts","sourceRoot":"","sources":["../../../src/v2/constants/gainsight.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwC1B,CAAC;AAEF,eAAO,MAAM,mBAAmB;;;;CAI/B,CAAC"}
+{"version":3,"file":"gainsight.d.ts","sourceRoot":"","sources":["../../../src/v2/constants/gainsight.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwC1B,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,qBAAqB;IAChC,2DAA2D;;IAE3D,gFAAgF;;IAEhF,+CAA+C;;;;IAI/C,kFAAkF;;;IAGlF,iDAAiD;;;CAGzC,CAAC;AAEX,MAAM,MAAM,kBAAkB,GAAG,CAAC,OAAO,qBAAqB,CAAC,CAAC,MAAM,OAAO,qBAAqB,CAAC,CAAC;AAEpG,eAAO,MAAM,mBAAmB;;;;CAI/B,CAAC"}

package/v2/hooks/__tests__/use-app-event.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=use-app-event.test.d.ts.map

package/v2/hooks/__tests__/use-app-event.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-app-event.test.d.ts","sourceRoot":"","sources":["../../../../src/v2/hooks/__tests__/use-app-event.test.tsx"],"names":[],"mappings":""}

package/v2/hooks/use-app-event.d.ts

@@ -0,0 +1,22 @@
+import { AppOnboardingEvent } from '../constants/gainsight';
+import { AppEventMetadata } from '../utils/app-event-metadata';
+interface IUseAppEventOnViewParams {
+    /** Which `*_viewed` event this screen is. */
+    event: AppOnboardingEvent;
+    /** Metadata from `buildAppEventMetadata`, plus anything page-specific. */
+    data?: AppEventMetadata;
+    /**
+     * False while the screen is not the one actually being shown — still fetching,
+     * about to redirect, or a tab that is mounted but hidden. Rules of hooks mean
+     * the hook is always called; this gates the emit instead.
+     */
+    enabled?: boolean;
+}
+export declare const useAppEventOnView: ({ event, data, enabled }: IUseAppEventOnViewParams) => void;
+/**
+ * Imperative sender for the outcome events. Returns a stable function, so it is
+ * safe in an effect's dependency array.
+ */
+export declare const useAppEventSender: () => (event: AppOnboardingEvent, data?: AppEventMetadata) => void;
+export {};
+//# sourceMappingURL=use-app-event.d.ts.map

package/v2/hooks/use-app-event.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-app-event.d.ts","sourceRoot":"","sources":["../../../src/v2/hooks/use-app-event.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AACnE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAwCtE,UAAU,wBAAwB;IAChC,6CAA6C;IAC7C,KAAK,EAAE,kBAAkB,CAAC;IAC1B,0EAA0E;IAC1E,IAAI,CAAC,EAAE,gBAAgB,CAAC;IACxB;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,eAAO,MAAM,iBAAiB,6BAAqC,wBAAwB,KAAG,IA+B7F,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,iBAAiB,gBAQlB,kBAAkB,SAAS,gBAAgB,SAStD,CAAC"}

package/v2/utils/__tests__/app-event-metadata.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=app-event-metadata.test.d.ts.map

package/v2/utils/__tests__/app-event-metadata.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-event-metadata.test.d.ts","sourceRoot":"","sources":["../../../../src/v2/utils/__tests__/app-event-metadata.test.ts"],"names":[],"mappings":""}

package/v2/utils/__tests__/get-pit-connector-stats.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=get-pit-connector-stats.test.d.ts.map

package/v2/utils/__tests__/get-pit-connector-stats.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-pit-connector-stats.test.d.ts","sourceRoot":"","sources":["../../../../src/v2/utils/__tests__/get-pit-connector-stats.test.ts"],"names":[],"mappings":""}

package/v2/utils/app-event-metadata.d.ts

@@ -0,0 +1,37 @@
+import { IConnectorDetails } from '../types/connector';
+/**
+ * Shared metadata for the Apps onboarding analytics events.
+ *
+ * Every one of these events answers "which app, in what state" before it answers
+ * anything else, so the same block rides on all of them and analysts can group
+ * across the funnel without joining back to the connectors collection.
+ *
+ * Two rules this file exists to enforce:
+ *
+ * 1. **Allow-list, never spread the row.** `IConnectorDetails` carries
+ *    `authDetails` — client secrets, tokens, API keys. Spreading a connector into
+ *    an analytics payload would ship credentials to a third party. Every field
+ *    below is named on purpose.
+ * 2. **Omit what is not known; never fabricate.** A template row has no
+ *    `isAuthenticated`/`isEnabled` because it is not installed yet, and an absent
+ *    key is honest where `false` would read as "installed but disabled".
+ */
+export interface IAppEventMetadataInput {
+    /** The `:id` in the URL — a template id pre-install, an install id post-install. */
+    id?: string;
+    /**
+     * Whether the page is looking at an installed connector (`?isEdit=true`) rather
+     * than a marketplace template. Drives both which id key is used and
+     * `setup_context`, the connector-vs-template identifier.
+     */
+    isEdit?: boolean;
+    /** The connector or template row the page already holds. */
+    row?: IConnectorDetails | null;
+    /** Install id when the page knows one independently of `:id` (initial setup). */
+    connectorId?: string | null;
+    /** Overrides `setup_context` for flows where `isEdit` is not the right signal. */
+    setupContext?: 'connector' | 'template';
+}
+export type AppEventMetadata = Record<string, string | number | boolean>;
+export declare const buildAppEventMetadata: ({ id, isEdit, row, connectorId, setupContext }: IAppEventMetadataInput) => AppEventMetadata;
+//# sourceMappingURL=app-event-metadata.d.ts.map

package/v2/utils/app-event-metadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-event-metadata.d.ts","sourceRoot":"","sources":["../../../src/v2/utils/app-event-metadata.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAE9D;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,sBAAsB;IACrC,oFAAoF;IACpF,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,4DAA4D;IAC5D,GAAG,CAAC,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAC/B,iFAAiF;IACjF,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,kFAAkF;IAClF,YAAY,CAAC,EAAE,WAAW,GAAG,UAAU,CAAC;CACzC;AAED,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;AAEzE,eAAO,MAAM,qBAAqB,mDAM/B,sBAAsB,KAAG,gBAuB3B,CAAC"}

package/v2/utils/index.d.ts

@@ -53,6 +53,7 @@ export declare const devLogger: {
 export declare const getPITConnectorStats: (connectorsObj: Record<string, IConnectorDetails>) => {
     total_authenticated_apps: number;
     total_enabled_apps: number;
+    total_apps_activated: number;
     total_apps_setup: number;
     apps_list: string;
     apps_auth_status: Record<string, boolean>;

package/v2/utils/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/v2/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAU5D,OAAO,KAAK,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AACxE,OAAO,KAAK,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAE/E,KAAK,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;AAEpD,wBAAgB,UAAU,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,MAAM,GAAG;IAAE,CAAC,CAAC,EAAE,MAAM,GAAG,CAAC,CAAA;CAAE,CAStF;AAED,wBAAgB,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,MAAM,YAEhE;AAED,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,CAQjH;AACD;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,sBAAuB,aAAa,2BAAoB,MAAM,YAM5F,CAAC;AAEF,eAAO,MAAM,aAAa,sBAAuB,aAAa,YAK7D,CAAC;AAEF,eAAO,MAAM,YAAY,sBAAuB,aAAa,YACG,CAAC;AAEjE,eAAO,MAAM,0BAA0B,sBAAuB,aAAa,YACP,CAAC;AAErE,eAAO,MAAM,cAAc,WAAY,MAAM,SAAS,MAAM,aAAa,MAAM,SAe9E,CAAC;AAoBF,eAAO,MAAM,QAAQ,aAAoB,MAAM,aAAa,CAAC,QAAQ,EAAE,OAAO,KAAK,IAAI,kBAWtF,CAAC;AAEF,eAAO,MAAM,0BAA0B,oBAAqB,MAAM,EAAE,YAGnE,CAAC;AAEF,eAAO,MAAM,YAAY,oBAAqB,MAAM,EAAE,YAGrD,CAAC;AAEF,eAAO,MAAM,aAAa,aAAc;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,WAIjE,CAAC;AAEF,eAAO,MAAM,UAAU,GAAI,CAAC,SAAS,MAAM,cAAc,CAAC,KAAK,EAAE,MAAM,KAAK,CAAC,KAAG,CAAC,EAEhF,CAAC;AAEF,eAAO,MAAM,mBAAmB,aAAc,MAAM,UAAU;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAA;CAAE,KAAG,MAElG,CAAC;AAEF,eAAO,MAAM,4BAA4B,sBACpB,kBAAkB,qBAClB,aAAa,YAMjC,CAAC;AAEF,eAAO,MAAM,WAAW,8BAGrB;IACD,SAAS,CAAC,EAAE,iBAAiB,CAAC;IAC9B,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,KAAG,iBAgBH,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,eAAe,SACnB,UAAU,cAAc,MAAM,eAC3B,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,EAAE,SAIrC,CAAC;AAEJ,eAAO,MAAM,SAAS;mBANV,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,EAAE;oBAA5B,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,EAAE;qBAA5B,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,EAAE;oBAA5B,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,EAAE;CAWvC,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,kBAAmB,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC;;;;;;;;CAuCpF,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/v2/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAU5D,OAAO,KAAK,EAAE,kBAAkB,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AACxE,OAAO,KAAK,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAE/E,KAAK,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;AAEpD,wBAAgB,UAAU,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,MAAM,GAAG;IAAE,CAAC,CAAC,EAAE,MAAM,GAAG,CAAC,CAAA;CAAE,CAStF;AAED,wBAAgB,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,MAAM,YAEhE;AAED,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,CAQjH;AACD;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,sBAAuB,aAAa,2BAAoB,MAAM,YAM5F,CAAC;AAEF,eAAO,MAAM,aAAa,sBAAuB,aAAa,YAK7D,CAAC;AAEF,eAAO,MAAM,YAAY,sBAAuB,aAAa,YACG,CAAC;AAEjE,eAAO,MAAM,0BAA0B,sBAAuB,aAAa,YACP,CAAC;AAErE,eAAO,MAAM,cAAc,WAAY,MAAM,SAAS,MAAM,aAAa,MAAM,SAe9E,CAAC;AAoBF,eAAO,MAAM,QAAQ,aAAoB,MAAM,aAAa,CAAC,QAAQ,EAAE,OAAO,KAAK,IAAI,kBAWtF,CAAC;AAEF,eAAO,MAAM,0BAA0B,oBAAqB,MAAM,EAAE,YAGnE,CAAC;AAEF,eAAO,MAAM,YAAY,oBAAqB,MAAM,EAAE,YAGrD,CAAC;AAEF,eAAO,MAAM,aAAa,aAAc;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,WAIjE,CAAC;AAEF,eAAO,MAAM,UAAU,GAAI,CAAC,SAAS,MAAM,cAAc,CAAC,KAAK,EAAE,MAAM,KAAK,CAAC,KAAG,CAAC,EAEhF,CAAC;AAEF,eAAO,MAAM,mBAAmB,aAAc,MAAM,UAAU;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAAA;CAAE,KAAG,MAElG,CAAC;AAEF,eAAO,MAAM,4BAA4B,sBACpB,kBAAkB,qBAClB,aAAa,YAMjC,CAAC;AAEF,eAAO,MAAM,WAAW,8BAGrB;IACD,SAAS,CAAC,EAAE,iBAAiB,CAAC;IAC9B,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,KAAG,iBAgBH,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,eAAe,SACnB,UAAU,cAAc,MAAM,eAC3B,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,EAAE,SAIrC,CAAC;AAEJ,eAAO,MAAM,SAAS;mBANV,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,EAAE;oBAA5B,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,EAAE;qBAA5B,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,EAAE;oBAA5B,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,EAAE;CAWvC,CAAC;AAEF;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,kBAAmB,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC;;;;;;;;;CA6CpF,CAAC"}