sveltekit-auth-example 2.0.0 → 2.0.2

package/.eslintrc.cjs

@@ -1,20 +1,32 @@
 module.exports = {
 	root: true,
 	parser: '@typescript-eslint/parser',
-	extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'],
-	plugins: ['svelte3', '@typescript-eslint'],
+	extends: [
+		'eslint:recommended',
+		'plugin:@typescript-eslint/recommended',
+		'plugin:svelte/recommended',
+		'prettier'
+	],
+	plugins: ['@typescript-eslint'],
 	ignorePatterns: ['*.cjs'],
 	overrides: [{ files: ['*.svelte'], processor: 'svelte3/svelte3' }],
-	settings: {
-		'svelte3/typescript': () => require('typescript')
-	},
 	parserOptions: {
 		sourceType: 'module',
-		ecmaVersion: 2020
+		ecmaVersion: 2020,
+		extraFileExtensions: ['.svelte']
 	},
 	env: {
 		browser: true,
 		es2017: true,
 		node: true
-	}
+	},
+	overrides: [
+		{
+			files: ['*.svelte'],
+			parser: 'svelte-eslint-parser',
+			parserOptions: {
+				parser: '@typescript-eslint/parser'
+			}
+		}
+	]
 }

package/.prettierignore

@@ -1,5 +1,6 @@
 .DS_Store
 node_modules
+.yarn
 /build
 /.svelte-kit
 /package

package/CHANGELOG.md

@@ -1,215 +1,281 @@
 # Backlog
-* Add password complexity checking on /register and /profile pages (only checks for length currently despite what the pages say)
+
+- Add password complexity checking on /register and /profile pages (only checks for length currently despite what the pages say)
+
+# 2.0.2
+- fix prettier
+
+# 2.0.1
+
+- Bump @sveltejs/adapter-node, @sveltejs/kit, @sveltejs/vite-plugin-svelte, svelte, svelte-check, vite, google-auth-library, @types/pg, @typescript-eslint/\*, prettier, sass, vitest
 
 # 2.0.0 Upgrade for SvelteKit to 2.0
-* Migrated to SvelteKit way of managing cookies (vs. setting headers). The latter no longer works.
-* Corrected AuthenticationResult.statusCode type
-* Removed throw from SvelteKit functions redirect and error
-* Bump @sendgrid/mail, node, yarn, svelte, @sveltejs/kit, @sveltejs/vite-plugin-svelte, svelte-check, google-auth-library, vite, typescript, eslint, eslint-config-prettier, prettier-plugin-svelte, vitest, @types*, @typescript-eslint*, prettier
+
+- Migrated to SvelteKit way of managing cookies (vs. setting headers). The latter no longer works.
+- Corrected AuthenticationResult.statusCode type
+- Removed throw from SvelteKit functions redirect and error
+- Bump @sendgrid/mail, node, yarn, svelte, @sveltejs/kit, @sveltejs/vite-plugin-svelte, svelte-check, google-auth-library, vite, typescript, eslint, eslint-config-prettier, prettier-plugin-svelte, vitest, @types*, @typescript-eslint*, prettier
 
 # 1.0.59
-* Bump pg, sveltekit, @types*, bootstrap, eslint, google-auth-library, sass, svelte, svelte-check, tslib, typescript, vite, vitest
+
+- Bump pg, sveltekit, @types\*, bootstrap, eslint, google-auth-library, sass, svelte, svelte-check, tslib, typescript, vite, vitest
 
 # 1.0.58
-* Bump pg, sveltekit, adapter-node, bootstrap, svelte, sass, jsonwebtoken, google-auth-library, vite, vitest
+
+- Bump pg, sveltekit, adapter-node, bootstrap, svelte, sass, jsonwebtoken, google-auth-library, vite, vitest
 
 # 1.0.57
-* Minor bumps for pg, tslib, typescript
+
+- Minor bumps for pg, tslib, typescript
 
 # 1.0.56
-* Svelte 4, minor updates for other dependencies
+
+- Svelte 4, minor updates for other dependencies
 
 # 1.0.55
