@platformos/platformos-check-common 0.0.2

package/dist/visitor.d.ts

@@ -0,0 +1,24 @@
+import { AST, LiquidHtmlNode, NodeOfType, SourceCodeType, NodeTypes, JSONNode } from './types';
+export type VisitorMethod<S extends SourceCodeType, T, R> = (node: NodeOfType<S, T>, ancestors: AST[S][]) => Promise<R | R[] | undefined>;
+export type Visitor<S extends SourceCodeType, R> = {
+    [T in NodeTypes[S]]?: VisitorMethod<S, T, R>;
+};
+export type ExecuteFunction<S extends SourceCodeType> = (node: AST[S], lineage: AST[S][]) => void;
+/**
+ * @example
+ *
+ * const links = visit<'LiquidHTML', DocumentLink>(liquidAST, {
+ *   'LiquidTag': (node, ancestors) => {
+ *     if (node.name === 'render' || node.name === 'include') {
+ *       return DocumentLink.create(...);
+ *     }
+ *   },
+ * })
+ *
+ * Note: this is the ChatGPT-rewritten version of the recursive method.
+ * If you want to refactor it, just ask it to do it for you :P
+ */
+export declare function visit<S extends SourceCodeType, R>(node: AST[S], visitor: Visitor<S, R>): Promise<R[]>;
+export declare function forEachChildNodes<S extends SourceCodeType>(node: AST[S], lineage: AST[S][], execute: ExecuteFunction<S>): void;
+export declare function findCurrentNode(ast: LiquidHtmlNode, cursorPosition: number): [node: LiquidHtmlNode, ancestors: LiquidHtmlNode[]];
+export declare function findJSONNode(ast: JSONNode, cursorPosition: number): [node: JSONNode, ancestors: JSONNode[]];

package/dist/visitor.js

@@ -0,0 +1,119 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.visit = visit;
+exports.forEachChildNodes = forEachChildNodes;
+exports.findCurrentNode = findCurrentNode;
+exports.findJSONNode = findJSONNode;
+const liquid_html_parser_1 = require("@platformos/liquid-html-parser");
+function isNode(x) {
+    return x !== null && typeof x === 'object' && typeof x.type === 'string';
+}
+/**
+ * @example
+ *
+ * const links = visit<'LiquidHTML', DocumentLink>(liquidAST, {
+ *   'LiquidTag': (node, ancestors) => {
+ *     if (node.name === 'render' || node.name === 'include') {
+ *       return DocumentLink.create(...);
+ *     }
+ *   },
+ * })
+ *
+ * Note: this is the ChatGPT-rewritten version of the recursive method.
+ * If you want to refactor it, just ask it to do it for you :P
+ */
+async function visit(node, visitor) {
+    const results = [];
+    const stack = [{ node, lineage: [] }];
+    const pushStack = (node, lineage) => stack.push({ node, lineage });
+    while (stack.length > 0) {
+        // Visit current node
+        const { node, lineage } = stack.pop();
+        const visitNode = visitor[node.type];
+        const result = visitNode
+            ? await Promise.resolve(visitNode(node, lineage))
+            : undefined;
+        if (Array.isArray(result)) {
+            results.push(...result);
+        }
+        else if (result !== undefined) {
+            results.push(result);
+        }
+        // Enqueue child nodes
+        forEachChildNodes(node, lineage.concat(node), pushStack);
+    }
+    return results;
+}
+function forEachChildNodes(node, lineage, execute) {
+    for (const value of Object.values(node)) {
+        if (Array.isArray(value)) {
+            for (let i = value.length - 1; i >= 0; i--) {
+                execute(value[i], lineage);
+            }
+        }
+        else if (isNode(value)) {
+            execute(value, lineage);
+        }
+    }
+}
+function findCurrentNode(ast, cursorPosition) {
+    let prev;
+    let current = ast;
+    let ancestors = [];
+    while (current !== prev) {
+        prev = current;
+        forEachChildNodes(current, ancestors.concat(current), (child, lineage) => {
+            if (isUnclosed(child) ||
+                (isCovered(child, cursorPosition) && size(child) <= size(current))) {
+                current = child;
+                ancestors = lineage;
+            }
+        });
+    }
+    return [current, ancestors];
+}
+function isCovered(node, offset) {
+    switch (node.type) {
+        // `product.█title` should cover `title`
+        case liquid_html_parser_1.NodeTypes.String:
+        // `if █cond` should cover `cond`
+        case liquid_html_parser_1.NodeTypes.VariableLookup:
+        // `if █cond and other` should cover `cond`
+        case liquid_html_parser_1.NodeTypes.LogicalExpression:
+        // `if █cond < other` should cover `cond`
+        case liquid_html_parser_1.NodeTypes.Comparison:
+            return node.position.start <= offset && offset <= node.position.end;
+        // default case avoids ambiguity by having the cursor in the [excluded, included] range
+        default:
+            return node.position.start < offset && offset <= node.position.end;
+    }
+}
+function size(node) {
+    return node.position.end - node.position.start;
+}
+function isUnclosed(node) {
+    if ('blockEndPosition' in node) {
+        return node.blockEndPosition?.end === -1;
+    }
+    else if ('children' in node) {
+        return node.children.length > 0;
+    }
+    return false;
+}
+function findJSONNode(ast, cursorPosition) {
+    let prev;
+    let current = ast;
+    let ancestors = [];
+    const offset = cursorPosition;
+    while (current !== prev) {
+        prev = current;
+        forEachChildNodes(current, ancestors.concat(current), (child, lineage) => {
+            if (child.loc.start.offset <= offset && offset < child.loc.end.offset) {
+                current = child;
+                ancestors = lineage;
+            }
+        });
+    }
+    return [current, ancestors];
+}
+//# sourceMappingURL=visitor.js.map

