diff --git a/packages/core/types/src/common/config-module.ts b/packages/core/types/src/common/config-module.ts index d8e034277c..771de5a884 100644 --- a/packages/core/types/src/common/config-module.ts +++ b/packages/core/types/src/common/config-module.ts @@ -29,17 +29,19 @@ export type AdminOptions = { */ path?: `/${string}` /** - * The directory where the admin build is output. This is where the build process will place the generated files. + * The directory where the admin build is output. This is where the build process places the generated files. * The default value is `./build`. */ outDir?: string /** - * The URL of your Medusa server. Defaults to an empty string, which means requests will hit the same server that serves the dashboard. + * The URL of your Medusa backend. Defaults to an empty string, which means requests will hit the same server that serves the dashboard. */ backendUrl?: string /** * Configure the Vite configuration for the admin dashboard. This function receives the default Vite configuration * and returns the modified configuration. The default value is `undefined`. + * + * @privateRemarks TODO Add example */ vite?: (config: InlineConfig) => InlineConfig } @@ -216,7 +218,7 @@ export type ProjectConfigOptions = { * @ignore * @deprecated * - * @privateRemark + * @privateRemarks * only postgres is supported, so this config has no effect */ database_type?: string @@ -379,12 +381,9 @@ export type ProjectConfigOptions = { session_options?: SessionOptions /** - * @deprecated - use `http.compression` instead * Configure HTTP compression from the application layer. If you have access to the HTTP server, the recommended approach would be to enable it there. * However, some platforms don't offer access to the HTTP layer and in those cases, this is a good alternative. * - * Its value is an object that has the following properties: - * * If you enable HTTP compression and you want to disable it for specific API Routes, you can pass in the request header `"x-no-compression": true`. * * @example @@ -402,6 +401,9 @@ export type ProjectConfigOptions = { * // ... * } * ``` + * + * @deprecated use {@link http }'s `compression` property instead. + * */ http_compression?: HttpCompressionOptions @@ -713,7 +715,8 @@ export type ProjectConfigOptions = { * * `medusa-config.js` exports an object having the following properties: * - * - {@link ConfigModule.projectConfig | projectConfig}: (required): An object that holds general configurations related to the Medusa backend, such as database or CORS configurations. + * - {@link ConfigModule.projectConfig | projectConfig} (required): An object that holds general configurations related to the Medusa backend, such as database or CORS configurations. + * - {@link ConfigModule.admin | admin}: An object that holds admin-related configurations. * - {@link ConfigModule.plugins | plugins}: An array of plugin configurations that defines what plugins are installed and optionally specifies each of their configurations. * - {@link ConfigModule.modules | modules}: An object that defines what modules are installed and optionally specifies each of their configurations. * - {@link ConfigModule.featureFlags | featureFlags}: An object that enables or disables features guarded by a feature flag. @@ -723,7 +726,7 @@ export type ProjectConfigOptions = { * ```js title="medusa-config.js" * module.exports = { * projectConfig, - * plugins, + * admin, * modules, * featureFlags, * } @@ -748,6 +751,16 @@ export type ConfigModule = { /** * Admin dashboard configurations. + * + * @example + * ```js title="medusa-config.js" + * module.exports = { + * admin: { + * backendUrl: process.env.MEDUSA_BACKEND_URL || "http://localhost:9000" + * } + * // ... + * } + * ``` */ admin?: AdminOptions @@ -863,6 +876,12 @@ export type ConfigModule = { */ featureFlags: Record + /** + * @ignore + * + * @privateRemarks + * Since this is a temporary config, maybe let's not include it in the generated reference for now. + */ directories?: { srcDir?: string } diff --git a/www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/medusa-config.ts b/www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/medusa-config.ts index 324a50e5a5..abec1d5aa5 100644 --- a/www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/medusa-config.ts +++ b/www/utils/packages/typedoc-generate-references/src/constants/merger-custom-options/medusa-config.ts @@ -9,13 +9,7 @@ const medusaConfigOptions: FormattingOptionsType = { frontmatterData: { slug: "/references/medusa-config", }, - reflectionDescription: `In this document, you’ll learn how to create a file service in the Medusa backend and the methods you must implement in it. - -## Prerequisites - -This document assumes you already followed along with the [Prepare Environment documentation](https://docs.medusajs.com/development/backend/prepare-environment) and have a Medusa backend installed. - ----`, + reflectionDescription: `In this document, you’ll learn how to create a file service in the Medusa backend and the methods you must implement in it.`, reflectionTitle: { fullReplacement: "Configure Medusa Backend", }, @@ -25,6 +19,8 @@ This document assumes you already followed along with the [Prepare Environment d ...baseSectionsOptions, member_declaration_title: false, member_declaration_children: true, + member_declaration_typeDeclaration: false, + member_declaration_signatures: false, }, }, } diff --git a/www/utils/packages/typedoc-generate-references/src/constants/references.ts b/www/utils/packages/typedoc-generate-references/src/constants/references.ts index 7258ba19bc..4b964f48e2 100644 --- a/www/utils/packages/typedoc-generate-references/src/constants/references.ts +++ b/www/utils/packages/typedoc-generate-references/src/constants/references.ts @@ -22,9 +22,9 @@ export const modules = [ const allReferences = [ ...modules, "file", - "js-client", + // "js-client", "medusa-config", - "medusa-react", + // "medusa-react", "medusa", "notification", "payment-provider", diff --git a/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/comment-tag.ts b/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/comment-tag.ts index 12b643effa..067992b369 100644 --- a/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/comment-tag.ts +++ b/www/utils/packages/typedoc-plugin-markdown-medusa/src/resources/helpers/comment-tag.ts @@ -17,6 +17,11 @@ export default function (theme: MarkdownTheme) { const tagTitle = camelToTitleCase(tag.tag.substring(1)), tagContent = Handlebars.helpers.comment(tag.content) + if (tag.tag === "@deprecated") { + // show as admonition + return `:::note[Deprecated]\n\n${tagContent}\n\n:::` + } + if (showCommentsAsHeader) { return `${Handlebars.helpers.titleLevel.call( parent