hydrousdb 1.1.0

package/dist/http-CIXLF5GV.d.ts

@@ -0,0 +1,466 @@
+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 API key */
+    apiKey: string;
+    /** Your bucket key */
+    bucketKey: 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 {
+    /** ISO date string "YYYY-MM-DD", epoch ms, or year string "26"/"2026" */
+    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;
+    /** For 'multiMetric' — array of { name, field, aggregation } */
+    metrics?: MultiMetricItem[];
+    /** For 'crossBucket' — list of bucket keys to compare */
+    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 {
+    apiKey: string;
+    bucketKey: string;
+    baseUrl?: string;
+    timeout?: number;
+    retries?: number;
+}
+declare class HttpClient {
+    readonly baseUrl: string;
+    readonly bucketKey: string;
+    private readonly apiKey;
+    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/index.d.mts

@@ -0,0 +1,73 @@
+import { RecordsClient } from './records/index.mjs';
+import { AuthClient } from './auth/index.mjs';
+import { AnalyticsClient } from './analytics/index.mjs';
+import { H as HydrousErrorBody, a as HydrousConfig } from './http-CIXLF5GV.mjs';
+export { A as AccountLockPayload, b as AccountLockResponse, c as AnalyticsQuery, d as AnalyticsQueryType, e as AnalyticsResponse, f as ApiMeta, g as AuthUser, B as BatchDeletePayload, h as BatchDeleteResponse, i as BatchInsertPayload, j as BatchInsertResponse, k as BatchResult, l as BatchUpdateItem, m as BatchUpdatePayload, n as BatchUpdateResponse, C as CountResult, D as DateRange, o as DeleteRecordResponse, p as DistributionItem, E as EmailVerifyConfirmPayload, q as EmailVerifyRequestPayload, F as FieldStatsResult, r as FieldTimeSeriesPoint, s as Filter, t as FilterOp, u as FilteredRecordsResult, G as GetRecordOptions, v as GetRecordResponse, w as GetSnapshotResponse, x as GetUserResponse, y as HistoryEntry, z as HydrousRecord, I as InsertRecordPayload, J as InsertRecordResponse, L as ListUsersResponse, M as MultiMetricItem, P as PaginationMeta, K as PasswordChangePayload, N as PasswordResetConfirmPayload, O as PasswordResetRequestPayload, Q as QueryOptions, R as QueryResponse, S as RecordData, T as RecordExistsInfo, U as RefreshSessionResponse, V as RequestOptions, W as SessionInfo, X as SignInPayload, Y as SignInResponse, Z as SignOutPayload, _ as SignUpPayload, $ as SignUpResponse, a0 as StorageStatsResult, a1 as SumResult, a2 as TimeSeriesPoint, a3 as TopNItem, a4 as UpdateRecordPayload, a5 as UpdateRecordResponse, a6 as UpdateUserPayload, a7 as UpdateUserResponse, a8 as ValidateSessionResponse } from './http-CIXLF5GV.mjs';
+
+/**
+ * Thrown for any non-2xx response from the HydrousDB API.
+ */
+declare class HydrousError extends Error {
+    /** HTTP status code */
+    readonly status: number;
+    /** Machine-readable error code from the API */
+    readonly code: string | undefined;
+    /** Detailed validation messages */
+    readonly details: string[];
+    /** Server-generated request ID for support */
+    readonly requestId: string | undefined;
+    constructor(body: HydrousErrorBody, status: number);
+}
+/**
+ * Thrown when a network request fails (e.g. no connectivity, DNS failure).
+ */
+declare class HydrousNetworkError extends Error {
+    readonly cause: unknown;
+    constructor(message: string, cause?: unknown);
+}
+/**
+ * Thrown when a request exceeds the configured timeout.
+ */
+declare class HydrousTimeoutError extends Error {
+    constructor(timeoutMs: number);
+}
+
+/**
+ * The main entry point for the HydrousDB SDK.
+ *
+ * @example
+ * import { createClient } from 'hydrousdb';
+ *
+ * const db = createClient({
+ *   apiKey: 'your-api-key',
+ *   bucketKey: 'your-bucket',
+ * });
+ *
+ * // Records
+ * const { data } = await db.records.get('rec_abc123');
+ *
+ * // Auth
+ * const { data, session } = await db.auth.signIn({ email: 'a@b.com', password: '...' });
+ *
+ * // Analytics
+ * const { data } = await db.analytics.count();
+ */
+declare class HydrousClient {
+    /** Record CRUD and batch operations */
+    readonly records: RecordsClient;
+    /** User authentication and session management */
+    readonly auth: AuthClient;
+    /** Analytics and aggregations */
+    readonly analytics: AnalyticsClient;
+    private readonly http;
+    constructor(config: HydrousConfig);
+}
+/**
+ * Create a HydrousDB client.
+ *
+ * @example
+ * const db = createClient({ apiKey: '...', bucketKey: '...' });
+ */
+declare function createClient(config: HydrousConfig): HydrousClient;
+
+export { AnalyticsClient, AuthClient, HydrousClient, HydrousConfig, HydrousError, HydrousErrorBody, HydrousNetworkError, HydrousTimeoutError, RecordsClient, createClient };

package/dist/index.d.ts

@@ -0,0 +1,73 @@
+import { RecordsClient } from './records/index.js';
+import { AuthClient } from './auth/index.js';
+import { AnalyticsClient } from './analytics/index.js';
+import { H as HydrousErrorBody, a as HydrousConfig } from './http-CIXLF5GV.js';
+export { A as AccountLockPayload, b as AccountLockResponse, c as AnalyticsQuery, d as AnalyticsQueryType, e as AnalyticsResponse, f as ApiMeta, g as AuthUser, B as BatchDeletePayload, h as BatchDeleteResponse, i as BatchInsertPayload, j as BatchInsertResponse, k as BatchResult, l as BatchUpdateItem, m as BatchUpdatePayload, n as BatchUpdateResponse, C as CountResult, D as DateRange, o as DeleteRecordResponse, p as DistributionItem, E as EmailVerifyConfirmPayload, q as EmailVerifyRequestPayload, F as FieldStatsResult, r as FieldTimeSeriesPoint, s as Filter, t as FilterOp, u as FilteredRecordsResult, G as GetRecordOptions, v as GetRecordResponse, w as GetSnapshotResponse, x as GetUserResponse, y as HistoryEntry, z as HydrousRecord, I as InsertRecordPayload, J as InsertRecordResponse, L as ListUsersResponse, M as MultiMetricItem, P as PaginationMeta, K as PasswordChangePayload, N as PasswordResetConfirmPayload, O as PasswordResetRequestPayload, Q as QueryOptions, R as QueryResponse, S as RecordData, T as RecordExistsInfo, U as RefreshSessionResponse, V as RequestOptions, W as SessionInfo, X as SignInPayload, Y as SignInResponse, Z as SignOutPayload, _ as SignUpPayload, $ as SignUpResponse, a0 as StorageStatsResult, a1 as SumResult, a2 as TimeSeriesPoint, a3 as TopNItem, a4 as UpdateRecordPayload, a5 as UpdateRecordResponse, a6 as UpdateUserPayload, a7 as UpdateUserResponse, a8 as ValidateSessionResponse } from './http-CIXLF5GV.js';
+
+/**
+ * Thrown for any non-2xx response from the HydrousDB API.
+ */
+declare class HydrousError extends Error {
+    /** HTTP status code */
+    readonly status: number;
+    /** Machine-readable error code from the API */
+    readonly code: string | undefined;
+    /** Detailed validation messages */
+    readonly details: string[];
+    /** Server-generated request ID for support */
+    readonly requestId: string | undefined;
+    constructor(body: HydrousErrorBody, status: number);
+}
+/**
+ * Thrown when a network request fails (e.g. no connectivity, DNS failure).
+ */
+declare class HydrousNetworkError extends Error {
+    readonly cause: unknown;
+    constructor(message: string, cause?: unknown);
+}
+/**
+ * Thrown when a request exceeds the configured timeout.
+ */
+declare class HydrousTimeoutError extends Error {
+    constructor(timeoutMs: number);
+}
+
+/**
+ * The main entry point for the HydrousDB SDK.
+ *
+ * @example
+ * import { createClient } from 'hydrousdb';
+ *
+ * const db = createClient({
+ *   apiKey: 'your-api-key',
+ *   bucketKey: 'your-bucket',
+ * });
+ *
+ * // Records
+ * const { data } = await db.records.get('rec_abc123');
+ *
+ * // Auth
+ * const { data, session } = await db.auth.signIn({ email: 'a@b.com', password: '...' });
+ *
+ * // Analytics
+ * const { data } = await db.analytics.count();
+ */
+declare class HydrousClient {
+    /** Record CRUD and batch operations */
+    readonly records: RecordsClient;
+    /** User authentication and session management */
+    readonly auth: AuthClient;
+    /** Analytics and aggregations */
+    readonly analytics: AnalyticsClient;
+    private readonly http;
+    constructor(config: HydrousConfig);
+}
+/**
+ * Create a HydrousDB client.
+ *
+ * @example
+ * const db = createClient({ apiKey: '...', bucketKey: '...' });
+ */
+declare function createClient(config: HydrousConfig): HydrousClient;
+
+export { AnalyticsClient, AuthClient, HydrousClient, HydrousConfig, HydrousError, HydrousErrorBody, HydrousNetworkError, HydrousTimeoutError, RecordsClient, createClient };