All files / src/apps/gbs-music-web/lib api.ts

0% Statements 0/201
0% Branches 0/100
0% Functions 0/83
0% Lines 0/182

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             
import { clearL10NData, setL10NData } from "shared/lib/lang/l10n";
import type {
  MusicDataPacket,
  MusicDataReceivePacket,
} from "shared/lib/music/types";
import type { MusicMidiState } from "shared/lib/music/midi";
import type { Song } from "shared/lib/uge/types";
import type { MusicAsset } from "shared/lib/resources/types";
import {
  downloadBytes,
  pickUGIFile,
  pickUGWFile,
  webMusicEnvironment,
} from "./adapters";
import {
  deleteStoredSetting,
  defaultLocaleData,
  getStoredLocaleId,
  getStoredSetting,
  getStoredThemeId,
  getThemeById,
  loadLocaleData,
  setStoredSetting,
} from "./preferences";
import type { MusicSession } from "components/music/helpers/musicSession";
import { MusicEditorStore } from "gbs-music-web/store/configureStore";
import { TRACKER_REDO, TRACKER_UNDO } from "consts";
 
type MusicResponseListener = (
  _event: unknown,
  data: MusicDataReceivePacket,
) => void;
type MenuListener = (_event: unknown) => void;
type TrackerKeyBindingsListener = (_event: unknown, value: number) => void;
 
const clipboardBufferStore = new Map<string, Uint8Array>();
const musicResponseListeners = new Set<MusicResponseListener>();
const menuSelectAllListeners = new Set<MenuListener>();
const trackerKeyBindingsListeners = new Set<TrackerKeyBindingsListener>();
const themeListeners = new Set<
  (theme: ReturnType<typeof getThemeById>) => void
>();
let clipboardTextStore = "";
let currentThemeId = getStoredThemeId();
let currentLocaleId = getStoredLocaleId();
let musicSessionPromise: Promise<MusicSession> | null = null;
 
const ensureMusicSession = async () => {
  Iif (!musicSessionPromise) {
    musicSessionPromise = import("components/music/helpers/musicSession").then(
      (module) => {
        const session = module.default();
        session.subscribe((data) => {
          emitMusicData(data);
        });
        return session;
      },
    );
  }
  return musicSessionPromise;
};
 
const applyLocale = async (localeId: string) => {
  currentLocaleId = localeId;
  const localeData = await loadLocaleData(localeId);
  Iif (currentLocaleId !== localeId) {
    return;
  }
  clearL10NData();
  setL10NData(defaultLocaleData);
  setL10NData(localeData);
};
 
const applyTheme = (themeId: string) => {
  currentThemeId = themeId;
  const theme = getThemeById(themeId);
  themeListeners.forEach((listener) => listener(theme));
};
 
const emitMusicData = (data: MusicDataReceivePacket) => {
  musicResponseListeners.forEach((listener) => listener(undefined, data));
};
 
const emitMenuSelectAll = () => {
  menuSelectAllListeners.forEach((listener) => listener(undefined));
};
 
const emitTrackerKeyBindingsChanged = (value: number) => {
  trackerKeyBindingsListeners.forEach((listener) => listener(undefined, value));
};
 
const isEditableTarget = (target: EventTarget | null) => {
  const element = target as HTMLElement | null;
  return (
    !!element &&
    (element.nodeName === "INPUT" ||
      element.nodeName === "TEXTAREA" ||
      element.isContentEditable)
  );
};
 
const dispatchClipboardEvent = (type: "copy" | "cut" | "paste") => {
  const target =
    document.activeElement instanceof HTMLElement
      ? document.activeElement
      : document.body;
 
  target.dispatchEvent(
    new Event(type, {
      bubbles: true,
      cancelable: true,
    }),
  );
};
 
const readClipboardText = async () => {
  try {
    const text = await navigator.clipboard?.readText?.();
    Iif (typeof text === "string" && text.length > 0) {
      clipboardTextStore = text;
      return text;
    }
  } catch {
    // Fall back to the in-memory clipboard when browser permissions block reads.
  }
  return clipboardTextStore;
};
 
const writeClipboardText = async (value: string) => {
  clipboardTextStore = value;
  try {
    await navigator.clipboard?.writeText?.(value);
  } catch {
    // Keep the in-memory clipboard so copy/paste still works inside the web app.
  }
};
 
const flushClipboardTextToSystem = async () => {
  try {
    await navigator.clipboard?.writeText?.(clipboardTextStore);
  } catch {
    // Some browsers only allow clipboard writes in specific contexts.
  }
};
 
