webamp 0.0.0-next-0d844a70 → 0.0.0-next-12f8e36b

package/{dist → built}/types/js/types.d.ts

@@ -6,7 +6,7 @@ import { UserInputState } from "./reducers/userInput";
 import { MediaState } from "./reducers/media";
 import { ThunkDispatch, ThunkAction } from "redux-thunk";
 import { DisplayState } from "./reducers/display";
-import { WindowsState, WindowPositions as _WindowPositions, WebampWindow as _WebampWindow, WindowInfo as _WindowInfo, WindowPosition as _WindowPosition } from "./reducers/windows";
+import { WindowsState, WindowPositions as _WindowPositions, WebampWindow as _WebampWindow, WindowInfo as _WindowInfo } from "./reducers/windows";
 import { EqualizerState } from "./reducers/equalizer";
 import { NetworkState } from "./reducers/network";
 import { MilkdropState } from "./reducers/milkdrop";
@@ -16,7 +16,6 @@ import { IAudioMetadata, IOptions } from "music-metadata-browser";
 import { Store as ReduxStore } from "redux";
 export declare type WebampWindow = _WebampWindow;
 export declare type WindowInfo = _WindowInfo;
-export declare type WindowPosition = _WindowPosition;
 export declare type WindowPositions = _WindowPositions;
 export interface Point {
     x: number;
@@ -117,7 +116,7 @@ export interface SkinGenExColors {
     listTextSelected: string;
     listTextSelectedBackground: string;
 }
-export declare type WindowId = string;
+export declare type WindowId = "main" | "playlist" | "equalizer" | "milkdrop";
 export declare type SkinData = {
     skinImages: SkinImages;
     skinColors: string[];
@@ -533,6 +532,14 @@ export interface Options {
         url: string;
         name: string;
     }[];
+    windowLayout?: WindowLayout;
+    /**
+     * Controls if "double size mode", where the fixed sized windows are rendered
+     * at 2x, should be enabled
+     *
+     * Default: `false`
+     */
+    enableDoubleSizeMode?: boolean;
     /**
      * Should global hotkeys be enabled?
      *
@@ -544,7 +551,7 @@ export interface Options {
      *
      * These will appear in the "Options" menu under "Play".
      *
-     * In the offical version, this option is used to provide a "Dropbox" file picker.
+     * For example, this option can be used to provide a "Dropbox" file picker.
      */
     filePickers?: [{
         /**
@@ -570,11 +577,64 @@ export interface Options {
     handleLoadListEvent?: () => Track[] | null | Promise<Track[] | null>;
     handleSaveListEvent?: (tracks: Track[]) => null | Promise<null>;
 }
+/**
+ * Specifies the initial position and size of a the Winamp windows.
+ *
+ * Positions are specified in pixels from the top left corner of an imaginary
+ * box. On initial render, the collection of visible windows will be centered
+ * within the HTML element passed to `Webamp.renderWhenReady(element)`. In other
+ * words, the positions given here will determine the _relative_ position of the
+ * windows. The absolute position will be determined by the HTML element in
+ * which Webamp is centered.
+ *
+ * Enabling "shade mode" for a window that supports it, will cause it to be
+ * rendered minimized. Be default windows are not in shade mode.
+ *
+ * Windows which support resizing can have their size specified. If omitted,
+ * they default to their small base size.
+ *
+ * Windows that are omitted will start closed. Enabling "closed" for a window
+ * that supports it, will cause it to start closed.
+ */
 export declare type WindowLayout = {
-    [windowId: string]: {
-        size?: null | [number, number];
+    main?: {
         position: WindowPosition;
+        shadeMode?: boolean;
+        closed?: boolean;
     };
+    equalizer?: {
+        position: WindowPosition;
+        shadeMode?: boolean;
+        closed?: boolean;
+    };
+    playlist?: {
+        position: WindowPosition;
+        shadeMode?: boolean;
+        size?: WindowSize | null;
+        closed?: boolean;
+    };
+    milkdrop?: {
+        position: WindowPosition;
+        size?: WindowSize | null;
+        closed?: boolean;
+    };
+};
+export declare type WindowPosition = {
+    top: number;
+    left: number;
+};
+/**
+ * Resizable windows in Winamp have a base size and can be expanded in
+ * increments based on the size of the skin sprite.
+ *
+ * To specify a window being larger than its base size, use `extraHeight` to
+ * specify how many sprite increments to expand the window's height by, and
+ * `extraWidth` to specify how many sprite increments to expand the window's
+ * width by.
+ */
+export declare type WindowSize = {
+    extraHeight: number;
+    extraWidth: number;
 };
 /**
  * Many methods on the webamp instance deal with track.

package/{dist → built}/types/js/webampLazy.d.ts

@@ -1,5 +1,5 @@
 import ReactDOM from "react-dom/client";
-import { Store, Track, LoadedURLTrack, Middleware, ButterchurnOptions, PartialState, WindowLayout, Options, MediaStatus } from "./types";
+import { Store, Track, LoadedURLTrack, Middleware, ButterchurnOptions, PartialState, Options, MediaStatus } from "./types";
 import Media from "./media";
 import Emitter from "./emitter";
 import { SerializedStateV1 } from "./serializedStates/v1Types";
@@ -9,7 +9,6 @@ export interface PrivateOptions {
     requireMusicMetadata(): Promise<any>;
     __initialState?: PartialState;
     __customMiddlewares?: Middleware[];
-    __initialWindowLayout?: WindowLayout;
     __butterchurnOptions?: ButterchurnOptions;
     __customMediaClass?: typeof Media;
 }