@thadeu/ndb 0.0.0-stage → 0.1.1

package/dist/index.d.cts

@@ -0,0 +1,247 @@
+import { Dispatcher } from 'undici';
+
+interface TypeMap {
+    string: string;
+    number: number;
+    boolean: boolean;
+    date: Date;
+    json: unknown;
+}
+type FieldType = keyof TypeMap;
+interface FieldDef {
+    type: FieldType;
+    index?: boolean;
+    unique?: boolean;
+    optional?: boolean;
+}
+type Fields = Record<string, FieldDef>;
+interface Schema<F extends Fields> {
+    id?: Extract<keyof F, string>;
+    time?: Extract<keyof F, string>;
+    expires?: Extract<keyof F, string>;
+    fields: F;
+}
+type ValueOf<D extends FieldDef> = TypeMap[D['type']];
+type OptionalKeys<F extends Fields> = {
+    [K in keyof F]: F[K] extends {
+        optional: true;
+    } ? K : never;
+}[keyof F];
+type Doc<F extends Fields> = {
+    [K in Exclude<keyof F, OptionalKeys<F>>]: ValueOf<F[K]>;
+} & {
+    [K in OptionalKeys<F>]?: ValueOf<F[K]>;
+};
+type Input<F extends Fields> = {
+    [K in keyof F]?: ValueOf<F[K]>;
+};
+type Row<F extends Fields> = Doc<F> & {
+    _v: number;
+};
+interface Ops<V> {
+    $eq?: V;
+    $ne?: V;
+    $gt?: V;
+    $gte?: V;
+    $lt?: V;
+    $lte?: V;
+    $in?: V[];
+    $nin?: V[];
+    $exists?: boolean;
+    $regex?: string | RegExp;
+    $options?: string;
+}
+type Operand<V> = V extends Date ? Date | string : V;
+type RegexOperand<V> = V extends string ? RegExp : never;
+type JsonKeys<F extends Fields> = Extract<{
+    [K in keyof F]: F[K]['type'] extends 'json' ? K : never;
+}[keyof F], string>;
+type Where<F extends Fields> = {
+    [K in keyof F]?: Operand<ValueOf<F[K]>> | Ops<Operand<ValueOf<F[K]>>> | RegexOperand<ValueOf<F[K]>>;
+} & {
+    [P in `${JsonKeys<F>}.${string}`]?: unknown;
+};
+type SortSpec<F extends Fields> = Partial<Record<Extract<keyof F, string>, 1 | -1>>;
+interface WriteResult {
+    id: string;
+    v: number;
+}
+interface WriteOptions {
+    ifVersion?: number;
+}
+type Duration = number | string;
+interface UpdateOptions extends WriteOptions {
+    unset?: string[];
+    expireIn?: Duration;
+}
+interface InsertOptions {
+    expireIn?: Duration;
+}
+interface ExpireResult extends WriteResult {
+    expiresAt: Date;
+}
+interface AggregateOptions {
+    limit?: number;
+    skip?: number;
+    after?: string;
+    count?: boolean;
+}
+interface AggregateResult<R = Record<string, unknown>> {
+    rows: R[];
+    next: string;
+    total: number;
+}
+interface WatchOptions<F extends Fields = Fields> {
+    from?: string;
+    limit?: number;
+    signal?: AbortSignal;
+    where?: Where<F>;
+}
+interface WatchEvent<R> {
+    consumer: string;
+    pos: string;
+    op: 'put' | 'del';
+    id: string;
+    v: number;
+    doc: R | undefined;
+}
+
+interface State {
+    clauses: Record<string, unknown>[];
+    fields?: string[];
+    sort?: Record<string, 1 | -1>;
+    limit?: number;
+    skip?: number;
+    after?: string;
+}
+declare class Query<F extends Fields, R = Row<F>> implements PromiseLike<R[]> {
+    private readonly model;
+    private readonly state;
+    nextCursor: string;
+    constructor(model: Model<F>, state?: State);
+    where(w: Where<F>): Query<F, R>;
+    not(w: Where<F>): Query<F, R>;
+    or(...ws: Where<F>[]): Query<F, R>;
+    sort(spec: SortSpec<F>): Query<F, R>;
+    limit(n: number): Query<F, R>;
+    skip(n: number): Query<F, R>;
+    page(n: number, size: number): Query<F, R>;
+    after(token: string): Query<F, R>;
+    fields(...names: string[]): Query<F, Partial<R>>;
+    then<A = R[], B = never>(onfulfilled?: ((value: R[]) => A | PromiseLike<A>) | null, onrejected?: ((reason: unknown) => B | PromiseLike<B>) | null): Promise<A | B>;
+    all(): Promise<R[]>;
+    first(): Promise<R | null>;
+    count(): Promise<number>;
+    iterate(): AsyncGenerator<R>;
+    private rows;
+    private body;
+    private whereDoc;
+    private with;
+}
+
+declare class Model<F extends Fields> {
+    readonly db: Ndb;
+    readonly name: string;
+    readonly schema: Schema<F>;
+    private ensured?;
+    constructor(db: Ndb, name: string, schema: Schema<F>);
+    get idField(): string;
+    path(op?: string): string;
+    ready(): Promise<void>;
+    insert(docs: Input<F> | Input<F>[], opts?: InsertOptions): Promise<WriteResult[]>;
+    create(docs: Input<F> | Input<F>[], opts?: InsertOptions): Promise<WriteResult[]>;
+    update(id: string, set: Input<F>, opts?: UpdateOptions): Promise<WriteResult>;
+    delete(id: string, opts?: WriteOptions): Promise<void>;
+    expire(id: string, duration: Duration, opts?: WriteOptions): Promise<ExpireResult>;
+    expireAt(id: string, at: Date, opts?: WriteOptions): Promise<ExpireResult>;
+    persist(id: string): Promise<WriteResult>;
+    ttl(id: string): Promise<number | null>;
+    private setExpiry;
+    find(id: string): Promise<Row<F> | null>;
+    query(): Query<F>;
+    where(w: Where<F>): Query<F>;
+    not(w: Where<F>): Query<F>;
+    or(...ws: Where<F>[]): Query<F>;
+    sort(spec: SortSpec<F>): Query<F>;
+    limit(n: number): Query<F>;
+    skip(n: number): Query<F>;
+    page(n: number, size: number): Query<F>;
+    after(token: string): Query<F>;
+    fields(...names: string[]): Query<F, Partial<Row<F>>>;
+    all(): Promise<Row<F>[]>;
+    count(): Promise<number>;
+    first(): Promise<Row<F> | null>;
+    iterate(): AsyncGenerator<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>;
+    decode(raw: Record<string, unknown>): Record<string, unknown>;
+    private catalog;
+}
+
+type Method = 'GET' | 'POST' | 'PUT' | 'DELETE';
+interface Streamed {
+    status: number;
+    headers: Record<string, string | string[] | undefined>;
+    body: Dispatcher.ResponseData["body"];
+    rows(): AsyncGenerator<unknown>;
+    header(name: string): string | undefined;
+}
+interface ConnectOptions {
+    token?: string;
+    readyTimeout?: number;
+}
+declare class Transport {
+    private readonly client;
+    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>;
+    close(): Promise<void>;
+    private withReadyRetry;
+    private headers;
+    private send;
+}
+
+declare class Ndb {
+    readonly transport: Transport;
+    constructor(addr?: string, opts?: ConnectOptions);
+    model<const F extends Fields>(name: string, schema: Schema<F>): Model<F>;
+    health(): Promise<void>;
+    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>;
+}
+declare function connect(addr?: string, opts?: ConnectOptions): Ndb;
+
+type ErrorCode = 'unauthorized' | 'not_found' | 'version_conflict' | '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' | 'http_status' | (string & {});
+declare class NdbError extends Error {
+    readonly code: ErrorCode;
+    readonly status: number;
+    constructor(code: ErrorCode, message: string, status?: number);
+}
+declare class UnauthorizedError extends NdbError {
+}
+declare class NotFoundError extends NdbError {
+}
+declare class VersionConflictError extends NdbError {
+}
+declare class DuplicateIdError extends NdbError {
+}
+declare class UniqueViolationError extends NdbError {
+}
+declare class InvalidQueryError extends NdbError {
+}
+declare class CursorError extends NdbError {
+}
+declare class WatchLaggedError extends NdbError {
+}
+declare class HistoryTruncatedError extends NdbError {
+}
+declare class TtlError extends NdbError {
+}
+declare function makeError(code: ErrorCode, message: string, status?: number): NdbError;
+
+export { CursorError, DuplicateIdError, HistoryTruncatedError, InvalidQueryError, Model, Ndb, NdbError, NotFoundError, Query, TtlError, UnauthorizedError, UniqueViolationError, VersionConflictError, WatchLaggedError, connect, makeError };
+export type { AggregateOptions, AggregateResult, ConnectOptions, Doc, Duration, ErrorCode, ExpireResult, FieldDef, FieldType, Fields, Input, InsertOptions, Ops, Row, Schema, SortSpec, TypeMap, UpdateOptions, WatchEvent, WatchOptions, Where, WriteOptions, WriteResult };

