@olenbetong/appframe-core 1.3.6 → 2.0.0

package/es/UserSession.js

@@ -3,10 +3,14 @@ export default class UserSession extends SessionHandler {
     constructor(userData) {
         super();
         this.decimalSeparator = ".";
+        this.domain = "OB";
         this.groupSeparator = null;
         this.shortDateFormat = "dd.MM.yyyy";
-        this.login = null;
+        this.login = "";
         this.isDeveloper = false;
+        this.culture = "en-GB";
+        this.uiculture = "en-GB";
+        this.expired = () => null;
         this.formats = {};
         Object.assign(this, userData);
     }

package/es/index.d.ts

@@ -1,14 +1,42 @@
 import "./errorHandler.js";
+import UserSession from "./UserSession.js";
 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 * from "./has.js";
 export { default as localStorage } from "./localStorage.js";
 export { default as SessionHandler } from "./SessionHandler.js";
-export { default as UserSession } from "./UserSession.js";
-export { formDataToDataObjectRecord, formDataToObject, formDataToProcedureParameters } from "./formDataToObject.js";
+export { UserSession };
 export * from "./settings.js";
 export declare const version: string;
+declare global {
+    var __VERSION__: string;
+    var __DEV__: number;
+    var af: AfCore;
+    interface Window {
+        af: AfCore;
+    }
+}
+export interface AfArticle {
+    hostName: string;
+    i18n: Record<string, string>;
+    id: string;
+}
+export interface AfCore {
+    article: AfArticle;
+    common?: {
+        getLocalizedString?: (string: string) => string;
+    };
+    controls?: {
+        alert?: (message: string, callback?: () => void) => void;
+        confirm?: (options: {
+            title: string;
+            message: string;
+            buttons: string[];
+            callback: (button: number) => void;
+        }) => void;
+    };
+    userSession: UserSession;
+}

package/es/index.js

@@ -1,14 +1,13 @@
 import "./errorHandler.js";
+import UserSession from "./UserSession.js";
 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 * from "./has.js";
 export { default as localStorage } from "./localStorage.js";
 export { default as SessionHandler } from "./SessionHandler.js";
-export { default as UserSession } from "./UserSession.js";
-export { formDataToDataObjectRecord, formDataToObject, formDataToProcedureParameters } from "./formDataToObject.js";
+export { UserSession };
 export * from "./settings.js";
-export const version = "1.3.6";
+export const version = "2.0.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@olenbetong/appframe-core",
-  "version": "1.3.6",
+  "version": "2.0.0",
   "description": "Javascript libraries to utilize the Appframe framework",
   "type": "module",
   "sideEffects": [
@@ -48,5 +48,5 @@
   "devDependencies": {
     "chalk": "^5.0.1"
   },
-  "gitHead": "8ea6dc3c1d3b7fe2e49dfd5c67a561344bb877e9"
+  "gitHead": "c415b5b6c68bb08712e38d9f91a01122c14e78a0"
 }

package/src/UserSession.ts

@@ -2,11 +2,15 @@ import SessionHandler from "./SessionHandler.js";
 
 export default class UserSession extends SessionHandler {
   decimalSeparator: string = ".";
+  domain: string = "OB";
   formats: any;
   groupSeparator: string | null = null;
   shortDateFormat: string = "dd.MM.yyyy";
-  login: string | null = null;
+  login: string = "";
   isDeveloper: boolean = false;
+  culture: string = "en-GB";
+  uiculture: string = "en-GB";
+  expired: (callback: () => void) => void = () => null;
 
   constructor(userData: any) {
     super();

package/src/index.ts

@@ -1,16 +1,49 @@
 import "./errorHandler.js";
 
+import UserSession from "./UserSession.js";
+
 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 * from "./has.js";
 export { default as localStorage } from "./localStorage.js";
 export { default as SessionHandler } from "./SessionHandler.js";
-export { default as UserSession } from "./UserSession.js";
-export { formDataToDataObjectRecord, formDataToObject, formDataToProcedureParameters } from "./formDataToObject.js";
+export { UserSession };
 export * from "./settings.js";
 
 export const version = __VERSION__;
+
+declare global {
+  var __VERSION__: string;
+  var __DEV__: number;
+  var af: AfCore;
+
+  interface Window {
+    af: AfCore;
+  }
+}
+
+export interface AfArticle {
+  hostName: string;
+  i18n: Record<string, string>;
+  id: string;
+}
+
+export interface AfCore {
+  article: AfArticle;
+  common?: {
+    getLocalizedString?: (string: string) => string;
+  };
+  controls?: {
+    alert?: (message: string, callback?: () => void) => void;
+    confirm?: (options: {
+      title: string;
+      message: string;
+      buttons: string[];
+      callback: (button: number) => void;
+    }) => void;
+  };
+  userSession: UserSession;
+}

package/es/exportDataObject.d.ts

@@ -1,73 +0,0 @@
-import { DataObject, DataObjectOptions, FieldDefinition } 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>["parameters"] & {
-    columns: FieldDefinition[];
-}>): {
-    distinctRows: boolean | undefined;
-    fields?: FieldDefinition[] | undefined;
-    filterObject: import("@olenbetong/appframe-data").Filter | undefined;
-    filterString: string | undefined;
-    masterChildCriteria?: Partial<any> | undefined;
-    maxRecords: number | undefined;
-    skip?: number | undefined;
-    sortOrder: Record<string | number | symbol, import("@olenbetong/appframe-data").SortOrder>[] | undefined;
-    uniqueName?: string | undefined;
-    returnTotal?: boolean | undefined;
-    whereClause: string | undefined;
-    whereObject: import("@olenbetong/appframe-data").Filter | undefined;
-    columns: {
-        name: string;
-    }[];
-};
-/**
- * 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

@@ -1,61 +0,0 @@
-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/formDataToObject.d.ts

@@ -1,26 +0,0 @@
-import type { DataObject, Procedure } from "@olenbetong/appframe-data";
-/**
- * Creates an object from form data. Uses the type map passed to convert the form values to the correct type.
- * @param form HTML form element to get form data from.
- * @param typeMap A mapping from field name to field type
- * @returns
- */
-export declare function formDataToObject<T = any>(form: HTMLFormElement, typeMap?: Record<string, string>): Partial<T>;
-/**
- * Creates a partial data object record from form data. The name property is mapped
- * to field name.
- *
- * @param form HTML form element to get FormData from
- * @param dataObject Data object for which to create a record from the form data
- * @returns {Partial<T>} Partial data object record
- */
-export declare function formDataToDataObjectRecord<T>(form: HTMLFormElement, dataObject: DataObject<T>): Partial<T>;
-/**
- * Creates procedure parameters from form data. The name property is mapped
- * to parameter names.
- *
- * @param form HTML Form element to get FormData from
- * @param procedure Appframe Procedure to create parameters for
- * @returns
- */
-export declare function formDataToProcedureParameters<T>(form: HTMLFormElement, procedure: Procedure<T, any>): T;

package/es/formDataToObject.js

@@ -1,73 +0,0 @@
-function getFormValue(value, type) {
-    if (value === "") {
-        return null;
-    }
-    else if (type === "number") {
-        let numValue = Number(value);
-        return isNaN(numValue) ? undefined : numValue;
-    }
-    else if (["date", "datetime", "time"].includes(type)) {
-        let dateValue = new Date(value);
-        return isNaN(dateValue.getTime()) ? undefined : dateValue;
-    }
-    else if (type === "boolean") {
-        return value.toLowerCase() === "true";
-    }
-    else if (type === "bigint") {
-        return BigInt(value);
-    }
-    return value;
-}
-/**
- * Creates an object from form data. Uses the type map passed to convert the form values to the correct type.
- * @param form HTML form element to get form data from.
- * @param typeMap A mapping from field name to field type
- * @returns
- */
-export function formDataToObject(form, typeMap = {}) {
-    let formData = new FormData(form);
-    let result = {};
-    for (let entry of formData.entries()) {
-        let field = entry[0];
-        let type = typeMap?.[field] ?? "string";
-        let value = getFormValue(entry[1], type);
-        if (result.hasOwnProperty(field)) {
-            if (Array.isArray(result[field])) {
-                result[field].push(value);
-            }
-            else {
-                result[field] = [result[field], value];
-            }
-        }
-        else {
-            result[field] = value;
-        }
-    }
-    return result;
-}
-/**
- * Creates a partial data object record from form data. The name property is mapped
- * to field name.
- *
- * @param form HTML form element to get FormData from
- * @param dataObject Data object for which to create a record from the form data
- * @returns {Partial<T>} Partial data object record
- */
-export function formDataToDataObjectRecord(form, dataObject) {
-    let fields = dataObject.getFields();
-    let types = Object.fromEntries(fields.map((field) => [field.name, field.type]));
-    return formDataToObject(form, types);
-}
-/**
- * Creates procedure parameters from form data. The name property is mapped
- * to parameter names.
- *
- * @param form HTML Form element to get FormData from
- * @param procedure Appframe Procedure to create parameters for
- * @returns
- */
-export function formDataToProcedureParameters(form, procedure) {
-    let parameters = procedure.getParameters();
-    let types = Object.fromEntries(parameters.map((param) => [param.name, param.type]));
-    return formDataToObject(form, types);
-}

package/src/exportDataObject.ts

@@ -1,110 +0,0 @@
-import { DataObject, DataObjectOptions, FieldDefinition } 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>["parameters"] & { columns: FieldDefinition[] }>
-) {
-  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/formDataToObject.ts

@@ -1,80 +0,0 @@
-import type { DataObject, Procedure } from "@olenbetong/appframe-data";
-
-function getFormValue(value: string, type: string): string | number | boolean | Date | BigInt | null | undefined {
-  if (value === "") {
-    return null;
-  } else if (type === "number") {
-    let numValue = Number(value);
-
-    return isNaN(numValue) ? undefined : numValue;
-  } else if (["date", "datetime", "time"].includes(type)) {
-    let dateValue = new Date(value);
-
-    return isNaN(dateValue.getTime()) ? undefined : dateValue;
-  } else if (type === "boolean") {
-    return value.toLowerCase() === "true";
-  } else if (type === "bigint") {
-    return BigInt(value);
-  }
-
-  return value;
-}
-
-/**
- * Creates an object from form data. Uses the type map passed to convert the form values to the correct type.
- * @param form HTML form element to get form data from.
- * @param typeMap A mapping from field name to field type
- * @returns
- */
-export function formDataToObject<T = any>(form: HTMLFormElement, typeMap: Record<string, string> = {}): Partial<T> {
-  let formData = new FormData(form);
-  let result: any = {};
-
-  for (let entry of formData.entries()) {
-    let field = entry[0];
-    let type = typeMap?.[field] ?? "string";
-    let value = getFormValue(entry[1] as string, type);
-
-    if (result.hasOwnProperty(field)) {
-      if (Array.isArray(result[field])) {
-        result[field].push(value);
-      } else {
-        result[field] = [result[field], value];
-      }
-    } else {
-      result[field] = value;
-    }
-  }
-
-  return result as T;
-}
-
-/**
- * Creates a partial data object record from form data. The name property is mapped
- * to field name.
- *
- * @param form HTML form element to get FormData from
- * @param dataObject Data object for which to create a record from the form data
- * @returns {Partial<T>} Partial data object record
- */
-export function formDataToDataObjectRecord<T>(form: HTMLFormElement, dataObject: DataObject<T>): Partial<T> {
-  let fields = dataObject.getFields();
-  let types = Object.fromEntries(fields.map((field) => [field.name, field.type])) as Record<string, string>;
-
-  return formDataToObject<T>(form, types);
-}
-
-/**
- * Creates procedure parameters from form data. The name property is mapped
- * to parameter names.
- *
- * @param form HTML Form element to get FormData from
- * @param procedure Appframe Procedure to create parameters for
- * @returns
- */
-export function formDataToProcedureParameters<T>(form: HTMLFormElement, procedure: Procedure<T, any>): T {
-  let parameters = procedure.getParameters();
-  let types = Object.fromEntries(parameters.map((param) => [param.name, param.type])) as Record<string, string>;
-
-  return formDataToObject(form, types) as T;
-}

package/src/global.d.ts

@@ -1,56 +0,0 @@
-import {
-  AfDataObject,
-  DataHandler,
-  DataObject,
-  Procedure,
-  ProcedureAPI,
-} from "@olenbetong/appframe-data";
-import UserSession from "./UserSession.js";
-
-export type Appframe = {
-  article: {
-    dataObjects?: Record<string, DataObject<any>>;
-    i18n: Record<string, string>;
-    id: string;
-    hostName: string;
-  };
-  common?: {
-    getLocalizedString?: (string: string) => string;
-  };
-  controls?: {
-    alert?: (message: string, callback?: () => void) => void;
-    confirm?: (options: {
-      title: string;
-      message: string;
-      buttons: string[];
-      callback: (button: number) => void;
-    }) => void;
-  };
-  data?: {
-    [index: string]: { new (options?: any): DataHandler<any> };
-  } & { version?: string };
-  DataObject?: {
-    new <T>(options: any): DataObject<T>;
-    getByID?: (name: string) => AfDataObject<unknown> | null;
-  };
-  Procedure?: { new <T, V>(options: any): Procedure<T, V> };
-  ProcedureAPI?: { new <T, V>(options: any): ProcedureAPI<T, V> };
-  userSession: UserSession;
-  template: {
-    loop: (template: string, data: any, custom?: any) => string;
-    run: (template: string, row: any, custom?: any) => string;
-    run2: (
-      template: string,
-      currentRow: any,
-      previousRow?: any,
-      state?: any,
-      custom?: any
-    ) => string;
-  };
-};
-
-declare global {
-  var __VERSION__: string;
-  var __DEV__: number;
-  var af: Appframe;
-}