@artsy/cohesion 4.363.0 → 4.364.0--canary.707.14874.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1368,5 +1368,21 @@ export declare enum ActionType {
1368
1368
  /**
1369
1369
  * Corresponds to {@link VisitMyCollectionOnboardingSlide}
1370
1370
  */
1371
- visitMyCollectionOnboardingSlide = "visitMyCollectionOnboardingSlide"
1371
+ visitMyCollectionOnboardingSlide = "visitMyCollectionOnboardingSlide",
1372
+ /**
1373
+ * Corresponds to {@link ClickedBrandKitColor}
1374
+ */
1375
+ clickedBrandKitColor = "clickedBrandKitColor",
1376
+ /**
1377
+ * Corresponds to {@link ClickedBrandKitFont}
1378
+ */
1379
+ clickedBrandKitFont = "clickedBrandKitFont",
1380
+ /**
1381
+ * Corresponds to {@link ClickedAddBrandKitFile}
1382
+ */
1383
+ clickedAddBrandKitFile = "clickedAddBrandKitFile",
1384
+ /**
1385
+ * Corresponds to {@link ClickedSaveBrandKit}
1386
+ */
1387
+ clickedSaveBrandKit = "clickedSaveBrandKit"
1372
1388
  }
@@ -351,4 +351,8 @@ exports.ActionType = ActionType;
351
351
  ActionType["viewedToast"] = "viewedToast";
352
352
  ActionType["visitMyCollection"] = "visitMyCollection";
353
353
  ActionType["visitMyCollectionOnboardingSlide"] = "visitMyCollectionOnboardingSlide";
354
+ ActionType["clickedBrandKitColor"] = "clickedBrandKitColor";
355
+ ActionType["clickedBrandKitFont"] = "clickedBrandKitFont";
356
+ ActionType["clickedAddBrandKitFile"] = "clickedAddBrandKitFile";
357
+ ActionType["clickedSaveBrandKit"] = "clickedSaveBrandKit";
354
358
  })(ActionType || (exports.ActionType = ActionType = {}));
@@ -54,3 +54,4 @@ export * from "./os/Events";
54
54
  export * from "./os/Values/OsContextModule";
55
55
  export * from "./os/Values/OsOwnerType";
56
56
  export * from "./os/Events/MultiAddFlow";
57
+ export * from "./os/Events/BrandKit";
@@ -566,4 +566,16 @@ Object.keys(_MultiAddFlow).forEach(function (key) {
566
566
  return _MultiAddFlow[key];
567
567
  }
568
568
  });
569
+ });
570
+
571
+ var _BrandKit = require("./os/Events/BrandKit");
572
+
573
+ Object.keys(_BrandKit).forEach(function (key) {
574
+ if (key === "default" || key === "__esModule") return;
575
+ Object.defineProperty(exports, key, {
576
+ enumerable: true,
577
+ get: function get() {
578
+ return _BrandKit[key];
579
+ }
580
+ });
569
581
  });
