@platformos/platformos-graph 0.0.6 → 0.0.8

package/src/toSourceCode.ts

@@ -4,52 +4,9 @@ import {
   UriString,
 } from '@platformos/platformos-check-common';
 import { parse as acornParse, Program } from 'acorn';
-import {
-  CssSourceCode,
-  FileSourceCode,
-  ImageSourceCode,
-  JsSourceCode,
-  SUPPORTED_ASSET_IMAGE_EXTENSIONS,
-  SvgSourceCode,
-} from './types';
+import { AssetSourceCode, FileSourceCode, SUPPORTED_ASSET_IMAGE_EXTENSIONS } from './types';
 import { extname } from './utils';
 
-export async function toCssSourceCode(uri: UriString, source: string): Promise<CssSourceCode> {
-  return {
-    type: 'css',
-    uri,
-    source,
-    ast: new Error('File parsing not implemented yet'), // Placeholder for CSS parsing
-  };
-}
-
-export async function toSvgSourceCode(uri: UriString, source: string): Promise<SvgSourceCode> {
-  return {
-    type: 'svg',
-    uri,
-    source,
-    ast: new Error('File parsing not implemented yet'), // Placeholder for SVG parsing
-  };
-}
-
-async function toImageSourceCode(uri: UriString, source: string): Promise<ImageSourceCode> {
-  return {
-    type: 'image',
-    uri,
-    source,
-    ast: new Error('Image files are not parsed'),
-  };
-}
-
-export async function toJsSourceCode(uri: UriString, source: string): Promise<JsSourceCode> {
-  return {
-    type: 'javascript',
-    uri,
-    source,
-    ast: parseJs(source),
-  };
-}
-
 export function parseJs(source: string): Program | Error {
   try {
     return acornParse(source, {
@@ -64,17 +21,19 @@ export function parseJs(source: string): Program | Error {
 export async function toSourceCode(uri: UriString, source: string): Promise<FileSourceCode> {
   const extension = extname(uri);
 
-  if (extension === 'json' || extension === 'liquid' || extension === 'graphql') {
+  if (
+    extension === 'json' ||
+    extension === 'liquid' ||
+    extension === 'graphql' ||
+    extension === 'yml' ||
+    extension === 'yaml'
+  ) {
     return tcToSourceCode(uri, source);
-  } else if (extension === 'js') {
-    return toJsSourceCode(uri, source);
-  } else if (extension === 'css') {
-    return toCssSourceCode(uri, source);
-  } else if (extension === 'svg') {
-    return toCssSourceCode(uri, source);
-  } else if (SUPPORTED_ASSET_IMAGE_EXTENSIONS.includes(extension)) {
-    return toImageSourceCode(uri, source);
-  } else {
-    throw new Error(`Unknown source code type for ${uri}`);
   }
+
+  const ast: Program | Error =
+    extension === 'js' ? parseJs(source) : new Error('File parsing not implemented');
+
+  const assetSourceCode: AssetSourceCode = { type: 'asset', uri, source, ast };
+  return assetSourceCode;
 }

package/src/types.ts

@@ -1,29 +1,17 @@
 import {
   JSONSourceCode,
   LiquidSourceCode,
-  Dependencies as ThemeCheckDependencies,
+  Dependencies as CheckDependencies,
   UriString,
   Reference,
   Location,
   Range,
   GraphQLSourceCode,
+  YAMLSourceCode,
 } from '@platformos/platformos-check-common';
-import { Program } from 'acorn';
 
 export interface IDependencies {
-  fs: ThemeCheckDependencies['fs'];
-
-  /**
-   * Asynchronously get the block schema for 'blocks/${name}.liquid'
-   * May return undefined when the theme isn't preloaded.
-   */
-  getBlockSchema: NonNullable<ThemeCheckDependencies['getBlockSchema']>;
-
-  /**
-   * Asynchronously get the section schema for 'section/${name}.liquid'
-   * May return undefined when the theme isn't preloaded or if there are none.
-   */
-  getSectionSchema: NonNullable<ThemeCheckDependencies['getSectionSchema']>;
+  fs: CheckDependencies['fs'];
 
   /** Optional perf improvement if you somehow have access to pre-computed source code info */
   getSourceCode?: (uri: UriString) => Promise<FileSourceCode>;
@@ -36,32 +24,22 @@ export interface IDependencies {
 
 export type Dependencies = Required<IDependencies>;
 
-export type AugmentedDependencies = Dependencies & {
-  getThemeBlockNames: () => Promise<string[]>;
-};
+export type AugmentedDependencies = Dependencies;
 
-export interface ThemeGraph {
+export interface AppGraph {
   rootUri: UriString;
-  entryPoints: ThemeModule[];
-  modules: Record<UriString, ThemeModule>;
+  entryPoints: AppModule[];
+  modules: Record<UriString, AppModule>;
 }
 
-export type ThemeModule =
-  | LiquidModule
-  | JsonModule
-  | JavaScriptModule
-  | CssModule
-  | SvgModule
-  | ImageModule;
+export type AppModule = LiquidModule | AssetModule;
 
 export type FileSourceCode =
   | LiquidSourceCode
   | JSONSourceCode
   | GraphQLSourceCode
-  | JsSourceCode
-  | CssSourceCode
-  | SvgSourceCode
-  | ImageSourceCode;
+  | YAMLSourceCode
+  | AssetSourceCode;
 
 export interface SerializableGraph {
   rootUri: UriString;
@@ -74,34 +52,18 @@ export interface SerializableEdge {
   target: Location;
 }
 
-export type SerializableNode = Pick<ThemeModule, 'uri' | 'type' | 'kind' | 'exists'>;
+export type SerializableNode = Pick<AppModule, 'uri' | 'type' | 'kind' | 'exists'>;
 
-export interface LiquidModule extends IThemeModule<ModuleType.Liquid> {
+export interface LiquidModule extends IAppModule<ModuleType.Liquid> {
   kind: LiquidModuleKind;
 }
 
-export interface JsonModule extends IThemeModule<ModuleType.Json> {
-  kind: JsonModuleKind;
-}
-
-export interface JavaScriptModule extends IThemeModule<ModuleType.JavaScript> {
+export interface AssetModule extends IAppModule<ModuleType.Asset> {
   kind: 'unused';
 }
 
-export interface CssModule extends IThemeModule<ModuleType.Css> {
-  kind: 'unused';
-}
-
-export interface SvgModule extends IThemeModule<ModuleType.Svg> {
-  kind: 'unused';
-}
-
-export interface ImageModule extends IThemeModule<ModuleType.Image> {
-  kind: 'unused';
-}
-
-export interface IThemeModule<T extends ModuleType> {
-  /** Used as a discriminant in the ThemeNode union */
+export interface IAppModule<T extends ModuleType> {
+  /** Used as a discriminant in the AppModule union */
   type: T;
 
   /** Should be normalized. Used as key. */
@@ -131,36 +93,18 @@ export interface IThemeModule<T extends ModuleType> {
 
 export const enum ModuleType {
   Liquid = 'Liquid',
-  JavaScript = 'JavaScript',
-  Json = 'JSON',
-  Css = 'CSS',
-  Svg = 'SVG',
-  Image = 'Image',
-}
-
-export const enum JsonModuleKind {
-  /** templates/*.json files */
-  Template = 'template',
-
-  /** sections/*.json files */
-  SectionGroup = 'section-group',
+  Asset = 'Asset',
 }
 
 export const enum LiquidModuleKind {
-  /** layout/*.liquid files */
+  /** app/views/layouts/*.liquid files */
   Layout = 'layout',
 
-  /** sections/*.liquid files */
-  Section = 'section',
-
-  /** blocks/*.liquid files */
-  Block = 'block',
-
-  /** app/views/partials/*.liquid files */
+  /** app/views/partials/*.liquid and app/lib/*.liquid files */
   Partial = 'partial',
 
-  /** templates/*.liquid files (forgot those existed...) */
-  Template = 'template',
+  /** app/views/pages/*.liquid files */
+  Page = 'page',
 }
 
 export const SUPPORTED_ASSET_IMAGE_EXTENSIONS = [
@@ -173,37 +117,16 @@ export const SUPPORTED_ASSET_IMAGE_EXTENSIONS = [
   'ico',
 ];
 
-export interface CssSourceCode {
-  type: 'css';
-  uri: UriString;
-  source: string;
-  ast: any | Error;
-}
-
-export interface SvgSourceCode {
-  type: 'svg';
+export interface AssetSourceCode {
+  type: 'asset';
   uri: UriString;
   source: string;
   ast: any | Error;
 }
 
-export interface ImageSourceCode {
-  type: 'image';
-  uri: UriString;
-  source: string;
-  ast: any | Error;
-}
-
-export interface JsSourceCode {
-  type: 'javascript';
-  uri: UriString;
-  source: string;
-  ast: Program | Error;
-}
-
 export { Reference, Range, Location };
 
-export type Void = void | Void[]; /** e.g. product-element, */
+export type Void = void | Void[];
 
 export type WebComponentMap = Map<WebComponentName, WebComponentDefinition>;
 export type WebComponentName = string;

package/src/utils/index.ts

@@ -1,6 +1,5 @@
 import { UriString } from '@platformos/platformos-check-common';
 import { AbstractFileSystem } from '@platformos/platformos-common';
-import { AugmentedDependencies } from '../types';
 
 export function unique<T>(array: T[]): T[] {
   return [...new Set(array)];
@@ -10,10 +9,6 @@ export function assertNever(module: never) {
   throw new Error(`Unknown module type ${module}`);
 }
 
-export function unexpected(): Error {
-  return new Error('Unexpected code path encountered');
-}
-
 export const identity = <T>(x: T): T => x;
 
 export function isString(x: unknown): x is string {
@@ -30,22 +25,3 @@ export async function exists(fs: AbstractFileSystem, uri: UriString): Promise<bo
     .then(() => true)
     .catch(() => false);
 }
-
-export async function acceptsLocalBlocks(
-  sectionType: string,
-  deps: AugmentedDependencies,
-): Promise<boolean | Error> {
-  const sectionSchema = await deps.getSectionSchema(sectionType).catch((_) => undefined);
-  if (!sectionSchema) {
-    return new Error('Section does not exist');
-  }
-
-  const validSchema = sectionSchema.validSchema;
-  if (validSchema instanceof Error) {
-    return validSchema;
-  }
-
-  return (validSchema.blocks ?? []).some((block) => {
-    return block.type && 'name' in block && block.name;
-  });
-}

package/fixtures/skeleton/blocks/_private.liquid

@@ -1 +0,0 @@
-hoho I'm private

package/fixtures/skeleton/blocks/_static.liquid

@@ -1,10 +0,0 @@
-{% doc %}
-  this block is statically rendered
-
-  @param {string} content
-
-{% enddoc %}
-
-<div class="static-block">
-  {{ content }}
-</div>

package/fixtures/skeleton/blocks/group.liquid

@@ -1,27 +0,0 @@
-{% doc %}
-  Fixture block component that passes its blocks to the parent snippet
-{% enddoc %}
-
-{% capture children %}
-  {%- content_for "blocks" -%}
-{% endcapture %}
-
-{% render 'parent', children: children %}
-
-{% schema %}
-{
-  "name": "Group block",
-  "blocks": [{ "type": "@theme" }],
-  "presets": [
-    {
-      "name": "Group block",
-      "category": "Group",
-      "blocks": [
-        {
-          "type": "text"
-        }
-      ]
-    }
-  ]
-}
-{% endschema %}

package/fixtures/skeleton/blocks/render-static.liquid

@@ -1,22 +0,0 @@
-{% doc %}
-  This block renders the private _static block. Has no schema.
-{% enddoc %}
-
-<div class="static-block-wrapper">
-  {% content_for 'block',
-    type: '_static',
-    id: 'static',
-    content: 'hello world'
-  %}
-</div>
-
-{% schema %}
-{
-  "name": "render static block",
-  "presets": [
-    {
-      "name": "Render Static Block"
-    }
-  ]
-}
-{% endschema %}

package/fixtures/skeleton/blocks/text.liquid

@@ -1,14 +0,0 @@
-hello world
-
-{% schema %}
-{
-  "name": "Text block",
-  "settings": [],
-  "presets": [
-    {
-      "name": "Text block",
-      "category": "Text"
-    }
-  ]
-}
-{% endschema %}

package/fixtures/skeleton/jsconfig.json

@@ -1,9 +0,0 @@
-{
-  "compilerOptions": {
-    "baseUrl": "./assets",
-    "lib": ["es2020", "dom"],
-    "allowJs": true,
-    "checkJs": true
-  },
-  "include": ["./assets/**/*.js"],
-}

package/fixtures/skeleton/sections/custom-section.liquid

@@ -1,6 +0,0 @@
-{% schema %}
-{
-  "name": "custom section",
-  "blocks": [{ "type": "@theme" }, { "type": "_private" }]
-}
-{% endschema %}

package/fixtures/skeleton/sections/header-group.json

@@ -1,36 +0,0 @@
-{
-  "sections": {
-    "header": {
-      "type": "custom-section",
-      "block_order": [
-        "header",
-        "render-static",
-      ],
-      "blocks": {
-        "header": {
-          "type": "group",
-          "block_order": [
-            "text"
-          ],
-          "blocks": {
-            "text": {
-              "type": "text",
-            }
-          },
-        },
-        "render-static": {
-          "type": "render-static",
-          "blocks": {
-            "static": {
-              "type": "_static",
-              "static": true,
-            }
-          }
-        }
-      }
-    }
-  },
-  "order": [
-    "header"
-  ],
-}

package/fixtures/skeleton/sections/header.liquid

@@ -1 +0,0 @@
-header content

package/fixtures/skeleton/templates/index.json

@@ -1,20 +0,0 @@
-{
-  "sections": {
-    "main": {
-      "type": "custom-section",
-      "blocks": [
-        {
-          "type": "group",
-          "blocks": {
-            "text1": {
-              "type": "text",
-            },
-          },
-          "block_order": [
-            "text1"
-          ]
-        }
-      ]
-    }
-  }
-}