@nangohq/types 0.63.0 → 0.64.0

package/dist/billing/types.d.ts

@@ -12,7 +12,23 @@ export interface BillingClient {
     upgrade: (opts: {
         subscriptionId: string;
         planExternalId: string;
-        immediate: boolean;
+    }) => Promise<Result<{
+        pendingChangeId: string;
+        amountInCents: number | null;
+    }>>;
+    downgrade: (opts: {
+        subscriptionId: string;
+        planExternalId: string;
+    }) => Promise<Result<void>>;
+    applyPendingChanges: (opts: {
+        pendingChangeId: string;
+        /**
+         * format: dollar.cent = 0.00
+         */
+        amount: string;
+    }) => Promise<Result<void>>;
+    cancelPendingChanges: (opts: {
+        pendingChangeId: string;
     }) => Promise<Result<void>>;
     verifyWebhookSignature(body: string, headers: Record<string, unknown>, secret: string): Result<true>;
     getPlanById(planId: string): Promise<Result<BillingPlan>>;
@@ -23,6 +39,8 @@ export interface BillingCustomer {
 }
 export interface BillingSubscription {
     id: string;
+    pendingChangeId?: string | undefined;
+    planExternalId: string;
 }
 export interface BillingUsageMetric {
     id: string;

package/dist/connection/api/get.d.ts

@@ -42,7 +42,8 @@ export type GetConnectionsCount = Endpoint<{
         };
     };
 }>;
-export type ApiPublicConnection = Pick<DBConnection, 'id' | 'connection_id' | 'provider_config_key'> & {
+export type ApiPublicConnection = Pick<DBConnection, 'id' | 'connection_id'> & {
+    provider_config_key: string;
     created: string;
     metadata: Record<string, unknown> | null;
     provider: string;
@@ -86,7 +87,8 @@ export type GetConnection = Endpoint<{
         };
     };
 }>;
