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

package/dist/templates/angular/src/app/routing/routing.module.ts

@@ -9,7 +9,7 @@ import { JssModule } from '@sitecore-jss/sitecore-jss-angular';
 import { BrowserModule } from '@angular/platform-browser';
 import { NavigationComponent } from './navigation/navigation.component';
 import { TranslateModule } from '@ngx-translate/core';
-import { VisitorIdentificationComponent } from './visitor-identification/visitor-identification.component';
+import { ScriptsModule } from './scripts/scripts.module';
 
 export function jssRouteMatcher(url: UrlSegment[]): UrlMatchResult {
   // use the route builder to parse out language / server route
@@ -27,7 +27,7 @@ export function jssRouteMatcher(url: UrlSegment[]): UrlMatchResult {
 
   return {
     consumed: url,
-    posParams
+    posParams,
   };
 }
 
@@ -39,32 +39,25 @@ const routes: Routes = [
     matcher: jssRouteMatcher,
     component: LayoutComponent,
     resolve: {
-      jssState: jssRouteResolver
+      jssState: jssRouteResolver,
     },
     runGuardsAndResolvers: 'always',
-  }
+  },
 ];
 
 @NgModule({
   imports: [
-    RouterModule.forRoot(routes, { onSameUrlNavigation: 'reload', initialNavigation: 'enabledBlocking' }),
+    RouterModule.forRoot(routes, {
+      onSameUrlNavigation: 'reload',
+      initialNavigation: 'enabledBlocking',
+    }),
     JssModule,
     TranslateModule,
-    BrowserModule
-  ],
-  exports: [
-    RouterModule,
-    TranslateModule,
-  ],
-  declarations: [
-    NotFoundComponent,
-    ServerErrorComponent,
-    LayoutComponent,
-    NavigationComponent,
-    VisitorIdentificationComponent
+    BrowserModule,
+    ScriptsModule,
   ],
-  providers: [
-    JssRouteBuilderService,
-  ]
+  exports: [RouterModule, TranslateModule],
+  declarations: [NotFoundComponent, ServerErrorComponent, LayoutComponent, NavigationComponent],
+  providers: [JssRouteBuilderService],
 })
-export class RoutingModule { }
+export class RoutingModule {}

package/dist/templates/angular/src/app/routing/scripts/scripts.component.html

@@ -0,0 +1 @@
+<div></div>

package/dist/templates/angular/src/app/routing/scripts/scripts.component.ts

@@ -0,0 +1,7 @@
+import { Component } from '@angular/core';
+
+@Component({
+  selector: 'app-scripts',
+  templateUrl: './scripts.component.html',
+})
+export class ScriptsComponent {}

package/dist/templates/angular/src/app/routing/scripts/scripts.module.ts

@@ -0,0 +1,8 @@
+import { NgModule } from '@angular/core';
+import { ScriptsComponent } from './scripts.component';
+
+@NgModule({
+  exports: [ScriptsComponent],
+  declarations: [ScriptsComponent],
+})
+export class ScriptsModule {}

package/dist/templates/angular/src/graphql-fragment-types.ts

