@aussieljk/forkbook 0.0.0-stage → 0.0.1-2

package/dist/chunk-DzuY9DXg.d.ts

@@ -0,0 +1,79 @@
+//#region .dts-emit/code/core/src/highlight/icons.d.ts
+declare const iconPaths: {
+  chevronLeft: string[];
+  chevronRight: string[];
+  info: string[];
+  shareAlt: string[];
+};
+type IconName = keyof typeof iconPaths;
+//#endregion
+//#region .dts-emit/code/core/src/highlight/types.d.ts
+interface HighlightTypes {
+  parameters: HighlightParameters;
+}
+interface HighlightParameters {
+  /**
+   * Highlight configuration
+   *
+   * @see https://storybook.js.org/docs/essentials/highlight#parameters
+   */
+  highlight?: {
+    /**
+     * Removes the tool and disables the feature's behavior. If you wish to turn off this feature
+     * for the entire Forkbook, you can set the option in your `main.js|ts` configuration file.
+     *
+     * @see https://storybook.js.org/docs/essentials/highlight#disable
+     */
+    disable?: boolean;
+  };
+}
+interface HighlightMenuItem {
+  /** Unique identifier for the menu item */
+  id: string;
+  /** Title of the menu item */
+  title: string;
+  /** Description of the menu item */
+  description?: string;
+  /** Icon for the menu item, left side */
+  iconLeft?: IconName;
+  /** Icon for the menu item, right side */
+  iconRight?: IconName;
+  /**
+   * Render the item as a button. Clicking it emits `HIGHLIGHT_MENU_CLICK` with the highlight `id`,
+   * the item `id` and the `ClickEventDetails` of the clicked element.
+   */
+  clickable?: boolean;
+  /** HTML selectors for which this menu item should show (subset of `selectors`) */
+  selectors?: HighlightOptions['selectors'];
+}
+interface HighlightOptions {
+  /** Unique identifier for the highlight, used to remove it later and to attribute menu clicks */
+  id: string;
+  /** HTML selectors of the elements */
+  selectors: string[];
+  /** Priority of the highlight, higher takes precedence, defaults to 0 */
+  priority?: number;
+  /** CSS styles to apply to the highlight */
+  styles?: Record<string, string>;
+  /** CSS styles to apply to the highlight when it is hovered */
+  hoverStyles?: Record<string, string>;
+  /** CSS styles to apply to the highlight when it is focused or selected */
+  focusStyles?: Record<string, string>;
+  /** Keyframes required for animations */
+  keyframes?: string;
+  /** Groups of menu items to show when the highlight is selected */
+  menu?: HighlightMenuItem[][];
+}
+interface ClickEventDetails {
+  top: number;
+  left: number;
+  width: number;
+  height: number;
+  selectors: string[];
+  element: {
+    localName: string;
+    tagName: string;
+  };
+}
+//#endregion
+export { HighlightTypes as i, HighlightMenuItem as n, HighlightOptions as r, ClickEventDetails as t };

package/dist/chunk-FjDVzZTj.d.ts

@@ -0,0 +1,62 @@
+//#region ../../node_modules/type-fest/source/simplify.d.ts
+/**
+Useful to flatten the type output to improve type hints shown in editors. And also to transform an interface into a type to aide with assignability.
+
+@example
+```
+import type {Simplify} from 'type-fest';
+
+type PositionProps = {
+	top: number;
+	left: number;
+};
+
+type SizeProps = {
+	width: number;
+	height: number;
+};
+
+// In your editor, hovering over `Props` will show a flattened object with all the properties.
+type Props = Simplify<PositionProps & SizeProps>;
+```
+
+Sometimes it is desired to pass a value as a function argument that has a different type. At first inspection it may seem assignable, and then you discover it is not because the `value`'s type definition was defined as an interface. In the following example, `fn` requires an argument of type `Record<string, unknown>`. If the value is defined as a literal, then it is assignable. And if the `value` is defined as type using the `Simplify` utility the value is assignable.  But if the `value` is defined as an interface, it is not assignable because the interface is not sealed and elsewhere a non-string property could be added to the interface.
+
+If the type definition must be an interface (perhaps it was defined in a third-party npm package), then the `value` can be defined as `const value: Simplify<SomeInterface> = ...`. Then `value` will be assignable to the `fn` argument.  Or the `value` can be cast as `Simplify<SomeInterface>` if you can't re-declare the `value`.
+
+@example
+```
+import type {Simplify} from 'type-fest';
+
+interface SomeInterface {
+	foo: number;
+	bar?: string;
+	baz: number | undefined;
+}
+
+type SomeType = {
+	foo: number;
+	bar?: string;
+	baz: number | undefined;
+};
+
+const literal = {foo: 123, bar: 'hello', baz: 456};
+const someType: SomeType = literal;
+const someInterface: SomeInterface = literal;
+
+declare function fn(object: Record<string, unknown>): void;
+
+fn(literal); // Good: literal object type is sealed
+fn(someType); // Good: type is sealed
+// @ts-expect-error
+fn(someInterface); // Error: Index signature for type 'string' is missing in type 'someInterface'. Because `interface` can be re-opened
+fn(someInterface as Simplify<SomeInterface>); // Good: transform an `interface` into a `type`
+```
+
+@link https://github.com/microsoft/TypeScript/issues/15300
+@see {@link SimplifyDeep}
+@category Object
+*/
+type Simplify<T> = { [KeyType in keyof T]: T[KeyType] } & {};
+//#endregion
+export { Simplify as t };

