@bfra.me/api-core 0.1.0

package/test-utils/sdks/response-title-quirks/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@api/response-title-quirks",
+  "version": "1.0.0",
+  "type": "module",
+  "main": "dist/index.cjs",
+  "types": "dist/index.d.cts",
+  "module": "dist/index.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./sdk": {
+      "import": "./dist/sdk.js",
+      "require": "./dist/sdk.cjs"
+    },
+    "./types": {
+      "import": "./dist/types.js",
+      "require": "./dist/types.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "openapi.json"
+  ],
+  "scripts": {
+    "lint": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@readme/api-core": "file:../../../../../core"
+  },
+  "devDependencies": {
+    "tsup": "^7.2.0",
+    "typescript": "^5.2.2"
+  },
+  "tsup": {
+    "cjsInterop": true,
+    "clean": true,
+    "dts": true,
+    "entry": [
+      "./src/index.ts",
+      "./src/sdk.ts",
+      "./src/types.ts"
+    ],
+    "format": [
+      "esm",
+      "cjs"
+    ],
+    "minify": false,
+    "shims": true,
+    "sourcemap": true,
+    "splitting": true
+  }
+}

package/test-utils/sdks/response-title-quirks/src/index.ts

@@ -0,0 +1,9 @@
+import SDK from './sdk.js';
+
+/**
+ * Testing an OAS that has response `title` props that start with a number
+ *
+ */
+const createSDK = (() => { return new SDK(); })();
+
+export default createSDK;

package/test-utils/sdks/response-title-quirks/src/schemas/GetAnything.ts

@@ -0,0 +1,60 @@
+const GetAnything = {
+  "metadata": {
+    "allOf": [
+      {
+        "type": "object",
+        "properties": {
+          "status": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "enum": [
+                "available",
+                "pending",
+                "sold"
+              ],
+              "default": "available"
+            },
+            "$schema": "https://json-schema.org/draft/2020-12/schema#",
+            "description": "Status values that need to be considered for filter"
+          }
+        },
+        "required": [
+          "status"
+        ]
+      }
+    ]
+  },
+  "response": {
+    "2XX": {
+      "oneOf": [
+        {
+          "title": "260 Created (token)",
+          "type": "object",
+          "properties": {
+            "id": {
+              "type": "string",
+              "examples": [
+                "e450ec69-dac2-4858-b4c9-6d3af44bb5f8"
+              ]
+            }
+          }
+        },
+        {
+          "title": "260 Created",
+          "type": "object",
+          "properties": {
+            "id": {
+              "type": "string",
+              "examples": [
+                "e450ec69-dac2-4858-b4c9-6d3af44bb5f8"
+              ]
+            }
+          }
+        }
+      ],
+      "$schema": "https://json-schema.org/draft/2020-12/schema#"
+    }
+  }
+} as const;
+export default GetAnything

package/test-utils/sdks/response-title-quirks/src/schemas.ts

@@ -0,0 +1,2 @@
+import GetAnything from './schemas/GetAnything.js';
+export { GetAnything }

package/test-utils/sdks/response-title-quirks/src/sdk.ts

@@ -0,0 +1,76 @@
+import type * as types from './types.js';
+import type { ConfigOptions, FetchResponse, HTTPMethodRange } from '@readme/api-core/types';
+import APICore from '@readme/api-core';
+import definition from '@api/test-utils/definitions/response-title-quirks.json';
+
+export default class SDK {
+  core: APICore;
+
+  constructor() {
+    this.core = new APICore(definition, 'response-title-quirks/1.0.0 (api/7.0.0-mock)');
+  }
+
+  /**
+   * Optionally configure various options that the SDK allows.
+   *
+   * @param config Object of supported SDK options and toggles.
+   * @param config.timeout Override the default `fetch` request timeout of 30 seconds. This number
+   * should be represented in milliseconds.
+   */
+  config(config: ConfigOptions) {
+    this.core.setConfig(config);
+  }
+
+  /**
+   * If the API you're using requires authentication you can supply the required credentials
+   * through this method and the library will magically determine how they should be used
+   * within your API request.
+   *
+   * With the exception of OpenID and MutualTLS, it supports all forms of authentication
+   * supported by the OpenAPI specification.
+   *
+   * @example <caption>HTTP Basic auth</caption>
+   * sdk.auth('username', 'password');
+   *
+   * @example <caption>Bearer tokens (HTTP or OAuth 2)</caption>
+   * sdk.auth('myBearerToken');
+   *
+   * @example <caption>API Keys</caption>
+   * sdk.auth('myApiKey');
+   *
+   * @see {@link https://spec.openapis.org/oas/v3.0.3#fixed-fields-22}
+   * @see {@link https://spec.openapis.org/oas/v3.1.0#fixed-fields-22}
+   * @param values Your auth credentials for the API; can specify up to two strings or numbers.
+   */
+  auth(...values: string[] | number[]) {
+    this.core.setAuth(...values);
+    return this;
+  }
+
+  /**
+   * If the API you're using offers alternate server URLs, and server variables, you can tell
+   * the SDK which one to use with this method. To use it you can supply either one of the
+   * server URLs that are contained within the OpenAPI definition (along with any server
+   * variables), or you can pass it a fully qualified URL to use (that may or may not exist
+   * within the OpenAPI definition).
+   *
+   * @example <caption>Server URL with server variables</caption>
+   * sdk.server('https://{region}.api.example.com/{basePath}', {
+   *   name: 'eu',
+   *   basePath: 'v14',
+   * });
+   *
+   * @example <caption>Fully qualified server URL</caption>
+   * sdk.server('https://eu.api.example.com/v14');
+   *
+   * @param url Server URL
+   * @param variables An object of variables to replace into the server URL.
+   */
+  server(url: string, variables = {}) {
+    this.core.setServer(url, variables);
+  }
+
+  getAnything(metadata: types.GetAnythingMetadataParam): Promise<FetchResponse<HTTPMethodRange<200, 299>, types.GetAnythingResponse2XX>> {
+    return this.core.fetch('/anything', 'get', metadata);
+  }
+}

