メインコンテンツまでスキップ

クライアント SDK

Squid Client SDKは、クライアントアプリケーションがSquidサーバーに接続し、Squidが提供する各種サービスに安全にアクセスできるようにするTypeScriptライブラリです。​

Squid Client SDKは、Squid AIソリューション、データベースやAPIコネクタ、認証、バックエンド機能など、Squidの各機能とアプリが連携するための主要な手段となります。

ほとんどのClient SDKの機能はlocal-firstとなっており、データベースレコードの更新がローカルですぐに反映され、その後サーバーと同期されます。これにより、Squidはアプリケーション向けにリアルタイムアップデートを提供できます。

注意

Client SDKは、フロントエンド開発とカスタムバックエンド開発の両方で利用可能です。これにより、フロントエンドアプリケーションとバックエンド機能の両方でSDKを使用でき、コードの共有が促進され、開発プロセスが簡素化されます。

Squidバックエンド上では、Client SDKは初期化なしですぐに利用可能です。拡張したSquidServiceクラス内でthis.squidを使用して直接アクセスできます。

Client SDK のセットアップ​

npm を使用してClient SDKをインストールします:

npm install @squidcloud/client

Squidクライアントは、さまざまなフレームワークやプラットフォームで利用できます。Squidクライアントを初期化するには、SDKからSquidクラスをインポートし、appId、region、environmentIdを渡してSquidクライアントのインスタンスを作成します。ローカル開発の場合は、squidDeveloperIdも含めてください。これらの値はSquid Consoleのアプリケーション概要ページで確認できます:

Client code
import { Squid } from '@squidcloud/client';

const squid = new Squid({
  appId: 'YOUR_APP_ID',
  region: 'YOUR_REGION', // example: 'us-east-1.aws'
  environmentId: 'dev',  // or prod
  squidDeveloperId: 'YOUR_SQUID_DEVELOPER_ID',
});

Squidクラスは、Squid Client SDKへの主要なエントリーポイントとして機能し、Squidの全機能にアクセスするための包括的な機能群を提供します。

Client SDKが提供する機能の詳細については、managing database data、AI agents and workflows、Squid storage bucket connectors、API connectorsの各ドキュメントをご覧ください。

探している機能が見つからない場合は、こちらからプロジェクトに関するサポートをお問い合わせください！