@websolutespa/bom-core 0.0.1 → 0.1.1

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @websolutespa/bom-core
 
+## 0.1.1
+
+### Patch Changes
+
+- Modified: ILocalizable.
+
+## 0.1.0
+
+### Minor Changes
+
+- Added: splat routes.
+- Added: variants.
+
 ## 0.0.1
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,10 +1,64 @@
 import { IncomingMessage, ServerResponse } from 'http';
 import { ParsedUrlQuery } from 'querystring';
 
-type ILocalizedString = {
+type Json = string | number | boolean | null | Json[] | {
+    [key: string]: Json;
+};
+type ValueOf<T> = T[keyof T];
+type LiteralUnion<T extends string | number> = T | Omit<T, T>;
+type PreviewData = string | false | object | undefined;
+type IContextBaseParams = {
+    market: string;
+    locale: string;
+};
+type IContextParams = IContextBaseParams & {
+    id: string;
+};
+type StaticPropsContext<Q extends ParsedUrlQuery = ParsedUrlQuery, D extends PreviewData = PreviewData> = {
+    params: Q;
+    preview?: boolean;
+    previewData?: D;
+    locale?: string;
+    locales?: string[];
+    defaultLocale?: string;
+};
+type IStaticContext<T extends {} = {}> = StaticPropsContext<IContextParams & T>;
+declare type NextApiRequestCookies = Partial<{
     [key: string]: string;
+}>;
+type ServerSidePropsContext<Q extends ParsedUrlQuery = ParsedUrlQuery, D extends PreviewData = PreviewData> = {
+    req: IncomingMessage & {
+        cookies: NextApiRequestCookies;
+    };
+    res: ServerResponse;
+    params: Q;
+    query: ParsedUrlQuery;
+    preview?: boolean;
+    previewData?: D;
+    resolvedUrl: string;
+    locale?: string;
+    locales?: string[];
+    defaultLocale?: string;
+};
+type IServerSideSplatContext<T extends {} = {}> = ServerSidePropsContext<IContextBaseParams & T>;
+type IServerSideContext<T extends {} = {}> = ServerSidePropsContext<IContextParams & T>;
+type StateValue = StateValue[] | {
+    [key: string]: StateValue;
+} | number | string | boolean | null | undefined;
+type IPartial<T> = {
+    [P in keyof T]?: Partial<T[P]>;
+};
+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 ILocalizedString = Record<string, string>;
+type ILocalizable = string | ILocalizedString;
+type ILocalized<T> = IOverride<T, ILocalizable, string>;
+
 type IEquatable = number | string;
 type SchemaType = string;
 type IOption = Record<string, any> & {
@@ -17,10 +71,10 @@ type ISchema = {
 };
 type IEntity = Record<string, unknown> & ISchema;
 type INamedEntity = IEntity & {
-    name: string | ILocalizedString;
+    name: ILocalizable;
 };
 type ITitledEntity = IEntity & {
-    title: string | ILocalizedString;
+    title: ILocalizable;
 };
 
 type IMediaType = 'image' | 'video' | string;
@@ -41,8 +95,8 @@ type ICategory = IEntity & {
     id: IEquatable;
     media?: IMedia;
     order?: number;
-    slug?: ILocalizedString | string;
-    title?: ILocalizedString | string;
+    slug?: ILocalizable;
+    title?: ILocalizable;
 };
 type ICategoryItem = ICategory & {
     items: ICategory[];
@@ -55,9 +109,10 @@ type ICategorized = {
     media?: IMedia;
     order?: number;
     schema?: string;
-    slug?: ILocalizedString | string;
+    slug?: ILocalizable;
     template?: string;
-    title?: ILocalizedString | string;
+    title?: ILocalizable;
+    useSplat?: boolean;
 };
 
 type IClassNameValue = string | boolean | number | null | undefined;
@@ -84,7 +139,7 @@ type FetchService<T = any> = (url: string, options?: FetchRequestOptions, servic
 
 type ILabel = IEntity & {
     id: IEquatable;
-    text?: string | ILocalizedString;
+    text?: ILocalizable;
 };
 
 type ILocale = IEntity & {
@@ -112,16 +167,17 @@ type IMeta = {
 };
 
 type IRoute = {
+    category: IEquatable | ICategory;
     id: string;
-    market: string;
+    isDefault?: boolean;
     locale: string;
-    category: IEquatable | ICategory;
+    market: string;
+    order?: number;
     page: IEquatable;
     schema: string;
     template?: string;
     title: string;
-    isDefault?: boolean;
-    order?: number;
+    useSplat?: boolean;
 };
 type IRouteLink = {
     href: string;
@@ -172,30 +228,30 @@ type IMenuBase = {
 };
 type IMenuCategory = IMenuBase & {
     type: 'category';
-    title: string | ILocalizedString;
+    title: ILocalizable;
     href: string;
     category: IEquatable;
 };
 type IMenuGroup = IMenuBase & {
     type: 'group';
-    title: string | ILocalizedString;
+    title: ILocalizable;
 };
 type IMenuLink = IMenuBase & {
     type: 'link';
-    title: string | ILocalizedString;
+    title: ILocalizable;
     href: string;
     target: string;
 };
 type IMenuRoute = IMenuBase & {
     type: 'route';
-    title: string | ILocalizedString;
+    title: ILocalizable;
     href: string;
     page: IEquatable;
     schema: string;
 };
 type IMenuPage = IMenuBase & {
     type: 'page';
-    title: string | ILocalizedString;
+    title: ILocalizable;
     href: string;
     page: IEquatable;
     schema: string;
@@ -213,7 +269,7 @@ type IMenu = {
  * this is the original menu model from cms
  */
 type IUndecoratedMenuBase = {
-    abstract?: ILocalizedString | string;
+    abstract?: ILocalizable;
     id?: string;
     items: IUndecoratedMenuItem[];
     markets?: string[];
@@ -224,22 +280,22 @@ type IUndecoratedMenuCategory = Omit<IUndecoratedMenuBase, 'type'> & {
     type: 'category';
     category: string;
     maxDepth?: number;
-    title?: ILocalizedString | string;
+    title?: ILocalizable;
 };
 type IUndecoratedMenuGroup = Omit<IUndecoratedMenuBase, 'type'> & {
     type: 'group';
-    title: ILocalizedString | string;
+    title: ILocalizable;
 };
 type IUndecoratedMenuLink = Omit<IUndecoratedMenuBase, 'type'> & {
     type: 'link';
-    title: ILocalizedString | string;
+    title: ILocalizable;
     href: string;
     target?: string;
 };
 type IUndecoratedMenuPage = Omit<IUndecoratedMenuBase, 'type'> & {
     type: 'page';
     page: IPageRelation;
-    title?: ILocalizedString | string;
+    title?: ILocalizable;
 };
 type IUndecoratedMenuCustom = Record<string, unknown> & {
     id: IEquatable;
@@ -357,51 +413,10 @@ type ISerializedStore = Record<string, ISerializedCollection>;
 
 type ITemplate = {
     id: IEquatable;
-    name: ILocalizedString | string;
+    name: ILocalizable;
     collections: string[];
 };
 
-type Json = string | number | boolean | null | Json[] | {
-    [key: string]: Json;
-};
-type ValueOf<T> = T[keyof T];
-type PreviewData = string | false | object | undefined;
-type IContextParams = {
-    id: string;
-    market: string;
-    locale: string;
-};
-type StaticPropsContext<Q extends ParsedUrlQuery = ParsedUrlQuery, D extends PreviewData = PreviewData> = {
-    params: Q;
-    preview?: boolean;
-    previewData?: D;
-    locale?: string;
-    locales?: string[];
-    defaultLocale?: string;
-};
-type IStaticContext = StaticPropsContext<IContextParams>;
-declare type NextApiRequestCookies = Partial<{
-    [key: string]: string;
-}>;
-type ServerSidePropsContext<Q extends ParsedUrlQuery = ParsedUrlQuery, D extends PreviewData = PreviewData> = {
-    req: IncomingMessage & {
-        cookies: NextApiRequestCookies;
-    };
-    res: ServerResponse;
-    params: Q;
-    query: ParsedUrlQuery;
-    preview?: boolean;
-    previewData?: D;
-    resolvedUrl: string;
-    locale?: string;
-    locales?: string[];
-    defaultLocale?: string;
-};
-type IServerSideContext = ServerSidePropsContext<IContextParams>;
-type StateValue = StateValue[] | {
-    [key: string]: StateValue;
-} | number | string | boolean | null | undefined;
-
 declare function getClassNames(...props: Array<IClassName>): string;
 
 declare function getCollectionDescription(text: string): ICollectionDescription;
@@ -471,4 +486,4 @@ declare function awaitAll(array: any, callback: (item: any, index: number) => Pr
 declare function merge(target: any, source: any): any;
 declare function deepCopy<T>(source: T): T;
 
-export { FetchRequestOptions, FetchService, FindParams, FindWhereParams, ICategorized, ICategory, ICategoryItem, IClassName, IClassNameCollection, IClassNameValue, ICollectionDescription, IConfig, IContextParams, IEntity, IEquatable, ILabel, ILayout, ILocale, ILocalizedString, IMarket, IMedia, IMediaType, IMemoryStore, IMenu, IMenuBase, IMenuCategory, IMenuCustom, IMenuGroup, IMenuItem, IMenuLink, IMenuPage, IMenuRoute, INamedEntity, IOption, IPackages, IPage, IPageRelation, IPageResult, IQuerable, IRoute, IRouteLink, IRouteParams, ISchema, ISerializedCollection, ISerializedStore, IServerSideContext, IStaticContext, IStore, ITemplate, ITitledEntity, IUndecoratedMenu, IUndecoratedMenuBase, IUndecoratedMenuCategory, IUndecoratedMenuCustom, IUndecoratedMenuGroup, IUndecoratedMenuItem, IUndecoratedMenuLink, IUndecoratedMenuPage, Json, JsonService, NextApiRequestCookies, Operator, PageProps, Pagination, PreviewData, QueryParams, SchemaType, ServerSidePropsContext, StateValue, StaticPropsContext, ValueOf, Where, WhereAndOr, WhereBase, WhereField, asEquatable, asServerProps, awaitAll, camelToSnakeCase, consoleWarn, deepCopy, deserializeKey, deserializeValue, getClassNames, getCollectionDescription, getIsDevelopment, httpDelete, httpFetch, httpGet, httpPatch, httpPost, httpPut, isBrowser, isDevelopment, isLocalizedString, isValidCollectionDescription, localizeItem, localizeValue, localizedToString, merge, qsDeserialize, qsSerialize, titleToSlug, toDisplayName, toFindParams, toPluralName, toTitleCase, toValidCollectionName, withSchema };
+export { FetchRequestOptions, FetchService, FindParams, FindWhereParams, ICategorized, ICategory, ICategoryItem, IClassName, IClassNameCollection, IClassNameValue, ICollectionDescription, IConfig, IContextBaseParams, IContextParams, 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, IPageResult, IPartial, IPrettify, IQuerable, IRoute, IRouteLink, IRouteParams, ISchema, ISerializedCollection, ISerializedStore, IServerSideContext, IServerSideSplatContext, IStaticContext, IStore, ITemplate, ITitledEntity, IUndecoratedMenu, IUndecoratedMenuBase, IUndecoratedMenuCategory, IUndecoratedMenuCustom, IUndecoratedMenuGroup, IUndecoratedMenuItem, IUndecoratedMenuLink, IUndecoratedMenuPage, Json, JsonService, LiteralUnion, NextApiRequestCookies, Operator, PageProps, Pagination, PreviewData, QueryParams, SchemaType, ServerSidePropsContext, StateValue, StaticPropsContext, ValueOf, Where, WhereAndOr, WhereBase, WhereField, asEquatable, asServerProps, awaitAll, camelToSnakeCase, consoleWarn, deepCopy, deserializeKey, deserializeValue, getClassNames, getCollectionDescription, getIsDevelopment, httpDelete, httpFetch, httpGet, httpPatch, httpPost, httpPut, isBrowser, isDevelopment, isLocalizedString, isValidCollectionDescription, localizeItem, localizeValue, localizedToString, merge, qsDeserialize, qsSerialize, titleToSlug, toDisplayName, toFindParams, toPluralName, toTitleCase, toValidCollectionName, withSchema };

package/package.json

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