@websolutespa/bom-mixer-store 1.4.0 → 1.4.2

package/CHANGELOG.md

@@ -1,98 +1,115 @@
-# @websolutespa/bom-mixer-store
-
-## 1.4.0
-
-### Minor Changes
-
-- Added: BuildStrategy.
-
-## 1.3.0
-
-### Minor Changes
-
-- Added: storeIndexHandler.
-- Modified: Store, StoreHandler, RemoteService, MockService, MockPageService, MockMenuService, StaticService.
-
-## 1.2.2
-
-### Patch Changes
-
-- Modified: MockMenuService IPageRelationResult.
-
-## 1.2.1
-
-### Patch Changes
-
-- Fixing: MockMenuService collectPages.
-
-## 1.2.0
-
-### Minor Changes
-
-- Updating: next 13.
-
-## 1.1.1
-
-### Patch Changes
-
-- Fixing: check redirects by pattern.
-
-## 1.1.0
-
-### Minor Changes
-
-- Modified: store refactor.
-
-## 1.0.1
-
-### Patch Changes
-
-- Fixing: localhost url.
-
-## 1.0.0
-
-### Minor Changes
-
-- Modified routes, added redirects.
-
-## 0.3.2
-
-### Patch Changes
-
-- Modified: MockMenuService.
-
-## 0.3.1
-
-### Patch Changes
-
-- Added: source files.
-
-## 0.3.0
-
-### Minor Changes
-
-- Added: splat routes.
-
-## 0.2.0
-
-### Minor Changes
-
-- Added: @websolutespa/bom-core.
-
-## 0.1.1
-
-### Patch Changes
-
-- Modified: store service.
-
-## 0.1.0
-
-### Minor Changes
-
-- mock refactor.
-
-## 0.0.2
-
-### Patch Changes
-
-- Added: first release.
+# @websolutespa/bom-mixer-store
+
+## 1.4.2
+
+### Patch Changes
+
+- Added: Decorators, CachedService, RemotePageService, RemoteMenuService, StoreStrategy.DecoratedApi, nextPhase, storeCacheDuration.
+- Modified: RemoteStore.
+- Updated dependencies
+  - @websolutespa/bom-core@0.6.4
+
+## 1.4.1
+
+### Patch Changes
+
+- Modified: MockPageService.
+- Updated dependencies
+  - @websolutespa/bom-core@0.6.3
+
+## 1.4.0
+
+### Minor Changes
+
+- Added: BuildStrategy.
+
+## 1.3.0
+
+### Minor Changes
+
+- Added: storeIndexHandler.
+- Modified: Store, StoreHandler, RemoteService, MockService, MockPageService, MockMenuService, StaticService.
+
+## 1.2.2
+
+### Patch Changes
+
+- Modified: MockMenuService IPageRelationResult.
+
+## 1.2.1
+
+### Patch Changes
+
+- Fixing: MockMenuService collectPages.
+
+## 1.2.0
+
+### Minor Changes
+
+- Updating: next 13.
+
+## 1.1.1
+
+### Patch Changes
+
+- Fixing: check redirects by pattern.
+
+## 1.1.0
+
+### Minor Changes
+
+- Modified: store refactor.
+
+## 1.0.1
+
+### Patch Changes
+
+- Fixing: localhost url.
+
+## 1.0.0
+
+### Minor Changes
+
+- Modified routes, added redirects.
+
+## 0.3.2
+
+### Patch Changes
+
+- Modified: MockMenuService.
+
+## 0.3.1
+
+### Patch Changes
+
+- Added: source files.
+
+## 0.3.0
+
+### Minor Changes
+
+- Added: splat routes.
+
+## 0.2.0
+
+### Minor Changes
+
+- Added: @websolutespa/bom-core.
+
+## 0.1.1
+
+### Patch Changes
+
+- Modified: store service.
+
+## 0.1.0
+
+### Minor Changes
+
+- mock refactor.
+
+## 0.0.2
+
+### Patch Changes
+
+- Added: first release.

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { FetchRequestOptions, IEntity, JsonService, IStore, QueryParams, ISchema, IMemoryStore, IQuerable, IEquatable, Pagination } from '@websolutespa/bom-core';
+import { FetchRequestOptions, ISchema, IStore, QueryParams, IUndecoratedMenu, IMenu, IRoute, IEntity, JsonService, IMemoryStore, IQuerable, IEquatable, IPagedResult } from '@websolutespa/bom-core';
 import { NextApiRequest, NextApiResponse } from 'next';
 import { NextRequest } from 'next/server';
 
