@nuxtus/nuxtus 1.1.0 → 1.3.0

package/.github/workflows/release.yml

@@ -0,0 +1,24 @@
+name: Release npm package
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@main
+      - uses: actions/setup-node@v1
+        with:
+          node-version: "16.x"
+      - run: npm install --save-dev @semantic-release/release-notes-generator @semantic-release/changelog@6 @semantic-release/git@10 @semantic-release/github@8 semantic-release@19
+      # - run: npm ci
+      # - run: npm run build --if-present
+      # - run: npm test
+      - run: npx semantic-release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package/{changelog.md → CHANGELOG.md}

@@ -1,4 +1,26 @@
-# Nuxtus
+Changelog
+
+# [1.3.0](https://github.com/nuxtus/nuxtus/compare/v1.2.0...v1.3.0) (2022-07-28)
+
+
+### Features
+
+* :sparkles: use @nuxtus/nuxt-module instead of hard-coded plugins and api endpoints ([c34a601](https://github.com/nuxtus/nuxtus/commit/c34a601e107be87649ead02ab99072c40b1a9922))
+
+# [1.2.0](https://github.com/nuxtus/nuxtus/compare/v1.1.1...v1.2.0) (2022-07-21)
+
+
+### Features
+
+* :zap: directus and nuxt server and port are now configurable ([96bda8b](https://github.com/nuxtus/nuxtus/commit/96bda8bfdd03f2cdca5994b5814070480121e904))
+
+## [1.1.1](https://github.com/nuxtus/nuxtus/compare/v1.1.0...v1.1.1) (2022-07-11)
+
+
+### Bug Fixes
+
+* :bug: update @nuxtus/generator to 1.1.2 ([fa02fba](https://github.com/nuxtus/nuxtus/commit/fa02fbae0e00b4dc6c59f3336cb321b43e0d7227))
+
 
 ## 1.1.0
 
@@ -54,4 +76,4 @@
 
 ## 0.0.1
 
-Initial alpha release.
+Initial alpha release.

package/README.md

@@ -46,10 +46,14 @@ $ cd server
 $ npm run cli bootstrap
 ```
 
+> If using Nuxt is not using `http://localhost:3000` update NUXT_SERVER in the `server/.env` file.
+
 ### Nuxt
 
 No set up for Nuxt is required.
 
+> If Directus is not using `http://localhost:8055` update DIRECTUS_SERVER in the `client/.env` file.
+
 ### Starting Nuxtus
 
 From inside your project folder:
@@ -67,8 +71,10 @@ Nuxtus includes a POST endpoint located /api/directus/collection that will run i
 Collections are also typed automatically, simply prepend "Items" to the collection name as per below:
 
 ```typescript
-import { components } from "../interfaces/nuxtus";
-type Test = components["schemas"]["ItemsTest"];
+<script setup lang="ts">
+  import { components } from "../interfaces/nuxtus";
+  type Test = components["schemas"]["ItemsTest"];
+</script>
 ```
 
 > Because OpenAPI schemas may have invalid TypeScript characters as names, the square brackets are a safe way to access every property.
@@ -94,7 +100,7 @@ If you chose to install, remove the Nuxtus hook extension by deleting the folder
 
 Clone this repo onto your local machine, remove the remote git origin and add a new one. Then follow the [manual install instructions](#directus).
 
-> For further instructions visit `[http://localhost:3000](http://localhost:3000)`
+> For further instructions post install, visit `[http://localhost:3000](http://localhost:3000)`
 
 ## Acknowledgements
 

package/TODO

@@ -5,7 +5,7 @@ Todo:
   ✔ Fix code for singleton page in .vue template @done(22-06-13 19:06)
   ✔ Make a CLI for creating index/listing pages for Directus API @done(22-06-10 20:42)
   ✔ Set up [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) @done(22-06-16 20:23)
-  ☐ Setup [semantic release](https://github.com/semantic-release/semantic-release)
+  ✔ Setup [semantic release](https://github.com/semantic-release/semantic-release) @done(22-07-11 15:57)
   ✔ Add interactive/pretty CLI for create-app.js @done(22-06-16 20:23)
   ✔ Query database use (via interactive shell) in create-app.js @done(22-06-21 20:26)
   ✔ Check node version for compatibility in create-app.js @done(22-06-16 22:07)
@@ -14,12 +14,19 @@ Todo:
   ✔ Create Directus flow via Directus API @done(22-07-04 17:46)
   ☐ Add ability to automatically update .env for none SQLite databases
   ☐ Can I HMR when adding new pages/routes? - requires Nuxt to fix bug
-  ☐ Add all questions in create-app to start of process for better user flow
-  ☐ Allow use of different ports/URLs for Directus and Nuxt (currently hard-coded)
-  ☐ Add "types" to cli to update types from Directus when not using hook
-  ☐ Make opening browser window on start optional using npm run start
-  ☐ Make sure separate packages can be used without Nuxt Boilerplate if required
-  ☐ Console.log messages from directus extension should be formatted like other directus messages
+  ✔ Add all questions in create-app to start of process for better user flow @done(22-07-13 19:15)
+  ✔ Allow use of different ports/URLs for Directus and Nuxt (currently hard-coded) @done(22-07-13 20:42)
+  ✔ Add "types" to cli to update types from Directus when not using hook - use @directus/sdk for /oas now on all apps @done(22-07-18 17:01)
+  ☐ Make opening browser window on start optional using npm run start (not possible)
+  ✔ Look at moving login and server/api stuff to a Nuxt module @done(22-07-28 19:37)
+  ✔ Make sure separate packages can be used without Nuxt Boilerplate if required @done(22-07-28 19:37)
+  ✔ Console.log messages from directus extension should be formatted like other directus messages @done(22-07-19 20:46)
+  ✔ Add default Directus login to end of create-nuxtus script @done(22-07-19 17:30)
   ☐ When adding a new collection the new page triggers a nuxt restart then directus tries to send a field.create which fails. We get around this by getting the create field first but Directus still returns a 404 for the second request.
   ✔ interfaces/nuxtus.ts should not be in .gitignore other than during my development (remove in create-nuxtus?) @done(22-07-11 12:52)
-  ☐ Add test coverage
+  ✔ Add test coverage (done: generator, nuxtus-cli) @started(22-07-11 17:19) @done(22-07-14 08:03) @lasted(2d14h44m55s)
+  ☐ GraphQL?
+  ☐ Websockets (https://github.com/br41nslug/directus-websocket-subscribe)
+  ✔ Upgrade nuxt-directus @done(22-07-17 11:32)
+  ☐ Add ability to use Directus static token instead of login (once https://github.com/Intevel/nuxt-directus/pull/54#pullrequestreview-1045062132 completed)
+  ☐ Get added to some nuxt/directus lists etc.

package/client/nuxt.config.ts

@@ -11,7 +11,7 @@ export default defineNuxtConfig({
 		],
 		"@nuxtjs/tailwindcss",
 	],
-	modules: ["nuxt-directus"],
+	modules: ["nuxt-directus", "@nuxtus/nuxt-module"],
 	googleFonts: {
 		families: {
 			Inter: true,
@@ -22,6 +22,9 @@ export default defineNuxtConfig({
 		jit: true,
 	},
 	directus: {},
+	nuxtus: {
+		authDirectus: true,
+	},
 	publicRuntimeConfig: {
 		directusEmail: "",
 		directusPassword: "",

package/client/package.json

@@ -9,14 +9,13 @@
   "devDependencies": {
     "@nuxtjs/google-fonts": "^1.3.0",
     "@nuxtjs/tailwindcss": "^5.0.4",
-    "@nuxtus/cli": "^1.0.6",
-    "@nuxtus/generator": "1.1.0",
-    "nuxt": "3.0.0-rc.4",
-    "openapi-typescript": "^5.4.1"
+    "@nuxtus/cli": "^1.1.1",
+    "@nuxtus/nuxt-module": "^1.0.3",
+    "nuxt": "^3.0.0-rc.6"
   },
   "dependencies": {
     "@headlessui/vue": "^1.6.1",
     "@heroicons/vue": "^1.0.6",
-    "nuxt-directus": "^2.1.0"
+    "nuxt-directus": "^2.2.0"
   }
 }

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@nuxtus/nuxtus",
 	"description": "Directus/Nuxt boilerplate with Tailwind CSS.",
-	"version": "1.1.0",
+	"version": "1.3.0",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/nuxtus/nuxtus.git"
@@ -29,6 +29,41 @@
 		"start": "concurrently \"npm run client\" \"npm run server\""
 	},
 	"devDependencies": {
-		"concurrently": "^7.2.2"
+		"@semantic-release/changelog": "^6.0.1",
+		"@semantic-release/git": "^10.0.1",
+		"@semantic-release/github": "^8.0.5",
+		"@semantic-release/release-notes-generator": "^10.0.3",
+		"concurrently": "^7.2.2",
+		"semantic-release": "^19.0.3"
+	},
+	"release": {
+		"branches": "main",
+		"plugins": [
+			[
+				"@semantic-release/commit-analyzer",
+				{
+					"releaseRules": [
+						{
+							"type": "revert",
+							"release": "patch"
+						},
+						{
+							"type": "refactor",
+							"release": "minor"
+						}
+					]
+				}
+			],
+			"@semantic-release/release-notes-generator",
+			[
+				"@semantic-release/changelog",
+				{
+					"changelogTitle": "Changelog"
+				}
+			],
+			"@semantic-release/npm",
+			"@semantic-release/git",
+			"@semantic-release/github"
+		]
 	}
 }

package/server/.env

@@ -69,3 +69,7 @@ EMAIL_SENDMAIL_PATH="/usr/sbin/sendmail"
 ## Default User
 ADMIN_EMAIL="admin@example.com"
 ADMIN_PASSWORD="password"
+
+####################################################################################################
+## NUXT SERVER
+NUXT_SERVER="http://localhost:3000"

package/client/plugins/directusLogin.client.ts

@@ -1,12 +0,0 @@
-export default defineNuxtPlugin(async (nuxtApp) => {
-	try {
-		const config = useRuntimeConfig()
-		const { login } = useDirectusAuth()
-		await login({
-			email: config.public.directusEmail,
-			password: config.public.directusPassword,
-		})
-	} catch (error) {
-		console.error(error)
-	}
-})

package/client/server/api/directus/collection.post.ts

@@ -1,17 +0,0 @@
-import { createPage } from "@nuxtus/generator"
-
-export default defineEventHandler(async (event) => {
-	if (process.env.NODE_ENV !== "production") {
-		const body = await useBody(event)
-		try {
-			const collection = body.collection
-			createPage(collection, body.singleton)
-		} catch (err) {
-			console.error(err.message)
-			throw new Error("Unable to create page: " + err.message)
-		}
-		return {
-			api: "ok",
-		}
-	}
-})

package/client/server/api/directus/field.post.ts

@@ -1,32 +0,0 @@
-import axios from "axios"
-import fs from "fs"
-import openapiTS from "openapi-typescript"
-
-export default defineEventHandler(async (event) => {
-	if (process.env.NODE_ENV !== "production") {
-		const config = useRuntimeConfig()
-		// TODO: Can't seem to share login from directusLogin (currently client only plugin)
-		try {
-			const { data } = await axios.post("http://localhost:8055/auth/login", {
-				email: config.public.directusEmail,
-				password: config.public.directusPassword,
-			})
-			axios.defaults.headers.common[
-				"Authorization"
-			] = `Bearer ${data.data.access_token}`
-		} catch (err) {
-			console.error("Failed to login to Directus: " + err.message)
-			throw err
-		}
-		const openapi = await axios.get("http://localhost:8055/server/specs/oas")
-		// console.log(JSON.stringify(openapi.data.components.schemas))
-		const types = await openapiTS(openapi.data)
-		if (!fs.existsSync("interfaces")) {
-			fs.mkdirSync("interfaces")
-		}
-		fs.writeFileSync("interfaces/nuxtus.ts", types)
-		return {
-			api: "ok",
-		}
-	}
-})