import { AnyDocDef, DocDef, LookupInMacroReturnType, MutateInMacroReturnType } from '@cbjsdev/shared';
import { CppProtocolSubdocOpcode } from './binding.js';
import type { LookupInSpecOpCode, MakeLookupInSpec } from './clusterTypes/kv/lookup/lookupIn.types.js';
import type { LookupInCountPath, LookupInExistsPath, LookupInGetPath } from './clusterTypes/kv/lookup/lookupOperations.types.js';
import type { MutateInSpecOpcode, MutateInValue } from './clusterTypes/kv/mutation/mutateIn.types.js';
import type { MutateInArrayAddUniqueOptions, MutateInArrayAddUniquePath, MutateInArrayAddUniqueValue, MutateInArrayAppendOptions, MutateInArrayAppendPath, MutateInArrayAppendValue, MutateInArrayInsertOptions, MutateInArrayInsertPath, MutateInArrayInsertValue, MutateInArrayPrependOptions, MutateInArrayPrependPath, MutateInArrayPrependValue, MutateInBinaryOptions, MutateInBinaryPath, MutateInBinaryValue, MutateInInsertOptions, MutateInInsertPath, MutateInInsertValue, MutateInRemoveOptions, MutateInRemovePath, MutateInReplaceOptions, MutateInReplacePath, MutateInReplaceValue, MutateInUpsertOptions, MutateInUpsertPath, MutateInUpsertValue } from './clusterTypes/kv/mutation/mutationOperations.types.js';
/**
 * Represents a macro that can be passed to a lookup-in operation to
 * fetch special values such as the expiry, cas, etc...
 *
 * @category Key-Value
 */
export declare class LookupInMacro<Type extends keyof LookupInMacroReturnType = keyof LookupInMacroReturnType> {
    /**
     * @internal
     */
    _value: Type;
    constructor(value: Type);
    /**
     * A macro which references the entirety of the document meta-data.
     */
    static get Document(): LookupInMacro<'$document'>;
    /**
     * A macro which references the expiry of a document.
     */
    static get Expiry(): LookupInMacro<'$document.exptime'>;
    /**
     * A macro which references the cas of a document.
     */
    static get Cas(): LookupInMacro<'$document.CAS'>;
    /**
     * A macro which references the seqno of a document.
     */
    static get SeqNo(): LookupInMacro<'$document.seqno'>;
    /**
     * A macro which references the last modified time of a document.
     */
    static get LastModified(): LookupInMacro<'$document.last_modified'>;
    /**
     * A macro which references the deletion state of a document.  This
     * only makes sense to use in concert with the internal AccessDeleted
     * flags, which are internal.
     */
    static get IsDeleted(): LookupInMacro<'$document.deleted'>;
    /**
     * A macro which references the size of a document, expressed in bytes.
     */
    static get ValueSizeBytes(): LookupInMacro<'$document.value_bytes'>;
    /**
     * A macro which references the revision id of a document.
     */
    static get RevId(): LookupInMacro<'$document.revid'>;
}
/**
 * Represents a macro that can be passed to a mutate-in operation to
 * write special values such as the expiry, cas, etc...
 *
 * @category Key-Value
 */
export declare class MutateInMacro<Type extends keyof MutateInMacroReturnType = keyof MutateInMacroReturnType> {
    /**
     * @internal
     */
    _value: Type;
    constructor(value: Type);
    /**
     * A macro which references the cas of a document.
     */
    static get Cas(): MutateInMacro;
    /**
     * A macro which references the seqno of a document.
     */
    static get SeqNo(): MutateInMacro;
    /**
     * A macro which references the crc32 of the value of a document.
     */
    static get ValueCrc32c(): MutateInMacro;
}
/**
 * Represents a sub-operation to perform within a lookup-in operation.
 *
 * @category Key-Value
 */
