forgeos 0.1.0-alpha.0

package/src/forge/feature/examples.ts

@@ -0,0 +1,125 @@
+import type { FeatureBlueprint } from "./types.ts";
+
+export const FEATURE_EXAMPLES: Record<string, FeatureBlueprint> = {
+  invoices: {
+    schemaVersion: "0.1.0",
+    name: "invoices",
+    description: "Add invoices resource with CRUD, live list and React page.",
+    mode: "create",
+    resources: [
+      {
+        name: "invoices",
+        tenantScoped: true,
+        fields: [
+          { name: "amount", type: "number", required: true },
+          {
+            name: "status",
+            type: "enum",
+            values: ["draft", "paid", "void"],
+            default: "draft",
+            indexed: true,
+          },
+          { name: "dueDate", type: "timestamp", optional: true },
+        ],
+        policies: {
+          read: ["owner", "admin", "member"],
+          create: ["owner", "admin"],
+          update: ["owner", "admin"],
+          delete: ["owner"],
+        },
+        crud: true,
+        liveQuery: true,
+        react: true,
+        frontend: {
+          react: true,
+          page: "/invoices",
+          components: ["list", "createForm"],
+        },
+        tests: true,
+      },
+    ],
+  },
+  "ticket-priority": {
+    schemaVersion: "0.1.0",
+    name: "ticket-priority",
+    description: "Add priority field, update command, liveQuery and badge component.",
+    mode: "modify",
+    changes: [
+      {
+        kind: "addField",
+        table: "tickets",
+        field: {
+          name: "priority",
+          type: "enum",
+          values: ["low", "medium", "high"],
+          default: "medium",
+          indexed: true,
+        },
+      },
+      {
+        kind: "addCommand",
+        name: "updateTicketPriority",
+        table: "tickets",
+        policy: "tickets.update",
+        emits: "ticket.priorityUpdated",
+      },
+      {
+        kind: "addLiveQuery",
+        name: "liveTicketsByPriority",
+        table: "tickets",
+        policy: "tickets.read",
+      },
+      {
+        kind: "addComponent",
+        name: "PriorityBadge",
+        table: "tickets",
+        fields: ["priority"],
+      },
+    ],
+  },
+  "customer-notes": {
+    schemaVersion: "0.1.0",
+    name: "customer-notes",
+    description: "Add customer notes resource for support context.",
+    mode: "create",
+    resources: [
+      {
+        name: "customerNotes",
+        tenantScoped: true,
+        fields: [
+          { name: "customerId", type: "ref", refTable: "customers", required: true },
+          { name: "body", type: "text", required: true },
+          { name: "visibility", type: "enum", values: ["internal", "shared"], default: "internal" },
+        ],
+        crud: true,
+        liveQuery: true,
+        react: false,
+        tests: true,
+      },
+    ],
+  },
+  "support-sla": {
+    schemaVersion: "0.1.0",
+    name: "support-sla",
+    description: "Add SLA policy data for support tickets.",
+    mode: "modify",
+    changes: [
+      {
+        kind: "addField",
+        table: "tickets",
+        field: { name: "slaDueAt", type: "timestamp", optional: true, indexed: true },
+      },
+      {
+        kind: "addField",
+        table: "tickets",
+        field: {
+          name: "slaStatus",
+          type: "enum",
+          values: ["on_track", "at_risk", "breached"],
+          default: "on_track",
+          indexed: true,
+        },
+      },
+    ],
+  },
+};

package/src/forge/feature/types.ts

