@unito/integration-cli 0.57.2 → 0.58.1

package/dist/integrationGenerator/index.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./src"), exports);
-tslib_1.__exportStar(require("./errors"), exports);

package/dist/integrationGenerator/integrationBoilerplate/integrationBoilerplate/.dockerignore

@@ -1,3 +0,0 @@
-node_modules
-dist
-.eslintrc.js

package/dist/integrationGenerator/integrationBoilerplate/integrationBoilerplate/.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/integrationGenerator/integrationBoilerplate/integrationBoilerplate/.nvmrc

@@ -1 +0,0 @@
-lts/iron

package/dist/integrationGenerator/integrationBoilerplate/integrationBoilerplate/.prettierignore

@@ -1 +0,0 @@
-*.md

package/dist/integrationGenerator/integrationBoilerplate/integrationBoilerplate/.prettierrc

@@ -1,7 +0,0 @@
-{
-  "semi": true,
-  "trailingComma": "all",
-  "singleQuote": true,
-  "printWidth": 180,
-  "arrowParens": "avoid"
-}

package/dist/integrationGenerator/integrationBoilerplate/integrationBoilerplate/.unito.json

@@ -1 +0,0 @@
-{}

package/dist/integrationGenerator/integrationBoilerplate/integrationBoilerplate/Dockerfile

@@ -1,38 +0,0 @@
-# syntax = docker/dockerfile:1.2
-
-#
-# Build
-#
-
-FROM --platform=$BUILDPLATFORM public.ecr.aws/docker/library/node:20-alpine as build
-
-WORKDIR /build
-
-COPY . .
-
-RUN --mount=type=secret,id=npmrc,target=.npmrc npm ci
-
-RUN npm install
-RUN npm run compile
-
-#
-# Runtime
-#
-
-FROM --platform=$TARGETPLATFORM public.ecr.aws/docker/library/node:20-alpine as runtime
-
-WORKDIR /app
-
-COPY --from=build \
-  /build/tsconfig.json \
-  /build/package.json \
-  /build/package-lock.json \
-  /build/dist \
-  .
-
-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"]

package/dist/integrationGenerator/integrationBoilerplate/integrationBoilerplate/README.md

@@ -1,21 +0,0 @@
-# Integration Boilerplate
-
-Integration Boilerplate is a codebase for providing a uniform way to integrate new connector.
-
-## Build Docker image locally
-
-```sh
-cd integration-boilerplate
-docker build -t integration-boilerplate .
-```
-
-Run the docker image
-```sh
-docker run --name mytest1 -d -p 9200:9200 integration-boilerplate
-```
-
-Accessible on http://localhost:9200
-
-## License
-
-Copyright © 2015-present Unito Inc. All Rights Reserved.

package/dist/integrationGenerator/integrationBoilerplate/integrationBoilerplate/src/index.ts

@@ -1,94 +0,0 @@
-import express from 'express';
-import { Error as APIError } from '@unito/integration-api';
-
-import indexRouter from './routes/index';
-import { extractCredentials } from './middlewares/credentials';
-import { extractCorrelationId } from './middlewares/correlationId';
-import { extractAdditionalLoggingContext } from './middlewares/additionalLoggingContext';
-import { logger } from './logger';
-
-// Express Server initialization
-const app: express.Application = express();
-
-// Parse query strings with https://github.com/ljharb/qs.
-app.set('query parser', 'extended');
-
-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();
-  });
-});

package/dist/integrationGenerator/integrationBoilerplate/package.json

@@ -1,43 +0,0 @@
-{
-  "name": "integration-boilerplate",
-  "version": "0.0.1",
-  "description": "Integration Boilerplate",
-  "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",
-    "ci:audit": "check-audit",
-    "ci:eslint": "eslint --resolve-plugins-relative-to . src --ext .ts",
-    "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"
-  },
-  "author": {
-    "name": "Unito",
-    "email": "hello@unito.io"
-  },
-  "engines": {
-    "node": ">=20.0.0"
-  },
-  "license": "LicenseRef-LICENSE",
-  "dependencies": {
-    "@unito/integration-api": "^0.x",
-    "express": "^5.0.0-beta.1",
-    "uuid": "9.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",
-    "eslint": "8.x",
-    "mocha": "10.x",
-    "nodemon": "2.x",
-    "npm-audit-resolver": "^3.0.0-RC.0",
-    "prettier": "2.x",
-    "ts-node": "10.x",
-    "typescript": "5.x"
-  }
-}

