@unito/integration-cli 0.55.1

package/dist/src/configurationTypes.d.ts

@@ -0,0 +1,209 @@
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+/**
+ * The configuration of an integration
+ */
+export interface Configuration {
+    /**
+     * The name of the integration
+     */
+    name: string;
+    /**
+     * The base URL where the integration is located
+     */
+    baseUrl?: string;
+    /**
+     * The relative URL (to the baseUrl) where the graph of items of the integration is located
+     */
+    graphRelativeUrl?: string;
+    /**
+     * The relative URL (to the baseUrl) to fetch the current integration's authenticated user
+     */
+    credentialAccountRelativeUrl?: string;
+    /**
+     * The relative URL (to the baseUrl) to parse a webhook payload
+     */
+    webhookParsingRelativeUrl?: string | null;
+    /**
+     * The relative URL (to the baseUrl) to operate on webhook subscriptions
+     */
+    webhookSubscriptionsRelativeUrl?: string | null;
+    /**
+     * The relative URL (to the baseUrl) to acknowledge webhook sender
+     */
+    webhookAcknowledgeRelativeUrl?: string | null;
+    /**
+     * The UI-related information of the integration
+     */
+    ui?: {
+        /**
+         * The name of the integration, as it should be displayed in a UI
+         */
+        displayName?: string;
+        /**
+         * Base64-encoded SVG of the logo of the integration
+         */
+        logo?: string;
+    };
+    /**
+     * The authorizations of the integration
+     */
+    authorizations?: Authorization[];
+    /**
+     * The test accounts of the integration
+     */
+    testAccounts?: {
+        /**
+         * Test account for local development
+         */
+        development?: {
+            [k: string]: unknown;
+        };
+        /**
+         * Test account for compliance tests
+         */
+        compliance?: {
+            [k: string]: unknown;
+        };
+    };
+    /**
+     * The secrets of the integration
+     */
+    secrets?: {
+        [k: string]: string;
+    };
+}
+/**
+ * An authorization is a way to obtain and generate credentials for an integration
+ */
+export interface Authorization {
+    name: string;
+    /**
+     * Whether the authorization is used locally for development purposes only
+     */
+    development?: boolean;
+    /**
+     * The Base64-encoded data URL of an <img> src content or null. For example: 'data:image/png;base64,<base64>'
+     */
+    instructionsImage?: null | string;
+    /**
+     * A string representing a markdown document or null
+     */
+    instructionsMarkdown?: null | string;
+    method: Method;
+    oauth2?: Oauth2;
+    /**
+     * Variables to obtain credentials from an end-user
+     */
+    variables?: {
+        /**
+         * This interface was referenced by `undefined`'s JSON-Schema definition
+         * via the `patternProperty` "^(?!refreshToken$)(?!accessToken$)(?!scope$)(?!expiresIn$)(?!tokenType$)(?!oauth2ExtraParameters$).*$".
+         */
+        [k: string]: {
+            type: Type;
+            format?: Format;
+            /**
+             * The JSON Schema regular expression template for the string value. Only the values that match this template will be accepted. The regular expression syntax used is from JavaScript (more specifically, ECMA 262)
+             */
+            pattern?: string;
+            label?: string;
+            required?: boolean;
+            defaultValue?: string | number | boolean;
+            placeholder?: string;
+            help?: string;
+            documentationUrl?: string;
+        };
+    };
+}
+/**
+ * Parameters to obtain OAuth 2 credentials from an end-user
+ */
+export interface Oauth2 {
+    /**
+     * The Client Secret obtained from the provider.
+     */
+    clientSecret?: string;
+    /**
+     * The Client Id obtained from the provider.
+     */
+    clientId?: string;
+    /**
+     * The URL to grant or deny access to the user account.
+     */
+    authorizationUrl?: string;
+    /**
+     * The URL to obtain or refresh an access token.
+     */
+    tokenUrl: string;
+    grantType?: GrantType;
+    scopes: {
+        /**
+         * The name of the scope
+         */
+        name: string;
+        /**
+         * Message to the end-user to explain the usage of the scope by Unito
+         */
+        help?: string;
+    }[];
+    tokenRequestParameters?: AuthorizationRequestParameters;
+    refreshRequestParameters?: AuthorizationRequestParameters;
+    requestContentType?: RequestContentType;
+    responseContentType?: RequestContentType;
+}
+/**
+ * The extra information used to communicate with the provider
+ */
+export interface AuthorizationRequestParameters {
+    /**
+     * Extra information to include in the HTTP request headers
+     */
+    header?: {
+        [k: string]: string | number | boolean;
+    };
+    /**
+     * Extra information to include in the HTTP request body
+     */
+    body?: {
+        [k: string]: string | number | boolean;
+    };
+}
+/**
+ * The method of authorization
+ */
+export declare enum Method {
+    CUSTOM = "custom",
+    OAUTH2 = "oauth2"
+}
+/**
+ * The type of grant of the OAuth 2 authorization
+ */
+export declare enum GrantType {
+    AUTHORIZATION_CODE = "authorization_code",
+    PASSWORD = "password"
+}
+/**
+ * The content type of exchanged information with the provider
+ */
+export declare enum RequestContentType {
+    URL_ENCODED = "application/x-www-form-urlencoded",
+    JSON = "application/json"
+}
+export declare enum Type {
+    BOOLEAN = "boolean",
+    NUMBER = "number",
+    PASSWORD = "password",
+    STRING = "string",
+    TEXT = "text"
+}
+/**
+ * The JSON Schema format that the value of the variable must comply to
+ */
+export declare enum Format {
+    EMAIL = "email",
+    URI = "uri"
+}

