@putkoff/abstract-utilities 0.1.113 → 0.1.115

package/dist/esm/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/esm/index.js

@@ -1,5 +1,7 @@
 export { useCallback, useEffect, useRef, useState } from 'react';
 import { jsx, jsxs } from 'react/jsx-runtime';
+import { promises } from 'fs';
+import path from 'path';
 
 /**
 ***Changes**:
@@ -1020,14 +1022,14 @@ function getAppConfig(endpoint) {
     return base ? `${base}/${clean}` : `/api/${clean}`;
 }
 /** Accessor for the loaded config. Throws if you forgot to loadConfig(). */
-function getConfig() {
+function getConfig$1() {
     {
         throw new Error('Config not loaded! Call loadConfig() first.');
     }
 }
 /** Convenience to grab the base URL once loaded. */
 function apiBase() {
-    return getConfig().API_BASE_URL.replace(/\/+$/, '');
+    return getConfig$1().API_BASE_URL.replace(/\/+$/, '');
 }
 
 function ensureAbstractUrl(endpoint, slices = []) {
@@ -1277,5 +1279,85 @@ function Spinner() {
     return (jsx("p", { className: 'animate-pulse', children: "Loading\u2026" }));
 }
 
-export { API_PREFIX, BASE_URL, Button, Checkbox, DEV_PREFIX, DOMAIN_NAME, Input, 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 };
+let _cachedConfig = null;
+function loadConfig() {
+    return __awaiter(this, arguments, void 0, function* (filePath = null) {
+        // 1. If nobody passed a custom path, we default to "config.json" (relative)
+        const relativePath = filePath || 'config.json';
+        // 2. Resolve it against the running page’s URL (document.baseURI)
+        const configUrl = new URL(relativePath, document.baseURI).href;
+        // 3. Fetch + cache
+        if (_cachedConfig)
+            return _cachedConfig;
+        const res = yield fetch(configUrl);
+        if (!res.ok) {
+            throw new Error(`Could not fetch ${configUrl}: ${res.status}`);
+        }
+        _cachedConfig = (yield res.json());
+        return _cachedConfig;
+    });
+}
+function getConfig(key) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const cfg = yield loadConfig();
+        return key ? cfg[key] : cfg;
+    });
+}
+
+/**
+ * Reads a file at `relativeOrAbsolutePath` and returns its contents as a string.
+ */
+function readFileContents(relativeOrAbsolutePath) {
+    return __awaiter(this, void 0, void 0, function* () {
+        // Resolve to an absolute path (so you’re always sure where it’s looking)
+        const filePath = path.isAbsolute(relativeOrAbsolutePath)
+            ? relativeOrAbsolutePath
+            : path.resolve(__dirname, relativeOrAbsolutePath);
+        // Read and return as UTF-8 text
+        return promises.readFile(filePath, 'utf8');
+    });
+}
+/**
+ * Reads a JSON file and returns the parsed object.
+ */
+function readJsonFile(relativeOrAbsolutePath) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const filePath = path.isAbsolute(relativeOrAbsolutePath)
+            ? relativeOrAbsolutePath
+            : path.resolve(__dirname, relativeOrAbsolutePath);
+        const text = yield promises.readFile(filePath, 'utf8');
+        return JSON.parse(text);
+    });
+}
+/**
+ * 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.
+ */
+function reader(filePath_1) {
+    return __awaiter(this, arguments, void 0, function* (filePath, asJson = false) {
+        // resolve to absolute so you know exactly where you’re reading from
+        const abs = path.isAbsolute(filePath)
+            ? filePath
+            : path.resolve(process.cwd(), filePath);
+        // 1) read file as text
+        const text = yield promises.readFile(abs, 'utf8');
+        // 2) if they want JSON, parse it
+        if (asJson) {
+            const obj = JSON.parse(text);
+            // 3) if they passed a string, return that property
+            if (typeof asJson === 'string') {
+                return obj[asJson];
+            }
+            return obj;
+        }
+        // 4) otherwise, just return the raw text
+        return text;
+    });
+}
+
+export { API_PREFIX, BASE_URL, Button, Checkbox, DEV_PREFIX, DOMAIN_NAME, Input, 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 };
 //# sourceMappingURL=index.js.map