@nohead/sdk 0.11.0 → 0.12.0

package/CHANGELOG.md

@@ -5,6 +5,16 @@ Changes to `@nohead/sdk` that you can notice. Versions follow
 releases; a change that could break your code is a major one. Each release's
 section is its GitHub release's notes.
 
+## 0.12.0
+
+- `webhooks.create` and `webhooks.update` take `published_only`, and every
+  webhook has it: a published-only webhook sends only the events that change
+  what a published-only API key reads (a record published, unpublished or
+  edited while live, schema changes, changes to assets that published records
+  use), and skips drafts, schedules and edits to unpublished records.
+- Audit events have `note`: the change note (`Nohead-Change-Note`) a record
+  or schema change was made with, or `null`.
+
 ## 0.11.0
 
 - `records.diff` takes `richText`, and the client's `richText` now applies to

package/README.md

@@ -14,6 +14,8 @@ for await (const post of nohead.records.list("posts", {
 }
 ```
 
+The key is a project API key: create one under **API keys** in the [web app](https://app.nohead.io), with the **Read records** scope for this example, and set it as `NOHEAD_API_KEY` in your app's environment (or pass it as `apiKey`, under [Configuration](#configuration)). The SDK doesn't read the key that `nohead login` saves for the CLI: give your app a key of its own.
+
 > **Status:** 0.x until the Nohead API launches.
 
 ## Contents

package/dist/generated/types.gen.d.ts

@@ -1231,6 +1231,10 @@ export type WebhookProperties = {
      * The subscribed event types and wildcards (`record.*`, or `*` for all).
      */
     event_types: Array<WebhookSubscription>;
+    /**
+     * Send only events that change what a published-only API key can read: a record's change while it is published (or that publishes, unpublishes, deletes or restores it), schema changes, and changes to assets that published records use. Drafts, schedules, history redactions, uploads and purges are never sent. `webhook.test` always is.
+     */
+    published_only: boolean;
     enabled: boolean;
     /**
      * When the webhook was deleted; null unless it is.
@@ -1336,10 +1340,19 @@ export type AuditEvent = {
      * The client the change came through, when known.
      */
     via: null | Via;
+    /**
+     * The change note (`Nohead-Change-Note`) the change was made with,
+     * read from the revision or schema change the event references, so
+     * record and schema events have one when their change did; null
+     * otherwise, and once a revision's history is pruned.
+     *
+     */
+    note: string | null;
     /**
      * Small, action-specific references, e.g. `revision_id` and
      * `collection_id` for record events, `schema_change_id` for schema
-     * events, `changed` attribute names for updates. Never content.
+     * events, `changed` attribute names for updates (field keys for a
+     * draft's). Never content.
      *
      */
     metadata: {
@@ -1363,12 +1376,20 @@ export type WebhookCreate = {
     url: string;
     description?: string | null;
     event_types: Array<WebhookSubscription>;
+    /**
+     * Send only events that change what a published-only API key can read (`false` by default). It can't be combined with event types it never sends, such as `draft.*`.
+     */
+    published_only?: boolean;
     enabled?: boolean;
 };
 export type WebhookUpdate = {
     url?: string;
     description?: string | null;
     event_types?: Array<WebhookSubscription>;
+    /**
+     * Send only events that change what a published-only API key can read (`false` by default). It can't be combined with event types it never sends, such as `draft.*`.
+     */
+    published_only?: boolean;
     enabled?: boolean;
 };
 export type WebhookDeliveryProperties = {

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "0.11.0";
+export declare const VERSION = "0.12.0";

package/dist/version.js

@@ -1 +1 @@
-export const VERSION = "0.11.0";
+export const VERSION = "0.12.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nohead/sdk",
-  "version": "0.11.0",
+  "version": "0.12.0",
   "description": "Official TypeScript SDK for the Nohead API",
   "license": "MIT",
   "homepage": "https://nohead.io",