@alauda-fe/crd-form 0.0.1

package/lib/spec-descriptors/capability-list/capability-list.component.d.ts

@@ -0,0 +1,34 @@
+import { OpenAPIV3SchemaObject } from '@alauda-fe/common';
+import { Descriptor, OperandArrayFieldGroup, OperandField, OperandFieldGroup } from '../../types';
+import { createCapabilityField } from '../../utils';
+import * as i0 from "@angular/core";
+export declare class SpecCapabilityListComponent {
+    descriptors: Descriptor[];
+    debug: boolean;
+    data: unknown;
+    openApiSchema: OpenAPIV3SchemaObject;
+    openApiSchemaPath: string | string[];
+    createCapabilityField: typeof createCapabilityField;
+    excludes: (fields: OperandField[]) => OperandField[];
+    debugLog: (fields: {
+        normalFields: OperandField[];
+        fieldGroups: OperandFieldGroup[];
+        arrayFieldGroups: OperandArrayFieldGroup[];
+        advancedFields: OperandField[];
+        descriptorFields: OperandField[];
+        openApiFields: OperandField[];
+        basicFields: OperandField[];
+        treeFields: OperandField[];
+    }) => {
+        normalFields: OperandField[];
+        fieldGroups: OperandFieldGroup[];
+        arrayFieldGroups: OperandArrayFieldGroup[];
+        advancedFields: OperandField[];
+        descriptorFields: OperandField[];
+        openApiFields: OperandField[];
+        basicFields: OperandField[];
+        treeFields: OperandField[];
+    };
+    static ɵfac: i0.ɵɵFactoryDeclaration<SpecCapabilityListComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<SpecCapabilityListComponent, "acl-spec-descriptor-capability-list", never, { "descriptors": { "alias": "descriptors"; "required": false; }; "debug": { "alias": "debug"; "required": false; }; "data": { "alias": "data"; "required": false; }; "openApiSchema": { "alias": "openApiSchema"; "required": false; }; "openApiSchemaPath": { "alias": "openApiSchemaPath"; "required": false; }; }, {}, never, never, false, never>;
+}

package/lib/spec-descriptors/index.d.ts

@@ -0,0 +1,3 @@
+export * from './capability/capability.component';
+export * from './capability-list/capability-list.component';
+export * from './util';

package/lib/spec-descriptors/util.d.ts

@@ -0,0 +1,4 @@
+import { Map } from 'immutable';
+import { SpecCapability } from '../types';
+export declare const capabilityComponents: Map<SpecCapability, SpecCapability>;
+export declare const capabilityFor: (specCapability: SpecCapability) => SpecCapability;

package/lib/types/index.d.ts

