@api-client/core 0.18.5 → 0.18.7

package/data/models/example-generator-api.json

@@ -42062,22 +42062,22 @@
 "@id": "#209"
 },
 {
-"@id": "#191"
+"@id": "#203"
 },
 {
-"@id": "#194"
+"@id": "#191"
 },
 {
-"@id": "#197"
+"@id": "#194"
 },
 {
-"@id": "#200"
+"@id": "#206"
 },
 {
-"@id": "#203"
+"@id": "#197"
 },
 {
-"@id": "#206"
+"@id": "#200"
 },
 {
 "@id": "#209"
@@ -42810,13 +42810,13 @@
 "@id": "#219"
 },
 {
-"@id": "#210"
+"@id": "#216"
 },
 {
-"@id": "#213"
+"@id": "#210"
 },
 {
-"@id": "#216"
+"@id": "#213"
 },
 {
 "@id": "#219"
@@ -43436,7 +43436,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "countryCode: \"BE\"\ngraydonEnterpriseId: 1057155523\nregistrationId: \"0422319093\"\nvatNumber: \"BE0422319093\"\ngraydonCompanyId: \"0422319093\"\nisBranchOffice: false\n",
+"doc:raw": "addressType: 'REGISTERED-OFFICE-ADDRESS'\nstreetName: 'UITBREIDINGSTRAAT'\nhouseNumber: '84'\nhouseNumberAddition: '/1'\npostalCode: '2600'\ncity: 'BERCHEM (ANTWERPEN)'\ncountry: 'Belgium'\ncountryCode: 'BE'\nfullFormatedAddress: \"UITBREIDINGSTRAAT 84 /1, 2600 BERCHEM (ANTWERPEN), BELIUM\"\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43457,7 +43457,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "addressType: 'REGISTERED-OFFICE-ADDRESS'\nstreetName: 'UITBREIDINGSTRAAT'\nhouseNumber: '84'\nhouseNumberAddition: '/1'\npostalCode: '2600'\ncity: 'BERCHEM (ANTWERPEN)'\ncountry: 'Belgium'\ncountryCode: 'BE'\nfullFormatedAddress: \"UITBREIDINGSTRAAT 84 /1, 2600 BERCHEM (ANTWERPEN), BELIUM\"\n",
+"doc:raw": "code: '5'\ndescription: 'Limited company'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43478,7 +43478,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "code: '5'\ndescription: 'Limited company'\n",
+"doc:raw": "code: 'J'\ndescription: 'Information and communication'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43499,7 +43499,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "class: '3'\ndescription: '150 - 300'\nnumberOfFte: 5500\nnumberOfEmployees: 5232\n",
+"doc:raw": "code: '7487'\ndescription: 'Financial and insurance activities'\ntype: \"PRIMARY\"\nclassificationCode: 'BE_NACEBEL2008'\nactivityGroupCode: 'ABCDE'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43520,7 +43520,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "code: 'J'\ndescription: 'Information and communication'\n",
+"doc:raw": "countryCode: \"BE\"\ngraydonEnterpriseId: 1057155523\nregistrationId: \"0422319093\"\nvatNumber: \"BE0422319093\"\ngraydonCompanyId: \"0422319093\"\nisBranchOffice: false\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -43541,7 +43541,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "code: '7487'\ndescription: 'Financial and insurance activities'\ntype: \"PRIMARY\"\nclassificationCode: 'BE_NACEBEL2008'\nactivityGroupCode: 'ABCDE'\n",
+"doc:raw": "class: '3'\ndescription: '150 - 300'\nnumberOfFte: 5500\nnumberOfEmployees: 5232\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -44232,7 +44232,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "type: 'GENERAL'\ncountryDialCode : '+32'\nareaCode : '22'\nsubscriberNumber: '12.87.00'\nformatted: '+32-(0)22 000000'\n",
+"doc:raw": "type: 'GENERAL'\ncountryDialCode : '+32'\nareaCode : '21'\nsubscriberNumber: '12.87.00'\nformatted: '+32-(0)21 302099'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -44253,7 +44253,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "type: 'GENERAL'\ncountryDialCode : '+32'\nareaCode : '21'\nsubscriberNumber: '12.87.00'\nformatted: '+32-(0)21 302099'\n",
+"doc:raw": "-\n  type: 'GENERAL'\n  value: 'info@company.be'\n-\n  type: 'IT_DEPT'\n  value: 'it-service@company.be'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -44274,7 +44274,7 @@
 "doc:ExternalDomainElement",
 "doc:DomainElement"
 ],
