feat(core): Implement localeText custom field type

Closes #2000
vendure-ecommerce · Feb 23, 2023 · 6a3c61f · 6a3c61f
1 parent efe23d1
commit 6a3c61f
Show file tree

Hide file tree

Showing 13 changed files with 711 additions and 651 deletions.
diff --git a/docs/content/developer-guide/customizing-models.md b/docs/content/developer-guide/customizing-models.md
diff --git a/packages/admin-ui/src/lib/core/src/common/generated-types.ts b/packages/admin-ui/src/lib/core/src/common/generated-types.ts
diff --git a/packages/admin-ui/src/lib/core/src/common/introspection-result.ts b/packages/admin-ui/src/lib/core/src/common/introspection-result.ts
diff --git a/packages/admin-ui/src/lib/core/src/common/utilities/create-updated-translatable.ts b/packages/admin-ui/src/lib/core/src/common/utilities/create-updated-translatable.ts
@@ -35,7 +35,7 @@ export function createUpdatedTranslatable<T extends { translations: any[] } & Ma
     if (customFieldConfig && updatedFields.hasOwnProperty('customFields')) {
         for (const field of customFieldConfig) {
             const value = updatedFields.customFields[field.name];
-            if (field.type === 'localeString') {
+            if (field.type === 'localeString' || field.type === 'localeText') {
                 newTranslatedCustomFields[field.name] = value;
             } else {
                 newCustomFields[field.name] =
@@ -64,6 +64,7 @@ function getDefaultValue(type: CustomFieldType): any {
         case 'localeString':
         case 'string':
         case 'text':
+        case 'localeText':
             return '';
         case 'boolean':
             return false;

diff --git a/packages/admin-ui/src/lib/core/src/data/definitions/settings-definitions.ts b/packages/admin-ui/src/lib/core/src/data/definitions/settings-definitions.ts
@@ -624,6 +624,12 @@ export const TEXT_CUSTOM_FIELD_FRAGMENT = gql`
     }
     ${CUSTOM_FIELD_CONFIG_FRAGMENT}
 `;
+export const LOCALE_TEXT_CUSTOM_FIELD_FRAGMENT = gql`
+    fragment LocaleTextCustomField on LocaleTextCustomFieldConfig {
+        ...CustomFieldConfig
+    }
+    ${CUSTOM_FIELD_CONFIG_FRAGMENT}
+`;
 export const BOOLEAN_CUSTOM_FIELD_FRAGMENT = gql`
     fragment BooleanCustomField on BooleanCustomFieldConfig {
         ...CustomFieldConfig
@@ -677,6 +683,9 @@ export const ALL_CUSTOM_FIELDS_FRAGMENT = gql`
         ... on TextCustomFieldConfig {
             ...TextCustomField
         }
+        ... on LocaleTextCustomFieldConfig {
+            ...LocaleTextCustomField
+        }
         ... on BooleanCustomFieldConfig {
             ...BooleanCustomField
         }
@@ -701,6 +710,7 @@ export const ALL_CUSTOM_FIELDS_FRAGMENT = gql`
     ${FLOAT_CUSTOM_FIELD_FRAGMENT}
     ${DATE_TIME_CUSTOM_FIELD_FRAGMENT}
     ${RELATION_CUSTOM_FIELD_FRAGMENT}
+    ${LOCALE_TEXT_CUSTOM_FIELD_FRAGMENT}
 `;
 
 export const GET_SERVER_CONFIG = gql`

diff --git a/...ib/core/src/shared/dynamic-form-inputs/dynamic-form-input/dynamic-form-input.component.ts b/...ib/core/src/shared/dynamic-form-inputs/dynamic-form-input/dynamic-form-input.component.ts
@@ -299,7 +299,8 @@ export class DynamicFormInputComponent
                     return { component: 'text-form-input' };
                 }
             }
-            case 'text': {
+            case 'text':
+            case 'localeText': {
                 return { component: 'textarea-form-input' };
             }
             case 'int':

diff --git a/packages/common/src/shared-types.ts b/packages/common/src/shared-types.ts
@@ -87,6 +87,7 @@ export type ID = string | number;
  * string       | varchar                               | String
  * localeString | varchar                               | String
  * text         | longtext(m), text(p,s)                | String
+ * localText    | longtext(m), text(p,s)                | String
  * int          | int                                   | Int
  * float        | double precision                      | Float
  * boolean      | tinyint (m), bool (p), boolean (s)    | Boolean
@@ -106,7 +107,8 @@ export type CustomFieldType =
     | 'boolean'
     | 'datetime'
     | 'relation'
-    | 'text';
+    | 'text'
+    | 'localeText';
 
 /**
  * @description

diff --git a/packages/core/src/api/common/validate-custom-field-value.ts b/packages/core/src/api/common/validate-custom-field-value.ts
@@ -59,6 +59,7 @@ function validateSingleValue(config: CustomFieldConfig, value: any) {
         case 'boolean':
         case 'relation':
         case 'text':
+        case 'localeText':
             break;
         default:
             assertNever(config);

diff --git a/packages/core/src/api/config/generate-resolvers.ts b/packages/core/src/api/config/generate-resolvers.ts
@@ -67,6 +67,8 @@ export function generateResolvers(
                     return 'LocaleStringCustomFieldConfig';
                 case 'text':
                     return 'TextCustomFieldConfig';
+                case 'localeText':
+                    return 'LocaleTextCustomFieldConfig';
                 case 'int':
                     return 'IntCustomFieldConfig';
                 case 'float':

diff --git a/packages/core/src/api/config/graphql-custom-fields.ts b/packages/core/src/api/config/graphql-custom-fields.ts
@@ -489,6 +489,7 @@ function getFilterOperator(config: CustomFieldConfig): string | undefined {
         case 'string':
         case 'localeString':
         case 'text':
+        case 'localeText':
             return config.list ? 'StringListOperators' : 'StringOperators';
         case 'boolean':
             return config.list ? 'BooleanListOperators' : 'BooleanOperators';
@@ -524,6 +525,7 @@ function getGraphQlType(config: CustomFieldConfig): string {
         case 'string':
         case 'localeString':
         case 'text':
+        case 'localeText':
             return 'String';
         case 'datetime':
             return 'DateTime';

diff --git a/packages/core/src/api/schema/common/custom-field-types.graphql b/packages/core/src/api/schema/common/custom-field-types.graphql
@@ -127,6 +127,18 @@ type TextCustomFieldConfig implements CustomField {
     ui: JSON
 }
 
+type LocaleTextCustomFieldConfig implements CustomField {
+    name: String!
+    type: String!
+    list: Boolean!
+    label: [LocalizedString!]
+    description: [LocalizedString!]
+    readonly: Boolean
+    internal: Boolean
+    nullable: Boolean
+    ui: JSON
+}
+
 type LocalizedString {
     languageCode: LanguageCode!
     value: String!
@@ -141,3 +153,4 @@ union CustomFieldConfig =
     | DateTimeCustomFieldConfig
     | RelationCustomFieldConfig
     | TextCustomFieldConfig
+    | LocaleTextCustomFieldConfig
diff --git a/packages/core/src/config/custom-field/custom-field-types.ts b/packages/core/src/config/custom-field/custom-field-types.ts
@@ -5,6 +5,7 @@ import {
     FloatCustomFieldConfig as GraphQLFloatCustomFieldConfig,
     IntCustomFieldConfig as GraphQLIntCustomFieldConfig,
     LocaleStringCustomFieldConfig as GraphQLLocaleStringCustomFieldConfig,
+    LocaleTextCustomFieldConfig as GraphQLLocaleTextCustomFieldConfig,
     LocalizedString,
     RelationCustomFieldConfig as GraphQLRelationCustomFieldConfig,
     StringCustomFieldConfig as GraphQLStringCustomFieldConfig,
@@ -23,7 +24,7 @@ import { VendureEntity } from '../../entity/base/base.entity';
 
 // prettier-ignore
 export type DefaultValueType<T extends CustomFieldType> =
-    T extends 'string' | 'localeString' ? string :
+    T extends 'string' | 'localeString' | 'text' | 'localeText' ? string :
         T extends 'int' | 'float' ? number :
             T extends 'boolean' ? boolean :
                 T extends 'datetime' ? Date :
@@ -84,6 +85,10 @@ export type LocaleStringCustomFieldConfig = TypedCustomFieldConfig<
     GraphQLLocaleStringCustomFieldConfig
 >;
 export type TextCustomFieldConfig = TypedCustomFieldConfig<'text', GraphQLTextCustomFieldConfig>;
+export type LocaleTextCustomFieldConfig = TypedCustomFieldConfig<
+    'localeText',
+    GraphQLLocaleTextCustomFieldConfig
+>;
 export type IntCustomFieldConfig = TypedCustomFieldConfig<'int', GraphQLIntCustomFieldConfig>;
 export type FloatCustomFieldConfig = TypedCustomFieldConfig<'float', GraphQLFloatCustomFieldConfig>;
 export type BooleanCustomFieldConfig = TypedCustomFieldConfig<'boolean', GraphQLBooleanCustomFieldConfig>;
@@ -103,6 +108,7 @@ export type CustomFieldConfig =
     | StringCustomFieldConfig
     | LocaleStringCustomFieldConfig
     | TextCustomFieldConfig
+    | LocaleTextCustomFieldConfig
     | IntCustomFieldConfig
     | FloatCustomFieldConfig
     | BooleanCustomFieldConfig

diff --git a/packages/core/src/entity/register-custom-entity-fields.ts b/packages/core/src/entity/register-custom-entity-fields.ts
@@ -137,11 +137,11 @@ function registerCustomFieldsForEntity(
             };
 
             if (translation) {
-                if (customField.type === 'localeString') {
+                if (customField.type === 'localeString' || customField.type === 'localeText') {
                     registerColumn();
                 }
             } else {
-                if (customField.type !== 'localeString') {
+                if (customField.type !== 'localeString' && customField.type !== 'localeText') {
                     registerColumn();
                 }
             }
@@ -193,6 +193,7 @@ function getColumnType(
         case 'localeString':
             return 'varchar';
         case 'text':
+        case 'localeText':
             switch (dbEngine) {
                 case 'mysql':
                 case 'mariadb':