@simoncomputing/mui-bueno-v3 0.1.14 → 0.1.15

package/README.md

@@ -24,6 +24,75 @@ npm install mui-bueno-v3
 </MForm>
 ```
 
+## Running the Library Locally
+
+To test locally before submitting to NPM, perform the following:
+
+```shell
+
+rm -rf dist
+npm run build:lib
+npm pack
+
+# will output something like: simoncomputing-mui-bueno-v3-0.1.14.tgz
+```
+
+In the application repo:
+
+```shell
+# Update package to look for this file in the proper directory.
+npm i ~/git/mui-bueno-v3/simoncomputing-mui-bueno-v3-0.1.15.tgz
+
+# Install
+npm install
+
+## If you want a clean reinstall
+rm -rf node_modules package-lock.json
+npm install
+```
+
+## Deploying to NPM
+
+#### Get an NPM Account
+
+1. Request an account from Simon, indicate you want to deploy mui-bueno-v3.
+
+#### Log into NPM
+
+1. At command line, type: `npm login`
+1. You'll be prompted to press enter to open the browser.
+1. Finish your login process.
+1. You can now confirm you're logged in:
+
+```shell
+
+# This should identify your user ID
+npm whoami
+
+# Logout
+npm logout
+
+# Running whoami again should return an error
+npm whoami
+
+# Log back in
+npm login
+```
+
+#### Run the build
+
+Go into `package.json` and set `private` to `false`. Don't check this in as this is safety against accidental deployment.
+
+```shell
+# Test with dry run
+npm run publishLib:dryrun
+
+# Run actual deployment
+npm run publishLib
+```
+
+Undo your change to `package.json`
+
 ## Documentation & Demo
 
 This project uses Storybook to document and demonstrate the components. _URL COMING SOON._

package/dist/@types/index.d.ts

@@ -190,3 +190,5 @@ export type UnsavedCitation = {
 export type UnsavedAttachment = {
     file?: File;
 } & UnsavedCitation;
+
+export type StoryFormValues = Record<string, any>;

package/dist/components/Form/MForm/MForm.d.ts

@@ -1,19 +1,24 @@
+import { default as React } from 'react';
 import { SubmitHandler, FieldValues, DefaultValues, FieldErrors, UseFormSetValue, UseFormReturn } from 'react-hook-form';
 import { AnyObjectSchema } from 'yup';
+type MFormChildProps<T extends FieldValues> = {
+    values: T;
+    setValue: UseFormSetValue<T>;
+    methods: UseFormReturn<T>;
+};
 type MFormProps<T extends FieldValues> = Readonly<{
     initialValues: DefaultValues<T>;
     initialErrors?: FieldErrors<T>;
-    onSubmit: SubmitHandler<T>;
-    children: React.ReactNode | ((props: {
-        values: T;
-        setValue: UseFormSetValue<T>;
-        methods: UseFormReturn<T>;
-    }) => React.ReactNode);
+    onSubmit: SubmitHandler<T> | ((values: T) => Promise<void>);
+    children: React.ReactNode | ((props: MFormChildProps<T>) => React.ReactNode);
     validationSchema?: AnyObjectSchema;
     shouldValidateOption?: boolean;
     shouldDirtyOption?: boolean;
     validationOnMount?: boolean;
     enableReinitialize?: boolean;
+    /** Automatically catch and apply 422 server errors (Axios-style). */
+    applyAxios422Errors?: boolean;
+    submitRef?: React.RefObject<(() => Promise<void>) | null>;
 }>;
-export declare function MForm<T extends FieldValues>({ initialValues, onSubmit, children, initialErrors, validationSchema, shouldValidateOption, shouldDirtyOption, validationOnMount, enableReinitialize }: MFormProps<T>): import("react/jsx-runtime").JSX.Element;
+export declare function MForm<T extends FieldValues>({ initialValues, onSubmit, children, initialErrors, validationSchema, shouldValidateOption, shouldDirtyOption, validationOnMount, enableReinitialize, applyAxios422Errors, submitRef, }: MFormProps<T>): import("react/jsx-runtime").JSX.Element;
 export default MForm;

package/dist/components/Form/MForm/MFormContext.d.ts

@@ -0,0 +1,8 @@
+import * as React from 'react';
+export type ServerErrorMap = Record<string, string>;
+type MFormCtx = {
+    applyServerErrors: (errors: ServerErrorMap, focusFirst?: boolean) => void;
+};
+export declare const MFormContext: React.Context<MFormCtx | null>;
+export declare function useMForm(): MFormCtx;
+export {};