@nangohq/types 0.71.1 → 0.71.2

package/dist/auth/api.d.ts

@@ -1,4 +1,5 @@
 import type { DBConnection } from '../connection/db.js';
+import type { ReplaceInObjectDeep } from '../utils.js';
 export interface AuthModes {
     OAuth1: 'OAUTH1';
     OAuth2: 'OAUTH2';
@@ -171,3 +172,4 @@ export interface AuthorizationTokenResponse extends Omit<OAuth2Credentials, 'typ
 export type TestableCredentials = ApiKeyCredentials | BasicApiCredentials | TbaCredentials | JwtCredentials | SignatureCredentials;
 export type RefreshableCredentials = OAuth2Credentials | AppCredentials | AppStoreCredentials | OAuth2ClientCredentials | JwtCredentials | TwoStepCredentials | BillCredentials | SignatureCredentials | AwsSigV4Credentials;
 export type AllAuthCredentials = OAuth1Credentials | OAuth2Credentials | OAuth2ClientCredentials | BasicApiCredentials | ApiKeyCredentials | AppCredentials | AppStoreCredentials | UnauthCredentials | CustomCredentials | TbaCredentials | JwtCredentials | BillCredentials | TwoStepCredentials | CombinedOauth2AppCredentials | SignatureCredentials | InstallPluginCredentials | AwsSigV4Credentials;
+export type ApiPublicAllAuthCredentials = ReplaceInObjectDeep<AllAuthCredentials, Date, string>;

package/dist/billing/types.d.ts

@@ -94,19 +94,12 @@ export interface GetBillingUsageOpts {
         group_by?: 'environmentId' | 'environmentName' | 'integrationId' | 'type' | 'functionName' | 'model';
     };
     /**
-     * Dev-only escape hatch: pins the request to Orb for parity checks.
-     * Honoured only when `FLAG_ALLOW_OVERRIDE_GETUSAGE_SERVICE` is enabled;
-     * ignored everywhere else. Default is ClickHouse.
-     */
-    source?: 'clickhouse' | 'orb';
-    /**
-     * Per-metric dimension breakdown spec. Honoured only on the CH path
+     * Per-metric dimension breakdown spec, applied to CH-backed metrics
      * (records / connections via `getDailySumAndBatches`, counters via
-     * `getDailyCounter`); the Orb client ignores it. Each metric's
-     * `BillingUsageMetric` gains a `breakdown` array of up to `top + 1`
-     * series (top-N dimension values + a single 'rest' aggregating the
-     * long tail). Top defaults to 10 and is clamped server-side to
-     * the CH cap.
+     * `getDailyCounter`). Each metric's `BillingUsageMetric` gains a
+     * `breakdown` array of up to `top + 1` series (top-N dimension
+     * values + a single 'rest' aggregating the long tail). Top defaults
+     * to 10 and is clamped server-side to the CH cap.
      */
     breakdown?: {
         [M in UsageMetric]?: BreakdownDimensions[M] | undefined;
@@ -114,8 +107,7 @@ export interface GetBillingUsageOpts {
     top?: number;
     /**
      * Subset of metrics to populate in the response. When set, only those
-     * metrics are fanned out (CH path) and returned. Omitted → all 7.
-     * Ignored on the Orb path.
+     * metrics are fanned out and returned. Omitted → all 7.
      */
     metrics?: UsageMetric[];
     /**
@@ -123,8 +115,7 @@ export interface GetBillingUsageOpts {
      * where the given dimension equals the given value. Composes with
      * `breakdown[<metric>]` on the same metric when the dimensions differ
      * (drill-in: filter to one value, re-break-down by another); controllers
-     * reject only the same-dimension pairing. CH path only; the Orb client
-     * ignores it.
+     * reject only the same-dimension pairing.
      */
     filter?: {
         [M in UsageMetric]?: {

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

@@ -1,5 +1,5 @@
 import type { ApiError, ApiTimestamps, Endpoint } from '../../api.js';
-import type { AllAuthCredentials, ApiKeyCredentials, BasicApiCredentials, OAuth1Credentials, OAuth2ClientCredentials, OAuth2Credentials, TbaCredentials } from '../../auth/api.js';
+import type { ApiKeyCredentials, ApiPublicAllAuthCredentials, BasicApiCredentials, OAuth1Credentials, OAuth2ClientCredentials, OAuth2Credentials, TbaCredentials } from '../../auth/api.js';
 import type { EndUserInput } from '../../connect/api.js';
 import type { Tags } from '../../db.js';
 import type { ApiEndUser } from '../../endUser/index.js';
@@ -135,7 +135,7 @@ export type ApiPublicConnectionFull = Pick<DBConnection, 'id' | 'connection_id'
     }[];
     end_user: ApiEndUser | null;
     tags: Tags;
-    credentials: AllAuthCredentials;
+    credentials: ApiPublicAllAuthCredentials;
 };
 export type GetPublicConnection = Endpoint<{
     Method: 'GET';
@@ -164,7 +164,7 @@ export type PatchPublicConnection = Endpoint<{
     Body: {
         end_user?: EndUserInput | undefined;
         tags?: Tags | undefined;
-        webhook_url?: string | undefined;
+        webhook_url_override?: string | undefined;
     };
     Success: {
         success: boolean;
@@ -184,7 +184,7 @@ export type PatchConnection = Endpoint<{
     Body: {
         end_user?: EndUserInput | undefined;
         tags?: Tags | undefined;
-        webhook_url?: string | undefined;
+        webhook_url_override?: string | undefined;
     };
     Success: {
         success: boolean;

package/dist/meta/api.d.ts

@@ -14,7 +14,6 @@ export type GetMeta = Endpoint<{
             baseUrl: string;
             debugMode: boolean;
             gettingStartedClosed: boolean;
-            billingUsageSource: 'clickhouse' | 'orb';
         };
     };
 }>;

package/dist/providers/provider.d.ts

@@ -84,6 +84,7 @@ export interface BaseProvider {
     authorization_code_param_in_webhook?: string;
     docs: string;
     docs_connect?: string;
+    setup_guide_url?: string;
     token_expiration_buffer?: number;
     webhook_routing_script?: string;
     webhook_user_defined_secret?: boolean;

package/dist/proxy/api.d.ts

@@ -1,3 +1,4 @@
+import type { AllAuthCredentials } from '../auth/api.js';
 import type { DBConnectionDecrypted } from '../connection/db.js';
 import type { DBIntegrationDecrypted } from '../integration/db.js';
 import type { HTTP_METHOD } from '../nangoYaml/index.js';
@@ -48,7 +49,9 @@ export interface UserProvidedProxyConfiguration extends BaseProxyConfiguration {
     method?: 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE' | 'get' | 'post' | 'patch' | 'put' | 'delete';
     paginate?: Partial<CursorPagination> | Partial<LinkPagination> | Partial<OffsetPagination>;
 }
-export type ConnectionForProxy = Pick<DBConnectionDecrypted, 'connection_id' | 'connection_config' | 'credentials' | 'metadata'>;
+export type ConnectionForProxy = Pick<DBConnectionDecrypted, 'connection_id' | 'connection_config' | 'metadata'> & {
+    credentials: AllAuthCredentials;
+};
 export type IntegrationConfigForProxy = Pick<DBIntegrationDecrypted, 'oauth_client_id' | 'oauth_client_secret' | 'custom'>;
 export interface ApplicationConstructedProxyConfiguration extends BaseProxyConfiguration {
     decompress: boolean;

package/dist/utils.d.ts

@@ -21,4 +21,7 @@ export type Jsonable = string | number | boolean | null | undefined | readonly J
 export type ReplaceInObject<T, From, To> = {
     [K in keyof T]: T[K] extends infer U ? (U extends From ? Exclude<U, From> | To : U) : never;
 };
+export type ReplaceInObjectDeep<T, From, To> = T extends From ? To : T extends object ? ReplaceInObject<{
+    [K in keyof T]: ReplaceInObjectDeep<T[K], From, To>;
+}, From, To> : T;
 export {};

package/package.json

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