@platformos/platformos-graph 0.0.2

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# shopify/theme-graph
+
+## 0.0.2
+
+### Patch Changes
+
+- Beta release
+- Updated dependencies
+  - @platformos/liquid-html-parser@0.0.2
+  - @platformos/platformos-check-common@0.0.2

package/README.md

@@ -0,0 +1,83 @@
+<h1 align="center" style="position: relative;" >
+  <br>
+    <img src="https://github.com/Platform-OS/platformos-tools/blob/main/packages/vscode-extension/images/platformos_logo.png?raw=true" alt="platformOS logo" width="200">
+  <br>
+  platformOS Graph
+</h1>
+
+<h4 align="center">A data structure that represents your platformOS application</h4>
+
+A platformOS Graph is a data structure that spans Liquid, JSON, JavaScript and CSS files.
+
+It has the following interface:
+
+```ts
+interface ThemeGraph {
+  rootUri: UriString; // e.g. 'file:/path/to/horizon'
+  entryPoints: ThemeModule[];
+  modules: Record<UriString, ThemeModule>
+}
+```
+
+A `ThemeModule` holds _dependencies_ and _references_ of a module. For instance,
+
+```ts
+interface LiquidModule {
+  uri: UriString;
+  type: 'liquid';
+  kind: 'block' | 'layout' | 'section' | 'snippet' | 'template';
+  references: Reference[];
+  dependencies: Reference[];
+}
+```
+
+For a module $M$,
+- a _reference_ is a backlink to _other_ modules that depend on $M$,
+- a _dependency_ is a dependent link on another module.
+
+```ts
+interface Reference {
+  /* The file that initiated the dependency/reference */
+  source: { uri: string, range?: Range };
+
+  /* The file that it points to */
+  target: { uri: string, range?: Range };
+
+  type:
+    | 'direct'   // e.g. {% render 'child' %}, {{ 'theme.js' | asset_url }}, <custom-element>, etc.
+    | 'indirect' // e.g. Sections and blocks that accept theme blocks
+    | 'preset'   // e.g. Section and block presets
+}
+```
+
+See [types.md](./src/types.ts) for more details and [how-it-works.md](./docs/how-it-works.md) for an overview of the algorithm.
+
+## Installation
+
+```bash
+npm install @platformos/theme-graph
+```
+
+## Usage
+
+### Through the VS Code extension
+
+The theme graph is used by the VS Code extension to power the dependencies, references and dead code features.
+
+### From the CLI
+
+```
+Usage:
+  theme-graph <path-to-theme-directory>
+
+Example:
+  theme-graph horizon > graph.json
+```
+
+### As a library
+
+[See bin/theme-graph](./bin/theme-graph) for inspiration.
+
+## Contributing
+
+See [CONTRIBUTING.md](../../docs/contributing.md).

package/bin/jsconfig.json

@@ -0,0 +1,18 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "commonjs",
+    "checkJs": true,
+    "strict": true,
+    "baseUrl": ".",
+    "paths": {
+      "@platformos/platformos-graph": ["../src"],
+      "@platformos/platformos-check-common": ["../../platformos-check-common/src"]
+    },
+    "allowJs": true,
+    "noEmit": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true
+  },
+  "files": ["./platformos-graph"]
+}

package/bin/platformos-graph

@@ -0,0 +1,107 @@
+#!/usr/bin/env node
+
+const { buildThemeGraph, serializeThemeGraph, toSourceCode } = require('@platformos/theme-graph');
+const {
+  NodeFileSystem,
+  memoize,
+  toSchema,
+  path: pathUtils,
+  recursiveReadDirectory,
+} = require('@platformos/theme-check-node');
+const path = require('path');
+const { URI } = require('vscode-uri');
+
+const usage = `
+Usage:
+  theme-graph <path-to-theme-directory>
+
+Example:
+  theme-graph horizon > graph.json
+`;
+
+const identity = (/** @type {any} */ x) => x;
+
+/**
+ * Outputs the JSON representing the theme graph for a Shopify theme directory.
+ *
+ * @param {string} root
+ */
+async function main(root) {
+  if (!root) {
+    console.error(usage);
+    process.exit(1);
+  }
+
+  if (!path.isAbsolute(root)) {
+    root = path.resolve(process.cwd(), root);
+  }
+
+  const getSourceCode = makeGetSourceCode();
+
+  // Preload files to get a sense of what is slow
+  const fs = NodeFileSystem;
+  const rootUri = URI.file(root).toString(true);
+  const filesToPreload = await recursiveReadDirectory(fs, rootUri, ([uri]) =>
+    ['.json', '.liquid'].some((ext) => uri.endsWith(ext)),
+  );
+  await bench('Preloading files', async () => {
+    await Promise.all(
+      filesToPreload.map(async (uri) => {
+        await getSourceCode(uri);
+      }),
+    );
+  });
+
+  /** @type {import('@platformos/theme-graph').WebComponentMap} */
+  const webComponentDefs = new Map();
+
+  /** @type {import('@platformos/theme-graph').Dependencies} */
+  const dependencies = {
+    fs,
+    // @ts-ignore
+    getSectionSchema: memoize(async (name) => {
+      const uri = pathUtils.join(rootUri, 'sections', `${name}.liquid`);
+      const sourceCode = await getSourceCode(uri);
+      return toSchema('theme', uri, /** @type {any} */ (sourceCode), async () => true);
+    }, identity),
+    // @ts-ignore
+    getBlockSchema: memoize(async (name) => {
+      const uri = pathUtils.join(rootUri, 'blocks', `${name}.liquid`);
+      const sourceCode = await getSourceCode(uri);
+      return toSchema('theme', uri, /** @type {any} */ (sourceCode), async () => true);
+    }, identity),
+    getSourceCode,
+    getWebComponentDefinitionReference: (customElementName) =>
+      webComponentDefs.get(customElementName),
+  };
+
+  // Build graph
+  const graph = await bench('Build graph', () => buildThemeGraph(rootUri, dependencies));
+
+  // Serialize into JSON
+  const serializedGraph = serializeThemeGraph(graph);
+
+  // Print result to STDOUT
+  console.log(JSON.stringify(serializedGraph));
+}
+
+function makeGetSourceCode() {
+  return memoize(async function getSourceCode(uri) {
+    const source = await NodeFileSystem.readFile(uri);
+    return await toSourceCode(URI.file(uri).toString(), source);
+  }, identity);
+}
+
+/**
+ * @param {string} name
+ * @param {(...args: any[]) => Promise<any>} fn
+ */
+async function bench(name, fn) {
+  const start = performance.now();
+  const result = await fn();
+  const end = performance.now();
+  console.error(`${name} took ${end - start}ms`);
+  return result;
+}
+
+main(process.argv[2]);

