@port-labs/jq-node-bindings 0.0.1 → 0.0.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-present, Port IO, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,77 @@
+# jq-node-bindings
+
+This is a library for Node.js that provides C bindings to the [jq](https://stedolan.github.io/jq/) library. It allows you to use jq to extract and manipulate data from JSON objects in Node.js.
+
+## Installation
+
+```
+npm install @port-labs/jq-node-bindings
+```
+
+## Requirements
+
+To use this library, you must have `node-gyp` installed on your system. and the following libraries
+
+1. `node-gyp`
+    ```
+    npm install -g node-gyp
+    ```
+
+2.  XCode on Mac, gcc on unix
+    Mac
+    ```
+    xcode-select --install
+    ```
+    
+    Yum
+    ```
+    sudo yum install gcc g++
+    ```
+
+    apt-get
+    ```
+    sudo apt-get gcc g++
+    ```
+
+3. The following C\C++ toolchains autoconf make libtool automake
+    Homebrew
+    ```
+    brew install autoconf make automake libtool
+    ```
+
+    Yum
+    ```
+    sudo apt-get install -y autoconf make libtool automake
+    ```
+
+    apt-get
+    ```
+    sudo apt-get install -y autoconf make libtool automake
+    ```
+
+
+
+## Usage
+
+Here's an example of how to use the library:
+
+```typescript
+import { exec } from 'jq-node-bindings';
+
+const json = { foo: 'bar' };
+const input = '.foo';
+
+const result = exec(json, input);
+
+console.log(result); // outputs "bar"
+```
+
+The exec function takes two arguments: a JSON object and a jq input string. It returns the result of running the jq program on the JSON object. The result can be of any type supported by jq: object, array, string, number, boolean, or null.
+
+## Contributing
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+Please make sure to update tests as appropriate.
+
+## License
+[MIT](https://choosealicense.com/licenses/mit/)

package/index.d.ts

@@ -1,3 +1,3 @@
-declare module 'jq-node-bindings' {
+declare module '@port-labs/jq-node-bindings' {
     export function exec(json: object, input: string): object | Array<any> | string | number | boolean | null;
 }

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@port-labs/jq-node-bindings",
-  "version": "v0.0.1",
+  "version": "v0.0.3",
   "description": "Node.js bindings for JQ",
-  "jq-node-bindings": "0.0.1",
+  "jq-node-bindings": "0.0.3",
   "main": "lib/index.js",
   "scripts": {
     "configure": "node-gyp configure",

package/reports/jest-port-api.xml

@@ -1,23 +1,23 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<testsuites name="jest tests" tests="15" failures="0" errors="0" time="0.356">
-  <testsuite name="jq" errors="0" failures="0" skipped="0" timestamp="2023-02-15T20:09:42" time="0.316" tests="15">
-    <testcase classname="jq should break" name="jq should break" time="0.003">
+<testsuites name="jest tests" tests="15" failures="0" errors="0" time="0.369">
+  <testsuite name="jq" errors="0" failures="0" skipped="0" timestamp="2023-02-16T09:01:38" time="0.328" tests="15">
+    <testcase classname="jq should break" name="jq should break" time="0.004">
     </testcase>
     <testcase classname="jq should break for invalid input" name="jq should break for invalid input" time="0.002">
     </testcase>
-    <testcase classname="jq should break for invalid input" name="jq should break for invalid input" time="0.002">
+    <testcase classname="jq should break for invalid input" name="jq should break for invalid input" time="0.003">
     </testcase>
-    <testcase classname="jq should break for invalid input" name="jq should break for invalid input" time="0.001">
+    <testcase classname="jq should break for invalid input" name="jq should break for invalid input" time="0.002">
     </testcase>
     <testcase classname="jq string should work" name="jq string should work" time="0">
     </testcase>
-    <testcase classname="jq number should work" name="jq number should work" time="0.001">
+    <testcase classname="jq number should work" name="jq number should work" time="0">
     </testcase>
     <testcase classname="jq should return null" name="jq should return null" time="0.002">
     </testcase>
     <testcase classname="jq should return array with object" name="jq should return array with object" time="0">
     </testcase>
-    <testcase classname="jq should return an item of an array" name="jq should return an item of an array" time="0.002">
+    <testcase classname="jq should return an item of an array" name="jq should return an item of an array" time="0.001">
     </testcase>
     <testcase classname="jq should return array with objects" name="jq should return array with objects" time="0">
     </testcase>
@@ -27,7 +27,7 @@
     </testcase>
     <testcase classname="jq should return recursed obj" name="jq should return recursed obj" time="0.001">
     </testcase>
-    <testcase classname="jq should return recursed obj" name="jq should return recursed obj" time="0">
+    <testcase classname="jq should return recursed obj" name="jq should return recursed obj" time="0.001">
     </testcase>
     <testcase classname="jq should return null on invalid json" name="jq should return null on invalid json" time="0">
     </testcase>