@platformos/platformos-graph 0.0.7 → 0.0.9

package/src/graph/module.ts

@@ -1,17 +1,12 @@
-import { path, UriString } from '@platformos/platformos-check-common';
+import { isLayout, isPage, isPartial, path, UriString } from '@platformos/platformos-check-common';
 import {
-  CssModule,
-  ImageModule,
-  JavaScriptModule,
-  JsonModule,
-  JsonModuleKind,
+  AssetModule,
+  AppGraph,
+  AppModule,
   LiquidModule,
   LiquidModuleKind,
   ModuleType,
   SUPPORTED_ASSET_IMAGE_EXTENSIONS,
-  SvgModule,
-  ThemeGraph,
-  ThemeModule,
 } from '../types';
 import { extname } from '../utils';
 
@@ -23,155 +18,68 @@ import { extname } from '../utils';
  * 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
+ * We're using a WeakMap<AppGraph> to cache modules so that if the app 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.)
+ * AppGraph (no need for a `visited` property on modules, etc.)
  */
-const ModuleCache: WeakMap<ThemeGraph, Map<string, ThemeModule>> = new WeakMap();
+const ModuleCache: WeakMap<AppGraph, Map<string, AppModule>> = new WeakMap();
 
-export function getModule(themeGraph: ThemeGraph, uri: UriString): ThemeModule | undefined {
-  const cache = getCache(themeGraph);
+export function getModule(appGraph: AppGraph, uri: UriString): AppModule | undefined {
+  const cache = getCache(appGraph);
   if (cache.has(uri)) {
     return cache.get(uri)!;
   }
 
-  const relativePath = path.relative(uri, themeGraph.rootUri);
+  const relativePath = path.relative(uri, appGraph.rootUri);
 
   switch (true) {
-    case relativePath.startsWith('assets'): {
-      return getAssetModule(themeGraph, path.basename(uri));
-    }
-
-    case relativePath.startsWith('blocks'): {
-      return getThemeBlockModule(themeGraph, path.basename(uri, '.liquid'));
-    }
-
-    case relativePath.startsWith('layout'): {
-      return getLayoutModule(themeGraph, path.basename(uri, '.liquid'));
-    }
-
-    case relativePath.startsWith('sections'): {
-      if (relativePath.endsWith('.json')) {
-        return getSectionGroupModule(themeGraph, path.basename(uri, '.json'));
-      }
-      return getSectionModule(themeGraph, path.basename(uri, '.liquid'));
-    }
-
-    case relativePath.includes('/views/partials') || relativePath.includes('/lib/'): {
-      return getPartialModule(themeGraph, path.basename(uri, '.liquid'));
-    }
-
-    case relativePath.startsWith('snippets'): {
-      return getPartialModule(themeGraph, path.basename(uri, '.liquid'));
-    }
-
-    case relativePath.startsWith('templates'): {
-      return getTemplateModule(themeGraph, uri);
-    }
-  }
-}
+    case isLayout(uri):
+      return getLayoutModule(appGraph, uri);
 
-export function getTemplateModule(themeGraph: ThemeGraph, uri: UriString): ThemeModule {
-  const extension = extname(uri);
-  switch (extension) {
-    case 'json': {
-      return module(themeGraph, {
-        type: ModuleType.Json,
-        kind: JsonModuleKind.Template,
-        dependencies: [],
-        references: [],
-        uri: uri,
-      });
-    }
-
-    case 'liquid': {
-      return module(themeGraph, {
-        type: ModuleType.Liquid,
-        kind: LiquidModuleKind.Template,
-        dependencies: [],
-        references: [],
-        uri: uri,
-      });
-    }
-
-    default: {
-      throw new Error(`Unknown template type for ${uri}`);
-    }
-  }
-}
+    case isPage(uri):
+      return getPageModule(appGraph, uri);
 
-export function getThemeBlockModule(themeGraph: ThemeGraph, blockType: string): LiquidModule {
-  const uri = path.join(themeGraph.rootUri, 'blocks', `${blockType}.liquid`);
-  return module(themeGraph, {
-    type: ModuleType.Liquid,
-    kind: LiquidModuleKind.Block,
-    dependencies: [],
-    references: [],
-    uri,
-  });
-}
-
-export function getSectionModule(themeGraph: ThemeGraph, sectionType: string): LiquidModule {
-  const uri = path.join(themeGraph.rootUri, 'sections', `${sectionType}.liquid`);
-  return module(themeGraph, {
-    type: ModuleType.Liquid,
-    kind: LiquidModuleKind.Section,
-    dependencies: [],
-    references: [],
-    uri,
-  });
-}
+    case isPartial(uri):
+      return getPartialModule(appGraph, path.basename(uri, '.liquid'));
 
-export function getSectionGroupModule(
-  themeGraph: ThemeGraph,
-  sectionGroupType: string,
-): JsonModule {
-  const uri = path.join(themeGraph.rootUri, 'sections', `${sectionGroupType}.json`);
-  return module(themeGraph, {
-    type: ModuleType.Json,
-    kind: JsonModuleKind.SectionGroup,
-    dependencies: [],
-    references: [],
-    uri,
-  });
+    case relativePath.startsWith('assets') || relativePath.startsWith('modules'):
+      return getAssetModule(appGraph, path.basename(uri));
+  }
 }
 
