@fjell/client-api 4.4.2 → 4.4.4

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

@@ -1,50 +1,47 @@
 import {
   Item,
-  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> = {},
+    item: Partial<Item<S, L1, L2, L3, L4, L5>>,
     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;
 }
-  

package/src/ops/facet.ts

@@ -3,7 +3,7 @@ import {
   Item,
   PriKey,
 } from "@fjell/core";
-import { GetMethodOptions, HttpApi } from "@fjell/http-api";
+import { HttpApi } from "@fjell/http-api";
 
 import { ClientApiOptions } from "@/ClientApiOptions";
 import LibLogger from "@/logger";
@@ -42,11 +42,10 @@ export const getFacetOperation = <
   const facet = async (
     ik: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>,
     facet: string,
-    options: Partial<GetMethodOptions> = {}
+    params: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>> = {},
   ): Promise<any> => {
-    logger.default('facet', { ik, facet });
-
-    const requestOptions = Object.assign({}, options, { isAuthenticated: apiOptions.writeAuthenticated });
+    const requestOptions = Object.assign({}, apiOptions.getOptions, { isAuthenticated: apiOptions.writeAuthenticated, params });
+    logger.default('facet', { ik, facet, requestOptions });
 
     return api.httpGet<any>(
       `${utilities.getPath(ik)}/${facet}`,

package/src/ops/find.ts

@@ -3,50 +3,47 @@ import {
   LocKeyArray,
   QueryParams
 } from "@fjell/core";
-import { GetMethodOptions, HttpApi } from "@fjell/http-api";
-    
+import { HttpApi } from "@fjell/http-api";
+
 import { finderToParams } from "@/AItemAPI";
 import { ClientApiOptions } from "@/ClientApiOptions";
 import LibLogger from "@/logger";
 import { Utilities } from "@/Utilities";
-    
+
 const logger = LibLogger.get('client-api', 'ops', 'find');
-  
+
 export const getFindOperation = <
-      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 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>> = {},
     locations: LocKeyArray<L1, L2, L3, L4, L5> | [] = []
   ): Promise<V[]> => {
-    logger.default('find', { finder, finderParams, locations });
     utilities.verifyLocations(locations);
     const loc: LocKeyArray<L1, L2, L3, L4, L5> | [] = locations;
-  
-    const params: QueryParams = finderToParams(finder, finderParams);
-  
-    const requestOptions = Object.assign({}, options, { isAuthenticated: apiOptions.allAuthenticated, params });
-  
+
+    const mergedParams: QueryParams = finderToParams(finder, finderParams);
+    const requestOptions = Object.assign({}, apiOptions.getOptions, { isAuthenticated: apiOptions.allAuthenticated, params: mergedParams });
+    logger.default('find', { finder, finderParams, locations, requestOptions });
+
     return utilities.validatePK(await utilities.processArray(
       api.httpGet<V[]>(
         utilities.getPath(loc),
         requestOptions,
       ))) as V[];
   }
-    
+
   return find;
 }
-    

package/src/ops/findOne.ts

@@ -3,7 +3,7 @@ import {
   LocKeyArray,
   QueryParams
 } from "@fjell/core";
-import { GetMethodOptions, HttpApi } from "@fjell/http-api";
+import { HttpApi } from "@fjell/http-api";
 
 import { finderToParams } from "@/AItemAPI";
 import { ClientApiOptions } from "@/ClientApiOptions";
