@nuxtus/nuxtus 1.0.6 → 1.2.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,25 @@
-# Nuxtus
+Changelog
+
+# [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
+
+- Automatically generate types from collections
+- Tidy up server end point
+- Automatically open browser window on Nuxt start
 
 ## 1.0.6
 
@@ -48,4 +69,4 @@
 
 ## 0.0.1
 
-Initial alpha release.
+Initial alpha release.

package/README.md

@@ -21,6 +21,7 @@ https://user-images.githubusercontent.com/324026/175452950-46bd51a6-3fd9-441d-80
   - [HeroIcons](https://heroicons.com/)
   - [Google Fonts](https://github.com/nuxt-community/google-fonts-module)
   - [Nuxtus CLI](https://github.com/nuxtus/cli)
+  - Typescript types
 
 ## Quickstart (preferred)
 
@@ -45,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:
@@ -63,23 +68,20 @@ $ npm start
 
 Nuxtus includes a POST endpoint located /api/directus/collection that will run in development. If you used `npx create-nuxtus` to create your Nuxtus project and selected "yes" to automatically creating pages from Directus then this is already configured in Directus for you.
 
-If not, create a new Flow in Directus as follows:
-
-#### Trigger
+Collections are also typed automatically, simply prepend "Items" to the collection name as per below:
 
-Type: action
-Scope: items.create
-Collections: directus_collections
-
-#### Webhook / Request URL
+```typescript
+<script setup lang="ts">
+  import { components } from "../interfaces/nuxtus";
+  type Test = components["schemas"]["ItemsTest"];
+</script>
+```
 
-URL: http://localhost:3000/api/directus/collection
-Method: POST
-Request Body: `{{$last.payload}}`
+> Because OpenAPI schemas may have invalid TypeScript characters as names, the square brackets are a safe way to access every property.
 
 ### Manually creating pages
 
-Nuxtus includes Nuxtus CLI which will automatically generate listing and view pages of any Directus collections. To use it:
+Nuxtus includes Nuxtus CLI which will generate listing and view pages of any Directus collection on demand. To use it:
 
 1. Log in to Directus ([http://0.0.0.0:8055/admin/login](http://0.0.0.0:8055/admin/login)) and [create a collection](https://docs.directus.io/configuration/data-model/#creating-a-collection)
 2. From the client folder (`cd client`) run `nuxtus create` and follow the prompts
@@ -98,6 +100,13 @@ 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
 
+Nuxtus wouldn't be possible without the following amazing technologies:
 
+[Directus](https://directus.io)
+[Nuxt](https://nuxt.js.org)
+[Nuxt-Directus](https://nuxt-directus.netlify.app/)
+[OpenApi Typescript](https://www.npmjs.com/package/openapi-typescript)

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)
@@ -13,5 +13,19 @@ Todo:
   ☐ Documentation: https://docusaurus.io/ or https://vuepress.vuejs.org/
   ✔ 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?
-  ☐ Add all questions in create-app to start of process for better user flow
+  ☐ 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 @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
+  ☐ 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 @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 (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)

package/client/package.json

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

package/client/plugins/{directusLogin.ts → directusLogin.client.ts}

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

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

@@ -1,10 +1,16 @@
-import { createPage } from "@nuxtus/generator"
+import Generator from "@nuxtus/generator"
 
 export default defineEventHandler(async (event) => {
 	if (process.env.NODE_ENV !== "production") {
 		const body = await useBody(event)
-		// TODO: Wrap in try/catch and return HTTP error if errors
-		createPage(body.collection, body.singleton)
+		const nuxtus = new Generator()
+		try {
+			const collection = body.collection
+			nuxtus.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

@@ -0,0 +1,11 @@
+import Generator from "@nuxtus/generator"
+
+export default defineEventHandler(async (event) => {
+	if (process.env.NODE_ENV !== "production") {
+		const nuxtus = new Generator()
+		await nuxtus.createTypes()
+		return {
+			api: "ok",
+		}
+	}
+})

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@nuxtus/nuxtus",
 	"description": "Directus/Nuxt boilerplate with Tailwind CSS.",
-	"version": "1.0.6",
+	"version": "1.2.0",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/nuxtus/nuxtus.git"
@@ -24,11 +24,46 @@
 		"registry": "https://registry.npmjs.org/"
 	},
 	"scripts": {
-		"client": "cd client && npm run dev",
+		"client": "cd client && npm run dev -- -o",
 		"server": "cd server && npx directus start",
 		"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/server/package.json

@@ -11,7 +11,7 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "directus": "^9.13.0",
+    "directus": "^9.14.1",
     "sqlite3": "^5.0.8"
   }
 }