TweakDB test

// TweakDB test: a sample of tweakdb in the rednode package (phases T1 and T2). Type a
// record's path; the window shows its type, a few of its flats and a method's answer.
// Vehicles lists every vehicle record. Change and Clone write through TweakXL (T2);
// REDnode undoes the change when this mod stops. Reading needs nothing else installed.

import { tweakdb, ui } from 'rednode';

let path = 'Items.Preset_Lexington_Default';
const FLATS = ['quality', 'itemType', 'displayName', 'friendlyName', 'tags', 'iconPath'];

const status = ui.text('Press Read.', { tone: 'dim' });
const lines = ui.text('', { tone: 'normal' });

ui.window({
  title: 'TweakDB test',
  anchor: 'left',
  x: 40,
  y: 160,
  width: 460,
  height: 480,
  children: [
    ui.input({
      placeholder: 'A record path (Enter)',
      value: path,
      onChange: (v) => (path = v.trim()),
      onSubmit: (v) => {
        path = v.trim();
        read();
      },
    }),
    ui.row(ui.button('Read', read), ui.button('Vehicles', vehicles, { variant: 'ghost' })),
    ui.row(ui.button('Change', change, { variant: 'ghost' }), ui.button('Clone', clone, { variant: 'ghost' })),
    status,
    lines,
  ],
});

const show = (value) => (typeof value === 'string' ? value : JSON.stringify(value));

async function read() {
  if (!path) return;
  const t0 = Date.now();
  try {
    const type = await tweakdb.type(path);
    if (!type) {
      status.set({ text: `No record "${path}"`, tone: 'danger' });
      lines.set({ text: '' });
      return;
    }
    const out = [`type  ${type}`, `id  ${tweakdb.id(path)}`];
    // All at once: calls waiting when a game frame starts run in that frame.
    const flats = await Promise.all(FLATS.map((name) => tweakdb.flat(`${path}.${name}`)));
    FLATS.forEach((name, i) => {
      if (flats[i]) out.push(`${name}  ${show(flats[i].value)}  (${flats[i].type})`);
    });
    // A method of the record. Game objects answer to any name (the game decides which
    // methods exist), so pick one by the record's type: FriendlyName is an item's.
    const method = /Item_Record$/.test(type) ? 'FriendlyName' : 'DisplayName';
    const record = await tweakdb.record(path);
    try {
      out.push(`${method}()  ${show(await record[method]())}`);
    } catch (err) {
      out.push(`${method}()  ${err.message}`);
    }
    status.set({ text: `${path} in ${Date.now() - t0} ms`, tone: 'dim' });
    lines.set({ text: out.join('\n') });
    console.log(`Read ${path}: ${type}, ${out.length - 2} values in ${Date.now() - t0} ms`);
  } catch (err) {
    status.set({ text: err.message, tone: 'danger' });
    console.log(`Read failed: ${err.message}`);
  }
}

async function vehicles() {
  const t0 = Date.now();
  try {
    const ids = await tweakdb.records('Vehicle');
    const named = ids.filter((id) => !id.startsWith('0x')).length;
    status.set({ text: `${ids.length} vehicle records (${named} with known names) in ${Date.now() - t0} ms`, tone: 'dim' });
    lines.set({ text: ids.slice(0, 12).join('\n') });
    console.log(`Vehicles: ${ids.length} records in ${Date.now() - t0} ms`);
  } catch (err) {
    status.set({ text: err.message, tone: 'danger' });
    console.log(`Vehicles failed: ${err.message}`);
  }
}

// T2: an item's friendly name, changed through TweakXL. Read shows it, through the
// record's own FriendlyName() too, which proves the record was updated.
async function change() {
  try {
    const flat = `${path}.friendlyName`;
    const before = await tweakdb.get(flat);
    if (before === null) {
      status.set({ text: `${path} has no friendlyName to change (items have one)`, tone: 'danger' });
      return;
    }
    const ok = await tweakdb.set(flat, 'REDnode was here');
    console.log(`Changed ${flat} from "${before}": ${ok}`);
    await read();
    status.set({ text: `Changed: ${ok}. Switch this mod off and on, then Read: it is back.`, tone: 'dim' });
  } catch (err) {
    status.set({ text: err.message, tone: 'danger' });
    console.log(`Change failed: ${err.message}`);
  }
}

// T2: a new record copied from this one, with its own friendly name.
async function clone() {
  const copy = 'Items.REDnode_Test_Clone';
  try {
    const ok = await tweakdb.clone(copy, path);
    if (ok) await tweakdb.set(`${copy}.friendlyName`, 'REDnode clone');
    console.log(`Cloned ${path} to ${copy}: ${ok}`);
    path = copy;
    await read();
  } catch (err) {
    status.set({ text: err.message, tone: 'danger' });
    console.log(`Clone failed: ${err.message}`);
  }
}

console.log('TweakDB test ready');

{
  "id": "tweakdb-test",
  "name": "TweakDB test",
  "version": "0.2.0",
  "author": "Edgemodders",
  "description": "A sample of the TweakDB API: reads a record's flats and calls its methods, and lists every vehicle record (T1, nothing else needed); changes an item's friendly name and clones a record through TweakXL (T2), undone when the mod stops.",
  "main": "mod.mjs",
  "requires": {
    "tweakxl": ">=1.10"
  }
}