Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@leonitousconforti
leonitousconforti committed Sep 17, 2024
1 parent a7bdf10 commit a5a34e2
Show file tree
Hide file tree
Showing 3 changed files with 76 additions and 72 deletions.
64 changes: 35 additions & 29 deletions docs/modules/WireguardConfig.ts.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -132,35 +132,41 @@ export declare const WireguardGetConfigResponse: Schema.extend<
| undefined
readonly ListenPort: InternetSchemas.PortBrand
readonly FirewallMark?: number | undefined
writeToFile: (
file: string
) => Effect.Effect<void, ParseResult.ParseError | PlatformError.PlatformError, FileSystem.FileSystem | Path.Path>
up: (
interfaceObject?: WireguardInterface.WireguardInterface | undefined
) => Effect.Effect<
WireguardInterface.WireguardInterface,
| Socket.SocketError
| ParseResult.ParseError
| Cause.TimeoutException
| WireguardErrors.WireguardError
| PlatformError.PlatformError,
FileSystem.FileSystem | Path.Path | WireguardControl.WireguardControl | CommandExecutor.CommandExecutor
>
upScoped: (
interfaceObject?: WireguardInterface.WireguardInterface | undefined
) => Effect.Effect<
WireguardInterface.WireguardInterface,
| Socket.SocketError
| ParseResult.ParseError
| Cause.TimeoutException
| WireguardErrors.WireguardError
| PlatformError.PlatformError,
| Scope.Scope
| FileSystem.FileSystem
| Path.Path
| WireguardControl.WireguardControl
| CommandExecutor.CommandExecutor
>
writeToFile: {
(
file: string
): Effect.Effect<void, ParseResult.ParseError | PlatformError.PlatformError, FileSystem.FileSystem | Path.Path>
}
up: {
(
interfaceObject?: WireguardInterface.WireguardInterface | undefined
): Effect.Effect<
WireguardInterface.WireguardInterface,
| Socket.SocketError
| ParseResult.ParseError
| Cause.TimeoutException
| PlatformError.PlatformError
| WireguardErrors.WireguardError,
FileSystem.FileSystem | Path.Path | CommandExecutor.CommandExecutor | WireguardControl.WireguardControl
>
}
upScoped: {
(
interfaceObject?: WireguardInterface.WireguardInterface | undefined
): Effect.Effect<
WireguardInterface.WireguardInterface,
| Socket.SocketError
| ParseResult.ParseError
| Cause.TimeoutException
| PlatformError.PlatformError
| WireguardErrors.WireguardError,
| FileSystem.FileSystem
| Path.Path
| CommandExecutor.CommandExecutor
| WireguardControl.WireguardControl
| Scope.Scope
>
}
},
{
readonly Address: `${string}/${number}`
Expand Down
82 changes: 40 additions & 42 deletions docs/modules/WireguardGenerate.ts.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,28 +55,26 @@ Adds an allowed IP to a node in the network.
```ts
export declare const addAllowedIPs: (<
Nodes extends
| readonly [node1: WireguardIPv4Node, node2: WireguardIPv4Node, ...rest: WireguardIPv4Node[]]
| readonly [node1: WireguardIPv6Node, node2: WireguardIPv6Node, ...rest: WireguardIPv6Node[]]
| readonly [node1: WireguardIPv4Node, node2: WireguardIPv4Node, ...rest: Array<WireguardIPv4Node>]
| readonly [node1: WireguardIPv6Node, node2: WireguardIPv6Node, ...rest: Array<WireguardIPv6Node>]
>(
nodeToIp: Extract<Nodes[number], WireguardRoamingPeer>["ip"] | Extract<Nodes[number], WireguardServer>[1]["ip"],
nodeFromIp: Extract<Nodes[number], WireguardRoamingPeer>["ip"] | Extract<Nodes[number], WireguardServer>[1]["ip"],
cidrs: readonly [
`${string}/${number}` | InternetSchemas.IPv4CidrBlock | InternetSchemas.IPv6CidrBlock,
...(`${string}/${number}` | InternetSchemas.IPv4CidrBlock | InternetSchemas.IPv6CidrBlock)[]
]
cidrs: Array.NonEmptyReadonlyArray<
InternetSchemas.IPv4CidrBlock | InternetSchemas.IPv6CidrBlock | InternetSchemas.CidrBlockFromStringEncoded
>
) => (allowedIPsLayer: AllowedIPsLayer<Nodes>) => AllowedIPsLayer<Nodes>) &
(<
Nodes extends
| readonly [node1: WireguardIPv4Node, node2: WireguardIPv4Node, ...rest: WireguardIPv4Node[]]
| readonly [node1: WireguardIPv6Node, node2: WireguardIPv6Node, ...rest: WireguardIPv6Node[]]
| readonly [node1: WireguardIPv4Node, node2: WireguardIPv4Node, ...rest: Array<WireguardIPv4Node>]
| readonly [node1: WireguardIPv6Node, node2: WireguardIPv6Node, ...rest: Array<WireguardIPv6Node>]
>(
allowedIPsLayer: AllowedIPsLayer<Nodes>,
nodeToIp: Extract<Nodes[number], WireguardRoamingPeer>["ip"] | Extract<Nodes[number], WireguardServer>[1]["ip"],
nodeFromIp: Extract<Nodes[number], WireguardRoamingPeer>["ip"] | Extract<Nodes[number], WireguardServer>[1]["ip"],
cidrs: readonly [
`${string}/${number}` | InternetSchemas.IPv4CidrBlock | InternetSchemas.IPv6CidrBlock,
...(`${string}/${number}` | InternetSchemas.IPv4CidrBlock | InternetSchemas.IPv6CidrBlock)[]
]
cidrs: Array.NonEmptyReadonlyArray<
InternetSchemas.IPv4CidrBlock | InternetSchemas.IPv6CidrBlock | InternetSchemas.CidrBlockFromStringEncoded
>
) => AllowedIPsLayer<Nodes>)
```
Expand All @@ -92,8 +90,8 @@ connections is has to the other nodes.
```ts
export declare const computeAllowedIPsFromConnections: <
Nodes extends
| readonly [node1: WireguardIPv4Node, node2: WireguardIPv4Node, ...rest: WireguardIPv4Node[]]
| readonly [node1: WireguardIPv6Node, node2: WireguardIPv6Node, ...rest: WireguardIPv6Node[]]
| readonly [node1: WireguardIPv4Node, node2: WireguardIPv4Node, ...rest: Array<WireguardIPv4Node>]
| readonly [node1: WireguardIPv6Node, node2: WireguardIPv6Node, ...rest: Array<WireguardIPv6Node>]
>(
connectionsLayer: ConnectionsLayer<Nodes>
) => AllowedIPsLayer<Nodes>
Expand All @@ -112,16 +110,16 @@ Adds a direct connection between two nodes in the network.
```ts
export declare const addConnection: (<
Nodes extends
| readonly [node1: WireguardIPv4Node, node2: WireguardIPv4Node, ...rest: WireguardIPv4Node[]]
| readonly [node1: WireguardIPv6Node, node2: WireguardIPv6Node, ...rest: WireguardIPv6Node[]]
| readonly [node1: WireguardIPv4Node, node2: WireguardIPv4Node, ...rest: Array<WireguardIPv4Node>]
| readonly [node1: WireguardIPv6Node, node2: WireguardIPv6Node, ...rest: Array<WireguardIPv6Node>]
>(
from: Extract<Nodes[number], WireguardRoamingPeer>["ip"] | Extract<Nodes[number], WireguardServer>[1]["ip"],
to: Extract<Nodes[number], WireguardRoamingPeer>["ip"] | Extract<Nodes[number], WireguardServer>[1]["ip"]
) => (connectionsLayer: ConnectionsLayer<Nodes>) => ConnectionsLayer<Nodes>) &
(<
Nodes extends
| readonly [node1: WireguardIPv4Node, node2: WireguardIPv4Node, ...rest: WireguardIPv4Node[]]
| readonly [node1: WireguardIPv6Node, node2: WireguardIPv6Node, ...rest: WireguardIPv6Node[]]
| readonly [node1: WireguardIPv4Node, node2: WireguardIPv4Node, ...rest: Array<WireguardIPv4Node>]
| readonly [node1: WireguardIPv6Node, node2: WireguardIPv6Node, ...rest: Array<WireguardIPv6Node>]
>(
connectionsLayer: ConnectionsLayer<Nodes>,
from: Extract<Nodes[number], WireguardRoamingPeer>["ip"] | Extract<Nodes[number], WireguardServer>[1]["ip"],
Expand All @@ -141,8 +139,8 @@ network.
```ts
export declare const generateHubAndSpokeConnections: <
Nodes extends
| readonly [node1: WireguardIPv4Node, node2: WireguardIPv4Node, ...rest: WireguardIPv4Node[]]
| readonly [node1: WireguardIPv6Node, node2: WireguardIPv6Node, ...rest: WireguardIPv6Node[]]
| readonly [node1: WireguardIPv4Node, node2: WireguardIPv4Node, ...rest: Array<WireguardIPv4Node>]
| readonly [node1: WireguardIPv6Node, node2: WireguardIPv6Node, ...rest: Array<WireguardIPv6Node>]
>(
keysLayer: keysLayer<Nodes>
) => ConnectionsLayer<Nodes>
Expand All @@ -159,8 +157,8 @@ Generates connections in a star pattern for all nodes in the network.
```ts
export declare const generateStarConnections: <
Nodes extends
| readonly [node1: WireguardIPv4Node, node2: WireguardIPv4Node, ...rest: WireguardIPv4Node[]]
| readonly [node1: WireguardIPv6Node, node2: WireguardIPv6Node, ...rest: WireguardIPv6Node[]]
| readonly [node1: WireguardIPv4Node, node2: WireguardIPv4Node, ...rest: Array<WireguardIPv4Node>]
| readonly [node1: WireguardIPv6Node, node2: WireguardIPv6Node, ...rest: Array<WireguardIPv6Node>]
>(
keysLayer: keysLayer<Nodes>
) => ConnectionsLayer<Nodes>
Expand All @@ -179,8 +177,8 @@ Converts a network into configs.
```ts
export declare const toConfigs: <
Nodes extends
| readonly [node1: WireguardIPv4Node, node2: WireguardIPv4Node, ...rest: WireguardIPv4Node[]]
| readonly [node1: WireguardIPv6Node, node2: WireguardIPv6Node, ...rest: WireguardIPv6Node[]]
| readonly [node1: WireguardIPv4Node, node2: WireguardIPv4Node, ...rest: Array<WireguardIPv4Node>]
| readonly [node1: WireguardIPv6Node, node2: WireguardIPv6Node, ...rest: Array<WireguardIPv6Node>]
>({
allowedIPs,
connections,
Expand Down Expand Up @@ -212,17 +210,17 @@ LAN as well.
```ts
export declare const generateLanHubAndSpokeAccess: <
Nodes extends
| readonly [server: WireguardIPv4Server, WireguardIPv4Node, ...WireguardIPv4Node[]]
| readonly [server: WireguardIPv6Server, WireguardIPv6Node, ...WireguardIPv6Node[]],
| readonly [server: WireguardIPv4Server, ...nodes: Array.NonEmptyReadonlyArray<WireguardIPv4Node>]
| readonly [server: WireguardIPv6Server, ...nodes: Array.NonEmptyReadonlyArray<WireguardIPv6Node>],
NetworkCidr extends Nodes[0] extends WireguardIPv4Node
? InternetSchemas.IPv4CidrBlock
: Nodes[0] extends WireguardIPv6Node
? InternetSchemas.IPv6CidrBlock
: never,
NetworkCidr2 extends Nodes[0] extends WireguardIPv4Server
? InternetSchemas.IPv4CidrBlock | [InternetSchemas.IPv4CidrBlock, ...InternetSchemas.IPv4CidrBlock[]]
? InternetSchemas.IPv4CidrBlock | Array.NonEmptyArray<InternetSchemas.IPv4CidrBlock>
: Nodes[0] extends WireguardIPv6Server
? InternetSchemas.IPv6CidrBlock | [InternetSchemas.IPv6CidrBlock, ...InternetSchemas.IPv6CidrBlock[]]
? InternetSchemas.IPv6CidrBlock | Array.NonEmptyArray<InternetSchemas.IPv6CidrBlock>
: never
>(options: {
nodes: Nodes
Expand Down Expand Up @@ -251,14 +249,14 @@ export declare const generateLanToLanAccess: <
? InternetSchemas.IPv6CidrBlock
: never,
NetworkCidr2 extends Nodes[0] extends WireguardIPv4Server
? InternetSchemas.IPv4CidrBlock | [InternetSchemas.IPv4CidrBlock, ...InternetSchemas.IPv4CidrBlock[]]
? InternetSchemas.IPv4CidrBlock | Array.NonEmptyArray<InternetSchemas.IPv4CidrBlock>
: Nodes[0] extends WireguardIPv6Server
? InternetSchemas.IPv6CidrBlock | [InternetSchemas.IPv6CidrBlock, ...InternetSchemas.IPv6CidrBlock[]]
? InternetSchemas.IPv6CidrBlock | Array.NonEmptyArray<InternetSchemas.IPv6CidrBlock>
: never,
NetworkCidr3 extends Nodes[1] extends WireguardIPv4Server
? InternetSchemas.IPv4CidrBlock | [InternetSchemas.IPv4CidrBlock, ...InternetSchemas.IPv4CidrBlock[]]
? InternetSchemas.IPv4CidrBlock | Array.NonEmptyArray<InternetSchemas.IPv4CidrBlock>
: Nodes[1] extends WireguardIPv6Server
? InternetSchemas.IPv6CidrBlock | [InternetSchemas.IPv6CidrBlock, ...InternetSchemas.IPv6CidrBlock[]]
? InternetSchemas.IPv6CidrBlock | Array.NonEmptyArray<InternetSchemas.IPv6CidrBlock>
: never
>(options: {
nodes: Nodes
Expand Down Expand Up @@ -288,9 +286,9 @@ export declare const generateRemoteAccessToLan: <
? InternetSchemas.IPv6CidrBlock
: never,
NetworkCidr2 extends Nodes[0] extends WireguardIPv4Server
? InternetSchemas.IPv4CidrBlock | [InternetSchemas.IPv4CidrBlock, ...InternetSchemas.IPv4CidrBlock[]]
? InternetSchemas.IPv4CidrBlock | Array.NonEmptyArray<InternetSchemas.IPv4CidrBlock>
: Nodes[0] extends WireguardIPv6Server
? InternetSchemas.IPv6CidrBlock | [InternetSchemas.IPv6CidrBlock, ...InternetSchemas.IPv6CidrBlock[]]
? InternetSchemas.IPv6CidrBlock | Array.NonEmptyArray<InternetSchemas.IPv6CidrBlock>
: never
>(options: {
nodes: Nodes
Expand Down Expand Up @@ -343,9 +341,9 @@ export declare const generateRemoteTunneledAccess: <
? InternetSchemas.IPv6CidrBlock
: never,
NetworkCidr2 extends Nodes[0] extends WireguardIPv4Server
? InternetSchemas.IPv4CidrBlock | [InternetSchemas.IPv4CidrBlock, ...InternetSchemas.IPv4CidrBlock[]]
? InternetSchemas.IPv4CidrBlock | Array.NonEmptyArray<InternetSchemas.IPv4CidrBlock>
: Nodes[0] extends WireguardIPv6Server
? InternetSchemas.IPv6CidrBlock | [InternetSchemas.IPv6CidrBlock, ...InternetSchemas.IPv6CidrBlock[]]
? InternetSchemas.IPv6CidrBlock | Array.NonEmptyArray<InternetSchemas.IPv6CidrBlock>
: never
>(options: {
nodes: Nodes
Expand All @@ -367,8 +365,8 @@ through the server.
```ts
export declare const generateServerHubAndSpokeAccess: <
Nodes extends
| readonly [server: WireguardIPv4Server, WireguardIPv4Node, ...WireguardIPv4Node[]]
| readonly [server: WireguardIPv6Server, WireguardIPv6Node, ...WireguardIPv6Node[]],
| readonly [server: WireguardIPv4Server, ...nodes: Array.NonEmptyReadonlyArray<WireguardIPv4Node>]
| readonly [server: WireguardIPv6Server, ...nodes: Array.NonEmptyReadonlyArray<WireguardIPv6Node>],
NetworkCidr extends Nodes[0] extends WireguardIPv4Node
? InternetSchemas.IPv4CidrBlock
: Nodes[0] extends WireguardIPv6Node
Expand Down Expand Up @@ -441,8 +439,8 @@ Generates preshare keys for all nodes in the network.
```ts
export declare const addPreshareKeys: <
Nodes extends
| readonly [node1: WireguardIPv4Node, node2: WireguardIPv4Node, ...rest: WireguardIPv4Node[]]
| readonly [node1: WireguardIPv6Node, node2: WireguardIPv6Node, ...rest: WireguardIPv6Node[]]
| readonly [node1: WireguardIPv4Node, node2: WireguardIPv4Node, ...rest: Array<WireguardIPv4Node>]
| readonly [node1: WireguardIPv6Node, node2: WireguardIPv6Node, ...rest: Array<WireguardIPv6Node>]
>(
keysLayer: keysLayer<Nodes>
) => keysLayer<Nodes>
Expand All @@ -459,8 +457,8 @@ Generates private+public keys for all nodes in the network.
```ts
export declare const generateKeys: <
Nodes extends
| readonly [node1: WireguardIPv4Node, node2: WireguardIPv4Node, ...rest: WireguardIPv4Node[]]
| readonly [node1: WireguardIPv6Node, node2: WireguardIPv6Node, ...rest: WireguardIPv6Node[]]
| readonly [node1: WireguardIPv4Node, node2: WireguardIPv4Node, ...rest: Array<WireguardIPv4Node>]
| readonly [node1: WireguardIPv6Node, node2: WireguardIPv6Node, ...rest: Array<WireguardIPv6Node>]
>(
nodesLayer: NodesLayer<Nodes>
) => keysLayer<Nodes>
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/WireguardServer.ts.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ export declare const requestWireguardDemoConfig: (
{
privateKey,
publicKey
}?: { readonly privateKey: string & Brand<"WireguardKey">; readonly publicKey: string & Brand<"WireguardKey"> }
}?: { readonly privateKey: WireguardKey.WireguardKey; readonly publicKey: WireguardKey.WireguardKey }
) => Effect.Effect<WireguardConfig.WireguardConfig, Socket.SocketError | ParseResult.ParseError, never>
```
Expand Down

0 comments on commit a5a34e2

Please sign in to comment.