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

In-App SDK リリースノート

@pocketsign/in-app-sdk の変更履歴です。各関数の仕様は In-App SDKリファレンスを参照してください。

2.0.0-beta.3 （2026/07/27）​

破壊的変更​

  • createAppBackend、createApiBackend、CreateApiBackendOptions を削除しました。

    • createAppBackend() を渡していた場合は、backend オプションそのものを省略してください。省略時はポケットサインアプリ内で動作する既定のバックエンドが使われます。
    • createApiBackend() に相当する機能はありません。アプリ外で動作確認する場合は、後述のモックバックエンドを利用してください。

  • SDKインスタンスを必要としない関数を標準の名前へ昇格し、従来のインスタンス版は Legacy を付けた名前で残して非推奨にしました。

    1.x移行先（SDKインスタンス不要、推奨）旧挙動を維持する場合
    closeWindow(sdk, options)closeWindow(options)closeWindowLegacy(sdk, options)
    openAppSettings(sdk)openAppSettings()openAppSettingsLegacy(sdk)
    requestAppUpdate(sdk)requestAppUpdate()requestAppUpdateLegacy(sdk)

    1.0.0-beta.12 で追加した closeWindowV2 は closeWindow へ改名しました。

    SDKインスタンス不要版は、closeWindow() がポケットサインアプリ 6.8.0 以降、openAppSettings() と requestAppUpdate() が 6.9.0 以降で利用できます。それ以前のアプリも対象にする場合は isMethodSupported() で判定し、Legacy 版へフォールバックしてください。

  • openHealthDataAppStore と openHealthDataSettings の応答型から { result: "cancel" } を削除しました。アプリの実装上返らないためで、実行時の挙動は変わりません。cancel を処理しているコードは削除してください。

  • 旧APIバックエンド用のエラー定数 API_BACKEND_ACCESS_TOKEN_REQUIRED、API_BACKEND_INVALID_TYPE、API_BACKEND_INSIDE_APP、API_BACKEND_SDK_VERSION_NO_LONGER_SUPPORTED、API_BACKEND_SUBSCRIPTION_REQUIRED を ERRORS と ERROR_MESSAGES から削除しました。

非推奨​

  • Web標準APIで代替できる関数を非推奨にしました。削除はしていないため、既存のコードは引き続き動作します。

    非推奨の関数移行先
    getCurrentGeolocationnavigator.geolocation
    openImagePicker<input type="file" accept="image/*">
    openCamera<input type="file" accept="image/*" capture="environment">

    関連する GeolocationResources、CameraResourceId も非推奨です。

新機能​

  • 動作環境を判定する isInApp() と isKLONSupported() を追加しました。ポケットサインアプリ内かどうか、利用中のアプリがKLON（PocketSign Link v2）に対応しているかを、SDKの初期化前に判定できます。
  • getSDKVersion() をSDKインスタンスなしで呼び出せるようにしました。
  • モックバックエンド @pocketsign/in-app-sdk/mock を追加しました。ポケットサインアプリなしで、ブラウザやユニットテスト・E2Eテスト上でSDKを動作させられます。関数ごとの応答の差し替え、呼び出しの検証、isMethodSupported() のテストに対応しています。使い方は SDK のバックエンドを参照してください。
  • backend オプションに指定できる BackendOverride、BackendSetupContext 型を公開しました。

その他​

  • SDKの呼び出しに60秒のタイムアウトを追加しました。アプリから応答が返らない場合は APP_BACKEND_INVOKE_TIMEOUT または INSTANCELESS_BACKEND_INVOKE_TIMEOUT でrejectされ、Promiseがpendingのままになりません。カード読み取りやQR読み取り、同意画面など、ユーザーの操作が60秒を超えた場合もタイムアウトします。
  • 不正な引数に対するエラーを INVALID_PACKET_DATA_SCHEMA に統一しました。関数や Symbol などシリアライズできない値は、アプリへ送信せずSDK側でエラーを返します。
  • package.json に "sideEffects": false を追加し、bundlerが未使用のSDK関数を除去できるようにしました。
  • すべての公開関数のドキュメントに、Promiseがrejectされる例外とエラーとしてresolveされる応答の一覧を追記しました。各関数のエラー仕様は In-App SDKリファレンスで確認できます。

