@flyo/nitro-astro 2.0.1 → 2.0.2

package/dist/types/cdn.d.ts

@@ -0,0 +1,4 @@
+import { ExternalImageService } from 'astro';
+
+declare const service: ExternalImageService;
+export default service;

package/dist/types/components/BlockSlot.d.ts

@@ -0,0 +1,3 @@
+import { default as BlockSlot } from './BlockSlot.astro';
+
+export default BlockSlot;

package/dist/types/components/FallbackComponent.d.ts

@@ -0,0 +1,3 @@
+import { default as FallbackComponent } from './FallbackComponent.astro';
+
+export default FallbackComponent;

package/dist/types/components/FlyoNitroBlock.d.ts

@@ -0,0 +1,3 @@
+import { default as FlyoNitroBlock } from './FlyoNitroBlock.astro';
+
+export default FlyoNitroBlock;

package/dist/types/components/FlyoNitroPage.d.ts

@@ -0,0 +1,3 @@
+import { default as FlyoNitroPage } from './FlyoNitroPage.astro';
+
+export default FlyoNitroPage;

package/dist/types/components/MetaInfo.d.ts

@@ -0,0 +1,3 @@
+import { default as MetaInfo } from './MetaInfo.astro';
+
+export default MetaInfo;

package/dist/types/components/MetaInfoEntity.d.ts

@@ -0,0 +1,3 @@
+import { default as MetaInfoEntity } from './MetaInfoEntity.astro';
+
+export default MetaInfoEntity;

package/dist/types/components/MetaInfoPage.d.ts

@@ -0,0 +1,3 @@
+import { default as MetaInfoPage } from './MetaInfoPage.astro';
+
+export default MetaInfoPage;

package/dist/types/index.d.ts

@@ -0,0 +1,66 @@
+import { AstroIntegration, AstroGlobal } from 'astro';
+import { Configuration, ConfigApi, EntitiesApi, PagesApi, SearchApi, SitemapApi, VersionApi, Block, ConfigResponse } from '@flyo/nitro-typescript';
+
+/**
+ * Options for configuring the integration.
+ */
+export interface IntegrationOptions {
+    /**
+     * Access token for authentication.
+     * This is either the production or development token from the flyo cloud interface. Keep in mind that requests for production accessToken will be effectivly cached from the flyo cdn, but the development accessToken requests will not be cached.
+     */
+    accessToken: string;
+    /**
+     * Enables live editing mode.
+     * 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. */
+    componentsDir: string;
+    /** Object containing component definitions. */
+    components: object;
+    /**
+     * (Optional) Fallback component name.
+     * If provided, this component will be used as a fallback. This fallback component will be used when the requested component is not found and only in live editing mode.
+     */
+    fallbackComponent?: string;
+    /**
+     * TTL (Time-To-Live) for client-side cache headers, in seconds.
+     * Default is 900 seconds (15 minutes) its only availble if the liveEdit is disabled. Use 0 to disable client caching.
+     */
+    clientCacheHeaderTtl: number;
+    /**
+     * TTL (Time-To-Live) for server-side cache headers, in seconds.
+     * Default is 1200 seconds (20 minutes) its only availble if the liveEdit is disabled. Use 0 to disable server caching.
+     */
+    serverCacheHeaderTtl: number;
+}
+export interface FlyoIntegration {
+    config: Configuration;
+    options: {
+        liveEdit: boolean;
+        componentsDir: string;
+        clientCacheHeaderTtl: number;
+        serverCacheHeaderTtl: number;
+    };
+}
+export declare function useFlyoIntegration(): FlyoIntegration;
+/**
+ * Returns the API main configuration which is used by the SDK.
+ * It holds the access key and is globally available.
+ */
+export declare function useConfiguration(): Configuration;
+/**
+ * Resolves (if not done) and returns the main configuration object of
+ * the SDK, which is done in the middleware.ts and using the useConfigApi()
+ * function.
+ */
+export declare function useConfig(astro: AstroGlobal): Promise<ConfigResponse>;
+export declare function useConfigApi(): ConfigApi;
+export declare function useEntitiesApi(): EntitiesApi;
+export declare function usePagesApi(): PagesApi;
+export declare function useSearchApi(): SearchApi;
+export declare function useSitemapApi(): SitemapApi;
+export declare function useVersionApi(): VersionApi;
+export declare function editableBlock(block: Block): object;
+export default function flyoNitroIntegration(options: IntegrationOptions): AstroIntegration;

