airbyte-faros-destination 0.0.1

package/package.json

@@ -0,0 +1,78 @@
+{
+  "name": "airbyte-faros-destination",
+  "version": "0.0.1",
+  "description": "Faros Destination for Airbyte",
+  "keywords": [
+    "airbyte",
+    "destination",
+    "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"
+  },
+  "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": {
+    "analytics-node": "^6.0.0",
+    "axios": "^0.26.0",
+    "date-format": "^4.0.6",
+    "faros-airbyte-cdk": "",
+    "faros-airbyte-common": "",
+    "faros-feeds-sdk": "^1.3.0",
+    "faros-js-client": "^0.3.1",
+    "fs-extra": "^11.1.0",
+    "git-url-parse": "^13.0.0",
+    "graphql": "^16.8.1",
+    "json-to-graphql-query": "^2.2.0",
+    "jsonata": "^1.8.5",
+    "object-sizeof": "^1.6.1",
+    "toposort": "^2.0.2",
+    "traverse": "^0.6.6",
+    "turndown": "^7.1.1",
+    "uuid": "^9.0.0",
+    "verror": "^1.10.1",
+    "zod": "^3.20.6"
+  },
+  "jest": {
+    "coverageDirectory": "out/coverage",
+    "coveragePathIgnorePatterns": [
+      "<rootDir>/node_modules/",
+      "<rootDir>/test/"
+    ],
+    "preset": "ts-jest",
+    "testEnvironment": "node",
+    "testPathIgnorePatterns": [
+      "out/"
+    ],
+    "testTimeout": 30000,
+    "globals": {
+      "ts-jest": {
+        "tsconfig": "test/tsconfig.json"
+      }
+    },
+    "snapshotFormat": {
+      "printBasicPrototype": true,
+      "escapeString": true
+    }
+  }
+}

package/resources/cloud.json

@@ -0,0 +1,73 @@
+{
+  "type": "object",
+  "title": "Cloud Edition",
+  "required": [
+    "api_key"
+  ],
+  "properties": {
+    "edition": {
+      "type": "string",
+      "title": "Cloud Edition",
+      "description": "Cloud Edition",
+      "const": "cloud"
+    },
+    "api_url": {
+      "type": "string",
+      "title": "API URL",
+      "description": "The Faros API URL.",
+      "default": "https://prod.api.faros.ai",
+      "examples": [
+        "https://prod.api.faros.ai"
+      ]
+    },
+    "api_key": {
+      "title": "API Key",
+      "type": "string",
+      "description": "The Faros API key to use to access the API.",
+      "airbyte_secret": true
+    },
+    "graph": {
+      "type": "string",
+      "title": "Graph name",
+      "description": "The Faros graph name.",
+      "default": "default"
+    },
+    "graphql_api": {
+      "type": "string",
+      "title": "GraphQL API",
+      "description": "The version of GraphQL API for writes.",
+      "default": "v2",
+      "enum": [
+        "v1",
+        "v2"
+      ]
+    },
+    "cloud_graphql_upsert_batch_size": {
+      "type": "integer",
+      "title": "GraphQL upsert batch size",
+      "description": "Maximum number of records to execute in a single GraphQL upsert.",
+      "default": 10000
+    },
+    "cloud_graphql_batch_size": {
+      "type": "integer",
+      "title": "GraphQL mutation batch size",
+      "description": "Maximum number of mutations to execute in a single request to GraphQL backend.",
+      "default": 100
+    },
+    "check_connection": {
+      "type": "boolean",
+      "title": "Check Faros API Connection",
+      "description": "Check Faros API connection on init.",
+      "default": true
+    },
+    "expiration": {
+      "type": "string",
+      "title": "Revision expiration",
+      "description": "The Faros graph revision expiration time. Only used in GraphQL API v1.",
+      "default": "5 seconds",
+      "examples": [
+        "5 seconds"
+      ]
+    }
+  }
+}

package/resources/community.json

