@grouparoo/core/src/actions/appRefreshQuery.ts

The Grouparoo Core

import { ParamsFrom } from "actionhero";
import { AuthenticatedAction } from "../classes/actions/authenticatedAction";
import { AppRefreshQuery } from "../models/AppRefreshQuery";
import { ActionPermission } from "../models/Permission";
import { Run } from "../models/Run";
import { APIData } from "../modules/apiData";
import { ConfigWriter } from "../modules/configWriter";

export class AppRefreshQueryRun extends AuthenticatedAction {
  name = "appRefreshQuery:run";
  description =
    "run an appRefreshQuery to check for new data and enqueue schedules if needed";
  outputExample = {};
  permission: ActionPermission = { topic: "app", mode: "write" };
  inputs = { id: { required: true } } as const;

  async runWithinTransaction({
    params,
  }: {
    params: ParamsFrom<AppRefreshQueryRun>;
  }) {
    let valueUpdated: Boolean = false;
    const appRefreshQuery = await AppRefreshQuery.findById(params.id);
    if (!appRefreshQuery)
      throw new Error(`No app refresh query ${params.id} found`);

    const sampleValue = await appRefreshQuery.query();
    await appRefreshQuery.update({ lastConfirmedAt: new Date() });

    let runs: Run[] = [];

    if (sampleValue !== appRefreshQuery.value) {
      await appRefreshQuery.update({
        value: sampleValue,
        lastChangedAt: new Date(),
      });

      runs = await appRefreshQuery.triggerSchedules(true);
      valueUpdated = true;
    }

    return {
      valueUpdated,
      appRefreshQuery: await appRefreshQuery.apiData(),
      runs,
    };
  }
}

export class AppRefreshQueryCreate extends AuthenticatedAction {
  name = "appRefreshQuery:create";
  description = "create an app refresh query";
  outputExample = {};
  permission: ActionPermission = { topic: "app", mode: "write" };
  inputs = {
    appId: { required: true },
    refreshQuery: { required: false },
    recurringFrequency: { required: false, formatter: APIData.ensureNumber },
    state: { required: false },
  } as const;

  async runWithinTransaction({
    params,
  }: {
    params: ParamsFrom<AppRefreshQueryCreate>;
  }) {
    const appRefreshQuery = await AppRefreshQuery.create({
      appId: params.appId,
    });
    if (params.refreshQuery)
      await appRefreshQuery.update({ refreshQuery: params.refreshQuery });
    if (params.recurringFrequency)
      await appRefreshQuery.update({
        recurringFrequency: params.recurringFrequency,
      });
    if (params.state) await appRefreshQuery.update({ state: params.state });

    await ConfigWriter.run();

    return { appRefreshQuery: await appRefreshQuery.apiData() };
  }
}

export class AppRefreshQueryEdit extends AuthenticatedAction {
  name = "appRefreshQuery:edit";
  description = "edit an app query refresh";
  outputExample = {};
  permission: ActionPermission = { topic: "app", mode: "write" };
  inputs = {
    id: { required: true },
    appId: { required: false },
    refreshQuery: { required: false },
    recurringFrequency: { required: false },
    state: { required: false },
  } as const;

  async runWithinTransaction({
    params,
  }: {
    params: ParamsFrom<AppRefreshQueryEdit>;
  }) {
    const appRefreshQuery = await AppRefreshQuery.findById(params.id);
    await appRefreshQuery.update(params);

    const sampleValue = await appRefreshQuery.query();
    await appRefreshQuery.update({ lastConfirmedAt: new Date() });

    if (sampleValue !== appRefreshQuery.value) {
      await appRefreshQuery.update({
        value: sampleValue,
        lastChangedAt: new Date(),
      });
      await appRefreshQuery.triggerSchedules(true);
    }

    await ConfigWriter.run();

    return { appRefreshQuery: await appRefreshQuery.apiData() };
  }
}

export class AppRefreshQueryTest extends AuthenticatedAction {
  name = "appRefreshQuery:test";
  description = "test the query for a given appRefreshQuery";
  permission: ActionPermission = { topic: "app", mode: "write" };
  outputExample = {};
  inputs = {
    id: { required: true },
    refreshQuery: { required: false },
  } as const;

  async runWithinTransaction({
    params,
  }: {
    params: ParamsFrom<AppRefreshQueryTest>;
  }) {
    const appRefreshQuery = await AppRefreshQuery.findById(params.id);

    const test = await appRefreshQuery.test(params.refreshQuery);
    if (test.error) test.error = String(test.error);

    return {
      test,
      appRefreshQuery: await appRefreshQuery.apiData(),
    };
  }
}

export class AppRefreshQueryView extends AuthenticatedAction {
  name = "appRefreshQuery:view";
  description = "view an app refresh query";
  outputExample = {};
  permission: ActionPermission = { topic: "app", mode: "read" };
  inputs = {
    id: { required: true },
  } as const;

  async runWithinTransaction({
    params,
  }: {
    params: ParamsFrom<AppRefreshQueryView>;
  }) {
    const appRefreshQuery = await AppRefreshQuery.findById(params.id);
    return { appRefreshQuery: await appRefreshQuery.apiData() };
  }
}

export class AppRefreshQueryDestroy extends AuthenticatedAction {
  name = "appRefreshQuery:destroy";
  description = "destroy an appRefreshQuery";
  outputExample = {};
  permission: ActionPermission = { topic: "app", mode: "write" };
  inputs = {
    id: { required: true },
  } as const;

  async runWithinTransaction({
    params,
  }: {
    params: ParamsFrom<AppRefreshQueryDestroy>;
  }) {
    const appRefreshQuery = await AppRefreshQuery.findById(params.id);
    await appRefreshQuery.destroy();

    await ConfigWriter.run();

    return { success: true };
  }
}