@supernova-studio/pulsar-core 1.0.41 → 1.0.43

package/build/typings/core/src/model/exporters/Exporter.d.ts

@@ -0,0 +1,53 @@
+import { PCExporterSource } from "../sources/ExporterSource";
+import { PCExporterMapBlueprint } from "../maps/ExporterMapBlueprint";
+export declare type PCExporterModel = {
+    id: string;
+    name: string;
+    description: string;
+    author?: string;
+    organization?: string;
+    icon?: string;
+    homepage: string;
+    source_dir: string;
+    version: string;
+    config?: {
+        sources?: string;
+        output?: string;
+    };
+    engines?: {
+        pulsar?: string;
+        supernova?: string;
+    };
+    tags: Array<string>;
+};
+export declare class PCExporter {
+    id: string;
+    name: string;
+    description: string;
+    author: string | null;
+    organization: string | null;
+    icon: string | null;
+    homepage: string;
+    sourceDirectory: string;
+    version: string;
+    sourceConfigFilePath: string | null;
+    outputConfigFilePath: string | null;
+    pulsarEngineVersion: string | null;
+    supernovaEngineVersion: string | null;
+    tags: Array<string>;
+    sources: Map<string, PCExporterSource>;
+    outputs: Array<PCExporterMapBlueprint>;
+    constructor(data: PCExporterModel);
+    applyConfiguration(data: PCExporterModel): void;
+    linkSources(sources: Array<PCExporterSource>): void;
+    linkOutputs(outputs: Array<PCExporterMapBlueprint>): void;
+    sourceByIdIgnoringExecutableExtension(sourceId: string): PCExporterSource | null;
+    sourceById(sourceId: string): PCExporterSource | null;
+    storeNewSource(source: PCExporterSource): void;
+    removeSource(source: PCExporterSource): void;
+    removeSourceById(sourceId: string): void;
+    storeSources(sources: Array<PCExporterSource>): void;
+    removeSources(sources: Array<PCExporterSource>): void;
+    moveBlueprintSource(oldId: string, newId: string, newPath: string | null): void;
+    removeOutputs(): void;
+}

package/build/typings/core/src/model/maps/ExporterMapBlueprint.d.ts

@@ -0,0 +1,12 @@
+export declare type PCExporterMapBlueprintModel = {
+    invoke: string;
+    write_to?: string;
+    write_using?: string;
+};
+export declare class PCExporterMapBlueprint {
+    invoke: string;
+    write_to: string | null;
+    write_using: string | null;
+    constructor(data: PCExporterMapBlueprintModel);
+    toObject(): PCExporterMapBlueprintModel;
+}

package/build/typings/core/src/model/sources/ExporterSource.d.ts

@@ -0,0 +1,26 @@
+export declare enum PCExporterSourceContextType {
+    generic = "generic",
+    component = "component",
+    componentGroup = "componentGroup",
+    tokenType = "tokenType",
+    tokenGroup = "tokenGroup",
+    theme = "theme"
+}
+export declare type PCExporterBlueprintModel = {
+    targets_ci?: boolean;
+    targets_sandbox?: boolean;
+    targets_documentation?: boolean;
+    context?: PCExporterSourceContextType;
+};
+export declare class PCExporterSource {
+    id: string;
+    path: string;
+    targetsCI: boolean;
+    targetsSandbox: boolean;
+    targetsDocumentation: boolean;
+    context: PCExporterSourceContextType;
+    content: string;
+    constructor(id: string, path: string | null, content: string);
+    loadBlueprintConfiguration(data: PCExporterBlueprintModel): void;
+    resetToDefault(): void;
+}

package/build/typings/core/src/pulsar/Pulsar.d.ts

