@fkn/lib 0.9.23 → 0.9.25

package/packages-Cn8S-Hkn.d.ts

@@ -1,217 +0,0 @@
-import { Remote } from "osra";
-
-//#region src/api/packages/identity.d.ts
-/**
- * A connection's identity. `id` is the normalized package uri when the other end runs on a sandbox
- * tenant origin (e.g. 'npm:@banou/stub'), otherwise its plain page origin. Version-pinned tenant
- * origins normalize to the version-free id, so a package keeps one identity (and one set of install
- * records) across its own updates, for every handler rather than only for npm.
- */
-type Caller = {
-  id: string;
-  origin: string; /** a package's display name, when provenance knew it. Attribution only, never an identity. */
-  name?: string;
-  /**
-   * Set when PROVENANCE established this caller is a package, which is the only way to know it for a
-   * connection whose `origin` is this realm's own (a broker nested inside a tenant we mounted). Every
-   * other package caller is recognised from its browser-set tenant origin instead.
-   */
-  isPackage?: boolean;
-};
-//#endregion
-//#region src/api/packages/types.d.ts
-type PackageQuery = {
-  /** package kind, e.g. 'plugin' - becomes the keyword `fkn-type:<type>` */type: string; /** host app scope, e.g. 'stub' - becomes the keyword `fkn-<type>--<id>` */
-  id?: string; /** package source; npm is the only origin implemented */
-  origin?: 'npm'; /** free text mixed into the registry query */
-  text?: string; /** result count, clamped to 1..100 */
-  size?: number;
-};
-type PackageResult = {
-  /** normalized version-free uri, e.g. 'npm:@banou/stub-plugin-foo' */uri: string;
-  origin: 'npm';
-  name: string; /** latest version per the search index - display only, install re-resolves from the packument */
-  version: string;
-  description: string;
-  keywords: string[];
-  publisher: string | null;
-  downloadsMonthly: number | null;
-  links: {
-    npm?: string;
-    homepage?: string;
-    repository?: string;
-  }; /** installed by the calling app */
-  installed: boolean;
-};
-type InstalledPackage = {
-  uri: string;
-  name: string; /** null when the handler addresses code directly and has no version to pin, e.g. a dev server */
-  version: string | null;
-  installedAt: number;
-};
-type PickOptions = {
-  /** untrusted, rendered as text in the picker header */title?: string;
-  multiple?: boolean;
-};
-type InstallOptions = {
-  /** exact version to pin; defaults to the packument's latest dist-tag */version?: string; /** skip the confirm prompt and report the install with a notice instead; the record stays scoped to the calling app */
-  noConfirm?: boolean;
-};
-type ConnectOptions = {
-  /** opaque contract tag delivered to the package's onConnect, e.g. 'stub-source@1' */protocol?: string;
-};
-/** viewport coordinates, the space both the app and the broker frame measure in */
-type SurfaceRect = {
-  x: number;
-  y: number;
-  width: number;
-  height: number;
-};
-/** corner radii in css order: top-left, top-right, bottom-right, bottom-left */
-type Radii = [number, number, number, number];
-type Placement = {
-  /** where the package frame sits, so its own layout gets the full box */rect: SurfaceRect; /** the part of `rect` still visible after the placeholder's scroll ancestors clip it */
-  clip?: SurfaceRect; /** the placeholder's corner radii, so the frame follows a rounded container */
-  radius?: Radii;
-};
-type PackagesErrorCode = 'invalid' | 'not-installed' | 'unaddressable' | 'timeout' | 'unavailable' | 'denied';
-type PackagesFail = {
-  error: PackagesErrorCode;
-  message: string;
-};
-//#endregion
-//#region src/api/packages/host.d.ts
-type MountDescriptor = {
-  /** where to point the iframe: the tenant origin plus the package's path */url: string; /** the tenant origin alone, which is what a `postMessage` to that frame must target */
-  origin: string; /** the version-free identity, echoed to the package in the port message */
-  uri: string;
-  name: string;
-  version: string | null; /** the connecting app, as the BROKER knows it */
-  from: string;
-};
-declare namespace packages_d_exports {
-  export { AppConnectOptions, Connect, ConnectOptions, ConnectPayload, IncomingConnection, IncomingConnectionInfo, InstallOptions, InstalledPackage, MountOptions, MountedPackage, PackageConnection, PackageQuery, PackageResult, PackageView, PackagesError, PackagesErrorCode, PickOptions, Placement, Radii, RawPackageConnection, ShowOptions, SurfaceRect, attach, connect, hide, install, isVisible, list, mount, onConnect, onVisibilityChange, pick, search, show, uninstall };
-}
-type PackagesError = Error & {
-  code: PackagesErrorCode;
-};
-/** Search npm for FKN packages, e.g. `search({ type: 'plugin', id: 'stub' })`. */
-declare const search: (query: PackageQuery) => Promise<PackageResult[]>;
-/** FKN-rendered picker over the same search; resolves the user's selection, already installed. [] on cancel. */
-declare const pick: (query: PackageQuery, options?: PickOptions) => Promise<PackageResult[]>;
-/** Install a package for this app behind an FKN-rendered confirm, or with `{ noConfirm: true }` for a notice instead of a prompt. Resolves null when the user declines. */
-declare const install: (uri: string, options?: InstallOptions) => Promise<InstalledPackage | null>;
-/** The packages installed by this app. */
-declare const list: () => Promise<InstalledPackage[]>;
-/** Uninstall a package from this app; its frames and connections are torn down. */
-declare const uninstall: (uri: string) => Promise<void>;
-type ShowOptions = {
-  /**
-   * A placeholder the package frame is aligned to for as long as the view lives. The frame tracks its
-   * rect every animation frame, is clipped by its scrolling ancestors, and follows its border-radius,
-   * so it reads as inline content even though it renders in FKN's overlay.
-   */
-  element?: HTMLElement; /** an explicit viewport rect, for a caller that tracks placement itself */
-  rect?: SurfaceRect;
-};
-type PackageView = {
-  /** release this view; equivalent to `packages.hide(uri, { element })` */hide: () => void; /** force a re-measure, e.g. right after a layout change the tracker cannot observe */
-  refresh: () => void;
-};
-/**
- * Show an installed, connected package's frame over this page, aligned to `element` (or an explicit
- * `rect`). The package renders its own UI there; the app keeps the space in its own layout. Take it
- * back down with `hide()` on the returned view, or with `packages.hide(uri)`. Throws a PackagesError
- * with code 'not-installed' when the package has not been connected by this app.
- */
-declare const show: (uri: string, options: ShowOptions) => Promise<PackageView>;
-/**
- * Hide a package's frame again, the counterpart to `show()`. Pass the same `element` to release only
- * the view bound to it; with no element every view of this package is released. The connection is
- * untouched, so the package can be shown again.
- */
-declare const hide: (uri: string, options?: ShowOptions) => Promise<void>;
-type PackageConnection<T = unknown> = {
-  /** the package's exposed payload */remote: Remote<T>; /** settles when the package side of the connection dies (uninstall, reload, crash) - reconnect by calling connect() again */
-  closed: Promise<void>; /** the raw channel under `remote`, for direct messaging (osra envelopes ride it too - filter by your own message shape) */
-  port: MessagePort;
-};
-type AppConnectOptions = ConnectOptions & {
-  /** exposed to the package as ITS `remote` */payload?: unknown;
-  signal?: AbortSignal; /** skip the osra handshake and hand back the untouched port - e.g. to transfer it into a worker and attach() there */
-  raw?: boolean;
-};
-type RawPackageConnection = Omit<PackageConnection<never>, 'remote'>;
-type Connect = {
-  <T = unknown>(uri: string, options?: AppConnectOptions & {
-    raw?: false;
-  }): Promise<PackageConnection<T>>;
-  (uri: string, options: AppConnectOptions & {
-    raw: true;
-  }): Promise<RawPackageConnection>;
-};
-/** Connect to an installed package. Throws a PackagesError with code 'not-installed' when it is not. */
-declare const connect: Connect;
-type MountOptions = AppConnectOptions & {
-  /**
-   * the iframe the package is loaded into. YOU create it and YOU own it: its attributes, its styles and
-   * its place in your layout are yours, and `mount` only navigates it.
-   *
-   * Set `allow` yourself for anything the package needs delegated, e.g. `allow="fullscreen; autoplay"`.
-   * Permissions policy is not inherited, so a capability this frame is not granted cannot be recovered
-   * by the package or by anything it nests inside itself.
-   */
-  iframe: HTMLIFrameElement;
-};
-type MountedPackage<T = unknown> = PackageConnection<T> & {
-  /** the iframe you passed in, unchanged apart from its `src` */frame: HTMLIFrameElement; /** blank the frame and settle `closed`; the element stays in your layout because it is yours */
-  unmount: () => void;
-};
-/**
- * Load a package into an iframe of YOUR OWN and connect to it, instead of positioning a frame the broker
- * owns and clipping the overlay to it the way `show()` does.
- *
- * You pass the iframe, the same way `cloud.attachFrame` takes one. It lays out, scrolls, stacks and
- * fullscreens with the rest of your page, there is no geometry to translate, and every attribute on it
- * stays exactly as you set it: `mount` reads `sandbox` and `allow` to check the package can boot, then
- * writes nothing but `src`. The package still gets its own origin and its own broker connection.
- *
- * Grant capabilities through the iframe's own `allow`, before calling this. Permissions policy is read
- * at navigation and is not inherited, so it cannot be added afterwards on the frame handed back.
- *
- * Needs a package built against this version of the lib: an older one only accepts a port from fkn.app.
- */
-declare const mount: <T = unknown>(uri: string, options: MountOptions) => Promise<MountedPackage<T>>;
-/** Run this end of an already-brokered connection port, e.g. after transferring it into a worker. */
-declare const attach: <T = unknown>(port: MessagePort, payload?: unknown, options?: {
-  signal?: AbortSignal;
-}) => Promise<Remote<T>>;
-type IncomingConnectionInfo = {
-  /** the connecting app's identity: its package uri when it runs on a sandbox origin, else its page origin */from: string; /** the contract tag the app passed to connect(), e.g. 'stub-source@1' */
-  protocol: string | null; /** this package's normalized uri per the connecting app's install record, e.g. 'npm:@banou/stub-source-example' */
-  uri: string; /** this package's npm name */
-  name: string; /** the exact version this frame runs - the pin is encoded into the sandbox origin, immutable per version */
-  version: string;
-};
-type IncomingConnection<T = unknown> = IncomingConnectionInfo & PackageConnection<T>;
-/** produces the payload exposed to a connecting app - called once per incoming connection */
-type ConnectPayload = (info: IncomingConnectionInfo) => unknown;
-/**
- * Serve connections from apps that installed this package. The first argument is called once per
- * incoming connection with the connection info and returns the payload exposed to that app (its
- * `remote`). The latest registration receives new connections; existing connections are unaffected.
- */
-declare const onConnect: <T = unknown>(createPayload: ConnectPayload, handler?: (connection: IncomingConnection<T>) => void) => {
-  unsubscribe: () => void;
-};
-/** True while a host app is showing this package's frame. Packages start hidden. */
-declare const isVisible: () => boolean;
-/**
- * Observe whether a host app is showing this package's frame, so it can render its UI only while on
- * screen. The handler is called immediately with the current state, and on every change after.
- */
-declare const onVisibilityChange: (handler: (visible: boolean) => void) => {
-  unsubscribe: () => void;
-};
-//#endregion
-export { InstalledPackage as A, pick as C, MountDescriptor as D, uninstall as E, PickOptions as F, Placement as I, Radii as L, PackageResult as M, PackagesErrorCode as N, ConnectOptions as O, PackagesFail as P, SurfaceRect as R, packages_d_exports as S, show as T, isVisible as _, IncomingConnectionInfo as a, onConnect as b, PackageConnection as c, RawPackageConnection as d, ShowOptions as f, install as g, hide as h, IncomingConnection as i, PackageQuery as j, InstallOptions as k, PackageView as l, connect as m, Connect as n, MountOptions as o, attach as p, ConnectPayload as r, MountedPackage as s, AppConnectOptions as t, PackagesError as u, list as v, search as w, onVisibilityChange as x, mount as y, Caller as z };

