enonic-library-reference

Enonic XP Server-Side Library Reference

Procedures

Step 1: Identify the Target Library

1. Determine which /lib/xp/* library the query relates to.
2. Map the library to the appropriate reference file:

Library	Reference File
lib-content	references/lib-content-reference.md
lib-node	references/lib-node-reference.md
lib-auth	references/lib-auth-reference.md
lib-portal	references/lib-portal-reference.md
lib-context, lib-event, lib-task	references/lib-context-reference.md
lib-io, lib-mail, lib-repo, lib-schema	references/lib-utilities-reference.md
lib-project, lib-export, lib-scheduler, lib-value	references/lib-cms-reference.md
lib-i18n, lib-websocket	references/lib-web-reference.md
lib-admin, lib-app, lib-auditlog, lib-cluster, lib-common, lib-grid, lib-vhost	references/lib-platform-reference.md

1. If the query spans multiple libraries or asks for a usage pattern, read references/examples.md.

Step 2: Look Up the Function

1. Read the identified reference file.
2. Locate the specific function by name.
3. Extract the following details:
   • Signature: Function name and import path.
   • Parameters: Name, type, required/optional, default value, description.
   • Return type: Type and shape of the returned value.
   • Example: Code snippet demonstrating correct usage.

Step 3: Provide the Answer

1. Present the function signature with its import statement.
2. Include the parameter table with types and descriptions.
3. Include the return type and shape.
4. Add a usage example. If the reference file includes one, use it. Otherwise, compose a minimal working example consistent with the documented signature.
5. Note any version requirements (e.g., "Requires XP 7.8.0+").

Step 4: Handle Cross-Library Patterns

1. If the query involves combining multiple libraries (e.g., "create content as admin"), read references/examples.md for established patterns.
2. If a pattern is not documented, compose it by combining individual function signatures from the relevant reference files.

Step 5: Troubleshoot Common Issues

1. If the query describes an error or unexpected behavior, read references/troubleshooting.md.
2. Match the error message or symptom to a known issue.
3. Provide the documented fix and any version-compatibility notes.

Step 6: Generate Import Blocks

1. If the user needs a reusable import block, read assets/enonic-imports.template.ts.
2. Uncomment only the libraries required for the user's controller.

Error Handling

• If a function is not found in any reference file, report that it may belong to a community library or a newer XP version not yet documented, and suggest checking https://developer.enonic.com/docs/xp/7.x/api.
• If the query relates to Guillotine/GraphQL, content type schemas, or Enonic CLI, indicate that this skill does not cover those topics.
• If a version mismatch is suspected, consult the version compatibility table in references/troubleshooting.md.