@@ -0,0 +1,122 @@
+import { JSONSchema6TypeName, LocaleDisplay } from '@alauda-fe/common';
+import { ValidationErrors } from '@angular/forms';
+import { Map } from 'immutable';
+export declare enum Validations {
+    maximum = "maximum",
+    minimum = "minimum",
+    maxLength = "maxLength",
+    minLength = "minLength",
+    pattern = "pattern",
+    required = "required"
+}
+export declare const SpecCapabilityUIPrefix = "urn:alm:descriptor:com.tectonic.ui";
+export declare const SpecCapabilityWidgetsPrefix = "urn:alm:descriptor:widgets";
+export declare enum SpecCapability {
+    podCount = "urn:alm:descriptor:com.tectonic.ui:podCount",
+    resourceRequirements = "urn:alm:descriptor:com.tectonic.ui:resourceRequirements",
+    booleanSwitch = "urn:alm:descriptor:com.tectonic.ui:booleanSwitch",
+    text = "urn:alm:descriptor:com.tectonic.ui:text",
+    textarea = "urn:alm:descriptor:com.tectonic.ui:textarea",
+    password = "urn:alm:descriptor:com.tectonic.ui:password",
+    confirmPassword = "urn:alm:descriptor:com.tectonic.ui:password:confirm",
+    externalPassword = "urn:alm:descriptor:com.tectonic.ui:externalPassword",
+    number = "urn:alm:descriptor:com.tectonic.ui:number",
+    tagsInput = "urn:alm:descriptor:com.tectonic.ui:tagsInput",
+    fieldGroup = "urn:alm:descriptor:com.tectonic.ui:fieldGroup:",
+    arrayFieldGroup = "urn:alm:descriptor:com.tectonic.ui:arrayFieldGroup:",
+    select = "urn:alm:descriptor:com.tectonic.ui:select:",
+    advanced = "urn:alm:descriptor:com.tectonic.ui:advanced",
+    fieldDependency = "urn:alm:descriptor:com.tectonic.ui:fieldDependency:",
+    defaultValue = "urn:alm:descriptor:com.tectonic.default:",
+    hidden = "urn:alm:descriptor:com.tectonic.ui:hidden",
+    k8sResourcePrefix = "urn:alm:descriptor:io.kubernetes:",
+    labelEn = "urn:alm:descriptor:label:en:",
+    labelZh = "urn:alm:descriptor:label:zh:",
+    descriptionEn = "urn:alm:descriptor:description:en:",
+    descriptionZh = "urn:alm:descriptor:description:zh:",
+    placeholder = "urn:alm:descriptor:placeholder:",
+    fieldGroupName = "urn:alm:descriptor:fieldGroupName:",
+    tooltip = "urn:alm:descriptor:tooltip:",
+    /** Using String Expressions */
+    expression = "urn:alm:descriptor:expression:",
+    /** 自定义 Urn */
+    yaml = "urn:alm:descriptor:com.tectonic.ui:yaml",
+    yamlActionsDisabled = "urn:alm:descriptor:yaml:actions:disabled:",
+    yamlResult = "urn:alm:descriptor:yaml:result:",
+    oneOf = "urn:alm:descriptor:oneOf:",
+    object = "urn:alm:descriptor:com.tectonic.ui:object",
+    array = "urn:alm:descriptor:com.tectonic.ui:array",
+    folded = "urn:alm:descriptor:com.tectonic.ui:folded",
+    emptyArray = "urn:alm:descriptor:com.tectonic.ui:emptyArray",
+    validation = "urn:alm:descriptor:com.tectonic.ui:validation:",
+    multiple = "urn:alm:descriptor:com.tectonic.ui:multiple",
+    allowCreate = "urn:alm:descriptor:com.tectonic.ui:allowCreate",
+    creatable = "urn:alm:descriptor:com.tectonic.ui:creatable",
+    clearable = "urn:alm:descriptor:com.tectonic.ui:clearable",
+    disabled = "urn:alm:descriptor:com.tectonic.ui:disabled",
+    radio = "urn:alm:descriptor:com.tectonic.ui:radio:",
+    customDescriptionZh = "urn:alm:descriptor:custom:description:zh:",
+    customDescriptionEn = "urn:alm:descriptor:custom:description:en:",
+    customDescriptionLink = "urn:alm:descriptor:custom:description:link:",
+    custom = "urn:alm:descriptor:widgets:",
+    basicAuthSecret = "urn:alm:descriptor:com.tectonic.ui:basicAuthSecret",
+    remote = "urn:alm:descriptor:remote:",
+    pathTag = "urn:alm:descriptor:com.tectonic.ui:path.tag:"
+}
+export interface Descriptor {
+    path: string;
+    displayName: string;
+    description: string;
+    'x-descriptors': SpecCapability[];
+    value?: any;
+}
+export interface DescriptorProps {
+    descriptor: Descriptor;
+    value: any;
+    namespace?: string;
+}
+export interface OperandFieldValidation {
+    [Validations.maximum]?: number;
+    [Validations.minimum]?: number;
+    [Validations.maxLength]?: number;
+    [Validations.minLength]?: number;
+    [Validations.pattern]?: string;
+    [Validations.required]?: boolean;
+}
+export interface OperandField {
+    path?: string;
+    type?: JSONSchema6TypeName;
+    capabilities?: SpecCapability[];
+    required?: boolean;
+    displayName?: string;
+    description?: string;
+    validations?: OperandFieldValidation;
+    value?: unknown;
+    descriptor?: Descriptor;
+    _dirty?: boolean;
+    parent?: string;
+    inParentIndex?: number;
+    disabled?: boolean;
+}
+export interface OperandFieldGroup extends OperandField {
+    groupName: string;
+    groupDisplay: LocaleDisplay;
+    fieldList: OperandField[];
+}
+export interface OperandArrayFieldGroup extends OperandField {
+    groupName: string;
+    fieldLists: OperandField[][];
+}
+export type FormDataState = Map<string, any>;
+export interface FieldValueChangeEvent {
+    field: OperandField;
+    data: unknown;
+    errors: unknown;
+}
+export interface FormErrors {
+    [key: string]: ValidationErrors;
+}
+export interface FormState {
+    data: unknown;
+    errors: FormErrors;
+}

