api-console 6.6.62 → 6.6.65

package/AGENTS.md

@@ -0,0 +1,195 @@
+# AGENTS.md - api-console v6
+
+AI context file for assistants (Claude Code, Cursor, Copilot) working with this open-source Web Components project.
+
+> **Full docs**: [README.md](./README.md) | **Team patterns**: [docs/team/](./docs/team/)
+
+---
+
+## Tech Stack
+
+- **LitElement 2.x** + Web Components (Shadow DOM)
+- **AMF v4.0+** (API Modeling Framework - RAML/OAS/AsyncAPI/gRPC)
+- **npm workspace** (18+ packages, main: `api-console`, components: `api-navigation`, `api-documentation`, etc.)
+- **@web/test-runner** (testing, **NOT Jest** - poor Shadow DOM support)
+- **Rollup** (builds), **Playwright** (visual regression)
+
+### Two Entry Points
+- `src/ApiConsoleApp.js` - Standalone app (routing, layout, OAuth)
+- `src/ApiConsole.js` - Embeddable component (no routing/layout)
+
+---
+
+## AMF Model Architecture (CRITICAL)
+
+**IMPORTANT**: API Console does **NOT** parse API files directly. It requires **pre-generated AMF models**.
+
+### What is AMF?
+MuleSoft's unified model for RAML, OAS, AsyncAPI, gRPC. Format: JSON-LD (AMF v4.0+).
+
+### Generate Models
+```bash
+# 1. Define APIs in demo/apis.json: { "path/to/api.raml": "RAML 1.0" }
+# 2. Generate models
+npm run build:models
+# 3. Models saved to demo/models/*.json
+```
+
+### Load Models
+```javascript
+// Direct model
+apiConsole.amf = await generateApiModel();
+
+// URL to JSON
+apiConsole.modelLocation = 'models/my-api.json';
+```
+
+---
+
+## Coding Patterns (CRITICAL)
+
+### 1. Component Communication
+
+**IMPORTANT**: Use custom events, **NOT** direct method calls.
+
+```javascript
+// ✅ GOOD: Custom event (bubbles across Shadow DOM)
+this.dispatchEvent(new CustomEvent('api-navigation-selection-changed', {
+  bubbles: true,
+  composed: true,
+  detail: { selected, type }
+}));
+
+// ❌ BAD: Direct method call (breaks encapsulation)
+this.parentElement.onNavigationChange(selected);
+```
+
+**Why**: Shadow DOM isolation requires composed events to bubble across boundaries.
+
+### 2. AMF Queries
+
+**IMPORTANT**: Use AmfHelperMixin utilities, **NOT** direct JSON access.
+
+```javascript
+// ✅ GOOD: AmfHelperMixin
+import { AmfHelperMixin } from '@api-components/amf-helper-mixin';
+
+class MyComponent extends AmfHelperMixin(LitElement) {
+  _computeEndpoints(model) {
+    return this._computeWebApi(model); // Helper method
+  }
+}
+
+// ❌ BAD: Direct JSON access (structure changes)
+const endpoints = model['@graph'][0]['http://raml.org/vocabularies/http#endpoint'];
+```
+
+**Why**: AMF model structure can change; helpers abstract this.
+
+### 3. Shadow DOM Styling
+
+Use CSS custom properties for theming:
+```css
+:host {
+  --api-console-primary-color: #00A1E0;
+}
+```
+
+❌ **Never** manipulate DOM styles directly (`document.querySelector('#api-console').style...`).
+
+### 4. Lazy Loading
+
+For large APIs, lazy load components on demand:
+```javascript
+if (this.selectedShape) {
+  import('@api-components/api-documentation')
+    .then(() => this._renderDocumentation());
+}
+```
+
+---
+
+## Testing Strategy
+
+### Commands
+```bash
+npm test                     # All tests (chromium + firefox)
+npm run test:watch           # Watch mode
+npm run test:visual          # Visual regression
+npm run test:visual:update   # Update baselines (after intentional UI changes)
+```
+
+### Write Tests with @web/test-runner
+**IMPORTANT**: Use @web/test-runner, **NOT Jest** (poor Shadow DOM support).
+
+```javascript
+import { fixture, expect } from '@open-wc/testing';
+it('renders navigation', async () => {
+  const el = await fixture('<api-console></api-console>');
+  expect(el.shadowRoot.querySelector('api-navigation')).to.exist;
+});
+```
+
+---
+
+## Anti-Patterns
+
+### Code
+- **IMPORTANT: Never parse API files directly** → Use AMF models
+- **IMPORTANT: Never access AMF JSON directly** → Use AmfHelperMixin
+- **IMPORTANT: Never use direct method calls between components** → Use custom events
+- **Never use Jest** → Use @web/test-runner
+- **Never use `any` in TypeScript** → Proper types
+
+### Dependencies
+- **Never import CodeMirror/crypto as ES modules** → Use `vendor.js` (non-ES6 dependencies bundled separately)
+- **Never modify AMF model structure** → External standard, use helpers
+
+### Git
+- **Never commit directly to master** → Always create branch first (`fix/W-XXXXXXXX-desc` or `build/X.X.X`)
+- **Never skip GPG signing** → Run `mulesoft-git` before committing
+- **Never commit large models** → Generate locally (`npm run build:models`)
+
+---
+
+## Build & Verification Strategy
+
+**Rule**: Don't run build after every small change (saves tokens, avoids error loops).
+
+**Workflow**:
+1. Implement feature
+2. Write tests
+3. Run `npm test` (once)
+4. Run `npm run build` only when: user asks explicitly, before PR, or after major type changes
+
+---
+
+## Quick Commands
+
+```bash
+npm run prepare              # Build vendor.js + generate AMF models (required after clone)
+npm start                    # Dev server
+npm test                     # Run all tests
+npm run build                # Production build
+npm run build:models         # Generate AMF models from demo/apis.json
+npm update @api-components/* # Update workspace components
+```
+
+---
+
+## Links
+
+### Team Documentation
+- **Runbooks**: [docs/team/runbooks/](./docs/team/runbooks/) - Release process, debugging
+- **Patterns**: [docs/team/patterns/](./docs/team/patterns/) - Web Component communication, architecture
+- **Configs**: [docs/team/configs/](./docs/team/configs/) - Git GPG setup, IDE settings
+
+### External Resources
+- **Full docs**: https://docs.api-console.io
+- **AMF**: https://github.com/aml-org/amf
+- **LitElement v2**: https://lit.dev/docs/v2/
+- **@web/test-runner**: https://modern-web.dev/docs/test-runner/overview/
+
+---
+
+**Last Updated**: 2026-03-20 (Ultra-optimized for AI context efficiency)

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,62 @@
+# Salesforce Open Source Community Code of Conduct
+
+## About the Code of Conduct
+
+Equality is a core value at Salesforce. We believe a diverse and inclusive community fosters innovation and creativity, and are committed to building a culture where everyone feels included.
+
+Salesforce open-source projects are committed to providing a friendly, safe, and welcoming environment for all, regardless of gender identity and expression, sexual orientation, disability, physical appearance, body size, ethnicity, nationality, race, age, religion, level of experience, education, socioeconomic status, or other similar personal characteristics.
+
+The goal of this code of conduct is to specify a baseline standard of behavior so that people with different social values and communication styles can work together effectively, productively, and respectfully in our open source community. It also establishes a mechanism for reporting issues and resolving conflicts.
+
+All questions and reports of abusive, harassing, or otherwise unacceptable behavior in a Salesforce open-source project may be reported by contacting the Salesforce Open Source Conduct Committee at ossconduct@salesforce.com.
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of gender identity and expression, sexual orientation, disability, physical appearance, body size, ethnicity, nationality, race, age, religion, level of experience, education, socioeconomic status, or other similar personal characteristics.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy toward other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Personal attacks, insulting/derogatory comments, or trolling
+* Public or private harassment
+* Publishing, or threatening to publish, others' private information—such as a physical or electronic address—without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+* Advocating for or encouraging any of the above behaviors
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project email address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the Salesforce Open Source Conduct Committee at ossconduct@salesforce.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The committee is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership and the Salesforce Open Source Conduct Committee.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][contributor-covenant-home], version 1.4, available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html. It includes adaptions and additions from [Go Community Code of Conduct][golang-coc], [CNCF Code of Conduct][cncf-coc], and [Microsoft Open Source Code of Conduct][microsoft-coc].
+
+This Code of Conduct is licensed under the [Creative Commons Attribution 3.0 License][cc-by-3-us].
+
+[contributor-covenant-home]: https://www.contributor-covenant.org (https://www.contributor-covenant.org/)
+[golang-coc]: https://golang.org/conduct
+[cncf-coc]: https://github.com/cncf/foundation/blob/master/code-of-conduct.md
+[microsoft-coc]: https://opensource.microsoft.com/codeofconduct/
+[cc-by-3-us]: https://creativecommons.org/licenses/by/3.0/us/

