@feelflow/ffid-sdk 1.7.3 → 1.8.0

package/README.md

@@ -17,6 +17,10 @@ yarn add @feelflow/ffid-sdk
 pnpm add @feelflow/ffid-sdk
 ```
 
+## 統合ガイド
+
+サービスを FFID Platform に統合する詳細なガイドは **[Integration Guide](./docs/INTEGRATION_GUIDE.md)** を参照してください。OAuth フロー、フロントエンド/バックエンド実装パターン、セキュリティチェックリスト、アンチパターン集を網羅しています。
+
 ## クイックスタート
 
 ### 1. プロバイダーを設定（5行で完了！）
@@ -263,9 +267,10 @@ token mode では SDK は `/api/v1/oauth/userinfo` を呼び出し、基本プ
 
 ```ts
 interface FFIDOAuthUserInfoSubscription {
+  subscriptionId: string | null
   status: 'trialing' | 'active' | 'past_due' | 'canceled' | 'paused' | null
   planCode: string | null
-  seatModel: 'organization' | 'individual' | null
+  seatModel: 'organization' | null
   memberRole: 'owner' | 'admin' | 'member' | 'viewer' | null
   organizationId: string | null
 }

package/dist/{chunk-SNARMHI7.js → chunk-7WZBWL56.js}

@@ -412,6 +412,43 @@ function createBillingMethods(deps) {
   return { createCheckoutSession, createPortalSession };
 }
 
+// src/client/version-check.ts
+var SDK_VERSION = "1.8.0";
+var SDK_USER_AGENT = `FFID-SDK/${SDK_VERSION} (TypeScript)`;
+var SDK_VERSION_HEADER = "X-FFID-SDK-Version";
+var LATEST_VERSION_HEADER = "X-FFID-SDK-Latest-Version";
+var SEMVER_PATTERN = /^\d+(\.\d+)*$/;
+var _versionWarningShown = false;
+function compareSemver(a, b) {
+  const cleanA = a.replace(/^v/, "");
+  const cleanB = b.replace(/^v/, "");
+  if (!SEMVER_PATTERN.test(cleanA) || !SEMVER_PATTERN.test(cleanB)) return 0;
+  const partsA = cleanA.split(".").map(Number);
+  const partsB = cleanB.split(".").map(Number);
+  const maxLen = Math.max(partsA.length, partsB.length);
+  for (let i = 0; i < maxLen; i++) {
+    const numA = partsA[i] ?? 0;
+    const numB = partsB[i] ?? 0;
+    if (numA < numB) return -1;
+    if (numA > numB) return 1;
+  }
+  return 0;
+}
+function checkVersionHeader(response, logger) {
+  if (_versionWarningShown) return;
+  if (typeof process !== "undefined" && process.env?.NODE_ENV === "production") return;
+  if (!response.headers?.get) return;
+  const latestVersion = response.headers.get(LATEST_VERSION_HEADER);
+  if (!latestVersion) return;
+  if (compareSemver(SDK_VERSION, latestVersion) < 0) {
+    _versionWarningShown = true;
+    logger.warn(
+      `\u65B0\u3057\u3044\u30D0\u30FC\u30B8\u30E7\u30F3\u304C\u5229\u7528\u53EF\u80FD\u3067\u3059: v${latestVersion} (\u73FE\u5728: v${SDK_VERSION})
+npm install @feelflow/ffid-sdk@latest \u3067\u30A2\u30C3\u30D7\u30C7\u30FC\u30C8\u3067\u304D\u307E\u3059`
+    );
+  }
+}
+
 // src/client/ffid-client.ts
 var NO_CONTENT_STATUS = 204;
 var SESSION_ENDPOINT = "/api/v1/auth/session";
@@ -512,6 +549,7 @@ function createFFIDClient(config) {
       };
     }
     logger.debug("Response:", response.status, raw);
