@sferarc/aula-pulumi 0.1.0 → 0.2.0

package/README.md

@@ -27,4 +27,6 @@ export const site = new SiteConfig("site", {
 });
 ```
 
-`pulumi up` creates or updates the school's site config; a second run plans no changes. The resource is never deleted with the stack.
+`pulumi up` creates or updates the school's site config; a second run plans no changes (a lesson type likewise, whatever order its prices are listed in). The resource is never deleted with the stack.
+
+`Domain` adds the school's custom domain and exposes the DNS records to publish as outputs (`pointsTo`, `ownershipRecord`, `verification`), so a DNS resource can reference them. It starts pending; run `pulumi refresh` once the records exist and the provider verifies it. Changing the hostname replaces the domain, and deleting it removes the domain from the school. The token needs `domain:write` and the plan `custom_domain`.

package/dist/domain.gen.d.ts

@@ -0,0 +1,16 @@
+import * as pulumi from "@pulumi/pulumi";
+export interface DomainArgs {
+    hostname: pulumi.Input<string>;
+}
+export declare const domainProvider: pulumi.dynamic.ResourceProvider;
+/** The school's custom domain for its main site. Its outputs hold the DNS records to publish (`pointsTo`, `ownershipRecord`, `verification`), so DNS resources can reference them. A pending domain is verified on each refresh once the records exist. Changing the hostname replaces the domain; deleting takes it off the school. */
+export declare class Domain extends pulumi.dynamic.Resource {
+    readonly hostname: pulumi.Output<string>;
+    readonly status: pulumi.Output<"pending" | "active" | "misconfigured" | "failed" | "removed">;
+    /** Where the hostname points: an A record at an apex, else a CNAME. */
+    readonly pointsTo: pulumi.Output<Record<string, unknown>>;
+    readonly ownershipRecord: pulumi.Output<Record<string, unknown>>;
+    readonly verification: pulumi.Output<Array<Record<string, unknown>>>;
+    readonly verifiedAt: pulumi.Output<string>;
+    constructor(name: string, args: DomainArgs, opts?: pulumi.CustomResourceOptions);
+}

package/dist/domain.gen.js

@@ -0,0 +1,73 @@
+// Code generated by @sferarc/iac-gen. DO NOT EDIT.
+import * as pulumi from "@pulumi/pulumi";
+import { callApi, setProviderConfig, stripUndefined } from "./runtime.js";
+const inputFields = ["hostname"];
+const updateFields = ["hostname"];
+const replaceFields = [];
+const defaultValues = {};
+const sortKeys = {};
+const derivedFields = [];
+const writeOnlyFields = [];
+// The form the API stores: trimmed text, no empty strings, sorted keys, and the lists it sorts.
+function canonical(value) {
+    if (typeof value === "string")
+        return value.trim() === "" ? null : value.trim();
+    if (Array.isArray(value))
+        return value.map(canonical);
+    if (value !== null && typeof value === "object") {
+        const entries = Object.entries(value).filter(([, v]) => v !== undefined);
+        return Object.fromEntries(entries.sort(([a], [b]) => (a < b ? -1 : 1)).map(([k, v]) => [k, canonical(v)]));
+    }
+    return value;
+}
+function comparable(key, value) {
+    const form = canonical(value) ?? defaultValues[key] ?? null;
+    const by = sortKeys[key];
+    if (by && Array.isArray(form)) {
+        const order = (item) => JSON.stringify(item?.[by] ?? null);
+        return JSON.stringify([...form].sort((a, b) => (order(a) < order(b) ? -1 : order(a) > order(b) ? 1 : 0)));
+    }
+    return JSON.stringify(form);
+}
+function pick(source, keys) {
+    const picked = {};
+    for (const key of keys)
+        picked[key] = source[key];
+    return picked;
+}
+export const domainProvider = {
+    async configure(req) {
+        setProviderConfig(req.config);
+    },
+    async create(inputs) {
+        const result = (await callApi("POST", `/api/v1/domain`, stripUndefined(pick(inputs, inputFields))));
+        const id = String(result["id"]);
+        return { id, outs: stripUndefined({ ...inputs, ...result }) };
+    },
+    async read(id, props) {
+        const current = (await callApi("GET", `/api/v1/domain`));
+        if (!current)
+            return {};
+        if (current["status"] === "pending") {
+            const verified = (await callApi("POST", `/api/v1/domain/verify`));
+            if (verified)
+                return { id, props: stripUndefined({ ...props, ...verified, ...pick(props, writeOnlyFields) }) };
+        }
+        const kept = pick(props, writeOnlyFields);
+        return { id, props: stripUndefined({ ...props, ...current, ...kept }) };
+    },
+    async delete(id, props) {
+        await callApi("DELETE", `/api/v1/domain`);
+    },
+    async diff(_id, olds, news) {
+        const changes = inputFields.filter((key) => !(derivedFields.includes(key) && canonical(news[key]) == null) &&
+            comparable(key, olds[key]) !== comparable(key, news[key]));
+        return { changes: changes.length > 0, deleteBeforeReplace: true, replaces: changes };
+    },
+};
+/** The school's custom domain for its main site. Its outputs hold the DNS records to publish (`pointsTo`, `ownershipRecord`, `verification`), so DNS resources can reference them. A pending domain is verified on each refresh once the records exist. Changing the hostname replaces the domain; deleting takes it off the school. */
+export class Domain extends pulumi.dynamic.Resource {
+    constructor(name, args, opts) {
+        super(domainProvider, name, { "status": undefined, "pointsTo": undefined, "ownershipRecord": undefined, "verification": undefined, "verifiedAt": undefined, ...args }, { ...opts, additionalSecretOutputs: [] });
+    }
+}

package/dist/index.d.ts

@@ -1 +1,3 @@
 export * from "./siteConfig.gen.js";
+export * from "./lessonType.gen.js";
+export * from "./domain.gen.js";

package/dist/index.js

@@ -1,2 +1,4 @@
 // Code generated by @sferarc/iac-gen. DO NOT EDIT.
 export * from "./siteConfig.gen.js";
+export * from "./lessonType.gen.js";
+export * from "./domain.gen.js";

package/dist/lessonType.gen.d.ts

@@ -0,0 +1,36 @@
+import * as pulumi from "@pulumi/pulumi";
+export interface LessonTypeArgs {
+    teacherId: pulumi.Input<string>;
+    title: pulumi.Input<string>;
+    description?: pulumi.Input<string>;
+    isTrial?: pulumi.Input<boolean>;
+    active?: pulumi.Input<boolean>;
+    capacity?: pulumi.Input<number>;
+    mode?: pulumi.Input<"online" | "in_person" | "either">;
+    address?: pulumi.Input<string>;
+    roomId?: pulumi.Input<string>;
+    subject?: pulumi.Input<string>;
+    level?: pulumi.Input<string>;
+    /** One price per lesson length, in minor units of the school's currency. */
+    prices: pulumi.Input<Array<Record<string, unknown>>>;
+}
+export declare const lessonTypeProvider: pulumi.dynamic.ResourceProvider;
+/** A lesson type of the catalogue. The teacher is fixed at creation, so changing it replaces the lesson type. Deleting archives it: bookings and purchases keep pointing at it. */
+export declare class LessonType extends pulumi.dynamic.Resource {
+    readonly teacherId: pulumi.Output<string>;
+    readonly title: pulumi.Output<string>;
+    readonly description: pulumi.Output<string>;
+    readonly isTrial: pulumi.Output<boolean>;
+    readonly active: pulumi.Output<boolean>;
+    readonly capacity: pulumi.Output<number>;
+    readonly mode: pulumi.Output<"online" | "in_person" | "either">;
+    readonly address: pulumi.Output<string>;
+    readonly roomId: pulumi.Output<string>;
+    readonly subject: pulumi.Output<string>;
+    readonly level: pulumi.Output<string>;
+    /** One price per lesson length, in minor units of the school's currency. */
+    readonly prices: pulumi.Output<Array<Record<string, unknown>>>;
+    readonly currency: pulumi.Output<string>;
+    readonly archived: pulumi.Output<boolean>;
+    constructor(name: string, args: LessonTypeArgs, opts?: pulumi.CustomResourceOptions);
+}

package/dist/lessonType.gen.js

@@ -0,0 +1,73 @@
+// Code generated by @sferarc/iac-gen. DO NOT EDIT.
+import * as pulumi from "@pulumi/pulumi";
+import { callApi, setProviderConfig, stripUndefined } from "./runtime.js";
+const inputFields = ["teacherId", "title", "description", "isTrial", "active", "capacity", "mode", "address", "roomId", "subject", "level", "prices"];
+const updateFields = ["title", "description", "isTrial", "active", "capacity", "mode", "address", "roomId", "subject", "level", "prices"];
+const replaceFields = ["teacherId"];
+const defaultValues = { "description": null, "isTrial": false, "active": true, "capacity": 1, "mode": "online", "address": null, "roomId": null, "subject": null, "level": null };
+const sortKeys = { "prices": "durationMinutes" };
+const derivedFields = ["address"];
+const writeOnlyFields = [];
+// The form the API stores: trimmed text, no empty strings, sorted keys, and the lists it sorts.
+function canonical(value) {
+    if (typeof value === "string")
+        return value.trim() === "" ? null : value.trim();
+    if (Array.isArray(value))
+        return value.map(canonical);
+    if (value !== null && typeof value === "object") {
+        const entries = Object.entries(value).filter(([, v]) => v !== undefined);
+        return Object.fromEntries(entries.sort(([a], [b]) => (a < b ? -1 : 1)).map(([k, v]) => [k, canonical(v)]));
+    }
+    return value;
+}
+function comparable(key, value) {
+    const form = canonical(value) ?? defaultValues[key] ?? null;
+    const by = sortKeys[key];
+    if (by && Array.isArray(form)) {
+        const order = (item) => JSON.stringify(item?.[by] ?? null);
+        return JSON.stringify([...form].sort((a, b) => (order(a) < order(b) ? -1 : order(a) > order(b) ? 1 : 0)));
+    }
+    return JSON.stringify(form);
+}
+function pick(source, keys) {
+    const picked = {};
+    for (const key of keys)
+        picked[key] = source[key];
+    return picked;
+}
+export const lessonTypeProvider = {
+    async configure(req) {
+        setProviderConfig(req.config);
+    },
+    async create(inputs) {
+        const result = (await callApi("POST", `/api/v1/lesson-types`, stripUndefined(pick(inputs, inputFields))));
+        const id = String(result["id"]);
+        return { id, outs: stripUndefined({ ...inputs, ...result }) };
+    },
+    async read(id, props) {
+        const current = (await callApi("GET", `/api/v1/lesson-types/${encodeURIComponent(id)}`));
+        if (!current)
+            return {};
+        const kept = pick(props, writeOnlyFields);
+        return { id, props: stripUndefined({ ...props, ...current, ...kept }) };
+    },
+    async update(id, _olds, news) {
+        const result = (await callApi("PUT", `/api/v1/lesson-types/${encodeURIComponent(id)}`, stripUndefined(pick(news, updateFields))));
+        return { outs: stripUndefined({ ...news, ...result }) };
+    },
+    async delete(id, props) {
+        await callApi("DELETE", `/api/v1/lesson-types/${encodeURIComponent(id)}`);
+    },
+    async diff(_id, olds, news) {
+        const changes = inputFields.filter((key) => !(derivedFields.includes(key) && canonical(news[key]) == null) &&
+            comparable(key, olds[key]) !== comparable(key, news[key]));
+        const replaces = changes.filter((key) => replaceFields.includes(key));
+        return { changes: changes.length > 0, replaces, deleteBeforeReplace: false };
+    },
+};
+/** A lesson type of the catalogue. The teacher is fixed at creation, so changing it replaces the lesson type. Deleting archives it: bookings and purchases keep pointing at it. */
+export class LessonType extends pulumi.dynamic.Resource {
+    constructor(name, args, opts) {
+        super(lessonTypeProvider, name, { "currency": undefined, "archived": undefined, ...args }, { ...opts, additionalSecretOutputs: [] });
+    }
+}

package/dist/siteConfig.gen.js

@@ -2,7 +2,33 @@
 import * as pulumi from "@pulumi/pulumi";
 import { callApi, setProviderConfig, stripUndefined } from "./runtime.js";
 const inputFields = ["version", "identity", "design", "locale", "classPolicy", "fees", "faq", "sections", "navigation", "pages", "emails", "sites"];
+const updateFields = ["version", "identity", "design", "locale", "classPolicy", "fees", "faq", "sections", "navigation", "pages", "emails", "sites"];
+const replaceFields = [];
+const defaultValues = {};
+const sortKeys = {};
+const derivedFields = [];
 const writeOnlyFields = [];
+// The form the API stores: trimmed text, no empty strings, sorted keys, and the lists it sorts.
+function canonical(value) {
+    if (typeof value === "string")
+        return value.trim() === "" ? null : value.trim();
+    if (Array.isArray(value))
+        return value.map(canonical);
+    if (value !== null && typeof value === "object") {
+        const entries = Object.entries(value).filter(([, v]) => v !== undefined);
+        return Object.fromEntries(entries.sort(([a], [b]) => (a < b ? -1 : 1)).map(([k, v]) => [k, canonical(v)]));
+    }
+    return value;
+}
+function comparable(key, value) {
+    const form = canonical(value) ?? defaultValues[key] ?? null;
+    const by = sortKeys[key];
+    if (by && Array.isArray(form)) {
+        const order = (item) => JSON.stringify(item?.[by] ?? null);
+        return JSON.stringify([...form].sort((a, b) => (order(a) < order(b) ? -1 : order(a) > order(b) ? 1 : 0)));
+    }
+    return JSON.stringify(form);
+}
 function pick(source, keys) {
     const picked = {};
     for (const key of keys)
@@ -26,7 +52,7 @@ export const siteConfigProvider = {
         return { id, props: stripUndefined({ ...props, ...current, ...kept }) };
     },
     async update(id, _olds, news) {
-        const result = (await callApi("PUT", `/api/v1/site-config`, stripUndefined(pick(news, inputFields))));
+        const result = (await callApi("PUT", `/api/v1/site-config`, stripUndefined(pick(news, updateFields))));
         return { outs: stripUndefined({ ...news, ...result }) };
     },
     async delete(id, props) {
@@ -34,8 +60,10 @@ export const siteConfigProvider = {
         void props;
     },
     async diff(_id, olds, news) {
-        const changes = inputFields.filter((key) => JSON.stringify(olds[key] ?? null) !== JSON.stringify(news[key] ?? null));
-        return { changes: changes.length > 0, deleteBeforeReplace: false };
+        const changes = inputFields.filter((key) => !(derivedFields.includes(key) && canonical(news[key]) == null) &&
+            comparable(key, olds[key]) !== comparable(key, news[key]));
+        const replaces = changes.filter((key) => replaceFields.includes(key));
+        return { changes: changes.length > 0, replaces, deleteBeforeReplace: false };
     },
 };
 /** The school's whole site document. One per school: it exists with the school, so it is read and replaced, never created or deleted. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sferarc/aula-pulumi",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Pulumi provider that declares an Aula school as code, generated from the management API's OpenAPI document",
   "keywords": [
     "pulumi",