@flyo/nitro-astro 2.0.8 → 2.0.10

package/README.md

@@ -12,10 +12,11 @@ This guide targets developers and web designers aiming to combine Flyo Nitro CMS
 
 ## Installation
 
-To install the package, execute the following command:
+To install the `@flyo/nitro-astro` package, execute the following command:
 
 ```bash
-astro add @flyo/nitro-astro
+npm install @flyo/nitro-astro
+# yarn add @flyo/nitro-astro
 ```
 
 Then, revise and adjust the configuration in your `astro.config.mjs`:
@@ -41,6 +42,7 @@ export default defineConfig({
 });
 ```
 
+> [!WARNING]
 > The nitro astro integration requires an SSR setup which is done by using `output: 'server'`.
 
 ### Pages
@@ -245,7 +247,8 @@ All endpoints accept a `lang` parameter to retrieve data in the desired language
   await useEntitiesApi().entityByUniqueid({ uniqueid, lang: Astro.currentLocale });
   ```
 
-Note: If your entity details are internationalized (i18n), you need to create separate detail pages for each language.
+> [!NOTE]  
+> If your entity details are internationalized (i18n), you need to create separate detail pages for each language.
 
 ```
 .

package/dist/nitro-astro.js

@@ -29,7 +29,7 @@
     </g>
 </g>
 </svg>
-`;function $e(e){const n={accessToken:!1,liveEdit:!1,fallbackComponent:null,componentsDir:"src/components/flyo",serverCacheHeaderTtl:1200,clientCacheHeaderTtl:900,...e};return n.liveEdit==="true"?n.liveEdit=!0:n.liveEdit==="false"&&(n.liveEdit=!1),{name:"@flyo/nitro-astro",hooks:{"astro:config:setup":({injectScript:t,updateConfig:i,injectRoute:a,addMiddleware:o,addDevToolbarApp:r})=>{r({id:"flyo-nitro",name:"Flyo Nitro",icon:xe,entrypoint:"@flyo/nitro-astro/toolbar.ts"}),a({pattern:"sitemap.xml",entrypoint:"@flyo/nitro-astro/sitemap.ts"}),o({entrypoint:"@flyo/nitro-astro/middleware.ts",order:"post"}),i({image:{service:{entrypoint:"@flyo/nitro-astro/cdn.ts"}},vite:{plugins:[Ie(e.componentsDir,e.components||{},e.fallbackComponent)]}}),t("page-ssr",`
+`;function $e(e){const n={accessToken:!1,liveEdit:!1,fallbackComponent:null,componentsDir:"src/components/flyo",serverCacheHeaderTtl:1200,clientCacheHeaderTtl:900,...e};return n.liveEdit==="true"?n.liveEdit=!0:n.liveEdit==="false"&&(n.liveEdit=!1),{name:"@flyo/nitro-astro",hooks:{"astro:config:setup":({injectScript:t,updateConfig:i,injectRoute:a,addMiddleware:o,addDevToolbarApp:r})=>{r({id:"flyo-nitro",name:"Flyo Nitro",icon:xe,entrypoint:"@flyo/nitro-astro/toolbar.ts"}),a({pattern:"sitemap.xml",entrypoint:"@flyo/nitro-astro/sitemap.ts"}),o({entrypoint:"@flyo/nitro-astro/middleware.ts",order:"post"}),i({image:{service:{entrypoint:"@flyo/nitro-astro/cdn.ts"}},vite:{plugins:[Ie(n.componentsDir,n.components||{},n.fallbackComponent)]}}),t("page-ssr",`
             import { Configuration } from '@flyo/nitro-typescript'
 
             var defaultConfig = new Configuration({

package/dist/nitro-astro.mjs

@@ -789,9 +789,9 @@ function Pe(e) {
           vite: {
             plugins: [
               Re(
-                e.componentsDir,
-                e.components || {},
-                e.fallbackComponent
+                n.componentsDir,
+                n.components || {},
+                n.fallbackComponent
               )
             ]
           }

package/dist/types/index.d.ts

@@ -15,9 +15,23 @@ export interface IntegrationOptions {
      * If enabled, the user can interact with the components, also it represents the application to be in development mode.
      */
     liveEdit: string | boolean | number;
-    /** Directory path for components. */
+    /**
+     * Directory path for components.
+     * By default the flyo components are located in `src/components/flyo`.
+     */
     componentsDir: string;
-    /** Object containing component definitions. */
+    /**
+     * Object containing component definitions.
+     * The key is the component name defined in Flyo Interface, while the value is the name of the component inside the components directory.
+     * ```json
+     * components: {
+     *  FlyoComponentName: "FlyoComponentName",
+     *  AnotherFlyoComponent "subfolder/AnotherFlyoComponent",
+     * }
+     * ```
+     * > The suffix .astro is not required.
+     * > Adding new elements to components section, requires restarting the development server.
+     */
     components: object;
     /**
      * (Optional) Fallback component name.

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@flyo/nitro-astro",
-  "version": "2.0.8",
+  "version": "2.0.10",
   "description": "Connecting Flyo Headless Content Hub into your Astro project.",
   "homepage": "https://dev.flyo.cloud/nitro",
   "keywords": [
     "withastro",
-    "astro-adapter"
+    "flyo"
   ],
   "main": "./dist/nitro-astro.js",
   "module": "./dist/nitro-astro.mjs",