@websolutespa/bom-core 2.0.1-next.2 → 2.0.1

package/CHANGELOG.md

@@ -1,28 +1,28 @@
 # @websolutespa/bom-core
 
-## 2.0.1-next.2
+## 2.0.1
 
 ### Patch Changes
 
-- Updating: dependencies and build step
+- Modified: getOrigin prioritize NEXT_PUBLIC_URL
 
-## 2.0.1-next.0
+## 2.0.0
 
 ### Major Changes
 
-- e74b305: Release: Payload 3.7.0
+- Release: Bom 2.0
 
-## 1.10.0-next.1
+## 1.8.24
 
 ### Patch Changes
 
-- 64289c4: Updating: React 19.x, Payload 3.x
+- Added: IApp global
 
-## 1.10.0-next.0
+## 1.8.23
 
-### Minor Changes
+### Patch Changes
 
-- Updating: React 19.x, Payload 3.x
+- 0c7f05f: Modified: IRoute isRoot noindex, routeService
 
 ## 1.8.22
 

package/dist/index.d.ts

@@ -1,6 +1,6 @@
-import { IncomingMessage, ServerResponse, IncomingHttpHeaders } from 'node:http';
-import { ParsedUrlQuery } from 'node:querystring';
-import { FC } from 'react';
+import { IncomingMessage, ServerResponse, IncomingHttpHeaders } from 'http';
+import { ParsedUrlQuery } from 'querystring';
+import React from 'react';
 
 declare function base64ToString(text: string): string;
 declare function stringToBase64(text: string): string;
@@ -20,13 +20,11 @@ type IContextParams = IContextBaseParams & {
 };
 type StaticPropsContext<Q extends ParsedUrlQuery = ParsedUrlQuery, D extends PreviewData = PreviewData> = {
     params: Q;
-    draftMode?: boolean;
+    preview?: boolean;
+    previewData?: D;
     locale?: string;
     locales?: string[];
     defaultLocale?: string;
-    revalidateReason?: 'build' | 'stale' | 'on-demand';
-    preview?: boolean;
-    previewData?: D;
 };
 type IStaticContext<T extends {} = {}> = StaticPropsContext<IContextParams & T>;
 declare type NextApiRequestCookies = Partial<{
@@ -38,15 +36,13 @@ type ServerSidePropsContext<Q extends ParsedUrlQuery = ParsedUrlQuery, D extends
     };
     res: ServerResponse;
     params: Q;
-    draftMode?: boolean;
     query: ParsedUrlQuery;
+    preview?: boolean;
+    previewData?: D;
     resolvedUrl: string;
     locale?: string;
     locales?: string[];
     defaultLocale?: string;
-    revalidateReason?: 'build' | 'stale' | 'on-demand';
-    preview?: boolean;
-    previewData?: D;
 };
 type IServerSideSplatContext<T extends {} = {}> = ServerSidePropsContext<IContextBaseParams & T>;
 type IServerSideContext<T extends {} = {}> = ServerSidePropsContext<IContextParams & T>;
