@backstage/plugin-scaffolder-node 0.8.0 → 0.8.1-next.1

package/CHANGELOG.md

@@ -1,5 +1,30 @@
 # @backstage/plugin-scaffolder-node
 
+## 0.8.1-next.1
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/integration@1.16.3-next.0
+  - @backstage/backend-plugin-api@1.2.1
+  - @backstage/catalog-model@1.7.3
+  - @backstage/errors@1.2.7
+  - @backstage/types@1.2.1
+  - @backstage/plugin-scaffolder-common@1.5.10
+
+## 0.8.1-next.0
+
+### Patch Changes
+
+- 497d47a: Document the internal built-in filters, and ensure that the types are validated when using `createTemplateFilter` and `createTemplateGlobalFunction` from the `zod` schema.
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.2.1
+  - @backstage/catalog-model@1.7.3
+  - @backstage/errors@1.2.7
+  - @backstage/integration@1.16.2
+  - @backstage/types@1.2.1
+  - @backstage/plugin-scaffolder-common@1.5.10
+
 ## 0.8.0
 
 ### Minor Changes

package/dist/alpha/filters/createTemplateFilter.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const createTemplateFilter = (filter) => filter;
+const createTemplateFilter = (options) => options;
 
 exports.createTemplateFilter = createTemplateFilter;
 //# sourceMappingURL=createTemplateFilter.cjs.js.map

package/dist/alpha/filters/createTemplateFilter.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"createTemplateFilter.cjs.js","sources":["../../../src/alpha/filters/createTemplateFilter.ts"],"sourcesContent":["/*\n * Copyright 2025 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 { JsonValue } from '@backstage/types';\nimport { CreatedTemplateFilter, TemplateFilterSchema } from './types';\nimport { z } from 'zod';\n\n/**\n * This function is used to create new template filters in type-safe manner.\n * @alpha\n */\nexport const createTemplateFilter = <\n  TSchema extends TemplateFilterSchema<any, any> | undefined,\n  TFunctionSchema extends TSchema extends TemplateFilterSchema<any, any>\n    ? z.infer<ReturnType<TSchema>>\n    : (arg: JsonValue, ...rest: JsonValue[]) => JsonValue | undefined,\n>(\n  filter: CreatedTemplateFilter<TSchema, TFunctionSchema>,\n): CreatedTemplateFilter<unknown, unknown> => filter;\n"],"names":[],"mappings":";;AAwBa,MAAA,oBAAA,GAAuB,CAMlC,MAC4C,KAAA;;;;"}
+{"version":3,"file":"createTemplateFilter.cjs.js","sources":["../../../src/alpha/filters/createTemplateFilter.ts"],"sourcesContent":["/*\n * Copyright 2025 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 { ZodFunctionSchema } from '../types';\nimport { CreatedTemplateFilter, TemplateFilterExample } from './types';\nimport { z } from 'zod';\n\n/**\n * This function is used to create new template filters in type-safe manner.\n * @alpha\n */\nexport const createTemplateFilter = <\n  TFunctionArgs extends [z.ZodTypeAny, ...z.ZodTypeAny[]],\n  TReturnType extends z.ZodTypeAny,\n>(options: {\n  id: string;\n  description?: string;\n  examples?: TemplateFilterExample[];\n  schema?: ZodFunctionSchema<TFunctionArgs, TReturnType>;\n  filter: (...args: z.infer<z.ZodTuple<TFunctionArgs>>) => z.infer<TReturnType>;\n}): CreatedTemplateFilter<TFunctionArgs, TReturnType> => options;\n"],"names":[],"mappings":";;AAwBa,MAAA,oBAAA,GAAuB,CAGlC,OAMuD,KAAA;;;;"}

package/dist/alpha/globals/createTemplateGlobal.cjs.js

@@ -1,7 +1,7 @@
 'use strict';
 
 const createTemplateGlobalValue = (v) => v;
-const createTemplateGlobalFunction = (fn) => fn;
+const createTemplateGlobalFunction = (options) => options;
 
 exports.createTemplateGlobalFunction = createTemplateGlobalFunction;
 exports.createTemplateGlobalValue = createTemplateGlobalValue;

