@eventconnectors/ndtrc_model 1.1.0 → 1.2.1

package/package.json

@@ -1,19 +1,60 @@
 {
   "name": "@eventconnectors/ndtrc_model",
-  "version": "1.1.0",
-  "main": "index.js",
+  "version": "1.2.1",
+  "description": "Zod schemas for the NDTRC tourism data model — TypeScript port of the Groovy ndtrc_model library",
+  "keywords": [
+    "ndtrc",
+    "eventconnectors",
+    "feed-factory",
+    "zod",
+    "tourism"
+  ],
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/TheFeedFactory/ndtrc_model.git",
+    "directory": "ts"
+  },
+  "bugs": {
+    "url": "https://github.com/TheFeedFactory/ndtrc_model/issues"
+  },
+  "homepage": "https://github.com/TheFeedFactory/ndtrc_model/tree/master/ts#readme",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
   "scripts": {
-    "test": "jest"
+    "build": "tsup",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run"
   },
   "dependencies": {
-    "dayjs": "^1.11.19",
-    "moment": "^2.30.1",
-    "xmlbuilder": "^15.1.1"
+    "zod": "^3.24.4"
   },
   "devDependencies": {
-    "jest": "^30.2.0"
+    "@types/node": "^25.6.0",
+    "tsup": "^8.4.0",
+    "typescript": "^5.8.3",
+    "vitest": "^3.1.3"
   },
-  "private": false,
-  "author": "wwwappz",
-  "license": "MIT"
+  "engines": {
+    "node": ">=18"
+  }
 }

package/.claude/settings.local.json

@@ -1,14 +0,0 @@
-{
-  "permissions": {
-    "allow": [
-      "Bash(npm test)",
-      "Bash(node -e:*)",
-      "WebFetch(domain:github.com)",
-      "WebFetch(domain:api.github.com)",
-      "WebFetch(domain:raw.githubusercontent.com)",
-      "Bash(npm publish:*)"
-    ],
-    "deny": [],
-    "ask": []
-  }
-}

package/CLAUDE.md

@@ -1,54 +0,0 @@
-# CLAUDE.md
-
-This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
-
-## Project Overview
-
-This is the `@eventconnectors/ndtrc_model` npm package - a Node.js data model library for NDTRC (Nationale Databank Toerisme en Recreatie Centraal), the Dutch national tourism and recreation database. It provides JavaScript classes for representing tourism events, locations, and related entities.
-
-## Commands
-
-- **Run tests**: `npm test` (uses Jest)
-- **Install dependencies**: `npm install`
-
-## Architecture
-
-### Entry Point
-- `index.js` - Exports all model classes from a single entry point
-
-### Model Classes (`src/model/`)
-
-**Core Entry Types:**
-- `FetchedEntry` - Raw data fetched from external sources (with `ExternalLocationInfo`)
-- `ConvertedEntry` - Processed entry containing a validated `TRCItem`
-
-**NDTRC Models (`src/model/ndtrc/`):**
-- `TRCItem` - Main entity representing an event/location with static enums `WFStatus` and `EntityType`
-- `TRCItemDetail` - Multilingual details (title, descriptions) per language
-- `Calendar` - Complex scheduling with single dates, pattern dates, and exception handling
-- `Location` - Location info with address and optional `LocationItem` reference
-- `TRCItemCategories` - Category assignments for items
-
-**Supporting Models:**
-- `Address`, `ContactInfo`, `GISCoordinate` - Location/contact data
-- `PriceElement`, `ExtraPriceInformation` - Pricing information
-- `File`, `Performer`, `Promotion` - Media and marketing
-- `Translations`, `RouteInfo`, `SubItemGroup`, `TRCItemGroup`, `TRCItemRelation`
-
-### Utilities (`src/util/`)
-- `CategoryMap` - Maps external category names to NDTRC category IDs with associated tags
-- `Categories` - NDTRC category ID lookup table
-
-### Key Patterns
-
-1. **Constructor-based initialization**: All model classes use destructured object parameters with defaults
-2. **Nested class instantiation**: Parent classes automatically instantiate child classes (e.g., `TRCItem` creates `Calendar`, `Location` instances)
-3. **Moment.js dates**: Date fields use `moment` for parsing and manipulation
-4. **Static enums**: Enums are defined as static properties on classes (e.g., `TRCItem.WFStatus`, `Calendar.CalendarType`)
-
-### Entity Types
-- `EVENEMENT` - Event
-- `LOCATIE` - Location/venue
-- `EVENEMENTGROEP` - Event group
-- `PLAATSREGIO` - Place/region
-- `ROUTE` - Route

