memorial-ui-component-library 1.0.4-dev.2396 → 1.1.0

package/types/async-validator.d.ts

@@ -1,147 +1,147 @@
-interface RuleProperty {
-  /**
-   * Indicates the type of validator to use.
-   */
-  type?:
-    | 'string'
-    | 'number'
-    | 'boolean'
-    | 'method'
-    | 'regexp'
-    | 'integer'
-    | 'float'
-    | 'array'
-    | 'object'
-    | 'enum'
-    | 'date'
-    | 'url'
-    | 'hex'
-    | 'email';
-  /**
-   * Indicates that the field must exist on the source object being validated.
-   */
-  required?: boolean;
-  /**
-   * Custom validate function.
-   */
-  validator?: (
-    rule: RuleProperty,
-    value: any,
-    callback: (error?: Error) => void
-  ) => void | boolean | Error | Error[];
-  /**
-   * Custom async validate function.
-   */
-  asyncValidator?: (
-    rule: RuleProperty,
-    value: any,
-    callback: (error?: Error) => void
-  ) => Promise<void | boolean | Error | Error[]>;
-  /**
-   * Validate deep object properties you may do so for validation rules that are of the object or array type.
-   * @example
-   * var descriptor = {
-        address: {
-          type: "object", required: true, options: {single: true, first: true},
-          fields: {
-            street: {type: "string", required: true},
-            city: {type: "string", required: true},
-            zip: {type: "string", required: true, len: 8, message: "invalid zip"}
-          }
-        },
-        name: {type: "string", required: true}
-    }
-   *
-   * var descriptor = {
-        roles: {
-          type: "array", required: true, len: 3,
-          fields: {
-            0: {type: "string", required: true},
-            1: {type: "string", required: true},
-            2: {type: "string", required: true}
-          }
-        }
-      }
-   */
-  fields?: SchemaDescriptor;
-  /**
-   * Indicates a regular expression that the value must match to pass validation.
-   */
-  pattern?: RegExp;
-  /**
-   * Minimum value within a range. For string and array types comparison is performed against the length, for number types the number must not be less than min.
-   */
-  min?: number;
-  /**
-   * Minimum value within a range. For string and array types comparison is performed against the length, for number types the number must not be greater than max.
-   */
-  max?: number;
-  /**
-   * Exact length of the value. For string and array types comparison is performed on the length property, for the number type this property indicates an exact match for the number, ie, it may only be strictly equal to len.
-   */
-  len?: number;
-  /**
-   * To validate a value from a list of possible values use the enum type with a enum property listing the valid values for the field.
-   * @example
-   * var descriptor = {
-        role: {type: "enum", enum: ['admin', 'user', 'guest']}
-      }
-   */
-  enum?: any[];
-  /**
-   * Test for a string that consists solely of whitespace. The rule must be a string type.
-   */
-  whitespace?: boolean;
-  /**
-   * Can be used with the array or object type for validating all values of the container. It may be an object or array containing validation rules.
-   * @example
-   * var descriptor = {
-        urls: {
-          type: "array", required: true,
-          defaultField: {type: "url"}
-        }
-      }
-   */
-  defaultField?: RuleProperty | RuleProperty[];
-  /**
-   * Transform a value before validation. The property is transformed prior to validation and re-assigned to the source object to mutate the value of the property in place.
-   */
-  transform?: (value: any) => any;
-  /**
-   * Message to display in the event of a validation error.
-   */
-  message?: string | Function | any /* JSX.Element */;
-}
-
-export interface SchemaDescriptor {
-  [modelProp: string]: RuleProperty | RuleProperty[];
-  [arrIndex: number]: RuleProperty | RuleProperty[];
-}
-
-export interface ValidationOptions {
-  /**
-   * Whether tu suppress internal warning logged to console about invalid fields
-   */
-  suppressWarning?: boolean;
-  /**
-   * Invoke callback when the first validation rule generates an error, no more validation rules are processed. If your validation involves multiple asynchronous calls (for example, database queries) and you only need the first error use this option.
-   */
-  first?: boolean;
-  /**
-   * Invoke callback when the first validation rule of the specified field generates an error, no more validation rules of the same field are processed. true means all fields.
-   */
-  firstFields?: boolean | string[];
-}
-
-export interface ValidationError {
-  message: string | Function | any /* JSX.Element */;
-  field: string;
-}
-
-export class ValidationResult {
-  errors: ValidationError[];
-  fields: {
-    [modelProp: string]: ValidationError[];
-    [arrIndex: number]: ValidationError[];
-  };
-}
+interface RuleProperty {
+  /**
+   * Indicates the type of validator to use.
+   */
+  type?:
+    | 'string'
+    | 'number'
+    | 'boolean'
+    | 'method'
+    | 'regexp'
+    | 'integer'
+    | 'float'
+    | 'array'
+    | 'object'
+    | 'enum'
+    | 'date'
+    | 'url'
+    | 'hex'
+    | 'email';
+  /**
+   * Indicates that the field must exist on the source object being validated.
+   */
+  required?: boolean;
+  /**
+   * Custom validate function.
+   */
+  validator?: (
+    rule: RuleProperty,
+    value: any,
+    callback: (error?: Error) => void
+  ) => void | boolean | Error | Error[];
+  /**
+   * Custom async validate function.
+   */
+  asyncValidator?: (
+    rule: RuleProperty,
+    value: any,
+    callback: (error?: Error) => void
+  ) => Promise<void | boolean | Error | Error[]>;
+  /**
+   * Validate deep object properties you may do so for validation rules that are of the object or array type.
+   * @example
+   * var descriptor = {
+        address: {
+          type: "object", required: true, options: {single: true, first: true},
+          fields: {
+            street: {type: "string", required: true},
+            city: {type: "string", required: true},
+            zip: {type: "string", required: true, len: 8, message: "invalid zip"}
+          }
+        },
+        name: {type: "string", required: true}
+    }
+   *
+   * var descriptor = {
+        roles: {
+          type: "array", required: true, len: 3,
+          fields: {
+            0: {type: "string", required: true},
+            1: {type: "string", required: true},
+            2: {type: "string", required: true}
+          }
+        }
+      }
+   */
+  fields?: SchemaDescriptor;
+  /**
+   * Indicates a regular expression that the value must match to pass validation.
+   */
+  pattern?: RegExp;
+  /**
+   * Minimum value within a range. For string and array types comparison is performed against the length, for number types the number must not be less than min.
+   */
+  min?: number;
+  /**
+   * Minimum value within a range. For string and array types comparison is performed against the length, for number types the number must not be greater than max.
+   */
+  max?: number;
+  /**
+   * Exact length of the value. For string and array types comparison is performed on the length property, for the number type this property indicates an exact match for the number, ie, it may only be strictly equal to len.
+   */
+  len?: number;
+  /**
+   * To validate a value from a list of possible values use the enum type with a enum property listing the valid values for the field.
+   * @example
+   * var descriptor = {
+        role: {type: "enum", enum: ['admin', 'user', 'guest']}
+      }
+   */
+  enum?: any[];
+  /**
+   * Test for a string that consists solely of whitespace. The rule must be a string type.
+   */
+  whitespace?: boolean;
+  /**
+   * Can be used with the array or object type for validating all values of the container. It may be an object or array containing validation rules.
+   * @example
+   * var descriptor = {
+        urls: {
+          type: "array", required: true,
+          defaultField: {type: "url"}
+        }
+      }
+   */
+  defaultField?: RuleProperty | RuleProperty[];
+  /**
+   * Transform a value before validation. The property is transformed prior to validation and re-assigned to the source object to mutate the value of the property in place.
+   */
+  transform?: (value: any) => any;
+  /**
+   * Message to display in the event of a validation error.
+   */
+  message?: string | Function | any /* JSX.Element */;
+}
+
+export interface SchemaDescriptor {
+  [modelProp: string]: RuleProperty | RuleProperty[];
+  [arrIndex: number]: RuleProperty | RuleProperty[];
+}
+
+export interface ValidationOptions {
+  /**
+   * Whether tu suppress internal warning logged to console about invalid fields
+   */
+  suppressWarning?: boolean;
+  /**
+   * Invoke callback when the first validation rule generates an error, no more validation rules are processed. If your validation involves multiple asynchronous calls (for example, database queries) and you only need the first error use this option.
+   */
+  first?: boolean;
+  /**
+   * Invoke callback when the first validation rule of the specified field generates an error, no more validation rules of the same field are processed. true means all fields.
+   */
+  firstFields?: boolean | string[];
+}
+
+export interface ValidationError {
+  message: string | Function | any /* JSX.Element */;
+  field: string;
+}
+
+export class ValidationResult {
+  errors: ValidationError[];
+  fields: {
+    [modelProp: string]: ValidationError[];
+    [arrIndex: number]: ValidationError[];
+  };
+}

