dify

dify/sdks/nodejs-client/.gitignore

@@ -0,0 +1,48 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+
+# local env files
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts
+
+# npm
+package-lock.json
+
+# yarn
+.pnp.cjs
+.pnp.loader.mjs
+.yarn/
+.yarnrc.yml
+
+# pmpm
+pnpm-lock.yaml

dify/sdks/nodejs-client/README.md

@@ -0,0 +1,67 @@
+# Dify Node.js SDK
+
+This is the Node.js SDK for the Dify API, which allows you to easily integrate Dify into your Node.js applications.
+
+## Install
+
+```bash
+npm install dify-client
+```
+
+## Usage
+
+After installing the SDK, you can use it in your project like this:
+
+```js
+import { DifyClient, ChatClient, CompletionClient } from 'dify-client'
+
+const API_KEY = 'your-api-key-here'
+const user = `random-user-id`
+const query = 'Please tell me a short story in 10 words or less.'
+const remote_url_files = [{
+    type: 'image',
+    transfer_method: 'remote_url',
+    url: 'your_url_address'
+}]
+
+// Create a completion client
+const completionClient = new CompletionClient(API_KEY)
+// Create a completion message
+completionClient.createCompletionMessage({'query': query}, user)
+// Create a completion message with vision model
+completionClient.createCompletionMessage({'query': 'Describe the picture.'}, user, false, remote_url_files)
+
+// Create a chat client
+const chatClient = new ChatClient(API_KEY)
+// Create a chat message in stream mode
+const response = await chatClient.createChatMessage({}, query, user, true, null)
+const stream = response.data;
+stream.on('data', data => {
+    console.log(data);
+});
+stream.on('end', () => {
+    console.log('stream done');
+});
+// Create a chat message with vision model
+chatClient.createChatMessage({}, 'Describe the picture.', user, false, null, remote_url_files)
+// Fetch conversations
+chatClient.getConversations(user)
+// Fetch conversation messages
+chatClient.getConversationMessages(conversationId, user)
+// Rename conversation
+chatClient.renameConversation(conversationId, name, user)
+
+
+const client = new DifyClient(API_KEY)
+// Fetch application parameters
+client.getApplicationParameters(user)
+// Provide feedback for a message
+client.messageFeedback(messageId, rating, user)
+
+```
+
+Replace 'your-api-key-here' with your actual Dify API key.Replace 'your-app-id-here' with your actual Dify APP ID.
+
+## License
+
+This SDK is released under the MIT License.

dify/sdks/nodejs-client/babel.config.cjs

@@ -0,0 +1,12 @@
+module.exports = {
+  presets: [
+    [
+      "@babel/preset-env",
+      {
+        targets: {
+          node: "current",
+        },
+      },
+    ],
+  ],
+};

dify/sdks/nodejs-client/index.d.ts

@@ -0,0 +1,107 @@
+// Types.d.ts
+export const BASE_URL: string;
+
+export type RequestMethods = 'GET' | 'POST' | 'PATCH' | 'DELETE';
+
+interface Params {
+  [key: string]: any;
+}
+
+interface HeaderParams {
+  [key: string]: string;
+}
+
+interface User {
+}
+
+interface DifyFileBase {
+  type: "image"
+}
+
+export interface DifyRemoteFile extends DifyFileBase {
+  transfer_method: "remote_url"
+  url: string
+}
+
+export interface DifyLocalFile extends DifyFileBase {
+  transfer_method: "local_file"
+  upload_file_id: string
+}
+
+export type DifyFile = DifyRemoteFile | DifyLocalFile;
+
+export declare class DifyClient {
+  constructor(apiKey: string, baseUrl?: string);
+
+  updateApiKey(apiKey: string): void;
+
+  sendRequest(
+    method: RequestMethods,
+    endpoint: string,
+    data?: any,
+    params?: Params,
+    stream?: boolean,
+    headerParams?: HeaderParams
+  ): Promise<any>;
+
+  messageFeedback(message_id: string, rating: number, user: User): Promise<any>;
+
+  getApplicationParameters(user: User): Promise<any>;
+
+  fileUpload(data: FormData): Promise<any>;
+
+  textToAudio(text: string ,user: string, streaming?: boolean): Promise<any>;
+
+  getMeta(user: User): Promise<any>;
+}
+
+export declare class CompletionClient extends DifyClient {
+  createCompletionMessage(
+    inputs: any,
+    user: User,
+    stream?: boolean,
+    files?: DifyFile[] | null
+  ): Promise<any>;
+}
+
+export declare class ChatClient extends DifyClient {
+  createChatMessage(
+    inputs: any,
+    query: string,
+    user: User,
+    stream?: boolean,
+    conversation_id?: string | null,
+    files?: DifyFile[] | null
+  ): Promise<any>;
+
+  getSuggested(message_id: string, user: User): Promise<any>;
+
+  stopMessage(task_id: string, user: User) : Promise<any>;
+
+
+  getConversations(
+    user: User,
+    first_id?: string | null,
+    limit?: number | null,
+    pinned?: boolean | null
+  ): Promise<any>;
+
+  getConversationMessages(
+    user: User,
+    conversation_id?: string,
+    first_id?: string | null,
+    limit?: number | null
+  ): Promise<any>;
+
+  renameConversation(conversation_id: string, name: string,  user: User,auto_generate:boolean): Promise<any>;
+
+  deleteConversation(conversation_id: string, user: User): Promise<any>;
+
+  audioToText(data: FormData): Promise<any>;
+}
+
+export declare class WorkflowClient extends DifyClient {
+  run(inputs: any, user: User, stream?: boolean,): Promise<any>;
+
+  stop(task_id: string, user: User): Promise<any>;
+}