package/test-utils/sdks/response-title-quirks/src/types.ts

@@ -0,0 +1,5 @@
+import type { FromSchema } from '@readme/api-core/types';
+import type * as schemas from './schemas.js';
+
+export type GetAnythingMetadataParam = FromSchema<typeof schemas.GetAnything.metadata>;
+export type GetAnythingResponse2XX = FromSchema<typeof schemas.GetAnything.response['2XX']>;

package/test-utils/sdks/response-title-quirks/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "esModuleInterop": true,
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "resolveJsonModule": true,
+    "strict": true
+  },
+  "include": [
+    "./src/**/*"
+  ]
+}

package/test-utils/sdks/simple/README.md

@@ -0,0 +1,14 @@
+# `@api/simple`
+
+This SDK was autogenerated by the [`api` SDK generator](https://api.readme.dev), powered by [ReadMe](https://readme.com) 🦉
+
+Add SDK setup information and usage examples here so your users get started in a jiffy! 🚀
+
+<!---
+
+Here's some additional info about the generated SDK:
+
+`api` version: 7.0.0-mock
+Generated at 2023-10-25T00:00:00.000Z
+
+--->

package/test-utils/sdks/simple/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@api/simple",
+  "version": "1.0.0",
+  "type": "module",
+  "main": "dist/index.cjs",
+  "types": "dist/index.d.cts",
+  "module": "dist/index.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./sdk": {
+      "import": "./dist/sdk.js",
+      "require": "./dist/sdk.cjs"
+    },
+    "./types": {
+      "import": "./dist/types.js",
+      "require": "./dist/types.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "openapi.json"
+  ],
+  "scripts": {
+    "lint": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@readme/api-core": "file:../../../../../core"
+  },
+  "devDependencies": {
+    "tsup": "^7.2.0",
+    "typescript": "^5.2.2"
+  },
+  "tsup": {
+    "cjsInterop": true,
+    "clean": true,
+    "dts": true,
+    "entry": [
+      "./src/index.ts",
+      "./src/sdk.ts",
+      "./src/types.ts"
+    ],
+    "format": [
+      "esm",
+      "cjs"
+    ],
+    "minify": false,
+    "shims": true,
+    "sourcemap": true,
+    "splitting": true
+  }
+}

package/test-utils/sdks/simple/src/index.ts

@@ -0,0 +1,10 @@
+import SDK from './sdk.js';
+
+/**
+ * Swagger Petstore
+ *
+ * @author API Support <support@example.com>
+ */
+const createSDK = (() => { return new SDK(); })();
+
+export default createSDK;

package/test-utils/sdks/simple/src/schemas/Category.ts

@@ -0,0 +1,15 @@
+const Category = {
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "integer",
+      "format": "int64"
+    },
+    "name": {
+      "type": "string"
+    }
+  },
+  "title": "Category",
+  "x-readme-ref-name": "Category"
+} as const;
+export default Category

package/test-utils/sdks/simple/src/schemas/FindPetsByStatus.ts

