move the auth services to backend-defaults

Signed-off-by: Fredrik Adelöw <freben@gmail.com>
This commit is contained in:
Fredrik Adelöw
2024-06-14 12:09:48 +02:00
parent 2d3977f78c
commit 9539a0b0a9
55 changed files with 1026 additions and 455 deletions
@@ -23,7 +23,11 @@ import { createServiceRef } from '../system';
*/
export namespace coreServices {
/**
* The service reference for the plugin scoped {@link AuthService}.
* Handles token authentication and credentials management.
*
* See {@link AuthService}
* and {@link https://backstage.io/docs/backend-system/core-services/auth | the service docs}
* for more information.
*
* @public
*/
@@ -32,7 +36,11 @@ export namespace coreServices {
});
/**
* The service reference for the plugin scoped {@link UserInfoService}.
* Authenticated user information retrieval.
*
* See {@link UserInfoService}
* and {@link https://backstage.io/docs/backend-system/core-services/user-info | the service docs}
* for more information.
*
* @public
*/
@@ -43,7 +51,11 @@ export namespace coreServices {
});
/**
* The service reference for the plugin scoped {@link CacheService}.
* Key-value store for caching data.
*
* See {@link CacheService}
* and {@link https://backstage.io/docs/backend-system/core-services/cache | the service docs}
* for more information.
*
* @public
*/
@@ -52,7 +64,11 @@ export namespace coreServices {
});
/**
* The service reference for the root scoped {@link RootConfigService}.
* Access to static configuration.
*
* See {@link RootConfigService}
* and {@link https://backstage.io/docs/backend-system/core-services/root-config | the service docs}
* for more information.
*
* @public
*/
@@ -61,7 +77,11 @@ export namespace coreServices {
>({ id: 'core.rootConfig', scope: 'root' });
/**
* The service reference for the plugin scoped {@link DatabaseService}.
* Database access and management via `knex`.
*
* See {@link DatabaseService}
* and {@link https://backstage.io/docs/backend-system/core-services/database | the service docs}
* for more information.
*
* @public
*/
@@ -70,7 +90,11 @@ export namespace coreServices {
>({ id: 'core.database' });
/**
* The service reference for the plugin scoped {@link DiscoveryService}.
* Service discovery for inter-plugin communication.
*
* See {@link DiscoveryService}
* and {@link https://backstage.io/docs/backend-system/core-services/discovery | the service docs}
* for more information.
*
* @public
*/
@@ -79,7 +103,11 @@ export namespace coreServices {
>({ id: 'core.discovery' });
/**
* The service reference for the plugin scoped {@link HttpAuthService}.
* Authentication of HTTP requests.
*
* See {@link HttpAuthService}
* and {@link https://backstage.io/docs/backend-system/core-services/http-auth | the service docs}
* for more information.
*
* @public
*/
@@ -88,7 +116,11 @@ export namespace coreServices {
>({ id: 'core.httpAuth' });
/**
* The service reference for the plugin scoped {@link HttpRouterService}.
* HTTP route registration for plugins.
*
* See {@link HttpRouterService}
* and {@link https://backstage.io/docs/backend-system/core-services/http-router | the service docs}
* for more information.
*
* @public
*/
@@ -97,7 +129,11 @@ export namespace coreServices {
>({ id: 'core.httpRouter' });
/**
* The service reference for the plugin scoped {@link LifecycleService}.
* Registration of plugin startup and shutdown lifecycle hooks.
*
* See {@link LifecycleService}
* and {@link https://backstage.io/docs/backend-system/core-services/lifecycle | the service docs}
* for more information.
*
* @public
*/
@@ -106,7 +142,11 @@ export namespace coreServices {
>({ id: 'core.lifecycle' });
/**
* The service reference for the plugin scoped {@link LoggerService}.
* Plugin-level logging.
*
* See {@link LoggerService}
* and {@link https://backstage.io/docs/backend-system/core-services/logger | the service docs}
* for more information.
*
* @public
*/
@@ -115,7 +155,11 @@ export namespace coreServices {
>({ id: 'core.logger' });
/**
* The service reference for the plugin scoped {@link PermissionsService}.
* Permission system integration for authorization of user actions.
*
* See {@link PermissionsService}
* and {@link https://backstage.io/docs/backend-system/core-services/permissions | the service docs}
* for more information.
*
* @public
*/
@@ -124,7 +168,11 @@ export namespace coreServices {
>({ id: 'core.permissions' });
/**
* The service reference for the plugin scoped {@link PluginMetadataService}.
* Built-in service for accessing metadata about the current plugin.
*
* See {@link PluginMetadataService}
* and {@link https://backstage.io/docs/backend-system/core-services/plugin-metadata | the service docs}
* for more information.
*
* @public
*/
@@ -133,7 +181,11 @@ export namespace coreServices {
>({ id: 'core.pluginMetadata' });
/**
* The service reference for the root scoped {@link RootHttpRouterService}.
* HTTP route registration for root services.
*
* See {@link RootHttpRouterService}
* and {@link https://backstage.io/docs/backend-system/core-services/root-http-router | the service docs}
* for more information.
*
* @public
*/
@@ -142,7 +194,11 @@ export namespace coreServices {
>({ id: 'core.rootHttpRouter', scope: 'root' });
/**
* The service reference for the root scoped {@link RootLifecycleService}.
* Registration of backend startup and shutdown lifecycle hooks.
*
* See {@link RootLifecycleService}
* and {@link https://backstage.io/docs/backend-system/core-services/root-lifecycle | the service docs}
* for more information.
*
* @public
*/
@@ -151,7 +207,11 @@ export namespace coreServices {
>({ id: 'core.rootLifecycle', scope: 'root' });
/**
* The service reference for the root scoped {@link RootLoggerService}.
* Root-level logging.
*
* See {@link RootLoggerService}
* and {@link https://backstage.io/docs/backend-system/core-services/root-logger | the service docs}
* for more information.
*
* @public
*/
@@ -160,7 +220,11 @@ export namespace coreServices {
>({ id: 'core.rootLogger', scope: 'root' });
/**
* The service reference for the plugin scoped {@link SchedulerService}.
* Scheduling of distributed background tasks.
*
* See {@link SchedulerService}
* and {@link https://backstage.io/docs/backend-system/core-services/scheduler | the service docs}
* for more information.
*
* @public
*/
@@ -169,7 +233,11 @@ export namespace coreServices {
>({ id: 'core.scheduler' });
/**
* The service reference for the plugin scoped {@link TokenManagerService}.
* Deprecated service authentication service, use the `auth` service instead.
*
* See {@link TokenManagerService}
* and {@link https://backstage.io/docs/backend-system/core-services/token-manager | the service docs}
* for more information.
*
* @public
* @deprecated Please migrate to the new `coreServices.auth`, `coreServices.httpAuth`, and `coreServices.userInfo` services as needed instead
@@ -179,7 +247,11 @@ export namespace coreServices {
>({ id: 'core.tokenManager' });
/**
* The service reference for the plugin scoped {@link UrlReaderService}.
* Reading content from external systems.
*
* See {@link UrlReaderService}
* and {@link https://backstage.io/docs/backend-system/core-services/url-reader | the service docs}
* for more information.
*
* @public
*/
@@ -188,7 +260,11 @@ export namespace coreServices {
>({ id: 'core.urlReader' });
/**
* The service reference for the plugin scoped {@link IdentityService}.
* Deprecated user authentication service, use the `auth` service instead.
*
* See {@link IdentityService}
* and {@link https://backstage.io/docs/backend-system/core-services/identity | the service docs}
* for more information.
*
* @public
* @deprecated Please migrate to the new `coreServices.auth`, `coreServices.httpAuth`, and `coreServices.userInfo` services as needed instead