Skip to content

Release v1.1.17#409

Merged
ormidales merged 27 commits into
mainfrom
1.1.17
Apr 2, 2026
Merged

Release v1.1.17#409
ormidales merged 27 commits into
mainfrom
1.1.17

Conversation

@ormidales
Copy link
Copy Markdown
Owner

This pull request primarily improves and clarifies JSDoc documentation throughout the codebase, especially for public APIs and critical internal functions. It also makes minor export and test adjustments to ensure documentation and exports are consistent and well-validated. The most notable changes are grouped below:

JSDoc and API Documentation Improvements

  • Expanded and clarified the JSDoc for GltfLoaderOptions.resolveUri, explicitly stating the callback must return a Promise, documenting error propagation, and adding @param and @returns tags. Also, baseline URI protections are now documented in a @remarks block. [1] [2] [3] [4]
  • Improved JSDoc for ShaderCache.getProgramKey to include a detailed @remarks block about key stability and usage, and clarified documentation for ShaderCache.MAX_KEY_LENGTH. [1] [2] [3] [4]
  • Enhanced JSDoc for RenderSystem.flushStaleMeshBuffers and the CONSECUTIVE_MESH_BUFFER_FAILURE_WARNING_THRESHOLD constant, adding @param, @returns, and rationale for the threshold/reset behavior. [1] [2] [3] [4]

Export and API Surface Adjustments

  • Changed the wrapGltfError utility to be exported from GltfLoader.ts and validated its export and JSDoc via new tests. [1] [2] [3] [4]
  • Updated the core/index.ts barrel export to re-export Material, DEFAULT_VERTEX_SOURCE, and DEFAULT_FRAGMENT_SOURCE together, removing duplicated JSDoc and security notes from the barrel file. Corresponding tests were updated for this new export style. [1] [2]

Version Bump

  • Incremented the package version from 1.1.16 to 1.1.17 in package.json.

Copilot AI and others added 27 commits April 1, 2026 19:31
Agent-Logs-Url: https://github.com/ormidales/microgl/sessions/9b4eaae0-8756-4d92-9a65-e09db5fa3688

Co-authored-by: ormidales <46538211+ormidales@users.noreply.github.com>
…ns-docs

docs(GltfLoader): move strict baseline URI protections into @remarks block
…length

docs(ShaderCache): add rationale JSDoc to MAX_KEY_LENGTH and enforce with tests
…e-mesh-buffer-threshold

docs(RenderSystem): clarify CONSECUTIVE_MESH_BUFFER_FAILURE_WARNING_THRESHOLD JSDoc
Export `wrapGltfError` with JSDoc from `GltfLoader.ts`
…s to getProgramKey

- Move @remarks block to appear immediately after the summary line,
  before the code example, so the ordering constraint is the first
  thing readers see
- Add @see getProgram, @see retainProgram, @see releaseProgram tags
- Use {@link getProgram} inline link in @remarks text
- Update 3 existing JSDoc tests to anchor on the method signature
  (getProgramKey(vertexSource) → lastIndexOf backward) instead of the
  brittle forward-scan from the first 'getProgramKey' text occurrence
- Add 2 new tests: @see getProgram present, @remarks before @param

Agent-Logs-Url: https://github.com/ormidales/microgl/sessions/d954493b-35c1-49f2-afa5-40b439a6e25d

Co-authored-by: ormidales <46538211+ormidales@users.noreply.github.com>
…mkey-documentation

docs(ShaderCache): move @remarks before code example and add @see tags to getProgramKey
…ent-source

Move DEFAULT_VERTEX_SOURCE / DEFAULT_FRAGMENT_SOURCE JSDoc from re-export to declaration site
… add matching tests

Agent-Logs-Url: https://github.com/ormidales/microgl/sessions/13b57889-c7bf-4004-a3e8-ffc596e587ec

Co-authored-by: ormidales <46538211+ormidales@users.noreply.github.com>
…to-jsdoc

docs(RenderSystem): add @param em and @returns to flushStaleMeshBuffers JSDoc
…opagation, @param and @returns tags

Agent-Logs-Url: https://github.com/ormidales/microgl/sessions/f9487d93-c163-439a-b9f4-0e3dcc65f76f

Co-authored-by: ormidales <46538211+ormidales@users.noreply.github.com>
…c-for-resolveuri

docs(GltfLoader): document Promise requirement, rejection propagation, and add @param/@returns to resolveUri
@ormidales ormidales added this to the v1.1.17 milestone Apr 2, 2026
@ormidales ormidales self-assigned this Apr 2, 2026
@ormidales ormidales marked this pull request as ready for review April 2, 2026 13:34
Copilot AI review requested due to automatic review settings April 2, 2026 13:34
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This release PR (v1.1.17) focuses on tightening and validating public-facing JSDoc contracts across core modules, plus a small API surface tweak (wrapGltfError export) and a version bump.

Changes:

  • Expanded/clarified JSDoc for GltfLoaderOptions.resolveUri, ShaderCache.getProgramKey, and RenderSystem.flushStaleMeshBuffers / mesh-buffer failure threshold constant.
  • Exported wrapGltfError from src/core/GltfLoader.ts and added tests validating both export and JSDoc.
  • Updated the core barrel export style for Material + default shader sources; bumped package version to 1.1.17.

Reviewed changes

Copilot reviewed 9 out of 10 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
tests/shader.test.ts Updates/adds assertions for ShaderCache JSDoc structure (@remarks, @see, MAX_KEY_LENGTH docs).
tests/gltf.test.ts Adds export + behavior tests for wrapGltfError and additional JSDoc contract checks for resolveUri / strict.
tests/ecs.test.ts Adds JSDoc contract checks for flushStaleMeshBuffers and the mesh-buffer failure threshold constant.
tests/core-index.test.ts Adjusts tests to match consolidated barrel re-export of Material + default shader sources without duplicated JSDoc.
src/core/ShaderCache.ts Enhances JSDoc for MAX_KEY_LENGTH and restructures/expands getProgramKey documentation (@remarks, @see).
src/core/index.ts Consolidates Material + default shader source exports into a single re-export line.
src/core/GltfLoader.ts Clarifies resolveUri JSDoc, adds @remarks for baseline protections, and exports wrapGltfError with param docs.
src/core/ecs/systems/RenderSystem.ts Expands JSDoc for the failure threshold constant and adds @param/@returns to flushStaleMeshBuffers.
package.json Version bump to 1.1.17.
package-lock.json Lockfile updated for version bump (and related metadata changes).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread src/core/ecs/systems/RenderSystem.ts
Comment thread tests/shader.test.ts
Comment thread tests/shader.test.ts
@ormidales ormidales merged commit 7a9a149 into main Apr 2, 2026
6 checks passed
@ormidales ormidales deleted the 1.1.17 branch April 2, 2026 13:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants