@sit-onyx/storybook-utils 0.0.0

package/LICENSE.txt

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2023 Schwarz IT KG
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@sit-onyx/storybook-utils",
+  "description": "Storybook utilities for Vue",
+  "version": "0.0.0",
+  "type": "module",
+  "exports": {
+    ".": {
+      "default": "./src/index.ts"
+    }
+  },
+  "peerDependencies": {
+    "@storybook/client-api": ">= 7",
+    "@storybook/core-events": ">= 7",
+    "@storybook/preview-api": ">= 7",
+    "@storybook/theming": ">= 7",
+    "@storybook/vue3": ">= 7",
+    "storybook-dark-mode": ">= 3"
+  },
+  "dependencies": {
+    "deepmerge-ts": "^5.1.0"
+  },
+  "scripts": {
+    "type-check": "tsc --noEmit"
+  }
+}

package/src/actions.ts

@@ -0,0 +1,142 @@
+import { useArgs } from "@storybook/client-api";
+import type { ArgTypes, Meta } from "@storybook/vue3";
+import { deepmerge } from "deepmerge-ts";
+import type { DefineStorybookActionsAndVModelsOptions, ExtractVueEventNames } from ".";
+
+/**
+ * Utility to define Storybook meta for a given Vue component which will take care of defining argTypes for
+ * the given events as well as implementing v-model handlers.
+ * Should be preferred over manually defining argTypes for a *.stories.ts file.
+ *
+ * @example
+ * ```ts
+ * // Input.stories.ts
+ * import { defineStorybookActionsAndVModels } from '@sit-onyx/storybook-utils';
+ * import type { Meta } from '@storybook/vue3';
+ * import Input from './Input.vue';
+ *
+ * const meta: Meta<typeof Input> = {
+ *   title: 'components/Input',
+ *   ...defineStorybookActionsAndVModels({
+ *     component: Input,
+ *     events: ['update:modelValue', 'change'],
+ *   }),
+ * };
+ * ```
+ */
+export const defineStorybookActionsAndVModels = <T>(
+  options: DefineStorybookActionsAndVModelsOptions<T>,
+): Meta<T> => {
+  const defaultMeta = {
+    argTypes: {
+      ...defineActions(options.events),
+      ...{}, // this is needed to fix a type issue
+    },
+    decorators: [
+      (story, context) => {
+        // provide the `updateArgs` function so we can use it in the render() function below
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        const [_, updateArgs] = useArgs();
+        return story({ ...context, updateArgs });
+      },
+    ],
+    /**
+     * Define a custom render function will provide event handlers for all v-models
+     * so that the Storybook controls are updated live when the user interacts with the component
+     */
+    render: defineRenderFunctionForVModels(options),
+  } satisfies Meta<T>;
+
+  return deepmerge(options, defaultMeta);
+};
+
+/**
+ * Defines Storybook actions ("argTypes") for the given events.
+ * Reason for this wrapper function is that Storybook expects event names to be prefixed
+ * with "on", e.g. "onClick".
+ *
+ * However in Vue, the event names are plain like "click" instead of "onClick" because
+ * otherwise we would use it like "@on-click="..."" which is redundant.
+ *
+ * So this utility will remove the on[eventName] entry from the Storybook panel/table
+ * and register the correct eventName as action so it is logged in the "Actions" tab.
+ *
+ * @example defineActions(["click", "input"])
+ */
+export const defineActions = <T>(events: ExtractVueEventNames<T>[]): ArgTypes => {
+  return events.reduce<ArgTypes>((argTypes, eventName) => {
+    argTypes[`on${capitalizeFirstLetter(eventName)}`] = {
+      table: { disable: true },
+      action: eventName,
+    };
+
+    argTypes[eventName] = { control: false };
+    return argTypes;
+  }, {});
+};
+
+/**
+ * Defines a custom render function that will provide event handlers for all v-models
+ * so that the Storybook controls are updated live when the user interacts with the component
+ */
+const defineRenderFunctionForVModels = <T>(
+  options: Pick<DefineStorybookActionsAndVModelsOptions<T>, "component" | "events">,
+): Meta<T>["render"] => {
+  const componentName = options.component.__name;
+  const vModelEvents = options.events.filter((event) => event.startsWith("update:"));
+
+  // if the component does not have any v-models, we don't need to specify a custom render function
+  if (!vModelEvents.length || !componentName) return;
+
+  return (args, context) => {
+    /**
+     * Mapped event handlers, e.g. `["update:modelValue"]` will be changed to:
+     *
+     * @example
+     * ```ts
+     * const eventHandler = {
+     *    updateModelValue: (value) => updateArgs({ modelValue: value })
+     * }
+     * ```
+     */
+    const eventHandlers = vModelEvents.reduce<Record<string, () => void>>((handler, event) => {
+      const methodName = vModelEventToMethodName(event);
+      handler[methodName] = (value?: unknown) =>
+        context.updateArgs({ [event.replace("update:", "")]: value });
+      return handler;
+    }, {});
+
+    return {
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      components: { [componentName]: options.component } as Record<string, any>,
+      setup: () => ({ args, ...eventHandlers }),
+      /**
+       * Add v-model event handlers to source code
+       *
+       * @example
+       * ```html
+       * <MyComponent v-bind="args" @update:modelValue="updateModelValue" />
+       * ```
+       */
+      template: `<${componentName} v-bind="args" ${vModelEvents
+        .map((event) => `@${event}="${vModelEventToMethodName(event)}"`)
+        .join(" ")} />`,
+    };
+  };
+};
+
+/** Capitalizes the first letter of the given string */
+const capitalizeFirstLetter = (value: string) => {
+  return value.charAt(0).toUpperCase() + value.slice(1);
+};
+
+/**
+ * Converts a v-model event name to a corresponding method name.
+ * @example "update:modelValue" => "updateModelValue"
+ */
+const vModelEventToMethodName = (eventName: string) => {
+  const index = eventName.indexOf(":");
+  return `${eventName.substring(0, index)}${eventName[
+    index + 1
+  ].toUpperCase()}${eventName.substring(index + 2)}`;
+};

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from "./actions";
+export * from "./preview";
+export * from "./types";