-export function getAssetModule(
-  themeGraph: ThemeGraph,
-  asset: string,
-): JavaScriptModule | CssModule | SvgModule | ImageModule | undefined {
+export function getAssetModule(appGraph: AppGraph, asset: string): AssetModule | undefined {
   const extension = extname(asset);
 
-  let type: ModuleType | undefined = undefined;
-
-  if (SUPPORTED_ASSET_IMAGE_EXTENSIONS.includes(extension)) {
-    type = ModuleType.Image;
-  } else if (extension === 'js') {
-    type = ModuleType.JavaScript;
-  } else if (extension === 'css') {
-    type = ModuleType.Css;
-  } else if (extension === 'svg') {
-    type = ModuleType.Svg;
-  }
-
-  if (!type) {
+  const SUPPORTED_ASSET_EXTENSIONS = [
+    ...SUPPORTED_ASSET_IMAGE_EXTENSIONS,
+    'js',
+    'css',
+    'svg',
+    'pdf',
+    'woff',
+    'woff2',
+    'ttf',
+    'eot',
+  ];
+
+  if (!SUPPORTED_ASSET_EXTENSIONS.includes(extension)) {
     return undefined;
   }
 
-  return module(themeGraph, {
-    type,
+  return module(appGraph, {
+    type: ModuleType.Asset,
     kind: 'unused',
     dependencies: [],
     references: [],
-    uri: path.join(themeGraph.rootUri, 'assets', asset),
+    uri: path.join(appGraph.rootUri, 'assets', asset),
   });
 }
 
-export function getPartialModule(themeGraph: ThemeGraph, partial: string): LiquidModule {
-  const uri = path.join(themeGraph.rootUri, 'app/views/partials', `${partial}.liquid`);
-  return module(themeGraph, {
+export function getPartialModule(appGraph: AppGraph, partial: string): LiquidModule {
+  const uri = path.join(appGraph.rootUri, 'app/views/partials', `${partial}.liquid`);
+  return module(appGraph, {
     type: ModuleType.Liquid,
     kind: LiquidModuleKind.Partial,
     uri: uri,
@@ -181,30 +89,38 @@ export function getPartialModule(themeGraph: ThemeGraph, partial: string): Liqui
 }
 
 export function getLayoutModule(
-  themeGraph: ThemeGraph,
-  layoutName: string | false | undefined = 'theme',
+  appGraph: AppGraph,
+  layoutUri: string | false | undefined,
 ): LiquidModule | undefined {
-  if (layoutName === false) return undefined;
-  if (layoutName === undefined) layoutName = 'theme';
-  const uri = path.join(themeGraph.rootUri, 'layout', `${layoutName}.liquid`);
-  return module(themeGraph, {
+  if (!layoutUri) return undefined;
+  return module(appGraph, {
     type: ModuleType.Liquid,
     kind: LiquidModuleKind.Layout,
-    uri: uri,
+    uri: layoutUri,
+    dependencies: [],
+    references: [],
+  });
+}
+
+export function getPageModule(appGraph: AppGraph, pageUri: string): LiquidModule {
+  return module(appGraph, {
+    type: ModuleType.Liquid,
+    kind: LiquidModuleKind.Page,
+    uri: pageUri,
     dependencies: [],
     references: [],
   });
 }
 
-function getCache(themeGraph: ThemeGraph): Map<string, ThemeModule> {
-  if (!ModuleCache.has(themeGraph)) {
-    ModuleCache.set(themeGraph, new Map());
+function getCache(appGraph: AppGraph): Map<string, AppModule> {
+  if (!ModuleCache.has(appGraph)) {
+    ModuleCache.set(appGraph, new Map());
   }
-  return ModuleCache.get(themeGraph)!;
+  return ModuleCache.get(appGraph)!;
 }
 
-function module<T extends ThemeModule>(themeGraph: ThemeGraph, mod: T): T {
-  const cache = getCache(themeGraph);
+function module<T extends AppModule>(appGraph: AppGraph, mod: T): T {
+  const cache = getCache(appGraph);
   if (!cache.has(mod.uri)) {
     cache.set(mod.uri, mod);
   }

package/src/graph/serialize.spec.ts

@@ -1,59 +1,52 @@
 import { path as pathUtils } from '@platformos/platformos-check-common';
 import { describe, expect, it } from 'vitest';
-import { ThemeGraph } from '../types';
-import { getSectionModule, getPartialModule, getTemplateModule } from './module';
-import { serializeThemeGraph } from './serialize';
+import { AppGraph } from '../types';
+import { getLayoutModule, getPartialModule } from './module';
+import { serializeAppGraph } from './serialize';
 import { bind } from './traverse';
 
-describe('Unit: serializeThemeGraph', () => {
+describe('Unit: serializeAppGraph', () => {
   it('serialize the graph', () => {
-    const rootUri = 'file:///theme';
+    const rootUri = 'file:///app';
     const p = (part: string) => pathUtils.join(rootUri, part);
-    const graph: ThemeGraph = {
+    const graph: AppGraph = {
       entryPoints: [],
       modules: {},
       rootUri,
     };
 
-    const template = getTemplateModule(graph, p('templates/index.json'));
-    const customSection = getSectionModule(graph, 'custom-section');
+    const layout = getLayoutModule(graph, p('app/views/layouts/application.liquid'))!;
+    const headerPartial = getPartialModule(graph, 'header');
     const parentPartial = getPartialModule(graph, 'parent');
     const childPartial = getPartialModule(graph, 'child');
-    bind(template, customSection, { sourceRange: [0, 5] });
-    bind(customSection, parentPartial, { sourceRange: [10, 15] });
-    bind(parentPartial, childPartial, { sourceRange: [20, 25] });
 
-    const section2 = getSectionModule(graph, 'section2');
-    bind(template, section2, { sourceRange: [20, 25] });
+    bind(layout, headerPartial, { sourceRange: [0, 5] });
+    bind(layout, parentPartial, { sourceRange: [10, 15] });
+    bind(parentPartial, childPartial, { sourceRange: [20, 25] });
 
-    graph.entryPoints = [template];
-    [template, customSection, section2, parentPartial, childPartial].forEach((module) => {
+    graph.entryPoints = [layout];
+    [layout, headerPartial, parentPartial, childPartial].forEach((module) => {
       graph.modules[module.uri] = module;
     });
 
-    const { nodes, edges } = serializeThemeGraph(graph);
-    expect(nodes).toHaveLength(5);
-    expect(edges).toHaveLength(4);
+    const { nodes, edges } = serializeAppGraph(graph);
+    expect(nodes).toHaveLength(4);
+    expect(edges).toHaveLength(3);
     expect(edges).toEqual(
       expect.arrayContaining([
         {
-          source: { uri: 'file:///theme/templates/index.json', range: [0, 5] },
-          target: { uri: 'file:///theme/sections/custom-section.liquid' },
-          type: 'direct',
-        },
-        {
-          source: { uri: 'file:///theme/sections/custom-section.liquid', range: [10, 15] },
-          target: { uri: 'file:///theme/app/views/partials/parent.liquid' },
+          source: { uri: p('app/views/layouts/application.liquid'), range: [0, 5] },
+          target: { uri: p('app/views/partials/header.liquid') },
           type: 'direct',
         },
         {
-          source: { uri: 'file:///theme/app/views/partials/parent.liquid', range: [20, 25] },
-          target: { uri: 'file:///theme/app/views/partials/child.liquid' },
+          source: { uri: p('app/views/layouts/application.liquid'), range: [10, 15] },
+          target: { uri: p('app/views/partials/parent.liquid') },
           type: 'direct',
         },
         {
-          source: { uri: 'file:///theme/templates/index.json', range: [20, 25] },
-          target: { uri: 'file:///theme/sections/section2.liquid' },
+          source: { uri: p('app/views/partials/parent.liquid'), range: [20, 25] },
+          target: { uri: p('app/views/partials/child.liquid') },
           type: 'direct',
         },
       ]),

package/src/graph/serialize.ts

@@ -1,6 +1,6 @@
-import { SerializableEdge, SerializableGraph, SerializableNode, ThemeGraph } from '../types';
+import { SerializableEdge, SerializableGraph, SerializableNode, AppGraph } from '../types';
 
-export function serializeThemeGraph(graph: ThemeGraph): SerializableGraph {
+export function serializeAppGraph(graph: AppGraph): SerializableGraph {
   const nodes: SerializableNode[] = Object.values(graph.modules).map((module) => ({
     uri: module.uri,
     type: module.type,

package/src/graph/test-helpers.ts

@@ -1,11 +1,4 @@
-import {
-  LiquidSourceCode,
-  memoize,
-  path as pathUtils,
-  SectionSchema,
-  ThemeBlockSchema,
-  toSchema,
-} from '@platformos/platformos-check-common';
+import { memoize, path as pathUtils } from '@platformos/platformos-check-common';
 import { AbstractFileSystem } from '@platformos/platformos-common';
 import { NodeFileSystem } from '@platformos/platformos-check-node';
 import { vi } from 'vitest';
@@ -28,16 +21,6 @@ export async function getDependencies(rootUri: string, fs: AbstractFileSystem =
   const getSourceCode = makeGetSourceCode(fs);
   const deps = {
     fs,
-    getSectionSchema: memoize(async (name: string) => {
-      const uri = pathUtils.join(skeleton, 'sections', `${name}.liquid`);
-      const sourceCode = (await getSourceCode(uri)) as LiquidSourceCode;
-      return (await toSchema('theme', uri, sourceCode, async () => true)) as SectionSchema;
-    }, identity),
-    getBlockSchema: memoize(async (name: string) => {
-      const uri = pathUtils.join(skeleton, 'blocks', `${name}.liquid`);
-      const sourceCode = (await getSourceCode(uri)) as LiquidSourceCode;
-      return (await toSchema('theme', uri, sourceCode, async () => true)) as ThemeBlockSchema;
-    }, identity),
     getSourceCode,
     getWebComponentDefinitionReference: (customElementName: string) =>
       webComponentDefs.get(customElementName),