@markupai/api 0.0.6

package/api/types/TermReplaceCategory.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type TermReplaceCategory = "term" | "other";
+export declare const TermReplaceCategory: {
+    readonly Term: "term";
+    readonly Other: "other";
+};

package/api/types/TermReplaceCategory.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TermReplaceCategory = void 0;
+exports.TermReplaceCategory = {
+    Term: "term",
+    Other: "other",
+};

package/api/types/TerminologyScore.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface TerminologyScore {
+    score?: number;
+    issues?: number;
+}

package/api/types/TerminologyScore.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/ToneCategory.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type ToneCategory = "word_choice" | "syntax" | "punctuation" | "discourse_features" | "implicit_style" | "other";
+export declare const ToneCategory: {
+    readonly WordChoice: "word_choice";
+    readonly Syntax: "syntax";
+    readonly Punctuation: "punctuation";
+    readonly DiscourseFeatures: "discourse_features";
+    readonly ImplicitStyle: "implicit_style";
+    readonly Other: "other";
+};

package/api/types/ToneCategory.js

@@ -0,0 +1,14 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ToneCategory = void 0;
+exports.ToneCategory = {
+    WordChoice: "word_choice",
+    Syntax: "syntax",
+    Punctuation: "punctuation",
+    DiscourseFeatures: "discourse_features",
+    ImplicitStyle: "implicit_style",
+    Other: "other",
+};

package/api/types/ToneScore.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ToneScore {
+    score?: number;
+    informality?: number;
+    liveliness?: number;
+    target_informality?: number;
+    target_liveliness?: number;
+    informality_tolerance?: number;
+    liveliness_tolerance?: number;
+}

package/api/types/ToneScore.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/Tones.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type Tones = "academic" | "business" | "conversational" | "formal" | "informal" | "technical";
+export declare const Tones: {
+    readonly Academic: "academic";
+    readonly Business: "business";
+    readonly Conversational: "conversational";
+    readonly Formal: "formal";
+    readonly Informal: "informal";
+    readonly Technical: "technical";
+};

package/api/types/Tones.js

@@ -0,0 +1,14 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Tones = void 0;
+exports.Tones = {
+    Academic: "academic",
+    Business: "business",
+    Conversational: "conversational",
+    Formal: "formal",
+    Informal: "informal",
+    Technical: "technical",
+};

package/api/types/WebhookResponse.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface WebhookResponse {
+    url: string;
+    status_code: number;
+}

package/api/types/WebhookResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/WorkflowResponse.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MarkupAI from "../index";
+export interface WorkflowResponse {
+    status: MarkupAI.WorkflowStatus;
+    workflow_id: string;
+}

package/api/types/WorkflowResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/types/WorkflowStatus.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type WorkflowStatus = "running" | "completed" | "failed" | "not_found";
+export declare const WorkflowStatus: {
+    readonly Running: "running";
+    readonly Completed: "completed";
+    readonly Failed: "failed";
+    readonly NotFound: "not_found";
+};

package/api/types/WorkflowStatus.js

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkflowStatus = void 0;
+exports.WorkflowStatus = {
+    Running: "running",
+    Completed: "completed",
+    Failed: "failed",
+    NotFound: "not_found",
+};

package/api/types/index.d.ts

@@ -0,0 +1,32 @@
+export * from "./CheckOptions";
+export * from "./ClarityScore";
+export * from "./Dialects";
+export * from "./ErrorResponse";
+export * from "./GrammarCategory";
+export * from "./GrammarScore";
+export * from "./Subcategory";
+export * from "./Issue";
+export * from "./IssueCategory";
+export * from "./QualityScore";
+export * from "./RewriteResponse";
+export * from "./ScoreOutput";
+export * from "./SentenceLengthCategory";
+export * from "./SentenceStructureCategory";
+export * from "./SimpleVocabCategory";
+export * from "./StyleCheckResponse";
+export * from "./StyleGuide";
+export * from "./StyleGuideCategory";
+export * from "./StyleGuideResponse";
+export * from "./StyleGuideScore";
+export * from "./StyleGuideStatus";
+export * from "./StyleGuides";
+export * from "./Suggestion";
+export * from "./SuggestionResponse";
+export * from "./TermReplaceCategory";
+export * from "./TerminologyScore";
+export * from "./ToneCategory";
+export * from "./ToneScore";
+export * from "./Tones";
+export * from "./WebhookResponse";
+export * from "./WorkflowResponse";
+export * from "./WorkflowStatus";

