@metadev/daga 4.0.1 → 4.1.0

package/src/lib/diagram/model/diagram-property.d.ts

@@ -1,368 +0,0 @@
-import { CollabTimestamp, CollabTimestampSet } from '../collab/primitives';
-/**
- * A property which is part of a property set and defines what values a value in a value set can take.
- * @public
- * @see PropertySet
- * @see ValueSet
- */
-export declare class Property {
-    /**
-     * The name of this property. Used to distinguish this property from others.
-     */
-    name: string;
-    /**
-     * The type of this property, which indicates the possible values that this property can have.
-     */
-    type: Type;
-    /**
-     * The default value of this property.
-     * @default undefined
-     */
-    defaultValue?: unknown;
-    /**
-     * Whether this property should always appear in the property editor component.
-     * @see PropertyEditorComponent
-     */
-    basic: boolean;
-    /**
-     * Whether the value of this property can be edited.
-     */
-    editable: boolean;
-    /**
-     * Which attribute of the parent component the value of this property is linked to. By default, it is not linked to any.
-     * @default undefined
-     */
-    rootAttribute?: string[] | string;
-    /**
-     * The list of possible values if the value of the property is chosen from a set of possible values.
-     * Should be set if the type of this property is `'option'` or 'option-list'. Otherwise, it should not be set.
-     * @default undefined
-     */
-    options?: Option<unknown>[];
-    /**
-     * The list of properties that are part of this property if this property is composed of other properties.
-     * Should be set if the type of this property is `'object'`. Otherwise, it should not be set.
-     * @default undefined
-     */
-    properties?: Property[];
-    constructor(name: string, type: Type, defaultValue: unknown, basic: boolean, editable: boolean, rootAttribute?: string[] | string);
-}
-/**
- * Each of the possible values that a property of type option can have.
- * @see Property
- * @see Type.Option
- */
-export interface Option<T> {
-    key: T;
-    label: string;
-}
-/**
- * The type that a property can have.
- * @public
- * @see Property
- */
-export declare enum Type {
-    /**
-     * A type whose value must be a boolean.
-     */
-    Boolean = "boolean",
-    /**
-     * A type whose value must be a string representing a valid HTML color code.
-     */
-    Color = "color",
-    /**
-     * A type whose value must be a date.
-     */
-    Date = "date",
-    /**
-     * A type whose value must be a date with a time.
-     */
-    Datetime = "datetime",
-    /**
-     * A type whose value must be a number.
-     */
-    Number = "number",
-    /**
-     * A type whose value must be an object.
-     */
-    Object = "object",
-    /**
-     * A type whose value must be one of a set of options.
-     */
-    Option = "option",
-    /**
-     * A type whose value must be a list of values picked from a set of options.
-     * @see Type.Option
-     */
-    OptionList = "option-list",
-    /**
-     * A type whose value must be a list of values picked from a set of options without repeated values.
-     * @see Type.Option
-     */
-    OptionSet = "option-set",
-    /**
-     * A type whose value must be a string without newline characters.
-     */
-    Text = "text",
-    /**
-     * A type whose value must be a string with newline characters.
-     */
-    TextArea = "text-area",
-    /**
-     * A type whose value must be a list of strings.
-     */
-    TextList = "text-list",
-    /**
-     * A type whose value must be a list of strings without repeated values.
-     */
-    TextSet = "text-set",
-    /**
-     * A type whose value must be a map with string keys and values.
-     */
-    TextMap = "text-map",
-    /**
-     * A type whose value must be a time of day.
-     */
-    Time = "time",
-    /**
-     * A type whose value must be a valid URL.
-     */
-    Url = "url"
-}
-/**
- * A set of properties based on which a set of values of those properties can be created.
- * @public
- * @see Property
- * @see ValueSet
- */
-export declare class PropertySet {
-    propertyMap: {
-        [key: string]: Property;
-    };
-    propertyList: Property[];
-    constructor(properties?: Property[]);
-    getProperty(key: string): Property;
-    hasProperty(key: string): boolean;
-    hasProperties(): boolean;
-}
-/**
- * A set of values corresponding to a set of properties.
- * @public
- * @see PropertySet
- */
-export declare class ValueSet {
-    rootElement: {
-        [key: string]: unknown;
-    };
-    propertySet: PropertySet;
-    displayedProperties: Property[];
-    hiddenProperties: Property[];
-    private values;
-    private valueSets;
-    /**
-     * Collaborative timestamps for all keys in this.values that have ever been set,
-     * even if since they've since been set to the default value.
-     *
-     * Object values (in this.valueSets) store their own timestamps separately.
-     */
-    private ownTimestamps;
-    constructor(propertySet: PropertySet, rootElement: unknown);
-    /**
-     * Gets the value of the root element attribute under the given keys.
-     * If given an array of keys, the value is found under repeated lookups to enable obtaining nested values.
-     * @public
-     * @param rootAttribute A key or array of keys to look up in the root element.
-     * @returns The value if it could be found, `undefined` if nothing could be found.
-     */
-    getRootElementValue(rootAttribute: string[] | string | null): unknown;
-    /**
-     * Sets the value of the root element's attribute under the given keys.
-     * If given an array of keys, the value is found under repeated lookups to enable setting nested values.
-     * If the root element has a function `updateInView()`, it is called upon successful setting of the value.
-     * If the root element's attribute doesn't exist, it does nothing.
-     * @private
-     * @param rootAttribute A key or array of keys to look up in the root element.
-     * @param value The value to set the root element's attribute to.
-     */
-    setRootElementValue(rootAttribute: string[] | string | null, value: unknown): void;
-    /**
-     * Obtains the value under the given key.
-     * @private
-     * @param key A key.
-     * @returns The value under the given key.
-     */
-    getValue(key: string): any;
-    /**
-     * Obtains all the values in the set.
-     * @private
-     * @returns An object containing all the values in the set.
-     */
-    getValues(): {
-        [key: string]: unknown;
-    };
-    /**
-     * Returns the values for all keys present in the given object, including keys in sub-objects.
-     * @private
-     * @param values An object containing all values for keys present in the given object.
-     */
-    getValuesForKeys(keys: {
-        [key: string]: unknown;
-    }): {
-        [key: string]: unknown;
-    };
-    /**
-     * Obtains all CollabTimestamps in the set, including those corresponding to nested keys.
-     * @private
-     * @returns An object containing all the CollabTimestamps in the set.
-     */
-    getTimestamps(): CollabTimestampSet;
-    /**
-     * Checks if the value under the key is not empty.
-     * @private
-     * @param key A key.
-     * @returns `true` if the value under the key is empty, `false` otherwise.
-     */
-    hasValue(key: string): boolean;
-    /**
-     * Checks if the value under the key is not empty or the default value.
-     * @private
-     * @param key A key.
-     * @returns `true` if the value under the key is not empty or the default value, `false` otherwise.
-     */
-    hasSetValue(key: string): boolean;
-    /**
-     * Checks if any of the values in the set are not empty or the default value.
-     * @private
-     * @returns `true` if any of the values in the set are not empty or the default value, `false` otherwise.
-     */
-    hasAnySetValue(): boolean;
-    /**
-     * Sets the value under the given key.
-     * @private
-     * @param key A key.
-     * @param value A value.
-     */
-    setValue(key: string, value: unknown): void;
-    /**
-     * Resets all values and then set them to the given values.
-     * @private
-     * @param values An object containing all values to set the values to.
-     */
-    setValues(values: {
-        [key: string]: unknown;
-    }): void;
-    /**
-     * Resets all timestamps and then set them to the given timestamps.
-     * @private
-     * @param values An object containing all the CollabTimestamps in the set.
-     */
-    setTimestamps(timestamps: CollabTimestampSet): void;
-    /**
-     * Writes the given values over the value set's existing values without resetting the existing values.
-     * @private
-     * @param values An object containing all values to set the values to.
-     */
-    overwriteValues(values: {
-        [key: string]: unknown;
-    }): void;
-    /**
-     * Variant of `overwriteValues` that applies last-writer-wins to each key, updating timestamps if appropriate.
-     * @private
-     * @param values An object containing all values to set the values to.
-     */
-    overwriteValuesLww(values: {
-        [key: string]: unknown;
-    }, timestamp: CollabTimestamp): void;
-    /**
-     * Sets all the values of this set to the defaults.
-     * If this set has a root element and any of its properties have root attributes, the root element's attributes are also set to the property's default value if one is provided.
-     * @private
-     */
-    resetValues(): void;
-    /**
-     * Constructs a ValueSet with its corresponding PropertySet representing the values of the object.
-     * @private
-     * @param key Key that the ValueSet is under.
-     * @returns The constructed ValueSet.
-     */
-    private constructSubValueSet;
-    /**
-     * Gets the ValueSet under the given key when there are nested ValueSets.
-     * @private
-     * @param key A key.
-     * @returns A ValueSet.
-     */
-    getSubValueSet(key: string): ValueSet;
-    /**
-     * Moves the given property to the list of displayed properties.
-     * @private
-     * @param property A property.
-     */
-    displayProperty(property: Property): void;
-    /**
-     * Moves the given property to the list of hidden properties.
-     * @private
-     * @param property A property.
-     */
-    hideProperty(property: Property): void;
-}
-/**
- * Checks if the given value is not empty.
- * @private
- * @param a A value.
- * @returns `true` if the given value is not `undefined`, `null`, `''`, `[]` or `{}`; `false` otherwise.
- */
-export declare const empty: (a: unknown) => boolean;
-/**
- * Checks whether the given values are equal.
- * @public
- * @param a A value.
- * @param b A value.
- * @returns `true` if the given values are equal, `false` otherwise.
- */
-export declare const equals: (a: unknown, b: unknown) => boolean;
-/**
- * Calculates the differences between the two given objects and returns two objects containing the differences in each relative to the other.
- *
- * For each key that holds a different value in the two objects, the resulting objects will contain the differences in the values under that key.
- *
- * This function is recursive, that is, if the value under the key is an object, the function will be applied to that value recursively.
- *
- * @public
- * @param a An object.
- * @param b An object.
- * @returns A tuple of two objects with each containing the keys that have a different value in the corresponding argument compared to the other argument.
- */
-export declare const diff: (a: {
-    [key: string]: unknown;
-}, b: {
-    [key: string]: unknown;
-}) => [{
-    [key: string]: unknown;
-}, {
-    [key: string]: unknown;
-}];
-/**
- * Calculates the differences between the two given values of a valueset and returns two objects containing the differences in each relative to the other.
- *
- * @param a An object.
- * @param b An object.
- * @param valueSet A ValueSet to use as reference for the keys and types of each property.
- * @returns A tuple of two objects with each containing the keys that have a different value in the corresponding argument compared to the other argument.
- */
-export declare const diffProperties: (a: {
-    [key: string]: unknown;
-}, b: {
-    [key: string]: unknown;
-}, valueSet: ValueSet) => [{
-    [key: string]: unknown;
-}, {
-    [key: string]: unknown;
-}];
-/**
- * Checks if the given value is an object.
- * @public
- * @param x A value.
- * @returns `true` if the given value is an object, `false` otherwise.
- */
-export declare const isObject: (x: unknown) => boolean;