@red-hat-developer-hub/backstage-plugin-bulk-import-backend 6.10.1 → 6.11.1

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 ### Dependencies
 
+## 6.11.1
+
+### Patch Changes
+
+- 9c17c36: Updated dependency `prettier` to `3.8.0`.
+- Updated dependencies [9c17c36]
+  - @red-hat-developer-hub/backstage-plugin-bulk-import-common@6.11.1
+
+## 6.11.0
+
+### Minor Changes
+
+- 88ac11d: Implement the execution of import orchestrator workflows with the help of the bulk-import plugin.
+
+### Patch Changes
+
+- Updated dependencies [88ac11d]
+  - @red-hat-developer-hub/backstage-plugin-bulk-import-common@6.11.0
+
 ## 6.10.1
 
 ### Patch Changes

package/README.md

@@ -103,10 +103,11 @@ bulkImport:
   importAPI: 'scaffolder'
 ```
 
-importAPI: This field defines the import workflow. It currently supports two options:
+importAPI: This field defines the import workflow. It currently supports three options:
 
 - open-pull-requests: This is the default import workflow, which includes the logic for creating pull requests for every selected repository.
 - scaffolder: This workflow uses an import scenario defined in the scaffolder template. The import steps depend on the template's content, allowing for various scenarios. These can include importing existing catalog entities from a repository, creating pull requests, calling webhooks, and more. This method offers greater flexibility.
+- orchestrator: This workflow uses the Orchestrator plugin to execute workflows for bulk import operations. This mode provides advanced workflow orchestration capabilities and integrates with the Backstage Orchestrator plugin.
 
 > Important Note
 > The scaffolder template must be generic and not specific to a single repository to be successfully executed for every repository in the bulk list.
@@ -176,6 +177,119 @@ parameters:
         title: Git provider host
 ```
 
+#### Orchestrator Workflow Execution
+
+The Bulk Import plugin supports using the Orchestrator plugin to execute workflows for bulk import operations. This mode leverages the Orchestrator's workflow engine to provide advanced orchestration capabilities for importing repositories.
+
+##### Plugin Configuration
+
+To use the orchestrator mode, configure the Bulk Import plugin as follows:
+
+```yaml
+bulkImport:
+  orchestratorWorkflow: your-workflow-id
+  importAPI: 'orchestrator'
+```
+
+**Configuration Parameters:**
+
+- **`orchestratorWorkflow`** (required): The ID of the orchestrator workflow to execute for each repository. This workflow must be registered in the Orchestrator plugin.
+- **`importAPI`**: Set to `'orchestrator'` to enable orchestrator workflow execution mode.
+
+> **Important Notes:**
+>
+> - The Orchestrator plugin must be installed and configured in your Backstage instance.
+> - The specified workflow must be available in the Orchestrator plugin.
+> - The workflow must be generic and able to handle different repositories, as it will be executed for each repository in the bulk import list.
+
+##### Orchestrator Workflow Input Parameters
+
+When executing an orchestrator workflow, the Bulk Import plugin provides the following input data to the workflow:
+
+- **`owner`** – Repository owner (organization or user name).
+  **Example:** For `https://github.com/redhat-developer/rhdh-plugins`, `owner` will be `redhat-developer`.
+
+- **`repo`** – Repository name.
+  **Example:** For `https://github.com/redhat-developer/rhdh-plugins`, `repo` will be `rhdh-plugins`.
+
+- **`baseBranch`** – Default branch of the Git repository (e.g., `main`, `master`).
+
+- **`targetBranch`** – Target branch for the import operation. By default, this is set to `bulk-import-orchestrator`.
+
+Additionally, the plugin automatically provides authentication tokens for the Git provider:
+
+- **`authTokens`** – Array of authentication tokens for the Git provider:
+  - For GitHub repositories (`approvalTool: 'GIT'`): `{ token: <github-token>, provider: 'github' }`
+  - For GitLab repositories (`approvalTool: 'GITLAB'`): `{ token: <gitlab-token>, provider: 'gitlab' }`
+
+The tokens are obtained from the configured GitHub/GitLab integrations in your Backstage instance.
+
+##### How Orchestrator Mode Works
+
+1. **Workflow Execution**: When you submit a bulk import request with `importAPI: 'orchestrator'`, the plugin:
+   - Iterates through each repository in the request
+   - Retrieves the appropriate Git provider credentials (GitHub or GitLab)
+   - Executes the specified orchestrator workflow for each repository
+   - Passes the repository information and authentication tokens as input data
+
+2. **Workflow Tracking**: The plugin:
+   - Stores workflow instance IDs in the database
+   - Associates each workflow instance with its repository
+   - Tracks workflow execution status by querying the Orchestrator API
+
+3. **Status Monitoring**: You can check the status of orchestrator workflows:
+   - The workflow status is mapped from Orchestrator states to Bulk Import statuses (e.g., `WORKFLOW_ACTIVE`, `WORKFLOW_COMPLETED`, `WORKFLOW_ERROR`)
+   - Status information includes the workflow instance ID, which can be used to view detailed workflow execution in the Orchestrator UI
+
+##### API Endpoints for Orchestrator Mode
+
+When using `importAPI: 'orchestrator'`, the following API endpoints are used:
+
+- **`POST /api/bulk-import/orchestrator-workflows`** – Create orchestrator workflow import jobs
+- **`GET /api/bulk-import/orchestrator-workflows`** – List all orchestrator workflow import jobs
+- **`GET /api/bulk-import/orchestrator-import/by-repo`** – Get orchestrator workflow import status for a specific repository
+- **`DELETE /api/bulk-import/orchestrator-import/by-repo`** – Delete orchestrator workflow records for a specific repository
+
+##### Example Orchestrator Workflow
+
+Your orchestrator workflow should accept the input parameters described above. Here's an example of how the workflow input data structure looks:
+
+```json
+{
+  "inputData": {
+    "owner": "redhat-developer",
+    "repo": "rhdh-plugins",
+    "baseBranch": "main",
+    "targetBranch": "bulk-import-orchestrator"
+  },
+  "authTokens": [
+    {
+      "token": "<github-token>",
+      "provider": "github"
+    }
+  ]
+}
+```
+
+The workflow can then use these parameters to perform operations such as:
+
+- Creating catalog entities
+- Generating pull requests
+- Calling external APIs
+- Performing custom import logic
+
+##### Workflow Status Mapping
+
+The plugin maps Orchestrator workflow states to Bulk Import status values:
+
+- Orchestrator `ACTIVE` → `WORKFLOW_ACTIVE`
+- Orchestrator `COMPLETED` → `WORKFLOW_COMPLETED`
+- Orchestrator `ERROR` → `WORKFLOW_ERROR`
+- Orchestrator `ABORTED` → `WORKFLOW_ABORTED`
+- Other states are prefixed with `WORKFLOW_` and uppercased
+
+If workflow status cannot be retrieved, the status is set to `WORKFLOW_FETCH_FAILED`.
+
 ### Audit Logging
 
 Audit logging is backed by the [`@backstage/backend-plugin-api`](https://www.npmjs.com/package/@backstage/backend-plugin-api) package.

package/config.d.ts

@@ -17,9 +17,14 @@
 export interface Config {
   bulkImport?: {
     /**
-     * The name of the scaffolder template to execute for importing a repository.
+     * The name of the scaffolder template or entity reference to execute for importing a repository.
      * @visibility backend
      */
     importTemplate?: string;
+    /**
+     * The orchestrator workflow id to execute for importing a repository.
+     * @visibility backend
+     */
+    orchestratorWorkflow?: string;
   };
 }

package/dist/database/repositoryDao.cjs.js

@@ -25,41 +25,42 @@ async function paginateQuery(queryBuilder, page = 1, size = 10, search) {
   };
 }
 class RepositoryDao {
-  constructor(knex, logger) {
+  constructor(knex, logger, tableName) {
     this.knex = knex;
     this.logger = logger;
+    this.tableName = tableName;
   }
   async findRepositories(page = 1, size = 10, search) {
     this.logger.debug(
       `Fetching repositories page=${page}, size=${size}, search=${search}`
     );
-    const query = this.knex("repositories").select("id", "url", "approvalTool");
+    const query = this.knex(this.tableName).select("id", "url", "approvalTool");
     const searchParam = { column: "url", term: search };
     return paginateQuery(query, page, size, searchParam);
   }
-  async insertRepository(repoUrl, taskId, approvalTool) {
+  async insertRepository(repoUrl, taskOrWorkflowId, approvalTool) {
     this.logger.debug(
-      `Saving task ${taskId} for repo ${repoUrl} to database..`
+      `Saving repository ${repoUrl} for task/workflow ${taskOrWorkflowId} to database..`
     );
-    const repository = await this.knex("repositories").where({ url: repoUrl }).first();
+    const repository = await this.knex(this.tableName).where({ url: repoUrl }).first();
     let repositoryId;
     if (repository) {
       repositoryId = repository.id;
     } else {
-      const [newRepository] = await this.knex("repositories").insert({ url: repoUrl, approvalTool }).returning("id");
+      const [newRepository] = await this.knex(this.tableName).insert({ url: repoUrl, approvalTool }).returning("id");
       repositoryId = newRepository.id;
     }
     return repositoryId;
   }
   async findRepositoryByUrl(url) {
     this.logger.debug(`Fetching repository from database by url ${url}...`);
-    return await this.knex("repositories").where({ url }).first();
+    return await this.knex(this.tableName).where({ url }).first();
   }
   async deleteRepository(url) {
     this.logger.debug(`Deleting repository from database by url ${url}...`);
-    const repository = await this.knex("repositories").where({ url }).first();
+    const repository = await this.knex(this.tableName).where({ url }).first();
     if (repository) {
-      await this.knex("repositories").where({ id: repository.id }).del();
+      await this.knex(this.tableName).where({ id: repository.id }).del();
     }
   }
 }
@@ -109,7 +110,37 @@ class TaskLocationsDao {
     );
   }
 }
