@griddo/core 11.0.25 → 11.0.26

package/dist/types/core/index.d.ts

@@ -59,9 +59,6 @@ interface Page<ContentType = unknown> {
         email: string;
     };
     entity?: string;
-    /** First module of the page if appeared in a section called `HeroSection`
-     * @deprecated To deprecated due to coupling with the section name */
-    firstModule?: string;
     follow?: boolean;
     footer: FooterModule;
     footerTheme?: string;

package/dist/types/schemas/SimpleContentType.d.ts

@@ -3,13 +3,6 @@ import type { DataPacks, ExpirationData } from "./props";
 import type { SearchFrom, WithSearchable } from "../schema-fields/props";
 import type { SimpleContentTypeFields, TextField } from "../schema-fields/simple-content-type-fields";
 type SimpleContentTypeProp<ContentType> = SearchFrom & {
-    /** An object to map fields to be used in search results */
-    searchMapping?: {
-        title: string;
-        url: string;
-        description?: string;
-        image?: string;
-    };
     /** An array of Griddo fields. */
     fields: [
         TextField<ContentType> & WithSearchable & {
@@ -18,16 +11,46 @@ type SimpleContentTypeProp<ContentType> = SearchFrom & {
         ...SimpleContentTypeFields<ContentType>[]
     ];
 };
-interface SimpleContentType<ContentType = unknown> extends BaseContentType, DataPacks, ExpirationData {
+type SimpleContentTypeBody = {
     /** Indicates that the data is of type simple/category. Must always be `false`. */
     fromPage: false;
-    /** Schema for the simple content type. */
-    schema: SimpleContentTypeProp<ContentType>;
     /** Set the ContentType to private */
     private?: boolean;
     /** Set if ContentType is exportable */
     exportable?: boolean;
     /** Set if ContentType is included in page search using the `searchMapping` prop */
     includedInPageSearch?: boolean;
-}
+};
+type Schema<ContentType> = {
+    includedInPageSearch?: true;
+    /** Schema for the simple content type. */
+    schema: {
+        /** An object to map fields to be used in search results */
+        searchMapping: {
+            title: string;
+            url: string;
+            description?: string;
+            image?: string;
+        };
+        fields: [
+            TextField<ContentType> & WithSearchable & {
+                key: "title";
+            },
+            ...SimpleContentTypeFields<ContentType>[]
+        ];
+    };
+} | {
+    /** Set if ContentType is included in page search using the `searchMapping` prop */
+    includedInPageSearch?: false | undefined;
+    /** Schema for the simple content type. */
+    schema: {
+        fields: [
+            TextField<ContentType> & WithSearchable & {
+                key: "title";
+            },
+            ...SimpleContentTypeFields<ContentType>[]
+        ];
+    };
+};
+type SimpleContentType<ContentType = unknown> = BaseContentType & DataPacks & ExpirationData & SimpleContentTypeBody & Schema<ContentType>;
 export type { SimpleContentType, SimpleContentTypeProp };

package/package.json

@@ -2,7 +2,7 @@
 	"name": "@griddo/core",
 	"description": "Reload version of Griddo Core",
 	"license": "UNLICENSED",
-	"version": "11.0.25",
+	"version": "11.0.26",
 	"authors": [
 		"Álvaro Sánchez' <alvaro.sanches@secuoyas.com>",
 		"Diego M. Béjar <diego.bejar@secuoyas.com>",
@@ -119,5 +119,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "ff159143be7318ebcc2c3de91a5b4e42428168ee"
+	"gitHead": "9f3c72f1c4e3a730e0b18f47260a62477e0bcb0e"
 }

package/dist/bin-tools/autotypes/autotypes.d.ts

@@ -1,11 +0,0 @@
-import type { ConfigFile } from "./misc/types";
-/**
- * Generates the `autotypes.d.ts` file in the root of the instance project using
- * the instance schemas exported in `griddo.config.file`
- * The main usage of this file is for intellisense and autocompletion in the
- * instance when they work with the React components and schemas.
- * @documentation https://www.notion.so/griddoio/AutoTypes-e7420867dd2e489c8da34a493b763cd8?pvs=4
- *
- * @param config The instance `griddo.config.ts` file path.
- */
-export declare function autotypes(config: ConfigFile, flags?: string): Promise<string>;

package/dist/bin-tools/autotypes/factories/index.d.ts

@@ -1,20 +0,0 @@
-import { getComponentsNames } from "./names/getComponents";
-import { getDetailTemplatesNames } from "./names/getDetailTemplates";
-import { getFormFieldsNames } from "./names/getFormFieldsNames";
-import { getFormTemplatesNames } from "./names/getFormTemplatesNames";
-import { getModulesNames } from "./names/getModules";
-import { getPageDataNames } from "./names/getPageData";
-import { getSimpleDataNames } from "./names/getSimpleData";
-import { getTaxonomyNames } from "./names/getTaxonomy";
-import { getTemplatesProps } from "./names/getTemplates";
-import { getPageDataProps } from "./props/getPageData";
-import { getSectionListType } from "./props/getSectionList";
-import { getSimpleDataProps } from "./props/getSimpleData";
-import { getTaxonomyDataProps } from "./props/getTaxonomyData";
-import { getUIAndDataProps } from "./props/getUIAndData";
-import { getDatapacksType } from "./schemas/getDataPacks";
-import { getLanguagesInterface } from "./schemas/getLanguages";
-import { getMenuItemsInterface } from "./schemas/getMenuItems";
-import { getModuleCategoriesType } from "./schemas/getModuleCategories";
-import { getThemesType } from "./schemas/getThemes";
-export { getComponentsNames, getDatapacksType, getDetailTemplatesNames, getFormFieldsNames, getFormTemplatesNames, getLanguagesInterface, getMenuItemsInterface, getModuleCategoriesType, getModulesNames, getPageDataNames, getPageDataProps, getSectionListType, getSimpleDataNames, getSimpleDataProps, getTaxonomyDataProps, getTaxonomyNames, getTemplatesProps, getThemesType, getUIAndDataProps, };

package/dist/bin-tools/autotypes/factories/names/getComponents.d.ts

@@ -1,2 +0,0 @@
-import type { Schema } from "../../../..";
-export declare function getComponentsNames(schemas: Record<string, Schema.Component>): string;

package/dist/bin-tools/autotypes/factories/names/getDetailTemplates.d.ts

@@ -1,2 +0,0 @@
-import type { Schema } from "../../../..";
-export declare function getDetailTemplatesNames(schemas: Record<string, Schema.Template | Schema.ListTemplate | Schema.PaginatedDataTemplate>): string;

package/dist/bin-tools/autotypes/factories/names/getFormFieldsNames.d.ts

@@ -1,2 +0,0 @@
-import type { Schema } from "../../../..";
-export declare function getFormFieldsNames(schemas: Record<string, Schema.FormField>): string;

package/dist/bin-tools/autotypes/factories/names/getFormTemplatesNames.d.ts

@@ -1,2 +0,0 @@
-import type { Schema } from "../../../..";
-export declare function getFormTemplatesNames(schemas: Record<string, Schema.FormTemplate>): string;

package/dist/bin-tools/autotypes/factories/names/getModules.d.ts

@@ -1,2 +0,0 @@
-import type { Schema } from "../../../..";
-export declare function getModulesNames(schemas: Record<string, Schema.Module>): string;

package/dist/bin-tools/autotypes/factories/names/getPageData.d.ts

@@ -1,2 +0,0 @@
-import type { Schema } from "../../../..";
-export declare function getPageDataNames(schemas: Record<string, Schema.PageContentType>): string;

package/dist/bin-tools/autotypes/factories/names/getSimpleData.d.ts

@@ -1,2 +0,0 @@
-import type { Schema } from "../../../..";
-export declare function getSimpleDataNames(schemas: Record<string, Schema.SimpleContentType>): string;

package/dist/bin-tools/autotypes/factories/names/getTaxonomy.d.ts

@@ -1,2 +0,0 @@
-import type { Schema } from "../../../..";
-export declare function getTaxonomyNames(schemas: Record<string, Schema.CategoryContentType>): string;

package/dist/bin-tools/autotypes/factories/names/getTemplates.d.ts

@@ -1,2 +0,0 @@
-import type { Schema } from "../../../..";
-export declare function getTemplatesProps(schemas: Record<string, Schema.Template | Schema.ListTemplate | Schema.PaginatedDataTemplate>): string;

package/dist/bin-tools/autotypes/factories/props/getPageData.d.ts

@@ -1,2 +0,0 @@
-import type { Schema } from "../../../..";
-export declare function getPageDataProps(schemas: Record<string, Schema.PageContentType>): string;

package/dist/bin-tools/autotypes/factories/props/getSectionList.d.ts

@@ -1,8 +0,0 @@
-import type { Schema } from "../../../..";
-/**
- * Lista de templates y sus secciones
- * Esto es algo que se usa en los schemas de Griddo. Es como el inverso a un
- * whitelist donde indicamos en qué secciones de qué templates puede
- * aparecer un módulo.
- */
-export declare function getSectionListType(schemas: Record<string, Schema.Template | Schema.ListTemplate | Schema.PaginatedDataTemplate>): string;

package/dist/bin-tools/autotypes/factories/props/getSimpleData.d.ts

@@ -1,2 +0,0 @@
-import type { Schema } from "../../../..";
-export declare function getSimpleDataProps(schemas: Record<string, Schema.SimpleContentType>): string;

package/dist/bin-tools/autotypes/factories/props/getTaxonomyData.d.ts

@@ -1,2 +0,0 @@
-import type { Schema } from "../../../..";
-export declare function getTaxonomyDataProps(schemas: Record<string, Schema.CategoryContentType>): string;

package/dist/bin-tools/autotypes/factories/props/getTypeFromField/index.d.ts

@@ -1,25 +0,0 @@
-import type { PageContentTypeFields } from "../../../../../types/schema-fields/page-content-type-fields";
-import type { SimpleContentTypeFields } from "../../../../../types/schema-fields/simple-content-type-fields";
-import type { UIFields } from "../../../../../types/schema-fields/ui-fields";
-import type { UIFormFields } from "../../../../../types/schema-fields/ui-form-fields";
-import type { UITemplateFields } from "../../../../../types/schema-fields/ui-template-fields";
-import type { Module } from "../../../../../types/schemas";
-import type { KindSchema, SchemaTypeWithComponentProp } from "../../../misc/types";
-/**
- * Return an optional property (the key in some Griddo field) and its value
- * (some Griddo field type) serialized based on a schema field.
- *
- * @param field A Griddo field object
- * @param kind Schema type in order to later do some operations with fields
- * @param options Object options
- * @example
- * getTypeFromField({ type: 'TextField', key: 'cardTitle', ... }, "component")
- * // returns -> "cardTitle?: Fields.Text"
- */
-export declare function getTypeFromField(field: UIFields | UIFormFields | UITemplateFields | SimpleContentTypeFields | PageContentTypeFields, kind: KindSchema, options: {
-    hasDistributorData: boolean;
-    getStaticData: boolean;
-    moduleSchemas: Array<Module | undefined>;
-    schema: SchemaTypeWithComponentProp;
-    allSchemas: any;
-}): string | undefined;

package/dist/bin-tools/autotypes/factories/props/getTypeFromField/utils.d.ts

@@ -1,41 +0,0 @@
-import type { FieldReturnTypes, Fields, SchemaFieldTypes } from "../../../misc/types";
-/** Build a interface prop based on the field from the schema.
- * Optionally it can receives a custom value for the type and a generic string to use as generic value
- *
- * @example
- * getGriddoFieldPropType(TextFieldObjectFromSchema)
- * // -> TextFieldObjectFromSchema.key: Fields.TextField
- * getGriddoFieldPropType(TextFieldObjectFromSchema, 'MyCustomValue', 'foo')
- * // -> TextFieldObjectFromSchema.key: MyCustomValue<foo>
- */
-type GetInterfacePropTypeOptions = {
-    returnTypeName?: FieldReturnTypes;
-    generic?: string;
-};
-/**
- * Return a serialized type from a Griddo schema field.
- *
- * @param Fields A Griddo field object
- * @param options An options object
- * @returns A string that represent a interface prop type.
- * @example
- * interface SomeInterface {
- * 	prop: boolean; // this function returns a string for this: `prop: boolean`
- * }
- */
-declare function getGriddoFieldPropType(field: Fields, options?: GetInterfacePropTypeOptions): string;
-/**
- * Return a string separated by the pipe char "|" using the `value` from object array.
- */
-declare function getGenericFromOptions<T = unknown>(options: Array<{
-    value: T;
-}>): string;
-/**
- * Return a string separated by the pipe char "|" using the `name` from object array.
- */
-declare function getGenericFromCheckBoxOptions<T>(options: Array<{
-    name: T;
-}>): string;
-declare function getGenericFromWhitelist(whiteList: Array<string>): string;
-declare function returnType(type: SchemaFieldTypes): FieldReturnTypes;
-export { getGenericFromCheckBoxOptions, getGenericFromOptions, getGenericFromWhitelist, getGriddoFieldPropType, returnType, };

package/dist/bin-tools/autotypes/factories/props/getUIAndData/index.d.ts

@@ -1,2 +0,0 @@
-import type { SchemaType } from "../../../misc/types";
-export declare function getUIAndDataProps(schemas: Record<string, SchemaType>): string;

package/dist/bin-tools/autotypes/factories/schemas/getDataPacks.d.ts

@@ -1,5 +0,0 @@
-import type { DataPack, DataPackCategory } from "../../../../types/schemas";
-export declare function getDatapacksType(schema: Record<string, DataPack>, categoriesSchema: Record<string, DataPackCategory>): {
-    DATAPACKS: string;
-    DATAPACKS_CATEGORIES: string;
-};

package/dist/bin-tools/autotypes/factories/schemas/getLanguages.d.ts

@@ -1,2 +0,0 @@
-import type { LanguagesSchema } from "../../misc/types";
-export declare function getLanguagesInterface(schemas: LanguagesSchema): string;

package/dist/bin-tools/autotypes/factories/schemas/getMenuItems.d.ts

@@ -1,2 +0,0 @@
-import type { MenuItemsSchema } from "../../misc/types";
-export declare function getMenuItemsInterface(menuItemsSchemas: MenuItemsSchema): string;

package/dist/bin-tools/autotypes/factories/schemas/getModuleCategories.d.ts

@@ -1,14 +0,0 @@
-import type { ModuleCategories } from "../../../../types/schemas";
-/**
- * Returns a string with the module categories type definition
- *
- * @example
- * type ModuleCategories =
- *	| "spacers"
- *	| "heros"
- *	| "basic"
- *	| "distributors"
- *  | ...
- * @returns (see example above)
- */
-export declare function getModuleCategoriesType(schema: ModuleCategories): string;

package/dist/bin-tools/autotypes/factories/schemas/getThemes.d.ts

@@ -1,5 +0,0 @@
-import type { ThemeEntry } from "../../../../types/schemas";
-export declare function getThemesType(themesSchema: Array<ThemeEntry>, subthemesSchema: Array<string>): {
-    THEMES: string;
-    SUBTHEMES: string;
-};

package/dist/hooks/useSitemap.d.ts

@@ -1,7 +0,0 @@
-/**
- * `useSitemap()`
- *
- * @deprecated This hook will be removed from Griddo in the future
- */
-declare function useSitemap(): (boolean | undefined)[];
-export { useSitemap };