@credal/sdk 0.0.3

package/core/schemas/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./builders";
+export type { inferParsed, inferRaw, Schema, SchemaOptions } from "./Schema";

package/core/schemas/index.js

@@ -0,0 +1,17 @@
+"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("./builders"), exports);

package/core/schemas/utils/MaybePromise.d.ts

@@ -0,0 +1 @@
+export declare type MaybePromise<T> = T | Promise<T>;

package/core/schemas/utils/MaybePromise.js

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

package/core/schemas/utils/addQuestionMarksToNullableProperties.d.ts

@@ -0,0 +1,7 @@
+export declare type addQuestionMarksToNullableProperties<T> = {
+    [K in OptionalKeys<T>]?: T[K];
+} & Pick<T, RequiredKeys<T>>;
+export declare type OptionalKeys<T> = {
+    [K in keyof T]-?: undefined extends T[K] ? K : null extends T[K] ? K : 1 extends (any extends T[K] ? 0 : 1) ? never : K;
+}[keyof T];
+export declare type RequiredKeys<T> = Exclude<keyof T, OptionalKeys<T>>;

package/core/schemas/utils/addQuestionMarksToNullableProperties.js

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

package/core/schemas/utils/createIdentitySchemaCreator.d.ts

@@ -0,0 +1,2 @@
+import { MaybeValid, Schema, SchemaOptions, SchemaType } from "../Schema";
+export declare function createIdentitySchemaCreator<T>(schemaType: SchemaType, validate: (value: unknown, opts?: SchemaOptions) => MaybeValid<T>): () => Schema<T, T>;

package/core/schemas/utils/createIdentitySchemaCreator.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createIdentitySchemaCreator = void 0;
+const schema_utils_1 = require("../builders/schema-utils");
+const maybeSkipValidation_1 = require("./maybeSkipValidation");
+function createIdentitySchemaCreator(schemaType, validate) {
+    return () => {
+        const baseSchema = {
+            parse: validate,
+            json: validate,
+            getType: () => schemaType,
+        };
+        return Object.assign(Object.assign({}, (0, maybeSkipValidation_1.maybeSkipValidation)(baseSchema)), (0, schema_utils_1.getSchemaUtils)(baseSchema));
+    };
+}
+exports.createIdentitySchemaCreator = createIdentitySchemaCreator;

package/core/schemas/utils/entries.d.ts

@@ -0,0 +1 @@
+export declare function entries<T>(object: T): [keyof T, T[keyof T]][];

package/core/schemas/utils/entries.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.entries = void 0;
+function entries(object) {
+    return Object.entries(object);
+}
+exports.entries = entries;

package/core/schemas/utils/filterObject.d.ts

@@ -0,0 +1 @@
+export declare function filterObject<T, K extends keyof T>(obj: T, keysToInclude: K[]): Pick<T, K>;

package/core/schemas/utils/filterObject.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.filterObject = void 0;
+function filterObject(obj, keysToInclude) {
+    const keysToIncludeSet = new Set(keysToInclude);
+    return Object.entries(obj).reduce((acc, [key, value]) => {
+        if (keysToIncludeSet.has(key)) {
+            acc[key] = value;
+        }
+        return acc;
+        // eslint-disable-next-line @typescript-eslint/prefer-reduce-type-parameter
+    }, {});
+}
+exports.filterObject = filterObject;

package/core/schemas/utils/getErrorMessageForIncorrectType.d.ts

@@ -0,0 +1 @@
+export declare function getErrorMessageForIncorrectType(value: unknown, expectedType: string): string;

package/core/schemas/utils/getErrorMessageForIncorrectType.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getErrorMessageForIncorrectType = void 0;
+function getErrorMessageForIncorrectType(value, expectedType) {
+    return `Expected ${expectedType}. Received ${getTypeAsString(value)}.`;
+}
+exports.getErrorMessageForIncorrectType = getErrorMessageForIncorrectType;
+function getTypeAsString(value) {
+    if (Array.isArray(value)) {
+        return "list";
+    }
+    if (value === null) {
+        return "null";
+    }
+    switch (typeof value) {
+        case "string":
+            return `"${value}"`;
+        case "number":
+        case "boolean":
+        case "undefined":
+            return `${value}`;
+    }
+    return typeof value;
+}

