@platformos/liquid-html-parser 0.0.2

package/dist/types.d.ts

@@ -0,0 +1,124 @@
+export interface Position {
+    /** 0-indexed offset in the string, included */
+    start: number;
+    /** 0-indexed offset, excluded */
+    end: number;
+}
+export declare enum NodeTypes {
+    Document = "Document",
+    LiquidRawTag = "LiquidRawTag",
+    LiquidTag = "LiquidTag",
+    LiquidBranch = "LiquidBranch",
+    LiquidVariableOutput = "LiquidVariableOutput",
+    HtmlSelfClosingElement = "HtmlSelfClosingElement",
+    HtmlVoidElement = "HtmlVoidElement",
+    HtmlDoctype = "HtmlDoctype",
+    HtmlComment = "HtmlComment",
+    HtmlElement = "HtmlElement",
+    HtmlDanglingMarkerClose = "HtmlDanglingMarkerClose",
+    HtmlRawNode = "HtmlRawNode",
+    AttrSingleQuoted = "AttrSingleQuoted",
+    AttrDoubleQuoted = "AttrDoubleQuoted",
+    AttrUnquoted = "AttrUnquoted",
+    AttrEmpty = "AttrEmpty",
+    TextNode = "TextNode",
+    YAMLFrontmatter = "YAMLFrontmatter",
+    LiquidVariable = "LiquidVariable",
+    LiquidFilter = "LiquidFilter",
+    NamedArgument = "NamedArgument",
+    LiquidLiteral = "LiquidLiteral",
+    BooleanExpression = "BooleanExpression",
+    String = "String",
+    Number = "Number",
+    Range = "Range",
+    VariableLookup = "VariableLookup",
+    Comparison = "Comparison",
+    LogicalExpression = "LogicalExpression",
+    AssignMarkup = "AssignMarkup",
+    HashAssignMarkup = "HashAssignMarkup",
+    ContentForMarkup = "ContentForMarkup",
+    CycleMarkup = "CycleMarkup",
+    ForMarkup = "ForMarkup",
+    PaginateMarkup = "PaginateMarkup",
+    RawMarkup = "RawMarkup",
+    RenderMarkup = "RenderMarkup",
+    FunctionMarkup = "FunctionMarkup",
+    GraphQLMarkup = "GraphQLMarkup",
+    GraphQLInlineMarkup = "GraphQLInlineMarkup",
+    RenderVariableExpression = "RenderVariableExpression",
+    RenderAliasExpression = "RenderAliasExpression",
+    LiquidDocDescriptionNode = "LiquidDocDescriptionNode",
+    LiquidDocParamNode = "LiquidDocParamNode",
+    LiquidDocExampleNode = "LiquidDocExampleNode",
+    LiquidDocPromptNode = "LiquidDocPromptNode",
+    BackgroundMarkup = "BackgroundMarkup",
+    BackgroundInlineMarkup = "BackgroundInlineMarkup",
+    CacheMarkup = "CacheMarkup",
+    LogMarkup = "LogMarkup",
+    SessionMarkup = "SessionMarkup",
+    ExportMarkup = "ExportMarkup",
+    RedirectToMarkup = "RedirectToMarkup",
+    IncludeFormMarkup = "IncludeFormMarkup",
+    SpamProtectionMarkup = "SpamProtectionMarkup"
+}
+export declare enum NamedTags {
+    assign = "assign",
+    hash_assign = "hash_assign",
+    capture = "capture",
+    case = "case",
+    content_for = "content_for",
+    cycle = "cycle",
+    decrement = "decrement",
+    echo = "echo",
+    elsif = "elsif",
+    for = "for",
+    form = "form",
+    if = "if",
+    include = "include",
+    increment = "increment",
+    layout = "layout",
+    liquid = "liquid",
+    paginate = "paginate",
+    render = "render",
+    function = "function",
+    graphql = "graphql",
+    section = "section",
+    sections = "sections",
+    tablerow = "tablerow",
+    unless = "unless",
+    when = "when",
+    background = "background",
+    cache = "cache",
+    catch = "catch",
+    context = "context",
+    export = "export",
+    include_form = "include_form",
+    log = "log",
+    parse_json = "parse_json",
+    print = "print",
+    redirect_to = "redirect_to",
+    response_headers = "response_headers",
+    response_status = "response_status",
+    return = "return",
+    rollback = "rollback",
+    session = "session",
+    sign_in = "sign_in",
+    spam_protection = "spam_protection",
+    theme_render_rc = "theme_render_rc",
+    transaction = "transaction",
+    try = "try",
+    yield = "yield"
+}
+export declare enum Comparators {
+    CONTAINS = "contains",
+    EQUAL = "==",
+    GREATER_THAN = ">",
+    GREATER_THAN_OR_EQUAL = ">=",
+    LESS_THAN = "<",
+    LESS_THAN_OR_EQUAL = "<=",
+    NOT_EQUAL = "!="
+}
+export declare const HtmlNodeTypes: readonly [NodeTypes.HtmlElement, NodeTypes.HtmlDanglingMarkerClose, NodeTypes.HtmlRawNode, NodeTypes.HtmlVoidElement, NodeTypes.HtmlSelfClosingElement];
+export declare const LiquidNodeTypes: readonly [NodeTypes.LiquidTag, NodeTypes.LiquidVariableOutput, NodeTypes.LiquidBranch, NodeTypes.LiquidRawTag];
+export declare const LoopNamedTags: readonly [NamedTags.for, NamedTags.tablerow];
+export declare const nonTraversableProperties: Set<string>;

