@fjell/client-api 4.4.1 → 4.4.2

package/src/ops/facet.ts

@@ -0,0 +1,59 @@
+import {
+  ComKey,
+  Item,
+  PriKey,
+} 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', 'facet');
+
+export const getFacetOperation = <
+  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>
+
+  ) => {
+
+  /**
+   * Executes a facet operation on an item.
+   *
+   * A facet is a piece of information that is related to an item - it represents
+   * a specific aspect or characteristic of the item. Unlike actions which may
+   * return items or perform operations, facets are informational queries that
+   * return data about a particular facet of an item.
+   *
+   * @param ik - The item key (composite or primary key) identifying the item
+   * @param facet - The name of the facet to query
+   * @param body - Optional request body for the facet operation
+   * @param options - Optional HTTP request options
+   * @returns Promise resolving to the facet data
+   */
+  const facet = async (
+    ik: ComKey<S, L1, L2, L3, L4, L5> | PriKey<S>,
+    facet: string,
+    options: Partial<GetMethodOptions> = {}
+  ): Promise<any> => {
+    logger.default('facet', { ik, facet });
+
+    const requestOptions = Object.assign({}, options, { isAuthenticated: apiOptions.writeAuthenticated });
+
+    return api.httpGet<any>(
+      `${utilities.getPath(ik)}/${facet}`,
+      requestOptions,
+    );
+
+  };
+
+  return facet;
+}

package/src/ops/findOne.ts

@@ -0,0 +1,52 @@
+import {
+  Item,
+  LocKeyArray,
+  QueryParams
+} from "@fjell/core";
+import { GetMethodOptions, 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 getFindOneOperation = <
+  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 findOne = async (
+    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> => {
+    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 });
+
+    return (utilities.validatePK(await utilities.processArray(
+      api.httpGet<V[]>(
+        utilities.getPath(loc),
+        requestOptions,
+      ))) as V[])[0];
+  }
+
+  return findOne;
+}

package/src/ops/index.ts

@@ -1,3 +1,4 @@
+/* eslint-disable indent */
 import { Item } from "@fjell/core"
 import { getAllOperation } from "./all"
 import { getActionOperation } from "./action"
@@ -12,66 +13,78 @@ import { getRemoveOperation } from "./remove"
 import { getFindOperation } from "./find"
 import { ClientApiOptions } from "@/ClientApiOptions"
 import { ClientApi } from "@/ClientApi"
+import { getFindOneOperation } from "./findOne"
+import { getFacetOperation } from "./facet"
 
 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,
-    ),
-  }
-}
+  <
+    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,
+      ),
+      facet: getFacetOperation<V, S, L1, L2, L3, L4, L5>(
+        api,
+        apiOptions,
+        utilities,
+      ),
+      findOne: getFindOneOperation<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,
+      ),
+    }
+  }