@awesomate/sdk 0.1.0 → 0.2.0

package/README.md

@@ -30,6 +30,30 @@ const one = await db.get('contact', rows[0].id); // null if there is none
 const byPlan = await db.aggregate({ measures: [{ column: 'people', agg: 'count' }], dimensions: ['plan'] });
 ```
 
+## Writing app data (Support Plus and above)
+
+Define the tables an app keeps, then write to them. There's no migration and no SQL; every value is
+checked against the kind (types, choices, required attributes and links).
+
+```ts
+await db.defineKind({
+  key: 'job', label: 'Job', label_plural: 'Jobs',
+  attributes: [
+    { key: 'title', type: 'text', required: true, readable_by_ai: true },
+    { key: 'status', type: 'choice', choices: ['open', 'booked', 'done'], readable_by_ai: true },
+  ],
+  links: [{ key: 'customer', to: 'contact' }],
+});
+const id = await db.write('job', { title: 'Possum in the roof', status: 'open' }, { links: { customer: contactId } });
+await db.write('job', { status: 'booked' }, { id });            // values not given stay
+const jobs = await db.query('job', { where: { customer_id: contactId } });
+await db.archive('job', id);
+```
+
+Only attributes marked `readable_by_ai` come back from `query` and `get`; a `sensitive` attribute
+can never be readable. Contacts themselves are not written this way: the contact list keeps its
+own consent rules.
+
 ## What you can read
 
 The built-in contact details (name, email, phone, company, tags, when they were added) and only

package/dist/index.d.ts

@@ -7,9 +7,10 @@
  *   const { rows, next } = await db.query('contact', { where: { created_at: { gte: '$YEAR_BEGIN' } }, limit: 50 });
  *
  * The account's token (a hosting PAT with crm:read) is a secret: use it on a server, never in a
- * browser. End-user sign-in for browser apps comes in a later version.
+ * browser. End-user sign-in for browser apps comes in a later version. Writing app data (kinds and
+ * their records) needs crm:write, Support Plus and above.
  */
-export declare const VERSION = "0.1.0";
+export declare const VERSION = "0.2.0";
 /** Augmented by the generated awesomate.d.ts, so each kind's rows are typed. */
 export interface Kinds {
 }
@@ -151,6 +152,14 @@ export declare class AwesomateClient {
     get<K extends KindName>(kind: K, id: string, options?: {
         tz?: string;
     }): Promise<RowOf<K> | null>;
+    /** The app kinds this account has defined. */
+    kinds(): Promise<KindDescription[]>;
+    /** Define an app kind (a table an app keeps). No migration: registry rows and generated views. */
+    defineKind(spec: KindSpec): Promise<KindDescription>;
+    /** Create a record (returns its id), or change one with options.id. Every value is checked against the kind. */
+    write<K extends KindName>(kind: K, data: Partial<RowOf<K>> | Record<string, unknown>, options?: WriteOptions): Promise<string>;
+    /** Archive a record: it leaves every read and is kept for a restore. */
+    archive<K extends KindName>(kind: K, id: string): Promise<void>;
     /** Grouped numbers (counts, sums) in the Business Data API's shape. */
     aggregate(request: {
         measures: Array<{
@@ -178,5 +187,45 @@ export declare class AwesomateClient {
         limit?: number;
     }): Promise<Record<string, unknown>>;
 }
+export interface AttributeSpec {
+    key: string;
+    label?: string;
+    type?: 'text' | 'long_text' | 'number' | 'money' | 'date' | 'datetime' | 'duration' | 'yes_no' | 'choice' | 'choices' | 'email' | 'phone' | 'address' | 'url' | 'file';
+    choices?: string[];
+    required?: boolean;
+    sensitivity?: 'ordinary' | 'personal' | 'sensitive';
+    /** Default false. Only readable attributes reach query(), get() and the generated types. */
+    readable_by_ai?: boolean;
+}
+export interface KindSpec {
+    key: string;
+    label?: string;
+    label_plural?: string;
+    attributes: AttributeSpec[];
+    /** to is 'contact' or a kind already defined; each link reads back as <key>_id. */
+    links?: Array<{
+        key: string;
+        to: string;
+        label?: string;
+        to_label?: string;
+        required?: boolean;
+    }>;
+}
+export interface KindDescription extends Omit<KindSpec, 'attributes'> {
+    storage: 'plain' | 'tracked';
+    attributes: Array<Required<Pick<AttributeSpec, 'key' | 'label' | 'type' | 'required' | 'sensitivity' | 'readable_by_ai'>> & {
+        choices: string[] | null;
+    }>;
+    views: {
+        all: string;
+        for_agents: string;
+    };
+}
+export interface WriteOptions {
+    /** Change this record instead of creating one; values not given stay. */
+    id?: string;
+    /** Set a link by its key ('<id>'), or end it (null). */
+    links?: Record<string, string | null>;
+}
 export declare function createClient(options: ClientOptions): AwesomateClient;
 export {};

package/dist/index.js

@@ -7,9 +7,10 @@
  *   const { rows, next } = await db.query('contact', { where: { created_at: { gte: '$YEAR_BEGIN' } }, limit: 50 });
  *
  * The account's token (a hosting PAT with crm:read) is a secret: use it on a server, never in a
- * browser. End-user sign-in for browser apps comes in a later version.
+ * browser. End-user sign-in for browser apps comes in a later version. Writing app data (kinds and
+ * their records) needs crm:write, Support Plus and above.
  */
-export const VERSION = '0.1.0';
+export const VERSION = '0.2.0';
 const DEFAULT_BASE = 'https://hub.awesomate.ai';
 export class AwesomateError extends Error {
     code;
@@ -124,6 +125,25 @@ export class AwesomateClient {
             throw err;
         }
     }
+    /** The app kinds this account has defined. */
+    async kinds() {
+        return (await this.call('GET', '/api/my-crm/v1/kinds')).kinds;
+    }
+    /** Define an app kind (a table an app keeps). No migration: registry rows and generated views. */
+    async defineKind(spec) {
+        return (await this.call('POST', '/api/my-crm/v1/kinds', spec)).kind;
+    }
+    /** Create a record (returns its id), or change one with options.id. Every value is checked against the kind. */
+    async write(kind, data, options = {}) {
+        const r = await this.call('POST', '/api/my-crm/v1/call', {
+            fn: 'write_record', args: { kind, data, links: options.links ?? {}, ...(options.id ? { id: options.id } : {}) },
+        }, false);
+        return r.result.id;
+    }
+    /** Archive a record: it leaves every read and is kept for a restore. */
+    async archive(kind, id) {
+        await this.call('POST', '/api/my-crm/v1/call', { fn: 'archive_record', args: { kind, id } }, false);
+    }
     /** Grouped numbers (counts, sums) in the Business Data API's shape. */
     aggregate(request) {
         return this.call('POST', '/api/my-crm/v1/data/query', request);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@awesomate/sdk",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Read your own Awesomate data from Node: query and page through your contact list with types generated from your fields",
   "license": "MIT",
   "type": "module",