docs(product): stub models

Create stubs and specs for: - lib/product/arbitrary-price - lib/product/batch - lib/product/catalog-entry - lib/product/measured-product-instance - lib/product/measured-product-type - lib/product/package - lib/product/package-instance - lib/product/package-type - lib/product/price - lib/product/pricing-strategy - lib/product/product-catalog - lib/product/product-feature-type - lib/product/product-identifier - lib/product/product-instance - lib/product/product-type #1
commonality · Jul 11, 2019 · 1444364 · 1444364
1 parent c6a3b82
commit 1444364
Show file tree

Hide file tree

Showing 88 changed files with 3,034 additions and 194 deletions.
diff --git a/.env.defaults b/.env.defaults
@@ -12,7 +12,7 @@
 # Product manifest (package.json) variables
 #
 
-NPM_PACKAGE_NAME=archetypes-products
+NPM_PACKAGE_NAME=@archetypes/product
 NPM_PACKAGE_VERSION=
 
 #
@@ -35,7 +35,7 @@ K8S_SECRET_GITLAB_TOKEN=
 
 # name attribute of <testsuites>
 # @default "jest tests"
-JEST_SUITE_NAME=archetypes-products tests
+JEST_SUITE_NAME=@archetypes/product tests
 
 # File path to save the output.
 # @default "./junit.xml"

