@websolutespa/bom-core 0.6.6 → 1.7.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @websolutespa/bom-core
 
+## 1.7.0
+
+### Minor Changes
+
+- 28e86bd: Modified: IPage, Store services & decorators
+
+## 1.6.0
+
+### Patch Changes
+
+- 6cbf4cb: Added: IAction, IEndUser, IConsentPreference, IPreference, ILegalNotice
+
 ## 0.6.6
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import { IncomingMessage, ServerResponse } from 'http';
 import { ParsedUrlQuery } from 'querystring';
+import React from 'react';
 
 type Json = string | number | boolean | null | Json[] | {
     [key: string]: Json;
@@ -51,19 +52,70 @@ type IPartial<T> = {
 type IPrettify<T> = {
     [K in keyof T]: T[K];
 } & {};
-type IOverride<T, TypeToReplace, TypeToReplaceWith> = {
-    [K in keyof T]: T[K] extends Record<string, unknown> ? IOverride<T[K], TypeToReplace, TypeToReplaceWith> : T[K] extends TypeToReplace ? TypeToReplaceWith : T[K];
+type IOverrideReturnValue<T, FromType, ToType> = T extends Record<string, unknown> ? IOverride<T, FromType, ToType> : T;
+type IOverrideValue<T, FromType, ToType> = T extends FromType ? ToType : IOverrideReturnValue<T, FromType, ToType>;
+type IOverride<T, FromType, ToType> = {
+    [Property in keyof T]: IOverrideValue<T[Property], FromType, ToType>;
 };
 
-type ILocalizedString = Record<string, string>;
+/**
+ * List of ISO 639 language codes (set 1)
+ * https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes
+ */
+type ILetter = 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | 'h' | 'i' | 'j' | 'k' | 'l' | 'm' | 'n' | 'o' | 'p' | 'q' | 'r' | 's' | 't' | 'u' | 'v' | 'w' | 'x' | 'y' | 'z';
+type ILocaleId = `${ILetter}${ILetter}`;
+type ILocalizedString = Record<ILocaleId, string>;
 type ILocalizable = string | ILocalizedString;
 type ILocalized<T> = IOverride<T, ILocalizable, string>;
 
+type ILegalNotice = {
+    id: string;
+    text: ILocalizable;
+};
+type IPreference = {
+    id: string;
+    description: string;
+    legalNotice: ILegalNotice;
+};
+type IConsentPreference = {
+    id: string;
+    consentPreference: IPreference;
+    date: Date | string;
+};
+
+type User = Record<string, unknown> & {
+    collection: string;
+    id: string;
+    email: string;
+};
+type UserRole = 'admin' | 'editor' | 'user' | string;
+type UserWithRoles = User & {
+    roles: UserRole[];
+};
+type IEndUser = UserWithRoles & {
+    email: string;
+    consentPreferences: IConsentPreference[];
+};
+
+type IAction = Record<string, unknown> & {
+    id: string;
+    consentPreferences: IConsentPreference[];
+    endUser: IEndUser;
+    loggedEndUser?: IEndUser;
+    email?: string;
+    password?: string;
+};
+
 type IAnchor = {
     id: string;
     title?: ILocalizable;
 };
 
+type IComponent = {
+    schema: string;
+    [key: string]: unknown;
+};
+
 type IEquatable = number | string;
 type SchemaType = string;
 type ISchema = {
@@ -108,6 +160,13 @@ type IMedia = {
 };
 declare function resolveMediaType(media: IMedia): IMediaType;
 
+type IMeta = {
+    title?: string;
+    description?: string;
+    keywords?: string;
+    robots?: string;
+};
+
 type ICategory = IEntity & {
     category?: IEquatable | ICategory;
     id: IEquatable;
@@ -119,19 +178,20 @@ type ICategory = IEntity & {
 type ICategoryItem = ICategory & {
     items: ICategory[];
 };
-type ICategorized = {
-    abstract?: ILocalizable;
-    category: IEquatable | ICategory;
-    id: IEquatable;
-    isDefault?: boolean;
-    markets?: string[];
+type ICategorized = IEntity & {
+    title: ILocalizable;
+    abstract?: string;
+    description?: string;
     media?: IMedia;
-    order?: number;
-    schema?: string;
+    meta?: IMeta;
+    components?: IComponent[];
+    category: IEquatable | ICategory;
     slug: ILocalizable;
     template?: string;
-    title: ILocalizable;
+    isDefault?: boolean;
     useSplat?: boolean;
+    order?: number;
+    markets?: string[];
     createdAt?: Date;
     updatedAt?: Date;
 };
@@ -183,13 +243,6 @@ type IMarket = IEntity & {
     isHidden?: boolean;
 };
 
-type IMeta = {
-    title?: string;
-    description?: string;
-    keywords?: string;
-    robots?: string;
-};
-
 type IRoute = {
     category: IEquatable | ICategory;
     id: string;
@@ -223,20 +276,25 @@ type IRouteParams = Record<string, any> & {
     market: string;
 };
 
-type IPage = Record<string, any> & ICategorized & {
-    abstract?: string;
+type IPage<T extends ICategorized = ICategorized> = ILocalized<T> & {
     alternates: IRoute[];
     breadcrumb: IRouteLink[];
-    content?: string;
-    description?: string;
+    category: ILocalized<ICategory>;
     href: string;
     locale: string;
     market: string;
-    meta?: IMeta;
     parentRoute?: IRouteLink;
     slug: string;
     title: string;
 };
+type PageProps<T extends ICategorized = ICategorized> = {
+    layout: ILayout;
+    page: IPage<T>;
+    params: IRouteParams;
+    locales?: string[];
+    locale?: string;
+    defaultLocale?: string;
+};
 type IPageRelationResult<T extends ICategorized = ICategorized> = {
     href: string;
 } & T;
@@ -248,15 +306,6 @@ type IPageUnresolvedRelation = {
     relationTo: string;
     value: IEquatable | IEquatable[];
 };
-type IPageResult<T extends ICategorized = ICategorized> = IPage & T;
-type PageProps<T extends ICategorized = ICategorized> = {
-    layout: ILayout;
-    page: IPageResult<T>;
-    params: IRouteParams;
-    locales?: string[];
-    locale?: string;
-    defaultLocale?: string;
-};
 
 type IMenuBase = {
     abstract?: ILocalizable;
@@ -297,6 +346,8 @@ type IMenuCustom = Record<string, unknown> & {
     type: string;
 };
 type IMenuItem = IMenuCategory | IMenuGroup | IMenuLink | IMenuPage | IMenuRoute;
+type IMenuHref = IMenuCategory | IMenuLink | IMenuPage | IMenuRoute;
+declare function isMenuHref(item: IMenuItem): item is IMenuHref;
 type IMenu = {
     id: string;
     items: IMenuItem[];
@@ -351,7 +402,7 @@ type ILayout = {
     locales: ILocale[];
     market: string;
     markets: IMarket[];
-    menu: Record<string, IMenu>;
+    menu: Record<string, ILocalized<IMenu>>;
     topLevelHrefs: Record<string, string>;
     topLevelRoutes: Record<string, IRouteLink>;
     tree?: IRouteLink;
@@ -449,7 +500,7 @@ type IRedirect = {
 };
 
 type IMemoryStore<T extends IEntity = IEntity> = Record<string, T[]>;
-type IStore = Record<string, IQuerable<IEntity>>;
+type IStore = Record<string, IQuerable>;
 type IConfig = {
     collections: string[];
     mocks: string[];
@@ -637,9 +688,9 @@ declare const isProduction: boolean;
 declare const isStage: boolean;
 declare const isBrowser: boolean;
 declare function getEnv(): Record<string, Json>;
-declare function withSchema<Component extends {}, 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 { FetchError, FetchRequestOptions, FetchService, FindParams, FindWhereParams, IAnchor, ICategorized, ICategory, ICategoryItem, IClassName, IClassNameCollection, IClassNameValue, ICollectionDescription, IConfig, IContextBaseParams, IContextParams, IDecoratedNav, IEntity, IEquatable, IFeature, IFeatureType, ILabel, ILayout, ILocale, ILocalizable, ILocalized, ILocalizedString, IMarket, IMedia, IMediaType, IMemoryStore, IMenu, IMenuBase, IMenuCategory, IMenuCustom, IMenuGroup, IMenuItem, IMenuLink, IMenuPage, IMenuRoute, INamedEntity, IOption, IOverride, IPackages, IPage, IPageRelation, IPageRelationResult, IPageResult, IPageUnresolvedRelation, IPagedResult, IPaginationResult, IPartial, 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, Json, JsonService, LiteralUnion, Logger, LoggerLevel, NextApiRequestCookies, Operator, PageProps, Pagination, PreviewData, QueryParams, RedirectReason, RouteStrategy, SchemaType, ServerSidePropsContext, StateValue, StaticPropsContext, ValueOf, Where, WhereAndOr, WhereBase, WhereField, asCategoryId, asEquatable, asServerProps, awaitAll, camelToSnakeCase, cloneItem, collectFeatureTypes, collectOptions, collectRoutes, consoleWarn, defaultLocale, defaultMarket, eachCategorized, eachMarketLocale, enumToList, getCategorySegments, getCategorySegmentsByCategory, getClassNames, getCollectionDescription, getEnv, getIsDevelopment, getIsProduction, getParentCategoriesById, getRootCategory, getRouteHref, httpDelete, httpFetch, httpGet, httpPatch, httpPost, httpPut, isArray, isBrowser, isCategory, isDevelopment, isEntity, isEquatable, isLocalizedString, isNotNullString, isObject, isProduction, isRelation, isReservedCollectionDescription, isStage, isUndecoratedMenuCategory, isUndecoratedMenuItem, isUndecoratedMenuPage, isUndecoratedNav, isUnresolvedRelation, isValidCollectionDescription, localize, localizeItem, localizeValue, localizedToString, merge, pascalCaseToCamelCase, pascalCaseToCharCase, pascalCaseToKebabCase, pascalCaseToSnakeCase, qsDeserialize, qsDeserializeRaw, qsSerialize, qsSerializeRaw, resolveMediaType, textToSlug, toCamelCase, toCharCase, toDisplayName, toFindParams, toKebabCase, toPascalCase, toPluralName, toSnakeCase, toTitleCase, toValidCollectionName, unknownCaseToPascalCase, withSchema };
+export { FetchError, FetchRequestOptions, FetchService, FindParams, FindWhereParams, IAction, IAnchor, ICategorized, ICategory, ICategoryItem, IClassName, IClassNameCollection, IClassNameValue, ICollectionDescription, IComponent, IConfig, IConsentPreference, IContextBaseParams, IContextParams, IDecoratedNav, IEndUser, IEntity, IEquatable, IFeature, IFeatureType, ILabel, ILayout, ILegalNotice, ILetter, ILocale, ILocaleId, ILocalizable, ILocalized, ILocalizedString, IMarket, IMedia, IMediaType, IMemoryStore, IMenu, IMenuBase, IMenuCategory, IMenuCustom, IMenuGroup, IMenuHref, IMenuItem, IMenuLink, IMenuPage, IMenuRoute, INamedEntity, IOption, IOverride, IOverrideReturnValue, IOverrideValue, IPackages, IPage, 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, Json, JsonService, LiteralUnion, Logger, LoggerLevel, NextApiRequestCookies, Operator, PageProps, Pagination, PreviewData, QueryParams, RedirectReason, RouteStrategy, SchemaType, ServerSidePropsContext, StateValue, StaticPropsContext, User, UserRole, UserWithRoles, ValueOf, Where, WhereAndOr, WhereBase, WhereField, asCategoryId, asEquatable, asServerProps, awaitAll, camelToSnakeCase, cloneItem, collectFeatureTypes, collectOptions, collectRoutes, consoleWarn, defaultLocale, defaultMarket, eachCategorized, eachMarketLocale, enumToList, getCategorySegments, getCategorySegmentsByCategory, getClassNames, getCollectionDescription, getEnv, getIsDevelopment, getIsProduction, getParentCategoriesById, getRootCategory, getRouteHref, httpDelete, httpFetch, httpGet, httpPatch, httpPost, httpPut, isArray, isBrowser, isCategory, isDevelopment, isEntity, isEquatable, isLocalizedString, isMenuHref, isNotNullString, isObject, isProduction, isRelation, isReservedCollectionDescription, isStage, isUndecoratedMenuCategory, isUndecoratedMenuItem, isUndecoratedMenuPage, isUndecoratedNav, isUnresolvedRelation, isValidCollectionDescription, localize, localizeItem, localizeValue, localizedToString, merge, pascalCaseToCamelCase, pascalCaseToCharCase, pascalCaseToKebabCase, pascalCaseToSnakeCase, qsDeserialize, qsDeserializeRaw, qsSerialize, qsSerializeRaw, resolveMediaType, textToSlug, toCamelCase, toCharCase, toDisplayName, toFindParams, toKebabCase, toPascalCase, toPluralName, toSnakeCase, toTitleCase, toValidCollectionName, unknownCaseToPascalCase, withSchema };

package/dist/index.js

@@ -73,6 +73,7 @@ __export(src_exports, {
   isEntity: () => isEntity,
   isEquatable: () => isEquatable,
   isLocalizedString: () => isLocalizedString,
+  isMenuHref: () => isMenuHref,
   isNotNullString: () => isNotNullString,
   isObject: () => isObject,
   isProduction: () => isProduction,
@@ -1129,6 +1130,11 @@ function resolveMediaType(media) {
   return media.type || (media.mimeType ? media.mimeType.split("/")[0] : "image");
 }
 
+// src/types/menu.ts
+function isMenuHref(item) {
+  return ["category", "link", "page", "route"].includes(item.type);
+}
+
 // src/types/querable.ts
 function toFindParams(idOrParams) {
   if (typeof idOrParams === "number" || typeof idOrParams === "string") {
@@ -1192,6 +1198,7 @@ var RedirectReason = /* @__PURE__ */ ((RedirectReason2) => {
   isEntity,
   isEquatable,
   isLocalizedString,
+  isMenuHref,
   isNotNullString,
   isObject,
   isProduction,

package/dist/index.mjs

@@ -1012,6 +1012,11 @@ function resolveMediaType(media) {
   return media.type || (media.mimeType ? media.mimeType.split("/")[0] : "image");
 }
 
+// src/types/menu.ts
+function isMenuHref(item) {
+  return ["category", "link", "page", "route"].includes(item.type);
+}
+
 // src/types/querable.ts
 function toFindParams(idOrParams) {
   if (typeof idOrParams === "number" || typeof idOrParams === "string") {
@@ -1074,6 +1079,7 @@ export {
   isEntity,
   isEquatable,
   isLocalizedString,
+  isMenuHref,
   isNotNullString,
   isObject,
   isProduction,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@websolutespa/bom-core",
-  "version": "0.6.6",
+  "version": "1.7.0",
   "description": "Core module of the BOM Repository",
   "keywords": [
     "bom",