@salesforce/lds-adapters-experience-model 1.313.0 → 1.315.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.
@@ -373,7 +373,7 @@ const getBlockTypesAdapterFactory = (luvio) => function ExperienceType__getBlock
373
373
  };
374
374
 
375
375
  const TTL$5 = 3600000;
376
- const VERSION$5 = "5a3f5e1d42d8f0aa089e888ddac06972";
376
+ const VERSION$5 = "a0031d20c176201daecd591a08fcdc75";
377
377
  function validate$f(obj, path = 'ExperienceModelBlockTypeDetailRepresentation') {
378
378
  const v_error = (() => {
379
379
  if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
@@ -407,6 +407,22 @@ function validate$f(obj, path = 'ExperienceModelBlockTypeDetailRepresentation')
407
407
  if (typeof obj_developerName !== 'string') {
408
408
  return new TypeError('Expected "string" but received "' + typeof obj_developerName + '" (at "' + path_developerName + '")');
409
409
  }
410
+ if (obj.editorConfig !== undefined) {
411
+ const obj_editorConfig = obj.editorConfig;
412
+ const path_editorConfig = path + '.editorConfig';
413
+ if (typeof obj_editorConfig !== 'object' || ArrayIsArray(obj_editorConfig) || obj_editorConfig === null) {
414
+ return new TypeError('Expected "object" but received "' + typeof obj_editorConfig + '" (at "' + path_editorConfig + '")');
415
+ }
416
+ const obj_editorConfig_keys = ObjectKeys(obj_editorConfig);
417
+ for (let i = 0; i < obj_editorConfig_keys.length; i++) {
418
+ const key = obj_editorConfig_keys[i];
419
+ const obj_editorConfig_prop = obj_editorConfig[key];
420
+ const path_editorConfig_prop = path_editorConfig + '["' + key + '"]';
421
+ if (obj_editorConfig_prop === undefined) {
422
+ return new TypeError('Expected "defined" but received "' + typeof obj_editorConfig_prop + '" (at "' + path_editorConfig_prop + '")');
423
+ }
424
+ }
425
+ }
410
426
  if (obj.id !== undefined) {
411
427
  const obj_id = obj.id;
412
428
  const path_id = path + '.id';
@@ -419,6 +435,22 @@ function validate$f(obj, path = 'ExperienceModelBlockTypeDetailRepresentation')
419
435
  if (typeof obj_namespacePrefix !== 'string') {
420
436
  return new TypeError('Expected "string" but received "' + typeof obj_namespacePrefix + '" (at "' + path_namespacePrefix + '")');
421
437
  }
438
+ if (obj.rendererConfig !== undefined) {
439
+ const obj_rendererConfig = obj.rendererConfig;
440
+ const path_rendererConfig = path + '.rendererConfig';
441
+ if (typeof obj_rendererConfig !== 'object' || ArrayIsArray(obj_rendererConfig) || obj_rendererConfig === null) {
442
+ return new TypeError('Expected "object" but received "' + typeof obj_rendererConfig + '" (at "' + path_rendererConfig + '")');
443
+ }
444
+ const obj_rendererConfig_keys = ObjectKeys(obj_rendererConfig);
445
+ for (let i = 0; i < obj_rendererConfig_keys.length; i++) {
446
+ const key = obj_rendererConfig_keys[i];
447
+ const obj_rendererConfig_prop = obj_rendererConfig[key];
448
+ const path_rendererConfig_prop = path_rendererConfig + '["' + key + '"]';
449
+ if (obj_rendererConfig_prop === undefined) {
450
+ return new TypeError('Expected "defined" but received "' + typeof obj_rendererConfig_prop + '" (at "' + path_rendererConfig_prop + '")');
451
+ }
452
+ }
453
+ }
422
454
  if (obj.renditionConfig !== undefined) {
423
455
  const obj_renditionConfig = obj.renditionConfig;
424
456
  const path_renditionConfig = path + '.renditionConfig';
@@ -503,7 +535,7 @@ function select$a(luvio, params) {
503
535
  return select$b();
504
536
  }
505
537
  function keyBuilder$b(luvio, params) {
506
- return keyPrefix + '::ExperienceModelBlockTypeDetailRepresentation:(' + 'designConfigTarget:' + params.queryParams.designConfigTarget + ',' + 'includeSubSchemaDefinitions:' + params.queryParams.includeSubSchemaDefinitions + ',' + 'language:' + params.queryParams.language + ',' + 'renditionConfigTarget:' + params.queryParams.renditionConfigTarget + ',' + 'fullyQualifiedName:' + params.urlParams.fullyQualifiedName + ')';
538
+ return keyPrefix + '::ExperienceModelBlockTypeDetailRepresentation:(' + 'editorConfigTarget:' + params.queryParams.editorConfigTarget + ',' + 'designConfigTarget:' + params.queryParams.designConfigTarget + ',' + 'includeSubSchemaDefinitions:' + params.queryParams.includeSubSchemaDefinitions + ',' + 'language:' + params.queryParams.language + ',' + 'rendererConfigTarget:' + params.queryParams.rendererConfigTarget + ',' + 'renditionConfigTarget:' + params.queryParams.renditionConfigTarget + ',' + 'fullyQualifiedName:' + params.urlParams.fullyQualifiedName + ')';
507
539
  }
508
540
  function getResponseCacheKeys$5(storeKeyMap, luvio, resourceParams, response) {
509
541
  getTypeCacheKeys$5(storeKeyMap, luvio, response, () => keyBuilder$b(luvio, resourceParams));
@@ -554,9 +586,11 @@ function createResourceRequest$5(config) {
554
586
  const adapterName$5 = 'getBlockType';
555
587
  const getBlockType_ConfigPropertyMetadata = [
556
588
  generateParamConfigMetadata('fullyQualifiedName', true, 0 /* UrlParameter */, 0 /* String */),
589
+ generateParamConfigMetadata('editorConfigTarget', false, 1 /* QueryParameter */, 0 /* String */),
557
590
  generateParamConfigMetadata('designConfigTarget', false, 1 /* QueryParameter */, 0 /* String */),
558
591
  generateParamConfigMetadata('includeSubSchemaDefinitions', false, 1 /* QueryParameter */, 1 /* Boolean */),
559
592
  generateParamConfigMetadata('language', false, 1 /* QueryParameter */, 0 /* String */),
593
+ generateParamConfigMetadata('rendererConfigTarget', false, 1 /* QueryParameter */, 0 /* String */),
560
594
  generateParamConfigMetadata('renditionConfigTarget', false, 1 /* QueryParameter */, 0 /* String */),
561
595
  ];
562
596
  const getBlockType_ConfigPropertyNames = /*#__PURE__*/ buildAdapterValidationConfig(adapterName$5, getBlockType_ConfigPropertyMetadata);
@@ -7,9 +7,11 @@ export declare const getBlockType_ConfigPropertyMetadata: $64$luvio_engine_Adapt
7
7
  export declare const getBlockType_ConfigPropertyNames: adapter$45$utils_AdapterValidationConfig;
8
8
  export interface GetBlockTypeConfig {
9
9
  fullyQualifiedName: string;
10
+ editorConfigTarget?: string;
10
11
  designConfigTarget?: string;
11
12
  includeSubSchemaDefinitions?: boolean;
12
13
  language?: string;
14
+ rendererConfigTarget?: string;
13
15
  renditionConfigTarget?: string;
14
16
  }
15
17
  export declare const createResourceParams: (config: GetBlockTypeConfig) => resources_getConnectExperienceModelBlockTypesByFullyQualifiedName_ResourceRequestConfig;
@@ -5,9 +5,11 @@ export interface ResourceRequestConfig {
5
5
  fullyQualifiedName: string;
6
6
  };
7
7
  queryParams: {
8
+ editorConfigTarget?: string;
8
9
  designConfigTarget?: string;
9
10
  includeSubSchemaDefinitions?: boolean;
10
11
  language?: string;
12
+ rendererConfigTarget?: string;
11
13
  renditionConfigTarget?: string;
12
14
  };
13
15
  }
@@ -1,6 +1,6 @@
1
1
  import { IngestPath as $64$luvio_engine_IngestPath, Luvio as $64$luvio_engine_Luvio, Store as $64$luvio_engine_Store, BaseFragment as $64$luvio_engine_BaseFragment, ResourceIngest as $64$luvio_engine_ResourceIngest, DurableStoreKeyMetadataMap as $64$luvio_engine_DurableStoreKeyMetadataMap, NormalizedKeyMetadata as $64$luvio_engine_NormalizedKeyMetadata } from '@luvio/engine';
2
2
  export declare const TTL = 3600000;
3
- export declare const VERSION = "5a3f5e1d42d8f0aa089e888ddac06972";
3
+ export declare const VERSION = "a0031d20c176201daecd591a08fcdc75";
4
4
  export declare function validate(obj: any, path?: string): TypeError | null;
5
5
  export declare const RepresentationType: string;
6
6
  export declare function normalize(input: ExperienceModelBlockTypeDetailRepresentation, existing: ExperienceModelBlockTypeDetailRepresentationNormalized, path: $64$luvio_engine_IngestPath, luvio: $64$luvio_engine_Luvio, store: $64$luvio_engine_Store, timestamp: number): ExperienceModelBlockTypeDetailRepresentationNormalized;
@@ -23,10 +23,18 @@ export interface ExperienceModelBlockTypeDetailRepresentationNormalized {
23
23
  };
24
24
  /** The developer name (aka apiName) of the Block Type. */
25
25
  developerName: string;
26
+ /** The editor configuration for the specified target. */
27
+ editorConfig?: {
28
+ [key: string]: unknown;
29
+ };
26
30
  /** The 18-char String ID of the Block Type. This is returned for the Custom Block Types only. */
27
31
  id?: string;
28
32
  /** The namespace prefix that is associated with the Block Type. Refer to a Block Type using the namespacePrefix__developerName notation (aka fullyQualifiedName) */
29
33
  namespacePrefix: string;
34
+ /** The renderer configuration for the specified target. */
35
+ rendererConfig?: {
36
+ [key: string]: unknown;
37
+ };
30
38
  /** The rendition configuration for the specified target. */
31
39
  renditionConfig?: {
32
40
  [key: string]: unknown;
@@ -50,8 +58,14 @@ export interface ExperienceModelBlockTypeDetailRepresentation {
50
58
  [key: string]: unknown;
51
59
  };
52
60
  developerName: string;
61
+ editorConfig?: {
62
+ [key: string]: unknown;
63
+ };
53
64
  id?: string;
54
65
  namespacePrefix: string;
66
+ rendererConfig?: {
67
+ [key: string]: unknown;
68
+ };
55
69
  renditionConfig?: {
56
70
  [key: string]: unknown;
57
71
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@salesforce/lds-adapters-experience-model",
3
- "version": "1.313.0",
3
+ "version": "1.315.0",
4
4
  "license": "SEE LICENSE IN LICENSE.txt",
5
5
  "description": "APIs to read and query all the 'types' in the Unified Experience Model",
6
6
  "main": "dist/es/es2018/experience-model.js",
@@ -44,11 +44,11 @@
44
44
  "test:unit": "jest"
45
45
  },
46
46
  "dependencies": {
47
- "@salesforce/lds-bindings": "^1.313.0"
47
+ "@salesforce/lds-bindings": "^1.315.0"
48
48
  },
49
49
  "devDependencies": {
50
- "@salesforce/lds-compiler-plugins": "^1.313.0",
51
- "@salesforce/lds-karma": "^1.313.0"
50
+ "@salesforce/lds-compiler-plugins": "^1.315.0",
51
+ "@salesforce/lds-karma": "^1.315.0"
52
52
  },
53
53
  "nx": {
54
54
  "targets": {
package/sfdc/index.js CHANGED
@@ -91,7 +91,7 @@ function createLink(ref) {
91
91
  }
92
92
 
93
93
  const TTL$6 = 3600000;
94
- const VERSION$6 = "5a3f5e1d42d8f0aa089e888ddac06972";
94
+ const VERSION$6 = "a0031d20c176201daecd591a08fcdc75";
95
95
  function validate$h(obj, path = 'ExperienceModelBlockTypeDetailRepresentation') {
96
96
  const v_error = (() => {
97
97
  if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
@@ -125,6 +125,22 @@ function validate$h(obj, path = 'ExperienceModelBlockTypeDetailRepresentation')
125
125
  if (typeof obj_developerName !== 'string') {
126
126
  return new TypeError('Expected "string" but received "' + typeof obj_developerName + '" (at "' + path_developerName + '")');
127
127
  }
128
+ if (obj.editorConfig !== undefined) {
129
+ const obj_editorConfig = obj.editorConfig;
130
+ const path_editorConfig = path + '.editorConfig';
131
+ if (typeof obj_editorConfig !== 'object' || ArrayIsArray(obj_editorConfig) || obj_editorConfig === null) {
132
+ return new TypeError('Expected "object" but received "' + typeof obj_editorConfig + '" (at "' + path_editorConfig + '")');
133
+ }
134
+ const obj_editorConfig_keys = ObjectKeys(obj_editorConfig);
135
+ for (let i = 0; i < obj_editorConfig_keys.length; i++) {
136
+ const key = obj_editorConfig_keys[i];
137
+ const obj_editorConfig_prop = obj_editorConfig[key];
138
+ const path_editorConfig_prop = path_editorConfig + '["' + key + '"]';
139
+ if (obj_editorConfig_prop === undefined) {
140
+ return new TypeError('Expected "defined" but received "' + typeof obj_editorConfig_prop + '" (at "' + path_editorConfig_prop + '")');
141
+ }
142
+ }
143
+ }
128
144
  if (obj.id !== undefined) {
129
145
  const obj_id = obj.id;
130
146
  const path_id = path + '.id';
@@ -137,6 +153,22 @@ function validate$h(obj, path = 'ExperienceModelBlockTypeDetailRepresentation')
137
153
  if (typeof obj_namespacePrefix !== 'string') {
138
154
  return new TypeError('Expected "string" but received "' + typeof obj_namespacePrefix + '" (at "' + path_namespacePrefix + '")');
139
155
  }
156
+ if (obj.rendererConfig !== undefined) {
157
+ const obj_rendererConfig = obj.rendererConfig;
158
+ const path_rendererConfig = path + '.rendererConfig';
159
+ if (typeof obj_rendererConfig !== 'object' || ArrayIsArray(obj_rendererConfig) || obj_rendererConfig === null) {
160
+ return new TypeError('Expected "object" but received "' + typeof obj_rendererConfig + '" (at "' + path_rendererConfig + '")');
161
+ }
162
+ const obj_rendererConfig_keys = ObjectKeys(obj_rendererConfig);
163
+ for (let i = 0; i < obj_rendererConfig_keys.length; i++) {
164
+ const key = obj_rendererConfig_keys[i];
165
+ const obj_rendererConfig_prop = obj_rendererConfig[key];
166
+ const path_rendererConfig_prop = path_rendererConfig + '["' + key + '"]';
167
+ if (obj_rendererConfig_prop === undefined) {
168
+ return new TypeError('Expected "defined" but received "' + typeof obj_rendererConfig_prop + '" (at "' + path_rendererConfig_prop + '")');
169
+ }
170
+ }
171
+ }
140
172
  if (obj.renditionConfig !== undefined) {
141
173
  const obj_renditionConfig = obj.renditionConfig;
142
174
  const path_renditionConfig = path + '.renditionConfig';
@@ -221,7 +253,7 @@ function select$c(luvio, params) {
221
253
  return select$d();
222
254
  }
223
255
  function keyBuilder$d(luvio, params) {
224
- return keyPrefix + '::ExperienceModelBlockTypeDetailRepresentation:(' + 'designConfigTarget:' + params.queryParams.designConfigTarget + ',' + 'includeSubSchemaDefinitions:' + params.queryParams.includeSubSchemaDefinitions + ',' + 'language:' + params.queryParams.language + ',' + 'renditionConfigTarget:' + params.queryParams.renditionConfigTarget + ',' + 'fullyQualifiedName:' + params.urlParams.fullyQualifiedName + ')';
256
+ return keyPrefix + '::ExperienceModelBlockTypeDetailRepresentation:(' + 'editorConfigTarget:' + params.queryParams.editorConfigTarget + ',' + 'designConfigTarget:' + params.queryParams.designConfigTarget + ',' + 'includeSubSchemaDefinitions:' + params.queryParams.includeSubSchemaDefinitions + ',' + 'language:' + params.queryParams.language + ',' + 'rendererConfigTarget:' + params.queryParams.rendererConfigTarget + ',' + 'renditionConfigTarget:' + params.queryParams.renditionConfigTarget + ',' + 'fullyQualifiedName:' + params.urlParams.fullyQualifiedName + ')';
225
257
  }
226
258
  function getResponseCacheKeys$6(storeKeyMap, luvio, resourceParams, response) {
227
259
  getTypeCacheKeys$6(storeKeyMap, luvio, response, () => keyBuilder$d(luvio, resourceParams));
@@ -272,9 +304,11 @@ function createResourceRequest$6(config) {
272
304
  const adapterName$6 = 'getBlockType';
273
305
  const getBlockType_ConfigPropertyMetadata = [
274
306
  generateParamConfigMetadata('fullyQualifiedName', true, 0 /* UrlParameter */, 0 /* String */),
307
+ generateParamConfigMetadata('editorConfigTarget', false, 1 /* QueryParameter */, 0 /* String */),
275
308
  generateParamConfigMetadata('designConfigTarget', false, 1 /* QueryParameter */, 0 /* String */),
276
309
  generateParamConfigMetadata('includeSubSchemaDefinitions', false, 1 /* QueryParameter */, 1 /* Boolean */),
277
310
  generateParamConfigMetadata('language', false, 1 /* QueryParameter */, 0 /* String */),
311
+ generateParamConfigMetadata('rendererConfigTarget', false, 1 /* QueryParameter */, 0 /* String */),
278
312
  generateParamConfigMetadata('renditionConfigTarget', false, 1 /* QueryParameter */, 0 /* String */),
279
313
  ];
280
314
  const getBlockType_ConfigPropertyNames = /*#__PURE__*/ buildAdapterValidationConfig(adapterName$6, getBlockType_ConfigPropertyMetadata);
@@ -2313,4 +2347,4 @@ withDefaultLuvio((luvio) => {
2313
2347
  });
2314
2348
 
2315
2349
  export { getBlockType, getBlockType_imperative, getBlockTypes, getBlockTypes_imperative, getContentType, getContentType_imperative, getContentTypes, getContentTypes_imperative, getPropertyType, getPropertyType_imperative, getPropertyTypes, getPropertyTypes_imperative, getTypes, getTypes_imperative };
2316
- // version: 1.313.0-19e9b0d234
2350
+ // version: 1.315.0-b7eff13c6d
package/src/raml/api.raml CHANGED
@@ -101,6 +101,13 @@ types:
101
101
  description: The description of the Block Type that was given in its schema.json.
102
102
  type: string
103
103
  required: false # TODO waiting on W-8253396
104
+ editorConfig:
105
+ description: The editor configuration for the specified target.
106
+ type: object
107
+ required: false # TODO waiting on W-8253396
108
+ properties:
109
+ //:
110
+ type: any # TODO waiting on W-8253396
104
111
  designConfig:
105
112
  description: The design configuration for the specified target.
106
113
  type: object
@@ -121,6 +128,13 @@ types:
121
128
  Refer to a Block Type using the namespacePrefix__developerName notation
122
129
  (aka fullyQualifiedName)
123
130
  type: string
131
+ rendererConfig:
132
+ description: The renderer configuration for the specified target.
133
+ type: object
134
+ required: false # TODO waiting on W-8253396
135
+ properties:
136
+ //:
137
+ type: any # TODO waiting on W-8253396
124
138
  renditionConfig:
125
139
  description: The rendition configuration for the specified target.
126
140
  type: object
@@ -3595,6 +3609,16 @@ types:
3595
3609
  application/json:
3596
3610
  type: ExperienceModelBlockTypeDetailRepresentation
3597
3611
  queryParameters:
3612
+ editorConfigTarget:
3613
+ description: A editor configuration target. To get the editor configuration
3614
+ also included for a particular target in the response. If not specified,
3615
+ no editor configuration is included in the response.
3616
+ type: string
3617
+ required: false
3618
+ enum:
3619
+ - BlockBuilder
3620
+ - CmsContentEditor
3621
+ - Default
3598
3622
  designConfigTarget:
3599
3623
  description: A design configuration target. To get the design configuration
3600
3624
  also included for a particular target in the response. If not specified,
@@ -3618,6 +3642,17 @@ types:
3618
3642
  in case translations don't exist.
3619
3643
  type: string
3620
3644
  required: false
3645
+ rendererConfigTarget:
3646
+ description: A renderer configuration target. To get the renderer configuration
3647
+ also included for a particular target in the response. If not specified,
3648
+ no renderer configuration is included in the response.
3649
+ type: string
3650
+ required: false
3651
+ enum:
3652
+ - CmsContentDetail
3653
+ - Default
3654
+ - Email
3655
+ - Lwr
3621
3656
  renditionConfigTarget:
3622
3657
  description: A rendition configuration target. To get the rendition configuration
3623
3658
  also included for a particular target in the response. If not specified,
@@ -92,6 +92,8 @@ types:
92
92
  "fullyQualifiedName":"sfdc_cms__heading",
93
93
  "language":"en_US",
94
94
  "includeSubSchemaDefinitions":false,
95
+ "editorConfigTarget":"DEFAULT",
96
+ "rendererConfigTarget":"DEFAULT",
95
97
  "designConfigTarget":"DEFAULT",
96
98
  "renditionConfigTarget":"DEFAULT"
97
99
  }