@griddo/core 12.12.1 → 12.13.0-rc.0

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

@@ -1 +1,2 @@
+#!/usr/bin/env node
 export {};

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

@@ -1,4 +1,3 @@
-import type { FieldReturnTypes, Fields, KindSchema, SchemaFieldTypes, SchemaTypeWithComponentProp } from "./types";
 import type { Core, Schema } from "../../..";
 import type { PageContentTypeFields } from "../../../types/schema-fields/page-content-type-fields";
 import type { SimpleContentTypeFields } from "../../../types/schema-fields/simple-content-type-fields";
@@ -7,6 +6,7 @@ import type { UIFormFields } from "../../../types/schema-fields/ui-form-fields";
 import type { UIFormTemplateFields } from "../../../types/schema-fields/ui-form-template-fields";
 import type { UITemplateFields } from "../../../types/schema-fields/ui-template-fields";
 import type { Module } from "../../../types/schemas";
+import type { FieldReturnTypes, Fields, KindSchema, SchemaFieldTypes, SchemaTypeWithComponentProp } from "./types";
 /**
  * Return a string separated by the pipe char "|" using the `value` from object array.
  */
@@ -48,9 +48,12 @@ type GetInterfacePropTypeOptions = {
 declare function getGriddoFieldPropType(field: Fields, options?: GetInterfacePropTypeOptions): string;
 declare function prettify(input: string): Promise<string>;
 /**
- * Returns the instance or monorepo paths.
+ * Returns the instance path: the closest directory, from the cwd upwards, that
+ * has a `griddo.config.ts`.
  *
- * @param customPath The path for the instance components
+ * It starts from where the command runs, not from where @griddo/core is
+ * installed, so it does not depend on the package manager's layout (hoisted,
+ * pnpm's `.pnpm`, PnP, a client monorepo...).
  */
 declare function resolveInstancePath(): string;
 declare function extractMergedSchemas(structuredData: any): {

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

@@ -22,4 +22,4 @@ declare function parseSchemas(schemaParserMap: Array<{
     parser: new () => Parser;
     config: Core.Config;
 }>): string[];
-export { AutoTypes, Parser, parseSchemas };
+export { AutoTypes, type Parser, parseSchemas };

package/dist/bin-tools/sync-schemas/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/bin-tools/sync-schemas/utils.d.ts

@@ -0,0 +1,76 @@
+import type { Core } from "../..";
+/**
+ * Returns the instance root, the closest directory from `cwd` upwards that has
+ * a `griddo.config.js|ts`, and that file.
+ *
+ * Like `griddo-autotypes`, it starts from where the command runs, not from
+ * where @griddo/core is installed, so it does not depend on the package
+ * manager's layout.
+ */
+declare function findInstance(cwd: string): {
+    root: string;
+    configFile: string;
+};
+/**
+ * Loads the closest `.env` from `cwd` upwards. The variables that are already
+ * set win over the file.
+ */
+declare function loadDotEnv(cwd: string): void;
+/**
+ * Returns the API URL from `GRIDDO_API_URL`. Its old names, `API_URL` and
+ * `REACT_APP_API_ENDPOINT`, still work, with a deprecation warning.
+ */
+declare function getApiUrl(env: NodeJS.ProcessEnv): string;
+/**
+ * Bundles the instance config with esbuild and runs it. As webpack did in the
+ * old sync of @griddo/ax, the `paths` of the instance tsconfig/jsconfig are
+ * resolved and the images imported by the schemas are left empty.
+ *
+ * Not loaded with tsx, as autotypes does: tsx adds `__name()` calls inside the
+ * functions, and the `computed` functions are sent as text that AX evaluates
+ * on its own, where `__name` does not exist.
+ */
+declare function loadGriddoConfig(configFile: string): Promise<Core.Config>;
+/**
+ * The body of `PUT /schemas`: the instance version and its schemas.
+ *
+ * @mutates the `computed` functions of the structured data become text, or
+ * they would be lost in the JSON.
+ */
+declare function buildPayload(config: Core.Config, version: string): {
+    config: {
+        languages: import("../../types/schemas").Languages;
+        menus: import("../../types/schemas").Menu;
+        menuItems: import("../../types/schemas").MenuItem;
+        richTextConfig?: import("../../types/schemas").RichTextConfig;
+        moduleCategories?: import("../../types/schemas").ModuleCategories;
+        themes: import("../../types/schemas").Themes;
+        subthemes?: Array<string>;
+        socials?: import("../../types/schemas").Socials;
+        llms?: Core.LlmsConfig;
+    };
+    ui: {
+        components: Record<string, import("../../types/schemas").Component>;
+        modules: Record<string, import("../../types/schemas").Module>;
+        templates: Record<string, import("../../types/schemas").Template>;
+    };
+    contentTypes: {
+        dataPacks: Record<string, import("../../types/schemas").DataPack>;
+        dataPacksCategories: Record<string, import("../../types/schemas").DataPackCategory>;
+        structuredData: Record<string, import("../../types/schemas").CategoryContentType | import("../../types/schemas").PageContentType | import("../../types/schemas").SimpleContentType>;
+    };
+    forms: {
+        templates: Record<string, import("../../types/schemas").FormTemplate>;
+        fields: Record<string, import("../../types/schemas").FormField>;
+        categories?: import("../../types/schemas").FormCategories;
+        templateCategories?: import("../../types/schemas").FormTemplateCategories;
+    } | {
+        templates: {};
+        fields: {};
+        categories: never[];
+    };
+    version: string;
+};
+/** Sends the schemas to the API. Throws with the API message if it rejects them. */
+declare function putSchemas(apiUrl: string, developerKey: string | undefined, payload: object): Promise<void>;
+export { buildPayload, findInstance, getApiUrl, loadDotEnv, loadGriddoConfig, putSchemas, };

package/dist/components/CloudinaryImage/index.d.ts

@@ -1,8 +1,7 @@
+import type { CSSProperties } from "react";
 import type { CloudinaryImageCrop, CloudinaryImageFormat, CloudinaryResponsiveImageProps } from "../../hooks/useImage";
 import type { ImageDecoding, ImageLoading } from "../../types/core";
-import type { CSSProperties } from "react";
 import * as React from "react";
-import "react-aspect-ratio/aspect-ratio.css";
 export declare const internalDefaults: {
     domain: string;
     uploadFolder: string;

package/dist/components/GriddoImage/index.d.ts

@@ -1,6 +1,5 @@
 import type { FetchPriority, ImageCropType, ImageDecoding, ImageLoading, ImagePosition, ImageTransform, ResponsiveImageProps } from "../../types/core";
 import * as React from "react";
-import "react-aspect-ratio/aspect-ratio.css";
 import "./styles.css";
 /**
  * Renders an image from the **Griddo** cdn.

package/dist/components/GriddoImageExp/utils.d.ts

@@ -1,6 +1,6 @@
-import type { Source } from "./types";
 import type { Core, Fields } from "../..";
 import type { GriddoDamDefaults, ImageCropType, ImageDecoding, ImageFormats, ImageLoading, ImagePosition, ImageTransform } from "../../types/core";
+import type { Source } from "./types";
 interface GetGriddoArtDirectionImage {
     sources: Array<Source>;
     width?: string;

package/dist/components/GriddoLink/index.d.ts

@@ -1,5 +1,5 @@
-import type { Url } from "../../types/api-response-fields";
 import type { ComponentPropsWithoutRef, CSSProperties, MouseEvent, ReactNode, Ref } from "react";
+import type { Url } from "../../types/api-response-fields";
 import * as React from "react";
 /**
  * Renders a router component from internal/external Griddo link.

package/dist/components/Page/index.d.ts

@@ -1,6 +1,6 @@
+import type { FC } from "react";
 import type { Schema } from "../..";
 import type { Page } from "../../types/core";
-import type { FC } from "react";
 import * as React from "react";
 import { type ComponentProps } from "../Component";
 /**

package/dist/contexts/Form/index.d.ts

@@ -10,4 +10,4 @@ interface FormContextProps {
 interface FormProviderProps {
     children: JSX.Element;
 }
-export { FormContext, FormProvider, type FormContextProps };
+export { FormContext, type FormContextProps, FormProvider };

package/dist/contexts/Navigation/index.d.ts

@@ -7,4 +7,4 @@ interface NavigationProviderProps {
 }
 declare const NavigationContext: React.Context<NavigationContextProps | null>;
 declare function NavigationProvider(props: NavigationProviderProps): React.JSX.Element;
-export { NavigationContext, NavigationProvider, type NavigationContextProps };
+export { NavigationContext, type NavigationContextProps, NavigationProvider };

package/dist/contexts/Site/index.d.ts

@@ -26,4 +26,4 @@ interface SiteContextProps extends Site {
 interface SiteProviderProps extends Site {
     children: JSX.Element;
 }
-export { SiteContext, SiteProvider, type SiteContextProps, type SiteProviderProps, };
+export { SiteContext, type SiteContextProps, SiteProvider, type SiteProviderProps, };

package/dist/functions/index.d.ts

@@ -1,3 +1,3 @@
-import { griddoAlertRegister, type GriddoAlertRegisterProps } from "./alerts";
+import { type GriddoAlertRegisterProps, griddoAlertRegister } from "./alerts";
 import { formatLocaleDate } from "./localeDate";
-export { formatLocaleDate, griddoAlertRegister, type GriddoAlertRegisterProps };
+export { formatLocaleDate, type GriddoAlertRegisterProps, griddoAlertRegister };

package/dist/hooks/index.d.ts

@@ -31,4 +31,4 @@ import { useSendInterests } from "./useSendInterests";
 import { useSession } from "./useSession";
 import { useSite } from "./useSite";
 import { useSSR } from "./useSSR";
-export { useAiAnswers, useAIReferenceField, useAiSearch, useContentType, useContentTypeNavigation, useDataFilters, useReferenceFieldData as useDistributorData, useFetch, useGlobalTheme, useGriddoImage, useGriddoImageExp, useI18n, useImage, useIsClient, useIsFirstRender, useLink, useList, useListWithDefaultStaticPage, useLocaleDate, useNavigation, usePage, usePageRelatedContent, useReceiveInterests, useReferenceFieldData, useScript, useSendInterests, useSession, useSite, useSSR, useTheme, useThemeColors, useThemeFont, useThemePrimitives, useForm, };
+export { useAIReferenceField, useAiAnswers, useAiSearch, useContentType, useContentTypeNavigation, useDataFilters, useFetch, useForm, useGlobalTheme, useGriddoImage, useGriddoImageExp, useI18n, useImage, useIsClient, useIsFirstRender, useLink, useList, useListWithDefaultStaticPage, useLocaleDate, useNavigation, usePage, usePageRelatedContent, useReceiveInterests, useReferenceFieldData as useDistributorData, useReferenceFieldData, useScript, useSendInterests, useSession, useSite, useSSR, useTheme, useThemeColors, useThemeFont, useThemePrimitives, };

package/dist/hooks/useAiAnswers.d.ts

@@ -1,5 +1,5 @@
-import type { PickRename } from "../types/global";
 import type __AT__ from "@/autotypes";
+import type { PickRename } from "../types/global";
 import { type UseFetchStateProps } from "./useFetch";
 interface AiAnswersResponse {
     status: "ok" | "noResponse";
@@ -22,4 +22,4 @@ type UseAiAnswersReturn = [
 ];
 type UseAiAnswersState = PickRename<UseFetchStateProps<AiAnswersResponse>, "data", "query">;
 export declare function useAiAnswers(): UseAiAnswersReturn;
-export { UseAiAnswersReturn, UseAiAnswersSetBodyAction, UseAiAnswersSetQuery, UseAiAnswersState, type AiAnswersResponse, };
+export type { AiAnswersResponse, UseAiAnswersReturn, UseAiAnswersSetBodyAction, UseAiAnswersSetQuery, UseAiAnswersState, };

package/dist/hooks/useAiSearch.d.ts

@@ -1,5 +1,5 @@
-import type { PickRename } from "../types/global";
 import type __AT__ from "@/autotypes";
+import type { PickRename } from "../types/global";
 import { type UseFetchStateProps } from "./useFetch";
 interface AiSearchResponse {
     page: number;
@@ -34,4 +34,4 @@ type UseAiSearchReturn = [
 ];
 type UseAiSearchState = PickRename<UseFetchStateProps<AiSearchResponse>, "data", "query">;
 export declare function useAiSearch(): UseAiSearchReturn;
-export { UseAiSearchReturn, UseAiSearchSetBodyAction, UseAiSearchSetQuery, UseAiSearchState, type AiSearchResponse, };
+export type { AiSearchResponse, UseAiSearchReturn, UseAiSearchSetBodyAction, UseAiSearchSetQuery, UseAiSearchState, };

package/dist/hooks/useReceiveInterests.d.ts

@@ -1,5 +1,5 @@
-import type { UseFetchStateProps } from "./useFetch";
 import type { PickRename } from "../types/global";
+import type { UseFetchStateProps } from "./useFetch";
 type Response<Areas extends string> = Record<Areas, {
     interest: {
         id?: string;

package/dist/index.d.ts

@@ -2,26 +2,24 @@ import { CloudinaryBackgroundImage, CloudinaryImage, Component, GriddoBackground
 import { CloudinaryImageProps } from "./components/CloudinaryImage";
 import { ComponentProps, getComponent } from "./components/Component";
 import { GriddoImageCommonProps, GriddoImageGif, GriddoImageJpgWebpAvif, GriddoImageProps, GriddoImageSvg } from "./components/GriddoImage";
+import { GriddoImageCommonPropsExperimental, GriddoImageGifExperimental, GriddoImageJpgWebpAvifExperimental, GriddoImagePropsExperimental, GriddoImageSvgExperimental } from "./components/GriddoImageExp/types";
 import { GriddoLinkProps, HLocation, LinkGetProps, WindowLocation } from "./components/GriddoLink";
 import { ModulePreviewProps } from "./components/ModulePreview";
 import { PageProps } from "./components/Page";
 import { PreviewProps } from "./components/Preview";
 import { PageContext, PageProvider, SessionContext, SessionProvider, SiteContext, SiteProvider } from "./contexts";
 import { SiteProviderProps } from "./contexts/Site";
-import { useAiAnswers, useAiSearch, useContentType, useContentTypeNavigation, useDataFilters, useGlobalTheme, useGriddoImage, useGriddoImageExp, useI18n, useImage, useIsClient, useIsFirstRender, useLink, useList, useListWithDefaultStaticPage, useLocaleDate, useNavigation, usePage, usePageRelatedContent, useReceiveInterests, useReferenceFieldData, useSSR, useScript, useSendInterests, useSession, useSite, useTheme, useThemeColors, useThemeFont, useThemePrimitives, useAIReferenceField } from "./hooks";
+import { formatLocaleDate, GriddoAlertRegisterProps, griddoAlertRegister } from "./functions";
+import { useAIReferenceField, useAiAnswers, useAiSearch, useContentType, useContentTypeNavigation, useDataFilters, useGlobalTheme, useGriddoImage, useGriddoImageExp, useI18n, useImage, useIsClient, useIsFirstRender, useLink, useList, useListWithDefaultStaticPage, useLocaleDate, useNavigation, usePage, usePageRelatedContent, useReceiveInterests, useReferenceFieldData, useScript, useSendInterests, useSession, useSite, useSSR, useTheme, useThemeColors, useThemeFont, useThemePrimitives } from "./hooks";
 import { UseDataFilterSetUrlAction, UseDataFiltersReturn, UseDataFiltersSetQueryProps, UseDataFiltersState } from "./hooks/useDataFilters";
 import { GenerateImageChunkProps, ImageChunk, ImageConfig, UseGriddoImageProps, UseGriddoImageReturn } from "./hooks/useGriddoImage";
 import { GenerateImageChunkPropsExperimental, ImageChunkExperimental, ImageConfigExperimental, UseGriddoImagePropsExperimental, UseGriddoImageReturnExperimental } from "./hooks/useGriddoImageExp";
-import { getLangFromLocalStorage, getSiteID, getToken } from "./utils";
 import { UseI18nProps } from "./hooks/useI18n";
 import { CloudinaryImageCrop, CloudinaryImageFormat, CloudinaryResponsiveImageProps, UseImageProps } from "./hooks/useImage";
 import { UseListSetQueryProps, UseListSetUrlAction } from "./hooks/useList";
-import { FiltersDataApiQueryResponseProps, HTMLHeadingTag, Hideable, ListApiQueryResponseProps, PickRename, Pretty, SetQueryProps } from "./types/global";
-import { NonEmptyArray } from "./types/utilities";
-import { GriddoImageCommonPropsExperimental, GriddoImageGifExperimental, GriddoImageJpgWebpAvifExperimental, GriddoImagePropsExperimental, GriddoImageSvgExperimental } from "./components/GriddoImageExp/types";
-import { GriddoAlertRegisterProps, formatLocaleDate, griddoAlertRegister } from "./functions";
 import * as Fields from "./types/api-response-fields";
 import * as Core from "./types/core";
+import { FiltersDataApiQueryResponseProps, Hideable, HTMLHeadingTag, ListApiQueryResponseProps, PickRename, Pretty, SetQueryProps } from "./types/global";
 import * as PageContentTypeFields from "./types/schema-fields/page-content-type-fields";
 import * as SimpleContentTypeFields from "./types/schema-fields/simple-content-type-fields";
 import * as UIFields from "./types/schema-fields/ui-fields";
@@ -29,4 +27,6 @@ import * as UIFormFields from "./types/schema-fields/ui-form-fields";
 import * as UITemplateFields from "./types/schema-fields/ui-template-fields";
 import * as Schema from "./types/schemas";
 import * as Theme from "./types/theme";
-export { CloudinaryBackgroundImage, CloudinaryImage, CloudinaryImageCrop, CloudinaryImageFormat, CloudinaryImageProps, CloudinaryResponsiveImageProps, Component, ComponentProps, Core, Fields, FiltersDataApiQueryResponseProps, GenerateImageChunkProps, GenerateImageChunkPropsExperimental, GriddoAlertRegisterProps, GriddoBackgroundImage, GriddoImage, GriddoImageCommonProps, GriddoImageCommonPropsExperimental, GriddoImageExp, GriddoImageGif, GriddoImageGifExperimental, GriddoImageJpgWebpAvif, GriddoImageJpgWebpAvifExperimental, GriddoImageProps, GriddoImagePropsExperimental, GriddoImageSvg, GriddoImageSvgExperimental, GriddoLink, GriddoLinkProps, HLocation, HTMLHeadingTag, Hideable, ImageChunk, ImageChunkExperimental, ImageConfig, ImageConfigExperimental, LdJson, Link, LinkGetProps, ListApiQueryResponseProps, ModulePreviewProps, NonEmptyArray, Page, PageContentTypeFields, PageContext, PageProps, PageProvider, PickRename, Pretty, Preview, PreviewProps, Schema, SessionContext, SessionProvider, SetQueryProps, SimpleContentTypeFields, SiteContext, SiteProvider, SiteProviderProps, Theme, UIFields, UIFormFields, UITemplateFields, UseDataFilterSetUrlAction, UseDataFiltersReturn, UseDataFiltersSetQueryProps, UseDataFiltersState, UseGriddoImageProps, UseGriddoImagePropsExperimental, UseGriddoImageReturn, UseGriddoImageReturnExperimental, UseI18nProps, UseImageProps, UseListSetQueryProps, UseListSetUrlAction, WindowLocation, formatLocaleDate, getComponent, getLangFromLocalStorage, getSiteID, getToken, griddoAlertRegister, useAiAnswers, useAiSearch, useAiAnswers as useAIAnswers, useAiSearch as useAISearch, useContentType, useContentTypeNavigation, useDataFilters, useReferenceFieldData as useDistributorData, useReferenceFieldData as useReferenceField, useGlobalTheme, useGriddoImage, useGriddoImageExp, useI18n, useImage, useIsClient, useIsFirstRender, useLink, useList, useListWithDefaultStaticPage, useLocaleDate, useNavigation, usePage, usePageRelatedContent, useReceiveInterests, useReferenceFieldData, useSSR, useScript, useSendInterests, useSession, useSite, useTheme, useThemeColors, useThemeFont, useThemePrimitives, useAIReferenceField, };
+import { NonEmptyArray } from "./types/utilities";
+import { getLangFromLocalStorage, getSiteID, getToken } from "./utils";
+export { CloudinaryBackgroundImage, CloudinaryImage, CloudinaryImageCrop, CloudinaryImageFormat, CloudinaryImageProps, CloudinaryResponsiveImageProps, Component, ComponentProps, Core, Fields, FiltersDataApiQueryResponseProps, formatLocaleDate, GenerateImageChunkProps, GenerateImageChunkPropsExperimental, GriddoAlertRegisterProps, GriddoBackgroundImage, GriddoImage, GriddoImageCommonProps, GriddoImageCommonPropsExperimental, GriddoImageExp, GriddoImageGif, GriddoImageGifExperimental, GriddoImageJpgWebpAvif, GriddoImageJpgWebpAvifExperimental, GriddoImageProps, GriddoImagePropsExperimental, GriddoImageSvg, GriddoImageSvgExperimental, GriddoLink, GriddoLinkProps, getComponent, getLangFromLocalStorage, getSiteID, getToken, griddoAlertRegister, Hideable, HLocation, HTMLHeadingTag, ImageChunk, ImageChunkExperimental, ImageConfig, ImageConfigExperimental, LdJson, Link, LinkGetProps, ListApiQueryResponseProps, ModulePreviewProps, NonEmptyArray, Page, PageContentTypeFields, PageContext, PageProps, PageProvider, PickRename, Pretty, Preview, PreviewProps, Schema, SessionContext, SessionProvider, SetQueryProps, SimpleContentTypeFields, SiteContext, SiteProvider, SiteProviderProps, Theme, UIFields, UIFormFields, UITemplateFields, UseDataFilterSetUrlAction, UseDataFiltersReturn, UseDataFiltersSetQueryProps, UseDataFiltersState, UseGriddoImageProps, UseGriddoImagePropsExperimental, UseGriddoImageReturn, UseGriddoImageReturnExperimental, UseI18nProps, UseImageProps, UseListSetQueryProps, UseListSetUrlAction, useAIReferenceField, useAiAnswers, useAiAnswers as useAIAnswers, useAiSearch, useAiSearch as useAISearch, useContentType, useContentTypeNavigation, useDataFilters, useGlobalTheme, useGriddoImage, useGriddoImageExp, useI18n, useImage, useIsClient, useIsFirstRender, useLink, useList, useListWithDefaultStaticPage, useLocaleDate, useNavigation, usePage, usePageRelatedContent, useReceiveInterests, useReferenceFieldData as useDistributorData, useReferenceFieldData as useReferenceField, useReferenceFieldData, useScript, useSendInterests, useSession, useSite, useSSR, useTheme, useThemeColors, useThemeFont, useThemePrimitives, WindowLocation, };