@websolutespa/bom-next 3.0.0 → 3.0.2

package/dist/types.d.ts

@@ -0,0 +1,136 @@
+import { BowlDecorator, MixerPayload } from "./server/mixer-payload.js";
+import { ErrorContext, RequestInfo } from "./instrumentation/types.js";
+import { ICategorized, IComponent, ILayout, ILocale, IMarket, IPage, IPrettify, IRoute, PageProps } from "@websolutespa/bom-core";
+import { ComponentType, ReactNode } from "react";
+import { Category, EndUser, User } from "@websolutespa/payload-plugin-bowl";
+import { BasePayload, CollectionSlug, DataFromCollectionSlug, SanitizedConfig, TypedFallbackLocale, TypedLocale } from "payload";
+import { DynamicOptions, Loader } from "next/dynamic";
+
+//#region src/types.d.ts
+type ReadonlyHeaders = Headers & {
+  /** @deprecated Method unavailable on `ReadonlyHeaders`. Read more: https://nextjs.org/docs/app/api-reference/functions/headers */
+  append(...args: any[]): void;
+  /** @deprecated Method unavailable on `ReadonlyHeaders`. Read more: https://nextjs.org/docs/app/api-reference/functions/headers */
+  set(...args: any[]): void;
+  /** @deprecated Method unavailable on `ReadonlyHeaders`. Read more: https://nextjs.org/docs/app/api-reference/functions/headers */
+  delete(...args: any[]): void;
+};
+type BaseOptions = {
+  currentDepth?: number;
+  depth?: number;
+  disableErrors?: boolean;
+  fallbackLocale?: TypedFallbackLocale;
+  includeLockStatus?: boolean;
+  limit?: number;
+  locale?: 'all' | TypedLocale;
+  overrideAccess?: boolean;
+  page?: number;
+  pagination?: boolean;
+  showHiddenFields?: boolean;
+  trash?: boolean;
+  user?: any;
+  draft?: boolean;
+};
+type LocalProvider = {
+  config: Promise<SanitizedConfig> | undefined;
+  sanitizedConfig: SanitizedConfig | undefined;
+  payload: BasePayload | undefined;
+};
+type SearchParams = {
+  [key: string]: string | string[] | undefined;
+};
+type MarketLocaleParams = {
+  market: string;
+  locale: string;
+};
+type NotFoundParams = IPrettify<MarketLocaleParams & {
+  slug: string;
+}>;
+type NotFoundContext = Readonly<{
+  params: Promise<NotFoundParams>;
+}>;
+type LayoutContext = Readonly<{
+  children: ReactNode;
+  params: Promise<MarketLocaleParams>;
+}>;
+type PageParams = IPrettify<MarketLocaleParams & {
+  id: string;
+}>;
+type PageContext = Readonly<{
+  params: Promise<PageParams>;
+  searchParams?: Promise<SearchParams>;
+}>;
+type PageLayoutContext = Readonly<{
+  params: Promise<PageParams>;
+  children: ReactNode;
+}>;
+type PartialPageProps<T extends ICategorized, B> = Omit<PageProps<T>, 'page'> & Partial<Pick<PageProps<T>, 'page'>> & B;
+type ComponentProps<T extends Record<string, any> = Record<string, any>> = {
+  item: IComponent & T;
+};
+type ComponentContext<T extends Record<string, any> = Record<string, any>> = PageContext & {
+  page: IPage;
+} & ComponentProps<T>;
+type IUser = User;
+type IEndUser = EndUser;
+type MixerContext = {
+  market: string;
+  marketIds: string[];
+  markets: IMarket[];
+  locale: string;
+  localeIds: string[];
+  locales: ILocale[];
+  routes: IRoute[];
+  currentRoutes: IRoute[];
+  categories: Category[];
+  richText: boolean;
+};
+type IContext = {
+  payload: MixerPayload;
+  context: MixerContext;
+};
+type PageDocument<TSlug extends CollectionSlug> = DataFromCollectionSlug<TSlug>;
+/** A generated page collection document enriched with Bowl's page envelope. */
+type TypedPage<TSlug extends CollectionSlug> = BowlDecorator<PageDocument<TSlug>> & IPage<ICategorized>;
+type TypedPageContext<TSlug extends CollectionSlug = CollectionSlug> = {
+  layout: ILayout;
+  page: TypedPage<TSlug> | undefined;
+  user: IUser | IEndUser | null;
+  label: (key: string, params?: Record<string, any>) => string;
+  link: (category: string) => string | undefined;
+};
+/** Broad page context used where the page collection is only known at runtime. */
+type IPageContext = TypedPageContext;
+type ILazyComponent = IComponent;
+type ILazyProps<T> = {
+  item: T & ILazyComponent;
+  index: number;
+  children?: ReactNode;
+};
+type ILazyableProps<T> = {
+  item: T & Partial<ILazyComponent>;
+  index?: number;
+  children?: ReactNode;
+};
+type INullableLazyableProps<T> = {
+  item?: T & Partial<ILazyComponent>;
+  index?: number;
+  children?: ReactNode;
+};
+type ILazyedProps<T> = Omit<ILazyProps<T>, 'children'>;
+type ILazyComponentProps = {
+  item: ILazyComponent;
+  index: number;
+};
+type ILazyModules = Record<string, ComponentType<ILazyProps<any>>>;
+type ILazyComponentFunc<P = {}> = DynamicOptions<P> | Loader<P>;
+type ILazyFuncProps<T> = IContext & IPageContext & {
+  component: T & ILazyComponent;
+};
+type ILazyStaticPropsFunc<T = any> = (props: ILazyFuncProps<T>) => Promise<T & ILazyComponent>;
+type ILazyStaticProps = Record<string, ILazyStaticPropsFunc>;
+//# sourceMappingURL=types.d.ts.map
+
+//#endregion
+export { BaseOptions, ComponentContext, ComponentProps, ErrorContext, IContext, IEndUser, ILazyComponent, ILazyComponentFunc, ILazyComponentProps, ILazyFuncProps, ILazyModules, ILazyProps, ILazyStaticProps, ILazyStaticPropsFunc, ILazyableProps, ILazyedProps, INullableLazyableProps, IPageContext, IUser, LayoutContext, LocalProvider, MarketLocaleParams, MixerContext, NotFoundContext, NotFoundParams, PageContext, PageDocument, PageLayoutContext, PageParams, PartialPageProps, ReadonlyHeaders, RequestInfo, SearchParams, TypedPage, TypedPageContext };
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","names":[],"sources":["../src/types.ts"],"mappings":";;;;;;;;;KASY,eAAA,GAAkB;;EAAlB,MAAA,CAAA,GAAA,IAAA,EAAA,GAAe,EAAA,CAAA,EAAA,IAAA;EASf;EAAW,GAAA,CAAA,GAAA,IAAA,EAAA,GAAA,EAAA,CAAA,EAAA,IAAA;EAIJ;EAGA,MAAA,CAAA,GAAA,IAAA,EAAA,GAAA,EAAA,CAAA,EAAA,IAAA;AAAW,CAAA;AAUlB,KAjBA,WAAA,GAiBa;EAAA,YAAA,CAAA,EAAA,MAAA;EACP,KAAA,CAAA,EAAA,MAAA;EAAR,aAAA,CAAA,EAAA,OAAA;EACS,cAAA,CAAA,EAfA,mBAeA;EACR,iBAAA,CAAA,EAAA,OAAA;EAAW,KAAA,CAAA,EAAA,MAAA;EAGV,MAAA,CAAA,EAAA,KAAA,GAhBO,WAgBK;EAIZ,cAAA,CAAA,EAAA,OAAkB;EAKlB,IAAA,CAAA,EAAA,MAAA;EAAc,UAAA,CAAA,EAAA,OAAA;EAAa,gBAAA,CAAA,EAAA,OAAA;EAAV,KAAA,CAAA,EAAA,OAAA;EAAS,IAAA,CAAA,EAAA,GAAA;EAI1B,KAAA,CAAA,EAAA,OAAA;AAAe,CAAA;AACT,KApBN,aAAA,GAoBM;EAAR,MAAA,EAnBA,OAmBA,CAnBQ,eAmBR,CAAA,GAAA,SAAA;EADoB,eAAA,EAjBX,eAiBW,GAAA,SAAA;EAAQ,OAAA,EAhB3B,WAgB2B,GAAA,SAAA;AAItC,CAAA;AAAyB,KAjBb,YAAA,GAiBa;EACb,CAAA,GAAA,EAAA,MAAA,CAAA,EAAA,MAAA,GAAA,MAAA,EAAA,GAAA,SAAA;AACM,CAAA;AAAR,KAfE,kBAAA,GAeF;EAFkB,MAAA,EAAA,MAAA;EAAQ,MAAA,EAAA,MAAA;AAKpC,CAAA;AAAsB,KAbV,cAAA,GAAiB,SAaP,CAbiB,kBAajB,GAAA;EAAa,IAAA,EAAA,MAAA;AAAV,CAAA,CAAA;AAAS,KATtB,eAAA,GAAkB,QASI,CAAA;EAItB,MAAA,EAZF,OAYa,CAZL,cAYK,CAAA;AAAA,CAAA,CAAA;AACL,KAVN,aAAA,GAAgB,QAUV,CAAA;EAAR,QAAA,EATE,SASF;EACe,MAAA,EATf,OASe,CATP,kBASO,CAAA;AAAR,CAAA,CAAA;AAFS,KAJd,UAAA,GAAa,SAIC,CAJS,kBAIT,GAAA;EAAQ,EAAA,EAAA,MAAA;AAKlC,CAAA,CAAA;AAA6B,KALjB,WAAA,GAAc,QAKG,CAAA;EACX,MAAA,EALR,OAKQ,CALA,UAKA,CAAA;EAAR,YAAA,CAAA,EAJO,OAIP,CAJe,YAIf,CAAA;AACE,CAAA,CAAA;AAFoB,KAApB,iBAAA,GAAoB,QAAA,CAAA;EAAQ,MAAA,EAC9B,OAD8B,CACtB,UADsB,CAAA;EAK5B,QAAA,EAHA,SAGgB;AAAA,CAAA,CAAA;AAAW,KAA3B,gBAA2B,CAAA,UAAA,YAAA,EAAA,CAAA,CAAA,GAAmB,IAAnB,CAAwB,SAAxB,CAAkC,CAAlC,CAAA,EAAA,MAAA,CAAA,GAAgD,OAAhD,CAAwD,IAAxD,CAA6D,SAA7D,CAAuE,CAAvE,CAAA,EAAA,MAAA,CAAA,CAAA,GAAsF,CAAtF;AAAkC,KAE7D,cAF6D,CAAA,UAEpC,MAFoC,CAAA,MAAA,EAAA,GAAA,CAAA,GAEd,MAFc,CAAA,MAAA,EAAA,GAAA,CAAA,CAAA,GAAA;EAAV,IAAA,EAE2B,UAF3B,GAEwC,CAFxC;AAAL,CAAA;AAAoD,KAIlG,gBAJkG,CAAA,UAIvE,MAJuE,CAAA,MAAA,EAAA,GAAA,CAAA,GAIjD,MAJiD,CAAA,MAAA,EAAA,GAAA,CAAA,CAAA,GAI1B,WAJ0B,GAAA;EAAV,IAAA,EAIM,KAJN;AAAL,CAAA,GAIqB,cAJrB,CAIoC,CAJpC,CAAA;AAAR,KAM3E,KAAA,GAAQ,IANmE;AAAsC,KAQjH,QAAA,GAAW,OARsG;AAAC,KAqBlH,YAAA,GArBkH;EAElH,MAAA,EAAA,MAAA;EAAc,SAAA,EAAA,MAAA,EAAA;EAAW,OAAA,EAsB1B,OAtB0B,EAAA;EAAsB,MAAA,EAAA,MAAA;EAA+B,SAAA,EAAA,MAAA,EAAA;EAAa,OAAA,EAyB5F,OAzB4F,EAAA;EAAC,MAAA,EA0B9F,MA1B8F,EAAA;EAE5F,aAAA,EAyBK,MAzBW,EAAA;EAAA,UAAA,EA0Bd,QA1Bc,EAAA;EAAW,QAAA,EAAA,OAAA;AAAsB,CAAA;AAAuB,KA8BxE,QAAA,GA9BwE;EAAsB,OAAA,EA+B/F,YA/B+F;EAAyB,OAAA,EAgCxH,YAhCwH;AAAf,CAAA;AAAc,KAmCtH,YAnCsH,CAAA,cAmC3F,cAnC2F,CAAA,GAmCzE,sBAnCyE,CAmClD,KAnCkD,CAAA;AAElI;AAEY,KAkCA,SAlCQ,CAAA,cAkCgB,cAlCN,CAAA,GAkCwB,aAlCxB,CAkCsC,YAlCtC,CAkCmD,KAlCnD,CAAA,CAAA,GAkC6D,KAlC7D,CAkCmE,YAlCnE,CAAA;AAalB,KAuBA,gBAvBY,CAAA,cAuBmB,cAvBnB,GAuBoC,cAvBpC,CAAA,GAAA;EAAA,MAAA,EAwBd,OAxBc;EAGb,IAAA,EAsBH,SAtBG,CAsBO,KAtBP,CAAA,GAAA,SAAA;EAGA,IAAA,EAoBH,KApBG,GAoBK,QApBL,GAAA,IAAA;EACD,KAAA,EAAA,CAAA,GAAA,EAAA,MAAA,EAAA,MAAA,CAAA,EAoBsB,MApBtB,CAAA,MAAA,EAAA,GAAA,CAAA,EAAA,GAAA,MAAA;EACO,IAAA,EAAA,CAAA,QAAA,EAAA,MAAA,EAAA,GAAA,MAAA,GAAA,SAAA;AACH,CAAA;AAAQ;AAIV,KAmBA,YAAA,GAAe,gBAnBP;AAAA,KAqBR,cAAA,GAAiB,UArBT;AACT,KAsBC,UAtBD,CAAA,CAAA,CAAA,GAAA;EACA,IAAA,EAsBH,CAtBG,GAsBC,cAtBD;EAAY,KAAA,EAAA,MAAA;EAGX,QAAA,CAAA,EAqBC,SArBW;AAAA,CAAA;AAAe,KAwB3B,cAxB2B,CAAA,CAAA,CAAA,GAAA;EAAyC,IAAA,EAyBxE,CAzBwE,GAyBpE,OAzBoE,CAyB5D,cAzB4D,CAAA;EAAvB,KAAA,CAAA,EAAA,MAAA;EAAsB,QAAA,CAAA,EA2BlE,SA3BkE;AAG/E,CAAA;AAAqB,KA2BT,sBA3BS,CAAA,CAAA,CAAA,GAAA;EAAe,IAAA,CAAA,EA4B3B,CA5B2B,GA4BvB,OA5BuB,CA4Bf,cA5Be,CAAA;EAA6C,KAAA,CAAA,EAAA,MAAA;EAAb,QAAA,CAAA,EA8BvD,SA9BuD;AAAd,CAAA;AAA2C,KAiCrF,YAjCqF,CAAA,CAAA,CAAA,GAiCnE,IAjCmE,CAiC9D,UAjC8D,CAiCnD,CAjCmD,CAAA,EAAA,UAAA,CAAA;AAAN,KAmC/E,mBAAA,GAnC+E;EAAK,IAAA,EAoCxF,cApCwF;EAEpF,KAAA,EAAA,MAAA;AAAgB,CAAA;AAAe,KAsC/B,YAAA,GAAe,MAtCgB,CAAA,MAAA,EAsCD,aAtCC,CAsCa,UAtCb,CAAA,GAAA,CAAA,CAAA,CAAA;AAAiB,KAwChD,kBAxCgD,CAAA,IAAA,CAAA,CAAA,CAAA,GAwCnB,cAxCmB,CAwCJ,CAxCI,CAAA,GAwCC,MAxCD,CAwCQ,CAxCR,CAAA;AAClD,KAyCE,cAzCF,CAAA,CAAA,CAAA,GAyCsB,QAzCtB,GAyCiC,YAzCjC,GAAA;EACQ,SAAA,EAyCL,CAzCK,GAyCD,cAzCC;AAAV,CAAA;AACA,KA2CI,oBA3CJ,CAAA,IAAA,GAAA,CAAA,GAAA,CAAA,KAAA,EA2C4C,cA3C5C,CA2C2D,CA3C3D,CAAA,EAAA,GA2CkE,OA3ClE,CA2C0E,CA3C1E,GA2C8E,cA3C9E,CAAA;AAAQ,KA6CJ,gBAAA,GAAmB,MA7Cf,CAAA,MAAA,EA6C8B,oBA7C9B,CAAA;AACgB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@websolutespa/bom-next",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "description": "Next module of the BOM Repository",
   "keywords": [
     "bom",

package/src/index.ts

@@ -14,4 +14,3 @@ export * from './lib/twitter-card';
 export * from './lib/utils';
 export * from './mock';
 export * from './types';
-