@nangohq/types 0.40.1 → 0.40.3

package/dist/index.d.ts

@@ -11,6 +11,7 @@ export type * from './account/db.js';
 export type * from './user/api.js';
 export type * from './connection/api/metadata.js';
 export type * from './connection/db.js';
+export type * from './proxy/api.js';
 export type * from './environment/db.js';
 export type * from './scripts/post-connection/api.js';
 export type * from './scripts/post-connection/db.js';
@@ -21,6 +22,8 @@ export type * from './integration/db.js';
 export type * from './integration/template.js';
 export type * from './auth/api.js';
 export type * from './auth/db.js';
+export type * from './nangoYaml/index.js';
+export type * from './utils.js';
 export type * from './environment/db.js';
 export type * from './environment/api/webhook.js';
 export type * from './webhooks/api.js';

package/dist/logs/api.d.ts

@@ -1,6 +1,6 @@
 import type { Endpoint } from '../api';
-import type { MessageOperation, MessageRow, MessageState, OperationRow } from './messages';
-type Concat<T extends MessageOperation> = T[keyof T] | (T extends {
+import type { MessageRow, MessageState, OperationList, OperationRow } from './messages';
+type Concat<T extends OperationList> = T[keyof T] | (T extends {
     action: string;
 } ? `${T['type']}:${T['action']}` : never);
 export type SearchOperations = Endpoint<{
@@ -28,7 +28,7 @@ export type SearchOperations = Endpoint<{
     };
 }>;
 export type SearchOperationsState = 'all' | MessageState;
-export type SearchOperationsType = 'all' | Concat<MessageOperation>;
+export type SearchOperationsType = 'all' | Concat<OperationList>;
 export type SearchOperationsIntegration = 'all' | string;
 export type SearchOperationsConnection = 'all' | string;
 export type SearchOperationsSync = 'all' | string;

package/dist/logs/messages.d.ts

@@ -1,3 +1,4 @@
+import type { Merge } from 'type-fest';
 /**
  * Level of the log and operation
  */
@@ -24,37 +25,37 @@ export type MessageState = 'waiting' | 'running' | 'success' | 'failed' | 'timeo
 /**
  * Operations
  */
-export interface MessageOpSync {
+export interface OperationSync {
     type: 'sync';
     action: 'pause' | 'unpause' | 'run' | 'request_run' | 'request_run_full' | 'cancel' | 'init';
 }
-export interface MessageOpProxy {
+export interface OperationProxy {
     type: 'proxy';
 }
-export interface MessageOpAction {
+export interface OperationAction {
     type: 'action';
 }
-export interface MessageOpAuth {
+export interface OperationAuth {
     type: 'auth';
     action: 'create_connection' | 'refresh_token' | 'post_connection';
 }
-export interface MessageOpAdmin {
+export interface OperationAdmin {
     type: 'admin';
     action: 'impersonation';
 }
-export interface MessageOpWebhook {
+export interface OperationWebhook {
     type: 'webhook';
     action: 'incoming' | 'outgoing';
 }
-export interface MessageOpDeploy {
+export interface OperationDeploy {
     type: 'deploy';
     action: 'prebuilt' | 'custom';
 }
-export type MessageOperation = MessageOpSync | MessageOpProxy | MessageOpAction | MessageOpWebhook | MessageOpDeploy | MessageOpAuth | MessageOpAdmin;
+export type OperationList = OperationSync | OperationProxy | OperationAction | OperationWebhook | OperationDeploy | OperationAuth | OperationAdmin;
 /**
  * Full schema
  */
-export type MessageRow = {
+export interface MessageRow {
     id: string;
     source: 'internal' | 'user';
     level: LogLevel;
@@ -63,6 +64,7 @@ export type MessageRow = {
     title: string | null;
     state: MessageState;
     code: MessageCode | null;
+    operation: null;
     accountId: number | null;
     accountName: string | null;
     environmentId: number | null;
@@ -105,18 +107,23 @@ export type MessageRow = {
     startedAt: string | null;
     endedAt: string | null;
     expiresAt: string | null;
-} & {
-    operation: MessageOperation | null;
-};
+}
 /**
  * What is required to insert a Message
  */
-export type OperationRequired = 'operation' | 'message';
-export type OperationRowInsert = Pick<MessageRow, OperationRequired> & Partial<Omit<MessageRow, OperationRequired>>;
-export type OperationRow = Pick<MessageRow, OperationRequired> & Omit<MessageRow, OperationRequired>;
+export type OperationRowInsert = Merge<Partial<MessageRow>, {
+    message: string;
+    operation: OperationList;
+}>;
+export type OperationRow = Merge<Required<OperationRowInsert>, {
+    accountId: number;
+    accountName: string;
+}>;
 /**
  * What is required to insert a Message
  */
 export type MessageRowInsert = Pick<MessageRow, 'type' | 'message'> & Partial<Omit<MessageRow, 'type' | 'message'>> & {
-    id?: string | undefined;
+    id?: never;
 };
+export type LogsBuffer = Pick<MessageRow, 'level' | 'message' | 'createdAt'> & Partial<Pick<MessageRow, 'error' | 'meta'>>;
+export type MessageOrOperationRow = MessageRow | OperationRow;

package/dist/nangoYaml/index.d.ts

@@ -0,0 +1,106 @@
+export type HTTP_VERB = 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
+export type SyncTypeLiteral = 'incremental' | 'full';
+export interface NangoYamlV1 {
+    integrations: Record<string, Record<string, NangoYamlV1Integration>>;
+    models: NangoYamlModel;
+}
+export interface NangoYamlV1Integration {
+    type?: 'action' | 'sync';
+    returns?: string | string[];
+    description?: string;
+    runs?: string;
+    track_deletes?: boolean;
+    auto_start?: boolean;
+}
+export interface NangoYamlV2 {
+    integrations: Record<string, NangoYamlV2Integration>;
+    models: NangoYamlModel;
+}
+export interface NangoYamlV2Integration {
+    provider?: string;
+    syncs?: Record<string, NangoYamlV2IntegrationSync>;
+    actions?: Record<string, NangoYamlV2IntegrationAction>;
+    'post-connection-scripts'?: string[];
+}
+export interface NangoYamlV2IntegrationSync {
+    endpoint: string | string[];
+    output: string | string[];
+    description?: string;
+    sync_type?: SyncTypeLiteral;
+    track_deletes?: boolean;
+    auto_start?: boolean;
+    runs: string;
+    scopes?: string | string[];
+    input?: string;
+    'webhook-subscriptions'?: string | string[];
+}
+export interface NangoYamlV2IntegrationAction {
+    endpoint: string;
+    output?: string | string[];
+    description?: string;
+    scopes?: string | string[];
+    input?: string;
+}
+export interface NangoYamlModel {
+    [key: string]: NangoYamlModelFields;
+}
+export interface NangoYamlModelFields {
+    [key: string]: NangoYamlModelField;
+}
+export type NangoYamlModelField = boolean | number | string | null | string[] | NangoYamlModelFields;
+export type NangoYaml = NangoYamlV1 | NangoYamlV2;
+export interface NangoYamlParsed {
+    yamlVersion: 'v1' | 'v2';
+    integrations: NangoYamlParsedIntegration[];
+    models: Map<string, NangoModel>;
+}
+export interface NangoYamlParsedIntegration {
+    providerConfigKey: string;
+    syncs: ParsedNangoSync[];
+    actions: ParsedNangoAction[];
+    postConnectionScripts: string[];
+}
+export interface ParsedNangoSync {
+    name: string;
+    type: 'sync';
+    endpoints: NangoSyncEndpoint[];
+    description: string;
+    sync_type: SyncTypeLiteral;
+    track_deletes: boolean;
+    auto_start: boolean;
+    runs: string;
+    scopes: string[];
+    input: string | null;
+    output: string[] | null;
+    usedModels: string[];
+    webhookSubscriptions: string[];
+}
+export interface ParsedNangoAction {
+    name: string;
+    type: 'action';
+    description: string;
+    input: string | null;
+    output: string[] | null;
+    endpoint: NangoSyncEndpoint | null;
+    scopes: string[];
+    usedModels: string[];
+}
+export type LayoutMode = 'root' | 'nested';
+export interface NangoModel {
+    name: string;
+    fields: NangoModelField[];
+    isAnon?: boolean;
+}
+export interface NangoModelField {
+    name: string;
+    value: string | number | boolean | null | undefined | NangoModelField[];
+    dynamic?: boolean;
+    tsType?: boolean;
+    model?: boolean;
+    array?: boolean;
+    union?: boolean;
+    optional?: boolean;
+}
+export type NangoSyncEndpoint = {
+    [key in HTTP_VERB]?: string;
+};

package/dist/utils.d.ts

@@ -0,0 +1,9 @@
+export type MaybePromise<T> = Promise<T> | T;
+export type LogMethod = (...args: any[]) => any;
+export interface Logger {
+    error: LogMethod;
+    warn: LogMethod;
+    info: LogMethod;
+    debug: LogMethod;
+    child: (...message: any[]) => Logger;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nangohq/types",
-    "version": "0.40.1",
+    "version": "0.40.3",
     "description": "Types used in Nango applications",
     "type": "module",
     "typings": "dist/index.d.ts",
@@ -12,7 +12,8 @@
         "directory": "packages/utils"
     },
     "devDependencies": {
-        "axios": "^1.3.4"
+        "axios": "^1.3.4",
+        "type-fest": "4.14.0"
     },
     "license": "SEE LICENSE IN LICENSE FILE IN GIT REPOSITORY",
     "files": [