lib6/mapping.decorators.js

import { rulesRegistry } from './mapping.highlevel';
import { rule } from './mapping.rulesfactories';
/**
 * Class Decorator Factory that enables the Neo4j Driver to map result records to this class
 *
 * @returns {Function} Class Decorator
 * @experimental Object Mapping Decorators are in preview and may change in minor releases.
 */
function mappedClass() {
    return (_, context) => {
        rulesRegistry[context.name] = context.metadata;
    };
}
/**
 * Property Decorator Factory that enables the Neo4j Driver to map this property to a boolean.
 *
 * @param {Rule} config Configurations for the rule
 * @returns {Function} Property Decorator
 * @experimental Object Mapping Decorators are in preview and may change in minor releases.
 */
function booleanProperty(config) {
    return (_, context) => {
        context.metadata[context.name] = rule.asBoolean(config);
    };
}
/**
 * Property Decorator Factory that enables the Neo4j Driver to map this property to a string.
 *
 * @param {Rule} config Configurations for the rule
 * @returns {Function} Property Decorator
 * @experimental Object Mapping Decorators are in preview and may change in minor releases.
 */
function stringProperty(config) {
    return (_, context) => {
        context.metadata[context.name] = rule.asString(config);
    };
}
/**
 * Property Decorator Factory that enables the Neo4j Driver to map this property to a number.
 *
 * @param {Rule & { isInteger?: boolean }} config Configurations for the rule.
 * If `isInteger` is set to true, the created validate function will allow Integer values through, and the conversion functions will ensure results are return as numbers while parameters are transmitted as integers.
 * @returns {Function} Property Decorator
 * @experimental Object Mapping Decorators are in preview and may change in minor releases.
 */
function numberProperty(config) {
    return (_, context) => {
        context.metadata[context.name] = rule.asNumber(config);
    };
}
/**
 * Property Decorator Factory that enables the Neo4j Driver to map this property to a BigInt.
 *
 * @param {Rule & { acceptNumber?: boolean }} config Configurations for the rule, if `acceptNumber` is set to true, the created validate function will allow Numbers through and the convert function will turn Numbers into BigInts.
 * @returns {Function} Property Decorator
 * @experimental Object Mapping Decorators are in preview and may change in minor releases.
 */
function bigIntProperty(config) {
    return (_, context) => {
        context.metadata[context.name] = rule.asBigInt(config);
    };
}
/**
 * Property Decorator Factory that enables the Neo4j Driver to map this property to an Integer.
 *
 * @param {Rule & { acceptNumber?: boolean }} config Configurations for the rule, if `acceptNumber` is set to true, the created validate function will allow Numbers through and the convert function will turn Numbers into BigInts.
 * @returns {Function} Property Decorator
 * @experimental Object Mapping Decorators are in preview and may change in minor releases.
 */
function integerProperty(config) {
    return (_, context) => {
        context.metadata[context.name] = rule.asInteger(config);
    };
}
/**
 * Property Decorator Factory that enables the Neo4j Driver to map this property to a Node.
 *
 * @param {Rule} config Configurations for the rule
 * @returns {Function} Property Decorator
 * @experimental Object Mapping Decorators are in preview and may change in minor releases.
 */
function nodeProperty(config) {
    return (_, context) => {
        context.metadata[context.name] = rule.asNode(config);
    };
}
/**
 * Property Decorator Factory that enables the Neo4j Driver to map this property to a Relationship.
 *
 * @param {Rule} config Configurations for the rule.
 * @returns {Function} Property Decorator
 * @experimental Object Mapping Decorators are in preview and may change in minor releases.
 */
function relationshipProperty(config) {
    return (_, context) => {
        context.metadata[context.name] = rule.asRelationship(config);
    };
}
/**
 * Property Decorator Factory that enables the Neo4j Driver to map this property to a Path.
 *
 * @param {Rule} config Configurations for the rule.
 * @returns {Function} Property Decorator
 * @experimental Object Mapping Decorators are in preview and may change in minor releases.
 */