package/dist/getWebComponentMap.d.ts

@@ -0,0 +1,10 @@
+import { Dependencies, Void, WebComponentMap } from './types';
+/**
+ * Find all the web component definitions from the JavaScript files in the
+ * assets directory.
+ *
+ * From those, we'll be able to map `<custom-element-name>` to the definition in
+ * the corresponding asset file.
+ */
+export declare function getWebComponentMap(rootUri: string, { fs, getSourceCode }: Pick<Dependencies, 'fs' | 'getSourceCode'>): Promise<WebComponentMap>;
+export declare function findWebComponentReferences(uri: string, assetRoot: string, getSourceCode: Dependencies['getSourceCode'], result: WebComponentMap): Promise<Void>;

package/dist/getWebComponentMap.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getWebComponentMap = getWebComponentMap;
+exports.findWebComponentReferences = findWebComponentReferences;
+const platformos_check_common_1 = require("@platformos/platformos-check-common");
+const acorn_walk_1 = require("acorn-walk");
+/**
+ * Regular expression for web component names
+ *
+ * Based on the HTML specification for valid custom element names.
+ *
+ * https://html.spec.whatwg.org/multipage/custom-elements.html#valid-custom-element-name
+ */
+const wcre = /^[a-z][-.\d_a-z\u00B7\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u037D\u037F-\u1FFF\u200C-\u200D\u203F-\u2040\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD]*([-][-.\d_a-z\u00B7\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u037D\u037F-\u1FFF\u200C-\u200D\u203F-\u2040\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD]*)$/u;
+/**
+ * Find all the web component definitions from the JavaScript files in the
+ * assets directory.
+ *
+ * From those, we'll be able to map `<custom-element-name>` to the definition in
+ * the corresponding asset file.
+ */
+async function getWebComponentMap(rootUri, { fs, getSourceCode }) {
+    const webComponentDefs = new Map();
+    const assetRoot = platformos_check_common_1.path.join(rootUri, 'assets');
+    const jsFiles = await (0, platformos_check_common_1.recursiveReadDirectory)(fs, assetRoot, ([fileName]) => fileName.endsWith('.js'));
+    await Promise.all(jsFiles.map((uri) => findWebComponentReferences(uri, assetRoot, getSourceCode, webComponentDefs)));
+    return webComponentDefs;
+}
+async function findWebComponentReferences(uri, assetRoot, getSourceCode, result) {
+    const sourceCode = await getSourceCode(uri);
+    if (sourceCode.type !== 'javascript') {
+        return;
+    }
+    const ast = sourceCode.ast;
+    if (ast instanceof Error) {
+        return;
+    }
+    for (const node of ast.body) {
+        (0, acorn_walk_1.ancestor)(node, {
+            Literal(node, _state, ancestors) {
+                if (typeof node.value === 'string' && wcre.test(node.value)) {
+                    // Making sure we're looking at customElements.define calls
+                    const parentNode = ancestors.at(-2);
+                    if (!parentNode)
+                        return;
+                    if (parentNode.type !== 'CallExpression')
+                        return;
+                    const callee = parentNode.callee;
+                    if (callee.type !== 'MemberExpression')
+                        return;
+                    const property = callee.property;
+                    if (property.type !== 'Identifier')
+                        return;
+                    if (property.name !== 'define')
+                        return;
+                    result.set(node.value, {
+                        assetName: platformos_check_common_1.path.relative(uri, assetRoot),
+                        range: [property.start, node.end],
+                    });
+                }
+                return null;
+            },
+        });
+    }
+}
+//# sourceMappingURL=getWebComponentMap.js.map

