@webda/compiler 4.0.0-beta.3

package/lib/configuration.js

@@ -0,0 +1,170 @@
+import { FileUtils, JSONUtils } from "@webda/utils";
+import { relative, dirname } from "node:path";
+/**
+ * Generate regex based on a service name
+ *
+ * The regex will ensure the namespace is optional
+ *
+ * @param app - the application to resolve namespaces
+ * @param type - the service type name
+ * @returns regex pattern string
+ */
+function getServiceTypePattern(app, type) {
+    const split = app.completeNamespace(type).split("/");
+    return `^(${split[0]}/)?${split[1]}$`;
+}
+/**
+ * Generate the configuration and deployment schemas
+ *
+ * @param app to use for application metadata
+ * @param filename to save config schema to
+ * @param deploymentFilename to save deployment schema to
+ * @param full to keep all required
+ * @param configFile - optional config file path to update $schema reference
+ */
+export function generateConfigurationSchemas(app, filename = ".webda/config.schema.json", deploymentFilename = ".webda/deployment.schema.json", full = false, configFile) {
+    // Build the base configuration schema structure
+    let res = {
+        type: "object",
+        properties: {
+            $schema: { type: "string" },
+            $import: {
+                anyOf: [{ type: "string" }, { items: { type: "string" }, type: "array" }],
+                description: "Include other configuration files"
+            },
+            version: { type: "number" },
+            parameters: {
+                type: "object",
+                additionalProperties: true,
+                description: "Global parameters shared between all services"
+            },
+            services: {
+                type: "object",
+                additionalProperties: {
+                    oneOf: []
+                }
+            },
+            models: {
+                type: "object",
+                additionalProperties: true
+            }
+        },
+        definitions: {}
+    };
+    // Add the definition for types
+    res.definitions.ServicesType = {
+        type: "string",
+        enum: Object.keys(app.getModdas() || {})
+    };
+    const addServiceSchema = (type) => {
+        return serviceType => {
+            const key = `${type}$${serviceType.replace(/\//g, "$")}`;
+            const definition = (res.definitions[key] = app.getSchema(serviceType));
+            /* should try to mock the getSchema */
+            /* c8 ignore next 3 */
+            if (!definition) {
+                return;
+            }
+            definition.title ??= serviceType;
+            if (definition.properties?.type) {
+                definition.properties.type.pattern = getServiceTypePattern(app, serviceType);
+            }
+            res.properties.services.additionalProperties.oneOf.push({
+                $ref: `#/definitions/${key}`
+            });
+            delete res.definitions[key]["$schema"];
+            // Flatten definition (might not be the best idea)
+            for (const def in definition.definitions) {
+                res.definitions[def] ??= definition.definitions[def];
+            }
+            delete definition.definitions;
+            // Remove mandatory depending on option
+            if (!full) {
+                res.definitions[key]["required"] = ["type"];
+            }
+            // Predefine beans
+            if (type === "BeanType") {
+                res.properties.services.properties ??= {};
+                res.properties.services[definition.title] = {
+                    $ref: `#/definitions/${key}`
+                };
+                res.definitions[key].required ??= [];
+                res.definitions[key].required = res.definitions[key].required.filter(p => p !== "type");
+            }
+        };
+    };
+    Object.keys(app.getModdas()).forEach(addServiceSchema("ServiceType"));
+    Object.keys(app.getModules().beans || {}).forEach(addServiceSchema("BeanType"));
+    FileUtils.save(res, filename);
+    // Build the deployment schema
+    // Ensure builtin deployers are there
+    const definitions = JSONUtils.duplicate(res.definitions);
+    res = {
+        properties: {
+            parameters: {
+                type: "object",
+                additionalProperties: true
+            },
+            resources: {
+                type: "object",
+                additionalProperties: true
+            },
+            services: {
+                type: "object",
+                additionalProperties: false,
+                properties: {}
+            },
+            units: {
+                type: "array",
+                items: { oneOf: [] }
+            }
+        },
+        definitions: res.definitions
+    };
+    const appServices = app.getConfiguration().services;
+    Object.keys(appServices || {}).forEach(k => {
+        if (!appServices[k]) {
+            return;
+        }
+        const key = `Service$${k}`;
+        res.properties.services.properties[k] = {
+            type: "object",
+            oneOf: [
+                { $ref: `#/definitions/${key}` },
+                ...Object.keys(definitions)
+                    .filter(name => name.startsWith("ServiceType"))
+                    .map(dkey => ({ $ref: `#/definitions/${dkey}` }))
+            ]
+        };
+    });
+    Object.keys(app.getDeployers()).forEach(serviceType => {
+        const key = `DeployerType$${serviceType.replace(/\//g, "$")}`;
+        const definition = (res.definitions[key] = app.getSchema(serviceType));
+        if (!definition) {
+            return;
+        }
+        definition.title = serviceType;
+        if (definition.properties?.type) {
+            definition.properties.type.pattern = getServiceTypePattern(app, serviceType);
+        }
+        res.properties.units.items.oneOf.push({
+            $ref: `#/definitions/${key}`
+        });
+        delete definition["$schema"];
+        // Remove mandatory depending on option
+        if (!full) {
+            definition["required"] = ["type"];
+        }
+    });
+    FileUtils.save(res, deploymentFilename);
+    // Ensure $schema is set in the configuration file
+    if (configFile) {
+        const config = FileUtils.load(configFile);
+        const schemaRef = relative(dirname(configFile), filename);
+        if (config.$schema !== schemaRef) {
+            config.$schema = schemaRef;
+            FileUtils.save(config, configFile);
+        }
+    }
+}
+//# sourceMappingURL=configuration.js.map