package/api/types/index.js

@@ -0,0 +1,48 @@
+"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("./CheckOptions"), exports);
+__exportStar(require("./ClarityScore"), exports);
+__exportStar(require("./Dialects"), exports);
+__exportStar(require("./ErrorResponse"), exports);
+__exportStar(require("./GrammarCategory"), exports);
+__exportStar(require("./GrammarScore"), exports);
+__exportStar(require("./Subcategory"), exports);
+__exportStar(require("./Issue"), exports);
+__exportStar(require("./IssueCategory"), exports);
+__exportStar(require("./QualityScore"), exports);
+__exportStar(require("./RewriteResponse"), exports);
+__exportStar(require("./ScoreOutput"), exports);
+__exportStar(require("./SentenceLengthCategory"), exports);
+__exportStar(require("./SentenceStructureCategory"), exports);
+__exportStar(require("./SimpleVocabCategory"), exports);
+__exportStar(require("./StyleCheckResponse"), exports);
+__exportStar(require("./StyleGuide"), exports);
+__exportStar(require("./StyleGuideCategory"), exports);
+__exportStar(require("./StyleGuideResponse"), exports);
+__exportStar(require("./StyleGuideScore"), exports);
+__exportStar(require("./StyleGuideStatus"), exports);
+__exportStar(require("./StyleGuides"), exports);
+__exportStar(require("./Suggestion"), exports);
+__exportStar(require("./SuggestionResponse"), exports);
+__exportStar(require("./TermReplaceCategory"), exports);
+__exportStar(require("./TerminologyScore"), exports);
+__exportStar(require("./ToneCategory"), exports);
+__exportStar(require("./ToneScore"), exports);
+__exportStar(require("./Tones"), exports);
+__exportStar(require("./WebhookResponse"), exports);
+__exportStar(require("./WorkflowResponse"), exports);
+__exportStar(require("./WorkflowStatus"), exports);

package/core/auth/BasicAuth.d.ts

@@ -0,0 +1,8 @@
+export interface BasicAuth {
+    username: string;
+    password: string;
+}
+export declare const BasicAuth: {
+    toAuthorizationHeader: (basicAuth: BasicAuth | undefined) => string | undefined;
+    fromAuthorizationHeader: (header: string) => BasicAuth;
+};

package/core/auth/BasicAuth.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BasicAuth = void 0;
+const js_base64_1 = require("js-base64");
+const BASIC_AUTH_HEADER_PREFIX = /^Basic /i;
+exports.BasicAuth = {
+    toAuthorizationHeader: (basicAuth) => {
+        if (basicAuth == null) {
+            return undefined;
+        }
+        const token = js_base64_1.Base64.encode(`${basicAuth.username}:${basicAuth.password}`);
+        return `Basic ${token}`;
+    },
+    fromAuthorizationHeader: (header) => {
+        const credentials = header.replace(BASIC_AUTH_HEADER_PREFIX, "");
+        const decoded = js_base64_1.Base64.decode(credentials);
+        const [username, password] = decoded.split(":", 2);
+        if (username == null || password == null) {
+            throw new Error("Invalid basic auth");
+        }
+        return {
+            username,
+            password,
+        };
+    },
+};

package/core/auth/BearerToken.d.ts

@@ -0,0 +1,5 @@
+export type BearerToken = string;
+export declare const BearerToken: {
+    toAuthorizationHeader: (token: BearerToken | undefined) => string | undefined;
+    fromAuthorizationHeader: (header: string) => BearerToken;
+};

