@andersundsehr/storybook-typo3 0.1.16 → 0.1.18

package/README.md

@@ -73,21 +73,23 @@ const config: StorybookConfig = {
   framework: '@andersundsehr/storybook-typo3', // required
 
   stories: [
-    "../src/**/*.mdx",
-    '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)',
+    "../src/**/*.@(mdx|stories.@(mdx|js|jsx|mjs|ts|tsx))",
   ],
 
   core: {
     disableTelemetry: true,
   },
 
-  env: (envs) => ({
-    STORYBOOK_TYPO3_ENDPOINT: 'http://localhost/_storybook/', // env can be set here or in the .env file
-    ...envs, // envs given to storybook have precedence
-  }),
+  env: (envs) => {
+    return {
+      STORYBOOK_TYPO3_ENDPOINT: 'http://localhost/_storybook/',
+      STORYBOOK_TYPO3_WATCH_ONLY_STORIES: '0', // set to '1' If you already use vite in your TYPO3 with HMR
+      // do not set your api key here! https://www.deployhq.com/blog/protecting-your-api-keys-a-quick-guide
+      ...envs, // envs given to storybook have precedence
+    };
+  },
 };
 export default config;
-
 ```
 
 ## Usage: How to use the extension? (Examples, screenshots, typical use cases)

package/dist/functions/fetchRenderAction.js

@@ -1,6 +1,22 @@
 import { url } from '@andersundsehr/storybook-typo3';
 import { fetchWithUserRetry } from './fetchWithUserRetry';
 import { error } from './error';
+let iframeContextId = 'sb-iframe-id-' + Math.random().toString(36).substring(2, 15);
+/**
+ * the IframeContextId is used to cache bust JS and CSS files,
+ * but on docs mode we want the same context ID as all the stories are rendered in the same iframe
+ */
+function getIframeContextId(viewMode) {
+    if (viewMode === 'story') {
+        // for story render we always create a new context ID
+        return (iframeContextId = 'sb-iframe-id-' + Math.random().toString(36).substring(2, 15));
+    }
+    // for docs we only want to create a new context ID if we were in story mode before
+    if (iframeContextId.startsWith('sb-iframe-id-')) {
+        return (iframeContextId = 'sb-docs-id-' + Math.random().toString(36).substring(2, 15));
+    }
+    return iframeContextId;
+}
 export async function fetchRenderAction(urlA, id, params, storyContext) {
     if (!storyContext.component) {
         error('No component found in story context. This function requires a Fluid component to render.', 4123764578913);
@@ -11,10 +27,10 @@ export async function fetchRenderAction(urlA, id, params, storyContext) {
         arguments: params,
         site: storyContext.globals?.site || 'default',
         siteLanguage: storyContext.globals?.language || 'default',
+        iframeContextId: getIframeContextId(storyContext.viewMode),
     };
     return await fetchWithUserRetry(url + '/_storybook/render', {
         method: 'POST',
         body: JSON.stringify(body),
     }, 'rendering component', 'text');
 }
-;

package/dist/functions/viteFinal.d.ts

@@ -0,0 +1,3 @@
+import { InlineConfig } from 'vite';
+import type { Options } from 'storybook/internal/types';
+export declare function viteFinal(config: InlineConfig, options: Options): Promise<InlineConfig>;

package/dist/functions/viteFinal.js

@@ -0,0 +1,55 @@
+import { glob } from 'node:fs/promises';
+import { basename } from 'node:path';
+async function isFeatureEnabled(name, options) {
+    const envs = await options.presets.apply('env');
+    return ['true', '1'].includes(envs[name] || process.env[name] || '0');
+}
+export async function viteFinal(config, options) {
+    if (await isFeatureEnabled('STORYBOOK_TYPO3_WATCH_ONLY_STORIES', options)) {
+        config = await watchOnlyStoriesConfig(config, options);
+    }
+    config = addAllowedHosts(config);
+    return config;
+}
+async function watchOnlyStoriesConfig(config, options) {
+    const colorYellow = '\x1b[33m';
+    const colorReset = '\x1b[0m';
+    console.log(colorYellow + '@andersundsehr/storybook-typo3:' + colorReset + ' STORYBOOK_TYPO3_WATCH_ONLY_STORIES enabled, only watching stories files');
+    const defaultGlobPattern = '/**/*.@(mdx|stories.@(mdx|js|jsx|mjs|ts|tsx))';
+    const storiesGlob = await options.presets.apply('stories');
+    const storiesFiles = [];
+    for (let globs of storiesGlob) {
+        if (typeof globs !== 'string') {
+            globs = globs.directory + (globs.files || defaultGlobPattern);
+        }
+        for await (const entry of glob(globs)) {
+            storiesFiles.push(entry);
+        }
+    }
+    const alwaysWatch = ['.env'];
+    config.server = config.server || {};
+    config.server.watch = config.server.watch || {};
+    config.server.watch.ignored = (file) => {
+        const filename = basename(file);
+        if (alwaysWatch.includes(filename)) {
+            return false; // always watch these files
+        }
+        if (!filename.includes('.')) {
+            return false; // ignore directories
+        }
+        if (!storiesFiles.includes(file)) {
+            return true;
+        }
+        return false;
+    };
+    return config;
+}
+function addAllowedHosts(config) {
+    var _a;
+    config.server = config.server || {};
+    if (process.env.IS_DDEV_PROJECT && config.server.allowedHosts !== true) {
+        (_a = config.server).allowedHosts ?? (_a.allowedHosts = []);
+        config.server.allowedHosts.push('.ddev.site');
+    }
+    return config;
+}

package/dist/preset.d.ts

@@ -1,16 +1,16 @@
 import type { PresetProperty } from 'storybook/internal/types';
-import type { ViteFinal } from '@storybook/builder-vite';
+import { viteFinal } from './functions/viteFinal.ts';
 export declare const addons: string[];
 /**
  * We want storybook to not use your local vite config.
  * As that is not really needed, and can cause issues or break storybook.
  */
-export declare const viteFinal: ViteFinal;
+export { viteFinal };
 export declare const core: PresetProperty<'core'>;
 export declare const previewAnnotations: PresetProperty<'previewAnnotations'>;
 export declare const tags: string[];
 /**
- * BUGFIX for chromium based browsers and windows
+ * BUGFIX for chromium based browsers on windows
  * @see https://github.com/talkjs/country-flag-emoji-polyfill?tab=readme-ov-file
  */
 export declare const managerHead = "<style>\n  body {\n    font-family: \"Twemoji Country Flags\", \"Nunito Sans\", -apple-system, \".SFNSText-Regular\", \"San Francisco\", BlinkMacSystemFont, \"Segoe UI\", \"Helvetica Neue\", Helvetica, Arial, sans-serif !important;\n  }\n  @font-face {\n    font-family: \"Twemoji Country Flags\";\n    unicode-range: U+1F1E6-1F1FF, U+1F3F4, U+E0062-E0063, U+E0065, U+E0067, U+E006C, U+E006E, U+E0073-E0074, U+E0077, U+E007F;\n    src: url('https://cdn.jsdelivr.net/npm/country-flag-emoji-polyfill@0.1/dist/TwemojiCountryFlags.woff2') format('woff2');\n    font-display: swap;\n  }\n</style>";

package/dist/preset.js

@@ -1,20 +1,16 @@
 import { dirname, join } from 'node:path';
 import { createRequire } from 'module';
+import { viteFinal } from "./functions/viteFinal.js";
 const require = createRequire(import.meta.url);
 function getAbsolutePath(value) {
     return dirname(require.resolve(join(value, 'package.json')));
 }
-export const addons = [
-    '@storybook/addon-docs',
-    '@storybook/addon-a11y',
-];
+export const addons = ['@storybook/addon-docs', '@storybook/addon-a11y'];
 /**
  * We want storybook to not use your local vite config.
  * As that is not really needed, and can cause issues or break storybook.
  */
-export const viteFinal = (config, options) => {
-    return config;
-};
+export { viteFinal };
 export const core = {
     builder: getAbsolutePath('@storybook/builder-vite'),
     renderer: getAbsolutePath('@storybook/server'),
@@ -28,7 +24,7 @@ export const previewAnnotations = async (entry = [], options) => {
 };
 export const tags = ['autodocs'];
 /**
- * BUGFIX for chromium based browsers and windows
+ * BUGFIX for chromium based browsers on windows
  * @see https://github.com/talkjs/country-flag-emoji-polyfill?tab=readme-ov-file
  */
 export const managerHead = `<style>

package/package.json

@@ -49,5 +49,5 @@
     "dist",
     "README.md"
   ],
-  "version": "0.1.16"
+  "version": "0.1.18"
 }