@indietabletop/appkit 7.0.0-0 → 7.0.0-rc.1

package/dist/use-reverting-state.d.ts

@@ -1,5 +0,0 @@
-/**
- * Sets a state that will automatically revert to null after specified number
- * of milliseconds.
- */
-export declare function useRevertingState<T>(initialState: T, revertAfterMs: number): readonly [T | null, import('react').Dispatch<import('react').SetStateAction<T | null>>];

package/dist/use-scroll-restoration.d.ts

@@ -1,25 +0,0 @@
-/**
- * Handles scroll restoration on window.
- *
- * This hook behaves a little differently than the default browser scroll
- * restoration. This is due to limitations of Wouter (our router of choice)
- * as well the need to make the app feel more app-like.
- *
- * Every scroll position is remembered however the user has got to it (we
- * don't differentiate between new entries in browser history and back
- * navigation), but they are only restored if the user last visited the
- * location less than 60 minutes ago.
- */
-export declare function useScrollRestoration(
-/**
- * The current path, provided by your router of choice.
- */
-pathname: string, options?: {
-    /**
-     * A list of paths where scroll restoration should never be performed.
-     *
-     * This list should have stable identity for optimal performance. Make
-     * sure to use `useMemo` or define the list in module scope.
-     */
-    neverRestore?: string[];
-}): void;

package/dist/useEnsureValue.d.ts

@@ -1,6 +0,0 @@
-import { Failure, Success, AsyncOp } from './async-op.ts';
-/**
- * Checks if the provided value is non-nullish, otherwise calls provided
- * getValue function to obtain the value (presumably from some remote location).
- */
-export declare function useEnsureValue<T>(value: T | null | undefined, getValue: () => Promise<Success<T> | Failure<string>>): AsyncOp<T, string>;

package/dist/useInvokeClient.d.ts

@@ -1,25 +0,0 @@
-import { SWRConfiguration, SWRResponse } from 'swr';
-import { Pending } from './async-op.ts';
-import { IndieTabletopClient } from './client.ts';
-/**
- * Creates a `useInvokeClient` hook that makes it ergonomic to invoke
- * client methods.
- *
- * Note that only methods starting with `get` are picked up. This hook is
- * intended for making easy fetches, not for form submissions.
- */
-export declare function createUseInvokeClient<C extends IndieTabletopClient>(c: C): <K extends keyof C & `get${string}`>(
-/**
- * ITC Client's method name.
- */
-method: K, 
-/**
- * Method's arguments.
- *
- * **IMPORTANT**: Must be an array or primitive values as it is directly
- * used as a `useCallback` dependecy array.
- */
-args: C[K] extends (...args: any) => any ? Parameters<C[K]> : never, options?: {
-    performFetch?: boolean;
-    swr?: SWRConfiguration;
-}) => C[K] extends (...args: any) => any ? [Awaited<ReturnType<C[K]>> | Pending, SWRResponse<unknown, unknown>] : never;

package/dist/useIsVisible.d.ts

@@ -1,4 +0,0 @@
-export declare function useIsVisible<T extends HTMLElement>(initialState?: boolean, options?: IntersectionObserverInit): {
-    ref: import('react').RefObject<T | null>;
-    isVisible: boolean;
-};

package/dist/utm.d.ts

@@ -1,58 +0,0 @@
-/**
- * Full UTM configuration object.
- */
-export type UtmParams = {
-    /**
-     * The website/platform the visitor is coming from.
-     */
-    source: string;
-    /**
-     * The type of marketing channel (e.g. cpc, email, affiliate, social,
-     * or similar).
-     */
-    medium: string;
-    /**
-     * The name of the campaign or product description. In our case, this is
-     * usually the name of the app.
-     */
-    campaign: string;
-    /**
-     * Optionally, provide an identifier for the place from which the link was
-     * clicked. E.g. footer, join, etc.
-     */
-    content?: string;
-    /**
-     * Optionally, identify paid keywords. We usually do not use this.
-     */
-    term?: string;
-};
-/**
- * UTM Params configuration that is appropriate to set at the link level,
- * if app-level defaults have been set.
- */
-export type LinkUtmParams = Pick<UtmParams, "content" | "term">;
-/**
- * Returns URL Search params with provided UTM configuration.
- *
- * Most of the time, you probably want to set up some defaults using
- * {@link createUtm}. This function is intended for special cases.
- */
-export declare function utm(params: UtmParams): URLSearchParams;
-/**
- * A factory for the {@link utm} function. Use it to set sensible defaults for
- * further use of the returned function.
- *
- * @example
- * ```ts
- * const utm = createUtm({
- *   source: "indietabletopclub",
- *   medium: "referral",
- *   campaign: "spacegitsapp",
- * });
- *
- * utm() // => URLSearchParams that inlude the above config
- *
- * utm({ campaign: "foo", content: "bar" }) // Sets optional fiels and overrides
- * ```
- */
-export declare function createUtm(defaults: UtmParams): (params?: Partial<UtmParams>) => URLSearchParams;

package/dist/utm.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/validations.d.ts

@@ -1,3 +0,0 @@
-export declare const EMAIL_REGEX: RegExp;
-export declare const validEmail: (value: string) => "This doesn't look like a valid email." | null;
-export declare const validPassword: (value: string) => "A password has to be at least 8 characters long." | "A password cannot be longer than 256 characters." | null;

package/dist/vars.css.d.ts

@@ -1,10 +0,0 @@
-export declare const Color: {
-    GRAY: `var(--${string})`;
-    MID_GRAY: `var(--${string})`;
-    LIGHT_GRAY: `var(--${string})`;
-    PALE_GRAY: `var(--${string})`;
-    PURPLE: `var(--${string})`;
-};
-export declare const ZIndex: {
-    DIALOG: `var(--${string})`;
-};