@backstage/plugin-scaffolder-node 0.9.0 → 0.9.1-next.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @backstage/plugin-scaffolder-node
 
+## 0.9.1-next.0
+
+### Patch Changes
+
+- dbde180: An internal refactor which adds additional types to experimental checkpoints
+- Updated dependencies
+  - @backstage/integration@1.17.1-next.0
+  - @backstage/backend-plugin-api@1.4.0
+  - @backstage/catalog-model@1.7.4
+  - @backstage/errors@1.2.7
+  - @backstage/types@1.2.1
+  - @backstage/plugin-scaffolder-common@1.5.11
+
 ## 0.9.0
 
 ### Minor Changes

package/dist/alpha.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"alpha.cjs.js","sources":["../src/alpha/index.ts"],"sourcesContent":["/*\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 {\n  TaskBroker,\n  TemplateAction,\n  TemplateFilter,\n  TemplateGlobal,\n} from '@backstage/plugin-scaffolder-node';\nimport { CreatedTemplateFilter } from './filters';\nimport { CreatedTemplateGlobal } from './globals';\n\nexport * from '../tasks/alpha';\nexport * from './filters';\nexport * from './globals';\nexport * from './types';\n\n/**\n * Extension point for managing scaffolder actions.\n *\n * @alpha\n */\nexport interface ScaffolderActionsExtensionPoint {\n  addActions(...actions: TemplateAction<any, any, 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\n/**\n * Extension point for replacing the scaffolder task broker.\n *\n * @alpha\n */\nexport interface ScaffolderTaskBrokerExtensionPoint {\n  setTaskBroker(taskBroker: TaskBroker): void;\n}\n\n/**\n * Extension point for replacing the scaffolder task broker.\n *\n * @alpha\n */\nexport const scaffolderTaskBrokerExtensionPoint =\n  createExtensionPoint<ScaffolderTaskBrokerExtensionPoint>({\n    id: 'scaffolder.taskBroker',\n  });\n\n/**\n * Extension point for adding template filters and globals.\n *\n * @alpha\n */\nexport interface ScaffolderTemplatingExtensionPoint {\n  addTemplateFilters(\n    filters: Record<string, TemplateFilter> | CreatedTemplateFilter<any, any>[],\n  ): void;\n\n  addTemplateGlobals(\n    globals: Record<string, TemplateGlobal> | CreatedTemplateGlobal[],\n  ): void;\n}\n\n/**\n * Extension point for adding template filters and globals.\n *\n * @alpha\n */\nexport const scaffolderTemplatingExtensionPoint =\n  createExtensionPoint<ScaffolderTemplatingExtensionPoint>({\n    id: 'scaffolder.templating',\n  });\n\n/**\n * Autocomplete handler for the scaffolder.\n * @alpha\n */\nexport type AutocompleteHandler = ({\n  resource,\n  token,\n  context,\n}: {\n  resource: string;\n  token: string;\n  context: Record<string, string>;\n}) => Promise<{ results: { title?: string; id: string }[] }>;\n\n/**\n * Extension point for adding autocomplete handler providers\n * @alpha\n */\nexport interface ScaffolderAutocompleteExtensionPoint {\n  addAutocompleteProvider({\n    id,\n    handler,\n  }: {\n    id: string;\n    handler: AutocompleteHandler;\n  }): void;\n}\n\n/**\n * Extension point for adding autocomplete handlers.\n *\n * @alpha\n */\nexport const scaffolderAutocompleteExtensionPoint =\n  createExtensionPoint<ScaffolderAutocompleteExtensionPoint>({\n    id: 'scaffolder.autocomplete',\n  });\n\n/**\n * This provider has to be implemented to make it possible to serialize/deserialize scaffolder workspace.\n *\n * @alpha\n */\nexport interface WorkspaceProvider {\n  serializeWorkspace({\n    path,\n    taskId,\n  }: {\n    path: string;\n    taskId: string;\n  }): Promise<void>;\n\n  cleanWorkspace(options: { taskId: string }): Promise<void>;\n\n  rehydrateWorkspace(options: {\n    taskId: string;\n    targetPath: string;\n  }): Promise<void>;\n}\n\n/**\n * Extension point for adding workspace providers.\n *\n * @alpha\n */\nexport interface ScaffolderWorkspaceProviderExtensionPoint {\n  addProviders(providers: Record<string, WorkspaceProvider>): void;\n}\n\n/**\n * Extension point for adding workspace providers.\n *\n * @alpha\n */\nexport const scaffolderWorkspaceProviderExtensionPoint =\n  createExtensionPoint<ScaffolderWorkspaceProviderExtensionPoint>({\n    id: 'scaffolder.workspace.provider',\n  });\n"],"names":["createExtensionPoint"],"mappings":";;;;;;;AA6CO,MAAM,kCACXA,qCAAsD,CAAA;AAAA,EACpD,EAAI,EAAA;AACN,CAAC;AAgBI,MAAM,qCACXA,qCAAyD,CAAA;AAAA,EACvD,EAAI,EAAA;AACN,CAAC;AAsBI,MAAM,qCACXA,qCAAyD,CAAA;AAAA,EACvD,EAAI,EAAA;AACN,CAAC;AAmCI,MAAM,uCACXA,qCAA2D,CAAA;AAAA,EACzD,EAAI,EAAA;AACN,CAAC;AAsCI,MAAM,4CACXA,qCAAgE,CAAA;AAAA,EAC9D,EAAI,EAAA;AACN,CAAC;;;;;;;;;;;;;"}
+{"version":3,"file":"alpha.cjs.js","sources":["../src/alpha/index.ts"],"sourcesContent":["/*\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 {\n  TaskBroker,\n  TemplateAction,\n  TemplateFilter,\n  TemplateGlobal,\n} from '@backstage/plugin-scaffolder-node';\nimport { CreatedTemplateFilter } from './filters';\nimport { CreatedTemplateGlobal } from './globals';\n\nexport * from '../tasks/alpha';\nexport * from './filters';\nexport * from './globals';\nexport * from './types';\nexport * from './checkpoints';\n\n/**\n * Extension point for managing scaffolder actions.\n *\n * @alpha\n */\nexport interface ScaffolderActionsExtensionPoint {\n  addActions(...actions: TemplateAction<any, any, 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\n/**\n * Extension point for replacing the scaffolder task broker.\n *\n * @alpha\n */\nexport interface ScaffolderTaskBrokerExtensionPoint {\n  setTaskBroker(taskBroker: TaskBroker): void;\n}\n\n/**\n * Extension point for replacing the scaffolder task broker.\n *\n * @alpha\n */\nexport const scaffolderTaskBrokerExtensionPoint =\n  createExtensionPoint<ScaffolderTaskBrokerExtensionPoint>({\n    id: 'scaffolder.taskBroker',\n  });\n\n/**\n * Extension point for adding template filters and globals.\n *\n * @alpha\n */\nexport interface ScaffolderTemplatingExtensionPoint {\n  addTemplateFilters(\n    filters: Record<string, TemplateFilter> | CreatedTemplateFilter<any, any>[],\n  ): void;\n\n  addTemplateGlobals(\n    globals: Record<string, TemplateGlobal> | CreatedTemplateGlobal[],\n  ): void;\n}\n\n/**\n * Extension point for adding template filters and globals.\n *\n * @alpha\n */\nexport const scaffolderTemplatingExtensionPoint =\n  createExtensionPoint<ScaffolderTemplatingExtensionPoint>({\n    id: 'scaffolder.templating',\n  });\n\n/**\n * Autocomplete handler for the scaffolder.\n * @alpha\n */\nexport type AutocompleteHandler = ({\n  resource,\n  token,\n  context,\n}: {\n  resource: string;\n  token: string;\n  context: Record<string, string>;\n}) => Promise<{ results: { title?: string; id: string }[] }>;\n\n/**\n * Extension point for adding autocomplete handler providers\n * @alpha\n */\nexport interface ScaffolderAutocompleteExtensionPoint {\n  addAutocompleteProvider({\n    id,\n    handler,\n  }: {\n    id: string;\n    handler: AutocompleteHandler;\n  }): void;\n}\n\n/**\n * Extension point for adding autocomplete handlers.\n *\n * @alpha\n */\nexport const scaffolderAutocompleteExtensionPoint =\n  createExtensionPoint<ScaffolderAutocompleteExtensionPoint>({\n    id: 'scaffolder.autocomplete',\n  });\n\n/**\n * This provider has to be implemented to make it possible to serialize/deserialize scaffolder workspace.\n *\n * @alpha\n */\nexport interface WorkspaceProvider {\n  serializeWorkspace({\n    path,\n    taskId,\n  }: {\n    path: string;\n    taskId: string;\n  }): Promise<void>;\n\n  cleanWorkspace(options: { taskId: string }): Promise<void>;\n\n  rehydrateWorkspace(options: {\n    taskId: string;\n    targetPath: string;\n  }): Promise<void>;\n}\n\n/**\n * Extension point for adding workspace providers.\n *\n * @alpha\n */\nexport interface ScaffolderWorkspaceProviderExtensionPoint {\n  addProviders(providers: Record<string, WorkspaceProvider>): void;\n}\n\n/**\n * Extension point for adding workspace providers.\n *\n * @alpha\n */\nexport const scaffolderWorkspaceProviderExtensionPoint =\n  createExtensionPoint<ScaffolderWorkspaceProviderExtensionPoint>({\n    id: 'scaffolder.workspace.provider',\n  });\n"],"names":["createExtensionPoint"],"mappings":";;;;;;;AA8CO,MAAM,kCACXA,qCAAsD,CAAA;AAAA,EACpD,EAAI,EAAA;AACN,CAAC;AAgBI,MAAM,qCACXA,qCAAyD,CAAA;AAAA,EACvD,EAAI,EAAA;AACN,CAAC;AAsBI,MAAM,qCACXA,qCAAyD,CAAA;AAAA,EACvD,EAAI,EAAA;AACN,CAAC;AAmCI,MAAM,uCACXA,qCAA2D,CAAA;AAAA,EACzD,EAAI,EAAA;AACN,CAAC;AAsCI,MAAM,4CACXA,qCAAgE,CAAA;AAAA,EAC9D,EAAI,EAAA;AACN,CAAC;;;;;;;;;;;;;"}

