graphlit-client 1.0.20240417002 → 1.0.20240418002

package/LICENSE

@@ -1,21 +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.
+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

@@ -1,53 +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-client
-```
-or
-```bash
-yarn add graphlit-client
-```
-
-## 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.
+# 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-client
+```
+or
+```bash
+yarn add graphlit-client
+```
+
+## 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.d.ts

@@ -0,0 +1,88 @@
+import { ApolloClient, NormalizedCacheObject } from '@apollo/client';
+import * as Types from './generated/graphql-types';
+declare class Graphlit {
+    client: ApolloClient<NormalizedCacheObject>;
+    private apiUri;
+    private environmentId;
+    private organizationId;
+    private ownerId;
+    private jwtSecret;
+    private correlationId;
+    private token;
+    constructor(organizationId?: string, environmentId?: string, jwtSecret?: string, ownerId?: string, apiUri?: string, correlationId?: string);
+    alert(): {
+        create: (alert: Types.AlertInput) => Promise<any>;
+        update: (alert: Types.AlertUpdateInput) => Promise<any>;
+        delete: (id: string) => Promise<any>;
+        deleteAll: (mutation?: any) => Promise<any>;
+        enable: (id: string) => Promise<any>;
+        disable: (id: string) => Promise<any>;
+        get: (id: string) => Promise<any>;
+        query: (filter: Types.AlertFilter) => Promise<any>;
+    };
+    collection(): {
+        create: (collection: Types.CollectionInput) => Promise<any>;
+        update: (collection: Types.CollectionUpdateInput) => Promise<any>;
+        delete: (id: string) => Promise<any>;
+        add: (contents: Types.EntityReferenceInput[], collections: Types.EntityReferenceInput[]) => Promise<any>;
+        remove: (contents: Types.EntityReferenceInput[], collection: Types.EntityReferenceInput) => Promise<any>;
+        get: (id: string) => Promise<any>;
+        query: (filter: Types.CollectionFilter) => Promise<any>;
+    };
+    content(): {
+        ingestUri: (uri: string, name?: string, id?: string, isSynchronous?: boolean, workflow?: Types.EntityReferenceInput) => Promise<any>;
+        ingestText: (name: string, text: string, textType?: Types.TextTypes, uri?: string, id?: string, isSynchronous?: boolean, workflow?: Types.EntityReferenceInput) => Promise<any>;
+        ingestEncodedFile: (name: string, data: string, mimeType: string, id?: string, isSynchronous?: boolean, workflow?: Types.EntityReferenceInput) => Promise<any>;
+        update: (content: Types.ContentUpdateInput) => Promise<any>;
+        delete: (id: string) => Promise<any>;
+        deleteAll: (mutation?: any) => Promise<any>;
+        summarize: (summarizations: [Types.SummarizationStrategyInput], filter?: Types.ContentFilter) => Promise<any>;
+        extract: (prompt: string, filter?: Types.ContentFilter, specification?: Types.EntityReferenceInput) => Promise<any>;
+        publish: (summaryPrompt: string, summarySpecification: Types.EntityReferenceInput, connector: Types.ContentPublishingConnectorInput, publishPrompt?: string, publishSpecification?: Types.EntityReferenceInput, name?: string, filter?: Types.ContentFilter, workflow?: Types.EntityReferenceInput) => Promise<any>;
+        get: (id: string) => Promise<any>;
+        query: (filter: Types.ContentFilter) => Promise<any>;
+    };
+    conversation(): {
+        create: (conversation: Types.ConversationInput) => Promise<any>;
+        update: (conversation: Types.ConversationUpdateInput) => Promise<any>;
+        delete: (id: string) => Promise<any>;
+        deleteAll: (mutation?: any) => Promise<any>;
+        clear: (id: string) => Promise<any>;
+        close: (id: string) => Promise<any>;
+        prompt: (prompt: string, id?: string) => Promise<any>;
+        publish: (id: string, connector: Types.ContentPublishingConnectorInput, name?: string, workflow?: Types.EntityReferenceInput) => Promise<any>;
+        suggest: (id: string, count?: number) => Promise<any>;
+        get: (id: string) => Promise<any>;
+        query: (filter: Types.ConversationFilter) => Promise<any>;
+    };
+    feed(): {
+        create: (feed: Types.FeedInput) => Promise<any>;
+        update: (feed: Types.FeedUpdateInput) => Promise<any>;
+        delete: (id: string) => Promise<any>;
+        deleteAll: (mutation?: any) => Promise<any>;
+        enable: (id: string) => Promise<any>;
+        disable: (id: string) => Promise<any>;
+        get: (id: string) => Promise<any>;
+        query: (filter: Types.FeedFilter) => Promise<any>;
+    };
+    project(): void;
+    specification(): {
+        create: (specification: Types.SpecificationInput) => Promise<any>;
+        update: (specification: Types.SpecificationUpdateInput) => Promise<any>;
+        delete: (id: string) => Promise<any>;
+        prompt: (prompt: string, ids: [string]) => Promise<any>;
+        get: (id: string) => Promise<any>;
+        query: (filter: Types.SpecificationFilter) => Promise<any>;
+    };
+    workflow(): {
+        create: (workflow: Types.WorkflowInput) => Promise<any>;
+        update: (workflow: Types.WorkflowUpdateInput) => Promise<any>;
+        delete: (id: string) => Promise<any>;
+        deleteAll: (mutation?: any) => Promise<any>;
+        get: (id: string) => Promise<any>;
+        query: (filter: Types.WorkflowFilter) => Promise<any>;
+    };
+    private mutateAndCheckError;
+    private queryAndCheckError;
+}
+export { Graphlit };