package/dist/getWebComponentMap.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getWebComponentMap.js","sourceRoot":"","sources":["../src/getWebComponentMap.ts"],"names":[],"mappings":";;AAsBA,gDAiBC;AAED,gEAuCC;AAhFD,iFAAmF;AACnF,2CAA+C;AAI/C;;;;;;GAMG;AACH,MAAM,IAAI,GACR,+UAA+U,CAAC;AAElV;;;;;;GAMG;AACI,KAAK,UAAU,kBAAkB,CACtC,OAAe,EACf,EAAE,EAAE,EAAE,aAAa,EAA8C;IAEjE,MAAM,gBAAgB,GAAoB,IAAI,GAAG,EAAE,CAAC;IACpD,MAAM,SAAS,GAAG,8BAAI,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC/C,MAAM,OAAO,GAAG,MAAM,IAAA,gDAAsB,EAAC,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,EAAE,EAAE,CACzE,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CACzB,CAAC;IAEF,MAAM,OAAO,CAAC,GAAG,CACf,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAClB,0BAA0B,CAAC,GAAG,EAAE,SAAS,EAAE,aAAa,EAAE,gBAAgB,CAAC,CAC5E,CACF,CAAC;IAEF,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAEM,KAAK,UAAU,0BAA0B,CAC9C,GAAW,EACX,SAAiB,EACjB,aAA4C,EAC5C,MAAuB;IAEvB,MAAM,UAAU,GAAG,MAAM,aAAa,CAAC,GAAG,CAAC,CAAC;IAC5C,IAAI,UAAU,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;QACrC,OAAO;IACT,CAAC;IAED,MAAM,GAAG,GAAG,UAAU,CAAC,GAAG,CAAC;IAC3B,IAAI,GAAG,YAAY,KAAK,EAAE,CAAC;QACzB,OAAO;IACT,CAAC;IAED,KAAK,MAAM,IAAI,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC;QAC5B,IAAA,qBAAK,EAAC,IAAI,EAAE;YACV,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS;gBAC7B,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC5D,2DAA2D;oBAC3D,MAAM,UAAU,GAAG,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;oBACpC,IAAI,CAAC,UAAU;wBAAE,OAAO;oBACxB,IAAI,UAAU,CAAC,IAAI,KAAK,gBAAgB;wBAAE,OAAO;oBACjD,MAAM,MAAM,GAAI,UAA6B,CAAC,MAAM,CAAC;oBACrD,IAAI,MAAM,CAAC,IAAI,KAAK,kBAAkB;wBAAE,OAAO;oBAC/C,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;oBACjC,IAAI,QAAQ,CAAC,IAAI,KAAK,YAAY;wBAAE,OAAO;oBAC3C,IAAI,QAAQ,CAAC,IAAI,KAAK,QAAQ;wBAAE,OAAO;oBAEvC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE;wBACrB,SAAS,EAAE,8BAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,SAAS,CAAC;wBACxC,KAAK,EAAE,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC;qBAClC,CAAC,CAAC;gBACL,CAAC;gBACD,OAAO,IAAI,CAAC;YACd,CAAC;SACF,CAAC,CAAC;IACL,CAAC;AACH,CAAC"}

package/dist/graph/augment.d.ts

@@ -0,0 +1,2 @@
+import { AugmentedDependencies, IDependencies } from '../types';
+export declare function augmentDependencies(rootUri: string, ideps: IDependencies): AugmentedDependencies;

package/dist/graph/augment.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.augmentDependencies = augmentDependencies;
+const platformos_check_common_1 = require("@platformos/platformos-check-common");
+const toSourceCode_1 = require("../toSourceCode");
+const utils_1 = require("../utils");
+function augmentDependencies(rootUri, ideps) {
+    return {
+        fs: ideps.fs,
+        getBlockSchema: (0, platformos_check_common_1.memoize)(ideps.getBlockSchema, utils_1.identity),
+        getSectionSchema: (0, platformos_check_common_1.memoize)(ideps.getSectionSchema, utils_1.identity),
+        // parse at most once
+        getSourceCode: (0, platformos_check_common_1.memoize)(ideps.getSourceCode ??
+            async function defaultGetSourceCode(uri) {
+                const contents = await ideps.fs.readFile(uri);
+                return (0, toSourceCode_1.toSourceCode)(uri, contents);
+            }, utils_1.identity),
+        getWebComponentDefinitionReference: ideps.getWebComponentDefinitionReference,
+        getThemeBlockNames: (0, platformos_check_common_1.memo)(() => (0, platformos_check_common_1.recursiveReadDirectory)(ideps.fs, platformos_check_common_1.path.join(rootUri, 'blocks'), ([uri]) => uri.endsWith('.liquid')).then((uris) => uris.map((uri) => platformos_check_common_1.path.basename(uri, '.liquid')))),
+    };
+}
+//# sourceMappingURL=augment.js.map

