@fjell/client-api 4.4.1 → 4.4.3

package/src/ClientApi.ts

@@ -1,59 +1,64 @@
 import { ComKey, Item, ItemQuery, LocKeyArray, PriKey, TypesProperties } from "@fjell/core";
-import { DeleteMethodOptions, GetMethodOptions, PostMethodOptions, PutMethodOptions } from "@fjell/http-api";
 
 export interface ClientApi<
-    V extends Item<S, L1, L2, L3, L4, L5>,
-    S extends string,
-    L1 extends string = never,
-    L2 extends string = never,
-    L3 extends string = never,
-    L4 extends string = never,
-    L5 extends string = never
+  V extends Item<S, L1, L2, L3, L4, L5>,
+  S extends string,
+  L1 extends string = never,
+  L2 extends string = never,
+  L3 extends string = never,
+  L4 extends string = never,
+  L5 extends string = never
 > {
-    action: (
-        ik: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>,
-        action: string,
-        body: any,
-        options?: Partial<PostMethodOptions>,
-    ) => Promise<V>;
-    all: (
-        query: ItemQuery,
-        options?: Partial<GetMethodOptions>,
-        locations?: LocKeyArray<L1, L2, L3, L4, L5> | []
-    ) => Promise<V[]>;
-    allAction: (
-        action: string,
-        body: any,
-        options?: Partial<PostMethodOptions>,
-        locations?: LocKeyArray<L1, L2, L3, L4, L5> | []
-    ) => Promise<V[]>;
-    create: (
-        item: TypesProperties<V, S, L1, L2, L3, L4, L5>,
-        options?: Partial<PostMethodOptions>,
-        locations?: LocKeyArray<L1, L2, L3, L4, L5> | []
-    ) => Promise<V>;
-    find: (
-        finder: string,
-        finderParams: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>>,
-        options?: Partial<GetMethodOptions>,
-        locations?: LocKeyArray<L1, L2, L3, L4, L5> | []
-    ) => Promise<V[]>;
-    get: (
-        ik: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>,
-        options?: Partial<GetMethodOptions>,
-    ) => Promise<V | null>;
-    one: (
-        query: ItemQuery,
-        options?: Partial<GetMethodOptions>,
-        locations?: LocKeyArray<L1, L2, L3, L4, L5> | []
-    ) => Promise<V | null>;
-    remove: (
-        ik: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>,
-        options?: Partial<DeleteMethodOptions>
-    ) => Promise<boolean>;
-    update: (
-        ik: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>,
-        item: TypesProperties<V, S, L1, L2, L3, L4, L5>,
-        options?: Partial<PutMethodOptions>
-    ) => Promise<V>;
+  action: (
+    ik: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>,
+    action: string,
+    body?: any,
+  ) => Promise<V>;
+  all: (
+    query: ItemQuery,
+    locations?: LocKeyArray<L1, L2, L3, L4, L5> | []
+  ) => Promise<V[]>;
+  allAction: (
+    action: string,
+    body?: any,
+    locations?: LocKeyArray<L1, L2, L3, L4, L5> | []
+  ) => Promise<V[]>;
+  allFacet: (
+    facet: string,
+    params?: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>>,
+    locations?: LocKeyArray<L1, L2, L3, L4, L5> | []
+  ) => Promise<any>;
+  create: (
+    item: TypesProperties<V, S, L1, L2, L3, L4, L5>,
+    locations?: LocKeyArray<L1, L2, L3, L4, L5> | []
+  ) => Promise<V>;
+  facet: (
+    ik: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>,
+    facet: string,
+    params?: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>>,
+  ) => Promise<any>;
+  find: (
+    finder: string,
+    finderParams?: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>>,
+    locations?: LocKeyArray<L1, L2, L3, L4, L5> | []
+  ) => Promise<V[]>;
+  findOne: (
+    finder: string,
+    finderParams?: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>>,
+    locations?: LocKeyArray<L1, L2, L3, L4, L5> | []
+  ) => Promise<V>;
+  get: (
+    ik: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>,
+  ) => Promise<V | null>;
+  one: (
+    query: ItemQuery,
+    locations?: LocKeyArray<L1, L2, L3, L4, L5> | []
+  ) => Promise<V | null>;
+  remove: (
+    ik: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>,
+  ) => Promise<boolean>;
+  update: (
+    ik: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>,
+    item: TypesProperties<V, S, L1, L2, L3, L4, L5>,
+  ) => Promise<V>;
 }

package/src/ClientApiOptions.ts

