From e1f3531271093d26d51f14429e6d5894c3cb6e05 Mon Sep 17 00:00:00 2001
From: AndrewLeedham <AndrewLeedham@Outlook.com>
Date: Thu, 24 Sep 2020 23:07:52 +0100
Subject: [PATCH] feat: Add includeIndex option

---
 README.md                  |  1 +
 src/index.d.ts             |  1 +
 src/utils/usePreviewUrl.ts |  1 +
 utils/index.d.ts           |  2 ++
 utils/index.js             | 25 +++++++++++++++++++++----
 5 files changed, 26 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index d189b7da..c65ee1fa 100644
--- a/README.md
+++ b/README.md
@@ -60,6 +60,7 @@ module.exports = {
   port: 9000,
   openBrowser: true,
   paramType: 'search', // default is 'hash'
+  includeIndex: true, // default is false, explicitly includes 'index.html' in links.
   exampleCode: `
     <Button>
       Hello World!
diff --git a/src/index.d.ts b/src/index.d.ts
index 0d6afd57..4b1311a1 100644
--- a/src/index.d.ts
+++ b/src/index.d.ts
@@ -13,6 +13,7 @@ interface PlayroomConfig {
   baseUrl?: string;
   paramType: 'hash' | 'search';
   iframeSandbox?: string;
+  includeIndex?: boolean;
 }
 
 interface InternalPlayroomConfig extends PlayroomConfig {
diff --git a/src/utils/usePreviewUrl.ts b/src/utils/usePreviewUrl.ts
index 44499bfd..24674cf2 100644
--- a/src/utils/usePreviewUrl.ts
+++ b/src/utils/usePreviewUrl.ts
@@ -18,5 +18,6 @@ export default (theme: string) => {
     code,
     theme: isThemed ? theme : undefined,
     paramType: playroomConfig.paramType,
+    includeIndex: playroomConfig.includeIndex,
   });
 };
diff --git a/utils/index.d.ts b/utils/index.d.ts
index f4ca437c..3820477d 100644
--- a/utils/index.d.ts
+++ b/utils/index.d.ts
@@ -22,6 +22,7 @@ interface CreateUrlOptions {
   themes?: string[];
   widths?: number[];
   paramType?: ParamType;
+  includeIndex?: boolean;
 }
 
 export const createUrl: (options: CreateUrlOptions) => string;
@@ -31,6 +32,7 @@ interface CreatePreviewUrlOptions {
   code?: string;
   theme?: string;
   paramType?: ParamType;
+  includeIndex?: boolean;
 }
 
 export const createPreviewUrl: (options: CreatePreviewUrlOptions) => string;
diff --git a/utils/index.js b/utils/index.js
index 05c45fdb..a590fd3c 100644
--- a/utils/index.js
+++ b/utils/index.js
@@ -11,13 +11,22 @@ const compressParams = ({ code, themes, widths, theme }) => {
   return lzString.compressToEncodedURIComponent(data);
 };
 
-const createUrl = ({ baseUrl, code, themes, widths, paramType = 'hash' }) => {
+const createUrl = ({
+  baseUrl,
+  code,
+  themes,
+  widths,
+  paramType = 'hash',
+  includeIndex = false,
+}) => {
   let path = '';
 
   if (code || themes || widths) {
     const compressedData = compressParams({ code, themes, widths });
 
-    path = `${paramType === 'hash' ? '#' : ''}?code=${compressedData}`;
+    path = `${includeIndex ? '/index.html' : ''}${
+      paramType === 'hash' ? '#' : ''
+    }?code=${compressedData}`;
   }
 
   if (baseUrl) {
@@ -29,13 +38,21 @@ const createUrl = ({ baseUrl, code, themes, widths, paramType = 'hash' }) => {
   return path;
 };
 
-const createPreviewUrl = ({ baseUrl, code, theme, paramType = 'hash' }) => {
+const createPreviewUrl = ({
+  baseUrl,
+  code,
+  theme,
+  paramType = 'hash',
+  includeIndex = false,
+}) => {
   let path = '';
 
   if (code || theme) {
     const compressedData = compressParams({ code, theme });
 
-    path = `/preview${paramType === 'hash' ? '#' : ''}?code=${compressedData}`;
+    path = `/preview${includeIndex ? '/index.html' : ''}${
+      paramType === 'hash' ? '#' : ''
+    }?code=${compressedData}`;
   }
 
   if (baseUrl) {