@nangohq/types 0.69.46 → 0.69.47
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/api.endpoints.d.ts +2 -2
- package/dist/authz/types.d.ts +12 -0
- package/dist/flow/http.api.d.ts +12 -0
- package/dist/index.d.ts +1 -0
- package/dist/invitations/api.d.ts +2 -0
- package/dist/providers/provider.d.ts +1 -0
- package/dist/runner/index.d.ts +2 -0
- package/dist/sync/api.d.ts +3 -1
- package/dist/team/api.d.ts +20 -0
- package/dist/user/api.d.ts +1 -0
- package/dist/web/env.d.ts +1 -0
- package/dist/webhooks/api.d.ts +2 -0
- package/package.json +1 -1
package/dist/api.endpoints.d.ts
CHANGED
|
@@ -24,11 +24,11 @@ import type { GetPublicRecords, PatchPublicPruneRecords } from './record/api.js'
|
|
|
24
24
|
import type { GetPublicScriptsConfig } from './scripts/http.api.js';
|
|
25
25
|
import type { GetSharedCredentialsProvider, GetSharedCredentialsProviders, PatchSharedCredentialsProvider, PostSharedCredentialsProvider } from './sharedCredentials/api.js';
|
|
26
26
|
import type { GetPublicSyncStatus, PostPublicSyncPause, PostPublicSyncStart, PostPublicTrigger, PutPublicSyncConnectionFrequency } from './sync/api.js';
|
|
27
|
-
import type { DeleteTeamUser, GetTeam, PutTeam } from './team/api.js';
|
|
27
|
+
import type { DeleteTeamUser, GetTeam, PatchTeamUser, PutTeam } from './team/api.js';
|
|
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 | 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 | 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;
|
|
32
32
|
export type APIEndpoints = PrivateApiEndpoints | PublicApiEndpoints;
|
|
33
33
|
/**
|
|
34
34
|
* Automatically narrow endpoints type with Method + Path
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { Role } from '../user/db.js';
|
|
2
|
+
export type Action = 'create' | 'read' | 'update' | 'delete' | '*';
|
|
3
|
+
export type Resource = 'team' | 'team_member' | 'invite' | 'connect_ui_settings' | 'billing' | 'plan' | 'environment' | 'environment_production_flag' | 'environment_key' | 'environment_variable' | 'webhook' | 'integration' | 'connection' | 'flow' | 'sync_command' | 'secret_key' | 'connection_credential' | 'log' | '*';
|
|
4
|
+
export type Scope = 'production' | 'non-production' | 'global';
|
|
5
|
+
export interface Permission {
|
|
6
|
+
action: Action;
|
|
7
|
+
resource: Resource;
|
|
8
|
+
scope: Scope;
|
|
9
|
+
}
|
|
10
|
+
export interface PermissionEvaluator {
|
|
11
|
+
evaluate(role: Role, permission: Permission): Promise<boolean>;
|
|
12
|
+
}
|
package/dist/flow/http.api.d.ts
CHANGED
|
@@ -106,3 +106,15 @@ export type PatchFlowFrequency = Endpoint<{
|
|
|
106
106
|
};
|
|
107
107
|
};
|
|
108
108
|
}>;
|
|
109
|
+
export type GetFlowDownload = Endpoint<{
|
|
110
|
+
Method: 'GET';
|
|
111
|
+
Path: '/api/v1/flows/:id/download';
|
|
112
|
+
Querystring: {
|
|
113
|
+
env: string;
|
|
114
|
+
};
|
|
115
|
+
Params: {
|
|
116
|
+
id: number;
|
|
117
|
+
};
|
|
118
|
+
Success: never;
|
|
119
|
+
Error: ApiError<'failed_to_download_flow'>;
|
|
120
|
+
}>;
|
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import type { ApiError, Endpoint } from '../api.js';
|
|
2
2
|
import type { ApiInvitation, ApiTeam } from '../team/api.js';
|
|
3
3
|
import type { ApiUser } from '../user/api.js';
|
|
4
|
+
import type { Role } from '../user/db.js';
|
|
4
5
|
export type PostInvite = Endpoint<{
|
|
5
6
|
Method: 'POST';
|
|
6
7
|
Path: '/api/v1/invite';
|
|
@@ -9,6 +10,7 @@ export type PostInvite = Endpoint<{
|
|
|
9
10
|
};
|
|
10
11
|
Body: {
|
|
11
12
|
emails: string[];
|
|
13
|
+
role?: Role;
|
|
12
14
|
};
|
|
13
15
|
Success: {
|
|
14
16
|
data: {
|
package/dist/runner/index.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import type { TelemetryBag } from './sdk.js';
|
|
2
2
|
import type { CheckpointRange } from '../checkpoint/types.js';
|
|
3
3
|
import type { DBPlan } from '../plans/db.js';
|
|
4
|
+
import type { Feature } from '../syncConfigs/db.js';
|
|
4
5
|
export interface RunnerOutputError {
|
|
5
6
|
type: string;
|
|
6
7
|
payload: Record<string, unknown> | unknown[];
|
|
@@ -23,4 +24,5 @@ export interface RunnerFlags {
|
|
|
23
24
|
}
|
|
24
25
|
export interface RoutingContext {
|
|
25
26
|
plan: DBPlan | null;
|
|
27
|
+
features: Feature[];
|
|
26
28
|
}
|
package/dist/sync/api.d.ts
CHANGED
|
@@ -24,7 +24,7 @@ export type PostPublicTrigger = Endpoint<{
|
|
|
24
24
|
Success: {
|
|
25
25
|
success: boolean;
|
|
26
26
|
};
|
|
27
|
-
Error: ApiError<'missing_provider_config_key'>;
|
|
27
|
+
Error: ApiError<'missing_provider_config_key' | 'unknown_provider_config' | 'unknown_connection' | 'no_syncs_found'>;
|
|
28
28
|
}>;
|
|
29
29
|
export type PostSyncVariant = Endpoint<{
|
|
30
30
|
Method: 'POST';
|
|
@@ -89,6 +89,7 @@ export type PostPublicSyncPause = Endpoint<{
|
|
|
89
89
|
Success: {
|
|
90
90
|
success: boolean;
|
|
91
91
|
};
|
|
92
|
+
Error: ApiError<'no_syncs_found' | 'unknown_connection' | 'unknown_provider_config'>;
|
|
92
93
|
}>;
|
|
93
94
|
export type PostPublicSyncStart = Endpoint<{
|
|
94
95
|
Method: 'POST';
|
|
@@ -104,6 +105,7 @@ export type PostPublicSyncStart = Endpoint<{
|
|
|
104
105
|
Success: {
|
|
105
106
|
success: boolean;
|
|
106
107
|
};
|
|
108
|
+
Error: ApiError<'no_syncs_found' | 'unknown_connection' | 'unknown_provider_config'>;
|
|
107
109
|
}>;
|
|
108
110
|
export type GetPublicSyncStatus = Endpoint<{
|
|
109
111
|
Method: 'GET';
|
package/dist/team/api.d.ts
CHANGED
|
@@ -2,6 +2,7 @@ import type { ApiError, ApiTimestamps, Endpoint } from '../api.js';
|
|
|
2
2
|
import type { DBTeam } from './db.js';
|
|
3
3
|
import type { DBInvitation } from '../invitations/db.js';
|
|
4
4
|
import type { ApiUser } from '../user/api.js';
|
|
5
|
+
import type { Role } from '../user/db.js';
|
|
5
6
|
import type { Merge } from 'type-fest';
|
|
6
7
|
export type GetTeam = Endpoint<{
|
|
7
8
|
Method: 'GET';
|
|
@@ -49,3 +50,22 @@ export type DeleteTeamUser = Endpoint<{
|
|
|
49
50
|
};
|
|
50
51
|
};
|
|
51
52
|
}>;
|
|
53
|
+
export type PatchTeamUser = Endpoint<{
|
|
54
|
+
Method: 'PATCH';
|
|
55
|
+
Path: '/api/v1/team/users/:id';
|
|
56
|
+
Querystring: {
|
|
57
|
+
env: string;
|
|
58
|
+
};
|
|
59
|
+
Params: {
|
|
60
|
+
id: number;
|
|
61
|
+
};
|
|
62
|
+
Body: {
|
|
63
|
+
role: Role;
|
|
64
|
+
};
|
|
65
|
+
Error: ApiError<'user_not_found'> | ApiError<'forbidden_self_demotion'>;
|
|
66
|
+
Success: {
|
|
67
|
+
data: {
|
|
68
|
+
success: true;
|
|
69
|
+
};
|
|
70
|
+
};
|
|
71
|
+
}>;
|
package/dist/user/api.d.ts
CHANGED
|
@@ -34,6 +34,7 @@ export interface ApiUser {
|
|
|
34
34
|
email: string;
|
|
35
35
|
name: string;
|
|
36
36
|
uuid: string;
|
|
37
|
+
role: Role;
|
|
37
38
|
gettingStartedClosed: boolean;
|
|
38
39
|
}
|
|
39
40
|
export type AllowedPermissions = Partial<Record<string, Partial<Record<'production' | 'non-production' | 'global', ('create' | 'read' | 'update' | 'delete' | '*')[]>>>>;
|
package/dist/web/env.d.ts
CHANGED
package/dist/webhooks/api.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import type { AsyncActionResponse } from '../action/api.js';
|
|
2
2
|
import type { ErrorPayload, SyncErrorPayload } from '../api.js';
|
|
3
3
|
import type { AuthModeType, AuthOperationType } from '../auth/api.js';
|
|
4
|
+
import type { CheckpointRange } from '../checkpoint/types.js';
|
|
4
5
|
import type { SyncResult } from '../sync/index.js';
|
|
5
6
|
export type WebhookTypes = 'sync' | 'auth' | 'forward' | 'async_action';
|
|
6
7
|
export interface NangoWebhookBase {
|
|
@@ -15,6 +16,7 @@ export interface NangoSyncWebhookBodyBase extends NangoWebhookBase {
|
|
|
15
16
|
syncName: string;
|
|
16
17
|
syncVariant: string;
|
|
17
18
|
model: string;
|
|
19
|
+
checkpoints?: CheckpointRange | undefined;
|
|
18
20
|
/** @deprecated **/
|
|
19
21
|
syncType: 'INCREMENTAL' | 'INITIAL' | 'WEBHOOK';
|
|
20
22
|
}
|