@iowas/toolpad 1.0.0

package/README.md

@@ -0,0 +1,57 @@
+# toolpad
+
+Reusable React components and hooks extracted from this repository.
+
+## Install
+
+```bash
+pnpm add @iowas/toolpad
+```
+
+Peer dependencies are required in the consuming app (`react`, `react-dom`, MUI, emotion, and optionally `next` for `toolpad/nextjs`).
+
+## Usage
+
+```tsx
+import { AppProvider, DashboardLayout } from '@iowas/toolpad';
+```
+
+Use subpath exports when you only need a subset:
+
+```tsx
+import { AppProvider } from '@iowas/toolpad/core';
+import { useBoolean } from '@iowas/toolpad/utils';
+import { NextAppProvider } from '@iowas/toolpad/nextjs';
+```
+
+## Build
+
+```bash
+pnpm install
+pnpm build
+```
+
+Build output is generated in `dist/`.
+
+## Reuse Locally In Another Project
+
+From this repository:
+
+```bash
+pnpm build
+pnpm pack
+```
+
+Then in another project:
+
+```bash
+pnpm add /absolute/path/to/@iowas%2ftoolpad-1.0.0.tgz
+```
+
+## Published Exports
+
+- `@iowas/toolpad`
+- `@iowas/toolpad/core`
+- `@iowas/toolpad/utils`
+- `@iowas/toolpad/nextjs`
+

package/dist/AppProvider-CIyOzZv_.d.mts

