@awesomate/sdk 0.19.0 → 0.21.0

package/dist/index.d.ts

@@ -24,7 +24,7 @@
  * Docs: https://hub.awesomate.ai/docs/sdk/
  */
 /** This package's version, sent to the hub with every server call. */
-export declare const VERSION = "0.19.0";
+export declare const VERSION = "0.21.0";
 /** Augmented by the generated awesomate.d.ts, so each kind's rows are typed. */
 export interface Kinds {
 }
@@ -260,6 +260,22 @@ export interface FilesUsage {
     partial: boolean;
     measured_at: string;
 }
+/** An answer from the app's agent to a typed question (app.ask()). */
+export interface AgentAnswer {
+    /** answered: from the business's content, with sources; none: the content has no answer (or not for this person). */
+    status: 'answered' | 'none';
+    answer: string;
+    /** Where the answer came from: show them with it. */
+    sources: Array<{
+        title: string;
+        url: string | null;
+    }>;
+    /**
+     * The platform's sentence about keeping questions it could not answer. It comes with a person's
+     * first answer only: show it with that answer.
+     */
+    questionNotice: string | null;
+}
 /** A file uploaded from an app. Keep `handle` in a record (a kind's file attribute); it opens the file again. */
 export interface AppFile {
     handle: string;
@@ -585,7 +601,10 @@ export interface BusinessMapJob {
     /** active: someone holds it. open: nobody does. hire_next: the owner's next hire. */
     state: 'active' | 'open' | 'hire_next';
     isOwnerJob: boolean;
+    /** Runs its division: the division manager, above its departments, so departmentNo is null (the owner's job excepted). */
     headsDivision: boolean;
+    /** Runs its department: the person responsible for it, and for its department-level KPIs. */
+    headsDepartment: boolean;
     departmentNo: number | null;
     reportsTo: {
         id: number;
@@ -650,10 +669,20 @@ export interface BusinessMapDivision {
     helpers: Array<BusinessMapHelper & {
         placedBy: string;
     }>;
+    /** Each department and who runs it: the holder of the job that heads it, else whoever runs the division (byDefault). */
     departments: Array<{
         no: number;
         name: string;
         gloss: string;
+        runBy: {
+            name: string;
+            byDefault: boolean;
+        };
+        headJob: {
+            id: number;
+            slug: string;
+            title: string;
+        } | null;
     }>;
     ideas: Array<{
         label: string;
@@ -1100,6 +1129,21 @@ export declare class AwesomateAppClient {
         /** The file a handle names, for someone signed in to this app. */
         download: (handle: string) => Promise<Blob>;
     };
+    /**
+     * Ask the app's agent a typed question, as this signed-in person: a help box that answers from
+     * the business's content, with sources. The agent is the one the account picked for the app (the
+     * same one Talk uses). Show `questionNotice` with the answer when it comes (a person's first).
+     * The agent answers only from content this person may see; the voice persona does not apply.
+     * A refusal's serverCode says why: no_agent, channel_off, person_daily (30 a day per person),
+     * agent_daily, answers_used_up; personMessage is the sentence to show.
+     *
+     * @example
+     * const a = await app.ask('What time do you open on Saturday?');
+     * render(a.answer, a.sources, a.questionNotice);
+     */
+    ask(question: string, options?: {
+        session?: string;
+    }): Promise<AgentAnswer>;
     /**
      * The agent this app talks with by voice, or null when the account has not picked one. Pass it
      * to AwesomateAgent.mount as agentId; the hub decides which agent answers, never the page.

package/dist/index.js

@@ -24,7 +24,7 @@
  * Docs: https://hub.awesomate.ai/docs/sdk/
  */
 /** This package's version, sent to the hub with every server call. */
-export const VERSION = '0.19.0';
+export const VERSION = '0.21.0';
 const DEFAULT_BASE = 'https://hub.awesomate.ai';
 const ERROR_CODES = ['unauthenticated', 'forbidden', 'not_found', 'validation', 'consent_blocked', 'rate_limited', 'conflict', 'unavailable'];
 /**
@@ -809,6 +809,22 @@ export class AwesomateAppClient {
         /** The file a handle names, for someone signed in to this app. */
         download: async (handle) => this.authed(async (token) => (await this.rawData('GET', `/files/${encodeURIComponent(handle)}`, token)).blob()),
     };
+    /**
+     * Ask the app's agent a typed question, as this signed-in person: a help box that answers from
+     * the business's content, with sources. The agent is the one the account picked for the app (the
+     * same one Talk uses). Show `questionNotice` with the answer when it comes (a person's first).
+     * The agent answers only from content this person may see; the voice persona does not apply.
+     * A refusal's serverCode says why: no_agent, channel_off, person_daily (30 a day per person),
+     * agent_daily, answers_used_up; personMessage is the sentence to show.
+     *
+     * @example
+     * const a = await app.ask('What time do you open on Saturday?');
+     * render(a.answer, a.sources, a.questionNotice);
+     */
+    async ask(question, options = {}) {
+        const r = await this.data('POST', '/agents/ask', { question, ...(options.session ? { session: options.session } : {}) });
+        return { status: r.status, answer: r.answer, sources: r.sources ?? [], questionNotice: r.question_notice ?? null };
+    }
     /**
      * The agent this app talks with by voice, or null when the account has not picked one. Pass it
      * to AwesomateAgent.mount as agentId; the hub decides which agent answers, never the page.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@awesomate/sdk",
-  "version": "0.19.0",
+  "version": "0.21.0",
   "description": "Your own Awesomate data from Node and the browser: query contacts and app data with generated types, and sign your app's own users in",
   "license": "MIT",
   "type": "module",