chore(orchestrator): log which OrchestratorFormApi is used (#782)

* chore(orchestrator): log which OrchestratorFormApi is used

Signed-off-by: Marek Libra <marek.libra@gmail.com>

* export orchestratorFormApiFactory

Signed-off-by: Marek Libra <marek.libra@gmail.com>

* api reports

---------

Signed-off-by: Marek Libra <marek.libra@gmail.com>

Author: mareklibra

workspaces/orchestrator/plugins/orchestrator-form-react/src/DefaultFormApi.tsx

@@ -24,6 +24,11 @@ import {
 
 class DefaultFormApi implements OrchestratorFormApi {
   getFormDecorator(): OrchestratorFormDecorator {
+    // eslint-disable-next-line no-console
+    console.log(
+      'Using the Orchestrator DefaultFormApi (without additional extensions).',
+    );
+
     return (FormComponent: React.ComponentType<FormDecoratorProps>) =>
       FormComponent;
   }

workspaces/orchestrator/plugins/orchestrator-form-widgets/report.api.md

@@ -4,16 +4,19 @@
 
 ```ts
 
+import { ApiFactory } from '@backstage/core-plugin-api';
 import { BackstagePlugin } from '@backstage/core-plugin-api';
+import { OrchestratorFormApi } from '@red-hat-developer-hub/backstage-plugin-orchestrator-form-api';
 
-// Warning: (ae-missing-release-tag) "orchestratorFormWidgetsPlugin" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+// Warning: (ae-forgotten-export) The symbol "FormWidgetsApi" needs to be exported by the entry point index.d.ts
 //
-// @public (undocumented)
-export const orchestratorFormWidgetsPlugin: BackstagePlugin<    {}, {}, {}>;
+// @public
+export const orchestratorFormApiFactory: ApiFactory<OrchestratorFormApi, FormWidgetsApi, {
+[x: string]: unknown;
+}>;
 
-// Warnings were encountered during analysis:
-//
-// src/plugin.d.ts:5:22 - (ae-undocumented) Missing documentation for "orchestratorFormWidgetsPlugin".
+// @public
+export const orchestratorFormWidgetsPlugin: BackstagePlugin<    {}, {}, {}>;
 
 // (No @packageDocumentation comment for this package)
 

workspaces/orchestrator/plugins/orchestrator-form-widgets/src/FormWidgetsApi.tsx

@@ -42,6 +42,9 @@ const widgets = {
 
 export class FormWidgetsApi implements OrchestratorFormApi {
   getFormDecorator: OrchestratorFormApi['getFormDecorator'] = () => {
+    // eslint-disable-next-line no-console
+    console.log('Using FormWidgetsApi by RHDH orchestrator-form-widgets.');
+
     return (FormComponent: React.ComponentType<FormDecoratorProps>) => {
       return () => {
         const { formData, setFormData } = useWrapperFormPropsContext();

workspaces/orchestrator/plugins/orchestrator-form-widgets/src/index.ts

@@ -13,4 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export { orchestratorFormWidgetsPlugin } from './plugin';
+export {
+  orchestratorFormWidgetsPlugin,
+  orchestratorFormApiFactory,
+} from './plugin';

workspaces/orchestrator/plugins/orchestrator-form-widgets/src/plugin.ts

@@ -17,16 +17,24 @@ import { createApiFactory, createPlugin } from '@backstage/core-plugin-api';
 import { orchestratorFormApiRef } from '@red-hat-developer-hub/backstage-plugin-orchestrator-form-api';
 import { FormWidgetsApi } from './FormWidgetsApi';
 
-export const formApiFactory = createApiFactory({
+/**
+ * @public
+ * Form API factory for the orchestratorFormWidgetsPlugin.
+ */
+export const orchestratorFormApiFactory = createApiFactory({
   api: orchestratorFormApiRef,
   deps: {},
   factory() {
     return new FormWidgetsApi();
   },
 });
 
+/**
+ * @public
+ * Orchestrator Frontend Plugin providing decorator with default RJSF widgets for the Workflow Execution page.
+ */
 export const orchestratorFormWidgetsPlugin = createPlugin({
   id: 'orchestrator-form-widgets',
   routes: {},
-  apis: [formApiFactory],
+  apis: [orchestratorFormApiFactory],
 });