@autometa/http 1.4.20 → 2.0.0-rc.0

package/dist/types.d.ts

@@ -0,0 +1,39 @@
+import type { HTTPRequest } from "./http-request";
+import type { HTTPResponse } from "./http-response";
+type Enumerate<N extends number, Acc extends number[] = []> = Acc["length"] extends N ? Acc[number] : Enumerate<N, [...Acc, Acc["length"]]>;
+type IntRange<From extends number, To extends number> = Exclude<Enumerate<To>, Enumerate<From>> | From;
+export type HTTPMethod = "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "OPTIONS" | "TRACE" | "CONNECT";
+export type HTTPAdditionalOptions<T = Record<string, unknown>> = Partial<T> & Record<string, unknown>;
+export type SchemaParser = {
+    parse: (data: unknown) => unknown;
+} | {
+    validate: (data: unknown) => unknown;
+} | ((data: unknown) => unknown);
+export type StatusCode = IntRange<100, 600>;
+export type RequestHook = <T = unknown>(state: HTTPRequest<T>) => unknown;
+export type ResponseHook<T> = (state: HTTPResponse<T>) => unknown;
+export interface HTTPRetryContext {
+    error: unknown;
+    attempt: number;
+    request: HTTPRequest<unknown>;
+    response?: HTTPResponse<unknown>;
+}
+export type HTTPRetryPredicate = (context: HTTPRetryContext) => boolean | Promise<boolean>;
+export interface HTTPRetryOptions {
+    attempts: number;
+    delay?: number | ((attempt: number) => number | Promise<number>);
+    retryOn?: HTTPRetryPredicate;
+}
+export type QueryParamPrimitive = string | number | boolean | null | undefined;
+export type QueryParamValue = QueryParamPrimitive | QueryParamValue[] | {
+    [key: string]: QueryParamValue;
+};
+export type QueryParamSerializer = (params: Record<string, QueryParamValue>) => string;
+export type QueryParamArrayFormat = "repeat" | "brackets" | "indices" | "comma" | "json";
+export type QueryParamObjectFormat = "brackets" | "dot" | "json";
+export interface QueryParamSerializationOptions {
+    arrayFormat?: QueryParamArrayFormat;
+    objectFormat?: QueryParamObjectFormat;
+    serializer?: QueryParamSerializer | null;
+}
+export {};

package/package.json

@@ -1,57 +1,57 @@
 {
   "name": "@autometa/http",
-  "version": "1.4.20",
-  "description": "An Axios Based HTTP Client for Autometa",
+  "version": "2.0.0-rc.0",
+  "description": "",
   "type": "module",
-  "main": "dist/index.js",
-  "module": "dist/esm/index.js",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
   "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
   "exports": {
-    "import": "./dist/esm/index.js",
-    "require": "./dist/index.js",
-    "default": "./dist/esm/index.js",
+    "import": "./dist/index.js",
+    "require": "./dist/index.cjs",
+    "default": "./dist/index.js",
     "types": "./dist/index.d.ts"
   },
   "license": "MIT",
+  "dependencies": {
+    "cli-highlight": "^2.1.11",
+    "url-join-ts": "^1.0.5",
+    "@autometa/assertions": "1.0.0-rc.0",
+    "@autometa/errors": "1.0.0-rc.0",
+    "@autometa/status-codes": "1.0.0-rc.0"
+  },
   "devDependencies": {
     "@types/node": "^18.11.18",
-    "@types/uuid": "^9.0.1",
     "@typescript-eslint/eslint-plugin": "^5.54.1",
     "@typescript-eslint/parser": "^5.54.1",
-    "@vitest/coverage-v8": "^1.4.0",
     "eslint": "^8.37.0",
     "eslint-config-prettier": "^8.3.0",
-    "myzod": "^1.10.2",
     "rimraf": "^4.1.2",
     "tsup": "^7.2.0",
     "typescript": "^4.9.5",
     "vitest": "1.4.0",
-    "@autometa/types": "^0.4.1",
     "eslint-config-custom": "0.6.0",
-    "tsconfig": "0.7.0"
-  },
-  "dependencies": {
-    "@stdlib/assert-is-json": "^0.1.1",
-    "@types/qs": "^6.9.11",
-    "axios": "^1.5.1",
-    "class-transformer": "^0.5.1",
-    "cli-highlight": "^2.1.11",
-    "reflect-metadata": "^0.1.13",
-    "ts-retry": "^4.2.3",
-    "url-join-ts": "^1.0.5",
-    "@autometa/app": "^0.4.2",
-    "@autometa/dto-builder": "^0.13.11",
-    "@autometa/errors": "^0.2.2",
-    "@autometa/injection": "^0.1.5",
-    "@autometa/status-codes": "^0.4.1"
+    "tsconfig": "0.7.0",
+    "tsup-config": "0.1.0"
   },
   "scripts": {
+    "type-check": "tsc --noEmit -p tsconfig.dev.json",
+    "type-check:watch": "tsc --noEmit --watch -p tsconfig.dev.json",
+    "build": "tsup && pnpm run build:types",
+    "build:types": "rimraf tsconfig.types.tsbuildinfo && tsc --build tsconfig.types.json",
+    "build:watch": "tsup --watch",
+    "dev": "tsup --watch",
     "test": "vitest run --passWithNoTests",
-    "prettify": "prettier --config .prettierrc 'src/**/*.ts' --write",
+    "test:watch": "vitest --passWithNoTests",
+    "test:ui": "vitest --ui --passWithNoTests",
+    "test:integration": "vitest run --config vitest.integration.config.ts --passWithNoTests",
+    "coverage": "vitest run --coverage --passWithNoTests",
     "lint": "eslint . --max-warnings 0",
     "lint:fix": "eslint . --fix",
-    "clean": "rimraf dist",
-    "build": "tsup",
-    "build:watch": "tsup --watch"
+    "prettify": "prettier --config .prettierrc 'src/**/*.ts' --write",
+    "clean": "rimraf dist"
   }
 }

package/.eslintignore

@@ -1,3 +0,0 @@
-/dist
-/out
-node_modules

package/.eslintrc.cjs

@@ -1,4 +0,0 @@
-module.exports = {
-  root: true,
-  extends: ["custom"],
-};

package/.turbo/turbo-lint$colon$fix.log

@@ -1,4 +0,0 @@
-
-> @autometa/http@1.4.15 lint:fix /Users/ben.aherne/Documents/GitHub/autometa/packages/http
-> eslint . --fix "--max-warnings=0"
-

package/.turbo/turbo-prettify.log

@@ -1,5 +0,0 @@
-
-> @autometa/http@1.4.13 prettify /Users/ben.aherne/Documents/GitHub/autometa/packages/http
-> prettier --config .prettierrc 'src/**/*.ts' --write
-
- ELIFECYCLE  Command failed.

package/.turbo/turbo-test.log

@@ -1,120 +0,0 @@
-
-> @autometa/http@1.4.17 test /Users/ben.aherne/Documents/GitHub/autometa/packages/http
-> vitest run --passWithNoTests
-
-
- RUN  v1.4.0 /Users/ben.aherne/Documents/GitHub/autometa/packages/http
-
- ✓ src/schema.map.spec.ts  (5 tests) 3ms
- ✓ src/default-client-factory.other.spec.ts  (1 test) 2ms
- ✓ src/request-meta.config.spec.ts  (8 tests) 5ms
- ✓ src/http-request.spec.ts  (11 tests) 4ms
- ✓ src/default-schema.spec.ts  (13 tests) 4ms
- ✓ src/default-client-factory.axios.spec.ts  (1 test) 2ms
-stdout | src/http.spec.ts > HTTP > resolving dynamic headers > should resolve dynamic headers
-HTTPRequest {
-  headers: { foo: 'bar' },
-  params: {},
-  route: [],
-  baseUrl: undefined,
-  method: 'GET',
-  data: undefined
-}
-
-stdout | src/http.spec.ts > HTTP > allowPlainText > should throw an error when allowPlainText is false
-HTTPRequest {
-  headers: {},
-  params: {},
-  route: [],
-  baseUrl: undefined,
-  method: 'GET',
-  data: undefined
-}
-
-stdout | src/http.spec.ts > HTTP > allowPlainText > should return the response when allowPlainText is true
-HTTPRequest {
-  headers: {},
-  params: {},
-  route: [],
-  baseUrl: undefined,
-  method: 'GET',
-  data: undefined
-}
-
-stdout | src/http.spec.ts > HTTP > hooks > onSend > should call the hook when the request is sent
-HTTPRequest {
-  headers: {},
-  params: {},
-  route: [],
-  baseUrl: undefined,
-  method: 'GET',
-  data: undefined
-}
-
-stdout | src/http.spec.ts > HTTP > hooks > onReceive > should call the hook when the response is received
-HTTPRequest {
-  headers: {},
-  params: {},
-  route: [],
-  baseUrl: undefined,
-  method: 'GET',
-  data: undefined
-}
-
-stdout | src/http.spec.ts > HTTP > hooks > onReceive > should propagate errors from the hook
-HTTPRequest {
-  headers: {},
-  params: {},
-  route: [],
-  baseUrl: undefined,
-  method: 'GET',
-  data: undefined
-}
-
-stdout | src/http.spec.ts > HTTP > schemas > should throw an error if there is no schema and requireSchema is true
-HTTPRequest {
-  headers: {},
-  params: {},
-  route: [],
-  baseUrl: undefined,
-  method: 'GET',
-  data: undefined
-}
-
-stdout | src/http.spec.ts > HTTP > schemas > should throw an error if the response status does not match a schema
-HTTPRequest {
-  headers: {},
-  params: {},
-  route: [],
-  baseUrl: undefined,
-  method: 'GET',
-  data: undefined
-}
-
-stdout | src/http.spec.ts > HTTP > schemas > should return the response if the status matches a schema
-HTTPRequest {
-  headers: {},
-  params: {},
-  route: [],
-  baseUrl: undefined,
-  method: 'GET',
-  data: undefined
-}
-
-stdout | src/http.spec.ts > HTTP > schemas > should return the validated response if the status matches a schema
-HTTPRequest {
-  headers: {},
-  params: {},
-  route: [],
-  baseUrl: undefined,
-  method: 'GET',
-  data: undefined
-}
-
- ✓ src/http.spec.ts  (13 tests) 35ms
-
- Test Files  7 passed (7)
-      Tests  52 passed (52)
-   Start at  13:56:48
-   Duration  5.28s (transform 2.17s, setup 169ms, collect 5.60s, tests 55ms, environment 7ms, prepare 4.76s)
-

