saasfunnels 0.3.3 → 0.4.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/README.md CHANGED
@@ -111,3 +111,38 @@ If extraction is unsupported, `.saasfunnels/setup-review.json` lists the files a
111
111
  Discovery follows Git ignore rules (including custom build folders) while keeping tracked application sources and new, non-ignored source files. Standalone folders without Git use the standard source filters.
112
112
 
113
113
  The command does not implement arbitrary payment code, approve feature access, or verify transactions. Complete **Review and verify** in Setup after deploying the runtime and payment integration. Requires the server's guided setup API release.
114
+
115
+ ### Discovery accuracy and review
116
+
117
+ Guided setup proposes supported JavaScript/TypeScript gates and static JS/TS/JSON/YAML catalogs. Tests, fixture/demo scopes, comments, and generic role permissions are excluded. Named capabilities and numeric/unlimited limits remain separate; units, reset periods, and aggregation require review in Setup's existing Plans & pricing editor.
118
+
119
+ A frontend scan is not evidence of complete backend coverage. Setup flags unsupported application languages, unresolved dynamic access, and optional add-on/capacity/trial declarations. Review these against the actual application's entitlement owner before confirming. Imported or dynamic pricing that cannot be statically resolved needs reviewed literal `.saasfunnels/setup-pricing.json` evidence or manual configuration; source is never executed. Arbitrary helper names and external services cannot be exhaustively discovered automatically.
120
+
121
+ Feature configuration must be saved and published in Plans & pricing before Setup can confirm it. Naming an unnamed restriction records a review decision; it does not implement access. A new scanner version may require running without `--resume`; guided rescans preserve human decisions and leave local generated catalogs untouched.
122
+
123
+ ### Review prefilled configuration (Setup contract 3)
124
+
125
+ CLI 0.4.x coordinates with the guided configuration review. Run
126
+ `npx --yes saasfunnels@latest setup run` to submit proposals; workspace
127
+ administrators review and publish them in Setup. The developer key never approves
128
+ configuration or payment connections.
129
+
130
+ Supported literal pricing declarations may include `quotas` with explicit unit,
131
+ period, aggregation, and `usageSource: "customer_reported"`, plus `components`
132
+ with exact Stripe product/price IDs, included quantities and quantity sources.
133
+ Use `quantityBasis: "total"` for sources reporting all units, or `"additional"`
134
+ for sources already reporting units above the allowance. Missing semantics require
135
+ review rather than guessed defaults.
136
+
137
+ A coding agent can place reviewed declarations in `.saasfunnels/setup-pricing.json`
138
+ and question explanations in `.saasfunnels/setup-answers.json`. Explanations are
139
+ bounded `{id, fingerprint, disposition, reason}` records; disposition is
140
+ `configuration`, `not_applicable`, or `unresolved`. Configuration answers include
141
+ `configuration: [{planKey, featureKey}]` or `[{planKey, componentKey}]` referencing
142
+ corrected declarations. Required unsupported behavior must remain unresolved.
143
+ Corrected configuration belongs in the pricing
144
+ file. No source files or credentials belong in either upload.
145
+
146
+ Changes to those files or application source require a fresh run. Use `--resume`
147
+ only for unchanged interrupted work. The scan identity includes reviewed inputs
148
+ and scanner contract version, so accepted old submissions cannot hide corrections.