@mintlify/http-client 0.0.5 → 0.0.7

package/dist/src/client/interfaces.d.ts

@@ -1,93 +0,0 @@
-import { ErrorResponseType, HttpMethods, QueryType, RequestInitType } from './types';
-/**
- * The `IBaseClient` interface outlines the structure for a base client with basic configurations for making HTTP requests.
- */
-export interface IBaseClient {
-    /**
-     * The server's address to which the client makes requests.
-     */
-    readonly host: string;
-    /**
-     * Fetches a response from the given path.
-     * @param path - The path of the resource.
-     * @param query - Optional query.
-     * @param init - Optional request initializer. Overwrites default settings.
-     */
-    fetch(path: string, query?: QueryType, init?: RequestInit): Promise<{
-        uri: string;
-        res: Response;
-    }>;
-    /**
-     * Gets a response from the given path.
-     * @param path - The path of the resource.
-     * @param query - Optional query.
-     * @param init - Optional request initializer. Overwrites default settings.
-     */
-    get(path: string, query?: QueryType, init?: RequestInit): Promise<Response>;
-    /**
-     * Posts a request and gets a response from the given path.
-     * @param path - The path of the resource.
-     * @param query - Optional query.
-     * @param init - Optional request initializer. Overwrites default settings.
-     * @returns Promise that resolves with the JSON data.
-     */
-    post(path: string, query?: QueryType, init?: RequestInitType): Promise<Response>;
-    /**
-     * Fetches a resource as text from the given path.
-     * @param path - The path of the resource.
-     * @param query - Optional query.
-     * @param init - Optional request initializer. Overwrites default settings.
-     * @returns Promise that resolves with the text data.
-     */
-    text(path: string, query?: QueryType, init?: RequestInit): Promise<string>;
-    /**
-     * Fetches a resource as JSON from the given path.
-     * @param path - The path of the resource.
-     * @param query - Optional query.
-     * @param init - Optional request initializer. Overwrites default settings.
-     * @returns Promise that resolves with the JSON data.
-     */
-    json<T extends object>(path: string, query?: QueryType, init?: RequestInit): Promise<T>;
-    /**
-     * Fetches a response, using the given path and method.
-     * @param method = Http method of the request.
-     * @param path - The path of the resource.
-     * @param query - Optional query.
-     * @param init - Optional request initializer. Overwrites default settings.
-     */
-    method(method: HttpMethods, path: string, query?: QueryType, init?: RequestInitType): Promise<Response>;
-    /**
-     * Constructs a URI path by joining URI components.
-     * @param paths - Paths to encode and join.
-     * @returns encoded URI path.
-     */
-    getPath(...paths: string[]): string;
-    /**
-     * Constructs a URI by appending a path to the host.
-     * @param path - The path to append to the host.
-     * @returns URI string.
-     */
-    getUri(path: string): string;
-}
-/**
- * Outlines the structure for a custom error type to handle client errors.
- * It extends the built-in Error interface.
- */
-export interface IClientError extends Error {
-    /**
-     * `BaseClient` that is associated with the error.
-     */
-    readonly client: IBaseClient;
-    /**
-     * Response received from the server that caused the error.
-     */
-    readonly response: ErrorResponseType;
-    /**
-     * Optional request that was sent which caused the error.
-     */
-    readonly request?: RequestInit;
-    /**
-     * Optional URI to which the request was sent.
-     */
-    readonly uri?: string;
-}

package/dist/src/client/interfaces.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/client/types.d.ts

@@ -1,9 +0,0 @@
-/**
- * The `ErrorResponseType` type represents a server response that contains a client side error.
- * It includes the mandatory 'status' property from the Response object.
- * All other properties are optional.
- */
-export type ErrorResponseType = Partial<Omit<Response, 'status'>> & Pick<Response, 'status'>;
-export type HttpMethods = 'get' | 'put' | 'post' | 'delete' | 'options' | 'head' | 'patch' | 'trace' | 'connect';
-export type QueryType = string[][] | Record<string, string> | string | URLSearchParams;
-export type RequestInitType = Omit<RequestInit, 'method'>;

package/dist/src/client/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/index.d.ts

@@ -1,2 +0,0 @@
-export * from './leaves-client';
-export * from './client';

package/dist/src/index.js

@@ -1,18 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./leaves-client"), exports);
-__exportStar(require("./client"), exports);

package/dist/src/leaves-client/constants.d.ts

