@bfra.me/api-core 0.1.0

package/test-utils/definitions/payloads.json

@@ -0,0 +1,58 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "title": "OAS test cases",
+    "version": "1.0.0"
+  },
+  "servers": [
+    {
+      "url": "https://api.example.com"
+    }
+  ],
+  "paths": {
+    "/arraySchema": {
+      "put": {
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "name": {
+                      "type": "string"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      }
+    },
+    "/primitiveBody": {
+      "put": {
+        "requestBody": {
+          "content": {
+            "text/plain": {
+              "schema": {
+                "type": "string"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      }
+    }
+  }
+}

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

@@ -0,0 +1,77 @@
+{
+  "openapi": "3.1.0",
+  "info": {
+    "title": "Testing an OAS that has response `title` props that start with a number",
+    "version": "1.0.0"
+  },
+  "servers": [
+    {
+      "url": "https://httpbin.org"
+    }
+  ],
+  "paths": {
+    "/anything": {
+      "get": {
+        "operationId": "getAnything",
+        "parameters": [
+          {
+            "name": "status",
+            "in": "query",
+            "description": "Status values that need to be considered for filter",
+            "required": true,
+            "explode": true,
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string",
+                "enum": ["available", "pending", "sold"],
+                "default": "available"
+              }
+            }
+          }
+        ],
+        "responses": {
+          "2XX": {
+            "description": "2XX",
+            "content": {
+              "application/json": {
+                "examples": {
+                  "260 Created (token)": {
+                    "value": "{\n\t\"id\": \"e450ec69-dac2-4858-b4c9-6d3af44bb5f8\",\n\t\"user\": {\n\t\t\"id\": \"dd57ae92-bd88-4663-bb9f-5bfd6d75ff85\",\n\t\t\"type\": \"customer\",\n\t\t\"uniqueId\": \"john-smith\"\n\t},\n\t\"session\": {\n\t\t\"id\": \"1063547f-30a1-44c4-ae6f-1dfad5b64403\",\n\t\t\"externalRef\": \"external-session-ref\",\n\t\t\"isAuthenticated\": false\n\t},\n\t\"token\": \"eyJh...\"\n}"
+                  },
+                  "260 Created": {
+                    "value": "{\n\t\"id\": \"e450ec69-dac2-4858-b4c9-6d3af44bb5f8\",\n\t\"user\": {\n\t\t\"id\": \"dd57ae92-bd88-4663-bb9f-5bfd6d75ff85\",\n\t\t\"type\": \"customer\",\n\t\t\"uniqueId\": \"john-smith\"\n\t},\n\t\"session\": {\n\t\t\"id\": \"1063547f-30a1-44c4-ae6f-1dfad5b64403\",\n\t\t\"externalRef\": \"external-session-ref\",\n\t\t\"isAuthenticated\": false\n\t}\n}"
+                  }
+                },
+                "schema": {
+                  "oneOf": [
+                    {
+                      "title": "260 Created (token)",
+                      "type": "object",
+                      "properties": {
+                        "id": {
+                          "type": "string",
+                          "example": "e450ec69-dac2-4858-b4c9-6d3af44bb5f8"
+                        }
+                      }
+                    },
+                    {
+                      "title": "260 Created",
+                      "type": "object",
+                      "properties": {
+                        "id": {
+                          "type": "string",
+                          "example": "e450ec69-dac2-4858-b4c9-6d3af44bb5f8"
+                        }
+                      }
+                    }
+                  ]
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/test-utils/definitions/simple.json

@@ -0,0 +1,291 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "version": "1.0.0",
+    "title": "Swagger Petstore",
+    "contact": {
+      "name": "API Support",
+      "email": "support@example.com"
+    }
+  },
+  "servers": [
+    {
+      "url": "http://petstore.swagger.io/v2"
+    }
+  ],
+  "paths": {
+    "/pet/findByStatus": {
+      "get": {
+        "tags": ["pet"],
+        "summary": "Finds Pets by status",
+        "description": "Multiple status values can be provided with comma separated strings",
+        "operationId": "findPetsByStatus",
+        "parameters": [
+          {
+            "name": "status",
+            "in": "query",
+            "description": "Status values that need to be considered for filter",
+            "required": true,
+            "explode": true,
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "string",
+                "enum": ["available", "pending", "sold"],
+                "default": "available"
+              }
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "successful operation",
+            "content": {
+              "application/xml": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/Pet"
+                  }
+                }
+              },
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/Pet"
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid status value"
+          }
+        },
+        "security": [
+          {
+            "petstore_auth": ["write:pets", "read:pets"]
+          }
+        ]
+      }
+    }
+  },
+  "components": {
+    "requestBodies": {
+      "Pet": {
+        "content": {
+          "application/json": {
+            "schema": {
+              "$ref": "#/components/schemas/Pet"
+            }
+          },
+          "application/xml": {
+            "schema": {
+              "$ref": "#/components/schemas/Pet"
+            }
+          }
+        },
+        "description": "Pet object that needs to be added to the store",
+        "required": true
+      },
+      "UserArray": {
+        "content": {
+          "application/json": {
+            "schema": {
+              "type": "array",
+              "items": {
+                "$ref": "#/components/schemas/User"
+              }
+            }
+          }
+        },
+        "description": "List of user object",
+        "required": true
+      }
+    },
+    "securitySchemes": {
+      "petstore_auth": {
+        "type": "oauth2",
+        "flows": {
+          "implicit": {
+            "authorizationUrl": "http://petstore.swagger.io/oauth/dialog",
+            "scopes": {
+              "write:pets": "modify pets in your account",
+              "read:pets": "read your pets"
+            }
+          }
+        }
+      },
+      "api_key": {
+        "type": "apiKey",
+        "name": "api_key",
+        "in": "header"
+      }
+    },
+    "schemas": {
+      "Order": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "integer",
+            "format": "int64"
+          },
+          "petId": {
+            "type": "integer",
+            "format": "int64"
+          },
+          "quantity": {
+            "type": "integer",
+            "format": "int32"
+          },
+          "shipDate": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "status": {
+            "type": "string",
+            "description": "Order Status",
+            "enum": ["placed", "approved", "delivered"]
+          },
+          "complete": {
+            "type": "boolean",
+            "default": false
+          }
+        },
+        "xml": {
+          "name": "Order"
+        }
+      },
+      "Category": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "integer",
+            "format": "int64"
+          },
+          "name": {
+            "type": "string"
+          }
+        },
+        "xml": {
+          "name": "Category"
+        }
+      },
+      "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"
+          }
+        },
+        "xml": {
+          "name": "User"
+        }
+      },
+      "Tag": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "integer",
+            "format": "int64"
+          },
+          "name": {
+            "type": "string"
+          }
+        },
+        "xml": {
+          "name": "Tag"
+        }
+      },
+      "Pet": {
+        "type": "object",
+        "required": ["name", "photoUrls"],
+        "properties": {
+          "id": {
+            "type": "integer",
+            "format": "int64",
+            "readOnly": true,
+            "default": 40,
+            "example": 25
+          },
+          "category": {
+            "$ref": "#/components/schemas/Category"
+          },
+          "name": {
+            "type": "string",
+            "example": "doggie"
+          },
+          "photoUrls": {
+            "type": "array",
+            "xml": {
+              "name": "photoUrl",
+              "wrapped": true
+            },
+            "items": {
+              "type": "string",
+              "example": "https://example.com/photo.png"
+            }
+          },
+          "tags": {
+            "type": "array",
+            "xml": {
+              "name": "tag",
+              "wrapped": true
+            },
+            "items": {
+              "$ref": "#/components/schemas/Tag"
+            }
+          },
+          "status": {
+            "type": "string",
+            "description": "pet status in the store",
+            "enum": ["available", "pending", "sold"]
+          }
+        },
+        "xml": {
+          "name": "Pet"
+        }
+      },
+      "ApiResponse": {
+        "type": "object",
+        "properties": {
+          "code": {
+            "type": "integer",
+            "format": "int32"
+          },
+          "type": {
+            "type": "string"
+          },
+          "message": {
+            "type": "string"
+          }
+        }
+      }
+    }
+  }
+}