@@ -0,0 +1,177 @@
+import type { Diagnostic } from "../compiler/types/diagnostic.ts";
+import type { MakeCommandOptions, MakeFieldSpec, MakeIntent, MakePlan, PlannedFile, PlannedPatch } from "../make/types.ts";
+
+export type FeatureAction =
+  | "validate"
+  | "plan"
+  | "diff"
+  | "apply"
+  | "list"
+  | "inspect"
+  | "rollback"
+  | "examples";
+
+export type FeatureMode = "create" | "modify";
+export type FeatureRiskLevel = "low" | "medium" | "high";
+
+export interface BlueprintField {
+  name: string;
+  type: MakeFieldSpec["type"];
+  required?: boolean;
+  optional?: boolean;
+  default?: unknown;
+  defaultNow?: boolean;
+  values?: string[];
+  refTable?: string;
+  unique?: boolean;
+  indexed?: boolean;
+  label?: string;
+  description?: string;
+}
+
+export interface ResourceBlueprint {
+  name: string;
+  singularName?: string;
+  tenantScoped?: boolean;
+  fields: BlueprintField[];
+  policies?: Partial<Record<"read" | "create" | "update" | "delete", string[]>>;
+  commands?: Partial<Record<"create" | "update" | "delete", boolean>>;
+  queries?: Partial<Record<"list" | "get", boolean>>;
+  liveQueries?: Partial<Record<"list", boolean>>;
+  actions?: Array<{ name: string; event: string }>;
+  workflows?: Array<{ name: string; trigger: string; withAi?: boolean }>;
+  frontend?: {
+    react?: boolean;
+    page?: string;
+    components?: string[];
+  };
+  crud?: boolean;
+  liveQuery?: boolean;
+  react?: boolean;
+  tests?: boolean | { smoke?: boolean };
+}
+
+export type FeatureChange =
+  | { kind: "addField"; table: string; field: BlueprintField }
+  | { kind: "addPolicy"; name: string; roles: string[] }
+  | { kind: "addCommand"; name: string; table: string; policy?: string; emits?: string }
+  | { kind: "addQuery"; name: string; table: string; policy?: string }
+  | { kind: "addLiveQuery"; name: string; table: string; policy?: string; where?: Record<string, unknown> }
+  | { kind: "addAction"; name: string; table?: string; event: string }
+  | { kind: "addWorkflow"; name: string; table?: string; trigger: string; withAi?: boolean }
+  | { kind: "addComponent"; name: string; table: string; fields?: string[] }
+  | { kind: "updateFrontend"; table: string; page?: string; component?: string };
+
+export interface FeatureBlueprint {
+  schemaVersion: string;
+  name: string;
+  description?: string;
+  mode?: FeatureMode;
+  resources?: ResourceBlueprint[];
+  changes?: FeatureChange[];
+  frontend?: Record<string, unknown>;
+  tests?: Record<string, unknown>;
+  metadata?: {
+    owner?: string;
+    risk?: FeatureRiskLevel;
+    tags?: string[];
+  };
+}
+
+export interface FeatureImpact {
+  data: {
+    tablesAdded: string[];
+    tablesModified: string[];
+    fieldsAdded: string[];
+  };
+  runtime: {
+    commandsAdded: string[];
+    queriesAdded: string[];
+    liveQueriesAdded: string[];
+    actionsAdded: string[];
+    workflowsAdded: string[];
+  };
+  frontend: {
+    pagesAdded: string[];
+    componentsAdded: string[];
+  };
+  policies: {
+    policiesAdded: string[];
+    policiesModified: string[];
+  };
+  tests: {
+    testsAdded: string[];
+  };
+}
+
+export interface FeatureRisk {
+  level: FeatureRiskLevel;
+  reasons: string[];
+}
+
+export interface FeaturePlan {
+  schemaVersion: "0.1.0";
+  plannerVersion: string;
+  id: string;
+  blueprintName: string;
+  blueprintHash: string;
+  summary: string;
+  makeIntents: MakeIntent[];
+  makeOptions: MakeCommandOptions[];
+  makePlans: MakePlan[];
+  filesToCreate: PlannedFile[];
+  filesToModify: PlannedPatch[];
+  filesToDelete: Array<{ file: string; description: string }>;
+  impact: FeatureImpact;
+  risk: FeatureRisk;
+  commandsToRun: string[];
+  diagnostics: Diagnostic[];
+  rollback: {
+    trackedFiles: string[];
+    instructions: string[];
+  };
+}
+
+export interface FeatureApplyRecord {
+  schemaVersion: "0.1.0";
+  featureId: string;
+  blueprintName: string;
+  blueprintHash: string;
+  status: "applied" | "rolled-back";
+  filesCreated: string[];
+  filesModified: string[];
+  commandsRun: string[];
+  result: {
+    ok: boolean;
+  };
+}
+
+export interface FeatureCommandOptions {
+  action: FeatureAction;
+  blueprintPath?: string;
+  featureId?: string;
+  exampleName?: string;
+  writePath?: string;
+  workspaceRoot: string;
+  json: boolean;
+  dryRun: boolean;
+  yes: boolean;
+  noGenerate: boolean;
+  noVerify: boolean;
+  keepFailed: boolean;
+  update: boolean;
+  allowHighRisk: boolean;
+}
+
+export interface FeatureResult {
+  ok: boolean;
+  plan?: FeaturePlan;
+  blueprint?: FeatureBlueprint;
+  record?: FeatureApplyRecord;
+  records?: FeatureApplyRecord[];
+  examples?: string[];
+  diff?: string;
+  explanation?: string;
+  diagnostics: Diagnostic[];
+  exitCode: 0 | 1;
+}