function pathProperty(config) {
    return (_, context) => {
        context.metadata[context.name] = rule.asPath(config);
    };
}
/**
 * Property Decorator Factory that enables the Neo4j Driver to map this property to a Point.
 *
 * @param {Rule} config Configurations for the rule.
 * @returns {Function} Property Decorator
 * @experimental Object Mapping Decorators are in preview and may change in minor releases.
 */
function pointProperty(config) {
    return (_, context) => {
        context.metadata[context.name] = rule.asPoint(config);
    };
}
/**
 * Property Decorator Factory that enables the Neo4j Driver to map this property to a Duration.
 *
 * @param {Rule & { stringify?: boolean }} config Configurations for the rule. If `stringify` is set, the applied rule will have `convert` and `parameterConversion` functions which automatically convert between strings in user code and {@link Duration}s in the database.
 * @returns {Function} Property Decorator
 * @experimental Object Mapping Decorators are in preview and may change in minor releases.
 */
function durationProperty(config) {
    return (_, context) => {
        context.metadata[context.name] = rule.asDuration(config);
    };
}
/**
 * Property Decorator Factory that enables the Neo4j Driver to map this property to a LocalTime
 *
 * @param {Rule & { stringify?: boolean }} config Configurations for the rule. If `stringify` is set, the applied rule will have `convert` and `parameterConversion` functions which automatically convert between strings in user code and {@link LocalTime}s in the database.
 * @returns {Function} Property Decorator
 * @experimental Object Mapping Decorators are in preview and may change in minor releases.
 */
function localTimeProperty(config) {
    return (_, context) => {
        context.metadata[context.name] = rule.asLocalTime(config);
    };
}
/**
 * Property Decorator Factory that enables the Neo4j Driver to map this property to a Time
 *
 * @param {Rule & { stringify?: boolean }} config Configurations for the rule. If `stringify` is set, the applied rule will have `convert` and `parameterConversion` functions which automatically convert between strings in user code and {@link Time}s in the database.
 * @returns {Function} Property Decorator
 * @experimental Object Mapping Decorators are in preview and may change in minor releases.
 */
function timeProperty(config) {
    return (_, context) => {
        context.metadata[context.name] = rule.asTime(config);
    };
}
/**
 * Property Decorator Factory that enables the Neo4j Driver to map this property to a Date
 *
 * @param {Rule & { stringify?: boolean, jsNativeDate?: boolean }} config Configurations for the rule. If `stringify`/`jsNativeDate` is set, the applied rule will have `convert` and `parameterConversion` functions which automatically convert between strings/JavaScript Dates in user code and {@link Date}s in the database.
 * @returns {Function} Property Decorator
 * @experimental Object Mapping Decorators are in preview and may change in minor releases.
 */
function dateProperty(config) {
    return (_, context) => {
        context.metadata[context.name] = rule.asDate(config);
    };
}
/**
 * Property Decorator Factory that enables the Neo4j Driver to map this property to a LocalDateTIme
 *
 * @param {Rule & { stringify?: boolean, jsNativeDate?: boolean }} config Configurations for the rule. If `stringify`/`jsNativeDate` is set, the applied rule will have `convert` and `parameterConversion` functions which automatically convert between strings/JavaScript Dates in user code and {@link LocalDateTime}s in the database.
 * @returns {Function} Property Decorator
 * @experimental Object Mapping Decorators are in preview and may change in minor releases.
 */
function localDateTimeProperty(config) {
    return (_, context) => {
        context.metadata[context.name] = rule.asLocalDateTime(config);
    };
}
/**
 * Property Decorator Factory that enables the Neo4j Driver to map this property to a DateTIme
 *
 * @param {Rule & { stringify?: boolean, jsNativeDate?: boolean }} config Configurations for the rule. If `stringify`/`jsNativeDate` is set, the applied rule will have `convert` and `parameterConversion` functions which automatically convert between strings/JavaScript Dates in user code and {@link DateTime}s in the database.
 * @returns {Function} Property Decorator
 * @experimental Object Mapping Decorators are in preview and may change in minor releases.
 */
