@quizbase/client 0.7.0 → 0.9.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/dist/index.d.cts CHANGED
@@ -606,7 +606,7 @@ interface paths {
606
606
  };
607
607
  /**
608
608
  * List region codes (cultural affinity)
609
- * @description Discovery dla `regions` filter. **Cultural affinity** — pytanie ma code regionu, jeśli mieszkańcy kraju lub członkowie grupy kulturowej/religijnej są statystycznie częściej w stanie odpowiedzieć (NIE geografia tematu pytania). Lowercase ISO 3166-1 alpha-2 (`us`, `pl`, `gb`) + cultural codes (`jewish`, `christian-catholic`, `islam` — LLM schema whitelist parity). Sourced z `mv_region_counts` (pre-aggregated TABLE). Cardinality ~150 distinct codes per language.
609
+ * @description Discovery dla `regions` filter. **Cultural affinity** — pytanie ma code regionu, jeśli mieszkańcy kraju lub członkowie grupy kulturowej/religijnej są statystycznie częściej w stanie odpowiedzieć (NIE geografia tematu pytania). Lowercase ISO 3166-1 alpha-2 (`us`, `pl`, `gb`) + cultural codes (`jewish`, `christian-catholic`, `islam` — LLM schema whitelist parity). Sourced from a pre-aggregated table. Cardinality ~150 distinct codes per language.
610
610
  */
