@apifuse/provider-sdk 2.1.0-beta.18 → 2.1.0-beta.19
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/CHANGELOG.md +4 -0
- package/README.md +3 -3
- package/SUBMISSION.md +10 -11
- package/bin/apifuse-submit-check.ts +561 -279
- package/dist/cli/create.js +10 -26
- package/dist/cli/templates/provider/README.md.tpl +6 -4
- package/package.json +1 -1
- package/src/cli/create.ts +25 -93
- package/src/cli/templates/provider/README.md.tpl +6 -4
package/CHANGELOG.md
CHANGED
package/README.md
CHANGED
|
@@ -56,7 +56,7 @@ Removed legacy runtime paths are not supported:
|
|
|
56
56
|
cd my-provider
|
|
57
57
|
bun run check
|
|
58
58
|
bun run test
|
|
59
|
-
bun run submit-check
|
|
59
|
+
bun run submit-check -- --smoke
|
|
60
60
|
bun run dev
|
|
61
61
|
```
|
|
62
62
|
|
|
@@ -245,10 +245,10 @@ be replaced before recording fixtures.
|
|
|
245
245
|
Standalone providers include a pre-submission script:
|
|
246
246
|
|
|
247
247
|
```bash
|
|
248
|
-
bun run submit-check
|
|
248
|
+
bun run submit-check -- --smoke
|
|
249
249
|
```
|
|
250
250
|
|
|
251
|
-
This runs the public review-readiness evaluator and writes `submission-report.md`. The report contains provider metadata, a 100-point readiness score, hard blockers, warnings, checklist evidence, and remediation. Blockers override the score; fix them before posting bounty evidence.
|
|
251
|
+
This runs the public review-readiness evaluator and writes `submission-report.md`. The report contains provider metadata, a 100-point readiness score, hard blockers, warnings, checklist evidence, measured smoke details, and remediation. Blockers override the score; fix them before posting bounty evidence. `--smoke` boots the local dev server, checks `/health`, and POSTs every operation fixture. Set `APIFUSE__PROVIDER__*` env vars when live upstream credentials are available; without them, structured provider errors can still earn runtime-path smoke credit. See [`SUBMISSION.md`](./SUBMISSION.md) for the full public-only bounty submission checklist shipped in the npm package.
|
|
252
252
|
|
|
253
253
|
## Scope boundary
|
|
254
254
|
|
package/SUBMISSION.md
CHANGED
|
@@ -9,11 +9,11 @@ bunx @apifuse/provider-sdk@beta create my-provider --yes
|
|
|
9
9
|
cd my-provider
|
|
10
10
|
bun run check
|
|
11
11
|
bun run test
|
|
12
|
-
bun run submit-check
|
|
12
|
+
bun run submit-check -- --smoke
|
|
13
13
|
bun run dev
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
`bun run submit-check` runs `apifuse submit-check . --markdown submission-report.md`
|
|
16
|
+
`bun run submit-check -- --smoke` runs the generated `apifuse submit-check . --markdown submission-report.md` script with measured smoke enabled.
|
|
17
17
|
|
|
18
18
|
## What submit-check scores
|
|
19
19
|
|
|
@@ -52,20 +52,19 @@ Fix all blockers before submitting:
|
|
|
52
52
|
|
|
53
53
|
Warnings do not fail the command, but they should be addressed when practical. For example, the generated starter `ping` operation warns because it is not a real upstream-backed bounty Operation. SDK-native warnings also flag moderate `as Type` assertion counts and credentialed Providers that never reference `ctx.credential`.
|
|
54
54
|
|
|
55
|
-
##
|
|
55
|
+
## Measured local smoke
|
|
56
56
|
|
|
57
|
-
`submit-check` does not call
|
|
57
|
+
`submit-check` does not call live upstream APIs by default. For smoke scoring,
|
|
58
|
+
run measured smoke so the CLI boots the Provider, checks `/health`, and POSTs
|
|
59
|
+
each operation fixture:
|
|
58
60
|
|
|
59
61
|
```bash
|
|
60
|
-
bun run
|
|
61
|
-
curl -s http://localhost:3900/health
|
|
62
|
-
curl -s -X POST http://localhost:3900/v1/<operation> \
|
|
63
|
-
-H 'Content-Type: application/json' \
|
|
64
|
-
-d '{"requestId":"req_local_smoke","input":{...},"headers":{}}'
|
|
65
|
-
|
|
66
|
-
bun run submit-check -- --smoke-note "GET /health and POST /v1/<operation> passed locally with redacted input."
|
|
62
|
+
bun run submit-check -- --smoke
|
|
67
63
|
```
|
|
68
64
|
|
|
65
|
+
`APIFUSE__PROVIDER__*` env vars enable live upstream calls. Their absence can
|
|
66
|
+
still produce 7/10 smoke credit when every operation routes and returns a
|
|
67
|
+
structured provider error envelope, but zero schema-valid successes are observed.
|
|
69
68
|
Never paste real credentials, personal data, account numbers, access tokens, cookies, or unredacted upstream responses into workspace PR comments, chat, or reports.
|
|
70
69
|
|
|
71
70
|
## Submission evidence checklist
|