@nangohq/types 0.56.1 → 0.56.2

package/dist/api.d.ts

@@ -11,7 +11,7 @@ export interface ValidationError {
     message: string;
     path: (string | number)[];
 }
-export type ResDefaultErrors = ApiError<'invalid_content_type'> | ApiError<'not_found'> | ApiError<'conflict'> | ApiError<'forbidden'> | ApiError<'invalid_query_params', ValidationError[]> | ApiError<'invalid_headers', ValidationError[]> | ApiError<'invalid_body', ValidationError[]> | ApiError<'invalid_uri_params', ValidationError[]> | ApiError<'feature_disabled'> | ApiError<'generic_error_support', undefined, string> | ApiError<'server_error'> | ApiError<'resource_capped'> | ApiError<'missing_auth_header'> | ApiError<'malformed_auth_header'> | ApiError<'unknown_account'> | ApiError<'unknown_connect_session_token'> | ApiError<'invalid_cli_version'> | ApiError<'invalid_permissions'> | ApiError<'invalid_connect_session_token_format'>;
+export type ResDefaultErrors = ApiError<'invalid_content_type'> | ApiError<'not_found'> | ApiError<'conflict'> | ApiError<'forbidden'> | ApiError<'invalid_query_params', ValidationError[]> | ApiError<'invalid_headers', ValidationError[]> | ApiError<'invalid_body', ValidationError[]> | ApiError<'invalid_uri_params', ValidationError[]> | ApiError<'feature_disabled'> | ApiError<'generic_error_support', undefined, string> | ApiError<'server_error'> | ApiError<'resource_capped'> | ApiError<'missing_auth_header'> | ApiError<'malformed_auth_header'> | ApiError<'unknown_account'> | ApiError<'unknown_connect_session_token'> | ApiError<'invalid_cli_version'> | ApiError<'invalid_permissions'> | ApiError<'invalid_connect_session_token_format'> | ApiError<'request_too_large'>;
 export type EndpointMethod = 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
 /**
  * API Request/Response type

package/dist/index.d.ts

@@ -60,3 +60,4 @@ export type * from './web/env.js';
 export type * from './fleet/api.js';
 export type * from './fleet/index.js';
 export type * from './persist/api.js';
+export type * from './jobs/api.js';

package/dist/jobs/api.d.ts

@@ -0,0 +1,53 @@
+import type { JsonValue } from 'type-fest';
+import type { ApiError, Endpoint } from '../api';
+import type { RunnerOutputError } from '../runner';
+import type { NangoProps } from '../runner/sdk';
+export type PostHeartbeat = Endpoint<{
+    Method: 'POST';
+    Path: '/tasks/:taskId/heartbeat';
+    Params: {
+        taskId: string;
+    };
+    Body: never;
+    Error: ApiError<'heartbeat_failed'>;
+    Success: never;
+}>;
+export type PutTask = Endpoint<{
+    Method: 'PUT';
+    Path: '/tasks/:taskId';
+    Params: {
+        taskId: string;
+    };
+    Body: {
+        nangoProps?: NangoProps | undefined;
+        error?: RunnerOutputError | undefined;
+        output?: JsonValue | undefined;
+    };
+    Error: ApiError<'put_task_failed'>;
+    Success: never;
+}>;
+export type PostRegister = Endpoint<{
+    Method: 'POST';
+    Path: '/runners/:nodeId/register';
+    Params: {
+        nodeId: number;
+    };
+    Body: {
+        url: string;
+    };
+    Error: ApiError<'register_failed'>;
+    Success: {
+        status: 'ok';
+    };
+}>;
+export type PostIdle = Endpoint<{
+    Method: 'POST';
+    Path: '/runners/:nodeId/idle';
+    Params: {
+        nodeId: number;
+    };
+    Error: ApiError<'idle_failed'>;
+    Success: {
+        status: 'ok';
+    };
+}>;

package/dist/logs/api.d.ts

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

package/dist/logs/messages.d.ts

@@ -1,4 +1,4 @@
-import type { Merge, SetNonNullable } from 'type-fest';
+import type { Merge } from 'type-fest';
 /**
  * Level of the log and operation
  */
@@ -13,15 +13,10 @@ export type MessageMeta = Record<any, any>;
  * - http: an HTTP request with request/response added to the log
  */
 export type MessageType = 'log' | 'http';
-/**
- * Error code attached to the message
- * Not used yet
- */
-export type MessageCode = 'success';
 /**
  * State of the Operation
  */
-export type MessageState = 'waiting' | 'running' | 'success' | 'failed' | 'timeout' | 'cancelled';
+export type OperationState = 'waiting' | 'running' | 'success' | 'failed' | 'timeout' | 'cancelled';
 /**
  * Operations
  */
@@ -58,64 +53,83 @@ export interface OperationDeploy {
     action: 'prebuilt' | 'custom';
 }
 export type OperationList = OperationSync | OperationProxy | OperationAction | OperationWebhook | OperationOnEvents | OperationDeploy | OperationAuth | OperationAdmin;
