bitburner-src/src/CodingContract/Contract.ts

import { FactionName, CodingContractName } from "@enums";
import { CodingContractTypes } from "./ContractTypes";

import { Generic_fromJSON, Generic_toJSON, IReviverValue, constructorsForReviver } from "../utils/JSONReviver";
import { ContractFilePath, resolveContractFilePath } from "../Paths/ContractFilePath";
import { assertObject } from "../utils/TypeAssertion";
import type { Result } from "@nsdefs";
import { CodingContractEventEmitter } from "./CodingContractEventEmitter";

// Numeric enum
/** Enum representing the different types of rewards a Coding Contract can give */
export enum CodingContractRewardType {
  FactionReputation,
  FactionReputationAll,
  CompanyReputation,
  Money, // This must always be the last reward type
}

// Numeric enum
/** Enum representing the result when trying to solve the Contract */
export enum CodingContractResult {
  Success,
  Failure,
  Cancelled,
  InvalidFormat,
}

/** A class that represents the type of reward a contract gives */
export type ICodingContractReward =
  | {
      type: CodingContractRewardType.Money;
    }
  | {
      type: CodingContractRewardType.FactionReputationAll;
    }
  | {
      type: CodingContractRewardType.CompanyReputation;
      name: string;
    }
  | {
      type: CodingContractRewardType.FactionReputation;
      name: FactionName;
    };

/**
 * A Coding Contract is a file that poses a programming-related problem to the Player.
 * The player receives a reward if the problem is solved correctly
 */
export class CodingContract {
  /* Relevant state for the contract's problem */
  state: unknown;

  /* Contract's filename */
  fn: ContractFilePath;

  /* Describes the reward given if this Contract is solved. The reward is actually
       processed outside of this file */
  reward: ICodingContractReward | null;

  /* Number of times the Contract has been attempted */
  tries = 0;

  /* String representing the contract's type. Must match type in ContractTypes */
  type: CodingContractName;

  constructor(
    fn = "default.cct",
    type = CodingContractName.FindLargestPrimeFactor,
    reward: ICodingContractReward | null = null,
  ) {
    const path = resolveContractFilePath(fn);
    if (!path) {
      throw new Error(`Bad file path while creating a coding contract: ${fn}`);
    }
    if (!CodingContractTypes[type]) {
      throw new Error(`Error: invalid contract type: ${type} please contact developer`);
    }

    this.fn = path;
    this.type = type;
    this.state = CodingContractTypes[type].generate();
    this.reward = reward;
  }

  getAnswer() {
    return CodingContractTypes[this.type].getAnswer(this.state);
  }

  getData(): unknown {
    const func = CodingContractTypes[this.type].getData;
    return func ? func(this.state) : this.state;
  }

  getDescription(): string {
    return CodingContractTypes[this.type].desc(this.getData());
  }

  getDifficulty(): number {
    return CodingContractTypes[this.type].difficulty;
  }

  getMaxNumTries(): number {
    return CodingContractTypes[this.type].numTries ?? 10;
  }

  getType(): CodingContractName {
    return this.type;
  }

  /** Checks if the answer is in the correct format. */
  isValid(answer: unknown): Result<{ answer: unknown }> {
    if (typeof answer === "string") {
      try {
        answer = CodingContractTypes[this.type].convertAnswer(answer);
      } catch (error) {
        return {
          success: false,
          message: `The answer is not in the right format for contract '${this.type}'. Reason: ${
            error instanceof Error ? error.message : String(error)
          }`,
        };
      }
    }
    const result = CodingContractTypes[this.type].validateAnswer(answer);
    if (!result) {
      return {
        success: false,
        message: `The answer is not in the right format for contract '${this.type}'. Got: ${answer}`,
      };
    }
    return { success: true, answer };
  }

  isSolution(solution: unknown): {
    result: Exclude<CodingContractResult, CodingContractResult.Cancelled>;
    message?: string;
  } {
    const validationResult = this.isValid(solution);
    if (!validationResult.success) {
      return { result: CodingContractResult.InvalidFormat, message: validationResult.message };
    }
    /**
     * We sometimes need to convert the given solution by calling CodingContractType.convertAnswer() (e.g., Square Root
     * contract) before using it. The conversion is done in CodingContract.isValid().
     */
    solution = validationResult.answer;
    return {
      result: CodingContractTypes[this.type].solver(this.state, solution)
        ? CodingContractResult.Success
        : CodingContractResult.Failure,
    };
  }

  /** Creates a popup to prompt the player to solve the problem */
  async prompt(): Promise<{ result: CodingContractResult; message?: string }> {
    return new Promise((resolve) => {
      CodingContractEventEmitter.emit({
        type: "run",
        data: {
          codingContract: this,
          onClose: () => {
            resolve({ result: CodingContractResult.Cancelled });
          },
          onAttempt: (val: string) => {
            resolve(this.isSolution(val));
          },
        },
      });
    });
  }

  /** Serialize the current file to a JSON save state. */
  toJSON(): IReviverValue {
    return Generic_toJSON("CodingContract", this);
  }

  /** Initializes a CodingContract from a JSON save state. */
  static fromJSON(value: IReviverValue): CodingContract {
    assertObject(value.data);
    // In previous versions, there was a data field instead of a state field.
    if ("data" in value.data) {
      value.data.state = value.data.data;
      delete value.data.data;
    }
    return Generic_fromJSON(CodingContract, value.data);
  }
}

constructorsForReviver.CodingContract = CodingContract;