@stealthscale/sdk-host 0.1.0

package/dist/standalone-XfUZYt9b.d.ts

@@ -0,0 +1,137 @@
+import { AccessCheck, AccessSource, AnyContract, FlagSource, InstalledOptions, PluginManifest, ProductDefinition, ResolvedProduct, Session, SessionSource } from "@stealthscale/sdk-core";
+//#region src/standalone.d.ts
+/**
+ * Lists the plugin a standalone product runs, and the plugins installed beside it.
+ */
+interface StandaloneOptions {
+  /**
+   * Contracts of the plugins installed beside the plugin, each from its contract alone. None where
+   * left out.
+   */
+  readonly beside?: readonly AnyContract[] | undefined;
+  /**
+   * The plugin's configuration, as its schema admits it. The schema's defaults where left out.
+   */
+  readonly config?: InstalledOptions["config"];
+  /**
+   * The plugin's contract.
+   */
+  readonly contract: AnyContract;
+  /**
+   * The plugin's manifest. The plugin is installed from its contract alone where left out.
+   */
+  readonly manifest?: PluginManifest | undefined;
+}
+/**
+ * Describes a module a standalone product is built from: a plugin's manifest module, or a contract
+ * package beside it.
+ */
+interface StandaloneModule {
+  /**
+   * Where the module comes from: a path or a package name, which an error names.
+   */
+  readonly from: string;
+  /**
+   * The module's exports.
+   */
+  readonly module: Readonly<Record<string, unknown>>;
+}
+/**
+ * Describes the session source of a standalone product, whose session a panel or a test replaces.
+ */
+interface StandaloneSession extends SessionSource {
+  /**
+   * Replaces the session, and calls every listener where the session is another object.
+   */
+  readonly set: (session: Session) => void;
+}
+/**
+ * Decides one check on one resource: true where the person has the permission on it.
+ */
+type Decider = (check: AccessCheck) => boolean;
+/**
+ * Describes the access source of a standalone product, whose decisions a panel or a test switches.
+ *
+ * @remarks
+ *   The source denies a check whose permission the session lacks, whatever the decision, as an
+ *   access service decides for the person the session names.
+ */
+interface StandaloneAccess extends AccessSource {
+  /**
+   * Allows every check the session's permissions admit from now on.
+   */
+  readonly allow: () => void;
+  /**
+   * Decides every check the session's permissions admit from now on with the function.
+   */
+  readonly decide: (decider: Decider) => void;
+  /**
+   * Denies every check from now on.
+   */
+  readonly deny: () => void;
+  /**
+   * Leaves every check from now on pending.
+   */
+  readonly pending: () => void;
+  /**
+   * Calls the listener after the decision or the session changes, so the host asks again. Returns a
+   * function that stops the calls.
+   */
+  readonly subscribe: (listener: () => void) => () => void;
+}
+/**
+ * Lists the sources the host of a standalone product reads.
+ */
+interface StandaloneSources {
+  /**
+   * Decides every check on one resource, allowing each the session's permissions admit until a
+   * panel or a test switches the decision.
+   */
+  readonly access: StandaloneAccess;
+  /**
+   * Turns every boolean flag on, and leaves every experiment at its default.
+   */
+  readonly flags: FlagSource;
+  /**
+   * Returns the session a panel or a test last set.
+   */
+  readonly session: StandaloneSession;
+}
+/**
+ * Returns the definition of a product that runs one plugin: the plugin from its manifest, and each
+ * plugin beside it from its contract alone.
+ *
+ * @remarks
+ *   A route of a plugin installed from its contract alone renders a page that names the route and
+ *   renders each of the plugin's slots with its sample props. Such a plugin's extensions render the
+ *   content they wrap, or nothing, and its commands resolve with nothing. Its settings sections
+ *   without a schema name their plugin. The product's id is the plugin's, and its name is the key
+ *   `plugin.name`, so the product's name is the plugin's own.
+ * @param options - The plugin's contract and manifest, its configuration, and the contracts beside
+ *   it.
+ * @throws {@link Error} Where the manifest implements another contract.
+ */
+declare function standaloneProduct(options: StandaloneOptions): ProductDefinition;
+/**
+ * Returns the definition of a product that runs one plugin, from the plugin's manifest module and
+ * the module of each contract package beside it.
+ *
+ * @remarks
+ *   The standalone layer of `vite-config-product` writes a definition that calls this with the
+ *   modules it imports, so an author states package names and paths alone.
+ * @param plugin - The module that exports the plugin's manifest.
+ * @param beside - The module of each contract package installed beside the plugin.
+ * @throws {@link Error} Where a module exports no manifest or contract, or several, naming the
+ *   module.
+ */
+declare function standaloneFrom(plugin: StandaloneModule, beside?: readonly StandaloneModule[]): ProductDefinition;
+/**
+ * Returns the sources of a standalone product's host: a signed-in session with every permission and
+ * entitlement the product declares, every check on one resource the session's permissions admit
+ * allowed, every boolean flag on and every experiment at its default.
+ *
+ * @param product - The permissions and entitlements the installed plugins declare.
+ */
+declare function standaloneSources(product: Pick<ResolvedProduct, "entitlements" | "permissions">): StandaloneSources;
+//#endregion
+export { StandaloneSession as a, standaloneProduct as c, StandaloneOptions as i, standaloneSources as l, StandaloneAccess as n, StandaloneSources as o, StandaloneModule as r, standaloneFrom as s, Decider as t };

