alphatheta-connect 0.15.0 → 0.18.0

package/lib/constants.d.ts

@@ -37,4 +37,10 @@ export declare const VIRTUAL_CDJ_NAME = "ProLink-Connect";
  * VirtualCDJFirmware is a string indicating the firmware version reported with
  * status packets.
  */
-export declare const VIRTUAL_CDJ_FIRMWARE = "1.43";
+export declare const VIRTUAL_CDJ_FIRMWARE = "3.20";
+/**
+ * CDJs use device IDs 1-6. Devices outside this range (e.g. Stagehand at 154)
+ * should not be queried for media slots or databases as they may crash.
+ */
+export declare const MIN_CDJ_DEVICE_ID = 1;
+export declare const MAX_CDJ_DEVICE_ID = 6;

package/lib/db/getArtworkFromFile.d.ts

@@ -1,4 +1,5 @@
 import { Track } from "../entities";
+import { type Logger } from "../logger";
 import { Device, DeviceID, MediaSlot } from "../types";
 import { TelemetrySpan as Span } from "../utils/telemetry";
 export interface Options {
@@ -6,6 +7,7 @@ export interface Options {
     trackSlot: MediaSlot;
     track: Track;
     span?: Span;
+    logger?: Logger;
 }
 /**
  * Extract artwork directly from an audio file via NFS.

package/lib/db/getFile.d.ts

@@ -1,5 +1,6 @@
 import { Track } from "../entities";
 import LocalDatabase from "../localdb";
+import { type Logger } from "../logger";
 import RemoteDatabase from "../remotedb";
 import { Device, DeviceID, MediaSlot, TrackType } from "../types";
 import { TelemetrySpan as Span } from "../utils/telemetry";
@@ -24,6 +25,10 @@ export interface Options {
      * The Sentry transaction span
      */
     span?: Span;
+    /**
+     * Logger instance for diagnostic output
+     */
+    logger?: Logger;
 }
-export declare function viaRemote(_remote: RemoteDatabase, _device: Device, _opts: Required<Options>): null;
-export declare function viaLocal(local: LocalDatabase, device: Device, opts: Required<Options>): Promise<Buffer<ArrayBuffer> | null>;
+export declare function viaRemote(_remote: RemoteDatabase, _device: Device, _opts: Options): null;
+export declare function viaLocal(local: LocalDatabase, device: Device, opts: Options): Promise<Buffer<ArrayBuffer> | null>;

package/lib/db/getMetadata.d.ts

@@ -1,3 +1,4 @@
+import { Track } from "../entities";
 import LocalDatabase from "../localdb";
 import RemoteDatabase from "../remotedb";
 import { Device, DeviceID, MediaSlot, TrackType } from "../types";
@@ -24,5 +25,5 @@ export interface Options {
      */
     span?: Span;
 }
-export declare function viaRemote(remote: RemoteDatabase, opts: Required<Options>): Promise<import("../types").Track<import("..").EntityFK.WithRelations> | null>;
-export declare function viaLocal(local: LocalDatabase, device: Device, opts: Required<Options>): Promise<import("../types").Track | null>;
+export declare function viaRemote(remote: RemoteDatabase, opts: Required<Options>): Promise<Track<import("../entities").EntityFK.WithRelations> | null>;
+export declare function viaLocal(local: LocalDatabase, device: Device, opts: Required<Options>): Promise<Track | null>;

package/lib/db/getTrackAnalysis.d.ts

@@ -0,0 +1,28 @@
+import { Track } from "../entities";
+import LocalDatabase from "../localdb";
+import { Device, DeviceID, ExtendedCue, MediaSlot, SongStructure, TrackType, VocalConfig, Waveform3BandDetail, Waveform3BandPreview, WaveformHD } from "../types";
+import { TelemetrySpan as Span } from "../utils/telemetry";
+export interface TrackAnalysis {
+    /** Extended cues with colors and comments (PCO2 tag) */
+    extendedCues: ExtendedCue[] | null;
+    /** Song structure / phrase analysis (PSSI tag) */
+    songStructure: SongStructure | null;
+    /** Color waveform preview (PWV4 tag) */
+    waveformColorPreview: Uint8Array | undefined;
+    /** HD waveform data (PWV5 tag) */
+    waveformHd: WaveformHD | null;
+    /** 3-band color waveform preview (PWV6 tag from .2EX) */
+    waveform3BandPreview: Waveform3BandPreview | null;
+    /** 3-band color detail waveform (PWV7 tag from .2EX) */
+    waveform3BandDetail: Waveform3BandDetail | null;
+    /** Vocal detection config (PWVC tag from .2EX) */
+    vocalConfig: VocalConfig | null;
+}
+export interface Options {
+    deviceId: DeviceID;
+    trackSlot: MediaSlot;
+    trackType: TrackType;
+    track: Track;
+    span?: Span;
+}
+export declare function viaLocal(local: LocalDatabase, device: Device, opts: Required<Options>): Promise<TrackAnalysis | null>;