package/lib/utils/capability.d.ts

@@ -0,0 +1,54 @@
+import { Dictionary, JSONSchema6TypeName, StringMap } from '@alauda-fe/common';
+import { Descriptor, OperandArrayFieldGroup, OperandField, OperandFieldGroup, OperandFieldValidation, SpecCapability } from '../types';
+export declare function getBasicAuthSecretConfig(field: OperandField): unknown;
+export declare function getRadioOptions(capabilities: SpecCapability[]): {
+    value: string;
+    display: {
+        zh: string;
+        en: string;
+    };
+}[];
+export declare function setRadiosDefaultValue(descriptors: Descriptor[]): {
+    spec: {};
+};
+export declare const getBooleanSwitchOptions: (capabilities: SpecCapability[]) => {
+    value: string;
+    display: string | {
+        zh: string;
+        en: string;
+    };
+}[];
+export declare const convertBooleanSwitchValue: (value: boolean, capabilities: SpecCapability[]) => string | {
+    zh: string;
+    en: string;
+};
+export declare function convertValue(value: string, type: JSONSchema6TypeName): any;
+export declare function getDefaultValue(field: OperandField): any;
+export declare function getFieldType(field: OperandField): SpecCapability;
+export declare function getBasicCapabilityType(capabilities: string[]): "string" | "number" | "boolean" | "object" | "array";
+export declare function getFieldDisplayName(field: OperandField | OperandArrayFieldGroup | OperandFieldGroup): {
+    en: string;
+    zh: string;
+};
+export declare function getDisplayByCapability(capabilities: SpecCapability[], name: string, fallback?: string): {
+    en: string;
+    zh: string;
+};
+export declare function getFieldDescription(field: OperandField): {
+    en: string;
+    zh: string;
+};
+export declare function getK8sResourcePrefixOptions(field: OperandField): {
+    namespaced: boolean;
+    labelSelector: string;
+    isGlobal: boolean;
+    groupVersionKind: string;
+    type: string;
+    multiple: boolean;
+    validations: OperandFieldValidation;
+};
+export declare function resolveKVParams(str: string): StringMap;
+export declare function getCapabilityDisabled(capabilities: SpecCapability[]): boolean;
+export declare function getCapabilityValidations(capabilities: SpecCapability[]): OperandFieldValidation;
+export declare function getOneOfMap(field: OperandField): Dictionary<string[]>;
+export declare function fieldShouldReveal(field: OperandField): SpecCapability;

package/lib/utils/constant.d.ts

@@ -0,0 +1,12 @@
+export declare const MAX_DEPTH = 1;
+export declare const SCHEMA_PATH: string[];
+export declare const DESCRIPTOR_DEFINITION_KEY = "x-descriptors";
+export declare const NamespacedResourceKind: string[];
+export declare const GROUP_PATTERN: RegExp;
+export declare const DEFAULT_VALUE_PATTERN: RegExp;
+export declare const REGEXP_K8S_RESOURCE_CAPABILITY: string;
+export declare const REGEXP_CAPABILITY_VALIDATION: string;
+export declare const REGEXP_FIELD_DEPENDENCY_CAPABILITY: string;
+export declare const REGEXP_SELECT_CAPABILITY: string;
+export declare const REGEXP_K8S_RESOURCE_SUFFIX: RegExp;
+export declare const REGEXP_VALIDATION_SUFFIX: RegExp;

package/lib/utils/directives.d.ts

@@ -0,0 +1,9 @@
+import { TemplateRef } from '@angular/core';
+import * as i0 from "@angular/core";
+export declare class CrdFormCustomDescriptionDirective {
+    templateRef: TemplateRef<any>;
+    aclCrdFormCustomDescription: string;
+    constructor(templateRef: TemplateRef<any>);
+    static ɵfac: i0.ɵɵFactoryDeclaration<CrdFormCustomDescriptionDirective, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<CrdFormCustomDescriptionDirective, "ng-template[aclCrdFormCustomDescription]", ["aclCrdFormCustomDescription"], { "aclCrdFormCustomDescription": { "alias": "aclCrdFormCustomDescription"; "required": false; }; }, {}, never, never, false, never>;
+}

package/lib/utils/helper.d.ts

