Skip to content

Commit 1cf2720

Browse files
committed
fix(docs): update TSchema examples to use Core.TSchema namespace
The docgen was failing because examples in TSchema.ts were importing TSchema directly from the package root, but after moving everything to the Core namespace, it's now available as Core.TSchema. Fixed all @example blocks to use: import { Core } from "@evolution-sdk/evolution" Core.TSchema.Struct(...) This fixes the CI failure in the docs build step.
1 parent d206aef commit 1cf2720

File tree

129 files changed

+438
-415
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

129 files changed

+438
-415
lines changed

docs/next-env.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/// <reference types="next" />
22
/// <reference types="next/image-types/global" />
3-
import "./out/dev/types/routes.d.ts";
3+
import "./.next/types/routes.d.ts";
44

55
// NOTE: This file should not be edited
66
// see https://nextjs.org/docs/app/api-reference/config/typescript for more information.

packages/evolution/docs/modules/core/AddressStructure.ts.md renamed to packages/evolution/docs/modules/core/Address.ts.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
title: core/AddressStructure.ts
3-
nav_order: 3
2+
title: core/Address.ts
3+
nav_order: 1
44
parent: Modules
55
---
66

7-
## AddressStructure overview
7+
## Address overview
88

99
Added in v1.0.0
1010