package/types/autocomplete.d.ts

@@ -1,94 +1,94 @@
-import { MemorialUIFormPluginComponent } from './component';
-
-export interface SdAutoCompleteSuggestionEntry {
-  readonly id: any;
-  readonly label: string;
-  [prop: string]: any;
-}
-
-/** Autocomplete component */
-export declare class SdAutoComplete extends MemorialUIFormPluginComponent {
-  /**
-   * The value to bind the autocomplete to.
-   */
-  value: string | null;
-
-  /**
-   * Collection of suggestion items to always include in the suggestions list.
-   */
-  suggestions: SdAutoCompleteSuggestionEntry[];
-
-  /**
-   * Function to execute when no matching suggestion exist within the suggestions list. Function should return an array of suggestions.
-   * @param input The the string provided to the input box.
-   * @param value The current bound value of the component.
-   */
-  fetchSuggestions: (
-    input: string,
-    value?: any
-  ) =>
-    | SdAutoCompleteSuggestionEntry[]
-    | Promise<SdAutoCompleteSuggestionEntry[]>;
-
-  /**
-   * Debounce delay for invoking the remote search when typing, in milliseconds.
-   * @default 300
-   */
-  debounce: number;
-
-  /**
-   * Wether to execute the remote search on creation. The component must be provided with a valid value.
-   * @default false
-   */
-  preFetch: boolean;
-
-  /**
-   * Highlights the matched substring in each suggestion entry.
-   * @default true
-   */
-  highlightMatch: boolean;
-
-  /**
-   * Whether to emit a select event on enter when there is no autocomplete match.
-   * @default false
-   */
-  selectWhenUnmatched: boolean;
-
-  /**
-   * Whether reset the input to its previously bound value or clear it entirely when a user navigates away with an input that produces no suggestion match.
-   * @default 'reset'
-   */
-  onNoMatchBlur: 'reset' | 'clear';
-
-  /**
-   * The minimum number of characters required to invoke the remote search.
-   * @default 2
-   */
-  min: number;
-
-  /**
-   * The maximum allowed number of characters to invoke the remote search.
-   */
-  max?: number;
-
-  /**
-   * Whether the component is disabled.
-   * @default false
-   */
-  disabled: boolean;
-
-  /** Whether the input can be cleared */
-  clearable: boolean;
-
-  /** When set, the component emits the value of the property indicated by this key on the selected `SdAutoCompleteSuggestion` object. */
-  objKey?: string;
-
-  /** Optional sort function used to order the list of suggestions. */
-  sortFunction?: (
-    a: SdAutoCompleteSuggestionEntry,
-    b: SdAutoCompleteSuggestionEntry
-  ) => -1 | 0 | 1;
-}
-
-declare const plugin: SdAutoComplete;
-export default plugin;
+import { MemorialUIFormPluginComponent } from './component';
+
+export interface SdAutoCompleteSuggestionEntry {
+  readonly id: any;
+  readonly label: string;
+  [prop: string]: any;
+}
+
+/** Autocomplete component */
+export declare class SdAutoComplete extends MemorialUIFormPluginComponent {
+  /**
+   * The value to bind the autocomplete to.
+   */
+  value: string | null;
+
+  /**
+   * Collection of suggestion items to always include in the suggestions list.
+   */
+  suggestions: SdAutoCompleteSuggestionEntry[];
+
+  /**
+   * Function to execute when no matching suggestion exist within the suggestions list. Function should return an array of suggestions.
+   * @param input The the string provided to the input box.
+   * @param value The current bound value of the component.
+   */
+  fetchSuggestions: (
+    input: string,
+    value?: any
+  ) =>
+    | SdAutoCompleteSuggestionEntry[]
+    | Promise<SdAutoCompleteSuggestionEntry[]>;
+
+  /**
+   * Debounce delay for invoking the remote search when typing, in milliseconds.
+   * @default 300
+   */
+  debounce: number;
+
+  /**
+   * Wether to execute the remote search on creation. The component must be provided with a valid value.
+   * @default false
+   */
+  preFetch: boolean;
+
+  /**
+   * Highlights the matched substring in each suggestion entry.
+   * @default true
+   */
+  highlightMatch: boolean;
+
+  /**
+   * Whether to emit a select event on enter when there is no autocomplete match.
+   * @default false
+   */
+  selectWhenUnmatched: boolean;
+
+  /**
+   * Whether reset the input to its previously bound value or clear it entirely when a user navigates away with an input that produces no suggestion match.
+   * @default 'reset'
+   */
+  onNoMatchBlur: 'reset' | 'clear';
+
+  /**
+   * The minimum number of characters required to invoke the remote search.
+   * @default 2
+   */
+  min: number;
+
+  /**
+   * The maximum allowed number of characters to invoke the remote search.
+   */
+  max?: number;
+
+  /**
+   * Whether the component is disabled.
+   * @default false
+   */
+  disabled: boolean;
+
+  /** Whether the input can be cleared */
+  clearable: boolean;
+
+  /** When set, the component emits the value of the property indicated by this key on the selected `SdAutoCompleteSuggestion` object. */
+  objKey?: string;
+
+  /** Optional sort function used to order the list of suggestions. */
+  sortFunction?: (
+    a: SdAutoCompleteSuggestionEntry,
+    b: SdAutoCompleteSuggestionEntry
+  ) => -1 | 0 | 1;
+}
+
+declare const plugin: SdAutoComplete;
+export default plugin;