@@ -0,0 +1,97 @@
1
+ import { ActionType } from "../../Events";
2
+ import { OsContextModule } from "../Values/OsContextModule";
3
+ import { OsOwnerType } from "../Values/OsOwnerType";
4
+ /**
5
+ * Schemas describing Art OS Brand Kit events
6
+ * @packageDocumentation
7
+ */
8
+ /**
9
+ * User clicks on a brand kit color option
10
+ *
11
+ * This schema describes events sent to Segment from [[clickedBrandKitColor]]
12
+ *
13
+ * @example
14
+ * ```
15
+ * {
16
+ * action: "clickedBrandKitColor",
17
+ * context_module: "brandKitEditor",
18
+ * context_page_owner_type: "brandSettings",
19
+ * field: "text",
20
+ * value: "#999be6"
21
+ * }
22
+ * ```
23
+ */
24
+ export interface ClickedBrandKitColor {
25
+ action: ActionType.clickedBrandKitColor;
26
+ context_module: OsContextModule.brandKit;
27
+ context_page_owner_type: OsOwnerType.studio;
28
+ field: string;
29
+ value: string;
30
+ }
31
+ /**
32
+ * User clicks on a brand kit font option
33
+ *
34
+ * This schema describes events sent to Segment from [[clickedBrandKitFont]]
35
+ *
36
+ * @example
37
+ * ```
38
+ * {
39
+ * action: "clickedBrandKitFont",
40
+ * context_module: "brandKitEditor",
41
+ * context_page_owner_type: "brandSettings",
42
+ * field: "font_family",
43
+ * value: "Courier"
44
+ * }
45
+ * ```
46
+ */
47
+ export interface ClickedBrandKitFont {
48
+ action: ActionType.clickedBrandKitFont;
49
+ context_module: OsContextModule.brandKit;
50
+ context_page_owner_type: OsOwnerType.studio;
51
+ field: string;
52
+ value: string;
53
+ }
54
+ /**
55
+ * User clicks to add a brand kit file
56
+ *
57
+ * This schema describes events sent to Segment from [[clickedAddBrandKitFile]]
58
+ *
59
+ * @example
60
+ * ```
61
+ * {
62
+ * action: "clickedAddBrandKitFile",
63
+ * context_module: "brandKitEditor",
64
+ * context_page_owner_type: "brandSettings",
65
+ * label: "brand kit logo",
66
+ * field: "file",
67
+ * value: "filename.png"
68
+ * }
69
+ * ```
70
+ */
71
+ export interface ClickedAddBrandKitFile {
72
+ action: ActionType.clickedAddBrandKitFile;
73
+ context_module: OsContextModule.brandKit;
74
+ context_page_owner_type: OsOwnerType.studio;
75
+ label: string;
76
+ field: string;
77
+ value: string;
78
+ }
79
+ /**
80
+ * User clicks to save brand kit settings
81
+ *
82
+ * This schema describes events sent to Segment from [[clickedSaveBrandKit]]
83
+ *
84
+ * @example
85
+ * ```
86
+ * {
87
+ * action: "clickedSaveBrandKit",
88
+ * context_module: "brandKitEditor",
89
+ * context_page_owner_type: "brandSettings"
90
+ * }
91
+ * ```
92
+ */
93
+ export interface ClickedSaveBrandKit {
94
+ action: ActionType.clickedSaveBrandKit;
95
+ context_module: OsContextModule.brandKit;
96
+ context_page_owner_type: OsOwnerType.studio;
97
+ }
@@ -0,0 +1 @@
1
+ "use strict";
@@ -0,0 +1 @@
1
+ export {};
@@ -1,10 +1,11 @@
1
+ import { ClickedAddBrandKitFile, ClickedBrandKitColor, ClickedBrandKitFont, ClickedSaveBrandKit } from "./BrandKit";
1
2
  import { OsMultiAddFlow } from "./MultiAddFlow";
2
3
  /**
3
4
  * List of valid schemas for Art OS analytics actions
4
5
  *
5
6
  * Each event describes one ActionType
6
7
  */
7
- export type OsEvent = OsMultiAddFlow;
8
+ export type OsEvent = OsMultiAddFlow | ClickedBrandKitColor | ClickedBrandKitFont | ClickedAddBrandKitFile | ClickedSaveBrandKit;
8
9
  /**
9
10
  * List of all Art OS actions
10
11
  *
@@ -6,5 +6,6 @@
6
6
  */
7
7
  export declare enum OsContextModule {
8
8
  multiAdd = "multiAdd",
9
- multiAddReview = "multiAddReview"
9
+ multiAddReview = "multiAddReview",
10
+ brandKit = "brandKit"
10
11
  }
@@ -17,4 +17,5 @@ exports.OsContextModule = OsContextModule;
17
17
  (function (OsContextModule) {
18
18
  OsContextModule["multiAdd"] = "multiAdd";
19
19
  OsContextModule["multiAddReview"] = "multiAddReview";
20
+ OsContextModule["brandKit"] = "brandKit";
20
21
  })(OsContextModule || (exports.OsContextModule = OsContextModule = {}));
@@ -4,5 +4,6 @@
4
4
  * @packageDocumentation
5
5
  */
6
6
  export declare enum OsOwnerType {
7
- inventory = "inventory"
7
+ inventory = "inventory",
8
+ studio = "studio"
8
9
  }
@@ -15,4 +15,5 @@ exports.OsOwnerType = OsOwnerType;
15
15
 
16
16
  (function (OsOwnerType) {
17
17
  OsOwnerType["inventory"] = "inventory";
18
+ OsOwnerType["studio"] = "studio";
18
19
  })(OsOwnerType || (exports.OsOwnerType = OsOwnerType = {}));
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@artsy/cohesion",
3
- "version": "4.363.0",
3
+ "version": "4.364.0--canary.707.14874.0",
4
4
  "description": "Analytics schema",
5
5
  "main": "dist/index.js",
6
6
  "publishConfig": {