@backstage/backend-plugin-api 1.9.2-next.0 → 1.9.2-next.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @backstage/backend-plugin-api
 
+## 1.9.2-next.1
+
+### Patch Changes
+
+- 0211390: Added optional `secrets` schema support to `ActionsRegistryActionOptions` and `ActionsRegistryActionContext`. Actions can now declare a Zod secrets schema separate from the input schema, enabling surfaces to collect sensitive credentials independently from tool arguments. Added optional `secrets` field to `ActionsServiceAction` metadata and `ActionsService.invoke()` parameters.
+
 ## 1.9.2-next.0
 
 ### Patch Changes

package/dist/alpha.d.ts

@@ -18,8 +18,9 @@ interface RootSystemMetadataService {
 /**
  * @alpha
  */
-type ActionsRegistryActionContext<TInputSchema extends AnyZodObject> = {
+type ActionsRegistryActionContext<TInputSchema extends AnyZodObject, TSecretsSchema extends AnyZodObject | undefined = undefined> = {
     input: z.infer<TInputSchema>;
+    secrets: TSecretsSchema extends AnyZodObject ? z.infer<TSecretsSchema> : undefined;
     logger: LoggerService;
     credentials: BackstageCredentials;
 };
@@ -37,13 +38,14 @@ type ActionsRegistryActionExample<TInputSchema extends AnyZodObject, TOutputSche
 /**
  * @alpha
  */
-type ActionsRegistryActionOptions<TInputSchema extends AnyZodObject, TOutputSchema extends AnyZodObject> = {
+type ActionsRegistryActionOptions<TInputSchema extends AnyZodObject, TOutputSchema extends AnyZodObject, TSecretsSchema extends AnyZodObject | undefined = undefined> = {
     name: string;
     title: string;
     description: string;
     schema: {
         input: (zod: typeof z) => TInputSchema;
         output: (zod: typeof z) => TOutputSchema;
+        secrets?: (zod: typeof z) => TSecretsSchema extends AnyZodObject ? TSecretsSchema : never;
     };
     examples?: Array<ActionsRegistryActionExample<TInputSchema, TOutputSchema>>;
     visibilityPermission?: BasicPermission;
@@ -52,7 +54,7 @@ type ActionsRegistryActionOptions<TInputSchema extends AnyZodObject, TOutputSche
         idempotent?: boolean;
         readOnly?: boolean;
     };
-    action: (context: ActionsRegistryActionContext<TInputSchema>) => Promise<z.infer<TOutputSchema> extends void ? void : {
+    action: (context: ActionsRegistryActionContext<TInputSchema, TSecretsSchema>) => Promise<z.infer<TOutputSchema> extends void ? void : {
         output: z.infer<TOutputSchema>;
     }>;
 };
@@ -60,7 +62,7 @@ type ActionsRegistryActionOptions<TInputSchema extends AnyZodObject, TOutputSche
  * @alpha
  */
 interface ActionsRegistryService {
-    register<TInputSchema extends AnyZodObject, TOutputSchema extends AnyZodObject>(options: ActionsRegistryActionOptions<TInputSchema, TOutputSchema>): void;
+    register<TInputSchema extends AnyZodObject, TOutputSchema extends AnyZodObject, TSecretsSchema extends AnyZodObject | undefined = undefined>(options: ActionsRegistryActionOptions<TInputSchema, TOutputSchema, TSecretsSchema>): void;
 }
 
 /**
@@ -75,6 +77,7 @@ type ActionsServiceAction = {
     schema: {
         input: JSONSchema7;
         output: JSONSchema7;
+        secrets?: JSONSchema7;
     };
     examples?: Array<{
         title: string;
@@ -100,6 +103,7 @@ interface ActionsService {
     invoke(opts: {
         id: string;
         input?: JsonObject;
+        secrets?: JsonObject;
         credentials: BackstageCredentials;
     }): Promise<{
         output: JsonValue;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/backend-plugin-api",
-  "version": "1.9.2-next.0",
+  "version": "1.9.2-next.1",
   "description": "Core API used by Backstage backend plugins",
   "backstage": {
     "role": "node-library"
@@ -81,8 +81,8 @@
     "zod": "^3.25.76 || ^4.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "1.11.4-next.0",
-    "@backstage/cli": "0.36.3-next.0"
+    "@backstage/backend-test-utils": "1.11.4-next.1",
+    "@backstage/cli": "0.36.3-next.1"
   },
   "configSchema": "config.d.ts"
 }