-
Notifications
You must be signed in to change notification settings - Fork 903
/
builder.class.ts
2395 lines (2143 loc) · 68 KB
/
builder.class.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import './polyfills/custom-event-polyfill';
import { IncomingMessage, ServerResponse } from 'http';
import { nextTick } from './functions/next-tick.function';
import { QueryString } from './classes/query-string.class';
import { version } from '../package.json';
import { BehaviorSubject } from './classes/observable.class';
import { fetch, SimplifiedFetchOptions } from './functions/fetch.function';
import { assign } from './functions/assign.function';
import { throttle } from './functions/throttle.function';
import { Animator } from './classes/animator.class';
import { BuilderElement } from './types/element';
import Cookies from './classes/cookies.class';
import { omit } from './functions/omit.function';
import { getTopLevelDomain } from './functions/get-top-level-domain';
import serverOnlyRequire from './functions/server-only-require.function';
import { BuilderContent } from './types/content';
import { uuid } from './functions/uuid';
// Do not change this to a require! It throws runtime errors - rollup
// will preserve the `require` and throw runtime errors
import hash from 'hash-sum';
export type Url = any;
function datePlusMinutes(minutes = 30) {
return new Date(Date.now() + minutes * 60000);
}
const isPositiveNumber = (thing: unknown) =>
typeof thing === 'number' && !isNaN(thing) && thing >= 0;
export const isReactNative = typeof navigator === 'object' && navigator.product === 'ReactNative';
export const validEnvList = [
'production',
'qa',
'test',
'development',
'dev',
'cdn-qa',
'cloud',
'fast',
'cdn2',
'cdn-prod',
];
function getQueryParam(url: string, variable: string): string | null {
const query = url.split('?')[1] || '';
const vars = query.split('&');
for (let i = 0; i < vars.length; i++) {
const pair = vars[i].split('=');
if (decodeURIComponent(pair[0]) === variable) {
return decodeURIComponent(pair[1]);
}
}
return null;
}
const urlParser = {
parse(url: string) {
const parser = document.createElement('a') as any;
parser.href = url;
const out: any = {};
const props = 'username password host hostname port protocol origin pathname search hash'.split(
' '
);
for (let i = props.length; i--; ) {
out[props[i]] = parser[props[i]];
}
// IE 11 pathname handling workaround
// (IE omits preceeding '/', unlike other browsers)
if (
(out.pathname || out.pathname === '') &&
typeof out.pathname === 'string' &&
out.pathname.indexOf('/') !== 0
) {
out.pathname = '/' + out.pathname;
}
return out;
},
};
const parse = isReactNative
? () => ({})
: typeof window === 'object'
? urlParser.parse
: serverOnlyRequire('url').parse;
function setCookie(name: string, value: string, expires?: Date) {
try {
let expiresString = '';
// TODO: need to know if secure server side
if (expires) {
expiresString = '; expires=' + expires.toUTCString();
}
const secure = isBrowser ? location.protocol === 'https:' : true;
document.cookie =
name +
'=' +
(value || '') +
expiresString +
'; path=/' +
`; domain=${getTopLevelDomain(location.hostname)}` +
(secure ? ';secure ; SameSite=None' : '');
} catch (err) {
console.warn('Could not set cookie', err);
}
}
function getCookie(name: string) {
try {
return (
decodeURIComponent(
document.cookie.replace(
new RegExp(
'(?:(?:^|.*;)\\s*' +
encodeURIComponent(name).replace(/[\-\.\+\*]/g, '\\$&') +
'\\s*\\=\\s*([^;]*).*$)|^.*$'
),
'$1'
)
) || null
);
} catch (err) {
console.warn('Could not get cookie', err);
}
}
function size(object: object) {
return Object.keys(object).length;
}
function find<T = any>(target: T[], callback: (item: T, index: number, list: T[]) => boolean) {
const list = target;
// Makes sures is always has an positive integer as length.
const length = list.length >>> 0;
const thisArg = arguments[1];
for (let i = 0; i < length; i++) {
const element = list[i];
if (callback.call(thisArg, element, i, list)) {
return element;
}
}
}
const sessionStorageKey = 'builderSessionId';
const localStorageKey = 'builderVisitorId';
export const isBrowser = typeof window !== 'undefined' && !isReactNative;
export const isIframe = isBrowser && window.top !== window.self;
export interface ParamsMap {
[key: string]: any;
}
type TrackingHook = (
eventData: Event,
context: { content?: BuilderContent; [key: string]: any }
) => Event | undefined;
interface EventData {
contentId?: string;
ownerId: string;
variationId?: string;
userAttributes?: any;
targetSelector?: string;
targetBuilderElement?: string;
unique?: boolean;
metadata?: any | string;
meta?: any | string;
sessionId?: string;
visitorId?: string;
amount?: number;
}
// TODO: share interfaces with API
interface Event {
type: string;
data: EventData;
}
/**
* Attributes that can be used for custom targeting. {@link
* https://www.builder.io/c/docs/guides/targeting-and-scheduling}
*/
export interface UserAttributes {
[key: string]:
| undefined
| string
| string[]
| boolean
| boolean[]
| number
| number[]
| Record<string, any>;
/**
* URL path of the current user.
*/
urlPath?: string;
/** @deprecated */
queryString?: string | ParamsMap;
/** @deprecated */
device?: 'mobile' | 'tablet' | 'desktop';
/** @deprecated */
location?: any;
/** @deprecated */
userAgent?: string;
/** @deprecated */
referrer?: string;
/** @deprecated */
entryMedium?: string;
/** @deprecated */
language?: string;
/** @deprecated */
browser?: string;
/** @deprecated */
cookie?: string;
/** @deprecated */
newVisitor?: boolean;
/** @deprecated */
operatingSystem?: string;
}
export interface GetContentOptions {
userAttributes?: UserAttributes;
/**
* Alias for userAttributes.urlPath except it can handle a full URL (optionally with host,
* protocol, query, etc) and we will parse out the path.
*/
url?: string;
/**
* @package
*/
includeUrl?: boolean;
/**
* Follow references. If you use the `reference` field to pull in other content without this
* enabled we will not fetch that content for the final response.
*/
includeRefs?: boolean;
/**
* How long in seconds content should be cached for. Sets the max-age of the cache-control header
* response header.
*
* Use a higher value for better performance, lower for content that will change more frequently
*
* @see {@link https://www.builder.io/c/docs/query-api#__next:~:text=%26includeRefs%3Dtrue-,cacheSeconds,-No}
*/
cacheSeconds?: number;
/**
* Builder.io uses stale-while-revalidate caching at the CDN level. This means we always serve
* from edge cache and update caches in the background for maximum possible performance. This also
* means that the more frequently content is requested, the more fresh it will be. The longest we
* will ever hold something in stale cache is 1 day by default, and you can set this to be shorter
* yourself as well. We suggest keeping this high unless you have content that must change rapidly
* and gets very little traffic.
*
* @see {@link https://www.fastly.com/blog/prevent-application-network-instability-serve-stale-content}
*/
staleCacheSeconds?: number;
/**
* Maximum number of results to return. Defaults to `1`.
*/
limit?: number;
/**
* Mongodb style query of your data. E.g.:
*
* ```
* &query.data.id=abc123
* &query.data.myCustomField=someValue
* &query.data.someNumber.$ne=20
* ```
*
* See more info on MongoDB's query operators and format.
*
* @see {@link https://docs.mongodb.com/manual/reference/operator/query/}
*/
query?: any;
/**
* Bust through all caches. Not recommended for production (for performance),
* but can be useful for development and static builds (so the static site has
* fully fresh / up to date content)
*/
cachebust?: boolean;
/**
* Convert any visual builder content to HTML.
*
* This will be on data.html of the response's content entry object json.
*/
prerender?: boolean;
/**
* Extract any styles to a separate css property when generating HTML.
*/
extractCss?: boolean;
/**
* Pagination results offset. Defaults to zero.
*/
offset?: number;
/**
* @package
*
* `BuilderContent` to render instead of fetching.
*/
initialContent?: any;
/**
* The name of the model to fetch content for.
*/
model?: string;
/**
* Set to `false` to not cache responses when running on the client.
*/
cache?: boolean;
/**
* @package
*
* Indicate that the fetch request is for preview purposes.
*/
preview?: boolean;
/**
* Specific content entry ID to fetch.
*/
entry?: string;
/**
* @package
* @deprecated
*/
alias?: string;
fields?: string;
/**
* Omit only these fields.
*
* @example
* ```
* &omit=data.bigField,data.blocks
* ```
*/
omit?: string;
key?: string;
/**
* @package
*
* Affects HTML generation for specific targets.
*/
format?: 'amp' | 'email' | 'html' | 'react' | 'solid';
/** @deprecated */
noWrap?: true;
/**
* @package
*
* Specific string to use for cache busting. e.g. every time we generate
* HTML we generate a rev (a revision ID) and we send that with each request
* on the client, such that if we generate new server HTML we get a new rev
* and we use that to bust the cache because even though the content ID may
* be the same, it could be an updated version of this content that needs to
* be fresh.
*/
rev?: string;
/**
* @package
*
* Tell the API that when generating HTML to generate it in static mode for
* a/b tests instead of the older way we did this
*/
static?: boolean;
/**
* Additional query params of the Content API to send.
*/
options?: { [key: string]: any };
/**
* @package
*
* Don't listen to updates in the editor - this is useful for embedded
* symbols so they don't accidentally listen to messages as you are editing
* content thinking they should updates when they actually shouldn't.
*/
noEditorUpdates?: boolean;
}
export type Class = {
name?: string;
new (...args: any[]): any;
};
interface Map<K, V> {
clear(): void;
delete(key: K): boolean;
entries(): IterableIterator<[K, V]>;
forEach(callbackfn: (value: V, index: K, map: Map<K, V>) => void, thisArg?: any): void;
get(key: K): V;
has(key: K): boolean;
keys(): IterableIterator<K>;
set(key: K, value?: V): Map<K, V>;
size: number;
values(): IterableIterator<V>;
[Symbol.iterator](): IterableIterator<[K, V]>;
}
export interface Input {
name: string;
friendlyName?: string;
description?: string;
defaultValue?: any;
type: string;
required?: boolean;
autoFocus?: boolean;
subFields?: Input[];
helperText?: string;
allowedFileTypes?: string[];
imageHeight?: number;
imageWidth?: number;
mediaHeight?: number;
mediaWidth?: number;
hideFromUI?: boolean;
modelId?: string;
/**
* Number field type validation maximum accepted input
*/
max?: number;
/**
* Number field type validation minimum accepted input
*/
min?: number;
/**
* Number field type step size when using arrows
*/
step?: number;
/**
* Set this to `true` to show the editor for this input when
* children of this component are selected. This is useful for things
* like Tabs, such that users may not always select the Tabs component
* directly but will still be looking for how to add additional tabs
*/
broadcast?: boolean;
/**
* Set this to `true` to show the editor for this input when
* group locked parents of this component are selected. This is useful
* to bubble up important inputs for locked groups, like text and images
*/
bubble?: boolean;
options?: { [key: string]: any };
enum?: string[] | { label: string; value: any; helperText?: string }[];
/** Regex field validation for all string types (text, longText, html, url, etc) */
regex?: {
/** pattern to test, like "^\/[a-z]$" */
pattern: string;
/** flags for the RegExp constructor, e.g. "gi" */
options?: string;
/**
* Friendly message to display to end-users if the regex fails, e.g.
* "You must use a relative url starting with '/...' "
*/
message: string;
};
advanced?: boolean;
onChange?: Function | string;
code?: boolean;
richText?: boolean;
showIf?: ((options: Map<string, any>) => boolean) | string;
copyOnAdd?: boolean;
}
export interface Component {
/**
* Name your component something unique, e.g. 'MyButton'. You can override built-in components
* by registering a component with the same name, e.g. 'Text', to replace the built-in text component
*/
name: string;
description?: string;
/**
* Link to a documentation page for this component
*/
docsLink?: string;
image?: string;
/**
* Input schema for your component for users to fill in the options
*/
inputs?: Input[];
class?: any;
type?: 'angular' | 'webcomponent' | 'react' | 'vue';
defaultStyles?: { [key: string]: string };
/**
* Turn on if your component can accept children. Be sure to use in combination with
* withChildren(YourComponent) like here
* github.com/BuilderIO/builder/blob/master/examples/react-design-system/src/components/HeroWithChildren/HeroWithChildren.builder.js#L5
*/
canHaveChildren?: boolean;
fragment?: boolean;
/**
* Do not wrap a component in a dom element. Be sure to use {...props.attributes} with this option
* like here github.com/BuilderIO/builder/blob/master/packages/react/src/blocks/forms/Input.tsx#L34
*/
noWrap?: boolean;
/**
* Default children
*/
defaultChildren?: BuilderElement[];
defaults?: Partial<BuilderElement>;
hooks?: { [key: string]: string | Function };
/**
* Hide your component in editor, useful for gradually deprecating components
*/
hideFromInsertMenu?: boolean;
// For webcomponents
tag?: string;
static?: boolean;
/**
* Passing a list of model names will restrict using the component to only the models listed here, otherwise it'll be available for all models
*/
models?: string[];
/**
* Specify restrictions direct children must match
*/
childRequirements?: {
/** Message to show when this doesn't match, e.g. "Children of 'Columns' must be a 'Column'" */
message: string;
/** Simple way to say children must be a specific component name */
component?: string;
/**
* More advanced - specify a MongoDB-style query (using sift.js github.com/crcn/sift.js)
* of what the children objects should match, e.g.
*
* @example
* query: {
* // Child of this element must be a 'Button' or 'Text' component
* 'component.name': { $in: ['Button', 'Text'] }
* }
*/
query?: any;
};
/**
* Specify restrictions any parent must match
*/
requiresParent?: {
/** Message to show when this doesn't match, e.g. "'Add to cart' buttons must be within a 'Product box'" */
message: string;
/** Simple way to say a parent must be a specific component name, e.g. 'Product box' */
component?: string;
/**
* More advanced - specify a MongoDB-style query (using sift.js github.com/crcn/sift.js)
* of what at least one parent in the parents hierarchy should match, e.g.
*
* @example
* query: {
* // Thils element must be somewhere inside either a 'Product box' or 'Collection' component
* 'component.name': { $in: ['Product Box', 'Collection'] }
* }
*/
query?: any;
};
/** not yet implemented */
friendlyName?: string;
/**
* Use to restrict access to your component based on a the current user permissions
* By default components will show to all users
* for more information on permissions in builder check https://www.builder.io/c/docs/guides/roles-and-permissions
*/
requiredPermissions?: Array<Permission>;
}
type Permission = 'read' | 'publish' | 'editCode' | 'editDesigns' | 'admin' | 'create';
type DeepPartial<T> = {
[P in keyof T]?: T[P] extends Array<infer U>
? Array<DeepPartial<U>>
: T[P] extends ReadonlyArray<infer U>
? ReadonlyArray<DeepPartial<U>>
: DeepPartial<T[P]>;
};
export interface InsertMenuItem {
name: string;
icon?: string;
item: DeepPartial<BuilderElement>;
}
export interface InsertMenuConfig {
name: string;
priority?: number;
persist?: boolean;
advanced?: boolean;
items: InsertMenuItem[];
}
export function BuilderComponent(info: Partial<Component> = {}) {
return Builder.Component(info);
}
// TODO
type Settings = any;
export interface Action {
name: string;
inputs?: Input[];
returnType?: Input;
action: Function | string;
}
export class Builder {
static VERSION = version;
static components: Component[] = [];
static singletonInstance: Builder;
/**
* Makes it so that a/b tests generate code like {@link
* https://www.builder.io/blog/high-performance-no-code#__next:~:text=Static%20generated%20A%2FB%20testing}
* instead of the old way where we render only one test group at a time on the
* server. This is the preferred/better way not and we should ultimately make it
* the default
*/
static isStatic = true;
static animator = new Animator();
static nextTick = nextTick;
static throttle = throttle;
static editors: any[] = [];
static trustedHosts: string[] = ['builder.io', 'localhost'];
static plugins: any[] = [];
static actions: Action[] = [];
static registry: { [key: string]: any[] } = {};
static overrideHost: string | undefined;
/**
* @todo `key` property on any info where if a key matches a current
* key it gets removed
*/
static register(type: 'insertMenu', info: InsertMenuConfig): void;
static register(type: string, info: any): void;
static register(type: string, info: any) {
// TODO: all must have name and can't conflict?
let typeList = this.registry[type];
if (!typeList) {
typeList = this.registry[type] = [];
}
typeList.push(info);
if (Builder.isBrowser) {
const message = {
type: 'builder.register',
data: {
type,
info,
},
};
try {
parent.postMessage(message, '*');
if (parent !== window) {
window.postMessage(message, '*');
}
} catch (err) {
console.debug('Could not postmessage', err);
}
}
this.registryChange.next(this.registry);
}
static registryChange = new BehaviorSubject({} as typeof Builder.registry);
static registerEditor(info: any) {
if (Builder.isBrowser) {
window.postMessage(
{
type: 'builder.registerEditor',
data: omit(info, 'component'),
},
'*'
);
const { hostname } = location;
if (!Builder.isTrustedHost(hostname)) {
console.error(
'Builder.registerEditor() called in the wrong environment! You cannot load custom editors from your app, they must be loaded through the Builder.io app itself. Follow the readme here for more details: https://github.com/builderio/builder/tree/master/plugins/cloudinary or contact chat us in our Spectrum community for help: https://spectrum.chat/builder'
);
}
}
this.editors.push(info);
}
static registerPlugin(info: any) {
this.plugins.push(info);
}
static registerAction(action: Action) {
this.actions.push(action);
}
static registerTrustedHost(host: string) {
this.trustedHosts.push(host);
}
static isTrustedHost(hostname: string) {
return (
this.trustedHosts.findIndex(
trustedHost => trustedHost === hostname || hostname.endsWith(`.${trustedHost}`)
) > -1
);
}
static runAction(action: Action | string) {
// TODO
const actionObject =
typeof action === 'string' ? find(this.actions, item => item.name === action) : action;
if (!actionObject) {
throw new Error(`Action not found: ${action}`);
}
}
static fields(name: string, fields: Input[]) {
window.parent?.postMessage(
{
type: 'builder.fields',
data: { name, fields },
},
'*'
);
}
private static _editingPage = false;
static isIframe = isIframe;
static isBrowser = isBrowser;
static isReactNative = isReactNative;
static isServer = !isBrowser && !isReactNative;
static previewingModel = Builder.isBrowser && getQueryParam(location.href, 'builder.preview');
static settings: Settings = {};
static settingsChange = new BehaviorSubject<Settings>({});
static set(settings: Settings) {
if (Builder.isBrowser) {
// TODO: merge
Object.assign(this.settings, settings);
const message = {
type: 'builder.settingsChange',
data: this.settings,
};
parent.postMessage(message, '*');
}
this.settingsChange.next(this.settings);
}
static import(packageName: string) {
if (!Builder.isBrowser) {
// TODO: server side support *maybe*
console.warn('Builder.import used on the server - this should only be used in the browser');
return;
}
const { System } = window as any;
if (!System) {
console.warn('System.js not available. Please include System.js when using Builder.import');
return;
}
return System.import(`https://cdn.builder.io/systemjs/${packageName}`);
}
// TODO: this is quick and dirty, do better implementation later. Also can be unreliable
// if page 301s etc. Use a query param instead? also could have issues with redirects. Injecting var could
// work but is async...
static isEditing = Boolean(
isIframe &&
((document.referrer && document.referrer.match(/builder\.io|localhost:1234/)) ||
location.search.indexOf('builder.frameEditing=') !== -1)
);
static isPreviewing = Boolean(
isBrowser &&
(location.search.indexOf('builder.preview=') !== -1 ||
location.search.indexOf('builder.frameEditing=') !== -1)
);
// useCdnApi = false;
static get editingPage() {
return this._editingPage;
}
static set editingPage(editingPage) {
this._editingPage = editingPage;
if (isBrowser && isIframe) {
if (editingPage) {
document.body.classList.add('builder-editing-page');
} else {
document.body.classList.remove('builder-editing-page');
}
}
}
private static prepareComponentSpecToSend(spec: Component): Component {
return {
...spec,
...(spec.inputs && {
inputs: spec.inputs.map((input: any) => {
// TODO: do for nexted fields too
// TODO: probably just convert all functions, not just
// TODO: put this in input hooks: { onChange: ..., showIf: ... }
const keysToConvertFnToString = ['onChange', 'showIf'];
for (const key of keysToConvertFnToString) {
if (input[key] && typeof input[key] === 'function') {
const fn = input[key];
input = {
...input,
[key]: `return (${fn.toString()}).apply(this, arguments)`,
};
}
}
return input;
}),
}),
hooks: Object.keys(spec.hooks || {}).reduce((memo, key) => {
const value = spec.hooks && spec.hooks[key];
if (!value) {
return memo;
}
if (typeof value === 'string') {
memo[key] = value;
} else {
memo[key] = `return (${value.toString()}).apply(this, arguments)`;
}
return memo;
}, {} as { [key: string]: string }),
class: undefined,
};
}
static registerBlock(component: any, options: Component) {
this.registerComponent(component, options);
}
static registerComponent(component: any, options: Component) {
const spec = {
class: component,
...component.builderOptions,
...options,
};
this.addComponent(spec);
const editable =
options.models && this.singletonInstance.editingModel
? isBrowser && options.models.includes(this.singletonInstance.editingModel)
: isBrowser;
if (editable) {
const sendSpec = this.prepareComponentSpecToSend(spec);
window.parent?.postMessage(
{
type: 'builder.registerComponent',
data: sendSpec,
},
'*'
);
}
}
private static addComponent(component: Component) {
const current = find(this.components, item => item.name === component.name);
if (current) {
// FIXME: why does sometimes we get an extra post without class - probably
// from postMessage handler wrong in some place
if (current.class && !component.class) {
return;
}
this.components.splice(this.components.indexOf(current), 1, component);
} else {
this.components.push(component);
}
}
// TODO: style guide, etc off this system as well?
static component(info: Partial<Component> = {}) {
return (component: Class) => {
const spec = { ...info, class: component };
if (!spec.name) {
spec.name = component.name;
}
this.addComponent(spec as Component);
const sendSpec = this.prepareComponentSpecToSend(spec as Component);
// TODO: serialize component name and inputs
if (isBrowser) {
window.parent?.postMessage(
{
type: 'builder.registerComponent',
data: sendSpec,
},
'*'
);
}
return component;
};
}
static isReact = false;
static get Component() {
return this.component;
}
private eventsQueue: Event[] = [];
private throttledClearEventsQueue = throttle(() => {
this.processEventsQueue();
// Extend the session cookie
this.setCookie(sessionStorageKey, this.sessionId, datePlusMinutes(30));
}, 5);
private processEventsQueue() {
if (!this.eventsQueue.length) {
return;
}
const events = this.eventsQueue;
this.eventsQueue = [];
const fullUserAttributes = {
...Builder.overrideUserAttributes,
...this.trackingUserAttributes,
};
for (const event of events) {
if (!event.data.metadata) {
event.data.metadata = {};
}
if (!event.data.metadata.user) {
event.data.metadata.user = {};
}
Object.assign(event.data.metadata.user, fullUserAttributes, event.data.metadata.user);
}
const host = this.host;
fetch(`${host}/api/v1/track`, {
method: 'POST',
body: JSON.stringify({ events }),
headers: {
'content-type': 'application/json',
},
mode: 'cors',
}).catch(() => {
// Not the end of the world
});
}
env: string = 'production';
sessionId = this.getSessionId();
targetContent = true;
contentPerRequest = 1;
// TODO: make array or function
allowCustomFonts = true;
private cookies: Cookies | null = null;
// TODO: api options object
private cachebust = false;
private overrideParams = '';
private noCache = false;
private preview = false;
get browserTrackingDisabled() {
return Boolean(Builder.isBrowser && (window as any).builderNoTrack);
}
get canTrack() {
return this.canTrack$.value;
}
set canTrack(canTrack) {
if (this.canTrack !== canTrack) {
this.canTrack$.next(canTrack);
}
}
private canTrack$ = new BehaviorSubject(!this.browserTrackingDisabled);
private apiKey$ = new BehaviorSubject<string | null>(null);
private authToken$ = new BehaviorSubject<string | null>(null);
userAttributesChanged = new BehaviorSubject<any>(null);
get editingMode() {
return this.editingMode$.value;
}
set editingMode(value) {
if (value !== this.editingMode) {
this.editingMode$.next(value);
}
}
editingMode$ = new BehaviorSubject(isIframe);