@briannorman9/eli-utils 1.0.0 → 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Brian Norman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,6 +1,6 @@
 # @briannorman9/eli-utils
 
-Utility functions for ELI web experiments.
+Utility functions for web experiments with ELI (Experimentation Local Interface).
 
 ## Installation
 
@@ -10,72 +10,163 @@ npm install @briannorman9/eli-utils
 
 ## Usage
 
-In your ELI project code, you can import utils using the special `@eli/utils` import syntax (the server will automatically resolve it to the installed `eli-utils` package):
+Import the utils in your ELI variant code:
 
 ```javascript
 import utils from '@eli/utils';
+```
+
+**Note:** ELI's import system automatically resolves `@eli/utils` to `@briannorman9/eli-utils` from your project's `node_modules`.
+
+## API
+
+### DOM Utilities
+
+#### `waitForElement(selector)`
+Wait for an element to appear in the DOM.
 
-// Wait for an element to appear
+```javascript
 utils.waitForElement('#myElement').then(element => {
   console.log('Element found:', element);
 });
+```
 
-// Wait until a condition is met
+#### `waitUntil(condition, interval)`
+Wait until a condition function returns true.
+
+```javascript
 utils.waitUntil(() => document.readyState === 'complete');
+```
+
+#### `select(selector, context)`
+Select a single element.
+
+```javascript
+const button = utils.select('#myButton');
+```
+
+#### `selectAll(selector, context)`
+Select multiple elements.
+
+```javascript
+const buttons = utils.selectAll('.button');
+```
 
-// DOM manipulation
+### Class Manipulation
+
+#### `addClass(element, className)`
+Add a class to an element.
+
+```javascript
 utils.addClass('#myButton', 'active');
+```
+
+#### `removeClass(element, className)`
+Remove a class from an element.
+
+```javascript
 utils.removeClass('#myButton', 'inactive');
+```
+
+#### `toggleClass(element, className)`
+Toggle a class on an element.
+
+```javascript
+utils.toggleClass('#myButton', 'active');
+```
+
+#### `hasClass(element, className)`
+Check if an element has a class.
+
+```javascript
+if (utils.hasClass('#myButton', 'active')) {
+  console.log('Button is active');
+}
+```
+
+### Event Handling
+
+#### `on(element, event, handler)`
+Add an event listener.
 
-// Event handling
+```javascript
 utils.on('#myButton', 'click', () => console.log('Clicked!'));
+```
 
-// Cookies
-const userId = utils.getCookie('userId');
-utils.setCookie('userId', '12345', 30);
+#### `off(element, event, handler)`
+Remove an event listener.
 
-// Query parameters
-const campaign = utils.getQueryParam('campaign');
+```javascript
+utils.off('#myButton', 'click', handler);
+```
 
-// Custom events
-utils.triggerEvent('experimentLoaded', { variant: 'v1' });
+#### `delegate(parent, selector, event, handler)`
+Event delegation - attach event to parent, handle on children.
+
+```javascript
+utils.delegate('#container', '.button', 'click', (e) => {
+  console.log('Button clicked:', e.target);
+});
 ```
 
-## API Reference
+#### `triggerEvent(eventName, data, target)`
+Trigger a custom event.
 
-### Element Utilities
+```javascript
+utils.triggerEvent('experimentLoaded', { variant: 'v1' });
+```
 
-- `waitForElement(selector)` - Wait for element to appear (waits indefinitely)
-- `waitUntil(condition, interval)` - Wait until condition is true (waits indefinitely, checks every `interval` ms, default: 100ms)
-- `select(selector, context)` - Select single element
-- `selectAll(selector, context)` - Select multiple elements
-- `addClass(element, className)` - Add class to element
-- `removeClass(element, className)` - Remove class from element
-- `toggleClass(element, className)` - Toggle class on element
-- `hasClass(element, className)` - Check if element has class
+### Cookies
 
-### Event Utilities
+#### `getCookie(name)`
+Get a cookie value by name.
 
-- `on(element, event, handler)` - Add event listener
-- `off(element, event, handler)` - Remove event listener
-- `delegate(parent, selector, event, handler)` - Event delegation
-- `triggerEvent(eventName, data, target)` - Trigger custom event
+```javascript
+const userId = utils.getCookie('userId');
+```
 
-### Cookie Utilities
+#### `setCookie(name, value, days, path)`
+Set a cookie.
 
-- `getCookie(name)` - Get cookie value
-- `setCookie(name, value, days, path)` - Set cookie
+```javascript
+utils.setCookie('userId', '12345', 30);
+```
 
 ### URL Utilities
 
-- `getQueryParam(name, url)` - Get URL query parameter
+#### `getQueryParam(name, url)`
+Get a URL query parameter value.
+
+```javascript
+const campaign = utils.getQueryParam('campaign');
+```
 
 ### Viewport Utilities
 
-- `getViewport()` - Get viewport dimensions
-- `isInViewport(element, threshold)` - Check if element is in viewport
-- `scrollIntoView(element, options)` - Scroll element into view
+#### `getViewport()`
+Get the viewport dimensions.
+
+```javascript
+const { width, height } = utils.getViewport();
+```
+
+#### `isInViewport(element, threshold)`
+Check if element is in viewport.
+
+```javascript
+if (utils.isInViewport('#myElement')) {
+  console.log('Element is visible');
+}
+```
+
+#### `scrollIntoView(element, options)`
+Scroll element into view.
+
+```javascript
+utils.scrollIntoView('#myElement', { behavior: 'smooth', block: 'center' });
+```
 
 ## License
 
 MIT
+

package/index.js

@@ -1,7 +1,5 @@
 // ELI Utils - Utility functions for web experiments
-// This package can be installed via: npm install @briannorman9/eli-utils
-// Then imported in variant code using: import utils from '@eli/utils';
-// (The server automatically resolves @eli/utils to the @briannorman9/eli-utils package)
+// This file can be imported in variant code using: import utils from '@eli/utils';
 
 export default {
   /**

package/package.json

@@ -1,30 +1,34 @@
 {
   "name": "@briannorman9/eli-utils",
-  "version": "1.0.0",
-  "description": "Utility functions for ELI web experiments",
+  "version": "1.0.1",
+  "description": "Utility functions for web experiments with ELI (Experimentation Local Interface)",
   "main": "index.js",
   "type": "module",
-  "exports": {
-    ".": "./index.js"
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
   },
   "keywords": [
     "eli",
     "utils",
+    "utilities",
     "web-experiments",
-    "utilities"
+    "dom",
+    "helpers"
   ],
   "author": "",
   "license": "MIT",
-  "engines": {
-    "node": ">=12.0.0"
-  },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/briannorman/eli.git",
-    "directory": "packages/eli-utils"
+    "url": "https://github.com/briannorman/eli-utils.git"
+  },
+  "bugs": {
+    "url": "https://github.com/briannorman/eli-utils/issues"
   },
-  "publishConfig": {
-    "access": "public"
-  }
+  "homepage": "https://github.com/briannorman/eli-utils#readme",
+  "files": [
+    "index.js",
+    "README.md",
+    "LICENSE"
+  ]
 }