@bfra.me/api-core 0.1.0 → 0.1.2

package/test-utils/sdks/petstore/src/schemas/UpdateUser.ts

@@ -1,20 +0,0 @@
-const UpdateUser = {
-  "metadata": {
-    "allOf": [
-      {
-        "type": "object",
-        "properties": {
-          "username": {
-            "type": "string",
-            "$schema": "http://json-schema.org/draft-04/schema#",
-            "description": "name that need to be updated"
-          }
-        },
-        "required": [
-          "username"
-        ]
-      }
-    ]
-  }
-} as const;
-export default UpdateUser

package/test-utils/sdks/petstore/src/schemas/UploadFile.ts

@@ -1,36 +0,0 @@
-const UploadFile = {
-  "body": {
-    "type": "object",
-    "properties": {
-      "additionalMetadata": {
-        "description": "Additional data to pass to server",
-        "type": "string"
-      },
-      "file": {
-        "description": "file to upload",
-        "type": "string",
-        "format": "binary"
-      }
-    },
-    "$schema": "http://json-schema.org/draft-04/schema#"
-  },
-  "metadata": {
-    "allOf": [
-      {
-        "type": "object",
-        "properties": {
-          "petId": {
-            "type": "integer",
-            "format": "int64",
-            "$schema": "http://json-schema.org/draft-04/schema#",
-            "description": "ID of pet to update"
-          }
-        },
-        "required": [
-          "petId"
-        ]
-      }
-    ]
-  }
-} as const;
-export default UploadFile

package/test-utils/sdks/petstore/src/schemas/User.ts

@@ -1,35 +0,0 @@
-const User = {
-  "type": "object",
-  "properties": {
-    "id": {
-      "type": "integer",
-      "format": "int64"
-    },
-    "username": {
-      "type": "string"
-    },
-    "firstName": {
-      "type": "string"
-    },
-    "lastName": {
-      "type": "string"
-    },
-    "email": {
-      "type": "string"
-    },
-    "password": {
-      "type": "string"
-    },
-    "phone": {
-      "type": "string"
-    },
-    "userStatus": {
-      "type": "integer",
-      "format": "int32",
-      "description": "User Status"
-    }
-  },
-  "title": "User",
-  "x-readme-ref-name": "User"
-} as const;
-export default User

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

@@ -1,22 +0,0 @@
-import ApiResponse from './schemas/ApiResponse.js';
-import Category from './schemas/Category.js';
-import CreateUsersWithArrayInput from './schemas/CreateUsersWithArrayInput.js';
-import CreateUsersWithListInput from './schemas/CreateUsersWithListInput.js';
-import DeleteOrder from './schemas/DeleteOrder.js';
-import DeletePet from './schemas/DeletePet.js';
-import DeleteUser from './schemas/DeleteUser.js';
-import FindPetsByStatus from './schemas/FindPetsByStatus.js';
-import FindPetsByTags from './schemas/FindPetsByTags.js';
-import GetInventory from './schemas/GetInventory.js';
-import GetOrderById from './schemas/GetOrderById.js';
-import GetPetById from './schemas/GetPetById.js';
-import GetUserByName from './schemas/GetUserByName.js';
-import LoginUser from './schemas/LoginUser.js';
-import Order from './schemas/Order.js';
-import Pet from './schemas/Pet.js';
-import Tag from './schemas/Tag.js';
-import UpdatePetWithForm from './schemas/UpdatePetWithForm.js';
-import UpdateUser from './schemas/UpdateUser.js';
-import UploadFile from './schemas/UploadFile.js';
-import User from './schemas/User.js';
-export { ApiResponse, Category, CreateUsersWithArrayInput, CreateUsersWithListInput, DeleteOrder, DeletePet, DeleteUser, FindPetsByStatus, FindPetsByTags, GetInventory, GetOrderById, GetPetById, GetUserByName, LoginUser, Order, Pet, Tag, UpdatePetWithForm, UpdateUser, UploadFile, User }

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

