create-sitecore-jss 22.2.0-canary.81 → 22.2.0-canary.83

package/dist/templates/node-xmcloud-proxy/README.md

@@ -1,36 +0,0 @@
-# Node XM Cloud Proxy
-
-> Sitecore JSS Proxy for XM Cloud is considered experimental.
-
-[Documentation](<TODO>)
-
-This is a sample setup showing one of how you can configure XM Cloud rendering server.
-
-## Pre-requisites
-
-1. SPA sample supports XM Cloud out of the box.
-
-1. Build your SPA app bundle with `jss build`. The build output should be placed in the `dist` folder.
-
-## Setup
-
-Open `config.js` and specify your application settings.
-
-### Environment Variables
-
-The following environment variables can be set to configure the Proxy sample instead of modifying `config.js`. You can use the `.env` file located in the root of the app or set these directly in the environment (for example, in containers).
-
-| Parameter                              | Description                                                                                                                                |
-| -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
-| `PROXY_BUNDLE_PATH`                        | Path to the JSS SPA app's `server.bundle.js`. Default can be seen in [config.js](./config.js) file.                                                                                                                    |
-| `PROXY_PORT`                              | Optional. Port which will be used when start sample. Default can be seen in [config.js](./config.js) file.                                                             |
-| `DEBUG`                  | Optional. Debug level for the proxy. Set the DEBUG environment variable to 'sitecore-jss:*,proxy*,http-proxy-middleware*' to see all logs.                                                                                                                  |
-
-## Build & run
-
-1. Run `npm install`
-
-1. Run `npm run start`
-
-You should be able to see the following message:
-`server listening on port 3000!`.

package/dist/templates/node-xmcloud-proxy/gitignore

@@ -1,33 +0,0 @@
-# See http://help.github.com/ignore-files/ for more about ignoring files.
-
-# compiled output
-/dist
-
-# dependencies
-/node_modules
-
-# local env files
-.env.local
-.env.*.local
-
-# IDE - VSCode
-.vscode/*
-!.vscode/settings.json
-!.vscode/tasks.json
-!.vscode/launch.json
-!.vscode/extensions.json
-
-# misc
-/connect.lock
-/libpeerconnection.log
-npm-debug.log
-testem.log
-/typings
-
-# System Files
-.DS_Store
-Thumbs.db
-
-# deploy platforms
-.vercel
-.netlify

package/dist/templates/node-xmcloud-proxy/package.json

@@ -1,26 +0,0 @@
-{
-  "name": "node-xmcloud-sample",
-  "version": "22.2.0-canary",
-  "description": "Node XM Cloud Proxy sample for running XM Cloud JSS SPA apps",
-  "author": {
-    "name": "Sitecore Corporation",
-    "url": "https://jss.sitecore.com"
-  },
-  "scripts": {
-    "start": "ts-node ./src/index.ts"
-  },
-  "dependencies": {
-    "@sitecore-jss/sitecore-jss-proxy": "~22.2.0-canary",
-    "compression": "^1.7.4",
-    "express": "^4.18.2",
-    "dotenv": "^16.0.3",
-    "http-proxy-middleware": "^3.0.0"
-  },
-  "devDependencies": {
-    "@sitecore-jss/sitecore-jss": "~22.2.0-canary",
-    "@types/compression": "^1.7.2",
-    "@types/express": "^4.17.17",
-    "ts-node": "^10.9.1",
-    "typescript": "~4.9.5"
-  }
-}

package/dist/templates/node-xmcloud-proxy/src/config.ts

@@ -1,25 +0,0 @@
-import { Config, ServerBundle } from './types';
-
-/**
- * The server.bundle.js file from your pre-built SPA app.
- */
-const bundlePath = process.env.PROXY_BUNDLE_PATH || '../dist/server.bundle';
-
-let serverBundle: ServerBundle;
-
-try {
-  serverBundle = require(bundlePath);
-} catch (error) {
-  throw new Error(`ERROR: The server.bundle.js error. ${error}`);
-}
-
-export const config: Config = {
-  /**
-   * The require'd server.bundle.js file from your pre-built SPA app.
-   */
-  serverBundle,
-  /**
-   * Port which will be used when start the proxy
-   */
-  port: process.env.PROXY_PORT || 3000,
-};

