@quizbase/client 0.4.1 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # @quizbase/client
2
2
 
3
- TypeScript SDK for the [QuizBase API](https://quizbase.runriva.com) — multilingual trivia API with 1.4M+ quiz-ready questions blended from 11 open-licensed sources, English and Polish at launch.
3
+ TypeScript SDK for the [QuizBase API](https://quizbase.runriva.com) — a multilingual trivia API. 1.4M+ blended, deduped questions from 11 open datasets (CC, MIT), English and Polish at launch. Per-record license, author, and source on every response.
4
4
 
5
5
  [![npm](https://img.shields.io/npm/v/@quizbase/client.svg)](https://www.npmjs.com/package/@quizbase/client)
6
6
  [![types](https://img.shields.io/npm/types/@quizbase/client.svg)](https://www.npmjs.com/package/@quizbase/client)
package/dist/index.d.cts CHANGED
@@ -857,9 +857,10 @@ interface paths {
857
857
  topic?: string;
858
858
  topics_any?: string;
859
859
  subcategory?: string;
860
- quality?: "high";
860
+ /** @description Quality preset: "high" (default) skips needs_review=true; "all" includes everything */
861
+ quality?: "high" | "all";
861
862
  regions?: string;
862
- source?: "opentdb" | "opentriviaqa" | "mkqa" | "mmlu-prox" | "wikipedia" | "community" | "runriva" | "ai-generated" | "purchased" | "quizbase";
863
+ source?: "arc" | "creak" | "entityq" | "kqa-pro" | "mintaka" | "mkqa" | "nq-open" | "opentdb" | "opentriviaqa" | "qasc" | "quizbase" | "webq";
863
864
  license?: "CC-BY-SA-4.0" | "CC-BY-SA-3.0" | "CC-BY-4.0" | "MIT" | "proprietary";
864
865
  count?: "estimate" | "exact" | "none";
865
866
  };
@@ -958,9 +959,10 @@ interface paths {
958
959
  topic?: string;
959
960
  topics_any?: string;
960
961
  subcategory?: string;
961
- quality?: "high";
962
+ /** @description Quality preset: "high" (default) skips needs_review=true; "all" includes everything */
963
+ quality?: "high" | "all";
962
964
  regions?: string;
963
- source?: "opentdb" | "opentriviaqa" | "mkqa" | "mmlu-prox" | "wikipedia" | "community" | "runriva" | "ai-generated" | "purchased" | "quizbase";
965
+ source?: "arc" | "creak" | "entityq" | "kqa-pro" | "mintaka" | "mkqa" | "nq-open" | "opentdb" | "opentriviaqa" | "qasc" | "quizbase" | "webq";
964
966
  license?: "CC-BY-SA-4.0" | "CC-BY-SA-3.0" | "CC-BY-4.0" | "MIT" | "proprietary";
965
967
  exclude?: string;
966
968
  };
@@ -1213,6 +1215,12 @@ interface components {
1213
1215
  */
1214
1216
  regions: string[];
1215
1217
  attribution: components["schemas"]["Attribution"];
1218
+ /**
1219
+ * @description Quality flag. Present only when the client requested non-default content via `?quality=all` (REST) or `quality: "all"` (MCP) — and always on `/api/v1/questions/{id}` deep-link responses. For default `?quality=high` all returned questions are by definition `high`, so the field is omitted to avoid redundancy. `needs_review` = flagged for moderation review (low-quality distractors, trivial answer-in-question patterns).
1220
+ * @example high
1221
+ * @enum {string}
1222
+ */
1223
+ quality?: "high" | "needs_review";
1216
1224
  /**
1217
1225
  * Format: uuid
1218
1226
  * @description Direct parent (usually English source) when this is a translation.
package/dist/index.d.ts CHANGED
@@ -857,9 +857,10 @@ interface paths {
857
857
  topic?: string;
858
858
  topics_any?: string;
859
859
  subcategory?: string;
860
- quality?: "high";
860
+ /** @description Quality preset: "high" (default) skips needs_review=true; "all" includes everything */
861
+ quality?: "high" | "all";
861
862
  regions?: string;
862
- source?: "opentdb" | "opentriviaqa" | "mkqa" | "mmlu-prox" | "wikipedia" | "community" | "runriva" | "ai-generated" | "purchased" | "quizbase";
863
+ source?: "arc" | "creak" | "entityq" | "kqa-pro" | "mintaka" | "mkqa" | "nq-open" | "opentdb" | "opentriviaqa" | "qasc" | "quizbase" | "webq";
863
864
  license?: "CC-BY-SA-4.0" | "CC-BY-SA-3.0" | "CC-BY-4.0" | "MIT" | "proprietary";
864
865
  count?: "estimate" | "exact" | "none";
865
866
  };
@@ -958,9 +959,10 @@ interface paths {
958
959
  topic?: string;
959
960
  topics_any?: string;
960
961
  subcategory?: string;
961
- quality?: "high";
962
+ /** @description Quality preset: "high" (default) skips needs_review=true; "all" includes everything */
963
+ quality?: "high" | "all";
962
964
  regions?: string;
963
- source?: "opentdb" | "opentriviaqa" | "mkqa" | "mmlu-prox" | "wikipedia" | "community" | "runriva" | "ai-generated" | "purchased" | "quizbase";
965
+ source?: "arc" | "creak" | "entityq" | "kqa-pro" | "mintaka" | "mkqa" | "nq-open" | "opentdb" | "opentriviaqa" | "qasc" | "quizbase" | "webq";
964
966
  license?: "CC-BY-SA-4.0" | "CC-BY-SA-3.0" | "CC-BY-4.0" | "MIT" | "proprietary";
965
967
  exclude?: string;
966
968
  };
@@ -1213,6 +1215,12 @@ interface components {
1213
1215
  */
1214
1216
  regions: string[];
1215
1217
  attribution: components["schemas"]["Attribution"];
1218
+ /**
1219
+ * @description Quality flag. Present only when the client requested non-default content via `?quality=all` (REST) or `quality: "all"` (MCP) — and always on `/api/v1/questions/{id}` deep-link responses. For default `?quality=high` all returned questions are by definition `high`, so the field is omitted to avoid redundancy. `needs_review` = flagged for moderation review (low-quality distractors, trivial answer-in-question patterns).
1220
+ * @example high
1221
+ * @enum {string}
1222
+ */
1223
+ quality?: "high" | "needs_review";
1216
1224
  /**
1217
1225
  * Format: uuid
1218
1226
  * @description Direct parent (usually English source) when this is a translation.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@quizbase/client",
3
- "version": "0.4.1",
3
+ "version": "0.5.0",
4
4
  "description": "TypeScript SDK for QuizBase API — typed client, retry, RFC 9457 errors, telemetry hook. Generated from openapi.json.",
5
5
  "license": "MIT",
6
6
  "author": "Maciej Dzierżek",