@osdk/foundry.streams 2.31.0 → 2.32.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.
Files changed (6) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/build/browser/_errors.d.ts +15 -0
  3. package/build/browser/_errors.d.ts.map +1 -1
  4. package/build/esm/_errors.d.ts +15 -0
  5. package/build/esm/_errors.d.ts.map +1 -1
  6. package/package.json +5 -5
package/CHANGELOG.md CHANGED
@@ -1,5 +1,19 @@
1
1
  # @osdk/foundry.streams
2
2
 
3
+ ## 2.32.0
4
+
5
+ ### Minor Changes
6
+
7
+ - 0a711d1: Introduce error descriptions
8
+
9
+ ### Patch Changes
10
+
11
+ - Updated dependencies [0a711d1]
12
+ - @osdk/shared.net.platformapi@1.5.0
13
+ - @osdk/foundry.filesystem@2.32.0
14
+ - @osdk/foundry.datasets@2.32.0
15
+ - @osdk/foundry.core@2.32.0
16
+
3
17
  ## 2.31.0
4
18
 
5
19
  ### Minor Changes
package/build/browser/_errors.d.ts CHANGED
@@ -9,6 +9,7 @@ export type LooselyBrandedString<T extends string> = string & {
9
9
  export interface CannotCreateStreamingDatasetInUserFolder {
10
10
  errorCode: "INVALID_ARGUMENT";
11
11
  errorName: "CannotCreateStreamingDatasetInUserFolder";
12
+ errorDescription: "Cannot create a streaming dataset in a user folder.";
12
13
  errorInstanceId: string;
13
14
  parameters: {
14
15
  parentFolderRid: unknown;
@@ -22,6 +23,7 @@ export interface CannotCreateStreamingDatasetInUserFolder {
22
23
  export interface CannotWriteToTrashedStream {
23
24
  errorCode: "INVALID_ARGUMENT";
24
25
  errorName: "CannotWriteToTrashedStream";
26
+ errorDescription: "Cannot write to a stream that is in the trash.";
25
27
  errorInstanceId: string;
26
28
  parameters: {
27
29
  datasetRid: unknown;
@@ -35,6 +37,7 @@ export interface CannotWriteToTrashedStream {
35
37
  export interface CreateStreamingDatasetPermissionDenied {
36
38
  errorCode: "PERMISSION_DENIED";
37
39
  errorName: "CreateStreamingDatasetPermissionDenied";
40
+ errorDescription: "Could not create the Dataset.";
38
41
  errorInstanceId: string;
39
42
  parameters: {};
40
43
  }
@@ -46,6 +49,7 @@ export interface CreateStreamingDatasetPermissionDenied {
46
49
  export interface CreateStreamPermissionDenied {
47
50
  errorCode: "PERMISSION_DENIED";
48
51
  errorName: "CreateStreamPermissionDenied";
52
+ errorDescription: "Could not create the Stream.";
49
53
  errorInstanceId: string;
50
54
  parameters: {
51
55
  datasetRid: unknown;
@@ -60,6 +64,7 @@ export interface CreateStreamPermissionDenied {
60
64
  export interface FailedToProcessBinaryRecord {
61
65
  errorCode: "INTERNAL";
62
66
  errorName: "FailedToProcessBinaryRecord";
67
+ errorDescription: "The byte stream could not be processed.";
63
68
  errorInstanceId: string;
64
69
  parameters: {};
65
70
  }
@@ -71,6 +76,7 @@ export interface FailedToProcessBinaryRecord {
71
76
  export interface InvalidStreamNoSchema {
72
77
  errorCode: "INVALID_ARGUMENT";
73
78
  errorName: "InvalidStreamNoSchema";
79
+ errorDescription: "The requested stream exists but is invalid, as it does not have a schema.";
74
80
  errorInstanceId: string;
75
81
  parameters: {
76
82
  datasetRid: unknown;
@@ -86,6 +92,7 @@ export interface InvalidStreamNoSchema {
86
92
  export interface InvalidStreamType {
87
93
  errorCode: "INVALID_ARGUMENT";
88
94
  errorName: "InvalidStreamType";
95
+ errorDescription: "The stream type is invalid.";
89
96
  errorInstanceId: string;
90
97
  parameters: {
91
98
  streamType: unknown;
@@ -99,6 +106,7 @@ export interface InvalidStreamType {
99
106
  export interface PublishBinaryRecordToStreamPermissionDenied {
100
107
  errorCode: "PERMISSION_DENIED";
101
108
  errorName: "PublishBinaryRecordToStreamPermissionDenied";
109
+ errorDescription: "Could not publishBinaryRecord the Stream.";
102
110
  errorInstanceId: string;
103
111
  parameters: {
104
112
  datasetRid: unknown;
@@ -113,6 +121,7 @@ export interface PublishBinaryRecordToStreamPermissionDenied {
113
121
  export interface PublishRecordsToStreamPermissionDenied {
114
122
  errorCode: "PERMISSION_DENIED";
115
123
  errorName: "PublishRecordsToStreamPermissionDenied";
124
+ errorDescription: "Could not publishRecords the Stream.";
116
125
  errorInstanceId: string;
117
126
  parameters: {
118
127
  datasetRid: unknown;
@@ -127,6 +136,7 @@ export interface PublishRecordsToStreamPermissionDenied {
127
136
  export interface PublishRecordToStreamPermissionDenied {
128
137
  errorCode: "PERMISSION_DENIED";
129
138
  errorName: "PublishRecordToStreamPermissionDenied";
139
+ errorDescription: "Could not publishRecord the Stream.";
130
140
  errorInstanceId: string;
131
141
  parameters: {
132
142
  datasetRid: unknown;
@@ -141,6 +151,7 @@ export interface PublishRecordToStreamPermissionDenied {
141
151
  export interface RecordDoesNotMatchStreamSchema {
142
152
  errorCode: "INVALID_ARGUMENT";
143
153
  errorName: "RecordDoesNotMatchStreamSchema";
154
+ errorDescription: "A provided record does not match the stream schema";
144
155
  errorInstanceId: string;
145
156
  parameters: {
146
157
  datasetRid: unknown;
@@ -156,6 +167,7 @@ export interface RecordDoesNotMatchStreamSchema {
156
167
  export interface RecordTooLarge {
157
168
  errorCode: "REQUEST_ENTITY_TOO_LARGE";
158
169
  errorName: "RecordTooLarge";
170
+ errorDescription: "A record is too large to be published to the stream. On most enrollments, the maximum record size is 1MB.";
159
171
  errorInstanceId: string;
160
172
  parameters: {};
161
173
  }
@@ -167,6 +179,7 @@ export interface RecordTooLarge {
167
179
  export interface ResetStreamPermissionDenied {
168
180
  errorCode: "PERMISSION_DENIED";
169
181
  errorName: "ResetStreamPermissionDenied";
182
+ errorDescription: "Could not reset the Stream.";
170
183
  errorInstanceId: string;
171
184
  parameters: {
172
185
  datasetRid: unknown;
@@ -181,6 +194,7 @@ export interface ResetStreamPermissionDenied {
181
194
  export interface StreamNotFound {
182
195
  errorCode: "NOT_FOUND";
183
196
  errorName: "StreamNotFound";
197
+ errorDescription: "The given Stream could not be found.";
184
198
  errorInstanceId: string;
185
199
  parameters: {
186
200
  datasetRid: unknown;
@@ -195,6 +209,7 @@ export interface StreamNotFound {
195
209
  export interface ViewNotFound {
196
210
  errorCode: "NOT_FOUND";
197
211
  errorName: "ViewNotFound";
212
+ errorDescription: "No view for the provided view rid provided could be found.";
198
213
  errorInstanceId: string;
199
214
  parameters: {
200
215
  viewRid: unknown;
package/build/browser/_errors.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"_errors.d.ts","sourceRoot":"","sources":["../../src/_errors.ts"],"names":[],"mappings":"AAgBA,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,MAAM,IAAI,MAAM,GAAG;IAC5D,aAAa,CAAC,EAAE,CAAC,CAAC;CACnB,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,wCAAwC;IACvD,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,0CAA0C,CAAC;IACtD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,eAAe,EAAE,OAAO,CAAC;KAC1B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,4BAA4B,CAAC;IACxC,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;KACrB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,sCAAsC;IACrD,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,wCAAwC,CAAC;IACpD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,EAAE,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,8BAA8B,CAAC;IAC1C,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IAC1C,SAAS,EAAE,UAAU,CAAC;IACtB,SAAS,EAAE,6BAA6B,CAAC;IACzC,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,EAAE,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,uBAAuB,CAAC;IACnC,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,UAAU,EAAE,OAAO,CAAC;QACpB,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,mBAAmB,CAAC;IAC/B,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;KACrB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,2CAA2C;IAC1D,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,6CAA6C,CAAC;IACzD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,sCAAsC;IACrD,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,wCAAwC,CAAC;IACpD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,qCAAqC;IACpD,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,uCAAuC,CAAC;IACnD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,8BAA8B;IAC7C,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,gCAAgC,CAAC;IAC5C,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,UAAU,EAAE,OAAO,CAAC;QACpB,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,0BAA0B,CAAC;IACtC,SAAS,EAAE,gBAAgB,CAAC;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,EAAE,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IAC1C,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,6BAA6B,CAAC;IACzC,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,gBAAgB,CAAC;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,cAAc,CAAC;IAC1B,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;CACH"}
1
+ {"version":3,"file":"_errors.d.ts","sourceRoot":"","sources":["../../src/_errors.ts"],"names":[],"mappings":"AAgBA,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,MAAM,IAAI,MAAM,GAAG;IAC5D,aAAa,CAAC,EAAE,CAAC,CAAC;CACnB,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,wCAAwC;IACvD,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,0CAA0C,CAAC;IACtD,gBAAgB,EAAE,qDAAqD,CAAC;IACxE,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,eAAe,EAAE,OAAO,CAAC;KAC1B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,4BAA4B,CAAC;IACxC,gBAAgB,EAAE,gDAAgD,CAAC;IACnE,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;KACrB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,sCAAsC;IACrD,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,wCAAwC,CAAC;IACpD,gBAAgB,EAAE,+BAA+B,CAAC;IAClD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,EAAE,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,8BAA8B,CAAC;IAC1C,gBAAgB,EAAE,8BAA8B,CAAC;IACjD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IAC1C,SAAS,EAAE,UAAU,CAAC;IACtB,SAAS,EAAE,6BAA6B,CAAC;IACzC,gBAAgB,EAAE,yCAAyC,CAAC;IAC5D,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,EAAE,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,uBAAuB,CAAC;IACnC,gBAAgB,EACd,2EAA2E,CAAC;IAC9E,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,UAAU,EAAE,OAAO,CAAC;QACpB,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,mBAAmB,CAAC;IAC/B,gBAAgB,EAAE,6BAA6B,CAAC;IAChD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;KACrB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,2CAA2C;IAC1D,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,6CAA6C,CAAC;IACzD,gBAAgB,EAAE,2CAA2C,CAAC;IAC9D,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,sCAAsC;IACrD,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,wCAAwC,CAAC;IACpD,gBAAgB,EAAE,sCAAsC,CAAC;IACzD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,qCAAqC;IACpD,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,uCAAuC,CAAC;IACnD,gBAAgB,EAAE,qCAAqC,CAAC;IACxD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,8BAA8B;IAC7C,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,gCAAgC,CAAC;IAC5C,gBAAgB,EAAE,oDAAoD,CAAC;IACvE,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,UAAU,EAAE,OAAO,CAAC;QACpB,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,0BAA0B,CAAC;IACtC,SAAS,EAAE,gBAAgB,CAAC;IAC5B,gBAAgB,EACd,2GAA2G,CAAC;IAC9G,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,EAAE,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IAC1C,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,6BAA6B,CAAC;IACzC,gBAAgB,EAAE,6BAA6B,CAAC;IAChD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,gBAAgB,CAAC;IAC5B,gBAAgB,EAAE,sCAAsC,CAAC;IACzD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,cAAc,CAAC;IAC1B,gBAAgB,EACd,4DAA4D,CAAC;IAC/D,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;CACH"}
package/build/esm/_errors.d.ts CHANGED
@@ -9,6 +9,7 @@ export type LooselyBrandedString<T extends string> = string & {
9
9
  export interface CannotCreateStreamingDatasetInUserFolder {
10
10
  errorCode: "INVALID_ARGUMENT";
11
11
  errorName: "CannotCreateStreamingDatasetInUserFolder";
12
+ errorDescription: "Cannot create a streaming dataset in a user folder.";
12
13
  errorInstanceId: string;
13
14
  parameters: {
14
15
  parentFolderRid: unknown;
@@ -22,6 +23,7 @@ export interface CannotCreateStreamingDatasetInUserFolder {
22
23
  export interface CannotWriteToTrashedStream {
23
24
  errorCode: "INVALID_ARGUMENT";
24
25
  errorName: "CannotWriteToTrashedStream";
26
+ errorDescription: "Cannot write to a stream that is in the trash.";
25
27
  errorInstanceId: string;
26
28
  parameters: {
27
29
  datasetRid: unknown;
@@ -35,6 +37,7 @@ export interface CannotWriteToTrashedStream {
35
37
  export interface CreateStreamingDatasetPermissionDenied {
36
38
  errorCode: "PERMISSION_DENIED";
37
39
  errorName: "CreateStreamingDatasetPermissionDenied";
40
+ errorDescription: "Could not create the Dataset.";
38
41
  errorInstanceId: string;
39
42
  parameters: {};
40
43
  }
@@ -46,6 +49,7 @@ export interface CreateStreamingDatasetPermissionDenied {
46
49
  export interface CreateStreamPermissionDenied {
47
50
  errorCode: "PERMISSION_DENIED";
48
51
  errorName: "CreateStreamPermissionDenied";
52
+ errorDescription: "Could not create the Stream.";
49
53
  errorInstanceId: string;
50
54
  parameters: {
51
55
  datasetRid: unknown;
@@ -60,6 +64,7 @@ export interface CreateStreamPermissionDenied {
60
64
  export interface FailedToProcessBinaryRecord {
61
65
  errorCode: "INTERNAL";
62
66
  errorName: "FailedToProcessBinaryRecord";
67
+ errorDescription: "The byte stream could not be processed.";
63
68
  errorInstanceId: string;
64
69
  parameters: {};
65
70
  }
@@ -71,6 +76,7 @@ export interface FailedToProcessBinaryRecord {
71
76
  export interface InvalidStreamNoSchema {
72
77
  errorCode: "INVALID_ARGUMENT";
73
78
  errorName: "InvalidStreamNoSchema";
79
+ errorDescription: "The requested stream exists but is invalid, as it does not have a schema.";
74
80
  errorInstanceId: string;
75
81
  parameters: {
76
82
  datasetRid: unknown;
@@ -86,6 +92,7 @@ export interface InvalidStreamNoSchema {
86
92
  export interface InvalidStreamType {
87
93
  errorCode: "INVALID_ARGUMENT";
88
94
  errorName: "InvalidStreamType";
95
+ errorDescription: "The stream type is invalid.";
89
96
  errorInstanceId: string;
90
97
  parameters: {
91
98
  streamType: unknown;
@@ -99,6 +106,7 @@ export interface InvalidStreamType {
99
106
  export interface PublishBinaryRecordToStreamPermissionDenied {
100
107
  errorCode: "PERMISSION_DENIED";
101
108
  errorName: "PublishBinaryRecordToStreamPermissionDenied";
109
+ errorDescription: "Could not publishBinaryRecord the Stream.";
102
110
  errorInstanceId: string;
103
111
  parameters: {
104
112
  datasetRid: unknown;
@@ -113,6 +121,7 @@ export interface PublishBinaryRecordToStreamPermissionDenied {
113
121
  export interface PublishRecordsToStreamPermissionDenied {
114
122
  errorCode: "PERMISSION_DENIED";
115
123
  errorName: "PublishRecordsToStreamPermissionDenied";
124
+ errorDescription: "Could not publishRecords the Stream.";
116
125
  errorInstanceId: string;
117
126
  parameters: {
118
127
  datasetRid: unknown;
@@ -127,6 +136,7 @@ export interface PublishRecordsToStreamPermissionDenied {
127
136
  export interface PublishRecordToStreamPermissionDenied {
128
137
  errorCode: "PERMISSION_DENIED";
129
138
  errorName: "PublishRecordToStreamPermissionDenied";
139
+ errorDescription: "Could not publishRecord the Stream.";
130
140
  errorInstanceId: string;
131
141
  parameters: {
132
142
  datasetRid: unknown;
@@ -141,6 +151,7 @@ export interface PublishRecordToStreamPermissionDenied {
141
151
  export interface RecordDoesNotMatchStreamSchema {
142
152
  errorCode: "INVALID_ARGUMENT";
143
153
  errorName: "RecordDoesNotMatchStreamSchema";
154
+ errorDescription: "A provided record does not match the stream schema";
144
155
  errorInstanceId: string;
145
156
  parameters: {
146
157
  datasetRid: unknown;
@@ -156,6 +167,7 @@ export interface RecordDoesNotMatchStreamSchema {
156
167
  export interface RecordTooLarge {
157
168
  errorCode: "REQUEST_ENTITY_TOO_LARGE";
158
169
  errorName: "RecordTooLarge";
170
+ errorDescription: "A record is too large to be published to the stream. On most enrollments, the maximum record size is 1MB.";
159
171
  errorInstanceId: string;
160
172
  parameters: {};
161
173
  }
@@ -167,6 +179,7 @@ export interface RecordTooLarge {
167
179
  export interface ResetStreamPermissionDenied {
168
180
  errorCode: "PERMISSION_DENIED";
169
181
  errorName: "ResetStreamPermissionDenied";
182
+ errorDescription: "Could not reset the Stream.";
170
183
  errorInstanceId: string;
171
184
  parameters: {
172
185
  datasetRid: unknown;
@@ -181,6 +194,7 @@ export interface ResetStreamPermissionDenied {
181
194
  export interface StreamNotFound {
182
195
  errorCode: "NOT_FOUND";
183
196
  errorName: "StreamNotFound";
197
+ errorDescription: "The given Stream could not be found.";
184
198
  errorInstanceId: string;
185
199
  parameters: {
186
200
  datasetRid: unknown;
@@ -195,6 +209,7 @@ export interface StreamNotFound {
195
209
  export interface ViewNotFound {
196
210
  errorCode: "NOT_FOUND";
197
211
  errorName: "ViewNotFound";
212
+ errorDescription: "No view for the provided view rid provided could be found.";
198
213
  errorInstanceId: string;
199
214
  parameters: {
200
215
  viewRid: unknown;
package/build/esm/_errors.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"_errors.d.ts","sourceRoot":"","sources":["../../src/_errors.ts"],"names":[],"mappings":"AAgBA,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,MAAM,IAAI,MAAM,GAAG;IAC5D,aAAa,CAAC,EAAE,CAAC,CAAC;CACnB,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,wCAAwC;IACvD,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,0CAA0C,CAAC;IACtD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,eAAe,EAAE,OAAO,CAAC;KAC1B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,4BAA4B,CAAC;IACxC,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;KACrB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,sCAAsC;IACrD,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,wCAAwC,CAAC;IACpD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,EAAE,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,8BAA8B,CAAC;IAC1C,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IAC1C,SAAS,EAAE,UAAU,CAAC;IACtB,SAAS,EAAE,6BAA6B,CAAC;IACzC,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,EAAE,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,uBAAuB,CAAC;IACnC,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,UAAU,EAAE,OAAO,CAAC;QACpB,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,mBAAmB,CAAC;IAC/B,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;KACrB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,2CAA2C;IAC1D,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,6CAA6C,CAAC;IACzD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,sCAAsC;IACrD,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,wCAAwC,CAAC;IACpD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,qCAAqC;IACpD,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,uCAAuC,CAAC;IACnD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,8BAA8B;IAC7C,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,gCAAgC,CAAC;IAC5C,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,UAAU,EAAE,OAAO,CAAC;QACpB,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,0BAA0B,CAAC;IACtC,SAAS,EAAE,gBAAgB,CAAC;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,EAAE,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IAC1C,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,6BAA6B,CAAC;IACzC,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,gBAAgB,CAAC;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,cAAc,CAAC;IAC1B,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;CACH"}
1
+ {"version":3,"file":"_errors.d.ts","sourceRoot":"","sources":["../../src/_errors.ts"],"names":[],"mappings":"AAgBA,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,MAAM,IAAI,MAAM,GAAG;IAC5D,aAAa,CAAC,EAAE,CAAC,CAAC;CACnB,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,wCAAwC;IACvD,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,0CAA0C,CAAC;IACtD,gBAAgB,EAAE,qDAAqD,CAAC;IACxE,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,eAAe,EAAE,OAAO,CAAC;KAC1B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,4BAA4B,CAAC;IACxC,gBAAgB,EAAE,gDAAgD,CAAC;IACnE,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;KACrB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,sCAAsC;IACrD,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,wCAAwC,CAAC;IACpD,gBAAgB,EAAE,+BAA+B,CAAC;IAClD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,EAAE,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,8BAA8B,CAAC;IAC1C,gBAAgB,EAAE,8BAA8B,CAAC;IACjD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IAC1C,SAAS,EAAE,UAAU,CAAC;IACtB,SAAS,EAAE,6BAA6B,CAAC;IACzC,gBAAgB,EAAE,yCAAyC,CAAC;IAC5D,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,EAAE,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,uBAAuB,CAAC;IACnC,gBAAgB,EACd,2EAA2E,CAAC;IAC9E,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,UAAU,EAAE,OAAO,CAAC;QACpB,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,mBAAmB,CAAC;IAC/B,gBAAgB,EAAE,6BAA6B,CAAC;IAChD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;KACrB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,2CAA2C;IAC1D,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,6CAA6C,CAAC;IACzD,gBAAgB,EAAE,2CAA2C,CAAC;IAC9D,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,sCAAsC;IACrD,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,wCAAwC,CAAC;IACpD,gBAAgB,EAAE,sCAAsC,CAAC;IACzD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,qCAAqC;IACpD,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,uCAAuC,CAAC;IACnD,gBAAgB,EAAE,qCAAqC,CAAC;IACxD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,8BAA8B;IAC7C,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,gCAAgC,CAAC;IAC5C,gBAAgB,EAAE,oDAAoD,CAAC;IACvE,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,UAAU,EAAE,OAAO,CAAC;QACpB,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,0BAA0B,CAAC;IACtC,SAAS,EAAE,gBAAgB,CAAC;IAC5B,gBAAgB,EACd,2GAA2G,CAAC;IAC9G,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,EAAE,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IAC1C,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,6BAA6B,CAAC;IACzC,gBAAgB,EAAE,6BAA6B,CAAC;IAChD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,gBAAgB,CAAC;IAC5B,gBAAgB,EAAE,sCAAsC,CAAC;IACzD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;QACpB,gBAAgB,EAAE,OAAO,CAAC;KAC3B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,cAAc,CAAC;IAC1B,gBAAgB,EACd,4DAA4D,CAAC;IAC/D,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;CACH"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@osdk/foundry.streams",
3
- "version": "2.31.0",
3
+ "version": "2.32.0",
4
4
  "license": "Apache-2.0",
5
5
  "repository": {
6
6
  "type": "git",
@@ -21,10 +21,10 @@
21
21
  "dependencies": {
22
22
  "@osdk/shared.client": "^1.0.1",
23
23
  "@osdk/shared.client2": "^1.0.0",
24
- "@osdk/foundry.core": "2.31.0",
25
- "@osdk/foundry.datasets": "2.31.0",
26
- "@osdk/shared.net.platformapi": "~1.4.0",
27
- "@osdk/foundry.filesystem": "2.31.0"
24
+ "@osdk/foundry.core": "2.32.0",
25
+ "@osdk/foundry.datasets": "2.32.0",
26
+ "@osdk/shared.net.platformapi": "~1.5.0",
27
+ "@osdk/foundry.filesystem": "2.32.0"
28
28
  },
29
29
  "devDependencies": {
30
30
  "typescript": "^5.5.4",