@appshell/runtime 1.0.0-alpha.24 → 1.0.0-alpha.25

package/README.md

@@ -6,8 +6,31 @@ This is a **shared singleton**. There is exactly one instance per page, held in
 module federation share scope, and both the host and every package must declare it as
 such. It replaced `window.__appshell_vars__<scope>`.
 
-Most packages should not import this directly — use
-[`@appshell/vars`](../vars/README.md), which supplies the scope for you.
+Most packages should not import this directly — use `@appshell/runtime/vars` below,
+which supplies the scope for you.
+
+## `@appshell/runtime/vars`
+
+The accessor most packages actually want. It reads *this* package's vars, with no scope
+to pass and no way to name someone else's:
+
+```ts
+import { getVars } from '@appshell/runtime/vars';
+
+const { BACKGROUND_COLOR } = getVars<{ BACKGROUND_COLOR: string }>();
+```
+
+It is a subpath rather than a main-entry export for a reason. `AppshellPlugin` compiles
+the package's own scope into whatever imports it, and the main entry is the *shared*
+module — one instance for the whole page — so a scope baked in there would be one
+package's, and every other package would read the wrong vars.
+
+The exact-match share key `'@appshell/runtime'` does not catch `'@appshell/runtime/vars'`,
+so each package bundles its own copy of the accessor with its own scope, while the store
+they all reach stays the single shared instance.
+
+`getVars` throws `MissingScopeError` when the package was built without `AppshellPlugin`,
+since nothing substituted the scope.
 
 ## Contract
 

package/dist/main.js

@@ -1 +1 @@
-!function(e,r){if("object"==typeof exports&&"object"==typeof module)module.exports=r();else if("function"==typeof define&&define.amd)define([],r);else{var t=r();for(var s in t)("object"==typeof exports?exports:e)[s]=t[s]}}(self,(()=>(()=>{"use strict";var e={d:(r,t)=>{for(var s in t)e.o(t,s)&&!e.o(r,s)&&Object.defineProperty(r,s,{enumerable:!0,get:t[s]})},o:(e,r)=>Object.prototype.hasOwnProperty.call(e,r),r:e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})}},r={};e.r(r),e.d(r,{MissingVarsError:()=>t,VarsConflictError:()=>s,hasVars:()=>i,readVars:()=>n,resetVars:()=>c,setVars:()=>a});class t extends Error{constructor(e,r){super(`No vars were delivered for '${e}'. ${r.length?`Vars are present for ${r.map((e=>`'${e}'`)).join(", ")} — check that '${e}' matches the module federation name the registry knows this package by.`:"Nothing has delivered vars on this page — check that the host and this package both declare '@appshell/runtime' as a shared singleton."}`),this.name="MissingVarsError",this.scope=e}}class s extends Error{constructor(e){super(`Vars for '${e}' were already delivered and cannot be replaced. A scope receives its vars once per page load.`),this.name="VarsConflictError",this.scope=e}}const o=new Map,a=(e,r)=>{const t=o.get(e);var a,n;if(t){if(a=t,n=r,![...new Set([...Object.keys(a),...Object.keys(n)])].every((e=>a[e]===n[e])))throw new s(e)}else o.set(e,Object.freeze({...r}))},n=e=>{const r=o.get(e);if(!r)throw new t(e,[...o.keys()]);return r},i=e=>o.has(e),c=()=>{o.clear()};return r})()));
+!function(e,r){if("object"==typeof exports&&"object"==typeof module)module.exports=r();else if("function"==typeof define&&define.amd)define([],r);else{var t=r();for(var s in t)("object"==typeof exports?exports:e)[s]=t[s]}}(this,(()=>(()=>{"use strict";var e={d:(r,t)=>{for(var s in t)e.o(t,s)&&!e.o(r,s)&&Object.defineProperty(r,s,{enumerable:!0,get:t[s]})},o:(e,r)=>Object.prototype.hasOwnProperty.call(e,r),r:e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})}},r={};e.r(r),e.d(r,{MissingScopeError:()=>o,MissingVarsError:()=>t,VarsConflictError:()=>s,hasVars:()=>c,readVars:()=>i,resetVars:()=>p,setVars:()=>n});class t extends Error{constructor(e,r){super(`No vars were delivered for '${e}'. ${r.length?`Vars are present for ${r.map((e=>`'${e}'`)).join(", ")} — check that '${e}' matches the module federation name the registry knows this package by.`:"Nothing has delivered vars on this page — check that the host and this package both declare '@appshell/runtime' as a shared singleton."}`),this.name="MissingVarsError",this.scope=e}}class s extends Error{constructor(e){super(`Vars for '${e}' were already delivered and cannot be replaced. A scope receives its vars once per page load.`),this.name="VarsConflictError",this.scope=e}}class o extends Error{constructor(){super("Cannot tell which package this is. '@appshell/runtime/vars' needs the scope that AppshellPlugin injects at build time — add it to this package's webpack plugins, or read the store directly with readVars(scope) from '@appshell/runtime'."),this.name="MissingScopeError"}}const a=new Map,n=(e,r)=>{const t=a.get(e);var o,n;if(t){if(o=t,n=r,![...new Set([...Object.keys(o),...Object.keys(n)])].every((e=>o[e]===n[e])))throw new s(e)}else a.set(e,Object.freeze({...r}))},i=e=>{const r=a.get(e);if(!r)throw new t(e,[...a.keys()]);return r},c=e=>a.has(e),p=()=>{a.clear()};return r})()));

