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

Collection improvements #275

Closed Southclaws closed 2 weeks ago

vercel[bot] commented 2 weeks 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 Nov 2, 2024 6:17pm
1 Skipped Deployment | Name | Status | Preview | Comments | Updated (UTC) | | :--- | :----- | :------ | :------- | :------ | | **storyden-homepage** | ⬜️ Ignored ([Inspect](https://vercel.com/southclaws-projects/storyden-homepage/HN8HqsPnpBaDSAj27PzMB25LTEok)) | [Visit Preview](https://storyden-homepage-git-collection-imp-2624c4-southclaws-projects.vercel.app) | | Nov 2, 2024 6:17pm |
coderabbitai[bot] commented 2 weeks ago

[!CAUTION]

Review failed

The pull request is closed.

📝 Walkthrough ## Walkthrough The changes in this pull request involve a comprehensive overhaul of the collection management system, focusing on the transition from `CollectionID` to `QueryKey` for identifying collections. Key modifications include the introduction of a `Mark` field in the `Collection` struct, the removal of various item-related types and functions, and the addition of a `Cover` field. The updates extend to multiple components and services, enhancing the handling of collections, including their creation, querying, and deletion, while introducing new types and methods for improved data management. ## Changes | File Path | Change Summary | |--------------------------------------------|----------------------------------------------------------------------------------------------------| | app/resources/collection/collection.go | Removed `CollectionID` type and `String()` method; added `Mark` field; reorganized fields; added `Cover` field; removed `CollectionItem` and related types/methods. | | app/resources/collection/collection_item/item.go | Updated `UpdateItems` and `ProbeItem` methods to use `QueryKey` instead of `CollectionID`. | | app/resources/collection/collection_querier/querier.go | Updated `Get` and `Probe` methods to accept `QueryKey` instead of `CollectionID`. | | app/resources/collection/collection_writer/writer.go | Updated methods to use `QueryKey` and added `WithCoverImage` method for setting cover asset ID. | | app/resources/collection/item.go | Introduced `CollectionItem`, `CollectionItemStatus`, and related mapping functions. | | app/resources/collection/mark.go | Added `Mark` and `QueryKey` types with associated constructors and methods. | | app/services/collection/collection_item_manager/manager.go | Updated methods to use `QueryKey` instead of `CollectionID`. | | app/services/collection/collection_manager/manager.go | Updated methods to incorporate `slug` and use `QueryKey`. | | app/services/collection/collection_read/reader.go | Updated `GetCollection` method to accept `QueryKey`. | | app/transports/http/bindings/collections.go | Updated methods to use `collection.Mark` instead of `CollectionID`. | | internal/ent/client.go | Added `QueryCoverImage` method to `CollectionClient`. | | internal/ent/collection.go | Added `Slug` and `CoverAssetID` fields; updated methods for retrieval and assignment. | | internal/ent/collection/collection.go | Added new fields and constants related to `slug` and `cover_asset_id`. | | internal/ent/collection/where.go | Added new predicates for `slug` and `cover_asset_id`. | | internal/ent/collection_create.go | Added setter methods for `slug` and `cover_asset_id` in `CollectionCreate` and `CollectionUpsert`. | | internal/ent/collection_query.go | Added `withCoverImage` field and query methods for cover images. | | internal/ent/collection_update.go | Added methods to manage `slug` and `cover_image` edge in `CollectionUpdate`. | | internal/ent/er.html | Updated ERD to reflect new fields and relationships. | | internal/ent/migrate/schema.go | Added columns for `slug` and `cover_asset_id` in the collections table schema. | | internal/ent/schema/collection.go | Added new fields and edges related to `slug` and `cover_image`. | | tests/collection/items_test.go | Updated test function to reflect changes in parameter types. | | web/src/api/openapi-client/collections.ts | Renamed `collectionId` to `collectionMark` in multiple functions. | | web/src/api/openapi-schema/collectionCommonProps.ts | Updated types for `description` and `name`, added `slug`. | | web/src/api/openapi-schema/collectionDescription.ts | Added new type `CollectionDescription`. | | web/src/api/openapi-schema/collectionInitialProps.ts | Updated types for `description` and `name`, added `slug`. | | web/src/api/openapi-schema/collectionMutableProps.ts | Updated types for `description` and `name`, added `slug`. | | web/src/api/openapi-schema/collectionName.ts | Added new type alias `CollectionName`. | | web/src/api/openapi-schema/collectionSlug.ts | Added new type alias `CollectionSlug`. | | web/src/api/openapi-schema/index.ts | Added new exports for `collectionDescription`, `collectionName`, and `collectionSlug`. | | web/src/api/openapi-server/collections.ts | Renamed `collectionId` to `collectionMark` in multiple functions. | | web/src/components/collection/CollectionCard.tsx | Updated URL construction to use `collection.slug`. | | web/src/components/collection/CollectionMenu/CollectionMenu.tsx | Simplified deletion confirmation logic. | | web/src/components/collection/CollectionMenu/useCollectionMenu.ts | Updated to use `collection.slug` for permalink; simplified deletion handling. | | web/src/components/site/DeleteConfirmationMenuItem.tsx | Simplified props structure for deletion confirmation. | | web/src/lib/collection/mutation.ts | Made `session` optional in `useCollectionMutations`, updated collection creation logic. | | web/src/screens/collection/CollectionScreen.tsx | Updated URL construction and rendering logic for collection details. | ## Poem > In the fields where collections grow, > A new mark shines, a vibrant glow. > With slugs to guide, and images bright, > Our collections now take flight! > From IDs to keys, we've made the leap, > In code we trust, our changes deep! 🐇✨

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 , please review it.` - `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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@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 using 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. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration 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](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.