package/storage-qxXFLgTM.d.ts

@@ -1,44 +0,0 @@
-//#region src/api/storage.d.ts
-type StorageEntry = {
-  path: string;
-  size: number;
-  contentType: string | null;
-  updatedAt: string;
-  encryption: string | null;
-};
-type StorageQuota = {
-  usedBytes: number;
-  limitBytes: number;
-  remaining: number;
-  objects: number;
-  maxObjects: number;
-};
-type WriteData = ArrayBuffer | Uint8Array | string;
-type StorageReadResult = {
-  bytes: Uint8Array;
-  encryption: string | null;
-  appOrigin: string;
-};
-type KeyState = {
-  keyEpoch: number | null;
-  keyFingerprint: string | null;
-  storageEncrypted: boolean;
-};
-/**
- * "There is no object at this path", as a thing a caller can TEST rather than parse.
- *
- * osra's error boxer ships name, message, stack and cause ONLY, so this code survives same-realm
- * hops but NOT the SharedWorker boundary; the message fallback in src/lib/storage.ts's rethrow is
- * what carries absence across that hop and re-mints the coded error for apps. The message does not
- * survive being reworded, which is the problem this exists to end: absence arrives in two
- * completely different sentences depending on which half of the read failed, and every consumer
- * was left regex-matching both. Ripple got one of them and missed the other, and a library quietly
- * went un-backed-up for a day because a missing backup read as a transient error.
- */
-declare const STORAGE_NOT_FOUND = "FKN_STORAGE_NOT_FOUND";
-type SealedGeneration = {
-  epoch: number;
-  fingerprint: string;
-};
-//#endregion
-export { StorageQuota as a, StorageEntry as i, STORAGE_NOT_FOUND as n, StorageReadResult as o, SealedGeneration as r, WriteData as s, KeyState as t };

