@wtasnorg/node-lib 0.0.7 → 0.0.8

package/changelog.txt

@@ -0,0 +1,14 @@
+# Changelog
+
+## [0.0.8] - 2026-01-19
+
+### Added
+- User-agent parsing functionality in `src/user-agent.ts`.
+- Comprehensive unit tests for user-agent parsing in `src/user-agent.test.ts`.
+- `parseUserAgent` function to extract browser, OS, device, and engine info.
+- `npm run lint` script to `package.json`.
+- ESLint and EditorConfig compliance for new files.
+
+### Fixed
+- Exported `parseUserAgent` function and `UserAgentInfo` type from `index.ts`.
+- Fixed `detectEngine` logic: "Blink" was never returned because "AppleWebKit" check ran first. Reordered checks so Chrome-based browsers correctly return "Blink".

package/dev_checklist.txt

@@ -0,0 +1,56 @@
+# Development Checklist
+
+## Constraints
+
+- [ ] Do not delete failing tests. Explain first. Ask second. No delete.
+- [ ] Do not turn off eslint warnings to avoid linting errors.
+
+## Code Quality Guidelines
+
+### Structure & Style
+
+- [ ] Imports/Exports: Imports at the top, exports at the bottom.
+- [ ] Visibility: All primary functions should be exported.
+- [ ] Mutability: Prefer `const` over `let` (`prefer-const`).
+- [ ] Control Blocks: Always use braces `{}` for `if`, `for`, etc. (`curly`).
+- [ ] AI Agent Protocol: AI agents MUST honor the project's ESLint and EditorConfig settings for all modifications. Run `npm run lint` to verify compliance.
+
+### Documentation & Examples
+
+- [ ] JSDoc: Comprehensive JSDoc for all exported functions and types.
+- [ ] Examples:
+  - At least 3 success examples showing different use cases.
+  - At least 1 error/fallback example showing edge cases.
+
+### Consistency
+
+- [ ] Default States: For complex types, provide a factory/function that returns default values.
+- [ ] Cross-Lang Parity: Match default values with Golang zero-value conventions where applicable.
+
+---
+
+## Pre-flight Checklist
+
+- [ ] Linting: Code passes npm run lint without warnings.
+- [ ] Testing:
+  - [ ] Unit tests written for all new functionality.
+  - [ ] All tests pass: npm run test.
+- [ ] Build: Project builds successfully: npm run build.
+- [ ] Documentation:
+  - [ ] readme.txt updated with new features/changes.
+  - [ ] Generated docs refreshed: npm run docs && npm run docs:json.
+- [ ] Version Control:
+  - [ ] changelog.txt updated for the current version.
+  - [ ] Identity verified (git log -n1) to protect PII.
+
+---
+
+## Useful Commands
+
+```bash
+# Full verification suite
+npm run lint \
+&& npm run build \
+&& npm run test \
+&& npm run docs
+```

package/docs/README.md

@@ -4,42 +4,15 @@
 
 # @wtasnorg/node-lib
 
-A library project for nodejs. #nodejs #typescript #library
+## Interfaces
 
-- [npm org](https://www.npmjs.com/org/wtasnorg)
-- [github repo](https://github.com/wtasg/node-lib)
+- [FileSystemDependencies](interfaces/FileSystemDependencies.md)
+- [FindDirectoriesOptions](interfaces/FindDirectoriesOptions.md)
+- [UserAgentInfo](interfaces/UserAgentInfo.md)
 
 ## Functions
 
-1. hello (for debugging)
-2. `pojo` for converting class objects to Plain Old Javascript Objects.
-3. `createFindDirectories` as a factory for finding directories; think `find path -type d`.
-
-## Develop
-
-```bash
-git clone git@github.com:wtasg/node-lib.git
-npm run build
-npm run test
-# make changes...
-```
-
-We are using `node --test` for testing.
-
-## Install and Usage
-
-```bash
-npm install @wtasnorg/node-lib
-```
-
-```typescript
-# check if you can run code
-import {hello} from "@wtasnorg/node-lib";
-
-await hello(); 
-// "hello from @wtasnorg/node-lib"
-```
-
-## License: MIT
-
-[MIT License file](_media/LICENSE)
+- [createFindDirectories](functions/createFindDirectories.md)
+- [hello](functions/hello.md)
+- [parseUserAgent](functions/parseUserAgent.md)
+- [pojo](functions/pojo.md)