package/dist/src/configurationTypes.js

@@ -0,0 +1,49 @@
+"use strict";
+/* eslint-disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Format = exports.Type = exports.RequestContentType = exports.GrantType = exports.Method = void 0;
+/**
+ * The method of authorization
+ */
+var Method;
+(function (Method) {
+    Method["CUSTOM"] = "custom";
+    Method["OAUTH2"] = "oauth2";
+})(Method || (exports.Method = Method = {}));
+/**
+ * The type of grant of the OAuth 2 authorization
+ */
+var GrantType;
+(function (GrantType) {
+    GrantType["AUTHORIZATION_CODE"] = "authorization_code";
+    GrantType["PASSWORD"] = "password";
+})(GrantType || (exports.GrantType = GrantType = {}));
+/**
+ * The content type of exchanged information with the provider
+ */
+var RequestContentType;
+(function (RequestContentType) {
+    RequestContentType["URL_ENCODED"] = "application/x-www-form-urlencoded";
+    RequestContentType["JSON"] = "application/json";
+})(RequestContentType || (exports.RequestContentType = RequestContentType = {}));
+var Type;
+(function (Type) {
+    Type["BOOLEAN"] = "boolean";
+    Type["NUMBER"] = "number";
+    Type["PASSWORD"] = "password";
+    Type["STRING"] = "string";
+    Type["TEXT"] = "text";
+})(Type || (exports.Type = Type = {}));
+/**
+ * The JSON Schema format that the value of the variable must comply to
+ */
+var Format;
+(function (Format) {
+    Format["EMAIL"] = "email";
+    Format["URI"] = "uri";
+})(Format || (exports.Format = Format = {}));

package/dist/src/errors.d.ts

@@ -0,0 +1,38 @@
+export declare class NoIntegrationFoundError extends Error {
+}
+export declare class NoConfigurationFileError extends Error {
+}
+export declare class ConfigurationMalformed extends Error {
+}
+export declare class MissingEnvironmentVariableError extends Error {
+}
+export declare class NoRefreshTokenError extends Error {
+}
+export declare class FailedToRetrieveAccessTokenError extends Error {
+}
+export declare class InvalidRequestContentTypeError extends Error {
+}
+export declare class MissingCredentialsError extends Error {
+}
+export declare class FileSizeExceeded extends Error {
+}
+export declare class MissingApiKey extends Error {
+}
+export declare class AuthenticationFailed extends Error {
+}
+export declare class DecryptionAuthenticationError extends Error {
+    encryptedEntityName: string;
+    constructor(entityName: string);
+}
+export declare class EntryDecryptionError extends Error {
+    key: string;
+    value: string;
+    environment: string;
+    constructor(key: string, value: string, targetEnvironment: string);
+}
+export declare class ConfigurationInvalid extends Error {
+    details: unknown;
+    prettyDetails: string;
+    constructor(message: string, details: unknown, prettyDetails: string);
+}
+export declare function handleError(error: Error): boolean;

package/dist/src/errors.js

