smoosic/src/ui/fileio/library.ts

<sub>[Github site](https://github.com/Smoosic/smoosic) | [source documentation](https://smoosic.github.io/Smoosic/release/docs/modules.html) | [change notes](https://aarondavidnewman.github.io/Smoosic/changes.html) | [application](https://smoosic.github.i

// [Smoosic](https://github.com/AaronDavidNewman/Smoosic)
// Copyright (c) Aaron David Newman 2021.
import { SuiXhrLoader } from './xhrLoader';
import { PromiseHelpers } from '../../common/promiseHelpers';
import { smoSerialize } from '../../common/serializationHelpers';
/**
 * @internal
 */
export interface kvPair { [key: string]: string }
/**
 * @category SuiFile
 */
export interface LibraryParams {
  loaded: boolean;
  parentLib: kvPair;
  url: string | undefined;
  format: string;
  metadata: kvPair;
  children: SmoLibrary[];
  data: any;
}

/**
 * A class to organize smoosic files (or any format smoosic accepts) into libraries.
 * @category SuiFile
 */
export class SmoLibrary {
  static _defaults: Partial<LibraryParams>;
  loaded: boolean;
  parentLib: kvPair;
  url: string | undefined = '';
  format: string = 'smo';
  metadata: kvPair = {};
  children: SmoLibrary[] = [];
  constructor(parameters: Partial<LibraryParams>) {
    this.loaded = false;
    this.parentLib = {};
    if (parameters.url) {
      this.url = parameters.url;
    } else if (parameters.data) {
      this.initialize(parameters.data);
    }
  }
  initialize(parameters: LibraryParams) {
    smoSerialize.serializedMerge(
      SmoLibrary.parameterArray, SmoLibrary.defaults, this);
    // if the object was loaded from URL, use that.
    if (!this.url) {
      this.url = parameters.url;
    }
    this.format = parameters.format;
    Object.keys(parameters.metadata).forEach((key: string) => {
      this.metadata[key] = parameters.metadata[key];
    });
    this.children = [];
    if (typeof(parameters.children) !== 'undefined') {
      parameters.children.forEach((childLib: SmoLibrary) => {
        this.children.push(new SmoLibrary({ data: childLib }));
      });
    }
    this.children.forEach((child) => {
      child._inheritMetadata(this);
    });
  }
  static get metadataNames() {
    return ['name', 'icon', 'tags', 'composer', 'artist', 'copyright',
      'title', 'subtitle', 'movement', 'source'];
  }
  static get formatTypes() {
    return ['smoosic', 'library', 'mxml', 'midi', 'abc'];
  }
  static get libraryTypes() {
    return ['work', 'transcription', 'library', 'collection'];
  }
  static get defaults() {
    if (typeof(SmoLibrary._defaults) === 'undefined') {
      SmoLibrary._defaults = { children: [], metadata: {} };
    }
    return SmoLibrary._defaults;
  }
  static get parameterArray() {
    return ['children', 'metadata', 'format', 'url'];
  }
  load() {
    const self = this;
    if (this.loaded) {
      return PromiseHelpers.emptyPromise();
    }
    const loader = new SuiXhrLoader(this.url!);
    return new Promise<void>((resolve) => {
      loader.loadAsync().then(() => {
        const jsonObj = JSON.parse(loader.value);
        self.initialize(jsonObj);
        self.loaded = true;
        resolve();
      });
    });
  }
  _inheritMetadata(parent: any) {
    // eslint-disable-next-line
    for (const key in parent) {
      if (typeof(this.metadata[key]) === 'undefined')  {
        this.metadata[key] = parent[key];
      }
    }
    this.parentLib = { name: parent.metadata.name, value: parent };
    this.children.forEach((child) => {
      child._inheritMetadata(this);
    });
  }
}