-* Add comment to indicate property that should be removed if ssl is turned off on the PostgreSQL server (thanks Brazos)
-* Update public.reset_password stored procedure to plpgsql (thanks Brazos)
+
+- Add comment to indicate property that should be removed if ssl is turned off on the PostgreSQL server (thanks Brazos)
+- Update public.reset_password stored procedure to plpgsql (thanks Brazos)
 
 # 1.0.54
-* Bump sveltekit, @types/pg, @typescript*, boostrap, eslint, prettier-plugin-svelte, sass, tslib, typescript, vitest
+
+- Bump sveltekit, @types/pg, @typescript\*, boostrap, eslint, prettier-plugin-svelte, sass, tslib, typescript, vitest
 
 # 1.0.53
-* Fix service-worker.ts typing
-* Bump pg, sveltekit, svelte, vite, tslib and other devDependencies
+
+- Fix service-worker.ts typing
+- Bump pg, sveltekit, svelte, vite, tslib and other devDependencies
 
 # 1.0.52
-* Bump @sveltejs/kit, svelte, vite, vitest, pg, adapter-node, google-auth-library, eslint, sass, @typescript*, typescript, prettier, eslint-config-prettier, prettier-plugin-svelte, svelte-check
+
+- Bump @sveltejs/kit, svelte, vite, vitest, pg, adapter-node, google-auth-library, eslint, sass, @typescript\*, typescript, prettier, eslint-config-prettier, prettier-plugin-svelte, svelte-check
 
 # 1.0.50
-* Bump @sveltejs/kit, vite, @typescript*
+
+- Bump @sveltejs/kit, vite, @typescript\*
 
 # 1.0.50
-* Bump @sveltejs/kit, sass, vite
+
+- Bump @sveltejs/kit, sass, vite
 
 # 1.0.49
-* Bump @sveltejs/kit, adapter-node, @typescript*, sass, vitest
+
+- Bump @sveltejs/kit, adapter-node, @typescript\*, sass, vitest
 
 # 1.0.48
-* Bump node, npm, @sveltejs/kit, adapter-node, eslint, prettier
+
+- Bump node, npm, @sveltejs/kit, adapter-node, eslint, prettier
 
 # 1.0.47
-* Bump @sveltejs/kit, adapter-node, @types/google.accounts, @typescript*, eslint, sass, typescript, vite, vitest
+
+- Bump @sveltejs/kit, adapter-node, @types/google.accounts, @typescript\*, eslint, sass, typescript, vite, vitest
 
 # 1.0.46
-* Bump @sveltejs/kit, pg, tslib, vitest
+
+- Bump @sveltejs/kit, pg, tslib, vitest
 
 # 1.0.45
-* Bump @sveltejs/kit, adapter-node, svelte-check, @typescript*, eslint, prettier, vitest, @types/jsonwebtoken
+
+- Bump @sveltejs/kit, adapter-node, svelte-check, @typescript\*, eslint, prettier, vitest, @types/jsonwebtoken
 
 # 1.0.44
-* Bump @sveltejs/kit, svelte
+
+- Bump @sveltejs/kit, svelte
 
 # 1.0.43
-* Bump @sveltejs/kit, svelte-check, vitest, @typescript*, prettier
+
+- Bump @sveltejs/kit, svelte-check, vitest, @typescript\*, prettier
 
 # 1.0.42
-* Bump @sveltejs/kit, vite, @typescript*, eslint-config-prettier, @types/google.accounts
+
+- Bump @sveltejs/kit, vite, @typescript\*, eslint-config-prettier, @types/google.accounts
 
 # 1.0.41
-* Bump @sveltejs/kit, vite, jsonwebtoken, svelte-check, sass
+
+- Bump @sveltejs/kit, vite, jsonwebtoken, svelte-check, sass
 
 # 1.0.39
-* Bump Svelte, SvelteKit, adapter-node, vite, svelte-preprocess,sass, svelte-check, typescript, prettier, prettier-plugin-svelte
+
+- Bump Svelte, SvelteKit, adapter-node, vite, svelte-preprocess,sass, svelte-check, typescript, prettier, prettier-plugin-svelte
 
 # 1.0.38
-* Switch from SendInBlue to Sendgrid for email
-* Bump SvelteKit, adapter-node, and vite
+
+- Switch from SendInBlue to Sendgrid for email
+- Bump SvelteKit, adapter-node, and vite
 
 # 1.0.37