@@ -0,0 +1,107 @@
+import { PCExporter } from "../model/exporters/Exporter";
+import { PCEngineExporterDetail, PCEngineExporterProcessingResult, PCPulsarInterface, PCEngineSourceDetail, PCEngineSourceProcessingResult } from "./PulsarInterface";
+import { PLHighlightEngineToken, DSMBridgeConfiguration } from "../../../language/src/index";
+import { DSMReferenceStore } from "../model/dsm/DSMReferenceStore";
+import { PLAutocompleteEngineApplicationResult, PLAutocompleteEngineSuggestion } from "../../../language/src/tools/autocomplete/AutocompleteEngine";
+import { PCLogger } from "../tools/Logger";
+export declare enum PCPulsarEngineState {
+    waiting = "waiting",
+    loading = "loading",
+    ready = "ready"
+}
+export declare enum PCPulsarExporterMode {
+    ci = "ci",
+    sandbox = "sandbox",
+    docs = "docs"
+}
+export declare class PCPulsar implements PCPulsarInterface {
+    private logger?;
+    private state;
+    private exporter;
+    private sourceManager;
+    private ciManager;
+    private codeManager;
+    private exporterManager;
+    private configurationManager;
+    constructor(logger?: PCLogger);
+    /** Initiates Pulsar library from existing exporter. This is only for internal use (especially for tests) and doesn't validate integrity of the exporter, and shouldn't not be used in production! */
+    initiateWithExporter(exporter: PCExporter): Promise<PCEngineExporterDetail>;
+    /** Initiates Pulsar library from a local filepath. Note that this has to always be called before using the library, as all calls require the exporter to be present. This fully handles loading and validation of the package, including download of the package, unzipping and more */
+    initiateWithLocalURL(url: string): Promise<PCEngineExporterDetail>;
+    /** Initiates Pulsar library from remote S3 URL. Note that this has to always be called before using the library, as all calls require the exporter to be present. This fully handles loading and validation of the package, including download of the package, unzipping and more */
+    initiateWithPackageS3URL(s3URL: string): Promise<PCEngineExporterDetail>;
+    /** Initiates Pulsar library from github URL. Note that this has to always be called before using the library, as all calls require the exporter to be present. This fully handles loading and validation of the package, including download of the package, unzipping and more */
+    initiateWithPackageGitHubURL(githubURL: string): Promise<PCEngineExporterDetail>;
+    /** Initiates Pulsar library from JSON blob or already parsed object. Note that this has to always be called before using the library, as all calls require the exporter to be present. This fully handles loading and validation of the package */
+    initiateWithPackageBlob(blob: Object | string): Promise<PCEngineExporterDetail>;
+    private preInit;
+    private postInit;
+    /** Retrieve underlaying exporter object. Not to be used on the client, as it exposes other properties of exporter that are not to be consumed */
+    getExporterBackingObject(): PCExporter;
+    /** Retrieve details about currently loaded exporter. Note that this only retrieves settings of the exporter, to request blueprints and mapping, use separate functions */
+    getExporterDetail(): PCEngineExporterDetail;
+    /** Update exporter name. Name must be non-empty and contain at least 6 characters */
+    updateExporterName(name: string): PCEngineExporterDetail;
+    /** Update exporter description. Description must be non-empty and contain at least 20 characters */
+    updateExporterDescription(description: string): PCEngineExporterDetail;
+    /** Update exporter version. Exporter version needs to follow standard major.minor.patch versioning. Patch is optional */
+    updateExporterVersion(version: string): PCEngineExporterDetail;
+    /** Update exporter author. Author can be empty. If non-empty, only alpha-numerics are allowed  */
+    updateExporterAuthor(author: string | null): PCEngineExporterDetail;
+    /** Update exporter homepage. Homepage can be empty. If non-empty, validates the URL */
+    updateExporterHomepage(homepage: string): PCEngineExporterDetail;
+    /** Update exporter icon. Not available at the moment */
+    updateExporterIcon(icon: string): PCEngineExporterDetail;
+    /** Update exporter tags. Each tag must consist of letters and numbers */
+    updateExporterTags(tags: string[]): PCEngineExporterDetail;
+    /** Get exporter configuration JSON */
+    getExporterConfigurationJSON(): string;
+    /** Get source configuration JSON */
+    getSourceConfigurationJSON(): string;
+    /** Get output configuration JSON */
+    getOutputConfigurationJSON(): string;
+    /** Update exporter configuration JSON */
+    updateExporterConfigurationJSON(content: string): void;
+    /** Update source configuration JSON */
+    updateSourceConfigurationJSON(content: string): void;
+    /** Update output configuration JSON */
+    updateOutputConfigurationJSON(content: string): void;
+    /** Get all blueprints associated with loaded exporter */
+    getSources(): Array<PCEngineSourceDetail>;
+    /** Get specific source associated with loaded exporter */
+    getSourceById(blueprintId: string): PCEngineSourceDetail;
+    /** Create new source for loaded exporter. Source comes with default name and code and uses generic context */
+    createNewSource(): PCEngineSourceDetail;
+    /** Delete specified source. Throws error when source is not found */
+    deleteSourceById(blueprintId: string): void;
+    /** Update source location. Id must be non-empty and contain at least 3 characters. It must also be unique in scope of the entire exporter */
+    updateSourceLocation(oldSourceId: string, newSourceId: string, newPath: string): PCEngineSourceDetail;
+    /** Get reference store containing description of all elements in the DSM, including all context categories */
+    getDSMContextStore(dsmBridgeConfig: DSMBridgeConfiguration): Promise<DSMReferenceStore>;
+    /** Get reference store containing description of all elements in the DSM, including all context categories. Note this can be called as static method to see the store content regardless of the exporter */
+    static getDSMContextStoreStatic(dsmBridgeConfig: DSMBridgeConfiguration): Promise<DSMReferenceStore>;
+    /** Execute source code and retrieve the resulting code. This also retrieves any emitted extra files. Throws error when source is not found */
+    executeSourceById(blueprintId: string, dsmBridgeConfig: DSMBridgeConfiguration, contextKey: string, contextId: string): Promise<PCEngineSourceProcessingResult>;
+    /** Update source code definition. Overview can be empty. Throws error when source is not found */
+    updateSourceCodeDefinitionForSourceId(sourceId: string, definition: string): void;
+    /** Suggest next characters, words or snippets to be inserted into pulsar code as user types */
+    suggestNextFromSourceCode(code: string, selectionLocation: number, selectionLength: number): Array<PLAutocompleteEngineSuggestion>;
+    /** Apply autocompletion result to specified pulsar code */
+    applyAutocompletionResultToCode(code: string, selectionLocation: number, selectionLength: number, apply: PLAutocompleteEngineSuggestion): PLAutocompleteEngineApplicationResult;
+    /** Compute highlight tokens for the provided pulsar code */
+    suggestHighlightFromSourceCode(code: string): Array<PLHighlightEngineToken>;
+    /** Serialize entire exporter into single javascript object. Returns object representation */
+    getExporterBlob(): Object;
+    /** Serialize entire exporter into single javascript object. Returns JSON-string representation */
+    getExporterBlobJSONSerialized(): string;
+    /** Execute entire exporter and retrieve all files produced as a result of this export */
+    executeExporter(dsmBridgeConfig: DSMBridgeConfiguration, exportMode?: PCPulsarExporterMode): Promise<PCEngineExporterProcessingResult>;
+    /** Execute exporter in sandbox mode for a specific component */
+    executeExporterForSingleSandboxedComponent(dsmBridgeConfig: DSMBridgeConfiguration, sandboxComponentId: string, serializedSandboxData: string): Promise<PCEngineExporterProcessingResult>;
+    /** Retrieve intermediate output of exporter in progress */
+    retrieveRunningExporterState(): PCEngineExporterProcessingResult | null;
+    private validateCanManipulateState;
+    private convertExporterToDetail;
+    private convertSourceToDetail;
+    private convertSourcesToDetails;
+}

