namespace CommonGrants.Models;

// ########################################
// Opportunity status options
// ########################################

/** The set of values accepted for opportunity status:
 * - `forecasted`: The opportunity is forecasted and not yet open for applications
 * - `open`: The opportunity is open for applications
 * - `closed`: The opportunity is no longer accepting applications
 * - `custom`: A custom status
 */
@Versioning.added(CommonGrants.Versions.v0_1)
enum OppStatusOptions {
  forecasted,
  open,
  closed,
  custom,
}

// ########################################
// Opportunity status model
// ########################################

/** The status of the opportunity */
@example(Examples.OppStatus.custom)
@example(Examples.OppStatus.default)
@Versioning.added(CommonGrants.Versions.v0_1)
model OppStatus {
  /** The status of the opportunity, from a predefined set of options */
  value: OppStatusOptions;

  /** A custom value for the status */
  customValue?: string;

  /** A human-readable description of the status */
  description?: string;
}

// ########################################
// Opportunity status model examples
// ########################################

/** Examples of the OppStatus model */
namespace Examples.OppStatus {
  const default = #{
    value: OppStatusOptions.open,
    description: "The opportunity is currently accepting applications",
  };

  const custom = #{
    value: OppStatusOptions.custom,
    customValue: "archived",
    description: "The opportunity is archived and shouldn't appear in search results",
  };
}