Skip to content

Commit

Permalink
Merge pull request #607 from Availity/chore/upgrade-docusaurus
Browse files Browse the repository at this point in the history
Chore/upgrade docusaurus
  • Loading branch information
gregmartDOTin authored Feb 19, 2024
2 parents f0cf8ba + f8a6329 commit f957c78
Show file tree
Hide file tree
Showing 25 changed files with 3,588 additions and 3,777 deletions.
8 changes: 0 additions & 8 deletions bundlesize.config.json

This file was deleted.

8 changes: 4 additions & 4 deletions docusaurus/docs/api/axios-resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ This page has information on pre-defined resources you can import into your app.
- [AvSpacesApi](#avspacesapi)
- [AvOrganizationsApi](#avorganizationsapi)
- [AvProvidersApi](#avprovidersapi)
- [AvLogMessageApi](#avlogmessageapi)
- [AvLogMessagesApi](#avlogmessagesapi)
- [AvFilesApi](#avfilesapi)
- [AvFilesDeliveryApi](#avfilesdeliveryapi)
- [AvFilesDeliveryApi](#avfilesdelivery)
- [AvSettingsApi](#avsettingsapi)
- [AvDisclaimersApi](#avdisclaimersapi)
- [AvSlotmachineApi](#avslotmachineapi)
Expand All @@ -24,7 +24,7 @@ This page has information on pre-defined resources you can import into your app.

Each pre-defined resource has two exports: the class and an instance. The class follows the pattern `AvUserApi` and the instance is `avUserApi`. In other words, the class is uppercase and the instance is lowercase.

Use the class to extend functionality. Otherwise import the instance to hit the ground running. Follow [our guide](https://availity.github.io/sdk-js/recipes/httpRequest) for more information on creating your own endpoint.
Use the class to extend functionality. Otherwise import the instance to hit the ground running. Follow [our guide](https://availity.github.io/sdk-js/recipes/http-request) for more information on creating your own endpoint.

### AvUserApi

Expand Down Expand Up @@ -639,7 +639,7 @@ Endpoint for making outbound proxy calls. For a detailed example see [Creating a

The `X-Availity-Customer-ID` header is required in the config for all methods. This can be done manually when the method is called as shown in the examples below. Alternatively, if the `X-Availity-Customer-ID` header needs to be added to all (or most) of your api calls, then it can be passed in axios.defaults.headers.common['X-Availity-Customer-ID'] when initializing axios. For more information, see [Config Defaults](https://axios-http.com/docs/config_defaults).

The `customerId` is a field in the response from the Organizations API. For more information on the API see the [AvOrganizationsApi](#avorganizationsapi) and the [Organizations API Definition](./definitions/organizations.md). For UIs, the [AvOrganizationSelect component](https://availity.github.io/availity-react/form/select/components/organization-select) provides a dropdown for the user to select an Organization they are associated with. By default the value returned from the AvOrganizationSelect component is the organization's `id`. Use the (valueKey)[https://availity.github.io/availity-react/form/select/components/select/#valuekey-string] prop to get the `customerId`.
The `customerId` is a field in the response from the Organizations API. For more information on the API see the [AvOrganizationsApi](#avorganizationsapi) and the [Organizations API Definition](./definitions/organizations.md). For UIs, the [AvOrganizationSelect component](https://availity.github.io/availity-react/form/select/components/organization-select) provides a dropdown for the user to select an Organization they are associated with. By default the value returned from the AvOrganizationSelect component is the organization's `id`. Use the [valueKey](https://availity.github.io/availity-react/form/select/components/select/#valuekey-string) prop to get the `customerId`.

#### `create(data, config)`

Expand Down
2 changes: 1 addition & 1 deletion docusaurus/docs/resources/analytics.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ Without plugins, the AvAnalytics class would not do anything useful. When AvAnal
- `isEnabled` - Determines if this plugin is enabled. Disabled plugins will not respond to events. This can be a method that returns a boolean or it can be a static boolean property.
- `init` - If defined, will be called when `AvAnalytics` is initialized.
- `trackEvent` - If defined, this plugin method will be called every time [`analytics.trackEvent()`](#trackeventproperties-object) is called. It will be forwarded the same event data passed to that original call.
- `trackPageView` - If defined, this plugin method will be called every time [`analytics.trackPageView()`](#trackeventproperties-object) is called. It will be forwarded the same new page URL passed to that original call.
- `trackPageView` - If defined, this plugin method will be called every time [`analytics.trackPageView()`](#trackpageviewarg-string---url-string-) is called. It will be forwarded the same new page URL passed to that original call.

A default class with functions defined and enabled logic is provided by `AvAnalyticsPlugin` from [@availity/analytics-core](https://www.npmjs.com/package/@availity/analytics-core). Extend this class to define your own custom plugins

Expand Down
2 changes: 1 addition & 1 deletion docusaurus/docs/resources/resolve-url.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Resolve URLs to absolute URI/IRI.

[![Version](https://img.shields.io/npm/v/@availity/resolve-url.svg?style=for-the-badge)](https://www.npmjs.com/package/@availity/resolve-url)

This library resolves relative IRIs to absolute IRIs given a base IRI, conforming to [RFC3986](https://www.ietf.org/rfc/rfc3986.txt). The code was borrowed from [relative-to-absolute-iri](https://github.com/rubensorks/relative-to-absolute-iri.js).
This library resolves relative IRIs to absolute IRIs given a base IRI, conforming to [RFC3986](https://www.ietf.org/rfc/rfc3986.txt). The code was borrowed from [relative-to-absolute-iri](https://github.com/rubensworks/relative-to-absolute-iri.js).

## Installation

Expand Down
6 changes: 3 additions & 3 deletions docusaurus/docs/resources/yup.md
Original file line number Diff line number Diff line change
Expand Up @@ -352,7 +352,7 @@ Set the min and max that the date must be inbetween

- **min** - `string`. **required**. The minimum allowed date.
- **max** - `string`. **required**. The maximum allowed date.
- **message** - `string`. Optional. Custom error message when invalid. Default: "Date must be between ${min} and ${max}."
- **message** - `string`. Optional. Custom error message when invalid. Default: "Date must be between `${min}` and `${max}`."
- **inclusivity** - `string`. Optional. Set whether the min and max should be inclusive. Default: "()"

[More information](https://momentjscom.readthedocs.io/en/latest/moment/05-query/06-is-between/) on inclusivity
Expand All @@ -374,7 +374,7 @@ Validate the date is on or after the given minimum
###### Parameters

- **min** - `string`. **required**. The minimum date the given value must be on or after.
- **message** - `string`. Optional. Custom error message when invalid. Default: "Date must be ${min} or later."
- **message** - `string`. Optional. Custom error message when invalid. Default: "Date must be `${min}` or later."

###### Example

Expand All @@ -393,7 +393,7 @@ Validate the date is on or before the given maximum
###### Parameters

- **max** - `string`. **required**. The maximum date the given value must be on or before.
- **message** - `string`. Optional. Custom error message when invalid. Default: "Date must be ${max} or earlier."
- **message** - `string`. Optional. Custom error message when invalid. Default: "Date must be `${max}` or earlier."

###### Example

Expand Down
6 changes: 3 additions & 3 deletions docusaurus/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@
"format": "prettier '**/*' --write --ignore-unknown"
},
"dependencies": {
"@docusaurus/core": "^2.4.1",
"@docusaurus/preset-classic": "^2.4.1",
"@mdx-js/react": "^1.6.22",
"@docusaurus/core": "^3.1.1",
"@docusaurus/preset-classic": "^3.1.1",
"@mdx-js/react": "^3.0.1",
"clsx": "^2.0.0",
"react": "^18.2.0",
"react-dom": "^18.2.0"
Expand Down
2 changes: 1 addition & 1 deletion nx.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"default": {
"runner": "nx/tasks-runners/default",
"options": {
"cacheableOperations": ["build", "test", "lint", "package", "prepare", "bundlesize"]
"cacheableOperations": ["build", "test", "lint", "package", "prepare"]
}
}
},
Expand Down
4 changes: 1 addition & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@
"build:packages": "nx run-many --target=build --all --exclude=docusaurus",
"build:docs": "nx build docusaurus",
"build:affected": "nx affected --target=build",
"bundlesize": "nx run-many --target=bundlesize --all",
"check:deps": "adio",
"check:registry": "sh ./scripts/artifactory-check.sh",
"clean": "nx run-many --target=clean --all && rm -rf node_modules",
Expand Down Expand Up @@ -60,7 +59,6 @@
"@types/jest": "^26.0.24",
"@types/node": "^18.17.7",
"adio": "^1.2.1",
"bundlesize": "^0.18.1",
"codecov": "^3.8.3",
"conventional-changelog-cli": "^3.0.0",
"conventional-recommended-bump": "^7.0.1",
Expand All @@ -76,7 +74,7 @@
"lint-staged": "^14.0.1",
"nock": "^13.3.3",
"nx": "16.7.2",
"plop": "^2.7.6",
"plop": "^4.0.1",
"prettier": "^3.0.2",
"ts-jest": "^27.0.0",
"typescript": "^5.1.6",
Expand Down
1 change: 0 additions & 1 deletion packages/analytics-core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@
"build": "tsup src/index.js --format esm,cjs --dts",
"dev": "tsup src/index.js --format esm,cjs --watch --dts",
"clean": "rm -rf node_modules && rm -rf dist",
"bundlesize": "bundlesize",
"publish": "yarn npm publish --tolerate-republish --access public"
},
"dependencies": {
Expand Down
1 change: 0 additions & 1 deletion packages/api-axios/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@
"lint": "eslint src",
"lint:fix": "eslint src --fix",
"clean": "rm -rf node_modules && rm -rf dist",
"bundlesize": "bundlesize",
"publish": "yarn npm publish --tolerate-republish --access public"
},
"dependencies": {
Expand Down
1 change: 0 additions & 1 deletion packages/authorizations-axios/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
"lint": "eslint src",
"lint:fix": "eslint src --fix",
"clean": "rm -rf node_modules && rm -rf dist",
"bundlesize": "bundlesize",
"publish": "yarn npm publish --tolerate-republish --access public"
},
"dependencies": {
Expand Down
1 change: 0 additions & 1 deletion packages/authorizations-core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
"lint": "eslint src",
"lint:fix": "eslint src --fix",
"clean": "rm -rf node_modules && rm -rf dist",
"bundlesize": "bundlesize",
"publish": "yarn npm publish --tolerate-republish --access public"
},
"devDependencies": {
Expand Down
1 change: 0 additions & 1 deletion packages/dl-axios/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@
"lint": "eslint src",
"lint:fix": "eslint src --fix",
"clean": "rm -rf node_modules && rm -rf dist",
"bundlesize": "bundlesize",
"publish": "yarn npm publish --tolerate-republish --access public"
},
"dependencies": {
Expand Down
1 change: 0 additions & 1 deletion packages/dl-core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
"lint": "eslint src",
"lint:fix": "eslint src --fix",
"clean": "rm -rf node_modules && rm -rf dist",
"bundlesize": "bundlesize",
"publish": "yarn npm publish --tolerate-republish --access public"
},
"dependencies": {
Expand Down
1 change: 0 additions & 1 deletion packages/dockyard/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
"lint": "eslint src",
"lint:fix": "eslint src --fix",
"clean": "rm -rf node_modules && rm -rf dist",
"bundlesize": "bundlesize",
"publish": "yarn npm publish --tolerate-republish --access public"
},
"dependencies": {
Expand Down
1 change: 0 additions & 1 deletion packages/env-var/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@
"lint": "eslint src",
"lint:fix": "eslint src --fix",
"clean": "rm -rf node_modules && rm -rf dist",
"bundlesize": "bundlesize",
"publish": "yarn npm publish --tolerate-republish --access public"
},
"devDependencies": {
Expand Down
1 change: 0 additions & 1 deletion packages/exceptions-axios/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
"lint": "eslint src",
"lint:fix": "eslint src --fix",
"clean": "rm -rf node_modules && rm -rf dist",
"bundlesize": "bundlesize",
"publish": "yarn npm publish --tolerate-republish --access public"
},
"dependencies": {
Expand Down
1 change: 0 additions & 1 deletion packages/exceptions-core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
"lint": "eslint src",
"lint:fix": "eslint src --fix",
"clean": "rm -rf node_modules && rm -rf dist",
"bundlesize": "bundlesize",
"publish": "yarn npm publish --tolerate-republish --access public"
},
"devDependencies": {
Expand Down
1 change: 0 additions & 1 deletion packages/message-core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
"lint": "eslint src",
"lint:fix": "eslint src --fix",
"clean": "rm -rf node_modules && rm -rf dist",
"bundlesize": "bundlesize",
"publish": "yarn npm publish --tolerate-republish --access public"
},
"devDependencies": {
Expand Down
1 change: 0 additions & 1 deletion packages/native-form/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@
"lint": "eslint src",
"lint:fix": "eslint src --fix",
"clean": "rm -rf node_modules && rm -rf dist",
"bundlesize": "bundlesize",
"publish": "yarn npm publish --tolerate-republish --access public"
},
"dependencies": {
Expand Down
1 change: 0 additions & 1 deletion packages/relay-id/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
"lint": "eslint src",
"lint:fix": "eslint src --fix",
"clean": "rm -rf node_modules && rm -rf dist",
"bundlesize": "bundlesize",
"publish": "yarn npm publish --tolerate-republish --access public"
},
"devDependencies": {
Expand Down
1 change: 0 additions & 1 deletion packages/resolve-url/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@
"lint": "eslint src",
"lint:fix": "eslint src --fix",
"clean": "rm -rf node_modules && rm -rf dist",
"bundlesize": "bundlesize",
"publish": "yarn npm publish --tolerate-republish --access public"
},
"devDependencies": {
Expand Down
1 change: 0 additions & 1 deletion packages/upload-core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@
"lint": "eslint src",
"lint:fix": "eslint src --fix",
"clean": "rm -rf node_modules && rm -rf dist",
"bundlesize": "bundlesize",
"publish": "yarn npm publish --tolerate-republish --access public"
},
"dependencies": {
Expand Down
1 change: 0 additions & 1 deletion packages/yup/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@
"lint": "eslint src",
"lint:fix": "eslint src --fix",
"clean": "rm -rf node_modules && rm -rf dist",
"bundlesize": "bundlesize",
"publish": "yarn npm publish --tolerate-republish --access public"
},
"dependencies": {
Expand Down
Loading

0 comments on commit f957c78

Please sign in to comment.