pacc 6.1.0 → 6.2.0

package/README.md

@@ -63,7 +63,6 @@ const result = getAttribute({ a: [0,{ b: 4 }]}, "a[1].b");
 *   [private\_key\_attribute](#private_key_attribute)
 *   [public\_key\_attribute](#public_key_attribute)
 *   [number\_attribute](#number_attribute)
-*   [number\_attribute](#number_attribute-1)
 *   [number\_attribute\_writable](#number_attribute_writable)
 *   [integer\_attribute](#integer_attribute)
 *   [integer\_attribute](#integer_attribute-1)
@@ -78,6 +77,8 @@ const result = getAttribute({ a: [0,{ b: 4 }]}, "a[1].b");
 *   [id\_attribute](#id_attribute)
 *   [title\_attribute\_writable](#title_attribute_writable)
 *   [priority\_attribute](#priority_attribute)
+*   [duration\_attribute](#duration_attribute)
+*   [duration\_ms\_attribute](#duration_ms_attribute)
 *   [timeout\_attribute](#timeout_attribute)
 *   [language\_attribute](#language_attribute)
 *   [environmentValues](#environmentvalues)
@@ -101,11 +102,13 @@ const result = getAttribute({ a: [0,{ b: 4 }]}, "a[1].b");
     *   [Parameters](#parameters-11)
 *   [getAttributeAndOperator](#getattributeandoperator)
     *   [Parameters](#parameters-12)
+*   [parseTime](#parsetime)
+    *   [Parameters](#parameters-13)
 *   [lookup](#lookup)
 *   [Token](#token)
     *   [Properties](#properties-1)
 *   [createToken](#createtoken)
-    *   [Parameters](#parameters-13)
+    *   [Parameters](#parameters-14)
 *   [PLUS](#plus)
 *   [MINUS](#minus)
 *   [STAR](#star)
@@ -317,10 +320,6 @@ Type: [AttributeDefinition](#attributedefinition)
 
 Type: [AttributeDefinition](#attributedefinition)
 
-## number\_attribute
-
-Type: [AttributeDefinition](#attributedefinition)
-
 ## number\_attribute\_writable
 
 Type: [AttributeDefinition](#attributedefinition)
@@ -384,6 +383,14 @@ this defines the order.
 
 Type: [AttributeDefinition](#attributedefinition)
 
+## duration\_attribute
+
+Type: [AttributeDefinition](#attributedefinition)
+
+## duration\_ms\_attribute
+
+Type: [AttributeDefinition](#attributedefinition)
+
 ## timeout\_attribute
 
 Type: [AttributeDefinition](#attributedefinition)
@@ -511,6 +518,14 @@ The name may be a property path like 'a.b.c <='.
 
 Returns **\[any, [Token](#token)]** value associated with the given property name
 
+## parseTime
+
+### 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)**&#x20;
+
 ## lookup
 
 Token lookup

package/package.json

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

package/src/module.mjs

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

package/src/time.mjs

@@ -1,18 +1,31 @@
 const units = {
   ms: 0.001,
+  millisecond: 0.001,
+  milliseconds: 0.001,
   s: 1,
+  second: 1,
+  seconds: 1,
   m: 60,
+  min: 60,
+  minute: 60,
+  minutes: 60,
   h: 3600,
+  hour: 3600,
+  hours: 3600,
   d: 86400,
-  w: 604800
+  day: 86400,
+  days: 86400,
+  w: 604800,
+  week: 604800,
+  weeks: 604800
 };
 
 /**
- * 
+ * Convert duration formatted string into number of seconds.
  * @param {number|string} value 
- * @returns {number}
+ * @returns {number} seconds
  */
-export function parseTime(value) {
+export function parseDuration(value) {
   if (typeof value === "string") {
     let seconds = 0;
 
@@ -31,3 +44,29 @@ export function parseTime(value) {
 
   return value;
 }
+
+const durations = [
+  [604800, "w"],
+  [86400, "d"],
+  [3600, "h"],
+  [60, "m"],
+  [1, "s"]
+];
+
+/**
+ * 
+ * @param {number} seconds 
+ * @returns {string} formatted duration
+ */
+export function formatDuration(seconds) {
+  const out = [];
+  for (const d of durations) {
+    const n = Math.floor(seconds / Number(d[0]));
+    if (n > 0) {
+      out.push(`${n}${d[1]}`);
+      seconds -= n * Number(d[0]);
+    }
+  }
+
+  return out.join(" ");
+}

package/src/types.mjs

@@ -1,5 +1,5 @@
 import { attributeIterator } from "./attributes.mjs";
-import { parseTime } from "./time.mjs";
+import { parseDuration } from "./time.mjs";
 
 /**
  * @typedef {Object} Type
@@ -40,12 +40,12 @@ export const types = {
   duration: {
     name: "duration",
     primitive: true,
-    prepareValue: value => parseTime(value)
+    prepareValue: value => parseDuration(value)
   },
   duration_ms: {
     name: "duration_ms",
     primitive: true,
-    prepareValue: value => parseTime(value) * 1000
+    prepareValue: value => parseDuration(value) * 1000
   },
   url: {
     name: "url",

package/types/module.d.mts

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

package/types/time.d.mts

@@ -1,6 +1,12 @@
 /**
- *
+ * Convert duration formatted string into number of seconds.
  * @param {number|string} value
- * @returns {number}
+ * @returns {number} seconds
+ */
+export function parseDuration(value: number | string): number;
+/**
+ *
+ * @param {number} seconds
+ * @returns {string} formatted duration
  */
-export function parseTime(value: number | string): number;
+export function formatDuration(seconds: number): string;