package/CHANGELOG.md

@@ -1,335 +0,0 @@
-# @autometa/http
-
-## 1.4.20
-
-### Patch Changes
-
-- Updated dependencies [8df323c]
-  - @autometa/injection@0.1.5
-  - @autometa/dto-builder@0.13.11
-  - @autometa/app@0.4.2
-
-## 1.4.19
-
-### Patch Changes
-
-- Updated dependencies [da669a3]
-  - @autometa/injection@0.1.4
-  - @autometa/app@0.4.1
-  - @autometa/dto-builder@0.13.10
-
-## 1.4.18
-
-### Patch Changes
-
-- Updated dependencies [7440e9f]
-  - @autometa/app@0.4.0
-
-## 1.4.17
-
-### Patch Changes
-
-- Updated dependencies [1d3f84e]
-  - @autometa/app@0.3.5
-
-## 1.4.16
-
-### Patch Changes
-
-- f60af5c: fix(http): dynamic headers could not be replaced with static headers
-
-## 1.4.15
-
-### Patch Changes
-
-- fdc17af: fix: params setter only accept string values
-
-## 1.4.14
-
-### Patch Changes
-
-- d759d5c: fix: value.replace is not a function when allowPlainText is false
-
-## 1.4.13
-
-### Patch Changes
-
-- Updated dependencies [603d0d0]
-  - @autometa/dto-builder@0.13.9
-
-## 1.4.12
-
-### Patch Changes
-
-- 0a250f4: regression
-
-## 1.4.11
-
-### Patch Changes
-
-- b579743: fix(http): options not derived
-
-## 1.4.10
-
-### Patch Changes
-
-- dbc0eda: feat(http): allow client options to be created with `sharedOptions`
-
-## 1.4.9
-
-### Patch Changes
-
-- 2aee2a4: fix(http): spread and array parameters not passed correctly
-- 2aee2a4: fix(http): spread and array parameters not passed correctly
-- Updated dependencies [2aee2a4]
-  - @autometa/injection@0.1.3
-  - @autometa/dto-builder@0.13.8
-  - @autometa/app@0.3.4
-
-## 1.4.8
-
-### Patch Changes
-
-- 536004e: fix: injection errors and http client hooks
-
-  - The new dependency injection library sometimes returned class prototypes instead of class instances due to inconsistent caching of decorated types.
-  - HTTP client hooks were not executing when certain builder methods were called.
-
-- Updated dependencies [536004e]
-- Updated dependencies [bac2661]
-  - @autometa/dto-builder@0.13.7
-  - @autometa/injection@0.1.2
-  - @autometa/app@0.3.3
-
-## 1.4.7
-
-### Patch Changes
-
-- cccedea: fix(http): dynamic headers not deriving and resolving correctly
-- Updated dependencies [cccedea]
-  - @autometa/dto-builder@0.13.6
-
-## 1.4.6
-
-### Patch Changes
-
-- Updated dependencies [db87a56]
-  - @autometa/dto-builder@0.13.5
-
-## 1.4.5
-
-### Patch Changes
-
-- Updated dependencies [ae7e34f]
-  - @autometa/dto-builder@0.13.4
-
-## 1.4.4
-
-### Patch Changes
-
-- Updated dependencies
-  - @autometa/dto-builder@0.13.3
-
-## 1.4.3
-
-### Patch Changes
-
-- Updated dependencies
-  - @autometa/dto-builder@0.13.2
-
-## 1.4.2
-
-### Patch Changes
-
-- Updated dependencies [95512a3]
-  - @autometa/dto-builder@0.13.1
-
-## 1.4.1
-
-### Patch Changes
-
-- 16634f7: fix(HTTP): dynamic headers not passable nor resolving
-
-## 1.4.0
-
-### Minor Changes
-
-- 7e9d2bc: feat: Table Documents
-
-  Introduces a new way of handling tables which are horizontal (HTable) or vertical (VTable) which maps
-  the headers of a table to an object properties, defined using a class.
-
-  [docs](https://bendat.github.io/autometa/docs/cucumber/test_runner/datatables#table-documents)
-
-### Patch Changes
-
-- Updated dependencies [7e9d2bc]
-  - @autometa/dto-builder@0.13.0
-
-## 1.3.0
-
-### Minor Changes
-
-- 82168a2: fix: `onRecievedResponse` hook not running when response failed schema validation
-
-  - Renamed hooks to `onSend` and `onRecieve`
-  - Rewrote HTTP fixture logic to be constructable and derivable.
-    - `new HTTP().sharedRoute('v1')` constructs a single instance of HTTP with route `v1`
-    - `new HTTP().sharedRoute('v1').route('user') derives a new HTTP fixture which inherits 'v1' and adds 'user' locally.
-  - Support for list based params with `paramList` and `sharedParamList`
-  - Added default schemas for use with simple response types like null, boolean, number etc
-
-### Patch Changes
-
-- Updated dependencies [d563916]
-  - @autometa/dto-builder@0.12.0
-  - @autometa/injection@0.1.1
-  - @autometa/app@0.3.2
-
-## 1.2.1
-
-### Patch Changes
-
-- Updated dependencies [6c4bb8d]
-  - @autometa/app@0.3.1
-
-## 1.2.0
-
-### Minor Changes
-
-- 98d911f: feat: replace tsyringe with custom DI solution
-
-### Patch Changes
-
-- Updated dependencies [98d911f]
-  - @autometa/injection@0.1.0
-  - @autometa/app@0.3.0
-
-## 1.1.0
-
-### Minor Changes
-
-- 4bbe6fc: feat: support factory function for shared headers
-
-## 1.0.14
-
-### Patch Changes
-
-- Updated dependencies [3fe2ad4]
-  - @autometa/errors@0.2.2
-  - @autometa/app@0.2.4
-
-## 1.0.13
-
-### Patch Changes
-
-- Updated dependencies [3493bb6]
-  - @autometa/errors@0.2.1
-  - @autometa/app@0.2.3
-
-## 1.0.12
-
-### Patch Changes
-
-- Updated dependencies [8ec0cdc]
-  - @autometa/app@0.2.2
-
-## 1.0.11
-
-### Patch Changes
-
-- @autometa/app@0.2.1
-
-## 1.0.10
-
-### Patch Changes
-
-- Updated dependencies [b5ce008]
-- Updated dependencies [8f116d9]
-  - @autometa/errors@0.2.0
-  - @autometa/app@0.2.0
-
-## 1.0.9
-
-### Patch Changes
-
-- a7b715a: fix: return empty string bodies without allowPlainText
-
-## 1.0.8
-
-### Patch Changes
-
-- 3390c77: fix: RequestState uses objects instead of maps
-
-## 1.0.7
-
-### Patch Changes
-
-- b992a2b: fix: HTTPResponse should be exported
-
-## 1.0.6
-
-### Patch Changes
-
-- 469f0cb: refactor: http client refactor
-
-## 1.0.5
-
-### Patch Changes
-
-- 3a8b32f: fix: improper handling of strings when parsing
-
-## 1.0.4
-
-### Patch Changes
-
-- 79a672d: fix: JSON.parse responses
-
-## 1.0.3
-
-### Patch Changes
-
-- ef91448: fix: http client return undefined
-
-## 1.0.2
-
-### Patch Changes
-
-- 9870641: fix: allow empty plaintext response without flagging it
-
-## 1.0.1
-
-### Patch Changes
-
-- e9a8dc8: fix: parsing numbers from raw response string
-
-## 1.0.0
-
-### Major Changes
-
-- c7b973f: fix: onRecieve hooks not executing if schema validation fails
-
-## 0.1.2
-
-### Patch Changes
-
-- 815b324: Fix: incorrectly imported cli-highlight package
-
-## 0.1.1
-
-### Patch Changes
-
-- 2ec3670: fix: http client accepts any input and converts it to a string
-
-## 0.1.0
-
-### Minor Changes
-
-- 04ed85d: feat: added HTP client based on axios
-
-### Patch Changes
-
-- Updated dependencies [04ed85d]
-  - @autometa/status-codes@0.4.1
-  - @autometa/errors@0.1.4
-  - @autometa/app@0.1.13