asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: enhance how references are generated (#5805)

Browse Source 
* adjusted configurations

* enhancements to tool and configurations

* change reference in docs

* fixed issue in workflows reference

* added project name

* more optimizations

* fix context error

* added a types reference

* resolved missing types

* fix reference reflection types not having children

* add an expand url parameter

* added new option to the README

* added details about new option
This commit is contained in:
Shahed Nasser
2023-12-05 15:29:41 +02:00
committed by GitHub
parent a418e6cebc
commit 892d737c1f
4358 changed files with 947876 additions and 534760 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/services/classes/services.ShippingProfileService.mdx
+881
View File
@@ -0,0 +1,881 @@
---
displayed_sidebar: servicesSidebar
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# ShippingProfileService
Provides layer to manipulate profiles.
## Implements
## constructor
### Parameters
<ParameterTypes parameters={[
{
"name": "__namedParameters",
"type": "`InjectedDependencies`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
___
## Properties
<ParameterTypes parameters={[
{
"name": "__configModule__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__container__",
"type": "`any`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "__moduleDeclaration__",
"type": "`Record<string, unknown>`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "customShippingOptionService_",
"type": "[CustomShippingOptionService](services.CustomShippingOptionService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "featureFlagRouter_",
"type": "`FlagRouter`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "manager_",
"type": "`EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productRepository_",
"type": "Repository&#60;[Product](../../entities/classes/entities.Product.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productService_",
"type": "[ProductService](services.ProductService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shippingOptionService_",
"type": "[ShippingOptionService](services.ShippingOptionService.mdx)",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "shippingProfileRepository_",
"type": "Repository&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62; & `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "transactionManager_",
"type": "`undefined` \\| `EntityManager`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
___
## Accessors
### activeManager\_
#### Returns
<ParameterTypes parameters={[
{
"name": "EntityManager",
"type": "`EntityManager`",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
## Methods
### addProduct
#### Parameters
<ParameterTypes parameters={[
{
"name": "profileId",
"type": "`string`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productId",
"type": "`string` \\| `string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
#### Deprecated
use [addProducts](services.ShippingProfileService.mdx#addproducts) instead
___
### addProducts
Adds a product or an array of products to the profile.
#### Parameters
<ParameterTypes parameters={[
{
"name": "profileId",
"type": "`string`",
"description": "the profile to add the products to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productId",
"type": "`string` \\| `string`[]",
"description": "the ID of the product or multiple products to add.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of update",
"expandable": false,
"children": []
}
]} />
___
### addShippingOption
Adds a shipping option to the profile. The shipping option can be used to
fulfill the products in the products field.
#### Parameters
<ParameterTypes parameters={[
{
"name": "profileId",
"type": "`string`",
"description": "the profile to apply the shipping option to",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "optionId",
"type": "`string` \\| `string`[]",
"description": "the ID of the option or multiple options to add to the profile",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the model update operation",
"expandable": false,
"children": []
}
]} />
___
### atomicPhase\_
Wraps some work within a transactional block. If the service already has
a transaction manager attached this will be reused, otherwise a new
transaction manager is created.
#### Type Parameters
<ParameterTypes parameters={[
{
"name": "TResult",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "TError",
"type": "`object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Parameters
<ParameterTypes parameters={[
{
"name": "work",
"type": "(`transactionManager`: `EntityManager`) => Promise&#60;TResult&#62;",
"description": "the transactional work to be done",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "isolationOrErrorHandler",
"type": "`IsolationLevel` \\| (`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "the isolation level to be used for the work.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "maybeErrorHandlerOrDontFail",
"type": "(`error`: `TError`) => Promise&#60;void \\| TResult&#62;",
"description": "Potential error handler",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;TResult&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the transactional work",
"expandable": false,
"children": []
}
]} />
___
### create
Creates a new shipping profile.
#### Parameters
<ParameterTypes parameters={[
{
"name": "profile",
"type": "`CreateShippingProfile`",
"description": "the shipping profile to create from",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the create operation",
"expandable": false,
"children": []
}
]} />
___
### createDefault
Creates a default shipping profile, if this does not already exist.
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the shipping profile",
"expandable": false,
"children": []
}
]} />
___
### createGiftCardDefault
Creates a default shipping profile, for gift cards if unless it already
exists.
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the shipping profile",
"expandable": false,
"children": []
}
]} />
___
### delete
Deletes a profile with a given profile id.
#### Parameters
<ParameterTypes parameters={[
{
"name": "profileId",
"type": "`string`",
"description": "the id of the profile to delete. Must be\n castable as an ObjectId",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the delete operation.",
"expandable": false,
"children": []
}
]} />
___
### fetchCartOptions
Finds all the shipping profiles that cover the products in a cart, and
validates all options that are available for the cart.
#### Parameters
<ParameterTypes parameters={[
{
"name": "cart",
"type": "`any`",
"description": "the cart object to find shipping options for",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ShippingOption](../../entities/classes/entities.ShippingOption.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "a list of the available shipping options",
"expandable": false,
"children": []
}
]} />
___
### getMapProfileIdsByProductIds
#### Parameters
<ParameterTypes parameters={[
{
"name": "productIds",
"type": "`string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;Map&#60;string, string&#62;&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### getProfilesInCart
Returns a list of all the productIds in the cart.
#### Parameters
<ParameterTypes parameters={[
{
"name": "cart",
"type": "[Cart](../../entities/classes/entities.Cart.mdx)",
"description": "the cart to extract products from",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;string[]&#62;",
"optional": false,
"defaultValue": "",
"description": "a list of product ids",
"expandable": false,
"children": []
}
]} />
___
### list
#### Parameters
<ParameterTypes parameters={[
{
"name": "selector",
"type": "[Selector](../../medusa/types/medusa.Selector.mdx)&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;",
"description": "the query object for find",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
},
{
"name": "config",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;",
"description": "the config object for find",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)[]&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of the find operation",
"expandable": false,
"children": []
}
]} />
___
### removeProducts
Removes a product or an array of products from the profile.
#### Parameters
<ParameterTypes parameters={[
{
"name": "profileId",
"type": "`null` \\| `string`",
"description": "the profile to add the products to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "productId",
"type": "`string` \\| `string`[]",
"description": "the ID of the product or multiple products to add.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;void \\| [ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the result of update",
"expandable": false,
"children": []
}
]} />
___
### retrieve
Gets a profile by id.
Throws in case of DB Error and if profile was not found.
#### Parameters
<ParameterTypes parameters={[
{
"name": "profileId",
"type": "`string`",
"description": "the id of the profile to get.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "options",
"type": "[FindConfig](../../medusa/interfaces/medusa.FindConfig.mdx)&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;",
"description": "options opf the query.",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the profile document.",
"expandable": false,
"children": []
}
]} />
___
### retrieveDefault
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;null \\| [ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### retrieveForProducts
#### Parameters
<ParameterTypes parameters={[
{
"name": "productIds",
"type": "`string` \\| `string`[]",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;object&#62;",
"optional": false,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### retrieveGiftCardDefault
Retrieves the default gift card profile
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;null \\| [ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "the shipping profile for gift cards",
"expandable": false,
"children": []
}
]} />
___
### shouldRetryTransaction\_
#### Parameters
<ParameterTypes parameters={[
{
"name": "err",
"type": "`Record<string, unknown>` \\| `object`",
"description": "",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "boolean",
"type": "`boolean`",
"optional": true,
"defaultValue": "",
"description": "",
"expandable": false,
"children": []
}
]} />
___
### update
Updates a profile. Metadata updates and product updates should use
dedicated methods, e.g. `setMetadata`, `addProduct`, etc. The function
will throw errors if metadata or product updates are attempted.
#### Parameters
<ParameterTypes parameters={[
{
"name": "profileId",
"type": "`string`",
"description": "the id of the profile. Must be a string that\n can be casted to an ObjectId",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "update",
"type": "`UpdateShippingProfile`",
"description": "an object with the update values.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "Promise",
"type": "Promise&#60;[ShippingProfile](../../entities/classes/entities.ShippingProfile.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "resolves to the update result.",
"expandable": false,
"children": []
}
]} />
___
### withTransaction
#### Parameters
<ParameterTypes parameters={[
{
"name": "transactionManager",
"type": "`EntityManager`",
"description": "",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />
#### Returns
<ParameterTypes parameters={[
{
"name": "ShippingProfileService",
"type": "`object`",
"description": "Provides layer to manipulate profiles.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]} />