-"doc:raw": "-\n  type: 'GENERAL'\n  value: 'info@company.be'\n-\n  type: 'IT_DEPT'\n  value: 'it-service@company.be'\n",
+"doc:raw": "type: 'GENERAL'\ncountryDialCode : '+32'\nareaCode : '22'\nsubscriberNumber: '12.87.00'\nformatted: '+32-(0)22 000000'\n",
 "core:mediaType": "application/yaml",
 "sourcemaps:sources": [
 {
@@ -44756,12 +44756,12 @@
 {
 "@id": "#193/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#193",
-"sourcemaps:value": "[(1,0)-(7,0)]"
+"sourcemaps:value": "[(1,0)-(10,0)]"
 },
 {
 "@id": "#196/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#196",
-"sourcemaps:value": "[(1,0)-(10,0)]"
+"sourcemaps:value": "[(1,0)-(3,0)]"
 },
 {
 "@id": "#199/source-map/lexical/element_0",
@@ -44771,17 +44771,17 @@
 {
 "@id": "#202/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#202",
-"sourcemaps:value": "[(1,0)-(5,0)]"
+"sourcemaps:value": "[(1,0)-(6,0)]"
 },
 {
 "@id": "#205/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#205",
-"sourcemaps:value": "[(1,0)-(3,0)]"
+"sourcemaps:value": "[(1,0)-(7,0)]"
 },
 {
 "@id": "#208/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#208",
-"sourcemaps:value": "[(1,0)-(6,0)]"
+"sourcemaps:value": "[(1,0)-(5,0)]"
 },
 {
 "@id": "#223/source-map/lexical/element_0",
@@ -45121,12 +45121,12 @@
 {
 "@id": "#215/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#215",
-"sourcemaps:value": "[(1,0)-(6,0)]"
+"sourcemaps:value": "[(1,0)-(7,0)]"
 },
 {
 "@id": "#218/source-map/lexical/element_0",
 "sourcemaps:element": "amf://id#218",
-"sourcemaps:value": "[(1,0)-(7,0)]"
+"sourcemaps:value": "[(1,0)-(6,0)]"
 },
 {
 "@id": "#221/source-map/lexical/element_0",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@api-client/core",
   "description": "The API Client's core client library. Works in NodeJS and in a ES enabled browser.",
-  "version": "0.18.5",
+  "version": "0.18.7",
   "license": "Apache-2.0",
   "exports": {
     "./browser.js": {
@@ -94,7 +94,8 @@
     "amf-json-ld-lib": "^0.0.15",
     "chalk": "^5.4.1",
     "console-table-printer": "^2.11.2",
-    "isomorphic-dompurify": "^2.26.0",
+    "dompurify": "^3.2.6",
+    "jsdom": "^26.1.0",
     "nanoid": "^5.1.5",
     "ws": "^8.12.0",
     "xpath": "^0.0.34"
@@ -154,6 +155,7 @@
     "prepare": "husky && npm run fixes && npm run build:ts && npm run build:api-models",
     "fixes": "node scripts/fix-rollup-plugin.js",
     "tsc": "wireit",
+    "tsc:tests": "wireit",
     "tsc:watch": "wireit",
     "test:browser": "node --import ts-node-maintained/register/esm --enable-source-maps bin/test-web.ts --playwright --browsers chromium",
     "test:browser:watch": "node --import ts-node-maintained/register/esm --enable-source-maps bin/test-web.ts --watch --playwright --browsers chromium",

package/src/lib/dom_purify.ts

@@ -0,0 +1,25 @@
+import DOMPurify from 'dompurify'
+
+let instance: typeof DOMPurify
+
+function isNodeJsEnvironment(): boolean {
+  return (
+    // eslint-disable-next-line no-restricted-globals
+    typeof process !== 'undefined' &&
+    // eslint-disable-next-line no-restricted-globals
+    typeof process.versions !== 'undefined' &&
+    // eslint-disable-next-line no-restricted-globals
+    typeof process.versions.node !== 'undefined'
+  )
+}
+if (isNodeJsEnvironment()) {
+  const { JSDOM } = await import('jsdom')
+  const { window } = new JSDOM('<!DOCTYPE html>')
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+  // @ts-ignore
+  instance = DOMPurify(window)
+} else {
+  instance = DOMPurify
+}
+
+export default instance

package/src/modeling/helpers/database.ts

@@ -1,8 +1,8 @@
-import DOMPurify from 'isomorphic-dompurify'
 import { snakeCase } from '@pawel-up/jexl/string.js'
+import DOMPurify from '../../lib/dom_purify.js'
 
 export function sanitizeInput(input: string): string {
-  return DOMPurify.isSupported ? DOMPurify.sanitize(input) : input
+  return DOMPurify.sanitize(input)
 }
 
 /**

package/src/modeling/importers/CsvImporter.ts

@@ -1,11 +1,43 @@
-import { type CSVOptions, CSVParser, type ParseResult } from '@pawel-up/csv'
+import { type CSVOptions, CSVParser, type ParseResult as ParseResult_ } from '@pawel-up/csv'
 import type { DataDomain } from '../DataDomain.js'
 import { sanitizeInput, toDatabaseColumnName, toDatabaseTableName } from '../helpers/database.js'
 import type { DomainPropertySchema } from '../DomainProperty.js'
 import type { DomainEntity } from '../DomainEntity.js'
 import type { DomainModel } from '../DomainModel.js'
 
-export type { CSVOptions, ParseResult }
+interface ParseResult extends ParseResult_ {
+  /**
+   * The file name of the CSV that was parsed.
+   * If the CSV is provided as a string, it will be named `inline_csv_0`, `inline_csv_1`, etc.
+   */
+  file: string
+}
+
+let increment = 0
+
+interface ImportResult {
+  /**
+   * The DomainEntity created from the CSV data.
+   */
+  entity: DomainEntity
+  /**
+   * The DomainModel that contains the imported entity.
+   */
+  model: DomainModel
+}
+
+interface ImportManyResult {
+  /**
+   * An array of DomainEntity instances created from the CSV data.
+   */
+  entities: DomainEntity[]
+  /**
+   * The DomainModel that contains all imported entities.
+   */
+  model: DomainModel
+}
+
+export type { CSVOptions, ParseResult, ImportResult, ImportManyResult }
 
 /**
  * Imports CSV data into a DataDomain.
@@ -33,8 +65,19 @@ export class CsvImporter {
    * @param csv The CSV content to parse, as a File object or a string.
    * @returns A promise that resolves with the parsed result.
    */
-  public parse(csv: File | string): Promise<ParseResult> {
-    return this.parser.parse(csv)
+  public async parse(csv: File | string): Promise<ParseResult> {
+    const result = await this.parser.parse(csv)
+    return {
+      ...result,
+      file: typeof csv === 'string' ? 'inline_csv_' + increment++ : csv.name,
+    }
+  }
+
+  private removeExtension(name: string): string {
+    if (name.endsWith('.csv')) {
+      name = name.slice(0, -4) // Remove .csv extension if present
+    }
+    return name
   }
 
   /**
@@ -45,7 +88,8 @@ export class CsvImporter {
    * @param modelName The name to be used for the created `DomainModel` and `DomainEntity`.
    * @returns A promise that resolves when the import is complete.
    */
-  public async import(data: ParseResult, modelName: string): Promise<{ entity: DomainEntity; model: DomainModel }> {
+  public async import(data: ParseResult, modelName: string): Promise<ImportResult> {
+    modelName = this.removeExtension(modelName)
     const name = toDatabaseTableName(modelName, 'imported_cvs_data')
     const model = this.domain.addModel({ info: { name } })
     const entity = model.addEntity({ info: { name } })
@@ -88,4 +132,70 @@ export class CsvImporter {
     }
     return { entity, model }
   }
+
+  /**
+   * Imports multiple parsed CSV data structures into the same data model.
+   * Creates a single `DomainModel` with multiple `DomainEntity` instances, one for each CSV data structure.
+   * Each entity represents the structure of its corresponding CSV file.
+   * @param data Array of objects containing parsed CSV data and entity names.
+   * @param modelName The name to be used for the created `DomainModel`.
+   * @returns A promise that resolves with the created model and all entities.
+   */
+  public async importMany(data: ParseResult[], modelName: string): Promise<ImportManyResult> {
+    modelName = this.removeExtension(modelName)
+    const name = toDatabaseTableName(modelName, 'imported_cvs_data')
+    const model = this.domain.addModel({ info: { name } })
+    const sanitizedModelName = sanitizeInput(modelName)
+    if (name !== sanitizedModelName) {
+      model.info.displayName = sanitizedModelName
+    }
+
+    const entities: DomainEntity[] = []
+
+    for (const { format, values, file } of data) {
+      const cleanFile = this.removeExtension(file)
+      const entityDbName = toDatabaseTableName(cleanFile, `entity_${entities.length}`)
+      const entity = model.addEntity({ info: { name: entityDbName } })
+      const sanitizedEntityName = sanitizeInput(cleanFile)
+      if (entityDbName !== sanitizedEntityName) {
+        entity.info.displayName = sanitizedEntityName
+      }
+
+      const exampleRow = values[0]
+      for (const row of format) {
+        const { index, name, type, format } = row
+        const columnName = toDatabaseColumnName(name, `column_${index}`)
+        const schema: Partial<DomainPropertySchema> = {
+          info: { name: columnName },
+          type,
+        }
+        if (format) {
+          schema.bindings = [
+            {
+              type: 'web',
+              schema: {
+                format: format === 'integer' ? 'int64' : 'double',
+              },
+            },
+          ]
+        }
+        if (Array.isArray(exampleRow) && exampleRow[index]) {
+          const value = exampleRow[index]
+          if (value !== undefined && value !== null) {
+            schema.schema = {
+              examples: [sanitizeInput(String(value))],
+            }
+          }
+        }
+        const prop = entity.addProperty(schema)
+        const sn = sanitizeInput(name)
+        if (sn !== columnName) {
+          prop.info.displayName = sn
+        }
+      }
+      entities.push(entity)
+    }
+
+    return { entities, model }
+  }
 }

package/tests/unit/lib/dom_purify.spec.ts

@@ -0,0 +1,12 @@
+import { test } from '@japa/runner'
+import DOMPurify from '../../../src/lib/dom_purify.js'
+
+test('DOMPurify is initialized correctly', ({ assert }) => {
+  assert.isFunction(DOMPurify.sanitize, 'DOMPurify should have a sanitize function')
+})
+
+test('DOMPurify sanitizes input correctly', ({ assert }) => {
+  const unsafeInput = '<script>alert("XSS")</script>'
+  const safeOutput = DOMPurify.sanitize(unsafeInput)
+  assert.equal(safeOutput, '', 'Sanitized output should be empty for unsafe input')
+})