mavenagi 0.0.0-alpha.2

package/api/resources/knowledge/errors/IneligibleKnowledgeBaseError.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../../../errors/index";
+import * as MavenAGI from "../../../index";
+export declare class IneligibleKnowledgeBaseError extends errors.MavenAGIError {
+    constructor(body: MavenAGI.IdBody);
+}

package/api/resources/knowledge/errors/IneligibleKnowledgeBaseError.js

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../../../errors/index";
+export class IneligibleKnowledgeBaseError extends errors.MavenAGIError {
+    constructor(body) {
+        super({
+            message: "IneligibleKnowledgeBaseError",
+            statusCode: 400,
+            body: body,
+        });
+        Object.setPrototypeOf(this, IneligibleKnowledgeBaseError.prototype);
+    }
+}

package/api/resources/knowledge/errors/KnowledgeBaseNotFoundError.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../../../errors/index";
+import * as MavenAGI from "../../../index";
+export declare class KnowledgeBaseNotFoundError extends errors.MavenAGIError {
+    constructor(body: MavenAGI.IdBody);
+}

package/api/resources/knowledge/errors/KnowledgeBaseNotFoundError.js

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../../../errors/index";
+export class KnowledgeBaseNotFoundError extends errors.MavenAGIError {
+    constructor(body) {
+        super({
+            message: "KnowledgeBaseNotFoundError",
+            statusCode: 404,
+            body: body,
+        });
+        Object.setPrototypeOf(this, KnowledgeBaseNotFoundError.prototype);
+    }
+}

package/api/resources/knowledge/errors/VersionInProgressError.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../../../errors/index";
+import * as MavenAGI from "../../../index";
+export declare class VersionInProgressError extends errors.MavenAGIError {
+    constructor(body: MavenAGI.IdBody);
+}

package/api/resources/knowledge/errors/VersionInProgressError.js

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../../../errors/index";
+export class VersionInProgressError extends errors.MavenAGIError {
+    constructor(body) {
+        super({
+            message: "VersionInProgressError",
+            statusCode: 400,
+            body: body,
+        });
+        Object.setPrototypeOf(this, VersionInProgressError.prototype);
+    }
+}

package/api/resources/knowledge/errors/VersionNotInProgressError.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../../../errors/index";
+import * as MavenAGI from "../../../index";
+export declare class VersionNotInProgressError extends errors.MavenAGIError {
+    constructor(body: MavenAGI.IdBody);
+}

package/api/resources/knowledge/errors/VersionNotInProgressError.js

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as errors from "../../../../errors/index";
+export class VersionNotInProgressError extends errors.MavenAGIError {
+    constructor(body) {
+        super({
+            message: "VersionNotInProgressError",
+            statusCode: 400,
+            body: body,
+        });
+        Object.setPrototypeOf(this, VersionNotInProgressError.prototype);
+    }
+}

package/api/resources/knowledge/errors/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./VersionInProgressError";
+export * from "./VersionNotInProgressError";
+export * from "./IneligibleKnowledgeBaseError";
+export * from "./DocumentNotFoundError";
+export * from "./DocumentCreationError";
+export * from "./KnowledgeBaseNotFoundError";

package/api/resources/knowledge/errors/index.js

@@ -0,0 +1,6 @@
+export * from "./VersionInProgressError";
+export * from "./VersionNotInProgressError";
+export * from "./IneligibleKnowledgeBaseError";
+export * from "./DocumentNotFoundError";
+export * from "./DocumentCreationError";
+export * from "./KnowledgeBaseNotFoundError";

package/api/resources/knowledge/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./types";
+export * from "./errors";
+export * from "./client";

package/api/resources/knowledge/index.js

@@ -0,0 +1,3 @@
+export * from "./types";
+export * from "./errors";
+export * from "./client";

package/api/resources/knowledge/types/IdBody.d.ts

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface IdBody {
+    requestedId: string;
+}

package/api/resources/knowledge/types/IdBody.js

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/api/resources/knowledge/types/KnowledgeBase.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface KnowledgeBase extends MavenAGI.KnowledgeBaseId {
+    /** The name of the knowledge base */
+    displayName: string;
+    /** The type of the knowledge base */
+    type: MavenAGI.KnowledgeBaseType;
+    /** The URL to pull content from for RSS and URL knowledge bases. */
+    url?: string;
+}

