faros-airbyte-cdk 0.0.1

package/lib/utils.d.ts

@@ -0,0 +1,13 @@
+import { AirbyteConfig, AirbyteSpec } from './protocol';
+export declare const PACKAGE_ROOT: string;
+export declare const PACKAGE_VERSION: any;
+/** Redact config of all secret values based on the provided specification */
+export declare function redactConfig(config: AirbyteConfig, spec: AirbyteSpec): string;
+/**
+ * Sets all undefined values with defaults from spec to their default value.
+ * The changes are made on a copy of the input.
+ * */
+export declare function withDefaults<Config extends AirbyteConfig>(config: Config, spec: AirbyteSpec): Config;
+/** Convert a value to Date */
+export declare function toDate(val: Date | string | number | undefined): Date | undefined;
+export declare function base64Encode(str: string): string;

package/lib/utils.js

@@ -0,0 +1,77 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.base64Encode = exports.toDate = exports.withDefaults = exports.redactConfig = exports.PACKAGE_VERSION = exports.PACKAGE_ROOT = void 0;
+const fast_redact_1 = __importDefault(require("fast-redact"));
+const fs_1 = __importDefault(require("fs"));
+const json_schema_traverse_1 = __importDefault(require("json-schema-traverse"));
+const lodash_1 = __importDefault(require("lodash"));
+const path_1 = __importDefault(require("path"));
+exports.PACKAGE_ROOT = path_1.default.join(__dirname, '..');
+const packageInfo = JSON.parse(fs_1.default.readFileSync(path_1.default.join(exports.PACKAGE_ROOT, 'package.json'), 'utf8'));
+exports.PACKAGE_VERSION = packageInfo.version;
+/** Redact config of all secret values based on the provided specification */
+function redactConfig(config, spec) {
+    var _a;
+    const paths = [];
+    (0, json_schema_traverse_1.default)((_a = spec.spec.connectionSpecification) !== null && _a !== void 0 ? _a : {}, {
+        cb: (schema, pointer) => {
+            if (schema.airbyte_secret) {
+                paths.push(toPath(pointer));
+            }
+        },
+    });
+    const redact = (0, fast_redact_1.default)({ paths, censor: 'REDACTED' });
+    return `${redact(config)}`;
+}
+exports.redactConfig = redactConfig;
+function toPath(pointer) {
+    return pointer
+        .replace(/\/oneOf\/\d+/g, '')
+        .replace(/\/items(\/?)/g, '[*]$1')
+        .split('/properties/')
+        .filter((s) => s)
+        .join('.');
+}
+/**
+ * Sets all undefined values with defaults from spec to their default value.
+ * The changes are made on a copy of the input.
+ * */
+function withDefaults(config, spec) {
+    var _a;
+    const defaultsByPath = new Map();
+    (0, json_schema_traverse_1.default)((_a = spec.spec.connectionSpecification) !== null && _a !== void 0 ? _a : {}, {
+        cb: (schema, pointer) => {
+            if (schema.default) {
+                defaultsByPath.set(toPath(pointer), schema.default);
+            }
+        },
+    });
+    // create a copy of input and apply defaults
+    const result = lodash_1.default.cloneDeep(config);
+    for (const [path, defaultValue] of defaultsByPath) {
+        if (lodash_1.default.get(result, path) === undefined) {
+            lodash_1.default.set(result, path, defaultValue);
+        }
+    }
+    return result;
+}
+exports.withDefaults = withDefaults;
+/** Convert a value to Date */
+function toDate(val) {
+    if (typeof val === 'number') {
+        return new Date(val);
+    }
+    if (!val) {
+        return undefined;
+    }
+    return new Date(val);
+}
+exports.toDate = toDate;
+function base64Encode(str) {
+    return Buffer.from(str, 'binary').toString('base64');
+}
+exports.base64Encode = base64Encode;
+//# sourceMappingURL=utils.js.map

