@nangohq/types 0.68.0 → 0.69.0

package/dist/billing/types.d.ts

@@ -2,7 +2,7 @@ import type { Result } from '../result.js';
 import type { DBTeam } from '../team/db.js';
 import type { DBUser } from '../user/db.js';
 export interface BillingClient {
-    ingest: (events: BillingIngestEvent[]) => Promise<void>;
+    ingest: (events: BillingEvent[]) => Promise<Result<void>>;
     upsertCustomer: (team: DBTeam, user: DBUser) => Promise<Result<BillingCustomer>>;
     updateCustomer: (customerId: string, name: string) => Promise<Result<void>>;
     linkStripeToCustomer(teamId: number, customerId: string): Promise<Result<void>>;
@@ -52,19 +52,71 @@ export interface BillingPlan {
     id: string;
     external_plan_id: string;
 }
-export interface BillingIngestEvent {
-    type: 'monthly_active_records' | 'billable_connections' | 'billable_actions' | 'billable_active_connections' | 'function_executions';
-    idempotencyKey: string;
-    accountId: number;
-    timestamp: Date;
-    properties: Record<string, string | number | Date>;
-}
-export interface BillingMetric {
-    type: BillingIngestEvent['type'];
-    value: number;
+type BillingPropertyValue = string | number | boolean | Date | undefined;
+type BillingProperties = Record<string, BillingPropertyValue | Record<string, BillingPropertyValue>>;
+interface BillingEventBase<TType extends string, TProperties extends BillingProperties = BillingProperties> {
+    type: TType;
     properties: {
-        accountId: number;
-        timestamp?: Date | undefined;
+        timestamp: Date;
         idempotencyKey?: string | undefined;
-    } & BillingIngestEvent['properties'];
+        accountId: number;
+        count: number;
+    } & TProperties;
 }
+export type MarBillingEvent = BillingEventBase<'monthly_active_records', {
+    connectionId: number;
+    environmentId: number;
+    providerConfigKey: string;
+    syncId: string;
+    model: string;
+}>;
+export type RecordsBillingEvent = BillingEventBase<'records', {
+    frequencyMs: number;
+    telemetry: {
+        sizeBytes: number;
+    };
+}>;
+export type ActionsBillingEvent = BillingEventBase<'billable_actions', {
+    connectionId: number;
+    environmentId: number;
+    providerConfigKey: string;
+    actionName: string;
+}>;
+export type FunctionExecutionsBillingEvent = BillingEventBase<'function_executions', {
+    type: string;
+    connectionId: number;
+    telemetry: {
+        successes: number;
+        failures: number;
+        durationMs: number;
+        compute: number;
+        customLogs: number;
+        proxyCalls: number;
+    };
+    frequencyMs?: number | undefined;
+}>;
+export type ProxyBillingEvent = BillingEventBase<'proxy', {
+    connectionId: number;
+    environmentId: number;
+    providerConfigKey: string;
+    provider: string;
+    telemetry: {
+        successes: number;
+        failures: number;
+    };
+}>;
+export type WebhookForwardBillingEvent = BillingEventBase<'webhook_forwards', {
+    environmentId: number;
+    providerConfigKey: string;
+    provider: string;
+    telemetry: {
+        successes: number;
+        failures: number;
+    };
+}>;
+export type ConnectionsBillingEvent = BillingEventBase<'billable_connections'>;
+export type ConnectionsBillingEventV2 = BillingEventBase<'billable_connections_v2', {
+    frequencyMs: number;
+}>;
+export type BillingEvent = MarBillingEvent | RecordsBillingEvent | ActionsBillingEvent | ProxyBillingEvent | WebhookForwardBillingEvent | FunctionExecutionsBillingEvent | ConnectionsBillingEvent | ConnectionsBillingEventV2;
+export {};

package/dist/dbConfig/db.d.ts

@@ -0,0 +1,4 @@
+export interface DBConfig {
+    encryption_key_hash: string | null;
+    encryption_complete: boolean;
+}

package/dist/index.d.ts

@@ -49,7 +49,7 @@ export type * from './integration/api.js';
 export type * from './integration/db.js';
 export type * from './providers/provider.js';
 export type * from './auth/api.js';
-export type * from './auth/db.js';
+export type * from './oauthSessions/db.js';
 export type * from './auth/http.api.js';
 export type * from './deploy/api.js';
 export type * from './deploy/index.js';
@@ -64,6 +64,7 @@ export type * from './plans/db.js';
 export type * from './plans/http.api.js';
 export type * from './stripe/http.api.js';
 export type * from './proxy/http.api.js';
+export type * from './dbConfig/db.js';
 export type * from './nangoYaml/index.js';
 export type * from './environment/db.js';
 export type * from './environment/api/index.js';

package/dist/oauthSessions/db.d.ts

@@ -0,0 +1,34 @@
+import type { AuthModeType } from '../auth/api.js';
+import type { Timestamps } from '../db.js';
+export interface DBOAuthSession extends Timestamps {
+    id: string;
+    provider_config_key: string;
+    provider: string;
+    connection_id: string;
+    callbackUrl: string;
+    authMode: AuthModeType;
+    connect_session_id: number | null;
+    connection_config: Record<string, string>;
+    environment_id: number;
+    web_socket_client_id: string | undefined;
+    activity_log_id: string;
+    code_verifier: string | null;
+    request_token_secret: string | null;
+}
+export interface OAuthSession {
+    id: string;
+    providerConfigKey: string;
+    provider: string;
+    connectionId: string;
+    callbackUrl: string;
+    authMode: AuthModeType;
+    connectSessionId: number | null;
+    connectionConfig: Record<string, string>;
+    environmentId: number;
+    webSocketClientId: string | undefined;
+    activityLogId: string;
+    codeVerifier: string | null;
+    requestTokenSecret: string | null;
+    createdAt: Date;
+    updatedAt: Date;
+}

package/dist/plans/db.d.ts

@@ -9,6 +9,7 @@ export interface DBPlan extends Timestamps {
     orb_subscription_id: string | null;
     orb_future_plan: string | null;
     orb_future_plan_at: Date | null;
+    orb_subscribed_at: Date | null;
     trial_start_at: Date | null;
     trial_end_at: Date | null;
     trial_extension_count: number;

package/dist/providers/provider.d.ts

@@ -43,9 +43,7 @@ export interface BaseProvider {
         base_url: string;
         headers?: Record<string, string>;
         connection_config?: Record<string, string>;
-        query?: {
-            api_key: string;
-        };
+        query?: Record<string, string>;
         retry?: RetryHeaderConfig;
         decompress?: boolean;
         paginate?: LinkPagination | CursorPagination | OffsetPagination;
@@ -155,6 +153,23 @@ export interface ProviderGithubApp extends BaseProvider {
 }
 export interface ProviderTwoStep extends Omit<BaseProvider, 'body_format'> {
     auth_mode: 'TWO_STEP';
+    signature?: {
+        protocol: 'RSA';
+    };
+    token?: {
+        signing_key: string;
+        expires_in_ms: number;
+        header: {
+            alg: string;
+            typ?: string;
+        };
+        payload: {
+            iss?: string;
+            scope?: string;
+            aud?: string;
+            sub?: string;
+        };
+    };
     token_request_method?: 'GET';
     token_headers?: Record<string, string>;
     token_response: {

package/dist/runner/sdk.d.ts

@@ -49,4 +49,6 @@ export interface UserLogParameters {
 export interface TelemetryBag extends Record<string, number> {
     customLogs: number;
     proxyCalls: number;
+    durationMs: number;
+    memoryGb: number;
 }

package/dist/web/env.d.ts

@@ -1,5 +1,6 @@
 export interface WindowEnv {
     apiUrl: string;
+    apiDownWatchPublicKey: string;
     publicUrl: string;
     connectUrl: string;
     gitHash: string | undefined;

package/dist/webhooks/api.d.ts

@@ -47,6 +47,7 @@ export interface NangoAuthWebhookBodyBase extends NangoWebhookBase {
     endUser?: {
         endUserId: string;
         organizationId?: string | undefined;
+        tags: Record<string, string>;
     } | undefined;
 }
 export interface NangoAuthWebhookBodySuccess extends NangoAuthWebhookBodyBase {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nangohq/types",
-    "version": "0.68.0",
+    "version": "0.69.0",
     "description": "Types used in Nango applications",
     "type": "module",
     "typings": "dist/index.d.ts",

package/dist/auth/db.d.ts

@@ -1,15 +0,0 @@
-import type { AuthModes } from './api.js';
-export interface OAuthSession {
-    providerConfigKey: string;
-    provider: string;
-    connectionId: string;
-    callbackUrl: string;
-    authMode: AuthModes;
-    id: string;
-    connectionConfig: Record<string, string>;
-    environmentId: number;
-    webSocketClientId: string | undefined;
-    codeVerifier: string;
-    requestTokenSecret?: string;
-    activityLogId: string;
-}