JavaScript SDKについて

Hexabase JavaScript SDKについて

対応環境・ソフトウェアについて

Hexabase JavaScript SDKを利用する際には、以下の環境・ソフトウェアが必要となります。

• OS
  Windows, macOS, Linux
• Node.js

Node.jsは最新2バージョンをサポートしています。

Getting started

Hexabase JavaScript SDKはNode.jsアプリケーション（フロントエンド向け含む）にて利用されます。まず、ディレクトリを作成します。

$ mkdir my-app
$ cd my-app

次に、Node.jsプロジェクトを初期化します。

$ npm init -y

コマンドが成功すると、 以下のような内容の package.json が作成されます。

{
  "name": "my-app",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC"
}

SDKのインストール

続けて、Hexabase JavaScript SDKをインストールします。

npm i @hexabase/hexabase-js

コマンドが成功すると、 node_modules ディレクトリが作成され、Hexabase JavaScript SDKがインストールされます。また、 package-lock.json というファイルが作成されます。

ここまでで準備完了です。

SDKの利用する

デモ用のアカウント、ワークスペースを用意していますので、以下の情報を利用してください。

変数名	項目	値
workspaceId	ワークスペースのID	demo_workspace
projectId	プロジェクトのID	sdk
datastoreId	データストアのID	hello
email	ログインメールアドレス	[email protected]
password	ログインパスワード	hexabase.com5678

まずJavaScriptファイルを用意します。ファイル名は index.mjs としてください（.jsではありません）。

最初にHexabase SDKをインポートします。

import { HexabaseClient }  from '@hexabase/hexabase-js';

次に、HexabaseClientを初期化します。

const client = new HexabaseClient();

変数を定義する

上記の変数を定義します。

const workspaceId = 'demo_workspace';
const projectId = 'sdk';
const datastoreId = 'hello';
const email = '[email protected]';
const password = 'hexabase.com5678';

ログインする

Hexabaseでは非同期処理が多用されるので、処理全体を async で囲みます。

(async () => {
    // 以下のコードはこの中に書きます
})();

まずログインを行います。

await client.login({email, password});

ワークスペース・プロジェクトを設定する

ログイン成功したら、ワークスペースを設定します。

await client.setWorkspace(workspaceId);

続けて、プロジェクトを取得します。

const project = await client.currentWorkspace.project(projectId);

最後にデータストアを取得します。

const datastore = await project.datastore(datastoreId);

データを保存してみる

では、このデータストアに対してデータを保存してみましょう。今回のデータストア hello には以下のフィールドを用意しています。

フィールド名（英語）	フィールド名（日本語）	フィールドタイプ
message	メッセージ	文字列

まず、データを作成します。

const item = await datastore.item();

続けて、この item に対してフィールドを設定します。

item.set('message', 'Hello, Hexabase!');

データを保存します。

await item.save();

ちゃんと保存されていれば、アイテムのIDが取得できます。

console.log(item.id);

コードを実行する

では、このコードを実行してみましょう。

node index.mjs

653f41f032d80f256a06015f のような文字列が返ってくれば、成功です。

全体のコード

ここまでのコードをまとめると以下のようになります。

// Hexabase JavaScript SDKをインポート
import { HexabaseClient }  from '@hexabase/hexabase-js';

// HexabaseClientを初期化
const client = new HexabaseClient();

// デモ用のワークスペース、プロジェクト、認証情報など
const workspaceId = 'demo_workspace';
const projectId = 'sdk';
const datastoreId = 'hello';
const email = '[email protected]';
const password = 'hexabase.com5678';

(async () => {
    // ログイン
    await client.login({email, password});
    // ワークスペースを設定
    await client.setWorkspace(workspaceId);
    // プロジェクトを取得
    const project = await client.currentWorkspace.project(projectId);
    // データストアを取得
    const datastore = await project.datastore(datastoreId);
    // データを新規作成
    const item = await datastore.item();
    // フィールドを設定
    item.set('message', 'Hello, Hexabase!');
    // データを保存
    await item.save();
    // アイテムIDを表示
    console.log(item.id);
})();

SDKの詳しい使い方を見る場合は、右側のメニューからクラスを選んでください。

License

Hexabase JavaScript SDKはMIT licensedにて公開されています。