export declare class LookupInSpec<Def extends AnyDocDef = AnyDocDef, Opcode extends LookupInSpecOpCode = LookupInSpecOpCode, InternalPath extends string = string, Options = NonNullable<unknown>> {
    /**
     * BUG(JSCBC-756): Previously provided access to the expiry macro for a
     * lookup-in operation.
     *
     * @deprecated Use {@link LookupInMacro.Expiry} instead.
     */
    static get Expiry(): LookupInMacro<'$document.exptime'>;
    /**
     * @internal
     */
    _op: Opcode;
    /**
     * @internal
     */
    _path: InternalPath;
    /**
     * @internal
     */
    _flags: number;
    private constructor();
    private static _create;
    static get<Def extends AnyDocDef, Options = NonNullable<unknown>>(this: void, path: '', options?: {
        xattr?: boolean;
    }): MakeLookupInSpec<Options, Def, CppProtocolSubdocOpcode.get_doc, ''>;
    static get<Def extends AnyDocDef, const Path extends Exclude<LookupInGetPath<Options, Def>, ''>, Options = NonNullable<unknown>>(this: void, path: Path, options?: {
        xattr?: boolean;
    }): MakeLookupInSpec<Options, Def, CppProtocolSubdocOpcode.get, Path>;
    /**
     * Returns whether a specific field exists in the document.
     *
     * @param path The path to the field.
     * @param options Optional parameters for this operation.
     * @param options.xattr
     * Whether this operation should reference the document body or the extended
     * attributes data for the document.
     */
    static exists<Options, Def extends AnyDocDef, const Path extends LookupInExistsPath<Options, Def>>(this: void, path: Path, options?: {
        xattr?: boolean;
    }): MakeLookupInSpec<Options, Def, CppProtocolSubdocOpcode.exists, Path>;
    /**
     * Returns the number of elements in the array reference by the path.
     *
     * @param path The path to the field.
     * @param options Optional parameters for this operation.
     * @param options.xattr
     * Whether this operation should reference the document body or the extended
     * attributes data for the document.
     */
    static count<Def extends AnyDocDef, const Path extends LookupInCountPath<Options, Def>, Options = NonNullable<unknown>>(this: void, path: Path, options?: {
        xattr?: boolean;
    }): MakeLookupInSpec<Options, Def, CppProtocolSubdocOpcode.get_count, Path>;
}
/**
 * Represents a sub-operation to perform within a mutate-in operation.
 *
 * @category Key-Value
 */