package/core/schemas/utils/isPlainObject.d.ts

@@ -0,0 +1 @@
+export declare function isPlainObject(value: unknown): value is Record<string, unknown>;

package/core/schemas/utils/isPlainObject.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPlainObject = void 0;
+// borrowed from https://github.com/lodash/lodash/blob/master/isPlainObject.js
+function isPlainObject(value) {
+    if (typeof value !== "object" || value === null) {
+        return false;
+    }
+    if (Object.getPrototypeOf(value) === null) {
+        return true;
+    }
+    let proto = value;
+    while (Object.getPrototypeOf(proto) !== null) {
+        proto = Object.getPrototypeOf(proto);
+    }
+    return Object.getPrototypeOf(value) === proto;
+}
+exports.isPlainObject = isPlainObject;

package/core/schemas/utils/keys.d.ts

@@ -0,0 +1 @@
+export declare function keys<T>(object: T): (keyof T)[];

package/core/schemas/utils/keys.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.keys = void 0;
+function keys(object) {
+    return Object.keys(object);
+}
+exports.keys = keys;

package/core/schemas/utils/maybeSkipValidation.d.ts

@@ -0,0 +1,2 @@
+import { BaseSchema } from "../Schema";
+export declare function maybeSkipValidation<S extends BaseSchema<Raw, Parsed>, Raw, Parsed>(schema: S): S;

package/core/schemas/utils/maybeSkipValidation.js

@@ -0,0 +1,37 @@
+"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.maybeSkipValidation = void 0;
+function maybeSkipValidation(schema) {
+    return Object.assign(Object.assign({}, schema), { json: transformAndMaybeSkipValidation(schema.json), parse: transformAndMaybeSkipValidation(schema.parse) });
+}
+exports.maybeSkipValidation = maybeSkipValidation;
+function transformAndMaybeSkipValidation(transform) {
+    return (value, opts) => __awaiter(this, void 0, void 0, function* () {
+        const transformed = yield transform(value, opts);
+        const { skipValidation = false } = opts !== null && opts !== void 0 ? opts : {};
+        if (!transformed.ok && skipValidation) {
+            // eslint-disable-next-line no-console
+            console.warn([
+                "Failed to validate.",
+                ...transformed.errors.map((error) => "  - " +
+                    (error.path.length > 0 ? `${error.path.join(".")}: ${error.message}` : error.message)),
+            ].join("\n"));
+            return {
+                ok: true,
+                value: value,
+            };
+        }
+        else {
+            return transformed;
+        }
+    });
+}

package/core/schemas/utils/partition.d.ts

@@ -0,0 +1 @@
+export declare function partition<T>(items: readonly T[], predicate: (item: T) => boolean): [T[], T[]];

package/core/schemas/utils/partition.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.partition = void 0;
+function partition(items, predicate) {
+    const trueItems = [], falseItems = [];
+    for (const item of items) {
+        if (predicate(item)) {
+            trueItems.push(item);
+        }
+        else {
+            falseItems.push(item);
+        }
+    }
+    return [trueItems, falseItems];
+}
+exports.partition = partition;

package/dist/Client.d.ts

@@ -0,0 +1,39 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "./environments";
+import * as core from "./core";
+import { Copilots } from "./api/resources/copilots/client/Client";
+import { DocumentCatalog } from "./api/resources/documentCatalog/client/Client";
+import { DocumentCollections } from "./api/resources/documentCollections/client/Client";
+import { PermissionsService } from "./api/resources/permissionsService/client/Client";
+import { Search } from "./api/resources/search/client/Client";
+import { Users } from "./api/resources/users/client/Client";
+export declare namespace CredalClient {
+    interface Options {
+        environment?: core.Supplier<environments.CredalEnvironment | string>;
+        apiKey?: core.Supplier<core.BearerToken | undefined>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        timeoutInSeconds?: number;
+        maxRetries?: number;
+        abortSignal?: AbortSignal;
+    }
+}
+export declare class CredalClient {
+    protected readonly _options: CredalClient.Options;
+    constructor(_options?: CredalClient.Options);
+    protected _copilots: Copilots | undefined;
+    get copilots(): Copilots;
+    protected _documentCatalog: DocumentCatalog | undefined;
+    get documentCatalog(): DocumentCatalog;
+    protected _documentCollections: DocumentCollections | undefined;
+    get documentCollections(): DocumentCollections;
+    protected _permissionsService: PermissionsService | undefined;
+    get permissionsService(): PermissionsService;
+    protected _search: Search | undefined;
+    get search(): Search;
+    protected _users: Users | undefined;
+    get users(): Users;
+}

