@camunda/ccma-shared-types 0.0.1

package/dist/types/ConsoleSelfManaged.type.js

@@ -0,0 +1,93 @@
+var ConsoleSM;
+((ConsoleSM2) => {
+  ConsoleSM2.CONFIG_UNSET = "unset";
+  function NameByAppType(appType) {
+    switch (appType) {
+      case "zeebe-broker":
+        return "Zeebe";
+      case "zeebe-gateway":
+        return "Zeebe Gateway";
+      case "operate":
+        return "Operate";
+      case "tasklist":
+        return "Tasklist";
+      case "optimize":
+        return "Optimize";
+      case "modeler":
+        return "Modeler";
+      case "console":
+        return "Console";
+      case "identity":
+        return "Identity";
+      case "connectors":
+        return "Connectors";
+      case "orchestration":
+        return "Orchestration";
+      case "orchestrationIdentity":
+        return "Identity";
+      default:
+        return "Unknown";
+    }
+  }
+  ConsoleSM2.NameByAppType = NameByAppType;
+  ConsoleSM2.FataErrorDescriptions = {
+    "configmap-not-found": {
+      message: "Failed to read file with configmap data",
+      fatal: true
+    },
+    "api-token-unset": {
+      message: "Telemetry API token not set",
+      fatal: false
+    },
+    "api-token-unauthorized": {
+      message: "Telemetry API token unauthorized",
+      fatal: false
+    },
+    "customer-context-unset": {
+      message: "Customer Id or Installation Id not set",
+      fatal: false
+    },
+    "automation-clusters-unset": {
+      message: "No automation clusters found",
+      fatal: false
+    },
+    "management-cluster-unset": {
+      message: "No management cluster found",
+      fatal: false
+    },
+    "jwks-not-reachable": {
+      message: "JWKS for authentication is not reachable",
+      fatal: true
+    },
+    "backend-error": {
+      message: "Backend error",
+      fatal: true
+    },
+    "auth-config-incomplete": {
+      message: "Auth Config incomplete. Please make sure to set all required values.",
+      fatal: true
+    },
+    "mobx-error": {
+      message: "Something went wrong with object assignments.",
+      fatal: false
+    }
+  };
+  let Health;
+  ((Health2) => {
+    let EndpointSource;
+    ((EndpointSource2) => {
+      EndpointSource2["CONFIG_OR_ENV"] = "Extra Values or Environment Variables";
+      EndpointSource2["CONFIGMAP"] = "ConfigMap";
+    })(EndpointSource = Health2.EndpointSource || (Health2.EndpointSource = {}));
+    let TEAM;
+    ((TEAM2) => {
+      TEAM2["UNSET"] = "U";
+      TEAM2["CONSOLE"] = "C";
+      TEAM2["DISTRIBUTION"] = "D";
+    })(TEAM = Health2.TEAM || (Health2.TEAM = {}));
+  })(Health = ConsoleSM2.Health || (ConsoleSM2.Health = {}));
+})(ConsoleSM || (ConsoleSM = {}));
+export {
+  ConsoleSM
+};
+//# sourceMappingURL=ConsoleSelfManaged.type.js.map

