@wix/astro 0.3.4 → 1.0.1

package/src/utils/writeVirtualExtensionFiles.ts

@@ -0,0 +1,54 @@
+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 { isValidBackofficeComponent } from '../utils/isValidBackofficeComponent.js';
+
+export async function writeVirtualExtensionFiles(
+  model: Model,
+  codegenDir: string
+) {
+  const existingFiles = await globby(`*.astro`, {
+    cwd: codegenDir,
+    onlyFiles: true,
+  });
+
+  for (const filename of existingFiles) {
+    const hasMatchingSourceFile = model.extensions.some(
+      (extension) => `${extension.config.compId}.astro` === filename
+    );
+
+    if (hasMatchingSourceFile) {
+      continue;
+    }
+
+    await rm(join(codegenDir, filename));
+  }
+
+  const backofficeExtensions = model.extensions.filter((extension) =>
+    isValidBackofficeComponent(extension.config)
+  );
+
+  for (const extension of backofficeExtensions) {
+    const originalEntrypoint = resolve(
+      model.rootDir,
+      extension.componentFilePath
+    );
+    const virtualEntrypoint = join(
+      codegenDir,
+      `${extension.config.compId}.astro`
+    );
+
+    await writeFile(
+      virtualEntrypoint,
+      outdent`
+        ---
+        import Component from '${originalEntrypoint}';
+        ---
+
+        <Component client:only="react" />
+      `
+    );
+  }
+}

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "include": ["src", "test"],
+  "compilerOptions": {
+    "outDir": "build",
+    "declaration": true
+  }
+}

package/tsup.config.mjs

@@ -0,0 +1,28 @@
+import { defineConfig } from '@wix/tsup-configs/public-node';
+
+export default defineConfig(
+  {
+    entry: ['src/index.ts'],
+    target: 'node20.9',
+    format: ['esm'],
+    outDir: 'build',
+    splitting: false,
+    external: ['astro', 'vite', /^astro:/],
+    dts: {
+      resolve: ['astro', 'vite', /^astro:/],
+    },
+  },
+  [
+    {
+      entry: ['src/middleware/auth.ts'],
+      target: 'node20.9',
+      format: ['esm'],
+      outDir: 'build-runtime',
+      splitting: false,
+      external: ['astro', 'vite', /^astro:/],
+      dts: {
+        resolve: ['astro', 'vite', /^astro:/],
+      },
+    },
+  ]
+);

package/README.md

