@artsy/cohesion 4.376.0 → 4.377.0--canary.722.15410.0

package/dist/Schema/index.d.ts

@@ -59,6 +59,7 @@ export * from "./os/Events/InstagramEditor";
 export * from "./os/Events/InventoryTable";
 export * from "./os/Events/MaterialsEditor";
 export * from "./os/Events/MultiAddFlow";
+export * from "./os/Events/OnboardingFlow";
 export * from "./os/Events/Submit";
 export * from "./os/Events/Toggle";
 export * from "./os/Values/OsContextModule";

package/dist/Schema/index.js

@@ -628,6 +628,18 @@ Object.keys(_MultiAddFlow).forEach(function (key) {
   });
 });
 
+var _OnboardingFlow = require("./os/Events/OnboardingFlow");
+
+Object.keys(_OnboardingFlow).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _OnboardingFlow[key];
+    }
+  });
+});
+
 var _Submit = require("./os/Events/Submit");
 
 Object.keys(_Submit).forEach(function (key) {

package/dist/Schema/os/Events/OnboardingFlow.d.ts

@@ -0,0 +1,76 @@
+/**
+ * Schemas describing Art OS Onboarding Flow events
+ * @packageDocumentation
+ */
+import { OsContextModule } from "../Values/OsContextModule";
+import { OsOwnerType } from "../Values/OsOwnerType";
+import { OsActionType } from "./index";
+/**
+ * A partner clicks the "Show me how" link on a Getting Started checklist step
+ * to open the guidance for that step.
+ *
+ * @example
+ * ```
+ * {
+ *   action: "clickedShowMeHow",
+ *   context_module: "onboardingFlow",
+ *   context_page_owner_type: "inventory",
+ *   step: "create an artwork"
+ * }
+ * ```
+ */
+export interface ClickedShowMeHow {
+    action: OsActionType.clickedShowMeHow;
+    context_module: OsContextModule.onboardingFlow;
+    context_page_owner_type: OsOwnerType.collection | OsOwnerType.inventory;
+    step: string;
+}
+/**
+ * Fires when the partner completes the final remaining step of the Getting Started
+ * checklist — the "🎉 You're all set!" moment (10 of 10). If the checklist gains
+ * steps later, completion recomputes and this event may re-fire when the new full
+ * set is completed.
+ *
+ * @example
+ * ```
+ * {
+ *   action: "completedOnboarding",
+ *   context_module: "onboardingFlow",
+ *   context_page_owner_type: "inventory",
+ *   total_steps: 10
+ * }
+ * ```
+ */
+export interface CompletedGettingStarted {
+    action: OsActionType.completedOnboarding;
+    context_module: OsContextModule.onboardingFlow;
+    context_page_owner_type: OsOwnerType.collection | OsOwnerType.inventory;
+    total_steps: number;
+}
+/**
+ * Fires each time a Getting Started checklist item is auto-ticked (step completed).
+ * Records which step finished and how far the partner has progressed.
+ * Onboarding is tracked per-user, not per-gallery.
+ *
+ * @example
+ * ```
+ * {
+ *   action: "progressedOnboarding",
+ *   completed_step_count: 3,
+ *   context_module: "onboardingFlow",
+ *   context_page_owner_type: "inventory",
+ *   step: "create an artwork",
+ *   total_steps: 10
+ * }
+ * ```
+ */
+export interface ProgressedGettingStarted {
+    action: OsActionType.progressedOnboarding;
+    completed_step_count: number;
+    context_module: OsContextModule.onboardingFlow;
+    context_page_owner_type: OsOwnerType.collection | OsOwnerType.inventory;
+    /** Lower-case label matching UI copy (e.g. "create an artwork"). Typed as `string` because steps are backend-defined and expected to evolve. */
+    step: string;
+    total_steps: number;
+}
+export type OsOnboardingFlow = ClickedShowMeHow | CompletedGettingStarted | ProgressedGettingStarted;

package/dist/Schema/os/Events/OnboardingFlow.js

@@ -0,0 +1 @@
+"use strict";

package/dist/Schema/os/Events/__tests__/OnboardingFlow.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/Schema/os/Events/index.d.ts

@@ -6,6 +6,7 @@ import { OsInstagramEditor } from "./InstagramEditor";
 import { OsInventoryTable } from "./InventoryTable";
 import { OsMaterialsEditor } from "./MaterialsEditor";
 import { OsMultiAddFlow } from "./MultiAddFlow";
+import { OsOnboardingFlow } from "./OnboardingFlow";
 import { OsSubmitEvent } from "./Submit";
 import { OsToggleEvent } from "./Toggle";
 /**
@@ -13,7 +14,7 @@ import { OsToggleEvent } from "./Toggle";
  *
  * Each event describes one ActionType
  */
-export type OsEvent = OsMultiAddFlow | ClickedBrandKitColor | ClickedBrandKitFont | ClickedAddBrandKitFile | ClickedSaveBrandKit | OsConnectedAppsFlow | OsClickEvent | OsFilterSortSearch | OsInstagramEditor | OsInventoryTable | OsMaterialsEditor | OsSubmitEvent | OsToggleEvent;
+export type OsEvent = ClickedAddBrandKitFile | ClickedBrandKitColor | ClickedBrandKitFont | ClickedSaveBrandKit | OsClickEvent | OsConnectedAppsFlow | OsFilterSortSearch | OsInstagramEditor | OsInventoryTable | OsMaterialsEditor | OsMultiAddFlow | OsOnboardingFlow | OsSubmitEvent | OsToggleEvent;
 /**
  * List of all Art OS actions
  *
@@ -117,6 +118,10 @@ export declare enum OsActionType {
      * Corresponds to {@link OsInstagramEditor}
      */
     clickedPublishConfirmation = "clickedPublishConfirmation",
+    /**
+     * Corresponds to {@link ClickedShowMeHow}
+     */
+    clickedShowMeHow = "clickedShowMeHow",
     /**
      * Corresponds to {@link OsInstagramEditor}
      */
@@ -129,6 +134,10 @@ export declare enum OsActionType {
      * Corresponds to {@link CompletedArtworkImport}
      */
     completedArtworkImport = "completedArtworkImport",
+    /**
+     * Corresponds to {@link CompletedGettingStarted}
+     */
+    completedOnboarding = "completedOnboarding",
     /**
      * Corresponds to {@link ConvertedArtworkToUnique}
      */
@@ -181,6 +190,10 @@ export declare enum OsActionType {
      * Corresponds to {@link MovedArtworksBetweenLists}
      */
     movedArtworksBetweenLists = "movedArtworksBetweenLists",
+    /**
+     * Corresponds to {@link ProgressedGettingStarted}
+     */
+    progressedOnboarding = "progressedOnboarding",
     /**
      * Corresponds to {@link OsInventoryTable}
      */

package/dist/Schema/os/Events/index.js

@@ -45,9 +45,11 @@ exports.OsActionType = OsActionType;
   OsActionType["clickedImagesModal"] = "clickedImagesModal";
   OsActionType["clickedOpenList"] = "clickedOpenList";
   OsActionType["clickedPublishConfirmation"] = "clickedPublishConfirmation";
+  OsActionType["clickedShowMeHow"] = "clickedShowMeHow";
   OsActionType["clickedUploadImageBank"] = "clickedUploadImageBank";
   OsActionType["completedArtworkDistribution"] = "completedArtworkDistribution";
   OsActionType["completedArtworkImport"] = "completedArtworkImport";
+  OsActionType["completedOnboarding"] = "completedOnboarding";
   OsActionType["convertedArtworkToUnique"] = "convertedArtworkToUnique";
   OsActionType["createdEditionSet"] = "createdEditionSet";
   OsActionType["createdImportedArtworks"] = "createdImportedArtworks";
@@ -61,6 +63,7 @@ exports.OsActionType = OsActionType;
   OsActionType["editedArtworkField"] = "editedArtworkField";
   OsActionType["editedInventoryField"] = "editedInventoryField";
   OsActionType["movedArtworksBetweenLists"] = "movedArtworksBetweenLists";
+  OsActionType["progressedOnboarding"] = "progressedOnboarding";
   OsActionType["removedArtworkDocument"] = "removedArtworkDocument";
   OsActionType["removedFilter"] = "removedFilter";
   OsActionType["removedArtworksFromList"] = "removedArtworksFromList";

package/dist/Schema/os/Values/OsContextModule.d.ts

@@ -32,6 +32,7 @@ export declare enum OsContextModule {
     materialsEditor = "materialsEditor",
     multiAdd = "multiAdd",
     multiAddReview = "multiAddReview",
+    onboardingFlow = "onboardingFlow",
     publishConfirmationModal = "publishConfirmationModal",
     tableActions = "tableActions"
 }

package/dist/Schema/os/Values/OsContextModule.js

@@ -42,6 +42,7 @@ exports.OsContextModule = OsContextModule;
   OsContextModule["materialsEditor"] = "materialsEditor";
   OsContextModule["multiAdd"] = "multiAdd";
   OsContextModule["multiAddReview"] = "multiAddReview";
+  OsContextModule["onboardingFlow"] = "onboardingFlow";
   OsContextModule["publishConfirmationModal"] = "publishConfirmationModal";
   OsContextModule["tableActions"] = "tableActions";
 })(OsContextModule || (exports.OsContextModule = OsContextModule = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@artsy/cohesion",
-  "version": "4.376.0",
+  "version": "4.377.0--canary.722.15410.0",
   "description": "Analytics schema",
   "main": "dist/index.js",
   "publishConfig": {