@idosgames/module-sdk 0.9.0 → 0.10.1

package/dist/index.cjs

@@ -1 +1 @@
-'use strict';var x=/^[a-z0-9][a-z0-9-]*:[a-z0-9][a-z0-9-]*@[1-9]\d*$/;function S(e){return typeof e=="string"&&x.test(e)}function T(e){let t=e.indexOf(":");return t<0?"":e.slice(0,t)}var c=/^(string|number|boolean)(\[\])?(\?)?$/;function u(e){return typeof e=="object"&&e!==null&&!Array.isArray(e)}function l(e,t){return e==="number"?typeof t=="number"&&Number.isFinite(t):typeof t===e}function f(e,t,r){if(!u(t))return `${r||"payload"} must be an object`;for(let[n,o]of Object.entries(e)){let i=r?`${r}.${n}`:n,a=t[n];if(typeof o!="string"){let p=f(o,a,i);if(p)return p;continue}let d=c.exec(o);if(!d)return `${i}: invalid descriptor "${o}"`;let[,s="",g,m]=d;if(a===void 0){if(m)continue;return `${i} is missing`}if(g){if(!Array.isArray(a))return `${i} must be ${s}[]`;if(!a.every(p=>l(s,p)))return `${i} must contain only ${s} values`;continue}if(!l(s,a))return `${i} must be a ${s}`}return null}function y(e,t){for(let[r,n]of Object.entries(e)){let o=t?`${t}.${r}`:r;if(typeof n=="string"){if(!c.test(n))throw new Error(`shape(): field "${o}" has invalid type "${n}" \u2014 use "string" | "number" | "boolean", optionally with "[]" and/or a trailing "?"`)}else if(u(n))y(n,o);else throw new Error(`shape(): field "${o}" must be a type string or an object`)}}function h(e){return y(e,""),{descriptor:e,check:t=>f(e,t,"")}}function v(e,t){if(!S(e))throw new Error(`defineTopic(): "${e}" is not a valid topic name \u2014 expected "<module-id>:<event>@<major>", e.g. "idle-rpg:character-upgraded@1"`);return {name:e,shape:t}}var b={modeChanged:v("host:mode-changed@1",h({from:"string?",to:"string"}))};var M=["currency-bar","wallet","status","account","menu","modes"];function R(e){return typeof e=="string"&&M.includes(e)}function D(e){return e}exports.SHARED_UI_ROLES=M;exports.TOPIC_NAME_RE=x;exports.defineModule=D;exports.defineTopic=v;exports.hostTopics=b;exports.isSharedUiRole=R;exports.isTopicName=S;exports.shape=h;exports.topicNamespace=T;
+'use strict';var x=/^[a-z0-9][a-z0-9-]*:[a-z0-9][a-z0-9-]*@[1-9]\d*$/;function S(e){return typeof e=="string"&&x.test(e)}function b(e){let t=e.indexOf(":");return t<0?"":e.slice(0,t)}var c=/^(string|number|boolean)(\[\])?(\?)?$/;function u(e){return typeof e=="object"&&e!==null&&!Array.isArray(e)}function l(e,t){return e==="number"?typeof t=="number"&&Number.isFinite(t):typeof t===e}function f(e,t,r){if(!u(t))return `${r||"payload"} must be an object`;for(let[n,o]of Object.entries(e)){let i=r?`${r}.${n}`:n,a=t[n];if(typeof o!="string"){let p=f(o,a,i);if(p)return p;continue}let d=c.exec(o);if(!d)return `${i}: invalid descriptor "${o}"`;let[,s="",g,m]=d;if(a===void 0){if(m)continue;return `${i} is missing`}if(g){if(!Array.isArray(a))return `${i} must be ${s}[]`;if(!a.every(p=>l(s,p)))return `${i} must contain only ${s} values`;continue}if(!l(s,a))return `${i} must be a ${s}`}return null}function y(e,t){for(let[r,n]of Object.entries(e)){let o=t?`${t}.${r}`:r;if(typeof n=="string"){if(!c.test(n))throw new Error(`shape(): field "${o}" has invalid type "${n}" \u2014 use "string" | "number" | "boolean", optionally with "[]" and/or a trailing "?"`)}else if(u(n))y(n,o);else throw new Error(`shape(): field "${o}" must be a type string or an object`)}}function h(e){return y(e,""),{descriptor:e,check:t=>f(e,t,"")}}function v(e,t){if(!S(e))throw new Error(`defineTopic(): "${e}" is not a valid topic name \u2014 expected "<module-id>:<event>@<major>", e.g. "idle-rpg:character-upgraded@1"`);return {name:e,shape:t}}var T={modeChanged:v("host:mode-changed@1",h({from:"string?",to:"string"}))};var M=["currency-bar","wallet","status","account","menu","modes"];function R(e){return typeof e=="string"&&M.includes(e)}function D(e){return e}exports.SHARED_UI_ROLES=M;exports.TOPIC_NAME_RE=x;exports.defineModule=D;exports.defineTopic=v;exports.hostTopics=T;exports.isSharedUiRole=R;exports.isTopicName=S;exports.shape=h;exports.topicNamespace=b;

