授权

设置嵌入变量 DEVREV_TOKEN 默认情况下,它将作为认证符, 您也可以通过 url 和 order in client.setup() (a) 将第1款改为第1款。 它还必须进行测试.

安装

npm install @devrev/typescript-sdk

该版本可见于 package.json. SDK目前为β. 确保您的项目 软件包.json 包含 "type":"module" 设置.

Beta SDK 实例使用

import {client, betaSDK} from "@devrev/typescript-sdk";

const devrevBetaSDK = client.setupBeta({ endpoint: "https://api.devrev.ai",
token: process.env.DEVREV_TOKEN });

async function test(){
    const response = await devrevBetaSDK.worksCreate({title:"New work item!",
    applies_to_part: "PROD-1",
    owned_by:["DEVU-1"],
    type: betaSDK.WorkType.Issue})
    console.log(response)
}

test()

公共 SDK 示例使用

import {client, publicSDK} from "@devrev/typescript-sdk";

const devrevSDK = client.setup({ endpoint: "https://api.devrev.ai", token: process.env.DEVREV_TOKEN });

async function test(){
    const response = await devrevSDK.worksCreate({title:"New work item!", applies_to_part: "PROD-1", owned_by:["DEVU-16"], type: publicSDK.WorkType.Issue})
    console.log(response.status)
}

test()

执行 Repo 中的测试

npm test

Devrev SDK Utils 指南 维基百科中的相关条目: 克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克

基本设置

首先,以您的 DevRev 证书初始化 SDK :

import { client } from '@devrev/typescript-sdk';
import { BetaSdkUtil } from '@devrev/sdk-utils';

// Initialize the DevRev SDK
const devrevSDK = new client.setupBeta({
  // Your DevRev credentials
  endpoint: "https://api.devrev.ai",
  token: "YOUR_TOKEN"
});

// Initialize the utils SDK
const sdkUtil = new BetaSdkUtil(devrevSDK);

核心特征

1. 用户管理

获取账户中所有 Rev 用户 :

const accountId = "ACC-12345";
const revUsers = await sdkUtil.getAllRevUsersFromAccount(accountId);
// Returns array of RevUser objects

2. 文件管理

上传文件

import { FileTypes } from '@devrev/sdk-utils';

// Prepare file object
const fileObject = {
  file_name: "example.txt",
  file_type: FileTypes.OTHERS,
  file: Buffer.from("Hello World"),
  custom_file_type: "text/plain" // Required when file_type is OTHERS
};

// Upload file
const artifactId = await sdkUtil.uploadFileToArtifact(fileObject);

获取文件内容

const artifactId = "ART-12345";
const fileContent = await sdkUtil.getFileContentFromArtifact(artifactId);

处理错误

SDK包括内置 API 提供详细错误信息的错误处理 :

try {
  await sdkUtil.uploadFileToArtifact(fileObject);
} catch (error) {
  // Error will be automatically handled with detailed logging:
  // === Error Details ===
  // Service: [function name]
  // API: [API endpoint]
  // Error Type: [error type]
  // Status Code: [status code]
  // Message: [error message]
}

类型脚本支持

SDK是用 TypeScript 书写的,为下列类型提供了全面的类型定义:

• 文件管理操作
• 用户管理
• API 处理错误

如何贡献?

1. 创建新分支

   • 首先为您的特性或错误修正创建单独的分支 .

2. 遵循最佳编码做法

   • 确保您的代码遵守以下准则:
     • 使用 try-catch 块.
     • 使用SDK的TypeScript类型/界面来进行类型安全.
     • 上传前检查文件类型要求 .
     • 使用内置的 API 错误处理来进行一致的日志 .

3. 增强 BetaSDKUtil

   • 修改 BetaSDKUtil 增加新的公用事业.
   • 编写综合测试案例以确保功能.

4. 运行测试

   • 使用 :

     npm test
     

5. 提交拉动请求

   • 打开一个拉取请求,并清晰而详细地描述您的变化.