@@ -1,5 +1,6 @@
 import { Item } from "@fjell/core";
 import { ClientApi } from "./ClientApi";
+import { DeleteMethodOptions, GetMethodOptions, PostMethodOptions, PutMethodOptions } from "@fjell/http-api";
 
 export interface ClientApiOptions {
   readAuthenticated?: boolean;
@@ -14,4 +15,8 @@ export interface ClientApiOptions {
     string | never,
     string | never
   >;
+  getOptions?: Partial<GetMethodOptions>;
+  postOptions?: Partial<PostMethodOptions>;
+  putOptions?: Partial<PutMethodOptions>;
+  deleteOptions?: Partial<DeleteMethodOptions>;
 }

package/src/PItemAPI.ts

@@ -1,13 +1,11 @@
-/* eslint-disable @typescript-eslint/no-unused-vars */
 
-import { ComKey, Item, ItemProperties, ItemQuery, PriKey, TypesProperties } from "@fjell/core";
+import { ComKey, Item, ItemQuery, PriKey, TypesProperties } from "@fjell/core";
 import { HttpApi } from "@fjell/http-api";
-import { createAItemAPI, PathNamesArray } from "./AItemAPI";
+import { createAItemAPI } from "./AItemAPI";
 import { ClientApi } from "./ClientApi";
 
-import { DeleteMethodOptions, GetMethodOptions, PostMethodOptions, PutMethodOptions } from "@fjell/http-api";
-import { ClientApiOptions } from "./ClientApiOptions";
 import LibLogger from "@/logger";
+import { ClientApiOptions } from "./ClientApiOptions";
 const logger = LibLogger.get('PItemAPI');
 
 export interface PItemApi<
@@ -19,58 +17,58 @@ export interface PItemApi<
     ik: PriKey<S> | ComKey<S, never, never, never, never, never>,
     action: string,
     body: any,
-    options?: Partial<PostMethodOptions>,
-    locations?: []
   ) => Promise<V>;
 
   all: (
     query: ItemQuery,
-    options?: Partial<GetMethodOptions>,
-    locations?: []
   ) => Promise<V[]>;
 
   allAction: (
     action: string,
-    body: any,
-    options?: Partial<PostMethodOptions>
+    body?: any,
   ) => Promise<V[]>;
 
+  allFacet: (
+    facet: string,
+    params?: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>>,
+  ) => Promise<any>;
+
   one: (
     query: ItemQuery,
-    options?: Partial<GetMethodOptions>
   ) => Promise<V | null>;
 
   get: (
     ik: PriKey<S> | ComKey<S, never, never, never, never, never>,
-    options?: Partial<GetMethodOptions>,
-    locations?: []
   ) => Promise<V | null>;
 
   create: (
     item: TypesProperties<V, S>,
-    options?: Partial<PostMethodOptions>,
-    locations?: []
   ) => Promise<V>;
 
   remove: (
     ik: PriKey<S> | ComKey<S, never, never, never, never, never>,
-    options?: Partial<DeleteMethodOptions>,
-    locations?: []
   ) => Promise<boolean>;
 
   update: (
     ik: PriKey<S> | ComKey<S, never, never, never, never, never>,
     item: TypesProperties<V, S>,
-    options?: Partial<PutMethodOptions>,
-    locations?: []
   ) => Promise<V>;
 
+  facet: (
+    ik: PriKey<S> | ComKey<S, never, never, never, never, never>,
+    facet: string,
+    params?: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>>,
+  ) => Promise<any>;
+
   find: (
     finder: string,
-    finderParams: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>>,
-    options?: Partial<GetMethodOptions>,
-    locations?: []
+    finderParams?: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>>,
   ) => Promise<V[]>;
