@microtronics/studio-cli 0.63.0 → 0.64.0

package/dist/studio-cli.d.ts

@@ -395,12 +395,16 @@ declare interface components {
     pathItems: never;
 }
 
+declare const createPawnCC: PawnModuleFactory;
+
+declare const createPawnDbg: PawnModuleFactory;
+
 export declare namespace DDE {
     import DDEJson = DDE_Core.DDEJson;
     /**
      * The json schema to validate the dde structure
      */
-    const DDE_SCHEMA: {
+    export const DDE_SCHEMA: {
         $schema: string;
         title: string;
         description: string;
@@ -1403,7 +1407,7 @@ export declare namespace DDE {
      * @param ddeHistory
      * @constructor
      */
-    const PreCompiler: (manifest: Manifest.Manifest, libraries: DDE_Core.LibraryFile[], ddeHistory: HistoryJson | null) => YamlPreCompiler.PreCompiler;
+    export const PreCompiler: (manifest: Manifest.Manifest, libraries: DDE_Core.LibraryFile[], ddeHistory: HistoryJson | null) => YamlPreCompiler.PreCompiler;
     /**
      * File Generators
      */
@@ -1669,15 +1673,15 @@ export declare namespace DDE_Core {
     export type ContainerDefinitions = {
         [key in ContainerName]: ContainerDefinition;
     };
-    const CONTAINER_DEFS: ContainerDefinitions;
-    const HISTDATA_CONTAINER: ContainerName[];
-    const CONFIG_CONTAINER: ContainerName[];
-    const SERVER_CONTAINER: ContainerName[];
-    const regexRelation: RegExp;
+    export const CONTAINER_DEFS: ContainerDefinitions;
+    export const HISTDATA_CONTAINER: ContainerName[];
+    export const CONFIG_CONTAINER: ContainerName[];
+    export const SERVER_CONTAINER: ContainerName[];
+    export const regexRelation: RegExp;
     /**
      * Defines what fields allow relations and the allowed target field type.
      */
-    const allowedRelationTypes: {
+    export const allowedRelationTypes: {
         title: string[];
         unit: string[];
         chartMinimum: string[];
@@ -1705,11 +1709,11 @@ export declare namespace DDE_Core {
     export function parseXMLValueWithRelation(attribute: AllowedRelationTypse, field: DDEJsonField, ddeMap: DDEJson): any;
     export function parseXMLBitmask(field: DDEJsonField): string | undefined;
     export function parseXMLDefaultValue(field: DDEJsonField): string | number | undefined;
-    const TDEF_NUMBER: {
+    export const TDEF_NUMBER: {
         xmlOut(xml: XMLField, jsonField: DDEJsonField, ddeMap: DDEJson): void;
     };
-    const TYPE_DEFS: any;
-    const fieldTypeDefinitions: {
+    export const TYPE_DEFS: any;
+    export const fieldTypeDefinitions: {
         uint8: any;
         uint16: any;
         uint32: any;
@@ -1749,11 +1753,11 @@ export declare namespace DDE_Core {
      * @param container
      */
     export function hasContainerAppFields(container: DDEJsonContainer): boolean;
-        {};
+    export {};
 }
 
 export declare namespace DefaultFiles {
-    const fileNames: {
+    export const fileNames: {
         projectSettings: string;
         mainAmx: string;
         mainAmxReport: string;
@@ -1773,7 +1777,7 @@ export declare namespace DefaultFiles {
         reportTemplate: string;
         dloCfg: string;
     };
-    const filePaths: {
+    export const filePaths: {
         studio: {
             initFile: string;
             auto: {
@@ -1835,11 +1839,11 @@ export declare namespace DefaultFiles {
     /**
      * Changelog.md
      */
-    const readme: (name: string) => string;
+    export const readme: (name: string) => string;
     /**
      * Changelog.md
      */
-    const changelog = "# Changelog\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).";
+    export const changelog = "# Changelog\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).";
 }
 
 export declare namespace Dependencies {
@@ -2057,7 +2061,7 @@ export declare namespace DFILES {
 }
 
 export declare namespace Diagnostics {
-    const CODE: {
+    export const CODE: {
         ddeFieldLength: string;
     };
     export type Level = 'error' | 'warning' | 'hint' | 'info';
@@ -2076,17 +2080,31 @@ export declare namespace Diagnostics {
 }
 
 export declare namespace DLO {
-    const FileSequencer: typeof DloFileSequencer;
+    /**
+     * Factory for the Pawn/DLO WASM compiler module (bundled from pawncc-wasm).
+     * Consumers (e.g. the browser language server) can instantiate their own
+     * compiler instance with a custom Emscripten FS setup.
+     */
+    export const createPawnCC: PawnccWasm.PawnModuleFactory;
+    /**
+     * Factory for the Pawn debugger WASM module (bundled from pawncc-wasm).
+     */
+    export const createPawnDbg: PawnccWasm.PawnModuleFactory;
+    export type PawnModule = PawnccWasm.PawnModule;
+    export type PawnModuleOptions = PawnccWasm.PawnModuleOptions;
+    export type PawnModuleFactory = PawnccWasm.PawnModuleFactory;
+    export type EmscriptenFS = PawnccWasm.EmscriptenFS;
+    export const FileSequencer: typeof DloFileSequencer;
     export type FileSequencer = DloFileSequencer;
-    const PreCompiler: typeof DloPreCompiler;
+    export const PreCompiler: typeof DloPreCompiler;
     export type PreCompiler = DloPreCompiler;
     /**
      * The DLO Compiler
      */
-    const Compiler: typeof DloCompiler;
+    export const Compiler: typeof DloCompiler;
     export type Compiler = DloCompiler;
-    const uriToMemFs: typeof uriToMemFsPath;
-    const parseCompilerWarningsAndErrors: typeof parseWarningsAndErrors;
+    export const uriToMemFs: typeof uriToMemFsPath;
+    export const parseCompilerWarningsAndErrors: typeof parseWarningsAndErrors;
     /**
      * Generate the dlo.cfg file and write it to the .studio/auto/dlo directory
      * @param cwd
@@ -2119,7 +2137,7 @@ declare class DloCompiler {
      * Get a symbol compiler instance with direct disk access via CUSTOM_WASM_FS.
      */
     getSymbolCompiler(): Promise<{
-        compiler: any;
+        compiler: PawnModule;
         print: {
             stdout: string[];
             stderr: string[];
@@ -2147,6 +2165,23 @@ declare class DloPreCompiler {
     };
 }
 
+/**
+ * Thin wrapper around the private `pawncc-wasm` package (bundled into the CLI
+ * at build time, like device-master).
+ *
+ * The types are re-declared here instead of being imported from `pawncc-wasm`
+ * so the api-extractor rollup (out/studio-cli.d.ts) stays self-contained —
+ * npm consumers of @microtronics/studio-cli do not have the private package
+ * installed.
+ */
+declare interface EmscriptenFS {
+    filesystems: Record<string, unknown>;
+    mkdir(path: string): void;
+    mount(fs: unknown, opts: unknown, mountPoint: string): void;
+    chdir(path: string): void;
+    [member: string]: any;
+}
+
 export declare namespace ENV {
     /**
      *
@@ -2372,7 +2407,7 @@ export declare namespace Helper {
      * Check if the given value is numeric
      * @param v
      */
-    const isNumeric: (v: any) => boolean;
+    export const isNumeric: (v: any) => boolean;
     /**
      * Convert an uint8Array to a base64 string
      * @param bytes
@@ -2433,7 +2468,7 @@ export declare namespace Library {
      */
     export function getFilesForArchive(cwd: URI, fs: LocalFS): Promise<{
         name: string;
-        data: Uint8Array;
+        data: Uint8Array<ArrayBufferLike>;
         modifyTime: Date;
     }[]>;
     /**
@@ -2505,7 +2540,7 @@ export declare namespace Log {
         warning = 3,
         error = 4
     }
-    const LOG_PREFIX: {
+    export const LOG_PREFIX: {
         1: string;
         0: string;
         2: string;
@@ -2533,7 +2568,7 @@ export declare namespace Manifest {
     /**
      * The source filename where the information is stored in
      */
-    const fileName = "studio.json";
+    export const fileName = "studio.json";
     export enum DeviceProfiles {
         m22x = "m22x",
         m23x = "m23x",
@@ -2901,14 +2936,14 @@ export declare namespace Package {
      * @param fs
      * @param projectName
      */
-    export function getReadmeFile(cwd: URI, fs: LocalFS, projectName: string): Promise<Uint8Array>;
+    export function getReadmeFile(cwd: URI, fs: LocalFS, projectName: string): Promise<Uint8Array<ArrayBufferLike>>;
     /**
      * Read the projects CHANGELOG.md file
      * validates if the file content is the initial content
      * @param cwd
      * @param fs
      */
-    export function getChangelogFile(cwd: URI, fs: LocalFS): Promise<Uint8Array>;
+    export function getChangelogFile(cwd: URI, fs: LocalFS): Promise<Uint8Array<ArrayBufferLike>>;
     /**
      * Validate manifest settings that are required for the APM
      * @param cwd
@@ -5131,6 +5166,31 @@ declare interface paths {
     };
 }
 
+declare namespace PawnccWasm {
+    export {
+        EmscriptenFS,
+        PawnModule,
+        PawnModuleOptions,
+        PawnModuleFactory,
+        createPawnCC,
+        createPawnDbg
+    }
+}
+
+declare interface PawnModule {
+    FS: EmscriptenFS;
+    callMain(args: string[]): number | Promise<number>;
+    PROXYFS: unknown;
+}
+
+declare type PawnModuleFactory = (options?: PawnModuleOptions) => Promise<PawnModule>;
+
+declare interface PawnModuleOptions {
+    noExitRuntime?: boolean;
+    print?: (data: string) => void;
+    printErr?: (data: string) => void;
+}
+
 /**
  * Publishes a package to the registry with the specified settings and configurations.
  *
@@ -5151,7 +5211,7 @@ export declare namespace Registry {
     /**
      * Get the actual api url based on the STUDIO_ENV
      */
-    const getAPIUrl: (env: Globals.ENV) => {
+    export const getAPIUrl: (env: Globals.ENV) => {
         baseUrl: string;
     };
     export type LibraryProfile = components['schemas']['LibraryDetailInformation'];
@@ -5247,7 +5307,7 @@ declare namespace YamlPreCompiler {
         private get previousVersion();
         private getContainerOfPreviousVersion;
         parseMainDDE(filePath: URI, yaml: string): {
-            ddeJSON: DDEJson | null;
+            ddeJSON: DDE_Core.DDEJson | null;
             diagnostics: Diagnostics.File[];
         };
         /**