@nangohq/types 0.39.18

package/dist/api.d.ts

@@ -0,0 +1,45 @@
+export interface ApiError<TCode extends string> {
+    error: {
+        code: TCode;
+        message?: string | undefined;
+    };
+}
+/**
+ * API Request/Response type
+ */
+export interface Endpoint<T extends {
+    Params?: Record<string, any>;
+    Body?: Record<string, any>;
+    Querystring?: Record<string, any>;
+    Error?: ApiError<any> | never;
+    Success: Record<string, any> | never;
+}> {
+    /**
+     * URL params
+     */
+    Params: T['Params'] extends Record<string, any> ? T['Params'] : never;
+    /**
+     * URL query string
+     */
+    Querystring: T['Querystring'] extends Record<string, any> ? T['Querystring'] : never;
+    /**
+     * Helpers: Querystring + Params
+     */
+    QP: (T['Params'] extends Record<string, any> ? T['Params'] : never) & (T['Querystring'] extends Record<string, any> ? T['Querystring'] : never);
+    /**
+     * Received body
+     */
+    Body: T['Body'] extends Record<string, any> ? T['Body'] : never;
+    /**
+     * Response body for success
+     */
+    Success: T['Success'];
+    /**
+     * Response body for any error
+     */
+    Errors: T['Error'];
+    /**
+     * Response body (success + error)
+     */
+    Reply: T['Error'] extends ApiError<any> ? T['Error'] | T['Success'] : T['Success'];
+}

package/dist/db.d.ts

@@ -0,0 +1,10 @@
+export interface Timestamps {
+    created_at?: Date;
+    updated_at?: Date;
+}
+export interface Deleted {
+    deleted_at?: Date | null;
+    deleted?: boolean;
+}
+export interface TimestampsAndDeleted extends Timestamps, Deleted {
+}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export type * from './db.js';
+export type * from './onboarding/db.js';
+export type * from './onboarding/api.js';
+export type * from './record/api.js';

package/dist/onboarding/api.d.ts

@@ -0,0 +1,16 @@
+import type { ApiError, Endpoint } from '../api';
+import type { NangoRecord } from '../record/api';
+export type GetOnboardingStatus = Endpoint<{
+    Params: {
+        foo: 'bar';
+    };
+    Error: ApiError<'onboarding_dev_only'> | ApiError<'no_onboarding'> | ApiError<'failed_to_get_records'> | ApiError<'invalid_query_params'>;
+    Success: {
+        id: number;
+        progress: number;
+        records: NangoRecord[] | null;
+        provider: boolean;
+        connection: boolean;
+        sync: boolean;
+    };
+}>;

package/dist/onboarding/db.d.ts

@@ -0,0 +1,10 @@
+import type { Timestamps } from '../db';
+/**
+ * Onboarding row in database
+ */
+export interface DBOnboarding extends Timestamps {
+    id: number;
+    user_id: number;
+    progress: number;
+    complete: boolean;
+}

package/dist/record/api.d.ts

@@ -0,0 +1,13 @@
+export type RecordLastAction = 'ADDED' | 'UPDATED' | 'DELETED' | 'added' | 'updated' | 'deleted';
+export interface RecordMetadata {
+    first_seen_at: string;
+    last_modified_at: string;
+    last_action: RecordLastAction;
+    deleted_at: string | null;
+    cursor: string;
+}
+export interface NangoRecord {
+    [key: string]: any;
+    id: string | number;
+    _nango_metadata: RecordMetadata;
+}

package/package.json

@@ -0,0 +1,18 @@
+{
+    "name": "@nangohq/types",
+    "version": "0.39.18",
+    "description": "Types used in Nango applications",
+    "type": "module",
+    "typings": "dist/index.d.ts",
+    "scripts": {},
+    "keywords": [],
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/NangoHQ/nango.git",
+        "directory": "packages/utils"
+    },
+    "license": "SEE LICENSE IN LICENSE FILE IN GIT REPOSITORY",
+    "files": [
+        "dist/**/*"
+    ]
+}