sudo-archive/src/utils/storage.ts

// TODO make type and react safe!!
/*
  it needs to be react-ified by having a save function not on the instance itself.
  also type safety is important, this is all spaghetti with "any" everywhere
*/

function buildStoreObject(d: any) {
  const data: any = {
    versions: d.versions,
    currentVersion: d.maxVersion,
    id: d.storageString,
  };

  function update(this: any, obj: any) {
    if (!obj) throw new Error("object to update is not an object");

    // repeat until object fully updated
    if (obj["--version"] === undefined) obj["--version"] = 0;
    while (obj["--version"] !== this.currentVersion) {
      // get version
      let version: any = obj["--version"] || 0;
      if (version.constructor !== Number || version < 0) version = -42;
      // invalid on purpose so it will reset
      else {
        version = ((version as number) + 1).toString();
      }

      // check if version exists
      if (!this.versions[version]) {
        console.error(
          `Version not found for storage item in store ${this.id}, resetting`
        );
        obj = null;
        break;
      }

      // update object
      obj = this.versions[version].update(obj);
    }

    // if resulting obj is null, use latest version as init object
    if (obj === null) {
      console.error(
        `Storage item for store ${this.id} has been reset due to faulty updates`
      );
      return this.versions[this.currentVersion.toString()].init();
    }

    // updates succesful, return
    return obj;
  }

  function get(this: any) {
    // get from storage api
    const store = this;
    let data: any = localStorage.getItem(this.id);

    // parse json if item exists
    if (data) {
      try {
        data = JSON.parse(data);
        if (!data.constructor) {
          console.error(
            `Storage item for store ${this.id} has not constructor`
          );
          throw new Error("storage item has no constructor");
        }
        if (data.constructor !== Object) {
          console.error(`Storage item for store ${this.id} is not an object`);
          throw new Error("storage item is not an object");
        }
      } catch (_) {
        // if errored, set to null so it generates new one, see below
        console.error(`Failed to parse storage item for store ${this.id}`);
        data = null;
      }
    }

    // if item doesnt exist, generate from version init
    if (!data) {
      data = this.versions[this.currentVersion.toString()].init();
    }

    // update the data if needed
    data = this.update(data);

    // add a save object to return value
    data.save = function save(newData: any) {
      const dataToStore = newData || data;
      localStorage.setItem(store.id, JSON.stringify(dataToStore));
    };

    // add instance helpers
    Object.entries(d.instanceHelpers).forEach(([name, helper]: any) => {
      if (data[name] !== undefined)
        throw new Error(
          `helper name: ${name} on instance of store ${this.id} is reserved`
        );
      data[name] = helper.bind(data);
    });

    // return data
    return data;
  }

  // add functions to store
  data.get = get.bind(data);
  data.update = update.bind(data);

  // add static helpers
  Object.entries(d.staticHelpers).forEach(([name, helper]: any) => {
    if (data[name] !== undefined)
      throw new Error(`helper name: ${name} on store ${data.id} is reserved`);
    data[name] = helper.bind({});
  });

  return data;
}

/*
 * Builds a versioned store
 *
 * manages versioning of localstorage items
 */
export function versionedStoreBuilder(): any {
  return {
    _data: {
      versionList: [],
      maxVersion: 0,
      versions: {},
      storageString: undefined,
      instanceHelpers: {},
      staticHelpers: {},
    },

    setKey(str: string) {
      this._data.storageString = str;
      return this;
    },

    addVersion({ version, migrate, create }: any) {
      // input checking
      if (version < 0) throw new Error("Cannot add version below 0 in store");
      if (version > 0 && !migrate)
        throw new Error(
          `Missing migration on version ${version} (needed for any version above 0)`
        );

      // update max version list
      if (version > this._data.maxVersion) this._data.maxVersion = version;
      // add to version list
      this._data.versionList.push(version);

      // register version
      this._data.versions[version.toString()] = {
        version, // version number
        update: migrate
          ? (data: any) => {
              // update function, and increment version
              migrate(data);
              data["--version"] = version;
              return data;
            }
          : undefined,
        init: create
          ? () => {
              // return an initial object
              const data = create();
              data["--version"] = version;
              return data;
            }
          : undefined,
      };
      return this;
    },

    registerHelper({ name, helper, type }: any) {
      // type
      if (!type) type = "instance";

      // input checking
      if (!name || name.constructor !== String) {
        throw new Error("helper name is not a string");
      }
      if (!helper || helper.constructor !== Function) {
        throw new Error("helper function is not a function");
      }
      if (!["instance", "static"].includes(type)) {
        throw new Error("helper type must be either 'instance' or 'static'");
      }

      // register helper
      if (type === "instance")
        this._data.instanceHelpers[name as string] = helper;
      else if (type === "static")
        this._data.staticHelpers[name as string] = helper;

      return this;
    },

    build() {
      // check if version list doesnt skip versions
      const versionListSorted = this._data.versionList.sort(
        (a: number, b: number) => a - b
      );
      versionListSorted.forEach((v: any, i: number, arr: any[]) => {
        if (i === 0) return;
        if (v !== arr[i - 1] + 1)
          throw new Error("Version list of store is not incremental");
      });

      // version zero must exist
      if (versionListSorted[0] !== 0)
        throw new Error("Version 0 doesn't exist in version list of store");

      // max version must have init function
      if (!this._data.versions[this._data.maxVersion.toString()].init)
        throw new Error(
          `Missing create function on version ${this._data.maxVersion} (needed for latest version of store)`
        );

      // check storage string
      if (!this._data.storageString)
        throw new Error("storage key not set in store");

      // build versioned store
      return buildStoreObject(this._data);
    },
  };
}