faros-airbyte-cdk 0.0.1

package/README.md

@@ -0,0 +1,5 @@
+# Airbyte Connector Development Kit (CDK) for JavaScript/TypeScript
+
+[![npm version](https://badge.fury.io/js/faros-airbyte-cdk.svg)](https://badge.fury.io/js/faros-airbyte-cdk)
+
+📖 Read more here - https://github.com/faros-ai/airbyte-connectors

package/lib/connector.d.ts

@@ -0,0 +1,17 @@
+import { AirbyteConfig, AirbyteConnectionStatusMessage, AirbyteSpec } from './protocol';
+export declare abstract class AirbyteConnector {
+    /**
+     * @returns the spec for this integration. The spec is a JSON-Schema object
+     * describing the required configurations (e.g: username and password)
+     * required to run this integration.
+     */
+    abstract spec(): Promise<AirbyteSpec>;
+    /**
+     * Tests if the input configuration can be used to successfully connect to the
+     * integration e.g: if a provided Stripe API token can be used to connect to
+     * the Stripe API.
+     *
+     * @returns Whether the check succeeds or fails with an error message.
+     */
+    abstract check(config: AirbyteConfig): Promise<AirbyteConnectionStatusMessage>;
+}

package/lib/connector.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AirbyteConnector = void 0;
+class AirbyteConnector {
+}
+exports.AirbyteConnector = AirbyteConnector;
+//# sourceMappingURL=connector.js.map

package/lib/connector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"connector.js","sourceRoot":"","sources":["../src/connector.ts"],"names":[],"mappings":";;;AAMA,MAAsB,gBAAgB;CAkBrC;AAlBD,4CAkBC"}

package/lib/destinations/destination-runner.d.ts

@@ -0,0 +1,17 @@
+import { Command } from 'commander';
+import { AirbyteLogger } from '../logger';
+import { AirbyteConfig } from '../protocol';
+import { Runner } from '../runner';
+import { AirbyteDestination } from './destination';
+export declare class AirbyteDestinationRunner<Config extends AirbyteConfig> extends Runner {
+    protected readonly logger: AirbyteLogger;
+    protected readonly destination: AirbyteDestination<Config>;
+    constructor(logger: AirbyteLogger, destination: AirbyteDestination<Config>);
+    mainCommand(): Command;
+    specCommand(): Command;
+    checkCommand(): Command;
+    writeCommand(): Command;
+    specPrettyCommand(): Command;
+    airbyteLocalCLIWizardCommand(): Command;
+    private loadConfig;
+}

package/lib/destinations/destination-runner.js

@@ -0,0 +1,151 @@
+"use strict";
+/* eslint-disable @typescript-eslint/no-var-requires */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AirbyteDestinationRunner = void 0;
+const commander_1 = require("commander");
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const errors_1 = require("../errors");
+const help_1 = require("../help");
+const runner_1 = require("../runner");
+const utils_1 = require("../utils");
+class AirbyteDestinationRunner extends runner_1.Runner {
+    constructor(logger, destination) {
+        super(logger);
+        this.logger = logger;
+        this.destination = destination;
+    }
+    mainCommand() {
+        return new commander_1.Command()
+            .name('main')
+            .version('v' + utils_1.PACKAGE_VERSION)
+            .addCommand(this.specCommand())
+            .addCommand(this.specPrettyCommand())
+            .addCommand(this.airbyteLocalCLIWizardCommand())
+            .addCommand(this.checkCommand())
+            .addCommand(this.writeCommand());
+    }
+    specCommand() {
+        return new commander_1.Command()
+            .command('spec')
+            .description('spec command')
+            .alias('s')
+            .action(async () => {
+            const spec = await this.destination.spec();
+            // Expected output
+            this.logger.write(spec);
+        });
+    }
+    checkCommand() {
+        return new commander_1.Command()
+            .command('check')
+            .description('check command')
+            .alias('c')
+            .requiredOption('--config <path to json>', 'config json')
+            .action(async (opts) => {
+            const config = require(path_1.default.resolve(opts.config));
+            const status = await this.destination.check(config);
+            // Expected output
+            this.logger.write(status);
+        });
+    }
+    writeCommand() {
+        return new commander_1.Command()
+            .command('write')
+            .description('write command')
+            .alias('w')
+            .requiredOption('--config <path to json>', 'config json')
+            .requiredOption('--catalog <path to json>', 'catalog json')
+            .option('--dry-run', 'dry run to skip writing records to destination', false)
+            .action(async (opts) => {
+            const { catalog, spec, config } = await this.loadConfig(opts);
+            this.logger.info(`Config: ${(0, utils_1.redactConfig)(config, spec)}`);
+            this.logger.info(`Catalog: ${JSON.stringify(catalog)}`);
+            try {
+                process.stdin.setEncoding('utf-8');
+                const iter = this.destination.write(config, catalog, process.stdin, opts.dryRun);
+                for await (const message of iter) {
+                    this.logger.write(message);
+                }
+            }
+            catch (e) {
+                const w = (0, errors_1.wrapApiError)(e);
+                const s = JSON.stringify(w);
+                this.logger.error(`Encountered an error while writing to destination: ${w} - ${s}`, w.stack);
+                throw e;
+            }
+            finally {
+                process.stdin.destroy();
+            }
+        });
+    }
+    specPrettyCommand() {
+        return new commander_1.Command()
+            .command('spec-pretty')
+            .description('pretty spec command')
+            .action(async () => {
+            const spec = await this.destination.spec();
+            const rows = (0, help_1.traverseObject)(spec.spec.connectionSpecification, [
+                // Prefix argument names with --dst
+                '--dst',
+            ], 
+            // Assign section = 0 to the root object's row, which
+            // will be removed, so that the remaining rows are
+            // numbered 1..N
+            0);
+            // Drop the first row since it corresponds to the root
+            // (connectionSpecification) object
+            rows.shift();
+            console.log((0, help_1.helpTable)(rows));
+        });
+    }
+    airbyteLocalCLIWizardCommand() {
+        return new commander_1.Command()
+            .command('airbyte-local-cli-wizard')
+            .option('--json <path to json>', 'Output the destination configuration as JSON')
+            .option('--spec-file <path to spec>', 'Path to the spec file. If not provided, the spec will be fetched from the destination')
+            .option('--include-deprecated-fields', 'Include fields marked as deprecated in the spec', false)
+            .option('--include-hidden-fields', 'Include fields marked as hidden in the spec', false)
+            .description('Run a wizard command to prepare arguments for Airbyte Local CLI')
+            .action(async (opts) => {
+            const spec = opts.specFile
+                ? JSON.parse(fs_1.default.readFileSync(opts.specFile, 'utf8'))
+                : await this.destination.spec();
+            const rows = (0, help_1.traverseObject)(spec.spec.connectionSpecification, opts.json
+                ? []
+                : [
+                    // Prefix argument names with --dst
+                    '--dst',
+                ], 
+            // Assign section = 0 to the root object's row
+            0, opts.includeDeprecatedFields, opts.includeHiddenFields);
+            if (opts.json) {
+                fs_1.default.writeFileSync(opts.json, await (0, help_1.buildJson)(rows));
+            }
+            else {
+                console.log('\n\nUse the arguments below when running this destination' +
+                    ' with Airbyte Local CLI (https://github.com/faros-ai/airbyte-local-cli):' +
+                    `\n\n${await (0, help_1.buildArgs)(rows)}`);
+            }
+        });
+    }
+    async loadConfig(opts) {
+        try {
+            const catalog = require(path_1.default.resolve(opts.catalog));
+            const spec = await this.destination.spec();
+            const config = (0, utils_1.withDefaults)(require(path_1.default.resolve(opts.config)), spec);
+            return { catalog, spec, config };
+        }
+        catch (e) {
+            const w = (0, errors_1.wrapApiError)(e);
+            const s = JSON.stringify(w);
+            this.logger.error(`Encountered an error while loading configuration: ${w} - ${s}`, w.stack);
+            throw e;
+        }
+    }
+}
+exports.AirbyteDestinationRunner = AirbyteDestinationRunner;
+//# sourceMappingURL=destination-runner.js.map

package/lib/destinations/destination-runner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"destination-runner.js","sourceRoot":"","sources":["../../src/destinations/destination-runner.ts"],"names":[],"mappings":";AAAA,uDAAuD;;;;;;AAEvD,yCAAkC;AAClC,4CAAoB;AACpB,gDAAwB;AAExB,sCAAuC;AACvC,kCAAwE;AAGxE,sCAAiC;AACjC,oCAAqE;AAGrE,MAAa,wBAEX,SAAQ,eAAM;IACd,YACqB,MAAqB,EACrB,WAAuC;QAE1D,KAAK,CAAC,MAAM,CAAC,CAAC;QAHK,WAAM,GAAN,MAAM,CAAe;QACrB,gBAAW,GAAX,WAAW,CAA4B;IAG5D,CAAC;IAED,WAAW;QACT,OAAO,IAAI,mBAAO,EAAE;aACjB,IAAI,CAAC,MAAM,CAAC;aACZ,OAAO,CAAC,GAAG,GAAG,uBAAe,CAAC;aAC9B,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;aAC9B,UAAU,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;aACpC,UAAU,CAAC,IAAI,CAAC,4BAA4B,EAAE,CAAC;aAC/C,UAAU,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;aAC/B,UAAU,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;IACrC,CAAC;IAED,WAAW;QACT,OAAO,IAAI,mBAAO,EAAE;aACjB,OAAO,CAAC,MAAM,CAAC;aACf,WAAW,CAAC,cAAc,CAAC;aAC3B,KAAK,CAAC,GAAG,CAAC;aACV,MAAM,CAAC,KAAK,IAAI,EAAE;YACjB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;YAE3C,kBAAkB;YAClB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;IACP,CAAC;IAED,YAAY;QACV,OAAO,IAAI,mBAAO,EAAE;aACjB,OAAO,CAAC,OAAO,CAAC;aAChB,WAAW,CAAC,eAAe,CAAC;aAC5B,KAAK,CAAC,GAAG,CAAC;aACV,cAAc,CAAC,yBAAyB,EAAE,aAAa,CAAC;aACxD,MAAM,CAAC,KAAK,EAAE,IAAsB,EAAE,EAAE;YACvC,MAAM,MAAM,GAAG,OAAO,CAAC,cAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;YAClD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YAEpD,kBAAkB;YAClB,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;IACP,CAAC;IAED,YAAY;QACV,OAAO,IAAI,mBAAO,EAAE;aACjB,OAAO,CAAC,OAAO,CAAC;aAChB,WAAW,CAAC,eAAe,CAAC;aAC5B,KAAK,CAAC,GAAG,CAAC;aACV,cAAc,CAAC,yBAAyB,EAAE,aAAa,CAAC;aACxD,cAAc,CAAC,0BAA0B,EAAE,cAAc,CAAC;aAC1D,MAAM,CACL,WAAW,EACX,gDAAgD,EAChD,KAAK,CACN;aACA,MAAM,CACL,KAAK,EAAE,IAAwD,EAAE,EAAE;YACjE,MAAM,EAAC,OAAO,EAAE,IAAI,EAAE,MAAM,EAAC,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;YAC5D,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,IAAA,oBAAY,EAAC,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;YAC1D,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;YAExD,IAAI;gBACF,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;gBAEnC,MAAM,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CACjC,MAAM,EACN,OAAO,EACP,OAAO,CAAC,KAAK,EACb,IAAI,CAAC,MAAM,CACZ,CAAC;gBACF,IAAI,KAAK,EAAE,MAAM,OAAO,IAAI,IAAI,EAAE;oBAChC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;iBAC5B;aACF;YAAC,OAAO,CAAM,EAAE;gBACf,MAAM,CAAC,GAAG,IAAA,qBAAY,EAAC,CAAC,CAAC,CAAC;gBAC1B,MAAM,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;gBAC5B,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,sDAAsD,CAAC,MAAM,CAAC,EAAE,EAChE,CAAC,CAAC,KAAK,CACR,CAAC;gBACF,MAAM,CAAC,CAAC;aACT;oBAAS;gBACR,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;aACzB;QACH,CAAC,CACF,CAAC;IACN,CAAC;IAED,iBAAiB;QACf,OAAO,IAAI,mBAAO,EAAE;aACjB,OAAO,CAAC,aAAa,CAAC;aACtB,WAAW,CAAC,qBAAqB,CAAC;aAClC,MAAM,CAAC,KAAK,IAAI,EAAE;YACjB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;YAC3C,MAAM,IAAI,GAAG,IAAA,qBAAc,EACzB,IAAI,CAAC,IAAI,CAAC,uBAAuB,EACjC;gBACE,mCAAmC;gBACnC,OAAO;aACR;YACD,qDAAqD;YACrD,kDAAkD;YAClD,gBAAgB;YAChB,CAAC,CACF,CAAC;YACF,sDAAsD;YACtD,mCAAmC;YACnC,IAAI,CAAC,KAAK,EAAE,CAAC;YACb,OAAO,CAAC,GAAG,CAAC,IAAA,gBAAS,EAAC,IAAI,CAAC,CAAC,CAAC;QAC/B,CAAC,CAAC,CAAC;IACP,CAAC;IAED,4BAA4B;QAC1B,OAAO,IAAI,mBAAO,EAAE;aACjB,OAAO,CAAC,0BAA0B,CAAC;aACnC,MAAM,CACL,uBAAuB,EACvB,8CAA8C,CAC/C;aACA,MAAM,CACL,4BAA4B,EAC5B,uFAAuF,CACxF;aACA,MAAM,CACL,6BAA6B,EAC7B,iDAAiD,EACjD,KAAK,CACN;aACA,MAAM,CACL,yBAAyB,EACzB,6CAA6C,EAC7C,KAAK,CACN;aACA,WAAW,CACV,iEAAiE,CAClE;aACA,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;YACrB,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ;gBACxB,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,YAAE,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;gBACpD,CAAC,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;YAClC,MAAM,IAAI,GAAG,IAAA,qBAAc,EACzB,IAAI,CAAC,IAAI,CAAC,uBAAuB,EACjC,IAAI,CAAC,IAAI;gBACP,CAAC,CAAC,EAAE;gBACJ,CAAC,CAAC;oBACE,mCAAmC;oBACnC,OAAO;iBACR;YACL,8CAA8C;YAC9C,CAAC,EACD,IAAI,CAAC,uBAAuB,EAC5B,IAAI,CAAC,mBAAmB,CACzB,CAAC;YAEF,IAAI,IAAI,CAAC,IAAI,EAAE;gBACb,YAAE,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,IAAA,gBAAS,EAAC,IAAI,CAAC,CAAC,CAAC;aACpD;iBAAM;gBACL,OAAO,CAAC,GAAG,CACT,2DAA2D;oBACzD,0EAA0E;oBAC1E,OAAO,MAAM,IAAA,gBAAS,EAAC,IAAI,CAAC,EAAE,CACjC,CAAC;aACH;QACH,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,KAAK,CAAC,UAAU,CAAC,IAIxB;QACC,IAAI;YACF,MAAM,OAAO,GAAG,OAAO,CAAC,cAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;YACpD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;YAC3C,MAAM,MAAM,GAAG,IAAA,oBAAY,EAAC,OAAO,CAAC,cAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;YACtE,OAAO,EAAC,OAAO,EAAE,IAAI,EAAE,MAAM,EAAC,CAAC;SAChC;QAAC,OAAO,CAAM,EAAE;YACf,MAAM,CAAC,GAAG,IAAA,qBAAY,EAAC,CAAC,CAAC,CAAC;YAC1B,MAAM,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YAC5B,IAAI,CAAC,MAAM,CAAC,KAAK,CACf,qDAAqD,CAAC,MAAM,CAAC,EAAE,EAC/D,CAAC,CAAC,KAAK,CACR,CAAC;YACF,MAAM,CAAC,CAAC;SACT;IACH,CAAC;CACF;AAhMD,4DAgMC"}