package/index.js

@@ -1,36 +0,0 @@
-// src/index.js
-
-// Exporteer alles in één keer vanuit de respectieve bestanden
-
-module.exports = {
-    // FeedFactory Route Model
-    Route: require("./src/model/ff/Route"),
-    Acl: require("./src/model/ff/Acl"),
-    ItemLink: require("./src/model/ff/ItemLink"),
-
-    // Exporteer alle klassen uit de modelbestanden
-    ConvertedEntry: require("./src/model/ConvertedEntry"),
-    FetchedEntry: require("./src/model/FetchedEntry"),
-    ExternalLocationInfo: require("./src/model/FetchedEntry").ExternalLocationInfo,
-    Location: require("./src/model/ndtrc/Location"),
-    PriceElement: require("./src/model/ndtrc/PriceElement"),
-    TRCItem: require("./src/model/ndtrc/TRCItem"),
-    TRCItemCategories: require("./src/model/ndtrc/TRCItemCategories"),
-    File: require("./src/model/ndtrc/File"),
-    GISCoordinate: require("./src/model/ndtrc/GISCoordinate"),
-    Calendar: require("./src/model/ndtrc/Calendar"),
-    Contactinfo: require("./src/model/ndtrc/ContactInfo"),
-    TRCItemDetail: require("./src/model/ndtrc/TRCItemDetail"),
-  
-    Address: require("./src/model/ndtrc/Address"),
-    ExtraPriceInformation: require("./src/model/ndtrc/ExtraPriceInformation"),
-    Performer: require("./src/model/ndtrc/Performer"),
-    Promotion: require("./src/model/ndtrc/Promotion"),
-    RouteInfo: require("./src/model/ndtrc/RouteInfo"),
-    SubItemGroup: require("./src/model/ndtrc/SubItemGroup"),
-    Translations: require("./src/model/ndtrc/Translations"),
-    TRCItemGroup: require("./src/model/ndtrc/TRCItemGroup"),
-    TRCItemRelation: require("./src/model/ndtrc/TRCItemRelation"),
-    Categories: require("./src/model/ndtrc/Categories"),
-    CategoryMap: require("./src/util/CategoryMap"),
-  };

package/src/__tests__/model.test.js

