@olenbetong/appframe-core 1.1.1 → 1.2.2

package/es/exportDataObject.d.ts

@@ -0,0 +1,89 @@
+import { DataObject, DataObjectOptions } from "@olenbetong/appframe-data";
+import { RetrieveParameters } from "@olenbetong/appframe-data";
+export declare type DataExportColumn = {
+    name: string;
+    caption?: string;
+    cellFormat?: string;
+    format?: string;
+};
+export declare type DataExportOptions = RetrieveParameters<any> & {
+    columns: DataExportColumn[];
+};
+export declare type DataObjectReportParams = {
+    articleId: string;
+    controller?: AbortController;
+    dataObject: string;
+    format: "pdf" | "xlsx" | "csv" | "xls";
+    fileName?: string;
+    options: DataExportOptions;
+    id?: string;
+    title?: string;
+    subTitle?: string;
+    /**
+     * Whether the title should be shown in the exported file (default true)
+     */
+    includeTitle?: boolean;
+    /**
+     * Whether the filter should be shown in the exported file (default true)
+     */
+    includefilter?: boolean;
+    /**
+     * Whether we should try to convert from camelCase to human readable names (default true)
+     */
+    formatHeaders?: boolean;
+    /**
+     * Whether the header should be frozen on top of the excel file.
+     */
+    freezeHeader?: boolean;
+};
+/**
+ * Get columns and retrieve parameters from a data object to be used to create a report.
+ * @param dataObject Data object to get parameters and columns from
+ * @param specifiedOptions Options to override the data object options
+ * @returns
+ */
+export declare function exportOptionsFromDataObject(dataObject: DataObject<any>, specifiedOptions: Partial<DataObjectOptions<any>>): {
+    allowDelete?: boolean | undefined;
+    allowInsert?: boolean | undefined;
+    allowUpdate?: boolean | undefined;
+    articleId?: string | undefined;
+    dataHandler?: import("@olenbetong/appframe-data").DataHandlerDescriptor | import("@olenbetong/appframe-data").DataHandler<any> | undefined;
+    dataSourceId?: string | undefined;
+    disableAutoload?: boolean | undefined;
+    dynamicLoading?: boolean | undefined;
+    errorHandler?: ((error: string, callback?: Function | undefined) => void) | undefined;
+    fields?: import("@olenbetong/appframe-data").FieldDefinition[] | undefined;
+    groupBy?: string | number | symbol | string[] | null | undefined;
+    hasIDTrig?: boolean | undefined;
+    hasIITrig?: boolean | undefined;
+    hasIUTrig?: boolean | undefined;
+    linkFields?: (string | number | symbol)[] | Record<string | number | symbol, string> | null | undefined;
+    masterDataObject?: import("@olenbetong/appframe-data").AfDataObject<any> | null | undefined;
+    optimisticLocking?: boolean | undefined;
+    parameters?: RetrieveParameters<any> | undefined;
+    selectFirstRow?: boolean | undefined;
+    systemFieldNames?: Record<string, string | number | symbol> | undefined;
+    strict?: boolean | undefined;
+    timeout?: number | undefined;
+    uniqueIdField?: string | number | symbol | undefined;
+    columns: {
+        name: string;
+    }[];
+    distinctRows: boolean | undefined;
+    filterObject: import("@olenbetong/appframe-data").Filter | undefined;
+    filterString: string | undefined;
+    maxRecords: number | undefined;
+    sortOrder: Record<string | number | symbol, import("@olenbetong/appframe-data").SortOrder>[] | undefined;
+    whereClause: string | undefined;
+    whereObject: import("@olenbetong/appframe-data").Filter | undefined;
+};
+/**
+ * Get a request object to download a report from a data object.
+ * @param params Parameters to use to create a report
+ * @returns Request object for the report
+ */
+export declare function getDataObjectReportRequest(params: DataObjectReportParams): {
+    controller: AbortController;
+    request: Request;
+};
+export declare function openDataObjectReport(params: DataObjectReportParams): Promise<void>;

package/es/exportDataObject.js

