@intentius/chant-lexicon-fly 0.44.13 → 0.45.0

package/dist/codegen/docs.d.ts

@@ -12,12 +12,6 @@
  * Machines, Storage, Networking, Secrets).
  */
 export declare function serviceFromType(resourceType: string): string;
-/**
- * The reference doc URL for a fly resource type. The Machines API (flaps) is
- * documented at docs.machines.dev, tagged by resource; resources flaps does not
- * own (public IPs, certificates) link to the matching fly.io docs page.
- */
-export declare function resourceTypeUrl(resourceType: string): string;
 /**
  * Generate documentation for the fly Machines lexicon.
  */

package/dist/codegen/docs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"docs.d.ts","sourceRoot":"","sources":["../../src/codegen/docs.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAsBH;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAiB5D;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAkB5D;AAsED;;GAEG;AACH,wBAAsB,YAAY,CAAC,OAAO,CAAC,EAAE;IAAE,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CA0DjF"}
+{"version":3,"file":"docs.d.ts","sourceRoot":"","sources":["../../src/codegen/docs.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAQH;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,MAAM,CAiB5D;AA2DD;;GAEG;AACH,wBAAsB,YAAY,CAAC,OAAO,CAAC,EAAE;IAAE,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAsBjF"}

package/dist/integrity.json

@@ -1,7 +1,7 @@
 {
   "algorithm": "sha256",
   "artifacts": {
-    "manifest.json": "201089313736647baccb5b76e3e3397a05c9bf08d219660a4aecd56a400b680c",
+    "manifest.json": "aed323ed6c59f96ab9470a796a81e75ddac9d72d7b1a5f7522cc7a544d88df42",
     "meta.json": "e46e65ba7544fafc6dbb3fd48b841904b5ae6f7cb4d517a940ed68b01626c097",
     "types/index.d.ts": "a76090adb6eda33a2c07a074183299a59e953b48dd3f2020d7ef11278d59341e",
     "rules/guest-sizing.ts": "bc749d218df8f3cc3d8fbe388205ae96e6b204ae0d6d77e8bf82cb936cc53ff6",
@@ -15,5 +15,5 @@
     "skills/chant-fly-ops.md": "b8eef6504e203133e6a35c83aabb08404eec95060705395515a0046d42269cf1",
     "skills/chant-fly-sprites.md": "89ba52db63a71a17eab483d99233a4ae67f5d34920445010e750f81c95200b4e"
   },
-  "composite": "2f3f19f6e8745ffe65aab23db63411aae8c014dc5f1a4c153dd256ce1d010ec4"
+  "composite": "2831247df3815a0f1f18a99d8a7dc4baeb905952268fec353746037d2d8a86c2"
 }

package/dist/manifest.json

@@ -1,6 +1,6 @@
 {
   "name": "fly",
-  "version": "0.44.13",
+  "version": "0.45.0",
   "chantVersion": ">=0.1.0",
   "namespace": "Fly"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intentius/chant-lexicon-fly",
-  "version": "0.44.13",
+  "version": "0.45.0",
   "type": "module",
   "files": [
     "src/",
@@ -57,7 +57,7 @@
     "typescript": "^5.9.3"
   },
   "peerDependencies": {
-    "@intentius/chant": "^0.44.13",
+    "@intentius/chant": "^0.45.0",
     "typescript": "^5.9.3"
   },
   "description": "Fly.io Machines lexicon for chant — declarative IaC in TypeScript",

package/src/codegen/docs.ts

@@ -12,20 +12,6 @@ import { docsPipeline, writeDocsSite, type DocsConfig } from "@intentius/chant/c
 
 const pkgDir = dirname(dirname(dirname(fileURLToPath(import.meta.url))));
 
-/**
- * The curated top-level fly resources (#741), in the order they read best in a
- * reference table. Property types (MachineConfig, MachineGuest, ...) are grouped
- * separately by the pipeline and are not repeated here.
- */
-const RESOURCES: Array<{ className: string; resourceType: string }> = [
-  { className: "App", resourceType: "Fly::Machines::App" },
-  { className: "Machine", resourceType: "Fly::Machines::Machine" },
-  { className: "Volume", resourceType: "Fly::Machines::Volume" },
-  { className: "IPAddress", resourceType: "Fly::Machines::IPAddress" },
-  { className: "Certificate", resourceType: "Fly::Machines::Certificate" },
-  { className: "Secret", resourceType: "Fly::Machines::Secret" },
-];
-
 /**
  * Group a fly resource type into a service bucket for the reference sidebar.
  * fly type names are `Fly::Machines::<Kind>`, so the middle segment is always
@@ -51,31 +37,6 @@ export function serviceFromType(resourceType: string): string {
   }
 }
 
-/**
- * The reference doc URL for a fly resource type. The Machines API (flaps) is
- * documented at docs.machines.dev, tagged by resource; resources flaps does not
- * own (public IPs, certificates) link to the matching fly.io docs page.
- */
-export function resourceTypeUrl(resourceType: string): string {
-  const kind = resourceType.split("::")[2] ?? resourceType;
-  switch (kind) {
-    case "App":
-      return "https://docs.machines.dev/#tag/apps";
-    case "Machine":
-      return "https://docs.machines.dev/#tag/machines";
-    case "Volume":
-      return "https://docs.machines.dev/#tag/volumes";
-    case "Secret":
-      return "https://docs.machines.dev/#tag/secrets";
-    case "IPAddress":
-      return "https://fly.io/docs/networking/services/";
-    case "Certificate":
-      return "https://fly.io/docs/networking/custom-domains-with-fly/";
-    default:
-      return "https://docs.machines.dev/";
-  }
-}
-
 const overview = `The **Fly Machines** lexicon defines Fly.io apps and machines using chant's declarative TypeScript syntax. Resources are serialized to the JSON create bodies the Machines API ("flaps") accepts, so the applier can POST them straight through and the mudflaps emulator can round-trip them offline.
 
 This lexicon is generated from Fly's published [Machines API OpenAPI spec](https://docs.machines.dev/openapi.json).
@@ -133,17 +94,6 @@ Every serialized machine carries the \`managed-by: chant\` ownership marker in \
 
 The output is applied against flaps directly (or the mudflaps emulator offline). Endpoint and auth come from \`FLY_FLAPS_BASE_URL\` and \`FLY_API_TOKEN\`.`;
 
-const resourcesPage = `The fly lexicon ships ${RESOURCES.length} top-level resources. Each maps to a Machines API create body; follow the reference link for the underlying API shape.
-
-| Resource | Type | Service | Machines API |
-|----------|------|---------|--------------|
-${RESOURCES.map(
-  (r) =>
-    `| \`${r.className}\` | \`${r.resourceType}\` | ${serviceFromType(r.resourceType)} | [reference](${resourceTypeUrl(r.resourceType)}) |`,
-).join("\n")}
-
-Property types such as \`MachineConfig\`, \`MachineGuest\`, \`MachineService\`, \`MachinePort\`, and \`MachineMount\` are authored inline on a resource and are documented alongside the resources they belong to.`;
-
 /**
  * Generate documentation for the fly Machines lexicon.
  */
