@pulsesync/yamusic-types 0.0.1 → 0.0.3

package/README.md

@@ -20,13 +20,7 @@ npm run check
 npm run build
 ```
 
-## Локальная проверка перед публикацией
-
-```bash
-npm run pack
-```
-
-Для публикации:
+## Публикация
 
 ```bash
 npm run publish:public

package/dist/global.js

@@ -0,0 +1 @@
+export {};

package/dist/index.d.ts

@@ -69,6 +69,32 @@ export interface PulseSyncProgressState {
     remainingBufferedTime?: number;
     [key: string]: unknown;
 }
+export type PulseSyncPageEntityType = 'album' | 'playlist' | 'artist';
+export interface PulseSyncPageEntity {
+    readonly revision: number;
+    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;
@@ -256,6 +282,10 @@ export interface PulseSyncApi {
     setVolume: (volume: number) => void;
     setProgress: (progress: number) => void;
     playTrackById: (trackId: string, options?: PulseSyncTrackSelector) => void;
+    playPlaylistById: (playlistId: string, options?: PulseSyncTrackSelector & {
+        uuid?: string;
+        utmLink?: string;
+    }) => void;
     addTrackToQueueById: (trackId: string, options?: PulseSyncTrackSelector) => void;
     likeTrack: (trackId?: string, options?: PulseSyncTrackSelector) => boolean;
     unlikeTrack: (trackId?: string, options?: PulseSyncTrackSelector) => boolean;
@@ -263,6 +293,10 @@ export interface PulseSyncApi {
     undislikeTrack: (trackId?: string, options?: PulseSyncTrackSelector) => boolean;
     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;
@@ -271,8 +305,51 @@ export interface PulseSyncApi {
     getVolume: () => number | undefined;
     getRepeatMode: () => PulseSyncRepeatMode | undefined;
     isShuffle: () => boolean | undefined;
+    getPageEntity: (options?: {
+        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;
+    removeTrackReplacement: (trackId: string, ownerId?: string) => boolean;
+    clearTrackReplacements: (ownerId?: string) => boolean;
+    getDisplayMaxFps: () => number;
+    getPlatform: () => string;
+    getPremiumStatus: () => Promise<boolean>;
+    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", "getPlayerSnapshot", "getQueueSnapshot", "getRouteSnapshot", "getCurrentTrack", "getQueue", "getProgress", "getDuration", "getVolume", "getRepeatMode", "isShuffle", "getDisplayMaxFps", "getPlatform", "getPremiumStatus", "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

@@ -0,0 +1,42 @@
+export const PULSESYNC_WEB_HOST_API_VERSION = 1;
+export const PULSESYNC_WEB_HOST_API_V1_RPC_METHODS = Object.freeze([
+    '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',
+    'refreshPlayerBar',
+    'getPageEntity',
+    'setTrackReplacement',
+    'setTrackReplacements',
+    'removeTrackReplacement',
+    'clearTrackReplacements',
+]);

package/package.json

@@ -1,13 +1,20 @@
 {
   "name": "@pulsesync/yamusic-types",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "TypeScript declaration package for PulseSync YaMusic addon development",
   "license": "GPL-3.0-or-later",
+  "type": "module",
   "sideEffects": false,
   "types": "./dist/index.d.ts",
   "exports": {
-    ".": "./dist/index.d.ts",
-    "./global": "./dist/global.d.ts",
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./global": {
+      "types": "./dist/global.d.ts",
+      "import": "./dist/global.js"
+    },
     "./package.json": "./package.json"
   },
   "files": [