@powerlines/plugin-env 0.16.131 → 0.16.134
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/dist/babel/plugin.mjs.map +1 -1
- package/dist/components/docs.cjs +49 -39
- package/dist/components/docs.d.cts +1 -2
- package/dist/components/docs.d.cts.map +1 -1
- package/dist/components/docs.d.mts +1 -2
- package/dist/components/docs.d.mts.map +1 -1
- package/dist/components/docs.mjs +50 -40
- package/dist/components/docs.mjs.map +1 -1
- package/dist/components/env-builtin.cjs +513 -397
- package/dist/components/env-builtin.d.cts +2 -2
- package/dist/components/env-builtin.d.cts.map +1 -1
- package/dist/components/env-builtin.d.mts +2 -2
- package/dist/components/env-builtin.d.mts.map +1 -1
- package/dist/components/env-builtin.mjs +514 -398
- package/dist/components/env-builtin.mjs.map +1 -1
- package/dist/helpers/automd-generator.mjs.map +1 -1
- package/dist/helpers/create-reflection-resource.mjs.map +1 -1
- package/dist/helpers/docs-helper.mjs.map +1 -1
- package/dist/helpers/load.cjs +20 -15
- package/dist/helpers/load.d.cts +7 -6
- package/dist/helpers/load.d.cts.map +1 -1
- package/dist/helpers/load.d.mts +7 -6
- package/dist/helpers/load.d.mts.map +1 -1
- package/dist/helpers/load.mjs +20 -15
- package/dist/helpers/load.mjs.map +1 -1
- package/dist/helpers/persistence.mjs.map +1 -1
- package/dist/helpers/reflect.mjs.map +1 -1
- package/dist/helpers/source-file-env.mjs.map +1 -1
- package/dist/helpers/template-helpers.mjs.map +1 -1
- package/dist/index.cjs +6 -3
- package/dist/index.mjs +7 -4
- package/dist/index.mjs.map +1 -1
- package/dist/types/runtime.mjs.map +1 -1
- package/package.json +10 -10
|
@@ -3,7 +3,7 @@ import { loadEnvFromContext } from "../helpers/load.mjs";
|
|
|
3
3
|
import { titleCase } from "@stryke/string-format/title-case";
|
|
4
4
|
import { ReflectionClass, ReflectionKind } from "@powerlines/deepkit/vendor/type";
|
|
5
5
|
import defu from "defu";
|
|
6
|
-
import {
|
|
6
|
+
import { createComponent, createIntrinsic, memo, mergeProps } from "@alloy-js/core/jsx-runtime";
|
|
7
7
|
import { For, Show, code, computed, splitProps } from "@alloy-js/core";
|
|
8
8
|
import { Spacing } from "@powerlines/plugin-alloy/core/components/spacing";
|
|
9
9
|
import { usePowerlines } from "@powerlines/plugin-alloy/core/contexts/context";
|
|
@@ -47,54 +47,72 @@ function __assignType(fn, args) {
|
|
|
47
47
|
function EnvTypeDefinition(props) {
|
|
48
48
|
const [{ defaultValue, reflection }] = splitProps(props, ["defaultValue", "reflection"]);
|
|
49
49
|
const context = (usePowerlines.Ω = [[() => __ΩEnvPluginContext, "n!"]], usePowerlines());
|
|
50
|
-
return
|
|
51
|
-
|
|
50
|
+
return [
|
|
51
|
+
createComponent(InterfaceDeclaration$1, {
|
|
52
52
|
name: "UnprefixedEnv",
|
|
53
53
|
defaultValue,
|
|
54
54
|
reflection,
|
|
55
|
-
export: true
|
|
55
|
+
"export": true
|
|
56
56
|
}),
|
|
57
|
-
|
|
58
|
-
|
|
57
|
+
createComponent(Spacing, {}),
|
|
58
|
+
createComponent(TSDoc, {
|
|
59
59
|
heading: "The environment configuration object with prefixed keys.",
|
|
60
|
-
children
|
|
60
|
+
get children() {
|
|
61
|
+
return createComponent(TSDocRemarks, { children: `The \`Env\` type extends the \`UnprefixedEnv\` interface by including additional keys that are prefixed according to the project's configuration. This allows for flexibility in accessing environment variables with different naming conventions.` });
|
|
62
|
+
}
|
|
61
63
|
}),
|
|
62
|
-
|
|
64
|
+
createComponent(InterfaceDeclaration, {
|
|
63
65
|
name: "Env",
|
|
64
|
-
export: true,
|
|
65
|
-
extends: "UnprefixedEnv",
|
|
66
|
-
children
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
"property",
|
|
76
|
-
"",
|
|
77
|
-
"P\"2!\"/\""
|
|
78
|
-
])) ?? [],
|
|
66
|
+
"export": true,
|
|
67
|
+
"extends": "UnprefixedEnv",
|
|
68
|
+
get children() {
|
|
69
|
+
return createComponent(For, {
|
|
70
|
+
get each() {
|
|
71
|
+
return getUnique(context.config.env.prefix).map(__assignType((prefix) => prefix.replace(/_$/, ""), [
|
|
72
|
+
"prefix",
|
|
73
|
+
"",
|
|
74
|
+
"P\"2!\"/\""
|
|
75
|
+
]));
|
|
76
|
+
},
|
|
79
77
|
doubleHardline: true,
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
78
|
+
get children() {
|
|
79
|
+
return __assignType((prefix) => createComponent(For, {
|
|
80
|
+
get each() {
|
|
81
|
+
return reflection?.getProperties().filter(__assignType((property) => !property.isIgnored(), [
|
|
82
|
+
"property",
|
|
83
|
+
"",
|
|
84
|
+
"P\"2!\"/\""
|
|
85
|
+
])) ?? [];
|
|
86
|
+
},
|
|
87
|
+
doubleHardline: true,
|
|
88
|
+
get children() {
|
|
89
|
+
return __assignType((property) => [createComponent(TSDocReflectionProperty, { reflection: property }), createComponent(InterfaceMember, {
|
|
90
|
+
get name() {
|
|
91
|
+
return `${prefix}_${property.getNameAsString()}`;
|
|
92
|
+
},
|
|
93
|
+
get type() {
|
|
94
|
+
return `UnprefixedEnv["${property.getNameAsString()}"]`;
|
|
95
|
+
},
|
|
96
|
+
get readonly() {
|
|
97
|
+
return property.isReadonly();
|
|
98
|
+
}
|
|
99
|
+
})], [
|
|
100
|
+
"property",
|
|
101
|
+
"",
|
|
102
|
+
"P\"2!\"/\""
|
|
103
|
+
]);
|
|
104
|
+
}
|
|
105
|
+
}), [
|
|
106
|
+
"prefix",
|
|
107
|
+
"",
|
|
108
|
+
"P\"2!\"/\""
|
|
109
|
+
]);
|
|
110
|
+
}
|
|
111
|
+
});
|
|
112
|
+
}
|
|
95
113
|
}),
|
|
96
|
-
|
|
97
|
-
]
|
|
114
|
+
createComponent(Spacing, {})
|
|
115
|
+
];
|
|
98
116
|
}
|
|
99
117
|
EnvTypeDefinition.__type = [
|
|
100
118
|
() => __ΩOmit,
|
|
@@ -144,47 +162,75 @@ function ConfigPropertyGet(props) {
|
|
|
144
162
|
"property",
|
|
145
163
|
"index"
|
|
146
164
|
]);
|
|
147
|
-
return
|
|
148
|
-
condition
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
165
|
+
return [index === 0 ? createComponent(IfStatement, {
|
|
166
|
+
get condition() {
|
|
167
|
+
return [createComponent(ConfigPropertyConditional, {
|
|
168
|
+
get name() {
|
|
169
|
+
return property.getNameAsString();
|
|
170
|
+
},
|
|
171
|
+
context
|
|
172
|
+
}), createComponent(Show, {
|
|
173
|
+
get when() {
|
|
174
|
+
return memo(() => !!property.getAlias())() && property.getAlias().length > 0;
|
|
175
|
+
},
|
|
176
|
+
get children() {
|
|
177
|
+
return [code` || `, createComponent(For, {
|
|
178
|
+
get each() {
|
|
179
|
+
return property.getAlias();
|
|
180
|
+
},
|
|
181
|
+
joiner: code` || `,
|
|
182
|
+
get children() {
|
|
183
|
+
return __assignType((alias) => createComponent(ConfigPropertyConditional, {
|
|
184
|
+
name: alias,
|
|
185
|
+
context
|
|
186
|
+
}), [
|
|
187
|
+
"alias",
|
|
188
|
+
"",
|
|
189
|
+
"P\"2!\"/\""
|
|
190
|
+
]);
|
|
191
|
+
}
|
|
192
|
+
})];
|
|
193
|
+
}
|
|
194
|
+
})];
|
|
195
|
+
},
|
|
196
|
+
get children() {
|
|
197
|
+
return code`return target["${property.getNameAsString()}"];`;
|
|
198
|
+
}
|
|
199
|
+
}) : createComponent(ElseIfClause, {
|
|
200
|
+
get condition() {
|
|
201
|
+
return [createComponent(ConfigPropertyConditional, {
|
|
202
|
+
get name() {
|
|
203
|
+
return property.getNameAsString();
|
|
204
|
+
},
|
|
205
|
+
context
|
|
206
|
+
}), createComponent(Show, {
|
|
207
|
+
get when() {
|
|
208
|
+
return memo(() => !!property.getAlias())() && property.getAlias().length > 0;
|
|
209
|
+
},
|
|
210
|
+
get children() {
|
|
211
|
+
return [code` || `, createComponent(For, {
|
|
212
|
+
get each() {
|
|
213
|
+
return property.getAlias();
|
|
214
|
+
},
|
|
215
|
+
joiner: code` || `,
|
|
216
|
+
get children() {
|
|
217
|
+
return __assignType((alias) => createComponent(ConfigPropertyConditional, {
|
|
218
|
+
name: alias,
|
|
219
|
+
context
|
|
220
|
+
}), [
|
|
221
|
+
"alias",
|
|
222
|
+
"",
|
|
223
|
+
"P\"2!\"/\""
|
|
224
|
+
]);
|
|
225
|
+
}
|
|
226
|
+
})];
|
|
227
|
+
}
|
|
228
|
+
})];
|
|
229
|
+
},
|
|
230
|
+
get children() {
|
|
231
|
+
return code`return target["${property.getNameAsString()}"];`;
|
|
232
|
+
}
|
|
233
|
+
})];
|
|
188
234
|
}
|
|
189
235
|
ConfigPropertyGet.__type = [
|
|
190
236
|
() => __ΩConfigPropertyProps,
|
|
@@ -198,53 +244,81 @@ function ConfigPropertySet(props) {
|
|
|
198
244
|
"property",
|
|
199
245
|
"index"
|
|
200
246
|
]);
|
|
201
|
-
return
|
|
202
|
-
condition
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
247
|
+
return [index === 0 ? createComponent(IfStatement, {
|
|
248
|
+
get condition() {
|
|
249
|
+
return [createComponent(ConfigPropertyConditional, {
|
|
250
|
+
get name() {
|
|
251
|
+
return property.getNameAsString();
|
|
252
|
+
},
|
|
253
|
+
context
|
|
254
|
+
}), createComponent(Show, {
|
|
255
|
+
get when() {
|
|
256
|
+
return memo(() => !!property.getAlias())() && property.getAlias().length > 0;
|
|
257
|
+
},
|
|
258
|
+
get children() {
|
|
259
|
+
return [code` || `, createComponent(For, {
|
|
260
|
+
get each() {
|
|
261
|
+
return property.getAlias();
|
|
262
|
+
},
|
|
263
|
+
joiner: code` || `,
|
|
264
|
+
get children() {
|
|
265
|
+
return __assignType((alias) => createComponent(ConfigPropertyConditional, {
|
|
266
|
+
name: alias,
|
|
267
|
+
context
|
|
268
|
+
}), [
|
|
269
|
+
"alias",
|
|
270
|
+
"",
|
|
271
|
+
"P\"2!\"/\""
|
|
272
|
+
]);
|
|
273
|
+
}
|
|
274
|
+
})];
|
|
275
|
+
}
|
|
276
|
+
})];
|
|
277
|
+
},
|
|
278
|
+
get children() {
|
|
279
|
+
return code`
|
|
221
280
|
target["${property.getNameAsString()}"] = newValue;
|
|
222
281
|
return true;
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
282
|
+
`;
|
|
283
|
+
}
|
|
284
|
+
}) : createComponent(ElseIfClause, {
|
|
285
|
+
get condition() {
|
|
286
|
+
return [createComponent(ConfigPropertyConditional, {
|
|
287
|
+
get name() {
|
|
288
|
+
return property.getNameAsString();
|
|
289
|
+
},
|
|
290
|
+
context
|
|
291
|
+
}), createComponent(Show, {
|
|
292
|
+
get when() {
|
|
293
|
+
return memo(() => !!property.getAlias())() && property.getAlias().length > 0;
|
|
294
|
+
},
|
|
295
|
+
get children() {
|
|
296
|
+
return [code` || `, createComponent(For, {
|
|
297
|
+
get each() {
|
|
298
|
+
return property.getAlias();
|
|
299
|
+
},
|
|
300
|
+
joiner: code` || `,
|
|
301
|
+
get children() {
|
|
302
|
+
return __assignType((alias) => createComponent(ConfigPropertyConditional, {
|
|
303
|
+
name: alias,
|
|
304
|
+
context
|
|
305
|
+
}), [
|
|
306
|
+
"alias",
|
|
307
|
+
"",
|
|
308
|
+
"P\"2!\"/\""
|
|
309
|
+
]);
|
|
310
|
+
}
|
|
311
|
+
})];
|
|
312
|
+
}
|
|
313
|
+
})];
|
|
314
|
+
},
|
|
315
|
+
get children() {
|
|
316
|
+
return code`
|
|
244
317
|
target["${property.getNameAsString()}"] = newValue;
|
|
245
318
|
return true;
|
|
246
|
-
|
|
247
|
-
|
|
319
|
+
`;
|
|
320
|
+
}
|
|
321
|
+
})];
|
|
248
322
|
}
|
|
249
323
|
ConfigPropertySet.__type = [
|
|
250
324
|
() => __ΩConfigPropertyProps,
|
|
@@ -314,61 +388,71 @@ function EnvBuiltin(props) {
|
|
|
314
388
|
"",
|
|
315
389
|
"P\"2!\"2\"\"/#"
|
|
316
390
|
])) ?? []);
|
|
317
|
-
return
|
|
391
|
+
return createComponent(BuiltinFile, mergeProps({
|
|
318
392
|
id: "env",
|
|
319
|
-
description: "The environment configuration module provides an interface to define environment configuration parameters."
|
|
320
|
-
|
|
321
|
-
imports
|
|
322
|
-
"
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
reflection
|
|
339
|
-
}
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
393
|
+
description: "The environment configuration module provides an interface to define environment configuration parameters."
|
|
394
|
+
}, rest, {
|
|
395
|
+
get imports() {
|
|
396
|
+
return defu({ "@powerlines/deepkit/vendor/type": [
|
|
397
|
+
"serializeFunction",
|
|
398
|
+
"deserializeFunction",
|
|
399
|
+
"ReflectionKind",
|
|
400
|
+
"Serializer",
|
|
401
|
+
"NamingStrategy",
|
|
402
|
+
"TemplateState",
|
|
403
|
+
"Type",
|
|
404
|
+
"TypeProperty",
|
|
405
|
+
"TypePropertySignature"
|
|
406
|
+
] }, rest.imports ?? {});
|
|
407
|
+
},
|
|
408
|
+
get children() {
|
|
409
|
+
return [
|
|
410
|
+
createComponent(Show, {
|
|
411
|
+
get when() {
|
|
412
|
+
return Boolean(reflection);
|
|
413
|
+
},
|
|
414
|
+
get children() {
|
|
415
|
+
return [
|
|
416
|
+
createComponent(EnvTypeDefinition, {
|
|
417
|
+
defaultValue,
|
|
418
|
+
reflection
|
|
419
|
+
}),
|
|
420
|
+
createIntrinsic("hbr", {}),
|
|
421
|
+
createIntrinsic("hbr", {})
|
|
422
|
+
];
|
|
423
|
+
}
|
|
424
|
+
}),
|
|
425
|
+
createComponent(ObjectDeclaration, {
|
|
426
|
+
name: "initialEnv",
|
|
427
|
+
type: "Partial<Env>",
|
|
428
|
+
defaultValue,
|
|
429
|
+
reflection: envInstance,
|
|
430
|
+
"export": true,
|
|
431
|
+
"const": true,
|
|
432
|
+
doc: "The initial environment configuration object values for the runtime."
|
|
433
|
+
}),
|
|
434
|
+
createComponent(Spacing, {}),
|
|
435
|
+
createComponent(TSDoc, {
|
|
436
|
+
heading: "The environment configuration serializer for the Powerlines application.",
|
|
437
|
+
get children() {
|
|
438
|
+
return [
|
|
439
|
+
createComponent(TSDocLink, { children: `https://deepkit.io/docs/serialization/serializers` }),
|
|
440
|
+
createComponent(TSDocLink, { children: `https://github.com/marcj/untitled-code/blob/master/packages/type/src/serializer.ts#L1918` }),
|
|
441
|
+
createComponent(TSDocRemarks, { children: `This serializer is used to serialize and deserialize the Powerlines environment configuration.` })
|
|
442
|
+
];
|
|
443
|
+
}
|
|
444
|
+
}),
|
|
445
|
+
createComponent(ClassDeclaration, {
|
|
446
|
+
refkey: envSerializerRefkey,
|
|
447
|
+
name: "EnvSerializer",
|
|
448
|
+
"extends": "Serializer",
|
|
449
|
+
"export": true,
|
|
450
|
+
get children() {
|
|
451
|
+
return createComponent(ClassMethod, {
|
|
452
|
+
name: "constructor",
|
|
453
|
+
"public": true,
|
|
454
|
+
doc: "Initializes a new instance of the `EnvSerializer` class.",
|
|
455
|
+
children: code`super("env");
|
|
372
456
|
|
|
373
457
|
this.deserializeRegistry.register(
|
|
374
458
|
ReflectionKind.boolean,
|
|
@@ -378,14 +462,16 @@ function EnvBuiltin(props) {
|
|
|
378
462
|
);
|
|
379
463
|
}
|
|
380
464
|
); `
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
465
|
+
});
|
|
466
|
+
}
|
|
467
|
+
}),
|
|
468
|
+
createComponent(Spacing, {}),
|
|
469
|
+
createComponent(VarDeclaration, {
|
|
470
|
+
name: "envNamingStrategy",
|
|
471
|
+
"const": true,
|
|
472
|
+
doc: "The environment naming strategy for the runtime.",
|
|
473
|
+
get initializer() {
|
|
474
|
+
return code`new class extends NamingStrategy {
|
|
389
475
|
constructor() {
|
|
390
476
|
super("env");
|
|
391
477
|
}
|
|
@@ -397,112 +483,127 @@ function EnvBuiltin(props) {
|
|
|
397
483
|
}
|
|
398
484
|
|
|
399
485
|
return name.replace(/^(${getUnique(context.config.env.prefix).map(__assignType((prefix) => prefix.replace(/_$/, ""), [
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
486
|
+
"prefix",
|
|
487
|
+
"",
|
|
488
|
+
"P\"2!\"/\""
|
|
489
|
+
])).join("|")})_/, "");
|
|
404
490
|
}
|
|
405
|
-
};
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
491
|
+
}; `;
|
|
492
|
+
}
|
|
493
|
+
}),
|
|
494
|
+
createComponent(Spacing, {}),
|
|
495
|
+
createComponent(TSDoc, {
|
|
496
|
+
heading: "A {@link EnvSerializer | environment configuration serializer} instance for the Powerlines application.",
|
|
497
|
+
get children() {
|
|
498
|
+
return [
|
|
499
|
+
createComponent(TSDocLink, { children: `https://deepkit.io/docs/serialization/serializers` }),
|
|
500
|
+
createComponent(TSDocLink, { children: `https://github.com/marcj/untitled-code/blob/master/packages/type/src/serializer.ts#L1918` }),
|
|
501
|
+
createComponent(TSDocRemarks, { children: `This serializer is used to serialize and deserialize the Powerlines environment configuration.` })
|
|
502
|
+
];
|
|
503
|
+
}
|
|
504
|
+
}),
|
|
505
|
+
createComponent(VarDeclaration, {
|
|
506
|
+
name: "envSerializer",
|
|
507
|
+
"const": true,
|
|
508
|
+
get initializer() {
|
|
509
|
+
return createComponent(NewExpression, {
|
|
510
|
+
args: [],
|
|
511
|
+
target: "EnvSerializer"
|
|
512
|
+
});
|
|
513
|
+
}
|
|
514
|
+
}),
|
|
515
|
+
createComponent(Spacing, {}),
|
|
516
|
+
createComponent(VarDeclaration, {
|
|
517
|
+
name: "_serializeEnv",
|
|
518
|
+
"const": true,
|
|
519
|
+
initializer: "serializeFunction<Env>(envSerializer, envNamingStrategy)"
|
|
520
|
+
}),
|
|
521
|
+
createComponent(Spacing, {}),
|
|
522
|
+
createComponent(TSDoc, {
|
|
523
|
+
heading: "Serialize a environment configuration object to JSON data objects (not a JSON string).",
|
|
524
|
+
get children() {
|
|
525
|
+
return [
|
|
526
|
+
createComponent(TSDocRemarks, { children: `The resulting JSON object can be stringified using \`JSON.stringify()\`.` }),
|
|
527
|
+
createComponent(TSDocExample, { children: `const json = serializeEnv(env);` }),
|
|
528
|
+
createComponent(Spacing, {}),
|
|
529
|
+
createComponent(TSDocParam, {
|
|
530
|
+
name: "input",
|
|
531
|
+
children: `The environment configuration object to serialize.`
|
|
532
|
+
}),
|
|
533
|
+
createComponent(TSDocReturns, { children: `The serialized environment configuration as JSON data objects.` }),
|
|
534
|
+
createComponent(TSDocThrows, { children: `ValidationError when serialization or validation fails.` })
|
|
535
|
+
];
|
|
536
|
+
}
|
|
537
|
+
}),
|
|
538
|
+
createComponent(FunctionDeclaration, {
|
|
539
|
+
name: "serializeEnv",
|
|
540
|
+
"export": true,
|
|
541
|
+
parameters: [{
|
|
438
542
|
name: "input",
|
|
439
|
-
|
|
440
|
-
}
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
children: [
|
|
464
|
-
jsx(TSDocRemarks, { children: `Types that are already correct will be used as-is.` }),
|
|
465
|
-
jsx(TSDocExample, { children: `const env = deserializeEnv(json);` }),
|
|
466
|
-
jsx(TSDocThrows, { children: `ValidationError when deserialization fails.` })
|
|
467
|
-
]
|
|
468
|
-
}),
|
|
469
|
-
jsx(FunctionDeclaration, {
|
|
470
|
-
name: "deserializeEnv",
|
|
471
|
-
export: true,
|
|
472
|
-
parameters: [{
|
|
473
|
-
name: "input",
|
|
474
|
-
type: "Env"
|
|
475
|
-
}],
|
|
476
|
-
children: code` return _deserializeEnv(input, { loosely: true }); `
|
|
477
|
-
}),
|
|
478
|
-
jsx(Spacing, {}),
|
|
479
|
-
jsxs(TSDoc, {
|
|
480
|
-
heading: "Initializes the Powerlines environment configuration module.",
|
|
481
|
-
children: [
|
|
482
|
-
jsx(TSDocRemarks, { children: `This function initializes the Powerlines environment configuration object.` }),
|
|
483
|
-
jsx(TSDocParam, {
|
|
484
|
-
name: "environmentConfig",
|
|
485
|
-
children: `The dynamic/runtime configuration - this could include the current environment variables or any other environment-specific settings provided by the runtime.`
|
|
486
|
-
}),
|
|
487
|
-
jsx(TSDocReturns, { children: `The initialized Powerlines configuration object.` })
|
|
488
|
-
]
|
|
489
|
-
}),
|
|
490
|
-
jsx(Show, {
|
|
491
|
-
when: Boolean(context?.entryPath),
|
|
492
|
-
children: jsxs(FunctionDeclaration, {
|
|
493
|
-
refkey: createEnvRefkey,
|
|
494
|
-
async: false,
|
|
495
|
-
export: true,
|
|
496
|
-
name: "createEnv",
|
|
543
|
+
type: "Env"
|
|
544
|
+
}],
|
|
545
|
+
children: code` return _serializeEnv(input, { loosely: true }); `
|
|
546
|
+
}),
|
|
547
|
+
createComponent(Spacing, {}),
|
|
548
|
+
createComponent(VarDeclaration, {
|
|
549
|
+
name: "_deserializeEnv",
|
|
550
|
+
"const": true,
|
|
551
|
+
initializer: "deserializeFunction<Env>(envSerializer, envNamingStrategy)"
|
|
552
|
+
}),
|
|
553
|
+
createComponent(Spacing, {}),
|
|
554
|
+
createComponent(TSDoc, {
|
|
555
|
+
heading: "Deserialize a environment configuration object from JSON data objects to JavaScript objects, without running any validators.",
|
|
556
|
+
get children() {
|
|
557
|
+
return [
|
|
558
|
+
createComponent(TSDocRemarks, { children: `Types that are already correct will be used as-is.` }),
|
|
559
|
+
createComponent(TSDocExample, { children: `const env = deserializeEnv(json);` }),
|
|
560
|
+
createComponent(TSDocThrows, { children: `ValidationError when deserialization fails.` })
|
|
561
|
+
];
|
|
562
|
+
}
|
|
563
|
+
}),
|
|
564
|
+
createComponent(FunctionDeclaration, {
|
|
565
|
+
name: "deserializeEnv",
|
|
566
|
+
"export": true,
|
|
497
567
|
parameters: [{
|
|
498
|
-
name: "
|
|
499
|
-
type:
|
|
500
|
-
optional: false,
|
|
501
|
-
default: "{}"
|
|
568
|
+
name: "input",
|
|
569
|
+
type: "Env"
|
|
502
570
|
}],
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
571
|
+
children: code` return _deserializeEnv(input, { loosely: true }); `
|
|
572
|
+
}),
|
|
573
|
+
createComponent(Spacing, {}),
|
|
574
|
+
createComponent(TSDoc, {
|
|
575
|
+
heading: "Initializes the Powerlines environment configuration module.",
|
|
576
|
+
get children() {
|
|
577
|
+
return [
|
|
578
|
+
createComponent(TSDocRemarks, { children: `This function initializes the Powerlines environment configuration object.` }),
|
|
579
|
+
createComponent(TSDocParam, {
|
|
580
|
+
name: "environmentConfig",
|
|
581
|
+
children: `The dynamic/runtime configuration - this could include the current environment variables or any other environment-specific settings provided by the runtime.`
|
|
582
|
+
}),
|
|
583
|
+
createComponent(TSDocReturns, { children: `The initialized Powerlines configuration object.` })
|
|
584
|
+
];
|
|
585
|
+
}
|
|
586
|
+
}),
|
|
587
|
+
createComponent(Show, {
|
|
588
|
+
get when() {
|
|
589
|
+
return Boolean(context?.entryPath);
|
|
590
|
+
},
|
|
591
|
+
get children() {
|
|
592
|
+
return createComponent(FunctionDeclaration, {
|
|
593
|
+
refkey: createEnvRefkey,
|
|
594
|
+
async: false,
|
|
595
|
+
"export": true,
|
|
596
|
+
name: "createEnv",
|
|
597
|
+
parameters: [{
|
|
598
|
+
name: "environmentConfig",
|
|
599
|
+
type: `Partial<Env>`,
|
|
600
|
+
optional: false,
|
|
601
|
+
default: "{}"
|
|
602
|
+
}],
|
|
603
|
+
returnType: "Env",
|
|
604
|
+
get children() {
|
|
605
|
+
return [
|
|
606
|
+
code`
|
|
506
607
|
return new Proxy<Env>(
|
|
507
608
|
deserializeEnv({
|
|
508
609
|
...initialEnv,
|
|
@@ -510,70 +611,80 @@ function EnvBuiltin(props) {
|
|
|
510
611
|
} as Env),
|
|
511
612
|
{
|
|
512
613
|
get: (target: UnprefixedEnv, propertyName: string) => { `,
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
614
|
+
createIntrinsic("hbr", {}),
|
|
615
|
+
createComponent(For, {
|
|
616
|
+
each: reflectionGetProperties,
|
|
617
|
+
get children() {
|
|
618
|
+
return __assignType((property, index) => createComponent(ConfigPropertyGet, {
|
|
619
|
+
index,
|
|
620
|
+
context,
|
|
621
|
+
property
|
|
622
|
+
}), [
|
|
623
|
+
"property",
|
|
624
|
+
"index",
|
|
625
|
+
"",
|
|
626
|
+
"P!2!'2\"\"/#"
|
|
627
|
+
]);
|
|
628
|
+
}
|
|
629
|
+
}),
|
|
630
|
+
code`
|
|
528
631
|
return undefined;
|
|
529
632
|
}, `,
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
633
|
+
createComponent(Spacing, {}),
|
|
634
|
+
code` set: (target: UnprefixedEnv, propertyName: string, newValue: any) => { `,
|
|
635
|
+
createIntrinsic("hbr", {}),
|
|
636
|
+
createComponent(For, {
|
|
637
|
+
each: reflectionSetProperties,
|
|
638
|
+
ender: code` else `,
|
|
639
|
+
get children() {
|
|
640
|
+
return __assignType((property, index) => createComponent(ConfigPropertySet, {
|
|
641
|
+
index,
|
|
642
|
+
context,
|
|
643
|
+
property
|
|
644
|
+
}), [
|
|
645
|
+
"property",
|
|
646
|
+
"index",
|
|
647
|
+
"",
|
|
648
|
+
"P!2!'2\"\"/#"
|
|
649
|
+
]);
|
|
650
|
+
}
|
|
651
|
+
}),
|
|
652
|
+
createIntrinsic("hbr", {}),
|
|
653
|
+
code`return false;
|
|
549
654
|
}
|
|
550
655
|
}
|
|
551
656
|
);
|
|
552
657
|
`
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
658
|
+
];
|
|
659
|
+
}
|
|
660
|
+
});
|
|
661
|
+
}
|
|
662
|
+
}),
|
|
663
|
+
createComponent(Spacing, {}),
|
|
664
|
+
createIntrinsic("hbr", {}),
|
|
665
|
+
createComponent(TSDoc, {
|
|
666
|
+
heading: "The environment configuration object.",
|
|
667
|
+
get children() {
|
|
668
|
+
return createComponent(TSDocRemarks, { children: `This object provides access to the environment configuration parameters in the application runtime.` });
|
|
669
|
+
}
|
|
670
|
+
}),
|
|
671
|
+
createComponent(VarDeclaration, {
|
|
672
|
+
refkey: envRefkey,
|
|
673
|
+
name: "env",
|
|
674
|
+
type: "Env",
|
|
675
|
+
"export": true,
|
|
676
|
+
"const": true,
|
|
677
|
+
get initializer() {
|
|
678
|
+
return [code`createEnv(${defaultConfig || "{}"} as Partial<Env>);`];
|
|
679
|
+
}
|
|
680
|
+
}),
|
|
681
|
+
createComponent(Spacing, {}),
|
|
682
|
+
createComponent(VarDeclaration, {
|
|
683
|
+
"export": true,
|
|
684
|
+
"const": true,
|
|
685
|
+
name: "isCI",
|
|
686
|
+
doc: "Detect if the application is running in a continuous integration (CI) environment.",
|
|
687
|
+
initializer: code`Boolean(
|
|
577
688
|
env.CI ||
|
|
578
689
|
env.RUN_ID ||
|
|
579
690
|
env.AGOLA_GIT_REF ||
|
|
@@ -626,61 +737,66 @@ function EnvBuiltin(props) {
|
|
|
626
737
|
env.CI_XCODE_PROJECT ||
|
|
627
738
|
env.XCS || false
|
|
628
739
|
); `
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
|
|
740
|
+
}),
|
|
741
|
+
createComponent(Spacing, {}),
|
|
742
|
+
createComponent(TSDoc, {
|
|
743
|
+
heading: "Detect the \\`mode\\` of the current runtime environment.",
|
|
744
|
+
get children() {
|
|
745
|
+
return createComponent(TSDocRemarks, { children: code`The \`mode\` is determined by the \`MODE\` environment variable, or falls back to the \`NEXT_PUBLIC_VERCEL_ENV\`, \`NODE_ENV\`, or defaults to \`production\`. While the value can potentially be any string, it is generally recommended to only allow a value in the following list:
|
|
634
746
|
- \`production\`
|
|
635
747
|
- \`test\`
|
|
636
748
|
- \`development\`
|
|
637
|
-
` })
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
|
|
749
|
+
` });
|
|
750
|
+
}
|
|
751
|
+
}),
|
|
752
|
+
createComponent(VarDeclaration, {
|
|
753
|
+
"export": true,
|
|
754
|
+
"const": true,
|
|
755
|
+
name: "mode",
|
|
756
|
+
initializer: code`String(env.MODE) || "production"; `
|
|
757
|
+
}),
|
|
758
|
+
createComponent(Spacing, {}),
|
|
759
|
+
createComponent(VarDeclaration, {
|
|
760
|
+
"export": true,
|
|
761
|
+
"const": true,
|
|
762
|
+
name: "isProduction",
|
|
763
|
+
doc: "Detect if the application is running in `\"production\"` mode",
|
|
764
|
+
initializer: code`["prd", "prod", "production"].includes(mode.toLowerCase()); `
|
|
765
|
+
}),
|
|
766
|
+
createComponent(Spacing, {}),
|
|
767
|
+
createComponent(VarDeclaration, {
|
|
768
|
+
"export": true,
|
|
769
|
+
"const": true,
|
|
770
|
+
name: "isTest",
|
|
771
|
+
doc: "Detect if the application is running in `\"test\"` mode",
|
|
772
|
+
initializer: code`["tst", "test", "testing", "stg", "stage", "staging"].includes(mode.toLowerCase()) || env.TEST; `
|
|
773
|
+
}),
|
|
774
|
+
createComponent(Spacing, {}),
|
|
775
|
+
createComponent(VarDeclaration, {
|
|
776
|
+
"export": true,
|
|
777
|
+
"const": true,
|
|
778
|
+
name: "isDevelopment",
|
|
779
|
+
doc: "Detect if the application is running in `\"development\"` mode",
|
|
780
|
+
initializer: code`["dev", "development"].includes(mode.toLowerCase()); `
|
|
781
|
+
}),
|
|
782
|
+
createComponent(Spacing, {}),
|
|
783
|
+
createComponent(VarDeclaration, {
|
|
784
|
+
"export": true,
|
|
785
|
+
"const": true,
|
|
786
|
+
name: "isDebug",
|
|
787
|
+
doc: "Detect if the application is currently being debugged",
|
|
788
|
+
initializer: code`Boolean(isDevelopment && env.DEBUG); `
|
|
789
|
+
}),
|
|
790
|
+
createComponent(Spacing, {}),
|
|
791
|
+
createComponent(Show, {
|
|
792
|
+
get when() {
|
|
793
|
+
return Boolean(children);
|
|
794
|
+
},
|
|
795
|
+
children
|
|
796
|
+
})
|
|
797
|
+
];
|
|
798
|
+
}
|
|
799
|
+
}));
|
|
684
800
|
}
|
|
685
801
|
EnvBuiltin.__type = [
|
|
686
802
|
() => __ΩEnvBuiltinProps,
|