@codenotch/codenotch.cli 1.0.33

package/src/models/Codenotch.ts

@@ -0,0 +1,361 @@
+import { JSONSchema7 } from "json-schema";
+
+export interface IWorkspaceCache {
+    apis: ProjectManifestApi[];
+    applications: ProjectManifestApplication[];
+    reactApplications: ProjectManifestReactApplication[];
+    expressComponents: ProjectManifestExpressComponent[];
+    scripts: ProjectManifestScript[];
+    pdfs: ProjectManifestPdf[];
+    emails: ProjectManifestEmail[];
+    htmls: ProjectManifestHtml[];
+    processes: ProjectManifestProcess[];
+    tableDataSources: ProjectManifestDatastore[];
+    documentDataSources: ProjectManifestDatastore[];
+}
+
+export class ProjectManifest {
+    projectName: string;
+    serviceName: string;
+    version: string;
+    index?: string; // The app that is served for the project root (/Tenant/myProject), default to Index.auml
+    packages: { [packageSource: string]: string };
+    apis: ProjectManifestApi[];
+    languages?: string[];
+
+    dependencies?: (ProjectManifestDependency | string)[];
+
+    applications: ProjectManifestApplication[];
+    reactApplications: ProjectManifestReactApplication[] | undefined; // React applications that can be served and embedded in express applications
+    expressComponents: ProjectManifestExpressComponent[] | undefined; // reusable AUML components that can be embedded in applications
+    scripts: ProjectManifestScript[] | undefined;
+    pdfs: ProjectManifestPdf[] | undefined;
+    emails: ProjectManifestEmail[] | undefined;
+    htmls: ProjectManifestHtml[] | undefined;
+
+    processes: ProjectManifestProcess[];
+
+    tableDataSources: ProjectManifestDatastore[];
+    documentDataSources: ProjectManifestDatastore[];
+
+    roles: ProjectManifestRole[];
+
+    postInstallationProcesses?: ProjectManifestPostInstallationProcess[];
+
+    constructor() {
+        this.projectName = '';
+        this.serviceName = '';
+        this.version = '0.0.0';
+        this.packages = {};
+        this.apis = [];
+        this.applications = [];
+        this.expressComponents = [];
+        this.scripts = [];
+        this.pdfs = [];
+        this.emails = [];
+        this.htmls = [];
+        this.processes = [];
+        this.tableDataSources = [];
+        this.documentDataSources = [];
+        this.roles = [];
+        this.languages = [];
+        this.postInstallationProcesses = [];
+    }
+}
+
+export class ProjectManifestPostInstallationProcess {
+    processName: string = '';;
+    startEvent: string = '';;
+}
+
+export class ProjectManifestDependency {
+    name: string = '';
+    version?: string = '';
+    //TODO more options ? optional dependency, auto install, ...
+}
+
+export class ProjectManifestRole {
+    name: string = ''
+    description: string = ''
+}
+
+export class ProjectManifestDatastore {
+    name: string;
+    file: string;
+    ttlMinutes?: number;
+
+    constructor() {
+        this.name = '';
+        this.file = '';
+    }
+}
+
+export class ProjectManifestProcess {
+    processName: string;
+    file: string;
+    startEvents: ProjectManifestProcessStartEvent[];
+    endEvent: JSONSchema7;
+    signals: ProjectManigestSignal[];
+    priority?: "immediate" | "high" | "medium" | "low";
+    minThreads?: number;
+    maxThreads?: number;
+
+    constructor() {
+        this.processName = '';
+        this.file = '';
+        this.startEvents = [];
+        this.endEvent = {};
+        this.signals = [];
+    }
+}
+
+export class ProjectManigestSignal {
+    signalId: string = '';
+    type: string = '';
+}
+
+export class ProjectManifestProcessStartEvent {
+    nodeId: string;
+    kind: string;
+    scope: string;
+    roles: string[];
+    input: JSONSchema7;
+
+    constructor() {
+        this.nodeId = '';
+        this.kind = '';
+        this.scope = '';
+        this.roles = [];
+        this.input = {};
+    }
+}
+
+export class ProjectManifestReactApplication {
+    applicationName: string;
+    file: string;
+    scope: string;
+    roles: string[];
+
+    constructor() {
+        this.applicationName = '';
+        this.file = '';
+        this.scope = '';
+        this.roles = [];
+    }
+}
+export class ProjectManifestApplication {
+    applicationName: string;
+    file: string;
+    scope: string;
+    roles: string[];
+
+    constructor() {
+        this.applicationName = '';
+        this.file = '';
+        this.scope = '';
+        this.roles = [];
+    }
+}
+
+export class ProjectManifestPdf {
+    name: string;
+    file: string;
+
+    constructor() {
+        this.name = '';
+        this.file = '';
+    }
+}
+
+export class ProjectManifestEmail {
+    name: string;
+    file: string;
+
+    constructor() {
+        this.name = '';
+        this.file = '';
+    }
+}
+
+export class ProjectManifestHtml {
+    name: string;
+    file: string;
+
+    constructor() {
+        this.name = '';
+        this.file = '';
+    }
+}
+
+export class ProjectManifestExpressComponent {
+    componentName: string;
+    file: string;
+
+    constructor() {
+        this.componentName = '';
+        this.file = '';
+    }
+}
+
+export class ProjectManifestScript {
+    file: string;
+
+    constructor() {
+        this.file = '';
+    }
+}
+
+export class ProjectManifestApplicationInsight {
+    key: string;
+    constructor() {
+        this.key = '';
+    }
+}
+
+export class ProjectManifestApi {
+    path: string;
+    method: string;
+    bpmn: string;
+    startNode: string;
+    accept: string;
+    priority?: "immediate" | "high" | "medium" | "low";
+    minThreads?: number;
+    maxThreads?: number;
+
+    constructor() {
+        this.path = '';
+        this.method = '';
+        this.bpmn = '';
+        this.startNode = '';
+        this.accept = '';
+    }
+}
+
+export class ProjectManifestParameter {
+    key: string;
+    value: string;
+
+    constructor() {
+        this.key = '';
+        this.value = '';
+    }
+}
+export interface IScenarioProjectManifest {
+    projectName: string;
+    serviceName: string;
+    version: string;
+
+    /**
+     * Expect an auml application name
+     */
+    index?: string;
+    packages: {
+        [packageSource: string]: string;
+    };
+    languages?: string[];
+    dependencies?: (ProjectManifestDependency | string)[];
+    roles: ProjectManifestRole[];
+    postInstallationProcesses?: ProjectManifestPostInstallationProcess[];
+    bpmnActivities?: { name: string, version: string }[];
+}
+
+export interface ApplicationManifest {
+    pwa?: PWAManifest;
+    html?: HTMLManifest;
+    auml?: AUMLManifest;
+}
+export interface HTMLManifest {
+    title?: string;
+    description?: string;
+    author?: string;
+    keywords?: string;
+    charset?: string;
+}
+
+
+export interface PWAManifest {
+    background_color?: string;
+    description?: string;
+    dir?: string;
+    display?: string;
+    icons?: PWAManifestIcon[];
+    lang?: string;
+    name?: string;
+    orientation?: string;
+    prefer_related_applications?: boolean;
+    related_applications?: PWAManifestRelatedApplications[];
+    scope?: string;
+    short_name?: string;
+    start_url?: string;
+    theme_color?: string;
+    shortcuts?: string;
+
+    display_override?: string[];
+}
+
+
+
+export interface PWAManifestIcon {
+    src?: string;
+    sizes?: string;
+    type?: string;
+}
+
+export interface PWAManifestRelatedApplications {
+    platform?: string;
+    url?: string;
+    id?: string;
+}
+
+export interface AUMLManifest {
+    name?: string;
+    description?: string;
+    logoURL?: string;
+    roles?: string[];
+    scope?: 'Public' | 'Internal' | 'External';
+}
+
+
+export interface ProjectState {
+    projectId: string;
+    projectLocation: ProjectLocation;
+    projectVersion: string;
+    serviceName: string;
+    time: string;
+    status: ProjectDeploymentStatus;
+    errors: string[] | null;
+    warnings: string[] | null;
+}
+
+export type ProjectDeploymentStatus = 'READY' | 'IN_PROGRESS' | 'FAILURE' | 'REMOVING';
+export type ProjectLocation = 'marketplace' | 'git' | 'upload';
+
+export interface IProcessTestReport {
+
+    ExecutionId: string; // Unique id for this execution of the test
+
+    Project: string; // Name of the project, NOT the service
+
+    ProjectVersion: string;
+
+    Success: boolean; // Overall result of the test
+
+    SuccessCount: number;
+
+    FailureCount: number;
+
+    Tests: IProcessTestExecutionResult[]; // Individual results for each test
+}
+
+export interface IProcessTestExecutionResult {
+    Name: string;
+    Success: boolean;
+    Errors: string[];
+    Asserts: IProcessTestAssertionResult[];
+}
+
+export interface IProcessTestAssertionResult {
+    Name: string;
+    Success: boolean;
+    Errors: string[];
+}