cedar-model-typescript-library 1.0.1 → 1.0.2

package/README.md

@@ -2,17 +2,10 @@
 
 A library to work with CEDAR templates and instances - implemented in TypeScript
 
-## Build
+## Install
 
 ```shell
-npm install
-npm run build
-```
-
-## Run the tests
-
-```shell
-npm test
+npm install cedar-model-typescript-library
 ```
 
 ## YAML scalar style
@@ -22,65 +15,6 @@ Canonical YAML leaves values plain only for `type`, `modelVersion`, `status`, `v
 field's CEDAR-owned vocabulary. IRIs, timestamps, external vocabularies, and user-authored strings
 remain double-quoted. The Java artifact library applies and tests the same policy.
 
-## To regenerate reference file outputs
-
-```shell
-# Using CEDAR Artifact Library
-npx ts-node ./itest/scripts/regenerate-json-files-with-java-lib.ts
-npx ts-node ./itest/scripts/regenerate-yaml-files-with-java-lib.ts
-
-# Using CEDAR Model TypeScript Library
-npx ts-node ./itest/scripts/regenerate-json-files-with-ts-lib.ts
-npx ts-node ./itest/scripts/regenerate-yaml-files-with-ts-lib.ts
-
-# All files
-npx ts-node ./itest/scripts/regenerate-all-files.ts
-```
-
-## Compare generated files
-
-```shell
-# Regenerates expanded and compact TypeScript instance YAML and fails if any
-# of the 21 shared Java/TypeScript outputs differs.
-npm run parity:yaml:instances
-
-npx ts-node ./itest/scripts/compare-verbatim-ts-java-yaml-files.ts
-npx ts-node ./itest/scripts/compare-verbatim-ref-java-yaml-files.ts
-npx ts-node ./itest/scripts/compare-verbatim-ref-ts-yaml-files.ts
-
-npx ts-node ./itest/scripts/compare-content-ref-ts-json-files.ts
-npx ts-node ./itest/scripts/compare-content-ref-java-json-files.ts
-```
-
-## Development
-
-During development, you might want to use this library in a client project.
-To do so, execute this:
-
-```shell
-npm run build
-npm run link
-```
-
-To check the globally installed packages, and check if this library is linked properly, execute:
-
-```shell
-npm ls -g --depth=0
-```
-
-You should see something similar:
-
-```shell
-/opt/homebrew/lib
-├── @angular/cli@17.3.0
-├── cedar-model-typescript-library@0.8.0 -> ./../../../Users/egyedia/CEDAR/cedar-model-typescript-library/dist
-├── ember-cli@5.7.0
-├── gulp@4.0.2
-├── npm@10.5.0
-├── ts-node@10.9.2
-└── typescript@5.4.2
-```
-
 ## See it in action
 
 Check out the README at the companion [demo repo](https://github.com/metadatacenter/cedar-model-typescript-library-demo)

package/package.json

@@ -1,72 +1,19 @@
 {
   "name": "cedar-model-typescript-library",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "CEDAR Model Typescript Library - a library to work with fields, elements, templates and instances implemented in TypeScript",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "scripts": {
-    "pretest": "node pretest.js",
-    "test": "jest",
-    "pretest:coverage": "node pretest.js",
-    "test:coverage": "jest --coverage --runInBand",
-    "generate:yaml:ts": "CEDAR_HOME=. ts-node ./itest/scripts/regenerate-yaml-files-with-ts-lib.ts",
-    "generate:yaml:compact:ts": "CEDAR_HOME=. ts-node ./itest/scripts/regenerate-compact-yaml-files-with-ts-lib.ts",
-    "generate:yaml:instances:ts": "CEDAR_HOME=. ts-node ./itest/scripts/regenerate-yaml-instances-with-ts-lib.ts",
-    "generate:json:ts": "CEDAR_HOME=. ts-node ./itest/scripts/regenerate-json-files-with-ts-lib.ts",
-    "verify:java-lock": "ts-node ./itest/scripts/verify-java-artifact-library-lock.ts",
-    "verify:java-lock:source": "npm run verify:java-lock -- --check-siblings",
-    "parity:json": "node itest/scripts/run-parity.js json",
-    "parity:yaml:instances": "node itest/scripts/run-parity.js yaml-instances",
-    "parity:yaml:compact": "node itest/scripts/run-parity.js yaml-compact",
-    "parity:yaml": "node itest/scripts/run-parity.js yaml",
-    "lint": "eslint \"src/**/*.ts\" eslint.config.js smoke-test-package.js itest/scripts/run-parity.js",
-    "typecheck": "tsc --noEmit --project tsconfig.json",
-    "sync:package-version": "node sync-package-version.js",
-    "version": "npm run sync:package-version",
-    "build": "npm run sync:package-version && webpack && cp package-dist.json dist/package.json && cp README-dist.md dist/README.md && cp license.txt dist/license.txt",
-    "test:package": "npm run build && node smoke-test-package.js",
-    "build:watch": "webpack --watch",
-    "prettier": "prettier --write .",
-    "link": "cd dist && npm link",
-    "unlink": "npm uninstall -g cedar-model-typescript-library"
-  },
+  "main": "index.js",
+  "module": "index.esm.js",
+  "types": "index.d.ts",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/metadatacenter/cedar-model-typescript-library.git"
   },
-  "keywords": [],
-  "author": "",
+  "keywords": ["CEDAR", "Model", "TypeScript", "Library"],
+  "author": "Metadatacenter.org - Attila L. Egyedi",
   "license": "BSD-2-Clause",
   "bugs": {
     "url": "https://github.com/metadatacenter/cedar-model-typescript-library/issues"
   },
-  "homepage": "https://github.com/metadatacenter/cedar-model-typescript-library#readme",
-  "engines": {
-    "node": "^24.15.0"
-  },
-  "devDependencies": {
-    "@eslint/js": "^10.0.1",
-    "@types/jest": "^30.0.0",
-    "@typescript-eslint/eslint-plugin": "^8.66.0",
-    "@typescript-eslint/parser": "^8.66.0",
-    "eslint": "^10.8.0",
-    "eslint-config-prettier": "^10.1.8",
-    "eslint-plugin-prettier": "^5.5.6",
-    "globals": "^17.9.0",
-    "jest": "^30.4.2",
-    "jest-util": "^30.4.1",
-    "prettier": "^3.9.6",
-    "ts-jest": "^29.4.12",
-    "ts-loader": "^9.6.2",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.9.3",
-    "webpack": "^5.109.2",
-    "webpack-cli": "^7.2.2"
-  },
-  "files": [
-    "dist"
-  ],
-  "dependencies": {
-    "yaml": "^2.9.0"
-  }
+  "homepage": "https://github.com/metadatacenter/cedar-model-typescript-library#readme"
 }

package/dist/README.md

@@ -1,20 +0,0 @@
-# CEDAR Model Typescript Library
-
-A library to work with CEDAR templates and instances - implemented in TypeScript
-
-## Install
-
-```shell
-npm install cedar-model-typescript-library
-```
-
-## YAML scalar style
-
-Canonical YAML leaves values plain only for `type`, `modelVersion`, `status`, `version`, `datatype`,
-`action`, `granularity`, `termType`, and `inputTimeFormat`, and only when the value belongs to that
-field's CEDAR-owned vocabulary. IRIs, timestamps, external vocabularies, and user-authored strings
-remain double-quoted. The Java artifact library applies and tests the same policy.
-
-## See it in action
-
-Check out the README at the companion [demo repo](https://github.com/metadatacenter/cedar-model-typescript-library-demo)

package/dist/license.txt

@@ -1,26 +0,0 @@
-Copyright (c) 2026, The Board of Trustees of Leland Stanford Junior University
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without modification, are
-permitted provided that the following conditions are met:
-
-   1. Redistributions of source code must retain the above copyright notice, this list of
-      conditions and the following disclaimer.
-
-   2. Redistributions in binary form must reproduce the above copyright notice, this list
-      of conditions and the following disclaimer in the documentation and/or other materials
-      provided with the distribution.
-
-THIS SOFTWARE IS PROVIDED BY The Board of Trustees of Leland Stanford Junior University
-''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
-EVENT SHALL The Board of Trustees of Leland Stanford Junior University OR CONTRIBUTORS BE
-LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
-WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
-IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-The views and conclusions contained in the software and documentation are those of the
-authors and should not be interpreted as representing official policies, either expressed
-or implied, of The Board of Trustees of Leland Stanford Junior University.

package/dist/package-lock.json

@@ -1,13 +0,0 @@
-{
-  "name": "@org.metadatacenter/cedar-model-typescript-library",
-  "version": "1.0.0",
-  "lockfileVersion": 3,
-  "requires": true,
-  "packages": {
-    "": {
-      "name": "@org.metadatacenter/cedar-model-typescript-library",
-      "version": "1.0.0",
-      "license": "ISC"
-    }
-  }
-}

package/dist/package.json

@@ -1,19 +0,0 @@
-{
-  "name": "@org.metadatacenter/cedar-model-typescript-library",
-  "version": "1.0.1",
-  "description": "CEDAR Model Typescript Library - a library to work with fields, elements, templates and instances implemented in TypeScript",
-  "main": "index.js",
-  "module": "index.esm.js",
-  "types": "index.d.ts",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/metadatacenter/cedar-model-typescript-library.git"
-  },
-  "keywords": ["CEDAR", "Model", "TypeScript", "Library"],
-  "author": "Metadatacenter.org - Attila L. Egyedi",
-  "license": "BSD-2-Clause",
-  "bugs": {
-    "url": "https://github.com/metadatacenter/cedar-model-typescript-library/issues"
-  },
-  "homepage": "https://github.com/metadatacenter/cedar-model-typescript-library#readme"
-}