hydrousdb 2.0.0 → 2.0.3

package/dist/http-DTukpdAU.d.ts

@@ -1,470 +0,0 @@
-type FilterOp = '==' | '!=' | '>' | '<' | '>=' | '<=' | 'contains';
-interface Filter {
-    field: string;
-    op: FilterOp;
-    value: string | number | boolean;
-}
-interface PaginationMeta {
-    nextCursor: string | null;
-    hasMore: boolean;
-    limit?: number;
-}
-interface ApiMeta extends PaginationMeta {
-    bucketKey?: string;
-    projectId?: string;
-    retrievedAt?: number;
-    filters?: Filter[];
-    timeScope?: string;
-    year?: string;
-    sortOrder?: 'asc' | 'desc';
-}
-interface RequestOptions {
-    /** Abort signal for cancellation */
-    signal?: AbortSignal;
-    /** Additional headers merged into every request */
-    headers?: Record<string, string>;
-}
-interface HydrousConfig {
-    /**
-     * Your HydrousDB auth service key.
-     * Used for all /auth routes (signUp, signIn, session management, etc.)
-     */
-    authKey: string;
-    /**
-     * Your HydrousDB security key.
-     * Used as the credential for records and analytics routes.
-     * The bucket is specified per-call via the bucketKey option on each method.
-     */
-    securityKey: string;
-    /** Override the default base URL (advanced use) */
-    baseUrl?: string;
-    /** Request timeout in milliseconds (default: 30_000) */
-    timeout?: number;
-    /** Number of times to retry on network errors (default: 2) */
-    retries?: number;
-}
-type RecordData = Record<string, unknown>;
-interface HydrousRecord {
-    id: string;
-    created_at?: number;
-    updated_at?: number;
-    [key: string]: unknown;
-}
-interface HistoryEntry {
-    generation: string | null;
-    savedAt: number | null;
-    savedBy: string | null;
-    sizeBytes: number | null;
-}
-interface GetRecordOptions {
-    showHistory?: boolean;
-}
-interface GetRecordResponse {
-    success: true;
-    data: HydrousRecord;
-    meta: {
-        id: string;
-        bucketKey: string;
-        projectId: string;
-        retrievedAt: number;
-        historyCount?: number;
-    };
-    history?: HistoryEntry[];
-}
-interface GetSnapshotResponse {
-    success: true;
-    data: HydrousRecord;
-    meta: {
-        id: string;
-        generation: string;
-        historical: true;
-        bucketKey: string;
-        projectId: string;
-        retrievedAt: number;
-    };
-}
-interface QueryOptions {
-    /** ISO date string or relative shorthand e.g. "7d", "30d" */
-    timeScope?: string;
-    /** Year restriction for monthly GCS walk e.g. "26" or "2026" */
-    year?: string;
-    filters?: Filter[];
-    sortOrder?: 'asc' | 'desc';
-    limit?: number;
-    /** Opaque cursor from a previous response's meta.nextCursor */
-    cursor?: string;
-    /** Comma-separated field names to return */
-    fields?: string;
-}
-interface QueryResponse<T extends RecordData = RecordData> {
-    success: true;
-    data: (T & HydrousRecord)[];
-    meta: ApiMeta;
-}
-interface InsertRecordPayload {
-    values: RecordData;
-    /** Fields to index for querying */
-    queryableFields?: string[];
-    userEmail?: string;
-}
-interface InsertRecordResponse {
-    success: true;
-    data: HydrousRecord;
-    meta: {
-        id: string;
-        bucketKey: string;
-        projectId: string;
-    };
-}
-interface UpdateRecordPayload {
-    recordId: string;
-    values: RecordData;
-    userEmail?: string;
-    reason?: string;
-    track_record_history?: boolean;
-}
-interface UpdateRecordResponse {
-    success: true;
-    meta: {
-        id: string;
-        updatedAt: number;
-    };
-}
-interface DeleteRecordResponse {
-    success: true;
-    meta: {
-        id: string;
-        deleted: true;
-        deletedAt: number;
-        deletedBy: string;
-        bucketKey: string;
-        projectId: string;
-    };
-}
-interface RecordExistsInfo {
-    exists: boolean;
-    id: string;
-    createdAt: string;
-    updatedAt: string;
-    sizeBytes: string;
-}
-interface BatchUpdateItem {
-    recordId: string;
-    values: RecordData;
-}
-interface BatchUpdatePayload {
-    updates: BatchUpdateItem[];
-    userEmail?: string;
-}
-interface BatchResult {
-    successful: number;
-    failed: number;
-    errors?: Array<{
-        recordId: string;
-        error: string;
-    }>;
-}
-interface BatchUpdateResponse {
-    success: true;
-    data: BatchResult;
-    meta: {
-        count: number;
-        bucketKey: string;
-        projectId: string;
-    };
-}
-interface BatchDeletePayload {
-    recordIds: string[];
-    userEmail?: string;
-}
-interface BatchDeleteResponse {
-    success: true;
-    data: BatchResult;
-    meta: {
-        count: number;
-        bucketKey: string;
-        projectId: string;
-    };
-}
-interface BatchInsertPayload {
-    records: RecordData[];
-    queryableFields?: string[];
-    userEmail?: string;
-}
-interface BatchInsertResponse {
-    success: boolean;
-    data: HydrousRecord[];
-    errors?: Array<{
-        index: number;
-        error: string;
-    }>;
-    meta: {
-        totalProcessed: number;
-        successful: number;
-        failed: number;
-        bucketKey: string;
-        projectId: string;
-    };
-}
-interface AuthUser {
-    id: string;
-    email: string;
-    fullName?: string | null;
-    role?: string;
-    emailVerified?: boolean;
-    accountStatus?: string;
-    createdAt?: number;
-    updatedAt?: number;
-    lastLoginAt?: number | null;
-    [key: string]: unknown;
-}
-interface SessionInfo {
-    sessionId: string;
-    refreshToken: string;
-    expiresAt: number;
-}
-interface SignUpPayload {
-    email: string;
-    password: string;
-    fullName?: string;
-    [key: string]: unknown;
-}
-interface SignUpResponse {
-    success: true;
-    message: string;
-    data: AuthUser;
-    session: SessionInfo;
-    meta: {
-        userId: string;
-        email: string;
-        requiresVerification: boolean;
-        requestId: string;
-    };
-}
-interface SignInPayload {
-    email: string;
-    password: string;
-}
-interface SignInResponse {
-    success: true;
-    message: string;
-    data: AuthUser;
-    session: SessionInfo;
-    meta: {
-        userId: string;
-        lastLogin: number | null;
-        requestId: string;
-    };
-}
-interface SignOutPayload {
-    sessionId?: string;
-    allDevices?: boolean;
-    userId?: string;
-}
-interface ValidateSessionResponse {
-    success: true;
-    data: AuthUser;
-    session: {
-        sessionId: string;
-        expiresAt: number;
-    };
-    requestId: string;
-}
-interface RefreshSessionResponse {
-    success: true;
-    data: AuthUser;
-    session: SessionInfo;
-    requestId: string;
-}
-interface GetUserResponse {
-    success: true;
-    data: AuthUser;
-    meta: {
-        userId: string;
-        requestId: string;
-        timestamp: number;
-    };
-}
-interface ListUsersResponse {
-    success: true;
-    data: AuthUser[];
-    meta: PaginationMeta & {
-        requestId: string;
-    };
-}
-interface UpdateUserPayload {
-    userId: string;
-    updates: Partial<AuthUser> & Record<string, unknown>;
-}
-interface UpdateUserResponse {
-    success: true;
-    message: string;
-    data: AuthUser;
-    meta: {
-        userId: string;
-        requestId: string;
-    };
-}
-interface PasswordChangePayload {
-    userId: string;
-    oldPassword: string;
-    newPassword: string;
-}
-interface PasswordResetRequestPayload {
-    email: string;
-}
-interface PasswordResetConfirmPayload {
-    resetToken: string;
-    newPassword: string;
-}
-interface EmailVerifyRequestPayload {
-    userId: string;
-}
-interface EmailVerifyConfirmPayload {
-    verifyToken: string;
-}
-interface AccountLockPayload {
-    userId: string;
-    /** Duration in ms — defaults to 15 min */
-    duration?: number;
-}
-interface AccountLockResponse {
-    success: true;
-    message: string;
-    data: {
-        lockedUntil: number;
-        unlockTime: string;
-    };
-    meta: {
-        userId: string;
-        requestId: string;
-    };
-}
-type AnalyticsQueryType = 'count' | 'distribution' | 'sum' | 'timeSeries' | 'fieldTimeSeries' | 'topN' | 'stats' | 'records' | 'multiMetric' | 'storageStats' | 'crossBucket';
-interface DateRange {
-    startDate?: string;
-    endDate?: string;
-    year?: string;
-    month?: string;
-    day?: string;
-}
-interface MultiMetricItem {
-    name: string;
-    field: string;
-    aggregation: 'sum' | 'avg' | 'min' | 'max' | 'count';
-}
-interface AnalyticsQuery {
-    queryType: AnalyticsQueryType;
-    dateRange?: DateRange;
-    field?: string;
-    groupBy?: string;
-    labelField?: string;
-    aggregation?: 'sum' | 'avg' | 'min' | 'max' | 'count';
-    granularity?: 'hour' | 'day' | 'week' | 'month';
-    filters?: Filter[];
-    selectFields?: string[];
-    limit?: number;
-    offset?: number;
-    orderBy?: string;
-    order?: 'asc' | 'desc';
-    n?: number;
-    metrics?: MultiMetricItem[];
-    bucketKeys?: string[];
-}
-interface CountResult {
-    count: number;
-}
-interface DistributionItem {
-    value: string;
-    count: number;
-}
-interface SumResult {
-    total: number;
-    groups?: Array<{
-        group: string;
-        total: number;
-    }>;
-}
-interface TimeSeriesPoint {
-    date: string;
-    count: number;
-}
-interface FieldTimeSeriesPoint {
-    date: string;
-    value: number;
-}
-interface TopNItem {
-    label: string;
-    value: string;
-    count: number;
-}
-interface FieldStatsResult {
-    min: number;
-    max: number;
-    avg: number;
-    stddev: number;
-    count: number;
-    sum: number;
-    p50: number;
-    p90: number;
-    p99: number;
-}
-interface FilteredRecordsResult {
-    data: RecordData[];
-    hasMore: boolean;
-    offset: number;
-    limit: number;
-}
-interface StorageStatsResult {
-    totalRecords: number;
-    totalBytes: number;
-    avgBytes: number;
-    minBytes: number;
-    maxBytes: number;
-}
-interface AnalyticsResponse {
-    success: true;
-    data: unknown;
-    meta?: Record<string, unknown>;
-}
-interface HydrousErrorBody {
-    success: false;
-    error: string;
-    code?: string;
-    details?: string[];
-    requestId?: string;
-}
-
-interface HttpClientConfig {
-    authKey: string;
-    securityKey: string;
-    baseUrl?: string;
-    timeout?: number;
-    retries?: number;
-}
-declare class HttpClient {
-    readonly baseUrl: string;
-    readonly authKey: string;
-    readonly securityKey: string;
-    private readonly timeout;
-    private readonly retries;
-    constructor(config: HttpClientConfig);
-    request<T>(method: string, path: string, options?: {
-        body?: unknown;
-        params?: Record<string, string | number | boolean | undefined | null>;
-        signal?: AbortSignal;
-        headers?: Record<string, string>;
-        /** Return raw Response instead of parsed JSON (used by HEAD) */
-        raw?: boolean;
-    }): Promise<T>;
-    get<T>(path: string, params?: Record<string, string | number | boolean | undefined | null>, opts?: RequestOptions): Promise<T>;
-    post<T>(path: string, body?: unknown, opts?: RequestOptions): Promise<T>;
-    patch<T>(path: string, body?: unknown, opts?: RequestOptions): Promise<T>;
-    delete<T>(path: string, params?: Record<string, string | number | boolean | undefined | null>, opts?: RequestOptions): Promise<T>;
-    head(path: string, params?: Record<string, string | number | boolean | undefined | null>, opts?: RequestOptions): Promise<Response>;
-    private buildUrl;
-    private buildSignal;
-    private executeWithRetry;
-}
-
-export { type SignUpResponse as $, type AccountLockPayload as A, type BatchDeletePayload as B, type CountResult as C, type DateRange as D, type EmailVerifyConfirmPayload as E, type FieldStatsResult as F, type GetRecordOptions as G, type HydrousErrorBody as H, type InsertRecordPayload as I, type InsertRecordResponse as J, type PasswordChangePayload as K, type ListUsersResponse as L, type MultiMetricItem as M, type PasswordResetConfirmPayload as N, type PasswordResetRequestPayload as O, type PaginationMeta as P, type QueryOptions as Q, type QueryResponse as R, type RecordData as S, type RecordExistsInfo as T, type RefreshSessionResponse as U, type RequestOptions as V, type SessionInfo as W, type SignInPayload as X, type SignInResponse as Y, type SignOutPayload as Z, type SignUpPayload as _, type HydrousConfig as a, type StorageStatsResult as a0, type SumResult as a1, type TimeSeriesPoint as a2, type TopNItem as a3, type UpdateRecordPayload as a4, type UpdateRecordResponse as a5, type UpdateUserPayload as a6, type UpdateUserResponse as a7, type ValidateSessionResponse as a8, HttpClient as a9, type AccountLockResponse as b, type AnalyticsQuery as c, type AnalyticsQueryType as d, type AnalyticsResponse as e, type ApiMeta as f, type AuthUser as g, type BatchDeleteResponse as h, type BatchInsertPayload as i, type BatchInsertResponse as j, type BatchResult as k, type BatchUpdateItem as l, type BatchUpdatePayload as m, type BatchUpdateResponse as n, type DeleteRecordResponse as o, type DistributionItem as p, type EmailVerifyRequestPayload as q, type FieldTimeSeriesPoint as r, type Filter as s, type FilterOp as t, type FilteredRecordsResult as u, type GetRecordResponse as v, type GetSnapshotResponse as w, type GetUserResponse as x, type HistoryEntry as y, type HydrousRecord as z };

