Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: cleanup and add tests #82

Merged
merged 13 commits into from
Apr 10, 2024
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
100 changes: 70 additions & 30 deletions apps/react/app/App.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ import {
Document,
Sheet,
} from '@flatfile/react'
import React, { useState } from 'react'
import React, { useEffect, useState } from 'react'
import styles from './page.module.css'
import { recordHook } from '@flatfile/plugin-record-hook'

import api from '@flatfile/api'
import { config } from '../../../packages/cli/src/config'

const sleep = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms))

Expand All @@ -25,10 +25,8 @@ const App = () => {
const [label, setLabel] = useState('Rock')

useListener((listener) => {
// currentListener
listener.on('**', (event) => {
console.log('FFApp useListener Event => ', event.topic)
// Handle the workbook:deleted event
})
}, [])

Expand All @@ -41,11 +39,11 @@ const App = () => {

useListener((client) => {
client.use(
recordHook('contacts', (record) => {
recordHook('contacts2', (record) => {
const firstName = record.get('firstName')
console.log({ firstName })
// Gettign the real types here would be nice but seems tricky
record.set('email', 'Rock')

record.set('lastName', 'Rock')
return record
})
)
Expand All @@ -60,12 +58,10 @@ const App = () => {
[label]
)

useEvent('workbook:created', (event) => {
console.log('workbook:created', { event })
})

useEvent('*:created', (event) => {
console.log({ topic: event.topic })
useEvent('space:created', async ({ context: { spaceId } }) => {
console.log('workbook:created')
const { data: space } = await api.spaces.get(spaceId)
console.log({ space })
bangarang marked this conversation as resolved.
Show resolved Hide resolved
})

useEvent('job:ready', { job: 'sheet:submitActionFg' }, async (event) => {
Expand Down Expand Up @@ -102,9 +98,24 @@ const App = () => {
}
})

const listenerConfig = (label: string) => {
setLabel(label)
}
useEvent(
'document:created',
async ({ context: { spaceId, documentId } }) => {
const updatedSpace = await api.spaces.update(spaceId, {
metadata: {
sidebarConfig: {
showSidebar: true,
defaultPage: {
documentId,
},
},
},
})
console.log({ updatedSpace })
},
[]
)
bangarang marked this conversation as resolved.
Show resolved Hide resolved

return (
<div className={styles.main}>
<div className={styles.description}>
Expand All @@ -115,11 +126,12 @@ const App = () => {
>
{open ? 'CLOSE' : 'OPEN'} PORTAL
</button>
<button onClick={() => listenerConfig('blue')}>blue listener</button>
<button onClick={() => listenerConfig('green')}>green listener</button>
<button onClick={() => setLabel('blue')}>blue listener</button>
<button onClick={() => setLabel('green')}>green listener</button>
bangarang marked this conversation as resolved.
Show resolved Hide resolved
</div>
<Space
config={{
name: "Alex's Space",
metadata: {
sidebarConfig: {
showSidebar: true,
Expand All @@ -129,26 +141,54 @@ const App = () => {
>
<Document config={document} />
<Workbook
config={workbook}
onSubmit={(sheet) => {
console.log('onSubmit', { sheet })
config={{ ...workbook, name: "ALEX'S WORKBOOK" }}
onSubmit={async (sheet) => {
console.log('on Workbook Submit ', { sheet })
}}
onRecordHooks={[
[
'**',
(record) => {
record.set('email', 'TEST SHEET RECORD')
record.set('email', 'SHEET 1 RECORDHOOKS')
return record
},
],
[
(record) => {
record.set('email', 'SHEET 2 RECORDHOOKS')
return record
},
],
]}
/>
{/* <Sheet
config={workbook.sheets![0]}
onSubmit={(sheet) => {
console.log('onSubmit', { sheet })
}}
/> */}
>
<Sheet
config={{
...workbook.sheets![0],
slug: 'contacts3',
name: 'Contacts 3',
}}
onRecordHook={(record) => {
record.set('email', 'SHEET 3 RECORDHOOK')
return record
}}
onSubmit={async (sheet) => {
console.log('onSubmit from Sheet 3', { sheet })
}}
/>
<Sheet
config={{
...workbook.sheets![0],
slug: 'contacts4',
name: 'Contacts 4',
}}
onRecordHook={(record) => {
record.set('email', 'SHEET 4 RECORDHOOK')
return record
}}
onSubmit={(sheet) => {
console.log('onSubmit from Sheet 4', { sheet })
}}
/>
</Workbook>
</Space>
</div>
)
Expand Down
22 changes: 1 addition & 21 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion packages/embedded-utils/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
},
"dependencies": {
"@flatfile/api": "^1.7.11",
"@flatfile/listener": "^1.0.0",
"@flatfile/listener": "^1.0.1",
"@flatfile/util-common": "^1.1.0",
"pubnub": "^7.2.2"
},
Expand Down
2 changes: 1 addition & 1 deletion packages/embedded-utils/src/types/Space.ts
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ export interface SimpleOnboarding extends NewSpaceFromPublishableKey {
sheet?: any
job?: any
event?: FlatfileEvent
}) => void
}) => Promise<void> | void
onRecordHook?: (
record: FlatfileRecord<TRecordDataWithLinks<TPrimitive>>,
event?: FlatfileEvent
Expand Down
2 changes: 1 addition & 1 deletion packages/listener/src/events/event.handler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ export class EventHandler extends AuthenticatedClient {
event: FlatfileEvent | Flatfile.Event | any
): Promise<void> {
if (!event) return
const eventPayload = event.src ? event.src : event
const eventPayload = event.src || event

event = new FlatfileEvent(eventPayload, this._accessToken, this._apiUrl)

Expand Down
18 changes: 0 additions & 18 deletions packages/react/index.html

This file was deleted.

6 changes: 5 additions & 1 deletion packages/react/src/components/Document.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@ import { useCallback, useContext } from 'react'
import type { Flatfile } from '@flatfile/api'
import { useDeepCompareEffect } from '../utils/useDeepCompareEffect'

export const Document = (props: { config: Flatfile.DocumentConfig }) => {
type DocumentProps = {
config: Flatfile.DocumentConfig
}

export const Document = (props: DocumentProps) => {
const { config } = props
const { updateDocument } = useContext(FlatfileContext)

Expand Down
17 changes: 17 additions & 0 deletions packages/react/src/components/FlatfileContext.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,23 @@ type ReUseSpace = Partial<Flatfile.SpaceConfig> & {
id: string
accessToken: string
}

export const DEFAULT_CREATE_SPACE = {
document: undefined,
workbook: {
name: 'Embedded Workbook',
sheets: [],
},
space: {
name: 'Embedded Space',
labels: ['embedded'],
namespace: 'portal',
metadata: {
sidebarConfig: { showSidebar: false },
},
},
}

export interface FlatfileContextType {
publishableKey?: string
environmentId?: string
Expand Down
35 changes: 16 additions & 19 deletions packages/react/src/components/FlatfileProvider.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import React, { useEffect, useState } from 'react'
import FlatfileContext from './FlatfileContext'
import FlatfileContext, { DEFAULT_CREATE_SPACE } from './FlatfileContext'
import FlatfileListener, { Browser } from '@flatfile/listener'
import { Flatfile } from '@flatfile/api'
import { EmbeddedIFrameWrapper } from './EmbeddedIFrameWrapper'
Expand All @@ -24,32 +24,18 @@ export const FlatfileProvider: React.FC<ExclusiveFlatfileProviderProps> = ({
document: Flatfile.DocumentConfig | undefined
workbook: Flatfile.CreateWorkbookConfig
space: Flatfile.SpaceConfig
}>({
document: undefined,
workbook: {
name: 'Embedded Workbook',
sheets: [],
},
space: {
name: 'Embedded Space',
labels: ['embedded'],
namespace: 'portal',
metadata: {
sidebarConfig: { showSidebar: false },
},
},
})
}>(DEFAULT_CREATE_SPACE)

const addSheet = (newSheet: Flatfile.SheetConfig) => {
setCreateSpace((prevSpace) => {
// Check if the sheet already exists
const sheetExists = prevSpace.workbook.sheets?.some(
(sheet: any) => sheet.slug === newSheet.slug
(sheet) => sheet.slug === newSheet.slug
)
if (sheetExists) {
return prevSpace // Return the state unchanged if the sheet exists
return prevSpace
}
// Add the new sheet if it doesn't exist

return {
...prevSpace,
workbook: {
Expand Down Expand Up @@ -88,6 +74,15 @@ export const FlatfileProvider: React.FC<ExclusiveFlatfileProviderProps> = ({
workbook: {
...prevSpace.workbook,
...workbookUpdates,
// Prioritize order of sheets passed along in the Workbook.config then subsequent <Sheet config /> components
actions: [
...(workbookUpdates.actions || []),
...(prevSpace.workbook.actions || []),
],
sheets: [
...(workbookUpdates.sheets || []),
...(prevSpace.workbook.sheets || []),
],
},
}))
}
Expand Down Expand Up @@ -118,13 +113,15 @@ export const FlatfileProvider: React.FC<ExclusiveFlatfileProviderProps> = ({
listener.dispatchEvent(flatfileEvent)
}

// Listen to the postMessage event from the created iFrame
useEffect(() => {
window.addEventListener('message', handlePostMessage, false)
return () => {
window.removeEventListener('message', handlePostMessage)
}
}, [listener])

// Mount the event listener to the FlatfileProvider
useEffect(() => {
if (listener && internalAccessToken) {
listener.mount(
Expand Down
Loading
Loading