package/dist/types.js

@@ -0,0 +1,146 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.nonTraversableProperties = exports.LoopNamedTags = exports.LiquidNodeTypes = exports.HtmlNodeTypes = exports.Comparators = exports.NamedTags = exports.NodeTypes = void 0;
+var NodeTypes;
+(function (NodeTypes) {
+    NodeTypes["Document"] = "Document";
+    NodeTypes["LiquidRawTag"] = "LiquidRawTag";
+    NodeTypes["LiquidTag"] = "LiquidTag";
+    NodeTypes["LiquidBranch"] = "LiquidBranch";
+    NodeTypes["LiquidVariableOutput"] = "LiquidVariableOutput";
+    NodeTypes["HtmlSelfClosingElement"] = "HtmlSelfClosingElement";
+    NodeTypes["HtmlVoidElement"] = "HtmlVoidElement";
+    NodeTypes["HtmlDoctype"] = "HtmlDoctype";
+    NodeTypes["HtmlComment"] = "HtmlComment";
+    NodeTypes["HtmlElement"] = "HtmlElement";
+    NodeTypes["HtmlDanglingMarkerClose"] = "HtmlDanglingMarkerClose";
+    NodeTypes["HtmlRawNode"] = "HtmlRawNode";
+    NodeTypes["AttrSingleQuoted"] = "AttrSingleQuoted";
+    NodeTypes["AttrDoubleQuoted"] = "AttrDoubleQuoted";
+    NodeTypes["AttrUnquoted"] = "AttrUnquoted";
+    NodeTypes["AttrEmpty"] = "AttrEmpty";
+    NodeTypes["TextNode"] = "TextNode";
+    NodeTypes["YAMLFrontmatter"] = "YAMLFrontmatter";
+    NodeTypes["LiquidVariable"] = "LiquidVariable";
+    NodeTypes["LiquidFilter"] = "LiquidFilter";
+    NodeTypes["NamedArgument"] = "NamedArgument";
+    NodeTypes["LiquidLiteral"] = "LiquidLiteral";
+    NodeTypes["BooleanExpression"] = "BooleanExpression";
+    NodeTypes["String"] = "String";
+    NodeTypes["Number"] = "Number";
+    NodeTypes["Range"] = "Range";
+    NodeTypes["VariableLookup"] = "VariableLookup";
+    NodeTypes["Comparison"] = "Comparison";
+    NodeTypes["LogicalExpression"] = "LogicalExpression";
+    NodeTypes["AssignMarkup"] = "AssignMarkup";
+    NodeTypes["HashAssignMarkup"] = "HashAssignMarkup";
+    NodeTypes["ContentForMarkup"] = "ContentForMarkup";
+    NodeTypes["CycleMarkup"] = "CycleMarkup";
+    NodeTypes["ForMarkup"] = "ForMarkup";
+    NodeTypes["PaginateMarkup"] = "PaginateMarkup";
+    NodeTypes["RawMarkup"] = "RawMarkup";
+    NodeTypes["RenderMarkup"] = "RenderMarkup";
+    NodeTypes["FunctionMarkup"] = "FunctionMarkup";
+    NodeTypes["GraphQLMarkup"] = "GraphQLMarkup";
+    NodeTypes["GraphQLInlineMarkup"] = "GraphQLInlineMarkup";
+    NodeTypes["RenderVariableExpression"] = "RenderVariableExpression";
+    NodeTypes["RenderAliasExpression"] = "RenderAliasExpression";
+    NodeTypes["LiquidDocDescriptionNode"] = "LiquidDocDescriptionNode";
+    NodeTypes["LiquidDocParamNode"] = "LiquidDocParamNode";
+    NodeTypes["LiquidDocExampleNode"] = "LiquidDocExampleNode";
+    NodeTypes["LiquidDocPromptNode"] = "LiquidDocPromptNode";
+    // platformos markup types
+    NodeTypes["BackgroundMarkup"] = "BackgroundMarkup";
+    NodeTypes["BackgroundInlineMarkup"] = "BackgroundInlineMarkup";
+    NodeTypes["CacheMarkup"] = "CacheMarkup";
+    NodeTypes["LogMarkup"] = "LogMarkup";
+    NodeTypes["SessionMarkup"] = "SessionMarkup";
+    NodeTypes["ExportMarkup"] = "ExportMarkup";
+    NodeTypes["RedirectToMarkup"] = "RedirectToMarkup";
+    NodeTypes["IncludeFormMarkup"] = "IncludeFormMarkup";
+    NodeTypes["SpamProtectionMarkup"] = "SpamProtectionMarkup";
+})(NodeTypes || (exports.NodeTypes = NodeTypes = {}));
+// These are officially supported with special node types
+var NamedTags;
+(function (NamedTags) {
+    NamedTags["assign"] = "assign";
+    NamedTags["hash_assign"] = "hash_assign";
+    NamedTags["capture"] = "capture";
+    NamedTags["case"] = "case";
+    NamedTags["content_for"] = "content_for";
+    NamedTags["cycle"] = "cycle";
+    NamedTags["decrement"] = "decrement";
+    NamedTags["echo"] = "echo";
+    NamedTags["elsif"] = "elsif";
+    NamedTags["for"] = "for";
+    NamedTags["form"] = "form";
+    NamedTags["if"] = "if";
+    NamedTags["include"] = "include";
+    NamedTags["increment"] = "increment";
+    NamedTags["layout"] = "layout";
+    NamedTags["liquid"] = "liquid";
+    NamedTags["paginate"] = "paginate";
+    NamedTags["render"] = "render";
+    NamedTags["function"] = "function";
+    NamedTags["graphql"] = "graphql";
+    NamedTags["section"] = "section";
+    NamedTags["sections"] = "sections";
+    NamedTags["tablerow"] = "tablerow";
+    NamedTags["unless"] = "unless";
+    NamedTags["when"] = "when";
+    // platformos tags
+    NamedTags["background"] = "background";
+    NamedTags["cache"] = "cache";
+    NamedTags["catch"] = "catch";
+    NamedTags["context"] = "context";
+    NamedTags["export"] = "export";
+    NamedTags["include_form"] = "include_form";
+    NamedTags["log"] = "log";
+    NamedTags["parse_json"] = "parse_json";
+    NamedTags["print"] = "print";
+    NamedTags["redirect_to"] = "redirect_to";
+    NamedTags["response_headers"] = "response_headers";
+    NamedTags["response_status"] = "response_status";
+    NamedTags["return"] = "return";
+    NamedTags["rollback"] = "rollback";
+    NamedTags["session"] = "session";
+    NamedTags["sign_in"] = "sign_in";
+    NamedTags["spam_protection"] = "spam_protection";
+    NamedTags["theme_render_rc"] = "theme_render_rc";
+    NamedTags["transaction"] = "transaction";
+    NamedTags["try"] = "try";
+    NamedTags["yield"] = "yield";
+})(NamedTags || (exports.NamedTags = NamedTags = {}));
+var Comparators;
+(function (Comparators) {
+    Comparators["CONTAINS"] = "contains";
+    Comparators["EQUAL"] = "==";
+    Comparators["GREATER_THAN"] = ">";
+    Comparators["GREATER_THAN_OR_EQUAL"] = ">=";
+    Comparators["LESS_THAN"] = "<";
+    Comparators["LESS_THAN_OR_EQUAL"] = "<=";
+    Comparators["NOT_EQUAL"] = "!=";
+})(Comparators || (exports.Comparators = Comparators = {}));
+exports.HtmlNodeTypes = [
+    NodeTypes.HtmlElement,
+    NodeTypes.HtmlDanglingMarkerClose,
+    NodeTypes.HtmlRawNode,
+    NodeTypes.HtmlVoidElement,
+    NodeTypes.HtmlSelfClosingElement,
+];
+exports.LiquidNodeTypes = [
+    NodeTypes.LiquidTag,
+    NodeTypes.LiquidVariableOutput,
+    NodeTypes.LiquidBranch,
+    NodeTypes.LiquidRawTag,
+];
+exports.LoopNamedTags = [NamedTags.for, NamedTags.tablerow];
+// Those properties create loops that would make walking infinite
+exports.nonTraversableProperties = new Set([
+    'parentNode',
+    'prev',
+    'next',
+    'firstChild',
+    'lastChild',
+]);
+//# sourceMappingURL=types.js.map

package/dist/utils.d.ts

@@ -0,0 +1,10 @@
+import { Position } from './types';
+export declare function assertNever(x: never): never;
+export declare function locStart(node: {
+    position: Position;
+}): number;
+export declare function locEnd(node: {
+    position: Position;
+}): number;
+export declare function deepGet<T = any>(path: (string | number)[], obj: any): T;
+export declare function dropLast<T>(n: number, xs: readonly T[]): T[];

package/dist/utils.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertNever = assertNever;
+exports.locStart = locStart;
+exports.locEnd = locEnd;
+exports.deepGet = deepGet;
+exports.dropLast = dropLast;
+function assertNever(x) {
+    throw new Error(`Unexpected object: ${x.type}`);
+}
+function locStart(node) {
+    return node.position.start;
+}
+function locEnd(node) {
+    return node.position.end;
+}
+function deepGet(path, obj) {
+    return path.reduce((curr, k) => {
+        if (curr && curr[k] !== undefined)
+            return curr[k];
+        return undefined;
+    }, obj);
+}
+function dropLast(n, xs) {
+    const result = [...xs];
+    for (let i = 0; i < n; i++) {
+        result.pop();
+    }
+    return result;
+}
+//# sourceMappingURL=utils.js.map