package/dist/graph/augment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"augment.js","sourceRoot":"","sources":["../../src/graph/augment.ts"],"names":[],"mappings":";;AAUA,kDAuBC;AAjCD,iFAK6C;AAC7C,kDAA+C;AAE/C,oCAAoC;AAEpC,SAAgB,mBAAmB,CAAC,OAAe,EAAE,KAAoB;IACvE,OAAO;QACL,EAAE,EAAE,KAAK,CAAC,EAAE;QACZ,cAAc,EAAE,IAAA,iCAAO,EAAC,KAAK,CAAC,cAAc,EAAE,gBAAQ,CAAC;QACvD,gBAAgB,EAAE,IAAA,iCAAO,EAAC,KAAK,CAAC,gBAAgB,EAAE,gBAAQ,CAAC;QAE3D,qBAAqB;QACrB,aAAa,EAAE,IAAA,iCAAO,EACpB,KAAK,CAAC,aAAa;YACjB,KAAK,UAAU,oBAAoB,CAAC,GAAG;gBACrC,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;gBAC9C,OAAO,IAAA,2BAAY,EAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;YACrC,CAAC,EACH,gBAAQ,CACT;QAED,kCAAkC,EAAE,KAAK,CAAC,kCAAkC;QAC5E,kBAAkB,EAAE,IAAA,8BAAI,EAAC,GAAG,EAAE,CAC5B,IAAA,gDAAY,EAAC,KAAK,CAAC,EAAE,EAAE,8BAAI,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAC3F,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,8BAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC,CAC3D,CACF;KACF,CAAC;AACJ,CAAC"}

package/dist/graph/build.d.ts

@@ -0,0 +1,3 @@
+import { UriString } from '@platformos/platformos-check-common';
+import { IDependencies, ThemeGraph } from '../types';
+export declare function buildThemeGraph(rootUri: UriString, ideps: IDependencies, entryPoints?: UriString[]): Promise<ThemeGraph>;

package/dist/graph/build.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildThemeGraph = buildThemeGraph;
+const platformos_check_common_1 = require("@platformos/platformos-check-common");
+const augment_1 = require("./augment");
+const module_1 = require("./module");
+const traverse_1 = require("./traverse");
+async function buildThemeGraph(rootUri, ideps, entryPoints) {
+    const deps = (0, augment_1.augmentDependencies)(rootUri, ideps);
+    entryPoints =
+        entryPoints ??
+            (await (0, platformos_check_common_1.recursiveReadDirectory)(deps.fs, rootUri, ([uri]) => {
+                // Templates are entry points in the theme graph.
+                const isTemplateFile = uri.startsWith(platformos_check_common_1.path.join(rootUri, 'templates'));
+                // Since any section file can be rendered directly by the Section Rendering API,
+                // we consider all section files as entry points.
+                const isSectionFile = uri.startsWith(platformos_check_common_1.path.join(rootUri, 'sections')) && uri.endsWith('.liquid');
+                return isTemplateFile || isSectionFile;
+            }));
+    const graph = {
+        entryPoints: [],
+        modules: {},
+        rootUri,
+    };
+    graph.entryPoints = entryPoints
+        .map((uri) => (0, module_1.getModule)(graph, uri))
+        .filter((x) => x !== undefined);
+    await Promise.all(graph.entryPoints.map((entry) => (0, traverse_1.traverseModule)(entry, graph, deps)));
+    return graph;
+}
+//# sourceMappingURL=build.js.map

package/dist/graph/build.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"build.js","sourceRoot":"","sources":["../../src/graph/build.ts"],"names":[],"mappings":";;AAUA,0CAkCC;AA5CD,iFAI6C;AAE7C,uCAAgD;AAChD,qCAAqC;AACrC,yCAA4C;AAErC,KAAK,UAAU,eAAe,CACnC,OAAkB,EAClB,KAAoB,EACpB,WAAyB;IAEzB,MAAM,IAAI,GAAG,IAAA,6BAAmB,EAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAEjD,WAAW;QACT,WAAW;YACX,CAAC,MAAM,IAAA,gDAAY,EAAC,IAAI,CAAC,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE;gBAC9C,iDAAiD;gBACjD,MAAM,cAAc,GAAG,GAAG,CAAC,UAAU,CAAC,8BAAI,CAAC,IAAI,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC;gBAEvE,gFAAgF;gBAChF,iDAAiD;gBACjD,MAAM,aAAa,GACjB,GAAG,CAAC,UAAU,CAAC,8BAAI,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;gBAE5E,OAAO,cAAc,IAAI,aAAa,CAAC;YACzC,CAAC,CAAC,CAAC,CAAC;IAEN,MAAM,KAAK,GAAe;QACxB,WAAW,EAAE,EAAE;QACf,OAAO,EAAE,EAAE;QACX,OAAO;KACR,CAAC;IAEF,KAAK,CAAC,WAAW,GAAG,WAAW;SAC5B,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAA,kBAAS,EAAC,KAAK,EAAE,GAAG,CAAC,CAAC;SACnC,MAAM,CAAC,CAAC,CAAC,EAAoB,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC;IAEpD,MAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAA,yBAAc,EAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAExF,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/graph/module.d.ts

