@bfra.me/api-core 0.1.0

package/test-utils/sdks/metrotransit/src/schemas/Vehicle.ts

@@ -0,0 +1,61 @@
+const Vehicle = {
+  "type": "object",
+  "properties": {
+    "trip_id": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "direction_id": {
+      "type": "integer",
+      "format": "int32"
+    },
+    "direction": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "location_time": {
+      "type": "integer",
+      "format": "int64"
+    },
+    "route_id": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "terminal": {
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "latitude": {
+      "type": "number",
+      "format": "float"
+    },
+    "longitude": {
+      "type": "number",
+      "format": "float"
+    },
+    "bearing": {
+      "type": "number",
+      "format": "float"
+    },
+    "odometer": {
+      "type": "number",
+      "format": "double"
+    },
+    "speed": {
+      "type": "number",
+      "format": "float"
+    }
+  },
+  "additionalProperties": false,
+  "title": "Vehicle",
+  "x-readme-ref-name": "Vehicle"
+} as const;
+export default Vehicle

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

@@ -0,0 +1,18 @@
+import Agency from './schemas/Agency.js';
+import AlertMessage from './schemas/AlertMessage.js';
+import Departure from './schemas/Departure.js';
+import Direction from './schemas/Direction.js';
+import GetNextripAgencies from './schemas/GetNextripAgencies.js';
+import GetNextripDirectionsRouteId from './schemas/GetNextripDirectionsRouteId.js';
+import GetNextripRouteIdDirectionIdPlaceCode from './schemas/GetNextripRouteIdDirectionIdPlaceCode.js';
+import GetNextripRoutes from './schemas/GetNextripRoutes.js';
+import GetNextripStopId from './schemas/GetNextripStopId.js';
+import GetNextripStopsRouteIdDirectionId from './schemas/GetNextripStopsRouteIdDirectionId.js';
+import GetNextripVehiclesRouteId from './schemas/GetNextripVehiclesRouteId.js';
+import NexTripResult from './schemas/NexTripResult.js';
+import Place from './schemas/Place.js';
+import ProblemDetails from './schemas/ProblemDetails.js';
+import Route from './schemas/Route.js';
+import Stop from './schemas/Stop.js';
+import Vehicle from './schemas/Vehicle.js';
+export { Agency, AlertMessage, Departure, Direction, GetNextripAgencies, GetNextripDirectionsRouteId, GetNextripRouteIdDirectionIdPlaceCode, GetNextripRoutes, GetNextripStopId, GetNextripStopsRouteIdDirectionId, GetNextripVehiclesRouteId, NexTripResult, Place, ProblemDetails, Route, Stop, Vehicle }

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

@@ -0,0 +1,107 @@
+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/metrotransit.json';
+
+export default class SDK {
+  core: APICore;
+
+  constructor() {
+    this.core = new APICore(definition, 'metrotransit/2 (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);
+  }
+
+  /** @throws FetchError<400, types.ProblemDetails> Bad Request */
+  getNextripAgencies(): Promise<FetchResponse<200, types.GetNextripAgenciesResponse200>> {
+    return this.core.fetch('/nextrip/agencies', 'get');
+  }
+
+  /** @throws FetchError<400, types.ProblemDetails> Bad Request */
+  getNextripRoutes(): Promise<FetchResponse<200, types.GetNextripRoutesResponse200>> {
+    return this.core.fetch('/nextrip/routes', 'get');
+  }
+
+  /** @throws FetchError<400, types.ProblemDetails> Bad Request */
+  getNextripDirectionsRoute_id(metadata: types.GetNextripDirectionsRouteIdMetadataParam): Promise<FetchResponse<200, types.GetNextripDirectionsRouteIdResponse200>> {
+    return this.core.fetch('/nextrip/directions/{route_id}', 'get', metadata);
+  }
+
+  /** @throws FetchError<400, types.ProblemDetails> Bad Request */
+  getNextripStopsRoute_idDirection_id(metadata: types.GetNextripStopsRouteIdDirectionIdMetadataParam): Promise<FetchResponse<200, types.GetNextripStopsRouteIdDirectionIdResponse200>> {
+    return this.core.fetch('/nextrip/stops/{route_id}/{direction_id}', 'get', metadata);
+  }
+
+  /** @throws FetchError<400, types.ProblemDetails> Bad Request */
+  getNextripStop_id(metadata: types.GetNextripStopIdMetadataParam): Promise<FetchResponse<200, types.NexTripResult>> {
+    return this.core.fetch('/nextrip/{stop_id}', 'get', metadata);
+  }
+
+  /** @throws FetchError<400, types.ProblemDetails> Bad Request */
+  getNextripRoute_idDirection_idPlace_code(metadata: types.GetNextripRouteIdDirectionIdPlaceCodeMetadataParam): Promise<FetchResponse<200, types.NexTripResult>> {
+    return this.core.fetch('/nextrip/{route_id}/{direction_id}/{place_code}', 'get', metadata);
+  }
+
+  /** @throws FetchError<400, types.ProblemDetails> Bad Request */
+  getNextripVehiclesRoute_id(metadata: types.GetNextripVehiclesRouteIdMetadataParam): Promise<FetchResponse<200, types.GetNextripVehiclesRouteIdResponse200>> {
+    return this.core.fetch('/nextrip/vehicles/{route_id}', 'get', metadata);
+  }
+}

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

@@ -0,0 +1,23 @@
+import type { FromSchema } from '@readme/api-core/types';
+import type * as schemas from './schemas.js';
+
+export type Agency = FromSchema<typeof schemas.Agency>;
+export type AlertMessage = FromSchema<typeof schemas.AlertMessage>;
+export type Departure = FromSchema<typeof schemas.Departure>;
+export type Direction = FromSchema<typeof schemas.Direction>;
+export type GetNextripAgenciesResponse200 = FromSchema<typeof schemas.GetNextripAgencies.response['200']>;
+export type GetNextripDirectionsRouteIdMetadataParam = FromSchema<typeof schemas.GetNextripDirectionsRouteId.metadata>;
+export type GetNextripDirectionsRouteIdResponse200 = FromSchema<typeof schemas.GetNextripDirectionsRouteId.response['200']>;
+export type GetNextripRouteIdDirectionIdPlaceCodeMetadataParam = FromSchema<typeof schemas.GetNextripRouteIdDirectionIdPlaceCode.metadata>;
+export type GetNextripRoutesResponse200 = FromSchema<typeof schemas.GetNextripRoutes.response['200']>;
+export type GetNextripStopIdMetadataParam = FromSchema<typeof schemas.GetNextripStopId.metadata>;
+export type GetNextripStopsRouteIdDirectionIdMetadataParam = FromSchema<typeof schemas.GetNextripStopsRouteIdDirectionId.metadata>;
+export type GetNextripStopsRouteIdDirectionIdResponse200 = FromSchema<typeof schemas.GetNextripStopsRouteIdDirectionId.response['200']>;
+export type GetNextripVehiclesRouteIdMetadataParam = FromSchema<typeof schemas.GetNextripVehiclesRouteId.metadata>;
+export type GetNextripVehiclesRouteIdResponse200 = FromSchema<typeof schemas.GetNextripVehiclesRouteId.response['200']>;
+export type NexTripResult = FromSchema<typeof schemas.NexTripResult>;
+export type Place = FromSchema<typeof schemas.Place>;
+export type ProblemDetails = FromSchema<typeof schemas.ProblemDetails>;
+export type Route = FromSchema<typeof schemas.Route>;
+export type Stop = FromSchema<typeof schemas.Stop>;
+export type Vehicle = FromSchema<typeof schemas.Vehicle>;

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

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

package/test-utils/sdks/operationid-quirks/README.md

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

@@ -0,0 +1,50 @@
+{
+  "name": "@api/operationid-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"
+    },
+    "./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"
+    ],
+    "format": [
+      "esm",
+      "cjs"
+    ],
+    "minify": false,
+    "shims": true,
+    "sourcemap": true,
+    "splitting": true
+  }
+}