@@ -0,0 +1,201 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as React from 'react';
+import { Theme } from '@mui/material/styles';
+
+/**
+ * @ignore - internal component.
+ */
+interface LinkProps extends React.AnchorHTMLAttributes<HTMLAnchorElement> {
+    history?: 'auto' | 'push' | 'replace';
+    href: string;
+}
+
+interface LocaleText {
+    accountSignInLabel: string;
+    accountSignOutLabel: string;
+    accountPreviewIconButtonLabel: string;
+    accountPreviewTitle: string;
+    signInTitle: string | ((brandingTitle?: string) => string);
+    signInSubtitle: string;
+    providerSignInTitle: (provider: string) => string;
+    signInRememberMe: string;
+    email: string;
+    passkey: string;
+    username: string;
+    password: string;
+    or: string;
+    to: string;
+    with: string;
+    save: string;
+    cancel: string;
+    ok: string;
+    close: string;
+    delete: string;
+    alert: string;
+    confirm: string;
+    loading: string;
+    createNewButtonLabel: string;
+    reloadButtonLabel: string;
+    createLabel: string;
+    createSuccessMessage: string;
+    createErrorMessage: string;
+    editLabel: string;
+    editSuccessMessage: string;
+    editErrorMessage: string;
+    deleteLabel: string;
+    deleteConfirmTitle: string;
+    deleteConfirmMessage: string;
+    deleteConfirmLabel: string;
+    deleteCancelLabel: string;
+    deleteSuccessMessage: string;
+    deleteErrorMessage: string;
+    deletedItemMessage: string;
+}
+interface LocalizationProviderProps {
+    children?: React.ReactNode;
+    /**
+     * Locale for components texts
+     */
+    localeText?: Partial<LocaleText>;
+}
+declare const LocalizationContext: React.Context<Partial<LocaleText>>;
+declare const LocalizationProvider: {
+    (props: LocalizationProviderProps): react_jsx_runtime.JSX.Element;
+    propTypes: any;
+};
+
+/**
+ *
+ * Demos:
+ *
+ * - [Sign-in Page](https://mui.com/toolpad/core/react-sign-in-page/)
+ *
+ * API:
+ *
+ * - [LocalizationProvider API](https://mui.com/toolpad/core/api/localization-provider)
+ */
+declare function useLocaleText(): Partial<LocaleText>;
+
+interface NavigateOptions {
+    history?: 'auto' | 'push' | 'replace';
+}
+interface Navigate {
+    (url: string | URL, options?: NavigateOptions): void;
+}
+/**
+ * Abstract router used by Toolpad components.
+ */
+interface Router {
+    pathname: string;
+    searchParams: URLSearchParams;
+    navigate: Navigate;
+    Link?: React.ComponentType<LinkProps>;
+}
+interface Branding {
+    title?: string;
+    logo?: React.ReactNode;
+    homeUrl?: string;
+}
+interface NavigationPageItem {
+    kind?: 'page';
+    segment?: string;
+    title?: string;
+    icon?: React.ReactNode;
+    pattern?: string;
+    action?: React.ReactNode;
+    children?: Navigation;
+}
+interface NavigationSubheaderItem {
+    kind: 'header';
+    title: string;
+}
+interface NavigationDividerItem {
+    kind: 'divider';
+}
+type NavigationItem = NavigationPageItem | NavigationSubheaderItem | NavigationDividerItem;
+type Navigation = NavigationItem[];
+interface Session {
+    user?: {
+        id?: string | null;
+        name?: string | null;
+        image?: string | null;
+        email?: string | null;
+    };
+}
+interface Authentication {
+    signIn: () => void;
+    signOut: () => void;
+}
+declare const AuthenticationContext: React.Context<Authentication | null>;
+declare const SessionContext: React.Context<Session | null>;
+type AppTheme = Theme | {
+    light: Theme;
+    dark: Theme;
+};
+interface AppProviderProps {
+    /**
+     * The content of the app provider.
+     */
+    children: React.ReactNode;
+    /**
+     * [Theme or themes](https://mui.com/toolpad/core/react-app-provider/#theming) to be used by the app in light/dark mode. A [CSS variables theme](https://mui.com/material-ui/customization/css-theme-variables/overview/) is recommended.
+     * @default createDefaultTheme()
+     */
+    theme?: AppTheme;
+    /**
+     * Branding options for the app.
+     * @default null
+     */
+    branding?: Branding | null;
+    /**
+     * Navigation definition for the app. [Find out more](https://mui.com/toolpad/core/react-app-provider/#navigation).
+     * @default []
+     */
+    navigation?: Navigation;
+    /**
+     * Router implementation used inside Toolpad components.
+     * @default null
+     */
+    router?: Router;
+    /**
+     * Locale text for components
+     */
+    localeText?: Partial<LocaleText>;
+    /**
+     * Session info about the current user.
+     * @default null
+     */
+    session?: Session | null;
+    /**
+     * Authentication methods.
+     * @default null
+     */
+    authentication?: Authentication | null;
+    /**
+     * The window where the application is rendered.
+     * This is needed when rendering the app inside an iframe, for example.
+     * @default window
+     */
+    window?: Window;
+    /**
+     * The nonce to be used for inline scripts.
+     */
+    nonce?: string;
+}
+/**
+ *
+ * Demos:
+ *
+ * - [App Provider](https://mui.com/toolpad/core/react-app-provider/)
+ * - [Dashboard Layout](https://mui.com/toolpad/core/react-dashboard-layout/)
+ *
+ * API:
+ *
+ * - [AppProvider API](https://mui.com/toolpad/core/api/app-provider)
+ */
+declare function AppProvider(props: AppProviderProps): react_jsx_runtime.JSX.Element;
+declare namespace AppProvider {
+    var propTypes: any;
+}
+
+export { AppProvider as A, type Branding as B, type LocaleText as L, type Navigate as N, type Router as R, type Session as S, type AppProviderProps as a, type AppTheme as b, type Authentication as c, AuthenticationContext as d, LocalizationContext as e, LocalizationProvider as f, type LocalizationProviderProps as g, type NavigateOptions as h, type Navigation as i, type NavigationDividerItem as j, type NavigationItem as k, type NavigationPageItem as l, type NavigationSubheaderItem as m, SessionContext as n, useLocaleText as u };