package/dist/visitor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"visitor.js","sourceRoot":"","sources":["../src/visitor.ts"],"names":[],"mappings":";;AAiCA,sBA8BC;AAED,8CAcC;AAED,0CA0BC;AAiCD,oCAoBC;AAhKD,uEAAkF;AAalF,SAAS,MAAM,CAA2B,CAAM;IAC9C,OAAO,CAAC,KAAK,IAAI,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,OAAO,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC;AAC3E,CAAC;AAID;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,KAAK,CACzB,IAAY,EACZ,OAAsB;IAEtB,MAAM,OAAO,GAAQ,EAAE,CAAC;IACxB,MAAM,KAAK,GAA0C,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;IAC7E,MAAM,SAAS,GAAG,CAAC,IAAY,EAAE,OAAiB,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC;IAErF,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,qBAAqB;QACrB,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC,GAAG,EAGlC,CAAC;QAEF,MAAM,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,IAA2B,CAAC,CAAC;QAC5D,MAAM,MAAM,GAAG,SAAS;YACtB,CAAC,CAAC,MAAM,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,IAAmC,EAAE,OAAO,CAAC,CAAC;YAChF,CAAC,CAAC,SAAS,CAAC;QACd,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1B,OAAO,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAC;QAC1B,CAAC;aAAM,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACvB,CAAC;QAED,sBAAsB;QACtB,iBAAiB,CAAC,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,SAAS,CAAC,CAAC;IAC3D,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAgB,iBAAiB,CAC/B,IAAY,EACZ,OAAiB,EACjB,OAA2B;IAE3B,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;QACxC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,KAAK,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC3C,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;YAC7B,CAAC;QACH,CAAC;aAAM,IAAI,MAAM,CAAI,KAAK,CAAC,EAAE,CAAC;YAC5B,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QAC1B,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAgB,eAAe,CAC7B,GAAmB,EACnB,cAAsB;IAEtB,IAAI,IAAgC,CAAC;IACrC,IAAI,OAAO,GAAmB,GAAG,CAAC;IAClC,IAAI,SAAS,GAAqB,EAAE,CAAC;IAErC,OAAO,OAAO,KAAK,IAAI,EAAE,CAAC;QACxB,IAAI,GAAG,OAAO,CAAC;QACf,iBAAiB,CACf,OAAO,EACP,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,EACzB,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;YACjB,IACE,UAAU,CAAC,KAAK,CAAC;gBACjB,CAAC,SAAS,CAAC,KAAK,EAAE,cAAc,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC,EAClE,CAAC;gBACD,OAAO,GAAG,KAAK,CAAC;gBAChB,SAAS,GAAG,OAAO,CAAC;YACtB,CAAC;QACH,CAAC,CACF,CAAC;IACJ,CAAC;IAED,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;AAC9B,CAAC;AAED,SAAS,SAAS,CAAC,IAAoB,EAAE,MAAc;IACrD,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,wCAAwC;QACxC,KAAK,8BAAmB,CAAC,MAAM,CAAC;QAChC,iCAAiC;QACjC,KAAK,8BAAmB,CAAC,cAAc,CAAC;QACxC,2CAA2C;QAC3C,KAAK,8BAAmB,CAAC,iBAAiB,CAAC;QAC3C,yCAAyC;QACzC,KAAK,8BAAmB,CAAC,UAAU;YACjC,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,IAAI,MAAM,IAAI,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;QAEtE,uFAAuF;QACvF;YACE,OAAO,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,MAAM,IAAI,MAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;IACvE,CAAC;AACH,CAAC;AAED,SAAS,IAAI,CAAC,IAAoB;IAChC,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;AACjD,CAAC;AAED,SAAS,UAAU,CAAC,IAAoB;IACtC,IAAI,kBAAkB,IAAI,IAAI,EAAE,CAAC;QAC/B,OAAO,IAAI,CAAC,gBAAgB,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;IAC3C,CAAC;SAAM,IAAI,UAAU,IAAI,IAAI,EAAE,CAAC;QAC9B,OAAO,IAAI,CAAC,QAAS,CAAC,MAAM,GAAG,CAAC,CAAC;IACnC,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAgB,YAAY,CAC1B,GAAa,EACb,cAAsB;IAEtB,IAAI,IAA0B,CAAC;IAC/B,IAAI,OAAO,GAAa,GAAG,CAAC;IAC5B,IAAI,SAAS,GAAe,EAAE,CAAC;IAC/B,MAAM,MAAM,GAAG,cAAc,CAAC;IAE9B,OAAO,OAAO,KAAK,IAAI,EAAE,CAAC;QACxB,IAAI,GAAG,OAAO,CAAC;QACf,iBAAiB,CAAsB,OAAO,EAAE,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE;YAC5F,IAAI,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,IAAI,MAAM,IAAI,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC;gBACtE,OAAO,GAAG,KAAK,CAAC;gBAChB,SAAS,GAAG,OAAO,CAAC;YACtB,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;AAC9B,CAAC"}

