fix(typescript): Keep the extension prefix in @type, and test generated TypeScript in models-ts

.github/workflows/generate-models.yaml

@@ -17,12 +17,12 @@ jobs:
 
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
       with:
         path: models-lib
 
     - name: Use Node.js 18.17.1
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v4
       with:
         node-version: 18.17.1
 
@@ -37,3 +37,11 @@ jobs:
       run: npm start -- generate ${{ matrix.language }} --destination ../output/
       working-directory: models-lib
 
+  # Generate the TypeScript models from this ref inside models-ts, then build and test them there,
+  # so that changes which produce invalid TypeScript are caught before they reach models-ts
+  test-ts:
+    needs: generate
+    uses: openactive/models-ts/.github/workflows/create-data-model-pr.yaml@main
+    with:
+      models-lib_ref: ${{ github.ref }}
+

src/generators/typescript/index.js

@@ -58,6 +58,32 @@ class TypeScript extends Generator {
     return true;
   }
 
+  /**
+   * The value of `@type` that identifies this model in JSON-LD data.
+   *
+   * OpenActive and schema.org types are written without a prefix, because the OpenActive context defines terms for
+   * OpenActive types and uses schema.org as its `@vocab`. Types from extensions (e.g. `beta:Bar` or
+   * `test:OpenBookingSimulateAction`) are only reachable through their extension's prefix, so the prefix is kept.
+   *
+   * @param {Model} model
+   */
+  getJsonLdTypeName(model) {
+    const prefix = this.getPrefix(model.type);
+    if (prefix && prefix !== 'schema') {
+      return model.type;
+    }
+    return this.getPropNameFromFQP(model.type);
+  }
+
+  createModelData(model, extensions) {
+    const data = super.createModelData(model, extensions);
+    return {
+      ...data,
+      /** e.g. Place, Thing, beta:Bar */
+      jsonLdTypeName: this.getJsonLdTypeName(model),
+    };
+  }
+
   async renderModel(data) {
     this.modelTemplate =
       this.modelTemplate ||

src/generators/typescript/model.ts.mustache

@@ -12,7 +12,7 @@ import * as schema from '../schema';
 {{/classDoc}}
  */
 export type {{{ className }}} = {
-  '@type': '{{{ modelTypePropName }}}';
+  '@type': '{{{ jsonLdTypeName }}}';
   '@context'?: string | string[];
 {{#fieldList}}
   {{#if description }}
@@ -58,7 +58,7 @@ export type {{{ className }}}OrSubClass =
 {{/classDoc}}
  */
 export const {{{ className }}}JoiSchema = Joi.object({
-  '@type': Joi.string().valid('{{{ modelTypePropName }}}').required(),
+  '@type': Joi.string().valid('{{{ jsonLdTypeName }}}').required(),
   '@context': Joi.alternatives().try([Joi.string(), Joi.array().items(Joi.string())]),
 {{#fieldList}}
   {{{ renderMemberName }}}: {{{ propertyJoiType }}},