epos 1.30.0 → 1.31.0

package/dist/epos.d.ts

@@ -1,3 +1,4 @@
+import { Spec } from 'epos-spec';
 import * as mobx from 'mobx';
 import * as mobxReactLite from 'mobx-react-lite';
 import * as react from 'react';
@@ -15,11 +16,15 @@ type ModelClass = new (...args: any[]) => any;
 type Model = InstanceType<ModelClass>;
 type Initial<T extends Obj | Model> = T | (() => T);
 type Attrs = Record<string, string | number>;
+type Mode = 'development' | 'production';
+type Sources = {
+    [path: string]: string;
+};
+type Assets = {
+    [path: string]: Blob;
+};
 type FnArgsOrArr<T> = T extends Fn ? Parameters<T> : Arr;
 type FnResultOrValue<T> = T extends Fn ? ReturnType<T> : T;
-type StateConfig = {
-    allowMissingModels?: boolean | string[];
-};
 type ReqInit = {
     body: RequestInit['body'];
     cache: RequestInit['cache'];
@@ -63,6 +68,12 @@ type Storage = {
     /** Clear the storage. Deletes all keys and storage itself. */
     clear(): Promise<void>;
 };
+type Bundle = {
+    mode: Mode;
+    spec: Spec;
+    sources: Sources;
+    assets: Assets;
+};
 interface Epos {
     fetch: (url: string | URL, init?: ReqInit) => Promise<Res>;
     browser: Chrome;
@@ -77,17 +88,17 @@ interface Epos {
         /** Listen for an event once. */
         once<T extends Fn>(name: string, callback: T, thisArg?: unknown): void;
         /** Send an event to all remote listeners (local listeners are ignored). */
-        send<T = unknown>(name: string, ...args: FnArgsOrArr<T>): Promise<FnResultOrValue<T>>;
+        send<T = unknown>(name: string, ...args: FnArgsOrArr<T>): Promise<FnResultOrValue<T> | null>;
         /** Emit event locally (calls local listeners only). */
-        emit<T = unknown>(name: string, ...args: FnArgsOrArr<T>): Promise<FnResultOrValue<T>>;
+        emit<T = unknown>(name: string, ...args: FnArgsOrArr<T>): Promise<FnResultOrValue<T> | null>;
         setSignal(name: string, value?: unknown): void;
-        waitSignal<T = unknown>(name: string, timeout?: number): Promise<T>;
+        waitSignal<T = unknown>(name: string, timeout?: number): Promise<T | null>;
     };
     state: {
         /** Connect state. */
         connect: {
-            <T extends Obj | Model>(initial?: Initial<T>, versioner?: Versioner): Promise<T>;
-            <T extends Obj | Model>(name?: string, initial?: Initial<T>, versioner?: Versioner): Promise<T>;
+            <T extends Obj | Model = Obj>(initial?: Initial<T>, versioner?: Versioner): Promise<T>;
+            <T extends Obj | Model = Obj>(name?: string, initial?: Initial<T>, versioner?: Versioner): Promise<T>;
         };
         /** Disconnect state. */
         disconnect(name?: string): void;
@@ -152,7 +163,7 @@ interface Epos {
         }[]>;
     };
     asset: {
-        /** Load either all assets to the memory or a specific asset by its path. */
+        /** Load specified asset to memory. Load all assets if no path is provided. */
         load: {
             /** Load all assets. */
             (): Promise<void>;
@@ -170,7 +181,7 @@ interface Epos {
         url(path: string): string;
         /** Get asset as Blob. */
         get(path: string): Promise<Blob | null>;
-        /** Get list of all available asset files. */
+        /** Get list of all available assets. */
         list(filter?: {
             loaded?: boolean;
         }): {
@@ -179,6 +190,7 @@ interface Epos {
         }[];
     };
     env: {
+        mode: Mode;
         tabId: number;
         project: string;
         isPopup: boolean;
@@ -201,10 +213,18 @@ interface Epos {
         readonly stateModelStrict: symbol;
         readonly stateModelVersioner: symbol;
     };
+    installer: {
+        install: {
+            (url: string, mode?: Mode): Promise<void>;
+            (bundle: Bundle): Promise<void>;
+        };
+        remove(name: string): Promise<void>;
+    };
+    engine: any;
 }
 declare global {
     var epos: Epos;
 }
 declare const _epos: Epos;
 
-export { type Arr, type Attrs, type Epos, type Fn, type FnArgsOrArr, type FnResultOrValue, type Initial, type Model, type ModelClass, type Obj, type ReqInit, type Res, type StateConfig, type Storage, type Versioner, _epos as default, _epos as epos };
+export { type Arr, type Assets, type Attrs, type Bundle, type Epos, type Fn, type FnArgsOrArr, type FnResultOrValue, type Initial, type Mode, type Model, type ModelClass, type Obj, type ReqInit, type Res, type Sources, type Storage, type Versioner, _epos as default, _epos as epos };

package/package.json

@@ -1,47 +1,38 @@
 {
   "name": "epos",
-  "version": "1.30.0",
+  "version": "1.31.0",
   "type": "module",
   "license": "MIT",
   "author": "imkost",
   "description": "",
   "keywords": [],
   "scripts": {
-    "dev": "tsup --config ../../tsup.config.ts --watch --dts-resolve",
-    "build": "tsup --config ../../tsup.config.ts --dts-resolve",
+    "dev": "tsup --config ../../tsup.config.ts --watch",
+    "build": "tsup --config ../../tsup.config.ts",
     "lint": "tsc --noEmit",
     "release": "sh -c 'npm version ${1:-minor} && npm run build && npm publish' --"
   },
   "exports": {
-    ".": {
-      "source": "./src/epos.ts",
-      "import": "./dist/epos.js",
-      "types": "./dist/epos.d.ts"
-    },
-    "./vite": {
-      "source": "./src/epos-vite.ts",
-      "import": "./dist/epos-vite.js",
-      "types": "./dist/epos-vite.d.ts"
-    },
-    "./vite/ts": {
-      "import": "./src/epos-vite.ts"
-    }
+    ".": "./dist/epos.js",
+    "./vite": "./dist/epos-vite.js",
+    "./vite/ts": "./src/epos-vite.ts"
   },
   "files": [
-    "src",
-    "dist"
+    "dist",
+    "src"
   ],
   "dependencies": {
     "@parcel/watcher": "^2.5.1",
     "@types/chrome": "^0.1.32",
     "@types/react": "^19.2.7",
     "@types/react-dom": "^19.2.3",
+    "epos-spec": "^1.0.0",
     "mobx": "^6.15.0",
     "mobx-react-lite": "^4.1.1",
     "portfinder": "^1.0.38",
     "react": "^19.2.3",
     "ws": "^8.18.3",
-    "yjs": "^13.6.27"
+    "yjs": "^13.6.28"
   },
   "devDependencies": {
     "vite": "^7.3.0"

package/src/epos.ts

@@ -1,3 +1,4 @@
+import { Spec } from 'epos-spec'
 import type * as mobx from 'mobx'
 import type * as mobxReactLite from 'mobx-react-lite'
 import type * as react from 'react'
@@ -15,13 +16,12 @@ export type ModelClass = new (...args: any[]) => any
 export type Model = InstanceType<ModelClass>
 export type Initial<T extends Obj | Model> = T | (() => T)
 export type Attrs = Record<string, string | number>
+export type Mode = 'development' | 'production'
+export type Sources = { [path: string]: string }
+export type Assets = { [path: string]: Blob }
 export type FnArgsOrArr<T> = T extends Fn ? Parameters<T> : Arr
 export type FnResultOrValue<T> = T extends Fn ? ReturnType<T> : T
 
-export type StateConfig = {
-  allowMissingModels?: boolean | string[]
-}
-
 export type ReqInit = {
   body: RequestInit['body']
   cache: RequestInit['cache']
@@ -68,6 +68,13 @@ export type Storage = {
   clear(): Promise<void>
 }
 
+export type Bundle = {
+  mode: Mode
+  spec: Spec
+  sources: Sources
+  assets: Assets
+}
+
 export interface Epos {
   // General
   fetch: (url: string | URL, init?: ReqInit) => Promise<Res>
@@ -85,19 +92,19 @@ export interface Epos {
     /** Listen for an event once. */
     once<T extends Fn>(name: string, callback: T, thisArg?: unknown): void
     /** Send an event to all remote listeners (local listeners are ignored). */
-    send<T = unknown>(name: string, ...args: FnArgsOrArr<T>): Promise<FnResultOrValue<T>>
+    send<T = unknown>(name: string, ...args: FnArgsOrArr<T>): Promise<FnResultOrValue<T> | null>
     /** Emit event locally (calls local listeners only). */
-    emit<T = unknown>(name: string, ...args: FnArgsOrArr<T>): Promise<FnResultOrValue<T>>
+    emit<T = unknown>(name: string, ...args: FnArgsOrArr<T>): Promise<FnResultOrValue<T> | null>
     setSignal(name: string, value?: unknown): void
-    waitSignal<T = unknown>(name: string, timeout?: number): Promise<T>
+    waitSignal<T = unknown>(name: string, timeout?: number): Promise<T | null>
   }
 
   // State
   state: {
     /** Connect state. */
     connect: {
-      <T extends Obj | Model>(initial?: Initial<T>, versioner?: Versioner): Promise<T>
-      <T extends Obj | Model>(name?: string, initial?: Initial<T>, versioner?: Versioner): Promise<T>
+      <T extends Obj | Model = Obj>(initial?: Initial<T>, versioner?: Versioner): Promise<T>
+      <T extends Obj | Model = Obj>(name?: string, initial?: Initial<T>, versioner?: Versioner): Promise<T>
     }
     /** Disconnect state. */
     disconnect(name?: string): void
@@ -159,7 +166,7 @@ export interface Epos {
 
   // Asset
   asset: {
-    /** Load either all assets to the memory or a specific asset by its path. */
+    /** Load specified asset to memory. Load all assets if no path is provided. */
     load: {
       /** Load all assets. */
       (): Promise<void>
@@ -177,12 +184,13 @@ export interface Epos {
     url(path: string): string
     /** Get asset as Blob. */
     get(path: string): Promise<Blob | null>
-    /** Get list of all available asset files. */
+    /** Get list of all available assets. */
     list(filter?: { loaded?: boolean }): { path: string; loaded: boolean }[]
   }
 
   // Env
   env: {
+    mode: Mode
     tabId: number
     project: string
     isPopup: boolean
@@ -209,6 +217,18 @@ export interface Epos {
     readonly stateModelStrict: symbol
     readonly stateModelVersioner: symbol
   }
+
+  // Installer
+  installer: {
+    install: {
+      (url: string, mode?: Mode): Promise<void>
+      (bundle: Bundle): Promise<void>
+    }
+    remove(name: string): Promise<void>
+  }
+
+  // Engine
+  engine: any
 }
 
 declare global {