@intentius/chant-lexicon-fly 0.41.20 → 0.42.1

package/dist/integrity.json

@@ -1,7 +1,7 @@
 {
   "algorithm": "sha256",
   "artifacts": {
-    "manifest.json": "34570d6936a41f0fdb3d31fcd20b83843b1774d9e86b53947e66fcd638c4c283",
+    "manifest.json": "69ff9c586050363edf93f976e21fae5ae6b1b101d669cd8b88bca1716e548b65",
     "meta.json": "e46e65ba7544fafc6dbb3fd48b841904b5ae6f7cb4d517a940ed68b01626c097",
     "types/index.d.ts": "07f5d04d0d3831cae053b1f0f5dd661c58e9708f45067a0fc85dd94079ac144b",
     "rules/guest-sizing.ts": "bc749d218df8f3cc3d8fbe388205ae96e6b204ae0d6d77e8bf82cb936cc53ff6",
@@ -15,5 +15,5 @@
     "skills/chant-fly-ops.md": "b8eef6504e203133e6a35c83aabb08404eec95060705395515a0046d42269cf1",
     "skills/chant-fly-sprites.md": "89ba52db63a71a17eab483d99233a4ae67f5d34920445010e750f81c95200b4e"
   },
-  "composite": "af0a8b75849382e5ec3aa310c36b40dcc2d62f398d058d883249242af7777cf6"
+  "composite": "384ff22ab801273fdd306c3ecf0981bd5018ca936916826766575f9519f69232"
 }

package/dist/manifest.json

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

package/dist/okf/index.md

@@ -0,0 +1,20 @@
+---
+okf_version: '0.2'
+---
+
+# Resource types
+
+* [App](/types/App.md) - Fly::Machines::App
+* [Certificate](/types/Certificate.md) - Fly::Machines::Certificate
+* [IPAddress](/types/IPAddress.md) - Fly::Machines::IPAddress
+* [Machine](/types/Machine.md) - Fly::Machines::Machine
+* [Secret](/types/Secret.md) - Fly::Machines::Secret
+* [Volume](/types/Volume.md) - Fly::Machines::Volume
+
+# Rules
+
+* [FLY001](/rules/FLY001.md) - Valid Fly region
+* [FLY002](/rules/FLY002.md) - Sane guest sizing
+* [FLY004](/rules/FLY004.md) - No secret literals in machine config
+* [FLY010](/rules/FLY010.md) - Machine config must specify an image — a Machine cannot boot without one
+* [FLY011](/rules/FLY011.md) - A machine mount's volume must resolve to a Volume declared in the stack

package/dist/okf/rules/FLY001.md

@@ -0,0 +1,11 @@
+---
+type: lint-rule
+title: FLY001
+description: Valid Fly region
+id: FLY001
+severity: error
+category: correctness
+lexicon: fly
+docs: https://intentius.io/chant/lexicons/fly/rules/
+---
+Valid Fly region

package/dist/okf/rules/FLY002.md

@@ -0,0 +1,11 @@
+---
+type: lint-rule
+title: FLY002
+description: Sane guest sizing
+id: FLY002
+severity: error
+category: correctness
+lexicon: fly
+docs: https://intentius.io/chant/lexicons/fly/rules/
+---
+Sane guest sizing

package/dist/okf/rules/FLY004.md

@@ -0,0 +1,15 @@
+---
+type: lint-rule
+title: FLY004
+description: No secret literals in machine config
+id: FLY004
+severity: warning
+category: security
+lexicon: fly
+docs: https://intentius.io/chant/lexicons/fly/rules/
+---
+No secret literals in machine config
+
+## Applies to
+
+- [Secret](/types/Secret.md)

package/dist/okf/rules/FLY010.md

@@ -0,0 +1,15 @@
+---
+type: post-synth-check
+title: FLY010
+description: Machine config must specify an image — a Machine cannot boot without one
+id: FLY010
+severity: error
+category: post-synth
+lexicon: fly
+docs: https://intentius.io/chant/lexicons/fly/rules/
+---
+Machine config must specify an image — a Machine cannot boot without one
+
+## Applies to
+
+- [Machine](/types/Machine.md)

package/dist/okf/rules/FLY011.md

@@ -0,0 +1,16 @@
+---
+type: post-synth-check
+title: FLY011
+description: A machine mount's volume must resolve to a Volume declared in the stack
+id: FLY011
+severity: error
+category: post-synth
+lexicon: fly
+docs: https://intentius.io/chant/lexicons/fly/rules/
+---
+A machine mount's volume must resolve to a Volume declared in the stack
+
+## Applies to
+
+- [Machine](/types/Machine.md)
+- [Volume](/types/Volume.md)

package/dist/okf/types/App.md

@@ -0,0 +1,16 @@
+---
+type: resource-type
+title: App
+description: fly resource type Fly::Machines::App
+name: App
+lexicon: fly
+resource_type: Fly::Machines::App
+---
+`Fly::Machines::App`, a resource type of the fly lexicon.
+
+## Properties
+
+- `enable_subdomains` (`boolean`, optional)
+- `name` (`string`, optional)
+- `network` (`string`, optional)
+- `org_slug` (`string`, optional)

package/dist/okf/types/Certificate.md

@@ -0,0 +1,13 @@
+---
+type: resource-type
+title: Certificate
+description: fly resource type Fly::Machines::Certificate
+name: Certificate
+lexicon: fly
+resource_type: Fly::Machines::Certificate
+---
+`Fly::Machines::Certificate`, a resource type of the fly lexicon.
+
+## Properties
+
+- `hostname` (`string`, optional)

