@aiquants/auth-react-router 0.9.1 → 0.12.0

package/dist/admin.d.mts

@@ -1,4 +1,5 @@
-import { AuthUser, AuthGroup, AuthGroupMember, AuthAllowlistEntry } from '@aiquants/auth-core';
+import * as react_router from 'react-router';
+import { AuthUser, AuthGroup, AuthGroupMember, AuthAllowlistEntry, AuthDirectoryMembershipMode, AuthDirectoryStatus } from '@aiquants/auth-core';
 import React__default from 'react';
 
 /**
@@ -12,60 +13,123 @@ import React__default from 'react';
  */
 type UserAdminLabels = {
     title: string;
+    /**
+     * BCP 47 locale used to format dates. 日付整形に使う BCP 47 ロケール。
+     *
+     * 実行環境任せにするとサーバーとブラウザで別の文字列になり、水和が壊れる。
+     */
+    locale: string;
+    /** IANA time zone used to format dates. 日付整形に使う IANA タイムゾーン。 */
+    timeZone: string;
+    /**
+     * Strings shared by more than one view. 複数のビューが共有する文言。
+     *
+     * ビューごとに同じ語を持たせると、ある画面の「削除」だけを言い換えることが **できなく
+     * なる** (実装がどのビューのキーを読んでいるかは呼び出し側から見えない)。共有する語は
+     * ここ 1 か所に置く。
+     */
+    common: {
+        add: string;
+        create: string;
+        edit: string;
+        delete: string;
+        save: string;
+        cancel: string;
+        actions: string;
+        status: string;
+        id: string;
+        /** 変更不能な供給元 (環境変数など) 由来の行に出す表示。 */
+        readOnly: string;
+        /** 上流所有のグループに出す編集不可の表示。 */
+        managedUpstream: string;
+        /** `#{id}` の表示。記号の位置は言語で変わる。 */
+        idTemplate: string;
+        /** 値が無いことの表示 (説明欄など)。 */
+        none: string;
+    };
+    /** アクションが拒否・失敗したときの文言。 */
+    errors: {
+        /**
+         * Shown when the actor lacks permission for the attempted operation.
+         * 操作の権限が無いときに出す文言。
+         *
+         * ガードの例外メッセージをそのまま返してはならない。テナント ID・アプリキー・
+         * 拒否理由といった内部の語彙が、権限を持たない相手にそのまま渡る。
+         */
+        forbidden: string;
+    };
     /** シェル (タブ枠) の見出し。 */
     heading: string;
+    /** シェルが描く自己権限バッジの文言。 */
+    permissions: {
+        label: string;
+        canWrite: string;
+        canRead: string;
+        none: string;
+        /** 未結線・取得失敗・付与ゼロのいずれも「不明」であり、許可ではない。 */
+        unknown: string;
+    };
     tabs: {
         users: string;
         groups: string;
         groupMembers: string;
         allowlist: string;
+        directory: string;
     };
     usersView: {
         title: string;
         searchPlaceholder: string;
+        /** 検索欄の読み上げ名。プレースホルダは入力すると消えるため名前にならない。 */
+        searchLabel: string;
         addUser: string;
         editUser: string;
-        id: string;
         displayName: string;
         email: string;
-        status: string;
         active: string;
         inactive: string;
-        actions: string;
-        edit: string;
         activate: string;
         deactivate: string;
+        /** 行ごとの読み上げ名。`{user}` を利用者名へ置換する。 */
+        editUserAria: string;
+        activateAria: string;
+        deactivateAria: string;
+        /** 無効化はサインインを止める。確認を取る。 */
+        confirmDeactivate: string;
         empty: string;
-        save: string;
-        cancel: string;
     };
     groupsView: {
+        /** 検索語に一致しないときの説明。空状態と混ぜると「消えた」と誤読される。 */
+        emptyFiltered: string;
         title: string;
         searchPlaceholder: string;
+        searchLabel: string;
         addGroup: string;
         editGroup: string;
-        id: string;
         groupKey: string;
         name: string;
         description: string;
-        memberCount: string;
-        status: string;
-        actions: string;
-        edit: string;
-        delete: string;
+        /** 所属人数。`{count}` を人数へ置換する。 */
+        memberCountTemplate: string;
         confirmDelete: string;
         noDescription: string;
         groupKeyPlaceholder: string;
         namePlaceholder: string;
         empty: string;
-        save: string;
-        cancel: string;
     };
     groupMembersView: {
+        title: string;
         selectGroup: string;
         selectPrompt: string;
         actionAdd: string;
         actionRemove: string;
+        /** 行ごとの読み上げ名。`{user}` を利用者名へ置換する。 */
+        actionAddAria: string;
+        actionRemoveAria: string;
+        /** 上流所有グループで編集を出さない理由。押せない理由を書かないと故障に見える。 */
+        upstreamNotice: string;
+        /** 見出し。`{group}` をグループ名へ置換する。語順が言語で変わるため位置指定にする。 */
+        membersOfTemplate: string;
+        groupKeyLabel: string;
     };
     allowlistView: {
         title: string;
@@ -77,14 +141,85 @@ type UserAdminLabels = {
         /** 一覧のバッジ表示 (短縮形)。 */
         emailTypeShort: string;
         domainTypeShort: string;
+        /** グループ単位の許可。上流ディレクトリの所属で判定される。 */
+        groupTypeShort: string;
+        /** 対象列の見出し。パターンとグループが混在するため「パターン」ではない。 */
+        target: string;
         description: string;
-        actions: string;
-        /** 変更不能な供給元 (環境変数など) 由来の行に出す表示。 */
-        readOnly: string;
-        delete: string;
+        /** 配備全体が所有する行 (環境変数由来) の所有者表示。 */
+        deploymentOwner: string;
+        /** 許可の取り消しはサインインを止める。確認を取る。 */
+        confirmDelete: string;
+        /** 行ごとの読み上げ名。`{target}` を対象へ置換する。 */
+        deleteAria: string;
         empty: string;
-        save: string;
-        cancel: string;
+    };
+    directoryView: {
+        title: string;
+        /** 出所列。ローカル管理か、どの上流かを示す。 */
+        source: string;
+        localSource: string;
+        membershipMode: string;
+        directMode: string;
+        transitiveMode: string;
+        lastSynced: string;
+        neverSynced: string;
+        /** 上流に居るがローカルユーザーへ解決できていない人数。`{count}` を人数へ置換する。 */
+        unresolvedTemplate: string;
+        syncPaused: string;
+        syncEnabled: string;
+        syncNow: string;
+        syncQueued: string;
+        /** 同期が滞っていることの警告。停止はセキュリティ事象である。 */
+        staleWarning: string;
+        disabledWarning: string;
+        /** 停止件数。`{paused}` / `{total}` を件数へ置換する。 */
+        pausedTemplate: string;
+        /** 失敗したグループの列挙。`{groups}` を名前の並びへ置換する。 */
+        erroredTemplate: string;
+        /** 失敗理由付きの 1 件。`{group}` / `{reason}`。 */
+        erroredItemTemplate: string;
+        /** 列挙の区切り。言語で変わる。 */
+        listSeparator: string;
+        /** 滞留警告に添える最終成功時刻。`{at}`。 */
+        oldestSyncedTemplate: string;
+        /** 未処理の同期要求。`{count}`。 */
+        pendingTemplate: string;
+        /** 連携先が 1 つも残っていないときの説明。 */
+        nothingToLink: string;
+        /** 未結線の配備で操作を出さない理由。 */
+        notWiredNotice: string;
+        /** 行ごとの読み上げ名。`{group}` をグループ名へ置換する。 */
+        syncNowAria: string;
+        pauseAria: string;
+        resumeAria: string;
+        allowGroupAria: string;
+        disallowGroupAria: string;
+        unlinkAria: string;
+        /** グループ単位のサインイン許可を外す確認。 */
+        confirmDisallow: string;
+        link: string;
+        unlink: string;
+        externalKey: string;
+        empty: string;
+        /** 直近の同期が失敗したグループの見出し。件数だけでは何が起きたか判らない。 */
+        erroredWarning: string;
+        /** 同期有効なリンクのうち最も古い成功時刻。滞留の実際の深さを示す。 */
+        oldestSyncedAt: string;
+        /** 連携するグループを選ぶ欄。 */
+        selectGroup: string;
+        /** 上流グループのアドレス入力。 */
+        externalKeyPlaceholder: string;
+        /** 連携解除の確認。台帳と許可設定が消える。 */
+        confirmUnlink: string;
+        /** 同期の一時停止・再開。 */
+        pause: string;
+        resume: string;
+        /** 許可グループに加える / 外す。 */
+        allowGroup: string;
+        disallowGroup: string;
+        /** グループ名と鍵の併記。`{name}` / `{key}`。 */
+        groupOptionTemplate: string;
     };
 };
 /**
@@ -100,12 +235,18 @@ declare const jaUserAdminLabels: UserAdminLabels;
 /** セクション単位の部分上書き。 */
 type PartialUserAdminLabels = {
     title?: string;
+    locale?: string;
+    timeZone?: string;
+    common?: Partial<UserAdminLabels["common"]>;
+    errors?: Partial<UserAdminLabels["errors"]>;
     heading?: string;
+    permissions?: Partial<UserAdminLabels["permissions"]>;
     tabs?: Partial<UserAdminLabels["tabs"]>;
     usersView?: Partial<UserAdminLabels["usersView"]>;
     groupsView?: Partial<UserAdminLabels["groupsView"]>;
     groupMembersView?: Partial<UserAdminLabels["groupMembersView"]>;
     allowlistView?: Partial<UserAdminLabels["allowlistView"]>;
+    directoryView?: Partial<UserAdminLabels["directoryView"]>;
 };
 /**
  * Shallow per-section merge over the English defaults.
@@ -149,6 +290,40 @@ type UserAdminStore = {
         description?: string;
     }) => Promise<AuthAllowlistEntry>;
     removeAllowlistEntry: (id: number) => Promise<void>;
+    /**
+     * Allows every member of an externally-sourced group to sign in.
+     * 外部供給グループのメンバー全員にサインインを許可する処理。
+     *
+     * 判定は上流メンバー台帳を読むため、ローカル管理のグループを渡しても誰にも何も与えない。
+     * ストアはそれを拒否すること (無言の no-op を作らない)。
+     */
+    addAllowlistGroup: (groupId: number, description?: string) => Promise<void>;
+    removeAllowlistGroup: (id: number) => Promise<void>;
+    /**
+     * Links a local group to a group in the upstream directory.
+     * ローカルグループを上流ディレクトリのグループへ結び付ける処理。
+     *
+     * リンク後、そのグループの名称と所属は上流が所有する。ロール割当はローカルのままである。
+     */
+    linkDirectoryGroup: (groupId: number, data: {
+        provider: string;
+        externalKey: string;
+        membershipMode: AuthDirectoryMembershipMode;
+    }) => Promise<void>;
+    /** Stops following the upstream, keeping the memberships already projected. 連携の解除。 */
+    unlinkDirectoryGroup: (groupId: number) => Promise<void>;
+    /** Pauses or resumes synchronization for one group. 1 グループの同期を停止・再開する処理。 */
+    setDirectorySyncEnabled: (groupId: number, isSyncEnabled: boolean) => Promise<void>;
+    /**
+     * Queues a synchronization request. 同期要求をキューへ積む処理。
+     *
+     * 上流へ到達できるのは同期ジョブだけなので、web からは要求を残すことしかできない。
+     *
+     * @param groupId `null` requests every linked group of the tenant. `null` はテナント全件。
+     */
+    requestDirectorySync: (groupId: number | null) => Promise<void>;
+    /** Health of the synchronization, for the header warning. 同期の健全性 (警告表示用)。 */
+    getDirectoryStatus: () => Promise<AuthDirectoryStatus>;
 };
 /**
  * Creates an in-memory UserAdminStore initialized with optional seed data.
@@ -194,6 +369,17 @@ type UserAdminGuards = {
         action: UserAdminAccess;
         intent: string;
     }) => Promise<void> | void;
+    /**
+     * Observes a denial that was converted into an in-page error. 画面内エラーへ変換した拒否の観測点。
+     *
+     * 拒否を画面内に返すと、既定のエラー経路が拾っていたログが消える。管理面への総当たりが
+     * 200 番台の列に紛れて見えなくなるため、宿主が記録できる口を開けておく。
+     */
+    onDenied?: (context: {
+        intent: string;
+        actions: readonly UserAdminAccess[];
+        error: unknown;
+    }) => void;
 };
 /**
  * Neutral per-resource permission summary the admin shell renders in its header badge.
@@ -247,10 +433,14 @@ declare function createUserAdminApp(config: UserAdminAppConfig): {
         groups: AuthGroup[];
         groupMembers: AuthGroupMember[];
         allowlist: AuthAllowlistEntry[];
+        directoryStatus: AuthDirectoryStatus;
         myPermissions: Record<string, UserAdminPermission | undefined> | null;
         labels: UserAdminLabels;
     }>;
-    action: ({ request }: RouteArgs) => Promise<{
+    action: ({ request }: RouteArgs) => Promise<react_router.UNSAFE_DataWithResponseInit<{
+        ok: boolean;
+        error: string;
+    }> | {
         ok: boolean;
         error?: undefined;
     } | {
@@ -278,6 +468,7 @@ type UserAdminLoaderData = {
     groups: AuthGroup[];
     groupMembers: AuthGroupMember[];
     allowlist: AuthAllowlistEntry[];
+    directoryStatus: AuthDirectoryStatus;
     labels?: UserAdminLabels;
 };
 declare function UsersView(): React__default.JSX.Element;
@@ -296,6 +487,15 @@ declare function GroupMembersView(): React__default.JSX.Element;
  * アクセス許可リスト (Allowlist) 管理ビュー。
  */
 declare function AllowlistView(): React__default.JSX.Element;