package/test-utils/sdks/operationid-quirks/src/index.ts

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

package/test-utils/sdks/operationid-quirks/src/sdk.ts

@@ -0,0 +1,107 @@
+import type { ConfigOptions, FetchResponse } from '@readme/api-core/types';
+import APICore from '@readme/api-core';
+import definition from '@api/test-utils/definitions/operationid-quirks.json';
+
+export default class SDK {
+  core: APICore;
+
+  constructor() {
+    this.core = new APICore(definition, 'operationid-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);
+  }
+
+  /**
+   * This mess of a string is intentionally nasty so we can be sure that we're not including
+   * anything that wouldn't look right as an operationID for a potential method accessor in
+   * `api`.
+   *
+   */
+  quirky_OperationId_string(): Promise<FetchResponse<number, unknown>> {
+    return this.core.fetch('/quirky-operationId', 'get');
+  }
+
+  /**
+   * This operation doesn't have an `operationId` so we should create one.
+   *
+   */
+  getNoOperationId(): Promise<FetchResponse<number, unknown>> {
+    return this.core.fetch('/no-operation-id', 'get');
+  }
+
+  /**
+   * This operation has no `operationId` but because path starts with an HTTP method when we
+   * generate an `operationId` that has `get` doubled.
+   *
+   */
+  getOperationPathStartsWithAnHttpMethod(): Promise<FetchResponse<number, unknown>> {
+    return this.core.fetch('/get-operation-path-starts-with-an-http-method', 'get');
+  }
+
+  /**
+   * This operation has an `operationId` with hypens yet it should still be accessible in the
+   * dynamic `api` flow.
+   *
+   */
+  hyphenatedOperationId(): Promise<FetchResponse<number, unknown>> {
+    return this.core.fetch('/hyphenated-operation-id', 'get');
+  }
+}

package/test-utils/sdks/operationid-quirks/tsconfig.json

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

package/test-utils/sdks/optional-payload/README.md

@@ -0,0 +1,14 @@
+# `@api/optional-payload`
+
+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/optional-payload/package.json

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

@@ -0,0 +1,9 @@
+import SDK from './sdk.js';
+
+/**
+ * Example API with a requestBody payload that's optional.
+ *
+ */
+const createSDK = (() => { return new SDK(); })();
+
+export default createSDK;

package/test-utils/sdks/optional-payload/src/schemas/UpdatePetWithForm.ts

@@ -0,0 +1,35 @@
+const UpdatePetWithForm = {
+  "formData": {
+    "type": "object",
+    "properties": {
+      "name": {
+        "description": "Updated name of the pet",
+        "type": "string"
+      },
+      "status": {
+        "description": "Updated status of the pet",
+        "type": "string"
+      }
+    },
+    "$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 that needs to be updated"
+          }
+        },
+        "required": [
+          "petId"
+        ]
+      }
+    ]
+  }
+} as const;
+export default UpdatePetWithForm

package/test-utils/sdks/optional-payload/src/schemas.ts

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

package/test-utils/sdks/optional-payload/src/sdk.ts

@@ -0,0 +1,82 @@
+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/optional-payload.json';
+
+export default class SDK {
+  core: APICore;
+
+  constructor() {
+    this.core = new APICore(definition, 'optional-payload/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);
+  }
+
+  /**
+   * 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);
+  }
+}

package/test-utils/sdks/optional-payload/src/types.ts

@@ -0,0 +1,5 @@
+import type { FromSchema } from '@readme/api-core/types';
+import type * as schemas from './schemas.js';
+
+export type UpdatePetWithFormFormDataParam = FromSchema<typeof schemas.UpdatePetWithForm.formData>;
+export type UpdatePetWithFormMetadataParam = FromSchema<typeof schemas.UpdatePetWithForm.metadata>;

package/test-utils/sdks/optional-payload/tsconfig.json

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