@cero-base/cero 1.18.2 → 1.19.0

package/types/build/builtins.d.ts

@@ -1,14 +1,50 @@
-export function getHyperdbType(prim: any): any;
-export function builtinRefs(ns: any, scope: any): {
+export declare const refs: {
+    main: {
+        members: {
+            type: string;
+        };
+        devices: {
+            type: string;
+        };
+        invites: {
+            type: string;
+        };
+        handles: {
+            type: string;
+        };
+        files: {
+            type: string;
+        };
+    };
+    local: {
+        master: {
+            type: string;
+            kind: string;
+        };
+        keypair: {
+            type: string;
+            kind: string;
+        };
+        'handle-keypairs': {
+            type: string;
+        };
+        environment: {
+            type: string;
+            kind: string;
+        };
+    };
+};
+export declare function getHyperdbType(prim: any): any;
+export declare function builtinRefs(ns: any, scope: any): {
     [k: string]: {
-        schema: string;
-        verb: any;
         kind: any;
         path: string[];
         builtin: boolean;
+        verb: any;
+        schema: string;
     };
 };
-export function builtinTypes(scope: any, extend: any): {
+export declare function builtinTypes(scope: any, extend: any): {
     name: string;
     compact: boolean;
     fields: {
@@ -17,7 +53,7 @@ export function builtinTypes(scope: any, extend: any): {
         required: boolean;
     }[];
 }[];
-export function rpcTypes(): {
+export declare function rpcTypes(): {
     name: string;
     compact: boolean;
     fields: {
@@ -26,20 +62,20 @@ export function rpcTypes(): {
         required: boolean;
     }[];
 }[];
-export function builtinCollections(ns: any, scope: any): {
+export declare function builtinCollections(ns: any, scope: any): {
     name: string;
     schema: string;
     key: string[];
 }[];
-export function builtinDispatches(ns: any): {
+export declare function builtinDispatches(ns: any): {
     name: string;
     requestType: string;
 }[];
-export function rotateDispatch(ns: any): {
+export declare function rotateDispatch(ns: any): {
     name: string;
     requestType: string;
 };
-export function rpcCommands(ns: any): ({
+export declare function rpcCommands(ns: any): ({
     name: string;
     request: {
         name: string;
@@ -58,43 +94,3 @@ export function rpcCommands(ns: any): ({
         stream: boolean;
     };
 })[];
-export namespace refs {
-    namespace main {
-        namespace members {
-            let type: string;
-        }
-        namespace devices {
-            let type_1: string;
-            export { type_1 as type };
-        }
-        namespace invites {
-            let type_2: string;
-            export { type_2 as type };
-        }
-        namespace handles {
-            let type_3: string;
-            export { type_3 as type };
-        }
-        namespace files {
-            let type_4: string;
-            export { type_4 as type };
-        }
-    }
-    let local: {
-        master: {
-            type: string;
-            kind: string;
-        };
-        keypair: {
-            type: string;
-            kind: string;
-        };
-        'handle-keypairs': {
-            type: string;
-        };
-        environment: {
-            type: string;
-            kind: string;
-        };
-    };
-}

package/types/build/index.d.ts

@@ -1,10 +1,5 @@
-export function build(specDir: any, schema: any, { ns, extensions }?: {
-    ns?: string;
-    extensions?: boolean;
-}): Promise<void>;
-export { getHyperdbType } from "./builtins.js";
-export type Schema = import("@cero-base/core/schema").Schema;
-export type SchemaDefs = import("@cero-base/core/schema").SchemaDefs;
+export type Schema = import('@cero-base/core/schema').Schema;
+export type SchemaDefs = import('@cero-base/core/schema').SchemaDefs;
 export type SchemaInput = Schema | (SchemaDefs & {
     local?: SchemaDefs;
 });
@@ -14,3 +9,28 @@ export type BuildOpts = {
      */
     ns?: string;
 };
+/**
+ * @typedef {import('@cero-base/core/schema').Schema} Schema
+ * @typedef {import('@cero-base/core/schema').SchemaDefs} SchemaDefs
+ * @typedef {Schema | (SchemaDefs & { local?: SchemaDefs })} SchemaInput
+ *
+ * @typedef {object} BuildOpts
+ * @property {string} [ns]  Namespace prefix for emitted schema ids. Defaults to `'cero'`.
+ */
+/**
+ * Compile a cero schema into wire-level artifacts and write them to disk.
+ *
+ * Emits a `main/` tree (schema + hyperdb + dispatch + rpc), a `local/` tree
+ * for per-device data, one `handles/<name>/` tree per child handle type, and
+ * an `index.js` that re-exports a ready-to-use `spec` object.
+ *
+ * @param {string} specDir          Output directory.
+ * @param {SchemaInput} schema      Either a `schema(...)` wrapper or its raw defs object.
+ * @param {BuildOpts} [opts]
+ * @returns {Promise<void>}
+ */
+export { getHyperdbType } from './builtins.js';
+export declare function build(specDir: any, schema: any, { ns, extensions }?: {
+    extensions?: boolean;
+    ns?: string;
+}): Promise<void>;

package/types/build/schemas.d.ts

@@ -1,4 +1,4 @@
-export const main: {
+export declare const main: {
     'del-by-id': {
         id: import("@cero-base/core").Prim;
     };
@@ -80,7 +80,7 @@ export const main: {
         stamp: import("@cero-base/core").Prim;
     };
 };
-export const local: {
+export declare const local: {
     master: {
         seed: import("@cero-base/core").Prim;
     };
@@ -98,7 +98,7 @@ export const local: {
         channel: import("@cero-base/core").Prim;
     };
 };
-export const rpc: {
+export declare const rpc: {
     'req-empty': {
         ok: import("@cero-base/core").Prim;
     };

package/types/extensions/handle-sync.d.ts

@@ -9,14 +9,14 @@
  *
  * @param {{ fields?: Record<string, any> }} [opts]
  */
-export function handleSync({ fields }?: {
+export declare function handleSync({ fields }?: {
     fields?: Record<string, any>;
 }): {
     name: string;
     bundled: boolean;
     schema: {
         handles: {
-            kind: "extend";
+            kind: 'extend';
             fields: Record<string, import("@cero-base/core").Prim>;
         };
     };

package/types/extensions/index.d.ts

@@ -1,2 +1,2 @@
-export * from "./profile-sync.js";
-export * from "./handle-sync.js";
+export * from './profile-sync.js';
+export * from './handle-sync.js';

package/types/extensions/profile-sync.d.ts

@@ -7,7 +7,7 @@
  *
  * @param {{ fields?: Record<string, any> }} [opts]
  */
-export function profileSync({ fields }?: {
+export declare function profileSync({ fields }?: {
     fields?: Record<string, any>;
 }): {
     name: string;
@@ -15,7 +15,7 @@ export function profileSync({ fields }?: {
     schema: {
         profile: import("@cero-base/core").TypeDef;
         members: {
-            kind: "extend";
+            kind: 'extend';
             fields: Record<string, import("@cero-base/core").Prim>;
         };
     };

package/types/handle/index.d.ts

@@ -1,4 +1,131 @@
-export { Ref } from "../lib/utils.js";
+import AbortController from 'bare-abort-controller';
+import ReadyResource from 'ready-resource';
+import { Identity } from '@cero-base/core/identity';
+import { Database } from '@cero-base/core/database';
+import { Pairing } from '@cero-base/core/pairing';
+import { Blobs } from '@cero-base/core/blobs';
+import { FileServer } from '@cero-base/core/blobs/server';
+export { Ref } from '../lib/refs.js';
+export type Network = import('@cero-base/core/network').Network;
+export type Local = import('../local/index.js').Local;
+export type KeyPair = import('@cero-base/core/identity').KeyPair;
+export type HandleOpts = {
+    /**
+     * Parent handle when this is a child slot.
+     */
+    parent?: Handle;
+    /**
+     * Long-lived user identity. Inherited from `parent` if omitted.
+     */
+    identity?: Identity;
+    /**
+     * Shared swarm. Inherited from `parent` if omitted.
+     */
+    network?: Network;
+    /**
+     * Pre-existing Corestore. Falls back to `parent.store.store`.
+     */
+    store?: any;
+    /**
+     * Built cero spec.
+     */
+    spec?: any;
+    /**
+     * Local store for per-handle keypairs.
+     */
+    local?: Local;
+    /**
+     * Owned HypercoreStorage to close on shutdown.
+     */
+    storage?: any;
+    /**
+     * Owned identity Discovery to destroy on shutdown.
+     */
+    discovery?: any;
+    /**
+     * Data directory (root handles only).
+     */
+    dir?: string;
+    /**
+     * Pass-through cero(...) options.
+     */
+    opts?: any;
+    routes?: Record<string, Function>;
+    /**
+     * Existing database key.
+     */
+    key?: Uint8Array;
+    /**
+     * Existing encryption key.
+     */
+    encryptionKey?: Uint8Array;
+    /**
+     * Rotation epochs delivered at join.
+     */
+    epochs?: Array<{
+        epoch: number;
+        entropy: Uint8Array;
+    }>;
+    /**
+     * Corestore namespace.
+     */
+    namespace?: string;
+    /**
+     * Writer keypair.
+     */
+    keyPair?: KeyPair;
+    /**
+     * Join discovery server-only; flip later with `setActive`.
+     */
+    passive?: boolean;
+    /**
+     * When `false`, skips creating a `Pairing` session.
+     */
+    pair?: boolean;
+};
+export type CreateChildOpts = {
+    name?: string | null;
+    routes?: Record<string, Function>;
+    role?: string;
+    accept?: boolean;
+};
+export type JoinChildOpts = {
+    routes?: Record<string, Function>;
+    timeout?: number;
+};
+export type StaticJoinOpts = {
+    parent?: Handle;
+    network?: Network;
+    identity?: Identity;
+    store?: any;
+    spec?: any;
+    namespace?: string;
+    routes?: Record<string, Function>;
+    timeout?: number;
+};
+export type AcceptOpts = {
+    /**
+     * Role to grant the joining peer. Falls back to the invite's role, then `'member'`.
+     */
+    role?: string;
+    name?: string | null;
+};
+export type HandleExtra = {
+    /**
+     * Display name; set on child handles by the owner flow.
+     */
+    name?: string | null;
+    /**
+     * `profile` ref, attached dynamically when the schema declares one.
+     */
+    profile?: import('../lib/refs.js').Ref;
+    /**
+     * `members` ref, attached dynamically when the schema declares one.
+     */
+    members?: import('../lib/refs.js').Ref;
+};
+export type Child = Handle & HandleExtra;
+export type CeroHandle = Handle & Record<string, import('../lib/refs.js').Ref>;
 /**
  * @typedef {import('@cero-base/core/network').Network} Network
  * @typedef {import('../local/index.js').Local} Local
@@ -48,17 +175,14 @@ export { Ref } from "../lib/utils.js";
  * @property {string} [role]   Role to grant the joining peer. Falls back to the invite's role, then `'member'`.
  * @property {string | null} [name]
  *
- * @typedef {object} RecoverOpts
- * @property {number} [timeout]
- *
  * @typedef {object} HandleExtra
  * @property {string | null} [name]                       Display name; set on child handles by the owner flow.
- * @property {import('../lib/utils.js').Ref} [profile]    `profile` ref, attached dynamically when the schema declares one.
- * @property {import('../lib/utils.js').Ref} [members]    `members` ref, attached dynamically when the schema declares one.
+ * @property {import('../lib/refs.js').Ref} [profile]    `profile` ref, attached dynamically when the schema declares one.
+ * @property {import('../lib/refs.js').Ref} [members]    `members` ref, attached dynamically when the schema declares one.
  *
  * @typedef {Handle & HandleExtra} Child  A child handle plus its dynamically-attached refs.
  *
- * @typedef {Handle & Record<string, import('../lib/utils.js').Ref>} CeroHandle  A handle with every schema ref reachable as a `Ref` property (e.g. `me.profile`, `room.messages`).
+ * @typedef {Handle & Record<string, import('../lib/refs.js').Ref>} CeroHandle  A handle with every schema ref reachable as a `Ref` property (e.g. `me.profile`, `room.messages`).
  */
 /**
  * A cero handle — a single writable database session attached to a swarm.
@@ -67,18 +191,7 @@ export { Ref } from "../lib/utils.js";
  * network and corestore. Ref properties (`profile`, `members`, ...) are
  * attached dynamically per the schema; child handles also carry a `name`.
  */
-export class Handle extends ReadyResource {
-    /**
-     * Pair into an existing handle via an invite, returning a brand-new
-     * `Handle` already configured with the resolved key + encryption key.
-     *
-     * @param {string} invite
-     * @param {StaticJoinOpts} [opts]
-     * @returns {Promise<Handle>}
-     */
-    static join(invite: string, { parent, network, identity, store, spec, namespace, routes, timeout }?: StaticJoinOpts): Promise<Handle>;
-    /** @param {HandleOpts} [opts] */
-    constructor(opts?: HandleOpts);
+export declare class Handle extends ReadyResource {
     identity: any;
     network: any;
     spec: any;
@@ -102,6 +215,11 @@ export class Handle extends ReadyResource {
     pair: Pairing;
     _wantsPair: boolean;
     _invitesSync: () => Promise<void>;
+    _ac: AbortController;
+    /** @param {HandleOpts} [opts] */
+    constructor(opts?: HandleOpts);
+    _open(): Promise<void>;
+    _close(): Promise<void>;
     /**
      * Tie a destroyable resource (a `watch` stream, a timer, any `{ destroy }`)
      * to this handle's lifecycle — it's destroyed automatically on close, so
@@ -123,7 +241,6 @@ export class Handle extends ReadyResource {
      * @returns {AbortSignal}
      */
     get signal(): AbortSignal;
-    _ac: AbortController;
     /**
      * `EventEmitter.on` plus an optional `{ signal }` that removes the listener
      * when the signal aborts — e.g. `me.on('handle', fn, { signal: me.signal })`.
@@ -190,7 +307,7 @@ export class Handle extends ReadyResource {
     get id(): any;
     /** This device's id + name. `null` on child handles. */
     get device(): {
-        id: string;
+        id: any;
         name: any;
     };
     get suspended(): boolean;
@@ -209,14 +326,6 @@ export class Handle extends ReadyResource {
      * @returns {Promise<void>}
      */
     claim(): Promise<void>;
-    /**
-     * Claim + wait until this peer becomes a writer + bring the bee up to date.
-     * Used by `restore()` after wiping local state.
-     *
-     * @param {RecoverOpts} [opts]
-     * @returns {Promise<void>}
-     */
-    recover({ timeout }?: RecoverOpts): Promise<void>;
     /**
      * Flip this handle's swarm announce mode — `setActive(false)` demotes an
      * idle/background room to server-only (still reachable, stops searching);
@@ -324,6 +433,15 @@ export class Handle extends ReadyResource {
      */
     resume(): Promise<void>;
     _resume(): Promise<void>;
+    /**
+     * Pair into an existing handle via an invite, returning a brand-new
+     * `Handle` already configured with the resolved key + encryption key.
+     *
+     * @param {string} invite
+     * @param {StaticJoinOpts} [opts]
+     * @returns {Promise<Handle>}
+     */
+    static join(invite: string, { parent, network, identity, store, spec, namespace, routes, timeout }?: StaticJoinOpts): Promise<Handle>;
     /**
      * @param {Handle} child
      * @param {{ role?: string }} [opts]
@@ -349,139 +467,3 @@ export class Handle extends ReadyResource {
         secretKey: Uint8Array;
     } | null>;
 }
-export type Network = import("@cero-base/core/network").Network;
-export type Local = import("../local/index.js").Local;
-export type KeyPair = import("@cero-base/core/identity").KeyPair;
-export type HandleOpts = {
-    /**
-     * Parent handle when this is a child slot.
-     */
-    parent?: Handle;
-    /**
-     * Long-lived user identity. Inherited from `parent` if omitted.
-     */
-    identity?: Identity;
-    /**
-     * Shared swarm. Inherited from `parent` if omitted.
-     */
-    network?: Network;
-    /**
-     * Pre-existing Corestore. Falls back to `parent.store.store`.
-     */
-    store?: any;
-    /**
-     * Built cero spec.
-     */
-    spec?: any;
-    /**
-     * Local store for per-handle keypairs.
-     */
-    local?: Local;
-    /**
-     * Owned HypercoreStorage to close on shutdown.
-     */
-    storage?: any;
-    /**
-     * Owned identity Discovery to destroy on shutdown.
-     */
-    discovery?: any;
-    /**
-     * Data directory (root handles only).
-     */
-    dir?: string;
-    /**
-     * Pass-through cero(...) options.
-     */
-    opts?: any;
-    routes?: Record<string, Function>;
-    /**
-     * Existing database key.
-     */
-    key?: Uint8Array;
-    /**
-     * Existing encryption key.
-     */
-    encryptionKey?: Uint8Array;
-    /**
-     * Rotation epochs delivered at join.
-     */
-    epochs?: Array<{
-        epoch: number;
-        entropy: Uint8Array;
-    }>;
-    /**
-     * Corestore namespace.
-     */
-    namespace?: string;
-    /**
-     * Writer keypair.
-     */
-    keyPair?: KeyPair;
-    /**
-     * Join discovery server-only; flip later with `setActive`.
-     */
-    passive?: boolean;
-    /**
-     * When `false`, skips creating a `Pairing` session.
-     */
-    pair?: boolean;
-};
-export type CreateChildOpts = {
-    name?: string | null;
-    routes?: Record<string, Function>;
-    role?: string;
-    accept?: boolean;
-};
-export type JoinChildOpts = {
-    routes?: Record<string, Function>;
-    timeout?: number;
-};
-export type StaticJoinOpts = {
-    parent?: Handle;
-    network?: Network;
-    identity?: Identity;
-    store?: any;
-    spec?: any;
-    namespace?: string;
-    routes?: Record<string, Function>;
-    timeout?: number;
-};
-export type AcceptOpts = {
-    /**
-     * Role to grant the joining peer. Falls back to the invite's role, then `'member'`.
-     */
-    role?: string;
-    name?: string | null;
-};
-export type RecoverOpts = {
-    timeout?: number;
-};
-export type HandleExtra = {
-    /**
-     * Display name; set on child handles by the owner flow.
-     */
-    name?: string | null;
-    /**
-     * `profile` ref, attached dynamically when the schema declares one.
-     */
-    profile?: import("../lib/utils.js").Ref;
-    /**
-     * `members` ref, attached dynamically when the schema declares one.
-     */
-    members?: import("../lib/utils.js").Ref;
-};
-/**
- * A child handle plus its dynamically-attached refs.
- */
-export type Child = Handle & HandleExtra;
-/**
- * A handle with every schema ref reachable as a `Ref` property (e.g. `me.profile`, `room.messages`).
- */
-export type CeroHandle = Handle & Record<string, import("../lib/utils.js").Ref>;
-import ReadyResource from 'ready-resource';
-import { FileServer } from '@cero-base/core/blobs/server';
-import { Blobs } from '@cero-base/core/blobs';
-import { Database } from '@cero-base/core/database';
-import { Pairing } from '@cero-base/core/pairing';
-import AbortController from 'bare-abort-controller';
-import { Identity } from '@cero-base/core/identity';