pacc 6.3.0 → 6.4.0

package/README.md

@@ -32,6 +32,8 @@ const result = getAttribute({ a: [0,{ b: 4 }]}, "a[1].b");
     *   [Parameters](#parameters-1)
 *   [attributeIterator](#attributeiterator)
     *   [Parameters](#parameters-2)
+*   [parseBytes](#parsebytes)
+    *   [Parameters](#parameters-3)
 *   [AttributeDefinition](#attributedefinition)
     *   [Properties](#properties)
 *   [default\_attribute](#default_attribute)
@@ -82,35 +84,37 @@ const result = getAttribute({ a: [0,{ b: 4 }]}, "a[1].b");
 *   [timeout\_attribute](#timeout_attribute)
 *   [language\_attribute](#language_attribute)
 *   [environmentValues](#environmentvalues)
-    *   [Parameters](#parameters-3)
-*   [expand](#expand)
     *   [Parameters](#parameters-4)
-*   [filter](#filter)
+*   [expand](#expand)
     *   [Parameters](#parameters-5)
-*   [setAttributes](#setattributes)
+*   [filter](#filter)
     *   [Parameters](#parameters-6)
-*   [getAttributes](#getattributes)
+*   [setAttributes](#setattributes)
     *   [Parameters](#parameters-7)
-*   [getAttributesJSON](#getattributesjson)
+*   [getAttributes](#getattributes)
     *   [Parameters](#parameters-8)
+*   [getAttributesJSON](#getattributesjson)
+    *   [Parameters](#parameters-9)
 *   [tokens](#tokens)
 *   [tokens](#tokens-1)
-    *   [Parameters](#parameters-9)
-*   [setAttribute](#setattribute)
     *   [Parameters](#parameters-10)
-*   [getAttribute](#getattribute)
+*   [setAttribute](#setattribute)
     *   [Parameters](#parameters-11)
-*   [getAttributeAndOperator](#getattributeandoperator)
+*   [getAttribute](#getattribute)
     *   [Parameters](#parameters-12)
-*   [parseDuration](#parseduration)
+*   [getAttributeAndOperator](#getattributeandoperator)
     *   [Parameters](#parameters-13)
-*   [formatDuration](#formatduration)
+*   [parseDuration](#parseduration)
     *   [Parameters](#parameters-14)
+*   [formatDuration](#formatduration)
+    *   [Parameters](#parameters-15)
+*   [formatDurationISO](#formatdurationiso)
+    *   [Parameters](#parameters-16)
 *   [lookup](#lookup)
 *   [Token](#token)
     *   [Properties](#properties-1)
 *   [createToken](#createtoken)
-    *   [Parameters](#parameters-15)
+    *   [Parameters](#parameters-17)
 *   [PLUS](#plus)
 *   [MINUS](#minus)
 *   [STAR](#star)
@@ -176,6 +180,16 @@ Iterate over all attributes.
 
 Returns **Iterable<\[[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>, [object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)]>**&#x20;
 
+## parseBytes
+
+Convert byte size formatted string into number of bytes.
+
+### Parameters
+
+*   `value` **([number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))**&#x20;
+
+Returns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** number of total bytes
+
 ## AttributeDefinition
 
 Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
@@ -189,6 +203,7 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
 *   `collection` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**&#x20;
 *   `private` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** should the value be shown
 *   `credential` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** any type of credential
+*   `persistent` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** should we be stored
 *   `depends` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** name of an attribute we depend on
 *   `description` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** human readable
 *   `default` **any?** the default value
@@ -524,8 +539,6 @@ Returns **\[any, [Token](#token)]** value associated with the given property nam
 
 Convert duration formatted string into number of seconds.
 
-Convert duration formatted string into number of seconds.
-
 ### Parameters
 
 *   `value` **([number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number) | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))**&#x20;
@@ -540,6 +553,14 @@ Returns **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** formatted duration
 
+## formatDurationISO
+
+### Parameters
+
+*   `seconds` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)**&#x20;
+
+Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** formatted duration
+
 ## lookup
 
 Token lookup

package/package.json

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

package/src/bytes.mjs

@@ -0,0 +1,45 @@
+export function formatBytes(bytes, decimals = 2) {
+  if (bytes === 0) return "0 Bytes";
+  if (bytes === 1) return "1 Byte";
+
+  const k = 1024;
+  const i = Math.floor(Math.log(bytes) / Math.log(k));
+
+  return (
+    parseFloat((bytes / Math.pow(k, i)).toFixed(decimals)) + " " + byteSizes[i]
+  );
+}
+
+const byteSizes = ["Bytes", "KB", "MB", "GB", "TB", "PB", "EB", "ZB", "YB"];
+
+const units = {
+  b: 1,
+  kb: 1024,
+  mb: 1024 * 1024,
+  gb: 1024 * 1024 * 1024
+};
+
+/**
+ * Convert byte size formatted string into number of bytes.
+ * @param {number|string} value
+ * @returns {number} number of total bytes
+ */
+export function parseBytes(value) {
+  if (typeof value === "string") {
+    let bytes = 0;
+
+    for (const match of value.matchAll(/([\d\.\-]+)\s*(\w*)/gi)) {
+      const v = parseFloat(match[1]);
+
+      if (match[2]) {
+        bytes += v * units[match[2]];
+      } else {
+        bytes += v;
+      }
+    }
+
+    return bytes;
+  }
+
+  return value;
+}

package/src/common-attributes.mjs

@@ -10,6 +10,7 @@ import { types } from "./types.mjs";
  * @property {boolean} collection
  * @property {boolean} [private] should the value be shown
  * @property {boolean} [credential] any type of credential
+ * @property {boolean} [persistent] should we be stored
  * @property {string} [depends] name of an attribute we depend on
  * @property {string} [description] human readable
  * @property {any} [default] the default value
@@ -31,6 +32,7 @@ export const default_attribute = {
   writable: false,
   mandatory: false,
   collection: false,
+  persistent: false,
   private: false,
   credential: false,
   isKey: false
@@ -271,6 +273,8 @@ export { integer_attribute_writable as count_attribute_writable };
  */
 export { integer_attribute as size_attribute };
 
+export const bytes_size_attribute = { ...default_attribute, type: types.byte_size };
+
 /**
  * @type {AttributeDefinition}
  */

package/src/module.mjs

@@ -1,5 +1,6 @@
 export * from "./types.mjs";
 export * from "./time.mjs";
+export * from "./bytes.mjs";
 export * from "./attributes.mjs";
 export * from "./tokens.mjs";
 export * from "./filter.mjs";

package/src/types.mjs

@@ -1,5 +1,6 @@
 import { attributeIterator } from "./attributes.mjs";
 import { parseDuration } from "./time.mjs";
+import { parseBytes } from "./bytes.mjs";
 
 /**
  * @typedef {Object} Type
@@ -47,6 +48,11 @@ export const types = {
     primitive: true,
     prepareValue: value => parseDuration(value) * 1000
   },
+  byte_size: {
+    name: "byte_size",
+    primitive: true,
+    prepareValue: parseBytes
+  },
   url: {
     name: "url",
     prepareValue: emptyStringIsUndefined,

package/types/bytes.d.mts

@@ -0,0 +1,7 @@
+export function formatBytes(bytes: any, decimals?: number): string;
+/**
+ * Convert byte size formatted string into number of bytes.
+ * @param {number|string} value
+ * @returns {number} number of total bytes
+ */
+export function parseBytes(value: number | string): number;

package/types/common-attributes.d.mts

@@ -8,6 +8,7 @@
  * @property {boolean} collection
  * @property {boolean} [private] should the value be shown
  * @property {boolean} [credential] any type of credential
+ * @property {boolean} [persistent] should we be stored
  * @property {string} [depends] name of an attribute we depend on
  * @property {string} [description] human readable
  * @property {any} [default] the default value
@@ -37,6 +38,7 @@ export namespace string_collection_attribute {
     let _private: boolean;
     export { _private as private };
     export let credential: boolean;
+    export let persistent: boolean;
     export let depends: string;
     export let description: string;
     let _default: any;
@@ -130,6 +132,16 @@ export const integer_attribute: AttributeDefinition;
  * @type {AttributeDefinition}
  */
 export const integer_attribute_writable: AttributeDefinition;
+export namespace bytes_size_attribute {
+    let type_1: {
+        name: string;
+        primitive: boolean;
+        prepareValue: typeof import("./bytes.mjs").parseBytes;
+    };
+    export { type_1 as type };
+    let collection_1: boolean;
+    export { collection_1 as collection };
+}
 /**
  * @type {AttributeDefinition}
  */
@@ -196,6 +208,10 @@ export type AttributeDefinition = {
      * any type of credential
      */
     credential?: boolean;
+    /**
+     * should we be stored
+     */
+    persistent?: boolean;
     /**
      * name of an attribute we depend on
      */

package/types/module.d.mts

@@ -1,5 +1,6 @@
 export * from "./types.mjs";
 export * from "./time.mjs";
+export * from "./bytes.mjs";
 export * from "./attributes.mjs";
 export * from "./tokens.mjs";
 export * from "./filter.mjs";

package/types/types.d.mts

@@ -37,6 +37,11 @@ export const types: {
         primitive: boolean;
         prepareValue: (value: any) => number;
     };
+    byte_size: {
+        name: string;
+        primitive: boolean;
+        prepareValue: typeof parseBytes;
+    };
     url: {
         name: string;
         prepareValue: (value: any) => any;
@@ -52,3 +57,4 @@ export type Type = {
     primitive?: boolean;
     prepareValue?: Function;
 };
+import { parseBytes } from "./bytes.mjs";