@sferarc/aula-pulumi 0.0.0-stage → 0.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Sferarc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,30 @@
-# Temporary Holding Version
+# @sferarc/aula-pulumi
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Pulumi dynamic provider for an Aula school, generated by `@sferarc/iac-gen` from `apps/aula/openapi/v1.json`. Run `pnpm generate` after the OpenAPI document changes; the test fails on drift.
+
+Set the per business API token as the secret `aula:token`, or call `configure({ token })`. The token is never written to state in plain text.
+
+## Install
+
+```sh
+npm install @sferarc/aula-pulumi @pulumi/pulumi
+```
+
+`@pulumi/pulumi` is a peer dependency.
+
+## Example
+
+Create an API token with the `site:write` scope in the school's settings and store it with `pulumi config set --secret aula:token aula_...`. Use `aula:baseUrl` for another host; plain HTTP is refused except on localhost.
+
+```ts
+import { SiteConfig } from "@sferarc/aula-pulumi";
+
+export const site = new SiteConfig("site", {
+	version: 1,
+	identity: { name: "Example Music School", tagline: "Lessons for every age" },
+	design: { accentColor: "#1d4ed8" },
+	locale: { defaultLocale: "en", timeZone: "Europe/Madrid", currency: "EUR" },
+});
+```
+
+`pulumi up` creates or updates the school's site config; a second run plans no changes. The resource is never deleted with the stack.

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from "./siteConfig.gen.js";

package/dist/index.js

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

package/dist/main.d.ts

@@ -0,0 +1,2 @@
+export * from "./index.js";
+export { configure } from "./runtime.js";

package/dist/main.js

@@ -0,0 +1,2 @@
+export * from "./index.js";
+export { configure } from "./runtime.js";

package/dist/runtime.d.ts

@@ -0,0 +1,12 @@
+import * as pulumi from "@pulumi/pulumi";
+/** Set the token once in a Pulumi program; the `aula:token` secret config or AULA_TOKEN work without it. */
+export declare function configure(args: {
+    token: pulumi.Input<string>;
+    baseUrl?: string;
+}): void;
+/** Called by each generated provider's `configure(req)` with the stack config. */
+export declare function setProviderConfig(config: Pick<pulumi.dynamic.Config, "get">): void;
+/** Drop `undefined` values, which Pulumi's struct encoding rejects. */
+export declare function stripUndefined<T extends Record<string, unknown>>(obj: T): T;
+/** Call the management API; a 404 or an empty body returns undefined, any other failure throws without the token or body secrets. */
+export declare function callApi(method: string, path: string, body?: unknown): Promise<unknown>;

package/dist/runtime.js

@@ -0,0 +1,71 @@
+import * as pulumi from "@pulumi/pulumi";
+const DEFAULT_BASE_URL = "https://aula.sferarc.com";
+const REQUEST_TIMEOUT_MS = 15_000;
+// A secret Output, so a provider closure that captures it is encrypted in state.
+let globalConfig;
+/** Set the token once in a Pulumi program; the `aula:token` secret config or AULA_TOKEN work without it. */
+export function configure(args) {
+    globalConfig = pulumi.secret({ token: args.token, baseUrl: args.baseUrl ?? DEFAULT_BASE_URL });
+}
+// An object, not a `let`: the serializer copies primitives per function but shares a captured object.
+const providerState = {};
+/** Called by each generated provider's `configure(req)` with the stack config. */
+export function setProviderConfig(config) {
+    providerState.config = config;
+}
+function getConfig() {
+    if (globalConfig)
+        return globalConfig.get();
+    const token = providerState.config?.get("aula:token") ?? process.env.AULA_TOKEN;
+    if (!token) {
+        throw new Error("Aula API token is required. Set aula:token as a secret, call configure(), or set AULA_TOKEN.");
+    }
+    const baseUrl = providerState.config?.get("aula:baseUrl") ?? process.env.AULA_API_URL ?? DEFAULT_BASE_URL;
+    return { token, baseUrl };
+}
+/** Drop `undefined` values, which Pulumi's struct encoding rejects. */
+export function stripUndefined(obj) {
+    const result = {};
+    for (const [key, value] of Object.entries(obj)) {
+        if (value === undefined)
+            continue;
+        result[key] =
+            value !== null && typeof value === "object" && !Array.isArray(value)
+                ? stripUndefined(value)
+                : value;
+    }
+    return result;
+}
+/** Call the management API; a 404 or an empty body returns undefined, any other failure throws without the token or body secrets. */
+export async function callApi(method, path, body) {
+    const { token, baseUrl } = getConfig();
+    const url = new URL(path, baseUrl);
+    if (url.protocol !== "https:" && url.hostname !== "localhost") {
+        throw new Error(`Aula: refusing to send the token over ${url.protocol}`);
+    }
+    const response = await fetch(url, {
+        method,
+        headers: {
+            Authorization: `Bearer ${token}`,
+            Accept: "application/json",
+            ...(body === undefined ? {} : { "Content-Type": "application/json" }),
+        },
+        body: body === undefined ? undefined : JSON.stringify(body),
+        signal: AbortSignal.timeout(REQUEST_TIMEOUT_MS),
+    });
+    if (response.status === 404 && method === "GET")
+        return undefined;
+    const text = await response.text();
+    if (!response.ok) {
+        let detail = "";
+        try {
+            const problem = JSON.parse(text);
+            detail = [problem.title, problem.detail].filter((v) => typeof v === "string").join(": ");
+        }
+        catch {
+            // Not a problem document; the status alone is reported.
+        }
+        throw new Error(`Aula ${method} ${url.pathname} failed (${response.status})${detail ? `: ${detail}` : ""}`);
+    }
+    return text ? JSON.parse(text) : undefined;
+}