package/lib/destinations/destination.d.ts

@@ -0,0 +1,13 @@
+/// <reference types="node" />
+import { AirbyteConnector } from '../connector';
+import { AirbyteConfig, AirbyteConfiguredCatalog, AirbyteStateMessage } from '../protocol';
+/**
+ * Airbyte Destination
+ * https://docs.airbyte.io/understanding-airbyte/airbyte-specification#destination
+ */
+export declare abstract class AirbyteDestination<Config extends AirbyteConfig> extends AirbyteConnector {
+    /**
+     * Implement to define how the connector writes data to the destination
+     */
+    abstract write(config: Config, catalog: AirbyteConfiguredCatalog, stdin: NodeJS.ReadStream, dryRun: boolean): AsyncGenerator<AirbyteStateMessage>;
+}

package/lib/destinations/destination.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AirbyteDestination = void 0;
+const connector_1 = require("../connector");
+/**
+ * Airbyte Destination
+ * https://docs.airbyte.io/understanding-airbyte/airbyte-specification#destination
+ */
+class AirbyteDestination extends connector_1.AirbyteConnector {
+}
+exports.AirbyteDestination = AirbyteDestination;
+//# sourceMappingURL=destination.js.map

package/lib/destinations/destination.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"destination.js","sourceRoot":"","sources":["../../src/destinations/destination.ts"],"names":[],"mappings":";;;AAAA,4CAA8C;AAO9C;;;GAGG;AACH,MAAsB,kBAEpB,SAAQ,4BAAgB;CAUzB;AAZD,gDAYC"}

