@getanthill/datastore/dist/constants/components.d.ts

Event-Sourced Datastore

export declare const COMPONENT_STRING: {
    type: string;
    description: string;
};
export declare const COMPONENT_TAG_SNAKECASE: {
    type: string;
    description: string;
    pattern: string;
};
export declare const COMPONENT_TAGS_SNAKECASE: {
    type: string;
    items: {
        type: string;
        description: string;
        pattern: string;
    };
};
export declare const COMPONENT_BOOLEAN: {
    type: string;
    description: string;
};
export declare const COMPONENT_INTEGER: {
    type: string;
    description: string;
};
export declare const COMPONENT_NUMBER: {
    type: string;
    description: string;
};
export declare const COMPONENT_DATE: {
    type: string;
    description: string;
    example: string;
    format: string;
};
export declare const COMPONENT_PHONE_NUMBER: {
    type: string;
    description: string;
    example: string;
    minLength: number;
    maxLength: number;
    pattern: string;
};
export declare const COMPONENT_EMAIL: {
    type: string;
    description: string;
    example: string;
    format: string;
};
export declare const COMPONENT_CORRELATION_ID: {
    type: string;
    description: string;
    example: string;
};
export declare const COMPONENT_UUID_V4: {
    type: string;
    description: string;
    example: string;
    pattern: string;
};
export declare const COMPONENT_LOCALE: {
    type: string;
    description: string;
    example: string;
    pattern: string;
};
export declare const COMPONENT_TIMEZONE: {
    type: string;
    description: string;
    example: string;
};
export declare const COMPONENT_URL: {
    type: string;
    description: string;
    example: string;
    pattern: string;
};
export declare const COMPONENT_JSON_PATCH: {
    type: string;
    items: {
        type: string;
        required: string[];
        properties: {
            op: {
                type: string;
                enum: string[];
                description: string;
            };
            path: {
                type: string;
                description: string;
            };
        };
    };
};
/**
 * JSON Resume location schema in snake_case
 * @see https://jsonresume.org/schema/
 */
export declare const COMPONENT_LOCATION: {
    type: string;
    additionalProperties: boolean;
    properties: {
        address: {
            type: string;
            description: string;
        };
        postal_code: {
            type: string;
        };
        city: {
            type: string;
        };
        country_code: {
            type: string;
            description: string;
        };
        region: {
            type: string;
            description: string;
        };
    };
};
export declare const COMPONENT_EVENT_TYPE: {
    type: string;
    description: string;
    example: string;
};
export declare const COMPONENT_EVENT_TYPE_VERSION: {
    type: string;
    description: string;
    example: string;
};
export declare const COMPONENT_EVENT_VERSION: {
    type: string;
    description: string;
    example: number;
    minimum: number;
};
export declare const COMPONENT_EVENT_PROPERTIES: {
    type: {
        type: string;
        description: string;
        example: string;
    };
    v: {
        type: string;
        description: string;
        example: string;
    };
    version: {
        type: string;
        description: string;
        example: number;
        minimum: number;
    };
    created_at: {
        type: string;
        description: string;
        example: string;
        format: string;
    };
};
export declare const COMPONENT_STATE_PROPERTIES: {
    type: {
        type: string;
        description: string;
        example: string;
    };
    version: {
        type: string;
        description: string;
        example: number;
        minimum: number;
    };
    created_at: {
        type: string;
        description: string;
        example: string;
        format: string;
    };
    updated_at: {
        type: string;
        description: string;
        example: string;
        format: string;
    };
};
export declare const COMPONENT_EVENT_REQUIRED_FIELDS: string[];
export declare const COMPONENTS: {
    type: {
        type: string;
        description: string;
        example: string;
    };
    v: {
        type: string;
        description: string;
        example: string;
    };
    version: {
        type: string;
        description: string;
        example: number;
        minimum: number;
    };
    created_at: {
        type: string;
        description: string;
        example: string;
        format: string;
    };
    updated_at: {
        type: string;
        description: string;
        example: string;
        format: string;
    };
    is_enabled: {
        description: string;
        type: string;
    };
    is_readonly: {
        description: string;
        type: string;
    };
    is_archived: {
        description: string;
        type: string;
    };
    is_deleted: {
        description: string;
        type: string;
    };
};