@yodaos-pkg/ink 0.3.0 → 0.6.0

package/dist/index.d.ts

@@ -1,166 +0,0 @@
-export type BundleFileInput = string | Uint8Array | ArrayBuffer | ArrayBufferView;
-
-export type BundleFiles =
-  | Map<string, BundleFileInput>
-  | Array<[string, BundleFileInput]>
-  | Record<string, BundleFileInput>;
-
-export interface InitInkOptions {
-  wasmUrl?: string | URL | Request;
-  moduleOrPath?: RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
-  proxyUrl?: string;
-  targetSearchParam?: string;
-  requestInterceptor?: InkRequestInterceptor;
-}
-
-export interface CreateInkViewOptions {
-  width: number;
-  height: number;
-  scaleFactor?: number;
-  canvas?: HTMLCanvasElement;
-  wasm?: InitInkOptions;
-}
-
-export interface OpenBundleOptions {
-  appId: string;
-  files: BundleFiles;
-  initialPage?: string | null;
-  query?: string | Record<string, unknown> | null;
-}
-
-export interface LoadBundleFromVfsOptions {
-  appId: string;
-  baseUrl: string;
-  fetch?: typeof globalThis.fetch;
-  signal?: AbortSignal;
-  headers?: HeadersInit;
-  requestInterceptor?: InkRequestInterceptor;
-}
-
-export interface OpenFromVfsOptions extends LoadBundleFromVfsOptions {
-  initialPage?: string | null;
-  query?: string | Record<string, unknown> | null;
-}
-
-export interface InkInterceptedRequest {
-  url: string;
-  method: string;
-  headers: Record<string, string>;
-  body: BodyInit | ArrayBuffer | ArrayBufferView | Uint8Array | null;
-  metadata: Record<string, unknown>;
-}
-
-export type InkInterceptedRequestAction =
-  | { action?: 'continue' }
-  | {
-      action: 'rewrite';
-      url?: string;
-      method?: string;
-      headers?: HeadersInit | Record<string, string>;
-      body?: BodyInit | ArrayBuffer | ArrayBufferView | Uint8Array | null;
-    }
-  | {
-      action: 'block';
-      reason?: string;
-    };
-
-export type InkRequestInterceptor = (
-  request: InkInterceptedRequest,
-) => InkInterceptedRequestAction | Promise<InkInterceptedRequestAction>;
-
-export interface ConfigureNetworkOptions {
-  proxyUrl?: string;
-  targetSearchParam?: string;
-  interceptor?: InkRequestInterceptor;
-  clear?: boolean;
-}
-
-export interface VfsManifestEntry {
-  path: string;
-  size?: number;
-  contentType?: string;
-  etag?: string;
-}
-
-export interface VfsManifest {
-  appId: string;
-  files: VfsManifestEntry[];
-}
-
-export interface LoadedVfsBundle {
-  appId: string;
-  manifest: VfsManifest;
-  files: Map<string, Uint8Array>;
-}
-
-export interface BindDomEventsOptions {
-  canvas?: HTMLCanvasElement;
-  keyboardTarget?: EventTarget | null;
-  focusTarget?: HTMLElement | HTMLCanvasElement | null;
-  preventWheelDefault?: boolean;
-}
-
-export declare function initInk(options?: InitInkOptions): Promise<{
-  InkWebView: unknown;
-  getInkVersion: () => string;
-}>;
-
-export declare function getInkVersion(): string;
-
-export declare function normalizeBundleFiles(files: BundleFiles): Map<string, Uint8Array>;
-
-export declare function serializeQuery(
-  query: string | Record<string, unknown> | null | undefined,
-): string | null;
-
-export declare function createProxyUrlResolver(options: {
-  proxyUrl: string;
-  targetSearchParam?: string;
-}): InkRequestInterceptor;
-
-export declare function setInkRequestInterceptor(
-  interceptor: InkRequestInterceptor | null | undefined,
-): void;
-
-export declare function clearInkRequestInterceptor(): void;
-
-export declare function configureNetwork(options?: ConfigureNetworkOptions): void;
-
-export declare function createVfsUrls(input: { baseUrl: string; appId: string }): {
-  manifestUrl: string;
-  fileUrl(filePath: string): string;
-};
-
-export declare function loadBundleFromVfs(
-  options: LoadBundleFromVfsOptions,
-): Promise<LoadedVfsBundle>;
-
-export declare class InkView {
-  static create(options: CreateInkViewOptions): Promise<InkView>;
-  bindCanvas(canvas: HTMLCanvasElement): this;
-  bindDomEvents(options?: BindDomEventsOptions): () => void;
-  openBundle(options: OpenBundleOptions): this;
-  openFromVfs(options: OpenFromVfsOptions): Promise<LoadedVfsBundle>;
-  resize(width: number, height: number, scaleFactor?: number): this;
-  focus(): this;
-  blur(): this;
-  notifyUserInteraction(): this;
-  render(): boolean;
-  requestRender(): this;
-  startRendering(): this;
-  stopRendering(): this;
-  isRunning(): boolean;
-  destroy(): void;
-}
-
-export declare function createInkView(options: CreateInkViewOptions): Promise<InkView>;
-
-export declare function createFrameworkBindings(): {
-  ensureLeadingSlash(path: string): string;
-  initInk: typeof initInk;
-  createInkView: typeof createInkView;
-  configureNetwork: typeof configureNetwork;
-  setInkRequestInterceptor: typeof setInkRequestInterceptor;
-  clearInkRequestInterceptor: typeof clearInkRequestInterceptor;
-  createProxyUrlResolver: typeof createProxyUrlResolver;
-};

package/dist/package.json

@@ -1,20 +0,0 @@
-{
-  "name": "@yodaos-pkg/ink",
-  "version": "0.1.0",
-  "description": "Ink Web SDK for browser rendering and VFS-backed app loading",
-  "type": "module",
-  "main": "index.js",
-  "types": "index.d.ts",
-  "files": [
-    "*"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/jsar-project/ink"
-  },
-  "license": "ISC",
-  "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.com/"
-  }
-}

package/dist/pkg/README.md

@@ -1,34 +0,0 @@
-# ink-web
-
-`ink-web` provides WebAssembly (Wasm) bindings.
-
-## Features
-
-This package compiles the Ink engine into Wasm, enabling it to run in modern web browsers:
-
-- **Wasm Bindings**: Utilizes `wasm-bindgen` to implement interoperability between Rust code and Web APIs.
-- **Web Rendering**: Bridges Ink's drawing instructions to Web Canvas or WebGL.
-
-## Running Locally
-
-1. Build the demo:
-
-```bash
-./build.sh
-```
-
-2. Start the bundled Node static server:
-
-```bash
-npm run dev --prefix playground
-```
-
-3. Open:
-
-```text
-http://localhost:8080
-```
-
-The playground host configures a same-origin `/__proxy` interceptor example for
-external HTTP resources. This proxy behavior is no longer hard-coded inside
-`ink-web`; hosts now opt into request interception explicitly from the SDK side.

package/dist/pkg/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "module"
-}