@@ -1,327 +0,0 @@
-const {
-  TRCItem,
-  FetchedEntry: FetchedEntryModule,
-  ExternalLocationInfo,
-  ConvertedEntry,
-  Location,
-  Calendar: CalendarModule,
-  Contactinfo,
-  File,
-  PriceElement,
-  Performer,
-  TRCItemDetail,
-  Address,
-  GISCoordinate,
-  Categories,
-  CategoryMap,
-} = require("../../index.js");
-
-const { FetchedEntry } = FetchedEntryModule;
-const { Calendar } = CalendarModule;
-
-describe("TRCItem", () => {
-  test("should create with default values", () => {
-    const item = new TRCItem();
-    expect(item.trcid).toBe("");
-    expect(item.published).toBe(false);
-    expect(item.deleted).toBe(false);
-    expect(item.forceOverwrite).toBe(false);
-  });
-
-  test("should create with custom values", () => {
-    const item = new TRCItem({
-      trcid: "test123",
-      published: true,
-      forceOverwrite: true,
-      entitytype: TRCItem.EntityType.EVENEMENT,
-    });
-    expect(item.trcid).toBe("test123");
-    expect(item.published).toBe(true);
-    expect(item.forceOverwrite).toBe(true);
-    expect(item.entitytype).toBe("EVENEMENT");
-  });
-
-  test("should have all EntityType values", () => {
-    expect(TRCItem.EntityType.EVENEMENT).toBe("EVENEMENT");
-    expect(TRCItem.EntityType.LOCATIE).toBe("LOCATIE");
-    expect(TRCItem.EntityType.EVENEMENTGROEP).toBe("EVENEMENTGROEP");
-    expect(TRCItem.EntityType.PLAATSREGIO).toBe("PLAATSREGIO");
-    expect(TRCItem.EntityType.ROUTE).toBe("ROUTE");
-    expect(TRCItem.EntityType.VENUE).toBe("VENUE");
-  });
-
-  test("should have all WFStatus values", () => {
-    expect(TRCItem.WFStatus.DRAFT).toBe("draft");
-    expect(TRCItem.WFStatus.READY_FOR_VALIDATION).toBe("readyforvalidation");
-    expect(TRCItem.WFStatus.APPROVED).toBe("approved");
-    expect(TRCItem.WFStatus.REJECTED).toBe("rejected");
-    expect(TRCItem.WFStatus.DELETED).toBe("deleted");
-    expect(TRCItem.WFStatus.ARCHIVED).toBe("archived");
-  });
-
-  test("should create nested objects", () => {
-    const item = new TRCItem({
-      trcid: "test",
-      location: { label: "Test Location" },
-      contactinfo: { label: "Test Contact" },
-      performers: [{ label: "Artist 1" }],
-      files: [{ filename: "image.jpg" }],
-      trcItemDetails: [{ lang: "nl", title: "Test" }],
-    });
-    expect(item.location).toBeInstanceOf(Location);
-    expect(item.contactinfo).toBeInstanceOf(Contactinfo);
-    expect(item.performers).toHaveLength(1);
-    expect(item.files).toHaveLength(1);
-    expect(item.trcItemDetails).toHaveLength(1);
-  });
-});
-
-describe("Location", () => {
-  test("should create with default values", () => {
-    const loc = new Location();
-    expect(loc.label).toBe("");
-    expect(loc.address).toBeNull();
-    expect(loc.locationItem).toBeNull();
-    expect(loc.venueItem).toBeNull();
-  });
-
-  test("should create with locationItem and venueItem", () => {
-    const loc = new Location({
-      label: "Test",
-      locationItem: { id: "1", trcid: "loc1", text: "Location" },
-      venueItem: { id: "2", trcid: "venue1", text: "Venue" },
-    });
-    expect(loc.locationItem.id).toBe("1");
-    expect(loc.locationItem.trcid).toBe("loc1");
-    expect(loc.venueItem.id).toBe("2");
-    expect(loc.venueItem.trcid).toBe("venue1");
-  });
-
-  test("should create address", () => {
-    const loc = new Location({
-      address: { city: "Amsterdam", street: "Damrak" },
-    });
-    expect(loc.address).toBeInstanceOf(Address);
-    expect(loc.address.city).toBe("Amsterdam");
-  });
-});
-
-describe("Calendar", () => {
-  test("should create with default values", () => {
-    const cal = new Calendar();
-    expect(cal.singleDates).toEqual([]);
-    expect(cal.patternDates).toEqual([]);
-    expect(cal.excludeholidays).toBe(false);
-    expect(cal.cancelled).toBe(false);
-    expect(cal.soldout).toBe(false);
-    expect(cal.onrequest).toBe(false);
-    expect(cal.alwaysopen).toBe(false);
-    expect(cal.comment).toBeNull();
-    expect(cal.calendarType).toBeNull();
-  });
-
-  test("should have CalendarType enum", () => {
-    expect(Calendar.CalendarType.NONE).toBe("NONE");
-    expect(Calendar.CalendarType.ALWAYSOPEN).toBe("ALWAYSOPEN");
-    expect(Calendar.CalendarType.ONREQUEST).toBe("ONREQUEST");
-    expect(Calendar.CalendarType.OPENINGTIMES).toBe("OPENINGTIMES");
-    expect(Calendar.CalendarType.PATTERNDATES).toBe("PATTERNDATES");
-    expect(Calendar.CalendarType.SINGLEDATES).toBe("SINGLEDATES");
-  });
-
-  test("should determine ALWAYSOPEN calendar type", () => {
-    const cal = new Calendar();
-    cal.alwaysopen = true;
-    cal.determineCalendarType();
-    expect(cal.calendarType).toBe("ALWAYSOPEN");
-  });
-
-  test("should determine ONREQUEST calendar type", () => {
-    const cal = new Calendar();
-    cal.onrequest = true;
-    cal.determineCalendarType();
-    expect(cal.calendarType).toBe("ONREQUEST");
-  });
-});
-
-describe("Contactinfo", () => {
-  test("should create with default values", () => {
-    const contact = new Contactinfo();
-    expect(contact.label).toBe("");
-    expect(contact.mails).toEqual([]);
-    expect(contact.phones).toEqual([]);
-    expect(contact.urls).toEqual([]);
-  });
-
-  test("should create nested Mail objects", () => {
-    const contact = new Contactinfo({
-      mails: [{ email: "test@example.com" }],
-    });
-    expect(contact.mails).toHaveLength(1);
-    expect(contact.mails[0].email).toBe("test@example.com");
-  });
-
-  test("should create nested Url objects", () => {
-    const contact = new Contactinfo({
-      urls: [{ url: "https://example.com", urlServiceType: "general" }],
-    });
-    expect(contact.urls).toHaveLength(1);
-    expect(contact.urls[0].url).toBe("https://example.com");
-  });
-
-  test("should have all URLServiceType values", () => {
-    const types = Contactinfo.Url.URLServiceType;
-    expect(types.general).toBe("general");
-    expect(types.booking).toBe("booking");
-    expect(types.review).toBe("review");
-    expect(types.video).toBe("video");
-    expect(types.webshop).toBe("webshop");
-    expect(types.socialmedia).toBe("socialmedia");
-    expect(types.lastminute).toBe("lastminute");
-    expect(types.virtualtour).toBe("virtualtour");
-    expect(types.dmo).toBe("dmo");
-    expect(types.sustainability).toBe("sustainability");
-    expect(types.venuefinder).toBe("venuefinder");
-    expect(types.travelbase).toBe("travelbase");
-  });
-});
-
-describe("File", () => {
-  test("should create with default values", () => {
-    const file = new File();
-    expect(file.trcid).toBe("");
-    expect(file.main).toBe(false);
-    expect(file.filename).toBe("");
-  });
-
-  test("should have FileType enum", () => {
-    expect(File.FileType.jpeg).toBe("jpeg");
-    expect(File.FileType.youtube).toBe("youtube");
-    expect(File.FileType.vimeo).toBe("vimeo");
-  });
-
-  test("should have MediaType enum", () => {
-    expect(File.MediaType.photo).toBe("photo");
-    expect(File.MediaType.video).toBe("video");
-    expect(File.MediaType.poster).toBe("poster");
-  });
-
-  test("should normalize YouTube URL", () => {
-    const shortUrl = "https://youtu.be/dQw4w9WgXcQ";
-    const normalized = File.normalizeYouTubeURL(shortUrl);
-    expect(normalized).toBe("https://www.youtube.com/watch?v=dQw4w9WgXcQ");
-  });
-
-  test("should extract YouTube video ID", () => {
-    const url = "https://www.youtube.com/watch?v=dQw4w9WgXcQ";
-    const videoId = File.youtubeVideoID(url);
-    expect(videoId).toBe("dQw4w9WgXcQ");
-  });
-});
-
-describe("PriceElement", () => {
-  test("should create with default values", () => {
-    const price = new PriceElement();
-    expect(price.freeentrance).toBe(false);
-    expect(price.priceValue).toBeNull();
-    expect(price.comments).toEqual([]);
-  });
-
-  test("should create with price value", () => {
-    const price = new PriceElement({
-      freeentrance: false,
-      priceValue: { from: 10.0, until: 25.0 },
-    });
-    expect(price.priceValue.from).toBe(10.0);
-    expect(price.priceValue.until).toBe(25.0);
-  });
-
-  test("should have PriceDescriptionValue enum", () => {
-    const values = PriceElement.Description.PriceDescriptionValue;
-    expect(values.Adults).toBe("Adults");
-    expect(values.Children).toBe("Children");
-    expect(values.Groups).toBe("Groups");
-    expect(values.CJP).toBe("CJP");
-  });
-});
-
-describe("FetchedEntry", () => {
-  test("should create with default values", () => {
-    const entry = new FetchedEntry();
-    expect(entry.feed).toBe("");
-    expect(entry.sourceId).toBe("");
-    expect(entry.externalId).toBe("");
-  });
-
-  test("should create with custom values", () => {
-    const entry = new FetchedEntry({
-      feed: "test-feed",
-      sourceId: "source-123",
-      externalId: "ext-456",
-      data: { key: "value" },
-    });
-    expect(entry.feed).toBe("test-feed");
-    expect(entry.sourceId).toBe("source-123");
-    expect(entry.data.key).toBe("value");
-  });
-});
-
-describe("ConvertedEntry", () => {
-  test("should create with default values", () => {
-    const entry = new ConvertedEntry();
-    expect(entry.label).toBe("");
-    expect(entry.externalId).toBe("");
-    expect(entry.trcItem).toBeNull();
-  });
-
-  test("should accept TRCItem instance", () => {
-    const trcItem = new TRCItem({ trcid: "test" });
-    const entry = new ConvertedEntry({
-      label: "Test Entry",
-      trcItem: trcItem,
-    });
-    expect(entry.trcItem).toBe(trcItem);
-  });
-});
-
-describe("Address", () => {
-  test("should create with default values", () => {
-    const address = new Address();
-    expect(address.city).toBe("");
-    expect(address.country).toBe("NL");
-    expect(address.main).toBe(false);
-  });
-
-  test("should normalize zipcode", () => {
-    const address = new Address({ zipcode: "1234ab" });
-    address.normaliseAdresItems();
-    expect(address.zipcode).toBe("1234 AB");
-  });
-
-  test("should check isEmpty", () => {
-    const emptyAddress = new Address();
-    const filledAddress = new Address({ city: "Amsterdam" });
-    expect(emptyAddress.isEmpty()).toBe(true);
-    expect(filledAddress.isEmpty()).toBe(false);
-  });
-});
-
-describe("Categories", () => {
-  test("should have category mappings", () => {
-    expect(Categories.categories).toBeDefined();
-    expect(Categories.categories["Beurs"]).toBe("2.3.1");
-    expect(Categories.categories["Film"]).toBe("2.5.2");
-  });
-});
-
-describe("CategoryMap", () => {
-  test("should have categoryMap", () => {
-    expect(CategoryMap.CategoryMap.categoryMap).toBeDefined();
-    expect(CategoryMap.CategoryMap.categoryMap["concert"].catId).toBe("2.6.5");
-  });
-
-  test("should have categoryType", () => {
-    expect(CategoryMap.CategoryMap.categoryType).toBeDefined();
-    expect(CategoryMap.CategoryMap.categoryType["Cabaret"]).toBe("2.9.1");
-  });
-});

