@artsy/cohesion 4.368.0 → 4.368.1--canary.711.15089.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.
- package/CHANGELOG.md +0 -12
- package/dist/Schema/Values/OwnerType.d.ts +1 -0
- package/dist/Schema/Values/OwnerType.js +1 -0
- package/dist/Schema/index.d.ts +5 -5
- package/dist/Schema/index.js +39 -39
- package/dist/Schema/os/Events/InstagramEditor.d.ts +244 -0
- package/dist/Schema/os/Events/InstagramEditor.js +1 -0
- package/dist/Schema/os/Events/MaterialsEditor.d.ts +26 -3
- package/dist/Schema/os/Events/index.d.ts +33 -8
- package/dist/Schema/os/Events/index.js +8 -2
- package/dist/Schema/os/Values/OsContextModule.d.ts +5 -1
- package/dist/Schema/os/Values/OsContextModule.js +4 -0
- package/dist/Schema/os/Values/OsOwnerType.d.ts +2 -0
- package/dist/Schema/os/Values/OsOwnerType.js +2 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,15 +1,3 @@
|
|
|
1
|
-
# v4.368.0 (Thu Jun 25 2026)
|
|
2
|
-
|
|
3
|
-
#### 🚀 Enhancement
|
|
4
|
-
|
|
5
|
-
- chore: Add tracking schema for OS Materials Editor [#710](https://github.com/artsy/cohesion/pull/710) ([@olerichter00](https://github.com/olerichter00))
|
|
6
|
-
|
|
7
|
-
#### Authors: 1
|
|
8
|
-
|
|
9
|
-
- Ole ([@olerichter00](https://github.com/olerichter00))
|
|
10
|
-
|
|
11
|
-
---
|
|
12
|
-
|
|
13
1
|
# v4.367.0 (Thu Jun 25 2026)
|
|
14
2
|
|
|
15
3
|
#### 🚀 Enhancement
|
|
@@ -148,6 +148,7 @@ export declare enum OwnerType {
|
|
|
148
148
|
shows = "shows",
|
|
149
149
|
signup = "signup",
|
|
150
150
|
similarToRecentlyViewed = "similarToRecentlyViewed",
|
|
151
|
+
studioInstagram = "studioInstagram",
|
|
151
152
|
studioMaterials = "studioMaterials",
|
|
152
153
|
submitArtworkStepAddDetails = "submitArtworkStepAddDetails",
|
|
153
154
|
submitArtworkStepAddDimensions = "submitArtworkStepAddDimensions",
|
|
@@ -166,6 +166,7 @@ exports.OwnerType = OwnerType;
|
|
|
166
166
|
OwnerType["shows"] = "shows";
|
|
167
167
|
OwnerType["signup"] = "signup";
|
|
168
168
|
OwnerType["similarToRecentlyViewed"] = "similarToRecentlyViewed";
|
|
169
|
+
OwnerType["studioInstagram"] = "studioInstagram";
|
|
169
170
|
OwnerType["studioMaterials"] = "studioMaterials";
|
|
170
171
|
OwnerType["submitArtworkStepAddDetails"] = "submitArtworkStepAddDetails";
|
|
171
172
|
OwnerType["submitArtworkStepAddDimensions"] = "submitArtworkStepAddDimensions";
|
package/dist/Schema/index.d.ts
CHANGED
|
@@ -36,8 +36,6 @@ export * from "./Values/Tab";
|
|
|
36
36
|
* CMS-specific exports
|
|
37
37
|
*/
|
|
38
38
|
export * from "./CMS/Events";
|
|
39
|
-
export * from "./CMS/Values/CmsContextModule";
|
|
40
|
-
export * from "./CMS/Values/CmsOwnerType";
|
|
41
39
|
export * from "./CMS/Events/AnalyticsPage";
|
|
42
40
|
export * from "./CMS/Events/ArtworkFilter";
|
|
43
41
|
export * from "./CMS/Events/BatchImportFlow";
|
|
@@ -47,16 +45,18 @@ export * from "./CMS/Events/QuickReplyFlow";
|
|
|
47
45
|
export * from "./CMS/Events/SettingsFlow";
|
|
48
46
|
export * from "./CMS/Events/ShowFlow";
|
|
49
47
|
export * from "./CMS/Events/UploadArtworkFlow";
|
|
48
|
+
export * from "./CMS/Values/CmsContextModule";
|
|
49
|
+
export * from "./CMS/Values/CmsOwnerType";
|
|
50
50
|
/**
|
|
51
51
|
* Art OS-specific exports
|
|
52
52
|
*/
|
|
53
53
|
export * from "./os/Events";
|
|
54
|
-
export * from "./os/Values/OsContextModule";
|
|
55
|
-
export * from "./os/Values/OsOwnerType";
|
|
56
54
|
export * from "./os/Events/BrandKit";
|
|
57
55
|
export * from "./os/Events/Click";
|
|
58
56
|
export * from "./os/Events/ConnectedAppsFlow";
|
|
57
|
+
export * from "./os/Events/InstagramEditor";
|
|
59
58
|
export * from "./os/Events/InventoryTable";
|
|
60
|
-
export * from "./os/Events/MaterialsEditor";
|
|
61
59
|
export * from "./os/Events/MultiAddFlow";
|
|
62
60
|
export * from "./os/Events/Submit";
|
|
61
|
+
export * from "./os/Values/OsContextModule";
|
|
62
|
+
export * from "./os/Values/OsOwnerType";
|
package/dist/Schema/index.js
CHANGED
|
@@ -388,30 +388,6 @@ Object.keys(_Events2).forEach(function (key) {
|
|
|
388
388
|
});
|
|
389
389
|
});
|
|
390
390
|
|
|
391
|
-
var _CmsContextModule = require("./CMS/Values/CmsContextModule");
|
|
392
|
-
|
|
393
|
-
Object.keys(_CmsContextModule).forEach(function (key) {
|
|
394
|
-
if (key === "default" || key === "__esModule") return;
|
|
395
|
-
Object.defineProperty(exports, key, {
|
|
396
|
-
enumerable: true,
|
|
397
|
-
get: function get() {
|
|
398
|
-
return _CmsContextModule[key];
|
|
399
|
-
}
|
|
400
|
-
});
|
|
401
|
-
});
|
|
402
|
-
|
|
403
|
-
var _CmsOwnerType = require("./CMS/Values/CmsOwnerType");
|
|
404
|
-
|
|
405
|
-
Object.keys(_CmsOwnerType).forEach(function (key) {
|
|
406
|
-
if (key === "default" || key === "__esModule") return;
|
|
407
|
-
Object.defineProperty(exports, key, {
|
|
408
|
-
enumerable: true,
|
|
409
|
-
get: function get() {
|
|
410
|
-
return _CmsOwnerType[key];
|
|
411
|
-
}
|
|
412
|
-
});
|
|
413
|
-
});
|
|
414
|
-
|
|
415
391
|
var _AnalyticsPage = require("./CMS/Events/AnalyticsPage");
|
|
416
392
|
|
|
417
393
|
Object.keys(_AnalyticsPage).forEach(function (key) {
|
|
@@ -520,38 +496,38 @@ Object.keys(_UploadArtworkFlow).forEach(function (key) {
|
|
|
520
496
|
});
|
|
521
497
|
});
|
|
522
498
|
|
|
523
|
-
var
|
|
499
|
+
var _CmsContextModule = require("./CMS/Values/CmsContextModule");
|
|
524
500
|
|
|
525
|
-
Object.keys(
|
|
501
|
+
Object.keys(_CmsContextModule).forEach(function (key) {
|
|
526
502
|
if (key === "default" || key === "__esModule") return;
|
|
527
503
|
Object.defineProperty(exports, key, {
|
|
528
504
|
enumerable: true,
|
|
529
505
|
get: function get() {
|
|
530
|
-
return
|
|
506
|
+
return _CmsContextModule[key];
|
|
531
507
|
}
|
|
532
508
|
});
|
|
533
509
|
});
|
|
534
510
|
|
|
535
|
-
var
|
|
511
|
+
var _CmsOwnerType = require("./CMS/Values/CmsOwnerType");
|
|
536
512
|
|
|
537
|
-
Object.keys(
|
|
513
|
+
Object.keys(_CmsOwnerType).forEach(function (key) {
|
|
538
514
|
if (key === "default" || key === "__esModule") return;
|
|
539
515
|
Object.defineProperty(exports, key, {
|
|
540
516
|
enumerable: true,
|
|
541
517
|
get: function get() {
|
|
542
|
-
return
|
|
518
|
+
return _CmsOwnerType[key];
|
|
543
519
|
}
|
|
544
520
|
});
|
|
545
521
|
});
|
|
546
522
|
|
|
547
|
-
var
|
|
523
|
+
var _Events3 = require("./os/Events");
|
|
548
524
|
|
|
549
|
-
Object.keys(
|
|
525
|
+
Object.keys(_Events3).forEach(function (key) {
|
|
550
526
|
if (key === "default" || key === "__esModule") return;
|
|
551
527
|
Object.defineProperty(exports, key, {
|
|
552
528
|
enumerable: true,
|
|
553
529
|
get: function get() {
|
|
554
|
-
return
|
|
530
|
+
return _Events3[key];
|
|
555
531
|
}
|
|
556
532
|
});
|
|
557
533
|
});
|
|
@@ -592,26 +568,26 @@ Object.keys(_ConnectedAppsFlow).forEach(function (key) {
|
|
|
592
568
|
});
|
|
593
569
|
});
|
|
594
570
|
|
|
595
|
-
var
|
|
571
|
+
var _InstagramEditor = require("./os/Events/InstagramEditor");
|
|
596
572
|
|
|
597
|
-
Object.keys(
|
|
573
|
+
Object.keys(_InstagramEditor).forEach(function (key) {
|
|
598
574
|
if (key === "default" || key === "__esModule") return;
|
|
599
575
|
Object.defineProperty(exports, key, {
|
|
600
576
|
enumerable: true,
|
|
601
577
|
get: function get() {
|
|
602
|
-
return
|
|
578
|
+
return _InstagramEditor[key];
|
|
603
579
|
}
|
|
604
580
|
});
|
|
605
581
|
});
|
|
606
582
|
|
|
607
|
-
var
|
|
583
|
+
var _InventoryTable = require("./os/Events/InventoryTable");
|
|
608
584
|
|
|
609
|
-
Object.keys(
|
|
585
|
+
Object.keys(_InventoryTable).forEach(function (key) {
|
|
610
586
|
if (key === "default" || key === "__esModule") return;
|
|
611
587
|
Object.defineProperty(exports, key, {
|
|
612
588
|
enumerable: true,
|
|
613
589
|
get: function get() {
|
|
614
|
-
return
|
|
590
|
+
return _InventoryTable[key];
|
|
615
591
|
}
|
|
616
592
|
});
|
|
617
593
|
});
|
|
@@ -638,4 +614,28 @@ Object.keys(_Submit).forEach(function (key) {
|
|
|
638
614
|
return _Submit[key];
|
|
639
615
|
}
|
|
640
616
|
});
|
|
617
|
+
});
|
|
618
|
+
|
|
619
|
+
var _OsContextModule = require("./os/Values/OsContextModule");
|
|
620
|
+
|
|
621
|
+
Object.keys(_OsContextModule).forEach(function (key) {
|
|
622
|
+
if (key === "default" || key === "__esModule") return;
|
|
623
|
+
Object.defineProperty(exports, key, {
|
|
624
|
+
enumerable: true,
|
|
625
|
+
get: function get() {
|
|
626
|
+
return _OsContextModule[key];
|
|
627
|
+
}
|
|
628
|
+
});
|
|
629
|
+
});
|
|
630
|
+
|
|
631
|
+
var _OsOwnerType = require("./os/Values/OsOwnerType");
|
|
632
|
+
|
|
633
|
+
Object.keys(_OsOwnerType).forEach(function (key) {
|
|
634
|
+
if (key === "default" || key === "__esModule") return;
|
|
635
|
+
Object.defineProperty(exports, key, {
|
|
636
|
+
enumerable: true,
|
|
637
|
+
get: function get() {
|
|
638
|
+
return _OsOwnerType[key];
|
|
639
|
+
}
|
|
640
|
+
});
|
|
641
641
|
});
|
|
@@ -0,0 +1,244 @@
|
|
|
1
|
+
import { OsContextModule } from "../Values/OsContextModule";
|
|
2
|
+
import { OsOwnerType } from "../Values/OsOwnerType";
|
|
3
|
+
import { OsActionType } from ".";
|
|
4
|
+
/**
|
|
5
|
+
* Schemas describing Art OS Instagram Editor events
|
|
6
|
+
* @packageDocumentation
|
|
7
|
+
*/
|
|
8
|
+
/**
|
|
9
|
+
* A partner clicks "Connect" or "Cancel" in the Instagram account connection modal.
|
|
10
|
+
* The same modal is also used for Mailchimp; `label` identifies which service it is.
|
|
11
|
+
*
|
|
12
|
+
* This schema describes events sent to Segment from [[OsClickedConnectModal]]
|
|
13
|
+
*
|
|
14
|
+
* @example Connect
|
|
15
|
+
* ```
|
|
16
|
+
* {
|
|
17
|
+
* action: "clickedConnectModal",
|
|
18
|
+
* context_module: "connectModal",
|
|
19
|
+
* context_page_owner_type: "studioInstagram",
|
|
20
|
+
* label: "instagram",
|
|
21
|
+
* value: "connect"
|
|
22
|
+
* }
|
|
23
|
+
* ```
|
|
24
|
+
*
|
|
25
|
+
* @example Cancel
|
|
26
|
+
* ```
|
|
27
|
+
* {
|
|
28
|
+
* action: "clickedConnectModal",
|
|
29
|
+
* context_module: "connectModal",
|
|
30
|
+
* context_page_owner_type: "studioInstagram",
|
|
31
|
+
* label: "instagram",
|
|
32
|
+
* value: "cancel"
|
|
33
|
+
* }
|
|
34
|
+
* ```
|
|
35
|
+
*/
|
|
36
|
+
export interface OsClickedConnectModal {
|
|
37
|
+
action: OsActionType.clickedConnectModal;
|
|
38
|
+
context_module: OsContextModule.connectModal;
|
|
39
|
+
context_page_owner_type: OsOwnerType.studioInstagram;
|
|
40
|
+
label: "instagram" | "mailchimp";
|
|
41
|
+
value: "connect" | "cancel";
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* A partner selects or deselects an image from the Image Bank in the Instagram editor.
|
|
45
|
+
*
|
|
46
|
+
* This schema describes events sent to Segment from [[OsClickedImageBankImage]]
|
|
47
|
+
*
|
|
48
|
+
* @example Select
|
|
49
|
+
* ```
|
|
50
|
+
* {
|
|
51
|
+
* action: "clickedImageBankImage",
|
|
52
|
+
* context_module: "imageBank",
|
|
53
|
+
* context_page_owner_type: "studioInstagram",
|
|
54
|
+
* value: "selected"
|
|
55
|
+
* }
|
|
56
|
+
* ```
|
|
57
|
+
*
|
|
58
|
+
* @example Deselect
|
|
59
|
+
* ```
|
|
60
|
+
* {
|
|
61
|
+
* action: "clickedImageBankImage",
|
|
62
|
+
* context_module: "imageBank",
|
|
63
|
+
* context_page_owner_type: "studioInstagram",
|
|
64
|
+
* value: "deselected"
|
|
65
|
+
* }
|
|
66
|
+
* ```
|
|
67
|
+
*/
|
|
68
|
+
export interface OsClickedImageBankImage {
|
|
69
|
+
action: OsActionType.clickedImageBankImage;
|
|
70
|
+
context_module: OsContextModule.imageBank;
|
|
71
|
+
context_page_owner_type: OsOwnerType.studioInstagram;
|
|
72
|
+
value: "selected" | "deselected";
|
|
73
|
+
}
|
|
74
|
+
/**
|
|
75
|
+
* A partner uploads an image into the Image Bank.
|
|
76
|
+
* Fires when the upload is initiated (file selected).
|
|
77
|
+
*
|
|
78
|
+
* This schema describes events sent to Segment from [[OsClickedUploadImageBank]]
|
|
79
|
+
*
|
|
80
|
+
* @example
|
|
81
|
+
* ```
|
|
82
|
+
* {
|
|
83
|
+
* action: "clickedUploadImageBank",
|
|
84
|
+
* context_module: "imageBank",
|
|
85
|
+
* context_page_owner_type: "studioInstagram",
|
|
86
|
+
* field: "file",
|
|
87
|
+
* value: "filename.png"
|
|
88
|
+
* }
|
|
89
|
+
* ```
|
|
90
|
+
*/
|
|
91
|
+
export interface OsClickedUploadImageBank {
|
|
92
|
+
action: OsActionType.clickedUploadImageBank;
|
|
93
|
+
context_module: OsContextModule.imageBank;
|
|
94
|
+
context_page_owner_type: OsOwnerType.studioInstagram;
|
|
95
|
+
field: "file";
|
|
96
|
+
value: string;
|
|
97
|
+
}
|
|
98
|
+
/**
|
|
99
|
+
* A partner reorders or removes an image in the Image Bank management view.
|
|
100
|
+
*
|
|
101
|
+
* This schema describes events sent to Segment from [[OsClickedImageBankManagement]]
|
|
102
|
+
*
|
|
103
|
+
* @example Reorder
|
|
104
|
+
* ```
|
|
105
|
+
* {
|
|
106
|
+
* action: "clickedImageBankManagement",
|
|
107
|
+
* context_module: "imageBank",
|
|
108
|
+
* context_page_owner_type: "studioInstagram",
|
|
109
|
+
* value: "reorder"
|
|
110
|
+
* }
|
|
111
|
+
* ```
|
|
112
|
+
*
|
|
113
|
+
* @example Remove
|
|
114
|
+
* ```
|
|
115
|
+
* {
|
|
116
|
+
* action: "clickedImageBankManagement",
|
|
117
|
+
* context_module: "imageBank",
|
|
118
|
+
* context_page_owner_type: "studioInstagram",
|
|
119
|
+
* value: "remove"
|
|
120
|
+
* }
|
|
121
|
+
* ```
|
|
122
|
+
*/
|
|
123
|
+
export interface OsClickedImageBankManagement {
|
|
124
|
+
action: OsActionType.clickedImageBankManagement;
|
|
125
|
+
context_module: OsContextModule.imageBank;
|
|
126
|
+
context_page_owner_type: OsOwnerType.studioInstagram;
|
|
127
|
+
value: "reorder" | "remove";
|
|
128
|
+
}
|
|
129
|
+
/**
|
|
130
|
+
* A partner interacts with the aspect-ratio toggle or zoom crop control in the image editor.
|
|
131
|
+
* `label` identifies which control was used.
|
|
132
|
+
*
|
|
133
|
+
* This schema describes events sent to Segment from [[OsClickedAspectRatio]]
|
|
134
|
+
*
|
|
135
|
+
* @example Aspect ratio toggle
|
|
136
|
+
* ```
|
|
137
|
+
* {
|
|
138
|
+
* action: "clickedAspectRatio",
|
|
139
|
+
* context_module: "imageEditor",
|
|
140
|
+
* context_page_owner_type: "studioInstagram",
|
|
141
|
+
* label: "image aspect ratio"
|
|
142
|
+
* }
|
|
143
|
+
* ```
|
|
144
|
+
*
|
|
145
|
+
* @example Zoom/crop
|
|
146
|
+
* ```
|
|
147
|
+
* {
|
|
148
|
+
* action: "clickedAspectRatio",
|
|
149
|
+
* context_module: "imageEditor",
|
|
150
|
+
* context_page_owner_type: "studioInstagram",
|
|
151
|
+
* label: "image zoom"
|
|
152
|
+
* }
|
|
153
|
+
* ```
|
|
154
|
+
*/
|
|
155
|
+
export interface OsClickedAspectRatio {
|
|
156
|
+
action: OsActionType.clickedAspectRatio;
|
|
157
|
+
context_module: OsContextModule.imageEditor;
|
|
158
|
+
context_page_owner_type: OsOwnerType.studioInstagram;
|
|
159
|
+
label: "image aspect ratio" | "image zoom";
|
|
160
|
+
}
|
|
161
|
+
/**
|
|
162
|
+
* A partner clicks "Cancel" or "Continue" in the Instagram post publish confirmation modal.
|
|
163
|
+
*
|
|
164
|
+
* This schema describes events sent to Segment from [[OsClickedPublishConfirmation]]
|
|
165
|
+
*
|
|
166
|
+
* @example Continue
|
|
167
|
+
* ```
|
|
168
|
+
* {
|
|
169
|
+
* action: "clickedPublishConfirmation",
|
|
170
|
+
* context_module: "publishConfirmationModal",
|
|
171
|
+
* context_page_owner_type: "studioInstagram",
|
|
172
|
+
* value: "continue"
|
|
173
|
+
* }
|
|
174
|
+
* ```
|
|
175
|
+
*
|
|
176
|
+
* @example Cancel
|
|
177
|
+
* ```
|
|
178
|
+
* {
|
|
179
|
+
* action: "clickedPublishConfirmation",
|
|
180
|
+
* context_module: "publishConfirmationModal",
|
|
181
|
+
* context_page_owner_type: "studioInstagram",
|
|
182
|
+
* value: "cancel"
|
|
183
|
+
* }
|
|
184
|
+
* ```
|
|
185
|
+
*/
|
|
186
|
+
export interface OsClickedPublishConfirmation {
|
|
187
|
+
action: OsActionType.clickedPublishConfirmation;
|
|
188
|
+
context_module: OsContextModule.publishConfirmationModal;
|
|
189
|
+
context_page_owner_type: OsOwnerType.studioInstagram;
|
|
190
|
+
value: "cancel" | "continue";
|
|
191
|
+
}
|
|
192
|
+
/**
|
|
193
|
+
* A partner publishes an Instagram post or downloads a PNG from the Instagram editor.
|
|
194
|
+
*
|
|
195
|
+
* `content` is a generic catch-all (same pattern as {@link OsCreatedStudioContent}) holding
|
|
196
|
+
* post metadata fields: artworkTitle, artistNames, postCaption, collaborators, aspectRatio,
|
|
197
|
+
* imageCount, etc. It is kept generic so the same event can serve multiple studio surfaces.
|
|
198
|
+
*
|
|
199
|
+
* This schema describes events sent to Segment from [[OsCreatedInstagramContent]]
|
|
200
|
+
*
|
|
201
|
+
* @example Publish
|
|
202
|
+
* ```
|
|
203
|
+
* {
|
|
204
|
+
* action: "createdStudioContent",
|
|
205
|
+
* context_module: "instagramEditor",
|
|
206
|
+
* context_page_owner_type: "studioInstagram",
|
|
207
|
+
* value: "instagram post",
|
|
208
|
+
* brand_kit: true,
|
|
209
|
+
* content: {
|
|
210
|
+
* artworkTitle: "Xpto",
|
|
211
|
+
* artistNames: ["Jane Doe", "John Doe"],
|
|
212
|
+
* postCaption: "FooBar",
|
|
213
|
+
* collaborators: ["bonnie", "clyde"],
|
|
214
|
+
* aspectRatio: "4:5",
|
|
215
|
+
* imageCount: 3
|
|
216
|
+
* }
|
|
217
|
+
* }
|
|
218
|
+
* ```
|
|
219
|
+
*
|
|
220
|
+
* @example PNG download
|
|
221
|
+
* ```
|
|
222
|
+
* {
|
|
223
|
+
* action: "createdStudioContent",
|
|
224
|
+
* context_module: "instagramEditor",
|
|
225
|
+
* context_page_owner_type: "studioInstagram",
|
|
226
|
+
* value: "instagram png download",
|
|
227
|
+
* brand_kit: false,
|
|
228
|
+
* content: {
|
|
229
|
+
* aspectRatio: "1:1",
|
|
230
|
+
* imageCount: 2
|
|
231
|
+
* }
|
|
232
|
+
* }
|
|
233
|
+
* ```
|
|
234
|
+
*/
|
|
235
|
+
export interface OsCreatedInstagramContent {
|
|
236
|
+
action: OsActionType.createdStudioContent;
|
|
237
|
+
context_module: OsContextModule.instagramEditor;
|
|
238
|
+
context_page_owner_type: OsOwnerType.studioInstagram;
|
|
239
|
+
value: "instagram post" | "instagram png download";
|
|
240
|
+
brand_kit: boolean;
|
|
241
|
+
/** Generic catch-all for post metadata included in the created content */
|
|
242
|
+
content: Record<string, unknown>;
|
|
243
|
+
}
|
|
244
|
+
export type OsInstagramEditor = OsClickedAspectRatio | OsClickedConnectModal | OsClickedImageBankImage | OsClickedImageBankManagement | OsClickedPublishConfirmation | OsClickedUploadImageBank | OsCreatedInstagramContent;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
"use strict";
|
|
@@ -5,6 +5,29 @@ import { OsActionType } from ".";
|
|
|
5
5
|
* Schemas describing Art OS Materials (Tearsheet / Checklist) events
|
|
6
6
|
* @packageDocumentation
|
|
7
7
|
*/
|
|
8
|
+
/**
|
|
9
|
+
* A partner selects "Tearsheet" or "Checklist" from the inventory actions dropdown
|
|
10
|
+
* to open the Materials editor. The dropdown is surfaced three ways: the artwork's
|
|
11
|
+
* actions, bulk actions, and the right-click context menu.
|
|
12
|
+
*
|
|
13
|
+
* This schema describes events sent to Segment from [[OsClickedActionsDropdown]]
|
|
14
|
+
*
|
|
15
|
+
* @example
|
|
16
|
+
* ```
|
|
17
|
+
* {
|
|
18
|
+
* action: "clickedActionsDropdown",
|
|
19
|
+
* context_module: "actionsDropdown",
|
|
20
|
+
* context_page_owner_type: "inventory",
|
|
21
|
+
* value: "Tearsheet"
|
|
22
|
+
* }
|
|
23
|
+
* ```
|
|
24
|
+
*/
|
|
25
|
+
export interface OsClickedActionsDropdown {
|
|
26
|
+
action: OsActionType.clickedActionsDropdown;
|
|
27
|
+
context_module: OsContextModule.actionsDropdown;
|
|
28
|
+
context_page_owner_type: OsOwnerType;
|
|
29
|
+
value: "Tearsheet" | "Checklist" | "Instagram Post";
|
|
30
|
+
}
|
|
8
31
|
/**
|
|
9
32
|
* A partner clicks "Exit" in the Materials editor header to leave the editor.
|
|
10
33
|
*
|
|
@@ -23,7 +46,7 @@ import { OsActionType } from ".";
|
|
|
23
46
|
export interface OsClickedExitEditor {
|
|
24
47
|
action: OsActionType.clickedExitEditor;
|
|
25
48
|
context_module: OsContextModule.editorHeader;
|
|
26
|
-
context_page_owner_type: OsOwnerType
|
|
49
|
+
context_page_owner_type: OsOwnerType;
|
|
27
50
|
label: string;
|
|
28
51
|
}
|
|
29
52
|
/**
|
|
@@ -46,7 +69,7 @@ export interface OsClickedExitEditor {
|
|
|
46
69
|
export interface OsClickedBrandKitModal {
|
|
47
70
|
action: OsActionType.clickedBrandKitModal;
|
|
48
71
|
context_module: OsContextModule.brandKitPromptModal;
|
|
49
|
-
context_page_owner_type: OsOwnerType
|
|
72
|
+
context_page_owner_type: OsOwnerType;
|
|
50
73
|
label: string;
|
|
51
74
|
value: "cancel" | "create";
|
|
52
75
|
}
|
|
@@ -85,4 +108,4 @@ export interface OsCreatedStudioContent {
|
|
|
85
108
|
/** Generic catch-all for the artwork detail fields included in the generated material */
|
|
86
109
|
content: Record<string, unknown>;
|
|
87
110
|
}
|
|
88
|
-
export type OsMaterialsEditor = OsClickedBrandKitModal | OsClickedExitEditor | OsCreatedStudioContent;
|
|
111
|
+
export type OsMaterialsEditor = OsClickedActionsDropdown | OsClickedBrandKitModal | OsClickedExitEditor | OsCreatedStudioContent;
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { ClickedAddBrandKitFile, ClickedBrandKitColor, ClickedBrandKitFont, ClickedSaveBrandKit } from "./BrandKit";
|
|
2
2
|
import { OsClickEvent } from "./Click";
|
|
3
3
|
import { OsConnectedAppsFlow } from "./ConnectedAppsFlow";
|
|
4
|
+
import { OsInstagramEditor } from "./InstagramEditor";
|
|
4
5
|
import { OsInventoryTable } from "./InventoryTable";
|
|
5
6
|
import { OsMaterialsEditor } from "./MaterialsEditor";
|
|
6
7
|
import { OsMultiAddFlow } from "./MultiAddFlow";
|
|
@@ -10,7 +11,7 @@ import { OsSubmitEvent } from "./Submit";
|
|
|
10
11
|
*
|
|
11
12
|
* Each event describes one ActionType
|
|
12
13
|
*/
|
|
13
|
-
export type OsEvent = OsMultiAddFlow | ClickedBrandKitColor | ClickedBrandKitFont | ClickedAddBrandKitFile | ClickedSaveBrandKit | OsConnectedAppsFlow | OsClickEvent | OsInventoryTable | OsMaterialsEditor | OsSubmitEvent;
|
|
14
|
+
export type OsEvent = OsMultiAddFlow | ClickedBrandKitColor | ClickedBrandKitFont | ClickedAddBrandKitFile | ClickedSaveBrandKit | OsConnectedAppsFlow | OsClickEvent | OsInstagramEditor | OsInventoryTable | OsMaterialsEditor | OsSubmitEvent;
|
|
14
15
|
/**
|
|
15
16
|
* List of all Art OS actions
|
|
16
17
|
*
|
|
@@ -47,13 +48,17 @@ export declare enum OsActionType {
|
|
|
47
48
|
clickedAddFromFile = "clickedAddFromFile",
|
|
48
49
|
clickedArtworkRow = "clickedArtworkRow",
|
|
49
50
|
/**
|
|
50
|
-
* Corresponds to {@link
|
|
51
|
+
* Corresponds to {@link OsInstagramEditor}
|
|
51
52
|
*/
|
|
52
|
-
|
|
53
|
+
clickedAspectRatio = "clickedAspectRatio",
|
|
53
54
|
/**
|
|
54
|
-
* Corresponds to {@link
|
|
55
|
+
* Corresponds to {@link OsClickedBrandKitModal}
|
|
55
56
|
*/
|
|
56
|
-
|
|
57
|
+
clickedBrandKitModal = "clickedBrandKitModal",
|
|
58
|
+
/**
|
|
59
|
+
* Corresponds to {@link ClickedCancelBulkEdit}
|
|
60
|
+
*/
|
|
61
|
+
clickedCancelBulkEdit = "clickedCancelBulkEdit",
|
|
57
62
|
/**
|
|
58
63
|
* Corresponds to {@link ClickedConnectAccount}
|
|
59
64
|
*/
|
|
@@ -63,9 +68,13 @@ export declare enum OsActionType {
|
|
|
63
68
|
*/
|
|
64
69
|
clickedConnectAccountModal = "clickedConnectAccountModal",
|
|
65
70
|
/**
|
|
66
|
-
* Corresponds to {@link
|
|
71
|
+
* Corresponds to {@link OsInstagramEditor}
|
|
67
72
|
*/
|
|
68
|
-
|
|
73
|
+
clickedConnectModal = "clickedConnectModal",
|
|
74
|
+
/**
|
|
75
|
+
* Corresponds to {@link OsInventoryTable}
|
|
76
|
+
*/
|
|
77
|
+
clickedEditionSetRow = "clickedEditionSetRow",
|
|
69
78
|
/**
|
|
70
79
|
* Corresponds to {@link ClickedExitDropZone}
|
|
71
80
|
*/
|
|
@@ -74,10 +83,26 @@ export declare enum OsActionType {
|
|
|
74
83
|
* Corresponds to {@link OsClickedExitEditor}
|
|
75
84
|
*/
|
|
76
85
|
clickedExitEditor = "clickedExitEditor",
|
|
86
|
+
/**
|
|
87
|
+
* Corresponds to {@link OsInstagramEditor}
|
|
88
|
+
*/
|
|
89
|
+
clickedImageBankImage = "clickedImageBankImage",
|
|
90
|
+
/**
|
|
91
|
+
* Corresponds to {@link OsInstagramEditor}
|
|
92
|
+
*/
|
|
93
|
+
clickedImageBankManagement = "clickedImageBankManagement",
|
|
77
94
|
/**
|
|
78
95
|
* Corresponds to {@link OsInventoryTable}
|
|
79
96
|
*/
|
|
80
97
|
clickedImagesModal = "clickedImagesModal",
|
|
98
|
+
/**
|
|
99
|
+
* Corresponds to {@link OsInstagramEditor}
|
|
100
|
+
*/
|
|
101
|
+
clickedPublishConfirmation = "clickedPublishConfirmation",
|
|
102
|
+
/**
|
|
103
|
+
* Corresponds to {@link OsInstagramEditor}
|
|
104
|
+
*/
|
|
105
|
+
clickedUploadImageBank = "clickedUploadImageBank",
|
|
81
106
|
/**
|
|
82
107
|
* Corresponds to {@link CompletedArtworkImport}
|
|
83
108
|
*/
|
|
@@ -87,7 +112,7 @@ export declare enum OsActionType {
|
|
|
87
112
|
*/
|
|
88
113
|
createdImportedArtworks = "createdImportedArtworks",
|
|
89
114
|
/**
|
|
90
|
-
* Corresponds to {@link
|
|
115
|
+
* Corresponds to {@link OsMaterialsEditor} and {@link OsInstagramEditor}
|
|
91
116
|
*/
|
|
92
117
|
createdStudioContent = "createdStudioContent",
|
|
93
118
|
/**
|
|
@@ -28,14 +28,20 @@ exports.OsActionType = OsActionType;
|
|
|
28
28
|
OsActionType["clickedActionsDropdown"] = "clickedActionsDropdown";
|
|
29
29
|
OsActionType["clickedAddFromFile"] = "clickedAddFromFile";
|
|
30
30
|
OsActionType["clickedArtworkRow"] = "clickedArtworkRow";
|
|
31
|
+
OsActionType["clickedAspectRatio"] = "clickedAspectRatio";
|
|
32
|
+
OsActionType["clickedBrandKitModal"] = "clickedBrandKitModal";
|
|
31
33
|
OsActionType["clickedCancelBulkEdit"] = "clickedCancelBulkEdit";
|
|
32
|
-
OsActionType["clickedEditionSetRow"] = "clickedEditionSetRow";
|
|
33
34
|
OsActionType["clickedConnectAccount"] = "clickedConnectAccount";
|
|
34
35
|
OsActionType["clickedConnectAccountModal"] = "clickedConnectAccountModal";
|
|
35
|
-
OsActionType["
|
|
36
|
+
OsActionType["clickedConnectModal"] = "clickedConnectModal";
|
|
37
|
+
OsActionType["clickedEditionSetRow"] = "clickedEditionSetRow";
|
|
36
38
|
OsActionType["clickedExitDropZone"] = "clickedExitDropZone";
|
|
37
39
|
OsActionType["clickedExitEditor"] = "clickedExitEditor";
|
|
40
|
+
OsActionType["clickedImageBankImage"] = "clickedImageBankImage";
|
|
41
|
+
OsActionType["clickedImageBankManagement"] = "clickedImageBankManagement";
|
|
38
42
|
OsActionType["clickedImagesModal"] = "clickedImagesModal";
|
|
43
|
+
OsActionType["clickedPublishConfirmation"] = "clickedPublishConfirmation";
|
|
44
|
+
OsActionType["clickedUploadImageBank"] = "clickedUploadImageBank";
|
|
39
45
|
OsActionType["completedArtworkImport"] = "completedArtworkImport";
|
|
40
46
|
OsActionType["createdImportedArtworks"] = "createdImportedArtworks";
|
|
41
47
|
OsActionType["createdStudioContent"] = "createdStudioContent";
|
|
@@ -18,8 +18,12 @@ export declare enum OsContextModule {
|
|
|
18
18
|
distributeModal = "distributeModal",
|
|
19
19
|
documentsModal = "documentsModal",
|
|
20
20
|
editorHeader = "editorHeader",
|
|
21
|
+
imageBank = "imageBank",
|
|
22
|
+
imageEditor = "imageEditor",
|
|
21
23
|
imagesModal = "imagesModal",
|
|
24
|
+
instagramEditor = "instagramEditor",
|
|
22
25
|
materialsEditor = "materialsEditor",
|
|
23
26
|
multiAdd = "multiAdd",
|
|
24
|
-
multiAddReview = "multiAddReview"
|
|
27
|
+
multiAddReview = "multiAddReview",
|
|
28
|
+
publishConfirmationModal = "publishConfirmationModal"
|
|
25
29
|
}
|
|
@@ -28,8 +28,12 @@ exports.OsContextModule = OsContextModule;
|
|
|
28
28
|
OsContextModule["distributeModal"] = "distributeModal";
|
|
29
29
|
OsContextModule["documentsModal"] = "documentsModal";
|
|
30
30
|
OsContextModule["editorHeader"] = "editorHeader";
|
|
31
|
+
OsContextModule["imageBank"] = "imageBank";
|
|
32
|
+
OsContextModule["imageEditor"] = "imageEditor";
|
|
31
33
|
OsContextModule["imagesModal"] = "imagesModal";
|
|
34
|
+
OsContextModule["instagramEditor"] = "instagramEditor";
|
|
32
35
|
OsContextModule["materialsEditor"] = "materialsEditor";
|
|
33
36
|
OsContextModule["multiAdd"] = "multiAdd";
|
|
34
37
|
OsContextModule["multiAddReview"] = "multiAddReview";
|
|
38
|
+
OsContextModule["publishConfirmationModal"] = "publishConfirmationModal";
|
|
35
39
|
})(OsContextModule || (exports.OsContextModule = OsContextModule = {}));
|
|
@@ -4,9 +4,11 @@
|
|
|
4
4
|
* @packageDocumentation
|
|
5
5
|
*/
|
|
6
6
|
export declare enum OsOwnerType {
|
|
7
|
+
collection = "collection",
|
|
7
8
|
connectedApps = "connectedApps",
|
|
8
9
|
inventory = "inventory",
|
|
9
10
|
list = "list",
|
|
10
11
|
studio = "studio",
|
|
12
|
+
studioInstagram = "studioInstagram",
|
|
11
13
|
studioMaterials = "studioMaterials"
|
|
12
14
|
}
|
|
@@ -14,9 +14,11 @@ var OsOwnerType;
|
|
|
14
14
|
exports.OsOwnerType = OsOwnerType;
|
|
15
15
|
|
|
16
16
|
(function (OsOwnerType) {
|
|
17
|
+
OsOwnerType["collection"] = "collection";
|
|
17
18
|
OsOwnerType["connectedApps"] = "connectedApps";
|
|
18
19
|
OsOwnerType["inventory"] = "inventory";
|
|
19
20
|
OsOwnerType["list"] = "list";
|
|
20
21
|
OsOwnerType["studio"] = "studio";
|
|
22
|
+
OsOwnerType["studioInstagram"] = "studioInstagram";
|
|
21
23
|
OsOwnerType["studioMaterials"] = "studioMaterials";
|
|
22
24
|
})(OsOwnerType || (exports.OsOwnerType = OsOwnerType = {}));
|