package/types/button.d.ts

@@ -1,74 +1,74 @@
-import { MemorialUIPluginComponent } from './component';
-
-export type SdButtonType = 'default' | 'primary' | 'secondary';
-
-export declare class SdButtonIconConfiguration {
-  icon: string | string[];
-  pos: 'left' | 'right' | undefined;
-}
-
-/** Button component */
-export declare class SdButton extends MemorialUIPluginComponent {
-  /**
-   * Button type
-   * @default 'default'
-   */
-  type: SdButtonType;
-
-  /**
-   * Determine whether the button has rounded corners.
-   * @default false
-   */
-  round: boolean;
-
-  /**
-   * Determine whether the button is a circle.
-   * @default false
-   */
-  circle: boolean;
-
-  /**
-   * Determine whether the button is just text.
-   * @default false
-   */
-  text: boolean;
-
-  /**
-   * Indicates that this is a forms submit button.
-   * @default false
-   */
-  submit: boolean;
-
-  /**
-   * Indicates that this is a forms reset button.
-   * @default false
-   */
-  reset: boolean;
-
-  /**
-   * The size of the button.
-   * @default 'medium''
-   */
-  size: 'mini' | 'small' | 'medium' | 'large';
-
-  /**
-   * Specifies the type of DOM element to use, i.e. button, a, etc..
-   * @default 'Button'
-   */
-  tag: string;
-
-  /** Whether the button is disabled. */
-  disabled: boolean;
-
-  /** The CSS class name of the **fontawesome** icon to use for this component. */
-  icon?: string | string[] | SdButtonIconConfiguration;
-
-  /** Whether the button has a label provided. */
-  hasLabel: boolean;
-
-  /** Triggers a click action. */
-  click(): void;
-}
-
-declare const plugin: SdButton;
-export default plugin;
+import { MemorialUIPluginComponent } from './component';
+
+export type SdButtonType = 'default' | 'primary' | 'secondary';
+
+export declare class SdButtonIconConfiguration {
+  icon: string | string[];
+  pos: 'left' | 'right' | undefined;
+}
+
+/** Button component */
+export declare class SdButton extends MemorialUIPluginComponent {
+  /**
+   * Button type
+   * @default 'default'
+   */
+  type: SdButtonType;
+
+  /**
+   * Determine whether the button has rounded corners.
+   * @default false
+   */
+  round: boolean;
+
+  /**
+   * Determine whether the button is a circle.
+   * @default false
+   */
+  circle: boolean;
+
+  /**
+   * Determine whether the button is just text.
+   * @default false
+   */
+  text: boolean;
+
+  /**
+   * Indicates that this is a forms submit button.
+   * @default false
+   */
+  submit: boolean;
+
+  /**
+   * Indicates that this is a forms reset button.
+   * @default false
+   */
+  reset: boolean;
+
+  /**
+   * The size of the button.
+   * @default 'medium''
+   */
+  size: 'mini' | 'small' | 'medium' | 'large';
+
+  /**
+   * Specifies the type of DOM element to use, i.e. button, a, etc..
+   * @default 'Button'
+   */
+  tag: string;
+
+  /** Whether the button is disabled. */
+  disabled: boolean;
+
+  /** The CSS class name of the **fontawesome** icon to use for this component. */
+  icon?: string | string[] | SdButtonIconConfiguration;
+
+  /** Whether the button has a label provided. */
+  hasLabel: boolean;
+
+  /** Triggers a click action. */
+  click(): void;
+}
+
+declare const plugin: SdButton;
+export default plugin;