package/dist/types/middleware.d.ts

@@ -0,0 +1 @@
+export declare const onRequest: import('astro').MiddlewareHandler;

package/dist/types/sitemap.d.ts

@@ -0,0 +1,3 @@
+import { AstroGlobal } from 'astro';
+
+export declare function GET(config: AstroGlobal): Promise<Response>;

package/dist/types/toolbar.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('astro').DevToolbarApp;
+export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@flyo/nitro-astro",
-  "version": "2.0.1",
+  "version": "2.0.2",
   "description": "Nitro Astro connecting Flyo Headless to Astro",
   "main": "./dist/nitro-astro.js",
   "module": "./dist/nitro-astro.mjs",
@@ -12,15 +12,15 @@
     "@flyo/nitro-typescript": "^1.0.9"
   },
   "devDependencies": {
-    "astro": "^4.10.1",
-    "typescript": "5.4.5",
-    "@types/node": "20.12.11",
-    "vite": "^5.2.13",
+    "astro": "^4.11.4",
+    "typescript": "5.5.3",
+    "@types/node": "20.14.9",
+    "vite": "^5.3.3",
     "vite-plugin-dts": "^3.9.1"
   },
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
+      "types": "./dist/types/index.d.ts",
       "import": "./dist/nitro-astro.mjs",
       "require": "./dist/nitro-astro.js"
     },
@@ -64,17 +64,11 @@
     "./sitemap.ts": "./sitemap.ts",
     "./toolbar.ts": "./toolbar.ts"
   },
-  "type": "module",
   "files": [
-    "module.d.ts",
     "dist",
-    "components",
-    "cdn.ts",
-    "middleware.ts",
-    "sitemap.ts",
-    "toolbar.ts"
+    "components"
   ],
-  "types": "./dist/index.d.ts",
+  "types": "./dist/types/index.d.ts",
   "author": "Basil Suter <git@nadar.io>",
   "license": "MIT",
   "release": {

package/cdn.ts

@@ -1,48 +0,0 @@
-/**
- * Create an astro ExternalImageService for flyo where the base url with transormations looks like https://storage.flyo.cloud/image_7a158241.jpg/thumb/250x250?format=webp
- */
-import type { ExternalImageService, ImageTransform } from "astro";
-
-const service: ExternalImageService = {
-  getURL(options: ImageTransform) {
-    // check if the options.src contains already https://storage.flyo.cloud
-    // if not we add it to the url
-
-    let url =
-      typeof options.src === "string" &&
-      options.src.includes("https://storage.flyo.cloud")
-        ? options.src
-        : `https://storage.flyo.cloud/${options.src}`;
-
-    // if either width or height are defined we add the /thumb/$widthx$height path to it.
-    let width: string | number | null = options.width ? options.width : null;
-    let height: string | number | null = options.height ? options.height : null;
-
-    if (width || height) {
-      if (width === null) {
-        width = "null";
-      }
-      if (height === null) {
-        height = "null";
-      }
-      url += `/thumb/${width}x${height}`;
-    }
-
-    const format = options.format ? options.format : "webp";
-
-    return `${url}?format=${format}`;
-  },
-
-  getHTMLAttributes(options) {
-    const { ...attributes } = options;
-    return {
-      ...attributes,
-      width: options.width ?? null, // width and height are required to prevent CLS and enable lazy loading for chrome.
-      height: options.height ?? null, // width and height are required to prevent CLS and enable lazy loading for chrome.
-      loading: options.loading ?? "lazy",
-      decoding: options.decoding ?? "async",
-    };
-  },
-};
-
-export default service;

package/middleware.ts

@@ -1,45 +0,0 @@
-import { defineMiddleware } from "astro:middleware";
-import { useConfigApi, useFlyoIntegration } from "./index.ts";
-
-let resolvedValue;
-
-async function getConfigPromise(context) {
-  if (resolvedValue) {
-    // If the value is already resolved, return a resolved promise with the value
-    return resolvedValue;
-  }
-
-  // Fetch the config and store the resolved value
-  const value = await useConfigApi().config({
-    lang: context.currentLocale,
-  });
-  resolvedValue = value;
-  return value;
-}
-
-export const onRequest = defineMiddleware(async (context, next) => {
-  context.locals.config = getConfigPromise(context);
-
-  const liveEditEnabled = useFlyoIntegration().options.liveEdit;
-
-  if (!liveEditEnabled) {
-    const response = await next();
-
-    response.headers.set(
-      "Vercel-CDN-Cache-Control",
-      `max-age=${useFlyoIntegration().options.serverCacheHeaderTtl}`
-    );
-    response.headers.set(
-      "CDN-Cache-Control",
-      `max-age=${useFlyoIntegration().options.serverCacheHeaderTtl}`
-    );
-    response.headers.set(
-      "Cache-Control",
-      `max-age=${useFlyoIntegration().options.clientCacheHeaderTtl}`
-    );
-
-    return response;
-  }
-
-  return next();
-});

package/module.d.ts

@@ -1,4 +0,0 @@
-declare module "virtual:*" {
-  const component: any;
-  export default component;
-}

package/sitemap.ts

@@ -1,34 +0,0 @@
-import { useSitemapApi } from "./index.ts";
-import type { AstroGlobal } from "astro";
-
-function buildUrl(path: string, domain: string) {
-  return `${domain.replace(/\/$/, "")}/${path.replace(/^\//, "")}`;
-}
-
-export async function GET(config: AstroGlobal) {
-  const sitemap = await useSitemapApi().sitemap();
-
-  let xml = '<?xml version="1.0" encoding="UTF-8"?>';
-  xml += '<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">';
-
-  const routes = [];
-  for (const item of sitemap) {
-    if (item.entity_type === "nitro-page") {
-      if (routes.includes(item.entity_slug)) {
-        continue;
-      }
-      routes.push(item.entity_slug);
-      xml += `<url><loc>${buildUrl(item.entity_slug, config.site.origin)}</loc></url>`;
-    } else if (item.routes?.detail) {
-      xml += `<url><loc>${buildUrl(item.routes["detail"], config.site.origin)}</loc></url>`;
-    }
-  }
-
-  xml += "</urlset>";
-
-  return new Response(xml, {
-    headers: {
-      "Content-Type": "application/xml",
-    },
-  });
-}

package/toolbar.ts

@@ -1,30 +0,0 @@
-import { defineToolbarApp } from "astro/toolbar";
-
-export default defineToolbarApp({
-  init(canvas) {
-    const windowElement = document.createElement("astro-dev-toolbar-window");
-
-    const links = [
-      { link: "https://flyo.cloud", text: "Flyo Cloud Login" },
-      {
-        link: "https://dev.flyo.cloud/nitro/",
-        text: "Flyo Nitro Developer Portal",
-      },
-      {
-        link: "https://nitro-openapi.flyo.cloud/",
-        text: "Flyo Nitro API Documentation",
-      },
-    ];
-
-    const content = links
-      .map(
-        (link) =>
-          `<astro-dev-toolbar-card link="${link.link}" style="margin-bottom:8px;">
-          ${link.text}
-        </astro-dev-toolbar-card>`
-      )
-      .join("");
-    windowElement.innerHTML = content;
-    canvas.appendChild(windowElement);
-  },
-});