@digicatapult/dtdl-parser 0.0.14 → 0.0.15

package/build/interop/_framework/blazor.boot.json

@@ -1,7 +1,7 @@
 {
   "mainAssemblyName": "DTDLParserJSInterop.dll",
   "resources": {
-    "hash": "sha256-QX5JG5/DtNnflHHj0ApuxEODJm2ljBbWqU8++LXEupQ=",
+    "hash": "sha256-gz7SFK75PKjPCvG+55ZwMLiIGkxrTqRy/2Wjzk68AFU=",
     "jsModuleNative": {
       "dotnet.native.js": "sha256-79LdZogK41buIci0KtOWmQvQc2swMI3jvDQCoN23NBM="
     },
@@ -181,10 +181,10 @@
       "mscorlib.wasm": "sha256-KvqZaNpjwhrOuzE4b4aMFsI+VUTyiWfoDI4zn4l9BM8=",
       "netstandard.wasm": "sha256-v+s7sWxtOM6bnOvC0jFrtnm6uMfbDymwl2nHNgbS2LM=",
       "System.Private.CoreLib.wasm": "sha256-pklll63uFQoY6vaD3vbluS9osYiJWLLLmob1yHFgepI=",
-      "DTDLParserJSInterop.wasm": "sha256-LIeTpiKwtFb7qU5P0NKMm5a6hQkbwycXeHoKOsEC0uE="
+      "DTDLParserJSInterop.wasm": "sha256-In0ykSqWvOHUMaydHOB4gMR1guIwhvIPHqqA+wJDy2w="
     },
     "pdb": {
-      "DTDLParserJSInterop.pdb": "sha256-st4B4B7o6fJ74mewyGLB7nd5YPDyE58Kqim9h+hnfdw="
+      "DTDLParserJSInterop.pdb": "sha256-GY59ni7t9PtmnPBjm+F+HwpjTCgF9LoFjDMjode/fak="
     },
     "vfs": {
       "runtimeconfig.bin": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digicatapult/dtdl-parser",
-  "version": "0.0.14",
+  "version": "0.0.15",
   "description": "JS tool to parse DTDL defined Ontologies",
   "main": "build/index.js",
   "type": "module",
@@ -8,6 +8,9 @@
     "import": "./build/index.js"
   },
   "types": "./build/index.d.ts",
+  "files": [
+    "build/"
+  ],
   "scripts": {
     "test": "NODE_ENV=test ./node_modules/.bin/mocha --config ./test/mocharc.json ./src/**/*.test.ts",
     "build": "npm run build:ts && npm run interop:build && npm run build:declarations",
@@ -24,10 +27,6 @@
     "type": "git",
     "url": "git+https://github.com/digicatapult/dtdl-parser.git"
   },
-  "files": [
-    "build",
-    ""
-  ],
   "keywords": [
     "dtdl",
     "digital",

package/.depcheckrc

@@ -1,6 +0,0 @@
-ignores: [
-    '@swc-node/register',
-    'prettier-plugin-organize-imports',
-    'rimraf',
-    'typescript'
-]

package/.github/CODEOWNERS

@@ -1,4 +0,0 @@
-# Github CODEOWNERS file
-
-# Global code-owners for this repository
-* @digicatapult/software-engineering

package/.github/workflows/release.yml

@@ -1,198 +0,0 @@
-name: Release
-
-on: 
-    push:
-        branches: ['main', 'init-commit']
-jobs:
-    preconditions:
-        runs-on: ubuntu-latest
-        outputs:
-            repo_name: ${{ steps.repo_ids.outputs.REPO_NAME }}
-            org_name: ${{ steps.repo_ids.outputs.ORG_NAME }}
-        steps:
-        - name: Checkout
-          uses: actions/checkout@v4
-          with:
-            fetch-depth: 0
-        - name: Check Github token
-          run: |
-            if [ -z "${{ secrets.GITHUB_TOKEN }}"]; then
-                echo "Must provide a GITHUB_TOKEN secret in order to run release workflow"
-                exit 1
-            fi
-        - name: Check npmjs token
-          run: |
-            if [ -z "${{ secrets.NPMJS_TOKEN }}"]; then
-                echo "Must provide a NPMJS_TOKEN secret in order to run release workflow"
-                exit 1
-            fi
-        - name: Get repository identifiers
-          id: repo_ids
-          run: |
-            REPO_NAME=$(echo "${{ github.event.repository.name }}" | tr '[:upper:]' '[:lower:]')
-            ORG_NAME=$(echo "${{ github.event.repository.owner.name }}" | tr '[:upper:]' '[:lower:]')
-            echo "REPO_NAME=$REPO_NAME" >> $GITHUB_OUTPUT
-            echo "ORG_NAME=$ORG_NAME" >> $GITHUB_OUTPUT
-    static-checks:
-        name: Run Static Analysis Checks
-        strategy:
-            fail-fast: false
-            matrix:
-                command: [lint, depcheck, check]
-        runs-on: ubuntu-latest
-        steps:
-          - uses: actions/checkout@v4
-          - uses: actions/setup-node@v4
-            with:
-                node-version: 20.x
-          - name: Cache Node.js modules
-            uses: actions/cache@v4
-            with:
-                path: ~/.npm # npm cache files are stored in `~/.npm` on Linux/macOS
-                key: ${{ runner.OS }}-node-${{ hashFiles('**/package-lock.json') }}
-                restore-keys: |
-                    ${{ runner.OS }}-node-
-                    ${{ runner.OS }}-
-          - name: Install Packages
-            run: npm ci
-          - name: Checks
-            run: npm run ${{ matrix.command }}
-    tests:
-        name: Run tests
-        strategy:
-            fail-fast: false
-            matrix:
-                command: ['test']
-        runs-on: ubuntu-latest
-        steps:
-          - uses: actions/checkout@v4
-          - uses: actions/setup-dotnet@v4
-            with:
-                dotnet-version: '8.0.x'
-          - uses: actions/setup-node@v4
-            with:
-                node-version: 20.x
-          - name: Cache Node.js modules
-            uses: actions/cache@v4
-            with:
-                path: ~/.npm # npm cache files are stored in `~/.npm` on Linux/macOS
-                key: ${{ runner.OS }}-node-${{ hashFiles('**/package-lock.json') }}
-                restore-keys: |
-                    ${{ runner.OS }}-node-
-                    ${{ runner.OS }}-
-          - name: Install wasm tools
-            run: dotnet workload install wasm-tools
-          - name: Install Packages
-            run: npm ci
-          - name: Build
-            run: npm run build
-          - name: Run tests
-            run: npm run ${{ matrix.command }}
-    check-version:
-        name: 'Check version'
-        runs-on: ubuntu-latest
-        outputs:
-            is_new_version: ${{ steps.get_version.outputs.IS_NEW_VERSION }}
-            version: ${{ steps.get_version.outputs.VERSION }}
-            build_date: ${{ steps.get_version.outputs.BUILD_DATE }}
-            is_prerelease: ${{ steps.get_version.outputs.IS_PRERELEASE }}
-
-        steps:
-          - uses: actions/checkout@v4
-          - name: Check version
-            id: get_version
-            uses: digicatapult/check-version@v1
-            with:
-                token: ${{ secrets.GITHUB_TOKEN }}
-    publish-gh:
-        name: 'Publish Github package'
-        needs:
-        - preconditions
-        - static-checks
-        - tests
-        - check-version
-        runs-on: ubuntu-latest
-        if: ${{ needs.check-version.outputs.is_new_version == 'true' }}
-
-        steps:
-          - uses: actions/checkout@v4
-          - uses: actions/setup-node@v4
-            with:
-                node-version: '16.x'
-                registry-url: 'https://npm.pkg.github.com'
-                scope: '@digicatapult'
-          - name: Install packages
-            run: npm ci
-          - name: Publish to github packages
-            run: npm publish --access public
-            env:
-                NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-    publish-npm:
-        name: 'Publish package to NPMJS'
-        needs:
-        - preconditions
-        - static-checks
-        - tests
-        - check-version
-        runs-on: ubuntu-latest
-        if: ${{ needs.check-version.outputs.is_new_version == 'true' }}
-
-        steps:
-          - uses: actions/checkout@v4
-          - uses: actions/setup-node@v4
-            with:
-                node-version: '18.x'
-                registry-url: 'https://registry.npmjs.org'
-                scope: '@digicatapult'
-          - uses: actions/setup-dotnet@v4
-            with:
-                dotnet-version: '8.0.x'
-          - name: Install wasm tools
-            run: dotnet workload install wasm-tools
-          - name: Install packages
-            run: npm ci
-          - name: Build
-            run: npm run build
-          - name: Publish to npmjs packages
-            run: npm publish --access public
-            env:
-                NODE_AUTH_TOKEN: ${{ secrets.NPMJS_TOKEN }}
-
-    publish:
-        name: 'Publish release'
-        needs: [preconditions, static-checks, tests, check-version]
-        runs-on: ubuntu-latest
-        if: ${{ needs.check-version.outputs.is_new_version == 'true' }}
-
-        steps:
-          - uses: actions/checkout@v4
-
-          - name: Build release version
-            uses: softprops/action-gh-release@v2
-            with:
-                token: '${{ secrets.GITHUB_TOKEN }}'
-                tag_name: ${{ needs.check-version.outputs.version }}
-                prerelease: false
-                name: ${{ needs.check-version.outputs.version }}
-                generate_release_notes: true
-          - name: Delete release latest
-            uses: actions/github-script@v7
-            with:
-                github-token: ${{secrets.GITHUB_TOKEN}}
-                script: |
-                    const { owner, repo } = context.repo
-                    try {
-                    await github.rest.git.deleteRef({ owner, repo, ref: 'tags/latest' })
-                    }
-                    catch (err) {
-                    if (err.status !== 422) throw err
-                    }
-          - name: Build release latest
-            uses: softprops/action-gh-release@v2
-            with:
-                token: '${{ secrets.GITHUB_TOKEN }}'
-                tag_name: latest
-                prerelease: false
-                name: Latest ${{ needs.check-version.outputs.version }}
-                generate_release_notes: true

package/.github/workflows/test.yml

@@ -1,92 +0,0 @@
-name: Lint and Test
-
-on:
-  push:
-    branches-ignore: ['main']
-
-jobs:
-  repo_ids:
-    runs-on: ubuntu-latest
-    outputs:
-      repo_name: ${{ steps.repo_ids.outputs.REPO_NAME }}
-      org_name: ${{ steps.repo_ids.outputs.ORG_NAME }}
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-      - name: Get repository identifiers
-        id: repo_ids
-        run: |
-          REPO_NAME=$(echo "${{ github.event.repository.name }}" | tr '[:upper:]' '[:lower:]')
-          ORG_NAME=$(echo "${{ github.event.repository.owner.name }}" | tr '[:upper:]' '[:lower:]')
-          echo "REPO_NAME=$REPO_NAME" >> $GITHUB_OUTPUT
-          echo "ORG_NAME=$ORG_NAME" >> $GITHUB_OUTPUT
-
-  static-checks:
-    name: Run Static Analysis Checks
-    strategy:
-      fail-fast: false
-      matrix:
-        command: [lint, depcheck, check]
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 20.x
-      - name: Cache Node.js modules
-        uses: actions/cache@v4
-        with:
-          path: ~/.npm # npm cache files are stored in `~/.npm` on Linux/macOS
-          key: ${{ runner.OS }}-node-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.OS }}-node-
-            ${{ runner.OS }}-
-      - name: Install Packages
-        run: npm ci
-      - name: Lint
-        run: npm run ${{ matrix.command }}
-
-  tests:
-    name: Run tests
-    strategy:
-      fail-fast: false
-      matrix:
-        command: ['test']
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 20.x
-      - name: Cache Node.js modules
-        uses: actions/cache@v4
-        with:
-          path: ~/.npm # npm cache files are stored in `~/.npm` on Linux/macOS
-          key: ${{ runner.OS }}-node-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.OS }}-node-
-            ${{ runner.OS }}-
-      - uses: actions/setup-dotnet@v4
-        with:
-            dotnet-version: '8.0.x'
-      - name: Install wasm tools
-        run: dotnet workload install wasm-tools
-      - name: Install Packages
-        run: npm ci
-      - name: Build
-        run: npm run build
-      - name: Run tests
-        run: npm run ${{ matrix.command }}
-
-  check-version:
-    name: 'Check version'
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - name: Check version
-        id: get_version
-        uses: digicatapult/check-version@v1
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}

