@putkoff/abstract-utilities 0.1.113 → 0.1.115

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

@@ -0,0 +1,17 @@
+/**
+ * Reads a file at `relativeOrAbsolutePath` and returns its contents as a string.
+ */
+export declare function readFileContents(relativeOrAbsolutePath: string): Promise<string>;
+/**
+ * Reads a JSON file and returns the parsed object.
+ */
+export declare function readJsonFile<T = any>(relativeOrAbsolutePath: string): Promise<T>;
+/**
+ * Read a file and optionally parse it as JSON (and even pluck a field).
+ *
+ * @param filePath   Path to your file (relative to cwd or absolute)
+ * @param asJson     If true, JSON.parse the file.
+ *                   If a string, JSON.parse then return parsed[string].
+ * @returns          The raw string, whole parsed object, or a specific field.
+ */
+export declare function reader(filePath: string, asJson?: boolean | string): Promise<any>;

package/dist/index.d.ts

@@ -47,6 +47,12 @@ interface ChangePasswordFormProps {
     onCancel?: () => void;
 }
 
+interface AppConfig {
+    BASE_URL: string;
+    BASE_API_URL: string;
+    FEATURE_FLAG?: boolean;
+    SOME_NUMBER?: number;
+}
 interface InputProps {
     label?: any;
     type?: any;
@@ -262,4 +268,29 @@ declare function Input({ label, trailing, ...rest }: React$1.InputHTMLAttributes
 
 declare function Spinner(): react_jsx_runtime.JSX.Element;
 
-export { API_PREFIX, type ApiRow, BASE_URL, Button, type ChangePasswordFormProps, type ChangePasswordProps, Checkbox, DEV_PREFIX, DOMAIN_NAME, type FetchVariables, type FileItem, type FileListResponse, Input, type InputProps, type JwtPayload, type LoginFormProps, type LoginProps, type LogoutButtonProps, PROD_PREFIX, PROTOCOL, SUB_DIR, Spinner, alertit, currentUsername, currentUsernames, decodeJwt, eatAll, eatEnd, eatInner, eatOuter, ensure_list, fetchIt, fetchSharePatch, geAuthsUtilsDirectory, geBackupsUtilsDirectory, geConstantsUtilsDirectory, geEnvUtilsDirectory, geFetchUtilsDirectory, geFileUtilsDirectory, gePathUtilsDirectory, geStaticDirectory, geStringUtilsDirectory, geTypeUtilsDirectory, getAbsDir, getAbsPath, getAuthorizationHeader, getBaseDir, getComponentsUtilsDirectory, getDbConfigsPath, getDistDir, getEnvDir, getEnvPath, getFunctionsDir, getFunctionsUtilsDirectory, getHooksUtilsDirectory, getLibUtilsDirectory, getPublicDir, getSchemasDirPath, getSchemasPath, getSrcDir, getSubstring, getToken, get_app_config_url, get_basename, get_dirname, get_extname, get_filename, get_splitext, get_window, get_window_location, get_window_parts, get_window_pathname, isLoggedIn, isTokenExpired, make_path, make_sanitized_path, normalizeUrl, requestPatch, requireToken, sanitizeFilename, secureFetchIt, stripPrefixes, truncateString };
+/**
+ * getConfig(): load the full AppConfig
+ * getConfig(key): load just that key
+ */
+declare function getConfig(): Promise<AppConfig>;
+declare function getConfig<K extends keyof AppConfig>(key: K): Promise<AppConfig[K]>;
+
+/**
+ * Reads a file at `relativeOrAbsolutePath` and returns its contents as a string.
+ */
+declare function readFileContents(relativeOrAbsolutePath: string): Promise<string>;
+/**
+ * Reads a JSON file and returns the parsed object.
+ */
+declare function readJsonFile<T = any>(relativeOrAbsolutePath: string): Promise<T>;
+/**
+ * Read a file and optionally parse it as JSON (and even pluck a field).
+ *
+ * @param filePath   Path to your file (relative to cwd or absolute)
+ * @param asJson     If true, JSON.parse the file.
+ *                   If a string, JSON.parse then return parsed[string].
+ * @returns          The raw string, whole parsed object, or a specific field.
+ */
+declare function reader(filePath: string, asJson?: boolean | string): Promise<any>;
+
+export { API_PREFIX, type ApiRow, type AppConfig, BASE_URL, Button, type ChangePasswordFormProps, type ChangePasswordProps, Checkbox, DEV_PREFIX, DOMAIN_NAME, type FetchVariables, type FileItem, type FileListResponse, Input, type InputProps, type JwtPayload, type LoginFormProps, type LoginProps, type LogoutButtonProps, PROD_PREFIX, PROTOCOL, SUB_DIR, Spinner, alertit, currentUsername, currentUsernames, decodeJwt, eatAll, eatEnd, eatInner, eatOuter, ensure_list, fetchIt, fetchSharePatch, geAuthsUtilsDirectory, geBackupsUtilsDirectory, geConstantsUtilsDirectory, geEnvUtilsDirectory, geFetchUtilsDirectory, geFileUtilsDirectory, gePathUtilsDirectory, geStaticDirectory, geStringUtilsDirectory, geTypeUtilsDirectory, getAbsDir, getAbsPath, getAuthorizationHeader, getBaseDir, getComponentsUtilsDirectory, getConfig, getDbConfigsPath, getDistDir, getEnvDir, getEnvPath, getFunctionsDir, getFunctionsUtilsDirectory, getHooksUtilsDirectory, getLibUtilsDirectory, getPublicDir, getSchemasDirPath, getSchemasPath, getSrcDir, getSubstring, getToken, get_app_config_url, get_basename, get_dirname, get_extname, get_filename, get_splitext, get_window, get_window_location, get_window_parts, get_window_pathname, isLoggedIn, isTokenExpired, make_path, make_sanitized_path, normalizeUrl, readFileContents, readJsonFile, reader, requestPatch, requireToken, sanitizeFilename, secureFetchIt, stripPrefixes, truncateString };

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

@@ -1,3 +1,9 @@
+export interface AppConfig {
+    BASE_URL: string;
+    BASE_API_URL: string;
+    FEATURE_FLAG?: boolean;
+    SOME_NUMBER?: number;
+}
 export interface InputProps {
     label?: any;
     type?: any;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@putkoff/abstract-utilities",
-    "version": "0.1.113",
+    "version": "0.1.115",
     "type": "module",
     "description": "A reusable React Login component with JWT authentication",
     "main": "dist/cjs/index.js",