package/dist/chunk-Kt1tW-D1.d.ts

@@ -0,0 +1,59 @@
+//#region .dts-emit/code/core/src/backgrounds/constants.d.ts
+declare const ADDON_ID = "@aussieljk/forkbook/background";
+declare const PARAM_KEY = "backgrounds";
+declare const GRID_PARAM_KEY = "grid";
+declare const EVENTS: {
+  UPDATE: string;
+};
+//#endregion
+//#region .dts-emit/code/core/src/backgrounds/types.d.ts
+interface Background {
+  name: string;
+  value: string;
+}
+type BackgroundMap = Record<string, Background>;
+interface GridConfig {
+  cellAmount: number;
+  cellSize: number;
+  opacity: number;
+  offsetX?: number;
+  offsetY?: number;
+}
+type GlobalState = {
+  value: string | undefined;
+  grid?: boolean;
+};
+type GlobalStateUpdate = Partial<GlobalState>;
+interface BackgroundsParameters {
+  /**
+   * Backgrounds configuration
+   *
+   * @see https://storybook.js.org/docs/essentials/backgrounds#parameters
+   */
+  backgrounds?: {
+    /** Default background color */default?: string;
+    /**
+     * Removes the tool and disables the feature's behavior. If you wish to turn off this feature
+     * for the entire Forkbook, you can set the option in your `main.js|ts` configuration file.
+     *
+     * @see https://storybook.js.org/docs/essentials/backgrounds#disable
+     */
+    disable?: boolean; /** Configuration for the background grid */
+    grid?: GridConfig; /** Available background colors */
+    options?: BackgroundMap;
+  };
+}
+interface BackgroundsGlobals {
+  /**
+   * Backgrounds configuration
+   *
+   * @see https://storybook.js.org/docs/essentials/backgrounds#globals
+   */
+  [PARAM_KEY]?: GlobalState | GlobalState['value'];
+}
+interface BackgroundTypes {
+  parameters: BackgroundsParameters;
+  globals: BackgroundsGlobals;
+}
+//#endregion
+export { BackgroundsParameters as a, GridConfig as c, GRID_PARAM_KEY as d, PARAM_KEY as f, BackgroundsGlobals as i, ADDON_ID as l, BackgroundMap as n, GlobalState as o, BackgroundTypes as r, GlobalStateUpdate as s, Background as t, EVENTS as u };

package/dist/chunk-XP8oHzpE.d.ts

@@ -0,0 +1,6 @@
+//#region .dts-emit/code/core/src/addon-a11y/constants.d.ts
+declare const ADDON_ID = "@aussieljk/forkbook/a11y";
+declare const PANEL_ID = "@aussieljk/forkbook/a11y/panel";
+declare const PARAM_KEY = "a11y";
+//#endregion
+export { PANEL_ID as n, PARAM_KEY as r, ADDON_ID as t };

package/dist/chunk-gCX81nOr.d.ts

@@ -0,0 +1,61 @@
+//#region .dts-emit/code/core/src/viewport/types.d.ts
+interface Viewport {
+  name: string;
+  styles: ViewportStyles;
+  type?: ViewportType;
+}
+type ViewportType = 'desktop' | 'mobile' | 'tablet' | 'watch' | 'other';
+interface ViewportStyles {
+  height: string;
+  width: string;
+}
+type ViewportMap = Record<string, Viewport>;
+type GlobalState = {
+  /**
+   * When set, the viewport is applied and cannot be changed using the toolbar. Must match the key
+   * of one of the available viewports or follow the format '{width}-{height}', e.g. '320-480' which
+   * may include a unit (e.g. '100vw' or '100pct').
+   */
+  value: string | undefined;
+  /**
+   * When true the viewport applied will be rotated 90°, e.g. it will rotate from portrait to
+   * landscape orientation.
+   */
+  isRotated?: boolean;
+};
+type GlobalStateUpdate = Partial<GlobalState>;
+interface ViewportParameters {
+  /**
+   * Viewport configuration
+   *
+   * @see https://storybook.js.org/docs/essentials/viewport#parameters
+   */
+  viewport?: {
+    /**
+     * Removes the tool and disables the feature's behavior. If you wish to turn off this feature
+     * for the entire Forkbook, you can set the option in your `main.js|ts` configuration file.
+     *
+     * @see https://storybook.js.org/docs/essentials/viewport#disable
+     */
+    disable?: boolean;
+    /**
+     * Specify the available viewports. The width and height values must include the unit, e.g.
+     * '320px'.
+     */
+    options: Record<string, Viewport>;
+  };
+}
+interface ViewportGlobals {
+  /**
+   * Viewport configuration
+   *
+   * @see https://storybook.js.org/docs/essentials/viewport#globals
+   */
+  viewport?: GlobalState | GlobalState['value'];
+}
+interface ViewportTypes {
+  parameters: ViewportParameters;
+  globals: ViewportGlobals;
+}
+//#endregion
+export { ViewportMap as a, ViewportType as c, ViewportGlobals as i, ViewportTypes as l, GlobalStateUpdate as n, ViewportParameters as o, Viewport as r, ViewportStyles as s, GlobalState as t };