package/dist/AppProvider-CIyOzZv_.d.ts

@@ -0,0 +1,201 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as React from 'react';
+import { Theme } from '@mui/material/styles';
+
+/**
+ * @ignore - internal component.
+ */
+interface LinkProps extends React.AnchorHTMLAttributes<HTMLAnchorElement> {
+    history?: 'auto' | 'push' | 'replace';
+    href: string;
+}
+
+interface LocaleText {
+    accountSignInLabel: string;
+    accountSignOutLabel: string;
+    accountPreviewIconButtonLabel: string;
+    accountPreviewTitle: string;
+    signInTitle: string | ((brandingTitle?: string) => string);
+    signInSubtitle: string;
+    providerSignInTitle: (provider: string) => string;
+    signInRememberMe: string;
+    email: string;
+    passkey: string;
+    username: string;
+    password: string;
+    or: string;
+    to: string;
+    with: string;
+    save: string;
+    cancel: string;
+    ok: string;
+    close: string;
+    delete: string;
+    alert: string;
+    confirm: string;
+    loading: string;
+    createNewButtonLabel: string;
+    reloadButtonLabel: string;
+    createLabel: string;
+    createSuccessMessage: string;
+    createErrorMessage: string;
+    editLabel: string;
+    editSuccessMessage: string;
+    editErrorMessage: string;
+    deleteLabel: string;
+    deleteConfirmTitle: string;
+    deleteConfirmMessage: string;
+    deleteConfirmLabel: string;
+    deleteCancelLabel: string;
+    deleteSuccessMessage: string;
+    deleteErrorMessage: string;
+    deletedItemMessage: string;
+}
+interface LocalizationProviderProps {
+    children?: React.ReactNode;
+    /**
+     * Locale for components texts
+     */
+    localeText?: Partial<LocaleText>;
+}
+declare const LocalizationContext: React.Context<Partial<LocaleText>>;
+declare const LocalizationProvider: {
+    (props: LocalizationProviderProps): react_jsx_runtime.JSX.Element;
+    propTypes: any;
+};
+
+/**
+ *
+ * Demos:
+ *
+ * - [Sign-in Page](https://mui.com/toolpad/core/react-sign-in-page/)
+ *
+ * API:
+ *
+ * - [LocalizationProvider API](https://mui.com/toolpad/core/api/localization-provider)
+ */
+declare function useLocaleText(): Partial<LocaleText>;
+
+interface NavigateOptions {
+    history?: 'auto' | 'push' | 'replace';
+}
+interface Navigate {
+    (url: string | URL, options?: NavigateOptions): void;
+}
+/**
+ * Abstract router used by Toolpad components.
+ */
+interface Router {
+    pathname: string;
+    searchParams: URLSearchParams;
+    navigate: Navigate;
+    Link?: React.ComponentType<LinkProps>;
+}
+interface Branding {
+    title?: string;
+    logo?: React.ReactNode;
+    homeUrl?: string;
+}
+interface NavigationPageItem {
+    kind?: 'page';
+    segment?: string;
+    title?: string;
+    icon?: React.ReactNode;
+    pattern?: string;
+    action?: React.ReactNode;
+    children?: Navigation;
+}
+interface NavigationSubheaderItem {
+    kind: 'header';
+    title: string;
+}
+interface NavigationDividerItem {
+    kind: 'divider';
+}
+type NavigationItem = NavigationPageItem | NavigationSubheaderItem | NavigationDividerItem;
+type Navigation = NavigationItem[];
+interface Session {
+    user?: {
+        id?: string | null;
+        name?: string | null;
+        image?: string | null;
+        email?: string | null;
+    };
+}
+interface Authentication {
+    signIn: () => void;
+    signOut: () => void;
+}
+declare const AuthenticationContext: React.Context<Authentication | null>;
+declare const SessionContext: React.Context<Session | null>;
+type AppTheme = Theme | {
+    light: Theme;
+    dark: Theme;
+};
+interface AppProviderProps {
+    /**
+     * The content of the app provider.
+     */
+    children: React.ReactNode;
+    /**
+     * [Theme or themes](https://mui.com/toolpad/core/react-app-provider/#theming) to be used by the app in light/dark mode. A [CSS variables theme](https://mui.com/material-ui/customization/css-theme-variables/overview/) is recommended.
+     * @default createDefaultTheme()
+     */
+    theme?: AppTheme;
+    /**
+     * Branding options for the app.
+     * @default null
+     */
+    branding?: Branding | null;
+    /**
+     * Navigation definition for the app. [Find out more](https://mui.com/toolpad/core/react-app-provider/#navigation).
+     * @default []
+     */
+    navigation?: Navigation;
+    /**
+     * Router implementation used inside Toolpad components.
+     * @default null
+     */
+    router?: Router;
+    /**
+     * Locale text for components
+     */
+    localeText?: Partial<LocaleText>;
+    /**
+     * Session info about the current user.
+     * @default null
+     */
+    session?: Session | null;
+    /**
+     * Authentication methods.
+     * @default null
+     */
+    authentication?: Authentication | null;
+    /**
+     * The window where the application is rendered.
+     * This is needed when rendering the app inside an iframe, for example.
+     * @default window
+     */
+    window?: Window;
+    /**
+     * The nonce to be used for inline scripts.
+     */
+    nonce?: string;
+}
+/**
+ *
+ * Demos:
+ *
+ * - [App Provider](https://mui.com/toolpad/core/react-app-provider/)
+ * - [Dashboard Layout](https://mui.com/toolpad/core/react-dashboard-layout/)
+ *
+ * API:
+ *
+ * - [AppProvider API](https://mui.com/toolpad/core/api/app-provider)
+ */
+declare function AppProvider(props: AppProviderProps): react_jsx_runtime.JSX.Element;
+declare namespace AppProvider {
+    var propTypes: any;
+}
+
+export { AppProvider as A, type Branding as B, type LocaleText as L, type Navigate as N, type Router as R, type Session as S, type AppProviderProps as a, type AppTheme as b, type Authentication as c, AuthenticationContext as d, LocalizationContext as e, LocalizationProvider as f, type LocalizationProviderProps as g, type NavigateOptions as h, type Navigation as i, type NavigationDividerItem as j, type NavigationItem as k, type NavigationPageItem as l, type NavigationSubheaderItem as m, SessionContext as n, useLocaleText as u };

