@atscript/core 0.1.17 → 0.1.18

package/dist/index.d.ts

@@ -18,6 +18,30 @@ interface TLexicalToken {
     };
 }
 
+type TPunctuation = '\n' | '&' | '+' | ',' | '\\' | '.' | '/' | ':' | '=' | '?' | '|' | ';';
+
+declare enum TSeverity {
+    Error = 1,
+    Warning = 2,
+    Info = 3,
+    Hint = 4
+}
+type TMessages = Array<{
+    severity: TSeverity;
+    message: string;
+    range: {
+        start: {
+            line: number;
+            character: number;
+        };
+        end: {
+            line: number;
+            character: number;
+        };
+    };
+    tags?: Array<1 | 2>;
+}>;
+
 declare class Token {
     protected readonly _data: TLexicalToken;
     constructor(_data: TLexicalToken);
@@ -111,7 +135,7 @@ declare class AtscriptRepo {
         multiple?: boolean;
         fromSpec?: boolean;
         typeSet: Set<string>;
-        types: ({
+        types: Array<{
             type: "object";
             props: Record<string, {
                 optional?: boolean;
@@ -120,7 +144,7 @@ declare class AtscriptRepo {
         } | {
             optional?: boolean;
             type: "string" | "number" | "boolean" | "unknown";
-        })[];
+        }>;
     } | undefined>>;
     loadPluginManagerFor(id: string): Promise<TPluginManagers>;
     resolveConfig(id: string): Promise<TPluginManagers>;
@@ -131,30 +155,6 @@ declare class AtscriptRepo {
     checkImport(atscript: AtscriptDoc, from: Token, imports: Token[], checked?: Set<string>): Promise<AtscriptDoc | undefined>;
 }
 
-type TPunctuation = '\n' | '&' | '+' | ',' | '\\' | '.' | '/' | ':' | '=' | '?' | '|' | ';';
-
-declare enum TSeverity {
-    Error = 1,
-    Warning = 2,
-    Info = 3,
-    Hint = 4
-}
-type TMessages = Array<{
-    severity: TSeverity;
-    message: string;
-    range: {
-        start: {
-            line: number;
-            character: number;
-        };
-        end: {
-            line: number;
-            character: number;
-        };
-    };
-    tags?: Array<1 | 2>;
-}>;
-
 interface TOutput extends TOutputWithSource {
     target: string;
 }
@@ -175,12 +175,31 @@ interface TPluginOutput {
     content: string;
 }
 type TAtscriptRenderFormat = string;
+/**
+ * Well-known render format for a plugin's primary output.
+ *
+ * When a `.as` file is saved in an editor (VSCode, etc.), the editor
+ * passes this format to `render()` and `buildEnd()`. Plugins should
+ * check for this value alongside their own format strings to produce
+ * output that is essential for the development experience — typically
+ * type declarations for the host language.
+ *
+ * @example
+ * ```ts
+ * render(doc, format) {
+ *   if (format === 'dts' || format === DEFAULT_FORMAT) {
+ *     return [{ fileName: `${doc.name}.d.ts`, content: renderTypes(doc) }]
+ *   }
+ * }
+ * ```
+ */
+declare const DEFAULT_FORMAT: TAtscriptRenderFormat;
 interface TAtscriptPlugin {
     name: string;
     config?: (config: TAtscriptConfig) => Promise<TAtscriptConfig | undefined> | TAtscriptConfig | undefined;
     resolve?: (id: string) => Promise<string | undefined> | string | undefined;
     load?: (id: string) => Promise<string | undefined> | string | undefined;
-    onDocumnet?: (doc: AtscriptDoc) => Promise<void> | void;
+    onDocument?: (doc: AtscriptDoc) => Promise<void> | void;
     render?: (doc: AtscriptDoc, format: TAtscriptRenderFormat) => Promise<TPluginOutput[]> | TPluginOutput[];
     buildEnd?: (output: TOutput[], format: TAtscriptRenderFormat, repo: AtscriptRepo) => Promise<void> | void;
 }
@@ -200,7 +219,7 @@ declare class PluginManager {
     config(config?: TAtscriptConfig): Promise<TAtscriptConfig>;
     resolve(id: string): Promise<string | undefined>;
     load(id: string): Promise<string>;
-    onDocumnet(doc: AtscriptDoc): Promise<void>;
+    onDocument(doc: AtscriptDoc): Promise<void>;
     render(doc: AtscriptDoc, format: TAtscriptRenderFormat): Promise<TOutputWithSource[]>;
     buildEnd(output: TOutput[], format: TAtscriptRenderFormat, repo: AtscriptRepo): Promise<void>;
     loopInAnnotationsSpec(cb: (name: string, a: AnnotationSpec) => void): Promise<void>;
@@ -244,9 +263,7 @@ interface TPrimitiveBaseConfig {
     };
 }
 interface TPrimitiveConfig extends TPrimitiveBaseConfig {
-    extensions?: {
-        [name: string]: Partial<TPrimitiveConfig>;
-    };
+    extensions?: Record<string, Partial<TPrimitiveConfig>>;
 }
 interface TPrimitiveTypeComplex {
     kind: 'union' | 'intersection' | 'tuple';
@@ -265,11 +282,11 @@ interface TPrimitiveTypeObject {
     optional?: boolean;
 }
 type TPrimitiveTypeFinal = 'string' | 'number' | 'boolean' | 'void' | 'null' | 'phantom';
-type TPrimitiveTypeFinalOptional = {
+interface TPrimitiveTypeFinalOptional {
     kind: 'final';
     value: TPrimitiveTypeFinal;
     optional: true;
-};
+}
 type TPrimitiveTypeDef = TPrimitiveTypeComplex | TPrimitiveTypeArray | TPrimitiveTypeObject | TPrimitiveTypeFinal | TPrimitiveTypeFinalOptional;
 
 declare class SemanticNode {
@@ -732,7 +749,7 @@ interface TAnnotationSpecConfig {
     mergeStrategy?: 'append' | 'replace';
     description?: string;
     nodeType?: TNodeEntity[];
-    defType?: SemanticPrimitiveNode['type'][];
+    defType?: Array<SemanticPrimitiveNode['type']>;
     argument?: TAnnotationArgument[] | TAnnotationArgument;
     validate?: (mainToken: Token, args: Token[], doc: AtscriptDoc) => TMessages | undefined;
     modify?: (mainToken: Token, args: Token[], doc: AtscriptDoc) => void;
@@ -755,5 +772,5 @@ declare function resolveAnnotation(name: string, annotationsTree?: TAnnotationsT
 declare function resolveAtscriptFromPath(from: string, id: string): string;
 declare function getRelPath(fromUri: string, toUri: string): string;
 
-export { $n, AnnotationSpec, AtscriptDoc, AtscriptRepo, BuildRepo, PluginManager, SemanticAnnotateNode, SemanticArrayNode, SemanticConstNode, SemanticGroup, SemanticImportNode, SemanticInterfaceNode, SemanticNode, SemanticPrimitiveNode, SemanticPropNode, SemanticRefNode, SemanticStructureNode, SemanticTupleNode, SemanticTypeNode, Token, build, createAtscriptPlugin, defineConfig, getRelPath, isAnnotate, isAnnotationSpec, isArray, isConst, isGroup, isImport, isInterface, isPrimitive, isProp, isRef, isStructure, isTuple, isType, loadConfig, loadTsConfig, resolveAnnotation, resolveAtscriptFromPath, resolveConfigFile };
+export { $n, AnnotationSpec, AtscriptDoc, AtscriptRepo, BuildRepo, DEFAULT_FORMAT, PluginManager, SemanticAnnotateNode, SemanticArrayNode, SemanticConstNode, SemanticGroup, SemanticImportNode, SemanticInterfaceNode, SemanticNode, SemanticPrimitiveNode, SemanticPropNode, SemanticRefNode, SemanticStructureNode, SemanticTupleNode, SemanticTypeNode, Token, build, createAtscriptPlugin, defineConfig, getRelPath, isAnnotate, isAnnotationSpec, isArray, isConst, isGroup, isImport, isInterface, isPrimitive, isProp, isRef, isStructure, isTuple, isType, loadConfig, loadTsConfig, resolveAnnotation, resolveAtscriptFromPath, resolveConfigFile };
 export type { TAnnotationArgument, TAnnotationSpecConfig, TAnnotationTokens, TAnnotationsTree, TAtscriptConfig, TAtscriptConfigInput, TAtscriptConfigOutput, TAtscriptDocConfig, TAtscriptPlugin, TAtscriptRenderFormat, TMessages, TNodeEntity, TOutput, TOutputWithSource, TPluginManagers, TPluginOutput, TPrimitiveBaseConfig, TPrimitiveConfig, TPrimitiveTypeArray, TPrimitiveTypeComplex, TPrimitiveTypeDef, TPrimitiveTypeFinal, TPrimitiveTypeFinalOptional, TPrimitiveTypeObject, TSemanticToken };