@andre1502/react-utilities 1.0.6 → 1.0.8

package/README.md

@@ -28,9 +28,9 @@ npm install @andre1502/react-utilities
 Filename will be auto defined by locales key (e.g. zh-TW, filename will be zh-tw.json).
 
 ```js
-const { fetchLocales } = require('@andre1502/react-utilities/cli');
+import { fetchLocales } from '@andre1502/react-utilities/cli';
 // OR
-const { fetchLocales } = require('@andre1502/react-utilities/config-cli');
+import { fetchLocales } from '@andre1502/react-utilities/config-cli';
 
 // https://docs.google.com/spreadsheets/d/<google-sheet-id>/edit
 const optionLocales = {
@@ -52,9 +52,9 @@ fetchLocales(optionLocales);
 Config file only support export as js file, since you need to combine it with transform function.
 
 ```js
-const { fetchConfig } = require('@andre1502/react-utilities/cli');
+import { fetchConfig } from '@andre1502/react-utilities/cli';
 // OR
-const { fetchConfig } = require('@andre1502/react-utilities/config-cli');
+import { fetchConfig } from '@andre1502/react-utilities/config-cli';
 
 // https://docs.google.com/spreadsheets/d/<google-sheet-id>/edit
 const optionConfig = {
@@ -107,9 +107,9 @@ module.exports = {
 To fetch both locales and config.
 
 ```js
-const { fetchAll } = require('@andre1502/react-utilities/cli');
+import { fetchAll } from '@andre1502/react-utilities/cli';
 // OR
-const { fetchAll } = require('@andre1502/react-utilities/config-cli');
+import { fetchAll } from '@andre1502/react-utilities/config-cli';
 
 // https://docs.google.com/spreadsheets/d/<google-sheet-id>/edit
 const spreadsheetId = ''; // Google Sheet Id
@@ -145,14 +145,17 @@ fetchAll([optionLocales, optionConfig]);
 ### Transform Config
 
 ```js
-const { transformConfig } = require('@andre1502/react-utilities/cli');
+import { transformConfig } from '@andre1502/react-utilities/cli';
 // OR
-const { transformConfig } = require('@andre1502/react-utilities/config-cli');
+import { transformConfig } from '@andre1502/react-utilities/config-cli';
 const version = '<app-brand>';
 const env = '<env-value>'; // support 'dev' | 'stag' | 'prod'
 
-let { params } = require('./versionConfig');
-const currentConfig = { ...params?.default, ...params[version] };
+import versionConfig from './versionConfig.json' with { type: 'json' };
+const currentConfig = {
+  ...versionConfig.params.default,
+  ...versionConfig.params[version],
+};
 
 transformConfig(currentConfig, env, 'REACT_APP_', {
   folder: '.', // transformed config folder location
@@ -165,14 +168,17 @@ transformConfig(currentConfig, env, 'REACT_APP_', {
 ### Transform Sitemap
 
 ```js
-const { transformSitemap } = require('@andre1502/react-utilities/cli');
+import { transformSitemap } from '@andre1502/react-utilities/cli';
 // OR
-const { transformSitemap } = require('@andre1502/react-utilities/config-cli');
+import { transformSitemap } from '@andre1502/react-utilities/config-cli';
 const version = '<app-brand>';
 const env = '<env-value>'; // support 'dev' | 'stag' | 'prod'
 
-let { params } = require('./versionConfig');
-const currentConfig = { ...params?.default, ...params[version] };
+import versionConfig from './versionConfig.json' with { type: 'json' };
+const currentConfig = {
+  ...versionConfig.params.default,
+  ...versionConfig.params[version],
+};
 const hostname = currentConfig['MAIN_URL'][env];
 const urls = currentConfig['SITEMAP'];
 
@@ -183,43 +189,6 @@ transformSitemap(hostname, urls, true, {
 });
 ```
 
-## Sentry CLI
-
-### Release Sentry Source Map
-
-Add `.sentryclirc` file in root project with these value
-
-```
-[defaults]
-url=https://<sentry_host_url>/
-org=<organization>
-project=<sentry_project_name>
-```
-
-Update system environment variables with
-
-```sh
-export SENTRY_AUTH_TOKEN=<sentry_auth_token>
-```
-
-Add sentry file in root project with this code
-
-```js
-const { releaseSentrySourceMap } = require('@andre1502/react-utilities/cli');
-// OR
-const {
-  releaseSentrySourceMap,
-} = require('@andre1502/react-utilities/sentry-cli');
-
-releaseSentrySourceMap({
-  env: '',
-  release: '',
-  includeFolder: [''],
-  urlPrefix: '~',
-  requiredEnvForSourceMap: [''],
-});
-```
-
 ## Sentry
 
 ### Init Sentry for React
@@ -397,3 +366,57 @@ initI18n({
   debug: debug,
 });
 ```
+
+## Local Testing
+
+If you want to test this library in another local project, here are the most effective ways to do it.
+
+### Method 1: The Quickest Way (`yarn add`)
+
+Best for a 10-second check.
+
+1. In your other project: `yarn add ../react-utilities` (use the relative path).
+2. **Warning**: This uses symlinks. If you get a "Duplicate React" or "Invalid Hook Call" error, use Method 2.
+
+### Method 2: The Recommended Way (`yalc`)
+
+Best for active development. It avoids all symlink/React issues by copying files instead of linking them.
+
+**In this library:**
+
+1. Install yalc globally: `npm i -g yalc`
+2. Build and publish locally: `yarn build && yalc publish`
+3. (Optional) For auto-syncing: `yarn build:watch` and in another terminal `yalc publish --push`
+
+**In your other project:**
+
+1. Add the local package: `yalc add @andre1502/react-utilities`
+2. Install dependencies: `yarn install` (or npm/pnpm)
+
+### Method 3: The "Clean" Way (`npm pack`)
+
+Best for final verification before publishing.
+
+**In this library:**
+
+1. `yarn build`
+2. `npm pack` (this creates a `.tgz` file like `andre1502-react-utilities-1.0.8.tgz`)
+
+**In your other project:**
+
+1. `yarn add ./path/to/andre1502-react-utilities-1.0.8.tgz`
+
+## 💖 Support the Project
+
+If this project saved you time or helped you build something cool, consider a one-time donation!
+
+[![Liberapay One-Time](https://img.shields.io/badge/Liberapay-Donate%20Once-blue?style=for-the-badge&logo=liberapay)](https://liberapay.com/andre1502/donate)
+
+| Amount | Goal |
+| :-- | :-- |
+| **[$5 USD](https://liberapay.com/andre1502/donate?amount=5.00&currency=USD)** | ☕ Buy me a coffee |
+| **[$15 USD](https://liberapay.com/andre1502/donate?amount=15.00&currency=USD)** | 🍕 Buy me a pizza |
+| **[$50 USD](https://liberapay.com/andre1502/donate?amount=50.00&currency=USD)** | 🛠️ Support a new feature |
+| **Custom** | 🚀 Every bit helps! |
+
+> **Note:** 100% of your donation goes to development (excluding PayPal's standard transaction fee).

package/dist/EnvironmentEnum-F4hjulGN.js

@@ -0,0 +1,12 @@
+//#region src/enums/EnvironmentEnum.ts
+var e = {
+	DEV: "dev",
+	QAT: "qat",
+	STAGING: "staging",
+	UAT: "uat",
+	PRODUCTION: "production"
+};
+//#endregion
+export { e as t };
+
+//# sourceMappingURL=EnvironmentEnum-F4hjulGN.js.map

package/dist/EnvironmentEnum-F4hjulGN.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EnvironmentEnum-F4hjulGN.js","names":[],"sources":["../src/enums/EnvironmentEnum.ts"],"sourcesContent":["export const EnvironmentEnum = {\n  DEV: 'dev',\n  QAT: 'qat',\n  STAGING: 'staging',\n  UAT: 'uat',\n  PRODUCTION: 'production',\n} as const;\n\nexport type EnvironmentEnum =\n  (typeof EnvironmentEnum)[keyof typeof EnvironmentEnum];\n"],"mappings":";AAAA,IAAa,IAAkB;CAC7B,KAAK;CACL,KAAK;CACL,SAAS;CACT,KAAK;CACL,YAAY;CACb"}

package/dist/Utils-Bb2yUYbQ.js

@@ -0,0 +1,14 @@
+//#region src/Sentry/Utils.ts
+var e = (e, t, n, r) => {
+	t && e.withScope((e) => {
+		e.setContext("config", t);
+	}), n && e.withScope((e) => {
+		e.setContext("request", n);
+	}), r && e.withScope((e) => {
+		e.setContext("response", r);
+	});
+};
+//#endregion
+export { e as t };
+
+//# sourceMappingURL=Utils-Bb2yUYbQ.js.map

package/dist/Utils-Bb2yUYbQ.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Utils-Bb2yUYbQ.js","names":[],"sources":["../src/Sentry/Utils.ts"],"sourcesContent":["const recordSentryHttp = (\n  Sentry: any,\n  config?: any,\n  request?: any,\n  response?: any,\n) => {\n  if (config) {\n    Sentry.withScope((scope: any) => {\n      scope.setContext('config', config);\n    });\n  }\n\n  if (request) {\n    Sentry.withScope((scope: any) => {\n      scope.setContext('request', request);\n    });\n  }\n\n  if (response) {\n    Sentry.withScope((scope: any) => {\n      scope.setContext('response', response);\n    });\n  }\n};\n\nexport { recordSentryHttp };\n"],"mappings":";AAAA,IAAM,KACJ,GACA,GACA,GACA,MACG;AAaH,CAZI,KACF,EAAO,WAAW,MAAe;AAC/B,IAAM,WAAW,UAAU,EAAO;GAClC,EAGA,KACF,EAAO,WAAW,MAAe;AAC/B,IAAM,WAAW,WAAW,EAAQ;GACpC,EAGA,KACF,EAAO,WAAW,MAAe;AAC/B,IAAM,WAAW,YAAY,EAAS;GACtC"}