@panomc/sdk 1.0.0-dev.4 → 1.0.0-dev.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@panomc/sdk",
-  "version": "1.0.0-dev.4",
+  "version": "1.0.0-dev.6",
   "author": "PanoMC",
   "repository": {
     "url": "https://github.com/PanoMC/sdk"
@@ -47,6 +47,10 @@
     "./variables": {
       "svelte": "./src/variables.js",
       "default": "./src/variables.js"
+    },
+    "./svelte": {
+      "svelte": "./src/svelte.js",
+      "default": "./src/svelte.js"
     }
   },
   "files": [

package/src/api/plugin.js

@@ -1,7 +1,22 @@
 import { createPluginContext } from "./plugin-context.js";
 
+/**
+ * @typedef {import('../types.js').Pano} Pano
+ * @typedef {import('../types.js').PanoPluginContext} PanoPluginContext
+ */
+
 export class PanoPlugin {
   static isPanoPlugin = true;
+
+  /** @type {Pano} */
+  pano;
+
+  /** @type {PanoPluginContext} */
+  contextApi;
+
+  /** @type {any} */
+  context;
+
   constructor({ pluginId, scope } = {}) {
     if (!pluginId) {
       throw new Error("[PanoPlugin] pluginId is required");
@@ -14,9 +29,11 @@ export class PanoPlugin {
     this._unsubscribers = [];
   }
 
-  /** lifecycle hooks */
-  onLoad(pano) {}
-  onUnload() {}
+  /** 
+   * @param {Pano} pano 
+   */
+  onLoad(pano) { }
+  onUnload() { }
 
   /** plugin context helper */
   setContext(partial) {

package/src/internal/pano-context.js

@@ -10,6 +10,13 @@ function getStore() {
   return globalThis[GLOBAL_KEY];
 }
 
+/**
+ * @typedef {import('../types.js').Pano} Pano
+ */
+
+/**
+ * @param {Partial<Pano>} partial
+ */
 export function setPanoContext(partial) {
   const store = getStore();
 
@@ -29,6 +36,9 @@ export function setPanoContext(partial) {
   });
 }
 
+/**
+ * @returns {{ context: Pano, subscribe: (fn: (ctx: Pano) => void) => () => void }}
+ */
 export function getPanoContext() {
   const store = getStore();
 

package/src/svelte.js

@@ -0,0 +1,6 @@
+import { getPanoContext } from "./internal/index.js";
+
+const panoContext = getPanoContext();
+const { page, base, navigating, browser } = panoContext.context;
+
+export { page, base, navigating, browser };

package/src/types.js

@@ -0,0 +1,40 @@
+/**
+ * @typedef {Object} Pano
+ * @property {boolean} isPanel
+ * @property {any} page - SvelteKit page store
+ * @property {string} base
+ * @property {any} navigating - SvelteKit navigating store
+ * @property {boolean} browser
+ * @property {Object} ui
+ * @property {Object} ui.page
+ * @property {function({path: string, component: any, layout?: any, resetLayout?: boolean}): void} ui.page.register
+ * @property {Object} ui.nav
+ * @property {Object} ui.nav.site
+ * @property {function(function(any[]): any[]): void} ui.nav.site.editNavLinks
+ * @property {Object} utils
+ * @property {Object} utils.api
+ * @property {any} utils.api.ApiUtil
+ * @property {function(Record<string, any>): string} utils.api.buildQueryParams
+ * @property {string} utils.api.NETWORK_ERROR
+ * @property {Object} utils.api.networkErrorBody
+ * @property {string} utils.api.networkErrorBody.result
+ * @property {string} utils.api.networkErrorBody.error
+ * @property {Object} utils.language
+ * @property {any} utils.language.init
+ * @property {any} utils.language._ - i18n store or function
+ * @property {Object} utils.tooltip
+ * @property {any} utils.tooltip.tooltip
+ * @property {any} utils.toast
+ * @property {Record<string, any>} components
+ * @property {Record<string, any>} variables
+ */
+
+/**
+ * @typedef {Object} PanoPluginContext
+ * @property {any} context
+ * @property {function(any): void} set
+ * @property {function(function(any): void): function(): void} subscribe
+ * @property {function(): void} [destroy]
+ */
+
+export { }

package/src/utils/language.js

@@ -11,6 +11,7 @@ const getAcceptedLanguage = languageStuff.getAcceptedLanguage;
 const loadLanguage = languageStuff.loadLanguage;
 const changeLanguage = languageStuff.changeLanguage;
 const getLanguageByLocale = languageStuff.getLanguageByLocale;
+const _ = languageStuff._;
 
 export {
   languageLoading,
@@ -21,4 +22,5 @@ export {
   loadLanguage,
   changeLanguage,
   getLanguageByLocale,
+  _
 };