@tight-embedded/react 1.0.0-alpha.0

package/dist/index.d.ts

@@ -0,0 +1,81 @@
+import { JSX } from 'react/jsx-runtime';
+import { PropsWithChildren } from 'react';
+
+export declare function BusinessOwnerDashboard(props: BusinessOwnerDashboardProps): JSX.Element;
+
+declare type BusinessOwnerDashboardProps = {
+    period?: Period;
+    onChangePeriod?: (period: Period) => void;
+};
+
+export declare type Environment = ValueOf<typeof Environments>;
+
+declare const Environments: {
+    readonly PRODUCTION: "PRODUCTION";
+    readonly SANDBOX: "SANDBOX";
+};
+
+declare type ExternalOptions = {
+    dataVisualizationColors?: string[];
+};
+
+declare type ObjectKey = string | number | symbol;
+
+declare type OptionSetter = (options: Partial<ExternalOptions>, replace?: boolean) => void;
+
+declare type Period = {
+    month: number;
+    year: number;
+};
+
+export declare function Tight({ children, environment, accessToken }: TightProps): JSX.Element;
+
+declare type TightProps = PropsWithChildren<{
+    environment: Environment;
+    accessToken: string;
+}>;
+
+/**
+ * Set library-wide options for various components.
+ *
+ * For Developers:
+ * This hook subscribes a component to Tight Embedded's option store, which is shared across all Tight Components
+ * The initial options passed into the hook will be set as the value of options on the hook's first render.
+ * When a component modifies these options by calling setOptions, all subscribed components will re-render with the new options
+ *
+ * @param initialOptions - options to pass into the store on first render of this hook.
+ *
+ * @example
+ * ```TypeScript
+ * const { options, setOptions } = useOptions({ accessToken: "my-token" })
+ *
+ * <button onClick={() => setOptions(someValue)} />
+ * ```
+ */
+export declare function useOptions(initialOptions?: Partial<ExternalOptions>): {
+    options: ExternalOptions;
+    setOptions: OptionSetter;
+};
+
+/**
+ * A type for making string unions out of faux enum 'as const' objects or extracting element types from arrays
+ * Usage with objects:
+ * ```
+ * const MyObject = {
+ *   EntryOne: "ENTRY_ONE",
+ *   EntryTwo: "ENTRY_TWO",
+ *   EntryThree: "ENTRY_THREE",
+ * } as const;
+ *
+ * type MyType = ValueOf<typeof MyObject>;
+ * // "ENTRY_ONE" | "ENTRY_TWO" | "ENTRY_THREE"
+ * ```
+ *
+ * Usage with arrays:
+ * ```
+ * type MyArray = ValueOf<string[]>;
+ * // string
+ * ```
+ */
+declare type ValueOf<T> = T extends Array<infer U> ? U : (T extends Record<ObjectKey, unknown> ? T[keyof T] : never);
+