@goodfellow-cms/admin 0.7.0 → 0.9.0

package/README.md

@@ -6,6 +6,8 @@ Its editor is built with each site's own config, so it always has the site's blo
 
 [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, GitLab or Bitbucket 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.
 
+Language packs' own checks read the admin panel's English from `@goodfellow-cms/admin/text`, which draws nothing, as [Goodfellow's French pack](https://github.com/goodfellow-cms/goodfellow-language-fr) does.
+
 More in the docs: [Edit pages](https://goodfellow-cms.github.io/goodfellow-cms/docs/edit-pages).
 
 ## License

package/dist/admin-text-sources-BTZJPlVK.js

@@ -0,0 +1,273 @@
+import { n as defaultStrings } from "./strings-D94noZrv.js";
+import { adminTextProblem, englishHash } from "@goodfellow-cms/core";
+//#region src/languages/en-puck.ts
+/**
+* Puck's own English for the text Goodfellow translates, as its built-in
+* dictionary has it (Puck doesn't export it), so the admin panel can have
+* Puck's text translated for a site's own language, and check placeholders
+* against it. A test keeps its keys the same as the Spanish table's.
+*/
+const PUCK_ENGLISH = {
+	"header-publish": "Publish",
+	"header-undo": "undo",
+	"header-redo": "redo",
+	"header-toggle-leftsidebar": "Toggle left sidebar",
+	"header-toggle-rightsidebar": "Toggle right sidebar",
+	"header-toggle-menubar": "Toggle menu bar",
+	"action-selectparent": "Select parent",
+	"action-duplicate": "Duplicate",
+	"action-delete": "Delete",
+	"label-page": "Page",
+	"label-component": "Component",
+	"outline-empty": "No items",
+	"outline-item-collapse": "Collapse",
+	"outline-item-expand": "Expand",
+	"outline-header-title": "Outline",
+	"outline-header-collapseall": "Collapse all",
+	"outline-item-duplicate": "Duplicate",
+	"outline-item-delete": "Delete",
+	"drawer-category-collapse": "Collapse {title}",
+	"drawer-category-expand": "Expand {title}",
+	"drawer-category-other": "Other",
+	"canvas-noconfig": "No configuration for {type}",
+	"field-readonly": "Read-only",
+	"field-arrayitem-summary": "Item #{index}",
+	"field-arrayitem-duplicate": "Duplicate",
+	"field-arrayitem-delete": "Delete",
+	"field-external-selectdata": "Select data",
+	"field-external-search": "Search",
+	"field-external-togglefilters": "Toggle filters",
+	"field-external-item": "External item",
+	"field-external-result-singular": "{count} result",
+	"field-external-result-plural": "{count} results",
+	"field-richtext-bold": "Bold",
+	"field-richtext-italic": "Italic",
+	"field-richtext-underline": "Underline",
+	"field-richtext-strikethrough": "Strikethrough",
+	"field-richtext-blockquote": "Blockquote",
+	"field-richtext-code-inline": "Inline code",
+	"field-richtext-code-block": "Code block",
+	"field-richtext-list-bullet": "Bullet list",
+	"field-richtext-list-ordered": "Ordered list",
+	"field-richtext-horizontalrule": "Horizontal rule",
+	"field-richtext-align-left": "Align left",
+	"field-richtext-align-center": "Align center",
+	"field-richtext-align-right": "Align right",
+	"field-richtext-align-justify": "Justify",
+	"field-richtext-select": "Select",
+	"field-richtext-headingselect-1": "Heading 1",
+	"field-richtext-headingselect-2": "Heading 2",
+	"field-richtext-headingselect-3": "Heading 3",
+	"field-richtext-headingselect-4": "Heading 4",
+	"field-richtext-headingselect-5": "Heading 5",
+	"field-richtext-headingselect-6": "Heading 6",
+	"field-richtext-alignselect-left": "Left",
+	"field-richtext-alignselect-center": "Center",
+	"field-richtext-alignselect-right": "Right",
+	"field-richtext-alignselect-justify": "Justify",
+	"field-richtext-listselect-bullet": "Bullet list",
+	"field-richtext-listselect-ordered": "Ordered list",
+	"viewport-zoom-in": "Zoom viewport in",
+	"viewport-zoom-out": "Zoom viewport out",
+	"viewport-zoom-auto": "{zoom}% (Auto)",
+	"viewport-toggle-menu": "Toggle viewport menu",
+	"viewport-switch": "Switch to {label} viewport",
+	"viewport-switch-default": "Switch viewport",
+	"plugin-blocks": "Blocks",
+	"plugin-outline": "Outline",
+	"plugin-fields": "Fields",
+	"plugin-components": "Components",
+	"layout-maximize": "maximize",
+	"layout-minimize": "minimize",
+	"loader-loading": "loading"
+};
+//#endregion
+//#region src/admin-text-sources.ts
+const TABLES = [
+	"strings",
+	"puck",
+	"labels"
+];
+/** A source's key in one list of every table's: the table, a colon, then its own key, since labels' keys are words. */
+function sourceKey(table, key) {
+	return `${table}:${key}`;
+}
+function splitKey(key) {
+	const colon = key.indexOf(":");
+	const table = key.slice(0, colon);
+	return TABLES.includes(table) ? {
+		table,
+		key: key.slice(colon + 1)
+	} : void 0;
+}
+/** Every label a block's fields show, as `withLabels()` puts them in another language: settings, choices and placeholders. */
+function fieldLabels(fields, found) {
+	for (const field of Object.values(fields)) {
+		const described = field ?? {};
+		for (const name of ["label", "placeholder"]) {
+			const value = described[name];
+			if (typeof value === "string" && value.trim()) found.add(value);
+		}
+		if (Array.isArray(described.options)) {
+			for (const option of described.options) if (typeof option?.label === "string" && option.label.trim()) found.add(option.label);
+		}
+		for (const nested of ["arrayFields", "objectFields"]) {
+			const inner = described[nested];
+			if (inner && typeof inner === "object") fieldLabels(inner, found);
+		}
+	}
+}
+/** The labels of the site's blocks and its page settings, from its description, with any more given (such as groups'). */
+function labelSources(description, more = []) {
+	const found = new Set(more);
+	for (const block of Object.values(description.blocks)) {
+		if (block.label?.trim()) found.add(block.label);
+		fieldLabels(block.fields, found);
+	}
+	fieldLabels(description.root.fields, found);
+	return [...found].sort((a, b) => a.localeCompare(b));
+}
+/** Everything the admin panel says in English, from every table, keyed with `sourceKey()`. */
+function adminTextSources(labels) {
+	return [
+		...Object.entries(defaultStrings).map(([key, english]) => ({
+			key: sourceKey("strings", key),
+			english,
+			table: "strings"
+		})),
+		...Object.entries(PUCK_ENGLISH).map(([key, english]) => ({
+			key: sourceKey("puck", key),
+			english,
+			table: "puck"
+		})),
+		...labels.map((english) => ({
+			key: sourceKey("labels", english),
+			english,
+			table: "labels"
+		}))
+	];
+}
+/** A string's entry in a language's file, by `sourceKey()`. */
+function entryOf(file, key) {
+	const split = splitKey(key);
+	if (!file || !split) return void 0;
+	const table = file[split.table];
+	return Object.hasOwn(table, split.key) ? table[split.key] : void 0;
+}
+/**
+* Where a string stands in a language's file: not there, there but not
+* usable (`adminTextProblem()`), made from English that has changed since,
+* or current. Labels are keyed by their English, so they can't be outdated.
+*/
+function sourceState(file, source) {
+	const entry = entryOf(file, source.key);
+	if (!entry) return "missing";
+	if (adminTextProblem(entry.text, source.english)) return "unusable";
+	if (source.table !== "labels" && entry.source !== void 0 && entry.source !== englishHash(source.english)) return "outdated";
+	return "current";
+}
+/** How much of the admin panel a language's file says. */
+function languageStatus(file, sources) {
+	const status = {
+		total: sources.length,
+		current: 0,
+		outdated: 0,
+		missing: 0,
+		unusable: 0,
+		reviewed: 0
+	};
+	for (const source of sources) {
+		const state = sourceState(file, source);
+		status[state] += 1;
+		if (state === "current" && entryOf(file, source.key)?.reviewed) status.reviewed += 1;
+	}
+	return status;
+}
+/** The strings to translate: those missing or unusable, and with `outdated`, those made from English that has changed. */
+function sourcesToTranslate(file, sources, options = {}) {
+	return sources.filter((source) => {
+		const state = sourceState(file, source);
+		return state === "missing" || state === "unusable" || options.outdated === true && state === "outdated";
+	});
+}
+/**
+* A language's file with new translations in it, by `sourceKey()`, each with
+* the hash of the English it was made from, and not marked reviewed, since
+* no one has read it yet. What the file had besides is kept as it was.
+*/
+function withTranslations(file, name, translated, sources) {
+	const next = {
+		version: 1,
+		name: file?.name ?? name,
+		strings: { ...file?.strings },
+		puck: { ...file?.puck },
+		labels: { ...file?.labels },
+		...file?.pack && { pack: file.pack }
+	};
+	const english = new Map(sources.map((source) => [source.key, source.english]));
+	for (const [key, text] of translated) {
+		const split = splitKey(key);
+		const source = english.get(key);
+		if (!split || source === void 0) continue;
+		const pack = entryOf(file, key)?.pack;
+		next[split.table][split.key] = {
+			text,
+			source: englishHash(source),
+			...pack && { pack }
+		};
+	}
+	return next;
+}
+/**
+* The strings an editor of a language's file shows: those the filter keeps
+* whose English, key or text in the file holds every word searched for,
+* ignoring case.
+*/
+function filterSources(file, sources, options = {}) {
+	const words = (options.query ?? "").toLocaleLowerCase().split(/\s+/).filter(Boolean);
+	const show = options.show ?? "all";
+	return sources.filter((source) => {
+		const state = sourceState(file, source);
+		const entry = entryOf(file, source.key);
+		if (show === "unreviewed" ? state !== "current" || entry?.reviewed : show !== "all" && state !== show) return false;
+		const haystack = `${source.key} ${source.english} ${entry?.text ?? ""}`.toLocaleLowerCase();
+		return words.every((word) => haystack.includes(word));
+	});
+}
+/**
+* A language's file with an owner's edits in it, by `sourceKey()`. Text
+* written or read against today's English is current, so it gets today's
+* English's hash; empty text takes the string out of the file, so it shows
+* the default again.
+*/
+function withEdits(file, name, edits, sources) {
+	const next = {
+		version: 1,
+		name: file?.name ?? name,
+		strings: { ...file?.strings },
+		puck: { ...file?.puck },
+		labels: { ...file?.labels },
+		...file?.pack && { pack: file.pack }
+	};
+	const english = new Map(sources.map((source) => [source.key, source.english]));
+	for (const [key, edit] of edits) {
+		const split = splitKey(key);
+		const source = english.get(key);
+		if (!split || source === void 0) continue;
+		const text = edit.text.trim();
+		if (!text) {
+			delete next[split.table][split.key];
+			continue;
+		}
+		const pack = entryOf(file, key)?.pack;
+		next[split.table][split.key] = {
+			text,
+			source: englishHash(source),
+			...edit.reviewed && { reviewed: true },
+			...pack && { pack }
+		};
+	}
+	return next;
+}
+//#endregion
+export { languageStatus as a, sourcesToTranslate as c, PUCK_ENGLISH as d, labelSources as i, withEdits as l, entryOf as n, sourceKey as o, filterSources as r, sourceState as s, adminTextSources as t, withTranslations as u };