Merge pull request #1469 from strapi/main

Production release week 5

Author: stb13579

docs/developer-docs/latest/developer-resources/cli/CLI.md

@@ -6,10 +6,19 @@ canonicalUrl: https://docs.strapi.io/developer-docs/latest/developer-resources/c
 
 # Command Line Interface (CLI)
 
-Strapi comes with a full featured Command Line Interface (CLI) which lets you scaffold and manage your project in seconds.
+Strapi comes with a full featured Command Line Interface (CLI) which lets you scaffold and manage your project in seconds. The CLI works with both the `yarn` and `npm` package managers. 
+
+:::caution
+Interactive commands such as `strapi admin:create-user` don't display prompts with `npm`. A fix for the `npm` package manager is anticipated by March 2023. In the meantime, consider using the `yarn` package manager.
+:::
 
 ::: note
 It is recommended to install Strapi locally only, which requires prefixing all of the following `strapi` commands with the package manager used for the project setup (e.g `npm run strapi help` or `yarn strapi help`) or a dedicated node package executor (e.g. `npx strapi help`).
+
+To pass options with `npm` use the syntax: `npm run strapi <command> -- --<option>`
+
+To pass options with `yarn` use the syntax: `yarn run strapi <command> --<option>`
+
 :::
 
 ## strapi new

docs/developer-docs/latest/developer-resources/content-api/integrations/nuxt-js.md

