@websolutespa/bom-mixer-store 0.1.1 → 0.2.0

package/CHANGELOG.md

@@ -1,19 +1,25 @@
-# @websolutespa/bom-mixer-store
-
-## 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
+
+## 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,90 +1,125 @@
-import { FetchRequestOptions, IEntity, IQuerable, IEquatable, QueryParams, Pagination, JsonService } from '@websolutespa/bom-mixer-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 function apiFetch(pathname: string, options?: ApiRequestOptions): Promise<any>;
-declare function apiGet(url: string, options?: ApiRequestOptions): Promise<any>;
-declare function apiPost(url: string, payload: any, options?: ApiRequestOptions): Promise<any>;
-declare function apiPut(url: string, payload: any, options?: ApiRequestOptions): Promise<any>;
-declare function apiPatch(url: string, payload: any, options?: ApiRequestOptions): Promise<any>;
-declare function apiDelete(url: string, options?: ApiRequestOptions): Promise<any>;
-declare class ApiService<T extends IEntity = IEntity> implements IQuerable<T> {
-    key: string;
-    constructor(key: string);
-    findOne___<B extends T = T>(id: IEquatable, params?: QueryParams): Promise<B | undefined>;
-    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 enum StoreStrategy {
-    Api = "api",
-    Data = "data",
-    Mock = "mock"
-}
-type IStore = Record<string, IQuerable<IEntity>>;
-declare const storeStrategy: StoreStrategy;
+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 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>;
+declare function getApiUrl(pathname: string): string;
+declare function apiFetch<T = any>(pathname: string, options?: FetchRequestOptions, serviceOptions?: {
+    locale: string;
+    market: string;
+}): Promise<T>;
+declare function apiGet<T = any>(url: string, options?: FetchRequestOptions, serviceOptions?: {
+    locale: string;
+    market: string;
+}): Promise<T>;
+declare function apiPost<T = any>(url: string, payload?: unknown, options?: FetchRequestOptions, serviceOptions?: {
+    locale: string;
+    market: string;
+}): Promise<T>;
+declare function apiPut<T = any>(url: string, payload?: unknown, options?: FetchRequestOptions, serviceOptions?: {
+    locale: string;
+    market: string;
+}): Promise<T>;
+declare function apiPatch<T = any>(url: string, payload?: unknown, options?: FetchRequestOptions, serviceOptions?: {
+    locale: string;
+    market: string;
+}): Promise<T>;
+declare function apiDelete<T = any>(url: string, options?: FetchRequestOptions, serviceOptions?: {
+    locale: string;
+    market: string;
+}): Promise<T>;
 
-declare function isStaticRequest(request: NextRequest): boolean;
-declare function isNextRequest(request: NextRequest): boolean;
+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 class MockService<T extends IEntity = IEntity> extends JsonService<T> {
-    protected decorator_<B extends T = T>(item: B, params?: QueryParams): B;
-}
+declare class MockService<T extends IEntity = IEntity> extends JsonService<T> {
+    store: IStore;
+    constructor(items: T[], store: IStore);
+    protected decorator_<B extends T = T>(item: B, params?: QueryParams): B;
+}
+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: Record<string, IEntity[]>): T;
+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;
 
-type IField = {
-    name: string;
-    type: 'text' | 'number' | 'relationship';
-    localized?: boolean;
-    relationTo?: string;
-    hasMany?: boolean;
-    required?: boolean;
-};
-type MapTo = Record<string, string>;
-type StaticServiceSrc<T extends IEntity = IEntity> = string | T[] | ((config: StaticServiceConfig<T>) => T[]) | ((config: StaticServiceConfig<T>) => Promise<T[]>);
-type StaticServiceConfig<T extends IEntity = IEntity> = {
-    src: StaticServiceSrc<T>;
-    slug: string;
-    fields: IField[];
-    map?: MapTo;
-};
+type IField = {
+    name: string;
+    type: 'text' | 'number' | 'relationship';
+    localized?: boolean;
+    relationTo?: string;
+    hasMany?: boolean;
+    required?: boolean;
+};
+type MapTo = Record<string, string>;
+type StaticServiceSrc<T extends IEntity = IEntity> = string | T[] | ((config: StaticServiceConfig<T>) => T[]) | ((config: StaticServiceConfig<T>) => Promise<T[]>);
+type StaticServiceConfig<T extends IEntity = IEntity> = {
+    src: StaticServiceSrc<T>;
+    slug: string;
+    fields: IField[];
+    map?: MapTo;
+};
 declare const staticCollections: StaticServiceConfig[];
 
-declare class StaticService<T extends IEntity = IEntity> extends JsonService<T> {
-    loaded: boolean;
-    config: StaticServiceConfig<T>;
-    store: IStore;
-    constructor(config: StaticServiceConfig<T>, store: IStore);
-    getItems<B extends T = T>(): Promise<B[]>;
-    findOne<B extends T = T>(id: IEquatable, params?: QueryParams): Promise<B | undefined>;
-    protected mapItems_<B extends T = T>(items: B[], map?: MapTo): B[];
-    protected relatedItems_<B extends T = T>(item: B, fields: IField[], locale?: string): Promise<B>;
-    protected decorator_<B extends T = T>(item: B, params?: QueryParams): B;
+declare class StaticService<T extends IEntity = IEntity> extends JsonService<T> {
+    loaded: boolean;
+    config: StaticServiceConfig<T>;
+    store: IStore;
+    constructor(config: StaticServiceConfig<T>, store: IStore);
+    getItems<B extends T = T>(): Promise<B[]>;
+    findOne<B extends T = T>(id: IEquatable, params?: QueryParams): Promise<B | undefined>;
+    protected mapItems_<B extends T = T>(items: B[], map?: MapTo): B[];
+    protected relatedItems_<B extends T = T>(item: B, fields: IField[], locale?: string): Promise<B>;
+    protected decorator_<B extends T = T>(item: B, params?: QueryParams): B;
 }
 
+declare enum StoreStrategy {
+    Api = "api",
+    Data = "data",
+    Mock = "mock"
+}
+declare const storeStrategy: StoreStrategy;
+
 declare function storeHandler<T extends IStore>(storePromise?: () => Promise<T>): any;
 
-declare const MOCK_COLLECTIONS: string[];
-declare const STATIC_COLLECTIONS: string[];
-declare const KNOWN_COLLECTIONS: string[];
-declare const COLLECTIONS: string[];
+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>;
 
-export { ApiRequestOptions, ApiService, COLLECTIONS, IField, IStore, KNOWN_COLLECTIONS, MOCK_COLLECTIONS, MapTo, MockService, STATIC_COLLECTIONS, StaticService, StaticServiceConfig, StaticServiceSrc, StoreStrategy, apiDelete, apiFetch, apiGet, apiPatch, apiPost, apiPut, getApiBuildStore, getApiRuntimeStore, getApiStore, getMockStore, getMockStoreFromData, getMockStoreServer, getStore, isApiRequest, isNextRequest, isStaticRequest, mockHandler, staticCollections, storeHandler, storeStrategy };
+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, errorHandler, getApiBuildStore, getApiRuntimeStore, getApiStore, getApiUrl, getMockStore, getMockStoreFromData, getMockStoreServer, getStore, isApiRequest, isNextRequest, isObject, isRelation, isStaticRequest, mockHandler, staticCollections, storeApiDelete, storeApiFetch, storeApiGet, storeApiPatch, storeApiPost, storeApiPut, storeHandler, storeStrategy };