package/build/typings/core/src/pulsar/PulsarInterface.d.ts

@@ -0,0 +1,152 @@
+import { DSMBridgeConfiguration, PLHighlightEngineToken } from "../../../language/src/index";
+import { PLLogger } from "../../../language/src/interpreter/loggers/Logger";
+import { PLAutocompleteEngineSuggestion, PLAutocompleteEngineApplicationResult } from "../../../language/src/tools/autocomplete/AutocompleteEngine";
+import { DSMReferenceStore } from "../index";
+import { PCExporterSourceContextType } from "../model/sources/ExporterSource";
+import { PCExporter } from "../model/exporters/Exporter";
+/** Exporter detail containing data about the currently loaded exporter */
+export declare class PCEngineExporterDetail {
+    id: string;
+    name: string;
+    description: string;
+    author?: string;
+    organization?: string;
+    homepage: string;
+    source_dir: string;
+    version: string;
+    icon?: string;
+    config?: {
+        sources?: string;
+        output?: string;
+    };
+    engines?: {
+        pulsar?: string;
+        supernova?: string;
+    };
+    tags: Array<string>;
+}
+/** Source detail containing data about specific source including its code definition */
+export declare class PCEngineSourceDetail {
+    id: string;
+    path: string;
+    targetsCI: boolean;
+    targetsSandbox: boolean;
+    targetsDocumentation: boolean;
+    context: PCExporterSourceContextType;
+    content: string;
+}
+/** Unique, computed file group */
+export declare class PCEngineFileGroup {
+    name: string;
+    path: string;
+    files: Array<PCEngineFileDescriptor>;
+    groups: Array<PCEngineFileGroup>;
+    constructor(name: string, path: string, files: Array<PCEngineFileDescriptor>, groups: Array<PCEngineFileGroup>);
+}
+/** Result of a specific run of a singular exporter. Also used to retrieve export in progress as a way to load files gradually as they are fed and written by the exporter */
+export declare type PCEngineExporterProcessingResult = {
+    exporterId: string;
+    runId: string;
+    state: PCEngineExporterState;
+    emittedFiles: Array<PCEngineFileDescriptor>;
+    rootGroup: PCEngineFileGroup;
+};
+/** Result of a specific run of a singular source. Can optionally produce multiple files if emitter was used within the source */
+export declare type PCEngineSourceProcessingResult = {
+    sourceId: string;
+    logger: PLLogger;
+    producedContent: Array<PCEngineFileDescriptor>;
+};
+/** Result of a specific run of a singular file map. Always produces one file because that file represents the generates the path to the file */
+export declare type PCEngineMapProcessingResult = {
+    mapId: string;
+    logger: PLLogger;
+    producedContent: Array<PCEngineFileDescriptor>;
+};
+/** File descriptor for one specific file produced by either source, map generation or exporter run */
+export declare type PCEngineFileDescriptor = {
+    name: string;
+    path: string;
+    content: string;
+    source: 'primary' | 'emitter';
+    type: 'string';
+};
+export declare enum PCEngineExporterState {
+    running = "running",
+    finished_success = "finished_success",
+    finished_failure = "finished_failure"
+}
+export interface PCPulsarInterface {
+    /** Initiates Pulsar library from existing exporter. This is only for internal use (especially for tests) and doesn't validate integrity of the exporter, and shouldn't not be used in production! */
+    initiateWithExporter(exporter: PCExporter): Promise<PCEngineExporterDetail>;
+    /** Initiates Pulsar library from a local filepath. Note that this has to always be called before using the library, as all calls require the exporter to be present. This fully handles loading and validation of the package, including download of the package, unzipping and more */
+    initiateWithLocalURL(url: string): Promise<PCEngineExporterDetail>;
+    /** Initiates Pulsar library from remote S3 URL. Note that this has to always be called before using the library, as all calls require the exporter to be present. This fully handles loading and validation of the package, including download of the package, unzipping and more */
+    initiateWithPackageS3URL(s3URL: string): Promise<PCEngineExporterDetail>;
+    /** Initiates Pulsar library from github URL. Note that this has to always be called before using the library, as all calls require the exporter to be present. This fully handles loading and validation of the package, including download of the package, unzipping and more */
+    initiateWithPackageGitHubURL(githubURL: string): Promise<PCEngineExporterDetail>;
+    /** Initiates Pulsar library from JSON blob or already parsed object. Note that this has to always be called before using the library, as all calls require the exporter to be present. This fully handles loading and validation of the package */
+    initiateWithPackageBlob(blob: Object | string): Promise<PCEngineExporterDetail>;
+    /** Retrieve underlaying exporter object. Not to be used on the client, as it exposes other properties of exporter that are not to be consumed */
+    getExporterBackingObject(): PCExporter;
+    /** Retrieve details about currently loaded exporter. Note that this only retrieves settings of the exporter, to request Sources and mapping, use separate functions */
+    getExporterDetail(): PCEngineExporterDetail;
+    /** Update exporter name. Name must be non-empty and contain at least 6 characters */
+    updateExporterName(name: string): PCEngineExporterDetail;
+    /** Update exporter description. Overview must be non-empty and contain at least 20 characters */
+    updateExporterDescription(description: string): PCEngineExporterDetail;
+    /** Update exporter version. Exporter version needs to follow standard major.minor.patch versioning. Patch is optional */
+    updateExporterVersion(version: string): PCEngineExporterDetail;
+    /** Update exporter author. Author can be empty. If non-empty, only alpha-numerics are allowed  */
+    updateExporterAuthor(author: string | null): PCEngineExporterDetail;
+    /** Update exporter homepage. Homepage can be empty */
+    updateExporterHomepage(homepage: string): PCEngineExporterDetail;
+    /** Update exporter icon. Not available at the moment and will throw */
+    updateExporterIcon(icon: string): PCEngineExporterDetail;
+    /** Update exporter tags. Each tag must consist of letters and numbers */
+    updateExporterTags(tags: string[]): PCEngineExporterDetail;
+    /** Get all Sources associated with loaded exporter. Note that Sources don't contain their code definitions, as those need to be requested separaterly */
+    getSources(): Array<PCEngineSourceDetail>;
+    /** Get specific source associated with loaded exporter */
+    getSourceById(sourceId: string): PCEngineSourceDetail;
+    /** Create new source for loaded exporter. Source comes with default name and code and uses generic context */
+    createNewSource(): PCEngineSourceDetail;
+    /** Delete specified source. Throws error when source is not found */
+    deleteSourceById(sourceId: string): any;
+    /** Update source id. Id must be non-empty and contain at least 3 characters. It must also be unique in scope. Note that this also updates all maps that are referencing this source */
+    updateSourceLocation(oldSourceId: string, newSourceId: string, newPath: string): PCEngineSourceDetail;
+    /** Get exporter configuration JSON */
+    getExporterConfigurationJSON(): string;
+    /** Get source configuration JSON */
+    getSourceConfigurationJSON(): string;
+    /** Get output configuration JSON */
+    getOutputConfigurationJSON(): string;
+    /** Update exporter configuration JSON */
+    updateExporterConfigurationJSON(content: string): any;
+    /** Update source configuration JSON */
+    updateSourceConfigurationJSON(content: string): any;
+    /** Update output configuration JSON */
+    updateOutputConfigurationJSON(content: string): any;
+    /** Get reference store containing description of all elements in the DSM, including all context categories */
+    getDSMContextStore(dsmBridgeConfig: DSMBridgeConfiguration): Promise<DSMReferenceStore>;
+    /** Execute source code and retrieve the resulting code. This also retrieves any emitted extra files. Throws error when source is not found */
+    executeSourceById(sourceId: string, dsmBridgeConfig: DSMBridgeConfiguration, contextKey: string, contextId: string): Promise<PCEngineSourceProcessingResult>;
+    /** Update source code definition. Overview can be empty. Throws error when source is not found */
+    updateSourceCodeDefinitionForSourceId(sourceId: string, definition: string): any;
+    /** @deprecated Use PCPulsarStaticAnalysis instead. Suggest next characters, words or snippets to be inserted into pulsar code as user types */
+    suggestNextFromSourceCode(code: string, selectionLocation: number, selectionLength: number): Array<PLAutocompleteEngineSuggestion>;
+    /** @deprecated Use PCPulsarStaticAnalysis instead.  Apply autocompletion result to specified pulsar code */
+    applyAutocompletionResultToCode(code: string, selectionLocation: number, selectionLength: number, apply: PLAutocompleteEngineSuggestion): PLAutocompleteEngineApplicationResult;
+    /** @deprecated Use PCPulsarStaticAnalysis instead.  Compute highlight tokens for the provided pulsar code */
+    suggestHighlightFromSourceCode(code: string): Array<PLHighlightEngineToken>;
+    /** Serialize entire exporter into single javascript object. Returns object representation */
+    getExporterBlob(): Object;
+    /** Serialize entire exporter into single javascript object. Returns JSON-string representation */
+    getExporterBlobJSONSerialized(): string;
+    /** Execute entire exporter and retrieve all files produced as a result of this export */
+    executeExporter(dsmBridgeConfig: DSMBridgeConfiguration, exportMode: string): Promise<PCEngineExporterProcessingResult>;
+    /** Execute exporter in sandbox mode for a specific component */
+    executeExporterForSingleSandboxedComponent(dsmBridgeConfig: DSMBridgeConfiguration, sandboxComponentId: string, serializedSandboxData: string): Promise<PCEngineExporterProcessingResult>;
+    /** Retrieve intermediate output of exporter in progress */
+    retrieveRunningExporterState(): PCEngineExporterProcessingResult | null;
+}

