fdbck-node 0.1.0 → 0.1.1

package/README.md

@@ -1,11 +1,13 @@
-# @fdbck/node
+# fdbck-node
 
-Official Node.js SDK for [fdbck](https://fdbck.sh) (read feedback) - a simple API to programmatically collect and structure feedback from your users.
+[![npm](https://img.shields.io/npm/v/fdbck-node)](https://www.npmjs.com/package/fdbck-node)
+
+Official Node.js SDK for [fdbck](https://fdbck.sh) — a simple API to programmatically collect and structure feedback from your users.
 
 Full TypeScript definitions included.
 
 ```ts
-import { Fdbck } from '@fdbck/node';
+import { Fdbck } from 'fdbck-node';
 
 const fdbck = new Fdbck('sk_fdbck_...');
 
@@ -37,7 +39,7 @@ console.log(results.data); // [{ respondent: 'user_8f2a', value: 5, ... }]
 ## Install
 
 ```sh
-npm install @fdbck/node
+npm install fdbck-node
 ```
 
 Requires Node.js 18 or later. Zero runtime dependencies.
@@ -72,7 +74,7 @@ Four question types are available:
 
 | Type | Description | Required fields | Response `value` |
 |------|-------------|-----------------|------------------|
-| `yes_no` | Yes or no (options are generated automatically) | — | `true` or `false` |
+| `yes_no` | Yes or no (options default to `["Yes", "No"]`) | — | `"Yes"` or `"No"` |
 | `single_choice` | Pick one option | `options` | `"Option A"` |
 | `multiple_choice` | Pick one or more | `options` | `["Option A", "Option B"]` |
 | `rating` | Numeric scale | `ratingConfig` | `4` |
@@ -92,7 +94,7 @@ const token = await fdbck.tokens.create(question.id, {
 
 Send `token.respondUrl` to your user however you like — email, in-app notification, SMS, etc. They open the link, answer on fdbck's hosted response page, and see a confirmation message. The page does not redirect — if you need to bring users back to your app, include a link in the question text or follow up after you receive the response.
 
-You can also embed the question directly in your app using `@fdbck/react` or `@fdbck/flutter` — pass the `token.token` value to the UI component and it handles submission for you.
+You can also embed the question directly in your app using `fdbck-react` or `fdbck-flutter` — pass the `token.token` value to the UI component and it handles submission for you.
 
 ### 3. Read results
 
@@ -139,7 +141,7 @@ const isValid = fdbck.verifyWebhook(rawBody, signature, webhookSecret);
 `verifyWebhook` is also available as a standalone import if you don't need a client instance:
 
 ```ts
-import { verifyWebhook } from '@fdbck/node';
+import { verifyWebhook } from 'fdbck-node';
 ```
 
 ## API reference
@@ -181,7 +183,7 @@ Returns a single question by ID.
 Returns a paginated list of questions.
 
 ```ts
-const page = await fdbck.questions.list({ status: 'active', limit: 20 });
+const page = await fdbck.questions.list({ status: 'collecting', limit: 20 });
 
 console.log(page.data);                // Question[]
 console.log(page.pagination.hasMore);  // boolean
@@ -190,7 +192,7 @@ console.log(page.pagination.nextCursor); // string | null
 // Fetch the next page
 if (page.pagination.nextCursor) {
   const next = await fdbck.questions.list({
-    status: 'active',
+    status: 'collecting',
     cursor: page.pagination.nextCursor,
   });
 }
@@ -198,7 +200,11 @@ if (page.pagination.nextCursor) {
 
 | Option | Type | Description |
 |--------|------|-------------|
-| `status` | `QuestionStatus` | Filter by `active`, `completed`, `expired`, or `cancelled` |
+| `status` | `QuestionStatus` | Filter by `collecting`, `completed`, `expired`, or `cancelled` |
+| `sort` | `string` | Sort by `created_at` or `updated_at` |
+| `order` | `string` | Sort direction: `asc` or `desc` |
+| `createdAfter` | `string` | ISO 8601 — only return questions created after this time |
+| `createdBefore` | `string` | ISO 8601 — only return questions created before this time |
 | `limit` | `number` | Items per page |
 | `cursor` | `string` | Cursor from a previous page's `pagination.nextCursor` |
 
@@ -209,28 +215,33 @@ Auto-paginates through all questions. Same options as `list` except `cursor`.
 Each page is fetched sequentially as you consume the iterator — there is no prefetching. If you have a large number of questions, be mindful of the number of API calls this produces.
 
 ```ts
-for await (const question of fdbck.questions.listAll({ status: 'active' })) {
+for await (const question of fdbck.questions.listAll({ status: 'collecting' })) {
   console.log(question.id, question.question);
 }
 ```
 
-#### `fdbck.questions.results(id, options?)` → `PaginatedList<ResponseItem>`
+#### `fdbck.questions.results(id, options?)` → `QuestionResultsResponse`
 
-Returns individual responses to a question, paginated.
+Returns aggregated results and individual responses for a question.
 
 ```ts
-const page = await fdbck.questions.results(question.id, { limit: 50 });
+const results = await fdbck.questions.results(question.id, { limit: 50 });
+
+console.log(results.totalResponses); // 142
+console.log(results.results);        // { average: 4.3, distribution: { ... } }
+console.log(results.type);           // 'rating'
+console.log(results.status);         // 'completed'
 
-for (const response of page.data) {
+for (const response of results.data) {
   console.log(response.respondent); // 'user_42' or null
   console.log(response.value);      // answer value (type depends on question type)
   console.log(response.createdAt);  // ISO timestamp
 }
 
 // Next page
-if (page.pagination.hasMore) {
+if (results.pagination.hasMore) {
   const next = await fdbck.questions.results(question.id, {
-    cursor: page.pagination.nextCursor,
+    cursor: results.pagination.nextCursor,
   });
 }
 ```
@@ -241,13 +252,13 @@ Each `ResponseItem` contains:
 |-------|------|-------------|
 | `id` | `string` | Response ID |
 | `questionId` | `string` | Parent question ID |
-| `value` | `unknown` | The answer — `true`/`false` for yes_no, `"Option A"` for single_choice, `["A", "B"]` for multiple_choice, `4` for rating |
+| `value` | `unknown` | The answer — `"Yes"`/`"No"` for yes_no, `"Option A"` for single_choice, `["A", "B"]` for multiple_choice, `4` for rating |
 | `respondent` | `string \| null` | The respondent identifier you passed when creating the token |
 | `createdAt` | `string` | ISO timestamp |
 
-#### `fdbck.questions.cancel(id)` → `void`
+#### `fdbck.questions.cancel(id)` → `Question`
 
-Cancels a question. It stops accepting responses immediately.
+Cancels a question and returns the cancelled question. It stops accepting responses immediately.
 
 #### `fdbck.questions.webhooks(id, options?)` → `PaginatedList<WebhookDelivery>`
 
@@ -273,14 +284,14 @@ token.expiresAt;  // ISO timestamp (1 hour from creation)
 
 ```ts
 const info = await fdbck.me();
-// info.organization → { id, name, plan }
-// info.usage → { responsesUsed, responsesLimit }
+// info.user         → { id, email, name, avatarUrl }
+// info.organization → { id, name, slug, plan, role, responsesUsed, responsesLimit, ... }
 ```
 
 ## Error handling
 
 ```ts
-import { FdbckApiError, FdbckNetworkError } from '@fdbck/node';
+import { FdbckApiError, FdbckNetworkError } from 'fdbck-node';
 
 try {
   await fdbck.questions.create({ ... });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fdbck-node",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Official Node.js SDK for the fdbck API",
   "license": "MIT",
   "author": "fdbck",