package/.gitignore

@@ -1,4 +0,0 @@
-node_modules/
-bin
-obj
-build/

package/.prettierrc

@@ -1,9 +0,0 @@
-{
-  "singleQuote": true,
-  "semi": false,
-  "trailingComma": "es5",
-  "printWidth": 120,
-  "plugins": [
-    "prettier-plugin-organize-imports"
-  ]
-}

package/.swcrc

@@ -1,32 +0,0 @@
-{
-  "$schema": "https://swc.rs/schema.json",
-  "jsc": {
-    "parser": {
-      "syntax": "typescript",
-      "decorators": true,
-      "topLevelAwait": true,
-      "importMeta": true
-    },
-    "transform": {
-      "legacyDecorator": true,
-      "decoratorMetadata": true,
-      "useDefineForClassFields": true
-    },
-    "minify": {
-      "compress": {
-        "unused": true
-      },
-      "mangle": true
-    },
-    "target": "esnext",
-    "experimental": {
-      "keepImportAttributes": true
-    }
-  },
-  "exclude": [
-    "__tests__",
-    "interop"
-  ],
-  "sourceMaps": true,
-  "isModule": true
-}

package/dtdl/error/error.json

@@ -1,11 +0,0 @@
-{
-  "@type": "Interface",
-  "@id": "dtmi:com:example:Thermostat",
-  "contents": [
-    {
-      "@type": "Telemetry",
-      "name": "temperature",
-      "schema": "double"
-    }
-  ]
-}

