@fluid-app/droplet-bridge 0.0.0-stage → 0.1.1

package/dist/index.d.mts

@@ -0,0 +1,243 @@
+//#region src/errors.d.ts
+type FluidBridgeErrorCode = "configuration_error" | "host_unavailable" | "handshake_timeout" | "incompatible_version" | "token_mint_failed" | "unauthorized" | "forbidden_origin" | "invalid_context" | "request_timeout" | "fetch_target_not_allowed" | "network_error" | "failed_authentication";
+declare class FluidBridgeError extends Error {
+  readonly code: FluidBridgeErrorCode;
+  readonly details?: unknown;
+  constructor(code: FluidBridgeErrorCode, message: string, details?: unknown);
+}
+declare class FluidBridgeConfigurationError extends FluidBridgeError {
+  constructor(message: string, details?: unknown);
+}
+declare class FluidBridgeHostUnavailableError extends FluidBridgeError {
+  constructor(message?: string, details?: unknown);
+}
+declare class FluidBridgeHandshakeTimeoutError extends FluidBridgeError {
+  constructor(message?: string, details?: unknown);
+}
+declare class FluidBridgeIncompatibleVersionError extends FluidBridgeError {
+  constructor(message?: string, details?: unknown);
+}
+declare class FluidBridgeTokenMintError extends FluidBridgeError {
+  constructor(message?: string, details?: unknown);
+}
+declare class FluidBridgeUnauthorizedError extends FluidBridgeError {
+  constructor(message?: string, details?: unknown);
+}
+declare class FluidBridgeForbiddenOriginError extends FluidBridgeError {
+  constructor(message?: string, details?: unknown);
+}
+declare class FluidBridgeInvalidContextError extends FluidBridgeError {
+  constructor(message?: string, details?: unknown);
+}
+declare class FluidBridgeRequestTimeoutError extends FluidBridgeError {
+  constructor(message?: string, details?: unknown);
+}
+declare class FluidBridgeFetchTargetError extends FluidBridgeError {
+  constructor(message?: string, details?: unknown);
+}
+declare class FluidBridgeNetworkError extends FluidBridgeError {
+  constructor(message?: string, details?: unknown);
+}
+declare class FluidBridgeFailedAuthenticationError extends FluidBridgeError {
+  constructor(message?: string, details?: unknown);
+}
+//#endregion
+//#region src/protocol.d.ts
+declare const FLUID_BRIDGE_PROTOCOL_VERSION = "2026-07";
+declare const APP_BRIDGE_SDK_NAME = "@fluid-app/droplet-bridge";
+declare const APP_BRIDGE_SDK_VERSION = "0.1.0";
+declare const FluidBridgeMessageType: {
+  readonly SessionTokenRequest: "FLUID::SESSION_TOKEN_REQUEST";
+  readonly SessionTokenRespond: "FLUID::SESSION_TOKEN_RESPOND";
+  readonly ContextRequest: "FLUID::CONTEXT_REQUEST";
+  readonly ContextRespond: "FLUID::CONTEXT_RESPOND";
+  readonly FailedAuthentication: "FLUID::ERROR::FAILED_AUTHENTICATION";
+  readonly Unauthorized: "FLUID::ERROR::UNAUTHORIZED";
+  readonly IncompatibleVersion: "FLUID::ERROR::INCOMPATIBLE_VERSION";
+  readonly TokenMintFailed: "FLUID::ERROR::TOKEN_MINT_FAILED";
+  readonly InvalidContext: "FLUID::ERROR::INVALID_CONTEXT";
+};
+type FluidBridgeMessageTypeValue = (typeof FluidBridgeMessageType)[keyof typeof FluidBridgeMessageType];
+type BridgeActorType = "admin" | "member" | "customer" | "anonymous";
+type BridgeEntryType = "droplet" | "drop_zone" | "mobile_embed" | "portal_embed" | "app_extension";
+interface BridgeResource {
+  type: string;
+  id: string;
+}
+interface BridgeContext {
+  protocol: typeof FLUID_BRIDGE_PROTOCOL_VERSION;
+  app: {
+    clientId: string;
+  };
+  store: {
+    subdomain: string;
+    url: string;
+    uuid?: string;
+    name?: string;
+  };
+  actor?: {
+    type: BridgeActorType;
+    uuid?: string;
+    roles?: string[];
+    permissions?: string[];
+    memberType?: string;
+  };
+  entry: {
+    type: BridgeEntryType;
+    name?: string;
+  };
+  resources: BridgeResource[];
+  fetch: {
+    allowedOrigins: string[];
+  };
+  sdk: {
+    minVersion: string;
+    recommendedVersion?: string;
+  };
+}
+interface BridgeEnvelope<TType extends string, TPayload> {
+  id: string;
+  type: TType;
+  payload: TPayload;
+}
+//#endregion
+//#region src/host.d.ts
+interface CreateFluidBridgeHostOptions {
+  iframe: HTMLIFrameElement;
+  appOrigin: string;
+  clientId: string;
+  getContext: () => BridgeContext | Promise<BridgeContext>;
+  getSessionToken: (context: BridgeContext) => string | Promise<string>;
+  targetWindow?: Window;
+}
+interface FluidBridgeHost {
+  destroy: () => void;
+}
+declare function createFluidBridgeHost(options: CreateFluidBridgeHostOptions): FluidBridgeHost;
+//#endregion
+//#region src/canonical-protocol.d.ts
+declare const protocolVersion: "1";
+declare const BRIDGE_PROTOCOL_VERSION: typeof protocolVersion;
+type CanonicalBridgeActorType = "store_admin" | "store_member";
+type CanonicalBridgeEntryType = "droplet" | "drop_zone" | "mobile_embed" | "portal_embed" | "app_extension";
+interface CanonicalBridgeResource {
+  type: string;
+  id: string;
+}
+interface CanonicalBridgeContext {
+  protocolVersion: typeof BRIDGE_PROTOCOL_VERSION;
+  app: {
+    clientId: string;
+  };
+  store: {
+    subdomain: string;
+    url: string;
+    uuid?: string;
+    name?: string; /** Authenticated viewer’s active language. Present when the host provides one. */
+    locale?: string;
+  };
+  actor: {
+    type: CanonicalBridgeActorType;
+    uuid?: string;
+    roles?: string[];
+    permissions?: string[];
+    memberType?: string;
+  };
+  entry: {
+    type: CanonicalBridgeEntryType;
+    name?: string;
+  };
+  resources: CanonicalBridgeResource[];
+  fetch: {
+    allowedOrigins: string[];
+  };
+  sdk: {
+    minVersion: string;
+    recommendedVersion?: string;
+  };
+}
+//#endregion
+//#region src/canonical-host.d.ts
+/** Trusted host inputs, fixed for one document load. Never populate from iframe messages. */
+interface BridgeMount {
+  clientId: string;
+  storeUuid: string;
+  actor: {
+    type: CanonicalBridgeContext["actor"]["type"];
+    uuid: string;
+  };
+  /**
+  * Advisory/informational only. Required so the shell cannot omit it, but
+  * the host never compares it against anything — it is not an
+  * authorization input. Carry it for logging/telemetry only.
+  */
+  installationId: string;
+  entry: {
+    type: CanonicalBridgeContext["entry"]["type"];
+    name: string;
+  };
+  /** Generated once by the shell, shared with the URL-bootstrap mint. */
+  sid: string;
+}
+interface CanonicalHostOptions {
+  iframe: HTMLIFrameElement;
+  /** Exact origin derived by the shell from the server's registered embed URL. */
+  appOrigin: string;
+  mount: BridgeMount;
+  /** Endpoint adapter for the context request. Returns the inner bridge_context unchanged. */
+  getContext: (signal: AbortSignal) => Promise<unknown>;
+  /** Endpoint adapter for the session-token request. Uses host auth; returns the compact token. */
+  getSessionToken: (mount: Readonly<BridgeMount>, signal: AbortSignal) => Promise<string>;
+  targetWindow?: Window;
+}
+interface CanonicalBridgeHost {
+  /** Unmount or identity/context change must destroy this host before mounting another. */
+  destroy: () => void;
+}
+/** Push handshake and correlated refresh on the single canonical envelope. */
+declare function createCanonicalBridgeHost(options: CanonicalHostOptions): CanonicalBridgeHost;
+//#endregion
+//#region src/session-token-api.d.ts
+interface AppBridgeSessionTokenRequest {
+  clientId: string;
+  entry: BridgeContext["entry"];
+  resources?: BridgeContext["resources"];
+  allowedOrigins?: string[];
+  sessionId?: string;
+}
+interface MintAppBridgeSessionTokenOptions {
+  request: AppBridgeSessionTokenRequest;
+  apiBaseUrl?: string;
+  authToken?: string;
+  fetch?: typeof fetch;
+}
+declare function mintAppBridgeSessionToken({
+  request,
+  apiBaseUrl,
+  authToken,
+  fetch: fetchImplementation
+}: MintAppBridgeSessionTokenOptions): Promise<string>;
+declare function sessionTokenRequestFromContext(context: BridgeContext, sessionId?: string): AppBridgeSessionTokenRequest;
+//#endregion
+//#region src/canonical-client.d.ts
+interface CreateFluidBridgeOptions {
+  clientId: string;
+  /** Exact host-shell origin, supplied by the shell. Never inferred from referrer. */
+  hostOrigin: string;
+  disableFetchPatch?: boolean;
+  timeoutMs?: number;
+  /** Document window; parent remains the only permitted sender. Primarily for testing. */
+  targetWindow?: Window;
+  fetch?: typeof fetch;
+}
+interface FluidBridge {
+  getContext(): Promise<CanonicalBridgeContext>;
+  getSessionToken(): Promise<string>;
+  fetch: typeof fetch;
+  destroy(): void;
+}
+/** One canonical client per iframe document. Tokens are decoded for delivery binding only. */
+declare function createFluidBridge(options: CreateFluidBridgeOptions): FluidBridge;
+//#endregion
+export { APP_BRIDGE_SDK_NAME, APP_BRIDGE_SDK_VERSION, type AppBridgeSessionTokenRequest, type BridgeActorType, type BridgeContext, type BridgeEntryType, type BridgeEnvelope, type BridgeMount, type BridgeResource, type CanonicalBridgeContext, type CanonicalBridgeHost, type CanonicalHostOptions, FluidBridgeConfigurationError as ConfigurationError, FluidBridgeConfigurationError, type CreateFluidBridgeHostOptions, type CreateFluidBridgeOptions, FLUID_BRIDGE_PROTOCOL_VERSION, FluidBridgeFailedAuthenticationError as FailedAuthenticationError, FluidBridgeFailedAuthenticationError, FluidBridgeFetchTargetError as FetchTargetNotAllowedError, FluidBridgeFetchTargetError, type FluidBridge, FluidBridgeError, type FluidBridgeErrorCode, FluidBridgeForbiddenOriginError, FluidBridgeForbiddenOriginError as ForbiddenOriginError, FluidBridgeHandshakeTimeoutError, FluidBridgeHandshakeTimeoutError as HandshakeTimeoutError, type FluidBridgeHost, FluidBridgeHostUnavailableError, FluidBridgeHostUnavailableError as HostUnavailableError, FluidBridgeIncompatibleVersionError, FluidBridgeIncompatibleVersionError as IncompatibleVersionError, FluidBridgeInvalidContextError, FluidBridgeInvalidContextError as InvalidContextError, FluidBridgeMessageType, type FluidBridgeMessageTypeValue, FluidBridgeNetworkError, FluidBridgeNetworkError as NetworkError, FluidBridgeRequestTimeoutError, FluidBridgeRequestTimeoutError as RequestTimeoutError, FluidBridgeTokenMintError, FluidBridgeTokenMintError as TokenMintFailedError, FluidBridgeUnauthorizedError, FluidBridgeUnauthorizedError as UnauthorizedError, type MintAppBridgeSessionTokenOptions, createCanonicalBridgeHost, createFluidBridge, createFluidBridgeHost, mintAppBridgeSessionToken, sessionTokenRequestFromContext };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/errors.ts","../src/protocol.ts","../src/host.ts","../src/canonical-protocol.ts","../src/canonical-host.ts","../src/session-token-api.ts","../src/canonical-client.ts"],"mappings":";KAAY,oBAAA;AAAA,cAcC,gBAAA,SAAyB,KAAA;EAAA,SAC3B,IAAA,EAAM,oBAAA;EAAA,SACN,OAAA;EAET,WAAA,CAAY,IAAA,EAAM,oBAAA,EAAsB,OAAA,UAAiB,OAAA;AAAA;AAAA,cAQ9C,6BAAA,SAAsC,gBAAA;EACjD,WAAA,CAAY,OAAA,UAAiB,OAAA;AAAA;AAAA,cAMlB,+BAAA,SAAwC,gBAAA;EACnD,WAAA,CACE,OAAA,WACA,OAAA;AAAA;AAAA,cAOS,gCAAA,SAAyC,gBAAA;EACpD,WAAA,CACE,OAAA,WACA,OAAA;AAAA;AAAA,cAOS,mCAAA,SAA4C,gBAAA;EACvD,WAAA,CACE,OAAA,WACA,OAAA;AAAA;AAAA,cAOS,yBAAA,SAAkC,gBAAA;EAC7C,WAAA,CACE,OAAA,WACA,OAAA;AAAA;AAAA,cAOS,4BAAA,SAAqC,gBAAA;EAChD,WAAA,CACE,OAAA,WACA,OAAA;AAAA;AAAA,cAOS,+BAAA,SAAwC,gBAAA;EACnD,WAAA,CACE,OAAA,WACA,OAAA;AAAA;AAAA,cAOS,8BAAA,SAAuC,gBAAA;EAClD,WAAA,CACE,OAAA,WACA,OAAA;AAAA;AAAA,cAOS,8BAAA,SAAuC,gBAAA;EAClD,WAAA,CACE,OAAA,WACA,OAAA;AAAA;AAAA,cAOS,2BAAA,SAAoC,gBAAA;EAC/C,WAAA,CACE,OAAA,WACA,OAAA;AAAA;AAAA,cAOS,uBAAA,SAAgC,gBAAA;EAC3C,WAAA,CAAY,OAAA,WAA2C,OAAA;AAAA;AAAA,cAM5C,oCAAA,SAA6C,gBAAA;EACxD,WAAA,CACE,OAAA,WACA,OAAA;AAAA;;;cCrIS,6BAAA;AAAA,cACA,mBAAA;AAAA,cACA,sBAAA;AAAA,cAEA,sBAAA;EAAA,SACX,mBAAA;EAAA,SACA,mBAAA;EAAA,SACA,cAAA;EAAA,SACA,cAAA;EAAA,SACA,oBAAA;EAAA,SACA,YAAA;EAAA,SACA,mBAAA;EAAA,SACA,eAAA;EAAA,SACA,cAAA;AAAA;AAAA,KAGU,2BAAA,WACF,sBAAA,eAAqC,sBAAA;AAAA,KAEnC,eAAA;AAAA,KACA,eAAA;AAAA,UAOK,cAAA;EACf,IAAA;EACA,EAAA;AAAA;AAAA,UAGe,aAAA;EACf,QAAA,SAAiB,6BAAA;EACjB,GAAA;IAAO,QAAA;EAAA;EACP,KAAA;IAAS,SAAA;IAAmB,GAAA;IAAa,IAAA;IAAe,IAAA;EAAA;EACxD,KAAA;IACE,IAAA,EAAM,eAAA;IACN,IAAA;IACA,KAAA;IACA,WAAA;IACA,UAAA;EAAA;EAEF,KAAA;IAAS,IAAA,EAAM,eAAA;IAAiB,IAAA;EAAA;EAChC,SAAA,EAAW,cAAA;EACX,KAAA;IAAS,cAAA;EAAA;EACT,GAAA;IAAO,UAAA;IAAoB,kBAAA;EAAA;AAAA;AAAA,UAGZ,cAAA;EACf,EAAA;EACA,IAAA,EAAM,KAAA;EACN,OAAA,EAAS,QAAA;AAAA;;;UCzBM,4BAAA;EACf,MAAA,EAAQ,iBAAA;EACR,SAAA;EACA,QAAA;EACA,UAAA,QAAkB,aAAA,GAAgB,OAAA,CAAQ,aAAA;EAC1C,eAAA,GAAkB,OAAA,EAAS,aAAA,cAA2B,OAAA;EACtD,YAAA,GAAe,MAAA;AAAA;AAAA,UAGA,eAAA;EACf,OAAA;AAAA;AAAA,iBAGc,qBAAA,CACd,OAAA,EAAS,4BAAA,GACR,eAAA;;;cC1CG,eAAA;AAAA,cAEO,uBAAA,SAAgC,eAAA;AAAA,KA8DjC,wBAAA;AAAA,KAEA,wBAAA;AAAA,UAOK,uBAAA;EACf,IAAA;EACA,EAAA;AAAA;AAAA,UAGe,sBAAA;EACf,eAAA,SAAwB,uBAAA;EACxB,GAAA;IAAO,QAAA;EAAA;EACP,KAAA;IACE,SAAA;IACA,GAAA;IACA,IAAA;IACA,IAAA,WHvCA;IGyCA,MAAA;EAAA;EAEF,KAAA;IACE,IAAA,EAAM,wBAAA;IACN,IAAA;IACA,KAAA;IACA,WAAA;IACA,UAAA;EAAA;EAEF,KAAA;IAAS,IAAA,EAAM,wBAAA;IAA0B,IAAA;EAAA;EACzC,SAAA,EAAW,uBAAA;EACX,KAAA;IAAS,cAAA;EAAA;EACT,GAAA;IACE,UAAA;IACA,kBAAA;EAAA;AAAA;;;AHrGJ;AAAA,UIiBiB,WAAA;EACf,QAAA;EACA,SAAA;EACA,KAAA;IAAS,IAAA,EAAM,sBAAA;IAAyC,IAAA;EAAA;;;;;;EAMxD,cAAA;EACA,KAAA;IAAS,IAAA,EAAM,sBAAA;IAAyC,IAAA;EAAA;;EAExD,GAAA;AAAA;AAAA,UAGe,oBAAA;EACf,MAAA,EAAQ,iBAAA;EJfiD;EIiBzD,SAAA;EACA,KAAA,EAAO,WAAA;;EAEP,UAAA,GAAa,MAAA,EAAQ,WAAA,KAAgB,OAAA;;EAErC,eAAA,GACE,KAAA,EAAO,QAAA,CAAS,WAAA,GAChB,MAAA,EAAQ,WAAA,KACL,OAAA;EACL,YAAA,GAAe,MAAA;AAAA;AAAA,UAGA,mBAAA;EJpBc;EIsB7B,OAAA;AAAA;;iBAQc,yBAAA,CACd,OAAA,EAAS,oBAAA,GACR,mBAAA;;;UC9Cc,4BAAA;EACf,QAAA;EACA,KAAA,EAAO,aAAA;EACP,SAAA,GAAY,aAAA;EACZ,cAAA;EACA,SAAA;AAAA;AAAA,UAGe,gCAAA;EACf,OAAA,EAAS,4BAAA;EACT,UAAA;EACA,SAAA;EACA,KAAA,UAAe,KAAA;AAAA;AAAA,iBAgBK,yBAAA,CAAA;EACpB,OAAA;EACA,UAAA;EACA,SAAA;EACA,KAAA,EAAO;AAAA,GACN,gCAAA,GAAmC,OAAA;AAAA,iBAgCtB,8BAAA,CACd,OAAA,EAAS,aAAA,EACT,SAAA,YACC,4BAAA;;;UCnEc,wBAAA;EACf,QAAA;;EAEA,UAAA;EACA,iBAAA;EACA,SAAA;ENLW;EMOX,YAAA,GAAe,MAAA;EACf,KAAA,UAAe,KAAA;AAAA;AAAA,UAEA,WAAA;EACf,UAAA,IAAc,OAAA,CAAQ,sBAAA;EACtB,eAAA,IAAmB,OAAA;EACnB,KAAA,SAAc,KAAA;EACd,OAAA;AAAA;;iBAWc,iBAAA,CACd,OAAA,EAAS,wBAAA,GACR,WAAA"}