paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 31 Packages Projects Releases Wiki Activity

backend-plugin-api: fix API report warnings

Browse Source 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2022-07-08 10:56:46 +02:00
parent 922f53f592
commit a3cdfcd078
3 changed files with 27 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/backend-plugin-api/api-report.md
+10 -27
View File
@@ -14,8 +14,6 @@ import { PluginTaskScheduler } from '@backstage/backend-tasks';
import { TokenManager } from '@backstage/backend-common';
import { UrlReader } from '@backstage/backend-common';
// Warning: (ae-missing-release-tag) "AnyServiceFactory" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type AnyServiceFactory = ServiceFactory<
unknown,
@@ -25,8 +23,6 @@ export type AnyServiceFactory = ServiceFactory<
}
>;
// Warning: (ae-missing-release-tag) "BackendInitRegistry" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export interface BackendInitRegistry {
// (undocumented)
@@ -47,8 +43,6 @@ export interface BackendInitRegistry {
}): void;
}
// Warning: (ae-missing-release-tag) "BackendModuleConfig" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export interface BackendModuleConfig<TOptions> {
// (undocumented)
@@ -62,8 +56,6 @@ export interface BackendModuleConfig<TOptions> {
): void;
}
// Warning: (ae-missing-release-tag) "BackendPluginConfig" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export interface BackendPluginConfig<TOptions> {
// (undocumented)
@@ -72,8 +64,6 @@ export interface BackendPluginConfig<TOptions> {
register(reg: BackendInitRegistry, options: TOptions): void;
}
// Warning: (ae-missing-release-tag) "BackendRegistrable" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export interface BackendRegistrable {
// (undocumented)
@@ -88,22 +78,16 @@ export const cacheServiceRef: ServiceRef<PluginCacheManager>;
// @public (undocumented)
export const configServiceRef: ServiceRef<Config>;
// Warning: (ae-missing-release-tag) "createBackendModule" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export function createBackendModule<TOptions>(
config: BackendModuleConfig<TOptions>,
): (option: TOptions) => BackendRegistrable;
// Warning: (ae-missing-release-tag) "createBackendPlugin" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export function createBackendPlugin<TOptions>(
config: BackendPluginConfig<TOptions>,
): (option: TOptions) => BackendRegistrable;
// Warning: (ae-missing-release-tag) "createExtensionPoint" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export function createExtensionPoint<T>(options: {
id: string;
@@ -124,6 +108,11 @@ export function createServiceRef<T>(options: { id: string }): ServiceRef<T>;
// @public (undocumented)
export const databaseServiceRef: ServiceRef<PluginDatabaseManager>;
// @public (undocumented)
export type DepsToDepFactories<T> = {
[key in keyof T]: (pluginId: string) => Promise<T[key]>;
};
// @public (undocumented)
export const discoveryServiceRef: ServiceRef<PluginEndpointDiscovery>;
@@ -135,8 +124,6 @@ export type ExtensionPoint<T> = {
$$ref: 'extension-point';
};
// Warning: (ae-missing-release-tag) "FactoryFunc" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type FactoryFunc<Impl> = (pluginId: string) => Promise<Impl>;
@@ -168,8 +155,6 @@ export const permissionsServiceRef: ServiceRef<
// @public (undocumented)
export const schedulerServiceRef: ServiceRef<PluginTaskScheduler>;
// Warning: (ae-missing-release-tag) "ServiceFactory" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type ServiceFactory<
TApi,
@@ -195,12 +180,10 @@ export type ServiceRef<T> = {
export const tokenManagerServiceRef: ServiceRef<TokenManager>;
// @public (undocumented)
export const urlReaderServiceRef: ServiceRef<UrlReader>;
export type TypesToServiceRef<T> = {
[key in keyof T]: ServiceRef<T[key]>;
};
// Warnings were encountered during analysis:
//
// src/services/system/types.d.ts:27:5 - (ae-forgotten-export) The symbol "TypesToServiceRef" needs to be exported by the entry point index.d.ts
// src/services/system/types.d.ts:28:5 - (ae-forgotten-export) The symbol "DepsToDepFactories" needs to be exported by the entry point index.d.ts
// src/wiring/types.d.ts:10:67 - (tsdoc-code-span-missing-delimiter) The code span is missing its closing backtick
// src/wiring/types.d.ts:11:24 - (tsdoc-code-span-missing-delimiter) The code span is missing its closing backtick
// @public (undocumented)
export const urlReaderServiceRef: ServiceRef<UrlReader>;
```
packages/backend-plugin-api/src/services/system/types.ts
+8 -2
View File
@@ -33,13 +33,18 @@ export type ServiceRef<T> = {
$$ref: 'service';
};
type TypesToServiceRef<T> = { [key in keyof T]: ServiceRef<T[key]> };
type DepsToDepFactories<T> = {
/** @public */
export type TypesToServiceRef<T> = { [key in keyof T]: ServiceRef<T[key]> };
/** @public */
export type DepsToDepFactories<T> = {
[key in keyof T]: (pluginId: string) => Promise<T[key]>;
};
/** @public */
export type FactoryFunc<Impl> = (pluginId: string) => Promise<Impl>;
/** @public */
export type ServiceFactory<
TApi,
TImpl extends TApi,
@@ -50,6 +55,7 @@ export type ServiceFactory<
factory(deps: DepsToDepFactories<TDeps>): Promise<FactoryFunc<TImpl>>;
};
/** @public */
export type AnyServiceFactory = ServiceFactory<
unknown,
unknown,
packages/backend-plugin-api/src/wiring/types.ts
+9 -3
View File
@@ -25,9 +25,8 @@ export type ExtensionPoint<T> = {
id: string;
/**
* Utility for getting the type of the extension point, using `typeof
* extensionPoint.T`. Attempting to actually read this value will result in an
* exception.
* Utility for getting the type of the extension point, using `typeof extensionPoint.T`.
* Attempting to actually read this value will result in an exception.
*/
T: T;
@@ -36,6 +35,7 @@ export type ExtensionPoint<T> = {
$$ref: 'extension-point';
};
/** @public */
export function createExtensionPoint<T>(options: {
id: string;
}): ExtensionPoint<T> {
@@ -51,6 +51,7 @@ export function createExtensionPoint<T>(options: {
};
}
/** @public */
export interface BackendInitRegistry {
registerExtensionPoint<TExtensionPoint>(
ref: ServiceRef<TExtensionPoint>,
@@ -62,16 +63,19 @@ export interface BackendInitRegistry {
}): void;
}
/** @public */
export interface BackendRegistrable {
id: string;
register(reg: BackendInitRegistry): void;
}
/** @public */
export interface BackendPluginConfig<TOptions> {
id: string;
register(reg: BackendInitRegistry, options: TOptions): void;
}
/** @public */
export function createBackendPlugin<TOptions>(
config: BackendPluginConfig<TOptions>,
): (option: TOptions) => BackendRegistrable {
@@ -83,6 +87,7 @@ export function createBackendPlugin<TOptions>(
});
}
/** @public */
export interface BackendModuleConfig<TOptions> {
pluginId: string;
moduleId: string;
@@ -92,6 +97,7 @@ export interface BackendModuleConfig<TOptions> {
): void;
}
/** @public */
export function createBackendModule<TOptions>(
config: BackendModuleConfig<TOptions>,
): (option: TOptions) => BackendRegistrable {