Skip to content

Commit 9d70c37

Browse files
committed
Fix build docs script
1 parent f327fc3 commit 9d70c37

5 files changed

Lines changed: 14 additions & 9 deletions

File tree

docs/llms-full.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2238,7 +2238,7 @@ const AuthClawbackEnabledFlag: number
22382238
## AuthFlag
22392239

22402240
```ts
2241-
type AuthFlag = unknown
2241+
type AuthFlag = { readonly clawbackEnabled: 8; readonly immutable: 4; readonly required: 1; readonly revocable: 2 }
22422242
```
22432243

22442244
**Source:** [src/base/operations/types.ts:431](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/operations/types.ts#L431)
@@ -26043,7 +26043,7 @@ txFromXDR<T>(xdrBase64: string): AssembledTransaction<T>;
2604326043
Options for a smart contract client.
2604426044

2604526045
```ts
26046-
type ClientOptions = unknown
26046+
type ClientOptions = { allowHttp?: boolean; contractId: string; errorTypes?: Record<number, { message: string }>; headers?: Record<string, string>; networkPassphrase: string; publicKey?: string; rpcUrl: string; server?: Server; signAuthEntry?: SignAuthEntry; signTransaction?: SignTransaction }
2604726047
```
2604826048

2604926049
**Source:** [src/contract/types.ts:127](https://github.com/stellar/js-stellar-sdk/blob/main/src/contract/types.ts#L127)
@@ -26100,7 +26100,7 @@ message: string;
2610026100
Options for a smart contract method invocation.
2610126101

2610226102
```ts
26103-
type MethodOptions = unknown
26103+
type MethodOptions = { fee?: string; publicKey?: string; restore?: boolean; signAuthEntry?: SignAuthEntry; signTransaction?: SignTransaction; simulate?: boolean; timeoutInSeconds?: number }
2610426104
```
2610526105

2610626106
**Source:** [src/contract/types.ts:203](https://github.com/stellar/js-stellar-sdk/blob/main/src/contract/types.ts#L203)
@@ -28328,7 +28328,7 @@ A promise that resolves to the federation record
2832828328
A parsed and validated challenge transaction, and some of its constituent details.
2832928329

2833028330
```ts
28331-
type ChallengeTxDetails = unknown
28331+
type ChallengeTxDetails = { clientAccountId: string; matchedHomeDomain: string; memo?: string; tx: Transaction }
2833228332
```
2833328333

2833428334
**Source:** [src/webauth/utils.ts:104](https://github.com/stellar/js-stellar-sdk/blob/main/src/webauth/utils.ts#L104)

docs/reference/contracts-client.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -793,7 +793,7 @@ txFromXDR<T>(xdrBase64: string): AssembledTransaction<T>;
793793
Options for a smart contract client.
794794
795795
```ts
796-
type ClientOptions = unknown
796+
type ClientOptions = { allowHttp?: boolean; contractId: string; errorTypes?: Record<number, { message: string }>; headers?: Record<string, string>; networkPassphrase: string; publicKey?: string; rpcUrl: string; server?: Server; signAuthEntry?: SignAuthEntry; signTransaction?: SignTransaction }
797797
```
798798
799799
**Source:** [src/contract/types.ts:127](https://github.com/stellar/js-stellar-sdk/blob/main/src/contract/types.ts#L127)
@@ -850,7 +850,7 @@ message: string;
850850
Options for a smart contract method invocation.
851851

852852
```ts
853-
type MethodOptions = unknown
853+
type MethodOptions = { fee?: string; publicKey?: string; restore?: boolean; signAuthEntry?: SignAuthEntry; signTransaction?: SignTransaction; simulate?: boolean; timeoutInSeconds?: number }
854854
```
855855
856856
**Source:** [src/contract/types.ts:203](https://github.com/stellar/js-stellar-sdk/blob/main/src/contract/types.ts#L203)

docs/reference/core-transactions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ const AuthClawbackEnabledFlag: number
9090
## AuthFlag
9191
9292
```ts
93-
type AuthFlag = unknown
93+
type AuthFlag = { readonly clawbackEnabled: 8; readonly immutable: 4; readonly required: 1; readonly revocable: 2 }
9494
```
9595
9696
**Source:** [src/base/operations/types.ts:431](https://github.com/stellar/js-stellar-sdk/blob/main/src/base/operations/types.ts#L431)

docs/reference/seps-webauth.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: Wallet authentication via SEP-10 challenge transactions — build,
1010
A parsed and validated challenge transaction, and some of its constituent details.
1111

1212
```ts
13-
type ChallengeTxDetails = unknown
13+
type ChallengeTxDetails = { clientAccountId: string; matchedHomeDomain: string; memo?: string; tx: Transaction }
1414
```
1515
1616
**Source:** [src/webauth/utils.ts:104](https://github.com/stellar/js-stellar-sdk/blob/main/src/webauth/utils.ts#L104)

scripts/build-docs.ts

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -713,7 +713,12 @@ function renderSignature(refl: Reflection): string {
713713
switch (refl.kind) {
714714
case KIND_TYPE_ALIAS: {
715715
const tparams = renderTypeParameters(refl.typeParameters);
716-
const rhs = refl.type !== undefined ? renderType(refl.type) : "unknown";
716+
const rhs =
717+
refl.type !== undefined
718+
? renderType(refl.type)
719+
: refl.children !== undefined && refl.children.length > 0
720+
? renderReflectionType(refl)
721+
: "unknown";
717722
return `type ${refl.name}${tparams} = ${rhs}`;
718723
}
719724
case KIND_FUNCTION: {

0 commit comments

Comments
 (0)