@websolutespa/bom-core 0.6.2 → 0.6.4

package/CHANGELOG.md

@@ -1,82 +1,95 @@
-# @websolutespa/bom-core
-
-## 0.6.2
-
-### Patch Changes
-
-- Modified: IMedia.
-
-## 0.6.1
-
-### Patch Changes
-
-- Added: defaultMarket, defaultLocale
-
-## 0.6.0
-
-### Minor Changes
-
-- Added Logger, IPaginationResult.
-
-## 0.5.0
-
-### Minor Changes
-
-- Modified: JsonService, qs.
-- Added: asEquatable, cloneItem, typeGuards.
-
-## 0.4.1
-
-### Patch Changes
-
-- Added: IAnchor, babelCase.
-- Modified: IApplication, IPageRelation.
-
-## 0.4.0
-
-### Minor Changes
-
-- Updating: next 13.
-
-## 0.3.0
-
-### Minor Changes
-
-- Modified: HttpService.
-
-## 0.2.1
-
-### Patch Changes
-
-- Added: env ROOT_CATEGORY.
-
-## 0.2.0
-
-### Minor Changes
-
-- Modified routes, added redirects.
-
-## 0.1.2
-
-### Patch Changes
-
-- Modified: MockMenuService.
-
-## 0.1.1
-
-### Patch Changes
-
-- Modified: ILocalizable.
-
-## 0.1.0
-
-### Minor Changes
-
-- Added: splat routes.
-- Added: variants.
-
-## 0.0.1
-
-### Patch Changes
-
-- Added: first release.
+# @websolutespa/bom-core
+
+## 0.6.4
+
+### Patch Changes
+
+- Added: typeGuards, IPagedResult.
+- Modified: IUndecoratedMenuCustom.
+
+## 0.6.3
+
+### Patch Changes
+
+- Added: isReservedCollectionDescription.
+
+## 0.6.2
+
+### Patch Changes
+
+- Modified: IMedia.
+
+## 0.6.1
+
+### Patch Changes
+
+- Added: defaultMarket, defaultLocale.
+
+## 0.6.0
+
+### Minor Changes
+
+- Added Logger, IPaginationResult.
+
+## 0.5.0
+
+### Minor Changes
+
+- Modified: JsonService, qs.
+- Added: asEquatable, cloneItem, typeGuards.
+
+## 0.4.1
+
+### Patch Changes
+
+- Added: IAnchor, babelCase.
+- Modified: IApplication, IPageRelation.
+
+## 0.4.0
+
+### Minor Changes
+
+- Updating: next 13.
+
+## 0.3.0
+
+### Minor Changes
+
+- Modified: HttpService.
+
+## 0.2.1
+
+### Patch Changes
+
+- Added: env ROOT_CATEGORY.
+
+## 0.2.0
+
+### Minor Changes
+
+- Modified routes, added redirects.
+
+## 0.1.2
+
+### Patch Changes
+
+- Modified: MockMenuService.
+
+## 0.1.1
+
+### Patch Changes
+
+- Modified: ILocalizable.
+
+## 0.1.0
+
+### Minor Changes
+
+- Added: splat routes.
+- Added: variants.
+
+## 0.0.1
+
+### Patch Changes
+
+- Added: first release.

package/dist/index.d.ts

@@ -324,8 +324,7 @@ type IUndecoratedMenuPage = Omit<IUndecoratedMenuBase, 'type'> & {
     page: IPageRelation;
     title?: ILocalizable;
 };
