@osdk/foundry.functions 2.30.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 +23 -0
  2. package/build/browser/_errors.d.ts +14 -0
  3. package/build/browser/_errors.d.ts.map +1 -1
  4. package/build/esm/_errors.d.ts +14 -0
  5. package/build/esm/_errors.d.ts.map +1 -1
  6. package/package.json +4 -4
package/CHANGELOG.md CHANGED
@@ -1,5 +1,28 @@
1
1
  # @osdk/foundry.functions
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.core@2.32.0
14
+
15
+ ## 2.31.0
16
+
17
+ ### Minor Changes
18
+
19
+ - 85be85a: Regenerated SDKs
20
+
21
+ ### Patch Changes
22
+
23
+ - Updated dependencies [85be85a]
24
+ - @osdk/foundry.core@2.31.0
25
+
3
26
  ## 2.30.0
4
27
 
5
28
  ### Minor Changes
package/build/browser/_errors.d.ts CHANGED
@@ -9,6 +9,7 @@ export type LooselyBrandedString<T extends string> = string & {
9
9
  export interface ExecuteQueryPermissionDenied {
10
10
  errorCode: "PERMISSION_DENIED";
11
11
  errorName: "ExecuteQueryPermissionDenied";
12
+ errorDescription: "Could not execute the Query.";
12
13
  errorInstanceId: string;
13
14
  parameters: {
14
15
  queryApiName: unknown;
@@ -22,6 +23,7 @@ export interface ExecuteQueryPermissionDenied {
22
23
  export interface GetByRidQueriesPermissionDenied {
23
24
  errorCode: "PERMISSION_DENIED";
24
25
  errorName: "GetByRidQueriesPermissionDenied";
26
+ errorDescription: "Could not getByRid the Query.";
25
27
  errorInstanceId: string;
26
28
  parameters: {};
27
29
  }
@@ -34,6 +36,7 @@ output type or constraints.
34
36
  export interface InvalidQueryOutputValue {
35
37
  errorCode: "INVALID_ARGUMENT";
36
38
  errorName: "InvalidQueryOutputValue";
39
+ errorDescription: "The value of the query's output is invalid. This may be because the return value did not match the specified output type or constraints.";
37
40
  errorInstanceId: string;
38
41
  parameters: {
39
42
  outputDataType: unknown;
@@ -51,6 +54,7 @@ how parameters are represented.
51
54
  export interface InvalidQueryParameterValue {
52
55
  errorCode: "INVALID_ARGUMENT";
53
56
  errorName: "InvalidQueryParameterValue";
57
+ errorDescription: "The value of the given parameter is invalid. See the documentation of DataValue for details on how parameters are represented.";
54
58
  errorInstanceId: string;
55
59
  parameters: {
56
60
  parameterDataType: unknown;
@@ -67,6 +71,7 @@ missing from the request.
67
71
  export interface MissingParameter {
68
72
  errorCode: "INVALID_ARGUMENT";
69
73
  errorName: "MissingParameter";
74
+ errorDescription: "Required parameters are missing. Please look at the parameters field to see which required parameters are missing from the request.";
70
75
  errorInstanceId: string;
71
76
  parameters: {
72
77
  parameters: unknown;
@@ -81,6 +86,7 @@ is meant to be displayed to the user.
81
86
  export interface QueryEncounteredUserFacingError {
82
87
  errorCode: "CONFLICT";
83
88
  errorName: "QueryEncounteredUserFacingError";
89
+ errorDescription: "The authored Query failed to execute because of a user induced error. The message argument is meant to be displayed to the user.";
84
90
  errorInstanceId: string;
85
91
  parameters: {
86
92
  functionRid: unknown;
@@ -96,6 +102,7 @@ export interface QueryEncounteredUserFacingError {
96
102
  export interface QueryMemoryExceededLimit {
97
103
  errorCode: "TIMEOUT";
98
104
  errorName: "QueryMemoryExceededLimit";
105
+ errorDescription: "Memory limits were exceeded for the Query execution.";
99
106
  errorInstanceId: string;
100
107
  parameters: {
101
108
  functionRid: unknown;
@@ -110,6 +117,7 @@ export interface QueryMemoryExceededLimit {
110
117
  export interface QueryNotFound {
111
118
  errorCode: "NOT_FOUND";
112
119
  errorName: "QueryNotFound";
120
+ errorDescription: "The given Query could not be found.";
113
121
  errorInstanceId: string;
114
122
  parameters: {
115
123
  queryApiName: unknown;
@@ -123,6 +131,7 @@ export interface QueryNotFound {
123
131
  export interface QueryRuntimeError {
124
132
  errorCode: "INVALID_ARGUMENT";
125
133
  errorName: "QueryRuntimeError";
134
+ errorDescription: "The authored Query failed to execute because of a runtime error.";
126
135
  errorInstanceId: string;
127
136
  parameters: {
128
137
  functionRid: unknown;
@@ -140,6 +149,7 @@ export interface QueryRuntimeError {
140
149
  export interface QueryTimeExceededLimit {
141
150
  errorCode: "TIMEOUT";
142
151
  errorName: "QueryTimeExceededLimit";
152
+ errorDescription: "Time limits were exceeded for the Query execution.";
143
153
  errorInstanceId: string;
144
154
  parameters: {
145
155
  functionRid: unknown;
@@ -154,6 +164,7 @@ export interface QueryTimeExceededLimit {
154
164
  export interface QueryVersionNotFound {
155
165
  errorCode: "NOT_FOUND";
156
166
  errorName: "QueryVersionNotFound";
167
+ errorDescription: "The query could not be found at the provided version.";
157
168
  errorInstanceId: string;
158
169
  parameters: {
159
170
  apiName: unknown;
@@ -169,6 +180,7 @@ to see which ones are available.
169
180
  export interface UnknownParameter {
170
181
  errorCode: "INVALID_ARGUMENT";
171
182
  errorName: "UnknownParameter";
183
+ errorDescription: "The provided parameters were not found. Please look at the knownParameters field to see which ones are available.";
172
184
  errorInstanceId: string;
173
185
  parameters: {
174
186
  unknownParameters: unknown;
@@ -183,6 +195,7 @@ export interface UnknownParameter {
183
195
  export interface ValueTypeNotFound {
184
196
  errorCode: "NOT_FOUND";
185
197
  errorName: "ValueTypeNotFound";
198
+ errorDescription: "The given ValueType could not be found.";
186
199
  errorInstanceId: string;
187
200
  parameters: {
188
201
  valueTypeRid: unknown;
@@ -196,6 +209,7 @@ export interface ValueTypeNotFound {
196
209
  export interface VersionIdNotFound {
197
210
  errorCode: "NOT_FOUND";
198
211
  errorName: "VersionIdNotFound";
212
+ errorDescription: "The given VersionId could not be found.";
199
213
  errorInstanceId: string;
200
214
  parameters: {
201
215
  valueTypeRid: 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,4BAA4B;IAC3C,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,8BAA8B,CAAC;IAC1C,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,YAAY,EAAE,OAAO,CAAC;KACvB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,+BAA+B;IAC9C,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,iCAAiC,CAAC;IAC7C,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,EAAE,CAAC;CAChB;AAED;;;;;KAKK;AACL,MAAM,WAAW,uBAAuB;IACtC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,yBAAyB,CAAC;IACrC,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,cAAc,EAAE,OAAO,CAAC;QACxB,WAAW,EAAE,OAAO,CAAC;QACrB,WAAW,EAAE,OAAO,CAAC;QACrB,eAAe,EAAE,OAAO,CAAC;KAC1B,CAAC;CACH;AAED;;;;;KAKK;AACL,MAAM,WAAW,0BAA0B;IACzC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,4BAA4B,CAAC;IACxC,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,iBAAiB,EAAE,OAAO,CAAC;QAC3B,WAAW,EAAE,OAAO,CAAC;QACrB,cAAc,EAAE,OAAO,CAAC;KACzB,CAAC;CACH;AAED;;;;;KAKK;AACL,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,kBAAkB,CAAC;IAC9B,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;KACrB,CAAC;CACH;AAED;;;;;KAKK;AACL,MAAM,WAAW,+BAA+B;IAC9C,SAAS,EAAE,UAAU,CAAC;IACtB,SAAS,EAAE,iCAAiC,CAAC;IAC7C,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,WAAW,EAAE,OAAO,CAAC;QACrB,eAAe,EAAE,OAAO,CAAC;QACzB,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACvC,SAAS,EAAE,SAAS,CAAC;IACrB,SAAS,EAAE,0BAA0B,CAAC;IACtC,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,WAAW,EAAE,OAAO,CAAC;QACrB,eAAe,EAAE,OAAO,CAAC;KAC1B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,eAAe,CAAC;IAC3B,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,YAAY,EAAE,OAAO,CAAC;KACvB,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,WAAW,EAAE,OAAO,CAAC;QACrB,eAAe,EAAE,OAAO,CAAC;QACzB,OAAO,EAAE,OAAO,CAAC;QACjB,UAAU,EAAE,OAAO,CAAC;QACpB,UAAU,EAAE,OAAO,CAAC;KACrB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,SAAS,EAAE,SAAS,CAAC;IACrB,SAAS,EAAE,wBAAwB,CAAC;IACpC,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,WAAW,EAAE,OAAO,CAAC;QACrB,eAAe,EAAE,OAAO,CAAC;KAC1B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,sBAAsB,CAAC;IAClC,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,OAAO,EAAE,OAAO,CAAC;QACjB,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;CACH;AAED;;;;;KAKK;AACL,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,kBAAkB,CAAC;IAC9B,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,iBAAiB,EAAE,OAAO,CAAC;QAC3B,kBAAkB,EAAE,OAAO,CAAC;KAC7B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,mBAAmB,CAAC;IAC/B,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,YAAY,EAAE,OAAO,CAAC;KACvB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,mBAAmB,CAAC;IAC/B,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,YAAY,EAAE,OAAO,CAAC;QACtB,kBAAkB,EAAE,OAAO,CAAC;KAC7B,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,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,YAAY,EAAE,OAAO,CAAC;KACvB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,+BAA+B;IAC9C,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,iCAAiC,CAAC;IAC7C,gBAAgB,EAAE,+BAA+B,CAAC;IAClD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,EAAE,CAAC;CAChB;AAED;;;;;KAKK;AACL,MAAM,WAAW,uBAAuB;IACtC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,yBAAyB,CAAC;IACrC,gBAAgB,EACd,0IAA0I,CAAC;IAC7I,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,cAAc,EAAE,OAAO,CAAC;QACxB,WAAW,EAAE,OAAO,CAAC;QACrB,WAAW,EAAE,OAAO,CAAC;QACrB,eAAe,EAAE,OAAO,CAAC;KAC1B,CAAC;CACH;AAED;;;;;KAKK;AACL,MAAM,WAAW,0BAA0B;IACzC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,4BAA4B,CAAC;IACxC,gBAAgB,EACd,gIAAgI,CAAC;IACnI,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,iBAAiB,EAAE,OAAO,CAAC;QAC3B,WAAW,EAAE,OAAO,CAAC;QACrB,cAAc,EAAE,OAAO,CAAC;KACzB,CAAC;CACH;AAED;;;;;KAKK;AACL,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,kBAAkB,CAAC;IAC9B,gBAAgB,EACd,qIAAqI,CAAC;IACxI,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;KACrB,CAAC;CACH;AAED;;;;;KAKK;AACL,MAAM,WAAW,+BAA+B;IAC9C,SAAS,EAAE,UAAU,CAAC;IACtB,SAAS,EAAE,iCAAiC,CAAC;IAC7C,gBAAgB,EACd,kIAAkI,CAAC;IACrI,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,WAAW,EAAE,OAAO,CAAC;QACrB,eAAe,EAAE,OAAO,CAAC;QACzB,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACvC,SAAS,EAAE,SAAS,CAAC;IACrB,SAAS,EAAE,0BAA0B,CAAC;IACtC,gBAAgB,EAAE,sDAAsD,CAAC;IACzE,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,WAAW,EAAE,OAAO,CAAC;QACrB,eAAe,EAAE,OAAO,CAAC;KAC1B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,eAAe,CAAC;IAC3B,gBAAgB,EAAE,qCAAqC,CAAC;IACxD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,YAAY,EAAE,OAAO,CAAC;KACvB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,mBAAmB,CAAC;IAC/B,gBAAgB,EACd,kEAAkE,CAAC;IACrE,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,WAAW,EAAE,OAAO,CAAC;QACrB,eAAe,EAAE,OAAO,CAAC;QACzB,OAAO,EAAE,OAAO,CAAC;QACjB,UAAU,EAAE,OAAO,CAAC;QACpB,UAAU,EAAE,OAAO,CAAC;KACrB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,SAAS,EAAE,SAAS,CAAC;IACrB,SAAS,EAAE,wBAAwB,CAAC;IACpC,gBAAgB,EAAE,oDAAoD,CAAC;IACvE,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,WAAW,EAAE,OAAO,CAAC;QACrB,eAAe,EAAE,OAAO,CAAC;KAC1B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,sBAAsB,CAAC;IAClC,gBAAgB,EAAE,uDAAuD,CAAC;IAC1E,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,OAAO,EAAE,OAAO,CAAC;QACjB,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;CACH;AAED;;;;;KAKK;AACL,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,kBAAkB,CAAC;IAC9B,gBAAgB,EACd,mHAAmH,CAAC;IACtH,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,iBAAiB,EAAE,OAAO,CAAC;QAC3B,kBAAkB,EAAE,OAAO,CAAC;KAC7B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,mBAAmB,CAAC;IAC/B,gBAAgB,EAAE,yCAAyC,CAAC;IAC5D,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,YAAY,EAAE,OAAO,CAAC;KACvB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,mBAAmB,CAAC;IAC/B,gBAAgB,EAAE,yCAAyC,CAAC;IAC5D,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,YAAY,EAAE,OAAO,CAAC;QACtB,kBAAkB,EAAE,OAAO,CAAC;KAC7B,CAAC;CACH"}
package/build/esm/_errors.d.ts CHANGED
@@ -9,6 +9,7 @@ export type LooselyBrandedString<T extends string> = string & {
9
9
  export interface ExecuteQueryPermissionDenied {
10
10
  errorCode: "PERMISSION_DENIED";
11
11
  errorName: "ExecuteQueryPermissionDenied";
12
+ errorDescription: "Could not execute the Query.";
12
13
  errorInstanceId: string;
13
14
  parameters: {
14
15
  queryApiName: unknown;
@@ -22,6 +23,7 @@ export interface ExecuteQueryPermissionDenied {
22
23
  export interface GetByRidQueriesPermissionDenied {
23
24
  errorCode: "PERMISSION_DENIED";
24
25
  errorName: "GetByRidQueriesPermissionDenied";
26
+ errorDescription: "Could not getByRid the Query.";
25
27
  errorInstanceId: string;
26
28
  parameters: {};
27
29
  }
@@ -34,6 +36,7 @@ output type or constraints.
34
36
  export interface InvalidQueryOutputValue {
35
37
  errorCode: "INVALID_ARGUMENT";
36
38
  errorName: "InvalidQueryOutputValue";
39
+ errorDescription: "The value of the query's output is invalid. This may be because the return value did not match the specified output type or constraints.";
37
40
  errorInstanceId: string;
38
41
  parameters: {
39
42
  outputDataType: unknown;
@@ -51,6 +54,7 @@ how parameters are represented.
51
54
  export interface InvalidQueryParameterValue {
52
55
  errorCode: "INVALID_ARGUMENT";
53
56
  errorName: "InvalidQueryParameterValue";
57
+ errorDescription: "The value of the given parameter is invalid. See the documentation of DataValue for details on how parameters are represented.";
54
58
  errorInstanceId: string;
55
59
  parameters: {
56
60
  parameterDataType: unknown;
@@ -67,6 +71,7 @@ missing from the request.
67
71
  export interface MissingParameter {
68
72
  errorCode: "INVALID_ARGUMENT";
69
73
  errorName: "MissingParameter";
74
+ errorDescription: "Required parameters are missing. Please look at the parameters field to see which required parameters are missing from the request.";
70
75
  errorInstanceId: string;
71
76
  parameters: {
72
77
  parameters: unknown;
@@ -81,6 +86,7 @@ is meant to be displayed to the user.
81
86
  export interface QueryEncounteredUserFacingError {
82
87
  errorCode: "CONFLICT";
83
88
  errorName: "QueryEncounteredUserFacingError";
89
+ errorDescription: "The authored Query failed to execute because of a user induced error. The message argument is meant to be displayed to the user.";
84
90
  errorInstanceId: string;
85
91
  parameters: {
86
92
  functionRid: unknown;
@@ -96,6 +102,7 @@ export interface QueryEncounteredUserFacingError {
96
102
  export interface QueryMemoryExceededLimit {
97
103
  errorCode: "TIMEOUT";
98
104
  errorName: "QueryMemoryExceededLimit";
105
+ errorDescription: "Memory limits were exceeded for the Query execution.";
99
106
  errorInstanceId: string;
100
107
  parameters: {
101
108
  functionRid: unknown;
@@ -110,6 +117,7 @@ export interface QueryMemoryExceededLimit {
110
117
  export interface QueryNotFound {
111
118
  errorCode: "NOT_FOUND";
112
119
  errorName: "QueryNotFound";
120
+ errorDescription: "The given Query could not be found.";
113
121
  errorInstanceId: string;
114
122
  parameters: {
115
123
  queryApiName: unknown;
@@ -123,6 +131,7 @@ export interface QueryNotFound {
123
131
  export interface QueryRuntimeError {
124
132
  errorCode: "INVALID_ARGUMENT";
125
133
  errorName: "QueryRuntimeError";
134
+ errorDescription: "The authored Query failed to execute because of a runtime error.";
126
135
  errorInstanceId: string;
127
136
  parameters: {
128
137
  functionRid: unknown;
@@ -140,6 +149,7 @@ export interface QueryRuntimeError {
140
149
  export interface QueryTimeExceededLimit {
141
150
  errorCode: "TIMEOUT";
142
151
  errorName: "QueryTimeExceededLimit";
152
+ errorDescription: "Time limits were exceeded for the Query execution.";
143
153
  errorInstanceId: string;
144
154
  parameters: {
145
155
  functionRid: unknown;
@@ -154,6 +164,7 @@ export interface QueryTimeExceededLimit {
154
164
  export interface QueryVersionNotFound {
155
165
  errorCode: "NOT_FOUND";
156
166
  errorName: "QueryVersionNotFound";
167
+ errorDescription: "The query could not be found at the provided version.";
157
168
  errorInstanceId: string;
158
169
  parameters: {
159
170
  apiName: unknown;
@@ -169,6 +180,7 @@ to see which ones are available.
169
180
  export interface UnknownParameter {
170
181
  errorCode: "INVALID_ARGUMENT";
171
182
  errorName: "UnknownParameter";
183
+ errorDescription: "The provided parameters were not found. Please look at the knownParameters field to see which ones are available.";
172
184
  errorInstanceId: string;
173
185
  parameters: {
174
186
  unknownParameters: unknown;
@@ -183,6 +195,7 @@ export interface UnknownParameter {
183
195
  export interface ValueTypeNotFound {
184
196
  errorCode: "NOT_FOUND";
185
197
  errorName: "ValueTypeNotFound";
198
+ errorDescription: "The given ValueType could not be found.";
186
199
  errorInstanceId: string;
187
200
  parameters: {
188
201
  valueTypeRid: unknown;
@@ -196,6 +209,7 @@ export interface ValueTypeNotFound {
196
209
  export interface VersionIdNotFound {
197
210
  errorCode: "NOT_FOUND";
198
211
  errorName: "VersionIdNotFound";
212
+ errorDescription: "The given VersionId could not be found.";
199
213
  errorInstanceId: string;
200
214
  parameters: {
201
215
  valueTypeRid: 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,4BAA4B;IAC3C,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,8BAA8B,CAAC;IAC1C,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,YAAY,EAAE,OAAO,CAAC;KACvB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,+BAA+B;IAC9C,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,iCAAiC,CAAC;IAC7C,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,EAAE,CAAC;CAChB;AAED;;;;;KAKK;AACL,MAAM,WAAW,uBAAuB;IACtC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,yBAAyB,CAAC;IACrC,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,cAAc,EAAE,OAAO,CAAC;QACxB,WAAW,EAAE,OAAO,CAAC;QACrB,WAAW,EAAE,OAAO,CAAC;QACrB,eAAe,EAAE,OAAO,CAAC;KAC1B,CAAC;CACH;AAED;;;;;KAKK;AACL,MAAM,WAAW,0BAA0B;IACzC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,4BAA4B,CAAC;IACxC,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,iBAAiB,EAAE,OAAO,CAAC;QAC3B,WAAW,EAAE,OAAO,CAAC;QACrB,cAAc,EAAE,OAAO,CAAC;KACzB,CAAC;CACH;AAED;;;;;KAKK;AACL,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,kBAAkB,CAAC;IAC9B,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;KACrB,CAAC;CACH;AAED;;;;;KAKK;AACL,MAAM,WAAW,+BAA+B;IAC9C,SAAS,EAAE,UAAU,CAAC;IACtB,SAAS,EAAE,iCAAiC,CAAC;IAC7C,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,WAAW,EAAE,OAAO,CAAC;QACrB,eAAe,EAAE,OAAO,CAAC;QACzB,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACvC,SAAS,EAAE,SAAS,CAAC;IACrB,SAAS,EAAE,0BAA0B,CAAC;IACtC,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,WAAW,EAAE,OAAO,CAAC;QACrB,eAAe,EAAE,OAAO,CAAC;KAC1B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,eAAe,CAAC;IAC3B,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,YAAY,EAAE,OAAO,CAAC;KACvB,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,WAAW,EAAE,OAAO,CAAC;QACrB,eAAe,EAAE,OAAO,CAAC;QACzB,OAAO,EAAE,OAAO,CAAC;QACjB,UAAU,EAAE,OAAO,CAAC;QACpB,UAAU,EAAE,OAAO,CAAC;KACrB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,SAAS,EAAE,SAAS,CAAC;IACrB,SAAS,EAAE,wBAAwB,CAAC;IACpC,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,WAAW,EAAE,OAAO,CAAC;QACrB,eAAe,EAAE,OAAO,CAAC;KAC1B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,sBAAsB,CAAC;IAClC,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,OAAO,EAAE,OAAO,CAAC;QACjB,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;CACH;AAED;;;;;KAKK;AACL,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,kBAAkB,CAAC;IAC9B,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,iBAAiB,EAAE,OAAO,CAAC;QAC3B,kBAAkB,EAAE,OAAO,CAAC;KAC7B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,mBAAmB,CAAC;IAC/B,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,YAAY,EAAE,OAAO,CAAC;KACvB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,mBAAmB,CAAC;IAC/B,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,YAAY,EAAE,OAAO,CAAC;QACtB,kBAAkB,EAAE,OAAO,CAAC;KAC7B,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,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,YAAY,EAAE,OAAO,CAAC;KACvB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,+BAA+B;IAC9C,SAAS,EAAE,mBAAmB,CAAC;IAC/B,SAAS,EAAE,iCAAiC,CAAC;IAC7C,gBAAgB,EAAE,+BAA+B,CAAC;IAClD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,EAAE,CAAC;CAChB;AAED;;;;;KAKK;AACL,MAAM,WAAW,uBAAuB;IACtC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,yBAAyB,CAAC;IACrC,gBAAgB,EACd,0IAA0I,CAAC;IAC7I,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,cAAc,EAAE,OAAO,CAAC;QACxB,WAAW,EAAE,OAAO,CAAC;QACrB,WAAW,EAAE,OAAO,CAAC;QACrB,eAAe,EAAE,OAAO,CAAC;KAC1B,CAAC;CACH;AAED;;;;;KAKK;AACL,MAAM,WAAW,0BAA0B;IACzC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,4BAA4B,CAAC;IACxC,gBAAgB,EACd,gIAAgI,CAAC;IACnI,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,iBAAiB,EAAE,OAAO,CAAC;QAC3B,WAAW,EAAE,OAAO,CAAC;QACrB,cAAc,EAAE,OAAO,CAAC;KACzB,CAAC;CACH;AAED;;;;;KAKK;AACL,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,kBAAkB,CAAC;IAC9B,gBAAgB,EACd,qIAAqI,CAAC;IACxI,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,UAAU,EAAE,OAAO,CAAC;KACrB,CAAC;CACH;AAED;;;;;KAKK;AACL,MAAM,WAAW,+BAA+B;IAC9C,SAAS,EAAE,UAAU,CAAC;IACtB,SAAS,EAAE,iCAAiC,CAAC;IAC7C,gBAAgB,EACd,kIAAkI,CAAC;IACrI,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,WAAW,EAAE,OAAO,CAAC;QACrB,eAAe,EAAE,OAAO,CAAC;QACzB,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,wBAAwB;IACvC,SAAS,EAAE,SAAS,CAAC;IACrB,SAAS,EAAE,0BAA0B,CAAC;IACtC,gBAAgB,EAAE,sDAAsD,CAAC;IACzE,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,WAAW,EAAE,OAAO,CAAC;QACrB,eAAe,EAAE,OAAO,CAAC;KAC1B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,eAAe,CAAC;IAC3B,gBAAgB,EAAE,qCAAqC,CAAC;IACxD,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,YAAY,EAAE,OAAO,CAAC;KACvB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,mBAAmB,CAAC;IAC/B,gBAAgB,EACd,kEAAkE,CAAC;IACrE,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,WAAW,EAAE,OAAO,CAAC;QACrB,eAAe,EAAE,OAAO,CAAC;QACzB,OAAO,EAAE,OAAO,CAAC;QACjB,UAAU,EAAE,OAAO,CAAC;QACpB,UAAU,EAAE,OAAO,CAAC;KACrB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,SAAS,EAAE,SAAS,CAAC;IACrB,SAAS,EAAE,wBAAwB,CAAC;IACpC,gBAAgB,EAAE,oDAAoD,CAAC;IACvE,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,WAAW,EAAE,OAAO,CAAC;QACrB,eAAe,EAAE,OAAO,CAAC;KAC1B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,sBAAsB,CAAC;IAClC,gBAAgB,EAAE,uDAAuD,CAAC;IAC1E,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,OAAO,EAAE,OAAO,CAAC;QACjB,OAAO,EAAE,OAAO,CAAC;KAClB,CAAC;CACH;AAED;;;;;KAKK;AACL,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,kBAAkB,CAAC;IAC9B,SAAS,EAAE,kBAAkB,CAAC;IAC9B,gBAAgB,EACd,mHAAmH,CAAC;IACtH,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,iBAAiB,EAAE,OAAO,CAAC;QAC3B,kBAAkB,EAAE,OAAO,CAAC;KAC7B,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,mBAAmB,CAAC;IAC/B,gBAAgB,EAAE,yCAAyC,CAAC;IAC5D,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,YAAY,EAAE,OAAO,CAAC;KACvB,CAAC;CACH;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,WAAW,CAAC;IACvB,SAAS,EAAE,mBAAmB,CAAC;IAC/B,gBAAgB,EAAE,yCAAyC,CAAC;IAC5D,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE;QACV,YAAY,EAAE,OAAO,CAAC;QACtB,kBAAkB,EAAE,OAAO,CAAC;KAC7B,CAAC;CACH"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@osdk/foundry.functions",
3
- "version": "2.30.0",
3
+ "version": "2.32.0",
4
4
  "license": "Apache-2.0",
5
5
  "repository": {
6
6
  "type": "git",
@@ -21,8 +21,8 @@
21
21
  "dependencies": {
22
22
  "@osdk/shared.client": "^1.0.1",
23
23
  "@osdk/shared.client2": "^1.0.0",
24
- "@osdk/foundry.core": "2.30.0",
25
- "@osdk/shared.net.platformapi": "~1.4.0"
24
+ "@osdk/foundry.core": "2.32.0",
25
+ "@osdk/shared.net.platformapi": "~1.5.0"
26
26
  },
27
27
  "devDependencies": {
28
28
  "typescript": "^5.5.4",
@@ -45,7 +45,7 @@
45
45
  "sls": {
46
46
  "dependencies": {
47
47
  "com.palantir.foundry.api:api-gateway": {
48
- "minVersion": "1.1285.0",
48
+ "minVersion": "1.1293.0",
49
49
  "maxVersion": "1.x.x",
50
50
  "optional": false
51
51
  }