@unito/integration-cli 0.58.1 → 0.58.3

package/dist/.eslintrc.d.ts

@@ -4,13 +4,13 @@ export declare namespace env {
 export declare let plugins: string[];
 declare let _extends: string[];
 export { _extends as extends };
+export declare let rules: {
+    'no-console': string;
+};
+export declare let ignorePatterns: string[];
 export declare let overrides: {
     files: string[];
     rules: {
         '@typescript-eslint/no-floating-promises': string;
     };
 }[];
-export declare let rules: {
-    'no-console': string;
-};
-export declare let ignorePatterns: string[];

package/dist/.eslintrc.js

@@ -10,14 +10,6 @@ module.exports = {
         'eslint:recommended',
         'plugin:@typescript-eslint/recommended',
     ],
-    overrides: [
-        {
-            'files': ['test/**/*.test.ts'],
-            'rules': {
-                '@typescript-eslint/no-floating-promises': 'off'
-            }
-        }
-    ],
     rules: {
         'no-console': 'off',
     },

package/dist/boilerplate/.dockerignore

@@ -1,3 +1,3 @@
 node_modules
 dist
-.eslintrc.js
+eslint.config.js

package/dist/boilerplate/Dockerfile

@@ -35,4 +35,4 @@ RUN --mount=type=secret,id=npmrc,target=.npmrc npm ci --omit=dev
 RUN npm install --omit=dev
 
 ENTRYPOINT ["/usr/local/bin/docker-entrypoint.sh"]
-CMD ["node", "./src/index.js"]
+CMD ["node", "./index.js"]

package/dist/boilerplate/eslint.config.js

@@ -0,0 +1,7 @@
+import eslint from '@eslint/js';
+import tseslint from 'typescript-eslint';
+
+export default tseslint.config(
+  eslint.configs.recommended,
+  ...tseslint.configs.recommended,
+);

package/dist/boilerplate/package.json

@@ -1,16 +1,19 @@
 {
   "name": "integration-boilerplate",
+  "type": "module",
   "version": "0.0.1",
   "description": "Integration Boilerplate",
+  "license": "LicenseRef-LICENSE",
   "scripts": {
     "compile": "tsc",
-    "dev": "nodemon --watch \"src/**\" --ext ts --exec \"node --inspect --no-lazy -r ts-node/register/transpile-only src/index.ts\"",
-    "lint": "eslint --resolve-plugins-relative-to . --fix src --ext .ts && prettier --write src",
+    "dev": "tsx watch src/index.ts",
+    "test": "NODE_ENV=test tsx --test --test-name-pattern=${ONLY:-.*} $(find test -type f -name '*.test.ts')",
+    "lint": "eslint --fix src && prettier --write src",
     "ci:audit": "check-audit",
-    "ci:eslint": "eslint --resolve-plugins-relative-to . src --ext .ts",
+    "ci:eslint": "eslint src",
     "ci:lint": "npm run ci:prettier && npm run ci:eslint || (echo \"Please run eslint and/or prettier and commit the changes\" && exit 1)",
     "ci:prettier": "prettier --cache --ignore-unknown --check src",
-    "ci:test": "NODE_ENV=test mocha"
+    "ci:test": "npm run test"
   },
   "author": {
     "name": "Unito",
@@ -19,25 +22,16 @@
   "engines": {
     "node": ">=20.0.0"
   },
-  "license": "LicenseRef-LICENSE",
   "dependencies": {
-    "@unito/integration-api": "^0.x",
-    "express": "^5.0.0-beta.1",
-    "uuid": "9.x"
+    "@unito/integration-sdk": "^0.x"
   },
   "devDependencies": {
-    "@types/express": "4.x",
-    "@types/mocha": "10.x",
     "@types/node": "20.x",
-    "@types/uuid": "9.x",
-    "@typescript-eslint/eslint-plugin": "5.x",
-    "@typescript-eslint/parser": "5.x",
+    "typescript-eslint": "7.x",
     "eslint": "8.x",
-    "mocha": "10.x",
-    "nodemon": "2.x",
     "npm-audit-resolver": "^3.0.0-RC.0",
     "prettier": "2.x",
-    "ts-node": "10.x",
+    "tsx": "4.x",
     "typescript": "5.x"
   }
 }

package/dist/boilerplate/src/cache.ts

@@ -0,0 +1,8 @@
+// The Cache class provides caching capabilities.
+// https://dev.unito.io/docs/connectors/SDK/modules/cache
+
+import { Cache } from '@unito/integration-sdk';
+
+const cache = Cache.create(process.env.REDIS_URL);
+
+export default cache;

package/dist/boilerplate/src/handlers/me.ts

@@ -0,0 +1,10 @@
+import { GetCredentialAccountHandler } from '@unito/integration-sdk';
+
+export const getCredentialAccount: GetCredentialAccountHandler = async () => {
+  return {
+    id: 'me',
+    displayName: 'Me',
+    emails: [],
+    partition: undefined,
+  };
+};

package/dist/boilerplate/src/handlers/root.ts

@@ -0,0 +1,8 @@
+import { GetItemHandler } from '@unito/integration-sdk';
+
+export const getItem: GetItemHandler = async () => {
+  return {
+    fields: {},
+    relations: [],
+  };
+};

package/dist/boilerplate/src/helpers.ts

@@ -0,0 +1,43 @@
+import { Credentials, Secrets } from '@unito/integration-sdk';
+
+/**
+ * Use this helper function to centralize the logic for getting the credentials from the context object.
+ * For example, you might want to enrich the original object with some additional properties, or ensure
+ * that some critical properties are present before proceeding.
+ *
+ * This function also ensures that your credentials are consistenly typed across your integration.
+ *
+ * As an example, to ensure access token is always set;
+ *
+ * ```
+ *   if (!context.credentials.accessToken) {
+ *     throw new HttpErrors.UnauthorizedError('Missing access token');
+ *   }
+ *
+ *   return { accessToken: context.credentials.accessToken };
+ * ```
+ *
+ * @param context The object containing the raw credentials
+ * @returns The enriched credentials object
+ */
+export const getCredentials = (context: { credentials: Credentials }) => {
+  return {
+    // Tweak these properties to suit your needs
+  };
+};
+
+/**
+ * Use this helper function to centralize the logic for getting the secrets from the context object.
+ * For example, you might want to enrich the original object with some additional properties, or ensure
+ * that some critical properties are present before proceeding.
+ *
+ * This function also ensures that your secrets are consistenly typed across your integration.
+ *
+ * @param context The object containing the raw secrets
+ * @returns The enriched secrets object
+ */
+export const getSecrets = (context: { secrets: Secrets }) => {
+  return {
+    // Tweak these properties to suit your needs
+  };
+};

package/dist/boilerplate/src/index.ts

@@ -1,92 +1,11 @@
-import express from 'express';
-import { Error as APIError } from '@unito/integration-api';
+import { Integration } from '@unito/integration-sdk';
 
-import indexRouter from './routes/index';
-import { extractCredentials } from './middlewares/credentials';
-import { extractCorrelationId } from './middlewares/correlationId';
-import { extractAdditionalLoggingContext } from './middlewares/additionalLoggingContext';
-import { logger } from './logger';
+import * as meHandler from './handlers/me.js';
+import * as rootHandler from './handlers/root.js';
 
-// Express Server initialization
-const app: express.Application = express();
+const integration = new Integration();
 
-// Parse query strings with https://github.com/ljharb/qs.
-app.set('query parser', 'extended');
+integration.addHandler('/', rootHandler);
+integration.addHandler('/me', meHandler);
 
-app.use(express.json());
-
-// Must be one of the first handlers (to catch all the errors).
-app.use((req: express.Request, res: express.Response, next: express.NextFunction) => {
-  if (req.originalUrl !== '/health') {
-    res.on('finish', function () {
-      const loggerLevel = res.statusCode >= 500 ? 'error' : 'info';
-
-      // eslint-disable-next-line
-      logger[loggerLevel](`${req.method} ${req.originalUrl} ${res.statusCode}`);
-    });
-  }
-
-  next();
-});
-
-// Extract and validate the credentials.
-app.use(extractCredentials);
-
-// Extract the correlation id.
-app.use(extractCorrelationId);
-
-// Load the routes.
-app.use('/', indexRouter);
-
-// Extract the additional logging context.
-app.use(extractAdditionalLoggingContext);
-
-// Must be the (last - 1) handler.
-app.use((err: Error, _req: express.Request, res: express.Response, next: express.NextFunction) => {
-  if (res.headersSent) {
-    return next(err);
-  }
-
-  const originalError: APIError = {
-    code: err.name,
-    message: err.message,
-  };
-
-  res.status(500).json({
-    code: '500',
-    message: 'Oops! Something went wrong',
-    originalError: originalError,
-  } as APIError);
-});
-
-// Must be the last handler.
-app.use((req: express.Request, res: express.Response, _next: express.NextFunction) => {
-  const error: APIError = {
-    code: '404',
-    message: `Path ${req.path} not found.`,
-  };
-
-  res.status(404).json(error);
-});
-
-// eslint-disable-next-line
-const instance = app.listen(process.env.PORT || 9200, () => console.log(`Server started on port ${process.env.PORT || 9200}.`));
-
-// Trap exit signals.
-['SIGTERM', 'SIGINT', 'SIGUSR2'].forEach(signalType => {
-  process.once(signalType, async () => {
-    // eslint-disable-next-line
-    console.log(`Received termination signal ${signalType}. Exiting.`);
-
-    try {
-      if (instance) {
-        instance.close();
-      }
-    } catch (e) {
-      // eslint-disable-next-line
-      console.error('Failed to gracefully exit', e);
-    }
-
-    process.exit();
-  });
-});
+integration.start();

package/dist/boilerplate/src/provider.ts

@@ -0,0 +1,19 @@
+// This provider module is meant to be used to make requests to your provider's API.
+// https://dev.unito.io/docs/connectors/SDK/modules/provider
+
+import { Provider } from '@unito/integration-sdk';
+
+const provider = new Provider({
+  prepareRequest: options => {
+    return {
+      url: 'api.provider.com',
+      headers: {
+        // Include custom headers here, for example;
+        // 'Authorization': `Bearer ${options.credentials.apiKey}`,
+      },
+    };
+  },
+  rateLimiter: undefined,
+});
+
+export default provider;

package/dist/boilerplate/test/handlers/me.test.ts

@@ -0,0 +1,19 @@
+import assert from 'node:assert/strict';
+import { describe, it } from 'node:test';
+
+import { GetCredentialAccountContext } from '@unito/integration-sdk';
+
+import { getCredentialAccount } from '../../src/handlers/me.js';
+
+describe('meHandler', () => {
+  describe('getCredentialAccount', () => {
+    it('returns the credential account', async () => {
+      const credentialAccount = await getCredentialAccount({} as GetCredentialAccountContext);
+
+      assert.deepEqual(credentialAccount.displayName, 'Me');
+      assert.deepEqual(credentialAccount.emails, []);
+      assert.deepEqual(credentialAccount.id, 'me');
+      assert.deepEqual(credentialAccount.partition, undefined);
+    });
+  });
+});

package/dist/boilerplate/test/handlers/root.test.ts

@@ -0,0 +1,17 @@
+import assert from 'node:assert/strict';
+import { describe, it } from 'node:test';
+
+import { GetItemContext } from '@unito/integration-sdk';
+
+import { getItem } from '../../src/handlers/root.js';
+
+describe('rootHandler', () => {
+  describe('getItem', () => {
+    it('returns the root item', async () => {
+      const root = await getItem({} as GetItemContext);
+
+      assert.deepEqual(root.fields, {});
+      assert.deepEqual(root.relations, []);
+    });
+  });
+});

package/dist/boilerplate/tsconfig.json

@@ -1,10 +1,5 @@
 {
-  "ts-node": {
-    "logError": true
-  },
   "compilerOptions": {
-    "allowJs": true,
-    "allowSyntheticDefaultImports": true,
     "baseUrl": ".",
     "declaration": true,
     "declarationMap": true,
@@ -15,23 +10,20 @@
     "incremental": true,
     "isolatedModules": false,
     "lib": ["dom", "ES2022"],
-    "module": "commonjs",
-    "moduleResolution": "node",
+    "module": "NodeNext",
     "noImplicitAny": true,
     "noFallthroughCasesInSwitch": true,
     "noUnusedLocals": true,
     "outDir": "dist",
     "pretty": true,
-    "resolveJsonModule": true,
-    "rootDir": ".",
+    "moduleResolution": "NodeNext",
+    "rootDir": "./src",
     "skipLibCheck": true,
     "sourceMap": true,
     "strict": true,
     "strictFunctionTypes": true,
     "strictNullChecks": true,
     "strictPropertyInitialization": false,
-    "target": "ES2022"
-  },
-  "include": ["src/**/*"],
-  "exclude": ["node_modules"]
+    "target": "esnext"
+  }
 }

package/dist/src/commands/oauth2.js

@@ -85,7 +85,7 @@ class Oauth2 extends core_1.Command {
             }
             const decryptionResult = await (0, decryption_1.decryptEntries)(configuration.name, environment, this.config.configDir, testAccountCredentials);
             const refreshToken = decryptionResult.entries?.refreshToken;
-            core_1.ux.action.start(`Refreshing test account ${testAccountCredentials}`, undefined, { stdout: true });
+            core_1.ux.action.start(`Refreshing test account ${testAccount}`, undefined, { stdout: true });
             credentials = await Oauth2Resource.updateToken(oauth2, refreshToken);
             // If provider response doesn't contain a new refresh token, use the one we already have
             if (!credentials.refreshToken) {

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.58.1",
+  "version": "0.58.3",
   "commands": {
     "activity": {
       "id": "activity",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unito/integration-cli",
-  "version": "0.58.1",
+  "version": "0.58.3",
   "description": "Integration CLI",
   "bin": {
     "integration-cli": "./bin/run"
@@ -13,7 +13,7 @@
     "email": "hello@unito.io"
   },
   "engines": {
-    "node": ">=20.0.0"
+    "node": ">=18.0.0"
   },
   "scripts": {
     "prepublishOnly": "npm run lint && npm run test",
@@ -62,7 +62,7 @@
     "@types/gradient-string": "1.x",
     "@types/inquirer": "9.x",
     "@types/mocha": "10.x",
-    "@types/node": "20.x",
+    "@types/node": "18.x",
     "@types/openurl": "1.x",
     "@types/tmp": "0.x",
     "c8": "9.x",

package/dist/boilerplate/.eslintrc.js

@@ -1,74 +0,0 @@
-module.exports = {
-  'env': {
-    'browser': true,
-    'es6': true,
-    'node': true
-  },
-  'parser': '@typescript-eslint/parser',
-  'parserOptions': {
-    'project': './tsconfig.json',
-  },
-  'plugins': [
-    '@typescript-eslint'
-  ],
-  extends: [
-    'eslint:recommended',
-    'plugin:@typescript-eslint/recommended',
-  ],
-  ignorePatterns: [
-    'node_modules',
-    'dist',
-    '.eslintrc.js'
-  ],
-  'rules': {
-    '@typescript-eslint/no-loss-of-precision': 0,
-    '@typescript-eslint/no-explicit-any': 0,
-    '@typescript-eslint/ban-ts-comment': 0,
-    '@typescript-eslint/ban-ts-ignore': 0,
-    '@typescript-eslint/explicit-module-boundary-types': 0,
-    '@typescript-eslint/no-var-requires': 0,
-    '@typescript-eslint/no-floating-promises': 2,
-    '@typescript-eslint/no-unused-vars': 0,
-    // We need null in connectors because in some API, adding null to a field makes the API remove the value to the field
-    '@typescript-eslint/no-non-null-assertion': 0,
-    '@typescript-eslint/prefer-namespace-keyword': 0,
-    '@typescript-eslint/no-namespace': 0,
-    '@typescript-eslint/no-inferrable-types': 0,
-    '@typescript-eslint/naming-convention': [
-      1,
-      {
-        selector: [
-          'classProperty',
-          'objectLiteralProperty',
-          'typeProperty',
-          'classMethod',
-          'objectLiteralMethod',
-          'typeMethod',
-          'accessor',
-          'enumMember'
-        ],
-        format: null,
-        modifiers: ['requiresQuotes']
-      }
-    ],
-    'no-whitespace-before-property': 2,
-    'no-trailing-spaces': 2,
-    'no-extra-boolean-cast': 0,
-    'no-inner-declarations': 0,
-    'no-useless-escape': 0,
-    'no-case-declarations': 0,
-    'space-unary-ops': [2,
-      {
-        'words': true,
-        'nonwords': false,
-      },
-    ],
-    'space-before-function-paren': [2, {
-        'anonymous': 'always',
-        'named': 'never',
-        'asyncArrow': 'always'
-    }],
-    'object-curly-spacing': [2, 'always'],
-    'no-console': 2,
-  }
-};

package/dist/boilerplate/src/logger.ts

@@ -1,55 +0,0 @@
-enum LogLevel {
-  ERROR = 'error',
-  WARN = 'warn',
-  INFO = 'info',
-  LOG = 'log',
-  DEBUG = 'debug',
-}
-
-export class Logger {
-  private metadata: { [key: string]: string } = {};
-
-  private send(logLevel: LogLevel, message: string) {
-    console[logLevel](
-      // Datadog automatically parses JSON-formatted logs
-      JSON.stringify({
-        message: message,
-        ...this.metadata,
-      }),
-    );
-  }
-
-  public log(message: string) {
-    this.send(LogLevel.LOG, message);
-  }
-
-  public error(message: string) {
-    this.send(LogLevel.ERROR, message);
-  }
-
-  public warn(message: string) {
-    this.send(LogLevel.WARN, message);
-  }
-
-  public info(message: string) {
-    this.send(LogLevel.INFO, message);
-  }
-
-  public debug(message: string) {
-    this.send(LogLevel.DEBUG, message);
-  }
-
-  public decorate(metadata: { [key: string]: string }) {
-    this.metadata = metadata;
-  }
-
-  public setMeta(key: string, value: string) {
-    this.metadata[key] = value;
-  }
-
-  public clearMeta() {
-    this.metadata = {};
-  }
-}
-
-export const logger = new Logger();

package/dist/boilerplate/src/middlewares/additionalLoggingContext.ts

@@ -1,22 +0,0 @@
-import express from 'express';
-import { logger } from '../logger';
-
-export const extractAdditionalLoggingContext = (req: express.Request, res: express.Response, next: express.NextFunction) => {
-  const additionalLoggingContextHeader = req.header('X-Unito-Additional-Logging-Context');
-
-  let additionalLoggingContext;
-
-  if (typeof additionalLoggingContextHeader === 'string') {
-    try {
-      additionalLoggingContext = JSON.parse(additionalLoggingContextHeader);
-    } catch (error) {
-      logger.warn(`Failed parsing header X-Unito-Additional-Logging-Context: ${additionalLoggingContextHeader}`);
-    }
-  }
-
-  for (const [key, value] of Object.entries(additionalLoggingContext || {})) {
-    logger.setMeta(key, String(value));
-  }
-
-  next();
-};

package/dist/boilerplate/src/middlewares/correlationId.ts

@@ -1,13 +0,0 @@
-import express from 'express';
-import * as uuid from 'uuid';
-import { logger } from '../logger';
-
-export const extractCorrelationId = (req: express.Request, res: express.Response, next: express.NextFunction) => {
-  const correlationIdHeader = req.header('X-Unito-Correlation-Id');
-
-  const correlationId = correlationIdHeader ?? uuid.v4();
-
-  logger.setMeta('correlation_id', correlationId);
-
-  next();
-};

package/dist/boilerplate/src/middlewares/credentials.ts

@@ -1,38 +0,0 @@
-import { Request, Response, NextFunction } from 'express';
-
-// This interface contains the different variables defined in the authorization methods
-// of your integration (in the Integrations Platform registry).
-//
-// For example, if you add a "custom" authorization method in the registry with the variable "apiKey",
-// you must add "apiKey: string" to this interface.
-//
-// For your convenience, this interface is initialized for an integration that can either have:
-//
-// * No authentication.
-// * API key authentication (Bearer <accessToken>).
-// * OAuth 2 authentication (Bearer <accessToken>).
-//
-export interface Credentials {
-  accessToken?: string;
-}
-
-export const extractCredentials = (req: Request, res: Response, next: NextFunction) => {
-  const credentialsHeader = req.header('X-Unito-Credentials');
-
-  let credentials: Credentials | null = null;
-
-  if (credentialsHeader) {
-    try {
-      credentials = JSON.parse(Buffer.from(credentialsHeader, 'base64').toString('utf8'));
-    } catch {
-      return res.status(400).json({ code: 400, message: 'Error parsing credentials' });
-    }
-  }
-
-  // You can add additional verifications here to make sure you received
-  // all the necessary information to authenticate a user.
-
-  res.locals.credentials = credentials;
-
-  next();
-};

package/dist/boilerplate/src/request.ts

@@ -1,59 +0,0 @@
-import { Credentials } from './middlewares/credentials';
-
-export interface RequestOptions {
-  queryParams?: { [key: string]: string };
-  method?: 'POST' | 'GET' | 'PATCH';
-  body?: Record<string, unknown>;
-  credentials?: Credentials;
-}
-
-const apiUrl = 'https://path_to_your_api';
-
-export async function get<T>(endpoint: string, options: RequestOptions): Promise<T> {
-  return fetchWrapper(endpoint, options);
-}
-
-export async function post<T>(endpoint: string, options: RequestOptions): Promise<T> {
-  return fetchWrapper<T>(endpoint, {
-    ...options,
-    method: 'POST',
-  });
-}
-
-export async function patch<T>(endpoint: string, options: RequestOptions): Promise<T> {
-  return fetchWrapper<T>(endpoint, {
-    ...options,
-    method: 'PATCH',
-  });
-}
-
-async function fetchWrapper<T>(endpoint: string, options: RequestOptions): Promise<T> {
-  let absoluteUrl = [apiUrl, endpoint.charAt(0) === '/' ? endpoint.substring(1) : endpoint].join('/');
-
-  if (options.queryParams) {
-    absoluteUrl = `${absoluteUrl}?${new URLSearchParams(options.queryParams)}`;
-  }
-
-  const headers: { [key: string]: string } = {
-    'Content-Type': 'application/json',
-    Accept: 'application/json',
-  };
-
-  if (options.credentials?.accessToken) {
-    headers['Authorization'] = `Bearer ${options.credentials?.accessToken}`;
-  }
-
-  const response = await fetch(absoluteUrl, {
-    method: options.method,
-    headers,
-    body: options.body ? JSON.stringify(options.body) : undefined,
-  });
-
-  if (response.status === 200) {
-    return (await response.json()) as T;
-  }
-
-  const textResult = await response.text();
-
-  throw new Error(textResult);
-}

package/dist/boilerplate/src/routes/index.ts

@@ -1,11 +0,0 @@
-import { Router } from 'express';
-
-import { router as rootRouter } from './root';
-import { router as meRouter } from './me';
-
-const router = Router();
-
-router.use('/', rootRouter);
-router.use('/me', meRouter);
-
-export default router;

package/dist/boilerplate/src/routes/me.ts

@@ -1,15 +0,0 @@
-import { Request, Response, Router } from 'express';
-
-import { CredentialAccount } from '@unito/integration-api';
-
-export const router = Router();
-
-router.get('/', async (_req: Request, res: Response<CredentialAccount>) => {
-  const account: CredentialAccount = {
-    id: 'me',
-    displayName: 'Me',
-    emails: [],
-  };
-
-  res.json(account);
-});

package/dist/boilerplate/src/routes/root.ts

@@ -1,12 +0,0 @@
-import { Request, Response, Router } from 'express';
-
-import { Item } from '@unito/integration-api';
-
-export const router = Router();
-
-router.get('/', (_req: Request, res: Response<Item>) => {
-  return res.send({
-    fields: {},
-    relations: [],
-  });
-});