@websolutespa/bom-mixer-store 0.0.1 → 0.1.0

package/CHANGELOG.md

@@ -1,6 +1,12 @@
 # @websolutespa/bom-mixer-store
 
-## 0.0.1
+## 0.1.0
+
+### Minor Changes
+
+- mock refactor.
+
+## 0.0.2
 
 ### Patch Changes
 

package/README.md

@@ -0,0 +1,11 @@
+# @websolutespa/bom-mixer-store
+
+[![npm version](https://badge.fury.io/js/%40websolutespa%2Fbom-mixer-store.svg)](https://badge.fury.io/js/%40websolutespa%2Fbom-mixer-store)
+
+[![status alpha](https://img.shields.io/badge/status-alpha-red.svg)](https://shields.io/)
+
+Mixer Store 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

@@ -1,38 +1,35 @@
-import { FetchRequestOptions, IEntity, IQuerable, QueryParams, IEquatable, JsonService } from '@websolutespa/bom-mixer-core';
-import { NextRequest, NextFetchEvent, NextResponse } from 'next/server';
-
-declare function apiFetch(pathname: string, options?: FetchRequestOptions): Promise<any>;
-declare function apiGet(url: string, options?: FetchRequestOptions): Promise<any>;
-declare function apiPost(url: string, payload: any, options?: FetchRequestOptions): Promise<any>;
-declare function apiPut(url: string, payload: any, options?: FetchRequestOptions): Promise<any>;
-declare function apiPatch(url: string, payload: any, options?: FetchRequestOptions): Promise<any>;
-declare function apiDelete(url: string, options?: FetchRequestOptions): Promise<any>;
-declare class ApiService<T extends IEntity> implements IQuerable<IEntity> {
+import { FetchRequestOptions, IEntity, IQuerable, IEquatable, QueryParams, Pagination, JsonService } from '@websolutespa/bom-mixer-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(params?: QueryParams): Promise<T | undefined>;
-    findMany(params?: QueryParams): Promise<T[]>;
-    create(payload: any): Promise<T>;
-    update(payload: T): Promise<T>;
-    delete(id: IEquatable): Promise<any>;
-    protected decorator_(item: any, params?: QueryParams): any;
+    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;
 }
 
-type Store = {
-    [key: string]: IQuerable<IEntity>;
-};
-type MockStore = {
-    [key: string]: any[];
-};
 declare enum StoreStrategy {
     Api = "api",
     Data = "data",
     Mock = "mock"
 }
-declare const storeStrategy: StoreStrategy;
-type IStore = {
-    [key: string]: IQuerable<IEntity>;
-};
+type IStore = Record<string, IQuerable<IEntity>>;
+declare const storeStrategy: StoreStrategy;
 
 declare function getApiStore<T extends IStore>(collections: string[]): Promise<T>;
 declare function getApiRuntimeStore<T extends IStore>(collections: string[]): Promise<T>;
@@ -40,21 +37,54 @@ declare function getApiBuildStore<T extends IStore>(): Promise<T>;
 
 declare function isStaticRequest(request: NextRequest): boolean;
 declare function isNextRequest(request: NextRequest): boolean;
-declare function isApiRequest(request: NextRequest): boolean;
-declare function isExistingApiRoute(request: NextRequest): boolean;
+declare function isApiRequest(request: NextRequest): boolean;
+
+declare function mockHandler(getJson: () => Promise<string>): any;
 
-declare function resolveMockApi(api: string): Promise<any>;
-declare function parseMockApi(api: string): Promise<any>;
+declare class MockService<T extends IEntity = IEntity> extends JsonService<T> {
+    protected decorator_<B extends T = T>(item: B, params?: QueryParams): B;
+}
+
+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 mockInterceptor(request: NextRequest, next: NextFetchEvent): Promise<NextResponse | undefined>;
+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 MockService<T extends IEntity = any> extends JsonService<T> {
-    protected decorator_(item: any, params?: QueryParams): any;
+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 function getMockStore<T extends IStore>(): Promise<T>;
+declare function storeHandler<T extends IStore>(storePromise?: () => Promise<T>): any;
 
-declare function registerCollections(collections?: string[]): 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>;
 
-export { ApiService, IStore, MockService, MockStore, Store, StoreStrategy, apiDelete, apiFetch, apiGet, apiPatch, apiPost, apiPut, getApiBuildStore, getApiRuntimeStore, getApiStore, getMockStore, getStore, isApiRequest, isExistingApiRoute, isNextRequest, isStaticRequest, mockInterceptor, parseMockApi, registerCollections, resolveMockApi, storeStrategy };
+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 };