@powerlines/plugin-env 0.16.68 → 0.16.70
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/README.md +1 -1
- package/dist/components/docs.cjs +37 -27
- package/dist/components/docs.mjs +37 -27
- package/dist/components/docs.mjs.map +1 -1
- package/dist/components/env-builtin.cjs +404 -314
- package/dist/components/env-builtin.mjs +404 -314
- package/dist/components/env-builtin.mjs.map +1 -1
- package/dist/index.cjs +6 -3
- package/dist/index.mjs +7 -4
- package/dist/index.mjs.map +1 -1
- package/package.json +18 -18
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"env-builtin.mjs","names":[],"sources":["../../src/components/env-builtin.tsx"],"sourcesContent":["/* -------------------------------------------------------------------\n\n ⚡ Storm Software - Powerlines\n\n This code was released as part of the Powerlines project. Powerlines\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/powerlines.\n\n Website: https://stormsoftware.com\n Repository: https://github.com/storm-software/powerlines\n Documentation: https://docs.stormsoftware.com/projects/powerlines\n Contact: https://stormsoftware.com/contact\n\n SPDX-License-Identifier: Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport {\n Children,\n code,\n computed,\n For,\n Show,\n splitProps\n} from \"@alloy-js/core\";\nimport {\n ClassDeclaration,\n ClassMethod,\n ElseIfClause,\n FunctionDeclaration,\n IfStatement,\n NewExpression,\n TypeDeclaration,\n VarDeclaration\n} from \"@alloy-js/typescript\";\nimport {\n ReflectionClass,\n ReflectionKind,\n ReflectionProperty\n} from \"@powerlines/deepkit/vendor/type\";\nimport { Spacing } from \"@powerlines/plugin-alloy/core/components/spacing\";\nimport { usePowerlines } from \"@powerlines/plugin-alloy/core/contexts/context\";\nimport { refkey } from \"@powerlines/plugin-alloy/helpers/refkey\";\nimport { ComponentProps } from \"@powerlines/plugin-alloy/types/components\";\nimport {\n BuiltinFile,\n BuiltinFileProps\n} from \"@powerlines/plugin-alloy/typescript/components/builtin-file\";\nimport type { InterfaceDeclarationProps } from \"@powerlines/plugin-alloy/typescript/components/interface-declaration\";\nimport { InterfaceDeclaration } from \"@powerlines/plugin-alloy/typescript/components/interface-declaration\";\nimport { ObjectDeclaration } from \"@powerlines/plugin-alloy/typescript/components/object-declaration\";\nimport {\n TSDoc,\n TSDocExample,\n TSDocLink,\n TSDocParam,\n TSDocRemarks,\n TSDocReturns,\n TSDocThrows\n} from \"@powerlines/plugin-alloy/typescript/components/tsdoc\";\nimport { titleCase } from \"@stryke/string-format/title-case\";\nimport defu from \"defu\";\nimport { loadEnvFromContext } from \"../helpers/load\";\nimport { EnvPluginContext } from \"../types/plugin\";\n\n/**\n * Generates the environment configuration typescript definition for the Powerlines project.\n */\nexport function EnvTypeDefinition(\n props: Omit<InterfaceDeclarationProps, \"name\">\n) {\n const [{ defaultValue, reflection }] = splitProps(props, [\n \"defaultValue\",\n \"reflection\"\n ]);\n\n const context = usePowerlines<EnvPluginContext>();\n\n return (\n <>\n <InterfaceDeclaration\n name=\" EnvBase\"\n defaultValue={defaultValue}\n reflection={reflection}\n export={true}\n />\n <Spacing />\n <TSDoc heading=\"The environment configuration object with prefixed keys.\">\n <TSDocRemarks>\n {`The \\`Env\\` type extends the \\`EnvBase\\` 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.`}\n </TSDocRemarks>\n </TSDoc>\n <TypeDeclaration name=\"Env\" export={true}>\n {code` {\n [Key in keyof EnvBase as Key ${context.config.env.prefix\n .map(prefix => `| \\`${prefix.replace(/_$/g, \"\")}_\\${Key}\\``)\n .join(\" \")}]: EnvBase[Key];\n}\n`}\n </TypeDeclaration>\n <Spacing />\n </>\n );\n}\n\ninterface ConfigPropertyConditionalProps extends ComponentProps {\n context: EnvPluginContext;\n name: string;\n}\n\nfunction ConfigPropertyConditional(props: ConfigPropertyConditionalProps) {\n const [{ context, name }] = splitProps(props, [\"context\", \"name\"]);\n\n return code`propertyName === \"${name}\" || propertyName.replace(/^(${context.config.env.prefix\n .sort((a, b) =>\n a.startsWith(b) ? -1 : b.startsWith(a) ? 1 : a.localeCompare(b)\n )\n .map(prefix => `${prefix.replace(/_$/, \"\")}_`)\n .join(\"|\")})/g, \"\").toLowerCase().replace(/[\\\\s\\\\-_]+/g, \"\") === \"${name\n .toLowerCase()\n .replace(/[\\s\\-_]+/g, \"\")}\"`;\n}\n\ninterface ConfigPropertyProps extends ComponentProps {\n index: number;\n context: EnvPluginContext;\n property: ReflectionProperty;\n}\n\nfunction ConfigPropertyGet(props: ConfigPropertyProps) {\n const [{ context, property, index }] = splitProps(props, [\n \"context\",\n \"property\",\n \"index\"\n ]);\n\n return (\n <>\n {index === 0 ? (\n <IfStatement\n condition={\n <>\n <ConfigPropertyConditional\n name={property.getNameAsString()}\n context={context}\n />\n <Show\n when={property.getAlias() && property.getAlias().length > 0}>\n {code` || `}\n <For each={property.getAlias()} joiner={code` || `}>\n {alias => (\n <ConfigPropertyConditional name={alias} context={context} />\n )}\n </For>\n </Show>\n </>\n }>\n {code`return target[\"${property.getNameAsString()}\"];`}\n </IfStatement>\n ) : (\n <ElseIfClause\n condition={\n <>\n <ConfigPropertyConditional\n name={property.getNameAsString()}\n context={context}\n />\n <Show\n when={property.getAlias() && property.getAlias().length > 0}>\n {code` || `}\n <For each={property.getAlias()} joiner={code` || `}>\n {alias => (\n <ConfigPropertyConditional name={alias} context={context} />\n )}\n </For>\n </Show>\n </>\n }>\n {code`return target[\"${property.getNameAsString()}\"];`}\n </ElseIfClause>\n )}\n </>\n );\n}\n\nfunction ConfigPropertySet(props: ConfigPropertyProps) {\n const [{ context, property, index }] = splitProps(props, [\n \"context\",\n \"property\",\n \"index\"\n ]);\n\n return (\n <>\n {index === 0 ? (\n <IfStatement\n condition={\n <>\n <ConfigPropertyConditional\n name={property.getNameAsString()}\n context={context}\n />\n <Show\n when={property.getAlias() && property.getAlias().length > 0}>\n {code` || `}\n <For each={property.getAlias()} joiner={code` || `}>\n {alias => (\n <ConfigPropertyConditional name={alias} context={context} />\n )}\n </For>\n </Show>\n </>\n }>\n {code`\n target[\"${property.getNameAsString()}\"] = newValue;\n return true;\n`}\n </IfStatement>\n ) : (\n <ElseIfClause\n condition={\n <>\n <ConfigPropertyConditional\n name={property.getNameAsString()}\n context={context}\n />\n <Show\n when={property.getAlias() && property.getAlias().length > 0}>\n {code` || `}\n <For each={property.getAlias()} joiner={code` || `}>\n {alias => (\n <ConfigPropertyConditional name={alias} context={context} />\n )}\n </For>\n </Show>\n </>\n }>\n {code`\n target[\"${property.getNameAsString()}\"] = newValue;\n return true;\n`}\n </ElseIfClause>\n )}\n </>\n );\n}\n\nexport interface EnvBuiltinProps extends Omit<BuiltinFileProps, \"id\"> {\n defaultConfig?: Children;\n reflection: ReflectionClass<any>;\n}\n\nconst createEnvRefkey = refkey(\"createEnv\");\nconst envRefkey = refkey(\"env\");\nconst envSerializerRefkey = refkey(\"EnvSerializer\");\n\n/**\n * Generates the environment configuration module for the Powerlines project.\n */\nexport function EnvBuiltin(props: EnvBuiltinProps) {\n const [{ defaultConfig, reflection, children }, rest] = splitProps(props, [\n \"defaultConfig\",\n \"reflection\",\n \"children\"\n ]);\n\n const context = usePowerlines<EnvPluginContext>();\n const defaultValue = computed(\n () => context && loadEnvFromContext(context, process.env)\n );\n\n const envInstance = computed(() => {\n const result = new ReflectionClass(\n {\n kind: ReflectionKind.objectLiteral,\n description: `The initial environment configuration state for the ${titleCase(\n context?.config?.name\n )} project.`,\n types: []\n },\n reflection\n );\n\n return result;\n });\n\n const reflectionGetProperties = computed(\n () =>\n reflection\n ?.getProperties()\n .filter(property => !property.isIgnored())\n .sort((a, b) =>\n a.getNameAsString().localeCompare(b.getNameAsString())\n ) ?? []\n );\n const reflectionSetProperties = computed(\n () =>\n reflection\n ?.getProperties()\n .filter(property => !property.isIgnored() && !property.isReadonly())\n .sort((a, b) =>\n a.getNameAsString().localeCompare(b.getNameAsString())\n ) ?? []\n );\n\n return (\n <BuiltinFile\n id=\"env\"\n description=\"The environment configuration module provides an interface to define environment configuration parameters.\"\n {...rest}\n imports={defu(\n {\n \"@powerlines/deepkit/vendor/type\": [\n \"stringify\",\n \"serializer\",\n \"serializeFunction\",\n \"deserializeFunction\",\n \"ReflectionKind\",\n \"Serializer\",\n \"TemplateState\",\n \"Type\",\n \"TypeProperty\",\n \"TypePropertySignature\"\n ]\n },\n rest.imports ?? {}\n )}>\n <Show when={Boolean(reflection)}>\n <EnvTypeDefinition\n defaultValue={defaultValue.value}\n reflection={reflection}\n />\n <hbr />\n <hbr />\n </Show>\n\n <ObjectDeclaration\n name=\"initialEnv\"\n type=\"Partial<EnvBase>\"\n defaultValue={defaultValue}\n reflection={envInstance}\n export={true}\n const={true}\n doc=\"The initial environment configuration object values for the runtime.\"\n />\n <Spacing />\n\n <TSDoc heading=\"The environment configuration serializer for the Powerlines application.\">\n <TSDocLink>\n {`https://deepkit.io/docs/serialization/serializers`}\n </TSDocLink>\n <TSDocLink>\n {`https://github.com/marcj/untitled-code/blob/master/packages/type/src/serializer.ts#L1918`}\n </TSDocLink>\n <TSDocRemarks>\n {`This serializer is used to serialize and deserialize the Powerlines environment configuration.`}\n </TSDocRemarks>\n </TSDoc>\n <ClassDeclaration\n refkey={envSerializerRefkey}\n name=\"EnvSerializer\"\n extends=\"Serializer\"\n export={true}>\n <ClassMethod\n name=\"constructor\"\n public={true}\n doc=\"Initializes a new instance of the `EnvSerializer` class.\">\n {code`super(\"env\");\n\n this.deserializeRegistry.register(\n ReflectionKind.boolean,\n (type: Type, state: TemplateState) => {\n state.addSetter(\n \\`typeof \\${state.accessor.toString()} !== \"boolean\" ? \\${state.accessor.toString()} === 1 || \\${state.accessor.toString()} === \"1\" || \\${state.accessor.toString()}.toLowerCase() === \"t\" || \\${state.accessor.toString()}.toLowerCase() === \"true\" || \\${state.accessor.toString()}.toLowerCase() === \"y\" || \\${state.accessor.toString()}.toLowerCase() === \"yes\" : \\${state.accessor.toString()}\\`\n );\n }\n ); `}\n </ClassMethod>\n </ClassDeclaration>\n <Spacing />\n\n <TSDoc heading=\"A {@link EnvSerializer | environment configuration serializer} instance for the Powerlines application.\">\n <TSDocLink>\n {`https://deepkit.io/docs/serialization/serializers`}\n </TSDocLink>\n <TSDocLink>\n {`https://github.com/marcj/untitled-code/blob/master/packages/type/src/serializer.ts#L1918`}\n </TSDocLink>\n <TSDocRemarks>\n {`This serializer is used to serialize and deserialize the Powerlines environment configuration.`}\n </TSDocRemarks>\n </TSDoc>\n <VarDeclaration\n name=\"envSerializer\"\n export={false}\n const={true}\n initializer={<NewExpression args={[]} target=\"EnvSerializer\" />}\n />\n <Spacing />\n\n <TSDoc heading=\"Serialize a environment configuration object to JSON data objects (not a JSON string).\">\n <TSDocRemarks>\n {`The resulting JSON object can be stringified using \\`JSON.stringify()\\`.`}\n </TSDocRemarks>\n <TSDocExample>{`const json = serializeEnv(env);`}</TSDocExample>\n <TSDocThrows>\n {`ValidationError when serialization or validation fails.`}\n </TSDocThrows>\n </TSDoc>\n <VarDeclaration\n name=\"serializeEnv\"\n export={true}\n const={true}\n initializer={\"serializeFunction<EnvBase>(envSerializer)\"}\n />\n <Spacing />\n\n <TSDoc heading=\"Deserialize a environment configuration object from JSON data objects to JavaScript objects, without running any validators.\">\n <TSDocRemarks>\n {`Types that are already correct will be used as-is.`}\n </TSDocRemarks>\n <TSDocExample>{`const env = deserializeEnv(json);`}</TSDocExample>\n <TSDocThrows>\n {`ValidationError when deserialization fails.`}\n </TSDocThrows>\n </TSDoc>\n <VarDeclaration\n name=\"deserializeEnv\"\n export={true}\n const={true}\n initializer=\"deserializeFunction<EnvBase>(envSerializer)\"\n />\n <Spacing />\n\n <TSDoc heading=\"Initializes the Powerlines environment configuration module.\">\n <TSDocRemarks>\n {`This function initializes the Powerlines environment configuration object.`}\n </TSDocRemarks>\n <TSDocParam name=\"environmentConfig\">\n {`The dynamic/runtime configuration - this could include the current environment variables or any other environment-specific settings provided by the runtime.`}\n </TSDocParam>\n <TSDocReturns>\n {`The initialized Powerlines configuration object.`}\n </TSDocReturns>\n </TSDoc>\n <Show when={Boolean(context?.entryPath)}>\n <FunctionDeclaration\n refkey={createEnvRefkey}\n async={false}\n export={true}\n name=\"createEnv\"\n parameters={[\n {\n name: \"environmentConfig\",\n type: `Partial<Env>`,\n optional: false,\n default: \"{}\"\n }\n ]}\n returnType=\"Env\">\n {code`\n return new Proxy<Env>(\n deserializeEnv({\n ...initialEnv,\n ...environmentConfig\n }) as Env,\n {\n get: (target: EnvBase, propertyName: string) => { `}\n <hbr />\n\n <For each={reflectionGetProperties}>\n {(property: ReflectionProperty, index: number) => (\n <ConfigPropertyGet\n index={index}\n context={context}\n property={property}\n />\n )}\n </For>\n {code`\n return undefined;\n }, `}\n\n <Spacing />\n {code` set: (target: EnvBase, propertyName: string, newValue: any) => { `}\n <hbr />\n\n <For each={reflectionSetProperties} ender={code` else `}>\n {(property: ReflectionProperty, index: number) => (\n <ConfigPropertySet\n index={index}\n context={context}\n property={property}\n />\n )}\n </For>\n\n <hbr />\n {code`return false;\n }\n }\n );\n`}\n </FunctionDeclaration>\n </Show>\n <Spacing />\n <hbr />\n\n <TSDoc heading=\"The environment configuration object.\">\n <TSDocRemarks>\n {`This object provides access to the environment configuration parameters in the application runtime.`}\n </TSDocRemarks>\n </TSDoc>\n <VarDeclaration\n refkey={envRefkey}\n name=\"env\"\n type=\"Env\"\n export={true}\n const={true}\n initializer={\n <>{code`createEnv(${defaultConfig || \"{}\"} as Partial<Env>);`}</>\n }\n />\n <Spacing />\n\n <VarDeclaration\n export\n const\n name=\"isCI\"\n doc=\"Detect if the application is running in a continuous integration (CI) environment.\"\n initializer={code`Boolean(\n env.CI ||\n env.RUN_ID ||\n env.AGOLA_GIT_REF ||\n env.AC_APPCIRCLE ||\n env.APPVEYOR ||\n env.CODEBUILD ||\n env.TF_BUILD ||\n env.bamboo_planKey ||\n env.BITBUCKET_COMMIT ||\n env.BITRISE_IO ||\n env.BUDDY_WORKSPACE_ID ||\n env.BUILDKITE ||\n env.CIRCLECI ||\n env.CIRRUS_CI ||\n env.CF_BUILD_ID ||\n env.CM_BUILD_ID ||\n env.CI_NAME ||\n env.DRONE ||\n env.DSARI ||\n env.EARTHLY_CI ||\n env.EAS_BUILD ||\n env.GERRIT_PROJECT ||\n env.GITEA_ACTIONS ||\n env.GITHUB_ACTIONS ||\n env.GITLAB_CI ||\n env.GOCD ||\n env.BUILDER_OUTPUT ||\n env.HARNESS_BUILD_ID ||\n env.JENKINS_URL ||\n env.LAYERCI ||\n env.MAGNUM ||\n env.NETLIFY ||\n env.NEVERCODE ||\n env.PROW_JOB_ID ||\n env.RELEASE_BUILD_ID ||\n env.RENDER ||\n env.SAILCI ||\n env.HUDSON ||\n env.SCREWDRIVER ||\n env.SEMAPHORE ||\n env.SOURCEHUT ||\n env.STRIDER ||\n env.TASK_ID ||\n env.RUN_ID ||\n env.TEAMCITY_VERSION ||\n env.TRAVIS ||\n env.VELA ||\n env.NOW_BUILDER ||\n env.APPCENTER_BUILD_ID ||\n env.CI_XCODE_PROJECT ||\n env.XCS || false\n );\n `}\n />\n <Spacing />\n\n <TSDoc heading=\"Detect the \\`mode\\` of the current runtime environment.\">\n <TSDocRemarks>\n {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:\n - \\`production\\`\n - \\`test\\`\n - \\`development\\`\n `}\n </TSDocRemarks>\n </TSDoc>\n <VarDeclaration\n export\n const\n name=\"mode\"\n initializer={code`String(env.MODE) || \"production\"; `}\n />\n <Spacing />\n\n <VarDeclaration\n export\n const\n name=\"isProduction\"\n doc='Detect if the application is running in `\"production\"` mode'\n initializer={code`[\"prd\", \"prod\", \"production\"].includes(mode.toLowerCase()); `}\n />\n <Spacing />\n\n <VarDeclaration\n export\n const\n name=\"isTest\"\n doc='Detect if the application is running in `\"test\"` mode'\n initializer={code`[\"tst\", \"test\", \"testing\", \"stg\", \"stage\", \"staging\"].includes(mode.toLowerCase()) || env.TEST; `}\n />\n <Spacing />\n\n <VarDeclaration\n export\n const\n name=\"isDevelopment\"\n doc='Detect if the application is running in `\"development\"` mode'\n initializer={code`[\"dev\", \"development\"].includes(mode.toLowerCase()); `}\n />\n <Spacing />\n\n <VarDeclaration\n export\n const\n name=\"isDebug\"\n doc=\"Detect if the application is currently being debugged\"\n initializer={code`Boolean(isDevelopment && env.DEBUG); `}\n />\n <Spacing />\n <Show when={Boolean(children)}>{children}</Show>\n </BuiltinFile>\n );\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAqEA,SAAgB,kBACd,OACA;CACA,MAAM,CAAC,EAAE,cAAc,gBAAgB,WAAW,OAAO,CACvD,gBACA,aACD,CAAC;CAEF,MAAM,UAAU,eAAiC;AAEjD,QACE;EACE,oBAAC,sBAAD;GACE,MAAK;GACS;GACF;GACZ,QAAQ;GACR;EACF,oBAAC,SAAD,EAAW;EACX,oBAAC,OAAD;GAAO,SAAQ;aACb,oBAAC,cAAD,YACG,iPACY;GACT;EACR,oBAAC,iBAAD;GAAiB,MAAK;GAAM,QAAQ;aACjC,IAAI;mCACsB,QAAQ,OAAO,IAAI,OAC/C,KAAI,WAAU,OAAO,OAAO,QAAQ,OAAO,GAAG,CAAC,YAAY,CAC3D,KAAK,IAAI,CAAC;;;GAGO;EAClB,oBAAC,SAAD,EAAW;EACV;;AASP,SAAS,0BAA0B,OAAuC;CACxE,MAAM,CAAC,EAAE,SAAS,UAAU,WAAW,OAAO,CAAC,WAAW,OAAO,CAAC;AAElE,QAAO,IAAI,qBAAqB,KAAK,+BAA+B,QAAQ,OAAO,IAAI,OACpF,MAAM,GAAG,MACR,EAAE,WAAW,EAAE,GAAG,KAAK,EAAE,WAAW,EAAE,GAAG,IAAI,EAAE,cAAc,EAAE,CAChE,CACA,KAAI,WAAU,GAAG,OAAO,QAAQ,MAAM,GAAG,CAAC,GAAG,CAC7C,KAAK,IAAI,CAAC,yDAAyD,KACnE,aAAa,CACb,QAAQ,aAAa,GAAG,CAAC;;AAS9B,SAAS,kBAAkB,OAA4B;CACrD,MAAM,CAAC,EAAE,SAAS,UAAU,WAAW,WAAW,OAAO;EACvD;EACA;EACA;EACD,CAAC;AAEF,QACE,0CACG,UAAU,IACT,oBAAC,aAAD;EACE,WACE,4CACE,oBAAC,2BAAD;GACE,MAAM,SAAS,iBAAiB;GACvB;GACT,GACF,qBAAC,MAAD;GACE,MAAM,SAAS,UAAU,IAAI,SAAS,UAAU,CAAC,SAAS;aAD5D,CAEG,IAAI,QACL,oBAAC,KAAD;IAAK,MAAM,SAAS,UAAU;IAAE,QAAQ,IAAI;eACzC,UACC,oBAAC,2BAAD;KAA2B,MAAM;KAAgB;KAAW;IAE1D,EACD;KACN;YAEJ,IAAI,kBAAkB,SAAS,iBAAiB,CAAC;EACtC,IAEd,oBAAC,cAAD;EACE,WACE,4CACE,oBAAC,2BAAD;GACE,MAAM,SAAS,iBAAiB;GACvB;GACT,GACF,qBAAC,MAAD;GACE,MAAM,SAAS,UAAU,IAAI,SAAS,UAAU,CAAC,SAAS;aAD5D,CAEG,IAAI,QACL,oBAAC,KAAD;IAAK,MAAM,SAAS,UAAU;IAAE,QAAQ,IAAI;eACzC,UACC,oBAAC,2BAAD;KAA2B,MAAM;KAAgB;KAAW;IAE1D,EACD;KACN;YAEJ,IAAI,kBAAkB,SAAS,iBAAiB,CAAC;EACrC,GAEhB;;AAIP,SAAS,kBAAkB,OAA4B;CACrD,MAAM,CAAC,EAAE,SAAS,UAAU,WAAW,WAAW,OAAO;EACvD;EACA;EACA;EACD,CAAC;AAEF,QACE,0CACG,UAAU,IACT,oBAAC,aAAD;EACE,WACE,4CACE,oBAAC,2BAAD;GACE,MAAM,SAAS,iBAAiB;GACvB;GACT,GACF,qBAAC,MAAD;GACE,MAAM,SAAS,UAAU,IAAI,SAAS,UAAU,CAAC,SAAS;aAD5D,CAEG,IAAI,QACL,oBAAC,KAAD;IAAK,MAAM,SAAS,UAAU;IAAE,QAAQ,IAAI;eACzC,UACC,oBAAC,2BAAD;KAA2B,MAAM;KAAgB;KAAW;IAE1D,EACD;KACN;YAEJ,IAAI;cACD,SAAS,iBAAiB,CAAC;;;EAGnB,IAEd,oBAAC,cAAD;EACE,WACE,4CACE,oBAAC,2BAAD;GACE,MAAM,SAAS,iBAAiB;GACvB;GACT,GACF,qBAAC,MAAD;GACE,MAAM,SAAS,UAAU,IAAI,SAAS,UAAU,CAAC,SAAS;aAD5D,CAEG,IAAI,QACL,oBAAC,KAAD;IAAK,MAAM,SAAS,UAAU;IAAE,QAAQ,IAAI;eACzC,UACC,oBAAC,2BAAD;KAA2B,MAAM;KAAgB;KAAW;IAE1D,EACD;KACN;YAEJ,IAAI;cACD,SAAS,iBAAiB,CAAC;;;EAGlB,GAEhB;;AASP,MAAM,kBAAkB,OAAO,YAAY;AAC3C,MAAM,YAAY,OAAO,MAAM;AAC/B,MAAM,sBAAsB,OAAO,gBAAgB;;;;AAKnD,SAAgB,WAAW,OAAwB;CACjD,MAAM,CAAC,EAAE,eAAe,YAAY,YAAY,QAAQ,WAAW,OAAO;EACxE;EACA;EACA;EACD,CAAC;CAEF,MAAM,UAAU,eAAiC;CACjD,MAAM,eAAe,eACb,WAAW,mBAAmB,SAAS,QAAQ,IAAI,CAC1D;CAED,MAAM,cAAc,eAAe;AAYjC,SAXe,IAAI,gBACjB;GACE,MAAM,eAAe;GACrB,aAAa,uDAAuD,UAClE,SAAS,QAAQ,KAClB,CAAC;GACF,OAAO,EAAE;GACV,EACD,WACD;GAGD;CAEF,MAAM,0BAA0B,eAE5B,YACI,eAAe,CAChB,QAAO,aAAY,CAAC,SAAS,WAAW,CAAC,CACzC,MAAM,GAAG,MACR,EAAE,iBAAiB,CAAC,cAAc,EAAE,iBAAiB,CAAC,CACvD,IAAI,EAAE,CACZ;CACD,MAAM,0BAA0B,eAE5B,YACI,eAAe,CAChB,QAAO,aAAY,CAAC,SAAS,WAAW,IAAI,CAAC,SAAS,YAAY,CAAC,CACnE,MAAM,GAAG,MACR,EAAE,iBAAiB,CAAC,cAAc,EAAE,iBAAiB,CAAC,CACvD,IAAI,EAAE,CACZ;AAED,QACE,qBAAC,aAAD;EACE,IAAG;EACH,aAAY;EACZ,GAAI;EACJ,SAAS,KACP,EACE,mCAAmC;GACjC;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACA;GACD,EACF,EACD,KAAK,WAAW,EAAE,CACnB;YApBH;GAqBE,qBAAC,MAAD;IAAM,MAAM,QAAQ,WAAW;cAA/B;KACE,oBAAC,mBAAD;MACE,cAAc,aAAa;MACf;MACZ;KACF,oBAAC,OAAD,EAAO;KACP,oBAAC,OAAD,EAAO;KACF;;GAEP,oBAAC,mBAAD;IACE,MAAK;IACL,MAAK;IACS;IACd,YAAY;IACZ,QAAQ;IACR,OAAO;IACP,KAAI;IACJ;GACF,oBAAC,SAAD,EAAW;GAEX,qBAAC,OAAD;IAAO,SAAQ;cAAf;KACE,oBAAC,WAAD,YACG,qDACS;KACZ,oBAAC,WAAD,YACG,4FACS;KACZ,oBAAC,cAAD,YACG,kGACY;KACT;;GACR,oBAAC,kBAAD;IACE,QAAQ;IACR,MAAK;IACL,SAAQ;IACR,QAAQ;cACR,oBAAC,aAAD;KACE,MAAK;KACL,QAAQ;KACR,KAAI;eACH,IAAI;;;;;;;;;;KAUO;IACG;GACnB,oBAAC,SAAD,EAAW;GAEX,qBAAC,OAAD;IAAO,SAAQ;cAAf;KACE,oBAAC,WAAD,YACG,qDACS;KACZ,oBAAC,WAAD,YACG,4FACS;KACZ,oBAAC,cAAD,YACG,kGACY;KACT;;GACR,oBAAC,gBAAD;IACE,MAAK;IACL,QAAQ;IACR,OAAO;IACP,aAAa,oBAAC,eAAD;KAAe,MAAM,EAAE;KAAE,QAAO;KAAkB;IAC/D;GACF,oBAAC,SAAD,EAAW;GAEX,qBAAC,OAAD;IAAO,SAAQ;cAAf;KACE,oBAAC,cAAD,YACG,4EACY;KACf,oBAAC,cAAD,YAAe,mCAAiD;KAChE,oBAAC,aAAD,YACG,2DACW;KACR;;GACR,oBAAC,gBAAD;IACE,MAAK;IACL,QAAQ;IACR,OAAO;IACP,aAAa;IACb;GACF,oBAAC,SAAD,EAAW;GAEX,qBAAC,OAAD;IAAO,SAAQ;cAAf;KACE,oBAAC,cAAD,YACG,sDACY;KACf,oBAAC,cAAD,YAAe,qCAAmD;KAClE,oBAAC,aAAD,YACG,+CACW;KACR;;GACR,oBAAC,gBAAD;IACE,MAAK;IACL,QAAQ;IACR,OAAO;IACP,aAAY;IACZ;GACF,oBAAC,SAAD,EAAW;GAEX,qBAAC,OAAD;IAAO,SAAQ;cAAf;KACE,oBAAC,cAAD,YACG,8EACY;KACf,oBAAC,YAAD;MAAY,MAAK;gBACd;MACU;KACb,oBAAC,cAAD,YACG,oDACY;KACT;;GACR,oBAAC,MAAD;IAAM,MAAM,QAAQ,SAAS,UAAU;cACrC,qBAAC,qBAAD;KACE,QAAQ;KACR,OAAO;KACP,QAAQ;KACR,MAAK;KACL,YAAY,CACV;MACE,MAAM;MACN,MAAM;MACN,UAAU;MACV,SAAS;MACV,CACF;KACD,YAAW;eAbb;MAcG,IAAI;;;;;;;;MAQL,oBAAC,OAAD,EAAO;MAEP,oBAAC,KAAD;OAAK,MAAM;kBACP,UAA8B,UAC9B,oBAAC,mBAAD;QACS;QACE;QACC;QACV;OAEA;MACL,IAAI;;;MAIL,oBAAC,SAAD,EAAW;MACV,IAAI;MACL,oBAAC,OAAD,EAAO;MAEP,oBAAC,KAAD;OAAK,MAAM;OAAyB,OAAO,IAAI;kBAC3C,UAA8B,UAC9B,oBAAC,mBAAD;QACS;QACE;QACC;QACV;OAEA;MAEN,oBAAC,OAAD,EAAO;MACN,IAAI;;;;;MAKe;;IACjB;GACP,oBAAC,SAAD,EAAW;GACX,oBAAC,OAAD,EAAO;GAEP,oBAAC,OAAD;IAAO,SAAQ;cACb,oBAAC,cAAD,YACG,uGACY;IACT;GACR,oBAAC,gBAAD;IACE,QAAQ;IACR,MAAK;IACL,MAAK;IACL,QAAQ;IACR,OAAO;IACP,aACE,0CAAG,IAAI,aAAa,iBAAiB,KAAK,qBAAuB;IAEnE;GACF,oBAAC,SAAD,EAAW;GAEX,oBAAC,gBAAD;IACE;IACA;IACA,MAAK;IACL,KAAI;IACJ,aAAa,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAsDjB;GACF,oBAAC,SAAD,EAAW;GAEX,oBAAC,OAAD;IAAO,SAAQ;cACb,oBAAC,cAAD,YACG,IAAI;;;;aAKQ;IACT;GACR,oBAAC,gBAAD;IACE;IACA;IACA,MAAK;IACL,aAAa,IAAI;IACjB;GACF,oBAAC,SAAD,EAAW;GAEX,oBAAC,gBAAD;IACE;IACA;IACA,MAAK;IACL,KAAI;IACJ,aAAa,IAAI;IACjB;GACF,oBAAC,SAAD,EAAW;GAEX,oBAAC,gBAAD;IACE;IACA;IACA,MAAK;IACL,KAAI;IACJ,aAAa,IAAI;IACjB;GACF,oBAAC,SAAD,EAAW;GAEX,oBAAC,gBAAD;IACE;IACA;IACA,MAAK;IACL,KAAI;IACJ,aAAa,IAAI;IACjB;GACF,oBAAC,SAAD,EAAW;GAEX,oBAAC,gBAAD;IACE;IACA;IACA,MAAK;IACL,KAAI;IACJ,aAAa,IAAI;IACjB;GACF,oBAAC,SAAD,EAAW;GACX,oBAAC,MAAD;IAAM,MAAM,QAAQ,SAAS;IAAG;IAAgB;GACpC"}
|
|
1
|
+
{"version":3,"file":"env-builtin.mjs","names":[],"sources":["../../src/components/env-builtin.tsx"],"sourcesContent":["/* -------------------------------------------------------------------\n\n ⚡ Storm Software - Powerlines\n\n This code was released as part of the Powerlines project. Powerlines\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/powerlines.\n\n Website: https://stormsoftware.com\n Repository: https://github.com/storm-software/powerlines\n Documentation: https://docs.stormsoftware.com/projects/powerlines\n Contact: https://stormsoftware.com/contact\n\n SPDX-License-Identifier: Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport {\n Children,\n code,\n computed,\n For,\n Show,\n splitProps\n} from \"@alloy-js/core\";\nimport {\n ClassDeclaration,\n ClassMethod,\n ElseIfClause,\n FunctionDeclaration,\n IfStatement,\n NewExpression,\n TypeDeclaration,\n VarDeclaration\n} from \"@alloy-js/typescript\";\nimport {\n ReflectionClass,\n ReflectionKind,\n ReflectionProperty\n} from \"@powerlines/deepkit/vendor/type\";\nimport { Spacing } from \"@powerlines/plugin-alloy/core/components/spacing\";\nimport { usePowerlines } from \"@powerlines/plugin-alloy/core/contexts/context\";\nimport { refkey } from \"@powerlines/plugin-alloy/helpers/refkey\";\nimport { ComponentProps } from \"@powerlines/plugin-alloy/types/components\";\nimport {\n BuiltinFile,\n BuiltinFileProps\n} from \"@powerlines/plugin-alloy/typescript/components/builtin-file\";\nimport type { InterfaceDeclarationProps } from \"@powerlines/plugin-alloy/typescript/components/interface-declaration\";\nimport { InterfaceDeclaration } from \"@powerlines/plugin-alloy/typescript/components/interface-declaration\";\nimport { ObjectDeclaration } from \"@powerlines/plugin-alloy/typescript/components/object-declaration\";\nimport {\n TSDoc,\n TSDocExample,\n TSDocLink,\n TSDocParam,\n TSDocRemarks,\n TSDocReturns,\n TSDocThrows\n} from \"@powerlines/plugin-alloy/typescript/components/tsdoc\";\nimport { titleCase } from \"@stryke/string-format/title-case\";\nimport defu from \"defu\";\nimport { loadEnvFromContext } from \"../helpers/load\";\nimport { EnvPluginContext } from \"../types/plugin\";\n\n/**\n * Generates the environment configuration typescript definition for the Powerlines project.\n */\nexport function EnvTypeDefinition(\n props: Omit<InterfaceDeclarationProps, \"name\">\n) {\n const [{ defaultValue, reflection }] = splitProps(props, [\n \"defaultValue\",\n \"reflection\"\n ]);\n\n const context = usePowerlines<EnvPluginContext>();\n\n return (\n <>\n <InterfaceDeclaration\n name=\" EnvBase\"\n defaultValue={defaultValue}\n reflection={reflection}\n export={true}\n />\n <Spacing />\n <TSDoc heading=\"The environment configuration object with prefixed keys.\">\n <TSDocRemarks>\n {`The \\`Env\\` type extends the \\`EnvBase\\` 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.`}\n </TSDocRemarks>\n </TSDoc>\n <TypeDeclaration name=\"Env\" export={true}>\n {code` {\n [Key in keyof EnvBase as Key ${context.config.env.prefix\n .map(prefix => `| \\`${prefix.replace(/_$/g, \"\")}_\\${Key}\\``)\n .join(\" \")}]: EnvBase[Key];\n}\n`}\n </TypeDeclaration>\n <Spacing />\n </>\n );\n}\n\ninterface ConfigPropertyConditionalProps extends ComponentProps {\n context: EnvPluginContext;\n name: string;\n}\n\nfunction ConfigPropertyConditional(props: ConfigPropertyConditionalProps) {\n const [{ context, name }] = splitProps(props, [\"context\", \"name\"]);\n\n return code`propertyName === \"${name}\" || propertyName.replace(/^(${context.config.env.prefix\n .sort((a, b) =>\n a.startsWith(b) ? -1 : b.startsWith(a) ? 1 : a.localeCompare(b)\n )\n .map(prefix => `${prefix.replace(/_$/, \"\")}_`)\n .join(\"|\")})/g, \"\").toLowerCase().replace(/[\\\\s\\\\-_]+/g, \"\") === \"${name\n .toLowerCase()\n .replace(/[\\s\\-_]+/g, \"\")}\"`;\n}\n\ninterface ConfigPropertyProps extends ComponentProps {\n index: number;\n context: EnvPluginContext;\n property: ReflectionProperty;\n}\n\nfunction ConfigPropertyGet(props: ConfigPropertyProps) {\n const [{ context, property, index }] = splitProps(props, [\n \"context\",\n \"property\",\n \"index\"\n ]);\n\n return (\n <>\n {index === 0 ? (\n <IfStatement\n condition={\n <>\n <ConfigPropertyConditional\n name={property.getNameAsString()}\n context={context}\n />\n <Show\n when={property.getAlias() && property.getAlias().length > 0}>\n {code` || `}\n <For each={property.getAlias()} joiner={code` || `}>\n {alias => (\n <ConfigPropertyConditional name={alias} context={context} />\n )}\n </For>\n </Show>\n </>\n }>\n {code`return target[\"${property.getNameAsString()}\"];`}\n </IfStatement>\n ) : (\n <ElseIfClause\n condition={\n <>\n <ConfigPropertyConditional\n name={property.getNameAsString()}\n context={context}\n />\n <Show\n when={property.getAlias() && property.getAlias().length > 0}>\n {code` || `}\n <For each={property.getAlias()} joiner={code` || `}>\n {alias => (\n <ConfigPropertyConditional name={alias} context={context} />\n )}\n </For>\n </Show>\n </>\n }>\n {code`return target[\"${property.getNameAsString()}\"];`}\n </ElseIfClause>\n )}\n </>\n );\n}\n\nfunction ConfigPropertySet(props: ConfigPropertyProps) {\n const [{ context, property, index }] = splitProps(props, [\n \"context\",\n \"property\",\n \"index\"\n ]);\n\n return (\n <>\n {index === 0 ? (\n <IfStatement\n condition={\n <>\n <ConfigPropertyConditional\n name={property.getNameAsString()}\n context={context}\n />\n <Show\n when={property.getAlias() && property.getAlias().length > 0}>\n {code` || `}\n <For each={property.getAlias()} joiner={code` || `}>\n {alias => (\n <ConfigPropertyConditional name={alias} context={context} />\n )}\n </For>\n </Show>\n </>\n }>\n {code`\n target[\"${property.getNameAsString()}\"] = newValue;\n return true;\n`}\n </IfStatement>\n ) : (\n <ElseIfClause\n condition={\n <>\n <ConfigPropertyConditional\n name={property.getNameAsString()}\n context={context}\n />\n <Show\n when={property.getAlias() && property.getAlias().length > 0}>\n {code` || `}\n <For each={property.getAlias()} joiner={code` || `}>\n {alias => (\n <ConfigPropertyConditional name={alias} context={context} />\n )}\n </For>\n </Show>\n </>\n }>\n {code`\n target[\"${property.getNameAsString()}\"] = newValue;\n return true;\n`}\n </ElseIfClause>\n )}\n </>\n );\n}\n\nexport interface EnvBuiltinProps extends Omit<BuiltinFileProps, \"id\"> {\n defaultConfig?: Children;\n reflection: ReflectionClass<any>;\n}\n\nconst createEnvRefkey = refkey(\"createEnv\");\nconst envRefkey = refkey(\"env\");\nconst envSerializerRefkey = refkey(\"EnvSerializer\");\n\n/**\n * Generates the environment configuration module for the Powerlines project.\n */\nexport function EnvBuiltin(props: EnvBuiltinProps) {\n const [{ defaultConfig, reflection, children }, rest] = splitProps(props, [\n \"defaultConfig\",\n \"reflection\",\n \"children\"\n ]);\n\n const context = usePowerlines<EnvPluginContext>();\n const defaultValue = computed(\n () => context && loadEnvFromContext(context, process.env)\n );\n\n const envInstance = computed(() => {\n const result = new ReflectionClass(\n {\n kind: ReflectionKind.objectLiteral,\n description: `The initial environment configuration state for the ${titleCase(\n context?.config?.name\n )} project.`,\n types: []\n },\n reflection\n );\n\n return result;\n });\n\n const reflectionGetProperties = computed(\n () =>\n reflection\n ?.getProperties()\n .filter(property => !property.isIgnored())\n .sort((a, b) =>\n a.getNameAsString().localeCompare(b.getNameAsString())\n ) ?? []\n );\n const reflectionSetProperties = computed(\n () =>\n reflection\n ?.getProperties()\n .filter(property => !property.isIgnored() && !property.isReadonly())\n .sort((a, b) =>\n a.getNameAsString().localeCompare(b.getNameAsString())\n ) ?? []\n );\n\n return (\n <BuiltinFile\n id=\"env\"\n description=\"The environment configuration module provides an interface to define environment configuration parameters.\"\n {...rest}\n imports={defu(\n {\n \"@powerlines/deepkit/vendor/type\": [\n \"stringify\",\n \"serializer\",\n \"serializeFunction\",\n \"deserializeFunction\",\n \"ReflectionKind\",\n \"Serializer\",\n \"TemplateState\",\n \"Type\",\n \"TypeProperty\",\n \"TypePropertySignature\"\n ]\n },\n rest.imports ?? {}\n )}>\n <Show when={Boolean(reflection)}>\n <EnvTypeDefinition\n defaultValue={defaultValue.value}\n reflection={reflection}\n />\n <hbr />\n <hbr />\n </Show>\n\n <ObjectDeclaration\n name=\"initialEnv\"\n type=\"Partial<EnvBase>\"\n defaultValue={defaultValue}\n reflection={envInstance}\n export={true}\n const={true}\n doc=\"The initial environment configuration object values for the runtime.\"\n />\n <Spacing />\n\n <TSDoc heading=\"The environment configuration serializer for the Powerlines application.\">\n <TSDocLink>\n {`https://deepkit.io/docs/serialization/serializers`}\n </TSDocLink>\n <TSDocLink>\n {`https://github.com/marcj/untitled-code/blob/master/packages/type/src/serializer.ts#L1918`}\n </TSDocLink>\n <TSDocRemarks>\n {`This serializer is used to serialize and deserialize the Powerlines environment configuration.`}\n </TSDocRemarks>\n </TSDoc>\n <ClassDeclaration\n refkey={envSerializerRefkey}\n name=\"EnvSerializer\"\n extends=\"Serializer\"\n export={true}>\n <ClassMethod\n name=\"constructor\"\n public={true}\n doc=\"Initializes a new instance of the `EnvSerializer` class.\">\n {code`super(\"env\");\n\n this.deserializeRegistry.register(\n ReflectionKind.boolean,\n (type: Type, state: TemplateState) => {\n state.addSetter(\n \\`typeof \\${state.accessor.toString()} !== \"boolean\" ? \\${state.accessor.toString()} === 1 || \\${state.accessor.toString()} === \"1\" || \\${state.accessor.toString()}.toLowerCase() === \"t\" || \\${state.accessor.toString()}.toLowerCase() === \"true\" || \\${state.accessor.toString()}.toLowerCase() === \"y\" || \\${state.accessor.toString()}.toLowerCase() === \"yes\" : \\${state.accessor.toString()}\\`\n );\n }\n ); `}\n </ClassMethod>\n </ClassDeclaration>\n <Spacing />\n\n <TSDoc heading=\"A {@link EnvSerializer | environment configuration serializer} instance for the Powerlines application.\">\n <TSDocLink>\n {`https://deepkit.io/docs/serialization/serializers`}\n </TSDocLink>\n <TSDocLink>\n {`https://github.com/marcj/untitled-code/blob/master/packages/type/src/serializer.ts#L1918`}\n </TSDocLink>\n <TSDocRemarks>\n {`This serializer is used to serialize and deserialize the Powerlines environment configuration.`}\n </TSDocRemarks>\n </TSDoc>\n <VarDeclaration\n name=\"envSerializer\"\n export={false}\n const={true}\n initializer={<NewExpression args={[]} target=\"EnvSerializer\" />}\n />\n <Spacing />\n\n <TSDoc heading=\"Serialize a environment configuration object to JSON data objects (not a JSON string).\">\n <TSDocRemarks>\n {`The resulting JSON object can be stringified using \\`JSON.stringify()\\`.`}\n </TSDocRemarks>\n <TSDocExample>{`const json = serializeEnv(env);`}</TSDocExample>\n <TSDocThrows>\n {`ValidationError when serialization or validation fails.`}\n </TSDocThrows>\n </TSDoc>\n <VarDeclaration\n name=\"serializeEnv\"\n export={true}\n const={true}\n initializer={\"serializeFunction<EnvBase>(envSerializer)\"}\n />\n <Spacing />\n\n <TSDoc heading=\"Deserialize a environment configuration object from JSON data objects to JavaScript objects, without running any validators.\">\n <TSDocRemarks>\n {`Types that are already correct will be used as-is.`}\n </TSDocRemarks>\n <TSDocExample>{`const env = deserializeEnv(json);`}</TSDocExample>\n <TSDocThrows>\n {`ValidationError when deserialization fails.`}\n </TSDocThrows>\n </TSDoc>\n <VarDeclaration\n name=\"deserializeEnv\"\n export={true}\n const={true}\n initializer=\"deserializeFunction<EnvBase>(envSerializer)\"\n />\n <Spacing />\n\n <TSDoc heading=\"Initializes the Powerlines environment configuration module.\">\n <TSDocRemarks>\n {`This function initializes the Powerlines environment configuration object.`}\n </TSDocRemarks>\n <TSDocParam name=\"environmentConfig\">\n {`The dynamic/runtime configuration - this could include the current environment variables or any other environment-specific settings provided by the runtime.`}\n </TSDocParam>\n <TSDocReturns>\n {`The initialized Powerlines configuration object.`}\n </TSDocReturns>\n </TSDoc>\n <Show when={Boolean(context?.entryPath)}>\n <FunctionDeclaration\n refkey={createEnvRefkey}\n async={false}\n export={true}\n name=\"createEnv\"\n parameters={[\n {\n name: \"environmentConfig\",\n type: `Partial<Env>`,\n optional: false,\n default: \"{}\"\n }\n ]}\n returnType=\"Env\">\n {code`\n return new Proxy<Env>(\n deserializeEnv({\n ...initialEnv,\n ...environmentConfig\n }) as Env,\n {\n get: (target: EnvBase, propertyName: string) => { `}\n <hbr />\n\n <For each={reflectionGetProperties}>\n {(property: ReflectionProperty, index: number) => (\n <ConfigPropertyGet\n index={index}\n context={context}\n property={property}\n />\n )}\n </For>\n {code`\n return undefined;\n }, `}\n\n <Spacing />\n {code` set: (target: EnvBase, propertyName: string, newValue: any) => { `}\n <hbr />\n\n <For each={reflectionSetProperties} ender={code` else `}>\n {(property: ReflectionProperty, index: number) => (\n <ConfigPropertySet\n index={index}\n context={context}\n property={property}\n />\n )}\n </For>\n\n <hbr />\n {code`return false;\n }\n }\n );\n`}\n </FunctionDeclaration>\n </Show>\n <Spacing />\n <hbr />\n\n <TSDoc heading=\"The environment configuration object.\">\n <TSDocRemarks>\n {`This object provides access to the environment configuration parameters in the application runtime.`}\n </TSDocRemarks>\n </TSDoc>\n <VarDeclaration\n refkey={envRefkey}\n name=\"env\"\n type=\"Env\"\n export={true}\n const={true}\n initializer={\n <>{code`createEnv(${defaultConfig || \"{}\"} as Partial<Env>);`}</>\n }\n />\n <Spacing />\n\n <VarDeclaration\n export\n const\n name=\"isCI\"\n doc=\"Detect if the application is running in a continuous integration (CI) environment.\"\n initializer={code`Boolean(\n env.CI ||\n env.RUN_ID ||\n env.AGOLA_GIT_REF ||\n env.AC_APPCIRCLE ||\n env.APPVEYOR ||\n env.CODEBUILD ||\n env.TF_BUILD ||\n env.bamboo_planKey ||\n env.BITBUCKET_COMMIT ||\n env.BITRISE_IO ||\n env.BUDDY_WORKSPACE_ID ||\n env.BUILDKITE ||\n env.CIRCLECI ||\n env.CIRRUS_CI ||\n env.CF_BUILD_ID ||\n env.CM_BUILD_ID ||\n env.CI_NAME ||\n env.DRONE ||\n env.DSARI ||\n env.EARTHLY_CI ||\n env.EAS_BUILD ||\n env.GERRIT_PROJECT ||\n env.GITEA_ACTIONS ||\n env.GITHUB_ACTIONS ||\n env.GITLAB_CI ||\n env.GOCD ||\n env.BUILDER_OUTPUT ||\n env.HARNESS_BUILD_ID ||\n env.JENKINS_URL ||\n env.LAYERCI ||\n env.MAGNUM ||\n env.NETLIFY ||\n env.NEVERCODE ||\n env.PROW_JOB_ID ||\n env.RELEASE_BUILD_ID ||\n env.RENDER ||\n env.SAILCI ||\n env.HUDSON ||\n env.SCREWDRIVER ||\n env.SEMAPHORE ||\n env.SOURCEHUT ||\n env.STRIDER ||\n env.TASK_ID ||\n env.RUN_ID ||\n env.TEAMCITY_VERSION ||\n env.TRAVIS ||\n env.VELA ||\n env.NOW_BUILDER ||\n env.APPCENTER_BUILD_ID ||\n env.CI_XCODE_PROJECT ||\n env.XCS || false\n );\n `}\n />\n <Spacing />\n\n <TSDoc heading=\"Detect the \\`mode\\` of the current runtime environment.\">\n <TSDocRemarks>\n {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:\n - \\`production\\`\n - \\`test\\`\n - \\`development\\`\n `}\n </TSDocRemarks>\n </TSDoc>\n <VarDeclaration\n export\n const\n name=\"mode\"\n initializer={code`String(env.MODE) || \"production\"; `}\n />\n <Spacing />\n\n <VarDeclaration\n export\n const\n name=\"isProduction\"\n doc='Detect if the application is running in `\"production\"` mode'\n initializer={code`[\"prd\", \"prod\", \"production\"].includes(mode.toLowerCase()); `}\n />\n <Spacing />\n\n <VarDeclaration\n export\n const\n name=\"isTest\"\n doc='Detect if the application is running in `\"test\"` mode'\n initializer={code`[\"tst\", \"test\", \"testing\", \"stg\", \"stage\", \"staging\"].includes(mode.toLowerCase()) || env.TEST; `}\n />\n <Spacing />\n\n <VarDeclaration\n export\n const\n name=\"isDevelopment\"\n doc='Detect if the application is running in `\"development\"` mode'\n initializer={code`[\"dev\", \"development\"].includes(mode.toLowerCase()); `}\n />\n <Spacing />\n\n <VarDeclaration\n export\n const\n name=\"isDebug\"\n doc=\"Detect if the application is currently being debugged\"\n initializer={code`Boolean(isDevelopment && env.DEBUG); `}\n />\n <Spacing />\n <Show when={Boolean(children)}>{children}</Show>\n </BuiltinFile>\n );\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAuCA,SAAE,kBAAA,OAAA;CACA,MAAM,CAAC,EACT,cACA,gBACO,WAAW,OAAO,CAAA,gBAAiB,aAAO,CAAO;CACxD,MAAQ,UAAC,eAA0C;AACnD,QAAO;EAAA,gBAAA,sBAAA;GACL,MAAA;GACA;GACO;GACT,UAAc;GACd,CAAA;EAAM,gBAAG,SAAuB,EAAA,CAAI;EAAE,gBAAkB,OAAO;GAC/D,SAAS;GACT,IAAO,WAAA;AACL,WAAK,gBAAA,cAAA,EACL,UAAY,iPACZ,CAAA;;GAEA,CAAA;EAAA,gBAAY,iBAAA;GACZ,MAAA;GACA,UAAA;GACA,IAAM,WAAW;AACb,WAAG,IAAA;mCACc,QAAA,OAAA,IAAA,OAAA,KAAA,WAAA,OAAA,OAAA,QAAA,OAAA,GAAA,CAAA,YAAA,CAAA,KAAA,IAAA,CAAA;;;;GAIrB,CAAA;EAAA,gBAAA,SAAA,EAAA,CAAA;EAAA;;AAMF,SAAS,0BAA0B,OAAwB;CACzD,MAAG,CAAA,EACD,SACA;AAEF,QAAM,IAAA,qBAAwB,KAAA,+BAAmB,QAAA,OAAA,IAAA,OAAA,MAAA,GAAA,MAAA,EAAA,WAAA,EAAA,GAAA,KAAA,EAAA,WAAA,EAAA,GAAA,IAAA,EAAA,cAAA,EAAA,CAAA,CAAA,KAAA,WAAA,GAAA,OAAA,QAAA,MAAA,GAAA,CAAA,GAAA,CAAA,KAAA,IAAA,CAAA,yDAAA,KAAA,aAAA,CAAA,QAAA,aAAA,GAAA,CAAA;;AAOnD,SAAQ,kBAAY,OAAU;CAC5B,MAAM,CAAA,EACJ,SACA,UACA,WACG,WAAE,OAAY;EAAA;EAAA;EAAA;EAAA,CAAA;AACnB,QAAO,CAAC,UAAQ,IAAM,gBAAkB,aAAW;EACjD,IAAI,YAAE;AACJ,UAAO,CAAA,gBAAA,2BAAA;IACN,IAAA,OAAA;AACE,YAAM,SAAA,iBAAA;;IAEE;IACV,CAAA,EAAA,gBAAqB,MAAI;IAChC,IAAA,OAAA;AACC,YAAA,WAAA,CAAA,CAAA,SAAA,UAAA,CAAA,EAAA,IAAA,SAAA,UAAA,CAAA,SAAA;;IAEM,IAAA,WAAS;AACV,YAAA,CAAA,IAAA,QAAA,gBAAA,KAAA;MACH,IAAA,OAAA;AACH,cAAA,SAAA,UAAA;;MAEU,QAAA,IAAA;MACC,WAAA,UAAgB,gBAAA,2BAAA;OACb,MAAA;OACd;;MAES,CAAA,CAAA;;;;EAIL,IAAC,WAAa;AACZ,UAAE,IAAA,kBAAuB,SAAa,iBAAS,CAAA;;EAElD,CAAC,GAAC,gBAAiB,cAAiB;EACnC,IAAC,YAAe;AACf,UAAA,CAAA,gBAAY,2BAAA;IACZ,IAAO,OAAO;AACnB,YAAA,SAAA,iBAAA;;IAEU;IACH,CAAC,EAAC,gBAAM,MAAA;IACb,IAAS,OAAA;AACD,YAAE,WAAkB,CAAA,CAAA,SAAA,UAAA,CAAA,EAAA,IAAA,SAAA,UAAA,CAAA,SAAA;;;AAGrB,YAAA,CAAA,IAAA,QAAkB,gBAAO,KAAmB;MAC1C,IAAA,OAAS;AACP,cAAA,SAAA,UAAA;;MAEH,QAAA,IAAA;MACN,WAAA,UAAA,gBAAA,2BAAA;;OAEK;OACJ,CAAA;MACE,CAAK,CAAC;;IAEN,CAAC,CAAC;;EAEL,IAAI,WAAO;AACT,UAAO,IAAG,kBAAe,SAAA,iBAAiB,CAAA;;EAE7C,CAAC,CAAC;;AAEL,SAAS,kBAAa,OAAgC;CACpD,MAAM,CAAC,EACL,SACA,UACA,WACG,WAAW,OAAC;EAAA;EAAA;EAAA;EAAA,CAAA;AACjB,QAAO,CAAC,UAAQ,IAAG,gBAAA,aAAA;EACjB,IAAI,YAAY;AACd,UAAO,CAAC,gBAAA,2BAAA;IACN,IAAG,OAAA;AACD,YAAM,SAAO,iBAAmB;;IAEhC;IACH,CAAC,EAAC,gBAAA,MAAA;IACD,IAAE,OAAS;AACT,YAAG,WAAA,CAAA,CAAA,SAAA,UAAA,CAAA,EAAA,IAAA,SAAA,UAAA,CAAA,SAAA;;IAEL,IAAI,WAAU;AACZ,YAAM,CAAA,IAAA,QAAS,gBAAO,KAAA;MACpB,IAAG,OAAA;AACD,cAAC,SAAA,UAAA;;MAEH,QAAK,IAAO;MACZ,WAAS,UAAM,gBAAqB,2BAAmB;OACrD,MAAK;OACE;OACR,CAAC;MACH,CAAC,CAAC;;IAEN,CAAC,CAAC;;EAEL,IAAI,WAAQ;AACV,UAAI,IAAA;cACH,SAAA,iBAAA,CAAA;;;;;EAKP,IAAQ,YAAC;AACP,UAAS,CAAA,gBAAmB,2BAA6B;IACtD,IAAO,OAAC;AACR,YAAS,SAAA,iBAAA;;IAEV;;IAEI,IAAC,OAAA;AACJ,YAAA,WAAA,CAAA,CAAA,SAAA,UAAA,CAAA,EAAA,IAAA,SAAA,UAAA,CAAA,SAAA;;IAEG,IAAC,WAAA;AACC,YAAA,CAAA,IAAU,QAAA,gBAAA,KAAA;MACR,IAAC,OAAA;AACC,cAAC,SAAA,UAAA;;MAEH,QAAI,IAAQ;MACZ,WAAG,UAAA,gBAAA,2BAAA;OACD,MAAC;OACO;OACT,CAAC;MACH,CAAC,CAAC;;IAEN,CAAC,CAAC;;EAEL,IAAI,WAAU;AACZ,UAAO,IAAG;cACF,SAAA,iBAAA,CAAA;;;;EAIX,CAAC,CAAA;;AAMJ,MAAM,kBAAO,OAAA,YAAA;AACb,MAAM,YAAS,OAAA,MAAA;AACf,MAAM,sBAAgB,OAAS,gBAAiB;;;;AAKhD,SAAgB,WAAW,OAAA;CACzB,MAAM,CAAC,EACL,eACA,YACA,YACC,QAAQ,WAAQ,OAAA;EAAA;EAAA;EAAA;EAAA,CAAA;CACnB,MAAM,UAAQ,eAAI;CAClB,MAAM,eAAM,eAAA,WAAA,mBAAA,SAAA,QAAA,IAAA,CAAA;CACZ,MAAM,cAAG,eAAA;AAMP,SALW,IAAA,gBAAA;GACX,MAAQ,eAAW;GACnB,aAAW,uDAAA,UAAA,SAAA,QAAA,KAAA,CAAA;GACd,OAAA,EAAA;GACI,EAAE,WAAG;GAEN;CACF,MAAC,0BAAA,eAAA,YAAA,eAAA,CAAA,QAAA,aAAA,CAAA,SAAA,WAAA,CAAA,CAAA,MAAA,GAAA,MAAA,EAAA,iBAAA,CAAA,cAAA,EAAA,iBAAA,CAAA,CAAA,IAAA,EAAA,CAAA;CACH,MAAA,0BAAA,eAAA,YAAA,eAAA,CAAA,QAAA,aAAA,CAAA,SAAA,WAAA,IAAA,CAAA,SAAA,YAAA,CAAA,CAAA,MAAA,GAAA,MAAA,EAAA,iBAAA,CAAA,cAAA,EAAA,iBAAA,CAAA,CAAA,IAAA,EAAA,CAAA;;EAEA,IAAO;EACL,aAAe;EACf,EAAA,MAAA;EACF,IAAA,UAAA;iBAEM,mCAAqC;IAAA;IAAA;IAAA;IAAA;IAAA;IAAA;IAAA;IAAA;IAAA;IAAA;IAAA,EACrC,EAAA,KAAA,WAAmB,EAAC,CAAA;;;AAGxB,UAAA;IAAA,gBAAA,MAAA;KACC,IAAS,OAAK;AACf,aAAA,QAAA,WAAA;;KAEM,IAAG,WAAA;AACN,aAAA;OAAa,gBAAC,mBAAA;QACd,IAAW,eAAA;AACH,gBAAA,aAAA;;;QAGL,CAAA;OAAA,gBAAwB,OAAA,EAAA,CAAA;OAAA,gBAAmB,OAAA,EAAA,CAAA;OAAA;;KAE5C,CAAC;IAAE,gBAAW,mBAA0B;KAC5C,MAAA;;KAEmB;KAClB,YAAe;KACb,UAAA;KACE,SAAM;KACN,KAAA;KACD,CAAC;IAAE,gBAAiB,SAAA,EAAA,CAAA;IAAA,gBAAA,OAAA;KACnB,SAAG;KACH,IAAA,WAAQ;AACT,aAAA;OAAA,gBAAA,WAAA,EACD,UAAA,qDACD,CAAA;OAAA,gBAAA,WAAA,wGAEM,CAAA;OAAA,gBAAM,cAAA,EACb,UAAA;;;KAGG,CAAC;IAAA,gBAAA,kBAAA;KACF,QAAA;KACE,MAAE;KACF,WAAQ;KACR,UAAU;KACV,IAAI,WAAA;AACF,aAAI,gBAAA,aAAA;OACX,MAAA;OACK,UAAA;OACA,KAAA;OACF,UAAA,IAAA;;;;;;;;;;OAUI,CAAA;;KAEH,CAAC;IAAE,gBAAI,SAAA,EAAA,CAAA;IAAA,gBAAA,OAAA;KACR,SAAS;KACP,IAAA,WAAA;AACE,aAAE;OAAA,gBAAmB,WAAc,EACjC,UAAU,qDACX,CAAC;OAAC,gBAAW,WAAA,EACZ,UAAC,4FACF,CAAC;OAAC,gBAAmB,cAAC,EACrB,UAAC,kGACF,CAAC;OAAC;;KAEN,CAAC;IAAE,gBAAQ,gBAAA;KACV,MAAK;KACL,UAAK;KACL,SAAE;KACF,IAAC,cAAA;AACD,aAAK,gBAAY,eAAA;OACjB,MAAA,EAAA;OACI,QAAM;OACT,CAAA;;KAEF,CAAC;IAAE,gBAAY,SAAU,EAAA,CAAA;IAAA,gBAAA,OAAA;KACxB,SAAC;KACD,IAAI,WAAE;AACL,aAAK;OAAA,gBAAA,cAAA,EACF,UAAA;uCAEL,UAAA,mCACC,CAAI;OAAE,gBAAU,aAAA,EACZ,UAAU,2DACd,CAAA;OAAA;;KAED,CAAC;IAAA,gBAAY,gBAAA;KACZ,MAAM;KACN,UAAS;KACV,SAAA;KACA,aAAS;;;;KAET,SAAM;KACL,IAAC,WAAS;AACR,aAAO;OAAC,gBAAkB,cAAc,EACxC,UAAS,sDACV,CAAA;OAAA,gBAAS,cAAA,EACN,UAAQ,qCACV,CAAA;OAAA,gBAAS,aAAA,EACV,UAAY,+CACV,CAAC;OAAA;;KAEL,CAAC;IAAA,gBAAK,gBAAA;KACN,MAAA;KACC,UAAQ;KACR,SAAM;KACN,aAAS;KACV,CAAC;IAAA,gBAAa,SAAA,EAAA,CAAA;IAAA,gBAAA,OAAA;KACb,SAAC;KACD,IAAE,WAAM;AACN,aAAO;OAAC,gBAAI,cAAA,EACZ,UAAK,8EACJ,CAAA;OAAA,gBAAiB,YAAA;;QAElB,UAAK;QACJ,CAAC;OAAA,gBAAe,cAAO,EACtB,UAAO,oDACR,CAAC;OAAC;;KAEN,CAAC;IAAE,gBAAK,MAAA;KACP,IAAI,OAAA;AACF,aAAI,QAAA,SAAA,UAAA;;KAEN,IAAA,WAAA;AACD,aAAS,gBAAA,qBAAA;;OAEJ,OAAC;OACJ,UAAS;OACN,MAAM;OACR,YAAS,CAAA;QACV,MAAS;QACN,MAAQ;QACV,UAAS;QACV,SAAY;QACT,CAAA;OACF,YAAY;OACd,IAAK,WAAA;AACN,eAAA;SAAA,IAAA;;;;;;;;;;UAQM,MAAS;UACb,WAAY,UAAA,UAAA,gBAAA,mBAAA;WACI;WACH;WACE;WACf,CAAA;UACG,CAAA;SAAA,IAAA;;;SAEC,gBAAA,SAAA,EAAA,CAAA;SAAA,IAAA;SAAA,gBAAA,OAAA,EAAA,CAAA;SAAA,gBAAA,KAAA;UACN,MAAA;UACO,OAAA,IAAY;UACV,WAAI,UAAA,UAAA,gBAAA,mBAAA;WACD;WACG;WACf;WACS,CAAA;;;;;;;;SAKd;;OAEO,CAAA;;KAEF,CAAC;IAAE,gBAAW,SAAA,EAAA,CAAA;IAAA,gBAAA,OAAA,EAAA,CAAA;IAAA,gBAAA,OAAA;KACb,SAAK;KACN,IAAA,WAAA;AACC,aAAM,gBAAc,cAAA,EACpB,UAAY,uGACZ,CAAA;;KAED,CAAA;IAAA,gBAAA,gBAAA;KACA,QAAS;;KAET,MAAM;KACL,UAAC;KACD,SAAS;KACT,IAAE,cAAY;AACb,aAAA,CAAA,IAAW,aAAM,iBAAkB,KAAA,oBAAA;;KAErC,CAAC;IAAE,gBAAU,SAAA,EAAA,CAAA;IAAA,gBAAA,gBAAA;KACZ,UAAC;KACD,SAAQ;KACR,MAAE;KACF,KAAK;KACN,aAAW,IAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAsDnB,CAAA;IAAA,gBAAA,SAAA,EAAA,CAAA;IAAA,gBAAA,OAAA;KACF,SAAA;KACD,IAAA,WAAA;AACF,aAAA,gBAAA,cAAA,EACS,UAAA,IAAA;;;;aAKH,CAAK;;KAEL,CAAC;IAAE,gBAAc,gBAAmB;KACnC,UAAE;KACF,SAAK;KACN,MAAA;KACC,aAAQ,IAAS;KAClB,CAAC;IAAA,gBAAS,SAAA,EAAA,CAAA;IAAA,gBAAA,gBAAA;KACT,UAAS;KACT,SAAQ;KACR,MAAM;KACN,KAAA;KACA,aAAU,IAAA;KACX,CAAC;IAAA,gBAAA,SAAA,EAAA,CAAA;IAAA,gBAAA,gBAAA;KACD,UAAA;KACA,SAAS;;KAET,KAAA;KACC,aAAA,IAAA;KACD,CAAC;IAAA,gBAAA,SAAA,EAAA,CAAA;IAAA,gBAAA,gBAAA;KACA,UAAU;KACV,SAAK;KACL,MAAA;KACA,KAAK;KACL,aAAa,IAAC;KACf,CAAC;IAAE,gBAAkB,SAAC,EAAA,CAAA;IAAA,gBAAA,gBAAA;KACrB,UAAM;KACN,SAAM;KACN,MAAM;KACN,KAAK;KACL,aAAM,IAAA;KACP,CAAC;IAAE,gBAAI,SAAkB,EAAA,CAAA;IAAA,gBAAA,MAAA;KACxB,IAAE,OAAI;AACJ,aAAI,QAAA,SAAoB;;KAEpB;KACP,CAAC;IAAC;;EAEN,CAAC,CAAC"}
|
package/dist/index.cjs
CHANGED
|
@@ -137,10 +137,13 @@ const plugin = (options = {}) => {
|
|
|
137
137
|
}
|
|
138
138
|
},
|
|
139
139
|
async prepare() {
|
|
140
|
+
const _self$ = this;
|
|
140
141
|
this.debug(`Preparing the Environment runtime artifacts for the Powerlines project.`);
|
|
141
142
|
const result = await require_helpers_persistence.readEnvTypeReflection(this, "env");
|
|
142
|
-
return (0, _powerlines_plugin_alloy_render.render)(this,
|
|
143
|
-
defaultConfig
|
|
143
|
+
return (0, _powerlines_plugin_alloy_render.render)(this, (0, _alloy_js_core_jsx_runtime.createComponent)(require_components_env_builtin.EnvBuiltin, {
|
|
144
|
+
get defaultConfig() {
|
|
145
|
+
return _self$.config.env.defaultConfig;
|
|
146
|
+
},
|
|
144
147
|
reflection: result
|
|
145
148
|
}));
|
|
146
149
|
},
|
|
@@ -160,7 +163,7 @@ const plugin = (options = {}) => {
|
|
|
160
163
|
async docs() {
|
|
161
164
|
this.debug(`Documenting environment variables configuration values in "${(0, _stryke_path_join.joinPaths)(require_helpers_docs_helper.getDocsOutputPath(this), "env.md")}"`);
|
|
162
165
|
const result = await require_helpers_persistence.readEnvTypeReflection(this, "env");
|
|
163
|
-
return (0, _powerlines_plugin_alloy_render.render)(this,
|
|
166
|
+
return (0, _powerlines_plugin_alloy_render.render)(this, (0, _alloy_js_core_jsx_runtime.createComponent)(require_components_docs.EnvDocsFile, {
|
|
164
167
|
levelOffset: 0,
|
|
165
168
|
reflection: result
|
|
166
169
|
}));
|
package/dist/index.mjs
CHANGED
|
@@ -10,7 +10,7 @@ import { ReflectionClass, ReflectionKind } from "@powerlines/deepkit/vendor/type
|
|
|
10
10
|
import { ENV_PREFIXES } from "@stryke/env/types";
|
|
11
11
|
import defu from "defu";
|
|
12
12
|
import { joinPaths } from "@stryke/path/join";
|
|
13
|
-
import {
|
|
13
|
+
import { createComponent } from "@alloy-js/core/jsx-runtime";
|
|
14
14
|
import alloy from "@powerlines/plugin-alloy";
|
|
15
15
|
import { render } from "@powerlines/plugin-alloy/render";
|
|
16
16
|
import automd from "@powerlines/plugin-automd";
|
|
@@ -131,10 +131,13 @@ const plugin = (options = {}) => {
|
|
|
131
131
|
}
|
|
132
132
|
},
|
|
133
133
|
async prepare() {
|
|
134
|
+
const _self$ = this;
|
|
134
135
|
this.debug(`Preparing the Environment runtime artifacts for the Powerlines project.`);
|
|
135
136
|
const result = await readEnvTypeReflection(this, "env");
|
|
136
|
-
return render(this,
|
|
137
|
-
defaultConfig
|
|
137
|
+
return render(this, createComponent(EnvBuiltin, {
|
|
138
|
+
get defaultConfig() {
|
|
139
|
+
return _self$.config.env.defaultConfig;
|
|
140
|
+
},
|
|
138
141
|
reflection: result
|
|
139
142
|
}));
|
|
140
143
|
},
|
|
@@ -154,7 +157,7 @@ const plugin = (options = {}) => {
|
|
|
154
157
|
async docs() {
|
|
155
158
|
this.debug(`Documenting environment variables configuration values in "${joinPaths(getDocsOutputPath(this), "env.md")}"`);
|
|
156
159
|
const result = await readEnvTypeReflection(this, "env");
|
|
157
|
-
return render(this,
|
|
160
|
+
return render(this, createComponent(EnvDocsFile, {
|
|
158
161
|
levelOffset: 0,
|
|
159
162
|
reflection: result
|
|
160
163
|
}));
|
package/dist/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.tsx"],"sourcesContent":["/* -------------------------------------------------------------------\n\n ⚡ Storm Software - Powerlines\n\n This code was released as part of the Powerlines project. Powerlines\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/powerlines.\n\n Website: https://stormsoftware.com\n Repository: https://github.com/storm-software/powerlines\n Documentation: https://docs.stormsoftware.com/projects/powerlines\n Contact: https://stormsoftware.com/contact\n\n SPDX-License-Identifier: Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport {\n ReflectionClass,\n ReflectionKind\n} from \"@powerlines/deepkit/vendor/type\";\nimport alloy from \"@powerlines/plugin-alloy\";\nimport { render } from \"@powerlines/plugin-alloy/render\";\nimport automd from \"@powerlines/plugin-automd\";\nimport babel from \"@powerlines/plugin-babel\";\nimport { parseTypeDefinition } from \"@stryke/convert/parse-type-definition\";\nimport { toArray } from \"@stryke/convert/to-array\";\nimport { ENV_PREFIXES } from \"@stryke/env/types\";\nimport { existsSync } from \"@stryke/fs/exists\";\nimport { joinPaths } from \"@stryke/path/join\";\nimport { constantCase } from \"@stryke/string-format/constant-case\";\nimport { isSetString } from \"@stryke/type-checks/is-set-string\";\nimport {\n TypeDefinition,\n TypeDefinitionParameter\n} from \"@stryke/types/configuration\";\nimport defu from \"defu\";\nimport { Plugin } from \"powerlines\";\nimport type { UserConfig as ViteUserConfig } from \"vite\";\nimport { envBabelPlugin } from \"./babel/plugin\";\nimport { EnvDocsFile } from \"./components/docs\";\nimport { EnvBuiltin } from \"./components/env-builtin\";\nimport { env } from \"./helpers/automd-generator\";\nimport { getDocsOutputPath } from \"./helpers/docs-helper\";\nimport { loadEnv } from \"./helpers/load\";\nimport {\n getEnvDefaultTypeDefinition,\n getEnvReflectionsPath,\n getEnvTypeReflectionsPath,\n getSecretsDefaultTypeDefinition,\n readEnvReflection,\n readEnvTypeReflection,\n readSecretsReflection,\n writeEnvReflection,\n writeEnvTypeReflection\n} from \"./helpers/persistence\";\nimport { reflectEnv, reflectSecrets } from \"./helpers/reflect\";\nimport { EnvPluginContext, EnvPluginOptions } from \"./types/plugin\";\n\nexport type * from \"./types\";\n\ndeclare module \"powerlines\" {\n interface Config {\n env?: EnvPluginOptions;\n }\n}\n\n/**\n * A Powerlines plugin to inject environment variables into the source code.\n */\nexport const plugin = <TContext extends EnvPluginContext = EnvPluginContext>(\n options: EnvPluginOptions = {}\n) => {\n return [\n alloy(options.alloy),\n babel(options.babel),\n {\n name: \"env\",\n async config() {\n this.debug(\n \"Providing default configuration for the Powerlines `env` build plugin.\"\n );\n\n const config = {\n env: defu(options, {\n types: {} as TypeDefinitionParameter,\n validate: false,\n inject: false,\n prefix: []\n }),\n transform: {\n babel: {\n plugins: [envBabelPlugin]\n }\n }\n };\n\n if (\n isSetString(config.env.types) ||\n (config.env.types && isSetString(config.env.types.file))\n ) {\n config.env.types = parseTypeDefinition(\n config.env.types\n ) as TypeDefinition;\n\n const file = await this.fs.resolve(config.env.types.file);\n if (file) {\n config.env.types.file = file;\n }\n } else {\n this.warn(\n \"The `env.types` configuration parameter was not provided. Please ensure this is expected.\"\n );\n\n const envDefaultTypeDefinition =\n await getEnvDefaultTypeDefinition(this);\n\n const file = await this.fs.resolve(envDefaultTypeDefinition.file);\n if (file) {\n config.env.types = parseTypeDefinition(\n `${file}#${envDefaultTypeDefinition.name}`\n ) as TypeDefinition;\n }\n }\n\n if (\n isSetString(config.env.secrets) ||\n (config.env.secrets && isSetString(config.env.secrets.file))\n ) {\n config.env.secrets = parseTypeDefinition(\n config.env.secrets\n ) as TypeDefinition;\n\n const file = await this.fs.resolve(config.env.secrets.file);\n if (file) {\n config.env.secrets.file = file;\n }\n } else {\n const secretsDefaultTypeDefinition =\n await getSecretsDefaultTypeDefinition(this);\n\n const file = await this.fs.resolve(secretsDefaultTypeDefinition.file);\n if (file) {\n config.env.secrets = parseTypeDefinition(\n `${file}#${secretsDefaultTypeDefinition.name}`\n ) as TypeDefinition;\n }\n }\n\n config.env.prefix = toArray(\n (config.env.prefix ?? []) as string[]\n ).reduce(\n (ret: string[], prefix: string) => {\n const formattedPrefix = constantCase(prefix);\n if (!ret.includes(formattedPrefix)) {\n ret.push(formattedPrefix);\n }\n\n return ret;\n },\n [\n ...ENV_PREFIXES,\n \"POWERLINES_\",\n this.config.framework &&\n this.config.framework !== \"powerlines\" &&\n `${constantCase(this.config.framework)}_`\n ].filter(Boolean) as string[]\n );\n\n config.env.prefix = toArray(config.env.prefix).reduce((ret, prefix) => {\n if (!ret.includes(prefix.replace(/_$/g, \"\"))) {\n ret.push(prefix.replace(/_$/g, \"\"));\n }\n return ret;\n }, [] as string[]);\n\n return config;\n },\n async configResolved() {\n this.debug(\n `Environment plugin configuration has been resolved for the Powerlines project.`\n );\n\n this.env = defu(\n {\n parsed: await loadEnv(this, this.config.env)\n },\n this.env ?? {},\n {\n types: {\n env: {}\n },\n used: {\n env: {},\n secrets: {}\n },\n parsed: {},\n injected: {}\n }\n ) as EnvPluginContext[\"env\"];\n\n if (\n this.config.command !== \"prepare\" &&\n !this.config.skipCache &&\n this.persistedMeta?.checksum === this.meta.checksum &&\n existsSync(getEnvTypeReflectionsPath(this, \"env\"))\n ) {\n this.debug(\n `Skipping reflection initialization as the meta checksum has not changed.`\n );\n\n this.env.types.env = await readEnvTypeReflection(this, \"env\");\n\n if (existsSync(getEnvReflectionsPath(this, \"env\"))) {\n this.env.used.env = await readEnvReflection(this);\n }\n\n if (existsSync(getEnvTypeReflectionsPath(this, \"secrets\"))) {\n this.env.types.secrets = await readEnvTypeReflection(\n this,\n \"secrets\"\n );\n }\n\n if (existsSync(getEnvReflectionsPath(this, \"secrets\"))) {\n this.env.used.secrets = await readSecretsReflection(this);\n }\n } else {\n this.debug(\n `Starting environment configuration reflection initialization.`\n );\n\n this.env.types.env = await reflectEnv(\n this,\n this.config.env.types?.file,\n this.config.env.types?.name\n );\n if (!this.env.types.env) {\n throw new Error(\n \"Failed to find the environment configuration type reflection in the context.\"\n );\n }\n\n await writeEnvTypeReflection(this, this.env.types.env, \"env\");\n\n this.env.types.secrets = await reflectSecrets(\n this,\n this.config.env.secrets?.file,\n this.config.env.secrets?.name\n );\n if (!this.env.types.secrets) {\n throw new Error(\n \"Failed to find the secrets configuration type reflection in the context.\"\n );\n }\n\n await writeEnvTypeReflection(this, this.env.types.secrets, \"secrets\");\n\n this.debug(\n `Resolved ${\n this.env.types.env.getProperties().length ?? 0\n } environment configuration parameters and ${\n this.env.types.secrets?.getProperties().length ?? 0\n } secret configuration parameters`\n );\n\n const envWithAlias = this.env.types.env\n .getProperties()\n .filter(prop => prop.getAlias().length > 0);\n\n Object.entries(await loadEnv(this, this.config.env)).forEach(\n ([key, value]) => {\n const unprefixedKey = this.config.env.prefix.reduce(\n (ret, prefix) => {\n if (key.replace(/_$/g, \"\").startsWith(prefix)) {\n return key.replace(/_$/g, \"\").slice(prefix.length);\n }\n return ret;\n },\n key\n );\n\n const aliasKey = envWithAlias.find(prop =>\n prop?.getAlias().reverse().includes(unprefixedKey)\n );\n if (this.env.types.env?.hasProperty(unprefixedKey) || aliasKey) {\n this.env.types.env\n .getProperty(unprefixedKey)\n .setDefaultValue(value);\n }\n }\n );\n\n this.env.used.env = new ReflectionClass(\n {\n kind: ReflectionKind.objectLiteral,\n typeName: \"Env\",\n description: `An object containing the environment configuration parameters used by the ${\n this.config.name\n ? `${this.config.name} application`\n : \"application\"\n }.`,\n types: []\n },\n this.env.types.env\n );\n\n await writeEnvReflection(this, this.env.used.env, \"env\");\n\n if (this.env.types.secrets) {\n await writeEnvTypeReflection(\n this,\n this.env.types.secrets,\n \"secrets\"\n );\n\n this.env.used.secrets = new ReflectionClass(\n {\n kind: ReflectionKind.objectLiteral,\n typeName: \"Secrets\",\n description: `An object containing the secret configuration parameters used by the ${\n this.config.name\n ? `${this.config.name} application`\n : \"application\"\n }.`,\n types: []\n },\n this.env.types.secrets\n );\n await writeEnvReflection(this, this.env.used.secrets, \"secrets\");\n }\n }\n },\n async prepare() {\n this.debug(\n `Preparing the Environment runtime artifacts for the Powerlines project.`\n );\n\n const result = await readEnvTypeReflection(this, \"env\");\n\n return render(\n this,\n <EnvBuiltin\n defaultConfig={this.config.env.defaultConfig}\n reflection={result}\n />\n );\n },\n transform: {\n order: \"post\",\n async handler() {\n if (this.env.used.env.getProperties().length > 0) {\n this.trace(\n `Persisting used environment configuration reflections to ${getEnvReflectionsPath(\n this,\n \"env\"\n )}.`\n );\n await writeEnvReflection(this, this.env.used.env, \"env\");\n }\n\n if (this.env.used.secrets.getProperties().length > 0) {\n this.trace(\n `Persisting used secret configuration reflections to ${getEnvReflectionsPath(\n this,\n \"secrets\"\n )}.`\n );\n await writeEnvReflection(this, this.env.used.secrets, \"secrets\");\n }\n }\n },\n async docs() {\n this.debug(\n `Documenting environment variables configuration values in \"${joinPaths(\n getDocsOutputPath(this),\n \"env.md\"\n )}\"`\n );\n\n const result = await readEnvTypeReflection(this, \"env\");\n\n return render(\n this,\n <EnvDocsFile levelOffset={0} reflection={result} />\n );\n },\n async buildEnd() {\n const reflectionPath = getEnvReflectionsPath(this, \"env\");\n\n this.debug(`Writing env reflection types to ${reflectionPath}.`);\n\n await writeEnvReflection(this, this.env.used.env, \"env\");\n }\n },\n {\n name: \"env:automd-generator\",\n config() {\n return {\n automd: defu(options.automd ?? {}, {\n generators: {\n env: env(this)\n }\n })\n };\n }\n },\n {\n name: \"env:vite\",\n vite: {\n configResolved(this: TContext) {\n return {\n envPrefix: this.config?.env?.prefix\n } as ViteUserConfig;\n }\n }\n },\n automd(options.automd)\n ] as Plugin<TContext>[];\n};\n\nexport default plugin;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAuEA,MAAa,UACX,UAA4B,EAAE,KAC3B;AACH,QAAO;EACL,MAAM,QAAQ,MAAM;EACpB,MAAM,QAAQ,MAAM;EACpB;GACE,MAAM;GACN,MAAM,SAAS;AACb,SAAK,MACH,yEACD;IAED,MAAM,SAAS;KACb,KAAK,KAAK,SAAS;MACjB,OAAO,EAAE;MACT,UAAU;MACV,QAAQ;MACR,QAAQ,EAAE;MACX,CAAC;KACF,WAAW,EACT,OAAO,EACL,SAAS,CAAC,eAAe,EAC1B,EACF;KACF;AAED,QACE,YAAY,OAAO,IAAI,MAAM,IAC5B,OAAO,IAAI,SAAS,YAAY,OAAO,IAAI,MAAM,KAAK,EACvD;AACA,YAAO,IAAI,QAAQ,oBACjB,OAAO,IAAI,MACZ;KAED,MAAM,OAAO,MAAM,KAAK,GAAG,QAAQ,OAAO,IAAI,MAAM,KAAK;AACzD,SAAI,KACF,QAAO,IAAI,MAAM,OAAO;WAErB;AACL,UAAK,KACH,4FACD;KAED,MAAM,2BACJ,MAAM,4BAA4B,KAAK;KAEzC,MAAM,OAAO,MAAM,KAAK,GAAG,QAAQ,yBAAyB,KAAK;AACjE,SAAI,KACF,QAAO,IAAI,QAAQ,oBACjB,GAAG,KAAK,GAAG,yBAAyB,OACrC;;AAIL,QACE,YAAY,OAAO,IAAI,QAAQ,IAC9B,OAAO,IAAI,WAAW,YAAY,OAAO,IAAI,QAAQ,KAAK,EAC3D;AACA,YAAO,IAAI,UAAU,oBACnB,OAAO,IAAI,QACZ;KAED,MAAM,OAAO,MAAM,KAAK,GAAG,QAAQ,OAAO,IAAI,QAAQ,KAAK;AAC3D,SAAI,KACF,QAAO,IAAI,QAAQ,OAAO;WAEvB;KACL,MAAM,+BACJ,MAAM,gCAAgC,KAAK;KAE7C,MAAM,OAAO,MAAM,KAAK,GAAG,QAAQ,6BAA6B,KAAK;AACrE,SAAI,KACF,QAAO,IAAI,UAAU,oBACnB,GAAG,KAAK,GAAG,6BAA6B,OACzC;;AAIL,WAAO,IAAI,SAAS,QACjB,OAAO,IAAI,UAAU,EAAE,CACzB,CAAC,QACC,KAAe,WAAmB;KACjC,MAAM,kBAAkB,aAAa,OAAO;AAC5C,SAAI,CAAC,IAAI,SAAS,gBAAgB,CAChC,KAAI,KAAK,gBAAgB;AAG3B,YAAO;OAET;KACE,GAAG;KACH;KACA,KAAK,OAAO,aACV,KAAK,OAAO,cAAc,gBAC1B,GAAG,aAAa,KAAK,OAAO,UAAU,CAAC;KAC1C,CAAC,OAAO,QAAQ,CAClB;AAED,WAAO,IAAI,SAAS,QAAQ,OAAO,IAAI,OAAO,CAAC,QAAQ,KAAK,WAAW;AACrE,SAAI,CAAC,IAAI,SAAS,OAAO,QAAQ,OAAO,GAAG,CAAC,CAC1C,KAAI,KAAK,OAAO,QAAQ,OAAO,GAAG,CAAC;AAErC,YAAO;OACN,EAAE,CAAa;AAElB,WAAO;;GAET,MAAM,iBAAiB;AACrB,SAAK,MACH,iFACD;AAED,SAAK,MAAM,KACT,EACE,QAAQ,MAAM,QAAQ,MAAM,KAAK,OAAO,IAAI,EAC7C,EACD,KAAK,OAAO,EAAE,EACd;KACE,OAAO,EACL,KAAK,EAAE,EACR;KACD,MAAM;MACJ,KAAK,EAAE;MACP,SAAS,EAAE;MACZ;KACD,QAAQ,EAAE;KACV,UAAU,EAAE;KACb,CACF;AAED,QACE,KAAK,OAAO,YAAY,aACxB,CAAC,KAAK,OAAO,aACb,KAAK,eAAe,aAAa,KAAK,KAAK,YAC3C,WAAW,0BAA0B,MAAM,MAAM,CAAC,EAClD;AACA,UAAK,MACH,2EACD;AAED,UAAK,IAAI,MAAM,MAAM,MAAM,sBAAsB,MAAM,MAAM;AAE7D,SAAI,WAAW,sBAAsB,MAAM,MAAM,CAAC,CAChD,MAAK,IAAI,KAAK,MAAM,MAAM,kBAAkB,KAAK;AAGnD,SAAI,WAAW,0BAA0B,MAAM,UAAU,CAAC,CACxD,MAAK,IAAI,MAAM,UAAU,MAAM,sBAC7B,MACA,UACD;AAGH,SAAI,WAAW,sBAAsB,MAAM,UAAU,CAAC,CACpD,MAAK,IAAI,KAAK,UAAU,MAAM,sBAAsB,KAAK;WAEtD;AACL,UAAK,MACH,gEACD;AAED,UAAK,IAAI,MAAM,MAAM,MAAM,WACzB,MACA,KAAK,OAAO,IAAI,OAAO,MACvB,KAAK,OAAO,IAAI,OAAO,KACxB;AACD,SAAI,CAAC,KAAK,IAAI,MAAM,IAClB,OAAM,IAAI,MACR,+EACD;AAGH,WAAM,uBAAuB,MAAM,KAAK,IAAI,MAAM,KAAK,MAAM;AAE7D,UAAK,IAAI,MAAM,UAAU,MAAM,eAC7B,MACA,KAAK,OAAO,IAAI,SAAS,MACzB,KAAK,OAAO,IAAI,SAAS,KAC1B;AACD,SAAI,CAAC,KAAK,IAAI,MAAM,QAClB,OAAM,IAAI,MACR,2EACD;AAGH,WAAM,uBAAuB,MAAM,KAAK,IAAI,MAAM,SAAS,UAAU;AAErE,UAAK,MACH,YACE,KAAK,IAAI,MAAM,IAAI,eAAe,CAAC,UAAU,EAC9C,4CACC,KAAK,IAAI,MAAM,SAAS,eAAe,CAAC,UAAU,EACnD,kCACF;KAED,MAAM,eAAe,KAAK,IAAI,MAAM,IACjC,eAAe,CACf,QAAO,SAAQ,KAAK,UAAU,CAAC,SAAS,EAAE;AAE7C,YAAO,QAAQ,MAAM,QAAQ,MAAM,KAAK,OAAO,IAAI,CAAC,CAAC,SAClD,CAAC,KAAK,WAAW;MAChB,MAAM,gBAAgB,KAAK,OAAO,IAAI,OAAO,QAC1C,KAAK,WAAW;AACf,WAAI,IAAI,QAAQ,OAAO,GAAG,CAAC,WAAW,OAAO,CAC3C,QAAO,IAAI,QAAQ,OAAO,GAAG,CAAC,MAAM,OAAO,OAAO;AAEpD,cAAO;SAET,IACD;MAED,MAAM,WAAW,aAAa,MAAK,SACjC,MAAM,UAAU,CAAC,SAAS,CAAC,SAAS,cAAc,CACnD;AACD,UAAI,KAAK,IAAI,MAAM,KAAK,YAAY,cAAc,IAAI,SACpD,MAAK,IAAI,MAAM,IACZ,YAAY,cAAc,CAC1B,gBAAgB,MAAM;OAG9B;AAED,UAAK,IAAI,KAAK,MAAM,IAAI,gBACtB;MACE,MAAM,eAAe;MACrB,UAAU;MACV,aAAa,6EACX,KAAK,OAAO,OACR,GAAG,KAAK,OAAO,KAAK,gBACpB,cACL;MACD,OAAO,EAAE;MACV,EACD,KAAK,IAAI,MAAM,IAChB;AAED,WAAM,mBAAmB,MAAM,KAAK,IAAI,KAAK,KAAK,MAAM;AAExD,SAAI,KAAK,IAAI,MAAM,SAAS;AAC1B,YAAM,uBACJ,MACA,KAAK,IAAI,MAAM,SACf,UACD;AAED,WAAK,IAAI,KAAK,UAAU,IAAI,gBAC1B;OACE,MAAM,eAAe;OACrB,UAAU;OACV,aAAa,wEACX,KAAK,OAAO,OACR,GAAG,KAAK,OAAO,KAAK,gBACpB,cACL;OACD,OAAO,EAAE;OACV,EACD,KAAK,IAAI,MAAM,QAChB;AACD,YAAM,mBAAmB,MAAM,KAAK,IAAI,KAAK,SAAS,UAAU;;;;GAItE,MAAM,UAAU;AACd,SAAK,MACH,0EACD;IAED,MAAM,SAAS,MAAM,sBAAsB,MAAM,MAAM;AAEvD,WAAO,OACL,MACA,oBAAC,YAAD;KACE,eAAe,KAAK,OAAO,IAAI;KAC/B,YAAY;KACZ,EACH;;GAEH,WAAW;IACT,OAAO;IACP,MAAM,UAAU;AACd,SAAI,KAAK,IAAI,KAAK,IAAI,eAAe,CAAC,SAAS,GAAG;AAChD,WAAK,MACH,4DAA4D,sBAC1D,MACA,MACD,CAAC,GACH;AACD,YAAM,mBAAmB,MAAM,KAAK,IAAI,KAAK,KAAK,MAAM;;AAG1D,SAAI,KAAK,IAAI,KAAK,QAAQ,eAAe,CAAC,SAAS,GAAG;AACpD,WAAK,MACH,uDAAuD,sBACrD,MACA,UACD,CAAC,GACH;AACD,YAAM,mBAAmB,MAAM,KAAK,IAAI,KAAK,SAAS,UAAU;;;IAGrE;GACD,MAAM,OAAO;AACX,SAAK,MACH,8DAA8D,UAC5D,kBAAkB,KAAK,EACvB,SACD,CAAC,GACH;IAED,MAAM,SAAS,MAAM,sBAAsB,MAAM,MAAM;AAEvD,WAAO,OACL,MACA,oBAAC,aAAD;KAAa,aAAa;KAAG,YAAY;KAAU,EACpD;;GAEH,MAAM,WAAW;IACf,MAAM,iBAAiB,sBAAsB,MAAM,MAAM;AAEzD,SAAK,MAAM,mCAAmC,eAAe,GAAG;AAEhE,UAAM,mBAAmB,MAAM,KAAK,IAAI,KAAK,KAAK,MAAM;;GAE3D;EACD;GACE,MAAM;GACN,SAAS;AACP,WAAO,EACL,QAAQ,KAAK,QAAQ,UAAU,EAAE,EAAE,EACjC,YAAY,EACV,KAAK,IAAI,KAAK,EACf,EACF,CAAC,EACH;;GAEJ;EACD;GACE,MAAM;GACN,MAAM,EACJ,iBAA+B;AAC7B,WAAO,EACL,WAAW,KAAK,QAAQ,KAAK,QAC9B;MAEJ;GACF;EACD,OAAO,QAAQ,OAAO;EACvB"}
|
|
1
|
+
{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.tsx"],"sourcesContent":["/* -------------------------------------------------------------------\n\n ⚡ Storm Software - Powerlines\n\n This code was released as part of the Powerlines project. Powerlines\n is maintained by Storm Software under the Apache-2.0 license, and is\n free for commercial and private use. For more information, please visit\n our licensing page at https://stormsoftware.com/licenses/projects/powerlines.\n\n Website: https://stormsoftware.com\n Repository: https://github.com/storm-software/powerlines\n Documentation: https://docs.stormsoftware.com/projects/powerlines\n Contact: https://stormsoftware.com/contact\n\n SPDX-License-Identifier: Apache-2.0\n\n ------------------------------------------------------------------- */\n\nimport {\n ReflectionClass,\n ReflectionKind\n} from \"@powerlines/deepkit/vendor/type\";\nimport alloy from \"@powerlines/plugin-alloy\";\nimport { render } from \"@powerlines/plugin-alloy/render\";\nimport automd from \"@powerlines/plugin-automd\";\nimport babel from \"@powerlines/plugin-babel\";\nimport { parseTypeDefinition } from \"@stryke/convert/parse-type-definition\";\nimport { toArray } from \"@stryke/convert/to-array\";\nimport { ENV_PREFIXES } from \"@stryke/env/types\";\nimport { existsSync } from \"@stryke/fs/exists\";\nimport { joinPaths } from \"@stryke/path/join\";\nimport { constantCase } from \"@stryke/string-format/constant-case\";\nimport { isSetString } from \"@stryke/type-checks/is-set-string\";\nimport {\n TypeDefinition,\n TypeDefinitionParameter\n} from \"@stryke/types/configuration\";\nimport defu from \"defu\";\nimport { Plugin } from \"powerlines\";\nimport type { UserConfig as ViteUserConfig } from \"vite\";\nimport { envBabelPlugin } from \"./babel/plugin\";\nimport { EnvDocsFile } from \"./components/docs\";\nimport { EnvBuiltin } from \"./components/env-builtin\";\nimport { env } from \"./helpers/automd-generator\";\nimport { getDocsOutputPath } from \"./helpers/docs-helper\";\nimport { loadEnv } from \"./helpers/load\";\nimport {\n getEnvDefaultTypeDefinition,\n getEnvReflectionsPath,\n getEnvTypeReflectionsPath,\n getSecretsDefaultTypeDefinition,\n readEnvReflection,\n readEnvTypeReflection,\n readSecretsReflection,\n writeEnvReflection,\n writeEnvTypeReflection\n} from \"./helpers/persistence\";\nimport { reflectEnv, reflectSecrets } from \"./helpers/reflect\";\nimport { EnvPluginContext, EnvPluginOptions } from \"./types/plugin\";\n\nexport type * from \"./types\";\n\ndeclare module \"powerlines\" {\n interface Config {\n env?: EnvPluginOptions;\n }\n}\n\n/**\n * A Powerlines plugin to inject environment variables into the source code.\n */\nexport const plugin = <TContext extends EnvPluginContext = EnvPluginContext>(\n options: EnvPluginOptions = {}\n) => {\n return [\n alloy(options.alloy),\n babel(options.babel),\n {\n name: \"env\",\n async config() {\n this.debug(\n \"Providing default configuration for the Powerlines `env` build plugin.\"\n );\n\n const config = {\n env: defu(options, {\n types: {} as TypeDefinitionParameter,\n validate: false,\n inject: false,\n prefix: []\n }),\n transform: {\n babel: {\n plugins: [envBabelPlugin]\n }\n }\n };\n\n if (\n isSetString(config.env.types) ||\n (config.env.types && isSetString(config.env.types.file))\n ) {\n config.env.types = parseTypeDefinition(\n config.env.types\n ) as TypeDefinition;\n\n const file = await this.fs.resolve(config.env.types.file);\n if (file) {\n config.env.types.file = file;\n }\n } else {\n this.warn(\n \"The `env.types` configuration parameter was not provided. Please ensure this is expected.\"\n );\n\n const envDefaultTypeDefinition =\n await getEnvDefaultTypeDefinition(this);\n\n const file = await this.fs.resolve(envDefaultTypeDefinition.file);\n if (file) {\n config.env.types = parseTypeDefinition(\n `${file}#${envDefaultTypeDefinition.name}`\n ) as TypeDefinition;\n }\n }\n\n if (\n isSetString(config.env.secrets) ||\n (config.env.secrets && isSetString(config.env.secrets.file))\n ) {\n config.env.secrets = parseTypeDefinition(\n config.env.secrets\n ) as TypeDefinition;\n\n const file = await this.fs.resolve(config.env.secrets.file);\n if (file) {\n config.env.secrets.file = file;\n }\n } else {\n const secretsDefaultTypeDefinition =\n await getSecretsDefaultTypeDefinition(this);\n\n const file = await this.fs.resolve(secretsDefaultTypeDefinition.file);\n if (file) {\n config.env.secrets = parseTypeDefinition(\n `${file}#${secretsDefaultTypeDefinition.name}`\n ) as TypeDefinition;\n }\n }\n\n config.env.prefix = toArray(\n (config.env.prefix ?? []) as string[]\n ).reduce(\n (ret: string[], prefix: string) => {\n const formattedPrefix = constantCase(prefix);\n if (!ret.includes(formattedPrefix)) {\n ret.push(formattedPrefix);\n }\n\n return ret;\n },\n [\n ...ENV_PREFIXES,\n \"POWERLINES_\",\n this.config.framework &&\n this.config.framework !== \"powerlines\" &&\n `${constantCase(this.config.framework)}_`\n ].filter(Boolean) as string[]\n );\n\n config.env.prefix = toArray(config.env.prefix).reduce((ret, prefix) => {\n if (!ret.includes(prefix.replace(/_$/g, \"\"))) {\n ret.push(prefix.replace(/_$/g, \"\"));\n }\n return ret;\n }, [] as string[]);\n\n return config;\n },\n async configResolved() {\n this.debug(\n `Environment plugin configuration has been resolved for the Powerlines project.`\n );\n\n this.env = defu(\n {\n parsed: await loadEnv(this, this.config.env)\n },\n this.env ?? {},\n {\n types: {\n env: {}\n },\n used: {\n env: {},\n secrets: {}\n },\n parsed: {},\n injected: {}\n }\n ) as EnvPluginContext[\"env\"];\n\n if (\n this.config.command !== \"prepare\" &&\n !this.config.skipCache &&\n this.persistedMeta?.checksum === this.meta.checksum &&\n existsSync(getEnvTypeReflectionsPath(this, \"env\"))\n ) {\n this.debug(\n `Skipping reflection initialization as the meta checksum has not changed.`\n );\n\n this.env.types.env = await readEnvTypeReflection(this, \"env\");\n\n if (existsSync(getEnvReflectionsPath(this, \"env\"))) {\n this.env.used.env = await readEnvReflection(this);\n }\n\n if (existsSync(getEnvTypeReflectionsPath(this, \"secrets\"))) {\n this.env.types.secrets = await readEnvTypeReflection(\n this,\n \"secrets\"\n );\n }\n\n if (existsSync(getEnvReflectionsPath(this, \"secrets\"))) {\n this.env.used.secrets = await readSecretsReflection(this);\n }\n } else {\n this.debug(\n `Starting environment configuration reflection initialization.`\n );\n\n this.env.types.env = await reflectEnv(\n this,\n this.config.env.types?.file,\n this.config.env.types?.name\n );\n if (!this.env.types.env) {\n throw new Error(\n \"Failed to find the environment configuration type reflection in the context.\"\n );\n }\n\n await writeEnvTypeReflection(this, this.env.types.env, \"env\");\n\n this.env.types.secrets = await reflectSecrets(\n this,\n this.config.env.secrets?.file,\n this.config.env.secrets?.name\n );\n if (!this.env.types.secrets) {\n throw new Error(\n \"Failed to find the secrets configuration type reflection in the context.\"\n );\n }\n\n await writeEnvTypeReflection(this, this.env.types.secrets, \"secrets\");\n\n this.debug(\n `Resolved ${\n this.env.types.env.getProperties().length ?? 0\n } environment configuration parameters and ${\n this.env.types.secrets?.getProperties().length ?? 0\n } secret configuration parameters`\n );\n\n const envWithAlias = this.env.types.env\n .getProperties()\n .filter(prop => prop.getAlias().length > 0);\n\n Object.entries(await loadEnv(this, this.config.env)).forEach(\n ([key, value]) => {\n const unprefixedKey = this.config.env.prefix.reduce(\n (ret, prefix) => {\n if (key.replace(/_$/g, \"\").startsWith(prefix)) {\n return key.replace(/_$/g, \"\").slice(prefix.length);\n }\n return ret;\n },\n key\n );\n\n const aliasKey = envWithAlias.find(prop =>\n prop?.getAlias().reverse().includes(unprefixedKey)\n );\n if (this.env.types.env?.hasProperty(unprefixedKey) || aliasKey) {\n this.env.types.env\n .getProperty(unprefixedKey)\n .setDefaultValue(value);\n }\n }\n );\n\n this.env.used.env = new ReflectionClass(\n {\n kind: ReflectionKind.objectLiteral,\n typeName: \"Env\",\n description: `An object containing the environment configuration parameters used by the ${\n this.config.name\n ? `${this.config.name} application`\n : \"application\"\n }.`,\n types: []\n },\n this.env.types.env\n );\n\n await writeEnvReflection(this, this.env.used.env, \"env\");\n\n if (this.env.types.secrets) {\n await writeEnvTypeReflection(\n this,\n this.env.types.secrets,\n \"secrets\"\n );\n\n this.env.used.secrets = new ReflectionClass(\n {\n kind: ReflectionKind.objectLiteral,\n typeName: \"Secrets\",\n description: `An object containing the secret configuration parameters used by the ${\n this.config.name\n ? `${this.config.name} application`\n : \"application\"\n }.`,\n types: []\n },\n this.env.types.secrets\n );\n await writeEnvReflection(this, this.env.used.secrets, \"secrets\");\n }\n }\n },\n async prepare() {\n this.debug(\n `Preparing the Environment runtime artifacts for the Powerlines project.`\n );\n\n const result = await readEnvTypeReflection(this, \"env\");\n\n return render(\n this,\n <EnvBuiltin\n defaultConfig={this.config.env.defaultConfig}\n reflection={result}\n />\n );\n },\n transform: {\n order: \"post\",\n async handler() {\n if (this.env.used.env.getProperties().length > 0) {\n this.trace(\n `Persisting used environment configuration reflections to ${getEnvReflectionsPath(\n this,\n \"env\"\n )}.`\n );\n await writeEnvReflection(this, this.env.used.env, \"env\");\n }\n\n if (this.env.used.secrets.getProperties().length > 0) {\n this.trace(\n `Persisting used secret configuration reflections to ${getEnvReflectionsPath(\n this,\n \"secrets\"\n )}.`\n );\n await writeEnvReflection(this, this.env.used.secrets, \"secrets\");\n }\n }\n },\n async docs() {\n this.debug(\n `Documenting environment variables configuration values in \"${joinPaths(\n getDocsOutputPath(this),\n \"env.md\"\n )}\"`\n );\n\n const result = await readEnvTypeReflection(this, \"env\");\n\n return render(\n this,\n <EnvDocsFile levelOffset={0} reflection={result} />\n );\n },\n async buildEnd() {\n const reflectionPath = getEnvReflectionsPath(this, \"env\");\n\n this.debug(`Writing env reflection types to ${reflectionPath}.`);\n\n await writeEnvReflection(this, this.env.used.env, \"env\");\n }\n },\n {\n name: \"env:automd-generator\",\n config() {\n return {\n automd: defu(options.automd ?? {}, {\n generators: {\n env: env(this)\n }\n })\n };\n }\n },\n {\n name: \"env:vite\",\n vite: {\n configResolved(this: TContext) {\n return {\n envPrefix: this.config?.env?.prefix\n } as ViteUserConfig;\n }\n }\n },\n automd(options.automd)\n ] as Plugin<TContext>[];\n};\n\nexport default plugin;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAsDA,MAAE,UAAkB,UAAA,EAAA,KAAA;AAClB,QAAA;EAAA,MAAA,QAAA,MAAA;EAAA,MAAA,QAAA,MAAA;EAAA;GACA,MAAQ;GACV,MAAS,SAAU;AACb,SAAG,MAAA,yEAA0D;;KAE5D,KAAM,KAAK,SAAS;;MAEnB,UAAQ;MACd,QAAgB;MACR,QAAA,EAAA;MACR,CAAA;KACF,WAAA,WAEE,SAAA,CAAA,eAAA,EACG,EACH;KACK;AACL,QAAQ,YAAC,OAAkB,IAAE,MAAA,IAAA,OAAA,IAAA,SAAA,YAAA,OAAA,IAAA,MAAA,KAAA,EAAA;AAC1B,YAAA,IAAA,QAAA,oBAAA,OAAA,IAAA,MAAA;KACG,MAAC,OAAA,MAAA,KAAA,GAAA,QAAA,OAAA,IAAA,MAAA,KAAA;AACL,SAAM,KACA,QAAO,IAAC,MAAM,OAAA;WAEX;AACP,UAAM,KAAM,4FAAG;KACb,MAAK,2BAAK,MAAA,4BAAA,KAAA;KACV,MAAG,OAAU,MAAA,KAAQ,GAAA,QAAc,yBAAyB,KAAK;AACjE,SAAC;;AAIH,QAAI,YAAY,OAAG,IAAA,QAAA,IAAA,OAAuB,IAAA,WAAA,YAAA,OAAA,IAAA,QAAA,KAAA,EAAA;AACxC,YAAI,IAAA,UAAe,oBAAA,OAAA,IAAA,QAAA;KACnB,MAAI,OAAQ,MAAK,KAAA,GAAA,QAAA,OAAA,IAAA,QAAA,KAAA;AACjB,SAAI,KACF,QAAE,IAAA,QAAA,OAAA;WAEA;KACJ,MAAM,+BAAwB,MAAA,gCAAA,KAAA;KAC9B,MAAI,OAAA,MAAA,KAAA,GAAA,QAAA,6BAAA,KAAA;AACJ,SAAE,KACD,QAAA,IAAA,UAAA,oBAAA,GAAA,KAAA,GAAA,6BAAA,OAAA;;AAGH,WAAI,IAAA,SAAY,QAAW,OAAQ,IAAA,UAAA,EAAA,CAAA,CAAA,QAAA,KAAA,WAAA;KACjC,MAAG,kBAAoB,aAAY,OAAO;AAC1C,SAAE,CAAA,IAAA,SAAA,gBAAA,CACA,KAAA,KAAO,gBAAY;AAErB,YAAO;;;;;;AAET,WAAI,IAAM,SAAO,QAAW,OAAG,IAAQ,OAAO,CAAA,QAAS,KAAK,WAAC;AAC3D,SAAI,CAAC,IAAC,SAAM,OAAA,QAAA,OAAA,GAAA,CAAA,CACV,KAAE,KAAO,OAAI,QAAW,OAAM,GAAA,CAAA;AAEhC,YAAO;OACN,EAAC,CAAS;AACb,WAAO;;;AAGP,SAAI,MAAM,iFAAyB;AACnC,SAAK,MAAM,KAAC,gDAEX,EAAE,KAAC,OAAW,EAAE,EAAA;KACf,OAAM,EACJ,KAAE,EAAA,EACH;KACD,MAAM;MACJ,KAAA,EAAA;MACF,SAAA,EAAA;;KAEA,QAAG,EAAA;KACH,UAAE,EAAA;KACH,CAAC;AACF,QAAI,KAAA,OAAA,YAAA,aAAA,CAAA,KAAA,OAAA,aAAA,KAAA,eAAA,aAAA,KAAA,KAAA,YAAA,WAAA,0BAAA,MAAA,MAAA,CAAA,EAAA;AACF,UAAE,MAAO,2EAAiC;AAC1C,UAAI,IAAA,MAAW,MAAA,MAAA,sBAAA,MAAA,MAAA;AACf,SAAI,WAAG,sBAAc,MAAA,MAAA,CAAA;AAGrB,SAAI,WAAQ,0BAAA,MAAA,UAAA,CAAA,CACV,MAAE,IAAO,MAAI,UAAY,MAAG,sBAAI,MAAA,UAAA;AAElC,SAAE,WAAK,sBAAA,MAAA,UAAA,CAAA,CACL,MAAK,IAAC,KAAA,UAAA,MAAA,sBAA6B,KAAA;;AAGrC,UAAE,MAAM,gEAA+D;AACvE,UAAK,IAAC,MAAM,MAAA,MAAA,WAAA,MAAA,KAAA,OAAA,IAAA,OAAA,MAAA,KAAA,OAAA,IAAA,OAAA,KAAA;AACZ,SAAI,CAAA,KAAM,IAAI,MAAC,IACb,OAAM,IAAC,MAAQ,+EAAkC;AAEnD,WAAE,uBAAA,MAAA,KAAA,IAAA,MAAA,KAAA,MAAA;AACF,UAAA,IAAA,MAAA,UAAA,MAAA,eAAA,MAAA,KAAA,OAAA,IAAA,SAAA,MAAA,KAAA,OAAA,IAAA,SAAA,KAAA;iCAEA,OAAO,IAAI,MAAO,2EAAS;AAE3B,WAAE,uBAAM,MAAA,KAAA,IAAA,MAAA,SAAA,UAAA;AACR,UAAG,MAAK,YAAU,KAAQ,IAAM,MAAK,IAAA,eAAA,CAAA,UAAA,EAAA,4CAAA,KAAA,IAAA,MAAA,SAAA,eAAA,CAAA,UAAA,EAAA,kCAAA;KACrC,MAAI,eAAM,KAAgB,IAAE,MAAA,IAAY,eAAQ,CAAA,QAAA,SAAA,KAAA,UAAA,CAAA,SAAA,EAAA;AAChD,YAAO,QAAM,MAAQ,QAAC,MAAA,KAAkB,OAAA,IAAA,CAAA,CAAA,SAAA,CAAA,KAAA,WAAA;MACtC,MAAI,gBAAS,KAAA,OAAgB,IAAA,OAAA,QAAA,KAAA,WAAA;AAC3B,WAAA,IAAA,QAAA,OAAA,GAAA,CAAA,WAAA,OAAA;AAGD,cAAA;SACD,IAAA;MACA,MAAK,WAAY,aAAA,MAAA,SAAA,MAAA,UAAA,CAAA,SAAA,CAAA,SAAA,cAAA,CAAA;AACjB,UAAG,KAAA,IAAA,MAAY,KAAA,YAAA,cAAA,IAAA,SACb,MAAK,IAAA,MAAO,IAAA,YAAW,cAAA,CAAA,gBAAA,MAAA;OAEzB;AACF,UAAI,IAAA,KAAO,MAAS,IAAG,gBAAO;MAC7B,MAAA,eAAA;;MAED,aAAW,6EAA4D,KAAA,OAAA,OAAA,GAAA,KAAA,OAAA,KAAA,gBAAA,cAAA;MACrE,OAAK,EAAI;MACV,EAAE,KAAK,IAAI,MAAC,IAAO;AACpB,WAAE,mBAAA,MAAA,KAAA,IAAA,KAAA,KAAA,MAAA;AACF,SAAE,KAAO,IAAG,MAAA,SAAA;AACV,YAAM,uBAAU,MAAA,KAAA,IAAA,MAAA,SAAA,UAAA;;OAElB,MAAO,eAAM;OACd,UAAA;OACK,aAAA,wEAAiB,KAAA,OAAA,OAAA,GAAA,KAAA,OAAA,KAAA,gBAAA,cAAA;OACjB,OAAM,EAAA;OACP,EAAA,KAAA,IAAW,MAAC,QAAO;AACrB,YAAA,mBAAA,MAAA,KAAA,IAAA,KAAA,SAAA,UAAA;;;;GAIL,MAAM,UAAU;IACd,MAAK,SAAA;AACL,SAAI,MAAK,0EAAS;IAClB,MAAI,SAAA,MAAA,sBAAA,MAAA,MAAA;AACJ,WAAM,OAAO,MAAA,gBAAA,YAAA;KACX,IAAI,gBAAQ;AACV,aAAG,OAAA,OAAA,IAAA;;KAEL,YAAY;KACb,CAAC,CAAC;;GAEL,WAAQ;IACN,OAAM;IACN,MAAI,UAAA;AACF,SAAI,KAAC,IAAA,KAAA,IAAiB,eAAM,CAAA,SAAA,GAAA;;AAE1B,YAAC,mBAAA,MAAA,KAAA,IAAA,KAAA,KAAA,MAAA;;AAEH,SAAG,KAAK,IAAA,KAAO,QAAW,eAAA,CAAA,SAAA,GAAA;AACxB,WAAK,MAAA,uDAAgD,sBAAA,MAAA,UAAA,CAAA,GAAA;AACrD,YAAA,mBAAW,MAAA,KAAyB,IAAC,KAAO,SAAK,UAAA;;;IAGtD;GACD,MAAM,OAAC;;IAEL,MAAI,SAAS,MAAM,sBAAY,MAAA,MAAsB;;KAEnD,aAAM;KACN,YAAY;KACb,CAAC,CAAC;;GAEL,MAAM,WAAI;IACR,MAAM,iBAAe,sBAAgB,MAAA,MAAA;AACrC,SAAK,MAAG,mCAAI,eAAA,GAAA;AACZ,UAAM,mBAAU,MAAA,KAAA,IAAA,KAAA,KAAA,MAAA;;GAEnB;EAAE;;GAED,SAAS;AACP,WAAM,EACJ,QAAE,KAAA,QAAA,UAAA,EAAA,EAAA,EACA,YAAK,EACL,KAAK,IAAK,KAAA,EACT,EACF,CAAC;;GAGP;EAAE;GACD,MAAM;GACN,MAAM,EACJ,iBAAK;AACH,WAAO,EACL,WAAW,KAAC,QAAK,KAAA,QAClB;MAEJ"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@powerlines/plugin-env",
|
|
3
|
-
"version": "0.16.
|
|
3
|
+
"version": "0.16.70",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "A package containing a Powerlines plugin for injecting static .env configuration values to the code so that they're accessible at runtime.",
|
|
6
6
|
"keywords": ["dotenv", "powerlines", "storm-software", "powerlines-plugin"],
|
|
@@ -306,31 +306,31 @@
|
|
|
306
306
|
"@alloy-js/typescript": "0.23.0-dev.4",
|
|
307
307
|
"@babel/core": "^7.29.0",
|
|
308
308
|
"@babel/types": "^7.29.0",
|
|
309
|
-
"@powerlines/plugin-alloy": "^0.25.
|
|
310
|
-
"@powerlines/plugin-automd": "^0.1.
|
|
311
|
-
"@powerlines/plugin-babel": "^0.12.
|
|
312
|
-
"@powerlines/plugin-plugin": "^0.12.
|
|
309
|
+
"@powerlines/plugin-alloy": "^0.25.35",
|
|
310
|
+
"@powerlines/plugin-automd": "^0.1.349",
|
|
311
|
+
"@powerlines/plugin-babel": "^0.12.352",
|
|
312
|
+
"@powerlines/plugin-plugin": "^0.12.300",
|
|
313
313
|
"@storm-software/config-tools": "1.189.28",
|
|
314
|
-
"@stryke/capnp": "^0.12.
|
|
315
|
-
"@stryke/convert": "^0.6.
|
|
316
|
-
"@stryke/env": "^0.20.
|
|
317
|
-
"@stryke/fs": "^0.33.
|
|
318
|
-
"@stryke/json": "^0.14.
|
|
319
|
-
"@stryke/path": "^0.
|
|
320
|
-
"@stryke/string-format": "^0.17.
|
|
321
|
-
"@stryke/type-checks": "^0.5.
|
|
322
|
-
"@stryke/types": "^0.10.
|
|
314
|
+
"@stryke/capnp": "^0.12.84",
|
|
315
|
+
"@stryke/convert": "^0.6.54",
|
|
316
|
+
"@stryke/env": "^0.20.75",
|
|
317
|
+
"@stryke/fs": "^0.33.58",
|
|
318
|
+
"@stryke/json": "^0.14.8",
|
|
319
|
+
"@stryke/path": "^0.27.0",
|
|
320
|
+
"@stryke/string-format": "^0.17.4",
|
|
321
|
+
"@stryke/type-checks": "^0.5.39",
|
|
322
|
+
"@stryke/types": "^0.10.53",
|
|
323
323
|
"automd": "^0.4.3",
|
|
324
324
|
"defu": "^6.1.4",
|
|
325
|
-
"powerlines": "^0.41.
|
|
325
|
+
"powerlines": "^0.41.14",
|
|
326
326
|
"c12": "^3.3.3"
|
|
327
327
|
},
|
|
328
328
|
"devDependencies": {
|
|
329
|
-
"@powerlines/deepkit": "^0.6.
|
|
330
|
-
"@powerlines/plugin-deepkit": "^0.11.
|
|
329
|
+
"@powerlines/deepkit": "^0.6.128",
|
|
330
|
+
"@powerlines/plugin-deepkit": "^0.11.228",
|
|
331
331
|
"@types/node": "^25.5.0",
|
|
332
332
|
"vite": "^8.0.0"
|
|
333
333
|
},
|
|
334
334
|
"publishConfig": { "access": "public" },
|
|
335
|
-
"gitHead": "
|
|
335
|
+
"gitHead": "9a873b7c4bc2a376b58e2721aa6211ca162c1f61"
|
|
336
336
|
}
|