react-native-store-version 1.4.2 → 2.0.0

package/dist/react/defaultUi.js

@@ -0,0 +1,118 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+// デフォルト UI（Force / Warning）が共有する部品: 配色、Context の読み取りと文言の解決、ボタン、文字のスタイル。
+// 値は元のデザイン（Force / Warning）の style と配色の定義からそのまま写す（目分量で変えない）。
+// RN 標準のコンポーネントだけで作り、依存は足さない。Modal の枠は StoreVersionModal.tsx
+import { useContext, useMemo } from 'react';
+import { Pressable, StyleSheet, Text, useColorScheme, } from 'react-native';
+import { resolveTexts } from './texts.js';
+import { StoreVersionDisplayContext, StoreVersionStateContext, } from './useStoreVersion.js';
+/** ライト / ダークの配色（Force / Warning の配色の定義。両方のデザインで同じ値） */
+export const PALETTES = {
+    light: {
+        card: '#FFFFFF',
+        text: '#18181B',
+        sub: '#52525B',
+        primary: '#1D4ED8',
+        iconBg: '#DBEAFE',
+        handle: '#D4D4D8',
+        secondaryText: '#1D4ED8',
+    },
+    dark: {
+        card: '#27272A',
+        text: '#FAFAFA',
+        sub: '#D4D4D8',
+        primary: '#2563EB',
+        iconBg: '#1E3A8A',
+        handle: '#52525B',
+        secondaryText: '#93C5FD',
+    },
+};
+/** 塗りのボタンの文字（デザインは `color: #FFFFFF` 固定。ライト / ダークで変わらない） */
+export const BUTTON_TEXT_COLOR = '#FFFFFF';
+/**
+ * カード / シートの最大幅（デザインから意図的に変える点）。タブレットや横向きで画面いっぱいに広がらないようにする。
+ * スマホの縦向き（幅 480 未満）では効かないので見た目は変わらない
+ */
+export const MAX_CONTENT_WIDTH = 480;
+/**
+ * `primaryColor` として使える値か。JS の利用者が false / '' / null などを渡しても（`isBrand && '#E11D48'` など）、
+ * 既定の配色に戻す（そのまま style に入れると塗りが透明になる。`icon` / `texts` と同じ扱い）
+ */
+const isUsableColor = (value) => typeof value === 'string'
+    ? value !== ''
+    : typeof value === 'number' ||
+        (typeof value === 'object' && value !== null);
+/**
+ * 端末の配色に合わせた色（`useColorScheme`。null（未対応の環境）はライト）。
+ * Provider に `primaryColor` があれば、ボタンの塗りと「あとで」の文字をそれにする
+ */
+export const usePalette = () => {
+    const palette = PALETTES[useColorScheme() === 'dark' ? 'dark' : 'light'];
+    const primaryColor = useContext(StoreVersionDisplayContext)?.primaryColor;
+    return useMemo(() => !isUsableColor(primaryColor)
+        ? palette
+        : { ...palette, primary: primaryColor, secondaryText: primaryColor }, [palette, primaryColor]);
+};
+/**
+ * `icon` を描くかどうかの正規化。JS からの利用で null / false を渡されても「無し」として扱う
+ * （`components` に渡す `icon` も undefined にそろえる）
+ */
+export const normalizeIcon = (icon) => {
+    const value = icon;
+    return value == null || value === false ? undefined : icon;
+};
+/**
+ * 判定の状態と表示の設定を読み、文言を解決する。Provider の中でしか描画されないので Context は必ずある。
+ * 文言は `texts` / `local` / `remote` が変わったときだけ解決し直す（`texts` の変更は表示中のモーダルに即座に反映される）
+ */
+export const useDefaultUiContext = () => {
+    const state = useContext(StoreVersionStateContext);
+    const display = useContext(StoreVersionDisplayContext);
+    if (state === null || display === null) {
+        // Provider が描くので外から到達できない。型を狭めるためだけの throw
+        throw new Error('the default UI of react-native-store-version must be rendered by <StoreVersionProvider>');
+    }
+    const rawTexts = display.texts;
+    const { local, remote } = state;
+    const texts = useMemo(() => resolveTexts(rawTexts, { local, remote }), [rawTexts, local, remote]);
+    return { state, display, texts };
+};
+/**
+ * ボタン（デザイン: 高さ 50・radius 12・文字 16/600）。高さはフォントスケールで伸びるよう `minHeight` にする（デザインから意図的に変える点）。
+ * 押している間だけ `opacity: 0.7`（デザインに無いので決めた値）。`allowFontScaling` は切らない（既定 true）
+ */
+export const ActionButton = ({ label, onPress, backgroundColor, color, }) => (_jsx(Pressable, { accessibilityRole: "button", onPress: onPress, style: ({ pressed }) => [
+        styles.button,
+        backgroundColor === undefined ? null : { backgroundColor },
+        pressed ? styles.pressed : null,
+    ], children: _jsx(Text, { style: [styles.buttonText, { color }], children: label }) }));
+/** タイトル（デザイン: 20/28 bold）。フォントはプラットフォーム標準（fontFamily は指定しない） */
+export const titleStyle = {
+    fontSize: 20,
+    lineHeight: 28,
+    fontWeight: '700',
+};
+/** 本文（デザイン: 15/22） */
+export const messageStyle = {
+    fontSize: 15,
+    lineHeight: 22,
+};
+const styles = StyleSheet.create({
+    button: {
+        minHeight: 50,
+        borderRadius: 12,
+        alignItems: 'center',
+        justifyContent: 'center',
+        // 押せる範囲の余白。文字 16 の行の高さ（約 22）+ 上下 8 ずつは minHeight 50 に収まるので、デザインの見た目の大きさは変わらない。
+        // 文字が長くて折り返したときや大きいフォントでは、文字が端に貼り付かずに済む
+        paddingVertical: 8,
+        paddingHorizontal: 16,
+    },
+    buttonText: {
+        fontSize: 16,
+        fontWeight: '600',
+    },
+    pressed: {
+        opacity: 0.7,
+    },
+});

package/dist/react/engine.d.ts

@@ -0,0 +1,146 @@
+import type { CompareDetail, CompareResult, DiffType } from '../compare.ts';
+import { StoreVersionError } from '../errors.ts';
+import type { VersionGetter } from '../fetchers/custom.ts';
+import { type Action, type Policy } from '../policy.ts';
+import type { StoreVersionStatus, UseStoreVersionResult } from './useStoreVersion.ts';
+/** 判定全体の既定のタイムアウト（Android の HTML が約 1.25MB あるため） */
+export declare const DEFAULT_TIMEOUT_MS = 10000;
+/** `onResult` に渡す値（`ready` になるたびに 1 回） */
+export type StoreVersionCheckResult = {
+    /** v1 の `checkVersion()` と同じ比較の結果。最新バージョンが比較できず、最低バージョンで force になったときは null */
+    result: CompareResult | null;
+    detail: CompareDetail | null;
+    action: Action;
+    diff: DiffType | null;
+    local: string;
+    /** Play の版が比較できず、最低バージョンで force になったときは null */
+    remote: string | null;
+};
+/** Provider の props のうち、判定に使うもの（表示の props は StoreVersionProvider.tsx） */
+export type StoreVersionCheckProps = {
+    /**
+     * false なら何もしない（`status: 'skipped'`。`onError` も呼ばない）。既定 true。
+     * true → false に変わったら判定を取り消して `skipped` にし、false → true に変わったら判定を始める
+     */
+    enabled?: boolean;
+    /**
+     * アプリのバージョン。必ずネイティブのバージョン（iOS の `CFBundleShortVersionString` / Android の `versionName`）を渡す。
+     * `Constants.expoConfig.version` や `package.json` の値は JS バンドルに含まれ、OTA 更新で変わってしまう
+     * （ネイティブは古いのに「更新済み」と誤判定し、force が出なくなる）ので使わないこと。
+     * 省略すると expo-application の `nativeApplicationVersion` → react-native-device-info の `getVersion()` の順に取る
+     */
+    version?: string | null;
+    /** iOS の bundleId。省略すると expo-application の `applicationId` → react-native-device-info の `getBundleId()` の順に取る */
+    bundleId?: string | null;
+    /** Android の package name。省略すると expo-application の `applicationId` → react-native-device-info の `getBundleId()` の順に取る */
+    packageName?: string | null;
+    /** iTunes Lookup の国（`jp` など）。既定は端末ロケールの地域（取れなければ `us`） */
+    country?: string;
+    /**
+     * ストアとの差分に対する扱い。既定 `{ major: 'force', minor: 'warning', patch: 'warning' }`。
+     * `'force'` のような 1 つの値、`{ minor: 'force' }` のような個別指定（省略したキーは既定）、`(local, remote) => Action` の関数で書ける。
+     * 変わったら取り直さずに、直近の判定の最新 / 最低バージョンで `action` だけを計算し直す
+     * （関数は判定のたびと policy が変わるたびに呼ばれ、インラインで書いた関数は描画のたびに変わる）。
+     * 判定が `POLICY_FAILED` で止まり取得結果が無いとき（取得の前に検証で止まった・取得の後に policy の関数が throw した）は、
+     * policy を直しても `recheck()` まで `error` のまま。
+     *
+     * 注意（Android の段階公開）: Android で段階公開を使う場合、公開対象外のユーザーは新バージョンを
+     * 入手できないため、ストア差分による `force` でアプリを使えなくなる可能性がある。
+     * `Platform.OS === 'android'` のときは `major: 'warning'` にするか、`getMinimumVersion` で
+     * force を制御すること。iOS の段階的リリースは自動アップデートの配信ペースだけを制御し、
+     * App Store から手動ならいつでも更新できるので問題ない。
+     */
+    policy?: Policy | null;
+    /** 判定全体のタイムアウト（ms）。既定 10000。最新バージョンが間に合わなければ `TIMEOUT`（UI は出さない） */
+    timeoutMs?: number;
+    /**
+     * バックグラウンドからの復帰時（`AppState` が `background` → `active`）にも再チェックする。既定 false。
+     * iOS の通知センターや権限ダイアログによる `inactive` → `active` では再チェックしない。
+     * Android には `inactive` が無く、権限ダイアログやほかのアプリから戻ったときも `background` → `active` になり再チェックする。
+     * Android は再チェックのたびに Play Store のページ（約 1.25MB）を取得する
+     */
+    recheckOnForeground?: boolean;
+    /**
+     * 最新バージョンの取得元（Remote Config / 自前の JSON など）。指定するとストアのバージョンは使わない
+     * （iOS はストア URL を得るためだけに lookup する。Android はストアに問い合わせない）。失敗はストアにフォールバックせず `error`。
+     * StrictMode では開発時だけ、マウント時に 2 回呼ばれうる（ストアへの fetch は 1 回にまとまる）
+     */
+    getLatestVersion?: VersionGetter | null;
+    /**
+     * 最低バージョンの取得元。これ未満は差分に関係なく force。失敗は最低バージョンの判定だけを飛ばす（`onError` には渡す）。
+     * StrictMode では開発時だけ、マウント時に 2 回呼ばれうる
+     */
+    getMinimumVersion?: VersionGetter | null;
+    /**
+     * 判定が `ready` になるたびに 1 回呼ぶ（`skipped` / `error` では呼ばない）。
+     * Promise を返しても待たない（reject しても unhandled rejection にはしない。開発時は `console.warn`）
+     */
+    onResult?: (result: StoreVersionCheckResult) => void;
+    /**
+     * エラーを受け取る（UI は出さない）。1 回の判定で複数回呼ばれうる（例: 最低バージョンの取得の失敗と、
+     * 最新バージョンの取得の失敗、iOS のストア URL の lookup の失敗）。判定の取り消し（アンマウント・バックグラウンド）では呼ばない。
+     * 再チェックの失敗（前回の結果は残る）と `openStore()` の失敗（`STORE_URL_UNAVAILABLE`）も渡す。
+     * 渡さない場合は `__DEV__` のときだけ `console.warn` する。
+     * Promise を返しても待たない（reject しても unhandled rejection にはしない。開発時は `console.warn`）
+     */
+    onError?: (error: StoreVersionError) => void;
+};
+/**
+ * `country` の既定。端末ロケールの地域を JS だけで取る（`Intl.DateTimeFormat().resolvedOptions().locale`）。
+ * 取れなければ `us`。例外は投げない（パッケージの入口からは export しない）
+ */
+export declare const defaultCountry: () => string;
+type Evaluation = {
+    result: CompareResult | null;
+    detail: CompareDetail | null;
+    action: Action;
+    diff: DiffType | null;
+};
+/** policy を当て直すために残す、直近の判定の取得結果 */
+type Snapshot = {
+    latest: string | null;
+    minimum: string | null;
+    storeUrl: string | null;
+    releaseNotes: string | undefined;
+};
+/** engine の状態。React の state にはこれをそのまま写す */
+export type Model = {
+    status: StoreVersionStatus;
+    local: string | null;
+    error: StoreVersionError | null;
+    /**
+     * 直近の判定の取得結果。`ready`、再チェック中（前回の ready を見せ続ける `checking`）、
+     * policy を当て直して `POLICY_FAILED` になった `error` のときにある
+     */
+    snapshot: Snapshot | null;
+    /** 見せる判定の結果。`ready` と、再チェック中（前回の ready の値）のときだけある */
+    evaluation: Evaluation | null;
+};
+export declare const IDLE: Model;
+/** Provider の判定の操作（StoreVersionProvider.tsx が effect と hook の値に配線する） */
+export type Engine = {
+    /** マウント（AppState の購読と最初の判定） */
+    mount(): void;
+    /** アンマウント（判定を取り消し、それ以降は setState / onResult / onError を呼ばない） */
+    unmount(): void;
+    /** 判定を始める（`recheck()`）。バックグラウンドの間は active まで待つ */
+    start(): void;
+    /** `enabled` の切り替え */
+    setEnabled(enabled: boolean): void;
+    /** `policy` の変更（取り直さずに action を計算し直す） */
+    applyPolicy(policy: Policy | null | undefined): void;
+    openStore(): Promise<boolean>;
+    dismiss(): void;
+};
+/**
+ * Provider の engine を作る。判断はすべてここの変数（最新の値）で行い、React の state は `setModel` で写すだけにする。
+ * props はいつも `getProps()` で最新のものを読む（変わっても取り直さない。例外は `enabled` の切り替え）
+ */
+export declare const createEngine: (getProps: () => StoreVersionCheckProps, setModel: (model: Model) => void, setDismissedRemote: (remote: string) => void) => Engine;
+/**
+ * engine の状態から hook の戻り値を作る。判定の結果（result / action / remote / storeUrl など）は ready のとき
+ * （再チェック中は前回の ready の値）だけ見せる
+ */
+export declare const stateOf: (model: Model, dismissedRemote: string | null, engine: Engine) => UseStoreVersionResult;
+export {};
+//# sourceMappingURL=engine.d.ts.map

