pacc 3.0.0 → 3.1.1

package/README.md

@@ -1,5 +1,6 @@
 [![npm](https://img.shields.io/npm/v/pacc.svg)](https://www.npmjs.com/package/pacc)
 [![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
+[![Typed with TypeScript](https://flat.badgen.net/badge/icon/Typed?icon=typescript\&label\&labelColor=blue\&color=555555)](https://typescriptlang.org)
 [![bundlejs](https://deno.bundlejs.com/?q=pacc\&badge=detailed)](https://bundlejs.com/?q=pacc)
 [![downloads](http://img.shields.io/npm/dm/pacc.svg?style=flat-square)](https://npmjs.org/package/pacc)
 [![GitHub Issues](https://img.shields.io/github/issues/arlac77/pacc.svg?style=flat-square)](https://github.com/arlac77/pacc/issues)
@@ -34,8 +35,12 @@ const result = getAttribute({ a: [0,{ b: 4 }]}, "a[1].b");
     *   [Parameters](#parameters-1)
 *   [getAttributeAndOperator](#getattributeandoperator)
     *   [Parameters](#parameters-2)
-*   [tokens](#tokens)
+*   [Token](#token)
+    *   [Properties](#properties-1)
+*   [createToken](#createtoken)
     *   [Parameters](#parameters-3)
+*   [tokens](#tokens)
+    *   [Parameters](#parameters-4)
 
 ## AttributeDefinition
 
@@ -86,9 +91,24 @@ The name may be a property path like 'a.b.c <='.
 
 *   `object` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**&#x20;
 *   `expression` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
-*   `getters`   (optional, default `{}`)
 
-Returns **\[any, [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)]** value associated with the given property name
+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
+
+*   `str` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**&#x20;
+
+Returns **[Token](#token)**&#x20;
 
 ## tokens
 

package/package.json

@@ -1,11 +1,16 @@
 {
   "name": "pacc",
-  "version": "3.0.0",
+  "version": "3.1.1",
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
+  "types": "./types/attribute.d.mts",
   "exports": {
-    ".": "./src/attribute.mjs"
+    ".": {
+      "types": "./types/attribute.d.mts",
+      "default": "./src/attribute.mjs"
+    }
   },
   "description": "property path utils",
   "contributors": [
@@ -16,24 +21,30 @@
   ],
   "license": "BSD-2-Clause",
   "scripts": {
+    "prepare": "tsc --allowJs --declaration --emitDeclarationOnly --declarationDir types -t esnext -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs",
     "test": "npm run test:browser-ava && npm run test:ava",
     "test:browser-ava": "browser-ava --headless --no-keep-open tests/*-ava.mjs tests/*-ava-browser.mjs",
     "test:ava": "ava --timeout 4m tests/*-ava.mjs tests/*-ava-node.mjs",
     "cover": "c8 -x 'tests/**/*' --temp-directory build/tmp ava --timeout 4m tests/*-ava.mjs tests/*-ava-node.mjs && c8 report -r lcov -o build/coverage --temp-directory build/tmp",
     "docs": "documentation readme --section=API ./src/**/*.mjs",
-    "lint": "npm run lint:docs",
-    "lint:docs": "documentation lint ./src/**/*.mjs"
+    "lint": "npm run lint:docs && npm run lint:tsc",
+    "lint:docs": "documentation lint ./src/**/*.mjs",
+    "lint:tsc": "tsc --allowJs --checkJs --noEmit -t esnext -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs"
   },
   "devDependencies": {
     "ava": "^6.1.1",
-    "browser-ava": "^2.1.9",
+    "browser-ava": "^2.2.0",
     "c8": "^9.1.0",
     "documentation": "^14.0.3",
-    "semantic-release": "^23.0.0"
+    "semantic-release": "^23.0.2",
+    "typescript": "^5.3.3"
+  },
+  "engines": {
+    "node": ">=20.11.0"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/arlac77/pacc"
+    "url": "git+https://github.com/arlac77/pacc.git"
   },
   "bugs": {
     "url": "https://github.com/arlac77/pacc/issues"
@@ -43,7 +54,9 @@
     "inheritFrom": [
       "arlac77/template-arlac77-github",
       "arlac77/template-browser-ava",
-      "arlac77/template-esm-only"
+      "arlac77/template-javascript-component",
+      "arlac77/template-node-component",
+      "arlac77/template-typescript"
     ]
   }
 }

package/src/attribute.mjs

@@ -13,6 +13,11 @@
  * @property {string[]|string} [env] environment variable use to provide the value
  */
 
+/**
+ * @typedef {Object} Token
+ * @property {string} str
+ */
+
 import {
   tokens,
   EQUAL,
@@ -83,7 +88,7 @@ export function getAttribute(object, expression) {
  * The name may be a property path like 'a.b.c <='.
  * @param {Object} object
  * @param {string} expression
- * @returns {[any,string]} value associated with the given property name
+ * @returns {[any,Token]} value associated with the given property name
  */
 export function getAttributeAndOperator(object, expression) {
   let op = EQUAL;

package/src/tokens.mjs

@@ -1,5 +1,15 @@
 const lookup = {};
 
+/**
+ * @typedef {Object} Token
+ * @property {string} str
+ */
+
+/**
+ * 
+ * @param {string} str 
+ * @returns {Token}
+ */
 function createToken(str) {
   const token = { str };
   lookup[str] = token;
@@ -37,7 +47,7 @@ export const DOUBLE_BAR = createToken("||");
  * Split property path into tokens
  * @generator
  * @param {string} string
- * @yields {string}
+ * @yields {Token}
  */
 export function* tokens(string) {
   let state, buffer, hex;
@@ -221,6 +231,7 @@ export function* tokens(string) {
             state = "number";
             break;
           case "number":
+            // @ts-ignore
             buffer = buffer * 10 + c.charCodeAt(0) - 48;
             break;
           case "string":

package/types/attribute.d.mts

@@ -0,0 +1,61 @@
+/**
+ * Set Object attribute.
+ * The name may be a property path like 'a.b.c'.
+ * @param {Object} object
+ * @param {string} expression
+ * @param {any} value
+ */
+export function setAttribute(object: any, expression: string, value: any): void;
+/**
+ * Deliver attribute value.
+ * The name may be a property path like 'a.b.c' or a[2]
+ * @param {Object} object
+ * @param {string} expression
+ * @returns {any} value associated with the given property name
+ */
+export function getAttribute(object: any, expression: string): any;
+/**
+ * Deliver attribute value and operator.
+ * The name may be a property path like 'a.b.c <='.
+ * @param {Object} object
+ * @param {string} expression
+ * @returns {[any,Token]} value associated with the given property name
+ */
+export function getAttributeAndOperator(object: any, expression: string): [any, Token];
+export * from "./tokens.mjs";
+export type AttributeDefinition = {
+    type: string;
+    writable: 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[];
+    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 use to provide the value
+     */
+    env?: string[] | string;
+};
+export type Token = {
+    str: string;
+};

package/types/tokens.d.mts

@@ -0,0 +1,38 @@
+/**
+ * Split property path into tokens
+ * @generator
+ * @param {string} string
+ * @yields {Token}
+ */
+export function tokens(string: string): Generator<any, void, unknown>;
+export namespace PLUS {
+    let str: string;
+}
+export namespace MINUS { }
+export namespace STAR { }
+export namespace DIVIDE { }
+export namespace NOT { }
+export namespace NOT_EQUAL { }
+export namespace GREATER { }
+export namespace GREATER_EQUAL { }
+export namespace LESS { }
+export namespace LESS_EQUAL { }
+export namespace EQUAL { }
+export namespace OPEN_ROUND { }
+export namespace CLOSE_ROUND { }
+export namespace OPEN_BRACKET { }
+export namespace CLOSE_BRACKET { }
+export namespace OPEN_CURLY { }
+export namespace CLOSE_CURLY { }
+export namespace QUESTION { }
+export namespace COLON { }
+export namespace SEMICOLON { }
+export namespace COMMA { }
+export namespace DOT { }
+export namespace AMPERSAND { }
+export namespace DOUBLE_AMPERSAND { }
+export namespace BAR { }
+export namespace DOUBLE_BAR { }
+export type Token = {
+    str: string;
+};