Initial commit

Author: erazemk

.devrev/repo.yml

@@ -0,0 +1 @@
+deployable: true

.github/CODEOWNERS

@@ -0,0 +1 @@
+- @radovanjorgic @patricijabrecko @devrev/airdrop

.gitignore

@@ -0,0 +1,20 @@
+.DS_Store
+
+# Ignore Node.js dependencies
+node_modules/
+
+# Ignore intermediate build folders
+build.*/
+conformance_tests.backup/
+
+# Ignore temporary folders used for runnning tests
+node_build/
+node_conformance_tests/
+
+.venv/
+
+chef-cli
+
+secrets_config.yaml
+
+manual_testing/

README.md

@@ -0,0 +1,49 @@
+# DevRev Repository for Snap-In Shared Files
+
+This repository contains files that are shared between DevRev snapins. Example of related repositories:
+
+- [devrev-trello-snapin](https://github.com/devrev/airdrop-trello-snap-in)
+- [devrev-asana-snapin](https://github.com/devrev/airdrop-asana-snap-in)
+
+Files in this repository are commonly shared between the above Snap-Ins, but you have the ability to override them for specific Snap-Ins.
+
+## Folder structure
+
+This setup assumes this repository (`devrev-snapin-shared`) is cloned on the same level as the Snap-In repositories.
+
+```bash
+❯ ls
+devrev-asana-snapin devrev-snapin-shared devrev-trello-snapin
+```
+
+Make sure you have this setup locally as well.
+
+## Additional required files
+
+### chef-cli
+
+You must download locally to this folder chef-cli binary available at https://github.com/devrev/adaas-chef-cli/releases.
+
+The chef-cli must be version 0.7.1 or newer.
+
+## The Shared Files
+
+- Base folder: (`base_folder/`) - This folder represents starting point for the Snap-In. It's adjusted based on our needs from https://github.com/devrev/airdrop-template.
+- DevRev Plain Snap-In template (`devrev-snapin-template.plain`).
+- Resource files:
+    - `test_data/` - This folder represents test data JSON files, referenced in the `.plain` files.
+    - `external_domain_metadata_schema.json` - This file represents the external domain metadata schema.
+- Scripts:
+    - `run_unittests_jest.sh` - Script for running unit tests for the Snap-In.
+    - `run_devrev_snapin_conformance_tests.sh` - Script for running conformance tests for the Snap-In.
+- Auxiliary files:
+    - `jest.setup.js`, `mock_callback_server.py` - Auxiliary files for unittest and conformance test scripts.
+
+## How to Override the Shared Files for Specific Snap-Ins
+
+You have the ability to override the contents of the shared repository for your specific Snap-In. Files in the directory containting your plain source file will always have bigger preference than files from the shared folder.
+
+- `devrev-snapin-template.plain` - In the workspace of your Plain source file (e.g. `devrev-trello-snapin`), define your custom `devrev-snapin-template.plain` file.
+- Resource files: You can override the contents resources by attaching a resource file to the same location relative to your plain source file.
+  Example: If you have a resource file `test_data/data_extraction_check.json` in the shared repository, you can override it by attaching a resource file `test_data/data_extraction_check.json` to the same location relative to your plain source file.
+- Scripts and auxiliary files: You can copy+paste the script to your plain source file repository and adjust it to your needs.

base_folder/babel.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+  presets: [
+    ['@babel/preset-env', { targets: { node: 'current' } }],
+    '@babel/preset-typescript',
+  ],
+};

base_folder/jest.config.js

@@ -0,0 +1,4 @@
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+};

base_folder/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "devrev-snapin",
+  "version": "1.1.6",
+  "description": "DevRev ADaaS (Airdrop-as-a-service) Connector",
+  "main": "./dist/index.js",
+  "scripts": {
+    "lint": "eslint .",
+    "lint:fix": "eslint --fix -- .",
+    "build": "rimraf ./dist && tsc",
+    "build:watch": "tsc --watch",
+    "prepackage": "npm run build",
+    "package": "tar -cvzf build.tar.gz dist package.json package-lock.json .npmrc",
+    "start": "ts-node ./src/main.ts",
+    "start:production": "node dist/main.js",
+    "test:server": "ts-node test/main.ts",
+    "test": "jest",
+    "test:watch": "jest --watch"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@babel/core": "^7.26.10",
+    "@babel/preset-env": "^7.20.2",
+    "@babel/preset-typescript": "^7.18.6",
+    "@types/body-parser": "^1.19.5",
+    "@types/express": "^4.17.21",
+    "@types/jest": "^29.4.0",
+    "@types/node": "^18.13.0",
+    "@types/yargs": "^17.0.24",
+    "@typescript-eslint/eslint-plugin": "^8.32.0",
+    "@typescript-eslint/parser": "^8.32.0",
+    "babel-jest": "^29.4.2",
+    "body-parser": "^1.20.3",
+    "dotenv": "^16.0.3",
+    "eslint": "^9.26.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-import": "^2.28.1",
+    "eslint-plugin-prettier": "4.0.0",
+    "eslint-plugin-simple-import-sort": "^10.0.0",
+    "eslint-plugin-sort-keys-fix": "^1.1.2",
+    "eslint-plugin-unused-imports": "^4.1.4",
+    "express": "^4.21.0",
+    "jest": "^29.4.2",
+    "nodemon": "^3.0.3",
+    "prettier": "^2.8.3",
+    "prettier-plugin-organize-imports": "^3.2.2",
+    "rimraf": "^4.1.2",
+    "ts-jest": "^29.0.5",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.5",
+    "yargs": "^17.6.2"
+  },
+  "dependencies": {
+    "@devrev/ts-adaas": "1.4.2",
+    "axios": "^1.9.0",
+    "dotenv": "^16.0.3",
+    "js-jsonl": "^1.1.1",
+    "yargs": "^17.6.2"
+  }
+}

base_folder/src/function-factory.ts

@@ -0,0 +1,5 @@
+export const functionFactory = {
+  // Add your functions here
+} as const;
+
+export type FunctionFactoryType = keyof typeof functionFactory;

base_folder/src/index.ts

@@ -0,0 +1 @@
+export * from './function-factory';

base_folder/test/http_client.ts

@@ -0,0 +1,38 @@
+import axios, { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
+
+interface SetupOptions {
+  endpoint: string;
+  token?: string;
+}
+
+export interface HttpRequest {
+  headers?: any;
+  path: string;
+  body: unknown;
+}
+
+export class HTTPClient {
+  public instance: AxiosInstance;
+
+  constructor({ endpoint, token }: SetupOptions) {
+    const axiosConfig: AxiosRequestConfig = {
+      baseURL: endpoint,
+      headers: {
+        Authorization: token,
+      },
+    };
+
+    this.instance = axios.create({
+      ...axiosConfig,
+    });
+  }
+
+  async post<T>({ headers, path, body }: HttpRequest): Promise<AxiosResponse<T>> {
+    return this.instance.request({
+      method: 'POST',
+      headers: headers,
+      data: body,
+      url: path,
+    });
+  }
+}