@aiquants/auth-react-router 0.14.1 → 0.15.0

package/dist/admin.d.mts

@@ -280,6 +280,8 @@ type UserAdminLabels = {
         syncQueued: string;
         /** 同じ範囲の要求が既に待っていて、積まれなかったことの説明。 */
         syncAlreadyPending: string;
+        /** 連携は作れたが、その直後の同期要求を積めなかったときの告知。 */
+        linkSyncNotQueued: string;
         /** 同期が滞っていることの警告。停止はセキュリティ事象である。 */
         staleWarning: string;
         disabledWarning: string;
@@ -631,6 +633,15 @@ type UserAdminCatalogSnapshot = AuthDirectoryCatalogSnapshot;
  * 何も積まれていないので、待っている行が誰にも拾われなければ何も起きない。
  */
 type UserAdminSyncRequestOutcome = "queued" | "already-pending";
+/**
+ * What the sync request made right after a link was created did.
+ * 連携の直後に積む同期要求が行ったこと。
+ *
+ * `not-queued` は **連携は成功したが要求は積めなかった** ことを表す。要求の失敗を連携の失敗として
+ * 投げると、運用者には「連携に失敗した」と伝わる一方で上流所有のグループは既に増えている。
+ * 連携の結果と要求の結果は別の事実なので、別の値で運ぶ。
+ */
+type UserAdminLinkSyncOutcome = UserAdminSyncRequestOutcome | "not-queued";
 /**
  * Why the upstream catalog could not be listed, classified for display.
  * 上流の候補一覧を引けなかった理由を、表示のために分類したもの。
@@ -725,25 +736,47 @@ declare function createUserAdminApp(config: UserAdminAppConfig): {
         syncRequest?: undefined;
     } | {
         ok: boolean;
-        syncRequest: UserAdminSyncRequestOutcome;
+        syncRequest: UserAdminLinkSyncOutcome;
     } | {
         ok: boolean;
         error: string;
     }>;
 };
 
+/**
+ * How the console keeps itself current while "sync now" requests are waiting for the job.
+ * 「今すぐ同期」の要求がジョブを待っている間、画面が自分を最新に保つ間隔と上限。
+ *
+ * The loader only re-runs after the console's own submissions, so a request the job finishes a few
+ * seconds later would stay invisible until a reload. While at least one request is pending the
+ * console re-validates every `intervalMs`, and gives up after `maxMs` so a deployment with no job
+ * consuming the queue does not poll forever from every open tab.
+ * ローダーは自分の送信のあとにしか再実行されないため、ジョブが数秒後に終えた要求はリロードまで
+ * 見えない。未処理の要求が 1 件でもある間は `intervalMs` ごとに再検証し、`maxMs` で諦める
+ * (キューを消化するジョブが居ない配備で、開いている全タブが永久に叩き続けないため)。
+ */
+type PendingSyncPolling = {
+    /** Milliseconds between re-validations. 再検証の間隔 (ミリ秒)。 */
+    intervalMs: number;
+    /** Milliseconds after which polling stops for an unchanged pending count. 件数が変わらないまま諦めるまでの時間 (ミリ秒)。 */
+    maxMs: number;
+};
+/** Defaults: every 3 seconds, for up to 5 minutes. 既定値 (3 秒ごと、最長 5 分)。 */
+declare const DEFAULT_PENDING_SYNC_POLLING: PendingSyncPolling;
 type UserAdminShellProps = {
     children?: React__default.ReactNode;
     renderHeader?: (props: {
         title: string;
         annotation: React__default.ReactNode;
     }) => React__default.ReactNode;
+    /** Polling while sync requests are pending; defaults to {@link DEFAULT_PENDING_SYNC_POLLING}. 未処理中のポーリング設定。 */
+    pendingSyncPolling?: PendingSyncPolling;
 };
 /**
  * Shell layout for user administration pages with header annotation delegation.
  * ヘッダー注釈委譲を備えたユーザー管理ページのシェルレイアウト。
  */
-declare function UserAdminShell({ children, renderHeader }: UserAdminShellProps): React__default.JSX.Element;
+declare function UserAdminShell({ children, renderHeader, pendingSyncPolling }: UserAdminShellProps): React__default.JSX.Element;
 
 /**
  * @module admin/views
@@ -795,6 +828,6 @@ type AuthUserAdminAppViewProps = UserAdminShellProps;
  * Top-level application view component for the user administration UI (`/users/*`).
  * ユーザー管理 UI 全体を描画するトップレベルコンポーネント。
  */
-declare function AuthUserAdminAppView({ renderHeader }?: AuthUserAdminAppViewProps): React__default.JSX.Element;
+declare function AuthUserAdminAppView({ renderHeader, pendingSyncPolling }?: AuthUserAdminAppViewProps): React__default.JSX.Element;
 
-export { AllowlistView, AuthUserAdminAppView, type AuthUserAdminAppViewProps, DirectoryView, GroupMembersView, GroupsView, type PartialUserAdminLabels, type UserAdminAccess, type UserAdminAppConfig, type UserAdminCatalog, type UserAdminCatalogFailure, type UserAdminCatalogGroup, type UserAdminCatalogSnapshot, type UserAdminGuards, UserAdminInputError, type UserAdminLabels, type UserAdminLoaderData, UserAdminOperatorError, type UserAdminPermission, UserAdminShell, type UserAdminShellProps, type UserAdminStore, type UserAdminSyncRequestOutcome, UsersView, createInMemoryUserAdminStore, createUserAdminApp, defaultUserAdminLabels, jaUserAdminLabels, normalizeUpstreamKey, resolveUserAdminLabels, userAdminAccessFor, userAdminIntents };
+export { AllowlistView, AuthUserAdminAppView, type AuthUserAdminAppViewProps, DEFAULT_PENDING_SYNC_POLLING, DirectoryView, GroupMembersView, GroupsView, type PartialUserAdminLabels, type PendingSyncPolling, type UserAdminAccess, type UserAdminAppConfig, type UserAdminCatalog, type UserAdminCatalogFailure, type UserAdminCatalogGroup, type UserAdminCatalogSnapshot, type UserAdminGuards, UserAdminInputError, type UserAdminLabels, type UserAdminLinkSyncOutcome, type UserAdminLoaderData, UserAdminOperatorError, type UserAdminPermission, UserAdminShell, type UserAdminShellProps, type UserAdminStore, type UserAdminSyncRequestOutcome, UsersView, createInMemoryUserAdminStore, createUserAdminApp, defaultUserAdminLabels, jaUserAdminLabels, normalizeUpstreamKey, resolveUserAdminLabels, userAdminAccessFor, userAdminIntents };

package/dist/admin.d.ts

@@ -280,6 +280,8 @@ type UserAdminLabels = {
         syncQueued: string;
         /** 同じ範囲の要求が既に待っていて、積まれなかったことの説明。 */
         syncAlreadyPending: string;
+        /** 連携は作れたが、その直後の同期要求を積めなかったときの告知。 */
+        linkSyncNotQueued: string;
         /** 同期が滞っていることの警告。停止はセキュリティ事象である。 */
         staleWarning: string;
         disabledWarning: string;
@@ -631,6 +633,15 @@ type UserAdminCatalogSnapshot = AuthDirectoryCatalogSnapshot;
  * 何も積まれていないので、待っている行が誰にも拾われなければ何も起きない。
  */
 type UserAdminSyncRequestOutcome = "queued" | "already-pending";
+/**
+ * What the sync request made right after a link was created did.
+ * 連携の直後に積む同期要求が行ったこと。
+ *
+ * `not-queued` は **連携は成功したが要求は積めなかった** ことを表す。要求の失敗を連携の失敗として
+ * 投げると、運用者には「連携に失敗した」と伝わる一方で上流所有のグループは既に増えている。
+ * 連携の結果と要求の結果は別の事実なので、別の値で運ぶ。
+ */
+type UserAdminLinkSyncOutcome = UserAdminSyncRequestOutcome | "not-queued";
 /**
  * Why the upstream catalog could not be listed, classified for display.
  * 上流の候補一覧を引けなかった理由を、表示のために分類したもの。
@@ -725,25 +736,47 @@ declare function createUserAdminApp(config: UserAdminAppConfig): {
         syncRequest?: undefined;
     } | {
         ok: boolean;
-        syncRequest: UserAdminSyncRequestOutcome;
+        syncRequest: UserAdminLinkSyncOutcome;
     } | {
         ok: boolean;
         error: string;
     }>;
 };
 
+/**
+ * How the console keeps itself current while "sync now" requests are waiting for the job.
+ * 「今すぐ同期」の要求がジョブを待っている間、画面が自分を最新に保つ間隔と上限。
+ *
+ * The loader only re-runs after the console's own submissions, so a request the job finishes a few
+ * seconds later would stay invisible until a reload. While at least one request is pending the
+ * console re-validates every `intervalMs`, and gives up after `maxMs` so a deployment with no job
+ * consuming the queue does not poll forever from every open tab.
+ * ローダーは自分の送信のあとにしか再実行されないため、ジョブが数秒後に終えた要求はリロードまで
+ * 見えない。未処理の要求が 1 件でもある間は `intervalMs` ごとに再検証し、`maxMs` で諦める
+ * (キューを消化するジョブが居ない配備で、開いている全タブが永久に叩き続けないため)。
+ */
+type PendingSyncPolling = {
+    /** Milliseconds between re-validations. 再検証の間隔 (ミリ秒)。 */
+    intervalMs: number;
+    /** Milliseconds after which polling stops for an unchanged pending count. 件数が変わらないまま諦めるまでの時間 (ミリ秒)。 */
+    maxMs: number;
+};
+/** Defaults: every 3 seconds, for up to 5 minutes. 既定値 (3 秒ごと、最長 5 分)。 */
+declare const DEFAULT_PENDING_SYNC_POLLING: PendingSyncPolling;
 type UserAdminShellProps = {
     children?: React__default.ReactNode;
     renderHeader?: (props: {
         title: string;
         annotation: React__default.ReactNode;
     }) => React__default.ReactNode;
+    /** Polling while sync requests are pending; defaults to {@link DEFAULT_PENDING_SYNC_POLLING}. 未処理中のポーリング設定。 */
+    pendingSyncPolling?: PendingSyncPolling;
 };
 /**
  * Shell layout for user administration pages with header annotation delegation.
  * ヘッダー注釈委譲を備えたユーザー管理ページのシェルレイアウト。
  */
-declare function UserAdminShell({ children, renderHeader }: UserAdminShellProps): React__default.JSX.Element;
+declare function UserAdminShell({ children, renderHeader, pendingSyncPolling }: UserAdminShellProps): React__default.JSX.Element;
 
 /**
  * @module admin/views
@@ -795,6 +828,6 @@ type AuthUserAdminAppViewProps = UserAdminShellProps;
  * Top-level application view component for the user administration UI (`/users/*`).
  * ユーザー管理 UI 全体を描画するトップレベルコンポーネント。
  */
-declare function AuthUserAdminAppView({ renderHeader }?: AuthUserAdminAppViewProps): React__default.JSX.Element;
+declare function AuthUserAdminAppView({ renderHeader, pendingSyncPolling }?: AuthUserAdminAppViewProps): React__default.JSX.Element;
 
-export { AllowlistView, AuthUserAdminAppView, type AuthUserAdminAppViewProps, DirectoryView, GroupMembersView, GroupsView, type PartialUserAdminLabels, type UserAdminAccess, type UserAdminAppConfig, type UserAdminCatalog, type UserAdminCatalogFailure, type UserAdminCatalogGroup, type UserAdminCatalogSnapshot, type UserAdminGuards, UserAdminInputError, type UserAdminLabels, type UserAdminLoaderData, UserAdminOperatorError, type UserAdminPermission, UserAdminShell, type UserAdminShellProps, type UserAdminStore, type UserAdminSyncRequestOutcome, UsersView, createInMemoryUserAdminStore, createUserAdminApp, defaultUserAdminLabels, jaUserAdminLabels, normalizeUpstreamKey, resolveUserAdminLabels, userAdminAccessFor, userAdminIntents };
+export { AllowlistView, AuthUserAdminAppView, type AuthUserAdminAppViewProps, DEFAULT_PENDING_SYNC_POLLING, DirectoryView, GroupMembersView, GroupsView, type PartialUserAdminLabels, type PendingSyncPolling, type UserAdminAccess, type UserAdminAppConfig, type UserAdminCatalog, type UserAdminCatalogFailure, type UserAdminCatalogGroup, type UserAdminCatalogSnapshot, type UserAdminGuards, UserAdminInputError, type UserAdminLabels, type UserAdminLinkSyncOutcome, type UserAdminLoaderData, UserAdminOperatorError, type UserAdminPermission, UserAdminShell, type UserAdminShellProps, type UserAdminStore, type UserAdminSyncRequestOutcome, UsersView, createInMemoryUserAdminStore, createUserAdminApp, defaultUserAdminLabels, jaUserAdminLabels, normalizeUpstreamKey, resolveUserAdminLabels, userAdminAccessFor, userAdminIntents };