airbyte-faros-destination 0.1.53 → 0.1.54
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -6
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
Faros Destination is a universal destination to import data from any Airbyte source into Faros.
|
|
4
4
|
|
|
5
|
-
Each source stream is handled by an appropriate [Converter](src/converters/converter.ts) implementation. Here are all the [supported sources](src/converters).
|
|
5
|
+
Each source stream is handled by an appropriate [Converter](https://github.com/faros-ai/airbyte-connectors/tree/main/destinations/faros-destination/src/converters/converter.ts) implementation. Here are all the [supported sources](https://github.com/faros-ai/airbyte-connectors/tree/main/destinations/faros-destination/src/converters).
|
|
6
6
|
|
|
7
|
-
Any additional source streams can be handled by providing a JSONata expression for the built-in [JSONataConverter](src/converters/jsonata.ts) or by implementing converters for the streams ([read more below](#adding-support-for-additional-sources)).
|
|
7
|
+
Any additional source streams can be handled by providing a JSONata expression for the built-in [JSONataConverter](https://github.com/faros-ai/airbyte-connectors/tree/main/destinations/faros-destination/src/converters/jsonata.ts) or by implementing converters for the streams ([read more below](#adding-support-for-additional-sources)).
|
|
8
8
|
|
|
9
9
|
## Usage
|
|
10
10
|
|
|
@@ -17,7 +17,7 @@ Any additional source streams can be handled by providing a JSONata expression f
|
|
|
17
17
|
5. Set the desired version `x.y.z`, e.g the latest [](https://hub.docker.com/r/farosai/airbyte-faros-destination/tags)
|
|
18
18
|
6. Click Add
|
|
19
19
|
|
|
20
|
-
More details on how to add a custom connector can be found in the official Airbyte
|
|
20
|
+
More details on how to add a custom connector can be found in the [official Airbyte guide](https://docs.airbyte.com/integrations/custom-connectors).
|
|
21
21
|
|
|
22
22
|
### Run from Terminal
|
|
23
23
|
|
|
@@ -35,11 +35,11 @@ Faros Destination is built to be easily extensible to support additional sources
|
|
|
35
35
|
For well-known sources you can simply open a PR against this repository and add any new stream converters.
|
|
36
36
|
We are always happy for you to contribute them to the community.
|
|
37
37
|
|
|
38
|
-
When developing a converter, there is a specific naming convention that must be followed to ensure that the converter is correctly picked up by the Faros Destination. The converter class name must be the PascalCase (or UpperCamelCase) version of the stream name, e.g. [PullRequestStats](src/converters/github/pull_request_stats.ts) for GitHub.
|
|
38
|
+
When developing a converter, there is a specific naming convention that must be followed to ensure that the converter is correctly picked up by the Faros Destination. The converter class name must be the PascalCase (or UpperCamelCase) version of the stream name, e.g. [PullRequestStats](https://github.com/faros-ai/airbyte-connectors/tree/main/destinations/faros-destination/src/converters/github/pull_request_stats.ts) for GitHub.
|
|
39
39
|
|
|
40
40
|
For testing, create the `all-streams.log` file and make sure that no real data is included. Also, ensure that the stream names are prefixed with the stream prefix specified in the test file. For example: `mytestsource__github__`.
|
|
41
41
|
|
|
42
|
-
We have implemented [a lot of converters](src/converters) already so you have plenty examples to follow.
|
|
42
|
+
We have implemented [a lot of converters](https://github.com/faros-ai/airbyte-connectors/tree/main/destinations/faros-destination/src/converters) already so you have plenty examples to follow.
|
|
43
43
|
|
|
44
44
|
### Custom Sources
|
|
45
45
|
|
|
@@ -135,7 +135,7 @@ Example `config.json`
|
|
|
135
135
|
"origin": "mydatasource"
|
|
136
136
|
}
|
|
137
137
|
```
|
|
138
|
-
See [spec.json](resources/spec.json) for more properties for the `config.json`
|
|
138
|
+
See [spec.json](https://github.com/faros-ai/airbyte-connectors/tree/main/destinations/faros-destination/resources/spec.json) for more properties for the `config.json`
|
|
139
139
|
|
|
140
140
|
Example `catalog.json`
|
|
141
141
|
```json
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "airbyte-faros-destination",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.54",
|
|
4
4
|
"description": "Faros Destination for Airbyte",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"airbyte",
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
"analytics-node": "^6.0.0",
|
|
37
37
|
"axios": "^0.26.0",
|
|
38
38
|
"date-format": "^4.0.3",
|
|
39
|
-
"faros-airbyte-cdk": "^0.1.
|
|
39
|
+
"faros-airbyte-cdk": "^0.1.54",
|
|
40
40
|
"faros-feeds-sdk": "^0.9.7",
|
|
41
41
|
"fs-extra": "^10.0.0",
|
|
42
42
|
"git-url-parse": "^11.6.0",
|