@wix/astro 1.0.22 → 1.0.24

package/src/utils/buildServicePluginComponent.ts

@@ -0,0 +1,54 @@
+import { writeFile } from 'node:fs/promises';
+import { join } from 'node:path';
+import type { InjectedRoute } from 'astro';
+import { outdent } from 'outdent';
+import type {
+  EcomAdditionalFees,
+  EcomDiscountsTrigger,
+  EcomGiftCardsProvider,
+  EcomPaymentSettings,
+  EcomShippingRates,
+  EcomValidations,
+} from '../components.js';
+import { outputDir, toRelativePath } from './fs-utils.js';
+
+export async function buildServicePluginComponent({
+  codegenDir,
+  component,
+  injectRoute,
+  rootDir,
+}: {
+  codegenDir: string;
+  component:
+    | EcomAdditionalFees
+    | EcomDiscountsTrigger
+    | EcomGiftCardsProvider
+    | EcomPaymentSettings
+    | EcomShippingRates
+    | EcomValidations;
+  injectRoute: (injectRoute: InjectedRoute) => void;
+  rootDir: string;
+}): Promise<void> {
+  const directory = join(codegenDir, component.manifest.compId);
+
+  await outputDir(directory);
+
+  const entrypoint = join(directory, `entry.ts`);
+  const entryFilePath = join(rootDir, component.directory, 'plugin.ts');
+
+  await writeFile(
+    entrypoint,
+    outdent`
+      import { setupServicePlugin } from '@wix/astro/context/setup-service-plugin';
+
+      export const ALL = await setupServicePlugin(
+        () => import('${toRelativePath(entrypoint, entryFilePath)}'),
+      );
+    `
+  );
+
+  injectRoute({
+    entrypoint,
+    pattern: `/_wix/extensions/service-plugins/${component.manifest.compId}`,
+  });
+}

package/src/utils/buildWebhookComponent.ts

@@ -0,0 +1,41 @@
+import { writeFile } from 'node:fs/promises';
+import { join } from 'node:path';
+import type { InjectedRoute } from 'astro';
+import { outdent } from 'outdent';
+import type { Webhook } from '../components.js';
+import { outputDir, toRelativePath } from './fs-utils.js';
+
+export async function buildWebhookComponent({
+  codegenDir,
+  component,
+  injectRoute,
+  rootDir,
+}: {
+  codegenDir: string;
+  component: Webhook;
+  injectRoute: (injectRoute: InjectedRoute) => void;
+  rootDir: string;
+}): Promise<void> {
+  const directory = join(codegenDir, component.manifest.compId);
+
+  await outputDir(directory);
+
+  const entrypoint = join(directory, `entry.ts`);
+  const entryFilePath = join(rootDir, component.directory, 'event.ts');
+
+  await writeFile(
+    entrypoint,
+    outdent`
+      import { setupWebhook } from '@wix/astro/context/setup-webhook';
+
+      export const ALL = await setupWebhook(
+        () => import('${toRelativePath(entrypoint, entryFilePath)}'),
+      );
+    `
+  );
+
+  injectRoute({
+    entrypoint,
+    pattern: `/_wix/extensions/webhooks/${component.manifest.compId}`,
+  });
+}

package/src/utils/createProjectModel.ts

@@ -3,9 +3,9 @@ import { cwd } from 'node:process';
 import type { AstroIntegrationLogger } from 'astro';
 import { globby } from 'globby';
 import { outdent } from 'outdent';
+import type { Component, UnknownComponent } from '../components.js';
 import type { DevCenterComponent } from '../schemas.js';
 import type { Model } from '../types.js';