package/build/typings/core/src/pulsar/PulsarStaticAnalysis.d.ts

@@ -0,0 +1,26 @@
+import { PLHighlightEngineToken } from "../../../language/src/index";
+import { PLError } from "../../../language/src/parser/errors/LanguageError";
+import { PLAutocompleteEngineSuggestion, PLAutocompleteEngineApplicationResult } from "../../../language/src/tools/autocomplete/AutocompleteEngine";
+import { PCPulsarStaticAnalysisInterface } from "./PulsarStaticAnalysisInterface";
+export declare enum PCPulsarEngineState {
+    waiting = "waiting",
+    loading = "loading",
+    ready = "ready"
+}
+export declare enum PCPulsarExporterMode {
+    ci = "ci",
+    sandbox = "sandbox",
+    docs = "docs"
+}
+export declare class PCPulsarStaticAnalysis implements PCPulsarStaticAnalysisInterface {
+    private codeManager;
+    constructor();
+    /** Run analysis and return errors if found, otherwise empty */
+    analyzeBlueprintCode(code: string, sourceFileName: string): Array<PLError>;
+    /** Suggest next characters, words or snippets to be inserted into pulsar code as user types */
+    suggestNextFromBlueprintCode(code: string, selectionLocation: number, selectionLength: number): Array<PLAutocompleteEngineSuggestion>;
+    /** Apply autocompletion result to specified pulsar code */
+    applyAutocompletionResultToCode(code: string, selectionLocation: number, selectionLength: number, apply: PLAutocompleteEngineSuggestion): PLAutocompleteEngineApplicationResult;
+    /** Compute highlight tokens for the provided pulsar code */
+    suggestHighlightFromBlueprintCode(code: string): Array<PLHighlightEngineToken>;
+}

