@mediusinc/mng-commons-data-api 6.2.0 → 7.0.0-rc.0

package/tableview/schema/fields-from-schema.d.ts

@@ -1,248 +0,0 @@
-import { SchemaEnum, SchemaModel, SchemaProperty } from '@mediusinc/mng-commons-data-api';
-import { ArrayItemType } from '@mediusinc/mng-commons/core';
-import { EnumDescriptor } from '@mediusinc/mng-commons/model';
-import { ITableDataProvider, TableDescriptorInst } from '@mediusinc/mng-commons/table/api';
-import { AFieldDescriptor, EditorDescriptorInst, FieldInputDescriptor, FieldLookupEnumDescriptor, FieldLookupProviderType, FieldManyEditorDescriptor, FieldManyToManyEditorDescriptor, TableviewDescriptorFieldsManageMultiType, TableviewDescriptorInst } from '@mediusinc/mng-commons/tableview/api';
-type FieldInputType = 'number' | 'currency' | 'boolean' | 'string' | 'text' | 'textarea' | 'date' | 'date-time' | 'enum' | 'hidden';
-type FromSchemaCommonOptsType<Model> = {
-    dateFormat?: string;
-    dateTimeFormat?: string;
-    textareaRows?: number;
-    numberUseGrouping?: boolean;
-    numberStep?: number;
-    numberMinFractionDigits?: number;
-    numberMaxFractionDigits?: number;
-    currency?: string;
-    currencyProperty?: keyof Model;
-    currencyDisplay?: 'symbol' | 'code' | 'name';
-};
-type FieldsFromSchemaOptsType<Model = any> = FromSchemaCommonOptsType<Model> & {
-    fieldTypes?: Partial<Record<keyof Model, FieldInputType>>;
-    enumModels?: Partial<Record<keyof Model, EnumDescriptor<any>>>;
-    enumSchemas?: Partial<Record<keyof Model, SchemaEnum<any>>>;
-};
-type FieldInputFromSchemaOptsType<Model = any, Enum = any> = FromSchemaCommonOptsType<Model> & {
-    fieldType?: FieldInputType;
-    enumSchema?: SchemaEnum<Enum>;
-    enumModel?: EnumDescriptor<Enum>;
-};
-/**
- * <em>Experimental:</em> Builder for adding fields to editor.
- *
- * @experimental
- */
-export declare class SchemaFieldsBuilder<Model, Parent = unknown, AddModel = Model, EditModel = Model, FieldsModel = TableviewDescriptorFieldsManageMultiType<Model, AddModel, EditModel>, SchModel = Model> {
-    private readonly descriptor;
-    private readonly schema;
-    private opts?;
-    constructor(descriptor: TableviewDescriptorInst<Model, any, any, Parent, any, AddModel, EditModel, FieldsModel> | EditorDescriptorInst<FieldsModel, Parent>, schema: SchemaModel<SchModel>, opts?: FieldsFromSchemaOptsType<SchModel> | undefined);
-    private mergeFieldsInputOpts;
-    private mergeFieldInputOpts;
-    /**
-     * <em>Experimental:</em> Adds a single input field via {addFieldInputFromSchema}.
-     *
-     * @experimental
-     *
-     * @param {Property} property - The property to add the field for.
-     * @param {FieldInputFromSchemaOptsType<SchModel>} opts - Additional options.
-     *
-     * @return {FieldInputDescriptor<Model, NonNullable<Model[Property]>, Model[Property], Parent>} The added field descriptor.
-     */
-    add<Property extends Extract<keyof FieldsModel, keyof SchModel>>(property: Property, opts?: FieldInputFromSchemaOptsType<SchModel>): FieldInputDescriptor<FieldsModel, NonNullable<FieldsModel[Property]>, FieldsModel[Property], Parent>;
-    /**
-     * <em>Experimental:</em> Adds all input fields for the non-array properties via {addFieldInputFromSchema}.
-     *
-     * @experimental
-     *
-     * @param {FieldsFromSchemaOptsType<SchModel>} opts - Additional options.
-     *
-     * @return {this} - The current instance of the builder.
-     */
-    withAddAll(opts?: FieldsFromSchemaOptsType<SchModel>): this;
-    /**
-     * <em>Experimental:</em> Adds input fields for properties via {addFieldInputFromSchema}.
-     *
-     * @experimental
-     *
-     * @param {FieldsFromSchemaOptsType<SchModel>} opts - Additional options.
-     * @param {...Property[]} properties - Properties to add fields for. If non provided, all non-array properties from schema will be added.
-     *
-     * @return {this} - The current instance of the builder.
-     */
-    withAdd<PropertyKey extends Extract<keyof Model, keyof SchModel>>(opts: FieldsFromSchemaOptsType<SchModel>, ...properties: PropertyKey[]): this;
-    /**
-     * <em>Experimental:</em> Adds fields for properties via {addFieldInputFromSchema}.
-     *
-     * @experimental
-     *
-     * @param {...Property[]} properties - Properties to add fields for. If non provided, all non-array properties from schema will be added.
-     *
-     * @return {this} - The current instance of the builder.
-     */
-    withAdd<Property extends Extract<keyof FieldsModel, keyof SchModel>>(...properties: Property[]): this;
-    private addFields;
-    /**
-     * <em>Experimental:</em> Adds a single input field via {addFieldInputFromSchema} where property schema is manually provided.
-     *
-     * @experimental
-     *
-     * @param {Property} property - The property to add the field for.
-     * @param {SchemaProperty} schemaProperty - Manually provided schema property.
-     * @param {FieldInputFromSchemaOptsType<Model>} opts - Additional options.
-     *
-     * @return {FieldInputDescriptor<Model, NonNullable<Model[Property]>, Model[Property], Parent>} The added field descriptor.
-     */
-    addFromSchema<Property extends keyof FieldsModel>(property: Property, schemaProperty: SchemaProperty, opts?: FieldInputFromSchemaOptsType<FieldsModel>): FieldInputDescriptor<FieldsModel, NonNullable<FieldsModel[Property]>, FieldsModel[Property], Parent>;
-    /**
-     * <em>Experimental:</em> Adds an enum lookup field via {addFieldEnumLookupFromSchema}.
-     *
-     * @experimental
-     *
-     * @param {Property} property - The property to add the enum lookup field for.
-     * @param {SchemaEnum<Enum> | EnumDescriptor<Enum>} [enumOpt] - The enum schema or the enum model descriptor. If non provided, builder opts will be checked.
-     *
-     * @returns {FieldLookupEnumDescriptor<Enum, Model, Parent>} - The added field descriptor.
-     *
-     * @throws {CommonsInternalError} - If no enum metadata is found for the property either from parameter or from builder's opts.
-     */
-    addEnum<Property extends Extract<keyof FieldsModel, keyof SchModel>, Enum>(property: Property, enumOpt?: SchemaEnum<Enum> | EnumDescriptor<Enum>): FieldLookupEnumDescriptor<Enum, FieldsModel, Parent>;
-    /**
-     * <em>Experimental:</em> Adds an enum lookup field via {addFieldEnumLookupFromSchema} where property schema is manually provided.
-     *
-     * @experimental
-     *
-     * @param {Property} property - The property to add the enum lookup field for.
-     * @param {SchemaEnum<Enum> | EnumDescriptor<Enum>} [enumOpt] - The enum schema or the enum model descriptor. If non provided, builder opts will be checked.
-     * @param {SchemaProperty} schemaProperty - Manually provided schema property.
-     *
-     * @returns {FieldLookupEnumDescriptor<Enum, Model, Parent>} - The added field descriptor.
-     *
-     * @throws {CommonsInternalError} - If no enum metadata is found for the property either from parameter or from builder's opts.
-     */
-    addEnumFromSchema<Property extends keyof FieldsModel, Enum>(property: Property, enumOpt: SchemaEnum<Enum> | EnumDescriptor<Enum> | undefined, schemaProperty: SchemaProperty): FieldLookupEnumDescriptor<Enum, FieldsModel, Parent>;
-    /**
-     * <em>Experimental:</em> Adds a lookup field.
-     * {EditorDescriptorInt.addFieldLookup} is used to create field and ${setFieldBasicOptionsFromSchema} to add basic field's options from schema.
-     *
-     * @experimental
-     *
-     * @param {Property} property - The property to create the lookup field for.
-     * @param {FieldLookupProviderType<LookupModel, Service>} provider - Data provider for the lookup field.
-     *
-     * @return The created lookup field.
-     */
-    addLookup<Property extends Extract<keyof FieldsModel, keyof SchModel>, Service = undefined, LookupModel extends NonNullable<FieldsModel[Property]> = NonNullable<FieldsModel[Property]>>(property: Property, provider?: FieldLookupProviderType<LookupModel, Service>): import("@mediusinc/mng-commons/tableview/api").FieldLookupDescriptor<LookupModel, FieldsModel, Service, FieldsModel[Property], Parent, keyof LookupModel, keyof LookupModel>;
-    /**
-     * <em>Experimental:</em> Adds a lookup field where property schema is manually provided.
-     * {EditorDescriptorInt.addFieldLookup} is used to create field and ${setFieldBasicOptionsFromSchema} to add basic field's options from schema.
-     *
-     * @experimental
-     *
-     * @param {Property} property - The property to create the lookup field for.
-     * @param {FieldLookupProviderType<LookupModel, Service> | undefined} provider - Data provider for the lookup field.
-     * @param {SchemaProperty} schemaProperty - Manually provided schema property.
-     *
-     * @return The created lookup field.
-     */
-    addLookupFromSchema<Property extends keyof FieldsModel, Service = undefined, LookupModel extends NonNullable<FieldsModel[Property]> = NonNullable<FieldsModel[Property]>>(property: Property, provider: FieldLookupProviderType<LookupModel, Service> | undefined, schemaProperty: SchemaProperty): import("@mediusinc/mng-commons/tableview/api").FieldLookupDescriptor<LookupModel, FieldsModel, Service, FieldsModel[Property], Parent, keyof LookupModel, keyof LookupModel>;
-    /**
-     * <em>Experimental:</em> Adds a one-to-many editor field.
-     * {EditorDescriptorInt.addFieldManyEditor} is used to create field and ${setFieldBasicOptionsFromSchema} to add basic field's options from schema.
-     *
-     * @experimental
-     *
-     * @param {Property} property - The property to create the many editor field for.
-     * @param {TableviewDescriptorInst<FieldModel, any, any, FieldsModel>} tableviewDescriptor - Tableview descriptor.
-     *
-     * @return The created one-to-many editor field.
-     */
-    addManyEditor<Property extends Extract<keyof FieldsModel, keyof SchModel>, FieldModel = ArrayItemType<FieldsModel[Property]>, FieldValue = FieldsModel[Property]>(property: Property, tableviewDescriptor: TableviewDescriptorInst<FieldModel, any, any, FieldsModel, FieldModel, FieldModel, FieldModel, FieldModel>): FieldManyEditorDescriptor<FieldModel, FieldsModel, FieldValue, Parent>;
-    /**
-     * <em>Experimental:</em> Adds an one-to-many editor field where property schema is manually provided.
-     * {EditorDescriptorInt.addFieldManyEditor} is used to create field and ${setFieldBasicOptionsFromSchema} to add basic field's options from schema.
-     *
-     * @experimental
-     *
-     * @param {Property} property - The property to create the many editor field for.
-     * @param {TableviewDescriptorType<FieldModel, any, any, FieldsModel>} tableviewDescriptor - Tableview descriptor.
-     * @param {SchemaProperty} schemaProperty - Manually provided schema property.
-     *
-     * @return The created one-to-many editor field.
-     */
-    addManyEditorFromSchema<Property extends keyof FieldsModel, FieldModel = ArrayItemType<FieldsModel[Property]>, FieldValue = FieldsModel[Property]>(property: Property, tableviewDescriptor: TableviewDescriptorInst<FieldModel, any, any, FieldsModel, FieldModel, FieldModel, FieldModel, FieldModel>, schemaProperty: SchemaProperty): FieldManyEditorDescriptor<FieldModel, FieldsModel, FieldValue, Parent>;
-    /**
-     * <em>Experimental:</em> Adds a many-to-many editor field.
-     * {EditorDescriptorInt.addFieldManyToManyEditor} is used to create field and ${setFieldBasicOptionsFromSchema} to add basic field's options from schema.
-     *
-     * @experimental
-     *
-     * @param {Property} property - The property to create the many editor field for.
-     * @param {TableDescriptorInst<FieldModel>} mainTableDescriptor - Main table descriptor.
-     * @param {TableDescriptorInst<FieldModel>} lookupTableDescriptor - Lookup table descriptor.
-     * @param {ITableDataProvider<FieldModel, ServiceType>} lookupDataProvider - Lookup data provider.
-     *
-     * @return The created many-to-many editor field.
-     */
-    addManyToManyEditor<Property extends Extract<keyof FieldsModel, keyof SchModel>, ServiceType, FieldModel = ArrayItemType<FieldsModel[Property]>, FieldValue = FieldsModel[Property]>(property: Property, mainTableDescriptor: TableDescriptorInst<FieldModel>, lookupTableDescriptor: TableDescriptorInst<FieldModel>, lookupDataProvider: ITableDataProvider<FieldModel, ServiceType>): FieldManyToManyEditorDescriptor<FieldModel, FieldsModel, ServiceType, FieldValue, Parent>;
-    /**
-     * <em>Experimental:</em> Adds a many-to-many editor field where property schema is manually provided.
-     * {EditorDescriptorInt.addFieldManyToManyEditor} is used to create field and ${setFieldBasicOptionsFromSchema} to add basic field's options from schema.
-     *
-     * @experimental
-     *
-     * @param {Property} property - The property to create the many editor field for.
-     * @param {TableDescriptorInst<FieldModel>} mainTableDescriptor - Main table descriptor.
-     * @param {TableDescriptorInst<FieldModel>} lookupTableDescriptor - Lookup table descriptor.
-     * @param {ITableDataProvider<FieldModel, ServiceType>} lookupDataProvider - Lookup data provider.
-     * @param {SchemaProperty} schemaProperty - Manually provided schema property.
-     *
-     * @return The created many-to-many editor field.
-     */
-    addManyToManyEditorFromSchema<Property extends keyof FieldsModel, ServiceType, FieldModel = ArrayItemType<FieldsModel[Property]>, FieldValue = FieldsModel[Property]>(property: Property, mainTableDescriptor: TableDescriptorInst<FieldModel>, lookupTableDescriptor: TableDescriptorInst<FieldModel>, lookupDataProvider: ITableDataProvider<FieldModel, ServiceType>, schemaProperty: SchemaProperty): FieldManyToManyEditorDescriptor<FieldModel, FieldsModel, ServiceType, FieldValue, Parent>;
-}
-/**
- * <em>Experimental:</em> Creates builder for adding fields to descriptor based on provided model schema.
- *
- * @experimental
- *
- * @param {TableviewDescriptorInst<Model, any, any, Parent, any, AddModel, EditModel, FieldsModel> | EditorDescriptorInst<Model, Parent>} descriptor - Descriptor to add fields to.
- * @param {SchemaModel<SchModel>} schema - The schema with metadata about properties for fields.
- * @param {FieldsFromSchemaOptsType<SchModel>} [opts] - Additional options.
- *
- * @return {SchemaFieldsBuilder<Model, Parent, AddModel, EditModel , FieldsModel, SchModel>} - The SchemaFieldsBuilder object containing the extracted fields.
- */
-export declare function fieldsFromSchema<Model, Parent = undefined, AddModel = Model, EditModel = Model, FieldsModel = TableviewDescriptorFieldsManageMultiType<Model, AddModel, EditModel>, SchModel = Model>(descriptor: TableviewDescriptorInst<Model, any, any, Parent, any, AddModel, EditModel, FieldsModel> | EditorDescriptorInst<FieldsModel, Parent>, schema: SchemaModel<SchModel>, opts?: FieldsFromSchemaOptsType<SchModel>): SchemaFieldsBuilder<Model, Parent, AddModel, EditModel, FieldsModel, SchModel>;
-/**
- * <em>Experimental:</em> Adds a field input to editor descriptor based on the given schema property and options.
- *
- * @experimental
- *
- * @param {TableviewDescriptorInst | EditorDescriptorInst} descriptor - Descriptor to add field to.
- * @param {keyof Model} property - The property of the model.
- * @param {SchemaProperty} propertySchema - The property's schema for the field.
- * @param {FieldInputFromSchemaOptsType<Model>} [opts] - Additional options.
- *
- * @return {FieldInputDescriptor<Model, NonNullable<Model[Property]>, Model[Property], Parent>} - The generated field input descriptor.
- */
-export declare function addFieldInputFromSchema<Property extends keyof FieldsModel, Model, Parent = unknown, AddModel = Model, EditModel = Model, FieldsModel = TableviewDescriptorFieldsManageMultiType<Model, AddModel, EditModel>>(descriptor: TableviewDescriptorInst<Model, any, any, Parent, any, AddModel, EditModel, FieldsModel> | EditorDescriptorInst<FieldsModel, Parent>, property: Property, propertySchema: SchemaProperty, opts?: FieldInputFromSchemaOptsType<FieldsModel>): FieldInputDescriptor<FieldsModel, NonNullable<FieldsModel[Property]>, FieldsModel[Property], Parent>;
-/**
- * <em>Experimental:</em> Adds a field enum lookup to editor descriptor based on the given schema property and options.
- *
- * @experimental
- *
- * @param {TableviewDescriptorInst<Model, any, any, Parent> | EditorDescriptorInst<Model, Parent>} descriptor - Descriptor to add field to.
- * @param {keyof Model} property - The property of the model.
- * @param {SchemaEnum<Enum> | EnumDescriptor<Enum>} enumOpt - The enum schema or enum model descriptor.
- * @param {SchemaProperty} propertySchema - The property's schema for the field.
- *
- * @returns {FieldLookupEnum<Enum>} - The field with enumeration values.
- */
-export declare function addFieldEnumLookupFromSchema<Model, Parent = unknown, AddModel = Model, EditModel = Model, FieldsModel = TableviewDescriptorFieldsManageMultiType<Model, AddModel, EditModel>, Enum = any>(descriptor: TableviewDescriptorInst<Model, any, any, Parent, any, AddModel, EditModel, FieldsModel> | EditorDescriptorInst<FieldsModel, Parent>, property: keyof FieldsModel, enumOpt: SchemaEnum<Enum> | EnumDescriptor<Enum>, propertySchema: SchemaProperty): FieldLookupEnumDescriptor<Enum, FieldsModel, Parent>;
-/**
- * <em>Experimental:</em> Sets basic options for a field based on a given property schema.
- *
- * @param {AFieldDescriptor<FieldModel, EditorModel, FieldValue, ParentEditorModel>} field - The field to set options for.
- * @param {SchemaProperty} propertySchema - The property schema to base the options on.
- */
-export declare function setFieldBasicOptionsFromSchema<FieldModel = any, EditorModel = any, FieldValue = FieldModel, ParentEditorModel = undefined>(field: AFieldDescriptor<FieldModel, EditorModel, FieldValue, ParentEditorModel>, propertySchema: SchemaProperty): void;
-export {};

package/tableview/schema/internal/common-from-schema.d.ts

@@ -1 +0,0 @@
-export declare function fromSchemaFilterNonArrayProperties<Model>(propertySchemas: Record<keyof Model, any>): (keyof Model)[];