@pulsesync/yamusic-types 0.0.2 → 0.0.4

package/dist/index.d.ts

@@ -17,6 +17,9 @@ export interface PulseSyncTrackSelector {
     from?: string;
     position?: 'next' | 'last' | string;
 }
+export interface PulseSyncToastOptions {
+    durationMs?: number;
+}
 export interface PulseSyncTrackArtist {
     id?: string | number;
     name?: string;
@@ -75,6 +78,26 @@ export interface PulseSyncPageEntity {
     readonly type: PulseSyncPageEntityType;
     readonly entity: unknown;
 }
+export interface PulseSyncPlayerSnapshot {
+    readonly status: PulseSyncPlayerStatus;
+    readonly isPlaying: boolean;
+    readonly track: PulseSyncTrackMeta | null;
+    readonly progress: number | PulseSyncProgressState | null;
+    readonly duration: number | null;
+    readonly volume: number | null;
+    readonly repeatMode: PulseSyncRepeatMode | null;
+    readonly shuffle: boolean;
+}
+export interface PulseSyncQueueSnapshot {
+    readonly currentIndex: number | null;
+    readonly items: readonly PulseSyncTrackMeta[];
+}
+export interface PulseSyncRouteSnapshot {
+    readonly href: string;
+    readonly pathname: string;
+    readonly search: string;
+    readonly hash: string;
+}
 export interface PulseSyncObservableState<T> {
     value?: T;
     onChange?: (callback: (value: T) => void, options?: Record<string, unknown>) => (() => void) | void;
@@ -274,6 +297,9 @@ export interface PulseSyncApi {
     isTrackLiked: (trackId?: string, albumId?: string) => boolean;
     isTrackDisliked: (trackId?: string, albumId?: string) => boolean;
     isPlaying: () => boolean;
+    getPlayerSnapshot: () => PulseSyncPlayerSnapshot;
+    getQueueSnapshot: () => PulseSyncQueueSnapshot;
+    getRouteSnapshot: () => PulseSyncRouteSnapshot;
     getState: () => PulseSyncPlayerState | null | undefined;
     getCurrentTrack: () => PulseSyncTrackMeta | undefined;
     getQueue: () => PulseSyncQueueItem[] | undefined;
@@ -286,6 +312,9 @@ export interface PulseSyncApi {
         includeArtistBrief?: boolean;
     }) => Promise<PulseSyncPageEntity | null>;
     onCurrentTrackChange: (listener: (track: PulseSyncTrackMeta | null) => void) => () => void;
+    onPlayerSnapshotChange: (listener: (snapshot: PulseSyncPlayerSnapshot) => void) => () => void;
+    onQueueChange: (listener: (snapshot: PulseSyncQueueSnapshot) => void) => () => void;
+    onRouteChange: (listener: (snapshot: PulseSyncRouteSnapshot) => void) => () => void;
     onPageEntityChange: (listener: (snapshot: PulseSyncPageEntity) => void) => () => void;
     setTrackReplacement: (trackId: string, url: string, ownerId?: string) => boolean;
     setTrackReplacements: (replacements: Readonly<Record<string, string>>, ownerId?: string) => number;
@@ -294,19 +323,37 @@ export interface PulseSyncApi {
     getDisplayMaxFps: () => number;
     getPlatform: () => string;
     getPremiumStatus: () => Promise<boolean>;
+    showToast: (message: string, options?: PulseSyncToastOptions, ownerId?: string) => Promise<void>;
     refreshPlayerBar: () => void;
     getSettings: <TSettings extends AddonSettings = AddonSettings>(addonId: string) => AddonSettingsStore<TSettings>;
 }
 export declare const PULSESYNC_WEB_HOST_API_VERSION: 1;
-export declare const PULSESYNC_WEB_HOST_API_V1_RPC_METHODS: readonly ["playVibe", "play", "pause", "togglePlayPause", "next", "previous", "setRepeatMode", "toggleShuffle", "setVolume", "setProgress", "playTrackById", "playPlaylistById", "addTrackToQueueById", "likeTrack", "unlikeTrack", "dislikeTrack", "undislikeTrack", "isTrackLiked", "isTrackDisliked", "isPlaying", "getCurrentTrack", "getQueue", "getProgress", "getDuration", "getVolume", "getRepeatMode", "isShuffle", "getDisplayMaxFps", "getPlatform", "getPremiumStatus", "refreshPlayerBar", "getPageEntity", "setTrackReplacement", "setTrackReplacements", "removeTrackReplacement", "clearTrackReplacements"];
+export declare const PULSESYNC_WEB_HOST_API_V1_RPC_METHODS: readonly ["playVibe", "play", "pause", "togglePlayPause", "next", "previous", "setRepeatMode", "toggleShuffle", "setVolume", "setProgress", "playTrackById", "playPlaylistById", "addTrackToQueueById", "likeTrack", "unlikeTrack", "dislikeTrack", "undislikeTrack", "isTrackLiked", "isTrackDisliked", "isPlaying", "getPlayerSnapshot", "getQueueSnapshot", "getRouteSnapshot", "getCurrentTrack", "getQueue", "getProgress", "getDuration", "getVolume", "getRepeatMode", "isShuffle", "getDisplayMaxFps", "getPlatform", "getPremiumStatus", "showToast", "refreshPlayerBar", "getPageEntity", "setTrackReplacement", "setTrackReplacements", "removeTrackReplacement", "clearTrackReplacements"];
 export type PulseSyncWebHostApiV1RpcMethod = (typeof PULSESYNC_WEB_HOST_API_V1_RPC_METHODS)[number];
 export type PulseSyncWebHostRpcApiV1 = {
     readonly [TMethod in PulseSyncWebHostApiV1RpcMethod]: PulseSyncApi[TMethod] extends (...args: infer TArgs) => infer TResult ? (...args: TArgs) => Promise<Awaited<TResult>> : never;
 };
 export type PulseSyncWebHostApiV1 = PulseSyncWebHostRpcApiV1 & {
     onCurrentTrackChange: (listener: (track: PulseSyncTrackMeta | null) => void) => () => void;
+    onPlayerSnapshotChange: (listener: (snapshot: PulseSyncPlayerSnapshot) => void) => () => void;
+    onQueueChange: (listener: (snapshot: PulseSyncQueueSnapshot) => void) => () => void;
+    onRouteChange: (listener: (snapshot: PulseSyncRouteSnapshot) => void) => () => void;
     onPageEntityChange: (listener: (snapshot: PulseSyncPageEntity) => void) => () => void;
 };
+export type PulseSyncPlayerApiV1 = {
+    getSnapshot: PulseSyncWebHostApiV1['getPlayerSnapshot'];
+    onChange: PulseSyncWebHostApiV1['onPlayerSnapshotChange'];
+    onQueueChange: PulseSyncWebHostApiV1['onQueueChange'];
+    onTrackChange: PulseSyncWebHostApiV1['onCurrentTrackChange'];
+};
+export type PulseSyncPageApiV1 = {
+    getSnapshot: PulseSyncWebHostApiV1['getPageEntity'];
+    onChange: PulseSyncWebHostApiV1['onPageEntityChange'];
+};
+export type PulseSyncRouterApiV1 = {
+    getSnapshot: PulseSyncWebHostApiV1['getRouteSnapshot'];
+    onChange: PulseSyncWebHostApiV1['onRouteChange'];
+};
 export interface WolfyPlayerState {
     speed: number;
     status: PulseSyncPlayerStatus;

package/dist/index.js

@@ -20,6 +20,9 @@ export const PULSESYNC_WEB_HOST_API_V1_RPC_METHODS = Object.freeze([
     'isTrackLiked',
     'isTrackDisliked',
     'isPlaying',
+    'getPlayerSnapshot',
+    'getQueueSnapshot',
+    'getRouteSnapshot',
     'getCurrentTrack',
     'getQueue',
     'getProgress',
@@ -30,6 +33,7 @@ export const PULSESYNC_WEB_HOST_API_V1_RPC_METHODS = Object.freeze([
     'getDisplayMaxFps',
     'getPlatform',
     'getPremiumStatus',
+    'showToast',
     'refreshPlayerBar',
     'getPageEntity',
     'setTrackReplacement',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pulsesync/yamusic-types",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "TypeScript declaration package for PulseSync YaMusic addon development",
   "license": "GPL-3.0-or-later",
   "type": "module",