Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation PR for Next Release #621

Open
wants to merge 33 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
cf0472c
Change package.json engines field to point to node version 20 and up.
philfuster Apr 2, 2024
c5b7e98
Update documentation to reference node version 20
philfuster Apr 2, 2024
09a8668
deleted node modules and re-installed dependencies with npm instead o…
philfuster Apr 2, 2024
85505df
update babelrc.js to reference node 20.
philfuster Apr 2, 2024
5bff4ab
update ci.yaml to use node 20. Updated the matrix for the test action…
philfuster Apr 2, 2024
7b575eb
updated gh-pages.yml to reference node version 20 instead of 16.
philfuster Apr 2, 2024
e3dd11c
Updated node version minimum to 18 in package.json.
philfuster Apr 3, 2024
06df42a
Updated babelrc to target node 18.
philfuster Apr 3, 2024
147722d
Update ci and gh-pages to run using node 18.
philfuster Apr 3, 2024
fcc9f38
Update version to 2.0.0
philfuster Apr 3, 2024
6b50173
Update changelog
philfuster Apr 3, 2024
cbb21d4
upgrade package.json dependencies according to the docusaurus upgrade…
philfuster Apr 3, 2024
4d66717
Upgrade dependencies.
philfuster Apr 3, 2024
47d0479
update tsconfig to include ts config files.
philfuster Apr 3, 2024
8acb560
Remove explicit import of React. no longer needed because of React 18…
philfuster Apr 3, 2024
4229231
Update admonitions according to the upgrade to v3 notes - [docusaurus…
philfuster Apr 3, 2024
26c746e
prettier on tsconfig.json.
philfuster Apr 3, 2024
bbe447f
update mvom packages release version in pnpm-lock.json
philfuster Apr 4, 2024
c9c46bd
Updated Docusaurus to version 3.2 because version 3 depended on an un…
philfuster Apr 4, 2024
fc586de
Fix broken links and anchors.
philfuster Apr 4, 2024
62dd57f
Update changelog to show updating docusaurus to v 3.2.
philfuster Apr 4, 2024
5410e55
Update Github workflows to use later action versions to avoid warning…
philfuster Apr 5, 2024
bb89949
Merge branch 'upgrade_to_node_20_remove_node_16' of github.com:storis…
philfuster Apr 5, 2024
ee410d3
Updated CHANGELOG.
philfuster Apr 5, 2024
ca2a05f
Revert package.json version change. Shouldn't be updated till new rel…
philfuster Apr 5, 2024
5d8b98a
Change remaining caution admonitions to warning.
philfuster Apr 5, 2024
50b3907
revert updating documentation version in docusaurus.config.ts. Goes i…
philfuster Apr 5, 2024
1bd5ffc
revert update to node version in the docs. Goes in separate PR.
philfuster Apr 5, 2024
f8fbc60
update to docusarus v3.2.1.
philfuster Apr 5, 2024
063f605
update docusaurus config with current docs version.
philfuster Apr 5, 2024
ed2c703
Changed casing of `unreleased` back to `Unreleased`.
philfuster Apr 8, 2024
3ef0cc0
Changed this to 2.0.0-rc.2.
philfuster Apr 8, 2024
a8efc2d
increase minimum node version in docs.
philfuster Apr 8, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .babelrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ module.exports = {
env: {
build: {
ignore: ['**/*.test.ts', '**/__mocks__/**'],
presets: [['@babel/env', { targets: { node: '16.0.0' } }], '@babel/typescript'],
presets: [['@babel/env', { targets: { node: '18.0.0' } }], '@babel/typescript'],
},
debug: { sourceMaps: 'inline', retainLines: true },
},
Expand Down
18 changes: 9 additions & 9 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: '16'
node-version: '18'
check-latest: true
cache: 'npm'
- name: Install Dependencies
Expand All @@ -24,10 +24,10 @@ jobs:
needs: setup

steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: '16'
node-version: '18'
check-latest: true
cache: 'npm'
- run: npm ci
Expand All @@ -43,11 +43,11 @@ jobs:
needs: setup
strategy:
matrix:
node: ['16', '18']
node: ['18', '20']

steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node }}
check-latest: true
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ jobs:
run:
working-directory: website
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 16.x
node-version: 18.x
cache: 'npm'

- name: Install dependencies
Expand All @@ -36,7 +36,7 @@ jobs:
# Popular action to deploy to GitHub Pages:
# Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
# Build output to publish to the `gh-pages` branch:
Expand Down
17 changes: 16 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [2.0.0-rc.2] - 2024-04-03

### Breaking Changes