package/README.md

@@ -152,3 +152,16 @@ For the same reasons as for CodeMirror this dependencies are required for OAuth1
 <script src="node_modules/cryptojslib/rollups/hmac-sha1.js"></script>
 <script src="node_modules/jsrsasign/lib/jsrsasign-rsa-min.js"></script>
 ```
+
+---
+
+## For AI Assistants
+
+This repo includes AI context for tools like Claude Code, Cursor, and Copilot:
+
+- **[AGENTS.md](./AGENTS.md)**: Tech stack, architecture patterns, AMF model usage, testing strategy
+- **[docs/team/](./docs/team/)**: Runbooks (release process, debugging), patterns (Web Component communication), configs
+
+**For contributors**: See [docs/team/README.md](./docs/team/README.md) for how to use and contribute.
+
+---

package/SECURITY.md

@@ -0,0 +1,3 @@
+## Security
+
+Please report any security issue to [security@salesforce.com](mailto:security@salesforce.com) as soon as it is discovered. This library limits its runtime dependencies in order to reduce the total cost of ownership as much as can be, but all consumers should remain vigilant and have their security stakeholders review all third-party products (3PP) like this one and their dependencies.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "api-console",
   "description": "The API Console to automatically generate API documentation from RAML and OAS files.",
-  "version": "6.6.62",
+  "version": "6.6.65",
   "license": "CPAL-1.0",
   "main": "index.js",
   "module": "index.js",
@@ -155,9 +155,9 @@
     "semver": "7.5.4",
     "decode-uri-component": "0.4.1",
     "set-value": "4.1.0",
-    "dompurify": "3.2.5"
+    "dompurify": "3.4.5"
   },
   "resolutions": {
-    "dompurify": "3.2.5"
+    "dompurify": "3.4.5"
   }
 }