@wakit/core 0.0.0-stage → 0.1.0

package/README.md

@@ -1,3 +1,266 @@
-# Temporary Holding Version
+<h1 align="center">Wakit</h1>
+<h3 align="center">Your toolkit for Progressive Web Applications</h3>
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+---
+
+Wakit (Web Applications Kit) is a set of tools to build Progressive Web Applications (mobile like applications using web).
+It includes an ORM, a network system and an event system, all working together.
+
+It's a great addition for applications built using **capacitor.js** (Ionic for example)
+
+## How
+
+Wakit core combines every part of the system in a single package:
+
+- [@wakit/waorm](https://www.npmjs.com/package/@wakit/waorm) — your ORM, using IndexedDB by default
+- [@wakit/networker](https://www.npmjs.com/package/@wakit/networker) — the network system, a wrapper of axios
+- [@wakit/events](https://www.npmjs.com/package/@wakit/events) — the event system
+
+`await init({ database, toast, network })`
+
+A single call sets up your database and network. All events from the different parts are wired into the core event
+system, so you only need to subscribe in one place.
+
+## Installation
+
+`npm i @wakit/core`
+
+## Usage
+
+#### Initialization
+
+Call `init` once when your application starts. Every option is optional, so just pass what you need:
+
+```typescript
+import { init } from '@wakit/core'
+
+await init({
+  database: {
+    name: 'MyDatabase',
+    // Increment the version every time you do a change on the schema
+    version: 1,
+    stores: [
+      {
+        name: 'users',
+        indexes: [
+          { name: 'name' },
+          { name: 'email', unique: true },
+        ],
+      },
+    ],
+  },
+  toast: {
+    success: (msg: string) => console.log(msg),
+    error: (msg: string) => console.error(msg),
+  },
+  network: {
+    pingUrl: 'https://example.com/ping',
+  },
+})
+```
+
+- `database` — the database config, see [@wakit/waorm](https://www.npmjs.com/package/@wakit/waorm) for all the options
+- `toast` — the toast system used to display network errors
+- `network.pingUrl` — when set, requests first check the internet connection by pinging this url, and skip the request when offline
+- `debug` — logs the initialization steps to the console. Defaults to `false`
+
+
+##### Waiting for Wakit
+
+If some part of your application may run before `init` finishes, use `waitForWakit`. It throws if wakit isn't ready
+after ~2 seconds:
+
+```typescript
+import { waitForWakit } from '@wakit/core'
+
+await waitForWakit()
+```
+
+#### Models & Network
+
+Core re-exports the most used functions and types, so you don't need to import each package:
+
+```typescript
+import { Model, collect, network } from '@wakit/core'
+
+class User extends Model {
+  storeName(): string {
+    return 'users'
+  }
+}
+
+const user = () => (new User)
+
+const data = await network.get('/user')
+await user().hydrate(data).save()
+
+await collect(user().all()).count()
+```
+
+Check [@wakit/waorm](https://www.npmjs.com/package/@wakit/waorm) and [@wakit/networker](https://www.npmjs.com/package/@wakit/networker)
+for everything you can do with models and network.
+
+#### Events
+
+Subscribing to events is super easy, just use `subscribe` with any of the events wakit provides:
+
+```typescript
+import { subscribe, unsubscribe, NETWORK_OFFLINE } from '@wakit/core'
+
+const eventId = subscribe(NETWORK_OFFLINE, () => {
+  alert('You are offline')
+})
+
+onbeforeunload = () => unsubscribe(eventId)
+```
+
+##### Wakit
+
+- `WAKIT_READY` — `init` finished
+
+##### Database
+
+- `DATABASE_READY` — database is initialized
+- `DATABASE_INIT_ERROR` — database failed to initialize. Context is the error
+- `DATABASE_BLOCKED` — another connection is blocking the upgrade. Context is `{ name, oldVersion, newVersion }`
+- `DATABASE_VERSION_CHANGE` — a newer version was opened (e.g. in another tab). Context is `{ name, oldVersion, newVersion }`
+- `MODEL_OPERATION_ERROR` — a model operation failed. Context is the error
+
+##### Network
+
+- `NETWORK_ONLINE` / `NETWORK_OFFLINE` — result of every connection check
+- `NETWORK_RECONNECTED` / `NETWORK_DISCONNECTED` — connection was restored / lost (only when it changes)
+- `NETWORK_SLOW_CONNECTION` — the ping took longer than 350ms
+- `NETWORK_HANDLED_ERROR` — a request error was handled. Context is the error
+
+##### Version Changes
+
+Database events can fire during `init`, so subscribe to them before calling it.
+
+When a newer `version` is opened, the existing connection is closed and can't be used anymore, so reload the app:
+
+```typescript
+import { init, subscribe, DATABASE_BLOCKED, DATABASE_VERSION_CHANGE } from '@wakit/core'
+
+subscribe(DATABASE_VERSION_CHANGE, () => location.reload())
+subscribe(DATABASE_BLOCKED, () => alert('Please close other tabs'))
+
+await init({ database: { ... } })
+```
+
+#### Error Handling
+
+`init` throws if the database fails to initialize, after dispatching `DATABASE_INIT_ERROR`. Wrap in try/catch or listen for errors:
+
+```typescript
+import { init, subscribe, DATABASE_INIT_ERROR, MODEL_OPERATION_ERROR } from '@wakit/core'
+
+subscribe(DATABASE_INIT_ERROR, (err) => console.error('DB init failed:', err))
+subscribe(MODEL_OPERATION_ERROR, (err) => console.error('Model op failed:', err))
+
+await init({ database: { ... } })
+```
+
+## Example
+
+Here is an example setup for a simple Todo App
+
+#### JavaScript
+```javascript
+import { init, subscribe, Model, network, WAKIT_READY, NETWORK_RECONNECTED } from '@wakit/core'
+
+class Todo extends Model {
+  storeName() {
+    return 'todos'
+  }
+}
+
+const todo = () => (new Todo)
+
+const syncTodos = async () => {
+  const todos = await network.get('/todos')
+
+  for (const data of todos ?? []) {
+    await todo().hydrate(data).save()
+  }
+}
+
+subscribe(WAKIT_READY, syncTodos)
+subscribe(NETWORK_RECONNECTED, syncTodos)
+
+await init({
+  database: {
+    name: 'TodoApp',
+    version: 1,
+    stores: [
+      {
+        name: 'todos',
+        indexes: [
+          { name: 'due_by' },
+        ],
+      },
+    ],
+  },
+  network: {
+    pingUrl: 'https://example.com/ping',
+  },
+})
+
+///// Using within the application /////
+
+await todo().hydrate({ name: 'Clean room', due_by: '2025-01-01' }).save()
+```
+#### TypeScript
+```typescript
+import { init, subscribe, Model, network, WAKIT_READY, NETWORK_RECONNECTED } from '@wakit/core'
+import type { Resource } from '@wakit/core'
+
+interface TodoResource extends Resource {
+  name: string;
+  due_by: string;
+}
+
+class Todo extends Model<TodoResource> {
+  public name?: string;
+  public due_by?: string;
+
+  storeName(): string {
+    return 'todos'
+  }
+}
+
+const todo = () => (new Todo)
+
+const syncTodos = async () => {
+  const todos = await network.get<TodoResource[]>('/todos')
+
+  for (const data of todos ?? []) {
+    await todo().hydrate(data).save()
+  }
+}
+
+subscribe(WAKIT_READY, syncTodos)
+subscribe(NETWORK_RECONNECTED, syncTodos)
+
+await init({
+  database: {
+    name: 'TodoApp',
+    version: 1,
+    stores: [
+      {
+        name: 'todos',
+        indexes: [
+          { name: 'due_by' },
+        ],
+      },
+    ],
+  },
+  network: {
+    pingUrl: 'https://example.com/ping',
+  },
+})
+
+///// Using within the application /////
+
+await todo().hydrate({ name: 'Clean room', due_by: '2025-01-01' }).save()
+```

package/dist/eslint.config.d.ts

@@ -0,0 +1,4 @@
+import tseslint from 'typescript-eslint';
+declare const _default: tseslint.FlatConfig.ConfigArray;
+export default _default;
+//# sourceMappingURL=eslint.config.d.ts.map

package/dist/eslint.config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"eslint.config.d.ts","sourceRoot":"","sources":["../eslint.config.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,mBAAmB,CAAA;;AAExC,wBAoBC"}

package/dist/eslint.config.js

@@ -0,0 +1,20 @@
+import tseslint from 'typescript-eslint';
+export default tseslint.config({
+    ignores: ['dist/**'],
+}, {
+    files: ['**/*.ts'],
+    extends: [tseslint.configs.base],
+    rules: {
+        'space-unary-ops': ['error', { words: true, nonwords: false, overrides: { '!': true } }],
+        'quotes': ['error', 'single', { avoidEscape: true, allowTemplateLiterals: true }],
+        'semi': ['error', 'never'],
+        'indent': ['error', 2, { SwitchCase: 1, ignoredNodes: ['CallExpression > ObjectExpression', 'CallExpression > ObjectExpression *', 'CallExpression > ArrowFunctionExpression > BlockStatement', 'CallExpression > ArrowFunctionExpression > BlockStatement *'] }],
+        'no-var': 'error',
+        'prefer-const': 'error',
+        'space-before-blocks': 'error',
+        'arrow-spacing': 'error',
+        'spaced-comment': ['error', 'always'],
+        'curly': ['error', 'all'],
+    },
+});
+//# sourceMappingURL=eslint.config.js.map

package/dist/eslint.config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"eslint.config.js","sourceRoot":"","sources":["../eslint.config.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,mBAAmB,CAAA;AAExC,eAAe,QAAQ,CAAC,MAAM,CAC5B;IACE,OAAO,EAAE,CAAC,SAAS,CAAC;CACrB,EACD;IACE,KAAK,EAAE,CAAC,SAAS,CAAC;IAClB,OAAO,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC;IAChC,KAAK,EAAE;QACL,iBAAiB,EAAE,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC;QACxF,QAAQ,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,qBAAqB,EAAE,IAAI,EAAE,CAAC;QACjF,MAAM,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC;QAC1B,QAAQ,EAAE,CAAC,OAAO,EAAE,CAAC,EAAE,EAAE,UAAU,EAAE,CAAC,EAAE,YAAY,EAAE,CAAC,mCAAmC,EAAE,qCAAqC,EAAE,2DAA2D,EAAE,6DAA6D,CAAC,EAAE,CAAC;QACjQ,QAAQ,EAAE,OAAO;QACjB,cAAc,EAAE,OAAO;QACvB,qBAAqB,EAAE,OAAO;QAC9B,eAAe,EAAE,OAAO;QACxB,gBAAgB,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC;QACrC,OAAO,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC;KAC1B;CACF,CACF,CAAA"}

package/dist/events.d.ts

@@ -0,0 +1,14 @@
+import type { IEvent } from '@wakit/events';
+export declare const NETWORK_OFFLINE: IEvent;
+export declare const NETWORK_ONLINE: IEvent;
+export declare const NETWORK_DISCONNECTED: IEvent;
+export declare const NETWORK_RECONNECTED: IEvent;
+export declare const NETWORK_SLOW_CONNECTION: IEvent;
+export declare const NETWORK_HANDLED_ERROR: IEvent;
+export declare const DATABASE_READY: IEvent;
+export declare const DATABASE_INIT_ERROR: IEvent;
+export declare const DATABASE_BLOCKED: IEvent;
+export declare const DATABASE_VERSION_CHANGE: IEvent;
+export declare const MODEL_OPERATION_ERROR: IEvent;
+export declare const WAKIT_READY: IEvent;
+//# sourceMappingURL=events.d.ts.map

package/dist/events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../events.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAE3C,eAAO,MAAM,eAAe,EAAE,MAAgC,CAAA;AAC9D,eAAO,MAAM,cAAc,EAAE,MAA+B,CAAA;AAC5D,eAAO,MAAM,oBAAoB,EAAE,MAAqC,CAAA;AACxE,eAAO,MAAM,mBAAmB,EAAE,MAAoC,CAAA;AACtE,eAAO,MAAM,uBAAuB,EAAE,MAAwC,CAAA;AAE9E,eAAO,MAAM,qBAAqB,EAAE,MAAsC,CAAA;AAE1E,eAAO,MAAM,cAAc,EAAE,MAA+B,CAAA;AAC5D,eAAO,MAAM,mBAAmB,EAAE,MAAoC,CAAA;AACtE,eAAO,MAAM,gBAAgB,EAAE,MAAiC,CAAA;AAChE,eAAO,MAAM,uBAAuB,EAAE,MAAwC,CAAA;AAC9E,eAAO,MAAM,qBAAqB,EAAE,MAAsC,CAAA;AAE1E,eAAO,MAAM,WAAW,EAAE,MAAsB,CAAA"}

package/dist/events.js

@@ -0,0 +1,13 @@
+export const NETWORK_OFFLINE = 'wakit:network:offline';
+export const NETWORK_ONLINE = 'wakit:network:online';
+export const NETWORK_DISCONNECTED = 'wakit:network:disconnected';
+export const NETWORK_RECONNECTED = 'wakit:network:reconnected';
+export const NETWORK_SLOW_CONNECTION = 'wakit:network:slow_connection';
+export const NETWORK_HANDLED_ERROR = 'wakit:network:handled_error';
+export const DATABASE_READY = 'wakit:database:ready';
+export const DATABASE_INIT_ERROR = 'wakit:database:init_error';
+export const DATABASE_BLOCKED = 'wakit:database:blocked';
+export const DATABASE_VERSION_CHANGE = 'wakit:database:version_change';
+export const MODEL_OPERATION_ERROR = 'wakit:model:operation_error';
+export const WAKIT_READY = 'wakit:ready';
+//# sourceMappingURL=events.js.map

package/dist/events.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../events.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,eAAe,GAAW,uBAAuB,CAAA;AAC9D,MAAM,CAAC,MAAM,cAAc,GAAW,sBAAsB,CAAA;AAC5D,MAAM,CAAC,MAAM,oBAAoB,GAAW,4BAA4B,CAAA;AACxE,MAAM,CAAC,MAAM,mBAAmB,GAAW,2BAA2B,CAAA;AACtE,MAAM,CAAC,MAAM,uBAAuB,GAAW,+BAA+B,CAAA;AAE9E,MAAM,CAAC,MAAM,qBAAqB,GAAW,6BAA6B,CAAA;AAE1E,MAAM,CAAC,MAAM,cAAc,GAAW,sBAAsB,CAAA;AAC5D,MAAM,CAAC,MAAM,mBAAmB,GAAW,2BAA2B,CAAA;AACtE,MAAM,CAAC,MAAM,gBAAgB,GAAW,wBAAwB,CAAA;AAChE,MAAM,CAAC,MAAM,uBAAuB,GAAW,+BAA+B,CAAA;AAC9E,MAAM,CAAC,MAAM,qBAAqB,GAAW,6BAA6B,CAAA;AAE1E,MAAM,CAAC,MAAM,WAAW,GAAW,aAAa,CAAA"}

package/dist/index.d.ts

@@ -0,0 +1,21 @@
+import type { WaormDatabaseConfig } from '@wakit/waorm';
+import type { ToastSystem } from '@wakit/networker';
+export type * from '@wakit/waorm';
+export type * from '@wakit/events';
+export { Model, collect, generateNewSlug, generateNewId, isDirty, isNew, isInstance } from '@wakit/waorm';
+export { dispatch, dispatchFor, subscribe, unsubscribe, unsubscribeGroup } from '@wakit/events';
+export { network } from '@wakit/networker';
+export * from './events.js';
+export interface WakitConfig {
+    database?: WaormDatabaseConfig<IDBDatabase>;
+    toast?: ToastSystem;
+    network?: {
+        pingUrl: string;
+    };
+    debug?: boolean;
+}
+declare const wait: (timeout?: number) => Promise<void>;
+declare const waitForWakit: () => Promise<void>;
+declare const init: (config: WakitConfig) => Promise<void>;
+export { wait, init, waitForWakit, };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAA;AACvD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAkCnD,mBAAmB,cAAc,CAAA;AACjC,mBAAmB,eAAe,CAAA;AAElC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AACzG,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,SAAS,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAA;AAC/F,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAE1C,cAAc,aAAa,CAAA;AAE3B,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,EAAE,mBAAmB,CAAC,WAAW,CAAC,CAAC;IAC5C,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,OAAO,CAAC,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;KAAE,CAAC;IAC/B,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAkBD,QAAA,MAAM,IAAI,GAAS,gBAAc,kBAEhC,CAAA;AAED,QAAA,MAAM,YAAY,qBASjB,CAAA;AAED,QAAA,MAAM,IAAI,GAAU,QAAQ,WAAW,kBAyCtC,CAAA;AAED,OAAO,EACL,IAAI,EACJ,IAAI,EACJ,YAAY,GACb,CAAA"}

package/dist/index.js

@@ -0,0 +1,72 @@
+import { dispatch } from '@wakit/events';
+import { initDB, onDatabaseBlocked, onDatabaseInitError, onDatabaseVersionChange, onModelOperationError, } from '@wakit/waorm';
+import { network, onNetworkDisconnected, onNetworkOffline, onNetworkOnline, onNetworkReconnected, onNetworkSlowConnection, setPingUrl, } from '@wakit/networker';
+import { NETWORK_ONLINE, NETWORK_OFFLINE, NETWORK_RECONNECTED, NETWORK_DISCONNECTED, NETWORK_SLOW_CONNECTION, NETWORK_HANDLED_ERROR, DATABASE_READY, DATABASE_INIT_ERROR, DATABASE_BLOCKED, DATABASE_VERSION_CHANGE, MODEL_OPERATION_ERROR, WAKIT_READY, } from './events.js';
+export { Model, collect, generateNewSlug, generateNewId, isDirty, isNew, isInstance } from '@wakit/waorm';
+export { dispatch, dispatchFor, subscribe, unsubscribe, unsubscribeGroup } from '@wakit/events';
+export { network } from '@wakit/networker';
+export * from './events.js';
+let initializing = false;
+let initialized = false;
+let debug = false;
+const log = (message) => {
+    if (debug) {
+        console.debug(`[wakit] ${message}`);
+    }
+};
+// registered once at load, before any initDB: init error / blocked fire during setup
+onDatabaseInitError((error) => dispatch(DATABASE_INIT_ERROR, error));
+onDatabaseBlocked((context) => dispatch(DATABASE_BLOCKED, context));
+onDatabaseVersionChange((context) => dispatch(DATABASE_VERSION_CHANGE, context));
+onModelOperationError((error) => dispatch(MODEL_OPERATION_ERROR, error));
+const wait = async (timeout = 1000) => {
+    await new Promise((resolve) => setTimeout(() => resolve(), timeout));
+};
+const waitForWakit = async () => {
+    let steps = 0;
+    while (!initialized && steps++ < 200) {
+        await wait(10);
+    }
+    if (!initialized) {
+        throw new Error('Timeout while waiting. Failed to initialize Wakit');
+    }
+};
+const init = async (config) => {
+    if (initializing || initialized) {
+        return;
+    }
+    initializing = true;
+    debug = config.debug ?? false;
+    if (config.database) {
+        log('starting database config');
+        try {
+            await initDB(config.database);
+        }
+        catch (err) {
+            initializing = false;
+            throw err;
+        }
+        dispatch(DATABASE_READY);
+    }
+    log('setting up network');
+    network.config({
+        onHandledError: (error) => dispatch(NETWORK_HANDLED_ERROR, error),
+        toast: config.toast,
+        handleErrors: true,
+        checkInternetConnection: !!config.network?.pingUrl,
+    });
+    if (!!config.network?.pingUrl) {
+        setPingUrl(config.network.pingUrl);
+    }
+    onNetworkOnline(() => dispatch(NETWORK_ONLINE));
+    onNetworkOffline(() => dispatch(NETWORK_OFFLINE));
+    onNetworkReconnected(() => dispatch(NETWORK_RECONNECTED));
+    onNetworkDisconnected(() => dispatch(NETWORK_DISCONNECTED));
+    onNetworkSlowConnection(() => dispatch(NETWORK_SLOW_CONNECTION));
+    initializing = false;
+    initialized = true;
+    log('ready');
+    dispatch(WAKIT_READY);
+};
+export { wait, init, waitForWakit, };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAC,MAAM,eAAe,CAAA;AACvC,OAAO,EACL,MAAM,EACN,iBAAiB,EACjB,mBAAmB,EACnB,uBAAuB,EACvB,qBAAqB,GACtB,MAAM,cAAc,CAAA;AACrB,OAAO,EACL,OAAO,EACP,qBAAqB,EACrB,gBAAgB,EAChB,eAAe,EACf,oBAAoB,EACpB,uBAAuB,EACvB,UAAU,GACX,MAAM,kBAAkB,CAAA;AAEzB,OAAO,EACL,cAAc,EACd,eAAe,EACf,mBAAmB,EACnB,oBAAoB,EACpB,uBAAuB,EACvB,qBAAqB,EACrB,cAAc,EACd,mBAAmB,EACnB,gBAAgB,EAChB,uBAAuB,EACvB,qBAAqB,EACrB,WAAW,GACZ,MAAM,aAAa,CAAA;AAKpB,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AACzG,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,SAAS,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAA;AAC/F,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAE1C,cAAc,aAAa,CAAA;AAS3B,IAAI,YAAY,GAAG,KAAK,CAAA;AACxB,IAAI,WAAW,GAAG,KAAK,CAAA;AACvB,IAAI,KAAK,GAAG,KAAK,CAAA;AAEjB,MAAM,GAAG,GAAG,CAAC,OAAe,EAAE,EAAE;IAC9B,IAAI,KAAK,EAAE,CAAC;QACV,OAAO,CAAC,KAAK,CAAC,WAAW,OAAO,EAAE,CAAC,CAAA;IACrC,CAAC;AACH,CAAC,CAAA;AAED,qFAAqF;AACrF,mBAAmB,CAAC,CAAC,KAAc,EAAE,EAAE,CAAC,QAAQ,CAAC,mBAAmB,EAAE,KAAK,CAAC,CAAC,CAAA;AAC7E,iBAAiB,CAAC,CAAC,OAAgB,EAAE,EAAE,CAAC,QAAQ,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC,CAAA;AAC5E,uBAAuB,CAAC,CAAC,OAAgB,EAAE,EAAE,CAAC,QAAQ,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAC,CAAA;AACzF,qBAAqB,CAAC,CAAC,KAAc,EAAE,EAAE,CAAC,QAAQ,CAAC,qBAAqB,EAAE,KAAK,CAAC,CAAC,CAAA;AAEjF,MAAM,IAAI,GAAG,KAAK,EAAC,OAAO,GAAG,IAAI,EAAE,EAAE;IACnC,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC,CAAA;AAC5E,CAAC,CAAA;AAED,MAAM,YAAY,GAAG,KAAK,IAAG,EAAE;IAC7B,IAAI,KAAK,GAAG,CAAC,CAAA;IACb,OAAO,CAAE,WAAW,IAAI,KAAK,EAAE,GAAG,GAAG,EAAE,CAAC;QACtC,MAAM,IAAI,CAAC,EAAE,CAAC,CAAA;IAChB,CAAC;IAED,IAAI,CAAE,WAAW,EAAE,CAAC;QAClB,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAA;IACtE,CAAC;AACH,CAAC,CAAA;AAED,MAAM,IAAI,GAAG,KAAK,EAAE,MAAmB,EAAE,EAAE;IACzC,IAAI,YAAY,IAAI,WAAW,EAAE,CAAC;QAChC,OAAM;IACR,CAAC;IAED,YAAY,GAAG,IAAI,CAAA;IACnB,KAAK,GAAG,MAAM,CAAC,KAAK,IAAI,KAAK,CAAA;IAE7B,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;QACpB,GAAG,CAAC,0BAA0B,CAAC,CAAA;QAC/B,IAAI,CAAC;YACH,MAAM,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;QAC/B,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,YAAY,GAAG,KAAK,CAAA;YACpB,MAAM,GAAG,CAAA;QACX,CAAC;QACD,QAAQ,CAAC,cAAc,CAAC,CAAA;IAC1B,CAAC;IAED,GAAG,CAAC,oBAAoB,CAAC,CAAA;IACzB,OAAO,CAAC,MAAM,CAAC;QACb,cAAc,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,qBAAqB,EAAE,KAAK,CAAC;QACjE,KAAK,EAAE,MAAM,CAAC,KAAK;QACnB,YAAY,EAAE,IAAI;QAClB,uBAAuB,EAAE,CAAC,CAAE,MAAM,CAAC,OAAO,EAAE,OAAO;KACpD,CAAC,CAAA;IAEF,IAAI,CAAC,CAAE,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,CAAC;QAC/B,UAAU,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;IACpC,CAAC;IAED,eAAe,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAAA;IAC/C,gBAAgB,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAA;IACjD,oBAAoB,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC,CAAA;IACzD,qBAAqB,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,oBAAoB,CAAC,CAAC,CAAA;IAC3D,uBAAuB,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,uBAAuB,CAAC,CAAC,CAAA;IAEhE,YAAY,GAAG,KAAK,CAAA;IACpB,WAAW,GAAG,IAAI,CAAA;IAClB,GAAG,CAAC,OAAO,CAAC,CAAA;IACZ,QAAQ,CAAC,WAAW,CAAC,CAAA;AACvB,CAAC,CAAA;AAED,OAAO,EACL,IAAI,EACJ,IAAI,EACJ,YAAY,GACb,CAAA"}

package/eslint.config.ts

@@ -0,0 +1,23 @@
+import tseslint from 'typescript-eslint'
+
+export default tseslint.config(
+  {
+    ignores: ['dist/**'],
+  },
+  {
+    files: ['**/*.ts'],
+    extends: [tseslint.configs.base],
+    rules: {
+      'space-unary-ops': ['error', { words: true, nonwords: false, overrides: { '!': true } }],
+      'quotes': ['error', 'single', { avoidEscape: true, allowTemplateLiterals: true }],
+      'semi': ['error', 'never'],
+      'indent': ['error', 2, { SwitchCase: 1, ignoredNodes: ['CallExpression > ObjectExpression', 'CallExpression > ObjectExpression *', 'CallExpression > ArrowFunctionExpression > BlockStatement', 'CallExpression > ArrowFunctionExpression > BlockStatement *'] }],
+      'no-var': 'error',
+      'prefer-const': 'error',
+      'space-before-blocks': 'error',
+      'arrow-spacing': 'error',
+      'spaced-comment': ['error', 'always'],
+      'curly': ['error', 'all'],
+    },
+  },
+)

package/events.ts

@@ -0,0 +1,17 @@
+import type { IEvent } from '@wakit/events'
+
+export const NETWORK_OFFLINE: IEvent = 'wakit:network:offline'
+export const NETWORK_ONLINE: IEvent = 'wakit:network:online'
+export const NETWORK_DISCONNECTED: IEvent = 'wakit:network:disconnected'
+export const NETWORK_RECONNECTED: IEvent = 'wakit:network:reconnected'
+export const NETWORK_SLOW_CONNECTION: IEvent = 'wakit:network:slow_connection'
+
+export const NETWORK_HANDLED_ERROR: IEvent = 'wakit:network:handled_error'
+
+export const DATABASE_READY: IEvent = 'wakit:database:ready'
+export const DATABASE_INIT_ERROR: IEvent = 'wakit:database:init_error'
+export const DATABASE_BLOCKED: IEvent = 'wakit:database:blocked'
+export const DATABASE_VERSION_CHANGE: IEvent = 'wakit:database:version_change'
+export const MODEL_OPERATION_ERROR: IEvent = 'wakit:model:operation_error'
+
+export const WAKIT_READY: IEvent = 'wakit:ready'

package/index.ts

@@ -0,0 +1,130 @@
+import type { WaormDatabaseConfig } from '@wakit/waorm'
+import type { ToastSystem } from '@wakit/networker'
+import { dispatch} from '@wakit/events'
+import {
+  initDB,
+  onDatabaseBlocked,
+  onDatabaseInitError,
+  onDatabaseVersionChange,
+  onModelOperationError,
+} from '@wakit/waorm'
+import {
+  network,
+  onNetworkDisconnected,
+  onNetworkOffline,
+  onNetworkOnline,
+  onNetworkReconnected,
+  onNetworkSlowConnection,
+  setPingUrl,
+} from '@wakit/networker'
+
+import {
+  NETWORK_ONLINE,
+  NETWORK_OFFLINE,
+  NETWORK_RECONNECTED,
+  NETWORK_DISCONNECTED,
+  NETWORK_SLOW_CONNECTION,
+  NETWORK_HANDLED_ERROR,
+  DATABASE_READY,
+  DATABASE_INIT_ERROR,
+  DATABASE_BLOCKED,
+  DATABASE_VERSION_CHANGE,
+  MODEL_OPERATION_ERROR,
+  WAKIT_READY,
+} from './events.js'
+
+export type * from '@wakit/waorm'
+export type * from '@wakit/events'
+
+export { Model, collect, generateNewSlug, generateNewId, isDirty, isNew, isInstance } from '@wakit/waorm'
+export { dispatch, dispatchFor, subscribe, unsubscribe, unsubscribeGroup } from '@wakit/events'
+export { network } from '@wakit/networker'
+
+export * from './events.js'
+
+export interface WakitConfig {
+  database?: WaormDatabaseConfig<IDBDatabase>,
+  toast?: ToastSystem,
+  network?: { pingUrl: string; };
+  debug?: boolean;
+}
+
+let initializing = false
+let initialized = false
+let debug = false
+
+const log = (message: string) => {
+  if (debug) {
+    console.debug(`[wakit] ${message}`)
+  }
+}
+
+// registered once at load, before any initDB: init error / blocked fire during setup
+onDatabaseInitError((error: unknown) => dispatch(DATABASE_INIT_ERROR, error))
+onDatabaseBlocked((context: unknown) => dispatch(DATABASE_BLOCKED, context))
+onDatabaseVersionChange((context: unknown) => dispatch(DATABASE_VERSION_CHANGE, context))
+onModelOperationError((error: unknown) => dispatch(MODEL_OPERATION_ERROR, error))
+
+const wait = async(timeout = 1000) => {
+  await new Promise<void>((resolve) => setTimeout(() => resolve(), timeout))
+}
+
+const waitForWakit = async() => {
+  let steps = 0
+  while (! initialized && steps++ < 200) {
+    await wait(10)
+  }
+
+  if (! initialized) {
+    throw new Error('Timeout while waiting. Failed to initialize Wakit')
+  }
+}
+
+const init = async (config: WakitConfig) => {
+  if (initializing || initialized) {
+    return
+  }
+
+  initializing = true
+  debug = config.debug ?? false
+
+  if (config.database) {
+    log('starting database config')
+    try {
+      await initDB(config.database)
+    } catch (err) {
+      initializing = false
+      throw err
+    }
+    dispatch(DATABASE_READY)
+  }
+
+  log('setting up network')
+  network.config({
+    onHandledError: (error) => dispatch(NETWORK_HANDLED_ERROR, error),
+    toast: config.toast,
+    handleErrors: true,
+    checkInternetConnection: !! config.network?.pingUrl,
+  })
+
+  if (!! config.network?.pingUrl) {
+    setPingUrl(config.network.pingUrl)
+  }
+
+  onNetworkOnline(() => dispatch(NETWORK_ONLINE))
+  onNetworkOffline(() => dispatch(NETWORK_OFFLINE))
+  onNetworkReconnected(() => dispatch(NETWORK_RECONNECTED))
+  onNetworkDisconnected(() => dispatch(NETWORK_DISCONNECTED))
+  onNetworkSlowConnection(() => dispatch(NETWORK_SLOW_CONNECTION))
+
+  initializing = false
+  initialized = true
+  log('ready')
+  dispatch(WAKIT_READY)
+}
+
+export {
+  wait,
+  init,
+  waitForWakit,
+}

package/package.json

@@ -1,6 +1,37 @@
-{
-  "name": "@wakit/core",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+{
+  "name": "@wakit/core",
+  "version": "0.1.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "files": [
+    "dist",
+    "**/*.ts",
+    "!tests/*"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "lint": "eslint .",
+    "typecheck": "tsc --noEmit"
+  },
+  "keywords": [
+    "pwa",
+    "webapps"
+  ],
+  "author": "Joao Matos",
+  "license": "MIT",
+  "description": "Set of tools for creating Web Applications",
+  "devDependencies": {
+    "@types/node": "^25.0.3",
+    "eslint": "^10.12.0",
+    "jiti": "^2.7.0",
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.71.1"
+  },
+  "dependencies": {
+    "@wakit/events": "^1.1.0",
+    "@wakit/networker": "^1.2.1",
+    "@wakit/waorm": "^1.3.0"
+  }
+}