@@ -0,0 +1,38 @@
+import Pet from './Pet.js';
+
+const FindPetsByStatus = {
+  "metadata": {
+    "allOf": [
+      {
+        "type": "object",
+        "properties": {
+          "status": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "enum": [
+                "available",
+                "pending",
+                "sold"
+              ],
+              "default": "available"
+            },
+            "$schema": "http://json-schema.org/draft-04/schema#",
+            "description": "Status values that need to be considered for filter"
+          }
+        },
+        "required": [
+          "status"
+        ]
+      }
+    ]
+  },
+  "response": {
+    "200": {
+      "type": "array",
+      "items": Pet,
+      "$schema": "http://json-schema.org/draft-04/schema#"
+    }
+  }
+} as const;
+export default FindPetsByStatus

package/test-utils/sdks/simple/src/schemas/Pet.ts

@@ -0,0 +1,53 @@
+import Category from './Category.js';
+import Tag from './Tag.js';
+
+const Pet = {
+  "type": "object",
+  "required": [
+    "name",
+    "photoUrls"
+  ],
+  "properties": {
+    "id": {
+      "type": "integer",
+      "format": "int64",
+      "readOnly": true,
+      "default": 40,
+      "examples": [
+        25
+      ]
+    },
+    "category": Category,
+    "name": {
+      "type": "string",
+      "examples": [
+        "doggie"
+      ]
+    },
+    "photoUrls": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "examples": [
+          "https://example.com/photo.png"
+        ]
+      }
+    },
+    "tags": {
+      "type": "array",
+      "items": Tag
+    },
+    "status": {
+      "type": "string",
+      "description": "pet status in the store\n\n`available` `pending` `sold`",
+      "enum": [
+        "available",
+        "pending",
+        "sold"
+      ]
+    }
+  },
+  "title": "Pet",
+  "x-readme-ref-name": "Pet"
+} as const;
+export default Pet

package/test-utils/sdks/simple/src/schemas/Tag.ts

@@ -0,0 +1,15 @@
+const Tag = {
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "integer",
+      "format": "int64"
+    },
+    "name": {
+      "type": "string"
+    }
+  },
+  "title": "Tag",
+  "x-readme-ref-name": "Tag"
+} as const;
+export default Tag

package/test-utils/sdks/simple/src/schemas.ts

@@ -0,0 +1,5 @@
+import Category from './schemas/Category.js';
+import FindPetsByStatus from './schemas/FindPetsByStatus.js';
+import Pet from './schemas/Pet.js';
+import Tag from './schemas/Tag.js';
+export { Category, FindPetsByStatus, Pet, Tag }

package/test-utils/sdks/simple/src/sdk.ts

@@ -0,0 +1,81 @@
+import type * as types from './types.js';
+import type { ConfigOptions, FetchResponse } from '@readme/api-core/types';
+import APICore from '@readme/api-core';
+import definition from '@api/test-utils/definitions/simple.json';
+
+export default class SDK {
+  core: APICore;
+
+  constructor() {
+    this.core = new APICore(definition, 'simple/1.0.0 (api/7.0.0-mock)');
+  }
+
+  /**
+   * Optionally configure various options that the SDK allows.
+   *
+   * @param config Object of supported SDK options and toggles.
+   * @param config.timeout Override the default `fetch` request timeout of 30 seconds. This number
+   * should be represented in milliseconds.
+   */
+  config(config: ConfigOptions) {
+    this.core.setConfig(config);
+  }
+
+  /**
+   * If the API you're using requires authentication you can supply the required credentials
+   * through this method and the library will magically determine how they should be used
+   * within your API request.
+   *
+   * With the exception of OpenID and MutualTLS, it supports all forms of authentication
+   * supported by the OpenAPI specification.
+   *
+   * @example <caption>HTTP Basic auth</caption>
+   * sdk.auth('username', 'password');
+   *
+   * @example <caption>Bearer tokens (HTTP or OAuth 2)</caption>
+   * sdk.auth('myBearerToken');
+   *
+   * @example <caption>API Keys</caption>
+   * sdk.auth('myApiKey');
+   *
+   * @see {@link https://spec.openapis.org/oas/v3.0.3#fixed-fields-22}
+   * @see {@link https://spec.openapis.org/oas/v3.1.0#fixed-fields-22}
+   * @param values Your auth credentials for the API; can specify up to two strings or numbers.
+   */
+  auth(...values: string[] | number[]) {
+    this.core.setAuth(...values);
+    return this;
+  }
+
+  /**
+   * If the API you're using offers alternate server URLs, and server variables, you can tell
+   * the SDK which one to use with this method. To use it you can supply either one of the
+   * server URLs that are contained within the OpenAPI definition (along with any server
+   * variables), or you can pass it a fully qualified URL to use (that may or may not exist
+   * within the OpenAPI definition).
+   *
+   * @example <caption>Server URL with server variables</caption>
+   * sdk.server('https://{region}.api.example.com/{basePath}', {
+   *   name: 'eu',
+   *   basePath: 'v14',
+   * });
+   *
+   * @example <caption>Fully qualified server URL</caption>
+   * sdk.server('https://eu.api.example.com/v14');
+   *
+   * @param url Server URL
+   * @param variables An object of variables to replace into the server URL.
+   */
+  server(url: string, variables = {}) {
+    this.core.setServer(url, variables);
+  }
+
+  /**
+   * Multiple status values can be provided with comma separated strings
+   *
+   * @summary Finds Pets by status
+   */
+  findPetsByStatus(metadata: types.FindPetsByStatusMetadataParam): Promise<FetchResponse<200, types.FindPetsByStatusResponse200>> {
+    return this.core.fetch('/pet/findByStatus', 'get', metadata);
+  }
+}