package/dist/react/engine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"engine.d.ts","sourceRoot":"","sources":["../../src/react/engine.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAE5E,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACjD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAE3D,OAAO,EACL,KAAK,MAAM,EAEX,KAAK,MAAM,EAEZ,MAAM,cAAc,CAAC;AAQtB,OAAO,KAAK,EACV,kBAAkB,EAClB,qBAAqB,EACtB,MAAM,sBAAsB,CAAC;AAK9B,oDAAoD;AACpD,eAAO,MAAM,kBAAkB,QAAQ,CAAC;AAExC,0CAA0C;AAC1C,MAAM,MAAM,uBAAuB,GAAG;IACpC,+EAA+E;IAC/E,MAAM,EAAE,aAAa,GAAG,IAAI,CAAC;IAC7B,MAAM,EAAE,aAAa,GAAG,IAAI,CAAC;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,QAAQ,GAAG,IAAI,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,gDAAgD;IAChD,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB,CAAC;AAEF,yEAAyE;AACzE,MAAM,MAAM,sBAAsB,GAAG;IACnC;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,iHAAiH;IACjH,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,yHAAyH;IACzH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,0DAA0D;IAC1D,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,oEAAoE;IACpE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IACxC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,aAAa,GAAG,IAAI,CAAC;IACzC;;;OAGG;IACH,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,uBAAuB,KAAK,IAAI,CAAC;IACrD;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,iBAAiB,KAAK,IAAI,CAAC;CAC9C,CAAC;AA0BF;;;GAGG;AACH,eAAO,MAAM,cAAc,QAAO,MAMjC,CAAC;AAEF,KAAK,UAAU,GAAG;IAChB,MAAM,EAAE,aAAa,GAAG,IAAI,CAAC;IAC7B,MAAM,EAAE,aAAa,GAAG,IAAI,CAAC;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,QAAQ,GAAG,IAAI,CAAC;CACvB,CAAC;AAEF,mCAAmC;AACnC,KAAK,QAAQ,GAAG;IACd,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;CAClC,CAAC;AAEF,2CAA2C;AAC3C,MAAM,MAAM,KAAK,GAAG;IAClB,MAAM,EAAE,kBAAkB,CAAC;IAC3B,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,KAAK,EAAE,iBAAiB,GAAG,IAAI,CAAC;IAChC;;;OAGG;IACH,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;IAC1B,qDAAqD;IACrD,UAAU,EAAE,UAAU,GAAG,IAAI,CAAC;CAC/B,CAAC;AAEF,eAAO,MAAM,IAAI,EAAE,KAMlB,CAAC;AAuCF,wEAAwE;AACxE,MAAM,MAAM,MAAM,GAAG;IACnB,+BAA+B;IAC/B,KAAK,IAAI,IAAI,CAAC;IACd,gEAAgE;IAChE,OAAO,IAAI,IAAI,CAAC;IAChB,kDAAkD;IAClD,KAAK,IAAI,IAAI,CAAC;IACd,sBAAsB;IACtB,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IACnC,yCAAyC;IACzC,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,IAAI,CAAC;IACrD,SAAS,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAC9B,OAAO,IAAI,IAAI,CAAC;CACjB,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,YAAY,aACb,MAAM,sBAAsB,YAC5B,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,sBACZ,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,KAC3C,MAoeF,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,OAAO,UACX,KAAK,mBACK,MAAM,GAAG,IAAI,UACtB,MAAM,KACb,qBAuBF,CAAC"}