feat: extend PluginContext model and regenerate client (#240)

* feat: extend PluginContext model and regenerate client

* chore: rebuild client with fixes

* chore: regenerate client

Author: zeljkoX

.github/workflows/codeql.yml

@@ -1,12 +1,12 @@
-name: "CodeQL Advanced"
+name: 'CodeQL Advanced'
 
 on:
   push:
-    branches: ["main", "release-v*"]
+    branches: ['main', 'release-v*']
   pull_request:
-    branches: ["main"]
+    branches: ['main']
   schedule:
-    - cron: "40 12 * * 3"
+    - cron: '40 12 * * 3'
 
 permissions:
   contents: read
@@ -53,4 +53,4 @@ jobs:
       - name: Perform CodeQL Analysis
         uses: github/codeql-action/analyze@64d10c13136e1c5bce3e5fbde8d4906eeaafc885 # v3.30.6
         with:
-          category: "/language:${{matrix.language}}"
+          category: '/language:${{matrix.language}}'

.github/workflows/publish.yml

@@ -20,7 +20,7 @@ env:
 
 jobs:
   provenance:
-    uses: slsa-framework/slsa-github-generator/.github/workflows/builder_nodejs_slsa3.yml@f7dd8c54c2067bafc12ca7a55595d5ee9b75204a  # v2.1.0
+    uses: slsa-framework/slsa-github-generator/.github/workflows/builder_nodejs_slsa3.yml@f7dd8c54c2067bafc12ca7a55595d5ee9b75204a # v2.1.0
     with:
       run-scripts: 'install-pnpm, install-deps, style, nx-build-skip-cache, nx-test-skip-cache, generate'
       node-version: '22.14.0'

custom-models/plugin-api.ts

@@ -198,6 +198,10 @@ export interface PluginContext {
   kv: PluginKVStore;
   headers: PluginHeaders;
   params: any;
+  route: string;
+  config?: Record<string, any>;
+  method: string;
+  query: Record<string, string[]>;
 }
 
 export interface PluginAPI {

examples/plugins/callPlugin.ts

@@ -23,12 +23,15 @@ const config = new Configuration({
 
 const pluginsApi = new PluginsApi(config);
 
-const plugin_id = 'example';
+const plugin_id = 'plugin-example'; // replace with your actual plugin id
 
-pluginsApi.callPlugin(plugin_id, {
-  // these params will be passed to the plugin.
-  params: {
-    foo: 'bar',
-    baz: 123,
-  },
-});
+pluginsApi
+  .callPlugin(plugin_id, {
+    // these params will be passed to the plugin.
+    params: {
+      foo: 'bar',
+      baz: 123,
+    },
+  })
+  .then((response) => console.log(JSON.stringify(response.data, null, 2)))
+  .catch(console.error);

examples/relayers/stellar/pnpm-lock.yaml

@@ -198,6 +198,10 @@ export interface PluginContext {
   kv: PluginKVStore;
   headers: PluginHeaders;
   params: any;
+  route: string;
+  config?: Record<string, any>;
+  method: string;
+  query: Record<string, string[]>;
 }
 
 export interface PluginAPI {

pnpm-lock.yaml

@@ -5,4 +5,4 @@
   },
   "include": ["src/**/*"],
   "exclude": ["node_modules", "dist", "examples", "custom-models"]
-} 
+}

src/models/plugin-api.ts

@@ -5,4 +5,4 @@
   },
   "include": ["src/**/*"],
   "exclude": ["node_modules", "dist", "examples", "custom-models"]
-} 
+}