@firestartr/cli 2.1.0 → 2.2.0-snapshot-0

package/build/index.js

@@ -358185,6 +358185,17 @@ const external_node_child_process_namespaceObject = __WEBPACK_EXTERNAL_createReq
     $schema: SCHEMA,
     $id: 'ComponentClaim',
     definitions: {
+        ApiDefinition: {
+            $id: 'firestartr.dev://common/ComponentClaimApiDefinition',
+            type: 'object',
+            properties: {
+                name: { type: 'string' },
+                definitionfile: { type: 'string' },
+                type: { type: 'string' },
+            },
+            required: ['name', 'definitionfile', 'type'],
+            additionalProperties: false,
+        },
         ComponentClaim: {
             $id: 'firestartr.dev://common/ComponentClaim',
             type: 'object',
@@ -358209,6 +358220,26 @@ const external_node_child_process_namespaceObject = __WEBPACK_EXTERNAL_createReq
                         subComponentOf: {
                             $ref: 'firestartr.dev://common/FirestartrComponentRef',
                         },
+                        providesApis: {
+                            anyOf: [
+                                {
+                                    type: 'array',
+                                    items: {
+                                        $ref: 'firestartr.dev://common/ComponentClaimApiDefinition',
+                                    },
+                                },
+                                {
+                                    type: 'object',
+                                    additionalProperties: {
+                                        $ref: 'firestartr.dev://common/ComponentClaimApiDefinition',
+                                    },
+                                },
+                            ],
+                        },
+                        consumesApis: {
+                            type: 'array',
+                            items: { type: 'string' },
+                        },
                         providers: {
                             type: 'object',
                             properties: {
@@ -361980,6 +362011,12 @@ function isPathInside(pathA, pathB) {
     return (normalizedPathB.startsWith(pathAWithSeparator) ||
         normalizedPathB === normalizedPathA);
 }
+function sanitizeApiEntityName(name) {
+    return name
+        .toLowerCase()
+        .replace(/[^a-z0-9-]/g, '-')
+        .replace(/^-+|-+$/g, '');
+}
 
 ;// CONCATENATED MODULE: ../cdk8s_renderer/imports/firestartr.dev.ts
 // generated by cdk8s
@@ -365384,9 +365421,19 @@ class CatalogUserChart extends BaseCatalogChart {
 ;// CONCATENATED MODULE: ../cdk8s_renderer/src/charts/catalog/componentChart.ts
 
 
+
+function claimProvidesApis(claim) {
+    if (!claim.providesApis)
+        return undefined;
+    if (Array.isArray(claim.providesApis)) {
+        return claim.providesApis.map((api) => sanitizeApiEntityName(api.name));
+    }
+    return Object.values(claim.providesApis).map((api) => sanitizeApiEntityName(api.name));
+}
 class CatalogComponentChart extends BaseCatalogChart {
     template() {
         const claim = this.get('claim');
+        const providesApis = claimProvidesApis(claim);
         return {
             apiVersion: 'backstage.io/v1alpha1',
             kind: 'Component',
@@ -365400,6 +365447,8 @@ class CatalogComponentChart extends BaseCatalogChart {
                 owner: claim.owner || 'nobody',
                 system: claim.system,
                 subComponentOf: claim.subComponentOf,
+                ...(providesApis ? { providesApis } : {}),
+                ...(claim.consumesApis ? { consumesApis: claim.consumesApis } : {}),
             },
         };
     }
@@ -365568,6 +365617,41 @@ class CatalogOrgWebhookChart extends BaseCatalogChart {
     }
 }
 
+;// CONCATENATED MODULE: ../cdk8s_renderer/src/charts/catalog/apiChart.ts
+
+
+class CatalogApiChart extends BaseCatalogChart {
+    template() {
+        const claim = this.get('claim');
+        return {
+            apiVersion: 'backstage.io/v1alpha1',
+            kind: 'API',
+            metadata: {
+                name: claim.name,
+                annotations: claim.annotations || {},
+            },
+            spec: {
+                type: claim.type,
+                lifecycle: claim.lifecycle,
+                owner: claim.owner || 'nobody',
+                system: claim.system,
+                definition: {
+                    $text: claim.definitionUrl,
+                },
+            },
+        };
+    }
+    instanceApiObject(template) {
+        return new lib.ApiObject(this, `${template.kind}-${template.metadata.name}`, template);
+    }
+    gvk() {
+        return {
+            kind: 'API',
+            apiVersion: 'v1alpha1',
+        };
+    }
+}
+
 ;// CONCATENATED MODULE: ../cdk8s_renderer/src/charts/catalog/index.ts
 
 
@@ -365579,6 +365663,7 @@ class CatalogOrgWebhookChart extends BaseCatalogChart {
 
 
 
+
 ;// CONCATENATED MODULE: ../cdk8s_renderer/src/charts/workspaces/base.ts
 
 class BaseWorkspaceChart extends BaseChart {
@@ -365934,6 +366019,7 @@ class SecretsChart extends BaseSecretsChart {
     CatalogArgoDeployChart: CatalogArgoDeployChart,
     CatalogSecretsChart: CatalogSecretsChart,
     CatalogOrgWebhookChart: CatalogOrgWebhookChart,
+    CatalogApiChart: CatalogApiChart,
     GithubGroupChart: GithubGroupChart,
     GithubMembershipChart: GithubMembershipChart,
     GithubRepositoryChart: GithubRepositoryChart,
@@ -365951,6 +366037,15 @@ class SecretsChart extends BaseSecretsChart {
 
 
 
+
+function normalizeProvidesApis(providesApis) {
+    if (!providesApis)
+        return [];
+    if (Array.isArray(providesApis)) {
+        return providesApis;
+    }
+    return Object.values(providesApis);
+}
 async function renderClaims(catalogScope, firestartrScope, data) {
     const result = {};
     const { renderClaims, crs } = data;
@@ -365983,6 +366078,11 @@ async function renderClaims(catalogScope, firestartrScope, data) {
                 result[`${catalogEntity.kind}-${catalogEntity.metadata.name}`] =
                     catalogEntity.toJson();
             }
+            for (const extraChart of extraCharts) {
+                const { claim, chart } = extraChart;
+                setRenderedClaim(claim, chart.toJson());
+                result[`${chart.kind}-${chart.metadata.name}`] = chart.toJson();
+            }
             /**
              * If there is no provider don't store the CR in the map
              */
@@ -365990,11 +366090,6 @@ async function renderClaims(catalogScope, firestartrScope, data) {
                 continue;
             const firestartrEntityJson = firestartrEntity.toJson();
             setRenderedClaim(claim, firestartrEntityJson);
-            for (const extraChart of extraCharts) {
-                const { claim, chart } = extraChart;
-                setRenderedClaim(claim, chart.toJson());
-                result[`${chart.kind}-${chart.metadata.name}`] = chart.toJson();
-            }
             if (!firestartrEntityJson.metadata.annotations ||
                 !firestartrEntityJson.metadata.name)
                 throw firestartrEntityJson;
@@ -366010,6 +366105,7 @@ async function renderClaims(catalogScope, firestartrScope, data) {
 async function renderClaim(catalogScope, firestartrScope, claim, patches, previousCR = null) {
     let catalogEntity = undefined;
     let firestartrEntity = undefined;
+    const extraCharts = [];
     const chartId = `${claim.kind}-${claim.name}`.toLowerCase();
     let firestartrId = null;
     if (previousCR) {
@@ -366056,6 +366152,47 @@ async function renderClaim(catalogScope, firestartrScope, claim, patches, previo
             }
             if (loadCatalog) {
                 catalogEntity = new charts.CatalogComponentChart(catalogScope, chartId, firestartrId, claim, renderPatches);
+                const githubProvider = claim.providers?.github;
+                const org = githubProvider?.org;
+                const repoName = githubProvider?.name;
+                const defaultBranch = githubProvider?.branchStrategy?.defaultBranch || 'main';
+                for (const apiDefinition of normalizeProvidesApis(claim.providesApis)) {
+                    if (!org ||
+                        !repoName ||
+                        !apiDefinition?.definitionfile ||
+                        !apiDefinition?.name) {
+                        cdk8s_renderer_src_logger.warn(`Skipping API generation for component ${claim.name} due to missing github provider fields or API definition data`);
+                        continue;
+                    }
+                    const definitionFilePath = String(apiDefinition.definitionfile).replace(/^\/+/, '');
+                    const encodedDefinitionFilePath = definitionFilePath
+                        .split('/')
+                        .map((segment) => encodeURIComponent(segment))
+                        .join('/');
+                    const definitionUrl = `https://raw.githubusercontent.com/${org}/${repoName}/refs/heads/${defaultBranch}/${encodedDefinitionFilePath}`;
+                    const sanitizedApiName = sanitizeApiEntityName(apiDefinition.name);
+                    const apiChart = new charts.CatalogApiChart(catalogScope, `${chartId}-api-${sanitizedApiName}`, firestartrId, {
+                        name: sanitizedApiName,
+                        type: apiDefinition.type,
+                        lifecycle: claim.lifecycle,
+                        owner: claim.owner,
+                        system: claim.system,
+                        definitionUrl,
+                        annotations: {
+                            ...(claim.annotations || {}),
+                            title: apiDefinition.name,
+                        },
+                    }, []);
+                    await apiChart.render();
+                    const apiObject = await apiChart.postRenderer([]);
+                    extraCharts.push({
+                        claim: {
+                            kind: 'API',
+                            name: sanitizedApiName,
+                        },
+                        chart: apiObject,
+                    });
+                }
             }
             break;
         case 'TFWorkspaceClaim':
@@ -366128,7 +366265,10 @@ async function renderClaim(catalogScope, firestartrScope, claim, patches, previo
         firestartrEntity: await (firestartrEntityChart
             ? firestartrEntityChart.postRenderer(postPatches)
             : undefined),
-        extraCharts: (await firestartrEntity?.extraCharts()) || [],
+        extraCharts: [
+            ...((await firestartrEntity?.extraCharts()) || []),
+            ...extraCharts,
+        ],
     };
 }
 
@@ -379457,7 +379597,7 @@ const crs_analyzerSubcommand = {
 };
 
 ;// CONCATENATED MODULE: ./package.json
-const package_namespaceObject = {"i8":"2.1.0"};
+const package_namespaceObject = JSON.parse('{"i8":"2.2.0-snapshot-0"}');
 ;// CONCATENATED MODULE: ../../package.json
 const package_namespaceObject_1 = {"i8":"2.1.0"};
 ;// CONCATENATED MODULE: ./src/subcommands/index.ts

package/build/packages/cdk8s_renderer/src/charts/catalog/apiChart.d.ts

@@ -0,0 +1,23 @@
+import { BaseCatalogChart } from './base';
+import { ApiObject, GroupVersionKind } from 'cdk8s';
+export declare class CatalogApiChart extends BaseCatalogChart {
+    template(): {
+        apiVersion: string;
+        kind: string;
+        metadata: {
+            name: string;
+            annotations: Record<string, string>;
+        };
+        spec: {
+            type: string;
+            lifecycle: string;
+            owner: string;
+            system: string;
+            definition: {
+                $text: string;
+            };
+        };
+    };
+    instanceApiObject(template: any): ApiObject;
+    gvk(): GroupVersionKind;
+}

package/build/packages/cdk8s_renderer/src/charts/catalog/componentChart.d.ts

@@ -11,6 +11,8 @@ export declare class CatalogComponentChart extends BaseCatalogChart {
             };
         };
         spec: {
+            consumesApis?: string[];
+            providesApis?: string[];
             type: string;
             lifecycle: string;
             owner: string;

package/build/packages/cdk8s_renderer/src/charts/catalog/index.d.ts

@@ -7,3 +7,4 @@ export { CatalogTFWorkspaceChart } from './tfWorkspaceChart';
 export { CatalogArgoDeployChart } from './argodeployChart';
 export { CatalogSecretsChart } from './secretsChart';
 export { CatalogOrgWebhookChart } from './orgWebhookChart';
+export { CatalogApiChart } from './apiChart';

package/build/packages/cdk8s_renderer/src/charts/index.d.ts

@@ -1,5 +1,5 @@
 import { GithubGroupChart, GithubMembershipChart, GithubRepositoryChart, GithubOrgWebhookChart } from './github';
-import { CatalogComponentChart, CatalogDomainChart, CatalogGroupChart, CatalogSystemChart, CatalogUserChart, CatalogTFWorkspaceChart, CatalogArgoDeployChart, CatalogSecretsChart, CatalogOrgWebhookChart } from './catalog';
+import { CatalogComponentChart, CatalogDomainChart, CatalogGroupChart, CatalogSystemChart, CatalogUserChart, CatalogTFWorkspaceChart, CatalogArgoDeployChart, CatalogSecretsChart, CatalogOrgWebhookChart, CatalogApiChart } from './catalog';
 import { TFWorkspaceChart } from './workspaces/tfworkspaceChart';
 import { ArgoDeployChart } from './argocd/argodeployChart';
 import { SecretsChart } from './secrets/secretsChart';
@@ -13,6 +13,7 @@ declare const _default: {
     CatalogArgoDeployChart: typeof CatalogArgoDeployChart;
     CatalogSecretsChart: typeof CatalogSecretsChart;
     CatalogOrgWebhookChart: typeof CatalogOrgWebhookChart;
+    CatalogApiChart: typeof CatalogApiChart;
     GithubGroupChart: typeof GithubGroupChart;
     GithubMembershipChart: typeof GithubMembershipChart;
     GithubRepositoryChart: typeof GithubRepositoryChart;

package/build/packages/cdk8s_renderer/src/claims/base/component.d.ts

@@ -1,4 +1,9 @@
 import { IClaim } from '../base';
+export interface IApiDefinition {
+    name: string;
+    definitionfile: string;
+    type: string;
+}
 export interface IComponentClaim extends IClaim {
     type: string;
     lifecycle: string;
@@ -9,5 +14,7 @@ export interface IComponentClaim extends IClaim {
     providers: object;
     platformOwner?: `${string}:${string}`;
     maintainedBy?: `${string}:${string}`[];
+    providesApis?: IApiDefinition[] | Record<string, IApiDefinition>;
+    consumesApis?: string[];
 }
 export declare const schema = "firestartr.dev://common/ComponentClaim";

package/build/packages/cdk8s_renderer/src/claims/base/schemas/component.schema.d.ts

@@ -2,6 +2,23 @@ declare const _default: {
     $schema: string;
     $id: string;
     definitions: {
+        ApiDefinition: {
+            $id: string;
+            type: string;
+            properties: {
+                name: {
+                    type: string;
+                };
+                definitionfile: {
+                    type: string;
+                };
+                type: {
+                    type: string;
+                };
+            };
+            required: string[];
+            additionalProperties: boolean;
+        };
         ComponentClaim: {
             $id: string;
             type: string;
@@ -33,6 +50,27 @@ declare const _default: {
                     subComponentOf: {
                         $ref: string;
                     };
+                    providesApis: {
+                        anyOf: ({
+                            type: string;
+                            items: {
+                                $ref: string;
+                            };
+                            additionalProperties?: undefined;
+                        } | {
+                            type: string;
+                            additionalProperties: {
+                                $ref: string;
+                            };
+                            items?: undefined;
+                        })[];
+                    };
+                    consumesApis: {
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                    };
                     providers: {
                         type: string;
                         properties: {

package/build/packages/cdk8s_renderer/src/claims/base/schemas/index.d.ts

@@ -247,6 +247,23 @@ declare const schemas: {
         $schema: string;
         $id: string;
         definitions: {
+            ApiDefinition: {
+                $id: string;
+                type: string;
+                properties: {
+                    name: {
+                        type: string;
+                    };
+                    definitionfile: {
+                        type: string;
+                    };
+                    type: {
+                        type: string;
+                    };
+                };
+                required: string[];
+                additionalProperties: boolean;
+            };
             ComponentClaim: {
                 $id: string;
                 type: string;
@@ -278,6 +295,27 @@ declare const schemas: {
                         subComponentOf: {
                             $ref: string;
                         };
+                        providesApis: {
+                            anyOf: ({
+                                type: string;
+                                items: {
+                                    $ref: string;
+                                };
+                                additionalProperties?: undefined;
+                            } | {
+                                type: string;
+                                additionalProperties: {
+                                    $ref: string;
+                                };
+                                items?: undefined;
+                            })[];
+                        };
+                        consumesApis: {
+                            type: string;
+                            items: {
+                                type: string;
+                            };
+                        };
                         providers: {
                             type: string;
                             properties: {

package/build/packages/cdk8s_renderer/src/utils/claimUtils.d.ts

@@ -4,3 +4,4 @@ export declare function resolveClaimFilesList(claimRefsList: string): string[];
 export declare function resolveClaimEntries(claimRefsList: string[]): AsyncGenerator<string, void, unknown>;
 export declare function resolveClaimFileRef(claimFile: string): Promise<string>;
 export declare function getClaimsEntryAbsolutePath(claimsDir: string, entryPath: string): string;
+export declare function sanitizeApiEntityName(name: string): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firestartr/cli",
-  "version": "2.1.0",
+  "version": "2.2.0-snapshot-0",
   "private": false,
   "description": "Commandline tool",
   "main": "build/main.js",