Merge pull request #23 from WordPress/prepare/0.1.0-release

Prepare initial release by bumping version to 0.1.0

Author: felixarntz

includes/AI_Client.php

@@ -2,8 +2,8 @@
 /**
  * Class WordPress\AI_Client\AI_Client
  *
- * @since n.e.x.t
- * @package wp-ai-client
+ * @since 0.1.0
+ * @package WordPress\AI_Client
  */
 
 namespace WordPress\AI_Client;
@@ -17,7 +17,7 @@
 /**
  * Main AI Client class providing fluent APIs for AI operations.
  *
- * @since n.e.x.t
+ * @since 0.1.0
  *
  * @phpstan-import-type Prompt from Prompt_Builder
  */
@@ -26,7 +26,7 @@ class AI_Client {
 	/**
 	 * Indicates whether the AI Client package has been initialized.
 	 *
-	 * @since n.e.x.t
+	 * @since 0.1.0
 	 * @var bool
 	 */
 	private static bool $initialized = false;
@@ -36,7 +36,7 @@ class AI_Client {
 	 *
 	 * This method needs to be called by the consumer of this package, on the WordPress 'init' action hook.
 	 *
-	 * @since n.e.x.t
+	 * @since 0.1.0
 	 */
 	public static function init(): void {
 		if ( self::$initialized ) {
@@ -56,7 +56,7 @@ public static function init(): void {
 	/**
 	 * Creates a new prompt builder for fluent API usage.
 	 *
-	 * @since n.e.x.t
+	 * @since 0.1.0
 	 *
 	 * @param Prompt $prompt Optional initial prompt content.
 	 * @return Prompt_Builder The prompt builder instance.
@@ -66,7 +66,7 @@ public static function prompt( $prompt = null ): Prompt_Builder {
 			_doing_it_wrong(
 				__METHOD__,
 				esc_html__( 'You must call AI_Client::init() on the WordPress "init" action hook before using the AI Client.', 'wp-ai-client' ),
-				'n.e.x.t'
+				'0.1.0'
 			);
 		}
 		return new Prompt_Builder( AiClient::defaultRegistry(), $prompt );
@@ -75,7 +75,7 @@ public static function prompt( $prompt = null ): Prompt_Builder {
 	/**
 	 * Creates a new prompt builder for fluent API usage, returning WP_Error on errors.
 	 *
-	 * @since n.e.x.t
+	 * @since 0.1.0
 	 *
 	 * @param Prompt $prompt Optional initial prompt content.
 	 * @return Prompt_Builder_With_WP_Error The prompt builder instance.
@@ -85,7 +85,7 @@ public static function prompt_with_wp_error( $prompt = null ): Prompt_Builder_Wi
 			_doing_it_wrong(
 				__METHOD__,
 				esc_html__( 'You must call AI_Client::init() on the WordPress "init" action hook before using the AI Client.', 'wp-ai-client' ),
-				'n.e.x.t'
+				'0.1.0'
 			);
 		}
 		return new Prompt_Builder_With_WP_Error( AiClient::defaultRegistry(), $prompt );

includes/API_Credentials/API_Credentials_Manager.php

@@ -2,8 +2,8 @@
 /**
  * Class WordPress\AI_Client\API_Credentials\API_Credentials_Manager
  *
- * @since n.e.x.t
- * @package wp-ai-client
+ * @since 0.1.0
+ * @package WordPress\AI_Client
  */
 
 namespace WordPress\AI_Client\API_Credentials;
@@ -16,7 +16,7 @@
 /**
  * Class for managing the AI API credentials for the various providers.
  *
- * @since n.e.x.t
+ * @since 0.1.0
  *
  * Note about PHPStan: Technically, we want `ProviderExtendedMetadataArrayShape` to be the intersection of
  * `ProviderMetadataArrayShape` and the additional `ai_client_classnames` field. However, PHPStan does not seem to
@@ -45,7 +45,7 @@ class API_Credentials_Manager {
 	 *
 	 * This method needs to be called by the consumer of this package, on the WordPress 'init' action hook.
 	 *
-	 * @since n.e.x.t
+	 * @since 0.1.0
 	 */
 	public function initialize(): void {
 		$this->collect_providers();
@@ -75,7 +75,7 @@ function () {
 	 * provider ID, and for each provider metadata it also stores a map of the AiClient class names where the provider
 	 * is registered in.
 	 *
-	 * @since n.e.x.t
+	 * @since 0.1.0
 	 *
 	 * @throws RuntimeException If the collected provider metadata is in an invalid format.
 	 */
@@ -128,7 +128,7 @@ private function collect_providers(): void {
 	 *
 	 * See {@see API_Credentials_Manager::collect_providers()} for details on how this works and why it uses a global.
 	 *
-	 * @since n.e.x.t
+	 * @since 0.1.0
 	 * @see API_Credentials_Manager::collect_providers()
 	 *
 	 * @return array<string, ProviderMetadata> Array of provider metadata objects, keyed by provider ID.
@@ -157,7 +157,7 @@ static function ( array $provider_metadata ) {
 	/**
 	 * Returns the metadata for all registered cloud providers across all instances of the PHP AI Client SDK.
 	 *
-	 * @since n.e.x.t
+	 * @since 0.1.0
 	 *
 	 * @return array<string, ProviderMetadata> Array of cloud provider metadata objects, keyed by provider ID.
 	 */
@@ -177,7 +177,7 @@ static function ( ProviderMetadata $metadata ) {
 	 *
 	 * The setting will only be registered once, even if the class is used multiple times.
 	 *
-	 * @since n.e.x.t
+	 * @since 0.1.0
 	 */
 	private function register_settings(): void {
 		// Avoid registering the setting multiple times.
@@ -219,7 +219,7 @@ private function register_settings(): void {
 	 *
 	 * This method should be called on every request, before any API requests are made via the PHP AI Client SDK.
 	 *
-	 * @since n.e.x.t
+	 * @since 0.1.0
 	 *
 	 * @throws RuntimeException If the stored credentials option is in an invalid format.
 	 */
@@ -253,7 +253,7 @@ private function pass_credentials_to_client(): void {
 	 *
 	 * The screen will only be added once, even if the class is used multiple times.
 	 *
-	 * @since n.e.x.t
+	 * @since 0.1.0
 	 */
 	private function add_admin_screen(): void {
 		global $_wp_submenu_nopriv, $_parent_pages;

includes/API_Credentials/API_Credentials_Settings_Screen.php

@@ -2,8 +2,8 @@
 /**
  * Class WordPress\AI_Client\API_Credentials\API_Credentials_Settings_Screen
  *
- * @since n.e.x.t
- * @package wp-ai-client
+ * @since 0.1.0
+ * @package WordPress\AI_Client
  */
 
 namespace WordPress\AI_Client\API_Credentials;
@@ -13,62 +13,62 @@
 /**
  * Class for a settings screen which displays AI provider API credentials fields.
  *
- * @since n.e.x.t
+ * @since 0.1.0
  */
 class API_Credentials_Settings_Screen {
 
 	/**
 	 * The screen slug.
 	 *
-	 * @since n.e.x.t
+	 * @since 0.1.0
 	 * @var string
 	 */
 	private string $screen_slug;
 
 	/**
 	 * The screen title.
 	 *
-	 * @since n.e.x.t
+	 * @since 0.1.0
 	 * @var string
 	 */
 	private string $screen_title;
 
 	/**
 	 * The screen description.
 	 *
-	 * @since n.e.x.t
+	 * @since 0.1.0
 	 * @var string
 	 */
 	private string $screen_description;
 
 	/**
 	 * The option group for the settings.
 	 *
-	 * @since n.e.x.t
+	 * @since 0.1.0
 	 * @var string
 	 */
 	private string $option_group;
 
 	/**
 	 * The option name for storing the provider credentials.
 	 *
-	 * @since n.e.x.t
+	 * @since 0.1.0
 	 * @var string
 	 */
 	private string $option_name;
 
 	/**
 	 * The providers metadata collected from the PHP AI Client SDK.
 	 *
-	 * @since n.e.x.t
+	 * @since 0.1.0
 	 * @var array<string, ProviderMetadata> An array of provider metadata, keyed by provider ID.
 	 */
 	private array $providers_metadata = array();
 
 	/**
 	 * Constructor.
 	 *
-	 * @since n.e.x.t
+	 * @since 0.1.0
 	 *
 	 * @param string                          $screen_slug        The screen slug.
 	 * @param string                          $screen_title       The screen title.
@@ -92,7 +92,7 @@ public function __construct( string $screen_slug, string $screen_title, string $
 	 * This method adds a settings section for provider API credentials, including a field for each provider that
 	 * requires API key authentication.
 	 *
-	 * @since n.e.x.t
+	 * @since 0.1.0
 	 */
 	public function initialize_screen(): void {
 		$settings_section = 'wp-ai-client-provider-credentials';
@@ -164,7 +164,7 @@ function () {
 	/**
 	 * Renders the provider settings screen.
 	 *
-	 * @since n.e.x.t
+	 * @since 0.1.0
 	 */
 	public function render_screen(): void {
 		?>
@@ -185,7 +185,7 @@ public function render_screen(): void {
 	/**
 	 * Renders a settings field based on the given arguments.
 	 *
-	 * @since n.e.x.t
+	 * @since 0.1.0
 	 *
 	 * @param array<string, string> $args Field arguments set up during `add_settings_field()`.
 	 */
@@ -246,7 +246,7 @@ class="description"
 	/**
 	 * Returns the allowed HTML tags and attributes for descriptions using wp_kses().
 	 *
-	 * @since n.e.x.t
+	 * @since 0.1.0
 	 *
 	 * @return array<string, array<string, mixed>> Allowed HTML tags and their attributes.
 	 */

includes/Builders/Prompt_Builder.php

@@ -2,8 +2,8 @@
 /**
  * Class WordPress\AI_Client\Builders\Prompt_Builder
  *
- * @since n.e.x.t
- * @package wp-ai-client
+ * @since 0.1.0
+ * @package WordPress\AI_Client
  */
 
 namespace WordPress\AI_Client\Builders;
@@ -35,7 +35,7 @@
  * It adds the necessary WordPress flavoring around it, e.g. follow WordPress Coding Standards, as well as
  * integrate with WordPress specific AI primitives such as the Abilities API.
  *
- * @since n.e.x.t
+ * @since 0.1.0
  *
  * @method self with_text(string $text) Adds text to the current message.
  * @method self with_file($file, ?string $mimeType = null) Adds a file to the current message.
@@ -94,15 +94,15 @@ class Prompt_Builder {
 	/**
 	 * Wrapped prompt builder instance.
 	 *
-	 * @since n.e.x.t
+	 * @since 0.1.0
 	 * @var PromptBuilder
 	 */
 	private PromptBuilder $builder;
 
 	/**
 	 * Constructor.
 	 *
-	 * @since n.e.x.t
+	 * @since 0.1.0
 	 *
 	 * @param ProviderRegistry $registry The provider registry for finding suitable models.
 	 * @param Prompt           $prompt   Optional initial prompt content.
@@ -116,7 +116,7 @@ public function __construct( ProviderRegistry $registry, $prompt = null ) {
 	 *
 	 * This allows WordPress developers to use snake_case naming conventions.
 	 *
-	 * @since n.e.x.t
+	 * @since 0.1.0
 	 *
 	 * @param string            $name      The method name in snake_case.
 	 * @param array<int, mixed> $arguments The method arguments.
@@ -137,7 +137,7 @@ public function __call( string $name, array $arguments ) {
 	/**
 	 * Retrieves a callable for a given PHP AI Client SDK prompt builder method name.
 	 *
-	 * @since n.e.x.t
+	 * @since 0.1.0
 	 *
 	 * @param string $name The method name in snake_case.
 	 * @return callable The callable for the specified method.
@@ -164,7 +164,7 @@ protected function get_builder_callable( string $name ): callable {
 	/**
 	 * Converts snake_case to camelCase.
 	 *
-	 * @since n.e.x.t
+	 * @since 0.1.0
 	 *
 	 * @param string $snake_case The snake_case string.
 	 * @return string The camelCase string.

includes/Builders/Prompt_Builder_With_WP_Error.php

@@ -2,8 +2,8 @@
 /**
  * Class WordPress\AI_Client\Builders\Prompt_Builder_With_WP_Error
  *
- * @since n.e.x.t
- * @package wp-ai-client
+ * @since 0.1.0
+ * @package WordPress\AI_Client
  */
 
 namespace WordPress\AI_Client\Builders;
@@ -33,7 +33,7 @@
  * will be no-ops that just return the same error state instance. Only when a terminate method is called, the WP_Error
  * will be returned.
  *
- * @since n.e.x.t
+ * @since 0.1.0
  *
  * @method self with_text(string $text) Adds text to the current message.
  * @method self with_file($file, ?string $mimeType = null) Adds a file to the current message.
@@ -87,7 +87,7 @@ class Prompt_Builder_With_WP_Error extends Prompt_Builder {
 	/**
 	 * WordPress error instance, if any error occurred during method calls.
 	 *
-	 * @since n.e.x.t
+	 * @since 0.1.0
 	 * @var WP_Error|null
 	 */
 	private ?WP_Error $error = null;
@@ -97,7 +97,7 @@ class Prompt_Builder_With_WP_Error extends Prompt_Builder {
 	 *
 	 * Technically a map, simply for faster lookups.
 	 *
-	 * @since n.e.x.t
+	 * @since 0.1.0
 	 * @var array<string, bool>
 	 */
 	private static array $terminate_methods = array(
@@ -122,7 +122,7 @@ class Prompt_Builder_With_WP_Error extends Prompt_Builder {
 	 * This allows WordPress developers to use snake_case naming conventions. It also catches any exceptions thrown,
 	 * stores them, and returns a WP_Error when a terminate method is called.
 	 *
-	 * @since n.e.x.t
+	 * @since 0.1.0
 	 *
 	 * @param string            $name      The method name in snake_case.
 	 * @param array<int, mixed> $arguments The method arguments.
@@ -171,7 +171,7 @@ public function __call( string $name, array $arguments ) {
 	/**
 	 * Checks if a method is a terminating method.
 	 *
-	 * @since n.e.x.t
+	 * @since 0.1.0
 	 *
 	 * @param string $name The method name.
 	 * @return bool True if the method is a terminating method, false otherwise.