@websolutespa/bom-mixer-store 1.0.0 → 1.1.0

package/CHANGELOG.md

@@ -1,49 +1,61 @@
-# @websolutespa/bom-mixer-store
-
-## 0.4.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.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,35 +1,41 @@
+import { FetchRequestOptions, IEntity, JsonService, IStore, QueryParams, IPageRelation, IQuerable, IEquatable, Pagination } from '@websolutespa/bom-core';
 import { NextApiRequest, NextApiResponse } from 'next';
-import { FetchRequestOptions, IEntity, JsonService, IStore, QueryParams, IPageRelation, IMemoryStore, IEquatable, IQuerable, Pagination } from '@websolutespa/bom-core';
 import { NextRequest } from 'next/server';
 
+type ApiRequestOptions = FetchRequestOptions;
+declare const defaultApiRequestOptions: ApiRequestOptions;
+declare function getDefaultApiRequestOptions(): ApiRequestOptions;
+
 type ICrudMethod = 'get' | 'post' | 'put' | 'patch' | 'delete' | string;
 type IHandler = (request: NextApiRequest, response: NextApiResponse) => Promise<any>;
 type IApiHandler = Record<ICrudMethod, IHandler>;
 declare function apiHandler(handler: IApiHandler): any;
 declare function errorHandler(error: any, response: NextApiResponse): Promise<any> | void;
 
-declare function getApiUrl(pathname: string): string;
-declare function apiFetch<T = any>(pathname: string, options?: FetchRequestOptions, serviceOptions?: {
+declare function fromCache<T = unknown>(callback: () => Promise<T>, key?: string): Promise<T>;
+
+declare function getLocalApiUrl(pathname: string): string;
+declare function localApiFetch<T = unknown>(pathname: string, options?: ApiRequestOptions, serviceOptions?: {
     locale: string;
     market: string;
 }): Promise<T>;
-declare function apiGet<T = any>(url: string, options?: FetchRequestOptions, serviceOptions?: {
+declare function localApiGet<T = unknown>(url: string, options?: ApiRequestOptions, serviceOptions?: {
     locale: string;
     market: string;
 }): Promise<T>;
-declare function apiPost<T = any>(url: string, payload?: unknown, options?: FetchRequestOptions, serviceOptions?: {
+declare function localApiPost<T = unknown>(url: string, payload?: unknown, options?: ApiRequestOptions, serviceOptions?: {
     locale: string;
     market: string;
 }): Promise<T>;
-declare function apiPut<T = any>(url: string, payload?: unknown, options?: FetchRequestOptions, serviceOptions?: {
+declare function localApiPut<T = unknown>(url: string, payload?: unknown, options?: ApiRequestOptions, serviceOptions?: {
     locale: string;
     market: string;
 }): Promise<T>;
-declare function apiPatch<T = any>(url: string, payload?: unknown, options?: FetchRequestOptions, serviceOptions?: {
+declare function localApiPatch<T = unknown>(url: string, payload?: unknown, options?: ApiRequestOptions, serviceOptions?: {
     locale: string;
     market: string;
 }): Promise<T>;
-declare function apiDelete<T = any>(url: string, options?: FetchRequestOptions, serviceOptions?: {
+declare function localApiDelete<T = unknown>(url: string, options?: ApiRequestOptions, serviceOptions?: {
     locale: string;
     market: string;
 }): Promise<T>;
@@ -38,7 +44,14 @@ declare function isStaticRequest(request: NextRequest): boolean;
 declare function isNextRequest(request: NextRequest): boolean;
 declare function isApiRequest(request: NextRequest): boolean;
 
-declare function mockHandler(getJson: () => Promise<string>): any;
+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>;
+declare function mockApiPut<T = unknown>(url: string, payload: unknown, options?: ApiRequestOptions): Promise<T>;
+declare function mockApiPatch<T = unknown>(url: string, payload: unknown, options?: ApiRequestOptions): Promise<T>;
+declare function mockApiDelete<T = unknown>(url: string, options?: ApiRequestOptions): Promise<T>;
+
+declare function mockHandler(): any;
 
 declare class MockService<T extends IEntity = IEntity> extends JsonService<T> {
     store: IStore;
@@ -48,9 +61,33 @@ declare class MockService<T extends IEntity = IEntity> extends JsonService<T> {
 declare function isObject(item: unknown): item is Record<string, unknown>;
 declare function isRelation(item: unknown): item is IPageRelation;
 
-declare function getMockStoreServer<T extends IStore>(): Promise<T>;
-declare function getMockStore<T extends IStore>(getJson: () => Promise<string>): 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);
+    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;
+}
+
+declare function getRemoteStore<T extends IStore>(): Promise<T>;
 
 type IField = {
     name: string;
@@ -87,7 +124,17 @@ declare enum StoreStrategy {
     Data = "data",
     Mock = "mock"
 }
-declare const storeStrategy: StoreStrategy;
+declare const storeStrategy: StoreStrategy;
+declare const MOCK_COLLECTIONS: string[];
+declare const STATIC_COLLECTIONS: string[];
+declare const KNOWN_COLLECTIONS: string[];
+declare const COLLECTIONS: string[];
+
+declare function storeApiGet<T = unknown>(url: string, options?: ApiRequestOptions): Promise<T>;
+declare function storeApiPost<T = unknown>(url: string, payload: unknown, options?: ApiRequestOptions): Promise<T>;
+declare function storeApiPut<T = unknown>(url: string, payload: unknown, options?: ApiRequestOptions): Promise<T>;
+declare function storeApiPatch<T = unknown>(url: string, payload: unknown, options?: ApiRequestOptions): Promise<T>;
+declare function storeApiDelete<T = unknown>(url: string, options?: ApiRequestOptions): Promise<T>;
 
 declare function storeHandler<T extends IStore>(storePromise?: () => Promise<T>): any;
 declare function collectionGet<T extends IStore>(storePromise: () => Promise<T>): (request: NextApiRequest, response: NextApiResponse) => Promise<void>;
@@ -96,35 +143,6 @@ declare function collectionPatch<T extends IStore>(storePromise: () => Promise<T
 declare function collectionDelete<T extends IStore>(storePromise: () => Promise<T>): (request: NextApiRequest, response: NextApiResponse) => Promise<void>;
 declare function routePost(store: IStore, request: NextApiRequest, response: NextApiResponse): Promise<void>;
 
-declare const MOCK_COLLECTIONS: string[];
-declare const STATIC_COLLECTIONS: string[];
-declare const KNOWN_COLLECTIONS: string[];
-declare const COLLECTIONS: string[];
 declare function getStore<T extends IStore>(): Promise<T>;
 
-type ApiRequestOptions = FetchRequestOptions;
-declare function storeApiFetch(pathname: string, options?: ApiRequestOptions): Promise<any>;
-declare function storeApiGet(url: string, options?: ApiRequestOptions): Promise<any>;
-declare function storeApiPost(url: string, payload: any, options?: ApiRequestOptions): Promise<any>;
-declare function storeApiPut(url: string, payload: any, options?: ApiRequestOptions): Promise<any>;
-declare function storeApiPatch(url: string, payload: any, options?: ApiRequestOptions): Promise<any>;
-declare function storeApiDelete(url: string, options?: ApiRequestOptions): Promise<any>;
-declare class StoreApiService<T extends IEntity = IEntity> implements IQuerable<T> {
-    key: string;
-    constructor(key: string);
-    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;
-}
-
-declare function getApiStore<T extends IStore>(collections: string[]): Promise<T>;
-declare function getApiRuntimeStore<T extends IStore>(collections: string[]): Promise<T>;
-declare function getApiBuildStore<T extends IStore>(): Promise<T>;
-
-export { ApiRequestOptions, COLLECTIONS, IApiHandler, ICrudMethod, IField, IHandler, KNOWN_COLLECTIONS, MOCK_COLLECTIONS, MapTo, MockService, STATIC_COLLECTIONS, StaticService, StaticServiceConfig, StaticServiceSrc, StoreApiService, StoreStrategy, apiDelete, apiFetch, apiGet, apiHandler, apiPatch, apiPost, apiPut, collectionDelete, collectionGet, collectionPatch, collectionPost, errorHandler, getApiBuildStore, getApiRuntimeStore, getApiStore, getApiUrl, getMockStore, getMockStoreFromData, getMockStoreServer, getStore, isApiRequest, isNextRequest, isObject, isRelation, isStaticRequest, mockHandler, routePost, staticCollections, storeApiDelete, storeApiFetch, storeApiGet, storeApiPatch, storeApiPost, storeApiPut, storeHandler, storeStrategy };
+export { ApiRequestOptions, COLLECTIONS, IApiHandler, ICrudMethod, IField, IHandler, KNOWN_COLLECTIONS, MOCK_COLLECTIONS, MapTo, MockService, RemoteService, STATIC_COLLECTIONS, StaticService, StaticServiceConfig, StaticServiceSrc, StoreStrategy, apiHandler, collectionDelete, collectionGet, collectionPatch, collectionPost, defaultApiRequestOptions, errorHandler, fromCache, getDefaultApiRequestOptions, getLocalApiUrl, getMockStore, getRemoteStore, getStore, isApiRequest, isNextRequest, isObject, isRelation, isStaticRequest, localApiDelete, localApiFetch, localApiGet, localApiPatch, localApiPost, localApiPut, mockApiDelete, mockApiFetch, mockApiGet, mockApiPatch, mockApiPost, mockApiPut, mockHandler, remoteApiDelete, remoteApiFetch, remoteApiGet, remoteApiPatch, remoteApiPost, remoteApiPut, routePost, staticCollections, storeApiDelete, storeApiGet, storeApiPatch, storeApiPost, storeApiPut, storeHandler, storeStrategy };