package/dtdl/simple/simple.json

@@ -1,9 +0,0 @@
-{
-  "@context": ["dtmi:dtdl:context;3"],
-  "@id": "dtmi:com:example;1",
-  "@type": "Interface",
-  "extends": {
-    "@type": "Interface",
-    "@id": "dtmi:com:example:base;1"
-  }
-}

package/eslint.config.mjs

@@ -1,52 +0,0 @@
-import { FlatCompat } from '@eslint/eslintrc'
-import js from '@eslint/js'
-import typescriptEslint from '@typescript-eslint/eslint-plugin'
-import tsParser from '@typescript-eslint/parser'
-import prettier from 'eslint-plugin-prettier'
-import globals from 'globals'
-import path from 'node:path'
-import { fileURLToPath } from 'node:url'
-
-const __filename = fileURLToPath(import.meta.url)
-const __dirname = path.dirname(__filename)
-const compat = new FlatCompat({
-  baseDirectory: __dirname,
-  recommendedConfig: js.configs.recommended,
-  allConfig: js.configs.all,
-})
-
-export default [
-  ...compat.extends('eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'),
-  {
-    plugins: {
-      prettier,
-      '@typescript-eslint': typescriptEslint,
-    },
-
-    languageOptions: {
-      globals: {
-        ...globals.node,
-      },
-
-      parser: tsParser,
-      ecmaVersion: 12,
-      sourceType: 'module',
-    },
-
-    rules: {
-      'prettier/prettier': 'error',
-      '@typescript-eslint/no-unused-vars': [
-        'warn',
-        {
-          ignoreRestSiblings: true,
-        },
-      ],
-
-      'no-console': 2,
-      'no-duplicate-imports': 'warn',
-    },
-  },
-  {
-    ignores: ['build/', 'node_modules/', 'interop/'],
-  },
-]