-export type ApiPublicConnectionFull = Pick<DBConnection, 'id' | 'connection_id' | 'provider_config_key' | 'connection_config'> & {
+export type ApiPublicConnectionFull = Pick<DBConnection, 'id' | 'connection_id' | 'connection_config'> & {
+    provider_config_key: string;
     created_at: string;
     updated_at: string;
     last_fetched_at: string | null;

package/dist/deploy/incomingFlow.d.ts

@@ -1,4 +1,4 @@
-import type { NangoModel, NangoSyncEndpointOld, NangoSyncEndpointV2, ScriptTypeLiteral, SyncTypeLiteral } from '../nangoYaml/index.js';
+import type { NangoSyncEndpointOld, NangoSyncEndpointV2, ScriptTypeLiteral, SyncTypeLiteral } from '../nangoYaml/index.js';
 import type { OnEventType } from '../scripts/on-events/api.js';
 import type { Merge } from 'type-fest';
 export interface IncomingScriptFiles {
@@ -30,7 +30,6 @@ export interface PreBuiltAction {
     models: string[];
     attributes?: object | undefined;
     metadata?: NangoConfigMetadata | undefined;
-    model_schema: string | NangoModel[];
     providerConfigKey: string;
     provider: string;
     is_public: boolean;
@@ -40,7 +39,7 @@ export interface PreBuiltAction {
     nango_config_id?: number;
     fileBody?: IncomingScriptFiles;
     endpoints: NangoSyncEndpointV2[];
-    input?: NangoModel | LegacySyncModelSchema | undefined;
+    input?: string | undefined;
     version?: string | null;
 }
 export interface PreBuiltSync {
@@ -50,7 +49,6 @@ export interface PreBuiltSync {
     auto_start?: boolean | undefined;
     attributes?: object | undefined;
     metadata?: NangoConfigMetadata | undefined;
-    model_schema: string | NangoModel[];
     track_deletes: boolean;
     providerConfigKey: string;
     provider: string;
@@ -61,7 +59,7 @@ export interface PreBuiltSync {
     nango_config_id?: number;
     fileBody?: IncomingScriptFiles;
     endpoints: NangoSyncEndpointV2[];
-    input?: NangoModel | LegacySyncModelSchema | undefined;
+    input?: string | undefined;
     version?: string | null;
 }
 export type PreBuiltFlowConfig = PreBuiltAction | PreBuiltSync;
@@ -72,7 +70,6 @@ export interface CLIDeployFlowConfig {
     auto_start?: boolean;
     attributes?: object | undefined;
     metadata?: NangoConfigMetadata | undefined;
-    model_schema: string | NangoModel[];
     endpoints?: (NangoSyncEndpointV2 | NangoSyncEndpointOld)[] | undefined;
     track_deletes: boolean;
     providerConfigKey: string;

package/dist/deploy/index.d.ts

@@ -1,4 +1,3 @@
-import type { LegacySyncModelSchema } from './incomingFlow.js';
 import type { ScriptTypeLiteral } from '../nangoYaml/index.js';
 export interface SyncDeploymentResult {
     name: string;
@@ -6,7 +5,7 @@ export interface SyncDeploymentResult {
     providerConfigKey: string;
     type: ScriptTypeLiteral;
     last_deployed?: Date;
-    input?: string | LegacySyncModelSchema | undefined | null;
+    input?: string | undefined | null;
     models: string | string[];
     id?: number | undefined;
     runs?: string | null;

package/dist/flow/index.d.ts

@@ -1,5 +1,5 @@
-import type { LegacySyncModelSchema, NangoConfigMetadata } from '../deploy/incomingFlow.js';
-import type { NangoModel, NangoSyncEndpointV2, ScriptTypeLiteral, SyncTypeLiteral } from '../nangoYaml/index.js';
+import type { NangoConfigMetadata } from '../deploy/incomingFlow.js';
+import type { NangoSyncEndpointV2, ScriptTypeLiteral, SyncTypeLiteral } from '../nangoYaml/index.js';
 import type { JSONSchema7 } from 'json-schema';
 export interface NangoSyncConfig {
     name: string;
@@ -12,14 +12,13 @@ export interface NangoSyncConfig {
     metadata?: NangoConfigMetadata;
     track_deletes?: boolean;
     returns: string[];
-    models: NangoModel[] | LegacySyncModelSchema[];
     endpoints: NangoSyncEndpointV2[];
     is_public?: boolean | null;
     pre_built?: boolean | null;
     version?: string | null;
     last_deployed?: string | null;
     id?: number;
-    input?: NangoModel | LegacySyncModelSchema | undefined;
+    input?: string | undefined;
     sync_type?: SyncTypeLiteral;
     webhookSubscriptions?: string[];
     enabled?: boolean;

package/dist/plans/db.d.ts

@@ -2,7 +2,7 @@ import type { Timestamps } from '../db.js';
 export interface DBPlan extends Timestamps {
     id: number;
     account_id: number;
-    name: string;
+    name: 'free' | 'starter' | 'starter-legacy' | 'growth' | 'scale-legacy' | 'growth-legacy' | 'enterprise';
     stripe_customer_id: string | null;
     stripe_payment_id: string | null;
     orb_customer_id: string | null;
@@ -14,12 +14,6 @@ export interface DBPlan extends Timestamps {
     trial_extension_count: number;
     trial_end_notified_at: Date | null;
     trial_expired: boolean | null;
-    /**
-     * Limit the number of connections with active scripts
-     * Set to null to remove limit
-     * @default 3
-     */
-    connection_with_scripts_max: number | null;
     /**
      * Limit the number of total non-deleted connections
      * Set to null to remove limit
@@ -31,6 +25,16 @@ export interface DBPlan extends Timestamps {
      * @default 2
      */
     environments_max: number;
+    /**
+     * Limit the number of actions that can be triggered in a month
+     * @default 1000
+     */
+    monthly_actions_max: number | null;
+    /**
+     * Limit the amount of monthly active records (Records created or updated in a month)
+     * @default 5000
+     */
+    monthly_active_records_max: number | null;
     /**
      * Limit the minimum frequency of a sync
      * Not used yet

package/dist/plans/http.api.d.ts

@@ -16,11 +16,13 @@ export type PostPlanExtendTrial = Endpoint<{
     };
 }>;
 export interface PlanDefinition {
-    code: string;
+    code: DBPlan['name'];
     title: string;
     description: string;
-    canUpgrade: boolean;
-    canDowngrade: false;
+    canChange: boolean;
+    nextPlan: string[] | null;
+    prevPlan: string[] | null;
+    basePrice?: number;
     /**
      * OrbId is the custom external_plan_id that we can setup
      * It's handy because you can set the same id in staging and prod
@@ -29,6 +31,14 @@ export interface PlanDefinition {
     cta?: string;
     hidden?: boolean;
     flags: Omit<Partial<DBPlan>, 'id' | 'account_id'>;
+    display?: {
+        featuresHeading?: string;
+        features: {
+            title: string;
+            sub?: string;
+        }[];
+        sub?: string;
+    };
 }
 export type GetPlans = Endpoint<{
     Method: 'GET';
@@ -40,6 +50,16 @@ export type GetPlans = Endpoint<{
         data: PlanDefinition[];
     };
 }>;
+export type GetPlan = Endpoint<{
+    Method: 'GET';
+    Path: '/api/v1/plans/current';
+    Querystring: {
+        env: string;
+    };
+    Success: {
+        data: ApiPlan;
+    };
+}>;
 export type GetUsage = Endpoint<{
     Method: 'GET';
     Path: '/api/v1/plans/usage';
@@ -54,3 +74,20 @@ export type GetUsage = Endpoint<{
         };
     };
 }>;
+export type PostPlanChange = Endpoint<{
+    Method: 'POST';
+    Path: '/api/v1/plans/change';
+    Querystring: {
+        env: string;
+    };
+    Body: {
+        orbId: string;
+    };
+    Success: {
+        data: {
+            success: true;
+        } | {
+            paymentIntent: any;
+        };
+    };
+}>;

package/dist/proxy/api.d.ts

@@ -46,7 +46,7 @@ export interface RetryHeaderConfig {
     at?: string;
     after?: string;
     remaining?: string;
-    error_code?: number;
+    error_code?: string[];
     in_body?: {
         path: string;
         value?: string;

package/dist/runner/sdk.d.ts

@@ -33,6 +33,7 @@ export interface NangoProps {
         endUserId: string | null;
         orgId: string | null;
     } | null;
+    heartbeatTimeoutSecs?: number | undefined;
     axios?: {
         request?: AxiosInterceptorManager<AxiosRequestConfig>;
         response?: {

package/dist/syncConfigs/db.d.ts

@@ -11,7 +11,7 @@ export interface DBSyncConfig extends TimestampsAndDeleted {
     models: string[];
     active: boolean;
     runs: string | null;
-    model_schema: LegacySyncModelSchema[] | NangoModel[] | null;
+    model_schema?: LegacySyncModelSchema[] | NangoModel[] | null | undefined;
     environment_id: number;
     track_deletes: boolean;
     type: ScriptTypeLiteral;

package/dist/web/env.d.ts

@@ -9,6 +9,7 @@ export interface WindowEnv {
     publicLogoDevKey: string;
     publicKoalaApiUrl: string;
     publicKoalaCdnUrl: string;
+    publicStripeKey: string;
     isCloud: boolean;
     features: {
         logs: boolean;

package/package.json

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