Merge pull request #7 from superindustries/feature/profile-ast-docume…

…ntation Feature/profile ast documentation
superfaceai · Jul 8, 2020 · ce28cfd · ce28cfd
2 parents adf7e61 + f7587b9
commit ce28cfd
Show file tree

Hide file tree

Showing 6 changed files with 200 additions and 122 deletions.
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@superindustries/language",
-  "version": "0.1.4",
-  "description": "Level 5 autonomous, self-driving API client, https://superface.ai",
+  "version": "0.2.0",
+  "description": "Superface profile and map language ASTs, https://superface.ai",
   "main": "dist/language.js",
   "source": "src/index.ts",
   "module": "dist/language.modern.js",

diff --git a/src/interfaces/ast/index.ts b/src/interfaces/ast/index.ts
@@ -1,2 +1,3 @@
 export * from './map-ast';
 export * from './map-ast.utils';
+export * from './profile-ast';
diff --git a/src/interfaces/ast/map-ast.ts b/src/interfaces/ast/map-ast.ts
@@ -1,3 +1,5 @@
+import { Location, Span } from './source';
+
 export type MapNodeKind =
   | 'EvalDefinition'
   | 'HTTPOperationDefinition'
@@ -16,14 +18,10 @@ export type MapNodeKind =
   | 'StepDefinition'
   | 'VariableExpressionsDefinition';
 
-export interface Location {
-  start: number;
-  end: number;
-}
-
 export interface MapASTNodeBase {
   kind: MapNodeKind;
-  loc?: Location;
+  span?: Span;
+  location?: Location;
 }
 
 export interface JSExpressionNode extends MapASTNodeBase {
@@ -111,7 +109,7 @@ export interface OperationDefinitionNode extends MapASTNodeBase {
   stepsDefinition: StepDefinitionNode[];
 }
 
-export interface ProfileIdNode extends MapASTNodeBase {
+export interface MapProfileIdNode extends MapASTNodeBase {
   kind: 'ProfileId';
   profileId: string;
 }
@@ -123,7 +121,7 @@ export interface ProviderNode extends MapASTNodeBase {
 
 export interface MapNode extends MapASTNodeBase {
   kind: 'Map';
-  profileId: ProfileIdNode;
+  profileId: MapProfileIdNode;
   provider: ProviderNode;
 }
 
@@ -154,7 +152,7 @@ export type MapASTNode =
   | OperationCallDefinitionNode
   | OperationDefinitionNode
   | OutcomeDefinitionNode
-  | ProfileIdNode
+  | MapProfileIdNode
   | ProviderNode
   | StepDefinitionNode
   | VariableExpressionDefinitionNode;
diff --git a/src/interfaces/ast/map-ast.utils.ts b/src/interfaces/ast/map-ast.utils.ts
@@ -8,11 +8,11 @@ import {
   MapDocumentNode,
   MapExpressionDefinitionNode,
   MapNode,
+  MapProfileIdNode,
   NetworkOperationDefinitionNode,
   OperationCallDefinitionNode,
   OperationDefinitionNode,
   OutcomeDefinitionNode,
-  ProfileIdNode,
   ProviderNode,
   StepDefinitionNode,
   VariableExpressionDefinitionNode,
@@ -90,9 +90,9 @@ export function assertIsOperationDefinitionNode(
   checkNode(node, 'OperationDefinition');
 }
 
-export function assertIsProfileIdNode(
+export function assertIsMapProfileIdNode(
   node: MapASTNode
-): asserts node is ProfileIdNode {
+): asserts node is MapProfileIdNode {
   checkNode(node, 'ProfileId');
 }
 
@@ -182,7 +182,7 @@ export function isOperationDefinitionNode(
   return node.kind === 'OperationDefinition';
 }
 
-export function isProfileIdNode(node: MapASTNode): node is ProfileIdNode {
+export function isProfileIdNode(node: MapASTNode): node is MapProfileIdNode {
   return node.kind === 'ProfileId';
 }