@pie-players/pie-calculator

Provider-neutral calculator contracts for PIE Players. This package has no UI or vendor implementation code.

Installation

bun add @pie-players/pie-calculator

Contract

The package exports:

• CalculatorProvider, the factory and capability contract implemented by a calculator adapter;
• Calculator, the lifecycle, value, state, resize, and focus contract for one mounted calculator;
• CalculatorProviderInit, the provider-level credential and instrumentation surface;
• CalculatorProviderConfig, whose settings object is interpreted by the selected implementation; and
• CalculatorType, with basic, scientific, and graphing modes.

Provider-specific settings belong to the provider package. Generic code passes them through without importing or naming Desmos, GeoGebra, or another vendor.

import type {
  Calculator,
  CalculatorProvider,
  CalculatorProviderCapabilities,
  CalculatorProviderConfig,
  CalculatorProviderInit,
  CalculatorType,
} from "@pie-players/pie-calculator";

interface MyCalculatorProviderConfig extends CalculatorProviderConfig {
  precision?: number;
}

export class MyCalculatorProvider implements CalculatorProvider {
  readonly providerId = "my-calculator";
  readonly providerName = "My Calculator";
  readonly supportedTypes: CalculatorType[] = ["basic", "scientific"];
  readonly version = "1";

  async initialize(config?: CalculatorProviderInit): Promise<void> {
    // Load libraries and initialize provider-level services.
  }

  async createCalculator(
    type: CalculatorType,
    container: HTMLElement,
    config?: MyCalculatorProviderConfig,
  ): Promise<Calculator> {
    return createMyCalculator({ provider: this, type, container, config });
  }

  supportsType(type: CalculatorType): boolean {
    return this.supportedTypes.includes(type);
  }

  getCapabilities(): CalculatorProviderCapabilities {
    return {
      supportsHistory: true,
      supportsGraphing: false,
      supportsExpressions: true,
      canExport: true,
      inputMethods: ["keyboard", "mouse", "touch"],
    };
  }

  destroy(): void {}
}

Implementations

• @pie-players/pie-calculator-desmos
• @pie-players/pie-calculator-geogebra

Each implementation and its underlying calculator product has its own package and licensing boundary. No vendor library is bundled by this contract package.

License

PIE-authored code in this package is MIT licensed.