@aussieljk/forkbook 0.0.0-stage → 0.0.1-10

package/assets/react-native/metro-env.d.ts

@@ -0,0 +1,69 @@
+// Type definitions for Metro bundler runtime APIs.
+//
+// Based on Expo's approach: https://github.com/expo/expo/blob/main/packages/expo/types/metro-require.d.ts
+// Which is derived from: https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/webpack-env/index.d.ts
+//
+// Metro's require.context API intentionally matches webpack's API by design.
+// See: https://github.com/facebook/metro/pull/822
+//
+// HMR types based on Metro's Flow definitions:
+// See: https://github.com/facebook/metro/blob/main/packages/metro-runtime/src/polyfills/require.js.flow
+
+declare namespace __MetroModuleApi {
+  interface RequireContext {
+    /** Return the keys that can be resolved. */
+    keys(): string[];
+    (id: string): any;
+    <T>(id: string): T;
+    /** **Unimplemented:** Return the module identifier for a user request. */
+    resolve(id: string): string;
+    /** **Unimplemented:** Readable identifier for the context module. */
+    id: string;
+  }
+
+  interface RequireFunction {
+    /**
+     * Returns the exports from a dependency. The call is sync. No request to the server is fired.
+     * The compiler ensures that the dependency is available.
+     */
+    (path: string): any;
+    <T>(path: string): T;
+
+    /**
+     * Import all modules from a directory dynamically. This module dynamically updates
+     * when the files in a directory are added or removed.
+     *
+     * **Enabling:** This feature can be enabled by setting the `transformer.unstable_allowRequireContext`
+     * property to `true` in your Metro configuration.
+     *
+     * @param path File path pointing to the directory to require.
+     * @param recursive Should search for files recursively. Optional, default `true`.
+     * @param filter Filename filter pattern. Optional, default `.*` (any file).
+     * @param mode Mode for resolving dynamic dependencies. Defaults to `sync`.
+     */
+    context(
+      path: string,
+      recursive?: boolean,
+      filter?: RegExp,
+      mode?: 'sync' | 'eager' | 'weak' | 'lazy' | 'lazy-once'
+    ): RequireContext;
+  }
+
+  interface Hot {
+    /** Accept updates for this module. */
+    accept(callback?: () => void): void;
+    /** Register a dispose handler for cleanup before module replacement. */
+    dispose(callback?: () => void): void;
+  }
+}
+
+declare namespace NodeJS {
+  // eslint-disable-next-line @typescript-eslint/no-empty-object-type -- Intentional declaration merging to extend NodeJS.Require
+  interface Require extends __MetroModuleApi.RequireFunction {}
+  interface Module {
+    hot?: __MetroModuleApi.Hot;
+  }
+}
+
+// eslint-disable-next-line no-var -- ambient global declaration must merge with Node's `var module`
+declare var module: NodeJS.Module;

package/assets/server/addon.tsconfig.json

@@ -0,0 +1,6 @@
+{
+  "compilerOptions": {
+    "jsx": "react",
+    "jsxImportSource": "react"
+  }
+}

package/assets/server/base-preview-body.html