function dateTimeProperty(config) {
    return (_, context) => {
        context.metadata[context.name] = rule.asDateTime(config);
    };
}
/**
 * Property Decorator Factory that enables the Neo4j Driver to map this property to a List
 *
 * @param {Rule & { apply?: Rule }} config Configurations for the rule. Setting apply to a rule will apply that rule to all elements of the list.
 * @returns {Function} Property Decorator
 * @experimental Object Mapping Decorators are in preview and may change in minor releases.
 */
function listProperty(config) {
    return (_, context) => {
        context.metadata[context.name] = rule.asList(Object.assign({ apply: Object.assign({}, context.metadata[context.name]) }, config));
    };
}
/**
 * Property Decorator Factory that enables the Neo4j Driver to map this property to a Vector
 *
 * @param {Rule & { asTypedList?: boolean, dimension?: number, type?: VectorType }} config Configurations for the rule. Setting asTypedList will automatically convert between TypedList in user code and Vectors in the database.
 * @returns {Function} Property Decorator
 * @experimental Object Mapping Decorators are in preview and may change in minor releases.
 */
function vectorProperty(config) {
    return (_, context) => {
        context.metadata[context.name] = rule.asVector(config);
    };
}
/**
 * Property Decorator Factory that enables the Neo4j Driver to map this property to an Object, allowing complex mapping of even nested results
 *
 * NOTE: When using this rule, object identifiers will be mapped according to any name mapping set with neo4j.RecordObjectMapping.translateIdentifiers.
 *
 * @param {Rules} rules rules for the fields of the object.
 * @param {GenericConstructor} constructor The constructor function of the class to map to. The constructor must be callable with all arguments undefined.
 * @param {Rule & { asTypedList?: boolean, dimension?: number, type?: VectorType }} config Configurations for the rule. Setting asTypedList will automatically convert between TypedList in user code and Vectors in the database.
 * @returns {Function} Property Decorator
 * @experimental Object Mapping Decorators are in preview and may change in minor releases.
 */
function objectProperty(constructorOrRules, rules) {
    return (_, context) => {
        context.metadata[context.name] = rule.asObject(constructorOrRules, rules);
    };
}
/**
 * Property Decorator Factory that sets this property to optional.
 * NOTE: Should be put above a type decorator.
 *
 * @returns {Function} Property Decorator
 * @experimental Object Mapping Decorators are in preview and may change in minor releases.
 */
function optionalProperty() {
    return (_, context) => {
        context.metadata[context.name] = Object.assign({ optional: true }, context.metadata[context.name]);
    };
}
/**
 * Property Decorator Factory that sets a custom parameter name to map this property to.
 * NOTE: Should be put above a type decorator.
 *
 * @param {string} name
 * @returns {Function} Property Decorator
 * @experimental Object Mapping Decorators are in preview and may change in minor releases.
 */
function mapPropertyFromName(name) {
    return (_, context) => {
        context.metadata[context.name] = Object.assign({ from: name }, context.metadata[context.name]);
    };
}
/**
 * Property Decorator Factory that sets the Neo4j Driver to convert this property to another type.
 * NOTE: Should be put above a type decorator of type Node or Relationship.
 *
 * @param {any} type
 * @returns {Function} Property Decorator
 * @experimental Object Mapping Decorators are in preview and may change in minor releases.
 */
function convertPropertyToType(type) {
    return (_, context) => {
        context.metadata[context.name] = Object.assign({ convert: (node) => node.as(type) }, context.metadata[context.name]);
    };
}
const forExport = {
    booleanProperty,
    stringProperty,
    numberProperty,
    bigIntProperty,
    integerProperty,
    nodeProperty,
    relationshipProperty,
    pathProperty,
    pointProperty,
    durationProperty,
    localTimeProperty,
    timeProperty,
    dateProperty,
    localDateTimeProperty,
    dateTimeProperty,
    listProperty,
    vectorProperty,
    objectProperty,
    optionalProperty,
    mapPropertyFromName,
    convertPropertyToType,
    mappedClass
};
export default forExport;