@@ -17,7 +17,7 @@ Added in v1.0.0
1717
- [Functions](#functions)
1818
- [fromBech32](#frombech32)
1919
- [Schema](#schema)
20-
- [AddressStructure (class)](#addressstructure-class)
20+
- [Address (class)](#address-class)
2121
- [toString (method)](#tostring-method)
2222
- [[Symbol.for("nodejs.util.inspect.custom")] (method)](#symbolfornodejsutilinspectcustom-method)
2323
- [Transformations](#transformations)
@@ -30,7 +30,7 @@ Added in v1.0.0
3030
- [hasStakingCredential](#hasstakingcredential)
3131
- [isEnterprise](#isenterprise)
3232
- [utils](#utils-1)
33-
- [AddressStructureError (class)](#addressstructureerror-class)
33+
- [AddressError (class)](#addresserror-class)
3434
- [Either (namespace)](#either-namespace)
3535
- [fromBytes](#frombytes-1)
3636
- [fromHex](#fromhex-1)
@@ -49,7 +49,7 @@ FastCheck arbitrary generator for testing
4949
**Signature**
5050

5151
```ts
52-
export declare const arbitrary: FastCheck.Arbitrary<AddressStructure>
52+
export declare const arbitrary: FastCheck.Arbitrary<Address>
5353
```
5454
5555
Added in v1.0.0
@@ -63,19 +63,19 @@ Sync functions using Function module utilities
6363
**Signature**
6464
6565
```ts
66-
export declare const fromBech32: (input: string) => AddressStructure
66+
export declare const fromBech32: (input: string) => Address
6767
```
6868
6969
Added in v1.0.0
7070
7171
# Schema
7272
73-
## AddressStructure (class)
73+
## Address (class)
7474
7575
**Signature**
7676
7777
```ts
78-
export declare class AddressStructure
78+
export declare class Address
7979
```
8080

8181
Added in v1.0.0
@@ -107,7 +107,7 @@ Transform from Bech32 string to AddressStructure
107107
```ts
108108
export declare const FromBech32: Schema.transformOrFail<
109109
typeof Schema.String,
110-
Schema.SchemaClass<AddressStructure, AddressStructure, never>,
110+
Schema.SchemaClass<Address, Address, never>,
111111
never
112112
>
113113
```
@@ -124,7 +124,7 @@ Handles both BaseAddress (57 bytes) and EnterpriseAddress (29 bytes)
124124
```ts
125125
export declare const FromBytes: Schema.transformOrFail<
126126
Schema.Union<[Schema.filter<typeof Schema.Uint8ArrayFromSelf>, Schema.filter<typeof Schema.Uint8ArrayFromSelf>]>,
127-
Schema.SchemaClass<AddressStructure, AddressStructure, never>,
127+
Schema.SchemaClass<Address, Address, never>,
128128
never
129129
>
130130
```
@@ -142,7 +142,7 @@ export declare const FromHex: Schema.transform<
142142
Schema.transform<Schema.Schema<string, string, never>, Schema.Schema<Uint8Array, Uint8Array, never>>,
143143
Schema.transformOrFail<
144144
Schema.Union<[Schema.filter<typeof Schema.Uint8ArrayFromSelf>, Schema.filter<typeof Schema.Uint8ArrayFromSelf>]>,
145-
Schema.SchemaClass<AddressStructure, AddressStructure, never>,
145+
Schema.SchemaClass<Address, Address, never>,
146146
never
147147
>
148148
>
@@ -159,7 +159,7 @@ Check if two AddressStructure instances are equal.
159159
**Signature**
160160

161161
```ts
162-
export declare const equals: (a: AddressStructure, b: AddressStructure) => boolean
162+
export declare const equals: (a: Address, b: Address) => boolean
163163
```
164164

165165
Added in v1.0.0
@@ -171,7 +171,7 @@ Get network ID from AddressStructure
171171
**Signature**
172172

173173
```ts
174-
export declare const getNetworkId: (address: AddressStructure) => NetworkId.NetworkId
174+
export declare const getNetworkId: (address: Address) => NetworkId.NetworkId
175175
```
176176

177177
Added in v1.0.0
@@ -183,7 +183,7 @@ Check if AddressStructure has staking credential (BaseAddress-like)
183183
**Signature**
184184

185185
```ts
186-
export declare const hasStakingCredential: (address: AddressStructure) => boolean
186+
export declare const hasStakingCredential: (address: Address) => boolean
187187
```
188188

189189
Added in v1.0.0
@@ -195,19 +195,19 @@ Check if AddressStructure is enterprise-like (no staking credential)
195195
**Signature**
196196

197197
```ts
198-
export declare const isEnterprise: (address: AddressStructure) => boolean
198+
export declare const isEnterprise: (address: Address) => boolean
199199
```
200200

201201
Added in v1.0.0
202202

203203
# utils
204204

205-
## AddressStructureError (class)
205+
## AddressError (class)
206206

207207
**Signature**
208208

209209
```ts
210-
export declare class AddressStructureError
210+
export declare class AddressError
211211
```
212212

213213
## Either (namespace)
@@ -217,37 +217,37 @@ export declare class AddressStructureError
217217
**Signature**
218218

219219
```ts
220-
export declare const fromBytes: (input: any) => AddressStructure
220+
export declare const fromBytes: (input: any) => Address
221221
```
222222

223223
## fromHex
224224

225225
**Signature**
226226

227227
```ts
228-
export declare const fromHex: (input: string) => AddressStructure
228+
export declare const fromHex: (input: string) => Address
229229
```
230230

231231
## toBech32
232232

233233
**Signature**
234234

235235
```ts
236-
export declare const toBech32: (input: AddressStructure) => string
236+
export declare const toBech32: (input: Address) => string
237237
```
238238

239239
## toBytes
240240

241241
**Signature**
242242

243243
```ts
244-
export declare const toBytes: (input: AddressStructure) => any
244+
export declare const toBytes: (input: Address) => any
245245
```
246246

247247
## toHex
248248

249249
**Signature**
250250

251251
```ts
252-
export declare const toHex: (input: AddressStructure) => string
252+
export declare const toHex: (input: Address) => string
253253
```

packages/evolution/docs/modules/core/AddressEras.ts.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ parent: Modules
2121
- [model](#model)
2222
- [AddressEras](#addresseras)
2323
- [AddressEras (type alias)](#addresseras-type-alias)
24-
- [AddressError (class)](#addresserror-class)
24+
- [AddressErasError (class)](#addresseraserror-class)
2525
- [parsing](#parsing)
2626
- [fromBech32](#frombech32)
2727
- [fromBytes](#frombytes)
@@ -156,14 +156,14 @@ export type AddressEras = typeof AddressEras.Type
156156
157157
Added in v2.0.0
158158
159-
## AddressError (class)
159+
## AddressErasError (class)
160160
161161
Error thrown when address operations fail
162162
163163
**Signature**
164164
165165
```ts
166-
export declare class AddressError
166+
export declare class AddressErasError
167167
```
168168

169169
Added in v2.0.0

packages/evolution/docs/modules/core/AddressTag.ts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: core/AddressTag.ts
3-
nav_order: 4
3+
nav_order: 3
44
parent: Modules
55
---
66

packages/evolution/docs/modules/core/Anchor.ts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: core/Anchor.ts
3-
nav_order: 5
3+
nav_order: 4
44
parent: Modules
55
---
66

packages/evolution/docs/modules/core/AssetName.ts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: core/AssetName.ts
3-
nav_order: 6
3+
nav_order: 5
44
parent: Modules
55
---
66

packages/evolution/docs/modules/core/AuxiliaryData.ts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: core/AuxiliaryData.ts
3-
nav_order: 7
3+
nav_order: 6
44
parent: Modules
55
---
66

packages/evolution/docs/modules/core/AuxiliaryDataHash.ts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: core/AuxiliaryDataHash.ts
3-
nav_order: 8
3+
nav_order: 7
44
parent: Modules
55
---
66

packages/evolution/docs/modules/core/BaseAddress.ts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: core/BaseAddress.ts
3-
nav_order: 9
3+
nav_order: 8
44
parent: Modules
55
---
66

packages/evolution/docs/modules/core/Bech32.ts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: core/Bech32.ts
3-
nav_order: 10
3+
nav_order: 9
44
parent: Modules
55
---
66

0 commit comments

Comments
 (0)