@backstage/plugin-scaffolder-node 0.0.0-nightly-20230124022523

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+# @backstage/plugin-scaffolder-node
+
+## 0.0.0-nightly-20230124022523
+
+### Minor Changes
+
+- d72866f0cc: New package that takes over some of the types and functionality from `@backstage/plugin-scaffolder-backend` that are shared with other modules
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.0.0-nightly-20230124022523

package/README.md

@@ -0,0 +1,3 @@
+# plugin-scaffolder-node
+
+Houses types and utilities for building scaffolder-related modules.

package/alpha/package.json

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

package/dist/index.alpha.d.ts

@@ -0,0 +1,102 @@
+/**
+ * The scaffolder-node module for `@backstage/plugin-scaffolder-backend`.
+ *
+ * @packageDocumentation
+ */
+
+/// <reference types="node" />
+
+import { ExtensionPoint } from '@backstage/backend-plugin-api';
+import { JsonObject } from '@backstage/types';
+import { JsonValue } from '@backstage/types';
+import { Logger } from 'winston';
+import { Schema } from 'jsonschema';
+import { TemplateInfo } from '@backstage/plugin-scaffolder-common';
+import { UserEntity } from '@backstage/catalog-model';
+import { Writable } from 'stream';
+
+/**
+ * ActionContext is passed into scaffolder actions.
+ * @public
+ */
+export declare type ActionContext<TInput extends JsonObject> = {
+    logger: Logger;
+    logStream: Writable;
+    secrets?: TaskSecrets;
+    workspacePath: string;
+    input: TInput;
+    output(name: string, value: JsonValue): void;
+    /**
+     * Creates a temporary directory for use by the action, which is then cleaned up automatically.
+     */
+    createTemporaryDirectory(): Promise<string>;
+    templateInfo?: TemplateInfo;
+    /**
+     * Whether this action invocation is a dry-run or not.
+     * This will only ever be true if the actions as marked as supporting dry-runs.
+     */
+    isDryRun?: boolean;
+    /**
+     * The user which triggered the action.
+     */
+    user?: {
+        /**
+         * The decorated entity from the Catalog
+         */
+        entity?: UserEntity;
+        /**
+         * An entity ref for the author of the task
+         */
+        ref?: string;
+    };
+};
+
+/**
+ * This function is used to create new template actions to get type safety.
+ *
+ * @public
+ */
+export declare const createTemplateAction: <TInput extends JsonObject>(templateAction: TemplateAction<TInput>) => TemplateAction<TInput>;
+
+/**
+ * Extension point for managing scaffolder actions.
+ *
+ * @alpha
+ */
+export declare interface ScaffolderActionsExtensionPoint {
+    addActions(...actions: TemplateAction<any>[]): void;
+}
+
+/**
+ * Extension point for managing scaffolder actions.
+ *
+ * @alpha
+ */
+export declare const scaffolderActionsExtensionPoint: ExtensionPoint<ScaffolderActionsExtensionPoint>;
+
+/**
+ * TaskSecrets
+ *
+ * @public
+ */
+export declare type TaskSecrets = Record<string, string> & {
+    backstageToken?: string;
+};
+
+/** @public */
+export declare type TemplateAction<TInput extends JsonObject> = {
+    id: string;
+    description?: string;
+    examples?: {
+        description: string;
+        example: string;
+    }[];
+    supportsDryRun?: boolean;
+    schema?: {
+        input?: Schema;
+        output?: Schema;
+    };
+    handler: (ctx: ActionContext<TInput>) => Promise<void>;
+};
+
+export { }

package/dist/index.beta.d.ts

@@ -0,0 +1,90 @@
+/**
+ * The scaffolder-node module for `@backstage/plugin-scaffolder-backend`.
+ *
+ * @packageDocumentation
+ */
+
+/// <reference types="node" />
+
+import { ExtensionPoint } from '@backstage/backend-plugin-api';
+import { JsonObject } from '@backstage/types';
+import { JsonValue } from '@backstage/types';
+import { Logger } from 'winston';
+import { Schema } from 'jsonschema';
+import { TemplateInfo } from '@backstage/plugin-scaffolder-common';
+import { UserEntity } from '@backstage/catalog-model';
+import { Writable } from 'stream';
+
+/**
+ * ActionContext is passed into scaffolder actions.
+ * @public
+ */
+export declare type ActionContext<TInput extends JsonObject> = {
+    logger: Logger;
+    logStream: Writable;
+    secrets?: TaskSecrets;
+    workspacePath: string;
+    input: TInput;
+    output(name: string, value: JsonValue): void;
+    /**
+     * Creates a temporary directory for use by the action, which is then cleaned up automatically.
+     */
+    createTemporaryDirectory(): Promise<string>;
+    templateInfo?: TemplateInfo;
+    /**
+     * Whether this action invocation is a dry-run or not.
+     * This will only ever be true if the actions as marked as supporting dry-runs.
+     */
+    isDryRun?: boolean;
+    /**
+     * The user which triggered the action.
+     */
+    user?: {
+        /**
+         * The decorated entity from the Catalog
+         */
+        entity?: UserEntity;
+        /**
+         * An entity ref for the author of the task
+         */
+        ref?: string;
+    };
+};
+
+/**
+ * This function is used to create new template actions to get type safety.
+ *
+ * @public
+ */
+export declare const createTemplateAction: <TInput extends JsonObject>(templateAction: TemplateAction<TInput>) => TemplateAction<TInput>;
+
+/* Excluded from this release type: ScaffolderActionsExtensionPoint */
+
+/* Excluded from this release type: scaffolderActionsExtensionPoint */
+
+/**
+ * TaskSecrets
+ *
+ * @public
+ */
+export declare type TaskSecrets = Record<string, string> & {
+    backstageToken?: string;
+};
+
+/** @public */
+export declare type TemplateAction<TInput extends JsonObject> = {
+    id: string;
+    description?: string;
+    examples?: {
+        description: string;
+        example: string;
+    }[];
+    supportsDryRun?: boolean;
+    schema?: {
+        input?: Schema;
+        output?: Schema;
+    };
+    handler: (ctx: ActionContext<TInput>) => Promise<void>;
+};
+
+export { }