@@ -48,9 +48,6 @@ export default {
           {
             name: 'UnknownItem',
           },
-          {
-            name: 'StyleguideComponentParamsRenderingParameters',
-          },
           {
             name: 'C__StandardTemplate',
           },
@@ -60,95 +57,6 @@ export default {
           {
             name: 'RenderEngineType',
           },
-          {
-            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideTracking',
-          },
-          {
-            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideSitecoreContext',
-          },
-          {
-            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideSection',
-          },
-          {
-            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideRouteFields',
-          },
-          {
-            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideMultilingual',
-          },
-          {
-            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideLayoutTabsTab',
-          },
-          {
-            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideLayoutTabs',
-          },
-          {
-            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideLayoutReuse',
-          },
-          {
-            name:
-              '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideItemLinkItemTemplate',
-          },
-          {
-            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideFieldUsageText',
-          },
-          {
-            name:
-              '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideFieldUsageRichText',
-          },
-          {
-            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideFieldUsageNumber',
-          },
-          {
-            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideFieldUsageLink',
-          },
-          {
-            name:
-              '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideFieldUsageItemLink',
-          },
-          {
-            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideFieldUsageImage',
-          },
-          {
-            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideFieldUsageFile',
-          },
-          {
-            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideFieldUsageDate',
-          },
-          {
-            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideFieldUsageCustom',
-          },
-          {
-            name:
-              '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideFieldUsageContentList',
-          },
-          {
-            name:
-              '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideFieldUsageCheckbox',
-          },
-          {
-            name:
-              '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideExplanatoryComponent',
-          },
-          {
-            name:
-              '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideContentListItemTemplate',
-          },
-          {
-            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideComponentParams',
-          },
-          {
-            name:
-              '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideAngularLazyLoading',
-          },
-          {
-            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>GraphQLIntegratedDemo',
-          },
-          {
-            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>GraphQLConnectedDemo',
-          },
-          {
-            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>ExampleCustomRouteType',
-          },
           {
             name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>ContentBlock',
           },
@@ -194,9 +102,6 @@ export default {
         kind: 'INTERFACE',
         name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>AppRoute',
         possibleTypes: [
-          {
-            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>ExampleCustomRouteType',
-          },
           {
             name: 'C__<%- helper.getAppPrefix(appPrefix, appName, false) %>AppRoute',
           },

package/dist/templates/angular/tsconfig.json

@@ -24,8 +24,13 @@
     "lib": ["es2018", "dom", "esnext.asynciterable"],
     "paths": {
       "@angular/*": ["../node_modules/@angular/*"],
-      "rxjs": ["node_modules/rxjs", "../node_modules/rxjs"]
+      "rxjs": ["node_modules/rxjs", "../node_modules/rxjs"],
+      "lib/*": ["src/app/lib/*"],
     },
-    "baseUrl": "./"
+    "baseUrl": "./",
+    "esModuleInterop": true
+  },
+  "ts-node": {
+    "require": ["tsconfig-paths/register"]
   }
 }

package/dist/templates/angular-sxp/package.json

@@ -0,0 +1,12 @@
+{
+  "scripts": {
+    "start": "cross-env-shell JSS_MODE=disconnected \"npm-run-all --serial bootstrap --parallel start:angular start:proxy start:watch-components\"",
+    "start:proxy": "ts-node --project src/tsconfig.webpack-server.json scripts/disconnected-mode-proxy.ts",
+    "lint:yml": "ts-node ./scripts/lint-yml.ts",
+    "lint": "ng lint <%- appName %> --fix && npm run lint:yml",
+    "scaffold": "ng generate @sitecore-jss/sitecore-jss-angular-schematics:jss-component"
+  },
+  "devDependencies": {
+    "yaml-lint": "^1.2.4"
+  }
+}

package/dist/templates/angular-sxp/proxy.conf.js

@@ -0,0 +1,43 @@
+/*
+  When the app runs in disconnected mode, and Sitecore is not present, we need to give
+  the app copies of the Sitecore APIs it depends on (layout service, dictionary service, content service)
+  to talk to so that the app can run using the locally defined disconnected data.
+
+  When the app runs in connected mode, Sitecore is present and some of the requests should be
+  proxied to the Sitecore API
+
+  This is accomplished by spinning up a small Express server that mocks the APIs, and then
+  telling angular-cli to proxy requests to the API paths to this express instance.
+
+*/
+const constants = require('@sitecore-jss/sitecore-jss-angular/cjs').constants;
+const environment = require('./src/environments/environment.js').environment;
+
+const port = 3043;
+
+const PROXY_CONFIG =
+  process.env.JSS_MODE === constants.JSS_MODE.DISCONNECTED
+    ? [
+        {
+          context: ['/data', '/sitecore'],
+          target: `http://localhost:${port}`,
+          secure: false,
+        },
+      ]
+    : [
+        {
+          context: [
+            // API endpoints
+            '/sitecore',
+            // media items
+            '/-',
+            // visitor identification
+            '/layouts',
+          ],
+          target: environment.sitecoreApiHost,
+          secure: false,
+          changeOrigin: true,
+        },
+      ];
+
+module.exports = PROXY_CONFIG;

package/dist/templates/angular-sxp/scripts/config/plugins/disconnected.ts

@@ -0,0 +1,27 @@
+import { JssConfig } from 'lib/config';
+import { ConfigPlugin } from '..';
+import { constants } from '@sitecore-jss/sitecore-jss-angular/cjs';
+const chalk = require('chalk');
+
+/**
+ * This plugin will check if fetchwith graphgl is beeing used in disconnected mode and throw error if so
+ */
+class DisconnectedPlugin implements ConfigPlugin {
+  // should come before other plugins
+  order = 0;
+
+  async exec(config: JssConfig) {
+    const disconnected = process.env.JSS_MODE === constants.JSS_MODE.DISCONNECTED;
+    if (disconnected && process.env.FETCH_WITH === constants.FETCH_WITH.GRAPHQL) {
+      throw new Error(
+        chalk.red(
+          'GraphQL requests to Dictionary and Layout services are not supported in disconnected mode.'
+        )
+      );
+    }
+
+    return config;
+  }
+}
+
+export const disconnectedPlugin = new DisconnectedPlugin();

package/dist/templates/angular-sxp/src/app/components/app-components.shared.module.ts

@@ -0,0 +1,35 @@
+import { NgModule } from '@angular/core';
+import { CommonModule } from '@angular/common';
+import { FormsModule } from '@angular/forms';
+import { TranslateModule } from '@ngx-translate/core';
+import { RouterModule } from '@angular/router';
+import { StyleguideSpecimenComponent } from './shared/styleguide-specimen/styleguide-specimen.component';
+import { JssModule } from '@sitecore-jss/sitecore-jss-angular';
+
+/*
+  This module is imported by the generated app-components.module.ts.
+  You can use this module to provide shared Angular components that are not
+  JSS components, etc to the generated module.
+
+  Don't want code generation? See ./.gitignore for instructions to turn it off.
+*/
+@NgModule({
+  imports: [
+    CommonModule,
+    TranslateModule,
+    RouterModule,
+    JssModule,
+    FormsModule,
+  ],
+  exports: [
+    CommonModule,
+    TranslateModule,
+    RouterModule,
+    FormsModule,
+    StyleguideSpecimenComponent
+  ],
+  declarations: [
+    StyleguideSpecimenComponent
+  ],
+})
+export class AppComponentsSharedModule { }

package/dist/templates/{angular → angular-sxp}/src/app/jss-data-fetcher.service.ts

@@ -3,7 +3,9 @@ import { HttpClient, HttpErrorResponse } from '@angular/common/http';
 import { HttpResponse } from '@sitecore-jss/sitecore-jss-angular';
 import { Observable, lastValueFrom } from 'rxjs';
 
-@Injectable()
+@Injectable({
+  providedIn: 'root'
+})
 export class JssDataFetcherService {
   constructor(
     private readonly httpClient: HttpClient,

package/dist/templates/angular-sxp/src/app/routing/navigation/navigation.component.html

@@ -0,0 +1,23 @@
+<div
+  class="d-flex flex-column flex-md-row align-items-center p-3 px-md-4 mb-3 bg-white border-bottom"
+>
+  <h5 class="my-0 me-md-auto fw-normal">
+    <a routerLink="/" class="text-dark" class="logo"></a>
+  </h5>
+  <nav class="my-2 my-md-0 me-md-3">
+    <a
+      class="p-2 text-dark"
+      href="https://jss.sitecore.com"
+      target="_blank"
+      rel="noopener noreferrer"
+    >
+      {{ 'Documentation' | translate }}
+    </a>
+    <a routerLink="/styleguide" class="p-2 text-dark">
+      {{ 'Styleguide' | translate }}
+    </a>
+    <a routerLink="/graphql" class="p-2 text-dark">
+      {{ 'GraphQL' | translate }}
+    </a>
+  </nav>
+</div>

package/dist/templates/angular-sxp/src/app/routing/scripts/scripts.component.html

@@ -0,0 +1,3 @@
+<div>
+  <app-visitor-identification></app-visitor-identification>
+</div>

package/dist/templates/angular-sxp/src/app/routing/scripts/scripts.module.ts

@@ -0,0 +1,9 @@
+import { NgModule } from '@angular/core';
+import { ScriptsComponent } from './scripts.component';
+import { VisitorIdentificationComponent } from './visitor-identification/visitor-identification.component';
+
+@NgModule({
+  exports: [ScriptsComponent],
+  declarations: [ScriptsComponent, VisitorIdentificationComponent],
+})
+export class ScriptsModule {}

package/dist/templates/{angular/src/app/routing → angular-sxp/src/app/routing/scripts}/visitor-identification/visitor-identification.component.ts

@@ -1,6 +1,6 @@
 import { Component, OnInit, OnDestroy } from '@angular/core';
 import { Subscription } from 'rxjs';
-import { JssContextService } from '../../jss-context.service';
+import { JssContextService } from '../../../jss-context.service';
 
 let emittedVI = false;
 
@@ -13,7 +13,13 @@ let emittedVI = false;
  */
 @Component({
   selector: 'app-visitor-identification',
-  template: `<meta *ngIf="visitorIdentificationTimestamp" name="VIcurrentDateTime" [content]="visitorIdentificationTimestamp" />`,
+  template: `
+    <meta
+      *ngIf="visitorIdentificationTimestamp"
+      name="VIcurrentDateTime"
+      [content]="visitorIdentificationTimestamp"
+    />
+  `,
 })
 export class VisitorIdentificationComponent implements OnInit, OnDestroy {
   visitorIdentificationTimestamp: number;
@@ -21,7 +27,7 @@ export class VisitorIdentificationComponent implements OnInit, OnDestroy {
   private contextSubscription: Subscription;
 
   // inject the JssContextService, which maintains the current Sitecore Context
-  constructor(private jssContext: JssContextService) { }
+  constructor(private jssContext: JssContextService) {}
 
   ngOnInit() {
     this.contextSubscription = this.jssContext.state.subscribe((state) => {

package/dist/templates/angular-sxp/src/graphql-fragment-types.ts

@@ -0,0 +1,219 @@
+/* eslint-disable */
+export default {
+  __schema: {
+    types: [
+      {
+        kind: 'INTERFACE',
+        name: 'ItemField',
+        possibleTypes: [
+          {
+            name: 'RichTextField',
+          },
+          {
+            name: 'NumberField',
+          },
+          {
+            name: 'MultilistField',
+          },
+          {
+            name: 'LookupField',
+          },
+          {
+            name: 'LinkField',
+          },
+          {
+            name: 'TextField',
+          },
+          {
+            name: 'IntegerField',
+          },
+          {
+            name: 'ImageField',
+          },
+          {
+            name: 'DateField',
+          },
+          {
+            name: 'CheckboxField',
+          },
+          {
+            name: 'NameValueListField',
+          },
+        ],
+      },
+      {
+        kind: 'INTERFACE',
+        name: 'Item',
+        possibleTypes: [
+          {
+            name: 'UnknownItem',
+          },
+          {
+            name: 'StyleguideComponentParamsRenderingParameters',
+          },
+          {
+            name: 'C__StandardTemplate',
+          },
+          {
+            name: 'C__Route',
+          },
+          {
+            name: 'RenderEngineType',
+          },
+          {
+            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideTracking',
+          },
+          {
+            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideSitecoreContext',
+          },
+          {
+            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideSection',
+          },
+          {
+            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideRouteFields',
+          },
+          {
+            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideMultilingual',
+          },
+          {
+            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideLayoutTabsTab',
+          },
+          {
+            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideLayoutTabs',
+          },
+          {
+            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideLayoutReuse',
+          },
+          {
+            name:
+              '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideItemLinkItemTemplate',
+          },
+          {
+            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideFieldUsageText',
+          },
+          {
+            name:
+              '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideFieldUsageRichText',
+          },
+          {
+            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideFieldUsageNumber',
+          },
+          {
+            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideFieldUsageLink',
+          },
+          {
+            name:
+              '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideFieldUsageItemLink',
+          },
+          {
+            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideFieldUsageImage',
+          },
+          {
+            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideFieldUsageFile',
+          },
+          {
+            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideFieldUsageDate',
+          },
+          {
+            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideFieldUsageCustom',
+          },
+          {
+            name:
+              '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideFieldUsageContentList',
+          },
+          {
+            name:
+              '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideFieldUsageCheckbox',
+          },
+          {
+            name:
+              '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideExplanatoryComponent',
+          },
+          {
+            name:
+              '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideContentListItemTemplate',
+          },
+          {
+            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideComponentParams',
+          },
+          {
+            name:
+              '<%- helper.getAppPrefix(appPrefix, appName, false) %>StyleguideAngularLazyLoading',
+          },
+          {
+            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>GraphQLIntegratedDemo',
+          },
+          {
+            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>GraphQLConnectedDemo',
+          },
+          {
+            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>ExampleCustomRouteType',
+          },
+          {
+            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>ContentBlock',
+          },
+          {
+            name: 'C__<%- helper.getAppPrefix(appPrefix, appName, false) %>AppRoute',
+          },
+          {
+            name: 'JsonRendering',
+          },
+          {
+            name: 'JavaScriptRendering',
+          },
+          {
+            name: 'JSSLayout',
+          },
+          {
+            name: 'App',
+          },
+        ],
+      },
+      {
+        kind: 'INTERFACE',
+        name: 'RenderingOptions',
+        possibleTypes: [
+          {
+            name: 'JsonRendering',
+          },
+          {
+            name: 'JavaScriptRendering',
+          },
+        ],
+      },
+      {
+        kind: 'INTERFACE',
+        name: 'Layout',
+        possibleTypes: [
+          {
+            name: 'JSSLayout',
+          },
+        ],
+      },
+      {
+        kind: 'INTERFACE',
+        name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>AppRoute',
+        possibleTypes: [
+          {
+            name: '<%- helper.getAppPrefix(appPrefix, appName, false) %>ExampleCustomRouteType',
+          },
+          {
+            name: 'C__<%- helper.getAppPrefix(appPrefix, appName, false) %>AppRoute',
+          },
+        ],
+      },
+      {
+        kind: 'INTERFACE',
+        name: 'Caching',
+        possibleTypes: [
+          {
+            name: 'JsonRendering',
+          },
+          {
+            name: 'JavaScriptRendering',
+          },
+        ],
+      },
+    ],
+  },
+};

package/dist/templates/angular-xmcloud/.env

@@ -0,0 +1,8 @@
+
+# ========== XM Cloud Proxy ===========
+
+# Your XM Cloud Proxy hostname is needed to build the app and execute the client-side requests against the proxy server.
+PROXY_HOST=http://localhost:3001
+
+# Your XM Cloud Proxy server path is needed to build the app. The build output will be copied to the proxy server path.
+PROXY_BUILD_PATH=<%- proxyAppDestination %>/dist

package/dist/templates/angular-xmcloud/package.json

@@ -0,0 +1,10 @@
+{
+  "config": {
+    "sitecoreDistPath": "/dist"
+  },
+  "scripts": {
+    "postbuild:server": "npm-run-all --serial prepare:build prepare:proxy-build",
+    "prepare:build": "move-cli ./dist/main.js ./dist/server.bundle.js",
+    "prepare:proxy-build": "ts-node --project src/tsconfig.webpack-server.json ./scripts/proxy-build.ts"
+  }
+}