@putkoff/abstract-utilities 0.1.194 → 0.1.197

package/dist/index.d.ts

@@ -1,3 +1,7 @@
+import React$1 from 'react';
+export { useCallback, useEffect, useRef, useState } from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
 interface FileItem {
     id: number | string;
     filename: string;
@@ -100,4 +104,268 @@ interface LoginFormProps {
     onSubmit: (e: React.FormEvent) => void;
 }
 
+declare function getSafeDocument(): Document | undefined;
+declare function getDocumentProp<K1 extends keyof Document>(prop1: K1): Document[K1] | undefined;
+declare function getDocumentProp<K1 extends keyof Document, K2 extends keyof NonNullable<Document[K1]>>(prop1: K1, prop2: K2): NonNullable<Document[K1]>[K2] | undefined;
+
+/**
+ * Returns `window` if running in a browser, otherwise `undefined`.
+ */
+declare function getSafeLocalStorage(): Storage | undefined;
+/**
+ * Call a Storage method by name, silencing any errors or missing storage.
+ *
+ * @param method  One of the keys of the Storage interface: "getItem", "setItem", etc.
+ * @param args    The arguments you’d normally pass to that method.
+ * @returns       The method’s return value, or undefined if storage/method isn’t available.
+ */
+declare function callStorage<K extends keyof Storage>(method: K, ...args: Parameters<Storage[K]>): ReturnType<Storage[K]> | undefined;
+/**
+ * Safely call storage methods (`localStorage` or `sessionStorage`) without blowing up.
+ * Returns `undefined` on any error.
+ */
+declare function safeStorage<S extends "localStorage" | "sessionStorage", K extends keyof Storage>(storageName: S, method: K, ...args: Parameters<Storage[K]>): ReturnType<Storage[K]> | undefined;
+
+/**
+ * Safely walk `globalThis` (or window/document) by a chain of property names.
+ * Returns `undefined` if any step is missing.
+ */
+declare function safeGlobalProp<T = any>(...path: string[]): T | undefined;
+
+/**
+ * Returns the global window object if it exists, otherwise undefined.
+ */
+declare function getSafeWindow(): Window | undefined;
+/**
+ * Safely call a method on window by name.
+ *
+ * @param method  The Window method to call (e.g. "alert", "open", etc.).
+ * @param args    Arguments to pass to that method.
+ * @returns       The method’s return value, or undefined if
+ *                 window/method isn’t available or throws.
+ */
+declare function callWindowMethod<K extends keyof Window, F extends Window[K] = Window[K], Args extends any[] = F extends (...a: infer P) => any ? P : never, R = F extends (...a: any) => infer U ? U : void>(method: K, ...args: Args): R | undefined;
+/** overloads for 1‐ and 2‐level deep props */
+declare function getWindowProp<K1 extends keyof Window>(prop1: K1): Window[K1] | undefined;
+declare function getWindowProp<K1 extends keyof Window, K2 extends keyof NonNullable<Window[K1]>>(prop1: K1, prop2: K2): NonNullable<Window[K1]>[K2] | undefined;
+declare function getWindowHost(): string | undefined;
+
+/**
+ * Helpers for dealing with the JWT stored in localStorage.
+ */
+
+/**
+***Changes**:
+*- Updated import path for `InputProps` to `../../types/interfaces`.
+*
+*3. **Token Utilities** (`src/functions/auth/token_utils.ts`):
+*   Copy from `/var/www/abstractendeavors/my-login-app/src/functions/auth_utils/token_utils.ts`.
+*
+*/
+/** Read raw JWT from LocalStorage (or null if absent) */
+declare function getToken(): string | null | any;
+declare function isLoggedIn(): boolean;
+/**
+ * Add a Bearer Authorization header.
+ * A shallow copy of headers is returned so callers can keep chaining.
+ */
+declare function getAuthorizationHeader(headers?: Record<string, string> | null, token?: string | null): Record<string, string>;
+/** Throw + redirect if there’s no valid token; otherwise return it. */
+declare function requireToken(): string;
+/** True if token is structurally bad or its exp ≤ now. */
+declare function isTokenExpired(token: string): boolean;
+/** Convenience wrapper: return username from the JWT (or null). */
+declare function currentUsername(): string | null;
+declare function currentUsernames(): any;
+declare function decodeJwt(token: string): JwtPayload;
+
+declare const PROTOCOL = "https://";
+declare const DOMAIN_NAME = "abstractendeavors";
+declare const BASE_URL = "https://abstractendeavors.com";
+declare const SUB_DIR = "secure-files";
+declare const PROD_PREFIX = "/secure-files/";
+declare const API_PREFIX = "/secure-files/api";
+declare const DEV_PREFIX = "/secure-files-dev/";
+
+declare function get_window(): (Window & typeof globalThis) | null;
+declare function get_window_location(): Location | "https://abstractendeavors.com" | null;
+declare function get_window_pathname(): string | null;
+declare function get_window_parts(): Location | "https://abstractendeavors.com" | null;
+
+declare function fetchIt<T>(url: any, body?: any, method?: any, headers?: Record<string, string> | null, blob?: boolean, configUrl?: boolean, withCredentials?: boolean, returnJson?: boolean, returnReult?: boolean): Promise<T>;
+declare function fetchIt(url: any, body?: any, method?: any, headers?: Record<string, string> | null, blob?: boolean, configUrl?: boolean, withCredentials?: boolean, returnJson?: boolean, returnReult?: boolean): Promise<Blob>;
+declare function getHtmlDirectory(directory: string, filename: string): string;
+declare function fetchIndexHtml(filename: string, directory?: string, base?: string): Promise<string>;
+declare function fetchIndexHtmlContainer(filename: string, doc?: Document, directory?: string): Promise<void>;
+
+/**
+ * Reads a JSON file, either via Node’s fs (if available)
+ * or via window.fetch in the browser. Never throws — returns
+ * the parsed object or null on any error.
+ */
+declare function readJsonFile<T = any>(relativeOrAbsolutePath: string): Promise<T | null>;
+declare function getConfigContent<T = Record<string, any>>(): Promise<T | null>;
+declare function getConfigVar<T = any>(key?: any): Promise<T | undefined>;
+
+/**
+ * Unwraps nested { result } fields until you hit a non-object or no more "result" keys.
+ */
+declare function getResult<T>(obj: unknown): T;
+declare function getMethod(method?: string | null, body?: unknown): string;
+declare function getHeaders(headers?: Record<string, string>, method?: string | null, body?: unknown): Record<string, string>;
+declare function getBody(body?: unknown, method?: string | null): string | undefined;
+declare function getFetchVars(headers?: Record<string, string> | null, method?: string | null, body?: any): FetchVariables;
+declare function parseResult(res: Response): Promise<unknown>;
+/**
+ * Intercept 401/403 and force a clean redirect to login
+ * without ever showing an alert.
+ */
+declare function checkResponse(res: Response): Response;
+
+declare function get_dirname(filePath: string | null): string;
+declare function get_basename(filePath: string | null): string;
+declare function get_filename(file_path: string): string;
+declare function get_extname(filePath: string | null): string;
+declare function get_splitext(filePath: string | null): {
+    filename: string;
+    extname: string;
+    ext?: undefined;
+} | {
+    filename: string;
+    ext: string;
+    extname?: undefined;
+};
+/**
+ * Join multiple path segments, normalizing leading/trailing slashes.
+ *
+ * Usage:
+ *   make_path('/foo','bar','baz')
+ *   make_path(['/foo','bar','baz'])
+ */
+declare function make_path(...paths: Array<string | string[]>): string;
+declare function sanitizeFilename(filename: string): string;
+declare function make_sanitized_path(...paths: string[]): string;
+declare function normalizeUrl(base: string, p?: string): string;
+
+/**
+ * Returns the absolute path of the current file.
+ */
+declare function getAbsDir(): string;
+declare function getAbsPath(subPath: string): string;
+
+declare function getFunctionsDir(): string;
+declare function geAuthsUtilsDirectory(): string;
+declare function geBackupsUtilsDirectory(): string;
+declare function geConstantsUtilsDirectory(): string;
+declare function geEnvUtilsDirectory(): string;
+declare function geFetchUtilsDirectory(): string;
+declare function geFileUtilsDirectory(): string;
+declare function gePathUtilsDirectory(): string;
+declare function geStringUtilsDirectory(): string;
+declare function geTypeUtilsDirectory(): string;
+
+declare function getSrcDir(): string;
+declare function geStaticDirectory(): string;
+declare function getLibUtilsDirectory(): string;
+declare function getHooksUtilsDirectory(): string;
+declare function getFunctionsUtilsDirectory(): string;
+declare function getComponentsUtilsDirectory(): string;
+
+declare function getBaseDir(): string;
+declare function getPublicDir(): string;
+declare function getDistDir(): string;
+declare function getEnvDir(): string;
+
+declare function getEnvPath(string?: string): string;
+declare function getDbConfigsPath(): string;
+declare function getSchemasPath(): string;
+declare function getSchemasDirPath(subPath: string): string;
+
+declare function alertit(obj?: any): void;
+
+declare function getSubstring(obj: string, maxLength?: number | null, minLength?: number | null): string;
+declare function truncateString(obj: string, maxLength?: number): string;
+declare function stripPrefixes(str: string, bases?: string | string[]): string;
+/**
+ * Removes characters from the beginning of the string
+ * if they are found in the list of characters.
+ *
+ * @param str - The input string.
+ * @param listObjects - A string or an array of characters to remove.
+ * @returns The modified string.
+ */
+declare function eatInner(str: string, listObjects: string | string[]): string;
+/**
+ * Removes characters from the end of the string
+ * if they are found in the list of characters.
+ *
+ * @param str - The input string.
+ * @param listObjects - A string or an array of characters to remove.
+ * @returns The modified string.
+ */
+declare function eatOuter(str: string, listObjects: string | string[]): string;
+/**
+ * Removes characters from both the beginning and the end of the string
+ * if they are found in the list of characters.
+ *
+ * @param str - The input string.
+ * @param listObjects - A string or an array of characters to remove.
+ * @returns The modified string.
+ */
+declare function eatAll(str: string, listObjects: string | string[]): string;
+declare function eatEnd(obj: string, endings?: string[]): string;
+declare function tryParse(obj: any): any;
+declare function create_list_string(array_obj: any): string;
+
+declare function ensure_list<T>(obj: T | T[]): T[];
+declare function assureString(obj: any): string;
+declare function cleanArray(obj: any): unknown[];
+declare function assureArray(input: string | string[]): any;
+declare function get_key_value<T extends object>(obj: T, key: string): any;
+declare function get<T extends object>(obj: T | null | undefined, keys: string | string[], defaultValue?: any): any;
+declare function cleanText(input: any): any;
+declare function getCleanArray(obj: any): unknown[];
+
+declare function Button({ children, color, variant, className, ...rest }: React.ButtonHTMLAttributes<HTMLButtonElement> & {
+    color?: 'gray' | 'green' | 'blue';
+    variant?: 'default' | 'icon' | 'primary' | 'secondary';
+    className?: string;
+}): react_jsx_runtime.JSX.Element;
+
+declare function Checkbox({ label, ...rest }: React$1.InputHTMLAttributes<HTMLInputElement> & {
+    label: string;
+}): react_jsx_runtime.JSX.Element;
+
+declare function Input({ label, trailing, ...rest }: React$1.InputHTMLAttributes<HTMLInputElement> & {
+    label: string;
+    trailing?: React$1.ReactNode;
+}): react_jsx_runtime.JSX.Element;
+
+declare function Spinner(): react_jsx_runtime.JSX.Element;
+
+declare function loadConfig(filePath?: string | null): Promise<AppConfig>;
+/**
+ * getConfig(): Promise<AppConfig>
+ * getConfig(key): Promise<AppConfig[K]>
+ */
+declare function getConfig(): Promise<AppConfig>;
+declare function getConfig<K extends keyof AppConfig>(key: K): Promise<AppConfig[K]>;
+
+/**
+ * Processes keywords by checking if keywords is a string and splitting it.
+ * Then cleans each keyword using `eatAll` with a set of characters to remove.
+ *
+ * @param keywords - The keywords as a comma-separated string or as an array.
+ * @returns An array of cleaned keywords.
+ */
+declare function processKeywords(keywords: string | string[]): string[];
+/**
+ * Constructs a keyword string where each keyword is prefixed with a hash (#).
+ *
+ * @param keywords - An array of keywords.
+ * @returns A string with each keyword prefixed by '#'.
+ */
+declare function get_keyword_string(keywords: any): string;
+
+export { API_PREFIX, BASE_URL, Button, Checkbox, DEV_PREFIX, DOMAIN_NAME, Input, PROD_PREFIX, PROTOCOL, SUB_DIR, Spinner, alertit, assureArray, assureString, callStorage, callWindowMethod, checkResponse, cleanArray, cleanText, create_list_string, currentUsername, currentUsernames, decodeJwt, eatAll, eatEnd, eatInner, eatOuter, ensure_list, fetchIndexHtml, fetchIndexHtmlContainer, fetchIt, geAuthsUtilsDirectory, geBackupsUtilsDirectory, geConstantsUtilsDirectory, geEnvUtilsDirectory, geFetchUtilsDirectory, geFileUtilsDirectory, gePathUtilsDirectory, geStaticDirectory, geStringUtilsDirectory, geTypeUtilsDirectory, get, getAbsDir, getAbsPath, getAuthorizationHeader, getBaseDir, getBody, getCleanArray, getComponentsUtilsDirectory, getConfig, getConfigContent, getConfigVar, getDbConfigsPath, getDistDir, getDocumentProp, getEnvDir, getEnvPath, getFetchVars, getFunctionsDir, getFunctionsUtilsDirectory, getHeaders, getHooksUtilsDirectory, getHtmlDirectory, getLibUtilsDirectory, getMethod, getPublicDir, getResult, getSafeDocument, getSafeLocalStorage, getSafeWindow, getSchemasDirPath, getSchemasPath, getSrcDir, getSubstring, getToken, getWindowHost, getWindowProp, get_basename, get_dirname, get_extname, get_filename, get_key_value, get_keyword_string, get_splitext, get_window, get_window_location, get_window_parts, get_window_pathname, isLoggedIn, isTokenExpired, loadConfig, make_path, make_sanitized_path, normalizeUrl, parseResult, processKeywords, readJsonFile, requireToken, safeGlobalProp, safeStorage, sanitizeFilename, stripPrefixes, truncateString, tryParse };
 export type { ApiRow, AppConfig, ChangePasswordFormProps, ChangePasswordProps, FetchVariables, FileItem, FileListResponse, InputProps, JwtPayload, LoginFormProps, LoginProps, LogoutButtonProps, Promise$1 as Promise, UrlKey };

package/dist/{functions → types/functions}/index.d.ts

@@ -12,3 +12,4 @@ export * from './config_utils';
 export * from './read_utils';
 export * from './safe_utils';
 export * from './read_utils';
+export * from './variable_utils';

package/dist/{functions → types/functions}/path_utils/src/path_utils.d.ts

@@ -11,7 +11,14 @@ export declare function get_splitext(filePath: string | null): {
     ext: string;
     extname?: undefined;
 };
-export declare function make_path(...segments: string[]): string;
+/**
+ * Join multiple path segments, normalizing leading/trailing slashes.
+ *
+ * Usage:
+ *   make_path('/foo','bar','baz')
+ *   make_path(['/foo','bar','baz'])
+ */
+export declare function make_path(...paths: Array<string | string[]>): string;
 export declare function sanitizeFilename(filename: string): string;
 export declare function make_sanitized_path(...paths: string[]): string;
 export declare function normalizeUrl(base: string, p?: string): string;

package/dist/types/functions/type_utils/src/type_utils.d.ts

@@ -0,0 +1,8 @@
+export declare function ensure_list<T>(obj: T | T[]): T[];
+export declare function assureString(obj: any): string;
+export declare function cleanArray(obj: any): unknown[];
+export declare function assureArray(input: string | string[]): any;
+export declare function get_key_value<T extends object>(obj: T, key: string): any;
+export declare function get<T extends object>(obj: T | null | undefined, keys: string | string[], defaultValue?: any): any;
+export declare function cleanText(input: any): any;
+export declare function getCleanArray(obj: any): unknown[];

package/dist/types/functions/variable_utils/imports.d.ts

@@ -0,0 +1 @@
+export { eatAll } from './../string_utils';

package/dist/types/functions/variable_utils/src/index.d.ts

@@ -0,0 +1 @@
+export * from './variable_utils';

package/dist/types/functions/variable_utils/src/variable_utils.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Processes keywords by checking if keywords is a string and splitting it.
+ * Then cleans each keyword using `eatAll` with a set of characters to remove.
+ *
+ * @param keywords - The keywords as a comma-separated string or as an array.
+ * @returns An array of cleaned keywords.
+ */
+export declare function processKeywords(keywords: string | string[]): string[];
+/**
+ * Constructs a keyword string where each keyword is prefixed with a hash (#).
+ *
+ * @param keywords - An array of keywords.
+ * @returns A string with each keyword prefixed by '#'.
+ */
+export declare function get_keyword_string(keywords: any): string;

package/dist/types/index.d.ts

@@ -1 +1,2 @@
-export * from './src';
+export * from './functions';
+export * from './types';

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

@@ -0,0 +1 @@
+export * from './src';

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

@@ -0,0 +1 @@
+export * from './src';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@putkoff/abstract-utilities",
-    "version": "0.1.194",
+    "version": "0.1.197",
     "type": "module",
     "description": "A reusable React Login component with JWT authentication",
     "main": "dist/cjs/index.js",
@@ -9,7 +9,8 @@
     "scripts": {
         "build": "tsc --emitDeclarationOnly && rollup -c",
         "test": "jest",
-        "prepublishOnly": "npm run build"
+        "prepublishOnly": "npm run build",
+        "release": "npm version patch -m \"chore(release): v%s\" && npm run build && npm publish --access public"
     },
     "keywords": [
         "react",
@@ -88,4 +89,4 @@
     "ts-node": {
         "esm": true
     }
-}
+}

package/dist/functions/type_utils/src/type_utils.d.ts

@@ -1 +0,0 @@
-export declare function ensure_list<T>(obj: T | T[]): T[];