@wtfalch/foundry 0.4.0 → 0.5.0

package/dist/store/schema.js

@@ -88,4 +88,61 @@ export const foundryAuditEvents = pgTable('foundry_audit_events', {
     outcome: text('outcome').$type(),
     reason: text('reason'),
     plan: jsonb('plan').$type(),
+    /** `'platform'` for a platform plan or apply (`migrations/0018_platform_apply.sql`); null for an org's row. */
+    target: text('target').$type(),
+});
+/**
+ * Mirrors `migrations/0016_platform.sql`, which is the source of truth: the
+ * SQL carries the singleton `check (id)` constraint drizzle-kit does not
+ * generate here (this package has no drizzle-kit journal, per the top of
+ * this file). `id` is always `true` -- see that migration's own comment.
+ */
+export const foundryDeclaredPlatform = pgTable('foundry_declared_platform', {
+    id: boolean('id').primaryKey().default(true),
+    ownerOrgId: text('owner_org_id').notNull(),
+    apex: text('apex').notNull(),
+    authEnabled: boolean('auth_enabled').notNull().default(false),
+    authHostname: text('auth_hostname').notNull(),
+    authGitRef: text('auth_git_ref').notNull().default(''),
+    mailEnabled: boolean('mail_enabled').notNull().default(false),
+    mailHostname: text('mail_hostname').notNull(),
+    mailGitRef: text('mail_git_ref').notNull().default(''),
+    sfuEnabled: boolean('sfu_enabled').notNull().default(false),
+    sfuHostname: text('sfu_hostname').notNull(),
+    sfuGitRef: text('sfu_git_ref').notNull().default(''),
+    filesEnabled: boolean('files_enabled').notNull().default(false),
+    filesHostname: text('files_hostname').notNull(),
+    filesGitRef: text('files_git_ref').notNull().default(''),
+    aiEnabled: boolean('ai_enabled').notNull().default(false),
+    aiHostname: text('ai_hostname').notNull(),
+    aiGitRef: text('ai_git_ref').notNull().default(''),
+    jobsEnabled: boolean('jobs_enabled').notNull().default(false),
+    jobsHostname: text('jobs_hostname').notNull(),
+    jobsGitRef: text('jobs_git_ref').notNull().default(''),
+    integrationsEnabled: boolean('integrations_enabled').notNull().default(false),
+    integrationsHostname: text('integrations_hostname').notNull(),
+    integrationsGitRef: text('integrations_git_ref').notNull().default(''),
+    archonEnabled: boolean('archon_enabled').notNull().default(false),
+    archonHostname: text('archon_hostname').notNull(),
+    archonGitRef: text('archon_git_ref').notNull().default(''),
+    /** `migrations/0018_platform_apply.sql`: the platform's applied state, `system:kind:key` to provider id. */
+    serviceIds: jsonb('service_ids').$type().notNull().default({}),
+    createdAt: timestamp('created_at', { withTimezone: true }).notNull().defaultNow(),
+    updatedAt: timestamp('updated_at', { withTimezone: true }).notNull().defaultNow(),
+});
+/**
+ * Mirrors `migrations/0017_requested_changes.sql`, which is the source of
+ * truth: the SQL carries the `field`/`state` CHECKs drizzle-kit does not
+ * generate here (this package has no drizzle-kit journal, per the top of
+ * this file). `value` holds only the field-specific payload -- `field`
+ * itself is the discriminator column, not repeated inside the jsonb.
+ */
+export const foundryRequestedChanges = pgTable('foundry_requested_changes', {
+    id: bigserial('id', { mode: 'number' }).primaryKey(),
+    orgId: text('org_id').notNull(),
+    field: text('field').notNull(),
+    value: jsonb('value').notNull().$type(),
+    requestedBy: text('requested_by').notNull(),
+    createdAt: timestamp('created_at', { withTimezone: true }).notNull().defaultNow(),
+    state: text('state').notNull().default('needs_approval'),
 });

package/dist/store.d.ts

@@ -1,4 +1,6 @@
 import type { DeclaredOrg, OrgId } from './org.js';
+import type { DeclaredPlatform } from './platform.js';
+import type { RequestedChange, RequestedChangeValue } from './requested-changes.js';
 import type { AppliedState } from './state.js';
 /**
  * The persistence seam https://github.com/wtfalch/foundry/issues/18
@@ -43,3 +45,47 @@ export interface DeclaredOrgStore {
      */
     delete(id: OrgId): Promise<void>;
 }
+/**
+ * The persistence seam for #166's {@link DeclaredPlatform}, mirroring
+ * {@link DeclaredOrgStore}'s split beside it. There is exactly one declared
+ * platform -- `get`/`put` take no id, and `migrations/0016_platform.sql`'s
+ * singleton table refuses a second row at the database level.
+ */
+export interface PlatformStore {
+    /** `null` until an operator declares the platform for the first time. */
+    get(): Promise<DeclaredPlatform | null>;
+    /** Creates the platform on the first call, replaces it on every later one. */
+    put(platform: DeclaredPlatform): Promise<void>;
+    /**
+     * The platform's applied state (#167): the provider ids its apply made or
+     * adopted, keyed `system:kind:key` like `AppliedState.serviceIds`. `{}`
+     * before the first apply. `put` never touches it.
+     */
+    getServiceIds(): Promise<Record<string, string>>;
+    /** Replaces the recorded ids. A no-op until the platform is declared. */
+    putServiceIds(serviceIds: Record<string, string>): Promise<void>;
+}
+/**
+ * The persistence seam for #178's {@link RequestedChange}: a company's own
+ * Boule requests a setting change on its declared org, foundry classifies
+ * and stores it, and archon reads it back to drive its own approve/apply
+ * workflow.
+ */
+export interface RequestedChangeStore {
+    /**
+     * Classifies `value` against `org`'s current state
+     * (`requested-changes.js`'s `classifyChange`) and stores the request,
+     * keyed by a generated id. Throws `requested-changes.js`'s
+     * `RequestedChangeError` for a field outside the whitelist -- never
+     * silently drops the write.
+     */
+    create(input: {
+        orgId: OrgId;
+        org: DeclaredOrg;
+        value: RequestedChangeValue;
+        requestedBy: string;
+    }): Promise<RequestedChange>;
+    get(id: number): Promise<RequestedChange | null>;
+    /** Every request an org has made, oldest first. */
+    listForOrg(orgId: OrgId): Promise<RequestedChange[]>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wtfalch/foundry",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Foundry's SDK: the declared org's types, the plan and apply contracts, and the state store's interface.",
   "repository": {
     "type": "git",