@olenbetong/appframe-core 2.2.0 → 2.3.0

package/src/getUserImage.ts

@@ -0,0 +1,50 @@
+export type ImageSize = "xs" | "sm" | "md" | "lg" | "xl";
+
+export interface getUserImageOptions {
+  /**
+   * Prim key of the record in atbl_Personnel_Employees
+   */
+  primKey: string | null;
+  /**
+   * Person ID of the employee
+   */
+  login: string | null;
+  /**
+   * The value of the ImageHash column in atbl_Personnel_Employees
+   */
+  hash: string | number | null;
+  /**
+   * The image will be resized according to this value. Default is 'xs':
+   * - xs: 64px
+   * - sm: 128px
+   * - md: 256px
+   * - lg: 512px
+   * - xl: image is not resized
+   */
+  size?: ImageSize;
+}
+
+const sizeMap: Record<ImageSize, number | undefined> = {
+  xs: 64,
+  sm: 128,
+  md: 256,
+  lg: 512,
+  xl: undefined,
+};
+
+/**
+ * Returns the absolute path of a users profile picture. Uses the EmployeesLookup
+ * data resource to enable caching across applications.
+ *
+ * If one of primKey or hash are not provided, or are null, an empty string will be returned.
+ */
+export function getUserImage({ primKey, login, hash, size = "xs" }: getUserImageOptions) {
+  if (!primKey || !hash) {
+    return "";
+  }
+
+  let sizePx = sizeMap[size];
+  return `/api/data/blob/EmployeesLookup/${primKey}/Image/${login}${login ? "." : ""}${hash}.jpg${
+    sizePx ? `?width=${sizePx}` : ""
+  }`;
+}

package/src/index.ts

@@ -7,6 +7,7 @@ export * from "./date.js";
 export { downloadBlob } from "./downloadBlob.js";
 export * from "./downloadRequest.js";
 export { expose } from "./expose.js";
+export * from "./getUserImage.js";
 export { getLocalizedString } from "./getLocalizedString.js";
 export { localize } from "./localize.js";
 export * from "./has.js";