@marimo-team/marimo-export 0.0.0 → 0.0.2

package/dist/types-D52GHn1Q.d.mts

@@ -0,0 +1,201 @@
+//#region ../portable-json/src/types.d.ts
+type JsonPrimitive = string | number | boolean | null;
+type JsonValue = JsonPrimitive | readonly JsonValue[] | JsonObject;
+interface JsonObject {
+  readonly [key: string]: JsonValue;
+}
+//#endregion
+//#region src/types.d.ts
+declare const NOTEBOOK_EXPORT_ERROR_CODES: readonly ["abort", "asset_invalid", "decode_failed", "integrity_failed", "loader_ambiguous", "loader_invalid", "loader_unavailable", "output_not_found", "output_representation_changed", "export_invalid", "export_noncanonical", "read_failed", "read_limit_exceeded", "state_input_invalid", "state_not_found", "state_unavailable"];
+type ScalarValue = null | boolean | string | number | bigint;
+type NotebookExportErrorCode = (typeof NOTEBOOK_EXPORT_ERROR_CODES)[number];
+interface NotebookExportErrorOptions {
+  readonly cause?: unknown;
+  readonly details?: JsonObject;
+}
+declare class NotebookExportError extends Error {
+  readonly code: NotebookExportErrorCode;
+  readonly details: JsonObject | undefined;
+  readonly cause: unknown;
+  constructor(code: NotebookExportErrorCode, message: string, options?: NotebookExportErrorOptions);
+}
+declare function isNotebookExportError<Value>(value: Value): value is Value & NotebookExportError;
+interface NotebookProvenance {
+  readonly filename: string | null;
+  readonly documentSha256: string;
+}
+interface ProducerProvenance {
+  readonly marimo: string;
+  readonly marimoExport: string;
+  readonly implementationSha256: string;
+}
+interface ControlIndexStep {
+  readonly kind: "index";
+  readonly value: number;
+}
+interface ControlKeyStep {
+  readonly kind: "key";
+  readonly value: string;
+}
+interface ControlElementStep {
+  readonly kind: "element";
+}
+type ControlPathStep = ControlIndexStep | ControlKeyStep | ControlElementStep;
+interface ControlBinding {
+  readonly input: string;
+  readonly path: readonly ControlPathStep[];
+}
+interface Provenance {
+  readonly pythonType: string;
+}
+interface AssetDescriptor {
+  readonly sha256: string;
+  readonly size: number;
+}
+interface ScalarDescriptor {
+  readonly codec: "marimo.scalar.v1";
+  readonly mediaType: "application/vnd.marimo.scalar.v1+json";
+  readonly provenance: Provenance;
+  readonly value: ScalarValue;
+}
+interface JsonDescriptor {
+  readonly codec: "marimo.json.v1";
+  readonly mediaType: "application/vnd.marimo.json.v1+json";
+  readonly provenance: Provenance;
+  readonly value: JsonValue;
+}
+interface MarimoOutputDescriptor {
+  readonly codec: "marimo.output.v1";
+  readonly mediaType: "application/vnd.marimo.output.v1+json";
+  readonly provenance: Provenance;
+  readonly asset: AssetDescriptor;
+}
+interface MarimoCellDescriptor {
+  readonly codec: "marimo.cell.v1";
+  readonly mediaType: "application/vnd.marimo.cell.v1+json";
+  readonly provenance: Provenance;
+  readonly asset: AssetDescriptor;
+}
+interface NumpyDescriptor {
+  readonly codec: "numpy.npy.v1";
+  readonly mediaType: "application/x-npy";
+  readonly provenance: Provenance;
+  readonly asset: AssetDescriptor;
+}
+interface ArrowDescriptor {
+  readonly codec: "apache.arrow.file.v1";
+  readonly mediaType: "application/vnd.apache.arrow.file";
+  readonly provenance: Provenance;
+  readonly asset: AssetDescriptor;
+}
+interface BlobAssetDescriptor {
+  readonly codec: "marimo.blob-asset.msgpack.v1";
+  readonly mediaType: string;
+  readonly filename: string | null;
+  readonly metadata: JsonObject;
+  readonly provenance: Provenance;
+  readonly asset: AssetDescriptor;
+}
+type OutputDescriptor = ScalarDescriptor | JsonDescriptor | MarimoOutputDescriptor | MarimoCellDescriptor | NumpyDescriptor | ArrowDescriptor | BlobAssetDescriptor;
+interface MediaType {
+  readonly raw: string;
+  readonly essence: string;
+  readonly type: string;
+  readonly subtype: string;
+  readonly parameters: ReadonlyMap<string, string>;
+}
+interface BlobAsset {
+  readonly data: Uint8Array;
+  readonly mediaType: MediaType;
+  readonly filename: string | null;
+  readonly metadata: JsonObject;
+}
+interface OutputPayloadMap {
+  readonly "marimo.scalar.v1": ScalarValue;
+  readonly "marimo.json.v1": JsonValue;
+  readonly "marimo.output.v1": Uint8Array;
+  readonly "marimo.cell.v1": Uint8Array;
+  readonly "numpy.npy.v1": Uint8Array;
+  readonly "apache.arrow.file.v1": Uint8Array;
+  readonly "marimo.blob-asset.msgpack.v1": BlobAsset;
+}
+type OutputCodec = keyof OutputPayloadMap;
+type DescriptorFor<C extends OutputCodec> = C extends "marimo.scalar.v1" ? ScalarDescriptor : C extends "marimo.json.v1" ? JsonDescriptor : C extends "marimo.output.v1" ? MarimoOutputDescriptor : C extends "marimo.cell.v1" ? MarimoCellDescriptor : C extends "numpy.npy.v1" ? NumpyDescriptor : C extends "apache.arrow.file.v1" ? ArrowDescriptor : C extends "marimo.blob-asset.msgpack.v1" ? BlobAssetDescriptor : never;
+interface OutputLoader<C extends OutputCodec, T> {
+  readonly codec: C;
+  accepts(descriptor: DescriptorFor<C>, mediaType: MediaType): boolean;
+  load(input: {
+    readonly descriptor: DescriptorFor<C>;
+    readonly mediaType: MediaType;
+    readonly payload: OutputPayloadMap[C];
+    readonly signal?: AbortSignal;
+  }): T | Promise<T>;
+}
+type AnyOutputLoader = { [C in OutputCodec]: OutputLoader<C, unknown>; }[OutputCodec];
+type BlobAssetLoader<T> = OutputLoader<"marimo.blob-asset.msgpack.v1", T>;
+interface BlobAssetLoadInput {
+  readonly descriptor: BlobAssetDescriptor;
+  readonly mediaType: MediaType;
+  readonly payload: BlobAsset;
+  readonly signal?: AbortSignal;
+}
+interface OpenExportOptions {
+  readonly fetch?: typeof globalThis.fetch;
+  readonly signal?: AbortSignal;
+}
+interface LoadOptions {
+  readonly signal?: AbortSignal;
+  readonly maxBytes?: number;
+}
+interface VerifyOptions extends LoadOptions {
+  readonly maxTotalBytes?: number;
+}
+interface VerificationResult {
+  readonly states: number;
+  readonly outputs: number;
+  readonly assets: number;
+  readonly bytesVerified: number;
+}
+interface NotebookExport {
+  readonly base: URL;
+  readonly identity: string;
+  readonly specSha256: string;
+  readonly defaultState: ExportState;
+  readonly notebook: NotebookProvenance;
+  readonly producer: ProducerProvenance;
+  readonly inputNames: readonly string[];
+  readonly controlBindings: Readonly<Record<string, ControlBinding>>;
+  readonly outputNames: readonly string[];
+  states(): readonly ExportState[];
+  state(alias: string): ExportState;
+  resolve(inputs: JsonObject): ExportState;
+  verify(options?: VerifyOptions): Promise<VerificationResult>;
+}
+interface ExportState {
+  readonly notebookExport: NotebookExport;
+  readonly fingerprint: string;
+  readonly aliases: readonly string[];
+  readonly inputs: JsonObject;
+  outputs(): readonly ExportOutput[];
+  output(name: string): ExportOutput;
+  resolve(patch: JsonObject): ExportState;
+}
+interface ExportOutput {
+  readonly state: ExportState;
+  readonly name: string;
+  readonly codec: OutputCodec;
+  readonly mediaType: MediaType;
+  readonly descriptor: OutputDescriptor;
+  load<C extends OutputCodec, T>(loader: OutputLoader<C, T>, options?: LoadOptions): Promise<T>;
+}
+interface MountedView {
+  dispose(): void | Promise<void>;
+}
+interface MountOptions {
+  readonly signal?: AbortSignal;
+}
+interface MountableValue {
+  mount(element: HTMLElement, options?: MountOptions): Promise<MountedView>;
+}
+//#endregion
+export { OutputDescriptor as A, JsonObject as B, NotebookExport as C, NumpyDescriptor as D, NotebookProvenance as E, ScalarDescriptor as F, JsonValue as H, ScalarValue as I, VerificationResult as L, OutputPayloadMap as M, ProducerProvenance as N, OpenExportOptions as O, Provenance as P, VerifyOptions as R, MountedView as S, NotebookExportErrorCode as T, JsonPrimitive as V, LoadOptions as _, BlobAssetDescriptor as a, MediaType as b, ControlBinding as c, ControlKeyStep as d, ControlPathStep as f, JsonDescriptor as g, ExportState as h, BlobAsset as i, OutputLoader as j, OutputCodec as k, ControlElementStep as l, ExportOutput as m, ArrowDescriptor as n, BlobAssetLoadInput as o, DescriptorFor as p, AssetDescriptor as r, BlobAssetLoader as s, AnyOutputLoader as t, ControlIndexStep as u, MarimoCellDescriptor as v, NotebookExportError as w, MountableValue as x, MarimoOutputDescriptor as y, isNotebookExportError as z };