package/dist/alpha.d.ts

@@ -100,6 +100,57 @@ declare const restoreWorkspace: (opts: {
     buffer?: Buffer;
 }) => Promise<void>;
 
+/**
+ * Options for updating a checkpoint in a task.
+ *
+ * @alpha
+ */
+type UpdateTaskCheckpointOptions = {
+    key: string;
+} & CheckpointStateValue;
+
+/**
+ * The status of a checkpoint, indicating whether it succeeded or failed.
+ *
+ * @alpha
+ */
+type CheckpointStatus = 'failed' | 'success';
+/**
+ * Represents the union of all possible checkpoint state values.
+ *
+ * @alpha
+ */
+type CheckpointStateValue<T extends JsonValue = JsonValue> = {
+    status: 'failed';
+    reason: string;
+} | {
+    status: 'success';
+    value: T;
+};
+/**
+ * A map of checkpoint keys to their states.
+ *
+ * @alpha
+ */
+type CheckpointState = {
+    [key: string]: CheckpointStateValue;
+};
+/**
+ * Context for checkpoint function invocation.
+ *
+ * @alpha
+ */
+type CheckpointContext<T extends JsonValue | void = JsonValue> = {
+    /**
+     * Unique key for the checkpoint
+     */
+    key: string;
+    /**
+     * Function to execute for the checkpoint
+     */
+    fn: () => Promise<T> | T;
+};
+
 /**
  * Extension point for managing scaffolder actions.
  *
@@ -206,4 +257,4 @@ interface ScaffolderWorkspaceProviderExtensionPoint {
  */
 declare const scaffolderWorkspaceProviderExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<ScaffolderWorkspaceProviderExtensionPoint>;
 
