@busy-app/busy-lib 0.3.0 → 0.4.0

package/dist/index.d.ts

@@ -2,14 +2,24 @@ declare type ApiKey = string;
 
 declare type ApiSemver = components["schemas"]["VersionInfo"]["api_semver"];
 
-declare interface AudioParams {
+export declare interface AssetsDeleteParams {
+    appId: paths["/assets/upload"]["delete"]["parameters"]["query"]["app_id"];
+}
+
+export declare interface AssetsUploadParams {
+    appId: paths["/assets/upload"]["post"]["parameters"]["query"]["app_id"];
+    fileName: paths["/assets/upload"]["post"]["parameters"]["query"]["file"];
+    file: BusyFile;
+}
+
+export declare interface AudioPlayParams {
     appId: paths["/audio/play"]["post"]["parameters"]["query"]["app_id"];
     path: paths["/audio/play"]["post"]["parameters"]["query"]["path"];
 }
 
 export declare type AudioVolumeInfo = components["schemas"]["AudioVolumeInfo"];
 
-declare interface AudioVolumeParams {
+export declare interface AudioVolumeParams {
     volume: operations["setAudioVolume"]["parameters"]["query"]["volume"];
 }
 
@@ -26,11 +36,6 @@ declare interface BaseConfig_2 {
 
 declare type Brightness = number | "auto";
 
-declare interface BrightnessParams {
-    front?: Brightness;
-    back?: Brightness;
-}
-
 /**
  * Main library class for interacting with the Busy Bar API.
  *
@@ -69,7 +74,7 @@ export declare class BusyBar {
      * @param {UpdateParams['file']} params.file - File data to upload.
      * @returns {Promise<SuccessResponse>} Result of the update operation.
      */
-    updateFirmware(params: UpdateParams): Promise<SuccessResponse>;
+    updateFirmware(params: SystemUpdateParams): Promise<SuccessResponse>;
     /**
      * Gets the current status of the device, including system and power information.
      *
@@ -97,7 +102,7 @@ export declare class BusyBar {
      * @param {UploadParams['file']} params.file - File data to upload.
      * @returns {Promise<SuccessResponse>} Result of the upload operation.
      */
-    uploadAsset(params: UploadParams): Promise<SuccessResponse>;
+    uploadAsset(params: AssetsUploadParams): Promise<SuccessResponse>;
     /**
      * Deletes all assets for a specific application from the device.
      *
@@ -105,7 +110,7 @@ export declare class BusyBar {
      * @param {DeleteParams['appId']} params.appId - Application ID whose assets should be deleted.
      * @returns {Promise<SuccessResponse>} Result of the delete operation.
      */
-    deleteAssets(params: DeleteParams): Promise<SuccessResponse>;
+    deleteAssets(params: AssetsDeleteParams): Promise<SuccessResponse>;
     /**
      * Draws elements on the device display.
      *
@@ -114,7 +119,7 @@ export declare class BusyBar {
      * @param {DrawParams['elements'][]} params.elements - Array of display elements (text or image).
      * @returns {Promise<SuccessResponse>} Result of the draw operation.
      */
-    drawDisplay(params: DrawParams): Promise<SuccessResponse>;
+    drawDisplay(params: DisplayDrawParams): Promise<SuccessResponse>;
     /**
      * Clears the device display and stops the Canvas application if running.
      *
@@ -124,12 +129,12 @@ export declare class BusyBar {
     /**
      * Plays an audio file from the assets directory.
      *
-     * @param {AudioParams} params - Parameters for the audio playback.
-     * @param {AudioParams['appId']} params.appId - Application ID for organizing assets.
-     * @param {AudioParams['path']} params.path - Path to the audio file within the app's assets directory.
+     * @param {AudioPlayParams} params - Parameters for the audio playback.
+     * @param {AudioPlayParams['appId']} params.appId - Application ID for organizing assets.
+     * @param {AudioPlayParams['path']} params.path - Path to the audio file within the app's assets directory.
      * @returns {Promise<SuccessResponse>} Result of the play operation.
      */
-    playSound(params: AudioParams): Promise<SuccessResponse>;
+    playSound(params: AudioPlayParams): Promise<SuccessResponse>;
     /**
      * Stops any currently playing audio on the device.
      *
@@ -169,7 +174,7 @@ export declare class BusyBar {
      *     @param {ConnectParams['ipConfig']['gateway']} [params.ipConfig.gateway] - Gateway address (if using "static" method).
      * @returns {Promise<SuccessResponse>} Result of the connect operation.
      */
-    connectWifi(params: ConnectParams): Promise<SuccessResponse>;
+    connectWifi(params: WifiConnectParams): Promise<SuccessResponse>;
     /**
      * Disconnects the device from the current Wi-Fi network.
      *
@@ -245,7 +250,7 @@ export declare class BusyBar {
      * @returns {Promise<SuccessResponse>} Result of the brightness update operation.
      * @throws {Error} If brightness value is outside the range 0-100 or not "auto".
      */
-    setDisplayBrightness(params: BrightnessParams): Promise<SuccessResponse>;
+    setDisplayBrightness(params: DisplayBrightnessParams): Promise<SuccessResponse>;
     /**
      * Gets the current audio volume value.
      *
@@ -295,14 +300,14 @@ export declare class BusyBar {
      * Sends a button press.
      *
      * @param params - Button press parameters:
-     *   @param {InputKey['keyName']} params.keyName - Button key.
+     *   @param {InputKeyParams['keyName']} params.keyName - Button key.
      *   @example
      *  {
      *    keyName: "ok"
      *  }
      * @returns {Promise<SuccessResponse>} Result of pressing the button.
      */
-    pressButton(params: InputKey): Promise<SuccessResponse>;
+    pressButton(params: InputKeyParams): Promise<SuccessResponse>;
 }
 
 declare interface BusyBarConfig {
@@ -634,13 +639,11 @@ declare interface components {
     pathItems: never;
 }
 
-declare type ConnectParams = RequireKeys<Omit<CamelizedRequest, "ipConfig"> & {
-    ipConfig: RequiredIpConfig;
-}, "ssid" | "security" | "ipConfig">;
-
-export declare interface CreateDirectoryParams {
+declare interface CreateDirectoryParams {
     path: operations["createStorageDir"]["parameters"]["query"]["path"];
 }
+export { CreateDirectoryParams }
+export { CreateDirectoryParams as StorageCreateDirectoryParams }
 
 declare type CustomElement = CustomTextElement | CustomImageElement;
 
@@ -654,10 +657,6 @@ declare type DeepCamelize<T> = T extends (...args: any[]) => any ? T : T extends
     [K in keyof T as SnakeToCamel<K & string>]: DeepCamelize<T[K]>;
 } : T;
 
-declare interface DeleteParams {
-    appId: paths["/assets/upload"]["delete"]["parameters"]["query"]["app_id"];
-}
-
 declare type DeviceConfig = LocalConfig | SiteConfig;
 
 declare type DeviceConfig_2 = LocalConfig_2 | SiteConfig_2;
@@ -669,16 +668,23 @@ export declare enum DeviceScreen {
 
 export declare type DisplayBrightnessInfo = components["schemas"]["DisplayBrightnessInfo"];
 
-export declare interface DownloadFileParams {
-    path: operations["readStorageFile"]["parameters"]["query"]["path"];
-    asArrayBuffer?: boolean;
+export declare interface DisplayBrightnessParams {
+    front?: Brightness;
+    back?: Brightness;
 }
 
-declare interface DrawParams {
+export declare interface DisplayDrawParams {
     appId: paths["/display/draw"]["post"]["requestBody"]["content"]["application/json"]["app_id"];
     elements: CustomElement[];
 }
 
+declare interface DownloadFileParams {
+    path: operations["readStorageFile"]["parameters"]["query"]["path"];
+    asArrayBuffer?: boolean;
+}
+export { DownloadFileParams }
+export { DownloadFileParams as StorageDownloadFileParams }
+
 declare type Error_2 = components["schemas"]["Error"];
 export { Error_2 as Error }
 
@@ -692,7 +698,7 @@ declare interface ErrorPayload {
 
 export declare type HttpAccessInfo = components["schemas"]["HttpAccessInfo"];
 
-declare interface HttpAccessParams {
+export declare interface HttpAccessParams {
     mode: operations["setHttpAccess"]["parameters"]["query"]["mode"];
     key: operations["setHttpAccess"]["parameters"]["query"]["key"];
 }
@@ -722,7 +728,7 @@ export declare class Input {
     closeWebsocket(): Promise<void>;
 }
 
-declare interface InputKey {
+export declare interface InputKeyParams {
     keyName: KeyName;
 }
 
@@ -2468,13 +2474,17 @@ declare interface paths {
     };
 }
 
-export declare interface ReadDirectoryParams {
+declare interface ReadDirectoryParams {
     path: operations["listStorageFiles"]["parameters"]["query"]["path"];
 }
+export { ReadDirectoryParams }
+export { ReadDirectoryParams as StorageReadDirectoryParams }
 
-export declare interface RemoveParams {
+declare interface RemoveParams {
     path: operations["removeStorageFile"]["parameters"]["query"]["path"];
 }
+export { RemoveParams }
+export { RemoveParams as StorageRemoveParams }
 
 declare type RequiredIpConfig = RequireKeys<NonNullable<CamelizedRequest["ipConfig"]>, "ipMethod" | "ipType">;
 
@@ -2536,24 +2546,24 @@ export declare type StorageReadResponse = ArrayBuffer | Blob;
 
 export declare type SuccessResponse = components["schemas"]["SuccessResponse"];
 
-declare interface UpdateParams {
+export declare interface SystemUpdateParams {
     name?: string;
     file: BusyFile;
 }
 
-export declare interface UploadFileParams {
+declare interface UploadFileParams {
     path: operations["writeStorageFile"]["parameters"]["query"]["path"];
     file: BusyFile;
 }
-
-declare interface UploadParams {
-    appId: paths["/assets/upload"]["post"]["parameters"]["query"]["app_id"];
-    fileName: paths["/assets/upload"]["post"]["parameters"]["query"]["file"];
-    file: BusyFile;
-}
+export { UploadFileParams as StorageUploadFileParams }
+export { UploadFileParams }
 
 export declare type VersionInfo = components["schemas"]["VersionInfo"];
 
+export declare type WifiConnectParams = RequireKeys<Omit<CamelizedRequest, "ipConfig"> & {
+    ipConfig: RequiredIpConfig;
+}, "ssid" | "security" | "ipConfig">;
+
 export declare type WifiConnectRequestConfig = components["schemas"]["ConnectRequestConfig"];
 
 export declare type WifiIpMethod = components["schemas"]["WifiIpMethod"];

package/dist/index.js

@@ -568,9 +568,9 @@ class lt {
   /**
    * Plays an audio file from the assets directory.
    *
-   * @param {AudioParams} params - Parameters for the audio playback.
-   * @param {AudioParams['appId']} params.appId - Application ID for organizing assets.
-   * @param {AudioParams['path']} params.path - Path to the audio file within the app's assets directory.
+   * @param {AudioPlayParams} params - Parameters for the audio playback.
+   * @param {AudioPlayParams['appId']} params.appId - Application ID for organizing assets.
+   * @param {AudioPlayParams['path']} params.path - Path to the audio file within the app's assets directory.
    * @returns {Promise<SuccessResponse>} Result of the play operation.
    */
   async playSound(t) {
@@ -786,7 +786,7 @@ class lt {
    * Sends a button press.
    *
    * @param params - Button press parameters:
-   *   @param {InputKey['keyName']} params.keyName - Button key.
+   *   @param {InputKeyParams['keyName']} params.keyName - Button key.
    *   @example
    *  {
    *    keyName: "ok"

package/package.json

@@ -2,7 +2,7 @@
   "name": "@busy-app/busy-lib",
   "private": false,
   "description": "A library for interacting with the BUSY Bar API",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "publishConfig": {
     "access": "public"
   },