@backstage/core-compat-api 0.5.4 → 0.5.5

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @backstage/core-compat-api
 
+## 0.5.5
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/frontend-plugin-api@0.13.2
+  - @backstage/plugin-catalog-react@1.21.4
+  - @backstage/core-plugin-api@1.12.1
+
+## 0.5.5-next.0
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/frontend-plugin-api@0.13.2-next.0
+  - @backstage/core-plugin-api@1.12.1-next.0
+  - @backstage/plugin-catalog-react@1.21.4-next.0
+  - @backstage/types@1.2.2
+  - @backstage/version-bridge@1.0.11
+
 ## 0.5.4
 
 ### Patch Changes

package/dist/core-plugin-api/src/routing/types.esm.js

@@ -2,7 +2,7 @@ import { getOrCreateGlobalSingleton } from '@backstage/version-bridge';
 
 const routeRefType = getOrCreateGlobalSingleton(
   "route-ref-type",
-  () => Symbol("route-ref-type")
+  () => /* @__PURE__ */ Symbol("route-ref-type")
 );
 
 export { routeRefType };

package/dist/core-plugin-api/src/routing/types.esm.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.esm.js","sources":["../../../../../core-plugin-api/src/routing/types.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { getOrCreateGlobalSingleton } from '@backstage/version-bridge';\n\n/**\n * Catch-all type for route params.\n *\n * @public\n */\nexport type AnyRouteRefParams = { [param in string]: string } | undefined;\n\n/**\n * @deprecated use {@link AnyRouteRefParams} instead\n * @public\n */\nexport type AnyParams = AnyRouteRefParams;\n\n/**\n * Type describing the key type of a route parameter mapping.\n *\n * @public\n * @deprecated this type is deprecated and will be removed in the future\n */\nexport type ParamKeys<Params extends AnyParams> = [AnyRouteRefParams] extends [\n  Params,\n]\n  ? string[]\n  : keyof Params extends never\n  ? []\n  : Array<keyof Params>;\n\n/**\n * Optional route params.\n *\n * @public\n * @deprecated this type is deprecated and will be removed in the future\n */\nexport type OptionalParams<Params extends { [param in string]: string }> =\n  Params[keyof Params] extends never ? undefined : Params;\n\n/**\n * TS magic for handling route parameters.\n *\n * @remarks\n *\n * The extra TS magic here is to require a single params argument if the RouteRef\n * had at least one param defined, but require 0 arguments if there are no params defined.\n * Without this we'd have to pass in empty object to all parameter-less RouteRefs\n * just to make TypeScript happy, or we would have to make the argument optional in\n * which case you might forget to pass it in when it is actually required.\n *\n * @public\n */\nexport type RouteFunc<Params extends AnyParams> = (\n  ...[params]: Params extends undefined ? readonly [] : readonly [Params]\n) => string;\n\n/**\n * This symbol is what we use at runtime to determine whether a given object\n * is a type of RouteRef or not. It doesn't work well in TypeScript though since\n * the `unique symbol` will refer to different values between package versions.\n * For that reason we use the marker $$routeRefType to represent the symbol at\n * compile-time instead of using the symbol directly.\n *\n * @internal\n */\nexport const routeRefType: unique symbol = getOrCreateGlobalSingleton<any>(\n  'route-ref-type',\n  () => Symbol('route-ref-type'),\n);\n\n/**\n * Absolute route reference.\n *\n * @remarks\n *\n * See {@link https://backstage.io/docs/plugins/composability#routing-system}.\n *\n * @public\n */\nexport type RouteRef<Params extends AnyParams = any> = {\n  /** @deprecated access to this property will be removed in the future */\n  $$routeRefType: 'absolute'; // See routeRefType above\n\n  /** @deprecated access to this property will be removed in the future */\n  params: ParamKeys<Params>;\n\n  /** Compatibility field for new frontend system */\n  readonly $$type: '@backstage/RouteRef';\n  /** Compatibility field for new frontend system */\n  readonly T: Params;\n};\n\n/**\n * Descriptor of a route relative to an absolute {@link RouteRef}.\n *\n * @remarks\n *\n * See {@link https://backstage.io/docs/plugins/composability#routing-system}.\n *\n * @public\n */\nexport type SubRouteRef<Params extends AnyParams = any> = {\n  /** @deprecated access to this property will be removed in the future */\n  $$routeRefType: 'sub'; // See routeRefType above\n\n  /** @deprecated access to this property will be removed in the future */\n  parent: RouteRef;\n\n  path: string;\n\n  /** @deprecated access to this property will be removed in the future */\n  params: ParamKeys<Params>;\n\n  /** Compatibility field for new frontend system */\n  readonly $$type: '@backstage/SubRouteRef';\n  /** Compatibility field for new frontend system */\n  readonly T: Params;\n};\n\n/**\n * Route descriptor, to be later bound to a concrete route by the app. Used to implement cross-plugin route references.\n *\n * @remarks\n *\n * See {@link https://backstage.io/docs/plugins/composability#routing-system}.\n *\n * @public\n */\nexport type ExternalRouteRef<\n  Params extends AnyParams = any,\n  Optional extends boolean = any,\n> = {\n  /** @deprecated access to this property will be removed in the future */\n  $$routeRefType: 'external'; // See routeRefType above\n\n  /** @deprecated access to this property will be removed in the future */\n  params: ParamKeys<Params>;\n\n  optional?: Optional;\n\n  /** Compatibility field for new frontend system */\n  readonly $$type: '@backstage/ExternalRouteRef';\n  /** Compatibility field for new frontend system */\n  readonly T: Params;\n};\n\n/**\n * @internal\n */\nexport type AnyRouteRef =\n  | RouteRef<any>\n  | SubRouteRef<any>\n  | ExternalRouteRef<any, any>;\n\n/**\n * A duplicate of the react-router RouteObject, but with routeRef added\n * @internal\n */\nexport interface BackstageRouteObject {\n  caseSensitive: boolean;\n  children?: BackstageRouteObject[];\n  element: React.ReactNode;\n  path: string;\n  routeRefs: Set<RouteRef>;\n}\n"],"names":[],"mappings":";;AAgFO,MAAM,YAAA,GAA8B,0BAAA;AAAA,EACzC,gBAAA;AAAA,EACA,MAAM,OAAO,gBAAgB;AAC/B;;;;"}
+{"version":3,"file":"types.esm.js","sources":["../../../../../core-plugin-api/src/routing/types.ts"],"sourcesContent":["/*\n * Copyright 2020 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 { getOrCreateGlobalSingleton } from '@backstage/version-bridge';\n\n/**\n * Catch-all type for route params.\n *\n * @public\n */\nexport type AnyRouteRefParams = { [param in string]: string } | undefined;\n\n/**\n * @deprecated use {@link AnyRouteRefParams} instead\n * @public\n */\nexport type AnyParams = AnyRouteRefParams;\n\n/**\n * Type describing the key type of a route parameter mapping.\n *\n * @public\n * @deprecated this type is deprecated and will be removed in the future\n */\nexport type ParamKeys<Params extends AnyParams> = [AnyRouteRefParams] extends [\n  Params,\n]\n  ? string[]\n  : keyof Params extends never\n  ? []\n  : Array<keyof Params>;\n\n/**\n * Optional route params.\n *\n * @public\n * @deprecated this type is deprecated and will be removed in the future\n */\nexport type OptionalParams<Params extends { [param in string]: string }> =\n  Params[keyof Params] extends never ? undefined : Params;\n\n/**\n * TS magic for handling route parameters.\n *\n * @remarks\n *\n * The extra TS magic here is to require a single params argument if the RouteRef\n * had at least one param defined, but require 0 arguments if there are no params defined.\n * Without this we'd have to pass in empty object to all parameter-less RouteRefs\n * just to make TypeScript happy, or we would have to make the argument optional in\n * which case you might forget to pass it in when it is actually required.\n *\n * @public\n */\nexport type RouteFunc<Params extends AnyParams> = (\n  ...[params]: Params extends undefined ? readonly [] : readonly [Params]\n) => string;\n\n/**\n * This symbol is what we use at runtime to determine whether a given object\n * is a type of RouteRef or not. It doesn't work well in TypeScript though since\n * the `unique symbol` will refer to different values between package versions.\n * For that reason we use the marker $$routeRefType to represent the symbol at\n * compile-time instead of using the symbol directly.\n *\n * @internal\n */\nexport const routeRefType: unique symbol = getOrCreateGlobalSingleton<any>(\n  'route-ref-type',\n  () => Symbol('route-ref-type'),\n);\n\n/**\n * Absolute route reference.\n *\n * @remarks\n *\n * See {@link https://backstage.io/docs/plugins/composability#routing-system}.\n *\n * @public\n */\nexport type RouteRef<Params extends AnyParams = any> = {\n  /** @deprecated access to this property will be removed in the future */\n  $$routeRefType: 'absolute'; // See routeRefType above\n\n  /** @deprecated access to this property will be removed in the future */\n  params: ParamKeys<Params>;\n\n  /** Compatibility field for new frontend system */\n  readonly $$type: '@backstage/RouteRef';\n  /** Compatibility field for new frontend system */\n  readonly T: Params;\n};\n\n/**\n * Descriptor of a route relative to an absolute {@link RouteRef}.\n *\n * @remarks\n *\n * See {@link https://backstage.io/docs/plugins/composability#routing-system}.\n *\n * @public\n */\nexport type SubRouteRef<Params extends AnyParams = any> = {\n  /** @deprecated access to this property will be removed in the future */\n  $$routeRefType: 'sub'; // See routeRefType above\n\n  /** @deprecated access to this property will be removed in the future */\n  parent: RouteRef;\n\n  path: string;\n\n  /** @deprecated access to this property will be removed in the future */\n  params: ParamKeys<Params>;\n\n  /** Compatibility field for new frontend system */\n  readonly $$type: '@backstage/SubRouteRef';\n  /** Compatibility field for new frontend system */\n  readonly T: Params;\n};\n\n/**\n * Route descriptor, to be later bound to a concrete route by the app. Used to implement cross-plugin route references.\n *\n * @remarks\n *\n * See {@link https://backstage.io/docs/plugins/composability#routing-system}.\n *\n * @public\n */\nexport type ExternalRouteRef<\n  Params extends AnyParams = any,\n  Optional extends boolean = any,\n> = {\n  /** @deprecated access to this property will be removed in the future */\n  $$routeRefType: 'external'; // See routeRefType above\n\n  /** @deprecated access to this property will be removed in the future */\n  params: ParamKeys<Params>;\n\n  optional?: Optional;\n\n  /** Compatibility field for new frontend system */\n  readonly $$type: '@backstage/ExternalRouteRef';\n  /** Compatibility field for new frontend system */\n  readonly T: Params;\n};\n\n/**\n * @internal\n */\nexport type AnyRouteRef =\n  | RouteRef<any>\n  | SubRouteRef<any>\n  | ExternalRouteRef<any, any>;\n\n/**\n * A duplicate of the react-router RouteObject, but with routeRef added\n * @internal\n */\nexport interface BackstageRouteObject {\n  caseSensitive: boolean;\n  children?: BackstageRouteObject[];\n  element: React.ReactNode;\n  path: string;\n  routeRefs: Set<RouteRef>;\n}\n"],"names":[],"mappings":";;AAgFO,MAAM,YAAA,GAA8B,0BAAA;AAAA,EACzC,gBAAA;AAAA,EACA,6BAAa,gBAAgB;AAC/B;;;;"}

package/dist/index.d.ts

@@ -201,4 +201,5 @@ declare function convertLegacyRouteRef<TParams extends AnyRouteRefParams>(ref: S
  */
 declare function convertLegacyRouteRef<TParams extends AnyRouteRefParams>(ref: ExternalRouteRef$1<TParams>): ExternalRouteRef<TParams, true>;
 
-export { type ConvertLegacyAppOptions, type ConvertLegacyAppRootOptions, MultipleAnalyticsApi, NoOpAnalyticsApi, type ToNewRouteRef, compatWrapper, convertLegacyApp, convertLegacyAppOptions, convertLegacyAppRoot, convertLegacyPageExtension, convertLegacyPlugin, convertLegacyRouteRef, convertLegacyRouteRefs };
+export { MultipleAnalyticsApi, NoOpAnalyticsApi, compatWrapper, convertLegacyApp, convertLegacyAppOptions, convertLegacyAppRoot, convertLegacyPageExtension, convertLegacyPlugin, convertLegacyRouteRef, convertLegacyRouteRefs };
+export type { ConvertLegacyAppOptions, ConvertLegacyAppRootOptions, ToNewRouteRef };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/core-compat-api",
-  "version": "0.5.4",
+  "version": "0.5.5",
   "backstage": {
     "role": "web-library"
   },
@@ -31,21 +31,21 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/core-plugin-api": "^1.12.0",
-    "@backstage/frontend-plugin-api": "^0.13.0",
-    "@backstage/plugin-catalog-react": "^1.21.3",
+    "@backstage/core-plugin-api": "^1.12.1",
+    "@backstage/frontend-plugin-api": "^0.13.2",
+    "@backstage/plugin-catalog-react": "^1.21.4",
     "@backstage/types": "^1.2.2",
     "@backstage/version-bridge": "^1.0.11",
     "lodash": "^4.17.21",
     "zod": "^3.22.4"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.34.5",
-    "@backstage/core-app-api": "^1.19.2",
-    "@backstage/frontend-app-api": "^0.13.2",
-    "@backstage/frontend-test-utils": "^0.4.1",
-    "@backstage/plugin-catalog": "^1.32.0",
-    "@backstage/test-utils": "^1.7.13",
+    "@backstage/cli": "^0.35.0",
+    "@backstage/core-app-api": "^1.19.3",
+    "@backstage/frontend-app-api": "^0.13.3",
+    "@backstage/frontend-test-utils": "^0.4.2",
+    "@backstage/plugin-catalog": "^1.32.1",
+    "@backstage/test-utils": "^1.7.14",
     "@backstage/types": "^1.2.2",
     "@testing-library/jest-dom": "^6.0.0",
     "@testing-library/react": "^16.0.0",