personal_site/frontend/node_modules/@aws-amplify/data-schema/dist/esm/ModelField.d.ts

import { AllowModifier, Authorization } from './Authorization';
import type { methodKeyOf, satisfy } from './util/usedMethods.js';
import type { brandSymbol } from './util/Brand.js';
import { ValidationRule, FieldTypeToValidationBuilder } from './Validate';
/**
 * Used to "attach" auth types to ModelField without exposing them on the builder.
 */
export declare const __auth: unique symbol;
/**
 * Used by `.default()` to represent a generated field (SQL).
 */
export declare const __generated: unique symbol;
declare const brandName = "modelField";
declare const internal: unique symbol;
export declare enum ModelFieldType {
    Id = "ID",
    String = "String",
    Integer = "Int",
    Float = "Float",
    Boolean = "Boolean",
    Date = "AWSDate",
    Time = "AWSTime",
    DateTime = "AWSDateTime",
    Timestamp = "AWSTimestamp",
    Email = "AWSEmail",
    JSON = "AWSJSON",
    Phone = "AWSPhone",
    Url = "AWSURL",
    IPAddress = "AWSIPAddress"
}
export declare enum ModelFieldDataType {
    String = "string",
    Number = "number",
    Boolean = "boolean",
    Date = "Date",
    JSON = "any"
}
type FieldData = {
    fieldType: ModelFieldType;
    required: boolean;
    array: boolean;
    arrayRequired: boolean;
    default: undefined | symbol | ModelFieldTypeParamOuter;
    authorization: Authorization<any, any, any>[];
    validation: ValidationRule[];
};
type ModelFieldTypeParamInner = string | number | boolean | Date | Json | null;
/**
 * A precise, recursive Json type blows the type calculation stack without installing
 * explicit `Json extends T ? short-circuit : ...` type checks all over the place.
 * We may take that on later. But, this is a good-enough approximation for now.
 */
export type Json = null | string | number | boolean | object | any[];
export type ModelFieldTypeParamOuter = ModelFieldTypeParamInner | Array<ModelFieldTypeParamInner> | null;
/**
 * Field type arg mutators
 */
export type Nullable<T> = T | null;
export type Required<T> = Exclude<T, null>;
export type ArrayField<T> = [T] extends [ModelFieldTypeParamInner] ? Array<T> | null : never;
export type BaseModelField<T extends ModelFieldTypeParamOuter = ModelFieldTypeParamOuter, FT extends ModelFieldType = ModelFieldType> = ModelField<T, UsableModelFieldKey, any, FT>;
export type UsableModelFieldKey = satisfy<methodKeyOf<ModelField>, 'required' | 'default' | 'authorization' | 'array' | 'validate'>;
/**
 * Public API for the chainable builder methods exposed by Model Field.
 * The type is narrowing e.g., after calling .array() it will be omitted from intellisense suggestions
 *
 * @typeParam T - holds the JS data type of the field
 * @typeParam UsedMethod - union of strings representing already-invoked method names. Used to improve Intellisense
 * @typeParam Auth - type of the authorization rules attached to the field
 * @typeParam FT - specific ModelFieldType of the field
 */
export type ModelField<T extends ModelFieldTypeParamOuter = ModelFieldTypeParamOuter, UsedMethod extends UsableModelFieldKey = never, Auth = undefined, FT extends ModelFieldType = ModelFieldType> = Omit<{
    [__auth]?: Auth;
    [brandSymbol]: typeof brandName;
    /**
     * Internal non-omittable method that allows `BaseModelField` to retain a reference to `T` type arg in `ModelField`.
     * Since all public methods are omittable, the evaluated `BaseModelField` loses type information unless
     * some property on the type is guaranteed to reference `T`
     * Context: https://github.com/aws-amplify/amplify-data/pull/406/files#r1869481467
     */
    [internal](): ModelField<T, UsedMethod, Auth, FT>;
    /**
     * Marks a field as required.
     */
    required(): ModelField<Required<T>, UsedMethod | 'required', Auth, FT>;
    /**
     * Converts a field type definition to an array of the field type.
     */
    array(): ModelField<ArrayField<T>, Exclude<UsedMethod, 'required'> | 'array' | 'validate', Auth, FT>;
    /**
     * Sets a default value for the scalar type.
     * @param value the default value
     */
    default(value?: ModelFieldTypeParamOuter): ModelField<T, UsedMethod | 'default', Auth, FT>;
    /**
     * Configures field-level authorization rules. Pass in an array of authorizations `(allow => allow.____)` to mix and match
     * multiple authorization rules for this field.
     */
    authorization<AuthRuleType extends Authorization<any, any, any>>(callback: (allow: Omit<AllowModifier, 'resource'>) => AuthRuleType | AuthRuleType[]): ModelField<T, UsedMethod | 'authorization', AuthRuleType, FT>;
    /**
     * Configures field-level validation rules.
     *
     * @example
     * a.integer().validate(v => v.gt(0, 'Integer must be greater than 0'))
     * a.float().validate(v => v.gt(0.99, 'Float must be greater than 0.99'))
     * a.string().validate(v => v.minLength(5, 'String must be at least 5 characters'))
     *
     * @param callback - A function that receives a validation builder object for the field type
     */
    validate(callback: (v: FieldTypeToValidationBuilder<T, FT>) => void): ModelField<T, UsedMethod | 'validate' | 'default' | 'array', Auth, FT>;
}, UsedMethod>;
/**
 * Internal representation of Model Field that exposes the `data` property.
 * Used at buildtime.
 */
