@websolutespa/bom-core 0.6.1 → 0.6.3

package/CHANGELOG.md

@@ -1,76 +1,88 @@
-# @websolutespa/bom-core
-
-## 0.6.1
-
-### Patch Changes
-
-- dad63747: 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.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

@@ -84,16 +84,18 @@ type ITitledEntity = IEntity & {
 
 type IMediaType = 'image' | 'video' | string;
 type IMedia = {
-    src: string;
-    type: IMediaType;
-    alt?: string;
-    title?: string;
     abstract?: string;
-    width?: number;
+    alt?: string;
     height?: number;
-    url?: string;
     media?: IMedia;
+    mimeType?: string;
+    src: string;
+    title?: string;
+    type: IMediaType;
+    url?: string;
+    width?: number;
 };
+declare function resolveMediaType(media: IMedia): IMediaType;
 
 type ICategory = IEntity & {
     category?: IEquatable | ICategory;
@@ -477,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;
@@ -623,4 +626,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, 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, 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, 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,6 +75,7 @@ __export(src_exports, {
   isObject: () => isObject,
   isProduction: () => isProduction,
   isRelation: () => isRelation,
+  isReservedCollectionDescription: () => isReservedCollectionDescription,
   isStage: () => isStage,
   isUndecoratedMenuItem: () => isUndecoratedMenuItem,
   isUndecoratedMenuPage: () => isUndecoratedMenuPage,
@@ -94,6 +95,7 @@ __export(src_exports, {
   qsDeserializeRaw: () => qsDeserializeRaw,
   qsSerialize: () => qsSerialize,
   qsSerializeRaw: () => qsSerializeRaw,
+  resolveMediaType: () => resolveMediaType,
   textToSlug: () => textToSlug,
   toCamelCase: () => toCamelCase,
   toCharCase: () => toCharCase,
@@ -241,6 +243,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, "");
 }
@@ -1054,6 +1068,11 @@ function textToSlug(title) {
   return title.toString().normalize("NFD").replace(/[\u0300-\u036f]/g, "").toLowerCase().replace(/\s+/g, "-").replace(/&/g, "-and-").replace(/[^\w-]+/g, "").replace(/--+/g, "-").replace(/^-+/, "").replace(/-+$/, "");
 }
 
+// src/types/media.ts
+function resolveMediaType(media) {
+  return media.type || (media.mimeType ? media.mimeType.split("/")[0] : "image");
+}
+
 // src/types/querable.ts
 function toFindParams(idOrParams) {
   if (typeof idOrParams === "number" || typeof idOrParams === "string") {
@@ -1119,6 +1138,7 @@ var RedirectReason = /* @__PURE__ */ ((RedirectReason2) => {
   isObject,
   isProduction,
   isRelation,
+  isReservedCollectionDescription,
   isStage,
   isUndecoratedMenuItem,
   isUndecoratedMenuPage,
@@ -1138,6 +1158,7 @@ var RedirectReason = /* @__PURE__ */ ((RedirectReason2) => {
   qsDeserializeRaw,
   qsSerialize,
   qsSerializeRaw,
+  resolveMediaType,
   textToSlug,
   toCamelCase,
   toCharCase,

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, "");
 }
@@ -942,6 +954,11 @@ function textToSlug(title) {
   return title.toString().normalize("NFD").replace(/[\u0300-\u036f]/g, "").toLowerCase().replace(/\s+/g, "-").replace(/&/g, "-and-").replace(/[^\w-]+/g, "").replace(/--+/g, "-").replace(/^-+/, "").replace(/-+$/, "");
 }
 
+// src/types/media.ts
+function resolveMediaType(media) {
+  return media.type || (media.mimeType ? media.mimeType.split("/")[0] : "image");
+}
+
 // src/types/querable.ts
 function toFindParams(idOrParams) {
   if (typeof idOrParams === "number" || typeof idOrParams === "string") {
@@ -1006,6 +1023,7 @@ export {
   isObject,
   isProduction,
   isRelation,
+  isReservedCollectionDescription,
   isStage,
   isUndecoratedMenuItem,
   isUndecoratedMenuPage,
@@ -1025,6 +1043,7 @@ export {
   qsDeserializeRaw,
   qsSerialize,
   qsSerializeRaw,
+  resolveMediaType,
   textToSlug,
   toCamelCase,
   toCharCase,

package/package.json

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