api-def 0.12.0-alpha.39 → 0.12.0-alpha.40

package/cjs/tests/validation.test.js

@@ -1,124 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
-    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var zod = require("zod");
-var Api_1 = require("../Api");
-var api = new Api_1.Api({
-    baseUrl: "httpstat.us",
-    name: "Example API",
-    mocking: {
-        enabled: true,
-    },
-});
-var queryReturnEndpoint = api
-    .endpoint()
-    .queryOf(zod.object({
-    test: zod.string(),
-}))
-    .responseOf(zod.object({
-    name: zod.string(),
-    query: zod.object({
-        test: zod.string().refine(function (v) { return !Number.isNaN(Number(v)) && Number(v) < 255; }, "below 255"),
-    }),
-}))
-    .build({
-    name: "Get 200",
-    id: "200",
-    method: "get",
-    path: "/200",
-    mocking: {
-        handler: function (req, res) {
-            return res.status(200).send({ name: "Test", query: req.query });
-        },
-    },
-});
-it("validation", function () { return __awaiter(void 0, void 0, void 0, function () {
-    var res, error, e_1, error, e_2;
-    var _a, _b;
-    return __generator(this, function (_c) {
-        switch (_c.label) {
-            case 0: return [4 /*yield*/, queryReturnEndpoint.submit({
-                    query: {
-                        test: "200",
-                    },
-                })];
-            case 1:
-                res = _c.sent();
-                expect(res.data.query.test).toBe("200");
-                error = void 0;
-                _c.label = 2;
-            case 2:
-                _c.trys.push([2, 4, , 5]);
-                return [4 /*yield*/, queryReturnEndpoint.submit({
-                        query: {
-                            test: {},
-                        },
-                    })];
-            case 3:
-                _c.sent();
-                return [3 /*break*/, 5];
-            case 4:
-                e_1 = _c.sent();
-                error = e_1;
-                return [3 /*break*/, 5];
-            case 5:
-                expect(error.code).toBe("validation/query-validate-error");
-                expect((_a = error.issues) === null || _a === void 0 ? void 0 : _a[0].code).toBe("invalid_type");
-                error = void 0;
-                _c.label = 6;
-            case 6:
-                _c.trys.push([6, 8, , 9]);
-                return [4 /*yield*/, queryReturnEndpoint.submit({
-                        query: {
-                            test: "300",
-                        },
-                    })];
-            case 7:
-                _c.sent();
-                return [3 /*break*/, 9];
-            case 8:
-                e_2 = _c.sent();
-                error = e_2;
-                return [3 /*break*/, 9];
-            case 9:
-                expect(error.code).toBe("validation/response-validate-error");
-                expect((_b = error.issues) === null || _b === void 0 ? void 0 : _b[0].message).toBe("below 255");
-                return [2 /*return*/];
-        }
-    });
-}); });

package/esm/cache/CacheBackend.d.ts

@@ -1,6 +0,0 @@
-export interface CacheBackend {
-    removeItem(key: string): Promise<void>;
-    setItem<T>(key: string, value: T): Promise<void>;
-    getItem<T>(key: string): Promise<T | null>;
-    clear(): Promise<void>;
-}

package/esm/cache/CacheBackend.js

@@ -1 +0,0 @@
-export {};

package/esm/cache/Caching.d.ts

@@ -1,10 +0,0 @@
-import type { CacheBackend } from "./CacheBackend";
-export declare const setCacheBackend: (backend: CacheBackend) => void;
-export declare const DEFAULT_CACHE_EXPIRY: number;
-export declare const clearCache: () => Promise<void>;
-export interface CacheEntry {
-    data: any;
-    expiry: number | null;
-}
-export declare const setCachedItem: <T>(key: string, value: T, expiry?: number) => Promise<T>;
-export declare const getCachedItem: <T = any>(key: string) => Promise<T | undefined>;

package/esm/cache/LocalForageCacheBackend.d.ts

@@ -1,9 +0,0 @@
-import type { CacheBackend } from "./CacheBackend";
-export default class LocalForageCacheBackend implements CacheBackend {
-    private readonly store;
-    constructor(localforage: any);
-    clear(): Promise<void>;
-    getItem<T>(key: string): Promise<T | null>;
-    removeItem(key: string): Promise<void>;
-    setItem<T>(key: string, value: T): Promise<void>;
-}

package/esm/cache/LocalForageCacheBackend.js