package/lib/db/index.d.ts

@@ -3,24 +3,19 @@ import { Track } from "../entities";
 import LocalDatabase from "../localdb";
 import { DatabaseType } from "../localdb/database-adapter";
 import RemoteDatabase from "../remotedb";
-import { Device, MediaSlot, PlaylistContents, Waveforms } from "../types";
+import { MediaSlot, PlaylistContents, Waveforms } from "../types";
 import * as GetArtworkFromFile from './getArtworkFromFile';
 import * as GetArtworkThumbnail from './getArtworkThumbnail';
 import * as GetMetadata from './getMetadata';
 import * as GetPlaylist from './getPlaylist';
+import * as GetTrackAnalysis from './getTrackAnalysis';
 /**
  * A Database is the central service used to query devices on the prolink
  * network for information from their databases.
  */
 declare class Database {
     #private;
-    constructor(hostDevice: Device, local: LocalDatabase, remote: RemoteDatabase, deviceManager: DeviceManager);
-    /**
-     * Reports weather or not the CDJs can be communicated to over the remote
-     * database protocol. This is important when trying to query for unanalyzed or
-     * compact disc tracks.
-     */
-    get cdjSupportsRemotedb(): boolean;
+    constructor(local: LocalDatabase, remote: RemoteDatabase, deviceManager: DeviceManager);
     /**
      * Get the database type (oneLibrary or pdb) for a loaded device slot.
      * Returns null if the slot uses remote database or no database is loaded.
@@ -58,6 +53,11 @@ declare class Database {
      * Retrieves the waveforms for a track on a specific device slot.
      */
     getWaveforms(opts: GetArtworkThumbnail.Options): Promise<Waveforms | null>;
+    /**
+     * Retrieves all analysis data from the EXT file for a track.
+     * Returns extended cues, song structure, waveform color preview, and HD waveform.
+     */
+    getTrackAnalysis(opts: GetTrackAnalysis.Options): Promise<GetTrackAnalysis.TrackAnalysis | null>;
     /**
      * Retrieve folders, playlists, and tracks within the playlist tree. The id
      * may be left undefined to query the root of the playlist tree.

package/lib/entities.d.ts

@@ -1,122 +1,24 @@
-import { BeatGrid, CueAndLoop, WaveformHD } from "./types";
+import type { BeatGrid, WaveformHD } from "./types";
+import type { Track as OneLibraryTrack } from 'onelibrary-connect';
 /**
- * Documentation type strictly for use with entities that have foreign key
- * attributes.
+ * Re-export entity types from onelibrary-connect.
+ * These types represent what is stored in the rekordbox database.
  */
-export declare enum EntityFK {
-    WithFKs = 0,
-    WithRelations = 1
-}
-export interface Artwork {
-    id: number;
-    path?: string;
-}
-export interface Key {
-    id: number;
-    name: string;
-}
-export interface Label {
-    id: number;
-    name: string;
-}
-export interface Color {
-    id: number;
-    name: string;
-}
-export interface Genre {
-    id: number;
-    name: string;
-}
-export interface Album {
-    id: number;
-    name: string;
-}
-export interface Artist {
-    id: number;
-    name: string;
-}
-export interface Playlist {
-    id: number;
-    name: string;
-    isFolder: boolean;
-    parentId: number | null;
-}
-interface PlaylistEntryRelations {
-    track: Track;
-}
-interface PlaylistEntryFks {
-    playlistId: number;
-    trackId: number;
-}
-export type PlaylistEntry<withFKs extends EntityFK = EntityFK.WithRelations> = {
-    id: number;
-    sortIndex: number;
-} & (withFKs extends EntityFK.WithFKs ? PlaylistEntryFks : PlaylistEntryRelations);
-interface TrackRelations {
-    artwork: Artwork | null;
-    artist: Artist | null;
-    originalArtist: Artist | null;
-    remixer: Artist | null;
-    composer: Artist | null;
-    album: Album | null;
-    label: Label | null;
-    genre: Genre | null;
-    color: Color | null;
-    key: Key | null;
-}
-interface TrackFks {
-    artworkId?: number;
-    artistId?: number;
-    originalArtistId?: number;
-    remixerId?: number;
-    composerId?: number;
-    albumId?: number;
-    labelId?: number;
-    genreId?: number;
-    colorId?: number;
-    keyId?: number;
-}
+export { EntityFK } from 'onelibrary-connect';
+export type { Album, Artist, Artwork, Color, Genre, Key, Label, Playlist, PlaylistEntry, } from 'onelibrary-connect';
 /**
- * Represents a track.
+ * Represents a track with both database fields and ANLZ analysis data.
  *
- * Note, fields that are not optional will be set for all database request
- * methods.
+ * Extends the onelibrary-connect Track type with ANLZ-specific fields
+ * that are populated from .DAT/.EXT analysis files on the CDJ.
  */
-export type Track<withFKs extends EntityFK = EntityFK.WithRelations> = {
-    id: number;
-    title: string;
-    duration: number;
-    bitrate?: number;
-    tempo: number;
-    rating: number;
-    comment: string;
-    filePath: string;
-    fileName: string;
-    trackNumber?: number;
-    discNumber?: number;
-    sampleRate?: number;
-    sampleDepth?: number;
-    playCount?: number;
-    year?: number;
-    mixName?: string;
-    autoloadHotcues?: boolean;
-    kuvoPublic?: boolean;
-    fileSize?: number;
-    analyzePath?: string;
-    releaseDate?: string;
-    analyzeDate?: Date;
-    dateAdded?: Date;
+export type Track<withFKs extends import('onelibrary-connect').EntityFK = import('onelibrary-connect').EntityFK.WithRelations> = OneLibraryTrack<withFKs> & {
     /**
-     * Embedded beat grid information
+     * Embedded beat grid information (from ANLZ files)
      */
     beatGrid: BeatGrid | null;
     /**
-     * Embedded cue and loop information
-     */
-    cueAndLoops: CueAndLoop[] | null;
-    /**
-     * Embedded HD Waveform information
+     * Embedded HD Waveform information (from ANLZ files)
      */
     waveformHd: WaveformHD | null;
-} & (withFKs extends EntityFK.WithFKs ? TrackFks : TrackRelations);
-export {};
+};

package/lib/index.d.ts

@@ -5,6 +5,14 @@ export { default as PositionEmitter } from './status/position';
 export * from './passive';
 export { extractArtwork, extractArtworkFromDevice, isArtworkExtractionSupported, PictureType, } from './artwork';
 export type { ExtractedArtwork, FileReader as ArtworkFileReader } from './artwork';
-export type { DatabaseAdapter, DatabasePreference, DatabaseType, PlaylistQueryResult, } from './localdb/database-adapter';
-export { OneLibraryAdapter } from './localdb/onelibrary';
+export { extractFullMetadata, extractMetadataFromDevice, isMetadataExtractionSupported, } from './metadata';
+export type { ExtractedMetadata } from './metadata';
+export { loadAnlz } from './localdb/rekordbox';
+export { fetchFile } from './nfs';
+export type { AnlzResolver, AnlzResponse, AnlzResponse2EX, AnlzResponseDAT, AnlzResponseEXT } from './localdb/rekordbox';
+export type { DatabaseAdapter, DatabasePreference, DatabaseType, PlaylistQueryResult, } from 'onelibrary-connect';
+export { OneLibraryAdapter } from 'onelibrary-connect';
+export type { Category, DeviceProperty, HistorySession, HotCueBankList, MenuItem, MyTag, SortOption, } from 'onelibrary-connect';
+export { noopLogger } from './logger';
+export type { Logger } from './logger';
 export * from './types';