package/src/__tests__/fixtures/empty.json

@@ -1 +0,0 @@
-{}

package/src/__tests__/fixtures/nested/nested.json

@@ -1 +0,0 @@
-{}

package/src/__tests__/index.test.ts

@@ -1,119 +0,0 @@
-import { expect } from 'chai'
-import { describe, it } from 'mocha'
-import path from 'path'
-import { parseDirectories, searchForJsonFiles, validateDirectories } from '../index'
-import { Parser } from '../interop'
-
-const fixturesFilepath = path.resolve('src/__tests__/fixtures')
-
-const exampleModel = {
-  'dtmi:com:example:base;1': {
-    languageMajorVersion: 3,
-    Id: 'dtmi:com:example:base;1',
-    ChildOf: 'dtmi:com:example;1',
-    DefinedIn: 'dtmi:com:example;1',
-    EntityKind: 'Interface',
-    ClassId: 'dtmi:dtdl:class:Interface;3',
-    extendedBy: ['dtmi:com:example;1'],
-  },
-  'dtmi:com:example;1': {
-    languageMajorVersion: 3,
-    Id: 'dtmi:com:example;1',
-    EntityKind: 'Interface',
-    ClassId: 'dtmi:dtdl:class:Interface;3',
-    extends: ['dtmi:com:example:base;1'],
-  },
-}
-
-const mockParser: Parser = {
-  parse: () => JSON.stringify(exampleModel),
-  parserVersion: () => '1.0.0',
-}
-
-const mockParserWithParsingException: Parser = {
-  parse: () => {
-    throw new Error(
-      JSON.stringify({
-        ExceptionKind: 'Parsing',
-        Errors: [{ Cause: '', Action: '', ValidationID: '' }],
-      })
-    )
-  },
-  parserVersion: () => '1.0.0',
-}
-
-const mockParserWithResolutionException: Parser = {
-  parse: () => {
-    throw new Error(
-      JSON.stringify({
-        ExceptionKind: 'Resolution',
-      })
-    )
-  },
-  parserVersion: () => '1.0.0',
-}
-
-describe('parse', () => {
-  describe('search for files', () => {
-    it('should return nested json filepaths', async () => {
-      const filepaths = searchForJsonFiles(fixturesFilepath)
-      expect(filepaths.map((fp) => path.basename(fp))).to.deep.equal(['empty.json', 'nested.json'])
-    })
-  })
-
-  describe('valid parse', () => {
-    it('should return model', async () => {
-      const model = parseDirectories(fixturesFilepath, mockParser)
-      expect(model).to.deep.equal(exampleModel)
-    })
-  })
-
-  describe('invalid directory path', () => {
-    it('should return null', async () => {
-      const model = parseDirectories('invalid', mockParser)
-      expect(model).to.equal(null)
-    })
-  })
-
-  describe('parsing exception thrown by interop parser', () => {
-    it('should return null', async () => {
-      const model = parseDirectories(fixturesFilepath, mockParserWithParsingException)
-      expect(model).to.equal(null)
-    })
-  })
-})
-
-describe('parse', () => {
-  describe('valid validate', () => {
-    it('should returned validated true', async () => {
-      const isValid = validateDirectories(fixturesFilepath, mockParser, false)
-      expect(isValid).to.equal(true)
-    })
-  })
-
-  describe('invalid directory path', () => {
-    it('should return null', async () => {
-      const isValid = validateDirectories('invalid', mockParser, false)
-      expect(isValid).to.equal(false)
-    })
-  })
-
-  describe('parsing exception thrown by interop validate', () => {
-    it('should return false', async () => {
-      const isValid = validateDirectories(fixturesFilepath, mockParserWithParsingException, false)
-      expect(isValid).to.equal(false)
-    })
-  })
-
-  describe('resolution exception thrown by interop validate', () => {
-    it('should return false if including resolution check', async () => {
-      const isValid = validateDirectories(fixturesFilepath, mockParserWithResolutionException, true)
-      expect(isValid).to.equal(false)
-    })
-
-    it('should return true if NOT including resolution check', async () => {
-      const isValid = validateDirectories(fixturesFilepath, mockParserWithResolutionException, false)
-      expect(isValid).to.equal(true)
-    })
-  })
-})

package/src/error.ts

@@ -1,25 +0,0 @@
-import type { ModelingException, ParsingException, ResolutionException } from '../types/DtdlErr.d.ts'
-
-const { error } = console
-
-const isParsingEx = (exception: ModelingException): exception is ParsingException => {
-  return exception.ExceptionKind === 'Parsing'
-}
-
-const isResolutionEx = (exception: ModelingException): exception is ResolutionException => {
-  return exception.ExceptionKind === 'Resolution'
-}
-
-export const isResolutionException = (err: unknown) => {
-  if (!(err instanceof Error)) return false
-  return isResolutionEx(JSON.parse(err.message))
-}
-
-export const errorHandler = (err: unknown) => {
-  if (!(err instanceof Error)) return error(`Unexpected error: ${err}`)
-
-  const exception = JSON.parse(err.message) as ModelingException
-
-  if (!(isParsingEx(exception) || isResolutionEx(exception))) error('Unknown exception type')
-  error(exception)
-}