feat(adapter-dynamodb): extend schema options #11463
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This change allows for more flexibility when customising the schema used
by the DynamoDB adapter. Specifically, it adds the ability to customize:
* **EntityTagName**: The attribute name under which to store the *type* of the entity.
* **EntityTags**: The value to use for each Entity type for the above attribute.
* **EntitySlugs**: The slug which is prepended to each type's partition/sort key.
`EntityTags` and `EntitySlug` are both of type `DynamoDBEntityTypeOptions` and
can take an (optional, string) value for each type of entity the adapter stores:
```
const entityTags: DynamoDBEntityTypeOptions = {
user: "AUTHUSER",
account: "ACT",
session: "SES",
vt: "VT"
}
```
`EntitySlug` does not format the provided slugs in any way; If users wish
to include a separator such as `#`, they need to include it.
`index.test.ts` and `format.test.ts` were updated to reflect changes required
to the `format.from` function.
`custom_config.test.ts` was added, which runs a full suite of the basic
tests against both the existing customizations _and_ those included in
this PR.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Skipped Deployment
|
|
@DylanLacey is attempting to deploy a commit to the authjs Team on Vercel. A member of the Team first needs to authorize it. |
github-actions
bot
added
adapters
ndom91
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This change allows for more flexibility when customising the schema used by the DynamoDB adapter. Specifically, it adds the ability to customize:
index.test.tsandformat.test.tswere updated to reflect changes required to theformat.fromfunction.custom_config.test.tswas added, which runs a full suite of the basic tests against both the existing customizations and those included in this PR.💻 Example
EntityTagsandEntitySlugare both of typeDynamoDBEntityTypeOptionsand can take an (optional, string) value for each type of entity the adapter stores:EntitySlugdoes not format the provided slugs in any way; If users wish to include a separator such as#, they need to include it.☕️ Reasoning
Firstly, to increase the ability to integrate Auth.js with other systems. For instance , DynamoDBToolbox uses an attribute
_etby default to type records.Secondly, to give users more control in general. They may wish to disambiguate AuthJS
Useritems from some extantUserentity, or shortenACCOUNTtoACNT.Documentation was not added, as the documentation on the
🧢 Checklist