@@ -0,0 +1,159 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleError = exports.ConfigurationInvalid = exports.EntryDecryptionError = exports.DecryptionAuthenticationError = exports.AuthenticationFailed = exports.MissingApiKey = exports.FileSizeExceeded = exports.MissingCredentialsError = exports.InvalidRequestContentTypeError = exports.FailedToRetrieveAccessTokenError = exports.NoRefreshTokenError = exports.MissingEnvironmentVariableError = exports.ConfigurationMalformed = exports.NoConfigurationFileError = exports.NoIntegrationFoundError = void 0;
+const tslib_1 = require("tslib");
+const core_1 = require("@oclif/core");
+const chalk_1 = tslib_1.__importDefault(require("chalk"));
+const path_1 = tslib_1.__importDefault(require("path"));
+const json_colorizer_1 = tslib_1.__importDefault(require("json-colorizer"));
+const configuration_1 = require("./resources/configuration");
+const integrationsPlatform_1 = require("./services/integrationsPlatform");
+class NoIntegrationFoundError extends Error {
+}
+exports.NoIntegrationFoundError = NoIntegrationFoundError;
+class NoConfigurationFileError extends Error {
+}
+exports.NoConfigurationFileError = NoConfigurationFileError;
+class ConfigurationMalformed extends Error {
+}
+exports.ConfigurationMalformed = ConfigurationMalformed;
+class MissingEnvironmentVariableError extends Error {
+}
+exports.MissingEnvironmentVariableError = MissingEnvironmentVariableError;
+class NoRefreshTokenError extends Error {
+}
+exports.NoRefreshTokenError = NoRefreshTokenError;
+class FailedToRetrieveAccessTokenError extends Error {
+}
+exports.FailedToRetrieveAccessTokenError = FailedToRetrieveAccessTokenError;
+class InvalidRequestContentTypeError extends Error {
+}
+exports.InvalidRequestContentTypeError = InvalidRequestContentTypeError;
+class MissingCredentialsError extends Error {
+}
+exports.MissingCredentialsError = MissingCredentialsError;
+class FileSizeExceeded extends Error {
+}
+exports.FileSizeExceeded = FileSizeExceeded;
+class MissingApiKey extends Error {
+}
+exports.MissingApiKey = MissingApiKey;
+class AuthenticationFailed extends Error {
+}
+exports.AuthenticationFailed = AuthenticationFailed;
+class DecryptionAuthenticationError extends Error {
+    encryptedEntityName;
+    constructor(entityName) {
+        super();
+        this.encryptedEntityName = entityName;
+    }
+}
+exports.DecryptionAuthenticationError = DecryptionAuthenticationError;
+class EntryDecryptionError extends Error {
+    key;
+    value;
+    environment;
+    constructor(key, value, targetEnvironment) {
+        super();
+        this.key = key;
+        this.value = value;
+        this.environment = targetEnvironment;
+    }
+}
+exports.EntryDecryptionError = EntryDecryptionError;
+class ConfigurationInvalid extends Error {
+    details;
+    prettyDetails;
+    constructor(message, details, prettyDetails) {
+        super(message);
+        this.details = details;
+        this.prettyDetails = prettyDetails;
+    }
+}
+exports.ConfigurationInvalid = ConfigurationInvalid;
+function handleError(error) {
+    /* istanbul ignore if */
+    if (core_1.ux.action.running) {
+        core_1.ux.action.stop(chalk_1.default.redBright('failed'));
+    }
+    let handled = false;
+    if (error instanceof NoIntegrationFoundError) {
+        core_1.ux.log(chalk_1.default.redBright('Your directory does not seem to contain an integration :('));
+        core_1.ux.log(`Make sure you are in the right directory and that you have a ${chalk_1.default.yellowBright(configuration_1.DEFAULT_CONFIGURATION_NAME)} file.`);
+        handled = true;
+    }
+    else if (error instanceof NoConfigurationFileError) {
+        core_1.ux.log(chalk_1.default.redBright('This command requires a configuration file for your integration :('));
+        core_1.ux.log(`This file should be located at ${chalk_1.default.yellowBright(path_1.default.relative(process.cwd(), (0, configuration_1.getConfigurationPath)()))}.`);
+        handled = true;
+    }
+    else if (error instanceof MissingEnvironmentVariableError) {
+        core_1.ux.log(chalk_1.default.redBright('This command requires a variable which is missing from your environment :('));
+        core_1.ux.log(`Make sure the environment variable ${chalk_1.default.yellowBright(error.message)} is defined.`);
+        handled = true;
+    }
+    else if (error instanceof ConfigurationMalformed) {
+        core_1.ux.log(chalk_1.default.redBright(`Your ${chalk_1.default.yellowBright(configuration_1.DEFAULT_CONFIGURATION_NAME)} was found but its not a valid JSON file!`));
+        handled = true;
+    }
+    else if (error instanceof ConfigurationInvalid) {
+        core_1.ux.log(chalk_1.default.redBright(`Your ${chalk_1.default.yellowBright(configuration_1.DEFAULT_CONFIGURATION_NAME)} is invalid!`));
+        core_1.ux.log();
+        core_1.ux.log(error.prettyDetails);
+        handled = true;
+    }
+    else if (error instanceof NoRefreshTokenError) {
+        core_1.ux.log(chalk_1.default.redBright('No refresh token found in your configuration file'));
+        handled = true;
+    }
+    else if (error instanceof FailedToRetrieveAccessTokenError) {
+        core_1.ux.log(chalk_1.default.redBright('Failed to retrieve access token'));
+        core_1.ux.log();
+        core_1.ux.log(error.message);
+        handled = true;
+    }
+    else if (error instanceof InvalidRequestContentTypeError) {
+        core_1.ux.log(chalk_1.default.redBright('Invalid request content type'));
+        handled = true;
+        core_1.ux.log();
+        core_1.ux.log(error.message);
+    }
+    else if (error instanceof integrationsPlatform_1.HttpError) {
+        handled = true;
+        core_1.ux.log();
+        core_1.ux.log((0, json_colorizer_1.default)(JSON.stringify(error.data, null, 2)));
+    }
+    else if (error instanceof MissingCredentialsError) {
+        core_1.ux.log();
+        core_1.ux.log(chalk_1.default.redBright('The credentials are missing from your configuration file'));
+        handled = true;
+    }
+    else if (error instanceof MissingApiKey) {
+        core_1.ux.log();
+        core_1.ux.log(chalk_1.default.redBright('Your API key is not set!'));
+        core_1.ux.log(`Make sure to run the ${chalk_1.default.yellowBright('login')} command first`);
+        handled = true;
+    }
+    else if (error instanceof AuthenticationFailed) {
+        core_1.ux.log();
+        core_1.ux.log(chalk_1.default.redBright('This command requires that you are logged to Unito!'));
+        core_1.ux.log(`Make sure to run the ${chalk_1.default.yellowBright('login')} command first`);
+        handled = true;
+    }
+    else if (error instanceof DecryptionAuthenticationError) {
+        core_1.ux.log();
+        core_1.ux.log(chalk_1.default.yellowBright(`Your configuration contains encrypted ${error.encryptedEntityName}.`));
+        core_1.ux.log('To use them locally, you must be authenticated to Unito.');
+        handled = true;
+    }
+    else if (error instanceof EntryDecryptionError) {
+        core_1.ux.log();
+        core_1.ux.log(chalk_1.default.yellowBright(`Error decrypting entry:`));
+        core_1.ux.log(chalk_1.default.redBright(`${error.key}: ${error.value}`));
+        core_1.ux.log();
+        core_1.ux.log(`Make sure they were encrypted by the same environement (Currently targeting: ${error.environment}).`);
+        handled = true;
+    }
+    return handled;
+}
+exports.handleError = handleError;

