diff --git a/.changeset/rotten-melons-carry.md b/.changeset/rotten-melons-carry.md index 5e9f849d2f..2f1429c399 100644 --- a/.changeset/rotten-melons-carry.md +++ b/.changeset/rotten-melons-carry.md @@ -5,4 +5,4 @@ '@backstage/plugin-scaffolder-backend': patch --- -Start using the new `@backstage/core-types` package. Initially, this means using the `Observable` and `Json*` types from there. The types also remain in their old places but deprecated, and will be removed in a future release. +Start using the new `@backstage/types` package. Initially, this means using the `Observable` and `Json*` types from there. The types also remain in their old places but deprecated, and will be removed in a future release. diff --git a/packages/config/api-report.md b/packages/config/api-report.md index 116231ac72..205db6ef2b 100644 --- a/packages/config/api-report.md +++ b/packages/config/api-report.md @@ -3,10 +3,10 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import type { JsonArray as JsonArray_2 } from '@backstage/core-types'; -import { JsonObject as JsonObject_2 } from '@backstage/core-types'; -import type { JsonPrimitive as JsonPrimitive_2 } from '@backstage/core-types'; -import { JsonValue as JsonValue_2 } from '@backstage/core-types'; +import type { JsonArray as JsonArray_2 } from '@backstage/types'; +import { JsonObject as JsonObject_2 } from '@backstage/types'; +import type { JsonPrimitive as JsonPrimitive_2 } from '@backstage/types'; +import { JsonValue as JsonValue_2 } from '@backstage/types'; // @public export type AppConfig = { diff --git a/packages/config/package.json b/packages/config/package.json index 7cd39eb2b0..da741b7a3b 100644 --- a/packages/config/package.json +++ b/packages/config/package.json @@ -30,7 +30,7 @@ "clean": "backstage-cli clean" }, "dependencies": { - "@backstage/core-types": "^0.1.0", + "@backstage/types": "^0.1.0", "lodash": "^4.17.21" }, "devDependencies": { diff --git a/packages/config/src/deprecatedTypes.ts b/packages/config/src/deprecatedTypes.ts index 17876f60eb..823825451b 100644 --- a/packages/config/src/deprecatedTypes.ts +++ b/packages/config/src/deprecatedTypes.ts @@ -14,19 +14,19 @@ * limitations under the License. */ -// Temporarily re-export the JSON types from @backstage/core-types +// Temporarily re-export the JSON types from @backstage/types import type { JsonArray as CoreJsonArray, JsonObject as CoreJsonObject, JsonPrimitive as CoreJsonPrimitive, JsonValue as CoreJsonValue, -} from '@backstage/core-types'; +} from '@backstage/types'; /** * A type representing all allowed JSON primitive values. * * @public - * @deprecated Please use the same type from `@backstage/core-types` instead + * @deprecated Please use the same type from `@backstage/types` instead */ export type JsonPrimitive = CoreJsonPrimitive; @@ -34,7 +34,7 @@ export type JsonPrimitive = CoreJsonPrimitive; * A type representing all allowed JSON object values. * * @public - * @deprecated Please use the same type from `@backstage/core-types` instead + * @deprecated Please use the same type from `@backstage/types` instead */ export type JsonObject = CoreJsonObject; @@ -42,7 +42,7 @@ export type JsonObject = CoreJsonObject; * A type representing all allowed JSON array values. * * @public - * @deprecated Please use the same type from `@backstage/core-types` instead + * @deprecated Please use the same type from `@backstage/types` instead */ export type JsonArray = CoreJsonArray; @@ -50,6 +50,6 @@ export type JsonArray = CoreJsonArray; * A type representing all allowed JSON values. * * @public - * @deprecated Please use the same type from `@backstage/core-types` instead + * @deprecated Please use the same type from `@backstage/types` instead */ export type JsonValue = CoreJsonValue; diff --git a/packages/config/src/reader.ts b/packages/config/src/reader.ts index fee1b34569..bc8a860c85 100644 --- a/packages/config/src/reader.ts +++ b/packages/config/src/reader.ts @@ -14,7 +14,7 @@ * limitations under the License. */ -import { JsonValue, JsonObject } from '@backstage/core-types'; +import { JsonValue, JsonObject } from '@backstage/types'; import { AppConfig, Config } from './types'; import cloneDeep from 'lodash/cloneDeep'; import mergeWith from 'lodash/mergeWith'; diff --git a/packages/config/src/types.ts b/packages/config/src/types.ts index e98dee9fa7..a543233277 100644 --- a/packages/config/src/types.ts +++ b/packages/config/src/types.ts @@ -14,7 +14,7 @@ * limitations under the License. */ -import { JsonObject, JsonValue } from '@backstage/core-types'; +import { JsonObject, JsonValue } from '@backstage/types'; /** * A serialized form of configuration data that carries additional context. diff --git a/packages/core-app-api/api-report.md b/packages/core-app-api/api-report.md index bfeaa7f678..f47ad2e791 100644 --- a/packages/core-app-api/api-report.md +++ b/packages/core-app-api/api-report.md @@ -40,7 +40,7 @@ import { microsoftAuthApiRef } from '@backstage/core-plugin-api'; import { OAuthApi } from '@backstage/core-plugin-api'; import { OAuthRequestApi } from '@backstage/core-plugin-api'; import { Observable } from '@backstage/core-plugin-api'; -import { Observable as Observable_2 } from '@backstage/core-types'; +import { Observable as Observable_2 } from '@backstage/types'; import { oktaAuthApiRef } from '@backstage/core-plugin-api'; import { oneloginAuthApiRef } from '@backstage/core-plugin-api'; import { OpenIdConnectApi } from '@backstage/core-plugin-api'; diff --git a/packages/core-plugin-api/api-report.md b/packages/core-plugin-api/api-report.md index 765cdaa21c..0347b4b018 100644 --- a/packages/core-plugin-api/api-report.md +++ b/packages/core-plugin-api/api-report.md @@ -8,12 +8,12 @@ import { BackstageTheme } from '@backstage/theme'; import { ComponentType } from 'react'; import { Config } from '@backstage/config'; -import { Observable as Observable_2 } from '@backstage/core-types'; -import { Observer as Observer_2 } from '@backstage/core-types'; +import { Observable as Observable_2 } from '@backstage/types'; +import { Observer as Observer_2 } from '@backstage/types'; import { default as React_2 } from 'react'; import { ReactElement } from 'react'; import { ReactNode } from 'react'; -import { Subscription as Subscription_2 } from '@backstage/core-types'; +import { Subscription as Subscription_2 } from '@backstage/types'; import { SvgIconProps } from '@material-ui/core'; // Warning: (ae-missing-release-tag) "AlertApi" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) diff --git a/packages/core-plugin-api/package.json b/packages/core-plugin-api/package.json index fbb2760e59..938ddc63e3 100644 --- a/packages/core-plugin-api/package.json +++ b/packages/core-plugin-api/package.json @@ -30,8 +30,8 @@ }, "dependencies": { "@backstage/config": "^0.1.9", - "@backstage/core-types": "^0.1.0", "@backstage/theme": "^0.2.9", + "@backstage/types": "^0.1.0", "@backstage/version-bridge": "^0.1.0", "@material-ui/core": "^4.12.2", "@types/react": "*", diff --git a/packages/core-plugin-api/src/apis/definitions/AlertApi.ts b/packages/core-plugin-api/src/apis/definitions/AlertApi.ts index ecd12c533a..7110c1d9f8 100644 --- a/packages/core-plugin-api/src/apis/definitions/AlertApi.ts +++ b/packages/core-plugin-api/src/apis/definitions/AlertApi.ts @@ -15,7 +15,7 @@ */ import { createApiRef, ApiRef } from '../system'; -import { Observable } from '@backstage/core-types'; +import { Observable } from '@backstage/types'; export type AlertMessage = { message: string; diff --git a/packages/core-plugin-api/src/apis/definitions/AppThemeApi.ts b/packages/core-plugin-api/src/apis/definitions/AppThemeApi.ts index 8608b53593..5ac16f83fd 100644 --- a/packages/core-plugin-api/src/apis/definitions/AppThemeApi.ts +++ b/packages/core-plugin-api/src/apis/definitions/AppThemeApi.ts @@ -16,7 +16,7 @@ import { ApiRef, createApiRef } from '../system'; import { BackstageTheme } from '@backstage/theme'; -import { Observable } from '@backstage/core-types'; +import { Observable } from '@backstage/types'; /** * Describes a theme provided by the app. diff --git a/packages/core-plugin-api/src/apis/definitions/ErrorApi.ts b/packages/core-plugin-api/src/apis/definitions/ErrorApi.ts index 6fd47ac966..69c331bc06 100644 --- a/packages/core-plugin-api/src/apis/definitions/ErrorApi.ts +++ b/packages/core-plugin-api/src/apis/definitions/ErrorApi.ts @@ -15,7 +15,7 @@ */ import { ApiRef, createApiRef } from '../system'; -import { Observable } from '@backstage/core-types'; +import { Observable } from '@backstage/types'; /** * Mirrors the JavaScript Error class, for the purpose of diff --git a/packages/core-plugin-api/src/apis/definitions/OAuthRequestApi.ts b/packages/core-plugin-api/src/apis/definitions/OAuthRequestApi.ts index 43351edaf8..14609f5b3a 100644 --- a/packages/core-plugin-api/src/apis/definitions/OAuthRequestApi.ts +++ b/packages/core-plugin-api/src/apis/definitions/OAuthRequestApi.ts @@ -15,7 +15,7 @@ */ import { IconComponent } from '../../icons/types'; -import { Observable } from '@backstage/core-types'; +import { Observable } from '@backstage/types'; import { ApiRef, createApiRef } from '../system'; /** diff --git a/packages/core-plugin-api/src/apis/definitions/StorageApi.ts b/packages/core-plugin-api/src/apis/definitions/StorageApi.ts index 7951403040..f9a52a0bf4 100644 --- a/packages/core-plugin-api/src/apis/definitions/StorageApi.ts +++ b/packages/core-plugin-api/src/apis/definitions/StorageApi.ts @@ -15,7 +15,7 @@ */ import { ApiRef, createApiRef } from '../system'; -import { Observable } from '@backstage/core-types'; +import { Observable } from '@backstage/types'; export type StorageValueChange = { key: string; diff --git a/packages/core-plugin-api/src/apis/definitions/auth.ts b/packages/core-plugin-api/src/apis/definitions/auth.ts index 314f2955cf..e1c56279d9 100644 --- a/packages/core-plugin-api/src/apis/definitions/auth.ts +++ b/packages/core-plugin-api/src/apis/definitions/auth.ts @@ -15,7 +15,7 @@ */ import { ApiRef, createApiRef } from '../system'; -import { Observable } from '@backstage/core-types'; +import { Observable } from '@backstage/types'; /** * This file contains declarations for common interfaces of auth-related APIs. diff --git a/packages/core-plugin-api/src/deprecatedTypes.ts b/packages/core-plugin-api/src/deprecatedTypes.ts index 598f666317..605dc72ee3 100644 --- a/packages/core-plugin-api/src/deprecatedTypes.ts +++ b/packages/core-plugin-api/src/deprecatedTypes.ts @@ -18,19 +18,19 @@ import { Observer as CoreObserver, Subscription as CoreSubscription, Observable as CoreObservable, -} from '@backstage/core-types'; +} from '@backstage/types'; /** * Observer interface for consuming an Observer, see TC39. * - * @deprecated Please use the same type from `@backstage/core-types` instead + * @deprecated Please use the same type from `@backstage/types` instead */ export type Observer = CoreObserver; /** * Subscription returned when subscribing to an Observable, see TC39. * - * @deprecated Please use the same type from `@backstage/core-types` instead + * @deprecated Please use the same type from `@backstage/types` instead */ export type Subscription = CoreSubscription; @@ -42,6 +42,6 @@ export type Subscription = CoreSubscription; * This is used as a common return type for observable values and can be created * using many different observable implementations, such as zen-observable or RxJS 5. * - * @deprecated Please use the same type from `@backstage/core-types` instead + * @deprecated Please use the same type from `@backstage/types` instead */ export type Observable = CoreObservable; diff --git a/packages/core-types/.eslintrc.js b/packages/types/.eslintrc.js similarity index 100% rename from packages/core-types/.eslintrc.js rename to packages/types/.eslintrc.js diff --git a/packages/core-types/README.md b/packages/types/README.md similarity index 82% rename from packages/core-types/README.md rename to packages/types/README.md index 52bd1fa7a5..4462890ed2 100644 --- a/packages/core-types/README.md +++ b/packages/types/README.md @@ -1,4 +1,4 @@ -# Common core types used within Backstage +# Common TypeScript types used within Backstage Contains some common types that are used widely within the rest of the Backstage project and in plugins. diff --git a/packages/core-types/api-report.md b/packages/types/api-report.md similarity index 94% rename from packages/core-types/api-report.md rename to packages/types/api-report.md index 09611f63e1..43e3cfee0e 100644 --- a/packages/core-types/api-report.md +++ b/packages/types/api-report.md @@ -1,4 +1,4 @@ -## API Report File for "@backstage/core-types" +## API Report File for "@backstage/types" > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). diff --git a/packages/core-types/package.json b/packages/types/package.json similarity index 85% rename from packages/core-types/package.json rename to packages/types/package.json index ce6fc05fb4..8274c1ce74 100644 --- a/packages/core-types/package.json +++ b/packages/types/package.json @@ -1,6 +1,6 @@ { - "name": "@backstage/core-types", - "description": "Common core types used within Backstage", + "name": "@backstage/types", + "description": "Common TypeScript types used within Backstage", "version": "0.1.0", "main": "src/index.ts", "types": "src/index.ts", @@ -16,7 +16,7 @@ "repository": { "type": "git", "url": "https://github.com/backstage/backstage", - "directory": "packages/core-types" + "directory": "packages/types" }, "keywords": [ "backstage" diff --git a/packages/core-types/src/index.ts b/packages/types/src/index.ts similarity index 94% rename from packages/core-types/src/index.ts rename to packages/types/src/index.ts index 9e7a33c5f2..1f1b13c349 100644 --- a/packages/core-types/src/index.ts +++ b/packages/types/src/index.ts @@ -15,7 +15,7 @@ */ /** - * Common core types used within Backstage + * Common TypeScript types used within Backstage * * @packageDocumentation */ diff --git a/packages/core-types/src/json.ts b/packages/types/src/json.ts similarity index 100% rename from packages/core-types/src/json.ts rename to packages/types/src/json.ts diff --git a/packages/core-types/src/observable.ts b/packages/types/src/observable.ts similarity index 100% rename from packages/core-types/src/observable.ts rename to packages/types/src/observable.ts diff --git a/packages/core-types/src/setupTests.ts b/packages/types/src/setupTests.ts similarity index 100% rename from packages/core-types/src/setupTests.ts rename to packages/types/src/setupTests.ts diff --git a/plugins/scaffolder-backend/api-report.md b/plugins/scaffolder-backend/api-report.md index 9dd86eeddc..07c6c7a57d 100644 --- a/plugins/scaffolder-backend/api-report.md +++ b/plugins/scaffolder-backend/api-report.md @@ -15,9 +15,9 @@ import { createPullRequest } from 'octokit-plugin-create-pull-request'; import { Entity } from '@backstage/catalog-model'; import express from 'express'; import { JsonObject } from '@backstage/config'; -import { JsonObject as JsonObject_2 } from '@backstage/core-types'; +import { JsonObject as JsonObject_2 } from '@backstage/types'; import { JsonValue } from '@backstage/config'; -import { JsonValue as JsonValue_2 } from '@backstage/core-types'; +import { JsonValue as JsonValue_2 } from '@backstage/types'; import { LocationSpec } from '@backstage/catalog-model'; import { Logger as Logger_2 } from 'winston'; import { Octokit } from '@octokit/rest';