@productcraft/social 1.0.2 → 1.0.3

package/README.md

@@ -21,7 +21,7 @@ The customer backend acts on behalf of one of its EndUsers via the `X-Acting-As`
 
 ## Quick start — create a community (admin)
 
-```ts
+```ts before
 import { Social } from "@productcraft/social";
 
 // Reads PRODUCTCRAFT_API_KEY from the environment
@@ -38,7 +38,7 @@ const { data, error } = await social.client.POST(
 
 ## Quick start — post on behalf of an EndUser (customer backend)
 
-```ts
+```ts before
 const actor_id = "<actor-uuid>"; // the EndUser's Social actor id
 
 const { data, error } = await social.client.POST(
@@ -66,7 +66,7 @@ Social's wire is snake_case both at the DTO level and in TS types — there's no
 
 1.0 renames every **path parameter** to snake_case, to match the rest of the ProductCraft APIs: `{communityId}` is now `{community_id}`, `{actorId}` is `{actor_id}`, `{srcActorId}` is `{src_actor_id}`, and so on. Request URLs are unchanged, so nothing breaks at runtime; the change is in the TypeScript path keys and in `params.path`:
 
-```ts
+```ts before
 // 0.x
 await social.client.GET("/v1/communities/{communityId}/posts/{postId}", {
   params: { path: { communityId, postId } },
@@ -95,7 +95,7 @@ PRODUCTCRAFT_API_KEY=pcft_live_...
 
 ## Configuration
 
-```ts
+```ts before
 new Social({
   // Omit to use PRODUCTCRAFT_API_KEY from the environment
   auth: { type: "apiKey", key: "pcft_live_..." }
@@ -110,7 +110,7 @@ new Social({
 
 ### Posts + feeds
 
-```ts
+```ts before
 // Create a post
 await social.client.POST(
   "/v1/communities/{community_id}/posts",
@@ -134,7 +134,7 @@ await social.client.GET(
 
 ### Stories
 
-```ts
+```ts before
 // Post a story (24h TTL)
 await social.client.POST(
   "/v1/communities/{community_id}/stories",
@@ -150,7 +150,7 @@ await social.client.GET(
 
 ### Social graph
 
-```ts
+```ts before
 // Follow / unfollow
 await social.client.PUT(
   "/v1/communities/{community_id}/follows/{src_actor_id}/{dst_actor_id}",
@@ -163,7 +163,7 @@ await social.client.PUT(
 
 ### Notifications
 
-```ts
+```ts before
 // List
 await social.client.GET(
   "/v1/communities/{community_id}/actors/{actor_id}/notifications",
@@ -185,7 +185,7 @@ await social.client.POST(
 
 ### Direct conversations
 
-```ts
+```ts before
 // Start / open a conversation
 await social.client.POST(
   "/v1/communities/{community_id}/conversations",
@@ -201,7 +201,7 @@ await social.client.POST(
 
 ### Moderation (workspace admin)
 
-```ts
+```ts before
 // List flags
 await social.client.GET(
   "/v1/workspaces/{workspace_id}/communities/{community_id}/moderation/flags",

package/dist/index.d.cts

@@ -2171,7 +2171,10 @@ interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Get one webhook endpoint (without its secret). */
+        /**
+         * Get one webhook endpoint (without its secret).
+         * @description The endpoint's URL, subscription, on/off state, failure streak and the last 4 characters of its signing secret. The full secret is only returned when the endpoint is created or its secret is rotated.
+         */
         get: operations["WebhooksController_social_community_getEndpoint"];
         put?: never;
         post?: never;
@@ -2276,7 +2279,10 @@ interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Get one webhook event with every delivery attempt. */
+        /**
+         * Get one webhook event with every delivery attempt.
+         * @description The event as it was sent (`type`, `data`) and every delivery attempt to every endpoint, with its trigger, HTTP status, error and the start of the response body. Use it to debug a receiver, then `replay` to send it again.
+         */
         get: operations["WebhooksController_social_community_getEvent"];
         put?: never;
         post?: never;
@@ -2733,7 +2739,10 @@ interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Get one webhook endpoint (without its secret). */
+        /**
+         * Get one webhook endpoint (without its secret).
+         * @description The endpoint's URL, subscription, on/off state, failure streak and the last 4 characters of its signing secret. The full secret is only returned when the endpoint is created or its secret is rotated.
+         */
         get: operations["WebhooksController_social_workspace_community_getEndpoint"];
         put?: never;
         post?: never;
@@ -2838,7 +2847,10 @@ interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Get one webhook event with every delivery attempt. */
+        /**
+         * Get one webhook event with every delivery attempt.
+         * @description The event as it was sent (`type`, `data`) and every delivery attempt to every endpoint, with its trigger, HTTP status, error and the start of the response body. Use it to debug a receiver, then `replay` to send it again.
+         */
         get: operations["WebhooksController_social_workspace_community_getEvent"];
         put?: never;
         post?: never;
@@ -2923,7 +2935,10 @@ interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Get one webhook endpoint (without its secret). */
+        /**
+         * Get one webhook endpoint (without its secret).
+         * @description The endpoint's URL, subscription, on/off state, failure streak and the last 4 characters of its signing secret. The full secret is only returned when the endpoint is created or its secret is rotated.
+         */
         get: operations["WebhooksController_social_workspace_getEndpoint"];
         put?: never;
         post?: never;
@@ -3028,7 +3043,10 @@ interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Get one webhook event with every delivery attempt. */
+        /**
+         * Get one webhook event with every delivery attempt.
+         * @description The event as it was sent (`type`, `data`) and every delivery attempt to every endpoint, with its trigger, HTTP status, error and the start of the response body. Use it to debug a receiver, then `replay` to send it again.
+         */
         get: operations["WebhooksController_social_workspace_getEvent"];
         put?: never;
         post?: never;
@@ -4710,8 +4728,9 @@ interface components {
              */
             description?: string | null;
             /**
-             * @description Create it switched off.
+             * @description Send `false` to create it switched off.
              * @default true
+             * @example true
              */
             enabled: boolean;
             /**
@@ -6604,6 +6623,7 @@ interface components {
             /**
              * @description Hours the previous secret keeps signing too (0 ends it now).
              * @default 24
+             * @example 24
              */
             grace_hours: number;
         };
@@ -7009,11 +7029,23 @@ interface components {
             url?: string;
         };
         UpdateWebhookEndpointDto: {
-            /** @description A new label; null clears it. */
+            /**
+             * @description A new label; null clears it.
+             * @example Production receiver
+             */
             description?: string | null;
-            /** @description Switch it on or off. Switching on also clears an automatic disable. */
+            /**
+             * @description Switch it on or off. Switching on also clears an automatic disable.
+             * @example true
+             */
             enabled?: boolean;
-            /** @description Replaces the subscription. Event types from `GET …/webhooks/event-types`. Empty or omitted means every event, including types added later. */
+            /**
+             * @description Replaces the subscription. Event types from `GET …/webhooks/event-types`. Empty or omitted means every event, including types added later.
+             * @example [
+             *       "post.created",
+             *       "post.updated"
+             *     ]
+             */
             event_types?: ("post.created" | "post.updated" | "post.deleted" | "post.reaction.created" | "repost.created" | "comment.created" | "comment.updated" | "comment.deleted" | "comment.reaction.created" | "edge.follow.created" | "edge.follow.deleted" | "edge.follow.requested" | "edge.follow.request_approved" | "flag.created" | "flag.updated" | "moderation.action.applied" | "actor.updated" | "dm.message.created" | "tag.created" | "asset.ready" | "asset.failed")[];
             /**
              * Format: uri

package/dist/index.d.ts

@@ -2171,7 +2171,10 @@ interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Get one webhook endpoint (without its secret). */
+        /**
+         * Get one webhook endpoint (without its secret).
+         * @description The endpoint's URL, subscription, on/off state, failure streak and the last 4 characters of its signing secret. The full secret is only returned when the endpoint is created or its secret is rotated.
+         */
         get: operations["WebhooksController_social_community_getEndpoint"];
         put?: never;
         post?: never;
@@ -2276,7 +2279,10 @@ interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Get one webhook event with every delivery attempt. */
+        /**
+         * Get one webhook event with every delivery attempt.
+         * @description The event as it was sent (`type`, `data`) and every delivery attempt to every endpoint, with its trigger, HTTP status, error and the start of the response body. Use it to debug a receiver, then `replay` to send it again.
+         */
         get: operations["WebhooksController_social_community_getEvent"];
         put?: never;
         post?: never;
@@ -2733,7 +2739,10 @@ interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Get one webhook endpoint (without its secret). */
+        /**
+         * Get one webhook endpoint (without its secret).
+         * @description The endpoint's URL, subscription, on/off state, failure streak and the last 4 characters of its signing secret. The full secret is only returned when the endpoint is created or its secret is rotated.
+         */
         get: operations["WebhooksController_social_workspace_community_getEndpoint"];
         put?: never;
         post?: never;
@@ -2838,7 +2847,10 @@ interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Get one webhook event with every delivery attempt. */
+        /**
+         * Get one webhook event with every delivery attempt.
+         * @description The event as it was sent (`type`, `data`) and every delivery attempt to every endpoint, with its trigger, HTTP status, error and the start of the response body. Use it to debug a receiver, then `replay` to send it again.
+         */
         get: operations["WebhooksController_social_workspace_community_getEvent"];
         put?: never;
         post?: never;
@@ -2923,7 +2935,10 @@ interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Get one webhook endpoint (without its secret). */
+        /**
+         * Get one webhook endpoint (without its secret).
+         * @description The endpoint's URL, subscription, on/off state, failure streak and the last 4 characters of its signing secret. The full secret is only returned when the endpoint is created or its secret is rotated.
+         */
         get: operations["WebhooksController_social_workspace_getEndpoint"];
         put?: never;
         post?: never;
@@ -3028,7 +3043,10 @@ interface paths {
             path?: never;
             cookie?: never;
         };
-        /** Get one webhook event with every delivery attempt. */
+        /**
+         * Get one webhook event with every delivery attempt.
+         * @description The event as it was sent (`type`, `data`) and every delivery attempt to every endpoint, with its trigger, HTTP status, error and the start of the response body. Use it to debug a receiver, then `replay` to send it again.
+         */
         get: operations["WebhooksController_social_workspace_getEvent"];
         put?: never;
         post?: never;
@@ -4710,8 +4728,9 @@ interface components {
              */
             description?: string | null;
             /**
-             * @description Create it switched off.
+             * @description Send `false` to create it switched off.
              * @default true
+             * @example true
              */
             enabled: boolean;
             /**
@@ -6604,6 +6623,7 @@ interface components {
             /**
              * @description Hours the previous secret keeps signing too (0 ends it now).
              * @default 24
+             * @example 24
              */
             grace_hours: number;
         };
@@ -7009,11 +7029,23 @@ interface components {
             url?: string;
         };
         UpdateWebhookEndpointDto: {
-            /** @description A new label; null clears it. */
+            /**
+             * @description A new label; null clears it.
+             * @example Production receiver
+             */
             description?: string | null;
-            /** @description Switch it on or off. Switching on also clears an automatic disable. */
+            /**
+             * @description Switch it on or off. Switching on also clears an automatic disable.
+             * @example true
+             */
             enabled?: boolean;
-            /** @description Replaces the subscription. Event types from `GET …/webhooks/event-types`. Empty or omitted means every event, including types added later. */
+            /**
+             * @description Replaces the subscription. Event types from `GET …/webhooks/event-types`. Empty or omitted means every event, including types added later.
+             * @example [
+             *       "post.created",
+             *       "post.updated"
+             *     ]
+             */
             event_types?: ("post.created" | "post.updated" | "post.deleted" | "post.reaction.created" | "repost.created" | "comment.created" | "comment.updated" | "comment.deleted" | "comment.reaction.created" | "edge.follow.created" | "edge.follow.deleted" | "edge.follow.requested" | "edge.follow.request_approved" | "flag.created" | "flag.updated" | "moderation.action.applied" | "actor.updated" | "dm.message.created" | "tag.created" | "asset.ready" | "asset.failed")[];
             /**
              * Format: uri

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@productcraft/social",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Social-as-a-service backend — communities, posts, ranked feeds, stories, direct conversations, notifications, moderation, flags via ProductCraft Social. Generated from the production OpenAPI spec.",
   "type": "module",
   "main": "./dist/index.cjs",