SDK の概要
Cozeni の公式 SDK(JavaScript / TypeScript)。
Cozeni の公式 SDK はサーバーで動く JavaScript / TypeScript のパッケージです。お客様の権利の確認、商品の管理、機能フラグ、Next.js 用のヘルパー、CLI を含みます。購入者限定ページを組み込むだけなら、お客様の権利を確かめる createCustomerClient(Next.js では @nulogic/cozeni-sdk/next の関数)で足ります。
パッケージ
- パッケージ名は
@nulogic/cozeni-sdkです。npm で公開しています。ソースも GitHub で公開しています。 - バージョンは固定して入れてください。例:
@nulogic/cozeni-sdk@0.8.0 - Node.js 20 以上で動きます。標準の
fetchを持つサーバー環境で使います。 - Next.js は
@nulogic/cozeni-sdk/nextを使うときだけ必要です。対応するバージョンは 15 と 16 です。
含まれるもの
| 名前 | 用途 |
|---|---|
@nulogic/cozeni-sdk |
お客様の権利の確認(createCustomerClient)と、商品の管理(createManagementClient)です。フレームワークに依存しません。 |
@nulogic/cozeni-sdk/next |
Next.js(App Router)用です。ハンドオフ、ページの認可、Route Handler、機能フラグを扱います。 |
cozeni(CLI) |
商品の作成、購入リンクの取得、販売状態の確認、テスト購入を、ターミナルや AI エージェントから行います。 |
| 導入用の skill | AI エージェント向けの手順書です。init がプロジェクトに置きます。 |
どれを使うか
| 作りたいもの | 使うもの |
|---|---|
| Next.js(App Router)の購入者限定ページ | Next.js の @nulogic/cozeni-sdk/next |
| Express、Hono など、ほかのサーバー | JavaScript / TypeScript の createCustomerClient |
| 商品をプログラムから作る、更新する | JavaScript / TypeScript の createManagementClient |
| 商品をターミナルや AI エージェントから作る | CLI の cozeni |
導入例
SDK のリポジトリに、そのまま動かせる導入例があります。
- Next.js の導入例(
examples/nextjs):買い切りの商品1つと、限定ページ1つの構成です。Next.js 16 で書かれています。 - JavaScript サーバーの導入例(
examples/javascript-server):Web 標準のRequestとResponseで、限定ページ、限定の API、コードの交換を書いた例です。Node.js の HTTP サーバーで動かす例も含みます。