package/dist/visitors/index.d.ts

@@ -0,0 +1,2 @@
+export { visitLiquid } from './liquid';
+export { visitJSON } from './json';

package/dist/visitors/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.visitJSON = exports.visitLiquid = void 0;
+var liquid_1 = require("./liquid");
+Object.defineProperty(exports, "visitLiquid", { enumerable: true, get: function () { return liquid_1.visitLiquid; } });
+var json_1 = require("./json");
+Object.defineProperty(exports, "visitJSON", { enumerable: true, get: function () { return json_1.visitJSON; } });
+//# sourceMappingURL=index.js.map

package/dist/visitors/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/visitors/index.ts"],"names":[],"mappings":";;;AAAA,mCAAuC;AAA9B,qGAAA,WAAW,OAAA;AACpB,+BAAmC;AAA1B,iGAAA,SAAS,OAAA"}

package/dist/visitors/json.d.ts

@@ -0,0 +1,2 @@
+import { JSONNode, JSONCheck } from '../types';
+export declare function visitJSON(node: JSONNode, check: JSONCheck): Promise<void>;

package/dist/visitors/json.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.visitJSON = visitJSON;
+function isJSONNode(thing) {
+    return !!thing && typeof thing === 'object' && 'type' in thing;
+}
+const nonTraversableProperties = new Set(['loc']);
+async function visitJSON(node, check) {
+    const stack = [{ node, ancestors: [] }];
+    let method;
+    while (stack.length > 0) {
+        const { node, ancestors } = stack.pop();
+        const lineage = ancestors.concat(node);
+        method = check[node.type];
+        if (method)
+            await method(node, ancestors);
+        for (const key in node) {
+            if (!node.hasOwnProperty(key) || nonTraversableProperties.has(key)) {
+                continue;
+            }
+            const value = node[key];
+            if (Array.isArray(value)) {
+                for (let i = value.length - 1; i >= 0; i--) {
+                    const item = value[i];
+                    if (isJSONNode(item)) {
+                        stack.push({ node: item, ancestors: lineage });
+                    }
+                }
+            }
+            else if (isJSONNode(value)) {
+                stack.push({ node: value, ancestors: lineage });
+            }
+        }
+        method = check[`${node.type}:exit`];
+        if (method)
+            await method(node, ancestors);
+    }
+}
+//# sourceMappingURL=json.js.map