package/dist/standalone.d.ts

@@ -0,0 +1,2 @@
+import { a as StandaloneSession, c as standaloneProduct, i as StandaloneOptions, l as standaloneSources, n as StandaloneAccess, o as StandaloneSources, r as StandaloneModule, s as standaloneFrom, t as Decider } from "./standalone-XfUZYt9b.js";
+export { Decider, StandaloneAccess, StandaloneModule, StandaloneOptions, StandaloneSession, StandaloneSources, standaloneFrom, standaloneProduct, standaloneSources };

package/dist/standalone.js

@@ -0,0 +1,257 @@
+import { API_RANGE } from "@stealthscale/sdk-core";
+//#region src/standalone.ts
+/**
+* Builds the product a plugin runs in alone, for its tests and its standalone page: the plugin, the
+* plugins beside it installed from their contracts alone, and the sources of a signed-in session.
+*
+* @remarks
+*   The module imports `sdk-core` alone. The build evaluates a product's definition in Node without
+*   a CommonJS loader, and an inline type import still loads its package there.
+*/
+/**
+* Allows every check.
+*/
+function allowed() {
+	return true;
+}
+/**
+* Denies every check.
+*/
+function denied() {
+	return false;
+}
+/**
+* The version a standalone product states, which no deployment compares.
+*/
+const VERSION = "0.0.0";
+/**
+* Does nothing: the run of a command without code, and the end of a subscription to a source that
+* never notifies.
+*/
+function nothing() {}
+/**
+* Renders the content a wrapping extension wraps, and nothing in any other position.
+*/
+function PlaceholderExtension({ children }) {
+	return children;
+}
+/**
+* The code of every command of a plugin installed from its contract alone.
+*/
+const COMMAND = { run: () => Promise.resolve({ nothing }) };
+/**
+* The code of every extension of a plugin installed from its contract alone.
+*/
+const EXTENSION = { component: () => Promise.resolve({ PlaceholderExtension }) };
+/**
+* The code of every settings section without a schema of a plugin installed from its contract
+* alone.
+*/
+const SECTION = { component: () => import("./section-CtcVFcBK.js") };
+/**
+* The flag source of a standalone product: every boolean flag on, and every experiment at the value
+* the product or the contract states.
+*/
+const FLAGS = {
+	evaluate: ({ type }) => type === "boolean" ? true : void 0,
+	subscribe: () => nothing
+};
+/**
+* A batch of decisions that never settles.
+*/
+const PENDING = new Promise(nothing);
+/**
+* Returns a value and its listeners, which each replacement with another value calls.
+*
+* @param initial - The value before the first replacement.
+*/
+function kept(initial) {
+	let value = initial;
+	const listeners = /* @__PURE__ */ new Set();
+	return {
+		get: () => value,
+		set: (next) => {
+			if (Object.is(next, value)) return;
+			value = next;
+			for (const listener of [...listeners]) listener();
+		},
+		subscribe: (listener) => {
+			listeners.add(listener);
+			return () => {
+				listeners.delete(listener);
+			};
+		}
+	};
+}
+/**
+* Returns the importer of the placeholder page of one route.
+*
+* @param routeId - Qualified id of the route the page names.
+* @param contract - The contract whose slots the page renders.
+*/
+function pageOf(routeId, contract) {
+	return async () => {
+		const { placeholderPageOf } = await import("./page-7ScZC_LI.js");
+		return { PlaceholderPage: placeholderPageOf(routeId, contract) };
+	};
+}
+/**
+* Returns a record with each value mapped, under the same names.
+*/
+function mapped(record, map) {
+	return Object.fromEntries(Object.entries(record).map(([name, value]) => [name, map(value)]));
+}
+/**
+* Returns the manifest of a plugin installed from its contract alone: a placeholder for every name
+* that needs code.
+*/
+function placeholderOf(contract) {
+	const sections = Object.entries(contract.settings.sections).filter(([, section]) => section.schema === void 0);
+	return {
+		apiVersion: API_RANGE,
+		code: {
+			commands: mapped(contract.commands, () => COMMAND),
+			extensions: mapped(contract.extensions, () => EXTENSION),
+			routes: mapped(contract.routes, ({ id }) => pageOf(id, contract)),
+			settings: Object.fromEntries(sections.map(([name]) => [name, SECTION]))
+		},
+		contract
+	};
+}
+/**
+* Returns the definition of a product that runs one plugin: the plugin from its manifest, and each
+* plugin beside it from its contract alone.
+*
+* @remarks
+*   A route of a plugin installed from its contract alone renders a page that names the route and
+*   renders each of the plugin's slots with its sample props. Such a plugin's extensions render the
+*   content they wrap, or nothing, and its commands resolve with nothing. Its settings sections
+*   without a schema name their plugin. The product's id is the plugin's, and its name is the key
+*   `plugin.name`, so the product's name is the plugin's own.
+* @param options - The plugin's contract and manifest, its configuration, and the contracts beside
+*   it.
+* @throws {@link Error} Where the manifest implements another contract.
+*/
+function standaloneProduct(options) {
+	const { beside = [], config, contract, manifest = placeholderOf(contract) } = options;
+	if (manifest.contract !== contract) throw new Error(`The manifest implements the contract of ${manifest.contract.pluginId}, not of ${contract.pluginId}.`);
+	return {
+		name: "plugin.name",
+		plugins: [{
+			config,
+			manifest
+		}, ...beside.map((one) => ({ manifest: placeholderOf(one) }))],
+		productId: contract.pluginId,
+		version: VERSION
+	};
+}
+/**
+* The members every manifest has, which no contract has.
+*/
+const MANIFEST_KEYS = [
+	"apiVersion",
+	"code",
+	"contract"
+];
+/**
+* The members every contract has, which no manifest has.
+*/
+const CONTRACT_KEYS = ["pluginId", "routes"];
+/**
+* Returns true where a value is an object with every member a manifest has.
+*/
+function isManifest(value) {
+	return value instanceof Object && MANIFEST_KEYS.every((key) => key in value);
+}
+/**
+* Returns true where a value is an object with every member a contract has.
+*/
+function isContract(value) {
+	return value instanceof Object && CONTRACT_KEYS.every((key) => key in value);
+}
+/**
+* Returns the one export of a module the test accepts, however many names export it.
+*
+* @param standalone - The module, and where it comes from.
+* @param test - Accepts the kind of export the module must have one of.
+* @param kind - The kind of export, which an error names.
+* @throws {@link Error} Where the module exports none of the kind, or several.
+*/
+function oneOf({ from, module }, test, kind) {
+	const found = [...new Set(Object.values(module).filter((value) => test(value)))];
+	const [one] = found;
+	if (one === void 0 || found.length > 1) throw new Error(`${from} exports ${String(found.length)} ${kind}s, and a standalone product takes one.`);
+	return one;
+}
+/**
+* Returns the definition of a product that runs one plugin, from the plugin's manifest module and
+* the module of each contract package beside it.
+*
+* @remarks
+*   The standalone layer of `vite-config-product` writes a definition that calls this with the
+*   modules it imports, so an author states package names and paths alone.
+* @param plugin - The module that exports the plugin's manifest.
+* @param beside - The module of each contract package installed beside the plugin.
+* @throws {@link Error} Where a module exports no manifest or contract, or several, naming the
+*   module.
+*/
+function standaloneFrom(plugin, beside = []) {
+	const manifest = oneOf(plugin, isManifest, "plugin manifest");
+	return standaloneProduct({
+		beside: beside.map((one) => oneOf(one, isContract, "plugin contract")),
+		contract: manifest.contract,
+		manifest
+	});
+}
+/**
+* Returns the sources of a standalone product's host: a signed-in session with every permission and
+* entitlement the product declares, every check on one resource the session's permissions admit
+* allowed, every boolean flag on and every experiment at its default.
+*
+* @param product - The permissions and entitlements the installed plugins declare.
+*/
+function standaloneSources(product) {
+	const session = kept({
+		authenticated: true,
+		entitlements: product.entitlements.map(({ id }) => id),
+		permissions: product.permissions.map(({ id }) => id),
+		roles: []
+	});
+	const decider = kept(allowed);
+	/**
+	* Returns true where the session has the permission a check names.
+	*/
+	const permitted = ({ permission }) => session.get().permissions.includes(permission);
+	return {
+		access: {
+			allow: () => {
+				decider.set(allowed);
+			},
+			check: (checks) => {
+				const decide = decider.get();
+				return decide === void 0 ? PENDING : Promise.resolve(checks.map((check) => permitted(check) && decide(check)));
+			},
+			decide: decider.set,
+			deny: () => {
+				decider.set(denied);
+			},
+			pending: () => {
+				decider.set(void 0);
+			},
+			subscribe: (listener) => {
+				const stops = [decider.subscribe(listener), session.subscribe(listener)];
+				return () => {
+					for (const stop of stops) stop();
+				};
+			}
+		},
+		flags: FLAGS,
+		session: {
+			read: session.get,
+			set: session.set,
+			subscribe: session.subscribe
+		}
+	};
+}
+//#endregion
+export { standaloneFrom, standaloneProduct, standaloneSources };