package/dist/okf/types/IPAddress.md

@@ -0,0 +1,17 @@
+---
+type: resource-type
+title: IPAddress
+description: fly resource type Fly::Machines::IPAddress
+name: IPAddress
+lexicon: fly
+resource_type: Fly::Machines::IPAddress
+---
+`Fly::Machines::IPAddress`, a resource type of the fly lexicon.
+
+## Properties
+
+- `network` (`string`, optional)
+- `org_slug` (`string`, optional)
+- `region` (`string`, optional)
+- `service_name` (`string`, optional)
+- `type` (`string`, optional)

package/dist/okf/types/Machine.md

@@ -0,0 +1,25 @@
+---
+type: resource-type
+title: Machine
+description: fly resource type Fly::Machines::Machine
+name: Machine
+lexicon: fly
+resource_type: Fly::Machines::Machine
+---
+`Fly::Machines::Machine`, a resource type of the fly lexicon.
+
+## Properties
+
+- `config` (`MachineConfig`, optional): An object defining the Machine configuration
+- `lease_ttl` (`number`, optional)
+- `min_secrets_version` (`number`, optional)
+- `name` (`string`, optional): Unique name for this Machine. If omitted, one is generated for you
+- `region` (`string`, optional): The target region. Omitting this param launches in the same region as your WireGuard peer connection (somewhere near you).
+- `skip_launch` (`boolean`, optional)
+- `skip_secrets` (`boolean`, optional)
+- `skip_service_registration` (`boolean`, optional)
+
+## Governed by
+
+- [FLY010](/rules/FLY010.md): Machine config must specify an image — a Machine cannot boot without one
+- [FLY011](/rules/FLY011.md): A machine mount's volume must resolve to a Volume declared in the stack

package/dist/okf/types/Secret.md

@@ -0,0 +1,17 @@
+---
+type: resource-type
+title: Secret
+description: fly resource type Fly::Machines::Secret
+name: Secret
+lexicon: fly
+resource_type: Fly::Machines::Secret
+---
+`Fly::Machines::Secret`, a resource type of the fly lexicon.
+
+## Properties
+
+- `value` (`string`, optional)
+
+## Governed by
+
+- [FLY004](/rules/FLY004.md): No secret literals in machine config

package/dist/okf/types/Volume.md

@@ -0,0 +1,29 @@
+---
+type: resource-type
+title: Volume
+description: fly resource type Fly::Machines::Volume
+name: Volume
+lexicon: fly
+resource_type: Fly::Machines::Volume
+---
+`Fly::Machines::Volume`, a resource type of the fly lexicon.
+
+## Properties
+
+- `auto_backup_enabled` (`boolean`, optional): enable scheduled automatic snapshots. Defaults to `true`
+- `compute` (`MachineGuest`, optional)
+- `compute_image` (`string`, optional)
+- `encrypted` (`boolean`, optional)
+- `fstype` (`string`, optional)
+- `name` (`string`, optional)
+- `region` (`string`, optional)
+- `require_unique_zone` (`boolean`, optional)
+- `size_gb` (`number`, optional)
+- `snapshot_id` (`string`, optional): restore from snapshot
+- `snapshot_retention` (`number`, optional)
+- `source_volume_id` (`string`, optional): fork from remote volume
+- `unique_zone_app_wide` (`boolean`, optional)
+
+## Governed by
+
+- [FLY011](/rules/FLY011.md): A machine mount's volume must resolve to a Volume declared in the stack

package/package.json

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

package/src/codegen/okf.test.ts

@@ -0,0 +1,37 @@
+import { describe, test, expect } from "vitest";
+import { packageLexicon } from "./package";
+import { okfConformanceProblems, splitFrontmatter } from "@intentius/chant/okf";
+import { parseYAML } from "@intentius/chant/yaml";
+
+/**
+ * The lexicon OKF bundle (#1060) over fly — the OpenAPI-derived generation
+ * path, where property descriptions come out of the generated declarations'
+ * JSDoc rather than the registry.
+ */
+describe("fly OKF bundle", () => {
+  test("packaging emits a conformant bundle with spec-sourced property descriptions", async () => {
+    const { spec } = await packageLexicon();
+    expect(spec.okf).toBeDefined();
+    expect(okfConformanceProblems(spec.okf!)).toEqual([]);
+
+    const files = new Map(spec.okf!.map((f) => [f.path, f.content]));
+    const machine = splitFrontmatter(files.get("types/Machine.md")!)!;
+    const front = parseYAML(machine.frontmatter);
+    expect(front.type).toBe("resource-type");
+    expect(front.resource_type).toBe("Fly::Machines::Machine");
+    // Description carried over from the Machines OpenAPI spec via the d.ts JSDoc.
+    expect(machine.body).toContain("Unique name for this Machine");
+  }, 120_000);
+
+  test("rules cross-link with the types they govern, both directions", async () => {
+    const { spec } = await packageLexicon();
+    const files = new Map(spec.okf!.map((f) => [f.path, f.content]));
+
+    const machine = splitFrontmatter(files.get("types/Machine.md")!)!;
+    expect(machine.body).toContain("## Governed by");
+    const ruleLink = machine.body.match(/\[([A-Z0-9]+)\]\(\/rules\/([A-Z0-9]+)\.md\)/);
+    expect(ruleLink).not.toBeNull();
+    const rule = splitFrontmatter(files.get(`rules/${ruleLink![2]}.md`)!)!;
+    expect(rule.body).toContain("- [Machine](/types/Machine.md)");
+  }, 120_000);
+});