package/api/resources/knowledge/types/KnowledgeBase.js

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/api/resources/knowledge/types/KnowledgeBaseId.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface KnowledgeBaseId {
+    /** Externally supplied ID to uniquely identify this knowledge base */
+    knowledgeBaseId: string;
+}

package/api/resources/knowledge/types/KnowledgeBaseId.js

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/api/resources/knowledge/types/KnowledgeBaseType.d.ts

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The type of knowledge base version
+ */
+export declare type KnowledgeBaseType = "API" | "URL" | "RSS";
+export declare const KnowledgeBaseType: {
+    readonly Api: "API";
+    readonly Url: "URL";
+    readonly Rss: "RSS";
+};

package/api/resources/knowledge/types/KnowledgeBaseType.js

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const KnowledgeBaseType = {
+    Api: "API",
+    Url: "URL",
+    Rss: "RSS",
+};

package/api/resources/knowledge/types/KnowledgeBaseVersion.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface KnowledgeBaseVersion {
+    /** External ID of the knowledge base used to create a new version */
+    knowledgeBaseId: string;
+    /** Indicates whether the completed version constitutes a full or partial refresh of the knowledge base */
+    type: MavenAGI.KnowledgeBaseVersionType;
+}

package/api/resources/knowledge/types/KnowledgeBaseVersion.js

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/api/resources/knowledge/types/KnowledgeBaseVersionType.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The type of knowledge base version
+ */
+export declare type KnowledgeBaseVersionType = "FULL" | "PARTIAL";
+export declare const KnowledgeBaseVersionType: {
+    readonly Full: "FULL";
+    readonly Partial: "PARTIAL";
+};

package/api/resources/knowledge/types/KnowledgeBaseVersionType.js

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export const KnowledgeBaseVersionType = {
+    Full: "FULL",
+    Partial: "PARTIAL",
+};

package/api/resources/knowledge/types/KnowledgeDocument.d.ts

@@ -0,0 +1,20 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as MavenAGI from "../../../index";
+export interface KnowledgeDocument extends MavenAGI.KnowledgeDocumentId {
+    /** The title of the document. Will be shown as part of answers. */
+    title: string;
+    /** The content of the document */
+    content: string;
+    /** The URL of the document. Should be visible to end users. Will be shown as part of answers. */
+    url?: string;
+    /** The document language. Must be a valid ISO 639-1 language code. */
+    language?: string;
+    /** The time at which this document was created. */
+    createdAt?: Date;
+    /** The time at which this document was last modified. */
+    updatedAt?: Date;
+    /** The name of the author who created this document. */
+    author?: string;
+}

package/api/resources/knowledge/types/KnowledgeDocument.js

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/api/resources/knowledge/types/KnowledgeDocumentId.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface KnowledgeDocumentId {
+    /** External ID of the knowledge base used to create this document. Must have an active version. */
+    knowledgeBaseId: string;
+    /** Externally supplied ID that uniquely identifies this document. It is used to deduplicate documents and facilitate operations such as updating or deleting documents when calculating changes in the knowledge base. */
+    documentId: string;
+}

package/api/resources/knowledge/types/KnowledgeDocumentId.js

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

package/api/resources/knowledge/types/index.d.ts

@@ -0,0 +1,8 @@
+export * from "./KnowledgeBaseId";
+export * from "./KnowledgeBase";
+export * from "./KnowledgeBaseType";
+export * from "./KnowledgeBaseVersion";
+export * from "./KnowledgeBaseVersionType";
+export * from "./KnowledgeDocumentId";
+export * from "./KnowledgeDocument";
+export * from "./IdBody";

package/api/resources/knowledge/types/index.js