@@ -1,248 +0,0 @@
-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 '@readme/oas-examples/3.0/json/petstore.json';
-
-export default class SDK {
-  core: APICore;
-
-  constructor() {
-    this.core = new APICore(definition, 'petstore/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);
-  }
-
-  /**
-   * Add a new pet to the store
-   *
-   */
-  addPet(body: types.Pet): Promise<FetchResponse<number, unknown>> {
-    return this.core.fetch('/pet', 'post', body);
-  }
-
-  /**
-   * Update an existing pet
-   *
-   */
-  updatePet(body: types.Pet): Promise<FetchResponse<number, unknown>> {
-    return this.core.fetch('/pet', 'put', body);
-  }
-
-  /**
-   * 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);
-  }
-
-  /**
-   * Muliple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for
-   * testing.
-   *
-   * @summary Finds Pets by tags
-   */
-  findPetsByTags(metadata: types.FindPetsByTagsMetadataParam): Promise<FetchResponse<200, types.FindPetsByTagsResponse200>> {
-    return this.core.fetch('/pet/findByTags', 'get', metadata);
-  }
-
-  /**
-   * Returns a single pet
-   *
-   * @summary Find pet by ID
-   */
-  getPetById(metadata: types.GetPetByIdMetadataParam): Promise<FetchResponse<200, types.Pet>> {
-    return this.core.fetch('/pet/{petId}', 'get', metadata);
-  }
-
-  /**
-   * Updates a pet in the store with form data
-   *
-   */
-  updatePetWithForm(body: types.UpdatePetWithFormFormDataParam, metadata: types.UpdatePetWithFormMetadataParam): Promise<FetchResponse<number, unknown>>;
-  updatePetWithForm(metadata: types.UpdatePetWithFormMetadataParam): Promise<FetchResponse<number, unknown>>;
-  updatePetWithForm(body?: types.UpdatePetWithFormFormDataParam | types.UpdatePetWithFormMetadataParam, metadata?: types.UpdatePetWithFormMetadataParam): Promise<FetchResponse<number, unknown>> {
-    return this.core.fetch('/pet/{petId}', 'post', body, metadata);
-  }
-
-  /**
-   * Deletes a pet
-   *
-   */
-  deletePet(metadata: types.DeletePetMetadataParam): Promise<FetchResponse<number, unknown>> {
-    return this.core.fetch('/pet/{petId}', 'delete', metadata);
-  }
-
-  /**
-   * Uploads an image
-   *
-   */
-  uploadFile(body: types.UploadFileBodyParam, metadata: types.UploadFileMetadataParam): Promise<FetchResponse<200, types.ApiResponse>>;
-  uploadFile(metadata: types.UploadFileMetadataParam): Promise<FetchResponse<200, types.ApiResponse>>;
-  uploadFile(body?: types.UploadFileBodyParam | types.UploadFileMetadataParam, metadata?: types.UploadFileMetadataParam): Promise<FetchResponse<200, types.ApiResponse>> {
-    return this.core.fetch('/pet/{petId}/uploadImage', 'post', body, metadata);
-  }
-
-  /**
-   * Returns a map of status codes to quantities
-   *
-   * @summary Returns pet inventories by status
-   */
-  getInventory(): Promise<FetchResponse<200, types.GetInventoryResponse200>> {
-    return this.core.fetch('/store/inventory', 'get');
-  }
-
-  /**
-   * Place an order for a pet
-   *
-   */
-  placeOrder(body: types.Order): Promise<FetchResponse<200, types.Order>> {
-    return this.core.fetch('/store/order', 'post', body);
-  }
-
-  /**
-   * For valid response try integer IDs with value >= 1 and <= 10. Other values will
-   * generated exceptions
-   *
-   * @summary Find purchase order by ID
-   */
-  getOrderById(metadata: types.GetOrderByIdMetadataParam): Promise<FetchResponse<200, types.Order>> {
-    return this.core.fetch('/store/order/{orderId}', 'get', metadata);
-  }
-
-  /**
-   * For valid response try integer IDs with positive integer value. Negative or non-integer
-   * values will generate API errors
-   *
-   * @summary Delete purchase order by ID
-   */
-  deleteOrder(metadata: types.DeleteOrderMetadataParam): Promise<FetchResponse<number, unknown>> {
-    return this.core.fetch('/store/order/{orderId}', 'delete', metadata);
-  }
-
-  /**
-   * This can only be done by the logged in user.
-   *
-   * @summary Create user
-   */
-  createUser(body: types.User): Promise<FetchResponse<number, unknown>> {
-    return this.core.fetch('/user', 'post', body);
-  }
-
-  /**
-   * Creates list of users with given input array
-   *
-   */
-  createUsersWithArrayInput(body: types.CreateUsersWithArrayInputBodyParam): Promise<FetchResponse<number, unknown>> {
-    return this.core.fetch('/user/createWithArray', 'post', body);
-  }
-
-  /**
-   * Creates list of users with given input array
-   *
-   */
-  createUsersWithListInput(body: types.CreateUsersWithListInputBodyParam): Promise<FetchResponse<number, unknown>> {
-    return this.core.fetch('/user/createWithList', 'post', body);
-  }
-
-  /**
-   * Logs user into the system
-   *
-   */
-  loginUser(metadata: types.LoginUserMetadataParam): Promise<FetchResponse<200, types.LoginUserResponse200>> {
-    return this.core.fetch('/user/login', 'get', metadata);
-  }
-
-  /**
-   * Logs out current logged in user session
-   *
-   */
-  logoutUser(): Promise<FetchResponse<number, unknown>> {
-    return this.core.fetch('/user/logout', 'get');
-  }
-
-  /**
-   * Get user by user name
-   *
-   */
-  getUserByName(metadata: types.GetUserByNameMetadataParam): Promise<FetchResponse<200, types.User>> {
-    return this.core.fetch('/user/{username}', 'get', metadata);
-  }
-
-  /**
-   * This can only be done by the logged in user.
-   *
-   * @summary Updated user
-   */
-  updateUser(body: types.User, metadata: types.UpdateUserMetadataParam): Promise<FetchResponse<number, unknown>> {
-    return this.core.fetch('/user/{username}', 'put', body, metadata);
-  }
-
-  /**
-   * This can only be done by the logged in user.
-   *
-   * @summary Delete user
-   */
-  deleteUser(metadata: types.DeleteUserMetadataParam): Promise<FetchResponse<number, unknown>> {
-    return this.core.fetch('/user/{username}', 'delete', metadata);
-  }
-}

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

@@ -1,29 +0,0 @@
-import type { FromSchema } from '@readme/api-core/types';
-import type * as schemas from './schemas.js';
-
-export type ApiResponse = FromSchema<typeof schemas.ApiResponse>;
-export type Category = FromSchema<typeof schemas.Category>;
-export type CreateUsersWithArrayInputBodyParam = FromSchema<typeof schemas.CreateUsersWithArrayInput.body>;
-export type CreateUsersWithListInputBodyParam = FromSchema<typeof schemas.CreateUsersWithListInput.body>;
-export type DeleteOrderMetadataParam = FromSchema<typeof schemas.DeleteOrder.metadata>;
-export type DeletePetMetadataParam = FromSchema<typeof schemas.DeletePet.metadata>;
-export type DeleteUserMetadataParam = FromSchema<typeof schemas.DeleteUser.metadata>;
-export type FindPetsByStatusMetadataParam = FromSchema<typeof schemas.FindPetsByStatus.metadata>;
-export type FindPetsByStatusResponse200 = FromSchema<typeof schemas.FindPetsByStatus.response['200']>;
-export type FindPetsByTagsMetadataParam = FromSchema<typeof schemas.FindPetsByTags.metadata>;
-export type FindPetsByTagsResponse200 = FromSchema<typeof schemas.FindPetsByTags.response['200']>;
-export type GetInventoryResponse200 = FromSchema<typeof schemas.GetInventory.response['200']>;
-export type GetOrderByIdMetadataParam = FromSchema<typeof schemas.GetOrderById.metadata>;
-export type GetPetByIdMetadataParam = FromSchema<typeof schemas.GetPetById.metadata>;
-export type GetUserByNameMetadataParam = FromSchema<typeof schemas.GetUserByName.metadata>;
-export type LoginUserMetadataParam = FromSchema<typeof schemas.LoginUser.metadata>;
-export type LoginUserResponse200 = FromSchema<typeof schemas.LoginUser.response['200']>;
-export type Order = FromSchema<typeof schemas.Order>;
-export type Pet = FromSchema<typeof schemas.Pet>;
-export type Tag = FromSchema<typeof schemas.Tag>;
-export type UpdatePetWithFormFormDataParam = FromSchema<typeof schemas.UpdatePetWithForm.formData>;
-export type UpdatePetWithFormMetadataParam = FromSchema<typeof schemas.UpdatePetWithForm.metadata>;
-export type UpdateUserMetadataParam = FromSchema<typeof schemas.UpdateUser.metadata>;
-export type UploadFileBodyParam = FromSchema<typeof schemas.UploadFile.body>;
-export type UploadFileMetadataParam = FromSchema<typeof schemas.UploadFile.metadata>;
-export type User = FromSchema<typeof schemas.User>;

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

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

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

@@ -1,23 +0,0 @@
-# `@api/readme`
-
-This SDK was autogenerated by the [`api` SDK generator](https://api.readme.dev), powered by [ReadMe](https://readme.com) 🦉
-
-## Example Usage 🚀
-
-```js
-import readme from '@api/readme';
-
-readme.auth('username', 'password');
-readme.getAPISpecification()
-  .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/readme/package.json

@@ -1,55 +0,0 @@
-{
-  "name": "@api/readme",
-  "version": "4.355.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/readme/src/index.ts

@@ -1,13 +0,0 @@
-import SDK from './sdk.js';
-
-/**
- * ReadMe API 🦉
- *
- * Create beautiful product and API documentation with our developer friendly platform.
- *
- * @author API Support <support@readme.io>
- * @see {@link https://docs.readme.com/main/docs/need-more-support}
- */
-const createSDK = (() => { return new SDK(); })();
-
-export default createSDK;

package/test-utils/sdks/readme/src/schemas/Apply.ts

@@ -1,61 +0,0 @@
-const Apply = {
-  "type": "object",
-  "properties": {
-    "name": {
-      "type": "string",
-      "minLength": 1,
-      "description": "Your full name",
-      "default": "Your Name"
-    },
-    "email": {
-      "type": "string",
-      "format": "email",
-      "description": "A valid email we can reach you at.",
-      "default": "you@example.com"
-    },
-    "job": {
-      "type": "string",
-      "description": "The job you're looking to apply for (https://readme.com/careers).",
-      "enum": [
-        "Front End Engineer",
-        "Full Stack Engineer",
-        "Head of Product",
-        "Head of Solutions Engineering",
-        "Product Designer"
-      ],
-      "default": "Front End Engineer"
-    },
-    "pronouns": {
-      "type": "string",
-      "description": "Learn more at https://lgbtlifecenter.org/pronouns/"
-    },
-    "linkedin": {
-      "type": "string",
-      "format": "url",
-      "description": "What have you been up to the past few years?"
-    },
-    "github": {
-      "type": "string",
-      "description": "Or Bitbucket, Gitlab or anywhere else your code is hosted!",
-      "format": "url"
-    },
-    "coverLetter": {
-      "type": "string",
-      "format": "blob",
-      "description": "What should we know about you?"
-    },
-    "dontReallyApply": {
-      "type": "boolean",
-      "description": "Want to play with the API but not actually apply? Set this to true.",
-      "default": false
-    }
-  },
-  "required": [
-    "name",
-    "email",
-    "job"
-  ],
-  "title": "apply",
-  "x-readme-ref-name": "apply"
-} as const;
-export default Apply

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

@@ -1,24 +0,0 @@
-const Category = {
-  "type": "object",
-  "title": "category",
-  "x-readme-ref-name": "category",
-  "required": [
-    "title"
-  ],
-  "properties": {
-    "title": {
-      "type": "string",
-      "description": "A short title for the category. This is what will show in the sidebar."
-    },
-    "type": {
-      "type": "string",
-      "enum": [
-        "reference",
-        "guide"
-      ],
-      "default": "guide",
-      "description": "A category can be part of your reference or guide documentation, which is determined by this field."
-    }
-  }
-} as const;
-export default Category

package/test-utils/sdks/readme/src/schemas/Changelog.ts

@@ -1,36 +0,0 @@
-const Changelog = {
-  "type": "object",
-  "properties": {
-    "title": {
-      "type": "string",
-      "description": "Title of the changelog."
-    },
-    "type": {
-      "type": "string",
-      "enum": [
-        "",
-        "added",
-        "fixed",
-        "improved",
-        "deprecated",
-        "removed"
-      ]
-    },
-    "body": {
-      "type": "string",
-      "description": "Body content of the changelog."
-    },
-    "hidden": {
-      "type": "boolean",
-      "description": "Visibility of the changelog.",
-      "default": true
-    }
-  },
-  "required": [
-    "title",
-    "body"
-  ],
-  "title": "changelog",
-  "x-readme-ref-name": "changelog"
-} as const;
-export default Changelog

package/test-utils/sdks/readme/src/schemas/CondensedProjectData.ts

@@ -1,25 +0,0 @@
-const CondensedProjectData = {
-  "type": "object",
-  "properties": {
-    "name": {
-      "type": "string"
-    },
-    "subdomain": {
-      "type": "string"
-    },
-    "jwtSecret": {
-      "type": "string"
-    },
-    "baseUrl": {
-      "type": "string",
-      "format": "url",
-      "description": "The base URL for the project. If the project is not running under a custom domain, it will be `https://projectSubdomain.readme.io`, otherwise it can either be or `https://example.com` or, in the case of an enterprise child project `https://example.com/projectSubdomain`."
-    },
-    "plan": {
-      "type": "string"
-    }
-  },
-  "title": "condensedProjectData",
-  "x-readme-ref-name": "condensedProjectData"
-} as const;
-export default CondensedProjectData

package/test-utils/sdks/readme/src/schemas/CreateCategory.ts

@@ -1,21 +0,0 @@
-const CreateCategory = {
-  "metadata": {
-    "allOf": [
-      {
-        "type": "object",
-        "properties": {
-          "x-readme-version": {
-            "type": "string",
-            "examples": [
-              "v3.0"
-            ],
-            "$schema": "http://json-schema.org/draft-04/schema#",
-            "description": "Version number of your docs project, for example, v3.0. By default the main project version is used. To see all valid versions for your docs project call https://docs.readme.com/main/reference/version#getversions."
-          }
-        },
-        "required": []
-      }
-    ]
-  }
-} as const;
-export default CreateCategory