@platformos/platformos-graph 0.0.19 → 0.0.20

package/src/types.ts

@@ -4,6 +4,7 @@ import {
   Dependencies as CheckDependencies,
   UriString,
   Reference,
+  ReferenceKind,
   Location,
   Range,
   GraphQLSourceCode,
@@ -15,11 +16,6 @@ export interface IDependencies {
 
   /** Optional perf improvement if you somehow have access to pre-computed source code info */
   getSourceCode?: (uri: UriString) => Promise<FileSourceCode>;
-
-  /** A way to link <custom-element> to its window.customElements.define statement */
-  getWebComponentDefinitionReference: (
-    customElementName: string,
-  ) => { assetName: string; range: Range } | undefined;
 }
 
 export type Dependencies = Required<IDependencies>;
@@ -32,7 +28,7 @@ export interface AppGraph {
   modules: Record<UriString, AppModule>;
 }
 
-export type AppModule = LiquidModule | AssetModule;
+export type AppModule = LiquidModule | AssetModule | GraphQLModule;
 
 export type FileSourceCode =
   | LiquidSourceCode
@@ -47,10 +43,9 @@ export interface SerializableGraph {
   edges: SerializableEdge[];
 }
 
-export interface SerializableEdge {
-  source: Location;
-  target: Location;
-}
+// Serialized edges are the modules' dependency `Reference`s verbatim, so they
+// carry `type` and `kind` in addition to `source`/`target`.
+export type SerializableEdge = Reference;
 
 export type SerializableNode = Pick<AppModule, 'uri' | 'type' | 'kind' | 'exists'>;
 
@@ -62,6 +57,15 @@ export interface AssetModule extends IAppModule<ModuleType.Asset> {
   kind: 'unused';
 }
 
+/**
+ * A `.graphql` operation file (referenced by `{% graphql op = 'name' %}`).
+ * A leaf node — GraphQL documents have no outgoing platformOS dependencies —
+ * so it is not traversed, only existence-checked (like {@link AssetModule}).
+ */
+export interface GraphQLModule extends IAppModule<ModuleType.GraphQL> {
+  kind: 'graphql';
+}
+
 export interface IAppModule<T extends ModuleType> {
   /** Used as a discriminant in the AppModule union */
   type: T;
@@ -94,6 +98,7 @@ export interface IAppModule<T extends ModuleType> {
 export const enum ModuleType {
   Liquid = 'Liquid',
   Asset = 'Asset',
+  GraphQL = 'GraphQL',
 }
 
 export const enum LiquidModuleKind {
@@ -124,13 +129,6 @@ export interface AssetSourceCode {
   ast: any | Error;
 }
 
-export { Reference, Range, Location };
+export { Reference, ReferenceKind, Range, Location };
 
 export type Void = void | Void[];
-
-export type WebComponentMap = Map<WebComponentName, WebComponentDefinition>;
-export type WebComponentName = string;
-export type WebComponentDefinition = {
-  assetName: string; // Relative path to the asset file
-  range: [number, number]; // Start and end positions in the file
-};

package/bin/jsconfig.json

@@ -1,18 +0,0 @@
-{
-  "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/src/getWebComponentMap.ts

@@ -1,81 +0,0 @@
-import { path, recursiveReadDirectory } from '@platformos/platformos-check-common';
-import { ancestor as visit } from 'acorn-walk';
-import { Dependencies, Void, WebComponentMap } from './types';
-import { CallExpression } from 'acorn';
-
-/**
- * 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.
- */
-export async function getWebComponentMap(
-  rootUri: string,
-  { fs, getSourceCode }: Pick<Dependencies, 'fs' | 'getSourceCode'>,
-): Promise<WebComponentMap> {
-  const webComponentDefs: WebComponentMap = new Map();
-  const assetRoot = path.join(rootUri, 'assets');
-  const jsFiles = await recursiveReadDirectory(fs, assetRoot, ([fileName]) =>
-    fileName.endsWith('.js'),
-  );
-
-  await Promise.all(
-    jsFiles.map((uri) =>
-      findWebComponentReferences(uri, assetRoot, getSourceCode, webComponentDefs),
-    ),
-  );
-
-  return webComponentDefs;
-}
-
-export async function findWebComponentReferences(
-  uri: string,
-  assetRoot: string,
-  getSourceCode: Dependencies['getSourceCode'],
-  result: WebComponentMap,
-): Promise<Void> {
-  const sourceCode = await getSourceCode(uri);
-  if (!uri.endsWith('.js')) {
-    return;
-  }
-
-  const ast = sourceCode.ast;
-  if (ast instanceof Error) {
-    return;
-  }
-
-  for (const node of ast.body) {
-    visit(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 as CallExpression).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: path.relative(uri, assetRoot),
-            range: [property.start, node.end],
-          });
-        }
-        return null;
-      },
-    });
-  }
-}