<?php
/**
 * Post and user meta keys owned by the plugin.
 *
 * @package Kordiam
 */

declare( strict_types=1 );

namespace Kordiam\Support;

// Exit if accessed directly.
if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

/**
 * Every meta key the plugin reads or writes, plus its Desk-Net ancestor.
 */
final class MetaKeys {

	/**
	 * Kordiam story ID linked to a post.
	 *
	 * @var string
	 */
	public const STORY_ID = 'kordiam_story_id';

	/**
	 * Story description shown in the editor panel.
	 *
	 * @var string
	 */
	public const STORY_DESCRIPTION = 'kordiam_story_description';

	/**
	 * Human-readable Kordiam status name.
	 *
	 * @var string
	 */
	public const STATUS_NAME = 'kordiam_status_name';

	/**
	 * Numeric Kordiam status ID, used to detect status changes.
	 *
	 * @var string
	 */
	public const STATUS_ID = 'kordiam_status_id';

	/**
	 * Kordiam publication ID a post was imported from.
	 *
	 * @var string
	 */
	public const PUBLICATION_ID = 'kordiam_publication_id';

	/**
	 * Kordiam category ID a post was imported with.
	 *
	 * @var string
	 */
	public const CATEGORY_ID = 'kordiam_category_id';

	/**
	 * ID of the editor notice currently shown for a post.
	 *
	 * @var string
	 */
	public const NOTICE_MESSAGE_ID = 'kordiam_notice_message_id';

	/**
	 * Set to REMOVED_FLAG once the story is gone on the Kordiam side.
	 *
	 * @var string
	 */
	public const REMOVE_STATUS = 'kordiam_remove_status';

	/**
	 * Blocks the importer from overwriting post content on the next sync.
	 *
	 * @var string
	 */
	public const LOCK_POST_CONTENT = 'kordiam_lock_post_content';

	/**
	 * Marks a save as plugin-initiated, so the export listener stays out of it.
	 *
	 * Without it, an import's nested save would export a second, orphaned story.
	 *
	 * @var string
	 */
	public const INTERNAL_SAVE = 'kordiam_internal_save';

	/**
	 * Kordiam task ID an attachment came from.
	 *
	 * @var string
	 */
	public const TASK_FILE_ID = 'kordiam_task_file_id';

	/**
	 * Post status at the last successful export, so unchanged saves are not re-sent.
	 *
	 * @var string
	 */
	public const PREVIOUS_STATUS = 'kordiam_previous_status';

	/**
	 * Marks a post whose date an editor changed by hand.
	 *
	 * @var string
	 */
	public const USER_CHANGED_DATE = 'kordiam_user_changed_date';

	/**
	 * Kordiam assignee ID stored against a WordPress user.
	 *
	 * @var string
	 */
	public const AUTHOR_ID = 'kordiam_author_id';

	/**
	 * Records (per user) that an administrator closed the "Desk-Net is still active" warning.
	 *
	 * @var string
	 */
	public const LEGACY_NOTICE_DISMISSED = 'kordiam_legacy_notice_dismissed';

	/**
	 * Free text explaining a notice, when Kordiam or WordPress gave a reason.
	 *
	 * @var string
	 */
	public const NOTICE_DETAIL = 'kordiam_notice_detail';

	/**
	 * Value written to REMOVE_STATUS when a story is deleted in Kordiam.
	 *
	 * @var string
	 */
	public const REMOVED_FLAG = 'removed';

	/**
	 * Post meta exposed to the block editor over the REST API.
	 *
	 * @var string[]
	 */
	private const REST_EXPOSED = array(
		self::STORY_ID,
		self::STORY_DESCRIPTION,
		self::STATUS_NAME,
		self::NOTICE_MESSAGE_ID,
		self::NOTICE_DETAIL,
		self::REMOVE_STATUS,
	);

	/**
	 * Every post meta key the plugin writes (removed on uninstall).
	 *
	 * Not derived from the legacy map: new keys may have no Desk-Net ancestor.
	 *
	 * @var string[]
	 */
	private const POST_META = array(
		self::STORY_ID,
		self::STORY_DESCRIPTION,
		self::STATUS_NAME,
		self::STATUS_ID,
		self::PUBLICATION_ID,
		self::CATEGORY_ID,
		self::NOTICE_MESSAGE_ID,
		self::NOTICE_DETAIL,
		self::REMOVE_STATUS,
		self::LOCK_POST_CONTENT,
		self::INTERNAL_SAVE,
		self::TASK_FILE_ID,
		self::PREVIOUS_STATUS,
		self::USER_CHANGED_DATE,
	);

	/**
	 * Every user meta key the plugin writes.
	 *
	 * @var string[]
	 */
	private const USER_META = array(
		self::AUTHOR_ID,
		self::LEGACY_NOTICE_DISMISSED,
	);

	/**
	 * Desk-Net ancestor of every key, for the activation-time importer.
	 *
	 * @var array<string, string>
	 */
	private const LEGACY_POST_META = array(
		self::STORY_ID          => 'story_id',
		self::STORY_DESCRIPTION => 'desk_net_description',
		self::STATUS_NAME       => 'desk_net_status_name',
		self::STATUS_ID         => 'desk_net_status_id',
		self::PUBLICATION_ID    => 'publications_id',
		self::CATEGORY_ID       => 'desk_net_category_id',
		self::NOTICE_MESSAGE_ID => 'desk_net_notice_message_id',
		self::REMOVE_STATUS     => 'wp_desk_net_remove_status',
		self::LOCK_POST_CONTENT => 'wp_desk_net_lock_update_post_content',
		self::INTERNAL_SAVE     => 'desk_net_updated_by_wp_update_post',
		self::TASK_FILE_ID      => 'wp_desk_net_file_id',
		self::PREVIOUS_STATUS   => 'wp_desk_net_post_previous_status',
		self::USER_CHANGED_DATE => 'wp_desk_net_change_post_date',
	);

	/**
	 * Desk-Net ancestor of every user meta key.
	 *
	 * @var array<string, string>
	 */
	private const LEGACY_USER_META = array(
		self::AUTHOR_ID => 'desk_net_author_id',
	);

	/**
	 * Blocking instantiation: this class is a constant bag.
	 */
	private function __construct() {
	}

	/**
	 * Listing the post meta keys registered for the block editor.
	 *
	 * @return string[] Meta keys.
	 */
	public static function rest_exposed(): array {
		return self::REST_EXPOSED;
	}

	/**
	 * Listing every post meta key the plugin writes.
	 *
	 * @return string[] Meta keys.
	 */
	public static function post_meta_keys(): array {
		return self::POST_META;
	}

	/**
	 * Listing every user meta key the plugin writes.
	 *
	 * @return string[] Meta keys.
	 */
	public static function user_meta_keys(): array {
		return self::USER_META;
	}

	/**
	 * Listing the post meta rename pairs.
	 *
	 * @return array<string, string> Kordiam key => Desk-Net key.
	 */
	public static function legacy_post_meta(): array {
		return self::LEGACY_POST_META;
	}

	/**
	 * Listing the user meta rename pairs.
	 *
	 * @return array<string, string> Kordiam key => Desk-Net key.
	 */
	public static function legacy_user_meta(): array {
		return self::LEGACY_USER_META;
	}
}