@@ -0,0 +1,61 @@
+import { QueryList } from '@angular/core';
+import { OperandArrayFieldGroup, OperandField, OperandFieldGroup, SpecCapability } from '../types';
+import { CrdFormCustomDescriptionDirective } from './directives';
+export declare const isRequired: (field: OperandField) => boolean;
+export declare const filterMapByKey: <T>(map: Map<string, T>, predicate: (input: string) => boolean) => Map<any, any>;
+export declare const getMatchArrayIndex: (arrPath: string) => number;
+export declare const isGroupField: (field: OperandField) => field is OperandFieldGroup;
+export declare const isArrayField: (field: OperandField) => field is OperandArrayFieldGroup;
+export declare const isRemoteField: (field: OperandField) => field is OperandArrayFieldGroup;
+export declare const isArrayFieldTable: (field: OperandField) => field is OperandArrayFieldGroup;
+export declare const isCreatable: (field: OperandField) => boolean;
+export declare const isMultiple: (field: OperandField) => boolean;
+export declare const isAllowCreate: (field: OperandField) => boolean;
+export declare const isClearable: (field: OperandField) => boolean;
+export declare const isFolded: (field: OperandField) => boolean;
+export declare const isEmptyArray: (field: OperandField) => boolean;
+export declare function hasDescriptor(field: OperandField, prefix: string, suffix?: string): boolean;
+export declare function parseArrayPath(path: string): {
+    index?: number;
+    match?: string;
+    pathBeforeIndex?: string;
+    pathAfterIndex?: string;
+};
+export declare function getArrayGroupName(field: OperandField): string;
+export declare function getGroupName(field: OperandField): string;
+/**
+ * 递归修复树形结构中 数组类型的索引
+ *
+ * @export
+ * @param {OperandField} field
+ * @param {string} fromPath
+ * @param {string} toPath
+ * @returns
+ *
+ */
+export declare const repairFieldChildPathByCorrectIndex: (field: OperandField, fromPath: string, toPath: string) => {
+    path: string;
+    type?: import("@alauda-fe/common").JSONSchema6TypeName;
+    capabilities?: SpecCapability[];
+    required?: boolean;
+    displayName?: string;
+    description?: string;
+    validations?: import("../types").OperandFieldValidation;
+    value?: unknown;
+    descriptor?: import("../types").Descriptor;
+    _dirty?: boolean;
+    parent?: string;
+    inParentIndex?: number;
+    disabled?: boolean;
+};
+export declare const getRelatedFields: (normalFields: OperandField[]) => OperandField[];
+export declare const getTreeFields: (rootFields: OperandField[], basicFields: OperandField[]) => any[];
+export declare const getMatchedCapabilityValue: (capabilities: SpecCapability[], descriptor: string) => string;
+export declare function evalInContext(stringExpression: string, context: any): any;
+export declare function coerceBoolean(val: any): boolean;
+export declare function coerceNumber(val: any, fallbackValue?: number): number;
+export declare function _isNumberValue(value: any): boolean;
+export declare function getCustomDescription(customDescriptions: QueryList<CrdFormCustomDescriptionDirective>, field: OperandField): CrdFormCustomDescriptionDirective;
+export declare function getOperandPath(field: OperandField): string;
+export declare function getPathFromTagPath(pathWithTag: string): string;
+export declare const getFieldsByPath: (path: string, fields: OperandField[]) => OperandField[];

package/lib/utils/index.d.ts

@@ -0,0 +1,6 @@
+export * from './capability';
+export * from './constant';
+export * from './directives';
+export * from './helper';
+export * from './service-model';
+export * from './util';

package/lib/utils/service-model.d.ts

@@ -0,0 +1,44 @@
+export type K8sVerb = 'create' | 'get' | 'list' | 'update' | 'patch' | 'delete' | 'deletecollection' | 'watch';
+export interface MatchExpressionWithValues {
+    key: string;
+    operator: 'In' | 'NotIn' | 'Exists' | 'DoesNotExist';
+    values: string[];
+}
+export type MatchExpression = {
+    key: string;
+    operator: 'Exists' | 'DoesNotExist';
+} | MatchExpressionWithValues;
+export interface MatchLabels {
+    [key: string]: string;
+}
+export interface Selector {
+    matchLabels?: MatchLabels;
+    matchExpressions?: MatchExpression[];
+}
+export interface K8sKind {
+    abbr: string;
+    kind: string;
+    label: string;
+    labelKey?: string;
+    labelPlural: string;
+    labelPluralKey?: string;
+    plural: string;
+    propagationPolicy?: 'Foreground' | 'Background';
+    id?: string;
+    crd?: boolean;
+    apiVersion: string;
+    apiGroup?: string;
+    namespaced?: boolean;
+    selector?: Selector;
+    labels?: {
+        [key: string]: string;
+    };
+    annotations?: {
+        [key: string]: string;
+    };
+    verbs?: K8sVerb[];
+    shortNames?: string[];
+    color?: string;
+    legacyPluralURL?: boolean;
+}
+export declare const NodeModel: K8sKind;

