@backstage/frontend-plugin-api 0.0.0

package/CHANGELOG.md

@@ -0,0 +1,9 @@
+# @backstage/frontend-plugin-api
+
+## 0.0.1-next.0
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/core-plugin-api@1.6.0-next.2
+  - @backstage/types@1.1.0

package/README.md

@@ -0,0 +1,9 @@
+# @backstage/frontend-plugin-api
+
+**This package is EXPERIMENTAL, we recommend against using it for production deployments**
+
+This package provides the core API used by Backstage frontend plugins. It implements the design outlined in [RFC: Frontend System Evolution](https://github.com/backstage/backstage/issues/18372).
+
+## Documentation
+
+- [Backstage Documentation](https://backstage.io/docs)

package/dist/index.d.ts

@@ -0,0 +1,181 @@
+/// <reference types="react" />
+import React, { ComponentType, ReactNode } from 'react';
+import { JsonObject } from '@backstage/types';
+import { AnyApiFactory, RouteRef, AnyApiRef } from '@backstage/core-plugin-api';
+import { z, ZodSchema, ZodTypeDef } from 'zod';
+
+/** @public */
+type ExtensionDataRef<TData, TConfig extends {
+    optional?: true;
+} = {}> = {
+    id: string;
+    T: TData;
+    config: TConfig;
+    $$type: 'extension-data';
+};
+/** @public */
+interface ConfigurableExtensionDataRef<TData, TConfig extends {
+    optional?: true;
+} = {}> extends ExtensionDataRef<TData, TConfig> {
+    optional(): ConfigurableExtensionDataRef<TData, TData & {
+        optional: true;
+    }>;
+}
+/** @public */
+declare function createExtensionDataRef<TData>(id: string): ConfigurableExtensionDataRef<TData>;
+
+/** @public */
+declare const coreExtensionData: {
+    reactComponent: ConfigurableExtensionDataRef<ComponentType<{}>, {}>;
+    routePath: ConfigurableExtensionDataRef<string, {}>;
+    apiFactory: ConfigurableExtensionDataRef<AnyApiFactory, {}>;
+    routeRef: ConfigurableExtensionDataRef<RouteRef<any>, {}>;
+};
+
+/** @public */
+type PortableSchema<TOutput> = {
+    parse: (input: unknown) => TOutput;
+    schema: JsonObject;
+};
+
+/** @public */
+declare function createSchemaFromZod<TOutput, TInput>(schemaCreator: (zImpl: typeof z) => ZodSchema<TOutput, ZodTypeDef, TInput>): PortableSchema<TOutput>;
+
+/** @public */
+type AnyExtensionDataMap = {
+    [name in string]: ExtensionDataRef<any, any>;
+};
+/** @public */
+interface Extension<TConfig> {
+    $$type: 'extension';
+    id: string;
+    at: string;
+    disabled: boolean;
+    inputs: Record<string, {
+        extensionData: AnyExtensionDataMap;
+    }>;
+    output: AnyExtensionDataMap;
+    configSchema?: PortableSchema<TConfig>;
+    factory(options: {
+        source?: BackstagePlugin;
+        bind: ExtensionDataBind<AnyExtensionDataMap>;
+        config: TConfig;
+        inputs: Record<string, Array<Record<string, unknown>>>;
+    }): void;
+}
+
+/** @public */
+interface PluginOptions {
+    id: string;
+    extensions?: Extension<unknown>[];
+}
+/** @public */
+interface BackstagePlugin {
+    $$type: 'backstage-plugin';
+    id: string;
+    extensions: Extension<unknown>[];
+}
+/** @public */
+declare function createPlugin(options: PluginOptions): BackstagePlugin;
+
+/** @public */
+type ExtensionDataInputValues<TInputs extends {
+    [name in string]: {
+        extensionData: AnyExtensionDataMap;
+    };
+}> = {
+    [InputName in keyof TInputs]: Array<{
+        [DataName in keyof TInputs[InputName]['extensionData'] as TInputs[InputName]['extensionData'][DataName]['config'] extends {
+            optional: true;
+        } ? never : DataName]: TInputs[InputName]['extensionData'][DataName]['T'];
+    } & {
+        [DataName in keyof TInputs[InputName]['extensionData'] as TInputs[InputName]['extensionData'][DataName]['config'] extends {
+            optional: true;
+        } ? DataName : never]?: TInputs[InputName]['extensionData'][DataName]['T'];
+    }>;
+};
+/** @public */
+type ExtensionDataBind<TMap extends AnyExtensionDataMap> = (values: {
+    [DataName in keyof TMap as TMap[DataName]['config'] extends {
+        optional: true;
+    } ? never : DataName]: TMap[DataName]['T'];
+} & {
+    [DataName in keyof TMap as TMap[DataName]['config'] extends {
+        optional: true;
+    } ? DataName : never]?: TMap[DataName]['T'];
+}) => void;
+/** @public */
+interface CreateExtensionOptions<TOutput extends AnyExtensionDataMap, TInputs extends Record<string, {
+    extensionData: AnyExtensionDataMap;
+}>, TConfig> {
+    id: string;
+    at: string;
+    disabled?: boolean;
+    inputs?: TInputs;
+    output: TOutput;
+    configSchema?: PortableSchema<TConfig>;
+    factory(options: {
+        source?: BackstagePlugin;
+        bind: ExtensionDataBind<TOutput>;
+        config: TConfig;
+        inputs: ExtensionDataInputValues<TInputs>;
+    }): void;
+}
+/** @public */
+declare function createExtension<TOutput extends AnyExtensionDataMap, TInputs extends Record<string, {
+    extensionData: AnyExtensionDataMap;
+}>, TConfig = never>(options: CreateExtensionOptions<TOutput, TInputs, TConfig>): Extension<TConfig>;
+
+/** @public */
+interface ExtensionBoundaryProps {
+    children: ReactNode;
+    source?: BackstagePlugin;
+}
+/** @public */
+declare function ExtensionBoundary(props: ExtensionBoundaryProps): React.JSX.Element;
+
+/** @public */
+declare function createApiExtension<TConfig extends {}, TInputs extends Record<string, {
+    extensionData: AnyExtensionDataMap;
+}>>(options: ({
+    api: AnyApiRef;
+    factory: (options: {
+        config: TConfig;
+        inputs: ExtensionDataInputValues<TInputs>;
+    }) => AnyApiFactory;
+} | {
+    factory: AnyApiFactory;
+}) & {
+    configSchema?: PortableSchema<TConfig>;
+    inputs?: TInputs;
+}): Extension<TConfig>;
+
+/**
+ * Helper for creating extensions for a routable React page component.
+ *
+ * @public
+ */
+declare function createPageExtension<TConfig extends {
+    path: string;
+}, TInputs extends Record<string, {
+    extensionData: AnyExtensionDataMap;
+}>>(options: ({
+    defaultPath: string;
+} | {
+    configSchema: PortableSchema<TConfig>;
+}) & {
+    id: string;
+    at?: string;
+    disabled?: boolean;
+    inputs?: TInputs;
+    routeRef?: RouteRef;
+    component: (props: {
+        config: TConfig;
+        inputs: ExtensionDataInputValues<TInputs>;
+    }) => Promise<JSX.Element>;
+}): Extension<TConfig>;
+
+/** @public */
+declare function useRouteRef(routeRef: RouteRef<any>): () => string;
+
+export { AnyExtensionDataMap, BackstagePlugin, ConfigurableExtensionDataRef, CreateExtensionOptions, Extension, ExtensionBoundary, ExtensionBoundaryProps, ExtensionDataBind, ExtensionDataInputValues, ExtensionDataRef, PluginOptions, PortableSchema, coreExtensionData, createApiExtension, createExtension, createExtensionDataRef, createPageExtension, createPlugin, createSchemaFromZod, useRouteRef };

package/dist/index.esm.js

@@ -0,0 +1,148 @@
+import React, { useContext, useMemo } from 'react';
+import { z } from 'zod';
+import zodToJsonSchema from 'zod-to-json-schema';
+import { RoutingContext } from '@backstage/frontend-app-api/src/routing/RoutingContext';
+import { useLocation } from 'react-router-dom';
+
+function ExtensionBoundary(props) {
+  return /* @__PURE__ */ React.createElement(React.Fragment, null, props.children);
+}
+
+function createExtensionDataRef(id) {
+  return {
+    id,
+    $$type: "extension-data",
+    config: {},
+    optional() {
+      return { ...this, config: { ...this.config, optional: true } };
+    }
+  };
+}
+
+const coreExtensionData = {
+  reactComponent: createExtensionDataRef("core.reactComponent"),
+  routePath: createExtensionDataRef("core.routing.path"),
+  apiFactory: createExtensionDataRef("core.api.factory"),
+  routeRef: createExtensionDataRef("core.routing.ref")
+};
+
+function createExtension(options) {
+  var _a, _b;
+  return {
+    ...options,
+    disabled: (_a = options.disabled) != null ? _a : false,
+    $$type: "extension",
+    inputs: (_b = options.inputs) != null ? _b : {},
+    factory({ bind, config, inputs }) {
+      return options.factory({
+        bind,
+        config,
+        inputs
+      });
+    }
+  };
+}
+
+function createPlugin(options) {
+  var _a;
+  return {
+    ...options,
+    $$type: "backstage-plugin",
+    extensions: (_a = options.extensions) != null ? _a : []
+  };
+}
+
+function createApiExtension(options) {
+  const { factory, configSchema, inputs: extensionInputs } = options;
+  const apiRef = "api" in options ? options.api : factory.api;
+  return createExtension({
+    id: `apis.${apiRef.id}`,
+    at: "core/apis",
+    inputs: extensionInputs,
+    configSchema,
+    output: {
+      api: coreExtensionData.apiFactory
+    },
+    factory({ bind, config, inputs }) {
+      if (typeof factory === "function") {
+        bind({ api: factory({ config, inputs }) });
+      } else {
+        bind({ api: factory });
+      }
+    }
+  });
+}
+
+function createSchemaFromZod(schemaCreator) {
+  const schema = schemaCreator(z);
+  return {
+    // TODO: Types allow z.array etc here but it will break stuff
+    parse: (input) => {
+      const result = schema.safeParse(input);
+      if (result.success) {
+        return result.data;
+      }
+      throw new Error(result.error.issues.map(formatIssue).join("; "));
+    },
+    // TODO: Verify why we are not compatible with the latest zodToJsonSchema.
+    schema: zodToJsonSchema(schema)
+  };
+}
+function formatIssue(issue) {
+  if (issue.code === "invalid_union") {
+    return formatIssue(issue.unionErrors[0].issues[0]);
+  }
+  let message = issue.message;
+  if (message === "Required") {
+    message = `Missing required value`;
+  }
+  if (issue.path.length) {
+    message += ` at '${issue.path.join(".")}'`;
+  }
+  return message;
+}
+
+function createPageExtension(options) {
+  var _a;
+  const configSchema = "configSchema" in options ? options.configSchema : createSchemaFromZod(
+    (z) => z.object({ path: z.string().default(options.defaultPath) })
+  );
+  return createExtension({
+    id: options.id,
+    at: (_a = options.at) != null ? _a : "core.router/routes",
+    disabled: options.disabled,
+    output: {
+      component: coreExtensionData.reactComponent,
+      path: coreExtensionData.routePath,
+      routeRef: coreExtensionData.routeRef.optional()
+    },
+    inputs: options.inputs,
+    configSchema,
+    factory({ bind, config, inputs, source }) {
+      const LazyComponent = React.lazy(
+        () => options.component({ config, inputs }).then((element) => ({ default: () => element }))
+      );
+      bind({
+        path: config.path,
+        component: () => /* @__PURE__ */ React.createElement(ExtensionBoundary, { source }, /* @__PURE__ */ React.createElement(React.Suspense, { fallback: "..." }, /* @__PURE__ */ React.createElement(LazyComponent, null))),
+        routeRef: options.routeRef
+      });
+    }
+  });
+}
+
+function useRouteRef(routeRef) {
+  const { pathname } = useLocation();
+  const resolver = useContext(RoutingContext);
+  const routeFunc = useMemo(
+    () => resolver && resolver.resolve(routeRef, { pathname }),
+    [resolver, routeRef, pathname]
+  );
+  if (!routeFunc) {
+    throw new Error(`Failed to resolve routeRef ${routeRef}`);
+  }
+  return routeFunc;
+}
+
+export { ExtensionBoundary, coreExtensionData, createApiExtension, createExtension, createExtensionDataRef, createPageExtension, createPlugin, createSchemaFromZod, useRouteRef };
+//# sourceMappingURL=index.esm.js.map

package/dist/index.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.esm.js","sources":["../src/components/ExtensionBoundary.tsx","../src/wiring/createExtensionDataRef.ts","../src/wiring/coreExtensionData.ts","../src/wiring/createExtension.ts","../src/wiring/createPlugin.ts","../src/extensions/createApiExtension.ts","../src/schema/createSchemaFromZod.ts","../src/extensions/createPageExtension.tsx","../src/routing/useRouteRef.ts"],"sourcesContent":["/*\n * Copyright 2023 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 React, { ReactNode } from 'react';\nimport { BackstagePlugin } from '../wiring';\n\n/** @public */\nexport interface ExtensionBoundaryProps {\n  children: ReactNode;\n  source?: BackstagePlugin;\n}\n\n/** @public */\nexport function ExtensionBoundary(props: ExtensionBoundaryProps) {\n  return <>{props.children}</>;\n}\n","/*\n * Copyright 2023 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\n/** @public */\nexport type ExtensionDataRef<\n  TData,\n  TConfig extends { optional?: true } = {},\n> = {\n  id: string;\n  T: TData;\n  config: TConfig;\n  $$type: 'extension-data';\n};\n\n/** @public */\nexport interface ConfigurableExtensionDataRef<\n  TData,\n  TConfig extends { optional?: true } = {},\n> extends ExtensionDataRef<TData, TConfig> {\n  optional(): ConfigurableExtensionDataRef<TData, TData & { optional: true }>;\n}\n\n// TODO: change to options object with ID.\n/** @public */\nexport function createExtensionDataRef<TData>(\n  id: string,\n): ConfigurableExtensionDataRef<TData> {\n  return {\n    id,\n    $$type: 'extension-data',\n    config: {},\n    optional() {\n      return { ...this, config: { ...this.config, optional: true } };\n    },\n  } as ConfigurableExtensionDataRef<TData>;\n}\n","/*\n * Copyright 2023 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 { AnyApiFactory, RouteRef } from '@backstage/core-plugin-api';\nimport { ComponentType } from 'react';\nimport { createExtensionDataRef } from './createExtensionDataRef';\n\n/** @public */\nexport const coreExtensionData = {\n  reactComponent: createExtensionDataRef<ComponentType>('core.reactComponent'),\n  routePath: createExtensionDataRef<string>('core.routing.path'),\n  apiFactory: createExtensionDataRef<AnyApiFactory>('core.api.factory'),\n  routeRef: createExtensionDataRef<RouteRef>('core.routing.ref'),\n};\n","/*\n * Copyright 2023 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 { PortableSchema } from '../schema';\nimport { BackstagePlugin } from './createPlugin';\nimport { AnyExtensionDataMap, Extension } from './types';\n\n/** @public */\nexport type ExtensionDataInputValues<\n  TInputs extends { [name in string]: { extensionData: AnyExtensionDataMap } },\n> = {\n  [InputName in keyof TInputs]: Array<\n    {\n      [DataName in keyof TInputs[InputName]['extensionData'] as TInputs[InputName]['extensionData'][DataName]['config'] extends {\n        optional: true;\n      }\n        ? never\n        : DataName]: TInputs[InputName]['extensionData'][DataName]['T'];\n    } & {\n      [DataName in keyof TInputs[InputName]['extensionData'] as TInputs[InputName]['extensionData'][DataName]['config'] extends {\n        optional: true;\n      }\n        ? DataName\n        : never]?: TInputs[InputName]['extensionData'][DataName]['T'];\n    }\n  >;\n};\n\n/** @public */\nexport type ExtensionDataBind<TMap extends AnyExtensionDataMap> = (\n  values: {\n    [DataName in keyof TMap as TMap[DataName]['config'] extends {\n      optional: true;\n    }\n      ? never\n      : DataName]: TMap[DataName]['T'];\n  } & {\n    [DataName in keyof TMap as TMap[DataName]['config'] extends {\n      optional: true;\n    }\n      ? DataName\n      : never]?: TMap[DataName]['T'];\n  },\n) => void;\n\n/** @public */\nexport interface CreateExtensionOptions<\n  TOutput extends AnyExtensionDataMap,\n  TInputs extends Record<string, { extensionData: AnyExtensionDataMap }>,\n  TConfig,\n> {\n  id: string;\n  at: string;\n  disabled?: boolean;\n  inputs?: TInputs;\n  output: TOutput;\n  configSchema?: PortableSchema<TConfig>;\n  factory(options: {\n    source?: BackstagePlugin;\n    bind: ExtensionDataBind<TOutput>;\n    config: TConfig;\n    inputs: ExtensionDataInputValues<TInputs>;\n  }): void;\n}\n\n/** @public */\nexport function createExtension<\n  TOutput extends AnyExtensionDataMap,\n  TInputs extends Record<string, { extensionData: AnyExtensionDataMap }>,\n  TConfig = never,\n>(\n  options: CreateExtensionOptions<TOutput, TInputs, TConfig>,\n): Extension<TConfig> {\n  return {\n    ...options,\n    disabled: options.disabled ?? false,\n    $$type: 'extension',\n    inputs: options.inputs ?? {},\n    factory({ bind, config, inputs }) {\n      // TODO: Simplify this, but TS wouldn't infer the input type for some reason\n      return options.factory({\n        bind,\n        config,\n        inputs: inputs as ExtensionDataInputValues<TInputs>,\n      });\n    },\n  };\n}\n","/*\n * Copyright 2023 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 { Extension } from './types';\n\n/** @public */\nexport interface PluginOptions {\n  id: string;\n  extensions?: Extension<unknown>[];\n}\n\n/** @public */\nexport interface BackstagePlugin {\n  $$type: 'backstage-plugin';\n  id: string;\n  extensions: Extension<unknown>[];\n}\n\n/** @public */\nexport function createPlugin(options: PluginOptions): BackstagePlugin {\n  return {\n    ...options,\n    $$type: 'backstage-plugin',\n    extensions: options.extensions ?? [],\n  };\n}\n","/*\n * Copyright 2023 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 { AnyApiFactory, AnyApiRef } from '@backstage/core-plugin-api';\nimport { PortableSchema } from '../schema';\nimport {\n  AnyExtensionDataMap,\n  ExtensionDataInputValues,\n  createExtension,\n  coreExtensionData,\n} from '../wiring';\n\n/** @public */\nexport function createApiExtension<\n  TConfig extends {},\n  TInputs extends Record<string, { extensionData: AnyExtensionDataMap }>,\n>(\n  options: (\n    | {\n        api: AnyApiRef;\n        factory: (options: {\n          config: TConfig;\n          inputs: ExtensionDataInputValues<TInputs>;\n        }) => AnyApiFactory;\n      }\n    | {\n        factory: AnyApiFactory;\n      }\n  ) & {\n    configSchema?: PortableSchema<TConfig>;\n    inputs?: TInputs;\n  },\n) {\n  const { factory, configSchema, inputs: extensionInputs } = options;\n\n  const apiRef =\n    'api' in options ? options.api : (factory as { api: AnyApiRef }).api;\n\n  return createExtension({\n    id: `apis.${apiRef.id}`,\n    at: 'core/apis',\n    inputs: extensionInputs,\n    configSchema,\n    output: {\n      api: coreExtensionData.apiFactory,\n    },\n    factory({ bind, config, inputs }) {\n      if (typeof factory === 'function') {\n        bind({ api: factory({ config, inputs }) });\n      } else {\n        bind({ api: factory });\n      }\n    },\n  });\n}\n","/*\n * Copyright 2023 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 { JsonObject } from '@backstage/types';\nimport { z, ZodSchema, ZodTypeDef } from 'zod';\nimport zodToJsonSchema from 'zod-to-json-schema';\nimport { PortableSchema } from './types';\n\n/** @public */\nexport function createSchemaFromZod<TOutput, TInput>(\n  schemaCreator: (zImpl: typeof z) => ZodSchema<TOutput, ZodTypeDef, TInput>,\n): PortableSchema<TOutput> {\n  const schema = schemaCreator(z);\n  return {\n    // TODO: Types allow z.array etc here but it will break stuff\n    parse: input => {\n      const result = schema.safeParse(input);\n      if (result.success) {\n        return result.data;\n      }\n\n      throw new Error(result.error.issues.map(formatIssue).join('; '));\n    },\n    // TODO: Verify why we are not compatible with the latest zodToJsonSchema.\n    schema: zodToJsonSchema(schema) as JsonObject,\n  };\n}\n\nfunction formatIssue(issue: z.ZodIssue): string {\n  if (issue.code === 'invalid_union') {\n    return formatIssue(issue.unionErrors[0].issues[0]);\n  }\n  let message = issue.message;\n  if (message === 'Required') {\n    message = `Missing required value`;\n  }\n  if (issue.path.length) {\n    message += ` at '${issue.path.join('.')}'`;\n  }\n  return message;\n}\n","/*\n * Copyright 2023 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 { RouteRef } from '@backstage/core-plugin-api';\nimport React from 'react';\nimport { ExtensionBoundary } from '../components';\nimport { createSchemaFromZod, PortableSchema } from '../schema';\nimport {\n  AnyExtensionDataMap,\n  coreExtensionData,\n  createExtension,\n  Extension,\n  ExtensionDataInputValues,\n} from '../wiring';\n\n/**\n * Helper for creating extensions for a routable React page component.\n *\n * @public\n */\nexport function createPageExtension<\n  TConfig extends { path: string },\n  TInputs extends Record<string, { extensionData: AnyExtensionDataMap }>,\n>(\n  options: (\n    | {\n        defaultPath: string;\n      }\n    | {\n        configSchema: PortableSchema<TConfig>;\n      }\n  ) & {\n    id: string;\n    at?: string;\n    disabled?: boolean;\n    inputs?: TInputs;\n    routeRef?: RouteRef;\n    component: (props: {\n      config: TConfig;\n      inputs: ExtensionDataInputValues<TInputs>;\n    }) => Promise<JSX.Element>;\n  },\n): Extension<TConfig> {\n  const configSchema =\n    'configSchema' in options\n      ? options.configSchema\n      : (createSchemaFromZod(z =>\n          z.object({ path: z.string().default(options.defaultPath) }),\n        ) as PortableSchema<TConfig>);\n\n  return createExtension({\n    id: options.id,\n    at: options.at ?? 'core.router/routes',\n    disabled: options.disabled,\n    output: {\n      component: coreExtensionData.reactComponent,\n      path: coreExtensionData.routePath,\n      routeRef: coreExtensionData.routeRef.optional(),\n    },\n    inputs: options.inputs,\n    configSchema,\n    factory({ bind, config, inputs, source }) {\n      const LazyComponent = React.lazy(() =>\n        options\n          .component({ config, inputs })\n          .then(element => ({ default: () => element })),\n      );\n\n      bind({\n        path: config.path,\n        component: () => (\n          <ExtensionBoundary source={source}>\n            <React.Suspense fallback=\"...\">\n              <LazyComponent />\n            </React.Suspense>\n          </ExtensionBoundary>\n        ),\n        routeRef: options.routeRef,\n      });\n    },\n  });\n}\n","/*\n * Copyright 2023 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 { RouteRef } from '@backstage/core-plugin-api';\n// eslint-disable-next-line @backstage/no-forbidden-package-imports\nimport { RoutingContext } from '@backstage/frontend-app-api/src/routing/RoutingContext';\nimport { useContext, useMemo } from 'react';\nimport { useLocation } from 'react-router-dom';\n\n/** @public */\nexport function useRouteRef(routeRef: RouteRef<any>): () => string {\n  const { pathname } = useLocation();\n  const resolver = useContext(RoutingContext);\n\n  const routeFunc = useMemo(\n    () => resolver && resolver.resolve(routeRef, { pathname }),\n    [resolver, routeRef, pathname],\n  );\n\n  if (!routeFunc) {\n    throw new Error(`Failed to resolve routeRef ${routeRef}`);\n  }\n\n  return routeFunc;\n}\n"],"names":[],"mappings":";;;;;;AA0BO,SAAS,kBAAkB,KAA+B,EAAA;AAC/D,EAAO,uBAAA,KAAA,CAAA,aAAA,CAAA,KAAA,CAAA,QAAA,EAAA,IAAA,EAAG,MAAM,QAAS,CAAA,CAAA;AAC3B;;ACSO,SAAS,uBACd,EACqC,EAAA;AACrC,EAAO,OAAA;AAAA,IACL,EAAA;AAAA,IACA,MAAQ,EAAA,gBAAA;AAAA,IACR,QAAQ,EAAC;AAAA,IACT,QAAW,GAAA;AACT,MAAO,OAAA,EAAE,GAAG,IAAA,EAAM,MAAQ,EAAA,EAAE,GAAG,IAAK,CAAA,MAAA,EAAQ,QAAU,EAAA,IAAA,EAAO,EAAA,CAAA;AAAA,KAC/D;AAAA,GACF,CAAA;AACF;;AC3BO,MAAM,iBAAoB,GAAA;AAAA,EAC/B,cAAA,EAAgB,uBAAsC,qBAAqB,CAAA;AAAA,EAC3E,SAAA,EAAW,uBAA+B,mBAAmB,CAAA;AAAA,EAC7D,UAAA,EAAY,uBAAsC,kBAAkB,CAAA;AAAA,EACpE,QAAA,EAAU,uBAAiC,kBAAkB,CAAA;AAC/D;;ACqDO,SAAS,gBAKd,OACoB,EAAA;AArFtB,EAAA,IAAA,EAAA,EAAA,EAAA,CAAA;AAsFE,EAAO,OAAA;AAAA,IACL,GAAG,OAAA;AAAA,IACH,QAAA,EAAA,CAAU,EAAQ,GAAA,OAAA,CAAA,QAAA,KAAR,IAAoB,GAAA,EAAA,GAAA,KAAA;AAAA,IAC9B,MAAQ,EAAA,WAAA;AAAA,IACR,MAAQ,EAAA,CAAA,EAAA,GAAA,OAAA,CAAQ,MAAR,KAAA,IAAA,GAAA,EAAA,GAAkB,EAAC;AAAA,IAC3B,OAAQ,CAAA,EAAE,IAAM,EAAA,MAAA,EAAQ,QAAU,EAAA;AAEhC,MAAA,OAAO,QAAQ,OAAQ,CAAA;AAAA,QACrB,IAAA;AAAA,QACA,MAAA;AAAA,QACA,MAAA;AAAA,OACD,CAAA,CAAA;AAAA,KACH;AAAA,GACF,CAAA;AACF;;ACpEO,SAAS,aAAa,OAAyC,EAAA;AAhCtE,EAAA,IAAA,EAAA,CAAA;AAiCE,EAAO,OAAA;AAAA,IACL,GAAG,OAAA;AAAA,IACH,MAAQ,EAAA,kBAAA;AAAA,IACR,UAAY,EAAA,CAAA,EAAA,GAAA,OAAA,CAAQ,UAAR,KAAA,IAAA,GAAA,EAAA,GAAsB,EAAC;AAAA,GACrC,CAAA;AACF;;ACZO,SAAS,mBAId,OAeA,EAAA;AACA,EAAA,MAAM,EAAE,OAAA,EAAS,YAAc,EAAA,MAAA,EAAQ,iBAAoB,GAAA,OAAA,CAAA;AAE3D,EAAA,MAAM,MACJ,GAAA,KAAA,IAAS,OAAU,GAAA,OAAA,CAAQ,MAAO,OAA+B,CAAA,GAAA,CAAA;AAEnE,EAAA,OAAO,eAAgB,CAAA;AAAA,IACrB,EAAA,EAAI,CAAQ,KAAA,EAAA,MAAA,CAAO,EAAE,CAAA,CAAA;AAAA,IACrB,EAAI,EAAA,WAAA;AAAA,IACJ,MAAQ,EAAA,eAAA;AAAA,IACR,YAAA;AAAA,IACA,MAAQ,EAAA;AAAA,MACN,KAAK,iBAAkB,CAAA,UAAA;AAAA,KACzB;AAAA,IACA,OAAQ,CAAA,EAAE,IAAM,EAAA,MAAA,EAAQ,QAAU,EAAA;AAChC,MAAI,IAAA,OAAO,YAAY,UAAY,EAAA;AACjC,QAAK,IAAA,CAAA,EAAE,KAAK,OAAQ,CAAA,EAAE,QAAQ,MAAO,EAAC,GAAG,CAAA,CAAA;AAAA,OACpC,MAAA;AACL,QAAK,IAAA,CAAA,EAAE,GAAK,EAAA,OAAA,EAAS,CAAA,CAAA;AAAA,OACvB;AAAA,KACF;AAAA,GACD,CAAA,CAAA;AACH;;AC7CO,SAAS,oBACd,aACyB,EAAA;AACzB,EAAM,MAAA,MAAA,GAAS,cAAc,CAAC,CAAA,CAAA;AAC9B,EAAO,OAAA;AAAA;AAAA,IAEL,OAAO,CAAS,KAAA,KAAA;AACd,MAAM,MAAA,MAAA,GAAS,MAAO,CAAA,SAAA,CAAU,KAAK,CAAA,CAAA;AACrC,MAAA,IAAI,OAAO,OAAS,EAAA;AAClB,QAAA,OAAO,MAAO,CAAA,IAAA,CAAA;AAAA,OAChB;AAEA,MAAM,MAAA,IAAI,KAAM,CAAA,MAAA,CAAO,KAAM,CAAA,MAAA,CAAO,IAAI,WAAW,CAAA,CAAE,IAAK,CAAA,IAAI,CAAC,CAAA,CAAA;AAAA,KACjE;AAAA;AAAA,IAEA,MAAA,EAAQ,gBAAgB,MAAM,CAAA;AAAA,GAChC,CAAA;AACF,CAAA;AAEA,SAAS,YAAY,KAA2B,EAAA;AAC9C,EAAI,IAAA,KAAA,CAAM,SAAS,eAAiB,EAAA;AAClC,IAAA,OAAO,YAAY,KAAM,CAAA,WAAA,CAAY,CAAC,CAAE,CAAA,MAAA,CAAO,CAAC,CAAC,CAAA,CAAA;AAAA,GACnD;AACA,EAAA,IAAI,UAAU,KAAM,CAAA,OAAA,CAAA;AACpB,EAAA,IAAI,YAAY,UAAY,EAAA;AAC1B,IAAU,OAAA,GAAA,CAAA,sBAAA,CAAA,CAAA;AAAA,GACZ;AACA,EAAI,IAAA,KAAA,CAAM,KAAK,MAAQ,EAAA;AACrB,IAAA,OAAA,IAAW,CAAQ,KAAA,EAAA,KAAA,CAAM,IAAK,CAAA,IAAA,CAAK,GAAG,CAAC,CAAA,CAAA,CAAA,CAAA;AAAA,GACzC;AACA,EAAO,OAAA,OAAA,CAAA;AACT;;ACpBO,SAAS,oBAId,OAkBoB,EAAA;AAvDtB,EAAA,IAAA,EAAA,CAAA;AAwDE,EAAA,MAAM,YACJ,GAAA,cAAA,IAAkB,OACd,GAAA,OAAA,CAAQ,YACP,GAAA,mBAAA;AAAA,IAAoB,CACnB,CAAA,KAAA,CAAA,CAAE,MAAO,CAAA,EAAE,IAAM,EAAA,CAAA,CAAE,MAAO,EAAA,CAAE,OAAQ,CAAA,OAAA,CAAQ,WAAW,CAAA,EAAG,CAAA;AAAA,GAC5D,CAAA;AAEN,EAAA,OAAO,eAAgB,CAAA;AAAA,IACrB,IAAI,OAAQ,CAAA,EAAA;AAAA,IACZ,EAAA,EAAA,CAAI,EAAQ,GAAA,OAAA,CAAA,EAAA,KAAR,IAAc,GAAA,EAAA,GAAA,oBAAA;AAAA,IAClB,UAAU,OAAQ,CAAA,QAAA;AAAA,IAClB,MAAQ,EAAA;AAAA,MACN,WAAW,iBAAkB,CAAA,cAAA;AAAA,MAC7B,MAAM,iBAAkB,CAAA,SAAA;AAAA,MACxB,QAAA,EAAU,iBAAkB,CAAA,QAAA,CAAS,QAAS,EAAA;AAAA,KAChD;AAAA,IACA,QAAQ,OAAQ,CAAA,MAAA;AAAA,IAChB,YAAA;AAAA,IACA,QAAQ,EAAE,IAAA,EAAM,MAAQ,EAAA,MAAA,EAAQ,QAAU,EAAA;AACxC,MAAA,MAAM,gBAAgB,KAAM,CAAA,IAAA;AAAA,QAAK,MAC/B,OAAA,CACG,SAAU,CAAA,EAAE,QAAQ,MAAO,EAAC,CAC5B,CAAA,IAAA,CAAK,CAAY,OAAA,MAAA,EAAE,OAAS,EAAA,MAAM,SAAU,CAAA,CAAA;AAAA,OACjD,CAAA;AAEA,MAAK,IAAA,CAAA;AAAA,QACH,MAAM,MAAO,CAAA,IAAA;AAAA,QACb,SAAW,EAAA,sBACR,KAAA,CAAA,aAAA,CAAA,iBAAA,EAAA,EAAkB,0BAChB,KAAA,CAAA,aAAA,CAAA,KAAA,CAAM,QAAN,EAAA,EAAe,QAAS,EAAA,KAAA,EAAA,kBACtB,KAAA,CAAA,aAAA,CAAA,aAAA,EAAA,IAAc,CACjB,CACF,CAAA;AAAA,QAEF,UAAU,OAAQ,CAAA,QAAA;AAAA,OACnB,CAAA,CAAA;AAAA,KACH;AAAA,GACD,CAAA,CAAA;AACH;;ACvEO,SAAS,YAAY,QAAuC,EAAA;AACjE,EAAM,MAAA,EAAE,QAAS,EAAA,GAAI,WAAY,EAAA,CAAA;AACjC,EAAM,MAAA,QAAA,GAAW,WAAW,cAAc,CAAA,CAAA;AAE1C,EAAA,MAAM,SAAY,GAAA,OAAA;AAAA,IAChB,MAAM,QAAY,IAAA,QAAA,CAAS,QAAQ,QAAU,EAAA,EAAE,UAAU,CAAA;AAAA,IACzD,CAAC,QAAU,EAAA,QAAA,EAAU,QAAQ,CAAA;AAAA,GAC/B,CAAA;AAEA,EAAA,IAAI,CAAC,SAAW,EAAA;AACd,IAAA,MAAM,IAAI,KAAA,CAAM,CAA8B,2BAAA,EAAA,QAAQ,CAAE,CAAA,CAAA,CAAA;AAAA,GAC1D;AAEA,EAAO,OAAA,SAAA,CAAA;AACT;;;;"}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@backstage/frontend-plugin-api",
+  "version": "0.0.0",
+  "main": "dist/index.esm.js",
+  "types": "dist/index.d.ts",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.esm.js",
+    "types": "dist/index.d.ts"
+  },
+  "backstage": {
+    "role": "web-library"
+  },
+  "sideEffects": false,
+  "scripts": {
+    "start": "backstage-cli package start",
+    "build": "backstage-cli package build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "clean": "backstage-cli package clean",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack"
+  },
+  "devDependencies": {
+    "@backstage/cli": "^0.22.13-next.2",
+    "@backstage/frontend-app-api": "^0.0.0",
+    "@testing-library/jest-dom": "^5.10.1",
+    "@testing-library/react": "^12.1.3"
+  },
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "react": "^16.13.1 || ^17.0.0",
+    "react-router-dom": "6.0.0-beta.0 || ^6.3.0"
+  },
+  "dependencies": {
+    "@backstage/core-plugin-api": "^1.6.0-next.2",
+    "@backstage/types": "^1.1.0",
+    "@types/react": "^16.13.1 || ^17.0.0",
+    "lodash": "^4.17.21",
+    "zod": "^3.21.4",
+    "zod-to-json-schema": "^3.21.4"
+  },
+  "module": "./dist/index.esm.js"
+}