+    checkVersionHeader(response, logger);
     if (!response.ok) {
       return {
         error: raw.error ?? {
@@ -530,6 +568,12 @@ function createFFIDClient(config) {
     }
     return { data: raw.data };
   }
+  function sdkHeaders() {
+    return {
+      "User-Agent": SDK_USER_AGENT,
+      [SDK_VERSION_HEADER]: SDK_VERSION
+    };
+  }
   function buildFetchOptions(options) {
     if (authMode === "service-key") {
       return {
@@ -537,6 +581,7 @@ function createFFIDClient(config) {
         credentials: "omit",
         headers: {
           "Content-Type": "application/json",
+          ...sdkHeaders(),
           "X-Service-Api-Key": serviceApiKey,
           ...options.headers
         }
@@ -546,6 +591,7 @@ function createFFIDClient(config) {
       const tokens = tokenStore.getTokens();
       const headers = {
         "Content-Type": "application/json",
+        ...sdkHeaders(),
         ...options.headers
       };
       if (tokens) {
@@ -562,6 +608,7 @@ function createFFIDClient(config) {
       credentials: "include",
       headers: {
         "Content-Type": "application/json",
+        ...sdkHeaders(),
         ...options.headers
       }
     };
@@ -607,7 +654,8 @@ function createFFIDClient(config) {
         credentials: "omit",
         headers: {
           "Authorization": `Bearer ${tokens.accessToken}`,
-          "Content-Type": "application/json"
+          "Content-Type": "application/json",
+          ...sdkHeaders()
         }
       });
     } catch (error) {
@@ -629,7 +677,8 @@ function createFFIDClient(config) {
               credentials: "omit",
               headers: {
                 "Authorization": `Bearer ${retryTokens.accessToken}`,
-                "Content-Type": "application/json"
+                "Content-Type": "application/json",
+                ...sdkHeaders()
               }
             });
           } catch (retryError) {
@@ -699,7 +748,7 @@ function createFFIDClient(config) {
       response = await fetch(url, {
         method: "POST",
         credentials: "include",
-        headers: { "Content-Type": "application/json" }
+        headers: { "Content-Type": "application/json", ...sdkHeaders() }
       });
     } catch (error) {
       logger.error("Network error:", error);
@@ -748,7 +797,7 @@ function createFFIDClient(config) {
       await fetch(url, {
         method: "POST",
         credentials: "omit",
-        headers: { "Content-Type": "application/x-www-form-urlencoded" },
+        headers: { "Content-Type": "application/x-www-form-urlencoded", ...sdkHeaders() },
         body: new URLSearchParams({
           token: tokens.accessToken,
           client_id: clientId
@@ -787,7 +836,7 @@ function createFFIDClient(config) {
       response = await fetch(url, {
         method: "POST",
         credentials: "omit",
-        headers: { "Content-Type": "application/x-www-form-urlencoded" },
+        headers: { "Content-Type": "application/x-www-form-urlencoded", ...sdkHeaders() },
         body: new URLSearchParams(body).toString()
       });
     } catch (error) {
@@ -845,7 +894,7 @@ function createFFIDClient(config) {
       response = await fetch(url, {
         method: "POST",
         credentials: "omit",
-        headers: { "Content-Type": "application/x-www-form-urlencoded" },
+        headers: { "Content-Type": "application/x-www-form-urlencoded", ...sdkHeaders() },
         body: new URLSearchParams({
           grant_type: "refresh_token",
           refresh_token: tokens.refreshToken,

package/dist/{chunk-LLOXOE37.cjs → chunk-DEN7AUNE.cjs}

@@ -414,6 +414,43 @@ function createBillingMethods(deps) {
   return { createCheckoutSession, createPortalSession };
 }
 
+// src/client/version-check.ts
+var SDK_VERSION = "1.8.0";
+var SDK_USER_AGENT = `FFID-SDK/${SDK_VERSION} (TypeScript)`;
+var SDK_VERSION_HEADER = "X-FFID-SDK-Version";
+var LATEST_VERSION_HEADER = "X-FFID-SDK-Latest-Version";
+var SEMVER_PATTERN = /^\d+(\.\d+)*$/;
+var _versionWarningShown = false;
+function compareSemver(a, b) {
+  const cleanA = a.replace(/^v/, "");
+  const cleanB = b.replace(/^v/, "");
+  if (!SEMVER_PATTERN.test(cleanA) || !SEMVER_PATTERN.test(cleanB)) return 0;
+  const partsA = cleanA.split(".").map(Number);
+  const partsB = cleanB.split(".").map(Number);
+  const maxLen = Math.max(partsA.length, partsB.length);
+  for (let i = 0; i < maxLen; i++) {
+    const numA = partsA[i] ?? 0;
+    const numB = partsB[i] ?? 0;
+    if (numA < numB) return -1;
+    if (numA > numB) return 1;
+  }
+  return 0;
+}
+function checkVersionHeader(response, logger) {
+  if (_versionWarningShown) return;
+  if (typeof process !== "undefined" && process.env?.NODE_ENV === "production") return;
+  if (!response.headers?.get) return;
+  const latestVersion = response.headers.get(LATEST_VERSION_HEADER);
+  if (!latestVersion) return;
+  if (compareSemver(SDK_VERSION, latestVersion) < 0) {
+    _versionWarningShown = true;
+    logger.warn(
+      `\u65B0\u3057\u3044\u30D0\u30FC\u30B8\u30E7\u30F3\u304C\u5229\u7528\u53EF\u80FD\u3067\u3059: v${latestVersion} (\u73FE\u5728: v${SDK_VERSION})
+npm install @feelflow/ffid-sdk@latest \u3067\u30A2\u30C3\u30D7\u30C7\u30FC\u30C8\u3067\u304D\u307E\u3059`
+    );
+  }
+}
+
 // src/client/ffid-client.ts
 var NO_CONTENT_STATUS = 204;
 var SESSION_ENDPOINT = "/api/v1/auth/session";
@@ -514,6 +551,7 @@ function createFFIDClient(config) {
       };
     }
     logger.debug("Response:", response.status, raw);
+    checkVersionHeader(response, logger);
     if (!response.ok) {
       return {
         error: raw.error ?? {
@@ -532,6 +570,12 @@ function createFFIDClient(config) {
     }
     return { data: raw.data };
   }
+  function sdkHeaders() {
+    return {
+      "User-Agent": SDK_USER_AGENT,
+      [SDK_VERSION_HEADER]: SDK_VERSION
+    };
+  }
   function buildFetchOptions(options) {
     if (authMode === "service-key") {
       return {
@@ -539,6 +583,7 @@ function createFFIDClient(config) {
         credentials: "omit",
         headers: {
           "Content-Type": "application/json",
+          ...sdkHeaders(),
           "X-Service-Api-Key": serviceApiKey,
           ...options.headers
         }
@@ -548,6 +593,7 @@ function createFFIDClient(config) {
       const tokens = tokenStore.getTokens();
       const headers = {
         "Content-Type": "application/json",
+        ...sdkHeaders(),
         ...options.headers
       };
       if (tokens) {
@@ -564,6 +610,7 @@ function createFFIDClient(config) {
       credentials: "include",
       headers: {
         "Content-Type": "application/json",
+        ...sdkHeaders(),
         ...options.headers
       }
     };
@@ -609,7 +656,8 @@ function createFFIDClient(config) {
         credentials: "omit",
         headers: {
           "Authorization": `Bearer ${tokens.accessToken}`,
-          "Content-Type": "application/json"
+          "Content-Type": "application/json",
+          ...sdkHeaders()
         }
       });
     } catch (error) {
@@ -631,7 +679,8 @@ function createFFIDClient(config) {
               credentials: "omit",
               headers: {
                 "Authorization": `Bearer ${retryTokens.accessToken}`,
-                "Content-Type": "application/json"
+                "Content-Type": "application/json",
+                ...sdkHeaders()
               }
             });
           } catch (retryError) {
@@ -701,7 +750,7 @@ function createFFIDClient(config) {
       response = await fetch(url, {
         method: "POST",
         credentials: "include",
-        headers: { "Content-Type": "application/json" }
+        headers: { "Content-Type": "application/json", ...sdkHeaders() }
       });
     } catch (error) {
       logger.error("Network error:", error);
@@ -750,7 +799,7 @@ function createFFIDClient(config) {
       await fetch(url, {
         method: "POST",
         credentials: "omit",
-        headers: { "Content-Type": "application/x-www-form-urlencoded" },
+        headers: { "Content-Type": "application/x-www-form-urlencoded", ...sdkHeaders() },
         body: new URLSearchParams({
           token: tokens.accessToken,
           client_id: clientId
@@ -789,7 +838,7 @@ function createFFIDClient(config) {
       response = await fetch(url, {
         method: "POST",
         credentials: "omit",
-        headers: { "Content-Type": "application/x-www-form-urlencoded" },
+        headers: { "Content-Type": "application/x-www-form-urlencoded", ...sdkHeaders() },
         body: new URLSearchParams(body).toString()
       });
     } catch (error) {
@@ -847,7 +896,7 @@ function createFFIDClient(config) {
       response = await fetch(url, {
         method: "POST",
         credentials: "omit",
-        headers: { "Content-Type": "application/x-www-form-urlencoded" },
+        headers: { "Content-Type": "application/x-www-form-urlencoded", ...sdkHeaders() },
         body: new URLSearchParams({
           grant_type: "refresh_token",
           refresh_token: tokens.refreshToken,

package/dist/components/index.cjs

@@ -1,30 +1,30 @@
 'use strict';
 
-var chunkLLOXOE37_cjs = require('../chunk-LLOXOE37.cjs');
+var chunkDEN7AUNE_cjs = require('../chunk-DEN7AUNE.cjs');
 
 
 
 Object.defineProperty(exports, "FFIDAnnouncementBadge", {
   enumerable: true,
-  get: function () { return chunkLLOXOE37_cjs.FFIDAnnouncementBadge; }
+  get: function () { return chunkDEN7AUNE_cjs.FFIDAnnouncementBadge; }
 });
 Object.defineProperty(exports, "FFIDAnnouncementList", {
   enumerable: true,
-  get: function () { return chunkLLOXOE37_cjs.FFIDAnnouncementList; }
+  get: function () { return chunkDEN7AUNE_cjs.FFIDAnnouncementList; }
 });
 Object.defineProperty(exports, "FFIDLoginButton", {
   enumerable: true,
-  get: function () { return chunkLLOXOE37_cjs.FFIDLoginButton; }
+  get: function () { return chunkDEN7AUNE_cjs.FFIDLoginButton; }
 });
 Object.defineProperty(exports, "FFIDOrganizationSwitcher", {
   enumerable: true,
-  get: function () { return chunkLLOXOE37_cjs.FFIDOrganizationSwitcher; }
+  get: function () { return chunkDEN7AUNE_cjs.FFIDOrganizationSwitcher; }
 });
 Object.defineProperty(exports, "FFIDSubscriptionBadge", {
   enumerable: true,
-  get: function () { return chunkLLOXOE37_cjs.FFIDSubscriptionBadge; }
+  get: function () { return chunkDEN7AUNE_cjs.FFIDSubscriptionBadge; }
 });
 Object.defineProperty(exports, "FFIDUserMenu", {
   enumerable: true,
-  get: function () { return chunkLLOXOE37_cjs.FFIDUserMenu; }
+  get: function () { return chunkDEN7AUNE_cjs.FFIDUserMenu; }
 });

package/dist/components/index.js

@@ -1 +1 @@
-export { FFIDAnnouncementBadge, FFIDAnnouncementList, FFIDLoginButton, FFIDOrganizationSwitcher, FFIDSubscriptionBadge, FFIDUserMenu } from '../chunk-SNARMHI7.js';
+export { FFIDAnnouncementBadge, FFIDAnnouncementList, FFIDLoginButton, FFIDOrganizationSwitcher, FFIDSubscriptionBadge, FFIDUserMenu } from '../chunk-7WZBWL56.js';

package/dist/index.cjs

@@ -1,12 +1,12 @@
 'use strict';
 
-var chunkLLOXOE37_cjs = require('./chunk-LLOXOE37.cjs');
+var chunkDEN7AUNE_cjs = require('./chunk-DEN7AUNE.cjs');
 var react = require('react');
 var jsxRuntime = require('react/jsx-runtime');
 
 function withFFIDAuth(Component, options = {}) {
   const WrappedComponent = (props) => {
-    const { isLoading, isAuthenticated, login } = chunkLLOXOE37_cjs.useFFIDContext();
+    const { isLoading, isAuthenticated, login } = chunkDEN7AUNE_cjs.useFFIDContext();
     const hasRedirected = react.useRef(false);
     react.useEffect(() => {
       if (!isLoading && !isAuthenticated && options.redirectToLogin && !hasRedirected.current) {
@@ -31,82 +31,82 @@ function withFFIDAuth(Component, options = {}) {
 
 Object.defineProperty(exports, "DEFAULT_API_BASE_URL", {
   enumerable: true,
-  get: function () { return chunkLLOXOE37_cjs.DEFAULT_API_BASE_URL; }
+  get: function () { return chunkDEN7AUNE_cjs.DEFAULT_API_BASE_URL; }
 });
 Object.defineProperty(exports, "FFIDAnnouncementBadge", {
   enumerable: true,
-  get: function () { return chunkLLOXOE37_cjs.FFIDAnnouncementBadge; }
+  get: function () { return chunkDEN7AUNE_cjs.FFIDAnnouncementBadge; }
 });
 Object.defineProperty(exports, "FFIDAnnouncementList", {
   enumerable: true,
-  get: function () { return chunkLLOXOE37_cjs.FFIDAnnouncementList; }
+  get: function () { return chunkDEN7AUNE_cjs.FFIDAnnouncementList; }
 });
 Object.defineProperty(exports, "FFIDLoginButton", {
   enumerable: true,
-  get: function () { return chunkLLOXOE37_cjs.FFIDLoginButton; }
+  get: function () { return chunkDEN7AUNE_cjs.FFIDLoginButton; }
 });
 Object.defineProperty(exports, "FFIDOrganizationSwitcher", {
   enumerable: true,
-  get: function () { return chunkLLOXOE37_cjs.FFIDOrganizationSwitcher; }
+  get: function () { return chunkDEN7AUNE_cjs.FFIDOrganizationSwitcher; }
 });
 Object.defineProperty(exports, "FFIDProvider", {
   enumerable: true,
-  get: function () { return chunkLLOXOE37_cjs.FFIDProvider; }
+  get: function () { return chunkDEN7AUNE_cjs.FFIDProvider; }
 });
 Object.defineProperty(exports, "FFIDSubscriptionBadge", {
   enumerable: true,
-  get: function () { return chunkLLOXOE37_cjs.FFIDSubscriptionBadge; }
+  get: function () { return chunkDEN7AUNE_cjs.FFIDSubscriptionBadge; }
 });
 Object.defineProperty(exports, "FFIDUserMenu", {
   enumerable: true,
-  get: function () { return chunkLLOXOE37_cjs.FFIDUserMenu; }
+  get: function () { return chunkDEN7AUNE_cjs.FFIDUserMenu; }
 });
 Object.defineProperty(exports, "FFID_ANNOUNCEMENTS_ERROR_CODES", {
   enumerable: true,
-  get: function () { return chunkLLOXOE37_cjs.FFID_ANNOUNCEMENTS_ERROR_CODES; }
+  get: function () { return chunkDEN7AUNE_cjs.FFID_ANNOUNCEMENTS_ERROR_CODES; }
 });
 Object.defineProperty(exports, "createFFIDAnnouncementsClient", {
   enumerable: true,
-  get: function () { return chunkLLOXOE37_cjs.createFFIDAnnouncementsClient; }
+  get: function () { return chunkDEN7AUNE_cjs.createFFIDAnnouncementsClient; }
 });
 Object.defineProperty(exports, "createFFIDClient", {
   enumerable: true,
-  get: function () { return chunkLLOXOE37_cjs.createFFIDClient; }
+  get: function () { return chunkDEN7AUNE_cjs.createFFIDClient; }
 });
 Object.defineProperty(exports, "createTokenStore", {
   enumerable: true,
-  get: function () { return chunkLLOXOE37_cjs.createTokenStore; }
+  get: function () { return chunkDEN7AUNE_cjs.createTokenStore; }
 });
 Object.defineProperty(exports, "generateCodeChallenge", {
   enumerable: true,
-  get: function () { return chunkLLOXOE37_cjs.generateCodeChallenge; }
+  get: function () { return chunkDEN7AUNE_cjs.generateCodeChallenge; }
 });
 Object.defineProperty(exports, "generateCodeVerifier", {
   enumerable: true,
-  get: function () { return chunkLLOXOE37_cjs.generateCodeVerifier; }
+  get: function () { return chunkDEN7AUNE_cjs.generateCodeVerifier; }
 });
 Object.defineProperty(exports, "retrieveCodeVerifier", {
   enumerable: true,
-  get: function () { return chunkLLOXOE37_cjs.retrieveCodeVerifier; }
+  get: function () { return chunkDEN7AUNE_cjs.retrieveCodeVerifier; }
 });
 Object.defineProperty(exports, "storeCodeVerifier", {
   enumerable: true,
-  get: function () { return chunkLLOXOE37_cjs.storeCodeVerifier; }
+  get: function () { return chunkDEN7AUNE_cjs.storeCodeVerifier; }
 });
 Object.defineProperty(exports, "useFFID", {
   enumerable: true,
-  get: function () { return chunkLLOXOE37_cjs.useFFID; }
+  get: function () { return chunkDEN7AUNE_cjs.useFFID; }
 });
 Object.defineProperty(exports, "useFFIDAnnouncements", {
   enumerable: true,
-  get: function () { return chunkLLOXOE37_cjs.useFFIDAnnouncements; }
+  get: function () { return chunkDEN7AUNE_cjs.useFFIDAnnouncements; }
 });
 Object.defineProperty(exports, "useSubscription", {
   enumerable: true,
-  get: function () { return chunkLLOXOE37_cjs.useSubscription; }
+  get: function () { return chunkDEN7AUNE_cjs.useSubscription; }
 });
 Object.defineProperty(exports, "withSubscription", {
   enumerable: true,
-  get: function () { return chunkLLOXOE37_cjs.withSubscription; }
+  get: function () { return chunkDEN7AUNE_cjs.withSubscription; }
 });
 exports.withFFIDAuth = withFFIDAuth;

package/dist/index.js

@@ -1,5 +1,5 @@
-import { useFFIDContext } from './chunk-SNARMHI7.js';
-export { DEFAULT_API_BASE_URL, FFIDAnnouncementBadge, FFIDAnnouncementList, FFIDLoginButton, FFIDOrganizationSwitcher, FFIDProvider, FFIDSubscriptionBadge, FFIDUserMenu, FFID_ANNOUNCEMENTS_ERROR_CODES, createFFIDAnnouncementsClient, createFFIDClient, createTokenStore, generateCodeChallenge, generateCodeVerifier, retrieveCodeVerifier, storeCodeVerifier, useFFID, useFFIDAnnouncements, useSubscription, withSubscription } from './chunk-SNARMHI7.js';
+import { useFFIDContext } from './chunk-7WZBWL56.js';
+export { DEFAULT_API_BASE_URL, FFIDAnnouncementBadge, FFIDAnnouncementList, FFIDLoginButton, FFIDOrganizationSwitcher, FFIDProvider, FFIDSubscriptionBadge, FFIDUserMenu, FFID_ANNOUNCEMENTS_ERROR_CODES, createFFIDAnnouncementsClient, createFFIDClient, createTokenStore, generateCodeChallenge, generateCodeVerifier, retrieveCodeVerifier, storeCodeVerifier, useFFID, useFFIDAnnouncements, useSubscription, withSubscription } from './chunk-7WZBWL56.js';
 import { useRef, useEffect } from 'react';
 import { jsx, Fragment } from 'react/jsx-runtime';
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@feelflow/ffid-sdk",
-  "version": "1.7.3",
+  "version": "1.8.0",
   "description": "FeelFlow ID Platform SDK for React/Next.js applications",
   "keywords": [
     "feelflow",