-
Notifications
You must be signed in to change notification settings - Fork 8
/
ComponentMapping.ts
182 lines (156 loc) · 5.39 KB
/
ComponentMapping.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
/*
* Copyright 2020 Adobe. All rights reserved.
* This file is licensed to you under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. You may obtain a copy
* of the License at http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software distributed under
* the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
* OF ANY KIND, either express or implied. See the License for the specific language
* governing permissions and limitations under the License.
*/
/**
* ComponentMapping interface.
* @private
*/
interface ComponentMappingObject {
[key: string]: unknown;
}
/**
* LazyComponentMappingObject interface.
* @private
*/
interface LazyComponentMappingObject {
[key: string]: lazyMapFunction;
}
/**
* ComponentMapping instance.
* @private
*/
let instance: ComponentMappingImpl;
export type lazyMapFunction = () => Promise<unknown>;
/**
* ComponentMapping singleton. It manages the mapping between AEM component resource types and corresponding
* JavaScript component class.
* @private
*/
class ComponentMappingImpl {
static mapping: ComponentMappingObject = {};
static lazyMapping: LazyComponentMappingObject = {};
static get instance(): ComponentMappingImpl {
return new this();
}
constructor() {
if (!instance) {
instance = this;
}
return instance;
}
/**
* Creates mapping for given resource type(s) and a component class.
* @param resourceTypes Resource type(s).
* @param clazz Component class that will be associated with given resource type(s).
* @protected
*/
public map(resourceTypes: string | string[], clazz: unknown): void {
ComponentMappingImpl.map(resourceTypes, clazz);
}
/**
* Creates mapping for given resource type(s) and a component class.
* @param resourceTypes Resource type(s).
* @param clazz Component class that will be associated with given resource type(s).
* @protected
*/
public static map(resourceTypes: string | string[], clazz: unknown): void {
if (resourceTypes && clazz) {
const resourceList = (typeof resourceTypes === 'string') ? [ resourceTypes ] : resourceTypes;
resourceList.forEach((entry) => {
this.mapping[entry] = clazz;
});
}
}
public lazyMap(resourceTypes: string | string[], clazz: lazyMapFunction): void {
ComponentMappingImpl.lazyMap(resourceTypes, clazz);
}
public static lazyMap(resourceTypes: string | string[], clazz: lazyMapFunction): void {
if (resourceTypes && clazz) {
const resourceList = (typeof resourceTypes === 'string') ? [ resourceTypes ] : resourceTypes;
resourceList.forEach((entry) => {
this.lazyMapping[entry] = clazz;
});
}
}
/**
* Returns object (or `undefined`) matching with given resource type.
* @param resourceType Resource type.
* @returns Class associated with given resource type or `undefined`.
*/
public get<T>(resourceType: string): T {
return ComponentMappingImpl.get(resourceType);
}
/**
* Returns object (or `undefined`) matching with given resource type.
* @param resourceType Resource type.
* @returns Class associated with given resource type or `undefined`.
*/
public static get<T>(resourceType: string): T {
return this.mapping[resourceType] as T;
}
/**
* Returns object (or undefined) matching with given resource type.
*
* @param {string} resourceType - resource type
* @returns {object|undefined} - class associated with given resource type
*/
public getLazy<T>(resourceType: string): Promise<T> {
return ComponentMappingImpl.getLazy(resourceType);
}
public static getLazy<T>(resourceType: string): Promise<T> {
if (this.lazyMapping[resourceType]) {
return this.lazyMapping[resourceType]() as Promise<T>;
}
return Promise.reject('resourceType ' + resourceType + ' not found in mappings!');
}
}
/**
* Use to register resource types to Class mapping.
*
* Example:
* ```
* import { MapTo } from '@adobe/aem-spa-component-mapping';
*
* class MyComponent {
* ...
* }
*
* export default MapTo('my/resource/type')(MyComponent);
* ```
*
* @param resourceTypes AEM resource type(s).
* @returns Function mapping a class with the given resource types.
*/
const MapTo = (resourceTypes: string | string[]): (clazz: unknown) => void => {
return (clazz: unknown) => ComponentMappingImpl.instance.map(resourceTypes, clazz);
};
/**
* Use to register resource types to Class mapping in a lazyLoad fashion, with dynamic imports
*
* Example:
* ```
* import { LazyMapTo } from '@adobe/aem-spa-component-mapping';
*
* MyComponent.ts:
* export class MyComponent {
* ...
* }
*
* LazyMapTo('my/resource/type')(MyComponent);
* ```
*
* @param resourceTypes AEM resource type(s).
* @returns Function mapping a class with the given resource types.
*/
const LazyMapTo = (resourceTypes: string | string[]): (lazyPromise: lazyMapFunction) => void => {
return (lazyPromise: lazyMapFunction) => ComponentMappingImpl.instance.lazyMap(resourceTypes, lazyPromise);
};
export { ComponentMappingImpl as ComponentMapping, MapTo, LazyMapTo };