package/build/typings/core/src/pulsar/PulsarStaticAnalysisInterface.d.ts

@@ -0,0 +1,13 @@
+import { PLHighlightEngineToken } from "../../../language/src/index";
+import { PLError } from "../../../language/src/parser/errors/LanguageError";
+import { PLAutocompleteEngineApplicationResult, PLAutocompleteEngineSuggestion } from "../../../language/src/tools/autocomplete/AutocompleteEngine";
+export interface PCPulsarStaticAnalysisInterface {
+    /** Run analysis and return errors if found, otherwise empty */
+    analyzeBlueprintCode(code: string, sourceFileName: string): Array<PLError>;
+    /** Suggest next characters, words or snippets to be inserted into pulsar code as user types */
+    suggestNextFromBlueprintCode(code: string, selectionLocation: number, selectionLength: number): Array<PLAutocompleteEngineSuggestion>;
+    /** Apply autocompletion result to specified pulsar code */
+    applyAutocompletionResultToCode(code: string, selectionLocation: number, selectionLength: number, apply: PLAutocompleteEngineSuggestion): PLAutocompleteEngineApplicationResult;
+    /** Compute highlight tokens for the provided pulsar code */
+    suggestHighlightFromBlueprintCode(code: string): Array<PLHighlightEngineToken>;
+}