package/dist/alpha/globals/createTemplateGlobal.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"createTemplateGlobal.cjs.js","sources":["../../../src/alpha/globals/createTemplateGlobal.ts"],"sourcesContent":["/*\n * Copyright 2025 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 { z } from 'zod';\nimport {\n  CreatedTemplateGlobalFunction,\n  CreatedTemplateGlobalValue,\n  TemplateGlobalFunctionSchema,\n} from './types';\nimport { JsonValue } from '@backstage/types';\n\n/**\n * This function is used to create new template global values in type-safe manner.\n * @param t - CreatedTemplateGlobalValue | CreatedTemplateGlobalFunction\n * @returns t\n * @alpha\n */\nexport const createTemplateGlobalValue = (\n  v: CreatedTemplateGlobalValue,\n): CreatedTemplateGlobalValue => v;\n\n/**\n * This function is used to create new template global functions in type-safe manner.\n * @param fn - CreatedTemplateGlobalFunction\n * @returns fn\n * @alpha\n */\nexport const createTemplateGlobalFunction = <\n  TSchema extends TemplateGlobalFunctionSchema<any, any> | undefined,\n  TFilterSchema extends TSchema extends TemplateGlobalFunctionSchema<any, any>\n    ? z.infer<ReturnType<TSchema>>\n    : (...args: JsonValue[]) => JsonValue | undefined,\n>(\n  fn: CreatedTemplateGlobalFunction<TSchema, TFilterSchema>,\n): CreatedTemplateGlobalFunction<any, any> => fn;\n"],"names":[],"mappings":";;AA8Ba,MAAA,yBAAA,GAA4B,CACvC,CAC+B,KAAA;AAQpB,MAAA,4BAAA,GAA+B,CAM1C,EAC4C,KAAA;;;;;"}
+{"version":3,"file":"createTemplateGlobal.cjs.js","sources":["../../../src/alpha/globals/createTemplateGlobal.ts"],"sourcesContent":["/*\n * Copyright 2025 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 { z } from 'zod';\nimport {\n  CreatedTemplateGlobalFunction,\n  CreatedTemplateGlobalValue,\n  TemplateGlobalFunctionExample,\n} from './types';\nimport { ZodFunctionSchema } from '../types';\n\n/**\n * This function is used to create new template global values in type-safe manner.\n * @param t - CreatedTemplateGlobalValue | CreatedTemplateGlobalFunction\n * @returns t\n * @alpha\n */\nexport const createTemplateGlobalValue = (\n  v: CreatedTemplateGlobalValue,\n): CreatedTemplateGlobalValue => v;\n\n/**\n * This function is used to create new template global functions in type-safe manner.\n * @param fn - CreatedTemplateGlobalFunction\n * @returns fn\n * @alpha\n */\nexport const createTemplateGlobalFunction = <\n  TFunctionArgs extends [z.ZodTypeAny, ...z.ZodTypeAny[]],\n  TReturnType extends z.ZodTypeAny,\n>(options: {\n  id: string;\n  description?: string;\n  examples?: TemplateGlobalFunctionExample[];\n  schema?: ZodFunctionSchema<TFunctionArgs, TReturnType>;\n  fn: (...args: z.infer<z.ZodTuple<TFunctionArgs>>) => z.infer<TReturnType>;\n}): CreatedTemplateGlobalFunction<TFunctionArgs, TReturnType> => options;\n"],"names":[],"mappings":";;AA8Ba,MAAA,yBAAA,GAA4B,CACvC,CAC+B,KAAA;AAQpB,MAAA,4BAAA,GAA+B,CAG1C,OAM+D,KAAA;;;;;"}

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';\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[],\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":";;;;;;;AA4CO,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';\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;;;;;;;;;;;;;"}

package/dist/alpha.d.ts

@@ -1,11 +1,14 @@
 import * as _backstage_backend_plugin_api from '@backstage/backend-plugin-api';
-import { TemplateAction, TaskBroker, TemplateFilter as TemplateFilter$1, TemplateGlobal as TemplateGlobal$1 } from '@backstage/plugin-scaffolder-node';
+import { TemplateAction, TaskBroker, TemplateFilter, TemplateGlobal } from '@backstage/plugin-scaffolder-node';
 import { z } from 'zod';
-import { T as TemplateFilter, a as TemplateGlobal } from './types/types.d-C0fXdKnD.js';
 import { JsonValue } from '@backstage/types';
+export { T as TemplateFilter, a as TemplateGlobal } from './types/types.d-C0fXdKnD.js';
+
+/**
+ * @alpha
+ */
+type ZodFunctionSchema<TFunctionArgs extends [z.ZodTypeAny, ...z.ZodTypeAny[]], TReturnType extends z.ZodTypeAny> = (zod: typeof z) => z.ZodFunction<z.ZodTuple<TFunctionArgs, null>, TReturnType> | z.ZodType<(...args: z.infer<z.ZodTuple<TFunctionArgs>>) => z.infer<TReturnType>>;
 