package/dist/index.cjs.js

@@ -0,0 +1,17 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+
+const createTemplateAction = (templateAction) => {
+  return templateAction;
+};
+
+const scaffolderActionsExtensionPoint = backendPluginApi.createExtensionPoint({
+  id: "scaffolder.actions"
+});
+
+exports.createTemplateAction = createTemplateAction;
+exports.scaffolderActionsExtensionPoint = scaffolderActionsExtensionPoint;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +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;;;;;"}

package/dist/index.d.ts

@@ -0,0 +1,90 @@
+/**
+ * The scaffolder-node module for `@backstage/plugin-scaffolder-backend`.
+ *
+ * @packageDocumentation
+ */
+
+/// <reference types="node" />
+
+import { ExtensionPoint } from '@backstage/backend-plugin-api';
+import { JsonObject } from '@backstage/types';
+import { JsonValue } from '@backstage/types';
+import { Logger } from 'winston';
+import { Schema } from 'jsonschema';
+import { TemplateInfo } from '@backstage/plugin-scaffolder-common';
+import { UserEntity } from '@backstage/catalog-model';
+import { Writable } from 'stream';
+
+/**
+ * ActionContext is passed into scaffolder actions.
+ * @public
+ */
+export declare type ActionContext<TInput extends JsonObject> = {
+    logger: Logger;
+    logStream: Writable;
+    secrets?: TaskSecrets;
+    workspacePath: string;
+    input: TInput;
+    output(name: string, value: JsonValue): void;
+    /**
+     * Creates a temporary directory for use by the action, which is then cleaned up automatically.
+     */
+    createTemporaryDirectory(): Promise<string>;
+    templateInfo?: TemplateInfo;
+    /**
+     * Whether this action invocation is a dry-run or not.
+     * This will only ever be true if the actions as marked as supporting dry-runs.
+     */
+    isDryRun?: boolean;
+    /**
+     * The user which triggered the action.
+     */
+    user?: {
+        /**
+         * The decorated entity from the Catalog
+         */
+        entity?: UserEntity;
+        /**
+         * An entity ref for the author of the task
+         */
+        ref?: string;
+    };
+};
+
+/**
+ * This function is used to create new template actions to get type safety.
+ *
+ * @public
+ */
+export declare const createTemplateAction: <TInput extends JsonObject>(templateAction: TemplateAction<TInput>) => TemplateAction<TInput>;
+
+/* Excluded from this release type: ScaffolderActionsExtensionPoint */
+
+/* Excluded from this release type: scaffolderActionsExtensionPoint */
+
+/**
+ * TaskSecrets
+ *
+ * @public
+ */
+export declare type TaskSecrets = Record<string, string> & {
+    backstageToken?: string;
+};
+
+/** @public */
+export declare type TemplateAction<TInput extends JsonObject> = {
+    id: string;
+    description?: string;
+    examples?: {
+        description: string;
+        example: string;
+    }[];
+    supportsDryRun?: boolean;
+    schema?: {
+        input?: Schema;
+        output?: Schema;
+    };
+    handler: (ctx: ActionContext<TInput>) => Promise<void>;
+};
+
+export { }

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@backstage/plugin-scaffolder-node",
+  "description": "The plugin-scaffolder-node module for @backstage/plugin-scaffolder-backend",
+  "version": "0.0.0-nightly-20230124022523",
+  "main": "dist/index.cjs.js",
+  "types": "dist/index.d.ts",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public",
+    "alphaTypes": "dist/index.alpha.d.ts",
+    "main": "dist/index.cjs.js",
+    "types": "dist/index.d.ts"
+  },
+  "backstage": {
+    "role": "node-library"
+  },
+  "scripts": {
+    "start": "backstage-cli package start",
+    "build": "backstage-cli package build --experimental-type-build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "clean": "backstage-cli package clean",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack"
+  },
+  "dependencies": {
+    "@backstage/backend-plugin-api": "^0.0.0-nightly-20230124022523",
+    "@backstage/catalog-model": "^1.1.5",
+    "@backstage/plugin-scaffolder-common": "^1.2.4",
+    "@backstage/types": "^1.0.2",
+    "jsonschema": "^1.2.6",
+    "winston": "^3.2.1"
+  },
+  "devDependencies": {
+    "@backstage/cli": "^0.22.1"
+  },
+  "files": [
+    "alpha",
+    "dist"
+  ]
+}