@backstage/backend-plugin-api 1.3.1-next.2 → 1.4.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @backstage/backend-plugin-api
 
+## 1.4.0-next.0
+
+### Minor Changes
+
+- 664c07a: Added `coreServices.actionsRegistry` and `coreServices.actions` to allow registration of distributed actions from plugins, and the ability to invoke these actions
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-auth-node@0.6.4-next.0
+  - @backstage/plugin-permission-node@0.10.1-next.0
+
+## 1.3.1
+
+### Patch Changes
+
+- acea1d4: update documentation
+- 72d019d: Removed various typos
+- d385854: Minor doc comment update
+- Updated dependencies
+  - @backstage/plugin-auth-node@0.6.3
+  - @backstage/plugin-permission-common@0.9.0
+  - @backstage/plugin-permission-node@0.10.0
+  - @backstage/config@1.3.2
+  - @backstage/cli-common@0.1.15
+  - @backstage/errors@1.2.7
+  - @backstage/types@1.2.1
+
 ## 1.3.1-next.2
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,6 +1,8 @@
-import { JsonObject, HumanDuration, JsonValue } from '@backstage/types';
-import { Request, Response, Handler } from 'express';
+import { ZodType, z } from 'zod';
+import { JsonObject, JsonValue, HumanDuration } from '@backstage/types';
 import { PermissionAttributes, EvaluatorRequestOptions, PermissionEvaluator, AuthorizePermissionRequest, AuthorizePermissionResponse, QueryPermissionRequest, QueryPermissionResponse, Permission } from '@backstage/plugin-permission-common';
+import { JSONSchema7 } from 'json-schema';
+import { Request, Response, Handler } from 'express';
 import { Knex } from 'knex';
 import { PermissionResourceRef, PermissionRule, PermissionRuleset } from '@backstage/plugin-permission-node';
 import { Config } from '@backstage/config';
@@ -9,51 +11,18 @@ import { Readable } from 'stream';
 export { isChildPath } from '@backstage/cli-common';
 
 /**
- * low (default): normal usage
- * medium: accessing write endpoints
- * high: non-root permission changes
- * critical: root permission changes
- * @public
- */
-type AuditorServiceEventSeverityLevel = 'low' | 'medium' | 'high' | 'critical';
-/** @public */
-type AuditorServiceCreateEventOptions = {
-    /**
-     * Use kebab-case to name audit events (e.g., "user-login", "file-download", "fetch"). Represents a logical group of similar events or operations. For example, "fetch" could be used as an eventId encompassing various fetch methods like "by-id" or "by-location".
-     *
-     * The `pluginId` already provides plugin/module context, so avoid redundant prefixes in the `eventId`.
-     */
-    eventId: string;
-    /** (Optional) The severity level for the audit event. */
-    severityLevel?: AuditorServiceEventSeverityLevel;
-    /** (Optional) The associated HTTP request, if applicable. */
-    request?: Request<any, any, any, any, any>;
-    /**
-     * (Optional) Additional metadata relevant to the event, structured as a JSON object.
-     * This could include a `queryType` field, using kebab-case, for variations within the main event (e.g., "by-id", "by-user").
-     * For example, if the `eventId` is "fetch", the `queryType` in `meta` could be "by-id" or "by-location".
-     */
-    meta?: JsonObject;
-};
-/** @public */
-type AuditorServiceEvent = {
-    success(options?: {
-        meta?: JsonObject;
-    }): Promise<void>;
-    fail(options: {
-        meta?: JsonObject;
-        error: Error;
-    }): Promise<void>;
-};
-/**
- * A service that provides an auditor facility.
+ * A service that provides a logging facility.
  *
- * See the {@link https://backstage.io/docs/backend-system/core-services/auditor | service documentation} for more details.
+ * See the {@link https://backstage.io/docs/backend-system/core-services/logger | service documentation} for more details.
  *
  * @public
  */
