@sitecore-content-sdk/core 1.2.0-canary.8 → 1.2.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/LICENSE.txt +202 -202
- package/README.md +7 -7
- package/dist/cjs/client/sitecore-client.js +33 -17
- package/dist/cjs/config/define-config.js +49 -2
- package/dist/cjs/config-cli/index.js +3 -1
- package/dist/cjs/config-cli/models.js +7 -0
- package/dist/cjs/debug.js +1 -0
- package/dist/cjs/editing/design-library.js +1 -3
- package/dist/cjs/editing/metadata.js +4 -2
- package/dist/cjs/editing/models.js +8 -3
- package/dist/cjs/i18n/index.js +3 -1
- package/dist/cjs/i18n/utils.js +15 -0
- package/dist/cjs/personalize/utils.js +2 -2
- package/dist/cjs/tools/codegen/component-variant.js +50 -0
- package/dist/cjs/tools/codegen/extract-files.js +107 -0
- package/dist/cjs/tools/codegen/import-map.js +359 -0
- package/dist/cjs/tools/codegen/utils.js +418 -0
- package/dist/cjs/tools/generateMetadata.js +2 -2
- package/dist/cjs/tools/generateSites.js +14 -12
- package/dist/cjs/tools/index.js +27 -3
- package/dist/cjs/tools/templating/components.js +199 -4
- package/dist/cjs/tools/templating/index.js +5 -1
- package/dist/cjs/utils/index.js +2 -1
- package/dist/cjs/utils/utils.js +34 -1
- package/dist/esm/client/sitecore-client.js +30 -17
- package/dist/esm/config/define-config.js +49 -2
- package/dist/esm/config-cli/index.js +1 -0
- package/dist/esm/config-cli/models.js +4 -0
- package/dist/esm/debug.js +1 -0
- package/dist/esm/editing/design-library.js +1 -3
- package/dist/esm/editing/metadata.js +4 -2
- package/dist/esm/editing/models.js +7 -2
- package/dist/esm/i18n/index.js +1 -0
- package/dist/esm/i18n/utils.js +12 -0
- package/dist/esm/personalize/utils.js +2 -2
- package/dist/esm/tools/codegen/component-variant.js +42 -0
- package/dist/esm/tools/codegen/extract-files.js +101 -0
- package/dist/esm/tools/codegen/import-map.js +316 -0
- package/dist/esm/tools/codegen/utils.js +373 -0
- package/dist/esm/tools/generateMetadata.js +2 -2
- package/dist/esm/tools/generateSites.js +14 -12
- package/dist/esm/tools/index.js +22 -2
- package/dist/esm/tools/templating/components.js +191 -3
- package/dist/esm/tools/templating/index.js +1 -1
- package/dist/esm/utils/index.js +1 -1
- package/dist/esm/utils/utils.js +32 -0
- package/package.json +2 -2
- package/types/client/sitecore-client.d.ts +20 -1
- package/types/config/models.d.ts +7 -1
- package/types/config-cli/index.d.ts +1 -0
- package/types/config-cli/models.d.ts +4 -0
- package/types/debug.d.ts +1 -0
- package/types/editing/component-layout-service.d.ts +9 -5
- package/types/editing/metadata.d.ts +3 -1
- package/types/editing/models.d.ts +9 -4
- package/types/i18n/index.d.ts +1 -0
- package/types/i18n/utils.d.ts +7 -0
- package/types/layout/utils.d.ts +1 -0
- package/types/tools/codegen/component-variant.d.ts +47 -0
- package/types/tools/codegen/extract-files.d.ts +22 -0
- package/types/tools/codegen/import-map.d.ts +70 -0
- package/types/tools/codegen/utils.d.ts +75 -0
- package/types/tools/generate-map.d.ts +11 -3
- package/types/tools/generateMetadata.d.ts +6 -1
- package/types/tools/generateSites.d.ts +3 -4
- package/types/tools/index.d.ts +14 -2
- package/types/tools/templating/components.d.ts +73 -12
- package/types/tools/templating/index.d.ts +1 -1
- package/types/utils/index.d.ts +1 -1
- package/types/utils/utils.d.ts +10 -1
package/LICENSE.txt
CHANGED
|
@@ -1,202 +1,202 @@
|
|
|
1
|
-
|
|
2
|
-
Apache License
|
|
3
|
-
Version 2.0, January 2004
|
|
4
|
-
http://www.apache.org/licenses/
|
|
5
|
-
|
|
6
|
-
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
-
|
|
8
|
-
1. Definitions.
|
|
9
|
-
|
|
10
|
-
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
-
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
-
|
|
13
|
-
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
-
the copyright owner that is granting the License.
|
|
15
|
-
|
|
16
|
-
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
-
other entities that control, are controlled by, or are under common
|
|
18
|
-
control with that entity. For the purposes of this definition,
|
|
19
|
-
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
-
direction or management of such entity, whether by contract or
|
|
21
|
-
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
-
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
-
|
|
24
|
-
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
-
exercising permissions granted by this License.
|
|
26
|
-
|
|
27
|
-
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
-
including but not limited to software source code, documentation
|
|
29
|
-
source, and configuration files.
|
|
30
|
-
|
|
31
|
-
"Object" form shall mean any form resulting from mechanical
|
|
32
|
-
transformation or translation of a Source form, including but
|
|
33
|
-
not limited to compiled object code, generated documentation,
|
|
34
|
-
and conversions to other media types.
|
|
35
|
-
|
|
36
|
-
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
-
Object form, made available under the License, as indicated by a
|
|
38
|
-
copyright notice that is included in or attached to the work
|
|
39
|
-
(an example is provided in the Appendix below).
|
|
40
|
-
|
|
41
|
-
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
-
form, that is based on (or derived from) the Work and for which the
|
|
43
|
-
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
-
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
-
of this License, Derivative Works shall not include works that remain
|
|
46
|
-
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
-
the Work and Derivative Works thereof.
|
|
48
|
-
|
|
49
|
-
"Contribution" shall mean any work of authorship, including
|
|
50
|
-
the original version of the Work and any modifications or additions
|
|
51
|
-
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
-
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
-
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
-
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
-
means any form of electronic, verbal, or written communication sent
|
|
56
|
-
to the Licensor or its representatives, including but not limited to
|
|
57
|
-
communication on electronic mailing lists, source code control systems,
|
|
58
|
-
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
-
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
-
excluding communication that is conspicuously marked or otherwise
|
|
61
|
-
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
-
|
|
63
|
-
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
-
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
-
subsequently incorporated within the Work.
|
|
66
|
-
|
|
67
|
-
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
-
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
-
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
-
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
-
Work and such Derivative Works in Source or Object form.
|
|
73
|
-
|
|
74
|
-
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
-
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
-
(except as stated in this section) patent license to make, have made,
|
|
78
|
-
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
-
where such license applies only to those patent claims licensable
|
|
80
|
-
by such Contributor that are necessarily infringed by their
|
|
81
|
-
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
-
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
-
institute patent litigation against any entity (including a
|
|
84
|
-
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
-
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
-
or contributory patent infringement, then any patent licenses
|
|
87
|
-
granted to You under this License for that Work shall terminate
|
|
88
|
-
as of the date such litigation is filed.
|
|
89
|
-
|
|
90
|
-
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
-
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
-
modifications, and in Source or Object form, provided that You
|
|
93
|
-
meet the following conditions:
|
|
94
|
-
|
|
95
|
-
(a) You must give any other recipients of the Work or
|
|
96
|
-
Derivative Works a copy of this License; and
|
|
97
|
-
|
|
98
|
-
(b) You must cause any modified files to carry prominent notices
|
|
99
|
-
stating that You changed the files; and
|
|
100
|
-
|
|
101
|
-
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
-
that You distribute, all copyright, patent, trademark, and
|
|
103
|
-
attribution notices from the Source form of the Work,
|
|
104
|
-
excluding those notices that do not pertain to any part of
|
|
105
|
-
the Derivative Works; and
|
|
106
|
-
|
|
107
|
-
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
-
distribution, then any Derivative Works that You distribute must
|
|
109
|
-
include a readable copy of the attribution notices contained
|
|
110
|
-
within such NOTICE file, excluding those notices that do not
|
|
111
|
-
pertain to any part of the Derivative Works, in at least one
|
|
112
|
-
of the following places: within a NOTICE text file distributed
|
|
113
|
-
as part of the Derivative Works; within the Source form or
|
|
114
|
-
documentation, if provided along with the Derivative Works; or,
|
|
115
|
-
within a display generated by the Derivative Works, if and
|
|
116
|
-
wherever such third-party notices normally appear. The contents
|
|
117
|
-
of the NOTICE file are for informational purposes only and
|
|
118
|
-
do not modify the License. You may add Your own attribution
|
|
119
|
-
notices within Derivative Works that You distribute, alongside
|
|
120
|
-
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
-
that such additional attribution notices cannot be construed
|
|
122
|
-
as modifying the License.
|
|
123
|
-
|
|
124
|
-
You may add Your own copyright statement to Your modifications and
|
|
125
|
-
may provide additional or different license terms and conditions
|
|
126
|
-
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
-
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
-
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
-
the conditions stated in this License.
|
|
130
|
-
|
|
131
|
-
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
-
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
-
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
-
this License, without any additional terms or conditions.
|
|
135
|
-
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
-
the terms of any separate license agreement you may have executed
|
|
137
|
-
with Licensor regarding such Contributions.
|
|
138
|
-
|
|
139
|
-
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
-
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
-
except as required for reasonable and customary use in describing the
|
|
142
|
-
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
-
|
|
144
|
-
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
-
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
-
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
-
implied, including, without limitation, any warranties or conditions
|
|
149
|
-
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
-
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
-
appropriateness of using or redistributing the Work and assume any
|
|
152
|
-
risks associated with Your exercise of permissions under this License.
|
|
153
|
-
|
|
154
|
-
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
-
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
-
unless required by applicable law (such as deliberate and grossly
|
|
157
|
-
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
-
liable to You for damages, including any direct, indirect, special,
|
|
159
|
-
incidental, or consequential damages of any character arising as a
|
|
160
|
-
result of this License or out of the use or inability to use the
|
|
161
|
-
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
-
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
-
other commercial damages or losses), even if such Contributor
|
|
164
|
-
has been advised of the possibility of such damages.
|
|
165
|
-
|
|
166
|
-
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
-
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
-
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
-
or other liability obligations and/or rights consistent with this
|
|
170
|
-
License. However, in accepting such obligations, You may act only
|
|
171
|
-
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
-
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
-
defend, and hold each Contributor harmless for any liability
|
|
174
|
-
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
-
of your accepting any such warranty or additional liability.
|
|
176
|
-
|
|
177
|
-
END OF TERMS AND CONDITIONS
|
|
178
|
-
|
|
179
|
-
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
-
|
|
181
|
-
To apply the Apache License to your work, attach the following
|
|
182
|
-
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
-
replaced with your own identifying information. (Don't include
|
|
184
|
-
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
-
comment syntax for the file format. We also recommend that a
|
|
186
|
-
file or class name and description of purpose be included on the
|
|
187
|
-
same "printed page" as the copyright notice for easier
|
|
188
|
-
identification within third-party archives.
|
|
189
|
-
|
|
190
|
-
Copyright [yyyy] [name of copyright owner]
|
|
191
|
-
|
|
192
|
-
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
-
you may not use this file except in compliance with the License.
|
|
194
|
-
You may obtain a copy of the License at
|
|
195
|
-
|
|
196
|
-
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
-
|
|
198
|
-
Unless required by applicable law or agreed to in writing, software
|
|
199
|
-
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
-
See the License for the specific language governing permissions and
|
|
202
|
-
limitations under the License.
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
# Sitecore Content SDK Core
|
|
2
|
-
|
|
3
|
-
This module is provided as a part of Sitecore Content SDK. It contains the core Sitecore Content SDK APIs and utilities.
|
|
4
|
-
|
|
5
|
-
[Documentation](https://doc.sitecore.com/xmc/en/developers/content-sdk/index.html)
|
|
6
|
-
|
|
7
|
-
[API reference documentation](/ref-docs/core/)
|
|
1
|
+
# Sitecore Content SDK Core
|
|
2
|
+
|
|
3
|
+
This module is provided as a part of Sitecore Content SDK. It contains the core Sitecore Content SDK APIs and utilities.
|
|
4
|
+
|
|
5
|
+
[Documentation](https://doc.sitecore.com/xmc/en/developers/content-sdk/index.html)
|
|
6
|
+
|
|
7
|
+
[API reference documentation](/ref-docs/core/)
|
|
@@ -1,4 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
2
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
6
|
exports.SitecoreClient = exports.ErrorPage = void 0;
|
|
4
7
|
const editing_1 = require("../editing");
|
|
@@ -10,6 +13,8 @@ const site_1 = require("../site");
|
|
|
10
13
|
const utils_2 = require("./utils");
|
|
11
14
|
const native_fetcher_1 = require("../native-fetcher");
|
|
12
15
|
const robots_service_1 = require("../site/robots-service");
|
|
16
|
+
const models_1 = require("../editing/models");
|
|
17
|
+
const debug_1 = __importDefault(require("../debug"));
|
|
13
18
|
/**
|
|
14
19
|
* Error page codes
|
|
15
20
|
*/
|
|
@@ -31,6 +36,9 @@ class SitecoreClient {
|
|
|
31
36
|
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
|
|
32
37
|
this.initOptions = initOptions;
|
|
33
38
|
this.clientFactory = this.getClientFactory();
|
|
39
|
+
this.graphQLClient = this.clientFactory({
|
|
40
|
+
debugger: debug_1.default.http,
|
|
41
|
+
});
|
|
34
42
|
const baseServiceOptions = this.getBaseServiceOptions();
|
|
35
43
|
this.layoutService =
|
|
36
44
|
(_b = (_a = initOptions.custom) === null || _a === void 0 ? void 0 : _a.layoutService) !== null && _b !== void 0 ? _b : this.getLayoutService(baseServiceOptions);
|
|
@@ -57,6 +65,16 @@ class SitecoreClient {
|
|
|
57
65
|
.map((part) => part.replace(/^\/+/, '').replace(/\/+$/, ''))
|
|
58
66
|
.join('/')}`;
|
|
59
67
|
}
|
|
68
|
+
/**
|
|
69
|
+
* Execute a raw GraphQL request using the client's configured GraphQL Edge endpoint.
|
|
70
|
+
* This is a thin pass-through to the underlying {@link GraphQLClient.request},
|
|
71
|
+
* @param {string | DocumentNode} query GraphQL query
|
|
72
|
+
* @param {Record<string, unknown>} [variables] Optional variables bag
|
|
73
|
+
* @param {FetchOptions} [fetchOptions] Optional fetch overrides (e.g. fetch, headers)
|
|
74
|
+
*/
|
|
75
|
+
getData(query, variables, fetchOptions) {
|
|
76
|
+
return this.graphQLClient.request(query, variables, fetchOptions);
|
|
77
|
+
}
|
|
60
78
|
/**
|
|
61
79
|
* Get page details for a route, with layout and other details
|
|
62
80
|
* @param {string} path route path
|
|
@@ -150,7 +168,10 @@ class SitecoreClient {
|
|
|
150
168
|
return null;
|
|
151
169
|
}
|
|
152
170
|
// If we're in Pages preview (editing) mode, prefetch the editing data
|
|
153
|
-
const { site, itemId, language, version,
|
|
171
|
+
const { site, itemId, language, version, layoutKind, mode } = previewData;
|
|
172
|
+
const variantIds = Array.isArray(previewData.variantIds)
|
|
173
|
+
? previewData.variantIds
|
|
174
|
+
: previewData.variantIds.split(',');
|
|
154
175
|
const data = await this.editingService.fetchEditingData({
|
|
155
176
|
itemId,
|
|
156
177
|
language,
|
|
@@ -182,17 +203,14 @@ class SitecoreClient {
|
|
|
182
203
|
if (!this.initOptions.api.local) {
|
|
183
204
|
throw new Error('Component Library requires Sitecore apiHost and apiKey to be provided');
|
|
184
205
|
}
|
|
185
|
-
const { itemId, componentUid, site, language, renderingId, dataSourceId, version, mode } = designLibData;
|
|
186
|
-
const componentData = await this.componentService.fetchComponentData({
|
|
187
|
-
siteName: site,
|
|
188
|
-
itemId,
|
|
206
|
+
const { itemId, componentUid, site, language, renderingId, dataSourceId, version, mode, generation, } = designLibData;
|
|
207
|
+
const componentData = await this.componentService.fetchComponentData(Object.assign({ siteName: site, itemId,
|
|
189
208
|
language,
|
|
190
209
|
componentUid,
|
|
191
210
|
renderingId,
|
|
192
211
|
dataSourceId,
|
|
193
212
|
version,
|
|
194
|
-
mode,
|
|
195
|
-
}, fetchOptions);
|
|
213
|
+
mode }, (generation ? { generation } : {})), fetchOptions);
|
|
196
214
|
if (!componentData) {
|
|
197
215
|
throw new Error(`Unable to fetch editing data for preview ${JSON.stringify(designLibData)}`);
|
|
198
216
|
}
|
|
@@ -200,7 +218,7 @@ class SitecoreClient {
|
|
|
200
218
|
locale: designLibData.language,
|
|
201
219
|
layout: componentData,
|
|
202
220
|
siteName: ((_a = componentData.sitecore.context.site) === null || _a === void 0 ? void 0 : _a.name) || site,
|
|
203
|
-
mode: this.getPageMode(mode),
|
|
221
|
+
mode: this.getPageMode(mode, generation),
|
|
204
222
|
};
|
|
205
223
|
return page;
|
|
206
224
|
}
|
|
@@ -334,18 +352,17 @@ class SitecoreClient {
|
|
|
334
352
|
/**
|
|
335
353
|
* Get page mode based on mode name
|
|
336
354
|
* @param {PageModeName} mode - The mode name to get the page mode for
|
|
355
|
+
* @param { DesignLibraryVariantGeneration} generation - The variant generation mode, if applicable
|
|
337
356
|
* @returns {PageMode} The page mode
|
|
338
357
|
*/
|
|
339
|
-
getPageMode(mode) {
|
|
358
|
+
getPageMode(mode, generation) {
|
|
340
359
|
const pageMode = {
|
|
341
360
|
name: mode,
|
|
342
361
|
isNormal: false,
|
|
343
362
|
isPreview: false,
|
|
344
363
|
isEditing: false,
|
|
345
364
|
isDesignLibrary: false,
|
|
346
|
-
designLibrary: {
|
|
347
|
-
isVariantGeneration: false,
|
|
348
|
-
},
|
|
365
|
+
designLibrary: { isVariantGeneration: false },
|
|
349
366
|
};
|
|
350
367
|
switch (mode) {
|
|
351
368
|
case layout_1.LayoutServicePageState.Normal:
|
|
@@ -364,14 +381,13 @@ class SitecoreClient {
|
|
|
364
381
|
pageMode.isDesignLibrary = true;
|
|
365
382
|
pageMode.isEditing = true;
|
|
366
383
|
break;
|
|
367
|
-
case editing_1.DesignLibraryMode.VariantGeneration:
|
|
368
|
-
pageMode.isDesignLibrary = true;
|
|
369
|
-
pageMode.isEditing = true;
|
|
370
|
-
pageMode.designLibrary.isVariantGeneration = true;
|
|
371
|
-
break;
|
|
372
384
|
default:
|
|
373
385
|
break;
|
|
374
386
|
}
|
|
387
|
+
if (pageMode.isDesignLibrary && generation === models_1.DesignLibraryVariantGeneration.Variant) {
|
|
388
|
+
pageMode.designLibrary.isVariantGeneration = true;
|
|
389
|
+
pageMode.isEditing = true;
|
|
390
|
+
}
|
|
375
391
|
return pageMode;
|
|
376
392
|
}
|
|
377
393
|
getClientFactory() {
|
|
@@ -4,6 +4,7 @@ exports.defineConfig = exports.getFallbackConfig = void 0;
|
|
|
4
4
|
exports.deepMerge = deepMerge;
|
|
5
5
|
const constants_1 = require("../constants");
|
|
6
6
|
const retries_1 = require("../retries");
|
|
7
|
+
const config_cli_1 = require("../config-cli");
|
|
7
8
|
/**
|
|
8
9
|
* Provides default initial values for SitecoreConfig
|
|
9
10
|
* @returns default config
|
|
@@ -105,7 +106,7 @@ const resolveConfig = (base, override) => {
|
|
|
105
106
|
}
|
|
106
107
|
return result;
|
|
107
108
|
};
|
|
108
|
-
const
|
|
109
|
+
const validateApiConfiguration = (config) => {
|
|
109
110
|
var _a, _b, _c, _d, _e, _f, _g, _h;
|
|
110
111
|
const isBrowser = typeof window !== 'undefined';
|
|
111
112
|
const hasEdgeContextId = !!((_b = (_a = config.api) === null || _a === void 0 ? void 0 : _a.edge) === null || _b === void 0 ? void 0 : _b.contextId);
|
|
@@ -133,6 +134,45 @@ const validateConfig = (config) => {
|
|
|
133
134
|
}
|
|
134
135
|
}
|
|
135
136
|
};
|
|
137
|
+
/**
|
|
138
|
+
* The validators for the config object during build time.
|
|
139
|
+
* Validators are called when the literal path of the config object is accessed.
|
|
140
|
+
*/
|
|
141
|
+
const PROPERTY_VALIDATORS = {
|
|
142
|
+
api: validateApiConfiguration,
|
|
143
|
+
};
|
|
144
|
+
/**
|
|
145
|
+
* Creates a proxy for the config object to validate the config object during build time.
|
|
146
|
+
* @param {SitecoreConfig} config - The config object to create a proxy for.
|
|
147
|
+
* @returns {SitecoreConfig} The proxy for the config object.
|
|
148
|
+
*/
|
|
149
|
+
const createConfigProxy = (config) => {
|
|
150
|
+
const validated = new Set();
|
|
151
|
+
const createProxy = (target, propPath = '') => {
|
|
152
|
+
return new Proxy(target, {
|
|
153
|
+
get(obj, prop, receiver) {
|
|
154
|
+
// Skip symbol properties, do not attempt to stringify them
|
|
155
|
+
// Type safety check
|
|
156
|
+
if (typeof prop === 'symbol') {
|
|
157
|
+
return Reflect.get(obj, prop, receiver);
|
|
158
|
+
}
|
|
159
|
+
const fullPath = propPath ? `${propPath}.${prop}` : prop;
|
|
160
|
+
const value = Reflect.get(obj, prop, receiver);
|
|
161
|
+
if (fullPath in PROPERTY_VALIDATORS &&
|
|
162
|
+
!validated.has(fullPath)) {
|
|
163
|
+
const validator = PROPERTY_VALIDATORS[fullPath];
|
|
164
|
+
validator(config);
|
|
165
|
+
validated.add(fullPath);
|
|
166
|
+
}
|
|
167
|
+
if (typeof value === 'object' && value !== null && !Array.isArray(value)) {
|
|
168
|
+
return createProxy(value, fullPath);
|
|
169
|
+
}
|
|
170
|
+
return value;
|
|
171
|
+
},
|
|
172
|
+
});
|
|
173
|
+
};
|
|
174
|
+
return createProxy(config);
|
|
175
|
+
};
|
|
136
176
|
/**
|
|
137
177
|
* Accepts a SitecoreConfigInput object and returns full sitecore configuration
|
|
138
178
|
* @param {SitecoreConfigInput} config override values to be written over default config settings
|
|
@@ -140,7 +180,14 @@ const validateConfig = (config) => {
|
|
|
140
180
|
*/
|
|
141
181
|
const defineConfig = (config) => {
|
|
142
182
|
const resolvedConfig = resolveConfig((0, exports.getFallbackConfig)(), config);
|
|
143
|
-
|
|
183
|
+
const isCLI = process.env[config_cli_1.SITECORE_CLI_MODE_ENV_VAR] === 'true';
|
|
184
|
+
// At `build time`, we create a proxy for the config object to validate the config by
|
|
185
|
+
// accessing the literal paths instead of validating the whole object at once.
|
|
186
|
+
// At `runtime` all the config should be validated to fail fast in case of invalid configuration.
|
|
187
|
+
if (isCLI) {
|
|
188
|
+
return createConfigProxy(resolvedConfig);
|
|
189
|
+
}
|
|
190
|
+
validateApiConfiguration(resolvedConfig);
|
|
144
191
|
return resolvedConfig;
|
|
145
192
|
};
|
|
146
193
|
exports.defineConfig = defineConfig;
|
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.defineCliConfig = void 0;
|
|
3
|
+
exports.SITECORE_CLI_MODE_ENV_VAR = exports.defineCliConfig = void 0;
|
|
4
4
|
var define_cli_config_1 = require("./define-cli-config");
|
|
5
5
|
Object.defineProperty(exports, "defineCliConfig", { enumerable: true, get: function () { return define_cli_config_1.defineCliConfig; } });
|
|
6
|
+
var models_1 = require("./models");
|
|
7
|
+
Object.defineProperty(exports, "SITECORE_CLI_MODE_ENV_VAR", { enumerable: true, get: function () { return models_1.SITECORE_CLI_MODE_ENV_VAR; } });
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.SITECORE_CLI_MODE_ENV_VAR = void 0;
|
|
4
|
+
/**
|
|
5
|
+
* Environment variable to indicate that the application is running in CLI mode
|
|
6
|
+
*/
|
|
7
|
+
exports.SITECORE_CLI_MODE_ENV_VAR = 'SITECORE_CLI_MODE';
|
package/dist/cjs/debug.js
CHANGED
|
@@ -40,6 +40,7 @@ exports.default = {
|
|
|
40
40
|
robots: (0, debug_1.default)(`${rootNamespace}:robots`),
|
|
41
41
|
redirects: (0, debug_1.default)(`${rootNamespace}:redirects`),
|
|
42
42
|
personalize: (0, debug_1.default)(`${rootNamespace}:personalize`),
|
|
43
|
+
locale: (0, debug_1.default)(`${rootNamespace}:locale`),
|
|
43
44
|
errorpages: (0, debug_1.default)(`${rootNamespace}:errorpages`),
|
|
44
45
|
proxy: (0, debug_1.default)(`${rootNamespace}:proxy`),
|
|
45
46
|
};
|