iii-browser-sdk 0.24.6 → 0.25.0-alpha.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.
package/dist/stream.d.cts CHANGED
@@ -1,5 +1,9 @@
1
1
  //#region src/stream.d.ts
2
- /** Input for stream authentication. */
2
+ /**
3
+ * Input for stream authentication.
4
+ *
5
+ * @deprecated StreamAuthInput is deprecated (iii-stream) and will be removed in an upcoming release. Behavior is unchanged for now. Migration guide: https://iii.dev/docs/upgrading/migrate-from-streams
6
+ */
3
7
  interface StreamAuthInput {
4
8
  /** Request headers. */
5
9
  headers: Record<string, string>;
@@ -10,14 +14,26 @@ interface StreamAuthInput {
10
14
  /** Client address. */
11
15
  addr: string;
12
16
  }
13
- /** Result of stream authentication. */
17
+ /**
18
+ * Result of stream authentication.
19
+ *
20
+ * @deprecated StreamAuthResult is deprecated (iii-stream) and will be removed in an upcoming release. Behavior is unchanged for now. Migration guide: https://iii.dev/docs/upgrading/migrate-from-streams
21
+ */
14
22
  interface StreamAuthResult {
15
23
  /** Arbitrary context passed to stream handlers after authentication. */
16
24
  context?: any;
17
25
  }
18
- /** Context type extracted from {@link StreamAuthResult}. */
26
+ /**
27
+ * Context type extracted from {@link StreamAuthResult}.
28
+ *
29
+ * @deprecated StreamContext is deprecated (iii-stream) and will be removed in an upcoming release. Behavior is unchanged for now. Migration guide: https://iii.dev/docs/upgrading/migrate-from-streams
30
+ */
19
31
  type StreamContext = StreamAuthResult['context'];
20
- /** Event payload for stream join/leave events. */
32
+ /**
33
+ * Event payload for stream join/leave events.
34
+ *
35
+ * @deprecated StreamJoinLeaveEvent is deprecated (iii-stream) and will be removed in an upcoming release. Behavior is unchanged for now. Migration guide: https://iii.dev/docs/upgrading/migrate-from-streams
36
+ */
21
37
  interface StreamJoinLeaveEvent {
22
38
  /** Unique subscription identifier. */
23
39
  subscription_id: string;
@@ -30,45 +46,77 @@ interface StreamJoinLeaveEvent {
30
46
  /** Auth context from {@link StreamAuthResult}. */
31
47
  context?: StreamContext;
32
48
  }
33
- /** Result of a stream join request. */
49
+ /**
50
+ * Result of a stream join request.
51
+ *
52
+ * @deprecated StreamJoinResult is deprecated (iii-stream) and will be removed in an upcoming release. Behavior is unchanged for now. Migration guide: https://iii.dev/docs/upgrading/migrate-from-streams
53
+ */
34
54
  interface StreamJoinResult {
35
55
  /** Whether the join was unauthorized. */
36
56
  unauthorized: boolean;
37
57
  }
38
- /** Input for retrieving a single stream item. */
58
+ /**
59
+ * Input for retrieving a single stream item.
60
+ *
61
+ * @deprecated StreamGetInput is deprecated (iii-stream) and will be removed in an upcoming release. Behavior is unchanged for now. Migration guide: https://iii.dev/docs/upgrading/migrate-from-streams
62
+ */
39
63
  type StreamGetInput = {
40
64
  /** Name of the stream. */stream_name: string; /** Group identifier. */
41
65
  group_id: string; /** Item identifier. */
42
66
  item_id: string;
43
67
  };
44
- /** Input for setting a stream item. */
68
+ /**
69
+ * Input for setting a stream item.
70
+ *
71
+ * @deprecated StreamSetInput is deprecated (iii-stream) and will be removed in an upcoming release. Behavior is unchanged for now. Migration guide: https://iii.dev/docs/upgrading/migrate-from-streams
72
+ */
45
73
  type StreamSetInput = {
46
74
  /** Name of the stream. */stream_name: string; /** Group identifier. */
47
75
  group_id: string; /** Item identifier. */
48
76
  item_id: string; /** Data to store. */
49
77
  data: any;
50
78
  };
51
- /** Input for deleting a stream item. */
79
+ /**
80
+ * Input for deleting a stream item.
81
+ *
82
+ * @deprecated StreamDeleteInput is deprecated (iii-stream) and will be removed in an upcoming release. Behavior is unchanged for now. Migration guide: https://iii.dev/docs/upgrading/migrate-from-streams
83
+ */
52
84
  type StreamDeleteInput = {
53
85
  /** Name of the stream. */stream_name: string; /** Group identifier. */
54
86
  group_id: string; /** Item identifier. */
55
87
  item_id: string;
56
88
  };
57
- /** Input for listing all items in a stream group. */
89
+ /**
90
+ * Input for listing all items in a stream group.
91
+ *
92
+ * @deprecated StreamListInput is deprecated (iii-stream) and will be removed in an upcoming release. Behavior is unchanged for now. Migration guide: https://iii.dev/docs/upgrading/migrate-from-streams
93
+ */
58
94
  type StreamListInput = {
59
95
  /** Name of the stream. */stream_name: string; /** Group identifier. */
60
96
  group_id: string;
61
97
  };
62
- /** Input for listing all groups in a stream. */
98
+ /**
99
+ * Input for listing all groups in a stream.
100
+ *
101
+ * @deprecated StreamListGroupsInput is deprecated (iii-stream) and will be removed in an upcoming release. Behavior is unchanged for now. Migration guide: https://iii.dev/docs/upgrading/migrate-from-streams
102
+ */
63
103
  type StreamListGroupsInput = {
64
104
  /** Name of the stream. */stream_name: string;
65
105
  };
66
- /** Result of a stream set operation. */
106
+ /**
107
+ * Result of a stream set operation.
108
+ *
109
+ * @deprecated StreamSetResult is deprecated (iii-stream) and will be removed in an upcoming release. Behavior is unchanged for now. Migration guide: https://iii.dev/docs/upgrading/migrate-from-streams
110
+ */
67
111
  type StreamSetResult<TData> = {
68
112
  /** Previous value (if it existed). */old_value?: TData; /** New value that was stored. */
69
113
  new_value: TData;
70
114
  };
71
- /** Result of a stream update operation. */
115
+ /**
116
+ * Result of a stream update operation.
117
+ *
118
+ * @deprecated StreamUpdateResult is deprecated (iii-stream) and will be removed in an upcoming release. Behavior is unchanged for now. Migration guide: https://iii.dev/docs/upgrading/migrate-from-streams
119
+ */
72
120
  type StreamUpdateResult<TData> = {
73
121
  /** Previous value (if it existed). */old_value?: TData; /** New value after the update. */
74
122
  new_value: TData;
@@ -162,7 +210,11 @@ type UpdateOpError = {
162
210
  message: string; /** Optional documentation URL. */
163
211
  doc_url?: string;
164
212
  };
165
- /** Result of a stream delete operation. */
213
+ /**
214
+ * Result of a stream delete operation.
215
+ *
216
+ * @deprecated DeleteResult is deprecated (iii-stream) and will be removed in an upcoming release. Behavior is unchanged for now. Migration guide: https://iii.dev/docs/upgrading/migrate-from-streams
217
+ */
166
218
  type DeleteResult = {
167
219
  /** Previous value (if it existed). */old_value?: any;
168
220
  };
@@ -173,14 +225,22 @@ type DeleteResult = {
173
225
  * {@link UpdateAppend}, {@link UpdateRemove}, {@link UpdateMerge}
174
226
  */
175
227
  type UpdateOp = UpdateSet | UpdateIncrement | UpdateDecrement | UpdateAppend | UpdateRemove | UpdateMerge;
176
- /** Input for atomically updating a stream item. */
228
+ /**
229
+ * Input for atomically updating a stream item.
230
+ *
231
+ * @deprecated StreamUpdateInput is deprecated (iii-stream) and will be removed in an upcoming release. Behavior is unchanged for now. Migration guide: https://iii.dev/docs/upgrading/migrate-from-streams
232
+ */
177
233
  type StreamUpdateInput = {
178
234
  /** Name of the stream. */stream_name: string; /** Group identifier. */
179
235
  group_id: string; /** Item identifier. */
180
236
  item_id: string; /** Ordered list of update operations to apply atomically. */
181
237
  ops: UpdateOp[];
182
238
  };
183
- /** Trigger config for `stream` triggers. Filters which item changes fire the handler. */
239
+ /**
240
+ * Trigger config for `stream` triggers. Filters which item changes fire the handler.
241
+ *
242
+ * @deprecated StreamTriggerConfig is deprecated (iii-stream) and will be removed in an upcoming release. Behavior is unchanged for now. Migration guide: https://iii.dev/docs/upgrading/migrate-from-streams
243
+ */
184
244
  interface StreamTriggerConfig {
185
245
  /** Stream name to watch. Only changes on this stream fire the handler. */
186
246
  stream_name: string;
@@ -191,12 +251,20 @@ interface StreamTriggerConfig {
191
251
  /** Function ID for conditional execution. If it returns `false`, the handler is skipped. */
192
252
  condition_function_id?: string;
193
253
  }
194
- /** Trigger config for `stream:join` and `stream:leave` triggers. */
254
+ /**
255
+ * Trigger config for `stream:join` and `stream:leave` triggers.
256
+ *
257
+ * @deprecated StreamJoinLeaveTriggerConfig is deprecated (iii-stream) and will be removed in an upcoming release. Behavior is unchanged for now. Migration guide: https://iii.dev/docs/upgrading/migrate-from-streams
258
+ */
195
259
  interface StreamJoinLeaveTriggerConfig {
196
260
  /** Function ID for conditional execution. If it returns `false`, the handler is skipped. */
197
261
  condition_function_id?: string;
198
262
  }
199
- /** Handler input for `stream` triggers, fired when an item changes via `stream::set`, `stream::update`, or `stream::delete`. */
263
+ /**
264
+ * Handler input for `stream` triggers, fired when an item changes via `stream::set`, `stream::update`, or `stream::delete`.
265
+ *
266
+ * @deprecated StreamChangeEvent is deprecated (iii-stream) and will be removed in an upcoming release. Behavior is unchanged for now. Migration guide: https://iii.dev/docs/upgrading/migrate-from-streams
267
+ */
200
268
  interface StreamChangeEvent {
201
269
  /** The event type. */
202
270
  type: 'stream';
@@ -219,6 +287,8 @@ interface StreamChangeEvent {
219
287
  * to override the engine's built-in stream storage.
220
288
  *
221
289
  * @typeParam TData - Type of the data stored in the stream.
290
+ *
291
+ * @deprecated IStream is deprecated (iii-stream) and will be removed in an upcoming release. Behavior is unchanged for now. Migration guide: https://iii.dev/docs/upgrading/migrate-from-streams
222
292
  */
223
293
  interface IStream<TData> {
224
294
  /** Retrieve a single item by group and item ID. */
@@ -1 +1 @@
1
- {"version":3,"file":"stream.d.cts","names":[],"sources":["../src/stream.ts"],"mappings":";;UACiB,eAAA;EAAe;EAE9B,OAAA,EAAS,MAAA;EAIW;EAFpB,IAAA;EAFS;EAIT,YAAA,EAAc,MAAA;EAAd;EAEA,IAAA;AAAA;;UAIe,gBAAA;EAAA;EAGf,OAAA;AAAA;;KAIU,aAAA,GAAgB,gBAAA;AAA5B;AAAA,UAGiB,oBAAA;;EAEf,eAAA;EAL0C;EAO1C,WAAA;EAJmC;EAMnC,QAAA;EAIuB;EAFvB,EAAA;EAJA;EAMA,OAAA,GAAU,aAAA;AAAA;;UAIK,gBAAA;EAJQ;EAMvB,YAAA;AAAA;;KAIU,cAAA;EAJV,0BAMA,WAAA,UAFU;EAIV,QAAA;EAEA,OAAA;AAAA;;KAIU,cAAA;EAJH,0BAMP,WAAA,UAFU;EAIV,QAAA;EAEA,OAAA,UAJA;EAOA,IAAA;AAAA;;KAIU,iBAAA;EAJN,0BAMJ,WAAA,UAF2B;EAI3B,QAAA,UAJ2B;EAM3B,OAAA;AAAA;;KAIU,eAAA;EAJH,0BAMP,WAAA,UAFyB;EAIzB,QAAA;AAAA;;KAIU,qBAAA;EAAqB,0BAE/B,WAAA;AAAA;;KAIU,eAAA;EAAe,sCAEzB,SAAA,GAAY,KAAA,EAEI;EAAhB,SAAA,EAAW,KAAA;AAAA;;KAID,kBAAA;EAJC,sCAMX,SAAA,GAAY,KAAA,EANI;EAQhB,SAAA,EAAW,KAAA;EAJiB;;;;;;EAW5B,MAAA,GAAS,aAAA;AAAA;;KAIC,SAAA;EACV,IAAA,SAZW;EAcX,IAAA,UAPS;EAUT,KAAA;AAAA;AANF;AAAA,KAUY,eAAA;EACV,IAAA,eAXmB;EAanB,IAAA,UAVA;EAYA,EAAA;AAAA;;KAIU,eAAA;EACV,IAAA;EAEA,IAAA,UAXA;EAaA,EAAA;AAAA;;;AALF;;;;;;;;;AAqBA;;KAAY,YAAA;EACV,IAAA;EAAA;;;;;EAMA,IAAA,GAAO,SAAA,EAOG;EAJV,KAAA;AAAA;;KAIU,YAAA;EACV,IAAA,YAkBmB;EAhBnB,IAAA;AAAA;;AA4BF;;;;;;;;;;AAUA;;KAtBY,SAAA;;;;;;;;AAkCZ;;;KAtBY,WAAA;EACV,IAAA,WAiCU;EA/BV,IAAA,GAAO,SAAA;EAGP,KAAA;AAAA;;KAIU,aAAA;EA6BR,iEA3BF,QAAA,UA4Ba;EA1Bb,IAAA,UAqBE;EAnBF,OAAA,UAqBE;EAnBF,OAAA;AAAA;;KAIU,YAAA;EAkBG,sCAfb,SAAA;AAAA;;;;;;;KASU,QAAA,GACR,SAAA,GACA,eAAA,GACA,eAAA,GACA,YAAA,GACA,YAAA,GACA,WAAA;;KAGQ,iBAAA;EAYK,0BAVf,WAAA;EAEA,QAAA,UAUA;EARA,OAAA,UAYA;EAVA,GAAA,EAAK,QAAA;AAAA;;UAIU,mBAAA;EAY4B;EAV3C,WAAA;EAYA;EAVA,QAAA;EAce;EAZf,OAAA;;EAEA,qBAAA;AAAA;;UAIe,4BAAA;EAcf;EAZA,qBAAA;AAAA;;UAIe,iBAAA;EAeT;EAbN,IAAA;EAuBe;EArBf,SAAA;EAqBsB;EAnBtB,UAAA;EAqBoC;EAnBpC,OAAA;EAqBW;EAnBX,EAAA;EAmBoC;EAjBpC,KAAA;IACE,IAAA;IAEA,IAAA;EAAA;AAAA;;;;;;;UAUa,OAAA;EAYmB;EAVlC,GAAA,CAAI,KAAA,EAAO,cAAA,GAAiB,OAAA,CAAQ,KAAA;EAUK;EARzC,GAAA,CAAI,KAAA,EAAO,cAAA,GAAiB,OAAA,CAAQ,eAAA,CAAgB,KAAA;EAFpD;EAIA,MAAA,CAAO,KAAA,EAAO,iBAAA,GAAoB,OAAA,CAAQ,YAAA;EAJtC;EAMJ,IAAA,CAAK,KAAA,EAAO,eAAA,GAAkB,OAAA,CAAQ,KAAA;EANF;EAQpC,UAAA,CAAW,KAAA,EAAO,qBAAA,GAAwB,OAAA;EAN/B;EAQX,MAAA,CAAO,KAAA,EAAO,iBAAA,GAAoB,OAAA,CAAQ,kBAAA,CAAmB,KAAA;AAAA"}
1
+ {"version":3,"file":"stream.d.cts","names":[],"sources":["../src/stream.ts"],"mappings":";;AAKA;;;;UAAiB,eAAA;EAEN;EAAT,OAAA,EAAS,MAAA;EAIT;EAFA,IAAA;EAIA;EAFA,YAAA,EAAc,MAAA;EAEV;EAAJ,IAAA;AAAA;;;;AAmBF;;UAXiB,gBAAA;EAWW;EAR1B,OAAA;AAAA;;;;;;KAQU,aAAA,GAAgB,gBAAA;;;;;;UAOX,oBAAA;EAkBgB;EAhB/B,eAAA;EAkBA;EAhBA,WAAA;EAwBU;EAtBV,QAAA;;EAEA,EAAA;EAsBA;EApBA,OAAA,GAAU,aAAA;AAAA;;;AAgCZ;;;UAxBiB,gBAAA;EA0Bf;EAxBA,YAAA;AAAA;;;;AAuCF;;KA/BY,cAAA;EA+BiB,0BA7B3B,WAAA,UAiCA;EA/BA,QAAA,UAiCO;EA/BP,OAAA;AAAA;;;;;AAmDF;KA3CY,cAAA;4BAEV,WAAA,UA2CW;EAzCX,QAAA,UAiDyB;EA/CzB,OAAA,UAmDgB;EAhDhB,IAAA;AAAA;;;;;;KAQU,iBAAA;EAgDkB,0BA9C5B,WAAA,UAgDY;EA9CZ,QAAA,UAuDS;EArDT,OAAA;AAAA;;;;;;KAQU,eAAA;EA6CD,0BA3CT,WAAA,UA2CsB;EAzCtB,QAAA;AAAA;;;;;;KAQU,qBAAA;EA2CL,0BAzCL,WAAA;AAAA;;;;;;KAQU,eAAA;EA0CR,sCAxCF,SAAA,GAAY,KAAA,EA4Ca;EA1CzB,SAAA,EAAW,KAAA;AAAA;;;;;;KAQD,kBAAA;EAuDY,sCArDtB,SAAA,GAAY,KAAA,EA4DI;EA1DhB,SAAA,EAAW,KAAA;EA0DX;;;;;AAOF;EA1DE,MAAA,GAAS,aAAA;AAAA;;KAIC,SAAA;EACV,IAAA,SAwEmB;EAtEnB,IAAA,UAsEmB;EAnEnB,KAAA;AAAA;;KAIU,eAAA;EACV,IAAA,eA2EA;EAzEA,IAAA,UA2EO;EAzEP,EAAA;AAAA;;KAIU,eAAA;EACV,IAAA;EAEA,IAAA,UA2EA;EAzEA,EAAA;AAAA;;;;AAuFF;;;;;AAYA;;;;;KAnFY,YAAA;EACV,IAAA;EAuFE;;;;;EAjFF,IAAA,GAAO,SAAA,EA+EL;EA5EF,KAAA;AAAA;;KAIU,YAAA;EACV,IAAA,YAiFU;EA/EV,IAAA;AAAA;;;;;;;;;AA+FF;;;;;KA/EY,SAAA;;;;;AA+FZ;;;;;AAUA;KA7FY,WAAA;EACV,IAAA,WA4FgC;EA1FhC,IAAA,GAAO,SAAA,EA8FP;EA3FA,KAAA;AAAA;;KAIU,aAAA;EAgGR,iEA9FF,QAAA,UAgGM;EA9FN,IAAA,UA0Ge;EAxGf,OAAA,UAwGsB;EAtGtB,OAAA;AAAA;;;;;;KAQU,YAAA;EAoGgC,sCAjG1C,SAAA;AAAA;;;;;;;KASU,QAAA,GACR,SAAA,GACA,eAAA,GACA,eAAA,GACA,YAAA,GACA,YAAA,GACA,WAAA;;;;;;KAOQ,iBAAA;EAuEN,0BArEJ,WAAA,UAqEoC;EAnEpC,QAAA,UAqEW;EAnEX,OAAA,UAmE4B;EAjE5B,GAAA,EAAK,QAAA;AAAA;;;;;;UAQU,mBAAA;EA6DH;EA3DZ,WAAA;EA2D8B;EAzD9B,QAAA;EA2DA;EAzDA,OAAA;EAyDW;EAvDX,qBAAA;AAAA;;;;;;UAQe,4BAAA;EAiDmD;EA/ClE,qBAAA;AAAA;;;;;;UAQe,iBAAA;;EAEf,IAAA;;EAEA,SAAA;;EAEA,UAAA;;EAEA,OAAA;;EAEA,EAAA;;EAEA,KAAA;IACE,IAAA;IAEA,IAAA;EAAA;AAAA;;;;;;;;;UAYa,OAAA;;EAEf,GAAA,CAAI,KAAA,EAAO,cAAA,GAAiB,OAAA,CAAQ,KAAA;;EAEpC,GAAA,CAAI,KAAA,EAAO,cAAA,GAAiB,OAAA,CAAQ,eAAA,CAAgB,KAAA;;EAEpD,MAAA,CAAO,KAAA,EAAO,iBAAA,GAAoB,OAAA,CAAQ,YAAA;;EAE1C,IAAA,CAAK,KAAA,EAAO,eAAA,GAAkB,OAAA,CAAQ,KAAA;;EAEtC,UAAA,CAAW,KAAA,EAAO,qBAAA,GAAwB,OAAA;;EAE1C,MAAA,CAAO,KAAA,EAAO,iBAAA,GAAoB,OAAA,CAAQ,kBAAA,CAAmB,KAAA;AAAA"}
package/dist/stream.d.mts CHANGED
@@ -1,5 +1,9 @@
1
1
  //#region src/stream.d.ts
2
- /** Input for stream authentication. */
2
+ /**
3
+ * Input for stream authentication.
4
+ *
5
+ * @deprecated StreamAuthInput is deprecated (iii-stream) and will be removed in an upcoming release. Behavior is unchanged for now. Migration guide: https://iii.dev/docs/upgrading/migrate-from-streams
6
+ */
3
7
  interface StreamAuthInput {
4
8
  /** Request headers. */
5
9
  headers: Record<string, string>;
@@ -10,14 +14,26 @@ interface StreamAuthInput {
10
14
  /** Client address. */
11
15
  addr: string;
12
16
  }
13
- /** Result of stream authentication. */
17
+ /**
18
+ * Result of stream authentication.
19
+ *
20
+ * @deprecated StreamAuthResult is deprecated (iii-stream) and will be removed in an upcoming release. Behavior is unchanged for now. Migration guide: https://iii.dev/docs/upgrading/migrate-from-streams
21
+ */
14
22
  interface StreamAuthResult {
15
23
  /** Arbitrary context passed to stream handlers after authentication. */
16
24
  context?: any;
17
25
  }
18
- /** Context type extracted from {@link StreamAuthResult}. */
26
+ /**
27
+ * Context type extracted from {@link StreamAuthResult}.
28
+ *
29
+ * @deprecated StreamContext is deprecated (iii-stream) and will be removed in an upcoming release. Behavior is unchanged for now. Migration guide: https://iii.dev/docs/upgrading/migrate-from-streams
30
+ */
19
31
  type StreamContext = StreamAuthResult['context'];
20
- /** Event payload for stream join/leave events. */
32
+ /**
33
+ * Event payload for stream join/leave events.
34
+ *
35
+ * @deprecated StreamJoinLeaveEvent is deprecated (iii-stream) and will be removed in an upcoming release. Behavior is unchanged for now. Migration guide: https://iii.dev/docs/upgrading/migrate-from-streams
36
+ */
21
37
  interface StreamJoinLeaveEvent {
22
38
  /** Unique subscription identifier. */
23
39
  subscription_id: string;
@@ -30,45 +46,77 @@ interface StreamJoinLeaveEvent {
30
46
  /** Auth context from {@link StreamAuthResult}. */
31
47
  context?: StreamContext;
32
48
  }
33
- /** Result of a stream join request. */
49
+ /**
50
+ * Result of a stream join request.
51
+ *
52
+ * @deprecated StreamJoinResult is deprecated (iii-stream) and will be removed in an upcoming release. Behavior is unchanged for now. Migration guide: https://iii.dev/docs/upgrading/migrate-from-streams
53
+ */
34
54
  interface StreamJoinResult {
35
55
  /** Whether the join was unauthorized. */
36
56
  unauthorized: boolean;
37
57
  }
38
- /** Input for retrieving a single stream item. */
58
+ /**
59
+ * Input for retrieving a single stream item.
60
+ *
61
+ * @deprecated StreamGetInput is deprecated (iii-stream) and will be removed in an upcoming release. Behavior is unchanged for now. Migration guide: https://iii.dev/docs/upgrading/migrate-from-streams
62
+ */
39
63
  type StreamGetInput = {
40
64
  /** Name of the stream. */stream_name: string; /** Group identifier. */
41
65
  group_id: string; /** Item identifier. */
42
66
  item_id: string;
43
67
  };
44
- /** Input for setting a stream item. */
68
+ /**
69
+ * Input for setting a stream item.
70
+ *
71
+ * @deprecated StreamSetInput is deprecated (iii-stream) and will be removed in an upcoming release. Behavior is unchanged for now. Migration guide: https://iii.dev/docs/upgrading/migrate-from-streams
72
+ */
45
73
  type StreamSetInput = {
46
74
  /** Name of the stream. */stream_name: string; /** Group identifier. */
47
75
  group_id: string; /** Item identifier. */
48
76
  item_id: string; /** Data to store. */
49
77
  data: any;
50
78
  };
51
- /** Input for deleting a stream item. */
79
+ /**
80
+ * Input for deleting a stream item.
81
+ *
82
+ * @deprecated StreamDeleteInput is deprecated (iii-stream) and will be removed in an upcoming release. Behavior is unchanged for now. Migration guide: https://iii.dev/docs/upgrading/migrate-from-streams
83
+ */
52
84
  type StreamDeleteInput = {
53
85
  /** Name of the stream. */stream_name: string; /** Group identifier. */
54
86
  group_id: string; /** Item identifier. */
55
87
  item_id: string;
56
88
  };
57
- /** Input for listing all items in a stream group. */
89
+ /**
90
+ * Input for listing all items in a stream group.
91
+ *
92
+ * @deprecated StreamListInput is deprecated (iii-stream) and will be removed in an upcoming release. Behavior is unchanged for now. Migration guide: https://iii.dev/docs/upgrading/migrate-from-streams
93
+ */
58
94
  type StreamListInput = {
59
95
  /** Name of the stream. */stream_name: string; /** Group identifier. */
60
96
  group_id: string;
61
97
  };
62
- /** Input for listing all groups in a stream. */
98
+ /**
99
+ * Input for listing all groups in a stream.
100
+ *
101
+ * @deprecated StreamListGroupsInput is deprecated (iii-stream) and will be removed in an upcoming release. Behavior is unchanged for now. Migration guide: https://iii.dev/docs/upgrading/migrate-from-streams
102
+ */
63
103
  type StreamListGroupsInput = {
64
104
  /** Name of the stream. */stream_name: string;
65
105
  };
66
- /** Result of a stream set operation. */
106
+ /**
107
+ * Result of a stream set operation.
108
+ *
109
+ * @deprecated StreamSetResult is deprecated (iii-stream) and will be removed in an upcoming release. Behavior is unchanged for now. Migration guide: https://iii.dev/docs/upgrading/migrate-from-streams
110
+ */
67
111
  type StreamSetResult<TData> = {
68
112
  /** Previous value (if it existed). */old_value?: TData; /** New value that was stored. */
69
113
  new_value: TData;
70
114
  };
71
- /** Result of a stream update operation. */
115
+ /**
116
+ * Result of a stream update operation.
117
+ *
118
+ * @deprecated StreamUpdateResult is deprecated (iii-stream) and will be removed in an upcoming release. Behavior is unchanged for now. Migration guide: https://iii.dev/docs/upgrading/migrate-from-streams
119
+ */
72
120
  type StreamUpdateResult<TData> = {
73
121
  /** Previous value (if it existed). */old_value?: TData; /** New value after the update. */
74
122
  new_value: TData;
@@ -162,7 +210,11 @@ type UpdateOpError = {
162
210
  message: string; /** Optional documentation URL. */
163
211
  doc_url?: string;
164
212
  };
165
- /** Result of a stream delete operation. */
213
+ /**
214
+ * Result of a stream delete operation.
215
+ *
216
+ * @deprecated DeleteResult is deprecated (iii-stream) and will be removed in an upcoming release. Behavior is unchanged for now. Migration guide: https://iii.dev/docs/upgrading/migrate-from-streams
217
+ */
166
218
  type DeleteResult = {
167
219
  /** Previous value (if it existed). */old_value?: any;
168
220
  };
@@ -173,14 +225,22 @@ type DeleteResult = {
173
225
  * {@link UpdateAppend}, {@link UpdateRemove}, {@link UpdateMerge}
174
226
  */
175
227
  type UpdateOp = UpdateSet | UpdateIncrement | UpdateDecrement | UpdateAppend | UpdateRemove | UpdateMerge;
176
- /** Input for atomically updating a stream item. */
228
+ /**
229
+ * Input for atomically updating a stream item.
230
+ *
231
+ * @deprecated StreamUpdateInput is deprecated (iii-stream) and will be removed in an upcoming release. Behavior is unchanged for now. Migration guide: https://iii.dev/docs/upgrading/migrate-from-streams
232
+ */
177
233
  type StreamUpdateInput = {
178
234
  /** Name of the stream. */stream_name: string; /** Group identifier. */
179
235
  group_id: string; /** Item identifier. */
180
236
  item_id: string; /** Ordered list of update operations to apply atomically. */
181
237
  ops: UpdateOp[];
182
238
  };
183
- /** Trigger config for `stream` triggers. Filters which item changes fire the handler. */
239
+ /**
240
+ * Trigger config for `stream` triggers. Filters which item changes fire the handler.
241
+ *
242
+ * @deprecated StreamTriggerConfig is deprecated (iii-stream) and will be removed in an upcoming release. Behavior is unchanged for now. Migration guide: https://iii.dev/docs/upgrading/migrate-from-streams
243
+ */
184
244
  interface StreamTriggerConfig {
185
245
  /** Stream name to watch. Only changes on this stream fire the handler. */
186
246
  stream_name: string;
@@ -191,12 +251,20 @@ interface StreamTriggerConfig {
191
251
  /** Function ID for conditional execution. If it returns `false`, the handler is skipped. */
192
252
  condition_function_id?: string;
193
253
  }
194
- /** Trigger config for `stream:join` and `stream:leave` triggers. */
254
+ /**
255
+ * Trigger config for `stream:join` and `stream:leave` triggers.
256
+ *
257
+ * @deprecated StreamJoinLeaveTriggerConfig is deprecated (iii-stream) and will be removed in an upcoming release. Behavior is unchanged for now. Migration guide: https://iii.dev/docs/upgrading/migrate-from-streams
258
+ */
195
259
  interface StreamJoinLeaveTriggerConfig {
196
260
  /** Function ID for conditional execution. If it returns `false`, the handler is skipped. */
197
261
  condition_function_id?: string;
198
262
  }
199
- /** Handler input for `stream` triggers, fired when an item changes via `stream::set`, `stream::update`, or `stream::delete`. */
263
+ /**
264
+ * Handler input for `stream` triggers, fired when an item changes via `stream::set`, `stream::update`, or `stream::delete`.
265
+ *
266
+ * @deprecated StreamChangeEvent is deprecated (iii-stream) and will be removed in an upcoming release. Behavior is unchanged for now. Migration guide: https://iii.dev/docs/upgrading/migrate-from-streams
267
+ */
200
268
  interface StreamChangeEvent {
201
269
  /** The event type. */
202
270
  type: 'stream';
@@ -219,6 +287,8 @@ interface StreamChangeEvent {
219
287
  * to override the engine's built-in stream storage.
220
288
  *
221
289
  * @typeParam TData - Type of the data stored in the stream.
290
+ *
291
+ * @deprecated IStream is deprecated (iii-stream) and will be removed in an upcoming release. Behavior is unchanged for now. Migration guide: https://iii.dev/docs/upgrading/migrate-from-streams
222
292
  */
223
293
  interface IStream<TData> {
224
294
  /** Retrieve a single item by group and item ID. */
@@ -1 +1 @@
1
- {"version":3,"file":"stream.d.mts","names":[],"sources":["../src/stream.ts"],"mappings":";;UACiB,eAAA;EAAe;EAE9B,OAAA,EAAS,MAAA;EAIW;EAFpB,IAAA;EAFS;EAIT,YAAA,EAAc,MAAA;EAAd;EAEA,IAAA;AAAA;;UAIe,gBAAA;EAAA;EAGf,OAAA;AAAA;;KAIU,aAAA,GAAgB,gBAAA;AAA5B;AAAA,UAGiB,oBAAA;;EAEf,eAAA;EAL0C;EAO1C,WAAA;EAJmC;EAMnC,QAAA;EAIuB;EAFvB,EAAA;EAJA;EAMA,OAAA,GAAU,aAAA;AAAA;;UAIK,gBAAA;EAJQ;EAMvB,YAAA;AAAA;;KAIU,cAAA;EAJV,0BAMA,WAAA,UAFU;EAIV,QAAA;EAEA,OAAA;AAAA;;KAIU,cAAA;EAJH,0BAMP,WAAA,UAFU;EAIV,QAAA;EAEA,OAAA,UAJA;EAOA,IAAA;AAAA;;KAIU,iBAAA;EAJN,0BAMJ,WAAA,UAF2B;EAI3B,QAAA,UAJ2B;EAM3B,OAAA;AAAA;;KAIU,eAAA;EAJH,0BAMP,WAAA,UAFyB;EAIzB,QAAA;AAAA;;KAIU,qBAAA;EAAqB,0BAE/B,WAAA;AAAA;;KAIU,eAAA;EAAe,sCAEzB,SAAA,GAAY,KAAA,EAEI;EAAhB,SAAA,EAAW,KAAA;AAAA;;KAID,kBAAA;EAJC,sCAMX,SAAA,GAAY,KAAA,EANI;EAQhB,SAAA,EAAW,KAAA;EAJiB;;;;;;EAW5B,MAAA,GAAS,aAAA;AAAA;;KAIC,SAAA;EACV,IAAA,SAZW;EAcX,IAAA,UAPS;EAUT,KAAA;AAAA;AANF;AAAA,KAUY,eAAA;EACV,IAAA,eAXmB;EAanB,IAAA,UAVA;EAYA,EAAA;AAAA;;KAIU,eAAA;EACV,IAAA;EAEA,IAAA,UAXA;EAaA,EAAA;AAAA;;;AALF;;;;;;;;;AAqBA;;KAAY,YAAA;EACV,IAAA;EAAA;;;;;EAMA,IAAA,GAAO,SAAA,EAOG;EAJV,KAAA;AAAA;;KAIU,YAAA;EACV,IAAA,YAkBmB;EAhBnB,IAAA;AAAA;;AA4BF;;;;;;;;;;AAUA;;KAtBY,SAAA;;;;;;;;AAkCZ;;;KAtBY,WAAA;EACV,IAAA,WAiCU;EA/BV,IAAA,GAAO,SAAA;EAGP,KAAA;AAAA;;KAIU,aAAA;EA6BR,iEA3BF,QAAA,UA4Ba;EA1Bb,IAAA,UAqBE;EAnBF,OAAA,UAqBE;EAnBF,OAAA;AAAA;;KAIU,YAAA;EAkBG,sCAfb,SAAA;AAAA;;;;;;;KASU,QAAA,GACR,SAAA,GACA,eAAA,GACA,eAAA,GACA,YAAA,GACA,YAAA,GACA,WAAA;;KAGQ,iBAAA;EAYK,0BAVf,WAAA;EAEA,QAAA,UAUA;EARA,OAAA,UAYA;EAVA,GAAA,EAAK,QAAA;AAAA;;UAIU,mBAAA;EAY4B;EAV3C,WAAA;EAYA;EAVA,QAAA;EAce;EAZf,OAAA;;EAEA,qBAAA;AAAA;;UAIe,4BAAA;EAcf;EAZA,qBAAA;AAAA;;UAIe,iBAAA;EAeT;EAbN,IAAA;EAuBe;EArBf,SAAA;EAqBsB;EAnBtB,UAAA;EAqBoC;EAnBpC,OAAA;EAqBW;EAnBX,EAAA;EAmBoC;EAjBpC,KAAA;IACE,IAAA;IAEA,IAAA;EAAA;AAAA;;;;;;;UAUa,OAAA;EAYmB;EAVlC,GAAA,CAAI,KAAA,EAAO,cAAA,GAAiB,OAAA,CAAQ,KAAA;EAUK;EARzC,GAAA,CAAI,KAAA,EAAO,cAAA,GAAiB,OAAA,CAAQ,eAAA,CAAgB,KAAA;EAFpD;EAIA,MAAA,CAAO,KAAA,EAAO,iBAAA,GAAoB,OAAA,CAAQ,YAAA;EAJtC;EAMJ,IAAA,CAAK,KAAA,EAAO,eAAA,GAAkB,OAAA,CAAQ,KAAA;EANF;EAQpC,UAAA,CAAW,KAAA,EAAO,qBAAA,GAAwB,OAAA;EAN/B;EAQX,MAAA,CAAO,KAAA,EAAO,iBAAA,GAAoB,OAAA,CAAQ,kBAAA,CAAmB,KAAA;AAAA"}
1
+ {"version":3,"file":"stream.d.mts","names":[],"sources":["../src/stream.ts"],"mappings":";;AAKA;;;;UAAiB,eAAA;EAEN;EAAT,OAAA,EAAS,MAAA;EAIT;EAFA,IAAA;EAIA;EAFA,YAAA,EAAc,MAAA;EAEV;EAAJ,IAAA;AAAA;;;;AAmBF;;UAXiB,gBAAA;EAWW;EAR1B,OAAA;AAAA;;;;;;KAQU,aAAA,GAAgB,gBAAA;;;;;;UAOX,oBAAA;EAkBgB;EAhB/B,eAAA;EAkBA;EAhBA,WAAA;EAwBU;EAtBV,QAAA;;EAEA,EAAA;EAsBA;EApBA,OAAA,GAAU,aAAA;AAAA;;;AAgCZ;;;UAxBiB,gBAAA;EA0Bf;EAxBA,YAAA;AAAA;;;;AAuCF;;KA/BY,cAAA;EA+BiB,0BA7B3B,WAAA,UAiCA;EA/BA,QAAA,UAiCO;EA/BP,OAAA;AAAA;;;;;AAmDF;KA3CY,cAAA;4BAEV,WAAA,UA2CW;EAzCX,QAAA,UAiDyB;EA/CzB,OAAA,UAmDgB;EAhDhB,IAAA;AAAA;;;;;;KAQU,iBAAA;EAgDkB,0BA9C5B,WAAA,UAgDY;EA9CZ,QAAA,UAuDS;EArDT,OAAA;AAAA;;;;;;KAQU,eAAA;EA6CD,0BA3CT,WAAA,UA2CsB;EAzCtB,QAAA;AAAA;;;;;;KAQU,qBAAA;EA2CL,0BAzCL,WAAA;AAAA;;;;;;KAQU,eAAA;EA0CR,sCAxCF,SAAA,GAAY,KAAA,EA4Ca;EA1CzB,SAAA,EAAW,KAAA;AAAA;;;;;;KAQD,kBAAA;EAuDY,sCArDtB,SAAA,GAAY,KAAA,EA4DI;EA1DhB,SAAA,EAAW,KAAA;EA0DX;;;;;AAOF;EA1DE,MAAA,GAAS,aAAA;AAAA;;KAIC,SAAA;EACV,IAAA,SAwEmB;EAtEnB,IAAA,UAsEmB;EAnEnB,KAAA;AAAA;;KAIU,eAAA;EACV,IAAA,eA2EA;EAzEA,IAAA,UA2EO;EAzEP,EAAA;AAAA;;KAIU,eAAA;EACV,IAAA;EAEA,IAAA,UA2EA;EAzEA,EAAA;AAAA;;;;AAuFF;;;;;AAYA;;;;;KAnFY,YAAA;EACV,IAAA;EAuFE;;;;;EAjFF,IAAA,GAAO,SAAA,EA+EL;EA5EF,KAAA;AAAA;;KAIU,YAAA;EACV,IAAA,YAiFU;EA/EV,IAAA;AAAA;;;;;;;;;AA+FF;;;;;KA/EY,SAAA;;;;;AA+FZ;;;;;AAUA;KA7FY,WAAA;EACV,IAAA,WA4FgC;EA1FhC,IAAA,GAAO,SAAA,EA8FP;EA3FA,KAAA;AAAA;;KAIU,aAAA;EAgGR,iEA9FF,QAAA,UAgGM;EA9FN,IAAA,UA0Ge;EAxGf,OAAA,UAwGsB;EAtGtB,OAAA;AAAA;;;;;;KAQU,YAAA;EAoGgC,sCAjG1C,SAAA;AAAA;;;;;;;KASU,QAAA,GACR,SAAA,GACA,eAAA,GACA,eAAA,GACA,YAAA,GACA,YAAA,GACA,WAAA;;;;;;KAOQ,iBAAA;EAuEN,0BArEJ,WAAA,UAqEoC;EAnEpC,QAAA,UAqEW;EAnEX,OAAA,UAmE4B;EAjE5B,GAAA,EAAK,QAAA;AAAA;;;;;;UAQU,mBAAA;EA6DH;EA3DZ,WAAA;EA2D8B;EAzD9B,QAAA;EA2DA;EAzDA,OAAA;EAyDW;EAvDX,qBAAA;AAAA;;;;;;UAQe,4BAAA;EAiDmD;EA/ClE,qBAAA;AAAA;;;;;;UAQe,iBAAA;;EAEf,IAAA;;EAEA,SAAA;;EAEA,UAAA;;EAEA,OAAA;;EAEA,EAAA;;EAEA,KAAA;IACE,IAAA;IAEA,IAAA;EAAA;AAAA;;;;;;;;;UAYa,OAAA;;EAEf,GAAA,CAAI,KAAA,EAAO,cAAA,GAAiB,OAAA,CAAQ,KAAA;;EAEpC,GAAA,CAAI,KAAA,EAAO,cAAA,GAAiB,OAAA,CAAQ,eAAA,CAAgB,KAAA;;EAEpD,MAAA,CAAO,KAAA,EAAO,iBAAA,GAAoB,OAAA,CAAQ,YAAA;;EAE1C,IAAA,CAAK,KAAA,EAAO,eAAA,GAAkB,OAAA,CAAQ,KAAA;;EAEtC,UAAA,CAAW,KAAA,EAAO,qBAAA,GAAwB,OAAA;;EAE1C,MAAA,CAAO,KAAA,EAAO,iBAAA,GAAoB,OAAA,CAAQ,kBAAA,CAAmB,KAAA;AAAA"}