@turndown/library 0.0.20 → 0.0.21

package/dist/helpers/index.js

@@ -0,0 +1,2 @@
+export * from "./object";
+export * from "./string";

package/dist/helpers/object/index.d.ts

@@ -0,0 +1,213 @@
+import { FilterCondition, SortCondition, TurndownObject } from "@/types/base";
+export interface Version {
+    major: number;
+    minor: number;
+    patch: number;
+}
+export type VersionInput = string | Version;
+/**
+ * Safely parse a JSON string into a value.
+ *
+ * Returns `{}` if parsing fails instead of throwing.
+ *
+ * @param {TurndownObject} jsonString - The JSON string to parse.
+ * @returns {TurndownObject} Parsed value or `{}` on failure.
+ * @example
+ * parseJSON('{"a":1}') // => { a: 1 }
+ * parseJSON('not json') // => {}
+ */
+export declare const parseJSON: (jsonString: TurndownObject) => TurndownObject;
+/**
+ * Stringify an object to JSON while skipping circular references.
+ *
+ * Uses an internal cache to omit repeated object references that would
+ * normally cause `JSON.stringify` to throw.
+ *
+ * @param {TurndownObject} obj - Value to stringify.
+ * @returns {string} JSON string with circulars omitted.
+ * @example
+ * const a:any = {}; a.self = a;
+ * JSONStringify(a) // => "{}"
+ */
+export declare const JSONStringify: (obj: TurndownObject) => string;
+/**
+ * Deep-remove `undefined` properties by serializing & parsing.
+ *
+ * @param {TurndownObject} obj - Input object.
+ * @returns {TurndownObject} Cleaned clone with `undefined` removed.
+ */
+export declare const removeUndefined: (obj: TurndownObject) => TurndownObject;
+/**
+ * Test whether a location object's `pathname` equals a key.
+ *
+ * @param {TurndownObject} location - Object expected to have a `pathname`.
+ * @param {string} key - Path to compare.
+ * @returns {boolean}
+ * @example
+ * validPath({ pathname: "/home" }, "/home") // true
+ */
+export declare const validPath: (location: TurndownObject, key: string) => boolean;
+/**
+ * Return the first element if the input is an array; otherwise return the value itself.
+ *
+ * @typeParam T - Element type.
+ * @param {T | T[]} input - A single value or an array.
+ * @returns {T} First element or the input value.
+ * @example
+ * returnObject([1,2,3]) // 1
+ * returnObject(5) // 5
+ */
+export declare const returnObject: <T>(input: T | T[]) => T;
+/**
+ * Filter out items from `array1` whose `id` appears in `array2`.
+ *
+ * @typeParam T - Object type with an `id` field.
+ * @param {T[]} [array1] - Source array.
+ * @param {T[]} [array2] - Items whose `id`s should be excluded.
+ * @returns {T[]} Filtered array (or `[]` on errors/invalid input).
+ */
+export declare const filterArrayById: <T extends {
+    id: number | string;
+}>(array1?: T[], array2?: T[]) => T[];
+/**
+ * Sort an array of objects by a given property (ascending).
+ *
+ * Mutates the original array (uses `Array.prototype.sort`).
+ *
+ * @typeParam T - Object type.
+ * @param {T[]} array - Array to sort.
+ * @param {keyof T} property - Property name to sort by.
+ * @returns {T[]} The same array instance, sorted (or empty array if input invalid).
+ */
+export declare const sortArrayByProperty: <T extends Record<string, any>>(array: T[], property: keyof T) => T[];
+/**
+ * Recursively replace `null` values with empty strings.
+ *
+ * Works on primitives, arrays, and plain objects.
+ *
+ * @param {TurndownObject} obj - Input value.
+ * @returns {TurndownObject} Value with all `null` replaced by `""`.
+ */
+export declare const replaceNulls: (obj: TurndownObject) => TurndownObject;
+/**
+ * Recursively remove object keys that contain a dot (`.`).
+ *
+ * @typeParam T - Object type.
+ * @param {T} obj - Input object.
+ * @returns {T} New object with dotted keys removed at all levels.
+ */
+export declare const removeFormProperties: <T extends Record<string, TurndownObject>>(obj: T) => T;
+/**
+ * Recursively convert string booleans `"true"`/`"false"` to actual booleans.
+ *
+ * Leaves all other values unchanged.
+ *
+ * @typeParam T - Object type.
+ * @param {T} obj - Input object or array.
+ * @returns {T} New value with boolean-like strings converted.
+ */
+export declare const convertStringBooleans: <T extends Record<string, any>>(obj: T) => T;
+/**
+ * Convenience helper to clean form-like data:
+ * - Removes `undefined` properties
+ * - Converts string booleans to booleans
+ * - Removes keys containing a dot ('.')
+ *
+ * @param {TurndownObject} obj - Input data.
+ * @returns {TurndownObject} Cleaned clone.
+ */
+export declare const cleanFormData: (obj: TurndownObject) => any;
+/**
+ * Return a default pagination object, allowing optional sort and filters.
+ *
+ * @param {SortCondition[]} [sort] - Optional sort conditions.
+ * @param {FilterCondition[]} [filters] - Optional filter conditions.
+ * @returns {{ page: number; size: number; sort: SortCondition[]; filters: FilterCondition[] }}
+ * @example
+ * resetPagination() // => { page:1, size:25, sort:[], filters:[] }
+ */
+export declare const resetPagination: (sort?: SortCondition[], filters?: FilterCondition[]) => {
+    page: number;
+    size: number;
+    sort: SortCondition[];
+    filters: FilterCondition[];
+};
+/**
+ * Format a string of digits into a U.S. phone number.
+ *
+ * Strips non-numeric characters and formats as `(XXX) XXX-XXXX`.
+ * If fewer than 10 digits are provided, returns the input unchanged.
+ *
+ * @param {string | number} value - Phone number digits (string or number).
+ * @returns {string} Formatted phone number, or original input if invalid length.
+ * @example
+ * formatPhoneNumber("1234567890") // "(123) 456-7890"
+ * formatPhoneNumber(9876543210)   // "(987) 654-3210"
+ * formatPhoneNumber("555")        // "555"
+ */
+export declare const formatPhoneNumber: (value: string | number) => string;
+/**
+ * Format a number with thousands separators (commas).
+ *
+ * @param {number} value - Number to format.
+ * @returns {string} String with commas.
+ * @example
+ * formatNumber(1234567) // "1,234,567"
+ */
+export declare const formatNumber: (value: number) => string;
+/**
+ * Parse a number string (note: current implementation adds commas as well).
+ *
+ * @remarks
+ * This function uses the same regex as `formatNumber`, so it **does not remove**
+ * commas; it inserts them. If you intended to *strip* separators, consider:
+ * `value.toString().replace(/,/g, "")`.
+ *
+ * @param {number} value - Number to "parse".
+ * @returns {string} Currently returns a comma-formatted string.
+ */
+export declare const parseNumber: (value: number) => string;
+/**
+ * Delete a property from an object if it exists (no-op if it doesn't).
+ *
+ * @param {TurndownObject} obj - Target object (mutated).
+ * @param {string} propertyName - Property to delete.
+ * @returns {void}
+ */
+export declare const deletePropertyIfExists: (obj: TurndownObject, propertyName: string) => void;
+/**
+ * Split an array into chunks of a given size.
+ *
+ * @typeParam T - Element type.
+ * @param {T[]} array - Source array.
+ * @param {number} chunkSize - Size of each chunk (no validation performed).
+ * @returns {T[][]} Array of chunks (last one may be smaller).
+ * @example
+ * chunkArray([1,2,3,4,5], 2) // [[1,2],[3,4],[5]]
+ */
+export declare const chunkArray: <T>(array: T[], chunkSize: number) => T[][];
+/**
+ * Return a shallow clone of `obj` without the listed properties.
+ *
+ * @param {TurndownObject} obj - Source object.
+ * @param {TurndownObject} propsToOmit - Iterable of property names (expects array-like).
+ * @returns {TurndownObject} New object without omitted props.
+ * @example
+ * omitProperties({a:1,b:2}, ["b"]) // { a:1 }
+ */
+export declare const omitProperties: (obj: TurndownObject, propsToOmit: TurndownObject) => any;
+/**
+ * Safe `hasOwnProperty` check.
+ *
+ * @param {Record<string, any>} obj - Object to test.
+ * @param {string} key - Property name.
+ * @returns {boolean}
+ */
+export declare const hasProperty: (obj: Record<string, any>, key: string) => boolean;
+/**
+ * Determine if an object has at least one own enumerable property.
+ *
+ * @param {object} obj - Object to test.
+ * @returns {boolean} `true` if there is at least one key.
+ */
+export declare const hasProperties: (obj: object) => boolean;

