instill-sdk 0.0.1 → 0.0.2

package/README.md

@@ -3,9 +3,9 @@
 Typescript SDK for Instill AI products
 
 [![Unix Build Status](https://img.shields.io/github/actions/workflow/status/instill-ai/typescript-sdk/test.yml?branch=main&label=linux)](https://github.com/instill-ai/typescript-sdk/actions)
-[![NPM License](https://img.shields.io/npm/l/@instill-ai/typescript-sdk.svg)](https://www.npmjs.com/package/@instill-ai/typescript-sdk)
-[![NPM Version](https://img.shields.io/npm/v/@instill-ai/typescript-sdk.svg)](https://www.npmjs.com/package/@instill-ai/typescript-sdk)
-[![NPM Downloads](https://img.shields.io/npm/dm/@instill-ai/typescript-sdk.svg?color=orange)](https://www.npmjs.com/package/@instill-ai/typescript-sdk)
+[![NPM License](https://img.shields.io/npm/l/instill-sdk.svg)](https://www.npmjs.com/package/instill-sdk)
+[![NPM Version](https://img.shields.io/npm/v/instill-sdk.svg)](https://www.npmjs.com/package/instill-sdk)
+[![NPM Downloads](https://img.shields.io/npm/dm/instill-sdk.svg?color=orange)](https://www.npmjs.com/package/instill-sdk)
 
 > [!IMPORTANT]  
 > **This SDK tool is under heavy development!!**  
@@ -21,25 +21,25 @@ Typescript SDK for Instill AI products
 ### installation
 
 ```
-npm i @instill-ai/typescript-sdk
+npm i instill-sdk
 ```
 
 ```
-yarn add @instill-ai/typescript-sdk
+yarn add instill-sdk
 ```
 
 ```
-pnpm add @instill-ai/typescript-sdk
+pnpm add instill-sdk
 ```
 
 ## Usage:
 
 ```
 // node.js
-const InstillClient = require("@instill-ai/typescript-sdk").default;
+const InstillClient = require("instill-sdk").default;
 
 // next.js
-import InstillClient from "@instill-ai/typescript-sdk";
+import InstillClient from "instill-sdk";
 
 ```
 
@@ -60,14 +60,14 @@ import { useEffect, useState } from "react";
 import InstillClient, {
   Nullable,
   User,
-} from "@instill-ai/typescript-sdk";
+} from "instill-sdk";
 
 export default function TypescriptSdkDemo() {
   const [user, setUser] = useState<User[]>([]);
 
   const client = new InstillClient(
     "http://localhost:8080",
-    "v1alpha",
+    "v1beta",
     "<your_api_token>" // get console API token from `http://localhost:3000/settings`
   );
 
@@ -101,7 +101,7 @@ import InstillClient, {
   Nullable,
   Pipeline,
   User,
-} from "@instill-ai/typescript-sdk";
+} from "instill-sdk";
 
 export default function TypescriptSdkDemo() {
   const [pipelines, setPipelines] = useState<Pipeline[]>([]);
@@ -109,7 +109,7 @@ export default function TypescriptSdkDemo() {
 
   const client = new InstillClient(
     "https://api.instill.tech",
-    "v1alpha",
+    "v1beta",
     "<your_api_token>" // console API token
   );
 
@@ -174,7 +174,7 @@ client.PipelineClient.createUserPipelineMutation("<userName>",
   {
     "id": "overseas-blue-lobster",
     "recipe": {
-      "version": "v1alpha",
+      "version": "v1beta",
       "components": [
         {
           "id": "start",

package/dist/{chunk-ZRC43MN3.mjs → chunk-DIAPO2ML.mjs}

@@ -21,7 +21,7 @@ import axios from "axios";
 var AuthClient = class {
   axiosInstance;
   constructor(baseUrl, appVersion, apiToken) {
-    let URL = `${baseUrl}/base/${appVersion}`;
+    let URL = `${baseUrl}/core/${appVersion}`;
     this.axiosInstance = axios.create({
       baseURL: URL,
       headers: {

package/dist/{chunk-WL54JNC6.mjs → chunk-G5M7VUJT.mjs}

@@ -9,7 +9,7 @@ import axios from "axios";
 var MetricClient = class {
   axiosInstance;
   constructor(baseUrl, appVersion, apiToken) {
-    let URL = `${baseUrl}/base/${appVersion}`;
+    let URL = `${baseUrl}/core/${appVersion}`;
     this.axiosInstance = axios.create({
       baseURL: URL,
       headers: {

package/dist/{chunk-4TKUHGUZ.mjs → chunk-MS2EILMH.mjs}

@@ -16,13 +16,13 @@ import {
   updateUserPipelineReleaseMutation
 } from "./chunk-QLWRKSUE.mjs";
 import {
-  ListUserPipelineReleasesQuery,
   getUserPipelineQuery,
   getUserPipelineReleaseQuery,
   listPipelinesQuery,
+  listUserPipelineReleasesQuery,
   listUserPipelinesQuery,
   watchUserPipelineReleaseQuery
-} from "./chunk-ECC5KF6S.mjs";
+} from "./chunk-YK7RY2CG.mjs";
 
 // src/pipeline/PipelineClient.ts
 import axios from "axios";
@@ -72,12 +72,12 @@ var PipelineClient = class {
   /* -------------------------------------------------------------------------
    * Pipeline Release
    * -----------------------------------------------------------------------*/
-  async ListUserPipelineReleasesQuery({
+  async listUserPipelineReleasesQuery({
     pipelineName,
     pageSize,
     nextPageToken
   }) {
-    return ListUserPipelineReleasesQuery({
+    return listUserPipelineReleasesQuery({
       axiosInstance: this.axiosInstance,
       pipelineName,
       pageSize,

package/dist/{chunk-ECC5KF6S.mjs → chunk-YK7RY2CG.mjs}

@@ -80,7 +80,7 @@ async function getUserPipelineQuery({
     return Promise.reject(err);
   }
 }
-async function ListUserPipelineReleasesQuery({
+async function listUserPipelineReleasesQuery({
   axiosInstance,
   pipelineName,
   pageSize,
@@ -100,7 +100,7 @@ async function ListUserPipelineReleasesQuery({
     releases.push(...data.releases);
     if (data.next_page_token) {
       releases.push(
-        ...await ListUserPipelineReleasesQuery({
+        ...await listUserPipelineReleasesQuery({
           axiosInstance,
           pipelineName,
           pageSize,
@@ -144,7 +144,7 @@ export {
   listPipelinesQuery,
   listUserPipelinesQuery,
   getUserPipelineQuery,
-  ListUserPipelineReleasesQuery,
+  listUserPipelineReleasesQuery,
   getUserPipelineReleaseQuery,
   watchUserPipelineReleaseQuery
 };

package/dist/index.js

@@ -622,7 +622,7 @@ async function listTriggeredPipelineChartQuery({
 var MetricClient = class {
   axiosInstance;
   constructor(baseUrl, appVersion, apiToken) {
-    let URL = `${baseUrl}/base/${appVersion}`;
+    let URL = `${baseUrl}/core/${appVersion}`;
     this.axiosInstance = import_axios4.default.create({
       baseURL: URL,
       headers: {
@@ -826,7 +826,7 @@ async function authValidateTokenAction(axiosInstance) {
 var AuthClient = class {
   axiosInstance;
   constructor(baseUrl, appVersion, apiToken) {
-    let URL = `${baseUrl}/base/${appVersion}`;
+    let URL = `${baseUrl}/core/${appVersion}`;
     this.axiosInstance = import_axios5.default.create({
       baseURL: URL,
       headers: {
@@ -1462,7 +1462,7 @@ async function getUserPipelineQuery({
     return Promise.reject(err);
   }
 }
-async function ListUserPipelineReleasesQuery({
+async function listUserPipelineReleasesQuery({
   axiosInstance,
   pipelineName,
   pageSize,
@@ -1482,7 +1482,7 @@ async function ListUserPipelineReleasesQuery({
     releases.push(...data.releases);
     if (data.next_page_token) {
       releases.push(
-        ...await ListUserPipelineReleasesQuery({
+        ...await listUserPipelineReleasesQuery({
           axiosInstance,
           pipelineName,
           pageSize,
@@ -1784,12 +1784,12 @@ var PipelineClient = class {
   /* -------------------------------------------------------------------------
    * Pipeline Release
    * -----------------------------------------------------------------------*/
-  async ListUserPipelineReleasesQuery({
+  async listUserPipelineReleasesQuery({
     pipelineName,
     pageSize,
     nextPageToken
   }) {
-    return ListUserPipelineReleasesQuery({
+    return listUserPipelineReleasesQuery({
       axiosInstance: this.axiosInstance,
       pipelineName,
       pageSize,

package/dist/index.mjs

@@ -1,10 +1,10 @@
 import "./chunk-KCKTAMXW.mjs";
 import {
   PipelineClient_default
-} from "./chunk-4TKUHGUZ.mjs";
+} from "./chunk-MS2EILMH.mjs";
 import "./chunk-NRP5M7FG.mjs";
 import "./chunk-QLWRKSUE.mjs";
-import "./chunk-ECC5KF6S.mjs";
+import "./chunk-YK7RY2CG.mjs";
 import "./chunk-42SCMPQP.mjs";
 import "./chunk-FNCXOA62.mjs";
 import "./chunk-2VZRNT6D.mjs";
@@ -20,7 +20,7 @@ import "./chunk-73EPIL2R.mjs";
 import "./chunk-VASX6R4R.mjs";
 import {
   AuthClient_default
-} from "./chunk-ZRC43MN3.mjs";
+} from "./chunk-DIAPO2ML.mjs";
 import "./chunk-IPW3WQCQ.mjs";
 import "./chunk-3VVR3XHW.mjs";
 import "./chunk-VIPORJ6H.mjs";
@@ -33,7 +33,7 @@ import "./chunk-QZOKJQTL.mjs";
 import "./chunk-KHFNAMT4.mjs";
 import {
   MetricClient_default
-} from "./chunk-WL54JNC6.mjs";
+} from "./chunk-G5M7VUJT.mjs";
 import "./chunk-YXNMG2RZ.mjs";
 import "./chunk-WBQAMGXK.mjs";
 import "./chunk-WLPBUHMI.mjs";

package/dist/metric/MetricClient.js

@@ -164,7 +164,7 @@ async function listTriggeredPipelineChartQuery({
 var MetricClient = class {
   axiosInstance;
   constructor(baseUrl, appVersion, apiToken) {
-    let URL = `${baseUrl}/base/${appVersion}`;
+    let URL = `${baseUrl}/core/${appVersion}`;
     this.axiosInstance = import_axios3.default.create({
       baseURL: URL,
       headers: {

package/dist/metric/MetricClient.mjs

@@ -1,6 +1,6 @@
 import {
   MetricClient_default
-} from "../chunk-WL54JNC6.mjs";
+} from "../chunk-G5M7VUJT.mjs";
 import "../chunk-YXNMG2RZ.mjs";
 import "../chunk-6ZXT6X3H.mjs";
 import "../chunk-JTTE7IZY.mjs";

package/dist/mgmt/AuthClient.js

@@ -222,7 +222,7 @@ async function authValidateTokenAction(axiosInstance) {
 var AuthClient = class {
   axiosInstance;
   constructor(baseUrl, appVersion, apiToken) {
-    let URL = `${baseUrl}/base/${appVersion}`;
+    let URL = `${baseUrl}/core/${appVersion}`;
     this.axiosInstance = import_axios3.default.create({
       baseURL: URL,
       headers: {

package/dist/mgmt/AuthClient.mjs

@@ -1,6 +1,6 @@
 import {
   AuthClient_default
-} from "../chunk-ZRC43MN3.mjs";
+} from "../chunk-DIAPO2ML.mjs";
 import "../chunk-IPW3WQCQ.mjs";
 import "../chunk-3VVR3XHW.mjs";
 import "../chunk-VIPORJ6H.mjs";

package/dist/mgmt/index.mjs

@@ -1,5 +1,5 @@
 import "../chunk-VASX6R4R.mjs";
-import "../chunk-ZRC43MN3.mjs";
+import "../chunk-DIAPO2ML.mjs";
 import "../chunk-IPW3WQCQ.mjs";
 import "../chunk-3VVR3XHW.mjs";
 import "../chunk-VIPORJ6H.mjs";

package/dist/pipeline/PipelineClient.d.ts

@@ -15,7 +15,7 @@ declare class PipelineClient {
     getUserPipelineQuery({ pipelineName }: {
         pipelineName: string;
     }): Promise<import("./types").Pipeline>;
-    ListUserPipelineReleasesQuery({ pipelineName, pageSize, nextPageToken, }: {
+    listUserPipelineReleasesQuery({ pipelineName, pageSize, nextPageToken, }: {
         pipelineName: string;
         pageSize: Nullable<number>;
         nextPageToken: Nullable<string>;

package/dist/pipeline/PipelineClient.js

@@ -149,7 +149,7 @@ async function getUserPipelineQuery({
     return Promise.reject(err);
   }
 }
-async function ListUserPipelineReleasesQuery({
+async function listUserPipelineReleasesQuery({
   axiosInstance,
   pipelineName,
   pageSize,
@@ -169,7 +169,7 @@ async function ListUserPipelineReleasesQuery({
     releases.push(...data.releases);
     if (data.next_page_token) {
       releases.push(
-        ...await ListUserPipelineReleasesQuery({
+        ...await listUserPipelineReleasesQuery({
           axiosInstance,
           pipelineName,
           pageSize,
@@ -471,12 +471,12 @@ var PipelineClient = class {
   /* -------------------------------------------------------------------------
    * Pipeline Release
    * -----------------------------------------------------------------------*/
-  async ListUserPipelineReleasesQuery({
+  async listUserPipelineReleasesQuery({
     pipelineName,
     pageSize,
     nextPageToken
   }) {
-    return ListUserPipelineReleasesQuery({
+    return listUserPipelineReleasesQuery({
       axiosInstance: this.axiosInstance,
       pipelineName,
       pageSize,

package/dist/pipeline/PipelineClient.mjs

@@ -1,9 +1,9 @@
 import {
   PipelineClient_default
-} from "../chunk-4TKUHGUZ.mjs";
+} from "../chunk-MS2EILMH.mjs";
 import "../chunk-NRP5M7FG.mjs";
 import "../chunk-QLWRKSUE.mjs";
-import "../chunk-ECC5KF6S.mjs";
+import "../chunk-YK7RY2CG.mjs";
 import "../chunk-6ZXT6X3H.mjs";
 import "../chunk-JTTE7IZY.mjs";
 import "../chunk-DXEIDDIA.mjs";

package/dist/pipeline/index.mjs

@@ -1,8 +1,8 @@
 import "../chunk-KCKTAMXW.mjs";
-import "../chunk-4TKUHGUZ.mjs";
+import "../chunk-MS2EILMH.mjs";
 import "../chunk-NRP5M7FG.mjs";
 import "../chunk-QLWRKSUE.mjs";
-import "../chunk-ECC5KF6S.mjs";
+import "../chunk-YK7RY2CG.mjs";
 import "../chunk-42SCMPQP.mjs";
 import "../chunk-6ZXT6X3H.mjs";
 import "../chunk-JTTE7IZY.mjs";

package/dist/pipeline/queries.d.ts

@@ -16,7 +16,7 @@ export declare function getUserPipelineQuery({ axiosInstance, pipelineName, }: {
     axiosInstance: AxiosInstance;
     pipelineName: string;
 }): Promise<Pipeline>;
-export declare function ListUserPipelineReleasesQuery({ axiosInstance, pipelineName, pageSize, nextPageToken, }: {
+export declare function listUserPipelineReleasesQuery({ axiosInstance, pipelineName, pageSize, nextPageToken, }: {
     axiosInstance: AxiosInstance;
     pipelineName: string;
     pageSize: Nullable<number>;

package/dist/pipeline/queries.js

@@ -30,10 +30,10 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/pipeline/queries.ts
 var queries_exports = {};
 __export(queries_exports, {
-  ListUserPipelineReleasesQuery: () => ListUserPipelineReleasesQuery,
   getUserPipelineQuery: () => getUserPipelineQuery,
   getUserPipelineReleaseQuery: () => getUserPipelineReleaseQuery,
   listPipelinesQuery: () => listPipelinesQuery,
+  listUserPipelineReleasesQuery: () => listUserPipelineReleasesQuery,
   listUserPipelinesQuery: () => listUserPipelinesQuery,
   watchUserPipelineReleaseQuery: () => watchUserPipelineReleaseQuery
 });
@@ -153,7 +153,7 @@ async function getUserPipelineQuery({
     return Promise.reject(err);
   }
 }
-async function ListUserPipelineReleasesQuery({
+async function listUserPipelineReleasesQuery({
   axiosInstance,
   pipelineName,
   pageSize,
@@ -173,7 +173,7 @@ async function ListUserPipelineReleasesQuery({
     releases.push(...data.releases);
     if (data.next_page_token) {
       releases.push(
-        ...await ListUserPipelineReleasesQuery({
+        ...await listUserPipelineReleasesQuery({
           axiosInstance,
           pipelineName,
           pageSize,
@@ -214,10 +214,10 @@ async function watchUserPipelineReleaseQuery({
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  ListUserPipelineReleasesQuery,
   getUserPipelineQuery,
   getUserPipelineReleaseQuery,
   listPipelinesQuery,
+  listUserPipelineReleasesQuery,
   listUserPipelinesQuery,
   watchUserPipelineReleaseQuery
 });

package/dist/pipeline/queries.mjs

@@ -1,11 +1,11 @@
 import {
-  ListUserPipelineReleasesQuery,
   getUserPipelineQuery,
   getUserPipelineReleaseQuery,
   listPipelinesQuery,
+  listUserPipelineReleasesQuery,
   listUserPipelinesQuery,
   watchUserPipelineReleaseQuery
-} from "../chunk-ECC5KF6S.mjs";
+} from "../chunk-YK7RY2CG.mjs";
 import "../chunk-6ZXT6X3H.mjs";
 import "../chunk-JTTE7IZY.mjs";
 import "../chunk-DXEIDDIA.mjs";
@@ -14,10 +14,10 @@ import "../chunk-7KV3Y36U.mjs";
 import "../chunk-EBWGEVUX.mjs";
 import "../chunk-EXJ4UK7Q.mjs";
 export {
-  ListUserPipelineReleasesQuery,
   getUserPipelineQuery,
   getUserPipelineReleaseQuery,
   listPipelinesQuery,
+  listUserPipelineReleasesQuery,
   listUserPipelinesQuery,
   watchUserPipelineReleaseQuery
 };

package/dist/tests/recipePayload.js

@@ -0,0 +1,57 @@
+// src/tests/recipePayload.json
+var id = "overseas-blue-lobster";
+var recipe = {
+  version: "v1beta",
+  components: [
+    {
+      id: "start",
+      resource_name: "",
+      configuration: {
+        metadata: {
+          text: {
+            instillFormat: "string",
+            type: "string",
+            title: "text"
+          }
+        }
+      },
+      definition_name: "operator-definitions/op-start"
+    },
+    {
+      id: "end",
+      resource_name: "",
+      configuration: {
+        metadata: {
+          output: {
+            title: "output"
+          }
+        },
+        input: {
+          output: "{ai_1.output.texts}"
+        }
+      },
+      definition_name: "operator-definitions/op-end"
+    },
+    {
+      id: "ai_1",
+      resource_name: "users/namananand-instill-ai/connector-resources/ai2",
+      configuration: {
+        task: "TASK_TEXT_GENERATION",
+        input: {
+          prompt: "{start.text}",
+          model: "gpt-3.5-turbo"
+        }
+      },
+      definition_name: "connector-definitions/ai-openai"
+    }
+  ]
+};
+var recipePayload_default = {
+  id,
+  recipe
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  id,
+  recipe
+});

package/dist/tests/recipePayload.mjs

@@ -0,0 +1,59 @@
+import "../chunk-EXJ4UK7Q.mjs";
+
+// src/tests/recipePayload.json
+var id = "overseas-blue-lobster";
+var recipe = {
+  version: "v1beta",
+  components: [
+    {
+      id: "start",
+      resource_name: "",
+      configuration: {
+        metadata: {
+          text: {
+            instillFormat: "string",
+            type: "string",
+            title: "text"
+          }
+        }
+      },
+      definition_name: "operator-definitions/op-start"
+    },
+    {
+      id: "end",
+      resource_name: "",
+      configuration: {
+        metadata: {
+          output: {
+            title: "output"
+          }
+        },
+        input: {
+          output: "{ai_1.output.texts}"
+        }
+      },
+      definition_name: "operator-definitions/op-end"
+    },
+    {
+      id: "ai_1",
+      resource_name: "users/namananand-instill-ai/connector-resources/ai2",
+      configuration: {
+        task: "TASK_TEXT_GENERATION",
+        input: {
+          prompt: "{start.text}",
+          model: "gpt-3.5-turbo"
+        }
+      },
+      definition_name: "connector-definitions/ai-openai"
+    }
+  ]
+};
+var recipePayload_default = {
+  id,
+  recipe
+};
+export {
+  recipePayload_default as default,
+  id,
+  recipe
+};

package/dist/tests/resourcePaylaod.js

@@ -0,0 +1,18 @@
+// src/tests/resourcePaylaod.json
+var id = "open-ai-model-1";
+var connector_definition_name = "connector-definitions/ai-openai";
+var configuration = {
+  organization: "my-org",
+  api_key: "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"
+};
+var resourcePaylaod_default = {
+  id,
+  connector_definition_name,
+  configuration
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  configuration,
+  connector_definition_name,
+  id
+});

package/dist/tests/resourcePaylaod.mjs

@@ -0,0 +1,20 @@
+import "../chunk-EXJ4UK7Q.mjs";
+
+// src/tests/resourcePaylaod.json
+var id = "open-ai-model-1";
+var connector_definition_name = "connector-definitions/ai-openai";
+var configuration = {
+  organization: "my-org",
+  api_key: "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"
+};
+var resourcePaylaod_default = {
+  id,
+  connector_definition_name,
+  configuration
+};
+export {
+  configuration,
+  connector_definition_name,
+  resourcePaylaod_default as default,
+  id
+};