-type IUndecoratedMenuCustom = Record<string, unknown> & {
-    id: IEquatable;
+type IUndecoratedMenuCustom = Omit<IUndecoratedMenuBase, 'type'> & {
     type: 'custom';
     blockType: string;
 };
@@ -394,12 +393,13 @@ type QueryParams = {
     richText?: boolean;
 };
 
+type IPagedResult<T extends IEntity = IEntity> = {
+    docs: T[];
+} & Pagination;
 type IQuerable<T extends IEntity = IEntity> = {
     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<{
-        docs: B[];
-    } & Pagination>;
+    findPaged<B extends T = T>(params?: QueryParams): Promise<IPagedResult<B>>;
     create<B extends T = T>(payload: Omit<B, 'id'>): Promise<B>;
     update<B extends T = T>(payload: Partial<B>): Promise<B>;
     delete<B extends T = T>(id: IEquatable): Promise<B | undefined>;
@@ -479,6 +479,7 @@ declare function getClassNames(...props: Array<IClassName>): string;
 declare function getCollectionDescription(text: string): ICollectionDescription;
 declare function camelToSnakeCase(text: string): string;
 declare function isValidCollectionDescription(description: ICollectionDescription): boolean;
+declare function isReservedCollectionDescription(description: ICollectionDescription): boolean;
 declare function toDisplayName(text: string): string;
 declare function toPluralName(text: string): string;
 declare function toTitleCase(text: string): string;
@@ -499,9 +500,7 @@ declare class JsonService<T extends IEntity = IEntity> implements IQuerable<T> {
     getItems<B extends T = T>(): Promise<B[]>;
     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<{
-        docs: B[];
-    } & Pagination>;
+    findPaged<B extends T = T>(params?: QueryParams): Promise<IPagedResult<B>>;
     create<B extends T = T>(payload: Omit<B, 'id'>): Promise<B>;
     update<B extends T = T>(payload: Partial<B>): Promise<B>;
     delete<B extends T = T>(id: IEquatable): Promise<B | undefined>;
@@ -611,6 +610,7 @@ declare function isUnresolvedRelation(item: unknown): item is IPageUnresolvedRel
 declare function isRelation(item: unknown): item is IPageRelation;
 declare function isUndecoratedMenuItem(item: unknown): item is IUndecoratedMenuItem;
 declare function isUndecoratedNav<T>(item: unknown): item is IUndecoratedNav<T>;
+declare function isUndecoratedMenuCategory(item: unknown): item is IUndecoratedMenuCategory;
 declare function isUndecoratedMenuPage(item: unknown): item is IUndecoratedMenuPage;
 
 declare function getIsDevelopment(): boolean;
@@ -625,4 +625,4 @@ 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, 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, 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, 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, isStage, 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, IAnchor, ICategorized, ICategory, ICategoryItem, IClassName, IClassNameCollection, IClassNameValue, ICollectionDescription, IConfig, IContextBaseParams, IContextParams, IDecoratedNav, IEntity, IEquatable, 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, 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 };

package/dist/index.js

@@ -75,7 +75,9 @@ __export(src_exports, {
   isObject: () => isObject,
   isProduction: () => isProduction,
   isRelation: () => isRelation,
+  isReservedCollectionDescription: () => isReservedCollectionDescription,
   isStage: () => isStage,
+  isUndecoratedMenuCategory: () => isUndecoratedMenuCategory,
   isUndecoratedMenuItem: () => isUndecoratedMenuItem,
   isUndecoratedMenuPage: () => isUndecoratedMenuPage,
   isUndecoratedNav: () => isUndecoratedNav,
@@ -242,6 +244,18 @@ function camelToSnakeCase(text) {
 function isValidCollectionDescription(description) {
   return description.singularName !== description.pluralName;
 }
+function isReservedCollectionDescription(description) {
+  return [
+    "category",
+    "label",
+    "locale",
+    "market",
+    "menu",
+    "redirect",
+    "route",
+    "template"
+  ].includes(description.singularName);
+}
 function toDisplayName(text) {
   return toTitleCase(text).replace(/\s/g, "");
 }
@@ -363,8 +377,11 @@ function isUndecoratedMenuItem(item) {
 function isUndecoratedNav(item) {
   return isObject(item) && isUndecoratedMenuPage(item.nav);
 }
+function isUndecoratedMenuCategory(item) {
+  return isObject(item) && item.type === "category" && isNotNullString(item.category) && item.id === void 0 && item.href === void 0;
+}
 function isUndecoratedMenuPage(item) {
-  return isObject(item) && item.type === "page" && isNotNullString(item.page.relationTo) && isEquatable(item.page.value);
+  return isObject(item) && item.type === "page" && isObject(item.page) && isNotNullString(item.page.relationTo) && isEquatable(item.page.value);
 }
 
 // src/utils/cloneItem.ts
@@ -1125,7 +1142,9 @@ var RedirectReason = /* @__PURE__ */ ((RedirectReason2) => {
   isObject,
   isProduction,
   isRelation,
+  isReservedCollectionDescription,
   isStage,
+  isUndecoratedMenuCategory,
   isUndecoratedMenuItem,
   isUndecoratedMenuPage,
   isUndecoratedNav,

package/dist/index.mjs

@@ -129,6 +129,18 @@ function camelToSnakeCase(text) {
 function isValidCollectionDescription(description) {
   return description.singularName !== description.pluralName;
 }
+function isReservedCollectionDescription(description) {
+  return [
+    "category",
+    "label",
+    "locale",
+    "market",
+    "menu",
+    "redirect",
+    "route",
+    "template"
+  ].includes(description.singularName);
+}
 function toDisplayName(text) {
   return toTitleCase(text).replace(/\s/g, "");
 }
@@ -250,8 +262,11 @@ function isUndecoratedMenuItem(item) {
 function isUndecoratedNav(item) {
   return isObject(item) && isUndecoratedMenuPage(item.nav);
 }
+function isUndecoratedMenuCategory(item) {
+  return isObject(item) && item.type === "category" && isNotNullString(item.category) && item.id === void 0 && item.href === void 0;
+}
 function isUndecoratedMenuPage(item) {
-  return isObject(item) && item.type === "page" && isNotNullString(item.page.relationTo) && isEquatable(item.page.value);
+  return isObject(item) && item.type === "page" && isObject(item.page) && isNotNullString(item.page.relationTo) && isEquatable(item.page.value);
 }
 
 // src/utils/cloneItem.ts
@@ -1011,7 +1026,9 @@ export {
   isObject,
   isProduction,
   isRelation,
+  isReservedCollectionDescription,
   isStage,
+  isUndecoratedMenuCategory,
   isUndecoratedMenuItem,
   isUndecoratedMenuPage,
   isUndecoratedNav,

package/package.json

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