+class OrchestratorWorkflowDao {
+  constructor(knex) {
+    this.knex = knex;
+  }
+  async insertWorkflow(instanceId, repositoryId) {
+    const [newWorkflow] = await this.knex("orchestrator_workflows").insert({
+      instance_id: instanceId,
+      repositoryId
+    }).returning("id");
+    return newWorkflow.id;
+  }
+  async lastExecutedWorkflowByRepoId(repositoryId) {
+    const result = await this.knex("orchestrator_workflows").select({
+      id: "id",
+      instanceId: "instance_id",
+      repositoryId: "repositoryId",
+      createdAt: "created_at"
+    }).where({ repositoryId }).orderBy("created_at", "desc").first();
+    return result;
+  }
+  async findWorkflowsByRepositoryId(repositoryId) {
+    return await this.knex("orchestrator_workflows").where({ repositoryId }).select({
+      id: "id",
+      instanceId: "instance_id",
+      repositoryId: "repositoryId",
+      createdAt: "created_at"
+    });
+  }
+}
 
+exports.OrchestratorWorkflowDao = OrchestratorWorkflowDao;
 exports.RepositoryDao = RepositoryDao;
 exports.ScaffolderTaskDao = ScaffolderTaskDao;
 exports.TaskLocationsDao = TaskLocationsDao;

