@websolutespa/bom-core 0.0.1

package/CHANGELOG.md

@@ -0,0 +1,7 @@
+# @websolutespa/bom-core
+
+## 0.0.1
+
+### Patch Changes
+
+- Added: first release.

package/README.md

@@ -0,0 +1,11 @@
+# @websolutespa/bom-core
+
+[![npm version](https://badge.fury.io/js/%40websolutespa%2Fbom-core.svg)](https://badge.fury.io/js/%40websolutespa%2Fbom-core)
+
+[![status alpha](https://img.shields.io/badge/status-alpha-red.svg)](https://shields.io/)
+
+Core module of the [BOM Repository](https://github.com/websolutespa/bom) by [websolute](https://www.websolute.com/).
+
+---
+
+##### *this library is for internal usage and not production ready*

package/dist/index.d.ts

@@ -0,0 +1,474 @@
+import { IncomingMessage, ServerResponse } from 'http';
+import { ParsedUrlQuery } from 'querystring';
+
+type ILocalizedString = {
+    [key: string]: string;
+};
+
+type IEquatable = number | string;
+type SchemaType = string;
+type IOption = Record<string, any> & {
+    id: IEquatable;
+    name: string;
+};
+type ISchema = {
+    id: IEquatable;
+    schema?: string;
+};
+type IEntity = Record<string, unknown> & ISchema;
+type INamedEntity = IEntity & {
+    name: string | ILocalizedString;
+};
+type ITitledEntity = IEntity & {
+    title: string | ILocalizedString;
+};
+
+type IMediaType = 'image' | 'video' | string;
+type IMedia = {
+    src: string;
+    type: IMediaType;
+    alt?: string;
+    title?: string;
+    abstract?: string;
+    width?: number;
+    height?: number;
+    url?: string;
+    media?: IMedia;
+};
+
+type ICategory = IEntity & {
+    category?: IEquatable | ICategory;
+    id: IEquatable;
+    media?: IMedia;
+    order?: number;
+    slug?: ILocalizedString | string;
+    title?: ILocalizedString | string;
+};
+type ICategoryItem = ICategory & {
+    items: ICategory[];
+};
+type ICategorized = {
+    category: IEquatable | ICategory;
+    id: IEquatable;
+    isDefault?: boolean;
+    markets?: string[];
+    media?: IMedia;
+    order?: number;
+    schema?: string;
+    slug?: ILocalizedString | string;
+    template?: string;
+    title?: ILocalizedString | string;
+};
+
+type IClassNameValue = string | boolean | number | null | undefined;
+type IClassNameCollection = Record<string, IClassNameValue>;
+type IClassName = IClassNameCollection | IClassNameValue;
+
+type FetchRequestOptions = {
+    method?: string;
+    headers?: {
+        [key: string]: string;
+    };
+    body?: Blob | BufferSource | FormData | URLSearchParams | string | ReadableStream;
+    mode?: 'cors' | 'no-cors' | 'same-origin';
+    credentials?: 'omit' | 'same-origin' | 'include';
+    cache?: 'default' | 'no-store' | 'reload' | 'no-cache' | 'force-cache' | 'only-if-cached';
+    redirect?: 'follow' | 'error' | 'manual';
+    referrer?: string;
+    referrerPolicy?: 'no-referrer, no-referrer-when-downgrade, same-origin, origin, strict-origin, origin-when-cross-origin, strict-origin-when-cross-origin, or unsafe-url';
+    integrity?: string;
+    keepalive?: boolean;
+    signal?: AbortSignal;
+};
+type FetchService<T = any> = (url: string, options?: FetchRequestOptions, serviceOptions?: any) => Promise<T>;
+
+type ILabel = IEntity & {
+    id: IEquatable;
+    text?: string | ILocalizedString;
+};
+
+type ILocale = IEntity & {
+    id: string;
+    title?: string;
+    isActive?: boolean;
+    isDefault?: boolean;
+};
+
+type IMarket = IEntity & {
+    id: string;
+    title?: string;
+    isActive?: boolean;
+    isDefault?: boolean;
+    countries?: string[];
+    languages?: string[];
+    defaultLanguage?: string;
+};
+
+type IMeta = {
+    title?: string;
+    description?: string;
+    keywords?: string;
+    robots?: string;
+};
+
+type IRoute = {
+    id: string;
+    market: string;
+    locale: string;
+    category: IEquatable | ICategory;
+    page: IEquatable;
+    schema: string;
+    template?: string;
+    title: string;
+    isDefault?: boolean;
+    order?: number;
+};
+type IRouteLink = {
+    href: string;
+    id: IEquatable;
+    items?: IRouteLink[];
+    media?: IMedia;
+    title: string;
+};
+type IRouteParams = Record<string, any> & {
+    id: IEquatable;
+    locale: string;
+    market: string;
+};
+
+type IPage = Record<string, any> & ICategorized & {
+    slug?: string;
+    href: string;
+    alternates: IRoute[];
+    breadcrumb: IRouteLink[];
+    parentRoute?: IRouteLink;
+    title?: string;
+    abstract?: string;
+    description?: string;
+    content?: string;
+    createdAt?: Date;
+    updatedAt?: Date;
+    meta?: IMeta;
+};
+type IPageRelation = {
+    relationTo: string;
+    value: ICategorized;
+};
+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 = {
+    id: IEquatable;
+    abstract?: string;
+    media?: IMedia;
+    items?: IMenuItem[];
+};
+type IMenuCategory = IMenuBase & {
+    type: 'category';
+    title: string | ILocalizedString;
+    href: string;
+    category: IEquatable;
+};
+type IMenuGroup = IMenuBase & {
+    type: 'group';
+    title: string | ILocalizedString;
+};
+type IMenuLink = IMenuBase & {
+    type: 'link';
+    title: string | ILocalizedString;
+    href: string;
+    target: string;
+};
+type IMenuRoute = IMenuBase & {
+    type: 'route';
+    title: string | ILocalizedString;
+    href: string;
+    page: IEquatable;
+    schema: string;
+};
+type IMenuPage = IMenuBase & {
+    type: 'page';
+    title: string | ILocalizedString;
+    href: string;
+    page: IEquatable;
+    schema: string;
+};
+type IMenuCustom = Record<string, unknown> & {
+    id: IEquatable;
+    type: string;
+};
+type IMenuItem = IMenuCategory | IMenuGroup | IMenuLink | IMenuPage | IMenuRoute;
+type IMenu = {
+    id: string;
+    items: IMenuItem[];
+};
+/**
+ * this is the original menu model from cms
+ */
+type IUndecoratedMenuBase = {
+    abstract?: ILocalizedString | string;
+    id?: string;
+    items: IUndecoratedMenuItem[];
+    markets?: string[];
+    media?: IMedia;
+    type: string;
+};
+type IUndecoratedMenuCategory = Omit<IUndecoratedMenuBase, 'type'> & {
+    type: 'category';
+    category: string;
+    maxDepth?: number;
+    title?: ILocalizedString | string;
+};
+type IUndecoratedMenuGroup = Omit<IUndecoratedMenuBase, 'type'> & {
+    type: 'group';
+    title: ILocalizedString | string;
+};
+type IUndecoratedMenuLink = Omit<IUndecoratedMenuBase, 'type'> & {
+    type: 'link';
+    title: ILocalizedString | string;
+    href: string;
+    target?: string;
+};
+type IUndecoratedMenuPage = Omit<IUndecoratedMenuBase, 'type'> & {
+    type: 'page';
+    page: IPageRelation;
+    title?: ILocalizedString | string;
+};
+type IUndecoratedMenuCustom = Record<string, unknown> & {
+    id: IEquatable;
+    type: 'custom';
+    blockType: string;
+};
+type IUndecoratedMenuItem = IUndecoratedMenuCategory | IUndecoratedMenuGroup | IUndecoratedMenuLink | IUndecoratedMenuPage | IUndecoratedMenuCustom;
+type IUndecoratedMenu = {
+    id: string;
+    items: IUndecoratedMenuItem[];
+};
+
+type ILayout = {
+    labels: ILabel[];
+    locale: string;
+    locales: ILocale[];
+    market: string;
+    markets: IMarket[];
+    menu: Record<string, IMenu>;
+    topLevelHrefs: Record<string, string>;
+    topLevelRoutes: Record<string, IRouteLink>;
+    tree?: IRouteLink;
+};
+
+type Pagination = {
+    hasNextPage: boolean;
+    hasPrevPage: boolean;
+    limit: number;
+    nextPage: number | null;
+    page: number;
+    pagingCounter: number;
+    prevPage: number | null;
+    totalDocs: number;
+    totalPages: number;
+};
+
+type Operator = 'equals' | 'contains' | 'not_equals' | 'in' | 'not_in' | 'exists' | 'greater_than' | 'greater_than_equal' | 'less_than' | 'less_than_equal' | 'like' | 'near';
+type WhereField = {
+    [key in Operator]?: unknown;
+};
+type WhereBase = {
+    [key: string]: WhereField | Where[];
+};
+type WhereAndOr = {
+    or?: Where[];
+    and?: Where[];
+};
+type Where = WhereBase & WhereAndOr;
+type QueryParams = {
+    where?: Where;
+    locale?: string;
+    market?: string;
+    sort?: string;
+    page?: number;
+    limit?: number;
+    depth?: number;
+    draft?: boolean;
+    pagination?: boolean;
+    richText?: boolean;
+};
+
+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>;
+    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>;
+};
+type FindParams = {
+    where?: {
+        [key: string]: unknown;
+    };
+    market?: string;
+    locale?: string;
+};
+type FindWhereParams = {
+    where: {
+        [key: string]: unknown;
+    };
+    market?: string;
+    locale?: string;
+};
+declare function toFindParams(idOrParams: IEquatable | FindWhereParams): FindWhereParams;
+
+type IMemoryStore = Record<string, IEntity[]>;
+type IStore = Record<string, IQuerable<IEntity>>;
+type IConfig = {
+    collections: string[];
+    mocks: string[];
+    pages: string[];
+};
+type IPackages = {
+    icons: string;
+    models: string;
+    ui: string;
+};
+type ICollectionDescription = {
+    singularName: string;
+    pluralName: string;
+    pluralDisplayName: string;
+    displayName: string;
+    title: string;
+};
+type ISerializedCollection = {
+    singularName: string;
+    pluralName: string;
+    pluralDisplayName: string;
+    displayName: string;
+    items: IEntity[];
+};
+type ISerializedStore = Record<string, ISerializedCollection>;
+
+type ITemplate = {
+    id: IEquatable;
+    name: ILocalizedString | string;
+    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;
+declare function isValidCollectionDescription(description: ICollectionDescription): boolean;
+declare function toValidCollectionName(text: string): string;
+declare function camelToSnakeCase(text: string): string;
+declare function toDisplayName(text: string): string;
+declare function toPluralName(text: string): string;
+declare function toTitleCase(text: string): string;
+
+declare function consoleWarn(message: string, component?: string): void;
+
+declare function httpFetch(url: string, options?: FetchRequestOptions, serviceOptions?: any): Promise<any>;
+declare function httpGet(url: string, options?: FetchRequestOptions): Promise<any>;
+declare function httpPost(url: string, payload: any, options?: FetchRequestOptions): Promise<any>;
+declare function httpPut(url: string, payload: any, options?: FetchRequestOptions): Promise<any>;
+declare function httpPatch(url: string, payload: any, options?: FetchRequestOptions): Promise<any>;
+declare function httpDelete(url: string, options?: FetchRequestOptions): Promise<any>;
+
+declare class JsonService<T extends IEntity = IEntity> implements IQuerable<T> {
+    items: T[];
+    constructor(items: 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>;
+    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>;
+    protected decorator_<B extends T = T>(item: B, params?: QueryParams): B;
+    protected newUUID_(): number;
+    protected evaluateValue_(value: unknown): unknown;
+    protected existsClause_(value: unknown, exists?: boolean): boolean;
+    protected equalsClause_(value: unknown, equals?: unknown): boolean;
+    protected inClause_(value: unknown, values?: unknown[]): boolean;
+    protected notInClause_(value: unknown, values?: unknown[]): boolean;
+    protected likeClause_(value: unknown, query?: string): boolean;
+    protected whereItem_<B extends T = T>(item: B, where?: Where): boolean;
+    protected whereItems_<B extends T = T>(items: B[], where?: Where): B[];
+    protected sortCollection_<B extends T = T>(items: B[], sort?: string): B[];
+    protected paginatedItems_<B extends T = T>(items: B[], page?: number, limit?: number): ({
+        docs: B[];
+    } & Pagination);
+}
+
+declare function isLocalizedString(value: any): value is ILocalizedString;
+declare function localizedToString(json: ILocalizedString, locale?: string, defaultLocale?: string): string;
+declare function localizeValue(value: any, locale?: string, defaultLocale?: string): any;
+declare function localizeItem(item: any, locale?: string, defaultLocale?: string): any;
+
+declare function qsSerialize(queryParams?: QueryParams): string;
+declare function asEquatable(value: string): IEquatable;
+declare function deserializeValue(value: string): string | boolean | number;
+declare function deserializeKey(value: string): string | number;
+declare function qsDeserialize(query?: string, deserializedParams?: {}): QueryParams;
+
+declare function titleToSlug(title: string): string;
+
+declare function getIsDevelopment(): boolean;
+declare const isDevelopment: boolean;
+declare const isBrowser: boolean;
+declare function withSchema<Component extends {}, 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;
+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 };