@yodaos-pkg/aix 0.2.1 → 0.3.0

package/README.md

@@ -1,50 +1,149 @@
-# @yodaos-jsar/aix
+# @yodaos-pkg/aix
 
-`@yodaos-jsar/aix` is a library for reading and managing **.aix** (AI eXecutable) packages in the web environment using WASM. The `.aix` format is an extension of the [Open Agent Format (OAF)](https://openagentformat.com/spec.html), designed to package AI agents with rich UI/UX capabilities powered by Ink Mini Programs.
+`@yodaos-pkg/aix` is a library for reading and managing **.aix** (AI eXecutable) packages in the web environment using WASM. The `.aix` format is an extension of the [Open Agent Format (OAF)](https://openagentformat.com/spec.html), designed to package AI agents with rich UI/UX capabilities powered by Ink Mini Programs.
 
-## Library Usage (JS/TS)
+## Installation
+
+```bash
+npm install @yodaos-pkg/aix
+```
+
+## Quick Start
 
-You can use this library in your JavaScript or TypeScript project to read `.aix` files.
+Here is a quick example of how to load an `.aix` package:
 
 ```typescript
-import { AIX } from '@yodaos-jsar/aix';
+import { AIX } from '@yodaos-pkg/aix';
+
+// Option 1: Load from a URL
+async function fromUrl() {
+  const response = await fetch('https://example.com/my-agent.aix');
+  const buffer = await response.arrayBuffer();
+  const aix = await AIX.From(new Uint8Array(buffer));
+  console.log('App Title:', aix.getTitle());
+}
+
+// Option 2: Load from a File object (e.g., from an <input type="file">)
+async function fromFile(file: File) {
+  const aix = await AIX.From(file);
+  console.log('App Title:', aix.getTitle());
+}
+```
+
+## API Reference
+
+### `AIX` Class
+
+The main class to interact with an AIX package.
 
-// Load the .aix file as a Uint8Array
-const response = await fetch('path/to/your.aix');
-const buffer = await response.arrayBuffer();
-const data = new Uint8Array(buffer);
+#### `static async From(data: Uint8Array | File): Promise<AIX>`
+Initializes the WASM module and creates an AIX instance from the given `.aix` file content. It supports both `Uint8Array` and the standard Web `File` object.
+```typescript
+// From Uint8Array
+const aix = await AIX.From(new Uint8Array(buffer));
 
-// Create an AIX instance
-const aix = await AIX.from(data);
+// From File (Web API)
+const aix = await AIX.From(file);
+```
 
-// List files
+#### `list(): AixEntry[]`
+Lists all files in the AIX package.
+```typescript
 const files = aix.list();
-console.log('Files in package:', files);
+// [{ name: "app.json", size: 123, compressed_size: 45 }, ...]
+```
 
-// Get version metadata
+#### `readFile(name: string): Uint8Array`
+Reads the raw content of a specific file from the package.
+```typescript
+const content = aix.readFile('app.json');
+const text = new TextDecoder().decode(content);
+```
+
+#### `getVersion(): string | undefined`
+Returns the version metadata from the `VERSION` file in the package.
+```typescript
 const version = aix.getVersion();
-console.log('Package version:', version);
+```
 
-// Read a specific file
-const appJson = aix.readFile('app.json');
-const content = new TextDecoder().decode(appJson);
-console.log('app.json content:', JSON.parse(content));
+#### `getTitle(): string | undefined`
+Extracts the navigation bar title from the `app.json`.
+```typescript
+const title = aix.getTitle();
 ```
 
-## Installation
+#### `getPages(): PageInfo[]`
+Returns information about all pages defined in the package, including their paths, titles, and data schemas.
+```typescript
+const pages = aix.getPages();
+/*
+[{
+  name: "pages/index/index",
+  title: "Home",
+  data_schema: { ... }
+}]
+*/
+```
 
-```bash
-npm install @yodaos-jsar/aix
+#### `getTools(): Tool[]`
+Generates a list of OpenAI-compatible tool definitions based on the pages and their schemas.
+```typescript
+const tools = aix.getTools();
+/*
+[{
+  type: "function",
+  function: {
+    name: "pages_index_index",
+    description: "Home",
+    parameters: { ... }
+  }
+}]
+*/
+```
+
+## Data Types
+
+### `AixEntry`
+```typescript
+interface AixEntry {
+  name: string;
+  size: number;
+  compressed_size: number;
+}
+```
+
+### `PageInfo`
+```typescript
+interface PageInfo {
+  name: string;
+  title?: string;
+  data_schema: any;
+}
+```
+
+### `Tool`
+OpenAI compatible tool format.
+```typescript
+interface Tool {
+  type: string;
+  function: {
+    name: string;
+    description?: string;
+    parameters: any;
+  };
+}
 ```
 
 ## Build
 
-To build the WASM and TS code:
+To build the library for distribution:
 
 ```bash
 npm run build
 ```
 
-## Core Library
+The output will be generated in the `dist` directory, including WASM binaries and TypeScript definitions.
+
+## License
 
-The core Rust logic is provided by the [aix](../aix) package.
+MIT

package/index.d.ts

@@ -21,9 +21,9 @@ export declare class AIX {
     private constructor();
     /**
      * Initialize the WASM module and create an AIX instance from the given data.
-     * @param data The .aix file content as Uint8Array
+     * @param data The .aix file content as Uint8Array or File
      */
-    static from(data: Uint8Array): Promise<AIX>;
+    static From(data: Uint8Array | File): Promise<AIX>;
     /**
      * List all files in the AIX package.
      */

package/index.js

@@ -5,11 +5,19 @@ export class AIX {
     }
     /**
      * Initialize the WASM module and create an AIX instance from the given data.
-     * @param data The .aix file content as Uint8Array
+     * @param data The .aix file content as Uint8Array or File
      */
-    static async from(data) {
+    static async From(data) {
         await init();
-        const reader = new AixReaderWasm(data);
+        let buffer;
+        if (data instanceof Uint8Array) {
+            buffer = data;
+        }
+        else {
+            const arrayBuffer = await data.arrayBuffer();
+            buffer = new Uint8Array(arrayBuffer);
+        }
+        const reader = new AixReaderWasm(buffer);
         return new AIX(reader);
     }
     /**

package/jsr.json

@@ -1,5 +1,5 @@
 {
   "name": "@yodaos-pkg/aix",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "exports": "./index.js"
 }

package/package.json

@@ -1,16 +1,13 @@
 {
   "name": "@yodaos-pkg/aix",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Ink AIX Package Reader",
   "main": "index.js",
   "types": "index.d.ts",
   "files": [
     "*"
   ],
-  "dependencies": {
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0"
-  },
+  "dependencies": {},
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"

package/pkg/README.md

@@ -1,50 +1,149 @@
-# @yodaos-jsar/aix
+# @yodaos-pkg/aix
 
-`@yodaos-jsar/aix` is a library for reading and managing **.aix** (AI eXecutable) packages in the web environment using WASM. The `.aix` format is an extension of the [Open Agent Format (OAF)](https://openagentformat.com/spec.html), designed to package AI agents with rich UI/UX capabilities powered by Ink Mini Programs.
+`@yodaos-pkg/aix` is a library for reading and managing **.aix** (AI eXecutable) packages in the web environment using WASM. The `.aix` format is an extension of the [Open Agent Format (OAF)](https://openagentformat.com/spec.html), designed to package AI agents with rich UI/UX capabilities powered by Ink Mini Programs.
 
-## Library Usage (JS/TS)
+## Installation
+
+```bash
+npm install @yodaos-pkg/aix
+```
+
+## Quick Start
 
-You can use this library in your JavaScript or TypeScript project to read `.aix` files.
+Here is a quick example of how to load an `.aix` package:
 
 ```typescript
-import { AIX } from '@yodaos-jsar/aix';
+import { AIX } from '@yodaos-pkg/aix';
+
+// Option 1: Load from a URL
+async function fromUrl() {
+  const response = await fetch('https://example.com/my-agent.aix');
+  const buffer = await response.arrayBuffer();
+  const aix = await AIX.From(new Uint8Array(buffer));
+  console.log('App Title:', aix.getTitle());
+}
+
+// Option 2: Load from a File object (e.g., from an <input type="file">)
+async function fromFile(file: File) {
+  const aix = await AIX.From(file);
+  console.log('App Title:', aix.getTitle());
+}
+```
+
+## API Reference
+
+### `AIX` Class
+
+The main class to interact with an AIX package.
 
-// Load the .aix file as a Uint8Array
-const response = await fetch('path/to/your.aix');
-const buffer = await response.arrayBuffer();
-const data = new Uint8Array(buffer);
+#### `static async From(data: Uint8Array | File): Promise<AIX>`
+Initializes the WASM module and creates an AIX instance from the given `.aix` file content. It supports both `Uint8Array` and the standard Web `File` object.
+```typescript
+// From Uint8Array
+const aix = await AIX.From(new Uint8Array(buffer));
 
-// Create an AIX instance
-const aix = await AIX.from(data);
+// From File (Web API)
+const aix = await AIX.From(file);
+```
 
-// List files
+#### `list(): AixEntry[]`
+Lists all files in the AIX package.
+```typescript
 const files = aix.list();
-console.log('Files in package:', files);
+// [{ name: "app.json", size: 123, compressed_size: 45 }, ...]
+```
 
-// Get version metadata
+#### `readFile(name: string): Uint8Array`
+Reads the raw content of a specific file from the package.
+```typescript
+const content = aix.readFile('app.json');
+const text = new TextDecoder().decode(content);
+```
+
+#### `getVersion(): string | undefined`
+Returns the version metadata from the `VERSION` file in the package.
+```typescript
 const version = aix.getVersion();
-console.log('Package version:', version);
+```
 
-// Read a specific file
-const appJson = aix.readFile('app.json');
-const content = new TextDecoder().decode(appJson);
-console.log('app.json content:', JSON.parse(content));
+#### `getTitle(): string | undefined`
+Extracts the navigation bar title from the `app.json`.
+```typescript
+const title = aix.getTitle();
 ```
 
-## Installation
+#### `getPages(): PageInfo[]`
+Returns information about all pages defined in the package, including their paths, titles, and data schemas.
+```typescript
+const pages = aix.getPages();
+/*
+[{
+  name: "pages/index/index",
+  title: "Home",
+  data_schema: { ... }
+}]
+*/
+```
 
-```bash
-npm install @yodaos-jsar/aix
+#### `getTools(): Tool[]`
+Generates a list of OpenAI-compatible tool definitions based on the pages and their schemas.
+```typescript
+const tools = aix.getTools();
+/*
+[{
+  type: "function",
+  function: {
+    name: "pages_index_index",
+    description: "Home",
+    parameters: { ... }
+  }
+}]
+*/
+```
+
+## Data Types
+
+### `AixEntry`
+```typescript
+interface AixEntry {
+  name: string;
+  size: number;
+  compressed_size: number;
+}
+```
+
+### `PageInfo`
+```typescript
+interface PageInfo {
+  name: string;
+  title?: string;
+  data_schema: any;
+}
+```
+
+### `Tool`
+OpenAI compatible tool format.
+```typescript
+interface Tool {
+  type: string;
+  function: {
+    name: string;
+    description?: string;
+    parameters: any;
+  };
+}
 ```
 
 ## Build
 
-To build the WASM and TS code:
+To build the library for distribution:
 
 ```bash
 npm run build
 ```
 
-## Core Library
+The output will be generated in the `dist` directory, including WASM binaries and TypeScript definitions.
+
+## License
 
-The core Rust logic is provided by the [aix](../aix) package.
+MIT

package/pkg/package.json

@@ -1,6 +1,6 @@
 {
   "name": "aix-web",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "files": [
     "aix_web_bg.wasm",
     "aix_web.js",