@stonecrop/beam 0.2.63 → 0.2.65

package/dist/composables/mqtt.js

@@ -1,5 +1,11 @@
 import mqtt from 'mqtt';
 import { onMounted, onUnmounted, ref } from 'vue';
+/**
+ * Use MQTT stream
+ * @param options - MQTT stream options
+ * @returns MQTT stream messages
+ * @beta
+ */
 export const useMqttStream = (options) => {
     const client = ref(null);
     const messages = ref({});

package/dist/src/composables/mqtt.d.ts

@@ -1,9 +1,11 @@
-import { type IClientOptions } from 'mqtt';
-interface IMqttStream extends IClientOptions {
-    topics?: string[];
-}
+import { IMqttStream } from '@/types';
+/**
+ * Use MQTT stream
+ * @param options - MQTT stream options
+ * @returns MQTT stream messages
+ * @beta
+ */
 export declare const useMqttStream: (options?: IMqttStream) => {
     messages: import("vue").Ref<Record<string, string[]>, Record<string, string[]>>;
 };
-export {};
 //# sourceMappingURL=mqtt.d.ts.map

package/dist/src/composables/mqtt.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mqtt.d.ts","sourceRoot":"","sources":["../../../src/composables/mqtt.ts"],"names":[],"mappings":"AAAA,OAAa,EAAmB,KAAK,cAAc,EAAE,MAAM,MAAM,CAAA;AAGjE,UAAU,WAAY,SAAQ,cAAc;IAC3C,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;CACjB;AAED,eAAO,MAAM,aAAa,aAAc,WAAW;;CAiClD,CAAA"}
+{"version":3,"file":"mqtt.d.ts","sourceRoot":"","sources":["../../../src/composables/mqtt.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAErC;;;;;GAKG;AACH,eAAO,MAAM,aAAa,aAAc,WAAW;;CAiClD,CAAA"}

package/dist/src/index.d.ts

@@ -22,7 +22,7 @@ import ScanInput from '@/components/ScanInput.vue';
 import SplitColumn from '@/components/SplitColumn.vue';
 import ToggleArrow from '@/components/ToggleArrow.vue';
 import { useMqttStream } from '@/composables/mqtt';
-export type { ListViewItem } from '@/types';
+export type { IMqttStream, ListViewItem } from '@/types';
 import 'themes/beam.css';
 /**
  * Install all Beam components

package/dist/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,KAAK,CAAA;AAEzB,OAAO,YAAY,MAAM,+BAA+B,CAAA;AACxD,OAAO,SAAS,MAAM,4BAA4B,CAAA;AAClD,OAAO,OAAO,MAAM,0BAA0B,CAAA;AAC9C,OAAO,cAAc,MAAM,iCAAiC,CAAA;AAC5D,OAAO,UAAU,MAAM,6BAA6B,CAAA;AACpD,OAAO,gBAAgB,MAAM,mCAAmC,CAAA;AAChE,OAAO,WAAW,MAAM,8BAA8B,CAAA;AACtD,OAAO,YAAY,MAAM,+BAA+B,CAAA;AACxD,OAAO,SAAS,MAAM,4BAA4B,CAAA;AAClD,OAAO,eAAe,MAAM,kCAAkC,CAAA;AAC9D,OAAO,YAAY,MAAM,+BAA+B,CAAA;AACxD,OAAO,OAAO,MAAM,0BAA0B,CAAA;AAC9C,OAAO,QAAQ,MAAM,2BAA2B,CAAA;AAChD,OAAO,SAAS,MAAM,4BAA4B,CAAA;AAClD,OAAO,SAAS,MAAM,4BAA4B,CAAA;AAClD,OAAO,UAAU,MAAM,6BAA6B,CAAA;AACpD,OAAO,QAAQ,MAAM,2BAA2B,CAAA;AAChD,OAAO,QAAQ,MAAM,2BAA2B,CAAA;AAChD,OAAO,MAAM,MAAM,yBAAyB,CAAA;AAC5C,OAAO,SAAS,MAAM,4BAA4B,CAAA;AAClD,OAAO,WAAW,MAAM,8BAA8B,CAAA;AACtD,OAAO,WAAW,MAAM,8BAA8B,CAAA;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAClD,YAAY,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAC3C,OAAO,iBAAiB,CAAA;AAExB;;;;GAIG;AACH,iBAAS,OAAO,CAAC,GAAG,EAAE,GAAG,QAuBxB;AAED,OAAO,EACN,YAAY,EACZ,SAAS,EACT,OAAO,EACP,cAAc,EACd,UAAU,EACV,gBAAgB,EAChB,WAAW,EACX,YAAY,EACZ,SAAS,EACT,eAAe,EACf,YAAY,EACZ,OAAO,EACP,QAAQ,EACR,SAAS,EACT,SAAS,EACT,UAAU,EACV,QAAQ,EACR,QAAQ,EACR,MAAM,EACN,SAAS,EACT,WAAW,EACX,WAAW,EACX,OAAO,EACP,aAAa,GACb,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,KAAK,CAAA;AAEzB,OAAO,YAAY,MAAM,+BAA+B,CAAA;AACxD,OAAO,SAAS,MAAM,4BAA4B,CAAA;AAClD,OAAO,OAAO,MAAM,0BAA0B,CAAA;AAC9C,OAAO,cAAc,MAAM,iCAAiC,CAAA;AAC5D,OAAO,UAAU,MAAM,6BAA6B,CAAA;AACpD,OAAO,gBAAgB,MAAM,mCAAmC,CAAA;AAChE,OAAO,WAAW,MAAM,8BAA8B,CAAA;AACtD,OAAO,YAAY,MAAM,+BAA+B,CAAA;AACxD,OAAO,SAAS,MAAM,4BAA4B,CAAA;AAClD,OAAO,eAAe,MAAM,kCAAkC,CAAA;AAC9D,OAAO,YAAY,MAAM,+BAA+B,CAAA;AACxD,OAAO,OAAO,MAAM,0BAA0B,CAAA;AAC9C,OAAO,QAAQ,MAAM,2BAA2B,CAAA;AAChD,OAAO,SAAS,MAAM,4BAA4B,CAAA;AAClD,OAAO,SAAS,MAAM,4BAA4B,CAAA;AAClD,OAAO,UAAU,MAAM,6BAA6B,CAAA;AACpD,OAAO,QAAQ,MAAM,2BAA2B,CAAA;AAChD,OAAO,QAAQ,MAAM,2BAA2B,CAAA;AAChD,OAAO,MAAM,MAAM,yBAAyB,CAAA;AAC5C,OAAO,SAAS,MAAM,4BAA4B,CAAA;AAClD,OAAO,WAAW,MAAM,8BAA8B,CAAA;AACtD,OAAO,WAAW,MAAM,8BAA8B,CAAA;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAClD,YAAY,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AACxD,OAAO,iBAAiB,CAAA;AAExB;;;;GAIG;AACH,iBAAS,OAAO,CAAC,GAAG,EAAE,GAAG,QAuBxB;AAED,OAAO,EACN,YAAY,EACZ,SAAS,EACT,OAAO,EACP,cAAc,EACd,UAAU,EACV,gBAAgB,EAChB,WAAW,EACX,YAAY,EACZ,SAAS,EACT,eAAe,EACf,YAAY,EACZ,OAAO,EACP,QAAQ,EACR,SAAS,EACT,SAAS,EACT,UAAU,EACV,QAAQ,EACR,QAAQ,EACR,MAAM,EACN,SAAS,EACT,WAAW,EACX,WAAW,EACX,OAAO,EACP,aAAa,GACb,CAAA"}

package/dist/src/types/index.d.ts

@@ -1,3 +1,7 @@
+import type { IClientOptions } from 'mqtt';
+/**
+ * @beta
+ */
 export type ListViewItem = {
     description: string;
     label: string;
@@ -13,4 +17,11 @@ export type ListViewItem = {
     linkComponent?: string;
     route?: string;
 };
+/**
+ * MQTT stream options
+ * @public
+ */
+export interface IMqttStream extends IClientOptions {
+    topics?: string[];
+}
 //# sourceMappingURL=index.d.ts.map

package/dist/src/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,YAAY,GAAG;IAC1B,WAAW,EAAE,MAAM,CAAA;IACnB,KAAK,EAAE,MAAM,CAAA;IAEb,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,KAAK,CAAC,EAAE;QACP,KAAK,EAAE,MAAM,CAAA;QACb,EAAE,EAAE,MAAM,CAAA;QACV,GAAG,EAAE,MAAM,CAAA;KACX,CAAA;IACD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,KAAK,CAAC,EAAE,MAAM,CAAA;CACd,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,MAAM,CAAA;AAE1C;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IAC1B,WAAW,EAAE,MAAM,CAAA;IACnB,KAAK,EAAE,MAAM,CAAA;IAEb,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,KAAK,CAAC,EAAE;QACP,KAAK,EAAE,MAAM,CAAA;QACb,EAAE,EAAE,MAAM,CAAA;QACV,GAAG,EAAE,MAAM,CAAA;KACX,CAAA;IACD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,KAAK,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,cAAc;IAClD,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;CACjB"}

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.47.9"
+      "packageVersion": "7.48.0"
     }
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stonecrop/beam",
-  "version": "0.2.63",
+  "version": "0.2.65",
   "license": "MIT",
   "type": "module",
   "author": {
@@ -32,11 +32,11 @@
     "@vueuse/core": "^11.1.0",
     "mqtt": "^5.10.1",
     "onscan.js": "^1.5.2",
-    "vue": "^3.5.6"
+    "vue": "^3.5.11"
   },
   "devDependencies": {
-    "@microsoft/api-documenter": "^7.25.3",
-    "@rushstack/heft": "^0.67.2",
+    "@microsoft/api-documenter": "^7.26.2",
+    "@rushstack/heft": "^0.68.6",
     "@typescript-eslint/eslint-plugin": "^7.14.1",
     "@typescript-eslint/parser": "^7.14.1",
     "@vitejs/plugin-vue": "^5.1.3",
@@ -48,7 +48,7 @@
     "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-vue": "^9.11.1",
     "sass": "^1.75.0",
-    "typescript": "^5.5.2",
+    "typescript": "^5.6.3",
     "vite-plugin-lib-inject-css": "^2.1.1",
     "vite": "^5.4.5",
     "vitest": "^2.1.1",

package/src/composables/mqtt.ts

@@ -1,10 +1,14 @@
-import mqtt, { type MqttClient, type IClientOptions } from 'mqtt'
+import mqtt, { type MqttClient } from 'mqtt'
 import { onMounted, onUnmounted, ref } from 'vue'
 
-interface IMqttStream extends IClientOptions {
-	topics?: string[]
-}
+import { IMqttStream } from '@/types'
 
+/**
+ * Use MQTT stream
+ * @param options - MQTT stream options
+ * @returns MQTT stream messages
+ * @beta
+ */
 export const useMqttStream = (options?: IMqttStream) => {
 	const client = ref<MqttClient>(null)
 	const messages = ref<Record<string, string[]>>({})

package/src/index.ts

@@ -23,7 +23,7 @@ import ScanInput from '@/components/ScanInput.vue'
 import SplitColumn from '@/components/SplitColumn.vue'
 import ToggleArrow from '@/components/ToggleArrow.vue'
 import { useMqttStream } from '@/composables/mqtt'
-export type { ListViewItem } from '@/types'
+export type { IMqttStream, ListViewItem } from '@/types'
 import 'themes/beam.css'
 
 /**

package/src/types/index.ts

@@ -1,3 +1,8 @@
+import type { IClientOptions } from 'mqtt'
+
+/**
+ * @beta
+ */
 export type ListViewItem = {
 	description: string
 	label: string
@@ -14,3 +19,11 @@ export type ListViewItem = {
 	linkComponent?: string
 	route?: string
 }
+
+/**
+ * MQTT stream options
+ * @public
+ */
+export interface IMqttStream extends IClientOptions {
+	topics?: string[]
+}