@ng-formworks/core 19.6.3 → 20.6.3

package/lib/shared/form-group.functions.d.ts

@@ -1,128 +0,0 @@
-import { AbstractControl } from '@angular/forms';
-import { Pointer } from './jsonpointer.functions';
-/**
- * path2ControlKey takes a datapointer path like /some/pointer/path
- * and returns something like $some$pointer$path
- * used mainly to convert paths so it can be used as keys in FormGroups
- * fot ITE scenarios
- * @param path
- * @returns string
- */
-export declare function path2ControlKey(path: string): string;
-/**
- * FormGroup function library:
- *
- * buildFormGroupTemplate:  Builds a FormGroupTemplate from schema
- *
- * buildFormGroup:          Builds an Angular FormGroup from a FormGroupTemplate
- *
- * mergeValues:
- *
- * setRequiredFields:
- *
- * formatFormData:
- *
- * getControl:
- *
- * ---- TODO: ----
- * TODO: add buildFormGroupTemplateFromLayout function
- * buildFormGroupTemplateFromLayout: Builds a FormGroupTemplate from a form layout
- */
-/**
- * 'buildFormGroupTemplate' function
- *
- * Builds a template for an Angular FormGroup from a JSON Schema.
- *
- * TODO: add support for pattern properties
- * https://spacetelescope.github.io/understanding-json-schema/reference/object.html
- *
- * //  {any} jsf -
- * //  {any = null} nodeValue -
- * //  {boolean = true} mapArrays -
- * //  {string = ''} schemaPointer -
- * //  {string = ''} dataPointer -
- * //  {any = ''} templatePointer -
- * // {any} -
- */
-export declare function buildFormGroupTemplate(jsf: any, nodeValue?: any, setValues?: boolean, schemaPointer?: string, dataPointer?: string, templatePointer?: string): {
-    controlType: string;
-    controls: any;
-    validators: any;
-    schemaPointer: string;
-    value?: undefined;
-} | {
-    controlType: string;
-    value: {
-        value: any;
-        disabled: any;
-    };
-    validators: any;
-    schemaPointer: string;
-    controls?: undefined;
-};
-/**
- * 'buildFormGroup' function
- *
- * // {any} template -
- * // {AbstractControl}
-*/
-export declare function buildFormGroup(template: any): AbstractControl;
-/**
- * 'mergeValues' function
- *
- * //  {any[]} ...valuesToMerge - Multiple values to merge
- * // {any} - Merged values
- */
-export declare function mergeValues(...valuesToMerge: any[]): any;
-/**
- * 'setRequiredFields' function
- *
- * // {schema} schema - JSON Schema
- * // {object} formControlTemplate - Form Control Template object
- * // {boolean} - true if any fields have been set to required, false if not
- */
-export declare function setRequiredFields(schema: any, formControlTemplate: any): boolean;
-/**
- * 'formatFormData' function
- *
- * // {any} formData - Angular FormGroup data object
- * // {Map<string, any>} dataMap -
- * // {Map<string, string>} recursiveRefMap -
- * // {Map<string, number>} arrayMap -
- * // {boolean = false} fixErrors - if TRUE, tries to fix data
- * // {any} - formatted data object
- */
-export declare function formatFormData(formData: any, dataMap: Map<string, any>, recursiveRefMap: Map<string, string>, arrayMap: Map<string, number>, returnEmptyFields?: boolean, fixErrors?: boolean): any;
-/**
- * 'getControl' function
- *
- * Uses a JSON Pointer for a data object to retrieve a control from
- * an Angular formGroup or formGroup template. (Note: though a formGroup
- * template is much simpler, its basic structure is idential to a formGroup).
- *
- * If the optional third parameter 'returnGroup' is set to TRUE, the group
- * containing the control is returned, rather than the control itself.
- *
- * // {FormGroup} formGroup - Angular FormGroup to get value from
- * // {Pointer} dataPointer - JSON Pointer (string or array)
- * // {boolean = false} returnGroup - If true, return group containing control
- * // {group} - Located value (or null, if no control found)
- * // {string} schemaPointer - string used for conditional controls coming from schema if/then/else
- */
-export declare function getControl(formGroup: any, dataPointer: Pointer, returnGroup?: boolean, schemaPointer?: string): any;
-/**
- * 'setControl' function
- *
- * Uses a JSON Pointer for a data object to retrieve a control from
- * an Angular formGroup or formGroup template. (Note: though a formGroup
- * template is much simpler, its basic structure is idential to a formGroup).
- *
- * If the optional third parameter 'returnGroup' is set to TRUE, the group
- * containing the control is returned, rather than the control itself.
- *
- * // {FormGroup} formGroup - Angular FormGroup to get value from
- * // {Pointer} dataPointer - JSON Pointer (string or array)
- * // {AbstractControl} control - control used to replace existing or add
- * // {targetKey} - optional string used as the new key-not implemented as yet
- */
-export declare function setControl(formGroup: any, dataPointer: Pointer, control: AbstractControl, targetKey?: string): any;

package/lib/shared/format-regex.constants.d.ts

