@backstage/plugin-scaffolder-node 0.13.1-next.0 → 0.13.1

package/CHANGELOG.md

@@ -1,18 +1,10 @@
 # @backstage/plugin-scaffolder-node
 
-## 0.13.1-next.0
+## 0.13.1
 
 ### Patch Changes
 
-- Updated dependencies
-  - @backstage/backend-plugin-api@1.8.1-next.0
-  - @backstage/backend-test-utils@1.11.2-next.0
-  - @backstage/catalog-model@1.7.7
-  - @backstage/errors@1.2.7
-  - @backstage/integration@2.0.0
-  - @backstage/types@1.2.2
-  - @backstage/plugin-permission-common@0.9.7
-  - @backstage/plugin-scaffolder-common@2.0.0
+- 1fea538: Added `PermissionResourceRef` definitions for scaffolder resource types: `scaffolderTemplatePermissionResourceRef`, `scaffolderActionPermissionResourceRef`, and `scaffolderTaskPermissionResourceRef`. These are exported from `@backstage/plugin-scaffolder-node/alpha`.
 
 ## 0.13.0
 

package/dist/alpha.cjs.js

@@ -4,6 +4,8 @@ var backendPluginApi = require('@backstage/backend-plugin-api');
 var serializer = require('./tasks/serializer.cjs.js');
 var createTemplateFilter = require('./alpha/filters/createTemplateFilter.cjs.js');
 var createTemplateGlobal = require('./alpha/globals/createTemplateGlobal.cjs.js');