package/build/typings/core/src/pulsar/managers/PulsarBlueprintManager.d.ts

@@ -0,0 +1,16 @@
+import { PCExporter } from "../../model/exporters/Exporter";
+import { PCExporterSource } from "../../model/sources/ExporterSource";
+export declare class PCPulsarSourceManager {
+    private exporter;
+    constructor(exporter: PCExporter);
+    /** Get all sources associated with loaded exporter. Note that sources don't contain their code definitions, as those need to be requested separaterly */
+    getSources(): Array<PCExporterSource>;
+    /** Get specific source associated with loaded exporter */
+    getSourceById(sourceId: string): PCExporterSource;
+    /** Create new source for loaded exporter. Source comes with default name and code and uses generic context */
+    createNewSource(): PCExporterSource;
+    /** Delete specified source. Throws error when source is not found */
+    deleteSourceById(sourceId: string): void;
+    /** Update source id. Id must be non-empty and contain at least 3 characters. It must also be unique in scope. Note that this also updates all maps that are referencing this source */
+    updateSourceLocation(oldSourceId: string, newSourceId: string, newPath: string): PCExporterSource;
+}

package/build/typings/core/src/pulsar/managers/PulsarCIManager.d.ts

@@ -0,0 +1,26 @@
+import { PCExporter } from "../../model/exporters/Exporter";
+import { PCLogger } from "../../tools/Logger";
+import { DSMBridgeConfiguration } from "../../../../language/src/index";
+import { DSMReferenceStore } from "../../index";
+import { PCPulsarExporterMode } from "../Pulsar";
+import { PCEngineExporterProcessingResult } from "../PulsarInterface";
+export declare class PCPulsarCIManager {
+    private exporter;
+    private currentExporterInstance;
+    constructor(exporter: PCExporter);
+    /** Execute entire exporter and retrieve all files produced as a result of this export */
+    executeExporter(dsmBridgeConfig: DSMBridgeConfiguration, exportMode: PCPulsarExporterMode, logger?: PCLogger): Promise<PCEngineExporterProcessingResult>;
+    /** Execute entire exporter and retrieve all files produced as a result of this export */
+    executeExporterForSingleSandboxedComponent(dsmBridgeConfig: DSMBridgeConfiguration, exportMode: PCPulsarExporterMode, sandboxComponentId: string, serializedSandboxData: string, logger?: PCLogger): Promise<PCEngineExporterProcessingResult>;
+    /** Retrieve intermediate output of exporter in progress */
+    retrieveRunningExporterState(): PCEngineExporterProcessingResult | null;
+    /** Get reference store containing description of all elements in the DSM, including all context categories */
+    getDSMContextStore(dsmBridgeConfig: DSMBridgeConfiguration): Promise<DSMReferenceStore>;
+    private convertExportResultToPulsarResult;
+    private parseName;
+    fetchReferenceStore(dsmBridgeConfig: DSMBridgeConfiguration): Promise<DSMReferenceStore>;
+    static fetchReferenceStoreStatic(dsmBridgeConfig: DSMBridgeConfiguration): Promise<DSMReferenceStore>;
+    fetchReferenceStoreForSandboxedComponent(componentId: string): Promise<DSMReferenceStore>;
+    private computeRootFileGroupFromFiles;
+    private pathPermutations;
+}

package/build/typings/core/src/pulsar/managers/PulsarCodeManager.d.ts

@@ -0,0 +1,25 @@
+import { PCExporter } from "../../model/exporters/Exporter";
+import { PCLogger } from "../../tools/Logger";
+import { DSMBridgeConfiguration, DSMExecutionContext, PLBlueprint, PLHighlightEngineToken } from "../../../../language/src/index";
+import { PLAutocompleteEngineApplicationResult, PLAutocompleteEngineSuggestion } from "../../../../language/src/tools/autocomplete/AutocompleteEngine";
+import { PCEngineSourceProcessingResult } from "../PulsarInterface";
+export declare class PCPulsarCodeManager {
+    private exporter;
+    private codeExecutionContext;
+    constructor(exporter: PCExporter);
+    /** Execute source code and retrieve the resulting output. This also retrieves any emitted extra files. Throws error when source is not found */
+    executeSourceById(sourceId: string, dsmBridgeConfig: DSMBridgeConfiguration, contextKey: string, contextId: string, logger?: PCLogger): Promise<PCEngineSourceProcessingResult>;
+    /** Update source code definition. Content can be anything */
+    updateSourceCodeDefinitionForSourceId(sourceId: string, definition: string): void;
+    /** Update source code definition. Overview can be empty. Throws error when source is not found */
+    updateSourceLocation(oldSourceId: string, newSourceId: string, newPath: string): void;
+    /** Suggest next characters, words or snippets to be inserted into pulsar code as user types */
+    suggestNextFromSourceCode(code: string, selectionLocation: number, selectionLength: number): Array<PLAutocompleteEngineSuggestion>;
+    /** Apply autocompletion result to specified pulsar code */
+    applyAutocompletionResultToCode(code: string, selectionLocation: number, selectionLength: number, apply: PLAutocompleteEngineSuggestion): PLAutocompleteEngineApplicationResult;
+    /** Compute highlight tokens for the provided pulsar code */
+    suggestHighlightFromSourceCode(code: string): Array<PLHighlightEngineToken>;
+    createContextData(contextKey: string, contextId: string): Map<string, any>;
+    parseSource(declaration: string, executionContext: DSMExecutionContext): Promise<PLBlueprint>;
+    interpretSource(source: PLBlueprint, data: Map<string, any>, executionContext: DSMExecutionContext): Promise<string>;
+}