@@ -0,0 +1,10 @@
+import { UriString } from '@platformos/platformos-check-common';
+import { CssModule, ImageModule, JavaScriptModule, JsonModule, LiquidModule, SvgModule, ThemeGraph, ThemeModule } from '../types';
+export declare function getModule(themeGraph: ThemeGraph, uri: UriString): ThemeModule | undefined;
+export declare function getTemplateModule(themeGraph: ThemeGraph, uri: UriString): ThemeModule;
+export declare function getThemeBlockModule(themeGraph: ThemeGraph, blockType: string): LiquidModule;
+export declare function getSectionModule(themeGraph: ThemeGraph, sectionType: string): LiquidModule;
+export declare function getSectionGroupModule(themeGraph: ThemeGraph, sectionGroupType: string): JsonModule;
+export declare function getAssetModule(themeGraph: ThemeGraph, asset: string): JavaScriptModule | CssModule | SvgModule | ImageModule | undefined;
+export declare function getPartialModule(themeGraph: ThemeGraph, partial: string): LiquidModule;
+export declare function getLayoutModule(themeGraph: ThemeGraph, layoutName?: string | false | undefined): LiquidModule | undefined;

package/dist/graph/module.js

@@ -0,0 +1,181 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getModule = getModule;
+exports.getTemplateModule = getTemplateModule;
+exports.getThemeBlockModule = getThemeBlockModule;
+exports.getSectionModule = getSectionModule;
+exports.getSectionGroupModule = getSectionGroupModule;
+exports.getAssetModule = getAssetModule;
+exports.getPartialModule = getPartialModule;
+exports.getLayoutModule = getLayoutModule;
+const platformos_check_common_1 = require("@platformos/platformos-check-common");
+const types_1 = require("../types");
+const utils_1 = require("../utils");
+/**
+ * We're using a ModuleCache to prevent race conditions with traverse.
+ *
+ * e.g. if we have two modules that depend on the same 'assets/foo.js' file and
+ * that they somehow depend on it before it gets traversed (and thus added to the
+ * graphs' modules record), we want to avoid creating two different module objects
+ * that represent the same file.
+ *
+ * We're using a WeakMap<ThemeGraph> to cache modules so that if the theme graph
+ * gets garbage collected, the module cache will also be garbage collected.
+ *
+ * This allows us to have a module cache without changing the API of the
+ * ThemeGraph (no need for a `visited` property on modules, etc.)
+ */
+const ModuleCache = new WeakMap();
+function getModule(themeGraph, uri) {
+    const cache = getCache(themeGraph);
+    if (cache.has(uri)) {
+        return cache.get(uri);
+    }
+    const relativePath = platformos_check_common_1.path.relative(uri, themeGraph.rootUri);
+    switch (true) {
+        case relativePath.startsWith('assets'): {
+            return getAssetModule(themeGraph, platformos_check_common_1.path.basename(uri));
+        }
+        case relativePath.startsWith('blocks'): {
+            return getThemeBlockModule(themeGraph, platformos_check_common_1.path.basename(uri, '.liquid'));
+        }
+        case relativePath.startsWith('layout'): {
+            return getLayoutModule(themeGraph, platformos_check_common_1.path.basename(uri, '.liquid'));
+        }
+        case relativePath.startsWith('sections'): {
+            if (relativePath.endsWith('.json')) {
+                return getSectionGroupModule(themeGraph, platformos_check_common_1.path.basename(uri, '.json'));
+            }
+            return getSectionModule(themeGraph, platformos_check_common_1.path.basename(uri, '.liquid'));
+        }
+        case relativePath.includes('/views/partials') || relativePath.includes('/lib/'): {
+            return getPartialModule(themeGraph, platformos_check_common_1.path.basename(uri, '.liquid'));
+        }
+        case relativePath.startsWith('snippets'): {
+            return getPartialModule(themeGraph, platformos_check_common_1.path.basename(uri, '.liquid'));
+        }
+        case relativePath.startsWith('templates'): {
+            return getTemplateModule(themeGraph, uri);
+        }
+    }
+}
+function getTemplateModule(themeGraph, uri) {
+    const extension = (0, utils_1.extname)(uri);
+    switch (extension) {
+        case 'json': {
+            return module(themeGraph, {
+                type: "JSON" /* ModuleType.Json */,
+                kind: "template" /* JsonModuleKind.Template */,
+                dependencies: [],
+                references: [],
+                uri: uri,
+            });
+        }
+        case 'liquid': {
+            return module(themeGraph, {
+                type: "Liquid" /* ModuleType.Liquid */,
+                kind: "template" /* LiquidModuleKind.Template */,
+                dependencies: [],
+                references: [],
+                uri: uri,
+            });
+        }
+        default: {
+            throw new Error(`Unknown template type for ${uri}`);
+        }
+    }
+}
+function getThemeBlockModule(themeGraph, blockType) {
+    const uri = platformos_check_common_1.path.join(themeGraph.rootUri, 'blocks', `${blockType}.liquid`);
+    return module(themeGraph, {
+        type: "Liquid" /* ModuleType.Liquid */,
+        kind: "block" /* LiquidModuleKind.Block */,
+        dependencies: [],
+        references: [],
+        uri,
+    });
+}
+function getSectionModule(themeGraph, sectionType) {
+    const uri = platformos_check_common_1.path.join(themeGraph.rootUri, 'sections', `${sectionType}.liquid`);
+    return module(themeGraph, {
+        type: "Liquid" /* ModuleType.Liquid */,
+        kind: "section" /* LiquidModuleKind.Section */,
+        dependencies: [],
+        references: [],
+        uri,
+    });
+}
+function getSectionGroupModule(themeGraph, sectionGroupType) {
+    const uri = platformos_check_common_1.path.join(themeGraph.rootUri, 'sections', `${sectionGroupType}.json`);
+    return module(themeGraph, {
+        type: "JSON" /* ModuleType.Json */,
+        kind: "section-group" /* JsonModuleKind.SectionGroup */,
+        dependencies: [],
+        references: [],
+        uri,
+    });
+}
+function getAssetModule(themeGraph, asset) {
+    const extension = (0, utils_1.extname)(asset);
+    let type = undefined;
+    if (types_1.SUPPORTED_ASSET_IMAGE_EXTENSIONS.includes(extension)) {
+        type = "Image" /* ModuleType.Image */;
+    }
+    else if (extension === 'js') {
+        type = "JavaScript" /* ModuleType.JavaScript */;
+    }
+    else if (extension === 'css') {
+        type = "CSS" /* ModuleType.Css */;
+    }
+    else if (extension === 'svg') {
+        type = "SVG" /* ModuleType.Svg */;
+    }
+    if (!type) {
+        return undefined;
+    }
+    return module(themeGraph, {
+        type,
+        kind: 'unused',
+        dependencies: [],
+        references: [],
+        uri: platformos_check_common_1.path.join(themeGraph.rootUri, 'assets', asset),
+    });
+}
+function getPartialModule(themeGraph, partial) {
+    const uri = platformos_check_common_1.path.join(themeGraph.rootUri, 'app/views/partials', `${partial}.liquid`);
+    return module(themeGraph, {
+        type: "Liquid" /* ModuleType.Liquid */,
+        kind: "partial" /* LiquidModuleKind.Partial */,
+        uri: uri,
+        dependencies: [],
+        references: [],
+    });
+}
+function getLayoutModule(themeGraph, layoutName = 'theme') {
+    if (layoutName === false)
+        return undefined;
+    if (layoutName === undefined)
+        layoutName = 'theme';
+    const uri = platformos_check_common_1.path.join(themeGraph.rootUri, 'layout', `${layoutName}.liquid`);
+    return module(themeGraph, {
+        type: "Liquid" /* ModuleType.Liquid */,
+        kind: "layout" /* LiquidModuleKind.Layout */,
+        uri: uri,
+        dependencies: [],
+        references: [],
+    });
+}
+function getCache(themeGraph) {
+    if (!ModuleCache.has(themeGraph)) {
+        ModuleCache.set(themeGraph, new Map());
+    }
+    return ModuleCache.get(themeGraph);
+}
+function module(themeGraph, mod) {
+    const cache = getCache(themeGraph);
+    if (!cache.has(mod.uri)) {
+        cache.set(mod.uri, mod);
+    }
+    return cache.get(mod.uri);
+}
+//# sourceMappingURL=module.js.map

