@devkong/cli-nx 0.0.67-alpha.24 → 0.0.67-alpha.25

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devkong/cli-nx",
-  "version": "0.0.67-alpha.24",
+  "version": "0.0.67-alpha.25",
   "type": "commonjs",
   "main": "./src/index.js",
   "typings": "./src/index.d.ts",

package/src/generators/preset/files/python/requirements.txt

@@ -1,2 +1,5 @@
 pydantic==2.13.4
-kong-sdk==0.0.49
+kong-sdk==0.0.51
+<% if (variant === "with-s3") { -%>
+aiobotocore==2.15.2
+<% } -%>

package/src/generators/preset/files/python-with-s3/src/frontend.py

@@ -0,0 +1,6 @@
+from kong.sdk.kong_frontend import KongFrontend, KongFrontendBuilder
+from kong.sdk.s3 import S3Secret
+
+frontend: KongFrontend = (
+    KongFrontendBuilder().with_secret_types("s3", {"s3": S3Secret}).with_form().build()
+)

package/src/generators/preset/files/python-with-s3/src/input_data.py

@@ -0,0 +1,17 @@
+from kong.sdk.kong_function_request import KongFunctionRequest
+from pydantic import BaseModel, Field
+
+
+class ExecuteData(BaseModel):
+    key: str = Field(
+        examples=["test/example.json"],
+        description="Key (path) of the object to download from the S3 bucket",
+    )
+
+
+class InputData(BaseModel):
+    request: KongFunctionRequest
+
+    execute: ExecuteData = Field(
+        description="Parameters for the 'execute' operation",
+    )

package/src/generators/preset/files/python-with-s3/src/main.py

@@ -0,0 +1,54 @@
+import sys
+from datetime import timedelta
+
+from frontend import frontend
+from input_data import InputData
+from kong.sdk.app import App
+from kong.sdk.app_logger import app_logger
+from kong.sdk.kong_function import KongFunction
+from kong.sdk.kong_function_context import KongFunctionContext
+from kong.sdk.s3 import S3Secret
+from output_data import OutputData
+from s3 import create_s3_client
+
+
+class Main(KongFunction):
+    __logger = app_logger(__name__)
+
+    async def handle(self, data: InputData, context: KongFunctionContext) -> OutputData:
+        secret: S3Secret = context.secret.get("s3").data
+        client = await context.state.use(
+            key=f"{secret.endpoint}:{secret.port}:{secret.bucket}:{secret.access_key}",
+            create=lambda: create_s3_client(secret),
+            unused=(timedelta(minutes=5), lambda c: c.close()),
+        )
+
+        response = await client.get_object(
+            Bucket=secret.bucket,
+            Key=data.execute.key,
+        )
+
+        body = await response["Body"].read()
+        self.__logger.info(
+            "have response from S3",
+            lambda: {
+                "bucket": secret.bucket,
+                "key": data.execute.key,
+                "size": len(body),
+            },
+        )
+
+        return OutputData(
+            key=data.execute.key,
+        )
+
+
+app = App(
+    InputData,
+    OutputData,
+    Main,
+    frontend,
+)
+
+if __name__ == "__main__":
+    app.run(sys.argv)

package/src/generators/preset/files/python-with-s3/src/main_test.py

@@ -0,0 +1,40 @@
+from datetime import timedelta
+from types import SimpleNamespace
+
+from frontend import frontend
+from input_data import ExecuteData, InputData
+from kong.sdk.conftest import ExtensionFixture, extension_test_context
+from kong.sdk.kong_function_request import KongFunctionRequest
+from kong.sdk.kong_state_context import KongStateContext
+from kong.sdk.s3 import S3Secret
+from main import Main, client_cache_key
+
+S3_SECRET = S3Secret(
+    access_key="access",
+    secret_key="secret",
+    bucket="my-bucket",
+    region="us-east-1",
+    endpoint=None,
+    port=None,
+    use_ssl=True,
+    path_style=False,
+)
+
+
+async def test_should_download_object_from_s3(
+    create_extension: ExtensionFixture,
+):
+    extension = create_extension(Main, InputData)
+
+    input_data = InputData(
+        request=KongFunctionRequest(operation="execute"),
+        execute=ExecuteData(key="test/example.json"),
+    )
+
+    context = extension_test_context(
+        frontend,
+        secrets={"s3": S3_SECRET},
+    )
+
+    output = await extension.handle(input_data, context)
+    assert output.key == "test/example.json"

