@andersundsehr/storybook-typo3 0.1.9 → 0.1.11

package/README.md

@@ -1,9 +1,9 @@
 # `EXT:storybook`
-<img alt="TYPO3" src="./Documentation/assets/TYPO3-Logo-rgb.svg" height="40" /> &nbsp;&nbsp;&nbsp;&nbsp;
-<img alt="Love" src="./Documentation/assets/heart.svg" height="40" />  &nbsp;&nbsp;&nbsp;&nbsp;
+<img alt="TYPO3" src="./Documentation/assets/TYPO3-Logo-rgb.svg" height="40" />
+<img alt="Love" src="./Documentation/assets/heart.svg" height="40" />
 <img alt="Storybook" src="./Documentation/assets/logo-storybook-default.svg" height="40" />  
 
-[Getting Started](https://docs.typo3.org/p/andersundsehr/storybook)
+[Getting Started](https://docs.typo3.org/permalink/andersundsehr-storybook:start) - [TYPO3 Slack](https://typo3.slack.com/archives/C098AQPGXLM)
 
 The TYPO3 extension `storybook` integrates Storybook into TYPO3 projects.  
 With the open-source tool Storybook, developers can develop and test UI components in isolation.  
@@ -46,7 +46,7 @@ After that you can run storybook with:
 npx http-server ./storybook-static
 ```
 
-> Also See [full installation steps](https://docs.typo3.org/p/andersundsehr/storybook/latest/en-us/Installation/Index.html) in the Getting Started Guide.
+> Also See [full installation steps](https://docs.typo3.org/permalink/andersundsehr-storybook:installation) in the Getting Started Guide.
 
 ## Configuration:
 
@@ -154,7 +154,7 @@ You can Select the site and the language in the top right corner of the Storyboo
 
 ## Documentation: Where to find more information? (Links, references, tutorials)
 
-https://docs.typo3.org/p/andersundsehr/storybook
+https://docs.typo3.org/permalink/andersundsehr-storybook:start
 
 - docs TODO link to hosted Storybook instance
 - docs TODO link to playwright report?
@@ -211,15 +211,3 @@ This extension is licensed under the [GPL-2.0-or-later](https://spdx.org/license
 
 > We are always looking for great people to join our team!
 > https://www.andersundsehr.com/karriere/
-
-
-# TODOs
-- [ ] add storybook:transform ViewHelper to code generation?
-- [ ] add storybook:toDateTime ViewHelper to code generation!
-
-- [ ] document transformers 
-- [ ] document .transformers.php
-- [ ] document how/when to use the transformers
-- [ ] document storybook:transform ViewHelper
-- [ ] document storybook:toDateTime ViewHelper
-- [ ] document that enums and dates are automatically handled by the extension

package/dist/entry-preview-docs.d.ts

@@ -1,6 +1,6 @@
 import { SourceType } from 'storybook/internal/docs-tools';
 import { type FluidRenderer } from '@andersundsehr/storybook-typo3';
-import { DecoratorFunction } from 'storybook/internal/types';
+import { type DecoratorFunction } from 'storybook/internal/types';
 export declare const tags: string[];
 export declare const decorators: DecoratorFunction<FluidRenderer>[];
 export declare const parameters: {

package/dist/functions/fetchWithUserRetry.js

@@ -1,8 +1,35 @@
+/*
+We want to make it obvious for the user what he has to do.
+
+We have 2 different usecases:
+- background fetches (componentMeta & preview)
+- html Fetches
+
+most of the time the user has to do something in there IDE to fix the problem.
+So we want to show a message that tells the user what he has to do.
+
+In the case of a background fetch, we want to show the full error in the console.
+And give the user a alert with the error message and a retry button.
+
+In the case of a html fetch, we want to show the error as html response?
+- yes: because the user can see the error in the browser and can fix it
+- no: because storybook dose not understand that it is an error
+
+In any case we should get the error in json so we can handle it in the frontend as we like.
+Some times it can still be text/html so we need to handle that as well.
+ */
 export async function fetchWithUserRetry(url, options, message, result = 'json') {
     options = { ...options }; // Clone options to avoid mutating the original
     options.signal = options.signal || AbortSignal.timeout(5000);
     try {
         const response = await fetch(url, options);
+        if (!response.ok) {
+            // let responseBody = await response.text();
+            // if (responseBody) {
+            //   responseBody += '\n';
+            // }
+            // throw new Error(`${responseBody}HTTP ${response.status}\nURL: ${url}\nError while fetching ${message}`);
+        }
         if (result === 'text') {
             return await response.text();
         }
@@ -10,12 +37,14 @@ export async function fetchWithUserRetry(url, options, message, result = 'json')
     }
     catch (error) {
         console.error('Fetch failed:', { error });
-        const retry = confirm('Error while fetching ' + message + '. \n\n'
-            + 'fetch: ' + url + '\n'
-            + 'ERROR: ' + String(error) + '\n\n'
+        const retry = confirm(''
+            + 'ERROR: ' + String(error) + '\n\n\n'
+            + 'Error while fetching ' + message + '. \n\n'
+            + 'fetch: ' + url + '\n\n'
             + 'look at the console for more details.\n\n'
             + 'Do you want to retry?');
         if (retry) {
+            options.signal = undefined; // Reset the signal to avoid reusing the same AbortSignal
             return fetchWithUserRetry(url, options, message);
         }
         throw error; // Re-throw the error if the user does not want to retry

package/dist/preset.d.ts

@@ -1,5 +1,11 @@
 import type { PresetProperty } from 'storybook/internal/types';
+import type { ViteFinal } from '@storybook/builder-vite';
 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 declare const core: PresetProperty<'core'>;
 export declare const previewAnnotations: PresetProperty<'previewAnnotations'>;
 export declare const tags: string[];

package/dist/preset.js

@@ -8,6 +8,13 @@ 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 const core = {
     builder: getAbsolutePath('@storybook/builder-vite'),
     renderer: getAbsolutePath('@storybook/server'),

package/dist/types/types.d.ts

@@ -1,5 +1,5 @@
 import type { Args, StrictArgs } from '@storybook/server';
-import { AnnotatedStoryFn, CompatibleString, ComponentAnnotations, DecoratorFunction, LoaderFunction, ProjectAnnotations, StoryAnnotations, StorybookConfig as StorybookConfigBase, StoryContext as StoryContext$1, WebRenderer } from 'storybook/internal/types';
+import type { AnnotatedStoryFn, CompatibleString, ComponentAnnotations, DecoratorFunction, LoaderFunction, ProjectAnnotations, StoryAnnotations, StorybookConfig as StorybookConfigBase, StoryContext as StoryContext$1, WebRenderer } from 'storybook/internal/types';
 import type { BuilderOptions, StorybookConfigVite } from '@storybook/builder-vite';
 type FrameworkName = CompatibleString<'@andersundsehr/storybook-typo3'>;
 type BuilderName = CompatibleString<'@storybook/builder-vite'>;
@@ -54,4 +54,4 @@ type Decorator<TArgs = StrictArgs> = DecoratorFunction<FluidRenderer, TArgs>;
 type Loader<TArgs = StrictArgs> = LoaderFunction<FluidRenderer, TArgs>;
 type StoryContext<TArgs = StrictArgs> = StoryContext$1<FluidRenderer, TArgs>;
 type Preview = ProjectAnnotations<FluidRenderer>;
-export { Decorator, Loader, Meta, Preview, FluidRenderer, StoryContext, StoryFn, StoryObj };
+export type { Decorator, Loader, Meta, Preview, FluidRenderer, StoryContext, StoryFn, StoryObj };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@andersundsehr/storybook-typo3",
-  "description": "The one and only Storybook Renderer for TYPO3 Fluid",
+  "description": "The one and only Storybook Renderer for TYPO3 Fluid Components",
   "keywords": [
     "storybook",
     "TYPO3",
@@ -49,5 +49,5 @@
     "dist",
     "README.md"
   ],
-  "version": "0.1.9"
+  "version": "0.1.11"
 }