package/dist/types/errors.d.ts

@@ -23,3 +23,10 @@ export declare class VarsConflictError extends Error {
     readonly scope: string;
     constructor(scope: string);
 }
+/**
+ * The package was built without `AppshellPlugin`, so nothing substituted the scope the
+ * `@appshell/runtime/vars` accessor needs to know which vars are its own.
+ */
+export declare class MissingScopeError extends Error {
+    constructor();
+}

package/dist/types/index.d.ts

@@ -1,3 +1,4 @@
-export { MissingVarsError, VarsConflictError } from './errors';
+export { MissingScopeError, MissingVarsError, VarsConflictError } from './errors';
 export { hasVars, readVars, resetVars, setVars } from './store';
 export type { Vars } from './types';
+export type { AppshellIndex, AppshellRemote, Metadata } from './wire';

package/dist/types/store.d.ts

@@ -16,7 +16,7 @@ export declare const setVars: (scope: string, vars: Vars) => void;
  * Reads a scope's vars, throwing rather than handing back an empty object — a package
  * that silently renders with no configuration is the failure this replaced.
  *
- * Prefer `getVars()` from `@appshell/vars`, which supplies the scope for you.
+ * Prefer `getVars()` from `@appshell/runtime/vars`, which supplies the scope for you.
  */
 export declare const readVars: <TVars extends Vars = Vars>(scope: string) => TVars;
 /** Whether a scope has been delivered, for callers that want to branch instead of catch. */

package/dist/types/vars.d.ts

@@ -0,0 +1,31 @@
+/**
+ * The scope-aware accessor, deliberately kept out of this package's main entry.
+ *
+ * `@appshell/runtime` is shared as a singleton, so exactly one copy of it exists on the
+ * page — whichever package wins the share negotiation. A `__APPSHELL_SCOPE__` compiled
+ * into that copy would be one package's scope, and every other package would silently
+ * read the wrong vars. So this module ships as the `@appshell/runtime/vars` subpath,
+ * which the exact-match share key does not catch: each package bundles its own copy and
+ * gets its own scope substituted, while the store they all reach through the bare
+ * `@appshell/runtime` import below stays the one shared instance.
+ *
+ * That bare specifier is load-bearing. A relative import of the store here would bind to
+ * a local copy and bypass the singleton entirely.
+ */
+import { type Vars } from '@appshell/runtime';
+/**
+ * This package's runtime configuration, as the registry composed it — the vars the
+ * package declared in its `appshell.config.yaml`, with the application's
+ * `overrides.vars` layered over them.
+ *
+ * Throws rather than returning an empty object when nothing was delivered. A package
+ * that renders with no configuration at all is the failure this is here to prevent.
+ *
+ * ```ts
+ * import { getVars } from '@appshell/runtime/vars';
+ *
+ * const { BACKGROUND_COLOR } = getVars<{ BACKGROUND_COLOR: string }>();
+ * ```
+ */
+export declare const getVars: <TVars extends Vars = Vars>() => TVars;
+export { MissingScopeError, MissingVarsError, type Vars } from '@appshell/runtime';