- Minimum Node version is now 18.0.0 ([#620](https://github.com/STORIS/mvom/pull/620))

### Docs

- Upgraded to Docusaurus v3.2.1 because V2 does not support Node 18 ([#620](https://github.com/STORIS/mvom/pull/620)).

### Added

- Add node 20 to the CI matrix

## [2.0.0-rc.1] - 2023-05-05

### Breaking changes
Expand Down Expand Up @@ -435,7 +449,8 @@ We've graduated from Alpha to Beta! Semver has been updated so breaking vs. non-

Initial alpha release of this library! Thanks for using it!

[unreleased]: https://github.com/storis/mvom/compare/2.0.0-rc.1...HEAD
[unreleased]: https://github.com/storis/mvom/compare/2.0.0-rc.2...HEAD
[2.0.0-rc.2]: https://github.com/storis/mvom/compare/2.0.0-rc.1...2.0.0-rc.2
[2.0.0-rc.1]: https://github.com/storis/mvom/compare/2.0.0-rc.0...2.0.0-rc.1
[2.0.0-rc.0]: https://github.com/storis/mvom/compare/2.0.0-alpha.7...2.0.0-rc.0
[2.0.0-alpha.7]: https://github.com/storis/mvom/compare/2.0.0-alpha.6...2.0.0-alpha.7
Expand Down
6 changes: 3 additions & 3 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"name": "mvom",
"private": true,
"version": "2.0.0-rc.1",
"version": "2.0.0-rc.2",
"description": "Multivalue Object Mapper",
"main": "index.js",
"engines": {
"node": ">=16"
"node": ">=18"
},
"scripts": {
"build": "npm-run-all build:node build:unibasic build:copy-files build:declaration",
Expand Down
4 changes: 2 additions & 2 deletions website/docs/01 - Introduction/01 - What is MVOM.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ MVOM (**M**ulti**V**alue **O**bject **M**apper) is a library which provides the

## Requirements

:::warning
:::danger
The creators of MVOM work with Unidata exclusively. This has not been tested on Universe. If you would like to help us test and ensure everything works on Universe, please [log an issue](https://github.com/STORIS/mvom/issues/new) and let us know.
:::

- MultiValue Database Server
- Unidata (version 8.2.1 or higher)
- Universe (see warning above)
- MultiValue Integration Server (version 1.3.0 or higher)
- Node.js (version 16.0.0 or higher)
- Node.js (version 18.0.0 or higher)

## How it works

Expand Down
2 changes: 1 addition & 1 deletion website/docs/03 - Schema/01 - Basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ For data located in a specific value of an attribute, the `path` will be a dot-d

For data located in a specific subvalue of a value of an attribute, the `path` will be a dot-delimited string of integers with three parts. That is, the format of the string will be `"n.n.n"` where `n` represents an integer value. For instance, If the data is locatated in the first subvalue of the second value of the third attribute of a file, the `path` would be defined as `"3.2.1"`.

:::caution
:::warning
It's very likely that if you have data defined using subvalue based paths that there is either a better way to describe that data in MVOM or you might be employing a schema anti-pattern. Although this mechanism is supported by MVOM, it may be best to evaluate if there is another way to describe your schema or consider refactoring your physical database structures.
:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The string schema type is the simplest of the schema types supported by MVOM.

## Schema Definition Properties

In addition to the [base schema definition properties](../schema_basics#properties-common-to-all-schema-definitions) the `string` type has the following additional properties:
In addition to the [base schema definition properties](../schema_basics#properties-common-to-all-schema-definition-types) the `string` type has the following additional properties:

| Property | Type | Mandatory | Default | Description |
| ------------ | ---------------------------------- | :----------------: | ------- | ------------------------------------------------------------------------------------------------------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The Boolean schema type allows you to work with boolean values.

## Schema Definition Properties

In addition to the [base schema definition properties](../schema_basics#properties-common-to-all-schema-definitions) the `boolean` type has the following additional properties:
In addition to the [base schema definition properties](../schema_basics#properties-common-to-all-schema-definition-types) the `boolean` type has the following additional properties:

| Property | Type | Mandatory | Default | Description |
| -------- | ----------- | :----------------: | ------- | ------------------------------------------ |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The number schema type allows you to work with numeric values.

## Schema Definition Properties

In addition to the [base schema definition properties](../schema_basics#properties-common-to-all-schema-definitions) the `number` type has the following additional properties:
In addition to the [base schema definition properties](../schema_basics#properties-common-to-all-schema-definition-types) the `number` type has the following additional properties:

| Property | Type | Mandatory | Default | Description |
| ------------ | ---------- | :----------------: | ------- | --------------------------------------------------------------------------------------------------------------------------------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The ISOCalendarDate schema type allow you to work with date values.

## Schema Definition Properties

In addition to the [base schema definition properties](../schema_basics#properties-common-to-all-schema-definitions) the `ISOCalendarDate` type has the following additional properties:
In addition to the [base schema definition properties](../schema_basics#properties-common-to-all-schema-definition-types) the `ISOCalendarDate` type has the following additional properties:

| Property | Type | Mandatory | Default | Description |
| -------- | ------------------- | :----------------: | ------- | --------------------------------------------------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The ISOTime schema type allow you to work with time values.

## Schema Definition Properties

In addition to the [base schema definition properties](../schema_basics#properties-common-to-all-schema-definitions) the `ISOTime` type has the following additional properties:
In addition to the [base schema definition properties](../schema_basics#properties-common-to-all-schema-definition-types) the `ISOTime` type has the following additional properties:

| Property | Type | Mandatory | Default | Description |
| ---------- | --------------- | :----------------: | ------- | --------------------------------------------------------------------------------------------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The ISOCalendarDateTime schema type allow you to work with compound date-time va

## Schema Definition Properties

In addition to the [base schema definition properties](../schema_basics#properties-common-to-all-schema-definitions) the `ISOCalendarDateTime` type has the following additional properties:
In addition to the [base schema definition properties](../schema_basics#properties-common-to-all-schema-definition-types) the `ISOCalendarDateTime` type has the following additional properties:

| Property | Type | Mandatory | Default | Description |
| ---------- | ----------------------- | :----------------: | ------- | --------------------------------------------------------------------------------------------- |
Expand Down
2 changes: 1 addition & 1 deletion website/docs/03 - Schema/03 - Schema Options.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ const schema = new Schema({...}, { dictionaries });

The `idMatch` property allows you to specify a regular expression which will validate the `_id` value of an object to determine if there is a match of the regular expression. If the value of `_id` property does not match the regular expression an error will be thrown when saving.

Related: [Validating pattern matching in strings](./Scalar%20Schema%20Types/schema_type_string#validating-pattern-matching>)
Related: [Validating pattern matching in strings](./Scalar%20Schema%20Types/schema_type_string#validating-pattern-matching)

### Validating ID foreign key

Expand Down
2 changes: 1 addition & 1 deletion website/docs/03 - Schema/07 - Encryption.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@ The signature of the decrypt function is:

Specifying the `encrypt` and `decrypt` functions for a schema merely enables the ability to allow encryption on properties in the schema. It does not activate encryption for any data by default. In order to enable encryption for a schema property, the `encrypted` property of the schema definition must be set to `true`. Doing so will enable encryption and decryption behaviors for that property as described above.

See the [schema definition properties documentation](./schema_basics#properties-common-to-all-schema-definitions) for more information.
See the [schema definition properties documentation](./schema_basics#properties-common-to-all-schema-definition-types) for more information.
2 changes: 1 addition & 1 deletion website/docs/04 - Model/06 - Querying/01 - Basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ When issuing queries, a query condition filter object must be passed to the `fin
```

:::info
In order to use a property for a query it must either be a property defined in the schema with a specified [dictionary](../../Schema/schema_basics#properties-common-to-all-schema-definitions) value or a property defined in the [dictionaries object](../../Schema/schema_options#dictionaries-object) of the schema options.
In order to use a property for a query it must either be a property defined in the schema with a specified [dictionary](../../Schema/schema_basics#properties-common-to-all-schema-definition-types) value or a property defined in the [dictionaries object](../../Schema/schema_options#dictionaries-object) of the schema options.
:::

### Example
Expand Down
6 changes: 3 additions & 3 deletions website/docs/04 - Model/06 - Querying/02 - Query Operators.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ The query which will be executed on the MultiValue database is:
select ITEM with DESCRIPTION like "...Bed..."
```

:::caution
:::warning
Queries with the `$contains` operator cannot include single or double quotes (`'` or `"`) in the query constant value.
:::

Expand All @@ -174,7 +174,7 @@ The query which will be executed on the MultiValue database is:
select ITEM with DESCRIPTION like "Bed..."
```

:::caution
:::warning
Queries with the `$startsWith` operator cannot include single or double quotes (`'` or `"`) in the query constant value.
:::

Expand All @@ -194,7 +194,7 @@ The query which will be executed on the MultiValue database is:
select ITEM with DESCRIPTION like "...Bed"
```

:::caution
:::warning
Queries with the `$endsWith` operator cannot include single or double quotes (`'` or `"`) in the query constant value.
:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ title: Projection

Consumers do not always want to return the entire contents of a record. In particular, for large records, returning the entirety of the record can increase the size of data transfer payloads and reduce overall performance if all of the data from a record is not needed. To support this behavior, many read operations allow for specification of a `projection` property. This `projection` property allows the consumer to limit the properties returned from the database resulting in reduced data traffic.

:::caution
:::warning
It is highly advised to never save a `Model` that is instantiated from a read operation using `projection`. Unless you really know what you are doing, this could result in data loss as the `Model` instance will not contain the data that was excluded from the projection.
:::

Expand Down
104 changes: 0 additions & 104 deletions website/docusaurus.config.js

This file was deleted.

Loading