@@ -1,18 +0,0 @@
-import { ErrorResponseType } from '../client/types';
-export declare const ADMIN_TOKEN: string | undefined;
-export declare const SUBDOMAIN: string | undefined;
-export declare const AUTH_HEADER: {
-    Authorization: string;
-} | undefined;
-export declare const API_ENDPOINT: string;
-export declare const ENDPOINT: string;
-export declare const HEADERS: {
-    Authorization: string;
-} | undefined;
-export declare const NAVIGATION_ROUTE = "navigation";
-export declare const PATHS_ROUTE = "paths";
-export declare const HOSTING_LOCATION_ROUTE = "hosting-location";
-export declare const HIDDEN_PAGES_ROUTE = "hidden-pages";
-export declare const UNAUTHORIZED: ErrorResponseType;
-export declare const ACCESS_DENIED = "Access denied. Not authorized to access protected content.";
-export declare const IS_PASSWORD_PROTECTED: boolean;

package/dist/src/leaves-client/constants.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.IS_PASSWORD_PROTECTED = exports.ACCESS_DENIED = exports.UNAUTHORIZED = exports.HIDDEN_PAGES_ROUTE = exports.HOSTING_LOCATION_ROUTE = exports.PATHS_ROUTE = exports.NAVIGATION_ROUTE = exports.HEADERS = exports.ENDPOINT = exports.API_ENDPOINT = exports.AUTH_HEADER = exports.SUBDOMAIN = exports.ADMIN_TOKEN = void 0;
-exports.ADMIN_TOKEN = process.env.ADMIN_TOKEN;
-exports.SUBDOMAIN = process.env.SUBDOMAIN;
-exports.AUTH_HEADER = exports.ADMIN_TOKEN ? { Authorization: "Bearer ".concat(exports.ADMIN_TOKEN) } : undefined;
-exports.API_ENDPOINT = process.env.API_ENDPOINT || 'http://localhost:5000';
-exports.ENDPOINT = "".concat(exports.API_ENDPOINT, "/api");
-exports.HEADERS = exports.AUTH_HEADER;
-exports.NAVIGATION_ROUTE = 'navigation';
-exports.PATHS_ROUTE = 'paths';
-exports.HOSTING_LOCATION_ROUTE = 'hosting-location';
-exports.HIDDEN_PAGES_ROUTE = 'hidden-pages';
-exports.UNAUTHORIZED = { status: 401 };
-exports.ACCESS_DENIED = 'Access denied. Not authorized to access protected content.';
-exports.IS_PASSWORD_PROTECTED = process.env.IS_PASSWORD_PROTECTED === 'true';

package/dist/src/leaves-client/index.d.ts

@@ -1,4 +0,0 @@
-import { ILeavesClient } from './interfaces';
-import getLeavesClient from './leavesClient';
-export { getLeavesClient };
-export type { ILeavesClient };

package/dist/src/leaves-client/index.js

@@ -1,8 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getLeavesClient = void 0;
-var leavesClient_1 = __importDefault(require("./leavesClient"));
-exports.getLeavesClient = leavesClient_1.default;

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

@@ -1,15 +0,0 @@
-import { DeploymentType, SnippetType, CustomerPageType, NavGroups } from '@mintlify/models';
-import { IBaseClient } from '../client';
-import { GetPagePropsReturnType } from './types';
-export interface ILeavesClient extends IBaseClient {
-    readonly subdomain: string;
-    readonly isPasswordProtected: boolean;
-    getDeployment(): Promise<DeploymentType>;
-    getNavigation(): Promise<NavGroups>;
-    getSnippets(): Promise<SnippetType[]>;
-    getPage(path: string, basePath?: string): Promise<CustomerPageType>;
-    getHostingLocation(): Promise<string>;
-    getHiddenPages(): Promise<string[]>;
-    getPageProps(path: string, basePath?: string): Promise<GetPagePropsReturnType>;
-    getPaths(): Promise<string[]>;
-}

package/dist/src/leaves-client/interfaces.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/leaves-client/leavesClient.d.ts

@@ -1,7 +0,0 @@
-import { ILeavesClient } from './interfaces';
-export declare const getLeavesClient: (subdomain: string, isPasswordProtected?: boolean, host?: string, reqInit?: {
-    headers: {
-        Authorization: string;
-    } | undefined;
-}) => ILeavesClient;
-export default getLeavesClient;

package/dist/src/leaves-client/leavesClient.js