const loadSongFromFilename = async (filename: string): Promise<Song | null> => {
  const { loadUGESong } = await import("shared/lib/uge/ugeHelper");
  const document = await webMusicEnvironment.loadDocument({
    id: filename,
    name: filename.split("/").pop() || filename,
    filename,
    format: "uge",
  });
  const buffer = Buffer.from(document.data);
  const song = loadUGESong(buffer);
  Iif (song) {
    song.filename = filename;
  }
  return song;
};
 
const saveSongToFilename = async (song: Song) => {
  const { saveUGESong } = await import("shared/lib/uge/ugeHelper");
  try {
    const data = saveUGESong(song);
    await webMusicEnvironment.saveDocument({
      meta: {
        id: song.filename,
        name: song.filename.split("/").pop() || song.filename,
        filename: song.filename,
        format: "uge",
      },
      data: new Uint8Array(data),
      modified: false,
    });
  } catch (e) {
    console.error(e);
    alert(e);
  }
};
 
export const installWebRendererApi = (store: MusicEditorStore) => {
  void applyLocale(currentLocaleId);
 
  window.addEventListener("keydown", (event) => {
    Iif (!(event.metaKey || event.ctrlKey) || event.altKey) {
      return;
    }
 
    Iif (isEditableTarget(event.target)) {
      return;
    }
 
    const key = event.key.toLowerCase();
 
    Iif (key === "a") {
      event.preventDefault();
      emitMenuSelectAll();
      return;
    }
 
    Iif (key === "c" || key === "x") {
      event.preventDefault();
      const command = key === "c" ? "copy" : "cut";
      Iif (!document.execCommand(command)) {
        dispatchClipboardEvent(command);
        void flushClipboardTextToSystem();
      }
      return;
    }
 
    Iif (key === "v") {
      event.preventDefault();
      dispatchClipboardEvent("paste");
      return;
    }
 
    Iif (key === "z") {
      if (event.shiftKey) {
        Iif (store.getState().trackerDocument.future.length > 0) {
          store.dispatch({ type: TRACKER_REDO });
        }
      } else {
        Iif (store.getState().trackerDocument.past.length > 0) {
          store.dispatch({ type: TRACKER_UNDO });
        }
      }
    }
  });
 
  type NavigatorUA = Navigator & {
    userAgentData?: {
      platform: string;
    };
  };
 
  const isMacOS = () => {
    const nav = navigator as NavigatorUA;
    return (
      nav.userAgentData?.platform === "macOS" ||
      navigator.platform.toUpperCase().includes("MAC")
    );
  };
 
  const API = {
    platform: isMacOS() ? "darwin" : "web",
    env: "web",
    l10n: {
      getL10NStrings: () => loadLocaleData(currentLocaleId),
    },
    theme: {
      getTheme: () => Promise.resolve(getThemeById(currentThemeId)),
      onChange: (
        callback: (theme: ReturnType<typeof getThemeById>) => void,
      ) => {
        themeListeners.add(callback);
        return () => themeListeners.delete(callback);
      },
    },
    settings: {
      get: (key: string) => Promise.resolve(getStoredSetting(key)),
      getString: (key: string, fallback: string) =>
        Promise.resolve((getStoredSetting(key) as string) ?? fallback),
      getNumber: (key: string, fallback: number) =>
        Promise.resolve((getStoredSetting(key) as number) ?? fallback),
      set: (key: string, value: unknown) => {
        setStoredSetting(key, value);
        return Promise.resolve();
      },
      delete: (key: string) => {
        deleteStoredSetting(key);
        return Promise.resolve();
      },
      app: {
        openExternal: (url: string) => window.open(url, "_blank"),
        setUIScale: () => Promise.resolve(),
        getUIScale: () => Promise.resolve(0),
        setTrackerKeyBindings: (value: number) => {
          const currentValue =
            (getStoredSetting("trackerKeyBindings") as number) ?? 0;
          setStoredSetting("trackerKeyBindings", value);
          Iif (currentValue !== value) {
            emitTrackerKeyBindingsChanged(value);
          }
          return Promise.resolve();
        },
        getTrackerKeyBindings: () =>
          Promise.resolve(
            (getStoredSetting("trackerKeyBindings") as number) ?? 0,
          ),
      },
    },
    dialog: {
      confirmUnsavedChangesTrackerDialog: () => Promise.resolve(2),
      showError: () => Promise.resolve(),
    },
    clipboard: {
      readText: readClipboardText,
      readBuffer: async (format: string) =>
        Buffer.from(clipboardBufferStore.get(format) ?? new Uint8Array()),
      writeText: writeClipboardText,
      writeBuffer: async (format: string, buffer: Uint8Array) => {
        clipboardBufferStore.set(format, Uint8Array.from(buffer));
      },
    },
    tracker: {
      addNewUGEFile: async (path: string) => {
        const { createSong } = await import("shared/lib/uge/song");
        const song = createSong();
        song.filename = path;
        await saveSongToFilename(song);
        return {
          _v: 0,
          inode: path,
          _resourceType: "music",
          id: path,
          name:
            path
              .split("/")
              .pop()
              ?.replace(/\.[^.]+$/, "") || path,
          symbol: `song_${path.replace(/[^a-zA-Z0-9]+/g, "_")}`,
          filename: path,
          settings: {},
          type: "uge",
        } as MusicAsset;
      },
      loadUGEFile: loadSongFromFilename,
      saveUGEFile: saveSongToFilename,
      convertModToUge: async (_asset: MusicAsset) => {
        throw new Error(
          "MOD conversion is not yet available in the web editor",
        );
      },
      exportInstrument: async (
        instrument: import("shared/lib/uge/ugiHelper").UGIInstrument,
      ) => {
        const { saveUGIInstrument } = await import("shared/lib/uge/ugiHelper");
        const data = saveUGIInstrument(instrument);
        const safeName =
          instrument.name.replace(/[^a-zA-Z0-9_-]/g, "_") || "instrument";
        downloadBytes(`${safeName}.ugi`, new Uint8Array(data));
      },
      importInstrument: async (): Promise<
        import("shared/lib/uge/ugiHelper").UGIInstrument | null
      > => {
        const { loadUGIInstrument } = await import("shared/lib/uge/ugiHelper");
        const bytes = await pickUGIFile();
        Iif (!bytes) return null;
        return loadUGIInstrument(Buffer.from(bytes));
      },
      exportWave: async (wave: Uint8Array, suggestedName: string) => {
        const { saveUGWave } = await import("shared/lib/uge/ugwHelper");
        const data = saveUGWave(wave);
        downloadBytes(`${suggestedName || "wave"}.ugw`, new Uint8Array(data));
      },
      importWave: async (): Promise<Uint8Array | null> => {
        const { loadUGWave } = await import("shared/lib/uge/ugwHelper");
        const bytes = await pickUGWFile();
        Iif (!bytes) return null;
        return loadUGWave(Buffer.from(bytes));
      },
    },
    music: {
      openMusic: () => {
        void ensureMusicSession().then((session) => {
          session.open();
        });
      },
      closeMusic: () => {
        void ensureMusicSession().then((_session) => {
          // @TODO Should this be added?
        });
      },
      sendToMusicWindow: (data: MusicDataPacket) => {
        void ensureMusicSession().then((session) => {
          session.send(data);
        });
      },
      updateMidiInputMenuState: (_state: MusicMidiState) => undefined,
      playUGE: async () => undefined,
      playMOD: async () => undefined,
    },
    events: {
      music: {
        response: {
          subscribe: (listener: MusicResponseListener) => {
            musicResponseListeners.add(listener);
            return () => musicResponseListeners.delete(listener);
          },
        },
      },
      menu: {
        selectAll: {
          subscribe: (listener: MenuListener) => {
            menuSelectAllListeners.add(listener);
            return () => menuSelectAllListeners.delete(listener);
          },
        },
        pasteInPlace: {
          subscribe: () => () => undefined,
        },
        midiInputToggle: {
          subscribe: () => () => undefined,
        },
        midiInputSelect: {
          subscribe: () => () => undefined,
        },
      },
      settings: {
        uiScaleChanged: {
          subscribe: () => () => undefined,
        },
        trackerKeyBindingsChanged: {
          subscribe: (listener: TrackerKeyBindingsListener) => {
            trackerKeyBindingsListeners.add(listener);
            return () => trackerKeyBindingsListeners.delete(listener);
          },
        },
        settingChanged: {
          subscribe: () => () => undefined,
        },
      },
    },
  };
 
  (window as typeof window & { API?: typeof API }).API = API;
};
 
const getThemeId = () => currentThemeId;
 
const setThemeId = (themeId: string) => {
  setStoredSetting("themeId", themeId);
  applyTheme(themeId);
};
 
const getLocaleId = () => currentLocaleId;
 
const setLocaleId = async (localeId: string) => {
  setStoredSetting("locale", localeId);
  await applyLocale(localeId);
};
 
const WebAPI = { getThemeId, setThemeId, getLocaleId, setLocaleId };
 
export default WebAPI;