package/test-utils/sdks/simple/src/types.ts

@@ -0,0 +1,8 @@
+import type { FromSchema } from '@readme/api-core/types';
+import type * as schemas from './schemas.js';
+
+export type Category = FromSchema<typeof schemas.Category>;
+export type FindPetsByStatusMetadataParam = FromSchema<typeof schemas.FindPetsByStatus.metadata>;
+export type FindPetsByStatusResponse200 = FromSchema<typeof schemas.FindPetsByStatus.response['200']>;
+export type Pet = FromSchema<typeof schemas.Pet>;
+export type Tag = FromSchema<typeof schemas.Tag>;

package/test-utils/sdks/simple/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "esModuleInterop": true,
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "resolveJsonModule": true,
+    "strict": true
+  },
+  "include": [
+    "./src/**/*"
+  ]
+}

package/test-utils/sdks/star-trek/README.md

@@ -0,0 +1,22 @@
+# `@api/star-trek`
+
+This SDK was autogenerated by the [`api` SDK generator](https://api.readme.dev), powered by [ReadMe](https://readme.com) 🦉
+
+## Example Usage 🚀
+
+```js
+import starTrek from '@api/star-trek';
+
+starTrek.getAnimalSearch()
+  .then(({ data }) => console.log(data))
+  .catch(err => console.error(err));
+```
+
+<!---
+
+Here's some additional info about the generated SDK:
+
+`api` version: 7.0.0-mock
+Generated at 2023-10-25T00:00:00.000Z
+
+--->

package/test-utils/sdks/star-trek/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@api/star-trek",
+  "version": "1.0.0",
+  "type": "module",
+  "main": "dist/index.cjs",
+  "types": "dist/index.d.cts",
+  "module": "dist/index.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./sdk": {
+      "import": "./dist/sdk.js",
+      "require": "./dist/sdk.cjs"
+    },
+    "./types": {
+      "import": "./dist/types.js",
+      "require": "./dist/types.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "openapi.json"
+  ],
+  "scripts": {
+    "lint": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@readme/api-core": "file:../../../../../core"
+  },
+  "devDependencies": {
+    "tsup": "^7.2.0",
+    "typescript": "^5.2.2"
+  },
+  "tsup": {
+    "cjsInterop": true,
+    "clean": true,
+    "dts": true,
+    "entry": [
+      "./src/index.ts",
+      "./src/sdk.ts",
+      "./src/types.ts"
+    ],
+    "format": [
+      "esm",
+      "cjs"
+    ],
+    "minify": false,
+    "shims": true,
+    "sourcemap": true,
+    "splitting": true
+  }
+}

package/test-utils/sdks/star-trek/src/index.ts

@@ -0,0 +1,9 @@
+import SDK from './sdk.js';
+
+/**
+ * STAPI
+ *
+ */
+const createSDK = (() => { return new SDK(); })();
+
+export default createSDK;

package/test-utils/sdks/star-trek/src/schemas/AnimalBase.ts

@@ -0,0 +1,41 @@
+const AnimalBase = {
+  "type": "object",
+  "description": "Base animal, returned in search results",
+  "properties": {
+    "uid": {
+      "type": "string",
+      "description": "Animal unique ID"
+    },
+    "name": {
+      "type": "string",
+      "description": "Animal name"
+    },
+    "earthAnimal": {
+      "type": "boolean",
+      "description": "Whether it's an earth animal"
+    },
+    "earthInsect": {
+      "type": "boolean",
+      "description": "Whether it's an earth insect"
+    },
+    "avian": {
+      "type": "boolean",
+      "description": "Whether it's an avian"
+    },
+    "canine": {
+      "type": "boolean",
+      "description": "Whether it's a canine"
+    },
+    "feline": {
+      "type": "boolean",
+      "description": "Whether it's a feline"
+    }
+  },
+  "required": [
+    "uid",
+    "name"
+  ],
+  "title": "AnimalBase",
+  "x-readme-ref-name": "AnimalBase"
+} as const;
+export default AnimalBase