-export { type AutocompleteHandler, type CreatedTemplateFilter, type CreatedTemplateGlobal, type CreatedTemplateGlobalFunction, type CreatedTemplateGlobalValue, type ScaffolderActionsExtensionPoint, type ScaffolderAutocompleteExtensionPoint, type ScaffolderTaskBrokerExtensionPoint, type ScaffolderTemplatingExtensionPoint, type ScaffolderWorkspaceProviderExtensionPoint, type TemplateFilterExample, type TemplateGlobalFunctionExample, type WorkspaceProvider, type ZodFunctionSchema, createTemplateFilter, createTemplateGlobalFunction, createTemplateGlobalValue, restoreWorkspace, scaffolderActionsExtensionPoint, scaffolderAutocompleteExtensionPoint, scaffolderTaskBrokerExtensionPoint, scaffolderTemplatingExtensionPoint, scaffolderWorkspaceProviderExtensionPoint, serializeWorkspace };
+export { type AutocompleteHandler, type CheckpointContext, type CheckpointState, type CheckpointStateValue, type CheckpointStatus, type CreatedTemplateFilter, type CreatedTemplateGlobal, type CreatedTemplateGlobalFunction, type CreatedTemplateGlobalValue, type ScaffolderActionsExtensionPoint, type ScaffolderAutocompleteExtensionPoint, type ScaffolderTaskBrokerExtensionPoint, type ScaffolderTemplatingExtensionPoint, type ScaffolderWorkspaceProviderExtensionPoint, type TemplateFilterExample, type TemplateGlobalFunctionExample, type UpdateTaskCheckpointOptions, type WorkspaceProvider, type ZodFunctionSchema, createTemplateFilter, createTemplateGlobalFunction, createTemplateGlobalValue, restoreWorkspace, scaffolderActionsExtensionPoint, scaffolderAutocompleteExtensionPoint, scaffolderTaskBrokerExtensionPoint, scaffolderTemplatingExtensionPoint, scaffolderWorkspaceProviderExtensionPoint, serializeWorkspace };