1.0.0-beta.12 （2026/03/05）​

新機能​

  • closeWindow に、閉じる前にユーザーへ確認を表示する confirm オプションを追加しました。ポケットサインアプリ 6.8.0 以降で有効です。それ以前のアプリでは confirm を true にしても確認は表示されません。
  • SDKインスタンスなしで呼び出せる closeWindowV2 を追加しました。ポケットサインアプリ 6.8.0 以降で利用できます。isMethodSupported(closeWindowV2) で判定し、非対応のアプリでは closeWindow(sdk, options) へフォールバックしてください。

1.0.0-beta.11 （2025/12/25）​

非推奨​

  • openReregistrationPage を非推奨にしました。openReregistration を利用してください。

新機能​

  • 登録手段を指定して再登録画面を開く openReregistration を追加しました。ポケットサインアプリ 6.4.0 以降で利用できます。type に digital_signature（署名用電子証明書）または user_authentication（利用者証明用電子証明書 + 券面事項入力補助AP）を指定できます。未指定の場合は openReregistrationPage と同じ挙動になります。

1.0.0-beta.10 （2025/10/09）​

破壊的変更​

  • 顔写真のリソースID定数 CardInfoSourceFaceImageResourceId を FaceImageResourceId へ改名しました。

新機能​

  • 別のサービスを開く openService を追加しました。u に起動時のURLを指定できます。
  • 電話番号のリソースID定数 PhoneNumberResourceId を追加しました。
  • OpenServiceRequest、OpenResourceEditorRequest、ReadWithQrScannerRequest 型を公開しました。

その他​

  • 各関数のドキュメントに、対応するポケットサインアプリのバージョンを追記しました。

1.0.0-beta.9 （2025/05/29）​

公開APIの変更はありません。

1.0.0-beta.8 （2025/05/12）​

非推奨​

  • 歩数計の関数 getPedometerAvailability、setupPedometerRequirements、getPedometerRecords、openPedometerSettings、disconnectPedometer を非推奨にしました。歩数は getHealthDataRecords に step を指定して取得してください。

新機能​

  • ヘルスコネクト（Android）とヘルスケア（iOS）に対応した関数を追加しました。歩数、距離、消費カロリー、身長、体重を取得できます。
    • getHealthDataRecords: 指定した期間・種別のデータを取得します。
    • getHealthDataAvailability: 利用可否、インストール状態、権限状態を返します。
    • openHealthDataAuthentication: 必要に応じて権限の認証画面を開きます。
    • openHealthDataSettings: ヘルスコネクト／ヘルスケアを起動します。
    • openHealthDataAppStore: ストアのヘルスケアアプリのインストール画面を開きます。

その他​

  • エラーの型を改善し、errno で絞り込んだあとに data の型が推論されるようにしました。

1.0.0-beta.7 （2025/02/26）​

新機能​

  • File を渡してファイルを端末に保存する downloadFile を追加しました。大きなファイルでは時間がかかるため、サービス側でローディング表示を出してください。保存中に再度呼び出した場合は cancel が返ります。

1.0.0-beta.6 （2025/01/17）​

破壊的変更​

  • share に files パラメータを追加し、ファイルの共有に対応しました。この版の share はポケットサインアプリ 3.14.0 以降で動作します。

1.0.0-beta.5 （2024/11/06）​

非推奨​

  • openQrScanner を非推奨にしました。readWithQrScanner を利用し、応答の raw を location.href へ代入すると同じ挙動になります。

新機能​

  • QRコードを読み取って結果を受け取る readWithQrScanner を追加しました。読み取り対象のURLのフィルタを指定できます。
  • 電子証明書が有効かどうかを判定する checkCertificateRevocation を追加しました。対応する権限が必要です。

1.0.0-beta.4 （2024/10/08）​

新機能​

  • サブスクリプションの登録を要求する requestSubscription を追加しました。サービスの設定で「起動時にサブスクライブの要求をしない」を有効にすると未登録のユーザーにもミニアプリを開けるようになり、その状態から requestSubscription で登録を要求できます。

1.0.0-beta.3 以前の変更履歴は記載していません。