@@ -0,0 +1,116 @@
+<div class="fb-preparing-story fb-wrapper">
+  <div class="fb-loader"></div>
+</div>
+
+<div class="fb-preparing-docs fb-wrapper">
+  <div class="fb-previewBlock">
+    <div class="fb-previewBlock_header">
+      <div class="fb-previewBlock_icon"></div>
+      <div class="fb-previewBlock_icon"></div>
+      <div class="fb-previewBlock_icon"></div>
+      <div class="fb-previewBlock_icon"></div>
+    </div>
+    <div class="fb-previewBlock_body">
+      <div class="fb-loader"></div>
+    </div>
+  </div>
+  <table aria-hidden="true" class="fb-argstableBlock">
+    <thead class="fb-argstableBlock-head">
+      <tr>
+        <th><span>Name</span></th>
+        <th><span>Description</span></th>
+        <th><span>Default</span></th>
+        <th><span>Control </span></th>
+      </tr>
+    </thead>
+    <tbody class="fb-argstableBlock-body">
+      <tr>
+        <td><span>propertyName</span><span title="Required">*</span></td>
+        <td>
+          <div><span>This is a short description</span></div>
+          <div class="fb-argstableBlock-summary">
+            <div><span class="fb-argstableBlock-code">summary</span></div>
+          </div>
+        </td>
+        <td>
+          <div><span class="fb-argstableBlock-code">defaultValue</span></div>
+        </td>
+        <td><button>Set string</button></td>
+      </tr>
+      <tr>
+        <td><span>propertyName</span><span>*</span></td>
+        <td>
+          <div><span>This is a short description</span></div>
+          <div class="fb-argstableBlock-summary">
+            <div><span class="fb-argstableBlock-code">summary</span></div>
+          </div>
+        </td>
+        <td>
+          <div><span class="fb-argstableBlock-code">defaultValue</span></div>
+        </td>
+        <td><button>Set string</button></td>
+      </tr>
+      <tr>
+        <td><span>propertyName</span><span>*</span></td>
+        <td>
+          <div><span>This is a short description</span></div>
+          <div class="fb-argstableBlock-summary">
+            <div><span class="fb-argstableBlock-code">summary</span></div>
+          </div>
+        </td>
+        <td>
+          <div><span class="fb-argstableBlock-code">defaultValue</span></div>
+        </td>
+        <td><button>Set string</button></td>
+      </tr>
+    </tbody>
+  </table>
+</div>
+
+<div class="fb-nopreview fb-wrapper">
+  <div class="fb-nopreview_main">
+    <h1 class="fb-nopreview_heading fb-heading">No Preview</h1>
+    <p>Sorry, but you either have no stories or none are selected somehow.</p>
+    <ul>
+      <li>Please check the Forkbook config.</li>
+      <li>Try reloading the page.</li>
+    </ul>
+    <p>
+      If the problem persists, check the browser console, or the terminal you've run Forkbook from.
+    </p>
+  </div>
+</div>
+
+<div class="fb-errordisplay fb-wrapper">
+  <div class="fb-errordisplay_main">
+    <h1 id="error-message"></h1>
+    <p>
+      The component failed to render properly, likely due to a configuration issue in Forkbook.
+      Here are some common causes and how you can address them:
+    </p>
+    <ol>
+      <li>
+        <strong>Missing Context/Providers</strong>: You can use decorators to supply specific
+        contexts or providers, which are sometimes necessary for components to render correctly. For
+        detailed instructions on using decorators, please visit the
+        <a href="https://forkbook.ljk.dev/docs/writing-stories/decorators"
+          >Decorators documentation</a
+        >.
+      </li>
+      <li>
+        <strong>Misconfigured Vite</strong>: Verify that Forkbook picks up all necessary
+        settings for plugins and other relevant parameters. You can find a step-by-step guide for
+        configuring <a href="https://forkbook.ljk.dev/docs/builders/vite">Vite</a> with Forkbook.
+      </li>
+      <li>
+        <strong>Missing Environment Variables</strong>: Your Forkbook may require specific
+        environment variables to function as intended. You can set up custom environment variables
+        as outlined in the
+        <a href="https://forkbook.ljk.dev/docs/configure/environment-variables"
+          >Environment Variables documentation</a
+        >.
+      </li>
+    </ol>
+    <pre class="fb-errordisplay_code"><code id="error-stack"></code></pre>
+  </div>
+</div>

package/assets/server/base-preview-head.html

