import { Enum, EnumValue } from "@kejistan/enum";

/**
 * The type of tenant. This is a fixed attribute of a tenant.
 */
export const TenantType = Enum({
  /**
   * The corporate tenant.
   * There is only one tenant of this type.
   * Users in this tenant have CORP_ roles.
   * This tenant type only supports TenantEnv.LIVE.
   */
  CORP: "CORP",

  /**
   * A client tenant.
   * There are many tenants of this type.
   * Users in these tenants have CLIENT_ roles.
   * Users in these tenants should have real emails and secure passwords.
   * This tenant type supports all TenantEnvs.
   */
  CLIENT: "CLIENT",

  /**
   * A demo tenant.
   * There are many tenants of this type.
   * Users in these tenants have CLIENT_ roles.
   * Users in these tenants may have fake emails and simple passwords.
   * This tenant type only supports TenantEnv.FAKE.
   */
  DEMO: "DEMO",

  /**
   * A tenant created for internal use cases.
   * There are many tenants of this type.
   * There are no users in these tenants.
   * Only corp users may interact with these tenants, and they
   * do so by scoping.
   * This tenant type supports all TenantEnvs.
   */
  INTERNAL: "INTERNAL",

  /**
   * The system tenant.
   * There is only one tenant of this type.
   * Users in this tenant have SYSTEM_ roles (ie bots).
   * This tenant is not used in the tenant_qid column on any table other
   * than user, so TenantEnv is not supported for it.
   */
  SYSTEM: "SYSTEM",
});

export type TenantType = EnumValue<typeof TenantType>;