@@ -8,7 +8,7 @@ canonicalUrl: https://docs.strapi.io/developer-docs/latest/developer-resources/c
 
 This integration guide is following the [Quick Start Guide](/developer-docs/latest/getting-started/quick-start.md). We assume that you have fully completed its "Hands-on" path, and therefore can consume the API by browsing this [url](http://localhost:1337/api/restaurants).
 
-If you haven't gone through the Quick Start Guide, the way you request a Strapi API with [Nuxt 3](https://v3.nuxtjs.org/) remains the same except that you will not fetch the same content.
+If you haven't gone through the Quick Start Guide, the way you request a Strapi API with [Nuxt 3](https://nuxtjs.org/) remains the same except that you will not fetch the same content.
 
 ## Create a Nuxt 3 app
 
@@ -20,7 +20,7 @@ npx nuxi init nuxt-app
 
 ## Use an HTTP client
 
-For this example we are using the awesome [@nuxt/strapi](https://strapi.nuxtjs.org/) module and Nuxt helper function [$fetch](https://v3.nuxtjs.org/api/utils/dollarfetch/) (based on `ohmyfetch`). You may choose any of this variants.
+For this example we are using the awesome [@nuxt/strapi](https://strapi.nuxtjs.org/) module and Nuxt helper function [$fetch](https://nuxt.com/docs/api/utils/dollarfetch/) (based on `ohmyfetch`). You may choose any of this variants.
 
 :::: tabs card
 
@@ -62,15 +62,15 @@ Be sure that you activated the `find` and `findOne` permission for the `restaura
 
 `@nuxtjs/strapi` exposes composables that are auto-imported by Nuxt 3. Note that `delete` function must be renamed because it's reserved word in JavaScript.
 
+::: request Example GET request with @nuxtjs/strapi
+
 ```js
 <script setup lang="ts">
 import type { Restaurant } from '~/types'
 const { find, findOne, create, update, delete: remove } = useStrapi()
 </script>
 ```
 
-::: request Example GET request with @nuxtjs/strapi
-
 ```js
 // Get all restaurants
 const response = await find<Restaurant>('restaurants')
@@ -266,29 +266,28 @@ Consider an example of a simple CRUD Nuxt application that implements the functi
 
 `./pages/index.vue`
 
-```js
+```html
 <template>
   <div>
-    <ul v-if="!pending">
-      <li v-for="restaurant in restaurants.data" :key="restaurant.id">
+    <ul>
+      <li v-for="restaurant in restaurants?.data" :key="restaurant.id">
         {{ restaurant.attributes.name }}
         <button @click="$router.push(`${$route.path}/restaurant/${restaurant.id}`)">Edit</button>
         <button @click="deleteRestaurant(restaurant.id)">Delete</button>
       </li>
     </ul>
-    <div v-else>Loading...</div>
     <nuxt-link :to="`${$route.path}/restaurant/create`">Create</nuxt-link>
   </div>
 </template>
 
 <script setup lang="ts">
-import type { Restaurant } from "~/types"
-const { find, delete: remove } = useStrapi()
-const { data: restaurants, pending, refresh, error } = await useAsyncData(
+import type { Restaurant } from '~/types'
+const { find, delete: remove } = useStrapi() // delete is keyword in JS, must not be used
+const { data: restaurants, refresh } = await useAsyncData(
   'restaurants',
   () => find<Restaurant>('restaurants')
 )
-onMounted(() => refresh())
+
 const deleteRestaurant = async (restaurantId: number) => {
   await remove<Restaurant>("restaurants", restaurantId);
   refresh()
@@ -298,52 +297,58 @@ const deleteRestaurant = async (restaurantId: number) => {
 
 `./pages/restaurant/create.vue`
 
-```js
+```html
 <template>
   <div>
-    <div><input type="text" v-model="restaurant.name" /></div>
-    <div><textarea v-model="restaurant.description"></textarea></div>
+    <div><input type="text" v-model="name" /></div>
+    <div><textarea v-model="description"></textarea></div>
     <button @click="createRestaurant();$router.go(-1)">Create</button>
     <button @click="$router.go(-1)">Cancel</button>
-    {{ restaurant }}
   </div>
 </template>
 
 <script setup lang="ts">
 import type { Restaurant } from "~/types"
 const { create } = useStrapi()
-const restaurant = ref({ name: "", description: "" })
+const name = ref("")
+const description = ref("")
 const createRestaurant = async () => {
   await create<Restaurant>("restaurants", { 
-    name: restaurant.value.name, 
-    description: restaurant.value.description })
+    name: name.value,
+    description: description.value
+  })
 }
 </script>
 ```
 
 `./pages/restaurant/[id].vue`
 
-```js
+```html
 <template>
   <div>
-    <div><input type="text" v-model="restaurant.name" /></div>
-    <div><textarea v-model="restaurant.description"></textarea></div>
+    <div><input type="text" v-model="name" /></div>
+    <div><textarea v-model="description"></textarea></div>
     <button @click="updateRestaurant();$router.go(-1)">Update</button>
     <button @click="$router.go(-1)">Cancel</button>
-    {{ restaurant }}
   </div>
 </template>
 
 <script setup lang="ts">
 import type { Restaurant } from '~/types'
-const route = useRoute()
+
 const { findOne, update } = useStrapi()
-const response = await findOne<Restaurant>("restaurants", route.params.id)
-const restaurant : Restaurant = ref(response.data.attributes)
+
+const route = useRoute()
+const restaurantId: number = +route.params.id // cast to number
+
+const response = await findOne<Restaurant>("restaurants", restaurantId)
+const name = ref(response.data.attributes.name)
+const description = ref(response.data.attributes.description)
 const updateRestaurant = async () => {
-  await update<Restaurant>("restaurants", route.params.id, { 
-    name: restaurant.value.name, 
-    description: restaurant.value.description })
+  await update<Restaurant>("restaurants", restaurantId, { 
+    name: name.value,
+    description: description.value
+  })
 }
 </script>
 ```
@@ -354,27 +359,26 @@ const updateRestaurant = async () => {
 
 `./pages/index.vue`
 
-```js
+```html
 <template>
   <div>
-    <ul v-if="!pending">
+    <ul>
       <li v-for="restaurant in restaurants.data" :key="restaurant.id">
         {{ restaurant.attributes.name }}
         <button @click="$router.push(`${$route.path}/restaurant/${restaurant.id}`)">Edit</button>
         <button @click="deleteRestaurant(restaurant.id)">Delete</button>
       </li>
     </ul>
-    <div v-else>Loading...</div>
     <nuxt-link :to="`${$route.path}/restaurant/create`">Create</nuxt-link>
   </div>
 </template>
 
 <script setup>
-const { data: restaurants, pending, refresh } = await useAsyncData(
+const { data: restaurants, refresh } = await useAsyncData(
   'restaurants', 
   () => $fetch("http://localhost:1337/api/restaurants")
 )
-onMounted(() => refresh())
+
 const deleteRestaurant = async (restaurantId) => {
   await $fetch(`http://localhost:1337/api/restaurants/${restaurantId}`, {
     method: 'DELETE'
@@ -386,14 +390,13 @@ const deleteRestaurant = async (restaurantId) => {
 
 `./pages/restaurant/create.vue`
 
-```js
+```html
 <template>
   <div>
     <div><input type="text" v-model="restaurant.name" /></div>
     <div><textarea v-model="restaurant.description"></textarea></div>
     <button @click="createRestaurant();$router.go(-1)">Create</button>
     <button @click="$router.go(-1)">Cancel</button>
-    {{ restaurant }}
   </div>
 </template>
 
@@ -415,14 +418,13 @@ const createRestaurant = async () => {
 
 `./pages/restaurant/[id].vue`
 
-```js
+```html
 <template>
   <div>
     <div><input type="text" v-model="restaurant.name" /></div>
     <div><textarea v-model="restaurant.description"></textarea></div>
     <button @click="updateRestaurant();$router.go(-1)">Update</button>
     <button @click="$router.go(-1)">Cancel</button>
-    {{ restaurant }}
   </div>
 </template>
 

docs/developer-docs/latest/developer-resources/data-management.md

@@ -23,6 +23,10 @@ Occasionally you need to move data out of or into a Strapi instance. The data ma
 The `strapi export` and `strapi import` CLI commands with all of the available options are listed in the [Command Line Interface documentation](/developer-docs/latest/developer-resources/cli/CLI.md#strapi-export).
 :::
 
+:::caution
+Interactive CLI commands do not currently work with the `npm` package manager. For `strapi export` and `strapi import` this means the encryption key prompt is not visible in the CLI. A fix is anticipated by early March 2023. In the meantime consider using the `yarn` package manager.
+:::
+
 ## Export data using the CLI tool
 
 The `strapi export` command, by default, exports data as an encrypted and compressed `.tar.gz.enc` file. The default export command exports:
@@ -56,7 +60,7 @@ yarn strapi export --file my-strapi-export
 <code-block title="NPM">
 
 ```bash
-npm strapi export  --file my-strapi-export
+npm run strapi export  -- --file my-strapi-export
 ```
 
 </code-block>
@@ -87,7 +91,7 @@ yarn strapi export --no-encrypt
 <code-block title="NPM">
 
 ```bash
-npm strapi export --no-encrypt
+npm run strapi export -- --no-encrypt
 ```
 
 </code-block>
@@ -108,7 +112,7 @@ yarn strapi export --key my-encryption-key
 <code-block title="NPM">
 
 ```bash
-npm strapi export --key my-encryption-key
+npm run strapi export -- --key my-encryption-key
 ```
 
 </code-block>
@@ -134,7 +138,7 @@ yarn strapi export --no-compress
 <code-block title="NPM">
 
 ```bash
-npm strapi export --no-compress
+npm run strapi export -- --no-compress
 ```
 
 </code-block>
@@ -163,7 +167,7 @@ yarn strapi export --only content
 <code-block title="NPM">
 
 ```bash
-npm strapi export --only content
+npm run strapi export -- --only content
 ```
 
 </code-block>
@@ -192,7 +196,7 @@ yarn strapi export --exclude files,content
 <code-block title="NPM">
 
 ```bash
-npm strapi export --exclude files,content
+npm run strapi export -- --exclude files,content
 ```
 
 </code-block>
@@ -231,7 +235,7 @@ yarn strapi import -f export_20221213105643.tar.gz.enc
 <code-block title="NPM">
 
 ```bash
-npm strapi import -f export_20221213105643.tar.gz.enc
+npm run strapi import -- -f export_20221213105643.tar.gz.enc
 ```
 
 </code-block>
@@ -255,7 +259,7 @@ yarn strapi import -f export_20221213105643.tar.gz.enc --key my-encryption-key
 <code-block title="NPM">
 
 ```bash
-npm strapi import -f export_20221213105643.tar.gz.enc --key my-encryption-key
+npm run strapi import -- -f export_20221213105643.tar.gz.enc --key my-encryption-key
 ```
 
 </code-block>
@@ -280,7 +284,7 @@ yarn strapi import -f export_20221213105643.tar.gz.enc --force --key my-encrypti
 <code-block title="NPM">
 
 ```bash
-npm strapi import -f export_20221213105643.tar.gz.enc --force --key my-encryption-key
+npm run strapi import -- -f export_20221213105643.tar.gz.enc --force --key my-encryption-key
 ```
 
 </code-block>
@@ -313,7 +317,7 @@ yarn strapi import -f export_20221213105643.tar.gz.enc --exclude files
 <code-block title="NPM">
 
 ```bash
-npm strapi import -f export_20221213105643.tar.gz.enc --exclude files
+npm run strapi import -- -f export_20221213105643.tar.gz.enc --exclude files
 ```
 
 </code-block>
@@ -342,7 +346,7 @@ yarn strapi import -f export_20221213105643.tar.gz.enc --only config
 <code-block title="NPM">
 
 ```bash
-npm strapi import -f export_20221213105643.tar.gz.enc --only config
+npm run strapi import -- -f export_20221213105643.tar.gz.enc --only config
 ```
 
 </code-block>

docs/developer-docs/latest/developer-resources/plugin-api-reference/server.md

@@ -21,7 +21,7 @@ To tap into the Server API, create a `strapi-server.js` file at the root of the
 | Parameter type         | Available parameters                                                                                                                                                                                           |
 | ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | Lifecycle functions    | <ul><li> [register](#register)</li><li>[bootstrap](#bootstrap)</li><li>[destroy](#destroy)</li></ul>                                                                                                           |
-| Configuration          | [config](#configuration) object                                                                                                                                                                                |
+| Configuration          | <ul><li>[config](#configuration) object   </li> <li>[Cron](#cron)</li></ul>                                                                                                                                                                             |
 | Backend customizations | <ul><li>[contentTypes](#content-types)</li><li>[routes](#routes)</li><li>[controllers](#controllers)</li><li>[services](#services)</li><li>[policies](#policies)</li><li>[middlewares](#middlewares)</li></ul> |
 
 ## Lifecycle functions
@@ -115,6 +115,25 @@ Once defined, the configuration can be accessed:
 * with `strapi.plugin('plugin-name').config('some-key')` for a specific configuration property,
 * or with `strapi.config.get('plugin.plugin-name')` for the whole configuration object.
 
+## Cron
+
+The `cron` object allows you to add cron jobs to the Strapi instance.
+
+```js
+// path: ./src/plugins/my-plugin/strapi-server.js
+
+module.exports = () => ({
+  bootstrap({ strapi }) {
+        strapi.cron.add({
+          // runs every second
+        '* * * * * *': ({ strapi }) => {
+          console.log("hello from plugin")
+        },
+    })
+  },
+});
+```
+
 ## Backend customization
 
 ### Content-types