@mintlify/http-client 0.0.2 → 0.0.4

package/README.md

@@ -1,4 +1,16 @@
-# @mintlify/htt-clients
+# @mintlify/http-clients
 
-Reusable Mintlify http clients. See [mintlify](../mintlify/README.md) for more documentation.
+Reusable Mintlify http clients [npm package](https://www.npmjs.com/package/@mintlify/http-client). See [mintlify](../../README.md) for more documentation.
 
+## Installation
+
+```
+npm install @mintlify-http-client
+```
+
+## Usage
+
+```ts
+const client = getLeavesClient(subdomain);
+navPromise = client.getNavigation();
+```

package/dist/client/baseClient.js

@@ -1,154 +1,70 @@
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-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;
-    return g = { next: verb(0), "throw": verb(1), "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 };
-    }
-};
 import { handleJson, handleText } from './clientError';
 /**
  * BaseClient serves as the base class for API clients.
  * Provides basic functionalities for making HTTP requests to a server.
  */
-var BaseClient = /** @class */ (function () {
+export class BaseClient {
     /**
      * @param host - The server's address.
      * @param reqInit - Optional default request initializer.
      */
-    function BaseClient(host, reqInit) {
-        if (reqInit === void 0) { reqInit = undefined; }
+    constructor(host, reqInit = undefined) {
         this.host = host;
         this.reqInit = reqInit;
     }
-    BaseClient.prototype.fetch = function (path, query, init) {
-        var _a;
-        return __awaiter(this, void 0, void 0, function () {
-            var req, uri;
-            var _b;
-            return __generator(this, function (_c) {
-                switch (_c.label) {
-                    case 0:
-                        req = __assign(__assign(__assign({}, this.reqInit), init), { headers: __assign(__assign({}, (_a = this.reqInit) === null || _a === void 0 ? void 0 : _a.headers), init === null || init === void 0 ? void 0 : init.headers) });
-                        uri = this.getUri(path);
-                        uri = query ? "".concat(uri, "?").concat(new URLSearchParams(query)) : uri;
-                        _b = { uri: uri };
-                        return [4 /*yield*/, fetch(uri, req)];
-                    case 1: return [2 /*return*/, (_b.res = _c.sent(), _b.req = req, _b)];
-                }
-            });
-        });
-    };
-    BaseClient.prototype.get = function (path, query, init) {
+    async fetch(path, query, init) {
+        const req = {
+            ...this.reqInit,
+            ...init,
+            headers: {
+                ...this.reqInit?.headers,
+                ...init?.headers,
+            },
+        };
+        let uri = this.getUri(path);
+        uri = query ? `${uri}?${new URLSearchParams(query)}` : uri;
+        return { uri, res: await fetch(uri, req), req };
+    }
+    get(path, query, init) {
         return this.method('get', path, query, init);
-    };
-    BaseClient.prototype.put = function (path, query, init) {
+    }
+    put(path, query, init) {
         return this.method('put', path, query, init);
-    };
-    BaseClient.prototype.delete = function (path, query, init) {
+    }
+    delete(path, query, init) {
         return this.method('delete', path, query, init);
-    };
-    BaseClient.prototype.post = function (path, query, init) {
+    }
+    post(path, query, init) {
         return this.method('post', path, query, init);
-    };
-    BaseClient.prototype.text = function (path, query, init) {
-        return __awaiter(this, void 0, void 0, function () {
-            var result;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.fetch(path, query, init)];
-                    case 1:
-                        result = _a.sent();
-                        return [2 /*return*/, this.handleText(result)];
-                }
-            });
-        });
-    };
-    BaseClient.prototype.json = function (path, query, init) {
-        return __awaiter(this, void 0, void 0, function () {
-            var result;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.fetch(path, query, init)];
-                    case 1:
-                        result = _a.sent();
-                        return [2 /*return*/, this.handleJson(result)];
-                }
-            });
-        });
-    };
-    BaseClient.prototype.method = function (method, path, query, init) {
-        return __awaiter(this, void 0, void 0, function () {
-            var result;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.fetch(path, query, __assign(__assign({}, init), { method: method }))];
-                    case 1:
-                        result = _a.sent();
-                        return [2 /*return*/, result.res];
-                }
-            });
-        });
-    };
+    }
+    async text(path, query, init) {
+        const result = await this.fetch(path, query, init);
+        return this.handleText(result);
+    }
+    async json(path, query, init) {
+        const result = await this.fetch(path, query, init);
+        return this.handleJson(result);
+    }
+    async method(method, path, query, init) {
+        const result = await this.fetch(path, query, { ...init, method });
+        return result.res;
+    }
     /**
      * Constructs a URI path by joining URI components.
      * @param paths - Paths to encode and join.
      * @returns encoded URI path.
      */
