@tmdjr/backstage-contracts 0.0.5 → 0.0.7

package/dist/backstage.types.d.ts

@@ -115,6 +115,120 @@ export interface paths {
         patch: operations["ExampleCrudController_unarchive"];
         trace?: never;
     };
+    "/backstage/services": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** List cached backstage services */
+        get: operations["BackstageCatalogController_list"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/backstage/services/{repo}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get full detail for a specific repo */
+        get: operations["BackstageCatalogController_getOne"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/backstage/sync": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post: operations["BackstageCatalogController_sync"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/backstage/services/{repo}/readme": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["BackstageCatalogController_readme"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/backstage/services/{repo}/openapi": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["BackstageCatalogController_openapi"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/backstage/services/{repo}/runbook": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["BackstageCatalogController_runbook"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/backstage/services/{repo}/metadata": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get: operations["BackstageCatalogController_metadata"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
 }
 export type webhooks = Record<string, never>;
 export interface components {
@@ -161,6 +275,63 @@ export interface components {
             /** Format: date-time */
             lastUpdated?: string;
         };
+        DocBlobDto: {
+            /** @description Raw content of the document */
+            content: string;
+            /** @description Git SHA of the fetched file */
+            sha?: string;
+            /** Format: date-time */
+            fetchedAt?: string;
+            /** @enum {string} */
+            format?: "yaml" | "json" | "markdown";
+        };
+        ServiceSummaryDto: {
+            repoName: string;
+            description?: string;
+            topics: string[];
+            defaultBranch?: string;
+            htmlUrl?: string;
+            /** Format: date-time */
+            lastSyncAt?: string;
+            /** @enum {string} */
+            syncStatus: "idle" | "ok" | "partial" | "failed" | "rate_limited";
+            syncError?: string;
+            readme?: components["schemas"]["DocBlobDto"];
+            openapi?: components["schemas"]["DocBlobDto"];
+            runbook?: components["schemas"]["DocBlobDto"];
+            serviceMetadata?: components["schemas"]["DocBlobDto"];
+        };
+        ServiceDetailDto: {
+            repoName: string;
+            description?: string;
+            topics: string[];
+            defaultBranch?: string;
+            htmlUrl?: string;
+            /** Format: date-time */
+            lastSyncAt?: string;
+            /** @enum {string} */
+            syncStatus: "idle" | "ok" | "partial" | "failed" | "rate_limited";
+            syncError?: string;
+            readme?: components["schemas"]["DocBlobDto"];
+            openapi?: components["schemas"]["DocBlobDto"];
+            runbook?: components["schemas"]["DocBlobDto"];
+            serviceMetadata?: components["schemas"]["DocBlobDto"];
+        };
+        SyncRequestDto: {
+            /** @description Optional list of repo names to sync; defaults to all repos in the org */
+            repos?: string[];
+            /** @description Force re-fetch even if SHA is unchanged */
+            force?: boolean;
+        };
+        SyncResponseDto: {
+            total: number;
+            succeeded: number;
+            failed: number;
+            /** @description Duration in milliseconds */
+            durationMs: number;
+            /** @description Repos that failed to sync (with error message inline if available) */
+            failures: string[];
+        };
     };
     responses: never;
     parameters: never;
@@ -381,4 +552,161 @@ export interface operations {
             };
         };
     };
+    BackstageCatalogController_list: {
+        parameters: {
+            query?: {
+                /** @description Search by name, description, or topics */
+                q?: string;
+                /** @description Comma-separated list of blobs to include (readme,openapi,runbook,metadata) */
+                include?: string;
+                /** @description Trigger a refresh for the returned items */
+                refresh?: boolean;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ServiceSummaryDto"][];
+                };
+            };
+        };
+    };
+    BackstageCatalogController_getOne: {
+        parameters: {
+            query?: {
+                /** @description Trigger a refresh before returning details */
+                refresh?: boolean;
+            };
+            header?: never;
+            path: {
+                repo: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["ServiceDetailDto"];
+                };
+            };
+        };
+    };
+    BackstageCatalogController_sync: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["SyncRequestDto"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SyncResponseDto"];
+                };
+            };
+        };
+    };
+    BackstageCatalogController_readme: {
+        parameters: {
+            query: {
+                refresh: string;
+            };
+            header?: never;
+            path: {
+                repo: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    BackstageCatalogController_openapi: {
+        parameters: {
+            query: {
+                refresh: string;
+            };
+            header?: never;
+            path: {
+                repo: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    BackstageCatalogController_runbook: {
+        parameters: {
+            query: {
+                refresh: string;
+            };
+            header?: never;
+            path: {
+                repo: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    BackstageCatalogController_metadata: {
+        parameters: {
+            query: {
+                refresh: string;
+            };
+            header?: never;
+            path: {
+                repo: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
 }

package/dist/index.d.ts

@@ -1,5 +1,10 @@
 export type { AuthTestDto } from './models/AuthTestDto';
 export type { CreateExampleMongodbDocDto } from './models/CreateExampleMongodbDocDto';
+export type { DocBlobDto } from './models/DocBlobDto';
 export type { ExampleMongodbDocDto } from './models/ExampleMongodbDocDto';
 export type { ExampleMongodbDocObjectDto } from './models/ExampleMongodbDocObjectDto';
+export type { ServiceDetailDto } from './models/ServiceDetailDto';
+export type { ServiceSummaryDto } from './models/ServiceSummaryDto';
+export type { SyncRequestDto } from './models/SyncRequestDto';
+export type { SyncResponseDto } from './models/SyncResponseDto';
 export type { UpdateExampleMongodbDocDto } from './models/UpdateExampleMongodbDocDto';

package/dist/models/DocBlobDto.d.ts

@@ -0,0 +1,12 @@
+export type DocBlobDto = {
+    /**
+     * Raw content of the document
+     */
+    content: string;
+    /**
+     * Git SHA of the fetched file
+     */
+    sha?: string;
+    fetchedAt?: string;
+    format?: 'yaml' | 'json' | 'markdown';
+};

package/dist/models/DocBlobDto.js

@@ -0,0 +1 @@
+export {};

package/dist/models/ServiceDetailDto.d.ts

@@ -0,0 +1,15 @@
+import type { DocBlobDto } from './DocBlobDto';
+export type ServiceDetailDto = {
+    repoName: string;
+    description?: string;
+    topics: Array<string>;
+    defaultBranch?: string;
+    htmlUrl?: string;
+    lastSyncAt?: string;
+    syncStatus: 'idle' | 'ok' | 'partial' | 'failed' | 'rate_limited';
+    syncError?: string;
+    readme?: DocBlobDto;
+    openapi?: DocBlobDto;
+    runbook?: DocBlobDto;
+    serviceMetadata?: DocBlobDto;
+};

package/dist/models/ServiceDetailDto.js

@@ -0,0 +1 @@
+export {};

package/dist/models/ServiceSummaryDto.d.ts

@@ -0,0 +1,15 @@
+import type { DocBlobDto } from './DocBlobDto';
+export type ServiceSummaryDto = {
+    repoName: string;
+    description?: string;
+    topics: Array<string>;
+    defaultBranch?: string;
+    htmlUrl?: string;
+    lastSyncAt?: string;
+    syncStatus: 'idle' | 'ok' | 'partial' | 'failed' | 'rate_limited';
+    syncError?: string;
+    readme?: DocBlobDto;
+    openapi?: DocBlobDto;
+    runbook?: DocBlobDto;
+    serviceMetadata?: DocBlobDto;
+};

package/dist/models/ServiceSummaryDto.js

@@ -0,0 +1 @@
+export {};

package/dist/models/SyncRequestDto.d.ts

@@ -0,0 +1,10 @@
+export type SyncRequestDto = {
+    /**
+     * Optional list of repo names to sync; defaults to all repos in the org
+     */
+    repos?: Array<string>;
+    /**
+     * Force re-fetch even if SHA is unchanged
+     */
+    force?: boolean;
+};

package/dist/models/SyncRequestDto.js

@@ -0,0 +1 @@
+export {};

package/dist/models/SyncResponseDto.d.ts

@@ -0,0 +1,13 @@
+export type SyncResponseDto = {
+    total: number;
+    succeeded: number;
+    failed: number;
+    /**
+     * Duration in milliseconds
+     */
+    durationMs: number;
+    /**
+     * Repos that failed to sync (with error message inline if available)
+     */
+    failures: Array<string>;
+};

package/dist/models/SyncResponseDto.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tmdjr/backstage-contracts",
-  "version": "0.0.5",
+  "version": "0.0.7",
   "description": "Types & runtime enums generated from NGX backstage spec",
   "license": "MIT",
   "private": false,