@mozilla/nimbus-shared - npm Package Compare versions

Comparing version 0.0.2 to 0.0.3

CHANGELOG.md

 # Changelog
 
+## Version 0.0.3
+
+### Major Changes
+
+- Added a Python package `mozilla-nimbus-shared` published on PyPI
+
 ## Version 0.0.2
 
-### Breaking changes
+### Major Changes
 
@@ -10,3 +16,3 @@ - Schema checks now includes an empty list of errors when schemas match, instead of null
 
-### Changes
+### Minor Changes
 
@@ -13,0 +19,0 @@ - Add CFR schemas

dist/types/normandy.d.ts

@@ -90,3 +90,3 @@ /** A Normandy recipe */
      *
-     * @default ""
+     * @default [{}]
      * @format uri
@@ -93,0 +93,0 @@ */

package.json

 {
   "name": "@mozilla/nimbus-shared",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "license": "MPL-2.0",
@@ -12,4 +12,3 @@ "engines": {
     "lint": "make lint",
-    "test": "make test",
-    "prepublishOnly": "make clean-build"
+    "test": "make test"
   },
@@ -16,0 +15,0 @@ "main": "dist/index.js",

README.md

@@ -1,2 +0,2 @@
-# Nimbus Shared ![CircleCI](https://img.shields.io/circleci/build/github/mozilla/nimbus-shared)
+# Nimbus Shared ![CircleCI](https://img.shields.io/circleci/build/github/mozilla/nimbus-shared) ![npm (scoped)](https://img.shields.io/npm/v/@mozilla/nimbus-shared)
 
@@ -90,6 +90,22 @@ This is a place to define data and schemas used across Project Nimbus.
 
-Native support coming soon. For now, consider using the NPM package and loading the schemas directly
-from the filesystem. After installing this package via `npm`, the schemas will be available at
-`node_modules/@mozilla/nimbus-shared/schemas/<group>/<type>.json`.
+Basic native support is available via the PyPI package `mozilla-nimbus-shared`. The only function is
+exposed is one to validate an object against a named schema.
 
+```python
+from mozilla_nimbus_shared import check_schema
+
+# Throws an error with details of the problems
+check_schema("normandy/ConsoleLogArguments", {})
+
+# Returns True
+check_schema("normandy/ConsoleLogArguments", {"message": "hello, world!"})
+```
+
+### Other
+
+For other applications, consider using the NPM package and loading the schemas directly from the
+filesystem. After installing this package via `npm`, the schemas will be available at
+`node_modules/@mozilla/nimbus-shared/schemas/<group>/<type>.json`. Please leave an issue on this
+repository if you have a use case not covered by the above.
+
 ---
@@ -96,0 +112,0 @@

schemas/normandy/NormandyRecipe.json

@@ -248,3 +248,5 @@ {
           "description": "URL of a document describing the experiment",
-          "default": "",
+          "default": [
+            {}
+          ],
           "format": "uri"
@@ -251,0 +253,0 @@ },

schemas/normandy/PreferenceExperimentArguments.json

@@ -72,3 +72,5 @@ {
           "description": "URL of a document describing the experiment",
-          "default": "",
+          "default": [
+            {}
+          ],
           "format": "uri"
@@ -75,0 +77,0 @@ },

types/normandy.ts

@@ -127,3 +127,3 @@ /** A Normandy recipe */
    *
-   * @default ""
+   * @default [{}]
    * @format uri
@@ -130,0 +130,0 @@ */

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

505601

increased by0.18%

Lines of code

9249

increased by0.13%

Number of lines in readme file

132

increased by13.79%

No dependency changes