package/dist/helpers/string/index.d.ts

@@ -0,0 +1,104 @@
+import { TurndownObject } from "@/types/base";
+/**
+ * Convert a string to "Normal Case":
+ * - Inserts spaces between camel/pascal case boundaries
+ * - Capitalizes the first letter of each word, lowercases the rest
+ *
+ * @param {TurndownObject} [str] Input value (falsy returns an empty string)
+ * @returns {string}
+ * @example
+ * normalCase("helloWorld") // "Hello World"
+ * normalCase("XMLHttpRequest") // "Xml Http Request"
+ */
+export declare const normalCase: (str?: TurndownObject) => string;
+/**
+ * Capitalize only the first character; lowercases the rest.
+ * Trims leading/trailing spaces before processing.
+ *
+ * @param {TurndownObject} [str] Input value (falsy returns an empty string)
+ * @returns {string}
+ * @example
+ * sentenceCase("hELLO WORLD") // "Hello world"
+ */
+export declare const sentenceCase: (str?: TurndownObject) => string;
+/**
+ * Uppercase the entire string.
+ *
+ * @param {TurndownObject} [str] Input value (falsy returns an empty string)
+ * @returns {string}
+ * @example
+ * upperCase("Hello world") // "HELLO WORLD"
+ */
+export declare const upperCase: (str?: TurndownObject) => string;
+/**
+ * Lowercase the entire string.
+ *
+ * @param {TurndownObject} [str] Input value (falsy returns an empty string)
+ * @returns {string}
+ * @example
+ * lowerCase("Hello WORLD") // "hello world"
+ */
+export declare const lowerCase: (str?: TurndownObject) => string;
+/**
+ * Convert to camelCase.
+ * Splits on spaces, underscores, and hyphens; lowercases the first word,
+ * TitleCases the rest, then joins with no separators.
+ *
+ * @param {TurndownObject} [str] Input value (falsy returns an empty string)
+ * @returns {string}
+ * @example
+ * camelCase("Hello world") // "helloWorld"
+ * camelCase("hello_world-again") // "helloWorldAgain"
+ */
+export declare const camelCase: (str?: TurndownObject) => string;
+/**
+ * Convert to PascalCase.
+ * Splits on spaces, underscores, and hyphens; TitleCases all words and joins them.
+ *
+ * @param {TurndownObject} [str] Input value (falsy returns an empty string)
+ * @returns {string}
+ * @example
+ * pascalCase("hello world") // "HelloWorld"
+ * pascalCase("hello_world-again") // "HelloWorldAgain"
+ */
+export declare const pascalCase: (str?: TurndownObject) => string;
+/**
+ * Convert to kebab-case.
+ * Inserts hyphens between camelCase boundaries, then replaces spaces/underscores with hyphens.
+ *
+ * @param {TurndownObject} [str] Input value (falsy returns an empty string)
+ * @returns {string}
+ * @example
+ * kebabCase("HelloWorld Again") // "hello-world-again"
+ * kebabCase("hello_world") // "hello-world"
+ */
+export declare const kebabCase: (str?: TurndownObject) => string;
+/**
+ * Convert to snake_case.
+ * Inserts underscores between camelCase boundaries, then replaces spaces/hyphens with underscores.
+ *
+ * @param {TurndownObject} [str] Input value (falsy returns an empty string)
+ * @returns {string}
+ * @example
+ * snakeCase("HelloWorld Again") // "hello_world_again"
+ * snakeCase("hello-world") // "hello_world"
+ */
+export declare const snakeCase: (str?: TurndownObject) => string;
+/**
+ * Convert snake_case to space-delimited words.
+ *
+ * @param {TurndownObject} [str] Input value (falsy returns an empty string)
+ * @returns {string}
+ * @example
+ * snakeCaseToSpaces("hello_world_again") // "hello world again"
+ */
+export declare const snakeCaseToSpaces: (str?: TurndownObject) => string;
+/**
+ * Convert kebab-case to space-delimited words.
+ *
+ * @param {TurndownObject} [str] Input value (falsy returns an empty string)
+ * @returns {string}
+ * @example
+ * kebabToSpaces("hello-world-again") // "hello world again"
+ */
+export declare const kebabToSpaces: (str?: TurndownObject) => string;

