@wix/astro 1.0.6 → 1.0.7

package/src/utils/generateAppManifest.ts

@@ -1,5 +1,8 @@
 import type {
   AppManifest,
+  BackofficeExtensionMenuItem,
+  BackofficeExtensionWidget,
+  BackofficeModal,
   BackofficePage,
   EcomAdditionalFees,
   EcomDiscountsTrigger,
@@ -8,132 +11,179 @@ import type {
   EcomShippingRates,
   EcomValidations,
   Webhook,
-} from '@wix/cli-app-manifest';
-import { ComponentType } from '@wix/ambassador-devcenter-components-v1-component/types';
-import type { Model } from './createProjectModel.js';
+} from '../schemas.js';
+import type { Model } from '../types.js';
 
-export function generateAppManifest(model: Model): AppManifest {
-  return {
-    appId: model.appId,
-    components: model.extensions
-      .map((extension) => extension.config)
-      .map((config) => {
-        switch (config.compType) {
-          case ComponentType.BACK_OFFICE_PAGE:
-            if (config.compData.backOfficePage.iframeUrl) {
-              return config;
-            }
+export function generateAppManifest(model: Model) {
+  const extensions = model.extensions
+    .map((extension) => extension.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;
+        case 'BACK_OFFICE_EXTENSION_WIDGET':
+          if (manifest.compData.backOfficeExtensionWidget.iframeUrl) {
+            return manifest;
+          }
+
+          return {
+            ...manifest,
+            compData: {
+              backOfficeExtensionWidget: {
+                ...manifest.compData.backOfficeExtensionWidget,
+                iframeUrl: `_wix/extensions/backoffice/${manifest.compId}`,
+              },
+            },
+          } satisfies BackofficeExtensionWidget;
+        case 'BACK_OFFICE_MODAL':
+          if (manifest.compData.backOfficeModal.iframeUrl) {
+            return manifest;
+          }
 
-            return {
-              ...config,
-              compData: {
-                backOfficePage: {
-                  ...config.compData.backOfficePage,
-                  iframeUrl: `_wix/extensions/backoffice/${config.compId}`,
-                },
+          return {
+            ...manifest,
+            compData: {
+              backOfficeModal: {
+                ...manifest.compData.backOfficeModal,
+                iframeUrl: `_wix/extensions/backoffice/${manifest.compId}`,
               },
-            } satisfies BackofficePage;
-          case ComponentType.ECOM_ADDITIONAL_FEES:
-            if (config.compData.ecomAdditionalFees.deploymentUri) {
-              return config;
-            }
+            },
+          } satisfies BackofficeModal;
+        case 'BACK_OFFICE_PAGE':
+          if (manifest.compData.backOfficePage.iframeUrl) {
+            return manifest;
+          }
 
-            return {
-              ...config,
-              compData: {
-                ecomAdditionalFees: {
-                  ...config.compData.ecomAdditionalFees,
-                  deploymentUri: `_wix/extensions/service-plugins/${config.compId}`,
-                },
+          return {
+            ...manifest,
+            compData: {
+              backOfficePage: {
+                ...manifest.compData.backOfficePage,
+                iframeUrl: `_wix/extensions/backoffice/${manifest.compId}`,
               },
-            } satisfies EcomAdditionalFees;
-          case ComponentType.ECOM_DISCOUNTS_TRIGGER:
-            if (config.compData.ecomDiscountsTrigger.deploymentUri) {
-              return config;
-            }
+            },
+          } satisfies BackofficePage;
+        case 'ECOM_ADDITIONAL_FEES':
+          if (manifest.compData.ecomAdditionalFees.deploymentUri) {
+            return manifest;
+          }
 
-            return {
-              ...config,
-              compData: {
-                ecomDiscountsTrigger: {
-                  ...config.compData.ecomDiscountsTrigger,
-                  deploymentUri: `_wix/extensions/service-plugins/${config.compId}`,
-                },
+          return {
+            ...manifest,
+            compData: {
+              ecomAdditionalFees: {
+                ...manifest.compData.ecomAdditionalFees,
+                deploymentUri: `_wix/extensions/service-plugins/${manifest.compId}`,
               },
-            } satisfies EcomDiscountsTrigger;
-          case ComponentType.ECOM_PAYMENT_SETTINGS:
-            if (config.compData.ecomPaymentSettings.deploymentUri) {
-              return config;
-            }
+            },
+          } satisfies EcomAdditionalFees;
+        case 'ECOM_DISCOUNTS_TRIGGER':
+          if (manifest.compData.ecomDiscountsTrigger.deploymentUri) {
+            return manifest;
+          }
 
-            return {
-              ...config,
-              compData: {
-                ecomPaymentSettings: {
-                  ...config.compData.ecomPaymentSettings,
-                  deploymentUri: `_wix/extensions/service-plugins/${config.compId}`,
-                },
+          return {
+            ...manifest,
+            compData: {
+              ecomDiscountsTrigger: {
+                ...manifest.compData.ecomDiscountsTrigger,
+                deploymentUri: `_wix/extensions/service-plugins/${manifest.compId}`,
               },
-            } satisfies EcomPaymentSettings;
-          case ComponentType.ECOM_SHIPPING_RATES:
-            if (config.compData.ecomShippingRates.deploymentUri) {
-              return config;
-            }
+            },
+          } satisfies EcomDiscountsTrigger;
+        case 'ECOM_PAYMENT_SETTINGS':
+          if (manifest.compData.ecomPaymentSettings.deploymentUri) {
+            return manifest;
+          }
 
-            return {
-              ...config,
-              compData: {
-                ecomShippingRates: {
-                  ...config.compData.ecomShippingRates,
-                  deploymentUri: `_wix/extensions/service-plugins/${config.compId}`,
-                },
+          return {
+            ...manifest,
+            compData: {
+              ecomPaymentSettings: {
+                ...manifest.compData.ecomPaymentSettings,
+                deploymentUri: `_wix/extensions/service-plugins/${manifest.compId}`,
               },
-            } satisfies EcomShippingRates;
-          case ComponentType.ECOM_VALIDATIONS:
-            if (config.compData.ecomValidations.deploymentUri) {
-              return config;
-            }
+            },
+          } satisfies EcomPaymentSettings;
+        case 'ECOM_SHIPPING_RATES':
+          if (manifest.compData.ecomShippingRates.deploymentUri) {
+            return manifest;
+          }
 
-            return {
-              ...config,
-              compData: {
-                ecomValidations: {
-                  ...config.compData.ecomValidations,
-                  deploymentUri: `_wix/extensions/service-plugins/${config.compId}`,
-                },
+          return {
+            ...manifest,
+            compData: {
+              ecomShippingRates: {
+                ...manifest.compData.ecomShippingRates,
+                deploymentUri: `_wix/extensions/service-plugins/${manifest.compId}`,
               },
-            } satisfies EcomValidations;
-          case ComponentType.GIFT_CARDS_PROVIDER:
-            if (config.compData.giftCardsProvider.deploymentUri) {
-              return config;
-            }
+            },
+          } satisfies EcomShippingRates;
+        case 'ECOM_VALIDATIONS':
+          if (manifest.compData.ecomValidations.deploymentUri) {
+            return manifest;
+          }
 
-            return {
-              ...config,
-              compData: {
-                giftCardsProvider: {
-                  ...config.compData.giftCardsProvider,
-                  deploymentUri: `_wix/extensions/service-plugins/${config.compId}`,
-                },
+          return {
+            ...manifest,
+            compData: {
+              ecomValidations: {
+                ...manifest.compData.ecomValidations,
+                deploymentUri: `_wix/extensions/service-plugins/${manifest.compId}`,
               },
-            } satisfies EcomGiftCardsProvider;
-          case ComponentType.WEBHOOK:
-            if (config.compData.webhook.callbackUrl) {
-              return config;
-            }
+            },
+          } satisfies EcomValidations;
+        case 'GIFT_CARDS_PROVIDER':
+          if (manifest.compData.giftCardsProvider.deploymentUri) {
+            return manifest;
+          }
 
-            return {
-              ...config,
-              compData: {
-                webhook: {
-                  ...config.compData.webhook,
-                  callbackUrl: `_wix/extensions/webhooks/${config.compId}`,
-                },
+          return {
+            ...manifest,
+            compData: {
+              giftCardsProvider: {
+                ...manifest.compData.giftCardsProvider,
+                deploymentUri: `_wix/extensions/service-plugins/${manifest.compId}`,
               },
-            } satisfies Webhook;
-          default:
-            return config;
-        }
-      }),
-  };
+            },
+          } satisfies EcomGiftCardsProvider;
+        case 'WEBHOOK':
+          if (manifest.compData.webhook.callbackUrl) {
+            return manifest;
+          }
+
+          return {
+            ...manifest,
+            compData: {
+              webhook: {
+                ...manifest.compData.webhook,
+                callbackUrl: `_wix/extensions/webhooks/${manifest.compId}`,
+              },
+            },
+          } satisfies Webhook;
+        default:
+          return manifest;
+      }
+    });
+
+  const unknownExtensions = model.unknownExtensions.map(
+    (extension) => extension.manifest
+  );
+
+  return {
+    appId: model.appId,
+    components: [...extensions, ...unknownExtensions],
+  } satisfies AppManifest;
 }

package/src/utils/isValidBackofficeComponent.ts

@@ -1,15 +1,14 @@
-import type { Component } from '@wix/cli-app-manifest';
-import { ComponentType } from '@wix/ambassador-devcenter-components-v1-component/types';
+import type { Component } from '../schemas.js';
 
 export function isValidBackofficeComponent(component: Component) {
   return (
-    (component.compType === ComponentType.BACK_OFFICE_PAGE &&
+    (component.compType === 'BACK_OFFICE_PAGE' &&
       !component.compData.backOfficePage.iframeUrl) ||
-    (component.compType === ComponentType.BACK_OFFICE_EXTENSION_WIDGET &&
+    (component.compType === 'BACK_OFFICE_EXTENSION_WIDGET' &&
       !component.compData.backOfficeExtensionWidget.iframeUrl) ||
-    (component.compType === ComponentType.BACK_OFFICE_EXTENSION_MENU_ITEM &&
+    (component.compType === 'BACK_OFFICE_EXTENSION_MENU_ITEM' &&
       !component.compData.backOfficeExtensionMenuItem.iframeUrl) ||
-    (component.compType === ComponentType.BACK_OFFICE_MODAL &&
+    (component.compType === 'BACK_OFFICE_MODAL' &&
       !component.compData.backOfficeModal.iframeUrl)
   );
 }

package/src/utils/isValidServicePluginComponent.ts

@@ -1,19 +1,18 @@
-import type { Component } from '@wix/cli-app-manifest';
-import { ComponentType } from '@wix/ambassador-devcenter-components-v1-component/types';
+import type { Component } from '../schemas.js';
 
 export function isValidServicePluginComponent(component: Component) {
   return (
-    (component.compType === ComponentType.ECOM_SHIPPING_RATES &&
+    (component.compType === 'ECOM_SHIPPING_RATES' &&
       !component.compData.ecomShippingRates.deploymentUri) ||
-    (component.compType === ComponentType.ECOM_ADDITIONAL_FEES &&
+    (component.compType === 'ECOM_ADDITIONAL_FEES' &&
       !component.compData.ecomAdditionalFees.deploymentUri) ||
-    (component.compType === ComponentType.ECOM_DISCOUNTS_TRIGGER &&
+    (component.compType === 'ECOM_DISCOUNTS_TRIGGER' &&
       !component.compData.ecomDiscountsTrigger.deploymentUri) ||
-    (component.compType === ComponentType.ECOM_VALIDATIONS &&
+    (component.compType === 'ECOM_VALIDATIONS' &&
       !component.compData.ecomValidations.deploymentUri) ||
-    (component.compType === ComponentType.ECOM_PAYMENT_SETTINGS &&
+    (component.compType === 'ECOM_PAYMENT_SETTINGS' &&
       !component.compData.ecomPaymentSettings.deploymentUri) ||
-    (component.compType === ComponentType.GIFT_CARDS_PROVIDER &&
+    (component.compType === 'GIFT_CARDS_PROVIDER' &&
       !component.compData.giftCardsProvider.deploymentUri)
   );
 }

package/src/utils/isValidWebhookComponent.ts

@@ -1,9 +1,7 @@
-import type { Component } from '@wix/cli-app-manifest';
-import { ComponentType } from '@wix/ambassador-devcenter-components-v1-component/types';
+import type { Component } from '../schemas.js';
 
 export function isValidWebhookComponent(component: Component) {
   return (
-    component.compType === ComponentType.WEBHOOK &&
-    !component.compData.webhook.callbackUrl
+    component.compType === 'WEBHOOK' && !component.compData.webhook.callbackUrl
   );
 }

package/src/utils/loadEnvVars.ts

@@ -0,0 +1,38 @@
+import type { AstroIntegrationLogger } from 'astro';
+import chalk from 'chalk';
+import { outdent } from 'outdent';
+import { loadEnv } from 'vite';
+
+const wixClientIdEnvVar = 'WIX_CLIENT_ID';
+
+export function loadEnvVars(rootDir: string, logger: AstroIntegrationLogger) {
+  const env = loadEnv(process.env.NODE_ENV ?? 'development', process.cwd(), '');
+  const appId = env[wixClientIdEnvVar];
+
+  if (!appId) {
+    logger.error(
+      outdent`
+        Missing environment variable ${chalk.blueBright(wixClientIdEnvVar)}
+        To use the Wix SDK, you must provide the ${chalk.blueBright(
+          wixClientIdEnvVar
+        )} environment variable.
+        💡 To pull the required environment variables from Wix, run:
+          ${chalk.magenta('npx wix edge env --env local pull')}
+        🔍 Need Help?
+        - Visit our docs: https://dev.wix.com/docs/go-headless
+        - Join the community: https://discord.com/channels/1114269395317968906/1288424190969511987
+      `
+    );
+
+    throw new Error(
+      `${chalk.magenta(
+        wixClientIdEnvVar
+      )} not found in loaded environment variables`
+    );
+  }
+
+  return {
+    appId,
+    env,
+  };
+}

package/src/utils/writeVirtualBackofficeExtensionFiles.ts

@@ -2,7 +2,7 @@ import { rm, writeFile } from 'node:fs/promises';
 import { join, resolve } from 'node:path';
 import { globby } from 'globby';
 import { outdent } from 'outdent';
-import type { Model } from '../utils/createProjectModel.js';
+import type { Model } from '../types.js';
 import { isValidBackofficeComponent } from '../utils/isValidBackofficeComponent.js';
 
 export async function writeVirtualBackofficeExtensionFiles(
@@ -10,7 +10,7 @@ export async function writeVirtualBackofficeExtensionFiles(
   codegenDir: string
 ) {
   const backofficeExtensions = model.extensions.filter((extension) =>
-    isValidBackofficeComponent(extension.config)
+    isValidBackofficeComponent(extension.manifest)
   );
 
   const existingFiles = await globby(`*.astro`, {
@@ -20,7 +20,7 @@ export async function writeVirtualBackofficeExtensionFiles(
 
   for (const filename of existingFiles) {
     const hasMatchingSourceFile = backofficeExtensions.some(
-      (extension) => `${extension.config.compId}.astro` === filename
+      (extension) => `${extension.manifest.compId}.astro` === filename
     );
 
     if (hasMatchingSourceFile) {
@@ -33,11 +33,12 @@ export async function writeVirtualBackofficeExtensionFiles(
   for (const extension of backofficeExtensions) {
     const originalEntrypoint = resolve(
       model.rootDir,
-      extension.componentFilePath
+      extension.cwd,
+      'page.tsx'
     );
     const virtualEntrypoint = join(
       codegenDir,
-      `${extension.config.compId}.astro`
+      `${extension.manifest.compId}.astro`
     );
 
     await writeFile(

package/src/utils/writeVirtualServicePluginExtensionFiles.ts

@@ -2,7 +2,7 @@ import { rm, writeFile } from 'node:fs/promises';
 import { join, resolve } from 'node:path';
 import { globby } from 'globby';
 import { outdent } from 'outdent';
-import type { Model } from '../utils/createProjectModel.js';
+import type { Model } from '../types.js';
 import { isValidServicePluginComponent } from './isValidServicePluginComponent.js';
 
 export async function writeVirtualServicePluginExtensionFiles(
@@ -10,7 +10,7 @@ export async function writeVirtualServicePluginExtensionFiles(
   codegenDir: string
 ) {
   const servicePluginExtensions = model.extensions.filter((extension) =>
-    isValidServicePluginComponent(extension.config)
+    isValidServicePluginComponent(extension.manifest)
   );
 
   const existingFiles = await globby(`*.ts`, {
@@ -20,7 +20,7 @@ export async function writeVirtualServicePluginExtensionFiles(
 
   for (const filename of existingFiles) {
     const hasMatchingSourceFile = servicePluginExtensions.some(
-      (extension) => `${extension.config.compId}.ts` === filename
+      (extension) => `${extension.manifest.compId}.ts` === filename
     );
 
     if (hasMatchingSourceFile) {
@@ -32,7 +32,10 @@ export async function writeVirtualServicePluginExtensionFiles(
 
   for (const extension of servicePluginExtensions) {
     const originalEntrypoint = resolve(extension.cwd, 'plugin.ts');
-    const virtualEntrypoint = join(codegenDir, `${extension.config.compId}.ts`);
+    const virtualEntrypoint = join(
+      codegenDir,
+      `${extension.manifest.compId}.ts`
+    );
 
     await writeFile(
       virtualEntrypoint,

package/src/utils/writeVirtualWebhookExtensionFiles.ts

@@ -2,7 +2,7 @@ import { rm, writeFile } from 'node:fs/promises';
 import { join, resolve } from 'node:path';
 import { globby } from 'globby';
 import { outdent } from 'outdent';
-import type { Model } from '../utils/createProjectModel.js';
+import type { Model } from '../types.js';
 import { isValidWebhookComponent } from './isValidWebhookComponent.js';
 
 export async function writeVirtualWebhookExtensionFiles(
@@ -10,7 +10,7 @@ export async function writeVirtualWebhookExtensionFiles(
   codegenDir: string
 ) {
   const webhookExtensions = model.extensions.filter((extension) =>
-    isValidWebhookComponent(extension.config)
+    isValidWebhookComponent(extension.manifest)
   );
 
   const existingFiles = await globby(`*.ts`, {
@@ -20,7 +20,7 @@ export async function writeVirtualWebhookExtensionFiles(
 
   for (const filename of existingFiles) {
     const hasMatchingSourceFile = webhookExtensions.some(
-      (extension) => `${extension.config.compId}.ts` === filename
+      (extension) => `${extension.manifest.compId}.ts` === filename
     );
 
     if (hasMatchingSourceFile) {
@@ -32,7 +32,10 @@ export async function writeVirtualWebhookExtensionFiles(
 
   for (const extension of webhookExtensions) {
     const originalEntrypoint = resolve(extension.cwd, 'event.ts');
-    const virtualEntrypoint = join(codegenDir, `${extension.config.compId}.ts`);
+    const virtualEntrypoint = join(
+      codegenDir,
+      `${extension.manifest.compId}.ts`
+    );
 
     await writeFile(
       virtualEntrypoint,

package/tsup.config.mjs

@@ -1,32 +1,47 @@
-import { defineConfig } from '@wix/tsup-configs/public-node';
+import isCI from 'is-ci';
+import { outdent } from 'outdent';
+import { defineConfig } from 'tsup';
 
-export default defineConfig(
+export default defineConfig([
   {
     entry: ['src/index.ts'],
     target: 'node20.9',
     format: ['esm'],
     outDir: 'build',
     splitting: false,
+    clean: true,
+    sourcemap: true,
     external: ['astro', 'vite', /^astro:/],
     dts: {
       resolve: ['astro', 'vite', /^astro:/],
     },
+    // We specifically do not minify the code in packages **for node** in order to keep it readable for debugging purposes.
+    minify: false,
+    env: {
+      NODE_ENV: isCI ? 'production' : 'development',
+    },
+    shims: true,
+    // https://github.com/evanw/esbuild/issues/1921
+    banner: {
+      js: outdent`
+        import { createRequire as _createRequire } from 'node:module';
+        const require = _createRequire(import.meta.url);
+      `,
+    },
   },
-  [
-    {
-      entry: [
-        'src/middleware/auth.ts',
-        'src/routes/webhooks.ts',
-        'src/routes/service-plugins.ts',
-      ],
-      target: 'node20.9',
-      format: ['esm'],
-      outDir: 'build-runtime',
-      splitting: false,
-      external: ['astro', 'vite', /^astro:/],
-      dts: {
-        resolve: ['astro', 'vite', /^astro:/],
-      },
+  {
+    entry: [
+      'src/middleware/auth.ts',
+      'src/routes/webhooks.ts',
+      'src/routes/service-plugins.ts',
+    ],
+    target: 'node20.9',
+    format: ['esm'],
+    outDir: 'build-runtime',
+    splitting: false,
+    external: ['astro', 'vite', /^astro:/],
+    dts: {
+      resolve: ['astro', 'vite', /^astro:/],
     },
-  ]
-);
+  },
+]);