package/lib/configuration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"configuration.js","sourceRoot":"","sources":["../src/configuration.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEpD,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAc9C;;;;;;;;GAQG;AACH,SAAS,qBAAqB,CAAC,GAA4B,EAAE,IAAY;IACvE,MAAM,KAAK,GAAG,GAAG,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACrD,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC;AACxC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,4BAA4B,CAC1C,GAA4B,EAC5B,QAAQ,GAAW,2BAA2B,EAC9C,kBAAkB,GAAW,+BAA+B,EAC5D,IAAI,GAAY,KAAK,EACrB,UAAmB;IAEnB,gDAAgD;IAChD,IAAI,GAAG,GAAgB;QACrB,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;YAC3B,OAAO,EAAE;gBACP,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;gBACzE,WAAW,EAAE,mCAAmC;aACjD;YACD,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;YAC3B,UAAU,EAAE;gBACV,IAAI,EAAE,QAAQ;gBACd,oBAAoB,EAAE,IAAI;gBAC1B,WAAW,EAAE,+CAA+C;aAC7D;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,oBAAoB,EAAE;oBACpB,KAAK,EAAE,EAAE;iBACV;aACF;YACD,MAAM,EAAE;gBACN,IAAI,EAAE,QAAQ;gBACd,oBAAoB,EAAE,IAAI;aAC3B;SACF;QACD,WAAW,EAAE,EAAE;KAChB,CAAC;IACF,+BAA+B;IAC/B,GAAG,CAAC,WAAW,CAAC,YAAY,GAAG;QAC7B,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,EAAE,CAAC;KACzC,CAAC;IACF,MAAM,gBAAgB,GAAG,CAAC,IAAgC,EAAE,EAAE;QAC5D,OAAO,WAAW,CAAC,EAAE;YACnB,MAAM,GAAG,GAAG,GAAG,IAAI,IAAI,WAAW,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC;YACzD,MAAM,UAAU,GAAgB,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC;YACpF,sCAAsC;YACtC,sBAAsB;YACtB,IAAI,CAAC,UAAU,EAAE,CAAC;gBAChB,OAAO;YACT,CAAC;YACD,UAAU,CAAC,KAAK,KAAK,WAAW,CAAC;YACjC,IAAI,UAAU,CAAC,UAAU,EAAE,IAAI,EAAE,CAAC;gBAClB,UAAU,CAAC,UAAU,CAAC,IAAK,CAAC,OAAO,GAAG,qBAAqB,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;YAC9F,CAAC;YAC2B,GAAG,CAAC,UAAU,CAAC,QAAS,CAAC,oBAAqB,CAAC,KAAK,CAAC,IAAI,CAAC;gBACpF,IAAI,EAAE,iBAAiB,GAAG,EAAE;aAC7B,CAAC,CAAC;YACH,OAAO,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC;YACvC,kDAAkD;YAClD,KAAK,MAAM,GAAG,IAAI,UAAU,CAAC,WAAW,EAAE,CAAC;gBACzC,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,UAAU,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;YACvD,CAAC;YACD,OAAO,UAAU,CAAC,WAAW,CAAC;YAC9B,uCAAuC;YACvC,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YAC9C,CAAC;YACD,kBAAkB;YAClB,IAAI,IAAI,KAAK,UAAU,EAAE,CAAC;gBACV,GAAG,CAAC,UAAU,CAAC,QAAS,CAAC,UAAU,KAAK,EAAE,CAAC;gBACzD,GAAG,CAAC,UAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG;oBAC1C,IAAI,EAAE,iBAAiB,GAAG,EAAE;iBAC7B,CAAC;gBACY,GAAG,CAAC,WAAW,CAAC,GAAG,CAAE,CAAC,QAAQ,KAAK,EAAE,CAAC;gBACtC,GAAG,CAAC,WAAW,CAAC,GAAG,CAAE,CAAC,QAAQ,GAAiB,GAAG,CAAC,WAAW,CAAC,GAAG,CAAE,CAAC,QAAQ,CAAC,MAAM,CAChG,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,MAAM,CAClB,CAAC;YACJ,CAAC;QACH,CAAC,CAAC;IACJ,CAAC,CAAC;IACF,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC,CAAC;IACtE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC;IAChF,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IAC9B,8BAA8B;IAC9B,qCAAqC;IACrC,MAAM,WAAW,GAAG,SAAS,CAAC,SAAS,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IACzD,GAAG,GAAG;QACJ,UAAU,EAAE;YACV,UAAU,EAAE;gBACV,IAAI,EAAE,QAAQ;gBACd,oBAAoB,EAAE,IAAI;aAC3B;YACD,SAAS,EAAE;gBACT,IAAI,EAAE,QAAQ;gBACd,oBAAoB,EAAE,IAAI;aAC3B;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,oBAAoB,EAAE,KAAK;gBAC3B,UAAU,EAAE,EAAE;aACf;YACD,KAAK,EAAE;gBACL,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE;aACrB;SACF;QACD,WAAW,EAAE,GAAG,CAAC,WAAW;KAC7B,CAAC;IACF,MAAM,WAAW,GAAG,GAAG,CAAC,gBAAgB,EAAE,CAAC,QAAQ,CAAC;IACpD,MAAM,CAAC,IAAI,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;QACzC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC;YACpB,OAAO;QACT,CAAC;QACD,MAAM,GAAG,GAAG,WAAW,CAAC,EAAE,CAAC;QACb,GAAG,CAAC,UAAU,CAAC,QAAS,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG;YACrD,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE;gBACL,EAAE,IAAI,EAAE,iBAAiB,GAAG,EAAE,EAAE;gBAChC,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC;qBACxB,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;qBAC9C,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,iBAAiB,IAAI,EAAE,EAAE,CAAC,CAAC;aACpD;SACF,CAAC;IACJ,CAAC,CAAC,CAAC;IACH,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;QACpD,MAAM,GAAG,GAAG,gBAAgB,WAAW,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,CAAC;QAC9D,MAAM,UAAU,GAAgB,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC;QACpF,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,OAAO;QACT,CAAC;QACD,UAAU,CAAC,KAAK,GAAG,WAAW,CAAC;QAC/B,IAAI,UAAU,CAAC,UAAU,EAAE,IAAI,EAAE,CAAC;YAClB,UAAU,CAAC,UAAU,CAAC,IAAK,CAAC,OAAO,GAAG,qBAAqB,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC;QAC9F,CAAC;QAC2B,GAAG,CAAC,UAAU,CAAC,KAAM,CAAC,KAAM,CAAC,KAAK,CAAC,IAAI,CAAC;YAClE,IAAI,EAAE,iBAAiB,GAAG,EAAE;SAC7B,CAAC,CAAC;QACH,OAAO,UAAU,CAAC,SAAS,CAAC,CAAC;QAC7B,uCAAuC;QACvC,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACpC,CAAC;IACH,CAAC,CAAC,CAAC;IACH,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,kBAAkB,CAAC,CAAC;IAExC,kDAAkD;IAClD,IAAI,UAAU,EAAE,CAAC;QACf,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC1C,MAAM,SAAS,GAAG,QAAQ,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,QAAQ,CAAC,CAAC;QAC1D,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACjC,MAAM,CAAC,OAAO,GAAG,SAAS,CAAC;YAC3B,SAAS,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;QACrC,CAAC;IACH,CAAC;AACH,CAAC"}