@betterportal/config-manager 10.5.0 → 10.6.1

package/lib/plugins/service-betterportal-config-manager/previewEnvironmentManagement.d.ts

@@ -0,0 +1,474 @@
+import * as av from "anyvali";
+import type { Infer } from "anyvali";
+import { type CacheHints, type BetterPortalConfig, type JsonObject, type DemoScenario, type PreviewEnvironmentGroup } from "@betterportal/framework";
+export declare const ResponseSchema: av.ObjectSchema<{
+    title: av.StringSchema;
+    previewPath: av.StringSchema;
+    deploymentApiBase: av.StringSchema;
+    configTicketUrl: av.StringSchema;
+    sourceTenants: av.ArraySchema<av.ObjectSchema<{
+        id: av.StringSchema;
+        title: av.StringSchema;
+    }>>;
+    sourceApps: av.ArraySchema<av.ObjectSchema<{
+        id: av.StringSchema;
+        tenantId: av.StringSchema;
+        title: av.StringSchema;
+    }>>;
+    groups: av.ArraySchema<av.ObjectSchema<{
+        id: av.StringSchema;
+        name: av.StringSchema;
+        sourceTenantId: av.StringSchema;
+        sourceAppId: av.StringSchema;
+        sourceLabel: av.StringSchema;
+        expiresInDays: av.OptionalSchema<av.IntSchema>;
+        oidc: av.OptionalSchema<av.ObjectSchema<{
+            issuer: av.StringSchema;
+            audience: av.StringSchema;
+            jwksUri: av.StringSchema;
+            subjectPrefix: av.OptionalSchema<av.StringSchema>;
+            requiredClaimsJson: av.StringSchema;
+        }>>;
+        services: av.ArraySchema<av.ObjectSchema<{
+            serviceId: av.StringSchema;
+            title: av.StringSchema;
+            fields: av.ArraySchema<av.ObjectSchema<{
+                key: av.StringSchema;
+                title: av.StringSchema;
+                description: av.StringSchema;
+                scope: av.EnumSchema<readonly ["tenant", "app"]>;
+                secret: av.BoolSchema;
+                required: av.BoolSchema;
+                defaultValue: av.OptionalSchema<av.BaseSchema<unknown, import("@betterportal/framework").JsonValue>>;
+                control: av.OptionalSchema<av.StringSchema>;
+                options: av.ArraySchema<av.ObjectSchema<{
+                    value: av.StringSchema;
+                    label: av.StringSchema;
+                }>>;
+            }>>;
+            source: av.OptionalSchema<av.ObjectSchema<{
+                instanceId: av.StringSchema;
+                hostname: av.StringSchema;
+            }>>;
+            encryptedTenantConfig: av.StringSchema;
+            encryptedAppConfig: av.StringSchema;
+        }>>;
+        deployments: av.ArraySchema<av.ObjectSchema<{
+            id: av.StringSchema;
+            groupId: av.StringSchema;
+            key: av.StringSchema;
+            name: av.StringSchema;
+            hostname: av.StringSchema;
+            expiresInDays: av.OptionalSchema<av.IntSchema>;
+            expiresAt: av.OptionalSchema<av.StringSchema>;
+            createdAt: av.StringSchema;
+            updatedAt: av.StringSchema;
+            ready: av.BoolSchema;
+            services: av.ArraySchema<av.ObjectSchema<{
+                serviceId: av.StringSchema;
+                instanceId: av.StringSchema;
+                url: av.StringSchema;
+                lastSyncAt: av.OptionalSchema<av.StringSchema>;
+                ready: av.BoolSchema;
+            }>>;
+        }>>;
+        createdAt: av.StringSchema;
+        updatedAt: av.StringSchema;
+    }>>;
+    notice: av.OptionalSchema<av.StringSchema>;
+    error: av.OptionalSchema<av.StringSchema>;
+    issuedApiKey: av.OptionalSchema<av.StringSchema>;
+    issuedCredentials: av.ArraySchema<av.ObjectSchema<{
+        serviceId: av.StringSchema;
+        instanceId: av.StringSchema;
+        url: av.StringSchema;
+        controlPlaneUrl: av.StringSchema;
+        apiKey: av.StringSchema;
+    }>>;
+}>;
+export type ResponseData = Infer<typeof ResponseSchema>;
+export declare const title = "Preview Environments";
+export declare const description = "Manage isolated, disposable application clones for development deployments.";
+export declare const cacheHints: CacheHints;
+export declare const demoScenarios: DemoScenario<ResponseData>[];
+export declare const handleGet: import("@betterportal/framework").RouteHandler<Record<string, string>, Record<string, unknown>, Record<string, string>, Record<string, unknown>, {
+    title: string;
+    previewPath: string;
+    deploymentApiBase: string;
+    configTicketUrl: string;
+    sourceTenants: {
+        id: string;
+        title: string;
+    }[];
+    sourceApps: {
+        id: string;
+        tenantId: string;
+        title: string;
+    }[];
+    groups: {
+        id: string;
+        name: string;
+        sourceTenantId: string;
+        sourceAppId: string;
+        sourceLabel: string;
+        services: {
+            serviceId: string;
+            title: string;
+            fields: {
+                key: string;
+                title: string;
+                description: string;
+                scope: "tenant" | "app";
+                secret: boolean;
+                required: boolean;
+                options: {
+                    value: string;
+                    label: string;
+                }[];
+                defaultValue?: import("@betterportal/framework").JsonValue | undefined;
+                control?: string | undefined;
+            }[];
+            encryptedTenantConfig: string;
+            encryptedAppConfig: string;
+            source?: {
+                instanceId: string;
+                hostname: string;
+            } | undefined;
+        }[];
+        deployments: {
+            id: string;
+            groupId: string;
+            key: string;
+            name: string;
+            hostname: string;
+            createdAt: string;
+            updatedAt: string;
+            ready: boolean;
+            services: {
+                serviceId: string;
+                instanceId: string;
+                url: string;
+                ready: boolean;
+                lastSyncAt?: string | undefined;
+            }[];
+            expiresInDays?: number | undefined;
+            expiresAt?: string | undefined;
+        }[];
+        createdAt: string;
+        updatedAt: string;
+        expiresInDays?: number | undefined;
+        oidc?: {
+            issuer: string;
+            audience: string;
+            jwksUri: string;
+            requiredClaimsJson: string;
+            subjectPrefix?: string | undefined;
+        } | undefined;
+    }[];
+    issuedCredentials: {
+        serviceId: string;
+        instanceId: string;
+        url: string;
+        controlPlaneUrl: string;
+        apiKey: string;
+    }[];
+    notice?: string | undefined;
+    error?: string | undefined;
+    issuedApiKey?: string | undefined;
+}, never, Record<string, unknown>>;
+export declare const handlePost: import("@betterportal/framework").RouteHandler<Record<string, string>, Record<string, unknown>, Record<string, string>, Record<string, unknown>, {
+    title: string;
+    previewPath: string;
+    deploymentApiBase: string;
+    configTicketUrl: string;
+    sourceTenants: {
+        id: string;
+        title: string;
+    }[];
+    sourceApps: {
+        id: string;
+        tenantId: string;
+        title: string;
+    }[];
+    groups: {
+        id: string;
+        name: string;
+        sourceTenantId: string;
+        sourceAppId: string;
+        sourceLabel: string;
+        services: {
+            serviceId: string;
+            title: string;
+            fields: {
+                key: string;
+                title: string;
+                description: string;
+                scope: "tenant" | "app";
+                secret: boolean;
+                required: boolean;
+                options: {
+                    value: string;
+                    label: string;
+                }[];
+                defaultValue?: import("@betterportal/framework").JsonValue | undefined;
+                control?: string | undefined;
+            }[];
+            encryptedTenantConfig: string;
+            encryptedAppConfig: string;
+            source?: {
+                instanceId: string;
+                hostname: string;
+            } | undefined;
+        }[];
+        deployments: {
+            id: string;
+            groupId: string;
+            key: string;
+            name: string;
+            hostname: string;
+            createdAt: string;
+            updatedAt: string;
+            ready: boolean;
+            services: {
+                serviceId: string;
+                instanceId: string;
+                url: string;
+                ready: boolean;
+                lastSyncAt?: string | undefined;
+            }[];
+            expiresInDays?: number | undefined;
+            expiresAt?: string | undefined;
+        }[];
+        createdAt: string;
+        updatedAt: string;
+        expiresInDays?: number | undefined;
+        oidc?: {
+            issuer: string;
+            audience: string;
+            jwksUri: string;
+            requiredClaimsJson: string;
+            subjectPrefix?: string | undefined;
+        } | undefined;
+    }[];
+    issuedCredentials: {
+        serviceId: string;
+        instanceId: string;
+        url: string;
+        controlPlaneUrl: string;
+        apiKey: string;
+    }[];
+    notice?: string | undefined;
+    error?: string | undefined;
+    issuedApiKey?: string | undefined;
+}, never, Record<string, unknown>>;
+export declare const handlePut: import("@betterportal/framework").RouteHandler<Record<string, string>, Record<string, unknown>, Record<string, string>, Record<string, unknown>, {
+    title: string;
+    previewPath: string;
+    deploymentApiBase: string;
+    configTicketUrl: string;
+    sourceTenants: {
+        id: string;
+        title: string;
+    }[];
+    sourceApps: {
+        id: string;
+        tenantId: string;
+        title: string;
+    }[];
+    groups: {
+        id: string;
+        name: string;
+        sourceTenantId: string;
+        sourceAppId: string;
+        sourceLabel: string;
+        services: {
+            serviceId: string;
+            title: string;
+            fields: {
+                key: string;
+                title: string;
+                description: string;
+                scope: "tenant" | "app";
+                secret: boolean;
+                required: boolean;
+                options: {
+                    value: string;
+                    label: string;
+                }[];
+                defaultValue?: import("@betterportal/framework").JsonValue | undefined;
+                control?: string | undefined;
+            }[];
+            encryptedTenantConfig: string;
+            encryptedAppConfig: string;
+            source?: {
+                instanceId: string;
+                hostname: string;
+            } | undefined;
+        }[];
+        deployments: {
+            id: string;
+            groupId: string;
+            key: string;
+            name: string;
+            hostname: string;
+            createdAt: string;
+            updatedAt: string;
+            ready: boolean;
+            services: {
+                serviceId: string;
+                instanceId: string;
+                url: string;
+                ready: boolean;
+                lastSyncAt?: string | undefined;
+            }[];
+            expiresInDays?: number | undefined;
+            expiresAt?: string | undefined;
+        }[];
+        createdAt: string;
+        updatedAt: string;
+        expiresInDays?: number | undefined;
+        oidc?: {
+            issuer: string;
+            audience: string;
+            jwksUri: string;
+            requiredClaimsJson: string;
+            subjectPrefix?: string | undefined;
+        } | undefined;
+    }[];
+    issuedCredentials: {
+        serviceId: string;
+        instanceId: string;
+        url: string;
+        controlPlaneUrl: string;
+        apiKey: string;
+    }[];
+    notice?: string | undefined;
+    error?: string | undefined;
+    issuedApiKey?: string | undefined;
+}, never, Record<string, unknown>>;
+export declare const handleDelete: import("@betterportal/framework").RouteHandler<Record<string, string>, Record<string, unknown>, Record<string, string>, Record<string, unknown>, {
+    title: string;
+    previewPath: string;
+    deploymentApiBase: string;
+    configTicketUrl: string;
+    sourceTenants: {
+        id: string;
+        title: string;
+    }[];
+    sourceApps: {
+        id: string;
+        tenantId: string;
+        title: string;
+    }[];
+    groups: {
+        id: string;
+        name: string;
+        sourceTenantId: string;
+        sourceAppId: string;
+        sourceLabel: string;
+        services: {
+            serviceId: string;
+            title: string;
+            fields: {
+                key: string;
+                title: string;
+                description: string;
+                scope: "tenant" | "app";
+                secret: boolean;
+                required: boolean;
+                options: {
+                    value: string;
+                    label: string;
+                }[];
+                defaultValue?: import("@betterportal/framework").JsonValue | undefined;
+                control?: string | undefined;
+            }[];
+            encryptedTenantConfig: string;
+            encryptedAppConfig: string;
+            source?: {
+                instanceId: string;
+                hostname: string;
+            } | undefined;
+        }[];
+        deployments: {
+            id: string;
+            groupId: string;
+            key: string;
+            name: string;
+            hostname: string;
+            createdAt: string;
+            updatedAt: string;
+            ready: boolean;
+            services: {
+                serviceId: string;
+                instanceId: string;
+                url: string;
+                ready: boolean;
+                lastSyncAt?: string | undefined;
+            }[];
+            expiresInDays?: number | undefined;
+            expiresAt?: string | undefined;
+        }[];
+        createdAt: string;
+        updatedAt: string;
+        expiresInDays?: number | undefined;
+        oidc?: {
+            issuer: string;
+            audience: string;
+            jwksUri: string;
+            requiredClaimsJson: string;
+            subjectPrefix?: string | undefined;
+        } | undefined;
+    }[];
+    issuedCredentials: {
+        serviceId: string;
+        instanceId: string;
+        url: string;
+        controlPlaneUrl: string;
+        apiKey: string;
+    }[];
+    notice?: string | undefined;
+    error?: string | undefined;
+    issuedApiKey?: string | undefined;
+}, never, Record<string, unknown>>;
+export declare function resolvePreviewConfigSchemas(config: BetterPortalConfig, group: PreviewEnvironmentGroup, serviceId: string): {
+    id: string;
+    title: string;
+    description: string;
+    scope: "tenant" | "app";
+    jsonSchema: JsonObject;
+    fields: {
+        key: string;
+        title: string;
+        description: string;
+        scope: "tenant" | "app";
+        visibility: "public" | "protected" | "secret";
+        ownership: "bp" | "plugin" | "mixed";
+        sourceOfTruth: "bp" | "plugin" | "external";
+        required: boolean;
+        groupId?: string | undefined;
+        order?: number | undefined;
+        defaultValue?: import("@betterportal/framework").JsonValue | undefined;
+        ui?: {
+            control?: "number" | "email" | "text" | "url" | "date" | "textarea" | "password" | "checkbox" | "select" | "multiselect" | "color" | "time" | "datetime-local" | undefined;
+            placeholder?: string | undefined;
+            options?: {
+                value: string;
+                label: string;
+            }[] | undefined;
+            optionsSource?: "app.routes" | undefined;
+            min?: string | number | undefined;
+            max?: string | number | undefined;
+            step?: number | undefined;
+            rows?: number | undefined;
+        } | undefined;
+    }[];
+    groups?: {
+        id: string;
+        title: string;
+        description?: string | undefined;
+        order?: number | undefined;
+        optional?: boolean | undefined;
+    }[] | undefined;
+}[] | undefined;
+//# sourceMappingURL=previewEnvironmentManagement.d.ts.map