-    BaseClient.prototype.getPath = function () {
-        var paths = [];
-        for (var _i = 0; _i < arguments.length; _i++) {
-            paths[_i] = arguments[_i];
-        }
+    getPath(...paths) {
         return paths.map(encodeURIComponent).join('/');
-    };
+    }
     /**
      * Constructs a URI by appending a path to the host.
      * @param path - The path to append to the host.
      * @returns URI string.
      */
-    BaseClient.prototype.getUri = function (path) {
-        return encodeURI("".concat(this.host, "/").concat(path));
-    };
+    getUri(path) {
+        return encodeURI(`${this.host}/${path}`);
+    }
     /**
      * Handles text responses from the server.
      * @param req - The request object.
@@ -156,10 +72,9 @@ var BaseClient = /** @class */ (function () {
      * @param uri - The request URI.
      * @returns Promise that resolves with the text data.
      */
-    BaseClient.prototype.handleText = function (_a) {
-        var req = _a.req, res = _a.res, uri = _a.uri;
+    handleText({ req, res, uri, }) {
         return handleText.bind(this)(req, res, uri);
-    };
+    }
     /**
      * Handles JSON responses from the server.
      * @param req - The request object.
@@ -167,11 +82,8 @@ var BaseClient = /** @class */ (function () {
      * @param uri - The request URI.
      * @returns Promise that resolves with the JSON data.
      */
-    BaseClient.prototype.handleJson = function (_a) {
-        var req = _a.req, res = _a.res, uri = _a.uri;
-        var handle = (handleJson);
+    handleJson({ req, res, uri, }) {
+        const handle = (handleJson);
         return handle.bind(this)(req, res, uri);
-    };
-    return BaseClient;
-}());
-export { BaseClient };
+    }
+}

package/dist/client/clientError.js

@@ -1,60 +1,8 @@
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
-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;
-    return g = { next: verb(0), "throw": verb(1), "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 };
-    }
-};
-import { ACCESS_DENIED, UNAUTHORIZED } from '../leaves-client/constants';
+import { ACCESS_DENIED, UNAUTHORIZED } from '../leaves-client';
 /**
  * Represents a client-side error.
  */
