ODS-Typings

Centralized TypeScript type definitions for shared domain models across services and applications.

This package provides declaration-only exports (.d.ts) with no runtime footprint. It is intended for consumption across backend services, frontend clients, and tooling layers.

Core Interfaces

Our core interfaces are inspired by the widely-used schema.org vocabulary. This allows us to build a robust and interoperable data model. The main components are:

• Thing: The most generic type of item.
• Person: Represents a person.
• Place: Represents a physical location.
• ContactPoint: Represents a point of contact.
• PostalAddress: Represents a postal address.

We will be building custom elements that implement these core interfaces.

Installation

npm install ods-typings
# or
pnpm add ods-typings

Releasing New Versions

To release a new version, use the npm version command from the main branch after pulling the latest changes. These scripts will bump the version in package.json, create a new git tag, and commit the changes.

# For a patch release (e.g., 0.1.0 -> 0.1.1)
npm run release:patch

# For a minor release (e.g., 0.1.0 -> 0.2.0)
npm run release:minor

# For a major release (e.g., 0.1.0 -> 1.0.0)
npm run release:major

After versioning, push the commit and the new tag to trigger the publish workflow:

npm run push