feat: add optional fields

[thetutlage]

Optional fields are precursor to the default value. Since it doesn't make sense to assign a default value, unless the field is marked as optional.

Fixes: FRMW-2786

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
medusa-dashboard	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 19, 2024 10:42am

6 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
api-reference	⬜️ Ignored (Inspect)			Nov 19, 2024 10:42am
api-reference-v2	⬜️ Ignored (Inspect)	Visit Preview		Nov 19, 2024 10:42am
docs-ui	⬜️ Ignored (Inspect)	Visit Preview		Nov 19, 2024 10:42am
docs-v2	⬜️ Ignored (Inspect)	Visit Preview		Nov 19, 2024 10:42am
medusa-docs	⬜️ Ignored (Inspect)	Visit Preview		Nov 19, 2024 10:42am
resources-docs	⬜️ Ignored (Inspect)	Visit Preview		Nov 19, 2024 10:42am

[changeset-bot]

🦋 Changeset detected

Latest commit: fbbe385

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 65 packages

Name	Type
@medusajs/types	Patch
@medusajs/utils	Patch
@medusajs/dashboard	Patch
integration-tests-http	Patch
@medusajs/cli	Patch
@medusajs/medusa	Patch
@medusajs/test-utils	Patch
@medusajs/api-key	Patch
@medusajs/auth	Patch
@medusajs/cache-inmemory	Patch
@medusajs/cache-redis	Patch
@medusajs/cart	Patch
@medusajs/currency	Patch
@medusajs/customer	Patch
@medusajs/event-bus-local	Patch
@medusajs/event-bus-redis	Patch
@medusajs/file	Patch
@medusajs/fulfillment	Patch
@medusajs/index	Patch
@medusajs/inventory	Patch
@medusajs/link-modules	Patch
@medusajs/locking	Patch
@medusajs/notification	Patch
@medusajs/order	Patch
@medusajs/payment	Patch
@medusajs/pricing	Patch
@medusajs/product	Patch
@medusajs/promotion	Patch
@medusajs/region	Patch
@medusajs/sales-channel	Patch
@medusajs/stock-location	Patch
@medusajs/store	Patch
@medusajs/tax	Patch
@medusajs/user	Patch
@medusajs/workflow-engine-inmemory	Patch
@medusajs/workflow-engine-redis	Patch
@medusajs/auth-emailpass	Patch
@medusajs/auth-github	Patch
@medusajs/auth-google	Patch
@medusajs/file-local	Patch
@medusajs/file-s3	Patch
@medusajs/fulfillment-manual	Patch
@medusajs/locking-postgres	Patch
@medusajs/locking-redis	Patch
@medusajs/notification-local	Patch
@medusajs/notification-sendgrid	Patch
@medusajs/payment-stripe	Patch
@medusajs/core-flows	Patch
@medusajs/framework	Patch
@medusajs/js-sdk	Patch
@medusajs/modules-sdk	Patch
@medusajs/orchestration	Patch
@medusajs/workflows-sdk	Patch
@medusajs/medusa-oas-cli	Patch
@medusajs/oas-github-ci	Patch
@medusajs/telemetry	Patch
@medusajs/admin-bundler	Patch
@medusajs/admin-sdk	Patch
@medusajs/admin-shared	Patch
@medusajs/admin-vite-plugin	Patch
@medusajs/icons	Patch
@medusajs/toolbox	Patch
@medusajs/ui-preset	Patch
create-medusa-app	Patch
medusa-dev-cli	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[thetutlage]

CC @shahednasser for documentation.

You can now make fields optional using DML using the optional modifier.

model.define('Product', {
  title: model.string(),
  handle: model.string().optional()
})

How is it different from nullable?

The nullable fields are marked as nullable within the database and they should be defined as null when no value is provided. Whereas, optional fields can be undefined/missing altogether.

// With nullable
const product = {
  handle: null
}

// With optional
const product = {
  handle: undefined
}