package/src/generators/preset/files/python-with-s3/src/output_data.py

@@ -0,0 +1,21 @@
+from typing import Optional
+
+from pydantic import BaseModel, Field
+
+
+class OutputData(BaseModel):
+    key: str = Field(
+        examples=["test/example.json"],
+        description="Key of the object that was downloaded",
+    )
+
+    size: int = Field(
+        examples=[42],
+        description="Size of the downloaded object, in bytes",
+    )
+
+    content: Optional[str] = Field(
+        default=None,
+        examples=['{"hello": "world"}'],
+        description="UTF-8 decoded content of the downloaded object",
+    )

package/src/generators/preset/files/python-with-s3/src/s3.py

@@ -0,0 +1,27 @@
+from aiobotocore.session import get_session
+from botocore.config import Config
+from kong.sdk.s3 import S3Secret
+
+
+async def create_s3_client(secret: S3Secret):
+    # Standard AWS endpoints are derived by boto from the region; only S3-compatible
+    # stores (MinIO, Ceph, ...) need an explicit endpoint override.
+    endpoint_url = None
+    if secret.endpoint and "amazonaws.com" not in secret.endpoint:
+        scheme = "https" if secret.use_ssl else "http"
+        endpoint_url = (
+            f"{scheme}://{secret.endpoint}:{secret.port}"
+            if secret.port
+            else f"{scheme}://{secret.endpoint}"
+        )
+
+    client_context = get_session().create_client(
+        "s3",
+        region_name=secret.region,
+        endpoint_url=endpoint_url,
+        use_ssl=secret.use_ssl,
+        aws_access_key_id=secret.access_key,
+        aws_secret_access_key=secret.secret_key,
+        config=(Config(s3={"addressing_style": "path"}) if secret.path_style else None),
+    )
+    return await client_context.__aenter__()

package/src/generators/preset/generator.js

