create-sitecore-jss 22.2.0-canary.1 → 22.2.0-canary.2

package/dist/templates/angular-xmcloud/scripts/config/plugins/xmcloud.ts

@@ -0,0 +1,23 @@
+import { JssConfig } from 'lib/config';
+import { ConfigPlugin } from '..';
+import { constantCase } from 'constant-case';
+
+/**
+ * This plugin will set XM Cloud related config props.
+ */
+class XMCloudPlugin implements ConfigPlugin {
+  // should come after other plugins (but before fallback)
+  order = 10;
+
+  async exec(config: JssConfig) {
+    const proxyBuildPath = process.env[`${constantCase('proxyBuildPath')}`]?.replace(/\/$/, '');
+    const proxyHost = process.env[`${constantCase('proxyHost')}`];
+
+    return Object.assign({}, config, {
+      proxyBuildPath,
+      proxyHost,
+    });
+  }
+}
+
+export const xmcloudPlugin = new XMCloudPlugin();

package/dist/templates/angular-xmcloud/scripts/proxy-build.ts

@@ -0,0 +1,15 @@
+import { execSync } from 'child_process';
+import { environment } from '../src/environments/environment';
+
+// Executed at the end of the build process (jss build) to move the build output to the proxy build path
+
+try {
+  console.log('Moving build output to proxy build path:', environment.proxyBuildPath);
+
+  execSync(`del-cli ${environment.proxyBuildPath} --force`, { stdio: 'inherit' });
+  execSync(`move-cli ./dist ${environment.proxyBuildPath}`, { stdio: 'inherit' });
+
+  console.log('Proxy build prepared successfully!');
+} catch (error) {
+  console.error('Error preparing proxy build:', error);
+}

package/dist/templates/angular-xmcloud/src/app/lib/config.ts

@@ -0,0 +1,15 @@
+/*
+ * Represents the type of config object available within the generated /environments/environment.js
+ */
+export interface JssConfig extends Record<string, string | boolean | undefined> {
+  production?: false;
+  sitecoreApiKey?: string;
+  sitecoreApiHost?: string;
+  sitecoreSiteName?: string;
+  defaultLanguage?: string;
+  graphQLEndpoint?: string;
+  graphQLEndpointPath?: string;
+  defaultServerRoute?: string;
+  proxyBuildPath?: string;
+  proxyHost?: string;
+}

package/dist/templates/angular-xmcloud/src/app/lib/graphql-client-factory.ts

@@ -0,0 +1,44 @@
+import {
+  GraphQLRequestClientFactoryConfig,
+  GraphQLRequestClient,
+} from '@sitecore-jss/sitecore-jss-angular';
+import { environment as env } from '../../environments/environment';
+
+// The GraphQLRequestClientFactory serves as the central hub for executing GraphQL requests within the application
+
+/**
+ * Creates a new GraphQLRequestClientFactory instance
+ * @returns GraphQLRequestClientFactory instance
+ */
+export const createGraphQLClientFactory = () => {
+  let clientConfig: GraphQLRequestClientFactoryConfig;
+
+  // If we are in a production environment we are going to use Node XM Cloud proxy
+  if (env.production === 'true') {
+    if (env.proxyHost && env.sitecoreApiKey && env.graphQLEndpoint) {
+      // Server side requests should go directly to the Sitecore, browser requests should go through the proxy.
+      clientConfig = {
+        endpoint:
+          typeof window === 'undefined'
+            ? env.graphQLEndpoint
+            : `${env.proxyHost}${env.graphQLEndpointPath}`,
+        apiKey: env.sitecoreApiKey,
+      };
+    } else {
+      throw new Error('Please configure your proxyHost, sitecoreApiKey, graphQLEndpoint.');
+    }
+  } else {
+    if (env.graphQLEndpoint && env.sitecoreApiKey) {
+      clientConfig = {
+        endpoint: env.graphQLEndpoint,
+        apiKey: env.sitecoreApiKey,
+      };
+    } else {
+      throw new Error('Please configure your graphQLEndpoint and sitecoreApiKey.');
+    }
+  }
+
+  return GraphQLRequestClient.createClientFactory(clientConfig);
+};
+
+export const clientFactory = createGraphQLClientFactory();

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