package/dist/index.js

@@ -0,0 +1,2 @@
+export * from "./helpers";
+export * from "./types";

package/dist/types/base/index.d.ts

@@ -0,0 +1,18 @@
+export type GenericTurndownObject = Record<string, any> | any | undefined;
+export type TurndownObject<T = GenericTurndownObject> = Record<string, T> | T | undefined;
+export type ObjectValues<T> = T[keyof T];
+export type ObjectKeys<T> = [keyof T];
+export interface MetaData {
+    company_id: string;
+    deleted: boolean;
+    updated_by: string;
+    created_by: string;
+    created_at: Date;
+    updated_at: Date;
+}
+export declare const STATUS: {
+    readonly ACTIVE: "ACTIVE";
+    readonly INACTIVE: "INACTIVE";
+};
+export type Status = ObjectValues<typeof STATUS>;
+export * from "./paging.types";

package/dist/types/base/paging.types.d.ts

@@ -0,0 +1,30 @@
+export interface PagingResult {
+    hasNextPage: boolean;
+    totalPages: number;
+    totalRecords: number;
+}
+export interface DataWithPagingResult<T> {
+    data: T;
+    pagination: PagingResult;
+}
+export interface SortCondition {
+    name: string;
+    direction: "ASC" | "DESC";
+}
+export interface FilterCondition {
+    name: string;
+    condition: "=" | ">" | "<" | "!=" | "LIKE" | "IN" | ">=" | "<=";
+    valueString?: string;
+    valueNumber?: number;
+    valueBoolean?: boolean;
+    useAnd?: boolean;
+}
+export interface PaginationRequest {
+    page: number;
+    size: number;
+    sort?: SortCondition[];
+    filters?: FilterCondition[];
+}
+export declare const createPagingObject: (page: number, size: number, sort?: SortCondition[], filters?: FilterCondition[]) => {
+    pagination: any;
+};

