@uniformdev/canvas 18.6.0 → 18.7.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/dist/{chunk-RFV573P3.mjs → chunk-QNNQJB7F.mjs} +7 -1
- package/dist/cli/cli.d.ts +1 -1
- package/dist/cli/cli.mjs +1 -1
- package/dist/{createEventBus-db0afea5.d.ts → createEventBus-60ff8dc4.d.ts} +63 -1
- package/dist/index.d.ts +3 -55
- package/dist/index.esm.js +1 -1
- package/dist/index.js +7 -1
- package/dist/index.mjs +1 -1
- package/package.json +4 -4
@@ -1223,8 +1223,14 @@ var createCanvasChannel = ({
|
|
1223
1223
|
postMessage(message);
|
1224
1224
|
};
|
1225
1225
|
const ready = () => {
|
1226
|
+
var _a;
|
1227
|
+
if (typeof window === "undefined") {
|
1228
|
+
return;
|
1229
|
+
}
|
1230
|
+
const framework = (_a = window.__UNIFORM_CONTEXTUAL_EDITING__) == null ? void 0 : _a.framework;
|
1226
1231
|
const message = {
|
1227
|
-
type: "ready"
|
1232
|
+
type: "ready",
|
1233
|
+
framework
|
1228
1234
|
};
|
1229
1235
|
postMessage(message);
|
1230
1236
|
};
|
package/dist/cli/cli.d.ts
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
import { UniformCLIPlugin } from '@uniformdev/cli';
|
2
2
|
import { UniformPackage } from '@uniformdev/cli/sync';
|
3
|
-
import {
|
3
|
+
import { ah as CanvasDefinitions } from '../createEventBus-60ff8dc4.js';
|
4
4
|
import 'pusher-js';
|
5
5
|
|
6
6
|
type CanvasPackage = UniformPackage & CanvasDefinitions;
|
package/dist/cli/cli.mjs
CHANGED
@@ -4064,6 +4064,68 @@ type DataType = components$2['schemas']['DataType'];
|
|
4064
4064
|
type DataSource = components$2['schemas']['DataSource'];
|
4065
4065
|
type DataVariableDefinition = components$2['schemas']['DataVariableDefinition'];
|
4066
4066
|
|
4067
|
+
interface ContextualEditingWindowData {
|
4068
|
+
framework?: ReadyMessage['framework'];
|
4069
|
+
}
|
4070
|
+
declare global {
|
4071
|
+
interface Window {
|
4072
|
+
__UNIFORM_CONTEXTUAL_EDITING__?: ContextualEditingWindowData;
|
4073
|
+
}
|
4074
|
+
}
|
4075
|
+
type SelectComponentMessage = {
|
4076
|
+
type: 'select-component';
|
4077
|
+
id: string;
|
4078
|
+
};
|
4079
|
+
type ReadyMessage = {
|
4080
|
+
type: 'ready';
|
4081
|
+
framework?: 'React' | 'Vue';
|
4082
|
+
};
|
4083
|
+
type UpdateCompositionMessage = {
|
4084
|
+
type: 'update-composition';
|
4085
|
+
composition: RootComponentInstance;
|
4086
|
+
hash: number | undefined;
|
4087
|
+
};
|
4088
|
+
type AddComponentMessage = {
|
4089
|
+
type: 'add-component';
|
4090
|
+
parentId: string;
|
4091
|
+
slotName: string;
|
4092
|
+
index: number;
|
4093
|
+
};
|
4094
|
+
type MoveComponentMessage = {
|
4095
|
+
type: 'move-component';
|
4096
|
+
componentId: string;
|
4097
|
+
slotName: string;
|
4098
|
+
index: number;
|
4099
|
+
direction: 'up' | 'down';
|
4100
|
+
};
|
4101
|
+
type DismissPlaceholderMessage = {
|
4102
|
+
type: 'dismiss-placeholder';
|
4103
|
+
parentId: string;
|
4104
|
+
slotName: string;
|
4105
|
+
};
|
4106
|
+
type ChannelMessage = SelectComponentMessage | ReadyMessage | UpdateCompositionMessage | AddComponentMessage | MoveComponentMessage | DismissPlaceholderMessage;
|
4107
|
+
declare const isSelectComponentMessage: (message: ChannelMessage) => message is SelectComponentMessage;
|
4108
|
+
declare const isReadyMessage: (message: ChannelMessage) => message is ReadyMessage;
|
4109
|
+
declare const isUpdateCompositionMessage: (message: ChannelMessage) => message is UpdateCompositionMessage;
|
4110
|
+
declare const isAddComponentMessage: (message: ChannelMessage) => message is AddComponentMessage;
|
4111
|
+
declare const isMovingComponentMessage: (message: ChannelMessage) => message is MoveComponentMessage;
|
4112
|
+
declare const isDismissPlaceholderMessage: (message: ChannelMessage) => message is DismissPlaceholderMessage;
|
4113
|
+
type MessageHandler = (message: ChannelMessage, originalEvent: MessageEvent) => void;
|
4114
|
+
type Channel = {
|
4115
|
+
ready: () => void;
|
4116
|
+
destroy: () => void;
|
4117
|
+
selectComponent: (id: string) => void;
|
4118
|
+
updateComposition: (component: RootComponentInstance, secret?: string) => void;
|
4119
|
+
on: (types: ChannelMessage['type'][] | ChannelMessage['type'], handler: MessageHandler) => () => void;
|
4120
|
+
addComponent: (options: Omit<AddComponentMessage, 'type'>) => void;
|
4121
|
+
moveComponent: (options: Omit<MoveComponentMessage, 'type'>) => void;
|
4122
|
+
dismissPlaceholder: (options: Omit<DismissPlaceholderMessage, 'type'>) => void;
|
4123
|
+
};
|
4124
|
+
declare const createCanvasChannel: ({ listenTo, broadcastTo, }: {
|
4125
|
+
listenTo: Window[];
|
4126
|
+
broadcastTo: Window[];
|
4127
|
+
}) => Channel;
|
4128
|
+
|
4067
4129
|
/**
|
4068
4130
|
* Pusher-js is large (80k) and not tree shakable so it is always bundled if directly referenced,
|
4069
4131
|
* when it's only needed during preview mode. To avoid bundling it for all, we use an old-school
|
@@ -4089,4 +4151,4 @@ declare global {
|
|
4089
4151
|
*/
|
4090
4152
|
declare function createEventBus(): Promise<PreviewEventBus | undefined>;
|
4091
4153
|
|
4092
|
-
export {
|
4154
|
+
export { ComponentDefinitionParameter as $, ReadyMessage as A, AddComponentMessage as B, CompositionGetParameters as C, DataResolutionOptionNegative as D, DismissPlaceholderMessage as E, ChannelMessage as F, isSelectComponentMessage as G, isReadyMessage as H, isUpdateCompositionMessage as I, isAddComponentMessage as J, isMovingComponentMessage as K, isDismissPlaceholderMessage as L, MoveComponentMessage as M, MessageHandler as N, Channel as O, PreviewEventBus as P, createCanvasChannel as Q, RootComponentInstance as R, SelectComponentMessage as S, ChannelSubscription as T, UpdateCompositionMessage as U, createEventBus as V, ComponentDefinitionGetResponse as W, ComponentDefinitionAPIResponse as X, ComponentDefinitionAPIPutRequest as Y, ComponentDefinitionAPIDeleteRequest as Z, ComponentDefinitionListAPIOptions as _, CompositionGetByNodePathParameters as a, ComponentDefinitionVariant as a0, ComponentDefinitionSlugSettings as a1, ComponentDefinitionSlot as a2, ComponentDefinitionPermission as a3, ComponentDefinition as a4, CreatingComponentDefinition as a5, CompositionGetOrderBy as a6, CompositionUIStatus as a7, CompositionGetListResponse as a8, CompositionAPIResponse as a9, CompositionAPIDeleteRequest as aa, CompositionListAPIResponse as ab, CompositionAPIOptions as ac, DataElementConnectionDefinition as ad, DataResourceVariables as ae, DataResourceDefinitions as af, DataResourceDefinition as ag, CanvasDefinitions as ah, CompositionIssue as ai, CompositionPatternIssue as aj, DataElementBindingIssue as ak, DataResourceIssue as al, DataResourceVariableIssue as am, DataResolutionConfigIssue as an, CompositionDataDiagnostic as ao, DataSourceGetResponse as ap, DataSourcesGetResponse as aq, DataType as ar, DataSource as as, DataVariableDefinition as at, CompositionGetResponse as b, DataResolutionOptionPositive as c, DataResolutionParameters as d, CompositionResolvedGetResponse as e, CompositionGetValidResponses as f, DataResolutionOption as g, CompositionGetByNodeIdParameters as h, CompositionGetBySlugParameters as i, CompositionGetByIdParameters as j, CompositionPutParameters as k, CompositionDeleteParameters as l, ComponentDefinitionGetParameters as m, ComponentDefinitionPutParameters as n, ComponentDefinitionDeleteParameters as o, ComponentInstance as p, ComponentParameter as q, components as r, DataSourceGetParameters as s, DataSourcesGetParameters as t, DataSourcePutParameters as u, DataSourceDeleteParameters as v, DataTypeGetParameters as w, DataTypeGetResponse as x, DataTypePutParameters as y, DataTypeDeleteParameters as z };
|
package/dist/index.d.ts
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
import { ApiClient, ClientOptions, ExceptProject, ApiClientError } from '@uniformdev/context/api';
|
2
2
|
export { ApiClientError } from '@uniformdev/context/api';
|
3
|
-
import { C as CompositionGetParameters, a as CompositionGetByNodePathParameters, D as DataResolutionOptionNegative, b as CompositionGetResponse, c as DataResolutionOptionPositive, d as DataResolutionParameters, e as CompositionResolvedGetResponse, f as CompositionGetValidResponses, g as DataResolutionOption, h as CompositionGetByNodeIdParameters, i as CompositionGetBySlugParameters, j as CompositionGetByIdParameters, k as CompositionPutParameters, l as CompositionDeleteParameters, m as ComponentDefinitionGetParameters, n as ComponentDefinitionPutParameters, o as ComponentDefinitionDeleteParameters, p as ComponentInstance, q as ComponentParameter, r as components, s as DataSourceGetParameters, t as DataSourcesGetParameters, u as DataSourcePutParameters, v as DataSourceDeleteParameters, w as DataTypeGetParameters, x as DataTypeGetResponse, y as DataTypePutParameters, z as DataTypeDeleteParameters,
|
4
|
-
export {
|
3
|
+
import { C as CompositionGetParameters, a as CompositionGetByNodePathParameters, D as DataResolutionOptionNegative, b as CompositionGetResponse, c as DataResolutionOptionPositive, d as DataResolutionParameters, e as CompositionResolvedGetResponse, f as CompositionGetValidResponses, g as DataResolutionOption, h as CompositionGetByNodeIdParameters, i as CompositionGetBySlugParameters, j as CompositionGetByIdParameters, k as CompositionPutParameters, l as CompositionDeleteParameters, m as ComponentDefinitionGetParameters, n as ComponentDefinitionPutParameters, o as ComponentDefinitionDeleteParameters, p as ComponentInstance, q as ComponentParameter, r as components, s as DataSourceGetParameters, t as DataSourcesGetParameters, u as DataSourcePutParameters, v as DataSourceDeleteParameters, w as DataTypeGetParameters, x as DataTypeGetResponse, y as DataTypePutParameters, z as DataTypeDeleteParameters, P as PreviewEventBus, U as UpdateCompositionMessage, R as RootComponentInstance } from './createEventBus-60ff8dc4.js';
|
4
|
+
export { B as AddComponentMessage, ah as CanvasDefinitions, O as Channel, F as ChannelMessage, T as ChannelSubscription, a4 as ComponentDefinition, Z as ComponentDefinitionAPIDeleteRequest, Y as ComponentDefinitionAPIPutRequest, X as ComponentDefinitionAPIResponse, o as ComponentDefinitionDeleteParameters, m as ComponentDefinitionGetParameters, W as ComponentDefinitionGetResponse, _ as ComponentDefinitionListAPIOptions, $ as ComponentDefinitionParameter, a3 as ComponentDefinitionPermission, n as ComponentDefinitionPutParameters, a2 as ComponentDefinitionSlot, a1 as ComponentDefinitionSlugSettings, a0 as ComponentDefinitionVariant, p as ComponentInstance, q as ComponentParameter, aa as CompositionAPIDeleteRequest, ac as CompositionAPIOptions, a9 as CompositionAPIResponse, ao as CompositionDataDiagnostic, l as CompositionDeleteParameters, j as CompositionGetByIdParameters, h as CompositionGetByNodeIdParameters, a as CompositionGetByNodePathParameters, i as CompositionGetBySlugParameters, a8 as CompositionGetListResponse, a6 as CompositionGetOrderBy, C as CompositionGetParameters, b as CompositionGetResponse, f as CompositionGetValidResponses, ai as CompositionIssue, ab as CompositionListAPIResponse, aj as CompositionPatternIssue, k as CompositionPutParameters, e as CompositionResolvedGetResponse, a7 as CompositionUIStatus, a5 as CreatingComponentDefinition, ak as DataElementBindingIssue, ad as DataElementConnectionDefinition, an as DataResolutionConfigIssue, g as DataResolutionOption, D as DataResolutionOptionNegative, c as DataResolutionOptionPositive, d as DataResolutionParameters, ag as DataResourceDefinition, af as DataResourceDefinitions, al as DataResourceIssue, am as DataResourceVariableIssue, ae as DataResourceVariables, as as DataSource, v as DataSourceDeleteParameters, s as DataSourceGetParameters, ap as DataSourceGetResponse, u as DataSourcePutParameters, t as DataSourcesGetParameters, aq as DataSourcesGetResponse, ar as DataType, z as DataTypeDeleteParameters, w as DataTypeGetParameters, x as DataTypeGetResponse, y as DataTypePutParameters, at as DataVariableDefinition, E as DismissPlaceholderMessage, N as MessageHandler, M as MoveComponentMessage, P as PreviewEventBus, A as ReadyMessage, R as RootComponentInstance, S as SelectComponentMessage, U as UpdateCompositionMessage, Q as createCanvasChannel, V as createEventBus, J as isAddComponentMessage, L as isDismissPlaceholderMessage, K as isMovingComponentMessage, H as isReadyMessage, G as isSelectComponentMessage, I as isUpdateCompositionMessage } from './createEventBus-60ff8dc4.js';
|
5
5
|
import { Options as Options$1 } from 'p-retry';
|
6
6
|
import { Options } from 'p-throttle';
|
7
7
|
import { PersonalizedVariant, TestVariant } from '@uniformdev/context';
|
@@ -568,58 +568,6 @@ declare function getComponentJsonPointer(ancestorsAndSelf: Array<ComponentLocati
|
|
568
568
|
withSlots?: boolean | undefined;
|
569
569
|
}): string;
|
570
570
|
|
571
|
-
type SelectComponentMessage = {
|
572
|
-
type: 'select-component';
|
573
|
-
id: string;
|
574
|
-
};
|
575
|
-
type ReadyMessage = {
|
576
|
-
type: 'ready';
|
577
|
-
};
|
578
|
-
type UpdateCompositionMessage = {
|
579
|
-
type: 'update-composition';
|
580
|
-
composition: RootComponentInstance;
|
581
|
-
hash: number | undefined;
|
582
|
-
};
|
583
|
-
type AddComponentMessage = {
|
584
|
-
type: 'add-component';
|
585
|
-
parentId: string;
|
586
|
-
slotName: string;
|
587
|
-
index: number;
|
588
|
-
};
|
589
|
-
type MoveComponentMessage = {
|
590
|
-
type: 'move-component';
|
591
|
-
componentId: string;
|
592
|
-
slotName: string;
|
593
|
-
index: number;
|
594
|
-
};
|
595
|
-
type DismissPlaceholderMessage = {
|
596
|
-
type: 'dismiss-placeholder';
|
597
|
-
parentId: string;
|
598
|
-
slotName: string;
|
599
|
-
};
|
600
|
-
type ChannelMessage = SelectComponentMessage | ReadyMessage | UpdateCompositionMessage | AddComponentMessage | MoveComponentMessage | DismissPlaceholderMessage;
|
601
|
-
declare const isSelectComponentMessage: (message: ChannelMessage) => message is SelectComponentMessage;
|
602
|
-
declare const isReadyMessage: (message: ChannelMessage) => message is ReadyMessage;
|
603
|
-
declare const isUpdateCompositionMessage: (message: ChannelMessage) => message is UpdateCompositionMessage;
|
604
|
-
declare const isAddComponentMessage: (message: ChannelMessage) => message is AddComponentMessage;
|
605
|
-
declare const isMovingComponentMessage: (message: ChannelMessage) => message is MoveComponentMessage;
|
606
|
-
declare const isDismissPlaceholderMessage: (message: ChannelMessage) => message is DismissPlaceholderMessage;
|
607
|
-
type MessageHandler = (message: ChannelMessage, originalEvent: MessageEvent) => void;
|
608
|
-
type Channel = {
|
609
|
-
ready: () => void;
|
610
|
-
destroy: () => void;
|
611
|
-
selectComponent: (id: string) => void;
|
612
|
-
updateComposition: (component: RootComponentInstance, secret?: string) => void;
|
613
|
-
on: (types: ChannelMessage['type'][] | ChannelMessage['type'], handler: MessageHandler) => () => void;
|
614
|
-
addComponent: (options: Omit<AddComponentMessage, 'type'>) => void;
|
615
|
-
moveComponent: (options: Omit<MoveComponentMessage, 'type'>) => void;
|
616
|
-
dismissPlaceholder: (options: Omit<DismissPlaceholderMessage, 'type'>) => void;
|
617
|
-
};
|
618
|
-
declare const createCanvasChannel: ({ listenTo, broadcastTo, }: {
|
619
|
-
listenTo: Window[];
|
620
|
-
broadcastTo: Window[];
|
621
|
-
}) => Channel;
|
622
|
-
|
623
571
|
type EventNames = 'updated';
|
624
572
|
|
625
573
|
declare function getChannelName(projectId: string, compositionId: string, state: number): string;
|
@@ -794,4 +742,4 @@ declare function mapSlotToTestVariations(slot: ComponentInstance[] | undefined):
|
|
794
742
|
|
795
743
|
declare const CanvasClientError: typeof ApiClientError;
|
796
744
|
|
797
|
-
export {
|
745
|
+
export { BatchEnhancer, BatchEntry, CANVAS_DRAFT_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, ChildEnhancerBuilder, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentLocationReference, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, DataSourceClient, DataTypeClient, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_DEFAULT_L2_CACHE_TTL_IN_HOURS, EDGE_MAX_CACHE_TTL, EDGE_MAX_L2_CACHE_TTL_IN_HOURS, EDGE_MIN_CACHE_TTL, EDGE_MIN_L2_CACHE_TTL_IN_HOURS, EnhancerBuilder, EnhancerContext, EnhancerError, EventNames, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, InvalidationInput, InvalidationPayload, InvalidationResult, LimitPolicy, PLACEHOLDER_ID, SubscribeToCompositionOptions, UncachedCanvasClient, UniqueBatchEntries, UnsubscribeCallback, WalkComponentTreeActions, compose, createBatchEnhancer, createLimitPolicy, createUniformApiEnhancer, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, isSystemComponentDefinition, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, walkComponentTree };
|
package/dist/index.esm.js
CHANGED
package/dist/index.js
CHANGED
@@ -1261,8 +1261,14 @@ var createCanvasChannel = ({
|
|
1261
1261
|
postMessage(message);
|
1262
1262
|
};
|
1263
1263
|
const ready = () => {
|
1264
|
+
var _a;
|
1265
|
+
if (typeof window === "undefined") {
|
1266
|
+
return;
|
1267
|
+
}
|
1268
|
+
const framework = (_a = window.__UNIFORM_CONTEXTUAL_EDITING__) == null ? void 0 : _a.framework;
|
1264
1269
|
const message = {
|
1265
|
-
type: "ready"
|
1270
|
+
type: "ready",
|
1271
|
+
framework
|
1266
1272
|
};
|
1267
1273
|
postMessage(message);
|
1268
1274
|
};
|
package/dist/index.mjs
CHANGED
package/package.json
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
{
|
2
2
|
"name": "@uniformdev/canvas",
|
3
|
-
"version": "18.
|
3
|
+
"version": "18.7.0",
|
4
4
|
"description": "Common functionality and types for Uniform Canvas",
|
5
5
|
"license": "SEE LICENSE IN LICENSE.txt",
|
6
6
|
"main": "./dist/index.js",
|
@@ -49,7 +49,7 @@
|
|
49
49
|
"devDependencies": {
|
50
50
|
"@types/retry": "0.12.1",
|
51
51
|
"@types/yargs": "17.0.20",
|
52
|
-
"@uniformdev/cli": "18.
|
52
|
+
"@uniformdev/cli": "18.7.0",
|
53
53
|
"p-limit": "4.0.0",
|
54
54
|
"p-retry": "5.1.2",
|
55
55
|
"p-throttle": "5.0.0",
|
@@ -57,7 +57,7 @@
|
|
57
57
|
"yargs": "17.6.2"
|
58
58
|
},
|
59
59
|
"dependencies": {
|
60
|
-
"@uniformdev/context": "18.
|
60
|
+
"@uniformdev/context": "18.7.0"
|
61
61
|
},
|
62
62
|
"files": [
|
63
63
|
"/dist"
|
@@ -65,5 +65,5 @@
|
|
65
65
|
"publishConfig": {
|
66
66
|
"access": "public"
|
67
67
|
},
|
68
|
-
"gitHead": "
|
68
|
+
"gitHead": "eaf3d0e5c1c124d6b449a2f2b16b327d6f3d3666"
|
69
69
|
}
|