@cyc-seattle/platform 1.31.0 → 1.33.0

package/README.md

@@ -107,9 +107,11 @@ GitHub environment that holds its identity and state bucket:
 | Run by hand, from a branch | `ci`, then `dev`                                                                               |
 | Run by hand, from `main`   | `prod-preview`, then `prod`                                                                    |
 
-Dev is shared, so only the merge queue deploys to it, one PR at a time (#69, #80). The queue
-requires `dev-passed`, so a PR merges only once its dev deploy and the integration tests pass, and
-`main` gets the exact commit the queue tested. A queued PR of only docs or CI skips `dev`. To try a
+Dev is shared, so only the merge queue deploys to it (#69, #80). PRs queued together deploy and
+test as one batch: each queued PR's run skips dev when a newer PR is queued behind it, and the newest
+tests them all. The queue requires `dev-passed`, so a batch merges only once its dev deploy and the
+integration tests pass, and `main` gets the exact commit the queue tested, in one push. If the
+newest PR fails, the queue drops it and the rest of the batch deploys without it. A queued PR of only docs or CI skips `dev`. To try a
 branch on dev before queueing it, run `gh workflow run pull-request.yml --ref <branch>`.
 
 `prod-preview` runs `mise run preview` as `deploy-runner` and writes the diff to the job summary.

package/dist/planning/activities.js

@@ -7,7 +7,7 @@ export function scheduleActivities(ctx) {
     const trips = new Map(ctx.data.plan_trips.map((t) => [t.id, t]));
     const closed = new Map();
     for (const c of ctx.data.plan_closed_dates ?? []) {
-        // The club's closed days are the Operations Plan's, not an area's.
+        // The closed days are the Operations Plan's, not an area's.
         if (ctx.planOfVersion.get(c.version_id)?.kind === "program_area") {
             ctx.warn("closed_date_in_area_plan", `${c.name} is a closed day in a program area's plan, so it's ignored`, c.key);
             continue;
@@ -32,7 +32,7 @@ export function scheduleActivities(ctx) {
         const span = start !== null && end !== null ? end - start : 0;
         const closedFor = closed.get(activity.date);
         if (closedFor !== undefined && activity.kind !== "travel") {
-            ctx.warn("closed_date", `${offering.name} has an activity on ${activity.date}, when the club is closed for ${closedFor}`, activity.key);
+            ctx.warn("closed_date", `${offering.name} has an activity on ${activity.date}, a closed day: ${closedFor}`, activity.key);
         }
         const usesBoats = activity.kind !== "travel" && activity.uses_boats;
         result.push({

package/dist/planning/engine.js

@@ -66,14 +66,6 @@ function checkAreas(ctx) {
             ctx.warn("offering_in_wrong_plan", `Offering ${offering.name} of ${product.name} is in ${where}`, offering.key);
         }
     }
-    const operations = new Set(ctx.data.plan_versions.filter((v) => ctx.planOfVersion.get(v.id)?.kind === "operations").map((v) => v.id));
-    for (const version of ctx.data.plan_versions) {
-        const pinned = version.operations_version_id;
-        if (pinned == null || operations.size === 0 || operations.has(pinned))
-            continue;
-        const area = ctx.areas.get(ctx.planOfVersion.get(version.id)?.program_area_id ?? "");
-        ctx.warn("other_operations_version", `${area?.name ?? "A program area"}'s plan was saved with a different Operations Plan version from the one it's calculated with`, version.id);
-    }
 }
 /** Each salaried position's year: its salary, where its hours went, and its hourly wages and bonus. */
 function summarizePositions(ctx, coaching, charged, bonuses, doubleBooked) {

package/dist/planning/types.d.ts

@@ -23,7 +23,7 @@ export interface Product {
     /** Every program has one; merchandise, storage and charters have none. */
     program_area_id: Id | null;
 }
-/** A part of the club's programs, such as Summer, with its revenue account. */
+/** A part of the organization's programs, such as Summer, with its revenue account. */
 export interface ProgramArea {
     id: Id;
     name: string;
@@ -83,8 +83,6 @@ export interface Plan {
 export interface PlanVersion {
     id: Id;
     plan_id: Id;
-    /** A saved area plan's: the Operations Plan version it was saved with. */
-    operations_version_id?: Id | null;
 }
 export type ActivityKind = "practice" | "regatta" | "clinic" | "travel";
 export interface PlanOffering extends Versioned {
@@ -265,7 +263,7 @@ export interface PlanRevenueCharge extends Versioned {
     excluded_from_mtdc: boolean;
     note: string | null;
 }
-/** A day the club is closed, such as Labor Day. */
+/** A day the organization is closed, such as Labor Day. */
 export interface PlanClosedDate extends Versioned {
     date: DateString;
     name: string;

package/dist/schema/index.d.ts

@@ -3,6 +3,7 @@ export interface Schema {
     accounts: Accounts[];
     audit_findings: AuditFindings[];
     boat_classes: BoatClasses[];
+    catalog_offerings: CatalogOfferings[];
     clubspot_camps: ClubspotCamps[];
     clubspot_classes: ClubspotClasses[];
     clubspot_custom_field_definitions: ClubspotCustomFieldDefinitions[];
@@ -22,12 +23,12 @@ export interface Schema {
     group_members: GroupMembers[];
     group_policies: GroupPolicies[];
     groups: Groups[];
+    households: Households[];
     medical_profiles: MedicalProfiles[];
     offerings: Offerings[];
     organization_cost_accounts: OrganizationCostAccounts[];
     organizations: Organizations[];
     people: People[];
-    plan_activations: PlanActivations[];
     plan_activities: PlanActivities[];
     plan_activity_block_rules: PlanActivityBlockRules[];
     plan_activity_resources: PlanActivityResources[];
@@ -45,7 +46,6 @@ export interface Schema {
     plan_result_lines: PlanResultLines[];
     plan_result_pnl: PlanResultPnl[];
     plan_result_positions: PlanResultPositions[];
-    plan_result_versions: PlanResultVersions[];
     plan_result_warnings: PlanResultWarnings[];
     plan_results: PlanResults[];
     plan_revenue_charges: PlanRevenueCharges[];
@@ -109,6 +109,14 @@ export interface BoatClasses {
     /** Dry-storage area one boat takes. */
     footprint_sq_ft: string | null;
 }
+/** An offering of a program that plans and Clubspot both point to, such as "J-Pod · fall practices" or "Summer camp · week 3". Each Financial Plan sets its own price, schedule, and size for it, and Clubspot's offerings are linked to it. */
+export interface CatalogOfferings {
+    id: string;
+    /** The program it's an offering of. */
+    program_id: string | Programs;
+    /** Which offering of the program, such as "fall practices" or "week 3". */
+    name: string;
+}
 /** A dated event, such as a season's race team. Copied from Clubspot, so edit it there. */
 export interface ClubspotCamps {
     /** Clubspot's own ID for this row. */
@@ -364,6 +372,15 @@ export interface Groups {
     /** The policies this group gives its members. */
     policies: (string | GroupPolicies)[];
 }
+/** A sailor and everyone listed as their parent, together with the parents' other children. Made from the Clubspot sign-ups, so change who's in one by fixing the people and their parents. */
+export interface Households {
+    id: string;
+    /** Everyone in the household. */
+    members: (string | People)[];
+    /** Whether the household's adults share their email and phone with the teams they're on. Blank means never answered, which counts as not shared. A child's own email and phone are never shared. */
+    share_contact: boolean | null;
+    date_created: string | null;
+}
 /** A person's medical information, kept apart from People so only some staff see it. */
 export interface MedicalProfiles {
     id: string;
@@ -428,25 +445,17 @@ export interface People {
     /** Every email and phone known for this person. */
     contact_point_links: (string | ContactPoints)[];
     school: string | null;
-    /** Null means never answered - treated as not shared. */
+    /** What this adult last answered before households held the answer. Kept for reference only: the household's answer counts now. */
     share_contact: boolean | null;
     /** What this person is signed up for. */
     registrations: (string | Registrations)[];
+    /** The name the club's apps show, if the person or their family gave one. Blank shows the first and last name. */
+    display_name: string | null;
+    /** Set by the Clubspot sync from the person's parents and children, so change those instead. */
+    household_id: string | Households | null;
     /** The person's own Directus login, if they have one. Usually empty. */
     directus_user_id: string | null;
 }
-/** Each time a saved version was made active. A plan's newest activation is its active version. */
-export interface PlanActivations {
-    id: string;
-    plan_id: string | Plans;
-    /** A saved version of the plan. */
-    version_id: string | PlanVersions;
-    /** Set when the version is made active. */
-    activated_at: string;
-    activated_by: string | null;
-    /** Set when the version is made active. The plan's active version is the one with the highest. */
-    sequence: number;
-}
 /** One dated activity, such as a practice, a regatta day, or a travel day. */
 export interface PlanActivities {
     id: string;
@@ -551,7 +560,7 @@ export interface PlanBudgetLines {
     account_id: string | Accounts;
     function: "program" | "management" | "fundraising" | null;
     cost_center_type: "offering" | "product" | "program_area" | "pool" | "org";
-    /** Who the cost is charged to: copy the Key from an offering or a pool, or a product's ID from the end of its page's web address. Leave empty for the whole club. */
+    /** Who the cost is charged to: copy the Key from an offering or a pool, or a product's ID from the end of its page's web address. Leave empty for the whole organization. */
     cost_center_key: string | null;
     /** In cents: 12500 is $125.00. */
     amount_cents: number;
@@ -560,7 +569,7 @@ export interface PlanBudgetLines {
     excluded_from_mtdc: boolean;
     note: string | null;
 }
-/** A day the club is closed, such as Labor Day. The P&L warns about an activity on one. */
+/** A day the organization is closed, such as Labor Day. The P&L warns about an activity on one. */
 export interface PlanClosedDates {
     id: string;
     /** The version this row belongs to. */
@@ -580,7 +589,7 @@ export interface PlanLaborLines {
     key: string;
     name: string;
     cost_center_type: "offering" | "product" | "program_area" | "pool" | "org";
-    /** Who the cost is charged to: copy the Key from an offering or a pool, or a product's ID from the end of its page's web address. Leave empty for the whole club. */
+    /** Who the cost is charged to: copy the Key from an offering or a pool, or a product's ID from the end of its page's web address. Leave empty for the whole organization. */
     cost_center_key: string | null;
     /** Who does the work: copy the Key from a staff level in the Operations Plan. */
     staff_level_key: string;
@@ -609,6 +618,8 @@ export interface PlanOfferings {
     /** Stays the same across versions. Copy it where another row asks for this one's Key. */
     key: string;
     product_id: string | Products;
+    /** Which of the program's catalog offerings this is, such as "J-Pod · fall practices". It's how Clubspot's sign-ups find it, in every Financial Plan. */
+    catalog_offering_id: string | CatalogOfferings | null;
     name: string;
     season_term: string | null;
     starts_on: string;
@@ -651,7 +662,7 @@ export interface PlanPools {
     key: string;
     name: string;
 }
-/** The year's rates. One row at most in each version. */
+/** The year's rates. One row at most in each copy. */
 export interface PlanRates {
     id: string;
     /** The version this row belongs to. */
@@ -688,11 +699,9 @@ export interface PlanResources {
     /** Set for a rental, whose cost is left out of modified total direct costs (MTDC). */
     excluded_from_mtdc: boolean;
 }
-/** Each cost and revenue line in a saved version's P&L. Worked out when the version was saved, and never changed. */
+/** Each cost and revenue line in a saved Financial Plan's P&L. Worked out when it was saved, and never changed. */
 export interface PlanResultLines {
     id: string;
-    /** The saved version these results are for, if they aren't a club plan's. */
-    version_id: string | PlanVersions | null;
     cost_center_type: "offering" | "product" | "program_area" | "pool" | "org";
     cost_center_key: string | null;
     cost_center_name: string;
@@ -703,18 +712,16 @@ export interface PlanResultLines {
     /** The engine's key for the line. */
     line: string;
     explanation: string | null;
-    /** The club plan these results are for, if they aren't a version's. */
-    version_set_id: string | VersionSets | null;
-    /** In a club plan's results, the plan that holds what it's charged to. */
+    /** The Financial Plan these results are for. */
+    version_set_id: string | VersionSets;
+    /** The plan in the Financial Plan that holds what it's charged to. */
     version_set_member_id: string | VersionSetMembers | null;
     /** What the line is, in plain words, such as G&A share: Payroll tax. */
     line_name: string | null;
 }
-/** A saved version's P&L for each offering, product, and program area. Worked out when the version was saved, and never changed. */
+/** A saved Financial Plan's P&L for each offering, product, and program area. Worked out when it was saved, and never changed. */
 export interface PlanResultPnl {
     id: string;
-    /** The saved version these results are for, if they aren't a club plan's. */
-    version_id: string | PlanVersions | null;
     level: "offering" | "product" | "program_area";
     subject_key: string;
     name: string;
@@ -729,16 +736,14 @@ export interface PlanResultPnl {
     enrollment: number;
     days: number;
     sailor_days: number;
-    /** The club plan these results are for, if they aren't a version's. */
-    version_set_id: string | VersionSets | null;
-    /** In a club plan's results, the plan that holds what it's charged to. */
+    /** The Financial Plan these results are for. */
+    version_set_id: string | VersionSets;
+    /** The plan in the Financial Plan that holds what it's charged to. */
     version_set_member_id: string | VersionSetMembers | null;
 }
-/** Each salaried position's pay for the year, in a saved version. Worked out when the version was saved, and never changed. */
+/** Each salaried position's pay for the year, in a saved Financial Plan. Worked out when it was saved, and never changed. */
 export interface PlanResultPositions {
     id: string;
-    /** The saved version these results are for, if they aren't a club plan's. */
-    version_id: string | PlanVersions | null;
     position_key: string;
     name: string;
     /** In cents: 12500 is $125.00. */
@@ -758,38 +763,26 @@ export interface PlanResultPositions {
     total_pay_cents: number;
     /** The year's payroll tax on the total pay. In cents: 12500 is $125.00. */
     payroll_tax_cents: number;
-    /** The club plan these results are for, if they aren't a version's. */
-    version_set_id: string | VersionSets | null;
+    /** The Financial Plan these results are for. */
+    version_set_id: string | VersionSets;
     /** Hours another coach would cover while this position coaches two or more groups at once: for three groups at once, two coaches. */
     double_booked_hours: string | null;
     /** Dates this position coaches two or more groups at once. */
     double_booked_dates: number | null;
 }
-/** The other saved versions a version's results were worked out with. Worked out when the version was saved, and never changed. */
-export interface PlanResultVersions {
-    id: string;
-    /** The saved version these results are for. */
-    version_id: string | PlanVersions;
-    /** Another saved version in the club's plan when this one was saved. */
-    calculated_with_id: string | PlanVersions;
-}
-/** What the P&L warned about when a version was saved. Worked out when the version was saved, and never changed. */
+/** What the P&L warned about when a Financial Plan was saved. Worked out when it was saved, and never changed. */
 export interface PlanResultWarnings {
     id: string;
-    /** The saved version these results are for, if they aren't a club plan's. */
-    version_id: string | PlanVersions | null;
     /** The kind of warning. */
     code: string;
     message: string;
     subject_key: string | null;
-    /** The club plan these results are for, if they aren't a version's. */
-    version_set_id: string | VersionSets | null;
+    /** The Financial Plan these results are for. */
+    version_set_id: string | VersionSets;
 }
-/** A saved version's club-wide totals. Worked out when the version was saved, and never changed. */
+/** A saved Financial Plan's totals for the organization. Worked out when it was saved, and never changed. */
 export interface PlanResults {
     id: string;
-    /** The saved version these results are for, if they aren't a club plan's. */
-    version_id: string | PlanVersions | null;
     calculated_at: string;
     /** In cents: 12500 is $125.00. */
     operating_revenue_cents: number;
@@ -807,8 +800,8 @@ export interface PlanResults {
     capital_cents: number;
     /** Operating net, plus fundraising net, less capital. In cents: 12500 is $125.00. */
     total_cents: number;
-    /** The club plan these results are for, if they aren't a version's. */
-    version_set_id: string | VersionSets | null;
+    /** The Financial Plan these results are for. */
+    version_set_id: string | VersionSets;
 }
 /** A charge set as a share of each offering's revenue, such as scholarships or card fees. Operations Plan only. */
 export interface PlanRevenueCharges {
@@ -892,43 +885,39 @@ export interface PlanTrips {
     airfare_cents: number | null;
     miles: number | null;
 }
-/** A plan's draft, or a version saved from it, which never changes. */
+/** One plan's copy in one Financial Plan, with every row it holds. It's saved with its Financial Plan, and then never changes. */
 export interface PlanVersions {
     id: string;
     plan_id: string | Plans;
-    /** The saved version this draft started from. */
+    /** The copy this one was made from, in the Financial Plan this one's started from. */
     parent_version_id: string | PlanVersions | null;
-    /** Saving a draft sets this to saved. A saved version never changes, even for an admin. */
+    /** Saved with its Financial Plan. A saved copy never changes, even for an admin. */
     status: "draft" | "saved";
     /** What changed in this version. */
     message: string | null;
-    /** Set when the version is saved. */
+    /** Set when its Financial Plan is saved. */
     saved_by: string | null;
-    /** Set when the version is saved. */
+    /** Set when its Financial Plan is saved. */
     saved_at: string | null;
     /** The version of the planning engine that calculated its numbers. Required to save. */
     platform_version: string | null;
-    /** For a program area's plan: the saved Operations Plan version its numbers were calculated with, for the same organization and year. Required to save. Empty for the Operations Plan. */
-    operations_version_id: string | PlanVersions | null;
     /** What you want that the plan's numbers don't capture, for your AI to fill in. For example: every Monday, Wednesday and Friday, except on SPS school holidays, from 4pm until dusk. */
     rules: string | null;
-    /** What the P&L showed when this version was saved, worked out a moment after it's saved. A saved version with none means working them out failed, and an admin can fill them in. */
-    results: (string | PlanResults)[];
 }
-/** One part of the club's plan: a program area's plan, or the Operations Plan. */
+/** One part of a Financial Plan: a program area's Program Plan, or the Operations Plan. */
 export interface Plans {
     id: string;
     kind: "program_area" | "operations";
     /** The program area the plan is for. Empty for the Operations Plan. */
     program_area_id: string | ProgramAreas | null;
-    /** The organization the plan is for. Can't change once the plan has a saved version. */
+    /** The organization the plan is for. Can't change once the plan has a saved copy. */
     organization_id: string | Organizations;
-    /** The plan year. Fiscal year N ends in calendar year N. Can't change once the plan has a saved version. */
+    /** The plan year. Fiscal year N ends in calendar year N. Can't change once the plan has a saved copy. */
     fiscal_year: number;
     name: string;
-    /** A plan with a saved version can't be deleted, so archive it instead. */
+    /** A plan with a saved copy can't be deleted, so archive it instead. */
     archived: boolean;
-    /** The plan's draft and saved versions. */
+    /** The plan's copy in each Financial Plan. */
     versions: (string | PlanVersions)[];
 }
 /** A lasting thing the club sells. A program also has a row in Programs. */
@@ -1054,33 +1043,38 @@ export interface SyncTasks {
     /** Set once the task has failed too many times. It keeps retrying; this flags it for staff. */
     needs_attention: boolean;
 }
-/** One plan's version in a club plan. Set when the club plan is saved, and never changed. */
+/** One plan in a Financial Plan: the copy of the plan it holds. Add or remove one only while the Financial Plan is a draft. */
 export interface VersionSetMembers {
     id: string;
     version_set_id: string | VersionSets;
-    plan_id: string | Plans;
-    /** The plan's active version when the club plan was saved. */
+    /** Filled in from the plan copy. */
+    plan_id: string | Plans | null;
+    /** The plan's copy in this Financial Plan. It's in no other Financial Plan. */
     version_id: string | PlanVersions;
 }
-/** The club's plan for a year, saved: the active Operations Plan version and each program area's, with the P&L they make together. Saved when it's added, and never changed. */
+/** The organization's plan for a year: one Operations Plan, and a Program Plan for any of the program areas, with the P&L they make together. Change its plans while it's a draft. Saving it saves them all, and then it never changes, apart from its note. Pick a parent when you add one, and its plans are copied in. */
 export interface VersionSets {
     id: string;
-    /** The organization the club plan is for. */
+    /** The organization the Financial Plan is for. */
     organization_id: string | Organizations;
-    /** The year the club plan is for. */
+    /** The year the Financial Plan is for. */
     fiscal_year: number;
     /** Such as 2027 budget as adopted. */
     name: string;
-    /** Why it was saved. */
+    /** What it was for, such as "Reviewed with the board". You can change it after it's saved. */
     message: string | null;
-    /** Set when the club plan is saved. */
+    /** Set it to saved to save the Financial Plan and all its plans. A saved Financial Plan never changes, apart from its note. Set a saved one to active to make it the one its organization runs for the year, which sets the one active before it back to saved. */
+    status: "draft" | "saved" | "active";
+    /** The Financial Plan this one started as a copy of. Pick it when you add this one, and its plans are copied in. */
+    parent_id: string | VersionSets | null;
+    /** Set when the Financial Plan is saved. */
     saved_by: string | null;
-    /** Set when the club plan is saved. */
+    /** Set when the Financial Plan is saved. */
     saved_at: string | null;
     /** The version of the planning engine that calculated its numbers. */
     platform_version: string | null;
-    /** The active version of each plan when the club plan was saved. */
+    /** Each plan in the Financial Plan. Add or remove one only while it's a draft. */
     members: (string | VersionSetMembers)[];
-    /** What the club's P&L showed when it was saved, worked out a moment after. A club plan with none means working them out failed, and an admin can fill them in. */
+    /** What the organization's P&L showed when it was saved, worked out a moment after. A Financial Plan with none means working them out failed, and an admin can fill them in. */
     results: (string | PlanResults)[];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cyc-seattle/platform",
-  "version": "1.31.0",
+  "version": "1.33.0",
   "description": "Pulumi components for CYC's shared Google Cloud platform: WebService, the platform outputs reader, and the stacks that build the platform",
   "author": "CYC Community Sailing Center",
   "license": "Apache-2.0",