docs: edits and fixes to commerce module docs (#7468)

Apply edits and fixes to the commerce modules docs

www/utils/generated/typedoc-json-output/auth-models.json

@@ -1,33 +1,33 @@
 {
-	"id": 519,
+	"id": 242,
 	"name": "auth-models",
 	"variant": "project",
 	"kind": 1,
 	"flags": {},
 	"children": [
 		{
-			"id": 520,
-			"name": "AuthUser",
+			"id": 243,
+			"name": "AuthIdentity",
 			"variant": "declaration",
 			"kind": 128,
 			"flags": {},
 			"children": [
 				{
-					"id": 521,
+					"id": 244,
 					"name": "constructor",
 					"variant": "declaration",
 					"kind": 512,
 					"flags": {},
 					"signatures": [
 						{
-							"id": 522,
-							"name": "new AuthUser",
+							"id": 245,
+							"name": "new AuthIdentity",
 							"variant": "signature",
 							"kind": 16384,
 							"flags": {},
 							"type": {
 								"type": "reference",
-								"target": 520,
+								"target": 243,
 								"name": "default",
 								"package": "@medusajs/auth"
 							}
@@ -35,7 +35,7 @@
 					]
 				},
 				{
-					"id": 534,
+					"id": 256,
 					"name": "[OptionalProps]",
 					"variant": "declaration",
 					"kind": 1024,
@@ -43,7 +43,7 @@
 					"type": {
 						"type": "reference",
 						"target": {
-							"sourceFileName": "../../../packages/auth/src/models/auth-user.ts",
+							"sourceFileName": "../../../../packages/modules/auth/src/models/auth-identity.ts",
 							"qualifiedName": "OptionalFields"
 						},
 						"name": "OptionalFields",
@@ -51,7 +51,7 @@
 					}
 				},
 				{
-					"id": 523,
+					"id": 246,
 					"name": "id",
 					"variant": "declaration",
 					"kind": 1024,
@@ -62,7 +62,7 @@
 					}
 				},
 				{
-					"id": 524,
+					"id": 247,
 					"name": "entity_id",
 					"variant": "declaration",
 					"kind": 1024,
@@ -73,7 +73,7 @@
 					}
 				},
 				{
-					"id": 525,
+					"id": 248,
 					"name": "provider",
 					"variant": "declaration",
 					"kind": 1024,
@@ -84,18 +84,7 @@
 					}
 				},
 				{
-					"id": 526,
-					"name": "scope",
-					"variant": "declaration",
-					"kind": 1024,
-					"flags": {},
-					"type": {
-						"type": "intrinsic",
-						"name": "string"
-					}
-				},
-				{
-					"id": 527,
+					"id": 249,
 					"name": "user_metadata",
 					"variant": "declaration",
 					"kind": 1024,
@@ -130,34 +119,42 @@
 					}
 				},
 				{
-					"id": 528,
+					"id": 250,
 					"name": "app_metadata",
 					"variant": "declaration",
 					"kind": 1024,
 					"flags": {},
 					"type": {
-						"type": "reference",
-						"target": {
-							"sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
-							"qualifiedName": "Record"
-						},
-						"typeArguments": [
+						"type": "union",
+						"types": [
 							{
-								"type": "intrinsic",
-								"name": "string"
+								"type": "literal",
+								"value": null
 							},
 							{
-								"type": "intrinsic",
-								"name": "unknown"
+								"type": "reference",
+								"target": {
+									"sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
+									"qualifiedName": "Record"
+								},
+								"typeArguments": [
+									{
+										"type": "intrinsic",
+										"name": "string"
+									},
+									{
+										"type": "intrinsic",
+										"name": "unknown"
+									}
+								],
+								"name": "Record",
+								"package": "typescript"
 							}
-						],
-						"name": "Record",
-						"package": "typescript"
-					},
-					"defaultValue": "{}"
+						]
+					}
 				},
 				{
-					"id": 529,
+					"id": 251,
 					"name": "provider_metadata",
 					"variant": "declaration",
 					"kind": 1024,
@@ -193,14 +190,14 @@
 					"defaultValue": "null"
 				},
 				{
-					"id": 530,
+					"id": 252,
 					"name": "onCreate",
 					"variant": "declaration",
 					"kind": 2048,
 					"flags": {},
 					"signatures": [
 						{
-							"id": 531,
+							"id": 253,
 							"name": "onCreate",
 							"variant": "signature",
 							"kind": 4096,
@@ -213,14 +210,14 @@
 					]
 				},
 				{
-					"id": 532,
+					"id": 254,
 					"name": "onInit",
 					"variant": "declaration",
 					"kind": 2048,
 					"flags": {},
 					"signatures": [
 						{
-							"id": 533,
+							"id": 255,
 							"name": "onInit",
 							"variant": "signature",
 							"kind": 4096,
@@ -237,27 +234,26 @@
 				{
 					"title": "Constructors",
 					"children": [
-						521
+						244
 					]
 				},
 				{
 					"title": "Properties",
 					"children": [
-						534,
-						523,
-						524,
-						525,
-						526,
-						527,
-						528,
-						529
+						256,
+						246,
+						247,
+						248,
+						249,
+						250,
+						251
 					]
 				},
 				{
 					"title": "Methods",
 					"children": [
-						530,
-						532
+						252,
+						254
 					]
 				}
 			]
@@ -267,66 +263,62 @@
 		{
 			"title": "Classes",
 			"children": [
-				520
+				243
 			]
 		}
 	],
 	"packageName": "@medusajs/auth",
 	"symbolIdMap": {
-		"519": {
-			"sourceFileName": "../../../packages/auth/src/models/index.ts",
+		"242": {
+			"sourceFileName": "../../../../packages/modules/auth/src/models/index.ts",
 			"qualifiedName": ""
 		},
-		"520": {
-			"sourceFileName": "../../../packages/auth/src/models/auth-user.ts",
+		"243": {
+			"sourceFileName": "../../../../packages/modules/auth/src/models/auth-identity.ts",
 			"qualifiedName": "default"
 		},
-		"523": {
-			"sourceFileName": "../../../packages/auth/src/models/auth-user.ts",
+		"246": {
+			"sourceFileName": "../../../../packages/modules/auth/src/models/auth-identity.ts",
 			"qualifiedName": "default.id"
 		},
-		"524": {
-			"sourceFileName": "../../../packages/auth/src/models/auth-user.ts",
+		"247": {
+			"sourceFileName": "../../../../packages/modules/auth/src/models/auth-identity.ts",
 			"qualifiedName": "default.entity_id"
 		},
-		"525": {
-			"sourceFileName": "../../../packages/auth/src/models/auth-user.ts",
+		"248": {
+			"sourceFileName": "../../../../packages/modules/auth/src/models/auth-identity.ts",
 			"qualifiedName": "default.provider"
 		},
-		"526": {
-			"sourceFileName": "../../../packages/auth/src/models/auth-user.ts",
-			"qualifiedName": "default.scope"
-		},
-		"527": {
-			"sourceFileName": "../../../packages/auth/src/models/auth-user.ts",
+		"249": {
+			"sourceFileName": "../../../../packages/modules/auth/src/models/auth-identity.ts",
 			"qualifiedName": "default.user_metadata"
 		},
-		"528": {
-			"sourceFileName": "../../../packages/auth/src/models/auth-user.ts",
+		"250": {
+			"sourceFileName": "../../../../packages/modules/auth/src/models/auth-identity.ts",
 			"qualifiedName": "default.app_metadata"
 		},
-		"529": {
-			"sourceFileName": "../../../packages/auth/src/models/auth-user.ts",
+		"251": {
+			"sourceFileName": "../../../../packages/modules/auth/src/models/auth-identity.ts",
 			"qualifiedName": "default.provider_metadata"
 		},
-		"530": {
-			"sourceFileName": "../../../packages/auth/src/models/auth-user.ts",
+		"252": {
+			"sourceFileName": "../../../../packages/modules/auth/src/models/auth-identity.ts",
 			"qualifiedName": "default.onCreate"
 		},
-		"531": {
-			"sourceFileName": "../../../packages/auth/src/models/auth-user.ts",
+		"253": {
+			"sourceFileName": "../../../../packages/modules/auth/src/models/auth-identity.ts",
 			"qualifiedName": "default.onCreate"
 		},
-		"532": {
-			"sourceFileName": "../../../packages/auth/src/models/auth-user.ts",
+		"254": {
+			"sourceFileName": "../../../../packages/modules/auth/src/models/auth-identity.ts",
 			"qualifiedName": "default.onInit"
 		},
-		"533": {
-			"sourceFileName": "../../../packages/auth/src/models/auth-user.ts",
+		"255": {
+			"sourceFileName": "../../../../packages/modules/auth/src/models/auth-identity.ts",
 			"qualifiedName": "default.onInit"
 		},
-		"534": {
-			"sourceFileName": "../../../packages/auth/src/models/auth-user.ts",
+		"256": {
+			"sourceFileName": "../../../../packages/modules/auth/src/models/auth-identity.ts",
 			"qualifiedName": "default.[OptionalProps]"
 		}
 	}

www/utils/generated/typedoc-json-output/auth-provider.json

@@ -0,0 +1,505 @@
+{
+	"id": 0,
+	"name": "auth-provider",
+	"variant": "project",
+	"kind": 1,
+	"flags": {},
+	"children": [
+		{
+			"id": 1,
+			"name": "AbstractAuthModuleProvider",
+			"variant": "declaration",
+			"kind": 128,
+			"flags": {
+				"isAbstract": true
+			},
+			"children": [
+				{
+					"id": 2,
+					"name": "PROVIDER",
+					"variant": "declaration",
+					"kind": 1024,
+					"flags": {
+						"isPrivate": true,
+						"isStatic": true
+					},
+					"type": {
+						"type": "intrinsic",
+						"name": "string"
+					}
+				},
+				{
+					"id": 3,
+					"name": "DISPLAY_NAME",
+					"variant": "declaration",
+					"kind": 1024,
+					"flags": {
+						"isPrivate": true,
+						"isStatic": true
+					},
+					"type": {
+						"type": "intrinsic",
+						"name": "string"
+					}
+				},
+				{
+					"id": 12,
+					"name": "container_",
+					"variant": "declaration",
+					"kind": 1024,
+					"flags": {
+						"isProtected": true,
+						"isReadonly": true
+					},
+					"type": {
+						"type": "intrinsic",
+						"name": "any"
+					}
+				},
+				{
+					"id": 13,
+					"name": "provider",
+					"variant": "declaration",
+					"kind": 262144,
+					"flags": {
+						"isPublic": true
+					},
+					"getSignature": {
+						"id": 14,
+						"name": "provider",
+						"variant": "signature",
+						"kind": 524288,
+						"flags": {},
+						"type": {
+							"type": "intrinsic",
+							"name": "string"
+						}
+					}
+				},
+				{
+					"id": 15,
+					"name": "displayName",
+					"variant": "declaration",
+					"kind": 262144,
+					"flags": {
+						"isPublic": true
+					},
+					"getSignature": {
+						"id": 16,
+						"name": "displayName",
+						"variant": "signature",
+						"kind": 524288,
+						"flags": {},
+						"type": {
+							"type": "intrinsic",
+							"name": "string"
+						}
+					}
+				},
+				{
+					"id": 4,
+					"name": "constructor",
+					"variant": "declaration",
+					"kind": 512,
+					"flags": {
+						"isProtected": true
+					},
+					"signatures": [
+						{
+							"id": 5,
+							"name": "new AbstractAuthModuleProvider",
+							"variant": "signature",
+							"kind": 16384,
+							"flags": {},
+							"parameters": [
+								{
+									"id": 6,
+									"name": "__namedParameters",
+									"variant": "param",
+									"kind": 32768,
+									"flags": {},
+									"type": {
+										"type": "reflection",
+										"declaration": {
+											"id": 7,
+											"name": "__type",
+											"variant": "declaration",
+											"kind": 65536,
+											"flags": {}
+										}
+									}
+								},
+								{
+									"id": 8,
+									"name": "config",
+									"variant": "param",
+									"kind": 32768,
+									"flags": {},
+									"type": {
+										"type": "reflection",
+										"declaration": {
+											"id": 9,
+											"name": "__type",
+											"variant": "declaration",
+											"kind": 65536,
+											"flags": {},
+											"children": [
+												{
+													"id": 10,
+													"name": "provider",
+													"variant": "declaration",
+													"kind": 1024,
+													"flags": {},
+													"type": {
+														"type": "intrinsic",
+														"name": "string"
+													}
+												},
+												{
+													"id": 11,
+													"name": "displayName",
+													"variant": "declaration",
+													"kind": 1024,
+													"flags": {},
+													"type": {
+														"type": "intrinsic",
+														"name": "string"
+													}
+												}
+											],
+											"groups": [
+												{
+													"title": "Properties",
+													"children": [
+														10,
+														11
+													]
+												}
+											]
+										}
+									}
+								}
+							],
+							"type": {
+								"type": "reference",
+								"target": 1,
+								"name": "AbstractAuthModuleProvider",
+								"package": "@medusajs/utils"
+							}
+						}
+					]
+				},
+				{
+					"id": 17,
+					"name": "authenticate",
+					"variant": "declaration",
+					"kind": 2048,
+					"flags": {
+						"isAbstract": true
+					},
+					"signatures": [
+						{
+							"id": 18,
+							"name": "authenticate",
+							"variant": "signature",
+							"kind": 4096,
+							"flags": {},
+							"parameters": [
+								{
+									"id": 19,
+									"name": "data",
+									"variant": "param",
+									"kind": 32768,
+									"flags": {},
+									"type": {
+										"type": "reference",
+										"target": {
+											"sourceFileName": "../../../../packages/core/types/src/auth/common/provider.ts",
+											"qualifiedName": "AuthenticationInput"
+										},
+										"name": "AuthenticationInput",
+										"package": "@medusajs/types"
+									}
+								},
+								{
+									"id": 20,
+									"name": "authIdentityProviderService",
+									"variant": "param",
+									"kind": 32768,
+									"flags": {},
+									"type": {
+										"type": "reference",
+										"target": {
+											"sourceFileName": "../../../../packages/core/types/src/auth/provider.ts",
+											"qualifiedName": "AuthIdentityProviderService"
+										},
+										"name": "AuthIdentityProviderService",
+										"package": "@medusajs/types"
+									}
+								}
+							],
+							"type": {
+								"type": "reference",
+								"target": {
+									"sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
+									"qualifiedName": "Promise"
+								},
+								"typeArguments": [
+									{
+										"type": "reference",
+										"target": {
+											"sourceFileName": "../../../../packages/core/types/src/auth/common/provider.ts",
+											"qualifiedName": "AuthenticationResponse"
+										},
+										"name": "AuthenticationResponse",
+										"package": "@medusajs/types"
+									}
+								],
+								"name": "Promise",
+								"package": "typescript"
+							},
+							"implementationOf": {
+								"type": "reference",
+								"target": -1,
+								"name": "IAuthProvider.authenticate"
+							}
+						}
+					],
+					"implementationOf": {
+						"type": "reference",
+						"target": -1,
+						"name": "IAuthProvider.authenticate"
+					}
+				},
+				{
+					"id": 21,
+					"name": "validateCallback",
+					"variant": "declaration",
+					"kind": 2048,
+					"flags": {},
+					"signatures": [
+						{
+							"id": 22,
+							"name": "validateCallback",
+							"variant": "signature",
+							"kind": 4096,
+							"flags": {},
+							"parameters": [
+								{
+									"id": 23,
+									"name": "data",
+									"variant": "param",
+									"kind": 32768,
+									"flags": {},
+									"type": {
+										"type": "reference",
+										"target": {
+											"sourceFileName": "../../../../packages/core/types/src/auth/common/provider.ts",
+											"qualifiedName": "AuthenticationInput"
+										},
+										"name": "AuthenticationInput",
+										"package": "@medusajs/types"
+									}
+								},
+								{
+									"id": 24,
+									"name": "authIdentityProviderService",
+									"variant": "param",
+									"kind": 32768,
+									"flags": {},
+									"type": {
+										"type": "reference",
+										"target": {
+											"sourceFileName": "../../../../packages/core/types/src/auth/provider.ts",
+											"qualifiedName": "AuthIdentityProviderService"
+										},
+										"name": "AuthIdentityProviderService",
+										"package": "@medusajs/types"
+									}
+								}
+							],
+							"type": {
+								"type": "reference",
+								"target": {
+									"sourceFileName": "../../node_modules/typescript/lib/lib.es5.d.ts",
+									"qualifiedName": "Promise"
+								},
+								"typeArguments": [
+									{
+										"type": "reference",
+										"target": {
+											"sourceFileName": "../../../../packages/core/types/src/auth/common/provider.ts",
+											"qualifiedName": "AuthenticationResponse"
+										},
+										"name": "AuthenticationResponse",
+										"package": "@medusajs/types"
+									}
+								],
+								"name": "Promise",
+								"package": "typescript"
+							},
+							"implementationOf": {
+								"type": "reference",
+								"target": -1,
+								"name": "IAuthProvider.validateCallback"
+							}
+						}
+					],
+					"implementationOf": {
+						"type": "reference",
+						"target": -1,
+						"name": "IAuthProvider.validateCallback"
+					}
+				}
+			],
+			"groups": [
+				{
+					"title": "Constructors",
+					"children": [
+						4
+					]
+				},
+				{
+					"title": "Properties",
+					"children": [
+						2,
+						3,
+						12
+					]
+				},
+				{
+					"title": "Accessors",
+					"children": [
+						13,
+						15
+					]
+				},
+				{
+					"title": "Methods",
+					"children": [
+						17,
+						21
+					]
+				}
+			],
+			"implementedTypes": [
+				{
+					"type": "reference",
+					"target": {
+						"sourceFileName": "../../../../packages/core/types/src/auth/provider.ts",
+						"qualifiedName": "IAuthProvider"
+					},
+					"name": "IAuthProvider",
+					"package": "@medusajs/types"
+				}
+			]
+		}
+	],
+	"groups": [
+		{
+			"title": "Classes",
+			"children": [
+				1
+			]
+		}
+	],
+	"packageName": "@medusajs/utils",
+	"symbolIdMap": {
+		"0": {
+			"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
+			"qualifiedName": ""
+		},
+		"1": {
+			"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
+			"qualifiedName": "AbstractAuthModuleProvider"
+		},
+		"2": {
+			"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
+			"qualifiedName": "AbstractAuthModuleProvider.PROVIDER"
+		},
+		"3": {
+			"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
+			"qualifiedName": "AbstractAuthModuleProvider.DISPLAY_NAME"
+		},
+		"4": {
+			"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
+			"qualifiedName": "AbstractAuthModuleProvider.__constructor"
+		},
+		"5": {
+			"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
+			"qualifiedName": "AbstractAuthModuleProvider"
+		},
+		"6": {
+			"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
+			"qualifiedName": "__0"
+		},
+		"8": {
+			"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
+			"qualifiedName": "config"
+		},
+		"9": {
+			"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
+			"qualifiedName": "__type"
+		},
+		"10": {
+			"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
+			"qualifiedName": "__type.provider"
+		},
+		"11": {
+			"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
+			"qualifiedName": "__type.displayName"
+		},
+		"12": {
+			"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
+			"qualifiedName": "AbstractAuthModuleProvider.container_"
+		},
+		"13": {
+			"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
+			"qualifiedName": "AbstractAuthModuleProvider.provider"
+		},
+		"14": {
+			"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
+			"qualifiedName": "AbstractAuthModuleProvider.provider"
+		},
+		"15": {
+			"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
+			"qualifiedName": "AbstractAuthModuleProvider.displayName"
+		},
+		"16": {
+			"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
+			"qualifiedName": "AbstractAuthModuleProvider.displayName"
+		},
+		"17": {
+			"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
+			"qualifiedName": "AbstractAuthModuleProvider.authenticate"
+		},
+		"18": {
+			"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
+			"qualifiedName": "AbstractAuthModuleProvider.authenticate"
+		},
+		"19": {
+			"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
+			"qualifiedName": "data"
+		},
+		"20": {
+			"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
+			"qualifiedName": "authIdentityProviderService"
+		},
+		"21": {
+			"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
+			"qualifiedName": "AbstractAuthModuleProvider.validateCallback"
+		},
+		"22": {
+			"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
+			"qualifiedName": "AbstractAuthModuleProvider.validateCallback"
+		},
+		"23": {
+			"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
+			"qualifiedName": "data"
+		},
+		"24": {
+			"sourceFileName": "../../../../packages/core/utils/src/auth/abstract-auth-provider.ts",
+			"qualifiedName": "authIdentityProviderService"
+		}
+	}
+}