@backstage/plugin-scaffolder-node 0.1.1-next.0 → 0.1.1-next.2

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @backstage/plugin-scaffolder-node
 
+## 0.1.1-next.2
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.4.1-next.2
+
+## 0.1.1-next.1
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.4.1-next.1
+  - @backstage/catalog-model@1.2.1-next.1
+  - @backstage/types@1.0.2
+  - @backstage/plugin-scaffolder-common@1.2.6-next.1
+
 ## 0.1.1-next.0
 
 ### Patch Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-node",
-  "version": "0.1.1-next.0",
+  "version": "0.1.1-next.2",
   "main": "../dist/index.cjs.js",
   "types": "../dist/index.alpha.d.ts"
 }

package/dist/index.alpha.d.ts

@@ -14,17 +14,18 @@ import { Schema } from 'jsonschema';
 import { TemplateInfo } from '@backstage/plugin-scaffolder-common';
 import { UserEntity } from '@backstage/catalog-model';
 import { Writable } from 'stream';
+import { z } from 'zod';
 
 /**
  * ActionContext is passed into scaffolder actions.
  * @public
  */
-export declare type ActionContext<TInput extends JsonObject> = {
+export declare type ActionContext<TActionInput extends JsonObject> = {
     logger: Logger;
     logStream: Writable;
     secrets?: TaskSecrets;
     workspacePath: string;
-    input: TInput;
+    input: TActionInput;
     output(name: string, value: JsonValue): void;
     /**
      * Creates a temporary directory for use by the action, which is then cleaned up automatically.
@@ -53,10 +54,10 @@ export declare type ActionContext<TInput extends JsonObject> = {
 
 /**
  * This function is used to create new template actions to get type safety.
- *
+ * Will convert zod schemas to json schemas for use throughout the system.
  * @public
  */
-export declare const createTemplateAction: <TInput extends JsonObject>(templateAction: TemplateAction<TInput>) => TemplateAction<TInput>;
+export declare const createTemplateAction: <TParams, TInputSchema extends z.ZodType<any, z.ZodTypeDef, any> | Schema = {}, TOutputSchema extends z.ZodType<any, z.ZodTypeDef, any> | Schema = {}, TActionInput = TInputSchema extends z.ZodType<any, any, infer IReturn> ? IReturn : TParams>(action: TemplateActionOptions<TActionInput, TInputSchema, TOutputSchema>) => TemplateAction<TActionInput>;
 
 /**
  * Extension point for managing scaffolder actions.
@@ -84,7 +85,7 @@ export declare type TaskSecrets = Record<string, string> & {
 };
 
 /** @public */
-export declare type TemplateAction<TInput extends JsonObject> = {
+export declare type TemplateAction<TActionInput = unknown> = {
     id: string;
     description?: string;
     examples?: {
@@ -96,7 +97,23 @@ export declare type TemplateAction<TInput extends JsonObject> = {
         input?: Schema;
         output?: Schema;
     };
-    handler: (ctx: ActionContext<TInput>) => Promise<void>;
+    handler: (ctx: ActionContext<TActionInput>) => Promise<void>;
+};
+
+/** @public */
+export declare type TemplateActionOptions<TActionInput = {}, TInputSchema extends Schema | z.ZodType = {}, TOutputSchema extends Schema | z.ZodType = {}> = {
+    id: string;
+    description?: string;
+    examples?: {
+        description: string;
+        example: string;
+    }[];
+    supportsDryRun?: boolean;
+    schema?: {
+        input?: TInputSchema;
+        output?: TOutputSchema;
+    };
+    handler: (ctx: ActionContext<TActionInput>) => Promise<void>;
 };
 
 export { }

package/dist/index.beta.d.ts

@@ -14,17 +14,18 @@ import { Schema } from 'jsonschema';
 import { TemplateInfo } from '@backstage/plugin-scaffolder-common';
 import { UserEntity } from '@backstage/catalog-model';
 import { Writable } from 'stream';
+import { z } from 'zod';
 
 /**
  * ActionContext is passed into scaffolder actions.
  * @public
  */
-export declare type ActionContext<TInput extends JsonObject> = {
+export declare type ActionContext<TActionInput extends JsonObject> = {
     logger: Logger;
     logStream: Writable;
     secrets?: TaskSecrets;
     workspacePath: string;
-    input: TInput;
+    input: TActionInput;
     output(name: string, value: JsonValue): void;
     /**
      * Creates a temporary directory for use by the action, which is then cleaned up automatically.
@@ -53,10 +54,10 @@ export declare type ActionContext<TInput extends JsonObject> = {
 
 /**
  * This function is used to create new template actions to get type safety.
- *
+ * Will convert zod schemas to json schemas for use throughout the system.
  * @public
  */
-export declare const createTemplateAction: <TInput extends JsonObject>(templateAction: TemplateAction<TInput>) => TemplateAction<TInput>;
+export declare const createTemplateAction: <TParams, TInputSchema extends z.ZodType<any, z.ZodTypeDef, any> | Schema = {}, TOutputSchema extends z.ZodType<any, z.ZodTypeDef, any> | Schema = {}, TActionInput = TInputSchema extends z.ZodType<any, any, infer IReturn> ? IReturn : TParams>(action: TemplateActionOptions<TActionInput, TInputSchema, TOutputSchema>) => TemplateAction<TActionInput>;
 
 /* Excluded from this release type: ScaffolderActionsExtensionPoint */
 
@@ -72,7 +73,7 @@ export declare type TaskSecrets = Record<string, string> & {
 };
 
 /** @public */
-export declare type TemplateAction<TInput extends JsonObject> = {
+export declare type TemplateAction<TActionInput = unknown> = {
     id: string;
     description?: string;
     examples?: {
@@ -84,7 +85,23 @@ export declare type TemplateAction<TInput extends JsonObject> = {
         input?: Schema;
         output?: Schema;
     };
-    handler: (ctx: ActionContext<TInput>) => Promise<void>;
+    handler: (ctx: ActionContext<TActionInput>) => Promise<void>;
+};
+
+/** @public */
+export declare type TemplateActionOptions<TActionInput = {}, TInputSchema extends Schema | z.ZodType = {}, TOutputSchema extends Schema | z.ZodType = {}> = {
+    id: string;
+    description?: string;
+    examples?: {
+        description: string;
+        example: string;
+    }[];
+    supportsDryRun?: boolean;
+    schema?: {
+        input?: TInputSchema;
+        output?: TOutputSchema;
+    };
+    handler: (ctx: ActionContext<TActionInput>) => Promise<void>;
 };
 
 export { }

package/dist/index.cjs.js

@@ -2,9 +2,25 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+var zodToJsonSchema = require('zod-to-json-schema');
 var backendPluginApi = require('@backstage/backend-plugin-api');
 
-const createTemplateAction = (templateAction) => {
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var zodToJsonSchema__default = /*#__PURE__*/_interopDefaultLegacy(zodToJsonSchema);
+
+const createTemplateAction = (action) => {
+  var _a, _b, _c, _d;
+  const inputSchema = ((_a = action.schema) == null ? void 0 : _a.input) && "safeParseAsync" in action.schema.input ? zodToJsonSchema__default["default"](action.schema.input) : (_b = action.schema) == null ? void 0 : _b.input;
+  const outputSchema = ((_c = action.schema) == null ? void 0 : _c.output) && "safeParseAsync" in action.schema.output ? zodToJsonSchema__default["default"](action.schema.output) : (_d = action.schema) == null ? void 0 : _d.output;
+  const templateAction = {
+    ...action,
+    schema: {
+      ...action.schema,
+      input: inputSchema,
+      output: outputSchema
+    }
+  };
   return templateAction;
 };
 

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":["../src/actions/createTemplateAction.ts","../src/extensions.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { JsonObject } from '@backstage/types';\nimport { TemplateAction } from './types';\n\n/**\n * This function is used to create new template actions to get type safety.\n *\n * @public\n */\nexport const createTemplateAction = <TInput extends JsonObject>(\n  templateAction: TemplateAction<TInput>,\n): TemplateAction<TInput> => {\n  // TODO(blam): Can add some more validation here to validate the action later on\n  return templateAction;\n};\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createExtensionPoint } from '@backstage/backend-plugin-api';\nimport { TemplateAction } from './actions';\n\n/**\n * Extension point for managing scaffolder actions.\n *\n * @alpha\n */\nexport interface ScaffolderActionsExtensionPoint {\n  addActions(...actions: TemplateAction<any>[]): void;\n}\n\n/**\n * Extension point for managing scaffolder actions.\n *\n * @alpha\n */\nexport const scaffolderActionsExtensionPoint =\n  createExtensionPoint<ScaffolderActionsExtensionPoint>({\n    id: 'scaffolder.actions',\n  });\n"],"names":["createExtensionPoint"],"mappings":";;;;;;AAwBa,MAAA,oBAAA,GAAuB,CAClC,cAC2B,KAAA;AAE3B,EAAO,OAAA,cAAA,CAAA;AACT;;ACIO,MAAM,kCACXA,qCAAsD,CAAA;AAAA,EACpD,EAAI,EAAA,oBAAA;AACN,CAAC;;;;;"}
+{"version":3,"file":"index.cjs.js","sources":["../src/actions/createTemplateAction.ts","../src/extensions.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { ActionContext, TemplateAction } from './types';\nimport { z } from 'zod';\nimport { Schema } from 'jsonschema';\nimport zodToJsonSchema from 'zod-to-json-schema';\n\n/** @public */\nexport type TemplateActionOptions<\n  TActionInput = {},\n  TInputSchema extends Schema | z.ZodType = {},\n  TOutputSchema extends Schema | z.ZodType = {},\n> = {\n  id: string;\n  description?: string;\n  examples?: { description: string; example: string }[];\n  supportsDryRun?: boolean;\n  schema?: {\n    input?: TInputSchema;\n    output?: TOutputSchema;\n  };\n  handler: (ctx: ActionContext<TActionInput>) => Promise<void>;\n};\n\n/**\n * This function is used to create new template actions to get type safety.\n * Will convert zod schemas to json schemas for use throughout the system.\n * @public\n */\nexport const createTemplateAction = <\n  TParams,\n  TInputSchema extends Schema | z.ZodType = {},\n  TOutputSchema extends Schema | z.ZodType = {},\n  TActionInput = TInputSchema extends z.ZodType<any, any, infer IReturn>\n    ? IReturn\n    : TParams,\n>(\n  action: TemplateActionOptions<TActionInput, TInputSchema, TOutputSchema>,\n): TemplateAction<TActionInput> => {\n  const inputSchema =\n    action.schema?.input && 'safeParseAsync' in action.schema.input\n      ? zodToJsonSchema(action.schema.input)\n      : action.schema?.input;\n\n  const outputSchema =\n    action.schema?.output && 'safeParseAsync' in action.schema.output\n      ? zodToJsonSchema(action.schema.output)\n      : action.schema?.output;\n\n  const templateAction = {\n    ...action,\n    schema: {\n      ...action.schema,\n      input: inputSchema,\n      output: outputSchema,\n    },\n  };\n\n  return templateAction;\n};\n","/*\n * Copyright 2022 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { createExtensionPoint } from '@backstage/backend-plugin-api';\nimport { TemplateAction } from './actions';\n\n/**\n * Extension point for managing scaffolder actions.\n *\n * @alpha\n */\nexport interface ScaffolderActionsExtensionPoint {\n  addActions(...actions: TemplateAction<any>[]): void;\n}\n\n/**\n * Extension point for managing scaffolder actions.\n *\n * @alpha\n */\nexport const scaffolderActionsExtensionPoint =\n  createExtensionPoint<ScaffolderActionsExtensionPoint>({\n    id: 'scaffolder.actions',\n  });\n"],"names":["zodToJsonSchema","createExtensionPoint"],"mappings":";;;;;;;;;;;AA2Ca,MAAA,oBAAA,GAAuB,CAQlC,MACiC,KAAA;AApDnC,EAAA,IAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,EAAA,CAAA;AAqDE,EAAA,MAAM,gBACJ,EAAO,GAAA,MAAA,CAAA,MAAA,KAAP,IAAe,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,KAAA,KAAS,oBAAoB,MAAO,CAAA,MAAA,CAAO,KACtD,GAAAA,mCAAA,CAAgB,OAAO,MAAO,CAAA,KAAK,CACnC,GAAA,CAAA,EAAA,GAAA,MAAA,CAAO,WAAP,IAAe,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,KAAA,CAAA;AAErB,EAAA,MAAM,iBACJ,EAAO,GAAA,MAAA,CAAA,MAAA,KAAP,IAAe,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,MAAA,KAAU,oBAAoB,MAAO,CAAA,MAAA,CAAO,MACvD,GAAAA,mCAAA,CAAgB,OAAO,MAAO,CAAA,MAAM,CACpC,GAAA,CAAA,EAAA,GAAA,MAAA,CAAO,WAAP,IAAe,GAAA,KAAA,CAAA,GAAA,EAAA,CAAA,MAAA,CAAA;AAErB,EAAA,MAAM,cAAiB,GAAA;AAAA,IACrB,GAAG,MAAA;AAAA,IACH,MAAQ,EAAA;AAAA,MACN,GAAG,MAAO,CAAA,MAAA;AAAA,MACV,KAAO,EAAA,WAAA;AAAA,MACP,MAAQ,EAAA,YAAA;AAAA,KACV;AAAA,GACF,CAAA;AAEA,EAAO,OAAA,cAAA,CAAA;AACT;;ACxCO,MAAM,kCACXC,qCAAsD,CAAA;AAAA,EACpD,EAAI,EAAA,oBAAA;AACN,CAAC;;;;;"}

package/dist/index.d.ts

@@ -14,17 +14,18 @@ import { Schema } from 'jsonschema';
 import { TemplateInfo } from '@backstage/plugin-scaffolder-common';
 import { UserEntity } from '@backstage/catalog-model';
 import { Writable } from 'stream';
+import { z } from 'zod';
 
 /**
  * ActionContext is passed into scaffolder actions.
  * @public
  */
-export declare type ActionContext<TInput extends JsonObject> = {
+export declare type ActionContext<TActionInput extends JsonObject> = {
     logger: Logger;
     logStream: Writable;
     secrets?: TaskSecrets;
     workspacePath: string;
-    input: TInput;
+    input: TActionInput;
     output(name: string, value: JsonValue): void;
     /**
      * Creates a temporary directory for use by the action, which is then cleaned up automatically.
@@ -53,10 +54,10 @@ export declare type ActionContext<TInput extends JsonObject> = {
 
 /**
  * This function is used to create new template actions to get type safety.
- *
+ * Will convert zod schemas to json schemas for use throughout the system.
  * @public
  */
-export declare const createTemplateAction: <TInput extends JsonObject>(templateAction: TemplateAction<TInput>) => TemplateAction<TInput>;
+export declare const createTemplateAction: <TParams, TInputSchema extends z.ZodType<any, z.ZodTypeDef, any> | Schema = {}, TOutputSchema extends z.ZodType<any, z.ZodTypeDef, any> | Schema = {}, TActionInput = TInputSchema extends z.ZodType<any, any, infer IReturn> ? IReturn : TParams>(action: TemplateActionOptions<TActionInput, TInputSchema, TOutputSchema>) => TemplateAction<TActionInput>;
 
 /* Excluded from this release type: ScaffolderActionsExtensionPoint */
 
@@ -72,7 +73,7 @@ export declare type TaskSecrets = Record<string, string> & {
 };
 
 /** @public */
-export declare type TemplateAction<TInput extends JsonObject> = {
+export declare type TemplateAction<TActionInput = unknown> = {
     id: string;
     description?: string;
     examples?: {
@@ -84,7 +85,23 @@ export declare type TemplateAction<TInput extends JsonObject> = {
         input?: Schema;
         output?: Schema;
     };
-    handler: (ctx: ActionContext<TInput>) => Promise<void>;
+    handler: (ctx: ActionContext<TActionInput>) => Promise<void>;
+};
+
+/** @public */
+export declare type TemplateActionOptions<TActionInput = {}, TInputSchema extends Schema | z.ZodType = {}, TOutputSchema extends Schema | z.ZodType = {}> = {
+    id: string;
+    description?: string;
+    examples?: {
+        description: string;
+        example: string;
+    }[];
+    supportsDryRun?: boolean;
+    schema?: {
+        input?: TInputSchema;
+        output?: TOutputSchema;
+    };
+    handler: (ctx: ActionContext<TActionInput>) => Promise<void>;
 };
 
 export { }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-scaffolder-node",
   "description": "The plugin-scaffolder-node module for @backstage/plugin-scaffolder-backend",
-  "version": "0.1.1-next.0",
+  "version": "0.1.1-next.2",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -24,15 +24,17 @@
     "postpack": "backstage-cli package postpack"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "^0.4.1-next.0",
-    "@backstage/catalog-model": "^1.2.1-next.0",
-    "@backstage/plugin-scaffolder-common": "^1.2.6-next.0",
+    "@backstage/backend-plugin-api": "^0.4.1-next.2",
+    "@backstage/catalog-model": "^1.2.1-next.1",
+    "@backstage/plugin-scaffolder-common": "^1.2.6-next.1",
     "@backstage/types": "^1.0.2",
     "jsonschema": "^1.2.6",
-    "winston": "^3.2.1"
+    "winston": "^3.2.1",
+    "zod": "~3.18.0",
+    "zod-to-json-schema": "~3.18.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.22.4-next.0"
+    "@backstage/cli": "^0.22.4-next.1"
   },
   "files": [
     "alpha",