package/dist/templates/node-xmcloud-proxy/src/index.ts

@@ -1,210 +0,0 @@
-import 'dotenv/config';
-import express, { Response } from 'express';
-import compression from 'compression';
-import { createProxyMiddleware } from 'http-proxy-middleware';
-import { debug } from '@sitecore-jss/sitecore-jss';
-import { editingRouter } from '@sitecore-jss/sitecore-jss-proxy';
-import { healthCheck } from '@sitecore-jss/sitecore-jss-proxy';
-import { config } from './config';
-
-const server = express();
-
-const {
-  renderView,
-  parseRouteUrl,
-  dictionaryServiceFactory,
-  layoutServiceFactory,
-} = config.serverBundle;
-
-/**
- * Required server bundle properties
- */
-const requiredProperties = [
-  'renderView',
-  'parseRouteUrl',
-  'clientFactory',
-  'getClientFactoryConfig',
-  'defaultLanguage',
-  'layoutServiceFactory',
-  'dictionaryServiceFactory',
-  'components',
-  'metadata',
-];
-
-const missingProperties = requiredProperties.filter((property) => !config.serverBundle[property]);
-
-if (missingProperties.length > 0) {
-  throw new Error(
-    `ERROR: The serverBundle should export the following properties: ${missingProperties.join(
-      ', '
-    )}. Please check your server bundle.`
-  );
-}
-
-const layoutService = layoutServiceFactory.create();
-
-const dictionaryService = dictionaryServiceFactory.create();
-
-const clientFactoryConfig = config.serverBundle.getClientFactoryConfig();
-
-/**
- * GraphQL endpoint resolution to meet the requirements of the http-proxy-middleware
- */
-const graphQLEndpoint = (() => {
-  try {
-    const graphQLEndpoint = new URL(clientFactoryConfig.endpoint);
-    // Browser request path to the proxy. Includes only the pathname.
-    const pathname = graphQLEndpoint.pathname;
-    // Target URL for the proxy. Can't include the query string.
-    const target = `${graphQLEndpoint.protocol}//${graphQLEndpoint.hostname}${pathname}`;
-
-    return {
-      target,
-      path: pathname,
-    };
-  } catch (error) {
-    throw new Error(
-      `ERROR: The serverBundle should export a getClientFactoryConfig function with valid GraphQL endpoint URL returned, current value is ${clientFactoryConfig.endpoint}. ` +
-        'Please check your server bundle.'
-    );
-  }
-})();
-
-/**
- * Parse requested url in order to detect current route and language
- * @param {string} reqRoute requested route
- */
-const getRouteParams = (reqRoute: string) => {
-  const routeParams = parseRouteUrl(reqRoute);
-  let lang;
-  let route;
-
-  if (routeParams) {
-    route = routeParams.sitecoreRoute || '/';
-
-    if (!route.startsWith('/')) {
-      route = `/${route}`;
-    }
-
-    lang = routeParams.lang || '';
-  }
-
-  return { route, lang };
-};
-
-/**
- * Handle unexpected error
- * @param {Response} res server response
- * @param {Error} err error
- */
-const handleError = (res: Response, err: unknown) => {
-  debug.proxy('response error %o', err);
-
-  res.status(500).send('Internal Server Error');
-};
-
-// enable gzip compression for appropriate file types
-server.use(compression());
-
-// turn off x-powered-by http header
-server.settings['x-powered-by'] = false;
-
-// Serve static app assets from local /dist folder
-server.use(
-  '/dist',
-  express.static('dist', {
-    fallthrough: false, // force 404 for unknown assets under /dist
-  })
-);
-
-/**
- * Proxy browser GraphQL requests to the Sitecore GraphQL endpoint
- */
-server.use(
-  graphQLEndpoint.path,
-  createProxyMiddleware({
-    target: graphQLEndpoint.target,
-    changeOrigin: true,
-  })
-);
-
-/**
- * The health check endpoint
- */
-server.use(healthCheck());
-
-/**
- * Proxy editing requests through the editing router
- */
-server.use(
-  '/api/editing',
-  editingRouter({
-    config: {
-      components: config.serverBundle.components,
-      metadata: config.serverBundle.metadata,
-    },
-    render: {
-      clientFactory: config.serverBundle.clientFactory,
-      renderView,
-    },
-  })
-);
-
-server.use(async (req, res) => {
-  debug.proxy(`performing SSR for ${req.originalUrl}`);
-
-  try {
-    const { route, lang } = getRouteParams(req.originalUrl);
-
-    if (!route) {
-      debug.proxy('no route detected, returning 404');
-
-      res.sendStatus(404);
-
-      return;
-    }
-
-    // Language is required. In case it's not specified in the requested URL, fallback to the default language from the app configuration.
-    const layoutData = await layoutService.fetchLayoutData(
-      route,
-      lang || config.serverBundle.defaultLanguage
-    );
-
-    const viewBag = { dictionary: {} };
-
-    viewBag.dictionary = await dictionaryService.fetchDictionaryData(
-      layoutData.sitecore.context.language || config.serverBundle.defaultLanguage
-    );
-
-    renderView(
-      (err, result) => {
-        if (err) {
-          handleError(res, err);
-          return;
-        }
-
-        if (!result) {
-          debug.proxy('no result returned from renderView, returning 204');
-
-          res.status(204).send();
-          return;
-        }
-
-        const statusCode = layoutData.sitecore.route ? 200 : 404;
-
-        debug.proxy('sending response with status %s', statusCode);
-
-        res.status(statusCode).send(result.html);
-      },
-      route,
-      layoutData,
-      viewBag
-    );
-  } catch (err) {
-    handleError(res, err);
-  }
-});
-
-server.listen(config.port, () => {
-  console.log(`server listening on port ${config.port}!`);
-});

