@orizm/cli 3.1.0 → 3.3.0-beta.0

package/dist/docs/features/cms-sdk/auth.md

@@ -0,0 +1,122 @@
+<!-- source: docs/src/app/features/cms-sdk/auth/page.mdx -->
+
+# 認証
+
+> [!WARNING]
+> 現在、`next-auth@4` を使用した Next.js との統合のみサポートしています。
+
+このドキュメントではCMS SDKを利用した認証処理の実装方法を説明します。現在、next-auth v4を使用した認証をサポートしています。このガイドでは以下の内容を学べます：
+
+- next-auth v4のインストール方法
+- 認証設定の構成方法
+- 認証APIの実装方法
+- アクセス制御のためのMiddlewareの設定方法
+
+## next-auth v4 のインストール
+
+next-auth v4をインストールするには以下のコマンドを実行します。auth.jsによる導入例は現時点で提供していません。
+
+```bash
+pnpm add next-auth@4
+```
+
+## 認証設定の構成
+
+認証設定は`authOptions`オブジェクトで構成します。`app/api/auth/[...nextauth].js`ファイルを作成し、以下のコードを記述します。
+
+```ts
+import { generateOrizmNextAuth } from "@orizm/cms-sdk/next-auth";
+import type { NextAuthOptions, Session } from "next-auth";
+import type { JWT } from "next-auth/jwt";
+
+export interface CustomSession extends Session {
+  accessToken: string;
+}
+
+interface ExtendedToken extends JWT {
+  accessToken?: string;
+}
+
+const orizmAuth = generateOrizmNextAuth({
+  id: "Orizm",
+  name: "Orizm",
+  clientId: process.env.ORIZM_CLIENT_ID,
+  clientSecret: process.env.ORIZM_CLIENT_SECRET,
+  projectName: process.env.NEXT_PUBLIC_ORIZM_PROJECT,
+  baseURL: process.env.NEXT_PUBLIC_ORIZM_BASE_URL,
+});
+
+export const authOptions = {
+  secret: process.env.NEXTAUTH_SECRET,
+  // Orizm認証プロバイダーを設定
+  providers: [orizmAuth.provider],
+  // JWTベースのセッション管理を設定
+  session: {
+    strategy: "jwt",
+  },
+  callbacks: {
+    async jwt(params) {
+      const extendedToken: ExtendedToken = params.token as ExtendedToken;
+      if (params.account) {
+        if (params.account.accessToken) {
+          extendedToken.accessToken = params.account.accessToken as string;
+        }
+      }
+      return orizmAuth.jwtCallback({ ...params, token: extendedToken });
+    },
+    async session(params) {
+      const extendedToken: ExtendedToken = params.token as ExtendedToken;
+      const customSession: CustomSession = {
+        ...params.session,
+        accessToken: extendedToken.accessToken ?? "",
+      };
+      return orizmAuth.sessionCallback({ ...params, session: customSession });
+    },
+  },
+  debug: process.env.NEXT_PUBLIC_VERCEL_ENV === "development",
+};
+```
+
+上記の設定により、`/api/auth/*`パスに認証関連のAPIエンドポイントが自動生成され、Next.jsのルーティングで利用できるようになります。
+
+## 認証APIの実装
+
+認証APIはNext.jsのAPI Routesを使って実装されます。`app/api/auth/[...nextauth].js`ファイルにより、次のAPIエンドポイントが自動的に提供されます：
+
+- `/api/auth/signin` - サインイン画面の提供
+- `/api/auth/signout` - サインアウト処理
+- `/api/auth/session` - セッション情報の取得
+- 各認証プロバイダーに対応した認証フロー
+
+必要に応じて`authOptions`の設定を拡張し、カスタムコールバックやイベントハンドラを追加してください。
+
+## Middlewareによるアクセス制御
+
+認証済みユーザーのみにアクセスを許可するには、Next.jsのMiddlewareを使用します。`src/middleware.ts`ファイルを作成し、以下のコードを追加します：
+
+```ts
+import { withAuth } from "next-auth/middleware";
+
+export default withAuth({
+  pages: {
+    signIn: "/signin",
+  },
+});
+
+/**
+ * @see https://vercel.com/docs/functions/edge-middleware/middleware-api#match-based-on-a-negative-lookahead
+ */
+export const config = {
+  matcher: [
+    "/((?!_next|[^?]*\\.(?:html?|css|js(?!on)|jpe?g|webp|png|gif|svg|ttf|woff2?|ico|csv|docx?|xlsx?|zip|webmanifest)|signin|api).*)",
+  ],
+};
+```
+
+アクセス制御の設定をカスタマイズするには、matcherパターンを変更するか、認可コールバックを追加してください。
+
+## 関連ドキュメント
+
+詳細な情報は、公式ドキュメントを参照してください：
+
+- [NextAuth.js 公式ドキュメント](https://next-auth.js.org/getting-started/introduction)

package/dist/docs/features/cms-sdk/bucket.md

@@ -0,0 +1,113 @@
+<!-- source: docs/src/app/features/cms-sdk/bucket/page.mdx -->
+
+# バケットの操作
+
+CMS SDKを使用したバケットの操作方法を説明します。このドキュメントでは以下の内容を解説します。
+
+- オブジェクトの単体取得・一覧取得
+- ファイルのアップロード
+- オブジェクトの削除
+
+## オブジェクトの一覧取得
+
+バケット内のオブジェクト一覧を取得するには、`list()` を使用します。
+
+```ts
+const data = await bucketClient.list();
+```
+
+### フィルタリング
+
+`filter` プロパティを使用して、条件に一致するオブジェクトのみを取得できます。
+
+以下の項目でフィルタ可能です。
+
+- `key`: オブジェクトのキー
+- `group`: オブジェクトのグループ
+
+以下の例では、キーに `example` を含むオブジェクトを取得します。
+
+```ts
+const data = await bucketClient.list({
+  filter: {
+    key: { $contains: "example" },
+  },
+});
+```
+
+条件の指定方法については、[フィルタ](./fetch-contents.md#フィルタ) を参照してください。
+
+### ページネーション
+
+`limit` と `offset` プロパティを使用して、ページネーションを行うことができます。
+
+```ts
+const data = await bucketClient.list({
+  limit: 10,
+  offset: 0,
+});
+```
+
+`limit` パラメータを指定しない場合、デフォルトで100件まで取得されます。
+
+## ファイルのアップロード
+
+ファイルをバケットにアップロードするには、`upload()` を使用します。
+
+```ts
+const data = await bucketClient.upload(file);
+```
+
+### オプション付きアップロード
+
+カスタムキーやグループを指定してアップロードできます。キーを指定しない場合は自動的に生成されます。
+
+```ts
+const data = await bucketClient.upload(file, {
+  key: "custom-key",
+  group: "admin",
+});
+```
+
+## オブジェクトの取得
+
+キーを指定して単一のオブジェクトを取得します。
+
+```ts
+const data = await bucketClient.get(objectKey);
+```
+
+## オブジェクトの削除
+
+### 単一オブジェクトの削除
+
+キーを指定して単一のオブジェクトを削除します。
+
+```ts
+const data = await bucketClient.delete(objectKey);
+```
+
+### 複数オブジェクトの削除
+
+複数のオブジェクトを一括削除します。
+
+```ts
+await bucketClient.deleteObjects({});
+```
+
+> [!WARNING]
+> `deleteObjects()`
+> でフィルタを指定しない場合、バケット内のすべてのオブジェクトが削除されます。
+
+### フィルタを使用した削除
+
+特定の条件に一致するオブジェクトを削除できます。
+
+```ts
+await bucketClient.deleteObjects({
+  filter: {
+    key: { $contains: "old_" },
+    group: "admin",
+  },
+});
+```

package/dist/docs/features/cms-sdk/cli.md

@@ -0,0 +1,104 @@
+<!-- source: docs/src/app/features/cms-sdk/cli/page.mdx -->
+
+# CMS CLI
+
+CMS CLIで利用可能なコマンドを説明します。
+
+> [!CAUTION]
+> 廃止予定
+>
+> @orizm/cms-sdk や @orizm/consumer-sdk に同梱されている CLI は廃止が予定されています。
+> 代わりに @orizm/cli パッケージを利用してください。
+> SDK同梱のCLIから新しいCLIへの移行方法は [CLI移行ガイド](../../resources/cli-migration-guide.md) や [CLI](../cli.md) を参照してください。
+>
+
+## update
+
+Orizmプロジェクトにスキーマを適用します。
+
+```sh copy
+orizm-cms update
+```
+
+このコマンドは以下の処理を行います。
+
+1. 設定ファイル（デフォルトでは `./orizm.config.ts`）からスキーマを読み込み
+1. どのような変更が行われるか確認（意図しないものであればこの時点でキャンセル可能）
+1. Orizmプロジェクトにスキーマを適用
+1. クライアントコードとTypeScriptの型定義ファイルを生成
+
+以下のオプションがあります。
+
+### --env \<path>
+
+環境変数ファイルのパスを指定します。デフォルトは `.env.x.local` です。
+
+```sh copy
+orizm-cms update --env ./path/to/file
+```
+
+環境変数ファイルは必須です。以下のように設定してください。`<Orizmプロジェクト名>` と `<Developer API Key>` はそれぞれプロジェクト名とAPIキーに置き換えてください。プロジェクト名とAPIキーは、プロジェクトの設定ページから取得できます。
+
+```ini copy filename=".env.x.local"
+ORIZM_BASE_URL=https://app.orizm.com
+ORIZM_PROJECT=<Orizmプロジェクト名>
+ORIZM_API_KEY=<Developer API Key>
+```
+
+### --config \<path>
+
+設定ファイルのパスを指定します。デフォルトは `./orizm.config.ts` です。
+
+```sh copy
+orizm-cms update --config ./path/to/file.ts
+```
+
+### --output \<path>
+
+生成されるコードの出力先ディレクトリを指定します。デフォルトは `./src/orizm` です。
+
+```sh copy
+orizm-cms update --output ./path/to/directory
+```
+
+### --dry-run
+
+実際にスキーマを適用することなく、どのような変更が行われるかを確認できます。
+
+```sh copy
+orizm-cms update --dry-run
+```
+
+### -y, --yes
+
+全てのプロンプトに対して `yes` で回答します。CI環境などインタラクティブな操作ができない場合に利用します。
+
+```sh copy
+orizm-cms update --yes
+```
+
+## generate
+
+クライアントコードとTypeScriptの型定義ファイルを生成します。
+
+```sh copy
+orizm-cms generate
+```
+
+以下のオプションがあります。
+
+### --config \<path>
+
+設定ファイルのパスを指定します。デフォルトは `./orizm.config.ts` です。
+
+```sh copy
+orizm-cms update --config ./path/to/file.ts
+```
+
+### --output \<path>
+
+生成されるコードの出力先ディレクトリを指定します。デフォルトは `./src/orizm` です。
+
+```sh copy
+orizm-cms update --output ./path/to/directory
+```