@medusajs/admin-shared 2.22.0-snapshot-20261021091347 → 2.22.0

package/AGENTS.md

@@ -0,0 +1,57 @@
+# @medusajs/admin-shared
+
+Shared constants, types, and validators for the Admin extension system, used by `@medusajs/admin-sdk`, `@medusajs/admin-vite-plugin`, `@medusajs/admin-bundler`, and `@medusajs/dashboard`. It defines the set of valid injection zones, nested route positions, core layouts, custom-field zones, and virtual module ids.
+
+## Using this package
+
+App code rarely imports it directly. The main reason to use it is TypeScript augmentation in a plugin:
+
+```ts
+// my-plugin/index.d.ts (listed in package.json "files" and "exports"."."."types")
+declare module "@medusajs/admin-shared" {
+  interface InjectionZoneRegistry {
+    "brand.details": true
+    "brand.details.side": true
+    "brand.list": true
+  }
+  interface LayoutSectionRegistry {
+    "my-plugin:three-column": "main" | "left" | "right"
+  }
+}
+```
+
+- `InjectionZoneRegistry` augmentation adds zones to `defineWidgetConfig`'s `zone` autocomplete.
+- `LayoutSectionRegistry` augmentation types `LayoutComposer`'s `sections` for a custom layout registered with `defineLayoutConfig`.
+- `CORE_LAYOUT_IDS`: `core:single-column`, `core:single-row`, `core:two-column`, `core:settings-sidebar`.
+
+Docs: https://docs.medusajs.com/learn/fundamentals/admin/custom-injection-zones.md
+
+## Architecture
+
+- `src/extensions/widgets/`:
+  - `INJECTION_ZONES`: one `LEGACY_*` (`.before` / `.after`) and one current array per entity, spread into a single list.
+  - `InjectionZoneRegistry`: an interface built from that list, so plugins can extend it.
+  - `isValidInjectionZone`: accepts any string.
+- `src/extensions/routes/`: `NESTED_ROUTE_POSITIONS` (`/orders`, `/products`, `/inventory`, `/customers`, `/promotions`, `/price-lists`).
+- `src/extensions/layouts/`: `CORE_LAYOUT_IDS`, `LayoutSection` (`ordering`: `list` | `grid` | `horizontal-stretched` | `horizontal-list`), `LayoutSectionRegistry`.
+- `src/extensions/custom-fields/`: models, form zones, tabs, and display zones for the experimental custom-fields API. Only `product` is implemented (`product/`).
+- `src/virtual-modules/constants.ts`: `virtual:medusa/*` ids and the `VIRTUAL_MODULES` list.
+- `src/utils/`: `deepMerge`, `isObject`.
+
+## Development
+
+```bash
+yarn build   # tsup
+```
+
+No tests in this package. Behavior is covered by `@medusajs/admin-vite-plugin` specs.
+
+## Gotchas
+
+- Adding a zone to a core dashboard page:
+  - Add the non-suffixed zone(s) to the entity's `*_INJECTION_ZONES` array and make sure that array is spread into `INJECTION_ZONES`.
+  - Update the zone docs under `www/apps/resources/app/commerce-modules/*/admin-widget-zones/`.
+- Never add new `.before` / `.after` zones. The layout composer ignores them (`login.before` / `login.after` are the only exception).
+- `isValidInjectionZone` returns `true` for unknown strings and only logs a warning, so custom zones work but typos are not rejected at build time.
+- Adding a virtual module means updating `VIRTUAL_MODULES` here, `vmod.ts` in `@medusajs/admin-vite-plugin`, and the `external` list in the dashboard's `tsup.config.cjs`.
+- Any change to an exported union type is a public API change for `@medusajs/admin-sdk` users.

package/README.md

@@ -1 +1,49 @@
-# @medusajs/admin-shared
+<p align="center">
+  <a href="https://www.medusajs.com">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/59018053/229103275-b5e482bb-4601-46e6-8142-244f531cebdb.svg">
+    <source media="(prefers-color-scheme: light)" srcset="https://user-images.githubusercontent.com/59018053/229103726-e5b529a3-9b3f-4970-8a1f-c6af37f087bf.svg">
+    <img alt="Medusa logo" src="https://user-images.githubusercontent.com/59018053/229103726-e5b529a3-9b3f-4970-8a1f-c6af37f087bf.svg">
+    </picture>
+  </a>
+</p>
+<h1 align="center">
+  @medusajs/admin-shared
+</h1>
+
+<h4 align="center">
+  <a href="https://docs.medusajs.com">Documentation</a> |
+  <a href="https://www.medusajs.com">Website</a>
+</h4>
+
+<p align="center">
+  Building blocks for digital commerce
+</p>
+<p align="center">
+  <a href="https://github.com/medusajs/medusa/blob/develop/LICENSE">
+    <img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="Medusa is released under the MIT license." />
+  </a>
+  <a href="https://github.com/medusajs/medusa/blob/develop/CONTRIBUTING.md">
+    <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" alt="PRs welcome!" />
+  </a>
+  <a href="https://discord.gg/xpCwq3Kfn8">
+    <img src="https://img.shields.io/badge/chat-on%20discord-7289DA.svg" alt="Discord Chat" />
+  </a>
+  <a href="https://twitter.com/intent/follow?screen_name=medusajs">
+    <img src="https://img.shields.io/twitter/follow/medusajs.svg?label=Follow%20@medusajs" alt="Follow @medusajs" />
+  </a>
+</p>
+
+Shared constants, types, and utilities for Medusa's admin packages, such as the list of widget injection zones (`INJECTION_ZONES`, `InjectionZone`) and custom field, route, and layout extension types. It's internal plumbing used by `@medusajs/admin-sdk`, `@medusajs/admin-vite-plugin`, `@medusajs/admin-bundler`, and `@medusajs/dashboard`; you don't need to install or import it directly to build admin extensions.
+
+## At a glance
+
+| | |
+|---|---|
+| Package | `@medusajs/admin-shared` |
+| Type | Internal tooling |
+
+## Resources
+
+- [Widget Injection Zones](https://docs.medusajs.com/resources/admin-widget-injection-zones)
+- [Admin Development](https://docs.medusajs.com/learn/fundamentals/admin)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@medusajs/admin-shared",
   "description": "Shared code for Medusa admin packages.",
-  "version": "2.22.0-snapshot-20261021091347",
+  "version": "2.22.0",
   "author": "Kasper Kristensen <kasper@medusajs.com>",
   "types": "dist/index.d.ts",
   "main": "dist/index.js",
@@ -16,8 +16,12 @@
   },
   "files": [
     "dist",
-    "package.json"
+    "package.json",
+    "AGENTS.md"
   ],
+  "llms": "https://docs.medusajs.com/llms.txt",
+  "llmsFull": "https://docs.medusajs.com/llms-full.txt",
+  "mcpServer": "https://docs.medusajs.com/mcp",
   "scripts": {
     "build": "yarn run -T tsup"
   },