dify/sdks/nodejs-client/index.js

@@ -0,0 +1,351 @@
+import axios from "axios";
+export const BASE_URL = "https://api.dify.ai/v1";
+
+export const routes = {
+  //  app's
+  feedback: {
+    method: "POST",
+    url: (message_id) => `/messages/${message_id}/feedbacks`,
+  },
+  application: {
+    method: "GET",
+    url: () => `/parameters`,
+  },
+  fileUpload: {
+    method: "POST",
+    url: () => `/files/upload`,
+  },
+  textToAudio: {
+    method: "POST",
+    url: () => `/text-to-audio`,
+  },
+  getMeta: {
+    method: "GET",
+    url: () => `/meta`,
+  },
+
+  // completion's
+  createCompletionMessage: {
+    method: "POST",
+    url: () => `/completion-messages`,
+  },
+
+  // chat's
+  createChatMessage: {
+    method: "POST",
+    url: () => `/chat-messages`,
+  },
+  getSuggested:{
+    method: "GET",
+    url: (message_id) => `/messages/${message_id}/suggested`,
+  },
+  stopChatMessage: {
+    method: "POST",
+    url: (task_id) => `/chat-messages/${task_id}/stop`,
+  },
+  getConversations: {
+    method: "GET",
+    url: () => `/conversations`,
+  },
+  getConversationMessages: {
+    method: "GET",
+    url: () => `/messages`,
+  },
+  renameConversation: {
+    method: "POST",
+    url: (conversation_id) => `/conversations/${conversation_id}/name`,
+  },
+  deleteConversation: {
+    method: "DELETE",
+    url: (conversation_id) => `/conversations/${conversation_id}`,
+  },
+  audioToText: {
+    method: "POST",
+    url: () => `/audio-to-text`,
+  },
+
+  // workflow‘s
+  runWorkflow: {
+    method: "POST",
+    url: () => `/workflows/run`,
+  },
+  stopWorkflow: {
+    method: "POST",
+    url: (task_id) => `/workflows/tasks/${task_id}/stop`,
+  }
+
+};
+
+export class DifyClient {
+  constructor(apiKey, baseUrl = BASE_URL) {
+    this.apiKey = apiKey;
+    this.baseUrl = baseUrl;
+  }
+
+  updateApiKey(apiKey) {
+    this.apiKey = apiKey;
+  }
+
+  async sendRequest(
+    method,
+    endpoint,
+    data = null,
+    params = null,
+    stream = false,
+    headerParams = {}
+  ) {
+    const isFormData =
+      (typeof FormData !== "undefined" && data instanceof FormData) ||
+      (data && data.constructor && data.constructor.name === "FormData");
+    const headers = {
+      Authorization: `Bearer ${this.apiKey}`,
+      ...(isFormData ? {} : { "Content-Type": "application/json" }),
+      ...headerParams,
+    };
+
+    const url = `${this.baseUrl}${endpoint}`;
+    let response;
+    if (stream) {
+      response = await axios({
+        method,
+        url,
+        data,
+        params,
+        headers,
+        responseType: "stream",
+      });
+    } else {
+      response = await axios({
+        method,
+        url,
+        ...(method !== "GET" && { data }),
+        params,
+        headers,
+        responseType: "json",
+      });
+    }
+
+    return response;
+  }
+
+  messageFeedback(message_id, rating, user) {
+    const data = {
+      rating,
+      user,
+    };
+    return this.sendRequest(
+      routes.feedback.method,
+      routes.feedback.url(message_id),
+      data
+    );
+  }
+
+  getApplicationParameters(user) {
+    const params = { user };
+    return this.sendRequest(
+      routes.application.method,
+      routes.application.url(),
+      null,
+      params
+    );
+  }
+
+  fileUpload(data) {
+    return this.sendRequest(
+      routes.fileUpload.method,
+      routes.fileUpload.url(),
+      data
+    );
+  }
+
+  textToAudio(text, user, streaming = false) {
+    const data = {
+      text,
+      user,
+      streaming
+    };
+    return this.sendRequest(
+      routes.textToAudio.method,
+      routes.textToAudio.url(),
+      data,
+      null,
+      streaming
+    );
+  }
+
+  getMeta(user) {
+    const params = { user };
+    return this.sendRequest(
+      routes.getMeta.method,
+      routes.getMeta.url(),
+      null,
+      params
+    );
+  }
+}
+
+export class CompletionClient extends DifyClient {
+  createCompletionMessage(inputs, user, stream = false, files = null) {
+    const data = {
+      inputs,
+      user,
+      response_mode: stream ? "streaming" : "blocking",
+      files,
+    };
+    return this.sendRequest(
+      routes.createCompletionMessage.method,
+      routes.createCompletionMessage.url(),
+      data,
+      null,
+      stream
+    );
+  }
+
+  runWorkflow(inputs, user, stream = false, files = null) {
+    const data = {
+      inputs,
+      user,
+      response_mode: stream ? "streaming" : "blocking",
+    };
+    return this.sendRequest(
+      routes.runWorkflow.method,
+      routes.runWorkflow.url(),
+      data,
+      null,
+      stream
+    );
+  }
+}
+
+export class ChatClient extends DifyClient {
+  createChatMessage(
+    inputs,
+    query,
+    user,
+    stream = false,
+    conversation_id = null,
+    files = null
+  ) {
+    const data = {
+      inputs,
+      query,
+      user,
+      response_mode: stream ? "streaming" : "blocking",
+      files,
+    };
+    if (conversation_id) data.conversation_id = conversation_id;
+
+    return this.sendRequest(
+      routes.createChatMessage.method,
+      routes.createChatMessage.url(),
+      data,
+      null,
+      stream
+    );
+  }
+
+  getSuggested(message_id, user) {
+    const data = { user };
+    return this.sendRequest(
+      routes.getSuggested.method,
+      routes.getSuggested.url(message_id),
+      data
+    );
+  }
+
+  stopMessage(task_id, user) {
+    const data = { user };
+    return this.sendRequest(
+      routes.stopChatMessage.method,
+      routes.stopChatMessage.url(task_id),
+      data
+    );
+  }
+
+  getConversations(user, first_id = null, limit = null, pinned = null) {
+    const params = { user, first_id: first_id, limit, pinned };
+    return this.sendRequest(
+      routes.getConversations.method,
+      routes.getConversations.url(),
+      null,
+      params
+    );
+  }
+
+  getConversationMessages(
+    user,
+    conversation_id = "",
+    first_id = null,
+    limit = null
+  ) {
+    const params = { user };
+
+    if (conversation_id) params.conversation_id = conversation_id;
+
+    if (first_id) params.first_id = first_id;
+
+    if (limit) params.limit = limit;
+
+    return this.sendRequest(
+      routes.getConversationMessages.method,
+      routes.getConversationMessages.url(),
+      null,
+      params
+    );
+  }
+
+  renameConversation(conversation_id, name, user, auto_generate) {
+    const data = { name, user, auto_generate };
+    return this.sendRequest(
+      routes.renameConversation.method,
+      routes.renameConversation.url(conversation_id),
+      data
+    );
+  }
+
+  deleteConversation(conversation_id, user) {
+    const data = { user };
+    return this.sendRequest(
+      routes.deleteConversation.method,
+      routes.deleteConversation.url(conversation_id),
+      data
+    );
+  }
+
+
+  audioToText(data) {
+    return this.sendRequest(
+      routes.audioToText.method,
+      routes.audioToText.url(),
+      data
+    );
+  }
+
+}
+
+export class WorkflowClient extends DifyClient {
+  run(inputs,user,stream) {
+    const data = {
+      inputs,
+      response_mode: stream ? "streaming" : "blocking",
+      user
+    };
+
+    return this.sendRequest(
+        routes.runWorkflow.method,
+        routes.runWorkflow.url(),
+        data,
+        null,
+        stream
+    );
+  }
+
+  stop(task_id, user) {
+    const data = { user };
+    return this.sendRequest(
+      routes.stopWorkflow.method,
+      routes.stopWorkflow.url(task_id),
+      data
+    );
+  }
+}