package/dist/records/index.d.mts

@@ -1,137 +0,0 @@
-import { a9 as HttpClient, G as GetRecordOptions, V as RequestOptions, v as GetRecordResponse, w as GetSnapshotResponse, S as RecordData, Q as QueryOptions, R as QueryResponse, I as InsertRecordPayload, J as InsertRecordResponse, a4 as UpdateRecordPayload, a5 as UpdateRecordResponse, o as DeleteRecordResponse, T as RecordExistsInfo, m as BatchUpdatePayload, n as BatchUpdateResponse, B as BatchDeletePayload, h as BatchDeleteResponse, i as BatchInsertPayload, j as BatchInsertResponse, z as HydrousRecord } from '../http-DTukpdAU.mjs';
-export { s as Filter, t as FilterOp, y as HistoryEntry } from '../http-DTukpdAU.mjs';
-
-/** Options accepted by every records method that needs a bucket */
-interface BucketOptions {
-    /**
-     * The bucket to read from or write to.
-     * Required on all records and analytics calls.
-     *
-     * @example
-     * await db.records.insert({ values: { name: 'Alice' } }, { bucketKey: 'users' });
-     */
-    bucketKey: string;
-}
-declare class RecordsClient {
-    private readonly http;
-    constructor(http: HttpClient);
-    /** Builds the base path for a given bucket: /api/:bucketKey/:securityKey */
-    private path;
-    /**
-     * Fetch a single record by ID.
-     *
-     * @example
-     * const { data } = await db.records.get('rec_abc123', { bucketKey: 'users' });
-     * const { data, history } = await db.records.get('rec_abc123', { bucketKey: 'users', showHistory: true });
-     */
-    get(recordId: string, options: GetRecordOptions & BucketOptions & RequestOptions): Promise<GetRecordResponse>;
-    /**
-     * Fetch a specific historical version (generation) of a record.
-     *
-     * @example
-     * const { data } = await db.records.getSnapshot('rec_abc123', '1700000000000000', { bucketKey: 'users' });
-     */
-    getSnapshot(recordId: string, generation: string, options: BucketOptions & RequestOptions): Promise<GetSnapshotResponse>;
-    /**
-     * Query a collection with optional filters, sorting, and pagination.
-     *
-     * @example
-     * // Simple query
-     * const { data, meta } = await db.records.query({ bucketKey: 'orders', limit: 50 });
-     *
-     * // Filtered query
-     * const { data } = await db.records.query({
-     *   bucketKey: 'orders',
-     *   filters: [{ field: 'status', op: '==', value: 'active' }],
-     *   timeScope: '7d',
-     * });
-     *
-     * // Paginated
-     * let cursor: string | null = null;
-     * do {
-     *   const result = await db.records.query({ bucketKey: 'orders', limit: 100, cursor: cursor ?? undefined });
-     *   cursor = result.meta.nextCursor;
-     * } while (cursor);
-     */
-    query<T extends RecordData = RecordData>(options: QueryOptions & BucketOptions & RequestOptions): Promise<QueryResponse<T>>;
-    /**
-     * Insert a new record into the specified bucket.
-     *
-     * @example
-     * const { data, meta } = await db.records.insert(
-     *   { values: { name: 'Alice', score: 99 }, queryableFields: ['name'] },
-     *   { bucketKey: 'users' }
-     * );
-     */
-    insert(payload: InsertRecordPayload, options: BucketOptions & RequestOptions): Promise<InsertRecordResponse>;
-    /**
-     * Update an existing record.
-     *
-     * @example
-     * await db.records.update(
-     *   { recordId: 'rec_abc123', values: { score: 100 }, track_record_history: true },
-     *   { bucketKey: 'users' }
-     * );
-     */
-    update(payload: UpdateRecordPayload, options: BucketOptions & RequestOptions): Promise<UpdateRecordResponse>;
-    /**
-     * Delete a record permanently.
-     *
-     * @example
-     * await db.records.delete('rec_abc123', { bucketKey: 'users' });
-     */
-    delete(recordId: string, options: BucketOptions & RequestOptions): Promise<DeleteRecordResponse>;
-    /**
-     * Check whether a record exists without fetching its full data.
-     * Returns `null` if the record is not found.
-     *
-     * @example
-     * const info = await db.records.exists('rec_abc123', { bucketKey: 'users' });
-     * if (info?.exists) console.log('found at', info.updatedAt);
-     */
-    exists(recordId: string, options: BucketOptions & RequestOptions): Promise<RecordExistsInfo | null>;
-    /**
-     * Update up to 500 records in a single request.
-     *
-     * @example
-     * await db.records.batchUpdate(
-     *   { updates: [{ recordId: 'rec_1', values: { status: 'archived' } }] },
-     *   { bucketKey: 'orders' }
-     * );
-     */
-    batchUpdate(payload: BatchUpdatePayload, options: BucketOptions & RequestOptions): Promise<BatchUpdateResponse>;
-    /**
-     * Delete up to 500 records in a single request.
-     *
-     * @example
-     * await db.records.batchDelete(
-     *   { recordIds: ['rec_1', 'rec_2'] },
-     *   { bucketKey: 'orders' }
-     * );
-     */
-    batchDelete(payload: BatchDeletePayload, options: BucketOptions & RequestOptions): Promise<BatchDeleteResponse>;
-    /**
-     * Insert up to 500 records in a single request.
-     * Returns HTTP 207 (multi-status) — check `meta.failed` for partial failures.
-     *
-     * @example
-     * const result = await db.records.batchInsert(
-     *   { records: [{ name: 'Alice' }, { name: 'Bob' }], queryableFields: ['name'] },
-     *   { bucketKey: 'users' }
-     * );
-     */
-    batchInsert(payload: BatchInsertPayload, options: BucketOptions & RequestOptions): Promise<BatchInsertResponse>;
-    /**
-     * Fetch ALL records matching a query, automatically following cursors.
-     * Use with care on large collections — prefer `query()` with manual pagination.
-     *
-     * @example
-     * const allRecords = await db.records.queryAll({
-     *   bucketKey: 'orders',
-     *   filters: [{ field: 'type', op: '==', value: 'invoice' }],
-     * });
-     */
-    queryAll<T extends RecordData = RecordData>(options: Omit<QueryOptions, 'cursor'> & BucketOptions & RequestOptions): Promise<(T & HydrousRecord)[]>;
-}
-
-export { BatchDeletePayload, BatchDeleteResponse, BatchInsertPayload, BatchInsertResponse, BatchUpdatePayload, BatchUpdateResponse, type BucketOptions, DeleteRecordResponse, GetRecordOptions, GetRecordResponse, GetSnapshotResponse, HydrousRecord, InsertRecordPayload, InsertRecordResponse, QueryOptions, QueryResponse, RecordData, RecordExistsInfo, RecordsClient, UpdateRecordPayload, UpdateRecordResponse };