@@ -0,0 +1,8 @@
+export * from "./KnowledgeBaseId";
+export * from "./KnowledgeBase";
+export * from "./KnowledgeBaseType";
+export * from "./KnowledgeBaseVersion";
+export * from "./KnowledgeBaseVersionType";
+export * from "./KnowledgeDocumentId";
+export * from "./KnowledgeDocument";
+export * from "./IdBody";

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,23 @@
+import { Base64 } from "js-base64";
+const BASIC_AUTH_HEADER_PREFIX = /^Basic /i;
+export const BasicAuth = {
+    toAuthorizationHeader: (basicAuth) => {
+        if (basicAuth == null) {
+            return undefined;
+        }
+        const token = Base64.encode(`${basicAuth.username}:${basicAuth.password}`);
+        return `Basic ${token}`;
+    },
+    fromAuthorizationHeader: (header) => {
+        const credentials = header.replace(BASIC_AUTH_HEADER_PREFIX, "");
+        const decoded = 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 declare 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,12 @@
+const BEARER_AUTH_HEADER_PREFIX = /^Bearer /i;
+export const 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,2 @@
+export { BasicAuth } from "./BasicAuth";
+export { BearerToken } from "./BearerToken";

package/core/fetcher/APIResponse.d.ts

@@ -0,0 +1,10 @@
+export declare type APIResponse<Success, Failure> = SuccessfulResponse<Success> | FailedResponse<Failure>;
+export interface SuccessfulResponse<T> {
+    ok: true;
+    body: T;
+    headers?: Record<string, any>;
+}
+export interface FailedResponse<T> {
+    ok: false;
+    error: T;
+}

package/core/fetcher/APIResponse.js

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

package/core/fetcher/Fetcher.d.ts

@@ -0,0 +1,36 @@
+import { APIResponse } from "./APIResponse";
+export declare 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[]>;
+        body?: unknown;
+        timeoutMs?: number;
+        maxRetries?: number;
+        withCredentials?: boolean;
+        abortSignal?: AbortSignal;
+        responseType?: "json" | "blob" | "streaming" | "text";
+    }
+    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 const fetcher: FetchFunction;

package/core/fetcher/Fetcher.js

@@ -0,0 +1,236 @@
+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 qs from "qs";
+import { RUNTIME } from "../runtime";
+const INITIAL_RETRY_DELAY = 1;
+const MAX_RETRY_DELAY = 60;
+const DEFAULT_MAX_RETRIES = 2;
+function fetcherImpl(args) {
+    var _a, _b;
+    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 = Object.keys((_a = args.queryParameters) !== null && _a !== void 0 ? _a : {}).length > 0
+            ? `${args.url}?${qs.stringify(args.queryParameters, { arrayFormat: "repeat" })}`
+            : args.url;
+        let body = undefined;
+        const maybeStringifyBody = (body) => {
+            if (body instanceof Uint8Array) {
+                return body;
+            }
+            else if (args.contentType === "application/x-www-form-urlencoded" && typeof args.body === "string") {
+                return args.body;
+            }
+            else {
+                return JSON.stringify(body);
+            }
+        };
+        if (RUNTIME.type === "node") {
+            if (args.body instanceof (yield import("formdata-node")).FormData) {
+                // @ts-expect-error
+                body = args.body;
+            }
+            else {
+                body = maybeStringifyBody(args.body);
+            }
+        }
+        else {
+            if (args.body instanceof (yield import("form-data")).default) {
+                // @ts-expect-error
+                body = args.body;
+            }
+            else {
+                body = maybeStringifyBody(args.body);
+            }
+        }
+        const fetchFn = yield getFetchFn();
+        const makeRequest = () => __awaiter(this, void 0, void 0, function* () {
+            const signals = [];
+            // Add timeout signal
+            let timeoutAbortId = undefined;
+            if (args.timeoutMs != null) {
+                const { signal, abortId } = getTimeoutSignal(args.timeoutMs);
+                timeoutAbortId = abortId;
+                signals.push(signal);
+            }
+            // Add arbitrary signal
+            if (args.abortSignal != null) {
+                signals.push(args.abortSignal);
+            }
+            const response = yield fetchFn(url, {
+                method: args.method,
+                headers,
+                body,
+                signal: anySignal(signals),
+                credentials: args.withCredentials ? "include" : undefined,
+            });
+            if (timeoutAbortId != null) {
+                clearTimeout(timeoutAbortId);
+            }
+            return response;
+        });
+        try {
+            let response = yield makeRequest();
+            for (let i = 0; i < ((_b = args.maxRetries) !== null && _b !== void 0 ? _b : DEFAULT_MAX_RETRIES); ++i) {
+                if (response.status === 408 ||
+                    response.status === 409 ||
+                    response.status === 429 ||
+                    response.status >= 500) {
+                    const delay = Math.min(INITIAL_RETRY_DELAY * Math.pow(i, 2), MAX_RETRY_DELAY);
+                    yield new Promise((resolve) => setTimeout(resolve, delay));
+                    response = yield makeRequest();
+                }
+                else {
+                    break;
+                }
+            }
+            let body;
+            if (response.body != null && args.responseType === "blob") {
+                body = yield response.blob();
+            }
+            else if (response.body != null && args.responseType === "streaming") {
+                body = response.body;
+            }
+            else if (response.body != null && args.responseType === "text") {
+                body = yield response.text();
+            }
+            else {
+                const text = yield response.text();
+                if (text.length > 0) {
+                    try {
+                        body = JSON.parse(text);
+                    }
+                    catch (err) {
+                        return {
+                            ok: false,
+                            error: {
+                                reason: "non-json",
+                                statusCode: response.status,
+                                rawBody: text,
+                            },
+                        };
+                    }
+                }
+            }
+            if (response.status >= 200 && response.status < 400) {
+                return {
+                    ok: true,
+                    body: body,
+                    headers: response.headers,
+                };
+            }
+            else {
+                return {
+                    ok: false,
+                    error: {
+                        reason: "status-code",
+                        statusCode: response.status,
+                        body,
+                    },
+                };
+            }
+        }
+        catch (error) {
+            if (args.abortSignal != null && args.abortSignal.aborted) {
+                return {
+                    ok: false,
+                    error: {
+                        reason: "unknown",
+                        errorMessage: "The user aborted a request",
+                    },
+                };
+            }
+            else if (error instanceof Error && error.name === "AbortError") {
+                return {
+                    ok: false,
+                    error: {
+                        reason: "timeout",
+                    },
+                };
+            }
+            else if (error instanceof Error) {
+                return {
+                    ok: false,
+                    error: {
+                        reason: "unknown",
+                        errorMessage: error.message,
+                    },
+                };
+            }
+            return {
+                ok: false,
+                error: {
+                    reason: "unknown",
+                    errorMessage: JSON.stringify(error),
+                },
+            };
+        }
+    });
+}
+const TIMEOUT = "timeout";
+function getTimeoutSignal(timeoutMs) {
+    const controller = new AbortController();
+    const abortId = setTimeout(() => controller.abort(TIMEOUT), timeoutMs);
+    return { signal: controller.signal, abortId };
+}
+/**
+ * Returns an abort signal that is getting aborted when
+ * at least one of the specified abort signals is aborted.
+ *
+ * Requires at least node.js 18.
+ */
+function anySignal(...args) {
+    // Allowing signals to be passed either as array
+    // of signals or as multiple arguments.
+    const signals = (args.length === 1 && Array.isArray(args[0]) ? args[0] : args);
+    const controller = new AbortController();
+    for (const signal of signals) {
+        if (signal.aborted) {
+            // Exiting early if one of the signals
+            // is already aborted.
+            controller.abort(signal === null || signal === void 0 ? void 0 : signal.reason);
+            break;
+        }
+        // Listening for signals and removing the listeners
+        // when at least one symbol is aborted.
+        signal.addEventListener("abort", () => controller.abort(signal === null || signal === void 0 ? void 0 : signal.reason), {
+            signal: controller.signal,
+        });
+    }
+    return controller.signal;
+}
+/**
+ * Returns a fetch function based on the runtime
+ */
+function getFetchFn() {
+    return __awaiter(this, void 0, void 0, function* () {
+        // In Node.js environments, the SDK always uses`node-fetch`.
+        if (RUNTIME.type === "node") {
+            return (yield import("node-fetch")).default;
+        }
+        // Otherwise the SDK uses global fetch if available,
+        // and falls back to node-fetch.
+        if (typeof fetch == "function") {
+            return fetch;
+        }
+        // Defaults to node `node-fetch` if global fetch isn't available
+        return (yield import("node-fetch")).default;
+    });
+}
+export const fetcher = fetcherImpl;

package/core/fetcher/Supplier.d.ts

@@ -0,0 +1,4 @@
+export declare type Supplier<T> = T | Promise<T> | (() => T | Promise<T>);
+export declare const Supplier: {
+    get: <T>(supplier: Supplier<T>) => Promise<T>;
+};