@regex-designer/js 0.0.0-stage → 0.2.0

package/README.md

@@ -1,3 +1,249 @@
-# Temporary Holding Version
+# Regular Expression Designer | JavaScript
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A small TypeScript library for composing native JavaScript regular expressions in a readable, reusable way.
+
+## API
+
+- [default](#default)
+- [set / var](#set--var)
+- [tpl](#tpl)
+- [raw](#raw)
+- [start / end / whole](#start--end--whole)
+- [group](#group)
+- [named](#named)
+- [ref](#ref)
+- [opt](#opt)
+- [qty](#qty)
+- [or](#or)
+- [ahead / ahead_pos / ahead_neg](#ahead--ahead_pos--ahead_neg)
+- [behind / behind_pos / behind_neg](#behind--behind_pos--behind_neg)
+
+The JavaScript package exposes a default factory and a `JSRegexDesigner` class. It extends the abstract `RegexDesigner` contract from `@regex-designer/core`. Templates are compiled to a native `RegExp`.
+
+```ts
+import createDesigner from "@regex-designer/js";
+
+const r$ = createDesigner();
+
+r$.set("number", r$.qty([1, Infinity], "[0-9]"));
+r$.set("identifier", r$.qty([1, Infinity], "[a-z0-9-]"));
+
+// (?<version>(?:[0-9]){1,}\.(?:[0-9]){1,}\.(?:[0-9]){1,}(?:-(?<prerelease>(?:[a-z0-9-]){1,}))?)
+const template = r$.named(
+  "version",
+  r$.var("number"), "\\.", r$.var("number"), "\\.", r$.var("number"),
+  r$.opt("-", r$.named("prerelease", r$.var("identifier"))),
+);
+const regex = template("i"); // Compile the template to a native RegExp
+
+regex.test("12.3.4-beta-1"); // true
+regex.exec("12.3.4-beta-1")?.groups; // { version: "12.3.4-beta-1", prerelease: "beta-1" }
+```
+
+### default
+
+```ts
+default function(): JSRegexDesigner
+```
+
+Create a new JavaScript regex designer with its own variable scope.
+
+```ts
+import createDesigner from "@regex-designer/js";
+
+const r$: JSRegexDesigner = createDesigner();
+```
+
+### set / var
+
+```ts
+set(name: string, ...patterns: RegexValue[]): this
+var(name: string): RegexTemplate
+```
+
+Define a reusable lazy variable on a designer, then reference it when composing
+a pattern. The variable resolves when the template is rendered. Rendering an unset variable or circular dependencies between variables throws an error.
+
+```ts
+r$.set("word", r$.or("cat", "dog"));
+r$.var("word"); // cat|dog
+```
+
+### tpl
+
+```ts
+tpl(...patterns: RegexValue[]): RegexTemplate
+```
+
+Concatenate patterns without adding groups or escaping.
+
+```ts
+r$.tpl("A", "B"); // AB
+```
+
+### raw
+
+```ts
+raw(...patterns: string[]): RegexTemplate
+```
+
+Escape literal text for use in a regex pattern.
+
+```ts
+r$.raw("a.b", "*"); // \x61\.b\*
+r$.raw("https://example.com"); // \x68ttps\x3a\/\/example\.com
+```
+
+### start / end / whole
+
+```ts
+start(...patterns: RegexValue[]): RegexTemplate
+end(...patterns: RegexValue[]): RegexTemplate
+whole(...patterns: RegexValue[]): RegexTemplate
+```
+
+Choose whether the concatenated patterns must match at the [start, end, or across the whole input](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Regular_expressions/Input_boundary_assertion).
+
+```ts
+r$.start("foo"); // ^(?:foo)
+r$.end("bar"); // (?:bar)$
+r$.whole("baz"); // ^(?:baz)$
+```
+
+### group
+
+```ts
+group(options: boolean, ...patterns: RegexValue[]): RegexTemplate
+group(options: { name: string }, ...patterns: RegexValue[]): RegexTemplate
+group(options: { capture?: boolean }, ...patterns: RegexValue[]): RegexTemplate
+```
+
+Group patterns using [capturing](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Regular_expressions/Capturing_group)
+or [non-capturing groups](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Regular_expressions/Non-capturing_group),
+optionally assigning a [capture name](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Regular_expressions/Named_capturing_group).
+
+```ts
+r$.group(true, "A"); // (A)
+r$.group(false, "A", "B"); // (?:AB)
+r$.group({ name: "part" }, "A", "B"); // (?<part>AB)
+r$.group({ capture: true }, "A"); // (A)
+r$.group({ capture: false }, "A", "B"); // (?:AB)
+```
+
+### named
+
+```ts
+named(name: string, ...patterns: RegexValue[]): RegexTemplate
+```
+
+Create a [named capturing group](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Regular_expressions/Named_capturing_group)
+around the concatenated patterns.
+
+```ts
+r$.named("value", "A", "B"); // (?<value>AB)
+r$.named("word", r$.or("cat", "dog")); // (?<word>cat|dog)
+```
+
+### ref
+
+```ts
+ref(reference: number | string): RegexTemplate
+```
+
+Create a [numeric](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Regular_expressions/Backreference) or [named](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Regular_expressions/Named_backreference) backreference.
+
+```ts
+r$.tpl(
+  r$.group(true, "B"),
+  r$.ref(1),
+); // (B)\1
+
+r$.tpl(
+  r$.named("name", "B"),
+  r$.ref("name"),
+); // (?<name>B)\k<name>
+```
+
+### opt
+
+```ts
+opt(...patterns: RegexValue[]): RegexTemplate
+```
+
+Make the concatenated patterns [optional](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Regular_expressions/Quantifier) using a non-capturing group.
+
+```ts
+r$.opt("C"); // (?:C)?
+r$.opt(r$.named("value", "A", "B")); // (?:(?<value>AB))?
+```
+
+### qty
+
+```ts
+qty(quantity: number, ...patterns: RegexValue[]): RegexTemplate
+qty(quantity: [min: number, max?: number], ...patterns: RegexValue[]): RegexTemplate
+qty(quantity: { exact: number; greedy?: boolean }, ...patterns: RegexValue[]): RegexTemplate
+qty(quantity: { min: number; max?: number; greedy?: boolean }, ...patterns: RegexValue[]): RegexTemplate
+```
+
+[Repeat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Regular_expressions/Quantifier) the concatenated patterns according to the supplied bounds.
+
+```ts
+r$.qty(3, "A", "B"); // (?:AB){3}
+r$.qty([3, 3], "A", "B"); // (?:AB){3}
+r$.qty([1, 3], "A", "B"); // (?:AB){1,3}
+r$.qty([1, Infinity], "A", "B"); // (?:AB){1,}
+r$.qty({ exact: 3 }, "A", "B"); // (?:AB){3}
+r$.qty({ exact: 3, greedy: false }, "A", "B"); // (?:AB){3}?
+r$.qty({ min: 2 }, "A", "B"); // (?:AB){2,}
+r$.qty({ min: 2, max: 5 }, "A", "B"); // (?:AB){2,5}
+r$.qty({ min: 2, max: 5, greedy: false }, "A", "B"); // (?:AB){2,5}?
+```
+
+### or
+
+```ts
+or(...patterns: RegexValue[]): RegexTemplate
+```
+
+Join patterns with [disjunction](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Regular_expressions/Disjunction)
+without adding groups.
+
+```ts
+r$.or("cat", "dog"); // cat|dog
+r$.or("foo", "bar", r$.raw("baz")); // foo|bar|\x62az
+```
+
+### ahead / ahead_pos / ahead_neg
+
+```ts
+ahead(positive: boolean, ...patterns: RegexValue[]): RegexTemplate
+ahead_pos(...patterns: RegexValue[]): RegexTemplate
+ahead_neg(...patterns: RegexValue[]): RegexTemplate
+```
+
+Create a positive or negative [lookahead assertion](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Regular_expressions/Lookahead_assertion).
+
+```ts
+r$.ahead(true, "foo"); // (?=foo)
+r$.ahead(false, "foo"); // (?!foo)
+r$.ahead_pos("foo"); // (?=foo)
+r$.ahead_neg("bar"); // (?!bar)
+```
+
+### behind / behind_pos / behind_neg
+
+```ts
+behind(positive: boolean, ...patterns: RegexValue[]): RegexTemplate
+behind_pos(...patterns: RegexValue[]): RegexTemplate
+behind_neg(...patterns: RegexValue[]): RegexTemplate
+```
+
+Create a positive or negative [lookbehind assertion](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Regular_expressions/Lookbehind_assertion).
+
+```ts
+r$.behind(true, "foo"); // (?<=foo)
+r$.behind(false, "foo"); // (?<!foo)
+r$.behind_pos("foo"); // (?<=foo)
+r$.behind_neg("bar"); // (?<!bar)
+```

package/dist/index.d.ts

@@ -0,0 +1,55 @@
+/**
+ * The JavaScript package exposes a default factory and a `JSRegexDesigner` class. It extends the abstract `RegexDesigner` contract from `@regex-designer/core`. Templates are compiled to a native `RegExp`.
+ */
+import type { GroupOptions, QuantityOptions, RegexDesignerWithBackreferences, RegexDesignerWithLookarounds, RegexTemplate as CoreRegexTemplate, RegexValue as CoreRegexValue } from "@regex-designer/core";
+import { RegexDesigner } from "@regex-designer/core";
+export type { GroupNamedOptions, GroupOptions, QuantityNamedOptions, QuantityOptions, RegexDesignerWithBackreferences, RegexDesignerWithLookarounds, } from "@regex-designer/core";
+export type RegexTemplate = CoreRegexTemplate<RegExp>;
+export type RegexValue = CoreRegexValue<RegExp>;
+export { isRegexTemplate } from "@regex-designer/core";
+/**
+ * Create a new JavaScript regex designer with its own variable scope.
+ * @readme default
+ */
+export default function create(): JSRegexDesigner;
+/**
+ * Templates are compiled to a native `RegExp`.
+ */
+export declare class JSRegexDesigner extends RegexDesigner<RegExp> implements RegexDesignerWithBackreferences<RegExp>, RegexDesignerWithLookarounds<RegExp> {
+    protected createTemplate(render: (flags: string | undefined, compiling: boolean) => string): RegexTemplate;
+    /** Concatenate patterns without adding groups or escaping. */
+    tpl(...patterns: RegexValue[]): RegexTemplate;
+    /** Escape literal text for use in a regex pattern. */
+    raw(...patterns: string[]): RegexTemplate;
+    /** Match the concatenated patterns at the start of the input. */
+    start(...patterns: RegexValue[]): RegexTemplate;
+    /** Match the concatenated patterns at the end of the input. */
+    end(...patterns: RegexValue[]): RegexTemplate;
+    /** Match the concatenated patterns across the whole input. */
+    whole(...patterns: RegexValue[]): RegexTemplate;
+    /** Group patterns, optionally capturing them or assigning a capture name. */
+    group(options: GroupOptions, ...patterns: RegexValue[]): RegexTemplate;
+    /** Create a named capturing group around the concatenated patterns. */
+    named(name: string, ...patterns: RegexValue[]): RegexTemplate;
+    /** Create a numeric or named backreference. */
+    ref(reference: number | string): RegexTemplate;
+    /** Make the concatenated patterns optional using a non-capturing group. */
+    opt(...patterns: RegexValue[]): RegexTemplate;
+    /** Repeat the concatenated patterns according to the supplied bounds. */
+    qty(quantity: QuantityOptions, ...patterns: RegexValue[]): RegexTemplate;
+    /** Join patterns with alternation without adding groups. */
+    or(...patterns: RegexValue[]): RegexTemplate;
+    /** Create a positive or negative [lookahead assertion](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Regular_expressions/Lookahead_assertion). */
+    ahead(positive: boolean, ...patterns: RegexValue[]): RegexTemplate;
+    /** Create a positive [lookahead assertion](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Regular_expressions/Lookahead_assertion). */
+    ahead_pos(...patterns: RegexValue[]): RegexTemplate;
+    /** Create a negative [lookahead assertion](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Regular_expressions/Lookahead_assertion). */
+    ahead_neg(...patterns: RegexValue[]): RegexTemplate;
+    /** Create a positive or negative [lookbehind assertion](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Regular_expressions/Lookbehind_assertion). */
+    behind(positive: boolean, ...patterns: RegexValue[]): RegexTemplate;
+    /** Create a positive [lookbehind assertion](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Regular_expressions/Lookbehind_assertion). */
+    behind_pos(...patterns: RegexValue[]): RegexTemplate;
+    /** Create a negative [lookbehind assertion](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Regular_expressions/Lookbehind_assertion). */
+    behind_neg(...patterns: RegexValue[]): RegexTemplate;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EACV,YAAY,EACZ,eAAe,EACf,+BAA+B,EAC/B,4BAA4B,EAC5B,aAAa,IAAI,iBAAiB,EAClC,UAAU,IAAI,cAAc,EAC7B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,aAAa,EAEd,MAAM,sBAAsB,CAAC;AAE9B,YAAY,EACV,iBAAiB,EACjB,YAAY,EACZ,oBAAoB,EACpB,eAAe,EACf,+BAA+B,EAC/B,4BAA4B,GAC7B,MAAM,sBAAsB,CAAC;AAC9B,MAAM,MAAM,aAAa,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;AACtD,MAAM,MAAM,UAAU,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AA8FvD;;;GAGG;AACH,MAAM,CAAC,OAAO,UAAU,MAAM,IAAI,eAAe,CAEhD;AAED;;GAEG;AACH,qBAAa,eAAgB,SAAQ,aAAa,CAAC,MAAM,CAAE,YAAW,+BAA+B,CAAC,MAAM,CAAC,EAAE,4BAA4B,CAAC,MAAM,CAAC;cAC9H,cAAc,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,EAAE,SAAS,EAAE,OAAO,KAAK,MAAM,GAAG,aAAa;IAInH,8DAA8D;IACrD,GAAG,CAAC,GAAG,QAAQ,EAAE,UAAU,EAAE,GAAG,aAAa;IAItD,sDAAsD;IAC7C,GAAG,CAAC,GAAG,QAAQ,EAAE,MAAM,EAAE,GAAG,aAAa;IAIlD,iEAAiE;IACxD,KAAK,CAAC,GAAG,QAAQ,EAAE,UAAU,EAAE,GAAG,aAAa;IAIxD,+DAA+D;IACtD,GAAG,CAAC,GAAG,QAAQ,EAAE,UAAU,EAAE,GAAG,aAAa;IAItD,8DAA8D;IACrD,KAAK,CAAC,GAAG,QAAQ,EAAE,UAAU,EAAE,GAAG,aAAa;IAIxD,6EAA6E;IACpE,KAAK,CAAC,OAAO,EAAE,YAAY,EAAE,GAAG,QAAQ,EAAE,UAAU,EAAE,GAAG,aAAa;IAI/E,uEAAuE;IAC9D,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,QAAQ,EAAE,UAAU,EAAE,GAAG,aAAa;IAItE,+CAA+C;IAC/C,GAAG,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,aAAa;IAI9C,2EAA2E;IAClE,GAAG,CAAC,GAAG,QAAQ,EAAE,UAAU,EAAE,GAAG,aAAa;IAItD,yEAAyE;IAChE,GAAG,CAAC,QAAQ,EAAE,eAAe,EAAE,GAAG,QAAQ,EAAE,UAAU,EAAE,GAAG,aAAa;IAIjF,4DAA4D;IACnD,EAAE,CAAC,GAAG,QAAQ,EAAE,UAAU,EAAE,GAAG,aAAa;IAIrD,sKAAsK;IAC7J,KAAK,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,QAAQ,EAAE,UAAU,EAAE,GAAG,aAAa;IAI3E,0JAA0J;IACjJ,SAAS,CAAC,GAAG,QAAQ,EAAE,UAAU,EAAE,GAAG,aAAa;IAI5D,0JAA0J;IACjJ,SAAS,CAAC,GAAG,QAAQ,EAAE,UAAU,EAAE,GAAG,aAAa;IAI5D,wKAAwK;IAC/J,MAAM,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,QAAQ,EAAE,UAAU,EAAE,GAAG,aAAa;IAI5E,4JAA4J;IACnJ,UAAU,CAAC,GAAG,QAAQ,EAAE,UAAU,EAAE,GAAG,aAAa;IAI7D,4JAA4J;IACnJ,UAAU,CAAC,GAAG,QAAQ,EAAE,UAAU,EAAE,GAAG,aAAa;CAI9D"}

package/dist/index.js

@@ -0,0 +1,167 @@
+/**
+ * The JavaScript package exposes a default factory and a `JSRegexDesigner` class. It extends the abstract `RegexDesigner` contract from `@regex-designer/core`. Templates are compiled to a native `RegExp`.
+ */
+import { RegexDesigner, isRegexTemplate, } from "@regex-designer/core";
+export { isRegexTemplate } from "@regex-designer/core";
+function patternString(pattern, flags, compiling) {
+    if (pattern instanceof RegExp) {
+        const unicodeFlag = pattern.flags.includes("v") ? "v" : pattern.flags.includes("u") ? "u" : undefined;
+        if (compiling && unicodeFlag !== undefined && !flags?.includes(unicodeFlag)) {
+            throw new TypeError(`RegExp flag "${unicodeFlag}" must be passed when compiling the composed pattern`);
+        }
+        const scopedFlags = pattern.flags.replace(/[dgyuv]/g, "");
+        return scopedFlags === "" ? pattern.source : `(?${scopedFlags}:${pattern.source})`;
+    }
+    if (isRegexTemplate(pattern)) {
+        return pattern.render(flags, compiling);
+    }
+    return pattern.toString();
+}
+function template(render) {
+    const regex = (flags) => new RegExp(regex.render(flags, true), flags);
+    regex.render = (flags, compiling = false) => render(flags, compiling);
+    regex.toString = () => regex.render();
+    return regex;
+}
+function tpl(...patterns) {
+    return template((flags, compiling) => patterns.map(pattern => patternString(pattern, flags, compiling)).join(""));
+}
+function or(...patterns) {
+    return template((flags, compiling) => patterns.map(pattern => patternString(pattern, flags, compiling)).join("|"));
+}
+function group(options, ...patterns) {
+    if (typeof options !== "boolean" && options.name !== undefined && options.capture !== undefined) {
+        throw new TypeError("Group options \"name\" and \"capture\" are mutually exclusive");
+    }
+    return template((flags, compiling) => {
+        const name = typeof options === "boolean" ? undefined : options.name;
+        const capture = typeof options === "boolean" ? options : options.capture ?? true;
+        const prefix = name !== undefined ? `?<${name}>` : capture ? "" : "?:";
+        return `(${prefix}${patterns.map(pattern => patternString(pattern, flags, compiling)).join("")})`;
+    });
+}
+function anchor(start, end, patterns) {
+    return template((flags, compiling) => `${start ? "^" : ""}${patternString(group(false, ...patterns), flags, compiling)}${end ? "$" : ""}`);
+}
+function named(name, ...patterns) {
+    return group({ name }, ...patterns);
+}
+function opt(...patterns) {
+    return template((flags, compiling) => `${patternString(group(false, ...patterns), flags, compiling)}?`);
+}
+function qty(quantity, ...patterns) {
+    let min;
+    let max;
+    let greedy = true;
+    if (typeof quantity === "number") {
+        min = quantity;
+        max = quantity;
+    }
+    else if (Array.isArray(quantity)) {
+        [min, max] = quantity;
+    }
+    else if ("exact" in quantity) {
+        min = quantity.exact;
+        max = quantity.exact;
+        greedy = quantity.greedy ?? true;
+    }
+    else {
+        min = quantity.min;
+        max = quantity.max;
+        greedy = quantity.greedy ?? true;
+    }
+    if (!Number.isInteger(min) || min < 0 || (max !== undefined && max !== Infinity && (!Number.isInteger(max) || max < min))) {
+        throw new RangeError("Quantity bounds must be non-negative integers with max >= min");
+    }
+    return template((flags, compiling) => `${patternString(group(false, ...patterns), flags, compiling)}{${min}${max === undefined || max === Infinity ? "," : max === min ? "" : `,${max}`}}${greedy ? "" : "?"}`);
+}
+function look(prefix, positive, patterns) {
+    return template((flags, compiling) => `(${prefix}${positive ? "=" : "!"}${patterns.map(pattern => patternString(pattern, flags, compiling)).join("")})`);
+}
+function raw(...patterns) {
+    return template(() => patterns.map(p => RegExp.escape(p)).join(""));
+}
+/**
+ * Create a new JavaScript regex designer with its own variable scope.
+ * @readme default
+ */
+export default function create() {
+    return new JSRegexDesigner();
+}
+/**
+ * Templates are compiled to a native `RegExp`.
+ */
+export class JSRegexDesigner extends RegexDesigner {
+    createTemplate(render) {
+        return template(render);
+    }
+    /** Concatenate patterns without adding groups or escaping. */
+    tpl(...patterns) {
+        return tpl(...patterns);
+    }
+    /** Escape literal text for use in a regex pattern. */
+    raw(...patterns) {
+        return raw(...patterns);
+    }
+    /** Match the concatenated patterns at the start of the input. */
+    start(...patterns) {
+        return anchor(true, false, patterns);
+    }
+    /** Match the concatenated patterns at the end of the input. */
+    end(...patterns) {
+        return anchor(false, true, patterns);
+    }
+    /** Match the concatenated patterns across the whole input. */
+    whole(...patterns) {
+        return anchor(true, true, patterns);
+    }
+    /** Group patterns, optionally capturing them or assigning a capture name. */
+    group(options, ...patterns) {
+        return group(options, ...patterns);
+    }
+    /** Create a named capturing group around the concatenated patterns. */
+    named(name, ...patterns) {
+        return named(name, ...patterns);
+    }
+    /** Create a numeric or named backreference. */
+    ref(reference) {
+        return template(() => typeof reference === "number" ? `\\${reference}` : `\\k<${reference}>`);
+    }
+    /** Make the concatenated patterns optional using a non-capturing group. */
+    opt(...patterns) {
+        return opt(...patterns);
+    }
+    /** Repeat the concatenated patterns according to the supplied bounds. */
+    qty(quantity, ...patterns) {
+        return qty(quantity, ...patterns);
+    }
+    /** Join patterns with alternation without adding groups. */
+    or(...patterns) {
+        return or(...patterns);
+    }
+    /** Create a positive or negative [lookahead assertion](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Regular_expressions/Lookahead_assertion). */
+    ahead(positive, ...patterns) {
+        return look("?", positive, patterns);
+    }
+    /** Create a positive [lookahead assertion](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Regular_expressions/Lookahead_assertion). */
+    ahead_pos(...patterns) {
+        return look("?", true, patterns);
+    }
+    /** Create a negative [lookahead assertion](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Regular_expressions/Lookahead_assertion). */
+    ahead_neg(...patterns) {
+        return look("?", false, patterns);
+    }
+    /** Create a positive or negative [lookbehind assertion](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Regular_expressions/Lookbehind_assertion). */
+    behind(positive, ...patterns) {
+        return look("?<", positive, patterns);
+    }
+    /** Create a positive [lookbehind assertion](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Regular_expressions/Lookbehind_assertion). */
+    behind_pos(...patterns) {
+        return look("?<", true, patterns);
+    }
+    /** Create a negative [lookbehind assertion](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Regular_expressions/Lookbehind_assertion). */
+    behind_neg(...patterns) {
+        return look("?<", false, patterns);
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AAUH,OAAO,EACL,aAAa,EACb,eAAe,GAChB,MAAM,sBAAsB,CAAC;AAY9B,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD,SAAS,aAAa,CAAC,OAAmB,EAAE,KAAyB,EAAE,SAAkB;IACvF,IAAI,OAAO,YAAY,MAAM,EAAE,CAAC;QAC9B,MAAM,WAAW,GAAG,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;QACtG,IAAI,SAAS,IAAI,WAAW,KAAK,SAAS,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;YAC5E,MAAM,IAAI,SAAS,CAAC,gBAAgB,WAAW,sDAAsD,CAAC,CAAC;QACzG,CAAC;QAED,MAAM,WAAW,GAAG,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;QAC1D,OAAO,WAAW,KAAK,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,WAAW,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;IACrF,CAAC;IAED,IAAI,eAAe,CAAC,OAAO,CAAC,EAAE,CAAC;QAC7B,OAAO,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;IAC1C,CAAC;IACD,OAAO,OAAO,CAAC,QAAQ,EAAE,CAAC;AAC5B,CAAC;AAED,SAAS,QAAQ,CAAC,MAAiE;IACjF,MAAM,KAAK,GAAkB,CAAC,KAAc,EAAE,EAAE,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC;IAC9F,KAAK,CAAC,MAAM,GAAG,CAAC,KAAc,EAAE,SAAS,GAAG,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;IAC/E,KAAK,CAAC,QAAQ,GAAG,GAAG,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;IACtC,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,GAAG,CAAC,GAAG,QAAsB;IACpC,OAAO,QAAQ,CAAC,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,aAAa,CAAC,OAAO,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;AACpH,CAAC;AAED,SAAS,EAAE,CAAC,GAAG,QAAsB;IACnC,OAAO,QAAQ,CAAC,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,aAAa,CAAC,OAAO,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AACrH,CAAC;AAED,SAAS,KAAK,CAAC,OAAqB,EAAE,GAAG,QAAsB;IAC7D,IAAI,OAAO,OAAO,KAAK,SAAS,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QAChG,MAAM,IAAI,SAAS,CAAC,+DAA+D,CAAC,CAAC;IACvF,CAAC;IAED,OAAO,QAAQ,CAAC,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE;QACnC,MAAM,IAAI,GAAG,OAAO,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC;QACrE,MAAM,OAAO,GAAG,OAAO,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,IAAI,IAAI,CAAC;QACjF,MAAM,MAAM,GAAG,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,IAAI,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;QACvE,OAAO,IAAI,MAAM,GAAG,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,aAAa,CAAC,OAAO,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC;IACpG,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,MAAM,CAAC,KAAc,EAAE,GAAY,EAAE,QAAsB;IAClE,OAAO,QAAQ,CAAC,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,aAAa,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,QAAQ,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AAC7I,CAAC;AAED,SAAS,KAAK,CAAC,IAAY,EAAE,GAAG,QAAsB;IACpD,OAAO,KAAK,CAAC,EAAE,IAAI,EAAE,EAAE,GAAG,QAAQ,CAAC,CAAC;AACtC,CAAC;AAED,SAAS,GAAG,CAAC,GAAG,QAAsB;IACpC,OAAO,QAAQ,CAAC,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE,CAAC,GAAG,aAAa,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,QAAQ,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC;AAC1G,CAAC;AAED,SAAS,GAAG,CAAC,QAAyB,EAAE,GAAG,QAAsB;IAC/D,IAAI,GAAW,CAAC;IAChB,IAAI,GAAuB,CAAC;IAC5B,IAAI,MAAM,GAAG,IAAI,CAAC;IAElB,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE,CAAC;QACjC,GAAG,GAAG,QAAQ,CAAC;QACf,GAAG,GAAG,QAAQ,CAAC;IACjB,CAAC;SAAM,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QACnC,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,QAAQ,CAAC;IACxB,CAAC;SAAM,IAAI,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,GAAG,GAAG,QAAQ,CAAC,KAAK,CAAC;QACrB,GAAG,GAAG,QAAQ,CAAC,KAAK,CAAC;QACrB,MAAM,GAAG,QAAQ,CAAC,MAAM,IAAI,IAAI,CAAC;IACnC,CAAC;SAAM,CAAC;QACN,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC;QACnB,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC;QACnB,MAAM,GAAG,QAAQ,CAAC,MAAM,IAAI,IAAI,CAAC;IACnC,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,QAAQ,IAAI,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,GAAG,GAAG,GAAG,CAAC,CAAC,EAAE,CAAC;QAC1H,MAAM,IAAI,UAAU,CAAC,+DAA+D,CAAC,CAAC;IACxF,CAAC;IAED,OAAO,QAAQ,CAAC,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE,CAAC,GAAG,aAAa,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,QAAQ,CAAC,EAAE,KAAK,EAAE,SAAS,CAAC,IAAI,GAAG,GAAG,GAAG,KAAK,SAAS,IAAI,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,GAAG,EAAE,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC;AAClN,CAAC;AAED,SAAS,IAAI,CAAC,MAAc,EAAE,QAAiB,EAAE,QAAsB;IACrE,OAAO,QAAQ,CAAC,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE,CAAC,IAAI,MAAM,GAAG,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,aAAa,CAAC,OAAO,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC;AAC3J,CAAC;AAED,SAAS,GAAG,CAAC,GAAG,QAAkB;IAChC,OAAO,QAAQ,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;AACtE,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,OAAO,UAAU,MAAM;IAC5B,OAAO,IAAI,eAAe,EAAE,CAAC;AAC/B,CAAC;AAED;;GAEG;AACH,MAAM,OAAO,eAAgB,SAAQ,aAAqB;IACrC,cAAc,CAAC,MAAiE;QACjG,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC1B,CAAC;IAED,8DAA8D;IACrD,GAAG,CAAC,GAAG,QAAsB;QACpC,OAAO,GAAG,CAAC,GAAG,QAAQ,CAAC,CAAC;IAC1B,CAAC;IAED,sDAAsD;IAC7C,GAAG,CAAC,GAAG,QAAkB;QAChC,OAAO,GAAG,CAAC,GAAG,QAAQ,CAAC,CAAC;IAC1B,CAAC;IAED,iEAAiE;IACxD,KAAK,CAAC,GAAG,QAAsB;QACtC,OAAO,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED,+DAA+D;IACtD,GAAG,CAAC,GAAG,QAAsB;QACpC,OAAO,MAAM,CAAC,KAAK,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED,8DAA8D;IACrD,KAAK,CAAC,GAAG,QAAsB;QACtC,OAAO,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IACtC,CAAC;IAED,6EAA6E;IACpE,KAAK,CAAC,OAAqB,EAAE,GAAG,QAAsB;QAC7D,OAAO,KAAK,CAAC,OAAO,EAAE,GAAG,QAAQ,CAAC,CAAC;IACrC,CAAC;IAED,uEAAuE;IAC9D,KAAK,CAAC,IAAY,EAAE,GAAG,QAAsB;QACpD,OAAO,KAAK,CAAC,IAAI,EAAE,GAAG,QAAQ,CAAC,CAAC;IAClC,CAAC;IAED,+CAA+C;IAC/C,GAAG,CAAC,SAA0B;QAC5B,OAAO,QAAQ,CAAC,GAAG,EAAE,CAAC,OAAO,SAAS,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC,CAAC,CAAC,OAAO,SAAS,GAAG,CAAC,CAAC;IAChG,CAAC;IAED,2EAA2E;IAClE,GAAG,CAAC,GAAG,QAAsB;QACpC,OAAO,GAAG,CAAC,GAAG,QAAQ,CAAC,CAAC;IAC1B,CAAC;IAED,yEAAyE;IAChE,GAAG,CAAC,QAAyB,EAAE,GAAG,QAAsB;QAC/D,OAAO,GAAG,CAAC,QAAQ,EAAE,GAAG,QAAQ,CAAC,CAAC;IACpC,CAAC;IAED,4DAA4D;IACnD,EAAE,CAAC,GAAG,QAAsB;QACnC,OAAO,EAAE,CAAC,GAAG,QAAQ,CAAC,CAAC;IACzB,CAAC;IAED,sKAAsK;IAC7J,KAAK,CAAC,QAAiB,EAAE,GAAG,QAAsB;QACzD,OAAO,IAAI,CAAC,GAAG,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED,0JAA0J;IACjJ,SAAS,CAAC,GAAG,QAAsB;QAC1C,OAAO,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IACnC,CAAC;IAED,0JAA0J;IACjJ,SAAS,CAAC,GAAG,QAAsB;QAC1C,OAAO,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;IACpC,CAAC;IAED,wKAAwK;IAC/J,MAAM,CAAC,QAAiB,EAAE,GAAG,QAAsB;QAC1D,OAAO,IAAI,CAAC,IAAI,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;IACxC,CAAC;IAED,4JAA4J;IACnJ,UAAU,CAAC,GAAG,QAAsB;QAC3C,OAAO,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;IACpC,CAAC;IAED,4JAA4J;IACnJ,UAAU,CAAC,GAAG,QAAsB;QAC3C,OAAO,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;IACrC,CAAC;CAEF"}

package/package.json

@@ -1,6 +1,36 @@
 {
   "name": "@regex-designer/js",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.2.0",
+  "description": "A small TypeScript library for composing JavaScript regular expressions in a readable, reusable way.",
+  "type": "module",
+  "license": "MIT",
+  "keywords": [
+    "regex",
+    "regexp",
+    "pattern",
+    "builder"
+  ],
+  "engines": {
+    "node": ">=24.0.0"
+  },
+  "files": [
+    "dist"
+  ],
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "sideEffects": false,
+  "dependencies": {
+    "@regex-designer/core": "0.2.0"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "lint": "eslint --config ../../eslint.config.* .",
+    "test": "npm run build && tsc -p tsconfig.test.json && node --test test/*.test.ts",
+    "check": "npm run lint && npm run test"
+  }
+}