package/lib/plugins/service-betterportal-config-manager/previewEnvironmentManagement.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"previewEnvironmentManagement.d.ts","sourceRoot":"","sources":["../../../src/plugins/service-betterportal-config-manager/previewEnvironmentManagement.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,SAAS,CAAC;AAC9B,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAIL,KAAK,UAAU,EACf,KAAK,kBAAkB,EACvB,KAAK,UAAU,EACf,KAAK,YAAY,EACjB,KAAK,uBAAuB,EAE7B,MAAM,yBAAyB,CAAC;AAsGjC,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAYzB,CAAC;AACH,MAAM,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,cAAc,CAAC,CAAC;AAExD,eAAO,MAAM,KAAK,yBAAyB,CAAC;AAC5C,eAAO,MAAM,WAAW,gFAAgF,CAAC;AACzG,eAAO,MAAM,UAAU,EAAE,UAA4D,CAAC;AACtF,eAAO,MAAM,aAAa,EAAE,YAAY,CAAC,YAAY,CAAC,EAapD,CAAC;AAEH,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kCAGrB,CAAC;AAEF,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kCAgDtB,CAAC;AAEF,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kCAyBrB,CAAC;AAEF,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;kCAYxB,CAAC;AAyMF,wBAAgB,2BAA2B,CAAC,MAAM,EAAE,kBAAkB,EAAE,KAAK,EAAE,uBAAuB,EAAE,SAAS,EAAE,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;gBAaxH"}