+export interface MessageError {
+    name: string;
+    message: string;
+    type?: string | undefined;
+    payload?: any;
+}
+export interface MessageHTTPRequest {
+    url: string;
+    method: string;
+    headers: Record<string, string>;
+    body?: unknown;
+}
+export interface MessageHTTPResponse {
+    code: number;
+    headers: Record<string, string>;
+}
+export interface MessageHTTPRetry {
+    attempt: number;
+    max: number;
+    waited: number;
+}
 /**
  * Full schema
  */
 export interface MessageRow {
+    /**
+     * This ID is for debugging purpose, not for insertion
+     * It should never be used to index
+     */
     id: string;
     source: 'internal' | 'user';
     level: LogLevel;
     type: MessageType;
     message: string;
-    title: string | null;
-    state: MessageState;
-    code: MessageCode | null;
-    operation: null;
-    accountId: number | null;
-    accountName: string | null;
-    environmentId: number | null;
-    environmentName: string | null;
+    parentId: string;
+    error?: MessageError | undefined;
+    request?: MessageHTTPRequest | undefined;
+    response?: MessageHTTPResponse | undefined;
+    meta?: MessageMeta | null | undefined;
+    retry?: MessageHTTPRetry | undefined;
+    createdAt: string;
+    endedAt?: string | undefined;
+}
+export interface OperationRow {
+    id: string;
+    source: 'internal';
+    level: LogLevel;
+    type: 'operation';
+    message: string;
+    operation: OperationList;
+    state: OperationState;
+    accountId: number;
+    accountName: string;
+    environmentId?: number | undefined;
+    environmentName?: string | undefined;
     /**
      * Provider name, i.e: github
      */
-    providerName: string | null;
+    providerName?: string | undefined;
     /**
      * Database ID of the config, i.e: 9
      */
-    integrationId: number | null;
+    integrationId?: number | undefined;
     /**
      * Unique config name, i.e: github-demo
      */
-    integrationName: string | null;
-    connectionId: number | null;
-    connectionName: string | null;
-    syncConfigId: number | null;
-    syncConfigName: string | null;
-    jobId: string | null;
-    userId: number | null;
-    parentId: string | null;
-    error: {
-        name: string;
-        message: string;
-        type?: string | null;
-        payload?: any;
-    } | null;
-    request: {
-        url: string;
-        method: string;
-        headers: Record<string, string>;
-        body?: unknown;
-    } | null;
-    response: {
-        code: number;
-        headers: Record<string, string>;
-    } | null;
-    meta: MessageMeta | null;
-    retry?: {
-        attempt: number;
-        max: number;
-        waited: number;
-    } | undefined;
+    integrationName?: string | undefined;
+    connectionId?: number | undefined;
+    connectionName?: string | undefined;
+    syncConfigId?: number | undefined;
+    syncConfigName?: string | undefined;
+    jobId?: string | undefined;
+    userId?: number | undefined;
+    error?: MessageError | undefined;
+    request?: MessageHTTPRequest | undefined;
+    response?: MessageHTTPResponse | undefined;
+    meta?: MessageMeta | undefined;
     createdAt: string;
     updatedAt: string;
     startedAt: string | null;
@@ -123,14 +137,9 @@ export interface MessageRow {
     expiresAt: string | null;
 }
 /**
- * What is required to insert a Message
+ * What is required to insert an Operation
  */
-export type OperationRowInsert = Omit<Merge<Partial<MessageRow>, {
-    operation: OperationList;
-}>, 'message'>;
-export type OperationRow = SetNonNullable<Omit<MessageRow, 'operation'>, 'id' | 'message' | 'source' | 'createdAt' | 'accountId' | 'accountName' | 'type' | 'level' | 'expiresAt' | 'state'> & {
-    operation: OperationList;
-};
+export type OperationRowInsert = Merge<Partial<OperationRow>, Pick<OperationRow, 'operation'>>;
 /**
  * What is required to insert a Message
  */

package/dist/persist/api.d.ts

@@ -1,4 +1,20 @@
+import type { ApiError, Endpoint } from '../api.js';
+import type { MessageRowInsert } from '../logs/messages.js';
 import type { MergingStrategy, NangoRecord } from '../record/api.js';
+interface LogBody {
+    activityLogId: string;
+    log: MessageRowInsert;
+}
+export type PostLog = Endpoint<{
+    Method: 'POST';
+    Path: '/environment/:environmentId/log';
+    Params: {
+        environmentId: number;
+    };
+    Body: LogBody;
+    Error: ApiError<'post_log_failed'>;
+    Success: never;
+}>;
 export interface PostRecordsSuccess {
     nextMerging: MergingStrategy;
 }
@@ -15,3 +31,4 @@ export interface GetRecordsSuccess {
     records: NangoRecord[];
     nextCursor?: string;
 }
+export {};

package/package.json

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