package/dist/Client.js

@@ -0,0 +1,42 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CredalClient = void 0;
+const Client_1 = require("./api/resources/copilots/client/Client");
+const Client_2 = require("./api/resources/documentCatalog/client/Client");
+const Client_3 = require("./api/resources/documentCollections/client/Client");
+const Client_4 = require("./api/resources/permissionsService/client/Client");
+const Client_5 = require("./api/resources/search/client/Client");
+const Client_6 = require("./api/resources/users/client/Client");
+class CredalClient {
+    constructor(_options = {}) {
+        this._options = _options;
+    }
+    get copilots() {
+        var _a;
+        return ((_a = this._copilots) !== null && _a !== void 0 ? _a : (this._copilots = new Client_1.Copilots(this._options)));
+    }
+    get documentCatalog() {
+        var _a;
+        return ((_a = this._documentCatalog) !== null && _a !== void 0 ? _a : (this._documentCatalog = new Client_2.DocumentCatalog(this._options)));
+    }
+    get documentCollections() {
+        var _a;
+        return ((_a = this._documentCollections) !== null && _a !== void 0 ? _a : (this._documentCollections = new Client_3.DocumentCollections(this._options)));
+    }
+    get permissionsService() {
+        var _a;
+        return ((_a = this._permissionsService) !== null && _a !== void 0 ? _a : (this._permissionsService = new Client_4.PermissionsService(this._options)));
+    }
+    get search() {
+        var _a;
+        return ((_a = this._search) !== null && _a !== void 0 ? _a : (this._search = new Client_5.Search(this._options)));
+    }
+    get users() {
+        var _a;
+        return ((_a = this._users) !== null && _a !== void 0 ? _a : (this._users = new Client_6.Users(this._options)));
+    }
+}
+exports.CredalClient = CredalClient;

package/dist/api/index.d.ts

@@ -0,0 +1 @@
+export * from "./resources";

package/dist/api/index.js

@@ -0,0 +1,17 @@
+"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("./resources"), exports);

package/dist/api/resources/common/index.d.ts

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

package/dist/api/resources/common/index.js

@@ -0,0 +1,17 @@
+"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("./types"), exports);

package/dist/api/resources/common/types/ExternalResourceId.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index";
+export interface ExternalResourceId {
+    externalResourceId: string;
+    resourceType: Credal.ResourceType;
+}

package/dist/api/resources/common/types/ExternalResourceId.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/dist/api/resources/common/types/ResourceIdentifier.d.ts

@@ -0,0 +1,13 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Credal from "../../../index";
+export declare type ResourceIdentifier = Credal.ResourceIdentifier.ExternalResourceId | Credal.ResourceIdentifier.Url;
+export declare namespace ResourceIdentifier {
+    interface ExternalResourceId extends Credal.ExternalResourceId {
+        type: "external-resource-id";
+    }
+    interface Url extends Credal.Url {
+        type: "url";
+    }
+}

package/dist/api/resources/common/types/ResourceIdentifier.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/dist/api/resources/common/types/ResourceType.d.ts

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type ResourceType = "GOOGLE_DRIVE_ITEM" | "MICROSOFT_DRIVE_ITEM" | "ZENDESK_TICKET" | "ZENDESK_ARTICLE" | "ZENDESK_GROUP" | "ZENDESK_ARTICLE_SECTION" | "CONFLUENCE_PAGE" | "CONFLUENCE_SPACE" | "JIRA_TICKET" | "JIRA_PROJECT" | "SALESFORCE_TASK" | "BOX_FILE" | "BOX_FOLDER" | "NOTION_PAGE" | "UNKNOWN";
+export declare const ResourceType: {
+    readonly GoogleDriveItem: "GOOGLE_DRIVE_ITEM";
+    readonly MicrosoftDriveItem: "MICROSOFT_DRIVE_ITEM";
+    readonly ZendeskTicket: "ZENDESK_TICKET";
+    readonly ZendeskArticle: "ZENDESK_ARTICLE";
+    readonly ZendeskGroup: "ZENDESK_GROUP";
+    readonly ZendeskArticleSection: "ZENDESK_ARTICLE_SECTION";
+    readonly ConfluencePage: "CONFLUENCE_PAGE";
+    readonly ConfluenceSpace: "CONFLUENCE_SPACE";
+    readonly JiraTicket: "JIRA_TICKET";
+    readonly JiraProject: "JIRA_PROJECT";
+    readonly SalesforceTask: "SALESFORCE_TASK";
+    readonly BoxFile: "BOX_FILE";
+    readonly BoxFolder: "BOX_FOLDER";
+    readonly NotionPage: "NOTION_PAGE";
+    readonly Unknown: "UNKNOWN";
+};

