appwrite-utils/dist/schemas/attribute.d.ts

`appwrite-utils` is a comprehensive TypeScript library designed to streamline the development process for Appwrite projects. Version 1.0.0 aligns with the YAML-first architecture of `appwrite-utils-cli`, providing enhanced integration capabilities and rob

import { z } from "zod";
export declare const attributeSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
    key: z.ZodString;
    type: z.ZodDefault<z.ZodLiteral<"string">>;
    error: z.ZodOptional<z.ZodDefault<z.ZodString>>;
    required: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    array: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    size: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
    xdefault: z.ZodOptional<z.ZodNullable<z.ZodString>>;
    encrypted: z.ZodOptional<z.ZodBoolean>;
    format: z.ZodOptional<z.ZodNullable<z.ZodString>>;
}, z.core.$strip>, z.ZodObject<{
    key: z.ZodString;
    type: z.ZodDefault<z.ZodLiteral<"integer">>;
    error: z.ZodOptional<z.ZodDefault<z.ZodString>>;
    required: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    array: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    min: z.ZodOptional<z.ZodNumber>;
    max: z.ZodOptional<z.ZodNumber>;
    xdefault: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
}, z.core.$strip>, z.ZodObject<{
    key: z.ZodString;
    error: z.ZodOptional<z.ZodDefault<z.ZodString>>;
    required: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    array: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    min: z.ZodOptional<z.ZodNumber>;
    max: z.ZodOptional<z.ZodNumber>;
    xdefault: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
    type: z.ZodDefault<z.ZodLiteral<"double">>;
}, z.core.$strip>, z.ZodObject<{
    key: z.ZodString;
    error: z.ZodOptional<z.ZodDefault<z.ZodString>>;
    required: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    array: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    min: z.ZodOptional<z.ZodNumber>;
    max: z.ZodOptional<z.ZodNumber>;
    xdefault: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
    type: z.ZodDefault<z.ZodLiteral<"float">>;
}, z.core.$strip>, z.ZodObject<{
    key: z.ZodString;
    type: z.ZodDefault<z.ZodLiteral<"boolean">>;
    error: z.ZodOptional<z.ZodDefault<z.ZodString>>;
    required: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    array: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    xdefault: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
}, z.core.$strip>, z.ZodObject<{
    key: z.ZodString;
    type: z.ZodDefault<z.ZodLiteral<"datetime">>;
    error: z.ZodOptional<z.ZodDefault<z.ZodString>>;
    required: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    array: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    xdefault: z.ZodOptional<z.ZodNullable<z.ZodString>>;
}, z.core.$strip>, z.ZodObject<{
    key: z.ZodString;
    type: z.ZodDefault<z.ZodLiteral<"email">>;
    error: z.ZodOptional<z.ZodDefault<z.ZodString>>;
    required: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    array: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    xdefault: z.ZodOptional<z.ZodNullable<z.ZodString>>;
}, z.core.$strip>, z.ZodObject<{
    key: z.ZodString;
    type: z.ZodLiteral<"ip">;
    error: z.ZodOptional<z.ZodDefault<z.ZodString>>;
    required: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    array: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    xdefault: z.ZodOptional<z.ZodNullable<z.ZodString>>;
}, z.core.$strip>, z.ZodObject<{
    key: z.ZodString;
    type: z.ZodDefault<z.ZodLiteral<"url">>;
    error: z.ZodOptional<z.ZodDefault<z.ZodString>>;
    required: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    array: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    xdefault: z.ZodOptional<z.ZodNullable<z.ZodString>>;
}, z.core.$strip>, z.ZodObject<{
    key: z.ZodString;
    type: z.ZodDefault<z.ZodLiteral<"enum">>;
    error: z.ZodOptional<z.ZodDefault<z.ZodString>>;
    required: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    array: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    elements: z.ZodDefault<z.ZodArray<z.ZodString>>;
    xdefault: z.ZodOptional<z.ZodNullable<z.ZodString>>;
}, z.core.$strip>, z.ZodObject<{
    key: z.ZodString;
    type: z.ZodDefault<z.ZodLiteral<"relationship">>;
    error: z.ZodOptional<z.ZodDefault<z.ZodString>>;
    required: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    array: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    relatedCollection: z.ZodString;
    relationType: z.ZodEnum<{
        oneToMany: "oneToMany";
        manyToOne: "manyToOne";
        oneToOne: "oneToOne";
        manyToMany: "manyToMany";
    }>;
    twoWay: z.ZodBoolean;
    twoWayKey: z.ZodOptional<z.ZodString>;
    onDelete: z.ZodDefault<z.ZodEnum<{
        setNull: "setNull";
        cascade: "cascade";
        restrict: "restrict";
    }>>;
    side: z.ZodOptional<z.ZodEnum<{
        parent: "parent";
        child: "child";
    }>>;
    importMapping: z.ZodOptional<z.ZodObject<{
        originalIdField: z.ZodString;
        targetField: z.ZodOptional<z.ZodString>;
    }, z.core.$strip>>;
}, z.core.$strip>], "type">;
export type Attribute = z.infer<typeof attributeSchema>;
export declare const attributesSchema: z.ZodArray<z.ZodDiscriminatedUnion<[z.ZodObject<{
    key: z.ZodString;
    type: z.ZodDefault<z.ZodLiteral<"string">>;
    error: z.ZodOptional<z.ZodDefault<z.ZodString>>;
    required: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    array: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    size: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
    xdefault: z.ZodOptional<z.ZodNullable<z.ZodString>>;
    encrypted: z.ZodOptional<z.ZodBoolean>;
    format: z.ZodOptional<z.ZodNullable<z.ZodString>>;
}, z.core.$strip>, z.ZodObject<{
    key: z.ZodString;
    type: z.ZodDefault<z.ZodLiteral<"integer">>;
    error: z.ZodOptional<z.ZodDefault<z.ZodString>>;
    required: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    array: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    min: z.ZodOptional<z.ZodNumber>;
    max: z.ZodOptional<z.ZodNumber>;
    xdefault: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
}, z.core.$strip>, z.ZodObject<{
    key: z.ZodString;
    error: z.ZodOptional<z.ZodDefault<z.ZodString>>;
    required: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    array: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    min: z.ZodOptional<z.ZodNumber>;
    max: z.ZodOptional<z.ZodNumber>;
    xdefault: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
    type: z.ZodDefault<z.ZodLiteral<"double">>;
}, z.core.$strip>, z.ZodObject<{
    key: z.ZodString;
    error: z.ZodOptional<z.ZodDefault<z.ZodString>>;
    required: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    array: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    min: z.ZodOptional<z.ZodNumber>;
    max: z.ZodOptional<z.ZodNumber>;
    xdefault: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
    type: z.ZodDefault<z.ZodLiteral<"float">>;
}, z.core.$strip>, z.ZodObject<{
    key: z.ZodString;
    type: z.ZodDefault<z.ZodLiteral<"boolean">>;
    error: z.ZodOptional<z.ZodDefault<z.ZodString>>;
    required: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    array: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    xdefault: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
}, z.core.$strip>, z.ZodObject<{
    key: z.ZodString;
    type: z.ZodDefault<z.ZodLiteral<"datetime">>;
    error: z.ZodOptional<z.ZodDefault<z.ZodString>>;
    required: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    array: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    xdefault: z.ZodOptional<z.ZodNullable<z.ZodString>>;
}, z.core.$strip>, z.ZodObject<{
    key: z.ZodString;
    type: z.ZodDefault<z.ZodLiteral<"email">>;
    error: z.ZodOptional<z.ZodDefault<z.ZodString>>;
    required: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    array: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    xdefault: z.ZodOptional<z.ZodNullable<z.ZodString>>;
}, z.core.$strip>, z.ZodObject<{
    key: z.ZodString;
    type: z.ZodLiteral<"ip">;
    error: z.ZodOptional<z.ZodDefault<z.ZodString>>;
    required: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    array: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    xdefault: z.ZodOptional<z.ZodNullable<z.ZodString>>;
}, z.core.$strip>, z.ZodObject<{
    key: z.ZodString;
    type: z.ZodDefault<z.ZodLiteral<"url">>;
    error: z.ZodOptional<z.ZodDefault<z.ZodString>>;
    required: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    array: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    xdefault: z.ZodOptional<z.ZodNullable<z.ZodString>>;
}, z.core.$strip>, z.ZodObject<{
    key: z.ZodString;
    type: z.ZodDefault<z.ZodLiteral<"enum">>;
    error: z.ZodOptional<z.ZodDefault<z.ZodString>>;
    required: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    array: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    elements: z.ZodDefault<z.ZodArray<z.ZodString>>;
    xdefault: z.ZodOptional<z.ZodNullable<z.ZodString>>;
}, z.core.$strip>, z.ZodObject<{
    key: z.ZodString;
    type: z.ZodDefault<z.ZodLiteral<"relationship">>;
    error: z.ZodOptional<z.ZodDefault<z.ZodString>>;
    required: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    array: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
    relatedCollection: z.ZodString;
    relationType: z.ZodEnum<{
        oneToMany: "oneToMany";
        manyToOne: "manyToOne";
        oneToOne: "oneToOne";
        manyToMany: "manyToMany";
    }>;
    twoWay: z.ZodBoolean;
    twoWayKey: z.ZodOptional<z.ZodString>;
    onDelete: z.ZodDefault<z.ZodEnum<{
        setNull: "setNull";
        cascade: "cascade";
        restrict: "restrict";
    }>>;
    side: z.ZodOptional<z.ZodEnum<{
        parent: "parent";
        child: "child";
    }>>;
    importMapping: z.ZodOptional<z.ZodObject<{
        originalIdField: z.ZodString;
        targetField: z.ZodOptional<z.ZodString>;
    }, z.core.$strip>>;
}, z.core.$strip>], "type">>;
export type Attributes = z.infer<typeof attributesSchema>;