@fjell/client-api 4.4.0 → 4.4.1

package/src/PItemAPI.ts

@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
- 
+
 import { ComKey, Item, ItemProperties, ItemQuery, PriKey, TypesProperties } from "@fjell/core";
 import { HttpApi } from "@fjell/http-api";
 import { createAItemAPI, PathNamesArray } from "./AItemAPI";
@@ -14,74 +14,71 @@ export interface PItemApi<
   V extends Item<S>,
   S extends string
 > extends ClientApi<V, S> {
-  
+
   action: (
     ik: PriKey<S> | ComKey<S, never, never, never, never, never>,
     action: string,
     body: any,
-    options: Partial<PostMethodOptions>,
+    options?: Partial<PostMethodOptions>,
     locations?: []
   ) => Promise<V>;
 
   all: (
     query: ItemQuery,
-    options: Partial<GetMethodOptions>,
+    options?: Partial<GetMethodOptions>,
     locations?: []
   ) => Promise<V[]>;
 
   allAction: (
     action: string,
     body: any,
-    options: Partial<PostMethodOptions>
+    options?: Partial<PostMethodOptions>
   ) => Promise<V[]>;
 
   one: (
     query: ItemQuery,
-    options: Partial<GetMethodOptions>
+    options?: Partial<GetMethodOptions>
   ) => Promise<V | null>;
 
   get: (
     ik: PriKey<S> | ComKey<S, never, never, never, never, never>,
-    options: Partial<GetMethodOptions>,
+    options?: Partial<GetMethodOptions>,
     locations?: []
   ) => Promise<V | null>;
 
   create: (
     item: TypesProperties<V, S>,
-    options: Partial<PostMethodOptions>,
+    options?: Partial<PostMethodOptions>,
     locations?: []
   ) => Promise<V>;
 
   remove: (
     ik: PriKey<S> | ComKey<S, never, never, never, never, never>,
-    options: Partial<DeleteMethodOptions>,
+    options?: Partial<DeleteMethodOptions>,
     locations?: []
   ) => Promise<boolean>;
 
   update: (
     ik: PriKey<S> | ComKey<S, never, never, never, never, never>,
     item: TypesProperties<V, S>,
-    options: Partial<PutMethodOptions>,
+    options?: Partial<PutMethodOptions>,
     locations?: []
   ) => Promise<V>;
 
   find: (
     finder: string,
     finderParams: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>>,
-    options: Partial<GetMethodOptions>,
+    options?: Partial<GetMethodOptions>,
     locations?: []
   ) => Promise<V[]>;
 }
 
-export const createPItemApi = <
-  V extends Item<S>,
-  S extends string
->(
-    api: HttpApi,
-    type: S,
-    pathName: string,
-    options: ClientApiOptions
-  ): PItemApi<V, S> => {
+export const createPItemApi = <V extends Item<S>, S extends string>(
+  api: HttpApi,
+  type: S,
+  pathName: string,
+  options?: ClientApiOptions
+): PItemApi<V, S> => {
 
   logger.default('createPItemApi', { type, pathName, options });
 
@@ -94,14 +91,14 @@ export const createPItemApi = <
       body: any = {},
       options: Partial<PostMethodOptions> = {},
     ): Promise<V> =>
-        await aItemAPI.action(ik, action, body, options) as V;
+      await aItemAPI.action(ik, action, body, options) 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, options, []) as V[];
 
   const allAction =
     async (
@@ -109,51 +106,51 @@ export const createPItemApi = <
       body: any = {},
       options: Partial<PostMethodOptions> = {},
     ): Promise<V[]> =>
-        await aItemAPI.allAction(action, body, options, []) as V[];
-  
+      await aItemAPI.allAction(action, body, options, []) as V[];
+
   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, options, []) 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, options) 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, options, []) 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, options) 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, options) as V;
+
   const find =
     async (
       finder: string,
       finderParams: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>>,
       options: Partial<GetMethodOptions> = {},
     ): Promise<V[]> =>
-        await aItemAPI.find(finder, finderParams, options, []) as V[];
+      await aItemAPI.find(finder, finderParams, options, []) as V[];
 
   return {
     ...aItemAPI,

package/src/Utilities.ts

@@ -15,31 +15,31 @@ import deepmerge from "deepmerge";
 const logger = LibLogger.get('client-api', 'Utility');
 
 export interface Utilities<
-    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
 > {
-    verifyLocations: (locations: LocKeyArray<L1, L2, L3, L4, L5> | [] | never) => boolean;
-    processOne: (apiCall: Promise<V>) => Promise<V>;
-    processArray: (api: Promise<V[]>) => Promise<V[]>;
-    convertDoc: (doc: V) => V;
-    getPath: (key: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S> | LocKeyArray<L1, L2, L3, L4, L5> | []) => string;
-    validatePK: (item: Item<S, L1, L2, L3, L4, L5> | Item<S, L1, L2, L3, L4, L5>[]) =>
-      Item<S, L1, L2, L3, L4, L5> | Item<S, L1, L2, L3, L4, L5>[];
+  verifyLocations: (locations: LocKeyArray<L1, L2, L3, L4, L5> | [] | never) => boolean;
+  processOne: (apiCall: Promise<V>) => Promise<V>;
+  processArray: (api: Promise<V[]>) => Promise<V[]>;
+  convertDoc: (doc: V) => V;
+  getPath: (key: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S> | LocKeyArray<L1, L2, L3, L4, L5> | []) => string;
+  validatePK: (item: Item<S, L1, L2, L3, L4, L5> | Item<S, L1, L2, L3, L4, L5>[]) =>
+    Item<S, L1, L2, L3, L4, L5> | Item<S, L1, L2, L3, L4, L5>[];
 }
 
 export const createUtilities = <
-    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
 >(pkType: S, pathNames: string[]): Utilities<V, S, L1, L2, L3, L4, L5> => {
 
   logger.default('createUtilities', { pkType, pathNames });
@@ -47,10 +47,10 @@ export const createUtilities = <
   const verifyLocations = (
     locations: LocKeyArray<L1, L2, L3, L4, L5> | [] | never,
   ): boolean => {
-  
+
     if (locations && locations.length < pathNames.length - 1) {
       throw new Error('Not enough locations for pathNames: locations:'
-          + locations.length + ' pathNames:' + pathNames.length);
+        + locations.length + ' pathNames:' + pathNames.length);
     }
     return true;
   }
@@ -96,33 +96,33 @@ export const createUtilities = <
   };
 
   const getPath =
