Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: generate references manually #10325

Merged
merged 3 commits into from
Nov 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
121 changes: 85 additions & 36 deletions www/apps/resources/generated/edit-dates.mjs

Large diffs are not rendered by default.

156 changes: 138 additions & 18 deletions www/apps/resources/generated/files-map.mjs

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion www/apps/resources/generated/sidebar.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -5919,7 +5919,7 @@ export const generatedSidebar = [
"type": "category",
"title": "Data Models",
"hasTitleStyling": true,
"autogenerate_path": "/references/product_models/classes",
"autogenerate_path": "/references/product_models/variables",
"children": [
{
"loaded": true,
Expand Down
36 changes: 18 additions & 18 deletions www/apps/resources/generated/slug-changes.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -6085,49 +6085,49 @@ export const slugChanges = [
"filePath": "/www/apps/resources/references/product/interfaces/product.IProductModuleService/page.mdx"
},
{
"origSlug": "/references/product_models/classes/product_models.Image",
"origSlug": "/references/product_models/variables/product_models.Image",
"newSlug": "/references/product/models/Image",
"filePath": "/www/apps/resources/references/product_models/classes/product_models.Image/page.mdx"
"filePath": "/www/apps/resources/references/product_models/variables/product_models.Image/page.mdx"
},
{
"origSlug": "/references/product_models/classes/product_models.Product",
"origSlug": "/references/product_models/variables/product_models.Product",
"newSlug": "/references/product/models/Product",
"filePath": "/www/apps/resources/references/product_models/classes/product_models.Product/page.mdx"
"filePath": "/www/apps/resources/references/product_models/variables/product_models.Product/page.mdx"
},
{
"origSlug": "/references/product_models/classes/product_models.ProductCategory",
"origSlug": "/references/product_models/variables/product_models.ProductCategory",
"newSlug": "/references/product/models/ProductCategory",
"filePath": "/www/apps/resources/references/product_models/classes/product_models.ProductCategory/page.mdx"
"filePath": "/www/apps/resources/references/product_models/variables/product_models.ProductCategory/page.mdx"
},
{
"origSlug": "/references/product_models/classes/product_models.ProductCollection",
"origSlug": "/references/product_models/variables/product_models.ProductCollection",
"newSlug": "/references/product/models/ProductCollection",
"filePath": "/www/apps/resources/references/product_models/classes/product_models.ProductCollection/page.mdx"
"filePath": "/www/apps/resources/references/product_models/variables/product_models.ProductCollection/page.mdx"
},
{
"origSlug": "/references/product_models/classes/product_models.ProductOption",
"origSlug": "/references/product_models/variables/product_models.ProductOption",
"newSlug": "/references/product/models/ProductOption",
"filePath": "/www/apps/resources/references/product_models/classes/product_models.ProductOption/page.mdx"
"filePath": "/www/apps/resources/references/product_models/variables/product_models.ProductOption/page.mdx"
},
{
"origSlug": "/references/product_models/classes/product_models.ProductOptionValue",
"origSlug": "/references/product_models/variables/product_models.ProductOptionValue",
"newSlug": "/references/product/models/ProductOptionValue",
"filePath": "/www/apps/resources/references/product_models/classes/product_models.ProductOptionValue/page.mdx"
"filePath": "/www/apps/resources/references/product_models/variables/product_models.ProductOptionValue/page.mdx"
},
{
"origSlug": "/references/product_models/classes/product_models.ProductTag",
"origSlug": "/references/product_models/variables/product_models.ProductTag",
"newSlug": "/references/product/models/ProductTag",
"filePath": "/www/apps/resources/references/product_models/classes/product_models.ProductTag/page.mdx"
"filePath": "/www/apps/resources/references/product_models/variables/product_models.ProductTag/page.mdx"
},
{
"origSlug": "/references/product_models/classes/product_models.ProductType",
"origSlug": "/references/product_models/variables/product_models.ProductType",
"newSlug": "/references/product/models/ProductType",
"filePath": "/www/apps/resources/references/product_models/classes/product_models.ProductType/page.mdx"
"filePath": "/www/apps/resources/references/product_models/variables/product_models.ProductType/page.mdx"
},
{
"origSlug": "/references/product_models/classes/product_models.ProductVariant",
"origSlug": "/references/product_models/variables/product_models.ProductVariant",
"newSlug": "/references/product/models/ProductVariant",
"filePath": "/www/apps/resources/references/product_models/classes/product_models.ProductVariant/page.mdx"
"filePath": "/www/apps/resources/references/product_models/variables/product_models.ProductVariant/page.mdx"
},
{
"origSlug": "/references/promotion/IPromotionModuleService/methods/promotion.IPromotionModuleService.addPromotionBuyRules",
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
displayed_sidebar: apiKeyReference
---

import { TypeList } from "docs-ui"

# Constructor

**Constructor**: (...`args`: `any`[]) => T \| () => T

## Parameters

<TypeList types={[{"name":"args","type":"`any`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"

# FilterQuery

**FilterQuery**: Prev extends `never` ? `never` : &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
**FilterQuery**: Prev extends `never` ? `never` : T extends [Constructor](../api_key.Constructor/page.mdx)&#60;infer Prototype&#62; ? [FilterQueryProperties](../api_key.FilterQueryProperties/page.mdx)&#60;Prototype, Prev&#62; : [FilterQueryProperties](../api_key.FilterQueryProperties/page.mdx)&#60;T, Prev&#62;
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
displayed_sidebar: apiKeyReference
---

import { TypeList } from "docs-ui"

# FilterQueryProperties

**FilterQueryProperties**: &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
displayed_sidebar: cartReference
---

import { TypeList } from "docs-ui"

# Constructor

**Constructor**: (...`args`: `any`[]) => T \| () => T

## Parameters

<TypeList types={[{"name":"args","type":"`any`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"

# FilterQuery

**FilterQuery**: Prev extends `never` ? `never` : &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
**FilterQuery**: Prev extends `never` ? `never` : T extends [Constructor](../cart.Constructor/page.mdx)&#60;infer Prototype&#62; ? [FilterQueryProperties](../cart.FilterQueryProperties/page.mdx)&#60;Prototype, Prev&#62; : [FilterQueryProperties](../cart.FilterQueryProperties/page.mdx)&#60;T, Prev&#62;
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
displayed_sidebar: cartReference
---

import { TypeList } from "docs-ui"

# FilterQueryProperties

**FilterQueryProperties**: &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ import { TypeList } from "docs-ui"

# Currency - Currency Module Data Models Reference

This documentation provides a reference to the Currency . This belongs to the Currency Module.
This documentation provides a reference to the Currency data model. It belongs to the Currency Module.

<TypeList types={[{"name":"code","type":"PrimaryKeyModifier&#60;TextProperty&#62;","description":"The ISO 3-character currency code. For example, `USD`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol","type":"`TextProperty`","description":"The symbol of the currency. For example, `$`.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"symbol_native","type":"`TextProperty`","description":"The native symbol of the currency, if it has a different local symbol.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"name","type":"`TextProperty`","description":"The name of the currency","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"decimal_digits","type":"`NumberProperty`","description":"How many digits are after the decimal separator for prices in this currency.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"rounding","type":"`BigNumberProperty`","description":"The rounding percision of prices in this currency.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="Currency"/>
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
displayed_sidebar: customerReference
---

import { TypeList } from "docs-ui"

# Constructor

**Constructor**: (...`args`: `any`[]) => T \| () => T

## Parameters

<TypeList types={[{"name":"args","type":"`any`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"

# FilterQuery

**FilterQuery**: Prev extends `never` ? `never` : &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
**FilterQuery**: Prev extends `never` ? `never` : T extends [Constructor](../customer.Constructor/page.mdx)&#60;infer Prototype&#62; ? [FilterQueryProperties](../customer.FilterQueryProperties/page.mdx)&#60;Prototype, Prev&#62; : [FilterQueryProperties](../customer.FilterQueryProperties/page.mdx)&#60;T, Prev&#62;
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
displayed_sidebar: customerReference
---

import { TypeList } from "docs-ui"

# FilterQueryProperties

**FilterQueryProperties**: &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ const Product = model.define("product", {

## Parameters

<TypeList types={[{"name":"entityBuilder","type":"T","description":"A function that returns the data model this model is related to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ManyToManyOptions](../../../entity_builder/types/dml.entity_builder.ManyToManyOptions/page.mdx)","description":"The relationship's options.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"mappedBy","type":"`string`","description":"The name of the relationship as defined in the other\ndata model. This is only required by the `belongsTo` and `manyToMany`\nrelationship method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pivotTable","type":"`string`","description":"The name of the pivot table\ncreated in the database for this relationship.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pivotEntity","type":"() => [DmlEntity](../../../entity/classes/dml.entity.DmlEntity/page.mdx)&#60;any, any&#62;","description":"A function that returns the data model\nrepresenting the pivot table created in the\ndatabase for this relationship.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="manyToMany"/>
<TypeList types={[{"name":"entityBuilder","type":"T","description":"A function that returns the data model this model is related to.","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"options","type":"[ManyToManyOptions](../../../entity_builder/types/dml.entity_builder.ManyToManyOptions/page.mdx)","description":"The relationship's options.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"mappedBy","type":"`string`","description":"The name of the relationship as defined in the other\ndata model. This is only required by the `belongsTo` and `manyToMany`\nrelationship method.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pivotTable","type":"`string`","description":"The name of the pivot table\ncreated in the database for this relationship.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"joinColumn","type":"`string`","description":"The column name in the pivot table that for the current entity","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"inverseJoinColumn","type":"`string`","description":"The column name in the pivot table for the opposite entity","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"pivotEntity","type":"() => [DmlEntity](../../../entity/classes/dml.entity.DmlEntity/page.mdx)&#60;any, any&#62;","description":"A function that returns the data model\nrepresenting the pivot table created in the\ndatabase for this relationship.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="manyToMany"/>
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,22 @@ created in the database for this relationship.

___

## joinColumn

`Optional` **joinColumn**: `string`

The column name in the pivot table that for the current entity

___

## inverseJoinColumn

`Optional` **inverseJoinColumn**: `string`

The column name in the pivot table for the opposite entity

___

## pivotEntity

`Optional` **pivotEntity**: () => [DmlEntity](../../../entity/classes/dml.entity.DmlEntity/page.mdx)&#60;any, any&#62;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
displayed_sidebar: fulfillmentReference
---

import { TypeList } from "docs-ui"

# Constructor

**Constructor**: (...`args`: `any`[]) => T \| () => T

## Parameters

<TypeList types={[{"name":"args","type":"`any`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"

# FilterQuery

**FilterQuery**: Prev extends `never` ? `never` : &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
**FilterQuery**: Prev extends `never` ? `never` : T extends [Constructor](../fulfillment.Constructor/page.mdx)&#60;infer Prototype&#62; ? [FilterQueryProperties](../fulfillment.FilterQueryProperties/page.mdx)&#60;Prototype, Prev&#62; : [FilterQueryProperties](../fulfillment.FilterQueryProperties/page.mdx)&#60;T, Prev&#62;
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
displayed_sidebar: fulfillmentReference
---

import { TypeList } from "docs-ui"

# FilterQueryProperties

**FilterQueryProperties**: &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
displayed_sidebar: inventoryNextReference
---

import { TypeList } from "docs-ui"

# Constructor

**Constructor**: (...`args`: `any`[]) => T \| () => T

## Parameters

<TypeList types={[{"name":"args","type":"`any`[]","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="__type"/>
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ import { TypeList } from "docs-ui"

# FilterQuery

**FilterQuery**: Prev extends `never` ? `never` : &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
**FilterQuery**: Prev extends `never` ? `never` : T extends [Constructor](../inventory_next.Constructor/page.mdx)&#60;infer Prototype&#62; ? [FilterQueryProperties](../inventory_next.FilterQueryProperties/page.mdx)&#60;Prototype, Prev&#62; : [FilterQueryProperties](../inventory_next.FilterQueryProperties/page.mdx)&#60;T, Prev&#62;
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
displayed_sidebar: inventoryNextReference
---

import { TypeList } from "docs-ui"

# FilterQueryProperties

**FilterQueryProperties**: &#123; [Key in keyof T]?: T[Key] extends boolean \| number \| string \| bigint \| symbol \| Date ? T[Key] \| OperatorMap&#60;T[Key]&#62; : T[Key] extends infer U ? U extends Object ? V extends object ? FilterQuery&#60;Partial&#60;V&#62;, PrevLimit[Prev]&#62; : never : never : never &#125;
Loading
Loading