実装コンセプト #

メソッドチェーン #

メソッドやプロパティは、メソッドチェーンによってアクセスできるようにデザインされています。

以下は特定のイベントが持つ物販を全て取得する例です。

要素ごとに取得

const stage = Hedgehog.stage.ref("ステージのUUID");
const liveEvent = stage.event.ref("イベントのUUID");
const products = await liveEvent.products().all();

ワンラインで取得

const products = await Hedgehog.stage
  .ref("ステージのUUID")
  .event.ref("イベントのUUID")
  .products()
  .all();

参照と実体 #

hedgehog では、データの参照( ref )に対して操作を行います。データの実体を SDK が保持する事はなく、全て get 等のメソッドによって取得します。

// ステージ参照を取得
const stage = Hedgehog.stage.ref("ステージのUUID");
// ステージ名を取得
const name = await stage.getName();

認証について #

Hedgehog SDK は基本的にフロントエンドライブラリであるため、エンドユーザーがアクセスする時のために認証が無くても使用する事が出来るように設計されています。これは、 ステージのUUID が分かれば誰でもそのステージのフロントエンドを作成する事ができる という事を意味しています。

ただし、作成/更新系の操作や、機密性の高い情報の取得には認証が必要になります。hedgehog では標準ダッシュボードを備えていますが、ステージに特化したカスタムのダッシュボードを作成したい時等にこのエリアにアクセスする必要が出てきます。

要認証操作の明示 #

取得に認証が必要なメソッドやプロパティは、全て admin 以下に配置されています。

await Hedgehog.stage
  .ref("ステージのUUID")
  .event.ref("イベントのUUID")
  .admin.update({
    /**/
  });

これにより、どの操作に認証が必要なのかが明示的になります。

admin 以下に配置されているメソッドやプロパティにアクセスする時は、その前に認証を行ってください。