@@ -1,19 +0,0 @@
-export default class LocalForageCacheBackend {
-    constructor(localforage) {
-        this.store = localforage.createInstance({
-            name: "requestCache",
-        });
-    }
-    clear() {
-        return this.store.clear();
-    }
-    getItem(key) {
-        return this.store.getItem(key);
-    }
-    removeItem(key) {
-        return this.store.removeItem(key);
-    }
-    setItem(key, value) {
-        return this.store.setItem(key, value);
-    }
-}

package/esm/cache/LocalStorageCacheBackend.d.ts

@@ -1,7 +0,0 @@
-import type { CacheBackend } from "./CacheBackend";
-export default class LocalStorageCacheBackend implements CacheBackend {
-    clear(): Promise<void>;
-    getItem<T>(key: string): Promise<T | null>;
-    removeItem(key: string): Promise<void>;
-    setItem<T>(key: string, value: T): Promise<void>;
-}

package/esm/middleware/CacheMiddleware.d.ts

@@ -1,7 +0,0 @@
-import type { RequestMiddleware } from "../ApiTypes";
-export interface CacheMiddlewareOptions {
-    defaultExpiry?: number;
-    predicate?: () => boolean;
-}
-declare const CacheMiddleware: (options?: CacheMiddlewareOptions) => RequestMiddleware;
-export default CacheMiddleware;

package/esm/tests/api.test.d.ts

@@ -1 +0,0 @@
-export {};

package/esm/tests/api.test.js

@@ -1,108 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import * as qs from "qs";
-import { Api } from "../Api";
-import { RequestMethod } from "../ApiConstants";
-import { postIdVerifStatus } from "./mock/MockApi";
-const api = new Api({
-    baseUrl: "example.com",
-    name: "Example API",
-    mocking: {
-        enabled: true,
-    },
-    middleware: [
-        {
-            beforeSend: (context) => __awaiter(void 0, void 0, void 0, function* () {
-                context.updateQuery({
-                    test: "abc",
-                });
-            }),
-        },
-    ],
-});
-const queryReturnEndpoint = api
-    .endpoint()
-    .queryOf()
-    .build({
-    name: "Fetch Users",
-    id: "fetchUsers",
-    method: RequestMethod.GET,
-    path: "/users",
-    mocking: {
-        handler: (req, res) => {
-            return res.status(200).send([{ name: "Test", query: req.query }]);
-        },
-    },
-});
-it("URL is properly constructed", () => __awaiter(void 0, void 0, void 0, function* () {
-    const res = yield postIdVerifStatus.submit({
-        body: {
-            forceReset: true,
-            validationService: 1,
-        },
-    });
-    expect(res.data.url).toBe("https://example.com/id-verif/verif-status");
-}));
-it("query as string", () => __awaiter(void 0, void 0, void 0, function* () {
-    const res = yield queryReturnEndpoint.submit({
-        query: "test=1&id=3",
-    });
-    expect(res.data).toEqual([
-        {
-            name: "Test",
-            query: {
-                test: "abc",
-                id: "3",
-            },
-        },
-    ]);
-}));
-it("qs", () => __awaiter(void 0, void 0, void 0, function* () {
-    let res = yield queryReturnEndpoint.submit({
-        query: "id[0]=1&id[1]=2",
-    });
-    expect(res.data).toEqual([
-        {
-            name: "Test",
-            query: {
-                test: "abc",
-                "id[0]": "1",
-                "id[1]": "2",
-            },
-        },
-    ]);
-    res = yield queryReturnEndpoint.submit({
-        query: "id[0]=1&id[1]=2",
-        queryHandling: qs,
-    });
-    expect(res.data).toEqual([
-        {
-            name: "Test",
-            query: {
-                test: "abc",
-                id: ["1", "2"],
-            },
-        },
-    ]);
-}));
-/*it("infer params in typescript", async (t) => {
-  const endpoint = mockApi.endpoint()
-    .build({
-      method: "get",
-      id: "test",
-      path: "/test/:id",
-    });
-
-  endpoint.submit({
-    params: {
-      id: "test",
-    },
-  });
-});*/

package/esm/tests/axios.test.d.ts

@@ -1 +0,0 @@
-export {};

package/esm/tests/axios.test.js

