@nangohq/types 0.69.48 → 0.69.49
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/account/api.d.ts +23 -0
- package/dist/api.endpoints.d.ts +2 -2
- package/dist/index.d.ts +1 -0
- package/dist/proxy/api.d.ts +5 -0
- package/dist/pubsub/events.d.ts +91 -0
- package/package.json +2 -2
package/dist/account/api.d.ts
CHANGED
|
@@ -130,6 +130,29 @@ export type PostManagedSignup = Endpoint<{
|
|
|
130
130
|
};
|
|
131
131
|
};
|
|
132
132
|
}>;
|
|
133
|
+
export type GetManagedEmailVerification = Endpoint<{
|
|
134
|
+
Method: 'GET';
|
|
135
|
+
Path: '/api/v1/account/managed/verification';
|
|
136
|
+
Error: ApiError<'not_found'>;
|
|
137
|
+
Success: {
|
|
138
|
+
data: {
|
|
139
|
+
email: string;
|
|
140
|
+
};
|
|
141
|
+
};
|
|
142
|
+
}>;
|
|
143
|
+
export type PostManagedEmailVerification = Endpoint<{
|
|
144
|
+
Method: 'POST';
|
|
145
|
+
Path: '/api/v1/account/managed/verification';
|
|
146
|
+
Body: {
|
|
147
|
+
code: string;
|
|
148
|
+
};
|
|
149
|
+
Error: ApiError<'invalid_verification_code'> | ApiError<'not_found'>;
|
|
150
|
+
Success: {
|
|
151
|
+
data: {
|
|
152
|
+
url: string;
|
|
153
|
+
};
|
|
154
|
+
};
|
|
155
|
+
}>;
|
|
133
156
|
export type GetManagedCallback = Endpoint<{
|
|
134
157
|
Method: 'GET';
|
|
135
158
|
Path: '/api/v1/login/callback';
|
package/dist/api.endpoints.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { GetEmailByExpiredToken, GetEmailByUuid, GetManagedCallback, PostForgotPassword, PostLogout, PostManagedSignup, PostSignin, PostSignup, PutResetPassword } from './account/api.js';
|
|
1
|
+
import type { GetEmailByExpiredToken, GetEmailByUuid, GetManagedCallback, GetManagedEmailVerification, PostForgotPassword, PostLogout, PostManagedEmailVerification, PostManagedSignup, PostSignin, PostSignup, PutResetPassword } from './account/api.js';
|
|
2
2
|
import type { GetAsyncActionResult, GetPublicV1, PostPublicTriggerAction } from './action/api.js';
|
|
3
3
|
import type { PostImpersonate } from './admin/http.api.js';
|
|
4
4
|
import type { EndpointMethod } from './api.js';
|
|
@@ -28,7 +28,7 @@ import type { DeleteTeamUser, GetTeam, PatchTeamUser, PutTeam } from './team/api
|
|
|
28
28
|
import type { GetUser, PatchUser } from './user/api.js';
|
|
29
29
|
import type { PostPublicWebhook } from './webhooks/http.api.js';
|
|
30
30
|
export type PublicApiEndpoints = SetMetadata | UpdateMetadata | PostDeploy | PostDeployConfirmation | PostPublicTrigger | PostPublicTbaAuthorization | PostPublicJwtAuthorization | PostPublicUnauthenticatedAuthorization | PostPublicApiKeyAuthorization | PostPublicBasicAuthorization | PostPublicAppStoreAuthorization | GetPublicProviders | GetPublicProvider | GetPublicListIntegrations | GetPublicIntegration | DeletePublicIntegration | PostConnectSessions | PostPublicConnectSessionsReconnect | GetPublicConnections | GetPublicConnection | GetConnectSession | DeleteConnectSession | PostDeployInternal | PostPublicBillAuthorization | DeletePublicConnection | PostPublicSignatureAuthorization | PostPublicTwoStepAuthorization | PostPublicWebhook | GetPublicRecords | PatchPublicPruneRecords | GetPublicScriptsConfig | PostPublicConnectTelemetry | PutPublicSyncConnectionFrequency | PostPublicIntegration | PatchPublicIntegration | GetAsyncActionResult | PostPublicOauthOutboundAuthorization | PostPublicConnection | PatchPublicConnection | PostPublicSyncStart | PostPublicSyncPause | GetPublicSyncStatus | GetPublicV1 | PostPublicTriggerAction | AllPublicProxy;
|
|
31
|
-
export type PrivateApiEndpoints = PostSignup | PostSignin | PostLogout | GetTeam | PutTeam | PostPlanExtendTrial | PostPlanChange | GetUser | PatchUser | PostInvite | DeleteInvite | DeleteTeamUser | PatchTeamUser | PostInsights | PostForgotPassword | PutResetPassword | SearchOperations | GetOperation | SearchMessages | SearchFilters | PostInternalConnectSessions | GetIntegrationFlows | DeleteIntegration | PatchIntegration | GetIntegration | PostIntegration | GetConnections | GetConnectionsCount | GetConnection | GetInvite | GetMeta | GetEmailByExpiredToken | GetEmailByUuid | GetManagedCallback | PatchFlowDisable | PatchFlowEnable | PatchFlowFrequency | PutUpgradePreBuiltFlow | PostConnectionRefresh | PostManagedSignup | PostPreBuiltDeploy | PostEnvironment | PatchEnvironment | DeleteEnvironment | GetEnvironments | GetEnvironment | PatchWebhook | PostEnvironmentVariables | PostImpersonate | GetSharedCredentialsProviders | GetSharedCredentialsProvider | PostSharedCredentialsProvider | PatchSharedCredentialsProvider | GetGettingStarted | PatchGettingStarted | GetConnectUISettings | PutConnectUISettings | GetProviders | GetProvider;
|
|
31
|
+
export type PrivateApiEndpoints = PostSignup | PostSignin | PostLogout | GetTeam | PutTeam | PostPlanExtendTrial | PostPlanChange | GetUser | PatchUser | PostInvite | DeleteInvite | DeleteTeamUser | PatchTeamUser | PostInsights | PostForgotPassword | PutResetPassword | SearchOperations | GetOperation | SearchMessages | SearchFilters | PostInternalConnectSessions | GetIntegrationFlows | DeleteIntegration | PatchIntegration | GetIntegration | PostIntegration | GetConnections | GetConnectionsCount | GetConnection | GetInvite | GetMeta | GetEmailByExpiredToken | GetEmailByUuid | GetManagedCallback | GetManagedEmailVerification | PatchFlowDisable | PatchFlowEnable | PatchFlowFrequency | PutUpgradePreBuiltFlow | PostConnectionRefresh | PostManagedEmailVerification | PostManagedSignup | PostPreBuiltDeploy | PostEnvironment | PatchEnvironment | DeleteEnvironment | GetEnvironments | GetEnvironment | PatchWebhook | PostEnvironmentVariables | PostImpersonate | GetSharedCredentialsProviders | GetSharedCredentialsProvider | PostSharedCredentialsProvider | PatchSharedCredentialsProvider | GetGettingStarted | PatchGettingStarted | GetConnectUISettings | PutConnectUISettings | GetProviders | GetProvider;
|
|
32
32
|
export type APIEndpoints = PrivateApiEndpoints | PublicApiEndpoints;
|
|
33
33
|
/**
|
|
34
34
|
* Automatically narrow endpoints type with Method + Path
|
package/dist/index.d.ts
CHANGED
package/dist/proxy/api.d.ts
CHANGED
|
@@ -27,6 +27,11 @@ export interface BaseProxyConfiguration {
|
|
|
27
27
|
retryHeader?: RetryHeaderConfig;
|
|
28
28
|
retryOn?: number[] | null;
|
|
29
29
|
forwardHeadersOnRedirect?: boolean;
|
|
30
|
+
/**
|
|
31
|
+
* If set, called with the absolute URL of each HTTP redirect before Axios follows it.
|
|
32
|
+
* Implementations may throw (e.g. shared `ProxyError`) to abort the redirect.
|
|
33
|
+
*/
|
|
34
|
+
validateProxyRedirectUrl?: (absoluteRedirectUrl: string) => void;
|
|
30
35
|
}
|
|
31
36
|
export interface UserProvidedProxyConfiguration extends BaseProxyConfiguration {
|
|
32
37
|
decompress?: boolean | string;
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
import type { FunctionRuntime } from '../runner/sdk.js';
|
|
2
|
+
import type { DBTeam } from '../team/db.js';
|
|
3
|
+
import type { DBUser } from '../user/db.js';
|
|
4
|
+
type Serializable = string | number | boolean | Date | null | undefined | Serializable[] | {
|
|
5
|
+
[key: string]: Serializable;
|
|
6
|
+
};
|
|
7
|
+
interface EventBase<TSubject extends string, TType extends string, TPayload extends Serializable> {
|
|
8
|
+
idempotencyKey: string;
|
|
9
|
+
subject: TSubject;
|
|
10
|
+
type: TType;
|
|
11
|
+
payload: TPayload;
|
|
12
|
+
source?: string | undefined;
|
|
13
|
+
createdAt: Date;
|
|
14
|
+
}
|
|
15
|
+
type EnforceEventBase<T extends EventBase<any, any, any>> = T;
|
|
16
|
+
export type Event = EnforceEventBase<UserCreatedEvent | UsageEvent | TeamUpdatedEvent>;
|
|
17
|
+
export type UserCreatedEvent = EventBase<'user', 'user.created', {
|
|
18
|
+
userId: DBUser['id'];
|
|
19
|
+
teamId: DBTeam['id'];
|
|
20
|
+
}>;
|
|
21
|
+
export type TeamUpdatedEvent = EventBase<'team', 'team.updated', {
|
|
22
|
+
id: DBTeam['id'];
|
|
23
|
+
}>;
|
|
24
|
+
interface UsageEventBase<TType extends string, TPayload extends Serializable> extends EventBase<'usage', TType, TPayload> {
|
|
25
|
+
subject: 'usage';
|
|
26
|
+
type: TType;
|
|
27
|
+
payload: TPayload & {
|
|
28
|
+
value: number;
|
|
29
|
+
properties: {
|
|
30
|
+
accountId: number;
|
|
31
|
+
environmentId: number;
|
|
32
|
+
environmentName: string;
|
|
33
|
+
integrationId: string;
|
|
34
|
+
connectionId: string;
|
|
35
|
+
};
|
|
36
|
+
};
|
|
37
|
+
}
|
|
38
|
+
export type UsageRecordsEvent = UsageEventBase<'usage.records', {
|
|
39
|
+
value: number;
|
|
40
|
+
properties: {
|
|
41
|
+
syncId: string;
|
|
42
|
+
model: string;
|
|
43
|
+
};
|
|
44
|
+
}>;
|
|
45
|
+
export type UsageMarEvent = UsageEventBase<'usage.monthly_active_records', {
|
|
46
|
+
value: number;
|
|
47
|
+
properties: {
|
|
48
|
+
syncId: string;
|
|
49
|
+
model: string;
|
|
50
|
+
};
|
|
51
|
+
}>;
|
|
52
|
+
export type UsageActionsEvent = UsageEventBase<'usage.actions', {
|
|
53
|
+
value: number;
|
|
54
|
+
properties: {
|
|
55
|
+
actionName: string;
|
|
56
|
+
};
|
|
57
|
+
}>;
|
|
58
|
+
export type UsageConnectionsEvent = UsageEventBase<'usage.connections', {
|
|
59
|
+
value: number;
|
|
60
|
+
}>;
|
|
61
|
+
export type UsageFunctionExecutionsEvent = UsageEventBase<'usage.function_executions', {
|
|
62
|
+
value: number;
|
|
63
|
+
properties: {
|
|
64
|
+
type: 'sync' | 'action' | 'webhook' | 'on-event';
|
|
65
|
+
success: boolean;
|
|
66
|
+
functionName: string;
|
|
67
|
+
runtime: FunctionRuntime | undefined;
|
|
68
|
+
telemetryBag: {
|
|
69
|
+
durationMs: number;
|
|
70
|
+
memoryGb: number;
|
|
71
|
+
customLogs: number;
|
|
72
|
+
proxyCalls: number;
|
|
73
|
+
} | undefined;
|
|
74
|
+
frequencyMs?: number | undefined;
|
|
75
|
+
};
|
|
76
|
+
}>;
|
|
77
|
+
export type UsageProxyEvent = UsageEventBase<'usage.proxy', {
|
|
78
|
+
value: number;
|
|
79
|
+
properties: {
|
|
80
|
+
success: boolean;
|
|
81
|
+
};
|
|
82
|
+
}>;
|
|
83
|
+
export type UsageWebhookForwardEvent = UsageEventBase<'usage.webhook_forward', {
|
|
84
|
+
value: number;
|
|
85
|
+
properties: {
|
|
86
|
+
success: boolean;
|
|
87
|
+
};
|
|
88
|
+
}>;
|
|
89
|
+
type EnforceUsageEventBase<T extends UsageEventBase<any, any>> = T;
|
|
90
|
+
export type UsageEvent = EnforceUsageEventBase<UsageMarEvent | UsageRecordsEvent | UsageActionsEvent | UsageConnectionsEvent | UsageFunctionExecutionsEvent | UsageProxyEvent | UsageWebhookForwardEvent>;
|
|
91
|
+
export {};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@nangohq/types",
|
|
3
|
-
"version": "0.69.
|
|
3
|
+
"version": "0.69.49",
|
|
4
4
|
"description": "Types used in Nango applications",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"typings": "dist/index.d.ts",
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
"directory": "packages/utils"
|
|
13
13
|
},
|
|
14
14
|
"dependencies": {
|
|
15
|
-
"axios": "1.
|
|
15
|
+
"axios": "1.15.0",
|
|
16
16
|
"json-schema": "0.4.0",
|
|
17
17
|
"type-fest": "4.41.0"
|
|
18
18
|
},
|