npm - @exdst-sitecore-content-sdk/astro - Versions diffs - 0.0.1 - Mend

@exdst-sitecore-content-sdk/astro 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (87) hide show

package/LICENSE.txt +202 -0
package/README.md +3 -0
package/package.json +101 -0
package/src/client/index.ts +12 -0
package/src/client/sitecore-astro-client.test.ts +271 -0
package/src/client/sitecore-astro-client.ts +137 -0
package/src/components/AstroImage.astro +114 -0
package/src/components/Date.astro +76 -0
package/src/components/DefaultEmptyFieldEditingComponentImage.astro +24 -0
package/src/components/DefaultEmptyFieldEditingComponentText.astro +12 -0
package/src/components/EditingScripts.astro +49 -0
package/src/components/EmptyRendering.astro +3 -0
package/src/components/ErrorBoundary.astro +77 -0
package/src/components/FieldMetadata.astro +30 -0
package/src/components/File.astro +46 -0
package/src/components/HiddenRendering.astro +22 -0
package/src/components/Image.astro +155 -0
package/src/components/Link.astro +105 -0
package/src/components/MissingComponent.astro +39 -0
package/src/components/Placeholder/EmptyPlaceholder.astro +9 -0
package/src/components/Placeholder/Placeholder.astro +100 -0
package/src/components/Placeholder/PlaceholderMetadata.astro +102 -0
package/src/components/Placeholder/PlaceholderUtils.astro +153 -0
package/src/components/Placeholder/index.ts +5 -0
package/src/components/Placeholder/models.ts +82 -0
package/src/components/Placeholder/placeholder-utils.test.ts +162 -0
package/src/components/Placeholder/placeholder-utils.ts +80 -0
package/src/components/RenderWrapper.astro +31 -0
package/src/components/RichText.astro +59 -0
package/src/components/Text.astro +97 -0
package/src/components/sharedTypes/index.ts +1 -0
package/src/components/sharedTypes/props.ts +17 -0
package/src/config/define-config.test.ts +526 -0
package/src/config/define-config.ts +99 -0
package/src/config/index.ts +1 -0
package/src/config-cli/define-cli-config.test.ts +95 -0
package/src/config-cli/define-cli-config.ts +50 -0
package/src/config-cli/index.ts +1 -0
package/src/context.ts +68 -0
package/src/editing/constants.ts +8 -0
package/src/editing/editing-config-middleware.test.ts +166 -0
package/src/editing/editing-config-middleware.ts +111 -0
package/src/editing/editing-render-middleware.test.ts +801 -0
package/src/editing/editing-render-middleware.ts +288 -0
package/src/editing/index.ts +16 -0
package/src/editing/render-middleware.test.ts +57 -0
package/src/editing/render-middleware.ts +51 -0
package/src/editing/utils.test.ts +852 -0
package/src/editing/utils.ts +308 -0
package/src/enhancers/WithEmptyFieldEditingComponent.astro +56 -0
package/src/enhancers/WithFieldMetadata.astro +31 -0
package/src/env.d.ts +12 -0
package/src/index.ts +16 -0
package/src/middleware/index.ts +24 -0
package/src/middleware/middleware.test.ts +507 -0
package/src/middleware/middleware.ts +167 -0
package/src/middleware/multisite-middleware.test.ts +672 -0
package/src/middleware/multisite-middleware.ts +147 -0
package/src/middleware/robots-middleware.test.ts +113 -0
package/src/middleware/robots-middleware.ts +47 -0
package/src/middleware/sitemap-middleware.test.ts +152 -0
package/src/middleware/sitemap-middleware.ts +65 -0
package/src/services/component-props-service.ts +182 -0
package/src/sharedTypes/component-props.ts +17 -0
package/src/site/index.ts +1 -0
package/src/test-data/components/Bar.astro +0 -0
package/src/test-data/components/Baz.astro +0 -0
package/src/test-data/components/Foo.astro +0 -0
package/src/test-data/components/Hero.variant.astro +0 -0
package/src/test-data/components/NotComponent.bsx +0 -0
package/src/test-data/components/Qux.astro +0 -0
package/src/test-data/components/folded/Folded.astro +0 -0
package/src/test-data/components/folded/random-file-2.docx +0 -0
package/src/test-data/components/random-file.txt +0 -0
package/src/test-data/helpers.ts +46 -0
package/src/test-data/personalizeData.ts +63 -0
package/src/tools/generate-map.ts +83 -0
package/src/tools/index.ts +8 -0
package/src/tools/templating/components.test.ts +305 -0
package/src/tools/templating/components.ts +49 -0
package/src/tools/templating/constants.ts +4 -0
package/src/tools/templating/default-component.test.ts +31 -0
package/src/tools/templating/default-component.ts +63 -0
package/src/tools/templating/index.ts +2 -0
package/src/utils/index.ts +1 -0
package/src/utils/utils.test.ts +48 -0
package/src/utils/utils.ts +52 -0

