@loancrate/json-selector 1.0.0

package/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2022, Loan Crate, Inc.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -0,0 +1,52 @@
+# LoanCrate JSON Selectors
+
+LoanCrate JSON Selectors are based on a subset of [JMESPath](https://jmespath.org/specification.html)
+with a shorthand/extension for selecting an object from an array based on ID.
+Specifically, the subset includes the [Basic Expressions](https://jmespath.org/tutorial.html#basic-expressions)
+([identifiers](https://jmespath.org/specification.html#identifiers),
+[subexpressions](https://jmespath.org/specification.html#subexpressions),
+and [index expressions](https://jmespath.org/specification.html#indexexpressions)).
+To allow for selection by ID, we extend index expressions to accept a
+[raw string literal](https://jmespath.org/specification.html#raw-string-literals)
+(as opposed to a numeric literal), which represents the value of the `id` property
+of the desired object from an array of objects.
+Formally, `x['y']` would be equivalent to `x[?id == 'y'] | [0]` in JMESPath.
+This should be unambiguous relative to the existing grammar and semantics.
+
+## Installation
+
+```sh
+npm add @loancrate/json-selector
+```
+
+## Usage
+
+```ts
+import {
+  accessWithJsonSelector,
+  parseJsonSelector,
+} from "@loancrate/json-selector";
+
+const obj = {
+  foo: {
+    bar: [
+      {
+        id: "x",
+        value: 1,
+      },
+    ],
+  },
+};
+const selector = parseJsonSelector("foo.bar['x'].value");
+const accessor = accessWithJsonSelector(selector, obj);
+console.log(accessor.get()); // 1
+console.log(obj.foo.bar[0].value); // 1
+accessor.set(2);
+console.log(obj.foo.bar[0].value); // 2
+accessor.delete();
+console.log(obj.foo.bar[0].value); // undefined
+```
+
+## License
+
+This library is available under the [ISC license](LICENSE).

package/dist/__generated__/parser.d.ts

@@ -0,0 +1,10 @@
+declare function peg$SyntaxError(message: any, expected: any, found: any, location: any): Error;
+declare class peg$SyntaxError {
+    constructor(message: any, expected: any, found: any, location: any);
+    format(sources: any): string;
+}
+declare namespace peg$SyntaxError {
+    function buildMessage(expected: any, found: any): string;
+}
+declare function peg$parse(input: any, options: any): any;
+export { peg$SyntaxError as SyntaxError, peg$parse as parse };