@wix/astro 1.0.7 → 1.0.9

package/src/utils/generateAppManifest.ts

@@ -1,38 +1,26 @@
 import type {
-  AppManifest,
-  BackofficeExtensionMenuItem,
-  BackofficeExtensionWidget,
-  BackofficeModal,
-  BackofficePage,
-  EcomAdditionalFees,
-  EcomDiscountsTrigger,
-  EcomGiftCardsProvider,
-  EcomPaymentSettings,
-  EcomShippingRates,
-  EcomValidations,
-  Webhook,
+  DevCenterAppManifest,
+  DevCenterBackofficeExtensionMenuItem,
+  DevCenterBackofficeExtensionWidget,
+  DevCenterBackofficeModal,
+  DevCenterBackofficePage,
+  DevCenterEcomAdditionalFees,
+  DevCenterEcomDiscountsTrigger,
+  DevCenterEcomGiftCardsProvider,
+  DevCenterEcomPaymentSettings,
+  DevCenterEcomShippingRates,
+  DevCenterEcomValidations,
+  DevCenterWebhook,
 } from '../schemas.js';
 import type { Model } from '../types.js';
 
 export function generateAppManifest(model: Model) {
-  const extensions = model.extensions
-    .map((extension) => extension.manifest)
+  const extensions = model.components
+    .map((component) => component.manifest)
     .map((manifest) => {
       switch (manifest.compType) {
         case 'BACK_OFFICE_EXTENSION_MENU_ITEM':
-          if (manifest.compData.backOfficeExtensionMenuItem.iframeUrl) {
-            return manifest;
-          }
-
-          return {
-            ...manifest,
-            compData: {
-              backOfficeExtensionMenuItem: {
-                ...manifest.compData.backOfficeExtensionMenuItem,
-                iframeUrl: `_wix/extensions/backoffice/${manifest.compId}`,
-              },
-            },
-          } satisfies BackofficeExtensionMenuItem;
+          return manifest satisfies DevCenterBackofficeExtensionMenuItem;
         case 'BACK_OFFICE_EXTENSION_WIDGET':
           if (manifest.compData.backOfficeExtensionWidget.iframeUrl) {
             return manifest;
@@ -46,7 +34,7 @@ export function generateAppManifest(model: Model) {
                 iframeUrl: `_wix/extensions/backoffice/${manifest.compId}`,
               },
             },
-          } satisfies BackofficeExtensionWidget;
+          } satisfies DevCenterBackofficeExtensionWidget;
         case 'BACK_OFFICE_MODAL':
           if (manifest.compData.backOfficeModal.iframeUrl) {
             return manifest;
@@ -60,7 +48,7 @@ export function generateAppManifest(model: Model) {
                 iframeUrl: `_wix/extensions/backoffice/${manifest.compId}`,
               },
             },
-          } satisfies BackofficeModal;
+          } satisfies DevCenterBackofficeModal;
         case 'BACK_OFFICE_PAGE':
           if (manifest.compData.backOfficePage.iframeUrl) {
             return manifest;
@@ -74,7 +62,7 @@ export function generateAppManifest(model: Model) {
                 iframeUrl: `_wix/extensions/backoffice/${manifest.compId}`,
               },
             },
-          } satisfies BackofficePage;
+          } satisfies DevCenterBackofficePage;
         case 'ECOM_ADDITIONAL_FEES':
           if (manifest.compData.ecomAdditionalFees.deploymentUri) {
             return manifest;
@@ -88,7 +76,7 @@ export function generateAppManifest(model: Model) {
                 deploymentUri: `_wix/extensions/service-plugins/${manifest.compId}`,
               },
             },
-          } satisfies EcomAdditionalFees;
+          } satisfies DevCenterEcomAdditionalFees;
         case 'ECOM_DISCOUNTS_TRIGGER':
           if (manifest.compData.ecomDiscountsTrigger.deploymentUri) {
             return manifest;
@@ -102,7 +90,7 @@ export function generateAppManifest(model: Model) {
                 deploymentUri: `_wix/extensions/service-plugins/${manifest.compId}`,
               },
             },
-          } satisfies EcomDiscountsTrigger;
+          } satisfies DevCenterEcomDiscountsTrigger;
         case 'ECOM_PAYMENT_SETTINGS':
           if (manifest.compData.ecomPaymentSettings.deploymentUri) {
             return manifest;
@@ -116,7 +104,7 @@ export function generateAppManifest(model: Model) {
                 deploymentUri: `_wix/extensions/service-plugins/${manifest.compId}`,
               },
             },