package/dist/index.d.cts

@@ -594,6 +594,19 @@ interface ModuleContext {
     registerPanel(panel: UiPanel): void;
     /** Register a nav / mode entry so the player can switch to this module. */
     registerRoute(entry: RouteEntry): void;
+    /**
+     * Runs `run` now and keeps what it started alive until the module is torn down (logout, a new
+     * login): the function it returns is called then. Use it for background work that needs no screen -
+     * keeping a menu badge in step with the player's state (`client.on("user:anyUpdated", …)` returns
+     * its unsubscribe, return that), a timer, a document listener. Do not mount a hidden React panel
+     * for this.
+     */
+    effect(run: () => void | (() => void)): void;
+    /**
+     * Calls `run` now and then every `ms` milliseconds until the module is torn down - the polling
+     * form of `effect`, with the timer cleared for you.
+     */
+    every(ms: number, run: () => void): void;
     /**
      * Content types other modules can publish and open (see `ContentTypeHandler`). A game registers
      * its type here; the Workshop module reads the registry — neither imports the other.
@@ -773,6 +786,13 @@ interface RouteEntry {
     /** Optional icon (emoji or short glyph the host nav renders). */
     icon?: string;
     order?: number;
+    /**
+     * A game that lives INSIDE the lobby: the base keeps the lobby's balances on top and its tabs at
+     * the bottom around it, "Play" is this game, and the app starts in it after sign-in (idle-rpg).
+     * Without it (the default) a game takes the whole screen, launched by "Play" in the lobby, with a
+     * small button back (voxelcraft, board-game).
+     */
+    inLobby?: boolean;
 }
 /** A mode of the app as every module sees it (`ctx.modes`): a registered route plus its owner. */
 interface ModeEntry {
@@ -785,6 +805,8 @@ interface ModeEntry {
     moduleId: string;
     /** That module's `meta.type` — a lobby offers "Play" for `game` modes. */
     moduleType: ModuleType;
+    /** The route's `inLobby`: the game sits inside the lobby rather than taking the whole screen. */
+    inLobby?: boolean;
 }
 /** `ctx.modes` — the modes of the app, live. Switch with `ctx.navigate(id)`. */
 interface ModeRegistry {

package/dist/index.d.ts

@@ -594,6 +594,19 @@ interface ModuleContext {
     registerPanel(panel: UiPanel): void;
     /** Register a nav / mode entry so the player can switch to this module. */
     registerRoute(entry: RouteEntry): void;
+    /**
+     * Runs `run` now and keeps what it started alive until the module is torn down (logout, a new
+     * login): the function it returns is called then. Use it for background work that needs no screen -
+     * keeping a menu badge in step with the player's state (`client.on("user:anyUpdated", …)` returns
+     * its unsubscribe, return that), a timer, a document listener. Do not mount a hidden React panel
+     * for this.
+     */
+    effect(run: () => void | (() => void)): void;
+    /**
+     * Calls `run` now and then every `ms` milliseconds until the module is torn down - the polling
+     * form of `effect`, with the timer cleared for you.
+     */
+    every(ms: number, run: () => void): void;
     /**
      * Content types other modules can publish and open (see `ContentTypeHandler`). A game registers
      * its type here; the Workshop module reads the registry — neither imports the other.
@@ -773,6 +786,13 @@ interface RouteEntry {
     /** Optional icon (emoji or short glyph the host nav renders). */
     icon?: string;
     order?: number;
+    /**
+     * A game that lives INSIDE the lobby: the base keeps the lobby's balances on top and its tabs at
+     * the bottom around it, "Play" is this game, and the app starts in it after sign-in (idle-rpg).
+     * Without it (the default) a game takes the whole screen, launched by "Play" in the lobby, with a
+     * small button back (voxelcraft, board-game).
+     */
+    inLobby?: boolean;
 }
 /** A mode of the app as every module sees it (`ctx.modes`): a registered route plus its owner. */
 interface ModeEntry {
@@ -785,6 +805,8 @@ interface ModeEntry {
     moduleId: string;
     /** That module's `meta.type` — a lobby offers "Play" for `game` modes. */
     moduleType: ModuleType;
+    /** The route's `inLobby`: the game sits inside the lobby rather than taking the whole screen. */
+    inLobby?: boolean;
 }
 /** `ctx.modes` — the modes of the app, live. Switch with `ctx.navigate(id)`. */
 interface ModeRegistry {

package/dist/index.js

@@ -1 +1 @@
-var x=/^[a-z0-9][a-z0-9-]*:[a-z0-9][a-z0-9-]*@[1-9]\d*$/;function S(e){return typeof e=="string"&&x.test(e)}function T(e){let t=e.indexOf(":");return t<0?"":e.slice(0,t)}var c=/^(string|number|boolean)(\[\])?(\?)?$/;function u(e){return typeof e=="object"&&e!==null&&!Array.isArray(e)}function l(e,t){return e==="number"?typeof t=="number"&&Number.isFinite(t):typeof t===e}function f(e,t,r){if(!u(t))return `${r||"payload"} must be an object`;for(let[n,o]of Object.entries(e)){let i=r?`${r}.${n}`:n,a=t[n];if(typeof o!="string"){let p=f(o,a,i);if(p)return p;continue}let d=c.exec(o);if(!d)return `${i}: invalid descriptor "${o}"`;let[,s="",g,m]=d;if(a===void 0){if(m)continue;return `${i} is missing`}if(g){if(!Array.isArray(a))return `${i} must be ${s}[]`;if(!a.every(p=>l(s,p)))return `${i} must contain only ${s} values`;continue}if(!l(s,a))return `${i} must be a ${s}`}return null}function y(e,t){for(let[r,n]of Object.entries(e)){let o=t?`${t}.${r}`:r;if(typeof n=="string"){if(!c.test(n))throw new Error(`shape(): field "${o}" has invalid type "${n}" \u2014 use "string" | "number" | "boolean", optionally with "[]" and/or a trailing "?"`)}else if(u(n))y(n,o);else throw new Error(`shape(): field "${o}" must be a type string or an object`)}}function h(e){return y(e,""),{descriptor:e,check:t=>f(e,t,"")}}function v(e,t){if(!S(e))throw new Error(`defineTopic(): "${e}" is not a valid topic name \u2014 expected "<module-id>:<event>@<major>", e.g. "idle-rpg:character-upgraded@1"`);return {name:e,shape:t}}var b={modeChanged:v("host:mode-changed@1",h({from:"string?",to:"string"}))};var M=["currency-bar","wallet","status","account","menu","modes"];function R(e){return typeof e=="string"&&M.includes(e)}function D(e){return e}export{M as SHARED_UI_ROLES,x as TOPIC_NAME_RE,D as defineModule,v as defineTopic,b as hostTopics,R as isSharedUiRole,S as isTopicName,h as shape,T as topicNamespace};
+var x=/^[a-z0-9][a-z0-9-]*:[a-z0-9][a-z0-9-]*@[1-9]\d*$/;function S(e){return typeof e=="string"&&x.test(e)}function b(e){let t=e.indexOf(":");return t<0?"":e.slice(0,t)}var c=/^(string|number|boolean)(\[\])?(\?)?$/;function u(e){return typeof e=="object"&&e!==null&&!Array.isArray(e)}function l(e,t){return e==="number"?typeof t=="number"&&Number.isFinite(t):typeof t===e}function f(e,t,r){if(!u(t))return `${r||"payload"} must be an object`;for(let[n,o]of Object.entries(e)){let i=r?`${r}.${n}`:n,a=t[n];if(typeof o!="string"){let p=f(o,a,i);if(p)return p;continue}let d=c.exec(o);if(!d)return `${i}: invalid descriptor "${o}"`;let[,s="",g,m]=d;if(a===void 0){if(m)continue;return `${i} is missing`}if(g){if(!Array.isArray(a))return `${i} must be ${s}[]`;if(!a.every(p=>l(s,p)))return `${i} must contain only ${s} values`;continue}if(!l(s,a))return `${i} must be a ${s}`}return null}function y(e,t){for(let[r,n]of Object.entries(e)){let o=t?`${t}.${r}`:r;if(typeof n=="string"){if(!c.test(n))throw new Error(`shape(): field "${o}" has invalid type "${n}" \u2014 use "string" | "number" | "boolean", optionally with "[]" and/or a trailing "?"`)}else if(u(n))y(n,o);else throw new Error(`shape(): field "${o}" must be a type string or an object`)}}function h(e){return y(e,""),{descriptor:e,check:t=>f(e,t,"")}}function v(e,t){if(!S(e))throw new Error(`defineTopic(): "${e}" is not a valid topic name \u2014 expected "<module-id>:<event>@<major>", e.g. "idle-rpg:character-upgraded@1"`);return {name:e,shape:t}}var T={modeChanged:v("host:mode-changed@1",h({from:"string?",to:"string"}))};var M=["currency-bar","wallet","status","account","menu","modes"];function R(e){return typeof e=="string"&&M.includes(e)}function D(e){return e}export{M as SHARED_UI_ROLES,x as TOPIC_NAME_RE,D as defineModule,v as defineTopic,T as hostTopics,R as isSharedUiRole,S as isTopicName,h as shape,b as topicNamespace};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@idosgames/module-sdk",
-  "version": "0.9.0",
+  "version": "0.10.1",
   "description": "The composable-module contract for the iDosGames host shell: Module / ModuleContext types plus tiny authoring helpers. Framework-neutral at runtime — a module can be a game (Three/Phaser), a plain app, or an AI app.",
   "type": "module",
   "license": "MIT",