@aussieljk/forkbook 0.0.0-stage → 0.0.1-2

package/dist/addon-docs/index.d.ts

@@ -0,0 +1,236 @@
+import { n as DocsContainerProps, o as TocParameters } from "../chunk-Ct9xd6IM.js";
+import React$1, { ComponentType } from "react";
+import { Args, DocsContextProps, DocsRenderFunction, ModuleExport, ModuleExports, PreparedStory, Renderer } from "@aussieljk/forkbook/internal/types";
+import { ThemeVars } from "@aussieljk/forkbook/theming";
+
+//#region .dts-emit/code/core/src/addon-docs/types.d.ts
+type StoryBlockParameters = {
+  /** Whether a story's play function runs when shown in docs page */autoplay?: boolean;
+  /**
+   * Set a minimum height (note for an iframe this is the actual height) when rendering a story in
+   * an iframe or inline. This overrides `parameters.docs.story.iframeHeight` for iframes.
+   */
+  height?: string; /** IFrame configuration */
+  iframeHeight?: string;
+  /**
+   * Whether the story is rendered inline (in the same browser frame as the other docs content) or
+   * in an iframe
+   */
+  inline?: boolean; /** Specifies the CSF file to which the story is associated */
+  meta: ModuleExports;
+  /**
+   * Specifies which story is rendered by the Story block. If no `of` is defined and the MDX file is
+   * attached, the primary (first) story will be rendered.
+   */
+  of: ModuleExport;
+};
+type StoriesBlockParameters = {
+  /**
+   * Custom filter function for determining which stories to include in a <Stories> block
+   */
+  filter?: <TRenderer extends Renderer = Renderer, TArgs = Args>(Story: PreparedStory<TRenderer>, Context: ReturnType<DocsContextProps['getStoryContext']>) => boolean;
+};
+type ControlsBlockParameters = {
+  /** Exclude specific properties from the Controls panel */exclude?: string[] | RegExp; /** Exclude only specific properties in the Controls panel */
+  include?: string[] | RegExp; /** Controls sorting order */
+  sort?: 'none' | 'alpha' | 'requiredFirst';
+};
+type ArgTypesBlockParameters = {
+  /** Exclude specific arg types from the args table */exclude?: string[] | RegExp; /** Exclude only specific arg types from the args table */
+  include?: string[] | RegExp;
+  /**
+   * Specifies which story to get the arg types from. If a CSF file exports is provided, it will use
+   * the primary (first) story in the file.
+   */
+  of: ModuleExport | ModuleExports;
+  /**
+   * Controls arg types order
+   *
+   * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-argtypes#sort
+   */
+  sort?: 'none' | 'alpha' | 'requiredFirst';
+};
+type CanvasBlockParameters = {
+  /**
+   * Provides any additional custom actions to show in the bottom right corner. These are simple
+   * buttons that do anything you specify in the onClick function.
+   */
+  additionalActions?: {
+    ariaLabel?: string;
+    className?: string;
+    disabled?: boolean;
+    onClick: () => void;
+    title: string | React.JSX.Element;
+  }[]; /** Provide HTML class(es) to the preview element, for custom styling. */
+  className?: string;
+  /**
+   * Specify how the canvas should layout the story.
+   *
+   * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-canvas#layout
+   */
+  layout?: 'centered' | 'fullscreen' | 'padded'; /** Specifies which story is rendered */
+  of: ModuleExport; /** Show story source code */
+  sourceState?: 'hidden' | 'shown' | 'none';
+  /**
+   * Story configuration
+   *
+   * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-canvas#story
+   */
+  story?: StoryBlockParameters; /** Disable story source code */
+  withSource?: 'open' | 'closed' | 'none'; /** Whether to render a toolbar containing tools to interact with the story. */
+  withToolbar?: 'open' | 'closed' | 'none';
+};
+type DescriptionBlockParameters = {
+  /** Component description */component?: string; /** Story description */
+  story?: string;
+};
+type SourceBlockParameters = {
+  /** The source code to be rendered. Will be inferred if not passed */code?: string; /** Whether to render the code in dark mode */
+  dark?: boolean; /** Determines if decorators are rendered in the source code snippet. */
+  excludeDecorators?: boolean;
+  /**
+   * The formatting used on source code. Both true and 'dedent' have the same effect of removing any
+   * extraneous indentation. Supports all valid prettier parser names.
+   */
+  format?: boolean | 'dedent' | string; /** Source code language */
+  language?: 'bash' | 'css' | 'graphql' | 'html' | 'json' | 'jsextra' | 'jsx' | 'md' | 'text' | 'tsx' | 'typescript' | 'yml';
+  /**
+   * Specifies which story is rendered by the Source block. If no of is defined and the MDX file is
+   * attached, the primary (first) story will be rendered.
+   */
+  of: ModuleExport; /** Source code transformations */
+  transform?: (code: string, storyContext: any) => string | Promise<string>;
+  /**
+   * Specifies how the source code is rendered.
+   *
+   * @default 'auto'
+   * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-source#type
+   */
+  type?: 'auto' | 'code' | 'dynamic';
+};
+interface DocsParameters {
+  /**
+   * Docs configuration
+   *
+   * @see https://storybook.js.org/docs/writing-docs
+   */
+  docs?: {
+    /**
+     * The subtitle displayed when shown in docs page
+     *
+     * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-argtypes
+     */
+    argTypes?: ArgTypesBlockParameters;
+    /**
+     * Canvas configuration when shown in docs page
+     *
+     * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-canvas
+     */
+    canvas?: Partial<CanvasBlockParameters>;
+    /**
+     * Show the Code panel by default. Set to `false` to hide it.
+     *
+     * @see https://storybook.js.org/docs/writing-docs/code-panel
+     */
+    codePanel?: boolean;
+    /**
+     * Controls block configuration
+     *
+     * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-controls
+     */
+    controls?: ControlsBlockParameters;
+    /**
+     * Customize the Docs Container
+     *
+     * @see https://storybook.js.org/docs/writing-docs/autodocs#customize-the-docs-container
+     */
+    container?: ComponentType<DocsContainerProps>;
+    /**
+     * Component/story description when shown in docs page
+     *
+     * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-description#writing-descriptions
+     */
+    description?: DescriptionBlockParameters; /** Remove the addon panel and disable the addon's behavior */
+    disable?: boolean;
+    /**
+     * Replace the default documentation template used by Forkbook with your own
+     *
+     * @see https://storybook.js.org/docs/writing-docs/autodocs#write-a-custom-template
+     */
+    page?: ComponentType;
+    /**
+     * Source code configuration when shown in docs page
+     *
+     * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-source
+     */
+    source?: Partial<SourceBlockParameters>;
+    /**
+     * Story block configuration
+     *
+     * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-story
+     */
+    story?: Partial<StoryBlockParameters>;
+    /**
+     * Stories block configuration
+     *
+     * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-stories
+     */
+    stories?: Partial<StoriesBlockParameters>;
+    /**
+     * The subtitle displayed when shown in docs page
+     *
+     * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-subtitle
+     */
+    subtitle?: string;
+    /**
+     * The BCP-47 language tag applied to Forkbook-rendered docs prose (descriptions, titles,
+     * ArgTypes description cells, free MDX prose).
+     *
+     * Forkbook's own chrome stays English regardless. Inherited project → meta (page-level) or
+     * project → meta → story (per-story prose).
+     *
+     * @default 'en'
+     */
+    lang?: string;
+    /**
+     * Override the default theme
+     *
+     * @see https://storybook.js.org/docs/writing-docs/autodocs#override-the-default-theme
+     */
+    theme?: ThemeVars;
+    /**
+     * The title displayed when shown in docs page
+     *
+     * @see https://storybook.js.org/docs/api/doc-blocks/doc-block-title
+     */
+    title?: string;
+    /**
+     * Configure the table of contents
+     *
+     * @see https://storybook.js.org/docs/writing-docs/autodocs#configure-the-table-of-contents
+     */
+    toc?: true | TocParameters;
+  };
+}
+interface DocsTypes {
+  parameters: DocsParameters;
+}
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/DocsRenderer.d.ts
+declare class DocsRenderer<TRenderer extends Renderer> {
+  render: DocsRenderFunction<TRenderer>;
+  unmount: (element: HTMLElement) => void;
+  constructor();
+}
+//#endregion
+//#region .dts-emit/code/core/src/addon-docs/index.d.ts
+declare module 'mdx/types' {
+  namespace JSX {
+    type Element = React$1.JSX.Element;
+    type ElementClass = React$1.JSX.ElementClass;
+    type IntrinsicElements = React$1.JSX.IntrinsicElements;
+  }
+}
+declare function _default(): import("@aussieljk/forkbook/internal/csf").PreviewAddon<DocsTypes>;
+//#endregion
+export { DocsRenderer, type DocsTypes, _default as default };

