acebase-server 1.8.0 → 1.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.vscode/launch.json +24 -0
- package/create-package-files +12 -0
- package/dist/cjs/auth.js +89 -0
- package/dist/cjs/auth.js.map +1 -0
- package/dist/cjs/cluster.js +57 -0
- package/dist/cjs/cluster.js.map +1 -0
- package/dist/cjs/index.js +9 -0
- package/dist/cjs/index.js.map +1 -0
- package/dist/cjs/middleware/404.js +15 -0
- package/dist/cjs/middleware/404.js.map +1 -0
- package/dist/cjs/middleware/cache.js +15 -0
- package/dist/cjs/middleware/cache.js.map +1 -0
- package/dist/cjs/middleware/connection.js +50 -0
- package/dist/cjs/middleware/connection.js.map +1 -0
- package/dist/cjs/middleware/context.js +21 -0
- package/dist/cjs/middleware/context.js.map +1 -0
- package/dist/cjs/middleware/cors.js +51 -0
- package/dist/cjs/middleware/cors.js.map +1 -0
- package/dist/cjs/middleware/swagger.js +18 -0
- package/dist/cjs/middleware/swagger.js.map +1 -0
- package/dist/cjs/middleware/user.js +58 -0
- package/dist/cjs/middleware/user.js.map +1 -0
- package/dist/cjs/oauth-providers/dropbox.js +109 -0
- package/dist/cjs/oauth-providers/dropbox.js.map +1 -0
- package/dist/cjs/oauth-providers/facebook.js +85 -0
- package/dist/cjs/oauth-providers/facebook.js.map +1 -0
- package/dist/cjs/oauth-providers/google.js +125 -0
- package/dist/cjs/oauth-providers/google.js.map +1 -0
- package/dist/cjs/oauth-providers/index.js +27 -0
- package/dist/cjs/oauth-providers/index.js.map +1 -0
- package/dist/cjs/oauth-providers/instagram.js +80 -0
- package/dist/cjs/oauth-providers/instagram.js.map +1 -0
- package/dist/cjs/oauth-providers/oauth-provider.js +3 -0
- package/dist/cjs/oauth-providers/oauth-provider.js.map +1 -0
- package/dist/cjs/oauth-providers/spotify.js +113 -0
- package/dist/cjs/oauth-providers/spotify.js.map +1 -0
- package/dist/cjs/package.json +3 -0
- package/dist/cjs/routes/auth-change-password.js +85 -0
- package/dist/cjs/routes/auth-change-password.js.map +1 -0
- package/dist/cjs/routes/auth-delete.js +51 -0
- package/dist/cjs/routes/auth-delete.js.map +1 -0
- package/dist/cjs/routes/auth-forgot-password.js +75 -0
- package/dist/cjs/routes/auth-forgot-password.js.map +1 -0
- package/dist/cjs/routes/auth-reset-password.js +94 -0
- package/dist/cjs/routes/auth-reset-password.js.map +1 -0
- package/dist/cjs/routes/auth-signin.js +47 -0
- package/dist/cjs/routes/auth-signin.js.map +1 -0
- package/dist/cjs/routes/auth-signout.js +60 -0
- package/dist/cjs/routes/auth-signout.js.map +1 -0
- package/dist/cjs/routes/auth-signup.js +141 -0
- package/dist/cjs/routes/auth-signup.js.map +1 -0
- package/dist/cjs/routes/auth-state.js +26 -0
- package/dist/cjs/routes/auth-state.js.map +1 -0
- package/dist/cjs/routes/auth-update.js +129 -0
- package/dist/cjs/routes/auth-update.js.map +1 -0
- package/dist/cjs/routes/auth-verify-email.js +67 -0
- package/dist/cjs/routes/auth-verify-email.js.map +1 -0
- package/dist/cjs/routes/auth.js +55 -0
- package/dist/cjs/routes/auth.js.map +1 -0
- package/dist/cjs/routes/data-exists.js +34 -0
- package/dist/cjs/routes/data-exists.js.map +1 -0
- package/dist/cjs/routes/data-export.js +49 -0
- package/dist/cjs/routes/data-export.js.map +1 -0
- package/dist/cjs/routes/data-get.js +67 -0
- package/dist/cjs/routes/data-get.js.map +1 -0
- package/dist/cjs/routes/data-import.js +55 -0
- package/dist/cjs/routes/data-import.js.map +1 -0
- package/dist/cjs/routes/data-index-create.js +45 -0
- package/dist/cjs/routes/data-index-create.js.map +1 -0
- package/dist/cjs/routes/data-index-delete.js +36 -0
- package/dist/cjs/routes/data-index-delete.js.map +1 -0
- package/dist/cjs/routes/data-index-list.js +35 -0
- package/dist/cjs/routes/data-index-list.js.map +1 -0
- package/dist/cjs/routes/data-query.js +71 -0
- package/dist/cjs/routes/data-query.js.map +1 -0
- package/dist/cjs/routes/data-reflect.js +89 -0
- package/dist/cjs/routes/data-reflect.js.map +1 -0
- package/dist/cjs/routes/data-schema-get.js +39 -0
- package/dist/cjs/routes/data-schema-get.js.map +1 -0
- package/dist/cjs/routes/data-schema-set.js +33 -0
- package/dist/cjs/routes/data-schema-set.js.map +1 -0
- package/dist/cjs/routes/data-schema-test.js +46 -0
- package/dist/cjs/routes/data-schema-test.js.map +1 -0
- package/dist/cjs/routes/data-schemas-list.js +35 -0
- package/dist/cjs/routes/data-schemas-list.js.map +1 -0
- package/dist/cjs/routes/data-set.js +72 -0
- package/dist/cjs/routes/data-set.js.map +1 -0
- package/dist/cjs/routes/data-sync-changes.js +68 -0
- package/dist/cjs/routes/data-sync-changes.js.map +1 -0
- package/dist/cjs/routes/data-sync-mutations.js +68 -0
- package/dist/cjs/routes/data-sync-mutations.js.map +1 -0
- package/dist/cjs/routes/data-transaction.js +120 -0
- package/dist/cjs/routes/data-transaction.js.map +1 -0
- package/dist/cjs/routes/data-update.js +71 -0
- package/dist/cjs/routes/data-update.js.map +1 -0
- package/dist/cjs/routes/data.js +63 -0
- package/dist/cjs/routes/data.js.map +1 -0
- package/dist/cjs/routes/docs.js +249 -0
- package/dist/cjs/routes/docs.js.map +1 -0
- package/dist/cjs/routes/meta-info.js +70 -0
- package/dist/cjs/routes/meta-info.js.map +1 -0
- package/dist/cjs/routes/meta-ping.js +12 -0
- package/dist/cjs/routes/meta-ping.js.map +1 -0
- package/dist/cjs/routes/meta-stats.js +28 -0
- package/dist/cjs/routes/meta-stats.js.map +1 -0
- package/dist/cjs/routes/meta.js +17 -0
- package/dist/cjs/routes/meta.js.map +1 -0
- package/dist/cjs/routes/oauth2-init.js +52 -0
- package/dist/cjs/routes/oauth2-init.js.map +1 -0
- package/dist/cjs/routes/oauth2-refresh.js +43 -0
- package/dist/cjs/routes/oauth2-refresh.js.map +1 -0
- package/dist/cjs/routes/oauth2-signin.js +262 -0
- package/dist/cjs/routes/oauth2-signin.js.map +1 -0
- package/dist/cjs/routes/webmanager.js +27 -0
- package/dist/cjs/routes/webmanager.js.map +1 -0
- package/dist/cjs/rules.js +175 -0
- package/dist/cjs/rules.js.map +1 -0
- package/dist/cjs/schema/user.js +26 -0
- package/dist/cjs/schema/user.js.map +1 -0
- package/dist/cjs/server.js +363 -0
- package/dist/cjs/server.js.map +1 -0
- package/dist/cjs/settings/email.js +5 -0
- package/dist/cjs/settings/email.js.map +1 -0
- package/dist/cjs/settings/index.js +159 -0
- package/dist/cjs/settings/index.js.map +1 -0
- package/dist/cjs/shared/clients.js +27 -0
- package/dist/cjs/shared/clients.js.map +1 -0
- package/dist/cjs/shared/email.js +7 -0
- package/dist/cjs/shared/email.js.map +1 -0
- package/{src/oauth-providers/oauth-provider.js → dist/cjs/shared/env.js} +3 -0
- package/dist/cjs/shared/env.js.map +1 -0
- package/dist/cjs/shared/error.js +35 -0
- package/dist/cjs/shared/error.js.map +1 -0
- package/dist/cjs/shared/http.js +21 -0
- package/dist/cjs/shared/http.js.map +1 -0
- package/dist/cjs/shared/password.js +46 -0
- package/dist/cjs/shared/password.js.map +1 -0
- package/dist/cjs/shared/rootpath.js +15 -0
- package/dist/cjs/shared/rootpath.js.map +1 -0
- package/dist/cjs/shared/signin.js +139 -0
- package/dist/cjs/shared/signin.js.map +1 -0
- package/dist/cjs/shared/simple-fetch.js +77 -0
- package/dist/cjs/shared/simple-fetch.js.map +1 -0
- package/dist/cjs/shared/tokens.js +79 -0
- package/dist/cjs/shared/tokens.js.map +1 -0
- package/dist/cjs/shared/validate.js +62 -0
- package/dist/cjs/shared/validate.js.map +1 -0
- package/dist/cjs/start.js +51 -0
- package/dist/cjs/start.js.map +1 -0
- package/dist/cjs/test.js +11 -0
- package/dist/cjs/test.js.map +1 -0
- package/dist/cjs/websocket/index.js +301 -0
- package/dist/cjs/websocket/index.js.map +1 -0
- package/dist/cjs/websocket/manager.js +16 -0
- package/dist/cjs/websocket/manager.js.map +1 -0
- package/dist/cjs/websocket/socket.io.js +79 -0
- package/dist/cjs/websocket/socket.io.js.map +1 -0
- package/dist/esm/auth.js +76 -0
- package/dist/esm/auth.js.map +1 -0
- package/{src → dist/esm}/cluster.js +9 -14
- package/dist/esm/cluster.js.map +1 -0
- package/dist/esm/index.js +3 -0
- package/dist/esm/index.js.map +1 -0
- package/dist/esm/middleware/404.js +11 -0
- package/dist/esm/middleware/404.js.map +1 -0
- package/dist/esm/middleware/cache.js +11 -0
- package/dist/esm/middleware/cache.js.map +1 -0
- package/dist/esm/middleware/connection.js +46 -0
- package/dist/esm/middleware/connection.js.map +1 -0
- package/dist/esm/middleware/context.js +17 -0
- package/dist/esm/middleware/context.js.map +1 -0
- package/dist/esm/middleware/cors.js +45 -0
- package/dist/esm/middleware/cors.js.map +1 -0
- package/dist/esm/middleware/swagger.js +14 -0
- package/dist/esm/middleware/swagger.js.map +1 -0
- package/dist/esm/middleware/user.js +45 -0
- package/dist/esm/middleware/user.js.map +1 -0
- package/{src → dist/esm}/oauth-providers/dropbox.js +11 -9
- package/dist/esm/oauth-providers/dropbox.js.map +1 -0
- package/{src → dist/esm}/oauth-providers/facebook.js +6 -9
- package/dist/esm/oauth-providers/facebook.js.map +1 -0
- package/{src → dist/esm}/oauth-providers/google.js +8 -11
- package/dist/esm/oauth-providers/google.js.map +1 -0
- package/dist/esm/oauth-providers/index.js +19 -0
- package/dist/esm/oauth-providers/index.js.map +1 -0
- package/{src → dist/esm}/oauth-providers/instagram.js +6 -9
- package/dist/esm/oauth-providers/instagram.js.map +1 -0
- package/dist/esm/oauth-providers/oauth-provider.js +2 -0
- package/dist/esm/oauth-providers/oauth-provider.js.map +1 -0
- package/{src → dist/esm}/oauth-providers/spotify.js +7 -10
- package/dist/esm/oauth-providers/spotify.js.map +1 -0
- package/dist/esm/package.json +3 -0
- package/dist/esm/routes/auth-change-password.js +70 -0
- package/dist/esm/routes/auth-change-password.js.map +1 -0
- package/dist/esm/routes/auth-delete.js +36 -0
- package/dist/esm/routes/auth-delete.js.map +1 -0
- package/dist/esm/routes/auth-forgot-password.js +61 -0
- package/dist/esm/routes/auth-forgot-password.js.map +1 -0
- package/dist/esm/routes/auth-reset-password.js +78 -0
- package/dist/esm/routes/auth-reset-password.js.map +1 -0
- package/dist/esm/routes/auth-signin.js +34 -0
- package/dist/esm/routes/auth-signin.js.map +1 -0
- package/dist/esm/routes/auth-signout.js +46 -0
- package/dist/esm/routes/auth-signout.js.map +1 -0
- package/dist/esm/routes/auth-signup.js +126 -0
- package/dist/esm/routes/auth-signup.js.map +1 -0
- package/dist/esm/routes/auth-state.js +13 -0
- package/dist/esm/routes/auth-state.js.map +1 -0
- package/dist/esm/routes/auth-update.js +115 -0
- package/dist/esm/routes/auth-update.js.map +1 -0
- package/dist/esm/routes/auth-verify-email.js +52 -0
- package/dist/esm/routes/auth-verify-email.js.map +1 -0
- package/dist/esm/routes/auth.js +51 -0
- package/dist/esm/routes/auth.js.map +1 -0
- package/dist/esm/routes/data-exists.js +21 -0
- package/dist/esm/routes/data-exists.js.map +1 -0
- package/dist/esm/routes/data-export.js +36 -0
- package/dist/esm/routes/data-export.js.map +1 -0
- package/dist/esm/routes/data-get.js +53 -0
- package/dist/esm/routes/data-get.js.map +1 -0
- package/dist/esm/routes/data-import.js +42 -0
- package/dist/esm/routes/data-import.js.map +1 -0
- package/dist/esm/routes/data-index-create.js +31 -0
- package/dist/esm/routes/data-index-create.js.map +1 -0
- package/dist/esm/routes/data-index-delete.js +23 -0
- package/dist/esm/routes/data-index-delete.js.map +1 -0
- package/dist/esm/routes/data-index-list.js +22 -0
- package/dist/esm/routes/data-index-list.js.map +1 -0
- package/dist/esm/routes/data-query.js +57 -0
- package/dist/esm/routes/data-query.js.map +1 -0
- package/dist/esm/routes/data-reflect.js +76 -0
- package/dist/esm/routes/data-reflect.js.map +1 -0
- package/dist/esm/routes/data-schema-get.js +26 -0
- package/dist/esm/routes/data-schema-get.js.map +1 -0
- package/dist/esm/routes/data-schema-set.js +20 -0
- package/dist/esm/routes/data-schema-set.js.map +1 -0
- package/dist/esm/routes/data-schema-test.js +32 -0
- package/dist/esm/routes/data-schema-test.js.map +1 -0
- package/dist/esm/routes/data-schemas-list.js +22 -0
- package/dist/esm/routes/data-schemas-list.js.map +1 -0
- package/dist/esm/routes/data-set.js +57 -0
- package/dist/esm/routes/data-set.js.map +1 -0
- package/dist/esm/routes/data-sync-changes.js +54 -0
- package/dist/esm/routes/data-sync-changes.js.map +1 -0
- package/dist/esm/routes/data-sync-mutations.js +54 -0
- package/dist/esm/routes/data-sync-mutations.js.map +1 -0
- package/dist/esm/routes/data-transaction.js +104 -0
- package/dist/esm/routes/data-transaction.js.map +1 -0
- package/dist/esm/routes/data-update.js +56 -0
- package/dist/esm/routes/data-update.js.map +1 -0
- package/dist/esm/routes/data.js +59 -0
- package/dist/esm/routes/data.js.map +1 -0
- package/dist/esm/routes/docs.js +244 -0
- package/dist/esm/routes/docs.js.map +1 -0
- package/dist/esm/routes/meta-info.js +66 -0
- package/dist/esm/routes/meta-info.js.map +1 -0
- package/dist/esm/routes/meta-ping.js +8 -0
- package/dist/esm/routes/meta-ping.js.map +1 -0
- package/dist/esm/routes/meta-stats.js +15 -0
- package/dist/esm/routes/meta-stats.js.map +1 -0
- package/dist/esm/routes/meta.js +13 -0
- package/dist/esm/routes/meta.js.map +1 -0
- package/dist/esm/routes/oauth2-init.js +39 -0
- package/dist/esm/routes/oauth2-init.js.map +1 -0
- package/dist/esm/routes/oauth2-refresh.js +30 -0
- package/dist/esm/routes/oauth2-refresh.js.map +1 -0
- package/dist/esm/routes/oauth2-signin.js +248 -0
- package/dist/esm/routes/oauth2-signin.js.map +1 -0
- package/dist/esm/routes/webmanager.js +23 -0
- package/dist/esm/routes/webmanager.js.map +1 -0
- package/dist/esm/rules.js +171 -0
- package/dist/esm/rules.js.map +1 -0
- package/dist/esm/schema/user.js +21 -0
- package/dist/esm/schema/user.js.map +1 -0
- package/dist/esm/server.js +344 -0
- package/dist/esm/server.js.map +1 -0
- package/dist/esm/settings/email.js +4 -0
- package/dist/esm/settings/email.js.map +1 -0
- package/dist/esm/settings/index.js +152 -0
- package/dist/esm/settings/index.js.map +1 -0
- package/dist/esm/shared/clients.js +23 -0
- package/dist/esm/shared/clients.js.map +1 -0
- package/dist/esm/shared/email.js +6 -0
- package/dist/esm/shared/email.js.map +1 -0
- package/dist/esm/shared/env.js +4 -0
- package/dist/esm/shared/env.js.map +1 -0
- package/dist/esm/shared/error.js +27 -0
- package/dist/esm/shared/error.js.map +1 -0
- package/dist/esm/shared/http.js +16 -0
- package/dist/esm/shared/http.js.map +1 -0
- package/dist/esm/shared/password.js +39 -0
- package/dist/esm/shared/password.js.map +1 -0
- package/dist/esm/shared/rootpath.js +12 -0
- package/dist/esm/shared/rootpath.js.map +1 -0
- package/dist/esm/shared/signin.js +125 -0
- package/dist/esm/shared/signin.js.map +1 -0
- package/{src/oauth-providers → dist/esm/shared}/simple-fetch.js +7 -10
- package/dist/esm/shared/simple-fetch.js.map +1 -0
- package/dist/esm/shared/tokens.js +72 -0
- package/dist/esm/shared/tokens.js.map +1 -0
- package/dist/esm/shared/validate.js +42 -0
- package/dist/esm/shared/validate.js.map +1 -0
- package/dist/esm/start.js +48 -0
- package/dist/esm/start.js.map +1 -0
- package/dist/esm/test.js +9 -0
- package/dist/esm/test.js.map +1 -0
- package/dist/esm/websocket/index.js +288 -0
- package/dist/esm/websocket/index.js.map +1 -0
- package/dist/esm/websocket/manager.js +12 -0
- package/dist/esm/websocket/manager.js.map +1 -0
- package/dist/esm/websocket/socket.io.js +73 -0
- package/dist/esm/websocket/socket.io.js.map +1 -0
- package/dist/types/auth.d.ts +3 -0
- package/dist/types/cluster.d.ts +1 -0
- package/dist/types/index.d.ts +2 -0
- package/dist/types/middleware/404.d.ts +7 -0
- package/dist/types/middleware/cache.d.ts +3 -0
- package/dist/types/middleware/connection.d.ts +7 -0
- package/dist/types/middleware/context.d.ts +3 -0
- package/dist/types/middleware/cors.d.ts +25 -0
- package/dist/types/middleware/swagger.d.ts +3 -0
- package/dist/types/middleware/user.d.ts +2 -0
- package/dist/types/oauth-providers/dropbox.d.ts +63 -0
- package/dist/types/oauth-providers/facebook.d.ts +45 -0
- package/dist/types/oauth-providers/google.d.ts +47 -0
- package/dist/types/oauth-providers/index.d.ts +18 -0
- package/dist/types/oauth-providers/instagram.d.ts +54 -0
- package/dist/types/oauth-providers/oauth-provider.d.ts +70 -0
- package/dist/types/oauth-providers/spotify.d.ts +57 -0
- package/dist/types/routes/auth-change-password.d.ts +20 -0
- package/dist/types/routes/auth-delete.d.ts +16 -0
- package/dist/types/routes/auth-forgot-password.d.ts +16 -0
- package/dist/types/routes/auth-reset-password.d.ts +23 -0
- package/dist/types/routes/auth-signin.d.ts +24 -0
- package/dist/types/routes/auth-signout.d.ts +14 -0
- package/dist/types/routes/auth-signup.d.ts +32 -0
- package/dist/types/routes/auth-state.d.ts +13 -0
- package/dist/types/routes/auth-update.d.ts +33 -0
- package/dist/types/routes/auth-verify-email.d.ts +21 -0
- package/dist/types/routes/auth.d.ts +6 -0
- package/dist/types/routes/data-exists.d.ts +9 -0
- package/dist/types/routes/data-export.d.ts +10 -0
- package/dist/types/routes/data-get.d.ts +14 -0
- package/dist/types/routes/data-import.d.ts +13 -0
- package/dist/types/routes/data-index-create.d.ts +51 -0
- package/dist/types/routes/data-index-delete.d.ts +17 -0
- package/dist/types/routes/data-index-list.d.ts +21 -0
- package/dist/types/routes/data-query.d.ts +49 -0
- package/dist/types/routes/data-reflect.d.ts +29 -0
- package/dist/types/routes/data-schema-get.d.ts +11 -0
- package/dist/types/routes/data-schema-set.d.ts +19 -0
- package/dist/types/routes/data-schema-test.d.ts +21 -0
- package/dist/types/routes/data-schemas-list.d.ts +11 -0
- package/dist/types/routes/data-set.d.ts +27 -0
- package/dist/types/routes/data-sync-changes.d.ts +28 -0
- package/dist/types/routes/data-sync-mutations.d.ts +28 -0
- package/dist/types/routes/data-transaction.d.ts +34 -0
- package/dist/types/routes/data-update.d.ts +27 -0
- package/dist/types/routes/data.d.ts +3 -0
- package/dist/types/routes/docs.d.ts +3 -0
- package/dist/types/routes/meta-info.d.ts +11 -0
- package/dist/types/routes/meta-ping.d.ts +7 -0
- package/dist/types/routes/meta-stats.d.ts +13 -0
- package/dist/types/routes/meta.d.ts +3 -0
- package/dist/types/routes/oauth2-init.d.ts +13 -0
- package/dist/types/routes/oauth2-refresh.d.ts +17 -0
- package/dist/types/routes/oauth2-signin.d.ts +15 -0
- package/dist/types/routes/webmanager.d.ts +3 -0
- package/dist/types/rules.d.ts +41 -0
- package/dist/types/schema/user.d.ts +85 -0
- package/dist/types/server.d.ts +106 -0
- package/dist/types/settings/email.d.ts +14 -0
- package/dist/types/settings/index.d.ts +165 -0
- package/dist/types/shared/clients.d.ts +44 -0
- package/dist/types/shared/email.d.ts +34 -0
- package/dist/types/shared/env.d.ts +42 -0
- package/dist/types/shared/error.d.ts +15 -0
- package/dist/types/shared/http.d.ts +14 -0
- package/dist/types/shared/password.d.ts +19 -0
- package/dist/types/shared/rootpath.d.ts +2 -0
- package/dist/types/shared/signin.d.ts +31 -0
- package/dist/types/shared/simple-fetch.d.ts +21 -0
- package/dist/types/shared/tokens.d.ts +23 -0
- package/dist/types/shared/validate.d.ts +22 -0
- package/dist/types/start.d.ts +1 -0
- package/dist/types/test.d.ts +1 -0
- package/dist/types/websocket/index.d.ts +2 -0
- package/dist/types/websocket/manager.d.ts +99 -0
- package/dist/types/websocket/socket.io.d.ts +10 -0
- package/package.json +25 -8
- package/src/auth.ts +87 -0
- package/src/cluster.ts +62 -0
- package/src/index.ts +2 -0
- package/src/middleware/404.ts +13 -0
- package/src/middleware/cache.ts +15 -0
- package/src/middleware/connection.ts +48 -0
- package/src/middleware/context.ts +23 -0
- package/src/middleware/cors.ts +49 -0
- package/src/middleware/swagger.ts +19 -0
- package/src/middleware/user.ts +51 -0
- package/src/{ts/oauth-providers → oauth-providers}/dropbox.ts +1 -1
- package/src/{ts/oauth-providers → oauth-providers}/facebook.ts +1 -1
- package/src/{ts/oauth-providers → oauth-providers}/google.ts +1 -1
- package/src/oauth-providers/index.ts +20 -0
- package/src/{ts/oauth-providers → oauth-providers}/instagram.ts +1 -1
- package/src/{ts/oauth-providers → oauth-providers}/oauth-provider.ts +0 -0
- package/src/{ts/oauth-providers → oauth-providers}/spotify.ts +1 -1
- package/src/routes/auth-change-password.ts +89 -0
- package/src/routes/auth-change-password.yaml +74 -0
- package/src/routes/auth-delete.ts +47 -0
- package/src/routes/auth-delete.yaml +78 -0
- package/src/routes/auth-forgot-password.ts +73 -0
- package/src/routes/auth-forgot-password.yaml +50 -0
- package/src/routes/auth-reset-password.ts +93 -0
- package/src/routes/auth-reset-password.yaml +54 -0
- package/src/routes/auth-signin.ts +55 -0
- package/src/routes/auth-signin.yaml +130 -0
- package/src/routes/auth-signout.ts +61 -0
- package/src/routes/auth-signout.yaml +46 -0
- package/src/routes/auth-signup.ts +161 -0
- package/src/routes/auth-signup.yaml +136 -0
- package/src/routes/auth-state.ts +20 -0
- package/src/routes/auth-state.yaml +29 -0
- package/src/routes/auth-update.ts +147 -0
- package/src/routes/auth-update.yaml +152 -0
- package/src/routes/auth-verify-email.ts +67 -0
- package/src/routes/auth-verify-email.yaml +53 -0
- package/src/routes/auth.ts +67 -0
- package/src/routes/data-exists.ts +31 -0
- package/src/routes/data-exists.yaml +44 -0
- package/src/routes/data-export.ts +51 -0
- package/src/routes/data-export.yaml +64 -0
- package/src/routes/data-get.ts +68 -0
- package/src/routes/data-get.yaml +54 -0
- package/src/routes/data-import.ts +56 -0
- package/src/routes/data-import.yaml +75 -0
- package/src/routes/data-index-create.ts +85 -0
- package/src/routes/data-index-create.yaml +105 -0
- package/src/routes/data-index-delete.ts +39 -0
- package/src/routes/data-index-delete.yaml +51 -0
- package/src/routes/data-index-list.ts +42 -0
- package/src/routes/data-index-list.yaml +80 -0
- package/src/routes/data-query.ts +97 -0
- package/src/routes/data-query.yaml +166 -0
- package/src/routes/data-reflect.ts +94 -0
- package/src/routes/data-reflect.yaml +124 -0
- package/src/routes/data-schema-get.ts +38 -0
- package/src/routes/data-schema-get.yaml +53 -0
- package/src/routes/data-schema-set.ts +38 -0
- package/src/routes/data-schema-set.yaml +60 -0
- package/src/routes/data-schema-test.ts +53 -0
- package/src/routes/data-schema-test.yaml +66 -0
- package/src/routes/data-schemas-list.ts +33 -0
- package/src/routes/data-schemas-list.yaml +41 -0
- package/src/routes/data-set.ts +76 -0
- package/src/routes/data-set.yaml +71 -0
- package/src/routes/data-sync-changes.ts +78 -0
- package/src/routes/data-sync-changes.yaml +67 -0
- package/src/routes/data-sync-mutations.ts +78 -0
- package/src/routes/data-sync-mutations.yaml +67 -0
- package/src/routes/data-transaction-finish.yaml +76 -0
- package/src/routes/data-transaction-start.yaml +58 -0
- package/src/routes/data-transaction.ts +144 -0
- package/src/routes/data-update.ts +77 -0
- package/src/routes/data-update.yaml +71 -0
- package/src/routes/data.ts +79 -0
- package/src/routes/docs.ts +249 -0
- package/src/routes/meta-info.ts +80 -0
- package/src/routes/meta-info.yaml +41 -0
- package/src/routes/meta-ping.ts +15 -0
- package/src/routes/meta-ping.yaml +23 -0
- package/src/routes/meta-stats.ts +31 -0
- package/src/routes/meta-stats.yaml +41 -0
- package/src/routes/meta.ts +18 -0
- package/src/routes/oauth2-init.ts +44 -0
- package/src/routes/oauth2-init.yaml +63 -0
- package/src/routes/oauth2-refresh.ts +39 -0
- package/src/routes/oauth2-refresh.yaml +65 -0
- package/src/routes/oauth2-signin.ts +281 -0
- package/src/routes/oauth2-signin.yaml +66 -0
- package/src/routes/webmanager.ts +29 -0
- package/src/rules.ts +196 -0
- package/src/schema/user.ts +99 -0
- package/src/server.ts +416 -0
- package/src/settings/email.ts +18 -0
- package/src/settings/index.ts +241 -0
- package/src/shared/clients.ts +31 -0
- package/src/shared/email.ts +33 -0
- package/src/shared/env.ts +38 -0
- package/src/shared/error.ts +37 -0
- package/src/shared/http.ts +24 -0
- package/src/shared/password.ts +41 -0
- package/src/shared/rootpath.ts +15 -0
- package/src/shared/signin.ts +143 -0
- package/src/{ts/oauth-providers → shared}/simple-fetch.ts +2 -2
- package/src/shared/tokens.ts +77 -0
- package/src/shared/validate.ts +53 -0
- package/src/{start.js → start.ts} +7 -5
- package/src/test.ts +10 -0
- package/src/websocket/index.ts +320 -0
- package/src/websocket/manager.ts +46 -0
- package/src/websocket/socket.io.ts +91 -0
- package/tsconfig-cjs.json +10 -0
- package/tsconfig.json +13 -5
- package/{src/webmanager → webmanager}/index.html +0 -0
- package/{src/webmanager → webmanager}/index.js +0 -0
- package/src/acebase-server.js +0 -3053
- package/src/index.d.ts +0 -212
- package/src/index.js +0 -2
|
@@ -0,0 +1,161 @@
|
|
|
1
|
+
import { RouteInitEnvironment, RouteRequest } from '../shared/env';
|
|
2
|
+
import { AceBaseUser, DbUserAccountDetails, getPublicAccountDetails, UserProfilePicture } from '../schema/user';
|
|
3
|
+
import { emailExistsError, emailOrUsernameExistsError, invalidDisplayNameError, invalidEmailError, invalidPasswordError, invalidPictureError, invalidSettingsError, invalidUsernameError, isValidDisplayName, isValidEmail, isValidNewEmailAddress, isValidNewUsername, isValidPassword, isValidPicture, isValidSettings, isValidUsername, usernameExistsError } from '../shared/validate';
|
|
4
|
+
import { createPasswordHash } from '../shared/password';
|
|
5
|
+
import { ID } from 'acebase-core';
|
|
6
|
+
import { AceBaseUserSignupEmailRequest } from '../shared/email';
|
|
7
|
+
import { createPublicAccessToken, createSignedPublicToken } from '../shared/tokens';
|
|
8
|
+
import { sendUnexpectedError } from '../shared/error';
|
|
9
|
+
|
|
10
|
+
export class SignupError extends Error {
|
|
11
|
+
constructor(public code: 'admin_only'|'conflict'|'email_conflict'|'username_conflict'|'missing_details'|'invalid_email'|'invalid_username'|'invalid_display_name'|'invalid_password'|'invalid_picture'|'invalid_settings', message: string) {
|
|
12
|
+
super(message);
|
|
13
|
+
}
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
export type RequestQuery = {};
|
|
17
|
+
export type RequestBody = {
|
|
18
|
+
username: string;
|
|
19
|
+
email: string;
|
|
20
|
+
password: string;
|
|
21
|
+
displayName?: string;
|
|
22
|
+
display_name?: string;
|
|
23
|
+
picture?: UserProfilePicture;
|
|
24
|
+
settings: {
|
|
25
|
+
[name: string]: string|number|boolean
|
|
26
|
+
};
|
|
27
|
+
} & (
|
|
28
|
+
// Allow both spellings of display name. display_name is used in the db, displayName in public user detail server responses.
|
|
29
|
+
// displayName is preferred and documented in the OpenAPI docs
|
|
30
|
+
{ displayName: string; } | { display_name: string; }
|
|
31
|
+
);
|
|
32
|
+
|
|
33
|
+
export type ResponseBody = { access_token: string; user: AceBaseUser } | { code: SignupError['code']; message: string };
|
|
34
|
+
export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>;
|
|
35
|
+
|
|
36
|
+
export const addRoute = (env: RouteInitEnvironment) => {
|
|
37
|
+
env.app.post(`/auth/${env.db.name}/signup`, async (req: Request, res) => {
|
|
38
|
+
if (!env.config.auth.allowUserSignup && (!req.user || req.user.username !== 'admin')) {
|
|
39
|
+
env.logRef.push({ action: 'signup', success: false, code: 'user_signup_disabled', ip: req.ip, date: new Date() });
|
|
40
|
+
res.statusCode = 403; // Forbidden
|
|
41
|
+
return res.send({ code: 'admin_only', message: 'Only admin is allowed to create users' });
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
// Create user if it doesn't exist yet.
|
|
45
|
+
// TODO: Rate-limit nr of signups per IP to prevent abuse
|
|
46
|
+
|
|
47
|
+
const details = req.body;
|
|
48
|
+
|
|
49
|
+
if (typeof details.display_name === 'string' && typeof details.displayName !== 'string') {
|
|
50
|
+
// Allow display_name to be sent also (which is used in update endpoint)
|
|
51
|
+
details.displayName = details.display_name;
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
// Check if sent details are ok
|
|
55
|
+
let err: { code: SignupError['code'], message: string };
|
|
56
|
+
if (!details.username && !details.email) {
|
|
57
|
+
err = { code: 'missing_details', message: 'No username or email provided' };
|
|
58
|
+
}
|
|
59
|
+
else if (details.email && !isValidEmail(details.email)) {
|
|
60
|
+
err = invalidEmailError;
|
|
61
|
+
}
|
|
62
|
+
else if (details.email && !await isValidNewEmailAddress(env.authRef, details.email)) {
|
|
63
|
+
err = emailExistsError;
|
|
64
|
+
}
|
|
65
|
+
else if (details.username && !isValidUsername(details.username)) {
|
|
66
|
+
err = invalidUsernameError;
|
|
67
|
+
}
|
|
68
|
+
else if (details.username && !await isValidNewUsername(env.authRef, details.username)) {
|
|
69
|
+
err = usernameExistsError;
|
|
70
|
+
}
|
|
71
|
+
else if (!isValidDisplayName(details.displayName)) {
|
|
72
|
+
err = invalidDisplayNameError;
|
|
73
|
+
}
|
|
74
|
+
else if (!isValidPassword(details.password)) {
|
|
75
|
+
err = invalidPasswordError;
|
|
76
|
+
}
|
|
77
|
+
else if (!isValidSettings(details.settings)) {
|
|
78
|
+
err = invalidSettingsError;
|
|
79
|
+
}
|
|
80
|
+
else if (details.picture && !isValidPicture(details.picture)) {
|
|
81
|
+
err = invalidPictureError;
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
if (err === emailExistsError || err === usernameExistsError) {
|
|
85
|
+
env.logRef.push({ action: 'signup', success: false, code: 'conflict', ip: req.ip, date: new Date(), username: details.username, email: details.email });
|
|
86
|
+
res.statusCode = 409; // conflict
|
|
87
|
+
return res.send(emailOrUsernameExistsError);
|
|
88
|
+
}
|
|
89
|
+
else if (err) {
|
|
90
|
+
// Log failure
|
|
91
|
+
env.logRef.push({ action: 'signup', success: false, code: err.code, ip: req.ip, date: new Date() });
|
|
92
|
+
res.statusCode = 422; // Unprocessable Entity
|
|
93
|
+
return res.send(err);
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
try {
|
|
97
|
+
// Ok, create user
|
|
98
|
+
let pwd = createPasswordHash(details.password);
|
|
99
|
+
const user: DbUserAccountDetails = {
|
|
100
|
+
uid: null,
|
|
101
|
+
username: details.username ?? null,
|
|
102
|
+
email: details.email ?? null,
|
|
103
|
+
email_verified: false,
|
|
104
|
+
display_name: details.displayName,
|
|
105
|
+
password: pwd.hash,
|
|
106
|
+
password_salt: pwd.salt,
|
|
107
|
+
created: new Date(),
|
|
108
|
+
created_ip: req.ip,
|
|
109
|
+
access_token: ID.generate(),
|
|
110
|
+
access_token_created: new Date(),
|
|
111
|
+
last_signin: new Date(),
|
|
112
|
+
last_signin_ip: req.ip,
|
|
113
|
+
picture: details.picture ?? null,
|
|
114
|
+
settings: details.settings ?? {}
|
|
115
|
+
};
|
|
116
|
+
|
|
117
|
+
const userRef = await env.authRef.push(user);
|
|
118
|
+
user.uid = userRef.key;
|
|
119
|
+
|
|
120
|
+
// Log success
|
|
121
|
+
env.logRef.push({ action: 'signup', success: true, ip: req.ip, date: new Date(), uid: user.uid });
|
|
122
|
+
|
|
123
|
+
// Cache the user
|
|
124
|
+
env.authCache.set(user.uid, user);
|
|
125
|
+
|
|
126
|
+
// Request welcome e-mail to be sent
|
|
127
|
+
const request: AceBaseUserSignupEmailRequest = {
|
|
128
|
+
type: 'user_signup',
|
|
129
|
+
user: {
|
|
130
|
+
uid: user.uid,
|
|
131
|
+
username: user.username,
|
|
132
|
+
email: user.email,
|
|
133
|
+
displayName: user.display_name,
|
|
134
|
+
settings: user.settings
|
|
135
|
+
},
|
|
136
|
+
date: user.created,
|
|
137
|
+
ip: user.created_ip,
|
|
138
|
+
provider: 'acebase',
|
|
139
|
+
activationCode: createSignedPublicToken({ uid: user.uid }, env.tokenSalt),
|
|
140
|
+
emailVerified: false
|
|
141
|
+
};
|
|
142
|
+
|
|
143
|
+
env.config.email?.send(request).catch(err => {
|
|
144
|
+
env.logRef.push({ action: 'signup_email', success: false, code: 'unexpected', ip: req.ip, date: new Date(), error: err.message, request });
|
|
145
|
+
});
|
|
146
|
+
|
|
147
|
+
// Return the positive news
|
|
148
|
+
const isAdmin = req.user && req.user.uid === 'admin';
|
|
149
|
+
res.send({
|
|
150
|
+
access_token: isAdmin ? '' : createPublicAccessToken(user.uid, req.ip, user.access_token, env.tokenSalt),
|
|
151
|
+
user: getPublicAccountDetails(user)
|
|
152
|
+
});
|
|
153
|
+
}
|
|
154
|
+
catch (err) {
|
|
155
|
+
env.logRef.push({ action: 'signup', success: false, code: 'unexpected', ip: req.ip, date: new Date(), error: err.message, username: details.username, email: details.email });
|
|
156
|
+
sendUnexpectedError(res, err);
|
|
157
|
+
}
|
|
158
|
+
});
|
|
159
|
+
};
|
|
160
|
+
|
|
161
|
+
export default addRoute;
|
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
/auth/{dbname}/signup:
|
|
2
|
+
post:
|
|
3
|
+
tags:
|
|
4
|
+
- auth
|
|
5
|
+
summary: Create a new user
|
|
6
|
+
description: Signs up a new user (must be enabled in the server config)
|
|
7
|
+
parameters:
|
|
8
|
+
- name: dbname
|
|
9
|
+
in: path
|
|
10
|
+
description: name of the database
|
|
11
|
+
required: true
|
|
12
|
+
schema:
|
|
13
|
+
type: string
|
|
14
|
+
example: mydb
|
|
15
|
+
requestBody:
|
|
16
|
+
description: new user details
|
|
17
|
+
content:
|
|
18
|
+
'application/json':
|
|
19
|
+
schema:
|
|
20
|
+
type: object
|
|
21
|
+
properties:
|
|
22
|
+
username:
|
|
23
|
+
type: string
|
|
24
|
+
description: Requested username (optional if `email` provided)
|
|
25
|
+
email:
|
|
26
|
+
type: string
|
|
27
|
+
description: Email address (optional if `username` provided)
|
|
28
|
+
displayName:
|
|
29
|
+
type: string
|
|
30
|
+
description: Name of the user for public displaying purposes. Consider this a real name, alias or handle
|
|
31
|
+
password:
|
|
32
|
+
type: string
|
|
33
|
+
format: password
|
|
34
|
+
description: Password to set for the account
|
|
35
|
+
picture:
|
|
36
|
+
type: object
|
|
37
|
+
description: Profile picture
|
|
38
|
+
properties:
|
|
39
|
+
url:
|
|
40
|
+
type: string
|
|
41
|
+
width:
|
|
42
|
+
type: number
|
|
43
|
+
height:
|
|
44
|
+
type: number
|
|
45
|
+
example:
|
|
46
|
+
url: https://my.profile.pic/me.jpg
|
|
47
|
+
width: 500
|
|
48
|
+
height: 500
|
|
49
|
+
settings:
|
|
50
|
+
type: object
|
|
51
|
+
otherProperties: true
|
|
52
|
+
desciption: (optional) miscellanious other info to store with the user account
|
|
53
|
+
required:
|
|
54
|
+
- username
|
|
55
|
+
- email
|
|
56
|
+
- displayName
|
|
57
|
+
- password
|
|
58
|
+
example:
|
|
59
|
+
email: user@example.com
|
|
60
|
+
displayName: Real Name
|
|
61
|
+
password: sup3rs3cr3t
|
|
62
|
+
responses:
|
|
63
|
+
200:
|
|
64
|
+
description: When signup succeeds, it returns an object with the result
|
|
65
|
+
content:
|
|
66
|
+
'application/json':
|
|
67
|
+
schema:
|
|
68
|
+
type: object
|
|
69
|
+
properties:
|
|
70
|
+
access_token:
|
|
71
|
+
description: The access token that provides access to API calls that require authentication. This access token should be added to the Authorization header of those requests. The token is allowed to be cached by the client to sign in witht the token method later
|
|
72
|
+
type: string
|
|
73
|
+
example: ewufh387f3fyubqwekrjbcqwkuiec7gq3euyfbqwkuyebqjk..
|
|
74
|
+
user:
|
|
75
|
+
$ref: '#/components/schemas/User'
|
|
76
|
+
403:
|
|
77
|
+
description: If user signup is disabled in the server config, only the admin user can create new accounts and `"403 Forbidden"` is returned
|
|
78
|
+
content:
|
|
79
|
+
'application/json':
|
|
80
|
+
schema:
|
|
81
|
+
type: object
|
|
82
|
+
properties:
|
|
83
|
+
code:
|
|
84
|
+
type: string
|
|
85
|
+
value: admin_only
|
|
86
|
+
message:
|
|
87
|
+
type: string
|
|
88
|
+
value: Only admin is allowed to create users
|
|
89
|
+
example:
|
|
90
|
+
code: admin_only
|
|
91
|
+
message: Only admin is allowed to create users
|
|
92
|
+
409:
|
|
93
|
+
description: An account with the same username or email address exists already
|
|
94
|
+
content:
|
|
95
|
+
'application/json':
|
|
96
|
+
schema:
|
|
97
|
+
type: object
|
|
98
|
+
properties:
|
|
99
|
+
code:
|
|
100
|
+
type: string
|
|
101
|
+
value: conflict
|
|
102
|
+
message:
|
|
103
|
+
type: string
|
|
104
|
+
value: Account with username and/or email already exists
|
|
105
|
+
422:
|
|
106
|
+
description: When the sent request details are incorrect, `"422 Unprocessable Entity"` is returned
|
|
107
|
+
content:
|
|
108
|
+
'application/json':
|
|
109
|
+
schema:
|
|
110
|
+
type: object
|
|
111
|
+
properties:
|
|
112
|
+
code:
|
|
113
|
+
type: string
|
|
114
|
+
description: The exact error code
|
|
115
|
+
enum:
|
|
116
|
+
- missing_details
|
|
117
|
+
- invalid_email
|
|
118
|
+
- invalid_username
|
|
119
|
+
- invalid_display_name
|
|
120
|
+
- invalid_password
|
|
121
|
+
- invalid_settings
|
|
122
|
+
- invalid_picture
|
|
123
|
+
example: missing_details
|
|
124
|
+
message:
|
|
125
|
+
type: string
|
|
126
|
+
description: Description of the error
|
|
127
|
+
example: No username or email provided
|
|
128
|
+
example:
|
|
129
|
+
code: invalid_password
|
|
130
|
+
message: Invalid password, must be at least 8 characters and cannot contain spaces
|
|
131
|
+
500:
|
|
132
|
+
description: An unenexpected error occurred on the server
|
|
133
|
+
content:
|
|
134
|
+
'application/json':
|
|
135
|
+
schema:
|
|
136
|
+
$ref: '#/components/schemas/UnexpectedError'
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { RouteInitEnvironment, RouteRequest } from '../shared/env';
|
|
2
|
+
import { AceBaseUser, getPublicAccountDetails } from '../schema/user';
|
|
3
|
+
|
|
4
|
+
export type RequestQuery = {};
|
|
5
|
+
export type RequestBody = {};
|
|
6
|
+
export type ResponseBody = { signed_in: false } | { signed_in: true; user: AceBaseUser };
|
|
7
|
+
export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>;
|
|
8
|
+
|
|
9
|
+
export const addRoute = (env: RouteInitEnvironment) => {
|
|
10
|
+
env.app.get(`/auth/${env.db.name}/state`, async (req: Request, res) => {
|
|
11
|
+
if (req.user) {
|
|
12
|
+
res.send({ signed_in: true, user: getPublicAccountDetails(req.user) });
|
|
13
|
+
}
|
|
14
|
+
else {
|
|
15
|
+
res.send({ signed_in: false });
|
|
16
|
+
}
|
|
17
|
+
});
|
|
18
|
+
};
|
|
19
|
+
|
|
20
|
+
export default addRoute;
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
/auth/{dbname}/state:
|
|
2
|
+
get:
|
|
3
|
+
tags:
|
|
4
|
+
- auth
|
|
5
|
+
summary: Get authentication state
|
|
6
|
+
description: Gets current auth state
|
|
7
|
+
parameters:
|
|
8
|
+
- name: dbname
|
|
9
|
+
in: path
|
|
10
|
+
description: name of the database
|
|
11
|
+
required: true
|
|
12
|
+
schema:
|
|
13
|
+
type: string
|
|
14
|
+
example: mydb
|
|
15
|
+
responses:
|
|
16
|
+
200:
|
|
17
|
+
description: returns whether the request was authenticated and by which user (determined by the sent Authorization header)
|
|
18
|
+
content:
|
|
19
|
+
'application/json':
|
|
20
|
+
schema:
|
|
21
|
+
type: object
|
|
22
|
+
properties:
|
|
23
|
+
signed_in:
|
|
24
|
+
type: boolean
|
|
25
|
+
example: true
|
|
26
|
+
user:
|
|
27
|
+
$ref: '#/components/schemas/User'
|
|
28
|
+
required:
|
|
29
|
+
- signed_in
|
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
import { RouteInitEnvironment, RouteRequest } from '../shared/env';
|
|
2
|
+
import { AceBaseUser, DbUserAccountDetails, getPublicAccountDetails, UserProfilePicture } from '../schema/user';
|
|
3
|
+
import { emailExistsError, invalidDisplayNameError, invalidEmailError, invalidPictureError, invalidSettingsError, invalidUsernameError, isValidDisplayName, isValidEmail, isValidNewEmailAddress, isValidNewUsername, isValidPicture, isValidSettings, isValidUsername, usernameExistsError } from '../shared/validate';
|
|
4
|
+
import { sendNotAuthenticatedError, sendUnauthorizedError, sendUnexpectedError } from '../shared/error';
|
|
5
|
+
|
|
6
|
+
export class UpdateError extends Error {
|
|
7
|
+
constructor(public code: 'unauthenticated_update'|'unauthorized_update'|'user_not_found'|'invalid_email'|'email_conflict'|'invalid_username'|'username_conflict'|'invalid_display_name'|'invalid_picture'|'invalid_settings', message: string) {
|
|
8
|
+
super(message);
|
|
9
|
+
}
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
export type RequestQuery = {};
|
|
13
|
+
export type RequestBody = {
|
|
14
|
+
/** admin only: specifies user account to update */
|
|
15
|
+
uid: string;
|
|
16
|
+
/** Admin only: whether to enable or disable the account */
|
|
17
|
+
is_disabled?: boolean;
|
|
18
|
+
email?: string;
|
|
19
|
+
username?: string;
|
|
20
|
+
displayName?: string;
|
|
21
|
+
display_name?: string;
|
|
22
|
+
picture?: UserProfilePicture;
|
|
23
|
+
settings?: {
|
|
24
|
+
[name: string]: string|number|boolean
|
|
25
|
+
};
|
|
26
|
+
} & (
|
|
27
|
+
// Allow both spellings of display name. display_name is used in the db, displayName in public user detail server responses.
|
|
28
|
+
// displayName is preferred and documented in the OpenAPI docs
|
|
29
|
+
{ displayName: string; } | { display_name: string; }
|
|
30
|
+
);
|
|
31
|
+
|
|
32
|
+
export type ResponseBody = { user: AceBaseUser } | { code: UpdateError['code']; message: string };
|
|
33
|
+
export type Request = RouteRequest<any, ResponseBody, RequestBody, RequestQuery>;
|
|
34
|
+
|
|
35
|
+
export const addRoute = (env: RouteInitEnvironment) => {
|
|
36
|
+
env.app.post(`/auth/${env.db.name}/update`, async (req: Request, res) => {
|
|
37
|
+
|
|
38
|
+
let details = req.body;
|
|
39
|
+
|
|
40
|
+
if (!req.user) {
|
|
41
|
+
env.logRef.push({ action: 'update', success: false, code: 'unauthenticated_update', update_uid: details.uid, ip: req.ip, date: new Date() });
|
|
42
|
+
return sendNotAuthenticatedError(res, 'unauthenticated_update', 'Sign in to change details');
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
const uid = details.uid || req.user.uid;
|
|
46
|
+
|
|
47
|
+
if (req.user.uid !== 'admin' && (uid !== req.user.uid || typeof details.is_disabled === 'boolean')) {
|
|
48
|
+
env.logRef.push({ action: 'update', success: false, code: 'unauthorized_update', auth_uid: req.user.uid, update_uid: details.uid, ip: req.ip, date: new Date() });
|
|
49
|
+
return sendUnauthorizedError(res, 'unauthorized_update', 'You are not authorized to perform this update. This attempt has been logged.');
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
if (typeof details.display_name === 'undefined' && typeof details.displayName === 'string') {
|
|
53
|
+
// Allow displayName to be sent also (which is used in signup endpoint)
|
|
54
|
+
details.display_name = details.displayName;
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
// Check if sent details are ok
|
|
58
|
+
let err: { code: UpdateError['code'], message: string };
|
|
59
|
+
if (details.email && !isValidEmail(details.email)) {
|
|
60
|
+
err = invalidEmailError;
|
|
61
|
+
}
|
|
62
|
+
else if (details.email && !await isValidNewEmailAddress(env.authRef, details.email)) {
|
|
63
|
+
err = emailExistsError;
|
|
64
|
+
}
|
|
65
|
+
else if (details.username && !isValidUsername(details.username)) {
|
|
66
|
+
err = invalidUsernameError;
|
|
67
|
+
}
|
|
68
|
+
else if (details.username && !await isValidNewUsername(env.authRef, details.username)) {
|
|
69
|
+
err = usernameExistsError;
|
|
70
|
+
}
|
|
71
|
+
else if (details.display_name && !isValidDisplayName(details.display_name)) {
|
|
72
|
+
err = invalidDisplayNameError;
|
|
73
|
+
}
|
|
74
|
+
else if (details.picture && !isValidPicture(details.picture)) {
|
|
75
|
+
err = invalidPictureError;
|
|
76
|
+
}
|
|
77
|
+
else if (!isValidSettings(details.settings)) {
|
|
78
|
+
err = invalidSettingsError;
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
if (err) {
|
|
82
|
+
// Log failure
|
|
83
|
+
env.logRef.push({ action: 'update', success: false, code: err.code, auth_uid: req.user.uid, update_uid: uid, ip: req.ip, date: new Date() });
|
|
84
|
+
res.status(422).send(err); // Unprocessable Entity
|
|
85
|
+
return;
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
try {
|
|
89
|
+
let user: DbUserAccountDetails;
|
|
90
|
+
await env.authRef.child(uid).transaction(snap => {
|
|
91
|
+
if (!snap.exists()) {
|
|
92
|
+
throw new UpdateError('user_not_found', `No user found with uid ${uid}`);
|
|
93
|
+
}
|
|
94
|
+
user = snap.val();
|
|
95
|
+
if (details.email && details.email !== user.email) {
|
|
96
|
+
user.email = details.email;
|
|
97
|
+
user.email_verified = false; // TODO: send verification email
|
|
98
|
+
}
|
|
99
|
+
if (details.username) { user.username = details.username; }
|
|
100
|
+
if (details.display_name) { user.display_name = details.display_name; }
|
|
101
|
+
if (details.picture) { user.picture = details.picture; }
|
|
102
|
+
if (details.settings) {
|
|
103
|
+
if (typeof user.settings !== 'object') {
|
|
104
|
+
user.settings = {};
|
|
105
|
+
}
|
|
106
|
+
Object.keys(details.settings).forEach(key => {
|
|
107
|
+
user.settings[key] = details.settings[key];
|
|
108
|
+
});
|
|
109
|
+
if (!isValidSettings(user.settings)) {
|
|
110
|
+
err = invalidSettingsError;
|
|
111
|
+
env.logRef.push({ action: 'update', success: false, code: 'too_many_settings', auth_uid: req.user.uid, update_uid: details.uid, ip: req.ip, date: new Date() });
|
|
112
|
+
res.statusCode = 422; // Unprocessable Entity
|
|
113
|
+
res.send(err);
|
|
114
|
+
return;
|
|
115
|
+
}
|
|
116
|
+
}
|
|
117
|
+
if (typeof details.is_disabled === 'boolean') {
|
|
118
|
+
user.is_disabled = details.is_disabled;
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
return user; // Update db user
|
|
122
|
+
});
|
|
123
|
+
|
|
124
|
+
// Update cache
|
|
125
|
+
env.authCache.set(user.uid, user);
|
|
126
|
+
|
|
127
|
+
// Send merged results back
|
|
128
|
+
res.send({ user: getPublicAccountDetails(user) });
|
|
129
|
+
}
|
|
130
|
+
catch (err) {
|
|
131
|
+
|
|
132
|
+
// All known errors except user_not_found will have been sent already
|
|
133
|
+
if (err.code === 'user_not_found') {
|
|
134
|
+
env.logRef.push({ action: 'update', success: false, code: err.code, auth_uid: req.user.uid, update_uid: details.uid, ip: req.ip, date: new Date() });
|
|
135
|
+
|
|
136
|
+
res.statusCode = 404; // Not Found
|
|
137
|
+
res.send(err);
|
|
138
|
+
}
|
|
139
|
+
else {
|
|
140
|
+
// Unexpected
|
|
141
|
+
env.logRef.push({ action: 'update', success: false, code: err.code || 'unexpected', message: err.message, auth_uid: req.user.uid, update_uid: details.uid, ip: req.ip, date: new Date() });
|
|
142
|
+
sendUnexpectedError(res, err);
|
|
143
|
+
}
|
|
144
|
+
}
|
|
145
|
+
|
|
146
|
+
});
|
|
147
|
+
};
|
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
/auth/{dbname}/update:
|
|
2
|
+
post:
|
|
3
|
+
tags:
|
|
4
|
+
- auth
|
|
5
|
+
summary: Update user details
|
|
6
|
+
description: Updates user account details
|
|
7
|
+
parameters:
|
|
8
|
+
- name: dbname
|
|
9
|
+
in: path
|
|
10
|
+
description: name of the database
|
|
11
|
+
required: true
|
|
12
|
+
schema:
|
|
13
|
+
type: string
|
|
14
|
+
example: mydb
|
|
15
|
+
requestBody:
|
|
16
|
+
description: user details to update
|
|
17
|
+
content:
|
|
18
|
+
'application/json':
|
|
19
|
+
schema:
|
|
20
|
+
type: object
|
|
21
|
+
properties:
|
|
22
|
+
uid:
|
|
23
|
+
type: string
|
|
24
|
+
description: (admin user only) to change a user's account settings, the target account `uid` must be passed with the request
|
|
25
|
+
is_disabled:
|
|
26
|
+
type: boolean
|
|
27
|
+
description: (admin user only) whether the target account should be disabled to enable/disable signin
|
|
28
|
+
email:
|
|
29
|
+
type: string
|
|
30
|
+
description: New email address
|
|
31
|
+
username:
|
|
32
|
+
type: string
|
|
33
|
+
description: New username
|
|
34
|
+
displayName:
|
|
35
|
+
type: string
|
|
36
|
+
description: Name of the user for public displaying purposes. Consider this a real name, alias or handle. (NOTE this property is equivalent to the deprecated `display_name`, both are allowed to be used from acebase-server v1.8.1)
|
|
37
|
+
display_name:
|
|
38
|
+
type: string
|
|
39
|
+
description: Name of the user for public displaying purposes. Consider this a real name, alias or handle. (NOTE this property deprecated, use `displayName` instead)
|
|
40
|
+
picture:
|
|
41
|
+
type: object
|
|
42
|
+
description: Profile picture
|
|
43
|
+
properties:
|
|
44
|
+
url:
|
|
45
|
+
type: string
|
|
46
|
+
width:
|
|
47
|
+
type: number
|
|
48
|
+
height:
|
|
49
|
+
type: number
|
|
50
|
+
example:
|
|
51
|
+
url: https://my.profile.pic/me.jpg
|
|
52
|
+
width: 500
|
|
53
|
+
height: 500
|
|
54
|
+
settings:
|
|
55
|
+
type: object
|
|
56
|
+
otherProperties: true
|
|
57
|
+
desciption: (optional) miscellanious other info to store with the user account
|
|
58
|
+
required:
|
|
59
|
+
- username
|
|
60
|
+
- email
|
|
61
|
+
- displayName
|
|
62
|
+
- password
|
|
63
|
+
responses:
|
|
64
|
+
200:
|
|
65
|
+
description: When update succeeds, it returns an object with the new user details
|
|
66
|
+
content:
|
|
67
|
+
'application/json':
|
|
68
|
+
schema:
|
|
69
|
+
type: object
|
|
70
|
+
properties:
|
|
71
|
+
user:
|
|
72
|
+
$ref: '#/components/schemas/User'
|
|
73
|
+
401:
|
|
74
|
+
description: If this is an unauthenticated request (not signed in), `"401 Unauthorized"` is returned
|
|
75
|
+
content:
|
|
76
|
+
'application/json':
|
|
77
|
+
schema:
|
|
78
|
+
type: object
|
|
79
|
+
properties:
|
|
80
|
+
code:
|
|
81
|
+
type: string
|
|
82
|
+
value: unauthenticated_update
|
|
83
|
+
message:
|
|
84
|
+
type: string
|
|
85
|
+
value: Sign in to change details
|
|
86
|
+
example:
|
|
87
|
+
code: unauthenticated_update
|
|
88
|
+
message: Sign in to change details
|
|
89
|
+
403:
|
|
90
|
+
description: If a non-admin user tries to update a user's account details, `"403 Forbidden"` is returned
|
|
91
|
+
content:
|
|
92
|
+
'application/json':
|
|
93
|
+
schema:
|
|
94
|
+
type: object
|
|
95
|
+
properties:
|
|
96
|
+
code:
|
|
97
|
+
type: string
|
|
98
|
+
value: unauthorized_update
|
|
99
|
+
message:
|
|
100
|
+
type: string
|
|
101
|
+
value: You are not authorized to perform this update. This attempt has been logged.
|
|
102
|
+
example:
|
|
103
|
+
code: unauthorized_update
|
|
104
|
+
message: You are not authorized to perform this update. This attempt has been logged.
|
|
105
|
+
404:
|
|
106
|
+
description: User account to update does not exist
|
|
107
|
+
content:
|
|
108
|
+
'application/json':
|
|
109
|
+
schema:
|
|
110
|
+
type: object
|
|
111
|
+
properties:
|
|
112
|
+
code:
|
|
113
|
+
type: string
|
|
114
|
+
value: user_not_found
|
|
115
|
+
message:
|
|
116
|
+
type: string
|
|
117
|
+
value: No user found with uid jld2cjxh0000qzrmn831i7rn
|
|
118
|
+
example:
|
|
119
|
+
code: user_not_found
|
|
120
|
+
message: No user found with uid jld2cjxh0000qzrmn831i7rn
|
|
121
|
+
422:
|
|
122
|
+
description: When the sent request details are incorrect, this "422 Unprocessable Entity" is returned
|
|
123
|
+
content:
|
|
124
|
+
'application/json':
|
|
125
|
+
schema:
|
|
126
|
+
type: object
|
|
127
|
+
properties:
|
|
128
|
+
code:
|
|
129
|
+
type: string
|
|
130
|
+
description: The exact error code
|
|
131
|
+
enum:
|
|
132
|
+
- invalid_email
|
|
133
|
+
- email_conflict
|
|
134
|
+
- invalid_username
|
|
135
|
+
- username_conflict
|
|
136
|
+
- invalid_display_name
|
|
137
|
+
- invalid_picture
|
|
138
|
+
- invalid_settings
|
|
139
|
+
example: user_not_found
|
|
140
|
+
message:
|
|
141
|
+
type: string
|
|
142
|
+
description: Description of the error
|
|
143
|
+
example: Account with email address exists already
|
|
144
|
+
example:
|
|
145
|
+
code: username_conflict
|
|
146
|
+
message: Account with username exists already
|
|
147
|
+
500:
|
|
148
|
+
description: An unenexpected error occurred on the server
|
|
149
|
+
content:
|
|
150
|
+
'application/json':
|
|
151
|
+
schema:
|
|
152
|
+
$ref: '#/components/schemas/UnexpectedError'
|