@@ -1,20 +0,0 @@
-export declare const jsonSchemaFormatTests: {
-    date: RegExp;
-    time: RegExp;
-    'date-time': RegExp;
-    email: RegExp;
-    hostname: RegExp;
-    ipv4: RegExp;
-    ipv6: RegExp;
-    uri: RegExp;
-    'uri-reference': RegExp;
-    'uri-template': RegExp;
-    url: RegExp;
-    uuid: RegExp;
-    color: RegExp;
-    'json-pointer': RegExp;
-    'relative-json-pointer': RegExp;
-    duration: RegExp;
-    regex: (str: any) => boolean;
-};
-export type JsonSchemaFormatNames = 'date' | 'time' | 'date-time' | 'email' | 'hostname' | 'ipv4' | 'ipv6' | 'uri' | 'uri-reference' | 'uri-template' | 'url' | 'uuid' | 'color' | 'json-pointer' | 'relative-json-pointer' | 'duration' | 'regex';

package/lib/shared/index.d.ts

@@ -1,9 +0,0 @@
-export { _executeAsyncValidators, _executeValidators, _mergeErrors, _mergeObjects, _toPromise, AsyncIValidatorFn, getType, hasValue, inArray, isArray, isBoolean, isDate, isDefined, isEmpty, isFunction, isInteger, isMap, isNumber, isObject, isObservable, isPrimitive, isPromise, isSet, isString, isType, IValidatorFn, JavaScriptPrimitiveType, JavaScriptType, PlainObject, PrimitiveValue, SchemaPrimitiveType, SchemaType, toJavaScriptType, toObservable, toSchemaType, xor } from './validator.functions';
-export { addClasses, commonItems, copy, fixTitle, forEach, forEachCopy, hasNonNullValue, hasOwn, mergeFilteredObject, toTitleCase, uniqueItems } from './utility.functions';
-export { JsonPointer, Pointer } from './jsonpointer.functions';
-export { JsonValidators } from './json.validators';
-export { buildSchemaFromData, buildSchemaFromLayout, checkInlineType, combineAllOf, fixRequiredArrayProperties, getControlValidators, getFromSchema, getInputType, getSubSchema, getTitleMapFromOneOf, isInputRequired, removeRecursiveReferences, resolveSchemaReferences, updateInputOptions } from './json-schema.functions';
-export { convertSchemaToDraft6 } from './convert-schema-to-draft6.function';
-export { mergeSchemas } from './merge-schemas.function';
-export { buildFormGroup, buildFormGroupTemplate, formatFormData, getControl, path2ControlKey, setControl, setRequiredFields } from './form-group.functions';
-export { buildLayout, buildLayoutFromSchema, buildTitleMap, getLayoutNode, mapLayout } from './layout.functions';

package/lib/shared/json-schema.functions.d.ts

