@dartsee/plugin-sdk 0.0.1 → 0.0.3

package/README.md

@@ -11,8 +11,6 @@ const session = await dartsee.session.get()
 const off = dartsee.on('gameEnd', (game) => { /* ... */ })
 ```
 
-Script tag: `https://cdn.jsdelivr.net/npm/@dartsee/plugin-sdk@<version>/dist/plugin-sdk.iife.js` → global `DartseeSDK`.
-
 ## Your page runs with an opaque origin
 
 The iframe is `sandbox="allow-scripts allow-forms"`, without `allow-same-origin`. That means:

package/dist/manifest.d.ts

@@ -8,6 +8,7 @@ export interface ConfigField {
 export interface Manifest {
     id: string;
     name: string;
+    description: string;
     icon: string;
     label: {
         en: string;

package/dist/plugin-sdk.es.js

@@ -13,17 +13,17 @@ function I({ timeout: r = _ } = {}) {
   if (e === window)
     return Promise.reject(new g("HOST_ERROR", "Not inside the Dartsee host (no parent frame)"));
   const i = /* @__PURE__ */ new Map(), t = /* @__PURE__ */ new Map();
-  let u = 0;
-  const o = (n, l, s = {}) => {
-    if (!l.capabilities.includes(n))
-      return Promise.reject(new g("UNSUPPORTED", `Host ${l.hostVersion} does not support ${n}`));
-    const E = s.timeout ?? _, c = String(++u), p = $(n, c), a = k(n, c);
+  let E = 0;
+  const o = (n, d, s = {}) => {
+    if (!d.capabilities.includes(n))
+      return Promise.reject(new g("UNSUPPORTED", `Host ${d.hostVersion} does not support ${n}`));
+    const u = s.timeout ?? _, c = String(++E), p = $(n, c), a = k(n, c);
     return new Promise((T, y) => {
       const f = () => {
         clearTimeout(h), i.delete(p), i.delete(a);
       }, h = setTimeout(() => {
-        f(), y(new g("TIMEOUT", `${n} timed out after ${E} ms`));
-      }, E);
+        f(), y(new g("TIMEOUT", `${n} timed out after ${u} ms`));
+      }, u);
       i.set(p, (R) => {
         f(), T(R.data);
       }), i.set(a, (R) => {
@@ -33,26 +33,26 @@ function I({ timeout: r = _ } = {}) {
       }), e.postMessage({ id: n, nonce: c }, "*");
     });
   }, v = (n) => {
-    let l;
+    let d;
     return {
       context: n,
       session: { get: (s) => o(m.SESSION_GET, n, s) },
       game: { get: (s) => o(m.GAME_GET, n, s) },
       auth: {
         async getToken(s) {
-          return (!l || l.expiresAt - Date.now() < G) && (l = await o(m.AUTH_GET_TOKEN, n, s)), l.token;
+          return (!d || d.expiresAt - Date.now() < G) && (d = await o(m.AUTH_GET_TOKEN, n, s)), d.token;
         }
       },
-      on(s, E) {
+      on(s, u) {
         const c = t.get(s) ?? /* @__PURE__ */ new Set();
-        return t.set(s, c), c.add(E), () => c.delete(E);
+        return t.set(s, c), c.add(u), () => c.delete(u);
       }
     };
   };
-  return new Promise((n, l) => {
+  return new Promise((n, d) => {
     let s = !1;
-    const E = setTimeout(() => {
-      window.removeEventListener("message", c), l(new g("TIMEOUT", `Host did not answer within ${r} ms`));
+    const u = setTimeout(() => {
+      window.removeEventListener("message", c), d(new g("TIMEOUT", `Host did not answer within ${r} ms`));
     }, r);
     function c(p) {
       if (p.source !== e)
@@ -62,7 +62,7 @@ function I({ timeout: r = _ } = {}) {
         if (!s) {
           if (a.id !== b)
             return;
-          s = !0, clearTimeout(E), n(v(a.data));
+          s = !0, clearTimeout(u), n(v(a.data));
           return;
         }
         if (a.id === A) {
@@ -82,20 +82,20 @@ function I({ timeout: r = _ } = {}) {
     window.addEventListener("message", c), e.postMessage({ id: N }, "*");
   });
 }
-const O = ["dialog", "side", "full"], d = (r) => typeof r == "string" && r.trim() !== "", w = (r) => {
+const O = ["dialog", "side", "full"], l = (r) => typeof r == "string" && r.trim() !== "", w = (r) => {
   try {
-    return d(r) && new URL(r).protocol === "https:";
+    return l(r) && new URL(r).protocol === "https:";
   } catch {
     return !1;
   }
-}, U = (r) => Array.isArray(r) && r.every(d);
+}, U = (r) => Array.isArray(r) && r.every(l);
 function D(r) {
-  const e = r ?? {}, i = [], t = (u, o) => u || i.push(o);
-  if (t(d(e.id) && /^[a-z0-9][a-z0-9-]*$/.test(e.id), "id: lowercase letters, digits and dashes"), t(d(e.name), "name: required"), t(w(e.icon), "icon: https URL"), t(d(e.label?.en), "label.en: required"), t(e.label == null || Object.values(e.label).every(d), "label: every value a non-empty string"), t(w(e.entryUrl), "entryUrl: https URL"), t(U(e.scopes), "scopes: array of strings"), t(e.allow === void 0 || U(e.allow), "allow: array of strings"), t(O.includes(e.size), `size: one of ${O.join(", ")}`), t(e.background === void 0 || typeof e.background == "boolean", "background: boolean"), t(e.verifyUrl === void 0 || w(e.verifyUrl), "verifyUrl: https URL"), t(d(e.support), "support: required"), t(w(e.privacyUrl), "privacyUrl: https URL"), e.config !== void 0) {
-    const u = Array.isArray(e.config) && e.config.every(
-      (o) => d(o?.key) && d(o?.label) && (o.secret === void 0 || typeof o.secret == "boolean")
+  const e = r ?? {}, i = [], t = (E, o) => E || i.push(o);
+  if (t(l(e.id) && /^[a-z0-9][a-z0-9-]*$/.test(e.id), "id: lowercase letters, digits and dashes"), t(l(e.name), "name: required"), t(l(e.description), "description: required"), t(w(e.icon), "icon: https URL"), t(l(e.label?.en), "label.en: required"), t(e.label == null || Object.values(e.label).every(l), "label: every value a non-empty string"), t(w(e.entryUrl), "entryUrl: https URL"), t(U(e.scopes), "scopes: array of strings"), t(e.allow === void 0 || U(e.allow), "allow: array of strings"), t(O.includes(e.size), `size: one of ${O.join(", ")}`), t(e.background === void 0 || typeof e.background == "boolean", "background: boolean"), t(e.verifyUrl === void 0 || w(e.verifyUrl), "verifyUrl: https URL"), t(l(e.support), "support: required"), t(w(e.privacyUrl), "privacyUrl: https URL"), e.config !== void 0) {
+    const E = Array.isArray(e.config) && e.config.every(
+      (o) => l(o?.key) && l(o?.label) && (o.secret === void 0 || typeof o.secret == "boolean")
     );
-    t(u, "config: array of { key, label, secret? }"), t(u && new Set(e.config.map((o) => o.key)).size === e.config.length, "config: duplicate key");
+    t(E, "config: array of { key, label, secret? }"), t(E && new Set(e.config.map((o) => o.key)).size === e.config.length, "config: duplicate key");
   }
   if (i.length)
     throw new Error(`Invalid manifest:

package/dist/plugin-sdk.iife.js

@@ -1,3 +1,3 @@
-var DartseeSDK=function(s){"use strict";class f extends Error{constructor(e,i){super(i),this.code=e,this.name="DartseeError"}}const _="CONNECT",v="READY",U="EVENT",g={SESSION_GET:"SESSION_GET",GAME_GET:"GAME_GET",AUTH_GET_TOKEN:"AUTH_GET_TOKEN"},D=Object.values(g),N=(r,e)=>`${r}_RESPONSE_${e}`,b=(r,e)=>`${r}_ERROR_${e}`,A=1e4,$=3e4;function k({timeout:r=A}={}){const e=window.parent;if(e===window)return Promise.reject(new f("HOST_ERROR","Not inside the Dartsee host (no parent frame)"));const i=new Map,t=new Map;let T=0;const a=(n,E,o={})=>{if(!E.capabilities.includes(n))return Promise.reject(new f("UNSUPPORTED",`Host ${E.hostVersion} does not support ${n}`));const u=o.timeout??A,l=String(++T),y=N(n,l),c=b(n,l);return new Promise((S,p)=>{const w=()=>{clearTimeout(h),i.delete(y),i.delete(c)},h=setTimeout(()=>{w(),p(new f("TIMEOUT",`${n} timed out after ${u} ms`))},u);i.set(y,O=>{w(),S(O.data)}),i.set(c,O=>{w();const M=O.data;p(new f(M?.code??"HOST_ERROR",M?.message??`${n} failed`))}),e.postMessage({id:n,nonce:l},"*")})},P=n=>{let E;return{context:n,session:{get:o=>a(g.SESSION_GET,n,o)},game:{get:o=>a(g.GAME_GET,n,o)},auth:{async getToken(o){return(!E||E.expiresAt-Date.now()<$)&&(E=await a(g.AUTH_GET_TOKEN,n,o)),E.token}},on(o,u){const l=t.get(o)??new Set;return t.set(o,l),l.add(u),()=>l.delete(u)}}};return new Promise((n,E)=>{let o=!1;const u=setTimeout(()=>{window.removeEventListener("message",l),E(new f("TIMEOUT",`Host did not answer within ${r} ms`))},r);function l(y){if(y.source!==e)return;const c=y.data;if(!(!c||typeof c.id!="string")){if(!o){if(c.id!==v)return;o=!0,clearTimeout(u),n(P(c.data));return}if(c.id===U){const{name:S,payload:p}=c.data??{};t.get(S)?.forEach(w=>{try{w(p)}catch(h){console.error(`[dartsee] ${S} listener threw`,h)}});return}i.get(c.id)?.(c)}}window.addEventListener("message",l),e.postMessage({id:_},"*")})}const R=["dialog","side","full"],d=r=>typeof r=="string"&&r.trim()!=="",m=r=>{try{return d(r)&&new URL(r).protocol==="https:"}catch{return!1}},I=r=>Array.isArray(r)&&r.every(d);function G(r){const e=r??{},i=[],t=(T,a)=>T||i.push(a);if(t(d(e.id)&&/^[a-z0-9][a-z0-9-]*$/.test(e.id),"id: lowercase letters, digits and dashes"),t(d(e.name),"name: required"),t(m(e.icon),"icon: https URL"),t(d(e.label?.en),"label.en: required"),t(e.label==null||Object.values(e.label).every(d),"label: every value a non-empty string"),t(m(e.entryUrl),"entryUrl: https URL"),t(I(e.scopes),"scopes: array of strings"),t(e.allow===void 0||I(e.allow),"allow: array of strings"),t(R.includes(e.size),`size: one of ${R.join(", ")}`),t(e.background===void 0||typeof e.background=="boolean","background: boolean"),t(e.verifyUrl===void 0||m(e.verifyUrl),"verifyUrl: https URL"),t(d(e.support),"support: required"),t(m(e.privacyUrl),"privacyUrl: https URL"),e.config!==void 0){const T=Array.isArray(e.config)&&e.config.every(a=>d(a?.key)&&d(a?.label)&&(a.secret===void 0||typeof a.secret=="boolean"));t(T,"config: array of { key, label, secret? }"),t(T&&new Set(e.config.map(a=>a.key)).size===e.config.length,"config: duplicate key")}if(i.length)throw new Error(`Invalid manifest:
-- ${i.join(`
+var DartseeSDK=function(s){"use strict";class f extends Error{constructor(e,a){super(a),this.code=e,this.name="DartseeError"}}const _="CONNECT",v="READY",U="EVENT",g={SESSION_GET:"SESSION_GET",GAME_GET:"GAME_GET",AUTH_GET_TOKEN:"AUTH_GET_TOKEN"},D=Object.values(g),N=(r,e)=>`${r}_RESPONSE_${e}`,b=(r,e)=>`${r}_ERROR_${e}`,A=1e4,$=3e4;function k({timeout:r=A}={}){const e=window.parent;if(e===window)return Promise.reject(new f("HOST_ERROR","Not inside the Dartsee host (no parent frame)"));const a=new Map,t=new Map;let T=0;const i=(n,E,o={})=>{if(!E.capabilities.includes(n))return Promise.reject(new f("UNSUPPORTED",`Host ${E.hostVersion} does not support ${n}`));const u=o.timeout??A,d=String(++T),y=N(n,d),c=b(n,d);return new Promise((p,S)=>{const w=()=>{clearTimeout(h),a.delete(y),a.delete(c)},h=setTimeout(()=>{w(),S(new f("TIMEOUT",`${n} timed out after ${u} ms`))},u);a.set(y,O=>{w(),p(O.data)}),a.set(c,O=>{w();const M=O.data;S(new f(M?.code??"HOST_ERROR",M?.message??`${n} failed`))}),e.postMessage({id:n,nonce:d},"*")})},P=n=>{let E;return{context:n,session:{get:o=>i(g.SESSION_GET,n,o)},game:{get:o=>i(g.GAME_GET,n,o)},auth:{async getToken(o){return(!E||E.expiresAt-Date.now()<$)&&(E=await i(g.AUTH_GET_TOKEN,n,o)),E.token}},on(o,u){const d=t.get(o)??new Set;return t.set(o,d),d.add(u),()=>d.delete(u)}}};return new Promise((n,E)=>{let o=!1;const u=setTimeout(()=>{window.removeEventListener("message",d),E(new f("TIMEOUT",`Host did not answer within ${r} ms`))},r);function d(y){if(y.source!==e)return;const c=y.data;if(!(!c||typeof c.id!="string")){if(!o){if(c.id!==v)return;o=!0,clearTimeout(u),n(P(c.data));return}if(c.id===U){const{name:p,payload:S}=c.data??{};t.get(p)?.forEach(w=>{try{w(S)}catch(h){console.error(`[dartsee] ${p} listener threw`,h)}});return}a.get(c.id)?.(c)}}window.addEventListener("message",d),e.postMessage({id:_},"*")})}const R=["dialog","side","full"],l=r=>typeof r=="string"&&r.trim()!=="",m=r=>{try{return l(r)&&new URL(r).protocol==="https:"}catch{return!1}},I=r=>Array.isArray(r)&&r.every(l);function G(r){const e=r??{},a=[],t=(T,i)=>T||a.push(i);if(t(l(e.id)&&/^[a-z0-9][a-z0-9-]*$/.test(e.id),"id: lowercase letters, digits and dashes"),t(l(e.name),"name: required"),t(l(e.description),"description: required"),t(m(e.icon),"icon: https URL"),t(l(e.label?.en),"label.en: required"),t(e.label==null||Object.values(e.label).every(l),"label: every value a non-empty string"),t(m(e.entryUrl),"entryUrl: https URL"),t(I(e.scopes),"scopes: array of strings"),t(e.allow===void 0||I(e.allow),"allow: array of strings"),t(R.includes(e.size),`size: one of ${R.join(", ")}`),t(e.background===void 0||typeof e.background=="boolean","background: boolean"),t(e.verifyUrl===void 0||m(e.verifyUrl),"verifyUrl: https URL"),t(l(e.support),"support: required"),t(m(e.privacyUrl),"privacyUrl: https URL"),e.config!==void 0){const T=Array.isArray(e.config)&&e.config.every(i=>l(i?.key)&&l(i?.label)&&(i.secret===void 0||typeof i.secret=="boolean"));t(T,"config: array of { key, label, secret? }"),t(T&&new Set(e.config.map(i=>i.key)).size===e.config.length,"config: duplicate key")}if(a.length)throw new Error(`Invalid manifest:
+- ${a.join(`
 - `)}`);return e}return s.CONNECT=_,s.DartseeError=f,s.EVENT=U,s.READY=v,s.RPC=g,s.RPC_IDS=D,s.SIZES=R,s.connect=k,s.errorId=b,s.responseId=N,s.validateManifest=G,Object.defineProperty(s,Symbol.toStringTag,{value:"Module"}),s}({});

package/dist/protocol.d.ts

@@ -5,7 +5,6 @@ export interface Message<T = unknown> {
     data?: T;
     nonce?: string;
 }
-/** The host answers every CONNECT with READY, not just the first, so a late-loading plugin can't miss it. */
 export declare const CONNECT = "CONNECT";
 export declare const READY = "READY";
 export declare const EVENT = "EVENT";
@@ -15,7 +14,6 @@ export declare const RPC: {
     readonly AUTH_GET_TOKEN: "AUTH_GET_TOKEN";
 };
 export type RpcId = (typeof RPC)[keyof typeof RPC];
-/** The host's allowlist: any other id does nothing. */
 export declare const RPC_IDS: readonly RpcId[];
 export declare const responseId: (id: string, nonce: string) => string;
 export declare const errorId: (id: string, nonce: string) => string;
@@ -36,7 +34,6 @@ export interface Context {
 export interface SessionInfo {
     active: boolean;
     controlMode: string;
-    /** epoch ms; absent for open-ended sessions */
     endsAt?: number;
     playerCount: number;
 }
@@ -46,7 +43,6 @@ export interface GameInfo {
 }
 export interface TokenInfo {
     token: string;
-    /** epoch ms */
     expiresAt: number;
 }
 export interface EventMap {

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@dartsee/plugin-sdk",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "SDK for Dartsee Game Controller plugins",
   "license": "MIT",
+  "homepage": "https://apidocs.dartsee.com",
   "repository": {
     "type": "git",
     "url": "git+https://gitlab.com/dartsee/games-monorepo.git",