atmn 2.0.16 → 2.0.17
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/dist/bin.js +120 -87
- package/dist/index.js +19 -72
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +2 -2
- package/src/actions/pull/pruneUnpulledPlanIds.ts +99 -0
- package/src/actions/pull.ts +25 -1
- package/src/generated/emit.ts +0 -3
- package/src/generated/lintRules.ts +12 -72
- package/src/generated/lintRuntime.ts +9 -0
- package/src/generated/plans.ts +0 -4
- package/src/generated/skills.ts +9 -9
- package/src/generated/variants.ts +0 -2
package/dist/bin.js
CHANGED
|
@@ -3747,6 +3747,7 @@ var LINT_RULES = {
|
|
|
3747
3747
|
label: "feature",
|
|
3748
3748
|
idField: "featureId",
|
|
3749
3749
|
required: ["featureId", "name", "type"],
|
|
3750
|
+
hidden: ["display", "newFeatureId"],
|
|
3750
3751
|
fields: {
|
|
3751
3752
|
type: {
|
|
3752
3753
|
enum: ["boolean", "metered", "credit_system", "ai_credit_system"]
|
|
@@ -3892,9 +3893,6 @@ var LINT_RULES = {
|
|
|
3892
3893
|
}
|
|
3893
3894
|
}
|
|
3894
3895
|
},
|
|
3895
|
-
"features.display": {
|
|
3896
|
-
required: ["plural", "singular"]
|
|
3897
|
-
},
|
|
3898
3896
|
"features.modelMarkups": {
|
|
3899
3897
|
keys: {
|
|
3900
3898
|
pattern: ".+\\/.+"
|
|
@@ -3925,39 +3923,30 @@ var LINT_RULES = {
|
|
|
3925
3923
|
label: "plan",
|
|
3926
3924
|
idField: "planId",
|
|
3927
3925
|
required: ["planId", "versionSlug"],
|
|
3926
|
+
hidden: [
|
|
3927
|
+
"baseVariantId",
|
|
3928
|
+
"isDefault",
|
|
3929
|
+
"migration",
|
|
3930
|
+
"newPlanId",
|
|
3931
|
+
"newVersionSlug",
|
|
3932
|
+
"propagate",
|
|
3933
|
+
"version",
|
|
3934
|
+
"versioning"
|
|
3935
|
+
],
|
|
3928
3936
|
fields: {
|
|
3929
3937
|
planId: {
|
|
3930
3938
|
minLength: 1,
|
|
3931
3939
|
pattern: "^[a-zA-Z0-9_-]+$"
|
|
3932
3940
|
},
|
|
3933
|
-
newPlanId: {
|
|
3934
|
-
minLength: 1,
|
|
3935
|
-
pattern: "^[a-zA-Z0-9_-]+$"
|
|
3936
|
-
},
|
|
3937
3941
|
internalId: {
|
|
3938
3942
|
minLength: 1
|
|
3939
3943
|
},
|
|
3940
3944
|
name: {
|
|
3941
3945
|
minLength: 1
|
|
3942
3946
|
},
|
|
3943
|
-
version: {
|
|
3944
|
-
minimum: 1,
|
|
3945
|
-
maximum: 9007199254740991
|
|
3946
|
-
},
|
|
3947
3947
|
versionSlug: {
|
|
3948
3948
|
minLength: 1,
|
|
3949
3949
|
pattern: "^[a-zA-Z0-9_-]+$"
|
|
3950
|
-
},
|
|
3951
|
-
newVersionSlug: {
|
|
3952
|
-
minLength: 1,
|
|
3953
|
-
pattern: "^[a-zA-Z0-9_-]+$"
|
|
3954
|
-
},
|
|
3955
|
-
versioning: {
|
|
3956
|
-
enum: ["existing", "new_version", "all_versions"]
|
|
3957
|
-
},
|
|
3958
|
-
baseVariantId: {
|
|
3959
|
-
minLength: 1,
|
|
3960
|
-
pattern: "^[a-zA-Z0-9_-]+$"
|
|
3961
3950
|
}
|
|
3962
3951
|
},
|
|
3963
3952
|
rules: [
|
|
@@ -4709,52 +4698,11 @@ var LINT_RULES = {
|
|
|
4709
4698
|
"plans.processors.stripe": {
|
|
4710
4699
|
required: ["productId"]
|
|
4711
4700
|
},
|
|
4712
|
-
"plans.propagate.licenseParents": {
|
|
4713
|
-
required: ["planId"],
|
|
4714
|
-
fields: {
|
|
4715
|
-
planId: {
|
|
4716
|
-
minLength: 1,
|
|
4717
|
-
pattern: "^[a-zA-Z0-9_-]+$"
|
|
4718
|
-
},
|
|
4719
|
-
version: {
|
|
4720
|
-
minimum: 1,
|
|
4721
|
-
maximum: 9007199254740991
|
|
4722
|
-
},
|
|
4723
|
-
versionSlug: {
|
|
4724
|
-
minLength: 1,
|
|
4725
|
-
pattern: "^[a-zA-Z0-9_-]+$"
|
|
4726
|
-
},
|
|
4727
|
-
newVersionSlug: {
|
|
4728
|
-
minLength: 1,
|
|
4729
|
-
pattern: "^[a-zA-Z0-9_-]+$"
|
|
4730
|
-
}
|
|
4731
|
-
}
|
|
4732
|
-
},
|
|
4733
|
-
"plans.propagate.variants": {
|
|
4734
|
-
required: ["planId"],
|
|
4735
|
-
fields: {
|
|
4736
|
-
planId: {
|
|
4737
|
-
minLength: 1,
|
|
4738
|
-
pattern: "^[a-zA-Z0-9_-]+$"
|
|
4739
|
-
},
|
|
4740
|
-
version: {
|
|
4741
|
-
minimum: 1,
|
|
4742
|
-
maximum: 9007199254740991
|
|
4743
|
-
},
|
|
4744
|
-
versionSlug: {
|
|
4745
|
-
minLength: 1,
|
|
4746
|
-
pattern: "^[a-zA-Z0-9_-]+$"
|
|
4747
|
-
},
|
|
4748
|
-
newVersionSlug: {
|
|
4749
|
-
minLength: 1,
|
|
4750
|
-
pattern: "^[a-zA-Z0-9_-]+$"
|
|
4751
|
-
}
|
|
4752
|
-
}
|
|
4753
|
-
},
|
|
4754
4701
|
"plans.variants": {
|
|
4755
4702
|
label: "variant",
|
|
4756
4703
|
idField: "variantPlanId",
|
|
4757
4704
|
required: ["variantPlanId", "versionSlug"],
|
|
4705
|
+
hidden: ["baseVariantId", "newPlanId"],
|
|
4758
4706
|
fields: {
|
|
4759
4707
|
variantPlanId: {
|
|
4760
4708
|
minLength: 1,
|
|
@@ -4774,17 +4722,9 @@ var LINT_RULES = {
|
|
|
4774
4722
|
name: {
|
|
4775
4723
|
minLength: 1
|
|
4776
4724
|
},
|
|
4777
|
-
newPlanId: {
|
|
4778
|
-
minLength: 1,
|
|
4779
|
-
pattern: "^[a-zA-Z0-9_-]+$"
|
|
4780
|
-
},
|
|
4781
4725
|
newVersionSlug: {
|
|
4782
4726
|
minLength: 1,
|
|
4783
4727
|
pattern: "^[a-zA-Z0-9_-]+$"
|
|
4784
|
-
},
|
|
4785
|
-
baseVariantId: {
|
|
4786
|
-
minLength: 1,
|
|
4787
|
-
pattern: "^[a-zA-Z0-9_-]+$"
|
|
4788
4728
|
}
|
|
4789
4729
|
}
|
|
4790
4730
|
},
|
|
@@ -6044,6 +5984,13 @@ var checkShape = ({
|
|
|
6044
5984
|
if (entry[field] === undefined)
|
|
6045
5985
|
issues.push({ path: at, message: `${field} is required.` });
|
|
6046
5986
|
}
|
|
5987
|
+
for (const field of shape.hidden ?? []) {
|
|
5988
|
+
if (entry[field] !== undefined)
|
|
5989
|
+
issues.push({
|
|
5990
|
+
path: at,
|
|
5991
|
+
message: `${field} is not a config field. Remove it.`
|
|
5992
|
+
});
|
|
5993
|
+
}
|
|
6047
5994
|
for (const [field, constraints] of Object.entries(shape.fields ?? {})) {
|
|
6048
5995
|
if (entry[field] === undefined)
|
|
6049
5996
|
continue;
|
|
@@ -6838,7 +6785,7 @@ var createClient = (options) => ({
|
|
|
6838
6785
|
});
|
|
6839
6786
|
|
|
6840
6787
|
// src/version.ts
|
|
6841
|
-
var version = "2.0.
|
|
6788
|
+
var version = "2.0.17";
|
|
6842
6789
|
|
|
6843
6790
|
// src/http/autumnFetch.ts
|
|
6844
6791
|
var runtime = typeof Bun !== "undefined" ? `bun ${Bun.version}` : `node ${process.versions.node}`;
|
|
@@ -7880,8 +7827,7 @@ var COLLECTIONS = {
|
|
|
7880
7827
|
"versionSlug",
|
|
7881
7828
|
"createInStripe",
|
|
7882
7829
|
"variants",
|
|
7883
|
-
"licenses"
|
|
7884
|
-
"baseVariantId"
|
|
7830
|
+
"licenses"
|
|
7885
7831
|
],
|
|
7886
7832
|
required: [
|
|
7887
7833
|
"active",
|
|
@@ -8086,7 +8032,6 @@ var COLLECTIONS = {
|
|
|
8086
8032
|
"addOn",
|
|
8087
8033
|
"archived",
|
|
8088
8034
|
"autoEnable",
|
|
8089
|
-
"baseVariantId",
|
|
8090
8035
|
"billingControls",
|
|
8091
8036
|
"billingControls.autoTopups",
|
|
8092
8037
|
"billingControls.autoTopups.enabled",
|
|
@@ -8326,7 +8271,6 @@ var COLLECTIONS = {
|
|
|
8326
8271
|
"processors.stripe.productId",
|
|
8327
8272
|
"variants",
|
|
8328
8273
|
"variants.archived",
|
|
8329
|
-
"variants.baseVariantId",
|
|
8330
8274
|
"variants.customize",
|
|
8331
8275
|
"variants.customize.addItems",
|
|
8332
8276
|
"variants.customize.addItems.entityFeatureId",
|
|
@@ -9085,16 +9029,16 @@ import { dirname as dirname4, join as join7 } from "node:path";
|
|
|
9085
9029
|
import chalk3 from "chalk";
|
|
9086
9030
|
|
|
9087
9031
|
// src/generated/skills.ts
|
|
9088
|
-
var SKILLS_VERSION = "2.0.
|
|
9032
|
+
var SKILLS_VERSION = "2.0.17";
|
|
9089
9033
|
var SKILLS = [
|
|
9090
9034
|
{
|
|
9091
9035
|
name: "autumn-setup",
|
|
9092
9036
|
description: "First-time Autumn setup — install the atmn CLI, connect to an org (sign in, or keyless with no account), turn the user's pricing into autumn.config.ts, and push it to a sandbox org. Use when the user is new to Autumn, pastes an Autumn setup prompt, or asks to set up Autumn, add billing, monetization, subscriptions, usage-based billing, pricing, or plans. If Autumn is already set up, use autumn-catalog instead.",
|
|
9093
|
-
version: "2.0.
|
|
9037
|
+
version: "2.0.17",
|
|
9094
9038
|
markdown: `---
|
|
9095
9039
|
name: autumn-setup
|
|
9096
9040
|
description: First-time Autumn setup — install the atmn CLI, connect to an org (sign in, or keyless with no account), turn the user's pricing into autumn.config.ts, and push it to a sandbox org. Use when the user is new to Autumn, pastes an Autumn setup prompt, or asks to set up Autumn, add billing, monetization, subscriptions, usage-based billing, pricing, or plans. If Autumn is already set up, use autumn-catalog instead.
|
|
9097
|
-
version: 2.0.
|
|
9041
|
+
version: 2.0.17
|
|
9098
9042
|
---
|
|
9099
9043
|
|
|
9100
9044
|
# Setup
|
|
@@ -9252,11 +9196,11 @@ Then stop. Don't keep building, don't tour the dashboard, don't deploy anything.
|
|
|
9252
9196
|
{
|
|
9253
9197
|
name: "autumn-catalog",
|
|
9254
9198
|
description: "Modeling a user's pricing into an Autumn catalog — deciding the structure (plans, variants, add-ons, licenses, credit systems, pooled balances) before writing config, then filling in the numbers. Use when the user describes their pricing or asks to model, change, or push a catalog.",
|
|
9255
|
-
version: "2.0.
|
|
9199
|
+
version: "2.0.17",
|
|
9256
9200
|
markdown: `---
|
|
9257
9201
|
name: autumn-catalog
|
|
9258
9202
|
description: Modeling a user's pricing into an Autumn catalog — deciding the structure (plans, variants, add-ons, licenses, credit systems, pooled balances) before writing config, then filling in the numbers. Use when the user describes their pricing or asks to model, change, or push a catalog.
|
|
9259
|
-
version: 2.0.
|
|
9203
|
+
version: 2.0.17
|
|
9260
9204
|
---
|
|
9261
9205
|
|
|
9262
9206
|
# Catalog
|
|
@@ -13138,11 +13082,11 @@ Pitch: "Pro $20/mo or $200/yr — 1,000 messages per month either way."
|
|
|
13138
13082
|
{
|
|
13139
13083
|
name: "autumn-integrate",
|
|
13140
13084
|
description: "Integrating Autumn into an app's backend — creating customers, billing flows (attach, checkout, upgrade, cancel), gating features with check, recording usage with track, and exposing billing data to the frontend. Use when the user asks to integrate Autumn, add billing/payments to their app, gate features, meter usage, or build checkout/upgrade flows. Requires a pushed catalog; use autumn-catalog first if plans don't exist yet.",
|
|
13141
|
-
version: "2.0.
|
|
13085
|
+
version: "2.0.17",
|
|
13142
13086
|
markdown: `---
|
|
13143
13087
|
name: autumn-integrate
|
|
13144
13088
|
description: Integrating Autumn into an app's backend — creating customers, billing flows (attach, checkout, upgrade, cancel), gating features with check, recording usage with track, and exposing billing data to the frontend. Use when the user asks to integrate Autumn, add billing/payments to their app, gate features, meter usage, or build checkout/upgrade flows. Requires a pushed catalog; use autumn-catalog first if plans don't exist yet.
|
|
13145
|
-
version: 2.0.
|
|
13089
|
+
version: 2.0.17
|
|
13146
13090
|
---
|
|
13147
13091
|
|
|
13148
13092
|
# Integrate
|
|
@@ -17740,11 +17684,11 @@ Monitor your logs for this message. If you see it, check [status.useautumn.com](
|
|
|
17740
17684
|
{
|
|
17741
17685
|
name: "autumn-concepts",
|
|
17742
17686
|
description: "Understanding Autumn's billing objects before acting on them — what a plan version is and what active means, when a trial starts or ends billing, how entity- and seat-scoped subscriptions differ from the customer's own, what a customize diff actually changes, and how caps, overage, and top-ups behave. Load before versioning, editing, or drafting a plan, or when a customer's state does not match the plain reading of their plan.",
|
|
17743
|
-
version: "2.0.
|
|
17687
|
+
version: "2.0.17",
|
|
17744
17688
|
markdown: `---
|
|
17745
17689
|
name: autumn-concepts
|
|
17746
17690
|
description: Understanding Autumn's billing objects before acting on them — what a plan version is and what active means, when a trial starts or ends billing, how entity- and seat-scoped subscriptions differ from the customer's own, what a customize diff actually changes, and how caps, overage, and top-ups behave. Load before versioning, editing, or drafting a plan, or when a customer's state does not match the plain reading of their plan.
|
|
17747
|
-
version: 2.0.
|
|
17691
|
+
version: 2.0.17
|
|
17748
17692
|
---
|
|
17749
17693
|
|
|
17750
17694
|
# Concepts
|
|
@@ -21741,6 +21685,78 @@ var applySettingsPreview = ({
|
|
|
21741
21685
|
return result;
|
|
21742
21686
|
};
|
|
21743
21687
|
|
|
21688
|
+
// src/actions/pull/pruneUnpulledPlanIds.ts
|
|
21689
|
+
var isRecord2 = (value) => value !== null && typeof value === "object" && !Array.isArray(value);
|
|
21690
|
+
var pulledPlanIds = ({
|
|
21691
|
+
plans
|
|
21692
|
+
}) => {
|
|
21693
|
+
const ids = new Set;
|
|
21694
|
+
for (const row of plans) {
|
|
21695
|
+
if (row.archived === true)
|
|
21696
|
+
continue;
|
|
21697
|
+
if (typeof row.id === "string")
|
|
21698
|
+
ids.add(row.id);
|
|
21699
|
+
if (!Array.isArray(row.variants))
|
|
21700
|
+
continue;
|
|
21701
|
+
for (const edge of row.variants) {
|
|
21702
|
+
if (isRecord2(edge) && typeof edge.variantPlanId === "string")
|
|
21703
|
+
ids.add(edge.variantPlanId);
|
|
21704
|
+
}
|
|
21705
|
+
}
|
|
21706
|
+
return ids;
|
|
21707
|
+
};
|
|
21708
|
+
var prunePlanIds = ({
|
|
21709
|
+
body,
|
|
21710
|
+
pulled
|
|
21711
|
+
}) => {
|
|
21712
|
+
if (!Array.isArray(body.planIds))
|
|
21713
|
+
return { body, dropped: [] };
|
|
21714
|
+
const dropped = body.planIds.filter((id) => typeof id === "string" && !pulled.has(id));
|
|
21715
|
+
if (dropped.length === 0)
|
|
21716
|
+
return { body, dropped };
|
|
21717
|
+
return {
|
|
21718
|
+
body: {
|
|
21719
|
+
...body,
|
|
21720
|
+
planIds: body.planIds.filter((id) => !dropped.includes(id))
|
|
21721
|
+
},
|
|
21722
|
+
dropped
|
|
21723
|
+
};
|
|
21724
|
+
};
|
|
21725
|
+
var show2 = (value) => JSON.stringify(value);
|
|
21726
|
+
var pruneUnpulledPlanIds = ({
|
|
21727
|
+
rows,
|
|
21728
|
+
pulled,
|
|
21729
|
+
kind
|
|
21730
|
+
}) => {
|
|
21731
|
+
const lines = [];
|
|
21732
|
+
const say = ({
|
|
21733
|
+
label,
|
|
21734
|
+
id,
|
|
21735
|
+
dropped
|
|
21736
|
+
}) => {
|
|
21737
|
+
const plans = dropped.length === 1 ? "plan" : "plans";
|
|
21738
|
+
lines.push(`↳ ${label} ${show2(String(id))} no longer names ${plans} ${dropped.map(show2).join(", ")}: not in the catalog (archived), so not in the config`);
|
|
21739
|
+
};
|
|
21740
|
+
return {
|
|
21741
|
+
lines,
|
|
21742
|
+
rows: rows.map((row) => {
|
|
21743
|
+
if (kind === "referralPrograms") {
|
|
21744
|
+
const { body: body2, dropped: dropped2 } = prunePlanIds({ body: row, pulled });
|
|
21745
|
+
if (dropped2.length > 0)
|
|
21746
|
+
say({ label: "referral program", id: row.id, dropped: dropped2 });
|
|
21747
|
+
return body2;
|
|
21748
|
+
}
|
|
21749
|
+
if (!isRecord2(row.coupon))
|
|
21750
|
+
return row;
|
|
21751
|
+
const { body, dropped } = prunePlanIds({ body: row.coupon, pulled });
|
|
21752
|
+
if (dropped.length === 0)
|
|
21753
|
+
return row;
|
|
21754
|
+
say({ label: "coupon", id: row.coupon.id, dropped });
|
|
21755
|
+
return { ...row, coupon: body };
|
|
21756
|
+
})
|
|
21757
|
+
};
|
|
21758
|
+
};
|
|
21759
|
+
|
|
21744
21760
|
// src/actions/pull/rewriteConfig.ts
|
|
21745
21761
|
import { existsSync as existsSync11, readFileSync as readFileSync11, writeFileSync as writeFileSync7 } from "node:fs";
|
|
21746
21762
|
import { dirname as dirname9, join as join12 } from "node:path";
|
|
@@ -23047,6 +23063,22 @@ var runPull = async ({
|
|
|
23047
23063
|
const previewRows = preview;
|
|
23048
23064
|
const catalogRows = catalog;
|
|
23049
23065
|
const featureTypes = featureTypesOf({ rows: rowsOf(catalogRows.features) });
|
|
23066
|
+
const pulled = pulledPlanIds({ plans: rowsOf(catalogRows.plans) });
|
|
23067
|
+
const rewards = pruneUnpulledPlanIds({
|
|
23068
|
+
rows: rowsOf(catalogRows.rewards),
|
|
23069
|
+
pulled,
|
|
23070
|
+
kind: "rewards"
|
|
23071
|
+
});
|
|
23072
|
+
const referralPrograms = pruneUnpulledPlanIds({
|
|
23073
|
+
rows: rowsOf(catalogRows.referralPrograms),
|
|
23074
|
+
pulled,
|
|
23075
|
+
kind: "referralPrograms"
|
|
23076
|
+
});
|
|
23077
|
+
const pulledRows = {
|
|
23078
|
+
...catalogRows,
|
|
23079
|
+
rewards: rewards.rows,
|
|
23080
|
+
referralPrograms: referralPrograms.rows
|
|
23081
|
+
};
|
|
23050
23082
|
const nestedBuilders = Object.fromEntries(Object.values(NESTED_FIXTURES).map(({ path, builder }) => [path, builder]));
|
|
23051
23083
|
for (const [collection, spec] of Object.entries(COLLECTIONS)) {
|
|
23052
23084
|
if (!spec.pull)
|
|
@@ -23055,7 +23087,7 @@ var runPull = async ({
|
|
|
23055
23087
|
collection,
|
|
23056
23088
|
spec,
|
|
23057
23089
|
entries: entriesOf(previewRows[collection]),
|
|
23058
|
-
catalogRows: withVariantIdentity(rowsOf(
|
|
23090
|
+
catalogRows: withVariantIdentity(rowsOf(pulledRows[collection])),
|
|
23059
23091
|
configPath,
|
|
23060
23092
|
files,
|
|
23061
23093
|
includeMappings,
|
|
@@ -23098,6 +23130,7 @@ var runPull = async ({
|
|
|
23098
23130
|
lines.push(`↳ wrote processor mappings into ${id}`);
|
|
23099
23131
|
}
|
|
23100
23132
|
}
|
|
23133
|
+
lines.push(...rewards.lines, ...referralPrograms.lines);
|
|
23101
23134
|
if (unlocated.length > 0)
|
|
23102
23135
|
throw new UnlocatableFixturesError({ unlocated });
|
|
23103
23136
|
for (const [file, source] of files) {
|
package/dist/index.js
CHANGED
|
@@ -22,6 +22,7 @@ var LINT_RULES = {
|
|
|
22
22
|
label: "feature",
|
|
23
23
|
idField: "featureId",
|
|
24
24
|
required: ["featureId", "name", "type"],
|
|
25
|
+
hidden: ["display", "newFeatureId"],
|
|
25
26
|
fields: {
|
|
26
27
|
type: {
|
|
27
28
|
enum: ["boolean", "metered", "credit_system", "ai_credit_system"]
|
|
@@ -167,9 +168,6 @@ var LINT_RULES = {
|
|
|
167
168
|
}
|
|
168
169
|
}
|
|
169
170
|
},
|
|
170
|
-
"features.display": {
|
|
171
|
-
required: ["plural", "singular"]
|
|
172
|
-
},
|
|
173
171
|
"features.modelMarkups": {
|
|
174
172
|
keys: {
|
|
175
173
|
pattern: ".+\\/.+"
|
|
@@ -200,39 +198,30 @@ var LINT_RULES = {
|
|
|
200
198
|
label: "plan",
|
|
201
199
|
idField: "planId",
|
|
202
200
|
required: ["planId", "versionSlug"],
|
|
201
|
+
hidden: [
|
|
202
|
+
"baseVariantId",
|
|
203
|
+
"isDefault",
|
|
204
|
+
"migration",
|
|
205
|
+
"newPlanId",
|
|
206
|
+
"newVersionSlug",
|
|
207
|
+
"propagate",
|
|
208
|
+
"version",
|
|
209
|
+
"versioning"
|
|
210
|
+
],
|
|
203
211
|
fields: {
|
|
204
212
|
planId: {
|
|
205
213
|
minLength: 1,
|
|
206
214
|
pattern: "^[a-zA-Z0-9_-]+$"
|
|
207
215
|
},
|
|
208
|
-
newPlanId: {
|
|
209
|
-
minLength: 1,
|
|
210
|
-
pattern: "^[a-zA-Z0-9_-]+$"
|
|
211
|
-
},
|
|
212
216
|
internalId: {
|
|
213
217
|
minLength: 1
|
|
214
218
|
},
|
|
215
219
|
name: {
|
|
216
220
|
minLength: 1
|
|
217
221
|
},
|
|
218
|
-
version: {
|
|
219
|
-
minimum: 1,
|
|
220
|
-
maximum: 9007199254740991
|
|
221
|
-
},
|
|
222
222
|
versionSlug: {
|
|
223
223
|
minLength: 1,
|
|
224
224
|
pattern: "^[a-zA-Z0-9_-]+$"
|
|
225
|
-
},
|
|
226
|
-
newVersionSlug: {
|
|
227
|
-
minLength: 1,
|
|
228
|
-
pattern: "^[a-zA-Z0-9_-]+$"
|
|
229
|
-
},
|
|
230
|
-
versioning: {
|
|
231
|
-
enum: ["existing", "new_version", "all_versions"]
|
|
232
|
-
},
|
|
233
|
-
baseVariantId: {
|
|
234
|
-
minLength: 1,
|
|
235
|
-
pattern: "^[a-zA-Z0-9_-]+$"
|
|
236
225
|
}
|
|
237
226
|
},
|
|
238
227
|
rules: [
|
|
@@ -984,52 +973,11 @@ var LINT_RULES = {
|
|
|
984
973
|
"plans.processors.stripe": {
|
|
985
974
|
required: ["productId"]
|
|
986
975
|
},
|
|
987
|
-
"plans.propagate.licenseParents": {
|
|
988
|
-
required: ["planId"],
|
|
989
|
-
fields: {
|
|
990
|
-
planId: {
|
|
991
|
-
minLength: 1,
|
|
992
|
-
pattern: "^[a-zA-Z0-9_-]+$"
|
|
993
|
-
},
|
|
994
|
-
version: {
|
|
995
|
-
minimum: 1,
|
|
996
|
-
maximum: 9007199254740991
|
|
997
|
-
},
|
|
998
|
-
versionSlug: {
|
|
999
|
-
minLength: 1,
|
|
1000
|
-
pattern: "^[a-zA-Z0-9_-]+$"
|
|
1001
|
-
},
|
|
1002
|
-
newVersionSlug: {
|
|
1003
|
-
minLength: 1,
|
|
1004
|
-
pattern: "^[a-zA-Z0-9_-]+$"
|
|
1005
|
-
}
|
|
1006
|
-
}
|
|
1007
|
-
},
|
|
1008
|
-
"plans.propagate.variants": {
|
|
1009
|
-
required: ["planId"],
|
|
1010
|
-
fields: {
|
|
1011
|
-
planId: {
|
|
1012
|
-
minLength: 1,
|
|
1013
|
-
pattern: "^[a-zA-Z0-9_-]+$"
|
|
1014
|
-
},
|
|
1015
|
-
version: {
|
|
1016
|
-
minimum: 1,
|
|
1017
|
-
maximum: 9007199254740991
|
|
1018
|
-
},
|
|
1019
|
-
versionSlug: {
|
|
1020
|
-
minLength: 1,
|
|
1021
|
-
pattern: "^[a-zA-Z0-9_-]+$"
|
|
1022
|
-
},
|
|
1023
|
-
newVersionSlug: {
|
|
1024
|
-
minLength: 1,
|
|
1025
|
-
pattern: "^[a-zA-Z0-9_-]+$"
|
|
1026
|
-
}
|
|
1027
|
-
}
|
|
1028
|
-
},
|
|
1029
976
|
"plans.variants": {
|
|
1030
977
|
label: "variant",
|
|
1031
978
|
idField: "variantPlanId",
|
|
1032
979
|
required: ["variantPlanId", "versionSlug"],
|
|
980
|
+
hidden: ["baseVariantId", "newPlanId"],
|
|
1033
981
|
fields: {
|
|
1034
982
|
variantPlanId: {
|
|
1035
983
|
minLength: 1,
|
|
@@ -1049,17 +997,9 @@ var LINT_RULES = {
|
|
|
1049
997
|
name: {
|
|
1050
998
|
minLength: 1
|
|
1051
999
|
},
|
|
1052
|
-
newPlanId: {
|
|
1053
|
-
minLength: 1,
|
|
1054
|
-
pattern: "^[a-zA-Z0-9_-]+$"
|
|
1055
|
-
},
|
|
1056
1000
|
newVersionSlug: {
|
|
1057
1001
|
minLength: 1,
|
|
1058
1002
|
pattern: "^[a-zA-Z0-9_-]+$"
|
|
1059
|
-
},
|
|
1060
|
-
baseVariantId: {
|
|
1061
|
-
minLength: 1,
|
|
1062
|
-
pattern: "^[a-zA-Z0-9_-]+$"
|
|
1063
1003
|
}
|
|
1064
1004
|
}
|
|
1065
1005
|
},
|
|
@@ -2319,6 +2259,13 @@ var checkShape = ({
|
|
|
2319
2259
|
if (entry[field] === undefined)
|
|
2320
2260
|
issues.push({ path: at, message: `${field} is required.` });
|
|
2321
2261
|
}
|
|
2262
|
+
for (const field of shape.hidden ?? []) {
|
|
2263
|
+
if (entry[field] !== undefined)
|
|
2264
|
+
issues.push({
|
|
2265
|
+
path: at,
|
|
2266
|
+
message: `${field} is not a config field. Remove it.`
|
|
2267
|
+
});
|
|
2268
|
+
}
|
|
2322
2269
|
for (const [field, constraints] of Object.entries(shape.fields ?? {})) {
|
|
2323
2270
|
if (entry[field] === undefined)
|
|
2324
2271
|
continue;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":"7.0.0-dev.20260511.1","root":["../src/bin.ts","../src/cli.ts","../src/index.ts","../src/version.ts","../src/actions/env.ts","../src/actions/login.ts","../src/actions/pull.ts","../src/actions/push.ts","../src/actions/api/callApi.ts","../src/actions/api/registerApiCommands.ts","../src/actions/env/fetchOrgInfo.ts","../src/actions/env/types/orgInfo.ts","../src/actions/init/runInit.ts","../src/actions/login/keyless.ts","../src/actions/pull/appendPlanVersionFixture.ts","../src/actions/pull/applyMappings.ts","../src/actions/pull/applyPreview.ts","../src/actions/pull/applySettingsPreview.ts","../src/actions/pull/changedFixtureKeys.ts","../src/actions/pull/listSourceFiles.ts","../src/actions/pull/locateFixture.ts","../src/actions/pull/resolveCollectionTarget.ts","../src/actions/pull/rewriteConfig.ts","../src/actions/pull/scaffoldConfig.ts","../src/actions/push/backfillInternalIds.ts","../src/actions/push/deprecatedFields.ts","../src/actions/reset/runReset.ts","../src/actions/sandbox/createSandbox.ts","../src/actions/sandbox/deleteSandbox.ts","../src/actions/sandbox/listSandboxes.ts","../src/actions/sandbox/useSandbox.ts","../src/actions/sandbox/withSandboxScopeHint.ts","../src/actions/sandbox/types/sandboxClient.ts","../src/actions/skills/ignoreBundledSkills.ts","../src/actions/skills/skills.ts","../src/auth/announceAuthorizationUrl.ts","../src/auth/buildAuthorizationUrl.ts","../src/auth/callbackPages.ts","../src/auth/createOrgApiKeys.ts","../src/auth/keyless.ts","../src/auth/oauthConfig.ts","../src/auth/runOAuthFlow.ts","../src/auth/browser/openSystemBrowser.ts","../src/auth/browser/tryOpenBrowser.ts","../src/auth/browser/watchLauncher.ts","../src/auth/types/browserOpener.ts","../src/auth/types/impersonationTokens.ts","../src/auth/types/oauthTokens.ts","../src/auth/types/orgApiKeys.ts","../src/config/configPackageName.ts","../src/config/legacyConfig.ts","../src/config/loadConfig.ts","../src/env/assertSandboxTarget.ts","../src/env/loadEnv.ts","../src/env/resolveTarget.ts","../src/env/sandboxKeyName.ts","../src/generated/apiRoutes.ts","../src/generated/client.ts","../src/generated/emit.ts","../src/generated/emitRuntime.ts","../src/generated/features.ts","../src/generated/labels.ts","../src/generated/licenses.ts","../src/generated/lintRules.ts","../src/generated/lintRuntime.ts","../src/generated/mappingAssignments.ts","../src/generated/plans.ts","../src/generated/referralPrograms.ts","../src/generated/rewards.ts","../src/generated/settings.ts","../src/generated/skills.ts","../src/generated/variants.ts","../src/generated/wire.ts","../src/http/autumnFetch.ts","../src/project/chooseConfigDir.ts","../src/project/resolveProject.ts","../src/project/rootMarker.ts","../src/prompt/prompt.ts","../src/prompt/select.ts","../src/render/renderEnv.ts","../src/render/renderPreview.ts","../src/render/renderSandboxes.ts","../src/render/stripTerminalControls.ts","../src/repo/findRepoRoot.ts","../src/surgery/appendPropertyEdit.ts","../src/surgery/appendToArray.ts","../src/surgery/appendToBinding.ts","../src/surgery/appendToCollection.ts","../src/surgery/appendToFixtureArray.ts","../src/surgery/arrayBinding.ts","../src/surgery/deleteFixtureLiteral.ts","../src/surgery/deleteReference.ts","../src/surgery/ensureBuilderImport.ts","../src/surgery/findFixture.ts","../src/surgery/fixtureEdit.ts","../src/surgery/fixtureLocation.ts","../src/surgery/insertCollection.ts","../src/surgery/insertFirstProperty.ts","../src/surgery/patchFixturePaths.ts","../src/surgery/patchFixtureProperty.ts","../src/surgery/patchSingletonProperty.ts","../src/surgery/readFixtureValue.ts","../src/surgery/replaceFixture.ts","../src/surgery/setFixtureProperty.ts","../src/surgery/staticFixtureRule.ts","../test/apiCommand.test.ts","../test/authorizationUrl.test.ts","../test/autumnFetch.test.ts","../test/backfill.test.ts","../test/backfillInlineVariants.test.ts","../test/backfillSlug.test.ts","../test/backfillVariants.test.ts","../test/chooseConfigDir.test.ts","../test/cliTargetFlags.test.ts","../test/client.test.ts","../test/configPackageName.test.ts","../test/emitFixture.test.ts","../test/env.test.ts","../test/envWriter.test.ts","../test/ignoreBundledSkills.test.ts","../test/init.test.ts","../test/keyless.test.ts","../test/legacyConfig.test.ts","../test/lintDocument.test.ts","../test/loadConfigNode.test.ts","../test/loadConfigV2.test.ts","../test/locateFixtureUnique.test.ts","../test/login.test.ts","../test/nodeNextTypes.test.ts","../test/patchFixturePaths.test.ts","../test/plans.test.ts","../test/previewIsEmpty.test.ts","../test/prompt.test.ts","../test/pull.test.ts","../test/pullByReference.test.ts","../test/pullFieldLevel.test.ts","../test/pullMappings.test.ts","../test/pullOmitDefaults.test.ts","../test/pullPlans.test.ts","../test/pullStatesSlugs.test.ts","../test/pullTwoCollections.test.ts","../test/readFixtureValue.test.ts","../test/renameHint.test.ts","../test/renderPreview.test.ts","../test/renderSandboxes.test.ts","../test/renderSettings.test.ts","../test/reset.test.ts","../test/resolveCollectionTarget.test.ts","../test/resolveProject.test.ts","../test/resolveTarget.test.ts","../test/sandboxActions.test.ts","../test/sandboxKeyName.test.ts","../test/sandboxUse.test.ts","../test/settingsActions.test.ts","../test/settingsWire.test.ts","../test/skills.test.ts","../test/watchLauncher.test.ts","../test/wireDocument.test.ts","../test/helpers/targetFor.ts","../test/surgery/appendToCollection.test.ts","../test/surgery/deleteFixtureLiteral.test.ts","../test/surgery/deleteReference.test.ts","../test/surgery/findFixture.test.ts","../test/surgery/fixtureLocation.test.ts","../test/surgery/insertCollection.test.ts","../test/surgery/insertFirstProperty.test.ts","../test/surgery/patchFixtureProperty.test.ts","../test/surgery/patchSingletonProperty.test.ts","../test/surgery/replaceFixture.test.ts","../test/surgery/staticFixtureRule.test.ts"]}
|
|
1
|
+
{"version":"7.0.0-dev.20260511.1","root":["../src/bin.ts","../src/cli.ts","../src/index.ts","../src/version.ts","../src/actions/env.ts","../src/actions/login.ts","../src/actions/pull.ts","../src/actions/push.ts","../src/actions/api/callApi.ts","../src/actions/api/registerApiCommands.ts","../src/actions/env/fetchOrgInfo.ts","../src/actions/env/types/orgInfo.ts","../src/actions/init/runInit.ts","../src/actions/login/keyless.ts","../src/actions/pull/appendPlanVersionFixture.ts","../src/actions/pull/applyMappings.ts","../src/actions/pull/applyPreview.ts","../src/actions/pull/applySettingsPreview.ts","../src/actions/pull/changedFixtureKeys.ts","../src/actions/pull/listSourceFiles.ts","../src/actions/pull/locateFixture.ts","../src/actions/pull/pruneUnpulledPlanIds.ts","../src/actions/pull/resolveCollectionTarget.ts","../src/actions/pull/rewriteConfig.ts","../src/actions/pull/scaffoldConfig.ts","../src/actions/push/backfillInternalIds.ts","../src/actions/push/deprecatedFields.ts","../src/actions/reset/runReset.ts","../src/actions/sandbox/createSandbox.ts","../src/actions/sandbox/deleteSandbox.ts","../src/actions/sandbox/listSandboxes.ts","../src/actions/sandbox/useSandbox.ts","../src/actions/sandbox/withSandboxScopeHint.ts","../src/actions/sandbox/types/sandboxClient.ts","../src/actions/skills/ignoreBundledSkills.ts","../src/actions/skills/skills.ts","../src/auth/announceAuthorizationUrl.ts","../src/auth/buildAuthorizationUrl.ts","../src/auth/callbackPages.ts","../src/auth/createOrgApiKeys.ts","../src/auth/keyless.ts","../src/auth/oauthConfig.ts","../src/auth/runOAuthFlow.ts","../src/auth/browser/openSystemBrowser.ts","../src/auth/browser/tryOpenBrowser.ts","../src/auth/browser/watchLauncher.ts","../src/auth/types/browserOpener.ts","../src/auth/types/impersonationTokens.ts","../src/auth/types/oauthTokens.ts","../src/auth/types/orgApiKeys.ts","../src/config/configPackageName.ts","../src/config/legacyConfig.ts","../src/config/loadConfig.ts","../src/env/assertSandboxTarget.ts","../src/env/loadEnv.ts","../src/env/resolveTarget.ts","../src/env/sandboxKeyName.ts","../src/generated/apiRoutes.ts","../src/generated/client.ts","../src/generated/emit.ts","../src/generated/emitRuntime.ts","../src/generated/features.ts","../src/generated/labels.ts","../src/generated/licenses.ts","../src/generated/lintRules.ts","../src/generated/lintRuntime.ts","../src/generated/mappingAssignments.ts","../src/generated/plans.ts","../src/generated/referralPrograms.ts","../src/generated/rewards.ts","../src/generated/settings.ts","../src/generated/skills.ts","../src/generated/variants.ts","../src/generated/wire.ts","../src/http/autumnFetch.ts","../src/project/chooseConfigDir.ts","../src/project/resolveProject.ts","../src/project/rootMarker.ts","../src/prompt/prompt.ts","../src/prompt/select.ts","../src/render/renderEnv.ts","../src/render/renderPreview.ts","../src/render/renderSandboxes.ts","../src/render/stripTerminalControls.ts","../src/repo/findRepoRoot.ts","../src/surgery/appendPropertyEdit.ts","../src/surgery/appendToArray.ts","../src/surgery/appendToBinding.ts","../src/surgery/appendToCollection.ts","../src/surgery/appendToFixtureArray.ts","../src/surgery/arrayBinding.ts","../src/surgery/deleteFixtureLiteral.ts","../src/surgery/deleteReference.ts","../src/surgery/ensureBuilderImport.ts","../src/surgery/findFixture.ts","../src/surgery/fixtureEdit.ts","../src/surgery/fixtureLocation.ts","../src/surgery/insertCollection.ts","../src/surgery/insertFirstProperty.ts","../src/surgery/patchFixturePaths.ts","../src/surgery/patchFixtureProperty.ts","../src/surgery/patchSingletonProperty.ts","../src/surgery/readFixtureValue.ts","../src/surgery/replaceFixture.ts","../src/surgery/setFixtureProperty.ts","../src/surgery/staticFixtureRule.ts","../test/apiCommand.test.ts","../test/authorizationUrl.test.ts","../test/autumnFetch.test.ts","../test/backfill.test.ts","../test/backfillInlineVariants.test.ts","../test/backfillSlug.test.ts","../test/backfillVariants.test.ts","../test/chooseConfigDir.test.ts","../test/cliTargetFlags.test.ts","../test/client.test.ts","../test/configPackageName.test.ts","../test/emitFixture.test.ts","../test/env.test.ts","../test/envWriter.test.ts","../test/ignoreBundledSkills.test.ts","../test/init.test.ts","../test/keyless.test.ts","../test/legacyConfig.test.ts","../test/lintDocument.test.ts","../test/loadConfigNode.test.ts","../test/loadConfigV2.test.ts","../test/locateFixtureUnique.test.ts","../test/login.test.ts","../test/nodeNextTypes.test.ts","../test/patchFixturePaths.test.ts","../test/plans.test.ts","../test/previewIsEmpty.test.ts","../test/prompt.test.ts","../test/pull.test.ts","../test/pullByReference.test.ts","../test/pullFieldLevel.test.ts","../test/pullMappings.test.ts","../test/pullOmitDefaults.test.ts","../test/pullPlans.test.ts","../test/pullStatesSlugs.test.ts","../test/pullTwoCollections.test.ts","../test/readFixtureValue.test.ts","../test/renameHint.test.ts","../test/renderPreview.test.ts","../test/renderSandboxes.test.ts","../test/renderSettings.test.ts","../test/reset.test.ts","../test/resolveCollectionTarget.test.ts","../test/resolveProject.test.ts","../test/resolveTarget.test.ts","../test/sandboxActions.test.ts","../test/sandboxKeyName.test.ts","../test/sandboxUse.test.ts","../test/settingsActions.test.ts","../test/settingsWire.test.ts","../test/skills.test.ts","../test/watchLauncher.test.ts","../test/wireDocument.test.ts","../test/helpers/targetFor.ts","../test/surgery/appendToCollection.test.ts","../test/surgery/deleteFixtureLiteral.test.ts","../test/surgery/deleteReference.test.ts","../test/surgery/findFixture.test.ts","../test/surgery/fixtureLocation.test.ts","../test/surgery/insertCollection.test.ts","../test/surgery/insertFirstProperty.test.ts","../test/surgery/patchFixtureProperty.test.ts","../test/surgery/patchSingletonProperty.test.ts","../test/surgery/replaceFixture.test.ts","../test/surgery/staticFixtureRule.test.ts"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "atmn",
|
|
3
|
-
"version": "2.0.
|
|
3
|
+
"version": "2.0.17",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"description": "The CLI for Autumn — define your pricing in code, sync it to Autumn, and keep everything in version control.",
|
|
6
6
|
"bin": {
|
|
@@ -49,5 +49,5 @@
|
|
|
49
49
|
"open": "10.2.0",
|
|
50
50
|
"yaml": "2.9.0"
|
|
51
51
|
},
|
|
52
|
-
"gitHead": "
|
|
52
|
+
"gitHead": "fd131f18fa4c1413d3dd57d3c3ac113a192d9763"
|
|
53
53
|
}
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
const isRecord = (value: unknown): value is Record<string, unknown> =>
|
|
2
|
+
value !== null && typeof value === "object" && !Array.isArray(value);
|
|
3
|
+
|
|
4
|
+
/**
|
|
5
|
+
* The plan ids a pull writes: every catalog row's own id, and the variants
|
|
6
|
+
* nested under it, which are plans in their own right. Archived rows are
|
|
7
|
+
* server history and never written, so they do not count.
|
|
8
|
+
*/
|
|
9
|
+
export const pulledPlanIds = ({
|
|
10
|
+
plans,
|
|
11
|
+
}: {
|
|
12
|
+
plans: Record<string, unknown>[];
|
|
13
|
+
}): Set<string> => {
|
|
14
|
+
const ids = new Set<string>();
|
|
15
|
+
for (const row of plans) {
|
|
16
|
+
if (row.archived === true) continue;
|
|
17
|
+
if (typeof row.id === "string") ids.add(row.id);
|
|
18
|
+
if (!Array.isArray(row.variants)) continue;
|
|
19
|
+
for (const edge of row.variants) {
|
|
20
|
+
if (isRecord(edge) && typeof edge.variantPlanId === "string")
|
|
21
|
+
ids.add(edge.variantPlanId);
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
return ids;
|
|
25
|
+
};
|
|
26
|
+
|
|
27
|
+
const prunePlanIds = ({
|
|
28
|
+
body,
|
|
29
|
+
pulled,
|
|
30
|
+
}: {
|
|
31
|
+
body: Record<string, unknown>;
|
|
32
|
+
pulled: Set<string>;
|
|
33
|
+
}): { body: Record<string, unknown>; dropped: string[] } => {
|
|
34
|
+
if (!Array.isArray(body.planIds)) return { body, dropped: [] };
|
|
35
|
+
const dropped = body.planIds.filter(
|
|
36
|
+
(id): id is string => typeof id === "string" && !pulled.has(id),
|
|
37
|
+
);
|
|
38
|
+
if (dropped.length === 0) return { body, dropped };
|
|
39
|
+
return {
|
|
40
|
+
body: {
|
|
41
|
+
...body,
|
|
42
|
+
planIds: body.planIds.filter((id) => !dropped.includes(id)),
|
|
43
|
+
},
|
|
44
|
+
dropped,
|
|
45
|
+
};
|
|
46
|
+
};
|
|
47
|
+
|
|
48
|
+
const show = (value: string): string => JSON.stringify(value);
|
|
49
|
+
|
|
50
|
+
/**
|
|
51
|
+
* A coupon or a referral program may still name a plan the pull never writes:
|
|
52
|
+
* an archived one, which the server keeps for its customers but no longer
|
|
53
|
+
* surfaces. The lint refuses a reference to a plan the config does not
|
|
54
|
+
* declare, so a pulled config would be refused by its own push. The reference
|
|
55
|
+
* is dropped instead, and said, since the next push takes it off the server
|
|
56
|
+
* too — a change the preview shows before it is made.
|
|
57
|
+
*/
|
|
58
|
+
export const pruneUnpulledPlanIds = ({
|
|
59
|
+
rows,
|
|
60
|
+
pulled,
|
|
61
|
+
kind,
|
|
62
|
+
}: {
|
|
63
|
+
rows: Record<string, unknown>[];
|
|
64
|
+
pulled: Set<string>;
|
|
65
|
+
/** Rewards are union rows, `{ coupon }` or `{ featureGrant }`; referral programs are flat. */
|
|
66
|
+
kind: "rewards" | "referralPrograms";
|
|
67
|
+
}): { rows: Record<string, unknown>[]; lines: string[] } => {
|
|
68
|
+
const lines: string[] = [];
|
|
69
|
+
const say = ({
|
|
70
|
+
label,
|
|
71
|
+
id,
|
|
72
|
+
dropped,
|
|
73
|
+
}: {
|
|
74
|
+
label: string;
|
|
75
|
+
id: unknown;
|
|
76
|
+
dropped: string[];
|
|
77
|
+
}): void => {
|
|
78
|
+
const plans = dropped.length === 1 ? "plan" : "plans";
|
|
79
|
+
lines.push(
|
|
80
|
+
`↳ ${label} ${show(String(id))} no longer names ${plans} ${dropped.map(show).join(", ")}: not in the catalog (archived), so not in the config`,
|
|
81
|
+
);
|
|
82
|
+
};
|
|
83
|
+
return {
|
|
84
|
+
lines,
|
|
85
|
+
rows: rows.map((row) => {
|
|
86
|
+
if (kind === "referralPrograms") {
|
|
87
|
+
const { body, dropped } = prunePlanIds({ body: row, pulled });
|
|
88
|
+
if (dropped.length > 0)
|
|
89
|
+
say({ label: "referral program", id: row.id, dropped });
|
|
90
|
+
return body;
|
|
91
|
+
}
|
|
92
|
+
if (!isRecord(row.coupon)) return row;
|
|
93
|
+
const { body, dropped } = prunePlanIds({ body: row.coupon, pulled });
|
|
94
|
+
if (dropped.length === 0) return row;
|
|
95
|
+
say({ label: "coupon", id: row.coupon.id, dropped });
|
|
96
|
+
return { ...row, coupon: body };
|
|
97
|
+
}),
|
|
98
|
+
};
|
|
99
|
+
};
|
package/src/actions/pull.ts
CHANGED
|
@@ -20,6 +20,10 @@ import { applyMappings } from "./pull/applyMappings";
|
|
|
20
20
|
import { applyPreview, type PreviewEntry } from "./pull/applyPreview";
|
|
21
21
|
import { applySettingsPreview } from "./pull/applySettingsPreview";
|
|
22
22
|
import { listSourceFiles } from "./pull/listSourceFiles";
|
|
23
|
+
import {
|
|
24
|
+
pruneUnpulledPlanIds,
|
|
25
|
+
pulledPlanIds,
|
|
26
|
+
} from "./pull/pruneUnpulledPlanIds";
|
|
23
27
|
import { rewriteConfig } from "./pull/rewriteConfig";
|
|
24
28
|
import {
|
|
25
29
|
type ConfigImports,
|
|
@@ -294,6 +298,24 @@ export const runPull = async ({
|
|
|
294
298
|
const previewRows = preview as unknown as Record<string, unknown>;
|
|
295
299
|
const catalogRows = catalog as unknown as Record<string, unknown>;
|
|
296
300
|
const featureTypes = featureTypesOf({ rows: rowsOf(catalogRows.features) });
|
|
301
|
+
// A reward may name an archived plan; the pull never writes one, and a
|
|
302
|
+
// config cannot name a plan it does not declare.
|
|
303
|
+
const pulled = pulledPlanIds({ plans: rowsOf(catalogRows.plans) });
|
|
304
|
+
const rewards = pruneUnpulledPlanIds({
|
|
305
|
+
rows: rowsOf(catalogRows.rewards),
|
|
306
|
+
pulled,
|
|
307
|
+
kind: "rewards",
|
|
308
|
+
});
|
|
309
|
+
const referralPrograms = pruneUnpulledPlanIds({
|
|
310
|
+
rows: rowsOf(catalogRows.referralPrograms),
|
|
311
|
+
pulled,
|
|
312
|
+
kind: "referralPrograms",
|
|
313
|
+
});
|
|
314
|
+
const pulledRows: Record<string, unknown> = {
|
|
315
|
+
...catalogRows,
|
|
316
|
+
rewards: rewards.rows,
|
|
317
|
+
referralPrograms: referralPrograms.rows,
|
|
318
|
+
};
|
|
297
319
|
const nestedBuilders = Object.fromEntries(
|
|
298
320
|
Object.values(NESTED_FIXTURES).map(({ path, builder }) => [path, builder]),
|
|
299
321
|
);
|
|
@@ -305,7 +327,7 @@ export const runPull = async ({
|
|
|
305
327
|
collection,
|
|
306
328
|
spec,
|
|
307
329
|
entries: entriesOf(previewRows[collection]),
|
|
308
|
-
catalogRows: withVariantIdentity(rowsOf(
|
|
330
|
+
catalogRows: withVariantIdentity(rowsOf(pulledRows[collection])),
|
|
309
331
|
configPath,
|
|
310
332
|
files,
|
|
311
333
|
includeMappings,
|
|
@@ -363,6 +385,8 @@ export const runPull = async ({
|
|
|
363
385
|
}
|
|
364
386
|
}
|
|
365
387
|
|
|
388
|
+
lines.push(...rewards.lines, ...referralPrograms.lines);
|
|
389
|
+
|
|
366
390
|
// A fixture that is not a plain literal cannot be edited in place; saying
|
|
367
391
|
// so before writing anything beats a half-applied pull.
|
|
368
392
|
if (unlocated.length > 0) throw new UnlocatableFixturesError({ unlocated });
|
package/src/generated/emit.ts
CHANGED
|
@@ -112,7 +112,6 @@ export const COLLECTIONS: Readonly<Record<string, CollectionSpec>> = {
|
|
|
112
112
|
"createInStripe",
|
|
113
113
|
"variants",
|
|
114
114
|
"licenses",
|
|
115
|
-
"baseVariantId",
|
|
116
115
|
],
|
|
117
116
|
required: [
|
|
118
117
|
"active",
|
|
@@ -317,7 +316,6 @@ export const COLLECTIONS: Readonly<Record<string, CollectionSpec>> = {
|
|
|
317
316
|
"addOn",
|
|
318
317
|
"archived",
|
|
319
318
|
"autoEnable",
|
|
320
|
-
"baseVariantId",
|
|
321
319
|
"billingControls",
|
|
322
320
|
"billingControls.autoTopups",
|
|
323
321
|
"billingControls.autoTopups.enabled",
|
|
@@ -557,7 +555,6 @@ export const COLLECTIONS: Readonly<Record<string, CollectionSpec>> = {
|
|
|
557
555
|
"processors.stripe.productId",
|
|
558
556
|
"variants",
|
|
559
557
|
"variants.archived",
|
|
560
|
-
"variants.baseVariantId",
|
|
561
558
|
"variants.customize",
|
|
562
559
|
"variants.customize.addItems",
|
|
563
560
|
"variants.customize.addItems.entityFeatureId",
|
|
@@ -7,6 +7,7 @@ export const LINT_RULES: LintRules = {
|
|
|
7
7
|
label: "feature",
|
|
8
8
|
idField: "featureId",
|
|
9
9
|
required: ["featureId", "name", "type"],
|
|
10
|
+
hidden: ["display", "newFeatureId"],
|
|
10
11
|
fields: {
|
|
11
12
|
type: {
|
|
12
13
|
enum: ["boolean", "metered", "credit_system", "ai_credit_system"],
|
|
@@ -154,9 +155,6 @@ export const LINT_RULES: LintRules = {
|
|
|
154
155
|
},
|
|
155
156
|
},
|
|
156
157
|
},
|
|
157
|
-
"features.display": {
|
|
158
|
-
required: ["plural", "singular"],
|
|
159
|
-
},
|
|
160
158
|
"features.modelMarkups": {
|
|
161
159
|
keys: {
|
|
162
160
|
pattern: ".+\\/.+",
|
|
@@ -187,40 +185,31 @@ export const LINT_RULES: LintRules = {
|
|
|
187
185
|
label: "plan",
|
|
188
186
|
idField: "planId",
|
|
189
187
|
required: ["planId", "versionSlug"],
|
|
188
|
+
hidden: [
|
|
189
|
+
"baseVariantId",
|
|
190
|
+
"isDefault",
|
|
191
|
+
"migration",
|
|
192
|
+
"newPlanId",
|
|
193
|
+
"newVersionSlug",
|
|
194
|
+
"propagate",
|
|
195
|
+
"version",
|
|
196
|
+
"versioning",
|
|
197
|
+
],
|
|
190
198
|
fields: {
|
|
191
199
|
planId: {
|
|
192
200
|
minLength: 1,
|
|
193
201
|
pattern: "^[a-zA-Z0-9_-]+$",
|
|
194
202
|
},
|
|
195
|
-
newPlanId: {
|
|
196
|
-
minLength: 1,
|
|
197
|
-
pattern: "^[a-zA-Z0-9_-]+$",
|
|
198
|
-
},
|
|
199
203
|
internalId: {
|
|
200
204
|
minLength: 1,
|
|
201
205
|
},
|
|
202
206
|
name: {
|
|
203
207
|
minLength: 1,
|
|
204
208
|
},
|
|
205
|
-
version: {
|
|
206
|
-
minimum: 1,
|
|
207
|
-
maximum: 9007199254740991,
|
|
208
|
-
},
|
|
209
209
|
versionSlug: {
|
|
210
210
|
minLength: 1,
|
|
211
211
|
pattern: "^[a-zA-Z0-9_-]+$",
|
|
212
212
|
},
|
|
213
|
-
newVersionSlug: {
|
|
214
|
-
minLength: 1,
|
|
215
|
-
pattern: "^[a-zA-Z0-9_-]+$",
|
|
216
|
-
},
|
|
217
|
-
versioning: {
|
|
218
|
-
enum: ["existing", "new_version", "all_versions"],
|
|
219
|
-
},
|
|
220
|
-
baseVariantId: {
|
|
221
|
-
minLength: 1,
|
|
222
|
-
pattern: "^[a-zA-Z0-9_-]+$",
|
|
223
|
-
},
|
|
224
213
|
},
|
|
225
214
|
rules: [
|
|
226
215
|
{
|
|
@@ -981,52 +970,11 @@ export const LINT_RULES: LintRules = {
|
|
|
981
970
|
"plans.processors.stripe": {
|
|
982
971
|
required: ["productId"],
|
|
983
972
|
},
|
|
984
|
-
"plans.propagate.licenseParents": {
|
|
985
|
-
required: ["planId"],
|
|
986
|
-
fields: {
|
|
987
|
-
planId: {
|
|
988
|
-
minLength: 1,
|
|
989
|
-
pattern: "^[a-zA-Z0-9_-]+$",
|
|
990
|
-
},
|
|
991
|
-
version: {
|
|
992
|
-
minimum: 1,
|
|
993
|
-
maximum: 9007199254740991,
|
|
994
|
-
},
|
|
995
|
-
versionSlug: {
|
|
996
|
-
minLength: 1,
|
|
997
|
-
pattern: "^[a-zA-Z0-9_-]+$",
|
|
998
|
-
},
|
|
999
|
-
newVersionSlug: {
|
|
1000
|
-
minLength: 1,
|
|
1001
|
-
pattern: "^[a-zA-Z0-9_-]+$",
|
|
1002
|
-
},
|
|
1003
|
-
},
|
|
1004
|
-
},
|
|
1005
|
-
"plans.propagate.variants": {
|
|
1006
|
-
required: ["planId"],
|
|
1007
|
-
fields: {
|
|
1008
|
-
planId: {
|
|
1009
|
-
minLength: 1,
|
|
1010
|
-
pattern: "^[a-zA-Z0-9_-]+$",
|
|
1011
|
-
},
|
|
1012
|
-
version: {
|
|
1013
|
-
minimum: 1,
|
|
1014
|
-
maximum: 9007199254740991,
|
|
1015
|
-
},
|
|
1016
|
-
versionSlug: {
|
|
1017
|
-
minLength: 1,
|
|
1018
|
-
pattern: "^[a-zA-Z0-9_-]+$",
|
|
1019
|
-
},
|
|
1020
|
-
newVersionSlug: {
|
|
1021
|
-
minLength: 1,
|
|
1022
|
-
pattern: "^[a-zA-Z0-9_-]+$",
|
|
1023
|
-
},
|
|
1024
|
-
},
|
|
1025
|
-
},
|
|
1026
973
|
"plans.variants": {
|
|
1027
974
|
label: "variant",
|
|
1028
975
|
idField: "variantPlanId",
|
|
1029
976
|
required: ["variantPlanId", "versionSlug"],
|
|
977
|
+
hidden: ["baseVariantId", "newPlanId"],
|
|
1030
978
|
fields: {
|
|
1031
979
|
variantPlanId: {
|
|
1032
980
|
minLength: 1,
|
|
@@ -1046,18 +994,10 @@ export const LINT_RULES: LintRules = {
|
|
|
1046
994
|
name: {
|
|
1047
995
|
minLength: 1,
|
|
1048
996
|
},
|
|
1049
|
-
newPlanId: {
|
|
1050
|
-
minLength: 1,
|
|
1051
|
-
pattern: "^[a-zA-Z0-9_-]+$",
|
|
1052
|
-
},
|
|
1053
997
|
newVersionSlug: {
|
|
1054
998
|
minLength: 1,
|
|
1055
999
|
pattern: "^[a-zA-Z0-9_-]+$",
|
|
1056
1000
|
},
|
|
1057
|
-
baseVariantId: {
|
|
1058
|
-
minLength: 1,
|
|
1059
|
-
pattern: "^[a-zA-Z0-9_-]+$",
|
|
1060
|
-
},
|
|
1061
1001
|
},
|
|
1062
1002
|
},
|
|
1063
1003
|
"plans.variants.customize.addItems": {
|
|
@@ -161,6 +161,8 @@ export type LintRule =
|
|
|
161
161
|
/** The part of a node's rules that an anyOf/oneOf branch can override. */
|
|
162
162
|
export type ShapeRules = {
|
|
163
163
|
readonly required?: readonly string[];
|
|
164
|
+
/** Fields the CLI keeps out of a config; stating one is an error. */
|
|
165
|
+
readonly hidden?: readonly string[];
|
|
164
166
|
readonly fields?: Readonly<Record<string, FieldConstraints>>;
|
|
165
167
|
};
|
|
166
168
|
|
|
@@ -322,6 +324,13 @@ const checkShape = ({
|
|
|
322
324
|
if (entry[field] === undefined)
|
|
323
325
|
issues.push({ path: at, message: `${field} is required.` });
|
|
324
326
|
}
|
|
327
|
+
for (const field of shape.hidden ?? []) {
|
|
328
|
+
if (entry[field] !== undefined)
|
|
329
|
+
issues.push({
|
|
330
|
+
path: at,
|
|
331
|
+
message: `${field} is not a config field. Remove it.`,
|
|
332
|
+
});
|
|
333
|
+
}
|
|
325
334
|
for (const [field, constraints] of Object.entries(shape.fields ?? {})) {
|
|
326
335
|
if (entry[field] === undefined) continue;
|
|
327
336
|
for (const message of constraintFailures({
|
package/src/generated/plans.ts
CHANGED
|
@@ -450,8 +450,6 @@ export type Plan = {
|
|
|
450
450
|
}>;
|
|
451
451
|
} | null;
|
|
452
452
|
};
|
|
453
|
-
/** Pointer write for this nested variant. Omit to link it to this base; `null` detaches it. A string must be this plan's id. */
|
|
454
|
-
baseVariantId?: string | null;
|
|
455
453
|
/** Declared overlay on this variant. `items` is PUT (replaces the list); `add_items` / `remove_items` are PATCH. Independent of `propagate`. Blocked on an archived variant unless `archived` is false in the same entry. */
|
|
456
454
|
customize?: {
|
|
457
455
|
/** Override the base price of the plan. Pass null to remove the base price. */
|
|
@@ -1646,8 +1644,6 @@ export type Plan = {
|
|
|
1646
1644
|
} | null;
|
|
1647
1645
|
metadata?: Record<string, unknown>;
|
|
1648
1646
|
}>;
|
|
1649
|
-
/** Base plan id to attach this plan to. `null` detaches it from its base. Omit to leave the pointer unchanged. Nesting under the base's variants[] also links. */
|
|
1650
|
-
baseVariantId?: string | null;
|
|
1651
1647
|
};
|
|
1652
1648
|
|
|
1653
1649
|
export const plan = (input: Plan): Plan => input;
|
package/src/generated/skills.ts
CHANGED
|
@@ -14,16 +14,16 @@ export type BundledSkill = {
|
|
|
14
14
|
}[];
|
|
15
15
|
};
|
|
16
16
|
|
|
17
|
-
export const SKILLS_VERSION = "2.0.
|
|
17
|
+
export const SKILLS_VERSION = "2.0.17";
|
|
18
18
|
|
|
19
19
|
export const SKILLS: readonly BundledSkill[] = [
|
|
20
20
|
{
|
|
21
21
|
name: "autumn-setup",
|
|
22
22
|
description:
|
|
23
23
|
"First-time Autumn setup — install the atmn CLI, connect to an org (sign in, or keyless with no account), turn the user's pricing into autumn.config.ts, and push it to a sandbox org. Use when the user is new to Autumn, pastes an Autumn setup prompt, or asks to set up Autumn, add billing, monetization, subscriptions, usage-based billing, pricing, or plans. If Autumn is already set up, use autumn-catalog instead.",
|
|
24
|
-
version: "2.0.
|
|
24
|
+
version: "2.0.17",
|
|
25
25
|
markdown:
|
|
26
|
-
"---\nname: autumn-setup\ndescription: First-time Autumn setup — install the atmn CLI, connect to an org (sign in, or keyless with no account), turn the user's pricing into autumn.config.ts, and push it to a sandbox org. Use when the user is new to Autumn, pastes an Autumn setup prompt, or asks to set up Autumn, add billing, monetization, subscriptions, usage-based billing, pricing, or plans. If Autumn is already set up, use autumn-catalog instead.\nversion: 2.0.16\n---\n\n# Setup\n\nTake the user from \"I want billing\" to pricing that is live in a sandbox org and working in their app — with as little between those two points as possible. You run the flow; two other skills do the heavy parts. `autumn-catalog` turns their pricing into `autumn.config.ts`. `autumn-integrate` puts the first calls in their code. Never do either of those jobs yourself.\n\n## Ground rules\n\nThese apply the whole time, not just in one phase.\n\n- CLI-first: everything happens in `autumn.config.ts` and `atmn`. The only browser moments are signing in, or claiming a keyless org later. Never send the user to the dashboard to do the work.\n- Never invent a price, limit, or plan name. A missing number is a question, never a guess.\n- Push only after the user approves the pricing (Phase 4), or when they already told you to go ahead without a review.\n- Sandbox by default: `AUTUMN_SECRET_KEY` is the sandbox key. Don't touch production during setup.\n- Keys: check that a key exists by its name only. Never read, print, or ask the user to paste a key into the chat. Same for a keyless org's claim token. A one-time email code is not a key — that one does come through the chat.\n- Two tries max to fix any failing command, then stop and show the error.\n- Never run `atmn reset`, and never remove existing plans unless the user clearly asked.\n- If a step is already done, say so in one line (\"Already signed in — skipping login\") and move on.\n\n## How to talk\n\nYou are a competent engineer pairing with the user, not an installer wizard and not a marketer.\n\n- Simple, everyday words: \"plans\", \"what's included\", \"extra usage\". No jargon in chat — schema words like `consumable`, `prepaid`, `usage_based` stay in the config. If a simpler word says the same thing, use it.\n- 1–3 sentences per message. The pricing summary is the only large thing you send.\n- One message, one purpose: a status, a question, or the pricing summary.\n- Don't ask permission for harmless work — reading the repo, drafting the config, building the summary. Ask only for decisions and approvals.\n- Say what's about to happen before it does: one line before the browser opens, one before the push.\n- When you need input, ask at most three short numbered questions — the ones that unblock you, nothing more. If your platform has a built-in way to ask questions with options, use it. Never re-ask something they answered.\n- Always end a message with something: the question, what you're doing next, or that you're done.\n- Don't paste the config or command output into chat; name the file and summarize. Errors are the exception — quote those exactly.\n- If you're stuck, send three lines: what failed, the exact error, what you need to continue.\n- No emoji, no hype, no \"Great question\". Plain and concrete: \"Connected to Acme (sandbox).\"\n\n## Progress\n\nCopy this checklist into your first message and keep it up to date. If you skip an item, say why in one line.\n\n- [ ] 1 Skills installed; checked for an existing config, key, and pricing\n- [ ] 2 Connected to Autumn — `atmn` installed, signed in or keyless\n- [ ] 3 Got the user's pricing — rough plans and prices to build from\n- [ ] 4 Pricing modeled and approved (the `autumn-catalog` skill runs this part)\n- [ ] 5 Pushed to Autumn and verified\n- [ ] 6 Working in the app — one plan bought, one feature gated (the `autumn-integrate` skill runs this part)\n- [ ] 7 Account linked (keyless only — drop this line if they signed in)\n- [ ] 8 Done\n\nFor items 4 and 6, another skill owns the conversation and its checklist replaces this one for the duration — show theirs, not this one. Come back here when they're finished.\n\n## Phase 1 — Check the project (silent)\n\nDon't message the user yet — just find out where things stand.\n\nFour skills share this job, and they ship inside the `atmn` CLI: `atmn init` writes them next to the config and prints the `npx skills add <that folder> -y` line that registers them with your agent, and `atmn skills update` refreshes them when `push` or `pull` say they are older than the CLI. If any is missing here, that is Phase 2's job — never fetch them from anywhere else.\n\n`autumn-setup` (this file) is the flow. `autumn-catalog` is how to build the pricing, plus the exact `atmn` commands — load it in Phase 4. `autumn-integrate` is how the app calls Autumn — load it in Phase 6. `autumn-concepts` explains Autumn's objects — the other two load it themselves.\n\nThen check three things:\n\n- `autumn.config.ts` exists → Autumn is already set up here. Say so, treat the file as the truth, and use `autumn-catalog` for the changes; come back at Phase 5 (push) when there's something to push.\n- An `AUTUMN_SECRET_KEY` exists (shell env, `.env`, `.env.local`) → already connected; skip the connect step in Phase 2.\n- They already told you the pricing (their message, a pricing page, the README) → Phase 3 is a quick confirm, not a list of questions.\n\n## Phase 2 — Introduce and connect\n\nStart with two or three sentences: what's going to happen (connect this project to an Autumn org → write the pricing into `autumn.config.ts` → approve the pricing → push). Something like this, in your own words:\n\n> Setting up Autumn. I'll connect this project to an Autumn org, write your pricing into `autumn.config.ts`, and show it to you to approve before anything is pushed.\n\nThen:\n\n1. Run `atmn init` from the project root with the user's package manager (`bunx atmn init`, `pnpm exec atmn init`, `yarn atmn init`, `npx atmn init` — read it off the lockfile). Every `atmn …` command below means that run command. One command does the whole connect step: it adds `atmn` as a dependency, places the config in `autumn/` (its own package in a monorepo — it asks where, or takes `--path` and `--name`), pulls whatever the org already holds, and installs these skills beside the config. Each run prints what it did and, when it needs an answer, the flag to pass; run it again with the flag.\n2. Key already there → `init` says who it's connected to and moves on. Say so in one line.\n3. No key → `init` stops and asks how to connect. Ask the user the same thing, one question, two options, plain words:\n\n > Two ways to start: sign in to an Autumn account (I'll open a browser), or go keyless — I set up a sandbox for you right now and you link an account later. Which do you want?\n\n Always ask this one, even if the user told you to handle everything yourself — a keyless org has no owner until they link it, and that is their call, not yours. Pick keyless without asking only when there is genuinely nobody in the chat to answer (an unattended run), and say in one line that you did.\n4. Connect the way they chose, by running `init` again with the flag:\n\n - **Sign in** → say a browser window is coming, then `atmn init --login`. It opens the browser to sign in and create or pick an org, prints the sign-in URL, and waits — that's normal, it's not stuck. If the browser doesn't open (SSH, sandbox), that's not a failure: send the user the printed URL as-is and wait. Keys get saved to `.env`. Fails → retry once, then stop and tell the user what failed. Offer the ways forward — go keyless, or they copy their own sandbox key from app.useautumn.com into `.env` as `AUTUMN_SECRET_KEY` — and wait for their answer. Never switch to keyless on your own.\n - **Keyless** → `atmn init --keyless`. It provisions a sandbox org and saves its key to `.env` as `AUTUMN_SECRET_KEY`. No account, no browser, nothing for the user to do. The org is a real one: pushing, customers, and billing all work the same. It has no owner until Phase 7 links one, and the key doesn't change when that happens. `init` prints the deadline for linking; note it for Phase 7. For what provisioning and linking do underneath, and their limits, read `references/keyless.md`.\n\n5. `init` pulled the org's catalog into the config. If plans showed up (\"Pulled N entries\"), say so and go through them with the user before changing anything. A brand-new or keyless org is empty; the config is a scaffold for Phase 4 to fill.\n\nDone when `init` finished and you know whether the org already has plans. Say so in one line — including whether it's keyless, since that decides how you finish.\n\n## Phase 3 — Get a starting point\n\nYou need the pricing in the user's own words — not the details, just what to build.\n\n- They already told you (their message, a pricing page, the README) → repeat it back in one or two sentences and move on. If they gave you everything, ask nothing.\n- They haven't → ask what they're building and what they want to charge. A pricing page, or a competitor's page they like, is a full answer too.\n\nDon't dig into details here — what to ask, what to assume, and how to handle unclear pricing is `autumn-catalog`'s job, next phase.\n\nDone when you have rough plans and prices to build from.\n\n## Phase 4 — Model, write, approve\n\nLoad `autumn-catalog` now — from here it owns the conversation: its Shape/Fill flow, its checklist (shown instead of this skill's), its questions, its catalog display, and the approval. Your speaking rules above still apply to its questions.\n\nThis whole phase is the catalog skill's: structure agreed → config written and valid → pricing shown in its format → user approved. Only come back here when that's done; don't push yet.\n\n## Phase 5 — Push\n\nOnly after the yes. Push with `atmn` using `autumn-catalog`'s atmn reference — it has the exact commands, flags, and versioning choices. If the push asks for decisions (new version of a live plan, deleting things), bring them to the user; never decide alone. Check the push output shows every plan and feature made it — a push that errored is not done, and after two failed fixes you stop and show the error.\n\n## Phase 6 — Get it working in the app\n\nPricing in a sandbox is invisible. The user believes Autumn works when their own app creates a customer, blocks something, and takes money — so go there next, in one short pass, before anything else gets built.\n\nSay what's now live (plans and features, which org, sandbox) and where the config file is, then offer it:\n\n> Plans are live. Want me to wire up the basics now — customers created on signup, buying a plan, one feature gated / tracked — so you can see it running in your app?\n\nThey say no → skip to Phase 7. They say yes, or already asked for the integration up front → this phase runs. Either way it's their call; never start editing app code unasked.\n\nScope it before handing over. The first pass is the thinnest thing that proves the loop, and nothing else:\n\n- a customer created where the app already knows who the user is\n- buying a plan: the main free → paid move, so real money moves once\n- `check` and `track` on the **one** feature that matters most — ask which if it isn't obvious, don't gate everything\n\nAnything else — every remaining feature, entities, seats, billing controls, the billing page — waits for a second pass. Say that out loud when you scope, so the user doesn't read a small first pass as a small integration.\n\nLoad `autumn-integrate` now with that scope — from here it owns the conversation and the code: its order of operations, its checklist, its verification. Your speaking rules above still apply.\n\nCome back when its verification passes: a customer that exists in sandbox, a check that denied, usage that landed, a plan that attached.\n\n## Phase 7 — Link the account (keyless only)\n\nSkip this entirely if the user signed in — they already own their org.\n\nOffer once, right after they've seen the integration work, because that's when there's something worth logging in to look at:\n\n> Want to link this to your account? I’ll create a secure sign-in link so you can claim the org and open everything that just ran in the dashboard.\n\nNo → fine, drop it and say the offer stands whenever. Yes → ask which email to send the link to, run `atmn login --claim <email>`, and give them the returned claim URL. Autumn also emails that same URL — say so, naming the address, so they know where to find it later (\"Also sent to you@example.com\"). Whoever opens the link and signs in becomes the owner — the email is only where the link is delivered, so treat the link like the key and give it to the user alone. Linking makes them the owner: same key, same plans, same customers, plus the dashboard. An account that already exists works the same way; the new org is added beside their existing ones and becomes active after confirmation.\n\nUnclaimed orgs don't wait forever, so mention the window `init` printed when you offer — as a fact, not a threat. If linking fails, nothing is lost: the key keeps working and they can try again, or sign up normally and push the same config. What the commands do underneath: `references/keyless.md`.\n\n## Phase 8 — Done\n\nThree lines: what's live and working, where it lives (`autumn.config.ts`, and the handlers if Phase 6 ran), and the obvious next thing — the rest of the features, or going to production when they're ready. A linked or signed-in user can see it all at app.useautumn.com; a keyless user who declined can't, so don't send them there.\n\nThen stop. Don't keep building, don't tour the dashboard, don't deploy anything.",
|
|
26
|
+
"---\nname: autumn-setup\ndescription: First-time Autumn setup — install the atmn CLI, connect to an org (sign in, or keyless with no account), turn the user's pricing into autumn.config.ts, and push it to a sandbox org. Use when the user is new to Autumn, pastes an Autumn setup prompt, or asks to set up Autumn, add billing, monetization, subscriptions, usage-based billing, pricing, or plans. If Autumn is already set up, use autumn-catalog instead.\nversion: 2.0.17\n---\n\n# Setup\n\nTake the user from \"I want billing\" to pricing that is live in a sandbox org and working in their app — with as little between those two points as possible. You run the flow; two other skills do the heavy parts. `autumn-catalog` turns their pricing into `autumn.config.ts`. `autumn-integrate` puts the first calls in their code. Never do either of those jobs yourself.\n\n## Ground rules\n\nThese apply the whole time, not just in one phase.\n\n- CLI-first: everything happens in `autumn.config.ts` and `atmn`. The only browser moments are signing in, or claiming a keyless org later. Never send the user to the dashboard to do the work.\n- Never invent a price, limit, or plan name. A missing number is a question, never a guess.\n- Push only after the user approves the pricing (Phase 4), or when they already told you to go ahead without a review.\n- Sandbox by default: `AUTUMN_SECRET_KEY` is the sandbox key. Don't touch production during setup.\n- Keys: check that a key exists by its name only. Never read, print, or ask the user to paste a key into the chat. Same for a keyless org's claim token. A one-time email code is not a key — that one does come through the chat.\n- Two tries max to fix any failing command, then stop and show the error.\n- Never run `atmn reset`, and never remove existing plans unless the user clearly asked.\n- If a step is already done, say so in one line (\"Already signed in — skipping login\") and move on.\n\n## How to talk\n\nYou are a competent engineer pairing with the user, not an installer wizard and not a marketer.\n\n- Simple, everyday words: \"plans\", \"what's included\", \"extra usage\". No jargon in chat — schema words like `consumable`, `prepaid`, `usage_based` stay in the config. If a simpler word says the same thing, use it.\n- 1–3 sentences per message. The pricing summary is the only large thing you send.\n- One message, one purpose: a status, a question, or the pricing summary.\n- Don't ask permission for harmless work — reading the repo, drafting the config, building the summary. Ask only for decisions and approvals.\n- Say what's about to happen before it does: one line before the browser opens, one before the push.\n- When you need input, ask at most three short numbered questions — the ones that unblock you, nothing more. If your platform has a built-in way to ask questions with options, use it. Never re-ask something they answered.\n- Always end a message with something: the question, what you're doing next, or that you're done.\n- Don't paste the config or command output into chat; name the file and summarize. Errors are the exception — quote those exactly.\n- If you're stuck, send three lines: what failed, the exact error, what you need to continue.\n- No emoji, no hype, no \"Great question\". Plain and concrete: \"Connected to Acme (sandbox).\"\n\n## Progress\n\nCopy this checklist into your first message and keep it up to date. If you skip an item, say why in one line.\n\n- [ ] 1 Skills installed; checked for an existing config, key, and pricing\n- [ ] 2 Connected to Autumn — `atmn` installed, signed in or keyless\n- [ ] 3 Got the user's pricing — rough plans and prices to build from\n- [ ] 4 Pricing modeled and approved (the `autumn-catalog` skill runs this part)\n- [ ] 5 Pushed to Autumn and verified\n- [ ] 6 Working in the app — one plan bought, one feature gated (the `autumn-integrate` skill runs this part)\n- [ ] 7 Account linked (keyless only — drop this line if they signed in)\n- [ ] 8 Done\n\nFor items 4 and 6, another skill owns the conversation and its checklist replaces this one for the duration — show theirs, not this one. Come back here when they're finished.\n\n## Phase 1 — Check the project (silent)\n\nDon't message the user yet — just find out where things stand.\n\nFour skills share this job, and they ship inside the `atmn` CLI: `atmn init` writes them next to the config and prints the `npx skills add <that folder> -y` line that registers them with your agent, and `atmn skills update` refreshes them when `push` or `pull` say they are older than the CLI. If any is missing here, that is Phase 2's job — never fetch them from anywhere else.\n\n`autumn-setup` (this file) is the flow. `autumn-catalog` is how to build the pricing, plus the exact `atmn` commands — load it in Phase 4. `autumn-integrate` is how the app calls Autumn — load it in Phase 6. `autumn-concepts` explains Autumn's objects — the other two load it themselves.\n\nThen check three things:\n\n- `autumn.config.ts` exists → Autumn is already set up here. Say so, treat the file as the truth, and use `autumn-catalog` for the changes; come back at Phase 5 (push) when there's something to push.\n- An `AUTUMN_SECRET_KEY` exists (shell env, `.env`, `.env.local`) → already connected; skip the connect step in Phase 2.\n- They already told you the pricing (their message, a pricing page, the README) → Phase 3 is a quick confirm, not a list of questions.\n\n## Phase 2 — Introduce and connect\n\nStart with two or three sentences: what's going to happen (connect this project to an Autumn org → write the pricing into `autumn.config.ts` → approve the pricing → push). Something like this, in your own words:\n\n> Setting up Autumn. I'll connect this project to an Autumn org, write your pricing into `autumn.config.ts`, and show it to you to approve before anything is pushed.\n\nThen:\n\n1. Run `atmn init` from the project root with the user's package manager (`bunx atmn init`, `pnpm exec atmn init`, `yarn atmn init`, `npx atmn init` — read it off the lockfile). Every `atmn …` command below means that run command. One command does the whole connect step: it adds `atmn` as a dependency, places the config in `autumn/` (its own package in a monorepo — it asks where, or takes `--path` and `--name`), pulls whatever the org already holds, and installs these skills beside the config. Each run prints what it did and, when it needs an answer, the flag to pass; run it again with the flag.\n2. Key already there → `init` says who it's connected to and moves on. Say so in one line.\n3. No key → `init` stops and asks how to connect. Ask the user the same thing, one question, two options, plain words:\n\n > Two ways to start: sign in to an Autumn account (I'll open a browser), or go keyless — I set up a sandbox for you right now and you link an account later. Which do you want?\n\n Always ask this one, even if the user told you to handle everything yourself — a keyless org has no owner until they link it, and that is their call, not yours. Pick keyless without asking only when there is genuinely nobody in the chat to answer (an unattended run), and say in one line that you did.\n4. Connect the way they chose, by running `init` again with the flag:\n\n - **Sign in** → say a browser window is coming, then `atmn init --login`. It opens the browser to sign in and create or pick an org, prints the sign-in URL, and waits — that's normal, it's not stuck. If the browser doesn't open (SSH, sandbox), that's not a failure: send the user the printed URL as-is and wait. Keys get saved to `.env`. Fails → retry once, then stop and tell the user what failed. Offer the ways forward — go keyless, or they copy their own sandbox key from app.useautumn.com into `.env` as `AUTUMN_SECRET_KEY` — and wait for their answer. Never switch to keyless on your own.\n - **Keyless** → `atmn init --keyless`. It provisions a sandbox org and saves its key to `.env` as `AUTUMN_SECRET_KEY`. No account, no browser, nothing for the user to do. The org is a real one: pushing, customers, and billing all work the same. It has no owner until Phase 7 links one, and the key doesn't change when that happens. `init` prints the deadline for linking; note it for Phase 7. For what provisioning and linking do underneath, and their limits, read `references/keyless.md`.\n\n5. `init` pulled the org's catalog into the config. If plans showed up (\"Pulled N entries\"), say so and go through them with the user before changing anything. A brand-new or keyless org is empty; the config is a scaffold for Phase 4 to fill.\n\nDone when `init` finished and you know whether the org already has plans. Say so in one line — including whether it's keyless, since that decides how you finish.\n\n## Phase 3 — Get a starting point\n\nYou need the pricing in the user's own words — not the details, just what to build.\n\n- They already told you (their message, a pricing page, the README) → repeat it back in one or two sentences and move on. If they gave you everything, ask nothing.\n- They haven't → ask what they're building and what they want to charge. A pricing page, or a competitor's page they like, is a full answer too.\n\nDon't dig into details here — what to ask, what to assume, and how to handle unclear pricing is `autumn-catalog`'s job, next phase.\n\nDone when you have rough plans and prices to build from.\n\n## Phase 4 — Model, write, approve\n\nLoad `autumn-catalog` now — from here it owns the conversation: its Shape/Fill flow, its checklist (shown instead of this skill's), its questions, its catalog display, and the approval. Your speaking rules above still apply to its questions.\n\nThis whole phase is the catalog skill's: structure agreed → config written and valid → pricing shown in its format → user approved. Only come back here when that's done; don't push yet.\n\n## Phase 5 — Push\n\nOnly after the yes. Push with `atmn` using `autumn-catalog`'s atmn reference — it has the exact commands, flags, and versioning choices. If the push asks for decisions (new version of a live plan, deleting things), bring them to the user; never decide alone. Check the push output shows every plan and feature made it — a push that errored is not done, and after two failed fixes you stop and show the error.\n\n## Phase 6 — Get it working in the app\n\nPricing in a sandbox is invisible. The user believes Autumn works when their own app creates a customer, blocks something, and takes money — so go there next, in one short pass, before anything else gets built.\n\nSay what's now live (plans and features, which org, sandbox) and where the config file is, then offer it:\n\n> Plans are live. Want me to wire up the basics now — customers created on signup, buying a plan, one feature gated / tracked — so you can see it running in your app?\n\nThey say no → skip to Phase 7. They say yes, or already asked for the integration up front → this phase runs. Either way it's their call; never start editing app code unasked.\n\nScope it before handing over. The first pass is the thinnest thing that proves the loop, and nothing else:\n\n- a customer created where the app already knows who the user is\n- buying a plan: the main free → paid move, so real money moves once\n- `check` and `track` on the **one** feature that matters most — ask which if it isn't obvious, don't gate everything\n\nAnything else — every remaining feature, entities, seats, billing controls, the billing page — waits for a second pass. Say that out loud when you scope, so the user doesn't read a small first pass as a small integration.\n\nLoad `autumn-integrate` now with that scope — from here it owns the conversation and the code: its order of operations, its checklist, its verification. Your speaking rules above still apply.\n\nCome back when its verification passes: a customer that exists in sandbox, a check that denied, usage that landed, a plan that attached.\n\n## Phase 7 — Link the account (keyless only)\n\nSkip this entirely if the user signed in — they already own their org.\n\nOffer once, right after they've seen the integration work, because that's when there's something worth logging in to look at:\n\n> Want to link this to your account? I’ll create a secure sign-in link so you can claim the org and open everything that just ran in the dashboard.\n\nNo → fine, drop it and say the offer stands whenever. Yes → ask which email to send the link to, run `atmn login --claim <email>`, and give them the returned claim URL. Autumn also emails that same URL — say so, naming the address, so they know where to find it later (\"Also sent to you@example.com\"). Whoever opens the link and signs in becomes the owner — the email is only where the link is delivered, so treat the link like the key and give it to the user alone. Linking makes them the owner: same key, same plans, same customers, plus the dashboard. An account that already exists works the same way; the new org is added beside their existing ones and becomes active after confirmation.\n\nUnclaimed orgs don't wait forever, so mention the window `init` printed when you offer — as a fact, not a threat. If linking fails, nothing is lost: the key keeps working and they can try again, or sign up normally and push the same config. What the commands do underneath: `references/keyless.md`.\n\n## Phase 8 — Done\n\nThree lines: what's live and working, where it lives (`autumn.config.ts`, and the handlers if Phase 6 ran), and the obvious next thing — the rest of the features, or going to production when they're ready. A linked or signed-in user can see it all at app.useautumn.com; a keyless user who declined can't, so don't send them there.\n\nThen stop. Don't keep building, don't tour the dashboard, don't deploy anything.",
|
|
27
27
|
references: [
|
|
28
28
|
{
|
|
29
29
|
path: "references/keyless.md",
|
|
@@ -36,9 +36,9 @@ export const SKILLS: readonly BundledSkill[] = [
|
|
|
36
36
|
name: "autumn-catalog",
|
|
37
37
|
description:
|
|
38
38
|
"Modeling a user's pricing into an Autumn catalog — deciding the structure (plans, variants, add-ons, licenses, credit systems, pooled balances) before writing config, then filling in the numbers. Use when the user describes their pricing or asks to model, change, or push a catalog.",
|
|
39
|
-
version: "2.0.
|
|
39
|
+
version: "2.0.17",
|
|
40
40
|
markdown:
|
|
41
|
-
'---\nname: autumn-catalog\ndescription: Modeling a user\'s pricing into an Autumn catalog — deciding the structure (plans, variants, add-ons, licenses, credit systems, pooled balances) before writing config, then filling in the numbers. Use when the user describes their pricing or asks to model, change, or push a catalog.\nversion: 2.0.16\n---\n\n# Catalog\n\nBefore using this skill, first load the `autumn-concepts` skill — it defines Autumn\'s data model — features, plans, plan items, balances — which every modeling decision builds on.\n\n## STRICT RULES — re-read before every config write\n\n1. **Amounts are in major units (e.g. dollars), never minor units (cents).** $180/month is `amount: 180`. $0.01 per credit is `amount: 0.01`. If any amount you wrote is 100× the user\'s number, it is wrong.\n2. **Never invent a price, limit, or plan name** — a missing number is a question.\n3. **One definition per real thing.** One feature per resource, one child plan per license pattern (parents customize their license, never get their own copy), one add-on per offer (sizes are tiers, not plans).\n\n**Building, or iterating on a live catalog?** What matters is whether customers are on these plans — not whether a config file exists. Still setting up (even across sessions, with a half-built `autumn.config.ts`) → the workflow below; edit the draft freely. Already running Autumn with customers, now changing prices/plans → that\'s an update with real stakes (versioning, migrations, grandfathering) — read `references/catalog-update.md` first. Unsure → check for customers (`atmn pull` / the org) or ask.\n\nTurning pricing into a catalog is two jobs:\n\n- **Shape** — decide the structure: which plans exist, what\'s a variant, what\'s an add-on, where balances live. Decided by relationships in their pricing, not by amounts.\n- **Fill** — put in the numbers and per-item details, then write and validate the config.\n\nDo Shape fully before Fill. Take numbers whenever the user mentions them, but never chase numbers during Shape — the one exception is "is this the same on every plan?", which is a structure question.\n\n## Progress (what the user sees)\n\nCopy this checklist into your first message and keep it up to date. It is the **only** structure the user ever sees — never say "step", "pass", "decide", or "fork" to them. If you skip an item, say why in one line.\n\n- [ ] 1 Your plans and prices\n- [ ] 2 What\'s included in each plan\n- [ ] 3 How billing behaves (signup, trials, limits)\n- [ ] 4 Licenses — paid seats, workspaces, projects (if any)\n- [ ] 5 Structure agreed\n- [ ] 6 Config written and checked\n\n## How to ask\n\n- One topic per message. Two questions at most, and only if both belong to that topic. Never mix topics in one message.\n- If one ambiguity changes which other questions apply, resolve it first before asking those.\n- Attach your guess to each question — "does the trial need a card? I\'d guess no" — a wrong guess gets corrected faster than a blank gets answered.\n- Assert the obvious instead of asking. "500 messages a month" resets monthly — state it as an assumption, don\'t ask. Questions are only for facts that change the structure and can\'t be guessed.\n- Skip anything they already told you. A good message to answer is a nod, not homework.\n- Never announce what you\'ll do next ("once I get those three, I\'ll restate…") — just work the current topic.\n- The restate (step 5) is the safety net: wrong assumptions get caught there cheaply, which is what makes fewer questions safe.\n\n## Shape: collect, then decide\n\nWork the four steps below in order, one at a time — each says when it\'s done. While collecting, make only the small calls each step allows; leave the big ones (marked ↦ Decide) for after.\n\n### Step 1 — Plans\n\n- What are the plans? ("Free, Pro $20/mo, Growth $50/mo")\n- Free tier? → a plan with no price that every new customer starts on automatically.\n- Anything bought *alongside* a plan rather than instead of it (packs, extra storage)? → note it ↦ Decide (add-on).\n- Enterprise tier? Ask. If it exists, model the base enterprise plan in the catalog, and tell the user: custom terms per customer (special prices, custom limits) are applied later when attaching, not modeled here.\n\nDone when you can list every plan they sell, including free, add-ons, and enterprise.\n\n### Step 2 — What each plan includes\n\nHave them describe what they charge for or limit, in their own words. Pick a type per feature:\n\n| They say | Feature type |\n|---|---|\n| "Pro has SSO" | boolean (on/off) |\n| "500 messages a month" | metered, resets |\n| "10 team members" | metered, no reset (held, not used up) |\n| "credits" / "tokens" / "wallet" | credit system — always, even if only one action uses it today. They will add more actions; a single mapped action is fine. Their app tracks the actions (chat, image), never the credit balance itself. |\n\nNote top-ups ("buy more when you run out", "auto-recharge") ↦ Decide (top-up placement).\n\n### Step 3 — How billing behaves\n\nThis step usually means explaining Autumn to the user in plain words. Do.\n\n- **Signup**: every new customer automatically gets the default plan — usually the free one. One default per group. A default can carry no prices at all — a "$0" plan with paid items (per-seat charges, prepaid packs) is a paid plan, not a default. If every plan bills something, there is no default; customers subscribe.\n- **Trials**: ask "does the trial need a card?" (guess from their motion — PLG usually no). Card → `free_trial` on the paid plan. No card → a **separate free trial plan** (`pro_trial`: no price, the paid plan\'s items, auto-enabled when everyone starts on it); the paid plan stays untouched, since a default plan can never be paid. For trial modeling details — trial-behavior on plans, read `references/plan.md` in the `autumn-concepts` skill.\n- **What is a plan attached to?** The customer, or each thing they own (workspace, project, site)? "Pro is $200 per workspace" → attached per entity. Pin this down — it changes everything downstream.\n- **Who uses each metered feature?** The customer as a whole, or each entity? If entities: one shared balance or separate ones? "Shared across…" → shared ↦ Decide (balances).\n\nDone when you know what attaches where, who consumes what, and how trials and signup work.\n\n### Step 4 — Licenses\n\nTriggered whenever the customer pays per unit of some entity — seats, workspaces, projects, sites, members: "each X is $10/month", "comes with 3 X". When you see one, always ask: **what does one X come with?** Never skip this because the user didn\'t say "seat". For modeling a license — the concept: child plan, license link, customize, read `references/licenses.md` in the `autumn-concepts` skill.\n\n- Nothing of its own ("$10 per seat", just a count) → a per-unit priced item on the plan. No entities. The common case.\n- The unit gets something of its own ("each seat gets 100 credits", "every workspace has its own allowance") → a **license**: a small plan of its own that the parent plan hands out per unit.\n- Units must be assigned, reassigned, or sit empty → also licenses. Rare — confirm they need it.\n\nFor deciding between a per-unit item, licenses, and entity-attached plans for a countable paid unit, read `references/fork-licenses.md`.\n\n### Before deciding: restate\n\nOnly after your questions are answered — never announce it in advance, and never restate facts nobody has confirmed yet. One short message: the plans, what\'s metered, what attaches where, who shares what. Let the user correct it. A wrong fact here is much cheaper than a wrong structure later.\n\nIf the user gave you everything up front and you asked nothing, skip the separate restate — the structure message (checklist item 5) does that job.\n\n## Decide\n\nResolve these with all facts in hand. Each has a default — when the facts genuinely don\'t settle it, show both options in one line each and ask.\n\n**Variant or separate plan?**\nA variant can change the price, swap items in or out, and change the trial — nothing else.\n\n- "Pro monthly / Pro annual, same features" → variant. (Annual usually still resets allowances monthly — billing and reset intervals are independent. Confirm.)\n- Volume buckets/tiers — one question decides: **is each bucket the subscription itself (→ a variant per bucket) or a purchase on top of one (→ a prepaid item)?**\n- Different features per tier → separate plans. One plan per tier is normal, not a smell.\n\nFor deciding whether volume buckets/tiers are variants of the plan or one prepaid volume-tiered item — the tells, the trap, when variants are forced, read `references/fork-variants.md`.\n\n**Add-on, or part of the plan?** Two independent questions: is the purchase priced/bundled per plan (→ item on each plan) or one offer across plans (→ one add-on plan, sizes as tiers on its prepaid item)? And does a plan exist at the level its balance is shared at (→ item there) or are all plans entity-attached (→ a customer-level add-on is forced)? Auto-recharge needs the prepaid item to exist — add it in Shape, it\'s structural.\n\nFor modeling packs, top-ups, or any purchase bought on top of a plan — add-on vs plan item, and what level it sits at, read `references/fork-addon.md`.\n\n**Where do balances and purchases live?**\nThe rule: **purchases and balance at the customer; usage tracking and caps at the entity.** Grants "shared across…" entities → pooled (`pooled: true` on the item); separate per-entity balances → no pooling; overage stays on the entity\'s plan either way.\n\nFor deciding where balances and purchases live — pooled grants, per-entity balances, customer-level packs, overage placement, read `references/fork-pooled.md`.\n\n**Groups?**\nCan one customer hold two plans at once from different lines (a support plan AND a sales plan)? → one group per line. Within a group, attaching a plan replaces the current one; that\'s what makes upgrades work.\n\n**One-off?**\n"Lifetime deal", "one-time pack" → a plan with a one-off price: single invoice, no subscription, balances never reset.\n\n## Check\n\nCompare the structure against the shapes in `references/cases.md`. If their pricing matches a known shape but your structure differs, either say why or fix it.\n\nShortcuts that are usually wrong — catch yourself before Show:\n\n| You\'re thinking | Check first |\n|---|---|\n| "seats + credits → licenses" | Are the credits per seat, or one shared pot? Shared → per-unit seats + pooled balance, no licenses. |\n| "annual pricing → separate plan" | Same features? → variant. |\n| "tiers → one plan with tiers" | Does overage or anything else differ per tier? → plan per tier. |\n| "they said credits but it\'s one action → plain meter" | Credits are always a credit system. |\n| "packs belong on the plan" | Are they shared across entities or plans? → add-on. |\n| "everyone starts on a Pro trial → trial + auto-enable on Pro" | A default plan can never be paid. → separate free `pro_trial` plan (Pro\'s items, no price, auto-enabled); Pro untouched. |\n| "several top-up sizes → one add-on plan per size" | Do the sizes differ only in quantity and price? → volume tiers on one prepaid item, one add-on plan. |\n| "the pack is priced per plan → an add-on per plan" | Per-plan pricing IS plan differentiation → a prepaid item on each base plan, no add-ons. Add-ons are for one offer shared across plans, or when no plan exists at the shared level. |\n| "the seat differs per plan → one seat plan per parent" | ONE child plan carrying the mainline take; each differing parent\'s license carries its own diff via `customize`. Never a `<parent>_seat` plan per parent. |\n\nFor checking the derived structure against known-good shapes, read `references/cases.md`.\n\n## Show\n\nPresent the structure in the "Showing the catalog" format below — the same one used for every catalog display, catalog inside a fenced code block. Numbers you don\'t have yet stay open, never invented: write the line without them ("AI messages per month — amount TBD"). Structure notes go in parentheses on the line they describe. The whole message:\n\n````\nHere\'s the structure I\'d build:\n\n```\nFeatures: AI credits (credit system — chat and image messages draw from it) · SSO (on/off)\n\nFree — no price, everyone starts here\n - 100 AI credits per month\nPro — $20/month, or annual (same features)\n - AI credits per month — amount TBD\n - SSO\nCredit pack (add-on) — price TBD, shared across all workspaces\n```\n\nI assumed: credits reset monthly, no rollover. Anything wrong?\n````\n\nList every assumption. Get a clear yes — "sounds good" without reading is not a yes. But if the user already told you to go ahead without review ("no need to ask", "just build it"), show the structure and keep going — don\'t stop to wait. If a late fact changes the structure, redo the affected decision, update the structure, and show what changed in one line.\n\n## Fill\n\nStructure agreed — now finish it. Four moves, in order.\n\n**1 — Fill in what\'s known.** Everything the user already said goes straight into the draft. Never re-ask a confirmed fact.\n\n**2 — Ask for missing essentials.** Values with no sane default: base prices, included amounts, per-unit prices, tier boundaries, trial length. Never invent one — a missing number is a question. Batch per the how-to-ask rules.\n\n**3 — Sweep the options.** Ask each of these **once for the whole catalog**, in plain words — never item by item. The answer distributes to every item it touches ("carry over on both plans, or just Growth?" only if they hint at a difference). Raise a bucket only when the structure makes it relevant; skip anything already answered.\n\n- **Carry-over** — any allowance that resets: "Should unused messages carry over month to month, or reset clean?"\n- **Running out** — any metered feature: "When they run out — hard stop, or keep going and bill the extra?" (often settled in Shape; skip if so)\n- **Top-ups** — credits present or buying-more mentioned: "Can they buy more before the reset?" → a one-off prepaid item\n- **Guardrails** — any plan with overage or heavy usage: "Any caps on how fast or how far usage can run — like a daily limit, or a ceiling on overage? Want customers warned as they approach limits?" → plan-level billing controls\n- **Anything else on/off** — always, it\'s cheap: "Any other on/off differences between plans — SSO, priority support, API access?"\n\nThe sweep exists so the user hears what\'s configurable without being marched through every item. Behind it, check every knob yourself — this list is internal, never show it:\n\n- per plan: base price · trial (length, unit, card — all explicit) · default plan · group · billing controls (guardrails answered → `billingControls` on the plan)\n- per item: billing method · included · price or tiers (tier behavior explicit) · reset · rollover · pooled (if Shape chose shared balances) · purchase caps · the one-off item auto-recharge needs\n\nLanding a guardrail answer means picking the right control — windowed cap vs overage ceiling vs alert vs allow-past-balance vs auto-recharge are different knobs with different fields. What each one is, the three overage knobs, and the plan→customer inheritance are the `autumn-concepts` skill\'s billing-controls reference — read it before writing `billingControls`. The flow rules here:\n\n- Plan-level controls are defaults every subscriber inherits — the right home for anything true of the whole plan ("free users max 20 emails/day"). Per-customer exceptions are a billing/customer operation, not catalog work.\n- A cap stated alongside an allowance ("1,000 a month but never more than 20 a day") is a usage limit on the plan, not a second item or a smaller allowance.\n- "Track it but don\'t bill it" / "let them run over, we\'ll invoice manually" → overage knobs on the plan, not a $0 price.\n- Auto-recharge needs its one-off prepaid item (already on the per-item list) AND the `autoTopups` control.\n\n**4 — Propose, then finalize.** One message: the full catalog in the format below, then "I assumed:" listing every knob you defaulted. Fold corrections in. Then write the config — and before saving, re-read every amount in it: dollars, never cents ($600 is `600`, not `60000`). Validate with `atmn push` (a preview; nothing is applied until `--yes`), fix what it flags, and show the final catalog — same format, no assumptions list. **Done means the config is written and valid — a summary is not done.**\n\n### Showing the catalog\n\nUse **exactly this format** every time you show the catalog — the Show structure message, the Fill proposal, and the done message alike. Never a markdown table, never a different layout per message. Send it as a fenced code block (```) so the indentation survives markdown rendering — plan names on bare lines otherwise get folded into the previous plan\'s list. It\'s the same grammar the dashboard renders. Features first with their kind, then plans, one line per item:\n\n```\nFeatures: AI messages (usage, resets) · Seats (held, not used up) · Credits (credit system — 1 message = 1 credit) · SSO (on/off)\n\nPro — $20/month\n - 500 AI messages per month\n · unused carry over, up to 500, for 1 month\n - 500 AI messages per month, then $0.01 per message\n - $10 per 1,000 credits\n - 5,000 credits for $50 per month\n - 3 seats included, then $10 per seat\n - $18 - $15 per seat\n - Unlimited projects\n - SSO\n - 100 credits per seat per month\nTeam — $500/month\n - 5 seats included, then $40 per seat per month\n each seat gets:\n · 100 summaries per month\n · SSO\nCredit pack (add-on) — $10 for 1,000 credits, buy anytime\n```\n\nThe Features line names every feature and its kind in plain words: `(usage, resets)` for consumable meters, `(held, not used up)` for non-consumable ones like seats, `(credit system — …)` with its action mappings, `(on/off)` for boolean. Item lines, top to bottom: plain allowance · allowance with overage · pure usage price (per billing unit) · prepaid bucket · included + prepaid per-unit · tiered rate shown first-to-last · unlimited · boolean (name only, never "enabled") · per-entity grant · one-off add-on. Numbers get commas; "then …" says what happens after the included runs out; annual variants go inline ("or $200/year — messages still reset monthly").\n\nConfigured item properties — carry-over, purchase caps, top-up behavior — are never their own `-` lines: indent them under the item they belong to as `·` lines, one behavior each, so the hierarchy is visible. Only show what\'s configured; defaults (like usage simply stopping when no overage price is set) get no line.\n\nBilling controls follow the same rule: `·` lines under the item they guard, in plain words — `· max 200 per day` · `· overage capped at 20% over` · `· overage tracked, not billed` · `· warned at 80%` · `· auto-buys 1,000 credits when below 100`. Never the schema names (usage_limits, spend_limits) in user-facing text.\n\n### Config gotchas\n\n- Amounts are plain dollars everywhere — base prices, tier `flatAmount`s, unit prices: $20 is `20`, never `2000`, and a $100 tier is `flatAmount: 100`, never `10000`. Re-check every number before writing; cents is the most common wrong config.\n- A default/auto-enabled plan can\'t be paid: no base price, no paid items.\n- A prepaid quantity **includes** the included amount, and so does each tier\'s `to` — the first tier\'s `to` must exceed `included`.\n- `billingUnits` rounds usage **up** when billing.\n- Set explicitly, never lean on defaults: `billingMethod` and `interval` on every item price, `tierBehavior` on tiered prices, and every trial field (`durationLength`, `durationType`, `cardRequired`, `onEnd`). Explicit defaults cause no spurious diffs.\n- Volume tiers charge the flat amount of the reached tier and are prepaid-only; graduated (the default) sums across brackets.\n- Rollover needs a resetting allowance; `max` and `maxPercentage` are mutually exclusive; `expiryDurationType` is required.\n- `billingControls` is a plain object on the plan with camelCase fields like the rest of the config (`featureId`, `overageLimit`); each control list replaces wholesale on update.\n- Pooled balances are config: `pooled: true` on the entity plan\'s item. Concluding "shared across workspaces" in Shape and then omitting the flag is the classic miss.\n- Pooled grant + overage = two items on the plan: the pooled grant carries no price; a separate usage-priced item (`included: 0`) carries the overage. A pooled item can\'t itself be usage-priced.\n- Don\'t write `proration` — leave it out and take server defaults.\n- Trial end behavior is `freeTrial.onEnd`: `"bill"` (default) charges when the trial ends, `"revert"` expires it and restores the previous plan.\n- Every plan row carries `versionSlug` and `active`, and every variant row and license link `versionSlug`. A plan\'s rows are its versions — exactly one `active: true` — and a version row left out of `plans` is deleted. How rows express versions, renames and drafts: `references/atmn.md`.\n\nThe config uses the builders `feature`, `plan`, `variant`, `license` as plain function calls with object arguments; items are plain objects inside a plan, and the file\'s default export is `atmn({...})` naming every collection. Never guess other functions or fields; the full shapes are in `references/atmn.md`.\n\n```ts\nimport { atmn, feature, plan } from "atmn";\n\nexport const credits = feature({\n featureId: "credits",\n name: "Credits",\n type: "credit_system",\n creditSchema: [{ meteredFeatureId: "messages", creditCost: 1 }],\n});\n\nexport const pro = plan({\n planId: "pro",\n versionSlug: "v1",\n active: true,\n name: "Pro",\n price: { amount: 20, interval: "month" },\n items: [\n { featureId: credits.featureId, included: 500, reset: { interval: "month" } },\n ],\n});\n\nexport default atmn({ features: [credits], plans: [pro] });\n```\n\nPattern deep-dives, split one file per pattern under `references/` — read the matching one when filling that pattern\'s details:\n\nFor usage overage pricing, read `references/usage-based-pricing.md`.\nFor prepaid quantities (seats, packs, buckets), read `references/prepaid-pricing.md`.\nFor volume-tiered prices, read `references/volume-based-tiers.md`.\nFor $X per unit, read `references/per-unit-pricing.md`.\nFor billing vs reset intervals, read `references/recurring.md`.\nFor one-off purchases / top-ups, read `references/one-off-purchases.md`.\nFor auto-recharge, read `references/auto-top-ups.md`.\nFor carry-over, read `references/rollovers.md`.\nFor trial details, read `references/trials.md`.\nFor entity plans and license attach flows, read `references/entity-plans.md`.\nFor credit schemas and mappings, read `references/credit-systems.md`.\nFor default plans / auto-enable, read `references/free-plans.md`.\nFor add-on balance stacking, read `references/add-ons.md`.\nFor what variants can change, read `references/plan-variants.md`.\n\n## Conduct\n\n- In an existing config, match its patterns: if sibling plans carry their prepaid purchases as items, the new plan does too — don\'t introduce a different structure for the same kind of thing.\n- Stable lowercase IDs with underscores: `pro_plan`, `chat_messages`.\n- `entityFeatureId` is deprecated. Never mention or use it unless the user\'s existing config already has it.\n- Per-unit pricing pairs a base fee with the per-unit item ("$X/seat" plans still have a base price, even $0).\n- Speak plainly: "plans", "what\'s included", "extra usage". Schema words stay in the config — say "carry over" not "rollover", "shared across workspaces" not "pooled", "paid upfront" / "billed at month end" not "prepaid" / "usage_based".\n- Never volunteer what Autumn can or can\'t do. Don\'t offer options Autumn can\'t model, and don\'t explain limitations unprompted — only address one when the user directly asks to model that specific thing, and even then lead with the closest thing that works.\n- Start simple: the most important features first, confirm before adding more.\n\nBefore finishing: re-check the STRICT RULES at the top against the config you wrote.\n\n## Catalog operations\n\nFor using atmn, autumn.config.ts, or headless push flows, read `references/atmn.md`.\n\nFor changing an existing catalog: previewing, versioning, migrations, variant propagation, read `references/catalog-update.md`.\n\nFor creating or changing coupons, promo codes, feature grants, or referral programs, read `references/rewards.md`.',
|
|
41
|
+
'---\nname: autumn-catalog\ndescription: Modeling a user\'s pricing into an Autumn catalog — deciding the structure (plans, variants, add-ons, licenses, credit systems, pooled balances) before writing config, then filling in the numbers. Use when the user describes their pricing or asks to model, change, or push a catalog.\nversion: 2.0.17\n---\n\n# Catalog\n\nBefore using this skill, first load the `autumn-concepts` skill — it defines Autumn\'s data model — features, plans, plan items, balances — which every modeling decision builds on.\n\n## STRICT RULES — re-read before every config write\n\n1. **Amounts are in major units (e.g. dollars), never minor units (cents).** $180/month is `amount: 180`. $0.01 per credit is `amount: 0.01`. If any amount you wrote is 100× the user\'s number, it is wrong.\n2. **Never invent a price, limit, or plan name** — a missing number is a question.\n3. **One definition per real thing.** One feature per resource, one child plan per license pattern (parents customize their license, never get their own copy), one add-on per offer (sizes are tiers, not plans).\n\n**Building, or iterating on a live catalog?** What matters is whether customers are on these plans — not whether a config file exists. Still setting up (even across sessions, with a half-built `autumn.config.ts`) → the workflow below; edit the draft freely. Already running Autumn with customers, now changing prices/plans → that\'s an update with real stakes (versioning, migrations, grandfathering) — read `references/catalog-update.md` first. Unsure → check for customers (`atmn pull` / the org) or ask.\n\nTurning pricing into a catalog is two jobs:\n\n- **Shape** — decide the structure: which plans exist, what\'s a variant, what\'s an add-on, where balances live. Decided by relationships in their pricing, not by amounts.\n- **Fill** — put in the numbers and per-item details, then write and validate the config.\n\nDo Shape fully before Fill. Take numbers whenever the user mentions them, but never chase numbers during Shape — the one exception is "is this the same on every plan?", which is a structure question.\n\n## Progress (what the user sees)\n\nCopy this checklist into your first message and keep it up to date. It is the **only** structure the user ever sees — never say "step", "pass", "decide", or "fork" to them. If you skip an item, say why in one line.\n\n- [ ] 1 Your plans and prices\n- [ ] 2 What\'s included in each plan\n- [ ] 3 How billing behaves (signup, trials, limits)\n- [ ] 4 Licenses — paid seats, workspaces, projects (if any)\n- [ ] 5 Structure agreed\n- [ ] 6 Config written and checked\n\n## How to ask\n\n- One topic per message. Two questions at most, and only if both belong to that topic. Never mix topics in one message.\n- If one ambiguity changes which other questions apply, resolve it first before asking those.\n- Attach your guess to each question — "does the trial need a card? I\'d guess no" — a wrong guess gets corrected faster than a blank gets answered.\n- Assert the obvious instead of asking. "500 messages a month" resets monthly — state it as an assumption, don\'t ask. Questions are only for facts that change the structure and can\'t be guessed.\n- Skip anything they already told you. A good message to answer is a nod, not homework.\n- Never announce what you\'ll do next ("once I get those three, I\'ll restate…") — just work the current topic.\n- The restate (step 5) is the safety net: wrong assumptions get caught there cheaply, which is what makes fewer questions safe.\n\n## Shape: collect, then decide\n\nWork the four steps below in order, one at a time — each says when it\'s done. While collecting, make only the small calls each step allows; leave the big ones (marked ↦ Decide) for after.\n\n### Step 1 — Plans\n\n- What are the plans? ("Free, Pro $20/mo, Growth $50/mo")\n- Free tier? → a plan with no price that every new customer starts on automatically.\n- Anything bought *alongside* a plan rather than instead of it (packs, extra storage)? → note it ↦ Decide (add-on).\n- Enterprise tier? Ask. If it exists, model the base enterprise plan in the catalog, and tell the user: custom terms per customer (special prices, custom limits) are applied later when attaching, not modeled here.\n\nDone when you can list every plan they sell, including free, add-ons, and enterprise.\n\n### Step 2 — What each plan includes\n\nHave them describe what they charge for or limit, in their own words. Pick a type per feature:\n\n| They say | Feature type |\n|---|---|\n| "Pro has SSO" | boolean (on/off) |\n| "500 messages a month" | metered, resets |\n| "10 team members" | metered, no reset (held, not used up) |\n| "credits" / "tokens" / "wallet" | credit system — always, even if only one action uses it today. They will add more actions; a single mapped action is fine. Their app tracks the actions (chat, image), never the credit balance itself. |\n\nNote top-ups ("buy more when you run out", "auto-recharge") ↦ Decide (top-up placement).\n\n### Step 3 — How billing behaves\n\nThis step usually means explaining Autumn to the user in plain words. Do.\n\n- **Signup**: every new customer automatically gets the default plan — usually the free one. One default per group. A default can carry no prices at all — a "$0" plan with paid items (per-seat charges, prepaid packs) is a paid plan, not a default. If every plan bills something, there is no default; customers subscribe.\n- **Trials**: ask "does the trial need a card?" (guess from their motion — PLG usually no). Card → `free_trial` on the paid plan. No card → a **separate free trial plan** (`pro_trial`: no price, the paid plan\'s items, auto-enabled when everyone starts on it); the paid plan stays untouched, since a default plan can never be paid. For trial modeling details — trial-behavior on plans, read `references/plan.md` in the `autumn-concepts` skill.\n- **What is a plan attached to?** The customer, or each thing they own (workspace, project, site)? "Pro is $200 per workspace" → attached per entity. Pin this down — it changes everything downstream.\n- **Who uses each metered feature?** The customer as a whole, or each entity? If entities: one shared balance or separate ones? "Shared across…" → shared ↦ Decide (balances).\n\nDone when you know what attaches where, who consumes what, and how trials and signup work.\n\n### Step 4 — Licenses\n\nTriggered whenever the customer pays per unit of some entity — seats, workspaces, projects, sites, members: "each X is $10/month", "comes with 3 X". When you see one, always ask: **what does one X come with?** Never skip this because the user didn\'t say "seat". For modeling a license — the concept: child plan, license link, customize, read `references/licenses.md` in the `autumn-concepts` skill.\n\n- Nothing of its own ("$10 per seat", just a count) → a per-unit priced item on the plan. No entities. The common case.\n- The unit gets something of its own ("each seat gets 100 credits", "every workspace has its own allowance") → a **license**: a small plan of its own that the parent plan hands out per unit.\n- Units must be assigned, reassigned, or sit empty → also licenses. Rare — confirm they need it.\n\nFor deciding between a per-unit item, licenses, and entity-attached plans for a countable paid unit, read `references/fork-licenses.md`.\n\n### Before deciding: restate\n\nOnly after your questions are answered — never announce it in advance, and never restate facts nobody has confirmed yet. One short message: the plans, what\'s metered, what attaches where, who shares what. Let the user correct it. A wrong fact here is much cheaper than a wrong structure later.\n\nIf the user gave you everything up front and you asked nothing, skip the separate restate — the structure message (checklist item 5) does that job.\n\n## Decide\n\nResolve these with all facts in hand. Each has a default — when the facts genuinely don\'t settle it, show both options in one line each and ask.\n\n**Variant or separate plan?**\nA variant can change the price, swap items in or out, and change the trial — nothing else.\n\n- "Pro monthly / Pro annual, same features" → variant. (Annual usually still resets allowances monthly — billing and reset intervals are independent. Confirm.)\n- Volume buckets/tiers — one question decides: **is each bucket the subscription itself (→ a variant per bucket) or a purchase on top of one (→ a prepaid item)?**\n- Different features per tier → separate plans. One plan per tier is normal, not a smell.\n\nFor deciding whether volume buckets/tiers are variants of the plan or one prepaid volume-tiered item — the tells, the trap, when variants are forced, read `references/fork-variants.md`.\n\n**Add-on, or part of the plan?** Two independent questions: is the purchase priced/bundled per plan (→ item on each plan) or one offer across plans (→ one add-on plan, sizes as tiers on its prepaid item)? And does a plan exist at the level its balance is shared at (→ item there) or are all plans entity-attached (→ a customer-level add-on is forced)? Auto-recharge needs the prepaid item to exist — add it in Shape, it\'s structural.\n\nFor modeling packs, top-ups, or any purchase bought on top of a plan — add-on vs plan item, and what level it sits at, read `references/fork-addon.md`.\n\n**Where do balances and purchases live?**\nThe rule: **purchases and balance at the customer; usage tracking and caps at the entity.** Grants "shared across…" entities → pooled (`pooled: true` on the item); separate per-entity balances → no pooling; overage stays on the entity\'s plan either way.\n\nFor deciding where balances and purchases live — pooled grants, per-entity balances, customer-level packs, overage placement, read `references/fork-pooled.md`.\n\n**Groups?**\nCan one customer hold two plans at once from different lines (a support plan AND a sales plan)? → one group per line. Within a group, attaching a plan replaces the current one; that\'s what makes upgrades work.\n\n**One-off?**\n"Lifetime deal", "one-time pack" → a plan with a one-off price: single invoice, no subscription, balances never reset.\n\n## Check\n\nCompare the structure against the shapes in `references/cases.md`. If their pricing matches a known shape but your structure differs, either say why or fix it.\n\nShortcuts that are usually wrong — catch yourself before Show:\n\n| You\'re thinking | Check first |\n|---|---|\n| "seats + credits → licenses" | Are the credits per seat, or one shared pot? Shared → per-unit seats + pooled balance, no licenses. |\n| "annual pricing → separate plan" | Same features? → variant. |\n| "tiers → one plan with tiers" | Does overage or anything else differ per tier? → plan per tier. |\n| "they said credits but it\'s one action → plain meter" | Credits are always a credit system. |\n| "packs belong on the plan" | Are they shared across entities or plans? → add-on. |\n| "everyone starts on a Pro trial → trial + auto-enable on Pro" | A default plan can never be paid. → separate free `pro_trial` plan (Pro\'s items, no price, auto-enabled); Pro untouched. |\n| "several top-up sizes → one add-on plan per size" | Do the sizes differ only in quantity and price? → volume tiers on one prepaid item, one add-on plan. |\n| "the pack is priced per plan → an add-on per plan" | Per-plan pricing IS plan differentiation → a prepaid item on each base plan, no add-ons. Add-ons are for one offer shared across plans, or when no plan exists at the shared level. |\n| "the seat differs per plan → one seat plan per parent" | ONE child plan carrying the mainline take; each differing parent\'s license carries its own diff via `customize`. Never a `<parent>_seat` plan per parent. |\n\nFor checking the derived structure against known-good shapes, read `references/cases.md`.\n\n## Show\n\nPresent the structure in the "Showing the catalog" format below — the same one used for every catalog display, catalog inside a fenced code block. Numbers you don\'t have yet stay open, never invented: write the line without them ("AI messages per month — amount TBD"). Structure notes go in parentheses on the line they describe. The whole message:\n\n````\nHere\'s the structure I\'d build:\n\n```\nFeatures: AI credits (credit system — chat and image messages draw from it) · SSO (on/off)\n\nFree — no price, everyone starts here\n - 100 AI credits per month\nPro — $20/month, or annual (same features)\n - AI credits per month — amount TBD\n - SSO\nCredit pack (add-on) — price TBD, shared across all workspaces\n```\n\nI assumed: credits reset monthly, no rollover. Anything wrong?\n````\n\nList every assumption. Get a clear yes — "sounds good" without reading is not a yes. But if the user already told you to go ahead without review ("no need to ask", "just build it"), show the structure and keep going — don\'t stop to wait. If a late fact changes the structure, redo the affected decision, update the structure, and show what changed in one line.\n\n## Fill\n\nStructure agreed — now finish it. Four moves, in order.\n\n**1 — Fill in what\'s known.** Everything the user already said goes straight into the draft. Never re-ask a confirmed fact.\n\n**2 — Ask for missing essentials.** Values with no sane default: base prices, included amounts, per-unit prices, tier boundaries, trial length. Never invent one — a missing number is a question. Batch per the how-to-ask rules.\n\n**3 — Sweep the options.** Ask each of these **once for the whole catalog**, in plain words — never item by item. The answer distributes to every item it touches ("carry over on both plans, or just Growth?" only if they hint at a difference). Raise a bucket only when the structure makes it relevant; skip anything already answered.\n\n- **Carry-over** — any allowance that resets: "Should unused messages carry over month to month, or reset clean?"\n- **Running out** — any metered feature: "When they run out — hard stop, or keep going and bill the extra?" (often settled in Shape; skip if so)\n- **Top-ups** — credits present or buying-more mentioned: "Can they buy more before the reset?" → a one-off prepaid item\n- **Guardrails** — any plan with overage or heavy usage: "Any caps on how fast or how far usage can run — like a daily limit, or a ceiling on overage? Want customers warned as they approach limits?" → plan-level billing controls\n- **Anything else on/off** — always, it\'s cheap: "Any other on/off differences between plans — SSO, priority support, API access?"\n\nThe sweep exists so the user hears what\'s configurable without being marched through every item. Behind it, check every knob yourself — this list is internal, never show it:\n\n- per plan: base price · trial (length, unit, card — all explicit) · default plan · group · billing controls (guardrails answered → `billingControls` on the plan)\n- per item: billing method · included · price or tiers (tier behavior explicit) · reset · rollover · pooled (if Shape chose shared balances) · purchase caps · the one-off item auto-recharge needs\n\nLanding a guardrail answer means picking the right control — windowed cap vs overage ceiling vs alert vs allow-past-balance vs auto-recharge are different knobs with different fields. What each one is, the three overage knobs, and the plan→customer inheritance are the `autumn-concepts` skill\'s billing-controls reference — read it before writing `billingControls`. The flow rules here:\n\n- Plan-level controls are defaults every subscriber inherits — the right home for anything true of the whole plan ("free users max 20 emails/day"). Per-customer exceptions are a billing/customer operation, not catalog work.\n- A cap stated alongside an allowance ("1,000 a month but never more than 20 a day") is a usage limit on the plan, not a second item or a smaller allowance.\n- "Track it but don\'t bill it" / "let them run over, we\'ll invoice manually" → overage knobs on the plan, not a $0 price.\n- Auto-recharge needs its one-off prepaid item (already on the per-item list) AND the `autoTopups` control.\n\n**4 — Propose, then finalize.** One message: the full catalog in the format below, then "I assumed:" listing every knob you defaulted. Fold corrections in. Then write the config — and before saving, re-read every amount in it: dollars, never cents ($600 is `600`, not `60000`). Validate with `atmn push` (a preview; nothing is applied until `--yes`), fix what it flags, and show the final catalog — same format, no assumptions list. **Done means the config is written and valid — a summary is not done.**\n\n### Showing the catalog\n\nUse **exactly this format** every time you show the catalog — the Show structure message, the Fill proposal, and the done message alike. Never a markdown table, never a different layout per message. Send it as a fenced code block (```) so the indentation survives markdown rendering — plan names on bare lines otherwise get folded into the previous plan\'s list. It\'s the same grammar the dashboard renders. Features first with their kind, then plans, one line per item:\n\n```\nFeatures: AI messages (usage, resets) · Seats (held, not used up) · Credits (credit system — 1 message = 1 credit) · SSO (on/off)\n\nPro — $20/month\n - 500 AI messages per month\n · unused carry over, up to 500, for 1 month\n - 500 AI messages per month, then $0.01 per message\n - $10 per 1,000 credits\n - 5,000 credits for $50 per month\n - 3 seats included, then $10 per seat\n - $18 - $15 per seat\n - Unlimited projects\n - SSO\n - 100 credits per seat per month\nTeam — $500/month\n - 5 seats included, then $40 per seat per month\n each seat gets:\n · 100 summaries per month\n · SSO\nCredit pack (add-on) — $10 for 1,000 credits, buy anytime\n```\n\nThe Features line names every feature and its kind in plain words: `(usage, resets)` for consumable meters, `(held, not used up)` for non-consumable ones like seats, `(credit system — …)` with its action mappings, `(on/off)` for boolean. Item lines, top to bottom: plain allowance · allowance with overage · pure usage price (per billing unit) · prepaid bucket · included + prepaid per-unit · tiered rate shown first-to-last · unlimited · boolean (name only, never "enabled") · per-entity grant · one-off add-on. Numbers get commas; "then …" says what happens after the included runs out; annual variants go inline ("or $200/year — messages still reset monthly").\n\nConfigured item properties — carry-over, purchase caps, top-up behavior — are never their own `-` lines: indent them under the item they belong to as `·` lines, one behavior each, so the hierarchy is visible. Only show what\'s configured; defaults (like usage simply stopping when no overage price is set) get no line.\n\nBilling controls follow the same rule: `·` lines under the item they guard, in plain words — `· max 200 per day` · `· overage capped at 20% over` · `· overage tracked, not billed` · `· warned at 80%` · `· auto-buys 1,000 credits when below 100`. Never the schema names (usage_limits, spend_limits) in user-facing text.\n\n### Config gotchas\n\n- Amounts are plain dollars everywhere — base prices, tier `flatAmount`s, unit prices: $20 is `20`, never `2000`, and a $100 tier is `flatAmount: 100`, never `10000`. Re-check every number before writing; cents is the most common wrong config.\n- A default/auto-enabled plan can\'t be paid: no base price, no paid items.\n- A prepaid quantity **includes** the included amount, and so does each tier\'s `to` — the first tier\'s `to` must exceed `included`.\n- `billingUnits` rounds usage **up** when billing.\n- Set explicitly, never lean on defaults: `billingMethod` and `interval` on every item price, `tierBehavior` on tiered prices, and every trial field (`durationLength`, `durationType`, `cardRequired`, `onEnd`). Explicit defaults cause no spurious diffs.\n- Volume tiers charge the flat amount of the reached tier and are prepaid-only; graduated (the default) sums across brackets.\n- Rollover needs a resetting allowance; `max` and `maxPercentage` are mutually exclusive; `expiryDurationType` is required.\n- `billingControls` is a plain object on the plan with camelCase fields like the rest of the config (`featureId`, `overageLimit`); each control list replaces wholesale on update.\n- Pooled balances are config: `pooled: true` on the entity plan\'s item. Concluding "shared across workspaces" in Shape and then omitting the flag is the classic miss.\n- Pooled grant + overage = two items on the plan: the pooled grant carries no price; a separate usage-priced item (`included: 0`) carries the overage. A pooled item can\'t itself be usage-priced.\n- Don\'t write `proration` — leave it out and take server defaults.\n- Trial end behavior is `freeTrial.onEnd`: `"bill"` (default) charges when the trial ends, `"revert"` expires it and restores the previous plan.\n- Every plan row carries `versionSlug` and `active`, and every variant row and license link `versionSlug`. A plan\'s rows are its versions — exactly one `active: true` — and a version row left out of `plans` is deleted. How rows express versions, renames and drafts: `references/atmn.md`.\n\nThe config uses the builders `feature`, `plan`, `variant`, `license` as plain function calls with object arguments; items are plain objects inside a plan, and the file\'s default export is `atmn({...})` naming every collection. Never guess other functions or fields; the full shapes are in `references/atmn.md`.\n\n```ts\nimport { atmn, feature, plan } from "atmn";\n\nexport const credits = feature({\n featureId: "credits",\n name: "Credits",\n type: "credit_system",\n creditSchema: [{ meteredFeatureId: "messages", creditCost: 1 }],\n});\n\nexport const pro = plan({\n planId: "pro",\n versionSlug: "v1",\n active: true,\n name: "Pro",\n price: { amount: 20, interval: "month" },\n items: [\n { featureId: credits.featureId, included: 500, reset: { interval: "month" } },\n ],\n});\n\nexport default atmn({ features: [credits], plans: [pro] });\n```\n\nPattern deep-dives, split one file per pattern under `references/` — read the matching one when filling that pattern\'s details:\n\nFor usage overage pricing, read `references/usage-based-pricing.md`.\nFor prepaid quantities (seats, packs, buckets), read `references/prepaid-pricing.md`.\nFor volume-tiered prices, read `references/volume-based-tiers.md`.\nFor $X per unit, read `references/per-unit-pricing.md`.\nFor billing vs reset intervals, read `references/recurring.md`.\nFor one-off purchases / top-ups, read `references/one-off-purchases.md`.\nFor auto-recharge, read `references/auto-top-ups.md`.\nFor carry-over, read `references/rollovers.md`.\nFor trial details, read `references/trials.md`.\nFor entity plans and license attach flows, read `references/entity-plans.md`.\nFor credit schemas and mappings, read `references/credit-systems.md`.\nFor default plans / auto-enable, read `references/free-plans.md`.\nFor add-on balance stacking, read `references/add-ons.md`.\nFor what variants can change, read `references/plan-variants.md`.\n\n## Conduct\n\n- In an existing config, match its patterns: if sibling plans carry their prepaid purchases as items, the new plan does too — don\'t introduce a different structure for the same kind of thing.\n- Stable lowercase IDs with underscores: `pro_plan`, `chat_messages`.\n- `entityFeatureId` is deprecated. Never mention or use it unless the user\'s existing config already has it.\n- Per-unit pricing pairs a base fee with the per-unit item ("$X/seat" plans still have a base price, even $0).\n- Speak plainly: "plans", "what\'s included", "extra usage". Schema words stay in the config — say "carry over" not "rollover", "shared across workspaces" not "pooled", "paid upfront" / "billed at month end" not "prepaid" / "usage_based".\n- Never volunteer what Autumn can or can\'t do. Don\'t offer options Autumn can\'t model, and don\'t explain limitations unprompted — only address one when the user directly asks to model that specific thing, and even then lead with the closest thing that works.\n- Start simple: the most important features first, confirm before adding more.\n\nBefore finishing: re-check the STRICT RULES at the top against the config you wrote.\n\n## Catalog operations\n\nFor using atmn, autumn.config.ts, or headless push flows, read `references/atmn.md`.\n\nFor changing an existing catalog: previewing, versioning, migrations, variant propagation, read `references/catalog-update.md`.\n\nFor creating or changing coupons, promo codes, feature grants, or referral programs, read `references/rewards.md`.',
|
|
42
42
|
references: [
|
|
43
43
|
{
|
|
44
44
|
path: "references/usage-based-pricing.md",
|
|
@@ -156,9 +156,9 @@ export const SKILLS: readonly BundledSkill[] = [
|
|
|
156
156
|
name: "autumn-integrate",
|
|
157
157
|
description:
|
|
158
158
|
"Integrating Autumn into an app's backend — creating customers, billing flows (attach, checkout, upgrade, cancel), gating features with check, recording usage with track, and exposing billing data to the frontend. Use when the user asks to integrate Autumn, add billing/payments to their app, gate features, meter usage, or build checkout/upgrade flows. Requires a pushed catalog; use autumn-catalog first if plans don't exist yet.",
|
|
159
|
-
version: "2.0.
|
|
159
|
+
version: "2.0.17",
|
|
160
160
|
markdown:
|
|
161
|
-
"---\nname: autumn-integrate\ndescription: Integrating Autumn into an app's backend — creating customers, billing flows (attach, checkout, upgrade, cancel), gating features with check, recording usage with track, and exposing billing data to the frontend. Use when the user asks to integrate Autumn, add billing/payments to their app, gate features, meter usage, or build checkout/upgrade flows. Requires a pushed catalog; use autumn-catalog first if plans don't exist yet.\nversion: 2.0.16\n---\n\n# Integrate\n\nBefore using this skill, first load the `autumn-concepts` skill — it defines the objects these calls operate on — customers, plans, balances, entities.\n\n## STRICT RULES\n\n1. **Everything is backend.** All Autumn calls run in the app's server code with `AUTUMN_SECRET_KEY` — never in the browser. The frontend gets billing data only through the app's own endpoints.\n2. **The old frontend layer is deprecated — never use or suggest it**: `autumnHandler` mounts, React hooks (`useCustomer`, `useEntity`, `AutumnProvider`), shadcn components. If an app already uses them, don't rip them out unasked — but build new work backend-only.\n3. **Resolve the customer before anything else.** Every handler that checks, tracks, or attaches must serve a brand-new user: `customers.getOrCreate` with the app's own stable id (user or org id from auth — whoever pays — never an email). Never assume the customer exists.\n4. **An error response is a failure.** A 4xx/5xx from any Autumn call is never \"working\" — read the error, fix the call.\n\n## Order of operations\n\nWork these in order; each step names what to settle and where the details live. Read the referenced doc before implementing the step — the snippets and parameters are there, not here.\n\n**1 — Discover the app.** Framework, server entry points, where auth lives, which existing routes handle the actions being billed. Settle the customer id: the app's stable user or org id — whoever pays. If the product bills per workspace/project/seat, those are entities under one customer, not separate customers.\n\n**2 — Settle the level.** Before writing any flow, ask the user how their plans and features actually work: what does a plan get bought for — the whole account, or each workspace/deployment/seat under it? And where does each feature's balance live — shared across the account, or per unit? The catalog hints (entity-scoped items, license plans) but doesn't decide — a plan can attach per deployment while credit packs stay account-wide. The answers flow through everything: `billing.attach` takes `entityId` for entity-level plans, `check`/`track` take `entityId` for entity-scoped balances, billing controls set at the matching level. Mixing levels silently misbills — an account-wide check against a per-seat balance always passes. For entities, entity-scoped balances, when to use which level, read `references/feature-entities.md`. For plans that attach per entity, read `references/entity-plans.md`.\n\n**3 — Install and connect.** `autumn-js` (or the platform's SDK) + `AUTUMN_SECRET_KEY` in server env. One shared client in server code. For install, client setup, the end-to-end happy path, read `references/setup.md`.\n\n**4 — Customer creation.** `customers.getOrCreate` where the app knows who the user is — signup/login hook, or lazily in billing handlers. Pass name/email when available. A default (auto-enable) plan attaches on creation — no attach call for the free tier. If step 2 settled anything at entity level, mirror this for entities: when the app creates its unit (a workspace, a deployment, a seat), create the entity then — usually in the same handler, right before the entity-level attach or check that needs it. For getOrCreate parameters, Stripe linking, pre-creating, read `references/creating-customers.md`. For creating entities, entity parameters, read `references/feature-entities.md`.\n\n**5 — Purchase and plan changes.** All through two calls, split by intent (pass `entityId` when the plan attaches at entity level — step 2):\n - `billing.attach` — getting on a plan, AND upgrades/downgrades within a plan group: attach the new plan; a higher (monthly-normalized) price applies immediately with proration, a lower one schedules for period end. `planSchedule` overrides. Default attach charges a saved card in place and returns `checkout_url` only when payment is actually needed — handle both outcomes. Force `redirectMode: \"always\"` only when the product wants hosted checkout unconditionally; custom flows preview first. For hosted vs custom checkout, redirectMode, previewAttach, read `references/payment-flow.md`. For upgrade/downgrade behavior, scheduled downgrades, carry-over on upgrade, read `references/subscription-lifecycle.md`.\n - `billing.update` — changing the subscription you're on: prepaid quantities (seats), `cancelAction` (`cancel_end_of_cycle` / `cancel_immediately` / `uncancel`), customization. It never switches plans — that's attach's job. Preview twins exist for both calls — use them wherever the app shows a confirmation screen. For quantities, cancelAction, previewUpdate, prorationBehavior, read `references/updating-subscriptions.md`.\n - When several plans move together — a plan plus its add-on in one purchase, or tied cancellation — use the multi twins: `billing.multiAttach` (one checkout / one payment covering every plan) and `billing.multiUpdate` (one atomic call applying a `cancelAction` per plan). Two sequential attach/update calls mean two checkouts or a half-canceled customer, and concurrent ones trip the per-customer lock.\n - Payment snags are response **state, not exceptions**: `required_action` (3DS, payment method, failure) plus `payment_url` — handle the states, surface the URL. For 3DS, payment failures, required_action codes, read `references/edge-cases.md`.\n - For deep parameter detail on attach, update, and the other billing actions (createSchedule, discounts, custom terms), the `autumn-billing` skill is the reference — it's written for operating billing directly, but its parameter and edge-case knowledge applies when implementing these calls in code.\n\n**6 — Check and track.** In the billed action's own handler: `check` before the work, `track` after it succeeds. Gate on `allowed` — don't re-derive access from balances. Pass `requiredBalance` when an action costs more than 1, and `entityId` when the balance lives on an entity (step 2) — check and track must agree on the level. For the check → act → track pattern, read `references/gating.md`. For check parameters, allowed semantics, credit systems, entity checks, read `references/check.md`. For track and setUsage, read `references/tracking-usage.md`.\n\n**7 — Billing controls.** Per-customer policy on top of the plan: set via `customers.update` with `billing_controls` (`spend_limits`, `usage_limits`, `usage_alerts`, `auto_topups`, `overage_allowed`), or at purchase time by passing `billing_controls` on `billing.attach`. The flagship shape is a user-facing \"overage billing on/off\" toggle: off maps to a `spend_limits` entry with `skip_overage_billing: true` — overage still accrues but is never invoiced — plus an `overage_limit` (use `limit_type: \"usage_percentage\"`, e.g. `20` = overage up to 20% of the plan allowance) so the user is blocked at the cap instead of running up unbilled usage forever; on means clearing or replacing the entry (`skip_overage_billing: false`). Whether overage needs enabling at all depends on the plan: items with a usage price already allow it (controls only modulate the billing); pure-grant items hard-stop at zero and need `overage_allowed` per customer — which permits the overage but doesn't bill it. Alerts (\"email at 80%\") are `usage_alerts` with `threshold_type: \"usage_percentage\"`; prepaid balances self-replenish via `auto_topups`. For all five controls, field shapes, customer vs entity level, plan defaults, read `references/billing-controls.md`. For spend limit semantics, skip_overage_billing, usage alerts, read `references/spend-limits.md`. For auto top-up setup and requirements, read `references/auto-top-ups.md`.\n\n**8 — Billing data for the frontend.** The app exposes its own endpoints calling `customers.get` / `plans.list` server-side; the UI reads those. For customer payload, plans list with eligibility, portal, read `references/display-billing.md`.\n\n**9 — Verify.** Call the app's routes as a fresh user; confirm in sandbox that the customer exists, checks gated, usage recorded, purchase reached checkout. `customers.get` is the oracle. **Done means verified behavior — compiling is not done.** Then undo what verifying created — release the license assignments, delete the entities, and reverse the usage your test recorded (a negative `track` or `setUsage` back), and nothing more. Never delete the customer or any state that existed before you started; pre-existing subscriptions and assignments are real. Verification also re-runs flows, so billing endpoints must tolerate repeats: joining a plan you're already on returns success, not a crash.\n\n## Gotchas the docs don't cover\n\n- **Concurrent billing mutations on one customer return 429** — attach/update share a per-customer lock; serialize instead of retrying blindly.\n- **A denied check should say what ran out** — include the feature and its balance state in the response, not a bare unexplained 403. What the caller does with it is the app's call: an API returns a clear error code, a dashboard might prompt an upgrade.\n\n## Conduct\n\n- Follow the app's existing patterns — router style, error handling, response shapes. Autumn code should look like the app wrote it.\n- Use catalog ids exactly; never invent feature or plan ids. Missing from the catalog → say so; that's an `autumn-catalog` change, not a workaround.\n- Smallest working integration first: one gated action end to end, verified, before spreading wider.\n\nGoing to production: For live keys, production checklist, read `references/deploy.md`. For fail-open behavior during Autumn outages, read `references/fail-open.md`.",
|
|
161
|
+
"---\nname: autumn-integrate\ndescription: Integrating Autumn into an app's backend — creating customers, billing flows (attach, checkout, upgrade, cancel), gating features with check, recording usage with track, and exposing billing data to the frontend. Use when the user asks to integrate Autumn, add billing/payments to their app, gate features, meter usage, or build checkout/upgrade flows. Requires a pushed catalog; use autumn-catalog first if plans don't exist yet.\nversion: 2.0.17\n---\n\n# Integrate\n\nBefore using this skill, first load the `autumn-concepts` skill — it defines the objects these calls operate on — customers, plans, balances, entities.\n\n## STRICT RULES\n\n1. **Everything is backend.** All Autumn calls run in the app's server code with `AUTUMN_SECRET_KEY` — never in the browser. The frontend gets billing data only through the app's own endpoints.\n2. **The old frontend layer is deprecated — never use or suggest it**: `autumnHandler` mounts, React hooks (`useCustomer`, `useEntity`, `AutumnProvider`), shadcn components. If an app already uses them, don't rip them out unasked — but build new work backend-only.\n3. **Resolve the customer before anything else.** Every handler that checks, tracks, or attaches must serve a brand-new user: `customers.getOrCreate` with the app's own stable id (user or org id from auth — whoever pays — never an email). Never assume the customer exists.\n4. **An error response is a failure.** A 4xx/5xx from any Autumn call is never \"working\" — read the error, fix the call.\n\n## Order of operations\n\nWork these in order; each step names what to settle and where the details live. Read the referenced doc before implementing the step — the snippets and parameters are there, not here.\n\n**1 — Discover the app.** Framework, server entry points, where auth lives, which existing routes handle the actions being billed. Settle the customer id: the app's stable user or org id — whoever pays. If the product bills per workspace/project/seat, those are entities under one customer, not separate customers.\n\n**2 — Settle the level.** Before writing any flow, ask the user how their plans and features actually work: what does a plan get bought for — the whole account, or each workspace/deployment/seat under it? And where does each feature's balance live — shared across the account, or per unit? The catalog hints (entity-scoped items, license plans) but doesn't decide — a plan can attach per deployment while credit packs stay account-wide. The answers flow through everything: `billing.attach` takes `entityId` for entity-level plans, `check`/`track` take `entityId` for entity-scoped balances, billing controls set at the matching level. Mixing levels silently misbills — an account-wide check against a per-seat balance always passes. For entities, entity-scoped balances, when to use which level, read `references/feature-entities.md`. For plans that attach per entity, read `references/entity-plans.md`.\n\n**3 — Install and connect.** `autumn-js` (or the platform's SDK) + `AUTUMN_SECRET_KEY` in server env. One shared client in server code. For install, client setup, the end-to-end happy path, read `references/setup.md`.\n\n**4 — Customer creation.** `customers.getOrCreate` where the app knows who the user is — signup/login hook, or lazily in billing handlers. Pass name/email when available. A default (auto-enable) plan attaches on creation — no attach call for the free tier. If step 2 settled anything at entity level, mirror this for entities: when the app creates its unit (a workspace, a deployment, a seat), create the entity then — usually in the same handler, right before the entity-level attach or check that needs it. For getOrCreate parameters, Stripe linking, pre-creating, read `references/creating-customers.md`. For creating entities, entity parameters, read `references/feature-entities.md`.\n\n**5 — Purchase and plan changes.** All through two calls, split by intent (pass `entityId` when the plan attaches at entity level — step 2):\n - `billing.attach` — getting on a plan, AND upgrades/downgrades within a plan group: attach the new plan; a higher (monthly-normalized) price applies immediately with proration, a lower one schedules for period end. `planSchedule` overrides. Default attach charges a saved card in place and returns `checkout_url` only when payment is actually needed — handle both outcomes. Force `redirectMode: \"always\"` only when the product wants hosted checkout unconditionally; custom flows preview first. For hosted vs custom checkout, redirectMode, previewAttach, read `references/payment-flow.md`. For upgrade/downgrade behavior, scheduled downgrades, carry-over on upgrade, read `references/subscription-lifecycle.md`.\n - `billing.update` — changing the subscription you're on: prepaid quantities (seats), `cancelAction` (`cancel_end_of_cycle` / `cancel_immediately` / `uncancel`), customization. It never switches plans — that's attach's job. Preview twins exist for both calls — use them wherever the app shows a confirmation screen. For quantities, cancelAction, previewUpdate, prorationBehavior, read `references/updating-subscriptions.md`.\n - When several plans move together — a plan plus its add-on in one purchase, or tied cancellation — use the multi twins: `billing.multiAttach` (one checkout / one payment covering every plan) and `billing.multiUpdate` (one atomic call applying a `cancelAction` per plan). Two sequential attach/update calls mean two checkouts or a half-canceled customer, and concurrent ones trip the per-customer lock.\n - Payment snags are response **state, not exceptions**: `required_action` (3DS, payment method, failure) plus `payment_url` — handle the states, surface the URL. For 3DS, payment failures, required_action codes, read `references/edge-cases.md`.\n - For deep parameter detail on attach, update, and the other billing actions (createSchedule, discounts, custom terms), the `autumn-billing` skill is the reference — it's written for operating billing directly, but its parameter and edge-case knowledge applies when implementing these calls in code.\n\n**6 — Check and track.** In the billed action's own handler: `check` before the work, `track` after it succeeds. Gate on `allowed` — don't re-derive access from balances. Pass `requiredBalance` when an action costs more than 1, and `entityId` when the balance lives on an entity (step 2) — check and track must agree on the level. For the check → act → track pattern, read `references/gating.md`. For check parameters, allowed semantics, credit systems, entity checks, read `references/check.md`. For track and setUsage, read `references/tracking-usage.md`.\n\n**7 — Billing controls.** Per-customer policy on top of the plan: set via `customers.update` with `billing_controls` (`spend_limits`, `usage_limits`, `usage_alerts`, `auto_topups`, `overage_allowed`), or at purchase time by passing `billing_controls` on `billing.attach`. The flagship shape is a user-facing \"overage billing on/off\" toggle: off maps to a `spend_limits` entry with `skip_overage_billing: true` — overage still accrues but is never invoiced — plus an `overage_limit` (use `limit_type: \"usage_percentage\"`, e.g. `20` = overage up to 20% of the plan allowance) so the user is blocked at the cap instead of running up unbilled usage forever; on means clearing or replacing the entry (`skip_overage_billing: false`). Whether overage needs enabling at all depends on the plan: items with a usage price already allow it (controls only modulate the billing); pure-grant items hard-stop at zero and need `overage_allowed` per customer — which permits the overage but doesn't bill it. Alerts (\"email at 80%\") are `usage_alerts` with `threshold_type: \"usage_percentage\"`; prepaid balances self-replenish via `auto_topups`. For all five controls, field shapes, customer vs entity level, plan defaults, read `references/billing-controls.md`. For spend limit semantics, skip_overage_billing, usage alerts, read `references/spend-limits.md`. For auto top-up setup and requirements, read `references/auto-top-ups.md`.\n\n**8 — Billing data for the frontend.** The app exposes its own endpoints calling `customers.get` / `plans.list` server-side; the UI reads those. For customer payload, plans list with eligibility, portal, read `references/display-billing.md`.\n\n**9 — Verify.** Call the app's routes as a fresh user; confirm in sandbox that the customer exists, checks gated, usage recorded, purchase reached checkout. `customers.get` is the oracle. **Done means verified behavior — compiling is not done.** Then undo what verifying created — release the license assignments, delete the entities, and reverse the usage your test recorded (a negative `track` or `setUsage` back), and nothing more. Never delete the customer or any state that existed before you started; pre-existing subscriptions and assignments are real. Verification also re-runs flows, so billing endpoints must tolerate repeats: joining a plan you're already on returns success, not a crash.\n\n## Gotchas the docs don't cover\n\n- **Concurrent billing mutations on one customer return 429** — attach/update share a per-customer lock; serialize instead of retrying blindly.\n- **A denied check should say what ran out** — include the feature and its balance state in the response, not a bare unexplained 403. What the caller does with it is the app's call: an API returns a clear error code, a dashboard might prompt an upgrade.\n\n## Conduct\n\n- Follow the app's existing patterns — router style, error handling, response shapes. Autumn code should look like the app wrote it.\n- Use catalog ids exactly; never invent feature or plan ids. Missing from the catalog → say so; that's an `autumn-catalog` change, not a workaround.\n- Smallest working integration first: one gated action end to end, verified, before spreading wider.\n\nGoing to production: For live keys, production checklist, read `references/deploy.md`. For fail-open behavior during Autumn outages, read `references/fail-open.md`.",
|
|
162
162
|
references: [
|
|
163
163
|
{
|
|
164
164
|
path: "references/feature-entities.md",
|
|
@@ -256,9 +256,9 @@ export const SKILLS: readonly BundledSkill[] = [
|
|
|
256
256
|
name: "autumn-concepts",
|
|
257
257
|
description:
|
|
258
258
|
"Understanding Autumn's billing objects before acting on them — what a plan version is and what active means, when a trial starts or ends billing, how entity- and seat-scoped subscriptions differ from the customer's own, what a customize diff actually changes, and how caps, overage, and top-ups behave. Load before versioning, editing, or drafting a plan, or when a customer's state does not match the plain reading of their plan.",
|
|
259
|
-
version: "2.0.
|
|
259
|
+
version: "2.0.17",
|
|
260
260
|
markdown:
|
|
261
|
-
"---\nname: autumn-concepts\ndescription: Understanding Autumn's billing objects before acting on them — what a plan version is and what active means, when a trial starts or ends billing, how entity- and seat-scoped subscriptions differ from the customer's own, what a customize diff actually changes, and how caps, overage, and top-ups behave. Load before versioning, editing, or drafting a plan, or when a customer's state does not match the plain reading of their plan.\nversion: 2.0.
|
|
261
|
+
"---\nname: autumn-concepts\ndescription: Understanding Autumn's billing objects before acting on them — what a plan version is and what active means, when a trial starts or ends billing, how entity- and seat-scoped subscriptions differ from the customer's own, what a customize diff actually changes, and how caps, overage, and top-ups behave. Load before versioning, editing, or drafting a plan, or when a customer's state does not match the plain reading of their plan.\nversion: 2.0.17\n---\n\n# Concepts\n\nAutumn is a database for your application billing state: features, plans, customers, subscriptions, purchases, balances, flags, and billing controls. It helps you iterate on pricing, manage credit access and usage, control overage, and keep billing behavior connected to product access.\n\nAutumn is a layer above Stripe; Stripe still handles subscription management, invoicing, and payment processing. Autumn provisions and updates Stripe subscriptions, schedules, invoices, and related billing objects for you.\n\n## Object graph\n\n```txt\nOrganization\n- features[] -> Feature\n- plans[] -> Plan\n- customers[] -> Customer\n\nConfiguration model:\nFeature\n- referenced by -> Plan Item\n- credit_system type: maps actions to credit costs (flat or tiered)\n\nPlan\n- items[] -> Plan Item\n - feature_id -> Feature\n - optional price -> usage_based or prepaid feature price\n- price -> base recurring or one-off price\n- versions[] -> parallel definitions of this plan; ONE is active\n- variants[] -> Plan (a derived plan storing only its differences)\n- licenses[] -> Plan (a seat plan this plan hands out per seat)\n- aliases -> old plan ids that still resolve after a rename\n\nPlan Item\n- feature_id -> Feature\n- optional price -> usage_based or prepaid feature price\n- pooled? -> entity grants combine into one shared customer balance\n\nRuntime model:\nCustomer\n- subscriptions[] -> Subscription -> Plan (a specific version of it)\n- purchases[] -> Purchase -> Plan\n- balances[feature_id] -> Balance -> Feature\n - pooled balance: fed by entity grants, spent by any entity\n - rollover, expiry, usage windows live here\n- licenses[] -> CustomerLicense -> seats granted / in use / remaining\n- flags[feature_id] -> Flag -> Feature\n- billing_controls -> customer-level usage controls\n- entities[] -> Entity -> same runtime shape scoped under Customer\n\nEntity\n- belongs to -> Customer\n- subscriptions[] -> Subscription -> Plan\n- purchases[] -> Purchase -> Plan\n- balances[feature_id] -> Balance -> Feature\n- flags[feature_id] -> Flag -> Feature\n- license assignment -> holds one seat from the customer's pool\n\nFrom config to customer state:\nPlan + Customer --billing.attach--> Subscription or Purchase\nPlan + Customer + entity_id --billing.attach--> Entity-scoped Subscription or Purchase\nParent plan's licenses --licenses.attach--> seat assigned to an Entity\nSubscription/Purchase -> Balance or Flag provisioning\n```\n\nTwo relationships changed recently — worth stating plainly because older docs describe the old way:\n\n**Versions are groups of customers, not history.** A plan's versions used to be numbered steps in time, and the newest was always live. Now each version is a definition that some group of customers lives on, and exactly one is **active** — the one attach uses when no version is named. Which changes are edits and which are new versions, drafts, and how customers move: the plan definition below.\n\n**Plans connect to other plans.** A plan can have variants (an annual twin storing only its differences), and it can offer licenses (a small seat plan it hands out per seat). So plans form a graph, not a flat list.\n\nUse these definitions as the mental model when designing or changing Autumn\npricing. Reason in terms of features, plans, plan items, customers/entities, and\nbilling controls before writing any config or calling the API — most modeling\nmistakes come from conflating a feature with a plan item, or a plan-level price\nwith a per-feature price.\n\n## Definitions\n\nLoad the matching definition when reasoning about that object.\n\nFor defining a feature — the atomic unit Autumn gates, tracks, or bills, and its types, read `references/feature.md`.\n\nFor defining a plan — the attachable package of items and pricing, read `references/plan.md`.\n\nFor modeling plan items, or when you need concrete API request-body examples (included usage, prepaid, usage-based, tiers), read `references/plan-items.md`.\n\nFor using customize, reading plan update previews, or representing a small diff from a base plan, read `references/customize.md`.\n\nFor reasoning about free trials and when billing begins, read `references/trials.md`.\n\nFor distinguishing a customer from an entity (seats, sub-accounts) and their runtime billing state, read `references/customer-entity.md`.\n\nFor reasoning about billing controls — runtime caps, alerts, overage, and top-ups, read `references/billing-controls.md`.\n\nFor reasoning about licenses — seat plans a parent plan hands out, seat pools, assigning and releasing seats, read `references/licenses.md`.",
|
|
262
262
|
references: [
|
|
263
263
|
{
|
|
264
264
|
path: "references/feature.md",
|
|
@@ -37,8 +37,6 @@ export type Variant = {
|
|
|
37
37
|
}>;
|
|
38
38
|
} | null;
|
|
39
39
|
};
|
|
40
|
-
/** Pointer write for this nested variant. Omit to link it to this base; `null` detaches it. A string must be this plan's id. */
|
|
41
|
-
baseVariantId?: string | null;
|
|
42
40
|
/** Declared overlay on this variant. `items` is PUT (replaces the list); `add_items` / `remove_items` are PATCH. Independent of `propagate`. Blocked on an archived variant unless `archived` is false in the same entry. */
|
|
43
41
|
customize?: {
|
|
44
42
|
/** Override the base price of the plan. Pass null to remove the base price. */
|