@@ -1,214 +0,0 @@
-/**
- * JSON Schema function library:
- *
- * buildSchemaFromLayout:   TODO: Write this function
- *
- * buildSchemaFromData:
- *
- * getFromSchema:
- *
- * removeRecursiveReferences:
- *
- * getInputType:
- *
- * checkInlineType:
- *
- * isInputRequired:
- *
- * updateInputOptions:
- *
- * getTitleMapFromOneOf:
- *
- * getControlValidators:
- *
- * resolveSchemaReferences:
- *
- * getSubSchema:
- *
- * combineAllOf:
- *
- * fixRequiredArrayProperties:
- */
-/**
- * 'buildSchemaFromLayout' function
- *
- * TODO: Build a JSON Schema from a JSON Form layout
- *
- * //   layout - The JSON Form layout
- * //  - The new JSON Schema
- */
-export declare function buildSchemaFromLayout(layout: any): void;
-/**
- * 'buildSchemaFromData' function
- *
- * Build a JSON Schema from a data object
- *
- * //   data - The data object
- * //  { boolean = false } requireAllFields - Require all fields?
- * //  { boolean = true } isRoot - is root
- * //  - The new JSON Schema
- */
-export declare function buildSchemaFromData(data: any, requireAllFields?: boolean, isRoot?: boolean): any;
-/**
- * 'getFromSchema' function
- *
- * Uses a JSON Pointer for a value within a data object to retrieve
- * the schema for that value within schema for the data object.
- *
- * The optional third parameter can also be set to return something else:
- * 'schema' (default): the schema for the value indicated by the data pointer
- * 'parentSchema': the schema for the value's parent object or array
- * 'schemaPointer': a pointer to the value's schema within the object's schema
- * 'parentSchemaPointer': a pointer to the schema for the value's parent object or array
- *
- * //   schema - The schema to get the sub-schema from
- * //  { Pointer } dataPointer - JSON Pointer (string or array)
- * //  { string = 'schema' } returnType - what to return?
- * //  - The located sub-schema
- */
-export declare function getFromSchema(schema: any, dataPointer: any, returnType?: string): any;
-/**
- * 'removeRecursiveReferences' function
- *
- * Checks a JSON Pointer against a map of recursive references and returns
- * a JSON Pointer to the shallowest equivalent location in the same object.
- *
- * Using this functions enables an object to be constructed with unlimited
- * recursion, while maintaing a fixed set of metadata, such as field data types.
- * The object can grow as large as it wants, and deeply recursed nodes can
- * just refer to the metadata for their shallow equivalents, instead of having
- * to add additional redundant metadata for each recursively added node.
- *
- * Example:
- *
- * pointer:         '/stuff/and/more/and/more/and/more/and/more/stuff'
- * recursiveRefMap: [['/stuff/and/more/and/more', '/stuff/and/more/']]
- * returned:        '/stuff/and/more/stuff'
- *
- * //  { Pointer } pointer -
- * //  { Map<string, string> } recursiveRefMap -
- * //  { Map<string, number> = new Map() } arrayMap - optional
- * // { string } -
- */
-export declare function removeRecursiveReferences(pointer: any, recursiveRefMap: any, arrayMap?: Map<any, any>): any;
-/**
- * 'getInputType' function
- *
- * //   schema
- * //  { any = null } layoutNode
- * // { string }
- */
-export declare function getInputType(schema: any, layoutNode?: any): any;
-/**
- * 'checkInlineType' function
- *
- * Checks layout and schema nodes for 'inline: true', and converts
- * 'radios' or 'checkboxes' to 'radios-inline' or 'checkboxes-inline'
- *
- * //  { string } controlType -
- * //   schema -
- * //  { any = null } layoutNode -
- * // { string }
- */
-export declare function checkInlineType(controlType: any, schema: any, layoutNode?: any): any;
-/**
- * 'isInputRequired' function
- *
- * Checks a JSON Schema to see if an item is required
- *
- * //   schema - the schema to check
- * //  { string } schemaPointer - the pointer to the item to check
- * // { boolean } - true if the item is required, false if not
- */
-export declare function isInputRequired(schema: any, schemaPointer: any): any;
-/**
- * 'updateInputOptions' function
- *
- * //   layoutNode
- * //   schema
- * //   jsf
- * // { void }
- */
-export declare function updateInputOptions(layoutNode: any, schema: any, jsf: any): void;
-/**
- * 'getTitleMapFromOneOf' function
- *
- * //  { schema } schema
- * //  { boolean = null } flatList
- * //  { boolean = false } validateOnly
- * // { validators }
- */
-export declare function getTitleMapFromOneOf(schema?: any, flatList?: boolean, validateOnly?: boolean): any;
-/**
- * 'getControlValidators' function
- *
- * //  schema
- * // { validators }
- */
-export declare function getControlValidators(schema: any): any;
-/**
- * 'resolveSchemaReferences' function
- *
- * Find all $ref links in schema and save links and referenced schemas in
- * schemaRefLibrary, schemaRecursiveRefMap, and dataRecursiveRefMap
- *
- * //  schema
- * //  schemaRefLibrary
- * // { Map<string, string> } schemaRecursiveRefMap
- * // { Map<string, string> } dataRecursiveRefMap
- * // { Map<string, number> } arrayMap
- * //
- */
-export declare function resolveSchemaReferences(schema: any, schemaRefLibrary: any, schemaRecursiveRefMap: any, dataRecursiveRefMap: any, arrayMap: any): any;
-/**
- * 'getSubSchema' function
- *
- * //   schema
- * //  { Pointer } pointer
- * //  { object } schemaRefLibrary
- * //  { Map<string, string> } schemaRecursiveRefMap
- * //  { string[] = [] } usedPointers
- * //
- */
-export declare function getSubSchema(schema: any, pointer: any, schemaRefLibrary?: any, schemaRecursiveRefMap?: Map<string, string>, usedPointers?: string[]): any;
-export declare function omitKeys<T extends object>(objects: T[], keysToOmit: (keyof T)[]): Omit<T, keyof T>[];
-export declare function combineAllOfITE(schema: any): void;
-/**
- * 'combineAllOf' function
- *
- * Attempt to convert an allOf schema object into
- * a non-allOf schema object with equivalent rules.
- *
- * //   schema - allOf schema object
- * //  - converted schema object
- */
-export declare function combineAllOf(schema: any): any;
-/**
- * 'fixRequiredArrayProperties' function
- *
- * Fixes an incorrectly placed required list inside an array schema, by moving
- * it into items.properties or additionalItems.properties, where it belongs.
- *
- * //   schema - allOf schema object
- * //  - converted schema object
- */
-export declare function fixRequiredArrayProperties(schema: any): any;
-/**
- * 'convertJSONSchemaIfToCondition' function
- * converts something like
- * "if": {
- *   "properties": {
- *     "animal": {
- *       "const": "Cat"
- *     },
- *     "habitat":{
- *        "const": "City"
- *      }
- *   }
- * }
- * to "model.animal=='Cat' && habitat=='City" contion
- * @param schema:any
- * @param negate:boolean=false
- * @returns
- */
-export declare function convertJSONSchemaIfToCondition(schema: any, layoutNode: any, negate?: boolean): {};