@alauda-fe/dynamic-plugin-shared 0.0.1-alpha.0

package/types/common.d.ts

@@ -0,0 +1,42 @@
+/**
+ * @packageDocumentation
+ * @module types
+ */
+export type StringMap = Record<string, string>;
+export interface Environments {
+    GLOBAL_NAMESPACE?: string;
+    LABEL_BASE_DOMAIN?: string;
+    LOGO_URL?: string;
+    INNER_PROJECT_NS_PREFIX?: string;
+    CPAAS_SESSION_SWITCH?: 'on' | 'off';
+    CLOSE_BROWSER_END_SESSION?: string;
+    CURRENT_STATE?: 'Active' | 'Standby';
+}
+export type KeyValue<V = string, T extends object = object> = T & {
+    key: string;
+    value: V;
+};
+export interface ResourceListParams extends StringMap {
+    limit?: string;
+    continue?: string;
+    labelSelector?: string;
+    fieldSelector?: string;
+    field?: string;
+    keyword?: string;
+}
+export interface WorkspaceParams {
+    project?: string;
+    cluster?: string;
+    namespace?: string;
+}
+export interface WorkspaceListParams extends WorkspaceParams, ResourceListParams {
+}
+export interface WorkspaceDetailParams extends WorkspaceListParams {
+    name?: string;
+}
+export type Pagination<T, O = {
+    [key: string]: unknown;
+}> = {
+    total: number;
+    items: T[];
+} & O;

package/types/helpers.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @packageDocumentation
+ * @module types
+ */
+import { Observable } from 'rxjs';
+import { Primitive } from 'ts-essentials';
+export { DeepPartial, DeepReadonly, Dictionary, ValueOf as LooseValueOf, } from 'ts-essentials';
+export type Readonlyable<T> = T | Readonly<T>;
+export type AnyArray<T> = Readonlyable<T[]>;
+export type Arrayable<T, R extends boolean = false> = [R] extends [never] ? T | T[] : R extends true ? Readonly<T> | readonly T[] : R extends false ? Readonlyable<T> | AnyArray<T> : never;
+export type Nullable<T> = T | null | undefined;
+export type Callback<T extends any[] = unknown[], R = unknown> = (...args: T) => R;
+/** Dark magic helper */
+export type IfEqual<X, Y, A = X, B = never> = (<T>() => T extends X ? true : false) extends <T>() => T extends Y ? true : false ? A : B;
+export type Keys<T> = {
+    [Key in keyof T]: Key;
+};
+export type ObservableType<T> = T extends Observable<infer R> ? R : never;
+export type UnaryObservableFunction<T, R> = (source: Observable<T>) => Observable<R>;
+export type ValueOf<T> = T extends {
+    [key: string]: infer M;
+} ? M : T extends {
+    [key: number]: infer N;
+} ? N : never;
+export declare function isErrorMessage<T extends {
+    message: string;
+}>(error: any): error is T;
+export type LiteralUnion<LiteralType, BaseType extends Primitive> = LiteralType | (BaseType & {
+    _?: never;
+});
+export declare const DataSource: {
+    readonly Platform: "Platform";
+    readonly Business: "Business";
+};
+export type DataSource = ValueOf<typeof DataSource>;

package/types/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @packageDocumentation
+ * @module types
+ * @preferred
+ */
+export * from './common';
+export * from './helpers';
+export * from './k8s';

package/types/k8s/core.d.ts

