Merge branch 'develop' into feat/seed_product_collections

.changeset/dull-grapes-act.md

@@ -0,0 +1,13 @@
+---
+"@medusajs/client-types": patch
+"medusa-react": patch
+"@medusajs/medusa-js": patch
+"@medusajs/medusa": patch
+"@medusajs/types": patch
+---
+
+fix(@medusajs/client-types): Fix types and TSDocs
+fix(medusa-react): Fix response type of Publishable API Key's list sales channels.
+fix(@medusajs/medusa-js): Fix incorrect parameter and response types.
+fix(@medusajs/medusa): Fix incorrect types and add TSDocs
+fix(@medusajs/types): Fix incorrect types and add TSDocs

.changeset/honest-panthers-lay.md

@@ -0,0 +1,10 @@
+---
+"@medusajs/inventory": patch
+"@medusajs/modules-sdk": patch
+"@medusajs/orchestration": patch
+"@medusajs/product": patch
+"@medusajs/utils": patch
+"@medusajs/workflows": patch
+---
+
+chore: Add missing version bumps

.changeset/tough-cups-breathe.md

@@ -1,5 +1,5 @@
 ---
-"@medusajs/cache-redis": major
+"@medusajs/cache-redis": minor
 "@medusajs/cache-inmemory": patch
 ---
 

.changeset/witty-tools-matter.md

@@ -0,0 +1,6 @@
+---
+"@medusajs/admin-ui": patch
+"@medusajs/admin": patch
+---
+
+fix(admin-ui): Admin UI: Invalid Request Header

.github/workflows/generate-references.yml

@@ -37,6 +37,10 @@ jobs:
       - name: Build Packages
         run: yarn build
 
+      - name: Install Docs dependencies
+        working-directory: www
+        run: yarn install
+
       - name: Install Workspace dependencies
         run: yarn install
         working-directory: docs-util

docs-util/packages/scripts/package.json

@@ -25,12 +25,12 @@
     "typedoc": "0.25.1",
     "typedoc-config": "*",
     "typedoc-monorepo-link-types": "^0.0.2",
+    "typedoc-plugin-custom": "*",
     "typedoc-plugin-frontmatter": "*",
     "typedoc-plugin-markdown": "3.16.0",
     "typedoc-plugin-markdown-medusa": "*",
     "typedoc-plugin-merge-modules": "5.1.0",
     "typedoc-plugin-missing-exports": "^2.1.0",
-    "typedoc-plugin-modules": "*",
     "typedoc-plugin-reference-excluder": "1.1.3",
     "typedoc-plugin-rename-defaults": "^0.6.6",
     "typescript": "^5.2.2"

docs-util/packages/typedoc-config/_base.js

@@ -1,4 +1,18 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+const path = require("path")
+
+const pathPrefix = path.join(__dirname, "..", "..", "..")
+
+/** @type {import('typedoc').TypeDocOptions} */
 module.exports = {
+  // extends: [typedocConfig],
   plugin: ["typedoc-plugin-markdown-medusa"],
   readme: "none",
+  eslintPathName: path.join(
+    pathPrefix,
+    "www/packages/eslint-config-docs/content.js"
+  ),
+  pluginsResolvePath: path.join(pathPrefix, "www"),
+  // Uncomment this when debugging
+  // showConfig: true,
 }

docs-util/packages/typedoc-config/_modules.js

