@backstage/config - npm Package Compare versions

Comparing version 0.1.10 to 0.1.11

CHANGELOG.md

 # @backstage/config
 
+## 0.1.11
+
+### Patch Changes
+
+- 10d267a1b7: Minor exports cleanup
+- 41c49884d2: Start using the new `@backstage/types` package. Initially, this means using the `Observable` and `Json*` types from there. The types also remain in their old places but deprecated, and will be removed in a future release.
+- 925a967f36: Replace usage of test-utils-core with test-utils
+
 ## 0.1.10
@@ -4,0 +12,0 @@

dist/index.d.ts

@@ -0,1 +1,3 @@
+import { JsonPrimitive as JsonPrimitive$1, JsonObject as JsonObject$1, JsonArray as JsonArray$1, JsonValue as JsonValue$1 } from '@backstage/types';
+
 /**
@@ -5,4 +7,5 @@ * A type representing all allowed JSON primitive values.
  * @public
+ * @deprecated Please use the same type from `@backstage/types` instead
  */
-declare type JsonPrimitive = number | string | boolean | null;
+declare type JsonPrimitive = JsonPrimitive$1;
 /**
@@ -12,6 +15,5 @@ * A type representing all allowed JSON object values.
  * @public
+ * @deprecated Please use the same type from `@backstage/types` instead
  */
-declare type JsonObject = {
-    [key in string]?: JsonValue;
-};
+declare type JsonObject = JsonObject$1;
 /**
@@ -21,5 +23,5 @@ * A type representing all allowed JSON array values.
  * @public
+ * @deprecated Please use the same type from `@backstage/types` instead
  */
-interface JsonArray extends Array<JsonValue> {
-}
+declare type JsonArray = JsonArray$1;
 /**
@@ -29,4 +31,6 @@ * A type representing all allowed JSON values.
  * @public
+ * @deprecated Please use the same type from `@backstage/types` instead
  */
-declare type JsonValue = JsonObject | JsonArray | JsonPrimitive;
+declare type JsonValue = JsonValue$1;
+
 /**
@@ -45,3 +49,3 @@ * A serialized form of configuration data that carries additional context.
      */
-    data: JsonObject;
+    data: JsonObject$1;
     /**
@@ -81,3 +85,3 @@ * A list of keys that where filtered out from the configuration when it was loaded.
      */
-    get<T = JsonValue>(key?: string): T;
+    get<T = JsonValue$1>(key?: string): T;
     /**
@@ -91,3 +95,3 @@ * Read out all configuration data for the given key.
      */
-    getOptional<T = JsonValue>(key?: string): T | undefined;
+    getOptional<T = JsonValue$1>(key?: string): T | undefined;
     /**
@@ -165,19 +169,38 @@ * Same as `getOptionalConfig`, but will throw an error if there's no value for the given key.
     private notifiedFilteredKeys;
+    /**
+     * Instantiates the config reader from a list of application config objects.
+     */
     static fromConfigs(configs: AppConfig[]): ConfigReader;
-    constructor(data: JsonObject | undefined, context?: string, fallback?: ConfigReader | undefined, prefix?: string);
+    constructor(data: JsonObject$1 | undefined, context?: string, fallback?: ConfigReader | undefined, prefix?: string);
+    /** {@inheritdoc Config.has} */
     has(key: string): boolean;
+    /** {@inheritdoc Config.keys} */
     keys(): string[];
-    get<T = JsonValue>(key?: string): T;
-    getOptional<T = JsonValue>(key?: string): T | undefined;
+    /** {@inheritdoc Config.get} */
+    get<T = JsonValue$1>(key?: string): T;
+    /** {@inheritdoc Config.getOptional} */
+    getOptional<T = JsonValue$1>(key?: string): T | undefined;
+    /** {@inheritdoc Config.getConfig} */
     getConfig(key: string): ConfigReader;
+    /** {@inheritdoc Config.getOptionalConfig} */
     getOptionalConfig(key: string): ConfigReader | undefined;
+    /** {@inheritdoc Config.getConfigArray} */
     getConfigArray(key: string): ConfigReader[];
+    /** {@inheritdoc Config.getOptionalConfigArray} */
     getOptionalConfigArray(key: string): ConfigReader[] | undefined;
+    /** {@inheritdoc Config.getNumber} */
     getNumber(key: string): number;
+    /** {@inheritdoc Config.getOptionalNumber} */
     getOptionalNumber(key: string): number | undefined;
+    /** {@inheritdoc Config.getBoolean} */
     getBoolean(key: string): boolean;
+    /** {@inheritdoc Config.getOptionalBoolean} */
     getOptionalBoolean(key: string): boolean | undefined;
+    /** {@inheritdoc Config.getString} */
     getString(key: string): string;
+    /** {@inheritdoc Config.getOptionalString} */
     getOptionalString(key: string): string | undefined;
+    /** {@inheritdoc Config.getStringArray} */
     getStringArray(key: string): string[];
+    /** {@inheritdoc Config.getOptionalStringArray} */
     getOptionalStringArray(key: string): string[] | undefined;
@@ -184,0 +207,0 @@ private fullKey;

package.json

 {
   "name": "@backstage/config",
   "description": "Config API used by Backstage core, backend, and CLI",
-  "version": "0.1.10",
+  "version": "0.1.11",
   "private": false,
@@ -33,6 +33,7 @@ "publishConfig": {
   "dependencies": {
+    "@backstage/types": "^0.1.1",
     "lodash": "^4.17.21"
   },
   "devDependencies": {
-    "@backstage/test-utils-core": "^0.1.2",
+    "@backstage/test-utils": "^0.1.20",
     "@types/jest": "^26.0.7",
@@ -44,4 +45,4 @@ "@types/node": "^14.14.32"
   ],
-  "gitHead": "2fd2dbc5d2fad9da5f623126920958970aea469b",
+  "gitHead": "3db0cb3683d3000666802af90a465ba4fb0d1e8d",
   "module": "dist/index.esm.js"
 }

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

76673

increased by4.46%

Lines of code

710

increased by3.05%

Worsened metrics

Dependency count

2

increased by100%

Dependency changes

• + Added@backstage/types@^0.1.1

• + Added@backstage/types@0.1.3(transitive)