package/src/preview.ts

@@ -0,0 +1,106 @@
+import { DOCS_RENDERED } from "@storybook/core-events";
+import { addons } from "@storybook/preview-api";
+import { themes, type ThemeVars } from "@storybook/theming";
+import { type Preview } from "@storybook/vue3";
+import { deepmerge } from "deepmerge-ts";
+import { DARK_MODE_EVENT_NAME } from "storybook-dark-mode";
+
+/**
+ * Creates a default Storybook preview configuration for 'Onyx' with the following features:
+ * - Improved controls (sorting and expanded controls so descriptions etc. are also shown in a single story)
+ * - Improved Vue-specific code highlighting (e.g. using `@` instead of `v-on:`)
+ * - Setup for dark mode (including docs page). Requires addon `storybook-dark-mode` to be enabled in .storybook/main.ts file
+ *
+ * @param overrides Custom preview / overrides, will be deep merged with the default preview.
+ *
+ * @example
+ * ```ts
+ * // .storybook/preview.ts
+ * const preview = {
+ *   // you need to destructure here because as of Storybook 7.6
+ *   // it can not statically analyze that the `preview` variable is an object
+ *   ...createPreview({
+ *     // custom preview / overrides
+ *     },
+ *   }),
+ * };
+ *
+ * export default preview;
+ * ```
+ */
+export const createPreview = <T extends Preview = Preview>(overrides?: T) => {
+  const defaultPreview = {
+    parameters: {
+      controls: {
+        matchers: {
+          color: /(background|color)$/i,
+          date: /Date$/i,
+        },
+        sort: "requiredFirst",
+        // needed to also show props/events descriptions etc. when opening a single story
+        expanded: true,
+      },
+      docs: {
+        // see: https://github.com/hipstersmoothie/storybook-dark-mode/issues/127#issuecomment-840701971
+        get theme(): ThemeVars {
+          // support setting the theme via query parameters, useful if docs are embedded via an iframe
+          const params = new URLSearchParams(window.location.search);
+          const themeParam = params.get("theme");
+
+          const isDark = themeParam
+            ? themeParam === "dark"
+            : parent.document.body.classList.contains("dark");
+          return isDark ? themes.dark : themes.light;
+        },
+        source: {
+          language: "html",
+          /**
+           * Use a custom transformer for the story source code to better fit to our
+           * Vue.js code because storybook per default does not render it exactly how
+           * we want it to look.
+           * @see https://storybook.js.org/docs/react/api/doc-block-source
+           */
+          transform: (sourceCode: string): string => {
+            return (
+              sourceCode
+                // replace event bindings with shortcut
+                .replaceAll("v-on:", "@")
+                // remove empty event handlers, e.g. @click="()=>({})" will be removed
+                .replaceAll(/ @.*['"]\(\)=>\({}\)['"]/g, "")
+                // remove empty v-binds, e.g. v-bind="{}" will be removed
+                .replaceAll(/ v-bind=['"]{}['"]/g, "")
+                // replace boolean shortcuts for true, e.g. disabled="true" will be changed to just disabled
+                .replaceAll(/:(.*)=['"]true['"]/g, "$1")
+            );
+          },
+        },
+      },
+      darkMode: {
+        stylePreview: true,
+        light: themes.light,
+        dark: themes.dark,
+      },
+      backgrounds: {
+        // backgrounds are not needed because we have configured the darkMode addon/toggle switch
+        disable: true,
+      },
+    },
+  } satisfies Preview;
+
+  const channel = addons.getChannel();
+
+  // our "workaround" above for dynamically setting the docs theme needs a page-reload after
+  // the theme has changed to take effect:
+  channel.once(DOCS_RENDERED, () => {
+    // the DARK_MODE_EVENT_NAME is emitted once after the docs have been rendered for the initial theme.
+    // We only want to reload the page on theme changes, that's why we use .once() to add the event listener
+    // only after the initial dark mode change event has been fired. Otherwise we would get an infinite loop.
+    channel.once(DARK_MODE_EVENT_NAME, () => {
+      channel.on(DARK_MODE_EVENT_NAME, () => {
+        window.location.reload();
+      });
+    });
+  });
+
+  return deepmerge<[T, typeof defaultPreview]>(overrides ?? ({} as T), defaultPreview);
+};

package/src/types.ts

@@ -0,0 +1,47 @@
+import type { ComponentPropsAndSlots, Meta } from "@storybook/vue3";
+
+/**
+ * Extracts all event names defined by e.g. `defineEmits()` from the given Vue component.
+ *
+ * @example
+ * ```ts
+ * import Input from "./Input.vue";
+ * type InputEvents = ExtractVueEventNames<typeof Input>; // e.g. "input" | "change"
+ * ```
+ */
+export type ExtractVueEventNames<VueComponent> = Extract<
+  // extract all props/events of the vue component that are functions
+  ExtractKeysByValueType<
+    // this generic type will extract ALL props and events from the given Vue component
+    ComponentPropsAndSlots<VueComponent>,
+    // emits are declared as functions, so we only take props/events that are functions and ignore the rest
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    ((...args: any) => any) | undefined
+  >,
+  // filter out potential function properties by just picking events that start with "on"
+  `on${string}`
+> extends `on${infer EventName}`
+  ? // until now the extracted event names still start with "on" but we want to have the plain event name
+    // so we will remove the "on" prefix and uncapitalized the first letter so e.g. "onClick" becomes "click"
+    Uncapitalize<EventName>
+  : never;
+
+/**
+ * Extracts only the keys from T whose value type satisfies U.
+ *
+ * @example
+ * ```ts
+ * type Test = ExtractKeysByValueType<{ a: boolean, b: number, c: boolean }, boolean>
+ * // result: "a" | "c"
+ * ```
+ */
+export type ExtractKeysByValueType<T, U> = { [P in keyof T]: T[P] extends U ? P : never }[keyof T] &
+  keyof T;
+
+/**
+ * Options for defining Storybook actions and v-models.
+ */
+export type DefineStorybookActionsAndVModelsOptions<T> = Meta<T> & {
+  component: NonNullable<T>;
+  events: ExtractVueEventNames<T>[];
+};

package/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "@vue/tsconfig/tsconfig.dom.json",
+  "include": ["src"],
+  "compilerOptions": {
+    "types": ["node"],
+    "rootDir": "./src",
+    "baseUrl": ".",
+    "lib": ["ES2021.String", "DOM"]
+  }
+}