@goodfellow-cms/admin 0.0.0-stage → 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Goodfellow contributors
+
+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,13 @@
-# Temporary Holding Version
+# @goodfellow-cms/admin
 
-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.
+The admin panel: the visual editor for a site's pages, collections, media, header and footer, and settings, which publishes to the site's repository from the browser.
+
+It's built with each site's own config, so the editor always has the site's blocks: `goodfellow build` adds it at `/admin`, and Next.js sites render `GoodfellowAdmin` from `@goodfellow-cms/next` there.
+
+[Goodfellow](https://github.com/goodfellow-cms/goodfellow-cms) is a website builder for people who aren't developers, with no server or database: pages are files in your own GitHub or GitLab repository, edited in a visual editor built on [Puck](https://puckeditor.com). To start a new site, run `npm create goodfellow@latest my-site`. See the [documentation](https://goodfellow-cms.github.io/goodfellow-cms/) for everything else.
+
+More in the docs: [Edit pages](https://goodfellow-cms.github.io/goodfellow-cms/docs/edit-pages).
+
+## License
+
+MIT

package/dist/dev.d.ts

@@ -0,0 +1,8 @@
+import { ContentStore } from "@goodfellow-cms/core";
+//#region src/dev.d.ts
+/**
+ * A content store that reads and writes the site's files through
+ * `goodfellow dev`. For local development only: it is never part of a built site.
+ */
+export declare function localStore(apiBase?: string): ContentStore;
+//#endregion

package/dist/dev.js

@@ -0,0 +1,60 @@
+import { ConflictError, decodeBase64, encodeBase64Bytes } from "@goodfellow-cms/core";
+//#region src/dev.ts
+/**
+* A content store that reads and writes the site's files through
+* `goodfellow dev`. For local development only: it is never part of a built site.
+*/
+function localStore(apiBase = "/__goodfellow/api") {
+	/** Calls the development API. A 404 means "no such file" only where `missingIsFine` says so. */
+	async function request(path, init = {}, missingIsFine = false) {
+		const [endpoint, query] = path.split("?", 2);
+		const response = await fetch(`${apiBase}/${endpoint}/${query === void 0 ? "" : `?${query}`}`, {
+			...init,
+			headers: {
+				"x-goodfellow-request": "1",
+				...init.headers
+			}
+		});
+		if (response.status === 409) throw new ConflictError();
+		if (response.status === 404 && !missingIsFine) throw new Error(`The development server's API isn't at ${new URL(apiBase, location.href).href} (it answered 404). Open the admin panel at the address \`goodfellow dev\` printed when it started.`);
+		if (!response.ok && response.status !== 404) {
+			const body = await response.json().catch(() => ({}));
+			throw new Error(body.message ?? `The development server answered ${response.status} (${body.error ?? "error"}).`);
+		}
+		return response;
+	}
+	return {
+		async read(path) {
+			const response = await request(`file?path=${encodeURIComponent(path)}`, {}, true);
+			if (response.status === 404) return void 0;
+			return (await response.json()).content;
+		},
+		async readBytes(path) {
+			const response = await request(`file?path=${encodeURIComponent(path)}&as=bytes`, {}, true);
+			if (response.status === 404) return void 0;
+			return decodeBase64((await response.json()).base64);
+		},
+		async list(dir) {
+			return (await (await request(`files?dir=${encodeURIComponent(dir)}`)).json()).files;
+		},
+		async revision() {
+			return (await (await request("revision")).json()).revision;
+		},
+		async write(changes, { message, expectedRevision }) {
+			return await (await request("write", {
+				method: "POST",
+				headers: { "content-type": "application/json" },
+				body: JSON.stringify({
+					changes: changes.map((change) => "bytes" in change ? {
+						path: change.path,
+						base64: encodeBase64Bytes(change.bytes)
+					} : change),
+					message,
+					expectedRevision
+				})
+			})).json();
+		}
+	};
+}
+//#endregion
+export { localStore };