@@ -16,11 +16,13 @@ function presetGenerator(tree, options) {
         options.os = process.platform;
         options.variant = (_a = options.variant) !== null && _a !== void 0 ? _a : "basic";
         (0, devkit_1.generateFiles)(tree, path.join(__dirname, `files/${options.platform}`), "", options);
-        // The python preset ships a "basic" (single sum) and an "advanced" (multi-operation
-        // + secret example) template. The advanced sources are layered on top of the shared
-        // base, overwriting the basic src/*.py files.
-        if (options.platform === "python" && options.variant === "advanced") {
-            (0, devkit_1.generateFiles)(tree, path.join(__dirname, "files/python-advanced"), "", options);
+        const pythonVariantDirs = {
+            "with-secret": "files/python-with-secret",
+            "with-s3": "files/python-with-s3",
+        };
+        const variantDir = pythonVariantDirs[options.variant];
+        if (options.platform === "python" && variantDir) {
+            (0, devkit_1.generateFiles)(tree, path.join(__dirname, variantDir), "", options);
         }
         yield (0, devkit_1.formatFiles)(tree);
         try {

package/src/generators/preset/generator.js.map

@@ -1 +1 @@
-{"version":3,"file":"generator.js","sourceRoot":"","sources":["../../../../src/generators/preset/generator.ts"],"names":[],"mappings":";;AAUA,0CA6BC;;AAvCD,uCAMoB;AACpB,mDAA6B;AAG7B,SAAsB,eAAe,CAAC,IAAU,EAAE,OAA8B;;;QAC9E,MAAM,WAAW,GAAG,GAAG,CAAC;QACxB,MAAM,WAAW,GAAG,EAAE,CAAC;QACvB,IAAA,gCAAuB,EAAC,IAAI,EAAE,WAAW,EAAE;YACzC,IAAI,EAAE,WAAW;YACjB,WAAW,EAAE,aAAa;SAC3B,CAAC,CAAC;QAEH,OAAO,CAAC,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC;QAC9B,OAAO,CAAC,OAAO,GAAG,MAAA,OAAO,CAAC,OAAO,mCAAI,OAAO,CAAC;QAC7C,IAAA,sBAAa,EAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,OAAO,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;QAEpF,oFAAoF;QACpF,oFAAoF;QACpF,8CAA8C;QAC9C,IAAI,OAAO,CAAC,QAAQ,KAAK,QAAQ,IAAI,OAAO,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;YACpE,IAAA,sBAAa,EAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,uBAAuB,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;QAClF,CAAC;QAED,MAAM,IAAA,oBAAW,EAAC,IAAI,CAAC,CAAC;QAExB,IAAI,CAAC;YACH,MAAM,WAAW,GAAG,IAAA,0BAAiB,EAAC,WAAW,EAAE,SAAS,CAAC,CAAC;YAC9D,IAAI,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC;gBAC7B,IAAI,CAAC,iBAAiB,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC,CAAC,YAAY;YAC1D,CAAC;QACH,CAAC;QAAC,OAAO,EAAE,EAAE,CAAC;YACZ,OAAO,CAAC,IAAI,CAAC,mCAAmC,EAAE,EAAE,CAAC,CAAC;QACxD,CAAC;IACH,CAAC;CAAA;AAED,kBAAe,eAAe,CAAC"}
+{"version":3,"file":"generator.js","sourceRoot":"","sources":["../../../../src/generators/preset/generator.ts"],"names":[],"mappings":";;AAUA,0CA+BC;;AAzCD,uCAMoB;AACpB,mDAA6B;AAG7B,SAAsB,eAAe,CAAC,IAAU,EAAE,OAA8B;;;QAC9E,MAAM,WAAW,GAAG,GAAG,CAAC;QACxB,MAAM,WAAW,GAAG,EAAE,CAAC;QACvB,IAAA,gCAAuB,EAAC,IAAI,EAAE,WAAW,EAAE;YACzC,IAAI,EAAE,WAAW;YACjB,WAAW,EAAE,aAAa;SAC3B,CAAC,CAAC;QAEH,OAAO,CAAC,EAAE,GAAG,OAAO,CAAC,QAAQ,CAAC;QAC9B,OAAO,CAAC,OAAO,GAAG,MAAA,OAAO,CAAC,OAAO,mCAAI,OAAO,CAAC;QAC7C,IAAA,sBAAa,EAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,OAAO,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;QAEpF,MAAM,iBAAiB,GAA2B;YAChD,aAAa,EAAE,0BAA0B;YACzC,SAAS,EAAE,sBAAsB;SAClC,CAAC;QACF,MAAM,UAAU,GAAG,iBAAiB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACtD,IAAI,OAAO,CAAC,QAAQ,KAAK,QAAQ,IAAI,UAAU,EAAE,CAAC;YAChD,IAAA,sBAAa,EAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,UAAU,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;QACrE,CAAC;QAED,MAAM,IAAA,oBAAW,EAAC,IAAI,CAAC,CAAC;QAExB,IAAI,CAAC;YACH,MAAM,WAAW,GAAG,IAAA,0BAAiB,EAAC,WAAW,EAAE,SAAS,CAAC,CAAC;YAC9D,IAAI,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,CAAC;gBAC7B,IAAI,CAAC,iBAAiB,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC,CAAC,YAAY;YAC1D,CAAC;QACH,CAAC;QAAC,OAAO,EAAE,EAAE,CAAC;YACZ,OAAO,CAAC,IAAI,CAAC,mCAAmC,EAAE,EAAE,CAAC,CAAC;QACxD,CAAC;IACH,CAAC;CAAA;AAED,kBAAe,eAAe,CAAC"}

package/src/generators/preset/schema.d.ts

@@ -6,6 +6,5 @@ export interface PresetGeneratorSchema {
   os?: string;
   platform: "python" | "kotlin";
   // Which starter template to scaffold. Only the python preset currently ships more
-  // than "basic"; "advanced" adds the multi-operation + secret example variant.
-  variant?: "basic" | "advanced";
+  variant?: "basic" | "with-secret" | "with-s3";
 }

package/src/generators/preset/schema.json

@@ -27,7 +27,8 @@
       "description": "Which starter template to scaffold",
       "enum": [
         "basic",
-        "advanced"
+        "with-secret",
+        "with-s3"
       ],
       "default": "basic",
       "x-prompt": {
@@ -39,8 +40,12 @@
             "label": "basic - a single operation"
           },
           {
-            "value": "advanced",
-            "label": "advanced - multiple operations with a secret example"
+            "value": "with-secret",
+            "label": "with-secret - multiple operations with a secret example"
+          },
+          {
+            "value": "with-s3",
+            "label": "with-s3 - download a file from S3 using an s3 secret"
           }
         ]
       }