RaaS Client for TypeScript

TypeScriptで実装されたRaaS（Report as a Service）クライアントライブラリです。このライブラリを使用することで、RaaSサービスへの接続と操作を簡単に行うことができます。

インストール

npm install @sutech_jp/raas-client-for-typescript

設定

RaaSクライアントを使用するには、接続設定とユーザーコンテキストが必要です。

接続設定

import { RaasConnectionConfig } from '@sutech_jp/raas-client-for-typescript';

const config: RaasConnectionConfig = {
  app: 'your-app-name',
  token: 'your-api-token',
  landscape: 'dev' // または 'prod'
};

app / tokenはSuTech担当者より提供された値を利用して下さい

ユーザーコンテキスト

import { RaasClientContext } from '@sutech_jp/raas-client-for-typescript';

const userContext: RaasClientContext = {
  tenant: 'your-tenant-id',
  tenantAlias: 'your-tenant-alias', // 障害調査などの際に利用しますので必要に応じてセットして下さい
  tenantType: 'paid', // 'paid', 'trial', 'demo', 'dev' のいずれか（オプション）
  sub: 'user-subject-id',
  email: '[email protected]', // ワークフローオプションを利用する場合には必須です
  subAlias: 'user-alias', // ワークフローオプションを利用する場合には必須です
  subDomain: 'user-domain' // ワークフローオプションを利用する場合には必須です
};

使用方法

GETリクエスト

import { get } from '@sutech_jp/raas-client-for-typescript';

// データ取得の例
const fetchData = async () => {
  try {
    const data = await get(config, userContext, '/api/endpoint');
    console.log('取得したデータ:', data);
  } catch (error) {
    console.error('エラー:', error);
  }
};

POSTリクエスト

import { post } from '@sutech_jp/raas-client-for-typescript';

// データ送信の例
const sendData = async () => {
  const payload = {
    key1: 'value1',
    key2: 'value2'
  };

  try {
    const response = await post(config, userContext, '/api/endpoint', payload);
    console.log('レスポンス:', response);
  } catch (error) {
    console.error('エラー:', error);
  }
};

PUTリクエスト

import { put } from '@sutech_jp/raas-client-for-typescript';

// データ更新の例
const updateData = async () => {
  const payload = {
    key1: 'updated-value1',
    key2: 'updated-value2'
  };

  try {
    const response = await put(config, userContext, '/api/endpoint', payload);
    console.log('レスポンス:', response);
  } catch (error) {
    console.error('エラー:', error);
  }
};

DELETEリクエスト

import { del } from '@sutech_jp/raas-client-for-typescript';

// データ削除の例
const deleteData = async () => {
  try {
    await del(config, userContext, '/api/endpoint');
    console.log('削除成功');
  } catch (error) {
    console.error('エラー:', error);
  }
};

エラーハンドリング

すべてのAPIリクエストメソッドは、HTTPエラーが発生した場合にエラーをスローします。try/catchブロックを使用してエラーを適切に処理してください。

開発

必要条件

• Node.js 18以上
• npm 7以上

ライセンス

SuTech-JP社の製品を利用するのに必要です