-interface AuditorService {
-    createEvent(options: AuditorServiceCreateEventOptions): Promise<AuditorServiceEvent>;
+interface LoggerService {
+    error(message: string, meta?: Error | JsonObject): void;
+    warn(message: string, meta?: Error | JsonObject): void;
+    info(message: string, meta?: Error | JsonObject): void;
+    debug(message: string, meta?: Error | JsonObject): void;
+    child(meta: JsonObject): LoggerService;
 }
 
 /**
@@ -279,6 +248,115 @@ interface AuthService {
     }>;
 }
 
+/**
+ * @public
+ */
+type ActionsRegistryActionContext<TInputSchema extends ZodType> = {
+    input: z.infer<TInputSchema>;
+    logger: LoggerService;
+    credentials: BackstageCredentials;
+};
+/**
+ * @public
+ */
+type ActionsRegistryActionOptions<TInputSchema extends ZodType, TOutputSchema extends ZodType> = {
+    name: string;
+    title: string;
+    description: string;
+    schema: {
+        input: (zod: typeof z) => TInputSchema;
+        output: (zod: typeof z) => TOutputSchema;
+    };
+    action: (context: ActionsRegistryActionContext<TInputSchema>) => Promise<z.infer<TOutputSchema> extends void ? void : {
+        output: z.infer<TOutputSchema>;
+    }>;
+};
+/**
+ * @public
+ */
+interface ActionsRegistryService {
+    register<TInputSchema extends ZodType, TOutputSchema extends ZodType>(options: ActionsRegistryActionOptions<TInputSchema, TOutputSchema>): void;
+}
+
+/**
+ * @public
+ */
+type ActionsServiceAction = {
+    id: string;
+    name: string;
+    title: string;
+    description: string;
+    schema: {
+        input: JSONSchema7;
+        output: JSONSchema7;
+    };
+};
+/**
+ * @public
+ */
+interface ActionsService {
+    list: (opts: {
+        credentials: BackstageCredentials;
+    }) => Promise<{
+        actions: ActionsServiceAction[];
+    }>;
+    invoke(opts: {
+        id: string;
+        input?: JsonObject;
+        credentials: BackstageCredentials;
+    }): Promise<{
+        output: JsonValue;
+    }>;
+}
+
+/**
+ * low (default): normal usage
+ * medium: accessing write endpoints
+ * high: non-root permission changes
+ * critical: root permission changes
+ * @public
+ */
+type AuditorServiceEventSeverityLevel = 'low' | 'medium' | 'high' | 'critical';
+/** @public */
+type AuditorServiceCreateEventOptions = {
+    /**
+     * Use kebab-case to name audit events (e.g., "user-login", "file-download", "fetch"). Represents a logical group of similar events or operations. For example, "fetch" could be used as an eventId encompassing various fetch methods like "by-id" or "by-location".
+     *
+     * The `pluginId` already provides plugin/module context, so avoid redundant prefixes in the `eventId`.
+     */
+    eventId: string;
+    /** (Optional) The severity level for the audit event. */
+    severityLevel?: AuditorServiceEventSeverityLevel;
+    /** (Optional) The associated HTTP request, if applicable. */
+    request?: Request<any, any, any, any, any>;
+    /**
+     * (Optional) Additional metadata relevant to the event, structured as a JSON object.
+     * This could include a `queryType` field, using kebab-case, for variations within the main event (e.g., "by-id", "by-user").
+     * For example, if the `eventId` is "fetch", the `queryType` in `meta` could be "by-id" or "by-location".
+     */
+    meta?: JsonObject;
+};
+/** @public */
+type AuditorServiceEvent = {
+    success(options?: {
+        meta?: JsonObject;
+    }): Promise<void>;
+    fail(options: {
+        meta?: JsonObject;
+        error: Error;
+    }): Promise<void>;
+};
+/**
+ * A service that provides an auditor facility.
+ *
+ * See the {@link https://backstage.io/docs/backend-system/core-services/auditor | service documentation} for more details.
+ *
+ * @public
+ */
+interface AuditorService {
+    createEvent(options: AuditorServiceCreateEventOptions): Promise<AuditorServiceEvent>;
+}
+
 /**
  * Options passed to {@link CacheService.set}.
  *
@@ -546,21 +624,6 @@ interface HttpRouterService {
     addAuthPolicy(policy: HttpRouterServiceAuthPolicy): void;
 }
 
-/**
- * A service that provides a logging facility.
- *
- * See the {@link https://backstage.io/docs/backend-system/core-services/logger | service documentation} for more details.
- *
- * @public
- */
-interface LoggerService {
-    error(message: string, meta?: Error | JsonObject): void;
-    warn(message: string, meta?: Error | JsonObject): void;
-    info(message: string, meta?: Error | JsonObject): void;
-    debug(message: string, meta?: Error | JsonObject): void;
-    child(meta: JsonObject): LoggerService;
-}
-
 /**
  * @public
  */
@@ -1655,6 +1718,26 @@ declare namespace coreServices {
      * @public
      */
     const auth: ServiceRef<AuthService, "plugin", "singleton">;
+    /**
+     * Service for calling distributed actions
+     *
+     * See {@link ActionsService}
+     * and {@link https://backstage.io/docs/backend-system/core-services/actions | the service docs}
+     * for more information.
+     *
+     * @public
+     */
+    const actions: ServiceRef<ActionsService, "plugin", "singleton">;
+    /**
+     * Service for registering and managing distributed actions.
+     *
+     * See {@link ActionsRegistryService}
+     * and {@link https://backstage.io/docs/backend-system/core-services/actions-registry | the service docs}
+     * for more information.
+     *
+     * @public
+     */
+    const actionsRegistry: ServiceRef<ActionsRegistryService, "plugin", "singleton">;
     /**
      * Authenticated user information retrieval.
      *
@@ -2027,4 +2110,4 @@ declare function createBackendFeatureLoader<TDeps extends {
     [name in string]: unknown;
 }>(options: CreateBackendFeatureLoaderOptions<TDeps>): BackendFeature;
 
-export { type AuditorService, type AuditorServiceCreateEventOptions, type AuditorServiceEvent, type AuditorServiceEventSeverityLevel, type AuthService, type BackendFeature, type BackendModuleRegistrationPoints, type BackendPluginRegistrationPoints, type BackstageCredentials, type BackstageNonePrincipal, type BackstagePrincipalAccessRestrictions, type BackstagePrincipalTypes, type BackstageServicePrincipal, type BackstageUserInfo, type BackstageUserPrincipal, type CacheService, type CacheServiceOptions, type CacheServiceSetOptions, type CreateBackendFeatureLoaderOptions, type CreateBackendModuleOptions, type CreateBackendPluginOptions, type CreateExtensionPointOptions, type DatabaseService, type DiscoveryService, type ExtensionPoint, type HttpAuthService, type HttpRouterService, type HttpRouterServiceAuthPolicy, type LifecycleService, type LifecycleServiceShutdownHook, type LifecycleServiceShutdownOptions, type LifecycleServiceStartupHook, type LifecycleServiceStartupOptions, type LoggerService, type PermissionsRegistryService, type PermissionsRegistryServiceAddResourceTypeOptions, type PermissionsService, type PermissionsServiceRequestOptions, type PluginMetadataService, type PluginServiceFactoryOptions, type RootConfigService, type RootHealthService, type RootHttpRouterService, type RootLifecycleService, type RootLoggerService, type RootServiceFactoryOptions, type SchedulerService, type SchedulerServiceTaskDescriptor, type SchedulerServiceTaskFunction, type SchedulerServiceTaskInvocationDefinition, type SchedulerServiceTaskRunner, type SchedulerServiceTaskScheduleDefinition, type SchedulerServiceTaskScheduleDefinitionConfig, type ServiceFactory, type ServiceRef, type ServiceRefOptions, type UrlReaderService, type UrlReaderServiceReadTreeOptions, type UrlReaderServiceReadTreeResponse, type UrlReaderServiceReadTreeResponseDirOptions, type UrlReaderServiceReadTreeResponseFile, type UrlReaderServiceReadUrlOptions, type UrlReaderServiceReadUrlResponse, type UrlReaderServiceSearchOptions, type UrlReaderServiceSearchResponse, type UrlReaderServiceSearchResponseFile, type UserInfoService, coreServices, createBackendFeatureLoader, createBackendModule, createBackendPlugin, createExtensionPoint, createServiceFactory, createServiceRef, isDatabaseConflictError, readSchedulerServiceTaskScheduleDefinitionFromConfig, resolvePackagePath, resolveSafeChildPath };
+export { type ActionsRegistryActionContext, type ActionsRegistryActionOptions, type ActionsRegistryService, type ActionsService, type ActionsServiceAction, type AuditorService, type AuditorServiceCreateEventOptions, type AuditorServiceEvent, type AuditorServiceEventSeverityLevel, type AuthService, type BackendFeature, type BackendModuleRegistrationPoints, type BackendPluginRegistrationPoints, type BackstageCredentials, type BackstageNonePrincipal, type BackstagePrincipalAccessRestrictions, type BackstagePrincipalTypes, type BackstageServicePrincipal, type BackstageUserInfo, type BackstageUserPrincipal, type CacheService, type CacheServiceOptions, type CacheServiceSetOptions, type CreateBackendFeatureLoaderOptions, type CreateBackendModuleOptions, type CreateBackendPluginOptions, type CreateExtensionPointOptions, type DatabaseService, type DiscoveryService, type ExtensionPoint, type HttpAuthService, type HttpRouterService, type HttpRouterServiceAuthPolicy, type LifecycleService, type LifecycleServiceShutdownHook, type LifecycleServiceShutdownOptions, type LifecycleServiceStartupHook, type LifecycleServiceStartupOptions, type LoggerService, type PermissionsRegistryService, type PermissionsRegistryServiceAddResourceTypeOptions, type PermissionsService, type PermissionsServiceRequestOptions, type PluginMetadataService, type PluginServiceFactoryOptions, type RootConfigService, type RootHealthService, type RootHttpRouterService, type RootLifecycleService, type RootLoggerService, type RootServiceFactoryOptions, type SchedulerService, type SchedulerServiceTaskDescriptor, type SchedulerServiceTaskFunction, type SchedulerServiceTaskInvocationDefinition, type SchedulerServiceTaskRunner, type SchedulerServiceTaskScheduleDefinition, type SchedulerServiceTaskScheduleDefinitionConfig, type ServiceFactory, type ServiceRef, type ServiceRefOptions, type UrlReaderService, type UrlReaderServiceReadTreeOptions, type UrlReaderServiceReadTreeResponse, type UrlReaderServiceReadTreeResponseDirOptions, type UrlReaderServiceReadTreeResponseFile, type UrlReaderServiceReadUrlOptions, type UrlReaderServiceReadUrlResponse, type UrlReaderServiceSearchOptions, type UrlReaderServiceSearchResponse, type UrlReaderServiceSearchResponseFile, type UserInfoService, coreServices, createBackendFeatureLoader, createBackendModule, createBackendPlugin, createExtensionPoint, createServiceFactory, createServiceRef, isDatabaseConflictError, readSchedulerServiceTaskScheduleDefinitionFromConfig, resolvePackagePath, resolveSafeChildPath };

package/dist/services/definitions/coreServices.cjs.js

@@ -7,6 +7,12 @@ exports.coreServices = void 0;
   coreServices2.auth = types.createServiceRef({
     id: "core.auth"
   });
+  coreServices2.actions = types.createServiceRef({
+    id: "core.actions"
+  });
+  coreServices2.actionsRegistry = types.createServiceRef({
+    id: "core.actionsRegistry"
+  });
   coreServices2.userInfo = types.createServiceRef({
     id: "core.userInfo"
   });

package/dist/services/definitions/coreServices.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"coreServices.cjs.js","sources":["../../../src/services/definitions/coreServices.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 { createServiceRef } from '../system';\n\n/**\n * All core services references\n *\n * @public\n */\nexport namespace coreServices {\n  /**\n   * Handles token authentication and credentials management.\n   *\n   * See {@link AuthService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/auth | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const auth = createServiceRef<import('./AuthService').AuthService>({\n    id: 'core.auth',\n  });\n\n  /**\n   * Authenticated user information retrieval.\n   *\n   * See {@link UserInfoService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/user-info | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const userInfo = createServiceRef<\n    import('./UserInfoService').UserInfoService\n  >({\n    id: 'core.userInfo',\n  });\n\n  /**\n   * Key-value store for caching data.\n   *\n   * See {@link CacheService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/cache | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const cache = createServiceRef<import('./CacheService').CacheService>({\n    id: 'core.cache',\n  });\n\n  /**\n   * Access to static configuration.\n   *\n   * See {@link RootConfigService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/root-config | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const rootConfig = createServiceRef<\n    import('./RootConfigService').RootConfigService\n  >({ id: 'core.rootConfig', scope: 'root' });\n\n  /**\n   * Database access and management via `knex`.\n   *\n   * See {@link DatabaseService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/database | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const database = createServiceRef<\n    import('./DatabaseService').DatabaseService\n  >({ id: 'core.database' });\n\n  /**\n   * Service discovery for inter-plugin communication.\n   *\n   * See {@link DiscoveryService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/discovery | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const discovery = createServiceRef<\n    import('./DiscoveryService').DiscoveryService\n  >({ id: 'core.discovery' });\n\n  /**\n   * The service reference for the plugin scoped {@link RootHealthService}.\n   */\n  export const rootHealth = createServiceRef<\n    import('./RootHealthService').RootHealthService\n  >({ id: 'core.rootHealth', scope: 'root' });\n\n  /**\n   * Authentication of HTTP requests.\n   *\n   * See {@link HttpAuthService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/http-auth | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const httpAuth = createServiceRef<\n    import('./HttpAuthService').HttpAuthService\n  >({ id: 'core.httpAuth' });\n\n  /**\n   * HTTP route registration for plugins.\n   *\n   * See {@link HttpRouterService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/http-router | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const httpRouter = createServiceRef<\n    import('./HttpRouterService').HttpRouterService\n  >({ id: 'core.httpRouter' });\n\n  /**\n   * Registration of plugin startup and shutdown lifecycle hooks.\n   *\n   * See {@link LifecycleService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/lifecycle | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const lifecycle = createServiceRef<\n    import('./LifecycleService').LifecycleService\n  >({ id: 'core.lifecycle' });\n\n  /**\n   * Plugin-level logging.\n   *\n   * See {@link LoggerService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/logger | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const logger = createServiceRef<\n    import('./LoggerService').LoggerService\n  >({ id: 'core.logger' });\n\n  /**\n   * Plugin-level auditing.\n   *\n   * See {@link AuditorService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/auditor | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const auditor = createServiceRef<\n    import('./AuditorService').AuditorService\n  >({ id: 'core.auditor' });\n\n  /**\n   * Permission system integration for authorization of user actions.\n   *\n   * See {@link PermissionsService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/permissions | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const permissions = createServiceRef<\n    import('./PermissionsService').PermissionsService\n  >({ id: 'core.permissions' });\n\n  /**\n   * Permission system integration for registering resources and permissions.\n   *\n   * See {@link PermissionsRegistryService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/permission-integrations | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const permissionsRegistry = createServiceRef<\n    import('./PermissionsRegistryService').PermissionsRegistryService\n  >({ id: 'core.permissionsRegistry' });\n\n  /**\n   * Built-in service for accessing metadata about the current plugin.\n   *\n   * See {@link PluginMetadataService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/plugin-metadata | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const pluginMetadata = createServiceRef<\n    import('./PluginMetadataService').PluginMetadataService\n  >({ id: 'core.pluginMetadata' });\n\n  /**\n   * HTTP route registration for root services.\n   *\n   * See {@link RootHttpRouterService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/root-http-router | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const rootHttpRouter = createServiceRef<\n    import('./RootHttpRouterService').RootHttpRouterService\n  >({ id: 'core.rootHttpRouter', scope: 'root' });\n\n  /**\n   * Registration of backend startup and shutdown lifecycle hooks.\n   *\n   * See {@link RootLifecycleService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/root-lifecycle | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const rootLifecycle = createServiceRef<\n    import('./RootLifecycleService').RootLifecycleService\n  >({ id: 'core.rootLifecycle', scope: 'root' });\n\n  /**\n   * Root-level logging.\n   *\n   * See {@link RootLoggerService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/root-logger | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const rootLogger = createServiceRef<\n    import('./RootLoggerService').RootLoggerService\n  >({ id: 'core.rootLogger', scope: 'root' });\n\n  /**\n   * Scheduling of distributed background tasks.\n   *\n   * See {@link SchedulerService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/scheduler | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const scheduler = createServiceRef<\n    import('./SchedulerService').SchedulerService\n  >({ id: 'core.scheduler' });\n\n  /**\n   * Reading content from external systems.\n   *\n   * See {@link UrlReaderService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/url-reader | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const urlReader = createServiceRef<\n    import('./UrlReaderService').UrlReaderService\n  >({ id: 'core.urlReader' });\n}\n"],"names":["coreServices","createServiceRef"],"mappings":";;;;AAuBiBA;AAAA,CAAV,CAAUA,aAAV,KAAA;AAUE,EAAMA,aAAAA,CAAA,OAAOC,sBAAsD,CAAA;AAAA,IACxE,EAAI,EAAA;AAAA,GACL,CAAA;AAWM,EAAMD,aAAAA,CAAA,WAAWC,sBAEtB,CAAA;AAAA,IACA,EAAI,EAAA;AAAA,GACL,CAAA;AAWM,EAAMD,aAAAA,CAAA,QAAQC,sBAAwD,CAAA;AAAA,IAC3E,EAAI,EAAA;AAAA,GACL,CAAA;AAWM,EAAMD,aAAAA,CAAA,aAAaC,sBAExB,CAAA,EAAE,IAAI,iBAAmB,EAAA,KAAA,EAAO,QAAQ,CAAA;AAWnC,EAAMD,cAAA,QAAW,GAAAC,sBAAA,CAEtB,EAAE,EAAA,EAAI,iBAAiB,CAAA;AAWlB,EAAMD,cAAA,SAAY,GAAAC,sBAAA,CAEvB,EAAE,EAAA,EAAI,kBAAkB,CAAA;AAKnB,EAAMD,aAAAA,CAAA,aAAaC,sBAExB,CAAA,EAAE,IAAI,iBAAmB,EAAA,KAAA,EAAO,QAAQ,CAAA;AAWnC,EAAMD,cAAA,QAAW,GAAAC,sBAAA,CAEtB,EAAE,EAAA,EAAI,iBAAiB,CAAA;AAWlB,EAAMD,cAAA,UAAa,GAAAC,sBAAA,CAExB,EAAE,EAAA,EAAI,mBAAmB,CAAA;AAWpB,EAAMD,cAAA,SAAY,GAAAC,sBAAA,CAEvB,EAAE,EAAA,EAAI,kBAAkB,CAAA;AAWnB,EAAMD,cAAA,MAAS,GAAAC,sBAAA,CAEpB,EAAE,EAAA,EAAI,eAAe,CAAA;AAWhB,EAAMD,cAAA,OAAU,GAAAC,sBAAA,CAErB,EAAE,EAAA,EAAI,gBAAgB,CAAA;AAWjB,EAAMD,cAAA,WAAc,GAAAC,sBAAA,CAEzB,EAAE,EAAA,EAAI,oBAAoB,CAAA;AAWrB,EAAMD,cAAA,mBAAsB,GAAAC,sBAAA,CAEjC,EAAE,EAAA,EAAI,4BAA4B,CAAA;AAW7B,EAAMD,cAAA,cAAiB,GAAAC,sBAAA,CAE5B,EAAE,EAAA,EAAI,uBAAuB,CAAA;AAWxB,EAAMD,aAAAA,CAAA,iBAAiBC,sBAE5B,CAAA,EAAE,IAAI,qBAAuB,EAAA,KAAA,EAAO,QAAQ,CAAA;AAWvC,EAAMD,aAAAA,CAAA,gBAAgBC,sBAE3B,CAAA,EAAE,IAAI,oBAAsB,EAAA,KAAA,EAAO,QAAQ,CAAA;AAWtC,EAAMD,aAAAA,CAAA,aAAaC,sBAExB,CAAA,EAAE,IAAI,iBAAmB,EAAA,KAAA,EAAO,QAAQ,CAAA;AAWnC,EAAMD,cAAA,SAAY,GAAAC,sBAAA,CAEvB,EAAE,EAAA,EAAI,kBAAkB,CAAA;AAWnB,EAAMD,cAAA,SAAY,GAAAC,sBAAA,CAEvB,EAAE,EAAA,EAAI,kBAAkB,CAAA;AAAA,CA/PX,EAAAD,oBAAA,KAAAA,oBAAA,GAAA,EAAA,CAAA,CAAA;;"}
+{"version":3,"file":"coreServices.cjs.js","sources":["../../../src/services/definitions/coreServices.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 { createServiceRef } from '../system';\n\n/**\n * All core services references\n *\n * @public\n */\nexport namespace coreServices {\n  /**\n   * Handles token authentication and credentials management.\n   *\n   * See {@link AuthService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/auth | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const auth = createServiceRef<import('./AuthService').AuthService>({\n    id: 'core.auth',\n  });\n\n  /**\n   * Service for calling distributed actions\n   *\n   * See {@link ActionsService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/actions | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const actions = createServiceRef<\n    import('./ActionsService').ActionsService\n  >({\n    id: 'core.actions',\n  });\n\n  /**\n   * Service for registering and managing distributed actions.\n   *\n   * See {@link ActionsRegistryService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/actions-registry | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const actionsRegistry = createServiceRef<\n    import('./ActionsRegistryService').ActionsRegistryService\n  >({\n    id: 'core.actionsRegistry',\n  });\n\n  /**\n   * Authenticated user information retrieval.\n   *\n   * See {@link UserInfoService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/user-info | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const userInfo = createServiceRef<\n    import('./UserInfoService').UserInfoService\n  >({\n    id: 'core.userInfo',\n  });\n\n  /**\n   * Key-value store for caching data.\n   *\n   * See {@link CacheService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/cache | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const cache = createServiceRef<import('./CacheService').CacheService>({\n    id: 'core.cache',\n  });\n\n  /**\n   * Access to static configuration.\n   *\n   * See {@link RootConfigService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/root-config | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const rootConfig = createServiceRef<\n    import('./RootConfigService').RootConfigService\n  >({ id: 'core.rootConfig', scope: 'root' });\n\n  /**\n   * Database access and management via `knex`.\n   *\n   * See {@link DatabaseService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/database | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const database = createServiceRef<\n    import('./DatabaseService').DatabaseService\n  >({ id: 'core.database' });\n\n  /**\n   * Service discovery for inter-plugin communication.\n   *\n   * See {@link DiscoveryService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/discovery | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const discovery = createServiceRef<\n    import('./DiscoveryService').DiscoveryService\n  >({ id: 'core.discovery' });\n\n  /**\n   * The service reference for the plugin scoped {@link RootHealthService}.\n   */\n  export const rootHealth = createServiceRef<\n    import('./RootHealthService').RootHealthService\n  >({ id: 'core.rootHealth', scope: 'root' });\n\n  /**\n   * Authentication of HTTP requests.\n   *\n   * See {@link HttpAuthService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/http-auth | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const httpAuth = createServiceRef<\n    import('./HttpAuthService').HttpAuthService\n  >({ id: 'core.httpAuth' });\n\n  /**\n   * HTTP route registration for plugins.\n   *\n   * See {@link HttpRouterService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/http-router | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const httpRouter = createServiceRef<\n    import('./HttpRouterService').HttpRouterService\n  >({ id: 'core.httpRouter' });\n\n  /**\n   * Registration of plugin startup and shutdown lifecycle hooks.\n   *\n   * See {@link LifecycleService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/lifecycle | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const lifecycle = createServiceRef<\n    import('./LifecycleService').LifecycleService\n  >({ id: 'core.lifecycle' });\n\n  /**\n   * Plugin-level logging.\n   *\n   * See {@link LoggerService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/logger | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const logger = createServiceRef<\n    import('./LoggerService').LoggerService\n  >({ id: 'core.logger' });\n\n  /**\n   * Plugin-level auditing.\n   *\n   * See {@link AuditorService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/auditor | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const auditor = createServiceRef<\n    import('./AuditorService').AuditorService\n  >({ id: 'core.auditor' });\n\n  /**\n   * Permission system integration for authorization of user actions.\n   *\n   * See {@link PermissionsService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/permissions | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const permissions = createServiceRef<\n    import('./PermissionsService').PermissionsService\n  >({ id: 'core.permissions' });\n\n  /**\n   * Permission system integration for registering resources and permissions.\n   *\n   * See {@link PermissionsRegistryService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/permission-integrations | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const permissionsRegistry = createServiceRef<\n    import('./PermissionsRegistryService').PermissionsRegistryService\n  >({ id: 'core.permissionsRegistry' });\n\n  /**\n   * Built-in service for accessing metadata about the current plugin.\n   *\n   * See {@link PluginMetadataService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/plugin-metadata | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const pluginMetadata = createServiceRef<\n    import('./PluginMetadataService').PluginMetadataService\n  >({ id: 'core.pluginMetadata' });\n\n  /**\n   * HTTP route registration for root services.\n   *\n   * See {@link RootHttpRouterService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/root-http-router | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const rootHttpRouter = createServiceRef<\n    import('./RootHttpRouterService').RootHttpRouterService\n  >({ id: 'core.rootHttpRouter', scope: 'root' });\n\n  /**\n   * Registration of backend startup and shutdown lifecycle hooks.\n   *\n   * See {@link RootLifecycleService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/root-lifecycle | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const rootLifecycle = createServiceRef<\n    import('./RootLifecycleService').RootLifecycleService\n  >({ id: 'core.rootLifecycle', scope: 'root' });\n\n  /**\n   * Root-level logging.\n   *\n   * See {@link RootLoggerService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/root-logger | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const rootLogger = createServiceRef<\n    import('./RootLoggerService').RootLoggerService\n  >({ id: 'core.rootLogger', scope: 'root' });\n\n  /**\n   * Scheduling of distributed background tasks.\n   *\n   * See {@link SchedulerService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/scheduler | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const scheduler = createServiceRef<\n    import('./SchedulerService').SchedulerService\n  >({ id: 'core.scheduler' });\n\n  /**\n   * Reading content from external systems.\n   *\n   * See {@link UrlReaderService}\n   * and {@link https://backstage.io/docs/backend-system/core-services/url-reader | the service docs}\n   * for more information.\n   *\n   * @public\n   */\n  export const urlReader = createServiceRef<\n    import('./UrlReaderService').UrlReaderService\n  >({ id: 'core.urlReader' });\n}\n"],"names":["coreServices","createServiceRef"],"mappings":";;;;AAuBiBA;AAAA,CAAV,CAAUA,aAAV,KAAA;AAUE,EAAMA,aAAAA,CAAA,OAAOC,sBAAsD,CAAA;AAAA,IACxE,EAAI,EAAA;AAAA,GACL,CAAA;AAWM,EAAMD,aAAAA,CAAA,UAAUC,sBAErB,CAAA;AAAA,IACA,EAAI,EAAA;AAAA,GACL,CAAA;AAWM,EAAMD,aAAAA,CAAA,kBAAkBC,sBAE7B,CAAA;AAAA,IACA,EAAI,EAAA;AAAA,GACL,CAAA;AAWM,EAAMD,aAAAA,CAAA,WAAWC,sBAEtB,CAAA;AAAA,IACA,EAAI,EAAA;AAAA,GACL,CAAA;AAWM,EAAMD,aAAAA,CAAA,QAAQC,sBAAwD,CAAA;AAAA,IAC3E,EAAI,EAAA;AAAA,GACL,CAAA;AAWM,EAAMD,aAAAA,CAAA,aAAaC,sBAExB,CAAA,EAAE,IAAI,iBAAmB,EAAA,KAAA,EAAO,QAAQ,CAAA;AAWnC,EAAMD,cAAA,QAAW,GAAAC,sBAAA,CAEtB,EAAE,EAAA,EAAI,iBAAiB,CAAA;AAWlB,EAAMD,cAAA,SAAY,GAAAC,sBAAA,CAEvB,EAAE,EAAA,EAAI,kBAAkB,CAAA;AAKnB,EAAMD,aAAAA,CAAA,aAAaC,sBAExB,CAAA,EAAE,IAAI,iBAAmB,EAAA,KAAA,EAAO,QAAQ,CAAA;AAWnC,EAAMD,cAAA,QAAW,GAAAC,sBAAA,CAEtB,EAAE,EAAA,EAAI,iBAAiB,CAAA;AAWlB,EAAMD,cAAA,UAAa,GAAAC,sBAAA,CAExB,EAAE,EAAA,EAAI,mBAAmB,CAAA;AAWpB,EAAMD,cAAA,SAAY,GAAAC,sBAAA,CAEvB,EAAE,EAAA,EAAI,kBAAkB,CAAA;AAWnB,EAAMD,cAAA,MAAS,GAAAC,sBAAA,CAEpB,EAAE,EAAA,EAAI,eAAe,CAAA;AAWhB,EAAMD,cAAA,OAAU,GAAAC,sBAAA,CAErB,EAAE,EAAA,EAAI,gBAAgB,CAAA;AAWjB,EAAMD,cAAA,WAAc,GAAAC,sBAAA,CAEzB,EAAE,EAAA,EAAI,oBAAoB,CAAA;AAWrB,EAAMD,cAAA,mBAAsB,GAAAC,sBAAA,CAEjC,EAAE,EAAA,EAAI,4BAA4B,CAAA;AAW7B,EAAMD,cAAA,cAAiB,GAAAC,sBAAA,CAE5B,EAAE,EAAA,EAAI,uBAAuB,CAAA;AAWxB,EAAMD,aAAAA,CAAA,iBAAiBC,sBAE5B,CAAA,EAAE,IAAI,qBAAuB,EAAA,KAAA,EAAO,QAAQ,CAAA;AAWvC,EAAMD,aAAAA,CAAA,gBAAgBC,sBAE3B,CAAA,EAAE,IAAI,oBAAsB,EAAA,KAAA,EAAO,QAAQ,CAAA;AAWtC,EAAMD,aAAAA,CAAA,aAAaC,sBAExB,CAAA,EAAE,IAAI,iBAAmB,EAAA,KAAA,EAAO,QAAQ,CAAA;AAWnC,EAAMD,cAAA,SAAY,GAAAC,sBAAA,CAEvB,EAAE,EAAA,EAAI,kBAAkB,CAAA;AAWnB,EAAMD,cAAA,SAAY,GAAAC,sBAAA,CAEvB,EAAE,EAAA,EAAI,kBAAkB,CAAA;AAAA,CA7RX,EAAAD,oBAAA,KAAAA,oBAAA,GAAA,EAAA,CAAA,CAAA;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/backend-plugin-api",
-  "version": "1.3.1-next.2",
+  "version": "1.4.0-next.0",
   "description": "Core API used by Backstage backend plugins",
   "backstage": {
     "role": "node-library"
@@ -68,18 +68,21 @@
     "@backstage/cli-common": "0.1.15",
     "@backstage/config": "1.3.2",
     "@backstage/errors": "1.2.7",
-    "@backstage/plugin-auth-node": "0.6.3-next.2",
-    "@backstage/plugin-permission-common": "0.9.0-next.0",
-    "@backstage/plugin-permission-node": "0.10.0-next.2",
+    "@backstage/plugin-auth-node": "0.6.4-next.0",
+    "@backstage/plugin-permission-common": "0.9.0",
+    "@backstage/plugin-permission-node": "0.10.1-next.0",
     "@backstage/types": "1.2.1",
     "@types/express": "^4.17.6",
+    "@types/json-schema": "^7.0.6",
     "@types/luxon": "^3.0.0",
+    "json-schema": "^0.4.0",
     "knex": "^3.0.0",
-    "luxon": "^3.0.0"
+    "luxon": "^3.0.0",
+    "zod": "^3.22.4"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "1.5.0-next.3",
-    "@backstage/cli": "0.32.1-next.3"
+    "@backstage/backend-test-utils": "1.6.0-next.0",
+    "@backstage/cli": "0.32.1"
   },
   "configSchema": "config.d.ts"
 }