package/dist/siteConfig.gen.d.ts

@@ -0,0 +1,46 @@
+import * as pulumi from "@pulumi/pulumi";
+export interface SiteConfigArgs {
+    version: pulumi.Input<number>;
+    identity?: pulumi.Input<Record<string, unknown>>;
+    design?: pulumi.Input<Record<string, unknown>>;
+    locale?: pulumi.Input<Record<string, unknown>>;
+    classPolicy?: pulumi.Input<Record<string, unknown>>;
+    fees?: pulumi.Input<Record<string, unknown>>;
+    /** Questions and answers in page order; each question and answer takes a string or a map from locale to string. */
+    faq?: pulumi.Input<Array<Record<string, unknown>>>;
+    /** The home's blocks in page order; hero, teachers, about and faq read their text from identity and faq. Headings, rich text bodies, call to action text and labels, and image alt text and captions take a string or a map from locale to string. An image's key is the storage key of an image this school uploaded, never a URL. */
+    sections?: pulumi.Input<Array<unknown>>;
+    /** Header and footer links in order; sign in, the locale switcher and Aula's own links always show besides them. */
+    navigation?: pulumi.Input<Record<string, unknown>>;
+    /** The school's own pages in order, each served at its slug with blocks as in sections. Titles and descriptions take a string or a map from locale to string. A slug is unique and never one of Aula's own paths. */
+    pages?: pulumi.Input<Array<Record<string, unknown>>>;
+    /** The school's own email text: a footer of address, contact and policy lines, and per email kind and locale a subject, heading, body and call to action label with the placeholders each kind allows. Plain text; a body link is [label](target). Left out, an email keeps Aula's text. The document replaces the stored text as a whole. */
+    emails?: pulumi.Input<Record<string, unknown>>;
+    /** The school's extra branded sites in order, each with its own name, design and the part of the offer it shows: lesson types and classes by id, and lesson types by subject. The list replaces the stored one as a whole: a key left out archives that site and naming it again restores it. A design token left out is Aula's default. */
+    sites?: pulumi.Input<Array<Record<string, unknown>>>;
+}
+export declare const siteConfigProvider: pulumi.dynamic.ResourceProvider;
+/** The school's whole site document. One per school: it exists with the school, so it is read and replaced, never created or deleted. */
+export declare class SiteConfig extends pulumi.dynamic.Resource {
+    readonly version: pulumi.Output<number>;
+    readonly identity: pulumi.Output<Record<string, unknown>>;
+    readonly design: pulumi.Output<Record<string, unknown>>;
+    readonly locale: pulumi.Output<Record<string, unknown>>;
+    readonly classPolicy: pulumi.Output<Record<string, unknown>>;
+    readonly fees: pulumi.Output<Record<string, unknown>>;
+    /** Questions and answers in page order; each question and answer takes a string or a map from locale to string. */
+    readonly faq: pulumi.Output<Array<Record<string, unknown>>>;
+    /** The home's blocks in page order; hero, teachers, about and faq read their text from identity and faq. Headings, rich text bodies, call to action text and labels, and image alt text and captions take a string or a map from locale to string. An image's key is the storage key of an image this school uploaded, never a URL. */
+    readonly sections: pulumi.Output<Array<unknown>>;
+    /** Header and footer links in order; sign in, the locale switcher and Aula's own links always show besides them. */
+    readonly navigation: pulumi.Output<Record<string, unknown>>;
+    /** The school's own pages in order, each served at its slug with blocks as in sections. Titles and descriptions take a string or a map from locale to string. A slug is unique and never one of Aula's own paths. */
+    readonly pages: pulumi.Output<Array<Record<string, unknown>>>;
+    /** The school's own email text: a footer of address, contact and policy lines, and per email kind and locale a subject, heading, body and call to action label with the placeholders each kind allows. Plain text; a body link is [label](target). Left out, an email keeps Aula's text. The document replaces the stored text as a whole. */
+    readonly emails: pulumi.Output<Record<string, unknown>>;
+    /** The school's extra branded sites in order, each with its own name, design and the part of the offer it shows: lesson types and classes by id, and lesson types by subject. The list replaces the stored one as a whole: a key left out archives that site and naming it again restores it. A design token left out is Aula's default. */
+    readonly sites: pulumi.Output<Array<Record<string, unknown>>>;
+    /** Exported for reference; an import never changes it. */
+    readonly domain: pulumi.Output<unknown>;
+    constructor(name: string, args: SiteConfigArgs, opts?: pulumi.CustomResourceOptions);
+}

