@appshell/config 1.0.0-alpha.47 → 1.0.0-alpha.49

package/dist/types/index.d.ts

@@ -8,8 +8,8 @@ export { clearCredential, credentialsPath, resolveToken, saveCredential } from '
 export type { Credential } from './credentials';
 export { default as generateManifest, manifestFrom } from './generate.manifest';
 export { default as outdated } from './outdated';
-export { activate, publish } from './publish';
-export type { PublishOptions, PublishResult } from './publish';
+export { activate, openOverlay, publish } from './publish';
+export type { OpenedOverlay, OverlayRemotePatch, PublishOptions, PublishResult } from './publish';
 export { default as sync } from './sync';
 export type { AppshellComposition, AppshellConfig, AppshellConfigRemote, AppshellIndex, AppshellManifest, AppshellRemote, AppshellTemplate, AppshellTokenUsage, ComparisonResult, ComparisonResults, ComparisonTarget, Metadata, ModuleFederationPluginOptions, PackageSpec, ResolvedRemote, Schema, SharedConfig, SharedModuleSpec, SharedObject, } from './types';
 export * as utils from './utils';

package/dist/types/publish.d.ts

@@ -26,3 +26,47 @@ export declare const publish: ({ registry, token, name, version, manifest, visib
  * @param application `scope/name`
  */
 export declare const activate: (registry: string, application: string, packageId: string, token?: string) => Promise<void>;
+/** What an overlay redirects a single remote to. */
+export type OverlayRemotePatch = {
+    remoteEntryUrl: string;
+    manifestUrl?: string;
+    /**
+     * The remote's `metadata` as this build declares it.
+     *
+     * Sent because a developer iterating on `appshell.config.yaml` is editing metadata as
+     * much as code; without it an overlay serves their new bundle beside the published
+     * route, displayName and icon. The registry replaces rather than merges, so a key
+     * removed from the yaml disappears rather than standing.
+     */
+    metadata?: Metadata;
+};
+export type OpenedOverlay = {
+    id: string;
+    confirmUrl: string;
+    url: string;
+    remotes: string[];
+    expiresAt: string;
+    /**
+     * False when an overlay was already open for this developer and this one extended it.
+     * A browser carries a single overlay id, so an extended overlay is one some browser has
+     * already confirmed — nothing needs sending back to the confirmation page.
+     */
+    created: boolean;
+};
+/**
+ * Points some of an application's remotes at a developer's own machine, for that
+ * developer only.
+ *
+ * This is what a local dev loop does instead of republishing. A published version is
+ * immutable and content-addressed; overwriting one on every rebuild makes the digest
+ * describe whoever built last, and two developers sharing a registry overwrite each
+ * other. An overlay is per-developer, per-browser and expiring, so neither happens.
+ *
+ * Extending is the normal case rather than the exception: the registry merges remotes
+ * into whatever overlay this developer already holds, so serving two micro-frontends
+ * locally redirects both without minting a second overlay or asking for confirmation
+ * twice.
+ *
+ * @param application `scope/name`
+ */
+export declare const openOverlay: (registry: string, application: string, remotes: Record<string, OverlayRemotePatch>, token?: string) => Promise<OpenedOverlay>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appshell/config",
-  "version": "1.0.0-alpha.47",
+  "version": "1.0.0-alpha.49",
   "description": "Utility for producing a global appshell manifest for module federation micro-frontends",
   "main": "dist/main.js",
   "types": "dist/types/index.d.ts",
@@ -30,9 +30,9 @@
     "appshell"
   ],
   "license": "MIT",
-  "gitHead": "9299f50b31ded495f5e846731a940fe69299f8fe",
+  "gitHead": "efd0f9c0156d747c1104edc34044a415999ab3c6",
   "dependencies": {
-    "@appshell/runtime": "^1.0.0-alpha.47",
+    "@appshell/runtime": "^1.0.0-alpha.49",
     "yaml": "^2.8.0"
   }
 }