package/dist/chunk-3JWXE2JW.mjs

@@ -0,0 +1,125 @@
+var __defProp = Object.defineProperty;
+var __defProps = Object.defineProperties;
+var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
+var __getOwnPropSymbols = Object.getOwnPropertySymbols;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __propIsEnum = Object.prototype.propertyIsEnumerable;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __spreadValues = (a, b) => {
+  for (var prop in b || (b = {}))
+    if (__hasOwnProp.call(b, prop))
+      __defNormalProp(a, prop, b[prop]);
+  if (__getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(b)) {
+      if (__propIsEnum.call(b, prop))
+        __defNormalProp(a, prop, b[prop]);
+    }
+  return a;
+};
+var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
+var __objRest = (source, exclude) => {
+  var target = {};
+  for (var prop in source)
+    if (__hasOwnProp.call(source, prop) && exclude.indexOf(prop) < 0)
+      target[prop] = source[prop];
+  if (source != null && __getOwnPropSymbols)
+    for (var prop of __getOwnPropSymbols(source)) {
+      if (exclude.indexOf(prop) < 0 && __propIsEnum.call(source, prop))
+        target[prop] = source[prop];
+    }
+  return target;
+};
+
+// src/toolpad-utils/react.tsx
+import * as React from "react";
+import * as ReactIs from "react-is";
+import { jsx } from "react/jsx-runtime";
+function interleave(items, separator) {
+  const result = [];
+  for (let i = 0; i < items.length; i += 1) {
+    if (i > 0) {
+      if (ReactIs.isElement(separator)) {
+        result.push(React.cloneElement(separator, { key: `separator-${i}` }));
+      } else {
+        result.push(separator);
+      }
+    }
+    const item = items[i];
+    result.push(item);
+  }
+  return /* @__PURE__ */ jsx(React.Fragment, { children: result });
+}
+function useNonNullableContext(context, name) {
+  const maybeContext = React.useContext(context);
+  if (maybeContext === null || maybeContext === void 0) {
+    throw new Error(`context "${name}" was used without a Provider`);
+  }
+  return maybeContext;
+}
+function createProvidedContext(name) {
+  const context = React.createContext(void 0);
+  const useContext2 = () => useNonNullableContext(context, name);
+  return [useContext2, context.Provider];
+}
+function useAssertedContext(context) {
+  const value = React.useContext(context);
+  if (value === void 0) {
+    throw new Error("context was used without a Provider");
+  }
+  return value;
+}
+function useTraceUpdates(prefix, props) {
+  const prev = React.useRef(props);
+  React.useEffect(() => {
+    const changedProps = {};
+    for (const key of Object.keys(props)) {
+      if (!Object.is(prev.current[key], props[key])) {
+        changedProps[key] = props[key];
+      }
+    }
+    if (Object.keys(changedProps).length > 0) {
+      console.log(`${prefix} changed props:`, changedProps);
+    }
+    prev.current = props;
+  });
+}
+function createGlobalState(initialState) {
+  let state = initialState;
+  const listeners = [];
+  const subscribe = (cb) => {
+    listeners.push(cb);
+    return () => {
+      const index = listeners.indexOf(cb);
+      listeners.splice(index, 1);
+    };
+  };
+  const getState = () => state;
+  const setState = (newState) => {
+    state = typeof newState === "function" ? newState(state) : newState;
+    listeners.forEach((cb) => cb(state));
+  };
+  const useValue = () => React.useSyncExternalStore(subscribe, getState, getState);
+  const useState = () => {
+    const value = useValue();
+    return [value, setState];
+  };
+  return {
+    getState,
+    setState,
+    useValue,
+    useState,
+    subscribe
+  };
+}
+
+export {
+  __spreadValues,
+  __spreadProps,
+  __objRest,
+  interleave,
+  useNonNullableContext,
+  createProvidedContext,
+  useAssertedContext,
+  useTraceUpdates,
+  createGlobalState
+};