+
+  findOne: (
+    finder: string,
+    finderParams?: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>>,
+  ) => Promise<V>;
 }
 
 export const createPItemApi = <V extends Item<S>, S extends string>(
@@ -89,80 +87,96 @@ export const createPItemApi = <V extends Item<S>, S extends string>(
       ik: PriKey<S> | ComKey<S, never, never, never, never, never>,
       action: string,
       body: any = {},
-      options: Partial<PostMethodOptions> = {},
     ): Promise<V> =>
-      await aItemAPI.action(ik, action, body, options) as V;
+      await aItemAPI.action(ik, action, body) as V;
 
   const all =
     async (
       query: ItemQuery = {} as ItemQuery,
-      options: Partial<GetMethodOptions> = {},
     ): Promise<V[]> =>
-      await aItemAPI.all(query, options, []) as V[];
+      await aItemAPI.all(query, []) as V[];
 
   const allAction =
     async (
       action: string,
       body: any = {},
-      options: Partial<PostMethodOptions> = {},
     ): Promise<V[]> =>
-      await aItemAPI.allAction(action, body, options, []) as V[];
+      await aItemAPI.allAction(action, body, []) as V[];
+
+  const allFacet =
+    async (
+      facet: string,
+      params: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>> = {},
+    ): Promise<any> =>
+      await aItemAPI.allFacet(facet, params) as any;
 
   const one =
     async (
       query: ItemQuery = {} as ItemQuery,
-      options: Partial<GetMethodOptions> = {},
     ): Promise<V | null> =>
-      await aItemAPI.one(query, options, []) as V | null;
+      await aItemAPI.one(query, []) as V | null;
 
   const get =
     async (
       ik: PriKey<S> | ComKey<S, never, never, never, never, never>,
-      options: Partial<GetMethodOptions> = {},
     ): Promise<V | null> =>
-      await aItemAPI.get(ik, options) as V | null;
+      await aItemAPI.get(ik) as V | null;
 
   const create =
     async (
       item: TypesProperties<V, S>,
-      options: Partial<PostMethodOptions> = {},
     ): Promise<V> =>
-      await aItemAPI.create(item, options, []) as V;
+      await aItemAPI.create(item, []) as V;
 
   const remove =
     async (
       ik: PriKey<S> | ComKey<S, never, never, never, never, never>,
-      options: Partial<DeleteMethodOptions> = {},
     ): Promise<boolean> =>
-      await aItemAPI.remove(ik, options) as boolean;
+      await aItemAPI.remove(ik) as boolean;
 
   const update =
     async (
       ik: PriKey<S> | ComKey<S, never, never, never, never, never>,
       item: TypesProperties<V, S>,
-      options: Partial<PutMethodOptions> = {},
     ): Promise<V> =>
-      await aItemAPI.update(ik, item, options) as V;
+      await aItemAPI.update(ik, item) as V;
+
+  const facet =
+    async (
+      ik: PriKey<S> | ComKey<S, never, never, never, never, never>,
+      facet: string,
+      params: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>> = {},
+    ): Promise<any> =>
+      await aItemAPI.facet(ik, facet, params) as any;
 
   const find =
     async (
       finder: string,
-      finderParams: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>>,
-      options: Partial<GetMethodOptions> = {},
+      finderParams: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>> = {},
     ): Promise<V[]> =>
-      await aItemAPI.find(finder, finderParams, options, []) as V[];
+      await aItemAPI.find(finder, finderParams) as V[];
+
+  const findOne =
+    async (
+      finder: string,
+      finderParams: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>> = {},
+    ): Promise<V> =>
+      await aItemAPI.findOne(finder, finderParams) as V;
 
   return {
     ...aItemAPI,
     action,
     all,
     allAction,
+    allFacet,
     one,
     get,
     create,
     remove,
     update,
+    facet,
     find,
+    findOne,
   };
 
 };

package/src/ops/action.ts

@@ -3,39 +3,36 @@ import {
   Item,
   PriKey,
 } from "@fjell/core";
-import { HttpApi, PostMethodOptions } from "@fjell/http-api";
-    
+import { HttpApi } from "@fjell/http-api";
+
 import { ClientApiOptions } from "@/ClientApiOptions";
 import LibLogger from "@/logger";
 import { Utilities } from "@/Utilities";
-    
+
 const logger = LibLogger.get('client-api', 'ops', 'action');
-  
+
 export const getActionOperation = <