@@ -0,0 +1,61 @@
+import { downloadRequest } from "./downloadRequest.js";
+/**
+ * Get columns and retrieve parameters from a data object to be used to create a report.
+ * @param dataObject Data object to get parameters and columns from
+ * @param specifiedOptions Options to override the data object options
+ * @returns
+ */
+export function exportOptionsFromDataObject(dataObject, specifiedOptions) {
+    return {
+        columns: dataObject.getFields().map((field) => ({ name: field.name })),
+        distinctRows: dataObject.getParameter("distinctRows"),
+        filterObject: dataObject.getParameter("filterObject"),
+        filterString: dataObject.getParameter("filterString"),
+        maxRecords: dataObject.getParameter("maxRecords"),
+        sortOrder: dataObject.getParameter("sortOrder"),
+        whereClause: dataObject.getParameter("whereClause"),
+        whereObject: dataObject.getParameter("whereObject"),
+        ...specifiedOptions,
+    };
+}
+const defaultOptions = {
+    columns: [],
+    distinctRows: false,
+    filterObject: null,
+    filterString: "",
+    maxRecords: -1,
+    sortOrder: [],
+    whereClause: "",
+    whereObject: null,
+};
+/**
+ * Get a request object to download a report from a data object.
+ * @param params Parameters to use to create a report
+ * @returns Request object for the report
+ */
+export function getDataObjectReportRequest(params) {
+    const { articleId, dataObject, format, options } = params;
+    const reportOptions = options ? Object.assign({}, defaultOptions, options) : defaultOptions;
+    const body = "data=" + encodeURIComponent(JSON.stringify(reportOptions));
+    const requestUrl = `/api/data-object/export/${articleId}/${dataObject}/${format}`;
+    const controller = params.controller ?? new AbortController();
+    return {
+        controller,
+        request: new Request(requestUrl, {
+            body,
+            credentials: "same-origin",
+            headers: {
+                "Content-Type": "application/x-www-form-urlencoded",
+            },
+            method: "POST",
+            signal: controller.signal,
+        }),
+    };
+}
+export function openDataObjectReport(params) {
+    const { dataObject, fileName, format } = params;
+    const { request } = getDataObjectReportRequest(params);
+    return downloadRequest(request, {
+        fileName: `${fileName || dataObject}.${format}`,
+    });
+}

package/es/index.d.ts

@@ -1,4 +1,7 @@
 export { default as mitt } from "mitt";
+export { downloadBlob } from "./downloadBlob.js";
+export * from "./downloadRequest.js";
+export * from "./exportDataObject.js";
 export { default as expose } from "./expose.js";
 export { getLocalizedString } from "./getLocalizedString.js";
 export { default as localStorage } from "./localStorage.js";

package/es/index.js

@@ -1,4 +1,7 @@
 export { default as mitt } from "mitt";
+export { downloadBlob } from "./downloadBlob.js";
+export * from "./downloadRequest.js";
+export * from "./exportDataObject.js";
 export { default as expose } from "./expose.js";
 export { getLocalizedString } from "./getLocalizedString.js";
 export { default as localStorage } from "./localStorage.js";
@@ -6,4 +9,4 @@ export { default as SessionHandler } from "./SessionHandler.js";
 export { default as UserSession } from "./UserSession.js";
 export { formDataToDataObjectRecord, formDataToObject, formDataToProcedureParameters } from "./formDataToObject.js";
 export * from "./settings.js";
-export const version = "1.1.1";
+export const version = "1.2.2";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@olenbetong/appframe-core",
-  "version": "1.1.1",
+  "version": "1.2.2",
   "description": "Javascript libraries to utilize the Appframe framework",
   "type": "module",
   "main": "./es/index.js",
@@ -35,5 +35,5 @@
   "devDependencies": {
     "chalk": "^5.0.1"
   },
-  "gitHead": "2fcc10369164e8ce8ad9ce14004da02ab04f5a85"
+  "gitHead": "110516c6cd639ad0a5d593be42bddcfba5a60cc6"
 }

package/src/downloadBlob.ts

@@ -0,0 +1,21 @@
+export function downloadBlob(blob: Blob | MediaSource, fileName: string) {
+  return new Promise<void>(function (resolve, reject) {
+    try {
+      const url = URL.createObjectURL(blob);
+      const parent = document.body;
+      const anchor = document.createElement("a");
+      anchor.setAttribute("download", fileName);
+      anchor.href = url;
+      parent.append(anchor);
+      anchor.click();
+      parent.removeChild(anchor);
+
+      setTimeout(function () {
+        URL.revokeObjectURL(url);
+        resolve();
+      }, 250);
+    } catch (ex) {
+      reject(ex);
+    }
+  });
+}

package/src/downloadRequest.ts

@@ -0,0 +1,82 @@
+import { downloadBlob } from "./downloadBlob.js";
+
+export type DownloadItem = {
+  status: "cancelled" | "error" | "requested" | "downloading" | "downloaded" | "completed";
+  bytesReceived?: number;
+  error?: string;
+};
+
+export type DownloadParameters = {
+  controller?: AbortController;
+  fileName: string;
+  onProgress?: (progress: DownloadItem) => void;
+};
+
+export async function downloadRequest(request: Request, { fileName, controller, onProgress }: DownloadParameters) {
+  function reportProgress(progress: DownloadItem) {
+    if (typeof onProgress === "function") {
+      onProgress({ ...progress });
+    }
+  }
+
+  let bytesReceived = 0;
+
+  reportProgress({ status: "requested" });
+
+  try {
+    let response = await fetch(request);
+
+    if (!response.ok || !response.body) {
+      if (response.headers.get("content-type")?.includes("application/json")) {
+        let data = await response.json();
+        if (data.error) {
+          throw new Error(data.error);
+        }
+      }
+      throw new Error(response.status + " " + response.statusText);
+    }
+
+    try {
+      const reader = response.body.getReader();
+      const stream = new ReadableStream({
+        start: function (controller) {
+          function pump(): Promise<void> {
+            return reader.read().then(function (read) {
+              if (read.done) {
+                controller.close();
+                return;
+              }
+
+              bytesReceived += read.value.length;
+              reportProgress({ bytesReceived, status: "downloading" });
+              controller.enqueue(read.value);
+
+              return pump();
+            });
+          }
+
+          return pump();
+        },
+      });
+
+      response = new Response(stream);
+    } catch (error) {
+      // eslint-disable-next-line no-console
+      console.warn("Failed to replace response stream to log download progress.");
+    }
+
+    const blob = await response.blob();
+
+    reportProgress({ bytesReceived, status: "downloaded" });
+
+    await downloadBlob(blob, fileName);
+
+    reportProgress({ bytesReceived, status: "completed" });
+  } catch (err) {
+    if (controller?.signal?.aborted) {
+      reportProgress({ status: "cancelled" });
+    } else {
+      reportProgress({ error: (err as Error).message, status: "error" });
+    }
+  }
+}