package/dist/client.js

@@ -41,10 +41,10 @@ const dotenv = __importStar(require("dotenv"));
 dotenv.config();
 // Define the Graphlit class
 class Graphlit {
-    constructor(environmentId, organizationId, jwtSecret, ownerId, apiUri, correlationId) {
+    constructor(organizationId, environmentId, 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.environmentId = environmentId || process.env.GRAPHLIT_ENVIRONMENT_ID;
         this.jwtSecret = jwtSecret || process.env.GRAPHLIT_JWT_SECRET;
         // optional: for multi-tenant support
         this.ownerId = ownerId || process.env.GRAPHLIT_OWNER_ID;

package/dist/generated/graphql-documents.d.ts

@@ -0,0 +1,72 @@
+export declare const CreateAlert: import("graphql").DocumentNode;
+export declare const DeleteAlert: import("graphql").DocumentNode;
+export declare const DeleteAlerts: import("graphql").DocumentNode;
+export declare const DeleteAllAlerts: import("graphql").DocumentNode;
+export declare const DisableAlert: import("graphql").DocumentNode;
+export declare const EnableAlert: import("graphql").DocumentNode;
+export declare const GetAlert: import("graphql").DocumentNode;
+export declare const QueryAlerts: import("graphql").DocumentNode;
+export declare const UpdateAlert: import("graphql").DocumentNode;
+export declare const AddContentsToCollections: import("graphql").DocumentNode;
+export declare const CreateCollection: import("graphql").DocumentNode;
+export declare const DeleteCollection: import("graphql").DocumentNode;
+export declare const DeleteCollections: import("graphql").DocumentNode;
+export declare const GetCollection: import("graphql").DocumentNode;
+export declare const QueryCollections: import("graphql").DocumentNode;
+export declare const RemoveContentsFromCollection: import("graphql").DocumentNode;
+export declare const UpdateCollection: import("graphql").DocumentNode;
+export declare const DeleteAllContents: import("graphql").DocumentNode;
+export declare const DeleteContent: import("graphql").DocumentNode;
+export declare const DeleteContents: import("graphql").DocumentNode;
+export declare const ExtractContents: import("graphql").DocumentNode;
+export declare const GetContent: import("graphql").DocumentNode;
+export declare const IngestEncodedFile: import("graphql").DocumentNode;
+export declare const IngestText: import("graphql").DocumentNode;
+export declare const IngestUri: import("graphql").DocumentNode;
+export declare const IsContentDone: import("graphql").DocumentNode;
+export declare const PublishContents: import("graphql").DocumentNode;
+export declare const QueryContentFacets: import("graphql").DocumentNode;
+export declare const QueryContents: import("graphql").DocumentNode;
+export declare const SummarizeContents: import("graphql").DocumentNode;
+export declare const UpdateContent: import("graphql").DocumentNode;
+export declare const ClearConversation: import("graphql").DocumentNode;
+export declare const CloseConversation: import("graphql").DocumentNode;
+export declare const CreateConversation: import("graphql").DocumentNode;
+export declare const DeleteAllConversations: import("graphql").DocumentNode;
+export declare const DeleteConversation: import("graphql").DocumentNode;
+export declare const DeleteConversations: import("graphql").DocumentNode;
+export declare const GetConversation: import("graphql").DocumentNode;
+export declare const PromptConversation: import("graphql").DocumentNode;
+export declare const PublishConversation: import("graphql").DocumentNode;
+export declare const QueryConversations: import("graphql").DocumentNode;
+export declare const SuggestConversation: import("graphql").DocumentNode;
+export declare const UpdateConversation: import("graphql").DocumentNode;
+export declare const CreateFeed: import("graphql").DocumentNode;
+export declare const DeleteAllFeeds: import("graphql").DocumentNode;
+export declare const DeleteFeed: import("graphql").DocumentNode;
+export declare const DeleteFeeds: import("graphql").DocumentNode;
+export declare const DisableFeed: import("graphql").DocumentNode;
+export declare const EnableFeed: import("graphql").DocumentNode;
+export declare const GetFeed: import("graphql").DocumentNode;
+export declare const IsFeedDone: import("graphql").DocumentNode;
+export declare const QueryFeeds: import("graphql").DocumentNode;
+export declare const UpdateFeed: import("graphql").DocumentNode;
+export declare const Credits: import("graphql").DocumentNode;
+export declare const LookupCredits: import("graphql").DocumentNode;
+export declare const LookupUsage: import("graphql").DocumentNode;
+export declare const Project: import("graphql").DocumentNode;
+export declare const UpdateProject: import("graphql").DocumentNode;
+export declare const Usage: import("graphql").DocumentNode;
+export declare const CreateSpecification: import("graphql").DocumentNode;
+export declare const DeleteSpecification: import("graphql").DocumentNode;
+export declare const GetSpecification: import("graphql").DocumentNode;
+export declare const PromptSpecifications: import("graphql").DocumentNode;
+export declare const QuerySpecifications: import("graphql").DocumentNode;
+export declare const UpdateSpecification: import("graphql").DocumentNode;
+export declare const CreateWorkflow: import("graphql").DocumentNode;
+export declare const DeleteAllWorkflows: import("graphql").DocumentNode;
+export declare const DeleteWorkflow: import("graphql").DocumentNode;
+export declare const DeleteWorkflows: import("graphql").DocumentNode;
+export declare const GetWorkflow: import("graphql").DocumentNode;
+export declare const QueryWorkflows: import("graphql").DocumentNode;
+export declare const UpdateWorkflow: import("graphql").DocumentNode;