Shahed Nasser
00a51b59b1
docs: update imports of middlewares and http types ( #9440 )
2024-10-03 15:56:58 +00:00
Shahed Nasser
1bb3f8b5b1
docs: add a troubleshooting guide for dist imports ( #9442 )
2024-10-03 14:17:48 +03:00
Shahed Nasser
ab5a7ca691
docs: fix infinite scroll, update next.js, other fixes ( #9441 )
...
* update nextjs
* badge + scroll fixes
2024-10-03 14:17:33 +03:00
Shahed Nasser
97c193be1b
chore: add action to update starter dependencies + update reference actions ( #9385 )
...
* chore: add action to update starter dependencies
* change trigger type
* trigger generating references on new RC release
2024-10-03 10:21:12 +03:00
Shahed Nasser
a94f30ba97
chore(oas): add more details link to pagination and select fields ( #9414 )
...
find-and-replace to add a link to the pagination and field selection sections in parameters.
Closes DOCS-940
2024-10-02 18:41:51 +00:00
Shahed Nasser
0f6f56e764
docs: DX and performance improvements in API reference ( #9430 )
...
- Improve scroll behavior between active sections
- Improve lag when clicking on a sidebar item
- Refactor internal working of the `SidebarProvider` to find active items faster.
- Use Next.js's `useRouter` hook for changing the hash (since they added the option to disable scroll)
- Change `isBrowser` from a hook to a provider since it's widely used across applications.
- Other general improvements and fixes.
Closes DOCS-952
2024-10-02 15:51:02 +00:00
Shahed Nasser
5fb9c1f82e
chore(oas): general fixes to OAS ( #9413 )
...
General fixes to OAS
2024-10-02 15:21:40 +00:00
Shahed Nasser
cb5c228a36
fix(create-medusa-app): remove warnings on installation ( #9405 )
2024-10-02 13:27:13 +03:00
Shahed Nasser
7ce9121095
chore(types, utils): update the TSDocs of AbstractFulfillmentProviderService ( #9349 )
...
Updates the `AbstractFulfillmentProviderService` with TSDocs for more useful information and examples
Closes DOCS-950
2024-10-02 09:01:01 +00:00
Shahed Nasser
9811da2960
docs: fix query option in instrumentation ( #9395 )
2024-10-02 10:29:11 +03:00
Shahed Nasser
a662c4b020
fix(medusa-oas-cli): Fix incorrect import ( #9404 )
...
* fix(medusa-oas-cli): Fix incorrect import
* update redocly config
2024-10-02 10:28:42 +03:00
Shahed Nasser
7bc7c50eef
fix(types, medusa): http types fixes ( #9334 )
...
* fix(types, medusa): http types fixes
* fix build error
* remove return fields
* more fixes
* fix cart payload types
2024-10-02 10:28:22 +03:00
Shahed Nasser
8686ca9d12
docs: updates and fixes in utils + fulfillment provider changes ( #9347 )
...
* fix config + update deps
* rearrange sidebar + add to examples
2024-10-02 10:27:48 +03:00
Shahed Nasser
07afa8fba6
docs: fix how api reference shows any type ( #9340 )
2024-10-02 10:27:21 +03:00
Shahed Nasser
1e144e9c08
chore(oas): clean up oas ( #9354 )
...
* clean up generated oas
* fix issues in docs-util
* more fixes
* align max level
* validation fix
* add missing summaries
* fix validation
* fix exchanges route
2024-10-02 10:27:02 +03:00
Shahed Nasser
fb67d90b64
docs: improvements + additions to module docs ( #9152 )
...
- Split Module and Module Links to their own chapters
- Add new docs on db operations and transactions in modules, multiple services, links with custom columns, etc...
- Added a list of registered dependencies in a module container
2024-10-01 11:20:54 +00:00
Shahed Nasser
1ad7e7583f
docs: fix imports from dist ( #9401 )
2024-10-01 09:49:37 +00:00
Shahed Nasser
20943902f9
chore: update imports in tsdocs ( #9379 )
2024-10-01 11:04:03 +02:00
Shahed Nasser
2e16949979
docs: update imports and package names across docs ( #9375 )
...
* docs: update imports and package names across docs
+ reference configs
* generate files
* fix import
* change preview to rc
2024-10-01 11:03:42 +02:00
Shahed Nasser and Oli Juhl
74b3385a65
chore(oas): [21/21] improve oas schemas ( #9339 )
...
* improve oas
* more improvements
* add missing descriptions
---------
Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com >
2024-09-27 12:40:24 +02:00
Shahed Nasser
bd4d2fd554
docs-util: fixes following packages reorg ( #9326 )
...
- Typescript config aren't picked up properly anymore since they're moved to `_tsconfig.base.json` in the root. So, we now read the config from the config file.
- Update Typescript version in the `utils` monorepo to match that of the root monorepo
2024-09-26 17:22:08 +00:00
Shahed Nasser
229da19029
chore(oas): [20/n] improve oas schemas ( #9337 )
...
Improve oas schemas [20/n]
2024-09-26 17:21:07 +00:00
Shahed Nasser
be1adac024
chore(oas): [18/n] improve oas schemas ( #9311 )
...
Improve OAS schemas [18/n]
2024-09-26 14:08:10 +00:00
Shahed Nasser
af34bf6c0c
chore(oas): [19/n] improve oas schemas ( #9317 )
...
- Improve OAS schemas [19/n]
- docs-generator: combine `Date | string` type to just `Date`.
2024-09-26 13:44:57 +00:00
Shahed Nasser
5390c8a845
fix(create-medusa-app): fix publishable api key not saving in .env.local ( #9328 )
2024-09-26 16:43:40 +03:00
Shahed Nasser
b3a204e974
docs: document InferTypeOf ( #9321 )
...
- Add documentation on how to use InferTypeOf
- Use InferTypeOf in recipes and examples
2024-09-26 13:42:29 +00:00
Shahed Nasser
c5bf22f3f4
chore(oas): [17/n] improve OAS schemas ( #9284 )
...
Improve OAS schemas [17/n]
2024-09-26 13:07:07 +00:00
Shahed Nasser
39a6780815
docs: add note about authentication opt out ( #9298 )
...
Closes #9268
2024-09-26 13:04:27 +00:00
Shahed Nasser
97b72f4662
oas: [15/n] improve oas schemas ( #9216 )
...
Improve OAS schemas [15/n]
Note: validation error will be fixed once #9218 is merged
2024-09-26 13:03:41 +00:00
Shahed Nasser
d352ea8122
chore(oas): [16/n] improve oas schemas ( #9272 )
...
- Improve OAS schemas [16/n]
- fixes and improvements to docs-generator tool
2024-09-26 13:02:32 +00:00
Shahed Nasser
ea2cc974cc
docs: fixes to customization docs ( #9236 )
...
Closes #9225 , #9224 , #9226 , #9227
Closes DOCS-948, DOCS-947, DOCS-945, DOCS-946
2024-09-26 13:00:37 +00:00
Shahed Nasser
22b7a36d2a
fix(types): fix order DTO types ( #9323 )
...
- Fix claim / exchange / return extending an order (we previously addressed this in the http types)
- add `@ignore` for all `raw_*` fields to hide them from references.
2024-09-26 12:58:33 +00:00
Shahed Nasser
2da15ba021
docs: added architecture documentation ( #9256 )
...
* docs: added architecture documentation
* update diagrams and text
* address PR comments
* sidebar + overview fixes
2024-09-26 09:29:47 +03:00
Shahed Nasser
3533aa86e8
fix(types, medusa): fixes to HTTP types ( #9273 )
...
### types
- Remove `is_internal` and `is_active` from `StoreProductCategory`
- Add missing status, reference, and action enums from `BaseOrderChange` and `BaseOrderChangeAction`
- Remove unused totals from `BaseOrderSummary`.
- Fix references to base types from admin / store types
- Other general fixes
### medusa
- Use HTTP types for create / update return reason routes
- Remove type arguments from the calculate taxes route since it's a `POST` API route but the type argument for the select query parameters only.
- Add `metadata` to the list of cart's fields.
- Add type casting for order previews in response
2024-09-25 15:24:23 +00:00
Shahed Nasser
d7dd7de0fe
fix(types): remove BigNumberValue usages in http types ( #9285 )
...
remove all `BigNumberValue` usages in http types, since http requests will only receive a number.
2024-09-25 12:12:43 +00:00
Shahed Nasser
cebffc7a11
chore(oas): [13/n] improve oas schemas ( #9201 )
...
* chore(oas): [13/n] improve oas schemas
* remove tax region name
2024-09-22 14:50:26 +02:00
Shahed Nasser
c790af7834
docs: improve search to show results for all filters ( #9208 )
...
* docs: improve search to show results for all filters
* fix index ordering
2024-09-22 14:49:16 +02:00
Shahed Nasser
138523a629
docs: change navbar items + breadcrumb improvements ( #9209 )
...
- Add a new commerce module navbar item
- Rename Learning Resources to Development Resources (in navbar and across documentation content)
- Improve breadcrumbs to show categories / subcategories
Preview: https://resources-docs-git-docs-navbar-changes-medusajs.vercel.app/v2/resources
2024-09-22 12:47:35 +00:00
Shahed Nasser
ba14d4341f
fix(oas): handle new keys in circular reference patch ( #9218 )
...
Handle new keys in the circular references patch leading to undefined not being iterable error.
2024-09-22 12:44:23 +00:00
Shahed Nasser
6584e911e0
docs: improvements + additions to workflow docs ( #9182 )
...
Improve existing workflow docs + add missing docs
2024-09-20 15:38:32 +00:00
Shahed Nasser
a4b5d66b3e
docs: updates to digital product recipe ( #9165 )
...
- Create workflow for fulfilling digital products that sends a notification + create a shipment to mark the fulfillment as fulfilled / shipped.
- Update the subscriber handling the `digital_product_order.created` event to use the workflow
- Add section on using the local notification module provider for testing purposes.
2024-09-20 14:27:18 +00:00
Shahed Nasser
2f3d15de85
docs: fix attribute name in calculated price ( #9215 )
2024-09-20 17:22:35 +03:00
Shahed Nasser
6a2a105cf8
fix(oas): support additional props, fix circular references patch, and other fixes ( #9213 )
...
* chore(oas): support additional props, fix circular references patch, and other fixes
* fix description
* description fixes
2024-09-20 17:22:19 +03:00
Shahed Nasser
426c39c04b
chore(oas): [14/n] improve OAS schemas ( #9202 )
...
* chore(oas): [14/n] improve OAS schemas
* fix description of required_quantity
2024-09-19 18:52:46 +02:00
Shahed Nasser and Oli Juhl
d6ce0688db
chore(oas): [10/n] improve oas schemas ( #9167 )
...
* chore(oas): [10/n] improve oas schemas
* fix validation error
---------
Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com >
2024-09-19 18:51:55 +02:00
Shahed Nasser
230a16ac5c
fix(types): fixes to HTTP types ( #9189 )
...
* fix(types): fixes to HTTP types
* more fixes
* remove incorrect fields for tax regions
2024-09-19 18:35:53 +02:00
Shahed Nasser
4923a6e823
chore(oas): [12/n] improve oas schemas ( #9200 )
...
- improve OAS schemas [12/n]
- Support ignoring properties in type if it has the `@ignore` jsdoc tag.
2024-09-19 14:25:16 +00:00
Shahed Nasser
89928dfdf3
chore(oas): [11/n] improve oas schemas ( #9188 )
...
Improve OAS schemas [11/n]
2024-09-19 14:24:54 +00:00
Shahed Nasser
8dd72acee2
docs: add an examples list documentation ( #9194 )
2024-09-19 16:09:29 +02:00
Shahed Nasser
db73e9b972
docs: fix link in sidebar for modules test example ( #9195 )
2024-09-19 16:08:36 +02:00
Shahed Nasser
bf4335f2a6
docs: improvements and fixes to API route docs ( #9197 )
...
General improvements and fixes to docs around API routes
2024-09-19 14:08:23 +00:00
Shahed Nasser
0c3e3ea88a
docs: customization chapter exploration ( #9078 )
...
Adds a new customizations chapter with realistic example while maintaining the linear learning journey.
Preview: https://docs-v2-git-docs-customizations-chapter-medusajs.vercel.app/v2/customization
2024-09-18 08:45:29 +00:00
Shahed Nasser
d2c48228df
chore(oas): [9/n] improve oas schemas ( #9166 )
2024-09-17 19:27:28 +02:00
Shahed Nasser
b5ffed6973
chore(oas): [7/n] improve oas schemas ( #9162 )
2024-09-17 19:27:20 +02:00
Shahed Nasser
78eaed70e5
chore(oas): [8/n] improve oas schemas ( #9163 )
...
Improve OAS schemas [8/n]
2024-09-17 17:26:41 +00:00
Shahed Nasser
cda5bbac78
docs: added documentation on instrumentation ( #9160 )
...
Added new documentation chapter on instrumentation and observability
2024-09-17 17:22:16 +00:00
Shahed Nasser
cb79a5dbff
docs-util: fixes for circular references, PAK in examples, namespaces ( #9091 )
...
- Fix circular references in generated OAS comments by cloning objects
- Add publishable API key in the header of store cURL examples + change the admin authentication header to use bearer tokens.
- Add plugin to generate namespaces from the `@customNamespace` tag in TSDocs, this was available before but was removed.
- Other fixes related to re-using schemas, overwritten descriptions, and smaller fixes
2024-09-16 17:55:05 +00:00
Shahed Nasser
05c88268d3
oas: update authorization header in cURL examples ( #9100 )
2024-09-16 20:42:06 +03:00
Shahed Nasser and Carlos R. L. Rodrigues
8d3fb7fb2b
docs: use require instead of import in medusa-config.js ( #9102 )
...
Co-authored-by: Carlos R. L. Rodrigues <37986729+carlos-r-l-rodrigues@users.noreply.github.com >
2024-09-16 19:34:00 +02:00
Shahed Nasser
58f06be44d
docs: update docs across projects following publishable API key change in store routes ( #9098 )
...
* docs: update docs across projects following publishable API key change in store routes
* rename env variable
* move subscribe route out of store
2024-09-16 16:42:08 +03:00
Shahed Nasser
0bcdcccbe2
docs: update query usage across docs ( #9120 )
...
WIP
2024-09-16 12:46:26 +00:00
Shahed Nasser
35ffaf73d7
docs: update store cURL examples in OAS ( #9099 )
2024-09-16 15:37:11 +03:00
Shahed Nasser
8584031041
docs: replace ModuleRegistrationName with Modules ( #9142 )
2024-09-16 15:30:03 +03:00
Shahed Nasser
ab4a422fc8
docs: fix import of LinkDefinition ( #9143 )
2024-09-16 12:09:47 +03:00
Shahed Nasser
2c8ae6073e
oas: [6/n] improve oas schemas ( #9122 )
...
Improve oas schemas [6/n]
2024-09-13 07:23:09 +00:00
Shahed Nasser
a7684b45f6
docs: add new events to reference ( #9121 )
2024-09-13 09:22:09 +02:00
Shahed Nasser
1eccf394df
docs: added docs for deleting user of actor type ( #9104 )
...
- Added to general guide on creating actor type how to delete its user later.
- Added to restaurant delivery recipe how to delete a restaurant admin
2024-09-13 07:17:36 +00:00
Shahed Nasser
8c2a5fbcf2
fix(types, medusa): fix http type of exchanges and claims ( #9123 )
2024-09-12 20:33:40 +03:00
Shahed Nasser
41fb2aacb0
docs: fixes to long-running workflows + relationship docs ( #9101 )
2024-09-12 09:51:00 +03:00
Shahed Nasser
1466ca73e0
docs: added a services constraint document ( #8999 )
...
- Added a services constraint document mentioning that a service's methods must be async.
- Modify the code in the services intro document to use `async` method.
2024-09-10 18:00:23 +00:00
Shahed Nasser
e9b5f76f9a
docs: add Query documentation ( #9079 )
...
- Replace remote query documentation with new Query documentation
- Add redirect from old remote query to new query documentation
- Update remote query usages across docs to use new query usage.
2024-09-10 12:31:47 +00:00
Shahed Nasser
1d8dd54014
fix(core-flows): fix emitted event for deleting sales channel ( #9081 )
...
Fix the usage of the user event instead of sales channel event
2024-09-10 12:24:19 +00:00
Shahed Nasser
4b663a4559
docs: document events reference ( #9080 )
...
- Remove old hidden reference files that document modules' events
- Add new events reference for workflow events
- Reference events reference in the main docs
2024-09-10 12:20:09 +00:00
Shahed Nasser
3fb2f10ccb
docs: fix links to inventory model references ( #9073 )
...
Closes #9070
2024-09-10 12:18:10 +00:00
Shahed Nasser
464a3e692f
docs-util: fix after updating node version ( #9072 )
...
Small fix in imports after updating node version
2024-09-10 12:05:19 +00:00
Shahed Nasser
5eafa5a184
oas: [5/n] improve oas schemas ( #9066 )
...
Improve oas schemas [5/n]
2024-09-10 12:03:18 +00:00
Shahed Nasser
6e46baa2cb
docs-util: fix generated hooks example ( #9060 )
...
Fix generated hook examples by the placement of `async` keyword
2024-09-09 18:53:44 +00:00
Shahed Nasser
abb5f0c2fe
oas: [4/n] improve oas schemas ( #9064 )
...
Improve oas schemas [4/n]
2024-09-09 18:52:49 +00:00
Shahed Nasser
dfb095e2ea
chore(types, medusa): clean up to request / response types ( #9067 )
...
Smaller clean up to request / response types
2024-09-09 18:52:02 +00:00
Shahed Nasser
c091cf5868
docs: add prerequisites link for test guides ( #9057 )
...
- Add a prerequisites link to test guides pointing to how to setup the testing tools
- Add in the main http / module integration guides the command to run the tests
2024-09-09 13:58:42 +00:00
Shahed Nasser
2189ff2dc8
chore: fix build errors in OAS ( #9059 )
...
Fix errors stopping OAS from building
2024-09-09 13:54:14 +00:00
Shahed Nasser
4ffcc41fe7
chore(utils): update auth provider TSDocs + fix errors stopping references build ( #9023 )
...
- Updated the TSDocs of the auth provider
- Update the Node version in the docs-util as the outdated version was causing TypeScript error
- Add `@ts-ignore` for a line that was causing a typescript error. If there's a better fix here let me know
2024-09-09 13:53:33 +00:00
Shahed Nasser
a5e8a55d63
docs: added storefront development guide on retrieving variant inventory details ( #9032 )
...
* docs: added storefront development guide on retrieving variant inventory details
* fix vale error
2024-09-09 10:02:59 +03:00
Shahed Nasser
c962283281
fix(types, medusa): request / response types clean-up ( #9043 )
...
More clean-up of request / response types
2024-09-09 06:59:43 +00:00
Shahed Nasser
3eb2387746
docs: fix pricing query params in storefront guide + modules restructure ( #9021 )
...
- Fix pricing query params previously using `customer_group_id` and `customer_id` as expected / accepted queries and update information around them
- Other: reorganize the introduction page of each module to show how to use it at the very beginning.
2024-09-09 06:43:43 +00:00
Shahed Nasser
4b8d9cc735
oas: [3/n] improve oas schemas ( #9042 )
...
Improve oas schemas [3/n]
2024-09-07 06:16:00 +00:00
Shahed Nasser
a7180e29b8
oas: [1/n] improve store oas ( #8993 )
...
* oas: [1/n] improve store oas
* add missing postal code param
2024-09-07 08:09:10 +02:00
Shahed Nasser
cf387aafa2
chore: re-add oas tests for generated OAS ( #9036 )
...
* chore: re-add oas tests for generated OAS
* test fix
2024-09-07 08:01:22 +02:00
Shahed Nasser
7a80593b68
oas: [2/n] improve schema oas ( #9040 )
2024-09-06 18:53:07 +03:00
Shahed Nasser
0482b7751d
oas: [1/n] improve oas schemas ( #9039 )
2024-09-06 18:52:51 +03:00
Shahed Nasser
cd909f9db3
oas: [2/2] improve store OAS ( #9035 )
2024-09-06 18:52:38 +03:00
Shahed Nasser
b5dbf572e3
docs: document star actor types ( #9044 )
2024-09-06 17:38:51 +02:00
Shahed Nasser
89f21e4a60
docs: fix admin actor type -> user ( #9028 )
2024-09-06 17:38:33 +02:00
Shahed Nasser and Stevche Radevski
a28c911c24
docs: update auth docs + add new storefront guides ( #9020 )
...
* docs: update auth docs + add new storefront guides
* lint content
* fix vale error
* add callback response schema
* Update www/apps/resources/app/commerce-modules/auth/auth-providers/github/page.mdx
Co-authored-by: Stevche Radevski <sradevski@live.com >
* Update www/apps/resources/app/commerce-modules/auth/auth-providers/github/page.mdx
Co-authored-by: Stevche Radevski <sradevski@live.com >
* Update www/apps/resources/app/commerce-modules/auth/authentication-route/page.mdx
Co-authored-by: Stevche Radevski <sradevski@live.com >
* address PR comments
* replace google -> github
* better explanation for refresh token
---------
Co-authored-by: Stevche Radevski <sradevski@live.com >
2024-09-06 15:26:10 +03:00
Shahed Nasser
72f7ff882d
chore: fix incorrect oas property name ( #9009 )
2024-09-06 12:59:11 +02:00
Shahed Nasser
3ba0ddcd43
fix(types): add inventory_quantity to http variant type ( #9030 )
2024-09-06 13:33:02 +03:00
Shahed Nasser
ac30a989f4
feat(create-medusa-app): add publishable API key environment variable to Next.js storefront ( #9029 )
...
When installing with Next.js starter, retrieve the publishable API key seeded and add it to the environment variable in the `.env.local` or `.env.template` file
2024-09-06 09:43:55 +00:00
Shahed Nasser
abe7b66999
docs: rename admin-shared -> admin-sdk ( #9008 )
2024-09-06 10:33:34 +02:00
Shahed Nasser
beaa851302
docs-util: fix to enum type + optional ( #8950 )
...
- Fix to some enum types (with one member) not being extracted properly.
- Consider `nullish` Zod types as optional.
2024-09-04 18:36:58 +00:00
Shahed Nasser
c615f4014c
chore: fix oas errors ( #8982 )
...
Fix indentation and missing values in OAS resulting in an error when generating the specs in the API reference
2024-09-04 18:34:17 +00:00