+var pluginPermissionNode = require('@backstage/plugin-permission-node');
+var alpha = require('@backstage/plugin-scaffolder-common/alpha');
 
 const scaffolderTaskBrokerExtensionPoint = backendPluginApi.createExtensionPoint({
   id: "scaffolder.taskBroker"
@@ -17,14 +19,29 @@ const scaffolderAutocompleteExtensionPoint = backendPluginApi.createExtensionPoi
 const scaffolderWorkspaceProviderExtensionPoint = backendPluginApi.createExtensionPoint({
   id: "scaffolder.workspace.provider"
 });
+const scaffolderTemplatePermissionResourceRef = pluginPermissionNode.createPermissionResourceRef().with({
+  pluginId: "scaffolder",
+  resourceType: alpha.RESOURCE_TYPE_SCAFFOLDER_TEMPLATE
+});
+const scaffolderActionPermissionResourceRef = pluginPermissionNode.createPermissionResourceRef().with({
+  pluginId: "scaffolder",
+  resourceType: alpha.RESOURCE_TYPE_SCAFFOLDER_ACTION
+});
+const scaffolderTaskPermissionResourceRef = pluginPermissionNode.createPermissionResourceRef().with({
+  pluginId: "scaffolder",
+  resourceType: alpha.RESOURCE_TYPE_SCAFFOLDER_TASK
+});
 
 exports.restoreWorkspace = serializer.restoreWorkspace;
 exports.serializeWorkspace = serializer.serializeWorkspace;
 exports.createTemplateFilter = createTemplateFilter.createTemplateFilter;
 exports.createTemplateGlobalFunction = createTemplateGlobal.createTemplateGlobalFunction;
 exports.createTemplateGlobalValue = createTemplateGlobal.createTemplateGlobalValue;
+exports.scaffolderActionPermissionResourceRef = scaffolderActionPermissionResourceRef;
 exports.scaffolderAutocompleteExtensionPoint = scaffolderAutocompleteExtensionPoint;
 exports.scaffolderTaskBrokerExtensionPoint = scaffolderTaskBrokerExtensionPoint;
+exports.scaffolderTaskPermissionResourceRef = scaffolderTaskPermissionResourceRef;
+exports.scaffolderTemplatePermissionResourceRef = scaffolderTemplatePermissionResourceRef;
 exports.scaffolderTemplatingExtensionPoint = scaffolderTemplatingExtensionPoint;
 exports.scaffolderWorkspaceProviderExtensionPoint = scaffolderWorkspaceProviderExtensionPoint;
 //# sourceMappingURL=alpha.cjs.js.map

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  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 replacing the scaffolder task broker.\n *\n * @alpha\n * @deprecated this extension point is planned to be removed, please reach out to us in an issue if you're using this extension point and your use cases.\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 * @deprecated this extension point is planned to be removed, please reach out to us in an issue if you're using this extension point and your use cases.\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":";;;;;;;AA+CO,MAAM,qCACXA,qCAAA,CAAyD;AAAA,EACvD,EAAA,EAAI;AACN,CAAC;AAsBI,MAAM,qCACXA,qCAAA,CAAyD;AAAA,EACvD,EAAA,EAAI;AACN,CAAC;AAmCI,MAAM,uCACXA,qCAAA,CAA2D;AAAA,EACzD,EAAA,EAAI;AACN,CAAC;AAsCI,MAAM,4CACXA,qCAAA,CAAgE;AAAA,EAC9D,EAAA,EAAI;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  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 replacing the scaffolder task broker.\n *\n * @alpha\n * @deprecated this extension point is planned to be removed, please reach out to us in an issue if you're using this extension point and your use cases.\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 * @deprecated this extension point is planned to be removed, please reach out to us in an issue if you're using this extension point and your use cases.\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\nimport { createPermissionResourceRef } from '@backstage/plugin-permission-node';\nimport {\n  RESOURCE_TYPE_SCAFFOLDER_TEMPLATE,\n  RESOURCE_TYPE_SCAFFOLDER_ACTION,\n  RESOURCE_TYPE_SCAFFOLDER_TASK,\n} from '@backstage/plugin-scaffolder-common/alpha';\nimport type {\n  TemplateEntityStepV1beta3,\n  TemplateParametersV1beta3,\n} from '@backstage/plugin-scaffolder-common';\nimport type { JsonObject } from '@backstage/types';\nimport type {\n  SerializedTask,\n  TaskFilter,\n} from '@backstage/plugin-scaffolder-node';\n\n/**\n * Permission resource ref for scaffolder templates.\n * @alpha\n */\nexport const scaffolderTemplatePermissionResourceRef =\n  createPermissionResourceRef<\n    TemplateEntityStepV1beta3 | TemplateParametersV1beta3,\n    {}\n  >().with({\n    pluginId: 'scaffolder',\n    resourceType: RESOURCE_TYPE_SCAFFOLDER_TEMPLATE,\n  });\n\n/**\n * Permission resource ref for scaffolder actions.\n * @alpha\n */\nexport const scaffolderActionPermissionResourceRef =\n  createPermissionResourceRef<JsonObject, {}>().with({\n    pluginId: 'scaffolder',\n    resourceType: RESOURCE_TYPE_SCAFFOLDER_ACTION,\n  });\n\n/**\n * Permission resource ref for scaffolder tasks.\n * @alpha\n */\nexport const scaffolderTaskPermissionResourceRef = createPermissionResourceRef<\n  SerializedTask,\n  TaskFilter\n>().with({\n  pluginId: 'scaffolder',\n  resourceType: RESOURCE_TYPE_SCAFFOLDER_TASK,\n});\n"],"names":["createExtensionPoint","createPermissionResourceRef","RESOURCE_TYPE_SCAFFOLDER_TEMPLATE","RESOURCE_TYPE_SCAFFOLDER_ACTION","RESOURCE_TYPE_SCAFFOLDER_TASK"],"mappings":";;;;;;;;;AA+CO,MAAM,qCACXA,qCAAA,CAAyD;AAAA,EACvD,EAAA,EAAI;AACN,CAAC;AAsBI,MAAM,qCACXA,qCAAA,CAAyD;AAAA,EACvD,EAAA,EAAI;AACN,CAAC;AAmCI,MAAM,uCACXA,qCAAA,CAA2D;AAAA,EACzD,EAAA,EAAI;AACN,CAAC;AAsCI,MAAM,4CACXA,qCAAA,CAAgE;AAAA,EAC9D,EAAA,EAAI;AACN,CAAC;AAsBI,MAAM,uCAAA,GACXC,gDAAA,EAGE,CAAE,IAAA,CAAK;AAAA,EACP,QAAA,EAAU,YAAA;AAAA,EACV,YAAA,EAAcC;AAChB,CAAC;AAMI,MAAM,qCAAA,GACXD,gDAAA,EAA4C,CAAE,IAAA,CAAK;AAAA,EACjD,QAAA,EAAU,YAAA;AAAA,EACV,YAAA,EAAcE;AAChB,CAAC;AAMI,MAAM,mCAAA,GAAsCF,gDAAA,EAGjD,CAAE,IAAA,CAAK;AAAA,EACP,QAAA,EAAU,YAAA;AAAA,EACV,YAAA,EAAcG;AAChB,CAAC;;;;;;;;;;;;;;;"}

package/dist/alpha.d.ts

@@ -1,7 +1,9 @@
+import * as _backstage_plugin_permission_node from '@backstage/plugin-permission-node';
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
-import { TaskBroker, TemplateFilter, TemplateGlobal } from '@backstage/plugin-scaffolder-node';
+import { TaskBroker, TemplateFilter, TemplateGlobal, SerializedTask, TaskFilter } from '@backstage/plugin-scaffolder-node';
 import { z } from 'zod/v3';
-import { JsonValue } from '@backstage/types';
+import { JsonValue, JsonObject } from '@backstage/types';
+import { TemplateParametersV1beta3, TemplateEntityStepV1beta3 } from '@backstage/plugin-scaffolder-common';
 export { T as TemplateFilter, a as TemplateGlobal } from './types/types.d-C0fXdKnD.js';
 
 /**
@@ -245,5 +247,21 @@ interface ScaffolderWorkspaceProviderExtensionPoint {
  */
 declare const scaffolderWorkspaceProviderExtensionPoint: _backstage_backend_plugin_api.ExtensionPoint<ScaffolderWorkspaceProviderExtensionPoint>;
 
-export { createTemplateFilter, createTemplateGlobalFunction, createTemplateGlobalValue, restoreWorkspace, scaffolderAutocompleteExtensionPoint, scaffolderTaskBrokerExtensionPoint, scaffolderTemplatingExtensionPoint, scaffolderWorkspaceProviderExtensionPoint, serializeWorkspace };
+/**
+ * Permission resource ref for scaffolder templates.
+ * @alpha
+ */
+declare const scaffolderTemplatePermissionResourceRef: _backstage_plugin_permission_node.PermissionResourceRef<TemplateParametersV1beta3 | TemplateEntityStepV1beta3, {}, "scaffolder-template", "scaffolder">;
+/**
+ * Permission resource ref for scaffolder actions.
+ * @alpha
+ */
+declare const scaffolderActionPermissionResourceRef: _backstage_plugin_permission_node.PermissionResourceRef<JsonObject, {}, "scaffolder-action", "scaffolder">;
+/**
+ * Permission resource ref for scaffolder tasks.
+ * @alpha
+ */
+declare const scaffolderTaskPermissionResourceRef: _backstage_plugin_permission_node.PermissionResourceRef<SerializedTask, TaskFilter, "scaffolder-task", "scaffolder">;
+
+export { createTemplateFilter, createTemplateGlobalFunction, createTemplateGlobalValue, restoreWorkspace, scaffolderActionPermissionResourceRef, scaffolderAutocompleteExtensionPoint, scaffolderTaskBrokerExtensionPoint, scaffolderTaskPermissionResourceRef, scaffolderTemplatePermissionResourceRef, scaffolderTemplatingExtensionPoint, scaffolderWorkspaceProviderExtensionPoint, serializeWorkspace };
 export type { AutocompleteHandler, CheckpointContext, CheckpointState, CheckpointStateValue, CheckpointStatus, CreatedTemplateFilter, CreatedTemplateGlobal, CreatedTemplateGlobalFunction, CreatedTemplateGlobalValue, ScaffolderAutocompleteExtensionPoint, ScaffolderTaskBrokerExtensionPoint, ScaffolderTemplatingExtensionPoint, ScaffolderWorkspaceProviderExtensionPoint, TemplateFilterExample, TemplateGlobalFunctionExample, UpdateTaskCheckpointOptions, WorkspaceProvider, ZodFunctionSchema };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-node",
-  "version": "0.13.1-next.0",
+  "version": "0.13.1",
   "description": "The plugin-scaffolder-node module for @backstage/plugin-scaffolder-backend",
   "backstage": {
     "role": "node-library",
@@ -70,13 +70,14 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "1.8.1-next.0",
-    "@backstage/catalog-model": "1.7.7",
-    "@backstage/errors": "1.2.7",
-    "@backstage/integration": "2.0.0",
-    "@backstage/plugin-permission-common": "0.9.7",
-    "@backstage/plugin-scaffolder-common": "2.0.0",
-    "@backstage/types": "1.2.2",
+    "@backstage/backend-plugin-api": "^1.8.0",
+    "@backstage/catalog-model": "^1.7.7",
+    "@backstage/errors": "^1.2.7",
+    "@backstage/integration": "^2.0.0",
+    "@backstage/plugin-permission-common": "^0.9.7",
+    "@backstage/plugin-permission-node": "^0.10.11",
+    "@backstage/plugin-scaffolder-common": "^2.0.0",
+    "@backstage/types": "^1.2.2",
     "@isomorphic-git/pgp-plugin": "^0.0.7",
     "concat-stream": "^2.0.0",
     "fs-extra": "^11.2.0",
@@ -92,14 +93,14 @@
     "zod-to-json-schema": "^3.25.1"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "1.11.2-next.0",
-    "@backstage/cli": "0.36.1-next.0",
-    "@backstage/config": "1.3.6",
+    "@backstage/backend-test-utils": "^1.11.1",
+    "@backstage/cli": "^0.36.0",
+    "@backstage/config": "^1.3.6",
     "@types/lodash": "^4.14.151",
     "msw": "^1.0.0"
   },
   "peerDependencies": {
-    "@backstage/backend-test-utils": "1.11.2-next.0"
+    "@backstage/backend-test-utils": "^1.11.1"
   },
   "peerDependenciesMeta": {
     "@backstage/backend-test-utils": {