package/dist/words-yI-WdYM3.js

@@ -0,0 +1,58 @@
+import { c } from "react/compiler-runtime";
+import { useTranslation } from "@stealthscale/provider-i18n";
+//#region src/host/words.ts
+/**
+* Returns the reader of the plugins' words over an i18next instance.
+*
+* @remarks
+*   A plugin's catalogue belongs to the product, so the host's generated word types list none of
+*   its keys, and the reader looks them up with plain strings.
+* @param i18n - The instance `useTranslation` returns.
+*/
+function pluginWordsOf(i18n) {
+	const untyped = i18n;
+	return {
+		exists: (pluginId, key) => untyped.exists(key, { ns: pluginId }),
+		t: (pluginId, key, values = {}) => untyped.t(key, {
+			...values,
+			ns: pluginId
+		})
+	};
+}
+/**
+* Returns the translator a settings section's form reads its words through: each key is looked up
+* in the catalogue of the section's plugin, and the form's default is returned where none is found.
+*
+* @param i18n - The instance `useTranslation` returns.
+* @param pluginId - Id of the plugin whose catalogue the form reads.
+*/
+function translatorOf(i18n, pluginId) {
+	const untyped = i18n;
+	return (keys, options) => untyped.t(keys, {
+		...options,
+		ns: pluginId
+	});
+}
+/**
+* Returns the product's name in the person's language, and renders again when the language
+* changes.
+*
+* @remarks
+*   The name is the key the product's definition states under `name`, translated in the product's
+*   own namespace, its id.
+*/
+function useProductName(product) {
+	const $ = c(4);
+	const { i18n } = useTranslation("host");
+	let t0;
+	if ($[0] !== i18n || $[1] !== product.name || $[2] !== product.productId) {
+		t0 = pluginWordsOf(i18n).t(product.productId, product.name);
+		$[0] = i18n;
+		$[1] = product.name;
+		$[2] = product.productId;
+		$[3] = t0;
+	} else t0 = $[3];
+	return t0;
+}
+//#endregion
+export { translatorOf as n, useProductName as r, pluginWordsOf as t };