package/dist/database/repositoryDao.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"repositoryDao.cjs.js","sources":["../../src/database/repositoryDao.ts"],"sourcesContent":["/*\n * Copyright Red Hat, Inc.\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 type { LoggerService } from '@backstage/backend-plugin-api';\n\nimport { Knex } from 'knex';\n\nimport { Components } from '../generated/openapi';\n\nexport interface Repository {\n  id: number;\n  url: string;\n  approvalTool: Components.Schemas.ApprovalTool;\n}\n\nexport interface ScaffolderTask {\n  taskId: string;\n  scaffolderOptions: any;\n  repositoryId: number;\n  executedAt?: Date;\n}\n\nexport interface PaginatedResult<T> {\n  data: T[];\n  page: number;\n  size: number;\n  total: number;\n  totalPages: number;\n}\n\nexport async function paginateQuery<T>(\n  queryBuilder: Knex.QueryBuilder<any, T[]>,\n  page: number = 1,\n  size: number = 10,\n  search?: { column: string; term?: string },\n): Promise<PaginatedResult<T>> {\n  const offset = (page - 1) * size;\n\n  let baseQuery = queryBuilder.clone();\n\n  if (search?.term) {\n    if (queryBuilder.client.dialect === 'postgres') {\n      baseQuery = baseQuery.whereILike(search.column, `%${search.term}%`);\n    } else {\n      baseQuery = baseQuery.whereLike(search.column, `%${search.term}%`);\n    }\n  }\n\n  const countQuery = baseQuery\n    .clone()\n    .clearSelect()\n    .clearOrder()\n    .count<{ count: string }[]>('* as count');\n\n  const [rows, [{ count }]] = await Promise.all([\n    baseQuery.clone().limit(size).offset(offset),\n    countQuery,\n  ]);\n\n  const total = Number(count);\n\n  return {\n    data: rows as T[],\n    page,\n    size,\n    total,\n    totalPages: Math.ceil(total / size),\n  };\n}\n\n// @internal\nexport class RepositoryDao {\n  constructor(\n    private readonly knex: Knex<any, any[]>,\n    private readonly logger: LoggerService,\n  ) {}\n\n  async findRepositories(\n    page: number = 1,\n    size: number = 10,\n    search?: string,\n  ): Promise<PaginatedResult<Repository>> {\n    this.logger.debug(\n      `Fetching repositories page=${page}, size=${size}, search=${search}`,\n    );\n    const query = this.knex('repositories').select('id', 'url', 'approvalTool');\n    const searchParam = { column: 'url', term: search };\n    return paginateQuery<Repository>(query, page, size, searchParam);\n  }\n\n  async insertRepository(\n    repoUrl: string,\n    taskId: string,\n    approvalTool: string,\n  ): Promise<number> {\n    this.logger.debug(\n      `Saving task ${taskId} for repo ${repoUrl} to database..`,\n    );\n    const repository = await this.knex('repositories')\n      .where({ url: repoUrl })\n      .first();\n\n    let repositoryId;\n    if (repository) {\n      repositoryId = repository.id;\n    } else {\n      const [newRepository] = await this.knex('repositories')\n        .insert({ url: repoUrl, approvalTool: approvalTool })\n        .returning('id');\n      repositoryId = newRepository.id;\n    }\n    return repositoryId;\n  }\n\n  async findRepositoryByUrl(url: string): Promise<Repository | undefined> {\n    this.logger.debug(`Fetching repository from database by url ${url}...`);\n    return await this.knex('repositories').where({ url: url }).first();\n  }\n\n  async deleteRepository(url: string): Promise<void> {\n    this.logger.debug(`Deleting repository from database by url ${url}...`);\n    const repository = await this.knex('repositories')\n      .where({ url: url })\n      .first();\n\n    if (repository) {\n      await this.knex('repositories').where({ id: repository.id }).del();\n    }\n  }\n}\n\n// @internal\nexport class ScaffolderTaskDao {\n  constructor(private readonly knex: Knex<any, any[]>) {}\n\n  async findAllTasks(): Promise<ScaffolderTask[]> {\n    return await this.knex('scaffolder_tasks').select<ScaffolderTask[]>(\n      'taskId',\n      'repositoryId',\n      'scaffolderOptions',\n    );\n  }\n\n  async insertTask(task: ScaffolderTask): Promise<string> {\n    const result = await this.knex('scaffolder_tasks')\n      .insert<ScaffolderTask>({\n        taskId: task.taskId,\n        repositoryId: task.repositoryId,\n        scaffolderOptions: JSON.stringify(task.scaffolderOptions),\n        executedAt: task.executedAt,\n      })\n      .returning<{ taskId: string }[]>('taskId');\n\n    return result[0].taskId;\n  }\n\n  async findTasksByRepositoryId(\n    repositoryId: number,\n  ): Promise<ScaffolderTask[]> {\n    return await this.knex('scaffolder_tasks')\n      .where({ repositoryId })\n      .select<\n        ScaffolderTask[]\n      >('taskId', 'repositoryId', 'scaffolderOptions', 'executedAt');\n  }\n\n  async lastExecutedTaskByRepoId(\n    repositoryId: number,\n  ): Promise<ScaffolderTask | undefined> {\n    return await this.knex('scaffolder_tasks')\n      .where({ repositoryId })\n      .orderBy('executedAt', 'desc')\n      .first<ScaffolderTask>();\n  }\n}\n\nexport interface TaskLocation {\n  id: number;\n  taskId: string;\n  location: string;\n  type: string;\n}\n\n// @internal\nexport class TaskLocationsDao {\n  constructor(private readonly knex: Knex<any, any[]>) {}\n\n  async addTaskLocation(\n    taskId: string,\n    location: string,\n    type: string = 'component',\n  ): Promise<void> {\n    await this.knex('task_locations').insert({ taskId, location, type });\n  }\n\n  async findLocationsByTaskId(taskId: string): Promise<TaskLocation[]> {\n    return await this.knex('task_locations')\n      .where({ taskId })\n      .select<TaskLocation[]>('id', 'taskId', 'location', 'type');\n  }\n\n  async findAllLocations(): Promise<TaskLocation[]> {\n    return await this.knex('task_locations').select<TaskLocation[]>(\n      'id',\n      'taskId',\n      'location',\n      'type',\n    );\n  }\n}\n"],"names":[],"mappings":";;AA2CA,eAAsB,cACpB,YACA,EAAA,IAAA,GAAe,CACf,EAAA,IAAA,GAAe,IACf,MAC6B,EAAA;AAC7B,EAAM,MAAA,MAAA,GAAA,CAAU,OAAO,CAAK,IAAA,IAAA;AAE5B,EAAI,IAAA,SAAA,GAAY,aAAa,KAAM,EAAA;AAEnC,EAAA,IAAI,QAAQ,IAAM,EAAA;AAChB,IAAI,IAAA,YAAA,CAAa,MAAO,CAAA,OAAA,KAAY,UAAY,EAAA;AAC9C,MAAA,SAAA,GAAY,UAAU,UAAW,CAAA,MAAA,CAAO,QAAQ,CAAI,CAAA,EAAA,MAAA,CAAO,IAAI,CAAG,CAAA,CAAA,CAAA;AAAA,KAC7D,MAAA;AACL,MAAA,SAAA,GAAY,UAAU,SAAU,CAAA,MAAA,CAAO,QAAQ,CAAI,CAAA,EAAA,MAAA,CAAO,IAAI,CAAG,CAAA,CAAA,CAAA;AAAA;AACnE;AAGF,EAAM,MAAA,UAAA,GAAa,UAChB,KAAM,EAAA,CACN,aACA,CAAA,UAAA,EACA,CAAA,KAAA,CAA2B,YAAY,CAAA;AAE1C,EAAM,MAAA,CAAC,IAAM,EAAA,CAAC,EAAE,KAAA,EAAO,CAAC,CAAA,GAAI,MAAM,OAAA,CAAQ,GAAI,CAAA;AAAA,IAC5C,UAAU,KAAM,EAAA,CAAE,MAAM,IAAI,CAAA,CAAE,OAAO,MAAM,CAAA;AAAA,IAC3C;AAAA,GACD,CAAA;AAED,EAAM,MAAA,KAAA,GAAQ,OAAO,KAAK,CAAA;AAE1B,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,IAAA;AAAA,IACN,IAAA;AAAA,IACA,IAAA;AAAA,IACA,KAAA;AAAA,IACA,UAAY,EAAA,IAAA,CAAK,IAAK,CAAA,KAAA,GAAQ,IAAI;AAAA,GACpC;AACF;AAGO,MAAM,aAAc,CAAA;AAAA,EACzB,WAAA,CACmB,MACA,MACjB,EAAA;AAFiB,IAAA,IAAA,CAAA,IAAA,GAAA,IAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AAAA;AAChB,EAEH,MAAM,gBACJ,CAAA,IAAA,GAAe,CACf,EAAA,IAAA,GAAe,IACf,MACsC,EAAA;AACtC,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,MACV,CAA8B,2BAAA,EAAA,IAAI,CAAU,OAAA,EAAA,IAAI,YAAY,MAAM,CAAA;AAAA,KACpE;AACA,IAAM,MAAA,KAAA,GAAQ,KAAK,IAAK,CAAA,cAAc,EAAE,MAAO,CAAA,IAAA,EAAM,OAAO,cAAc,CAAA;AAC1E,IAAA,MAAM,WAAc,GAAA,EAAE,MAAQ,EAAA,KAAA,EAAO,MAAM,MAAO,EAAA;AAClD,IAAA,OAAO,aAA0B,CAAA,KAAA,EAAO,IAAM,EAAA,IAAA,EAAM,WAAW,CAAA;AAAA;AACjE,EAEA,MAAM,gBAAA,CACJ,OACA,EAAA,MAAA,EACA,YACiB,EAAA;AACjB,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,MACV,CAAA,YAAA,EAAe,MAAM,CAAA,UAAA,EAAa,OAAO,CAAA,cAAA;AAAA,KAC3C;AACA,IAAA,MAAM,UAAa,GAAA,MAAM,IAAK,CAAA,IAAA,CAAK,cAAc,CAAA,CAC9C,KAAM,CAAA,EAAE,GAAK,EAAA,OAAA,EAAS,CAAA,CACtB,KAAM,EAAA;AAET,IAAI,IAAA,YAAA;AACJ,IAAA,IAAI,UAAY,EAAA;AACd,MAAA,YAAA,GAAe,UAAW,CAAA,EAAA;AAAA,KACrB,MAAA;AACL,MAAA,MAAM,CAAC,aAAa,CAAA,GAAI,MAAM,IAAA,CAAK,KAAK,cAAc,CAAA,CACnD,MAAO,CAAA,EAAE,KAAK,OAAS,EAAA,YAAA,EAA4B,CAAA,CACnD,UAAU,IAAI,CAAA;AACjB,MAAA,YAAA,GAAe,aAAc,CAAA,EAAA;AAAA;AAE/B,IAAO,OAAA,YAAA;AAAA;AACT,EAEA,MAAM,oBAAoB,GAA8C,EAAA;AACtE,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA,CAAM,CAA4C,yCAAA,EAAA,GAAG,CAAK,GAAA,CAAA,CAAA;AACtE,IAAO,OAAA,MAAM,IAAK,CAAA,IAAA,CAAK,cAAc,CAAA,CAAE,MAAM,EAAE,GAAA,EAAU,CAAA,CAAE,KAAM,EAAA;AAAA;AACnE,EAEA,MAAM,iBAAiB,GAA4B,EAAA;AACjD,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA,CAAM,CAA4C,yCAAA,EAAA,GAAG,CAAK,GAAA,CAAA,CAAA;AACtE,IAAM,MAAA,UAAA,GAAa,MAAM,IAAA,CAAK,IAAK,CAAA,cAAc,CAC9C,CAAA,KAAA,CAAM,EAAE,GAAA,EAAU,CAAA,CAClB,KAAM,EAAA;AAET,IAAA,IAAI,UAAY,EAAA;AACd,MAAM,MAAA,IAAA,CAAK,IAAK,CAAA,cAAc,CAAE,CAAA,KAAA,CAAM,EAAE,EAAA,EAAI,UAAW,CAAA,EAAA,EAAI,CAAA,CAAE,GAAI,EAAA;AAAA;AACnE;AAEJ;AAGO,MAAM,iBAAkB,CAAA;AAAA,EAC7B,YAA6B,IAAwB,EAAA;AAAxB,IAAA,IAAA,CAAA,IAAA,GAAA,IAAA;AAAA;AAAyB,EAEtD,MAAM,YAA0C,GAAA;AAC9C,IAAA,OAAO,MAAM,IAAA,CAAK,IAAK,CAAA,kBAAkB,CAAE,CAAA,MAAA;AAAA,MACzC,QAAA;AAAA,MACA,cAAA;AAAA,MACA;AAAA,KACF;AAAA;AACF,EAEA,MAAM,WAAW,IAAuC,EAAA;AACtD,IAAA,MAAM,SAAS,MAAM,IAAA,CAAK,IAAK,CAAA,kBAAkB,EAC9C,MAAuB,CAAA;AAAA,MACtB,QAAQ,IAAK,CAAA,MAAA;AAAA,MACb,cAAc,IAAK,CAAA,YAAA;AAAA,MACnB,iBAAmB,EAAA,IAAA,CAAK,SAAU,CAAA,IAAA,CAAK,iBAAiB,CAAA;AAAA,MACxD,YAAY,IAAK,CAAA;AAAA,KAClB,CACA,CAAA,SAAA,CAAgC,QAAQ,CAAA;AAE3C,IAAO,OAAA,MAAA,CAAO,CAAC,CAAE,CAAA,MAAA;AAAA;AACnB,EAEA,MAAM,wBACJ,YAC2B,EAAA;AAC3B,IAAA,OAAO,MAAM,IAAA,CAAK,IAAK,CAAA,kBAAkB,EACtC,KAAM,CAAA,EAAE,YAAa,EAAC,CACtB,CAAA,MAAA,CAEC,QAAU,EAAA,cAAA,EAAgB,qBAAqB,YAAY,CAAA;AAAA;AACjE,EAEA,MAAM,yBACJ,YACqC,EAAA;AACrC,IAAA,OAAO,MAAM,IAAA,CAAK,IAAK,CAAA,kBAAkB,EACtC,KAAM,CAAA,EAAE,YAAa,EAAC,CACtB,CAAA,OAAA,CAAQ,YAAc,EAAA,MAAM,EAC5B,KAAsB,EAAA;AAAA;AAE7B;AAUO,MAAM,gBAAiB,CAAA;AAAA,EAC5B,YAA6B,IAAwB,EAAA;AAAxB,IAAA,IAAA,CAAA,IAAA,GAAA,IAAA;AAAA;AAAyB,EAEtD,MAAM,eAAA,CACJ,MACA,EAAA,QAAA,EACA,OAAe,WACA,EAAA;AACf,IAAM,MAAA,IAAA,CAAK,KAAK,gBAAgB,CAAA,CAAE,OAAO,EAAE,MAAA,EAAQ,QAAU,EAAA,IAAA,EAAM,CAAA;AAAA;AACrE,EAEA,MAAM,sBAAsB,MAAyC,EAAA;AACnE,IAAA,OAAO,MAAM,IAAA,CAAK,IAAK,CAAA,gBAAgB,EACpC,KAAM,CAAA,EAAE,MAAO,EAAC,CAChB,CAAA,MAAA,CAAuB,IAAM,EAAA,QAAA,EAAU,YAAY,MAAM,CAAA;AAAA;AAC9D,EAEA,MAAM,gBAA4C,GAAA;AAChD,IAAA,OAAO,MAAM,IAAA,CAAK,IAAK,CAAA,gBAAgB,CAAE,CAAA,MAAA;AAAA,MACvC,IAAA;AAAA,MACA,QAAA;AAAA,MACA,UAAA;AAAA,MACA;AAAA,KACF;AAAA;AAEJ;;;;;;;"}
+{"version":3,"file":"repositoryDao.cjs.js","sources":["../../src/database/repositoryDao.ts"],"sourcesContent":["/*\n * Copyright Red Hat, Inc.\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 type { LoggerService } from '@backstage/backend-plugin-api';\n\nimport { Knex } from 'knex';\n\nimport { Components } from '../generated/openapi';\n\nexport interface Repository {\n  id: number;\n  url: string;\n  approvalTool: Components.Schemas.ApprovalTool;\n}\n\nexport interface ScaffolderTask {\n  taskId: string;\n  scaffolderOptions: any;\n  repositoryId: number;\n  executedAt?: Date;\n}\n\nexport interface PaginatedResult<T> {\n  data: T[];\n  page: number;\n  size: number;\n  total: number;\n  totalPages: number;\n}\n\nexport async function paginateQuery<T>(\n  queryBuilder: Knex.QueryBuilder<any, T[]>,\n  page: number = 1,\n  size: number = 10,\n  search?: { column: string; term?: string },\n): Promise<PaginatedResult<T>> {\n  const offset = (page - 1) * size;\n\n  let baseQuery = queryBuilder.clone();\n\n  if (search?.term) {\n    if (queryBuilder.client.dialect === 'postgres') {\n      baseQuery = baseQuery.whereILike(search.column, `%${search.term}%`);\n    } else {\n      baseQuery = baseQuery.whereLike(search.column, `%${search.term}%`);\n    }\n  }\n\n  const countQuery = baseQuery\n    .clone()\n    .clearSelect()\n    .clearOrder()\n    .count<{ count: string }[]>('* as count');\n\n  const [rows, [{ count }]] = await Promise.all([\n    baseQuery.clone().limit(size).offset(offset),\n    countQuery,\n  ]);\n\n  const total = Number(count);\n\n  return {\n    data: rows as T[],\n    page,\n    size,\n    total,\n    totalPages: Math.ceil(total / size),\n  };\n}\n\nexport type RepositoryName = 'repositories' | 'orchestrator_repositories';\n\n// @internal\nexport class RepositoryDao<R extends RepositoryName> {\n  constructor(\n    private readonly knex: Knex<any, any[]>,\n    private readonly logger: LoggerService,\n    private readonly tableName: R,\n  ) {}\n\n  async findRepositories(\n    page: number = 1,\n    size: number = 10,\n    search?: string,\n  ): Promise<PaginatedResult<Repository>> {\n    this.logger.debug(\n      `Fetching repositories page=${page}, size=${size}, search=${search}`,\n    );\n    const query = this.knex(this.tableName).select('id', 'url', 'approvalTool');\n    const searchParam = { column: 'url', term: search };\n    return paginateQuery<Repository>(query, page, size, searchParam);\n  }\n\n  async insertRepository(\n    repoUrl: string,\n    taskOrWorkflowId: string,\n    approvalTool: string,\n  ): Promise<number> {\n    this.logger.debug(\n      `Saving repository ${repoUrl} for task/workflow ${taskOrWorkflowId} to database..`,\n    );\n    const repository = await this.knex(this.tableName)\n      .where({ url: repoUrl })\n      .first();\n\n    let repositoryId;\n    if (repository) {\n      repositoryId = repository.id;\n    } else {\n      const [newRepository] = await this.knex(this.tableName)\n        .insert({ url: repoUrl, approvalTool: approvalTool })\n        .returning('id');\n      repositoryId = newRepository.id;\n    }\n    return repositoryId;\n  }\n\n  async findRepositoryByUrl(url: string): Promise<Repository | undefined> {\n    this.logger.debug(`Fetching repository from database by url ${url}...`);\n    return await this.knex(this.tableName).where({ url: url }).first();\n  }\n\n  async deleteRepository(url: string): Promise<void> {\n    this.logger.debug(`Deleting repository from database by url ${url}...`);\n    const repository = await this.knex(this.tableName)\n      .where({ url: url })\n      .first();\n\n    if (repository) {\n      await this.knex(this.tableName).where({ id: repository.id }).del();\n    }\n  }\n}\n\n// @internal\nexport class ScaffolderTaskDao {\n  constructor(private readonly knex: Knex<any, any[]>) {}\n\n  async findAllTasks(): Promise<ScaffolderTask[]> {\n    return await this.knex('scaffolder_tasks').select<ScaffolderTask[]>(\n      'taskId',\n      'repositoryId',\n      'scaffolderOptions',\n    );\n  }\n\n  async insertTask(task: ScaffolderTask): Promise<string> {\n    const result = await this.knex('scaffolder_tasks')\n      .insert<ScaffolderTask>({\n        taskId: task.taskId,\n        repositoryId: task.repositoryId,\n        scaffolderOptions: JSON.stringify(task.scaffolderOptions),\n        executedAt: task.executedAt,\n      })\n      .returning<{ taskId: string }[]>('taskId');\n\n    return result[0].taskId;\n  }\n\n  async findTasksByRepositoryId(\n    repositoryId: number,\n  ): Promise<ScaffolderTask[]> {\n    return await this.knex('scaffolder_tasks')\n      .where({ repositoryId })\n      .select<\n        ScaffolderTask[]\n      >('taskId', 'repositoryId', 'scaffolderOptions', 'executedAt');\n  }\n\n  async lastExecutedTaskByRepoId(\n    repositoryId: number,\n  ): Promise<ScaffolderTask | undefined> {\n    return await this.knex('scaffolder_tasks')\n      .where({ repositoryId })\n      .orderBy('executedAt', 'desc')\n      .first<ScaffolderTask>();\n  }\n}\n\nexport interface TaskLocation {\n  id: number;\n  taskId: string;\n  location: string;\n  type: string;\n}\n\n// @internal\nexport class TaskLocationsDao {\n  constructor(private readonly knex: Knex<any, any[]>) {}\n\n  async addTaskLocation(\n    taskId: string,\n    location: string,\n    type: string = 'component',\n  ): Promise<void> {\n    await this.knex('task_locations').insert({ taskId, location, type });\n  }\n\n  async findLocationsByTaskId(taskId: string): Promise<TaskLocation[]> {\n    return await this.knex('task_locations')\n      .where({ taskId })\n      .select<TaskLocation[]>('id', 'taskId', 'location', 'type');\n  }\n\n  async findAllLocations(): Promise<TaskLocation[]> {\n    return await this.knex('task_locations').select<TaskLocation[]>(\n      'id',\n      'taskId',\n      'location',\n      'type',\n    );\n  }\n}\n\nexport interface OrchestratorWorkflow {\n  id: number;\n  instanceId: string;\n  repositoryId: number;\n  createdAt: Date;\n  status?: string;\n}\n\n// @internal\nexport class OrchestratorWorkflowDao {\n  constructor(private readonly knex: Knex<any, any[]>) {}\n\n  async insertWorkflow(\n    instanceId: string,\n    repositoryId: number,\n  ): Promise<number> {\n    const [newWorkflow] = await this.knex('orchestrator_workflows')\n      .insert({\n        instance_id: instanceId,\n        repositoryId: repositoryId,\n      })\n      .returning('id');\n    return newWorkflow.id;\n  }\n\n  async lastExecutedWorkflowByRepoId(\n    repositoryId: number,\n  ): Promise<OrchestratorWorkflow | undefined> {\n    const result = await this.knex('orchestrator_workflows')\n      .select({\n        id: 'id',\n        instanceId: 'instance_id',\n        repositoryId: 'repositoryId',\n        createdAt: 'created_at',\n      })\n      .where({ repositoryId: repositoryId })\n      .orderBy('created_at', 'desc')\n      .first();\n    return result;\n  }\n\n  async findWorkflowsByRepositoryId(\n    repositoryId: number,\n  ): Promise<OrchestratorWorkflow[]> {\n    return await this.knex('orchestrator_workflows')\n      .where({ repositoryId: repositoryId })\n      .select({\n        id: 'id',\n        instanceId: 'instance_id',\n        repositoryId: 'repositoryId',\n        createdAt: 'created_at',\n      });\n  }\n}\n"],"names":[],"mappings":";;AA2CA,eAAsB,cACpB,YACA,EAAA,IAAA,GAAe,CACf,EAAA,IAAA,GAAe,IACf,MAC6B,EAAA;AAC7B,EAAM,MAAA,MAAA,GAAA,CAAU,OAAO,CAAK,IAAA,IAAA;AAE5B,EAAI,IAAA,SAAA,GAAY,aAAa,KAAM,EAAA;AAEnC,EAAA,IAAI,QAAQ,IAAM,EAAA;AAChB,IAAI,IAAA,YAAA,CAAa,MAAO,CAAA,OAAA,KAAY,UAAY,EAAA;AAC9C,MAAA,SAAA,GAAY,UAAU,UAAW,CAAA,MAAA,CAAO,QAAQ,CAAI,CAAA,EAAA,MAAA,CAAO,IAAI,CAAG,CAAA,CAAA,CAAA;AAAA,KAC7D,MAAA;AACL,MAAA,SAAA,GAAY,UAAU,SAAU,CAAA,MAAA,CAAO,QAAQ,CAAI,CAAA,EAAA,MAAA,CAAO,IAAI,CAAG,CAAA,CAAA,CAAA;AAAA;AACnE;AAGF,EAAM,MAAA,UAAA,GAAa,UAChB,KAAM,EAAA,CACN,aACA,CAAA,UAAA,EACA,CAAA,KAAA,CAA2B,YAAY,CAAA;AAE1C,EAAM,MAAA,CAAC,IAAM,EAAA,CAAC,EAAE,KAAA,EAAO,CAAC,CAAA,GAAI,MAAM,OAAA,CAAQ,GAAI,CAAA;AAAA,IAC5C,UAAU,KAAM,EAAA,CAAE,MAAM,IAAI,CAAA,CAAE,OAAO,MAAM,CAAA;AAAA,IAC3C;AAAA,GACD,CAAA;AAED,EAAM,MAAA,KAAA,GAAQ,OAAO,KAAK,CAAA;AAE1B,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,IAAA;AAAA,IACN,IAAA;AAAA,IACA,IAAA;AAAA,IACA,KAAA;AAAA,IACA,UAAY,EAAA,IAAA,CAAK,IAAK,CAAA,KAAA,GAAQ,IAAI;AAAA,GACpC;AACF;AAKO,MAAM,aAAwC,CAAA;AAAA,EACnD,WAAA,CACmB,IACA,EAAA,MAAA,EACA,SACjB,EAAA;AAHiB,IAAA,IAAA,CAAA,IAAA,GAAA,IAAA;AACA,IAAA,IAAA,CAAA,MAAA,GAAA,MAAA;AACA,IAAA,IAAA,CAAA,SAAA,GAAA,SAAA;AAAA;AAChB,EAEH,MAAM,gBACJ,CAAA,IAAA,GAAe,CACf,EAAA,IAAA,GAAe,IACf,MACsC,EAAA;AACtC,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,MACV,CAA8B,2BAAA,EAAA,IAAI,CAAU,OAAA,EAAA,IAAI,YAAY,MAAM,CAAA;AAAA,KACpE;AACA,IAAM,MAAA,KAAA,GAAQ,KAAK,IAAK,CAAA,IAAA,CAAK,SAAS,CAAE,CAAA,MAAA,CAAO,IAAM,EAAA,KAAA,EAAO,cAAc,CAAA;AAC1E,IAAA,MAAM,WAAc,GAAA,EAAE,MAAQ,EAAA,KAAA,EAAO,MAAM,MAAO,EAAA;AAClD,IAAA,OAAO,aAA0B,CAAA,KAAA,EAAO,IAAM,EAAA,IAAA,EAAM,WAAW,CAAA;AAAA;AACjE,EAEA,MAAM,gBAAA,CACJ,OACA,EAAA,gBAAA,EACA,YACiB,EAAA;AACjB,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA;AAAA,MACV,CAAA,kBAAA,EAAqB,OAAO,CAAA,mBAAA,EAAsB,gBAAgB,CAAA,cAAA;AAAA,KACpE;AACA,IAAA,MAAM,UAAa,GAAA,MAAM,IAAK,CAAA,IAAA,CAAK,IAAK,CAAA,SAAS,CAC9C,CAAA,KAAA,CAAM,EAAE,GAAA,EAAK,OAAQ,EAAC,EACtB,KAAM,EAAA;AAET,IAAI,IAAA,YAAA;AACJ,IAAA,IAAI,UAAY,EAAA;AACd,MAAA,YAAA,GAAe,UAAW,CAAA,EAAA;AAAA,KACrB,MAAA;AACL,MAAA,MAAM,CAAC,aAAa,CAAA,GAAI,MAAM,IAAA,CAAK,KAAK,IAAK,CAAA,SAAS,CACnD,CAAA,MAAA,CAAO,EAAE,GAAK,EAAA,OAAA,EAAS,cAA4B,CAAA,CACnD,UAAU,IAAI,CAAA;AACjB,MAAA,YAAA,GAAe,aAAc,CAAA,EAAA;AAAA;AAE/B,IAAO,OAAA,YAAA;AAAA;AACT,EAEA,MAAM,oBAAoB,GAA8C,EAAA;AACtE,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA,CAAM,CAA4C,yCAAA,EAAA,GAAG,CAAK,GAAA,CAAA,CAAA;AACtE,IAAO,OAAA,MAAM,IAAK,CAAA,IAAA,CAAK,IAAK,CAAA,SAAS,CAAE,CAAA,KAAA,CAAM,EAAE,GAAA,EAAU,CAAA,CAAE,KAAM,EAAA;AAAA;AACnE,EAEA,MAAM,iBAAiB,GAA4B,EAAA;AACjD,IAAA,IAAA,CAAK,MAAO,CAAA,KAAA,CAAM,CAA4C,yCAAA,EAAA,GAAG,CAAK,GAAA,CAAA,CAAA;AACtE,IAAA,MAAM,UAAa,GAAA,MAAM,IAAK,CAAA,IAAA,CAAK,IAAK,CAAA,SAAS,CAC9C,CAAA,KAAA,CAAM,EAAE,GAAA,EAAU,CAAA,CAClB,KAAM,EAAA;AAET,IAAA,IAAI,UAAY,EAAA;AACd,MAAA,MAAM,IAAK,CAAA,IAAA,CAAK,IAAK,CAAA,SAAS,CAAE,CAAA,KAAA,CAAM,EAAE,EAAA,EAAI,UAAW,CAAA,EAAA,EAAI,CAAA,CAAE,GAAI,EAAA;AAAA;AACnE;AAEJ;AAGO,MAAM,iBAAkB,CAAA;AAAA,EAC7B,YAA6B,IAAwB,EAAA;AAAxB,IAAA,IAAA,CAAA,IAAA,GAAA,IAAA;AAAA;AAAyB,EAEtD,MAAM,YAA0C,GAAA;AAC9C,IAAA,OAAO,MAAM,IAAA,CAAK,IAAK,CAAA,kBAAkB,CAAE,CAAA,MAAA;AAAA,MACzC,QAAA;AAAA,MACA,cAAA;AAAA,MACA;AAAA,KACF;AAAA;AACF,EAEA,MAAM,WAAW,IAAuC,EAAA;AACtD,IAAA,MAAM,SAAS,MAAM,IAAA,CAAK,IAAK,CAAA,kBAAkB,EAC9C,MAAuB,CAAA;AAAA,MACtB,QAAQ,IAAK,CAAA,MAAA;AAAA,MACb,cAAc,IAAK,CAAA,YAAA;AAAA,MACnB,iBAAmB,EAAA,IAAA,CAAK,SAAU,CAAA,IAAA,CAAK,iBAAiB,CAAA;AAAA,MACxD,YAAY,IAAK,CAAA;AAAA,KAClB,CACA,CAAA,SAAA,CAAgC,QAAQ,CAAA;AAE3C,IAAO,OAAA,MAAA,CAAO,CAAC,CAAE,CAAA,MAAA;AAAA;AACnB,EAEA,MAAM,wBACJ,YAC2B,EAAA;AAC3B,IAAA,OAAO,MAAM,IAAA,CAAK,IAAK,CAAA,kBAAkB,EACtC,KAAM,CAAA,EAAE,YAAa,EAAC,CACtB,CAAA,MAAA,CAEC,QAAU,EAAA,cAAA,EAAgB,qBAAqB,YAAY,CAAA;AAAA;AACjE,EAEA,MAAM,yBACJ,YACqC,EAAA;AACrC,IAAA,OAAO,MAAM,IAAA,CAAK,IAAK,CAAA,kBAAkB,EACtC,KAAM,CAAA,EAAE,YAAa,EAAC,CACtB,CAAA,OAAA,CAAQ,YAAc,EAAA,MAAM,EAC5B,KAAsB,EAAA;AAAA;AAE7B;AAUO,MAAM,gBAAiB,CAAA;AAAA,EAC5B,YAA6B,IAAwB,EAAA;AAAxB,IAAA,IAAA,CAAA,IAAA,GAAA,IAAA;AAAA;AAAyB,EAEtD,MAAM,eAAA,CACJ,MACA,EAAA,QAAA,EACA,OAAe,WACA,EAAA;AACf,IAAM,MAAA,IAAA,CAAK,KAAK,gBAAgB,CAAA,CAAE,OAAO,EAAE,MAAA,EAAQ,QAAU,EAAA,IAAA,EAAM,CAAA;AAAA;AACrE,EAEA,MAAM,sBAAsB,MAAyC,EAAA;AACnE,IAAA,OAAO,MAAM,IAAA,CAAK,IAAK,CAAA,gBAAgB,EACpC,KAAM,CAAA,EAAE,MAAO,EAAC,CAChB,CAAA,MAAA,CAAuB,IAAM,EAAA,QAAA,EAAU,YAAY,MAAM,CAAA;AAAA;AAC9D,EAEA,MAAM,gBAA4C,GAAA;AAChD,IAAA,OAAO,MAAM,IAAA,CAAK,IAAK,CAAA,gBAAgB,CAAE,CAAA,MAAA;AAAA,MACvC,IAAA;AAAA,MACA,QAAA;AAAA,MACA,UAAA;AAAA,MACA;AAAA,KACF;AAAA;AAEJ;AAWO,MAAM,uBAAwB,CAAA;AAAA,EACnC,YAA6B,IAAwB,EAAA;AAAxB,IAAA,IAAA,CAAA,IAAA,GAAA,IAAA;AAAA;AAAyB,EAEtD,MAAM,cACJ,CAAA,UAAA,EACA,YACiB,EAAA;AACjB,IAAM,MAAA,CAAC,WAAW,CAAI,GAAA,MAAM,KAAK,IAAK,CAAA,wBAAwB,EAC3D,MAAO,CAAA;AAAA,MACN,WAAa,EAAA,UAAA;AAAA,MACb;AAAA,KACD,CACA,CAAA,SAAA,CAAU,IAAI,CAAA;AACjB,IAAA,OAAO,WAAY,CAAA,EAAA;AAAA;AACrB,EAEA,MAAM,6BACJ,YAC2C,EAAA;AAC3C,IAAA,MAAM,SAAS,MAAM,IAAA,CAAK,IAAK,CAAA,wBAAwB,EACpD,MAAO,CAAA;AAAA,MACN,EAAI,EAAA,IAAA;AAAA,MACJ,UAAY,EAAA,aAAA;AAAA,MACZ,YAAc,EAAA,cAAA;AAAA,MACd,SAAW,EAAA;AAAA,KACZ,CACA,CAAA,KAAA,CAAM,EAAE,YAAA,EAA4B,CAAA,CACpC,OAAQ,CAAA,YAAA,EAAc,MAAM,CAAA,CAC5B,KAAM,EAAA;AACT,IAAO,OAAA,MAAA;AAAA;AACT,EAEA,MAAM,4BACJ,YACiC,EAAA;AACjC,IAAO,OAAA,MAAM,IAAK,CAAA,IAAA,CAAK,wBAAwB,CAAA,CAC5C,MAAM,EAAE,YAAA,EAA4B,CAAA,CACpC,MAAO,CAAA;AAAA,MACN,EAAI,EAAA,IAAA;AAAA,MACJ,UAAY,EAAA,aAAA;AAAA,MACZ,YAAc,EAAA,cAAA;AAAA,MACd,SAAW,EAAA;AAAA,KACZ,CAAA;AAAA;AAEP;;;;;;;;"}

