epos 1.8.3 → 1.8.4

package/dist/epos.d.ts

@@ -11,11 +11,8 @@ type Obj = Record<string, unknown>;
 type Versioner = Record<number, (this: any, state: any) => void>;
 type ClassName = string | null | boolean | undefined | ClassName[];
 type ModelClass = new (...args: any[]) => any;
-type ConnectOptions<T extends Obj> = {
-    getInitialState?: () => T;
-    models?: Record<string, ModelClass>;
-    versioner?: Versioner;
-};
+type Model = InstanceType<ModelClass>;
+type Initial<T extends Obj | Model> = T | (() => T);
 type Storage = {
     /** Get value from the storage. */
     get<T = unknown>(key: string): Promise<T>;
@@ -52,8 +49,8 @@ interface Epos {
     state: {
         /** Connect state. */
         connect: {
-            <T extends Obj>(name?: string, options?: ConnectOptions<T>): Promise<T>;
-            <T extends Obj>(options?: ConnectOptions<T>): Promise<T>;
+            <T extends Obj | Model>(initial?: Initial<T>, versioner?: Versioner): Promise<T>;
+            <T extends Obj | Model>(name?: string, initial?: Initial<T>, versioner?: Versioner): Promise<T>;
         };
         /** Disconnect state. */
         disconnect(name?: string): void;
@@ -64,20 +61,18 @@ interface Epos {
         /** Get the list of all state names. */
         list(filter?: {
             connected?: boolean;
-        }): Promise<Array<{
+        }): Promise<{
             name: string | null;
-        }>>;
+        }[]>;
         /** Remove state and all its data. */
         destroy(name?: string): Promise<void>;
-        /** Dynamically register models for all states. */
-        registerGlobalModels(models: Record<string, ModelClass>): void;
+        /** Register models for all states. */
+        registerModels(models: Record<string, ModelClass>): void;
         symbols: {
-            model: {
-                readonly init: unique symbol;
-                readonly cleanup: unique symbol;
-                readonly versioner: unique symbol;
-                readonly parent: unique symbol;
-            };
+            readonly parent: unique symbol;
+            readonly modelInit: unique symbol;
+            readonly modelCleanup: unique symbol;
+            readonly modelVersioner: unique symbol;
         };
     };
     storage: {
@@ -91,15 +86,26 @@ interface Epos {
         keys(storageName?: string): Promise<string[]>;
         /** Clear storage. Removes all keys and storage itself. */
         clear(storageName?: string): Promise<void>;
-        /** Create storage API. */
-        use(name: string): Promise<Storage>;
-        /** Get list of all storage names. */
-        list(): Promise<Array<{
+        /** Get storage API for a specific storage. */
+        use(storageName: string): Promise<Storage>;
+        /** Get this list of all storages. */
+        list(): Promise<{
             name: string | null;
-        }>>;
+        }[]>;
+    };
+    frame: {
+        /** Open frame in the background. */
+        open(name: string, url: string, attributes?: Record<string, unknown>): Promise<void>;
+        /** Remove background frame by its name. */
+        close(name: string): Promise<void>;
+        /** Get list of all open background frames. */
+        list(): Promise<{
+            name: string;
+            url: string;
+        }[]>;
     };
     assets: {
-        /** Get asset URL. Asset must be loaded first. */
+        /** Get asset URL. The asset must be loaded first. */
         url(path: string): string;
         /** Load asset by path. */
         load(path: string): Promise<Blob>;
@@ -109,42 +115,20 @@ interface Epos {
         unload(path: string): void;
         /** Unload all assets from memory. */
         unloadAll(): void;
-        /** Get list of all available asset paths. */
+        /** Get list of all available assets. */
         list(filter?: {
             loaded?: boolean;
-        }): Array<{
+        }): {
             path: string;
             loaded: boolean;
-        }>;
-    };
-    frames: {
-        /** Create a new frame. */
-        create(name: string, url: string, attributes?: Record<string, unknown>): Promise<void>;
-        /** Remove frame by name. */
-        remove(name: string): Promise<void>;
-        /** Get list of all created frames. */
-        list(): Promise<Array<{
-            name: string;
-            url: string;
-        }>>;
+        }[];
     };
     env: {
-        /** Current tab ID. */
         tabId: number;
-        /** True if running in a tab (top-level, not iframe). */
-        isTab: boolean;
-        /** True if running in an iframe. */
-        isFrame: boolean;
-        /** True if running in a popup or side panel (`<popup>` or `<sidePanel>`). */
-        isShell: boolean;
-        /** True if running in a popup (`<popup>`). */
+        isWeb: boolean;
         isPopup: boolean;
-        /** True if running in a side panel (`<sidePanel>`). */
         isSidePanel: boolean;
-        /** True if running in the background (`<background>`). */
         isBackground: boolean;
-        /** True if running in the foreground (not `<background>` and not inside iframe). */
-        isForeground: boolean;
     };
     libs: {
         mobx: typeof mobx;
@@ -167,4 +151,4 @@ declare global {
 declare const _epos: Epos;
 var epos$1 = epos;
 
-export { type ClassName, type ConnectOptions, type Epos, type Fn, type ModelClass, type Obj, type Storage, type Versioner, epos$1 as default, _epos as epos };
+export { type ClassName, type Epos, type Fn, type Initial, type Model, type ModelClass, type Obj, type Storage, type Versioner, epos$1 as default, _epos as epos };

package/dist/vite.js

@@ -1,6 +1,6 @@
 // src/vite.ts
 import { resolve } from "path";
-var mapping = {
+var libs = {
   "react": resolve(import.meta.dirname, "./libs/libs-react.js"),
   "react/jsx-runtime": resolve(import.meta.dirname, "./libs/libs-react-jsx-runtime.js"),
   "react-dom": resolve(import.meta.dirname, "./libs/libs-react-dom.js"),
@@ -12,7 +12,7 @@ function epos() {
   return {
     name: "epos",
     enforce: "pre",
-    resolveId: (source) => mapping[source] ?? null
+    resolveId: (source) => libs[source] ?? null
   };
 }
 var vite_default = epos;

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "epos",
-  "version": "1.8.3",
+  "version": "1.8.4",
   "type": "module",
   "license": "MIT",
   "author": "imkost",
   "description": "",
   "keywords": [],
   "scripts": {
-    "build": "tsup src --format esm --dts --clean",
+    "build": "tsup src --format esm --dts --clean --no-splitting",
     "lint": "tsc --noEmit",
     "release": "sh -c 'npm version ${1:-patch} && npm run build && npm publish' --"
   },
@@ -35,7 +35,7 @@
     "@types/react": "^19.1.14",
     "@types/react-dom": "^19.1.9",
     "mobx": "^6.15.0",
-    "mobx-react-lite": "^4.1.0",
+    "mobx-react-lite": "^4.1.1",
     "react": "^19.1.1",
     "yjs": "^13.6.27"
   },

package/src/epos.ts

@@ -11,12 +11,8 @@ export type Obj = Record<string, unknown>
 export type Versioner = Record<number, (this: any, state: any) => void>
 export type ClassName = string | null | boolean | undefined | ClassName[]
 export type ModelClass = new (...args: any[]) => any
-
-export type ConnectOptions<T extends Obj> = {
-  getInitialState?: () => T
-  models?: Record<string, ModelClass>
-  versioner?: Versioner
-}
+export type Model = InstanceType<ModelClass>
+export type Initial<T extends Obj | Model> = T | (() => T)
 
 export type Storage = {
   /** Get value from the storage. */
@@ -60,8 +56,8 @@ export interface Epos {
   state: {
     /** Connect state. */
     connect: {
-      <T extends Obj>(name?: string, options?: ConnectOptions<T>): Promise<T>
-      <T extends Obj>(options?: ConnectOptions<T>): Promise<T>
+      <T extends Obj | Model>(initial?: Initial<T>, versioner?: Versioner): Promise<T>
+      <T extends Obj | Model>(name?: string, initial?: Initial<T>, versioner?: Versioner): Promise<T>
     }
     /** Disconnect state. */
     disconnect(name?: string): void
@@ -70,18 +66,16 @@ export interface Epos {
     /** Create local state (no sync). */
     local<T extends Obj = {}>(state?: T): T
     /** Get the list of all state names. */
-    list(filter?: { connected?: boolean }): Promise<Array<{ name: string | null }>>
+    list(filter?: { connected?: boolean }): Promise<{ name: string | null }[]>
     /** Remove state and all its data. */
     destroy(name?: string): Promise<void>
-    /** Dynamically register models for all states. */
-    registerGlobalModels(models: Record<string, ModelClass>): void
+    /** Register models for all states. */
+    registerModels(models: Record<string, ModelClass>): void
     symbols: {
-      model: {
-        readonly init: unique symbol
-        readonly cleanup: unique symbol
-        readonly versioner: unique symbol
-        readonly parent: unique symbol
-      }
+      readonly parent: unique symbol
+      readonly modelInit: unique symbol
+      readonly modelCleanup: unique symbol
+      readonly modelVersioner: unique symbol
     }
   }
 
@@ -97,15 +91,25 @@ export interface Epos {
     keys(storageName?: string): Promise<string[]>
     /** Clear storage. Removes all keys and storage itself. */
     clear(storageName?: string): Promise<void>
-    /** Create storage API. */
-    use(name: string): Promise<Storage>
-    /** Get list of all storage names. */
-    list(): Promise<Array<{ name: string | null }>>
+    /** Get storage API for a specific storage. */
+    use(storageName: string): Promise<Storage>
+    /** Get this list of all storages. */
+    list(): Promise<{ name: string | null }[]>
+  }
+
+  // Frame
+  frame: {
+    /** Open frame in the background. */
+    open(name: string, url: string, attributes?: Record<string, unknown>): Promise<void>
+    /** Remove background frame by its name. */
+    close(name: string): Promise<void>
+    /** Get list of all open background frames. */
+    list(): Promise<{ name: string; url: string }[]>
   }
 
   // Assets
   assets: {
-    /** Get asset URL. Asset must be loaded first. */
+    /** Get asset URL. The asset must be loaded first. */
     url(path: string): string
     /** Load asset by path. */
     load(path: string): Promise<Blob>
@@ -115,38 +119,17 @@ export interface Epos {
     unload(path: string): void
     /** Unload all assets from memory. */
     unloadAll(): void
-    /** Get list of all available asset paths. */
-    list(filter?: { loaded?: boolean }): Array<{ path: string; loaded: boolean }>
-  }
-
-  // Frames
-  frames: {
-    /** Create a new frame. */
-    create(name: string, url: string, attributes?: Record<string, unknown>): Promise<void>
-    /** Remove frame by name. */
-    remove(name: string): Promise<void>
-    /** Get list of all created frames. */
-    list(): Promise<Array<{ name: string; url: string }>>
+    /** Get list of all available assets. */
+    list(filter?: { loaded?: boolean }): { path: string; loaded: boolean }[]
   }
 
   // Env
   env: {
-    /** Current tab ID. */
     tabId: number
-    /** True if running in a tab (top-level, not iframe). */
-    isTab: boolean
-    /** True if running in an iframe. */
-    isFrame: boolean
-    /** True if running in a popup or side panel (`<popup>` or `<sidePanel>`). */
-    isShell: boolean
-    /** True if running in a popup (`<popup>`). */
+    isWeb: boolean
     isPopup: boolean
-    /** True if running in a side panel (`<sidePanel>`). */
     isSidePanel: boolean
-    /** True if running in the background (`<background>`). */
     isBackground: boolean
-    /** True if running in the foreground (not `<background>` and not inside iframe). */
-    isForeground: boolean
   }
 
   // Libs

package/src/vite.ts

@@ -1,7 +1,7 @@
 import { resolve } from 'node:path'
 import type { Plugin } from 'vite'
 
-const mapping: Record<string, string> = {
+const libs: Record<string, string> = {
   'react': resolve(import.meta.dirname, './libs/libs-react.js'),
   'react/jsx-runtime': resolve(import.meta.dirname, './libs/libs-react-jsx-runtime.js'),
   'react-dom': resolve(import.meta.dirname, './libs/libs-react-dom.js'),
@@ -14,7 +14,7 @@ export function epos(): Plugin {
   return {
     name: 'epos',
     enforce: 'pre',
-    resolveId: source => mapping[source] ?? null,
+    resolveId: source => libs[source] ?? null,
   }
 }