@mediusinc/mng-commons-data-api 5.2.0-rc.2 → 5.3.0-rc.0

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

@@ -3,22 +3,28 @@ import { ArrayItemType, KeyofAndOfType } from '@mediusinc/mng-commons/core';
 import { EnumDescriptor, TypeDescriptor } from '@mediusinc/mng-commons/model';
 import { ITableDataProvider, TableDescriptorInst } from '@mediusinc/mng-commons/table/api';
 import { AFieldDescriptor, EditorDescriptorInst, FieldInputDescriptor, FieldLookupDescriptor, FieldLookupEnumDescriptor, FieldLookupProviderType, FieldManyEditorDescriptor, FieldManyToManyEditorDescriptor, TableviewDescriptorInst } from '@mediusinc/mng-commons/tableview/api';
-import { FromSchemaCurrencyOptsType } from './internal/common-from-schema';
 type FieldInputType = 'number' | 'currency' | 'boolean' | 'string' | 'text' | 'textarea' | 'date' | 'date-time' | 'enum' | 'hidden';
-type FieldsFromSchemaOptsType<Model = any> = {
+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>>>;
-    dateFormat?: string;
-    dateTimeFormat?: string;
 };
-type FieldInputFromSchemaOptsType<Model = any, Enum = any> = {
+type FieldInputFromSchemaOptsType<Model = any, Enum = any> = FromSchemaCommonOptsType<Model> & {
     fieldType?: FieldInputType;
     enumSchema?: SchemaEnum<Enum>;
     enumModel?: EnumDescriptor<Enum>;
-    currency?: FromSchemaCurrencyOptsType<Model>;
-    dateFormat?: string;
-    dateTimeFormat?: string;
 };
 /**
  * <em>Experimental:</em> Builder for adding fields to editor.
@@ -29,7 +35,7 @@ export declare class SchemaFieldsBuilder<Model, Parent = unknown, SchModel = Mod
     private readonly descriptor;
     private readonly schema;
     private opts?;
-    constructor(descriptor: TableviewDescriptorInst<Model, any, any, Parent> | EditorDescriptorInst<Model>, schema: SchemaModel<SchModel>, opts?: FieldsFromSchemaOptsType<SchModel> | undefined);
+    constructor(descriptor: TableviewDescriptorInst<Model, any, any, Parent> | EditorDescriptorInst<Model, Parent>, schema: SchemaModel<SchModel>, opts?: FieldsFromSchemaOptsType<SchModel> | undefined);
     private mergeFieldsInputOpts;
     private mergeFieldInputOpts;
     /**
@@ -124,7 +130,7 @@ export declare class SchemaFieldsBuilder<Model, Parent = unknown, SchModel = Mod
      *
      * @return The created lookup field.
      */
-    addLookup<Property extends Extract<keyof Model, keyof SchModel>, LookupModel = NonNullable<Model[Property]>, FieldValue = Model[Property]>(property: Property): FieldLookupDescriptor<LookupModel, Model, undefined, Model[Property], Parent>;
+    addLookup<Property extends Extract<keyof Model, keyof SchModel>, LookupModel = NonNullable<Model[Property]>>(property: Property): FieldLookupDescriptor<LookupModel, Model, undefined, Model[Property], Parent>;
     /**
      * <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.
@@ -136,7 +142,7 @@ export declare class SchemaFieldsBuilder<Model, Parent = unknown, SchModel = Mod
      *
      * @return The created lookup field.
      */
-    addLookupFromSchema<Property extends keyof Model, LookupModel = NonNullable<Model[Property]>, FieldValue = Model[Property]>(property: Property, schemaProperty: SchemaProperty): FieldLookupDescriptor<NonNullable<Model[Property]>, Model, undefined, Model[Property], Parent>;
+    addLookupFromSchema<Property extends keyof Model>(property: Property, schemaProperty: SchemaProperty): FieldLookupDescriptor<NonNullable<Model[Property]>, Model, undefined, Model[Property], Parent>;
     /**
      * <em>Experimental:</em> Adds a lookup field.
      * {EditorDescriptorInt.addFieldLookupWithOptionsValueProperty} is used to create field and ${setFieldBasicOptionsFromSchema} to add basic field's options from schema.
@@ -149,7 +155,7 @@ export declare class SchemaFieldsBuilder<Model, Parent = unknown, SchModel = Mod
      *
      * @return The created lookup field.
      */
-    addLookupWithOptionsValueProperty<Property extends Extract<keyof Model, keyof SchModel>, LookupModel, LookupValueProperty extends KeyofAndOfType<LookupModel, Model[Property]>, FieldValue = Model[Property]>(property: Property, type: TypeDescriptor<LookupModel>, lookupOptionsValueProperty: LookupValueProperty): FieldLookupDescriptor<LookupModel, Model, undefined, Model[Property], Parent>;
+    addLookupWithOptionsValueProperty<Property extends Extract<keyof Model, keyof SchModel>, LookupModel, LookupValueProperty extends KeyofAndOfType<LookupModel, Model[Property]>>(property: Property, type: TypeDescriptor<LookupModel>, lookupOptionsValueProperty: LookupValueProperty): FieldLookupDescriptor<LookupModel, Model, undefined, Model[Property], Parent>;
     /**
      * <em>Experimental:</em> Adds a lookup field where property schema is manually provided.
      * {EditorDescriptorInt.addFieldLookupWithOptionsValueProperty} is used to create field and ${setFieldBasicOptionsFromSchema} to add basic field's options from schema.
@@ -163,7 +169,7 @@ export declare class SchemaFieldsBuilder<Model, Parent = unknown, SchModel = Mod
      *
      * @return The created lookup field.
      */
-    addLookupWithOptionsValuePropertyFromSchema<Property extends keyof Model, LookupModel, LookupValueProperty extends KeyofAndOfType<LookupModel, Model[Property]>, FieldValue = Model[Property]>(property: Property, type: TypeDescriptor<LookupModel>, lookupOptionsValueProperty: LookupValueProperty, schemaProperty: SchemaProperty): FieldLookupDescriptor<LookupModel, Model, undefined, Model[Property], Parent>;
+    addLookupWithOptionsValuePropertyFromSchema<Property extends keyof Model, LookupModel, LookupValueProperty extends KeyofAndOfType<LookupModel, Model[Property]>>(property: Property, type: TypeDescriptor<LookupModel>, lookupOptionsValueProperty: LookupValueProperty, schemaProperty: SchemaProperty): FieldLookupDescriptor<LookupModel, Model, undefined, Model[Property], Parent>;
     /**
      * <em>Experimental:</em> Adds a lookup field.
      * {EditorDescriptorInt.addFieldLookupWithProvider} is used to create field and ${setFieldBasicOptionsFromSchema} to add basic field's options from schema.
@@ -175,7 +181,7 @@ export declare class SchemaFieldsBuilder<Model, Parent = unknown, SchModel = Mod
      *
      * @return The created lookup field.
      */
-    addLookupWithProvider<Property extends Extract<keyof Model, keyof SchModel>, Service, LookupModel = NonNullable<Model[Property]>, FieldValue = Model[Property]>(property: Property, provider: FieldLookupProviderType<LookupModel, Service>): FieldLookupDescriptor<LookupModel, Model, Service, Model[Property], Parent>;
+    addLookupWithProvider<Property extends Extract<keyof Model, keyof SchModel>, Service, LookupModel = NonNullable<Model[Property]>>(property: Property, provider: FieldLookupProviderType<LookupModel, Service>): FieldLookupDescriptor<LookupModel, Model, Service, Model[Property], Parent>;
     /**
      * <em>Experimental:</em> Adds a lookup field where property schema is manually provided.
      * {EditorDescriptorInt.addFieldLookupWithProvider} is used to create field and ${setFieldBasicOptionsFromSchema} to add basic field's options from schema.
@@ -188,7 +194,7 @@ export declare class SchemaFieldsBuilder<Model, Parent = unknown, SchModel = Mod
      *
      * @return The created lookup field.
      */
-    addLookupWithProviderFromSchema<Property extends keyof Model, Service, LookupModel = NonNullable<Model[Property]>, FieldValue = Model[Property]>(property: Property, provider: FieldLookupProviderType<LookupModel, Service>, schemaProperty: SchemaProperty): FieldLookupDescriptor<LookupModel, Model, Service, Model[Property], Parent>;
+    addLookupWithProviderFromSchema<Property extends keyof Model, Service, LookupModel = NonNullable<Model[Property]>>(property: Property, provider: FieldLookupProviderType<LookupModel, Service>, schemaProperty: SchemaProperty): FieldLookupDescriptor<LookupModel, Model, Service, Model[Property], Parent>;
     /**
      * <em>Experimental:</em> Adds a lookup field.
      * {EditorDescriptorInt.addFieldLookupWithProviderAndOptionsValueProperty} is used to create field and ${setFieldBasicOptionsFromSchema} to add basic field's options from schema.
@@ -202,7 +208,7 @@ export declare class SchemaFieldsBuilder<Model, Parent = unknown, SchModel = Mod
      *
      * @return The created lookup field.
      */
-    addLookupWithProviderAndOptionsValueProperty<Property extends Extract<keyof Model, keyof SchModel>, Service, LookupModel, LookupValueProperty extends KeyofAndOfType<LookupModel, Model[Property]>, FieldValue = Model[Property]>(property: Property, provider: FieldLookupProviderType<LookupModel, Service>, type: TypeDescriptor<LookupModel>, lookupOptionsValueProperty: LookupValueProperty): FieldLookupDescriptor<LookupModel, Model, Service, FieldValue>;
+    addLookupWithProviderAndOptionsValueProperty<Property extends Extract<keyof Model, keyof SchModel>, Service, LookupModel, LookupValueProperty extends KeyofAndOfType<LookupModel, Model[Property]>, FieldValue = Model[Property]>(property: Property, provider: FieldLookupProviderType<LookupModel, Service>, type: TypeDescriptor<LookupModel>, lookupOptionsValueProperty: LookupValueProperty): FieldLookupDescriptor<LookupModel, Model, Service, FieldValue, Parent>;
     /**
      * <em>Experimental:</em> Adds a lookup field where property schema is manually provided.
      * {EditorDescriptorInt.addFieldLookupWithProviderAndOptionsValueProperty} is used to create field and ${setFieldBasicOptionsFromSchema} to add basic field's options from schema.
@@ -217,7 +223,7 @@ export declare class SchemaFieldsBuilder<Model, Parent = unknown, SchModel = Mod
      *
      * @return The created lookup field.
      */
-    addLookupWithProviderAndOptionsValuePropertyFromSchema<Property extends keyof Model, Service, LookupModel, LookupValueProperty extends KeyofAndOfType<LookupModel, Model[Property]>, FieldValue = Model[Property]>(property: Property, provider: FieldLookupProviderType<LookupModel, Service>, type: TypeDescriptor<LookupModel>, lookupOptionsValueProperty: LookupValueProperty, schemaProperty: SchemaProperty): FieldLookupDescriptor<LookupModel, Model, Service, FieldValue>;
+    addLookupWithProviderAndOptionsValuePropertyFromSchema<Property extends keyof Model, Service, LookupModel, LookupValueProperty extends KeyofAndOfType<LookupModel, Model[Property]>, FieldValue = Model[Property]>(property: Property, provider: FieldLookupProviderType<LookupModel, Service>, type: TypeDescriptor<LookupModel>, lookupOptionsValueProperty: LookupValueProperty, schemaProperty: SchemaProperty): FieldLookupDescriptor<LookupModel, Model, Service, FieldValue, Parent>;
     /**
      * <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.
@@ -229,7 +235,7 @@ export declare class SchemaFieldsBuilder<Model, Parent = unknown, SchModel = Mod
      *
      * @return The created one-to-many editor field.
      */
-    addManyEditor<Property extends Extract<keyof Model, keyof SchModel>, FieldModel = ArrayItemType<Model[Property]>, FieldValue = Model[Property]>(property: Property, tableviewDescriptor: TableviewDescriptorInst<FieldModel, any, any, Model>): FieldManyEditorDescriptor<FieldModel, Model, FieldValue>;
+    addManyEditor<Property extends Extract<keyof Model, keyof SchModel>, FieldModel = ArrayItemType<Model[Property]>, FieldValue = Model[Property]>(property: Property, tableviewDescriptor: TableviewDescriptorInst<FieldModel, any, any, Model>): FieldManyEditorDescriptor<FieldModel, Model, 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.
@@ -242,7 +248,7 @@ export declare class SchemaFieldsBuilder<Model, Parent = unknown, SchModel = Mod
      *
      * @return The created one-to-many editor field.
      */
-    addManyEditorFromSchema<Property extends keyof Model, FieldModel = ArrayItemType<Model[Property]>, FieldValue = Model[Property]>(property: Property, tableviewDescriptor: TableviewDescriptorInst<FieldModel, any, any, Model>, schemaProperty: SchemaProperty): FieldManyEditorDescriptor<FieldModel, Model, FieldValue>;
+    addManyEditorFromSchema<Property extends keyof Model, FieldModel = ArrayItemType<Model[Property]>, FieldValue = Model[Property]>(property: Property, tableviewDescriptor: TableviewDescriptorInst<FieldModel, any, any, Model>, schemaProperty: SchemaProperty): FieldManyEditorDescriptor<FieldModel, Model, 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.
@@ -256,7 +262,7 @@ export declare class SchemaFieldsBuilder<Model, Parent = unknown, SchModel = Mod
      *
      * @return The created many-to-many editor field.
      */
-    addManyToManyEditor<Property extends Extract<keyof Model, keyof SchModel>, ServiceType, FieldModel = ArrayItemType<Model[Property]>, FieldValue = Model[Property]>(property: Property, mainTableDescriptor: TableDescriptorInst<FieldModel>, lookupTableDescriptor: TableDescriptorInst<FieldModel>, lookupDataProvider: ITableDataProvider<FieldModel, ServiceType>): FieldManyToManyEditorDescriptor<FieldModel, Model, ServiceType, FieldValue>;
+    addManyToManyEditor<Property extends Extract<keyof Model, keyof SchModel>, ServiceType, FieldModel = ArrayItemType<Model[Property]>, FieldValue = Model[Property]>(property: Property, mainTableDescriptor: TableDescriptorInst<FieldModel>, lookupTableDescriptor: TableDescriptorInst<FieldModel>, lookupDataProvider: ITableDataProvider<FieldModel, ServiceType>): FieldManyToManyEditorDescriptor<FieldModel, Model, 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.
@@ -271,20 +277,20 @@ export declare class SchemaFieldsBuilder<Model, Parent = unknown, SchModel = Mod
      *
      * @return The created many-to-many editor field.
      */
-    addManyToManyEditorFromSchema<Property extends keyof Model, ServiceType, FieldModel = ArrayItemType<Model[Property]>, FieldValue = Model[Property]>(property: Property, mainTableDescriptor: TableDescriptorInst<FieldModel>, lookupTableDescriptor: TableDescriptorInst<FieldModel>, lookupDataProvider: ITableDataProvider<FieldModel, ServiceType>, schemaProperty: SchemaProperty): FieldManyToManyEditorDescriptor<FieldModel, Model, ServiceType, FieldValue>;
+    addManyToManyEditorFromSchema<Property extends keyof Model, ServiceType, FieldModel = ArrayItemType<Model[Property]>, FieldValue = Model[Property]>(property: Property, mainTableDescriptor: TableDescriptorInst<FieldModel>, lookupTableDescriptor: TableDescriptorInst<FieldModel>, lookupDataProvider: ITableDataProvider<FieldModel, ServiceType>, schemaProperty: SchemaProperty): FieldManyToManyEditorDescriptor<FieldModel, Model, 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> | EditorDescriptorInst<Model>} descriptor - Descriptor to add fields to.
+ * @param {TableviewDescriptorInst<Model, any, any, Parent> | 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, SchModel>} - The SchemaFieldsBuilder object containing the extracted fields.
  */
