wip:12 (h4980)

Author: adrians5j

extensions/MyApiKeyAfterUpdate.ts

@@ -1,18 +1,32 @@
-import { ApiKeyAfterUpdateHandler } from "webiny/api/security/features/UpdateApiKey";
-
+import { ApiKeyAfterUpdateHandler } from "webiny/api/security/apiKey";
 import { Logger } from "webiny/api/logger";
+import { BuildParams } from "webiny/api/buildParams";
 
 class MyApiKeyAfterUpdateImpl implements ApiKeyAfterUpdateHandler.Interface {
-    constructor(private logger: Logger.Interface) {}
+    constructor(
+        private logger: Logger.Interface,
+        private buildParams: BuildParams.Interface
+    ) {}
 
     async handle() {
         this.logger.warn("An API key was updated!");
+
+        // Read build params
+        const param1 = this.buildParams.get<string>("MY_CUSTOM_BUILD_PARAM");
+        const param2 = this.buildParams.get<{ myKey: number; nested: { foo: string } }>(
+            "MY_CUSTOM_BUILD_PARAM-2"
+        );
+
+        console.log("---- Build Params ----");
+
+        console.log(`Build param 1: ${param1}`);
+        console.log(`Build param 2:`, param2);
     }
 }
 
 const MyApiKeyAfterUpdate = ApiKeyAfterUpdateHandler.createImplementation({
     implementation: MyApiKeyAfterUpdateImpl,
-    dependencies: [Logger]
+    dependencies: [Logger, BuildParams]
 });
 
 export default MyApiKeyAfterUpdate;

…s/api-core/src/exports/api/buildParam.ts …/api-core/src/exports/api/buildParams.tspackages/api-core/src/exports/api/buildParam.ts renamed to packages/api-core/src/exports/api/buildParams.ts packages/api-core/src/exports/api/buildParam.ts renamed to packages/api-core/src/exports/api/buildParams.ts

@@ -13,7 +13,13 @@ export const BuildParam = defineExtension({
     paramsSchema: () => {
         return z.object({
             paramName: z.string(),
-            value: z.string()
+            value: z.union([
+                z.string(),
+                z.record(z.any()),
+                z.array(z.any()),
+                z.number(),
+                z.boolean()
+            ])
         });
     },
     async build(params, ctx) {
@@ -27,6 +33,9 @@ export const BuildParam = defineExtension({
 
         const { paramName, value } = params;
 
+        // Serialize value to a TypeScript literal.
+        const valueStr = JSON.stringify(value, null, 4);
+
         // Generate a unique class name based on the paramName.
         const hash = crypto.createHash("sha256").update(paramName).digest("hex");
         const className = `BuildParam_${hash.slice(-10)}`;
@@ -43,12 +52,17 @@ export const BuildParam = defineExtension({
             // File exists, just ensure it's imported in extensions.ts
         } else {
             // Create the BuildParam implementation file.
-            const fileContent = `import { BuildParam } from "@webiny/api-core/exports/api/buildParam";
+            const fileContent = `import { BuildParam } from "webiny/api/buildParams";
 
-export class ${className} implements BuildParam.Interface {
+class ${className} implements BuildParam.Interface {
     key = "${paramName}";
-    value = "${value}";
+    value = ${valueStr};
 }
+
+export default BuildParam.createImplementation({
+    implementation: ${className},
+    dependencies: []
+});
 `;
             fs.writeFileSync(filePath, fileContent, "utf8");
         }
@@ -83,9 +97,9 @@ export class ${className} implements BuildParam.Interface {
             index = last.getChildIndex() + 1;
         }
 
-        // Add import for the BuildParam class.
+        // Add import for the BuildParam implementation.
         source.insertImportDeclaration(index, {
-            namedImports: [className],
+            defaultImport: className,
             moduleSpecifier: importPath
         });
 

packages/api-core/src/extensions/BuildParam.ts

@@ -4,7 +4,7 @@ import { BuildParam, BuildParams as BuildParamsAbstraction } from "./abstraction
 export class BuildParamsImpl implements BuildParamsAbstraction.Interface {
     constructor(private container: Container) {}
 
-    get(key: string): string | null {
+    get<T = any>(key: string): T | null {
         const params = this.container.resolveAll<BuildParam.Interface>(BuildParam);
         const param = params.find(p => p.key === key);
         return param ? param.value : null;

packages/api-core/src/features/buildParams/BuildParams.ts

@@ -2,7 +2,7 @@ import { createAbstraction } from "@webiny/feature/api";
 
 export interface IBuildParam {
     key: string;
-    value: string;
+    value: any;
 }
 
 export const BuildParam = createAbstraction<IBuildParam>("BuildParam");
@@ -12,7 +12,7 @@ export namespace BuildParam {
 }
 
 export interface IBuildParams {
-    get(key: string): string | null;
+    get<T = any>(key: string): T | null;
 }
 
 export const BuildParams = createAbstraction<IBuildParams>("BuildParams");

packages/api-core/src/features/buildParams/abstractions.ts

@@ -37,6 +37,7 @@
     "./configs/tsconfig.json": "./configs/tsconfig.json",
     "./global.ts": "./global.ts",
     "./admin/ui": "./admin/ui.js",
+    "./api/buildParams": "./api/buildParams.js",
     "./api/eventPublisher": "./api/eventPublisher.js",
     "./api/keyValueStore": "./api/keyValueStore.js",
     "./api/logger": "./api/logger.js",

packages/webiny/package.json

@@ -0,0 +1 @@
+export { BuildParam, BuildParams } from "@webiny/api-core/features/buildParams/index.js";

packages/webiny/src/api/buildParams.ts

@@ -23,6 +23,10 @@ export const Extensions = () => {
             <Infra.Aws.DefaultRegion name={"eu-central-1"} />
 
             <Api.BuildParam paramName="MY_CUSTOM_BUILD_PARAM" value="customValue" />
+            <Api.BuildParam
+                paramName="MY_CUSTOM_BUILD_PARAM-2"
+                value={{ myKey: 2, nested: { foo: "bar" } }}
+            />
             {/* Example: Environment-based conditional configuration */}
             {/*<Infra.Env.Is env="prod">
                 <Infra.Aws.Tags tags={{ ENV: "production" }} />
@@ -91,7 +95,7 @@ export const Extensions = () => {
 
             {/* Security 👇 */}
             <Api.Extension src={"/extensions/MyApiKey.ts"} />
-            {/*<Security.ApiKey.AfterUpdate src={"/extensions/MyApiKeyAfterUpdate.ts"} />*/}
+            <Security.ApiKey.AfterUpdate src={"/extensions/MyApiKeyAfterUpdate.ts"} />
 
             {/* 🚧 WIP 👇 */}
             {/*<Security.ApiKeyBeforeCreate src={"/extensions/ApiKeyBeforeCreate.ts"} />*/}