@telemetryos/root-sdk 1.0.1 → 1.2.0

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @telemetryos/root-sdk
+
+## 1.2.0
+
+### Minor Changes
+
+- Added setDependencies to applications api

package/dist/applications.d.ts

@@ -10,6 +10,10 @@ export type Application = {
 export type GetUrlResult = {
     url: string;
 };
+export type SetDependenciesResult = {
+    ready: string[];
+    unavailable: string[];
+};
 export declare class Applications {
     _client: Client;
     constructor(client: Client);
@@ -39,17 +43,23 @@ export declare class Applications {
      */
     getByName(name: string): Promise<Application | null>;
     /**
-     * Generates a URL for embedding an application with the specified name and mount point.
+     * Sets the dependencies for the current application.
+     *
+     * This method allows an application to declare which other applications it depends on.
+     * The player will download and prepare these dependencies before they can be loaded.
      *
-     * This method returns a URL that can be used in an iframe src attribute to embed
-     * the application. The URL includes necessary parameters for the application to
-     * understand its context and communicate with the platform.
+     * IMPORTANT: This method must be called and awaited before loading any sub-applications
+     * in iframes. Only applications that return as 'ready' should be loaded.
      *
-     * Only applications that are associated with the current account can be retrieved.
+     * @param applicationSpecifiers An array of application specifiers that this application depends on
+     * @returns A promise that resolves with arrays of ready and unavailable application specifiers
      *
-     * @param name The name of the application to get the URL for
-     * @param mountPoint The mount point to use when embedding the application
-     * @returns A promise that resolves to the URL string for embedding the application
+     * @example
+     * ```typescript
+     * const result = await client.applications.setDependencies(['app1-hash', 'app2-hash'])
+     * // result.ready: ['app1-hash'] - these can be loaded in iframes
+     * // result.unavailable: ['app2-hash'] - these failed to load
+     * ```
      */
-    getUrl(name: string, mountPoint: string): Promise<string>;
+    setDependencies(applicationSpecifiers: string[]): Promise<SetDependenciesResult>;
 }

package/dist/bridge.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./index-JDXm3DEz.cjs");const a=e.z.object({telemetrySdkVersion:e.z.string(),applicationName:e.z.string(),name:e.z.string(),data:e.z.any(),responseName:e.z.string().optional(),subscriptionName:e.z.string().optional(),unsubscribeName:e.z.string().optional()});class r{bind(){this._windowMessageHandler=n=>{var s;if(n.source===window)return;const i=a.safeParse(n.data);if(!i.success)return;const t=i.data;(s=this.onMessage)===null||s===void 0||s.call(this,t)},window.addEventListener("message",this._windowMessageHandler)}unbind(){this._windowMessageHandler&&window.removeEventListener("message",this._windowMessageHandler)}send(n){for(let s=0;s<window.frames.length;s+=1)window.frames[s].postMessage(n,"*")}}exports.Bridge=r;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./index-JDXm3DEz.cjs");const a=e.z.object({telemetrySdkVersion:e.z.string(),applicationName:e.z.string(),applicationSpecifier:e.z.string(),applicationInstance:e.z.string(),name:e.z.string(),data:e.z.any(),responseName:e.z.string().optional(),subscriptionName:e.z.string().optional(),unsubscribeName:e.z.string().optional()});class r{bind(){this._windowMessageHandler=i=>{var s;if(i.source===window)return;const n=a.safeParse(i.data);if(!n.success)return;const t=n.data;(s=this.onMessage)===null||s===void 0||s.call(this,t)},window.addEventListener("message",this._windowMessageHandler)}unbind(){this._windowMessageHandler&&window.removeEventListener("message",this._windowMessageHandler)}send(i){for(let s=0;s<window.frames.length;s+=1)window.frames[s].postMessage(i,"*")}}exports.Bridge=r;

package/dist/bridge.js

@@ -2,6 +2,8 @@ import { z as e } from "./index-B98VDFRY.js";
 const t = e.object({
   telemetrySdkVersion: e.string(),
   applicationName: e.string(),
+  applicationSpecifier: e.string(),
+  applicationInstance: e.string(),
   name: e.string(),
   data: e.any(),
   responseName: e.string().optional(),

package/dist/client-message-formatter.d.ts

@@ -4,6 +4,8 @@ export type Message = z.infer<typeof clientMessageValidator>;
 export declare function formatClientMessage(data: Message): {
     telemetrySdkVersion: string;
     applicationName: string;
+    applicationSpecifier: string;
+    applicationInstance: string;
     name: string;
     data?: any;
     responseName?: string | undefined;

package/dist/client-message-validator.d.ts

@@ -2,6 +2,8 @@ import { z } from 'zod';
 export declare const clientMessageValidator: z.ZodObject<{
     telemetrySdkVersion: z.ZodString;
     applicationName: z.ZodString;
+    applicationSpecifier: z.ZodString;
+    applicationInstance: z.ZodString;
     name: z.ZodString;
     data: z.ZodAny;
     responseName: z.ZodOptional<z.ZodString>;
@@ -10,6 +12,8 @@ export declare const clientMessageValidator: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     telemetrySdkVersion: string;
     applicationName: string;
+    applicationSpecifier: string;
+    applicationInstance: string;
     name: string;
     data?: any;
     responseName?: string | undefined;
@@ -18,6 +22,8 @@ export declare const clientMessageValidator: z.ZodObject<{
 }, {
     telemetrySdkVersion: string;
     applicationName: string;
+    applicationSpecifier: string;
+    applicationInstance: string;
     name: string;
     data?: any;
     responseName?: string | undefined;

package/dist/client.d.ts

@@ -45,7 +45,8 @@ export type SubscriptionResult<D = void> = {
  */
 export declare class Client {
     _applicationName: string;
-    _applicationId: string;
+    _applicationInstance: string;
+    _applicationSpecifier: string;
     _onHandlers: Map<string, MessageHandler<any>[]>;
     _onceHandlers: Map<string, MessageHandler<any>[]>;
     _subscriptionNamesByHandler: Map<MessageHandler<any>, string>;
@@ -139,6 +140,9 @@ export declare class Client {
      * @throws {Error} If used by an application not mounted at the 'rootSettingsNavigation' mount point
      */
     get rootSettingsNavigation(): RootSettingsNavigation;
+    get applicationName(): string;
+    get applicationSpecifier(): string;
+    get applicationInstance(): string;
     /**
      * Initializes the client by setting up message listeners and extracting the application ID.
      *

package/dist/index.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const S=require("./index-JDXm3DEz.cjs"),k="1.0.1",E={version:k};class M{constructor(e){this._client=e}async getCurrent(){return(await this._client.request("user.getCurrentAccount",{})).account}}class H{constructor(e){this._client=e}async getAllByMountPoint(e){return(await this._client.request("applications.getByMountPoint",{mountPoint:e})).applications}async getByName(e){return(await this._client.request("applications.getByName",{name:e})).application}async getUrl(e,t){return(await this._client.request("applications.getUrl",{name:e,mountPoint:t})).url}}function A(o,e=console.error){o().catch(e)}class ${constructor(e){this._client=e}async getColorScheme(){return(await this._client.request("environment.getColorScheme",{})).colorScheme}subscribeColorScheme(e){A(async()=>{this._client.on("environment.colorSchemeChanged",e),e(await this.getColorScheme())})}unsubscribeColorScheme(e){this._client.off("environment.colorSchemeChanged",e)}}class q{constructor(e){this._client=e}async queryFolders(e){return(await this._client.request("media.queryMediaFolders",{query:e})).folders}async getFoldersByTag(e){return(await this._client.request("media.getMediaFoldersByTag",{tagName:e})).folders}async getFolderById(e){return(await this._client.request("media.getMediaFolderById",{id:e})).folder}async getMediaContentByFolderId(e){return(await this._client.request("media.getMediaContentByFolderId",{folderId:e})).folders}async getMediaContentById(e){return(await this._client.request("media.getMediaContentById",{id:e})).content}}class C{constructor(e){this._client=e}get application(){return new b("application","",this._client)}get instance(){return new b("instance",this._client._applicationId,this._client)}get device(){return new b("device",this._client._applicationId,this._client)}shared(e){return new b("shared",e,this._client)}}class b{constructor(e,t,s){this._kind=e,this._namespace=t,this._client=s}async set(e,t){return(await this._client.request("store.set",{kind:this._kind,namespace:this._namespace,key:e,value:t})).success}async get(e){return(await this._client.request("store.get",{kind:this._kind,namespace:this._namespace,key:e})).value}async subscribe(e,t){return(await this._client.subscribe("store.subscribe",{kind:this._kind,namespace:this._namespace,key:e},t)).success}async unsubscribe(e,t){return(await this._client.unsubscribe("store.unsubscribe",{kind:this._kind,namespace:this._namespace,key:e},t)).success}async delete(e){return(await this._client.request("store.delete",{kind:this._kind,namespace:this._namespace,key:e})).success}}class P{constructor(e){this._client=e}async getCurrent(){return await this._client.request("user.getCurrentUser",{})}}const T=S.z.object({name:S.z.string(),data:S.z.any()});class F{constructor(e){if(e._client._applicationId!=="rootSettingsNavigation")throw new Error("RootSettingsNavigation can only be used in the rootSettingsNavigation mount point");this._store=e}async setRootSettingsNavigation(e){const t=this._store.shared("root-settings-navigation"),s=await t.get("navigation"),r=this._store._client._applicationId;s[r]={applicationId:r,entries:e.entries},t.set("navigation",s)}async getRootSettingsNavigation(){const t=await this._store.shared("root-settings-navigation").get("navigation"),s=this._store._client._applicationId;return t[s]}async getAllRootSettingsNavigation(){return this._store.shared("root-settings-navigation").get("navigation")}}const m=1e3*30;class B{constructor(e){this._applicationName=e,this._applicationId="",this._onHandlers=new Map,this._onceHandlers=new Map,this._subscriptionNamesByHandler=new Map,this._subscriptionNamesBySubjectName=new Map}get accounts(){return new M(this)}get users(){return new P(this)}get store(){return new C(this)}get applications(){return new H(this)}get media(){return new q(this)}get rootSettingsNavigation(){return new F(this.store)}bind(){var e;const t=new URL(window.location.href).searchParams;this._applicationId=(e=t.get("telemetryApplicationId"))!==null&&e!==void 0?e:"",this._windowMessageHandler=s=>{if(s.source===window)return;for(let a=0;a<window.frames.length;a+=1)window.frames[a].postMessage(s.data,"*");const r=T.safeParse(s.data);if(!r.success)return;const i=r.data,c=this._onHandlers.get(i.name),l=this._onceHandlers.get(i.name);if(c)for(const a of c)a(i.data);if(l){for(const a of l)a(i.data);this._onceHandlers.delete(i.name)}},window.addEventListener("message",this._windowMessageHandler)}unbind(){this._windowMessageHandler&&window.removeEventListener("message",this._windowMessageHandler)}send(e,t){const s={telemetrySdkVersion:_,applicationName:this._applicationName,name:e,data:t};window.parent.postMessage(s,"*")}request(e,t){const s=y(),r={telemetrySdkVersion:_,applicationName:this._applicationName,name:e,data:t,responseName:s};window.parent.postMessage(r,"*");let i=!1,c;const l=new Promise((h,d)=>{const p=new Error(`${e} message request with response name of ${s} timed out after ${m}`);setTimeout(()=>{i=!0,this.off(s,c),d(p)},m)}),a=new Promise(h=>{c=d=>{i||h(d)},this.once(s,h)});return Promise.race([l,a])}async subscribe(e,t,s){let r,i;typeof t=="function"?i=t:(r=t,i=s);const c=y(),l=y();let a=this._subscriptionNamesBySubjectName.get(e);a||(a=[],this._subscriptionNamesBySubjectName.set(e,a)),a.push(c),this._subscriptionNamesByHandler.set(i,c),this.on(c,i);const h={telemetrySdkVersion:_,applicationName:this._applicationName,name:e,data:r,responseName:l,subscriptionName:c};window.parent.postMessage(h,"*");let d=!1,p;const N=new Promise((w,g)=>{const f=new Error(`${e} subscribe request with subscription name of ${c} and response name of ${l} timed out after ${m}`);setTimeout(()=>{d=!0,this.off(l,p),g(f)},m)}),v=new Promise(w=>{p=g=>{d||w(g)},this.on(l,w)});return Promise.race([N,v])}async unsubscribe(e,t,s){let r,i;typeof t=="function"?i=t:(r=t,i=s);const c=y();let l=[];if(i){const a=this._subscriptionNamesByHandler.get(i);if(!a)return{success:!1};l=[a],this._subscriptionNamesByHandler.delete(i)}else if(!this._subscriptionNamesBySubjectName.get(e))return{success:!1};for await(const a of l){this.off(a,i);const h={telemetrySdkVersion:_,applicationName:this._applicationName,name:e,data:r,responseName:c,unsubscribeName:a};window.parent.postMessage(h,"*");let d=!1,p;const N=new Promise((g,f)=>{const I=new Error(`${e} unsubscribe request with unsubscribe name of ${a} and response name of ${c} timed out after ${m}`);setTimeout(()=>{d=!0,this.off(c,p),f(I)},m)}),v=new Promise(g=>{p=f=>{d||g(f)},this.once(c,g)});if(!(await Promise.race([N,v])).success)return{success:!1}}return{success:!0}}on(e,t){var s;const r=(s=this._onHandlers.get(e))!==null&&s!==void 0?s:[];r.length===0&&this._onHandlers.set(e,r),r.push(t)}once(e,t){var s;const r=(s=this._onceHandlers.get(e))!==null&&s!==void 0?s:[];r.length===0&&this._onceHandlers.set(e,r),r.push(t)}off(e,t){const s=this._onHandlers.get(e),r=this._onceHandlers.get(e);if(!(!s&&!r)){if(s){for(let i=0;i<s.length;i+=1)t&&s[i]!==t||(s.splice(i,1),i-=1);s.length===0&&this._onHandlers.delete(e)}if(r){for(let i=0;i<r.length;i+=1)t&&r[i]!==t||(r.splice(i,1),i-=1);r.length===0&&this._onceHandlers.delete(e)}}}}function y(){return Math.random().toString(36).slice(2,9)}const _=E.version;let n=null;function R(){return n}function j(o){n=new B(o),n.bind()}function U(){n==null||n.unbind(),n=null}function z(...o){return u(n),n.on(...o)}function L(...o){return u(n),n.once(...o)}function V(...o){return u(n),n.off(...o)}function x(...o){return u(n),n.send(...o)}function D(...o){return u(n),n.request(...o)}function K(...o){return u(n),n.subscribe(...o)}function G(...o){return u(n),n.unsubscribe(...o)}function J(){return u(n),n.store}function O(){return u(n),n.applications}function Q(){return u(n),n.media}function W(){return u(n),n.accounts}function X(){return u(n),n.users}function Y(){return u(n),n.rootSettingsNavigation}function u(o){if(!o)throw new Error("SDK is not configured")}exports.Accounts=M;exports.Applications=H;exports.Client=B;exports.Environment=$;exports.Media=q;exports.Store=C;exports.Users=P;exports.accounts=W;exports.applications=O;exports.configure=j;exports.destroy=U;exports.globalClient=R;exports.media=Q;exports.off=V;exports.on=z;exports.once=L;exports.request=D;exports.rootSettingsNavigation=Y;exports.send=x;exports.store=J;exports.subscribe=K;exports.telemetrySdkVersion=_;exports.unsubscribe=G;exports.users=X;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const v=require("./index-JDXm3DEz.cjs"),k="1.2.0",E={version:k};class I{constructor(e){this._client=e}async getCurrent(){return(await this._client.request("user.getCurrentAccount",{})).account}}class M{constructor(e){this._client=e}async getAllByMountPoint(e){return(await this._client.request("applications.getByMountPoint",{mountPoint:e})).applications}async getByName(e){return(await this._client.request("applications.getByName",{name:e})).application}async setDependencies(e){return await this._client.request("applications.setDependencies",{applicationSpecifiers:e})}}function A(o,e=console.error){o().catch(e)}class ${constructor(e){this._client=e}async getColorScheme(){return(await this._client.request("environment.getColorScheme",{})).colorScheme}subscribeColorScheme(e){A(async()=>{this._client.on("environment.colorSchemeChanged",e),e(await this.getColorScheme())})}unsubscribeColorScheme(e){this._client.off("environment.colorSchemeChanged",e)}}class q{constructor(e){this._client=e}async queryFolders(e){return(await this._client.request("media.queryMediaFolders",{query:e})).folders}async getFoldersByTag(e){return(await this._client.request("media.getMediaFoldersByTag",{tagName:e})).folders}async getFolderById(e){return(await this._client.request("media.getMediaFolderById",{id:e})).folder}async getMediaContentByFolderId(e){return(await this._client.request("media.getMediaContentByFolderId",{folderId:e})).folders}async getMediaContentById(e){return(await this._client.request("media.getMediaContentById",{id:e})).content}}class H{constructor(e){this._client=e}get application(){return new b("application","",this._client)}get instance(){return new b("instance",this._client._applicationId,this._client)}get device(){return new b("device",this._client._applicationId,this._client)}shared(e){return new b("shared",e,this._client)}}class b{constructor(e,t,s){this._kind=e,this._namespace=t,this._client=s}async set(e,t){return(await this._client.request("store.set",{kind:this._kind,namespace:this._namespace,key:e,value:t})).success}async get(e){return(await this._client.request("store.get",{kind:this._kind,namespace:this._namespace,key:e})).value}async subscribe(e,t){return(await this._client.subscribe("store.subscribe",{kind:this._kind,namespace:this._namespace,key:e},t)).success}async unsubscribe(e,t){return(await this._client.unsubscribe("store.unsubscribe",{kind:this._kind,namespace:this._namespace,key:e},t)).success}async delete(e){return(await this._client.request("store.delete",{kind:this._kind,namespace:this._namespace,key:e})).success}}class P{constructor(e){this._client=e}async getCurrent(){return await this._client.request("user.getCurrentUser",{})}}const T=v.z.object({name:v.z.string(),data:v.z.any()});class F{constructor(e){if(e._client._applicationId!=="rootSettingsNavigation")throw new Error("RootSettingsNavigation can only be used in the rootSettingsNavigation mount point");this._store=e}async setRootSettingsNavigation(e){const t=this._store.shared("root-settings-navigation"),s=await t.get("navigation"),r=this._store._client._applicationId;s[r]={applicationId:r,entries:e.entries},t.set("navigation",s)}async getRootSettingsNavigation(){const t=await this._store.shared("root-settings-navigation").get("navigation"),s=this._store._client._applicationId;return t[s]}async getAllRootSettingsNavigation(){return this._store.shared("root-settings-navigation").get("navigation")}}const f=1e3*30;class C{constructor(e){this._applicationName=e,this._applicationInstance="",this._applicationSpecifier="",this._onHandlers=new Map,this._onceHandlers=new Map,this._subscriptionNamesByHandler=new Map,this._subscriptionNamesBySubjectName=new Map}get accounts(){return new I(this)}get users(){return new P(this)}get store(){return new H(this)}get applications(){return new M(this)}get media(){return new q(this)}get rootSettingsNavigation(){return new F(this.store)}get applicationName(){return this._applicationName}get applicationSpecifier(){return this._applicationSpecifier}get applicationInstance(){return this._applicationInstance}bind(){var e;const t=new URL(window.location.href),s=t.searchParams;this._applicationInstance=(e=s.get("telemetryApplicationId"))!==null&&e!==void 0?e:"";const r=s.get("applicationSpecifier");if(r)this._applicationSpecifier=r;else{const i=t.hostname.split(".");this._applicationSpecifier=i[0]||""}if(!this._applicationSpecifier||this._applicationSpecifier.length!==40)throw new Error(`Invalid applicationSpecifier: expected 40-character hash, got "${this._applicationSpecifier}"`);if(!this._applicationInstance)throw new Error("Missing telemetryApplicationId query parameter");this._windowMessageHandler=i=>{if(i.source===window)return;for(let c=0;c<window.frames.length;c+=1)window.frames[c].postMessage(i.data,"*");const l=T.safeParse(i.data);if(!l.success)return;const u=l.data,a=this._onHandlers.get(u.name),h=this._onceHandlers.get(u.name);if(a)for(const c of a)c(u.data);if(h){for(const c of h)c(u.data);this._onceHandlers.delete(u.name)}},window.addEventListener("message",this._windowMessageHandler)}unbind(){this._windowMessageHandler&&window.removeEventListener("message",this._windowMessageHandler)}send(e,t){const s={telemetrySdkVersion:_,applicationName:this._applicationName,applicationSpecifier:this._applicationSpecifier,applicationInstance:this._applicationInstance,name:e,data:t};window.parent.postMessage(s,"*")}request(e,t){const s=y(),r={telemetrySdkVersion:_,applicationName:this._applicationName,applicationSpecifier:this._applicationSpecifier,applicationInstance:this._applicationInstance,name:e,data:t,responseName:s};window.parent.postMessage(r,"*");let i=!1,l;const u=new Promise((h,c)=>{const d=new Error(`${e} message request with response name of ${s} timed out after ${f}`);setTimeout(()=>{i=!0,this.off(s,l),c(d)},f)}),a=new Promise(h=>{l=c=>{i||h(c)},this.once(s,h)});return Promise.race([u,a])}async subscribe(e,t,s){let r,i;typeof t=="function"?i=t:(r=t,i=s);const l=y(),u=y();let a=this._subscriptionNamesBySubjectName.get(e);a||(a=[],this._subscriptionNamesBySubjectName.set(e,a)),a.push(l),this._subscriptionNamesByHandler.set(i,l),this.on(l,i);const h={telemetrySdkVersion:_,applicationName:this._applicationName,applicationSpecifier:this._applicationSpecifier,applicationInstance:this._applicationInstance,name:e,data:r,responseName:u,subscriptionName:l};window.parent.postMessage(h,"*");let c=!1,d;const S=new Promise((w,g)=>{const m=new Error(`${e} subscribe request with subscription name of ${l} and response name of ${u} timed out after ${f}`);setTimeout(()=>{c=!0,this.off(u,d),g(m)},f)}),N=new Promise(w=>{d=g=>{c||w(g)},this.on(u,w)});return Promise.race([S,N])}async unsubscribe(e,t,s){let r,i;typeof t=="function"?i=t:(r=t,i=s);const l=y();let u=[];if(i){const a=this._subscriptionNamesByHandler.get(i);if(!a)return{success:!1};u=[a],this._subscriptionNamesByHandler.delete(i)}else if(!this._subscriptionNamesBySubjectName.get(e))return{success:!1};for await(const a of u){this.off(a,i);const h={telemetrySdkVersion:_,applicationInstance:this._applicationInstance,applicationName:this._applicationName,applicationSpecifier:this._applicationSpecifier,name:e,data:r,responseName:l,unsubscribeName:a};window.parent.postMessage(h,"*");let c=!1,d;const S=new Promise((g,m)=>{const B=new Error(`${e} unsubscribe request with unsubscribe name of ${a} and response name of ${l} timed out after ${f}`);setTimeout(()=>{c=!0,this.off(l,d),m(B)},f)}),N=new Promise(g=>{d=m=>{c||g(m)},this.once(l,g)});if(!(await Promise.race([S,N])).success)return{success:!1}}return{success:!0}}on(e,t){var s;const r=(s=this._onHandlers.get(e))!==null&&s!==void 0?s:[];r.length===0&&this._onHandlers.set(e,r),r.push(t)}once(e,t){var s;const r=(s=this._onceHandlers.get(e))!==null&&s!==void 0?s:[];r.length===0&&this._onceHandlers.set(e,r),r.push(t)}off(e,t){const s=this._onHandlers.get(e),r=this._onceHandlers.get(e);if(!(!s&&!r)){if(s){for(let i=0;i<s.length;i+=1)t&&s[i]!==t||(s.splice(i,1),i-=1);s.length===0&&this._onHandlers.delete(e)}if(r){for(let i=0;i<r.length;i+=1)t&&r[i]!==t||(r.splice(i,1),i-=1);r.length===0&&this._onceHandlers.delete(e)}}}}function y(){return Math.random().toString(36).slice(2,9)}const _=E.version;let n=null;function R(){return n}function j(o){n=new C(o),n.bind()}function U(){n==null||n.unbind(),n=null}function z(...o){return p(n),n.on(...o)}function D(...o){return p(n),n.once(...o)}function L(...o){return p(n),n.off(...o)}function V(...o){return p(n),n.send(...o)}function x(...o){return p(n),n.request(...o)}function K(...o){return p(n),n.subscribe(...o)}function G(...o){return p(n),n.unsubscribe(...o)}function J(){return p(n),n.store}function O(){return p(n),n.applications}function Q(){return p(n),n.media}function W(){return p(n),n.accounts}function X(){return p(n),n.users}function Y(){return p(n),n.rootSettingsNavigation}function p(o){if(!o)throw new Error("SDK is not configured")}exports.Accounts=I;exports.Applications=M;exports.Client=C;exports.Environment=$;exports.Media=q;exports.Store=H;exports.Users=P;exports.accounts=W;exports.applications=O;exports.configure=j;exports.destroy=U;exports.globalClient=R;exports.media=Q;exports.off=L;exports.on=z;exports.once=D;exports.request=x;exports.rootSettingsNavigation=Y;exports.send=V;exports.store=J;exports.subscribe=K;exports.telemetrySdkVersion=_;exports.unsubscribe=G;exports.users=X;

package/dist/index.js

@@ -1,8 +1,8 @@
-import { z as S } from "./index-B98VDFRY.js";
-const M = "1.0.1", q = {
+import { z as v } from "./index-B98VDFRY.js";
+const M = "1.2.0", H = {
   version: M
 };
-class B {
+class q {
   constructor(e) {
     this._client = e;
   }
@@ -56,27 +56,32 @@ class P {
     })).application;
   }
   /**
-   * Generates a URL for embedding an application with the specified name and mount point.
+   * Sets the dependencies for the current application.
    *
-   * This method returns a URL that can be used in an iframe src attribute to embed
-   * the application. The URL includes necessary parameters for the application to
-   * understand its context and communicate with the platform.
+   * This method allows an application to declare which other applications it depends on.
+   * The player will download and prepare these dependencies before they can be loaded.
    *
-   * Only applications that are associated with the current account can be retrieved.
+   * IMPORTANT: This method must be called and awaited before loading any sub-applications
+   * in iframes. Only applications that return as 'ready' should be loaded.
    *
-   * @param name The name of the application to get the URL for
-   * @param mountPoint The mount point to use when embedding the application
-   * @returns A promise that resolves to the URL string for embedding the application
-   */
-  async getUrl(e, t) {
-    return (await this._client.request("applications.getUrl", {
-      name: e,
-      mountPoint: t
-    })).url;
+   * @param applicationSpecifiers An array of application specifiers that this application depends on
+   * @returns A promise that resolves with arrays of ready and unavailable application specifiers
+   *
+   * @example
+   * ```typescript
+   * const result = await client.applications.setDependencies(['app1-hash', 'app2-hash'])
+   * // result.ready: ['app1-hash'] - these can be loaded in iframes
+   * // result.unavailable: ['app2-hash'] - these failed to load
+   * ```
+   */
+  async setDependencies(e) {
+    return await this._client.request("applications.setDependencies", {
+      applicationSpecifiers: e
+    });
   }
 }
-function C(r, e = console.error) {
-  r().catch(e);
+function B(o, e = console.error) {
+  o().catch(e);
 }
 class R {
   constructor(e) {
@@ -86,7 +91,7 @@ class R {
     return (await this._client.request("environment.getColorScheme", {})).colorScheme;
   }
   subscribeColorScheme(e) {
-    C(async () => {
+    B(async () => {
       this._client.on("environment.colorSchemeChanged", e), e(await this.getColorScheme());
     });
   }
@@ -94,7 +99,7 @@ class R {
     this._client.off("environment.colorSchemeChanged", e);
   }
 }
-class I {
+class C {
   constructor(e) {
     this._client = e;
   }
@@ -333,9 +338,9 @@ class E {
     return await this._client.request("user.getCurrentUser", {});
   }
 }
-const $ = S.object({
-  name: S.string(),
-  data: S.any()
+const $ = v.object({
+  name: v.string(),
+  data: v.any()
 });
 class A {
   /**
@@ -360,9 +365,9 @@ class A {
    * @returns A promise that resolves when the navigation has been registered
    */
   async setRootSettingsNavigation(e) {
-    const t = this._store.shared("root-settings-navigation"), s = await t.get("navigation"), o = this._store._client._applicationId;
-    s[o] = {
-      applicationId: o,
+    const t = this._store.shared("root-settings-navigation"), s = await t.get("navigation"), r = this._store._client._applicationId;
+    s[r] = {
+      applicationId: r,
       entries: e.entries
     }, t.set("navigation", s);
   }
@@ -391,7 +396,7 @@ class A {
     return this._store.shared("root-settings-navigation").get("navigation");
   }
 }
-const m = 1e3 * 30;
+const g = 1e3 * 30;
 class T {
   /**
    * Creates a new Client instance for communicating with the TelemetryOS platform.
@@ -404,7 +409,7 @@ class T {
    *                        in your application's telemetry.config.json file
    */
   constructor(e) {
-    this._applicationName = e, this._applicationId = "", this._onHandlers = /* @__PURE__ */ new Map(), this._onceHandlers = /* @__PURE__ */ new Map(), this._subscriptionNamesByHandler = /* @__PURE__ */ new Map(), this._subscriptionNamesBySubjectName = /* @__PURE__ */ new Map();
+    this._applicationName = e, this._applicationInstance = "", this._applicationSpecifier = "", this._onHandlers = /* @__PURE__ */ new Map(), this._onceHandlers = /* @__PURE__ */ new Map(), this._subscriptionNamesByHandler = /* @__PURE__ */ new Map(), this._subscriptionNamesBySubjectName = /* @__PURE__ */ new Map();
   }
   /**
    * Provides access to the accounts API for retrieving TelemetryOS account information.
@@ -418,7 +423,7 @@ class T {
    * @returns An Accounts instance bound to this client
    */
   get accounts() {
-    return new B(this);
+    return new q(this);
   }
   /**
    * Provides access to the users API for retrieving TelemetryOS user information.
@@ -475,7 +480,7 @@ class T {
    * @returns A Media instance bound to this client
    */
   get media() {
-    return new I(this);
+    return new C(this);
   }
   /**
    * Provides access to the root settings navigation API for TelemetryOS administration UI integration.
@@ -495,6 +500,15 @@ class T {
   get rootSettingsNavigation() {
     return new A(this.store);
   }
+  get applicationName() {
+    return this._applicationName;
+  }
+  get applicationSpecifier() {
+    return this._applicationSpecifier;
+  }
+  get applicationInstance() {
+    return this._applicationInstance;
+  }
   /**
    * Initializes the client by setting up message listeners and extracting the application ID.
    *
@@ -512,23 +526,35 @@ class T {
    */
   bind() {
     var e;
-    const t = new URL(window.location.href).searchParams;
-    this._applicationId = (e = t.get("telemetryApplicationId")) !== null && e !== void 0 ? e : "", this._windowMessageHandler = (s) => {
-      if (s.source === window)
+    const t = new URL(window.location.href), s = t.searchParams;
+    this._applicationInstance = (e = s.get("telemetryApplicationId")) !== null && e !== void 0 ? e : "";
+    const r = s.get("applicationSpecifier");
+    if (r)
+      this._applicationSpecifier = r;
+    else {
+      const i = t.hostname.split(".");
+      this._applicationSpecifier = i[0] || "";
+    }
+    if (!this._applicationSpecifier || this._applicationSpecifier.length !== 40)
+      throw new Error(`Invalid applicationSpecifier: expected 40-character hash, got "${this._applicationSpecifier}"`);
+    if (!this._applicationInstance)
+      throw new Error("Missing telemetryApplicationId query parameter");
+    this._windowMessageHandler = (i) => {
+      if (i.source === window)
         return;
-      for (let a = 0; a < window.frames.length; a += 1)
-        window.frames[a].postMessage(s.data, "*");
-      const o = $.safeParse(s.data);
-      if (!o.success)
+      for (let c = 0; c < window.frames.length; c += 1)
+        window.frames[c].postMessage(i.data, "*");
+      const l = $.safeParse(i.data);
+      if (!l.success)
         return;
-      const i = o.data, c = this._onHandlers.get(i.name), l = this._onceHandlers.get(i.name);
-      if (c)
-        for (const a of c)
-          a(i.data);
-      if (l) {
-        for (const a of l)
-          a(i.data);
-        this._onceHandlers.delete(i.name);
+      const u = l.data, a = this._onHandlers.get(u.name), h = this._onceHandlers.get(u.name);
+      if (a)
+        for (const c of a)
+          c(u.data);
+      if (h) {
+        for (const c of h)
+          c(u.data);
+        this._onceHandlers.delete(u.name);
       }
     }, window.addEventListener("message", this._windowMessageHandler);
   }
@@ -565,6 +591,8 @@ class T {
     const s = {
       telemetrySdkVersion: y,
       applicationName: this._applicationName,
+      applicationSpecifier: this._applicationSpecifier,
+      applicationInstance: this._applicationInstance,
       name: e,
       data: t
     };
@@ -588,90 +616,96 @@ class T {
    * @throws {Error} If the request times out
    */
   request(e, t) {
-    const s = b(), o = {
+    const s = b(), r = {
       telemetrySdkVersion: y,
       applicationName: this._applicationName,
+      applicationSpecifier: this._applicationSpecifier,
+      applicationInstance: this._applicationInstance,
       name: e,
       data: t,
       responseName: s
     };
-    window.parent.postMessage(o, "*");
-    let i = !1, c;
-    const l = new Promise((h, d) => {
-      const p = new Error(`${e} message request with response name of ${s} timed out after ${m}`);
+    window.parent.postMessage(r, "*");
+    let i = !1, l;
+    const u = new Promise((h, c) => {
+      const d = new Error(`${e} message request with response name of ${s} timed out after ${g}`);
       setTimeout(() => {
-        i = !0, this.off(s, c), d(p);
-      }, m);
+        i = !0, this.off(s, l), c(d);
+      }, g);
     }), a = new Promise((h) => {
-      c = (d) => {
-        i || h(d);
+      l = (c) => {
+        i || h(c);
       }, this.once(s, h);
     });
-    return Promise.race([l, a]);
+    return Promise.race([u, a]);
   }
   async subscribe(e, t, s) {
-    let o, i;
-    typeof t == "function" ? i = t : (o = t, i = s);
-    const c = b(), l = b();
+    let r, i;
+    typeof t == "function" ? i = t : (r = t, i = s);
+    const l = b(), u = b();
     let a = this._subscriptionNamesBySubjectName.get(e);
-    a || (a = [], this._subscriptionNamesBySubjectName.set(e, a)), a.push(c), this._subscriptionNamesByHandler.set(i, c), this.on(c, i);
+    a || (a = [], this._subscriptionNamesBySubjectName.set(e, a)), a.push(l), this._subscriptionNamesByHandler.set(i, l), this.on(l, i);
     const h = {
       telemetrySdkVersion: y,
       applicationName: this._applicationName,
+      applicationSpecifier: this._applicationSpecifier,
+      applicationInstance: this._applicationInstance,
       name: e,
-      data: o,
-      responseName: l,
-      subscriptionName: c
+      data: r,
+      responseName: u,
+      subscriptionName: l
     };
     window.parent.postMessage(h, "*");
-    let d = !1, p;
-    const N = new Promise((_, g) => {
-      const f = new Error(`${e} subscribe request with subscription name of ${c} and response name of ${l} timed out after ${m}`);
+    let c = !1, d;
+    const S = new Promise((_, f) => {
+      const m = new Error(`${e} subscribe request with subscription name of ${l} and response name of ${u} timed out after ${g}`);
       setTimeout(() => {
-        d = !0, this.off(l, p), g(f);
-      }, m);
-    }), v = new Promise((_) => {
-      p = (g) => {
-        d || _(g);
-      }, this.on(l, _);
+        c = !0, this.off(u, d), f(m);
+      }, g);
+    }), N = new Promise((_) => {
+      d = (f) => {
+        c || _(f);
+      }, this.on(u, _);
     });
-    return Promise.race([N, v]);
+    return Promise.race([S, N]);
   }
   async unsubscribe(e, t, s) {
-    let o, i;
-    typeof t == "function" ? i = t : (o = t, i = s);
-    const c = b();
-    let l = [];
+    let r, i;
+    typeof t == "function" ? i = t : (r = t, i = s);
+    const l = b();
+    let u = [];
     if (i) {
       const a = this._subscriptionNamesByHandler.get(i);
       if (!a)
         return { success: !1 };
-      l = [a], this._subscriptionNamesByHandler.delete(i);
+      u = [a], this._subscriptionNamesByHandler.delete(i);
     } else if (!this._subscriptionNamesBySubjectName.get(e))
       return { success: !1 };
-    for await (const a of l) {
+    for await (const a of u) {
       this.off(a, i);
       const h = {
         telemetrySdkVersion: y,
+        applicationInstance: this._applicationInstance,
         applicationName: this._applicationName,
+        applicationSpecifier: this._applicationSpecifier,
         name: e,
-        data: o,
-        responseName: c,
+        data: r,
+        responseName: l,
         unsubscribeName: a
       };
       window.parent.postMessage(h, "*");
-      let d = !1, p;
-      const N = new Promise((g, f) => {
-        const H = new Error(`${e} unsubscribe request with unsubscribe name of ${a} and response name of ${c} timed out after ${m}`);
+      let c = !1, d;
+      const S = new Promise((f, m) => {
+        const I = new Error(`${e} unsubscribe request with unsubscribe name of ${a} and response name of ${l} timed out after ${g}`);
         setTimeout(() => {
-          d = !0, this.off(c, p), f(H);
-        }, m);
-      }), v = new Promise((g) => {
-        p = (f) => {
-          d || g(f);
-        }, this.once(c, g);
+          c = !0, this.off(l, d), m(I);
+        }, g);
+      }), N = new Promise((f) => {
+        d = (m) => {
+          c || f(m);
+        }, this.once(l, f);
       });
-      if (!(await Promise.race([N, v])).success)
+      if (!(await Promise.race([S, N])).success)
         return { success: !1 };
     }
     return { success: !0 };
@@ -695,8 +729,8 @@ class T {
    */
   on(e, t) {
     var s;
-    const o = (s = this._onHandlers.get(e)) !== null && s !== void 0 ? s : [];
-    o.length === 0 && this._onHandlers.set(e, o), o.push(t);
+    const r = (s = this._onHandlers.get(e)) !== null && s !== void 0 ? s : [];
+    r.length === 0 && this._onHandlers.set(e, r), r.push(t);
   }
   /**
    * Registers a one-time handler for a specific message type.
@@ -714,8 +748,8 @@ class T {
    */
   once(e, t) {
     var s;
-    const o = (s = this._onceHandlers.get(e)) !== null && s !== void 0 ? s : [];
-    o.length === 0 && this._onceHandlers.set(e, o), o.push(t);
+    const r = (s = this._onceHandlers.get(e)) !== null && s !== void 0 ? s : [];
+    r.length === 0 && this._onceHandlers.set(e, r), r.push(t);
   }
   /**
    * Removes previously registered message handlers.
@@ -733,17 +767,17 @@ class T {
    *                all handlers for this message type will be removed.
    */
   off(e, t) {
-    const s = this._onHandlers.get(e), o = this._onceHandlers.get(e);
-    if (!(!s && !o)) {
+    const s = this._onHandlers.get(e), r = this._onceHandlers.get(e);
+    if (!(!s && !r)) {
       if (s) {
         for (let i = 0; i < s.length; i += 1)
           t && s[i] !== t || (s.splice(i, 1), i -= 1);
         s.length === 0 && this._onHandlers.delete(e);
       }
-      if (o) {
-        for (let i = 0; i < o.length; i += 1)
-          t && o[i] !== t || (o.splice(i, 1), i -= 1);
-        o.length === 0 && this._onceHandlers.delete(e);
+      if (r) {
+        for (let i = 0; i < r.length; i += 1)
+          t && r[i] !== t || (r.splice(i, 1), i -= 1);
+        r.length === 0 && this._onceHandlers.delete(e);
       }
     }
   }
@@ -751,80 +785,80 @@ class T {
 function b() {
   return Math.random().toString(36).slice(2, 9);
 }
-const y = q.version;
+const y = H.version;
 let n = null;
 function j() {
   return n;
 }
-function U(r) {
-  n = new T(r), n.bind();
+function D(o) {
+  n = new T(o), n.bind();
 }
 function L() {
   n == null || n.unbind(), n = null;
 }
-function V(...r) {
-  return u(n), n.on(...r);
+function U(...o) {
+  return p(n), n.on(...o);
 }
-function x(...r) {
-  return u(n), n.once(...r);
+function x(...o) {
+  return p(n), n.once(...o);
 }
-function z(...r) {
-  return u(n), n.off(...r);
+function V(...o) {
+  return p(n), n.off(...o);
 }
-function D(...r) {
-  return u(n), n.send(...r);
+function z(...o) {
+  return p(n), n.send(...o);
 }
-function K(...r) {
-  return u(n), n.request(...r);
+function K(...o) {
+  return p(n), n.request(...o);
 }
-function G(...r) {
-  return u(n), n.subscribe(...r);
+function G(...o) {
+  return p(n), n.subscribe(...o);
 }
-function J(...r) {
-  return u(n), n.unsubscribe(...r);
+function J(...o) {
+  return p(n), n.unsubscribe(...o);
 }
 function Q() {
-  return u(n), n.store;
+  return p(n), n.store;
 }
 function W() {
-  return u(n), n.applications;
+  return p(n), n.applications;
 }
 function X() {
-  return u(n), n.media;
+  return p(n), n.media;
 }
 function Y() {
-  return u(n), n.accounts;
+  return p(n), n.accounts;
 }
 function Z() {
-  return u(n), n.users;
+  return p(n), n.users;
 }
 function O() {
-  return u(n), n.rootSettingsNavigation;
+  return p(n), n.rootSettingsNavigation;
 }
-function u(r) {
-  if (!r)
+function p(o) {
+  if (!o)
     throw new Error("SDK is not configured");
 }
 export {
-  B as Accounts,
+  q as Accounts,
   P as Applications,
   T as Client,
   R as Environment,
-  I as Media,
+  C as Media,
   k as Store,
   E as Users,
   Y as accounts,
   W as applications,
-  U as configure,
+  D as configure,
   L as destroy,
   j as globalClient,
   X as media,
-  z as off,
-  V as on,
+  V as off,
+  U as on,
   x as once,
   K as request,
   O as rootSettingsNavigation,
-  D as send,
+  z as send,
   Q as store,
   G as subscribe,
   y as telemetrySdkVersion,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@telemetryos/root-sdk",
-  "version": "1.0.1",
+  "version": "1.2.0",
   "description": "The official TelemetryOS root application sdk package. Provides types and apis for building root TelemetryOS applications.",
   "type": "module",
   "main": "dist/index.cjs",