feat(link-modules,modules-sdk, utils, types, products) - Remote Link and Link modules (#4695)
What:
- Definition of all Modules links
- `link-modules` package to manage the creation of all pre-defined link or custom ones
```typescript
import { initialize as iniInventory } from "@medusajs/inventory";
import { initialize as iniProduct } from "@medusajs/product";
import {
initialize as iniLinks,
runMigrations as migrateLinks
} from "@medusajs/link-modules";
await Promise.all([iniInventory(), iniProduct()]);
await migrateLinks(); // create tables based on previous loaded modules
await iniLinks(); // load link based on previous loaded modules
await iniLinks(undefined, [
{
serviceName: "product_custom_translation_service_link",
isLink: true,
databaseConfig: {
tableName: "product_transalations",
},
alias: [
{
name: "translations",
},
],
primaryKeys: ["id", "product_id", "translation_id"],
relationships: [
{
serviceName: Modules.PRODUCT,
primaryKey: "id",
foreignKey: "product_id",
alias: "product",
},
{
serviceName: "custom_translation_service",
primaryKey: "id",
foreignKey: "translation_id",
alias: "transalation",
deleteCascade: true,
},
],
extends: [
{
serviceName: Modules.PRODUCT,
relationship: {
serviceName: "product_custom_translation_service_link",
primaryKey: "product_id",
foreignKey: "id",
alias: "translations",
isList: true,
},
},
{
serviceName: "custom_translation_service",
relationship: {
serviceName: "product_custom_translation_service_link",
primaryKey: "product_id",
foreignKey: "id",
alias: "product_link",
},
},
],
},
]); // custom links
```
Remote Link
```typescript
import { RemoteLink, Modules } from "@medusajs/modules-sdk";
// [...] initialize modules and links
const remoteLink = new RemoteLink();
// upsert the relationship
await remoteLink.create({ // one (object) or many (array)
[Modules.PRODUCT]: {
variant_id: "var_abc",
},
[Modules.INVENTORY]: {
inventory_item_id: "iitem_abc",
},
data: { // optional additional fields
required_quantity: 5
}
});
// dismiss (doesn't cascade)
await remoteLink.dismiss({ // one (object) or many (array)
[Modules.PRODUCT]: {
variant_id: "var_abc",
},
[Modules.INVENTORY]: {
inventory_item_id: "iitem_abc",
},
});
// delete
await remoteLink.delete({
// every key is a module
[Modules.PRODUCT]: {
// every key is a linkable field
variant_id: "var_abc", // single or multiple values
},
});
// restore
await remoteLink.restore({
// every key is a module
[Modules.PRODUCT]: {
// every key is a linkable field
variant_id: "var_abc", // single or multiple values
},
});
```
Co-authored-by: Riqwan Thamir <5105988+riqwan@users.noreply.github.com>
This commit is contained in:
co-authored by
Riqwan Thamir
parent
bc4c9e0d32
commit
4d16acf5f0
@@ -6196,10 +6196,10 @@ __metadata:
|
||||
"@medusajs/modules-sdk": ^1.8.8
|
||||
"@medusajs/types": ^1.8.8
|
||||
cross-env: ^5.2.1
|
||||
jest: ^25.5.4
|
||||
jest: ^29.6.3
|
||||
rimraf: ^5.0.1
|
||||
ts-jest: ^25.5.1
|
||||
typescript: ^4.4.4
|
||||
ts-jest: ^29.1.1
|
||||
typescript: ^5.1.6
|
||||
languageName: unknown
|
||||
linkType: soft
|
||||
|
||||
@@ -6212,10 +6212,10 @@ __metadata:
|
||||
awilix: ^8.0.0
|
||||
cross-env: ^5.2.1
|
||||
ioredis: ^5.3.1
|
||||
jest: ^25.5.4
|
||||
jest: ^29.6.3
|
||||
rimraf: ^5.0.1
|
||||
ts-jest: ^25.5.1
|
||||
typescript: ^4.4.4
|
||||
ts-jest: ^29.1.1
|
||||
typescript: ^5.1.6
|
||||
languageName: unknown
|
||||
linkType: soft
|
||||
|
||||
@@ -6241,10 +6241,10 @@ __metadata:
|
||||
"@medusajs/types": ^1.8.10
|
||||
"@medusajs/utils": ^1.9.2
|
||||
cross-env: ^5.2.1
|
||||
jest: ^25.5.2
|
||||
jest: ^29.6.3
|
||||
rimraf: ^5.0.1
|
||||
ts-jest: ^25.5.1
|
||||
typescript: ^4.4.4
|
||||
ts-jest: ^29.1.1
|
||||
typescript: ^5.1.6
|
||||
ulid: ^2.3.0
|
||||
languageName: unknown
|
||||
linkType: soft
|
||||
@@ -6260,11 +6260,11 @@ __metadata:
|
||||
bullmq: ^3.5.6
|
||||
cross-env: ^5.2.1
|
||||
ioredis: ^5.2.5
|
||||
jest: ^25.5.2
|
||||
jest: ^29.6.3
|
||||
medusa-test-utils: ^1.1.40
|
||||
rimraf: ^5.0.1
|
||||
ts-jest: ^25.5.1
|
||||
typescript: ^4.4.4
|
||||
ts-jest: ^29.1.1
|
||||
typescript: ^5.1.6
|
||||
languageName: unknown
|
||||
linkType: soft
|
||||
|
||||
@@ -6310,11 +6310,32 @@ __metadata:
|
||||
"@medusajs/utils": ^1.9.1
|
||||
awilix: ^8.0.0
|
||||
cross-env: ^5.2.1
|
||||
jest: ^25.5.4
|
||||
jest: ^29.6.3
|
||||
rimraf: ^5.0.1
|
||||
ts-jest: ^25.5.1
|
||||
ts-jest: ^29.1.1
|
||||
typeorm: ^0.3.16
|
||||
typescript: ^4.4.4
|
||||
typescript: ^5.1.6
|
||||
languageName: unknown
|
||||
linkType: soft
|
||||
|
||||
"@medusajs/link-modules@workspace:packages/link-modules":
|
||||
version: 0.0.0-use.local
|
||||
resolution: "@medusajs/link-modules@workspace:packages/link-modules"
|
||||
dependencies:
|
||||
"@medusajs/modules-sdk": ^1.8.8
|
||||
"@medusajs/types": ^1.8.11
|
||||
"@medusajs/utils": ^1.9.2
|
||||
"@mikro-orm/core": 5.7.12
|
||||
"@mikro-orm/postgresql": 5.7.12
|
||||
awilix: ^8.0.0
|
||||
cross-env: ^5.2.1
|
||||
jest: ^29.6.3
|
||||
pg-god: ^1.0.12
|
||||
rimraf: ^5.0.1
|
||||
ts-jest: ^29.1.1
|
||||
ts-node: ^10.9.1
|
||||
tsc-alias: ^1.8.6
|
||||
typescript: ^5.1.6
|
||||
languageName: unknown
|
||||
linkType: soft
|
||||
|
||||
@@ -6496,11 +6517,11 @@ __metadata:
|
||||
"@medusajs/utils": ^1.9.6
|
||||
awilix: ^8.0.0
|
||||
cross-env: ^5.2.1
|
||||
jest: ^25.5.4
|
||||
jest: ^29.6.3
|
||||
resolve-cwd: ^3.0.0
|
||||
rimraf: ^5.0.1
|
||||
ts-jest: ^25.5.1
|
||||
typescript: ^4.4.4
|
||||
ts-jest: ^29.1.1
|
||||
typescript: ^5.1.6
|
||||
languageName: unknown
|
||||
linkType: soft
|
||||
|
||||
@@ -6558,10 +6579,10 @@ __metadata:
|
||||
"@medusajs/utils": ^1.9.6
|
||||
cross-env: ^5.2.1
|
||||
graphql: ^16.6.0
|
||||
jest: ^25.5.4
|
||||
jest: ^29.6.3
|
||||
rimraf: ^5.0.1
|
||||
ts-jest: ^25.5.1
|
||||
typescript: ^4.4.4
|
||||
ts-jest: ^29.1.1
|
||||
typescript: ^5.1.6
|
||||
languageName: unknown
|
||||
linkType: soft
|
||||
|
||||
@@ -6609,16 +6630,16 @@ __metadata:
|
||||
cross-env: ^5.2.1
|
||||
dotenv: ^16.1.4
|
||||
faker: ^6.6.6
|
||||
jest: ^25.5.4
|
||||
jest: ^29.6.3
|
||||
knex: 2.4.2
|
||||
lodash: ^4.17.21
|
||||
medusa-test-utils: ^1.1.40
|
||||
pg-god: ^1.0.12
|
||||
rimraf: ^3.0.2
|
||||
ts-jest: ^25.5.1
|
||||
ts-jest: ^29.1.1
|
||||
ts-node: ^10.9.1
|
||||
tsc-alias: ^1.8.6
|
||||
typescript: ^4.4.4
|
||||
typescript: ^5.1.6
|
||||
bin:
|
||||
medusa-product-migrations-down: dist/scripts/bin/run-migration-down.js
|
||||
medusa-product-migrations-up: dist/scripts/bin/run-migration-up.js
|
||||
@@ -6635,11 +6656,11 @@ __metadata:
|
||||
"@medusajs/utils": ^1.9.1
|
||||
awilix: ^8.0.0
|
||||
cross-env: ^5.2.1
|
||||
jest: ^25.5.4
|
||||
jest: ^29.6.3
|
||||
rimraf: ^5.0.1
|
||||
ts-jest: ^25.5.1
|
||||
ts-jest: ^29.1.1
|
||||
typeorm: ^0.3.16
|
||||
typescript: ^4.4.4
|
||||
typescript: ^5.1.6
|
||||
languageName: unknown
|
||||
linkType: soft
|
||||
|
||||
@@ -6652,7 +6673,7 @@ __metadata:
|
||||
ioredis: ^5.2.5
|
||||
rimraf: ^5.0.1
|
||||
typeorm: ^0.3.16
|
||||
typescript: ^4.4.4
|
||||
typescript: ^5.1.6
|
||||
winston: ^3.8.2
|
||||
languageName: unknown
|
||||
linkType: soft
|
||||
@@ -6763,10 +6784,10 @@ __metadata:
|
||||
awilix: ^8.0.1
|
||||
cross-env: ^5.2.1
|
||||
express: ^4.18.2
|
||||
jest: ^25.5.4
|
||||
jest: ^29.6.3
|
||||
rimraf: ^5.0.1
|
||||
ts-jest: ^25.5.1
|
||||
typescript: ^4.4.4
|
||||
ts-jest: ^29.1.1
|
||||
typescript: ^5.1.6
|
||||
ulid: ^2.3.0
|
||||
languageName: unknown
|
||||
linkType: soft
|
||||
@@ -6781,10 +6802,10 @@ __metadata:
|
||||
"@medusajs/utils": ^1.9.6
|
||||
awilix: ^8.0.1
|
||||
cross-env: ^5.2.1
|
||||
jest: ^25.5.4
|
||||
jest: ^29.6.3
|
||||
rimraf: ^5.0.1
|
||||
ts-jest: ^25.5.1
|
||||
typescript: ^4.4.4
|
||||
ts-jest: ^29.1.1
|
||||
typescript: ^5.1.6
|
||||
ulid: ^2.3.0
|
||||
languageName: unknown
|
||||
linkType: soft
|
||||
@@ -29262,7 +29283,7 @@ __metadata:
|
||||
languageName: node
|
||||
linkType: hard
|
||||
|
||||
"jest@npm:25.5.4, jest@npm:^25.5.2, jest@npm:^25.5.4":
|
||||
"jest@npm:25.5.4, jest@npm:^25.5.4":
|
||||
version: 25.5.4
|
||||
resolution: "jest@npm:25.5.4"
|
||||
dependencies:
|
||||
|
||||
Reference in New Issue
Block a user