package/lib/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":";;;;;;AAAA,8DAAqC;AACrC,4CAAoB;AACpB,gFAA4C;AAC5C,oDAAuB;AACvB,gDAAwB;AAIX,QAAA,YAAY,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;AAEvD,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAC5B,YAAE,CAAC,YAAY,CAAC,cAAI,CAAC,IAAI,CAAC,oBAAY,EAAE,cAAc,CAAC,EAAE,MAAM,CAAC,CACjE,CAAC;AAEW,QAAA,eAAe,GAAG,WAAW,CAAC,OAAO,CAAC;AAEnD,6EAA6E;AAC7E,SAAgB,YAAY,CAAC,MAAqB,EAAE,IAAiB;;IACnE,MAAM,KAAK,GAAG,EAAE,CAAC;IACjB,IAAA,8BAAQ,EAAC,MAAA,IAAI,CAAC,IAAI,CAAC,uBAAuB,mCAAI,EAAE,EAAE;QAChD,EAAE,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE;YACtB,IAAI,MAAM,CAAC,cAAc,EAAE;gBACzB,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;aAC7B;QACH,CAAC;KACF,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,IAAA,qBAAU,EAAC,EAAC,KAAK,EAAE,MAAM,EAAE,UAAU,EAAC,CAAC,CAAC;IACvD,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;AAC7B,CAAC;AAXD,oCAWC;AAED,SAAS,MAAM,CAAC,OAAe;IAC7B,OAAO,OAAO;SACX,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC;SAC5B,OAAO,CAAC,eAAe,EAAE,OAAO,CAAC;SACjC,KAAK,CAAC,cAAc,CAAC;SACrB,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;SAChB,IAAI,CAAC,GAAG,CAAC,CAAC;AACf,CAAC;AAED;;;KAGK;AACL,SAAgB,YAAY,CAC1B,MAAc,EACd,IAAiB;;IAEjB,MAAM,cAAc,GAAG,IAAI,GAAG,EAAe,CAAC;IAC9C,IAAA,8BAAQ,EAAC,MAAA,IAAI,CAAC,IAAI,CAAC,uBAAuB,mCAAI,EAAE,EAAE;QAChD,EAAE,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE;YACtB,IAAI,MAAM,CAAC,OAAO,EAAE;gBAClB,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;aACrD;QACH,CAAC;KACF,CAAC,CAAC;IACH,4CAA4C;IAC5C,MAAM,MAAM,GAAG,gBAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IACnC,KAAK,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,IAAI,cAAc,EAAE;QACjD,IAAI,gBAAC,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,SAAS,EAAE;YACrC,gBAAC,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,EAAE,YAAY,CAAC,CAAC;SACnC;KACF;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AApBD,oCAoBC;AAED,8BAA8B;AAC9B,SAAgB,MAAM,CACpB,GAAuC;IAEvC,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;QAC3B,OAAO,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC;KACtB;IACD,IAAI,CAAC,GAAG,EAAE;QACR,OAAO,SAAS,CAAC;KAClB;IACD,OAAO,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC;AACvB,CAAC;AAVD,wBAUC;AAED,SAAgB,YAAY,CAAC,GAAW;IACtC,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AACvD,CAAC;AAFD,oCAEC"}

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "faros-airbyte-cdk",
+  "version": "0.0.1",
+  "description": "Airbyte Connector Development Kit (CDK) for JavaScript/TypeScript",
+  "keywords": [
+    "airbyte",
+    "cdk",
+    "faros"
+  ],
+  "homepage": "https://www.faros.ai",
+  "author": "Faros AI, Inc.",
+  "license": "Apache-2.0",
+  "repository": "https://github.com/faros-ai/airbyte-connectors",
+  "bugs": {
+    "url": "https://github.com/faros-ai/airbyte-connectors/issues"
+  },
+  "directories": {
+    "lib": "lib",
+    "test": "test"
+  },
+  "files": [
+    "lib/",
+    "resources/"
+  ],
+  "main": "./lib",
+  "engines": {
+    "node": ">=16"
+  },
+  "scripts": {
+    "build": "tsc -p src",
+    "clean": "rm -rf lib node_modules out",
+    "fix": "prettier --write 'src/**/*.ts' 'test/**/*.ts' && npm run lint -- --fix",
+    "lint": "eslint 'src/**/*.ts' 'test/**/*.ts'",
+    "prepare": "npm run build",
+    "test": "jest --verbose --color",
+    "test-cov": "jest --coverage --verbose --color",
+    "watch": "tsc -b -w src test"
+  },
+  "dependencies": {
+    "@apidevtools/json-schema-ref-parser": "^9.0.9",
+    "commander": "^9.3.0",
+    "enquirer": "^2.3.6",
+    "fast-redact": "^3.0.2",
+    "json-schema-traverse": "^1.0.0",
+    "lodash": "^4.17.21",
+    "pino": "^8.5.0",
+    "table": "^6.8.1",
+    "verror": "^1.10.1"
+  },
+  "jest": {
+    "coverageDirectory": "out/coverage",
+    "coveragePathIgnorePatterns": [
+      "<rootDir>/node_modules/",
+      "<rootDir>/test/"
+    ],
+    "preset": "ts-jest",
+    "testEnvironment": "node",
+    "testTimeout": 10000,
+    "globals": {
+      "ts-jest": {
+        "tsconfig": "test/tsconfig.json"
+      }
+    },
+    "snapshotFormat": {
+      "printBasicPrototype": true,
+      "escapeString": true
+    }
+  }
+}