package/src/model/ConvertedEntry.js

@@ -1,22 +0,0 @@
-const TRCItem = require('./ndtrc/TRCItem'); // Zorg ervoor dat je het juiste pad gebruikt naar de TRCItem-module
-
-class ConvertedEntry {
-    constructor({
-        label = '',
-        created = null, // Verwacht een Date-object
-        modified = null, // Verwacht een Date-object
-        errorMessage = '',
-        externalId = '',
-        trcItem = null, // Verwacht een instantie van TRCItem
-    } = {}) {
-        this.label = label;
-        this.created = created;
-        this.modified = modified;
-        this.errorMessage = errorMessage;
-
-        this.externalId = externalId;
-        this.trcItem = trcItem instanceof TRCItem ? trcItem : null; // Validatie dat het een TRCItem is
-    }
-}
-
-module.exports = ConvertedEntry;

package/src/model/FetchedEntry.js

@@ -1,55 +0,0 @@
-
-class FetchedEntry {
-    constructor({
-        feed = '',
-        sourceId = '',
-        sourceUrl = '',
-        errorMessage = '',
-        label = '',
-        created = null, // Verwacht een Date-object
-        modified = null, // Verwacht een Date-object
-        externalId = '',
-        data = {}, // Verwacht een object met willekeurige sleutel-waarde paren
-        externalLocationInfo = null, // Verwacht een instantie van ExternalLocationInfo
-    } = {}) {
-        this.feed = feed;
-        this.sourceId = sourceId;
-        this.sourceUrl = sourceUrl;
-        this.errorMessage = errorMessage;
-
-        this.label = label;
-        this.created = created;
-        this.modified = modified;
-
-        this.externalId = externalId;
-        this.data = data;
-        this.externalLocationInfo = externalLocationInfo;
-    }
-}
-
-class ExternalLocationInfo {
-    constructor({
-        externalId = '',
-        locationName = '',
-        address = '',
-        housenr = '',
-        zipcode = '',
-        city = '',
-        latitude = '',
-        longitude = '',
-        trcid = '',
-        ffId = '',
-    } = {}) {
-        this.externalId = externalId;
-        this.locationName = locationName;
-        this.address = address;
-        this.housenr = housenr;
-        this.zipcode = zipcode;
-        this.city = city;
-        this.latitude = latitude;
-        this.longitude = longitude;
-        this.trcid = trcid;
-        this.ffId = ffId;
-    }
-}
-module.exports = { FetchedEntry, ExternalLocationInfo };

package/src/model/ff/Acl.js

@@ -1,13 +0,0 @@
-class Acl {
-    constructor({
-        readers = [],
-        editors = [],
-        managers = []
-    } = {}) {
-        this.readers = readers;
-        this.editors = editors;
-        this.managers = managers;
-    }
-}
-
-module.exports = Acl;

package/src/model/ff/ItemLink.js

@@ -1,25 +0,0 @@
-class ItemLink {
-    constructor({
-        type = null,
-        id = ''
-    } = {}) {
-        this.type = type;
-        this.id = id;
-    }
-
-    static Type = {
-        ALIAS: 'alias',
-        COMMENT: 'comment',
-        PARENT: 'parent',
-        CHILD: 'child',
-
-        fromString(type) {
-            if (Object.values(ItemLink.Type).includes(type)) {
-                return type;
-            }
-            throw new Error(`Invalid ItemLink Type: ${type}`);
-        }
-    };
-}
-
-module.exports = ItemLink;