package/dist/siteConfig.gen.js

@@ -0,0 +1,46 @@
+// Code generated by @sferarc/iac-gen. DO NOT EDIT.
+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 writeOnlyFields = [];
+function pick(source, keys) {
+    const picked = {};
+    for (const key of keys)
+        picked[key] = source[key];
+    return picked;
+}
+export const siteConfigProvider = {
+    async configure(req) {
+        setProviderConfig(req.config);
+    },
+    async create(inputs) {
+        const result = (await callApi("PUT", `/api/v1/site-config`, stripUndefined(pick(inputs, inputFields))));
+        const id = "SiteConfig";
+        return { id, outs: stripUndefined({ ...inputs, ...result }) };
+    },
+    async read(id, props) {
+        const current = (await callApi("GET", `/api/v1/site-config`));
+        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/site-config`, stripUndefined(pick(news, inputFields))));
+        return { outs: stripUndefined({ ...news, ...result }) };
+    },
+    async delete(id, props) {
+        void id;
+        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 };
+    },
+};
+/** The school's whole site document. One per school: it exists with the school, so it is read and replaced, never created or deleted. */
+export class SiteConfig extends pulumi.dynamic.Resource {
+    constructor(name, args, opts) {
+        super(siteConfigProvider, name, { "domain": undefined, ...args }, { ...opts, additionalSecretOutputs: [] });
+    }
+}

package/package.json

@@ -1,6 +1,54 @@
 {
   "name": "@sferarc/aula-pulumi",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.0.2",
+  "description": "Pulumi provider that declares an Aula school as code, generated from the management API's OpenAPI document",
+  "keywords": [
+    "pulumi",
+    "aula",
+    "iac",
+    "infrastructure-as-code"
+  ],
+  "homepage": "https://github.com/sferarc/platform/tree/main/packages/aula-pulumi#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sferarc/platform.git",
+    "directory": "packages/aula-pulumi"
+  },
+  "type": "module",
+  "license": "MIT",
+  "exports": {
+    ".": {
+      "types": "./dist/main.d.ts",
+      "default": "./dist/main.js"
+    }
+  },
+  "peerDependencies": {
+    "@pulumi/pulumi": "^3.0.0"
+  },
+  "devDependencies": {
+    "@pulumi/pulumi": "3.274.1",
+    "@sferarc/iac-gen": "0.2.4",
+    "@sferarc/tsconfig": "0.0.0",
+    "@types/node": "26.6.6",
+    "tsx": "4.23.15",
+    "typescript": "7.0.2",
+    "vitest": "5.1.0"
+  },
+  "main": "./dist/main.js",
+  "types": "./dist/main.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "scripts": {
+    "build": "rm -rf dist && tsc -p tsconfig.build.json",
+    "generate": "tsx scripts/generate.ts",
+    "tsc": "tsc --noEmit",
+    "test": "vitest run"
+  }
 }