package/dist/types/ConsoleSelfManaged.type.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/types/ConsoleSelfManaged.type.ts"],
+  "sourcesContent": ["/*\n * Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH\n * under one or more contributor license agreements. Licensed under a commercial license.\n * You may not use this file except in compliance with the commercial license.\n */\n\nexport namespace ConsoleSM {\n  export const CONFIG_UNSET = 'unset'\n  export type Status = 'healthy' | 'unhealthy' | 'unknown'\n\n  export type AppType =\n    | 'zeebe-broker'\n    | 'zeebe-gateway'\n    | 'operate'\n    | 'tasklist'\n    | 'optimize'\n    | 'modeler'\n    | 'console'\n    | 'identity'\n    | 'connectors'\n    | 'orchestration'\n    | 'orchestrationIdentity'\n    | 'unknown'\n\n  export function NameByAppType(appType: AppType): string {\n    switch (appType) {\n      case 'zeebe-broker':\n        return 'Zeebe'\n      case 'zeebe-gateway':\n        return 'Zeebe Gateway'\n      case 'operate':\n        return 'Operate'\n      case 'tasklist':\n        return 'Tasklist'\n      case 'optimize':\n        return 'Optimize'\n      case 'modeler':\n        return 'Modeler'\n      case 'console':\n        return 'Console'\n      case 'identity':\n        return 'Identity'\n      case 'connectors':\n        return 'Connectors'\n      case 'orchestration':\n        return 'Orchestration'\n      case 'orchestrationIdentity':\n        return 'Identity'\n      default:\n        return 'Unknown'\n    }\n  }\n\n  export type ClusterType = 'automation' | 'management'\n\n  export interface App {\n    type: AppType\n    id: string\n    status: Status\n    url: string\n    urls?: {\n      grpc: string\n      http: string\n    }\n    generation: string\n    readiness?: string\n    metrics?: string\n  }\n\n  export interface CamundaLicense {\n    validLicense: boolean\n    licenseType: string\n    isCommercial?: boolean\n    expiresAt?: string\n  }\n\n  export interface DiscoveredCluster {\n    license: CamundaLicense\n    clusterId: string\n    clusterName: string\n    version: string\n    properties?: Record<string, string>\n  }\n\n  export interface Cluster {\n    /**\n     * Unique identifier of the cluster\n     */\n    uuid: string\n    /**\n     * Name of the cluster\n     */\n    name: string\n    /**\n     * Tags of the cluster, example: dev, stage, prod\n     */\n    tags?: string[]\n    /**\n     * Custom properties of the cluster\n     */\n    customProperties?: Array<{\n      description?: string\n      links?: Array<{\n        name?: string\n        url?: string\n      }>\n    }>\n    /**\n     * Namespace the cluster is running in.\n     */\n    namespace: string\n    /**\n     * Indicates if a cluster is healthy or not\n     */\n    status: Status\n    /**\n     * This is the current version of the running cluster\n     */\n    generation: string\n    /**\n     * We're distinguishing between automation and management clusters. Management clusters include applications that act globally in an installed context, like Console or Modeler. Automation clusters are the Zeebe clusters including applications like Operate, Tasklist and Optimize.\n     */\n    type: ClusterType\n    /**\n     * The list of applications running in the cluster\n     */\n    apps: App[]\n    /**\n     * audit events of the cluster\n     */\n    audit?: Array<{\n      ts: number\n    }>\n    /**\n     * Custom properties added by the discovery process.\n     */\n    discoveredClusterProperties?: Record<string, string>\n    /**\n     * The cluster license information\n     */\n    license?: CamundaLicense\n  }\n\n  export type TelemetryState = 'disabled' | 'online' | 'download'\n  export type LicanseState = 'disabled' | 'valid' | 'invalid'\n\n  export interface AppConfig {\n    auth: {\n      clientId: string\n      audience: string\n      issuer: string\n      type: string\n      disabled: boolean\n      redirectTrailingSlash: boolean\n      redirectUrl: string\n      resource?: string\n    }\n    customerContext: {\n      customerId: string\n      installationId: string\n      telemetry: TelemetryState\n      license: LicanseState\n      isCommercial: boolean\n      expiresAt: number | undefined\n      discoveryModeEnabled: boolean\n      jobDashboardEnabled: boolean\n    }\n    fatalErrors: FatalError[]\n  }\n\n  export interface UsageMetrics {\n    total: number\n  }\n\n  export interface UsageMetricsInstances extends UsageMetrics {}\n\n  export interface UsageMetricsTaskUsers extends UsageMetrics {\n    assignees: string[]\n  }\n\n  export interface UsageMetricsForCluster {\n    id: string\n    processInstances: UsageMetricsInstances\n    decisionInstances: UsageMetricsInstances\n    taskUsers: UsageMetricsTaskUsers\n    activeTenants?: UsageMetricsInstances\n  }\n\n  // CONFIG PARAMS\n\n  export interface ConfigParams {\n    csm_context_path: string\n  }\n\n  // SSE\n\n  export interface SendEventOptions<T> {\n    type: 'status' | 'keepalive' | 'cluster-update'\n    payload: T\n  }\n\n  export interface SseKeepAlivePayload {\n    keepAlive: boolean\n  }\n\n  // Fatal Errors\n\n  export type FatalErrorType =\n    | 'configmap-not-found'\n    | 'api-token-unauthorized'\n    | 'api-token-unset'\n    | 'customer-context-unset'\n    | 'automation-clusters-unset'\n    | 'management-cluster-unset'\n    | 'jwks-not-reachable'\n    | 'backend-error'\n    | 'auth-config-incomplete'\n    | 'mobx-error'\n\n  export const FataErrorDescriptions: Record<\n    FatalErrorType,\n    { message: string; fatal: boolean }\n  > = {\n    'configmap-not-found': {\n      message: 'Failed to read file with configmap data',\n      fatal: true,\n    },\n    'api-token-unset': {\n      message: 'Telemetry API token not set',\n      fatal: false,\n    },\n    'api-token-unauthorized': {\n      message: 'Telemetry API token unauthorized',\n      fatal: false,\n    },\n    'customer-context-unset': {\n      message: 'Customer Id or Installation Id not set',\n      fatal: false,\n    },\n    'automation-clusters-unset': {\n      message: 'No automation clusters found',\n      fatal: false,\n    },\n    'management-cluster-unset': {\n      message: 'No management cluster found',\n      fatal: false,\n    },\n    'jwks-not-reachable': {\n      message: 'JWKS for authentication is not reachable',\n      fatal: true,\n    },\n    'backend-error': {\n      message: 'Backend error',\n      fatal: true,\n    },\n    'auth-config-incomplete': {\n      message:\n        'Auth Config incomplete. Please make sure to set all required values.',\n      fatal: true,\n    },\n    'mobx-error': {\n      message: 'Something went wrong with object assignments.',\n      fatal: false,\n    },\n  }\n\n  export interface FatalError {\n    type: FatalErrorType\n    message: string\n    ts: number\n    fatal: boolean\n    count: number\n  }\n\n  // DEBUG\n\n  export interface DebugData {\n    configmap: string\n    configmapOverride?: string\n    envvars: Array<{ key: string; value: string }>\n  }\n\n  // ///////////////////////////////////////////////////////////////////////////7\n  // HEALTH CHECK\n\n  export namespace Health {\n    // eslint-disable-next-line no-shadow\n    export enum EndpointSource {\n      CONFIG_OR_ENV = 'Extra Values or Environment Variables',\n      CONFIGMAP = 'ConfigMap',\n    }\n\n    // eslint-disable-next-line no-shadow\n    export enum TEAM {\n      UNSET = 'U',\n      CONSOLE = 'C',\n      DISTRIBUTION = 'D',\n    }\n\n    interface BaseContext {\n      type: 'endpoint' | 'configuration'\n      team: TEAM\n    }\n\n    export interface Endpoint extends BaseContext {\n      type: 'endpoint'\n      name: string\n      url: string\n      source: EndpointSource\n      method?: 'post'\n      ignore?: boolean\n    }\n\n    export interface Configuration extends BaseContext {\n      type: 'configuration'\n      source: string\n    }\n\n    export type Context = Endpoint | Configuration\n\n    export interface Result {\n      problemIdentitfied: boolean\n      message: string\n      context: Context\n      ts?: number\n    }\n\n    export interface HealthCheck {\n      ts: number\n      results: Result[]\n    }\n  }\n}\n"],
+  "mappings": "AAMO,IAAU;AAAA,CAAV,CAAUA,eAAV;AACE,EAAMA,WAAA,eAAe;AAiBrB,WAAS,cAAc,SAA0B;AACtD,YAAQ,SAAS;AAAA,MACf,KAAK;AACH,eAAO;AAAA,MACT,KAAK;AACH,eAAO;AAAA,MACT,KAAK;AACH,eAAO;AAAA,MACT,KAAK;AACH,eAAO;AAAA,MACT,KAAK;AACH,eAAO;AAAA,MACT,KAAK;AACH,eAAO;AAAA,MACT,KAAK;AACH,eAAO;AAAA,MACT,KAAK;AACH,eAAO;AAAA,MACT,KAAK;AACH,eAAO;AAAA,MACT,KAAK;AACH,eAAO;AAAA,MACT,KAAK;AACH,eAAO;AAAA,MACT;AACE,eAAO;AAAA,IACX;AAAA,EACF;AA3BO,EAAAA,WAAS;AAmMT,EAAMA,WAAA,wBAGT;AAAA,IACF,uBAAuB;AAAA,MACrB,SAAS;AAAA,MACT,OAAO;AAAA,IACT;AAAA,IACA,mBAAmB;AAAA,MACjB,SAAS;AAAA,MACT,OAAO;AAAA,IACT;AAAA,IACA,0BAA0B;AAAA,MACxB,SAAS;AAAA,MACT,OAAO;AAAA,IACT;AAAA,IACA,0BAA0B;AAAA,MACxB,SAAS;AAAA,MACT,OAAO;AAAA,IACT;AAAA,IACA,6BAA6B;AAAA,MAC3B,SAAS;AAAA,MACT,OAAO;AAAA,IACT;AAAA,IACA,4BAA4B;AAAA,MAC1B,SAAS;AAAA,MACT,OAAO;AAAA,IACT;AAAA,IACA,sBAAsB;AAAA,MACpB,SAAS;AAAA,MACT,OAAO;AAAA,IACT;AAAA,IACA,iBAAiB;AAAA,MACf,SAAS;AAAA,MACT,OAAO;AAAA,IACT;AAAA,IACA,0BAA0B;AAAA,MACxB,SACE;AAAA,MACF,OAAO;AAAA,IACT;AAAA,IACA,cAAc;AAAA,MACZ,SAAS;AAAA,MACT,OAAO;AAAA,IACT;AAAA,EACF;AAqBO,MAAU;AAAV,IAAUC,YAAV;AAEE,QAAK;AAAL,MAAKC,oBAAL;AACL,MAAAA,gBAAA,mBAAgB;AAChB,MAAAA,gBAAA,eAAY;AAAA,OAFF,iBAAAD,QAAA,mBAAAA,QAAA;AAML,QAAK;AAAL,MAAKE,UAAL;AACL,MAAAA,MAAA,WAAQ;AACR,MAAAA,MAAA,aAAU;AACV,MAAAA,MAAA,kBAAe;AAAA,OAHL,OAAAF,QAAA,SAAAA,QAAA;AAAA,KARG,SAAAD,WAAA,WAAAA,WAAA;AAAA,GAvRF;",
+  "names": ["ConsoleSM", "Health", "EndpointSource", "TEAM"]
+}

