@awesomate/sdk 0.13.0 → 0.15.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.13.0";
+export declare const VERSION = "0.15.0";
 /** Augmented by the generated awesomate.d.ts, so each kind's rows are typed. */
 export interface Kinds {
 }
@@ -298,6 +298,13 @@ export declare class AwesomateClient {
      * token (hosting:read, every plan), never an app key.
      */
     business(): Promise<BusinessIdentity>;
+    /**
+     * The business map: the seven divisions every business has, the jobs in each and who holds them,
+     * which agents and automations help which job and how far each may go, and what is missing, most
+     * important first. Read only: the owner changes the map in the hub. Needs the account's token
+     * (hosting:read, every plan), never an app key, and the account must have the business map.
+     */
+    businessMap(): Promise<BusinessMap>;
     /** Details waiting for the owner's yes on Your business: from the website, the account, a team member or a file. */
     businessSuggestions(): Promise<BusinessSuggestion[]>;
     /** Grouped numbers (counts, sums) in the Business Data API's shape. */
@@ -360,6 +367,162 @@ export interface BusinessIdentity {
     /** Where the owner changes these details, in words. */
     how_to_change: string;
 }
+/** How far someone, or an agent, decides alone: 1 find out, 2 suggest options, 3 recommend and wait, 4 do it then tell, 5 report only the exceptions. */
+export type BusinessMapLevel = 1 | 2 | 3 | 4 | 5;
+/** Something that helps: an agent, a library install, an automation Awesomate built, or a tool outside Awesomate. */
+export interface BusinessMapHelper {
+    kind: 'agent' | 'bundle' | 'template' | 'build' | 'external';
+    ref: string;
+    label: string;
+}
+/** A job on the map. `slug` is its stable name for routing work: "whoever holds quotes". */
+export interface BusinessMapJob {
+    id: number;
+    slug: string;
+    title: string;
+    mission: string | null;
+    /** active: someone holds it. open: nobody does. hire_next: the owner's next hire. */
+    state: 'active' | 'open' | 'hire_next';
+    isOwnerJob: boolean;
+    headsDivision: boolean;
+    departmentNo: number | null;
+    reportsTo: {
+        id: number;
+        title: string;
+    } | null;
+    holders: Array<{
+        membershipId: number;
+        name: string;
+        accountable: boolean;
+        timeSharePct: number | null;
+    }>;
+    responsibilities: Array<{
+        text: string;
+        level: BusinessMapLevel;
+        exceptions: string | null;
+    }>;
+    helpers: Array<BusinessMapHelper & {
+        id: number;
+        supervisor: string;
+        level: BusinessMapLevel | null;
+        exceptions: string | null;
+        minutesSavedPerRun: number | null;
+    }>;
+    /** The tag this job's procedures carry in 1Brain, such as 'job:quotes'. The map keeps no procedure text. */
+    proceduresTag: string;
+}
+/** One step of the customer's path. */
+export interface BusinessMapPathStep {
+    position: number;
+    label: string;
+    divisionNo: 1 | 2 | 3 | 4 | 5 | 6 | 7;
+    verb: string;
+    /** The job that looks after the step, when the owner named one. */
+    job: {
+        id: number;
+        slug: string;
+        title: string;
+    } | null;
+    /** Who looks after it: the job's holder, else whoever runs the division (byDefault). */
+    owner: {
+        name: string;
+        byDefault: boolean;
+    };
+    /** Where this step hands over to the next, in the owner's words. */
+    handoffRule: string | null;
+}
+/** One of the seven divisions, in board order (7 first). */
+export interface BusinessMapDivision {
+    no: 1 | 2 | 3 | 4 | 5 | 6 | 7;
+    /** Envision, Form, Promise, Balance, Fulfil, Refine, Share. */
+    verb: string;
+    name: string;
+    purpose: string;
+    stage: 'survive' | 'grow' | 'scale';
+    /** Who runs it. byDefault: nobody else has been given it, so the owner does. */
+    runBy: {
+        name: string;
+        byDefault: boolean;
+    };
+    jobs: BusinessMapJob[];
+    /** Helping here but not yet put on a job, with how they were placed, in words. */
+    helpers: Array<BusinessMapHelper & {
+        placedBy: string;
+    }>;
+    departments: Array<{
+        no: number;
+        name: string;
+        gloss: string;
+    }>;
+    ideas: Array<{
+        label: string;
+        what: string;
+        status: 'live' | 'library' | 'coming' | 'building' | 'planned';
+        path?: string;
+    }>;
+    numbers: Array<{
+        label: string;
+        kind: 'lead' | 'result';
+    }>;
+    question: string;
+    /** 1Brain departments whose procedures belong in this division. */
+    oneBrainDepartments: string[];
+}
+/** The business map, as businessMap() returns it. No email addresses. */
+export interface BusinessMap {
+    business: {
+        name: string | null;
+        ownerName: string;
+    };
+    /** false: the owner has not started the map, so it is worked out from what the account runs. */
+    stored: boolean;
+    people: Array<{
+        id: number | null;
+        name: string;
+        kind: 'owner' | 'staff' | 'contractor' | 'adviser' | null;
+        role: 'owner' | 'full' | 'view' | null;
+        location: string | null;
+        fromTeamAccess: boolean;
+    }>;
+    divisions: BusinessMapDivision[];
+    /** Helpers we could not place on a division. */
+    unplaced: Array<BusinessMapHelper & {
+        placedBy: string;
+    }>;
+    /** How a customer moves through the business. stored false: suggested for its kind of business, not set by the owner yet. */
+    path: {
+        stored: boolean;
+        template: {
+            key: string;
+            label: string;
+        } | null;
+        steps: BusinessMapPathStep[];
+    };
+    /** What is missing, most important first. */
+    gaps: Array<{
+        kind: 'procedure_first' | 'no_helper' | 'job_open' | 'path_missing' | 'path_unowned' | 'owner_everywhere' | 'unplaced';
+        division: number | null;
+        title: string;
+        detail: string;
+        action: {
+            label: string;
+            path: string;
+        } | null;
+    }>;
+    settings: {
+        adviser: string | null;
+        runsWeek: string | null;
+    };
+    counts: {
+        people: number;
+        helpers: number;
+        placed: number;
+        divisionsWithHelpers: number;
+        jobs: number;
+    };
+    /** Sources that could not be read just now: a missing helper may simply not have been read. */
+    unavailable: string[];
+}
 /** A detail waiting for the owner's yes. */
 export interface BusinessSuggestion {
     id: number;

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.13.0';
+export const VERSION = '0.15.0';
 const DEFAULT_BASE = 'https://hub.awesomate.ai';
 const ERROR_CODES = ['unauthenticated', 'forbidden', 'not_found', 'validation', 'consent_blocked', 'rate_limited', 'conflict', 'unavailable'];
 /**
@@ -254,6 +254,15 @@ export class AwesomateClient {
     business() {
         return this.request('GET', '/api/my-business/v1/identity?format=json');
     }
+    /**
+     * The business map: the seven divisions every business has, the jobs in each and who holds them,
+     * which agents and automations help which job and how far each may go, and what is missing, most
+     * important first. Read only: the owner changes the map in the hub. Needs the account's token
+     * (hosting:read, every plan), never an app key, and the account must have the business map.
+     */
+    async businessMap() {
+        return (await this.request('GET', '/api/my-business/v1/map?format=json')).map;
+    }
     /** Details waiting for the owner's yes on Your business: from the website, the account, a team member or a file. */
     async businessSuggestions() {
         return (await this.request('GET', '/api/my-business/v1/proposals')).proposals;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@awesomate/sdk",
-  "version": "0.13.0",
+  "version": "0.15.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",
@@ -35,8 +35,6 @@
   },
   "devDependencies": {
     "@types/node": "^20.17.0",
-    "marked": "^18.0.14",
-    "shiki": "^4.5.0",
     "typedoc": "^0.28.20",
     "typescript": "^5.7.2"
   }