package/dist/src/hooks/init/displayLogo.d.ts

@@ -0,0 +1,3 @@
+import { Hook } from '@oclif/core';
+declare const displayLogo: Hook<'init'>;
+export default displayLogo;

package/dist/src/hooks/init/displayLogo.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const core_1 = require("@oclif/core");
+const gradient = tslib_1.__importStar(require("gradient-string"));
+const displayLogo = async function () {
+    const gradients = [
+        gradient.atlas,
+        gradient.mind,
+        gradient.morning,
+        gradient.passion,
+        gradient.fruit,
+        gradient.instagram,
+        gradient.retro,
+        gradient.teen,
+        gradient.pastel,
+        gradient.rainbow,
+        gradient.cristal,
+    ];
+    const selectedGradient = gradients[Math.floor(Math.random() * gradients.length)];
+    const UNITOCLI_LOGO = selectedGradient.multiline([
+        '+------------------------------------+',
+        '|                                    |',
+        '|        / / / /___  (_) /_____      |',
+        '|       / / / / __ \\/ / __/ __ \\     |',
+        '|      / /_/ / / / / / /_/ /_/ /     |',
+        '|      \\____/_/_/_/_/\\__/\\____/      |',
+        '|        / ____/ /   /  _/           |',
+        '|       / /   / /    / /             |',
+        '|      / /___/ /____/ /              |',
+        '|      \\____/_____/___/              |',
+        '|                                    |',
+        '+------------------------------------+',
+    ].join('\n'));
+    core_1.ux.log(UNITOCLI_LOGO);
+};
+exports.default = displayLogo;

package/dist/src/index.d.ts

@@ -0,0 +1 @@
+export { run } from '@oclif/core';

package/dist/src/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.run = void 0;
+var core_1 = require("@oclif/core");
+Object.defineProperty(exports, "run", { enumerable: true, get: function () { return core_1.run; } });

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

@@ -0,0 +1,63 @@
+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;