package/core/auth/BearerToken.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BearerToken = void 0;
+const BEARER_AUTH_HEADER_PREFIX = /^Bearer /i;
+exports.BearerToken = {
+    toAuthorizationHeader: (token) => {
+        if (token == null) {
+            return undefined;
+        }
+        return `Bearer ${token}`;
+    },
+    fromAuthorizationHeader: (header) => {
+        return header.replace(BEARER_AUTH_HEADER_PREFIX, "").trim();
+    },
+};

package/core/auth/index.d.ts

@@ -0,0 +1,2 @@
+export { BasicAuth } from "./BasicAuth";
+export { BearerToken } from "./BearerToken";

package/core/auth/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BearerToken = exports.BasicAuth = void 0;
+var BasicAuth_1 = require("./BasicAuth");
+Object.defineProperty(exports, "BasicAuth", { enumerable: true, get: function () { return BasicAuth_1.BasicAuth; } });
+var BearerToken_1 = require("./BearerToken");
+Object.defineProperty(exports, "BearerToken", { enumerable: true, get: function () { return BearerToken_1.BearerToken; } });

package/core/fetcher/APIResponse.d.ts

@@ -0,0 +1,20 @@
+import { RawResponse } from "./RawResponse";
+/**
+ * The response of an API call.
+ * It is a successful response or a failed response.
+ */
+export type APIResponse<Success, Failure> = SuccessfulResponse<Success> | FailedResponse<Failure>;
+export interface SuccessfulResponse<T> {
+    ok: true;
+    body: T;
+    /**
+     * @deprecated Use `rawResponse` instead
+     */
+    headers?: Record<string, any>;
+    rawResponse: RawResponse;
+}
+export interface FailedResponse<T> {
+    ok: false;
+    error: T;
+    rawResponse: RawResponse;
+}

package/core/fetcher/APIResponse.js

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

package/core/fetcher/Fetcher.d.ts

@@ -0,0 +1,39 @@
+import { APIResponse } from "./APIResponse";
+export type FetchFunction = <R = unknown>(args: Fetcher.Args) => Promise<APIResponse<R, Fetcher.Error>>;
+export declare namespace Fetcher {
+    interface Args {
+        url: string;
+        method: string;
+        contentType?: string;
+        headers?: Record<string, string | undefined>;
+        queryParameters?: Record<string, string | string[] | object | object[] | null>;
+        body?: unknown;
+        timeoutMs?: number;
+        maxRetries?: number;
+        withCredentials?: boolean;
+        abortSignal?: AbortSignal;
+        requestType?: "json" | "file" | "bytes";
+        responseType?: "json" | "blob" | "sse" | "streaming" | "text" | "arrayBuffer";
+        duplex?: "half";
+    }
+    type Error = FailedStatusCodeError | NonJsonError | TimeoutError | UnknownError;
+    interface FailedStatusCodeError {
+        reason: "status-code";
+        statusCode: number;
+        body: unknown;
+    }
+    interface NonJsonError {
+        reason: "non-json";
+        statusCode: number;
+        rawBody: string;
+    }
+    interface TimeoutError {
+        reason: "timeout";
+    }
+    interface UnknownError {
+        reason: "unknown";
+        errorMessage: string;
+    }
+}
+export declare function fetcherImpl<R = unknown>(args: Fetcher.Args): Promise<APIResponse<R, Fetcher.Error>>;
+export declare const fetcher: FetchFunction;

package/core/fetcher/Fetcher.js