@@ -0,0 +1,39 @@
+{
+  "type": "object",
+  "title": "Community Edition",
+  "required": [
+    "hasura_url"
+  ],
+  "properties": {
+    "edition": {
+      "type": "string",
+      "title": "Community Edition",
+      "description": "Community Edition",
+      "const": "community"
+    },
+    "hasura_admin_secret": {
+      "type": "string",
+      "title": "Hasura Admin Secret",
+      "description": "The Hasura Admin Secret.",
+      "airbyte_secret": true
+    },
+    "hasura_url": {
+      "type": "string",
+      "title": "Hasura URL",
+      "description": "The Community Edition Hasura URL.",
+      "default": "http://localhost:8080"
+    },
+    "segment_user_id": {
+      "type": "string",
+      "title": "Segment User Id",
+      "description": "The User UUID with which to track events in Segment. If not present, then reporting is disabled. See https://community.faros.ai/docs/telemetry for more details.",
+      "format": "uuid"
+    },
+    "community_graphql_batch_size": {
+      "type": "integer",
+      "title": "GraphQL mutation batch size",
+      "description": "Maximum number of mutations to execute in a single request to GraphQL backend.",
+      "default": 100
+    }
+  }
+}

package/resources/source-specific-configs/agileaccelerator.json

@@ -0,0 +1,33 @@
+{
+  "title": "AgileAccelerator",
+  "description": "Configuration options that apply to records generated by the AgileAccelerator Source.",
+  "type": "object",
+  "oneOf": [
+    {
+      "type": "object",
+      "title": "Configuration",
+      "properties": {
+        "source_type": {
+          "type": "string",
+          "const": "AgileAccelerator",
+          "order": 0
+        },
+        "max_description_length": {
+          "type": "integer",
+          "title": "Max Description Length",
+          "description": "Value to cut description to specific length",
+          "default": 1000
+        },
+        "work_additional_fields": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "title": "Work Additional Fields",
+          "description": "Fields to save to tms_Task's additionalFields variable",
+          "default": []
+        }
+      }
+    }
+  ]
+}

package/resources/source-specific-configs/azurepipeline.json

@@ -0,0 +1,27 @@
+{
+  "title": "Azure pipeline",
+  "description": "Configuration options that apply to records generated by the Azure pipeline Source.",
+  "type": "object",
+  "oneOf": [
+    {
+      "type": "object",
+      "title": "Configuration",
+      "properties": {
+        "source_type": {
+          "type": "string",
+          "const": "Azure pipeline",
+          "order": 0
+        },
+        "application_mapping": {
+          "type": "string",
+          "title": "Azure pipeline Application Mapping",
+          "description": "JSON map of Azure Pipeline service(s) name, to compute platform specific app name and platform name. Used to reference compute_Application object, from an cicd_Deployment object.",
+          "default": "{}",
+          "examples": [
+            "{ \"Aion\": { \"name\": \"aion\", \"platform\": \"ECS\" } }"
+          ]
+        }
+      }
+    }
+  ]
+}

package/resources/source-specific-configs/backlog.json

@@ -0,0 +1,24 @@
+{
+  "title": "Backlog",
+  "description": "Configuration options that apply to records generated by the Backlog Source.",
+  "type": "object",
+  "oneOf": [
+    {
+      "type": "object",
+      "title": "Configuration",
+      "properties": {
+        "source_type": {
+          "type": "string",
+          "const": "Backlog",
+          "order": 0
+        },
+        "max_description_length": {
+          "type": "integer",
+          "title": "Max Description Length",
+          "description": "Value to cut description to specific length",
+          "default": 1000
+        }
+      }
+    }
+  ]
+}

package/resources/source-specific-configs/bamboohr.json

@@ -0,0 +1,36 @@
+{
+  "title": "BambooHR",
+  "description": "Configuration options that apply to records generated by the BambooHR Source.",
+  "type": "object",
+  "oneOf": [
+    {
+      "type": "object",
+      "title": "Configuration",
+      "properties": {
+        "source_type": {
+          "type": "string",
+          "const": "BambooHR",
+          "order": 0
+        },
+        "bootstrap_teams_from_managers": {
+          "type": "boolean",
+          "title": "Bootstrap Teams From Managers",
+          "description": "Assign employees to teams based off their managers.",
+          "default": false
+        },
+        "inactive_employment_history_status": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "title": "Inactive employmentHistoryStatus",
+          "description": "Values of employmentHistoryStatus that are equivalent to an employee being inactive",
+          "example": [
+            "Terminated",
+            "On-Leave"
+          ]
+        }
+      }
+    }
+  ]
+}

package/resources/source-specific-configs/bitbucket.json

@@ -0,0 +1,28 @@
+{
+  "title": "Bitbucket",
+  "description": "Configuration options that apply to records generated by the Bitbucket Source.",
+  "type": "object",
+  "oneOf": [
+    {
+      "type": "object",
+      "title": "Configuration",
+      "properties": {
+        "source_type": {
+          "type": "string",
+          "const": "Bitbucket",
+          "order": 0
+        },
+        "application_mapping": {
+          "type": "string",
+          "title": "Application Mapping",
+          "description": "JSON map of Bitbucket service(s) name, to compute platform specific app name and platform name. Used to reference compute_Application object, from an ims_Incident object.",
+          "multiline": true,
+          "default": "{}",
+          "examples": [
+            "{ \"Aion\": { \"name\": \"aion\", \"platform\": \"ECS\" } }"
+          ]
+        }
+      }
+    }
+  ]
+}

package/resources/source-specific-configs/circleci.json

@@ -0,0 +1,24 @@
+{
+  "title": "CircleCI",
+  "description": "Configuration options that apply to records generated by the CircleCI Source.",
+  "type": "object",
+  "oneOf": [
+    {
+      "type": "object",
+      "title": "Configuration",
+      "properties": {
+        "source_type": {
+          "type": "string",
+          "const": "CircleCI",
+          "order": 0
+        },
+        "skip_writing_test_cases": {
+          "type": "boolean",
+          "title": "Skip writing test cases",
+          "description": "Disable if you require to collect detailed information about test results.",
+          "default": true
+        }
+      }
+    }
+  ]
+}

package/resources/source-specific-configs/clickup.json

@@ -0,0 +1,35 @@
+{
+  "title": "ClickUp",
+  "description": "Configuration options that apply to records generated by the ClickUp Source.",
+  "type": "object",
+  "oneOf": [
+    {
+      "type": "object",
+      "title": "Configuration",
+      "properties": {
+        "source_type": {
+          "type": "string",
+          "const": "ClickUp",
+          "order": 0
+        },
+        "taskboard_source": {
+          "type": "string",
+          "title": "TaskBoard Source",
+          "description": "ClickUp task grouping type that will be mapped to tms_TaskBoards",
+          "default": "space",
+          "enum": [
+            "space",
+            "folder",
+            "list"
+          ]
+        },
+        "truncate_limit": {
+          "type": "integer",
+          "title": "Truncate Limit",
+          "description": "Truncate the descriptions of tasks.",
+          "default": 10000
+        }
+      }
+    }
+  ]
+}

package/resources/source-specific-configs/datadog.json

@@ -0,0 +1,42 @@
+{
+  "title": "Datadog",
+  "description": "Configuration options that apply to records generated by the Datadog Source.",
+  "type": "object",
+  "oneOf": [
+    {
+      "type": "object",
+      "title": "Configuration",
+      "properties": {
+        "source_type": {
+          "type": "string",
+          "const": "Datadog",
+          "order": 0
+        },
+        "application_mapping": {
+          "type": "string",
+          "title": "Application Mapping",
+          "description": "JSON map of Datadog service(s) name, to compute platform specific app name and platform name. Used to reference compute_Application object, from an ims_Incident object.",
+          "multiline": true,
+          "default": "{}",
+          "examples": [
+            "{ \"Aion\": { \"name\": \"aion\", \"platform\": \"ECS\" } }"
+          ]
+        },
+        "default_severity": {
+          "type": "string",
+          "title": "Default Severity",
+          "description": "A default severity category if not present",
+          "pattern": "^(Sev[1-5])?(Custom)?$",
+          "examples": [
+            "Sev1",
+            "Sev2",
+            "Sev3",
+            "Sev4",
+            "Sev5",
+            "Custom"
+          ]
+        }
+      }
+    }
+  ]
+}

package/resources/source-specific-configs/docker.json

