shyft/lib/engine/attribute/Attribute.d.ts

Model driven GraphQL API framework

import { GraphQLResolveInfo, Source } from 'graphql';
import { Context } from '../context/Context';
import { ComplexDataType } from '../datatype/ComplexDataType';
import { DataType, DataTypeFunction } from '../datatype/DataType';
import { Entity } from '../entity/Entity';
import { Mutation } from '../mutation/Mutation';
import { Subscription } from '../subscription/Subscription';
export declare type AttributeDefaultValue = (params: {
    payload?: {
        [key: string]: unknown;
    };
    operation?: Mutation | Subscription;
    entity?: Entity;
    context?: Context;
}) => unknown | Promise<unknown>;
export declare type AttributeResolve = (params: {
    obj?: {
        [key: string]: unknown;
    };
    args?: {
        [key: string]: unknown;
    };
    context?: Context;
    info?: GraphQLResolveInfo;
}) => unknown | Promise<unknown>;
export declare type AttributeSerialize = (field?: unknown, payload?: unknown, entityMutation?: Mutation, entity?: Entity, model?: unknown, context?: Context, language?: unknown) => unknown;
export declare type AttributeValidate = (params: {
    value?: unknown;
    attributeName?: string;
    input?: {
        [key: string]: unknown;
    };
    source?: Source;
    context?: Context;
}) => void | Promise<void>;
/**
 * base of a model attribute
 */
export declare type AttributeBase = {
    /**
     * attribute description for documentation purposes
     */
    description: string;
    /**
     * data type of the attribute
     */
    type: DataType | ComplexDataType | Entity | DataTypeFunction;
    /**
     * make attribute non-nullable on the storage level
     */
    required?: boolean;
    /**
     * make this attribute the primary key on the storage level
     */
    primary?: boolean;
    /**
     * enforce uniqueness on this attribute on the storage level
     */
    unique?: boolean;
    /**
     * enable storage level index for faster filtering and lookups
     */
    index?: boolean;
    /**
     * derives a value from the retrieved row data (attribute is not part of the storage model)
     *
     * @param row instance data
     */
    resolve?: AttributeResolve;
    /**
     * default value generator for create type mutations
     */
    defaultValue?: AttributeDefaultValue;
    /**
     * custom data serializer function
     */
    serialize?: AttributeSerialize;
    /**
     * custom validation function
     */
    validate?: AttributeValidate;
    /**
     * hide the attribute in the protocol (graphql) layer
     */
    hidden?: boolean;
    /**
     * enable internationalization (extends the given storage model)
     */
    i18n?: boolean;
    /**
     * a custom mock data generator
     */
    mock?: (...args: any[]) => any;
    /**
     * attribute is an input for a mutation and not part of the storage model
     */
    mutationInput?: boolean;
    /**
     * place to store custom (project-related) meta data
     */
    meta?: any;
};
/**
 * a model attribute
 */
export declare type Attribute = AttributeBase & {
    /**
     * name of the attribute
     */
    name: string;
    /**
     * map of target attributes when referencing another entity
     */
    targetAttributesMap?: {
        [key: string]: {
            name: string;
            type: DataType;
        };
    };
    /**
     * internal flag for system attributes (e.g. time tracking, state, ...)
     */
    isSystemAttribute?: boolean;
};
/**
 * a model attribute
 */
export declare type PrimaryAttribute = AttributeBase & {
    /**
     * name of the attribute
     */
    name: string;
    /**
     * map of target attributes when referencing another entity
     */
    /**
     * internal flag for system attributes (e.g. time tracking, state, ...)
     */
    isSystemAttribute?: boolean;
    type: DataType;
};
/**
 * setup of an attribute
 */
export declare type AttributeSetup = AttributeBase;
/**
 * map of attributes
 */
export declare type AttributesMap = {
    /**
     * an attribute
     */
    [key: string]: AttributeSetup;
};
/**
 * setup of a map of attributes
 */
export declare type AttributesSetupMap = {
    /**
     * an attribute
     */
    [key: string]: AttributeSetup;
};
/**
 * a generator function returning a setup of a map of attributes
 */
export declare type AttributesMapGenerator = () => AttributesSetupMap;