package/dist/integrationGenerator/integrationBoilerplate/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/integrationGenerator/integrationBoilerplate/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/integrationGenerator/integrationBoilerplate/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/integrationGenerator/integrationBoilerplate/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/integrationGenerator/integrationBoilerplate/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/integrationGenerator/integrationBoilerplate/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/integrationGenerator/integrationBoilerplate/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/integrationGenerator/integrationBoilerplate/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: [],
-  });
-});

package/dist/integrationGenerator/integrationBoilerplate/tsconfig.json

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

package/dist/integrationGenerator/src/index.d.ts

@@ -1 +0,0 @@
-export * as Resources from './resources';

package/dist/integrationGenerator/src/index.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Resources = void 0;
-const tslib_1 = require("tslib");
-exports.Resources = tslib_1.__importStar(require("./resources"));

package/dist/integrationGenerator/src/resources/index.d.ts

@@ -1 +0,0 @@
-export * as Integration from './integration';

package/dist/integrationGenerator/src/resources/index.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Integration = void 0;
-const tslib_1 = require("tslib");
-exports.Integration = tslib_1.__importStar(require("./integration"));

package/dist/integrationGenerator/src/resources/integration.d.ts

@@ -1,9 +0,0 @@
-/**
- * Generates an integration skeleton with the specified name.
- *
- * @param {string} integrationName - The name of the integration.
- * @param {string} [destinationPath] - The destination path where the integration skeleton will be generated. If not provided, a default path will be used.
- * @returns {string} - The path of the generated integration skeleton.
- * @throws {Error} - If an integration with the same name already exists.
- */
-export declare function generateIntegrationSkeleton(integrationName: string, destinationPath?: string): Promise<string>;

package/dist/integrationGenerator/src/resources/integration.js

@@ -1,60 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateIntegrationSkeleton = void 0;
-const tslib_1 = require("tslib");
-const path = tslib_1.__importStar(require("path"));
-const fs = tslib_1.__importStar(require("fs"));
-const errors_1 = require("../../errors");
-/**
- * Generates an integration skeleton with the specified name.
- *
- * @param {string} integrationName - The name of the integration.
- * @param {string} [destinationPath] - The destination path where the integration skeleton will be generated. If not provided, a default path will be used.
- * @returns {string} - The path of the generated integration skeleton.
- * @throws {Error} - If an integration with the same name already exists.
- */
-async function generateIntegrationSkeleton(integrationName, destinationPath) {
-    const srcPath = path.join(__dirname, `../../integrationBoilerplate`);
-    // istanbul ignore next
-    const destPath = destinationPath ?? path.join(__dirname, `../../outputIntegrations`);
-    const targetFolder = `${destPath}/${integrationName.toLowerCase().replace(/ /g, '_')}`;
-    if (!fs.existsSync(targetFolder)) {
-        await fs.promises.mkdir(targetFolder, { recursive: true });
-        await copyFilesAndFolders(srcPath, targetFolder, ['node_modules', 'dist']);
-        // The .npmrc file is created here because it will be excluded during the CLI package's publishing process by npm.
-        // This step is necessary to ensure that the correct registry and auth token settings are present
-        // when installing package dependencies.
-        const npmrcContent = [
-            '@unitoio:registry=https://npm.pkg.github.com/unitoio',
-            '//npm.pkg.github.com/:_authToken=${UNITO_GITHUB_PKG_TOKEN}',
-            'engine-strict=true',
-            'strict-ssl=true',
-        ].join('\n');
-        await fs.promises.writeFile(path.join(targetFolder, '.npmrc'), npmrcContent);
-    }
-    else {
-        throw new errors_1.AlreadyExistingIntegrationError(`Integration already exists with this name: ${integrationName}`);
-    }
-    return targetFolder;
-}
-exports.generateIntegrationSkeleton = generateIntegrationSkeleton;
-async function copyFilesAndFolders(source, destination, excludedFolders) {
-    const files = await fs.promises.readdir(source);
-    for (const file of files) {
-        /* istanbul ignore next */
-        if (excludedFolders.includes(file)) {
-            continue;
-        }
-        const sourcePath = path.join(source, file);
-        const destPath = path.join(destination, file);
-        const stats = await fs.promises.stat(sourcePath);
-        /* istanbul ignore else */
-        if (stats.isFile()) {
-            await fs.promises.copyFile(sourcePath, destPath);
-        }
-        else if (stats.isDirectory()) {
-            await fs.promises.mkdir(destPath);
-            await copyFilesAndFolders(sourcePath, destPath, excludedFolders);
-        }
-    }
-}