@fjell/client-api 4.2.1

package/src/ops/index.ts

@@ -0,0 +1,77 @@
+import { Item } from "@fjell/core"
+import { getAllOperation } from "./all"
+import { getActionOperation } from "./action"
+import { Utilities } from "@/Utilities"
+import { HttpApi } from "@fjell/http-api"
+import { getAllActionOperation } from "./allAction"
+import { getOneOperation } from "./one"
+import { getCreateOperation } from "./create"
+import { getUpdateOperation } from "./update"
+import { getGetOperation } from "./get"
+import { getRemoveOperation } from "./remove"
+import { getFindOperation } from "./find"
+import { ClientApiOptions } from "@/ClientApiOptions"
+import { ClientApi } from "@/ClientApi"
+
+export const getOperations =
+<
+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>,
+   
+  ): ClientApi<V, S, L1, L2, L3, L4, L5> => {
+  return {
+    action: getActionOperation<V, S, L1, L2, L3, L4, L5>(
+      api,
+      apiOptions,
+      utilities,
+    ),
+    all: getAllOperation<V, S, L1, L2, L3, L4, L5>(
+      api,
+      apiOptions,
+      utilities,
+    ),
+    allAction: getAllActionOperation<V, S, L1, L2, L3, L4, L5>(
+      api,
+      apiOptions,
+      utilities,
+    ),
+    create: getCreateOperation<V, S, L1, L2, L3, L4, L5>(
+      api,
+      apiOptions,
+      utilities,
+    ),
+    find: getFindOperation<V, S, L1, L2, L3, L4, L5>(
+      api,
+      apiOptions,
+      utilities,
+    ),
+    get: getGetOperation<V, S, L1, L2, L3, L4, L5>(
+      api,
+      apiOptions,
+      utilities,
+    ),
+    one: getOneOperation<V, S, L1, L2, L3, L4, L5>(
+      api,
+      apiOptions,
+      utilities,
+    ),
+    remove: getRemoveOperation<V, S, L1, L2, L3, L4, L5>(
+      api,
+      apiOptions,
+      utilities,
+    ),
+    update: getUpdateOperation<V, S, L1, L2, L3, L4, L5>(
+      api,
+      apiOptions,
+      utilities,
+    ),
+  }
+}

package/src/ops/one.ts

@@ -0,0 +1,64 @@
+import {
+  Item,
+  ItemQuery,
+  LocKeyArray,
+  QueryParams,
+  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>(
+    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> | []
+  ) => 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 });
+  
+    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;
+}
+    

package/src/ops/remove.ts

@@ -0,0 +1,41 @@
+import {
+  ComKey,
+  Item,
+  PriKey,
+} from "@fjell/core";
+import { DeleteMethodOptions, 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>(
+    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 });
+  
+    return api.httpDelete<boolean>(utilities.getPath(ik), requestOptions);
+  }
+  
+  return remove;
+}
+    

package/src/ops/update.ts

@@ -0,0 +1,47 @@
+import {
+  ComKey,
+  Item,
+  ItemProperties,
+  PriKey
+} from "@fjell/core";
+import { HttpApi, PutMethodOptions } 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>(
+    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> = {},
+  ): Promise<V> => {
+    logger.default('update', { ik, item });
+    const requestOptions = Object.assign({}, options, { isAuthenticated: apiOptions.writeAuthenticated });
+        
+    return utilities.validatePK(await utilities.processOne(
+      api.httpPut<V>(
+        utilities.getPath(ik),
+        item,
+        requestOptions,
+      ))) as V;
+  }
+  
+  return update;
+}
+