@@ -1,51 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import axios from "axios";
-import { Api, setRequestBackend } from "../Api";
-import AxiosRequestBackend from "../backend/AxiosRequestBackend";
-import FetchRequestBackend from "../backend/FetchRequestBackend";
-const cleanResponse = (response) => {
-    response.headers = undefined;
-    response.__lowercaseHeaders = undefined;
-    return response;
-};
-it("request backends output", () => __awaiter(void 0, void 0, void 0, function* () {
-    const api = new Api({
-        baseUrl: "httpstat.us",
-        name: "Example API",
-        requestBackend: new AxiosRequestBackend(axios),
-        middleware: [
-            {
-                beforeSend: (context) => __awaiter(void 0, void 0, void 0, function* () {
-                    context.updateQuery({
-                        id: "abc",
-                    });
-                }),
-            },
-        ],
-    });
-    const fetchPage = api.endpoint().queryOf().build({
-        name: "Get 200",
-        id: "200",
-        method: "get",
-        path: "/200",
-    });
-    expect(fetchPage.name).toBe("Get 200");
-    setRequestBackend(new FetchRequestBackend());
-    const fetchResult = yield fetchPage.submit({
-        query: "test",
-    });
-    setRequestBackend(new AxiosRequestBackend(axios));
-    const axiosResult = yield fetchPage.submit({
-        query: "test",
-    });
-    expect(cleanResponse(fetchResult)).toEqual(cleanResponse(axiosResult));
-    expect(fetchResult.url).toBe("https://httpstat.us/200?test=true&id=abc");
-}));

package/esm/tests/backend.test.d.ts

@@ -1 +0,0 @@
-export {};

package/esm/tests/backend.test.js

@@ -1,49 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import axios from "axios";
-import { Api, setRequestBackend } from "../Api";
-import AxiosRequestBackend from "../backend/AxiosRequestBackend";
-import FetchRequestBackend from "../backend/FetchRequestBackend";
-const cleanResponse = (response) => {
-    response.headers = undefined;
-    response.__lowercaseHeaders = undefined;
-    return response;
-};
-it("request backends output", () => __awaiter(void 0, void 0, void 0, function* () {
-    const api = new Api({
-        baseUrl: "httpstat.us",
-        name: "Example API",
-        middleware: [
-            {
-                beforeSend: (context) => __awaiter(void 0, void 0, void 0, function* () {
-                    context.updateQuery({
-                        id: "abc",
-                    });
-                }),
-            },
-        ],
-    });
-    const fetchPage = api.endpoint().queryOf().build({
-        name: "Get 200",
-        id: "200",
-        method: "get",
-        path: "/200",
-    });
-    setRequestBackend(new FetchRequestBackend());
-    const fetchResult = yield fetchPage.submit({
-        query: "test",
-    });
-    setRequestBackend(new AxiosRequestBackend(axios));
-    const axiosResult = yield fetchPage.submit({
-        query: "test",
-    });
-    expect(cleanResponse(fetchResult)).toEqual(cleanResponse(axiosResult));
-    expect(fetchResult.url).toBe("https://httpstat.us/200?test=true&id=abc");
-}));

package/esm/tests/bodyTypes.test.d.ts

@@ -1 +0,0 @@
-export {};

package/esm/tests/bodyTypes.test.js

@@ -1,21 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import { postFormUrlEncoded } from "./mock/MockApi";
-it("correctly parses body for form url encoded request", () => __awaiter(void 0, void 0, void 0, function* () {
-    const res = yield postFormUrlEncoded.submit({
-        body: {
-            test: 123,
-            b: "test",
-        },
-    });
-    expect(res.data).toEqual(["test=123&b=test"]);
-}));
-// @ts-expect-error
-const a = { data: 123 };

package/esm/tests/mock/MockApi.d.ts

@@ -1,16 +0,0 @@
-import { Api } from "../../Api";
-declare const api: Api;
-export declare const fetchRequiresToken: import("../..").Endpoint<unknown, undefined, undefined, undefined, import("../..").State, "/requires-token", import("../..").RawHeaders | undefined, import("../..").RawHeaders | undefined>;
-export declare const postFormUrlEncoded: import("../..").Endpoint<string[], undefined, undefined, {
-    test: number;
-    b: string;
-}, import("../..").State, "/send-data", import("../..").RawHeaders | undefined, import("../..").RawHeaders | undefined>;
-export declare const postIdVerifStatus: import("../..").Endpoint<{
-    transactionStatus: any;
-    transactionId?: string;
-    verifPayload?: any;
-}, undefined, undefined, {
-    validationService: 1;
-    forceReset: boolean;
-}, import("../..").State, "/id-verif/verif-status", import("../..").RawHeaders | undefined, import("../..").RawHeaders | undefined>;
-export default api;