package/dist/graph/module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"module.js","sourceRoot":"","sources":["../../src/graph/module.ts"],"names":[],"mappings":";;AAiCA,8BAwCC;AAED,8CA2BC;AAED,kDASC;AAED,4CASC;AAED,sDAYC;AAED,wCA6BC;AAED,4CASC;AAED,0CAcC;AApMD,iFAAsE;AACtE,oCAakB;AAClB,oCAAmC;AAEnC;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,GAAkD,IAAI,OAAO,EAAE,CAAC;AAEjF,SAAgB,SAAS,CAAC,UAAsB,EAAE,GAAc;IAC9D,MAAM,KAAK,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC;IACnC,IAAI,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;QACnB,OAAO,KAAK,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC;IACzB,CAAC;IAED,MAAM,YAAY,GAAG,8BAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;IAE5D,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,YAAY,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;YACvC,OAAO,cAAc,CAAC,UAAU,EAAE,8BAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;QACxD,CAAC;QAED,KAAK,YAAY,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;YACvC,OAAO,mBAAmB,CAAC,UAAU,EAAE,8BAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC;QACxE,CAAC;QAED,KAAK,YAAY,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;YACvC,OAAO,eAAe,CAAC,UAAU,EAAE,8BAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC;QACpE,CAAC;QAED,KAAK,YAAY,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;YACzC,IAAI,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;gBACnC,OAAO,qBAAqB,CAAC,UAAU,EAAE,8BAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC;YACxE,CAAC;YACD,OAAO,gBAAgB,CAAC,UAAU,EAAE,8BAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC;QACrE,CAAC;QAED,KAAK,YAAY,CAAC,QAAQ,CAAC,iBAAiB,CAAC,IAAI,YAAY,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YAChF,OAAO,gBAAgB,CAAC,UAAU,EAAE,8BAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC;QACrE,CAAC;QAED,KAAK,YAAY,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;YACzC,OAAO,gBAAgB,CAAC,UAAU,EAAE,8BAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC;QACrE,CAAC;QAED,KAAK,YAAY,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;YAC1C,OAAO,iBAAiB,CAAC,UAAU,EAAE,GAAG,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAgB,iBAAiB,CAAC,UAAsB,EAAE,GAAc;IACtE,MAAM,SAAS,GAAG,IAAA,eAAO,EAAC,GAAG,CAAC,CAAC;IAC/B,QAAQ,SAAS,EAAE,CAAC;QAClB,KAAK,MAAM,CAAC,CAAC,CAAC;YACZ,OAAO,MAAM,CAAC,UAAU,EAAE;gBACxB,IAAI,8BAAiB;gBACrB,IAAI,0CAAyB;gBAC7B,YAAY,EAAE,EAAE;gBAChB,UAAU,EAAE,EAAE;gBACd,GAAG,EAAE,GAAG;aACT,CAAC,CAAC;QACL,CAAC;QAED,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,OAAO,MAAM,CAAC,UAAU,EAAE;gBACxB,IAAI,kCAAmB;gBACvB,IAAI,4CAA2B;gBAC/B,YAAY,EAAE,EAAE;gBAChB,UAAU,EAAE,EAAE;gBACd,GAAG,EAAE,GAAG;aACT,CAAC,CAAC;QACL,CAAC;QAED,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,IAAI,KAAK,CAAC,6BAA6B,GAAG,EAAE,CAAC,CAAC;QACtD,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAgB,mBAAmB,CAAC,UAAsB,EAAE,SAAiB;IAC3E,MAAM,GAAG,GAAG,8BAAI,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,GAAG,SAAS,SAAS,CAAC,CAAC;IAC3E,OAAO,MAAM,CAAC,UAAU,EAAE;QACxB,IAAI,kCAAmB;QACvB,IAAI,sCAAwB;QAC5B,YAAY,EAAE,EAAE;QAChB,UAAU,EAAE,EAAE;QACd,GAAG;KACJ,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,gBAAgB,CAAC,UAAsB,EAAE,WAAmB;IAC1E,MAAM,GAAG,GAAG,8BAAI,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,UAAU,EAAE,GAAG,WAAW,SAAS,CAAC,CAAC;IAC/E,OAAO,MAAM,CAAC,UAAU,EAAE;QACxB,IAAI,kCAAmB;QACvB,IAAI,0CAA0B;QAC9B,YAAY,EAAE,EAAE;QAChB,UAAU,EAAE,EAAE;QACd,GAAG;KACJ,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,qBAAqB,CACnC,UAAsB,EACtB,gBAAwB;IAExB,MAAM,GAAG,GAAG,8BAAI,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,UAAU,EAAE,GAAG,gBAAgB,OAAO,CAAC,CAAC;IAClF,OAAO,MAAM,CAAC,UAAU,EAAE;QACxB,IAAI,8BAAiB;QACrB,IAAI,mDAA6B;QACjC,YAAY,EAAE,EAAE;QAChB,UAAU,EAAE,EAAE;QACd,GAAG;KACJ,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,cAAc,CAC5B,UAAsB,EACtB,KAAa;IAEb,MAAM,SAAS,GAAG,IAAA,eAAO,EAAC,KAAK,CAAC,CAAC;IAEjC,IAAI,IAAI,GAA2B,SAAS,CAAC;IAE7C,IAAI,wCAAgC,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;QACzD,IAAI,iCAAmB,CAAC;IAC1B,CAAC;SAAM,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;QAC9B,IAAI,2CAAwB,CAAC;IAC/B,CAAC;SAAM,IAAI,SAAS,KAAK,KAAK,EAAE,CAAC;QAC/B,IAAI,6BAAiB,CAAC;IACxB,CAAC;SAAM,IAAI,SAAS,KAAK,KAAK,EAAE,CAAC;QAC/B,IAAI,6BAAiB,CAAC;IACxB,CAAC;IAED,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,MAAM,CAAC,UAAU,EAAE;QACxB,IAAI;QACJ,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,EAAE;QAChB,UAAU,EAAE,EAAE;QACd,GAAG,EAAE,8BAAI,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,KAAK,CAAC;KACpD,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,gBAAgB,CAAC,UAAsB,EAAE,OAAe;IACtE,MAAM,GAAG,GAAG,8BAAI,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,oBAAoB,EAAE,GAAG,OAAO,SAAS,CAAC,CAAC;IACrF,OAAO,MAAM,CAAC,UAAU,EAAE;QACxB,IAAI,kCAAmB;QACvB,IAAI,0CAA0B;QAC9B,GAAG,EAAE,GAAG;QACR,YAAY,EAAE,EAAE;QAChB,UAAU,EAAE,EAAE;KACf,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,eAAe,CAC7B,UAAsB,EACtB,aAAyC,OAAO;IAEhD,IAAI,UAAU,KAAK,KAAK;QAAE,OAAO,SAAS,CAAC;IAC3C,IAAI,UAAU,KAAK,SAAS;QAAE,UAAU,GAAG,OAAO,CAAC;IACnD,MAAM,GAAG,GAAG,8BAAI,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,GAAG,UAAU,SAAS,CAAC,CAAC;IAC5E,OAAO,MAAM,CAAC,UAAU,EAAE;QACxB,IAAI,kCAAmB;QACvB,IAAI,wCAAyB;QAC7B,GAAG,EAAE,GAAG;QACR,YAAY,EAAE,EAAE;QAChB,UAAU,EAAE,EAAE;KACf,CAAC,CAAC;AACL,CAAC;AAED,SAAS,QAAQ,CAAC,UAAsB;IACtC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;QACjC,WAAW,CAAC,GAAG,CAAC,UAAU,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;IACzC,CAAC;IACD,OAAO,WAAW,CAAC,GAAG,CAAC,UAAU,CAAE,CAAC;AACtC,CAAC;AAED,SAAS,MAAM,CAAwB,UAAsB,EAAE,GAAM;IACnE,MAAM,KAAK,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC;IACnC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;QACxB,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;IAC1B,CAAC;IACD,OAAO,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAO,CAAC;AAClC,CAAC"}

