feat(settings): view configuration enhancement (#14650)

* feat(view-configuration): Enhance view configuration to be more generic

* some cleanup, integration tests and fixes

* apply feature flag

* cleanup

* cleanup

* mopre dynamic display field

* semantic to category mapping and integration tests

* cleanup + singularize util

* middleware

* middleware

* cleanup

* export settings util to acces registry

* handle comments

* entity override registry

* property label and description translatable

* Create gold-grapes-roll.md

Author: adrien2p

.changeset/gold-grapes-roll.md

@@ -0,0 +1,9 @@
+---
+"@medusajs/medusa": patch
+"@medusajs/core-flows": patch
+"@medusajs/types": patch
+"@medusajs/utils": patch
+"@medusajs/settings": patch
+---
+
+Feat(view configuration): Generic introspection and generation

integration-tests/http/__tests__/views/admin/columns.spec.ts

@@ -54,7 +54,7 @@ medusaIntegrationTestRunner({
             field: "display_id",
             data_type: "string",
             semantic_type: "identifier",
-            context: "order",
+            context: "both",
           })
 
           // Check for missing relationships

packages/core/core-flows/src/settings/steps/create-property-label.ts

@@ -0,0 +1,52 @@
+import { SettingsTypes } from "@medusajs/framework/types"
+import { Modules } from "@medusajs/framework/utils"
+import { StepResponse, createStep } from "@medusajs/framework/workflows-sdk"
+
+export interface CreatePropertyLabelsStepInput {
+  property_labels: {
+    entity: string
+    property: string
+    label: string
+    description?: string
+  }[]
+}
+
+export const createPropertyLabelsStepId = "create-property-labels"
+
+/**
+ * @since 2.13.2
+ * @featureFlag view_configurations
+ */
+export const createPropertyLabelsStep = createStep(
+  createPropertyLabelsStepId,
+  async (
+    data: CreatePropertyLabelsStepInput,
+    { container }
+  ): Promise<StepResponse<SettingsTypes.PropertyLabelDTO[], string[]>> => {
+    if (!data.property_labels?.length) {
+      return new StepResponse([], [])
+    }
+
+    const service = container.resolve<SettingsTypes.ISettingsModuleService>(
+      Modules.SETTINGS
+    )
+
+    const created = await service.createPropertyLabels(data.property_labels)
+    const createdArray = Array.isArray(created) ? created : [created]
+
+    return new StepResponse(
+      createdArray,
+      createdArray.map((c) => c.id)
+    )
+  },
+  async (createdIds, { container }) => {
+    if (!createdIds?.length) {
+      return
+    }
+
+    const service = container.resolve<SettingsTypes.ISettingsModuleService>(
+      Modules.SETTINGS
+    )
+    await service.deletePropertyLabels(createdIds)
+  }
+)

packages/core/core-flows/src/settings/steps/delete-property-labels.ts

@@ -0,0 +1,55 @@
+import { SettingsTypes } from "@medusajs/framework/types"
+import { Modules } from "@medusajs/framework/utils"
+import { StepResponse, createStep } from "@medusajs/framework/workflows-sdk"
+
+export interface DeletePropertyLabelsStepInput {
+  ids: string[]
+}
+
+export const deletePropertyLabelsStepId = "delete-property-labels"
+
+/**
+ * @since 2.13.2
+ * @featureFlag view_configurations
+ */
+export const deletePropertyLabelsStep = createStep(
+  deletePropertyLabelsStepId,
+  async (
+    data: DeletePropertyLabelsStepInput,
+    { container }
+  ): Promise<StepResponse<void, SettingsTypes.PropertyLabelDTO[]>> => {
+    if (!data.ids?.length) {
+      return new StepResponse(void 0, [])
+    }
+
+    const service = container.resolve<SettingsTypes.ISettingsModuleService>(
+      Modules.SETTINGS
+    )
+
+    const existing = await service.listPropertyLabels({
+      id: data.ids,
+    })
+
+    await service.deletePropertyLabels(data.ids)
+
+    return new StepResponse(void 0, existing)
+  },
+  async (previousLabels, { container }) => {
+    if (!previousLabels?.length) {
+      return
+    }
+
+    const service = container.resolve<SettingsTypes.ISettingsModuleService>(
+      Modules.SETTINGS
+    )
+
+    await service.createPropertyLabels(
+      previousLabels.map((label) => ({
+        entity: label.entity,
+        property: label.property,
+        label: label.label,
+        description: label.description ?? undefined,
+      }))
+    )
+  }
+)

packages/core/core-flows/src/settings/steps/index.ts

@@ -1,3 +1,6 @@
 export * from "./create-view-configuration"
 export * from "./update-view-configuration"
-export * from "./set-active-view-configuration"
+export * from "./set-active-view-configuration"
+export * from "./create-property-label"
+export * from "./update-property-label"
+export * from "./delete-property-labels"

packages/core/core-flows/src/settings/steps/update-property-label.ts

@@ -0,0 +1,72 @@
+import { SettingsTypes } from "@medusajs/framework/types"
+import { Modules } from "@medusajs/framework/utils"
+import { StepResponse, createStep } from "@medusajs/framework/workflows-sdk"
+
+export interface UpdatePropertyLabelsStepInput {
+  property_labels: {
+    id: string
+    label?: string
+    description?: string
+  }[]
+}
+
+interface UpdatePropertyLabelsCompensateData {
+  previous: { id: string; label: string; description: string | null }[]
+}
+
+export const updatePropertyLabelsStepId = "update-property-labels"
+
+/**
+ * @since 2.13.2
+ * @featureFlag view_configurations
+ */
+export const updatePropertyLabelsStep = createStep(
+  updatePropertyLabelsStepId,
+  async (
+    data: UpdatePropertyLabelsStepInput,
+    { container }
+  ): Promise<
+    StepResponse<
+      SettingsTypes.PropertyLabelDTO[],
+      UpdatePropertyLabelsCompensateData
+    >
+  > => {
+    if (!data.property_labels?.length) {
+      return new StepResponse([], { previous: [] })
+    }
+
+    const service = container.resolve<SettingsTypes.ISettingsModuleService>(
+      Modules.SETTINGS
+    )
+
+    const ids = data.property_labels.map((p) => p.id)
+    const existing = await service.listPropertyLabels({ id: ids })
+
+    const previous = existing.map((e) => ({
+      id: e.id,
+      label: e.label,
+      description: e.description,
+    }))
+
+    const updated = await service.updatePropertyLabels(data.property_labels)
+
+    return new StepResponse(updated, { previous })
+  },
+  async (compensateData, { container }) => {
+    if (!compensateData?.previous?.length) {
+      return
+    }
+
+    const service = container.resolve<SettingsTypes.ISettingsModuleService>(
+      Modules.SETTINGS
+    )
+
+    const restoreData = compensateData.previous.map((prev) => ({
+      id: prev.id,
+      label: prev.label,
+      description: prev.description ?? undefined,
+    }))
+
+    await service.updatePropertyLabels(restoreData)
+  }
+)

packages/core/core-flows/src/settings/workflows/batch-property-labels.ts

@@ -0,0 +1,105 @@
+import {
+  BatchWorkflowInput,
+  BatchWorkflowOutput,
+  SettingsTypes,
+} from "@medusajs/framework/types"
+import {
+  WorkflowData,
+  WorkflowResponse,
+  createWorkflow,
+  parallelize,
+  transform,
+  when,
+} from "@medusajs/framework/workflows-sdk"
+import { createPropertyLabelsWorkflow } from "./create-property-label"
+import { deletePropertyLabelsWorkflow } from "./delete-property-labels"
+import { updatePropertyLabelsWorkflow } from "./update-property-label"
+
+/**
+ * Input type for creating a property label in batch.
+ */
+export interface BatchPropertyLabelCreateInput {
+  entity: string
+  property: string
+  label: string
+  description?: string
+}
+
+/**
+ * Input type for updating a property label in batch.
+ */
+export interface BatchPropertyLabelUpdateInput {
+  id: string
+  label?: string
+  description?: string
+}
+
+/**
+ * The property labels to manage.
+ */
+export interface BatchPropertyLabelsWorkflowInput
+  extends BatchWorkflowInput<
+    BatchPropertyLabelCreateInput,
+    BatchPropertyLabelUpdateInput
+  > {}
+
+export type BatchPropertyLabelsWorkflowOutput =
+  BatchWorkflowOutput<SettingsTypes.PropertyLabelDTO>
+
+const conditionallyCreatePropertyLabels = (
+  input: BatchPropertyLabelsWorkflowInput
+) =>
+  when({ input }, ({ input }) => !!input.create?.length).then(() =>
+    createPropertyLabelsWorkflow.runAsStep({
+      input: { property_labels: input.create! },
+    })
+  )
+
+const conditionallyUpdatePropertyLabels = (
+  input: BatchPropertyLabelsWorkflowInput
+) =>
+  when({ input }, ({ input }) => !!input.update?.length).then(() =>
+    updatePropertyLabelsWorkflow.runAsStep({
+      input: { property_labels: input.update! },
+    })
+  )
+
+const conditionallyDeletePropertyLabels = (
+  input: BatchPropertyLabelsWorkflowInput
+) =>
+  when({ input }, ({ input }) => !!input.delete?.length).then(() =>
+    deletePropertyLabelsWorkflow.runAsStep({
+      input: { ids: input.delete! },
+    })
+  )
+
+export const batchPropertyLabelsWorkflowId = "batch-property-labels"
+
+/**
+ * This workflow creates, updates, or deletes property labels in batch.
+ *
+ * @since 2.13.2
+ * @featureFlag view_configurations
+ */
+export const batchPropertyLabelsWorkflow = createWorkflow(
+  batchPropertyLabelsWorkflowId,
+  (
+    input: WorkflowData<BatchPropertyLabelsWorkflowInput>
+  ): WorkflowResponse<BatchPropertyLabelsWorkflowOutput> => {
+    const res = parallelize(
+      conditionallyCreatePropertyLabels(input),
+      conditionallyUpdatePropertyLabels(input),
+      conditionallyDeletePropertyLabels(input)
+    )
+
+    return new WorkflowResponse(
+      transform({ res, input }, (data) => {
+        return {
+          created: data.res[0] ?? [],
+          updated: data.res[1] ?? [],
+          deleted: data.input.delete ?? [],
+        }
+      })
+    )
+  }
+)

packages/core/core-flows/src/settings/workflows/create-property-label.ts

@@ -0,0 +1,33 @@
+import { SettingsTypes } from "@medusajs/framework/types"
+import {
+  WorkflowData,
+  WorkflowResponse,
+  createWorkflow,
+} from "@medusajs/framework/workflows-sdk"
+import { createPropertyLabelsStep } from "../steps"
+
+export interface CreatePropertyLabelsWorkflowInput {
+  property_labels: {
+    entity: string
+    property: string
+    label: string
+    description?: string
+  }[]
+}
+
+export const createPropertyLabelsWorkflowId = "create-property-labels"
+
+/**
+ * @since 2.13.2
+ * @featureFlag view_configurations
+ */
+export const createPropertyLabelsWorkflow = createWorkflow(
+  createPropertyLabelsWorkflowId,
+  (
+    input: WorkflowData<CreatePropertyLabelsWorkflowInput>
+  ): WorkflowResponse<SettingsTypes.PropertyLabelDTO[]> => {
+    const propertyLabels = createPropertyLabelsStep(input)
+
+    return new WorkflowResponse(propertyLabels)
+  }
+)

packages/core/core-flows/src/settings/workflows/delete-property-labels.ts

@@ -0,0 +1,27 @@
+import {
+  WorkflowData,
+  WorkflowResponse,
+  createWorkflow,
+} from "@medusajs/framework/workflows-sdk"
+import { deletePropertyLabelsStep } from "../steps"
+
+export interface DeletePropertyLabelsWorkflowInput {
+  ids: string[]
+}
+
+export const deletePropertyLabelsWorkflowId = "delete-property-labels"
+
+/**
+ * @since 2.13.2
+ * @featureFlag view_configurations
+ */
+export const deletePropertyLabelsWorkflow = createWorkflow(
+  deletePropertyLabelsWorkflowId,
+  (
+    input: WorkflowData<DeletePropertyLabelsWorkflowInput>
+  ): WorkflowResponse<void> => {
+    deletePropertyLabelsStep(input)
+
+    return new WorkflowResponse(void 0)
+  }
+)

packages/core/core-flows/src/settings/workflows/index.ts

@@ -1,2 +1,6 @@
 export * from "./create-view-configuration"
-export * from "./update-view-configuration"
+export * from "./update-view-configuration"
+export * from "./create-property-label"
+export * from "./update-property-label"
+export * from "./delete-property-labels"
+export * from "./batch-property-labels"