chore(deps): update all dependencies to latest versions

BREAKING CHANGE: Updated dependencies may introduce breaking changes.
Benjamin-Stefan · Nov 27, 2024 · d5058fb · d5058fb
1 parent bed165b
commit d5058fb
Show file tree

Hide file tree

Showing 14 changed files with 473 additions and 908 deletions.
diff --git a/dist/index.d.mts b/dist/index.d.mts
@@ -26,6 +26,23 @@ interface SSHOptions {
     privateKeyPath?: string;
     passphrase?: string;
 }
+/**
+ * Enum-like type that defines various service types supported by the system.
+ *
+ * ServiceType represents a set of valid services that can be interacted with. Each service type
+ * is represented as a string and can be one of the following:
+ * - "wds": Wireless data service
+ * - "nas": Network access service
+ * - "uim": User identity module service
+ * - "sms": Short message service
+ * - "voice": Voice service
+ * - "dms": Device management service
+ * - "gps": Global positioning service
+ *
+ * @example
+ * const myService: ServiceType = "sms";
+ */
+type ServiceType = "wds" | "nas" | "uim" | "sms" | "voice" | "dms" | "gps";
 /**
  * Options for configuring the Uqmi client, allowing for optional settings like timeout.
  *
@@ -341,4 +358,4 @@ declare class UqmiClient {
     getServingSystem(): Promise<string>;
 }
 
-export { UqmiClient };
+export { type SSHOptions, type ServiceType, UqmiClient, type UqmiClientOptions };
diff --git a/dist/index.d.ts b/dist/index.d.ts
@@ -26,6 +26,23 @@ interface SSHOptions {
     privateKeyPath?: string;
     passphrase?: string;
 }
+/**
+ * Enum-like type that defines various service types supported by the system.
+ *
+ * ServiceType represents a set of valid services that can be interacted with. Each service type
+ * is represented as a string and can be one of the following:
+ * - "wds": Wireless data service
+ * - "nas": Network access service
+ * - "uim": User identity module service
+ * - "sms": Short message service
+ * - "voice": Voice service
+ * - "dms": Device management service
+ * - "gps": Global positioning service
+ *
+ * @example
+ * const myService: ServiceType = "sms";
+ */
+type ServiceType = "wds" | "nas" | "uim" | "sms" | "voice" | "dms" | "gps";
 /**
  * Options for configuring the Uqmi client, allowing for optional settings like timeout.
  *
@@ -341,4 +358,4 @@ declare class UqmiClient {
     getServingSystem(): Promise<string>;
 }
 
-export { UqmiClient };
+export { type SSHOptions, type ServiceType, UqmiClient, type UqmiClientOptions };
diff --git a/dist/index.d.ts.map b/dist/index.d.ts.map
diff --git a/dist/types.d.ts b/dist/types.d.ts
@@ -29,7 +29,6 @@ export interface SSHOptions {
 /**
  * Enum-like type that defines various service types supported by the system.
  *
- * @description
  * ServiceType represents a set of valid services that can be interacted with. Each service type
  * is represented as a string and can be one of the following:
  * - "wds": Wireless data service

diff --git a/dist/types.d.ts.map b/dist/types.d.ts.map
diff --git a/docs/README.md b/docs/README.md
@@ -1,4 +1,4 @@
-**UqmiClient v1.1.0** • **Docs**
+**UqmiClient v1.1.0**
 
 ***
 
@@ -7,3 +7,12 @@
 ## Classes
 
 - [UqmiClient](classes/UqmiClient.md)
+
+## Interfaces
+
+- [SSHOptions](interfaces/SSHOptions.md)
+- [UqmiClientOptions](interfaces/UqmiClientOptions.md)
+
+## Type Aliases
+
+- [ServiceType](type-aliases/ServiceType.md)