dphelper 3.0.6 → 3.0.7

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "dphelper",
-  "version": "3.0.6",
+  "version": "3.0.7",
   "type": "module",
   "main": "index.js",
   "browser": "./dist/dphelper.umd.js",
   "description": "dphelper devtools for developers",
   "license": "MIT",
-  "types": "./types/index.d.ts",
+  "types": "./types/dphelper.d.ts",
   "typings": "./types/*",
   "copyright": "Dario Passariello",
   "homepage": "https://a51.gitbook.io/dphelper",
@@ -65,17 +65,18 @@
   ],
   "exports": {
     ".": {
-      "types": "./types/index.d.ts",
+      "types": "./types/dphelper.d.ts",
       "import": "./index.js",
       "default": "./index.js"
     },
     "./types/*": "./types/*"
   },
   "scripts": {
-    "build": "rimraf dist && npm run generate-imports && node esbuild.config.mjs && node node_modules/typescript/bin/tsc -p tsconfig.json --emitDeclarationOnly",
+    "build": "rimraf dist && npm run generate-imports && node esbuild.config.mjs && node node_modules/typescript/bin/tsc -p tsconfig.json --emitDeclarationOnly && node scripts/patch-dist.mjs",
     "dev": "npm run generate-imports && node esbuild.config.mjs --watch-and-serve",
     "npm:pack": "npm run build && cd dist && npm pack",
     "npm:publish": "npm run build && npm publish ./dist --access public",
+    "postinstall": "node postinstall.mjs",
     "test": "cd tests && npm run test",
     "lint": "cd tests && npm run lint",
     "tsc": "cd tests && tsc --noEmit",

package/postinstall.mjs

@@ -0,0 +1,23 @@
+// dphelper postinstall
+// Creates node_modules/@types/dphelper/index.d.ts automatically so TypeScript
+// discovers dphelper's global types without any configuration in the consumer project.
+import fs from 'node:fs'
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+const
+  __dirname = path.dirname(fileURLToPath(import.meta.url)),
+  // When postinstall runs, cwd is the consuming project root.
+  // __dirname is node_modules/dphelper/
+  atTypesDir = path.join(__dirname, '..', '@types', 'dphelper'),
+  atTypesFile = path.join(atTypesDir, 'index.d.ts'),
+  reference = '/// <reference path="../../dphelper/types/dphelper.d.ts" />\n'
+
+try {
+  fs.mkdirSync(atTypesDir, { recursive: true })
+  fs.writeFileSync(atTypesFile, reference, 'utf8')
+  console.debug('[dphelper] Global types registered at node_modules/@types/dphelper/index.d.ts')
+} catch (e) {
+  // Non-fatal: types can still be referenced manually
+  console.debug('[dphelper] Could not auto-register types:', e)
+}

package/tools/ai/interface.d.ts

@@ -0,0 +1,12 @@
+interface AiTool {
+  tokenCount: (data: any) => number
+  smartSanitize: (text: string) => string
+  toon: (data: any) => string
+  toonToJson: (toon: string) => any
+  chunker: (text: string, options?: { size?: number, overlap?: number }) => string[]
+  similarity: (a: number[], b: number[]) => number
+  extractReasoning: (text: string) => { reasoning: string, content: string }
+  prompt: (template: string, vars: Record<string, any>) => string
+  schema: (data: any) => string
+  snapshot: () => string
+}

package/tools/anchor/interface.d.ts

@@ -0,0 +1,7 @@
+interface AnchorTool {
+  /**
+   * Converts anchor tags to onClick events
+   * @param selector - CSS selector for target elements
+   */
+  toOnClick(selector: string): void
+}

package/tools/array/interface.d.ts

@@ -0,0 +1,22 @@
+interface ArrayTool {
+  find<T>(array: T[], key: any): T | any
+  unique<T>(array: T[]): T[]
+  delete<T>(array: T[], key: keyof T): void
+  merge<T>(arrayA: T[], arrayB: T[]): T[]
+  mergeByKey<T extends Record<string, any>>(arrayA: T[], arrayB: T[], key: keyof T): T[]
+  asc<T>(array: T[]): T[]
+  desc<T>(array: T[]): T[]
+  duplicates<T>(array: T[]): T[]
+  even<T>(array: T[]): T[]
+  odd<T>(array: T[]): T[]
+  toObj<T>(array: T[]): Record<string, T>
+  sumColumn(array: number[][], column: number): number
+  shuffle<T>(array: T[]): T[]
+  generate(num: number): number[]
+  testArrayInt(array: unknown[]): number[]
+  rand32(number: number): number
+  findindex<T>(array: T[], key: any): number
+  pathToJson(array: string[], separator?: string): Record<string, unknown>
+  deepClone<T>(src: T): T
+  match(arrayWords: string[], arrayToCheck: string[]): boolean
+}

package/tools/audio/interface.d.ts

@@ -0,0 +1,11 @@
+interface AudioTool {
+  /**
+   * Plays an audio file if it is not already playing.
+   * If no file is specified, removes all audio elements from the document.
+   *
+   * @param file - The name of the audio file to play.
+   * @param path - The path to the audio file.
+   * @param loop - Whether the audio should loop.
+   */
+  play: (file?: string, path?: string, loop?: boolean) => void
+}

package/tools/avoid/interface.d.ts

@@ -0,0 +1,3 @@
+interface AvoidTool {
+  cache: (uri: string) => string
+}

package/tools/browser/interface.d.ts

@@ -0,0 +1,11 @@
+interface BrowserTool {
+  state(state: any, title: any, url: any): void
+  forw(times: number): void
+  back(times: number): void
+  reload(): void
+  href(url: string): void
+  offLine(text?: string): void
+  zoom(): number
+  status(code: number): string
+  interlock(onUpdate: (tabs: number) => void): void
+}

package/tools/check/interface.d.ts

@@ -0,0 +1,5 @@
+interface CheckTool {
+  url: (url: string) => any
+  version: (v1: string, v2: string, opts?: any) => any
+  npmVer: (npm: string) => any
+}

package/tools/color/interface.d.ts

@@ -0,0 +1,7 @@
+interface ColorTool {
+  hex: (c: any) => string
+  toHex: (rgb: any) => string
+  toRGB: (c: any) => number[]
+  oleColor: (c: any) => string
+  gradient: (colorStart: any, colorEnd: any, colorCount: any) => any
+}

package/tools/cookie/interface.d.ts

@@ -0,0 +1,13 @@
+interface CookieTool {
+  set: (pars: {
+    name: any,
+    value: any,
+    time?: any,
+    path?: string,
+    sameSite?: string,
+    secure?: string
+  }) => any
+  get: (name: string) => any
+  delete: (name: string) => any
+  removeAll: () => any
+}

package/tools/coords/interface.d.ts

@@ -0,0 +1,9 @@
+interface CoordsTool {
+  degreesToRadians: (degrees: any) => any
+  latToMeters: (points: any) => any
+  toVector: (points: any) => any
+  convertToDecDegrees: (deg: any, minutes: any, sec: any, direction: any) => any
+  distance: (point1: any, point2: any) => any
+  polarToCartesian: (centerX: any, centerY: any, radius: any, angleInDegrees: any) => any
+  mapDegreesToPixels: (degree: number, minDegree: number, maxDegree: number, minPixel: number, maxPixel: number, padding: number) => number
+}

package/tools/credits/interface.d.ts

@@ -0,0 +1,12 @@
+interface Credits {
+  name: string
+  version: string
+  description: string
+  license: string
+  author: {
+    name: string
+    email: string
+  }
+}
+
+type CreditsTool = (props: Credits) => void

package/tools/date/interface.d.ts

@@ -0,0 +1,26 @@
+interface DateTool {
+  days: (lang?: string) => string[]
+  months: (lang?: string) => string[]
+  year: () => number
+  toIso: (value: any, int?: string) => string | null
+  toMMDDYYYY: (value: any) => string
+  toYYYYMMDD: (value: any) => string | undefined
+  toHuman: (value: any) => string
+  convert: (value: any, format: string[]) => string | null
+  iso2Epoch: (value: any) => number
+  localIsoTime: (value: any) => string
+  utc: () => string
+  parse: (value: any, separator?: string) => string | null
+  addDays: (date: any, days: number) => Date
+  dateTimeToString: (dateObject: any) => string
+  isoToHuman: (value: any, symbol?: string) => string | null
+  fullDate: () => string
+  epoch: () => number
+  diffInDays: (d1: any, d2: any) => number
+  diffInWeeks: (d1: any, d2: any) => number
+  diffInMonths: (d1: any, d2: any) => number
+  diffInYears: (d1: any, d2: any) => number
+  dateToYMD: (date: any) => string
+  collection: (params: { date?: Date; type: string; locale?: string }) => string | undefined
+  timeZones: () => string[]
+}

package/tools/disable/interface.d.ts

@@ -0,0 +1,9 @@
+interface DisableTool {
+  select: (el?: string) => void
+  spellCheck: (tmr?: number) => void
+  rightClick: (el?: string) => void
+  copy: (el?: string) => void
+  paste: (el?: string) => void
+  cut: (el?: string) => void
+  drag: (el?: string) => void
+}

package/tools/dispatch/interface.d.ts

@@ -0,0 +1,5 @@
+interface DispatchTool {
+  set: (name: string, value?: any) => void
+  listen: (name: string, cb?: (e: Event) => void, flag?: boolean) => void
+  remove: (name: string) => void
+}

package/tools/elements/interface.d.ts

@@ -0,0 +1,4 @@
+interface ElementsTool {
+  fitScale: (el: any, scale?: number, fit?: boolean) => void
+  scaleBasedOnWindow: (elm: any, scale: number, fit: boolean) => void
+}

package/tools/events/interface.d.ts

@@ -0,0 +1,7 @@
+interface EventsTool {
+  list: (el: Element) => any
+  multi: (element: Element, eventNames: string, listener: EventListener) => void
+  copy: (el: string) => void
+  onDrag: (elem: string) => void
+  keys: (e: KeyboardEvent) => { key: string; ctrl: boolean; alt: boolean; shift: boolean }
+}

package/tools/fetch/interface.d.ts

@@ -0,0 +1,16 @@
+interface FetchTool {
+  /**
+   * Perform a resilient fetch with automatic retries and exponential backoff.
+   */
+  (url: string, options?: any, retries?: number, backoff?: number): Promise<Response>
+
+  /**
+   * Perform a GET request.
+   */
+  get: (url: string, options?: any) => Promise<Response>
+
+  /**
+   * Perform a POST request with optional JSON body auto-serialization.
+   */
+  post: (url: string, body: any, options?: any) => Promise<Response>
+}

package/tools/form/interface.d.ts

@@ -0,0 +1,14 @@
+interface FormTool {
+  serialize: (form: HTMLFormElement) => { [key: string]: any }
+  confirmType: (type: string, value: any) => boolean
+  required: (value: any) => string | undefined
+  minLength: (value: any, num?: number) => string | undefined
+  maxLength: (value: any, num?: number) => string | undefined
+  maxPhoneNumber: (value: any, num?: number) => string | undefined
+  isNumeric: (value: any) => boolean
+  isEmail: (value: any) => boolean
+  pattern: (e: Event) => void
+  noSpecialChars: (e: Event) => void
+  table: (size: [number, number], id: string, elem: HTMLElement) => void
+  sanitize: (str: string) => string | undefined
+}

package/tools/format/interface.d.ts

@@ -0,0 +1,4 @@
+interface FormatTool {
+  currency: (value: number, locale?: string, currency?: string) => string
+  phoneNumber: (value: string, countryCode?: string) => string
+}

package/tools/json/interface.d.ts

@@ -0,0 +1,9 @@
+interface JsonTool {
+  counter: (json: any, key?: string, val?: any) => number | null
+  toCsv: (jsonInput: any) => string
+  saveCsvAs: (csvData: string, fileName: string) => void
+  is: (str: string) => boolean
+  parse: (file: string) => any
+  sanitize: (str: string) => string
+  sanitizeJsonValue: (str: string) => string
+}

package/tools/load/interface.d.ts

@@ -0,0 +1,9 @@
+interface LoadTool {
+  all: (context: any, cacheName?: string) => void
+  file: (filePath: string) => Promise<string>
+  fileToElement: (elementSelector: string, filePath: string) => Promise<void>
+  json: (filePath: string) => Promise<any>
+  remote: (path: string, method?: string, headers?: HeadersInit) => Promise<any>
+  script: (scripts: string[], elementSelector?: string) => void
+  toJson: (context: any, cacheName?: string) => void
+}

package/tools/logging/interface.d.ts

@@ -0,0 +1,9 @@
+interface LoggingTool {
+  list: {
+    type: string
+    message: string
+  }[]
+  reg: (txt: string) => void
+  debug: (txt: string) => void
+  error: (txt: string) => void
+}

package/tools/math/interface.d.ts

@@ -0,0 +1,14 @@
+interface MathTool {
+  rnd: () => number
+  tmr: () => number
+  add: (a: number, b: number) => number
+  sub: (a: number, b: number) => number
+  multi: (a: number, b: number) => number
+  div: (a: number, b: number) => number
+  rem: (a: number, b: number) => number
+  exp: (a: number, b: number) => number
+  isOdd: (a: number) => boolean
+  float2int: (a: number) => number
+  percent: (n: number, tot: number) => number
+  isPrime: (n: number) => boolean
+}

package/tools/memory/interface.d.ts

@@ -0,0 +1,4 @@
+interface MemoryTool {
+  lock: (obj: string) => void
+  unlock: (obj: string) => void
+}

package/tools/navigation/interface.d.ts

@@ -0,0 +1,5 @@
+interface NavigationTool {
+  load(url: string): Promise<void>
+  ajax(): void
+  ajax_running?: boolean
+}

package/tools/objects/interface.d.ts

@@ -0,0 +1,16 @@
+interface ObjectsTool {
+  toArray: (object: Record<string, any>) => [string, any][]
+  replaceNullObjects: (data: Record<string, any>) => Record<string, any>
+  serialize: (value: any) => any
+  deSerialize: (valueNew: any) => any
+  sort: (o: Record<string, any>) => Record<string, any>
+  toXML: (obj: Record<string, any>) => string
+  find: (array: any[], key: string, value: any) => any
+  instance: (obj: any) => any
+  updateByKey: (obj: Record<string, any>, key: string, newValue: any) => Record<string, any>
+  findindex: (array: any[], key: string) => number
+  parse: (val: any) => any
+  isObject: (val: any) => boolean
+  diff: (obj1: Record<string, any>, obj2: Record<string, any>) => Record<string, { obj1: any, obj2: any }>
+  path: (prop: string, array: string[], separator?: string) => string
+}

package/tools/path/interface.d.ts

@@ -0,0 +1,5 @@
+interface PathTool {
+  rail: () => string[]
+  hash: () => string[]
+  query: (url: string) => Record<string, string>
+}

package/tools/promise/interface.d.ts

@@ -0,0 +1,4 @@
+interface PromiseTool {
+  check: (p: any) => boolean
+  resolve: (data: any) => Promise<any>
+}

package/tools/sanitize/interface.d.ts

@@ -0,0 +1,3 @@
+interface SanitizeTool {
+  html: (s: string) => string
+}

package/tools/screen/interface.d.ts

@@ -0,0 +1,12 @@
+interface ScreenTool {
+  fullScreen: (el: string) => void
+  toggle: (el: string) => void
+  info: () => {
+    width: number
+    height: number
+    availWidth: number
+    availHeight: number
+    colorDepth: number
+    pixelDepth: number
+  }
+}

package/tools/scrollbar/interface.d.ts

@@ -0,0 +1,10 @@
+interface ScrollbarTool {
+  custom: (el: string, options: any) => void
+  indicator: (props: any) => void
+  position: {
+    get: (el: any) => void
+    set: (el: any) => void
+  }
+  smooth: (target: any, speed: any, smooth: any) => void
+  scrollTo: (container: string, element: string, gap?: number) => void
+}

package/tools/security/interface.d.ts

@@ -0,0 +1,12 @@
+interface SecurityTool {
+  uuid: {
+    byVal: (string: string) => string
+    v4: string
+    v5: string
+  }
+  hashPass: (u: string, p: string, t?: string) => Promise<string>
+  crypt: (u: string, p: string, mode?: string) => string
+  deCrypt: (u: string, p: string, mode?: string) => string
+  AES_KeyGen: (passKey?: string) => string
+  SHA256_Hex: (passKey: string) => string
+}

package/tools/shortcut/interface.d.ts

@@ -0,0 +1,3 @@
+interface ShortcutTool {
+  keys: (e: any, trigger: any) => void
+}

package/tools/socket/interface.d.ts

@@ -0,0 +1,13 @@
+interface SocketTool {
+  info: () => string
+  start: (element: any, server: any, name: string) => void
+  conn: (id: any, server: any, name: string) => void
+  connect: (server: any, name: string) => void
+  open: (id: any, server: any, name: string) => void
+  send: (mex: any, type?: string) => void
+  ping: (name: string) => void
+  receive: (el?: any, name?: string) => void
+  keepAlive: (name: string) => void
+  check: () => void
+  list: () => WebSocket[]
+}

package/tools/sse/interface.d.ts

@@ -0,0 +1,9 @@
+interface SseTool {
+  /**
+   * Opens an SSE connection with support for custom fetch options (POST, Headers, etc).
+   */
+  open(url: string, options?: any): {
+    on(event: "message" | "error" | "open", cb: (data: any) => void): void
+    close(): void
+  }
+}

package/tools/svg/interface.d.ts

@@ -0,0 +1,13 @@
+interface SvgTool {
+  init: (container: HTMLElement, source1: [HTMLElement, string], source2: [HTMLElement, string], cb?: Function) => void
+  check: () => boolean
+  update: (rect1: HTMLElement, rect2: HTMLElement, cxn: HTMLElement) => void
+  getCurve: (p1: [number, number], p2: [number, number], dx: number) => string
+  getIntersection: (dx: number, dy: number, cx: number, cy: number, w: number, h: number) => [number, number]
+  setConnector: (source: HTMLElement, side: string) => HTMLElement
+  removeConnection: (container: HTMLElement) => void
+  makeScrollable: (svgContainer: HTMLElement, scrollContainer: HTMLElement, elm1: HTMLElement, elm2: HTMLElement, rect1: HTMLElement, rect2: HTMLElement) => void
+  makeDraggable: (evt: Event) => void
+  toggle: (evt: Event, container: HTMLElement, source1: HTMLElement, source2: HTMLElement) => void
+  convert: (options: any) => string | void
+}

package/tools/sync/interface.d.ts

@@ -0,0 +1,14 @@
+interface SyncTool {
+  /**
+   * Synchronize data between tabs using BroadcastChannel.
+   */
+  tab: (channelName: string, callback: (data: any) => void) => { post: (data: any) => void, close: () => void }
+  /**
+   * Create a Proxy object linked to localStorage for auto-sync.
+   */
+  storageProxy: <T extends object>(key: string, initialValue: T) => T
+  /**
+   * Low-latency cross-tab event bus.
+   */
+  pulse: (channelName: string, callback: (data: any) => void) => { emit: (data: any) => void, stop: () => void }
+}

package/tools/system/interface.d.ts

@@ -0,0 +1,3 @@
+interface SystemTool {
+  multiSplit: () => any
+}

package/tools/text/interface.d.ts

@@ -0,0 +1,13 @@
+interface TextTool {
+  trim(s: string, c: string, b: number, e: number): string
+  capitalize(txt: string): string
+  lower(txt: string): string
+  upper(txt: string): string
+  nl2br(str: string): string
+  sanitize(str: string): string
+  camelCase: {
+    toSpace(string: string): string
+    toUnderscore(string: string): string
+  }
+  fitContainer(el: string): void
+}

package/tools/timer/interface.d.ts

@@ -0,0 +1,4 @@
+interface TimerTool {
+  sleep(ms: number): Promise<void>
+  percentage(start: string, end: string): string
+}

package/tools/tools/interface.d.ts

@@ -0,0 +1,6 @@
+interface ToolsTool {
+  getip(): Promise<void>
+  byteSize(bytes: number): string
+  zIndex(): number
+  zeroToFalse(value: number): boolean | number
+}

package/tools/translators/interface.d.ts

@@ -0,0 +1,3 @@
+interface TranslatorsTool {
+  convertMatrixToScale(values: any): number
+}

package/tools/triggers/interface.d.ts

@@ -0,0 +1,5 @@
+interface TriggersTool {
+  click(elem: string): void
+  change(elem: string): void
+  input(elem: string): void
+}

package/tools/types/interface.d.ts

@@ -0,0 +1,6 @@
+interface TypesTool {
+  of(p: any): string
+  instOfObj(p: any): boolean
+  isNull(p: any): (p: any) => boolean
+  isBool(val: any): boolean
+}

package/tools/ui/interface.d.ts

@@ -0,0 +1,4 @@
+interface UiTool {
+  anchorContext(): void
+  [key: string]: any
+}

package/tools/window/interface.d.ts

@@ -0,0 +1,10 @@
+interface WindowTool {
+  enhancement(): void
+  animationframe(): any
+  center(params: { url: string; title: string; name: string; w: number; h: number }): void
+  onBeforeUnLoad(e: any): void
+  purge(d?: Document, time?: number): void
+  stopZoomWheel(e: any): void
+  setZoom(element?: string, zoom?: number): string
+  getZoom(element?: string): number
+}