package/dist/generated/openapidocument.cjs.js

@@ -562,6 +562,135 @@ const OPENAPI = `
         }
       }
     },
+    "/orchestrator-workflows": {
+      "get": {
+        "operationId": "findAllOrchestratorWorkflowImports",
+        "summary": "Fetch Import Jobs",
+        "security": [
+          {
+            "BearerAuth": []
+          }
+        ],
+        "tags": [
+          "Import"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/apiVersionHeaderParam"
+          },
+          {
+            "$ref": "#/components/parameters/pagePerIntegrationQueryParamDeprecated"
+          },
+          {
+            "$ref": "#/components/parameters/sizePerIntegrationQueryParamDeprecated"
+          },
+          {
+            "$ref": "#/components/parameters/pageQueryParam"
+          },
+          {
+            "$ref": "#/components/parameters/sizeQueryParam"
+          },
+          {
+            "$ref": "#/components/parameters/sortOrderQueryParam"
+          },
+          {
+            "$ref": "#/components/parameters/sortColumnQueryParam"
+          },
+          {
+            "$ref": "#/components/parameters/searchQueryParam"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Import Job list was fetched successfully with no errors",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "oneOf": [
+                    {
+                      "type": "array",
+                      "items": {
+                        "$ref": "#/components/schemas/SourceImport"
+                      }
+                    },
+                    {
+                      "$ref": "#/components/schemas/ImportJobListV2"
+                    }
+                  ]
+                },
+                "examples": {
+                  "twoImports": {
+                    "$ref": "#/components/examples/twoImports"
+                  },
+                  "multipleImportJobsV2": {
+                    "$ref": "#/components/examples/multipleImportJobsV2"
+                  }
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Generic error when there are errors and no Import Job is returned",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "oneOf": [
+                    {
+                      "type": "string",
+                      "description": "Generic error"
+                    },
+                    {
+                      "$ref": "#/components/schemas/ImportJobListV2"
+                    }
+                  ]
+                },
+                "examples": {
+                  "repositoryListErrors": {
+                    "$ref": "#/components/examples/importJobListErrors"
+                  }
+                }
+              }
+            }
+          }
+        }
+      },
+      "post": {
+        "operationId": "createOrchestratorWorkflowJobs",
+        "summary": "Execute an orchestrator workflow",
+        "security": [
+          {
+            "BearerAuth": []
+          }
+        ],
+        "tags": [
+          "Import"
+        ],
+        "requestBody": {
+          "description": "List of Import jobs to create",
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/ImportRequest"
+                }
+              },
+              "examples": {
+                "multipleImportRequests": {
+                  "$ref": "#/components/examples/multipleImportRequests"
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "The orchestrator workflow was triggered successfully."
+          }
+        }
+      }
+    },
     "/task-import/by-repo": {
       "get": {
         "operationId": "findTaskImportStatusByRepo",
@@ -651,6 +780,86 @@ const OPENAPI = `
         }
       }
     },
