From c35e52cfcd204ac0d63bbd49829e5cc6a0900d84 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fredrik=20Adel=C3=B6w?= Date: Mon, 24 Jan 2022 15:50:13 +0100 Subject: [PATCH] switch to alpha MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fredrik Adelöw --- .changeset/rare-comics-tan.md | 8 +++++++- packages/backend-common/api-report.md | 4 ++-- packages/backend-common/package.json | 8 +++++--- packages/backend-common/src/context/Contexts.ts | 2 +- packages/backend-common/src/context/types.ts | 2 +- 5 files changed, 16 insertions(+), 8 deletions(-) diff --git a/.changeset/rare-comics-tan.md b/.changeset/rare-comics-tan.md index 12d615d3f3..338dfba7c2 100644 --- a/.changeset/rare-comics-tan.md +++ b/.changeset/rare-comics-tan.md @@ -2,4 +2,10 @@ '@backstage/backend-common': patch --- -Added a `Context` type for the backend, that can propagate an abort signal, a deadline, and contextual values through the call stack. The main entrypoint is the `Contexts` utility class that provides a root context creator and commonly used decorators. +Added a `Context` type for the backend, that can propagate an abort signal, a +deadline, and contextual values through the call stack. The main entrypoint is +the `Contexts` utility class that provides a root context creator and commonly +used decorators. + +These are marked as `@alpha` for now, and are therefore only accessible via +`@backstage/backend-common/alpha`. diff --git a/packages/backend-common/api-report.md b/packages/backend-common/api-report.md index 478a17d1fd..f53fb9d6e4 100644 --- a/packages/backend-common/api-report.md +++ b/packages/backend-common/api-report.md @@ -147,14 +147,14 @@ export interface ContainerRunner { runContainer(opts: RunContainerOptions): Promise; } -// @public +// @alpha export interface Context { readonly abortSignal: AbortSignal_2; readonly deadline: Date | undefined; value(key: string): T | undefined; } -// @public +// @alpha export class Contexts { static root(): Context; static withAbort( diff --git a/packages/backend-common/package.json b/packages/backend-common/package.json index 3008d915f9..7bde82db0d 100644 --- a/packages/backend-common/package.json +++ b/packages/backend-common/package.json @@ -8,7 +8,8 @@ "publishConfig": { "access": "public", "main": "dist/index.cjs.js", - "types": "dist/index.d.ts" + "types": "dist/index.d.ts", + "alphaTypes": "dist/index.alpha.d.ts" }, "homepage": "https://backstage.io", "repository": { @@ -21,7 +22,7 @@ ], "license": "Apache-2.0", "scripts": { - "build": "backstage-cli build --outputs cjs,types", + "build": "backstage-cli build --experimental-type-build --outputs cjs,types", "lint": "backstage-cli lint", "test": "backstage-cli test", "prepack": "backstage-cli prepack", @@ -111,7 +112,8 @@ }, "files": [ "dist", - "config.d.ts" + "config.d.ts", + "alpha" ], "configSchema": "config.d.ts" } diff --git a/packages/backend-common/src/context/Contexts.ts b/packages/backend-common/src/context/Contexts.ts index 8bb086168a..e22a76f673 100644 --- a/packages/backend-common/src/context/Contexts.ts +++ b/packages/backend-common/src/context/Contexts.ts @@ -24,7 +24,7 @@ import { ValueContext } from './ValueContext'; /** * Common context decorators. * - * @public + * @alpha */ export class Contexts { /** diff --git a/packages/backend-common/src/context/types.ts b/packages/backend-common/src/context/types.ts index 57bf836560..664745bbf6 100644 --- a/packages/backend-common/src/context/types.ts +++ b/packages/backend-common/src/context/types.ts @@ -20,7 +20,7 @@ import { AbortSignal } from 'node-abort-controller'; * A context that is meant to be passed as a ctx variable down the call chain, * to pass along scoped information and abort signals. * - * @public + * @alpha */ export interface Context { /**