package/dist/graph/serialize.d.ts

@@ -0,0 +1,2 @@
+import { SerializableGraph, ThemeGraph } from '../types';
+export declare function serializeThemeGraph(graph: ThemeGraph): SerializableGraph;

package/dist/graph/serialize.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeThemeGraph = serializeThemeGraph;
+function serializeThemeGraph(graph) {
+    const nodes = Object.values(graph.modules).map((module) => ({
+        uri: module.uri,
+        type: module.type,
+        kind: module.kind,
+        ...('exists' in module ? { exists: module.exists } : {}),
+    }));
+    const edges = Object.values(graph.modules).flatMap((module) => module.dependencies);
+    return {
+        rootUri: graph.rootUri,
+        nodes,
+        edges,
+    };
+}
+//# sourceMappingURL=serialize.js.map

package/dist/graph/serialize.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"serialize.js","sourceRoot":"","sources":["../../src/graph/serialize.ts"],"names":[],"mappings":";;AAEA,kDAiBC;AAjBD,SAAgB,mBAAmB,CAAC,KAAiB;IACnD,MAAM,KAAK,GAAuB,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QAC9E,GAAG,EAAE,MAAM,CAAC,GAAG;QACf,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,GAAG,CAAC,QAAQ,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KACzD,CAAC,CAAC,CAAC;IAEJ,MAAM,KAAK,GAAuB,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,OAAO,CACpE,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,YAAY,CAChC,CAAC;IAEF,OAAO;QACL,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,KAAK;QACL,KAAK;KACN,CAAC;AACJ,CAAC"}