package/lib/errors.d.ts

@@ -0,0 +1,2 @@
+/** Strips verbose properties that libraries like Axios attach to errors */
+export declare function wrapApiError(error: Error, message?: string): Error;

package/lib/errors.js

@@ -0,0 +1,61 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.wrapApiError = void 0;
+const stream_1 = __importDefault(require("stream"));
+const verror_1 = require("verror");
+function formatMessageData(data) {
+    return data instanceof stream_1.default.Readable ? '[Stream]' : data;
+}
+function formatRequest(req) {
+    return {
+        baseUrl: req === null || req === void 0 ? void 0 : req.baseURL,
+        url: req === null || req === void 0 ? void 0 : req.url,
+        method: req === null || req === void 0 ? void 0 : req.method,
+        params: req === null || req === void 0 ? void 0 : req.params,
+    };
+}
+function formatResponse(res) {
+    return {
+        status: res.status,
+        headers: res.headers,
+        data: formatMessageData(res.data),
+    };
+}
+function isAxiosError(error) {
+    return error.isAxiosError;
+}
+/** Strips verbose properties that libraries like Axios attach to errors */
+function wrapApiError(error, message) {
+    var _a;
+    if (!isAxiosError(error)) {
+        const cause = verror_1.VError.cause(error);
+        if (cause) {
+            // Wrap the cause recursively since it could contain an Axios error
+            error = new verror_1.WError(wrapApiError(cause), error.message);
+        }
+        return message ? new verror_1.WError(error, message) : error;
+    }
+    const prefix = message ? `${message}: ` : '';
+    const res = error.response;
+    const info = {
+        req: error.request
+            ? formatRequest({ ...error.config, ...error.request })
+            : formatRequest(error.config),
+        res: res ? formatResponse(res) : undefined,
+    };
+    if (!res) {
+        return new verror_1.VError({ info }, '%sAPI request failed: %s', prefix, error.message);
+    }
+    const { data, status } = res;
+    let msg = `${prefix}API responded with status ${status}`;
+    const causeMsg = typeof data == 'string' ? data : (_a = data === null || data === void 0 ? void 0 : data.error) === null || _a === void 0 ? void 0 : _a.message;
+    if (causeMsg) {
+        msg += `: ${causeMsg}`;
+    }
+    return new verror_1.VError({ info }, msg);
+}
+exports.wrapApiError = wrapApiError;
+//# sourceMappingURL=errors.js.map