package/src/editing/editing-render-middleware.ts ADDED Viewed

@@ -0,0 +1,288 @@
+import { debug, NativeDataFetcher } from '@sitecore-content-sdk/core';
+import {
+  QUERY_PARAM_EDITING_SECRET,
+  EDITING_ALLOWED_ORIGINS,
+} from '@sitecore-content-sdk/core/editing';
+import { getEditingSecret } from '../utils';
+import { getEnforcedCorsHeaders } from '@sitecore-content-sdk/core/utils';
+import { LayoutServicePageState } from '@sitecore-content-sdk/core/layout';
+import { RenderMiddlewareBase } from './render-middleware';
+import {
+  cleanupPreviewCookies,
+  getCSPHeader,
+  getEditingRenderQueryParams,
+  getEditingRequestHtml,
+  getHeadersForPropagation,
+  getPreviewCookies,
+  getQueryParamsForPropagation,
+  getRequiredEditingParamsList,
+  mapEditingParams,
+  PreviewCookies,
+  resolveServerUrl,
+} from './utils';
+import * as cookie from 'cookie';
+/**
+ * Configuration for the Editing Render Middleware.
+ */
+export type EditingRenderMiddlewareConfig = {
+  /**
+   * Function used to determine route/page URL to render.
+   * This may be necessary for certain custom routing configurations.
+   * @param {string} itemPath The Sitecore relative item path e.g. '/styleguide'
+   * @returns {string} The URL to render
+   * @default `${itemPath}`
+   */
+  resolvePageUrl?: (itemPath: string) => string;
+  /**
+   * The internal host URL for the application, used for server-side requests for page rendering during editing.
+   */
+  sitecoreInternalEditingHostUrl?: string;
+};
+/**
+ * Middleware / handler for use in the editing render API route (e.g. '/api/editing/render')
+ * which is required for Sitecore editing support.
+ */
+export class EditingRenderMiddleware extends RenderMiddlewareBase {
+  private dataFetcher: NativeDataFetcher;
+  /**
+   * @param {EditingRenderMiddlewareConfig} [config] Editing render middleware config
+   */
+  constructor(public config?: EditingRenderMiddlewareConfig) {
+    super();
+    this.dataFetcher = new NativeDataFetcher({ debugger: debug.editing });
+  }
+  /**
+   * Gets the API route handler
+   * @returns route handler
+   */
+  public getHandler(): (req: Request) => Promise<Response> {
+    return this.handler;
+  }
+  /**
+   * Gets the preview data cookies string
+   * @param {object} data preview data
+   * @returns Cookie string with the preview data
+   */
+  private getPreviewDataCookies = (data: {
+    [key: string]: string | string[] | undefined;
+  }): string => {
+    return cookie.serialize(
+      PreviewCookies.PREVIEW_DATA,
+      JSON.stringify(data, (_, value) => (value === null ? undefined : value)),
+      {
+        httpOnly: true,
+        path: '/',
+        maxAge: 3,
+        sameSite: 'none',
+        secure: true,
+      }
+    );
+  };
+  private handler = async (_req: Request): Promise<Response> => {
+    const { method, headers } = _req;
+    const url = new URL(_req.url.toLowerCase());
+    const query = getEditingRenderQueryParams(url.searchParams);
+    debug.editing('editing render middleware start: %o', {
+      method,
+      query,
+      headers,
+    });
+    const _res = new Response();
+    _res.headers.append('Content-Type', 'application/json; charset=utf-8');
+    const corsHeaders = getEnforcedCorsHeaders({
+      requestMethod: _req.method,
+      headers: _req.headers,
+      allowedOrigins: EDITING_ALLOWED_ORIGINS,
+    });
+    if (!corsHeaders) {
+      debug.editing(
+        'invalid origin host - set allowed origins in JSS_ALLOWED_ORIGINS environment variable'
+      );
+      return new Response(
+        JSON.stringify({
+          html: `<html><body>Requests from origin ${_req.headers?.get(
+            'origin'
+          )} not allowed</body></html>`,
+        }),
+        {
+          status: 401,
+          headers: _res.headers,
+        }
+      );
+    }
+    Object.keys(corsHeaders).forEach((key) => {
+      _res.headers.append(key, corsHeaders[key]);
+    });
+    // Validate secret
+    const secret = query[QUERY_PARAM_EDITING_SECRET];
+    if (secret !== getEditingSecret()) {
+      debug.editing('invalid editing secret - sent "%s" expected "%s"', secret, getEditingSecret());
+      return new Response(
+        JSON.stringify({
+          html: '<html><body>Missing or invalid secret</body></html>',
+        }),
+        {
+          status: 401,
+          headers: _res.headers,
+        }
+      );
+    }
+    if (_req.method === 'OPTIONS') {
+      debug.editing('preflight request');
+      // CORS headers are set by enforceCors
+      return new Response(null, {
+        status: 204,
+        headers: _res.headers,
+      });
+    }
+    if (_req.method !== 'GET') {
+      debug.editing('invalid method - sent %s expected GET', _req.method);
+      _res.headers.append('Allow', 'GET');
+      return new Response(
+        JSON.stringify({
+          html: `<html><body>Invalid request method '${_req.method}'</body></html>`,
+        }),
+        {
+          status: 405,
+          headers: _res.headers,
+        }
+      );
+    }
+    const startTimestamp = Date.now();
+    const mode = query.mode;
+    const requiredQueryParams = getRequiredEditingParamsList(mode);
+    const missingQueryParams = requiredQueryParams.filter((param) => !query[param]);
+    // Validate query parameters
+    if (missingQueryParams.length) {
+      debug.editing('missing required query parameters: %o', missingQueryParams);
+      return new Response(
+        JSON.stringify({
+          html: `<html><body>Missing required query parameters: ${missingQueryParams.join(
+            ', '
+          )}</body></html>`,
+        }),
+        {
+          status: 400,
+          headers: _res.headers,
+        }
+      );
+    }
+    const previewDataParams = mapEditingParams(query as { [key: string]: string });
+    const previewDataCookies = this.getPreviewDataCookies({
+      ...previewDataParams,
+      variantIds: previewDataParams.variantIds?.split(','),
+    });
+    _res.headers.append('Set-Cookie', previewDataCookies);
+    // Set Preview mode identifier cookie, if the page is rendered in Sitecore Preview mode
+    if (mode === LayoutServicePageState.Preview) {
+      const previewCookies = getPreviewCookies(query.sc_site as string);
+      previewCookies.forEach((cookie) => {
+        _res.headers.append('Set-Cookie', cookie);
+      });
+    }
+    // Restrict the page to be rendered only within the allowed origins
+    _res.headers.append('Content-Security-Policy', getCSPHeader());
+    const encodedRoute = encodeURI(query.route);
+    const route = this.config?.resolvePageUrl?.(encodedRoute) || encodedRoute;
+    const base = this.config?.sitecoreInternalEditingHostUrl || resolveServerUrl(_req);
+    const requestUrl = new URL(route, base);
+    // Grab the preview cookies to send on to the render request
+    const cookies = _res.headers.getSetCookie();
+    // Make actual render request for page route, passing on preview cookies as well as any approved query string parameters.
+    // Note timestamp effectively disables caching the request (no amount of cache headers seemed to do it)
+    try {
+      debug.editing('fetching page route for %s', query.route);
+      // Get query string parameters to propagate on subsequent requests (e.g. for deployment protection bypass)
+      const propagatedQsParams = getQueryParamsForPropagation(query as { [key: string]: string });
+      // Get headers to propagate on subsequent requests
+      const propagatedHeaders = getHeadersForPropagation(headers);
+      const html = await getEditingRequestHtml(
+        requestUrl,
+        propagatedQsParams,
+        propagatedHeaders,
+        cookies,
+        this.dataFetcher
+      );
+      // remove preview cookies to not leak them to the browser
+      if (cookies && Array.isArray(cookies)) {
+        const filteredCookies = cleanupPreviewCookies(cookies);
+        _res.headers.delete('Set-Cookie');
+        filteredCookies?.forEach((cookie) => {
+          _res.headers.append('Set-Cookie', cookie);
+        });
+      }
+      debug.editing('editing render middleware end in %dms: %o', Date.now() - startTimestamp, {
+        status: 200,
+        route,
+      });
+      _res.headers.set('Content-Type', 'text/html; charset=utf-8');
+      return new Response(html, {
+        status: 200,
+        headers: _res.headers,
+      });
+    } catch (err) {
+      const error = err as Record<string, unknown>;
+      console.error(error);
+      if (error.response) {
+        console.info(
+          // eslint-disable-next-line quotes
+          "Hint: for non-standard server or Next.js route configurations, you may need to override 'resolvePageUrl' or set the 'sitecoreInternalEditingHostUrl' (or SITECORE_INTERNAL_EDITING_HOST_URL env variable) available on the 'EditingRenderMiddleware' config."
+        );
+      }
+      // remove preview cookies to not leak them to the browser
+      const filteredCookies = cleanupPreviewCookies(cookies);
+      _res.headers.delete('Set-Cookie');
+      filteredCookies?.forEach((cookie) => {
+        _res.headers.append('Set-Cookie', cookie);
+      });
+      return new Response(`<html><body>${error}</body></html>`, {
+        status: 500,
+        headers: _res.headers,
+      });
+    }
+  };
+}