@@ -0,0 +1,107 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetcher = void 0;
+exports.fetcherImpl = fetcherImpl;
+const json_1 = require("../json");
+const RawResponse_1 = require("./RawResponse");
+const createRequestUrl_1 = require("./createRequestUrl");
+const getFetchFn_1 = require("./getFetchFn");
+const getRequestBody_1 = require("./getRequestBody");
+const getResponseBody_1 = require("./getResponseBody");
+const makeRequest_1 = require("./makeRequest");
+const requestWithRetries_1 = require("./requestWithRetries");
+function fetcherImpl(args) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const headers = {};
+        if (args.body !== undefined && args.contentType != null) {
+            headers["Content-Type"] = args.contentType;
+        }
+        if (args.headers != null) {
+            for (const [key, value] of Object.entries(args.headers)) {
+                if (value != null) {
+                    headers[key] = value;
+                }
+            }
+        }
+        const url = (0, createRequestUrl_1.createRequestUrl)(args.url, args.queryParameters);
+        const requestBody = yield (0, getRequestBody_1.getRequestBody)({
+            body: args.body,
+            type: args.requestType === "json" ? "json" : "other",
+        });
+        const fetchFn = yield (0, getFetchFn_1.getFetchFn)();
+        try {
+            const response = yield (0, requestWithRetries_1.requestWithRetries)(() => __awaiter(this, void 0, void 0, function* () {
+                return (0, makeRequest_1.makeRequest)(fetchFn, url, args.method, headers, requestBody, args.timeoutMs, args.abortSignal, args.withCredentials, args.duplex);
+            }), args.maxRetries);
+            const responseBody = yield (0, getResponseBody_1.getResponseBody)(response, args.responseType);
+            if (response.status >= 200 && response.status < 400) {
+                return {
+                    ok: true,
+                    body: responseBody,
+                    headers: response.headers,
+                    rawResponse: (0, RawResponse_1.toRawResponse)(response),
+                };
+            }
+            else {
+                return {
+                    ok: false,
+                    error: {
+                        reason: "status-code",
+                        statusCode: response.status,
+                        body: responseBody,
+                    },
+                    rawResponse: (0, RawResponse_1.toRawResponse)(response),
+                };
+            }
+        }
+        catch (error) {
+            if (args.abortSignal != null && args.abortSignal.aborted) {
+                return {
+                    ok: false,
+                    error: {
+                        reason: "unknown",
+                        errorMessage: "The user aborted a request",
+                    },
+                    rawResponse: RawResponse_1.abortRawResponse,
+                };
+            }
+            else if (error instanceof Error && error.name === "AbortError") {
+                return {
+                    ok: false,
+                    error: {
+                        reason: "timeout",
+                    },
+                    rawResponse: RawResponse_1.abortRawResponse,
+                };
+            }
+            else if (error instanceof Error) {
+                return {
+                    ok: false,
+                    error: {
+                        reason: "unknown",
+                        errorMessage: error.message,
+                    },
+                    rawResponse: RawResponse_1.unknownRawResponse,
+                };
+            }
+            return {
+                ok: false,
+                error: {
+                    reason: "unknown",
+                    errorMessage: (0, json_1.toJson)(error),
+                },
+                rawResponse: RawResponse_1.unknownRawResponse,
+            };
+        }
+    });
+}
+exports.fetcher = fetcherImpl;

package/core/fetcher/Headers.d.ts

@@ -0,0 +1,2 @@
+declare let Headers: typeof globalThis.Headers;
+export { Headers };

package/core/fetcher/Headers.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Headers = void 0;
+let Headers;
+if (typeof globalThis.Headers !== "undefined") {
+    exports.Headers = Headers = globalThis.Headers;
+}
+else {
+    exports.Headers = Headers = class Headers {
+        constructor(init) {
+            this.headers = new Map();
+            if (init) {
+                if (init instanceof Headers) {
+                    init.forEach((value, key) => this.append(key, value));
+                }
+                else if (Array.isArray(init)) {
+                    for (const [key, value] of init) {
+                        if (typeof key === "string" && typeof value === "string") {
+                            this.append(key, value);
+                        }
+                        else {
+                            throw new TypeError("Each header entry must be a [string, string] tuple");
+                        }
+                    }
+                }
+                else {
+                    for (const [key, value] of Object.entries(init)) {
+                        if (typeof value === "string") {
+                            this.append(key, value);
+                        }
+                        else {
+                            throw new TypeError("Header values must be strings");
+                        }
+                    }
+                }
+            }
+        }
+        append(name, value) {
+            const key = name.toLowerCase();
+            const existing = this.headers.get(key) || [];
+            this.headers.set(key, [...existing, value]);
+        }
+        delete(name) {
+            const key = name.toLowerCase();
+            this.headers.delete(key);
+        }
+        get(name) {
+            const key = name.toLowerCase();
+            const values = this.headers.get(key);
+            return values ? values.join(", ") : null;
+        }
+        has(name) {
+            const key = name.toLowerCase();
+            return this.headers.has(key);
+        }
+        set(name, value) {
+            const key = name.toLowerCase();
+            this.headers.set(key, [value]);
+        }
+        forEach(callbackfn, thisArg) {
+            const boundCallback = thisArg ? callbackfn.bind(thisArg) : callbackfn;
+            this.headers.forEach((values, key) => boundCallback(values.join(", "), key, this));
+        }
+        getSetCookie() {
+            return this.headers.get("set-cookie") || [];
+        }
+        *entries() {
+            for (const [key, values] of this.headers.entries()) {
+                yield [key, values.join(", ")];
+            }
+        }
+        *keys() {
+            yield* this.headers.keys();
+        }
+        *values() {
+            for (const values of this.headers.values()) {
+                yield values.join(", ");
+            }
+        }
+        [Symbol.iterator]() {
+            return this.entries();
+        }
+    };
+}