package/src/exportDataObject.ts

@@ -0,0 +1,110 @@
+import { DataObject, DataObjectOptions } from "@olenbetong/appframe-data";
+import { RetrieveParameters } from "@olenbetong/appframe-data";
+
+import { downloadRequest } from "./downloadRequest.js";
+
+export type DataExportColumn = {
+  name: string;
+  caption?: string;
+  cellFormat?: string;
+  format?: string;
+};
+
+export type DataExportOptions = RetrieveParameters<any> & { columns: DataExportColumn[] };
+export type DataObjectReportParams = {
+  articleId: string;
+  controller?: AbortController;
+  dataObject: string;
+  format: "pdf" | "xlsx" | "csv" | "xls";
+  fileName?: string;
+  options: DataExportOptions;
+  id?: string;
+  title?: string;
+  subTitle?: string;
+  /**
+   * Whether the title should be shown in the exported file (default true)
+   */
+  includeTitle?: boolean;
+  /**
+   * Whether the filter should be shown in the exported file (default true)
+   */
+  includefilter?: boolean;
+  /**
+   * Whether we should try to convert from camelCase to human readable names (default true)
+   */
+  formatHeaders?: boolean;
+  /**
+   * Whether the header should be frozen on top of the excel file.
+   */
+  freezeHeader?: boolean;
+};
+
+/**
+ * Get columns and retrieve parameters from a data object to be used to create a report.
+ * @param dataObject Data object to get parameters and columns from
+ * @param specifiedOptions Options to override the data object options
+ * @returns
+ */
+export function exportOptionsFromDataObject(
+  dataObject: DataObject<any>,
+  specifiedOptions: Partial<DataObjectOptions<any>>
+) {
+  return {
+    columns: dataObject.getFields().map((field) => ({ name: field.name })),
+    distinctRows: dataObject.getParameter("distinctRows"),
+    filterObject: dataObject.getParameter("filterObject"),
+    filterString: dataObject.getParameter("filterString"),
+    maxRecords: dataObject.getParameter("maxRecords"),
+    sortOrder: dataObject.getParameter("sortOrder"),
+    whereClause: dataObject.getParameter("whereClause"),
+    whereObject: dataObject.getParameter("whereObject"),
+    ...specifiedOptions,
+  };
+}
+
+const defaultOptions: DataExportOptions = {
+  columns: [],
+  distinctRows: false,
+  filterObject: null,
+  filterString: "",
+  maxRecords: -1,
+  sortOrder: [],
+  whereClause: "",
+  whereObject: null,
+};
+
+/**
+ * Get a request object to download a report from a data object.
+ * @param params Parameters to use to create a report
+ * @returns Request object for the report
+ */
+export function getDataObjectReportRequest(params: DataObjectReportParams) {
+  const { articleId, dataObject, format, options } = params;
+  const reportOptions = options ? Object.assign({}, defaultOptions, options) : defaultOptions;
+  const body = "data=" + encodeURIComponent(JSON.stringify(reportOptions));
+  const requestUrl = `/api/data-object/export/${articleId}/${dataObject}/${format}`;
+
+  const controller = params.controller ?? new AbortController();
+
+  return {
+    controller,
+    request: new Request(requestUrl, {
+      body,
+      credentials: "same-origin",
+      headers: {
+        "Content-Type": "application/x-www-form-urlencoded",
+      },
+      method: "POST",
+      signal: controller.signal,
+    }),
+  };
+}
+
+export function openDataObjectReport(params: DataObjectReportParams) {
+  const { dataObject, fileName, format } = params;
+  const { request } = getDataObjectReportRequest(params);
+
+  return downloadRequest(request, {
+    fileName: `${fileName || dataObject}.${format}`,
+  });
+}

package/src/index.ts

@@ -1,4 +1,7 @@
 export { default as mitt } from "mitt";
+export { downloadBlob } from "./downloadBlob.js";
+export * from "./downloadRequest.js";
+export * from "./exportDataObject.js";
 export { default as expose } from "./expose.js";
 export { getLocalizedString } from "./getLocalizedString.js";
 export { default as localStorage } from "./localStorage.js";