package/dist/api/resources/common/types/ResourceType.js

@@ -0,0 +1,23 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResourceType = void 0;
+exports.ResourceType = {
+    GoogleDriveItem: "GOOGLE_DRIVE_ITEM",
+    MicrosoftDriveItem: "MICROSOFT_DRIVE_ITEM",
+    ZendeskTicket: "ZENDESK_TICKET",
+    ZendeskArticle: "ZENDESK_ARTICLE",
+    ZendeskGroup: "ZENDESK_GROUP",
+    ZendeskArticleSection: "ZENDESK_ARTICLE_SECTION",
+    ConfluencePage: "CONFLUENCE_PAGE",
+    ConfluenceSpace: "CONFLUENCE_SPACE",
+    JiraTicket: "JIRA_TICKET",
+    JiraProject: "JIRA_PROJECT",
+    SalesforceTask: "SALESFORCE_TASK",
+    BoxFile: "BOX_FILE",
+    BoxFolder: "BOX_FOLDER",
+    NotionPage: "NOTION_PAGE",
+    Unknown: "UNKNOWN",
+};

package/dist/api/resources/common/types/Url.d.ts

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

package/dist/api/resources/common/types/Url.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/dist/api/resources/common/types/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./ResourceIdentifier";
+export * from "./ExternalResourceId";
+export * from "./Url";
+export * from "./ResourceType";

package/dist/api/resources/common/types/index.js

@@ -0,0 +1,20 @@
+"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("./ResourceIdentifier"), exports);
+__exportStar(require("./ExternalResourceId"), exports);
+__exportStar(require("./Url"), exports);
+__exportStar(require("./ResourceType"), exports);

package/dist/api/resources/copilots/client/Client.d.ts

@@ -0,0 +1,46 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments";
+import * as core from "../../../../core";
+import * as Credal from "../../../index";
+export declare namespace Copilots {
+    interface Options {
+        environment?: core.Supplier<environments.CredalEnvironment | string>;
+        apiKey?: core.Supplier<core.BearerToken | undefined>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        timeoutInSeconds?: number;
+        maxRetries?: number;
+        abortSignal?: AbortSignal;
+    }
+}
+export declare class Copilots {
+    protected readonly _options: Copilots.Options;
+    constructor(_options?: Copilots.Options);
+    /**
+     * OPTIONAL. Create a new conversation with the Copilot. The conversation ID can be used in the sendMessage endpoint. The sendMessage endpoint automatically creates new conversations upon first request, but calling this endpoint can simplify certain use cases where it is helpful for the application to have the conversation ID before the first message is sent.
+     *
+     * @param {Credal.CreateConversationRequest} request
+     * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await credal.copilots.createConversation({
+     *         userEmail: "ravin@credal.ai"
+     *     })
+     */
+    createConversation(request: Credal.CreateConversationRequest, requestOptions?: Copilots.RequestOptions): Promise<Credal.CreateConversationResponse>;
+    /**
+     * @param {Credal.SendMessageRequest} request
+     * @param {Copilots.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await credal.copilots.sendMessage({
+     *         message: "Is Credal SOC 2 compliant?",
+     *         userEmail: "ravin@credal.ai"
+     *     })
+     */
+    sendMessage(request: Credal.SendMessageRequest, requestOptions?: Copilots.RequestOptions): Promise<Credal.SendAgentMessageResponse>;
+    protected _getAuthorizationHeader(): Promise<string>;
+}