@contentstack/studio-message-types 1.0.1

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/README.md ADDED
@@ -0,0 +1,22 @@
1
+ # `studio-message-types`
2
+ This package contains all message types that are used to communicate between the Studio platform and the iframe webpage.
3
+
4
+ ## How is this package organized?
5
+ Package have 2 types of folders:
6
+ - **version folder**: Version folders like base, v2, v3, etc. Will have message types of old and new versions. SDKs will always use the latest version. New versions will extend base version and modify it to add new fields.
7
+ - **studio folder**: Studio folder will have message type union of all versions type. Since Studio should know how to communicate with all versions of SDKs.
8
+
9
+ ## How to use this package?
10
+ ### For SDKs
11
+ SDK will always use the latest version of the message types.
12
+
13
+ ```ts
14
+ import {} from '@contentstack/studio-message-types/latest_version'
15
+ ```
16
+
17
+ ### For Studio
18
+ Studio will use the union of all versions of the message types.
19
+
20
+ ```ts
21
+ import {} from '@contentstack/studio-message-types/studio'
22
+ ```
@@ -0,0 +1,180 @@
1
+ import type { Operation, Path } from "@contentstack/studio-internal";
2
+ type CompositionQuery = {
3
+ composableUid: string;
4
+ } | {
5
+ /**
6
+ * IMPORTANT: If you only pass the URL without the composable UID,
7
+ * we will still fetch the composition. However, it will be slower
8
+ * as we will have to process all the compositions.
9
+ */
10
+ url: string;
11
+ } | {
12
+ composableUid: string;
13
+ url: string;
14
+ };
15
+ export type InitMessage = {
16
+ sdkVersion: string;
17
+ schemaVersion: string;
18
+ };
19
+ export declare enum TARGET_NODE {
20
+ ACTIVE_NODE = "active-node",
21
+ HOVERED_NODE = "hovered-node",
22
+ STYLE_NODE = "style-node",
23
+ SLOT_NODE = "slot-node",
24
+ FOCUSED_NODE = "focused-node"
25
+ }
26
+ type TARGET_NODE_TYPE = typeof TARGET_NODE;
27
+ export interface BaseHighlightEventPayload {
28
+ target: TARGET_NODE_TYPE[keyof TARGET_NODE_TYPE];
29
+ }
30
+ export interface HighlightActiveNodeEventPayload extends BaseHighlightEventPayload {
31
+ target: TARGET_NODE_TYPE["ACTIVE_NODE"];
32
+ path: Path;
33
+ activeNodeRect: DOMRect;
34
+ }
35
+ export interface HighlightAncestorsEventPayload extends BaseHighlightEventPayload {
36
+ target: TARGET_NODE_TYPE["HOVERED_NODE"];
37
+ path: Path;
38
+ hoveredNodeRect: DOMRect;
39
+ hoveredNodeAncestorsRect: DOMRect[];
40
+ }
41
+ export interface HighlightStyleNodeEventPayload extends BaseHighlightEventPayload {
42
+ target: TARGET_NODE_TYPE["STYLE_NODE"];
43
+ path: Path;
44
+ styleNodeRect: DOMRect | null;
45
+ styles: Partial<CSSStyleDeclaration> | undefined;
46
+ }
47
+ export interface HighlightSlotNodeEventPayload extends BaseHighlightEventPayload {
48
+ target: TARGET_NODE_TYPE["SLOT_NODE"];
49
+ slotNodeRect: DOMRect;
50
+ slotUID: string;
51
+ }
52
+ export interface HighlightFocusedNodeEventPayload extends BaseHighlightEventPayload {
53
+ target: TARGET_NODE_TYPE["FOCUSED_NODE"];
54
+ path: Path;
55
+ focusedNodeRect: DOMRect | null;
56
+ }
57
+ export type HighlightNodeEventPayload = HighlightActiveNodeEventPayload | HighlightAncestorsEventPayload | HighlightStyleNodeEventPayload | HighlightFocusedNodeEventPayload;
58
+ export interface RequestHighlightNodeEventPayload {
59
+ target: TARGET_NODE_TYPE["ACTIVE_NODE"] | TARGET_NODE_TYPE["HOVERED_NODE"] | TARGET_NODE_TYPE["FOCUSED_NODE"];
60
+ uid: string;
61
+ }
62
+ export interface handleActiveNodePayload {
63
+ uid?: string;
64
+ }
65
+ export interface handleFocusedNodePayload {
66
+ uid?: string;
67
+ }
68
+ export interface handleActiveSlotNode {
69
+ slotUid?: string;
70
+ }
71
+ export interface MouseMoveEventPayload {
72
+ event: MouseEvent;
73
+ details: HitboxDetails;
74
+ }
75
+ export interface MouseUpEventPayload {
76
+ event: MouseEvent;
77
+ details: HitboxDetails;
78
+ }
79
+ export interface ComputedStyleSection {
80
+ styles: Partial<CSSStyleDeclaration> | undefined;
81
+ }
82
+ export interface UpdateStyleEventPayload {
83
+ styles: CSSStyleDeclaration | undefined;
84
+ styleNodeRect: DOMRect;
85
+ }
86
+ export interface ChangeActiveStyleGroupPayload {
87
+ uid: string;
88
+ styleGroup: string;
89
+ }
90
+ export type BaseHitboxDetails = {
91
+ path: Path;
92
+ direction: "top" | "bottom" | "left" | "right";
93
+ nodeBoundingBox: DOMRect;
94
+ };
95
+ export type RegularNodeHitboxDetails = BaseHitboxDetails & {
96
+ shouldShowSlotDropzone: false;
97
+ };
98
+ export type SlotNodeHitboxDetails = BaseHitboxDetails & {
99
+ slotUid: string;
100
+ shouldShowSlotDropzone: true;
101
+ };
102
+ export type HitboxDetails = RegularNodeHitboxDetails | SlotNodeHitboxDetails | null;
103
+ export interface SetCursorTypeEventPayload {
104
+ cursorType: string;
105
+ }
106
+ export interface DraggerPosition {
107
+ top: number;
108
+ left: number;
109
+ }
110
+ export interface ValidatePropEventPayload {
111
+ componentName: string;
112
+ propName: string;
113
+ value: unknown;
114
+ }
115
+ export interface ActiveBreakpointEventPayload {
116
+ activeBreakpoint: Breakpoint;
117
+ }
118
+ export interface RegisterBreakpointsEventPayload {
119
+ breakpoints: Breakpoint[];
120
+ }
121
+ export interface Breakpoint {
122
+ id: string;
123
+ displayName: string;
124
+ query: string;
125
+ previewSize: {
126
+ width: number;
127
+ height: number;
128
+ };
129
+ }
130
+ export type PreProcessedBreakpoint = Omit<Breakpoint, "displayName"> & {
131
+ displayName?: string;
132
+ };
133
+ export type DefaultBreakpoint = Omit<PreProcessedBreakpoint, "query"> & {
134
+ id: "default";
135
+ };
136
+ export type BreakpointInput = [DefaultBreakpoint, ...PreProcessedBreakpoint[]];
137
+ export interface UpdateBindingErrorsEventPayload {
138
+ propKey: string;
139
+ errorMessage?: string;
140
+ }
141
+ export interface SerializedEvent {
142
+ pageX: number;
143
+ pageY: number;
144
+ clientX: number;
145
+ clientY: number;
146
+ }
147
+ export interface OpenComposableStudioFromVBEventData {
148
+ compositionEntryUid: string;
149
+ windowFeatures?: string;
150
+ compositionQuery: CompositionQuery | null;
151
+ }
152
+ export interface OpenComposableStudioFromStudioEventData {
153
+ compositionEntryUid: string;
154
+ compositionQuery: CompositionQuery | null;
155
+ }
156
+ export interface CompositionSavedEventData {
157
+ entryUid: string;
158
+ contentTypeUid: string;
159
+ locale: string;
160
+ }
161
+ export interface HiddenElementNotificationEventData {
162
+ action: "open" | "close";
163
+ uid: "__all__" | (string & {});
164
+ }
165
+ export interface GetNodeScreenshotEventData {
166
+ uid: string;
167
+ }
168
+ export interface GetNodeScreenshotResponseEventData {
169
+ screenshot: string;
170
+ }
171
+ export interface RefetchSpecEventData {
172
+ entryUid: string;
173
+ contentTypeUid: string;
174
+ locale: string;
175
+ }
176
+ export interface ApplySymbolOperationEventData {
177
+ operations: Operation[];
178
+ uid: string;
179
+ }
180
+ export type { CompositionQuery };
@@ -0,0 +1,9 @@
1
+ // Highlight Node Event Payloads
2
+ export var TARGET_NODE;
3
+ (function (TARGET_NODE) {
4
+ TARGET_NODE["ACTIVE_NODE"] = "active-node";
5
+ TARGET_NODE["HOVERED_NODE"] = "hovered-node";
6
+ TARGET_NODE["STYLE_NODE"] = "style-node";
7
+ TARGET_NODE["SLOT_NODE"] = "slot-node";
8
+ TARGET_NODE["FOCUSED_NODE"] = "focused-node";
9
+ })(TARGET_NODE || (TARGET_NODE = {}));
@@ -0,0 +1,45 @@
1
+ import { HitboxDetails, ValidatePropEventPayload, PreProcessedBreakpoint, SlotNodeHitboxDetails, HighlightNodeEventPayload, RequestHighlightNodeEventPayload, HighlightFocusedNodeEventPayload, HighlightSlotNodeEventPayload, HighlightStyleNodeEventPayload, HighlightActiveNodeEventPayload, BaseHighlightEventPayload, RegularNodeHitboxDetails, SerializedEvent, Breakpoint, HighlightAncestorsEventPayload, InitMessage, DefaultBreakpoint, ActiveBreakpointEventPayload, BreakpointInput, RegisterBreakpointsEventPayload, SetCursorTypeEventPayload, UpdateStyleEventPayload, ComputedStyleSection, ChangeActiveStyleGroupPayload, handleActiveNodePayload, handleFocusedNodePayload, handleActiveSlotNode, MouseMoveEventPayload, MouseUpEventPayload, DraggerPosition, UpdateBindingErrorsEventPayload, OpenComposableStudioFromVBEventData, OpenComposableStudioFromStudioEventData, CompositionSavedEventData, HiddenElementNotificationEventData, GetNodeScreenshotEventData, GetNodeScreenshotResponseEventData, RefetchSpecEventData, ApplySymbolOperationEventData, TARGET_NODE } from "./client";
2
+ export type { InitMessage, HighlightActiveNodeEventPayload, HighlightAncestorsEventPayload, HighlightStyleNodeEventPayload, HighlightSlotNodeEventPayload, HighlightFocusedNodeEventPayload, HighlightNodeEventPayload, RequestHighlightNodeEventPayload, BaseHighlightEventPayload, HitboxDetails, RegularNodeHitboxDetails, SlotNodeHitboxDetails, SerializedEvent, ValidatePropEventPayload, Breakpoint, PreProcessedBreakpoint, DefaultBreakpoint, BreakpointInput, ActiveBreakpointEventPayload, RegisterBreakpointsEventPayload, SetCursorTypeEventPayload, UpdateStyleEventPayload, ComputedStyleSection, ChangeActiveStyleGroupPayload, handleActiveNodePayload, handleFocusedNodePayload, handleActiveSlotNode, MouseMoveEventPayload, MouseUpEventPayload, DraggerPosition, UpdateBindingErrorsEventPayload, OpenComposableStudioFromVBEventData, OpenComposableStudioFromStudioEventData, CompositionSavedEventData, HiddenElementNotificationEventData, GetNodeScreenshotEventData, GetNodeScreenshotResponseEventData, RefetchSpecEventData, ApplySymbolOperationEventData, } from "./client";
3
+ export { TARGET_NODE } from "./client";
4
+ export type BaseType = {
5
+ InitMessage: InitMessage;
6
+ HighlightActiveNodeEventPayload: HighlightActiveNodeEventPayload;
7
+ HighlightAncestorsEventPayload: HighlightAncestorsEventPayload;
8
+ HighlightStyleNodeEventPayload: HighlightStyleNodeEventPayload;
9
+ HighlightSlotNodeEventPayload: HighlightSlotNodeEventPayload;
10
+ HighlightFocusedNodeEventPayload: HighlightFocusedNodeEventPayload;
11
+ HighlightNodeEventPayload: HighlightNodeEventPayload;
12
+ RequestHighlightNodeEventPayload: RequestHighlightNodeEventPayload;
13
+ BaseHighlightEventPayload: BaseHighlightEventPayload;
14
+ HitboxDetails: HitboxDetails;
15
+ RegularNodeHitboxDetails: RegularNodeHitboxDetails;
16
+ SlotNodeHitboxDetails: SlotNodeHitboxDetails;
17
+ SerializedEvent: SerializedEvent;
18
+ ValidatePropEventPayload: ValidatePropEventPayload;
19
+ Breakpoint: Breakpoint;
20
+ PreProcessedBreakpoint: PreProcessedBreakpoint;
21
+ DefaultBreakpoint: DefaultBreakpoint;
22
+ BreakpointInput: BreakpointInput;
23
+ ActiveBreakpointEventPayload: ActiveBreakpointEventPayload;
24
+ RegisterBreakpointsEventPayload: RegisterBreakpointsEventPayload;
25
+ SetCursorTypeEventPayload: SetCursorTypeEventPayload;
26
+ UpdateStyleEventPayload: UpdateStyleEventPayload;
27
+ ComputedStyleSection: ComputedStyleSection;
28
+ ChangeActiveStyleGroupPayload: ChangeActiveStyleGroupPayload;
29
+ handleActiveNodePayload: handleActiveNodePayload;
30
+ handleFocusedNodePayload: handleFocusedNodePayload;
31
+ handleActiveSlotNode: handleActiveSlotNode;
32
+ MouseMoveEventPayload: MouseMoveEventPayload;
33
+ MouseUpEventPayload: MouseUpEventPayload;
34
+ DraggerPosition: DraggerPosition;
35
+ UpdateBindingErrorsEventPayload: UpdateBindingErrorsEventPayload;
36
+ OpenComposableStudioFromVBEventData: OpenComposableStudioFromVBEventData;
37
+ OpenComposableStudioFromStudioEventData: OpenComposableStudioFromStudioEventData;
38
+ CompositionSavedEventData: CompositionSavedEventData;
39
+ HiddenElementNotificationEventData: HiddenElementNotificationEventData;
40
+ GetNodeScreenshotEventData: GetNodeScreenshotEventData;
41
+ GetNodeScreenshotResponseEventData: GetNodeScreenshotResponseEventData;
42
+ RefetchSpecEventData: RefetchSpecEventData;
43
+ ApplySymbolOperationEventData: ApplySymbolOperationEventData;
44
+ TARGET_NODE: TARGET_NODE;
45
+ };
@@ -0,0 +1 @@
1
+ export { TARGET_NODE } from "./client";
@@ -0,0 +1 @@
1
+ export * from "./latest";
package/dist/index.js ADDED
@@ -0,0 +1,2 @@
1
+ // Main entry point - defaults to latest version for SDK packages
2
+ export * from "./latest";
@@ -0,0 +1 @@
1
+ export * from "../base";
@@ -0,0 +1,2 @@
1
+ // Latest SDK version message types
2
+ export * from "../base";
package/package.json ADDED
@@ -0,0 +1,40 @@
1
+ {
2
+ "name": "@contentstack/studio-message-types",
3
+ "version": "1.0.1",
4
+ "description": "Shared message types for communication between Studio platform and SDKs",
5
+ "author": "RavenColEvol <ravilamkoti@gmail.com>",
6
+ "homepage": "https://github.com/contentstack/composable-studio-sdk#readme",
7
+ "main": "dist/index.js",
8
+ "license": "MIT",
9
+ "files": [
10
+ "dist"
11
+ ],
12
+ "exports": {
13
+ ".": {
14
+ "import": "./dist/index.js",
15
+ "types": "./dist/index.d.ts"
16
+ },
17
+ "./base": {
18
+ "import": "./dist/base/index.js",
19
+ "types": "./dist/base/index.d.ts"
20
+ },
21
+ "./latest": {
22
+ "import": "./dist/latest/index.js",
23
+ "types": "./dist/latest/index.d.ts"
24
+ }
25
+ },
26
+ "repository": {
27
+ "type": "git",
28
+ "url": "git+https://github.com/contentstack/composable-studio-sdk.git"
29
+ },
30
+ "scripts": {
31
+ "build": "tsc -p tsconfig.json",
32
+ "dev": "tsc --watch"
33
+ },
34
+ "bugs": {
35
+ "url": "https://github.com/contentstack/composable-studio-sdk/issues"
36
+ },
37
+ "peerDependencies": {
38
+ "@contentstack/studio-internal": "*"
39
+ }
40
+ }