package/src/editing/index.ts ADDED Viewed

@@ -0,0 +1,16 @@
+export {
+  EditingConfigMiddleware,
+  EditingConfigMiddlewareConfig,
+} from './editing-config-middleware';
+export {
+  EditingRenderMiddleware,
+  EditingRenderMiddlewareConfig,
+} from './editing-render-middleware';
+export {
+  isDesignLibraryPreviewData,
+  getQueryParamsForPropagation,
+  getHeadersForPropagation,
+  PreviewCookies,
+} from './utils';

package/src/editing/render-middleware.test.ts ADDED Viewed

@@ -0,0 +1,57 @@
+/* eslint-disable dot-notation */
+import chai from 'chai';
+import chaiString from 'chai-string';
+import { QUERY_PARAM_EDITING_SECRET } from '@sitecore-content-sdk/core/editing';
+import { RenderMiddlewareBase } from './render-middleware';
+import {
+  QUERY_PARAM_VERCEL_PROTECTION_BYPASS,
+  QUERY_PARAM_VERCEL_SET_BYPASS_COOKIE,
+  EDITING_PASS_THROUGH_HEADERS,
+} from './constants';
+const expect = chai.use(chaiString).expect;
+describe('RenderMiddlewareBase', () => {
+  class SampleMiddleware extends RenderMiddlewareBase {}
+  describe('getQueryParamsForPropagation', () => {
+    it('should construct query params for protection bypass', () => {
+      const middleware = new SampleMiddleware();
+      const secret = 'secret1234';
+      const vercelBypassToken = 'token1234Vercel';
+      const vercelBypassCookie = 'samesitenone';
+      const query = new URLSearchParams({
+        [QUERY_PARAM_EDITING_SECRET]: secret,
+        [QUERY_PARAM_VERCEL_PROTECTION_BYPASS]: vercelBypassToken,
+        [QUERY_PARAM_VERCEL_SET_BYPASS_COOKIE]: vercelBypassCookie,
+      });
+      const approvedQuery = new URLSearchParams({
+        [QUERY_PARAM_VERCEL_PROTECTION_BYPASS]: vercelBypassToken,
+        [QUERY_PARAM_VERCEL_SET_BYPASS_COOKIE]: vercelBypassCookie,
+      });
+      expect(middleware['getQueryParamsForPropagation'](query)).to.deep.equal(approvedQuery);
+    });
+  });
+  describe('getHeadersForPropagation', () => {
+    it('should return approved headers', () => {
+      const middleware = new SampleMiddleware();
+      const allHeaders = new Headers();
+      const approvedHeaders = new Headers();
+      EDITING_PASS_THROUGH_HEADERS.forEach((key) => {
+        allHeaders.append(key, `${key}-value`);
+        approvedHeaders.append(key, `${key}-value`);
+      });
+      allHeaders.append('nope', 'nope');
+      allHeaders.append('should-not-pass', 'n/a');
+      expect(middleware['getHeadersForPropagation'](allHeaders)).to.deep.equal(approvedHeaders);
+    });
+  });
+});