@@ -0,0 +1,8 @@
+# Your proxy port (default: 3001)
+PROXY_PORT=
+
+# Your proxy server bundle path
+PROXY_BUNDLE_PATH=
+
+# Set the DEBUG environment variable to 'sitecore-jss:*,sitecore-jss:proxy,http-proxy-middleware*' to see all logs:
+#DEBUG=sitecore-jss:*,http-proxy-middleware*

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

@@ -0,0 +1,36 @@
+# 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 3001!`.

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

@@ -0,0 +1,25 @@
+{
+  "name": "node-xmcloud-sample",
+  "version": "22.1.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": {
+    "compression": "^1.7.4",
+    "express": "^4.18.2",
+    "dotenv": "^16.0.3",
+    "http-proxy-middleware": "^3.0.0"
+  },
+  "devDependencies": {
+    "@sitecore-jss/sitecore-jss": "~22.1.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

@@ -0,0 +1,19 @@
+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`;
+
+const serverBundle: ServerBundle = require(bundlePath);
+
+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 || 3001,
+};

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

@@ -0,0 +1,161 @@
+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 { config } from './config';
+
+const server = express();
+
+const {
+  renderView,
+  parseRouteUrl,
+  dictionaryServiceFactory,
+  layoutServiceFactory,
+} = config.serverBundle;
+
+/**
+ * Required server bundle properties
+ */
+const requiredProperties = [
+  'renderView',
+  'parseRouteUrl',
+  'clientFactory',
+  'siteName',
+  'defaultLanguage',
+  'layoutServiceFactory',
+  'dictionaryServiceFactory',
+  'graphQLEndpointPath',
+  'graphQLEndpoint',
+];
+
+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();
+
+/**
+ * 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(
+  config.serverBundle.graphQLEndpointPath,
+  createProxyMiddleware({
+    target: config.serverBundle.graphQLEndpoint,
+    changeOrigin: true,
+  })
+);
+
+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

@@ -0,0 +1,59 @@
+import { GraphQLRequestClientFactory } from '@sitecore-jss/sitecore-jss';
+import { DictionaryService } from '@sitecore-jss/sitecore-jss/i18n';
+import { LayoutService, LayoutServiceData } from '@sitecore-jss/sitecore-jss/layout';
+
+interface ServerResponse {
+  /**
+   * The rendered HTML to return to the client
+   */
+  html: string;
+  /**
+   * Set the HTTP status code. If not set, the status code returned from Layout Service is returned.
+   */
+  status?: number;
+  /**
+   * Sets a redirect URL, causing the reply to send a HTTP redirect instead of the HTML content.
+   * Note: when using this you must set the status code to 301 or 302.
+   */
+  redirect?: string;
+}
+
+declare type AppRenderer = (
+  callback: (error: Error | null, result: ServerResponse | null) => void,
+  path: string,
+  /**
+   * Data returned by Layout Service. If the route does not exist, null.
+   */
+  layoutData: LayoutServiceData,
+  viewBag: {
+    [key: string]: unknown;
+    dictionary: { [key: string]: string };
+  }
+) => void;
+
+declare type RouteUrlParser = (
+  url: string
+) => {
+  sitecoreRoute?: string;
+  lang?: string;
+  qsParams?: string;
+};
+
+export interface ServerBundle {
+  [key: string]: unknown;
+  renderView: AppRenderer;
+  parseRouteUrl: RouteUrlParser;
+  clientFactory: GraphQLRequestClientFactory;
+  siteName: string;
+  defaultLanguage: string;
+  layoutServiceFactory: { create: () => LayoutService };
+  dictionaryServiceFactory: { create: () => DictionaryService };
+  graphQLEndpointPath: string;
+  graphQLEndpoint: string;
+}
+
+export interface Config {
+  [key: string]: unknown;
+  port: string | number;
+  serverBundle: ServerBundle;
+}

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

@@ -0,0 +1,22 @@
+{
+  "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"]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-sitecore-jss",
-  "version": "22.2.0-canary.1",
+  "version": "22.2.0-canary.2",
   "description": "Sitecore JSS initializer",
   "bin": "./dist/index.js",
   "scripts": {
@@ -63,5 +63,5 @@
     "ts-node": "^10.9.1",
     "typescript": "~4.9.5"
   },
-  "gitHead": "7dd64ce5a019e4579596beae31315db262a4700f"
+  "gitHead": "ba1b71ef1209c0e3bdd3557d315a0e2a46ba4580"
 }