instill-sdk 0.0.2 → 0.0.3

package/dist/pipeline/types.d.ts

@@ -1,8 +1,10 @@
 import { OpenAPIV3 } from "openapi-types";
-import { ConnectorDefinition, ConnectorResource } from "../connector";
+import { ConnectorDefinition, Connector } from "../connector";
 import { Spec, Visibility } from "../types";
-import { Nullable } from "../types";
+import { JSONSchema7TypeName } from "json-schema";
+import { GeneralRecord, Nullable } from "@instill-ai/toolkit";
 import { Operation } from "../operation";
+import { AxiosInstance } from "axios";
 export type PipelineMode = "MODE_UNSPECIFIED" | "MODE_SYNC" | "MODE_ASYNC";
 export type PipelineReleaseState = "STATE_UNSPECIFIED" | "STATE_ACTIVE" | "STATE_INACTIVE" | "STATE_ERROR" | "STATE_DELETED";
 export type PipelineRecipe = {
@@ -25,17 +27,26 @@ export type PipelineReleaseWatchState = {
 };
 export type PipelineComponentType = "COMPONENT_TYPE_UNSPECIFIED" | "COMPONENT_TYPE_CONNECTOR_AI" | "COMPONENT_TYPE_CONNECTOR_DATA" | "COMPONENT_TYPE_CONNECTOR_BLOCKCHAIN" | "COMPONENT_TYPE_OPERATOR";
 export type PipelineReleasesWatchState = Record<string, PipelineReleaseWatchState>;
+export type Permission = {
+    can_edit: boolean;
+    can_trigger: boolean;
+};
 export type Pipeline = {
     name: string;
     uid: string;
     id: string;
     description: string;
-    user: string;
+    readme: string;
     create_time: string;
     update_time: string;
     recipe: PipelineRecipe;
     openapi_schema: OpenAPIV3.Document;
-    owner: string;
+    owner: Record<string, any>;
+    owner_name: string;
+    releases: PipelineRelease[];
+    sharing: PipelineSharing;
+    metadata: GeneralRecord;
+    permission: Permission;
 };
 export type OperatorDefinition = {
     name: string;
@@ -50,6 +61,21 @@ export type OperatorDefinition = {
     custom: boolean;
     icon_url: string;
 };
+export type PipelineSharing = {
+    users: PipelineSharingUserRules;
+    share_code: Nullable<PipelineSharingCodeRule>;
+};
+export type PipelineSharingUserRules = Record<string, {
+    enabled: boolean;
+    role: PermissionRole;
+} | undefined>;
+export type PipelineSharingCodeRule = {
+    user: string;
+    code?: string;
+    enabled: boolean;
+    role: PermissionRole;
+};
+export type PermissionRole = "ROLE_UNSPECIFIED" | "ROLE_VIEWER" | "ROLE_EXECUTOR";
 export type PipelineRelease = {
     name: string;
     uid: string;
@@ -60,6 +86,7 @@ export type PipelineRelease = {
     update_time: string;
     visibility: Visibility;
     openapi_schema: OpenAPIV3.Document;
+    metadata: GeneralRecord;
 };
 export type PipelineTrace = {
     success: boolean;
@@ -73,39 +100,58 @@ export type PipelineTriggerMetadata = {
 };
 export type PipelineStartComponent = {
     id: "start";
-    resource_name: string;
-    resource: Nullable<ConnectorResource>;
+    resource_name: Nullable<string>;
+    resource: Nullable<Connector>;
     type: PipelineComponentType;
     definition_name: string;
     operator_definition: Nullable<OperatorDefinition>;
-    configuration: Record<string, Record<string, StartOperatorInput>>;
+    configuration: {
+        metadata?: StartOperatorMetadata;
+    } & GeneralRecord;
+};
+export type PipelineOperatorComponent = {
+    id: string;
+    resource_name: Nullable<string>;
+    resource: Nullable<Connector>;
+    type: PipelineComponentType;
+    definition_name: string;
+    operator_definition: Nullable<OperatorDefinition>;
+    configuration: GeneralRecord;
 };
 export type PipelineEndComponent = {
     id: "end";
-    resource_name: string;
-    resource: Nullable<ConnectorResource>;
+    resource_name: Nullable<string>;
+    resource: Nullable<Connector>;
     type: PipelineComponentType;
     definition_name: string;
     operator_definition: Nullable<OperatorDefinition>;
-    configuration: Record<string, Record<string, any>>;
+    configuration: Record<string, GeneralRecord>;
 };
 export type PipelineConnectorComponent = {
     id: string;
-    resource_name: string;
-    resource: Nullable<ConnectorResource>;
+    resource_name: Nullable<string>;
+    resource: Nullable<Connector>;
     type: PipelineComponentType;
     definition_name: string;
     connector_definition: Nullable<ConnectorDefinition>;
-    configuration: Record<string, any>;
+    configuration: GeneralRecord;
 };
 export type PipelineComponent = PipelineStartComponent | PipelineEndComponent | PipelineConnectorComponent;
-export type StartOperatorBody = Record<string, StartOperatorInput>;
-export type StartOperatorInputBodyValue = Record<string, any>;
+export type StartOperatorMetadata = Record<string, StartOperatorInput>;
 export type StartOperatorInput = {
     title: string;
     type: StartOperatorInputType;
+    instillFormat: string;
+    items?: {
+        type: string;
+    };
+    instillUiOrder?: number;
+    instillUIMultiline?: boolean;
+    description?: string;
 };
-export type StartOperatorInputType = StartOperatorInputSingularType | StartOperatorInputArrayType;
+export type StartOperatorInputType = "audio/*" | "image/*" | "long_string" | "array:image/*" | "array:audio/*" | "array:string" | "*/*" | "array:*/*" | "semi-structured/object" | JSONSchema7TypeName;
+export type StartOperatorBody = Record<string, StartOperatorInput>;
+export type StartOperatorInputBodyValue = Record<string, any>;
 export type StartOperatorInputSingularType = "text" | "number" | "boolean" | "audio" | "image";
 export type StartOperatorInputArrayType = "text_array" | "number_array" | "boolean_array" | "audio_array" | "image_array";
 export type TriggerUserPipelinePayload = {
@@ -172,6 +218,12 @@ export type CreateUserPipelineReleaseResponse = {
     release: PipelineRelease;
 };
 export type UpdateUserPipelineReleasePayload = {
+    instillFormat: string;
+    items?: {
+        type: string;
+    };
+    instillUiOrder?: number;
+    instillUIMultiline?: boolean;
     description?: string;
     recipe: RawPipelineRecipe;
 };
@@ -202,3 +254,23 @@ export type GetUserPipelineReleaseResponse = {
 export type WatchUserPipelineReleaseResponse = {
     state: PipelineReleaseWatchState;
 };
+export type listPipelinesQueryParams = {
+    pageSize: Nullable<number>;
+    nextPageToken: Nullable<string>;
+    axiosInstance: AxiosInstance;
+    visibility?: Visibility;
+};
+export type listUserPipelinesQueryProps = {
+    pageSize: Nullable<number>;
+    nextPageToken: Nullable<string>;
+    axiosInstance: AxiosInstance;
+    userName: string;
+};
+export type GetOperatorDefinitionResponse = {
+    operator_definition: OperatorDefinition;
+};
+export type ListOperatorDefinitionsResponse = {
+    operator_definitions: OperatorDefinition[];
+    next_page_token: string;
+    total_size: number;
+};