概要

JavaScript 用 DID Space Client SDK へようこそ！これは Node.js 環境向けに設計された、強力でモダンなライブラリで、DID Space とのシームレスな対話を可能にします。ユーザーが自身のデータを真に所有し、管理するアプリケーションを構築しているなら、ここは最適な場所です。

この SDK は、暗号技術によって安全性が確保され、ユーザー中心の分散型ストレージシステムにおいて、ファイルの管理、フォルダの同期、その他のデータオブジェクトの処理を行うための、シンプルかつ包括的なインターフェースを提供します。

主な機能

コアアーキテクチャ

この SDK は、シンプルで堅牢なコマンドベースのアーキテクチャ上に構築されています。API との対話は、主に2つのコンポーネントを通じて行います。

1. `SpaceClient`

   SDK のメインエントリーポイントです。設定と認証情報でインスタンス化します。

2. コマンド

   ファイルのアップロードやディレクトリのコンテンツ一覧表示など、実行したい特定のアクションを表すクラスです。各コマンドは、それぞれの操作に必要なパラメータとロジックをカプセル化しています。

アプリケーションはコマンドオブジェクトを作成し、必要な入力値を設定した後、それを SpaceClient の send メソッドに渡してリクエストを実行します。

SDK の使用パターン

import { SpaceClient, PutObjectCommand } from '@blocklet/did-space-js';
import getWallet from '@blocklet/sdk/lib/wallet';

async function uploadFile() {
  // 1. 認証情報でクライアントを初期化
  const client = new SpaceClient({
    auth: {
      endpoint: 'https://www.didspaces.com/app/api/space/...',
      wallet: getWallet(),
    },
  });

  // 2. 特定の入力を持つコマンドを作成
  const command = new PutObjectCommand({
    key: 'documents/hello.txt',
    data: 'Hello, DID Space!',
  });

  // 3. コマンドを送信し、出力を受け取る
  const output = await client.send(command);

  if (output.statusCode === 200) {
    console.log('File uploaded successfully!');
  } else {
    console.error('Upload failed:', output.statusMessage);
  }
}

uploadFile();

この設計パターンにより、SDK は高いモジュール性を持ち、拡張が容易になっています。各コマンドは自己完結しているため、コードはクリーンで整理された状態に保たれます。

このドキュメントの歩き方

このドキュメントは、あなたが始めたばかりであろうと、特定の詳細を探していようと、必要な情報を見つけられるように構成されています。

次のステップ

ビルドを始める準備はできましたか？最善の学習方法は、実践することです。『はじめに』ガイドに従って SDK をインストールし、最初の API コールを行ってみましょう。