+    "/orchestrator-import/by-repo": {
+      "get": {
+        "operationId": "findOrchestratorImportStatusByRepo",
+        "summary": "Get Import Status by repository",
+        "security": [
+          {
+            "BearerAuth": []
+          }
+        ],
+        "tags": [
+          "Import"
+        ],
+        "parameters": [
+          {
+            "in": "query",
+            "name": "repo",
+            "description": "the full URL to the repo",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "$ref": "#/components/parameters/approvalToolParam"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Import Job status was determined successfully with no errors",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Import"
+                },
+                "examples": {
+                  "singleImportStatusForRepo": {
+                    "$ref": "#/components/examples/singleImportStatusForRepo"
+                  }
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Generic error"
+          }
+        }
+      },
+      "delete": {
+        "operationId": "deleteOrchestratorImportByRepo",
+        "summary": "Delete stored orchestrator workflow records for a specific repository",
+        "security": [
+          {
+            "BearerAuth": []
+          }
+        ],
+        "tags": [
+          "Import"
+        ],
+        "parameters": [
+          {
+            "in": "query",
+            "name": "repo",
+            "description": "the full URL to the repo",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "$ref": "#/components/parameters/approvalToolParam"
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "Repository was deleted successfully with no errors"
+          },
+          "500": {
+            "description": "Generic error"
+          }
+        }
+      }
+    },
     "/import/by-repo": {
       "get": {
         "operationId": "findImportStatusByRepo",
@@ -983,6 +1192,9 @@ const OPENAPI = `
               },
               {
                 "$ref": "#/components/schemas/TaskImportStatus"
+              },
+              {
+                "$ref": "#/components/schemas/WorkflowImportStatus"
               }
             ]
           },
@@ -1012,7 +1224,6 @@ const OPENAPI = `
       },
       "TaskImportStatus": {
         "type": "string",
-        "nullable": true,
         "description": "Import Job status",
         "enum": [
           "TASK_CANCELLED",
@@ -1076,6 +1287,9 @@ const OPENAPI = `
               },
               {
                 "$ref": "#/components/schemas/TaskImportStatus"
+              },
+              {
+                "$ref": "#/components/schemas/WorkflowImportStatus"
               }
             ]
           },
@@ -1087,6 +1301,14 @@ const OPENAPI = `
               }
             }
           },
+          "workflow": {
+            "type": "object",
+            "properties": {
+              "workflowId": {
+                "type": "string"
+              }
+            }
+          },
           "tasks": {
             "type": "array",
             "items": {
@@ -1098,6 +1320,17 @@ const OPENAPI = `
               }
             }
           },
+          "workflows": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "workflowId": {
+                  "type": "string"
+                }
+              }
+            }
+          },
           "catalogEntityName": {
             "type": "string",
             "description": "Specified entity name in the catalog. Filled only in response for dry-run import requests."
@@ -1281,6 +1514,19 @@ const OPENAPI = `
             }
           }
         }
+      },
+      "WorkflowImportStatus": {
+        "type": "string",
+        "description": "Import Job status",
+        "enum": [
+          "WORKFLOW_ACTIVE",
+          "WORKFLOW_COMPLETED",
+          "WORKFLOW_ABORTED",
+          "WORKFLOW_SUSPENDED",
+          "WORKFLOW_ERROR",
+          "WORKFLOW_PENDING",
+          "WORKFLOW_FETCH_FAILED"
+        ]
       }
     },
     "securitySchemes": {