@@ -0,0 +1,40 @@
+{
+  "title": "Docker",
+  "description": "Configuration options that apply to records generated by the Docker Source.",
+  "type": "object",
+  "oneOf": [
+    {
+      "type": "object",
+      "title": "Configuration",
+      "required": [
+        "organization"
+      ],
+      "properties": {
+        "source_type": {
+          "type": "string",
+          "const": "Docker",
+          "order": 0
+        },
+        "label_prefix": {
+          "type": "string",
+          "title": "Label Prefix",
+          "description": "Label prefix used to construct build key and commit key for cicd_Artifact and cicd_ArtifactCommitAssociation from labels. Every label key start with this prefix. If the prefix is 'faros-', then the label keys will be 'faros-build-id', 'faros-pipeline-id', etc."
+        },
+        "skip_tags": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "title": "Skip tags",
+          "description": "The images with the listed tags will be ignored by the feed"
+        },
+        "organization": {
+          "type": "string",
+          "title": "Organization",
+          "description": "Organization name to associate with image tags",
+          "default": "unknown-org"
+        }
+      }
+    }
+  ]
+}

package/resources/source-specific-configs/firehydrant.json

@@ -0,0 +1,34 @@
+{
+  "title": "FireHydrant",
+  "description": "Configuration options that apply to records generated by the FireHydrant Source.",
+  "type": "object",
+  "oneOf": [
+    {
+      "type": "object",
+      "title": "Configuration",
+      "properties": {
+        "source_type": {
+          "type": "string",
+          "const": "FireHydrant",
+          "order": 0
+        },
+        "application_mapping": {
+          "type": "string",
+          "title": "Application Mapping",
+          "description": "JSON map of FireHydrant service(s) name, to compute platform specific app name and platform name. Used to reference compute_Application object, from an ims_Incident object.",
+          "multiline": true,
+          "default": "{}",
+          "examples": [
+            "{ \"Aion\": { \"name\": \"aion\", \"platform\": \"ECS\" } }"
+          ]
+        },
+        "max_description_length": {
+          "type": "integer",
+          "title": "Max Description Length",
+          "description": "Value to cut description to specific length",
+          "default": 1000
+        }
+      }
+    }
+  ]
+}

package/resources/source-specific-configs/jenkins.json

@@ -0,0 +1,24 @@
+{
+  "title": "Jenkins",
+  "description": "Configuration options that apply to records generated by the Jenkins Source.",
+  "type": "object",
+  "oneOf": [
+    {
+      "type": "object",
+      "title": "Configuration",
+      "properties": {
+        "source_type": {
+          "type": "string",
+          "const": "Jenkins",
+          "order": 0
+        },
+        "create_commit_records": {
+          "type": "boolean",
+          "title": "Create Commit Records",
+          "description": "Create vcs_Commit records from Jenkins builds",
+          "default": false
+        }
+      }
+    }
+  ]
+}

package/resources/source-specific-configs/jira.json

@@ -0,0 +1,45 @@
+{
+  "title": "Jira",
+  "description": "Configuration options that apply to records generated by the Jira Source.",
+  "type": "object",
+  "oneOf": [
+    {
+      "type": "object",
+      "title": "Configuration",
+      "properties": {
+        "source_type": {
+          "type": "string",
+          "const": "Jira",
+          "order": 0
+        },
+        "use_board_ownership": {
+          "type": "boolean",
+          "title": "Use Board Ownership",
+          "description": "Use Jira boards for assigning owners of tasks, or use projects.",
+          "default": false
+        },
+        "truncate_limit": {
+          "type": "integer",
+          "title": "Truncate Limit",
+          "description": "Truncate the descriptions of projects, tasks, and epics.",
+          "default": 10000
+        },
+        "exclude_fields": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          },
+          "title": "Exclude Fields",
+          "description": "List of fields to exclude when saving tasks. Defaults to no exclusions.",
+          "default": []
+        },
+        "additional_fields_array_limit": {
+          "type": "integer",
+          "title": "Additional Fields Array Limit",
+          "description": "Truncates an additional field's array value to the given length.",
+          "default": 50
+        }
+      }
+    }
+  ]
+}