package/dist/visitors/json.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"json.js","sourceRoot":"","sources":["../../src/visitors/json.ts"],"names":[],"mappings":";;AAQA,8BAgCC;AAtCD,SAAS,UAAU,CAAC,KAAc;IAChC,OAAO,CAAC,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,IAAI,KAAK,CAAC;AACjE,CAAC;AAED,MAAM,wBAAwB,GAAG,IAAI,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;AAE3C,KAAK,UAAU,SAAS,CAAC,IAAc,EAAE,KAAgB;IAC9D,MAAM,KAAK,GAAgD,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,CAAC;IACrF,IAAI,MAA6D,CAAC;IAElE,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,KAAK,CAAC,GAAG,EAAG,CAAC;QACzC,MAAM,OAAO,GAAG,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAEvC,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1B,IAAI,MAAM;YAAE,MAAM,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QAE1C,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,wBAAwB,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBACnE,SAAS;YACX,CAAC;YAED,MAAM,KAAK,GAAG,IAAI,CAAC,GAAqB,CAAC,CAAC;YAC1C,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,KAAK,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;oBAC3C,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;oBACtB,IAAI,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;wBACrB,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,CAAC;oBACjD,CAAC;gBACH,CAAC;YACH,CAAC;iBAAM,IAAI,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC7B,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,CAAC;YAClD,CAAC;QACH,CAAC;QAED,MAAM,GAAG,KAAK,CAAC,GAAG,IAAI,CAAC,IAAI,OAAO,CAAC,CAAC;QACpC,IAAI,MAAM;YAAE,MAAM,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IAC5C,CAAC;AACH,CAAC"}

package/dist/visitors/liquid.d.ts

@@ -0,0 +1,2 @@
+import { LiquidHtmlNode, LiquidCheck } from '../types';
+export declare function visitLiquid(node: LiquidHtmlNode, check: LiquidCheck): Promise<void>;

package/dist/visitors/liquid.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.visitLiquid = visitLiquid;
+const liquid_html_parser_1 = require("@platformos/liquid-html-parser");
+function isLiquidHtmlNode(thing) {
+    return !!thing && typeof thing === 'object' && 'type' in thing;
+}
+async function visitLiquid(node, check) {
+    const stack = [{ node, ancestors: [] }];
+    let method;
+    while (stack.length > 0) {
+        const { node, ancestors } = stack.pop();
+        const lineage = ancestors.concat(node);
+        method = check[node.type];
+        if (method)
+            await method(node, ancestors);
+        for (const key in node) {
+            if (!node.hasOwnProperty(key) || liquid_html_parser_1.nonTraversableProperties.has(key)) {
+                continue;
+            }
+            const value = node[key];
+            if (Array.isArray(value)) {
+                for (let i = value.length - 1; i >= 0; i--) {
+                    const item = value[i];
+                    if (isLiquidHtmlNode(item)) {
+                        stack.push({ node: item, ancestors: lineage });
+                    }
+                }
+            }
+            else if (isLiquidHtmlNode(value)) {
+                stack.push({ node: value, ancestors: lineage });
+            }
+        }
+        method = check[`${node.type}:exit`];
+        if (method)
+            await method(node, ancestors);
+    }
+}
+//# sourceMappingURL=liquid.js.map

