@wix/astro 1.0.28 → 2.0.0

package/src/utils/buildWebhookComponent.ts

@@ -1,39 +0,0 @@
-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,
-}: {
-  codegenDir: string;
-  component: Webhook;
-  injectRoute: (injectRoute: InjectedRoute) => void;
-}): Promise<void> {
-  const directory = join(codegenDir, component.manifest.compId);
-
-  await outputDir(directory);
-
-  const entrypoint = join(directory, `entry.ts`);
-  const entryFilePath = join(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/contextualAuth.ts

@@ -1,4 +0,0 @@
-import type { IOAuthStrategy } from '@wix/sdk';
-import { auth as originalAuth } from '@wix/essentials';
-
-export const auth = originalAuth.getContextualAuth<IOAuthStrategy>();

package/src/utils/createProjectModel.ts

@@ -1,190 +0,0 @@
-import { join } from 'node:path';
-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 { EXTENSIONS_DIR } from '../directories.js';
-import {
-  baseDevCenterComponentSchema,
-  devCenterComponentSchema,
-} from '../schemas.js';
-import { pathExists, readJson } from './fs-utils.js';
-import { loadEnvVars } from './loadEnvVars.js';
-
-export async function createProjectModel({
-  logger,
-  rootDir,
-}: {
-  logger: AstroIntegrationLogger;
-  rootDir: string;
-}): Promise<Model> {
-  const { appId, env } = loadEnvVars({ logger, rootDir });
-
-  const componentsPaths = await globby(
-    pathToGlobby(join(EXTENSIONS_DIR, '*')),
-    {
-      cwd: rootDir,
-      onlyDirectories: true,
-    }
-  );
-
-  const components: Component[] = [];
-  const unknownComponents: UnknownComponent[] = [];
-
-  for (const componentRelativePath of componentsPaths) {
-    const componentPath = join(rootDir, componentRelativePath);
-
-    const extensionManifest = await readExtensionManifest(componentPath);
-    const knownManifest = parseKnownExtensionManifest(extensionManifest);
-
-    if (knownManifest != null) {
-      components.push(createComponent(knownManifest, componentPath));
-      continue;
-    }
-
-    const unknownManifest = parseBaseExtensionManifest(extensionManifest);
-
-    unknownComponents.push({
-      directory: componentPath,
-      manifest: unknownManifest,
-    });
-  }
-
-  return {
-    appId,
-    components,
-    env,
-    rootDir,
-    unknownComponents,
-  };
-}
-
-// 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
-): Component {
-  switch (manifest.compType) {
-    case 'BACK_OFFICE_EXTENSION_MENU_ITEM':
-      return {
-        directory,
-        manifest,
-        type: 'BackofficeExtensionMenuPlugin',
-      };
-    case 'BACK_OFFICE_EXTENSION_WIDGET': {
-      return {
-        directory,
-        manifest,
-        type: 'BackofficeExtensionWidget',
-      };
-    }
-    case 'BACK_OFFICE_MODAL': {
-      return {
-        directory,
-        manifest,
-        type: 'BackofficeModal',
-      };
-    }
-    case 'BACK_OFFICE_PAGE': {
-      return {
-        directory,
-        manifest,
-        type: 'BackofficePage',
-      };
-    }
-    case 'ECOM_ADDITIONAL_FEES': {
-      return {
-        directory,
-        manifest,
-        type: 'EcomAdditionalFees',
-      };
-    }
-    case 'ECOM_DISCOUNTS_TRIGGER': {
-      return {
-        directory,
-        manifest,
-        type: 'EcomDiscountsTrigger',
-      };
-    }
-    case 'ECOM_PAYMENT_SETTINGS': {
-      return {
-        directory,
-        manifest,
-        type: 'EcomPaymentSettings',
-      };
-    }
-    case 'ECOM_SHIPPING_RATES': {
-      return {
-        directory,
-        manifest,
-        type: 'EcomShippingRates',
-      };
-    }
-    case 'ECOM_VALIDATIONS': {
-      return {
-        directory,
-        manifest,
-        type: 'EcomValidations',
-      };
-    }
-    case 'GIFT_CARDS_PROVIDER': {
-      return {
-        directory,
-        manifest,
-        type: 'EcomGiftCardsProvider',
-      };
-    }
-    case 'WEBHOOK': {
-      return {
-        directory,
-        manifest,
-        type: 'Webhook',
-      };
-    }
-  }
-}
-
-function parseBaseExtensionManifest(extensionManifest: unknown) {
-  const appManifestResult =
-    baseDevCenterComponentSchema.safeParse(extensionManifest);
-
-  if (!appManifestResult.success) {
-    throw new Error(outdent`
-      Invalid extension configuration:
-
-      ${appManifestResult.error.issues
-        .map((e) => `${e.path.join('.')}: ${e.message}`)
-        .join('\n')}
-    `);
-  }
-
-  return appManifestResult.data;
-}
-
-function parseKnownExtensionManifest(extensionManifest: unknown) {
-  const appManifestResult =
-    devCenterComponentSchema.safeParse(extensionManifest);
-
-  if (appManifestResult.error) {
-    return null;
-  }
-
-  return appManifestResult.data;
-}
-
-function pathToGlobby(path: string) {
-  return path.replaceAll('\\', '/');
-}
-
-async function readExtensionManifest(directoryPath: string) {
-  const manifestFilePath = join(directoryPath, 'extension.json');
-
-  if (!(await pathExists(manifestFilePath))) {
-    throw new Error('Missing extension manifest');
-  }
-
-  return await readJson(manifestFilePath);
-}

package/src/utils/fs-utils.ts

@@ -1,48 +0,0 @@
-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 async function pathExists(path: string): Promise<boolean> {
-  return access(path)
-    .then(() => true)
-    .catch(() => false);
-}
-
-export async function readJson(file: string): Promise<unknown> {
-  return JSON.parse(await fsReadFile(file, 'utf-8'));
-}
-
-export function toRelativePath(from: string, to: string): string {
-  const rel = relative(dirname(from), to).replaceAll('\\', '/');
-  return rel.startsWith('.') ? rel : `./${rel}`;
-}
-
-export async function writeJson(
-  filePath: string,
-  object: unknown,
-  opts?: { spaces: number }
-): Promise<void> {
-  const str = toJsonString(object, opts);
-  await outputDir(dirname(filePath));
-
-  await writeFile(filePath, str, 'utf-8');
-}
-
-function toJsonString(object: unknown, opts?: { spaces: number }) {
-  return `${JSON.stringify(object, null, opts?.spaces)}${EOL}`;
-}

package/src/utils/generateAppManifest.ts

@@ -1,177 +0,0 @@
-import type {
-  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): DevCenterAppManifest {
-  const extensions = model.components
-    .map((component) => component.manifest)
-    .map((manifest) => {
-      switch (manifest.compType) {
-        case 'BACK_OFFICE_EXTENSION_MENU_ITEM':
-          return manifest satisfies DevCenterBackofficeExtensionMenuItem;
-        case 'BACK_OFFICE_EXTENSION_WIDGET':
-          if (manifest.compData.backOfficeExtensionWidget.iframeUrl != null) {
-            return manifest;
-          }
-
-          return {
-            ...manifest,
-            compData: {
-              backOfficeExtensionWidget: {
-                ...manifest.compData.backOfficeExtensionWidget,
-                iframeUrl: `_wix/extensions/backoffice/${manifest.compId}`,
-              },
-            },
-          } satisfies DevCenterBackofficeExtensionWidget;
-        case 'BACK_OFFICE_MODAL':
-          if (manifest.compData.backOfficeModal.iframeUrl != null) {
-            return manifest;
-          }
-
-          return {
-            ...manifest,
-            compData: {
-              backOfficeModal: {
-                ...manifest.compData.backOfficeModal,
-                iframeUrl: `_wix/extensions/backoffice/${manifest.compId}`,
-              },
-            },
-          } satisfies DevCenterBackofficeModal;
-        case 'BACK_OFFICE_PAGE':
-          if (manifest.compData.backOfficePage.iframeUrl != null) {
-            return manifest;
-          }
-
-          return {
-            ...manifest,
-            compData: {
-              backOfficePage: {
-                ...manifest.compData.backOfficePage,
-                iframeUrl: `_wix/extensions/backoffice/${manifest.compId}`,
-              },
-            },
-          } satisfies DevCenterBackofficePage;
-        case 'ECOM_ADDITIONAL_FEES':
-          if (manifest.compData.ecomAdditionalFees.deploymentUri != null) {
-            return manifest;
-          }
-
-          return {
-            ...manifest,
-            compData: {
-              ecomAdditionalFees: {
-                ...manifest.compData.ecomAdditionalFees,
-                deploymentUri: `_wix/extensions/service-plugins/${manifest.compId}`,
-              },
-            },
-          } satisfies DevCenterEcomAdditionalFees;
-        case 'ECOM_DISCOUNTS_TRIGGER':
-          if (manifest.compData.ecomDiscountsTrigger.deploymentUri != null) {
-            return manifest;
-          }
-
-          return {
-            ...manifest,
-            compData: {
-              ecomDiscountsTrigger: {
-                ...manifest.compData.ecomDiscountsTrigger,
-                deploymentUri: `_wix/extensions/service-plugins/${manifest.compId}`,
-              },
-            },
-          } satisfies DevCenterEcomDiscountsTrigger;
-        case 'ECOM_PAYMENT_SETTINGS':
-          if (manifest.compData.ecomPaymentSettings.deploymentUri != null) {
-            return manifest;
-          }
-
-          return {
-            ...manifest,
-            compData: {
-              ecomPaymentSettings: {
-                ...manifest.compData.ecomPaymentSettings,
-                deploymentUri: `_wix/extensions/service-plugins/${manifest.compId}`,
-              },
-            },
-          } satisfies DevCenterEcomPaymentSettings;
-        case 'ECOM_SHIPPING_RATES':
-          if (manifest.compData.ecomShippingRates.deploymentUri != null) {
-            return manifest;
-          }
-
-          return {
-            ...manifest,
-            compData: {
-              ecomShippingRates: {
-                ...manifest.compData.ecomShippingRates,
-                deploymentUri: `_wix/extensions/service-plugins/${manifest.compId}`,
-              },
-            },
-          } satisfies DevCenterEcomShippingRates;
-        case 'ECOM_VALIDATIONS':
-          if (manifest.compData.ecomValidations.deploymentUri != null) {
-            return manifest;
-          }
-
-          return {
-            ...manifest,
-            compData: {
-              ecomValidations: {
-                ...manifest.compData.ecomValidations,
-                deploymentUri: `_wix/extensions/service-plugins/${manifest.compId}`,
-              },
-            },
-          } satisfies DevCenterEcomValidations;
-        case 'GIFT_CARDS_PROVIDER':
-          if (manifest.compData.giftCardsProvider.deploymentUri != null) {
-            return manifest;
-          }
-
-          return {
-            ...manifest,
-            compData: {
-              giftCardsProvider: {
-                ...manifest.compData.giftCardsProvider,
-                deploymentUri: `_wix/extensions/service-plugins/${manifest.compId}`,
-              },
-            },
-          } satisfies DevCenterEcomGiftCardsProvider;
-        case 'WEBHOOK':
-          if (manifest.compData.webhook.callbackUrl != null) {
-            return manifest;
-          }
-
-          return {
-            ...manifest,
-            compData: {
-              webhook: {
-                ...manifest.compData.webhook,
-                callbackUrl: `_wix/extensions/webhooks/${manifest.compId}`,
-              },
-            },
-          } satisfies DevCenterWebhook;
-        default:
-          return manifest;
-      }
-    });
-
-  const unknownExtensions = model.unknownComponents.map(
-    (component) => component.manifest
-  );
-
-  return {
-    appId: model.appId,
-    components: [...extensions, ...unknownExtensions],
-  };
-}

package/src/utils/generateVisitorTokens.ts

@@ -1,11 +0,0 @@
-import type { Tokens } from '@wix/sdk';
-import { OAuthStrategy } from '@wix/sdk';
-import { WIX_CLIENT_ID } from 'astro:env/client';
-
-const auth = OAuthStrategy({
-  clientId: WIX_CLIENT_ID,
-});
-
-export async function generateVisitorTokens(): Promise<Tokens> {
-  return auth.generateVisitorTokens();
-}

package/src/utils/getSessionTokensFromCookie.ts

@@ -1,38 +0,0 @@
-import type { Tokens } from '@wix/sdk';
-import type { APIContext } from 'astro';
-import { TokenRole } from '@wix/sdk';
-import { z } from 'astro/zod';
-import { WIX_CLIENT_ID } from 'astro:env/client';
-
-const tokensSchema = z.object({
-  clientId: z.string(),
-  tokens: z.object({
-    accessToken: z.object({
-      expiresAt: z.number(),
-      value: z.string(),
-    }),
-    refreshToken: z.object({
-      role: z.nativeEnum(TokenRole),
-      value: z.string(),
-    }),
-  }),
-});
-
-export function getSessionTokensFromCookie(context: APIContext): null | Tokens {
-  if (!context.isPrerendered) {
-    const rawCookie = context.cookies.get('wixSession')?.json() as unknown;
-
-    if (rawCookie != null) {
-      const tokensParseResult = tokensSchema.safeParse(rawCookie);
-
-      if (
-        tokensParseResult.success &&
-        tokensParseResult.data.clientId === WIX_CLIENT_ID
-      ) {
-        return tokensParseResult.data.tokens;
-      }
-    }
-  }
-
-  return null;
-}

package/src/utils/loadEnvVars.ts

@@ -1,47 +0,0 @@
-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({
-  logger,
-  rootDir,
-}: {
-  logger: AstroIntegrationLogger;
-  rootDir: string;
-}): {
-  appId: string;
-  env: Record<string, string>;
-} {
-  const env = loadEnv(process.env.NODE_ENV ?? 'development', rootDir, '');
-  const appId = env[wixClientIdEnvVar];
-
-  if (appId == null) {
-    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 env 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/removeUnusedCodegenFiles.ts

@@ -1,34 +0,0 @@
-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/src/utils/resolveBuildMetadata.ts

@@ -1,37 +0,0 @@
-import { fileURLToPath } from 'node:url';
-import type { AstroConfig } from 'astro';
-import { pathExists } from './fs-utils.js';
-
-interface BuildMetadata {
-  appManifestPath: string;
-  clientDir: string;
-  outDir: string;
-  serverDir?: string;
-}
-
-export async function resolveBuildMetadata(
-  appManifestPath: string,
-  config: AstroConfig
-): Promise<BuildMetadata> {
-  const outDir = fileURLToPath(config.outDir);
-  const buildClientDir = fileURLToPath(config.build.client);
-  const buildServerDir = fileURLToPath(config.build.server);
-
-  // When there are only static assets, everything is under the out dir.
-  // When there are static and server, the output is in the appropriate folders
-  const clientDir = (await pathExists(buildClientDir))
-    ? buildClientDir
-    : outDir;
-
-  // In SSG (static site generation) mode, there is no `serverDir`, only the client side output.
-  const serverDir = (await pathExists(buildServerDir))
-    ? buildServerDir
-    : undefined;
-
-  return {
-    appManifestPath,
-    clientDir,
-    outDir,
-    serverDir,
-  };
-}

package/src/utils/saveSessionTokensToCookie.ts

@@ -1,27 +0,0 @@
-import type { Tokens } from '@wix/sdk';
-import type { APIContext, AstroCookieSetOptions } from 'astro';
-import { WIX_CLIENT_ID } from 'astro:env/client';
-
-export function saveSessionTokensToCookie(
-  context: APIContext,
-  tokens: Tokens
-): void {
-  const cookieOptions: AstroCookieSetOptions = {
-    path: '/',
-    secure: true,
-  };
-
-  if (import.meta.env.DEV) {
-    cookieOptions.sameSite = 'none';
-    cookieOptions.maxAge = 10800;
-  }
-
-  context.cookies.set('wixSession', sessionCookieJson(tokens), cookieOptions);
-}
-
-function sessionCookieJson(tokens: Tokens) {
-  return {
-    clientId: WIX_CLIENT_ID,
-    tokens,
-  };
-}

package/src/utils/transformStreamUtils.ts

@@ -1,39 +0,0 @@
-export function injectAfterTransformStream(
-  predicate: RegExp,
-  htmlToInject: string
-): TransformStream<string> {
-  let hasInjected = false;
-  return new TransformStream<string>({
-    transform: (chunk, controller) => {
-      if (!hasInjected) {
-        const index = predicate.exec(chunk);
-        if (index) {
-          const position = index.index + index[0].length;
-          chunk =
-            chunk.slice(0, position) + htmlToInject + chunk.slice(position);
-          hasInjected = true;
-        }
-      }
-      controller.enqueue(chunk);
-    },
-  });
-}
-
-export function injectBeforeTransformStream(
-  predicate: string,
-  htmlToInject: string
-): TransformStream<string> {
-  let hasInjected = false;
-  return new TransformStream<string>({
-    transform: (chunk, controller) => {
-      if (!hasInjected) {
-        const index = chunk.indexOf(predicate);
-        if (index > -1) {
-          chunk = chunk.slice(0, index) + htmlToInject + chunk.slice(index);
-          hasInjected = true;
-        }
-      }
-      controller.enqueue(chunk);
-    },
-  });
-}