@@ -14,6 +14,33 @@ declare function errorHandler(error: any, response: NextApiResponse): Promise<an
 
 declare function fromCache<T = unknown>(callback: () => Promise<T>, key?: string): Promise<T>;
 
+declare function decorateHref_<T extends ISchema = ISchema>(store: IStore, item: T, params?: QueryParams): Promise<T | T & {
+    href: string | null;
+}>;
+declare function decorateHrefs_<T extends ISchema = ISchema>(store: IStore, items: T[], params?: QueryParams): Promise<T[] | (T & {
+    href: string | null;
+})[]>;
+
+declare function localizeItem_<B>(item: B, params?: QueryParams): Promise<B>;
+declare function localizeItems_<B>(items: B[], params?: QueryParams): Promise<B[]>;
+
+declare function decorateMenu_(store: IStore, item: IUndecoratedMenu, params: {
+    market: string;
+    locale: string;
+}): Promise<IMenu>;
+declare function decorateMenus_(store: IStore, items: IUndecoratedMenu[], params: {
+    market: string;
+    locale: string;
+}): Promise<IMenu[]>;
+declare const MAX_INT = 1000000000000;
+
+declare function decorateNav_<T extends ISchema = ISchema>(store: IStore, item: T, params?: QueryParams, routes?: IRoute[]): Promise<T>;
+declare function decorateNavs_<T extends ISchema = ISchema>(store: IStore, items: T[], params?: QueryParams): Promise<T[]>;
+
+declare const SERVICE_DEFAULT_DEPTH = 2;
+declare function decorateRelation_<T extends ISchema = ISchema>(store: IStore, item: T, params?: QueryParams): Promise<T>;
+declare function decorateRelations_<T extends ISchema = ISchema>(store: IStore, items: T[], params?: QueryParams): Promise<T[]>;
+
 declare function getLocalApiUrl(pathname: string): string;
 declare function localApiFetch<T = unknown>(pathname: string, options?: ApiRequestOptions, serviceOptions?: {
     locale: string;
@@ -44,6 +71,23 @@ declare function isStaticRequest(request: NextRequest): boolean;
 declare function isNextRequest(request: NextRequest): boolean;
 declare function isApiRequest(request: NextRequest): boolean;
 
+declare class MockService<T extends IEntity = IEntity> extends JsonService<T> {
+    store: IStore;
+    constructor(items: T[], store: IStore);
+    protected decorateOne_<B extends T = T>(item: B, params?: QueryParams): Promise<B>;
+    protected decorateMany_<B extends T = T>(items: B[], params?: QueryParams): Promise<B[]>;
+}
+
+declare class MockMenuService<T extends IEntity = IEntity> extends MockService<T> {
+    protected decorateOne_<B extends T = T>(item: B, params?: QueryParams): Promise<B>;
+    protected decorateMany_<B extends T = T>(items: B[], params?: QueryParams): Promise<B[]>;
+}
+
+declare class MockPageService<T extends IEntity = IEntity> extends MockService<T> {
+    protected decorateOne_<B extends T = T>(item: B, params?: QueryParams): Promise<B>;
+    protected decorateMany_<B extends T = T>(items: B[], params?: QueryParams): Promise<B[]>;
+}
+
 declare function mockApiFetch<T = unknown>(pathname: string, options?: ApiRequestOptions): Promise<T>;
 declare function mockApiGet<T = unknown>(url: string, options?: ApiRequestOptions): Promise<T>;
 declare function mockApiPost<T = unknown>(url: string, payload: unknown, options?: ApiRequestOptions): Promise<T>;
@@ -53,39 +97,19 @@ declare function mockApiDelete<T = unknown>(url: string, options?: ApiRequestOpt
 
 declare function mockHandler(): any;
 
-declare const MOCK_SERVICE_DEFAULT_DEPTH = 2;
-declare class MockService<T extends IEntity = IEntity> extends JsonService<T> {
-    store: IStore;
-    constructor(items: T[], store: IStore);
-    protected decorateOne_<B extends T = T>(item: B, params?: QueryParams): Promise<B>;
-    protected decorateMany_<B extends T = T>(items: B[], params?: QueryParams): Promise<B[]>;
-}
-declare function localizeItem_<B>(item: B, params?: QueryParams): Promise<B>;
-declare function localizeItems_<B>(items: B[], params?: QueryParams): Promise<B[]>;
-declare function decorateRelation_<T extends ISchema = ISchema>(store: IStore, item: T, params?: QueryParams): Promise<T>;
-declare function decorateRelations_<T extends ISchema = ISchema>(store: IStore, items: T[], params?: QueryParams): Promise<T[]>;
-
 declare function getMockStoreFromData_<T extends IStore>(data?: IMemoryStore): T;
 declare function getMockStore<T extends IStore = IStore>(): Promise<T>;
 
-declare function remoteApiFetch<T = unknown>(pathname: string, options?: ApiRequestOptions): Promise<T>;
-declare function remoteApiGet<T = unknown>(url: string, options?: ApiRequestOptions): Promise<T>;
-declare function remoteApiPost<T = unknown>(url: string, payload: unknown, options?: ApiRequestOptions): Promise<T>;
-declare function remoteApiPut<T = unknown>(url: string, payload: unknown, options?: ApiRequestOptions): Promise<T>;
-declare function remoteApiPatch<T = unknown>(url: string, payload: unknown, options?: ApiRequestOptions): Promise<T>;
-declare function remoteApiDelete<T = unknown>(url: string, options?: ApiRequestOptions): Promise<T>;
-
 /**
  * This service handle call to remote api (bowl or over)
  */
 declare class RemoteService<T extends IEntity = IEntity> implements IQuerable<T> {
     key: string;
-    constructor(key: string);
+    store: IStore;
+    constructor(key: string, store: IStore);
     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>;
@@ -93,6 +117,23 @@ declare class RemoteService<T extends IEntity = IEntity> implements IQuerable<T>
     protected decorateMany_<B extends T = T>(items: B[], params?: QueryParams): Promise<B[]>;
 }
 
+declare class RemoteMenuService<T extends IEntity = IEntity> extends RemoteService<T> {
+    protected decorateOne_<B extends T = T>(item: B, params?: QueryParams): Promise<B>;
+    protected decorateMany_<B extends T = T>(items: B[], params?: QueryParams): Promise<B[]>;
+}
+
+declare class RemotePageService<T extends IEntity = IEntity> extends RemoteService<T> {
+    protected decorateOne_<B extends T = T>(item: B, params?: QueryParams): Promise<B>;
+    protected decorateMany_<B extends T = T>(items: B[], params?: QueryParams): Promise<B[]>;
+}
+
+declare function remoteApiFetch<T = unknown>(pathname: string, options?: ApiRequestOptions): Promise<T>;
+declare function remoteApiGet<T = unknown>(url: string, options?: ApiRequestOptions): Promise<T>;
+declare function remoteApiPost<T = unknown>(url: string, payload: unknown, options?: ApiRequestOptions): Promise<T>;
+declare function remoteApiPut<T = unknown>(url: string, payload: unknown, options?: ApiRequestOptions): Promise<T>;
+declare function remoteApiPatch<T = unknown>(url: string, payload: unknown, options?: ApiRequestOptions): Promise<T>;
+declare function remoteApiDelete<T = unknown>(url: string, options?: ApiRequestOptions): Promise<T>;
+
 declare function getRemoteStore<T extends IStore>(): Promise<T>;
 
 type IField = {
@@ -126,6 +167,14 @@ declare class StaticService<T extends IEntity = IEntity> extends JsonService<T>
 declare function decorateStaticRelation_<T>(store: IStore, fields: IField[], item: T, params?: QueryParams): Promise<T>;
 declare function decorateStaticRelations_<T>(store: IStore, fields: IField[], items: T[], params?: QueryParams): Promise<T[]>;
 
+declare enum NextPhase {
+    Export = "phase-export",
+    ProductionBuild = "phase-production-build",
+    ProductionServer = "phase-production-server",
+    DevelopmentServer = "phase-development-server",
+    Test = "phase-test"
+}
+declare const nextPhase: NextPhase;
 declare enum BuildStrategy {
     Static = "static",
     Runtime = "runtime"
@@ -133,10 +182,12 @@ declare enum BuildStrategy {
 declare const buildStrategy: BuildStrategy;
 declare enum StoreStrategy {
     Api = "api",
+    DecoratedApi = "decoratedApi",
     Data = "data",
     Mock = "mock"
 }
 declare const storeStrategy: StoreStrategy;
+declare const storeCacheDuration: number;
 declare const MOCK_COLLECTIONS: string[];
 declare const STATIC_COLLECTIONS: string[];
 declare const KNOWN_COLLECTIONS: string[];
@@ -158,4 +209,4 @@ declare function storeIndexHandler(): any;
 
 declare function getStore<T extends IStore>(): Promise<T>;
 
-export { ApiRequestOptions, BuildStrategy, COLLECTIONS, IApiHandler, ICrudMethod, IField, IHandler, KNOWN_COLLECTIONS, MOCK_COLLECTIONS, MOCK_SERVICE_DEFAULT_DEPTH, MapTo, MockService, RemoteService, STATIC_COLLECTIONS, StaticService, StaticServiceConfig, StaticServiceSrc, StoreStrategy, apiHandler, buildStrategy, collectionDelete, collectionGet, collectionPatch, collectionPost, decorateRelation_, decorateRelations_, decorateStaticRelation_, decorateStaticRelations_, defaultApiRequestOptions, errorHandler, fromCache, getDefaultApiRequestOptions, getLocalApiUrl, getMockStore, getMockStoreFromData_, getRemoteStore, getStore, isApiRequest, isNextRequest, isStaticRequest, localApiDelete, localApiFetch, localApiGet, localApiPatch, localApiPost, localApiPut, localizeItem_, localizeItems_, mockApiDelete, mockApiFetch, mockApiGet, mockApiPatch, mockApiPost, mockApiPut, mockHandler, remoteApiDelete, remoteApiFetch, remoteApiGet, remoteApiPatch, remoteApiPost, remoteApiPut, routePost, staticCollections, storeApiDelete, storeApiGet, storeApiPatch, storeApiPost, storeApiPut, storeHandler, storeIndexHandler, storeStrategy };
+export { ApiRequestOptions, BuildStrategy, COLLECTIONS, IApiHandler, ICrudMethod, IField, IHandler, KNOWN_COLLECTIONS, MAX_INT, MOCK_COLLECTIONS, MapTo, MockMenuService, MockPageService, MockService, NextPhase, RemoteMenuService, RemotePageService, RemoteService, SERVICE_DEFAULT_DEPTH, STATIC_COLLECTIONS, StaticService, StaticServiceConfig, StaticServiceSrc, StoreStrategy, apiHandler, buildStrategy, collectionDelete, collectionGet, collectionPatch, collectionPost, decorateHref_, decorateHrefs_, decorateMenu_, decorateMenus_, decorateNav_, decorateNavs_, decorateRelation_, decorateRelations_, decorateStaticRelation_, decorateStaticRelations_, defaultApiRequestOptions, errorHandler, fromCache, getDefaultApiRequestOptions, getLocalApiUrl, getMockStore, getMockStoreFromData_, getRemoteStore, getStore, isApiRequest, isNextRequest, isStaticRequest, localApiDelete, localApiFetch, localApiGet, localApiPatch, localApiPost, localApiPut, localizeItem_, localizeItems_, mockApiDelete, mockApiFetch, mockApiGet, mockApiPatch, mockApiPost, mockApiPut, mockHandler, nextPhase, remoteApiDelete, remoteApiFetch, remoteApiGet, remoteApiPatch, remoteApiPost, remoteApiPut, routePost, staticCollections, storeApiDelete, storeApiGet, storeApiPatch, storeApiPost, storeApiPut, storeCacheDuration, storeHandler, storeIndexHandler, storeStrategy };