een-api-toolkit 0.2.1 → 0.3.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -2,79 +2,23 @@
2
2
 
3
3
  All notable changes to this project will be documented in this file.
4
4
 
5
- ## [0.2.1] - 2026-01-03
5
+ ## [0.3.4] - 2026-01-04
6
6
 
7
7
  ### Release Summary
8
8
 
9
- #### PR #41: Release v0.2.0 - Dependency updates, E2E fixes, and documentation
10
- ## Summary
11
-
12
- Release version 0.2.0 with major dependency updates, E2E test improvements, and documentation enhancements.
13
-
14
- ### Breaking Changes
15
-
16
- - **Pinia 3.0 Required**: Peer dependency changed from `^2.0.0 || ^3.0.0` to `^3.0.0`
17
-
18
- ### Key Changes
19
-
20
- **Dependency Updates:**
21
- - ESLint 8 → 9 with flat config migration
22
- - @typescript-eslint packages → v8
23
- - eslint-plugin-vue → v10
24
- - Pinia → v3 across all examples
25
- - @types/node, @vue/tsconfig updated
26
-
27
- **E2E Test Improvements:**
28
- - Rewrote vue-feeds and vue-media auth tests to be self-contained
29
- - Fixed Playwright "double require" conflict
30
- - Added configurable baseURL support
31
- - Improved error logging for local debugging
32
- - Added comprehensive E2E testing documentation
33
-
34
- **Documentation:**
35
- - Added CHANGELOG.md documenting breaking changes
36
- - Added "Running E2E Tests" section to README
37
- - Added "Working Examples" note to AI-CONTEXT.md
38
- - Added "Live Video Viewer App" prompt to Prompts.md
39
-
40
- ### Commits
41
-
42
- - `245e2b9` docs: Add Live Video Viewer prompt to Prompts.md
43
- - `3da2ba8` docs: Add working examples note to AI-CONTEXT.md
44
- - `cf3343c` chore: Bump version to 0.2.0 and add CHANGELOG
45
- - `cca7f8c` fix: Address remaining code review recommendations
46
- - `0c09a7a` fix: Address code review feedback for PR #40
47
- - `0b44931` chore: Update dependencies and fix E2E tests
48
-
49
- ## Test Results
50
-
51
- - ✅ Lint: Passed (1 warning)
52
- - ✅ Unit tests: 164 passed
53
- - ✅ Build: Successful
54
- - ✅ E2E tests: 67 passed across 5 examples
55
-
56
- ## Version
57
-
58
- `0.2.0`
59
-
60
- 🤖 Generated with [Claude Code](https://claude.com/claude-code)
61
-
9
+ No PR descriptions available for this release.
62
10
 
63
11
  ### Detailed Changes
64
12
 
65
- #### Bug Fixes
66
- - fix: Fix vue-users E2E test and Prompts.md branch reference
67
-
68
13
  #### Other Changes
69
- - docs: Clarify redirect URI comes from toolkit configuration
70
- - docs: Address code review feedback for OAuth and logout documentation
71
- - docs: Clarify OAuth callback handling and add logout button to prompts
72
- - docs: Add Live Video Viewer prompt to Prompts.md
73
- - docs: Add working examples note to AI-CONTEXT.md
14
+ - docs: Address code review feedback
15
+ - docs: Update README description and add disclaimer
16
+ - docs: Move infographic above Key Features section
17
+ - docs: Add infographic header image to README
74
18
 
75
19
  ### Links
76
20
  - [npm package](https://www.npmjs.com/package/een-api-toolkit)
77
- - [Full Changelog](https://github.com/klaushofrichter/een-api-toolkit/compare/v0.2.0...v0.2.1)
21
+ - [Full Changelog](https://github.com/klaushofrichter/een-api-toolkit/compare/v0.3.0...v0.3.4)
78
22
 
79
23
  ---
80
- *Released: 2026-01-03 11:40:40 CST*
24
+ *Released: 2026-01-04 15:31:38 CST*
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # een-api-toolkit
2
2
 
3
- A TypeScript library for the [Eagle Eye Networks](https://een.com/) Video API v3.0, designed for Vue 3 applications.
3
+ A TypeScript library for the [Eagle Eye Networks (EEN)](https://een.com/) Video Platform API v3.0, designed for Vue 3 applications.
4
4
 
5
5
  ## Purpose
6
6
 
@@ -8,8 +8,12 @@ This toolkit aims to **simplify and accelerate web application development** for
8
8
 
9
9
  The project is also designed to **enable AI-assisted software development**. With comprehensive documentation, clear code patterns, and an AI-optimized context file (`docs/AI-CONTEXT.md`), AI coding assistants can effectively help developers build, extend, and maintain applications using this toolkit.
10
10
 
11
+ This repository is provided as-is without any warranty, functionality guarantee, or assurance of availability. This repository uses EEN's services but is not affiliated with Eagle Eye Networks.
12
+
11
13
  > **Note:** Work in progress - do not use in production yet.
12
14
 
15
+ ![Architecture diagram showing TypeScript library with Vue 3 and Pinia integration, secure OAuth proxy design, multi-layered testing with Vitest and Playwright, and AI-powered CI/CD pipeline](./docs/images/een-api-toolkit-infograph.png)
16
+
13
17
  ## Key Features
14
18
 
15
19
  - **Plain Async Functions** - Simple API calls with `getCurrentUser()`, `getUsers()`, `getUser()`, `getCameras()`, `getCamera()`
@@ -249,5 +253,3 @@ npm run test:e2e:ui
249
253
  MIT
250
254
 
251
255
  ---
252
-
253
- This repository is provided as-is without warranty. It uses EEN services but is not affiliated with Eagle Eye Networks.
@@ -1,6 +1,6 @@
1
1
  # EEN API Toolkit - AI Reference
2
2
 
3
- > **Version:** 0.2.1
3
+ > **Version:** 0.3.4
4
4
  >
5
5
  > This file is optimized for AI assistants. It contains all API signatures,
6
6
  > types, and usage patterns in a single, parseable document.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "een-api-toolkit",
3
- "version": "0.2.1",
3
+ "version": "0.3.4",
4
4
  "description": "EEN Video platform API v3.0 library for Vue 3",
5
5
  "type": "module",
6
6
  "main": "./dist/index.cjs",
@@ -35,6 +35,7 @@
35
35
  "docs:ai-context": "npx tsx scripts/generate-ai-context.ts",
36
36
  "verify-package": "./scripts/verify-package.sh",
37
37
  "prepublishOnly": "npm run build && npm run docs",
38
+ "build:presentation": "node scripts/generate-presentation.cjs && npx @marp-team/marp-cli PRESENTATION.md -o PRESENTATION.html",
38
39
  "prepare": "husky"
39
40
  },
40
41
  "peerDependencies": {
@@ -42,6 +43,7 @@
42
43
  "vue": "^3.3.0"
43
44
  },
44
45
  "devDependencies": {
46
+ "@marp-team/marp-cli": "^4.2.3",
45
47
  "@playwright/test": "^1.57.0",
46
48
  "@types/node": "^25.0.3",
47
49
  "@typescript-eslint/eslint-plugin": "^8.51.0",