From 5ff8f304b91d6d5e40febaf65798b1f3efab3a71 Mon Sep 17 00:00:00 2001 From: Michael Beckemeyer Date: Fri, 8 Mar 2024 15:42:37 +0100 Subject: [PATCH] Update package.json metadata --- .changeset/small-poets-fail.md | 15 +++++++++++++++ src/packages/authentication/package.json | 9 +++++++++ src/packages/base-theme/README.md | 6 ++++-- src/packages/base-theme/package.json | 10 ++++++++++ src/packages/chakra-integration/README.md | 2 +- src/packages/chakra-integration/package.json | 10 ++++++++++ src/packages/core/package.json | 12 +++++++++++- src/packages/http/package.json | 10 ++++++++++ src/packages/integration/package.json | 10 ++++++++++ src/packages/local-storage/package.json | 10 ++++++++++ src/packages/notifier/package.json | 11 ++++++++++- src/packages/runtime-react-support/README.md | 2 +- src/packages/runtime-react-support/package.json | 10 ++++++++++ src/packages/runtime/README.md | 2 +- src/packages/runtime/package.json | 10 ++++++++++ src/packages/test-utils/README.md | 2 +- src/packages/test-utils/package.json | 10 ++++++++++ 17 files changed, 133 insertions(+), 8 deletions(-) create mode 100644 .changeset/small-poets-fail.md diff --git a/.changeset/small-poets-fail.md b/.changeset/small-poets-fail.md new file mode 100644 index 00000000..7e7ca562 --- /dev/null +++ b/.changeset/small-poets-fail.md @@ -0,0 +1,15 @@ +--- +"@open-pioneer/runtime-react-support": patch +"@open-pioneer/chakra-integration": patch +"@open-pioneer/authentication": patch +"@open-pioneer/local-storage": patch +"@open-pioneer/integration": patch +"@open-pioneer/base-theme": patch +"@open-pioneer/test-utils": patch +"@open-pioneer/notifier": patch +"@open-pioneer/runtime": patch +"@open-pioneer/core": patch +"@open-pioneer/http": patch +--- + +Update package.json metadata. diff --git a/src/packages/authentication/package.json b/src/packages/authentication/package.json index 8fdcf72e..d4a2a9ac 100644 --- a/src/packages/authentication/package.json +++ b/src/packages/authentication/package.json @@ -4,6 +4,15 @@ "license": "Apache-2.0", "version": "0.3.1", "main": "index.ts", + "repository": { + "type": "git", + "url": "https://github.com/open-pioneer/trails-core-packages", + "directory": "src/packages/authentication" + }, + "homepage": "https://github.com/open-pioneer", + "keywords": [ + "open-pioneer-trails" + ], "scripts": { "build": "build-pioneer-package" }, diff --git a/src/packages/base-theme/README.md b/src/packages/base-theme/README.md index 478131ec..9cdab87f 100644 --- a/src/packages/base-theme/README.md +++ b/src/packages/base-theme/README.md @@ -1,6 +1,6 @@ # @open-pioneer/base-theme -This package provides a theme that uses the "trails" color scheme. +This package provides the default theme for all open pioneer trails applications. ## Usage @@ -8,7 +8,9 @@ This theme is automatically used as the default theme for all open pioneer trail ### How to override the `trails` color scheme -Import the `extendTheme` helper function: +When using this theme, the `trails` color scheme becomes is the default color scheme for all chakra UI components. + +To override the `trails` color scheme, import the `extendTheme` helper function: ```jsx import { extendTheme } from "@open-pioneer/chakra-integration"; diff --git a/src/packages/base-theme/package.json b/src/packages/base-theme/package.json index 2a482af4..47cda917 100644 --- a/src/packages/base-theme/package.json +++ b/src/packages/base-theme/package.json @@ -1,8 +1,18 @@ { "name": "@open-pioneer/base-theme", + "description": "This package provides the default theme for all open pioneer trails applications.", "version": "0.3.0", "main": "index.ts", "license": "Apache-2.0", + "repository": { + "type": "git", + "url": "https://github.com/open-pioneer/trails-core-packages", + "directory": "src/packages/base-theme" + }, + "homepage": "https://github.com/open-pioneer", + "keywords": [ + "open-pioneer-trails" + ], "scripts": { "build": "build-pioneer-package" }, diff --git a/src/packages/chakra-integration/README.md b/src/packages/chakra-integration/README.md index 3bcd8d08..b7526e81 100644 --- a/src/packages/chakra-integration/README.md +++ b/src/packages/chakra-integration/README.md @@ -1,6 +1,6 @@ # @open-pioneer/chakra-integration -This package integrates [Chakra UI](https://chakra-ui.com/) into the open pioneer project. +This package integrates [Chakra UI](https://chakra-ui.com/) into open pioneer trails application. All components are re-exported from `@chakra-ui/react` (sometimes with some modifications). All UI packages using the pioneer framework should use this package instead of depending on `@chakra-ui/react` directly. diff --git a/src/packages/chakra-integration/package.json b/src/packages/chakra-integration/package.json index 5b0ba9c9..43ec2487 100644 --- a/src/packages/chakra-integration/package.json +++ b/src/packages/chakra-integration/package.json @@ -1,8 +1,18 @@ { "name": "@open-pioneer/chakra-integration", "version": "1.1.1", + "description": "Integrates Chakra UI into open pioneer trails application.", "main": "index.tsx", "license": "Apache-2.0", + "repository": { + "type": "git", + "url": "https://github.com/open-pioneer/trails-core-packages", + "directory": "src/packages/chakra-integration" + }, + "homepage": "https://github.com/open-pioneer", + "keywords": [ + "open-pioneer-trails" + ], "scripts": { "build": "build-pioneer-package" }, diff --git a/src/packages/core/package.json b/src/packages/core/package.json index 0593556e..3eb350f6 100644 --- a/src/packages/core/package.json +++ b/src/packages/core/package.json @@ -1,8 +1,18 @@ { "name": "@open-pioneer/core", + "version": "1.2.1", + "description": "Contains basic utility functions and classes used by the @open-pioneer project.", "license": "Apache-2.0", "main": "index.ts", - "version": "1.2.1", + "repository": { + "type": "git", + "url": "https://github.com/open-pioneer/trails-core-packages", + "directory": "src/packages/core" + }, + "homepage": "https://github.com/open-pioneer", + "keywords": [ + "open-pioneer-trails" + ], "scripts": { "build": "build-pioneer-package" }, diff --git a/src/packages/http/package.json b/src/packages/http/package.json index ef5830c0..0f65046e 100644 --- a/src/packages/http/package.json +++ b/src/packages/http/package.json @@ -1,8 +1,18 @@ { "name": "@open-pioneer/http", "version": "2.1.4", + "description": "Provides the HttpService, which can be used to request resources over HTTP.", "license": "Apache-2.0", "main": "index.ts", + "repository": { + "type": "git", + "url": "https://github.com/open-pioneer/trails-core-packages", + "directory": "src/packages/http" + }, + "homepage": "https://github.com/open-pioneer", + "keywords": [ + "open-pioneer-trails" + ], "scripts": { "build": "build-pioneer-package" }, diff --git a/src/packages/integration/package.json b/src/packages/integration/package.json index 9eb57691..2967e981 100644 --- a/src/packages/integration/package.json +++ b/src/packages/integration/package.json @@ -1,8 +1,18 @@ { "name": "@open-pioneer/integration", "version": "2.0.5", + "description": "Provides techniques for the communication between an application (web component) and its embedding site.", "license": "Apache-2.0", "main": "index.ts", + "repository": { + "type": "git", + "url": "https://github.com/open-pioneer/trails-core-packages", + "directory": "src/packages/integration" + }, + "homepage": "https://github.com/open-pioneer", + "keywords": [ + "open-pioneer-trails" + ], "scripts": { "build": "build-pioneer-package" }, diff --git a/src/packages/local-storage/package.json b/src/packages/local-storage/package.json index 79d3a0b4..69867086 100644 --- a/src/packages/local-storage/package.json +++ b/src/packages/local-storage/package.json @@ -1,8 +1,18 @@ { "name": "@open-pioneer/local-storage", "version": "0.3.1", + "description": "Provides access to the browser's local storage.", "license": "Apache-2.0", "main": "index.ts", + "repository": { + "type": "git", + "url": "https://github.com/open-pioneer/trails-core-packages", + "directory": "src/packages/local-storage" + }, + "homepage": "https://github.com/open-pioneer", + "keywords": [ + "open-pioneer-trails" + ], "scripts": { "build": "build-pioneer-package" }, diff --git a/src/packages/notifier/package.json b/src/packages/notifier/package.json index 7e7aa795..0a4ee4a3 100644 --- a/src/packages/notifier/package.json +++ b/src/packages/notifier/package.json @@ -1,9 +1,18 @@ { "name": "@open-pioneer/notifier", - "description": "Provides support for application-wide notifications", + "description": "Provides support for application-wide notifications.", "version": "0.3.1", "license": "Apache-2.0", "main": "index.ts", + "repository": { + "type": "git", + "url": "https://github.com/open-pioneer/trails-core-packages", + "directory": "src/packages/notifier" + }, + "homepage": "https://github.com/open-pioneer", + "keywords": [ + "open-pioneer-trails" + ], "scripts": { "build": "build-pioneer-package" }, diff --git a/src/packages/runtime-react-support/README.md b/src/packages/runtime-react-support/README.md index cea4ee58..e29cb1de 100644 --- a/src/packages/runtime-react-support/README.md +++ b/src/packages/runtime-react-support/README.md @@ -1,6 +1,6 @@ # @open-pioneer/runtime-react-support -An internal module providing support for react integration +An internal module providing support for react integration. ## License diff --git a/src/packages/runtime-react-support/package.json b/src/packages/runtime-react-support/package.json index 74cfbb60..deea1153 100644 --- a/src/packages/runtime-react-support/package.json +++ b/src/packages/runtime-react-support/package.json @@ -1,8 +1,18 @@ { "name": "@open-pioneer/runtime-react-support", "version": "1.0.0", + "description": "An internal module providing support for react integration.", "license": "Apache-2.0", "main": "index.ts", + "repository": { + "type": "git", + "url": "https://github.com/open-pioneer/trails-core-packages", + "directory": "src/packages/runtime-react-support" + }, + "homepage": "https://github.com/open-pioneer", + "keywords": [ + "open-pioneer-trails" + ], "scripts": { "build": "build-pioneer-package" }, diff --git a/src/packages/runtime/README.md b/src/packages/runtime/README.md index c66ca99b..b31f5ea5 100644 --- a/src/packages/runtime/README.md +++ b/src/packages/runtime/README.md @@ -1,6 +1,6 @@ # @open-pioneer/runtime -Implements the runtime environment for open pioneer apps. +Implements the runtime environment for open pioneer trails apps. ## Quick start diff --git a/src/packages/runtime/package.json b/src/packages/runtime/package.json index 41786fd0..9c2013bf 100644 --- a/src/packages/runtime/package.json +++ b/src/packages/runtime/package.json @@ -1,8 +1,18 @@ { "name": "@open-pioneer/runtime", "version": "2.1.2", + "description": "Implements the runtime environment for open pioneer trails apps.", "license": "Apache-2.0", "main": "index.ts", + "repository": { + "type": "git", + "url": "https://github.com/open-pioneer/trails-core-packages", + "directory": "src/packages/runtime" + }, + "homepage": "https://github.com/open-pioneer", + "keywords": [ + "open-pioneer-trails" + ], "scripts": { "build": "build-pioneer-package" }, diff --git a/src/packages/test-utils/README.md b/src/packages/test-utils/README.md index bc4dbd91..57983afb 100644 --- a/src/packages/test-utils/README.md +++ b/src/packages/test-utils/README.md @@ -1,6 +1,6 @@ # @open-pioneer/test-utils -This package contains test utilities that make it easier to test parts of a pioneer application. +This package contains test utilities that make it easier to test parts of an open pioneer trails application. ## Web Component utilities diff --git a/src/packages/test-utils/package.json b/src/packages/test-utils/package.json index 1acab13c..92c9bd27 100644 --- a/src/packages/test-utils/package.json +++ b/src/packages/test-utils/package.json @@ -1,7 +1,17 @@ { "name": "@open-pioneer/test-utils", "version": "1.1.1", + "description": "Contains test utilities that make it easier to test parts of an open pioneer trails application.", "license": "Apache-2.0", + "repository": { + "type": "git", + "url": "https://github.com/open-pioneer/trails-core-packages", + "directory": "src/packages/test-utils" + }, + "homepage": "https://github.com/open-pioneer", + "keywords": [ + "open-pioneer-trails" + ], "scripts": { "build": "build-pioneer-package" },