package/dist/visitors/liquid.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"liquid.js","sourceRoot":"","sources":["../../src/visitors/liquid.ts"],"names":[],"mappings":";;AAOA,kCAgCC;AAvCD,uEAA0E;AAG1E,SAAS,gBAAgB,CAAC,KAAc;IACtC,OAAO,CAAC,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,IAAI,KAAK,CAAC;AACjE,CAAC;AAEM,KAAK,UAAU,WAAW,CAAC,IAAoB,EAAE,KAAkB;IACxE,MAAM,KAAK,GAA4D,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,CAAC;IACjG,IAAI,MAAmE,CAAC;IAExE,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,KAAK,CAAC,GAAG,EAAG,CAAC;QACzC,MAAM,OAAO,GAAG,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAEvC,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1B,IAAI,MAAM;YAAE,MAAM,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QAE1C,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,IAAI,6CAAwB,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;gBACnE,SAAS;YACX,CAAC;YAED,MAAM,KAAK,GAAG,IAAI,CAAC,GAA2B,CAAC,CAAC;YAChD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,KAAK,IAAI,CAAC,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;oBAC3C,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;oBACtB,IAAI,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;wBAC3B,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,CAAC;oBACjD,CAAC;gBACH,CAAC;YACH,CAAC;iBAAM,IAAI,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;gBACnC,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,CAAC;YAClD,CAAC;QACH,CAAC;QAED,MAAM,GAAG,KAAK,CAAC,GAAG,IAAI,CAAC,IAAI,OAAO,CAAC,CAAC;QACpC,IAAI,MAAM;YAAE,MAAM,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IAC5C,CAAC;AACH,CAAC"}

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@platformos/platformos-check-common",
+  "version": "0.0.2",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "author": "platformOS",
+  "homepage": "https://github.com/Platform-OS/platformos-tools/tree/main/packages/platformos-check-common#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Platform-OS/platformos-tools.git",
+    "directory": "packages/platformos-check-common"
+  },
+  "bugs": {
+    "url": "https://github.com/Platform-OS/platformos-tools/issues"
+  },
+  "publishConfig": {
+    "access": "public",
+    "@platformos:registry": "https://registry.npmjs.org"
+  },
+  "scripts": {
+    "build": "yarn build:ts",
+    "build:ci": "yarn build",
+    "build:ts": "tsc -b tsconfig.build.json",
+    "test": "vitest",
+    "type-check": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@platformos/liquid-html-parser": "0.0.2",
+    "cross-fetch": "^4.0.0",
+    "graphql": "^16.12.0",
+    "js-yaml": "^3.14.1",
+    "jsonc-parser": "^3.2.0",
+    "line-column": "^1.0.2",
+    "lodash": "^4.17.21",
+    "minimatch": "^9.0.1",
+    "vscode-json-languageservice": "^5.3.10",
+    "vscode-uri": "^3.0.7"
+  },
+  "devDependencies": {
+    "@types/js-yaml": "^4.0.9",
+    "@types/line-column": "^1.0.0",
+    "@types/lodash": "^4.17.20"
+  }
+}

package/src/AugmentedThemeDocset.spec.ts