-* Bump SvelteKit, svelte-check, and a few dev dependencies
+
+- Bump SvelteKit, svelte-check, and a few dev dependencies
 
 # 1.0.36
-* Bump SvelteKit, adapter-node, Bootstrap, prettier
+
+- Bump SvelteKit, adapter-node, Bootstrap, prettier
 
 # 1.0.35
-* Update SvelteKit, vite, Typescript
+
+- Update SvelteKit, vite, Typescript
 
 # 1.0.34
-* Update SvelteKit
+
+- Update SvelteKit
 
 # 1.0.33
-* Update dependencies
+
+- Update dependencies
 
 # 1.0.32
-* Remove window from reference to google.accounts
-* Add apple-touch-icon.png
-* Update dependencies
-* Remove dead code
+
+- Remove window from reference to google.accounts
+- Add apple-touch-icon.png
+- Update dependencies
+- Remove dead code
 
 # 1.0.31
-* Cleanup
-* Update SvelteKit
+
+- Cleanup
+- Update SvelteKit
 
 # 1.0.30
-* Fixed bug where opening /login or /register would fail to render Sign in With Google button (onMount in +layout.svelte loads after children's onMount)
-* Fix bad path for favicon
-* Update dependencies
+
+- Fixed bug where opening /login or /register would fail to render Sign in With Google button (onMount in +layout.svelte loads after children's onMount)
+- Fix bad path for favicon
+- Update dependencies
 
 # 1.0.29
-* Fixed bug in hooks.server.ts - new version of SvelteKit complains about modifying cookie after `const response = await resolve(event)` so moved it up two lines.
-* Update dependencies
+
+- Fixed bug in hooks.server.ts - new version of SvelteKit complains about modifying cookie after `const response = await resolve(event)` so moved it up two lines.
+- Update dependencies
 
 # 1.0.28
-* Update dependencies
+
+- Update dependencies
 
 # 1.0.27
-* Update dependencies
+
+- Update dependencies
 
 # 1.0.26
-* On the client, track whether the login session has expired and if so, clear $loginSession
-* Update dependencies
+
+- On the client, track whether the login session has expired and if so, clear $loginSession
+- Update dependencies
 
 # 1.0.25
-* Bump dependencies
-* Simplify Sign In With Google
+
+- Bump dependencies
+- Simplify Sign In With Google
 
 # 1.0.24
-* Bump dependencies
+
+- Bump dependencies
 
 # 1.0.23
-* Restructured server-side libraries to $lib/server based on https://github.com/sveltejs/kit/pull/6623
-* General cleanup
+
+- Restructured server-side libraries to $lib/server based on https://github.com/sveltejs/kit/pull/6623
+- General cleanup
 
 # 1.0.22
-* Move google-auth-library and jsonwebtoken to devDependencies from dependencies and other cleanup to package.json
+
+- Move google-auth-library and jsonwebtoken to devDependencies from dependencies and other cleanup to package.json
 
 # 1.0.21
-* Refactor to use $env/static/private and public, dropping dotenv dependency
-* Remove @types/cookie and bootstrap-icons dependencies
+
+- Refactor to use $env/static/private and public, dropping dotenv dependency
+- Remove @types/cookie and bootstrap-icons dependencies
 
 # 1.0.20
-* Bump dependencies
-* Add service-worker
-* Add dropdown, avatarm and user's first name to navbar once user is logged in
-* Refactor user session and update typing
+
+- Bump dependencies
+- Add service-worker
+- Add dropdown, avatarm and user's first name to navbar once user is logged in
+- Refactor user session and update typing
 
 # 1.0.19
-* Added SvelteKit's cookies implementation in RequestEvent
-* [Bug] Logout then go to http://localhost/admin gives error on auth.ts:39
+
+- Added SvelteKit's cookies implementation in RequestEvent
+- [Bug] Logout then go to http://localhost/admin gives error on auth.ts:39
 
 # 1.0.18
-* Bump dependencies
+
+- Bump dependencies
 
 # 1.0.17
-* Bump dependencies
+
+- Bump dependencies
 
 # 1.0.16
-* [Bug] Fixed LayoutServerLoad typing
+
+- [Bug] Fixed LayoutServerLoad typing
 
 # 1.0.15
-* [Bug] Replaced use of Action type in +server.ts files (only works for +page.server.ts)
+
+- [Bug] Replaced use of Action type in +server.ts files (only works for +page.server.ts)
 
 # 1.0.14
-* Refactor routing to be folder, not file-based - https://github.com/sveltejs/kit/discussions/5774 (file system router). More info: https://github.com/sveltejs/kit/discussions/5774#discussioncomment-3294867
-* Move bootstrap SCSS import to JavaScript in +layout.svelte
-* Refactor as session was removed in https://github.com/sveltejs/kit/discussions/5883
+
+- Refactor routing to be folder, not file-based - https://github.com/sveltejs/kit/discussions/5774 (file system router). More info: https://github.com/sveltejs/kit/discussions/5774#discussioncomment-3294867
+- Move bootstrap SCSS import to JavaScript in +layout.svelte
+- Refactor as session was removed in https://github.com/sveltejs/kit/discussions/5883
 
 # 1.0.13
-* Bump dependencies
+
+- Bump dependencies
 
 # 1.0.12
-* Remove unnecessary reference from app.d.ts
-* Remove commented lines in svelte.config.js
+
+- Remove unnecessary reference from app.d.ts
+- Remove commented lines in svelte.config.js
 
 # 1.0.10
-* Bump dependencies
-* Adjust for changes to SvelteKit
-* Improve typings
+
+- Bump dependencies
+- Adjust for changes to SvelteKit
+- Improve typings
 
 # 1.0.9
-* Bump dependencies
-* Adjust for changes to SvelteKit with respect to vite
+
+- Bump dependencies
+- Adjust for changes to SvelteKit with respect to vite
 
 # 1.0.7
-* Bump dependencies and verify against latest SvelteKit
-* Additional changes for register PostgreSQL function
+
+- Bump dependencies and verify against latest SvelteKit
+- Additional changes for register PostgreSQL function
 
 # 1.0.5
-* Bump dependencies
-* [Fix] Flaw in register allowing user to register over top of an existing account
-* Additional checks of submitted data
+
+- Bump dependencies
+- [Fix] Flaw in register allowing user to register over top of an existing account
+- Additional checks of submitted data
 
 # 1.0.4
-* Bump dependencies
+
+- Bump dependencies
 
 # 1.0.4
-* [Fix] If you login with a Google account, you cannot Update the Profile (UI is looking for password and confirm password which don't make sense in this context)
-* Added Content Security Policy
+
+- [Fix] If you login with a Google account, you cannot Update the Profile (UI is looking for password and confirm password which don't make sense in this context)
+- Added Content Security Policy
 
 # 1.0.3
-* [Fix] user created or updated when password mismatches (@lxy-yz)
-* Updated project dependencies
-* Replaced Sveltestrap's Toast with native Bootstrap 5 JavaScript to avoid error with @popperjs import (lacks type=module)
-* Added declarations for Session and Locals for type safety
+
+- [Fix] user created or updated when password mismatches (@lxy-yz)
+- Updated project dependencies
+- Replaced Sveltestrap's Toast with native Bootstrap 5 JavaScript to avoid error with @popperjs import (lacks type=module)
+- Added declarations for Session and Locals for type safety
 
 # 1.0.2
-* [Fix] Updated endpoints and hooks to conform to SvelteKit's API changes.
-* Updated project dependencies
+
+- [Fix] Updated endpoints and hooks to conform to SvelteKit's API changes.
+- Updated project dependencies
 
 # 1.0.1
-* Switched to dotenv vs. VITE_ env values for better security
-* Load Sign in with Google via code instead of static template
-* Fix logout (didn't work if session expired)
-* Fix login button rendering if that's the starting page
+
+- Switched to dotenv vs. VITE\_ env values for better security
+- Load Sign in with Google via code instead of static template
+- Fix logout (didn't work if session expired)
+- Fix login button rendering if that's the starting page
 
 # Backlog
-* [Low] Add password complexity check
-* [Low] Add Google reCaptcha 3
+
+- [Low] Add password complexity check
+- [Low] Add Google reCaptcha 3

package/README.md

@@ -10,6 +10,7 @@ It's a Single Page App (SPA) built with SvelteKit and a PostgreSQL database back
 The project includes a Content Security Policy (CSP) in svelte.config.js.
 
 The website supports two types of authentication:
+
 1. **Local accounts** via username (email) and password
    - The login form (/src/routes/login/+page.svelte) sends the login info as JSON to endpoint /auth/login
    - The endpoint passes the JSON to PostgreSQL function authenticate(json) which hashes the password and compares it to the stored hashed password in the users table. The function returns JSON containing a session ID (v4 UUID) and user object (sans password).
@@ -31,6 +32,7 @@ The website supports two types of authentication:
 The forgot password / password reset functionality uses a JWT and [**SendGrid**](https://www.sendgrid.com) to send the email. You would need to have a **SendGrid** account and set two environmental variables. Email sending is in /src/routes/auth/forgot.ts. This code could easily be replaced by nodemailer or something similar. Note: I have no affliation with **SendGrid** (used their API in another project).
 
 ## Prerequisites
+
 - PostgreSQL 14.10 or higher
 - Node.js 18.19.0 or higher
 - Google API client
@@ -41,6 +43,7 @@ The forgot password / password reset functionality uses a JWT and [**SendGrid**]
 Here are the steps:
 
 1. Get the project and setup the database
+
 ```bash
 # Clone the repo to your current directory
 git clone https://github.com/nstuyvesant/sveltekit-auth-example.git
@@ -58,6 +61,7 @@ psql -d postgres -f db_create.sql
 3. [Create a free Twilio SendGrid account](https://signup.sendgrid.com) and generate an API Key following [this documentation](https://docs.sendgrid.com/ui/account-and-settings/api-keys) and add a sender as documented [here](https://docs.sendgrid.com/ui/sending-email/senders).
 
 4. Create an **.env** file at the top level of the project with the following values (substituting your own id and PostgreSQL username and password):
+
 ```bash
 DATABASE_URL=postgres://user:password@localhost:5432/auth
 DOMAIN=http://localhost:3000
@@ -77,10 +81,11 @@ yarn dev -- --open
 ## Valid logins
 
 The db_create.sql script adds three users to the database with obvious roles:
+
 - admin@example.com password admin123
 - teacher@example.com password teacher123
 - student@example.com password student123
 
 ## My ask of you
 
-Please report any issues [here](https://github.com/nstuyvesant/sveltekit-auth-example/issues). [Pull requests](https://github.com/nstuyvesant/sveltekit-auth-example/pulls) are encouraged especially as SvelteKit is evolving rapidly.
+Please report any issues [here](https://github.com/nstuyvesant/sveltekit-auth-example/issues). [Pull requests](https://github.com/nstuyvesant/sveltekit-auth-example/pulls) are encouraged especially as SvelteKit is evolving rapidly.

package/package.json

@@ -1,68 +1,69 @@
 {
-  "name": "sveltekit-auth-example",
-  "description": "SvelteKit Authentication Example",
-  "version": "2.0.0",
-  "author": "Nate Stuyvesant",
-  "license": "https://github.com/nstuyvesant/sveltekit-auth-example/blob/master/LICENSE",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/nstuyvesant/sveltekit-auth-example.git"
-  },
-  "bugs": {
-    "url": "https://github.com/nstuyvesant/sveltekit-auth-example/issues"
-  },
-  "keywords": [
-    "svelte",
-    "sveltekit",
-    "authentication",
-    "example",
-    "google",
-    "postgresql"
-  ],
-  "scripts": {
-    "start": "node build",
-    "dev": "vite dev",
-    "build": "vite build",
-    "package": "svelte-kit package",
-    "preview": "vite preview",
-    "check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
-    "check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
-    "lint": "prettier --check . && eslint .",
-    "format": "prettier --write ."
-  },
-  "engines": {
-    "node": "^18.19.0"
-  },
-  "type": "module",
-  "dependencies": {
-    "@sendgrid/mail": "^8.1.0",
-    "pg": "^8.11.3"
-  },
-  "devDependencies": {
-    "@sveltejs/adapter-node": "^2.0.0",
-    "@sveltejs/kit": "^2.0.0",
-    "@sveltejs/vite-plugin-svelte": "^3.0.1",
-    "@types/bootstrap": "5.2.10",
-    "@types/google.accounts": "^0.0.14",
-    "@types/jsonwebtoken": "^9.0.5",
-    "@types/pg": "^8.10.9",
-    "@typescript-eslint/eslint-plugin": "^6.14.0",
-    "@typescript-eslint/parser": "^6.14.0",
-    "bootstrap": "^5.3.2",
-    "eslint": "^8.56.0",
-    "eslint-config-prettier": "^9.1.0",
-    "eslint-plugin-svelte3": "^4.0.0",
-    "google-auth-library": "^9.4.1",
-    "jsonwebtoken": "^9.0.2",
-    "prettier": "^3.1.1",
-    "prettier-plugin-svelte": "^3.1.2",
-    "sass": "^1.69.5",
-    "svelte": "^4.2.8",
-    "svelte-check": "^3.6.2",
-    "tslib": "^2.6.2",
-    "typescript": "^5.3.3",
-    "vite": "^5.0.10",
-    "vitest": "^1.0.4"
-  },
-  "packageManager": "yarn@4.0.2"
+	"name": "sveltekit-auth-example",
+	"description": "SvelteKit Authentication Example",
+	"version": "2.0.2",
+	"author": "Nate Stuyvesant",
+	"license": "https://github.com/nstuyvesant/sveltekit-auth-example/blob/master/LICENSE",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/nstuyvesant/sveltekit-auth-example.git"
+	},
+	"bugs": {
+		"url": "https://github.com/nstuyvesant/sveltekit-auth-example/issues"
+	},
+	"keywords": [
+		"svelte",
+		"sveltekit",
+		"authentication",
+		"example",
+		"google",
+		"postgresql"
+	],
+	"scripts": {
+		"start": "node build",
+		"dev": "vite dev",
+		"build": "vite build",
+		"package": "svelte-kit package",
+		"preview": "vite preview",
+		"check": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json",
+		"check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch",
+		"lint": "prettier --check . && eslint .",
+		"format": "prettier --write ."
+	},
+	"engines": {
+		"node": "^18.19.0"
+	},
+	"type": "module",
+	"dependencies": {
+		"@sendgrid/mail": "^8.1.0",
+		"pg": "^8.11.3"
+	},
+	"devDependencies": {
+		"@sveltejs/adapter-node": "^4.0.1",
+		"@sveltejs/kit": "^2.5.0",
+		"@sveltejs/vite-plugin-svelte": "^3.0.2",
+		"@types/bootstrap": "5.2.10",
+		"@types/google.accounts": "^0.0.14",
+		"@types/jsonwebtoken": "^9.0.5",
+		"@types/pg": "^8.11.0",
+		"@typescript-eslint/eslint-plugin": "^6.19.1",
+		"@typescript-eslint/parser": "^6.19.1",
+		"bootstrap": "^5.3.2",
+		"eslint": "^8.56.0",
+		"eslint-config-prettier": "^9.1.0",
+		"eslint-plugin-svelte": "^2.35.1",
+		"google-auth-library": "^9.5.0",
+		"jsonwebtoken": "^9.0.2",
+		"prettier": "^3.2.4",
+		"prettier-plugin-svelte": "^3.1.2",
+		"sass": "^1.70.0",
+		"svelte": "^4.2.9",
+		"svelte-check": "^3.6.3",
+		"tslib": "^2.6.2",
+		"typescript": "^5.3.3",
+		"vite": "^5.0.12",
+		"vitest": "^1.2.2"
+	},
+	"packageManager": "yarn@4.0.2",
+	"prettier": "./prettier.config.mjs"
 }

package/prettier.config.mjs

@@ -0,0 +1,15 @@
+export default {
+	$schema: 'https://json.schemastore.org/prettierrc',
+	useTabs: true,
+	semi: false,
+	singleQuote: true,
+	trailingComma: 'none',
+	printWidth: 100,
+	plugins: ['prettier-plugin-svelte'],
+	overrides: [
+		{
+			files: '*.svelte',
+			options: { parser: 'svelte' }
+		}
+	]
+}