@jackchuka/gql-ingest 1.3.0 → 1.5.0
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/LICENSE +21 -0
- package/README.md +24 -0
- package/bin/cli.js +213 -35
- package/dist/dependency-resolver.d.ts +2 -1
- package/dist/dependency-resolver.d.ts.map +1 -1
- package/dist/mapper.d.ts +4 -1
- package/dist/mapper.d.ts.map +1 -1
- package/dist/metrics.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/cli.ts +43 -7
- package/src/dependency-resolver.test.ts +15 -1
- package/src/dependency-resolver.ts +6 -2
- package/src/mapper.test.ts +221 -0
- package/src/mapper.ts +174 -13
- package/src/metrics.ts +18 -10
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 jackchuka
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -47,6 +47,7 @@ Options:
|
|
|
47
47
|
-V, --version output the version number
|
|
48
48
|
-e, --endpoint <url> GraphQL endpoint URL (required)
|
|
49
49
|
-c, --config <path> Path to configuration directory (required)
|
|
50
|
+
-n, --entities <list> Comma-separated list of specific entities to process
|
|
50
51
|
-h, --headers <headers> JSON string of headers to include in requests
|
|
51
52
|
--help display help for command
|
|
52
53
|
```
|
|
@@ -70,6 +71,18 @@ npx @jackchuka/gql-ingest \
|
|
|
70
71
|
--endpoint https://api.example.com/graphql \
|
|
71
72
|
--config ./my-config \
|
|
72
73
|
--headers '{"X-API-Key": "your-api-key", "Content-Type": "application/json"}'
|
|
74
|
+
|
|
75
|
+
# Process specific entities only
|
|
76
|
+
npx @jackchuka/gql-ingest \
|
|
77
|
+
--endpoint https://your-graphql-api.com/graphql \
|
|
78
|
+
--config ./examples/demo \
|
|
79
|
+
--entities users,products
|
|
80
|
+
|
|
81
|
+
# Process a single entity
|
|
82
|
+
npx @jackchuka/gql-ingest \
|
|
83
|
+
--endpoint https://your-graphql-api.com/graphql \
|
|
84
|
+
--config ./examples/demo \
|
|
85
|
+
--entities items
|
|
73
86
|
```
|
|
74
87
|
|
|
75
88
|
## Parallel Processing 🚀
|
|
@@ -143,6 +156,17 @@ entityConfig:
|
|
|
143
156
|
|
|
144
157
|
**Reliability Impact**: Retry capabilities can improve success rates from 95% to 99.9%+ for APIs with transient failures.
|
|
145
158
|
|
|
159
|
+
## Selective Entity Processing
|
|
160
|
+
|
|
161
|
+
The `--entities` flag allows you to process specific entities instead of all discovered mappings:
|
|
162
|
+
|
|
163
|
+
- Process multiple entities: `--entities users,products,orders`
|
|
164
|
+
- Process a single entity: `--entities items`
|
|
165
|
+
- Entities are processed in dependency order automatically
|
|
166
|
+
- Missing dependencies will trigger a warning but not prevent execution
|
|
167
|
+
|
|
168
|
+
**Note**: When using `--entities` with entity dependencies defined in `config.yaml`, the tool will warn you about any missing dependencies but will still attempt to process the selected entities. Ensure dependent data exists in your GraphQL API before processing entities with unmet dependencies.
|
|
169
|
+
|
|
146
170
|
## Configuration
|
|
147
171
|
|
|
148
172
|
The `--config` flag points to a configuration directory containing three subdirectories:
|