package/storage-xAeRQQiz.cjs

@@ -1 +0,0 @@
-const e=require("./rolldown-runtime-BIInC43l.cjs"),t=require("./api-C-TpWHAU.cjs");var n=`FKN_STORAGE_NOT_FOUND`,r=e.t({StorageLockedError:()=>i,StorageNotFoundError:()=>a,availability:()=>p,available:()=>c,encryption:()=>y,isNotFound:()=>o,list:()=>m,quota:()=>h,readFile:()=>g,remove:()=>v,unlock:()=>b,writeFile:()=>_}),i=class extends Error{code=`FKN_E2E_LOCKED`;constructor(){super(`storage locked: this account stores encrypted data, unlock it from the FKN card or unlock()`)}},a=class extends Error{code=n;constructor(e=`storage: no object at that path`){super(e)}},o=e=>e?.code===n,s=e=>{throw e instanceof Error&&e.message.startsWith(`fkn:e2e-locked`)?new i:o(e)||e instanceof Error&&(/^not found$/i.test(e.message)||/\(404\)$/.test(e.message))?new a(e.message):e},c=()=>t.t.then(e=>e.cloud.fs.available()).catch(()=>!1),l=8e3,u=1e3,d=!1,f=async()=>{let e=(await t.t).cloud.fs;return typeof e.availability==`function`?e.availability():await e.available()?`connected`:`disconnected`},p=async()=>{let e=d?u:l,t=await new Promise(t=>{let n=setTimeout(()=>t(`timeout`),e);f().then(e=>{clearTimeout(n),t(e)},()=>{clearTimeout(n),t(`unknown`)})});return t===`timeout`?(d=!0,`unknown`):(d=!1,t)},m=()=>t.t.then(e=>e.cloud.fs.list()),h=()=>t.t.then(e=>e.cloud.fs.quota()),g=async e=>{let n=await(await t.t).cloud.fs.readFile(e).catch(s);return new Blob([n])},_=async(e,n,r)=>{let i=await t.t,a=n instanceof Blob?new Uint8Array(await n.arrayBuffer()):n;await i.cloud.fs.writeFile(e,a,r?.contentType??null).catch(s)},v=e=>t.t.then(t=>t.cloud.fs.remove(e)).then(()=>void 0),y=()=>t.t.then(e=>e.cloud.fs.encryption()),b=()=>t.t.then(e=>e.cloud.fs.unlock());Object.defineProperty(exports,"a",{enumerable:!0,get:function(){return o}}),Object.defineProperty(exports,"c",{enumerable:!0,get:function(){return g}}),Object.defineProperty(exports,"d",{enumerable:!0,get:function(){return b}}),Object.defineProperty(exports,"f",{enumerable:!0,get:function(){return _}}),Object.defineProperty(exports,"i",{enumerable:!0,get:function(){return y}}),Object.defineProperty(exports,"l",{enumerable:!0,get:function(){return v}}),Object.defineProperty(exports,"n",{enumerable:!0,get:function(){return a}}),Object.defineProperty(exports,"o",{enumerable:!0,get:function(){return m}}),Object.defineProperty(exports,"p",{enumerable:!0,get:function(){return n}}),Object.defineProperty(exports,"r",{enumerable:!0,get:function(){return p}}),Object.defineProperty(exports,"s",{enumerable:!0,get:function(){return h}}),Object.defineProperty(exports,"t",{enumerable:!0,get:function(){return i}}),Object.defineProperty(exports,"u",{enumerable:!0,get:function(){return r}});

