pacc 3.7.0 → 3.8.0

package/README.md

@@ -36,10 +36,29 @@ const result = getAttribute({ a: [0,{ b: 4 }]}, "a[1].b");
     *   [Parameters](#parameters-2)
 *   [getAttributeAndOperator](#getattributeandoperator)
     *   [Parameters](#parameters-3)
-*   [filter](#filter)
-    *   [Parameters](#parameters-4)
 *   [AttributeDefinition](#attributedefinition)
     *   [Properties](#properties)
+*   [default\_attribute](#default_attribute)
+*   [name\_attribute](#name_attribute)
+*   [description\_attribute](#description_attribute)
+*   [type\_attribute](#type_attribute)
+*   [state\_attribute](#state_attribute)
+*   [boolean\_attribute](#boolean_attribute)
+*   [boolean\_read\_only\_attribute](#boolean_read_only_attribute)
+*   [uuid\_attribute](#uuid_attribute)
+*   [empty\_attribute](#empty_attribute)
+*   [secret\_attribute](#secret_attribute)
+*   [count\_attribute](#count_attribute)
+*   [size\_attribute](#size_attribute)
+*   [url\_attribute](#url_attribute)
+*   [id\_attribute](#id_attribute)
+*   [body\_attribute](#body_attribute)
+*   [title\_attribute](#title_attribute)
+*   [priority\_attribute](#priority_attribute)
+*   [active\_attribute](#active_attribute)
+*   [language\_attribute](#language_attribute)
+*   [filter](#filter)
+    *   [Parameters](#parameters-4)
 *   [prepareAttributesDefinitions](#prepareattributesdefinitions)
     *   [Parameters](#parameters-5)
 *   [mergeAttributeDefinitions](#mergeattributedefinitions)
@@ -125,23 +144,12 @@ The name may be a property path like 'a.b.c <='.
 
 Returns **\[any, [Token](#token)]** value associated with the given property name
 
-## filter
-
-Generate filter function.
-
-### Parameters
-
-*   `filterBy` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**&#x20;
-
-Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)**&#x20;
-
 ## AttributeDefinition
 
 Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
 
 ### Properties
 
-*   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
 *   `type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
 *   `isKey` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**&#x20;
 *   `writable` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**&#x20;
@@ -155,6 +163,105 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
 *   `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(s) used to provide the value
 
+## default\_attribute
+
+Common attribute properties.
+
+Type: [AttributeDefinition](#attributedefinition)
+
+## name\_attribute
+
+Type: [AttributeDefinition](#attributedefinition)
+
+## description\_attribute
+
+The description of the object content.
+
+Type: [AttributeDefinition](#attributedefinition)
+
+## type\_attribute
+
+Type: [AttributeDefinition](#attributedefinition)
+
+## state\_attribute
+
+Type: [AttributeDefinition](#attributedefinition)
+
+## boolean\_attribute
+
+Type: [AttributeDefinition](#attributedefinition)
+
+## boolean\_read\_only\_attribute
+
+Type: [AttributeDefinition](#attributedefinition)
+
+## uuid\_attribute
+
+Type: [AttributeDefinition](#attributedefinition)
+
+## empty\_attribute
+
+Type: [AttributeDefinition](#attributedefinition)
+
+## secret\_attribute
+
+Type: [AttributeDefinition](#attributedefinition)
+
+## count\_attribute
+
+Type: [AttributeDefinition](#attributedefinition)
+
+## size\_attribute
+
+Type: [AttributeDefinition](#attributedefinition)
+
+## url\_attribute
+
+Type: [AttributeDefinition](#attributedefinition)
+
+## id\_attribute
+
+Unique id within the provider.
+
+Type: [AttributeDefinition](#attributedefinition)
+
+## body\_attribute
+
+The body text of the pull request.
+
+Type: [AttributeDefinition](#attributedefinition)
+
+## title\_attribute
+
+The one line description of the pull request.
+
+Type: [AttributeDefinition](#attributedefinition)
+
+## priority\_attribute
+
+In case there are several providers able to support a given source which one sould be used ?
+this defines the order.
+
+Type: [AttributeDefinition](#attributedefinition)
+
+## active\_attribute
+
+Type: [AttributeDefinition](#attributedefinition)
+
+## language\_attribute
+
+Type: [AttributeDefinition](#attributedefinition)
+
+## filter
+
+Generate filter function.
+
+### Parameters
+
+*   `filterBy` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?**&#x20;
+
+Returns **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)**&#x20;
+
 ## prepareAttributesDefinitions
 
 Create attributes from its definition.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pacc",
-  "version": "3.7.0",
+  "version": "3.8.0",
   "publishConfig": {
     "access": "public",
     "provenance": true

package/src/common-attributes.mjs

@@ -0,0 +1,179 @@
+/**
+ * @typedef {Object} AttributeDefinition
+ *
+ * @property {string} type
+ * @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
+ * @property {string} [description] human readable
+ * @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(s) used to provide the value
+ */
+
+/**
+ * Common attribute properties.
+ * @type {AttributeDefinition}
+ */
+export const default_attribute = {
+  type: "string",
+  writable: false,
+  mandatory: false,
+  private: false,
+  isKey: false,
+  additionalAttributes: []
+};
+
+/**
+ * @type {AttributeDefinition}
+ */
+export const name_attribute = {
+  ...default_attribute,
+  isKey: true
+};
+
+/**
+ * The description of the object content.
+ * @type {AttributeDefinition}
+ */
+export const description_attribute = {
+  ...default_attribute,
+  description: "human readable description",
+  writable: true
+};
+
+/**
+ * @type {AttributeDefinition}
+ */
+export const type_attribute = default_attribute;
+
+/**
+ * @type {AttributeDefinition}
+ */
+export const state_attribute = {
+  ...default_attribute,
+  writable: true
+};
+
+/**
+ * @type {AttributeDefinition}
+ */
+export const boolean_attribute = {
+  ...default_attribute,
+  type: "boolean",
+  writable: true,
+  default: false
+};
+
+/**
+ * @type {AttributeDefinition}
+ */
+export const boolean_read_only_attribute = {
+  ...default_attribute,
+  type: "boolean",
+  default: false
+};
+
+/**
+ * @type {AttributeDefinition}
+ */
+export const uuid_attribute = {
+  ...default_attribute,
+  isKey: true
+};
+
+/**
+ * @type {AttributeDefinition}
+ */
+export const empty_attribute = { ...default_attribute, type: "boolean" };
+
+/**
+ * @type {AttributeDefinition}
+ */
+export const secret_attribute = {
+  ...default_attribute,
+  private: true,
+  writable: true
+};
+
+/**
+ * @type {AttributeDefinition}
+ */
+export const count_attribute = { ...default_attribute, type: "integer" };
+
+/**
+ * @type {AttributeDefinition}
+ */
+export const size_attribute = { ...default_attribute, type: "integer" };
+
+/**
+ * @type {AttributeDefinition}
+ */
+export const url_attribute = {
+  ...default_attribute,
+  type: "url",
+  description: "home of the object"
+};
+
+/**
+ * Unique id within the provider.
+ * @type {AttributeDefinition}
+ */
+export const id_attribute = {
+  ...default_attribute,
+  isKey: true,
+  description: "internal identifier"
+};
+
+/**
+ * The body text of the pull request.
+ * @type {AttributeDefinition}
+ */
+export const body_attribute = {
+  ...default_attribute,
+  writable: true
+};
+
+/**
+ * The one line description of the pull request.
+ * @type {AttributeDefinition}
+ */
+export const title_attribute = {
+  ...default_attribute,
+  description: "human readable title",
+  writable: true
+};
+
+/**
+ * In case there are several providers able to support a given source which one sould be used ?
+ * this defines the order.
+ * @type {AttributeDefinition}
+ */
+export const priority_attribute = {
+  ...default_attribute,
+  type: "number",
+  default: 0,
+  writable: true
+};
+
+/**
+ * @type {AttributeDefinition}
+ */
+export const active_attribute = {
+  ...default_attribute,
+  type: "boolean",
+  default: true,
+  writable: true
+};
+
+/**
+ * @type {AttributeDefinition}
+ */
+export const language_attribute = {
+  ...default_attribute,
+  description: "human spoken language"
+};

package/src/module.mjs

@@ -1,6 +1,7 @@
 export * from "./tokens.mjs";
 export * from "./filter.mjs";
 export * from "./multiple.mjs";
+export * from "./common-attributes.mjs";
 export {
   setAttribute,
   getAttribute,

package/src/multiple.mjs

@@ -1,22 +1,5 @@
 import { setAttribute, getAttribute } from "./attribute.mjs";
 
-/**
- * @typedef {Object} AttributeDefinition
- *
- * @property {string} type
- * @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
- * @property {string} [description] human readable
- * @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(s) used to provide the value
- */
-
 const types = {
   base: { name: "base" },
   string: { name: "string" },

package/types/common-attributes.d.mts

@@ -0,0 +1,137 @@
+/**
+ * @typedef {Object} AttributeDefinition
+ *
+ * @property {string} type
+ * @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
+ * @property {string} [description] human readable
+ * @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(s) used to provide the value
+ */
+/**
+ * Common attribute properties.
+ * @type {AttributeDefinition}
+ */
+export const default_attribute: AttributeDefinition;
+/**
+ * @type {AttributeDefinition}
+ */
+export const name_attribute: AttributeDefinition;
+/**
+ * The description of the object content.
+ * @type {AttributeDefinition}
+ */
+export const description_attribute: AttributeDefinition;
+/**
+ * @type {AttributeDefinition}
+ */
+export const type_attribute: AttributeDefinition;
+/**
+ * @type {AttributeDefinition}
+ */
+export const state_attribute: AttributeDefinition;
+/**
+ * @type {AttributeDefinition}
+ */
+export const boolean_attribute: AttributeDefinition;
+/**
+ * @type {AttributeDefinition}
+ */
+export const boolean_read_only_attribute: AttributeDefinition;
+/**
+ * @type {AttributeDefinition}
+ */
+export const uuid_attribute: AttributeDefinition;
+/**
+ * @type {AttributeDefinition}
+ */
+export const empty_attribute: AttributeDefinition;
+/**
+ * @type {AttributeDefinition}
+ */
+export const secret_attribute: AttributeDefinition;
+/**
+ * @type {AttributeDefinition}
+ */
+export const count_attribute: AttributeDefinition;
+/**
+ * @type {AttributeDefinition}
+ */
+export const size_attribute: AttributeDefinition;
+/**
+ * @type {AttributeDefinition}
+ */
+export const url_attribute: AttributeDefinition;
+/**
+ * Unique id within the provider.
+ * @type {AttributeDefinition}
+ */
+export const id_attribute: AttributeDefinition;
+/**
+ * The body text of the pull request.
+ * @type {AttributeDefinition}
+ */
+export const body_attribute: AttributeDefinition;
+/**
+ * The one line description of the pull request.
+ * @type {AttributeDefinition}
+ */
+export const title_attribute: AttributeDefinition;
+/**
+ * In case there are several providers able to support a given source which one sould be used ?
+ * this defines the order.
+ * @type {AttributeDefinition}
+ */
+export const priority_attribute: AttributeDefinition;
+/**
+ * @type {AttributeDefinition}
+ */
+export const active_attribute: AttributeDefinition;
+/**
+ * @type {AttributeDefinition}
+ */
+export const language_attribute: AttributeDefinition;
+export type AttributeDefinition = {
+    type: string;
+    isKey: boolean;
+    writable: boolean;
+    mandatory: boolean;
+    /**
+     * should the value be shown
+     */
+    private?: boolean;
+    /**
+     * name of an attribute we depend on
+     */
+    depends?: string;
+    /**
+     * extra attributes that are present in case our attribute is set
+     */
+    additionalAttributes: string[];
+    /**
+     * human readable
+     */
+    description?: string;
+    /**
+     * the default value
+     */
+    default?: any;
+    /**
+     * set the value
+     */
+    set?: Function;
+    /**
+     * get the value can be used to calculate default values
+     */
+    get?: Function;
+    /**
+     * environment variable(s) used to provide the value
+     */
+    env?: string[] | string;
+};

package/types/module.d.mts

@@ -1,4 +1,5 @@
 export * from "./tokens.mjs";
 export * from "./filter.mjs";
 export * from "./multiple.mjs";
+export * from "./common-attributes.mjs";
 export { setAttribute, getAttribute, getAttributeAndOperator } from "./attribute.mjs";

package/types/multiple.d.mts

@@ -27,41 +27,3 @@ export function setAttributes(object: any, source: any, definitions: any, cb: Fu
  * @return {Object} values
  */
 export function getAttributes(object: any, definitions: any): any;
-export type AttributeDefinition = {
-    type: string;
-    isKey: boolean;
-    writable: boolean;
-    mandatory: boolean;
-    /**
-     * should the value be shown
-     */
-    private?: boolean;
-    /**
-     * name of an attribute we depend on
-     */
-    depends?: string;
-    /**
-     * extra attributes that are present in case our attribute is set
-     */
-    additionalAttributes: string[];
-    /**
-     * human readable
-     */
-    description?: string;
-    /**
-     * the default value
-     */
-    default?: any;
-    /**
-     * set the value
-     */
-    set?: Function;
-    /**
-     * get the value can be used to calculate default values
-     */
-    get?: Function;
-    /**
-     * environment variable(s) used to provide the value
-     */
-    env?: string[] | string;
-};