package/dist/utf8-DI-jI2Nm.mjs

@@ -0,0 +1,17 @@
+//#region src/loader/utf8.ts
+const decoder = new TextDecoder("utf-8", {
+	fatal: true,
+	ignoreBOM: true
+});
+const decodeUtf8Blob = ({ payload, signal }) => {
+	signal?.throwIfAborted();
+	const value = decoder.decode(payload.data);
+	signal?.throwIfAborted();
+	return value;
+};
+const hasUtf8Charset = (mediaType) => {
+	const charset = mediaType.parameters.get("charset");
+	return charset === void 0 || charset.toLowerCase() === "utf-8" || charset.toLowerCase() === "utf8";
+};
+//#endregion
+export { hasUtf8Charset as n, decodeUtf8Blob as t };

package/package.json

@@ -1,14 +1,121 @@
 {
   "name": "@marimo-team/marimo-export",
-  "version": "0.0.0",
-  "description": "Placeholder for @marimo-team/marimo-export. Real releases coming soon.",
+  "version": "0.0.2",
+  "description": "Load precomputed marimo notebook results in browser applications",
+  "homepage": "https://marimo-team.github.io/marimo-export/",
+  "bugs": {
+    "url": "https://github.com/marimo-team/marimo-export/issues"
+  },
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/marimo-team/marimo-export.git"
+    "url": "git+https://github.com/marimo-team/marimo-export.git",
+    "directory": "packages/browser"
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs"
+    },
+    "./prepared": {
+      "types": "./dist/prepared/index.d.mts",
+      "import": "./dist/prepared/index.mjs"
+    },
+    "./loader/anywidget": {
+      "types": "./dist/loader/anywidget.d.mts",
+      "import": "./dist/loader/anywidget.mjs"
+    },
+    "./loader/arrow": {
+      "types": "./dist/loader/arrow.d.mts",
+      "import": "./dist/loader/arrow.mjs"
+    },
+    "./loader/html": {
+      "types": "./dist/loader/html.d.mts",
+      "import": "./dist/loader/html.mjs"
+    },
+    "./loader/json": {
+      "types": "./dist/loader/json.d.mts",
+      "import": "./dist/loader/json.mjs"
+    },
+    "./loader/marimo-cell": {
+      "types": "./dist/loader/marimo-cell.d.mts",
+      "import": "./dist/loader/marimo-cell.mjs"
+    },
+    "./loader/marimo-output": {
+      "types": "./dist/loader/marimo-output.d.mts",
+      "import": "./dist/loader/marimo-output.mjs"
+    },
+    "./loader/numpy": {
+      "types": "./dist/loader/numpy.d.mts",
+      "import": "./dist/loader/numpy.mjs"
+    },
+    "./loader/parquet": {
+      "types": "./dist/loader/parquet.d.mts",
+      "import": "./dist/loader/parquet.mjs"
+    },
+    "./loader/text": {
+      "types": "./dist/loader/text.d.mts",
+      "import": "./dist/loader/text.mjs"
+    },
+    "./loader/vegalite": {
+      "types": "./dist/loader/vegalite.d.mts",
+      "import": "./dist/loader/vegalite.mjs"
+    },
+    "./package.json": "./package.json"
   },
