[pull] develop from medusajs:develop

[pull]

See Commits and Changes for more details.

---

Created by pull[bot] (v2.0.0-alpha.1)

Can you help keep this open source service alive? 💖 Please sponsor : )

Summary by Sourcery

Update type handling in Medusa services to support relationships and improve developer experience. Add a GitHub workflow to automatically generate documentation preparation files. Fix a documentation error and a bug related to relationship handling in services.

Bug Fixes:

• Allow relationships to accept IDs as valid values when creating or updating entities using module services

Enhancements:

• Improve type hinting for model properties in Medusa services to include relationships and foreign keys
• Add support for many-to-many and has-many relationships in Medusa services

CI:

• Add a workflow to automatically generate documentation preparation files when changes are made to the documentation in the www directory

Documentation:

• Correct the command for installing dependencies in the documentation for updating Medusa to npm install from npm run install

Tests:

• Update tests to reflect changes in Medusa service typings and relationship handling

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request includes updates to Medusa service typings to handle relationships correctly, documentation fixes, a new GitHub workflow for documentation preparation, and a changeset for patching @medusajs/types and @medusajs/utils.

Updated class diagram for Medusa service typings

classDiagram
    class DmlEntity {

    }
    class InferSchemaFields
    class InferEntityType
    class InferEntityForModuleService

    DmlEntity <|-- InferSchemaFields : Uses
    DmlEntity <|-- InferEntityType : Uses
    DmlEntity <|-- InferEntityForModuleService : Uses

    InferEntityType --|> InferSchemaFields : Extends
    InferEntityForModuleService --|> InferSchemaFields : Extends

    note for InferEntityForModuleService "Modified to handle relationships correctly"

Loading

File-Level Changes

Change	Details	Files
Updated Medusa service typings to correctly handle relationships and DTOs for module services.	Added definitions for Tag, Comment, and User models to test relationships. Modified BlogService to include the Comment model. Updated type expectations for createBlogs and createComments to include relationship properties like comments and tags. Adjusted type expectations for updateBlogs to handle relationship properties correctly. Introduced InferSchemaFieldsForModuleServices type to infer schema fields for module services, handling relationship types. Modified inputDto type in ModelConfigurationsToConfigTemplate to use InferEntityForModuleService for DML entities.	packages/core/utils/src/modules-sdk/__tests__/medusa-service-typings.spec.ts packages/core/types/src/dml/index.ts packages/core/utils/src/modules-sdk/types/medusa-service.ts
Fixed typos in documentation and added a new GitHub workflow.	Corrected typos in the npm install command within the documentation. Added a new GitHub workflow to automatically generate documentation preparation files when changes are made to the documentation. The workflow installs workspace dependencies, builds packages, and runs yarn prep in the book and resources apps. The workflow commits and pushes the changes if any files are generated.	www/apps/book/app/learn/update/page.mdx .github/workflows/generate-doc-files.yml
Created a changeset to patch @medusajs/types and @medusajs/utils.	Added a changeset file to indicate a patch change to the @medusajs/types and @medusajs/utils packages. The changeset indicates that the patch fixes relationships to accept IDs.	.changeset/great-badgers-play.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.