@@ -1,157 +0,0 @@
-"use strict";
-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 __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 };
-    }
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getLeavesClient = void 0;
-var models_1 = require("@mintlify/models");
-var client_1 = require("../client");
-var clientError_1 = require("../client/clientError");
-var constants_1 = require("./constants");
-var LeavesClient = /** @class */ (function (_super) {
-    __extends(LeavesClient, _super);
-    function LeavesClient(subdomain, isPasswordProtected, host, reqInit) {
-        if (reqInit === void 0) { reqInit = undefined; }
-        var _this = _super.call(this, host, reqInit) || this;
-        _this.isPasswordProtected = isPasswordProtected;
-        _this.subdomain = constants_1.SUBDOMAIN !== null && constants_1.SUBDOMAIN !== void 0 ? constants_1.SUBDOMAIN : subdomain;
-        var isAccessDenied = constants_1.SUBDOMAIN !== subdomain && _this.isPasswordProtected;
-        clientError_1.handleAccess.bind(_this)(!isAccessDenied);
-        return _this;
-    }
-    LeavesClient.prototype.getDeployment = function () {
-        return this.entity(models_1.ENTITY_TYPE.DEPLOYMENT);
-    };
-    LeavesClient.prototype.getNavigation = function () {
-        var path = this.getPath(constants_1.NAVIGATION_ROUTE, this.subdomain);
-        return this.json(path);
-    };
-    LeavesClient.prototype.getSnippets = function () {
-        return this.entity(models_1.ENTITY_TYPE.SNIPPET);
-    };
-    LeavesClient.prototype.getPage = function (path, basePath) {
-        return this.entity(models_1.ENTITY_TYPE.PAGE, __assign({ path: path }, (basePath ? { basePath: basePath } : {})));
-    };
-    LeavesClient.prototype.getHiddenPages = function () {
-        var route = this.getRoute(models_1.ENTITY_TYPE.PAGE);
-        var path = this.getPath(route, this.subdomain, constants_1.HIDDEN_PAGES_ROUTE);
-        return this.json(path);
-    };
-    LeavesClient.prototype.getPaths = function () {
-        var route = this.getRoute(models_1.ENTITY_TYPE.PAGE);
-        var path = this.getPath(route, this.subdomain, constants_1.PATHS_ROUTE);
-        return this.json(path);
-    };
-    LeavesClient.prototype.getHostingLocation = function () {
-        var route = this.getRoute(models_1.ENTITY_TYPE.DEPLOYMENT);
-        var path = this.getPath(route, this.subdomain, constants_1.HOSTING_LOCATION_ROUTE);
-        return this.text(path);
-    };
-    LeavesClient.prototype.getPageProps = function (path, basePath) {
-        var _a;
-        return __awaiter(this, void 0, void 0, function () {
-            var promises, _b, deployment, page, isProtectedEqual;
-            return __generator(this, function (_c) {
-                switch (_c.label) {
-                    case 0:
-                        promises = [
-                            this.getDeployment(),
-                            this.getPage(path, basePath),
-                        ];
-                        return [4 /*yield*/, Promise.all(promises)];
-                    case 1:
-                        _b = _c.sent(), deployment = _b[0], page = _b[1];
-                        isProtectedEqual = this.isPasswordProtected === ((_a = deployment.isPasswordProtected) !== null && _a !== void 0 ? _a : false);
-                        clientError_1.handleAccess.bind(this)(isProtectedEqual);
-                        return [2 /*return*/, {
-                                data: __assign(__assign({}, deployment), page),
-                                status: 200,
-                            }];
-                }
-            });
-        });
-    };
-    LeavesClient.prototype.getRoute = function (type) {
-        switch (type) {
-            case models_1.ENTITY_TYPE.DEPLOYMENT:
-            case models_1.ENTITY_TYPE.SNIPPET:
-            case models_1.ENTITY_TYPE.PAGE:
-                return type.toLowerCase();
-            default:
-                throw new Error("ENTITY_TYPE: ".concat(type, " is not supported."));
-        }
-    };
-    LeavesClient.prototype.entity = function (type, query, init) {
-        var route = this.getRoute(type);
-        var path = this.getPath(route, this.subdomain);
-        return this.json(path, query, init);
-    };
-    return LeavesClient;
-}(client_1.BaseClient));
-var getLeavesClient = function (subdomain, isPasswordProtected, host, reqInit) {
-    if (isPasswordProtected === void 0) { isPasswordProtected = constants_1.IS_PASSWORD_PROTECTED; }
-    if (host === void 0) { host = constants_1.ENDPOINT; }
-    if (reqInit === void 0) { reqInit = { headers: constants_1.HEADERS }; }
-    return new LeavesClient(subdomain, isPasswordProtected, host, reqInit);
-};
-exports.getLeavesClient = getLeavesClient;
-exports.default = exports.getLeavesClient;

package/dist/src/leaves-client/types.d.ts

@@ -1,11 +0,0 @@
-import { CustomerPageType, DeploymentType } from '@mintlify/models';
-export type PagePropsResponseType = CustomerPageType & DeploymentType & {
-    redirect?: {
-        destination: string;
-        permanent: boolean;
-    };
-};
-export type GetPagePropsReturnType = {
-    data?: PagePropsResponseType;
-    status: number;
-};

package/dist/src/leaves-client/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });