@things-factory/ai-assistant 10.1.250 → 10.1.256

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@things-factory/ai-assistant",
-  "version": "10.1.250",
+  "version": "10.1.256",
   "main": "dist-server/index.js",
   "things-factory": true,
   "author": "heartyoh",
@@ -35,14 +35,14 @@
     "@operato/shell": "^10.29.39",
     "@operato/styles": "^10.0.0",
     "@operato/utils": "^10.29.39",
-    "@things-factory/ai-client-base": "^10.1.250",
-    "@things-factory/apptool-base": "^10.1.247",
-    "@things-factory/attachment-base": "^10.1.250",
-    "@things-factory/auth-base": "^10.1.250",
+    "@things-factory/ai-client-base": "^10.1.256",
+    "@things-factory/apptool-base": "^10.1.254",
+    "@things-factory/attachment-base": "^10.1.256",
+    "@things-factory/auth-base": "^10.1.256",
     "@things-factory/env": "^10.1.149",
-    "@things-factory/help": "^10.1.247",
-    "@things-factory/setting-base": "^10.1.250",
-    "@things-factory/shell": "^10.1.247",
+    "@things-factory/help": "^10.1.254",
+    "@things-factory/setting-base": "^10.1.256",
+    "@things-factory/shell": "^10.1.254",
     "dompurify": "^3.0.0",
     "exceljs": "4.2.0",
     "graphql-scalars": "^1.22.0",
@@ -58,5 +58,5 @@
     "copyfiles": "^2.4.1",
     "rimraf": "^5.0.0"
   },
-  "gitHead": "4fdb6d24ef24f43d9e158d4c6d6396ad3097bb9e"
+  "gitHead": "2fd641697190ce6e87bcf454a60b2321553e8110"
 }

package/server/service/help-documents/help-tools.test.ts

@@ -7,7 +7,7 @@ jest.mock('@things-factory/help', () => {
     ...partsOfDocument('office/guide-employee.ko.html', '<h1>모든 직원</h1><h2 id="spending">경비 · 지출 올리기</h2><p>내 정보 › 내 지출결의 에서 새 결의를 작성합니다.</p>'),
     ...partsOfDocument('office/guide-employee.html', '<h1>Everyone</h1><h2 id="spending">Spending</h2><p>Write a new claim in My expense claims.</p>')
   ])
-  return { searchHelp: (q: string, o: any) => index.search(q, o), readHelp: (t: string, s: string, l: string) => index.read(t, s, l) }
+  return { searchHelp: async (q: string, o: any) => index.search(q, o), readHelp: async (t: string, s: string, l: string) => index.read(t, s, l) }
 })
 
 import { helpCategory, readHelpDocument, searchHelpDocuments } from './help-tools'
@@ -16,20 +16,20 @@ import { modeFrontCategories, modeToolCategories } from '../assistant-mode/mode-
 const korean = { state: { lng: 'ko' } }
 
 describe('the help tools', () => {
-  it('finds a part with its title and its link', () => {
-    expect(searchHelpDocuments({ query: '지출결의 올리기' }, korean)).toEqual({
+  it('finds a part with its title and its link', async () => {
+    expect(await searchHelpDocuments({ query: '지출결의 올리기' }, korean)).toEqual({
       found: 1,
       parts: [{ topic: 'office/guide-employee', section: 'spending', title: '모든 직원 › 경비 · 지출 올리기', summary: '내 정보 › 내 지출결의 에서 새 결의를 작성합니다.', link: 'help?topic=office%2Fguide-employee&section=spending' }]
     })
   })
 
-  it('says when the help has nothing, so the model does not answer from elsewhere', () => {
-    expect(searchHelpDocuments({ query: '주식 매수 방법' }, korean)).toMatchObject({ found: 0, message: expect.stringContaining('say so') })
+  it('says when the help has nothing, so the model does not answer from elsewhere', async () => {
+    expect(await searchHelpDocuments({ query: '주식 매수 방법' }, korean)).toMatchObject({ found: 0, message: expect.stringContaining('say so') })
   })
 
-  it('reads a part in the person\'s language', () => {
-    expect(readHelpDocument({ topic: 'office/guide-employee', section: 'spending' }, { state: { lng: 'en' } })).toMatchObject({ found: true, title: 'Spending' })
-    expect(readHelpDocument({ topic: 'office/guide-employee', section: 'none' }, korean)).toMatchObject({ found: false })
+  it('reads a part in the person\'s language', async () => {
+    expect(await readHelpDocument({ topic: 'office/guide-employee', section: 'spending' }, { state: { lng: 'en' } })).toMatchObject({ found: true, title: 'Spending' })
+    expect(await readHelpDocument({ topic: 'office/guide-employee', section: 'none' }, korean)).toMatchObject({ found: false })
   })
 
   it('reaches no door, and every conversation has it in front', () => {

package/server/service/help-documents/help-tools.ts

@@ -4,7 +4,8 @@
  * and reads it, rather than the mode's prompt carrying the manual.
  *
  * The help is no one's secret - every screen's `?` opens it for whoever is there - so the tools reach no door. Whether
- * the person may open the screen a part names is still that screen's own door.
+ * the person may open the screen a part names is still that screen's own door. A source's parts - the company's rules
+ * (ADR-0187 decision 12) - are found only where the source lets the person read them; they open where the source says.
  */
 import { registerToolCategory, type ToolCategory, type ToolSpec } from '@things-factory/ai-client-base'
 import { readHelp, searchHelp } from '@things-factory/help'
@@ -16,25 +17,25 @@ export const helpLink = (topic: string, section = '') => `help?topic=${encodeURI
 
 const languageOf = (context: any): string | undefined => context?.state?.lng || context?.state?.language || undefined
 
-export function searchHelpDocuments(args: { query?: string; limit?: number }, context?: any) {
+export async function searchHelpDocuments(args: { query?: string; limit?: number }, context?: any) {
   const query = String(args?.query ?? '').trim()
   if (!query) return { found: 0, parts: [], message: 'name what to look for.' }
-  const parts = searchHelp(query, { lang: languageOf(context), limit: Math.min(Math.max(Number(args?.limit) || 5, 1), 10) }).map(hit => ({
+  const parts = (await searchHelp(query, { lang: languageOf(context), limit: Math.min(Math.max(Number(args?.limit) || 5, 1), 10), context })).map(hit => ({
     topic: hit.topic,
     section: hit.section,
     title: hit.documentTitle === hit.title ? hit.title : `${hit.documentTitle} › ${hit.title}`,
     summary: hit.summary,
-    link: helpLink(hit.topic, hit.section)
+    link: hit.link ?? helpLink(hit.topic, hit.section)
   }))
   return parts.length ? { found: parts.length, parts } : { found: 0, parts: [], message: 'the help has nothing on this - say so; do not answer from general knowledge as if it were this application.' }
 }
 
-export function readHelpDocument(args: { topic?: string; section?: string }, context?: any) {
+export async function readHelpDocument(args: { topic?: string; section?: string }, context?: any) {
   const topic = String(args?.topic ?? '').trim()
   const section = String(args?.section ?? '').trim()
-  const part = topic ? readHelp(topic, section, languageOf(context)) : null
+  const part = topic ? await readHelp(topic, section, languageOf(context), context) : null
   if (!part) return { found: false, message: `no help part ${topic}${section ? `#${section}` : ''} - search again with searchHelp.` }
-  return { found: true, ...part, link: helpLink(part.topic, part.section) }
+  return { found: true, ...part, link: part.link ?? helpLink(part.topic, part.section) }
 }
 
 const searchSpec = {
@@ -78,7 +79,8 @@ export const helpCategory: ToolCategory = {
     '- When the person asks how to do something in this application, where a screen or menu is, what the steps are, or what a term on a screen means, call searchHelp, then readHelp on the part that answers it - before you answer.',
     '- Answer from what readHelp returned, in your own short words, and end with the part as a link: [its title](its link). Never invent a menu, a button or a step the help does not name.',
     '- When searchHelp finds nothing, say the help does not cover it; then answer only what your other tools show.',
-    '- The help says how the application works; figures and records still come from the other tools.'
+    '- The help says how the application works; figures and records still come from the other tools.',
+    "- A part of the company's own rules (a topic under regulation/) is the company's: answer with the article and its effective day as a link. Where the guidance on the law and the company's rule read differently, show both and do not judge between them."
   ].join('\n'),
   specs: [searchSpec, readSpec]
 }