package/build/typings/core/src/pulsar/managers/PulsarConfigurationManager.d.ts

@@ -0,0 +1,17 @@
+import { PCExporter } from "../../model/exporters/Exporter";
+export declare class PCPulsarConfigurationManager {
+    private exporter;
+    constructor(exporter: PCExporter);
+    /** Get exporter configuration JSON */
+    getExporterConfigurationJSON(): string;
+    /** Get source configuration JSON */
+    getSourceConfigurationJSON(): string;
+    /** Get output configuration JSON */
+    getOutputConfigurationJSON(): string;
+    /** Update exporter configuration JSON */
+    updateExporterConfigurationJSON(content: string): void;
+    /** Update source configuration JSON */
+    updateSourceConfigurationJSON(content: string): void;
+    /** Update output configuration JSON */
+    updateOutputConfigurationJSON(content: string): void;
+}

package/build/typings/core/src/pulsar/managers/PulsarExporterManager.d.ts

@@ -0,0 +1,25 @@
+import { PCExporter } from "../../model/exporters/Exporter";
+export declare class PCPulsarExporterManager {
+    private exporter;
+    constructor(exporter: PCExporter);
+    /** Retrieve details about currently loaded exporter. Note that this only retrieves settings of the exporter, to request blueprints and mapping, use separate functions */
+    getExporterDetail(): PCExporter;
+    /** Update exporter name. Name must be non-empty and contain at least 6 characters */
+    updateExporterName(name: string): PCExporter;
+    /** Update exporter description. Description must be non-empty and contain at least 20 characters */
+    updateExporterDescription(description: string): PCExporter;
+    /** Update exporter version. Exporter version needs to follow standard major.minor.patch versioning. Patch is optional */
+    updateExporterVersion(version: string): PCExporter;
+    /** Update exporter author. Author can be empty. If non-empty, only alpha-numerics and spaces are allowed  */
+    updateExporterAuthor(author: string | null): PCExporter;
+    /** Update exporter homepage. Homepage can be empty. If non-empty, validates the URL */
+    updateExporterHomepage(homepage: string): PCExporter;
+    /** Update exporter tags. Only alpha-numeric are allowed */
+    updateExporterTags(tags: Array<string>): PCExporter;
+    /** Update exporter icon. Not available at the moment */
+    updateExporterIcon(icon: string): PCExporter;
+    /** Serialize entire exporter into single javascript object. Returns object representation */
+    getExporterBlob(): Object;
+    /** Serialize entire exporter into single javascript object. Returns JSON-string representation */
+    getExporterBlobJSONSerialized(): string;
+}

package/build/typings/core/src/pulsar/managers/generators/PulsarExporterConfigFileGenerator.d.ts

@@ -0,0 +1,12 @@
+import { PCExporter } from "../../../model/exporters/Exporter";
+import { PCPulsarFile } from "./PulsarFileGenerator";
+export declare class PCPulsarExporterConfigurationGenerator {
+    exporter: PCExporter;
+    constructor(exporter: PCExporter);
+    exporterConfigurationFile(): PCPulsarFile;
+    exporterConfigurationData(): Object;
+    sourceConfigurationFile(): PCPulsarFile;
+    sourceConfigurationData(): Object;
+    outputConfigurationFile(): PCPulsarFile;
+    outputConfigurationData(): Object;
+}

package/build/typings/core/src/pulsar/managers/generators/PulsarExporterJSONGenerator.d.ts

@@ -0,0 +1,8 @@
+import { PCExporter } from "../../../model/exporters/Exporter";
+import { PCPulsarFile } from "./PulsarFileGenerator";
+export declare class PCPulsarExporterJSONGenerator {
+    exporter: PCExporter;
+    constructor(exporter: PCExporter);
+    constructBlob(): Array<PCPulsarFile>;
+    constructBlobJSON(): string;
+}

