@pulsesync/yamusic-types 0.0.4 → 0.2.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2026 PulseSync
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2026 PulseSync
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,6 +1,12 @@
-# `@pulsesync/yamusic-types`
+# @pulsesync/yamusic-types
 
-TypeScript declaration package for PulseSync YaMusic addons.
+Типы TypeScript для API PulseSync и Яндекс Музыки. Для React-аддонов WebHost используйте [@pulsesync/addon-sdk](https://www.npmjs.com/package/@pulsesync/addon-sdk).
+
+## Установка
+
+```bash
+yarn add --dev @pulsesync/yamusic-types
+```
 
 ## Использование
 
@@ -8,22 +14,22 @@ TypeScript declaration package for PulseSync YaMusic addons.
 import type { PulseSyncApi, SonataState } from '@pulsesync/yamusic-types'
 ```
 
+Для типизации глобальных объектов `window` подключите отдельный модуль:
+
 ```ts
 import '@pulsesync/yamusic-types/global'
-```
 
-## Разработка
-
-```bash
-npm install
-npm run check
-npm run build
+const api = window.pulsesyncApi
 ```
 
-## Публикация
+Пакет описывает API, но не устанавливает мод и не создаёт объекты во время выполнения. Доступность методов зависит от версии PulseSync и окружения; глобальные объекты могут отсутствовать.
+
+## Разработка
 
 ```bash
-npm run publish:public
+yarn install
+yarn run check
+yarn build
 ```
 
-Нужен `.env` с `NPM_TOKEN=...`.
+Лицензия: GPL-3.0-or-later.

package/dist/addonModules.d.ts

@@ -0,0 +1,63 @@
+export type AddonModuleKind = 'javascript' | 'wasm';
+export type AddonModuleAccess = 'public' | 'protected';
+export type AddonModuleStatus = 'draft' | 'pending' | 'accepted' | 'rejected' | 'revoked';
+export type AddonModuleChannel = 'stable' | 'dev';
+export type AddonModuleReference = Readonly<{
+    moduleId: string;
+    apiMajor: number;
+    optional?: boolean;
+} & ({
+    channel: AddonModuleChannel;
+    version?: never;
+} | {
+    version: string;
+    channel?: never;
+})>;
+export type AddonModuleReferences = Readonly<Record<string, AddonModuleReference>>;
+export type AddonModuleErrorCode = 'unsupported-host' | 'undeclared-module' | 'unavailable' | 'revoked' | 'access-denied' | 'incompatible-api' | 'integrity-mismatch' | 'aborted' | 'initialization-failed' | 'reload-required';
+export interface AddonModuleDescriptor {
+    readonly formatVersion: 1;
+    readonly moduleId: string;
+    readonly versionId: string;
+    readonly version: string;
+    readonly apiMajor: number;
+    readonly kind: AddonModuleKind;
+    readonly access: AddonModuleAccess;
+    readonly sha256: string;
+    readonly size: number;
+}
+export interface AddonModuleSecurityManifest {
+    readonly formatVersion: 1;
+    readonly runtime: 'isolated';
+    readonly kind: 'web-addon';
+    readonly apiVersion: number;
+    readonly capabilities: readonly ['modules-v1'];
+    readonly allowedUrls: readonly string[];
+    readonly modules: AddonModuleReferences;
+}
+export interface AddonModuleReleaseBinding {
+    readonly formatVersion: 1;
+    readonly catalogAddonId: string;
+    readonly releaseId: string;
+    readonly runtimeId: string;
+    readonly codeHash: string;
+    readonly manifestHash: string;
+}
+export interface AddonModuleResolution {
+    readonly activationId: string;
+    readonly releaseBinding: string;
+    readonly descriptors: Readonly<Record<string, AddonModuleDescriptor>>;
+    readonly errors: Readonly<Record<string, AddonModuleErrorCode>>;
+}
+export interface AddonModuleChallenge {
+    readonly challenge: string;
+    readonly moduleVersionId: string;
+    readonly expiresAt: number;
+}
+export interface AddonModuleLoadOptions {
+    readonly authorize?: (challenge: AddonModuleChallenge) => Promise<string>;
+}
+export interface AddonModules {
+    load<T = unknown>(alias: string, options?: AddonModuleLoadOptions): Promise<T>;
+    instantiateWasm<T = Readonly<Record<string, (...args: never[]) => unknown>>>(alias: string, options?: AddonModuleLoadOptions): Promise<T>;
+}

package/dist/addonModules.js

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

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+export type * from './addonModules.js';
 export type AddonSettingValue<T> = {
     value?: T;
     default?: T;
@@ -20,6 +21,53 @@ export interface PulseSyncTrackSelector {
 export interface PulseSyncToastOptions {
     durationMs?: number;
 }
+export interface NotificationOptions {
+    durationMs?: number;
+    icon?: string;
+    coverUrl?: string;
+    link?: {
+        label: string;
+        href: string;
+    };
+}
+export interface ModalOptions {
+    title: string;
+    message: string;
+    confirmLabel?: string;
+    cancelLabel?: string;
+}
+export type NativeField = {
+    name: string;
+    label: string;
+    disabled?: boolean;
+    required?: boolean;
+} & ({
+    type: 'text';
+    value?: string;
+    placeholder?: string;
+    minLength?: number;
+    maxLength?: number;
+} | {
+    type: 'switch';
+    value?: boolean;
+} | {
+    type: 'slider';
+    value?: number;
+    min?: number;
+    max?: number;
+    step?: number;
+} | {
+    type: 'select';
+    value?: string;
+    options: readonly {
+        value: string;
+        label: string;
+    }[];
+});
+export type FormValues = Record<string, string | boolean | number>;
+export interface FormModalOptions extends ModalOptions {
+    fields: readonly NativeField[];
+}
 export interface PulseSyncTrackArtist {
     id?: string | number;
     name?: string;
@@ -324,11 +372,15 @@ export interface PulseSyncApi {
     getPlatform: () => string;
     getPremiumStatus: () => Promise<boolean>;
     showToast: (message: string, options?: PulseSyncToastOptions, ownerId?: string) => Promise<void>;
+    showNotification: (message: string, kind: 'info' | 'error', options?: NotificationOptions, ownerId?: string) => Promise<void>;
+    showModal: (kind: 'alert' | 'confirm', options: ModalOptions, ownerId?: string, requestId?: string) => Promise<boolean>;
+    closeModal: (requestId: string, ownerId?: string) => Promise<boolean>;
+    showFormModal: (options: FormModalOptions, ownerId?: string, requestId?: string) => Promise<FormValues | null>;
     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", "showToast", "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", "showNotification", "showModal", "closeModal", "showFormModal", "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;

package/dist/index.js

@@ -34,6 +34,10 @@ export const PULSESYNC_WEB_HOST_API_V1_RPC_METHODS = Object.freeze([
     'getPlatform',
     'getPremiumStatus',
     'showToast',
+    'showNotification',
+    'showModal',
+    'closeModal',
+    'showFormModal',
     'refreshPlayerBar',
     'getPageEntity',
     'setTrackReplacement',

package/package.json

@@ -1,9 +1,14 @@
 {
   "name": "@pulsesync/yamusic-types",
-  "version": "0.0.4",
+  "version": "0.2.0",
   "description": "TypeScript declaration package for PulseSync YaMusic addon development",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/PulseSync-LLC/PulseSync-yamusic-types.git"
+  },
   "license": "GPL-3.0-or-later",
   "type": "module",
+  "packageManager": "yarn@1.22.22",
   "sideEffects": false,
   "types": "./dist/index.d.ts",
   "exports": {
@@ -23,13 +28,14 @@
     "LICENSE"
   ],
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
   },
   "scripts": {
     "build": "tsc -p tsconfig.json",
     "check": "tsc -p tsconfig.json --noEmit",
     "pack": "npm run build && npm pack --cache ./.npm-cache",
-    "publish:public": "npm run build && dotenv -e .env -- npm publish --access public --cache ./.npm-cache"
+    "publish:public": "yarn run check && yarn build && npm publish --access public --registry=https://registry.npmjs.org/ --cache ./.npm-cache"
   },
   "devDependencies": {
     "dotenv-cli": "^11.0.0",