-var ClientError = /** @class */ (function (_super) {
-    __extends(ClientError, _super);
+class ClientError extends Error {
     /**
      * Constructs a ClientError.
      * @param message - The error message.
@@ -63,16 +11,14 @@ var ClientError = /** @class */ (function (_super) {
      * @param request - The original request.
      * @param uri - The URI to which the request was sent.
      */
-    function ClientError(message, client, response, request, uri) {
-        var _this = _super.call(this, message) || this;
-        _this.client = client;
-        _this.response = response;
-        _this.request = request;
-        _this.uri = uri;
-        return _this;
+    constructor(message, client, response, request, uri) {
+        super(message);
+        this.client = client;
+        this.response = response;
+        this.request = request;
+        this.uri = uri;
     }
-    return ClientError;
-}(Error));
+}
 /**
  * Type guard for ClientError.
  * @param object - The object to check.
@@ -98,24 +44,14 @@ export function isClientError(object) {
  * @throws ClientError - If the response is not ok.
  * @returns The fetched text.
  */
-export function handleText(req, res, uri) {
-    return __awaiter(this, void 0, void 0, function () {
-        var text;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0: return [4 /*yield*/, res.text()];
-                case 1:
-                    text = _a.sent();
-                    if (res.ok) {
-                        return [2 /*return*/, text];
-                    }
-                    else {
-                        throw new ClientError(text, this, res, req, uri);
-                    }
-                    return [2 /*return*/];
-            }
-        });
-    });
+export async function handleText(req, res, uri) {
+    const text = await res.text();
+    if (res.ok) {
+        return text;
+    }
+    else {
+        throw new ClientError(text, this, res, req, uri);
+    }
 }
 /**
  * Fetches a resource as JSON.
@@ -125,21 +61,13 @@ export function handleText(req, res, uri) {
  * @throws ClientError - If the response is not ok.
  * @returns The fetched JSON data.
  */
-export function handleJson(req, res, uri) {
-    return __awaiter(this, void 0, void 0, function () {
-        var _a;
-        return __generator(this, function (_b) {
-            switch (_b.label) {
-                case 0:
-                    if (!res.ok) return [3 /*break*/, 1];
-                    return [2 /*return*/, res.json()];
-                case 1:
-                    _a = ClientError.bind;
-                    return [4 /*yield*/, res.text()];
-                case 2: throw new (_a.apply(ClientError, [void 0, _b.sent(), this, res, req, uri]))();
-            }
-        });
-    });
+export async function handleJson(req, res, uri) {
+    if (res.ok) {
+        return res.json();
+    }
+    else {
+        throw new ClientError(await res.text(), this, res, req, uri);
+    }
 }
 /**
  * Checks if a client has access to a resource.

package/dist/leaves-client/constants.js

@@ -1,13 +1,13 @@
-export var ADMIN_TOKEN = process.env.ADMIN_TOKEN;
-export var SUBDOMAIN = process.env.SUBDOMAIN;
-export var AUTH_HEADER = ADMIN_TOKEN ? { Authorization: "Bearer ".concat(ADMIN_TOKEN) } : undefined;
-export var API_ENDPOINT = process.env.API_ENDPOINT || 'http://localhost:5000';
-export var ENDPOINT = "".concat(API_ENDPOINT, "/api");
-export var HEADERS = AUTH_HEADER;
-export var NAVIGATION_ROUTE = 'navigation';
-export var PATHS_ROUTE = 'paths';
-export var HOSTING_LOCATION_ROUTE = 'hosting-location';
-export var HIDDEN_PAGES_ROUTE = 'hidden-pages';
-export var UNAUTHORIZED = { status: 401 };
-export var ACCESS_DENIED = 'Access denied. Not authorized to access protected content.';
-export var IS_PASSWORD_PROTECTED = process.env.IS_PASSWORD_PROTECTED === 'true';
+export const ADMIN_TOKEN = process.env.ADMIN_TOKEN;
+export const SUBDOMAIN = process.env.SUBDOMAIN;
+export const AUTH_HEADER = ADMIN_TOKEN ? { Authorization: `Bearer ${ADMIN_TOKEN}` } : undefined;
+export const API_ENDPOINT = process.env.API_ENDPOINT || 'http://localhost:5000';
+export const ENDPOINT = `${API_ENDPOINT}/api`;
+export const HEADERS = AUTH_HEADER;
+export const NAVIGATION_ROUTE = 'navigation';
+export const PATHS_ROUTE = 'paths';
+export const HOSTING_LOCATION_ROUTE = 'hosting-location';
+export const HIDDEN_PAGES_ROUTE = 'hidden-pages';
+export const UNAUTHORIZED = { status: 401 };
+export const ACCESS_DENIED = 'Access denied. Not authorized to access protected content.';
+export const IS_PASSWORD_PROTECTED = process.env.IS_PASSWORD_PROTECTED === 'true';

package/dist/leaves-client/interfaces.d.ts

@@ -7,7 +7,8 @@ export interface ILeavesClient extends IBaseClient {
     getDeployment(): Promise<DeploymentType>;
     getNavigation(): Promise<NavGroups>;
     getSnippets(): Promise<SnippetType[]>;
-    getPage(path: string, basePath?: string): Promise<CustomerPageType>;
+    getPage(path: string, basePath?: string, ...fields: (keyof CustomerPageType)[]): Promise<CustomerPageType>;
+    getPages(basePath?: string, ...fields: (keyof CustomerPageType)[]): Promise<CustomerPageType[]>;
     getHostingLocation(): Promise<string>;
     getHiddenPages(): Promise<string[]>;
     getPageProps(path: string, basePath?: string): Promise<GetPagePropsReturnType>;