@backstage/plugin-scaffolder-common 0.3.0 → 1.0.1

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # @backstage/plugin-scaffolder-common
 
+## 1.0.1
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/catalog-model@1.0.1
+
+## 1.0.1-next.0
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/catalog-model@1.0.1-next.0
+
+## 1.0.0
+
+### Major Changes
+
+- b58c70c223: This package has been promoted to v1.0! To understand how this change affects the package, please check out our [versioning policy](https://backstage.io/docs/overview/versioning-policy).
+
+### Patch Changes
+
+- c8475ab3bb: Adding some documentation for exported things
+- Updated dependencies
+  - @backstage/catalog-model@1.0.0
+  - @backstage/types@1.0.0
+
 ## 0.3.0
 
 ### Minor Changes

package/dist/index.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.cjs.js","sources":["../src/TemplateEntityV1beta3.ts"],"sourcesContent":["/*\n * Copyright 2020 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 {\n  Entity,\n  entityKindSchemaValidator,\n  KindValidator,\n} from '@backstage/catalog-model';\nimport { JsonObject } from '@backstage/types';\nimport schema from './Template.v1beta3.schema.json';\n\n/**\n * Backstage catalog Template kind Entity. Templates are used by the Scaffolder\n * plugin to create new entities, such as Components.\n *\n * @public\n */\nexport interface TemplateEntityV1beta3 extends Entity {\n  apiVersion: 'scaffolder.backstage.io/v1beta3';\n  kind: 'Template';\n  spec: {\n    type: string;\n    parameters?: JsonObject | JsonObject[];\n    steps: Array<{\n      id?: string;\n      name?: string;\n      action: string;\n      input?: JsonObject;\n      if?: string | boolean;\n    }>;\n    output?: { [name: string]: string };\n    owner?: string;\n  };\n}\n\nconst validator = entityKindSchemaValidator(schema);\n\n/**\n * Entity data validator for {@link TemplateEntityV1beta3}.\n *\n * @public\n */\nexport const templateEntityV1beta3Validator: KindValidator = {\n  // TODO(freben): Emulate the old KindValidator until we fix that type\n  async check(data: Entity) {\n    return validator(data) === data;\n  },\n};\n"],"names":["entityKindSchemaValidator"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgDA,MAAM,YAAYA,uCAA0B;MAO/B,iCAAgD;AAAA,QAErD,MAAM,MAAc;AACxB,WAAO,UAAU,UAAU;AAAA;AAAA;;;;"}
+{"version":3,"file":"index.cjs.js","sources":["../src/TemplateEntityV1beta3.ts"],"sourcesContent":["/*\n * Copyright 2020 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 {\n  Entity,\n  entityKindSchemaValidator,\n  KindValidator,\n} from '@backstage/catalog-model';\nimport { JsonObject } from '@backstage/types';\nimport schema from './Template.v1beta3.schema.json';\n\n/**\n * Backstage catalog Template kind Entity. Templates are used by the Scaffolder\n * plugin to create new entities, such as Components.\n *\n * @public\n */\nexport interface TemplateEntityV1beta3 extends Entity {\n  /**\n   * The apiVersion string of the TaskSpec.\n   */\n  apiVersion: 'scaffolder.backstage.io/v1beta3';\n  /**\n   * The kind of the entity\n   */\n  kind: 'Template';\n  /**\n   * The specification of the Template Entity\n   */\n  spec: {\n    /**\n     * The type that the Template will create. For example service, website or library.\n     */\n    type: string;\n    /**\n     * This is a JSONSchema or an array of JSONSchema's which is used to render a form in the frontend\n     * to collect user input and validate it against that schema. This can then be used in the `steps` part below to template\n     * variables passed from the user into each action in the template.\n     */\n    parameters?: JsonObject | JsonObject[];\n    /**\n     * A list of steps to be executed in sequence which are defined by the template. These steps are a list of the underlying\n     * javascript action and some optional input parameters that may or may not have been collected from the end user.\n     */\n    steps: Array<{\n      id?: string;\n      name?: string;\n      action: string;\n      input?: JsonObject;\n      if?: string | boolean;\n    }>;\n    /**\n     * The output is an object where template authors can pull out information from template actions and return them in a known standard way.\n     */\n    output?: { [name: string]: string };\n    /**\n     * The owner entityRef of the TemplateEntity\n     */\n    owner?: string;\n  };\n}\n\nconst validator = entityKindSchemaValidator(schema);\n\n/**\n * Entity data validator for {@link TemplateEntityV1beta3}.\n *\n * @public\n */\nexport const templateEntityV1beta3Validator: KindValidator = {\n  // TODO(freben): Emulate the old KindValidator until we fix that type\n  async check(data: Entity) {\n    return validator(data) === data;\n  },\n};\n"],"names":["entityKindSchemaValidator"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAIA,MAAM,SAAS,GAAGA,sCAAyB,CAAC,MAAM,CAAC,CAAC;AACxC,MAAC,8BAA8B,GAAG;AAC9C,EAAE,MAAM,KAAK,CAAC,IAAI,EAAE;AACpB,IAAI,OAAO,SAAS,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC;AACpC,GAAG;AACH;;;;"}

package/dist/index.d.ts

@@ -8,7 +8,13 @@ import { Entity, KindValidator } from '@backstage/catalog-model';
  * @public
  */
 declare type TemplateInfo = {
+    /**
+     * The entityRef of the template
+     */
     entityRef: string;
+    /**
+     * Where the template is stored, so we can resolve relative paths for things like `fetch:template` paths.
+     */
     baseUrl?: string;
 };
 /**
@@ -17,10 +23,25 @@ declare type TemplateInfo = {
  * @public
  */
 interface TaskStep {
+    /**
+     * A unqiue identifier for this step.
+     */
     id: string;
+    /**
+     * A display name to show the user.
+     */
     name: string;
+    /**
+     * The underlying action ID that will be called as part of running this step.
+     */
     action: string;
+    /**
+     * Additional data that will be passed to the action.
+     */
     input?: JsonObject;
+    /**
+     * When this is false, or if the templated value string evaluates to something that is falsy the step will be skipped.
+     */
     if?: string | boolean;
 }
 /**
@@ -30,12 +51,30 @@ interface TaskStep {
  * @public
  */
 interface TaskSpecV1beta3 {
+    /**
+     * The apiVersion string of the TaskSpec.
+     */
     apiVersion: 'scaffolder.backstage.io/v1beta3';
+    /**
+     * This is a JSONSchema which is used to render a form in the frontend
+     * to collect user input and validate it against that schema. This can then be used in the `steps` part below to template
+     * variables passed from the user into each action in the template.
+     */
     parameters: JsonObject;
+    /**
+     * A list of steps to be executed in sequence which are defined by the template. These steps are a list of the underlying
+     * javascript action and some optional input parameters that may or may not have been collected from the end user.
+     */
     steps: TaskStep[];
+    /**
+     * The output is an object where template authors can pull out information from template actions and return them in a known standard way.
+     */
     output: {
         [name: string]: JsonValue;
     };
+    /**
+     * Some information about the template that is stored on the task spec.
+     */
     templateInfo?: TemplateInfo;
 }
 /**
@@ -52,11 +91,32 @@ declare type TaskSpec = TaskSpecV1beta3;
  * @public
  */
 interface TemplateEntityV1beta3 extends Entity {
+    /**
+     * The apiVersion string of the TaskSpec.
+     */
     apiVersion: 'scaffolder.backstage.io/v1beta3';
+    /**
+     * The kind of the entity
+     */
     kind: 'Template';
+    /**
+     * The specification of the Template Entity
+     */
     spec: {
+        /**
+         * The type that the Template will create. For example service, website or library.
+         */
         type: string;
+        /**
+         * This is a JSONSchema or an array of JSONSchema's which is used to render a form in the frontend
+         * to collect user input and validate it against that schema. This can then be used in the `steps` part below to template
+         * variables passed from the user into each action in the template.
+         */
         parameters?: JsonObject | JsonObject[];
+        /**
+         * A list of steps to be executed in sequence which are defined by the template. These steps are a list of the underlying
+         * javascript action and some optional input parameters that may or may not have been collected from the end user.
+         */
         steps: Array<{
             id?: string;
             name?: string;
@@ -64,9 +124,15 @@ interface TemplateEntityV1beta3 extends Entity {
             input?: JsonObject;
             if?: string | boolean;
         }>;
+        /**
+         * The output is an object where template authors can pull out information from template actions and return them in a known standard way.
+         */
         output?: {
             [name: string]: string;
         };
+        /**
+         * The owner entityRef of the TemplateEntity
+         */
         owner?: string;
     };
 }

package/dist/index.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.esm.js","sources":["../src/TemplateEntityV1beta3.ts"],"sourcesContent":["/*\n * Copyright 2020 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 {\n  Entity,\n  entityKindSchemaValidator,\n  KindValidator,\n} from '@backstage/catalog-model';\nimport { JsonObject } from '@backstage/types';\nimport schema from './Template.v1beta3.schema.json';\n\n/**\n * Backstage catalog Template kind Entity. Templates are used by the Scaffolder\n * plugin to create new entities, such as Components.\n *\n * @public\n */\nexport interface TemplateEntityV1beta3 extends Entity {\n  apiVersion: 'scaffolder.backstage.io/v1beta3';\n  kind: 'Template';\n  spec: {\n    type: string;\n    parameters?: JsonObject | JsonObject[];\n    steps: Array<{\n      id?: string;\n      name?: string;\n      action: string;\n      input?: JsonObject;\n      if?: string | boolean;\n    }>;\n    output?: { [name: string]: string };\n    owner?: string;\n  };\n}\n\nconst validator = entityKindSchemaValidator(schema);\n\n/**\n * Entity data validator for {@link TemplateEntityV1beta3}.\n *\n * @public\n */\nexport const templateEntityV1beta3Validator: KindValidator = {\n  // TODO(freben): Emulate the old KindValidator until we fix that type\n  async check(data: Entity) {\n    return validator(data) === data;\n  },\n};\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgDA,MAAM,YAAY,0BAA0B;MAO/B,iCAAgD;AAAA,QAErD,MAAM,MAAc;AACxB,WAAO,UAAU,UAAU;AAAA;AAAA;;;;"}
+{"version":3,"file":"index.esm.js","sources":["../src/TemplateEntityV1beta3.ts"],"sourcesContent":["/*\n * Copyright 2020 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 {\n  Entity,\n  entityKindSchemaValidator,\n  KindValidator,\n} from '@backstage/catalog-model';\nimport { JsonObject } from '@backstage/types';\nimport schema from './Template.v1beta3.schema.json';\n\n/**\n * Backstage catalog Template kind Entity. Templates are used by the Scaffolder\n * plugin to create new entities, such as Components.\n *\n * @public\n */\nexport interface TemplateEntityV1beta3 extends Entity {\n  /**\n   * The apiVersion string of the TaskSpec.\n   */\n  apiVersion: 'scaffolder.backstage.io/v1beta3';\n  /**\n   * The kind of the entity\n   */\n  kind: 'Template';\n  /**\n   * The specification of the Template Entity\n   */\n  spec: {\n    /**\n     * The type that the Template will create. For example service, website or library.\n     */\n    type: string;\n    /**\n     * This is a JSONSchema or an array of JSONSchema's which is used to render a form in the frontend\n     * to collect user input and validate it against that schema. This can then be used in the `steps` part below to template\n     * variables passed from the user into each action in the template.\n     */\n    parameters?: JsonObject | JsonObject[];\n    /**\n     * A list of steps to be executed in sequence which are defined by the template. These steps are a list of the underlying\n     * javascript action and some optional input parameters that may or may not have been collected from the end user.\n     */\n    steps: Array<{\n      id?: string;\n      name?: string;\n      action: string;\n      input?: JsonObject;\n      if?: string | boolean;\n    }>;\n    /**\n     * The output is an object where template authors can pull out information from template actions and return them in a known standard way.\n     */\n    output?: { [name: string]: string };\n    /**\n     * The owner entityRef of the TemplateEntity\n     */\n    owner?: string;\n  };\n}\n\nconst validator = entityKindSchemaValidator(schema);\n\n/**\n * Entity data validator for {@link TemplateEntityV1beta3}.\n *\n * @public\n */\nexport const templateEntityV1beta3Validator: KindValidator = {\n  // TODO(freben): Emulate the old KindValidator until we fix that type\n  async check(data: Entity) {\n    return validator(data) === data;\n  },\n};\n"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAIA,MAAM,SAAS,GAAG,yBAAyB,CAAC,MAAM,CAAC,CAAC;AACxC,MAAC,8BAA8B,GAAG;AAC9C,EAAE,MAAM,KAAK,CAAC,IAAI,EAAE;AACpB,IAAI,OAAO,SAAS,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC;AACpC,GAAG;AACH;;;;"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-scaffolder-common",
   "description": "Common functionalities for the scaffolder, to be shared between scaffolder and scaffolder-backend plugin",
-  "version": "0.3.0",
+  "version": "1.0.1",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -39,12 +39,12 @@
     "url": "https://github.com/backstage/backstage/issues"
   },
   "dependencies": {
-    "@backstage/catalog-model": "^0.13.0",
-    "@backstage/types": "^0.1.3"
+    "@backstage/catalog-model": "^1.0.1",
+    "@backstage/types": "^1.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.15.2"
+    "@backstage/cli": "^0.17.0"
   },
-  "gitHead": "60c4e39d1fcaeb10d6488ada1d907f34dc2a105a",
+  "gitHead": "e0e44c433319711c2fb8b175db411a621f7aaec2",
   "module": "dist/index.esm.js"
 }