package/lib/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":";;;;;;AACA,oDAA4B;AAC5B,mCAAsC;AAEtC,SAAS,iBAAiB,CAAC,IAAS;IAClC,OAAO,IAAI,YAAY,gBAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC;AAC7D,CAAC;AAED,SAAS,aAAa,CAAC,GAAuB;IAC5C,OAAO;QACL,OAAO,EAAE,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,OAAO;QACrB,GAAG,EAAE,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,GAAG;QACb,MAAM,EAAE,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,MAAM;QACnB,MAAM,EAAE,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,MAAM;KACpB,CAAC;AACJ,CAAC;AAED,SAAS,cAAc,CAAC,GAAkB;IACxC,OAAO;QACL,MAAM,EAAE,GAAG,CAAC,MAAM;QAClB,OAAO,EAAE,GAAG,CAAC,OAAO;QACpB,IAAI,EAAE,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC;KAClC,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CAAC,KAAY;IAChC,OAAQ,KAAa,CAAC,YAAY,CAAC;AACrC,CAAC;AAED,2EAA2E;AAC3E,SAAgB,YAAY,CAAC,KAAY,EAAE,OAAgB;;IACzD,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE;QACxB,MAAM,KAAK,GAAG,eAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAClC,IAAI,KAAK,EAAE;YACT,mEAAmE;YACnE,KAAK,GAAG,IAAI,eAAM,CAAC,YAAY,CAAC,KAAK,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC;SACxD;QACD,OAAO,OAAO,CAAC,CAAC,CAAC,IAAI,eAAM,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;KACrD;IAED,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;IAC7C,MAAM,GAAG,GAAG,KAAK,CAAC,QAAQ,CAAC;IAC3B,MAAM,IAAI,GAAG;QACX,GAAG,EAAE,KAAK,CAAC,OAAO;YAChB,CAAC,CAAC,aAAa,CAAC,EAAC,GAAG,KAAK,CAAC,MAAM,EAAE,GAAG,KAAK,CAAC,OAAO,EAAC,CAAC;YACpD,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,MAAM,CAAC;QAC/B,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS;KAC3C,CAAC;IACF,IAAI,CAAC,GAAG,EAAE;QACR,OAAO,IAAI,eAAM,CACf,EAAC,IAAI,EAAC,EACN,0BAA0B,EAC1B,MAAM,EACN,KAAK,CAAC,OAAO,CACd,CAAC;KACH;IACD,MAAM,EAAC,IAAI,EAAE,MAAM,EAAC,GAAG,GAAG,CAAC;IAC3B,IAAI,GAAG,GAAG,GAAG,MAAM,6BAA6B,MAAM,EAAE,CAAC;IACzD,MAAM,QAAQ,GAAG,OAAO,IAAI,IAAI,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,KAAK,0CAAE,OAAO,CAAC;IACvE,IAAI,QAAQ,EAAE;QACZ,GAAG,IAAI,KAAK,QAAQ,EAAE,CAAC;KACxB;IACD,OAAO,IAAI,eAAM,CAAC,EAAC,IAAI,EAAC,EAAE,GAAG,CAAC,CAAC;AACjC,CAAC;AAjCD,oCAiCC"}

package/lib/help.d.ts

@@ -0,0 +1,22 @@
+import { Dictionary } from 'ts-essentials';
+export interface TableRow {
+    title: string;
+    path: string;
+    section: number;
+    children?: ReadonlyArray<number>;
+    oneOf?: boolean;
+    description?: string;
+    required: boolean;
+    constValue?: string;
+    default?: any;
+    examples: ReadonlyArray<any>;
+    airbyte_secret?: boolean;
+    multiline?: boolean;
+    type: string;
+    items_type?: string;
+    enum?: ReadonlyArray<string>;
+}
+export declare function traverseObject(startObject: Dictionary<any>, startPath: string[], section?: number, useDeprecatedFields?: boolean, useHiddenFields?: boolean): TableRow[];
+export declare function helpTable(rows: ReadonlyArray<TableRow>): string;
+export declare function buildJson(rows: ReadonlyArray<TableRow>): Promise<string>;
+export declare function buildArgs(rows: ReadonlyArray<TableRow>): Promise<string>;