Skip to content

Commit

Permalink
feat(admin-sdk,admin-bundler,admin-shared,medusa): Restructure admin …
Browse files Browse the repository at this point in the history
…packages (medusajs#8988)

**What**
- Renames /admin-next -> /admin
- Renames @medusajs/admin-sdk -> @medusajs/admin-bundler
- Creates a new package called @medusajs/admin-sdk that will hold all tooling relevant to creating admin extensions. This is currently `defineRouteConfig` and `defineWidgetConfig`, but will eventually also export methods for adding custom fields, register translation, etc. 
  - cc: @shahednasser we should update the examples in the docs so these functions are imported from `@medusajs/admin-sdk`. People will also need to install the package in their project, as it's no longer a transient dependency.
  - cc: @olivermrbl we might want to publish a changelog when this is merged, as it is a breaking change, and will require people to import the `defineXConfig` from the new package instead of `@medusajs/admin-shared`.
- Updates CODEOWNERS so /admin packages does not require a review from the UI team.
  • Loading branch information
kasperkristensen authored Sep 4, 2024
1 parent beaa851 commit 0fe1201
Show file tree
Hide file tree
Showing 1,440 changed files with 122 additions and 86 deletions.
1 change: 1 addition & 0 deletions .changeset/little-books-reply.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@
"@medusajs/workflow-engine-inmemory": patch
"@medusajs/workflow-engine-redis": patch
"@medusajs/dashboard": patch
"@medusajs/admin-bundler": patch
"@medusajs/admin-sdk": patch
"@medusajs/admin-shared": patch
"@medusajs/admin-vite-plugin": patch
Expand Down
64 changes: 8 additions & 56 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,11 @@ module.exports = {
project: [
"./packages/medusa/tsconfig.json",

"./packages/admin-next/dashboard/tsconfig.json",
"./packages/admin-next/admin-sdk/tsconfig.json",
"./packages/admin-next/admin-shared/tsconfig.json",
"./packages/admin-next/admin-vite-plugin/tsconfig.json",
"./packages/admin/dashboard/tsconfig.json",
"./packages/admin/admin-sdk/tsconfig.json",
"./packages/admin/admin-shared/tsconfig.json",
"./packages/admin/admin-bundler/tsconfig.json",
"./packages/admin/admin-vite-plugin/tsconfig.json",

"./packages/cli/create-medusa-app/tsconfig.json",
"./packages/cli/medusa-cli/tsconfig.spec.json",
Expand Down Expand Up @@ -218,8 +219,8 @@ module.exports = {
},
{
files: [
"packages/admin-next/dashboard/**/*.ts",
"packages/admin-next/dashboard/**/*.tsx",
"packages/admin/dashboard/**/*.ts",
"packages/admin/dashboard/**/*.tsx",
],
plugins: ["unused-imports", "react-refresh"],
extends: [
Expand All @@ -234,56 +235,7 @@ module.exports = {
},
ecmaVersion: 2018, // Allows for the parsing of modern ECMAScript features
sourceType: "module", // Allows for the use of imports
project: "./packages/admin-next/dashboard/tsconfig.json",
},
globals: {
__BASE__: "readonly",
},
env: {
browser: true,
},
rules: {
"prettier/prettier": "error",
"react/prop-types": "off",
"new-cap": "off",
"require-jsdoc": "off",
"valid-jsdoc": "off",
"react-refresh/only-export-components": [
"warn",
{ allowConstantExport: true },
],
"no-unused-expressions": "off",
"unused-imports/no-unused-imports": "error",
"unused-imports/no-unused-vars": [
"warn",
{
vars: "all",
varsIgnorePattern: "^_",
args: "after-used",
argsIgnorePattern: "^_",
},
],
},
},
{
files: [
"packages/admin-next/app/**/*.ts",
"packages/admin-next/app/**/*.tsx",
],
plugins: ["unused-imports", "react-refresh"],
extends: [
"plugin:react/recommended",
"plugin:react/jsx-runtime",
"plugin:react-hooks/recommended",
],
parser: "@typescript-eslint/parser",
parserOptions: {
ecmaFeatures: {
jsx: true,
},
ecmaVersion: 2018, // Allows for the parsing of modern ECMAScript features
sourceType: "module", // Allows for the use of imports
project: "./packages/admin-next/app/tsconfig.json",
project: "./packages/admin/dashboard/tsconfig.json",
},
globals: {
__BASE__: "readonly",
Expand Down
2 changes: 0 additions & 2 deletions CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,4 @@ yarn.lock @medusajs/engineering
/integration-tests/ @medusajs/engineering
/docs-util/ @medusajs/docs
/www/ @medusajs/docs
/packages/admin @medusajs/ui
/packages/admin-ui @medusajs/ui
/packages/design-system/ @medusajs/ui
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"packages/cli/*",
"packages/cli/oas/*",
"packages/*",
"packages/admin-next/*",
"packages/admin/*",
"packages/design-system/*",
"packages/generated/*",
"integration-tests/**/*"
Expand Down
1 change: 0 additions & 1 deletion packages/admin-next/admin-sdk/README.md

This file was deleted.

1 change: 0 additions & 1 deletion packages/admin-next/admin-shared/README.md

This file was deleted.

1 change: 0 additions & 1 deletion packages/admin-next/admin-vite-plugin/README.md

This file was deleted.

1 change: 1 addition & 0 deletions packages/admin/admin-bundler/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# `@medusajs/admin-bundler`
Original file line number Diff line number Diff line change
@@ -1,13 +1,18 @@
{
"name": "@medusajs/admin-sdk",
"name": "@medusajs/admin-bundler",
"version": "0.0.1",
"description": "Admin SDK for Medusa.",
"description": "Bundler for the Medusa admin dashboard.",
"author": "Kasper Kristensen <[email protected]>",
"scripts": {
"build": "tsup && copyfiles -f ./src/index.html ./src/entry.tsx ./src/index.css ./dist"
},
"main": "./dist/index.js",
"types": "./dist/index.d.ts",
"repository": {
"type": "git",
"url": "https://github.com/medusajs/medusa",
"directory": "packages/admin/admin-bundler"
},
"files": [
"dist",
"package.json"
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
import { defineRouteConfig, defineWidgetConfig } from "@medusajs/admin-shared"

export { build } from "./lib/build"
export { develop } from "./lib/develop"
export { serve } from "./lib/serve"

export { defineRouteConfig, defineWidgetConfig }

export * from "./types"
File renamed without changes.
File renamed without changes.
1 change: 1 addition & 0 deletions packages/admin/admin-sdk/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# @medusajs/admin-sdk
30 changes: 30 additions & 0 deletions packages/admin/admin-sdk/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
{
"name": "@medusajs/admin-sdk",
"description": "SDK for building extension for the Medusa admin dashboard.",
"version": "0.0.1",
"author": "Kasper Kristensen <[email protected]>",
"types": "dist/index.d.ts",
"main": "dist/index.js",
"module": "dist/index.mjs",
"repository": {
"type": "git",
"url": "https://github.com/medusajs/medusa",
"directory": "packages/admin/admin-sdk"
},
"files": [
"dist",
"package.json"
],
"scripts": {
"build": "tsup"
},
"devDependencies": {
"@types/react": "^18.3.2",
"tsup": "^8.0.1",
"typescript": "^5.3.3"
},
"dependencies": {
"@medusajs/admin-shared": "^0.0.1"
},
"packageManager": "[email protected]"
}
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import type { InjectionZone } from "@medusajs/admin-shared"
import type { ComponentType } from "react"

import { InjectionZone } from "../widgets"

export type WidgetConfig = {
zone: InjectionZone | InjectionZone[]
}
Expand Down
1 change: 1 addition & 0 deletions packages/admin/admin-sdk/src/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export * from "./config"
File renamed without changes.
8 changes: 8 additions & 0 deletions packages/admin/admin-sdk/tsup.config.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import { defineConfig } from "tsup"

export default defineConfig({
entry: ["src/index.ts"],
format: ["cjs", "esm"],
dts: true,
clean: true,
})
1 change: 1 addition & 0 deletions packages/admin/admin-shared/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# @medusajs/admin-shared
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@
"types": "dist/index.d.ts",
"main": "dist/index.js",
"module": "dist/index.mjs",
"repository": {
"type": "git",
"url": "https://github.com/medusajs/medusa",
"directory": "packages/admin/admin-shared"
},
"files": [
"dist",
"package.json"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
export * from "./extensions/config"
export * from "./extensions/virtual"
export * from "./extensions/widgets"

19 changes: 19 additions & 0 deletions packages/admin/admin-shared/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"compilerOptions": {
"target": "ES2020",
"useDefineForClassFields": true,
"lib": ["ES2020", "DOM", "DOM.Iterable"],
"module": "ESNext",
"moduleResolution": "Node",
"skipLibCheck": true,
"strict": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"noFallthroughCasesInSwitch": true,
"esModuleInterop": true,
"outDir": "dist",
"declarationMap": true,
"declaration": true
},
"include": ["src"]
}
File renamed without changes.
1 change: 1 addition & 0 deletions packages/admin/admin-vite-plugin/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# @medusajs/admin-vite-plugin
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,11 @@
"types": "./dist/index.d.ts"
}
},
"repository": {
"type": "git",
"url": "https://github.com/medusajs/medusa",
"directory": "packages/admin/admin-vite-plugin"
},
"files": [
"dist",
"package.json"
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,11 @@
"require": "./dist/app.css"
}
},
"repository": {
"type": "git",
"url": "https://github.com/medusajs/medusa",
"directory": "packages/admin/dashboard"
},
"files": [
"dist",
"package.json"
Expand Down
File renamed without changes.
File renamed without changes
File renamed without changes.
Loading

0 comments on commit 0fe1201

Please sign in to comment.