quickbooks-medusa-plugin 0.0.5 → 0.0.6

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "quickbooks-medusa-plugin",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "Medusa v2 plugin for QuickBooks Online bi-directional sync (Customers, Products, Orders, Inventory).",
   "author": "bootssecurity",
   "license": "MIT",
   "files": [
-    ".medusa/server"
+    ".medusa/server",
+    "src/admin"
   ],
   "exports": {
     "./package.json": "./package.json",
@@ -15,9 +16,9 @@
     "./providers/*": "./.medusa/server/src/providers/*/index.js",
     "./*": "./.medusa/server/src/*.js",
     "./admin": {
-      "import": "./.medusa/server/src/admin/index.mjs",
-      "require": "./.medusa/server/src/admin/index.js",
-      "default": "./.medusa/server/src/admin/index.js"
+      "import": "./src/admin/index.ts",
+      "require": "./src/admin/index.ts",
+      "default": "./src/admin/index.ts"
     }
   },
   "keywords": [
@@ -30,9 +31,9 @@
     "intuit"
   ],
   "scripts": {
-    "build": "medusa plugin:build && mkdir -p .medusa/server/src/admin && cp -r src/admin/routes .medusa/server/src/admin/",
+    "build": "medusa plugin:build",
     "dev": "medusa plugin:develop",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "medusa plugin:build"
   },
   "devDependencies": {
     "@medusajs/admin-sdk": "2.12.3",

package/src/admin/README.md

@@ -0,0 +1,31 @@
+# Admin Customizations
+
+You can extend the Medusa Admin to add widgets and new pages. Your customizations interact with API routes to provide merchants with custom functionalities.
+
+## Example: Create a Widget
+
+A widget is a React component that can be injected into an existing page in the admin dashboard.
+
+For example, create the file `src/admin/widgets/product-widget.tsx` with the following content:
+
+```tsx title="src/admin/widgets/product-widget.tsx"
+import { defineWidgetConfig } from "@medusajs/admin-sdk"
+
+// The widget
+const ProductWidget = () => {
+  return (
+    <div>
+      <h2>Product Widget</h2>
+    </div>
+  )
+}
+
+// The widget's configurations
+export const config = defineWidgetConfig({
+  zone: "product.details.after",
+})
+
+export default ProductWidget
+```
+
+This inserts a widget with the text “Product Widget” at the end of a product’s details page.

package/src/admin/i18n/README.md

@@ -0,0 +1,58 @@
+# Admin Customizations Translations
+
+The Medusa Admin dashboard supports multiple languages for its interface. Medusa uses [react-i18next](https://react.i18next.com/) to manage translations in the admin dashboard.
+
+To add translations, create JSON translation files for each language under the `src/admin/i18n/json` directory. For example, create the `src/admin/i18n/json/en.json` file with the following content:
+
+```json
+{
+  "brands": {
+    "title": "Brands",
+    "description": "Manage your product brands"
+  },
+  "done": "Done"
+}
+```
+
+Then, export the translations in `src/admin/i18n/index.ts`:
+
+```ts
+import en from "./json/en.json" with { type: "json" }
+
+export default {
+  en: {
+    translation: en,
+  },
+}
+```
+
+Finally, use translations in your admin widgets and routes using the `useTranslation` hook:
+
+```tsx
+import { defineWidgetConfig } from "@medusajs/admin-sdk"
+import { Button, Container, Heading } from "@medusajs/ui"
+import { useTranslation } from "react-i18next"
+
+const ProductWidget = () => {
+  const { t } = useTranslation()
+  return (
+    <Container className="p-0">
+      <div className="flex items-center justify-between px-6 py-4">
+        <Heading level="h2">{t("brands.title")}</Heading>
+        <p>{t("brands.description")}</p>
+      </div>
+      <div className="flex justify-end px-6 py-4">
+        <Button variant="primary">{t("done")}</Button>
+      </div>
+    </Container>
+  )
+}
+
+export const config = defineWidgetConfig({
+  zone: "product.details.before",
+})
+
+export default ProductWidget
+```
+
+Learn more about translating admin extensions in the [Translate Admin Customizations](https://docs.medusajs.com/learn/fundamentals/admin/translations) documentation.

package/src/admin/i18n/index.ts

@@ -0,0 +1 @@
+export default {}

package/src/admin/index.ts

@@ -0,0 +1,6 @@
+// Medusa Admin Extension Entry Point
+// Must export 'widgets' and 'default' to be valid.
+
+export const widgets = [];
+
+export default {};

package/src/admin/tsconfig.json

@@ -0,0 +1,24 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "useDefineForClassFields": true,
+    "lib": ["ES2020", "DOM", "DOM.Iterable"],
+    "module": "ESNext",
+    "skipLibCheck": true,
+
+    /* Bundler mode */
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": true,
+    "jsx": "react-jsx",
+
+    /* Linting */
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true
+  },
+  "include": ["."]
+}

package/src/admin/vite-env.d.ts

@@ -0,0 +1 @@
+/// <reference types="vite/client" />