package/dist/graph/test-helpers.d.ts

@@ -0,0 +1,33 @@
+import { SectionSchema, ThemeBlockSchema } from '@platformos/platformos-check-common';
+import { AbstractFileSystem } from '@platformos/platformos-common';
+export declare function makeGetSourceCode(fs: AbstractFileSystem): {
+    (x: string): Promise<import("..").FileSourceCode>;
+    force(x: string): Promise<import("..").FileSourceCode>;
+    invalidate(x: string): void;
+    clearCache(): void;
+};
+export declare const fixturesRoot: string;
+export declare const skeleton: string;
+export declare function getDependencies(rootUri: string, fs?: AbstractFileSystem): Promise<{
+    fs: AbstractFileSystem;
+    getSectionSchema: {
+        (x: string): Promise<SectionSchema>;
+        force(x: string): Promise<SectionSchema>;
+        invalidate(x: string): void;
+        clearCache(): void;
+    };
+    getBlockSchema: {
+        (x: string): Promise<ThemeBlockSchema>;
+        force(x: string): Promise<ThemeBlockSchema>;
+        invalidate(x: string): void;
+        clearCache(): void;
+    };
+    getSourceCode: {
+        (x: string): Promise<import("..").FileSourceCode>;
+        force(x: string): Promise<import("..").FileSourceCode>;
+        invalidate(x: string): void;
+        clearCache(): void;
+    };
+    getWebComponentDefinitionReference: (customElementName: string) => import("..").WebComponentDefinition | undefined;
+}>;
+export declare function mockImpl(obj: any, method: any, callback: any): import("vitest").MockInstance<(this: unknown, ...args: unknown[]) => unknown>;