package/dist/index.d.ts

@@ -1,6 +1,7 @@
-import { JsonObject, JsonValue, Observable, Expand } from '@backstage/types';
+import { JsonObject, Observable, JsonValue, Expand } from '@backstage/types';
 import { BackstageCredentials, LoggerService, UrlReaderService } from '@backstage/backend-plugin-api';
 import { TaskSpec, TemplateInfo } from '@backstage/plugin-scaffolder-common';
+import { UpdateTaskCheckpointOptions, CheckpointContext } from '@backstage/plugin-scaffolder-node/alpha';
 import { UserEntity } from '@backstage/catalog-model';
 import { Schema } from 'jsonschema';
 import { z } from 'zod';
@@ -100,15 +101,7 @@ interface TaskContext {
     getTaskState?(): Promise<{
         state?: JsonObject;
     } | undefined>;
-    updateCheckpoint?(options: {
-        key: string;
-        status: 'success';
-        value: JsonValue;
-    } | {
-        key: string;
-        status: 'failed';
-        reason: string;
-    }): Promise<void>;
+    updateCheckpoint?(options: UpdateTaskCheckpointOptions): Promise<void>;
     serializeWorkspace?(options: {
         path: string;
     }): Promise<void>;
@@ -182,10 +175,7 @@ type ActionContext<TActionInput extends JsonObject, TActionOutput extends JsonOb
     secrets?: TaskSecrets;
     workspacePath: string;
     input: TActionInput;
-    checkpoint<T extends JsonValue | void>(opts: {
-        key: string;
-        fn: () => Promise<T> | T;
-    }): Promise<T>;
+    checkpoint<T extends JsonValue | void>(opts: CheckpointContext<T>): Promise<T>;
     output(name: keyof TActionOutput, value: TActionOutput[keyof TActionOutput]): void;
     /**
      * Creates a temporary directory for use by the action, which is then cleaned up automatically.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-node",
-  "version": "0.9.0",
+  "version": "0.9.1-next.0",
   "description": "The plugin-scaffolder-node module for @backstage/plugin-scaffolder-backend",
   "backstage": {
     "role": "node-library",
@@ -62,12 +62,12 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "^1.4.0",
-    "@backstage/catalog-model": "^1.7.4",
-    "@backstage/errors": "^1.2.7",
-    "@backstage/integration": "^1.17.0",
-    "@backstage/plugin-scaffolder-common": "^1.5.11",
-    "@backstage/types": "^1.2.1",
+    "@backstage/backend-plugin-api": "1.4.0",
+    "@backstage/catalog-model": "1.7.4",
+    "@backstage/errors": "1.2.7",
+    "@backstage/integration": "1.17.1-next.0",
+    "@backstage/plugin-scaffolder-common": "1.5.11",
+    "@backstage/types": "1.2.1",
     "@isomorphic-git/pgp-plugin": "^0.0.7",
     "concat-stream": "^2.0.0",
     "fs-extra": "^11.2.0",
@@ -83,9 +83,9 @@
     "zod-to-json-schema": "^3.20.4"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^1.6.0",
-    "@backstage/cli": "^0.33.0",
-    "@backstage/config": "^1.3.2",
+    "@backstage/backend-test-utils": "1.7.0-next.0",
+    "@backstage/cli": "0.33.1-next.0",
+    "@backstage/config": "1.3.2",
     "@types/lodash": "^4.14.151"
   }
 }