@@ -159,42 +109,6 @@ export async function generateDocs(options?: { verbose?: boolean }): Promise<voi
     overview,
     outputFormat,
     serviceFromType,
-    extraPages: [
-      {
-        slug: "resources",
-        title: "Resource Reference",
-        description: "The fly resource types and their Machines API documentation links",
-        content: resourcesPage,
-      },
-      {
-        slug: "pseudo-params",
-        title: "Pseudo-parameters",
-        description: "Environment-resolved values: Fly.Region, Fly.OrgSlug, Fly.AppName",
-        content: `Pseudo-parameters stand in for values that vary by environment. Reference them instead of hard-coding, and the serializer resolves each from an environment variable at build time.
-
-| Pseudo-parameter | Environment variable | Fallback |
-|------------------|----------------------|----------|
-| \`Fly.Region\` | \`FLY_REGION\` | \`iad\` |
-| \`Fly.OrgSlug\` | \`FLY_ORG\`, then \`FLY_ORG_SLUG\` | \`personal\` |
-| \`Fly.AppName\` | \`FLY_APP_NAME\` | \`app\` |
-
-\`\`\`typescript
-import { App, Machine, MachineConfig, MachineGuest, Fly } from "@intentius/chant-lexicon-fly";
-
-const app = new App({ name: "my-app", org_slug: Fly.OrgSlug });
-
-const web = new Machine({
-  region: Fly.Region,
-  config: new MachineConfig({
-    image: "flyio/hellofly:latest",
-    guest: new MachineGuest({ cpu_kind: "shared", cpus: 1, memory_mb: 256 }),
-  }),
-});
-\`\`\`
-
-With \`FLY_REGION=lhr\` set, \`region\` serializes to \`"lhr"\`; unset, it falls back to \`"iad"\`.`,
-      },
-    ],
   };
 
   const result = docsPipeline(config);

