@readme/api-core 7.0.0-alpha.5 → 7.0.0-beta.0

package/dist/lib/index.d.ts

@@ -0,0 +1,62 @@
+export { FromSchema } from 'json-schema-to-ts';
+import { SchemaWrapper } from 'oas/operation/get-parameters-as-json-schema';
+import Operation from 'oas/operation';
+import Oas from 'oas';
+
+/**
+ * Run through a JSON Schema object and compose up an object containing default data for any schema
+ * property that is required and also has a defined default.
+ *
+ * Code partially adapted from the `json-schema-default` package but modified to only return
+ * defaults of required properties.
+ *
+ * @todo This is a good candidate to be moved into a core `oas` library method.
+ * @see {@link https://github.com/mdornseif/json-schema-default}
+ */
+declare function getJSONSchemaDefaults(jsonSchemas: SchemaWrapper[]): {
+    [x: string]: Record<string, unknown>;
+};
+
+declare function parseResponse<HTTPStatus extends number = number>(response: Response): Promise<{
+    data: any;
+    status: HTTPStatus;
+    headers: Headers;
+    res: Response;
+}>;
+
+declare function prepareAuth(authKey: (number | string)[], operation: Operation): Record<string, string | number | {
+    pass: string | number;
+    user: string | number;
+}>;
+
+/**
+ * With potentially supplied body and/or metadata we need to run through them against a given API
+ * operation to see what's what and prepare any available parameters to be used in an API request
+ * with `@readme/oas-to-har`.
+ *
+ */
+declare function prepareParams(operation: Operation, body?: unknown, metadata?: Record<string, unknown>): Promise<{
+    body?: any;
+    cookie?: Record<string, string | number | boolean> | undefined;
+    files?: Record<string, Buffer> | undefined;
+    formData?: any;
+    header?: Record<string, string | number | boolean> | undefined;
+    path?: Record<string, string | number | boolean> | undefined;
+    query?: Record<string, string | number | boolean> | undefined;
+    server?: {
+        selected: number;
+        variables: Record<string, string | number>;
+    } | undefined;
+}>;
+
+/**
+ * With an SDK server config and an instance of OAS we should extract and prepare the server and
+ * any server variables to be supplied to `@readme/oas-to-har`.
+ *
+ */
+declare function prepareServer(spec: Oas, url: string, variables?: Record<string, string | number>): false | {
+    selected: number;
+    variables: Record<string, string | number>;
+};
+
+export { getJSONSchemaDefaults, parseResponse, prepareAuth, prepareParams, prepareServer };

package/dist/lib/index.js

@@ -0,0 +1,15 @@
+import {
+  getJSONSchemaDefaults,
+  parseResponse,
+  prepareAuth,
+  prepareParams,
+  prepareServer
+} from "../chunk-PWY7T36C.js";
+export {
+  getJSONSchemaDefaults,
+  parseResponse,
+  prepareAuth,
+  prepareParams,
+  prepareServer
+};
+//# sourceMappingURL=index.js.map

package/dist/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@readme/api-core",
-  "version": "7.0.0-alpha.5",
+  "version": "7.0.0-beta.0",
   "description": "The magic behind `api` 🧙",
   "sideEffects": false,
   "type": "module",
@@ -13,6 +13,10 @@
       "require": "./dist/errors/fetchError.cjs",
       "import": "./dist/errors/fetchError.js"
     },
+    "./lib": {
+      "require": "./dist/lib/index.cjs",
+      "import": "./dist/lib/index.js"
+    },
     "./package.json": "./package.json"
   },
   "main": "dist/index.cjs",
@@ -45,14 +49,15 @@
     "caseless": "^0.12.0",
     "datauri": "^4.1.0",
     "fetch-har": "^11.0.1",
