@backstage/plugin-scaffolder-backend 1.12.1-next.0 → 1.13.0-next.2

package/dist/alpha.d.ts

@@ -1,4 +1,7 @@
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
+import * as _backstage_plugin_permission_common from '@backstage/plugin-permission-common';
+import * as _backstage_plugin_permission_node from '@backstage/plugin-permission-node';
+import * as _backstage_plugin_scaffolder_common from '@backstage/plugin-scaffolder-common';
 import { TemplateAction } from '@backstage/plugin-scaffolder-node';
 import { TaskBroker, TemplateFilter, TemplateGlobal } from '@backstage/plugin-scaffolder-backend';
 
@@ -9,12 +12,57 @@ import { TaskBroker, TemplateFilter, TemplateGlobal } from '@backstage/plugin-sc
  */
 declare const catalogModuleTemplateKind: () => _backstage_backend_plugin_api.BackendFeature;
 
+/**
+ * These conditions are used when creating conditional decisions for scaffolder
+ * templates that are returned by authorization policies.
+ *
+ * @alpha
+ */
+declare const scaffolderConditions: _backstage_plugin_permission_node.Conditions<{
+    hasTag: _backstage_plugin_permission_node.PermissionRule<_backstage_plugin_scaffolder_common.TemplateParametersV1beta3 | _backstage_plugin_scaffolder_common.TemplateEntityStepV1beta3, {}, "scaffolder-template", {
+        tag: string;
+    }>;
+}>;
+/**
+ * `createScaffolderConditionalDecision` can be used when authoring policies to
+ * create conditional decisions. It requires a permission of type
+ * `ResourcePermission<'scaffolder-template'>` to be passed as the first parameter.
+ * It's recommended that you use the provided `isResourcePermission` and
+ * `isPermission` helper methods to narrow the type of the permission passed to
+ * the handle method as shown below.
+ *
+ * ```
+ * // MyAuthorizationPolicy.ts
+ * ...
+ * import { createScaffolderPolicyDecision } from '@backstage/plugin-scaffolder-backend';
+ * import { RESOURCE_TYPE_SCAFFOLDER_TEMPLATE } from '@backstage/plugin-scaffolder-common';
+ *
+ * class MyAuthorizationPolicy implements PermissionPolicy {
+ *   async handle(request, user) {
+ *    ...
+ *
+ *    if (isResourcePermission(request.permission, RESOURCE_TYPE_SCAFFOLDER_TEMPLATE)) {
+ *      return createScaffolderConditionalDecision(
+ *        request.permission,
+ *        { anyOf: [...insert conditions here...] }
+ *      );
+ *    }
+ *
+ *    ...
+ * }
+ *
+ * ```
+ *
+ * @alpha
+ */
+declare const createScaffolderConditionalDecision: (permission: _backstage_plugin_permission_common.ResourcePermission<"scaffolder-template">, conditions: _backstage_plugin_permission_common.PermissionCriteria<_backstage_plugin_permission_common.PermissionCondition<"scaffolder-template">>) => _backstage_plugin_permission_common.ConditionalPolicyDecision;
+
 /**
  * Catalog plugin options
  *
  * @alpha
  */
-declare type ScaffolderPluginOptions = {
+type ScaffolderPluginOptions = {
     actions?: TemplateAction<any>[];
     taskWorkers?: number;
     taskBroker?: TaskBroker;
@@ -28,4 +76,4 @@ declare type ScaffolderPluginOptions = {
  */
 declare const scaffolderPlugin: (options: ScaffolderPluginOptions) => _backstage_backend_plugin_api.BackendFeature;
 
-export { ScaffolderPluginOptions, catalogModuleTemplateKind, scaffolderPlugin };
+export { ScaffolderPluginOptions, catalogModuleTemplateKind, createScaffolderConditionalDecision, scaffolderConditions, scaffolderPlugin };