package/dist/chunk-CENJI4RY.mjs

@@ -0,0 +1,26 @@
+// src/toolpad-utils/hooks/useBoolean.ts
+import * as React from "react";
+function useBoolean(initialValue) {
+  const [value, setValue] = React.useState(initialValue);
+  const toggle = React.useCallback(() => setValue((existing) => !existing), []);
+  const setTrue = React.useCallback(() => setValue(true), []);
+  const setFalse = React.useCallback(() => setValue(false), []);
+  return { value, setValue, toggle, setTrue, setFalse };
+}
+
+// src/toolpad-utils/hooks/usePageTitle.ts
+import * as React2 from "react";
+function usePageTitle(title) {
+  React2.useEffect(() => {
+    const original = document.title;
+    document.title = title;
+    return () => {
+      document.title = original;
+    };
+  }, [title]);
+}
+
+export {
+  useBoolean,
+  usePageTitle
+};

package/dist/chunk-F6JD4MSY.mjs

@@ -0,0 +1,12 @@
+// src/toolpad-utils/warnOnce.ts
+var history = /* @__PURE__ */ new Set();
+function warnOnce(msg) {
+  if (!history.has(msg)) {
+    history.add(msg);
+    console.warn(msg);
+  }
+}
+
+export {
+  warnOnce
+};