@@ -0,0 +1,148 @@
+import { describe, beforeEach, it, expect } from 'vitest';
+import { AugmentedThemeDocset } from './AugmentedThemeDocset';
+import { ThemeDocset } from './types';
+
+describe('Module: AugmentedThemeDocset', async () => {
+  let themeDocset: ThemeDocset;
+
+  beforeEach(async () => {
+    themeDocset = new AugmentedThemeDocset({
+      graphQL: async () => null,
+      filters: async () => [],
+      objects: async () => [
+        {
+          name: 'test-object',
+          access: {
+            global: false,
+            parents: [],
+            template: [],
+          },
+        },
+        {
+          name: 'deprecated-test-object',
+          deprecated: true,
+          access: {
+            global: false,
+            parents: [],
+            template: [],
+          },
+        },
+        {
+          name: 'exclusive-global-test-object',
+          access: {
+            global: true,
+            parents: [],
+            template: [],
+          },
+        },
+        {
+          name: 'global-test-object-with-parents',
+          access: {
+            global: true,
+            parents: [
+              {
+                object: 'parent-test-object',
+                property: 'parent-property',
+              },
+            ],
+            template: [],
+          },
+        },
+      ],
+      liquidDrops: async () => [],
+      tags: async () => [],
+      systemTranslations: async () => ({}),
+    });
+  });
+
+  describe('filters', async () => {
+    it('should return filters with undocumented filters', async () => {
+      const filters = await themeDocset.filters();
+
+      expect(filters).to.have.length.greaterThanOrEqual(30);
+    });
+
+    it('should return valid filter entries', async () => {
+      const filters = await themeDocset.filters();
+
+      expect(filters).to.deep.include({ name: 'h' });
+    });
+  });
+
+  describe('objects', async () => {
+    it('should return objects with undocumented objects', async () => {
+      const objects = await themeDocset.objects();
+
+      expect(objects).to.have.length.greaterThanOrEqual(15);
+    });
+
+    it('should return valid object entries', async () => {
+      const objects = await themeDocset.objects();
+
+      expect(objects).to.deep.include({ name: 'customer_address' });
+      expect(objects).to.deep.include({
+        name: 'locale',
+        access: {
+          global: false,
+          parents: [],
+          template: [],
+        },
+        return_type: [
+          {
+            type: 'string',
+            name: '',
+          },
+        ],
+      });
+    });
+  });
+
+  describe('liquidDrops', async () => {
+    it('should return non-deprecated objects', async () => {
+      const objects = await themeDocset.liquidDrops();
+
+      expect(objects).to.have.lengthOf(2);
+      expect(objects).to.deep.include({
+        name: 'test-object',
+        access: {
+          global: false,
+          parents: [],
+          template: [],
+        },
+      });
+    });
+
+    it("should return objects that aren't exclusively global", async () => {
+      const objects = await themeDocset.liquidDrops();
+
+      expect(objects).to.have.lengthOf(2);
+      expect(objects).to.deep.include({
+        name: 'global-test-object-with-parents',
+        access: {
+          global: true,
+          parents: [
+            {
+              object: 'parent-test-object',
+              property: 'parent-property',
+            },
+          ],
+          template: [],
+        },
+      });
+    });
+  });
+
+  describe('tags', async () => {
+    it('should return tags with undocumented tags', async () => {
+      const tags = await themeDocset.tags();
+
+      expect(tags).have.length.greaterThanOrEqual(4);
+    });
+
+    it('should return valid tag entries', async () => {
+      const tags = await themeDocset.tags();
+
+      expect(tags).to.deep.include({ name: 'elsif' });
+    });
+  });
+});

package/src/AugmentedThemeDocset.ts

