@machinemetrics/mm-erp-sdk 0.2.0-beta.0 → 0.2.0-beta.2

package/src/types/flattened-work-order.ts

@@ -1,108 +0,0 @@
-/**
- * Canonical representation of a flattened work order row that contains the
- * information needed to build MM work order entities plus their operations.
- *
- * All properties are optional to maintain backwards compatibility with
- * existing connectors.
- */
-export interface FlattenedWorkOrderPartFields {
-  /** ERP part number (required for Parts when present). */
-  partNumber?: string | number;
-  /** ERP part revision or version string. */
-  partRevision?: string | number;
-  /** Routing/method identifier (defaults to "Standard" when omitted). */
-  method?: string;
-}
-
-export interface FlattenedWorkOrderPartOperationFields {
-  /** Sequence number of the operation on the routing. */
-  sequenceNumber?: string | number;
-  /** Resource or machine identifier responsible for the operation. */
-  resourceId?: string | number;
-  /** Operation cycle time expressed in milliseconds. */
-  cycleTimeMs?: number;
-  /** Operation setup time expressed in milliseconds. */
-  setupTimeMs?: number;
-  /** Human-readable description of the operation. */
-  operationDescription?: string;
-  /** Quantity of parts operated on per cycle. */
-  quantityPerPart?: number;
-}
-
-export interface FlattenedWorkOrderFields
-  extends FlattenedWorkOrderPartFields {
-  /** Unique identifier for the work order in the ERP. */
-  workOrderId?: string | number;
-  /** Lot number (if the ERP distinguishes lots). */
-  lot?: string | number;
-  /** Split identifier (if the ERP splits orders). */
-  split?: string | number;
-  /** Sub identifier (for multi-level orders). */
-  sub?: string | number;
-  /** Work order status (e.g., Open, Closed, Released). */
-  status?: string;
-  /**
-   * Due date expressed as an ISO-8601 UTC string (trailing `Z` or explicit offset).
-   * The SDK validates but does not shift timezones.
-   */
-  dueDate?: string;
-  /** Free-form description of the work order. */
-  description?: string;
-  /** Scheduled start datetime in ISO-8601 UTC form. */
-  scheduledStartDate?: string;
-  /** Scheduled end datetime in ISO-8601 UTC form. */
-  scheduledEndDate?: string;
-  /** Closed datetime in ISO-8601 UTC form. */
-  closedDate?: string;
-  /** Quantity required by the work order. */
-  quantityRequired?: number;
-}
-
-export interface FlattenedWorkOrderOperationFields {
-  /** Work order identifier (repeated for each operation). */
-  workOrderId?: string | number;
-  /** Lot identifier for the operation row. */
-  lot?: string | number;
-  /** Split identifier for the operation row. */
-  split?: string | number;
-  /** Sub identifier for the operation row. */
-  sub?: string | number;
-  /** Sequence number for the specific operation. */
-  sequenceNumber?: string | number;
-  /** Resource or machine identifier for the operation. */
-  resourceId?: string | number;
-  /** Quantity started on the operation. */
-  startQuantity?: number;
-  /** Quantity finished on the operation. */
-  finishQuantity?: number;
-  /** Expected reject percentage (0-1). */
-  expectedRejectRate?: number;
-  /** Scheduled start datetime (ISO-8601 UTC). */
-  opScheduledStartDate?: string;
-  /** Scheduled finish datetime (ISO-8601 UTC). */
-  opScheduledFinishDate?: string;
-  /** Closed datetime for the operation (ISO-8601 UTC). */
-  opClosedDate?: string;
-  /** Production burden rate per hour. */
-  productionburdenRateHourly?: number | string;
-  /** Setup burden rate per hour. */
-  setupburdenRatehourly?: number | string;
-  /** Operation type (Production, Setup, etc.). */
-  operationType?: string;
-  /** Quantity per part for the operation. */
-  quantityPerPart?: number;
-  /** Operation status (defaults to work-order status when omitted). */
-  opStatus?: string;
-}
-
-export type FlattenedWorkOrderRowBase =
-  FlattenedWorkOrderPartFields &
-  FlattenedWorkOrderPartOperationFields &
-  FlattenedWorkOrderFields &
-  FlattenedWorkOrderOperationFields;
-
-/**
- * Canonical flattened row that callers pass into
- * `StandardProcessDrivers.syncWorkOrderBatchFromFlattened`.
- */
-export type FlattenedWorkOrderRow = FlattenedWorkOrderRowBase;

package/src/utils/env.ts

