@unito/integration-cli 0.57.1 → 0.58.0

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);
-        }
-    }
-}

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

@@ -1,51 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const chai_1 = require("chai");
-const path = tslib_1.__importStar(require("path"));
-const sinon = tslib_1.__importStar(require("sinon"));
-const tmp_1 = tslib_1.__importDefault(require("tmp"));
-const fs_1 = tslib_1.__importDefault(require("fs"));
-const Integration = tslib_1.__importStar(require("../../src/resources/integration"));
-describe('Integration Resource Generation', () => {
-    let tempDir;
-    const boilerplatePath = path.join(__dirname, '../../integrationBoilerplate');
-    afterEach(() => {
-        sinon.restore();
-    });
-    describe('generateIntegrationSkeleton', () => {
-        beforeEach(() => {
-            tempDir = tmp_1.default.dirSync({ prefix: 'outputIntegrations-' }).name;
-        });
-        afterEach(async () => {
-            await fs_1.default.promises.rm(tempDir, { recursive: true });
-            sinon.restore();
-        });
-        it('should not create a new integration directory if it already exists', async () => {
-            const existingIntegrationName = 'existingIntegration';
-            await Integration.generateIntegrationSkeleton(existingIntegrationName, tempDir);
-            try {
-                await Integration.generateIntegrationSkeleton(existingIntegrationName, tempDir);
-            }
-            catch (e) {
-                (0, chai_1.expect)(e).to.eql(new Error(`Integration already exists with this name: ${existingIntegrationName}`));
-            }
-        });
-        it('should create a new integration directory if it does not exist', async () => {
-            const integrationName = 'NewIntegration';
-            const result = await Integration.generateIntegrationSkeleton(integrationName, tempDir);
-            (0, chai_1.expect)(result).equal(path.join(tempDir, integrationName.toLowerCase()));
-            (0, chai_1.expect)(fs_1.default.existsSync(result)).to.be.true;
-            const expectedFiles = await fs_1.default.promises.readdir(boilerplatePath);
-            expectedFiles.push('.npmrc');
-            const createdFiles = await fs_1.default.promises.readdir(result);
-            (0, chai_1.expect)(createdFiles).to.deep.eq(expectedFiles.sort());
-            createdFiles.forEach(createdField => (0, chai_1.expect)(expectedFiles.includes(createdField)));
-        });
-        it('generates an .npmrc file', async () => {
-            const result = await Integration.generateIntegrationSkeleton('foo', tempDir);
-            const npmrc = await fs_1.default.promises.readFile(`${result}/.npmrc`, 'utf-8');
-            (0, chai_1.expect)(npmrc).to.include('//npm.pkg.github.com/:_authToken=${UNITO_GITHUB_PKG_TOKEN}');
-        });
-    });
-});

package/dist/src/oauth2Helper/oauth2Helper.d.ts

@@ -1,63 +0,0 @@
-import * as openUrl from 'openurl';
-import { Oauth2Response, Oauth2Payload } from './types';
-export declare const open: typeof openUrl;
-declare class OAuth2Helper {
-    private server;
-    private clientId;
-    private clientSecret;
-    private providerAuthorizationUrl;
-    private tokenUrl;
-    private scopes;
-    private grantType;
-    private requestContentType;
-    private responseContentType;
-    private refreshToken?;
-    private code;
-    private serverUrl;
-    private tokenRequestParameters;
-    private refreshRequestParameters;
-    /**
-     * Constructs an instance of OAuthHelper.
-     * @param clientId The client ID for your OAuth application.
-     * @param clientSecret The client secret for your OAuth application.
-     * @param authorizationUrl The URL for the authorization endpoint of the provider.
-     * @param scopes The scopes required for the OAuth authorization.
-     * @param providerTokenUrl The URL for the token endpoint of the provider.
-     */
-    constructor(authorizationInfo: Oauth2Payload);
-    /**
-     * Handles the authorization request and redirects the user to the provider's authorization page.
-     * @param req The express Request object.
-     * @param res The express Response object.
-     */
-    private handleAuthorize;
-    /**
-     * Handles the callback request from the provider and stores the authorization code.
-     * @param req The express Request object.
-     * @param res The express Response object.
-     */
-    private handleCallback;
-    private encodeBody;
-    /**
-     * Handles the token request to exchange the authorization code for an access token.
-     * @param req The express Request object.
-     * @param res The express Response object.
-     */
-    private handleToken;
-    updateToken(): Promise<Oauth2Response>;
-    /**
-     * Starts the Express server for handling OAuth callbacks.
-     * @returns The URL of the server.
-     */
-    startServer(): string;
-    /**
-     * Stops the Express server.
-     */
-    stopServer(): void;
-    /**
-     * Waits for the authorization code to be set.
-     * @returns A promise that resolves when the code is set.
-     */
-    callbackIsDone(): Promise<boolean>;
-}
-export default OAuth2Helper;