@stetcms/vite 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,73 @@
+# @stetcms/vite
+
+Vite plugin for products built on [Stet](https://github.com/jamiedavenport/stet). It does two jobs from one config file:
+
+- **Generates a typed content client** before every build and dev-server start: the collections and maps your content team shapes in the Stet UI become `stet.<slug>.list()` / `.get()` calls your editor autocompletes. While the dev server runs it keeps watching, so a field added in the Stet UI reaches your types moments later without a restart.
+- **Publishes your analytics tracking plan**, so the events your code declares can be charted in Stet before anyone has fired one.
+
+Building without Vite? [`stet generate`](https://github.com/jamiedavenport/stet/tree/main/published/cli#stet-generate) and [`stet sync`](https://github.com/jamiedavenport/stet/tree/main/published/cli#stet-sync) run the same two jobs from the command line, for Next.js apps and CI.
+
+## Install
+
+```bash
+npm install -D @stetcms/vite
+npm install @stetcms/client
+```
+
+## Usage
+
+```ts
+// vite.config.ts
+import { stet } from '@stetcms/vite';
+import { defineConfig } from 'vite';
+
+export default defineConfig({
+  plugins: [stet()],
+});
+```
+
+Everything is configured in `stet.config.ts` (see [`@stetcms/config`](https://github.com/jamiedavenport/stet/tree/main/published/config)), which the CLI reads too:
+
+```ts
+// stet.config.ts
+import { defineStet } from '@stetcms/config';
+
+export default defineStet({ output: 'src/stet.gen.ts' });
+```
+
+With `STET_API_KEY` set, the plugin fetches `/api/v1/model` and writes `src/stet.gen.ts`:
+
+```ts
+import { stet } from './stet.gen';
+
+const posts = await stet.posts.list(); // a collection
+const post = await stet.posts.get('hello-world'); // one entry
+const landing = await stet.landing.get(); // a map
+// all fully typed from the model marketing built
+```
+
+The generated file never contains the key: at runtime the client reads `STET_API_KEY` from the environment again, so the file is safe to commit — and committing it keeps type checks working without a running Stet. It reads `STET_ORIGIN` at runtime too, falling back to the origin it was generated against, so one committed file works in every environment rather than pinning your deployment to whatever origin last regenerated it.
+
+Neither job can fail your build. Without a key, or with the API unreachable, the plugin warns and leaves the previous generated file in place, writing an empty model only when no file exists yet. A field deleted in the Stet UI keeps its key in the generated types, marked `@deprecated`: your editor strikes it through wherever you read it, and your build keeps passing while you migrate.
+
+## Analytics
+
+A config that declares `analytics` has its tracking plan published on every dev-server and build start, so the dashboard can offer an event before it has ever been recorded. Dropping an event from your code drops it from that list on the next sync, while anything already recorded under that name keeps its history. See [`@stetcms/analytics`](https://github.com/jamiedavenport/stet/tree/main/published/analytics) for the plan itself and the route it feeds.
+
+## Options
+
+Each option overrides the same key in `stet.config.ts`; leave them off and the config file decides.
+
+| Option   | Default                           | Description                                                                   |
+| -------- | --------------------------------- | ----------------------------------------------------------------------------- |
+| `origin` | `STET_ORIGIN` or the hosted cloud | The Stet deployment to generate from and call.                                |
+| `apiKey` | `STET_API_KEY`                    | Organization API key used to fetch the model.                                 |
+| `output` | `src/stet.gen.ts`                 | Where the generated module goes, relative to root.                            |
+| `watch`  | `true`                            | Regenerate every few seconds while the dev server runs. Never affects builds. |
+| `config` | auto-detected                     | Path to `stet.config.ts`, relative to root.                                   |
+
+See [`examples/tanstack`](https://github.com/jamiedavenport/stet/tree/main/examples/tanstack) for a complete TanStack Start app built on the generated client.
+
+## License
+
+Apache-2.0

package/dist/config.d.mts

@@ -0,0 +1,28 @@
+import { StetConfig } from "@stetcms/config";
+import { EventsShape } from "@stetcms/analytics";
+
+//#region src/config.d.ts
+/** Paths tried, relative to the project root, when none is given. */
+declare const CONFIG_CANDIDATES: string[];
+/** Finds a config by trying {@link CONFIG_CANDIDATES} under `root`. */
+declare function findStetConfig(root: string): string | undefined;
+/**
+ * Loads a config file and returns its `defineStet(...)` result, or undefined
+ * when the file exports none.
+ *
+ * Uses jiti so a TypeScript config loads under plain Node whatever the
+ * project's own build setup is. `cloudflare:workers` only exists inside
+ * workerd, so it resolves to a virtual module whose `env` is `process.env` —
+ * the same values Workers expose there on recent compatibility dates.
+ */
+declare function loadStetConfig(path: string): Promise<StetConfig | undefined>;
+/**
+ * The tracking plan's events, if the config declares any.
+ *
+ * `StetConfig` keeps `analytics` opaque so `@stetcms/config` never depends on
+ * `@stetcms/analytics`; this is where the two meet, and the only place the
+ * shape is asserted rather than inferred.
+ */
+declare function trackingPlanEvents(config: StetConfig | undefined): EventsShape | undefined;
+//#endregion
+export { CONFIG_CANDIDATES, findStetConfig, loadStetConfig, trackingPlanEvents };

package/dist/config.mjs

@@ -0,0 +1,75 @@
+import { resolve } from "node:path";
+import { existsSync } from "node:fs";
+import { createJiti } from "jiti";
+//#region src/config.ts
+/**
+* Loading a project's `stet.config.ts`. Node-only, and kept out of
+* `index.ts` so the CLI can reuse it without pulling in Vite.
+*/
+/** Paths tried, relative to the project root, when none is given. */
+const CONFIG_CANDIDATES = [
+	"stet.config.ts",
+	"stet.config.js",
+	"stet.config.mjs",
+	"src/stet.config.ts"
+];
+/** Finds a config by trying {@link CONFIG_CANDIDATES} under `root`. */
+function findStetConfig(root) {
+	for (const candidate of CONFIG_CANDIDATES) {
+		const absolute = resolve(root, candidate);
+		if (existsSync(absolute)) return absolute;
+	}
+}
+function isStetConfig(value) {
+	if (typeof value !== "object" || value === null) return false;
+	return [
+		"origin",
+		"apiKey",
+		"output",
+		"watch",
+		"analytics"
+	].some((key) => key in value);
+}
+/**
+* Loads a config file and returns its `defineStet(...)` result, or undefined
+* when the file exports none.
+*
+* Uses jiti so a TypeScript config loads under plain Node whatever the
+* project's own build setup is. `cloudflare:workers` only exists inside
+* workerd, so it resolves to a virtual module whose `env` is `process.env` —
+* the same values Workers expose there on recent compatibility dates.
+*/
+async function loadStetConfig(path) {
+	const absolute = resolve(path);
+	if (!existsSync(absolute)) return;
+	const module = await createJiti(import.meta.url, {
+		interopDefault: true,
+		virtualModules: { "cloudflare:workers": { env: process.env } }
+	}).import(absolute);
+	for (const exported of Object.values(module)) {
+		let value = exported;
+		if (typeof value === "function" && value.length === 0) try {
+			value = value();
+		} catch {
+			continue;
+		}
+		if (value instanceof Promise) try {
+			value = await value;
+		} catch {
+			continue;
+		}
+		if (isStetConfig(value)) return value;
+	}
+}
+/**
+* The tracking plan's events, if the config declares any.
+*
+* `StetConfig` keeps `analytics` opaque so `@stetcms/config` never depends on
+* `@stetcms/analytics`; this is where the two meet, and the only place the
+* shape is asserted rather than inferred.
+*/
+function trackingPlanEvents(config) {
+	return (config?.analytics)?.events;
+}
+//#endregion
+export { CONFIG_CANDIDATES, findStetConfig, loadStetConfig, trackingPlanEvents };

package/dist/index.d.mts

@@ -0,0 +1,46 @@
+import { Plugin } from "vite";
+
+//#region src/index.d.ts
+/** Options for {@link stet}. Each one overrides the same key in `stet.config.ts`. */
+type StetPluginOptions = {
+  /**
+   * The Stet deployment to generate from. Defaults to the config file, then
+   * `STET_ORIGIN`, then the hosted cloud.
+   */
+  origin?: string;
+  /**
+   * Organization API key used to fetch the model at codegen time. Defaults to
+   * `STET_API_KEY`. Never written into the generated file: at runtime the
+   * client reads `STET_API_KEY` from the environment again.
+   */
+  apiKey?: string; /** Where the generated module goes, relative to the project root. */
+  output?: string;
+  /**
+   * Regenerate while the dev server runs, so model changes made in the Stet
+   * UI reach the app without a restart. On by default; never affects builds.
+   */
+  watch?: boolean;
+  /**
+   * Path to `stet.config.ts`, relative to the project root. Auto-detected
+   * when omitted; a project without one runs on this plugin's options alone.
+   */
+  config?: string;
+};
+/**
+ * Generates a typed content client from your organization's content model
+ * before every build and dev-server start: the collections and maps your
+ * content team shapes become `stet.<slug>.list()` / `.get()` calls your
+ * editor autocompletes. While the dev server runs it keeps watching, so a
+ * field added in the Stet UI shows up in your types moments later.
+ *
+ * It also publishes the analytics tracking plan from `stet.config.ts`, so the
+ * events your code declares can be charted in Stet before anyone has fired
+ * one.
+ *
+ * Neither ever fails the build. Without a key or with the API unreachable it
+ * warns and leaves the previous generated file in place, writing an empty
+ * model only when no file exists yet.
+ */
+declare function stet(options?: StetPluginOptions): Plugin;
+//#endregion
+export { StetPluginOptions, stet };

package/dist/index.mjs

@@ -0,0 +1,96 @@
+import { findStetConfig, loadStetConfig, trackingPlanEvents } from "./config.mjs";
+import { access, mkdir, writeFile } from "node:fs/promises";
+import { dirname, resolve } from "node:path";
+import { syncTrackingPlan } from "@stetcms/analytics/sync";
+import { fetchContentModel, renderContentModule } from "@stetcms/client/codegen";
+import { resolveStetConfig } from "@stetcms/config";
+//#region src/index.ts
+/** How often the dev server checks the model for changes. */
+const watchIntervalMs = 3e3;
+/**
+* Generates a typed content client from your organization's content model
+* before every build and dev-server start: the collections and maps your
+* content team shapes become `stet.<slug>.list()` / `.get()` calls your
+* editor autocompletes. While the dev server runs it keeps watching, so a
+* field added in the Stet UI shows up in your types moments later.
+*
+* It also publishes the analytics tracking plan from `stet.config.ts`, so the
+* events your code declares can be charted in Stet before anyone has fired
+* one.
+*
+* Neither ever fails the build. Without a key or with the API unreachable it
+* warns and leaves the previous generated file in place, writing an empty
+* model only when no file exists yet.
+*/
+function stet(options = {}) {
+	let resolvedConfig;
+	let lastRendered;
+	const configPath = () => options.config === void 0 ? findStetConfig(resolvedConfig.root) : resolve(resolvedConfig.root, options.config);
+	/**
+	* Read on every pass rather than cached, so editing the config during a
+	* watch run takes effect without restarting the dev server.
+	*/
+	const settle = async () => {
+		const path = configPath();
+		const file = path === void 0 ? void 0 : await loadStetConfig(path);
+		const resolved = resolveStetConfig(file, options);
+		return {
+			...resolved,
+			output: resolve(resolvedConfig.root, resolved.output),
+			events: trackingPlanEvents(file)
+		};
+	};
+	const write = async (output, code) => {
+		await mkdir(dirname(output), { recursive: true });
+		await writeFile(output, code, "utf8");
+	};
+	const exists = (output) => access(output).then(() => true, () => false);
+	return {
+		name: "stet",
+		configResolved(config) {
+			resolvedConfig = config;
+		},
+		async buildStart() {
+			const { origin, apiKey, output, events } = await settle();
+			if (apiKey === void 0) {
+				this.warn("[stet] STET_API_KEY is not set; skipping content client generation.");
+				if (!await exists(output)) await write(output, renderContentModule({ types: [] }, origin));
+				return;
+			}
+			try {
+				lastRendered = renderContentModule(await fetchContentModel(origin, apiKey), origin);
+				await write(output, lastRendered);
+			} catch (error) {
+				this.warn(`[stet] Could not refresh the content client from ${origin}: ${String(error)}`);
+				if (!await exists(output)) await write(output, renderContentModule({ types: [] }, origin));
+			}
+			if (events !== void 0) try {
+				await syncTrackingPlan({
+					events,
+					origin,
+					apiKey
+				});
+			} catch (error) {
+				this.warn(`[stet] Could not publish the tracking plan to ${origin}: ${String(error)}`);
+			}
+		},
+		configureServer(server) {
+			const tick = async () => {
+				try {
+					const { origin, apiKey, output, watch } = await settle();
+					if (!watch || apiKey === void 0) return;
+					const code = renderContentModule(await fetchContentModel(origin, apiKey), origin);
+					if (code !== lastRendered) {
+						lastRendered = code;
+						await write(output, code);
+						server.config.logger.info(`[stet] Content model changed; regenerated ${output}`);
+					}
+				} catch {}
+			};
+			const timer = setInterval(() => void tick(), watchIntervalMs);
+			server.httpServer?.on("close", () => clearInterval(timer));
+		}
+	};
+}
+//#endregion
+export { stet };

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@stetcms/vite",
+  "version": "0.1.0",
+  "description": "Vite plugin for products built on Stet: typed options, a virtual config module, and a build-time codegen hook.",
+  "keywords": [
+    "plugin",
+    "stet",
+    "vite",
+    "vite-plugin"
+  ],
+  "homepage": "https://github.com/jamiedavenport/stet/tree/main/published/vite#readme",
+  "bugs": "https://github.com/jamiedavenport/stet/issues",
+  "license": "Apache-2.0",
+  "author": "Jamie Davenport (https://jxd.dev)",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jamiedavenport/stet.git",
+    "directory": "published/vite"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
+    },
+    "./config": {
+      "types": "./dist/config.d.mts",
+      "default": "./dist/config.mjs"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "jiti": "^2.7.0",
+    "@stetcms/client": "0.1.0",
+    "@stetcms/analytics": "0.1.0",
+    "@stetcms/config": "0.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "^26.1.1",
+    "publint": "^0.3.21",
+    "typescript": "^5.9.3",
+    "vite": "npm:@voidzero-dev/vite-plus-core@0.2.2",
+    "vite-plus": "0.2.2",
+    "vitest": "^4.1.9"
+  },
+  "peerDependencies": {
+    "vite": ">=6.0.0"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "build": "vp pack",
+    "tc": "tsc --noEmit",
+    "test": "vp test run"
+  }
+}