-  "homepage": "https://marimo.io",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@msgpack/msgpack": "^3.1.3"
+  },
+  "devDependencies": {
+    "@anywidget/types": "^0.4.0",
+    "@marimo-team/portable-json": "0.0.0",
+    "@types/node": "^24.13.3",
+    "@uwdata/flechette": "^2.5.0",
+    "hyparquet": "^1.29.2",
+    "lz4js": "0.2.0",
+    "typescript": "^6.0.3",
+    "vega-embed": "^7.2.0",
+    "vite-plus": "0.3.0"
+  },
+  "peerDependencies": {
+    "@anywidget/types": "^0.4.0",
+    "@uwdata/flechette": "^2.5.0",
+    "hyparquet": "^1.26.2",
+    "lz4js": "0.2.0",
+    "vega-embed": "^7.1.0"
+  },
+  "peerDependenciesMeta": {
+    "@anywidget/types": {
+      "optional": true
+    },
+    "@uwdata/flechette": {
+      "optional": true
+    },
+    "hyparquet": {
+      "optional": true
+    },
+    "lz4js": {
+      "optional": true
+    },
+    "vega-embed": {
+      "optional": true
+    }
+  },
+  "scripts": {
+    "build": "vp pack",
+    "check": "vp check",
+    "test": "vp test",
+    "test:package": "vp pack && pnpm run test:workspace && node tests/packed-install.mjs",
+    "test:workspace": "node tests/clean-workspace.mjs",
+    "typecheck": "tsc --noEmit"
   }
-}
+}