package/dist/addon-docs/index.js

@@ -0,0 +1,16 @@
+import {
+  DocsRenderer
+} from "../_browser-chunks/chunk-5I7E4GMO.js";
+import "../_browser-chunks/chunk-46Z7NGAS.js";
+import {
+  preview_exports
+} from "../_browser-chunks/chunk-RBCHTR7C.js";
+import "../_browser-chunks/chunk-IMSF75WX.js";
+
+// src/addon-docs/index.ts
+import { definePreviewAddon } from "@aussieljk/forkbook/internal/csf";
+var addon_docs_default = () => definePreviewAddon(preview_exports);
+export {
+  DocsRenderer,
+  addon_docs_default as default
+};

package/dist/addon-docs/manager.js

@@ -0,0 +1,90 @@
+import {
+  SnippetWarning,
+  Source
+} from "../_browser-chunks/chunk-KQ7CRO2B.js";
+import "../_browser-chunks/chunk-PFRNG3UC.js";
+import "../_browser-chunks/chunk-CNED6RYH.js";
+import "../_browser-chunks/chunk-IMSF75WX.js";
+
+// src/addon-docs/manager.tsx
+import { useEffect, useState } from "react";
+import {
+  AddonPanel
+} from "@aussieljk/forkbook/internal/components";
+import { addons, types, useChannel, useParameter } from "@aussieljk/forkbook/manager-api";
+import { useTheme } from "@aussieljk/forkbook/theming";
+import {
+  ADDON_ID,
+  PANEL_ID,
+  PARAM_KEY,
+  shouldWaitForServiceSnippet,
+  SNIPPET_RENDERED
+} from "@aussieljk/forkbook/internal/docs-tools";
+
+// storybook-css:/Users/ljk/p/repos/storybook/code/core/src/addon-docs/manager.module.css
+var id = "core/src/addon-docs/manager.module.css";
+if (typeof document < "u" && !document.querySelector(`style[data-sb-css="${id}"]`)) {
+  let style = document.createElement("style");
+  style.setAttribute("data-sb-css", id), style.textContent = ".sb-iSROvG-source{height:100%;position:relative;&>:first-child{height:100%;box-shadow:none;margin:0}}.sb-iSROvG-snippetWarning{position:absolute;top:8px;right:10px}", document.head.appendChild(style);
+}
+var manager_default = { source: "sb-iSROvG-source", snippetWarning: "sb-iSROvG-snippetWarning" };
+
+// src/addon-docs/manager.tsx
+import { jsx, jsxs } from "react/jsx-runtime";
+var CodePanel = ({
+  active,
+  lastEvent,
+  currentStoryId,
+  storyParameters,
+  storyPrepared
+}) => {
+  let lastEventMatchesCurrentStory = lastEvent?.id === currentStoryId, [codeSnippet, setSourceCode] = useState({
+    source: lastEventMatchesCurrentStory ? lastEvent?.source : void 0,
+    format: lastEventMatchesCurrentStory ? lastEvent?.format ?? void 0 : void 0,
+    warning: lastEventMatchesCurrentStory ? lastEvent?.warning : void 0
+  }), parameter = useParameter(PARAM_KEY, {
+    source: { code: "" },
+    theme: "dark"
+  });
+  useEffect(() => {
+    setSourceCode({
+      source: void 0,
+      format: void 0,
+      warning: void 0
+    });
+  }, [currentStoryId]), useChannel(
+    {
+      [SNIPPET_RENDERED]: ({ id: id2, source, format, warning: warning2 }) => {
+        id2 !== void 0 && id2 !== currentStoryId || setSourceCode({ source, format, warning: warning2 });
+      }
+    },
+    [currentStoryId]
+  );
+  let isDark = useTheme().base !== "light", awaitingServiceSnippet = shouldWaitForServiceSnippet(storyParameters, storyPrepared), code = parameter.source?.code || codeSnippet.source || (awaitingServiceSnippet ? "" : parameter.source?.originalSource), warning = parameter.source?.code ? void 0 : codeSnippet.warning;
+  return jsx(AddonPanel, { active: !!active, children: jsxs("div", { className: manager_default.source, children: [
+    jsx(Source, { ...parameter.source, code, format: codeSnippet.format, dark: isDark }),
+    jsx(SnippetWarning, { className: manager_default.snippetWarning, warning })
+  ] }) });
+};
+addons.register(ADDON_ID, (api) => {
+  addons.add(PANEL_ID, {
+    title: "Code",
+    type: types.PANEL,
+    paramKey: PARAM_KEY,
+    disabled: (parameters) => parameters?.docs?.codePanel === !1,
+    match: ({ viewMode }) => viewMode === "story",
+    render: ({ active }) => {
+      let channel = api.getChannel(), currentStory = api.getCurrentStoryData(), lastEvent = channel?.last(SNIPPET_RENDERED)?.[0];
+      return jsx(
+        CodePanel,
+        {
+          currentStoryId: currentStory?.id,
+          storyParameters: currentStory?.parameters,
+          storyPrepared: currentStory?.prepared,
+          lastEvent,
+          active
+        }
+      );
+    }
+  });
+});

package/dist/addon-docs/mdx-react-shim.d.ts

@@ -0,0 +1 @@
+export * from "@mdx-js/react";

package/dist/addon-docs/mdx-react-shim.js

@@ -0,0 +1,2 @@
+// src/addon-docs/mdx-react-shim.ts
+export * from "@mdx-js/react";