[Next.js][Multi-site] Dynamic site resolver

packages/sitecore-jss/src/site/index.ts

@@ -24,3 +24,5 @@ export {
   GraphQLErrorPagesService,
   GraphQLErrorPagesServiceConfig,
 } from './graphql-error-pages-service';
+
+export { SiteResolver, HostInfo } from './site-resolver';

packages/sitecore-jss/src/site/site-resolver.test.ts

@@ -0,0 +1,103 @@
+import { expect } from 'chai';
+import { HostInfo, SiteResolver } from './site-resolver';
+
+describe('SiteResolver', () => {
+  const hostInfo: HostInfo = {
+    hostName: 'foo.com',
+  };
+
+  const hostInfoWithLanguage: HostInfo = {
+    ...hostInfo,
+    language: 'en',
+  };
+
+  describe('resolve', () => {
+    describe('fallback site name', () => {
+      it('should return default when sites info is empty', () => {
+        const siteName = SiteResolver.resolve(hostInfo, []);
+
+        expect(siteName).to.equal('website');
+      });
+
+      it('should return default when there is no appropriate site info', () => {
+        const siteName = SiteResolver.resolve(hostInfo, [
+          { hostName: 'bar.com', language: '', name: 'bar' },
+          { hostName: 'var.com', language: '', name: 'var' },
+        ]);
+
+        expect(siteName).to.equal('website');
+      });
+
+      it('should return custom when sites info is empty', () => {
+        const siteName = SiteResolver.resolve(hostInfo, [], 'sample');
+
+        expect(siteName).to.equal('sample');
+      });
+
+      it('should return custom when there is no appropriate site info', () => {
+        const siteName = SiteResolver.resolve(
+          hostInfo,
+          [
+            { hostName: 'bar.com', language: '', name: 'bar' },
+            { hostName: 'var.com', language: '', name: 'var' },
+          ],
+          'sample'
+        );
+
+        expect(siteName).to.equal('sample');
+      });
+    });
+
+    it('should return site name when only hostname is provided', () => {
+      const siteName = SiteResolver.resolve(hostInfo, [
+        { hostName: 'bar.net', language: '', name: 'bar' },
+        { hostName: 'foo.com', language: '', name: 'foo' },
+        { hostName: 'var.com', language: '', name: 'var' },
+      ]);
+
+      expect(siteName).to.equal('foo');
+    });
+
+    it('should return site name when wildcard is provided', () => {
+      const siteName = SiteResolver.resolve(hostInfo, [
+        { hostName: 'bar.net', language: '', name: 'bar' },
+        { hostName: '*', language: '', name: 'wildcard' },
+        { hostName: 'foo.com', language: '', name: 'foo' },
+      ]);
+
+      expect(siteName).to.equal('wildcard');
+    });
+
+    it('should return site name when language is provided', () => {
+      const siteName = SiteResolver.resolve(hostInfoWithLanguage, [
+        { hostName: 'foo.com', language: 'ca', name: 'foo-ca' },
+        { hostName: 'var.com', language: 'da-DK', name: 'var' },
+        { hostName: 'bar.net', language: 'en', name: 'bar' },
+        { hostName: 'foo.com', language: 'en', name: 'foo-en' },
+      ]);
+
+      expect(siteName).to.equal('foo-en');
+    });
+
+    it('should return site name when language is omit', () => {
+      const siteName = SiteResolver.resolve(hostInfoWithLanguage, [
+        { hostName: 'var.com', language: 'da-DK', name: 'var' },
+        { hostName: 'bar.net', language: 'en', name: 'bar' },
+        { hostName: 'foo.com', language: '', name: 'foo' },
+        { hostName: 'foo.com', language: 'en', name: 'foo-en' },
+      ]);
+
+      expect(siteName).to.equal('foo');
+    });
+
+    it('should return site name when multi-value hostnames are provided', () => {
+      const siteName = SiteResolver.resolve(hostInfoWithLanguage, [
+        { hostName: 'bar.net', language: '', name: 'bar' },
+        { hostName: 'test.com|foo.net|foo.com', language: 'en', name: 'foo' },
+        { hostName: 'var.com', language: '', name: 'var' },
+      ]);
+
+      expect(siteName).to.equal('foo');
+    });
+  });
+});

packages/sitecore-jss/src/site/site-resolver.ts

@@ -0,0 +1,46 @@
+import { SiteInfo } from './graphql-siteinfo-service';
+
+/**
+ * Information about the current host
+ */
+export type HostInfo = {
+  hostName: string;
+  language?: string;
+};
+
+// Delimiters for multi-value hostnames
+const DELIMITERS = /\|/g;
+
+// Wildcard hostname
+const WILDCARD = '*';
+
+/**
+ * Determines site name based on the provided hostname
+ */
+export class SiteResolver {
+  /**
+   * Resolve siteName by hostName
+   * @param {HostInfo} hostInfo
+   * @param {SiteInfo[]} sitesInfo
+   * @param {string} [fallbackSiteName] siteName to be returned in case siteName is not found
+   * @returns {string} siteName
+   */
+  static resolve = (
+    hostInfo: HostInfo,
+    sitesInfo: SiteInfo[],
+    fallbackSiteName = 'website'
+  ): string => {
+    const siteInfo = sitesInfo.find((info) => {
+      const hostnames = info.hostName.split(DELIMITERS);
+
+      const languageMatches =
+        info.language === '' || !hostInfo.language || hostInfo.language === info.language;
+
+      return hostnames.some(
+        (value) => languageMatches && (hostInfo.hostName === value || value === WILDCARD)
+      );
+    });
+
+    return siteInfo?.name || fallbackSiteName;
+  };
+}