package/core/fetcher/HttpResponsePromise.d.ts

@@ -0,0 +1,58 @@
+import { WithRawResponse } from "./RawResponse";
+/**
+ * A promise that returns the parsed response and lets you retrieve the raw response too.
+ */
+export declare class HttpResponsePromise<T> extends Promise<T> {
+    private innerPromise;
+    private unwrappedPromise;
+    private constructor();
+    /**
+     * Creates an `HttpResponsePromise` from a function that returns a promise.
+     *
+     * @param fn - A function that returns a promise resolving to a `WithRawResponse` object.
+     * @param args - Arguments to pass to the function.
+     * @returns An `HttpResponsePromise` instance.
+     */
+    static fromFunction<F extends (...args: never[]) => Promise<WithRawResponse<T>>, T>(fn: F, ...args: Parameters<F>): HttpResponsePromise<T>;
+    /**
+     * Creates a function that returns an `HttpResponsePromise` from a function that returns a promise.
+     *
+     * @param fn - A function that returns a promise resolving to a `WithRawResponse` object.
+     * @returns A function that returns an `HttpResponsePromise` instance.
+     */
+    static interceptFunction<F extends (...args: never[]) => Promise<WithRawResponse<T>>, T = Awaited<ReturnType<F>>["data"]>(fn: F): (...args: Parameters<F>) => HttpResponsePromise<T>;
+    /**
+     * Creates an `HttpResponsePromise` from an existing promise.
+     *
+     * @param promise - A promise resolving to a `WithRawResponse` object.
+     * @returns An `HttpResponsePromise` instance.
+     */
+    static fromPromise<T>(promise: Promise<WithRawResponse<T>>): HttpResponsePromise<T>;
+    /**
+     * Creates an `HttpResponsePromise` from an executor function.
+     *
+     * @param executor - A function that takes resolve and reject callbacks to create a promise.
+     * @returns An `HttpResponsePromise` instance.
+     */
+    static fromExecutor<T>(executor: (resolve: (value: WithRawResponse<T>) => void, reject: (reason?: unknown) => void) => void): HttpResponsePromise<T>;
+    /**
+     * Creates an `HttpResponsePromise` from a resolved result.
+     *
+     * @param result - A `WithRawResponse` object to resolve immediately.
+     * @returns An `HttpResponsePromise` instance.
+     */
+    static fromResult<T>(result: WithRawResponse<T>): HttpResponsePromise<T>;
+    private unwrap;
+    /** @inheritdoc */
+    then<TResult1 = T, TResult2 = never>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
+    /** @inheritdoc */
+    catch<TResult = never>(onrejected?: ((reason: unknown) => TResult | PromiseLike<TResult>) | null): Promise<T | TResult>;
+    /** @inheritdoc */
+    finally(onfinally?: (() => void) | null): Promise<T>;
+    /**
+     * Retrieves the data and raw response.
+     *
+     * @returns A promise resolving to a `WithRawResponse` object.
+     */
+    withRawResponse(): Promise<WithRawResponse<T>>;
+}