chore: namananand/ins-3307-add-new-api-end-points-which-where-added-on-the-console (#57)

Because

- add-new-api-end-points-which-where-added-on-the-console

This commit

- add-new-api-end-points-which-where-added-on-the-console

Author: iamnamananand996

package.json

@@ -41,7 +41,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@instill-ai/toolkit": "0.68.0-rc.23",
+    "@instill-ai/toolkit": "0.78.1",
     "@types/json-schema": "^7.0.11",
     "axios": "^1.3.4",
     "json-schema": "^0.4.0",

pnpm-lock.yaml

@@ -1,30 +1,29 @@
 import axios, { AxiosInstance } from "axios";
 import { Nullable } from "../types";
-import {
-  CreateUserConnectorResourcePayload,
-  RenameUserConnectorResourcePayload,
-  UpdateUserConnectorResourcePayload,
-} from "./types";
-import { getQueryString } from "../helper";
 import {
   getConnectorDefinitionQuery,
-  getUserConnectorResourceQuery,
+  getUserConnectorQuery,
   listConnectorDefinitionsQuery,
-  listConnectorResourcesQuery,
-  listUserConnectorResourcesQuery,
-  watchUserConnectorResource,
+  listConnectorsQuery,
+  listUserConnectorsQuery,
+  watchUserConnector,
 } from "./queries";
 import {
-  createUserConnectorResourceMutation,
-  deleteUserConnectorResourceMutation,
-  renameUserConnectorResource,
-  updateUserConnectorResourceMutation,
+  createUserConnectorMutation,
+  deleteUserConnectorMutation,
+  renameUserConnector,
+  updateUserConnectorMutation,
 } from "./mutation";
 import {
-  connectUserConnectorResourceAction,
-  disconnectUserConnectorResourceAction,
-  testUserConnectorResourceConnectionAction,
+  testUserConnectorConnectionAction,
+  connectUserConnectorAction,
+  disconnectUserConnectorAction,
 } from "./action";
+import {
+  CreateUserConnectorPayload,
+  RenameUserConnectorPayload,
+  UpdateUserConnectorPayload,
+} from "./types";
 
 class ConnectorClient {
   private axiosInstance: AxiosInstance;
@@ -44,7 +43,7 @@ class ConnectorClient {
    * Connector Queries
    * -----------------------------------------------------------------------*/
 
-  async listConnectorResourcesQuery({
+  async listConnectorsQuery({
     pageSize,
     nextPageToken,
     filter,
@@ -53,15 +52,15 @@ class ConnectorClient {
     nextPageToken: Nullable<string>;
     filter: Nullable<string>;
   }) {
-    return listConnectorResourcesQuery({
+    return listConnectorsQuery({
       axiosInstance: this.axiosInstance,
       pageSize,
       nextPageToken,
       filter,
     });
   }
 
-  async listUserConnectorResourcesQuery({
+  async listUserConnectorsQuery({
     userName,
     pageSize,
     nextPageToken,
@@ -72,7 +71,7 @@ class ConnectorClient {
     nextPageToken: Nullable<string>;
     filter: Nullable<string>;
   }) {
-    return listUserConnectorResourcesQuery({
+    return listUserConnectorsQuery({
       axiosInstance: this.axiosInstance,
       userName,
       pageSize,
@@ -109,74 +108,66 @@ class ConnectorClient {
     });
   }
 
-  async getUserConnectorResourceQuery({
-    connectorResourceName,
-  }: {
-    connectorResourceName: string;
-  }) {
-    return getUserConnectorResourceQuery({
+  async getUserConnectorQuery({ connectorName }: { connectorName: string }) {
+    return getUserConnectorQuery({
       axiosInstance: this.axiosInstance,
-      connectorResourceName,
+      connectorName,
     });
   }
 
-  async watchUserConnectorResource({
-    connectorResourceName,
-  }: {
-    connectorResourceName: string;
-  }) {
-    return watchUserConnectorResource({
+  async watchUserConnector({ connectorName }: { connectorName: string }) {
+    return watchUserConnector({
       axiosInstance: this.axiosInstance,
-      connectorResourceName,
+      connectorName,
     });
   }
 
   /* -------------------------------------------------------------------------
    * Connector Mutation
    * -----------------------------------------------------------------------*/
 
-  async createUserConnectorResourceMutation({
-    userName,
+  async createUserConnectorMutation({
+    entityName,
     payload,
   }: {
-    userName: string;
-    payload: CreateUserConnectorResourcePayload;
+    entityName: string;
+    payload: CreateUserConnectorPayload;
   }) {
-    return createUserConnectorResourceMutation({
+    return createUserConnectorMutation({
       axiosInstance: this.axiosInstance,
-      userName,
+      entityName,
       payload,
     });
   }
 
-  async deleteUserConnectorResourceMutation({
-    connectorResourceName,
+  async deleteUserConnectorMutation({
+    connectorName,
   }: {
-    connectorResourceName: string;
+    connectorName: string;
   }) {
-    return deleteUserConnectorResourceMutation({
+    return deleteUserConnectorMutation({
       axiosInstance: this.axiosInstance,
-      connectorResourceName,
+      connectorName,
     });
   }
 
-  async updateUserConnectorResourceMutation({
+  async updateUserConnectorMutation({
     payload,
   }: {
-    payload: UpdateUserConnectorResourcePayload;
+    payload: UpdateUserConnectorPayload;
   }) {
-    return updateUserConnectorResourceMutation({
+    return updateUserConnectorMutation({
       axiosInstance: this.axiosInstance,
       payload,
     });
   }
 
-  async renameUserConnectorResource({
+  async renameUserConnector({
     payload,
   }: {
-    payload: RenameUserConnectorResourcePayload;
+    payload: RenameUserConnectorPayload;
   }) {
-    return renameUserConnectorResource({
+    return renameUserConnector({
       axiosInstance: this.axiosInstance,
       payload,
     });
@@ -186,36 +177,36 @@ class ConnectorClient {
    * Connector Action
    * -----------------------------------------------------------------------*/
 
-  async testUserConnectorResourceConnectionAction({
-    connectorResourceName,
+  async testUserConnectorConnectionAction({
+    connectorName,
   }: {
-    connectorResourceName: string;
+    connectorName: string;
   }) {
-    return testUserConnectorResourceConnectionAction({
+    return testUserConnectorConnectionAction({
       axiosInstance: this.axiosInstance,
-      connectorResourceName,
+      connectorName,
     });
   }
 
-  async connectUserConnectorResourceAction({
-    connectorResourceName,
+  async connectUserConnectorAction({
+    connectorName,
   }: {
-    connectorResourceName: string;
+    connectorName: string;
   }) {
-    return connectUserConnectorResourceAction({
+    return connectUserConnectorAction({
       axiosInstance: this.axiosInstance,
-      connectorResourceName,
+      connectorName,
     });
   }
 
-  async disconnectUserConnectorResourceAction({
-    connectorResourceName,
+  async disconnectUserConnectorAction({
+    connectorName,
   }: {
-    connectorResourceName: string;
+    connectorName: string;
   }) {
-    return disconnectUserConnectorResourceAction({
+    return disconnectUserConnectorAction({
       axiosInstance: this.axiosInstance,
-      connectorResourceName,
+      connectorName,
     });
   }
 }

src/connector/ConnectorClient.ts

@@ -1,59 +1,65 @@
 import { AxiosInstance } from "axios";
-import {
-  ConnectUserConnectorResourceResponse,
-  DisconnectUserConnectorResourceResponse,
-  TestUserConnectorResourceConnectionResponse,
-} from "./types";
+import { ConnectorState, ConnectorWithDefinition } from "./types";
 
-export async function testUserConnectorResourceConnectionAction({
+export type TestUserConnectorConnectionResponse = {
+  state: ConnectorState;
+};
+
+export async function testUserConnectorConnectionAction({
   axiosInstance,
-  connectorResourceName,
+  connectorName,
 }: {
   axiosInstance: AxiosInstance;
-  connectorResourceName: string;
+  connectorName: string;
 }) {
   try {
     const { data } =
-      await axiosInstance.post<TestUserConnectorResourceConnectionResponse>(
-        `/${connectorResourceName}/testConnection`
+      await axiosInstance.post<TestUserConnectorConnectionResponse>(
+        `/${connectorName}/testConnection`
       );
     return Promise.resolve(data.state);
   } catch (err) {
     return Promise.reject(err);
   }
 }
 
-export async function connectUserConnectorResourceAction({
+export type ConnectUserConnectorResponse = {
+  connector: ConnectorWithDefinition;
+};
+
+export async function connectUserConnectorAction({
   axiosInstance,
-  connectorResourceName,
+  connectorName,
 }: {
   axiosInstance: AxiosInstance;
-  connectorResourceName: string;
+  connectorName: string;
 }) {
   try {
-    const { data } =
-      await axiosInstance.post<ConnectUserConnectorResourceResponse>(
-        `/${connectorResourceName}/connect`
-      );
-    return Promise.resolve(data.connector_resource);
+    const { data } = await axiosInstance.post<ConnectUserConnectorResponse>(
+      `/${connectorName}/connect`
+    );
+    return Promise.resolve(data.connector);
   } catch (err) {
     return Promise.reject(err);
   }
 }
 
-export async function disconnectUserConnectorResourceAction({
+export type DisconnectUserConnectorResponse = {
+  connector: ConnectorWithDefinition;
+};
+
+export async function disconnectUserConnectorAction({
   axiosInstance,
-  connectorResourceName,
+  connectorName,
 }: {
   axiosInstance: AxiosInstance;
-  connectorResourceName: string;
+  connectorName: string;
 }) {
   try {
-    const { data } =
-      await axiosInstance.post<DisconnectUserConnectorResourceResponse>(
-        `/${connectorResourceName}/disconnect`
-      );
-    return Promise.resolve(data.connector_resource);
+    const { data } = await axiosInstance.post<DisconnectUserConnectorResponse>(
+      `/${connectorName}/disconnect`
+    );
+    return Promise.resolve(data.connector);
   } catch (err) {
     return Promise.reject(err);
   }