package/test-utils/fetch-mock.ts

@@ -0,0 +1,81 @@
+import DatauriParser from 'datauri/parser'
+import formDataToString from 'formdata-to-string'
+
+function objectifyHeaders(headers: []) {
+  return Object.fromEntries(headers)
+}
+
+export const response = {
+  id: 123,
+  name: 'Buster',
+}
+
+export const responses = {
+  all: (url: string, opts: RequestInit) => {
+    return {
+      uri: new URL(url).pathname,
+      headers: Object.fromEntries(opts.headers as unknown as []),
+      requestBody: opts.body,
+    }
+  },
+
+  datauri: (url: string, opts: RequestInit) => {
+    const buffer = Buffer.from(opts.body as string, 'hex')
+    const parser = new DatauriParser()
+
+    return {
+      uri: new URL(url).pathname,
+      requestBody: parser.format('.png', buffer).content,
+      headers: Object.fromEntries(opts.headers as unknown as []),
+    }
+  },
+
+  delay: (res: Record<string, unknown> | string, delay: number) => {
+    return new Promise(resolve => {
+      setTimeout(() => resolve(res), delay)
+    })
+  },
+
+  headers: (url: string, opts: RequestInit) => {
+    // `opts.headers` returns a `HeadersList` object instead of `Headers` as the typing suggests so
+    // we need to convert it to an array before converting it to an object.
+    return Object.fromEntries(opts.headers as unknown as [])
+  },
+
+  multipart: async (url: string, opts: RequestInit) => {
+    const headers = objectifyHeaders(opts.headers as unknown as [])
+    const payload = await formDataToString(opts.body as FormData)
+
+    return {
+      uri: new URL(url).pathname,
+      requestBody: payload,
+      headers,
+      boundary: payload.split('\r\n')[0],
+    }
+  },
+
+  real: (res: Record<string, unknown> | string) => {
+    return () => res
+  },
+
+  requestBody: () => {
+    return (url: string, opts: RequestInit) => {
+      return {
+        uri: new URL(url).pathname,
+        // eslint-disable-next-line try-catch-failsafe/json-parse
+        requestBody: JSON.parse(opts.body as string),
+      }
+    }
+  },
+
+  searchParams: (url: string) => {
+    const res = new URL(url)
+    return `${res.pathname}${res.search}`
+  },
+
+  url: (prop: keyof URL) => {
+    return (url: string) => {
+      return new URL(url)[prop]
+    }
+  },
+}

