@le-space/ui 0.7.0 → 0.9.0

package/shared/index.d.ts

@@ -1,3 +1,6 @@
+type CrnSource = 'list' | 'aggregate';
+type CrnSourcePreference = 'auto' | 'aggregate' | 'list';
+
 type MessageStatus = 'processed' | 'pending' | 'rejected' | 'removing' | 'removed' | 'unknown';
 interface BalanceResponse {
     address: string;
@@ -220,6 +223,12 @@ interface SponsorRelayProps {
     apiHost?: string;
     apiHosts?: string | readonly string[];
     crnListUrl?: string;
+    /**
+     * Which CRN source to read. `auto` falls back to the corechannel aggregate
+     * when crns.json is down, `aggregate` skips crns.json, `list` disables the
+     * fallback. `localStorage.LE_SPACE_CRN_SOURCE` overrides this at runtime.
+     */
+    crnSource?: CrnSourcePreference;
     schedulerApiHost?: string;
     twoN6ApiHost?: string;
 }
@@ -253,6 +262,12 @@ interface CompactInstanceDetails {
     vmIpv4: string | null;
     webUrl: string | null;
     sshCommand: string | null;
+    /**
+     * Hostname of the deployment's HTTPS proxy. The mapped ports are plain HTTP,
+     * which a browser on an HTTPS page refuses to fetch, so this is the only
+     * address the card can read the relay's own documents from.
+     */
+    proxyHostname: string | null;
     mappedPorts: Array<{
         label: string;
         hostPort: number | null;
@@ -260,6 +275,32 @@ interface CompactInstanceDetails {
     execution: InstanceExecution | null;
     error: string | null;
 }
+/** One transport's worth of addresses, as the relay itself groups them. */
+interface SponsorRelayAddressGroup {
+    key: string;
+    label: string;
+    addresses: string[];
+}
+/**
+ * What a deployment reports about itself at `/multiaddrs`. Deliberately not
+ * normalised into "the best address": the card shows what the relay says, and
+ * choosing between addresses is the consumer's business, not this UI's.
+ */
+interface SponsorRelayInstanceAddresses {
+    status: 'idle' | 'loading' | 'ready' | 'unsupported' | 'error';
+    /** Transport groups, empty for a profile that publishes no libp2p addresses. */
+    groups: SponsorRelayAddressGroup[];
+    /** Ready-to-paste environment block, when the profile publishes one. */
+    pwaEnv: Record<string, string> | null;
+    /** Raw payload, rendered verbatim on the health tab. */
+    payload: Record<string, unknown> | null;
+    peerId: string | null;
+    version: string | null;
+    fetchedAt: number | null;
+    error: string | null;
+    /** Source URL, shown so a person can curl exactly what the card read. */
+    sourceUrl: string | null;
+}
 interface CompactInstanceRecord {
     instance: InstanceMessage;
     details: CompactInstanceDetails;
@@ -312,6 +353,8 @@ interface SponsorRelayState {
     pricingSummary: SponsorRelayPricingSummary;
     balance: BalanceResponse | null;
     crns: Crn[];
+    /** Which source the current `crns` came from; `null` until the first load. */
+    crnSource: CrnSource | null;
     selectedCrn: Crn | null;
     crnOptions: Array<{
         hash: string;
@@ -324,6 +367,13 @@ interface SponsorRelayState {
     orphanBootstrapRegistrations: CompactBootstrapRegistrationRecord[];
     lastDeploymentHash: string | null;
     deploymentProgress: DeploymentProgressEvent;
+    /**
+     * What each deployment reports at `/multiaddrs`, keyed by instance item hash.
+     * Fetched on demand rather than with the instance list: AutoTLS addresses only
+     * appear a minute or two after a deploy reports success, so this is state that
+     * has to be refreshable on its own.
+     */
+    instanceAddresses: Record<string, SponsorRelayInstanceAddresses>;
 }
 type SponsorRelaySubscriber = (state: SponsorRelayState) => void;
 
@@ -347,7 +397,7 @@ declare const STALE_INSTANCE_ALLOCATION_COOLDOWN_MS: number;
 declare const RECENT_INSTANCE_RUNTIME_GRACE_MS: number;
 declare const DEPLOYMENT_PENDING_WARNING_MS: number;
 
-declare const UI_PACKAGE_VERSION = "0.7.0";
+declare const UI_PACKAGE_VERSION = "0.9.0";
 
 interface RootfsRequiredPortForward {
     port: number;
@@ -383,6 +433,14 @@ declare function connectWallet(provider?: EthereumProviderLike | null): Promise<
 declare function personalSign(address: string, message: string, provider?: EthereumProviderLike | null): Promise<string>;
 declare function watchWallet(onChange: () => void, provider?: EthereumProviderLike | null): () => void;
 
+/**
+ * Normalise the two address documents in the fleet into one list of groups.
+ *
+ * orbitdb-relay reports `byTransport`; uc-go-peer's describe output uses
+ * `<transport>_multiaddrs` keys. Neither is rewritten or ranked here — the card
+ * shows what the relay said, and picking an address is the consumer's job.
+ */
+declare function parseInstanceAddressPayload(payload: Record<string, unknown>): SponsorRelayInstanceAddresses;
 declare function rootfsHealth(args: {
     manifestState: RootfsManifestState;
     rootfsVerified: boolean;
@@ -438,6 +496,18 @@ declare class SponsorRelayController {
     private refreshWalletDerivedState;
     refresh(): Promise<void>;
     deploy(): Promise<void>;
+    /**
+     * Read one deployment's own address document over its HTTPS proxy.
+     *
+     * The mapped ports are plain HTTP, which a browser on an HTTPS page refuses to
+     * fetch, so the proxy hostname is the only way in. Deliberately single-shot:
+     * unlike the deploy-time readiness probe this backs a button someone pressed,
+     * and a caller who wants newer data presses it again.
+     */
+    loadInstanceAddresses(instanceHash: string, options?: {
+        force?: boolean;
+    }): Promise<void>;
+    private patchInstanceAddresses;
     deleteInstance(instanceHash: string): Promise<void>;
     deleteBootstrapRegistration(registrationHash: string): Promise<void>;
 }
@@ -450,4 +520,4 @@ interface DeploymentProgressEmitter {
 }
 declare function createDeploymentProgressEmitter(): DeploymentProgressEmitter;
 
-export { type CompactBootstrapRegistrationRecord, type CompactInstanceDetails, type CompactInstanceRecord, DEFAULT_INSTANCE_NAME, DEFAULT_MANIFEST_URL, DEFAULT_TIER_ID, DEFAULT_UCAN_STORE_ALLOWED_CAPABILITIES, DEFAULT_UCAN_STORE_MAX_DELEGATION_EXPIRATION_SECONDS, DEFAULT_UCAN_STORE_PWA_ORIGIN, DEFAULT_UCAN_STORE_SERVICE_DID, DEFAULT_UCAN_STORE_SERVICE_ORIGIN, DEFAULT_UCAN_STORE_USER_DELEGATION_EXPIRATION_SECONDS, DEPLOYMENT_PENDING_WARNING_MS, type DeploymentProgressEmitter, type EthereumProviderLike, IDLE_DEPLOYMENT_PROGRESS, INSTANCE_RUNTIME_PENDING_REFRESH_MS, INSTANCE_RUNTIME_READY_REFRESH_MS, INSTANCE_RUNTIME_STALE_REFRESH_MS, MANIFEST_SOURCE_REFRESH_DEBOUNCE_MS, RECENT_INSTANCE_RUNTIME_GRACE_MS, REFRESH_INTERVAL_MS, ROOTFS_MISSING_STATE, STALE_INSTANCE_ALLOCATION_COOLDOWN_MS, SponsorRelayController, type SponsorRelayHealthTone, type SponsorRelayPricingSummary, type SponsorRelayProps, type SponsorRelayRootfsHealth, type SponsorRelayState, type SponsorRelaySubscriber, type SponsorRelayUcanStoreBootstrapInput, type SponsorRelayWalletState, UI_PACKAGE_VERSION, buildSshCommand, connectWallet, createDeploymentProgressEmitter, createSponsorRelayController, formatDateTime, formatNumber, formatTierSpecLabel, getEthereumProvider, joinMappedPorts, joinRequiredPortForwards, personalSign, resolveManifestSource, rootfsHealth, shortHash, toChecksumAddress, watchWallet };
+export { type CompactBootstrapRegistrationRecord, type CompactInstanceDetails, type CompactInstanceRecord, DEFAULT_INSTANCE_NAME, DEFAULT_MANIFEST_URL, DEFAULT_TIER_ID, DEFAULT_UCAN_STORE_ALLOWED_CAPABILITIES, DEFAULT_UCAN_STORE_MAX_DELEGATION_EXPIRATION_SECONDS, DEFAULT_UCAN_STORE_PWA_ORIGIN, DEFAULT_UCAN_STORE_SERVICE_DID, DEFAULT_UCAN_STORE_SERVICE_ORIGIN, DEFAULT_UCAN_STORE_USER_DELEGATION_EXPIRATION_SECONDS, DEPLOYMENT_PENDING_WARNING_MS, type DeploymentProgressEmitter, type EthereumProviderLike, IDLE_DEPLOYMENT_PROGRESS, INSTANCE_RUNTIME_PENDING_REFRESH_MS, INSTANCE_RUNTIME_READY_REFRESH_MS, INSTANCE_RUNTIME_STALE_REFRESH_MS, MANIFEST_SOURCE_REFRESH_DEBOUNCE_MS, RECENT_INSTANCE_RUNTIME_GRACE_MS, REFRESH_INTERVAL_MS, ROOTFS_MISSING_STATE, STALE_INSTANCE_ALLOCATION_COOLDOWN_MS, type SponsorRelayAddressGroup, SponsorRelayController, type SponsorRelayHealthTone, type SponsorRelayInstanceAddresses, type SponsorRelayPricingSummary, type SponsorRelayProps, type SponsorRelayRootfsHealth, type SponsorRelayState, type SponsorRelaySubscriber, type SponsorRelayUcanStoreBootstrapInput, type SponsorRelayWalletState, UI_PACKAGE_VERSION, buildSshCommand, connectWallet, createDeploymentProgressEmitter, createSponsorRelayController, formatDateTime, formatNumber, formatTierSpecLabel, getEthereumProvider, joinMappedPorts, joinRequiredPortForwards, parseInstanceAddressPayload, personalSign, resolveManifestSource, rootfsHealth, shortHash, toChecksumAddress, watchWallet };