-/** @alpha */
-type TemplateFilterSchema<Args extends z.ZodTuple<[z.ZodType<JsonValue>] | [z.ZodType<JsonValue>, ...(z.ZodType<JsonValue> | z.ZodUnknown)[]], z.ZodType<JsonValue> | z.ZodUnknown | null>, Result extends z.ZodType<JsonValue> | z.ZodUndefined> = (zod: typeof z) => z.ZodFunction<Args, Result>;
 /** @alpha */
 type TemplateFilterExample = {
     description?: string;
@@ -13,19 +16,25 @@ type TemplateFilterExample = {
     notes?: string;
 };
 /** @alpha */
-type CreatedTemplateFilter<TSchema extends TemplateFilterSchema<any, any> | undefined | unknown = unknown, TFilterSchema extends TSchema extends TemplateFilterSchema<any, any> ? z.infer<ReturnType<TSchema>> : TSchema extends unknown ? unknown : TemplateFilter = TSchema extends TemplateFilterSchema<any, any> ? z.infer<ReturnType<TSchema>> : TSchema extends unknown ? unknown : TemplateFilter> = {
+type CreatedTemplateFilter<TFunctionArgs extends [z.ZodTypeAny, ...z.ZodTypeAny[]], TReturnType extends z.ZodTypeAny> = {
     id: string;
     description?: string;
     examples?: TemplateFilterExample[];
-    schema?: TSchema;
-    filter: TFilterSchema;
+    schema?: ZodFunctionSchema<TFunctionArgs, TReturnType>;
+    filter: (...args: z.infer<z.ZodTuple<TFunctionArgs>>) => z.infer<TReturnType>;
 };
 
 /**
  * This function is used to create new template filters in type-safe manner.
  * @alpha
  */
-declare const createTemplateFilter: <TSchema extends TemplateFilterSchema<any, any> | undefined, TFunctionSchema extends TSchema extends TemplateFilterSchema<any, any> ? z.infer<ReturnType<TSchema>> : (arg: JsonValue, ...rest: JsonValue[]) => JsonValue | undefined>(filter: CreatedTemplateFilter<TSchema, TFunctionSchema>) => CreatedTemplateFilter<unknown, unknown>;
+declare const createTemplateFilter: <TFunctionArgs extends [z.ZodTypeAny, ...z.ZodTypeAny[]], TReturnType extends z.ZodTypeAny>(options: {
+    id: string;
+    description?: string;
+    examples?: TemplateFilterExample[];
+    schema?: ZodFunctionSchema<TFunctionArgs, TReturnType>;
+    filter: (...args: z.infer<z.ZodTuple<TFunctionArgs>>) => z.infer<TReturnType>;
+}) => CreatedTemplateFilter<TFunctionArgs, TReturnType>;
 
 /** @alpha */
 type CreatedTemplateGlobalValue<T extends JsonValue = JsonValue> = {
@@ -34,24 +43,21 @@ type CreatedTemplateGlobalValue<T extends JsonValue = JsonValue> = {
     description?: string;
 };
 /** @alpha */
-type TemplateGlobalFunctionSchema<Args extends z.ZodTuple<[
-] | [z.ZodType<JsonValue>, ...(z.ZodType<JsonValue> | z.ZodUnknown)[]], z.ZodType<JsonValue> | z.ZodUnknown | null>, Result extends z.ZodType<JsonValue> | z.ZodUndefined> = (zod: typeof z) => z.ZodFunction<Args, Result>;
-/** @alpha */
 type TemplateGlobalFunctionExample = {
     description?: string;
     example: string;
     notes?: string;
 };
 /** @alpha */
-type CreatedTemplateGlobalFunction<TSchema extends TemplateGlobalFunctionSchema<any, any> | undefined | unknown = unknown, TFilterSchema extends TSchema extends TemplateGlobalFunctionSchema<any, any> ? z.infer<ReturnType<TSchema>> : TSchema extends unknown ? unknown : Exclude<TemplateGlobal, JsonValue> = TSchema extends TemplateGlobalFunctionSchema<any, any> ? z.infer<ReturnType<TSchema>> : TSchema extends unknown ? unknown : Exclude<TemplateGlobal, JsonValue>> = {
+type CreatedTemplateGlobalFunction<TFunctionArgs extends [z.ZodTypeAny, ...z.ZodTypeAny[]], TReturnType extends z.ZodTypeAny> = {
     id: string;
     description?: string;
     examples?: TemplateGlobalFunctionExample[];
-    schema?: TSchema;
-    fn: TFilterSchema;
+    schema?: ZodFunctionSchema<TFunctionArgs, TReturnType>;
+    fn: (...args: z.infer<z.ZodTuple<TFunctionArgs>>) => z.infer<TReturnType>;
 };
 /** @alpha */
-type CreatedTemplateGlobal = CreatedTemplateGlobalValue | CreatedTemplateGlobalFunction<unknown, unknown>;
+type CreatedTemplateGlobal = CreatedTemplateGlobalValue | CreatedTemplateGlobalFunction<any, any>;
 
 /**
  * This function is used to create new template global values in type-safe manner.
@@ -66,7 +72,13 @@ declare const createTemplateGlobalValue: (v: CreatedTemplateGlobalValue) => Crea
  * @returns fn
  * @alpha
  */
-declare const createTemplateGlobalFunction: <TSchema extends TemplateGlobalFunctionSchema<any, any> | undefined, TFilterSchema extends TSchema extends TemplateGlobalFunctionSchema<any, any> ? z.infer<ReturnType<TSchema>> : (...args: JsonValue[]) => JsonValue | undefined>(fn: CreatedTemplateGlobalFunction<TSchema, TFilterSchema>) => CreatedTemplateGlobalFunction<any, any>;
+declare const createTemplateGlobalFunction: <TFunctionArgs extends [z.ZodTypeAny, ...z.ZodTypeAny[]], TReturnType extends z.ZodTypeAny>(options: {
+    id: string;
+    description?: string;
+    examples?: TemplateGlobalFunctionExample[];
+    schema?: ZodFunctionSchema<TFunctionArgs, TReturnType>;
+    fn: (...args: z.infer<z.ZodTuple<TFunctionArgs>>) => z.infer<TReturnType>;
+}) => CreatedTemplateGlobalFunction<TFunctionArgs, TReturnType>;
 
 /**
  * Serializes provided path into tar archive
@@ -122,8 +134,8 @@ declare const scaffolderTaskBrokerExtensionPoint: _backstage_backend_plugin_api.
  * @alpha
  */
 interface ScaffolderTemplatingExtensionPoint {
-    addTemplateFilters(filters: Record<string, TemplateFilter$1> | CreatedTemplateFilter[]): void;
-    addTemplateGlobals(globals: Record<string, TemplateGlobal$1> | CreatedTemplateGlobal[]): void;
+    addTemplateFilters(filters: Record<string, TemplateFilter> | CreatedTemplateFilter<any, any>[]): void;
+    addTemplateGlobals(globals: Record<string, TemplateGlobal> | CreatedTemplateGlobal[]): void;
 }
 /**
  * Extension point for adding template filters and globals.
@@ -194,4 +206,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, TemplateFilter, type TemplateFilterExample, type TemplateFilterSchema, TemplateGlobal, type TemplateGlobalFunctionExample, type TemplateGlobalFunctionSchema, type WorkspaceProvider, createTemplateFilter, createTemplateGlobalFunction, createTemplateGlobalValue, restoreWorkspace, scaffolderActionsExtensionPoint, scaffolderAutocompleteExtensionPoint, scaffolderTaskBrokerExtensionPoint, scaffolderTemplatingExtensionPoint, scaffolderWorkspaceProviderExtensionPoint, serializeWorkspace };
+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 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-node",
-  "version": "0.8.0",
+  "version": "0.8.1-next.1",
   "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.2.1",
-    "@backstage/catalog-model": "^1.7.3",
-    "@backstage/errors": "^1.2.7",
-    "@backstage/integration": "^1.16.2",
-    "@backstage/plugin-scaffolder-common": "^1.5.10",
-    "@backstage/types": "^1.2.1",
+    "@backstage/backend-plugin-api": "1.2.1",
+    "@backstage/catalog-model": "1.7.3",
+    "@backstage/errors": "1.2.7",
+    "@backstage/integration": "1.16.3-next.0",
+    "@backstage/plugin-scaffolder-common": "1.5.10",
+    "@backstage/types": "1.2.1",
     "@isomorphic-git/pgp-plugin": "^0.0.7",
     "concat-stream": "^2.0.0",
     "fs-extra": "^11.2.0",
@@ -82,8 +82,8 @@
     "zod-to-json-schema": "^3.20.4"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^1.3.1",
-    "@backstage/cli": "^0.31.0",
-    "@backstage/config": "^1.3.2"
+    "@backstage/backend-test-utils": "1.3.2-next.1",
+    "@backstage/cli": "0.32.0-next.1",
+    "@backstage/config": "1.3.2"
   }
 }