@@ -0,0 +1,494 @@
+<base target="_parent" />
+
+<style>
+  /* While we aren't showing the main block yet, but still preparing, we want everything the user has rendered, which may or may not be in #storybook-root, to be display none */
+  .fb-show-preparing-story:not(.fb-show-main) > :not(.fb-preparing-story) {
+    display: none;
+  }
+
+  .fb-show-preparing-docs:not(.fb-show-main) > :not(.fb-preparing-docs) {
+    display: none;
+  }
+
+  /* Hide our own blocks when we aren't supposed to be showing them */
+  :not(.fb-show-preparing-story) > .fb-preparing-story,
+  :not(.fb-show-preparing-docs) > .fb-preparing-docs,
+  :not(.fb-show-nopreview) > .fb-nopreview,
+  :not(.fb-show-errordisplay) > .fb-errordisplay {
+    display: none;
+  }
+
+  .fb-show-main.fb-main-centered {
+    margin: 0;
+    display: flex;
+    align-items: center;
+    min-height: 100vh;
+  }
+
+  .fb-show-main.fb-main-centered #storybook-root {
+    box-sizing: border-box;
+    margin: auto;
+    padding: 1rem;
+    max-height: 100%;
+    /* Hack for centering correctly in IE11 */
+  }
+
+  /* Vertical centering fix for IE11 */
+  @media screen and (-ms-high-contrast: none), (-ms-high-contrast: active) {
+    .fb-show-main.fb-main-centered:after {
+      content: '';
+      min-height: inherit;
+      font-size: 0;
+    }
+  }
+
+  .fb-show-main.fb-main-fullscreen {
+    margin: 0;
+    padding: 0;
+    display: block;
+  }
+
+  .fb-show-main.fb-main-padded {
+    margin: 0;
+    padding: 1rem;
+    display: block;
+    box-sizing: border-box;
+  }
+
+  .fb-wrapper {
+    position: fixed;
+    top: 0;
+    bottom: 0;
+    left: 0;
+    right: 0;
+    box-sizing: border-box;
+
+    padding: 40px;
+    font-family:
+      'Inter Variable',
+      -apple-system,
+      '.SFNSText-Regular',
+      'San Francisco',
+      BlinkMacSystemFont,
+      'Segoe UI',
+      'Helvetica Neue',
+      Helvetica,
+      Arial,
+      sans-serif;
+    -webkit-font-smoothing: antialiased;
+    overflow: auto;
+  }
+
+  @media (max-width: 700px) {
+    .fb-wrapper {
+      padding: 20px;
+    }
+  }
+
+  @media (max-width: 500px) {
+    .fb-wrapper {
+      padding: 10px;
+    }
+  }
+
+  .fb-heading {
+    font-size: 14px;
+    font-weight: 600;
+    letter-spacing: 0.2px;
+    margin: 10px 0;
+    padding-right: 25px;
+  }
+
+  .fb-nopreview {
+    display: flex;
+    align-content: center;
+    justify-content: center;
+    box-sizing: border-box;
+  }
+
+  .fb-nopreview_main {
+    margin: auto;
+    padding: 30px;
+    border-radius: 10px;
+    background: rgb(247, 247, 247);
+    color: rgb(46, 52, 56);
+  }
+
+  .fb-nopreview_main * {
+    background: rgb(247, 247, 247);
+    color: rgb(46, 52, 56);
+  }
+
+  .fb-nopreview_heading {
+    text-align: center;
+  }
+
+  .fb-errordisplay {
+    background: #f2f2f7;
+    color: black;
+    z-index: 999999;
+    width: 100vw;
+    min-height: 100vh;
+    box-sizing: border-box;
+  }
+
+  .fb-errordisplay_main {
+    margin: auto;
+    padding: 24px;
+    display: flex;
+    box-sizing: border-box;
+
+    flex-direction: column;
+    min-height: 100%;
+    width: 100%;
+    border-radius: 6px;
+    background: white;
+    color: black;
+    border: 1px solid #ff0000;
+    box-shadow: 0 0 64px rgba(0, 0, 0, 0.1);
+    gap: 24px;
+  }
+
+  .fb-errordisplay_main ol {
+    padding-left: 18px;
+    margin: 0;
+  }
+
+  /* Redefine colors to ensure readability regardless of user-provided * selectors. */
+  .fb-errordisplay_main * {
+    background: white;
+    color: black;
+  }
+
+  /* Exclude error code block from the universal reset to preserve ANSI colors and dark theme */
+  .fb-errordisplay_main .fb-errordisplay_code,
+  .fb-errordisplay_main .fb-errordisplay_code * {
+    background: #242424;
+    color: #c6c6c6;
+  }
+
+  .fb-errordisplay_main h1 {
+    font-family: inherit;
+    font-size: 22px;
+    font-weight: 400;
+    line-height: 30px;
+    margin: 0;
+  }
+
+  .fb-errordisplay_main h1::before {
+    content: '';
+    display: inline-block;
+    width: 12px;
+    height: 12px;
+    background: #ff4400;
+    border-radius: 50%;
+    margin-right: 8px;
+  }
+
+  .fb-errordisplay_main p,
+  .fb-errordisplay_main ol {
+    font-family: inherit;
+    font-size: 14px;
+    font-weight: 400;
+    line-height: 19px;
+    margin: 0;
+  }
+
+  .fb-errordisplay_main li + li {
+    margin: 0;
+    padding: 0;
+    padding-top: 12px;
+  }
+
+  .fb-errordisplay_main a {
+    color: currentColor;
+  }
+
+  .fb-errordisplay_main .fb-errordisplay_code {
+    padding: 10px;
+    flex: 1;
+    background: #242424;
+    color: #c6c6c6;
+    box-sizing: border-box;
+
+    font-size: 14px;
+    font-weight: 400;
+    line-height: 19px;
+    border-radius: 4px;
+
+    font-family:
+      'Operator Mono', 'Fira Code Retina', 'Fira Code', 'FiraCode-Retina', 'Andale Mono',
+      'Lucida Console', Consolas, Monaco, monospace;
+    margin: 0;
+    overflow: auto;
+  }
+
+  .fb-errordisplay_main .fb-errordisplay_code code {
+    background-color: inherit;
+    color: inherit;
+  }
+
+  .fb-errordisplay_main .fb-errordisplay_code {
+    white-space: pre-wrap;
+  }
+
+  @-webkit-keyframes fb-rotate360 {
+    from {
+      transform: rotate(0deg);
+    }
+
+    to {
+      transform: rotate(360deg);
+    }
+  }
+
+  @keyframes fb-rotate360 {
+    from {
+      transform: rotate(0deg);
+    }
+
+    to {
+      transform: rotate(360deg);
+    }
+  }
+
+  @-webkit-keyframes fb-glow {
+    0%,
+    100% {
+      opacity: 1;
+    }
+
+    50% {
+      opacity: 0.4;
+    }
+  }
+
+  @keyframes fb-glow {
+    0%,
+    100% {
+      opacity: 1;
+    }
+
+    50% {
+      opacity: 0.4;
+    }
+  }
+
+  /* We display the preparing loaders *over* the rendering story */
+  .fb-preparing-story,
+  .fb-preparing-docs {
+    background-color: white;
+    /* Maximum possible z-index. It would be better to use stacking contexts to ensure it's always
+    on top, but this isn't possible as it would require making CSS changes that could affect user code */
+    z-index: 2147483647;
+  }
+
+  .fb-loader {
+    -webkit-animation: fb-rotate360 0.7s linear infinite;
+    animation: fb-rotate360 0.7s linear infinite;
+    border-color: rgba(97, 97, 97, 0.29);
+    border-radius: 50%;
+    border-style: solid;
+    border-top-color: #646464;
+    border-width: 2px;
+    display: inline-block;
+    height: 32px;
+    left: 50%;
+    margin-left: -16px;
+    margin-top: -16px;
+    mix-blend-mode: difference;
+    overflow: hidden;
+    position: absolute;
+    top: 50%;
+    transition: all 200ms ease-out;
+    vertical-align: top;
+    width: 32px;
+    z-index: 4;
+  }
+
+  .fb-previewBlock {
+    background: #fff;
+    border: 1px solid rgba(0, 0, 0, 0.1);
+    border-radius: 4px;
+    box-shadow: rgba(0, 0, 0, 0.1) 0 1px 3px 0;
+    margin: 25px auto 40px;
+    max-width: 600px;
+  }
+
+  .fb-previewBlock_header {
+    align-items: center;
+    box-shadow: rgba(0, 0, 0, 0.1) 0 -1px 0 0 inset;
+    display: flex;
+    gap: 14px;
+    height: 40px;
+    padding: 0 12px;
+  }
+
+  .fb-previewBlock_icon {
+    -webkit-animation: fb-glow 1.5s ease-in-out infinite;
+    animation: fb-glow 1.5s ease-in-out infinite;
+    background: #e6e6e6;
+    height: 14px;
+    width: 14px;
+  }
+
+  .fb-previewBlock_icon:last-child {
+    margin-left: auto;
+  }
+
+  .fb-previewBlock_body {
+    -webkit-animation: fb-glow 1.5s ease-in-out infinite;
+    animation: fb-glow 1.5s ease-in-out infinite;
+    height: 182px;
+    position: relative;
+  }
+
+  .fb-argstableBlock {
+    border-collapse: collapse;
+    border-spacing: 0;
+    font-size: 13px;
+    line-height: 20px;
+    margin: 25px auto 40px;
+    max-width: 600px;
+    text-align: left;
+    width: 100%;
+  }
+
+  .fb-argstableBlock th:first-of-type,
+  .fb-argstableBlock td:first-of-type {
+    padding-left: 20px;
+  }
+
+  .fb-argstableBlock th:nth-of-type(2),
+  .fb-argstableBlock td:nth-of-type(2) {
+    width: 35%;
+  }
+
+  .fb-argstableBlock th:nth-of-type(3),
+  .fb-argstableBlock td:nth-of-type(3) {
+    width: 15%;
+  }
+
+  .fb-argstableBlock th:last-of-type,
+  .fb-argstableBlock td:last-of-type {
+    width: 25%;
+    padding-right: 20px;
+  }
+
+  .fb-argstableBlock th span,
+  .fb-argstableBlock td span {
+    -webkit-animation: fb-glow 1.5s ease-in-out infinite;
+    animation: fb-glow 1.5s ease-in-out infinite;
+    background-color: rgba(0, 0, 0, 0.1);
+    border-radius: 0;
+    box-shadow: none;
+    color: transparent;
+  }
+
+  .fb-argstableBlock th {
+    padding: 10px 15px;
+  }
+
+  .fb-argstableBlock-body {
+    border-radius: 4px;
+    box-shadow:
+      rgba(0, 0, 0, 0.1) 0 1px 3px 1px,
+      rgba(0, 0, 0, 0.065) 0 0 0 1px;
+  }
+
+  .fb-argstableBlock-body tr {
+    background: transparent;
+    overflow: hidden;
+  }
+
+  .fb-argstableBlock-body tr:not(:first-child) {
+    border-top: 1px solid #e6e6e6;
+  }
+
+  .fb-argstableBlock-body tr:first-child td:first-child {
+    border-top-left-radius: 4px;
+  }
+
+  .fb-argstableBlock-body tr:first-child td:last-child {
+    border-top-right-radius: 4px;
+  }
+
+  .fb-argstableBlock-body tr:last-child td:first-child {
+    border-bottom-left-radius: 4px;
+  }
+
+  .fb-argstableBlock-body tr:last-child td:last-child {
+    border-bottom-right-radius: 4px;
+  }
+
+  .fb-argstableBlock-body td {
+    background: #fff;
+    padding-bottom: 10px;
+    padding-top: 10px;
+    vertical-align: top;
+  }
+
+  .fb-argstableBlock-body td:not(:first-of-type) {
+    padding-left: 15px;
+    padding-right: 15px;
+  }
+
+  .fb-argstableBlock-body button {
+    -webkit-animation: fb-glow 1.5s ease-in-out infinite;
+    animation: fb-glow 1.5s ease-in-out infinite;
+    background-color: rgba(0, 0, 0, 0.1);
+    border: 0;
+    border-radius: 0;
+    box-shadow: none;
+    color: transparent;
+    display: inline;
+    font-size: 12px;
+    line-height: 1;
+    padding: 10px 16px;
+  }
+
+  .fb-argstableBlock-summary {
+    margin-top: 4px;
+  }
+
+  .fb-argstableBlock-code {
+    margin-right: 4px;
+    margin-bottom: 4px;
+    padding: 2px 5px;
+  }
+
+  .fb-sr-only,
+  .fb-hidden-until-focus:not(:focus) {
+    position: absolute;
+    width: 1px;
+    height: 1px;
+    padding: 0px;
+    margin: -1px;
+    overflow: hidden;
+    clip: rect(0, 0, 0, 0);
+    border: none;
+  }
+
+  .fb-hidden-until-focus {
+    opacity: 0;
+    transition: opacity 150ms ease-out;
+  }
+
+  .fb-hidden-until-focus:focus {
+    opacity: 1;
+  }
+</style>
+
+<script>
+  /* globals window */
+  try {
+    if (window.top !== window) {
+      window.__REACT_DEVTOOLS_GLOBAL_HOOK__ = window.top.__REACT_DEVTOOLS_GLOBAL_HOOK__;
+      window.__VUE_DEVTOOLS_GLOBAL_HOOK__ = window.top.__VUE_DEVTOOLS_GLOBAL_HOOK__;
+      window.top.__VUE_DEVTOOLS_CONTEXT__ = window.document;
+    }
+  } catch (e) {
+    // eslint-disable-next-line no-console
+    console.warn('unable to connect to top frame for connecting dev tools');
+  }
+</script>