@arke-institute/sdk 2.3.2 → 2.3.3

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.
@@ -6,7 +6,7 @@
6
6
  *
7
7
  * Source: Arke v1 API
8
8
  * Version: 1.0.0
9
- * Generated: 2026-01-04T16:48:55.356Z
9
+ * Generated: 2026-01-04T18:00:08.698Z
10
10
  */
11
11
  type paths = {
12
12
  "/auth/register": {
@@ -4936,12 +4936,17 @@ type paths = {
4936
4936
  * @description Returns a cursor-based list of entity change events for client synchronization.
4937
4937
  *
4938
4938
  * **Usage:**
4939
- * - Start with `?after=0` to get all events
4940
- * - Use the returned `cursor` as `?after=` for the next page
4941
- * - Poll periodically (e.g., every 10s) to stay in sync
4939
+ * - Call without cursor to get newest events
4940
+ * - Use returned `cursor` as `?cursor=` to get older events
4941
+ * - Poll without cursor periodically to check for new events
4942
+ *
4943
+ * **Sync flow:**
4944
+ * 1. Initial: `GET /events` → get newest, save highest `id` as high-water mark
4945
+ * 2. Paginate: `GET /events?cursor=X` → get older events until `has_more=false`
4946
+ * 3. Poll: `GET /events` → if newest `id` > high-water mark, process new events
4942
4947
  *
4943
4948
  * **Event data:**
4944
- * - `id`: Auto-increment ID (use as cursor)
4949
+ * - `id`: Auto-increment ID
4945
4950
  * - `pi`: Entity ID that changed
4946
4951
  * - `cid`: New manifest CID
4947
4952
  * - `ts`: ISO timestamp
@@ -4951,8 +4956,8 @@ type paths = {
4951
4956
  get: {
4952
4957
  parameters: {
4953
4958
  query?: {
4954
- /** @description Return events with id > after (cursor for pagination) */
4955
- after?: number | null;
4959
+ /** @description Return events older than this id (from previous response cursor) */
4960
+ cursor?: number;
4956
4961
  /** @description Maximum number of events to return (default: 100, max: 1000) */
4957
4962
  limit?: number;
4958
4963
  /** @description Network to query (default: main) */
@@ -7093,16 +7098,16 @@ type components = {
7093
7098
  ts: string;
7094
7099
  };
7095
7100
  EventsListResponse: {
7096
- /** @description List of events */
7101
+ /** @description List of events (newest first) */
7097
7102
  events: components["schemas"]["Event"][];
7098
7103
  /**
7099
- * @description Whether there are more events available
7104
+ * @description Whether there are more (older) events available
7100
7105
  * @example true
7101
7106
  */
7102
7107
  has_more: boolean;
7103
7108
  /**
7104
- * @description Cursor for the next page (pass as ?after= parameter)
7105
- * @example 12347
7109
+ * @description Cursor for the next page (oldest id in batch, pass as ?cursor= for older events)
7110
+ * @example 12340
7106
7111
  */
7107
7112
  cursor: number;
7108
7113
  };
@@ -6,7 +6,7 @@
6
6
  *
7
7
  * Source: Arke v1 API
8
8
  * Version: 1.0.0
9
- * Generated: 2026-01-04T16:48:55.356Z
9
+ * Generated: 2026-01-04T18:00:08.698Z
10
10
  */
11
11
  type paths = {
12
12
  "/auth/register": {
@@ -4936,12 +4936,17 @@ type paths = {
4936
4936
  * @description Returns a cursor-based list of entity change events for client synchronization.
4937
4937
  *
4938
4938
  * **Usage:**
4939
- * - Start with `?after=0` to get all events
4940
- * - Use the returned `cursor` as `?after=` for the next page
4941
- * - Poll periodically (e.g., every 10s) to stay in sync
4939
+ * - Call without cursor to get newest events
4940
+ * - Use returned `cursor` as `?cursor=` to get older events
4941
+ * - Poll without cursor periodically to check for new events
4942
+ *
4943
+ * **Sync flow:**
4944
+ * 1. Initial: `GET /events` → get newest, save highest `id` as high-water mark
4945
+ * 2. Paginate: `GET /events?cursor=X` → get older events until `has_more=false`
4946
+ * 3. Poll: `GET /events` → if newest `id` > high-water mark, process new events
4942
4947
  *
4943
4948
  * **Event data:**
4944
- * - `id`: Auto-increment ID (use as cursor)
4949
+ * - `id`: Auto-increment ID
4945
4950
  * - `pi`: Entity ID that changed
4946
4951
  * - `cid`: New manifest CID
4947
4952
  * - `ts`: ISO timestamp
@@ -4951,8 +4956,8 @@ type paths = {
4951
4956
  get: {
4952
4957
  parameters: {
4953
4958
  query?: {
4954
- /** @description Return events with id > after (cursor for pagination) */
4955
- after?: number | null;
4959
+ /** @description Return events older than this id (from previous response cursor) */
4960
+ cursor?: number;
4956
4961
  /** @description Maximum number of events to return (default: 100, max: 1000) */
4957
4962
  limit?: number;
4958
4963
  /** @description Network to query (default: main) */
@@ -7093,16 +7098,16 @@ type components = {
7093
7098
  ts: string;
7094
7099
  };
7095
7100
  EventsListResponse: {
7096
- /** @description List of events */
7101
+ /** @description List of events (newest first) */
7097
7102
  events: components["schemas"]["Event"][];
7098
7103
  /**
7099
- * @description Whether there are more events available
7104
+ * @description Whether there are more (older) events available
7100
7105
  * @example true
7101
7106
  */
7102
7107
  has_more: boolean;
7103
7108
  /**
7104
- * @description Cursor for the next page (pass as ?after= parameter)
7105
- * @example 12347
7109
+ * @description Cursor for the next page (oldest id in batch, pass as ?cursor= for older events)
7110
+ * @example 12340
7106
7111
  */
7107
7112
  cursor: number;
7108
7113
  };
package/openapi/spec.json CHANGED
@@ -4448,17 +4448,17 @@
4448
4448
  "items": {
4449
4449
  "$ref": "#/components/schemas/Event"
4450
4450
  },
4451
- "description": "List of events"
4451
+ "description": "List of events (newest first)"
4452
4452
  },
4453
4453
  "has_more": {
4454
4454
  "type": "boolean",
4455
- "description": "Whether there are more events available",
4455
+ "description": "Whether there are more (older) events available",
4456
4456
  "example": true
4457
4457
  },
4458
4458
  "cursor": {
4459
4459
  "type": "integer",
4460
- "description": "Cursor for the next page (pass as ?after= parameter)",
4461
- "example": 12347
4460
+ "description": "Cursor for the next page (oldest id in batch, pass as ?cursor= for older events)",
4461
+ "example": 12340
4462
4462
  }
4463
4463
  },
4464
4464
  "required": [
@@ -9325,20 +9325,19 @@
9325
9325
  "Events"
9326
9326
  ],
9327
9327
  "summary": "List entity change events",
9328
- "description": "Returns a cursor-based list of entity change events for client synchronization.\n\n**Usage:**\n- Start with `?after=0` to get all events\n- Use the returned `cursor` as `?after=` for the next page\n- Poll periodically (e.g., every 10s) to stay in sync\n\n**Event data:**\n- `id`: Auto-increment ID (use as cursor)\n- `pi`: Entity ID that changed\n- `cid`: New manifest CID\n- `ts`: ISO timestamp\n\nEvents are ephemeral (30-day rolling window) - for full sync, use snapshots.",
9328
+ "description": "Returns a cursor-based list of entity change events for client synchronization.\n\n**Usage:**\n- Call without cursor to get newest events\n- Use returned `cursor` as `?cursor=` to get older events\n- Poll without cursor periodically to check for new events\n\n**Sync flow:**\n1. Initial: `GET /events` get newest, save highest `id` as high-water mark\n2. Paginate: `GET /events?cursor=X` → get older events until `has_more=false`\n3. Poll: `GET /events` → if newest `id` > high-water mark, process new events\n\n**Event data:**\n- `id`: Auto-increment ID\n- `pi`: Entity ID that changed\n- `cid`: New manifest CID\n- `ts`: ISO timestamp\n\nEvents are ephemeral (30-day rolling window) - for full sync, use snapshots.",
9329
9329
  "x-arke-action": "events:list",
9330
9330
  "x-arke-auth": "none",
9331
9331
  "parameters": [
9332
9332
  {
9333
9333
  "schema": {
9334
9334
  "type": "integer",
9335
- "nullable": true,
9336
- "minimum": 0,
9335
+ "minimum": 1,
9337
9336
  "example": 12345
9338
9337
  },
9339
9338
  "required": false,
9340
- "description": "Return events with id > after (cursor for pagination)",
9341
- "name": "after",
9339
+ "description": "Return events older than this id (from previous response cursor)",
9340
+ "name": "cursor",
9342
9341
  "in": "query"
9343
9342
  },
9344
9343
  {
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "specVersion": "1.0.0",
3
3
  "apiVersion": "1.0.0",
4
- "fetchedAt": "2026-01-04T16:48:54.559Z",
4
+ "fetchedAt": "2026-01-04T18:00:07.945Z",
5
5
  "sourceUrl": "https://arke-v1.arke.institute/openapi.json",
6
6
  "openApiVersion": "3.1.0"
7
7
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@arke-institute/sdk",
3
- "version": "2.3.2",
3
+ "version": "2.3.3",
4
4
  "description": "TypeScript SDK for the Arke API - auto-generated from OpenAPI spec",
5
5
  "type": "module",
6
6
  "main": "dist/index.cjs",