graphlit-client 1.0.20240417001

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Unstruk Data Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,53 @@
+# TypeScript Client for Graphlit Platform
+## Overview
+
+The Graphlit Client for Node.js enables straightforward interactions with the Graphlit API, allowing developers to execute GraphQL queries and mutations against the Graphlit service. This document outlines the setup process and provides a basic example of using the client.
+
+## Prerequisites
+
+Before you begin, ensure you have the following:
+
+- Node.js installed on your system (recommended version 20.x or higher).
+- An active account on the [Graphlit Platform](https://portal.graphlit.dev) with access to the API settings dashboard.
+
+## Installation
+
+To install the Graphlit Client, use npm or yarn:
+
+```bash
+npm install graphlit
+```
+or
+```bash
+yarn add graphlit
+```
+
+## Configuration
+
+The Graphlit Client supports environment variables to be set for authentication and configuration:
+
+- `GRAPHLIT_ENVIRONMENT_ID`: Your environment ID.
+- `GRAPHLIT_ORGANIZATION_ID`: Your organization ID.
+- `GRAPHLIT_JWT_SECRET`: Your JWT secret for signing the JWT token.
+
+Alternately, you can pass these values with the constructor of the Graphlit client.
+
+You can find these values in the API settings dashboard on the [Graphlit Platform](https://portal.graphlit.dev).
+
+### Setting Environment Variables
+
+To set these environment variables on your system, you can place them in a `.env` file at the root of your project:
+
+```env
+GRAPHLIT_ENVIRONMENT_ID=your_environment_id_value
+GRAPHLIT_ORGANIZATION_ID=your_organization_id_value
+GRAPHLIT_JWT_SECRET=your_jwt_secret_value
+```
+
+## Support
+
+Please refer to the [Graphlit API Documentation](https://docs.graphlit.dev/).
+
+For support with the Graphlit Client, please submit a [GitHub Issue](https://github.com/graphlit/graphlit-client-typescript/issues).  
+
+For further support with the Graphlit Platform, please join our [Discord](https://discord.gg/ygFmfjy3Qx) community.

package/dist/client.js

@@ -0,0 +1,320 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+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.Graphlit = void 0;
+const client_1 = require("@apollo/client");
+const Documents = __importStar(require("./generated/graphql-documents"));
+const jwt = __importStar(require("jsonwebtoken"));
+const dotenv = __importStar(require("dotenv"));
+// Initialize dotenv to use environment variables
+dotenv.config();
+// Define the Graphlit class
+class Graphlit {
+    constructor(environmentId, organizationId, jwtSecret, ownerId, apiUri, correlationId) {
+        this.apiUri = apiUri || "https://data-scus.graphlit.io/api/v1";
+        this.environmentId = environmentId || process.env.GRAPHLIT_ENVIRONMENT_ID;
+        this.organizationId = organizationId || process.env.GRAPHLIT_ORGANIZATION_ID;
+        this.jwtSecret = jwtSecret || process.env.GRAPHLIT_JWT_SECRET;
+        // optional: for multi-tenant support
+        this.ownerId = ownerId || process.env.GRAPHLIT_OWNER_ID;
+        // optional: for billing correlation of multiple operations
+        this.correlationId = correlationId || undefined;
+        // Set token expiration to one hour from now
+        const expiration = Math.floor(Date.now() / 1000) + (60 * 60);
+        const payload = {
+            "https://graphlit.io/jwt/claims": Object.assign(Object.assign({ "x-graphlit-environment-id": this.environmentId, "x-graphlit-organization-id": this.organizationId }, (this.ownerId && { "x-graphlit-owner-id": this.ownerId })), { "x-graphlit-role": "Owner" }),
+            exp: expiration,
+            iss: "graphlit",
+            aud: "https://portal.graphlit.io",
+        };
+        if (!this.jwtSecret) {
+            throw new Error("JWT secret is required.");
+        }
+        this.token = jwt.sign(payload, this.jwtSecret, { algorithm: 'HS256' });
+        const httpLink = (0, client_1.createHttpLink)({
+            uri: this.apiUri,
+        });
+        const authLink = new client_1.ApolloLink((operation, forward) => {
+            operation.setContext({
+                headers: {
+                    Authorization: this.token ? `Bearer ${this.token}` : "",
+                }
+            });
+            return forward(operation);
+        });
+        this.client = new client_1.ApolloClient({
+            link: authLink.concat(httpLink),
+            cache: new client_1.InMemoryCache(),
+        });
+    }
+    alert() {
+        return {
+            create: (alert) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.CreateAlert, { alert: alert, correlationId: this.correlationId });
+            }),
+            update: (alert) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.UpdateAlert, { alert: alert });
+            }),
+            delete: (id) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.DeleteAlert, { id: id });
+            }),
+            deleteAll: (mutation) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.DeleteAllAlerts);
+            }),
+            enable: (id) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.EnableAlert, { id: id });
+            }),
+            disable: (id) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.DisableAlert, { id: id });
+            }),
+            get: (id) => __awaiter(this, void 0, void 0, function* () {
+                return this.queryAndCheckError(Documents.GetAlert, { id: id });
+            }),
+            query: (filter) => __awaiter(this, void 0, void 0, function* () {
+                return this.queryAndCheckError(Documents.QueryAlerts, { filter: filter });
+            }),
+        };
+    }
+    collection() {
+        return {
+            create: (collection) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.CreateCollection, { collection: collection });
+            }),
+            update: (collection) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.UpdateCollection, { collection: collection });
+            }),
+            delete: (id) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.DeleteCollection, { id: id });
+            }),
+            /*
+            deleteAll: async (mutation?: any) => {
+              return this.mutateAndCheckError(Documents.DeleteAllCollections);
+            },
+            */
+            add: (contents, collections) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.AddContentsToCollections, { contents: contents, collections: collections });
+            }),
+            remove: (contents, collection) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.RemoveContentsFromCollection, { contents: contents, collection: collection });
+            }),
+            get: (id) => __awaiter(this, void 0, void 0, function* () {
+                return this.queryAndCheckError(Documents.GetCollection, { id: id });
+            }),
+            query: (filter) => __awaiter(this, void 0, void 0, function* () {
+                return this.queryAndCheckError(Documents.QueryCollections, { filter: filter });
+            }),
+        };
+    }
+    content() {
+        return {
+            ingestUri: (uri, name, id, isSynchronous, workflow) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.IngestUri, { uri: uri, name: name, id: id, isSynchronous: isSynchronous, workflow: workflow, correlationId: this.correlationId });
+            }),
+            ingestText: (name, text, textType, uri, id, isSynchronous, workflow) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.IngestText, { name: name, text: text, textType: textType, uri: uri, id: id, isSynchronous: isSynchronous, workflow: workflow, correlationId: this.correlationId });
+            }),
+            ingestEncodedFile: (name, data, mimeType, id, isSynchronous, workflow) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.IngestEncodedFile, { name: name, data: data, mimeType: mimeType, id: id, isSynchronous: isSynchronous, workflow: workflow, correlationId: this.correlationId });
+            }),
+            update: (content) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.UpdateContent, { content: content });
+            }),
+            delete: (id) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.DeleteContent, { id: id });
+            }),
+            deleteAll: (mutation) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.DeleteAllContents);
+            }),
+            summarize: (summarizations, filter) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.SummarizeContents, { summarizations: summarizations, filter: filter, correlationId: this.correlationId });
+            }),
+            extract: (prompt, filter, specification) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.ExtractContents, { prompt: prompt, filter: filter, specification: specification, correlationId: this.correlationId });
+            }),
+            publish: (summaryPrompt, summarySpecification, connector, publishPrompt, publishSpecification, name, filter, workflow) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.PublishContents, { summaryPrompt: summaryPrompt, summarySpecification: summarySpecification, connector: connector, publishPrompt: publishPrompt, publishSpecification: publishSpecification, name: name, filter: filter, workflow: workflow, correlationId: this.correlationId });
+            }),
+            get: (id) => __awaiter(this, void 0, void 0, function* () {
+                return this.queryAndCheckError(Documents.GetContent, { id: id });
+            }),
+            query: (filter) => __awaiter(this, void 0, void 0, function* () {
+                return this.queryAndCheckError(Documents.QueryContents, { filter: filter });
+            }),
+        };
+    }
+    conversation() {
+        return {
+            create: (conversation) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.CreateConversation, { conversation: conversation, correlationId: this.correlationId });
+            }),
+            update: (conversation) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.UpdateConversation, { conversation: conversation });
+            }),
+            delete: (id) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.DeleteConversation, { id: id });
+            }),
+            deleteAll: (mutation) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.DeleteAllConversations);
+            }),
+            clear: (id) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.ClearConversation, { id: id });
+            }),
+            close: (id) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.CloseConversation, { id: id });
+            }),
+            prompt: (prompt, id) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.PromptConversation, { prompt: prompt, id: id, correlationId: this.correlationId });
+            }),
+            publish: (id, connector, name, workflow) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.PublishConversation, { id: id, connector: connector, name: name, workflow: workflow, correlationId: this.correlationId });
+            }),
+            suggest: (id, count) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.SuggestConversation, { id: id, count: count, correlationId: this.correlationId });
+            }),
+            get: (id) => __awaiter(this, void 0, void 0, function* () {
+                return this.queryAndCheckError(Documents.GetConversation, { id: id });
+            }),
+            query: (filter) => __awaiter(this, void 0, void 0, function* () {
+                return this.queryAndCheckError(Documents.QueryConversations, { filter: filter });
+            }),
+        };
+    }
+    feed() {
+        return {
+            create: (feed) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.CreateFeed, { feed: feed, correlationId: this.correlationId });
+            }),
+            update: (feed) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.UpdateFeed, { feed: feed });
+            }),
+            delete: (id) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.DeleteFeed, { id: id });
+            }),
+            deleteAll: (mutation) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.DeleteAllFeeds);
+            }),
+            enable: (id) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.EnableFeed, { id: id });
+            }),
+            disable: (id) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.DisableFeed, { id: id });
+            }),
+            get: (id) => __awaiter(this, void 0, void 0, function* () {
+                return this.queryAndCheckError(Documents.GetFeed, { id: id });
+            }),
+            query: (filter) => __awaiter(this, void 0, void 0, function* () {
+                return this.queryAndCheckError(Documents.QueryFeeds, { filter: filter });
+            }),
+        };
+    }
+    project() {
+        // TODO: credits, usage, etc.
+    }
+    specification() {
+        return {
+            create: (specification) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.CreateSpecification, { specification: specification });
+            }),
+            update: (specification) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.UpdateSpecification, { specification: specification });
+            }),
+            delete: (id) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.DeleteSpecification, { id: id });
+            }),
+            /*
+            deleteAll: async (mutation?: any) => {
+              return this.mutateAndCheckError(Documents.DeleteAllSpecifications);
+            },
+            */
+            prompt: (prompt, ids) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.PromptSpecifications, { prompt: prompt, ids: ids });
+            }),
+            get: (id) => __awaiter(this, void 0, void 0, function* () {
+                return this.queryAndCheckError(Documents.GetSpecification, { id: id });
+            }),
+            query: (filter) => __awaiter(this, void 0, void 0, function* () {
+                return this.queryAndCheckError(Documents.QuerySpecifications, { filter: filter });
+            }),
+        };
+    }
+    workflow() {
+        return {
+            create: (workflow) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.CreateWorkflow, { workflow: workflow });
+            }),
+            update: (workflow) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.UpdateWorkflow, { workflow: workflow });
+            }),
+            delete: (id) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.DeleteWorkflow, { id: id });
+            }),
+            deleteAll: (mutation) => __awaiter(this, void 0, void 0, function* () {
+                return this.mutateAndCheckError(Documents.DeleteAllWorkflows);
+            }),
+            get: (id) => __awaiter(this, void 0, void 0, function* () {
+                return this.queryAndCheckError(Documents.GetWorkflow, { id: id });
+            }),
+            query: (filter) => __awaiter(this, void 0, void 0, function* () {
+                return this.queryAndCheckError(Documents.QueryWorkflows, { filter: filter });
+            }),
+        };
+    }
+    mutateAndCheckError(mutation, variables) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const result = yield this.client.mutate({
+                mutation,
+                variables,
+            });
+            if (result.errors && result.errors.length > 0) {
+                const errorMessage = result.errors.map(error => error.message).join("\n");
+                throw new Error(errorMessage);
+            }
+            return result.data;
+        });
+    }
+    queryAndCheckError(query, variables) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const result = yield this.client.query({
+                query,
+                variables,
+            });
+            if (result.errors && result.errors.length > 0) {
+                const errorMessage = result.errors.map(error => error.message).join("\n");
+                throw new Error(errorMessage);
+            }
+            return result.data;
+        });
+    }
+}
+exports.Graphlit = Graphlit;