@awesomate/sdk 0.8.0 → 0.9.0

package/README.md

@@ -160,6 +160,22 @@ await app.write('job', { title: 'Gutters' }, { links: { customer: jo.id } });
 
 Name, email and phone only, and nothing the owner marked sensitive. Anyone else is refused.
 
+An attribute can also be visible to some roles only (`awesomate_crm_kinds`, `set_visibility`, for
+example a cost only `staff` see). For everyone else it comes back `null` and a write that sets it
+is refused, whatever the app asks for.
+
+Some things a customer should do without being able to edit the record: accept their quote, say.
+Save it as a write recipe and open it to their role (`awesomate_crm_recipes`, `run_by`, Pro and
+above), then:
+
+```ts
+await app.call('accept_quote', { job: job.id });
+```
+
+The database lets them do exactly the recipe's steps: only its params take their values, every
+other value is fixed, and an existing record must be one they can already read. A recipe not
+opened to their role is "not found".
+
 The rules are kept in your own database, which applies them to every read and write, so a mistake
 in the app cannot show anyone more than their role allows. A disabled person is refused on their
 next call. Sessions are kept in `localStorage`; in a Capacitor app pass `storage` (Preferences) and

package/dist/index.d.ts

@@ -492,6 +492,13 @@ export declare class AwesomateAppClient {
     /** Create a record (returns its id) or change one with options.id, inside the kind's write rule for this user. */
     write<K extends KindName>(kind: K, data: Partial<RowOf<K>> | Record<string, unknown>, options?: WriteOptions): Promise<string>;
     archive<K extends KindName>(kind: K, id: string): Promise<void>;
+    /**
+     * Run a recipe the account opened to this person's role: "accept this quote", something their
+     * write rule would not let them do by hand. Every step commits or none does; a recipe they may
+     * not run reads as not found. Never retried once sent: a write that may have landed is not safe
+     * to send twice (a refused sign-in is, and is retried after a refresh like every data call).
+     */
+    call<R extends RecipeName>(recipe: R, args?: ArgsOf<R>): Promise<RecipeResult>;
     /**
      * Customers by name or email (two characters or more), or by id, so staff can find one and put
      * a record under them. Only for a role the account lets look customers up in this app; anyone

package/dist/index.js

@@ -514,6 +514,15 @@ export class AwesomateAppClient {
     async archive(kind, id) {
         await this.data('POST', '/call', { fn: 'archive_record', args: { kind, id } });
     }
+    /**
+     * Run a recipe the account opened to this person's role: "accept this quote", something their
+     * write rule would not let them do by hand. Every step commits or none does; a recipe they may
+     * not run reads as not found. Never retried once sent: a write that may have landed is not safe
+     * to send twice (a refused sign-in is, and is retried after a refresh like every data call).
+     */
+    async call(recipe, args = {}) {
+        return (await this.data('POST', '/call', { fn: recipe, args })).result;
+    }
     /**
      * Customers by name or email (two characters or more), or by id, so staff can find one and put
      * a record under them. Only for a role the account lets look customers up in this app; anyone

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@awesomate/sdk",
-  "version": "0.8.0",
+  "version": "0.9.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",