Skip to content

docs(sdk): clarify machineUserAttributes is required without userProfile #1168

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
dqn wants to merge 1 commit into from
Closed

docs(sdk): clarify machineUserAttributes is required without userProfile #1168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/sdk/docs/services/auth.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ const auth = defineAuth("my-auth", {
usernameField: "email",
attributes: { role: true },
},
// Optional when you don't define userProfile:
// Required when you don't define userProfile (mutually exclusive with userProfile):
// machineUserAttributes: {
// role: t.string(),
// },
Expand Down
14 changes: 14 additions & 0 deletions packages/sdk/docs/services/staticwebsite.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,12 +80,26 @@ export default defineConfig({

### OAuth2 Redirect URIs

The same `website.url` placeholder can be reused in `defineAuth`'s OAuth2 redirect URIs. Pick exactly one of `userProfile` or `machineUserAttributes` on `defineAuth` (they are mutually exclusive). The snippet below uses the machine-user-only shape so it compiles standalone.

```typescript
import { defineAuth, defineStaticWebSite, t } from "@tailor-platform/sdk";

const website = defineStaticWebSite("my-frontend", {
description: "Frontend application",
});

const auth = defineAuth("my-auth", {
// `machineUserAttributes` is required whenever you use `machineUsers`
// without a `userProfile`. It types every `machineUsers[*].attributes`.
machineUserAttributes: {
role: t.string(),
},
machineUsers: {
runner: {
attributes: { role: "RUNNER" },
},
},
oauth2Clients: {
"my-client": {
redirectURIs: [
Expand Down
Loading