feat: integrate ReadMe input format in configuration

Author: bombillazo

packages/openapi-ts/src/config/input.ts

@@ -1,4 +1,5 @@
 import type { Config, UserConfig } from '../types/config';
+import { isReadmeInput, transformReadmeInput } from '../utils/readme';
 
 const defaultWatch: Config['input']['watch'] = {
   enabled: false,
@@ -38,7 +39,12 @@ export const getInput = (userConfig: UserConfig): Config['input'] => {
   };
 
   if (typeof userConfig.input === 'string') {
-    input.path = userConfig.input;
+    // Handle ReadMe input format transformation
+    if (isReadmeInput(userConfig.input)) {
+      input.path = transformReadmeInput(userConfig.input);
+    } else {
+      input.path = userConfig.input;
+    }
   } else if (
     userConfig.input &&
     (userConfig.input.path !== undefined ||
@@ -51,6 +57,11 @@ export const getInput = (userConfig: UserConfig): Config['input'] => {
       ...userConfig.input,
     };
 
+    // Handle ReadMe input format transformation when path is specified
+    if (typeof input.path === 'string' && isReadmeInput(input.path)) {
+      input.path = transformReadmeInput(input.path);
+    }
+
     // watch only remote files
     if (input.watch !== undefined) {
       input.watch = getWatch(input);

packages/openapi-ts/src/types/config.d.ts

@@ -18,14 +18,20 @@ export interface UserConfig {
    */
   dryRun?: boolean;
   /**
-   * Path to the OpenAPI specification. This can be either local or remote path.
+   * Path to the OpenAPI specification. This can be either:
+   *   - local file
+   *.  - remote path
+   *   - ReadMe API Registry UUID (full and simplified formats)
+   *
    * Both JSON and YAML file formats are supported. You can also pass the parsed
    * object directly if you're fetching the file yourself.
    *
    * Alternatively, you can define a configuration object with more options.
    */
   input:
-    | 'https://get.heyapi.dev/<organization>/<project>'
+    | `https://get.heyapi.dev/${string}/${string}`
+    | `readme:@${string}/${string}#${string}`
+    | `readme:${string}`
     | (string & {})
     | (Record<string, unknown> & { path?: never })
     | Input;

packages/openapi-ts/src/types/input.d.ts

@@ -36,12 +36,18 @@ export type Input = {
    */
   organization?: string;
   /**
-   * Path to the OpenAPI specification. This can be either local or remote path.
+   * Path to the OpenAPI specification. This can be either:
+   *   - local file
+   *.  - remote path
+   *   - ReadMe API Registry UUID (full and simplified formats)
+   *
    * Both JSON and YAML file formats are supported. You can also pass the parsed
    * object directly if you're fetching the file yourself.
    */
   path?:
-    | 'https://get.heyapi.dev/<organization>/<project>'
+    | `https://get.heyapi.dev/${string}/${string}`
+    | `readme:@${string}/${string}#${string}`
+    | `readme:${string}`
     | (string & {})
     | Record<string, unknown>;
   /**