package/test-utils/fixtures/hello.jp.txt

@@ -0,0 +1 @@
+速い茶色のキツネは怠惰な犬を飛び越えます

package/test-utils/fixtures/hello.txt

@@ -0,0 +1 @@
+Hello world!

package/test-utils/index.ts

@@ -0,0 +1,2 @@
+export * from './fetch-mock.js'
+export * from './load-spec.js'

package/test-utils/load-spec.ts

@@ -0,0 +1,8 @@
+/**
+ * Because parts of our OpenAPI dereferencer in `oas` can update variable references passed to it
+ * we may need to sometimes fully clone a spec to test something. This is just a small DIY wrapper
+ * for doing so.
+ */
+export function loadSpec(spec: string) {
+  return import(spec).then(({default: data}) => JSON.stringify(data)).then(JSON.parse)
+}

package/test-utils/node_modules/.bin/tsc

@@ -0,0 +1,17 @@
+#!/bin/sh
+basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
+
+case `uname` in
+    *CYGWIN*) basedir=`cygpath -w "$basedir"`;;
+esac
+
+if [ -z "$NODE_PATH" ]; then
+  export NODE_PATH="/home/runner/work/works/works/node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/bin/node_modules:/home/runner/work/works/works/node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/node_modules:/home/runner/work/works/works/node_modules/.pnpm/typescript@5.6.2/node_modules:/home/runner/work/works/works/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="/home/runner/work/works/works/node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/bin/node_modules:/home/runner/work/works/works/node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/node_modules:/home/runner/work/works/works/node_modules/.pnpm/typescript@5.6.2/node_modules:/home/runner/work/works/works/node_modules/.pnpm/node_modules:$NODE_PATH"
+fi
+if [ -x "$basedir/node" ]; then
+  exec "$basedir/node"  "$basedir/../typescript/bin/tsc" "$@"
+else
+  exec node  "$basedir/../typescript/bin/tsc" "$@"
+fi

package/test-utils/node_modules/.bin/tsserver

@@ -0,0 +1,17 @@
+#!/bin/sh
+basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
+
+case `uname` in
+    *CYGWIN*) basedir=`cygpath -w "$basedir"`;;
+esac
+
+if [ -z "$NODE_PATH" ]; then
+  export NODE_PATH="/home/runner/work/works/works/node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/bin/node_modules:/home/runner/work/works/works/node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/node_modules:/home/runner/work/works/works/node_modules/.pnpm/typescript@5.6.2/node_modules:/home/runner/work/works/works/node_modules/.pnpm/node_modules"
+else
+  export NODE_PATH="/home/runner/work/works/works/node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/bin/node_modules:/home/runner/work/works/works/node_modules/.pnpm/typescript@5.6.2/node_modules/typescript/node_modules:/home/runner/work/works/works/node_modules/.pnpm/typescript@5.6.2/node_modules:/home/runner/work/works/works/node_modules/.pnpm/node_modules:$NODE_PATH"
+fi
+if [ -x "$basedir/node" ]; then
+  exec "$basedir/node"  "$basedir/../typescript/bin/tsserver" "$@"
+else
+  exec node  "$basedir/../typescript/bin/tsserver" "$@"
+fi

package/test-utils/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@api/test-utils",
+  "version": "0.1.0",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "lint:types": "tsc --noEmit"
+  },
+  "dependencies": {
+    "caseless": "^0.12.0",
+    "datauri": "^4.1.0",
+    "formdata-to-string": "^2.0.1"
+  },
+  "devDependencies": {
+    "@types/caseless": "0.12.5",
+    "oas": "^24.0.0",
+    "typescript": "5.6.2",
+    "vitest": "2.1.3"
+  }
+}

package/test-utils/sdks/README.md

@@ -0,0 +1,3 @@
+Contained within this directory are real-world generated API SDKs that we use for running unit tests against.
+
+There will be TypeScript (and ESLint) errors in some of these files because modules they load aren't present within this test repository, and OpenAPI definition paths don't line up with where the fixture was, but that's okay!

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

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

@@ -0,0 +1,55 @@
+{
+  "name": "@api/alby",
+  "version": "1.0.14",
+  "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
+  }
+}