package/src/import/roundtrip.test.ts

@@ -49,7 +49,7 @@ describe("roundtrip: declared entities → serialize → parse → generate →
       ["app", app],
       ["web", web],
     ]);
-    const planA = JSON.parse(flySerializer.serialize(entities));
+    const planA = JSON.parse(flySerializer.serialize(entities) as string);
 
     // 2. Parse the plan and generate TypeScript.
     const ir = parser.parse(JSON.stringify(planA));
@@ -67,7 +67,7 @@ describe("roundtrip: declared entities → serialize → parse → generate →
 
     // 4. Re-serialize the regenerated entities.
     const regenerated = new Map<string, any>(Object.entries(mod));
-    const planB = JSON.parse(flySerializer.serialize(regenerated));
+    const planB = JSON.parse(flySerializer.serialize(regenerated) as string);
 
     // The bodies survive the round-trip. Entity keys differ (variable names are
     // camelCased from the resource name), so compare the create bodies by kind.

package/src/serializer.test.ts

@@ -11,7 +11,7 @@ function stack(...entries: Array<[string, unknown]>): Map<string, Declarable> {
 
 describe("fly serializer", () => {
   it("serializes an empty map to valid JSON", () => {
-    const result = flySerializer.serialize(new Map());
+    const result = flySerializer.serialize(new Map()) as string;
     expect(typeof result).toBe("string");
     expect(JSON.parse(result)).toEqual({});
   });
@@ -27,7 +27,7 @@ describe("fly serializer", () => {
       new App({ name: "my-app", org_slug: "acme" }),
     ]);
 
-    const out = JSON.parse(flySerializer.serialize(entities));
+    const out = JSON.parse(flySerializer.serialize(entities) as string);
     expect(out.web).toEqual({
       endpoint: "/v1/apps",
       method: "POST",
@@ -36,7 +36,7 @@ describe("fly serializer", () => {
   });
 
   it("falls back to the entity name for app_name when no explicit name", () => {
-    const out = JSON.parse(flySerializer.serialize(stack(["billing", new App({ org_slug: "acme" })])));
+    const out = JSON.parse(flySerializer.serialize(stack(["billing", new App({ org_slug: "acme" })])) as string);
     expect(out.billing.body.app_name).toBe("billing");
   });
 
@@ -57,7 +57,7 @@ describe("fly serializer", () => {
       ],
     );
 
-    const out = JSON.parse(flySerializer.serialize(entities));
+    const out = JSON.parse(flySerializer.serialize(entities) as string);
     expect(out.api.endpoint).toBe("/v1/apps/my-app/machines");
     expect(out.api.method).toBe("POST");
     expect(out.api.body.name).toBe("api-1");
@@ -79,7 +79,7 @@ describe("fly serializer", () => {
       ],
     );
 
-    const out = JSON.parse(flySerializer.serialize(entities));
+    const out = JSON.parse(flySerializer.serialize(entities) as string);
     // No user metadata → marker still present.
     expect(out.bare.body.config.metadata["managed-by"]).toBe("chant");
     // User metadata is preserved and the marker is merged in.
@@ -94,7 +94,7 @@ describe("fly serializer", () => {
     );
 
     const out = JSON.parse(
-      flySerializer.serialize(entities, undefined, { ownership: { stack: "billing", env: "prod" } }),
+      flySerializer.serialize(entities, undefined, { ownership: { stack: "billing", env: "prod" } }) as string,
     );
     const meta = out.api.body.config.metadata;
     expect(meta["managed-by"]).toBe("chant");
@@ -110,7 +110,7 @@ describe("fly serializer", () => {
         new Machine({ name: "api-1", region: "iad", config: new MachineConfig({ image: "nginx" }) }),
       ],
     );
-    const body = JSON.parse(flySerializer.serialize(entities)).api.body;
+    const body = JSON.parse(flySerializer.serialize(entities) as string).api.body;
     // Only fields present on flaps CreateMachineRequest / MachineConfig.
     expect(Object.keys(body).sort()).toEqual(["config", "name", "region"]);
     expect(Object.keys(body.config.guest ?? {})).toEqual([]);
@@ -123,7 +123,7 @@ describe("fly serializer", () => {
       ["app", new App({ name: "my-app" })],
       ["data", new Volume({ name: "data", region: "iad", size_gb: 10, encrypted: true })],
     );
-    const out = JSON.parse(flySerializer.serialize(entities));
+    const out = JSON.parse(flySerializer.serialize(entities) as string);
     expect(out.data).toEqual({
       endpoint: "/v1/apps/my-app/volumes",
       method: "POST",
@@ -138,7 +138,7 @@ describe("fly serializer", () => {
       ["app", new App({ name: "my-app" })],
       ["ip", new IPAddress({ type: "shared_v4", region: "iad", org_slug: "acme", service_name: "web", network: "default" })],
     );
-    const out = JSON.parse(flySerializer.serialize(entities));
+    const out = JSON.parse(flySerializer.serialize(entities) as string);
     expect(out.ip).toEqual({
       endpoint: "/v1/apps/my-app/ip_assignments",
       method: "POST",
@@ -151,7 +151,7 @@ describe("fly serializer", () => {
       ["app", new App({ name: "my-app" })],
       ["cert", new Certificate({ hostname: "example.com" })],
     );
-    const out = JSON.parse(flySerializer.serialize(entities));
+    const out = JSON.parse(flySerializer.serialize(entities) as string);
     expect(out.cert).toEqual({
       endpoint: "/v1/apps/my-app/certificates",
       method: "POST",
@@ -164,7 +164,7 @@ describe("fly serializer", () => {
       ["app", new App({ name: "my-app" })],
       ["db-password", new Secret({ value: "s3cret" })],
     );
-    const out = JSON.parse(flySerializer.serialize(entities));
+    const out = JSON.parse(flySerializer.serialize(entities) as string);
     expect(out["db-password"]).toEqual({
       endpoint: "/v1/apps/my-app/secrets/db-password",
       method: "POST",
@@ -195,7 +195,7 @@ describe("fly serializer pseudo-parameters", () => {
       ["app", new App({ name: "my-app" })],
       ["web", new Machine({ region: Fly.Region, config: new MachineConfig({ image: "nginx" }) })],
     );
-    const body = JSON.parse(flySerializer.serialize(entities)).web.body;
+    const body = JSON.parse(flySerializer.serialize(entities) as string).web.body;
     expect(body.region).toBe("lhr");
   });
 
@@ -205,28 +205,28 @@ describe("fly serializer pseudo-parameters", () => {
       ["app", new App({ name: "my-app" })],
       ["web", new Machine({ region: Fly.Region, config: new MachineConfig({ image: "nginx" }) })],
     );
-    const body = JSON.parse(flySerializer.serialize(entities)).web.body;
+    const body = JSON.parse(flySerializer.serialize(entities) as string).web.body;
     expect(body.region).toBe("iad");
   });
 
   it("resolves Fly.OrgSlug from FLY_ORG (preferred over FLY_ORG_SLUG)", () => {
     process.env.FLY_ORG = "acme";
     process.env.FLY_ORG_SLUG = "ignored";
-    const out = JSON.parse(flySerializer.serialize(stack(["app", new App({ name: "my-app", org_slug: Fly.OrgSlug })])));
+    const out = JSON.parse(flySerializer.serialize(stack(["app", new App({ name: "my-app", org_slug: Fly.OrgSlug })])) as string);
     expect(out.app.body.org_slug).toBe("acme");
   });
 
   it("resolves Fly.OrgSlug from FLY_ORG_SLUG when FLY_ORG is unset", () => {
     delete process.env.FLY_ORG;
     process.env.FLY_ORG_SLUG = "beta-org";
-    const out = JSON.parse(flySerializer.serialize(stack(["app", new App({ name: "my-app", org_slug: Fly.OrgSlug })])));
+    const out = JSON.parse(flySerializer.serialize(stack(["app", new App({ name: "my-app", org_slug: Fly.OrgSlug })])) as string);
     expect(out.app.body.org_slug).toBe("beta-org");
   });
 
   it("falls back to personal for Fly.OrgSlug when no org env var is set", () => {
     delete process.env.FLY_ORG;
     delete process.env.FLY_ORG_SLUG;
-    const out = JSON.parse(flySerializer.serialize(stack(["app", new App({ name: "my-app", org_slug: Fly.OrgSlug })])));
+    const out = JSON.parse(flySerializer.serialize(stack(["app", new App({ name: "my-app", org_slug: Fly.OrgSlug })])) as string);
     expect(out.app.body.org_slug).toBe("personal");
   });
 });