package/lib/utils/util.d.ts

@@ -0,0 +1,48 @@
+import { OpenAPIV3SchemaObject } from '@alauda-fe/common';
+import { Descriptor, FormDataState, OperandField, SpecCapability } from '../types';
+export interface FlattenNestedPropertiesAccumulator {
+    currentCapabilities?: SpecCapability[];
+    currentPath?: string[];
+    fields?: OperandField[];
+    required: boolean;
+}
+export declare function getPropertyDepth(property: OpenAPIV3SchemaObject, depth?: number): number;
+export declare function getFieldsFromDescriptor({ path, description, displayName, 'x-descriptors': capabilities, }: Descriptor, data: any, openApi: OpenAPIV3SchemaObject, _originDescriptors?: Descriptor[]): OperandField[];
+export declare function getOpenApiPropertyByPath(descriptorPath: string, openApi: OpenAPIV3SchemaObject): OpenAPIV3SchemaObject;
+export declare function getFieldsFromOpenApiSchema(openApi: OpenAPIV3SchemaObject, descriptors: Descriptor[], data: unknown, openApiSchemaPath?: string | string[], maxDepth?: number): OperandField[];
+export declare function flattenNestedProperties(propertyName: string, property: OpenAPIV3SchemaObject, descriptors: Descriptor[], data: any, { currentCapabilities, currentPath, required, }: FlattenNestedPropertiesAccumulator): OperandField[];
+export declare function getCapabilitiesForOpenApiProperty(property: OpenAPIV3SchemaObject, capabilities?: string[]): SpecCapability[];
+export declare function modifyArrayFieldPathIndex(path: string, operation: (index?: number) => string | number): string;
+export declare function pathToArray(path: string): Array<string | number>;
+export declare function parseGroupDescriptor(field: OperandField): {
+    groupName?: string;
+    groupType?: string;
+    match?: string;
+};
+export declare function normalizePath(path: string): string;
+export declare function getFormData(formData: FormDataState, path: string, enableConvert?: boolean): FormDataState;
+export declare function createCapabilityField(descriptors: Descriptor[], openApiSchema: OpenAPIV3SchemaObject, data: unknown, openApiSchemaPath: string | string[]): {
+    normalFields: OperandField[];
+    fieldGroups: {
+        groupName: string;
+        displayName: string;
+        groupDisplay: {
+            en: string;
+            zh: string;
+        };
+        capabilities: SpecCapability[];
+        fieldList: OperandField[];
+    }[];
+    arrayFieldGroups: {
+        groupName: string;
+        displayName: string;
+        capabilities: SpecCapability[];
+        fieldLists: OperandField[][];
+        _dirty: boolean;
+    }[];
+    advancedFields: OperandField[];
+    descriptorFields: OperandField[];
+    openApiFields: OperandField[];
+    basicFields: OperandField[];
+    treeFields: OperandField[];
+};

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@alauda-fe/crd-form",
+  "version": "0.0.1",
+  "peerDependencies": {
+    "@alauda-fe/i18n": "1.0.3",
+    "@angular/common": "^13.2.0",
+    "@angular/core": "^13.2.0"
+  },
+  "dependencies": {
+    "tslib": "^2.4.0"
+  },
+  "sideEffects": false,
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "module": "esm2022/alauda-fe-crd-form.mjs",
+  "typings": "index.d.ts",
+  "exports": {
+    "./package.json": {
+      "default": "./package.json"
+    },
+    ".": {
+      "types": "./index.d.ts",
+      "esm2022": "./esm2022/alauda-fe-crd-form.mjs",
+      "esm": "./esm2022/alauda-fe-crd-form.mjs",
+      "default": "./esm2022/alauda-fe-crd-form.mjs"
+    }
+  }
+}

package/public-api.d.ts

@@ -0,0 +1,9 @@
+export * from './lib/abstract/base-array';
+export * from './lib/crd-form.module';
+export * from './lib/crd-form/component';
+export * from './lib/field-controls';
+export * from './lib/field-widgets';
+export * from './lib/remote-widgets';
+export * from './lib/spec-descriptors';
+export * from './lib/types';
+export * from './lib/utils';