@devkong/cli-nx 0.0.8 → 0.0.10

package/package.json

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

package/src/generators/preset/files/python/.vscode/settings.json

@@ -1,7 +1,6 @@
 {
   "files.eol": "\n",
   "python.languageServer": "Pylance",
-  "python.formatting.provider": "none",
   "[python]": {
     "editor.defaultFormatter": "ms-python.black-formatter",
     "editor.formatOnSave": true,
@@ -10,14 +9,10 @@
     }
   },
   "isort.args": ["--profile", "black"],
-  "explorer.fileNesting.enabled": true,
-  "explorer.fileNesting.patterns": {
-    "config.json": "config.*.json"
-  },
   "json.schemas": [
     {
       "fileMatch": ["**/kong.json"],
-      "url": "./node_modules/@kong/cli/assets/kong-json-schema.json"
+      "url": "http://kong.dev.re.app-dfi.net/kong-cli-schema.json"
     }
   ],
   "cSpell.words": [
@@ -32,12 +27,14 @@
     "conint",
     "contextlib",
     "contextmanager",
+    "devkong",
     "docparams",
     "docstrings",
     "elif",
     "fstring",
     "inlinevar",
     "isort",
+    "libpeerconnection",
     "metaclass",
     "msvs",
     "mymodule",
@@ -48,6 +45,8 @@
     "optparse",
     "overgeneral",
     "parseable",
+    "protoeditor",
+    "pycache",
     "pyenchant",
     "pylint",
     "pytest",
@@ -55,6 +54,9 @@
     "rexec",
     "rgxs",
     "TERMIOS",
-    "typevar"
+    "testem",
+    "typevar",
+    "unittests",
+    "venv"
   ]
 }

package/src/generators/preset/files/python/README.md

@@ -6,15 +6,15 @@ Welcome to the Kong extension development workspace!
 
 Before you start, make sure you have the following installed:
 
-- [Node.js](https://nodejs.org/en/download), version >= 20.0
+- [Node.js](https://nodejs.org/en/download/prebuilt-installer), version >= 20.0
 - [Python](https://www.python.org/downloads/), version >= 3.9
-- [Docker](https://docs.docker.com/engine/install/)
+- [Docker](https://docs.docker.com/desktop/)
 
 To verify the installation and check the versions, run the following commands:
 
 ```shell script
 node --version
-python --version
+python --version # or python3 --version
 docker info
 ```
 
@@ -32,7 +32,7 @@ kong configure
 kong install --verbose
 ```
 
-That's it! Now, modify your code, tag it by publishing a new version, and assign aliases for use in the workflow.
+That's it! Now, modify [main.py](./src/main.py), tag it by publishing a new version, and assign aliases for use in the workflow.
 
 ### Publish a New Version
 

package/src/generators/preset/files/python/src/main.py

@@ -1,10 +1,9 @@
 import sys
 from typing import Optional
-from uuid import UUID
 
 from kong.sdk.app import App
 from kong.sdk.kong_function import KongFunction
-from pydantic import BaseModel, EmailStr, Field
+from pydantic import BaseModel, Field
 
 # This script is for developing an extension for Kong.
 # For more details, please refer to the README.md file.
@@ -16,49 +15,52 @@ class InputData(BaseModel):
     # sample objects in the UI, making it easier to work with the models.
     # For more standard types, refer to: https://docs.pydantic.dev/latest/concepts/types/
 
-    string_field: str = Field(
-        examples=["Hello"],
-        description="A string",
-    )
+    # REPLACE BELLOW WITH YOUR FIELDS
 
-    integer_field: int = Field(
-        examples=[42],
+    a: int = Field(
+        examples=[1],
         description="An integer number",
     )
 
-    optional_field: Optional[UUID] = Field(
-        None,
-        examples=["123e4567-e89b-12d3-a456-426614174000"],
-        description="An optional UUID field",
-    )
-
-    email_list: list[EmailStr] = Field(
-        examples=["one@example.com", "two@example.com"],
-        description="A list of emails",
+    b: int = Field(
+        examples=[2],
+        description="An integer number",
     )
 
 
 class OutputData(BaseModel):
     # Define the structure of the output data that your extension will return.
 
-    value: str = Field(examples=["Hello"], description="Value from the string_field")
+    # REPLACE BELLOW WITH YOUR FIELDS
+
+    sum_of: int = Field(
+        examples=[3],
+        description="Result of a + b",
+    )
 
+    comment: Optional[str] = Field(
+        examples=["This example extension returns sum of a and b"],
+        description="A string field",
+    )
 
-class ExtensionTemplate(KongFunction):
-    # This is where you implement the logic to handle the input data and produce the output.
-    # Override the `handle` method to customize the processing of input data.
 
-    async def handle(self, data: InputData) -> OutputData:
-        # In this example, we are simply returning
-        # the value of 'string_field' as the output.
+class MyExtension(KongFunction):
+    # This is where you implement the logic to handle the input data
+    # and produce the output.
 
-        return OutputData(value=data.string_field)
+    # OVERRIDE BELLOW TO CUSTOMIZE THE PROCESSING.
+
+    async def handle(self, data: InputData) -> OutputData:
+        return OutputData(
+            sum_of=data.a + data.b,
+            comment=f"sum of {data.a} and {data.b}",
+        )
 
 
 app = App(
     InputData,
     OutputData,
-    ExtensionTemplate,
+    MyExtension,
 )
 
 if __name__ == "__main__":

package/src/generators/preset/files/python/src/main_test.py

@@ -1,21 +1,18 @@
 from kong.sdk.conftest import ExtensionFixture
-
-from src.main import ExtensionTemplate, InputData
+from src.main import InputData, MyExtension
 
 
 # The test function to validate the behavior of the extension
 async def test_should_return_value_from_string_field_when_input_is_provided(
     create_extension: ExtensionFixture,
 ):
-    extension = create_extension(ExtensionTemplate, InputData)
+    extension = create_extension(MyExtension, InputData)
 
     # Prepare the input data
     input_data = InputData(
-        string_field="test",
-        integer_field=42,
-        optional_field=None,
-        email_list=["one@example.com", "two@example.com"],
+        a=1,
+        b=2,
     )
 
     output = await extension.handle(input_data)
-    assert output.value == "test"
+    assert output.sum_of == 3