feat(storage-browser): add storage browser (#6175)

Co-authored-by: Chris F <[email protected]> Co-authored-by: Jordan Van Ness <[email protected]> Co-authored-by: Scott Rees <[email protected]> Co-authored-by: Pranav Malewadkar <[email protected]> Co-authored-by: ManojNB <[email protected]> Co-authored-by: Jim Blanchard <[email protected]> Co-authored-by: Hui Zhao <[email protected]> Co-authored-by: Hui Zhao <[email protected]> Co-authored-by: Ashwin Kumar <[email protected]> Co-authored-by: Ashwin Kumar <[email protected]> Co-authored-by: ashika112 <[email protected]> Co-authored-by: Danny Banks <[email protected]> Co-authored-by: dindjarinjs <[email protected]> Co-authored-by: AllanZhengYP <[email protected]> Co-authored-by: Joon Choi <[email protected]> Co-authored-by: Dustin <[email protected]> Co-authored-by: Chris Fang <[email protected]>
aws-amplify · Nov 20, 2024 · 70971f3 · 70971f3
1 parent 526b0f3
commit 70971f3
Show file tree

Hide file tree

Showing 516 changed files with 31,072 additions and 678 deletions.
diff --git a/.changeset/sto-bro-release.md b/.changeset/sto-bro-release.md
@@ -0,0 +1,45 @@
+---
+"@aws-amplify/ui-react-storage": minor
+"@aws-amplify/ui-react": minor
+"@aws-amplify/ui-react-core": minor
+"@aws-amplify/ui": minor
+---
+
+feat(storage-browser): add `StorageBrowser` and `createStorageBrowser`
+
+```tsx
+import { Amplify } from 'aws-amplify';
+
+import { StorageBrowser } from '@aws-amplify/ui-react-storage';
+import '@aws-amplify/ui-react-storage/styles.css';
+
+import config from './aws-exports';
+
+Amplify.configure(config);
+
+function App() {
+  return <StorageBrowser />
+}
+```
+
+```tsx
+import { Amplify } from 'aws-amplify';
+
+import {
+  createAmplifyAuthAdapter,
+  createStorageBrowser,
+} from '@aws-amplify/ui-react-storage/browser';
+import '@aws-amplify/ui-react-storage/styles.css';
+
+import config from './aws-exports';
+
+Amplify.configure(config);
+
+const { StorageBrowser } = createStorageBrowser({
+  config: createAmplifyAuthAdapter(),
+});
+
+function App() {
+  return <StorageBrowser />
+}
+```
diff --git a/docs/__tests__/__snapshots__/props-table.test.ts.snap b/docs/__tests__/__snapshots__/props-table.test.ts.snap
@@ -770,7 +770,7 @@ exports[`Props Table 1`] = `
                     },
                     "errorMessage": {
                         "name": "errorMessage",
-                        "type": "string | undefined",
+                        "type": "React.ReactNode",
                         "description": " When defined and \`hasError\` is true, show error message",
                         "category": "BaseFieldProps",
                         "isOptional": true
@@ -2692,7 +2692,7 @@ exports[`Props Table 1`] = `
                     },
                     "errorMessage": {
                         "name": "errorMessage",
-                        "type": "string | undefined",
+                        "type": "React.ReactNode",
                         "description": " When defined and \`hasError\` is true, show error message",
                         "category": "BaseFieldProps",
                         "isOptional": true
@@ -7317,7 +7317,7 @@ exports[`Props Table 1`] = `
                     },
                     "errorMessage": {
                         "name": "errorMessage",
-                        "type": "string | undefined",
+                        "type": "React.ReactNode",
                         "description": " When defined and \`hasError\` is true, show error message",
                         "category": "BaseFieldProps",
                         "isOptional": true
@@ -7679,7 +7679,7 @@ exports[`Props Table 1`] = `
                     },
                     "errorMessage": {
                         "name": "errorMessage",
-                        "type": "string | undefined",
+                        "type": "React.ReactNode",
                         "description": " When defined and \`hasError\` is true, show error message",
                         "category": "BaseFieldProps",
                         "isOptional": true
@@ -8326,7 +8326,7 @@ exports[`Props Table 1`] = `
                     },
                     "errorMessage": {
                         "name": "errorMessage",
-                        "type": "string | undefined",
+                        "type": "React.ReactNode",
                         "description": " When defined and \`hasError\` is true, show error message",
                         "category": "BaseFieldProps",
                         "isOptional": true
@@ -9457,7 +9457,7 @@ exports[`Props Table 1`] = `
                     },
                     "errorMessage": {
                         "name": "errorMessage",
-                        "type": "string | undefined",
+                        "type": "React.ReactNode",
                         "description": " When defined and \`hasError\` is true, show error message",
                         "category": "BaseFieldProps",
                         "isOptional": true
@@ -9791,7 +9791,7 @@ exports[`Props Table 1`] = `
                     },
                     "errorMessage": {
                         "name": "errorMessage",
-                        "type": "string | undefined",
+                        "type": "React.ReactNode",
                         "description": " When defined and \`hasError\` is true, show error message",
                         "category": "BaseFieldProps",
                         "isOptional": true
@@ -10272,7 +10272,7 @@ exports[`Props Table 1`] = `
                     },
                     "errorMessage": {
                         "name": "errorMessage",
-                        "type": "string | undefined",
+                        "type": "React.ReactNode",
                         "description": " When defined and \`hasError\` is true, show error message",
                         "category": "BaseFieldProps",
                         "isOptional": true
@@ -10711,7 +10711,7 @@ exports[`Props Table 1`] = `
                     },
                     "errorMessage": {
                         "name": "errorMessage",
-                        "type": "string | undefined",
+                        "type": "React.ReactNode",
                         "description": " When defined and \`hasError\` is true, show error message",
                         "category": "BaseFieldProps",
                         "isOptional": true
@@ -11220,7 +11220,7 @@ exports[`Props Table 1`] = `
                     },
                     "errorMessage": {
                         "name": "errorMessage",
-                        "type": "string | undefined",
+                        "type": "React.ReactNode",
                         "description": " When defined and \`hasError\` is true, show error message",
                         "category": "BaseFieldProps",
                         "isOptional": true
@@ -13353,7 +13353,7 @@ exports[`Props Table 1`] = `
                     },
                     "errorMessage": {
                         "name": "errorMessage",
-                        "type": "string | undefined",
+                        "type": "React.ReactNode",
                         "description": " When defined and \`hasError\` is true, show error message",
                         "category": "BaseFieldProps",
                         "isOptional": true
@@ -13722,7 +13722,7 @@ exports[`Props Table 1`] = `
                     },
                     "errorMessage": {
                         "name": "errorMessage",
-                        "type": "string | undefined",
+                        "type": "React.ReactNode",
                         "description": " When defined and \`hasError\` is true, show error message",
                         "category": "BaseFieldProps",
                         "isOptional": true

diff --git a/docs/src/pages/[platform]/components/passwordfield/passwordFieldPropControls.tsx b/docs/src/pages/[platform]/components/passwordfield/passwordFieldPropControls.tsx
@@ -131,7 +131,7 @@ export const PasswordFieldPropControls: PasswordFieldPropControlsInterface = ({
         name="errorMessage"
         id="errorMessage"
         placeholder="set errorMessage"
-        value={errorMessage}
+        value={errorMessage as string}
         onChange={(event) => {
           setErrorMessage(
             event.target.value as PasswordFieldProps['errorMessage']

diff --git a/docs/src/pages/[platform]/components/selectfield/SelectFieldPropControls.tsx b/docs/src/pages/[platform]/components/selectfield/SelectFieldPropControls.tsx
@@ -116,7 +116,7 @@ export const SelectFieldPropControls: SelectFieldPropControlsInterface = ({
         label="errorMessage"
         name="errorMessage"
         placeholder="Specify error message"
-        value={errorMessage}
+        value={errorMessage as string}
         onChange={(event) =>
           setErrorMessage(
             event.target.value as SelectFieldProps['errorMessage']

diff --git a/docs/src/pages/[platform]/components/textareafield/TextAreaFieldPropControls.tsx b/docs/src/pages/[platform]/components/textareafield/TextAreaFieldPropControls.tsx
@@ -126,7 +126,7 @@ export const TextAreaFieldPropControls: TextAreaFieldControlsInterface = ({
       <TextField
         placeholder="Set error message"
         name="errorMessage"
-        value={errorMessage}
+        value={errorMessage as string}
         onChange={(event: any) => {
           setErrorMessage(event.target.value);
         }}

diff --git a/docs/storageMock.ts b/docs/storageMock.ts
@@ -5,8 +5,10 @@ import {
   getProperties,
   copy,
   getUrl,
+  isCancelError,
+  type UploadDataInput,
+  type UploadDataOutput,
 } from '@aws-amplify/storage';
-import type { UploadDataInput, UploadDataOutput } from '@aws-amplify/storage';
 
 type UploadData = (props: UploadDataInput) => UploadDataOutput;
 
@@ -66,4 +68,13 @@ const uploadData: UploadData = (props) => {
   };
 };
 
-export { uploadData, downloadData, copy, remove, list, getUrl, getProperties };
+export {
+  isCancelError,
+  uploadData,
+  downloadData,
+  copy,
+  remove,
+  list,
+  getUrl,
+  getProperties,
+};
diff --git a/examples/next/.env.example b/examples/next/.env.example
@@ -1,3 +1,10 @@
+NEXT_PUBLIC_BACKEND_API_URL=
 # Set this .env to the beta/gamma endpoints to test locally
 NEXT_PUBLIC_STREAMING_API_URL=
 NEXT_PUBLIC_BACKEND_API_REGION=
+NEXT_PUBLIC_DEBUG=
+
+# StorageBrowser Managed Auth
+NEXT_PUBLIC_MANAGED_AUTH_ACCOUNT_ID=
+NEXT_PUBLIC_MANAGED_AUTH_ENDPOINT=
+NEXT_PUBLIC_MANAGED_AUTH_REGION=
diff --git a/examples/next/.eslintrc b/examples/next/.eslintrc
@@ -1,3 +1,3 @@
 {
-  "extends": ["next", "next/babel", "next/core-web-vitals"]
+  "extends": ["next", "next/core-web-vitals"]
 }
diff --git a/examples/next/next-env.d.ts b/examples/next/next-env.d.ts
diff --git a/examples/next/pages/_document.page.tsx b/examples/next/pages/_document.page.tsx
@@ -20,8 +20,6 @@ class MyDocument extends Document {
         </Head>
         <body>
           <title>React Example App</title>
-          <h1>React Example App</h1>
-
           <Main />
           <NextScript />
         </body>