@@ -0,0 +1,148 @@
+import {
+  Access,
+  FilterEntry,
+  ObjectEntry,
+  TagEntry,
+  ThemeDocset,
+  Translations,
+  ReturnType,
+} from './types';
+import { memo } from './utils';
+
+const toFilterEntry = (name: string): FilterEntry => ({ name });
+const aliasedFilters: [string, string][] = [
+  ['camelcase', 'camelize'],
+  ['handle', 'handleize'],
+  ['t', 'translate'],
+];
+
+const toAliasedFilterEntry =
+  (entries: FilterEntry[]) =>
+  ([alias, baseName]: [string, string]): FilterEntry => {
+    const baseEntry = entries.find((entry) => entry.name === baseName);
+    if (!baseEntry) {
+      return toFilterEntry(alias);
+    }
+    return {
+      ...baseEntry,
+      name: alias,
+    };
+  };
+
+const undocumentedFilters = [
+  '_online_store_editor_live_setting',
+  'addresses_url',
+  'app_block_path?',
+  'app_block_path_for',
+  'app_extension_path?',
+  'app_snippet_path?',
+  'cancel_customer_order_link',
+  'debug',
+  'delete_customer_address_link',
+  'dev_shop?',
+  'distance_from',
+  'edit_customer_address_link',
+  'encode_url_component',
+  'excerpt',
+  'format_code',
+  'global_block_type?',
+  'h',
+  'handle_from',
+  'installments_pricing',
+  'link_to_theme',
+  'login_button',
+  'login_url',
+  'logout_url',
+  'pad_spaces',
+  'paragraphize',
+  'recover_password_link',
+  'recover_url',
+  'register_url',
+  'registration_uuid_from',
+  'root_account_url',
+  'sentence',
+  'theme_url',
+  'unit',
+  'weight',
+];
+
+const undocumentedObjectEntryKeys = [
+  'locale',
+  'direction',
+  'skip_to_content_link',
+  'checkout_html_classes',
+  'checkout_stylesheets',
+  'checkout_scripts',
+  'content_for_logo',
+  'breadcrumb',
+  'order_summary_toggle',
+  'content_for_order_summary',
+  'alternative_payment_methods',
+  'content_for_footer',
+  'tracking_code',
+];
+
+const toObjectEntry = (name: string, access?: Access, returnType?: ReturnType[]): ObjectEntry => ({
+  name,
+  ...(access && { access }),
+  ...(returnType && { return_type: returnType }),
+});
+
+const undocumentedObjects = ['customer_address', 'product_variant'];
+const legacyCheckoutEntries: ObjectEntry[] = undocumentedObjectEntryKeys.map((objectKey) =>
+  toObjectEntry(objectKey, { global: false, parents: [], template: [] }, [
+    { type: 'string', name: '' },
+  ]),
+);
+
+const toTagEntry = (name: string): TagEntry => ({ name });
+const undocumentedTags = ['elsif', 'ifchanged', 'when', 'schema'];
+
+export class AugmentedThemeDocset implements ThemeDocset {
+  constructor(private themeDocset: ThemeDocset) {}
+  graphQL = memo(async (): Promise<string | null> => {
+    return await this.themeDocset.graphQL();
+  });
+
+  public isAugmented = true;
+
+  filters = memo(async (): Promise<FilterEntry[]> => {
+    const officialFilters = await this.themeDocset.filters();
+    return [
+      ...officialFilters,
+      ...aliasedFilters.map(toAliasedFilterEntry(officialFilters)),
+      ...undocumentedFilters.map(toFilterEntry),
+    ];
+  });
+
+  objects = memo(async (): Promise<ObjectEntry[]> => {
+    return [
+      ...(await this.themeDocset.objects()),
+      ...undocumentedObjects.map((obj) => toObjectEntry(obj)),
+      ...legacyCheckoutEntries,
+    ];
+  });
+
+  liquidDrops = memo(async (): Promise<ObjectEntry[]> => {
+    return (await this.themeDocset.objects()).filter((obj) => {
+      if (!obj.access) {
+        return true;
+      }
+
+      if (obj.deprecated) {
+        return false;
+      }
+
+      // objects that are accessible outside Global context
+      return !obj.access.global || (obj.access.global && obj.access.parents.length > 0);
+    });
+  });
+
+  tags = memo(async (): Promise<TagEntry[]> => {
+    return [...(await this.themeDocset.tags()), ...undocumentedTags.map(toTagEntry)];
+  });
+
+  systemTranslations = memo(async (): Promise<Translations> => {
+    return this.themeDocset.systemTranslations();
+  });
+}