diff --git a/.github/ci/docs/jsdoc.json b/.github/ci/docs/jsdoc.json
@@ -25,7 +25,7 @@
     "cleverLinks": false,
     "monospaceLinks": false,
     "better-docs": {
-      "name": "archetypes-products API Documentation",
+      "name": "@archetypes/product API Documentation",
       "logo": "docs/img/logos/logo.png",
       "trackingCode": null,
       "navigation": [

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -95,57 +95,57 @@ $ npm test
 
 ### How to test a release
 
-The [Pre-release test instructions](https://github.com/commonality/archetypes-products/wiki/Pre-release-test-instructions) include step-by-step guidelines for bundling, packing, and testing this module as it would be released on NPM.
+The [Pre-release test instructions](https://github.com/commonality/@archetypes/product/wiki/Pre-release-test-instructions) include step-by-step guidelines for bundling, packing, and testing this module as it would be released on NPM.
 
 
 ---
 
 <!-- SonarCloud badge refs -->
 
 [sonar-alert-status-badge]:
-  https://sonarcloud.io/api/project_badges/measure?project=commonality_archetypes-products&metric=alert_status&template=FLAT
+  https://sonarcloud.io/api/project_badges/measure?project=commonality_@archetypes/product&metric=alert_status&template=FLAT
 [sonar-alert-status-url]:
-  https://sonarcloud.io/dashboard?id=commonality_archetypes-products
+  https://sonarcloud.io/dashboard?id=commonality_@archetypes/product
 [sonar-bugs-badge]:
-  https://sonarcloud.io/api/project_badges/measure?project=commonality_archetypes-products&metric=bugs&template=FLAT
+  https://sonarcloud.io/api/project_badges/measure?project=commonality_@archetypes/product&metric=bugs&template=FLAT
 [sonar-bugs-url]:
-  https://sonarcloud.io/dashboard?id=commonality_archetypes-products
+  https://sonarcloud.io/dashboard?id=commonality_@archetypes/product
 [sonar-code-smells-badge]:
-  https://sonarcloud.io/api/project_badges/measure?project=commonality_archetypes-products&metric=code_smells&template=FLAT
+  https://sonarcloud.io/api/project_badges/measure?project=commonality_@archetypes/product&metric=code_smells&template=FLAT
 [sonar-code-smells-url]:
-  https://sonarcloud.io/component_measures?id=commonality_archetypes-products&metric=code_smells
+  https://sonarcloud.io/component_measures?id=commonality_@archetypes/product&metric=code_smells
 [sonar-coverage-badge]:
-  https://sonarcloud.io/api/project_badges/measure?project=commonality_archetypes-products&metric=coverage&template=FLAT
+  https://sonarcloud.io/api/project_badges/measure?project=commonality_@archetypes/product&metric=coverage&template=FLAT
 [sonar-coverage-url]:
-  https://sonarcloud.io/component_measures?id=commonality_archetypes-products&metric=coverage
+  https://sonarcloud.io/component_measures?id=commonality_@archetypes/product&metric=coverage
 [sonar-duplicated-lines-density-badge]:
-  https://sonarcloud.io/api/project_badges/measure?project=commonality_archetypes-products&metric=duplicated_lines_density&template=FLAT
+  https://sonarcloud.io/api/project_badges/measure?project=commonality_@archetypes/product&metric=duplicated_lines_density&template=FLAT
 [sonar-duplicated-lines-density-url]:
-  https://sonarcloud.io/component_measures?id=commonality_archetypes-products&metric=duplicated_lines_density
+  https://sonarcloud.io/component_measures?id=commonality_@archetypes/product&metric=duplicated_lines_density
 [sonar-ncloc-badge]:
-  https://sonarcloud.io/api/project_badges/measure?project=commonality_archetypes-products&metric=ncloc&template=FLAT
+  https://sonarcloud.io/api/project_badges/measure?project=commonality_@archetypes/product&metric=ncloc&template=FLAT
 [sonar-ncloc-url]:
-  https://sonarcloud.io/component_measures?id=commonality_archetypes-products&metric=ncloc
+  https://sonarcloud.io/component_measures?id=commonality_@archetypes/product&metric=ncloc
 [sonar-reliability-rating-badge]:
-  https://sonarcloud.io/api/project_badges/measure?project=commonality_archetypes-products&metric=reliability_rating&template=FLAT
+  https://sonarcloud.io/api/project_badges/measure?project=commonality_@archetypes/product&metric=reliability_rating&template=FLAT
 [sonar-reliability-rating-url]:
-  https://sonarcloud.io/component_measures?id=commonality_archetypes-products&metric=reliability_rating
+  https://sonarcloud.io/component_measures?id=commonality_@archetypes/product&metric=reliability_rating
 [sonar-security-rating-badge]:
-  https://sonarcloud.io/api/project_badges/measure?project=commonality_archetypes-products&metric=security_rating&template=FLAT
+  https://sonarcloud.io/api/project_badges/measure?project=commonality_@archetypes/product&metric=security_rating&template=FLAT
 [sonar-security-rating-url]:
-  https://sonarcloud.io/component_measures?id=commonality_archetypes-products&metric=security_rating
+  https://sonarcloud.io/component_measures?id=commonality_@archetypes/product&metric=security_rating
 [sonar-sqale-index-badge]:
-  https://sonarcloud.io/api/project_badges/measure?project=commonality_archetypes-products&metric=sqale_index&template=FLAT
+  https://sonarcloud.io/api/project_badges/measure?project=commonality_@archetypes/product&metric=sqale_index&template=FLAT
 [sonar-sqale-index-url]:
-  https://sonarcloud.io/component_measures?id=commonality_archetypes-products&metric=sqale_index
+  https://sonarcloud.io/component_measures?id=commonality_@archetypes/product&metric=sqale_index
 [sonar-sqale-rating-badge]:
-  https://sonarcloud.io/api/project_badges/measure?project=commonality_archetypes-products&metric=sqale_rating&template=FLAT
+  https://sonarcloud.io/api/project_badges/measure?project=commonality_@archetypes/product&metric=sqale_rating&template=FLAT
 [sonar-sqale-rating-url]:
-  https://sonarcloud.io/component_measures?id=commonality_archetypes-products&metric=sqale_rating
+  https://sonarcloud.io/component_measures?id=commonality_@archetypes/product&metric=sqale_rating
 [sonar-vulnerabilities-badge]:
-  https://sonarcloud.io/api/project_badges/measure?project=commonality_archetypes-products&metric=vulnerabilities&template=FLAT
+  https://sonarcloud.io/api/project_badges/measure?project=commonality_@archetypes/product&metric=vulnerabilities&template=FLAT
 [sonar-vulnerabilities-url]:
-  https://sonarcloud.io/component_measures?id=commonality_archetypes-products&metric=vulnerabilities
+  https://sonarcloud.io/component_measures?id=commonality_@archetypes/product&metric=vulnerabilities
 
 <!-- ⛔️ Badge references ⛔️  -->
 
@@ -162,9 +162,9 @@ The [Pre-release test instructions](https://github.com/commonality/archetypes-pr
 
 [standardjs-logo]: https://cdn.rawgit.com/feross/standard/master/badge.svg
 [standardjs-url]: https://github.com/feross/standard
-[eslint-logo]: https://raw.githubusercontent.com/commonality/archetypes-products/master/docs/img/logos/logo-eslint.png
+[eslint-logo]: https://raw.githubusercontent.com/commonality/@archetypes/product/master/docs/img/logos/logo-eslint.png
 [eslint-url]: https://eslint.org/docs/user-guide/getting-started
-[jest-logo]: https://raw.githubusercontent.com/commonality/archetypes-products/master/docs/img/logos/logo-jest.png
+[jest-logo]: https://raw.githubusercontent.com/commonality/@archetypes/product/master/docs/img/logos/logo-jest.png
 [jest-url]: https://facebook.github.io/jest/docs/en/getting-started.html
 
 <!-- ⛔️ Octicon img references ⛔️  -->

diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# archetypes-products
+# @archetypes/product
 
 ![banner](docs/img/logos/logo.png)
 
@@ -20,7 +20,7 @@
 
 - [1. Overview](#1-overview)
   * [1.1. Standards](#11-standards)
-  * [1.2. **@archetypes/product** Model](#12-archetypesproduct-model)
+  * [1.2. **@archetypes/product** Specification](#12-archetypesproduct-specification)
 - [2. Installation](#2-installation)
 - [3. Usage](#3-usage)
 - [4. API](#4-api)
@@ -52,6 +52,7 @@
 - [5. Maintainers](#5-maintainers)
 - [6. Contributions](#6-contributions)
 - [7. License](#7-license)
+- [8. Citations and References](#8-citations-and-references)
 
 <!-- tocstop -->
 
@@ -71,9 +72,9 @@ _Table 1.1_
 
 | Standard                      | Description                                |
 | ----------------------------- | ------------------------------------------ |
-| [EAN.UCC System][ean-ucc-url] | Product identification standards.          |
-| [ISO 2108][iso-2108-url]      | International Standard Book Number (ISBN)  |
-| [ISO 10957][iso-10957-url]    | International Standard Music Number (ISMN) |
+| [EAN.UCC System](http://www.ibcaweb.org/guide/guide_mfr/ch4.htm) | Product identification standards.          |
+| [ISO 2108](https://www.iso.org/standard/65483.html)              | International Standard Book Number (ISBN)  |
+| [ISO 10957](https://www.iso.org/standard/43173.html)             | International Standard Music Number (ISMN) |
 
 ### 1.2. **@archetypes/product** Specification
 
@@ -84,7 +85,7 @@ _Figure 1: **@archetypes/product** module UML class diagram._ [^1]
 ## 2. Installation
 
 ```sh
-npm install @archetypes/products
+npm install @archetypes/product
 ```
 
 <small>[![Back to Table of contents][octicon-triangle-up]