package/dist/templates/node-xmcloud-proxy/src/types.ts

@@ -1,27 +0,0 @@
-import {
-  GraphQLRequestClientFactory,
-  GraphQLRequestClientFactoryConfig,
-} from '@sitecore-jss/sitecore-jss';
-import { DictionaryService } from '@sitecore-jss/sitecore-jss/i18n';
-import { Metadata } from '@sitecore-jss/sitecore-jss/utils';
-import { LayoutService } from '@sitecore-jss/sitecore-jss/layout';
-import { AppRenderer, RouteUrlParser } from '@sitecore-jss/sitecore-jss-proxy';
-
-export interface ServerBundle {
-  [key: string]: unknown;
-  renderView: AppRenderer;
-  parseRouteUrl: RouteUrlParser;
-  clientFactory: GraphQLRequestClientFactory;
-  getClientFactoryConfig: () => GraphQLRequestClientFactoryConfig;
-  defaultLanguage: string;
-  layoutServiceFactory: { create: () => LayoutService };
-  dictionaryServiceFactory: { create: () => DictionaryService };
-  components: string[] | Map<string, unknown>;
-  metadata: Metadata;
-}
-
-export interface Config {
-  [key: string]: unknown;
-  port: string | number;
-  serverBundle: ServerBundle;
-}

package/dist/templates/node-xmcloud-proxy/tsconfig.json

@@ -1,22 +0,0 @@
-{
-  "compilerOptions": {
-    "newLine": "LF",
-    "emitDecoratorMetadata": true,
-    "experimentalDecorators": true,
-    "noFallthroughCasesInSwitch": true,
-    "rootDir": ".",
-    "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": true,
-    "strict": true,
-    "noImplicitAny": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "noImplicitReturns": true,
-    "strictFunctionTypes": false,
-    "downlevelIteration": true,
-    "moduleResolution": "node",
-    "isolatedModules": true,
-    "allowSyntheticDefaultImports": true
-  },
-  "exclude": ["node_modules", "dist"]
-}