package/src/editing/render-middleware.ts ADDED Viewed

@@ -0,0 +1,51 @@
+import {
+  QUERY_PARAM_VERCEL_PROTECTION_BYPASS,
+  QUERY_PARAM_VERCEL_SET_BYPASS_COOKIE,
+  EDITING_PASS_THROUGH_HEADERS,
+} from './constants';
+/**
+ * Base class for middleware that handles pages and components rendering in Sitecore Editors.
+ * @deprecated getQueryParamsForPropagation and getHeadersForPropagation methods have been moved to separate exports
+ */
+export abstract class RenderMiddlewareBase {
+  /**
+   * Gets query parameters that should be passed along to subsequent requests (e.g. for deployment protection bypass)
+   * @param {object} query URLSearchParams object from incoming URL
+   * @returns URLSearchParams object of approved query parameters
+   */
+  protected getQueryParamsForPropagation = (query: URLSearchParams): URLSearchParams => {
+    const params = new URLSearchParams();
+    if (query.get(QUERY_PARAM_VERCEL_PROTECTION_BYPASS)) {
+      params.append(
+        QUERY_PARAM_VERCEL_PROTECTION_BYPASS,
+        query.get(QUERY_PARAM_VERCEL_PROTECTION_BYPASS) as string
+      );
+    }
+    if (query.get(QUERY_PARAM_VERCEL_SET_BYPASS_COOKIE)) {
+      params.append(
+        QUERY_PARAM_VERCEL_SET_BYPASS_COOKIE,
+        query.get(QUERY_PARAM_VERCEL_SET_BYPASS_COOKIE) as string
+      );
+    }
+    return params;
+  };
+  /**
+   * Get headers that should be passed along to subsequent requests
+   * @param {IncomingHttpHeaders} headers Incoming HTTP Headers
+   * @returns Object of approved headers
+   */
+  protected getHeadersForPropagation = (headers: Headers): Headers => {
+    // Filter and normalize headers
+    const filteredHeaders = EDITING_PASS_THROUGH_HEADERS.reduce((acc, header) => {
+      const value = headers.get(header);
+      if (value) {
+        acc.append(header, Array.isArray(value) ? value.join(', ') : value);
+      }
+      return acc;
+    }, new Headers());
+    return filteredHeaders;
+  };
+}