package/dist/types/ConsoleSelfManagedAdminApi.type.d.ts

@@ -0,0 +1,111 @@
+export declare namespace ConsoleSMAdminApi {
+    type Status = 'healthy' | 'unhealthy' | 'unknown';
+    type AppType = 'zeebe-broker' | 'zeebe-gateway' | 'operate' | 'tasklist' | 'optimize' | 'modeler' | 'console' | 'identity' | 'unknown';
+    type ClusterType = 'automation' | 'management';
+    interface App {
+        /**
+         * What application is running in the cluster, like Zeebe, Operate, Tasklist, ...
+         */
+        type: AppType;
+        /**
+         * Unique identifier of the application
+         */
+        id: string;
+        /**
+         * Indicates if an application is healthy or not
+         */
+        status: Status;
+        /**
+         * The public URL of the application
+         */
+        url: string;
+        /**
+         * This is the current version of the running application
+         */
+        generation: string;
+        /**
+         * The readiness URL of the application
+         */
+        readiness?: string;
+        /**
+         * The metrics URL of the application
+         */
+        metrics?: string;
+    }
+    interface Cluster {
+        /**
+         * Unique identifier of the cluster
+         */
+        uuid: string;
+        /**
+         * Name of the cluster
+         */
+        name: string;
+        /**
+         * Tags of the cluster, example: dev, stage, prod
+         */
+        tags?: string[];
+        /**
+         * Custom properties of the cluster
+         */
+        customProperties?: Array<{
+            description?: string;
+            links?: Array<{
+                name?: string;
+                url?: string;
+            }>;
+        }>;
+        /**
+         * Namespace the cluster is running in.
+         */
+        namespace: string;
+        /**
+         * Indicates if a cluster is healthy or not
+         */
+        status: Status;
+        /**
+         * This is the current version of the running cluster
+         */
+        generation: string;
+        /**
+         * We're distinguishing between automation and management clusters. Management clusters include applications that act globally in an installed context, like Console or Modeler. Automation clusters are the Zeebe clusters including applications like Operate, Tasklist and Optimize.
+         */
+        type: ClusterType;
+        /**
+         * The list of applications running in the cluster
+         */
+        apps: App[];
+    }
+    interface UsageMetrics {
+        /**
+         * The number of usage metrics for a specific type.
+         */
+        total: number;
+    }
+    interface UsageMetricsInstances extends UsageMetrics {
+    }
+    interface UsageMetricsTaskUsers extends UsageMetrics {
+        /**
+         * The users that tasks have been assigned to.
+         */
+        assignees: string[];
+    }
+    interface UsageMetricsForCluster {
+        /**
+         * The identifier of the cluster.
+         */
+        id: string;
+        /**
+         * The usage metrics for started process instances.
+         */
+        processInstances: UsageMetricsInstances;
+        /**
+         * The usage metrics for executed decision instances.
+         */
+        decisionInstances: UsageMetricsInstances;
+        /**
+         * The usage metrics for assigned task users.
+         */
+        taskUsers: UsageMetricsTaskUsers;
+    }
+}