dify/sdks/nodejs-client/index.test.js

@@ -0,0 +1,141 @@
+import { DifyClient, WorkflowClient, BASE_URL, routes } from ".";
+
+import axios from 'axios'
+
+jest.mock('axios')
+
+afterEach(() => {
+  jest.resetAllMocks()
+})
+
+describe('Client', () => {
+  let difyClient
+  beforeEach(() => {
+    difyClient = new DifyClient('test')
+  })
+
+  test('should create a client', () => {
+    expect(difyClient).toBeDefined();
+  })
+  // test updateApiKey
+  test('should update the api key', () => {
+    difyClient.updateApiKey('test2');
+    expect(difyClient.apiKey).toBe('test2');
+  })
+});
+
+describe('Send Requests', () => {
+  let difyClient
+
+  beforeEach(() => {
+    difyClient = new DifyClient('test')
+  })
+
+  it('should make a successful request to the application parameter', async () => {
+    const method = 'GET'
+    const endpoint = routes.application.url()
+    const expectedResponse = { data: 'response' }
+    axios.mockResolvedValue(expectedResponse)
+
+    await difyClient.sendRequest(method, endpoint)
+
+    expect(axios).toHaveBeenCalledWith({
+      method,
+      url: `${BASE_URL}${endpoint}`,
+      params: null,
+      headers: {
+        Authorization: `Bearer ${difyClient.apiKey}`,
+        'Content-Type': 'application/json',
+      },
+      responseType: 'json',
+    })
+
+  })
+
+  it('should handle errors from the API', async () => {
+    const method = 'GET'
+    const endpoint = '/test-endpoint'
+    const errorMessage = 'Request failed with status code 404'
+    axios.mockRejectedValue(new Error(errorMessage))
+
+    await expect(difyClient.sendRequest(method, endpoint)).rejects.toThrow(
+      errorMessage
+    )
+  })
+
+  it('uses the getMeta route configuration', async () => {
+    axios.mockResolvedValue({ data: 'ok' })
+    await difyClient.getMeta('end-user')
+
+    expect(axios).toHaveBeenCalledWith({
+      method: routes.getMeta.method,
+      url: `${BASE_URL}${routes.getMeta.url()}`,
+      params: { user: 'end-user' },
+      headers: {
+        Authorization: `Bearer ${difyClient.apiKey}`,
+        'Content-Type': 'application/json',
+      },
+      responseType: 'json',
+    })
+  })
+})
+
+describe('File uploads', () => {
+  let difyClient
+  const OriginalFormData = global.FormData
+
+  beforeAll(() => {
+    global.FormData = class FormDataMock {}
+  })
+
+  afterAll(() => {
+    global.FormData = OriginalFormData
+  })
+
+  beforeEach(() => {
+    difyClient = new DifyClient('test')
+  })
+
+  it('does not override multipart boundary headers for FormData', async () => {
+    const form = new FormData()
+    axios.mockResolvedValue({ data: 'ok' })
+
+    await difyClient.fileUpload(form)
+
+    expect(axios).toHaveBeenCalledWith({
+      method: routes.fileUpload.method,
+      url: `${BASE_URL}${routes.fileUpload.url()}`,
+      data: form,
+      params: null,
+      headers: {
+        Authorization: `Bearer ${difyClient.apiKey}`,
+      },
+      responseType: 'json',
+    })
+  })
+})
+
+describe('Workflow client', () => {
+  let workflowClient
+
+  beforeEach(() => {
+    workflowClient = new WorkflowClient('test')
+  })
+
+  it('uses tasks stop path for workflow stop', async () => {
+    axios.mockResolvedValue({ data: 'stopped' })
+    await workflowClient.stop('task-1', 'end-user')
+
+    expect(axios).toHaveBeenCalledWith({
+      method: routes.stopWorkflow.method,
+      url: `${BASE_URL}${routes.stopWorkflow.url('task-1')}`,
+      data: { user: 'end-user' },
+      params: null,
+      headers: {
+        Authorization: `Bearer ${workflowClient.apiKey}`,
+        'Content-Type': 'application/json',
+      },
+      responseType: 'json',
+    })
+  })
+})

dify/sdks/nodejs-client/jest.config.cjs

@@ -0,0 +1,6 @@
+module.exports = {
+  testEnvironment: "node",
+  transform: {
+    "^.+\\.[tj]sx?$": "babel-jest",
+  },
+};

dify/sdks/nodejs-client/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "dify-client",
+  "version": "2.3.2",
+  "description": "This is the Node.js SDK for the Dify.AI API, which allows you to easily integrate Dify.AI into your Node.js applications.",
+  "main": "index.js",
+  "type": "module",
+  "types":"index.d.ts",
+  "keywords": [
+    "Dify",
+    "Dify.AI",
+    "LLM"
+  ],
+  "author": "Joel",
+  "contributors": [
+    "<crazywoola> <<427733928@qq.com>> (https://github.com/crazywoola)"
+  ],
+  "license": "MIT",
+  "scripts": {
+    "test": "jest"
+  },
+  "dependencies": {
+    "axios": "^1.3.5"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.21.8",
+    "@babel/preset-env": "^7.21.5",
+    "babel-jest": "^29.5.0",
+    "jest": "^29.5.0"
+  }
+}