@numa-tech/numa 1.12.10 → 1.13.0

package/dist/repositories/client.d.ts

@@ -0,0 +1,540 @@
+import type { AuthConfig } from "../config.js";
+import { type KeycloakTokenProvider } from "../oauth.js";
+import { type RepositoryConsumerType, type RepositoryPlanRequest, type RepositoryRunCreate } from "./schemas.js";
+export declare const SCM_API_ROOT = "/api/v1/scm";
+export declare const SOURCE_REPOSITORY_CONTRACT_VERSION = "v2";
+export interface SourceRepositoryClientDependencies {
+    fetch?: typeof fetch;
+    tokenProvider?: KeycloakTokenProvider;
+}
+export interface CursorPageOptions {
+    search?: string;
+    cursor?: string;
+    limit?: number;
+}
+export interface RepositoryListOptions {
+    status?: string;
+    connectionCode?: string;
+    namespace?: string;
+    ownerTeamId?: string;
+    managementMode?: string;
+    search?: string;
+    page?: number;
+    size?: number;
+}
+export interface RepositoryRunListOptions {
+    state?: string;
+    repositoryKey?: string;
+    consumerType?: RepositoryConsumerType;
+    page?: number;
+    size?: number;
+}
+export declare class SourceRepositoryClient {
+    private readonly config;
+    private readonly fetchImpl;
+    private readonly tokenProvider;
+    constructor(config: AuthConfig, dependencies?: SourceRepositoryClientDependencies);
+    private authenticatedFetch;
+    private json;
+    listConnections(): Promise<{
+        items: {
+            code: string;
+            name: string;
+            provider: string;
+            status: string;
+            capabilities: string[] | {
+                code: string;
+                supported: boolean;
+                reason?: string | null | undefined;
+            }[] | Record<string, boolean>;
+            lastCheckedAt?: string | null | undefined;
+        }[];
+        nextCursor: string | null;
+        hasMore: boolean;
+        total?: number | undefined;
+        page?: number | undefined;
+        size?: number | undefined;
+    }>;
+    listRepositories(options?: RepositoryListOptions): Promise<{
+        items: {
+            repositoryKey: string;
+            id?: string | undefined;
+            connectionCode: string;
+            provider?: string | null | undefined;
+            externalId?: string | null | undefined;
+            namespaceExternalId?: string | null | undefined;
+            namespacePath?: string | null | undefined;
+            name?: string | null | undefined;
+            fullName: string;
+            description?: string | null | undefined;
+            visibility?: string | null | undefined;
+            defaultBranch?: string | null | undefined;
+            lastObservedRevision?: string | null | undefined;
+            webUrl?: string | null | undefined;
+            cloneUrl?: string | null | undefined;
+            managementMode?: string | null | undefined;
+            status: string;
+            ownerTeamId?: string | null | undefined;
+            lastReconciledAt?: string | null | undefined;
+            version?: number | undefined;
+            repositoryId: string | undefined;
+            observedRevision: string | null | undefined;
+        }[];
+        nextCursor: string | null;
+        hasMore: boolean;
+        total?: number | undefined;
+        page?: number | undefined;
+        size?: number | undefined;
+    }>;
+    getRepository(repositoryKey: string): Promise<{
+        repositoryKey: string;
+        id?: string | undefined;
+        connectionCode: string;
+        provider?: string | null | undefined;
+        externalId?: string | null | undefined;
+        namespaceExternalId?: string | null | undefined;
+        namespacePath?: string | null | undefined;
+        name?: string | null | undefined;
+        fullName: string;
+        description?: string | null | undefined;
+        visibility?: string | null | undefined;
+        defaultBranch?: string | null | undefined;
+        lastObservedRevision?: string | null | undefined;
+        webUrl?: string | null | undefined;
+        cloneUrl?: string | null | undefined;
+        managementMode?: string | null | undefined;
+        status: string;
+        ownerTeamId?: string | null | undefined;
+        lastReconciledAt?: string | null | undefined;
+        version?: number | undefined;
+        repositoryId: string | undefined;
+        observedRevision: string | null | undefined;
+    }>;
+    listNamespaces(connectionCode: string, options?: CursorPageOptions): Promise<{
+        items: {
+            externalId: string;
+            name: string;
+            fullPath?: string | null | undefined;
+            parentExternalId?: string | null | undefined;
+            visibility?: string | null | undefined;
+            webUrl?: string | null | undefined;
+        }[];
+        nextCursor: string | null;
+        hasMore: boolean;
+        total?: number | undefined;
+        page?: number | undefined;
+        size?: number | undefined;
+    }>;
+    listRemoteRepositories(connectionCode: string, options?: CursorPageOptions): Promise<{
+        items: {
+            externalId: string;
+            namespace?: string | null | undefined;
+            namespaceExternalId?: string | null | undefined;
+            name: string;
+            fullName?: string | null | undefined;
+            description?: string | null | undefined;
+            visibility?: string | null | undefined;
+            defaultBranch?: string | null | undefined;
+            headRevision?: string | null | undefined;
+            archived?: boolean | undefined;
+            webUrl?: string | null | undefined;
+            httpCloneUrl?: string | null | undefined;
+            sshCloneUrl?: string | null | undefined;
+            namespacePath: string | null | undefined;
+            httpUrl: string | null | undefined;
+            sshUrl: string | null | undefined;
+        }[];
+        nextCursor: string | null;
+        hasMore: boolean;
+        total?: number | undefined;
+        page?: number | undefined;
+        size?: number | undefined;
+    }>;
+    getRemoteRepository(connectionCode: string, externalId: string): Promise<{
+        externalId: string;
+        namespace?: string | null | undefined;
+        namespaceExternalId?: string | null | undefined;
+        name: string;
+        fullName?: string | null | undefined;
+        description?: string | null | undefined;
+        visibility?: string | null | undefined;
+        defaultBranch?: string | null | undefined;
+        headRevision?: string | null | undefined;
+        archived?: boolean | undefined;
+        webUrl?: string | null | undefined;
+        httpCloneUrl?: string | null | undefined;
+        sshCloneUrl?: string | null | undefined;
+        namespacePath: string | null | undefined;
+        httpUrl: string | null | undefined;
+        sshUrl: string | null | undefined;
+    }>;
+    getCapabilities(connectionCode: string, consumerType?: RepositoryConsumerType): Promise<{
+        contractVersion?: string | null | undefined;
+        connection: {
+            code: string;
+            name: string;
+            provider: string;
+            status: string;
+            capabilities: string[] | {
+                code: string;
+                supported: boolean;
+                reason?: string | null | undefined;
+            }[] | Record<string, boolean>;
+            lastCheckedAt?: string | null | undefined;
+        };
+        providerCapabilities: Record<string, boolean>;
+        allowedActions: string[];
+        constraints: {
+            supportedVisibilities: string[];
+            supportedOperations: ("CREATE" | "DISABLE" | "REGISTER_EXISTING" | "USE_EXISTING")[];
+            defaultVisibility?: string | null | undefined;
+            defaultBranch?: string | null | undefined;
+            namePattern?: string | null | undefined;
+            nameMaxLength?: number | undefined;
+            namespaceRequired?: boolean | undefined;
+        };
+    }>;
+    createPlan(input: RepositoryPlanRequest): Promise<{
+        planNo: string;
+        operation: "CREATE" | "DISABLE" | "REGISTER_EXISTING" | "USE_EXISTING";
+        state: string;
+        planHash: string;
+        normalizedSpec: Record<string, unknown>;
+        sideEffects: unknown[];
+        warnings: (string | {
+            path?: string | null | undefined;
+            code?: string | null | undefined;
+            message: string;
+        })[];
+        blockers: (string | {
+            path?: string | null | undefined;
+            code?: string | null | undefined;
+            message: string;
+        })[];
+        expiresAt?: string | null | undefined;
+    }>;
+    getPlan(planNo: string): Promise<{
+        planNo: string;
+        operation: "CREATE" | "DISABLE" | "REGISTER_EXISTING" | "USE_EXISTING";
+        state: string;
+        planHash: string;
+        normalizedSpec: Record<string, unknown>;
+        sideEffects: unknown[];
+        warnings: (string | {
+            path?: string | null | undefined;
+            code?: string | null | undefined;
+            message: string;
+        })[];
+        blockers: (string | {
+            path?: string | null | undefined;
+            code?: string | null | undefined;
+            message: string;
+        })[];
+        expiresAt?: string | null | undefined;
+    }>;
+    createRun(input: RepositoryRunCreate, idempotencyKey: string): Promise<{
+        runNo: string;
+        planNo: string;
+        state: string;
+        stepCode?: string | null | undefined;
+        repository?: {
+            repositoryKey: string;
+            id?: string | undefined;
+            connectionCode: string;
+            provider?: string | null | undefined;
+            externalId?: string | null | undefined;
+            namespaceExternalId?: string | null | undefined;
+            namespacePath?: string | null | undefined;
+            name?: string | null | undefined;
+            fullName: string;
+            description?: string | null | undefined;
+            visibility?: string | null | undefined;
+            defaultBranch?: string | null | undefined;
+            lastObservedRevision?: string | null | undefined;
+            webUrl?: string | null | undefined;
+            cloneUrl?: string | null | undefined;
+            managementMode?: string | null | undefined;
+            status: string;
+            ownerTeamId?: string | null | undefined;
+            lastReconciledAt?: string | null | undefined;
+            version?: number | undefined;
+            repositoryId: string | undefined;
+            observedRevision: string | null | undefined;
+        } | null | undefined;
+        retryable: boolean;
+        errorCode?: string | null | undefined;
+        errorMessage?: string | null | undefined;
+        clientRequestId?: string | null | undefined;
+        createdAt?: string | null | undefined;
+        startedAt?: string | null | undefined;
+        updatedAt?: string | null | undefined;
+        finishedAt?: string | null | undefined;
+        completedAt?: string | null | undefined;
+    }>;
+    listRuns(options?: RepositoryRunListOptions): Promise<{
+        items: {
+            runNo: string;
+            planNo: string;
+            state: string;
+            stepCode?: string | null | undefined;
+            repository?: {
+                repositoryKey: string;
+                id?: string | undefined;
+                connectionCode: string;
+                provider?: string | null | undefined;
+                externalId?: string | null | undefined;
+                namespaceExternalId?: string | null | undefined;
+                namespacePath?: string | null | undefined;
+                name?: string | null | undefined;
+                fullName: string;
+                description?: string | null | undefined;
+                visibility?: string | null | undefined;
+                defaultBranch?: string | null | undefined;
+                lastObservedRevision?: string | null | undefined;
+                webUrl?: string | null | undefined;
+                cloneUrl?: string | null | undefined;
+                managementMode?: string | null | undefined;
+                status: string;
+                ownerTeamId?: string | null | undefined;
+                lastReconciledAt?: string | null | undefined;
+                version?: number | undefined;
+                repositoryId: string | undefined;
+                observedRevision: string | null | undefined;
+            } | null | undefined;
+            retryable: boolean;
+            errorCode?: string | null | undefined;
+            errorMessage?: string | null | undefined;
+            clientRequestId?: string | null | undefined;
+            createdAt?: string | null | undefined;
+            startedAt?: string | null | undefined;
+            updatedAt?: string | null | undefined;
+            finishedAt?: string | null | undefined;
+            completedAt?: string | null | undefined;
+        }[];
+        nextCursor: string | null;
+        hasMore: boolean;
+        total?: number | undefined;
+        page?: number | undefined;
+        size?: number | undefined;
+    }>;
+    getRun(runNo: string): Promise<{
+        runNo: string;
+        planNo: string;
+        state: string;
+        stepCode?: string | null | undefined;
+        repository?: {
+            repositoryKey: string;
+            id?: string | undefined;
+            connectionCode: string;
+            provider?: string | null | undefined;
+            externalId?: string | null | undefined;
+            namespaceExternalId?: string | null | undefined;
+            namespacePath?: string | null | undefined;
+            name?: string | null | undefined;
+            fullName: string;
+            description?: string | null | undefined;
+            visibility?: string | null | undefined;
+            defaultBranch?: string | null | undefined;
+            lastObservedRevision?: string | null | undefined;
+            webUrl?: string | null | undefined;
+            cloneUrl?: string | null | undefined;
+            managementMode?: string | null | undefined;
+            status: string;
+            ownerTeamId?: string | null | undefined;
+            lastReconciledAt?: string | null | undefined;
+            version?: number | undefined;
+            repositoryId: string | undefined;
+            observedRevision: string | null | undefined;
+        } | null | undefined;
+        retryable: boolean;
+        errorCode?: string | null | undefined;
+        errorMessage?: string | null | undefined;
+        clientRequestId?: string | null | undefined;
+        createdAt?: string | null | undefined;
+        startedAt?: string | null | undefined;
+        updatedAt?: string | null | undefined;
+        finishedAt?: string | null | undefined;
+        completedAt?: string | null | undefined;
+    }>;
+    resolveRun(clientRequestId: string): Promise<{
+        runNo: string;
+        planNo: string;
+        state: string;
+        stepCode?: string | null | undefined;
+        repository?: {
+            repositoryKey: string;
+            id?: string | undefined;
+            connectionCode: string;
+            provider?: string | null | undefined;
+            externalId?: string | null | undefined;
+            namespaceExternalId?: string | null | undefined;
+            namespacePath?: string | null | undefined;
+            name?: string | null | undefined;
+            fullName: string;
+            description?: string | null | undefined;
+            visibility?: string | null | undefined;
+            defaultBranch?: string | null | undefined;
+            lastObservedRevision?: string | null | undefined;
+            webUrl?: string | null | undefined;
+            cloneUrl?: string | null | undefined;
+            managementMode?: string | null | undefined;
+            status: string;
+            ownerTeamId?: string | null | undefined;
+            lastReconciledAt?: string | null | undefined;
+            version?: number | undefined;
+            repositoryId: string | undefined;
+            observedRevision: string | null | undefined;
+        } | null | undefined;
+        retryable: boolean;
+        errorCode?: string | null | undefined;
+        errorMessage?: string | null | undefined;
+        clientRequestId?: string | null | undefined;
+        createdAt?: string | null | undefined;
+        startedAt?: string | null | undefined;
+        updatedAt?: string | null | undefined;
+        finishedAt?: string | null | undefined;
+        completedAt?: string | null | undefined;
+    }>;
+    getEvents(runNo: string, afterSequence?: number): Promise<{
+        items: ({
+            sequence: number;
+            eventType?: string | undefined;
+            type?: string | undefined;
+            state?: string | null | undefined;
+            stepCode?: string | null | undefined;
+            message?: string | null | undefined;
+            createdAt: string;
+            details?: Record<string, unknown> | undefined;
+        } | {
+            sequenceNo: number;
+            eventType: string;
+            state?: string | null | undefined;
+            stepCode?: string | null | undefined;
+            message?: string | null | undefined;
+            errorCode?: string | null | undefined;
+            retryable?: boolean | undefined;
+            occurredAt?: string | null | undefined;
+            sequence: number;
+            type: undefined;
+            createdAt: string | null | undefined;
+        })[];
+        nextSequence: number | null;
+    }>;
+    retryRun(runNo: string): Promise<{
+        runNo: string;
+        planNo: string;
+        state: string;
+        stepCode?: string | null | undefined;
+        repository?: {
+            repositoryKey: string;
+            id?: string | undefined;
+            connectionCode: string;
+            provider?: string | null | undefined;
+            externalId?: string | null | undefined;
+            namespaceExternalId?: string | null | undefined;
+            namespacePath?: string | null | undefined;
+            name?: string | null | undefined;
+            fullName: string;
+            description?: string | null | undefined;
+            visibility?: string | null | undefined;
+            defaultBranch?: string | null | undefined;
+            lastObservedRevision?: string | null | undefined;
+            webUrl?: string | null | undefined;
+            cloneUrl?: string | null | undefined;
+            managementMode?: string | null | undefined;
+            status: string;
+            ownerTeamId?: string | null | undefined;
+            lastReconciledAt?: string | null | undefined;
+            version?: number | undefined;
+            repositoryId: string | undefined;
+            observedRevision: string | null | undefined;
+        } | null | undefined;
+        retryable: boolean;
+        errorCode?: string | null | undefined;
+        errorMessage?: string | null | undefined;
+        clientRequestId?: string | null | undefined;
+        createdAt?: string | null | undefined;
+        startedAt?: string | null | undefined;
+        updatedAt?: string | null | undefined;
+        finishedAt?: string | null | undefined;
+        completedAt?: string | null | undefined;
+    }>;
+    reconcileRun(runNo: string): Promise<{
+        runNo: string;
+        planNo: string;
+        state: string;
+        stepCode?: string | null | undefined;
+        repository?: {
+            repositoryKey: string;
+            id?: string | undefined;
+            connectionCode: string;
+            provider?: string | null | undefined;
+            externalId?: string | null | undefined;
+            namespaceExternalId?: string | null | undefined;
+            namespacePath?: string | null | undefined;
+            name?: string | null | undefined;
+            fullName: string;
+            description?: string | null | undefined;
+            visibility?: string | null | undefined;
+            defaultBranch?: string | null | undefined;
+            lastObservedRevision?: string | null | undefined;
+            webUrl?: string | null | undefined;
+            cloneUrl?: string | null | undefined;
+            managementMode?: string | null | undefined;
+            status: string;
+            ownerTeamId?: string | null | undefined;
+            lastReconciledAt?: string | null | undefined;
+            version?: number | undefined;
+            repositoryId: string | undefined;
+            observedRevision: string | null | undefined;
+        } | null | undefined;
+        retryable: boolean;
+        errorCode?: string | null | undefined;
+        errorMessage?: string | null | undefined;
+        clientRequestId?: string | null | undefined;
+        createdAt?: string | null | undefined;
+        startedAt?: string | null | undefined;
+        updatedAt?: string | null | undefined;
+        finishedAt?: string | null | undefined;
+        completedAt?: string | null | undefined;
+    }>;
+    reconcileRepository(repositoryKey: string, idempotencyKey: string): Promise<{
+        runNo: string;
+        planNo: string;
+        state: string;
+        stepCode?: string | null | undefined;
+        repository?: {
+            repositoryKey: string;
+            id?: string | undefined;
+            connectionCode: string;
+            provider?: string | null | undefined;
+            externalId?: string | null | undefined;
+            namespaceExternalId?: string | null | undefined;
+            namespacePath?: string | null | undefined;
+            name?: string | null | undefined;
+            fullName: string;
+            description?: string | null | undefined;
+            visibility?: string | null | undefined;
+            defaultBranch?: string | null | undefined;
+            lastObservedRevision?: string | null | undefined;
+            webUrl?: string | null | undefined;
+            cloneUrl?: string | null | undefined;
+            managementMode?: string | null | undefined;
+            status: string;
+            ownerTeamId?: string | null | undefined;
+            lastReconciledAt?: string | null | undefined;
+            version?: number | undefined;
+            repositoryId: string | undefined;
+            observedRevision: string | null | undefined;
+        } | null | undefined;
+        retryable: boolean;
+        errorCode?: string | null | undefined;
+        errorMessage?: string | null | undefined;
+        clientRequestId?: string | null | undefined;
+        createdAt?: string | null | undefined;
+        startedAt?: string | null | undefined;
+        updatedAt?: string | null | undefined;
+        finishedAt?: string | null | undefined;
+        completedAt?: string | null | undefined;
+    }>;
+}