FlatFilers / Guides

Flatfile's Documentation
7 stars 20 forks source link

feat: remove env id required #1124

Closed ashleygmulligan2 closed 2 months ago

ashleygmulligan2 commented 3 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

The overarching change involves the removal of the environmentId parameter across various functionalities and files in the Flatfile integration. This simplification affects event handlers, API calls, and initialization processes, streamlining the setup and usage of Flatfile by focusing on the publishableKey and other context-specific parameters. This change aims to simplify the developer experience and reduce the complexity of integrating Flatfile into applications.

Changes

Files Change Summary
.../guest_sidebar/block1.mdx, .../namespaces/block1.mdx Removed environmentId from context in flatfileEventListener, affecting metadata updates and API calls.
.../namespaces/block2.mdx Removed environmentId from CreateWorkbookConfig in Team Orange namespace.
.../theming/block1.mdx Adjusted event listeners for theme settings updates and job event handling.
.../embedded_listener.mdx, .../embedded_listener_basicreact.mdx Modified openFlatfile to require only publishableKey; removed environmentId from flatfileOptions.
.../headless/block1.mdx, .../headless/block2.mdx Removed environmentId from objects in api.spaces.create and api.files.upload.
apps/custom/deploying.mdx, apps/custom/meet-the-listener.mdx Updated deployment instructions and removed FLATFILE_ENVIRONMENT_ID update instructions.
apps/custom/meet-the-workbook.mdx Modified event handling logic in flatfileEventListener.
apps/embedding/.../new_space.mdx (angular, javascript, react, vue) Removed environmentId requirement during initialization in various frameworks.
apps/embedding/.../new_space_quickstart.mdx (angular, react) Focused on setting publishableKey only for initialization.
apps/embedding/.../reuse_space.mdx (angular, vue) Removed environmentId property from spaceProps object.
apps/embedding/portal-and-excel.mdx Updated server-side listener setup instructions.
apps/embedding/reference/... (common.mdx, simple.mdx) Removed environmentId from flatfileOptions and updated descriptions.
changelog/sdks.mdx Modified secrets cache creation to be based on spaceId instead of environmentId and spaceId.
developer-tools/deploying.mdx, developer-tools/developing/running-local.mdx Removed environmentId field from spaceProps and updated environment variable setup.
guides/localization.mdx, guides/metadata.mdx Simplified language override logic and removed environmentId from API calls.
upgrade/v2_upgrade.mdx, upgrade/v2_upgrade_concepts.mdx Removed requirement for environmentId in openFlatfile and related configurations.

Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.