@enonic/nextjs-adapter 0.0.1-alpha.3 → 0.0.1-alpha.5

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.
Files changed (46) hide show
  1. package/LICENSE +201 -0
  2. package/dist/ComponentRegistry.d.ts +61 -0
  3. package/dist/ComponentRegistry.js +115 -0
  4. package/dist/UrlProcessor.d.ts +21 -0
  5. package/dist/UrlProcessor.js +54 -0
  6. package/dist/baseMappings.d.ts +1 -0
  7. package/dist/baseMappings.js +38 -0
  8. package/dist/guillotine/fetchContent.d.ts +82 -0
  9. package/dist/guillotine/fetchContent.js +644 -0
  10. package/dist/guillotine/getMetaData.d.ts +91 -0
  11. package/dist/guillotine/getMetaData.js +128 -0
  12. package/dist/index.d.ts +2 -0
  13. package/dist/index.js +2 -0
  14. package/dist/utils.d.ts +64 -0
  15. package/dist/utils.js +146 -0
  16. package/dist/views/BaseComponent.d.ts +25 -0
  17. package/dist/views/BaseComponent.jsx +114 -0
  18. package/dist/views/BaseContent.d.ts +4 -0
  19. package/dist/views/BaseContent.jsx +41 -0
  20. package/dist/views/BaseLayout.d.ts +17 -0
  21. package/dist/views/BaseLayout.jsx +24 -0
  22. package/dist/views/BaseMacro.d.ts +16 -0
  23. package/dist/views/BaseMacro.jsx +85 -0
  24. package/dist/views/BasePage.d.ts +19 -0
  25. package/dist/views/BasePage.jsx +34 -0
  26. package/dist/views/BasePart.d.ts +19 -0
  27. package/dist/views/BasePart.jsx +24 -0
  28. package/dist/views/Empty.d.ts +3 -0
  29. package/dist/views/Empty.jsx +3 -0
  30. package/dist/views/Fragment.d.ts +10 -0
  31. package/dist/views/Fragment.jsx +25 -0
  32. package/dist/views/MainView.d.ts +4 -0
  33. package/dist/views/MainView.jsx +14 -0
  34. package/dist/views/Region.d.ts +20 -0
  35. package/dist/views/Region.jsx +57 -0
  36. package/dist/views/RichTextView.d.ts +15 -0
  37. package/dist/views/RichTextView.jsx +55 -0
  38. package/dist/views/SingleComponent.d.ts +5 -0
  39. package/dist/views/SingleComponent.jsx +11 -0
  40. package/dist/views/Text.d.ts +9 -0
  41. package/dist/views/Text.jsx +4 -0
  42. package/dist/views/macros/DefaultMacro.d.ts +4 -0
  43. package/dist/views/macros/DefaultMacro.jsx +3 -0
  44. package/dist/views/macros/DisableMacro.d.ts +3 -0
  45. package/dist/views/macros/DisableMacro.jsx +2 -0
  46. package/package.json +6 -4
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,61 @@
1
+ /// <reference types="react" />
2
+ import { PageComponent } from './guillotine/getMetaData';
3
+ import { Context } from './guillotine/fetchContent';
4
+ /**
5
+ * Object that configures the handling of a particular content type. All attributes are optional (see examples below), and missing values will fall back to default behavior:
6
+ * - 'query' (used in fetchContent.ts) Guillotine query for fetching content data, may also have a function that supplies guillotine variables. So, 'query' can EITHER be only a query string, OR also add a get-guillotine-variables function. In the latter case, 'query' can be an object with 'query' and 'variables' attributes, or an array where the query string is first and the get-variables function is second. Either way, the get-variables function takes two arguments: path (content path, mandatory) and context (next.js-supplied Context from getServerSideProps etc. Optional, and requires that fetchContent is called with the context, of course).
7
+ * - 'props' (used in fetchContent.ts) is a function for processing props after fetching them
8
+ * - 'view' (used in BasePage.tsx) is a React component: top-level content-type-specific rendering with the props first fetched from guillotine (and then optionally preprocessed with the function in 'props').
9
+ */
10
+ export interface ComponentDefinition {
11
+ catchAll?: boolean;
12
+ query?: SelectedQueryMaybeVariablesFunc;
13
+ configQuery?: string;
14
+ processor?: DataProcessor;
15
+ view?: React.FunctionComponent<any>;
16
+ }
17
+ export declare type DataProcessor = (data: any, context?: Context) => Promise<Record<string, any>>;
18
+ export declare type VariablesGetter = (path: string, context?: Context, config?: any) => VariablesGetterResult;
19
+ export declare type VariablesGetterResult = {
20
+ [variables: string]: any;
21
+ path: string;
22
+ };
23
+ export declare type SelectedQueryMaybeVariablesFunc = string | {
24
+ query: string;
25
+ variables: VariablesGetter;
26
+ } | [
27
+ string,
28
+ VariablesGetter
29
+ ];
30
+ export declare const CATCH_ALL = "*";
31
+ export declare class ComponentRegistry {
32
+ private static contentTypes;
33
+ private static pages;
34
+ private static components;
35
+ private static parts;
36
+ private static layouts;
37
+ private static macros;
38
+ private static commonQuery;
39
+ static getByComponent(component: PageComponent): ComponentDefinition | undefined;
40
+ static setCommonQuery(query: SelectedQueryMaybeVariablesFunc): void;
41
+ static getCommonQuery(): SelectedQueryMaybeVariablesFunc;
42
+ static addMacro(name: string, obj: ComponentDefinition): void;
43
+ static getMacro(name: string): ComponentDefinition | undefined;
44
+ static getMacros(): [string, ComponentDefinition][];
45
+ static getParts(): [string, ComponentDefinition][];
46
+ static getLayouts(): [string, ComponentDefinition][];
47
+ static getPages(): [string, ComponentDefinition][];
48
+ static addContentType(name: string, obj: ComponentDefinition): void;
49
+ static getContentType(name: string): ComponentDefinition | undefined;
50
+ static addPage(name: string, obj: ComponentDefinition): void;
51
+ static getPage(name: string): ComponentDefinition | undefined;
52
+ static addPart(name: string, obj: ComponentDefinition): void;
53
+ static getPart(name: string): ComponentDefinition | undefined;
54
+ static addLayout(name: string, obj: ComponentDefinition): void;
55
+ static getLayout(name: string): ComponentDefinition | undefined;
56
+ static addComponent(name: string, obj: ComponentDefinition): void;
57
+ static getComponent(name: string): ComponentDefinition | undefined;
58
+ private static getSelector;
59
+ private static getType;
60
+ private static addType;
61
+ }
@@ -0,0 +1,115 @@
1
+ import { XP_COMPONENT_TYPE } from './utils';
2
+ function toSelectorName(type) {
3
+ switch (type) {
4
+ case XP_COMPONENT_TYPE.PAGE:
5
+ return 'page';
6
+ case XP_COMPONENT_TYPE.LAYOUT:
7
+ return 'layout';
8
+ case XP_COMPONENT_TYPE.PART:
9
+ return 'part';
10
+ }
11
+ }
12
+ export const CATCH_ALL = '*';
13
+ export class ComponentRegistry {
14
+ static getByComponent(component) {
15
+ const selName = toSelectorName(component.type);
16
+ const cmpData = component[component.type];
17
+ const desc = cmpData && 'descriptor' in cmpData ? cmpData.descriptor : component.path;
18
+ return selName && desc ? this.getType(selName, desc) : undefined;
19
+ }
20
+ static setCommonQuery(query) {
21
+ this.commonQuery = query;
22
+ }
23
+ static getCommonQuery() {
24
+ return this.commonQuery;
25
+ }
26
+ static addMacro(name, obj) {
27
+ return ComponentRegistry.addType('macro', name, obj);
28
+ }
29
+ static getMacro(name) {
30
+ return ComponentRegistry.getType('macro', name);
31
+ }
32
+ static getMacros() {
33
+ return Object.entries(this.macros);
34
+ }
35
+ static getParts() {
36
+ return Object.entries(this.parts);
37
+ }
38
+ static getLayouts() {
39
+ return Object.entries(this.layouts);
40
+ }
41
+ static getPages() {
42
+ return Object.entries(this.pages);
43
+ }
44
+ static addContentType(name, obj) {
45
+ return ComponentRegistry.addType('contentType', name, obj);
46
+ }
47
+ static getContentType(name) {
48
+ return ComponentRegistry.getType('contentType', name);
49
+ }
50
+ static addPage(name, obj) {
51
+ return ComponentRegistry.addType('page', name, obj);
52
+ }
53
+ static getPage(name) {
54
+ return ComponentRegistry.getType('page', name);
55
+ }
56
+ static addPart(name, obj) {
57
+ return ComponentRegistry.addType('part', name, obj);
58
+ }
59
+ static getPart(name) {
60
+ return ComponentRegistry.getType('part', name);
61
+ }
62
+ static addLayout(name, obj) {
63
+ return ComponentRegistry.addType('layout', name, obj);
64
+ }
65
+ static getLayout(name) {
66
+ return ComponentRegistry.getType('layout', name);
67
+ }
68
+ static addComponent(name, obj) {
69
+ return ComponentRegistry.addType('component', name, obj);
70
+ }
71
+ static getComponent(name) {
72
+ return ComponentRegistry.getType('component', name);
73
+ }
74
+ static getSelector(name) {
75
+ switch (name) {
76
+ case 'contentType':
77
+ return this.contentTypes;
78
+ case 'page':
79
+ return this.pages;
80
+ case 'component':
81
+ return this.components;
82
+ case 'layout':
83
+ return this.layouts;
84
+ case 'part':
85
+ return this.parts;
86
+ case 'macro':
87
+ return this.macros;
88
+ }
89
+ }
90
+ static getType(selectorName, typeName, useCatchAll = true) {
91
+ const selector = ComponentRegistry.getSelector(selectorName);
92
+ let type = selector[typeName];
93
+ if (type) {
94
+ type.catchAll = false;
95
+ }
96
+ else if (!type && useCatchAll) {
97
+ type = selector[CATCH_ALL];
98
+ if (type) {
99
+ type.catchAll = true;
100
+ }
101
+ }
102
+ return type;
103
+ }
104
+ static addType(selectorName, name, obj) {
105
+ const selector = ComponentRegistry.getSelector(selectorName);
106
+ const curr = selector[name];
107
+ selector[name] = curr ? Object.assign(curr, obj) : obj;
108
+ }
109
+ }
110
+ ComponentRegistry.contentTypes = {};
111
+ ComponentRegistry.pages = {};
112
+ ComponentRegistry.components = {};
113
+ ComponentRegistry.parts = {};
114
+ ComponentRegistry.layouts = {};
115
+ ComponentRegistry.macros = {};
@@ -0,0 +1,21 @@
1
+ import { ImageData, LinkData, MetaData } from './guillotine/getMetaData';
2
+ export declare class UrlProcessor {
3
+ static IMG_TAG: string;
4
+ static LINK_TAG: string;
5
+ static MACRO_TAG: string;
6
+ static IMG_ATTR: string;
7
+ static LINK_ATTR: string;
8
+ static MACRO_ATTR: string;
9
+ private static IMG_ATMT_REGEXP;
10
+ private static endSlashPattern;
11
+ private static startSlashPattern;
12
+ private static siteKey;
13
+ static process(url: string, meta: MetaData): string;
14
+ static setSiteKey(key: string): void;
15
+ static isMediaLink(ref: string, linkData: LinkData[]): boolean;
16
+ static isContentImage(ref: string, linkData: ImageData[]): boolean;
17
+ private static stripApiUrl;
18
+ private static isPageUrl;
19
+ private static getApiUrl;
20
+ }
21
+ export declare const getUrl: any;
@@ -0,0 +1,54 @@
1
+ import { commonChars, RENDER_MODE, SITE_KEY } from './utils';
2
+ export class UrlProcessor {
3
+ static process(url, meta) {
4
+ let result;
5
+ if (!meta || !this.isPageUrl(url) && meta.renderMode === RENDER_MODE.NEXT) {
6
+ // keep content urls absolute in next mode for everything but page urls
7
+ result = url;
8
+ }
9
+ else {
10
+ const apiUrl = this.getApiUrl(meta);
11
+ const strippedUrl = this.stripApiUrl(url, apiUrl);
12
+ result = ((meta === null || meta === void 0 ? void 0 : meta.baseUrl) || '') + strippedUrl;
13
+ }
14
+ return result;
15
+ }
16
+ static setSiteKey(key) {
17
+ this.siteKey = key;
18
+ }
19
+ static isMediaLink(ref, linkData) {
20
+ var _a;
21
+ return ((_a = linkData.find(data => data.ref === ref)) === null || _a === void 0 ? void 0 : _a.media) !== null;
22
+ }
23
+ static isContentImage(ref, linkData) {
24
+ var _a;
25
+ return ((_a = linkData.find(data => data.ref === ref)) === null || _a === void 0 ? void 0 : _a.image) !== null;
26
+ }
27
+ static stripApiUrl(url, apiUrl) {
28
+ const common = commonChars(url, apiUrl);
29
+ const remaining = common.length > 0 ? url.substring(common.length) : url;
30
+ return (remaining.length > 0 && remaining.charAt(0) === '/') ? remaining.substring(1) : remaining;
31
+ }
32
+ static isPageUrl(url) {
33
+ return !this.IMG_ATMT_REGEXP.test(url);
34
+ }
35
+ static getApiUrl(meta) {
36
+ var _a, _b;
37
+ let combinedUrl = ((_a = meta.apiUrl) === null || _a === void 0 ? void 0 : _a.replace(this.endSlashPattern, '')) || '';
38
+ if ((_b = this.siteKey) === null || _b === void 0 ? void 0 : _b.length) {
39
+ combinedUrl += '/' + this.siteKey.replace(this.startSlashPattern, '');
40
+ }
41
+ return combinedUrl;
42
+ }
43
+ }
44
+ UrlProcessor.IMG_TAG = 'img';
45
+ UrlProcessor.LINK_TAG = 'a';
46
+ UrlProcessor.MACRO_TAG = 'editor-macro';
47
+ UrlProcessor.IMG_ATTR = 'data-image-ref';
48
+ UrlProcessor.LINK_ATTR = 'data-link-ref';
49
+ UrlProcessor.MACRO_ATTR = 'data-macro-ref';
50
+ UrlProcessor.IMG_ATMT_REGEXP = /_\/image\/|_\/attachment\//;
51
+ UrlProcessor.endSlashPattern = /\/+$/;
52
+ UrlProcessor.startSlashPattern = /^\/+/;
53
+ UrlProcessor.setSiteKey(SITE_KEY);
54
+ export const getUrl = UrlProcessor.process.bind(UrlProcessor);
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,38 @@
1
+ import { ComponentRegistry } from './ComponentRegistry';
2
+ import { FRAGMENT_CONTENTTYPE_NAME, XP_COMPONENT_TYPE } from './utils';
3
+ import FragmentView from './views/Fragment';
4
+ import BasePage from './views/BasePage';
5
+ import BasePart from './views/BasePart';
6
+ import BaseLayout from './views/BaseLayout';
7
+ import TextView from './views/Text';
8
+ import DefaultMacro from './views/macros/DefaultMacro';
9
+ import DisableMacro from './views/macros/DisableMacro';
10
+ // Base Content Types
11
+ ComponentRegistry.addContentType(FRAGMENT_CONTENTTYPE_NAME, {
12
+ view: FragmentView,
13
+ });
14
+ // Base Components
15
+ ComponentRegistry.addComponent(XP_COMPONENT_TYPE.PAGE, {
16
+ view: BasePage,
17
+ });
18
+ ComponentRegistry.addComponent(XP_COMPONENT_TYPE.PART, {
19
+ view: BasePart,
20
+ });
21
+ ComponentRegistry.addComponent(XP_COMPONENT_TYPE.LAYOUT, {
22
+ view: BaseLayout,
23
+ });
24
+ ComponentRegistry.addComponent(XP_COMPONENT_TYPE.FRAGMENT, {
25
+ view: FragmentView,
26
+ });
27
+ ComponentRegistry.addComponent(XP_COMPONENT_TYPE.TEXT, {
28
+ view: TextView,
29
+ });
30
+ // Macro mappings
31
+ ComponentRegistry.addMacro('system:embed', {
32
+ view: DefaultMacro,
33
+ configQuery: '{body}',
34
+ });
35
+ ComponentRegistry.addMacro('system:disable', {
36
+ view: DisableMacro,
37
+ configQuery: '{body}',
38
+ });
@@ -0,0 +1,82 @@
1
+ /// <reference types="node" />
2
+ /// <reference types="node" />
3
+ import { MetaData, PageComponent } from './getMetaData';
4
+ import { RENDER_MODE, XP_REQUEST_TYPE } from '../utils';
5
+ import { ComponentRegistry } from '../ComponentRegistry';
6
+ import { ParsedUrlQuery } from 'node:querystring';
7
+ import { type GetServerSidePropsContext } from 'next';
8
+ import { IncomingMessage } from 'http';
9
+ import { type NextApiRequestCookies } from 'next/dist/server/api-utils';
10
+ export declare type AdapterConstants = {
11
+ APP_NAME: string;
12
+ APP_NAME_DASHED: string;
13
+ SITE_KEY: string;
14
+ getXPRequestType: (context?: Context) => XP_REQUEST_TYPE;
15
+ getRenderMode: (context?: Context) => RENDER_MODE;
16
+ getSingleComponentPath: (context?: Context) => string | undefined;
17
+ };
18
+ declare type Result = {
19
+ error?: {
20
+ code: string;
21
+ message: string;
22
+ } | null;
23
+ };
24
+ declare type GuillotineResult = Result & {
25
+ [dataKey: string]: any;
26
+ };
27
+ export declare type FetchContentResult = Result & {
28
+ data: Record<string, any> | null;
29
+ common: Record<string, any> | null;
30
+ meta: MetaData;
31
+ page: PageComponent | null;
32
+ };
33
+ declare type FetcherConfig<T extends AdapterConstants> = T & {
34
+ componentRegistry: typeof ComponentRegistry;
35
+ };
36
+ export interface ServerSideParams extends ParsedUrlQuery {
37
+ contentPath?: string[];
38
+ mode?: string;
39
+ }
40
+ export interface PreviewParams {
41
+ contentPath: string[];
42
+ headers: Record<string, string>;
43
+ }
44
+ export declare type Context = GetServerSidePropsContext<ServerSideParams, PreviewParams>;
45
+ export interface MinimalContext {
46
+ req: IncomingMessage & {
47
+ cookies: NextApiRequestCookies;
48
+ };
49
+ }
50
+ /**
51
+ * Sends one query to the guillotine API and asks for content type, then uses the type to select a second query and variables, which is sent to the API and fetches content data.
52
+ * @param contentPath string or string array: pre-split or slash-delimited _path to a content available on the API
53
+ * @returns FetchContentResult object: {data?: T, error?: {code, message}}
54
+ */
55
+ export declare type ContentFetcher = (contentPath: string | string[], context: Context) => Promise<FetchContentResult>;
56
+ export declare type ContentApiBaseBody = {
57
+ query?: string;
58
+ variables?: {
59
+ path?: string;
60
+ };
61
+ };
62
+ /** Generic fetch */
63
+ export declare const fetchFromApi: (apiUrl: string, body: {}, method?: string) => Promise<any>;
64
+ /** Guillotine-specialized fetch, using the generic fetch above */
65
+ export declare const fetchGuillotine: (contentApiUrl: string, body: ContentApiBaseBody, xpContentPath: string) => Promise<GuillotineResult>;
66
+ /**
67
+ * Configures, builds and returns a general fetchContent function.
68
+ * @param adapterConstants Object containing attributes imported from enonic-connecion-config.js: constants and function concerned with connection to the XP backend. Easiest: caller imports enonic-connection-config and just passes that entire object here as adapterConstants.
69
+ * @param componentRegistry ComponentRegistry object from ComponentRegistry.ts, holding user type mappings that are set in typesRegistration.ts file
70
+ * @returns ContentFetcher
71
+ */
72
+ export declare const buildContentFetcher: <T extends AdapterConstants>(config: FetcherConfig<T>) => ContentFetcher;
73
+ /**
74
+ * Default fetchContent function, built with params from imports.
75
+ * It runs custom content-type-specific guillotine calls against an XP guillotine endpoint, returns content data, error and some meta data
76
+ * Sends one query to the guillotine API and asks for content type, then uses the type to select a second query and variables, which is sent to the API and fetches content data.
77
+ * @param contentPath string or string array: local (site-relative) path to a content available on the API (by XP _path - obtainable by running contentPath through getXpPath). Pre-split into string array, or already a slash-delimited string.
78
+ * @param context object from Next, contains .query info
79
+ * @returns FetchContentResult object: {data?: T, error?: {code, message}}
80
+ */
81
+ export declare const fetchContent: ContentFetcher;
82
+ export {};