@fjell/client-api 4.4.4 → 4.4.6

package/src/Utilities.ts

@@ -1,183 +0,0 @@
-import {
-  ComKey,
-  validatePK as coreValidatePK,
-  generateKeyArray,
-  isPriKey,
-  Item,
-  LocKey,
-  LocKeyArray,
-  PriKey,
-} from "@fjell/core";
-
-import LibLogger from "@/logger";
-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
-> {
-  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
->(pkType: S, pathNames: string[]): Utilities<V, S, L1, L2, L3, L4, L5> => {
-
-  logger.default('createUtilities', { pkType, pathNames });
-
-  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);
-    }
-    return true;
-  }
-
-  const processOne = async (
-    apiCall: Promise<V>,
-  ): Promise<V> => {
-    logger.default('processOne', { apiCall });
-    const response = await apiCall;
-    logger.default('processOne response', { response: JSON.stringify(response, null, 2) });
-    return convertDoc(response);
-  };
-
-  const processArray = async (
-    api: Promise<V[]>,
-  ): Promise<V[]> => {
-    logger.default('processArray', { api });
-    const response = await api;
-    logger.default('processArray response', { response: JSON.stringify(response, null, 2) });
-    if (response && Array.isArray(response)) {
-      return response.map((subjectChat: V) =>
-        convertDoc(subjectChat),
-      ) as unknown as V[];
-    } else {
-      logger.error('Response was not an array', { response });
-      throw new Error('Response was not an array');
-    }
-  };
-
-  const convertDoc = (doc: V): V => {
-    logger.default('convertDoc', { doc });
-    // console.log(JSON.stringify(doc, null, 2));
-    if (doc && doc.events) {
-      const events = doc.events;
-      for (const key in events) {
-        events[key] = deepmerge(events[key], { at: events[key].at ? new Date(events[key].at) : null });
-      }
-
-      return doc as unknown as V;
-    } else {
-      return doc;
-    }
-  };
-
-  const getPath =
-    (
-      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 });
-
-      // console.log('getPath key: ' + JSON.stringify(key));
-
-      const keys = generateKeyArray(key);
-
-      // console.log('getPath keys: ' + JSON.stringify(keys));
-      // console.log('getPath pathNames: ' + JSON.stringify(pathNames));
-
-      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]}`;
-      }
-
-      logger.default('getPath created', { key, path });
-
-      return path;
-    };
-
-  const addPath = (
-    base: string,
-    keys: Array<PriKey<S> | LocKey<L1 | L2 | L3 | L4 | L5>>,
-    localPathNames: string[],
-  ): string => {
-    logger.default('addPath', { base, keys, pathNames: localPathNames });
-    if (keys.length < localPathNames.length - 1) {
-      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));
-    } 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));
-    }
-    if (keys.length === 0) {
-      // 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
-      let nextBase: string;
-      const key = keys.pop();
-      const pathName = localPathNames.pop();
-      if (isPriKey(key)) {
-        const PriKey = key as PriKey<S>;
-        nextBase = `${base}/${pathName}/${PriKey.pk}`;
-        logger.default('Adding Path for PK', { pathName, PriKey, nextBase });
-      } else {
-        const LocKey = key as LocKey<L1 | L2 | L3 | L4 | L5>;
-        nextBase = `${base}/${pathName}/${LocKey.lk}`;
-        logger.default('Retrieving Collection for LK', { pathName, LocKey });
-      }
-
-      logger.default('calling addPath recursively', { nextBase, keys, localPathNames });
-      return addPath(nextBase, keys, localPathNames);
-    }
-
-  }
-
-  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>[] => {
-    return coreValidatePK<S, L1, L2, L3, L4, L5>(item, pkType);
-  }
-
-  return {
-    verifyLocations,
-    processOne,
-    convertDoc,
-    processArray,
-    getPath,
-    validatePK,
-  }
-}

package/src/index.ts

@@ -1,7 +0,0 @@
-export type { CItemApi } from "./CItemAPI";
-export type { PItemApi } from "./PItemAPI";
-export type { ClientApi } from "./ClientApi";
-export type { ClientApiOptions } from "./ClientApiOptions";
-
-export { createCItemApi } from "./CItemAPI";
-export { createPItemApi } from "./PItemAPI";

package/src/logger.ts

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

package/src/ops/action.ts

@@ -1,48 +0,0 @@
-import {
-  ComKey,
-  Item,
-  PriKey,
-} 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', '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>(
-    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 = {},
-  ): 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>(
-          `${utilities.getPath(ik)}/${action}`,
-          body,
-          requestOptions,
-        )
-      )) as V;
-
-  };
-
-  return action;
-}

package/src/ops/all.ts

@@ -1,50 +0,0 @@
-import {
-  Item,
-  ItemQuery,
-  LocKeyArray,
-  queryToParams,
-} from "@fjell/core";
-import { HttpApi, QueryParams } from "@fjell/http-api";
-
-import { ClientApiOptions } from "@/ClientApiOptions";
-import LibLogger from "@/logger";
-import { Utilities } from "@/Utilities";
-
-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>(
-    api: HttpApi,
-    apiOptions: ClientApiOptions,
-    utilities: Utilities<V, S, L1, L2, L3, L4, L5>
-
-  ) => {
-
-  const all = async (
-    query: ItemQuery = {} as ItemQuery,
-    locations: LocKeyArray<L1, L2, L3, L4, L5> | [] = []
-  ): Promise<V[]> => {
-    utilities.verifyLocations(locations);
-    const loc: LocKeyArray<L1, L2, L3, L4, L5> | [] = locations;
-
-    const params: QueryParams = queryToParams(query);
-    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),
-        requestOptions,
-      ))) as V[];
-  }
-
-  return all;
-}
-

package/src/ops/allAction.ts

@@ -1,50 +0,0 @@
-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', '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>(
-    api: HttpApi,
-    apiOptions: ClientApiOptions,
-    utilities: Utilities<V, S, L1, L2, L3, L4, L5>
-
-  ) => {
-
-  const allAction = async (
-    action: string,
-    body: any = {},
-    locations: LocKeyArray<L1, L2, L3, L4, L5> | [] = []
-  ): Promise<V[]> => {
-    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;
-
-    // TODO: This should respond to either a single object, or multiple objects in an array.
-    return utilities.validatePK(
-      await utilities.processArray(
-        api.httpPost<V[]>(
-          utilities.getPath(loc),
-          body,
-          requestOptions,
-        )
-      )) as V[];
-  };
-
-  return allAction;
-}

package/src/ops/allFacet.ts

@@ -1,46 +0,0 @@
-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,47 +0,0 @@
-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', '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>(
-    api: HttpApi,
-    apiOptions: ClientApiOptions,
-    utilities: Utilities<V, S, L1, L2, L3, L4, L5>
-
-  ) => {
-
-  const create = async (
-    item: Partial<Item<S, L1, L2, L3, L4, L5>>,
-    locations: LocKeyArray<L1, L2, L3, L4, L5> | [] = []
-  ): Promise<V> => {
-    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 created: 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

@@ -1,58 +0,0 @@
-import {
-  ComKey,
-  Item,
-  PriKey,
-} 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', '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,
-    params: Record<string, string | number | boolean | Date | Array<string | number | boolean | Date>> = {},
-  ): Promise<any> => {
-    const requestOptions = Object.assign({}, apiOptions.getOptions, { isAuthenticated: apiOptions.writeAuthenticated, params });
-    logger.default('facet', { ik, facet, requestOptions });
-
-    return api.httpGet<any>(
-      `${utilities.getPath(ik)}/${facet}`,
-      requestOptions,
-    );
-
-  };
-
-  return facet;
-}

package/src/ops/find.ts

@@ -1,49 +0,0 @@
-import {
-  Item,
-  LocKeyArray,
-  QueryParams
-} from "@fjell/core";
-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>(
-    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>> = {},
-    locations: LocKeyArray<L1, L2, L3, L4, L5> | [] = []
-  ): Promise<V[]> => {
-    utilities.verifyLocations(locations);
-    const loc: LocKeyArray<L1, L2, L3, L4, L5> | [] = locations;
-
-    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

@@ -1,51 +0,0 @@
-import {
-  Item,
-  LocKeyArray,
-  QueryParams
-} from "@fjell/core";
-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 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>> = {},
-    locations: LocKeyArray<L1, L2, L3, L4, L5> | [] = []
-  ): Promise<V> => {
-    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({}, apiOptions.getOptions, { isAuthenticated: apiOptions.allAuthenticated, params });
-    logger.default('findOne', { finder, finderParams, locations, requestOptions });
-
-    return (utilities.validatePK(await utilities.processArray(
-      api.httpGet<V[]>(
-        utilities.getPath(loc),
-        requestOptions,
-      ))) as V[])[0];
-  }
-
-  return findOne;
-}

package/src/ops/get.ts

@@ -1,42 +0,0 @@
-import {
-  ComKey,
-  Item,
-  PriKey,
-} 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', '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>(
-    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>,
-  ): Promise<V | null> => {
-    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;
-}