@@ -0,0 +1,100 @@
+import { StringMap } from '../common';
+/**
+ * 维护 k8s core 类型，比如 metaType，Condition，ownerRef 等等，
+ * 这里的类型基本是具体类型都依赖的基础类型。大大概率不会变化的
+ */
+export type LimitType = 'Container' | 'Pod' | 'PersistentVolumeClaim';
+export interface LimitRangeSpec extends KubernetesResource {
+    limits: LimitRangeItem[];
+}
+export interface LimitRange extends KubernetesResource {
+    spec?: LimitRangeSpec;
+}
+export interface LimitRangeItem {
+    type: LimitType;
+    min?: StringMap;
+    max?: StringMap;
+    default?: StringMap;
+    defaultRequest?: StringMap;
+    maxLimitRequestRatio?: StringMap;
+}
+export interface ObjectReference {
+    kind?: string;
+    namespace?: string;
+    name?: string;
+    uid?: string;
+    apiVersion?: string;
+    resourceVersion?: string;
+    fieldPath?: string;
+}
+export interface LabelSelector {
+    matchLabels?: StringMap;
+    matchExpressions?: LabelSelectorRequirement[];
+}
+export interface LabelSelectorRequirement {
+    key: string;
+    operator?: '=' | '==' | '!=' | '!' | 'in' | 'notin' | 'exists' | 'doesnotexist' | 'In';
+    values?: string[];
+}
+export interface TypeMeta {
+    kind?: string;
+    apiVersion?: string;
+}
+export interface OwnerReference {
+    apiVersion: string;
+    kind: string;
+    name: string;
+    uid: string;
+    controller?: boolean;
+    blockOwnerDeletion?: boolean;
+}
+export interface ObjectMeta {
+    name?: string;
+    generateName?: string;
+    namespace?: string;
+    labels?: StringMap;
+    annotations?: StringMap;
+    finalizers?: string[];
+    selfLink?: string;
+    uid?: string;
+    creationTimestamp?: string;
+    deletionTimestamp?: string;
+    ownerReferences?: OwnerReference[];
+    resourceVersion?: string;
+    generation?: number;
+    continue?: string;
+    totalItems?: number;
+    managedFields?: unknown;
+    clusterName?: string;
+}
+export interface KubernetesResource extends TypeMeta {
+    metadata?: ObjectMeta;
+    spec?: unknown;
+    status?: unknown;
+}
+export interface UntypedKubernetesResource extends TypeMeta {
+    metadata?: ObjectMeta;
+    spec?: any;
+    status?: any;
+}
+export interface KubernetesResourceList<T extends KubernetesResource = KubernetesResource> extends KubernetesResource {
+    items: T[];
+}
+export interface Condition {
+    lastProbeTime?: string;
+    lastTransitionTime?: string;
+    message?: string;
+    reason?: string;
+    status?: string;
+    type?: string;
+}
+/**
+ * Kubernetes Subject
+ * https://github.com/kubernetes/api/blob/9b64426eca51a74faa7cc9bd732a533d339c69c2/rbac/v1/types.go#L74
+ */
+export interface KubernetesSubject {
+    kind: string;
+    APIGroup?: string;
+    namespace?: string;
+    name: string;
+}

package/types/k8s/crd.d.ts