package/dist/types/ConsoleSelfManagedAdminApi.type.js

@@ -0,0 +1 @@
+//# sourceMappingURL=ConsoleSelfManagedAdminApi.type.js.map

package/dist/types/ConsoleSelfManagedAdminApi.type.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": [],
+  "sourcesContent": [],
+  "mappings": "",
+  "names": []
+}

package/dist/types/Dashboard.types.d.ts

@@ -0,0 +1,23 @@
+export type DashboardMappingTarget = 'group' | 'key' | 'value';
+export interface DashboardMappingItem {
+    source: string;
+    target: DashboardMappingTarget;
+}
+export type DashboardResultPrimitive = string | number | boolean | undefined;
+export type DashboardResultRow = Record<string, DashboardResultPrimitive>;
+export interface DashboardConfig {
+    tab: string;
+    title: string;
+    source: string;
+    chartType: 'line' | 'bar' | 'alluvial';
+    xAxisTitle: string;
+    yAxisTitle: string;
+    stacked?: boolean;
+    dataSource: {
+        type: 'hdp-sql' | 'data';
+        query?: string;
+    };
+    mapping: DashboardMappingItem[];
+    result?: DashboardResultRow[];
+}
+export type EngineeringOperationsDashboardResponse = DashboardConfig[];

package/dist/types/Dashboard.types.js