package/locales/en/host.json

@@ -0,0 +1,135 @@
+{
+  "commands": {
+    "failed": "Could not run \"{{label}}\"."
+  },
+  "failed": {
+    "description": "Reload the page to start it again.",
+    "reload": "Reload",
+    "title": "{{product}} could not be shown"
+  },
+  "flags": {
+    "killSwitch": "Turns the whole plugin off"
+  },
+  "notFound": {
+    "off": {
+      "action": "Turn on {{plugin}}",
+      "description": "Turn {{plugin}} on to open this page.",
+      "title": "{{plugin}} is turned off"
+    },
+    "plain": {
+      "description": "Check the address, or go back to the page you came from.",
+      "title": "Page not found"
+    },
+    "quarantined": {
+      "action": "Try again",
+      "description": "It failed too many times in a row.",
+      "title": "This page stopped working"
+    },
+    "unavailable": {
+      "description": "{{plugin}} is unavailable for now. Try again later.",
+      "title": "{{plugin}} is unavailable"
+    }
+  },
+  "page": {
+    "failed": {
+      "description": "Reload the page, or try again later.",
+      "title": "This page could not be shown"
+    }
+  },
+  "palette": {
+    "commands": "Commands",
+    "count_one": "{{count}} result",
+    "count_other": "{{count}} results",
+    "goTo": "Go to",
+    "label": "Command palette",
+    "none": "No command matches.",
+    "search": "Search commands"
+  },
+  "plugins": {
+    "about": "Turn a plugin off to remove its pages, menus and settings for you alone.",
+    "always": "Always on",
+    "confirm": {
+      "action": "Turn off",
+      "description_one": "{{plugins}} needs it and turns off with it.",
+      "description_other": "{{plugins}} need it and turn off with it.",
+      "keep": "Keep on",
+      "title": "Turn off {{plugin}}?"
+    },
+    "reason": {
+      "condition": "Not available here",
+      "requirement": "Off while a plugin it needs is off",
+      "unavailable": "Unavailable for now"
+    },
+    "title": "Installed plugins"
+  },
+  "settings": {
+    "account": "Account",
+    "empty": "Nothing to set on this page",
+    "failed": {
+      "description": "Reload the page, or try again later.",
+      "title": "This section could not be shown"
+    },
+    "menu": "Settings pages",
+    "plugins": "Plugins",
+    "save": "Save",
+    "saved": "Settings saved",
+    "title": "Settings"
+  },
+  "standalone": {
+    "page": "{{plugin}} is installed from its contract alone, so this page is a placeholder. Its slots render with their sample props.",
+    "panel": {
+      "access": {
+        "allow": "Allow",
+        "deny": "Deny",
+        "pending": "Pending",
+        "title": "Checks on one resource"
+      },
+      "data": {
+        "modes": {
+          "conflict": "Refuse as a conflict",
+          "delayed": "Sample after 2 seconds",
+          "forbidden": "Refuse as forbidden",
+          "invalid": "Refuse as invalid",
+          "network": "Fail on the network",
+          "not-found": "Refuse as not found",
+          "sample": "Sample",
+          "server": "Fail on the server",
+          "unauthenticated": "Refuse as signed out"
+        },
+        "title": "Operations"
+      },
+      "flags": {
+        "title": "Feature flags"
+      },
+      "page": {
+        "route": "Page",
+        "title": "Page"
+      },
+      "plugin": {
+        "kill": "Allowed by its kill switch",
+        "switch": "Switched on",
+        "title": "Plugin"
+      },
+      "session": {
+        "entitlements": "Entitlements",
+        "permissions": "Permissions",
+        "signedIn": "Signed in",
+        "title": "Session"
+      },
+      "shell": {
+        "colorMode": "Color mode",
+        "dark": "Dark",
+        "language": "Language",
+        "light": "Light",
+        "system": "System",
+        "theme": "Theme",
+        "title": "Display"
+      },
+      "title": "Development panel"
+    },
+    "section": "{{plugin}} is installed from its contract alone, so this section is a placeholder."
+  },
+  "toasts": {
+    "label": "Notifications"
+  }
+}