package/dist/types/wire.d.ts

@@ -0,0 +1,26 @@
+/**
+ * What the browser is told about a remote.
+ *
+ * These live here rather than in `@appshell/config` because config is build tooling — it
+ * carries yaml, lodash and axios — and a package that only wants to type a remote should
+ * not install a compiler to get it. This package is already the one every micro-frontend
+ * on the page shares, and it has no dependencies of its own to pass on.
+ *
+ * `AppshellManifest` deliberately stays in `@appshell/config`. It is a build artifact, and
+ * its `modules` field is Module Federation plugin options — build-time webpack
+ * configuration the browser never sees and this package should never drag in.
+ */
+/** Arbitrary, application-defined description of a remote. Appshell never reads it. */
+export type Metadata = Record<string, unknown>;
+/** A remote the registry has already resolved, so the browser needs no manifest fetch. */
+export type AppshellRemote<TMetadata = Metadata> = {
+    id: string;
+    manifestUrl: string;
+    remoteEntryUrl: string;
+    scope: string;
+    module: string;
+    shareScope?: string;
+    metadata: TMetadata;
+};
+/** Remote key to manifest url. */
+export type AppshellIndex = Record<string, string>;

package/dist/vars.js

@@ -0,0 +1 @@
+!function(e,r){if("object"==typeof exports&&"object"==typeof module)module.exports=r(require("@appshell/runtime"));else if("function"==typeof define&&define.amd)define(["@appshell/runtime"],r);else{var o="object"==typeof exports?r(require("@appshell/runtime")):r(e["@appshell/runtime"]);for(var t in o)("object"==typeof exports?exports:e)[t]=o[t]}}(this,(e=>(()=>{"use strict";var r={164(r){r.exports=e}},o={};function t(e){var n=o[e];if(void 0!==n)return n.exports;var i=o[e]={exports:{}};return r[e](i,i.exports,t),i.exports}t.n=e=>{var r=e&&e.__esModule?()=>e.default:()=>e;return t.d(r,{a:r}),r},t.d=(e,r)=>{for(var o in r)t.o(r,o)&&!t.o(e,o)&&Object.defineProperty(e,o,{enumerable:!0,get:r[o]})},t.o=(e,r)=>Object.prototype.hasOwnProperty.call(e,r),t.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})};var n={};t.r(n),t.d(n,{MissingScopeError:()=>i.MissingScopeError,MissingVarsError:()=>i.MissingVarsError,getVars:()=>s});var i=t(164);const s=()=>(0,i.readVars)((()=>{if("undefined"==typeof __APPSHELL_SCOPE__)throw new i.MissingScopeError;return __APPSHELL_SCOPE__})());return n})()));

package/package.json

@@ -1,9 +1,27 @@
 {
   "name": "@appshell/runtime",
-  "version": "1.0.0-alpha.24",
+  "version": "1.0.0-alpha.25",
   "description": "The shared singleton that delivers a package's runtime configuration to it",
   "main": "dist/main.js",
   "types": "dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "default": "./dist/main.js"
+    },
+    "./vars": {
+      "types": "./dist/types/vars.d.ts",
+      "default": "./dist/vars.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "typesVersions": {
+    "*": {
+      "vars": [
+        "./dist/types/vars.d.ts"
+      ]
+    }
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/appshellhq/appshell.git"
@@ -30,5 +48,5 @@
     "appshell"
   ],
   "license": "MIT",
-  "gitHead": "41f2ce7eee90490c80273dfe4a5df46295730a0e"
+  "gitHead": "7d90eb91be3cb50aae5aaa680063878dfcaafea2"
 }