@multisystemsuite/timezone-engine-shared-types

Shared TypeScript types and interfaces for the entire timezone-engine monorepo.

What it is used for

• Type-safe APIs across all @multisystemsuite/timezone-engine-* packages
• Custom integrations, plugins, and enterprise extensions
• Ensuring consistent contracts in microfrontends and multi-service architectures
• Zero runtime overhead — types only (erased at compile time)

Install

npm install @multisystemsuite/timezone-engine-shared-types

Usually pulled in automatically as a dependency of @multisystemsuite/timezone-engine-core.

Usage

import type {
  TimezoneInfo,
  DateFormatType,
  FormatDateOptions,
  WorldClockEntry,
  SchedulerConfig,
  MeetingOverlapResult,
  TimezoneEngineConfig,
  TimezonePlugin,
} from "@multisystemsuite/timezone-engine-shared-types";

const config: TimezoneEngineConfig = {
  defaultTimezone: "Asia/Kolkata",
  defaultLocale: "en-IN",
  cacheEnabled: true,
};

const format: DateFormatType = "ISO";

const plugin: TimezonePlugin = {
  name: "tenant-isolation",
  beforeFormat: (_date, options) => ({
    ...options,
    timezone: tenant.timezone,
  }),
};

Main types

| Type | Purpose | | ------------------------ | ---------------------------- | | TimezoneInfo | IANA timezone metadata | | DateFormatType | ISO, SHORT, LONG, FULL, etc. | | FormatDateOptions | Formatting options | | WorldClockEntry | World clock row data | | SchedulerConfig | Scheduler engine config | | MeetingOverlapResult | Meeting overlap analysis | | TimezoneEngineConfig | Engine + plugin config | | TimezonePlugin | Plugin hook interface | | CountryTimezoneMapping | Country → timezones | | ShiftDefinition | Workforce shift model | | UTCStorageRecord | UTC storage with metadata | | AuditTimestamp | Audit log timestamp shape | | PayrollTimeResult | Payroll UTC shift result | | TenantTimezoneConfig | Multi-tenant timezone config |

Related packages

All other @multisystemsuite/timezone-engine-* packages depend on this package.

Keywords

timezone, typescript, types, interfaces, enterprise, iana

License

MIT