-      V extends Item<S, L1, L2, L3, L4, L5>,
-      S extends string,
-      L1 extends string = never,
-      L2 extends string = never,
-      L3 extends string = never,
-      L4 extends string = never,
-      L5 extends string = never>(
+  V extends Item<S, L1, L2, L3, L4, L5>,
+  S extends string,
+  L1 extends string = never,
+  L2 extends string = never,
+  L3 extends string = never,
+  L4 extends string = never,
+  L5 extends string = never>(
     api: HttpApi,
     apiOptions: ClientApiOptions,
     utilities: Utilities<V, S, L1, L2, L3, L4, L5>
-     
+
   ) => {
-    
+
   const action = async (
     ik: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>,
     action: string,
     body: any = {},
-    options: Partial<PostMethodOptions> = {}
-  ):
-        Promise<V> => {
-    logger.default('action', { ik, action, body });
-    
-    const requestOptions = Object.assign({}, options, { isAuthenticated: apiOptions.writeAuthenticated });
-    
+  ): Promise<V> => {
+    const requestOptions = Object.assign({}, apiOptions.postOptions, { isAuthenticated: apiOptions.writeAuthenticated });
+    logger.default('action', { ik, action, body, requestOptions });
+
     return utilities.validatePK(
       await utilities.processOne(
         api.httpPost<V>(
@@ -44,9 +41,8 @@ export const getActionOperation = <
           requestOptions,
         )
       )) as V;
-    
+
   };
-  
+
   return action;
 }
-  

package/src/ops/all.ts

@@ -5,41 +5,39 @@ import {
   queryToParams,
 } from "@fjell/core";
 import { HttpApi, QueryParams } from "@fjell/http-api";
-  
+
 import { ClientApiOptions } from "@/ClientApiOptions";
 import LibLogger from "@/logger";
 import { Utilities } from "@/Utilities";
-import { GetMethodOptions } from "@fjell/http-api";
-  
+
 const logger = LibLogger.get('client-api', 'ops', 'all');
 
 export const getAllOperation = <
-    V extends Item<S, L1, L2, L3, L4, L5>,
-    S extends string,
-    L1 extends string = never,
-    L2 extends string = never,
-    L3 extends string = never,
-    L4 extends string = never,
-    L5 extends string = never>(
+  V extends Item<S, L1, L2, L3, L4, L5>,
+  S extends string,
+  L1 extends string = never,
+  L2 extends string = never,
+  L3 extends string = never,
+  L4 extends string = never,
+  L5 extends string = never>(
     api: HttpApi,
     apiOptions: ClientApiOptions,
     utilities: Utilities<V, S, L1, L2, L3, L4, L5>
-   
+
   ) => {
-  
+
   const all = async (
     query: ItemQuery = {} as ItemQuery,
-    options: Partial<GetMethodOptions> = {},
     locations: LocKeyArray<L1, L2, L3, L4, L5> | [] = []
   ): Promise<V[]> => {
-    logger.default('all', { query, locations });
     utilities.verifyLocations(locations);
     const loc: LocKeyArray<L1, L2, L3, L4, L5> | [] = locations;
-  
+
     const params: QueryParams = queryToParams(query);
-  
-    const requestOptions = Object.assign({}, options, { isAuthenticated: apiOptions.allAuthenticated, params });
-  
+    const requestOptions = Object.assign({}, apiOptions.getOptions, { isAuthenticated: apiOptions.allAuthenticated, params });
+
+    logger.default('all', { query, locations, requestOptions });
+
     return utilities.validatePK(await utilities.processArray(
       api.httpGet<V[]>(
         utilities.getPath(loc),
@@ -49,4 +47,4 @@ export const getAllOperation = <
 
   return all;
 }
-  
+

package/src/ops/allAction.ts

@@ -2,41 +2,39 @@ import {
   Item,
   LocKeyArray
 } from "@fjell/core";
-import { HttpApi, PostMethodOptions } from "@fjell/http-api";
-    
+import { HttpApi } from "@fjell/http-api";
+
 import { ClientApiOptions } from "@/ClientApiOptions";
 import LibLogger from "@/logger";
 import { Utilities } from "@/Utilities";
-    
+
 const logger = LibLogger.get('client-api', 'ops', 'allAction');
-  
+
 export const getAllActionOperation = <
-      V extends Item<S, L1, L2, L3, L4, L5>,
-      S extends string,
-      L1 extends string = never,
-      L2 extends string = never,
-      L3 extends string = never,
-      L4 extends string = never,
-      L5 extends string = never>(
+  V extends Item<S, L1, L2, L3, L4, L5>,
+  S extends string,
+  L1 extends string = never,
+  L2 extends string = never,
+  L3 extends string = never,
+  L4 extends string = never,
+  L5 extends string = never>(
     api: HttpApi,
     apiOptions: ClientApiOptions,
     utilities: Utilities<V, S, L1, L2, L3, L4, L5>
-     
+
   ) => {
-    
+
   const allAction = async (
     action: string,
     body: any = {},
-    options: Partial<PostMethodOptions> = {},
     locations: LocKeyArray<L1, L2, L3, L4, L5> | [] = []
   ): Promise<V[]> => {
-    logger.default('allAction', { action, body, locations });
+    const requestOptions = Object.assign({}, apiOptions.postOptions, { isAuthenticated: apiOptions.writeAuthenticated });
+    logger.default('allAction', { action, body, locations, requestOptions });
     utilities.verifyLocations(locations);
-  
+
     const loc: LocKeyArray<L1, L2, L3, L4, L5> | [] = locations;
-  
-    const requestOptions = Object.assign({}, options, { isAuthenticated: apiOptions.writeAuthenticated });
-  
+
     // TODO: This should respond to either a single object, or multiple objects in an array.
     return utilities.validatePK(
       await utilities.processArray(
@@ -47,7 +45,6 @@ export const getAllActionOperation = <
         )
       )) as V[];
   };
-  
+
   return allAction;
 }
-    

package/src/ops/allFacet.ts

@@ -0,0 +1,46 @@
+import {
+  Item,
+  LocKeyArray
+} from "@fjell/core";
+import { HttpApi } from "@fjell/http-api";
+
+import { ClientApiOptions } from "@/ClientApiOptions";
+import LibLogger from "@/logger";
+import { Utilities } from "@/Utilities";
+
+const logger = LibLogger.get('client-api', 'ops', 'allFacet');
+
+export const getAllFacetOperation = <
+  V extends Item<S, L1, L2, L3, L4, L5>,
+  S extends string,
+  L1 extends string = never,
+  L2 extends string = never,
+  L3 extends string = never,
+  L4 extends string = never,
+  L5 extends string = never>(
+    api: HttpApi,
+    apiOptions: ClientApiOptions,
+    utilities: Utilities<V, S, L1, L2, L3, L4, L5>
+
+  ) => {
+
+  const allFacet = async (
+    facet: string,
+    params: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>> = {},
+    locations: LocKeyArray<L1, L2, L3, L4, L5> | [] = []
+  ): Promise<V[]> => {
+    const requestOptions = Object.assign({}, apiOptions.getOptions, { isAuthenticated: apiOptions.writeAuthenticated, params });
+    logger.default('allFacet', { facet, locations, requestOptions });
+    utilities.verifyLocations(locations);
+
+    const loc: LocKeyArray<L1, L2, L3, L4, L5> | [] = locations;
+
+    // TODO: This should respond to either a single object, or multiple objects in an array.
+    return api.httpGet<V[]>(
+      utilities.getPath(loc),
+      requestOptions,
+    )
+  };
+
+  return allFacet;
+}

package/src/ops/create.ts

@@ -3,48 +3,46 @@ import {
   ItemProperties,
   LocKeyArray
 } from "@fjell/core";
-import { HttpApi, PostMethodOptions } from "@fjell/http-api";
-  
+import { HttpApi } from "@fjell/http-api";
+
 import { ClientApiOptions } from "@/ClientApiOptions";
 import LibLogger from "@/logger";
 import { Utilities } from "@/Utilities";
-  
+
 const logger = LibLogger.get('client-api', 'ops', 'create');
 
 export const getCreateOperation = <
-    V extends Item<S, L1, L2, L3, L4, L5>,
-    S extends string,
-    L1 extends string = never,
-    L2 extends string = never,
-    L3 extends string = never,
-    L4 extends string = never,
-    L5 extends string = never>(
+  V extends Item<S, L1, L2, L3, L4, L5>,
+  S extends string,
+  L1 extends string = never,
+  L2 extends string = never,
+  L3 extends string = never,
+  L4 extends string = never,
+  L5 extends string = never>(
     api: HttpApi,
     apiOptions: ClientApiOptions,
     utilities: Utilities<V, S, L1, L2, L3, L4, L5>
-   
+
   ) => {
-  
+
   const create = async (
     item: ItemProperties<S, L1, L2, L3, L4, L5>,
-    options: Partial<PostMethodOptions> = {},
     locations: LocKeyArray<L1, L2, L3, L4, L5> | [] = []
   ): Promise<V> => {
-    logger.default('create', { item, locations });
+    const requestOptions = Object.assign({}, apiOptions.postOptions, { isAuthenticated: apiOptions.writeAuthenticated });
+    logger.default('create', { item, locations, requestOptions });
     utilities.verifyLocations(locations);
-  
+
     const loc: LocKeyArray<L1, L2, L3, L4, L5> | [] = locations;
-    const requestOptions = Object.assign({}, options, { isAuthenticated: apiOptions.writeAuthenticated });
-  
+
     const created: V =
-        utilities.validatePK(await utilities.processOne(api.httpPost<V>(
-          utilities.getPath(loc),
-          item,
-          requestOptions,
-        ))) as V;
+      utilities.validatePK(await utilities.processOne(api.httpPost<V>(
+        utilities.getPath(loc),
+        item,
+        requestOptions,
+      ))) as V;
     return created;
   };
 
   return create;
 }
-