package/build/typings/core/src/pulsar/managers/generators/PulsarExporterSourceFileGenerator.d.ts

@@ -0,0 +1,9 @@
+import { PCExporter } from "../../../model/exporters/Exporter";
+import { PCExporterSource } from "../../../model/sources/ExporterSource";
+import { PCPulsarFile } from "./PulsarFileGenerator";
+export declare class PCPulsarExporterSourceFileGenerator {
+    exporter: PCExporter;
+    constructor(exporter: PCExporter);
+    sourceFiles(): Array<PCPulsarFile>;
+    sourceFile(source: PCExporterSource, name: string): PCPulsarFile;
+}

package/build/typings/core/src/pulsar/managers/generators/PulsarExporterZIPGenerator.d.ts

@@ -0,0 +1,7 @@
+/// <reference types="node" />
+import { PCExporter } from "../../../model/exporters/Exporter";
+import { PCEngineExporterProcessingResult } from "../../PulsarInterface";
+export declare class PCPulsarZIPGenerator {
+    static constructZIPBufferForExporterStructure(exporter: PCExporter): NodeJS.ReadableStream;
+    static constructZIPBufferForExporterResult(result: PCEngineExporterProcessingResult): NodeJS.ReadableStream;
+}

package/build/typings/core/src/pulsar/managers/generators/PulsarFileGenerator.d.ts

@@ -0,0 +1,20 @@
+export declare type PCPulsarFileMap = Map<string, PCPulsarFile>;
+export declare type PCPulsarFileDescriptor = {
+    filename: string;
+    name: string;
+    extension: string;
+    directory: string;
+};
+export declare type PCPulsarFile = {
+    directory: string;
+    filename: string;
+    name: string;
+    extension: string;
+    content: string;
+    key: string;
+};
+export declare class PCPulsarFileGenerator {
+    constructor();
+    pulsarFileDescriptorForFileWrite(name: string, extension: string, directory: string | null, content: string | Object): PCPulsarFile;
+    pulsarFileDescriptorFromFilePath(filePath: string): PCPulsarFileDescriptor;
+}

package/build/typings/core/src/pulsar/managers/loaders/PulsarBaseLoader.d.ts

@@ -0,0 +1,5 @@
+import { PCExporter } from "../../../model/exporters/Exporter";
+export declare class PCPulsarBaseLoader {
+    constructor();
+    initialize(): Promise<PCExporter>;
+}

package/build/typings/core/src/pulsar/managers/loaders/local/PulsarFSLoader.d.ts

@@ -0,0 +1,11 @@
+import { PCPulsarBaseLoader } from "../PulsarBaseLoader";
+import { PCExporter } from "../../../../model/exporters/Exporter";
+import { PCPulsarFile, PCPulsarFileMap } from "../../generators/PulsarFileGenerator";
+export declare class PCPulsarFSLoader extends PCPulsarBaseLoader {
+    exporterRootURL: string;
+    constructor(sourceZIPURL: string);
+    initialize(): Promise<PCExporter>;
+    loadFilesFromRootDirectory(rootDirectory: string): Promise<PCPulsarFileMap>;
+    getFiles(directory: string): any;
+    loadFileAtUrl(filePath: string, rootDirectory: string): Promise<PCPulsarFile | null>;
+}

package/build/typings/core/src/pulsar/managers/loaders/memory/PulsarExporterJSONLoader.d.ts

@@ -0,0 +1,9 @@
+import { PCPulsarBaseLoader } from "../PulsarBaseLoader";
+import { PCExporter } from "../../../../model/exporters/Exporter";
+import { PCPulsarFile } from "../../generators/PulsarFileGenerator";
+export declare class PCPulsarExporterJSONLoader extends PCPulsarBaseLoader {
+    blob: string | Object;
+    constructor(blob: string | Object);
+    initialize(): Promise<PCExporter>;
+    validateBlobEntry(entry: PCPulsarFile): void;
+}

package/build/typings/core/src/pulsar/managers/loaders/memory/PulsarExporterMemoryLoader.d.ts

@@ -0,0 +1,11 @@
+import { PCPulsarBaseLoader } from "../PulsarBaseLoader";
+import { PCExporter } from "../../../../model/exporters/Exporter";
+import { PCPulsarFileMap } from "../../generators/PulsarFileGenerator";
+export declare class PCPulsarExporterMemoryLoader extends PCPulsarBaseLoader {
+    sourceFiles: PCPulsarFileMap;
+    constructor(sourceFiles: PCPulsarFileMap);
+    constructExporterFromSourceFiles(): Promise<PCExporter>;
+    private loadSourcesFromSourceDirectory;
+    private enhanceSourcesWithConfiguration;
+    private loadOutputMapping;
+}