release: version 1.0.3

apps/xillio-transcreate/.gitignore

@@ -3,10 +3,11 @@
 
 # testing
 /coverage
+/storybook-static
 
 # production
 /dist
-!/types/dist
+.env
 
 # misc
 .DS_Store

apps/xillio-transcreate/.storybook/main.ts

@@ -11,17 +11,22 @@ function getAbsolutePath(value: string): any {
 }
 const config: StorybookConfig = {
     stories: ["../src/**/*.mdx", "../src/**/*.stories.@(js|jsx|mjs|ts|tsx)"],
+
     addons: [
         getAbsolutePath("@storybook/addon-links"),
         getAbsolutePath("@storybook/addon-essentials"),
         getAbsolutePath("@storybook/addon-interactions"),
     ],
+
     framework: {
         name: getAbsolutePath("@storybook/react-vite"),
         options: {},
     },
-    docs: {
-        autodocs: "tag",
+
+    docs: {},
+
+    typescript: {
+        reactDocgen: "react-docgen-typescript",
     },
 };
 export default config;

apps/xillio-transcreate/.storybook/preview.tsx

@@ -0,0 +1,39 @@
+import React from "react";
+
+import type { Preview } from "@storybook/react";
+
+import { Box, GlobalStyles } from "@contentful/f36-components";
+import tokens from "@contentful/f36-tokens";
+import { css } from "emotion";
+
+const preview: Preview = {
+    parameters: {
+        controls: {
+            matchers: {
+                color: /(background|color)$/i,
+                date: /Date$/,
+            },
+            include: [],
+        },
+    },
+
+    decorators: [
+        (Story) => (
+            <>
+                <GlobalStyles />
+                <Box
+                    padding="spacingL"
+                    className={css({
+                        backgroundColor: tokens.gray100,
+                        position: "fixed",
+                        inset: 0,
+                    })}
+                >
+                    <Story />
+                </Box>
+            </>
+        ),
+    ],
+};
+
+export default preview;

apps/xillio-transcreate/README.md

@@ -2,7 +2,7 @@
 
 The Xillio Transcreate Contentful App brings the power of professional translation services directly into the heart of your Contentful workflow. Translate your content efficiently and seamlessly, ensuring that your multilingual projects are delivered with quality and consistency.
 
-For full information about the app, see the Xillio Transcreate documentation [here](https://docs.xillio.com/transcreate)
+For full information about the app, see the Xillio Transcreate documentation [here](https://docs.xill.io/transcreate)
 
 ## Available Scripts
 
@@ -38,6 +38,24 @@ the upload command to your CI pipeline.
 
 For this command to work, the following environment variables must be set:
 
-- `CONTENTFUL_ORG_ID` - The ID of your organization
-- `CONTENTFUL_APP_DEF_ID` - The ID of the app to which to add the bundle
-- `CONTENTFUL_ACCESS_TOKEN` - A personal [access token](https://www.contentful.com/developers/docs/references/content-management-api/#/reference/personal-access-tokens)
+-   `CONTENTFUL_ORG_ID` - The ID of your organization
+-   `CONTENTFUL_APP_DEF_ID` - The ID of the app to which to add the bundle
+-   `CONTENTFUL_ACCESS_TOKEN` - A personal [access token](https://www.contentful.com/developers/docs/references/content-management-api/#/reference/personal-access-tokens)
+
+#### `npm run storybook`
+
+This command starts the Storybook development server, allowing you to view and interact with your app's components in isolation. Storybook is a popular tool for developing UI components in isolation and documenting their behavior.
+
+#### `npm run test:storybook`
+
+This command is used to run the Storybook test suite for the Xillio Transcreate app.
+
+Before running the tests, make sure to run `npm run storybook` and have an active Storybook instance running on port 6006.
+
+#### `npm run test`
+
+This command is used to run the tests for the Xillio Transcreate app. 
+
+It can be ran locally, but is intented to be used on a CI server to automate the testing process. 
+
+The command makes a static build of Storybook and runs these headless using Playwright.