+/**
+ * View for the upstream directory: what is linked, how fresh it is, and the controls that change it.
+ * 上流ディレクトリのビュー。何が連携され、どれだけ新しく、それを変える操作を提供する。
+ *
+ * このタブが無いと、連携の作成・解除・一時停止・即時同期・グループ単位のサインイン許可という
+ * 5 つの操作にどこからも到達できない。実装されているのに押せる場所が無い状態は、実装が無いのと
+ * 変わらないうえ、「許可を消せるが作れない」という片肺の運用を強いる。
+ */
+declare function DirectoryView(): React__default.JSX.Element;
 type AuthUserAdminAppViewProps = UserAdminShellProps;
 /**
  * Top-level application view component for the user administration UI (`/users/*`).
@@ -303,4 +503,4 @@ type AuthUserAdminAppViewProps = UserAdminShellProps;
  */
 declare function AuthUserAdminAppView({ renderHeader }?: AuthUserAdminAppViewProps): React__default.JSX.Element;
 
-export { AllowlistView, AuthUserAdminAppView, type AuthUserAdminAppViewProps, GroupMembersView, GroupsView, type PartialUserAdminLabels, type UserAdminAccess, type UserAdminAppConfig, type UserAdminGuards, type UserAdminLabels, type UserAdminLoaderData, type UserAdminPermission, UserAdminShell, type UserAdminShellProps, type UserAdminStore, UsersView, createInMemoryUserAdminStore, createUserAdminApp, defaultUserAdminLabels, jaUserAdminLabels, resolveUserAdminLabels };
+export { AllowlistView, AuthUserAdminAppView, type AuthUserAdminAppViewProps, DirectoryView, GroupMembersView, GroupsView, type PartialUserAdminLabels, type UserAdminAccess, type UserAdminAppConfig, type UserAdminGuards, type UserAdminLabels, type UserAdminLoaderData, type UserAdminPermission, UserAdminShell, type UserAdminShellProps, type UserAdminStore, UsersView, createInMemoryUserAdminStore, createUserAdminApp, defaultUserAdminLabels, jaUserAdminLabels, resolveUserAdminLabels };