@norbix.ai/ts 1.0.1

package/dist/index.d.cts

@@ -0,0 +1,225 @@
+import { D as DatabaseModule, A as ApiNamespace } from './index-BARFtiR-.cjs';
+import { HubNamespace } from './hub/index.cjs';
+import { R as RequestOverrideOptions, N as NorbixConfig, L as LoginCredentials, a as LoginResponse, b as ResolvedNorbixConfig } from './transport-c4_dsqN0.cjs';
+import { CodeMashApi2 } from './types/api2.dtos.cjs';
+import './types/hub2.dtos.cjs';
+
+declare class CollectionResource<TItem = unknown> {
+    private readonly database;
+    private readonly collectionName;
+    constructor(database: DatabaseModule, collectionName: string);
+    find(request?: Omit<Partial<CodeMashApi2.FindRequest>, 'collectionName'>, options?: RequestOverrideOptions): Promise<CodeMashApi2.FindResponse>;
+    findItems(request?: Omit<Partial<CodeMashApi2.FindRequest>, 'collectionName'>, options?: RequestOverrideOptions): Promise<TItem[]>;
+    findOne(request: Omit<Partial<CodeMashApi2.FindOneRequest>, 'collectionName'>, options?: RequestOverrideOptions): Promise<CodeMashApi2.FindOneResponse>;
+    count(request?: Omit<Partial<CodeMashApi2.CountRequest>, 'collectionName'>, options?: RequestOverrideOptions): Promise<CodeMashApi2.CountResponse>;
+    distinct(request: Omit<Partial<CodeMashApi2.DistinctRequest>, 'collectionName'>, options?: RequestOverrideOptions): Promise<CodeMashApi2.DistinctResponse>;
+    insertOne(request: Omit<Partial<CodeMashApi2.InsertOneRequest>, 'collectionName'>, options?: RequestOverrideOptions): Promise<CodeMashApi2.IdResponse>;
+    insertMany(request: Omit<Partial<CodeMashApi2.InsertManyRequest>, 'collectionName'>, options?: RequestOverrideOptions): Promise<CodeMashApi2.EmptyResponse>;
+    updateOne(request: Omit<Partial<CodeMashApi2.UpdateOneRequest>, 'collectionName'>, options?: RequestOverrideOptions): Promise<CodeMashApi2.EmptyResponse>;
+    updateMany(request: Omit<Partial<CodeMashApi2.UpdateManyRequest>, 'collectionName'>, options?: RequestOverrideOptions): Promise<CodeMashApi2.EmptyResponse>;
+    replaceOne(request: Omit<Partial<CodeMashApi2.ReplaceOneRequest>, 'collectionName'>, options?: RequestOverrideOptions): Promise<CodeMashApi2.EmptyResponse>;
+    deleteOne(request: Omit<Partial<CodeMashApi2.DeleteOneRequest>, 'collectionName'>, options?: RequestOverrideOptions): Promise<CodeMashApi2.EmptyResponse>;
+    deleteMany(request: Omit<Partial<CodeMashApi2.DeleteManyRequest>, 'collectionName'>, options?: RequestOverrideOptions): Promise<CodeMashApi2.EmptyResponse>;
+    aggregate(request: Omit<Partial<CodeMashApi2.AggregateRequest>, 'collectionName'>, options?: RequestOverrideOptions): Promise<CodeMashApi2.AggregateResponse>;
+    executeAggregate(request: Omit<Partial<CodeMashApi2.ExecuteAggregateRequest>, 'collectionName'>, options?: RequestOverrideOptions): Promise<CodeMashApi2.ExecuteAggregateResponse>;
+}
+
+/**
+ * Single entry point for the Norbix SDK.
+ *
+ * ```ts
+ * // Service-to-service: long-lived API key
+ * const norbix = new Norbix({ apiKey: '...', projectId: '...' });
+ *
+ * // User-on-behalf-of: log in, then act as the user
+ * const norbix = new Norbix({ projectId: '...' });
+ * await norbix.login({ userName: 'alice', password: '...' });
+ * await norbix.api.database.find({ collectionName: 'orders' });
+ *
+ * // Zero-config: read everything from NORBIX_* env vars
+ * const norbix = new Norbix();
+ * ```
+ */
+declare class Norbix {
+    readonly api: ApiNamespace;
+    readonly hub: HubNamespace;
+    private cfg;
+    private transport;
+    /**
+     * Whether each base URL is the SDK default (not user/env supplied). Only
+     * default base URLs are ever rewritten when a region is set; a custom
+     * `baseUrl` is never touched.
+     */
+    private readonly usesDefaultBaseUrl;
+    /** Create a client using explicit configuration (readable alternative to `new Norbix(...)`). */
+    static create(config?: NorbixConfig, opts?: {
+        envSource?: Record<string, string | undefined>;
+    }): Norbix;
+    /**
+     * Create a client from environment variables only (still allows injecting envSource for tests).
+     * Equivalent to `new Norbix({}, opts)`.
+     */
+    static fromEnv(opts?: {
+        envSource?: Record<string, string | undefined>;
+    }): Norbix;
+    constructor(config?: NorbixConfig, opts?: {
+        envSource?: Record<string, string | undefined>;
+    });
+    /**
+     * (Re)compose the base URLs for the configured region. Only the SDK's
+     * default URLs are ever rewritten — `https://api.norbix.dev` becomes
+     * `https://nb-eu-germany.api.norbix.dev` — and clearing the region restores
+     * the defaults. A user-supplied custom base URL is never touched.
+     */
+    private applyRegionToBaseUrls;
+    /**
+     * Exchange credentials for a JWT bearer token. On success, the token is
+     * stored on the client and used for every subsequent call (it takes
+     * precedence over any configured `apiKey`). The full /auth response is
+     * returned so the caller can also access refreshToken, userId, etc.
+     *
+     * The login call itself runs unauthenticated — no Authorization header is
+     * sent for /auth even if a token is already configured.
+     */
+    login(credentials: LoginCredentials): Promise<LoginResponse>;
+    /**
+     * Clear the JWT bearer token. If an `apiKey` was configured, the client
+     * falls back to it; otherwise subsequent calls throw NORBIX_NOT_AUTHENTICATED.
+     */
+    logout(): void;
+    /** Replace the bearer token without rebuilding the client. */
+    setBearerToken(token: string | undefined): void;
+    /** Replace the API key without rebuilding the client. */
+    setApiKey(apiKey: string | undefined): void;
+    /** Switch the client to a different project (and optionally account) at runtime. */
+    setScope(scope: {
+        projectId: string;
+        accountId?: string;
+    }): void;
+    /**
+     * Switch the project environment all subsequent requests target (sent as the
+     * `norbix-env` header). Pass `'PROD'` or `undefined` to return to production.
+     * Per-call `env` overrides still take precedence for individual requests.
+     */
+    setEnv(env: string | undefined): void;
+    /** Current project environment the client targets (defaults to `PROD`). */
+    getEnv(): string;
+    /**
+     * Switch the Norbix region all subsequent requests target (sent as the
+     * `nb-region` header). Pass `undefined` to clear the region — no header is
+     * sent when no region is set. When the client uses the SDK's default base
+     * URLs, the regional URL is recomposed under the same rule as construction;
+     * a custom `baseUrl` is never rewritten. Per-call `region` overrides still
+     * take precedence for individual requests (header only — never the URL).
+     */
+    setRegion(region: string | undefined): void;
+    /** Current Norbix region the client targets (e.g. `nb-eu-germany`), if any. */
+    getRegion(): string | undefined;
+    /** True when the client has either a JWT bearer token or an API key. */
+    isAuthenticated(): boolean;
+    /**
+     * Ergonomic database access wrapper over `norbix.api.database.*`.
+     * Keeps the generated API available, but gives a resource-first call style.
+     */
+    collection<TItem = unknown>(collectionName: string): CollectionResource<TItem>;
+    /** Read-only snapshot of the current config (useful for tests/diagnostics). */
+    getConfig(): Readonly<ResolvedNorbixConfig>;
+    /**
+     * Snapshot suitable for logs/telemetry. Sensitive fields are redacted.
+     * Use `getConfig()` only in tests or trusted diagnostics.
+     */
+    getRedactedConfig(): Readonly<Omit<ResolvedNorbixConfig, 'fetch'>>;
+    /**
+     * Create a new client for per-request scoping (SSR/multi-tenant safe).
+     * The new instance does not share mutable auth or scope with the original.
+     */
+    with(overrides: Pick<NorbixConfig, 'apiKey' | 'bearerToken' | 'projectId' | 'accountId' | 'env' | 'region'>): Norbix;
+}
+
+/**
+ * Shape of a ServiceStack ResponseStatus block returned by the Norbix gateways
+ * on failure. Modelled after the `ResponseStatus` DTO so error envelopes are
+ * consumer-friendly without forcing them to import generated DTO types.
+ */
+interface NorbixErrorPayload {
+    errorCode?: string;
+    message?: string;
+    stackTrace?: string;
+    errors?: Array<{
+        errorCode?: string;
+        fieldName?: string;
+        message?: string;
+        meta?: Record<string, string>;
+    }>;
+    meta?: Record<string, string>;
+}
+declare class NorbixError extends Error {
+    readonly status: number;
+    readonly code?: string;
+    readonly fieldErrors: NonNullable<NorbixErrorPayload['errors']>;
+    readonly raw?: unknown;
+    readonly url?: string;
+    constructor(opts: {
+        message: string;
+        status: number;
+        code?: string;
+        fieldErrors?: NonNullable<NorbixErrorPayload['errors']>;
+        raw?: unknown;
+        url?: string;
+    });
+}
+declare class NorbixNetworkError extends NorbixError {
+    constructor(opts: {
+        message: string;
+        url?: string;
+        raw?: unknown;
+    });
+}
+declare class NorbixTimeoutError extends NorbixError {
+    constructor(opts: {
+        message: string;
+        url?: string;
+        raw?: unknown;
+    });
+}
+declare class NorbixAuthError extends NorbixError {
+    constructor(opts: {
+        message: string;
+        status: number;
+        code?: string;
+        fieldErrors?: NorbixErrorPayload['errors'];
+        url?: string;
+        raw?: unknown;
+    });
+}
+declare class NorbixValidationError extends NorbixError {
+    constructor(opts: {
+        message: string;
+        status: number;
+        code?: string;
+        fieldErrors?: NorbixErrorPayload['errors'];
+        url?: string;
+        raw?: unknown;
+    });
+}
+
+/**
+ * Resolve all NORBIX_* env vars into a typed snapshot. Returns an object with
+ * only the keys that were set, so callers can spread it as a partial config.
+ */
+interface EnvConfig {
+    apiKey?: string;
+    bearerToken?: string;
+    projectId?: string;
+    accountId?: string;
+    env?: string;
+    region?: string;
+    apiUrl?: string;
+    hubUrl?: string;
+    apiVersion?: string;
+    hubVersion?: string;
+    timeoutMs?: number;
+}
+declare function loadEnvConfig(source?: Record<string, string | undefined>): EnvConfig;
+
+export { CollectionResource, type EnvConfig, LoginCredentials, LoginResponse, Norbix, NorbixAuthError, NorbixConfig, NorbixError, type NorbixErrorPayload, NorbixNetworkError, NorbixTimeoutError, NorbixValidationError, loadEnvConfig };

