dynamodb-toolbox/dist/esm/schema/tuple/schema_.js

Lightweight and type-safe query builder for DynamoDB and TypeScript.

import { ifThenElse } from '../../utils/ifThenElse.js';
import { overwrite } from '../../utils/overwrite.js';
import { lightRec } from '../utils/light.js';
import { TupleSchema } from './schema.js';
/**
 * Define a new tuple attribute
 *
 * @param elements Attribute[]
 */
export const tuple = (...elements) => new TupleSchema_(lightRec(...elements), {});
/**
 * Tuple schema
 */
export class TupleSchema_ extends TupleSchema {
    /**
     * Tag schema values as required. Possible values are:
     * - `'atLeastOnce'` _(default)_: Required in PUTs, optional in UPDATEs
     * - `'never'`: Optional in PUTs and UPDATEs
     * - `'always'`: Required in PUTs and UPDATEs
     *
     * @param nextRequired SchemaRequiredProp
     */
    required(nextRequired = 'atLeastOnce') {
        return new TupleSchema_(this.elements, overwrite(this.props, { required: nextRequired }));
    }
    /**
     * Shorthand for `required('never')`
     */
    optional() {
        return this.required('never');
    }
    /**
     * Hide schema values after fetch commands and formatting
     */
    hidden(nextHidden = true) {
        return new TupleSchema_(this.elements, overwrite(this.props, { hidden: nextHidden }));
    }
    /**
     * Tag schema values as a primary key attribute or linked to a primary key attribute
     */
    key(nextKey = true) {
        return new TupleSchema_(this.elements, overwrite(this.props, { key: nextKey, required: 'always' }));
    }
    /**
     * Rename schema values before save commands
     */
    savedAs(nextSavedAs) {
        return new TupleSchema_(this.elements, overwrite(this.props, { savedAs: nextSavedAs }));
    }
    /**
     * Provide a default value during Primary Key computing
     *
     * @param nextKeyDefault `keyInput | (() => keyInput)`
     */
    keyDefault(nextKeyDefault) {
        return new TupleSchema_(this.elements, overwrite(this.props, { keyDefault: nextKeyDefault }));
    }
    /**
     * Provide a default value for attribute in PUT commands
     *
     * @param nextPutDefault `putAttributeInput | (() => putAttributeInput)`
     */
    putDefault(nextPutDefault) {
        return new TupleSchema_(this.elements, overwrite(this.props, { putDefault: nextPutDefault }));
    }
    /**
     * Provide a default value for attribute in UPDATE commands
     *
     * @param nextUpdateDefault `updateAttributeInput | (() => updateAttributeInput)`
     */
    updateDefault(nextUpdateDefault) {
        return new TupleSchema_(this.elements, overwrite(this.props, { updateDefault: nextUpdateDefault }));
    }
    /**
     * Provide a default value for attribute in PUT commands OR Primary Key computing if attribute is tagged as key
     *
     * @param nextDefault `key/putAttributeInput | (() => key/putAttributeInput)`
     */
    default(nextDefault) {
        return ifThenElse(this.props.key, new TupleSchema_(this.elements, overwrite(this.props, { keyDefault: nextDefault })), new TupleSchema_(this.elements, overwrite(this.props, { putDefault: nextDefault })));
    }
    /**
     * Provide a **linked** default value for attribute in Primary Key computing
     *
     * @param nextKeyLink `keyAttributeInput | ((keyInput) => keyAttributeInput)`
     */
    keyLink(nextKeyLink) {
        return new TupleSchema_(this.elements, overwrite(this.props, { keyLink: nextKeyLink }));
    }
    /**
     * Provide a **linked** default value for attribute in PUT commands
     *
     * @param nextPutLink `putAttributeInput | ((putItemInput) => putAttributeInput)`
     */
    putLink(nextPutLink) {
        return new TupleSchema_(this.elements, overwrite(this.props, { putLink: nextPutLink }));
    }
    /**
     * Provide a **linked** default value for attribute in UPDATE commands
     *
     * @param nextUpdateLink `unknown | ((updateItemInput) => updateAttributeInput)`
     */
    updateLink(nextUpdateLink) {
        return new TupleSchema_(this.elements, overwrite(this.props, { updateLink: nextUpdateLink }));
    }
    /**
     * Provide a **linked** default value for attribute in PUT commands OR Primary Key computing if attribute is tagged as key
     *
     * @param nextLink `key/putAttributeInput | (() => key/putAttributeInput)`
     */
    link(nextLink) {
        return ifThenElse(this.props.key, new TupleSchema_(this.elements, overwrite(this.props, { keyLink: nextLink })), new TupleSchema_(this.elements, overwrite(this.props, { putLink: nextLink })));
    }
    /**
     * Provide a custom validator for attribute in Primary Key computing
     *
     * @param nextKeyValidator `(keyAttributeInput) => boolean | string`
     */
    keyValidate(nextKeyValidator) {
        return new TupleSchema_(this.elements, overwrite(this.props, { keyValidator: nextKeyValidator }));
    }
    /**
     * Provide a custom validator for attribute in PUT commands
     *
     * @param nextPutValidator `(putAttributeInput) => boolean | string`
     */
    putValidate(nextPutValidator) {
        return new TupleSchema_(this.elements, overwrite(this.props, { putValidator: nextPutValidator }));
    }
    /**
     * Provide a custom validator for attribute in UPDATE commands
     *
     * @param nextUpdateValidator `(updateAttributeInput) => boolean | string`
     */
    updateValidate(nextUpdateValidator) {
        return new TupleSchema_(this.elements, overwrite(this.props, { updateValidator: nextUpdateValidator }));
    }
    /**
     * Provide a custom validator for attribute in PUT commands OR Primary Key computing if attribute is tagged as key
     *
     * @param nextValidator `(key/putAttributeInput) => boolean | string`
     */
    validate(nextValidator) {
        return ifThenElse(this.props.key, new TupleSchema_(this.elements, overwrite(this.props, { keyValidator: nextValidator })), new TupleSchema_(this.elements, overwrite(this.props, { putValidator: nextValidator })));
    }
    clone(nextProps = {}) {
        return new TupleSchema_(this.elements, overwrite(this.props, nextProps));
    }
    build(Action) {
        return new Action(this);
    }
}