@@ -70,10 +70,9 @@ module.exports = ({
     ...globalTypedocOptions,
     entryPoints: [path.join(pathPrefix, entryPointPath)],
     out: [path.join(pathPrefix, outPath)],
-    tsconfig: path.join(
-      pathPrefix,
-      tsconfigPath || "packages/types/tsconfig.json"
-    ),
+    tsconfig: tsconfigPath.length
+      ? path.join(pathPrefix, tsconfigPath)
+      : path.join(__dirname, "extended-tsconfig", "types.json"),
     name: `${moduleName} Reference`,
     indexTitle: `${moduleName} Reference`,
     entryDocument: "index.md",
@@ -82,7 +81,7 @@ module.exports = ({
     hideBreadcrumbs: true,
     plugin: [
       ...globalTypedocOptions.plugin,
-      "typedoc-plugin-modules",
+      "typedoc-plugin-custom",
       "typedoc-plugin-rename-defaults",
       "typedoc-plugin-frontmatter",
     ],

docs-util/packages/typedoc-config/entities.js

@@ -8,7 +8,7 @@ module.exports = {
   ...globalTypedocOptions,
   entryPoints: [path.join(pathPrefix, "packages/medusa/src/models/index.ts")],
   out: [path.join(pathPrefix, "www/apps/docs/content/references/entities")],
-  tsconfig: path.join(pathPrefix, "packages/medusa/tsconfig.json"),
+  tsconfig: path.join(__dirname, "extended-tsconfig", "medusa.json"),
   name: "Entities Reference",
   indexTitle: "Entities Reference",
   entryDocument: "_index.mdx",

docs-util/packages/typedoc-config/extended-tsconfig/js-client.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "http://json.schemastore.org/tsconfig",
+  "extends": [
+    "../../../../packages/medusa-js/tsconfig.json"
+  ]
+}

docs-util/packages/typedoc-config/extended-tsconfig/medusa.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "http://json.schemastore.org/tsconfig",
+  "extends": [
+    "../../../../packages/medusa/tsconfig.json"
+  ]
+}

docs-util/packages/typedoc-config/extended-tsconfig/tsdoc.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+  "extends": ["typedoc/tsdoc.json"],
+  "tagDefinitions": [
+    {
+      "tagName": "@featureFlag",
+      "syntaxKind": "block"
+    },
+    {
+      "tagName": "@expandable",
+      "syntaxKind": "modifier"
+    },
+    {
+      "tagName": "@schema",
+      "syntaxKind": "block"
+    },
+    {
+      "tagName": "@apiIgnore",
+      "syntaxKind": "modifier"
+    }
+  ]
+}

docs-util/packages/typedoc-config/extended-tsconfig/types.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "http://json.schemastore.org/tsconfig",
+  "extends": [
+    "../../../../packages/types/tsconfig.json"
+  ]
+}

docs-util/packages/typedoc-config/js-client.js

@@ -4,48 +4,62 @@ const globalTypedocOptions = require("./_base")
 
 const pathPrefix = path.join(__dirname, "..", "..", "..")
 
+const defaultFormattingOptions = {
+  showCommentsAsHeader: true,
+  sections: {
+    member_sources_definedIn: false,
+    reflection_hierarchy: false,
+    member_signature_typeParameters: false,
+    member_signature_sources: false,
+    member_signature_title: false,
+    member_signature_returns: false,
+  },
+  parameterStyle: "component",
+  parameterComponent: "ParameterTypes",
+  mdxImports: [
+    `import ParameterTypes from "@site/src/components/ParameterTypes"`,
+  ],
+  reflectionGroups: {
+    Constructors: false,
+  },
+  frontmatterData: {
+    displayed_sidebar: "jsClientSidebar",
+  },
+}
+
+/** @type {import('typedoc').TypeDocOptions} */
 module.exports = {
   ...globalTypedocOptions,
   entryPoints: [path.join(pathPrefix, "packages/medusa-js/src/resources")],
-  entryPointStrategy: "expand",
   out: [path.join(pathPrefix, "www/apps/docs/content/references/js-client")],
-  tsconfig: path.join(pathPrefix, "packages/medusa-js/tsconfig.json"),
+  tsconfig: path.join(__dirname, "extended-tsconfig", "js-client.json"),
   name: "JS Client Reference",
   indexTitle: "JS Client Reference",
   entryDocument: "_index.mdx",
   hideInPageTOC: true,
   hideBreadcrumbs: true,
   plugin: [
     ...globalTypedocOptions.plugin,
-    "typedoc-plugin-reference-excluder",
-    "typedoc-plugin-frontmatter",
     "typedoc-plugin-rename-defaults",
-    "typedoc-plugin-modules",
+    "typedoc-plugin-custom",
   ],
   exclude: [
     path.join(pathPrefix, "packages/medusa-js/src/resources/base.ts"),
     path.join(pathPrefix, "node_modules/**"),
-    path.join(pathPrefix, "packages/**/node_modules"),
   ],
-  excludeConstructors: true,
-  frontmatterData: {
-    displayed_sidebar: "jsClientSidebar",
-  },
   internalModule: "internal",
   formatting: {
-    "*": {
-      showCommentsAsHeader: true,
-      sections: {
-        member_sources_definedIn: false,
-        reflection_hierarchy: false,
+    "*": defaultFormattingOptions,
+    "^classes/": {
+      ...defaultFormattingOptions,
+      frontmatterData: {
+        ...defaultFormattingOptions.frontmatterData,
+        slug: "/references/js-client/{{alias}}",
       },
-      parameterStyle: "component",
-      parameterComponent: "ParameterTypes",
-      mdxImports: [
-        `import ParameterTypes from "@site/src/components/ParameterTypes"`,
-      ],
     },
   },
   objectLiteralTypeDeclarationStyle: "component",
   mdxOutput: true,
+  maxLevel: 4,
+  ignoreApi: true,
 }

docs-util/packages/typedoc-config/package.json

@@ -5,6 +5,9 @@
   "publishConfig": {
     "access": "public"
   },
+  "peerDependencies": {
+    "typedoc": "0.25.x"
+  },
   "main": "_base.js",
   "version": "0.0.0"
 }

docs-util/packages/typedoc-config/services.js

@@ -8,7 +8,7 @@ module.exports = {
   ...globalTypedocOptions,
   entryPoints: [path.join(pathPrefix, "packages/medusa/src/services/index.ts")],
   out: [path.join(pathPrefix, "www/apps/docs/content/references/services")],
-  tsconfig: path.join(pathPrefix, "packages/medusa/tsconfig.json"),
+  tsconfig: path.join(__dirname, "extended-tsconfig", "medusa.json"),
   name: "Services Reference",
   indexTitle: "Services Reference",
   entryDocument: "index.md",

docs-util/packages/typedoc-plugin-custom/README.md

@@ -0,0 +1,44 @@
+# typedoc-plugin-custom
+
+A Typedoc plugin that combines utility plugins for documenting references.
+
+## Configurations
+
+### Resolve Reference Configurations
+
+The [`resolve-reference-plugin`](./src/resolve-references-plugin.ts) imitates the [`typedoc-plugin-missing-exports`](https://www.npmjs.com/package/typedoc-plugin-missing-exports) plugin. So, it accepts the same options as the [`typedoc-plugin-missing-exports`](https://www.npmjs.com/package/typedoc-plugin-missing-exports) plugin.
+
+### Frontmatter
+
+`frontmatterData` is an object of key-value pairs. If none provided, no frontmatter variables will be added to the Markdown files.
+
+An example of passing it in a JavaScript configuration file:
+
+```js
+frontmatterData: {
+  displayed_sidebar: "jsClientSidebar",
+},
+```
+
+### API Ignore
+
+The `ignoreApi` option is a boolean that indicates whether reflections with the `@apiIgnore` tag should be ignored. If enabled, reflections having this tag are removed from the generated documentation. If disabled (which is the default), the `@apiIgnore` tag is removed from the reflection to ensure it's not shown in the generated documentation.
+
+### ESLint
+
+If the `eslintPathName` option is set, code snippets provided in `@example` tag are linted based on the documentation's ESLint rules.
+
+The following options are useful for linting:
+
+- `eslintPathName`: The path to the ESLint configuration file.
+- `pluginsResolvePath`: The path to resolve plugins used in the ESLint configuration files.
+
+---
+
+## Build the Plugin
+
+Before using any command that makes use of this plugin, make sure to run the `build` command:
+
+```bash
+yarn build
+```

docs-util/packages/typedoc-plugin-modules/package.json → docs-util/packages/typedoc-plugin-custom/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "typedoc-plugin-modules",
+  "name": "typedoc-plugin-custom",
   "private": true,
   "version": "0.0.0",
   "license": "MIT",
@@ -32,7 +32,10 @@
     "typedoc"
   ],
   "dependencies": {
+    "eslint": "^8.53.0",
     "glob": "^10.3.10",
-    "typedoc-plugin-markdown": "^3.16.0"
+    "typedoc-plugin-markdown": "^3.16.0",
+    "utils": "*",
+    "yaml": "^2.3.3"
   }
 }

docs-util/packages/typedoc-plugin-custom/src/api-ignore.ts

@@ -0,0 +1,30 @@
+import {
+  Application,
+  Context,
+  Converter,
+  ParameterType,
+  ReflectionKind,
+} from "typedoc"
+
+export function load(app: Application) {
+  app.options.addDeclaration({
+    name: "ignoreApi",
+    help: "Whether to ignore items with the `@apiIgnore` tag.",
+    type: ParameterType.Boolean, // The default
+    defaultValue: false,
+  })
+
+  app.converter.on(Converter.EVENT_RESOLVE_BEGIN, (context: Context) => {
+    for (const reflection of context.project.getReflectionsByKind(
+      ReflectionKind.All
+    )) {
+      if (reflection.comment?.hasModifier("@apiIgnore")) {
+        if (app.options.getValue("ignoreApi")) {
+          context.project.removeReflection(reflection)
+        } else {
+          reflection.comment.removeModifier(`@apiIgnore`)
+        }
+      }
+    }
+  })
+}