-import { Component, UnknownComponent } from '../components.js';
 import { EXTENSIONS_DIR } from '../directories.js';
 import {
   baseDevCenterComponentSchema,
@@ -42,12 +42,10 @@ export async function createProjectModel(
 
     const unknownManifest = parseBaseExtensionManifest(extensionManifest);
 
-    unknownComponents.push(
-      UnknownComponent.Unknown({
-        directory: componentPath,
-        manifest: unknownManifest,
-      })
-    );
+    unknownComponents.push({
+      directory: componentPath,
+      manifest: unknownManifest,
+    });
   }
 
   return {
@@ -61,72 +59,86 @@ export async function createProjectModel(
 
 // https://github.com/mrmlnc/fast-glob/releases/tag/3.0.0
 // globby using fast-glob under the hood accepts only forward slashes in patterns.
-function createComponent(manifest: DevCenterComponent, directory: string) {
+function createComponent(
+  manifest: DevCenterComponent,
+  directory: string
+): Component {
   switch (manifest.compType) {
     case 'BACK_OFFICE_EXTENSION_MENU_ITEM':
-      return Component.BackofficeExtensionMenuPlugin({
+      return {
         directory,
         manifest,
-      });
+        type: 'BackofficeExtensionMenuPlugin',
+      };
     case 'BACK_OFFICE_EXTENSION_WIDGET': {
-      return Component.BackofficeExtensionWidget({
+      return {
         directory,
         manifest,
-      });
+        type: 'BackofficeExtensionWidget',
+      };
     }
     case 'BACK_OFFICE_MODAL': {
-      return Component.BackofficeModal({
+      return {
         directory,
         manifest,
-      });
+        type: 'BackofficeModal',
+      };
     }
     case 'BACK_OFFICE_PAGE': {
-      return Component.BackofficePage({
+      return {
         directory,
         manifest,
-      });
+        type: 'BackofficePage',
+      };
     }
     case 'ECOM_ADDITIONAL_FEES': {
-      return Component.EcomAdditionalFees({
+      return {
         directory,
         manifest,
-      });
+        type: 'EcomAdditionalFees',
+      };
     }
     case 'ECOM_DISCOUNTS_TRIGGER': {
-      return Component.EcomDiscountsTrigger({
+      return {
         directory,
         manifest,
-      });
+        type: 'EcomDiscountsTrigger',
+      };
     }
     case 'ECOM_PAYMENT_SETTINGS': {
-      return Component.EcomPaymentSettings({
+      return {
         directory,
         manifest,
-      });
+        type: 'EcomPaymentSettings',
+      };
     }
     case 'ECOM_SHIPPING_RATES': {
-      return Component.EcomShippingRates({
+      return {
         directory,
         manifest,
-      });
+        type: 'EcomShippingRates',
+      };
     }
     case 'ECOM_VALIDATIONS': {
-      return Component.EcomValidations({
+      return {
         directory,
         manifest,
-      });
+        type: 'EcomValidations',
+      };
     }
     case 'GIFT_CARDS_PROVIDER': {
-      return Component.EcomGiftCardsProvider({
+      return {
         directory,
         manifest,
-      });
+        type: 'EcomGiftCardsProvider',
+      };
     }
     case 'WEBHOOK': {
-      return Component.Webhook({
+      return {
         directory,
         manifest,
-      });
+        type: 'Webhook',
+      };
     }
   }
 }

package/src/utils/fs-utils.ts

@@ -2,16 +2,22 @@ import {
   access,
   readFile as fsReadFile,
   mkdir,
+  rm,
   writeFile,
 } from 'node:fs/promises';
 import { EOL } from 'node:os';
 import { dirname, relative } from 'node:path';
 
+export async function clearDir(dir: string): Promise<void> {
+  await rm(dir, { recursive: true });
+  await mkdir(dir);
+}
+
 export async function outputDir(dir: string): Promise<void> {
   await mkdir(dir, { recursive: true });
 }
 
-export function pathExists(path: string): Promise<boolean> {
+export async function pathExists(path: string): Promise<boolean> {
   return access(path)
     .then(() => true)
     .catch(() => false);

package/src/utils/removeUnusedCodegenFiles.ts

@@ -0,0 +1,34 @@
+import { rm } from 'node:fs/promises';
+import { basename } from 'node:path';
+import { globby } from 'globby';
+import type { Model } from '../types.js';
+
+export async function removeUnusedCodegenFiles({
+  extensionsDir,
+  model,
+}: {
+  extensionsDir: string;
+  model: Model;
+}): Promise<void> {
+  const codegenFiles = await globby(`*/*`, {
+    absolute: true,
+    cwd: extensionsDir,
+    onlyDirectories: true,
+  });
+
+  for (const dirname of codegenFiles) {
+    // rely on codegen files being in the following format:
+    // `backoffice/{componentId}/...`, `webhooks/{componentId}/...`, etc...
+    const componentId = basename(dirname);
+
+    if (
+      model.components.some(
+        (component) => component.manifest.compId === componentId
+      )
+    ) {
+      continue;
+    }
+
+    await rm(dirname, { recursive: true });
+  }
+}

package/tsup.config.mjs

@@ -39,13 +39,15 @@ export default defineConfig([
     },
     entry: [
       // extensions
-      'src/routes/webhooks.ts',
-      'src/routes/service-plugins.ts',
+      'src/routes/webhooksDevRoute.ts',
+      'src/routes/servicePluginsDevRoute.ts',
 
       // contextual client
       'src/middleware/auth.ts',
       'src/context/elevated.ts',
-      'src/context/non-elevated.ts',
+      'src/context/nonElevated.ts',
+      'src/context/setupServicePlugin.ts',
+      'src/context/setupWebhook.ts',
 
       // auth routes
       'src/routes/auth/login.ts',
@@ -66,7 +68,7 @@ export default defineConfig([
     dts: {
       resolve: [...astroExternals, ...viteExternals, '@wix/sdk-context'],
     },
-    entry: ['src/context/setup.ts'],
+    entry: ['src/client-context/setup.ts'],
     external: [...astroExternals, ...viteExternals, '@wix/sdk-context'],
     format: ['esm'],
     outDir: 'build-browser-runtime',

package/src/utils/isValidBackofficeComponent.ts

@@ -1,18 +0,0 @@
-import type { Component } from '../components.js';
-
-export function isValidBackofficeComponent(
-  component: Component
-): component is
-  | Component<'BackofficeExtensionWidget'>
-  | Component<'BackofficeModal'>
-  | Component<'BackofficePage'> {
-  return (
-    (component.type === 'BackofficePage' &&
-      component.manifest.compData.backOfficePage.iframeUrl == null) ||
-    (component.type === 'BackofficeExtensionWidget' &&
-      component.manifest.compData.backOfficeExtensionWidget.iframeUrl ==
-        null) ||
-    (component.type === 'BackofficeModal' &&
-      component.manifest.compData.backOfficeModal.iframeUrl == null)
-  );
-}

package/src/utils/isValidServicePluginComponent.ts

@@ -1,26 +0,0 @@
-import type { Component } from '../components.js';
-
-export function isValidServicePluginComponent(
-  component: Component
-): component is
-  | Component<'EcomAdditionalFees'>
-  | Component<'EcomDiscountsTrigger'>
-  | Component<'EcomGiftCardsProvider'>
-  | Component<'EcomPaymentSettings'>
-  | Component<'EcomShippingRates'>
-  | Component<'EcomValidations'> {
-  return (
-    (component.type === 'EcomShippingRates' &&
-      component.manifest.compData.ecomShippingRates.deploymentUri == null) ||
-    (component.type === 'EcomAdditionalFees' &&
-      component.manifest.compData.ecomAdditionalFees.deploymentUri == null) ||
-    (component.type === 'EcomDiscountsTrigger' &&
-      component.manifest.compData.ecomDiscountsTrigger.deploymentUri == null) ||
-    (component.type === 'EcomValidations' &&
-      component.manifest.compData.ecomValidations.deploymentUri == null) ||
-    (component.type === 'EcomPaymentSettings' &&
-      component.manifest.compData.ecomPaymentSettings.deploymentUri == null) ||
-    (component.type === 'EcomGiftCardsProvider' &&
-      component.manifest.compData.giftCardsProvider.deploymentUri == null)
-  );
-}

package/src/utils/isValidWebhookComponent.ts

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

package/src/utils/writeVirtualBackofficeExtensionFiles.ts

@@ -1,93 +0,0 @@
-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';
-import { toRelativePath } from './fs-utils.js';
-
-export async function writeVirtualBackofficeExtensionFiles(
-  model: Model,
-  codegenDir: string
-): Promise<void> {
-  const backofficeComponents = model.components.filter(
-    isValidBackofficeComponent
-  );
-
-  const existingFiles = await globby(`*.astro`, {
-    cwd: codegenDir,
-    onlyFiles: true,
-  });
-
-  for (const filename of existingFiles) {
-    const hasMatchingSourceFile = backofficeComponents.some(
-      (component) => `${component.manifest.compId}.astro` === filename
-    );
-
-    if (hasMatchingSourceFile) {
-      continue;
-    }
-
-    await rm(join(codegenDir, filename));
-  }
-
-  for (const component of backofficeComponents) {
-    const entryFilename = resolveEntry(component);
-    const originalEntrypoint = resolve(model.rootDir, entryFilename);
-
-    const virtualHocEntrypoint = join(
-      codegenDir,
-      `hoc_${component.manifest.compId}.tsx`
-    );
-
-    await writeFile(
-      virtualHocEntrypoint,
-      outdent`
-        import Component from '${toRelativePath(virtualHocEntrypoint, originalEntrypoint)}';
-        import { withContextualWixClient } from '@wix/dashboard/internal';
-
-        export const WrappedComponent = withContextualWixClient(Component);
-      `
-    );
-
-    const virtualEntrypoint = join(
-      codegenDir,
-      `${component.manifest.compId}.astro`
-    );
-
-    await writeFile(
-      virtualEntrypoint,
-      outdent`
-        ---
-        import { WrappedComponent } from '${toRelativePath(virtualEntrypoint, virtualHocEntrypoint)}';
-        ---
-
-        <html lang="en">
-          <head></head>
-          <body>
-            <div>
-              <WrappedComponent client:only="react" />
-            </div>
-          </body>
-        </html>
-      `
-    );
-  }
-}
-
-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

@@ -1,73 +0,0 @@
-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 '../types.js';
-import { toRelativePath } from './fs-utils.js';
-import { isValidServicePluginComponent } from './isValidServicePluginComponent.js';
-
-export async function writeVirtualServicePluginExtensionFiles(
-  model: Model,
-  codegenDir: string
-): Promise<void> {
-  const servicePluginComponents = model.components.filter(
-    isValidServicePluginComponent
-  );
-
-  const existingFiles = await globby(`*.ts`, {
-    cwd: codegenDir,
-    onlyFiles: true,
-  });
-
-  for (const filename of existingFiles) {
-    const hasMatchingSourceFile = servicePluginComponents.some(
-      (component) => `${component.manifest.compId}.ts` === filename
-    );
-
-    if (hasMatchingSourceFile) {
-      continue;
-    }
-
-    await rm(join(codegenDir, filename));
-  }
-
-  for (const component of servicePluginComponents) {
-    const originalEntrypoint = resolve(component.directory, 'plugin.ts');
-    const virtualEntrypoint = join(
-      codegenDir,
-      `${component.manifest.compId}.ts`
-    );
-
-    await writeFile(
-      virtualEntrypoint,
-      outdent`
-        import type { APIRoute } from 'astro';
-        import { AppStrategy, createClient } from '@wix/sdk';
-        import { WIX_CLIENT_ID } from 'astro:env/client';
-        import { WIX_CLIENT_PUBLIC_KEY, WIX_CLIENT_SECRET } from 'astro:env/server';
-
-        const client = createClient({
-          auth: AppStrategy({
-            appId: WIX_CLIENT_ID,
-            appSecret: WIX_CLIENT_SECRET,
-            publicKey: WIX_CLIENT_PUBLIC_KEY,
-          }),
-        });
-
-        const olderClient = globalThis.__wix_context__.client;
-
-        client.enableContext('global');
-
-        await import('${toRelativePath(virtualEntrypoint, originalEntrypoint)}');
-
-        if (olderClient) {
-          olderClient.enableContext('global');
-        }
-
-        export const ALL: APIRoute = async (context) => {
-          return await client.servicePlugins.processRequest(context.request);
-        };
-      `
-    );
-  }
-}

package/src/utils/writeVirtualWebhookExtensionFiles.ts

@@ -1,72 +0,0 @@
-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 '../types.js';
-import { toRelativePath } from './fs-utils.js';
-import { isValidWebhookComponent } from './isValidWebhookComponent.js';
-
-export async function writeVirtualWebhookExtensionFiles(
-  model: Model,
-  codegenDir: string
-): Promise<void> {
-  const webhookComponents = model.components.filter(isValidWebhookComponent);
-
-  const existingFiles = await globby(`*.ts`, {
-    cwd: codegenDir,
-    onlyFiles: true,
-  });
-
-  for (const filename of existingFiles) {
-    const hasMatchingSourceFile = webhookComponents.some(
-      (component) => `${component.manifest.compId}.ts` === filename
-    );
-
-    if (hasMatchingSourceFile) {
-      continue;
-    }
-
-    await rm(join(codegenDir, filename));
-  }
-
-  for (const component of webhookComponents) {
-    const originalEntrypoint = resolve(component.directory, 'event.ts');
-    const virtualEntrypoint = join(
-      codegenDir,
-      `${component.manifest.compId}.ts`
-    );
-
-    await writeFile(
-      virtualEntrypoint,
-      outdent`
-        import type { APIRoute } from 'astro';
-        import { AppStrategy, createClient } from '@wix/sdk';
-        import { WIX_CLIENT_ID } from 'astro:env/client';
-        import { WIX_CLIENT_PUBLIC_KEY, WIX_CLIENT_SECRET } from 'astro:env/server';
-
-        const client = createClient({
-          auth: AppStrategy({
-            appId: WIX_CLIENT_ID,
-            appSecret: WIX_CLIENT_SECRET,
-            publicKey: WIX_CLIENT_PUBLIC_KEY,
-          }),
-        });
-
-        const olderClient = globalThis.__wix_context__.client;
-
-        client.enableContext('global');
-
-        await import('${toRelativePath(virtualEntrypoint, originalEntrypoint)}');
-
-        if (olderClient) {
-          olderClient.enableContext('global');
-        }
-
-        export const ALL: APIRoute = async (context) => {
-          await client.webhooks.processRequest(context.request);
-          return new Response('OK');
-        };
-      `
-    );
-  }
-}