-export declare function fieldsFromSchema<Model, Parent = unknown, SchModel = Model>(descriptor: TableviewDescriptorInst<Model, any, any, Parent> | EditorDescriptorInst<Model>, schema: SchemaModel<SchModel>, opts?: FieldsFromSchemaOptsType<SchModel>): SchemaFieldsBuilder<Model, Parent, SchModel>;
+export declare function fieldsFromSchema<Model, Parent = unknown, SchModel = Model>(descriptor: TableviewDescriptorInst<Model, any, any, Parent> | EditorDescriptorInst<Model, Parent>, schema: SchemaModel<SchModel>, opts?: FieldsFromSchemaOptsType<SchModel>): SchemaFieldsBuilder<Model, Parent, SchModel>;
 /**
  * <em>Experimental:</em> Adds a field input to editor descriptor based on the given schema property and options.
  *
@@ -297,20 +303,20 @@ export declare function fieldsFromSchema<Model, Parent = unknown, SchModel = Mod
  *
  * @return {FieldInputDescriptor<Model, NonNullable<Model[Property]>, Model[Property], Parent>} - The generated field input descriptor.
  */
-export declare function addFieldInputFromSchema<Property extends keyof Model, Model, Parent = unknown>(descriptor: TableviewDescriptorInst<Model, any, any, Parent> | EditorDescriptorInst<Model>, property: Property, propertySchema: SchemaProperty, opts?: FieldInputFromSchemaOptsType<Model>): FieldInputDescriptor<Model, NonNullable<Model[Property]>, Model[Property], Parent>;
+export declare function addFieldInputFromSchema<Property extends keyof Model, Model, Parent = unknown>(descriptor: TableviewDescriptorInst<Model, any, any, Parent> | EditorDescriptorInst<Model, Parent>, property: Property, propertySchema: SchemaProperty, opts?: FieldInputFromSchemaOptsType<Model>): FieldInputDescriptor<Model, NonNullable<Model[Property]>, Model[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>} descriptor - Descriptor to add field to.
+ * @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, Enum = any>(descriptor: TableviewDescriptorInst<Model, any, any, Parent> | EditorDescriptorInst<Model>, property: keyof Model, enumOpt: SchemaEnum<Enum> | EnumDescriptor<Enum>, propertySchema: SchemaProperty): FieldLookupEnumDescriptor<Enum, Model, Parent>;
+export declare function addFieldEnumLookupFromSchema<Model, Parent = unknown, Enum = any>(descriptor: TableviewDescriptorInst<Model, any, any, Parent> | EditorDescriptorInst<Model, Parent>, property: keyof Model, enumOpt: SchemaEnum<Enum> | EnumDescriptor<Enum>, propertySchema: SchemaProperty): FieldLookupEnumDescriptor<Enum, Model, Parent>;
 /**
  * <em>Experimental:</em> Sets basic options for a field based on a given property schema.
  *

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

@@ -1,11 +1 @@
-export type FromSchemaCurrencyOptsType<Model> = string | {
-    currencyProperty?: keyof Model;
-    currency?: string;
-    currencyDisplay?: 'symbol' | 'code' | 'name';
-};
-export declare function fromSchemaCurrencyOptsToCurrency<Model>(opts: FromSchemaCurrencyOptsType<Model>): {
-    currency: string | undefined;
-    currencyDisplay: "symbol" | "name" | "code" | undefined;
-    currencyProperty: keyof Model | undefined;
-};
 export declare function fromSchemaFilterNonArrayProperties<Model>(propertySchemas: Record<keyof Model, any>): (keyof Model)[];

package/version-info.json

@@ -1,11 +1,11 @@
 {
     "name": "@mediusinc/mng-commons-data-api",
-    "version": "5.2.0-rc.2",
+    "version": "5.3.0-rc.0",
     "tag": "v5.2.0-rc.2",
-    "distance": 0,
-    "hash": "41eee2dc",
+    "distance": 15,
+    "hash": "9b56542d",
     "dirty": true,
-    "semver": "5.2.0-rc.2+0.g41eee2dc.dirty",
+    "semver": "5.2.0-rc.2+15.g9b56542d.dirty",
     "buildTimestamp": null,
-    "raw": "v5.2.0-rc.2-41eee2dc-dirty"
+    "raw": "v5.2.0-rc.2-15-9b56542d-dirty"
 }