Pre-beta changes - Githubissues

arcjet / arcjet-js

Arcjet JS SDKs. Bot detection, rate limiting, email validation, attack protection, data redaction for Node.js, Next.js, Deno, Bun, SvelteKit, NestJS.

https://arcjet.com

Apache License 2.0

269 stars 7 forks source link

Pre-beta changes #928

Open blaine-arcjet opened 5 months ago

blaine-arcjet commented 5 months ago

[x] https://github.com/arcjet/arcjet-js/issues/46
[x] https://github.com/arcjet/arcjet-js/issues/191
[x] https://github.com/arcjet/arcjet-js/issues/922 (only technically breaking since it could be deduped into the tree)
[x] https://github.com/arcjet/arcjet-js/issues/930
[x] https://github.com/arcjet/arcjet-js/issues/1397
[x] https://github.com/arcjet/arcjet-js/issues/992
[ ] https://github.com/arcjet/arcjet-js/issues/1448
[ ] https://github.com/arcjet/arcjet-js/issues/1391
[x] https://github.com/arcjet/arcjet-js/issues/1801
[x] https://github.com/arcjet/arcjet-js/issues/1810
[ ] https://github.com/arcjet/arcjet-js/issues/1833
[ ] https://github.com/arcjet/arcjet-js/issues/1834
[ ] https://github.com/arcjet/arcjet-js/issues/1835
[ ] https://github.com/arcjet/arcjet-js/issues/1836

davidmytton commented 5 months ago

All these make sense to me except #539 unless we also do #782. eslint 9 has version conflicts with other packages so we should avoid forcing a breaking change release just for our internal packages.

blaine-arcjet commented 5 months ago

I'm fine to skip the eslint upgrade but I think we're in agreement to decouple the version numbers of our devDeps so we can make breaking changes in the future without affecting the SDK version numbers.

davidmytton commented 5 months ago

Yes, agreed.

blaine-arcjet commented 4 months ago

We're putting this on hold until we're ready to approach beta again.

e-moran commented 3 months ago

We should rename the block field in validateEmail to align with the allow/deny naming of other rules.

blaine-arcjet commented 2 months ago

I've been discussing with @e-moran about making the wholesale switch from SCREAMING_SNAKE_CASE to kebab-case for our enum-like values. This would match the output of jco and require less translation when calling Wasm.

blaine-arcjet commented 2 months ago

Remove the ability to construct multiple rules with one constructor: #1397

e-moran commented 2 months ago

I've been discussing with @e-moran about making the wholesale switch from SCREAMING_SNAKE_CASE to kebab-case for our enum-like values. This would match the output of jco and require less translation when calling Wasm.

Do you think we should do this before the beta as its a big breaking change? I could have time to do it at the end of the week after the docs.

blaine-arcjet commented 2 months ago

@e-moran I think we need to make this backwards compatible with warning logs for deprecated format. Would you be able to do that in the timeline suggested?

blaine-arcjet commented 1 month ago

I think we should also consider removing the .ts files from our published packages. It is becoming frustrating that some frameworks/build tools process the .ts files even when our package manifest indicates that we provide the .js and .d.ts files.

blaine-arcjet commented 1 month ago

I believe I've migrated all suggestions in this thread to issues and update the root checklist.