package/dist/index.d.ts

@@ -0,0 +1,247 @@
+import { Dispatcher } from 'undici';
+
+interface TypeMap {
+    string: string;
+    number: number;
+    boolean: boolean;
+    date: Date;
+    json: unknown;
+}
+type FieldType = keyof TypeMap;
+interface FieldDef {
+    type: FieldType;
+    index?: boolean;
+    unique?: boolean;
+    optional?: boolean;
+}
+type Fields = Record<string, FieldDef>;
+interface Schema<F extends Fields> {
+    id?: Extract<keyof F, string>;
+    time?: Extract<keyof F, string>;
+    expires?: Extract<keyof F, string>;
+    fields: F;
+}
+type ValueOf<D extends FieldDef> = TypeMap[D['type']];
+type OptionalKeys<F extends Fields> = {
+    [K in keyof F]: F[K] extends {
+        optional: true;
+    } ? K : never;
+}[keyof F];
+type Doc<F extends Fields> = {
+    [K in Exclude<keyof F, OptionalKeys<F>>]: ValueOf<F[K]>;
+} & {
+    [K in OptionalKeys<F>]?: ValueOf<F[K]>;
+};
+type Input<F extends Fields> = {
+    [K in keyof F]?: ValueOf<F[K]>;
+};
+type Row<F extends Fields> = Doc<F> & {
+    _v: number;
+};
+interface Ops<V> {
+    $eq?: V;
+    $ne?: V;
+    $gt?: V;
+    $gte?: V;
+    $lt?: V;
+    $lte?: V;
+    $in?: V[];
+    $nin?: V[];
+    $exists?: boolean;
+    $regex?: string | RegExp;
+    $options?: string;
+}
+type Operand<V> = V extends Date ? Date | string : V;
+type RegexOperand<V> = V extends string ? RegExp : never;
+type JsonKeys<F extends Fields> = Extract<{
+    [K in keyof F]: F[K]['type'] extends 'json' ? K : never;
+}[keyof F], string>;
+type Where<F extends Fields> = {
+    [K in keyof F]?: Operand<ValueOf<F[K]>> | Ops<Operand<ValueOf<F[K]>>> | RegexOperand<ValueOf<F[K]>>;
+} & {
+    [P in `${JsonKeys<F>}.${string}`]?: unknown;
+};
+type SortSpec<F extends Fields> = Partial<Record<Extract<keyof F, string>, 1 | -1>>;
+interface WriteResult {
+    id: string;
+    v: number;
+}
+interface WriteOptions {
+    ifVersion?: number;
+}
+type Duration = number | string;
+interface UpdateOptions extends WriteOptions {
+    unset?: string[];
+    expireIn?: Duration;
+}
+interface InsertOptions {
+    expireIn?: Duration;
+}
+interface ExpireResult extends WriteResult {
+    expiresAt: Date;
+}
+interface AggregateOptions {
+    limit?: number;
+    skip?: number;
+    after?: string;
+    count?: boolean;
+}
+interface AggregateResult<R = Record<string, unknown>> {
+    rows: R[];
+    next: string;
+    total: number;
+}
+interface WatchOptions<F extends Fields = Fields> {
+    from?: string;
+    limit?: number;
+    signal?: AbortSignal;
+    where?: Where<F>;
+}
+interface WatchEvent<R> {
+    consumer: string;
+    pos: string;
+    op: 'put' | 'del';
+    id: string;
+    v: number;
+    doc: R | undefined;
+}
+
+interface State {
+    clauses: Record<string, unknown>[];
+    fields?: string[];
+    sort?: Record<string, 1 | -1>;
+    limit?: number;
+    skip?: number;
+    after?: string;
+}
+declare class Query<F extends Fields, R = Row<F>> implements PromiseLike<R[]> {
+    private readonly model;
+    private readonly state;
+    nextCursor: string;
+    constructor(model: Model<F>, state?: State);
+    where(w: Where<F>): Query<F, R>;
+    not(w: Where<F>): Query<F, R>;
+    or(...ws: Where<F>[]): Query<F, R>;
+    sort(spec: SortSpec<F>): Query<F, R>;
+    limit(n: number): Query<F, R>;
+    skip(n: number): Query<F, R>;
+    page(n: number, size: number): Query<F, R>;
+    after(token: string): Query<F, R>;
+    fields(...names: string[]): Query<F, Partial<R>>;
+    then<A = R[], B = never>(onfulfilled?: ((value: R[]) => A | PromiseLike<A>) | null, onrejected?: ((reason: unknown) => B | PromiseLike<B>) | null): Promise<A | B>;
+    all(): Promise<R[]>;
+    first(): Promise<R | null>;
+    count(): Promise<number>;
+    iterate(): AsyncGenerator<R>;
+    private rows;
+    private body;
+    private whereDoc;
+    private with;
+}
+
+declare class Model<F extends Fields> {
+    readonly db: Ndb;
+    readonly name: string;
+    readonly schema: Schema<F>;
+    private ensured?;
+    constructor(db: Ndb, name: string, schema: Schema<F>);
+    get idField(): string;
+    path(op?: string): string;
+    ready(): Promise<void>;
+    insert(docs: Input<F> | Input<F>[], opts?: InsertOptions): Promise<WriteResult[]>;
+    create(docs: Input<F> | Input<F>[], opts?: InsertOptions): Promise<WriteResult[]>;
+    update(id: string, set: Input<F>, opts?: UpdateOptions): Promise<WriteResult>;
+    delete(id: string, opts?: WriteOptions): Promise<void>;
+    expire(id: string, duration: Duration, opts?: WriteOptions): Promise<ExpireResult>;
+    expireAt(id: string, at: Date, opts?: WriteOptions): Promise<ExpireResult>;
+    persist(id: string): Promise<WriteResult>;
+    ttl(id: string): Promise<number | null>;
+    private setExpiry;
+    find(id: string): Promise<Row<F> | null>;
+    query(): Query<F>;
+    where(w: Where<F>): Query<F>;
+    not(w: Where<F>): Query<F>;
+    or(...ws: Where<F>[]): Query<F>;
+    sort(spec: SortSpec<F>): Query<F>;
+    limit(n: number): Query<F>;
+    skip(n: number): Query<F>;
+    page(n: number, size: number): Query<F>;
+    after(token: string): Query<F>;
+    fields(...names: string[]): Query<F, Partial<Row<F>>>;
+    all(): Promise<Row<F>[]>;
+    count(): Promise<number>;
+    first(): Promise<Row<F> | null>;
+    iterate(): AsyncGenerator<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>;
+    decode(raw: Record<string, unknown>): Record<string, unknown>;
+    private catalog;
+}
+
+type Method = 'GET' | 'POST' | 'PUT' | 'DELETE';
+interface Streamed {
+    status: number;
+    headers: Record<string, string | string[] | undefined>;
+    body: Dispatcher.ResponseData["body"];
+    rows(): AsyncGenerator<unknown>;
+    header(name: string): string | undefined;
+}
+interface ConnectOptions {
+    token?: string;
+    readyTimeout?: number;
+}
+declare class Transport {
+    private readonly client;
+    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>;
+    close(): Promise<void>;
+    private withReadyRetry;
+    private headers;
+    private send;
+}
+
+declare class Ndb {
+    readonly transport: Transport;
+    constructor(addr?: string, opts?: ConnectOptions);
+    model<const F extends Fields>(name: string, schema: Schema<F>): Model<F>;
+    health(): Promise<void>;
+    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>;
+}
+declare function connect(addr?: string, opts?: ConnectOptions): Ndb;
+
+type ErrorCode = 'unauthorized' | 'not_found' | 'version_conflict' | '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' | 'http_status' | (string & {});
+declare class NdbError extends Error {
+    readonly code: ErrorCode;
+    readonly status: number;
+    constructor(code: ErrorCode, message: string, status?: number);
+}
+declare class UnauthorizedError extends NdbError {
+}
+declare class NotFoundError extends NdbError {
+}
+declare class VersionConflictError extends NdbError {
+}
+declare class DuplicateIdError extends NdbError {
+}
+declare class UniqueViolationError extends NdbError {
+}
+declare class InvalidQueryError extends NdbError {
+}
+declare class CursorError extends NdbError {
+}
+declare class WatchLaggedError extends NdbError {
+}
+declare class HistoryTruncatedError extends NdbError {
+}
+declare class TtlError extends NdbError {
+}
+declare function makeError(code: ErrorCode, message: string, status?: number): NdbError;
+
+export { CursorError, DuplicateIdError, HistoryTruncatedError, InvalidQueryError, Model, Ndb, NdbError, NotFoundError, Query, TtlError, UnauthorizedError, UniqueViolationError, VersionConflictError, WatchLaggedError, connect, makeError };
+export type { AggregateOptions, AggregateResult, ConnectOptions, Doc, Duration, ErrorCode, ExpireResult, FieldDef, FieldType, Fields, Input, InsertOptions, Ops, Row, Schema, SortSpec, TypeMap, UpdateOptions, WatchEvent, WatchOptions, Where, WriteOptions, WriteResult };