@@ -28,18 +28,17 @@ export const getFindOneOperation = <
 
   const findOne = 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>> = {},
     locations: LocKeyArray<L1, L2, L3, L4, L5> | [] = []
   ): Promise<V> => {
-    logger.default('findOne', { finder, finderParams, locations });
     utilities.verifyLocations(locations);
     const loc: LocKeyArray<L1, L2, L3, L4, L5> | [] = locations;
 
     const params: QueryParams = finderToParams(finder, finderParams);
     params.one = true;
 
-    const requestOptions = Object.assign({}, options, { isAuthenticated: apiOptions.allAuthenticated, params });
+    const requestOptions = Object.assign({}, apiOptions.getOptions, { isAuthenticated: apiOptions.allAuthenticated, params });
+    logger.default('findOne', { finder, finderParams, locations, requestOptions });
 
     return (utilities.validatePK(await utilities.processArray(
       api.httpGet<V[]>(

package/src/ops/get.ts

@@ -3,43 +3,40 @@ import {
   Item,
   PriKey,
 } from "@fjell/core";
-import { GetMethodOptions, HttpApi } 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', 'get');
-  
+
 export const getGetOperation = <
-      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 get = async (
     ik: PriKey<S> | ComKey<S, never, never, never, never, never>,
-    options: Partial<GetMethodOptions> = {},
   ): Promise<V | null> => {
-    logger.default('get', { ik });
-  
-    const requestOptions = Object.assign({}, options, { isAuthenticated: apiOptions.readAuthenticated });
-  
+    const requestOptions = Object.assign({}, apiOptions.getOptions, { isAuthenticated: apiOptions.readAuthenticated });
+    logger.default('get', { ik, requestOptions });
+
     return utilities.validatePK(await utilities.processOne(
       api.httpGet<V>(
         utilities.getPath(ik),
         requestOptions,
       ))) as V;
   }
-  
+
   return get;
 }
-    

package/src/ops/index.ts

@@ -15,6 +15,7 @@ import { ClientApiOptions } from "@/ClientApiOptions"
 import { ClientApi } from "@/ClientApi"
 import { getFindOneOperation } from "./findOne"
 import { getFacetOperation } from "./facet"
+import { getAllFacetOperation } from "./allFacet"
 
 export const getOperations =
   <
@@ -46,6 +47,11 @@ export const getOperations =
         apiOptions,
         utilities,
       ),
+      allFacet: getAllFacetOperation<V, S, L1, L2, L3, L4, L5>(
+        api,
+        apiOptions,
+        utilities,
+      ),
       create: getCreateOperation<V, S, L1, L2, L3, L4, L5>(
         api,
         apiOptions,

package/src/ops/one.ts

@@ -5,7 +5,7 @@ import {
   QueryParams,
   queryToParams
 } from "@fjell/core";
-import { GetMethodOptions, HttpApi } from "@fjell/http-api";
+import { HttpApi } from "@fjell/http-api";
 
 import { ClientApiOptions } from "@/ClientApiOptions";
 import LibLogger from "@/logger";
@@ -27,22 +27,20 @@ export const getOneOperation = <
 
   ): (
     query: ItemQuery,
-    options?: Partial<GetMethodOptions>,
     locations?: LocKeyArray<L1, L2, L3, L4, L5> | []
   ) => Promise<V | null> => {
 
   const one = async (
     query: ItemQuery = {} as ItemQuery,
-    options: Partial<GetMethodOptions> = {},
     locations: LocKeyArray<L1, L2, L3, L4, L5> | [] = []
   ): Promise<V | null> => {
-    logger.default('one', { 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.readAuthenticated, params });
+    const requestOptions = Object.assign({}, apiOptions.getOptions, { isAuthenticated: apiOptions.readAuthenticated, params });
+    logger.default('one', { query, locations, requestOptions });
 
     let item: V | null = null;
 

package/src/ops/remove.ts

@@ -3,39 +3,36 @@ import {
   Item,
   PriKey,
 } from "@fjell/core";
-import { DeleteMethodOptions, HttpApi } 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', 'remove');
-  
+
 export const getRemoveOperation = <
-      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 remove = async (
     ik: PriKey<S> | ComKey<S, L1, L2, L3, L4, L5>,
-    options: Partial<DeleteMethodOptions> = {},
   ): Promise<boolean> => {
-    logger.default('remove', { ik });
-  
-    const requestOptions = Object.assign({}, options, { isAuthenticated: apiOptions.writeAuthenticated });
-  
+    const requestOptions = Object.assign({}, apiOptions.deleteOptions, { isAuthenticated: apiOptions.writeAuthenticated });
+    logger.default('remove', { ik, requestOptions });
+
     return api.httpDelete<boolean>(utilities.getPath(ik), requestOptions);
   }
-  
+
   return remove;
 }
-    

package/src/ops/update.ts

@@ -1,39 +1,37 @@
 import {
   ComKey,
   Item,
-  ItemProperties,
   PriKey
 } from "@fjell/core";
-import { HttpApi, PutMethodOptions } 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', 'update');
-  
+
 export const getUpdateOperation = <
-      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 update = async (
     ik: PriKey<S> | ComKey<S, L1, L2, L3, L4, L5>,
-    item: ItemProperties<S, L1, L2, L3, L4, L5>,
-    options: Partial<PutMethodOptions> = {},
+    item: Partial<Item<S, L1, L2, L3, L4, L5>>,
   ): Promise<V> => {
-    logger.default('update', { ik, item });
-    const requestOptions = Object.assign({}, options, { isAuthenticated: apiOptions.writeAuthenticated });
-        
+    const requestOptions = Object.assign({}, apiOptions.putOptions, { isAuthenticated: apiOptions.writeAuthenticated });
+    logger.default('update', { ik, item, requestOptions });
+
     return utilities.validatePK(await utilities.processOne(
       api.httpPut<V>(
         utilities.getPath(ik),
@@ -41,7 +39,6 @@ export const getUpdateOperation = <
         requestOptions,
       ))) as V;
   }
-  
+
   return update;
 }
-    

package/src/util/general.ts

@@ -0,0 +1,65 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+/* eslint-disable no-undefined */
+export const clean = (obj: any) => {
+  return Object.fromEntries(
+    Object.entries(obj).filter(([_, v]) => v !== undefined)
+  );
+}
+
+//Recursive implementation of jSON.stringify;
+export const stringifyJSON = function (obj: any, visited: Set<any> = new Set()): string {
+  const arrOfKeyVals: string[] = [];
+  const arrVals: string[] = [];
+  let objKeys: string[] = [];
+
+  /*********CHECK FOR PRIMITIVE TYPES**********/
+  if (typeof obj === 'number' || typeof obj === 'boolean' || obj === null)
+    return '' + obj;
+  else if (typeof obj === 'string')
+    return '"' + obj + '"';
+
+  /*********DETECT CIRCULAR REFERENCES**********/
+  if (obj instanceof Object && visited.has(obj)) {
+    return '"(circular)"';
+  }
+
+  /*********CHECK FOR ARRAY**********/
+  else if (Array.isArray(obj)) {
+    //check for empty array
+    if (obj[0] === undefined)
+      return '[]';
+    else {
+      // Add array to visited before processing its elements
+      visited.add(obj);
+      obj.forEach(function (el) {
+        arrVals.push(stringifyJSON(el, visited));
+      });
+      return '[' + arrVals + ']';
+    }
+  }
+  /*********CHECK FOR OBJECT**********/
+  else if (obj instanceof Object) {
+    // Add object to visited before processing its properties
+    visited.add(obj);
+    //get object keys
+    objKeys = Object.keys(obj);
+    //set key output;
+    objKeys.forEach(function (key) {
+      const keyOut = '"' + key + '":';
+      const keyValOut = obj[key];
+      //skip functions and undefined properties
+      if (keyValOut instanceof Function || keyValOut === undefined)
+        return; // Skip this entry entirely instead of pushing an empty string
+      else if (typeof keyValOut === 'string')
+        arrOfKeyVals.push(keyOut + '"' + keyValOut + '"');
+      else if (typeof keyValOut === 'boolean' || typeof keyValOut === 'number' || keyValOut === null)
+        arrOfKeyVals.push(keyOut + keyValOut);
+      //check for nested objects, call recursively until no more objects
+      else if (keyValOut instanceof Object) {
+        arrOfKeyVals.push(keyOut + stringifyJSON(keyValOut, visited));
+      }
+    });
+    return '{' + arrOfKeyVals + '}';
+  }
+  return '';
+};