harperdb 4.6.0-alpha.1 → 4.6.0-alpha.3

package/server/status.d.ts

@@ -7,6 +7,442 @@ type StatusOperationRequestBody = OperationRequestBody & {
 type StatusOperationWriteRequestBody = StatusOperationRequestBody & {
     status: string;
 };
+export declare const Status: {
+    new (identifier: Id, source: any): {
+        "__#5@#record": any;
+        "__#5@#changes": any;
+        "__#5@#version"?: number;
+        "__#5@#entry"?: import("../resources/RecordEncoder.js").Entry;
+        "__#5@#saveMode"?: boolean;
+        "__#5@#loadedFromSource"?: boolean;
+        getProperty: (name: string) => any;
+        ensureLoaded(): any;
+        get(target?: import("../resources/RequestTarget.js").RequestTarget): Promise<object | void> | object | void;
+        allowRead(user: any, query: any): any;
+        allowUpdate(user: any, updatedData: any): boolean;
+        allowCreate(user: any, newData: {}): boolean;
+        allowDelete(user: any): boolean;
+        update(target: import("../resources/RequestTarget.js").RequestTarget, updates?: any): any;
+        addTo(property: any, value: any): void;
+        subtractFrom(property: any, value: any): void;
+        getMetadata(): import("../resources/RecordEncoder.js").Entry;
+        getRecord(): any;
+        getChanges(): any;
+        _setChanges(changes: any): void;
+        setRecord(record: any): void;
+        invalidate(target: import("../resources/ResourceInterface.js").RequestTargetOrId): void;
+        _writeInvalidate(id: Id, partialRecord?: any, options?: any): void;
+        _writeRelocate(id: Id, options: any): void;
+        lock(): void;
+        put(target: import("../resources/RequestTarget.js").RequestTarget, record: any): void;
+        patch(target: import("../resources/RequestTarget.js").RequestTarget, recordUpdate: any): void | Promise<void>;
+        _writeUpdate(id: Id, recordUpdate: any, fullUpdate: boolean, options?: any): void;
+        delete(target: import("../resources/RequestTarget.js").RequestTarget): Promise<boolean>;
+        _writeDelete(id: Id, options?: any): boolean;
+        search(request: import("../resources/RequestTarget.js").RequestTarget): AsyncIterable<any>;
+        subscribe(request: import("../resources/ResourceInterface.js").SubscriptionRequest): Promise<{
+            listener: (recordId: Id, auditEntry: any, localTime: number, beginTxn: boolean) => void;
+            subscriptions: [];
+            startTime?: number;
+            includeDescendants?: boolean;
+            supportsTransactions?: boolean;
+            onlyChildren?: boolean;
+            end(): void;
+            toJSON(): {
+                name: string;
+            };
+            resolveNext: Function;
+            queue: any[];
+            hasDataListeners: boolean;
+            drainCloseListener: boolean;
+            currentDrainResolver: Function;
+            push(message: any): void;
+            send(message: any): void;
+            getNextMessage(): any;
+            waitForDrain(): Promise<boolean>;
+            on(eventName: any, listener: any): /*elided*/ any;
+            [Symbol.asyncIterator](): {
+                queue: import("../resources/IterableEventQueue.js").IterableEventQueue;
+                push(message: any): void;
+                next(): Promise<unknown> | {
+                    value: any;
+                };
+                return(value: any): {
+                    value: any;
+                    done: boolean;
+                };
+                throw(error: any): {
+                    done: boolean;
+                };
+            };
+            [EventEmitter.captureRejectionSymbol]?<K>(error: Error, event: string | symbol, ...args: any[]): void;
+            addListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): /*elided*/ any;
+            once<K>(eventName: string | symbol, listener: (...args: any[]) => void): /*elided*/ any;
+            removeListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): /*elided*/ any;
+            off<K>(eventName: string | symbol, listener: (...args: any[]) => void): /*elided*/ any;
+            removeAllListeners(eventName?: string | symbol): /*elided*/ any;
+            setMaxListeners(n: number): /*elided*/ any;
+            getMaxListeners(): number;
+            listeners<K>(eventName: string | symbol): Function[];
+            rawListeners<K>(eventName: string | symbol): Function[];
+            emit<K>(eventName: string | symbol, ...args: any[]): boolean;
+            listenerCount<K>(eventName: string | symbol, listener?: Function): number;
+            prependListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): /*elided*/ any;
+            prependOnceListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): /*elided*/ any;
+            eventNames(): (string | symbol)[];
+        }>;
+        doesExist(): boolean;
+        publish(target: import("../resources/RequestTarget.js").RequestTarget, message: any, options?: any): void;
+        _writePublish(id: Id, message: any, options?: any): void;
+        validate(record: any, patch?: any): void;
+        getUpdatedTime(): number;
+        wasLoadedFromSource(): boolean | void;
+        readonly "__#6@#id": Id;
+        readonly "__#6@#context": import("../resources/ResourceInterface.js").Context;
+        "__#6@#isCollection": boolean;
+        post(newRecord: any): Promise<any>;
+        readonly isCollection: boolean;
+        connect(incomingMessages: import("../resources/IterableEventQueue.js").IterableEventQueue, query?: {}): AsyncIterable<any>;
+        getId(): Id;
+        getContext(): import("../resources/ResourceInterface.js").Context;
+    };
+    name: any;
+    primaryStore: any;
+    auditStore: any;
+    primaryKey: any;
+    tableName: any;
+    tableId: any;
+    indices: any;
+    audit: any;
+    databasePath: any;
+    databaseName: any;
+    attributes: any;
+    replicate: any;
+    sealed: any;
+    splitSegments: any;
+    createdTimeProperty: import("../resources/Table.js").Attribute;
+    updatedTimeProperty: import("../resources/Table.js").Attribute;
+    propertyResolvers: any;
+    userResolvers: {};
+    sources: (/*elided*/ any)[];
+    sourceOptions: any;
+    intermediateSource: boolean;
+    getResidencyById: (id: Id) => number | void;
+    readonly expirationMS: any;
+    dbisDB: any;
+    schemaDefined: any;
+    sourcedFrom(source: any, options: any): /*elided*/ any;
+    readonly isCaching: any;
+    readonly shouldRevalidateEvents: boolean;
+    getResource(id: Id, request: import("../resources/ResourceInterface.js").Context, resourceOptions?: any): Promise<{
+        "__#5@#record": any;
+        "__#5@#changes": any;
+        "__#5@#version"?: number;
+        "__#5@#entry"?: import("../resources/RecordEncoder.js").Entry;
+        "__#5@#saveMode"?: boolean;
+        "__#5@#loadedFromSource"?: boolean;
+        getProperty: (name: string) => any;
+        ensureLoaded(): any;
+        get(target?: import("../resources/RequestTarget.js").RequestTarget): Promise<object | void> | object | void;
+        allowRead(user: any, query: any): any;
+        allowUpdate(user: any, updatedData: any): boolean;
+        allowCreate(user: any, newData: {}): boolean;
+        allowDelete(user: any): boolean;
+        update(target: import("../resources/RequestTarget.js").RequestTarget, updates?: any): any;
+        addTo(property: any, value: any): void;
+        subtractFrom(property: any, value: any): void;
+        getMetadata(): import("../resources/RecordEncoder.js").Entry;
+        getRecord(): any;
+        getChanges(): any;
+        _setChanges(changes: any): void;
+        setRecord(record: any): void;
+        invalidate(target: import("../resources/ResourceInterface.js").RequestTargetOrId): void;
+        _writeInvalidate(id: Id, partialRecord?: any, options?: any): void;
+        _writeRelocate(id: Id, options: any): void;
+        lock(): void;
+        put(target: import("../resources/RequestTarget.js").RequestTarget, record: any): void;
+        patch(target: import("../resources/RequestTarget.js").RequestTarget, recordUpdate: any): void | Promise<void>;
+        _writeUpdate(id: Id, recordUpdate: any, fullUpdate: boolean, options?: any): void;
+        delete(target: import("../resources/RequestTarget.js").RequestTarget): Promise<boolean>;
+        _writeDelete(id: Id, options?: any): boolean;
+        search(request: import("../resources/RequestTarget.js").RequestTarget): AsyncIterable<any>;
+        subscribe(request: import("../resources/ResourceInterface.js").SubscriptionRequest): Promise<{
+            listener: (recordId: Id, auditEntry: any, localTime: number, beginTxn: boolean) => void;
+            subscriptions: [];
+            startTime?: number;
+            includeDescendants?: boolean;
+            supportsTransactions?: boolean;
+            onlyChildren?: boolean;
+            end(): void;
+            toJSON(): {
+                name: string;
+            };
+            resolveNext: Function;
+            queue: any[];
+            hasDataListeners: boolean;
+            drainCloseListener: boolean;
+            currentDrainResolver: Function;
+            push(message: any): void;
+            send(message: any): void;
+            getNextMessage(): any;
+            waitForDrain(): Promise<boolean>;
+            on(eventName: any, listener: any): /*elided*/ any;
+            [Symbol.asyncIterator](): {
+                queue: import("../resources/IterableEventQueue.js").IterableEventQueue;
+                push(message: any): void;
+                next(): Promise<unknown> | {
+                    value: any;
+                };
+                return(value: any): {
+                    value: any;
+                    done: boolean;
+                };
+                throw(error: any): {
+                    done: boolean;
+                };
+            };
+            [EventEmitter.captureRejectionSymbol]?<K>(error: Error, event: string | symbol, ...args: any[]): void;
+            addListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): /*elided*/ any;
+            once<K>(eventName: string | symbol, listener: (...args: any[]) => void): /*elided*/ any;
+            removeListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): /*elided*/ any;
+            off<K>(eventName: string | symbol, listener: (...args: any[]) => void): /*elided*/ any;
+            removeAllListeners(eventName?: string | symbol): /*elided*/ any;
+            setMaxListeners(n: number): /*elided*/ any;
+            getMaxListeners(): number;
+            listeners<K>(eventName: string | symbol): Function[];
+            rawListeners<K>(eventName: string | symbol): Function[];
+            emit<K>(eventName: string | symbol, ...args: any[]): boolean;
+            listenerCount<K>(eventName: string | symbol, listener?: Function): number;
+            prependListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): /*elided*/ any;
+            prependOnceListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): /*elided*/ any;
+            eventNames(): (string | symbol)[];
+        }>;
+        doesExist(): boolean;
+        publish(target: import("../resources/RequestTarget.js").RequestTarget, message: any, options?: any): void;
+        _writePublish(id: Id, message: any, options?: any): void;
+        validate(record: any, patch?: any): void;
+        getUpdatedTime(): number;
+        wasLoadedFromSource(): boolean | void;
+        readonly "__#6@#id": Id;
+        readonly "__#6@#context": import("../resources/ResourceInterface.js").Context;
+        "__#6@#isCollection": boolean;
+        post(newRecord: any): Promise<any>;
+        readonly isCollection: boolean;
+        connect(incomingMessages: import("../resources/IterableEventQueue.js").IterableEventQueue, query?: {}): AsyncIterable<any>;
+        getId(): Id;
+        getContext(): import("../resources/ResourceInterface.js").Context;
+    }> | {
+        "__#5@#record": any;
+        "__#5@#changes": any;
+        "__#5@#version"?: number;
+        "__#5@#entry"?: import("../resources/RecordEncoder.js").Entry;
+        "__#5@#saveMode"?: boolean;
+        "__#5@#loadedFromSource"?: boolean;
+        getProperty: (name: string) => any;
+        ensureLoaded(): any;
+        get(target?: import("../resources/RequestTarget.js").RequestTarget): Promise<object | void> | object | void;
+        allowRead(user: any, query: any): any;
+        allowUpdate(user: any, updatedData: any): boolean;
+        allowCreate(user: any, newData: {}): boolean;
+        allowDelete(user: any): boolean;
+        update(target: import("../resources/RequestTarget.js").RequestTarget, updates?: any): any;
+        addTo(property: any, value: any): void;
+        subtractFrom(property: any, value: any): void;
+        getMetadata(): import("../resources/RecordEncoder.js").Entry;
+        getRecord(): any;
+        getChanges(): any;
+        _setChanges(changes: any): void;
+        setRecord(record: any): void;
+        invalidate(target: import("../resources/ResourceInterface.js").RequestTargetOrId): void;
+        _writeInvalidate(id: Id, partialRecord?: any, options?: any): void;
+        _writeRelocate(id: Id, options: any): void;
+        lock(): void;
+        put(target: import("../resources/RequestTarget.js").RequestTarget, record: any): void;
+        patch(target: import("../resources/RequestTarget.js").RequestTarget, recordUpdate: any): void | Promise<void>;
+        _writeUpdate(id: Id, recordUpdate: any, fullUpdate: boolean, options?: any): void;
+        delete(target: import("../resources/RequestTarget.js").RequestTarget): Promise<boolean>;
+        _writeDelete(id: Id, options?: any): boolean;
+        search(request: import("../resources/RequestTarget.js").RequestTarget): AsyncIterable<any>;
+        subscribe(request: import("../resources/ResourceInterface.js").SubscriptionRequest): Promise<{
+            listener: (recordId: Id, auditEntry: any, localTime: number, beginTxn: boolean) => void;
+            subscriptions: [];
+            startTime?: number;
+            includeDescendants?: boolean;
+            supportsTransactions?: boolean;
+            onlyChildren?: boolean;
+            end(): void;
+            toJSON(): {
+                name: string;
+            };
+            resolveNext: Function;
+            queue: any[];
+            hasDataListeners: boolean;
+            drainCloseListener: boolean;
+            currentDrainResolver: Function;
+            push(message: any): void;
+            send(message: any): void;
+            getNextMessage(): any;
+            waitForDrain(): Promise<boolean>;
+            on(eventName: any, listener: any): /*elided*/ any;
+            [Symbol.asyncIterator](): {
+                queue: import("../resources/IterableEventQueue.js").IterableEventQueue;
+                push(message: any): void;
+                next(): Promise<unknown> | {
+                    value: any;
+                };
+                return(value: any): {
+                    value: any;
+                    done: boolean;
+                };
+                throw(error: any): {
+                    done: boolean;
+                };
+            };
+            [EventEmitter.captureRejectionSymbol]?<K>(error: Error, event: string | symbol, ...args: any[]): void;
+            addListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): /*elided*/ any;
+            once<K>(eventName: string | symbol, listener: (...args: any[]) => void): /*elided*/ any;
+            removeListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): /*elided*/ any;
+            off<K>(eventName: string | symbol, listener: (...args: any[]) => void): /*elided*/ any;
+            removeAllListeners(eventName?: string | symbol): /*elided*/ any;
+            setMaxListeners(n: number): /*elided*/ any;
+            getMaxListeners(): number;
+            listeners<K>(eventName: string | symbol): Function[];
+            rawListeners<K>(eventName: string | symbol): Function[];
+            emit<K>(eventName: string | symbol, ...args: any[]): boolean;
+            listenerCount<K>(eventName: string | symbol, listener?: Function): number;
+            prependListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): /*elided*/ any;
+            prependOnceListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): /*elided*/ any;
+            eventNames(): (string | symbol)[];
+        }>;
+        doesExist(): boolean;
+        publish(target: import("../resources/RequestTarget.js").RequestTarget, message: any, options?: any): void;
+        _writePublish(id: Id, message: any, options?: any): void;
+        validate(record: any, patch?: any): void;
+        getUpdatedTime(): number;
+        wasLoadedFromSource(): boolean | void;
+        readonly "__#6@#id": Id;
+        readonly "__#6@#context": import("../resources/ResourceInterface.js").Context;
+        "__#6@#isCollection": boolean;
+        post(newRecord: any): Promise<any>;
+        readonly isCollection: boolean;
+        connect(incomingMessages: import("../resources/IterableEventQueue.js").IterableEventQueue, query?: {}): AsyncIterable<any>;
+        getId(): Id;
+        getContext(): import("../resources/ResourceInterface.js").Context;
+    };
+    _updateResource(resource: any, entry: any): void;
+    getNewId(): any;
+    setTTLExpiration(expiration: number | {
+        expiration: number;
+        eviction?: number;
+        scanInterval?: number;
+    }): void;
+    getResidencyRecord(id: Id): any;
+    setResidency(getResidency?: (record: object, context: import("../resources/ResourceInterface.js").Context) => number | void | string[]): void;
+    setResidencyById(getResidencyById?: (id: Id) => number | void): void;
+    getResidency(record: object, context: import("../resources/ResourceInterface.js").Context): number | void | string[];
+    enableAuditing(auditEnabled?: boolean): void;
+    coerceId(id: string): number | string;
+    dropTable(): Promise<void>;
+    _recordRelocate(existingEntry: any, entry: any): void;
+    evict(id: any, existingRecord: any, existingVersion: any): Promise<void>;
+    operation(operation: any, context: any): any;
+    transformToOrderedSelect(entries: any[], select: (string | import("../resources/ResourceInterface.js").SubSelect)[], sort: import("../resources/ResourceInterface.js").Sort, context: import("../resources/ResourceInterface.js").Context, readTxn: any, transformToRecord: Function): any;
+    transformEntryForSelect(select: any, context: any, readTxn: any, filtered: any, ensure_loaded?: any, canSkip?: any): (entry: import("../resources/RecordEncoder.js").Entry) => any;
+    subscribeOnThisThread(workerIndex: any, options: any): boolean;
+    addAttributes(attributesToAdd: any): Promise<any>;
+    removeAttributes(names: string[]): Promise<any>;
+    getSize(): number;
+    getAuditSize(): number;
+    getStorageStats(): {
+        available: number;
+        free: number;
+        size: number;
+    };
+    getRecordCount(options?: any): Promise<{
+        recordCount: number;
+        estimatedRange: number[];
+    } | {
+        recordCount: number;
+        estimatedRange?: undefined;
+    }>;
+    updatedAttributes(): void;
+    setComputedAttribute(attribute_name: any, resolver: any): void;
+    deleteHistory(endTime?: number, cleanupDeletedRecords?: boolean): Promise<void>;
+    getHistory(startTime?: number, endTime?: number): AsyncGenerator<{
+        id: import("ordered-binary").Key;
+        localTime: any;
+        version: any;
+        type: any;
+        value: any;
+        user: import("ordered-binary").Key;
+        operation: any;
+    }, void, unknown>;
+    getHistoryOfRecord(id: any): Promise<any[]>;
+    cleanup(): void;
+    transactions: import("../resources/DatabaseTransaction.js").Transaction[] & {
+        timestamp: number;
+    };
+    directURLMapping: boolean;
+    loadAsInstance: boolean;
+    get(identifier: Id, context?: import("../resources/ResourceInterface.js").Context): Promise<import("../entry.js").Resource>;
+    get(target: import("../resources/RequestTarget.js").RequestTarget, context?: import("../resources/ResourceInterface.js").Context): Promise<AsyncIterable<object>>;
+    put: {
+        (idOrQuery: string | Id | import("../resources/ResourceInterface.js").Query, dataOrContext?: any, context?: import("../resources/ResourceInterface.js").Context): any;
+        reliesOnPrototype: boolean;
+    };
+    patch: {
+        (idOrQuery: string | Id | import("../resources/ResourceInterface.js").Query, dataOrContext?: any, context?: import("../resources/ResourceInterface.js").Context): any;
+        reliesOnPrototype: boolean;
+    };
+    delete(identifier: Id, context?: import("../resources/ResourceInterface.js").Context): Promise<boolean>;
+    delete(request: import("../resources/ResourceInterface.js").Context, context?: import("../resources/ResourceInterface.js").Context): Promise<object>;
+    create(idPrefix: Id, record: any, context: import("../resources/ResourceInterface.js").Context): Promise<Id>;
+    create(record: any, context: import("../resources/ResourceInterface.js").Context): Promise<Id>;
+    invalidate: {
+        (idOrQuery: string | Id | import("../resources/ResourceInterface.js").Query, dataOrContext?: any, context?: import("../resources/ResourceInterface.js").Context): any;
+        reliesOnPrototype: boolean;
+    };
+    post: {
+        (idOrQuery: string | Id | import("../resources/ResourceInterface.js").Query, dataOrContext?: any, context?: import("../resources/ResourceInterface.js").Context): any;
+        reliesOnPrototype: boolean;
+    };
+    update: {
+        (idOrQuery: string | Id | import("../resources/ResourceInterface.js").Query, dataOrContext?: any, context?: import("../resources/ResourceInterface.js").Context): any;
+        reliesOnPrototype: boolean;
+    };
+    connect: {
+        (idOrQuery: string | Id | import("../resources/ResourceInterface.js").Query, dataOrContext?: any, context?: import("../resources/ResourceInterface.js").Context): any;
+        reliesOnPrototype: boolean;
+    };
+    subscribe(request: import("../resources/ResourceInterface.js").SubscriptionRequest): Promise<AsyncIterable<{
+        id: any;
+        operation: string;
+        value: object;
+    }>>;
+    publish: {
+        (idOrQuery: string | Id | import("../resources/ResourceInterface.js").Query, dataOrContext?: any, context?: import("../resources/ResourceInterface.js").Context): any;
+        reliesOnPrototype: boolean;
+    };
+    search: {
+        (idOrQuery: string | Id | import("../resources/ResourceInterface.js").Query, dataOrContext?: any, context?: import("../resources/ResourceInterface.js").Context): any;
+        reliesOnPrototype: boolean;
+    };
+    query: {
+        (idOrQuery: string | Id | import("../resources/ResourceInterface.js").Query, dataOrContext?: any, context?: import("../resources/ResourceInterface.js").Context): any;
+        reliesOnPrototype: boolean;
+    };
+    copy: {
+        (idOrQuery: string | Id | import("../resources/ResourceInterface.js").Query, dataOrContext?: any, context?: import("../resources/ResourceInterface.js").Context): any;
+        reliesOnPrototype: boolean;
+    };
+    move: {
+        (idOrQuery: string | Id | import("../resources/ResourceInterface.js").Query, dataOrContext?: any, context?: import("../resources/ResourceInterface.js").Context): any;
+        reliesOnPrototype: boolean;
+    };
+    isCollection(resource: any): any;
+    parseQuery(search: any, query: any): URLSearchParams | import("../resources/RequestTarget.js").RequestTarget;
+    parsePath(path: any, context: any, query: any): any;
+};
 declare function clearStatus({ id }: StatusOperationRequestBody): Promise<boolean>;
-declare function getStatus({ id }: StatusOperationRequestBody): Promise<import("../entry.js").Resource> | Promise<AsyncIterable<object>>;
+declare function getStatus({ id }: StatusOperationRequestBody): Promise<import("../entry.js").Resource>;
 declare function setStatus({ status, id }: StatusOperationWriteRequestBody): any;