-          } satisfies EcomPaymentSettings;
+          } satisfies DevCenterEcomPaymentSettings;
         case 'ECOM_SHIPPING_RATES':
           if (manifest.compData.ecomShippingRates.deploymentUri) {
             return manifest;
@@ -130,7 +118,7 @@ export function generateAppManifest(model: Model) {
                 deploymentUri: `_wix/extensions/service-plugins/${manifest.compId}`,
               },
             },
-          } satisfies EcomShippingRates;
+          } satisfies DevCenterEcomShippingRates;
         case 'ECOM_VALIDATIONS':
           if (manifest.compData.ecomValidations.deploymentUri) {
             return manifest;
@@ -144,7 +132,7 @@ export function generateAppManifest(model: Model) {
                 deploymentUri: `_wix/extensions/service-plugins/${manifest.compId}`,
               },
             },
-          } satisfies EcomValidations;
+          } satisfies DevCenterEcomValidations;
         case 'GIFT_CARDS_PROVIDER':
           if (manifest.compData.giftCardsProvider.deploymentUri) {
             return manifest;
@@ -158,7 +146,7 @@ export function generateAppManifest(model: Model) {
                 deploymentUri: `_wix/extensions/service-plugins/${manifest.compId}`,
               },
             },
-          } satisfies EcomGiftCardsProvider;
+          } satisfies DevCenterEcomGiftCardsProvider;
         case 'WEBHOOK':
           if (manifest.compData.webhook.callbackUrl) {
             return manifest;
@@ -172,18 +160,18 @@ export function generateAppManifest(model: Model) {
                 callbackUrl: `_wix/extensions/webhooks/${manifest.compId}`,
               },
             },
-          } satisfies Webhook;
+          } satisfies DevCenterWebhook;
         default:
           return manifest;
       }
     });
 
-  const unknownExtensions = model.unknownExtensions.map(
-    (extension) => extension.manifest
+  const unknownExtensions = model.unknownComponents.map(
+    (component) => component.manifest
   );
 
   return {
     appId: model.appId,
     components: [...extensions, ...unknownExtensions],
-  } satisfies AppManifest;
+  } satisfies DevCenterAppManifest;
 }

package/src/utils/isValidBackofficeComponent.ts

@@ -1,14 +1,17 @@
-import type { Component } from '../schemas.js';
+import type { Component } from '../components.js';
 