package/dist/types/index.js

@@ -0,0 +1,2 @@
+export * from "./user";
+export * from "./base";

package/dist/types/user/index.d.ts

@@ -0,0 +1,37 @@
+import { MetaData, ObjectValues, Status } from "@/types";
+export interface User extends Omit<MetaData, "created_by" | "updated_by"> {
+    id: string;
+    firstName: string;
+    lastName: string;
+    mi: string;
+    username: string;
+    email: string;
+    password: string;
+    loginAttempts: number;
+    locked: boolean;
+    passwordLastReset: Date;
+    passwordResetRequired: boolean;
+    type: AccountType;
+    status: Status;
+    companyId: number;
+    phoneNumber: string;
+    phoneFormat: string;
+    language: Language;
+    biometrics: string;
+    lastLogin: Date;
+}
+export declare const ACCOUNT_TYPE: {
+    readonly TURNDOWN_ADMIN: "TURNDOWN_ADMIN";
+    readonly OWNER: "OWNER";
+    readonly ACCOUNT_ADMIN: "ACCOUNT_ADMIN";
+    readonly MAINTAINER: "MAINTAINER";
+    readonly CLEANER: "CLEANER";
+};
+export type AccountType = ObjectValues<typeof ACCOUNT_TYPE>;
+export declare const LANGUAGE: {
+    readonly ENGLISH: "ENGLISH";
+    readonly FRENCH: "FRENCH";
+    readonly SPANISH: "SPANISH";
+    readonly GERMAN: "GERMAN";
+};
+export type Language = ObjectValues<typeof LANGUAGE>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@turndown/library",
-  "version": "0.0.20",
+  "version": "0.0.21",
   "description": "Shared TypeScript library for the Turndown suite.",
   "keywords": [
     "types",
@@ -19,8 +19,8 @@
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "import": "./dist/index.js",
-      "default": "./dist/index.js"
+      "import": "./dist/index.ts",
+      "default": "./dist/index.ts"
     },
     "./package.json": "./package.json"
   },

package/dist/package.json

@@ -1,45 +0,0 @@
-{
-    "name": "@turndown/library",
-    "version": "0.0.20",
-    "description": "Shared TypeScript library for the Turndown suite.",
-    "keywords": [
-        "types",
-        "typescript",
-        "turndown"
-    ],
-    "license": "MIT",
-    "repository": {
-        "type": "git",
-        "url": "git@github.com:Turndown-App/turndown-library.git"
-    },
-    "publishConfig": {
-        "access": "public"
-    },
-    "type": "module",
-    "exports": {
-        ".": {
-            "types": "./dist/index.d.ts",
-            "import": "./dist/index.js",
-            "default": "./dist/index.js"
-        },
-        "./package.json": "./package.json"
-    },
-    "types": "./dist/index.d.ts",
-    "files": [
-        "dist",
-        "LICENSE",
-        "README.md"
-    ],
-    "scripts": {
-        "clean": "rimraf dist",
-        "build": "npm run clean && tsc -p .",
-        "dev": "tsc -w -p .",
-        "release": "npm run clean && changeset version && npm install --no-frozen-lockfile && npm run build",
-        "publish:ci": "npm run release && changeset publish"
-    },
-    "devDependencies": {
-        "@changesets/cli": "^2.29.7",
-        "rimraf": "^6.0.1",
-        "typescript": "^5.9.3"
-    }
-}