@@ -1,121 +0,0 @@
-# Wix Integration For Astro
-
-The Wix integration for Astro allows you to build custom frontends with Astro on top of the Wix Developer Platform. The integration provides a boilerplate-free development experience with a set of tools to help streamline your development with Wix.
-
-The main features of the Wix integration for Astro include:
-
-- **Easy SDK Integration**: Use the Wix SDK modules directly through a pre-initialized and contextually available `WixClient`.
-- **Session Management Middleware**: A middleware that manages a session cookie for the current site visitor.
-- **Adapter for Wix Hosting**: The integration provides an adapter for Wix hosting, allowing you to deploy your Astro project to Wix hosting.
-
-## Getting Started
-
-The easiest way to get started with the Wix integration for Astro is to scaffold a new Astro project with one of the Wix templates. If you already have an Astro project or rather start with another template, you can add the Wix integration to an existing Astro project.
-
-### Scaffold a New Astro Project with a Wix Template
-
-Wix provides a collection of Astro templates that are pre-configured with the Wix integration for Astro and also act as a starting point for different types of projects. Check out our Wix Astro templates on GitHub: [wix/headless-templates/astro](https://github.com/wix/headless-templates/tree/main/astro).
-
-```bash
-# npm
-npm create astro@latest --template wix/headless-templates/astro/<template-name>
-# yarn
-yarn create astro@latest --template wix/headless-templates/astro/<template-name>
-# pnpm
-pnpm create astro@latest --template wix/headless-templates/astro/<template-name>
-```
-
-Check the template's README for more information on how to get started with the template.
-
-### Add the Wix Integration to an Existing Astro Project
-
-If you already have an Astro project or want to start with another template, you can add the Wix integration to your project.
-
-```bash
-# npm
-npx astro add @wix/astro
-# yarn
-yarn astro add @wix/astro
-# pnpm
-pnpx astro add @wix/astro
-```
-
-#### Setting up local development
-
-> 💡 If you are deploying your project to Wix, check out the guide on [local development with the Wix Edge CLI](../cli//local-development.md).
-
-The Wix integration requires the `WIX_CLIENT_ID` environment variable to be set. For local development, you can create a `.env.local` file in the root of your project and add the `WIX_CLIENT_ID` environment variable.
-
-```properties
-WIX_CLIENT_ID=your-wix-client-id
-```
-
-> ❓ Not sure what the Wix Client ID is or how to obtain it? Check out our documentation to [Create an OAuth App](https://dev.wix.com/docs/go-headless/getting-started/setup/authentication/create-an-oauth-app-for-visitors-and-members)
-
-## Features
-
-### Easy SDK Integration
-
-The Wix integration for Astro provides a pre-initialized and contextually available `WixClient` that allows you to use the Wix SDK modules directly in your Astro project.
-
-For example, to query your products from the Wix Stores API, you can just install the `@wix/stores` npm package and use the methods directly after importing them.
-
-```js
----
-import { products } from "@wix/stores";
-
-const storeProducts = await products.queryProducts().find();
----
-
-<h1>Number of products in store: {storeProducts.items.length}</h1>
-```
-
-#### SDK Modules in Astro Components frontmatter
-
-You can use any of the SDK modules in your Astro components frontmatter to fetch data at build time or on-demand. There's no need to create an explicit `WixClient` and methods can be called directly.
-
-```astro
----
-import { products } from "@wix/stores";
-
-const storeProducts = await products.queryProducts().find();
----
-
-<h1>Products</h1>
-
-{storeProducts.map((product) => (
-  <div>
-    <h2>{product.name}</h2>
-    <p>{product.description}</p>
-  </div>
-))}
-```
-
-##### Pre-rendering
-
-When used in pre-rendered components or pages, the SDK modules will use an automatically generated visitor session for the entire build. This means you'll only be able to access public data, and any data that requires a visitor session will be reset on each build.
-
-> 💡 If you are working with APIs that require a current visitor session, be sure to set the relevant pages / components to [on-demand rendering](#on-demand-rendering).
-
-##### On-demand rendering
-
-When used in on-demand rendered components or pages, the SDK modules will use the current visitor session. This means you'll be able to access data that requires a visitor session, and the data will be fetched on-demand when the page is visited.
-
-Visitor session management is handled by the [Session Management Middleware](#session-management-middleware).
-
-#### SDK Modules in Scripts / UI Frameworks
-
-You can also use the SDK modules in your scripts or UI frameworks. Just import the modules and use them as you would in any other JavaScript environment.
-
-```html
-<p>Products in store: <span id="productsCount">...</span></p>
-<script>
-import { products } from "@wix/stores";
-
-const storeProducts = await products.queryProducts().find();
-
-document.getElementById("productsCount").innerText = storeProducts.items.length;
-</script>
-```
-
-In your scripts or UI framework components, your API calls will be authenticated with the current visitor session as managed by the [Session Management Middleware](#session-management-middleware).

package/dist/auth-context.d.ts

@@ -1,5 +0,0 @@
-import { AsyncLocalStorage } from "node:async_hooks";
-import type { AuthenticationStrategy } from "@wix/sdk";
-export declare const authStrategyAsyncLocalStorage: AsyncLocalStorage<{
-    auth: AuthenticationStrategy<void>;
-}>;

package/dist/auth-context.js

@@ -1,2 +0,0 @@
-import { AsyncLocalStorage } from "node:async_hooks";
-export const authStrategyAsyncLocalStorage = new AsyncLocalStorage();

package/dist/client.d.ts

@@ -1,15 +0,0 @@
-import { categories, posts, tags } from "@wix/blog";
-import { items } from "@wix/data";
-export declare const getWixClient: ({ modules }?: {
-    modules: {
-        items: typeof items;
-        posts: typeof posts;
-        categories: typeof categories;
-        tags: typeof tags;
-    };
-}) => import("@wix/sdk").WixClient<undefined, import("@wix/sdk").IOAuthStrategy, {
-    items: typeof items;
-    posts: typeof posts;
-    categories: typeof categories;
-    tags: typeof tags;
-}>;

package/dist/client.js

@@ -1,16 +0,0 @@
-import { categories, posts, tags } from "@wix/blog";
-import { items } from "@wix/data";
-import { createClient, OAuthStrategy } from "@wix/sdk";
-export const getWixClient = ({ modules } = { modules: { items, posts, categories, tags } }) => {
-    const { WIX_CLIENT_ID } = import.meta.env;
-    if (!WIX_CLIENT_ID) {
-        throw new Error(`❌ Wix Client ID is missing! Please create an ".env.local" file with WIX_CLIENT_ID.`);
-    }
-    const wixClient = createClient({
-        modules,
-        auth: OAuthStrategy({
-            clientId: WIX_CLIENT_ID,
-        }),
-    });
-    return wixClient;
-};

package/dist/components/login-helpers/bi-header-generator.d.ts

@@ -1,11 +0,0 @@
-import { APIMetadata, PublicMetadata } from '@wix/sdk-types';
-export declare const WixBIHeaderName = "x-wix-bi-gateway";
-export type WixBIHeaderValues = {
-    ['environment']: 'js-sdk' | string;
-    ['package-name']?: string;
-    ['method-fqn']?: string;
-    ['entity']?: string;
-};
-export declare function biHeaderGenerator(apiMetadata: APIMetadata, publicMetadata?: PublicMetadata, environment?: string): {
-    [WixBIHeaderName]: string;
-};

package/dist/components/login-helpers/bi-header-generator.js

@@ -1,17 +0,0 @@
-export const WixBIHeaderName = 'x-wix-bi-gateway';
-export function biHeaderGenerator(apiMetadata, publicMetadata, environment) {
-    return {
-        [WixBIHeaderName]: objectToKeyValue({
-            environment: `js-sdk${environment ? `-${environment}` : ``}`,
-            'package-name': apiMetadata.packageName ?? publicMetadata?.PACKAGE_NAME,
-            'method-fqn': apiMetadata.methodFqn,
-            entity: apiMetadata.entityFqdn,
-        }),
-    };
-}
-function objectToKeyValue(input) {
-    return Object.entries(input)
-        .filter(([_, value]) => Boolean(value))
-        .map(([key, value]) => `${key}=${value}`)
-        .join(',');
-}

package/dist/components/login-helpers/iframeUtils.d.ts

@@ -1,4 +0,0 @@
-export declare function addListener(eventTarget: any, name: string, fn: Function): void;
-export declare function removeListener(eventTarget: any, name: string, fn: Function): void;
-export declare function loadFrame(src: string): HTMLIFrameElement;
-export declare function addPostMessageListener(state: string): Promise<unknown>;

package/dist/components/login-helpers/iframeUtils.js

@@ -1,43 +0,0 @@
-export function addListener(eventTarget, name, fn) {
-    if (eventTarget.addEventListener) {
-        eventTarget.addEventListener(name, fn);
-    }
-    else {
-        eventTarget.attachEvent('on' + name, fn);
-    }
-}
-export function removeListener(eventTarget, name, fn) {
-    if (eventTarget.removeEventListener) {
-        eventTarget.removeEventListener(name, fn);
-    }
-    else {
-        eventTarget.detachEvent('on' + name, fn);
-    }
-}
-export function loadFrame(src) {
-    const iframe = document.createElement('iframe');
-    iframe.style.display = 'none';
-    iframe.src = src;
-    return document.body.appendChild(iframe);
-}
-export function addPostMessageListener(state) {
-    let responseHandler;
-    let timeoutId;
-    const msgReceivedOrTimeout = new Promise((resolve, reject) => {
-        responseHandler = (e) => {
-            if (!e.data || e.data.state !== state) {
-                // A message not meant for us
-                return;
-            }
-            resolve(e.data);
-        };
-        addListener(window, 'message', responseHandler);
-        timeoutId = setTimeout(() => {
-            reject(new Error('OAuth flow timed out'));
-        }, 120000);
-    });
-    return msgReceivedOrTimeout.finally(() => {
-        clearTimeout(timeoutId);
-        removeListener(window, 'message', responseHandler);
-    });
-}

package/dist/components/login-helpers/login-helpers.d.ts

@@ -1,42 +0,0 @@
-export interface OauthPKCE {
-    codeVerifier: string;
-    codeChallenge: string;
-    state: string;
-}
-export interface OauthData extends OauthPKCE {
-    originalUri: string;
-    redirectUri: string;
-}
-export interface OauthPKCE {
-    codeVerifier: string;
-    codeChallenge: string;
-    state: string;
-}
-export interface Token {
-    value: string;
-}
-export interface AccessToken extends Token {
-    expiresAt: number;
-}
-export declare enum TokenRole {
-    NONE = "none",
-    VISITOR = "visitor",
-    MEMBER = "member"
-}
-export interface TokenResponse {
-    access_token: string;
-    expires_in: number;
-    refresh_token: string | null;
-    token_type: string;
-    scope?: string | null;
-}
-export declare const getMemberTokensForDirectLogin: (sessionToken: string) => Promise<{
-    clientId: string;
-    tokens: {
-        accessToken: AccessToken;
-        refreshToken: {
-            value: string;
-            role: TokenRole;
-        };
-    };
-}>;

package/dist/components/login-helpers/login-helpers.js

@@ -1,119 +0,0 @@
-import { redirects } from '@wix/redirects';
-import { loadFrame, addPostMessageListener } from './iframeUtils.js';
-import { biHeaderGenerator } from './bi-header-generator.js';
-import { wixContext } from '@wix/sdk-context';
-import { generateRandomCodeVerifier, calculatePKCECodeChallenge, generateRandomState } from 'oauth4webapi';
-const DEFAULT_API_URL = 'www.wixapis.com';
-export var TokenRole;
-(function (TokenRole) {
-    TokenRole["NONE"] = "none";
-    TokenRole["VISITOR"] = "visitor";
-    TokenRole["MEMBER"] = "member";
-})(TokenRole || (TokenRole = {}));
-const generatePKCE = async () => {
-    const codeVerifier = generateRandomCodeVerifier();
-    const pkceState = await calculatePKCECodeChallenge(codeVerifier);
-    return {
-        codeChallenge: pkceState,
-        codeVerifier: codeVerifier,
-        state: generateRandomState(),
-    };
-};
-const getAuthorizationUrlWithOptions = async (oauthData, responseMode, prompt, sessionToken) => {
-    const { redirectSession } = await redirects.createRedirectSession({
-        auth: {
-            authRequest: {
-                redirectUri: oauthData.redirectUri,
-                ...(oauthData.redirectUri && {
-                    redirectUri: oauthData.redirectUri,
-                }),
-                codeChallenge: oauthData.codeChallenge,
-                codeChallengeMethod: 'S256',
-                responseMode,
-                responseType: 'code',
-                scope: 'offline_access',
-                state: oauthData.state,
-                clientId: wixContext['clientId'],
-                ...(sessionToken && { sessionToken }),
-            },
-            prompt: redirects.Prompt[prompt],
-        },
-    });
-    return {
-        authUrl: redirectSession.fullUrl,
-        authorizationEndpoint: redirectSession.urlDetails.endpoint,
-        sessionToken: redirectSession.sessionToken,
-    };
-};
-const fetchTokens = async (payload, headers = {}) => {
-    const res = await fetch(`https://${DEFAULT_API_URL}/oauth2/token`, {
-        method: 'POST',
-        body: JSON.stringify(payload),
-        headers: {
-            ...biHeaderGenerator({
-                entityFqdn: 'wix.identity.oauth.v1.refresh_token',
-                methodFqn: 'wix.identity.oauth2.v1.Oauth2Ng.Token',
-                packageName: '@wix/sdk',
-            }),
-            'Content-Type': 'application/json',
-            ...headers,
-        },
-    });
-    if (res.status !== 200) {
-        let responseJson;
-        try {
-            responseJson = await res.json();
-        }
-        catch { }
-        throw new Error(`Failed to fetch tokens from OAuth API: ${res.statusText}. request id: ${res.headers.get('x-request-id')}. ${responseJson ? `Response: ${JSON.stringify(responseJson)}` : ''}`);
-    }
-    const json = await res.json();
-    return json;
-};
-function getCurrentDate() {
-    return Math.floor(Date.now() / 1000);
-}
-function createAccessToken(accessToken, expiresIn) {
-    const now = getCurrentDate();
-    return { value: accessToken, expiresAt: Number(expiresIn) + now };
-}
-const getMemberTokens = async (code, state, oauthData) => {
-    if (!code || !state) {
-        throw new Error('Missing code or _state');
-    }
-    else if (state !== oauthData.state) {
-        throw new Error('Invalid _state');
-    }
-    const tokensResponse = await fetchTokens({
-        clientId: wixContext['clientId'],
-        grantType: 'authorization_code',
-        ...(oauthData.redirectUri && { redirectUri: oauthData.redirectUri }),
-        code,
-        codeVerifier: oauthData.codeVerifier,
-    });
-    return {
-        clientId: wixContext['clientId'],
-        tokens: {
-            accessToken: createAccessToken(tokensResponse.access_token, tokensResponse.expires_in),
-            refreshToken: {
-                value: tokensResponse.refresh_token,
-                role: TokenRole.MEMBER,
-            },
-        }
-    };
-};
-export const getMemberTokensForDirectLogin = async (sessionToken) => {
-    const oauthPKCE = await generatePKCE();
-    const { authUrl } = await getAuthorizationUrlWithOptions(oauthPKCE, 'web_message', 'none', sessionToken);
-    const iframePromise = addPostMessageListener(oauthPKCE.state);
-    const iframeEl = loadFrame(authUrl);
-    return iframePromise
-        .then((res) => {
-        return getMemberTokens(res.code, res.state, oauthPKCE);
-    })
-        .finally(() => {
-        if (document.body.contains(iframeEl)) {
-            iframeEl.parentElement?.removeChild(iframeEl);
-        }
-    });
-};