@@ -1,75 +0,0 @@
-/**
- * This module contains utility functions to get environment variables with default values and validation.
- */
-
-const normalizeValue = (value?: string | null): string | undefined => {
-  if (value === undefined || value === null) {
-    return undefined;
-  }
-
-  const trimmed = value.trim();
-  if (!trimmed) {
-    return undefined;
-  }
-
-  const lowered = trimmed.toLowerCase();
-  if (lowered === "undefined" || lowered === "null") {
-    return undefined;
-  }
-
-  return trimmed;
-};
-
-const warnInvalid = (key: string, rawValue: string | undefined, reason: string) => {
-  const received = rawValue !== undefined ? `; received "${rawValue}"` : "";
-  console.warn(`[config] ${key} ${reason}${received}`); // eslint-disable-line no-console
-};
-
-export const getEnvString = (key: string, defaultValue = ""): string => {
-  const normalized = normalizeValue(process.env[key]);
-  return normalized ?? defaultValue;
-};
-
-export const getEnvNumber = (
-  key: string,
-  defaultValue: number
-): number => {
-  const normalized = normalizeValue(process.env[key]);
-  if (normalized === undefined) {
-    return defaultValue;
-  }
-
-  const parsed = Number.parseInt(normalized, 10);
-  if (Number.isNaN(parsed)) {
-    warnInvalid(key, normalized, `is not a valid number for key ${key}; falling back to default ${defaultValue}`);
-    return defaultValue;
-  }
-
-  return parsed;
-};
-
-export const getEnvBoolean = (key: string, defaultValue = false): boolean => {
-  const normalized = normalizeValue(process.env[key]);
-  if (normalized === undefined) {
-    return defaultValue;
-  }
-
-  const truthyValues = new Set(["true", "1", "yes", "y", "on"]);
-  const falsyValues = new Set(["false", "0", "no", "n", "off"]);
-  const lowered = normalized.toLowerCase();
-
-  if (truthyValues.has(lowered)) {
-    return true;
-  }
-  if (falsyValues.has(lowered)) {
-    return false;
-  }
-
-  warnInvalid(key, normalized, "is not a recognized boolean; falling back to default");
-  return defaultValue;
-};
-
-export const getOptionalEnv = (key: string): string | undefined => {
-  return normalizeValue(process.env[key]);
-};
-

package/src/utils/erp-timezone-utils.ts

@@ -1,99 +0,0 @@
-import { DateTime } from "luxon";
-import logger from "../services/reporting-service/logger.js";
-import { getCachedTimezoneName } from "./local-data-store/jobs-shared-data.js";
-
-/**
- * Retrieves the ERP timezone name that should have been cached during initialization.
- * @throws Error when the timezone cache has not been populated.
- */
-export function getERPTimezone(): string {
-  const timezone = getCachedTimezoneName();
-  if (!timezone) {
-    throw new Error(
-      "ERP timezone is not cached. Run getTimezoneOffsetAndPersist() to populate it."
-    );
-  }
-  return timezone;
-}
-
-/**
- * Converts a UTC ISO-8601 datetime string to the ERP's local timezone (also ISO-8601).
- * @param utcDateTime ISO-8601 datetime string representing UTC time.
- * @param timezone Optional timezone override; defaults to the cached ERP timezone.
- * @returns ISO-8601 string in the ERP timezone.
- */
-export function convertUtcDateTimeToErpLocal(
-  utcDateTime: string,
-  timezone?: string
-): string {
-  if (!utcDateTime) {
-    throw new Error("convertUtcDateTimeToErpLocal requires a non-empty UTC datetime string");
-  }
-  try {
-    const targetZone = timezone ?? getERPTimezone();
-    const parsedUtc = DateTime.fromISO(utcDateTime, { zone: "utc" });
-    if (!parsedUtc.isValid) {
-      throw new Error(
-        `Invalid UTC datetime "${utcDateTime}": ${parsedUtc.invalidReason}`
-      );
-    }
-
-    const localized = parsedUtc.setZone(targetZone);
-    if (!localized.isValid) {
-      throw new Error(
-        `Unable to convert UTC datetime "${utcDateTime}" to target zone "${targetZone}": ${localized.invalidReason}`
-      );
-    }
-
-    return localized.toISO();
-  } catch (error) {
-    logger.error("convertUtcDateTimeToErpLocal: Failed to convert datetime", {
-      utcDateTime,
-      error,
-    });
-    throw new Error(
-      "Failed to convert UTC datetime to ERP local timezone. See logs for details."
-    );
-  }
-}
-
-/**
- * Converts an ERP-local ISO-8601 datetime string to UTC (still ISO-8601).
- * @param localDateTime ISO-8601 datetime string representing ERP local time.
- * @param timezone Optional timezone override; defaults to the cached ERP timezone.
- * @returns ISO-8601 string in UTC.
- */
-export function convertErpLocalDateTimeToUtc(
-  localDateTime: string,
-  timezone?: string
-): string {
-  if (!localDateTime) {
-    throw new Error("convertErpLocalDateTimeToUtc requires a non-empty local datetime string");
-  }
-  try {
-    const sourceZone = timezone ?? getERPTimezone();
-    const parsedLocal = DateTime.fromISO(localDateTime, { zone: sourceZone });
-    if (!parsedLocal.isValid) {
-      throw new Error(
-        `Invalid ERP local datetime "${localDateTime}" for zone "${sourceZone}": ${parsedLocal.invalidReason}`
-      );
-    }
-
-    const utcDateTime = parsedLocal.setZone("utc");
-    if (!utcDateTime.isValid) {
-      throw new Error(
-        `Unable to convert ERP local datetime "${localDateTime}" to UTC: ${utcDateTime.invalidReason}`
-      );
-    }
-
-    return utcDateTime.toISO();
-  } catch (error) {
-    logger.error("convertErpLocalDateTimeToUtc: Failed to convert datetime", {
-      localDateTime,
-      error,
-    });
-    throw new Error(
-      "Failed to convert ERP local datetime to UTC. See logs for details."
-    );
-  }
-}