-  (
-    key: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S> | LocKeyArray<L1, L2, L3, L4, L5> | [],
-  ):
-    string => {
+    (
+      key: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S> | LocKeyArray<L1, L2, L3, L4, L5> | [],
+    ):
+      string => {
 
-    const localPathNames = [...pathNames];
-    logger.default('getPath', { key, pathNames: localPathNames });
+      const localPathNames = [...pathNames];
+      logger.default('getPath', { key, pathNames: localPathNames });
 
-    // console.log('getPath key: ' + JSON.stringify(key));
+      // console.log('getPath key: ' + JSON.stringify(key));
 
-    const keys = generateKeyArray(key);
+      const keys = generateKeyArray(key);
 
-    // console.log('getPath keys: ' + JSON.stringify(keys));
-    // console.log('getPath pathNames: ' + JSON.stringify(pathNames));
+      // console.log('getPath keys: ' + JSON.stringify(keys));
+      // console.log('getPath pathNames: ' + JSON.stringify(pathNames));
 
-    let path: string = addPath('', keys, localPathNames);
+      let path: string = addPath('', keys, localPathNames);
 
-    // If there is only one collection left in the collections array, this means that
-    // we received LocKeys and we need to add the last collection to the reference
-    if (localPathNames.length === 1) {
-      path = `${path}/${localPathNames[0]}`;
-    }
+      // If there is only one collection left in the collections array, this means that
+      // we received LocKeys and we need to add the last collection to the reference
+      if (localPathNames.length === 1) {
+        path = `${path}/${localPathNames[0]}`;
+      }
 
-    logger.default('getPath created', { key, path });
+      logger.default('getPath created', { key, path });
 
-    return path;
-  };
+      return path;
+    };
 
   const addPath = (
     base: string,
@@ -134,19 +134,19 @@ export const createUtilities = <
       logger.error('addPath should never have keys with a length less than the length of pathNames - 1',
         { keys, localPathNames });
       throw new Error('addPath should never have keys with a length less than the length of pathNames - 1: '
-      + keys.length + ' ' + localPathNames.length + ' ' + JSON.stringify(keys, localPathNames));
+        + keys.length + ' ' + localPathNames.length + ' ' + JSON.stringify(keys, localPathNames));
     } else if (keys.length > localPathNames.length) {
       logger.error('addPath should never have keys with a length greater than the length of pathNames',
         { keys, pathNames });
       throw new Error('addPath should never have keys with a length greater than the length of pathNames: '
-      + keys.length + ' ' + localPathNames.length + ' ' + JSON.stringify(keys, localPathNames));
+        + keys.length + ' ' + localPathNames.length + ' ' + JSON.stringify(keys, localPathNames));
     }
     if (keys.length === 0) {
-    // If you've recursively consumed all of the keys, return the base.
+      // If you've recursively consumed all of the keys, return the base.
       logger.default('addPath returning base', { base });
       return base;
     } else {
-    // Retrieve the next key and collection, and create the next base
+      // Retrieve the next key and collection, and create the next base
       let nextBase: string;
       const key = keys.pop();
       const pathName = localPathNames.pop();
@@ -168,7 +168,7 @@ export const createUtilities = <
 
   const validatePK = (
     item: Item<S, L1, L2, L3, L4, L5> | Item<S, L1, L2, L3, L4, L5>[]):
-        Item<S, L1, L2, L3, L4, L5> | Item<S, L1, L2, L3, L4, L5>[] => {
+    Item<S, L1, L2, L3, L4, L5> | Item<S, L1, L2, L3, L4, L5>[] => {
     return coreValidatePK<S, L1, L2, L3, L4, L5>(item, pkType);
   }
 

package/src/logger.ts

@@ -1,5 +1,5 @@
 import Logging from '@fjell/logging';
 
-const LibLogger = Logging.getLogger('@fjellproject/client-api');
+const LibLogger = Logging.getLogger('@fjell/client-api');
 
 export default LibLogger;

package/src/ops/one.ts

@@ -6,59 +6,58 @@ import {
   queryToParams
 } from "@fjell/core";
 import { GetMethodOptions, HttpApi } from "@fjell/http-api";
-    
+
 import { ClientApiOptions } from "@/ClientApiOptions";
 import LibLogger from "@/logger";
 import { Utilities } from "@/Utilities";
-    
+
 const logger = LibLogger.get('client-api', 'ops', 'one');
-  
+
 export const getOneOperation = <
-      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>
-     
+
   ): (
     query: ItemQuery,
-    options: Partial<GetMethodOptions>,
-    locations: LocKeyArray<L1, L2, L3, L4, L5> | []
+    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> | []
+    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 });
-  
+
     let item: V | null = null;
-  
+
     const items = utilities.validatePK(await utilities.processArray(
       api.httpGet<V[]>(
         utilities.getPath(loc),
         requestOptions,
       ))) as V[];
-  
+
     if (items.length > 0) {
       item = items[0];
     }
-  
+
     return item as V;
   }
-  
+
   return one;
 }
-