@@ -0,0 +1 @@
+//# sourceMappingURL=Dashboard.types.js.map

package/dist/types/Dashboard.types.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": [],
+  "sourcesContent": [],
+  "mappings": "",
+  "names": []
+}

package/dist/types/EnterpriseIncludingValueMetrics.type.d.ts

@@ -0,0 +1,5 @@
+export interface EnterpriseIncludingValueMetrics {
+    processInstances: number;
+    taskUsers: number;
+    decisionInstances: number;
+}

package/dist/types/EnterpriseIncludingValueMetrics.type.js

@@ -0,0 +1 @@
+//# sourceMappingURL=EnterpriseIncludingValueMetrics.type.js.map

package/dist/types/EnterpriseIncludingValueMetrics.type.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": [],
+  "sourcesContent": [],
+  "mappings": "",
+  "names": []
+}

package/dist/types/OrganizationPermission.type.d.ts

@@ -0,0 +1,64 @@
+import { OrganizationRole } from '../enums/OrganizationRole.enum.js';
+export interface CreateReadUpdateDelete {
+    create: boolean;
+    read: boolean;
+    update: boolean;
+    delete: boolean;
+}
+export interface CreateReadUpdateDeleteDescriptions {
+    create: string;
+    read: string;
+    update: string;
+    delete: string;
+}
+export interface OrganizationPermissionsInternal<T> {
+    org: {
+        clusters: T;
+        clients: T;
+        settings: T;
+        usage: T;
+        billing: T;
+        users: {
+            general: T;
+            owner: T;
+            admin: T;
+            member: T;
+        };
+        activity: T;
+        diagrams: T;
+        forms: T;
+        instances: T;
+        workflows: T;
+        webide: T;
+        earlyAccessFeatures: T;
+    };
+    cluster: {
+        clients: T;
+        alerts: T;
+        operate: T;
+        tasklist: T;
+        optimize: T;
+        identity: T;
+        ipWhitelist: T;
+        secureConnectivity: T;
+        encryption: T;
+        connectorSecrets: T;
+        connectors: T;
+        settings: {
+            resourceBasedAuthorizations: {
+                activate: T;
+                configure: T;
+            };
+            identityBasedAuthorizations: {
+                activate: T;
+            };
+            multiTenancy: {
+                activate: T;
+            };
+        };
+    };
+}
+export interface OrganizationPermissions extends OrganizationPermissionsInternal<CreateReadUpdateDelete> {
+}
+export declare const OrganizationPermissionsDescriptions: OrganizationPermissionsInternal<CreateReadUpdateDeleteDescriptions>;
+export declare const PermissionsForOrganizationRole: Map<OrganizationRole, OrganizationPermissions>;