feat(api-headless-cms): improve input types

webiny · Sep 14, 2024 · 5d15934 · 5d15934
1 parent 70c249d
commit 5d15934
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 12 deletions.
diff --git a/packages/api-headless-cms/src/crud/contentEntry/markLockedFields.ts b/packages/api-headless-cms/src/crud/contentEntry/markLockedFields.ts
@@ -10,7 +10,6 @@ interface MarkLockedFieldsParams {
 }
 
 export const markLockedFields = async (params: MarkLockedFieldsParams): Promise<void> => {
-    return;
     const { model, context } = params;
     /**
      * If the model is registered via a plugin, we don't need do process anything.

diff --git a/packages/api-headless-cms/src/types/context.ts b/packages/api-headless-cms/src/types/context.ts
@@ -52,6 +52,7 @@ import {
     UpdateCmsEntryOptionsInput
 } from "./types";
 import { CmsModel } from "./model";
+import {GenericRecord} from "@webiny/api/types";
 
 /**
  * Cms Entry CRUD methods in the context.
@@ -120,7 +121,7 @@ export interface CmsEntryContext {
      */
     createEntry: <T = CmsEntryValues>(
         model: CmsModel,
-        input: CreateCmsEntryInput,
+        input: CreateCmsEntryInput<T>,
         options?: CreateCmsEntryOptionsInput
     ) => Promise<CmsEntry<T>>;
     /**
@@ -135,10 +136,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
@@ -1377,7 +1377,7 @@ export interface EntryBeforeListTopicParams {
  * @category Context
  * @category CmsEntry
  */
-export interface CreateCmsEntryInput {
+export type CreateCmsEntryInput<TValues = CmsEntryValues> = TValues & {
     id?: string;
     status?: CmsEntryStatus;
 
@@ -1419,9 +1419,7 @@ export interface CreateCmsEntryInput {
     wbyAco_location?: {
         folderId?: string | null;
     };
-
-    [key: string]: any;
-}
+};
 
 export interface CreateCmsEntryOptionsInput {
     skipValidators?: string[];
@@ -1471,7 +1469,7 @@ export interface CreateRevisionCmsEntryOptionsInput {
  * @category Context
  * @category CmsEntry
  */
-export interface UpdateCmsEntryInput {
+export type UpdateCmsEntryInput<TValues = CmsEntryValues> = TValues & {
     /**
      * Revision-level meta fields. 👇
      */
@@ -1511,9 +1509,7 @@ export interface UpdateCmsEntryInput {
     wbyAco_location?: {
         folderId?: string | null;
     };
-
-    [key: string]: any;
-}
+};
 
 export interface UpdateCmsEntryOptionsInput {
     skipValidators?: string[];
-Original file line number
+Diff line change
@@ Expand Up / @@ -10,7 +10,6 @@ interface MarkLockedFieldsParams { @@
     }
     export const markLockedFields = async (params: MarkLockedFieldsParams): Promise<void> => {
-        return;
         const { model, context } = params;
         /**
          * If the model is registered via a plugin, we don't need do process anything.
@@ Expand Down @@