export declare class MutateInSpec<Def extends AnyDocDef = DocDef, Opcode extends MutateInSpecOpcode = MutateInSpecOpcode, Path extends string = string, Multi extends boolean = false, Value = any> {
    /**
     * BUG(JSCBC-756): Previously provided access to the document cas mutate
     * macro.
     *
     * @deprecated Use {@link MutateInMacro.Cas} instead.
     */
    static get CasPlaceholder(): MutateInMacro;
    /**
     * @internal
     */
    _op: Opcode;
    /**
     * @internal
     */
    _path: Path;
    /**
     * @internal
     */
    _flags: number;
    /**
     * Serialized representation of the user's value.
     *
     * @internal
     */
    _data: string | undefined;
    /**
     * Raw user's value.
     *
     * @internal
     */
    _rawData: Value;
    private constructor();
    private static _create;
    /**
     * Creates a MutateInSpec for inserting a field into the document.  Failing if
     * the field already exists at the specified path.
     *
     * @param path The path to the field.
     * @param value The value to insert.
     * @param options Optional parameters for this operation.
     * @param options.createPath
     * Whether or not the path to the field should be created if it does not
     * already exist.
     * @param options.xattr
     * Whether this operation should reference the document body or the extended
     * attributes data for the document.
     */
    static insert<Options, Def extends AnyDocDef, const Path extends MutateInInsertPath<Options, Def>, Value extends MutateInInsertValue<Options, Def, Path>>(this: void, path: Path, value: Value, options?: MutateInInsertOptions): MutateInSpec<Def, CppProtocolSubdocOpcode.dict_add, Path, boolean, Value>;
    static upsert<Options, Def extends AnyDocDef, Value extends MutateInValue<Options, Def, CppProtocolSubdocOpcode.set_doc, ''>>(this: void, path: '', value: Value, options?: MutateInUpsertOptions): MutateInSpec<Def, CppProtocolSubdocOpcode.set_doc, '', false, Value>;
    static upsert<Options, Def extends AnyDocDef, const Path extends MutateInUpsertPath<Options, Def>, Value extends MutateInUpsertValue<Options, Def, Path>>(this: void, path: Path, value: Value, options?: MutateInUpsertOptions): MutateInSpec<Def, CppProtocolSubdocOpcode.dict_upsert, Path, false, Value>;
    /**
     * Creates a MutateInSpec for replacing a field on a document.  This updates
     * the value of the specified field, failing if the field does not exits.
     *
     * @param path The path to the field.
     * @param value The value to write.
     * @param options Optional parameters for this operation.
     * @param options.xattr
     * Whether this operation should reference the document body or the extended
     * attributes data for the document.
     */
    static replace<Options, Def extends AnyDocDef, const Path extends MutateInReplacePath<Options, Def>, Value extends MutateInReplaceValue<Options, Def, Path>>(this: void, path: Path, value: Value, options?: MutateInReplaceOptions): MutateInSpec<Def, CppProtocolSubdocOpcode.replace, Path, boolean, Value>;
    static remove<Def extends AnyDocDef>(this: void, path: '', options?: MutateInRemoveOptions): MutateInSpec<Def, CppProtocolSubdocOpcode.remove_doc, '', false, never>;
    static remove<Options, Def extends AnyDocDef, const Path extends Exclude<MutateInRemovePath<Options, Def>, ''>>(this: void, path: Path, options?: MutateInRemoveOptions): MutateInSpec<Def, CppProtocolSubdocOpcode.remove, Path, false, never>;
    /**
     * Creates a MutateInSpec for adding a value to the end of an array in a document.
     *
     * @param path The path to the field.
     * @param value The value to add.
     * @param options Optional parameters for this operation.
     * @param options.createPath
     * Whether or not the path to the field should be created if it does not
     * already exist.
     * @param options.multi
     * If set, this enables an array of values to be passed as value, and each
     * element of the passed array is added to the array.
     * @param options.xattr
     * Whether this operation should reference the document body or the extended
     * attributes data for the document.
     */
    static arrayAppend<Options, Def extends AnyDocDef, const Path extends MutateInArrayAppendPath<Options, Def>, Value extends MutateInArrayAppendValue<Options, Def, Path, Multi>, Multi extends boolean = false>(this: void, path: Path, value: Value, options?: MutateInArrayAppendOptions<Multi>): MutateInSpec<Def, CppProtocolSubdocOpcode.array_push_last, Path, Multi, Value>;
    /**
     * Creates a MutateInSpec for adding a value to the beginning of an array in a document.
     *
     * @param path The path to the field.
     * @param value The value to add.
     * @param options Optional parameters for this operation.
     * @param options.createPath
     * Whether or not the path to the field should be created if it does not
     * already exist.
     * @param options.multi
     * If set, this enables an array of values to be passed as value, and each
     * element of the passed array is added to the array.
     * @param options.xattr
     * Whether this operation should reference the document body or the extended
     * attributes data for the document.
     */
    static arrayPrepend<Options, Def extends AnyDocDef, const Path extends MutateInArrayPrependPath<Options, Def>, Value extends MutateInArrayPrependValue<Options, Def, Path, Multi>, Multi extends boolean = false>(this: void, path: Path, value: Value, options?: MutateInArrayPrependOptions<Multi>): MutateInSpec<Def, CppProtocolSubdocOpcode.array_push_first, Path, Multi, Value>;
    /**
     * Creates a MutateInSpec for adding a value to a specified location in an array in a
     * document.  The path should specify a specific index in the array and the new values
     * are inserted at this location.
     *
     * @param path The path to an element of an array.
     * @param value The value to add.
     * @param options Optional parameters for this operation.
     * @param options.createPath
     * Whether or not the path to the field should be created if it does not
     * already exist.
     * @param options.multi
     * If set, this enables an array of values to be passed as value, and each
     * element of the passed array is added to the array.
     * @param options.xattr
     * Whether this operation should reference the document body or the extended
     * attributes data for the document.
     */
    static arrayInsert<Options, Def extends AnyDocDef, const Path extends MutateInArrayInsertPath<Options, Def>, Value extends MutateInArrayInsertValue<Options, Def, Path, Multi>, Multi extends boolean = false>(this: void, path: Path, value: Value, options?: MutateInArrayInsertOptions<Multi>): MutateInSpec<Def, CppProtocolSubdocOpcode.array_insert, Path, Multi, Value>;
    /**
     * Creates a MutateInSpec for adding a unique value to an array in a document.  This
     * operation will only add the value if it does not already exist elsewhere in the array.
     *
     * @param path The path to the field.
     * @param value The value to add.
     * @param options Optional parameters for this operation.
     * @param options.createPath
     * Whether or not the path to the field should be created if it does not
     * already exist.
     * @param options.xattr
     * Whether this operation should reference the document body or the extended
     * attributes data for the document.
     */
    static arrayAddUnique<Options, Def extends AnyDocDef, const Path extends MutateInArrayAddUniquePath<Options, Def>, Value extends MutateInArrayAddUniqueValue<Options, Def, Path>>(this: void, path: Path, value: Value, options?: MutateInArrayAddUniqueOptions): MutateInSpec<Def, CppProtocolSubdocOpcode.array_add_unique, Path, false, Value>;
    /**
     * Creates a MutateInSpec for incrementing the value of a field in a document.
     *
     * @param path The path to the field.
     * @param incrementBy The value to add.
     * @param options Optional parameters for this operation.
     * @param options.createPath
     * Whether or not the path to the field should be created if it does not
     * already exist.
     * @param options.xattr
     * Whether this operation should reference the document body or the extended
     * attributes data for the document.
     */
    static increment<Options, Def extends AnyDocDef, const Path extends MutateInBinaryPath<Options, Def>, Value extends MutateInBinaryValue<Options, Def, Path>>(this: void, path: Path, incrementBy: Value, options?: MutateInBinaryOptions): MutateInSpec<Def, CppProtocolSubdocOpcode.counter, Path, boolean, Value>;
    /**
     * Creates a MutateInSpec for decrementing the value of a field in a document.
     *
     * @param path The path to the field.
     * @param decrementBy The value to subtract.
     * @param options Optional parameters for this operation.
     * @param options.createPath
     * Whether or not the path to the field should be created if it does not
     * already exist.
     * @param options.xattr
     * Whether this operation should reference the document body or the extended
     * attributes data for the document.
     */
    static decrement<Options, Def extends AnyDocDef, const Path extends MutateInBinaryPath<Options, Def>, Value extends MutateInBinaryValue<Options, Def, Path>>(this: void, path: Path, decrementBy: Value, options?: MutateInBinaryOptions): MutateInSpec<Def, CppProtocolSubdocOpcode.counter, Path, false, Value>;
}