Skip to content

Commit d470a6f

Browse files
dimikotdimikot
committed
v2.17.2: Add toStandardSchemaV1() to EntAccessError, EntValidationError etc.
1 parent 7bd4a16 commit d470a6f

20 files changed

+471
-128
lines changed

‎docs/classes/EntAccessError.md‎

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,14 @@
66

77
# Class: EntAccessError
88

9-
Defined in: [src/ent/errors/EntAccessError.ts:7](https://github.com/clickup/ent-framework/blob/master/src/ent/errors/EntAccessError.ts#L7)
9+
Defined in: [src/ent/errors/EntAccessError.ts:22](https://github.com/clickup/ent-framework/blob/master/src/ent/errors/EntAccessError.ts#L22)
1010

11-
A base class for errors which trigger the validation framework to process
12-
them as a DENY/SKIP.
11+
A base class for errors that trigger the validation framework to process them
12+
as a DENY/SKIP. Invariants in derived classes: the error message should be
13+
safe to pass to the client (it must not have any private information; a good
14+
example is EntValidationError), plus the message alone should be descriptive
15+
enough to extract information from it. If `cause` is passed, it becomes a
16+
part of the message, with the above assumptions.
1317

1418
## Extends
1519

@@ -29,7 +33,7 @@ them as a DENY/SKIP.
2933

3034
> **new EntAccessError**(`entName`, `message`, `cause`): [`EntAccessError`](EntAccessError.md)
3135
32-
Defined in: [src/ent/errors/EntAccessError.ts:10](https://github.com/clickup/ent-framework/blob/master/src/ent/errors/EntAccessError.ts#L10)
36+
Defined in: [src/ent/errors/EntAccessError.ts:25](https://github.com/clickup/ent-framework/blob/master/src/ent/errors/EntAccessError.ts#L25)
3337

3438
#### Parameters
3539

@@ -53,3 +57,15 @@ Defined in: [src/ent/errors/EntAccessError.ts:10](https://github.com/clickup/ent
5357
| ------ | ------ |
5458
| <a id="cause-1"></a> `cause` | `null` \| `string` \| `Error` |
5559
| <a id="entname-1"></a> `entName` | `string` |
60+
61+
## Methods
62+
63+
### toStandardSchemaV1()
64+
65+
> **toStandardSchemaV1**(): [`StandardSchemaV1FailureResult`](../interfaces/StandardSchemaV1FailureResult.md)
66+
67+
Defined in: [src/ent/errors/EntAccessError.ts:52](https://github.com/clickup/ent-framework/blob/master/src/ent/errors/EntAccessError.ts#L52)
68+
69+
#### Returns
70+
71+
[`StandardSchemaV1FailureResult`](../interfaces/StandardSchemaV1FailureResult.md)

‎docs/classes/EntNotFoundError.md‎

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,11 @@
66

77
# Class: EntNotFoundError
88

9-
Defined in: [src/ent/errors/EntNotFoundError.ts:7](https://github.com/clickup/ent-framework/blob/master/src/ent/errors/EntNotFoundError.ts#L7)
9+
Defined in: [src/ent/errors/EntNotFoundError.ts:9](https://github.com/clickup/ent-framework/blob/master/src/ent/errors/EntNotFoundError.ts#L9)
1010

11-
Error: non-existing ID in the database.
11+
Error: non-existing ID in the database (failed loadX() call), or non-existing
12+
Ent (failed loadByX() call). Notice that `where` data is intentionally NOT
13+
considered as private and may be delivered to the client.
1214

1315
## Extends
1416

@@ -20,7 +22,7 @@ Error: non-existing ID in the database.
2022

2123
> **new EntNotFoundError**(`entName`, `where`, `cause`): [`EntNotFoundError`](EntNotFoundError.md)
2224
23-
Defined in: [src/ent/errors/EntNotFoundError.ts:8](https://github.com/clickup/ent-framework/blob/master/src/ent/errors/EntNotFoundError.ts#L8)
25+
Defined in: [src/ent/errors/EntNotFoundError.ts:10](https://github.com/clickup/ent-framework/blob/master/src/ent/errors/EntNotFoundError.ts#L10)
2426

2527
#### Parameters
2628

@@ -45,3 +47,19 @@ Defined in: [src/ent/errors/EntNotFoundError.ts:8](https://github.com/clickup/en
4547
| <a id="cause-1"></a> `cause` | `null` \| `string` \| `Error` |
4648
| <a id="entname-1"></a> `entName` | `string` |
4749
| <a id="where-1"></a> `where` | `Record`\<`string`, `unknown`\> |
50+
51+
## Methods
52+
53+
### toStandardSchemaV1()
54+
55+
> **toStandardSchemaV1**(): [`StandardSchemaV1FailureResult`](../interfaces/StandardSchemaV1FailureResult.md)
56+
57+
Defined in: [src/ent/errors/EntAccessError.ts:52](https://github.com/clickup/ent-framework/blob/master/src/ent/errors/EntAccessError.ts#L52)
58+
59+
#### Returns
60+
61+
[`StandardSchemaV1FailureResult`](../interfaces/StandardSchemaV1FailureResult.md)
62+
63+
#### Inherited from
64+
65+
[`EntAccessError`](EntAccessError.md).[`toStandardSchemaV1`](EntAccessError.md#tostandardschemav1)

‎docs/classes/EntNotInsertableError.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,19 @@ Defined in: [src/ent/errors/EntNotInsertableError.ts:7](https://github.com/click
4747
| <a id="entname-1"></a> `entName` | `string` |
4848
| <a id="vc-1"></a> `vc` | `string` |
4949
| <a id="row-1"></a> `row` | `object` |
50+
51+
## Methods
52+
53+
### toStandardSchemaV1()
54+
55+
> **toStandardSchemaV1**(): [`StandardSchemaV1FailureResult`](../interfaces/StandardSchemaV1FailureResult.md)
56+
57+
Defined in: [src/ent/errors/EntAccessError.ts:52](https://github.com/clickup/ent-framework/blob/master/src/ent/errors/EntAccessError.ts#L52)
58+
59+
#### Returns
60+
61+
[`StandardSchemaV1FailureResult`](../interfaces/StandardSchemaV1FailureResult.md)
62+
63+
#### Inherited from
64+
65+
[`EntAccessError`](EntAccessError.md).[`toStandardSchemaV1`](EntAccessError.md#tostandardschemav1)

‎docs/classes/EntNotReadableError.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,19 @@ Defined in: [src/ent/errors/EntNotReadableError.ts:9](https://github.com/clickup
4747
| <a id="entname-1"></a> `entName` | `string` |
4848
| <a id="vc-1"></a> `vc` | `string` |
4949
| <a id="row-1"></a> `row` | [`RowWithID`](../type-aliases/RowWithID.md) |
50+
51+
## Methods
52+
53+
### toStandardSchemaV1()
54+
55+
> **toStandardSchemaV1**(): [`StandardSchemaV1FailureResult`](../interfaces/StandardSchemaV1FailureResult.md)
56+
57+
Defined in: [src/ent/errors/EntAccessError.ts:52](https://github.com/clickup/ent-framework/blob/master/src/ent/errors/EntAccessError.ts#L52)
58+
59+
#### Returns
60+
61+
[`StandardSchemaV1FailureResult`](../interfaces/StandardSchemaV1FailureResult.md)
62+
63+
#### Inherited from
64+
65+
[`EntAccessError`](EntAccessError.md).[`toStandardSchemaV1`](EntAccessError.md#tostandardschemav1)

‎docs/classes/EntNotUpdatableError.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,19 @@ Defined in: [src/ent/errors/EntNotUpdatableError.ts:9](https://github.com/clicku
4747
| <a id="entname-1"></a> `entName` | `string` |
4848
| <a id="vc-1"></a> `vc` | `string` |
4949
| <a id="row-1"></a> `row` | [`RowWithID`](../type-aliases/RowWithID.md) |
50+
51+
## Methods
52+
53+
### toStandardSchemaV1()
54+
55+
> **toStandardSchemaV1**(): [`StandardSchemaV1FailureResult`](../interfaces/StandardSchemaV1FailureResult.md)
56+
57+
Defined in: [src/ent/errors/EntAccessError.ts:52](https://github.com/clickup/ent-framework/blob/master/src/ent/errors/EntAccessError.ts#L52)
58+
59+
#### Returns
60+
61+
[`StandardSchemaV1FailureResult`](../interfaces/StandardSchemaV1FailureResult.md)
62+
63+
#### Inherited from
64+
65+
[`EntAccessError`](EntAccessError.md).[`toStandardSchemaV1`](EntAccessError.md#tostandardschemav1)

‎docs/classes/EntValidationError.md‎

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# Class: EntValidationError
88

9-
Defined in: [src/ent/errors/EntValidationError.ts:7](https://github.com/clickup/ent-framework/blob/master/src/ent/errors/EntValidationError.ts#L7)
9+
Defined in: [src/ent/errors/EntValidationError.ts:8](https://github.com/clickup/ent-framework/blob/master/src/ent/errors/EntValidationError.ts#L8)
1010

1111
Error: thrown after all validators are executed, and some of them think that
1212
the row is invalid.
@@ -21,7 +21,7 @@ the row is invalid.
2121

2222
> **new EntValidationError**(`entName`, `errors`): [`EntValidationError`](EntValidationError.md)
2323
24-
Defined in: [src/ent/errors/EntValidationError.ts:8](https://github.com/clickup/ent-framework/blob/master/src/ent/errors/EntValidationError.ts#L8)
24+
Defined in: [src/ent/errors/EntValidationError.ts:9](https://github.com/clickup/ent-framework/blob/master/src/ent/errors/EntValidationError.ts#L9)
2525

2626
#### Parameters
2727

@@ -45,3 +45,22 @@ Defined in: [src/ent/errors/EntValidationError.ts:8](https://github.com/clickup/
4545
| <a id="cause"></a> `cause` | `null` \| `string` \| `Error` |
4646
| <a id="entname-1"></a> `entName` | `string` |
4747
| <a id="errors-1"></a> `errors` | readonly [`EntValidationErrorInfo`](../interfaces/EntValidationErrorInfo.md)[] |
48+
49+
## Methods
50+
51+
### toStandardSchemaV1()
52+
53+
> **toStandardSchemaV1**(): [`StandardSchemaV1FailureResult`](../interfaces/StandardSchemaV1FailureResult.md)
54+
55+
Defined in: [src/ent/errors/EntValidationError.ts:27](https://github.com/clickup/ent-framework/blob/master/src/ent/errors/EntValidationError.ts#L27)
56+
57+
Converts the payload to a Standard Schema V1 compatible error result. See
58+
https://standardschema.dev.
59+
60+
#### Returns
61+
62+
[`StandardSchemaV1FailureResult`](../interfaces/StandardSchemaV1FailureResult.md)
63+
64+
#### Overrides
65+
66+
[`EntAccessError`](EntAccessError.md).[`toStandardSchemaV1`](EntAccessError.md#tostandardschemav1)

‎docs/globals.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,7 @@
9797
- [Query](interfaces/Query.md)
9898
- [QueryAnnotation](interfaces/QueryAnnotation.md)
9999
- [SchemaClass](interfaces/SchemaClass.md)
100+
- [StandardSchemaV1FailureResult](interfaces/StandardSchemaV1FailureResult.md)
100101
- [EntValidationErrorInfo](interfaces/EntValidationErrorInfo.md)
101102
- [ConfigInstance](interfaces/ConfigInstance.md)
102103
- [ConfigClass](interfaces/ConfigClass.md)

‎docs/interfaces/EntValidationErrorInfo.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# Interface: EntValidationErrorInfo
88

9-
Defined in: [src/ent/errors/EntValidationError.ts:26](https://github.com/clickup/ent-framework/blob/master/src/ent/errors/EntValidationError.ts#L26)
9+
Defined in: [src/ent/errors/EntValidationError.ts:46](https://github.com/clickup/ent-framework/blob/master/src/ent/errors/EntValidationError.ts#L46)
1010

1111
Auxiliary information which every validation predicate should emit.
1212

‎docs/interfaces/StandardSchemaV1FailureResult.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
[**@clickup/ent-framework**](../README.md)
2+
3+
***
4+
5+
[@clickup/ent-framework](../globals.md) / StandardSchemaV1FailureResult
6+
7+
# Interface: StandardSchemaV1FailureResult
8+
9+
Defined in: [src/ent/errors/EntAccessError.ts:7](https://github.com/clickup/ent-framework/blob/master/src/ent/errors/EntAccessError.ts#L7)
10+
11+
Standard Schema V1 compatible error result. Every EntAccessError can be
12+
converted to it. See https://standardschema.dev.
13+
14+
## Properties
15+
16+
| Property | Type |
17+
| ------ | ------ |
18+
| <a id="issues"></a> `issues` | readonly `object`[] |

0 commit comments

Comments
 (0)