@aiquants/daily-report 0.6.0 → 0.6.2

package/README.md

@@ -62,7 +62,7 @@ The standalone build bundles every JSX utility (and maps the shadcn tokens), but
 
 ## Required database schema
 
-Six tables: `DailyReportHub` (中核・出所横断), `DailyReportInternal` (アプリ内作成本文), `DailyReportComment`, `DailyReportLabel`, `DailyReportHub_Label`, `DailyReportUserStatus` (既読・スター)。
+Six tables: `DailyReportHub` (core/cross-source), `DailyReportInternal` (in-app content), `DailyReportComment`, `DailyReportLabel`, `DailyReportHub_Label`, `DailyReportUserStatus` (read status & stars).
 
 Existing apps can inject their own drizzle models (structural typing — see `DailyReportTables`). Greenfield projects can generate definitions:
 
@@ -83,18 +83,18 @@ export const dailyReportServer = createDailyReportServer({
     db: db as unknown as DailyReportDb,          // drizzle mssql handle
     tables: { hub, internal, comment, label, hubLabel, userStatus },
     userTable: Users,                            // { id, displayName }
-    resolveUserId: async (externalId) => {/* 外部 ID (Google sub 等) → 内部数値 ID */},
-    encodeUserId: (id) => encodeId(id),          // 内部 ID の難読化 (例: sqids)
+    resolveUserId: async (externalId) => {/* External ID (e.g., OAuth sub) -> internal numeric ID */},
+    encodeUserId: (id) => encodeId(id),          // Internal ID obfuscation (e.g. sqids)
     authenticate: authenticateInLoader,          // (request, { failureRedirect }) => { user?, cookie? }
-    redis: redisProvider as unknown as DailyReportRedisProvider, // 省略可 (SSE/epoch 無効化)
-    externalSources: [                           // 省略可: 別システムのレガシー日報テーブルの取り込み
+    redis: redisProvider as unknown as DailyReportRedisProvider, // Optional (disables SSE/epoch)
+    externalSources: [                           // Optional: ingest legacy daily report tables from external systems
         { sourceType: "legacy", table: LegacyReport, idColumn: LegacyReport.reportId, mapRow: mapLegacyRow },
     ],
-    draftLabelName: "draft",                     // 必須: 自 DB のドラフトラベル名 (パッケージは既定値を持たない)
+    draftLabelNames: ["Draft", "Work in Progress"], // Draft label names (can specify a single string or array of candidates)
 })
 ```
 
-Route mounts (React Router v7, file convention は自由):
+Route mounts (React Router v7, flexible file convention):
 
 ```ts
 // daily_report._index/loader.server.ts
@@ -111,13 +111,13 @@ export const loader = (args) => dailyReportServer.sse.loader(args)
 
 ### DI ports
 
-- `authenticate(request, { failureRedirect })` — セッション検証。`failureRedirect: string` のとき未認証は redirect を throw する実装にする。
-- `resolveUserId(externalId)` — 外部 ID → 内部数値 ID (`null` = 未登録)。プロセス内キャッシュは `disableUserIdCache` で無効化可 (テスト用)。
-- `encodeUserId(id)` — クライアントへ出す ID の難読化。既存 ID 空間を維持するためアプリ側実装を注入する。
-- `redis` — `getClient()` (get/incr/xAdd/xRange/xRevRange) + `createClient()` (blocking xRead)。`node-redis` v5 クライアントが構造的に適合する。省略時: SSE publish はスキップ (warn)、epoch 無効。
-- `externalSources[]` — `Hub.source_type` 一致時に `Hub.source_id_num = idColumn` で LEFT JOIN し `mapRow` で表示フィールドへ変換。
-- `draftLabelName` — **必須**。ドラフト状態を表す自 DB のラベル名。サーバー側のクロスユーザー可視性フィルタ (他ユーザーの下書きを隠す) に使うため、パッケージはサイレントな既定値を持たない。
-- 主要チューニング: `idsTtlMs` (180s) / `businessDateTtlMs` (300s) / `streamKey` / `streamMaxLen` / `loginRedirectPath`。
+- `authenticate(request, { failureRedirect })` — Session verification. When `failureRedirect: string` is set, throw a redirect on unauthenticated requests.
+- `resolveUserId(externalId)` — External ID → internal numeric ID (`null` = unregistered). In-process caching can be disabled with `disableUserIdCache` (useful for testing).
+- `encodeUserId(id)` — Obfuscates IDs sent to the client. Inject app-level implementation to preserve existing ID namespaces.
+- `redis` — `getClient()` (get/incr/xAdd/xRange/xRevRange) + `createClient()` (blocking xRead). Structurally matches a `node-redis` v5 client. If omitted, SSE publishing is skipped (with a warning) and epoch is disabled.
+- `externalSources[]` — When `Hub.source_type` matches, performs a `LEFT JOIN` on `Hub.source_id_num = idColumn` and converts fields via `mapRow`.
+- `draftLabelName` / `draftLabelNames` — Database label names representing draft states (single string or array of candidates like `["Draft", "Work in Progress"]`). Used for server-side cross-user visibility filtering (hiding drafts from other users) and `isDraft` evaluation.
+- Primary tuning parameters: `idsTtlMs` (180s) / `businessDateTtlMs` (300s) / `streamKey` / `streamMaxLen` / `loginRedirectPath`.
 
 ## Client wiring
 
@@ -126,7 +126,7 @@ export const loader = (args) => dailyReportServer.sse.loader(args)
 import { createDailyReportClientLoader, DailyReportPage, dailyReportShouldRevalidate } from "@aiquants/daily-report/client"
 
 export const shouldRevalidate = dailyReportShouldRevalidate
-export const clientLoader = createDailyReportClientLoader()   // /daily_report/api/ids を defer 取得
+export const clientLoader = createDailyReportClientLoader()   // Deferred fetching of /daily_report/api/ids
 
 export default function Route() {
     const { user, userId, dailyReportIds } = useLoaderData<typeof clientLoader>()
@@ -138,10 +138,10 @@ export default function Route() {
                 dailyReportIds={dailyReportIds}
                 config={{
                     renderHeader: ({ title, annotation }) => <YourHeader title={title} annotation={annotation} />,
-                    showDevControls: import.meta.env.DEV,   // SSE 購読トグル等
-                    draftLabelName: "draft",                // ドラフト状態のラベル名 (自 DB に合わせる)
-                    fieldLabels: {                          // 詳細/一覧カードの見出しラベル (下記参照。部分上書き可)
-                        businessDate: "日付", content: "本文", comments: "コメント", /* ... 各キーを自アプリの言語・表記へ */
+                    showDevControls: import.meta.env.DEV,   // Toggle SSE subscriptions, etc.
+                    draftLabelName: "Draft",                // Label name for draft states (matches target DB)
+                    fieldLabels: {                          // Card/detail header labels (customizable per key)
+                        businessDate: "Date", content: "Body", comments: "Comments", /* ... override to match app locale */
                     },
                     // apiBasePath: "/daily_report/api", ssePath: "/sse/daily_report/updates"
                 }}
@@ -151,28 +151,28 @@ export default function Route() {
 }
 ```
 
-`DailyReportPage` はレイアウト非依存 (ヘッダーは `renderHeader` スロット、エラー境界・フッター制御はアプリ側)。細粒度に使う場合は `DailyReportActionProvider` / `DailyReportResolvedContent` / `useDailyReportDetail` 等を個別 import できる。
+`DailyReportPage` is layout-agnostic (header rendering via `renderHeader` slot, error boundaries/footer control managed by the app). For fine-grained usage, `DailyReportActionProvider`, `DailyReportResolvedContent`, `useDailyReportDetail`, etc. can be imported individually.
 
-### フィールドラベル (`fieldLabels`)
+### Field Labels (`fieldLabels`)
 
-詳細/一覧カードの見出し (`id` / `businessDate` / `author` / `visitTime` / `createdAt` / `updatedAt` / `updatedBy` / `category` / `categoryInfo` / `creationCategory` / `customer` / `subject` / `content` / `interviewers` / `comments` / `tabArticle` / `tabRelations` / `relationsEmpty`) はすべて DI。**パッケージは中立な英語 (`Business date` / `Customer` / `Content` 等) のみを既定で同梱**し、各見出しの言語・表記は消費アプリが `fieldLabels` で上書きする。これによりパッケージ本体は業務ドメイン固有の表記を持たない。部分指定した分だけ既定へ上書きされる (`DailyReportConfigProvider` が 1 段深くマージ)。
+Card and detail headings (`id` / `businessDate` / `author` / `visitTime` / `createdAt` / `updatedAt` / `updatedBy` / `category` / `categoryInfo` / `creationCategory` / `customer` / `subject` / `content` / `interviewers` / `comments` / `tabArticle` / `tabRelations` / `relationsEmpty`) are fully dependency-injected. **The package includes neutral English defaults** (`Business date` / `Customer` / `Content`, etc.), and consuming applications override headings via `fieldLabels`. This ensures the package itself carries no domain-specific wording. Partial overrides merge deeply over defaults (`DailyReportConfigProvider` performs a 1-level deep merge).
 
-### 外部ソースバッジ設定 (`sourceTypeConfigs`)
+### External Source Badge Configuration (`sourceTypeConfigs`)
 
-外部ソースから取り込まれた日報の表示 (ラベル名やバッジの CSS クラス) を `sourceTypeConfigs` で上書き設定できます。これにより、パッケージ自身は特定の外部サービス ( NI 日報や Kintone など) の名前やデザインに依存せず、ホストアプリケーションから柔軟に表示をカスタマイズできます。
+Display parameters (label names and badge CSS classes) for reports ingested from external sources can be overridden using `sourceTypeConfigs`. This prevents the package from hardcoding specific third-party service names or designs, leaving display customization to the host application.
 
 ```tsx
 sourceTypeConfigs: {
     Internal: {
-        label: "オリジナル",
+        label: "Native",
         badgeClassName: "bg-green-100 text-green-800 dark:bg-green-900/30 dark:text-green-400",
     },
-    NI: {
-        label: "NI 日報",
+    ExternalCRM: {
+        label: "External CRM",
         badgeClassName: "bg-red-100 text-red-800 dark:bg-red-900/30 dark:text-red-400",
     },
-    Kintone: {
-        label: "Kintone",
+    LegacyPortal: {
+        label: "Legacy Portal",
         badgeClassName: "bg-blue-100 text-blue-800 dark:bg-blue-900/30 dark:text-blue-400",
     },
 }
@@ -216,17 +216,17 @@ export default defineConfig({
 })
 ```
 
-## Realtime architecture
+## Realtime Architecture
 
-1. 変更系サービスは `invalidate → epoch increment → SSE publish` の順で Redis Stream (`daily-report:sse-stream`) へ発行。
-2. `DailyReportSseReader` が単一の blocking `xRead` ループで全 SSE 接続へ fan-out (接続ごとの Redis TCP を排除)。
-3. `sse.loader` は `Last-Event-ID` / `lastEventId` による catch-up (`xRange`) と 5 秒 keep-alive を実装。`recipientRawUserId` はサーバー側でフィルタ後に除去される (内部 ID 漏洩防止)。
-4. クライアントは `useDailyReportSseConnection` が指数バックオフ再接続し、アクションコンテキストが楽観的更新と SSE エコーを `clientTempId` で照合する。
+1. Mutation services publish to Redis Stream (`daily-report:sse-stream`) in sequence: `invalidate -> epoch increment -> SSE publish`.
+2. `DailyReportSseReader` uses a single blocking `xRead` loop to fan-out events to all SSE connections (eliminating per-connection Redis TCP connections).
+3. `sse.loader` implements catch-up (`xRange`) using `Last-Event-ID` / `lastEventId` and 5-second keep-alive pings. `recipientRawUserId` is filtered server-side and removed before transmission to prevent internal ID leaks.
+4. On the client, `useDailyReportSseConnection` handles exponential backoff reconnects, and the action context correlates optimistic updates with SSE echoes using `clientTempId`.
 
-## API surface (抜粋)
+## API Surface (Summary)
 
-- server: `createDailyReportServer` / `createDailyReportService` / `createDailyReportHandlers` / `defineDailyReportSchema` / `DailyReportSseReader` / `SqlResultCache` / `transformJsonArray` / `jsonResponseWithETag` / `generateETag` / `isStreamIdLte`
-- client: `DailyReportPage` / `DailyReportResolvedContent` / `DailyReportList` / `DailyReportDetailList` / `DailyReportActionProvider` / `useDailyReportActionContext` / `useDailyReportDetail` / `useDailyReportPrefetch` / `useDailyReportComments` / `useDailyReportSseConnection` / `DailyReportConfigProvider` / `createDailyReportClientLoader` / `dailyReportShouldRevalidate`
-- shared: `DailyReportItem` / `DailyReportDetail` / `DailyReportUser` / `dailyReportSseMessageSchema` (8 種 discriminated union) / `normalizeBusinessDateKey` / `mergeComments`
+- **server**: `createDailyReportServer` / `createDailyReportService` / `createDailyReportHandlers` / `defineDailyReportSchema` / `DailyReportSseReader` / `SqlResultCache` / `transformJsonArray` / `jsonResponseWithETag` / `generateETag` / `isStreamIdLte`
+- **client**: `DailyReportPage` / `DailyReportResolvedContent` / `DailyReportList` / `DailyReportDetailList` / `DailyReportActionProvider` / `useDailyReportActionContext` / `useDailyReportDetail` / `useDailyReportPrefetch` / `useDailyReportComments` / `useDailyReportSseConnection` / `DailyReportConfigProvider` / `createDailyReportClientLoader` / `dailyReportShouldRevalidate`
+- **shared**: `DailyReportItem` / `DailyReportDetail` / `DailyReportUser` / `dailyReportSseMessageSchema` (8 discriminated union types) / `normalizeBusinessDateKey` / `mergeComments`
 
 MIT

package/dist/client.d.mts

@@ -61,12 +61,14 @@ type DailyReportDetailListProps = {
     userId?: string | null;
     selectedItemId?: number | null;
     onSelectItem?: (id: number | null) => void;
+    initialScrollOffset?: number;
+    onScrollOffsetChange?: (offset: number) => void;
 };
 /**
  * Daily report detail cards rendered with dynamic height virtual scroll.
  * 動的高さの仮想スクロールで日報詳細カードを描画するコンポーネント。
  */
-declare const DailyReportDetailList: ({ dailyReportItems, userId, selectedItemId, onSelectItem }: DailyReportDetailListProps) => react.JSX.Element;
+declare const DailyReportDetailList: ({ dailyReportItems, userId, selectedItemId, onSelectItem, initialScrollOffset, onScrollOffsetChange }: DailyReportDetailListProps) => react.JSX.Element;
 
 type DailyReportEditFormProps = {
     report: DailyReportDetail;
@@ -83,12 +85,14 @@ type DailyReportListProps = {
     selectedReportHubId: number | null;
     onSelectItem: (reportHubId: number | null) => void;
     userId?: string | null;
+    initialScrollOffset?: number;
+    onScrollOffsetChange?: (offset: number) => void;
 };
 /**
  * Daily report list cards with key metadata and preview content via virtual scrolling.
  * 主なメタデータと内容プレビューを仮想スクロール表示する日報リスト。
  */
-declare const DailyReportList: ({ dailyReportItems, initialSelectedBusinessDate, initialSelectedReportHubId, autoMarkRead, selectedReportHubId, onSelectItem, userId }: DailyReportListProps) => react.JSX.Element;
+declare const DailyReportList: ({ dailyReportItems, initialSelectedBusinessDate, initialSelectedReportHubId, autoMarkRead, selectedReportHubId, onSelectItem, userId, initialScrollOffset, onScrollOffsetChange }: DailyReportListProps) => react.JSX.Element;
 
 /** ヘッダー描画スロットに渡される引数。 */
 type DailyReportHeaderProps = {
@@ -126,6 +130,8 @@ type DailyReportFieldLabels = {
 type SourceTypeConfig = {
     label: string;
     badgeClassName?: string;
+    /** コメント投稿を許可するかどうか (既定 true)。false の場合、該当ソースの日報でコメント投稿フォームを非表示にする。 */
+    allowComment?: boolean;
 };
 /** クライアント層の設定一式。 */
 type DailyReportClientConfig = {
@@ -500,7 +506,7 @@ declare const dailyReportShouldRevalidate: ShouldRevalidateFunction;
  * Fetches the deferred daily report id list from the API endpoint.
  * API エンドポイントから日報 ID 一覧を遅延取得する処理。
  */
-declare const fetchDailyReportIds: (apiBasePath?: string) => Promise<DailyReportItem[]>;
+declare const fetchDailyReportIds: (apiBasePath?: string, forceRefresh?: boolean) => Promise<DailyReportItem[]>;
 /**
  * Creates a React Router clientLoader that merges server data with deferred report ids.
  * サーバーデータへ遅延日報 ID を合成する React Router clientLoader を生成する処理。

package/dist/client.d.ts

@@ -61,12 +61,14 @@ type DailyReportDetailListProps = {
     userId?: string | null;
     selectedItemId?: number | null;
     onSelectItem?: (id: number | null) => void;
+    initialScrollOffset?: number;
+    onScrollOffsetChange?: (offset: number) => void;
 };
 /**
  * Daily report detail cards rendered with dynamic height virtual scroll.
  * 動的高さの仮想スクロールで日報詳細カードを描画するコンポーネント。
  */
-declare const DailyReportDetailList: ({ dailyReportItems, userId, selectedItemId, onSelectItem }: DailyReportDetailListProps) => react.JSX.Element;
+declare const DailyReportDetailList: ({ dailyReportItems, userId, selectedItemId, onSelectItem, initialScrollOffset, onScrollOffsetChange }: DailyReportDetailListProps) => react.JSX.Element;
 
 type DailyReportEditFormProps = {
     report: DailyReportDetail;
@@ -83,12 +85,14 @@ type DailyReportListProps = {
     selectedReportHubId: number | null;
     onSelectItem: (reportHubId: number | null) => void;
     userId?: string | null;
+    initialScrollOffset?: number;
+    onScrollOffsetChange?: (offset: number) => void;
 };
 /**
  * Daily report list cards with key metadata and preview content via virtual scrolling.
  * 主なメタデータと内容プレビューを仮想スクロール表示する日報リスト。
  */
-declare const DailyReportList: ({ dailyReportItems, initialSelectedBusinessDate, initialSelectedReportHubId, autoMarkRead, selectedReportHubId, onSelectItem, userId }: DailyReportListProps) => react.JSX.Element;
+declare const DailyReportList: ({ dailyReportItems, initialSelectedBusinessDate, initialSelectedReportHubId, autoMarkRead, selectedReportHubId, onSelectItem, userId, initialScrollOffset, onScrollOffsetChange }: DailyReportListProps) => react.JSX.Element;
 
 /** ヘッダー描画スロットに渡される引数。 */
 type DailyReportHeaderProps = {
@@ -126,6 +130,8 @@ type DailyReportFieldLabels = {
 type SourceTypeConfig = {
     label: string;
     badgeClassName?: string;
+    /** コメント投稿を許可するかどうか (既定 true)。false の場合、該当ソースの日報でコメント投稿フォームを非表示にする。 */
+    allowComment?: boolean;
 };
 /** クライアント層の設定一式。 */
 type DailyReportClientConfig = {
@@ -500,7 +506,7 @@ declare const dailyReportShouldRevalidate: ShouldRevalidateFunction;
  * Fetches the deferred daily report id list from the API endpoint.
  * API エンドポイントから日報 ID 一覧を遅延取得する処理。
  */
-declare const fetchDailyReportIds: (apiBasePath?: string) => Promise<DailyReportItem[]>;
+declare const fetchDailyReportIds: (apiBasePath?: string, forceRefresh?: boolean) => Promise<DailyReportItem[]>;
 /**
  * Creates a React Router clientLoader that merges server data with deferred report ids.
  * サーバーデータへ遅延日報 ID を合成する React Router clientLoader を生成する処理。