-    "get-stream": "^6.0.1",
+    "get-stream": "^8.0.1",
+    "json-schema-to-ts": "^2.9.2",
     "json-schema-traverse": "^1.0.0",
     "lodash.merge": "^4.6.2",
     "oas": "^23.0.0",
     "remove-undefined-objects": "^5.0.0"
   },
   "devDependencies": {
-    "@api/test-utils": "^7.0.0-alpha.5",
+    "@api/test-utils": "^7.0.0-beta.0",
     "@readme/oas-examples": "^5.12.0",
     "@types/caseless": "^0.12.3",
     "@types/lodash.merge": "^4.6.7",
@@ -62,5 +67,5 @@
     "vitest": "^0.34.5"
   },
   "prettier": "@readme/eslint-config/prettier",
-  "gitHead": "b1e705dddedd223f360f1dfe620ae721f54af88b"
+  "gitHead": "6ea3f3468343cea16536dda9460d8f0c65fa35c8"
 }

package/src/index.ts

@@ -1,10 +1,10 @@
 import type { Har } from 'har-format';
-import type Oas from 'oas';
 import type Operation from 'oas/operation';
-import type { HttpMethods } from 'oas/rmoas.types';
+import type { HttpMethods, OASDocument } from 'oas/rmoas.types';
 
 import oasToHar from '@readme/oas-to-har';
 import fetchHar from 'fetch-har';
+import Oas from 'oas';
 
 import FetchError from './errors/fetchError.js';
 import { parseResponse, prepareAuth, prepareParams, prepareServer } from './lib/index.js';
@@ -47,8 +47,8 @@ export default class APICore {
 
   private userAgent!: string;
 
-  constructor(spec?: Oas, userAgent?: string) {
-    if (spec) this.spec = spec;
+  constructor(definition?: Record<string, unknown> | OASDocument, userAgent?: string) {
+    if (definition) this.spec = Oas.init(definition);
     if (userAgent) this.userAgent = userAgent;
   }
 

package/src/lib/index.ts

@@ -1,7 +1,9 @@
+import type { FromSchema } from 'json-schema-to-ts';
+
 import getJSONSchemaDefaults from './getJSONSchemaDefaults.js';
 import parseResponse from './parseResponse.js';
 import prepareAuth from './prepareAuth.js';
 import prepareParams from './prepareParams.js';
 import prepareServer from './prepareServer.js';
 
-export { getJSONSchemaDefaults, parseResponse, prepareAuth, prepareParams, prepareServer };
+export { FromSchema, getJSONSchemaDefaults, parseResponse, prepareAuth, prepareParams, prepareServer };

package/src/lib/prepareParams.ts

@@ -9,7 +9,7 @@ import stream from 'node:stream';
 import caseless from 'caseless';
 import DatauriParser from 'datauri/parser.js';
 import datauri from 'datauri/sync.js';
-import getStream from 'get-stream';
+import { getStreamAsBuffer } from 'get-stream';
 import lodashMerge from 'lodash.merge';
 import removeUndefinedObjects from 'remove-undefined-objects';
 
@@ -111,7 +111,7 @@ function processFile(
       });
     });
   } else if (file instanceof stream.Readable) {
-    return getStream.buffer(file).then(buffer => {
+    return getStreamAsBuffer(file).then(buffer => {
       const filePath = file.path as string;
       const parser = new DatauriParser();
       const base64 = parser.format(filePath, buffer).content;

package/tsup.config.ts

@@ -1,6 +1,6 @@
+/* eslint-disable import/no-extraneous-dependencies, node/no-extraneous-import */
 import type { Options } from 'tsup';
 
-// eslint-disable-next-line import/no-extraneous-dependencies
 import { defineConfig } from 'tsup';
 
 // eslint-disable-next-line import/no-relative-packages
@@ -10,6 +10,6 @@ export default defineConfig((options: Options) => ({
   ...options,
   ...config,
 
-  entry: ['src/errors/fetchError.ts', 'src/index.ts'],
+  entry: ['src/errors/fetchError.ts', 'src/lib/index.ts', 'src/index.ts'],
   silent: !options.watch,
 }));