Skip to content

Commit

Permalink
feat: Updates documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
m-housh committed May 8, 2024
1 parent 8035ea9 commit 2ccc61e
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 41 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ extension AuthController {
}

#if DEBUG
/// An in memory auth storage type that is used in mocks and tests.
public struct LocalAuthStorage: AuthLocalStorage, Sendable {
private let storage = LockIsolated([String:Data]())

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ The supabase dependency contains an authentication controller that has some conv
methods for interacting with the supabase authentication client. Providing hooks that can allow
you to override the current user, session, and convenience methods for logging in users.

See <doc:AuthControllerUsage> for more authentication methods.
See <doc:01_AuthControllerUsage> for more authentication methods.

```swift

Expand Down Expand Up @@ -185,7 +185,7 @@ func insertTodo(description: String, isComplete: Bool = false) -> Todo {
)
}
```
See <doc:DatabaseRouterUsage> for more details about modeling and overriding your database routes.
See <doc:02_DatabaseRouterUsage> for more details about modeling and overriding your database routes.

See the [Example](https://github.com/m-housh/supabase-client-dependency/tree/main/Examples/Examples)
project for a full working example.
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ services provided. It also includes some convenience methods and types.
It gives you the ability to override the current user and session. It also provides some
validations for credentials if you need them for your application.

The ``SupabaseClientDependency`` sets up an auth controller automatically, however it can
The ``SupabaseDependency`` sets up an auth controller automatically, however it can
also be used / managed independently.

### Usage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ routes.
The database router module is used to model your database and table routes as enumurations.
It also offers the ability to override routes for preview and testing purposes in your application.

The ``SupabaseClientDependency`` contains a router for your database routes, however this module can
The ``SupabaseDependency`` contains a router for your database routes, however this module can
be used as a standalone package as well. This article is focused on explaining the module as a
standalone package.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,40 +15,3 @@ This package adds some niceties around database queries as well as holds onto an

In general you use this package / dependency to build your database clients for usage in a
[swift-composable-architecture](https://github.com/pointfreeco/swift-composable-architecture) based application.


## Articles

- <doc:GettingStarted>
- <doc:AuthControllerUsage>
- <doc:DatabaseRouterUsage>


## Topics

### Structures

- ``SupabaseDependency``
- ``AuthController``
- ``AuthController/SharedOptions``
- ``DatabaseRouter``
- ``DatabaseRoute/Column``
- ``DatabaseRoute/Table``
- ``DatabaseRoute/Filter``
- ``DatabaseRoute/Order``
- ``Credentials``

### Enumerations

- ``AuthController/LoginRequest``
- ``AuthController/SignUpRequest``
- ``DatabaseRoute/Method``

### Errors

- ``AuthenticationError``
- ``CredentialError``

### Protocols

- ``RouteCollection``

0 comments on commit 2ccc61e

Please sign in to comment.