@@ -67,14 +63,6 @@ type IOverride<T, FromType, ToType> = {
 type RequireAtLeastOne<T> = {
     [K in keyof T]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<keyof T, K>>>;
 }[keyof T];
-type Shift<T extends any[]> = ((...t: T) => any) extends ((first: any, ...rest: infer Rest) => any) ? Rest : never;
-type ShiftUnion<P extends PropertyKey, T extends any[]> = T extends any[] ? T[0] extends P ? Shift<T> : never : never;
-type DeepRequiredProps<T, P extends string[]> = T extends object ? (Omit<T, Extract<keyof T, P[0]>> & Required<{
-    [K in Extract<keyof T, P[0]>]: NonNullable<DeepRequiredProps<T[K], ShiftUnion<K, P>>>;
-}>) : T;
-type DeepRequired<T> = {
-    [K in keyof T]: Required<DeepRequired<T[K]>>;
-};
 
 /**
  * List of ISO 639 language codes (set 1)
@@ -144,45 +132,6 @@ type IAnchor = {
     title: string;
 };
 
-type IEquatable = number | string;
-type SchemaType = string;
-type ISchema = {
-    id: IEquatable;
-    schema?: string;
-};
-type IEntity = ISchema & Record<string, unknown>;
-type INamedEntity = IEntity & {
-    name: ILocalizable;
-};
-type ITitledEntity = IEntity & {
-    title: ILocalizable;
-};
-type IOption = Record<string, any> & {
-    id: IEquatable;
-    name: string;
-};
-type IFeature = Record<string, any> & {
-    id: IEquatable;
-    title: string;
-};
-type IFeatureType = IEntity & {
-    id: string;
-    title: string;
-    mode: string;
-    features: IFeature[];
-};
-
-type Headings = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6';
-
-type IComponent = {
-    id?: IEquatable;
-    blockType?: string;
-    schema?: string;
-    anchor?: IAnchor;
-    seoWeight?: Headings;
-    [key: string]: unknown;
-};
-
 type IMediaType = 'image' | 'video' | 'json' | 'pdf' | string;
 type IMediaInfo = {
     id: string;
@@ -239,6 +188,68 @@ declare function isMediaPdf(media: {
 }): media is IMediaPdf;
 declare function isMedia(item: unknown): item is IMedia;
 
+type IAppExtended = Record<string, any>;
+type IApp<T extends IAppExtended = IAppExtended> = {
+    id: 'app';
+    brand: {
+        name: string;
+        businessName?: string;
+        appName?: string;
+        logo?: IMedia;
+        email?: string;
+        telephone?: string;
+        address?: string;
+        city?: string;
+        provinceCode?: string;
+        zipCode?: string;
+        countryCode?: string;
+        twitterName?: string;
+        social: {
+            key: string;
+            url: string;
+        }[];
+    };
+} & T;
+
+type IEquatable = number | string;
+type SchemaType = string;
+type ISchema = {
+    id: IEquatable;
+    schema?: string;
+};
+type IEntity = ISchema & Record<string, unknown>;
+type INamedEntity = IEntity & {
+    name: ILocalizable;
+};
+type ITitledEntity = IEntity & {
+    title: ILocalizable;
+};
+type IOption = Record<string, any> & {
+    id: IEquatable;
+    name: string;
+};
+type IFeature = Record<string, any> & {
+    id: IEquatable;
+    title: string;
+};
+type IFeatureType = IEntity & {
+    id: string;
+    title: string;
+    mode: string;
+    features: IFeature[];
+};
+
+type Headings = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6';
+
+type IComponent = {
+    id?: IEquatable;
+    blockType?: string;
+    schema?: string;
+    anchor?: IAnchor;
+    seoWeight?: Headings;
+    [key: string]: unknown;
+};
+
 type IMeta = {
     title?: string;
     description?: string;
@@ -359,14 +370,16 @@ type IMarket = IEntity & {
 
 type IRoute = {
     category: IEquatable;
-    resolvedCategory: IEquatable;
     id: string;
     isDefault?: boolean;
+    isRoot?: boolean;
     locale: string;
     market: string;
     media?: IMedia;
+    noindex?: boolean;
     order?: number;
     page: IEquatable;
+    resolvedCategory: IEquatable;
     schema: string;
     template?: string;
     title: string;
@@ -562,12 +575,13 @@ type IUndecoratedMenu = IEntity & {
     items: IUndecoratedMenuItem[];
 };
 
-type ILayout = {
+type ILayout<T extends IAppExtended = IAppExtended> = {
     labels: ILabel[];
     locale: string;
     locales: ILocale[];
     market: string;
     markets: IMarket[];
+    app: IPrettify<IApp<T>>;
     menu: Record<string, ILocalizedMenu>;
     topLevelHrefs: Record<string, string>;
     topLevelRoutes: Record<string, IRouteLink>;
@@ -631,11 +645,19 @@ type QueryParams = {
     sort?: string;
     where?: Where;
 };
+type GlobalQueryParams = {
+    depth?: number;
+    draft?: boolean;
+    locale?: string;
+    market?: string;
+    richText?: boolean;
+};
 
 type IPagedResult<T extends IEntity = IEntity> = {
     docs: T[];
 } & Pagination;
 type IQuerable<T extends IEntity = IEntity> = {
+    findGlobal<B extends T = T>(params?: GlobalQueryParams, token?: string): Promise<B | undefined>;
     findOne<B extends T = T>(id: IEquatable, params?: QueryParams, token?: string): Promise<B | undefined>;
     findMany<B extends T = T>(params?: QueryParams, token?: string): Promise<B[]>;
     findPaged<B extends T = T>(params?: QueryParams, token?: string): Promise<IPagedResult<B>>;
@@ -891,7 +913,7 @@ declare class JsonService<T extends IEntity = IEntity> implements IQuerable<T> {
     items: T[];
     constructor(items: T[]);
     getItems<B extends T = T>(): Promise<B[]>;
-    protected whereId_(id: IEquatable): WhereField;
+    findGlobal<B extends T = T>(params?: GlobalQueryParams): Promise<B | undefined>;
     findOne<B extends T = T>(id: IEquatable, params?: QueryParams): Promise<B | undefined>;
     findMany<B extends T = T>(params?: QueryParams): Promise<B[]>;
     findPaged<B extends T = T>(params?: QueryParams): Promise<IPagedResult<B>>;
@@ -1065,6 +1087,9 @@ declare function getOrigin(headers?: IncomingHttpHeaders | Headers): string;
 
 /**
  * Represents the route strategy options.
+ * - **Auto** dynamically add/remove prefixes based on number of markets & languages.
+ * - **Default** add prefixes based on !isDefault market or language flag.
+ * - **Manual** add prefixes based on !isHidden market or language flag.
  */
 declare enum RouteStrategy {
     Auto = "auto",
@@ -1361,9 +1386,9 @@ declare const isProduction: boolean;
 declare const isStage: boolean;
 declare const isBrowser: boolean;
 declare function getEnv(): Record<string, Json>;
-declare function withSchema<Component extends FC<any>, Schema>(component: Component, schema: Schema): Component & Schema;
+declare function withSchema<Component extends React.FC<any>, Schema>(component: Component, schema: Schema): Component & Schema;
 declare function asServerProps(props: any): any;
 declare function awaitAll(array: any, callback: (item: any, index: number) => Promise<any>): Promise<any[]>;
 declare function merge(target: any, source: any): any;
 
-export { type DeepPartial, type DeepRequired, type DeepRequiredProps, type Dynamic, type FetchError, type FetchRequestOptions, type FetchService, type FindParams, type FindWhereParams, type Headings, type IAction, type IActionEmailData, type IAnchor, type ICategorized, type ICategory, type ICategoryItem, type IClassName, type IClassNameCollection, type IClassNameValue, type ICollectionDescription, type IComponent, type IConfig, type IConsentPreference, type IContextBaseParams, type IContextParams, type IDecoratedNav, type IEmailConfig, type IEndUser, type IEntity, type IEquatable, type IFeature, type IFeatureType, type IImageResize, type ILabel, type ILayout, type ILegalNotice, type ILetter, type ILocale, type ILocaleId, type ILocalizable, type ILocalized, type ILocalizedMenu, type ILocalizedString, type IMarket, type IMedia, type IMediaImage, type IMediaInfo, type IMediaJson, type IMediaPdf, type IMediaType, type IMediaVideo, type IMemoryStore, type IMenu, type IMenuBase, type IMenuCategory, type IMenuCustom, type IMenuGroup, type IMenuHref, type IMenuItem, type IMenuLink, type IMenuPage, type IMenuRoute, type INamedEntity, type IOption, type IOverride, type IOverrideReturnValue, type IOverrideValue, type IPackages, type IPage, type IPageItem, type IPageRelation, type IPageRelationResult, type IPageUnresolvedRelation, type IPagedResult, type IPaginationResult, type IPartial, type IPreference, type IPrettify, type IQuerable, type IRedirect, type IRoute, type IRouteCanonical, type IRouteLink, type IRouteParams, type ISchema, type ISerializedCollection, type ISerializedStore, type IServerSideContext, type IServerSideSplatContext, type IStaticContext, type IStore, type ITemplate, type ITitledEntity, type IUndecoratedMenu, type IUndecoratedMenuBase, type IUndecoratedMenuCategory, type IUndecoratedMenuCustom, type IUndecoratedMenuGroup, type IUndecoratedMenuItem, type IUndecoratedMenuLink, type IUndecoratedMenuPage, type IUndecoratedNav, ImageStrategy, type Json, JsonService, type LiteralUnion, Logger, LoggerLevel, MenuCategoryStrategy, type NextApiRequestCookies, type Operator, type PageProps, type Pagination, type PreviewData, type Primitive, type QueryParams, RedirectReason, type RequireAtLeastOne, RouteStrategy, type SchemaType, type ServerSidePropsContext, type Shift, type ShiftUnion, type StaticPropsContext, type User, type UserRole, type UserWithRoles, type ValueOf, type Where, type WhereAndOr, type WhereBase, type WhereField, arrayShuffle, asCategoryId, asEntityId, asEquatable, asEquatableNumber, asEquatableString, asServerProps, asSortedOptions, awaitAll, base64ToString, camelToSnakeCase, cloneItem, collectFeatureTypes, collectFeatureTypes__, collectOptions, collectRoutes, consoleWarn, decryptImageResize, deepMerge, defaultLocale, defaultMarket, eachCategorized, eachMarketLocale, eachMedia, eachValue, encryptImageToken, enumToList, excludeComponent, findCategoryInCategories, findChildCategories, findRouteOfCategory, findRoutesOfCategory, getCategorySegments, getCategorySegmentsByCategory, getClassNames, getCollectionDescription, getEnv, getHost, getIsDevelopment, getIsProduction, getOrigin, getParentCategoriesById, getParentCategory, getProto, getRootCategory, getRouteHref, groupComponents, hasComponents, hasMarket, httpDelete, httpFetch, httpGet, httpPatch, httpPost, httpPut, isArray, isBrowser, isComponent, isComponentOfType, isDevelopment, isEntity, isEquatable, isHeaders, isIncomingHttpHeaders, isLocalizedString, isMedia, isMediaImage, isMediaJson, isMediaPdf, isMediaVideo, isMenuCategory, isMenuGroup, isMenuHref, isMenuLink, isMenuPage, isMenuRoute, isNonEmptyArray, isNotNullString, isNumber, isObject, isProduction, isPromise, isRelation, isReservedCollectionDescription, isStage, isString, isUndecoratedCategory, isUndecoratedMenuCategory, isUndecoratedMenuItem, isUndecoratedMenuPage, isUndecoratedNav, isUnresolvedCategory, isUnresolvedRelation, isValidCollectionDescription, isValidString, localize, localizeItem, localizeValue, localizedToString, merge, pascalCaseToCamelCase, pascalCaseToCharCase, pascalCaseToKebabCase, pascalCaseToSnakeCase, passwordStrategy, pickComponent, pickHero, prependHero, qsDeserialize, qsDeserializeRaw, qsSerialize, qsSerializeRaw, resolveMediaType, stringToBase64, toCamelCase, toCharCase, toDisplayName, toFindParams, toKebabCase, toPascalCase, toPluralName, toSnakeCase, toTitleCase, toValidCollectionName, unknownCaseToPascalCase, uuidv4, withSchema };
+export { DeepPartial, Dynamic, FetchError, FetchRequestOptions, FetchService, FindParams, FindWhereParams, GlobalQueryParams, Headings, IAction, IActionEmailData, IAnchor, IApp, IAppExtended, ICategorized, ICategory, ICategoryItem, IClassName, IClassNameCollection, IClassNameValue, ICollectionDescription, IComponent, IConfig, IConsentPreference, IContextBaseParams, IContextParams, IDecoratedNav, IEmailConfig, IEndUser, IEntity, IEquatable, IFeature, IFeatureType, IImageResize, ILabel, ILayout, ILegalNotice, ILetter, ILocale, ILocaleId, ILocalizable, ILocalized, ILocalizedMenu, ILocalizedString, IMarket, IMedia, IMediaImage, IMediaInfo, IMediaJson, IMediaPdf, IMediaType, IMediaVideo, IMemoryStore, IMenu, IMenuBase, IMenuCategory, IMenuCustom, IMenuGroup, IMenuHref, IMenuItem, IMenuLink, IMenuPage, IMenuRoute, INamedEntity, IOption, IOverride, IOverrideReturnValue, IOverrideValue, IPackages, IPage, IPageItem, IPageRelation, IPageRelationResult, IPageUnresolvedRelation, IPagedResult, IPaginationResult, IPartial, IPreference, IPrettify, IQuerable, IRedirect, IRoute, IRouteCanonical, IRouteLink, IRouteParams, ISchema, ISerializedCollection, ISerializedStore, IServerSideContext, IServerSideSplatContext, IStaticContext, IStore, ITemplate, ITitledEntity, IUndecoratedMenu, IUndecoratedMenuBase, IUndecoratedMenuCategory, IUndecoratedMenuCustom, IUndecoratedMenuGroup, IUndecoratedMenuItem, IUndecoratedMenuLink, IUndecoratedMenuPage, IUndecoratedNav, ImageStrategy, Json, JsonService, LiteralUnion, Logger, LoggerLevel, MenuCategoryStrategy, NextApiRequestCookies, Operator, PageProps, Pagination, PreviewData, Primitive, QueryParams, RedirectReason, RequireAtLeastOne, RouteStrategy, SchemaType, ServerSidePropsContext, StaticPropsContext, User, UserRole, UserWithRoles, ValueOf, Where, WhereAndOr, WhereBase, WhereField, arrayShuffle, asCategoryId, asEntityId, asEquatable, asEquatableNumber, asEquatableString, asServerProps, asSortedOptions, awaitAll, base64ToString, camelToSnakeCase, cloneItem, collectFeatureTypes, collectFeatureTypes__, collectOptions, collectRoutes, consoleWarn, decryptImageResize, deepMerge, defaultLocale, defaultMarket, eachCategorized, eachMarketLocale, eachMedia, eachValue, encryptImageToken, enumToList, excludeComponent, findCategoryInCategories, findChildCategories, findRouteOfCategory, findRoutesOfCategory, getCategorySegments, getCategorySegmentsByCategory, getClassNames, getCollectionDescription, getEnv, getHost, getIsDevelopment, getIsProduction, getOrigin, getParentCategoriesById, getParentCategory, getProto, getRootCategory, getRouteHref, groupComponents, hasComponents, hasMarket, httpDelete, httpFetch, httpGet, httpPatch, httpPost, httpPut, isArray, isBrowser, isComponent, isComponentOfType, isDevelopment, isEntity, isEquatable, isHeaders, isIncomingHttpHeaders, isLocalizedString, isMedia, isMediaImage, isMediaJson, isMediaPdf, isMediaVideo, isMenuCategory, isMenuGroup, isMenuHref, isMenuLink, isMenuPage, isMenuRoute, isNonEmptyArray, isNotNullString, isNumber, isObject, isProduction, isPromise, isRelation, isReservedCollectionDescription, isStage, isString, isUndecoratedCategory, isUndecoratedMenuCategory, isUndecoratedMenuItem, isUndecoratedMenuPage, isUndecoratedNav, isUnresolvedCategory, isUnresolvedRelation, isValidCollectionDescription, isValidString, localize, localizeItem, localizeValue, localizedToString, merge, pascalCaseToCamelCase, pascalCaseToCharCase, pascalCaseToKebabCase, pascalCaseToSnakeCase, passwordStrategy, pickComponent, pickHero, prependHero, qsDeserialize, qsDeserializeRaw, qsSerialize, qsSerializeRaw, resolveMediaType, stringToBase64, toCamelCase, toCharCase, toDisplayName, toFindParams, toKebabCase, toPascalCase, toPluralName, toSnakeCase, toTitleCase, toValidCollectionName, unknownCaseToPascalCase, uuidv4, withSchema };