611
611
  get: {
612
612
  parameters: {
@@ -939,13 +939,13 @@ interface paths {
939
939
  topic?: string;
940
940
  topics_any?: string;
941
941
  subcategory?: string;
942
- /** @description Quality preset: "high" (default) skips needs_review=true; "all" includes everything */
942
+ /** @description Quality preset: "high" (default) skips questions flagged for review; "all" includes everything */
943
943
  quality?: "high" | "all";
944
944
  /** @description Cultural affinity codes. A question is tagged with a region if residents of that country, or members of that cultural/religious group, are statistically more likely to know the answer (NOT geography of the subject). Lowercase ISO 3166-1 alpha-2 (e.g. `us`, `pl`, `gb`) plus cultural codes (`jewish`, `christian-catholic`, `islam`). AND-logic. Empty array on a question = universally accessible (no cultural advantage). Discover via `GET /api/v1/regions`. Uppercase tolerated on input (normalized to lowercase). */
945
945
  regions?: string;
946
946
  source?: "arc" | "creak" | "entityq" | "kqa-pro" | "mintaka" | "mkqa" | "nq-open" | "opentdb" | "opentriviaqa" | "qasc" | "quizbase" | "webq";
947
947
  license?: "CC-BY-SA-4.0" | "CC-BY-SA-3.0" | "CC-BY-4.0" | "MIT" | "proprietary";
948
- count?: "estimate" | "exact" | "none";
948
+ count?: "exact" | "none";
949
949
  };
950
950
  header?: never;
951
951
  path?: never;
@@ -1042,7 +1042,7 @@ interface paths {
1042
1042
  topic?: string;
1043
1043
  topics_any?: string;
1044
1044
  subcategory?: string;
1045
- /** @description Quality preset: "high" (default) skips needs_review=true; "all" includes everything */
1045
+ /** @description Quality preset: "high" (default) skips questions flagged for review; "all" includes everything */
1046
1046
  quality?: "high" | "all";
1047
1047
  /** @description Cultural affinity codes. A question is tagged with a region if residents of that country, or members of that cultural/religious group, are statistically more likely to know the answer (NOT geography of the subject). Lowercase ISO 3166-1 alpha-2 (e.g. `us`, `pl`, `gb`) plus cultural codes (`jewish`, `christian-catholic`, `islam`). AND-logic. Empty array on a question = universally accessible (no cultural advantage). Discover via `GET /api/v1/regions`. Uppercase tolerated on input (normalized to lowercase). */
1048
1048
  regions?: string;
@@ -1458,7 +1458,7 @@ interface components {
1458
1458
  /** @example 146384 */
1459
1459
  count: number;
1460
1460
  };
1461
- /** @description Difficulty distribution across 5 LLM-calibrated levels (Plan 121) plus `unrated` for pre-rescore records. */
1461
+ /** @description Difficulty distribution across 5 LLM-calibrated levels plus `unrated` for records not yet LLM-rated. */
1462
1462
  StatsByDifficulty: {
1463
1463
  /** @example 12480 */
1464
1464
  trivial: number;
@@ -1489,7 +1489,7 @@ interface components {
1489
1489
  /** @example 15281 */
1490
1490
  count: number;
1491
1491
  };
1492
- /** @description Top regions by cultural affinity (Plan 120). Code = ISO 3166-1 alpha-2 or cultural identifier; not a geographic filter — indicates "person from this region has higher statistical chance to answer correctly". */
1492
+ /** @description Top regions by cultural affinity. Code = ISO 3166-1 alpha-2 or cultural identifier; not a geographic filter — indicates "person from this region has higher statistical chance to answer correctly". */
1493
1493
  StatsTopRegions: {
1494
1494
  /** @example us */
1495
1495
  code: string;
@@ -1498,7 +1498,7 @@ interface components {
1498
1498
  /** @example 309090 */
1499
1499
  count: number;
1500
1500
  }[];
1501
- /** @description Counts of records eligible for `?quality=high` filter (Plan 121: needs_review=false AND content_grade != 0) per language. */
1501
+ /** @description Counts of records eligible for the `?quality=high` filter per language. */
1502
1502
  StatsByQualityHigh: {
1503
1503
  /** @example 329266 */
1504
1504
  en: number;
@@ -1885,21 +1885,16 @@ interface components {
1885
1885
  */
1886
1886
  count: number;
1887
1887
  /**
1888
- * @description Total matching items (when `count=exact`).
1889
- * @example 1294009
1890
- */
1891
- total?: number;
1892
- /**
1893
- * @description Planner-estimated total (default `count=estimate`).
1888
+ * @description Exact count of matching questions. Present only when `count=exact`. Omitted by default — page via cursor + `_links.next`.
1894
1889
  * @example 545379
1895
1890
  */
1896
- totalEstimate?: number;
1891
+ total?: number;
1897
1892
  /**
1898
1893
  * @description Echo of the `count` query param.
1899
- * @example estimate
1894
+ * @example none
1900
1895
  * @enum {string}
1901
1896
  */
1902
- countMode?: "estimate" | "exact" | "none";
1897
+ countMode?: "exact" | "none";
1903
1898
  /**
1904
1899
  * @description Language of the response content.
1905
1900
  * @example en
package/dist/index.d.ts CHANGED
@@ -606,7 +606,7 @@ interface paths {
606
606
  };
607
607
  /**
608
608
  * List region codes (cultural affinity)
609
- * @description Discovery dla `regions` filter. **Cultural affinity** — pytanie ma code regionu, jeśli mieszkańcy kraju lub członkowie grupy kulturowej/religijnej są statystycznie częściej w stanie odpowiedzieć (NIE geografia tematu pytania). Lowercase ISO 3166-1 alpha-2 (`us`, `pl`, `gb`) + cultural codes (`jewish`, `christian-catholic`, `islam` — LLM schema whitelist parity). Sourced z `mv_region_counts` (pre-aggregated TABLE). Cardinality ~150 distinct codes per language.
609
+ * @description Discovery dla `regions` filter. **Cultural affinity** — pytanie ma code regionu, jeśli mieszkańcy kraju lub członkowie grupy kulturowej/religijnej są statystycznie częściej w stanie odpowiedzieć (NIE geografia tematu pytania). Lowercase ISO 3166-1 alpha-2 (`us`, `pl`, `gb`) + cultural codes (`jewish`, `christian-catholic`, `islam` — LLM schema whitelist parity). Sourced from a pre-aggregated table. Cardinality ~150 distinct codes per language.
610
610
  */
611
611
  get: {
612
612
  parameters: {
@@ -939,13 +939,13 @@ interface paths {
939
939
  topic?: string;
940
940
  topics_any?: string;
941
941
  subcategory?: string;
942
- /** @description Quality preset: "high" (default) skips needs_review=true; "all" includes everything */
942
+ /** @description Quality preset: "high" (default) skips questions flagged for review; "all" includes everything */
943
943
  quality?: "high" | "all";
944
944
  /** @description Cultural affinity codes. A question is tagged with a region if residents of that country, or members of that cultural/religious group, are statistically more likely to know the answer (NOT geography of the subject). Lowercase ISO 3166-1 alpha-2 (e.g. `us`, `pl`, `gb`) plus cultural codes (`jewish`, `christian-catholic`, `islam`). AND-logic. Empty array on a question = universally accessible (no cultural advantage). Discover via `GET /api/v1/regions`. Uppercase tolerated on input (normalized to lowercase). */
945
945
  regions?: string;
946
946
  source?: "arc" | "creak" | "entityq" | "kqa-pro" | "mintaka" | "mkqa" | "nq-open" | "opentdb" | "opentriviaqa" | "qasc" | "quizbase" | "webq";
947
947
  license?: "CC-BY-SA-4.0" | "CC-BY-SA-3.0" | "CC-BY-4.0" | "MIT" | "proprietary";
948
- count?: "estimate" | "exact" | "none";
948
+ count?: "exact" | "none";
949
949
  };
950
950
  header?: never;
951
951
  path?: never;
@@ -1042,7 +1042,7 @@ interface paths {
1042
1042
  topic?: string;
1043
1043
  topics_any?: string;
1044
1044
  subcategory?: string;
1045
- /** @description Quality preset: "high" (default) skips needs_review=true; "all" includes everything */
1045
+ /** @description Quality preset: "high" (default) skips questions flagged for review; "all" includes everything */
1046
1046
  quality?: "high" | "all";
1047
1047
  /** @description Cultural affinity codes. A question is tagged with a region if residents of that country, or members of that cultural/religious group, are statistically more likely to know the answer (NOT geography of the subject). Lowercase ISO 3166-1 alpha-2 (e.g. `us`, `pl`, `gb`) plus cultural codes (`jewish`, `christian-catholic`, `islam`). AND-logic. Empty array on a question = universally accessible (no cultural advantage). Discover via `GET /api/v1/regions`. Uppercase tolerated on input (normalized to lowercase). */
1048
1048
  regions?: string;
@@ -1458,7 +1458,7 @@ interface components {
1458
1458
  /** @example 146384 */
1459
1459
  count: number;
1460
1460
  };
1461
- /** @description Difficulty distribution across 5 LLM-calibrated levels (Plan 121) plus `unrated` for pre-rescore records. */
1461
+ /** @description Difficulty distribution across 5 LLM-calibrated levels plus `unrated` for records not yet LLM-rated. */
1462
1462
  StatsByDifficulty: {
1463
1463
  /** @example 12480 */
1464
1464
  trivial: number;
@@ -1489,7 +1489,7 @@ interface components {
1489
1489
  /** @example 15281 */
1490
1490
  count: number;
1491
1491
  };
1492
- /** @description Top regions by cultural affinity (Plan 120). Code = ISO 3166-1 alpha-2 or cultural identifier; not a geographic filter — indicates "person from this region has higher statistical chance to answer correctly". */
1492
+ /** @description Top regions by cultural affinity. Code = ISO 3166-1 alpha-2 or cultural identifier; not a geographic filter — indicates "person from this region has higher statistical chance to answer correctly". */
1493
1493
  StatsTopRegions: {
1494
1494
  /** @example us */
1495
1495
  code: string;
@@ -1498,7 +1498,7 @@ interface components {
1498
1498
  /** @example 309090 */
1499
1499
  count: number;
1500
1500
  }[];
1501
- /** @description Counts of records eligible for `?quality=high` filter (Plan 121: needs_review=false AND content_grade != 0) per language. */
1501
+ /** @description Counts of records eligible for the `?quality=high` filter per language. */
1502
1502
  StatsByQualityHigh: {
1503
1503
  /** @example 329266 */
1504
1504
  en: number;
@@ -1885,21 +1885,16 @@ interface components {
1885
1885
  */
1886
1886
  count: number;
1887
1887
  /**
1888
- * @description Total matching items (when `count=exact`).
1889
- * @example 1294009
1890
- */
1891
- total?: number;
1892
- /**
1893
- * @description Planner-estimated total (default `count=estimate`).
1888
+ * @description Exact count of matching questions. Present only when `count=exact`. Omitted by default — page via cursor + `_links.next`.
1894
1889
  * @example 545379
1895
1890
  */
1896
- totalEstimate?: number;
1891
+ total?: number;
1897
1892
  /**
1898
1893
  * @description Echo of the `count` query param.
1899
- * @example estimate
1894
+ * @example none
1900
1895
  * @enum {string}
1901
1896
  */
1902
- countMode?: "estimate" | "exact" | "none";
1897
+ countMode?: "exact" | "none";
1903
1898
  /**
1904
1899
  * @description Language of the response content.
1905
1900
  * @example en
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@quizbase/client",
3
- "version": "0.7.0",
3
+ "version": "0.9.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",