export type InternalField<T extends ModelFieldTypeParamOuter = ModelFieldTypeParamOuter, UsedMethod extends UsableModelFieldKey = never, Auth = undefined, FT extends ModelFieldType = ModelFieldType> = ModelField<T, UsedMethod, Auth, FT> & {
    data: FieldData;
};
/**
 * A unique identifier scalar type. This scalar is serialized like a String but isn't meant to be human-readable.
 * If not specified on create operations, a ULID will be auto-generated service-side.
 * @returns ID field definition
 */
export declare function id(): ModelField<Nullable<string>, never, undefined, ModelFieldType.Id>;
/**
 * A string scalar type that is represented server-side as a UTF-8 character sequence.
 * @returns string field definition
 */
export declare function string(): ModelField<Nullable<string>, never, undefined, ModelFieldType.String>;
/**
 * An integer scalar type with a supported value range between -(2^31) and 2^31-1.
 * @returns integer field definition
 */
export declare function integer(): ModelField<Nullable<number>, never, undefined, ModelFieldType.Integer>;
/**
 * A float scalar type following represented server-side as an IEEE 754 floating point value.
 * @returns float field definition
 */
export declare function float(): ModelField<Nullable<number>, never, undefined, ModelFieldType.Float>;
/**
 * A boolean scalar type that can be either true or false.
 * @returns boolean field definition
 */
export declare function boolean(): ModelField<Nullable<boolean>, never, undefined, ModelFieldType.Boolean>;
/**
 * A date scalar type that is represented server-side as an extended ISO 8601 date string in the format `YYYY-MM-DD`.
 * @returns date field definition
 */
export declare function date(): ModelField<Nullable<string>, never, undefined, ModelFieldType.Date>;
/**
 * A time scalar type that is represented server-side as an extended ISO 8601 time string in the format `hh:mm:ss.sss`.
 * @returns time field definition
 */
export declare function time(): ModelField<Nullable<string>, never, undefined, ModelFieldType.Time>;
/**
 * A date time scalar type that is represented server-side as an extended ISO 8601 date and time string in the format `YYYY-MM-DDThh:mm:ss.sssZ`.
 * @returns datetime field definition
 */
export declare function datetime(): ModelField<Nullable<string>, never, undefined, ModelFieldType.DateTime>;
/**
 * A timestamp scalar type that is represented by an integer value of the number of seconds before or after `1970-01-01-T00:00Z`.
 * @returns timestamp field definition
 */
export declare function timestamp(): ModelField<Nullable<number>, never, undefined, ModelFieldType.Timestamp>;
/**
 * An email scalar type that is represented server-side in the format `local-part@domain-part` as defined by RFC 822.
 * @returns email field definition
 */
export declare function email(): ModelField<Nullable<string>, never, undefined, ModelFieldType.Email>;
/**
 * A JSON scalar type that is automatically parsed and loaded server-side as maps, lists, or scalar values
 * rather than as the literal input strings.
 * @returns JSON field definition
 */
export declare function json(): ModelField<Nullable<Json>, never, undefined, ModelFieldType.JSON>;
/**
 * A phone number scalar type thas is stored as a string server-side. Phone numbers can contain either spaces
 * or hyphens to separate digit groups. Phone numbers without a country code are assumed to be US/North American numbers adhering
 * to the North American Numbering Plan.
 * @returns phone number field definition
 */
export declare function phone(): ModelField<Nullable<string>, never, undefined, ModelFieldType.Phone>;
/**
 * A URL scalar type as defined by RFC 1738. For example, https://www.amazon.com/dp/B000NZW3KC/ or mailto:example@example.com.
 * URLs must contain a schema (http, mailto) and can't contain two forward slashes (//) in the path part.
 * @returns URL field definition
 */
export declare function url(): ModelField<Nullable<string>, never, undefined, ModelFieldType.Url>;
/**
 * A valid IPv4 or IPv6 address scalar type. IPv4 addresses are expected in quad-dotted notation (123.12.34.56). IPv6 addresses
 * are expected in non-bracketed, colon-separated format (1a2b:3c4b:🔢4567). You can include an optional CIDR suffix (123.45.67.89/16)
 * to indicate subnet mask.
 * @returns IP address field definition
 */
export declare function ipAddress(): ModelField<Nullable<string>, never, undefined, ModelFieldType.IPAddress>;
export {};