feat: page builder translations #4269

webiny · Oct 1, 2024 · 91b712f · 91b712f
2 parents 4f7dd91 + 9ecdcb1
commit 91b712f
Show file tree

Hide file tree

Showing 240 changed files with 4,423 additions and 2,232 deletions.
diff --git a/apps/website/package.json b/apps/website/package.json
@@ -12,14 +12,12 @@
     "@webiny/cli": "0.0.0",
     "@webiny/plugins": "0.0.0",
     "@webiny/project-utils": "0.0.0",
-    "@webiny/react-router": "0.0.0",
     "@webiny/serverless-cms-aws": "0.0.0",
     "apollo-client": "^2.6.10",
     "apollo-link": "^1.2.14",
     "core-js": "^3.0.1",
     "cross-fetch": "^3.0.4",
     "graphql": "^15.7.2",
-    "graphql-tag": "^2.12.6",
     "react": "18.2.0",
     "react-dom": "18.2.0",
     "regenerator-runtime": "^0.13.5",

diff --git a/apps/website/src/plugins/linkPreload.ts b/apps/website/src/plugins/linkPreload.ts
diff --git a/apps/website/src/plugins/pageBuilder.ts b/apps/website/src/plugins/pageBuilder.ts
@@ -1,7 +1,6 @@
 /**
  * Plugins specific to the "website" app.
  */
-import linkPreload from "./linkPreload";
 
 /**
  * Ensures GraphQL's PbPage and PbPageListItem types are correctly cached.
@@ -66,7 +65,6 @@ import accordionItemSettings from "@webiny/app-page-builder/editor/plugins/eleme
 import responsiveMode from "@webiny/app-page-builder/render/plugins/responsiveMode";
 
 export default [
-    linkPreload(),
     apolloCacheObjectId,
 
     // Page elements

diff --git a/packages/api-headless-cms-ddb-es/src/index.ts b/packages/api-headless-cms-ddb-es/src/index.ts
@@ -33,7 +33,7 @@ import {
 } from "~/plugins";
 import { createFilterPlugins } from "~/operations/entry/elasticsearch/filtering/plugins";
 import { CmsEntryFilterPlugin } from "~/plugins/CmsEntryFilterPlugin";
-import { StorageOperationsCmsModelPlugin } from "@webiny/api-headless-cms";
+import { StorageOperationsCmsModelPlugin, StorageTransformPlugin } from "@webiny/api-headless-cms";
 import { createElasticsearchIndexesOnLocaleAfterCreate } from "~/operations/system/indexes";
 import { createIndexTaskPluginTest } from "~/tasks/createIndexTaskPlugin";
 
@@ -157,6 +157,7 @@ export const createStorageOperations: StorageOperationsFactory = params => {
                 CmsEntryElasticsearchSortModifierPlugin.type,
                 CmsElasticsearchModelFieldPlugin.type,
                 StorageOperationsCmsModelPlugin.type,
+                StorageTransformPlugin.type,
                 CmsEntryElasticsearchValuesModifier.type
             ];
             for (const type of types) {

diff --git a/packages/api-headless-cms-ddb/src/index.ts b/packages/api-headless-cms-ddb/src/index.ts
@@ -20,7 +20,7 @@ import {
     CmsFieldFilterValueTransformPlugin
 } from "~/plugins";
 import { ValueFilterPlugin } from "@webiny/db-dynamodb/plugins/definitions/ValueFilterPlugin";
-import { StorageOperationsCmsModelPlugin } from "@webiny/api-headless-cms";
+import { StorageOperationsCmsModelPlugin, StorageTransformPlugin } from "@webiny/api-headless-cms";
 
 export * from "./plugins";
 
@@ -89,7 +89,8 @@ export const createStorageOperations: StorageOperationsFactory = params => {
                 CmsEntryFieldFilterPlugin.type,
                 CmsEntryFieldSortingPlugin.type,
                 ValueFilterPlugin.type,
-                StorageOperationsCmsModelPlugin.type
+                StorageOperationsCmsModelPlugin.type,
+                StorageTransformPlugin.type
             ];
             /**
              * Collect all required plugins from parent context.

diff --git a/packages/api-headless-cms-ddb/src/operations/entry/index.ts b/packages/api-headless-cms-ddb/src/operations/entry/index.ts
@@ -116,16 +116,17 @@ export const createEntriesStorageOperations = (
         entity
     });
 
-    const storageTransformPlugins = plugins
-        .byType<StorageTransformPlugin>(StorageTransformPlugin.type)
-        .reduce((collection, plugin) => {
-            collection[plugin.fieldType] = plugin;
-            return collection;
-        }, {} as Record<string, StorageTransformPlugin>);
-
     const createStorageTransformCallable = (
         model: StorageOperationsCmsModel
     ): FilterItemFromStorage => {
+        // Cache StorageTransformPlugin to optimize execution.
+        const storageTransformPlugins = plugins
+            .byType<StorageTransformPlugin>(StorageTransformPlugin.type)
+            .reduce((collection, plugin) => {
+                collection[plugin.fieldType] = plugin;
+                return collection;
+            }, {} as Record<string, StorageTransformPlugin>);
+
         return (field, value) => {
             const plugin: StorageTransformPlugin = storageTransformPlugins[field.type];
             if (!plugin) {

diff --git a/packages/api-headless-cms/src/crud/contentEntry.crud.ts b/packages/api-headless-cms/src/crud/contentEntry.crud.ts
@@ -5,12 +5,15 @@ import {
     CmsContext,
     CmsEntry,
     CmsEntryContext,
+    CmsEntryGetParams,
     CmsEntryListParams,
     CmsEntryListWhere,
     CmsEntryMeta,
     CmsEntryValues,
     CmsModel,
     CmsStorageEntry,
+    CreateCmsEntryInput,
+    CreateCmsEntryOptionsInput,
     EntryBeforeListTopicParams,
     HeadlessCmsStorageOperations,
     OnEntryAfterCreateTopicParams,
@@ -378,7 +381,11 @@ export const createContentEntryCrud = (params: CreateContentEntryCrudParams): Cm
         }
         return entry;
     };
-    const createEntry: CmsEntryContext["createEntry"] = async (model, rawInput, options) => {
+    const createEntry: CmsEntryContext["createEntry"] = async <T = CmsEntryValues>(
+        model: CmsModel,
+        rawInput: CreateCmsEntryInput,
+        options?: CreateCmsEntryOptionsInput
+    ): Promise<CmsEntry<T>> => {
         await accessControl.ensureCanAccessEntry({ model, rwd: "w" });
 
         const { entry, input } = await createEntryData({
@@ -416,7 +423,7 @@ export const createContentEntryCrud = (params: CreateContentEntryCrudParams): Cm
                 input
             });
 
-            return entry;
+            return entry as CmsEntry<T>;
         } catch (ex) {
             await onEntryCreateError.publish({
                 error: ex,
@@ -1304,9 +1311,12 @@ export const createContentEntryCrud = (params: CreateContentEntryCrudParams): Cm
         /**
          * @internal
          */
