Installation

npm install rim-xmg-database-lib

Usage

import { hello, version } from 'rim-xmg-database-lib';

console.log(hello('World')); // Hello, World
console.log(version); // 0.0.1

Development

Scripts:

• npm run build – Clean and compile TypeScript to dist.
• npm run lint – Lint all .ts files.
• npm run format – Apply Prettier formatting.

Publishing

The prepare script builds on install. Before publishing:

npm version patch   # or minor/major
npm publish

GitHub

Repository: https://github.com/Rimblehelm/rim-xmg-database-lib

rim-xmg-database-lib

Rimblehelm XMG database utilities (TypeScript library)

TypeScript library providing utilities for working with XMG database structures.

Installation

npm install rim-xmg-database-lib

Usage

import { hello, version } from 'rim-xmg-database-lib';

console.log(hello('World')); // Hello, World
console.log(version); // 0.0.1

Development

Scripts:

• npm run build – Clean and compile TypeScript to dist.
• npm run lint – Lint all .ts files.
• npm run format – Apply Prettier formatting.

Publishing

The prepare script builds on install. Before publishing:

npm version patch   # or minor/major
npm publish

Notes:

• The package is configured to publish publicly to npm via publishConfig.access = "public".
• For secure publishing from GitHub Actions we recommend using GitHub's OpenID Connect (OIDC) provider rather than storing NPM_TOKEN as a secret. See setup notes below.

OIDC setup for npm publishing

1. In GitHub repository settings → Actions → General, ensure OIDC is enabled for the organization / repository.
2. In your npm account, add a new "OIDC" trusted identity / publisher that trusts GitHub Actions for this repository (npm provides a way to accept tokens from GitHub as a trusted publisher). Follow npm's "Use GitHub Actions to publish packages" guidance to register GitHub as a trusted provider.
3. After that is configured, the semantic-release workflow (.github/workflows/semantic-release.yml) will use the OIDC token to authenticate to npm and publish without needing NPM_TOKEN.

If OIDC is not available for your npm account, semantic-release supports publishing with NPM_TOKEN stored as a repository secret. Create it in GitHub settings → Secrets → Actions, name it NPM_TOKEN, and semantic-release will use it as a fallback.

GitHub

Update USERNAME in package.json once repository is created.

License

MIT