-export function isValidBackofficeComponent(component: Component) {
+export function isValidBackofficeComponent(
+  component: Component
+): component is
+  | Component<'BackofficeExtensionWidget'>
+  | Component<'BackofficeModal'>
+  | Component<'BackofficePage'> {
   return (
-    (component.compType === 'BACK_OFFICE_PAGE' &&
-      !component.compData.backOfficePage.iframeUrl) ||
-    (component.compType === 'BACK_OFFICE_EXTENSION_WIDGET' &&
-      !component.compData.backOfficeExtensionWidget.iframeUrl) ||
-    (component.compType === 'BACK_OFFICE_EXTENSION_MENU_ITEM' &&
-      !component.compData.backOfficeExtensionMenuItem.iframeUrl) ||
-    (component.compType === 'BACK_OFFICE_MODAL' &&
-      !component.compData.backOfficeModal.iframeUrl)
+    (component.type === 'BackofficePage' &&
+      !component.manifest.compData.backOfficePage.iframeUrl) ||
+    (component.type === 'BackofficeExtensionWidget' &&
+      !component.manifest.compData.backOfficeExtensionWidget.iframeUrl) ||
+    (component.type === 'BackofficeModal' &&
+      !component.manifest.compData.backOfficeModal.iframeUrl)
   );
 }

package/src/utils/isValidServicePluginComponent.ts

@@ -1,18 +1,26 @@
-import type { Component } from '../schemas.js';
+import type { Component } from '../components.js';
 
-export function isValidServicePluginComponent(component: Component) {
+export function isValidServicePluginComponent(
+  component: Component
+): component is
+  | Component<'EcomAdditionalFees'>
+  | Component<'EcomDiscountsTrigger'>
+  | Component<'EcomGiftCardsProvider'>
+  | Component<'EcomPaymentSettings'>
+  | Component<'EcomShippingRates'>
+  | Component<'EcomValidations'> {
   return (
-    (component.compType === 'ECOM_SHIPPING_RATES' &&
-      !component.compData.ecomShippingRates.deploymentUri) ||
-    (component.compType === 'ECOM_ADDITIONAL_FEES' &&
-      !component.compData.ecomAdditionalFees.deploymentUri) ||
-    (component.compType === 'ECOM_DISCOUNTS_TRIGGER' &&
-      !component.compData.ecomDiscountsTrigger.deploymentUri) ||
-    (component.compType === 'ECOM_VALIDATIONS' &&
-      !component.compData.ecomValidations.deploymentUri) ||
-    (component.compType === 'ECOM_PAYMENT_SETTINGS' &&
-      !component.compData.ecomPaymentSettings.deploymentUri) ||
-    (component.compType === 'GIFT_CARDS_PROVIDER' &&
-      !component.compData.giftCardsProvider.deploymentUri)
+    (component.type === 'EcomShippingRates' &&
+      !component.manifest.compData.ecomShippingRates.deploymentUri) ||
+    (component.type === 'EcomAdditionalFees' &&
+      !component.manifest.compData.ecomAdditionalFees.deploymentUri) ||
+    (component.type === 'EcomDiscountsTrigger' &&
+      !component.manifest.compData.ecomDiscountsTrigger.deploymentUri) ||
+    (component.type === 'EcomValidations' &&
+      !component.manifest.compData.ecomValidations.deploymentUri) ||
+    (component.type === 'EcomPaymentSettings' &&
+      !component.manifest.compData.ecomPaymentSettings.deploymentUri) ||
+    (component.type === 'EcomGiftCardsProvider' &&
+      !component.manifest.compData.giftCardsProvider.deploymentUri)
   );
 }

package/src/utils/isValidWebhookComponent.ts

@@ -1,7 +1,10 @@
-import type { Component } from '../schemas.js';
+import type { Component } from '../components.js';
 
-export function isValidWebhookComponent(component: Component) {
+export function isValidWebhookComponent(
+  component: Component
+): component is Component<'Webhook'> {
   return (
-    component.compType === 'WEBHOOK' && !component.compData.webhook.callbackUrl
+    component.type === 'Webhook' &&
+    !component.manifest.compData.webhook.callbackUrl
   );
 }

package/src/utils/resolveBuildMetadata.ts

@@ -0,0 +1,30 @@
+import type { AstroConfig } from 'astro';
+import { pathExists } from './fs-utils.js';
+
+interface BuildMetadata {
+  appManifestPath: string;
+  clientDir: string;
+  outDir: string;
+  // In SSG (static site generation) mode, there is no `serverDir`, only the client side output.
+  serverDir?: string;
+}
+
+export async function resolveBuildMetadata(
+  appManifestPath: string,
+  config: AstroConfig
+): Promise<BuildMetadata> {
+  const clientDir = (await pathExists(config.build.client.pathname))
+    ? config.build.client.pathname
+    : config.outDir.pathname;
+
+  const serverDir = (await pathExists(config.build.server.pathname))
+    ? config.build.server.pathname
+    : undefined;
+
+  return {
+    appManifestPath,
+    clientDir,
+    outDir: config.outDir.pathname,
+    serverDir,
+  };
+}

package/src/utils/writeVirtualBackofficeExtensionFiles.ts

@@ -2,6 +2,8 @@ import { rm, writeFile } from 'node:fs/promises';
 import { join, resolve } from 'node:path';
 import { globby } from 'globby';
 import { outdent } from 'outdent';
+import { match } from 'variant';
+import type { Component } from '../components.js';
 import type { Model } from '../types.js';
 import { isValidBackofficeComponent } from '../utils/isValidBackofficeComponent.js';
 
@@ -9,8 +11,8 @@ export async function writeVirtualBackofficeExtensionFiles(
   model: Model,
   codegenDir: string
 ) {
-  const backofficeExtensions = model.extensions.filter((extension) =>
-    isValidBackofficeComponent(extension.manifest)
+  const backofficeComponents = model.components.filter(
+    isValidBackofficeComponent
   );
 
   const existingFiles = await globby(`*.astro`, {
@@ -19,8 +21,8 @@ export async function writeVirtualBackofficeExtensionFiles(
   });
 
   for (const filename of existingFiles) {
-    const hasMatchingSourceFile = backofficeExtensions.some(
-      (extension) => `${extension.manifest.compId}.astro` === filename
+    const hasMatchingSourceFile = backofficeComponents.some(
+      (component) => `${component.manifest.compId}.astro` === filename
     );
 
     if (hasMatchingSourceFile) {
@@ -30,15 +32,12 @@ export async function writeVirtualBackofficeExtensionFiles(
     await rm(join(codegenDir, filename));
   }
 
-  for (const extension of backofficeExtensions) {
-    const originalEntrypoint = resolve(
-      model.rootDir,
-      extension.cwd,
-      'page.tsx'
-    );
+  for (const component of backofficeComponents) {
+    const entryFilename = resolveEntry(component);
+    const originalEntrypoint = resolve(model.rootDir, entryFilename);
     const virtualEntrypoint = join(
       codegenDir,
-      `${extension.manifest.compId}.astro`
+      `${component.manifest.compId}.astro`
     );
 
     await writeFile(
@@ -55,3 +54,18 @@ export async function writeVirtualBackofficeExtensionFiles(
     );
   }
 }
+
+function resolveEntry(
+  component:
+    | Component<'BackofficeExtensionWidget'>
+    | Component<'BackofficeModal'>
+    | Component<'BackofficePage'>
+) {
+  const entryName = match(component, {
+    BackofficeExtensionWidget: () => 'widget.tsx',
+    BackofficeModal: () => 'modal.tsx',
+    BackofficePage: () => 'page.tsx',
+  });
+
+  return join(component.directory, entryName);
+}

package/src/utils/writeVirtualServicePluginExtensionFiles.ts

@@ -9,8 +9,8 @@ export async function writeVirtualServicePluginExtensionFiles(
   model: Model,
   codegenDir: string
 ) {
-  const servicePluginExtensions = model.extensions.filter((extension) =>
-    isValidServicePluginComponent(extension.manifest)
+  const servicePluginComponents = model.components.filter(
+    isValidServicePluginComponent
   );
 
   const existingFiles = await globby(`*.ts`, {
@@ -19,8 +19,8 @@ export async function writeVirtualServicePluginExtensionFiles(
   });
 
   for (const filename of existingFiles) {
-    const hasMatchingSourceFile = servicePluginExtensions.some(
-      (extension) => `${extension.manifest.compId}.ts` === filename
+    const hasMatchingSourceFile = servicePluginComponents.some(
+      (component) => `${component.manifest.compId}.ts` === filename
     );
 
     if (hasMatchingSourceFile) {
@@ -30,11 +30,11 @@ export async function writeVirtualServicePluginExtensionFiles(
     await rm(join(codegenDir, filename));
   }
 
-  for (const extension of servicePluginExtensions) {
-    const originalEntrypoint = resolve(extension.cwd, 'plugin.ts');
+  for (const component of servicePluginComponents) {
+    const originalEntrypoint = resolve(component.directory, 'plugin.ts');
     const virtualEntrypoint = join(
       codegenDir,
-      `${extension.manifest.compId}.ts`
+      `${component.manifest.compId}.ts`
     );
 
     await writeFile(

package/src/utils/writeVirtualWebhookExtensionFiles.ts

@@ -9,9 +9,7 @@ export async function writeVirtualWebhookExtensionFiles(
   model: Model,
   codegenDir: string
 ) {
-  const webhookExtensions = model.extensions.filter((extension) =>
-    isValidWebhookComponent(extension.manifest)
-  );
+  const webhookComponents = model.components.filter(isValidWebhookComponent);
 
   const existingFiles = await globby(`*.ts`, {
     cwd: codegenDir,
@@ -19,8 +17,8 @@ export async function writeVirtualWebhookExtensionFiles(
   });
 
   for (const filename of existingFiles) {
-    const hasMatchingSourceFile = webhookExtensions.some(
-      (extension) => `${extension.manifest.compId}.ts` === filename
+    const hasMatchingSourceFile = webhookComponents.some(
+      (component) => `${component.manifest.compId}.ts` === filename
     );
 
     if (hasMatchingSourceFile) {
@@ -30,11 +28,11 @@ export async function writeVirtualWebhookExtensionFiles(
     await rm(join(codegenDir, filename));
   }
 
-  for (const extension of webhookExtensions) {
-    const originalEntrypoint = resolve(extension.cwd, 'event.ts');
+  for (const component of webhookComponents) {
+    const originalEntrypoint = resolve(component.directory, 'event.ts');
     const virtualEntrypoint = join(
       codegenDir,
-      `${extension.manifest.compId}.ts`
+      `${component.manifest.compId}.ts`
     );
 
     await writeFile(