@stellar-light/api-client 1.0.0 → 1.0.1

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.
Files changed (2) hide show
  1. package/dist/index.d.ts +17 -6
  2. package/package.json +1 -1
package/dist/index.d.ts CHANGED
@@ -64,8 +64,10 @@ interface paths {
64
64
  hackathon?: string;
65
65
  /** @description Filter to SCF-funded projects only */
66
66
  scfAwarded?: boolean;
67
- /** @description Max results returned */
67
+ /** @description Max results returned (per-page) */
68
68
  limit?: components["parameters"]["limit"];
69
+ /** @description Number of matching rows to skip before returning (pagination). Page until offset + meta.counts.returned >= meta.counts.total. */
70
+ offset?: components["parameters"]["offset"];
69
71
  };
70
72
  header?: never;
71
73
  path?: never;
@@ -112,7 +114,7 @@ interface paths {
112
114
  organizer?: string;
113
115
  /** @description Restrict to one feed (curated vs DoraHacks) */
114
116
  source?: "curated" | "dorahacks";
115
- /** @description Max results returned */
117
+ /** @description Max results returned (per-page) */
116
118
  limit?: components["parameters"]["limit"];
117
119
  };
118
120
  header?: never;
@@ -205,7 +207,7 @@ interface paths {
205
207
  get: {
206
208
  parameters: {
207
209
  query: {
208
- /** @description 2–5 hackathon slugs */
210
+ /** @description 2–5 hackathon slugs, comma-separated (?slugs=a,b) */
209
211
  slugs: string[];
210
212
  };
211
213
  header?: never;
@@ -253,8 +255,10 @@ interface paths {
253
255
  skill?: string;
254
256
  /** @description Filter by SCF tier */
255
257
  scfTier?: string;
256
- /** @description Max results returned */
258
+ /** @description Max results returned (per-page) */
257
259
  limit?: components["parameters"]["limit"];
260
+ /** @description Number of matching rows to skip before returning (pagination). Page until offset + meta.counts.returned >= meta.counts.total. */
261
+ offset?: components["parameters"]["offset"];
258
262
  };
259
263
  header?: never;
260
264
  path?: never;
@@ -299,8 +303,10 @@ interface paths {
299
303
  status?: "open" | "closed";
300
304
  /** @description Filter by quarter slug (e.g. 'q1-2026') */
301
305
  quarter?: string;
302
- /** @description Max results returned */
306
+ /** @description Max results returned (per-page) */
303
307
  limit?: components["parameters"]["limit"];
308
+ /** @description Number of matching rows to skip before returning (pagination). Page until offset + meta.counts.returned >= meta.counts.total. */
309
+ offset?: components["parameters"]["offset"];
304
310
  };
305
311
  header?: never;
306
312
  path?: never;
@@ -674,7 +680,10 @@ interface components {
674
680
  [key: string]: unknown;
675
681
  };
676
682
  counts?: {
683
+ /** @description Rows in this page (post limit/offset slice) */
677
684
  returned?: number;
685
+ /** @description Rows matching the filter before slicing (paginated endpoints). Page until offset + returned >= total. */
686
+ total?: number;
678
687
  };
679
688
  };
680
689
  ErrorResponse: {
@@ -772,8 +781,10 @@ interface components {
772
781
  parameters: {
773
782
  /** @description Keyword query (free text) */
774
783
  q: string;
775
- /** @description Max results returned */
784
+ /** @description Max results returned (per-page) */
776
785
  limit: number;
786
+ /** @description Number of matching rows to skip before returning (pagination). Page until offset + meta.counts.returned >= meta.counts.total. */
787
+ offset: number;
777
788
  };
778
789
  requestBodies: never;
779
790
  headers: never;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stellar-light/api-client",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "Typed TypeScript client for the Stellar Scout API — projects, builders, hackathons, SCF, audits, research. Zero dependencies, for autonomous agents and aggregators.",
5
5
  "keywords": [
6
6
  "stellar",