pacc 3.1.1 → 3.1.3

package/README.md

@@ -29,14 +29,16 @@ const result = getAttribute({ a: [0,{ b: 4 }]}, "a[1].b");
 
 *   [AttributeDefinition](#attributedefinition)
     *   [Properties](#properties)
+*   [Token](#token)
+    *   [Properties](#properties-1)
+*   [Token](#token-1)
+    *   [Properties](#properties-2)
 *   [setAttribute](#setattribute)
     *   [Parameters](#parameters)
 *   [getAttribute](#getattribute)
     *   [Parameters](#parameters-1)
 *   [getAttributeAndOperator](#getattributeandoperator)
     *   [Parameters](#parameters-2)
-*   [Token](#token)
-    *   [Properties](#properties-1)
 *   [createToken](#createtoken)
     *   [Parameters](#parameters-3)
 *   [tokens](#tokens)
@@ -49,7 +51,9 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
 ### Properties
 
 *   `type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+*   `isKey` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
 *   `writable` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
+*   `mandatory` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
 *   `private` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** should the value be shown
 *   `depends` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** name of an attribute we depend on
 *   `additionalAttributes` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** extra attributes that are present in case our attribute is set
@@ -57,7 +61,23 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
 *   `default` **any?** the default value
 *   `set` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** set the value
 *   `get` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** get the value can be used to calculate default values
-*   `env` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))?** environment variable use to provide the value
+*   `env` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))?** environment variable(s) used to provide the value
+
+## Token
+
+Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
+
+### Properties
+
+*   `str` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+
+## Token
+
+Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
+
+### Properties
+
+*   `str` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
 
 ## setAttribute
 
@@ -94,14 +114,6 @@ The name may be a property path like 'a.b.c <='.
 
 Returns **\[any, [Token](#token)]** value associated with the given property name
 
-## Token
-
-Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
-
-### Properties
-
-*   `str` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
-
 ## createToken
 
 ### Parameters

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pacc",
-  "version": "3.1.1",
+  "version": "3.1.3",
   "publishConfig": {
     "access": "public",
     "provenance": true
@@ -8,8 +8,8 @@
   "types": "./types/attribute.d.mts",
   "exports": {
     ".": {
-      "types": "./types/attribute.d.mts",
-      "default": "./src/attribute.mjs"
+      "default": "./src/attribute.mjs",
+      "types": "./types/attribute.d.mts"
     }
   },
   "description": "property path utils",
@@ -40,7 +40,7 @@
     "typescript": "^5.3.3"
   },
   "engines": {
-    "node": ">=20.11.0"
+    "node": ">=20.11.1"
   },
   "repository": {
     "type": "git",

package/src/attribute.mjs

@@ -2,7 +2,10 @@
  * @typedef {Object} AttributeDefinition
  *
  * @property {string} type
+ * @property {string} description
+ * @property {boolean} isKey
  * @property {boolean} writable
+ * @property {boolean} mandatory
  * @property {boolean} [private] should the value be shown
  * @property {string} [depends] name of an attribute we depend on
  * @property {string[]} additionalAttributes extra attributes that are present in case our attribute is set
@@ -10,7 +13,7 @@
  * @property {any} [default] the default value
  * @property {Function} [set] set the value
  * @property {Function} [get] get the value can be used to calculate default values
- * @property {string[]|string} [env] environment variable use to provide the value
+ * @property {string[]|string} [env] environment variable(s) used to provide the value
  */
 
 /**

package/types/attribute.d.mts

@@ -25,7 +25,10 @@ export function getAttributeAndOperator(object: any, expression: string): [any,
 export * from "./tokens.mjs";
 export type AttributeDefinition = {
     type: string;
+    description: string;
+    isKey: boolean;
     writable: boolean;
+    mandatory: boolean;
     /**
      * should the value be shown
      */
@@ -38,7 +41,6 @@ export type AttributeDefinition = {
      * extra attributes that are present in case our attribute is set
      */
     additionalAttributes: string[];
-    description: string;
     /**
      * the default value
      */
@@ -52,7 +54,7 @@ export type AttributeDefinition = {
      */
     get?: Function;
     /**
-     * environment variable use to provide the value
+     * environment variable(s) used to provide the value
      */
     env?: string[] | string;
 };