package/dist/index.d.ts

@@ -0,0 +1,225 @@
+import { D as DatabaseModule, A as ApiNamespace } from './index-t6pXnReB.js';
+import { HubNamespace } from './hub/index.js';
+import { R as RequestOverrideOptions, N as NorbixConfig, L as LoginCredentials, a as LoginResponse, b as ResolvedNorbixConfig } from './transport-c4_dsqN0.js';
+import { CodeMashApi2 } from './types/api2.dtos.js';
+import './types/hub2.dtos.js';
+
+declare class CollectionResource<TItem = unknown> {
+    private readonly database;
+    private readonly collectionName;
+    constructor(database: DatabaseModule, collectionName: string);
+    find(request?: Omit<Partial<CodeMashApi2.FindRequest>, 'collectionName'>, options?: RequestOverrideOptions): Promise<CodeMashApi2.FindResponse>;
+    findItems(request?: Omit<Partial<CodeMashApi2.FindRequest>, 'collectionName'>, options?: RequestOverrideOptions): Promise<TItem[]>;
+    findOne(request: Omit<Partial<CodeMashApi2.FindOneRequest>, 'collectionName'>, options?: RequestOverrideOptions): Promise<CodeMashApi2.FindOneResponse>;
+    count(request?: Omit<Partial<CodeMashApi2.CountRequest>, 'collectionName'>, options?: RequestOverrideOptions): Promise<CodeMashApi2.CountResponse>;
+    distinct(request: Omit<Partial<CodeMashApi2.DistinctRequest>, 'collectionName'>, options?: RequestOverrideOptions): Promise<CodeMashApi2.DistinctResponse>;
+    insertOne(request: Omit<Partial<CodeMashApi2.InsertOneRequest>, 'collectionName'>, options?: RequestOverrideOptions): Promise<CodeMashApi2.IdResponse>;
+    insertMany(request: Omit<Partial<CodeMashApi2.InsertManyRequest>, 'collectionName'>, options?: RequestOverrideOptions): Promise<CodeMashApi2.EmptyResponse>;
+    updateOne(request: Omit<Partial<CodeMashApi2.UpdateOneRequest>, 'collectionName'>, options?: RequestOverrideOptions): Promise<CodeMashApi2.EmptyResponse>;
+    updateMany(request: Omit<Partial<CodeMashApi2.UpdateManyRequest>, 'collectionName'>, options?: RequestOverrideOptions): Promise<CodeMashApi2.EmptyResponse>;
+    replaceOne(request: Omit<Partial<CodeMashApi2.ReplaceOneRequest>, 'collectionName'>, options?: RequestOverrideOptions): Promise<CodeMashApi2.EmptyResponse>;
+    deleteOne(request: Omit<Partial<CodeMashApi2.DeleteOneRequest>, 'collectionName'>, options?: RequestOverrideOptions): Promise<CodeMashApi2.EmptyResponse>;
+    deleteMany(request: Omit<Partial<CodeMashApi2.DeleteManyRequest>, 'collectionName'>, options?: RequestOverrideOptions): Promise<CodeMashApi2.EmptyResponse>;
+    aggregate(request: Omit<Partial<CodeMashApi2.AggregateRequest>, 'collectionName'>, options?: RequestOverrideOptions): Promise<CodeMashApi2.AggregateResponse>;
+    executeAggregate(request: Omit<Partial<CodeMashApi2.ExecuteAggregateRequest>, 'collectionName'>, options?: RequestOverrideOptions): Promise<CodeMashApi2.ExecuteAggregateResponse>;
+}
+
+/**
+ * Single entry point for the Norbix SDK.
+ *
+ * ```ts
+ * // Service-to-service: long-lived API key
+ * const norbix = new Norbix({ apiKey: '...', projectId: '...' });
+ *
+ * // User-on-behalf-of: log in, then act as the user
+ * const norbix = new Norbix({ projectId: '...' });
+ * await norbix.login({ userName: 'alice', password: '...' });
+ * await norbix.api.database.find({ collectionName: 'orders' });
+ *
+ * // Zero-config: read everything from NORBIX_* env vars
+ * const norbix = new Norbix();
+ * ```
+ */
+declare class Norbix {
+    readonly api: ApiNamespace;
+    readonly hub: HubNamespace;
+    private cfg;
+    private transport;
+    /**
+     * Whether each base URL is the SDK default (not user/env supplied). Only
+     * default base URLs are ever rewritten when a region is set; a custom
+     * `baseUrl` is never touched.
+     */
+    private readonly usesDefaultBaseUrl;
+    /** Create a client using explicit configuration (readable alternative to `new Norbix(...)`). */
+    static create(config?: NorbixConfig, opts?: {
+        envSource?: Record<string, string | undefined>;
+    }): Norbix;
+    /**
+     * Create a client from environment variables only (still allows injecting envSource for tests).
+     * Equivalent to `new Norbix({}, opts)`.
+     */
+    static fromEnv(opts?: {
+        envSource?: Record<string, string | undefined>;
+    }): Norbix;
+    constructor(config?: NorbixConfig, opts?: {
+        envSource?: Record<string, string | undefined>;
+    });
+    /**
+     * (Re)compose the base URLs for the configured region. Only the SDK's
+     * default URLs are ever rewritten — `https://api.norbix.dev` becomes
+     * `https://nb-eu-germany.api.norbix.dev` — and clearing the region restores
+     * the defaults. A user-supplied custom base URL is never touched.
+     */
+    private applyRegionToBaseUrls;
+    /**
+     * Exchange credentials for a JWT bearer token. On success, the token is
+     * stored on the client and used for every subsequent call (it takes
+     * precedence over any configured `apiKey`). The full /auth response is
+     * returned so the caller can also access refreshToken, userId, etc.
+     *
+     * The login call itself runs unauthenticated — no Authorization header is
+     * sent for /auth even if a token is already configured.
+     */
+    login(credentials: LoginCredentials): Promise<LoginResponse>;
+    /**
+     * Clear the JWT bearer token. If an `apiKey` was configured, the client
+     * falls back to it; otherwise subsequent calls throw NORBIX_NOT_AUTHENTICATED.
+     */
+    logout(): void;
+    /** Replace the bearer token without rebuilding the client. */
+    setBearerToken(token: string | undefined): void;
+    /** Replace the API key without rebuilding the client. */
+    setApiKey(apiKey: string | undefined): void;
+    /** Switch the client to a different project (and optionally account) at runtime. */
+    setScope(scope: {
+        projectId: string;
+        accountId?: string;
+    }): void;
+    /**
+     * Switch the project environment all subsequent requests target (sent as the
+     * `norbix-env` header). Pass `'PROD'` or `undefined` to return to production.
+     * Per-call `env` overrides still take precedence for individual requests.
+     */
+    setEnv(env: string | undefined): void;
+    /** Current project environment the client targets (defaults to `PROD`). */
+    getEnv(): string;
+    /**
+     * Switch the Norbix region all subsequent requests target (sent as the
+     * `nb-region` header). Pass `undefined` to clear the region — no header is
+     * sent when no region is set. When the client uses the SDK's default base
+     * URLs, the regional URL is recomposed under the same rule as construction;
+     * a custom `baseUrl` is never rewritten. Per-call `region` overrides still
+     * take precedence for individual requests (header only — never the URL).
+     */
+    setRegion(region: string | undefined): void;
+    /** Current Norbix region the client targets (e.g. `nb-eu-germany`), if any. */
+    getRegion(): string | undefined;
+    /** True when the client has either a JWT bearer token or an API key. */
+    isAuthenticated(): boolean;
+    /**
+     * Ergonomic database access wrapper over `norbix.api.database.*`.
+     * Keeps the generated API available, but gives a resource-first call style.
+     */
+    collection<TItem = unknown>(collectionName: string): CollectionResource<TItem>;
+    /** Read-only snapshot of the current config (useful for tests/diagnostics). */
+    getConfig(): Readonly<ResolvedNorbixConfig>;
+    /**
+     * Snapshot suitable for logs/telemetry. Sensitive fields are redacted.
+     * Use `getConfig()` only in tests or trusted diagnostics.
+     */
+    getRedactedConfig(): Readonly<Omit<ResolvedNorbixConfig, 'fetch'>>;
+    /**
+     * Create a new client for per-request scoping (SSR/multi-tenant safe).
+     * The new instance does not share mutable auth or scope with the original.
+     */
+    with(overrides: Pick<NorbixConfig, 'apiKey' | 'bearerToken' | 'projectId' | 'accountId' | 'env' | 'region'>): Norbix;
+}
+
+/**
+ * Shape of a ServiceStack ResponseStatus block returned by the Norbix gateways
+ * on failure. Modelled after the `ResponseStatus` DTO so error envelopes are
+ * consumer-friendly without forcing them to import generated DTO types.
+ */
+interface NorbixErrorPayload {
+    errorCode?: string;
+    message?: string;
+    stackTrace?: string;
+    errors?: Array<{
+        errorCode?: string;
+        fieldName?: string;
+        message?: string;
+        meta?: Record<string, string>;
+    }>;
+    meta?: Record<string, string>;
+}
+declare class NorbixError extends Error {
+    readonly status: number;
+    readonly code?: string;
+    readonly fieldErrors: NonNullable<NorbixErrorPayload['errors']>;
+    readonly raw?: unknown;
+    readonly url?: string;
+    constructor(opts: {
+        message: string;
+        status: number;
+        code?: string;
+        fieldErrors?: NonNullable<NorbixErrorPayload['errors']>;
+        raw?: unknown;
+        url?: string;
+    });
+}
+declare class NorbixNetworkError extends NorbixError {
+    constructor(opts: {
+        message: string;
+        url?: string;
+        raw?: unknown;
+    });
+}
+declare class NorbixTimeoutError extends NorbixError {
+    constructor(opts: {
+        message: string;
+        url?: string;
+        raw?: unknown;
+    });
+}
+declare class NorbixAuthError extends NorbixError {
+    constructor(opts: {
+        message: string;
+        status: number;
+        code?: string;
+        fieldErrors?: NorbixErrorPayload['errors'];
+        url?: string;
+        raw?: unknown;
+    });
+}
+declare class NorbixValidationError extends NorbixError {
+    constructor(opts: {
+        message: string;
+        status: number;
+        code?: string;
+        fieldErrors?: NorbixErrorPayload['errors'];
+        url?: string;
+        raw?: unknown;
+    });
+}
+
+/**
+ * Resolve all NORBIX_* env vars into a typed snapshot. Returns an object with
+ * only the keys that were set, so callers can spread it as a partial config.
+ */
+interface EnvConfig {
+    apiKey?: string;
+    bearerToken?: string;
+    projectId?: string;
+    accountId?: string;
+    env?: string;
+    region?: string;
+    apiUrl?: string;
+    hubUrl?: string;
+    apiVersion?: string;
+    hubVersion?: string;
+    timeoutMs?: number;
+}
+declare function loadEnvConfig(source?: Record<string, string | undefined>): EnvConfig;
+
+export { CollectionResource, type EnvConfig, LoginCredentials, LoginResponse, Norbix, NorbixAuthError, NorbixConfig, NorbixError, type NorbixErrorPayload, NorbixNetworkError, NorbixTimeoutError, NorbixValidationError, loadEnvConfig };