feat: adapt sdk for pipeline related endpoint

instill-ai · Jul 13, 2024 · e6cb6ec · e6cb6ec
1 parent b5f4226
commit e6cb6ec
Show file tree

Hide file tree

Showing 110 changed files with 1,184 additions and 1,663 deletions.
diff --git a/packages/sdk/package.json b/packages/sdk/package.json
@@ -1,6 +1,6 @@
 {
   "name": "instill-sdk",
-  "version": "0.1.0-rc.1",
+  "version": "0.1.0-rc.5",
   "description": "Instill AI's Typescript SDK",
   "repository": "https://github.com/instill-ai/typescript-sdk.git",
   "bugs": "https://github.com/instill-ai/community/issues",

diff --git a/packages/sdk/src/main/index.ts b/packages/sdk/src/main/index.ts
@@ -22,10 +22,20 @@ export type RequestOption = {
 export class InstillAPIClient {
   baseURL: string;
   apiToken: string;
+  publicAccess?: boolean;
 
-  constructor({ baseURL, apiToken }: { baseURL: string; apiToken: string }) {
+  constructor({
+    baseURL,
+    apiToken,
+    publicAccess,
+  }: {
+    baseURL: string;
+    apiToken: string;
+    publicAccess?: boolean;
+  }) {
     this.baseURL = baseURL;
     this.apiToken = apiToken;
+    this.publicAccess = publicAccess;
   }
 
   async get<Rsp>(path: string, opt?: RequestOption): Promise<Rsp> {
@@ -56,11 +66,16 @@ export class InstillAPIClient {
     try {
       const response = await fetch(`${this.baseURL}${path}`, {
         method,
-        headers: {
-          "Content-Type": "application/json",
-          Authorization: `Bearer ${this.apiToken}`,
-          ...opt?.additionalHeaders,
-        },
+        headers: this.publicAccess
+          ? {
+              "Content-Type": "application/json",
+              ...opt?.additionalHeaders,
+            }
+          : {
+              "Content-Type": "application/json",
+              Authorization: `Bearer ${this.apiToken}`,
+              ...opt?.additionalHeaders,
+            },
         body: opt?.body,
       });
 

diff --git a/packages/sdk/src/vdp/component/ComponentClient.ts b/packages/sdk/src/vdp/component/ComponentClient.ts
@@ -4,6 +4,8 @@ import {
   ConnectorDefinition,
   GetConnectorDefinitionRequest,
   GetConnectorDefinitionResponse,
+  GetOperatorDefinitionRequest,
+  GetOperatorDefinitionResponse,
   ListConnectorDefinitionsRequest,
   ListConnectorDefinitionsResponse,
   ListOperatorDefinitionsRequest,
@@ -86,6 +88,24 @@ export class ComponentClient extends APIResource {
     }
   }
 
+  async getOperatorDefinition({
+    operatorDefinitionName,
+    view,
+  }: GetOperatorDefinitionRequest) {
+    try {
+      const queryString = getQueryString({
+        baseURL: `/${operatorDefinitionName}`,
+        view,
+      });
+
+      const data =
+        await this._client.get<GetOperatorDefinitionResponse>(queryString);
+      return Promise.resolve(data.operatorDefinition);
+    } catch (error) {
+      return Promise.reject(error);
+    }
+  }
+
   async listOperatorDefinitions(
     props: ListOperatorDefinitionsRequest & {
       enablePagination: true;

diff --git a/packages/sdk/src/vdp/component/types.ts b/packages/sdk/src/vdp/component/types.ts
@@ -73,3 +73,12 @@ export type ListOperatorDefinitionsResponse = {
   nextPageToken: string;
   totalSize: number;
 };
+
+export type GetOperatorDefinitionRequest = {
+  operatorDefinitionName: string;
+  view?: string;
+};
+
+export type GetOperatorDefinitionResponse = {
+  operatorDefinition: OperatorDefinition;
+};
diff --git a/packages/sdk/src/vdp/release/ReleaseClient.ts b/packages/sdk/src/vdp/release/ReleaseClient.ts
@@ -47,11 +47,16 @@ export class ReleaseClient extends APIResource {
   ): Promise<PipelineRelease[]>;
   async listNamespacePipelineReleases(
     props: ListNamespacePipelineReleaseRequest & {
-      enablePagination: boolean;
+      enablePagination: undefined;
+    },
+  ): Promise<PipelineRelease[]>;
+  async listNamespacePipelineReleases(
+    props: ListNamespacePipelineReleaseRequest & {
+      enablePagination?: boolean;
     },
   ): Promise<ListNamespacePipelineReleaseResponse | PipelineRelease[]>;
   async listNamespacePipelineReleases(
-    props: ListNamespacePipelineReleaseRequest & { enablePagination: boolean },
+    props: ListNamespacePipelineReleaseRequest & { enablePagination?: boolean },
   ) {
     const {
       namespacePipelineName,
@@ -101,7 +106,7 @@ export class ReleaseClient extends APIResource {
             shareCode,
             view,
             filter,
-            enablePagination,
+            enablePagination: false,
           })),
         );
       }

diff --git a/packages/sdk/src/vdp/trigger/TriggerClient.ts b/packages/sdk/src/vdp/trigger/TriggerClient.ts
@@ -13,7 +13,7 @@ import {
 export class TriggerClient extends APIResource {
   async triggerNamespacePipeline({
     namespacePipelineName,
-    input,
+    inputs,
     requesterUid,
     returnTraces,
     shareCode,
@@ -22,7 +22,7 @@ export class TriggerClient extends APIResource {
       const data = this._client.post<TriggerNamespacePipelineResponse>(
         `/${namespacePipelineName}/trigger`,
         {
-          body: JSON.stringify({ input }),
+          body: JSON.stringify({ inputs }),
           additionalHeaders: {
             "instill-return-traces": returnTraces ? "true" : "false",
             "instill-share-code": shareCode,
@@ -41,7 +41,7 @@ export class TriggerClient extends APIResource {
 
   async triggerAsyncNamespacePipeline({
     namespacePipelineName,
-    input,
+    inputs,
     returnTraces,
     requesterUid,
     shareCode,
@@ -51,7 +51,7 @@ export class TriggerClient extends APIResource {
         await this._client.post<TriggerAsyncNamespacePipelineResponse>(
           `/${namespacePipelineName}/triggerAsync`,
           {
-            body: JSON.stringify({ input }),
+            body: JSON.stringify({ inputs }),
             additionalHeaders: {
               "instill-return-traces": returnTraces ? "true" : "false",
               "instill-share-code": shareCode,
@@ -70,7 +70,7 @@ export class TriggerClient extends APIResource {
 
   async triggerNamespacePipelineRelease({
     namespacePipelineReleaseName,
-    input,
+    inputs,
     returnTraces,
     requesterUid,
     shareCode,
@@ -80,7 +80,7 @@ export class TriggerClient extends APIResource {
         await this._client.post<TriggerNamespacePipelineReleaseResponse>(
           `/${namespacePipelineReleaseName}/trigger`,
           {
-            body: JSON.stringify({ input }),
+            body: JSON.stringify({ inputs }),
             additionalHeaders: {
               "instill-return-traces": returnTraces ? "true" : "false",
               "instill-share-code": shareCode,
@@ -99,7 +99,7 @@ export class TriggerClient extends APIResource {
 
   async triggerAsyncNamespacePipelineRelease({
     namespacePipelineReleaseName,
-    input,
+    inputs,
     returnTraces,
     requesterUid,
     shareCode,
@@ -109,7 +109,7 @@ export class TriggerClient extends APIResource {
         await this._client.post<TriggerAsyncNamespacePipelineReleaseResponse>(
           `/${namespacePipelineReleaseName}/triggerAsync`,
           {
-            body: JSON.stringify({ input }),
+            body: JSON.stringify({ inputs }),
             additionalHeaders: {
               "instill-return-traces": returnTraces ? "true" : "false",
               "instill-share-code": shareCode,

diff --git a/packages/sdk/src/vdp/trigger/types.ts b/packages/sdk/src/vdp/trigger/types.ts
@@ -7,7 +7,7 @@ export type PipelineTriggerMetadata = {
 
 export type TriggerNamespacePipelineRequest = {
   namespacePipelineName: string;
-  input: GeneralRecord[];
+  inputs: GeneralRecord[];
   returnTraces?: boolean;
   shareCode?: string;
   requesterUid?: string;
@@ -20,7 +20,7 @@ export type TriggerNamespacePipelineResponse = {
 
 export type TriggerAsyncNamespacePipelineRequest = {
   namespacePipelineName: string;
-  input: GeneralRecord[];
+  inputs: GeneralRecord[];
   returnTraces?: boolean;
   shareCode?: string;
   requesterUid?: string;
@@ -32,7 +32,7 @@ export type TriggerAsyncNamespacePipelineResponse = {
 
 export type TriggerNamespacePipelineReleaseRequest = {
   namespacePipelineReleaseName: string;
-  input: GeneralRecord[];
+  inputs: GeneralRecord[];
   returnTraces?: boolean;
   shareCode?: string;
   requesterUid?: string;
@@ -45,7 +45,7 @@ export type TriggerNamespacePipelineReleaseResponse = {
 
 export type TriggerAsyncNamespacePipelineReleaseRequest = {
   namespacePipelineReleaseName: string;
-  input: GeneralRecord[];
+  inputs: GeneralRecord[];
   returnTraces?: boolean;
   shareCode?: string;
   requesterUid?: string;

diff --git a/packages/toolkit/package.json b/packages/toolkit/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@instill-ai/toolkit",
-  "version": "0.96.0-rc.8",
+  "version": "0.96.0-rc.13",
   "description": "Instill AI's frontend toolkit",
   "repository": "https://github.com/instill-ai/design-system.git",
   "bugs": "https://github.com/instill-ai/design-system/issues",

diff --git a/packages/toolkit/src/components/ClonePipelineDialog.tsx b/packages/toolkit/src/components/ClonePipelineDialog.tsx
@@ -3,6 +3,7 @@
 import * as React from "react";
 import { useRouter } from "next/navigation";
 import { zodResolver } from "@hookform/resolvers/zod";
+import { CreateNamespacePipelineRequest } from "instill-sdk";
 import { useForm } from "react-hook-form";
 import * as z from "zod";
 
@@ -21,7 +22,6 @@ import {
 
 import { InstillErrors } from "../constant";
 import {
-  CreateUserPipelinePayload,
   InstillStore,
   Nullable,
   Pipeline,
@@ -30,7 +30,7 @@ import {
   toastInstillError,
   useAmplitudeCtx,
   useAuthenticatedUser,
-  useCreateUserPipeline,
+  useCreateNamespacePipeline,
   useInstillStore,
   useRouteInfo,
   useShallow,
@@ -113,7 +113,7 @@ export const ClonePipelineDialog = ({
 
   const namespaces = useUserNamespaces();
 
-  const createPipeline = useCreateUserPipeline();
+  const createPipeline = useCreateNamespacePipeline();
   async function handleClone(data: z.infer<typeof ClonePipelineSchema>) {
     if (!me.isSuccess || !accessToken || !pipeline) {
       return;
@@ -150,26 +150,23 @@ export const ClonePipelineDialog = ({
 
     const recipe = composePipelineRecipeFromNodes(nodes);
 
-    const payload: CreateUserPipelinePayload = {
-      id: data.id,
-      recipe,
-      metadata: pipeline.metadata,
-      readme: pipeline.readme,
-      description: data.brief ? data.brief : pipeline.description,
-      sharing,
-    };
-
     const namespace = namespaces.find(
       (account) => account.id === data.namespaceId,
     );
 
     if (namespace) {
+      const payload: CreateNamespacePipelineRequest = {
+        namespaceName: namespace.name,
+        id: data.id,
+        recipe,
+        metadata: pipeline.metadata,
+        readme: pipeline.readme,
+        description: data.brief ? data.brief : pipeline.description,
+        sharing,
+      };
+
       try {
-        await createPipeline.mutateAsync({
-          payload,
-          accessToken,
-          entityName: namespace.name,
-        });
+        await createPipeline.mutateAsync({ payload, accessToken });
         if (amplitudeIsInit) {
           if (pipeline.ownerName === me.data.name) {
             sendAmplitudeData("duplicate_pipeline");

diff --git a/packages/toolkit/src/components/card-pipeline/Head.tsx b/packages/toolkit/src/components/card-pipeline/Head.tsx
@@ -11,7 +11,7 @@ import {
   OrganizationOwner,
   Pipeline,
   toastInstillError,
-  useDeleteUserPipeline,
+  useDeleteNamespacePipeline,
   useInstillStore,
   UserOwner,
   useShallow,
@@ -48,11 +48,11 @@ export const Head = ({
   const { toast } = useToast();
   const { accessToken } = useInstillStore(useShallow(selector));
 
-  const deletePipeline = useDeleteUserPipeline();
+  const deletePipeline = useDeleteNamespacePipeline();
   async function handleDeletePipeline() {
     try {
       await deletePipeline.mutateAsync({
-        pipelineName: pipeline.name,
+        namespacePipelineName: pipeline.name,
         accessToken: accessToken ? accessToken : null,
       });
 

diff --git a/packages/toolkit/src/components/top-bar/NamespaceSwitch.tsx b/packages/toolkit/src/components/top-bar/NamespaceSwitch.tsx
@@ -21,11 +21,11 @@ import {
   useAuthenticatedUser,
   useGuardPipelineBuilderUnsavedChangesNavigation,
   useInstillStore,
+  useNamespacePipeline,
   useNamespacesRemainingCredit,
   useRouteInfo,
   useShallow,
   useUserModel,
-  useUserPipeline,
 } from "../../lib";
 import { useUserNamespaces } from "../../lib/useUserNamespaces";
 import { env } from "../../server";
@@ -76,8 +76,10 @@ export const NamespaceSwitch = () => {
     accessToken,
   });
 
-  const pipeline = useUserPipeline({
-    pipelineName: routeInfo.isSuccess ? routeInfo.data.pipelineName : null,
+  const pipeline = useNamespacePipeline({
+    namespacePipelineName: routeInfo.isSuccess
+      ? routeInfo.data.pipelineName
+      : null,
     accessToken,
     enabled: enabledQuery && pathnameEvaluator.isPipelineOverviewPage(pathname),
   });

diff --git a/packages/toolkit/src/lib/react-query-service/metric/useCreditConsumptionChartRecords.ts b/packages/toolkit/src/lib/react-query-service/metric/useCreditConsumptionChartRecords.ts
@@ -60,7 +60,7 @@ export function useCreditConsumptionChartRecords({
         return Promise.reject(new Error("owner not provided"));
       }
 
-      const client = getInstillAPIClient({ accessToken });
+      const client = getInstillAPIClient({ accessToken, publicAccess: false });
 
       const data =
         await client.core.metric.listInstillCreditConsumptionTimeChart({

diff --git a/...ges/toolkit/src/lib/react-query-service/metric/usePipelineTriggerComputationTimeCharts.ts b/...ges/toolkit/src/lib/react-query-service/metric/usePipelineTriggerComputationTimeCharts.ts
@@ -22,7 +22,7 @@ export function usePipelineTriggerComputationTimeCharts({
         return Promise.reject(new Error("accessToken not provided"));
       }
 
-      const client = getInstillAPIClient({ accessToken });
+      const client = getInstillAPIClient({ accessToken, publicAccess: false });
 
       const triggers =
         await client.core.metric.listPipelineTriggerComputationTimeCharts({

diff --git a/packages/toolkit/src/lib/react-query-service/metric/usePipelineTriggerMetric.ts b/packages/toolkit/src/lib/react-query-service/metric/usePipelineTriggerMetric.ts
@@ -22,7 +22,7 @@ export function usePipelineTriggerMetric({
         return Promise.reject(new Error("accessToken not provided"));
       }
 
-      const client = getInstillAPIClient({ accessToken });
+      const client = getInstillAPIClient({ accessToken, publicAccess: false });
 
       const triggerMetric = await client.core.metric.listPipelineTriggerMetric({
         pageSize: env("NEXT_PUBLIC_QUERY_PAGE_SIZE"),

diff --git a/packages/toolkit/src/lib/react-query-service/metric/usePipelineTriggers.ts b/packages/toolkit/src/lib/react-query-service/metric/usePipelineTriggers.ts
@@ -24,7 +24,7 @@ export function usePipelineTriggers({
         return Promise.reject(new Error("accessToken not provided"));
       }
 
-      const client = getInstillAPIClient({ accessToken });
+      const client = getInstillAPIClient({ accessToken, publicAccess: false });
 
       const triggers = await client.core.metric.listPipelineTriggers({
         pageSize: env("NEXT_PUBLIC_QUERY_PAGE_SIZE"),