@thadeu/ndb 0.3.2 → 1.0.0

package/dist/index.d.cts

@@ -39,6 +39,7 @@ type Input<F extends Fields> = {
 type Row<F extends Fields> = Doc<F> & {
     _id: string;
     _v: number;
+    _coll?: string;
 };
 interface Ops<V> {
     $eq?: V;
@@ -52,6 +53,7 @@ interface Ops<V> {
     $exists?: boolean;
     $regex?: string | RegExp;
     $options?: string;
+    $elemMatch?: Record<string, unknown>;
 }
 type Operand<V> = V extends Date ? Date | string : V;
 type RegexOperand<V> = V extends string ? RegExp : never;
@@ -66,9 +68,14 @@ type Where<F extends Fields> = {
     [P in `${JsonKeys<F>}.${string}`]?: unknown;
 };
 type SortSpec<F extends Fields> = Partial<Record<Extract<keyof F, string> | '_id', 1 | -1>>;
+interface Blob {
+    $blob: string;
+    size: number;
+    type?: string;
+}
 interface WriteResult {
     _id: string;
-    v: number;
+    _v: number;
 }
 type Duration = number | string;
 type Filter<F extends Fields> = Where<F> & {
@@ -87,7 +94,12 @@ interface UpdateOps<F extends Fields = Fields> {
     $min?: Record<string, number | string>;
     $max?: Record<string, number | string>;
 }
-interface UpdateOptions {
+interface UpdateOptions<F extends Fields = Fields> {
+    guard?: Filter<F>;
+    upsert?: boolean;
+    expireIn?: Duration;
+}
+interface UpdateByOptions {
     many?: boolean;
     upsert?: boolean;
     expireIn?: Duration;
@@ -115,6 +127,20 @@ interface AggregateOptions {
     after?: string;
     count?: boolean;
 }
+interface SearchBody {
+    query?: Record<string, unknown>;
+    fields?: string[];
+    sort?: Record<string, 1 | -1>;
+    limit?: number;
+    skip?: number;
+    after?: string;
+    count?: boolean;
+}
+interface SearchResult<R> {
+    rows: R[];
+    next: string;
+    total: number;
+}
 interface AggregateResult<R = Record<string, unknown>> {
     rows: R[];
     next: string;
@@ -124,14 +150,14 @@ interface WatchOptions<F extends Fields = Fields> {
     from?: string;
     limit?: number;
     signal?: AbortSignal;
-    where?: Where<F>;
+    query?: Where<F>;
 }
 interface WatchEvent<R> {
     consumer: string;
     pos: string;
-    op: 'put' | 'del';
+    op: 'put' | 'del' | 'truncate';
     _id: string;
-    v: number;
+    _v: number;
     doc: R | undefined;
 }
 
@@ -144,11 +170,12 @@ interface State {
     after?: string;
 }
 declare class Query<F extends Fields, R = Row<F>> implements PromiseLike<R[]> {
-    private readonly model;
+    private readonly coll;
     private readonly state;
     nextCursor: string;
-    constructor(model: Model<F>, state?: State);
-    where(w: Where<F>): Query<F, R>;
+    constructor(coll: Collection<F>, state?: State);
+    query(w: Where<F>): Query<F, R>;
+    rawQuery(w: Record<string, unknown>): Query<F, R>;
     not(w: Where<F>): Query<F, R>;
     or(...ws: Where<F>[]): Query<F, R>;
     sort(spec: SortSpec<F>): Query<F, R>;
@@ -161,33 +188,41 @@ declare class Query<F extends Fields, R = Row<F>> implements PromiseLike<R[]> {
     all(): Promise<R[]>;
     first(): Promise<R | null>;
     count(): Promise<number>;
-    iterate(): AsyncGenerator<R>;
+    each(): AsyncGenerator<R>;
     private rows;
     private body;
     private whereDoc;
     private with;
 }
 
-declare class Model<F extends Fields> {
+declare class Collection<F extends Fields> {
     readonly db: Ndb;
     readonly name: string;
     readonly schema: Schema<F>;
     private ensured?;
     constructor(db: Ndb, name: string, schema: Schema<F>);
-    path(op?: string): string;
+    path(action?: string): string;
+    get isPattern(): boolean;
     ready(): Promise<void>;
-    insert(docs: Input<F> | Input<F>[], opts?: InsertOptions): Promise<WriteResult[]>;
-    create(docs: Input<F> | Input<F>[], opts?: InsertOptions): Promise<WriteResult[]>;
-    update(idOrFilter: string | Filter<F>, ops: UpdateOps<F>, opts?: UpdateOptions): Promise<UpdateResult<F>>;
-    delete(idOrFilter: string | Filter<F>, opts?: DeleteOptions): Promise<DeleteResult>;
+    insert(doc: Input<F>, opts?: InsertOptions): Promise<WriteResult>;
+    insert(docs: Input<F>[], opts?: InsertOptions): Promise<WriteResult[]>;
+    upsert(doc: Input<F>, opts?: InsertOptions): Promise<WriteResult>;
+    upsertAll(docs: Input<F>[], opts?: InsertOptions): Promise<WriteResult[]>;
+    update(id: string, ops: UpdateOps<F>, opts?: UpdateOptions<F>): Promise<UpdateResult<F>>;
+    updateBy(query: Filter<F>, ops: UpdateOps<F>, opts?: UpdateByOptions): Promise<UpdateResult<F>>;
+    delete(id: string): Promise<DeleteResult>;
+    deleteBy(query: Filter<F>, opts?: DeleteOptions): Promise<DeleteResult>;
+    truncate(): Promise<void>;
+    drop(): Promise<void>;
+    private confirm;
     expire(id: string, duration: Duration): Promise<ExpireResult>;
     expireAt(id: string, at: Date): Promise<ExpireResult>;
     persist(id: string): Promise<WriteResult>;
     ttl(id: string): Promise<number | null>;
     private setExpiry;
     get(id: string): Promise<Row<F> | null>;
-    query(): Query<F>;
-    where(w: Where<F>): Query<F>;
+    query(w?: Where<F>): Query<F>;
+    rawQuery(w: Record<string, unknown>): Query<F>;
     not(w: Where<F>): Query<F>;
     or(...ws: Where<F>[]): Query<F>;
     sort(spec: SortSpec<F>): Query<F>;
@@ -197,13 +232,20 @@ declare class Model<F extends Fields> {
     after(token: string): Query<F>;
     fields(...names: string[]): Query<F, Partial<Row<F>>>;
     all(): Promise<Row<F>[]>;
-    count(): Promise<number>;
+    count(w?: Where<F>): Promise<number>;
     first(): Promise<Row<F> | null>;
-    iterate(): AsyncGenerator<Row<F>>;
+    each(): AsyncGenerator<Row<F>>;
+    search(body: SearchBody): Promise<SearchResult<Row<F>>>;
     aggregate<R = Record<string, unknown>>(pipeline: Record<string, unknown>[], opts?: AggregateOptions): Promise<AggregateResult<R>>;
     watch(consumer: string, opts?: WatchOptions<F>): AsyncGenerator<WatchEvent<Row<F>>>;
     ack(event: Pick<WatchEvent<unknown>, 'consumer' | 'pos'>): Promise<void>;
+    stats(): Promise<Record<string, unknown>>;
+    compact(): Promise<Record<string, unknown>>;
+    ensureIndex(field: string): Promise<string[]>;
+    dropIndex(field: string): Promise<string[]>;
     decode(raw: Record<string, unknown>): Record<string, unknown>;
+    private send;
+    private updated;
     private catalog;
 }
 
@@ -224,8 +266,8 @@ declare class Transport {
     private readonly token;
     private readonly readyTimeout;
     constructor(addr?: string, opts?: ConnectOptions);
-    stream(method: Method, path: string, body?: unknown, signal?: AbortSignal): Promise<Streamed>;
-    request<T = unknown>(method: Method, path: string, body?: unknown): Promise<T>;
+    stream(method: Method, path: string, body?: unknown, signal?: AbortSignal, contentType?: string): Promise<Streamed>;
+    request<T = unknown>(method: Method, path: string, body?: unknown, contentType?: string): Promise<T>;
     close(): Promise<void>;
     private withReadyRetry;
     private headers;
@@ -235,8 +277,13 @@ declare class Transport {
 declare class Ndb {
     readonly transport: Transport;
     constructor(addr?: string, opts?: ConnectOptions);
-    model<const F extends Fields>(name: string, schema: Schema<F>): Model<F>;
+    collection<const F extends Fields>(name: string, schema: Schema<F>): Collection<F>;
     health(): Promise<void>;
+    collections(): Promise<Record<string, unknown>[]>;
+    stats(): Promise<Record<string, unknown>>;
+    size(): Promise<Record<string, unknown>>;
+    putBlob(data: Uint8Array | string, contentType?: string): Promise<Blob>;
+    getBlob(blob: Blob | string): Promise<Uint8Array>;
     request<T = unknown>(method: 'GET' | 'POST' | 'PUT' | 'DELETE', path: string, body?: unknown): Promise<T>;
     stream(...args: Parameters<Transport['stream']>): ReturnType<Transport['stream']>;
     close(): Promise<void>;
@@ -245,7 +292,7 @@ declare function connect(addr?: string, opts?: ConnectOptions): Ndb;
 
 declare function newId(): string;
 
-type ErrorCode = 'unauthorized' | 'not_found' | 'duplicate_id' | 'unique_violation' | 'catalog_conflict' | 'catalog_invalid' | 'unknown_collection' | 'direct_collection' | 'invalid_request' | 'invalid_query' | 'invalid_pipeline' | 'group_limit_exceeded' | 'cursor_invalid' | 'cursor_mismatch' | 'cursor_expired' | 'request_too_large' | 'line_too_large' | 'not_ready' | 'closed' | 'watch_lagged' | 'invalid_position' | 'history_truncated' | 'ttl_not_enabled' | 'ttl_derived' | 'unknown_operator' | 'no_update' | 'conflicting_update' | 'invalid_field' | 'unindexed_many' | 'empty_filter' | 'invalid_update' | 'http_status' | (string & {});
+type ErrorCode = 'unauthorized' | 'not_found' | 'duplicate_id' | 'unique_violation' | 'catalog_conflict' | 'catalog_invalid' | 'unknown_collection' | 'direct_collection' | 'invalid_request' | 'invalid_query' | 'invalid_pipeline' | 'group_limit_exceeded' | 'cursor_invalid' | 'cursor_mismatch' | 'cursor_expired' | 'request_too_large' | 'line_too_large' | 'not_ready' | 'closed' | 'watch_lagged' | 'invalid_position' | 'history_truncated' | 'ttl_not_enabled' | 'ttl_derived' | 'unknown_operator' | 'no_update' | 'conflicting_update' | 'invalid_field' | 'unindexed_many' | 'empty_filter' | 'confirm_required' | 'invalid_update' | 'http_status' | (string & {});
 declare class NdbError extends Error {
     readonly code: ErrorCode;
     readonly status: number;
@@ -273,5 +320,5 @@ declare class TtlError extends NdbError {
 }
 declare function makeError(code: ErrorCode, message: string, status?: number): NdbError;
 
-export { CursorError, DuplicateIdError, HistoryTruncatedError, InvalidQueryError, InvalidUpdateError, Model, Ndb, NdbError, NotFoundError, Query, TtlError, UnauthorizedError, UniqueViolationError, WatchLaggedError, connect, makeError, newId };
-export type { AggregateOptions, AggregateResult, ConnectOptions, DeleteOptions, DeleteResult, Doc, Duration, ErrorCode, ExpireResult, FieldDef, FieldType, Fields, Filter, Input, InsertOptions, Ops, Row, Schema, SortSpec, TypeMap, UpdateOps, UpdateOptions, UpdateResult, WatchEvent, WatchOptions, Where, WriteResult };
+export { Collection, CursorError, DuplicateIdError, HistoryTruncatedError, InvalidQueryError, InvalidUpdateError, Ndb, NdbError, NotFoundError, Query, TtlError, UnauthorizedError, UniqueViolationError, WatchLaggedError, connect, makeError, newId };
+export type { AggregateOptions, AggregateResult, Blob, ConnectOptions, DeleteOptions, DeleteResult, Doc, Duration, ErrorCode, ExpireResult, FieldDef, FieldType, Fields, Filter, Input, InsertOptions, Ops, Row, Schema, SearchBody, SearchResult, SortSpec, TypeMap, UpdateByOptions, UpdateOps, UpdateOptions, UpdateResult, WatchEvent, WatchOptions, Where, WriteResult };

package/dist/index.d.ts

@@ -39,6 +39,7 @@ type Input<F extends Fields> = {
 type Row<F extends Fields> = Doc<F> & {
     _id: string;
     _v: number;
+    _coll?: string;
 };
 interface Ops<V> {
     $eq?: V;
@@ -52,6 +53,7 @@ interface Ops<V> {
     $exists?: boolean;
     $regex?: string | RegExp;
     $options?: string;
+    $elemMatch?: Record<string, unknown>;
 }
 type Operand<V> = V extends Date ? Date | string : V;
 type RegexOperand<V> = V extends string ? RegExp : never;
@@ -66,9 +68,14 @@ type Where<F extends Fields> = {
     [P in `${JsonKeys<F>}.${string}`]?: unknown;
 };
 type SortSpec<F extends Fields> = Partial<Record<Extract<keyof F, string> | '_id', 1 | -1>>;
+interface Blob {
+    $blob: string;
+    size: number;
+    type?: string;
+}
 interface WriteResult {
     _id: string;
-    v: number;
+    _v: number;
 }
 type Duration = number | string;
 type Filter<F extends Fields> = Where<F> & {
@@ -87,7 +94,12 @@ interface UpdateOps<F extends Fields = Fields> {
     $min?: Record<string, number | string>;
     $max?: Record<string, number | string>;
 }
-interface UpdateOptions {
+interface UpdateOptions<F extends Fields = Fields> {
+    guard?: Filter<F>;
+    upsert?: boolean;
+    expireIn?: Duration;
+}
+interface UpdateByOptions {
     many?: boolean;
     upsert?: boolean;
     expireIn?: Duration;
@@ -115,6 +127,20 @@ interface AggregateOptions {
     after?: string;
     count?: boolean;
 }
+interface SearchBody {
+    query?: Record<string, unknown>;
+    fields?: string[];
+    sort?: Record<string, 1 | -1>;
+    limit?: number;
+    skip?: number;
+    after?: string;
+    count?: boolean;
+}
+interface SearchResult<R> {
+    rows: R[];
+    next: string;
+    total: number;
+}
 interface AggregateResult<R = Record<string, unknown>> {
     rows: R[];
     next: string;
@@ -124,14 +150,14 @@ interface WatchOptions<F extends Fields = Fields> {
     from?: string;
     limit?: number;
     signal?: AbortSignal;
-    where?: Where<F>;
+    query?: Where<F>;
 }
 interface WatchEvent<R> {
     consumer: string;
     pos: string;
-    op: 'put' | 'del';
+    op: 'put' | 'del' | 'truncate';
     _id: string;
-    v: number;
+    _v: number;
     doc: R | undefined;
 }
 
@@ -144,11 +170,12 @@ interface State {
     after?: string;
 }
 declare class Query<F extends Fields, R = Row<F>> implements PromiseLike<R[]> {
-    private readonly model;
+    private readonly coll;
     private readonly state;
     nextCursor: string;
-    constructor(model: Model<F>, state?: State);
-    where(w: Where<F>): Query<F, R>;
+    constructor(coll: Collection<F>, state?: State);
+    query(w: Where<F>): Query<F, R>;
+    rawQuery(w: Record<string, unknown>): Query<F, R>;
     not(w: Where<F>): Query<F, R>;
     or(...ws: Where<F>[]): Query<F, R>;
     sort(spec: SortSpec<F>): Query<F, R>;
@@ -161,33 +188,41 @@ declare class Query<F extends Fields, R = Row<F>> implements PromiseLike<R[]> {
     all(): Promise<R[]>;
     first(): Promise<R | null>;
     count(): Promise<number>;
-    iterate(): AsyncGenerator<R>;
+    each(): AsyncGenerator<R>;
     private rows;
     private body;
     private whereDoc;
     private with;
 }
 
-declare class Model<F extends Fields> {
+declare class Collection<F extends Fields> {
     readonly db: Ndb;
     readonly name: string;
     readonly schema: Schema<F>;
     private ensured?;
     constructor(db: Ndb, name: string, schema: Schema<F>);
-    path(op?: string): string;
+    path(action?: string): string;
+    get isPattern(): boolean;
     ready(): Promise<void>;
-    insert(docs: Input<F> | Input<F>[], opts?: InsertOptions): Promise<WriteResult[]>;
-    create(docs: Input<F> | Input<F>[], opts?: InsertOptions): Promise<WriteResult[]>;
-    update(idOrFilter: string | Filter<F>, ops: UpdateOps<F>, opts?: UpdateOptions): Promise<UpdateResult<F>>;
-    delete(idOrFilter: string | Filter<F>, opts?: DeleteOptions): Promise<DeleteResult>;
+    insert(doc: Input<F>, opts?: InsertOptions): Promise<WriteResult>;
+    insert(docs: Input<F>[], opts?: InsertOptions): Promise<WriteResult[]>;
+    upsert(doc: Input<F>, opts?: InsertOptions): Promise<WriteResult>;
+    upsertAll(docs: Input<F>[], opts?: InsertOptions): Promise<WriteResult[]>;
+    update(id: string, ops: UpdateOps<F>, opts?: UpdateOptions<F>): Promise<UpdateResult<F>>;
+    updateBy(query: Filter<F>, ops: UpdateOps<F>, opts?: UpdateByOptions): Promise<UpdateResult<F>>;
+    delete(id: string): Promise<DeleteResult>;
+    deleteBy(query: Filter<F>, opts?: DeleteOptions): Promise<DeleteResult>;
+    truncate(): Promise<void>;
+    drop(): Promise<void>;
+    private confirm;
     expire(id: string, duration: Duration): Promise<ExpireResult>;
     expireAt(id: string, at: Date): Promise<ExpireResult>;
     persist(id: string): Promise<WriteResult>;
     ttl(id: string): Promise<number | null>;
     private setExpiry;
     get(id: string): Promise<Row<F> | null>;
-    query(): Query<F>;
-    where(w: Where<F>): Query<F>;
+    query(w?: Where<F>): Query<F>;
+    rawQuery(w: Record<string, unknown>): Query<F>;
     not(w: Where<F>): Query<F>;
     or(...ws: Where<F>[]): Query<F>;
     sort(spec: SortSpec<F>): Query<F>;
@@ -197,13 +232,20 @@ declare class Model<F extends Fields> {
     after(token: string): Query<F>;
     fields(...names: string[]): Query<F, Partial<Row<F>>>;
     all(): Promise<Row<F>[]>;
-    count(): Promise<number>;
+    count(w?: Where<F>): Promise<number>;
     first(): Promise<Row<F> | null>;
-    iterate(): AsyncGenerator<Row<F>>;
+    each(): AsyncGenerator<Row<F>>;
+    search(body: SearchBody): Promise<SearchResult<Row<F>>>;
     aggregate<R = Record<string, unknown>>(pipeline: Record<string, unknown>[], opts?: AggregateOptions): Promise<AggregateResult<R>>;
     watch(consumer: string, opts?: WatchOptions<F>): AsyncGenerator<WatchEvent<Row<F>>>;
     ack(event: Pick<WatchEvent<unknown>, 'consumer' | 'pos'>): Promise<void>;
+    stats(): Promise<Record<string, unknown>>;
+    compact(): Promise<Record<string, unknown>>;
+    ensureIndex(field: string): Promise<string[]>;
+    dropIndex(field: string): Promise<string[]>;
     decode(raw: Record<string, unknown>): Record<string, unknown>;
+    private send;
+    private updated;
     private catalog;
 }
 
@@ -224,8 +266,8 @@ declare class Transport {
     private readonly token;
     private readonly readyTimeout;
     constructor(addr?: string, opts?: ConnectOptions);
-    stream(method: Method, path: string, body?: unknown, signal?: AbortSignal): Promise<Streamed>;
-    request<T = unknown>(method: Method, path: string, body?: unknown): Promise<T>;
+    stream(method: Method, path: string, body?: unknown, signal?: AbortSignal, contentType?: string): Promise<Streamed>;
+    request<T = unknown>(method: Method, path: string, body?: unknown, contentType?: string): Promise<T>;
     close(): Promise<void>;
     private withReadyRetry;
     private headers;
@@ -235,8 +277,13 @@ declare class Transport {
 declare class Ndb {
     readonly transport: Transport;
     constructor(addr?: string, opts?: ConnectOptions);
-    model<const F extends Fields>(name: string, schema: Schema<F>): Model<F>;
+    collection<const F extends Fields>(name: string, schema: Schema<F>): Collection<F>;
     health(): Promise<void>;
+    collections(): Promise<Record<string, unknown>[]>;
+    stats(): Promise<Record<string, unknown>>;
+    size(): Promise<Record<string, unknown>>;
+    putBlob(data: Uint8Array | string, contentType?: string): Promise<Blob>;
+    getBlob(blob: Blob | string): Promise<Uint8Array>;
     request<T = unknown>(method: 'GET' | 'POST' | 'PUT' | 'DELETE', path: string, body?: unknown): Promise<T>;
     stream(...args: Parameters<Transport['stream']>): ReturnType<Transport['stream']>;
     close(): Promise<void>;
@@ -245,7 +292,7 @@ declare function connect(addr?: string, opts?: ConnectOptions): Ndb;
 
 declare function newId(): string;
 
-type ErrorCode = 'unauthorized' | 'not_found' | 'duplicate_id' | 'unique_violation' | 'catalog_conflict' | 'catalog_invalid' | 'unknown_collection' | 'direct_collection' | 'invalid_request' | 'invalid_query' | 'invalid_pipeline' | 'group_limit_exceeded' | 'cursor_invalid' | 'cursor_mismatch' | 'cursor_expired' | 'request_too_large' | 'line_too_large' | 'not_ready' | 'closed' | 'watch_lagged' | 'invalid_position' | 'history_truncated' | 'ttl_not_enabled' | 'ttl_derived' | 'unknown_operator' | 'no_update' | 'conflicting_update' | 'invalid_field' | 'unindexed_many' | 'empty_filter' | 'invalid_update' | 'http_status' | (string & {});
+type ErrorCode = 'unauthorized' | 'not_found' | 'duplicate_id' | 'unique_violation' | 'catalog_conflict' | 'catalog_invalid' | 'unknown_collection' | 'direct_collection' | 'invalid_request' | 'invalid_query' | 'invalid_pipeline' | 'group_limit_exceeded' | 'cursor_invalid' | 'cursor_mismatch' | 'cursor_expired' | 'request_too_large' | 'line_too_large' | 'not_ready' | 'closed' | 'watch_lagged' | 'invalid_position' | 'history_truncated' | 'ttl_not_enabled' | 'ttl_derived' | 'unknown_operator' | 'no_update' | 'conflicting_update' | 'invalid_field' | 'unindexed_many' | 'empty_filter' | 'confirm_required' | 'invalid_update' | 'http_status' | (string & {});
 declare class NdbError extends Error {
     readonly code: ErrorCode;
     readonly status: number;
@@ -273,5 +320,5 @@ declare class TtlError extends NdbError {
 }
 declare function makeError(code: ErrorCode, message: string, status?: number): NdbError;
 
-export { CursorError, DuplicateIdError, HistoryTruncatedError, InvalidQueryError, InvalidUpdateError, Model, Ndb, NdbError, NotFoundError, Query, TtlError, UnauthorizedError, UniqueViolationError, WatchLaggedError, connect, makeError, newId };
-export type { AggregateOptions, AggregateResult, ConnectOptions, DeleteOptions, DeleteResult, Doc, Duration, ErrorCode, ExpireResult, FieldDef, FieldType, Fields, Filter, Input, InsertOptions, Ops, Row, Schema, SortSpec, TypeMap, UpdateOps, UpdateOptions, UpdateResult, WatchEvent, WatchOptions, Where, WriteResult };
+export { Collection, CursorError, DuplicateIdError, HistoryTruncatedError, InvalidQueryError, InvalidUpdateError, Ndb, NdbError, NotFoundError, Query, TtlError, UnauthorizedError, UniqueViolationError, WatchLaggedError, connect, makeError, newId };
+export type { AggregateOptions, AggregateResult, Blob, ConnectOptions, DeleteOptions, DeleteResult, Doc, Duration, ErrorCode, ExpireResult, FieldDef, FieldType, Fields, Filter, Input, InsertOptions, Ops, Row, Schema, SearchBody, SearchResult, SortSpec, TypeMap, UpdateByOptions, UpdateOps, UpdateOptions, UpdateResult, WatchEvent, WatchOptions, Where, WriteResult };