@@ -0,0 +1,497 @@
+import { ValueOf } from 'ts-essentials';
+import { StringMap } from '../common';
+import { Condition, KubernetesResource, KubernetesResourceList, ObjectMeta } from './core';
+import { ConfigMapKeyRef, SecretKeyRef } from './raw';
+export interface ClusterSpec {
+    authInfo?: {
+        controller: {
+            kind: string;
+            namespace: string;
+            name: string;
+        };
+    };
+    kubernetesApiEndpoints?: {
+        caBundle?: string;
+        serverEndpoints: Array<{
+            clientCIDR: string;
+            serverAddress: string;
+        }>;
+    };
+}
+export type ClusterStatusReason = 'Timeout' | 'Forbidden' | 'Unauthorized' | 'SomeComponentsUnhealthy' | 'SomeNodesNotReady';
+export interface ClusterStatusCondition extends Condition {
+    lastTransitionTime: string;
+    type: 'NotReachable' | 'NotAccessible' | 'ComponentNotHealthy' | 'NodeNotReady';
+    status: 'True' | 'False';
+    reason: ClusterStatusReason;
+}
+export interface ClusterStatus {
+    version: string;
+    conditions: ClusterStatusCondition[];
+}
+export interface Cluster extends KubernetesResource {
+    metadata?: ObjectMeta & {
+        finalizers?: string[];
+    };
+    spec?: ClusterSpec;
+    status?: ClusterStatus;
+    details?: {
+        group: string;
+        kind: string;
+        name: string;
+        uid: string;
+    };
+}
+export interface AlaudaProductStatus extends Condition {
+    deployStatus?: AlaudaDeployStatus;
+    runningStatus?: AlaudaRunningStatus;
+    message: string;
+    deployTime?: string;
+}
+export declare enum AlaudaRunningStatus {
+    NOT_RUNNING = "NotRunning",
+    HEALTHY = "Healthy",
+    ABNORMAL = "Abnormal"
+}
+export declare enum AlaudaDeployStatus {
+    NOT_DEPLOYED = "NotDeployed",
+    SUCCESS = "success",
+    ABNORMAL = "Abnormal",
+    DEPLOYING = "Deploying",
+    DEPLOY_FAILED = "DeployFailed",
+    UPGRADING = "Upgrading",
+    UPGRADE_FAILED = "UpgradeFailed",
+    COMPLETED = "Completed",
+    PENDING = "Pending"
+}
+export interface ProductBase extends KubernetesResource {
+    spec: ProductBaseSpec;
+    status?: ProductBaseStatus;
+}
+export interface ProductStatusCondition {
+    status?: 'True' | 'False' | 'Unknown';
+    reason?: string;
+    message?: string;
+    type: 'Ready' | 'Initialized' | 'Reclaimed' | 'Succeed';
+    lastTransitionTime?: string;
+    lastHeartbeatTime?: string;
+}
+export interface ProductBaseStatus {
+    globalID: string;
+    cloud: {
+        phase: 'ONLine' | 'ConnectFailed' | 'Connecting' | 'OFFLine';
+        message: string;
+        connectURL: string;
+    };
+    version: string;
+    phase?: 'Pending' | 'Provisioning' | 'Provisioned' | 'Deleting' | 'Failed' | 'Running' | 'Installing' | 'Upgrading';
+    productEntrypoint?: string;
+    deletable?: boolean;
+    conditions?: ProductStatusCondition[];
+    prometheusAddress?: string;
+    elasticSearchAddress?: string;
+    kafkaAddress?: string;
+    containerPlatform?: AlaudaProductStatus;
+    devops?: AlaudaProductStatus;
+    serviceMesh?: AlaudaProductStatus;
+    dataServices?: AlaudaProductStatus;
+    base?: AlaudaProductStatus;
+    progress?: number;
+    replicas?: number;
+}
+export declare const ProductKey: {
+    readonly BASE: "base";
+    readonly CONTAINER_PLATFORM: "containerPlatform";
+    readonly DEVOPS: "devops";
+    readonly SERVICE_MESH: "serviceMesh";
+    readonly DATA_SERVICES: "dataServices";
+};
+export type ProductKey = ValueOf<typeof ProductKey>;
+type GenProduct<T extends ProductKey> = Record<T, {
+    install: boolean;
+}>;
+export interface Tls {
+    secretRef: {
+        name: string;
+    };
+}
+export interface ProductBaseSpec extends GenProduct<ProductKey> {
+    alternativeURLs: string[];
+    chartMuseum: {
+        url: string;
+    };
+    packageEdition: string;
+    valuesOverride?: {
+        dex: StringMap;
+    };
+    chartVersions: [{
+        name: string;
+        version: string;
+    }];
+    defaultAdmin: {
+        account: string;
+        email: string;
+        password: string;
+    };
+    defaultRedirectPath: string;
+    deployType: string;
+    elasticsearch: {
+        install: boolean;
+        nodes: string[];
+        username: string;
+    };
+    http: {
+        forceRedirectHttps?: boolean;
+        httpPort?: number;
+        httpsPort?: number;
+        tls?: Tls;
+    };
+    ingress: {
+        controller: {
+            install: boolean;
+            nodes: string[];
+        };
+        host: string;
+        ingressClassName: string;
+    };
+    kafka: {
+        auth: boolean;
+        install: boolean;
+        nodes: string[];
+        username: string;
+    };
+    logAgent: {
+        enable: boolean;
+    };
+    logCenter: {
+        enable: boolean;
+    };
+    platformURL: string;
+    prometheus: {
+        install: boolean;
+        replicas: number;
+        storage: {
+            capacity: number;
+            nodes: string[];
+            path: string;
+            type: string;
+        };
+    };
+    registry: {
+        external?: string;
+        address: string;
+        username: string;
+        secretRef?: string;
+    };
+    replicas: number;
+    version: string;
+    cloud: {
+        connect: boolean;
+        connectType: string;
+    };
+}
+export interface ProjectSpec {
+    clusters: ProjectCluster[];
+    status?: {
+        phase: string;
+    };
+    clusterDeletePolicy?: 'Delete' | 'Retain';
+}
+export interface ProjectCluster {
+    name: string;
+    quota: Record<string, string>;
+    type?: '' | 'FedMember';
+}
+export interface Project extends KubernetesResource {
+    spec: ProjectSpec;
+    status?: {
+        phase: string;
+    };
+}
+export type LocaleDisplay = Record<string, string>;
+export interface ProductEntrySpec {
+    logo?: string;
+    displayName?: LocaleDisplay;
+    description?: LocaleDisplay;
+    catalog?: LocaleDisplay;
+    entrypoint?: string;
+    ssoEnabled?: boolean;
+    packType?: 'Integrated' | 'BuildIn' | 'AdminPage';
+    version?: string;
+}
+export interface ProductEntryStatus {
+    hiddenOnPortal?: boolean;
+    hiddenOnMenu?: boolean;
+    orderOnPortal?: number;
+    orderOnMenu?: number;
+}
+export interface ProductEntry extends KubernetesResource {
+    spec?: ProductEntrySpec;
+    status?: ProductEntryStatus;
+}
+export interface ProductStatus {
+    type: 'NotDeployed' | 'InDeployment' | 'Running' | 'DeploymentFailure' | 'RunningAbnormal' | 'Deleting' | 'DeleteFailure' | 'DeploymentSucceed' | 'SystemError' | 'Upgrading';
+    icon: string;
+    text: string;
+}
+/**
+ * @link https://gitlab-ce.alauda.cn/container-platform/captain/-/blob/master/docs/crd.md
+ */
+export interface HelmRequest extends KubernetesResource {
+    spec?: HelmRequestSpec;
+    status?: {
+        phase: HelmRequestPhaseEnum;
+        notes?: string;
+        lastSpecHash?: string;
+        reason?: string;
+        conditions?: HelmRequestCondition[];
+        targetClusterSyncResults?: HelmRequestClusterSyncResults;
+    };
+}
+export interface HelmRequestCondition {
+    lastProbeTime?: string;
+    lastTransitionTime?: string;
+    message: string;
+    reason: string;
+    status: 'True' | 'False';
+    type: string;
+}
+export interface HelmRequestClusterSyncResults {
+    [cluster: string]: HelmRequestClusterSyncResult;
+}
+export declare enum CloudHelmRequestStateEnum {
+    Pending = "Pending",
+    Running = "Running",
+    Stopped = "Stopped",
+    Failed = "Failed",
+    Empty = "Empty"
+}
+export interface HelmRequestClusterSyncResult {
+    appStatus: CloudHelmRequestStateEnum;
+    endpoint: string;
+    lastUpdateAt: string;
+    name: string;
+    phase: HelmRequestPhaseEnum;
+    reason: string;
+}
+export declare enum HelmRequestPhaseEnum {
+    Synced = "Synced",
+    Failed = "Failed",
+    Pending = "Pending",
+    Uninstalling = "Uninstalling"
+}
+export interface HelmRequestSpec {
+    chart?: string;
+    values: Record<string, unknown>;
+    valuesFrom?: Array<{
+        configMapKeyRef?: ConfigMapKeyRef;
+        secretKeyRef?: SecretKeyRef;
+    }>;
+    clusterName?: string;
+    namespace?: string;
+    releaseName?: string;
+    version?: string;
+    projectName?: string;
+    source?: {
+        oci?: HelmRequestOci;
+        http?: HelmRequestHttp;
+    };
+    targetClusters?: {
+        clusterNames: {
+            names: string[];
+        };
+    };
+}
+export interface HelmRequestOci {
+    repo: string;
+    secretRef: string;
+}
+export interface HelmRequestHttp {
+    url: string;
+    secretRef: string;
+}
+export interface User extends KubernetesResource {
+    spec?: UserSpec;
+}
+export interface UserSpec {
+    connector_name?: string;
+    connector_type?: string;
+    email?: string;
+    mail?: string;
+    groups?: string[];
+    is_admin?: boolean;
+    valid?: boolean;
+    username?: string;
+    old_password?: string;
+    password?: string;
+    last_login_time?: string;
+    login_failure_times?: number;
+    state?: UserState;
+    is_disabled?: boolean;
+    expired?: {
+        begin: string;
+        end: string;
+    };
+    mobile?: string;
+    webhookType?: WebhookType;
+    webhookUrl?: string;
+    ids?: Array<{
+        type: string;
+        id: string;
+    }>;
+}
+export declare enum UserState {
+    ACTIVE = "active",
+    LOCKED = "locked",
+    INVALID = "invalid",
+    DELETED = "deleted"
+}
+export type WebhookType = 'Webhook' | 'DingTalk' | 'WeChat';
+export interface UserList extends KubernetesResourceList<User> {
+    total: number;
+}
+/**
+ * https://confluence.alauda.cn/pages/viewpage.action?pageId=176883470
+ */
+export interface UserBinding extends KubernetesResource {
+    spec?: UserBindingSpec;
+}
+export interface UserBindingSpec {
+    subjects: Array<{
+        kind: 'User' | 'Group' | 'ServiceAccount';
+        name: string;
+    }>;
+    roleRef: string;
+    scope: string;
+    constraint: Array<{
+        project?: string;
+        cluster?: string;
+        namespace?: string;
+    }>;
+}
+export interface UserGroup extends KubernetesResource {
+    spec: UserGroupSpec;
+}
+export interface UserGroupSpec {
+    refConnector?: {
+        id: string;
+        type: string;
+    };
+    name?: string;
+    description?: string;
+    users?: Array<{
+        name: string;
+        importTime: string;
+    }>;
+}
+export interface RoleRule {
+    functionResourceRef: string;
+    verbs: string[];
+}
+export interface RoleCustomRule {
+    apiGroup: string;
+    resources: string[];
+    verbs: string[];
+}
+export interface RoleTemplateSpec {
+    rules?: RoleRule[];
+    customRules?: RoleCustomRule[];
+}
+export interface RoleTemplate extends KubernetesResource {
+    spec?: RoleTemplateSpec;
+}
+export interface UserRoleNamespace {
+    namespace: string;
+    cluster: string;
+}
+export interface UserRole extends KubernetesResource {
+    name?: string;
+    roles?: string[];
+    namespaces?: Record<string, UserRoleNamespace[]>;
+}
+export declare enum UserSecurityPolicyRule {
+    PasswordPolicy = "PasswordPolicy",
+    UserLock = "UserLockedPolicy",
+    UserDisable = "UserDisabledPolicy",
+    Notification = "NotificationPolicy",
+    AccessControl = "AccessControlPolicy",
+    TwoFA = "TwoFactorAuthenticationPolicy"
+}
+export interface UserPolicyRule {
+    name: UserSecurityPolicyRule;
+    items: Array<{
+        enable: boolean;
+        key: string;
+        value?: string;
+    }>;
+}
+export interface UserPolicy extends KubernetesResource {
+    rules: UserPolicyRule[];
+}
+export interface Idp extends KubernetesResource {
+    spec?: {
+        config?: LdapConfig | OidcConfig;
+    };
+    id: string;
+    name: string;
+    type: string;
+    namespace?: string;
+    config?: string;
+    ldapSync?: {
+        sync: boolean;
+        roles: string;
+    };
+    idpValidation?: {
+        username: string;
+        password: string;
+    };
+}
+export interface LdapConfig {
+    host?: string;
+    insecureNoSSL?: boolean;
+    insecureSkipVerify?: boolean;
+    startTLS?: boolean;
+    rootCA?: string;
+    rootCAData?: string;
+    bindDN?: string;
+    bindPW?: string;
+    clientSecretRef?: string;
+    ldapType?: string;
+    usernamePrompt?: string;
+    userSearch?: LdapUserSearch;
+    groupSearch?: LdapGroupSearch;
+}
+export interface LdapUserSearch {
+    baseDN?: string;
+    filter?: string;
+    scope?: string;
+    username?: string;
+    idAttr?: string;
+    emailAttr?: string;
+    nameAttr?: string;
+}
+export interface LdapGroupSearch {
+    baseDN?: string;
+    filter?: string;
+    scope?: string;
+    userAttr?: string;
+    groupAttr?: string;
+    nameAttr?: string;
+}
+export interface OidcConfig {
+    issuer?: string;
+    clientID?: string;
+    clientSecret?: string;
+    clientSecretRef?: string;
+    redirectURI?: string;
+    logoutURL?: string;
+    scopes?: string[];
+}
+export interface AccessTokenInfo extends KubernetesResource {
+    spec: {
+        timestamp: number;
+        expiration: number;
+        description: string;
+    };
+}
+export {};

package/types/k8s/index.d.ts

@@ -0,0 +1,3 @@
+export * from './crd';
+export * from './raw';
+export * from './core';