package/utils-QfNXtEhb.cjs

@@ -1 +0,0 @@
-let e=require("ip-address");var t=new TextEncoder;new TextDecoder;var n=`webvpn-udp-port-ack`,r=512*1024,i=t=>e.Address4.isValid(t),a=t=>e.Address6.isValid(t),o=e=>i(e)?4:a(e)?6:0,s=(...e)=>{if(typeof e[0]==`string`)throw Error(`FKN WebVPN does not support IPC connections`);let t=typeof e.at(-1)==`function`?e.at(-1):void 0;return e[0]&&typeof e[0]==`object`?{...e[0],callback:t}:{port:e[0]??0,host:typeof e[1]==`string`?e[1]:void 0,callback:t}},c=(...e)=>{let t=typeof e.at(-1)==`function`?e.at(-1):void 0,n=e[0]??0,r=typeof e[1]==`string`?e[1]:void 0;return typeof e[0]==`object`?{...e[0],address:e[0].address??r,port:e[0].port??n,callback:t}:{address:r,port:n,callback:t}},l=(...e)=>{let t=typeof e.at(-1)==`function`?e.at(-1):void 0,n=e[0];if(typeof e[2]==`number`)return{message:n,hasRange:!0,offset:e[1],length:e[2],port:typeof e[3]==`number`?e[3]:0,address:typeof e[4]==`string`?e[4]:void 0,callback:t};{let r=typeof e[1]==`number`?e[1]:0,i=typeof e[2]==`string`?e[2]:void 0;return{message:n,hasRange:!1,offset:0,length:n.length,port:r,address:i,callback:t}}};new TextEncoder,new TextDecoder,Object.defineProperty(exports,"a",{enumerable:!0,get:function(){return a}}),Object.defineProperty(exports,"c",{enumerable:!0,get:function(){return s}}),Object.defineProperty(exports,"i",{enumerable:!0,get:function(){return i}}),Object.defineProperty(exports,"l",{enumerable:!0,get:function(){return t}}),Object.defineProperty(exports,"n",{enumerable:!0,get:function(){return n}}),Object.defineProperty(exports,"o",{enumerable:!0,get:function(){return c}}),Object.defineProperty(exports,"r",{enumerable:!0,get:function(){return o}}),Object.defineProperty(exports,"s",{enumerable:!0,get:function(){return l}}),Object.defineProperty(exports,"t",{enumerable:!0,get:function(){return r}});