Southclaws / storyden

With a fresh new take on traditional bulletin board forum software, Storyden is a modern, secure and extensible platform for building communities.
https://www.storyden.org/
Mozilla Public License 2.0
93 stars 11 forks source link

'expose asset filename and enable adding assets to nodes via just a URL to copy from' #151

Closed Southclaws closed 4 months ago

vercel[bot] commented 4 months ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
storyden ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 11, 2024 10:18am
storyden-homepage ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 11, 2024 10:18am
coderabbitai[bot] commented 4 months ago
Walkthrough ## Walkthrough The changes introduce new asset handling capabilities across various parts of the application. The `fetcher.Service` interface now includes a `Copy` method for copying assets, which is utilized in the node service for handling asset sources. The OpenAPI bindings and web API schemas have been updated to support the inclusion of asset source URLs. This allows for better management of external media assets within the application. ## Changes | File(s) | Change Summary | |-------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------| | `app/services/hydrator/fetcher/fetcher.go` | Added `Copy` method to `Service` interface and renamed the `service` struct's `copy` method to `Copy`. | | `app/services/node/node.go` | Added `AssetSources` field to `Partial` struct and `fetcher.Service` to `service` struct; updated node operations.| | `app/transports/openapi/bindings/nodes.go` | Updated `NodeCreate` and `NodeUpdate` to handle `AssetSources`; added deserialization functions. | | `app/transports/openapi/bindings/utils.go` | Added `Filename` field to `openapi.Asset` struct in `serialiseAssetReference`. | | `web/src/api/openapi/schemas/asset.ts` | Added `filename` field to `Asset` interface. | | `web/src/api/openapi/schemas/assetSourceList.ts` | New file defining `AssetSourceList` type as an array of `AssetSourceURL` types. | | `web/src/api/openapi/schemas/assetSourceURL.ts` | New file defining `AssetSourceURL` type representing URLs of external media assets. | | `web/src/api/openapi/schemas/index.ts` | Exported `assetSourceList` and `assetSourceURL`. | | `web/src/api/openapi/schemas/nodeInitialProps.ts` | Added `asset_sources` field to `NodeInitialProps` interface. | | `web/src/api/openapi/schemas/nodeMutableProps.ts` | Added `asset_sources` field to `NodeMutableProps` interface. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant Client participant API participant NodeService participant FetcherService participant AssetStorage Client->>API: POST /nodes (with AssetSources) API->>NodeService: CreateNode(request) NodeService->>FetcherService: Copy(ctx, url) FetcherService->>AssetStorage: StoreAsset(url) AssetStorage-->>FetcherService: AssetReference FetcherService-->>NodeService: *asset.Asset NodeService-->>API: NodeCreatedResponse API-->>Client: NodeCreatedResponse ``` ## Poem > In code we trust, to fetch and store, > New assets now, we can explore. > With URLs and sources bright, > Nodes gain new media, day and night. > Copy and bind, in harmony, > A tale of code, set assets free!

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
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.` - `@coderabbitai help me debug CodeRabbit configuration file.` 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 an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@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/schema.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.