package/esm/tests/mock/MockApi.js

@@ -1,64 +0,0 @@
-import { Api } from "../../Api";
-import { RequestMethod } from "../../ApiConstants";
-const api = new Api({
-    baseUrl: "example.com",
-    name: "Example API",
-    mocking: {
-        enabled: true,
-    },
-});
-export const fetchRequiresToken = api.endpoint().build({
-    name: "Requires Token",
-    id: "fetchRequiresToken",
-    method: RequestMethod.GET,
-    path: "/requires-token",
-    mocking: {
-        handler: (req, res) => {
-            if (!req.headers.token) {
-                return res.status(400).send({
-                    code: "auth/invalid-token",
-                });
-            }
-            return res.status(200).send({ hello: true });
-        },
-    },
-});
-export const postFormUrlEncoded = api
-    .endpoint()
-    .bodyOf()
-    .responseOf()
-    .build({
-    id: "sendFormUrlEncoded",
-    method: "post",
-    path: "/send-data",
-    config: {
-        headers: {
-            "Content-type": "application/x-www-form-urlencoded",
-        },
-    },
-    mocking: {
-        handler: (req, res) => {
-            return res.status(200).send([req.body.toString()]);
-        },
-    },
-});
-export const postIdVerifStatus = api
-    .endpoint()
-    .bodyOf()
-    .responseOf()
-    .build({
-    id: "id-verif-status",
-    method: RequestMethod.POST,
-    path: "/id-verif/verif-status",
-    responseType: "json",
-    config: {
-        acceptableStatus: [200],
-        retry: false, // outcome screen has it's own retry
-    },
-    mocking: {
-        handler: (req, res) => {
-            return res.status(200).send({ url: req.url });
-        },
-    },
-});
-export default api;

package/esm/tests/params.test.d.ts

@@ -1 +0,0 @@
-export {};

package/esm/tests/params.test.js

@@ -1,88 +0,0 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-import { Api } from "../Api";
-import { RequestMethod } from "../ApiConstants";
-const api = new Api({
-    baseUrl: "example.com",
-    name: "Example API",
-    mocking: {
-        enabled: true,
-    },
-    middleware: [
-        {
-            beforeSend: (context) => __awaiter(void 0, void 0, void 0, function* () {
-                context.updateQuery({
-                    test: "abc",
-                });
-            }),
-        },
-    ],
-});
-const withColons = api
-    .endpoint()
-    .paramsOf()
-    .build({
-    name: "Fetch Users",
-    id: "fetchUsers",
-    method: RequestMethod.GET,
-    path: "/users/:id/:sub_id",
-    mocking: {
-        handler: (req, res) => {
-            return res.status(200).send([{ name: "Test", data: req.url }]);
-        },
-    },
-});
-const withBrackets = api
-    .endpoint()
-    .paramsOf()
-    .build({
-    name: "Fetch Users",
-    id: "fetchUsers",
-    method: RequestMethod.GET,
-    path: "/users/{id}/{sub_id}",
-    mocking: {
-        handler: (req, res) => {
-            return res.status(200).send([{ name: "Test", data: req.url }]);
-        },
-    },
-});
-it("should throw error if missing param", () => __awaiter(void 0, void 0, void 0, function* () {
-    yield expect((() => __awaiter(void 0, void 0, void 0, function* () {
-        const res = yield withColons.submit({
-            params: {
-                id: "123",
-            },
-        });
-        return res;
-    }))()).rejects.toThrowError("[api-def] Not all path params have been resolved: '/users/123/:sub_id'");
-    yield expect((() => __awaiter(void 0, void 0, void 0, function* () {
-        const res = yield withBrackets.submit({
-            params: {
-                id: "123",
-            },
-        });
-        return res;
-    }))()).rejects.toThrowError("[api-def] Not all path params have been resolved: '/users/123/{sub_id}'");
-    // This should not throw an error
-    const res = yield withColons.submit({
-        params: {
-            id: "123",
-            sub_id: "456",
-        },
-    });
-    expect(res.data).toEqual([{ name: "Test", data: "https://example.com/users/123/456" }]);
-    const res2 = yield withBrackets.submit({
-        params: {
-            id: "123",
-            sub_id: "456",
-        },
-    });
-    expect(res2.data).toEqual([{ name: "Test", data: "https://example.com/users/123/456" }]);
-}));

package/esm/tests/retry.test.d.ts

@@ -1 +0,0 @@
-export {};