-        async getEntry(model, params) {
+        async getEntry<T = CmsEntryValues>(
+            model: CmsModel,
+            params: CmsEntryGetParams
+        ): Promise<CmsEntry<T>> {
             return context.benchmark.measure("headlessCms.crud.entries.getEntry", async () => {
-                return await getEntryUseCase.execute(model, params);
+                return (await getEntryUseCase.execute(model, params)) as CmsEntry<T>;
             });
         },
         /**
@@ -1355,7 +1365,11 @@ export const createContentEntryCrud = (params: CreateContentEntryCrudParams): Cm
                 }
             );
         },
-        async createEntry(model, input, options) {
+        async createEntry<T extends CmsEntryValues = CmsEntryValues>(
+            model: CmsModel,
+            input: CreateCmsEntryInput<T>,
+            options?: CreateCmsEntryOptionsInput
+        ): Promise<CmsEntry<T>> {
             return context.benchmark.measure("headlessCms.crud.entries.createEntry", async () => {
                 return createEntry(model, input, options);
             });

diff --git a/packages/api-headless-cms/src/types/context.ts b/packages/api-headless-cms/src/types/context.ts
@@ -67,7 +67,10 @@ export interface CmsEntryContext {
     /**
      * Get a single content entry for a model.
      */
-    getEntry: (model: CmsModel, params: CmsEntryGetParams) => Promise<CmsEntry>;
+    getEntry: <T = CmsEntryValues>(
+        model: CmsModel,
+        params: CmsEntryGetParams
+    ) => Promise<CmsEntry<T>>;
     /**
      * Get a list of entries for a model by a given ID (revision).
      */
@@ -115,11 +118,11 @@ export interface CmsEntryContext {
     /**
      * Create a new content entry.
      */
-    createEntry: (
+    createEntry: <T extends CmsEntryValues = CmsEntryValues>(
         model: CmsModel,
-        input: CreateCmsEntryInput,
+        input: CreateCmsEntryInput<T>,
         options?: CreateCmsEntryOptionsInput
-    ) => Promise<CmsEntry>;
+    ) => Promise<CmsEntry<T>>;
     /**
      * Create a new entry from already existing entry.
      */
@@ -132,10 +135,10 @@ export interface CmsEntryContext {
     /**
      * Update existing entry.
      */
-    updateEntry: (
+    updateEntry: <TInput = CmsEntryValues>(
         model: CmsModel,
         id: string,
-        input: UpdateCmsEntryInput,
+        input: UpdateCmsEntryInput<TInput>,
         meta?: Record<string, any>,
         options?: UpdateCmsEntryOptionsInput
     ) => Promise<CmsEntry>;

diff --git a/packages/api-headless-cms/src/types/types.ts b/packages/api-headless-cms/src/types/types.ts
@@ -1405,7 +1405,7 @@ export interface EntryBeforeListTopicParams {
  * @category Context
  * @category CmsEntry
  */
-export interface CreateCmsEntryInput {
+export type CreateCmsEntryInput<TValues = CmsEntryValues> = TValues & {
     id?: string;
     status?: CmsEntryStatus;
 
@@ -1447,9 +1447,7 @@ export interface CreateCmsEntryInput {
     wbyAco_location?: {
         folderId?: string | null;
     };
-
-    [key: string]: any;
-}
+};
 
 export interface CreateCmsEntryOptionsInput {
     skipValidators?: string[];
@@ -1499,7 +1497,7 @@ export interface CreateRevisionCmsEntryOptionsInput {
  * @category Context
  * @category CmsEntry
  */
-export interface UpdateCmsEntryInput {
+export type UpdateCmsEntryInput<TValues = CmsEntryValues> = TValues & {
     /**
      * Revision-level meta fields. 👇
      */
@@ -1539,9 +1537,7 @@ export interface UpdateCmsEntryInput {
     wbyAco_location?: {
         folderId?: string | null;
     };
-
-    [key: string]: any;
-}
+};
 
 export interface UpdateCmsEntryOptionsInput {
     skipValidators?: string[];

diff --git a/packages/api-page-builder-import-export/src/graphql/graphql/importExportTasks.gql.ts b/packages/api-page-builder-import-export/src/graphql/graphql/importExportTasks.gql.ts
@@ -24,7 +24,7 @@ const plugin: GraphQLSchemaPlugin<PbImportExportContext> = {
             type PbImportExportTask {
                 id: ID
                 createdOn: DateTime
-                createdBy: PbCreatedBy
+                createdBy: PbIdentity
                 status: PbImportExportTaskStatus
                 data: JSON
                 stats: PbImportExportTaskStats

diff --git a/packages/api-page-builder-import-export/src/graphql/graphql/pages.gql.ts b/packages/api-page-builder-import-export/src/graphql/graphql/pages.gql.ts
@@ -34,7 +34,7 @@ const plugin: GraphQLSchemaPlugin<PbImportExportContext> = {
             type PbExportPagesTask {
                 id: ID!
                 createdOn: DateTime!
-                createdBy: PbCreatedBy!
+                createdBy: PbIdentity!
                 status: PbImportExportPagesTaskStatus!
                 data: PbExportPagesTaskData!
                 stats: PbImportExportPagesTaskStats!
@@ -54,7 +54,7 @@ const plugin: GraphQLSchemaPlugin<PbImportExportContext> = {
             type PbImportPagesTask {
                 id: ID!
                 createdOn: DateTime!
-                createdBy: PbCreatedBy!
+                createdBy: PbIdentity!
                 status: PbImportExportPagesTaskStatus!
                 stats: PbImportExportPagesTaskStats!
                 data: PbImportExportPagesTaskData!