@itwin/core-backend 4.8.0-dev.3 → 4.8.0-dev.31

package/lib/cjs/internal/workspace/SettingsSchemasImpl.js

@@ -0,0 +1,276 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Workspace
+ */
+var _a;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.constructSettingsSchemas = void 0;
+const fs = require("fs-extra");
+const json5_1 = require("json5");
+const path_1 = require("path");
+const core_bentley_1 = require("@itwin/core-bentley");
+const IModelJsFs_1 = require("../../IModelJsFs");
+const Symbols_1 = require("../Symbols");
+const makeSettingKey = (prefix, key) => `${prefix}/${key}`;
+class SettingsSchemasImpl {
+    constructor() {
+        this[_a] = undefined;
+        this._allGroups = new Map();
+        /** a map of all registered Setting Definitions  */
+        this.settingDefs = new Map();
+        /** a map of all registered TypeDefs  */
+        this.typeDefs = new Map();
+        /** event that signals that the values in [[allSchemas]] have changed in some way. */
+        this.onSchemaChanged = new core_bentley_1.BeEvent();
+    }
+    verifyType(val, expectedType, path) {
+        if (expectedType === "integer") {
+            if (Number.isInteger(val))
+                return;
+        }
+        else if (expectedType === "null") {
+            if (val === null || val === undefined)
+                return;
+        }
+        else if (typeof val === expectedType)
+            return;
+        throw new Error(`value for ${path}: "${val}" is wrong type, expected ${expectedType}`);
+    }
+    validateSetting(value, settingName) {
+        const settingDef = this.settingDefs.get(settingName);
+        if (undefined !== settingDef) // if there's no setting definition, there's no rules so just return ok
+            this.validateProperty(value, settingDef, settingName);
+        return value;
+    }
+    /** @internal */
+    getObjectProperties(propDef, scope) {
+        let required = propDef.required;
+        let properties = propDef.properties;
+        // if this object extends a typeDef, add typeDef's properties and required values, recursively
+        if (propDef.extends !== undefined) {
+            const typeDef = this.typeDefs.get(propDef.extends);
+            if (undefined === typeDef)
+                throw new Error(`typeDef ${propDef.extends} does not exist for ${scope}`);
+            const expanded = this.getObjectProperties(typeDef, `${scope}.${propDef.extends}`);
+            if (expanded.required)
+                required = required ? [...required, ...expanded.required] : expanded.required;
+            if (expanded.properties) {
+                properties = properties ? { ...expanded.properties, ...properties } : expanded.properties;
+            }
+        }
+        properties = properties ?? {};
+        return { required, properties };
+    }
+    /** @internal */
+    getArrayItems(propDef, scope) {
+        let items = propDef.items;
+        if (undefined === items && propDef.extends) {
+            const typeDef = this.typeDefs.get(propDef.extends);
+            if (undefined === typeDef)
+                throw new Error(`typeDef ${propDef.extends} does not exist for ${scope}`);
+            items = typeDef.items;
+        }
+        if (undefined === items)
+            throw new Error(`array ${scope} has no items definition`);
+        return items;
+    }
+    validateProperty(val, propDef, path) {
+        switch (propDef.type) {
+            case "boolean":
+            case "number":
+            case "string":
+            case "integer":
+            case "null":
+                return this.verifyType(val, propDef.type, path);
+            case "array":
+                if (!Array.isArray(val))
+                    throw new Error(`Property ${path} must be an array`);
+                const items = this.getArrayItems(propDef, path);
+                for (let i = 0; i < val.length; ++i)
+                    this.validateProperty(val[i], items, `${path}[${i}]`);
+                return;
+        }
+        if (!val || typeof val !== "object")
+            throw new Error(`${path} must be an object`);
+        const { required, properties } = this.getObjectProperties(propDef, path);
+        // first ensure all required properties are present
+        if (undefined !== required) {
+            for (const entry of required) {
+                const value = val[entry];
+                if (undefined === value)
+                    throw new Error(`required value for "${entry}" is missing in "${path}"`);
+            }
+        }
+        // you can supply default values in typeDefs. See if any members are undefined that have a default.
+        if (undefined !== properties) {
+            for (const [key, prop] of Object.entries(properties)) {
+                if (val[key] === undefined && prop.default)
+                    val[key] = prop.default;
+            }
+        }
+        // then validate all values in the supplied object are valid
+        for (const key of Object.keys(val)) {
+            const prop = properties[key];
+            if (prop !== undefined) { // note: extra values are ignored.
+                this.validateProperty(val[key], prop, `${path}.${key}`);
+            }
+        }
+    }
+    /**
+     * Add one or more [[SettingSchemaGroup]]s. `SettingSchemaGroup`s must include a `schemaPrefix` member that is used
+     * to identify the group. If a group with the same name is already registered, the old values are first removed and then the new group is added.
+     */
+    addGroup(settingsGroup) {
+        if (!Array.isArray(settingsGroup))
+            settingsGroup = [settingsGroup];
+        this.doAdd(settingsGroup);
+        this.onSchemaChanged.raiseEvent();
+    }
+    /** Add a [[SettingSchemaGroup]] from stringified json5. */
+    addJson(settingSchema) {
+        this.addGroup((0, json5_1.parse)(settingSchema));
+    }
+    /** Add a [[SettingSchemaGroup]] from a json5 file. */
+    addFile(fileName) {
+        try {
+            this.addJson(fs.readFileSync(fileName, "utf-8"));
+        }
+        catch (e) {
+            throw new Error(`parsing SettingSchema file "${fileName}": ${e.message}"`);
+        }
+    }
+    /** Add all files with a either ".json" or ".json5" extension from a supplied directory. */
+    addDirectory(dirName) {
+        for (const fileName of IModelJsFs_1.IModelJsFs.readdirSync(dirName)) {
+            const ext = (0, path_1.extname)(fileName);
+            if (ext === ".json5" || ext === ".json")
+                this.addFile((0, path_1.join)(dirName, fileName));
+        }
+    }
+    /** Remove a previously added [[SettingSchemaGroup]] by schemaPrefix */
+    removeGroup(schemaPrefix) {
+        this.doRemove(schemaPrefix);
+        this.onSchemaChanged.raiseEvent();
+    }
+    doAdd(settingsGroup) {
+        settingsGroup.forEach((group) => {
+            if (undefined === group.schemaPrefix)
+                throw new Error(`settings group has no "schemaPrefix" member`);
+            this.doRemove(group.schemaPrefix);
+            this.validateAndAdd(group);
+            this._allGroups.set(group.schemaPrefix, group);
+        });
+    }
+    doRemove(schemaPrefix) {
+        const group = this._allGroups.get(schemaPrefix);
+        if (undefined !== group?.settingDefs) {
+            for (const key of Object.keys(group.settingDefs))
+                this.settingDefs.delete(makeSettingKey(schemaPrefix, key));
+        }
+        if (undefined !== group?.typeDefs) {
+            for (const key of Object.keys(group.typeDefs))
+                this.settingDefs.delete(makeSettingKey(schemaPrefix, key));
+        }
+        this._allGroups.delete(schemaPrefix);
+    }
+    validateName(name) {
+        if (!name.trim())
+            throw new Error(`empty property name`);
+    }
+    verifyPropertyDef(name, property) {
+        if (!property)
+            throw new Error(`missing required property ${name}`);
+        if (!property.type)
+            throw new Error(`property ${name} has no type`);
+        switch (property.type) {
+            case "boolean":
+            case "integer":
+            case "null":
+            case "number":
+            case "string":
+                return;
+            case "object":
+                const required = property.required;
+                const props = property.properties;
+                if (required && props) {
+                    for (const entry of required) {
+                        if (undefined === props[entry])
+                            throw new Error(`missing required property of ${name}: "${entry}"`);
+                    }
+                }
+                if (props) {
+                    for (const key of Object.keys(props))
+                        try {
+                            this.verifyPropertyDef(key, props[key]);
+                        }
+                        catch (e) {
+                            throw new Error(`property ${key} of ${name}: ${e.message}`);
+                        }
+                }
+                return;
+            case "array":
+                if (typeof property.extends === "string")
+                    return;
+                if (typeof property.items !== "object")
+                    throw new Error(`array property ${name} has no items member`);
+                try {
+                    this.verifyPropertyDef("items", property.items);
+                }
+                catch (e) {
+                    throw new Error(`array property ${name}: ${e.message}`);
+                }
+                return;
+            default:
+                throw new Error(`property ${name} has illegal type "${property.type}"`);
+        }
+    }
+    validateAndAdd(group) {
+        const settingDefs = group.settingDefs;
+        if (undefined !== settingDefs) {
+            for (const key of Object.keys(settingDefs)) {
+                this.validateName(key);
+                this.verifyPropertyDef(key, settingDefs[key]);
+                const property = settingDefs[key];
+                (0, core_bentley_1.assert)(undefined !== property);
+                property.default = property.default ?? this.getDefaultValue(property.type);
+                this.settingDefs.set(makeSettingKey(group.schemaPrefix, key), property);
+            }
+        }
+        const typeDefs = group.typeDefs ?? {};
+        for (const key of Object.keys(typeDefs)) {
+            this.validateName(key);
+            this.verifyPropertyDef(key, typeDefs[key]);
+            const typeDef = typeDefs[key];
+            (0, core_bentley_1.assert)(undefined !== typeDef);
+            this.typeDefs.set(makeSettingKey(group.schemaPrefix, key), typeDef);
+        }
+    }
+    getDefaultValue(type) {
+        type = Array.isArray(type) ? type[0] : type;
+        switch (type) {
+            case "boolean":
+                return false;
+            case "integer":
+            case "number":
+                return 0;
+            case "string":
+                return "";
+            case "array":
+                return [];
+            case "object":
+                return {};
+            default:
+                return undefined;
+        }
+    }
+}
+_a = Symbols_1._implementationProhibited;
+function constructSettingsSchemas() {
+    return new SettingsSchemasImpl();
+}
+exports.constructSettingsSchemas = constructSettingsSchemas;
+//# sourceMappingURL=SettingsSchemasImpl.js.map

package/lib/cjs/internal/workspace/SettingsSchemasImpl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SettingsSchemasImpl.js","sourceRoot":"","sources":["../../../../src/internal/workspace/SettingsSchemasImpl.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;;AAEH,+BAA+B;AAC/B,iCAA8B;AAC9B,+BAAqC;AACrC,sDAAmG;AAEnG,iDAA8C;AAE9C,wCAAuD;AAEvD,MAAM,cAAc,GAAG,CAAC,MAAc,EAAE,GAAW,EAAE,EAAE,CAAC,GAAG,MAAM,IAAI,GAAG,EAAE,CAAC;AAE3E,MAAM,mBAAmB;IAAzB;QACkB,QAA2B,GAAG,SAAS,CAAC;QACvC,eAAU,GAAG,IAAI,GAAG,EAA8B,CAAC;QACpE,mDAAmD;QACnC,gBAAW,GAAG,IAAI,GAAG,EAAyB,CAAC;QAC/D,wCAAwC;QACxB,aAAQ,GAAG,IAAI,GAAG,EAAyB,CAAC;QAC5D,qFAAqF;QACrE,oBAAe,GAAG,IAAI,sBAAO,EAAc,CAAC;IA0Q9D,CAAC;IAxQS,UAAU,CAAI,GAAM,EAAE,YAAgC,EAAE,IAAY;QAC1E,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;YAC/B,IAAI,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC;gBACvB,OAAO;QACX,CAAC;aAAM,IAAI,YAAY,KAAK,MAAM,EAAE,CAAC;YACnC,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,KAAK,SAAS;gBACnC,OAAO;QACX,CAAC;aAAM,IAAI,OAAO,GAAG,KAAK,YAAY;YACpC,OAAO;QAET,MAAM,IAAI,KAAK,CAAC,aAAa,IAAI,MAAM,GAAG,6BAA6B,YAAY,EAAE,CAAC,CAAC;IACzF,CAAC;IAEM,eAAe,CAAI,KAAQ,EAAE,WAAmB;QACrD,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QACrD,IAAI,SAAS,KAAK,UAAU,EAAE,uEAAuE;YACnG,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;QACxD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gBAAgB;IACT,mBAAmB,CAAC,OAAgC,EAAE,KAAa;QACxE,IAAI,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QAChC,IAAI,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QAEpC,8FAA8F;QAC9F,IAAI,OAAO,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAClC,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACnD,IAAI,SAAS,KAAK,OAAO;gBACvB,MAAM,IAAI,KAAK,CAAC,WAAW,OAAO,CAAC,OAAO,uBAAuB,KAAK,EAAE,CAAC,CAAC;YAC5E,MAAM,QAAQ,GAAG,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,GAAG,KAAK,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;YAClF,IAAI,QAAQ,CAAC,QAAQ;gBACnB,QAAQ,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,EAAE,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC;YAChF,IAAI,QAAQ,CAAC,UAAU,EAAE,CAAC;gBACxB,UAAU,GAAG,UAAU,CAAC,CAAC,CAAC,EAAE,GAAG,QAAQ,CAAC,UAAU,EAAE,GAAG,UAAU,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC;YAC5F,CAAC;QACH,CAAC;QACD,UAAU,GAAG,UAAU,IAAI,EAAE,CAAC;QAC9B,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC;IAClC,CAAC;IAED,gBAAgB;IACT,aAAa,CAAC,OAAgC,EAAE,KAAa;QAClE,IAAI,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAC1B,IAAI,SAAS,KAAK,KAAK,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YAC3C,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACnD,IAAI,SAAS,KAAK,OAAO;gBACvB,MAAM,IAAI,KAAK,CAAC,WAAW,OAAO,CAAC,OAAO,uBAAuB,KAAK,EAAE,CAAC,CAAC;YAC5E,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QACxB,CAAC;QACD,IAAI,SAAS,KAAK,KAAK;YACrB,MAAM,IAAI,KAAK,CAAC,SAAS,KAAK,0BAA0B,CAAC,CAAC;QAC5D,OAAO,KAAK,CAAC;IACf,CAAC;IAEO,gBAAgB,CAAI,GAAM,EAAE,OAAgC,EAAE,IAAY;QAChF,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC;YACrB,KAAK,SAAS,CAAC;YACf,KAAK,QAAQ,CAAC;YACd,KAAK,QAAQ,CAAC;YACd,KAAK,SAAS,CAAC;YACf,KAAK,MAAM;gBACT,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YAElD,KAAK,OAAO;gBACV,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC;oBACrB,MAAM,IAAI,KAAK,CAAC,YAAY,IAAI,mBAAmB,CAAC,CAAC;gBACvD,MAAM,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;gBAChD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC;oBACjC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC;gBACxD,OAAO;QACX,CAAC;QACD,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ;YACjC,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,oBAAoB,CAAC,CAAC;QAE/C,MAAM,EAAE,QAAQ,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,mBAAmB,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAEzE,mDAAmD;QACnD,IAAI,SAAS,KAAK,QAAQ,EAAE,CAAC;YAC3B,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;gBAC7B,MAAM,KAAK,GAAI,GAAW,CAAC,KAAK,CAAC,CAAC;gBAClC,IAAI,SAAS,KAAK,KAAK;oBACrB,MAAM,IAAI,KAAK,CAAC,uBAAuB,KAAK,oBAAoB,IAAI,GAAG,CAAC,CAAC;YAC7E,CAAC;QACH,CAAC;QAED,mGAAmG;QACnG,IAAI,SAAS,KAAK,UAAU,EAAE,CAAC;YAC7B,KAAK,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;gBACrD,IAAK,GAAW,CAAC,GAAG,CAAC,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO;oBAChD,GAAW,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC;YACrC,CAAC;QACH,CAAC;QAED,4DAA4D;QAC5D,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;YACnC,MAAM,IAAI,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;YAC7B,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC,CAAC,kCAAkC;gBAC1D,IAAI,CAAC,gBAAgB,CAAE,GAAW,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,GAAG,IAAI,IAAI,GAAG,EAAE,CAAC,CAAC;YACnE,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,QAAQ,CAAC,aAAwD;QACtE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,aAAa,CAAC;YAC/B,aAAa,GAAG,CAAC,aAAa,CAAC,CAAC;QAElC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;QAC1B,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,CAAC;IACpC,CAAC;IAED,2DAA2D;IACpD,OAAO,CAAC,aAAqB;QAClC,IAAI,CAAC,QAAQ,CAAC,IAAA,aAAK,EAAC,aAAa,CAAC,CAAC,CAAC;IACtC,CAAC;IAED,sDAAsD;IAC/C,OAAO,CAAC,QAAuB;QACpC,IAAI,CAAC;YACH,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC;QACnD,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,+BAA+B,QAAQ,MAAM,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC;QAC7E,CAAC;IACH,CAAC;IAED,2FAA2F;IACpF,YAAY,CAAC,OAAqB;QACvC,KAAK,MAAM,QAAQ,IAAI,uBAAU,CAAC,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC;YACvD,MAAM,GAAG,GAAG,IAAA,cAAO,EAAC,QAAQ,CAAC,CAAC;YAC9B,IAAI,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,OAAO;gBACrC,IAAI,CAAC,OAAO,CAAC,IAAA,WAAI,EAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;QAC1C,CAAC;IACH,CAAC;IAED,uEAAuE;IAChE,WAAW,CAAC,YAAoB;QACrC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QAC5B,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,CAAC;IACpC,CAAC;IAEO,KAAK,CAAC,aAAmC;QAC/C,aAAa,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC9B,IAAI,SAAS,KAAK,KAAK,CAAC,YAAY;gBAClC,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;YAEjE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YAClC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YAC3B,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,KAAK,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,QAAQ,CAAC,YAAoB;QACnC,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QAChD,IAAI,SAAS,KAAK,KAAK,EAAE,WAAW,EAAE,CAAC;YACrC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC;gBAC9C,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,cAAc,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC,CAAC;QAC/D,CAAC;QACD,IAAI,SAAS,KAAK,KAAK,EAAE,QAAQ,EAAE,CAAC;YAClC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;gBAC3C,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,cAAc,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC,CAAC;QAC/D,CAAC;QACD,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;IACvC,CAAC;IAEO,YAAY,CAAC,IAAY;QAC/B,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;YACd,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAC3C,CAAC;IAEO,iBAAiB,CAAC,IAAY,EAAE,QAAmC;QACzE,IAAI,CAAC,QAAQ;YACX,MAAM,IAAI,KAAK,CAAC,6BAA6B,IAAI,EAAE,CAAC,CAAC;QAEvD,IAAI,CAAC,QAAQ,CAAC,IAAI;YAChB,MAAM,IAAI,KAAK,CAAC,YAAY,IAAI,cAAc,CAAC,CAAC;QAElD,QAAQ,QAAQ,CAAC,IAAI,EAAE,CAAC;YACtB,KAAK,SAAS,CAAC;YACf,KAAK,SAAS,CAAC;YACf,KAAK,MAAM,CAAC;YACZ,KAAK,QAAQ,CAAC;YACd,KAAK,QAAQ;gBACX,OAAO;YAET,KAAK,QAAQ;gBACX,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;gBACnC,MAAM,KAAK,GAAG,QAAQ,CAAC,UAAU,CAAC;gBAClC,IAAI,QAAQ,IAAI,KAAK,EAAE,CAAC;oBACtB,KAAK,MAAM,KAAK,IAAI,QAAQ,EAAE,CAAC;wBAC7B,IAAI,SAAS,KAAK,KAAK,CAAC,KAAK,CAAC;4BAC5B,MAAM,IAAI,KAAK,CAAC,gCAAgC,IAAI,MAAM,KAAK,GAAG,CAAC,CAAC;oBACxE,CAAC;gBACH,CAAC;gBACD,IAAI,KAAK,EAAE,CAAC;oBACV,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;wBAClC,IAAI,CAAC;4BACH,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;wBAC1C,CAAC;wBAAC,OAAO,CAAM,EAAE,CAAC;4BAChB,MAAM,IAAI,KAAK,CAAC,YAAY,GAAG,OAAO,IAAI,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;wBAC9D,CAAC;gBACL,CAAC;gBACD,OAAO;YAET,KAAK,OAAO;gBACV,IAAI,OAAO,QAAQ,CAAC,OAAO,KAAK,QAAQ;oBACtC,OAAO;gBACT,IAAI,OAAO,QAAQ,CAAC,KAAK,KAAK,QAAQ;oBACpC,MAAM,IAAI,KAAK,CAAC,kBAAkB,IAAI,sBAAsB,CAAC,CAAC;gBAChE,IAAI,CAAC;oBACH,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC;gBAClD,CAAC;gBAAC,OAAO,CAAM,EAAE,CAAC;oBAChB,MAAM,IAAI,KAAK,CAAC,kBAAkB,IAAI,KAAK,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;gBAC1D,CAAC;gBACD,OAAO;YAET;gBACE,MAAM,IAAI,KAAK,CAAC,YAAY,IAAI,sBAAsB,QAAQ,CAAC,IAAI,GAAG,CAAC,CAAC;QAC5E,CAAC;IACH,CAAC;IAEO,cAAc,CAAC,KAAyB;QAC9C,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,IAAI,SAAS,KAAK,WAAW,EAAE,CAAC;YAC9B,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;gBAC3C,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;gBACvB,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC;gBAC9C,MAAM,QAAQ,GAAuC,WAAW,CAAC,GAAG,CAAC,CAAC;gBACtE,IAAA,qBAAM,EAAC,SAAS,KAAK,QAAQ,CAAC,CAAC;gBAC/B,QAAQ,CAAC,OAAO,GAAG,QAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;gBAC3E,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,cAAc,CAAC,KAAK,CAAC,YAAY,EAAE,GAAG,CAAC,EAAE,QAAQ,CAAC,CAAC;YAC1E,CAAC;QACH,CAAC;QACD,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,IAAI,EAAE,CAAC;QACtC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YACxC,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;YACvB,IAAI,CAAC,iBAAiB,CAAC,GAAG,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;YAC3C,MAAM,OAAO,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;YAC9B,IAAA,qBAAM,EAAC,SAAS,KAAK,OAAO,CAAC,CAAC;YAC9B,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,cAAc,CAAC,KAAK,CAAC,YAAY,EAAE,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC;QACtE,CAAC;IACH,CAAC;IAEO,eAAe,CAAC,IAA+C;QACrE,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAC5C,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,SAAS;gBACZ,OAAO,KAAK,CAAC;YACf,KAAK,SAAS,CAAC;YACf,KAAK,QAAQ;gBACX,OAAO,CAAC,CAAC;YACX,KAAK,QAAQ;gBACX,OAAO,EAAE,CAAC;YACZ,KAAK,OAAO;gBACV,OAAO,EAAE,CAAC;YACZ,KAAK,QAAQ;gBACX,OAAO,EAAE,CAAC;YACZ;gBACE,OAAO,SAAS,CAAC;QACrB,CAAC;IACH,CAAC;CACF;KAjRkB,mCAAyB;AAmR5C,SAAgB,wBAAwB;IACtC,OAAO,IAAI,mBAAmB,EAAE,CAAC;AACnC,CAAC;AAFD,4DAEC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Workspace\n */\n\nimport * as fs from \"fs-extra\";\nimport { parse } from \"json5\";\nimport { extname, join } from \"path\";\nimport { assert, BeEvent, JSONSchemaType, JSONSchemaTypeName, Mutable } from \"@itwin/core-bentley\";\nimport { LocalDirName, LocalFileName } from \"@itwin/core-common\";\nimport { IModelJsFs } from \"../../IModelJsFs\";\nimport { SettingGroupSchema, SettingSchema, SettingsSchemas } from \"../../workspace/SettingsSchemas\";\nimport { _implementationProhibited } from \"../Symbols\";\n\nconst makeSettingKey = (prefix: string, key: string) => `${prefix}/${key}`;\n\nclass SettingsSchemasImpl implements SettingsSchemas {\n  public readonly [_implementationProhibited] = undefined;\n  private readonly _allGroups = new Map<string, SettingGroupSchema>();\n  /** a map of all registered Setting Definitions  */\n  public readonly settingDefs = new Map<string, SettingSchema>();\n  /** a map of all registered TypeDefs  */\n  public readonly typeDefs = new Map<string, SettingSchema>();\n  /** event that signals that the values in [[allSchemas]] have changed in some way. */\n  public readonly onSchemaChanged = new BeEvent<() => void>();\n\n  private verifyType<T>(val: T, expectedType: JSONSchemaTypeName, path: string) {\n    if (expectedType === \"integer\") {\n      if (Number.isInteger(val))\n        return;\n    } else if (expectedType === \"null\") {\n      if (val === null || val === undefined)\n        return;\n    } else if (typeof val === expectedType)\n      return;\n\n    throw new Error(`value for ${path}: \"${val}\" is wrong type, expected ${expectedType}`);\n  }\n\n  public validateSetting<T>(value: T, settingName: string): T {\n    const settingDef = this.settingDefs.get(settingName);\n    if (undefined !== settingDef) // if there's no setting definition, there's no rules so just return ok\n      this.validateProperty(value, settingDef, settingName);\n    return value;\n  }\n\n  /** @internal */\n  public getObjectProperties(propDef: Readonly<SettingSchema>, scope: string): { required?: string[], properties: { [name: string]: SettingSchema } } {\n    let required = propDef.required;\n    let properties = propDef.properties;\n\n    // if this object extends a typeDef, add typeDef's properties and required values, recursively\n    if (propDef.extends !== undefined) {\n      const typeDef = this.typeDefs.get(propDef.extends);\n      if (undefined === typeDef)\n        throw new Error(`typeDef ${propDef.extends} does not exist for ${scope}`);\n      const expanded = this.getObjectProperties(typeDef, `${scope}.${propDef.extends}`);\n      if (expanded.required)\n        required = required ? [...required, ...expanded.required] : expanded.required;\n      if (expanded.properties) {\n        properties = properties ? { ...expanded.properties, ...properties } : expanded.properties;\n      }\n    }\n    properties = properties ?? {};\n    return { required, properties };\n  }\n\n  /** @internal */\n  public getArrayItems(propDef: Readonly<SettingSchema>, scope: string): SettingSchema {\n    let items = propDef.items;\n    if (undefined === items && propDef.extends) {\n      const typeDef = this.typeDefs.get(propDef.extends);\n      if (undefined === typeDef)\n        throw new Error(`typeDef ${propDef.extends} does not exist for ${scope}`);\n      items = typeDef.items;\n    }\n    if (undefined === items)\n      throw new Error(`array ${scope} has no items definition`);\n    return items;\n  }\n\n  private validateProperty<T>(val: T, propDef: Readonly<SettingSchema>, path: string) {\n    switch (propDef.type) {\n      case \"boolean\":\n      case \"number\":\n      case \"string\":\n      case \"integer\":\n      case \"null\":\n        return this.verifyType(val, propDef.type, path);\n\n      case \"array\":\n        if (!Array.isArray(val))\n          throw new Error(`Property ${path} must be an array`);\n        const items = this.getArrayItems(propDef, path);\n        for (let i = 0; i < val.length; ++i)\n          this.validateProperty(val[i], items, `${path}[${i}]`);\n        return;\n    }\n    if (!val || typeof val !== \"object\")\n      throw new Error(`${path} must be an object`);\n\n    const { required, properties } = this.getObjectProperties(propDef, path);\n\n    // first ensure all required properties are present\n    if (undefined !== required) {\n      for (const entry of required) {\n        const value = (val as any)[entry];\n        if (undefined === value)\n          throw new Error(`required value for \"${entry}\" is missing in \"${path}\"`);\n      }\n    }\n\n    // you can supply default values in typeDefs. See if any members are undefined that have a default.\n    if (undefined !== properties) {\n      for (const [key, prop] of Object.entries(properties)) {\n        if ((val as any)[key] === undefined && prop.default)\n          (val as any)[key] = prop.default;\n      }\n    }\n\n    // then validate all values in the supplied object are valid\n    for (const key of Object.keys(val)) {\n      const prop = properties[key];\n      if (prop !== undefined) { // note: extra values are ignored.\n        this.validateProperty((val as any)[key], prop, `${path}.${key}`);\n      }\n    }\n  }\n\n  /**\n   * Add one or more [[SettingSchemaGroup]]s. `SettingSchemaGroup`s must include a `schemaPrefix` member that is used\n   * to identify the group. If a group with the same name is already registered, the old values are first removed and then the new group is added.\n   */\n  public addGroup(settingsGroup: SettingGroupSchema | SettingGroupSchema[]): void {\n    if (!Array.isArray(settingsGroup))\n      settingsGroup = [settingsGroup];\n\n    this.doAdd(settingsGroup);\n    this.onSchemaChanged.raiseEvent();\n  }\n\n  /** Add a [[SettingSchemaGroup]] from stringified json5. */\n  public addJson(settingSchema: string): void {\n    this.addGroup(parse(settingSchema));\n  }\n\n  /** Add a [[SettingSchemaGroup]] from a json5 file. */\n  public addFile(fileName: LocalFileName): void {\n    try {\n      this.addJson(fs.readFileSync(fileName, \"utf-8\"));\n    } catch (e: any) {\n      throw new Error(`parsing SettingSchema file \"${fileName}\": ${e.message}\"`);\n    }\n  }\n\n  /** Add all files with a either \".json\" or \".json5\" extension from a supplied directory. */\n  public addDirectory(dirName: LocalDirName) {\n    for (const fileName of IModelJsFs.readdirSync(dirName)) {\n      const ext = extname(fileName);\n      if (ext === \".json5\" || ext === \".json\")\n        this.addFile(join(dirName, fileName));\n    }\n  }\n\n  /** Remove a previously added [[SettingSchemaGroup]] by schemaPrefix */\n  public removeGroup(schemaPrefix: string): void {\n    this.doRemove(schemaPrefix);\n    this.onSchemaChanged.raiseEvent();\n  }\n\n  private doAdd(settingsGroup: SettingGroupSchema[]) {\n    settingsGroup.forEach((group) => {\n      if (undefined === group.schemaPrefix)\n        throw new Error(`settings group has no \"schemaPrefix\" member`);\n\n      this.doRemove(group.schemaPrefix);\n      this.validateAndAdd(group);\n      this._allGroups.set(group.schemaPrefix, group);\n    });\n  }\n\n  private doRemove(schemaPrefix: string) {\n    const group = this._allGroups.get(schemaPrefix);\n    if (undefined !== group?.settingDefs) {\n      for (const key of Object.keys(group.settingDefs))\n        this.settingDefs.delete(makeSettingKey(schemaPrefix, key));\n    }\n    if (undefined !== group?.typeDefs) {\n      for (const key of Object.keys(group.typeDefs))\n        this.settingDefs.delete(makeSettingKey(schemaPrefix, key));\n    }\n    this._allGroups.delete(schemaPrefix);\n  }\n\n  private validateName(name: string) {\n    if (!name.trim())\n      throw new Error(`empty property name`);\n  }\n\n  private verifyPropertyDef(name: string, property: SettingSchema | undefined) {\n    if (!property)\n      throw new Error(`missing required property ${name}`);\n\n    if (!property.type)\n      throw new Error(`property ${name} has no type`);\n\n    switch (property.type) {\n      case \"boolean\":\n      case \"integer\":\n      case \"null\":\n      case \"number\":\n      case \"string\":\n        return;\n\n      case \"object\":\n        const required = property.required;\n        const props = property.properties;\n        if (required && props) {\n          for (const entry of required) {\n            if (undefined === props[entry])\n              throw new Error(`missing required property of ${name}: \"${entry}\"`);\n          }\n        }\n        if (props) {\n          for (const key of Object.keys(props))\n            try {\n              this.verifyPropertyDef(key, props[key]);\n            } catch (e: any) {\n              throw new Error(`property ${key} of ${name}: ${e.message}`);\n            }\n        }\n        return;\n\n      case \"array\":\n        if (typeof property.extends === \"string\")\n          return;\n        if (typeof property.items !== \"object\")\n          throw new Error(`array property ${name} has no items member`);\n        try {\n          this.verifyPropertyDef(\"items\", property.items);\n        } catch (e: any) {\n          throw new Error(`array property ${name}: ${e.message}`);\n        }\n        return;\n\n      default:\n        throw new Error(`property ${name} has illegal type \"${property.type}\"`);\n    }\n  }\n\n  private validateAndAdd(group: SettingGroupSchema) {\n    const settingDefs = group.settingDefs;\n    if (undefined !== settingDefs) {\n      for (const key of Object.keys(settingDefs)) {\n        this.validateName(key);\n        this.verifyPropertyDef(key, settingDefs[key]);\n        const property: Mutable<SettingSchema> | undefined = settingDefs[key];\n        assert(undefined !== property);\n        property.default = property.default ?? this.getDefaultValue(property.type);\n        this.settingDefs.set(makeSettingKey(group.schemaPrefix, key), property);\n      }\n    }\n    const typeDefs = group.typeDefs ?? {};\n    for (const key of Object.keys(typeDefs)) {\n      this.validateName(key);\n      this.verifyPropertyDef(key, typeDefs[key]);\n      const typeDef = typeDefs[key];\n      assert(undefined !== typeDef);\n      this.typeDefs.set(makeSettingKey(group.schemaPrefix, key), typeDef);\n    }\n  }\n\n  private getDefaultValue(type: JSONSchemaTypeName | JSONSchemaTypeName[]): JSONSchemaType | undefined {\n    type = Array.isArray(type) ? type[0] : type;\n    switch (type) {\n      case \"boolean\":\n        return false;\n      case \"integer\":\n      case \"number\":\n        return 0;\n      case \"string\":\n        return \"\";\n      case \"array\":\n        return [];\n      case \"object\":\n        return {};\n      default:\n        return undefined;\n    }\n  }\n}\n\nexport function constructSettingsSchemas(): SettingsSchemas {\n  return new SettingsSchemasImpl();\n}\n"]}

package/lib/cjs/internal/workspace/WorkspaceImpl.d.ts

@@ -0,0 +1,41 @@
+/** @packageDocumentation
+ * @module Workspace
+ */
+import { FilePropertyProps } from "@itwin/core-common";
+import { Settings } from "../../workspace/Settings";
+import { Workspace, WorkspaceContainer, WorkspaceContainerId, WorkspaceDb, WorkspaceDbFullName, WorkspaceDbLoadError, WorkspaceDbName, WorkspaceDbProps, WorkspaceDbVersion, WorkspaceOpts } from "../../workspace/Workspace";
+import { WorkspaceEditor } from "../../workspace/WorkspaceEditor";
+/** file extension for local WorkspaceDbs */
+export declare const workspaceDbFileExt = "itwin-workspace";
+export declare function constructWorkspaceDb(props: WorkspaceDbProps, container: WorkspaceContainer): WorkspaceDb;
+export declare function constructWorkspace(settings: Settings, opts?: WorkspaceOpts): OwnedWorkspace;
+export declare function constructWorkspaceEditor(): WorkspaceEditor;
+export declare function noLeadingOrTrailingSpaces(name: string, msg: string): void;
+export declare function validateWorkspaceDbName(dbName: WorkspaceDbName): void;
+/**
+ * Validate that a WorkspaceContainer.Id is valid.
+ * The rules for ContainerIds (from Azure, see https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata):
+ *  - may only contain lower case letters, numbers or dashes
+ *  - may not start or end with with a dash nor have more than one dash in a row
+ *  - may not be shorter than 3 or longer than 63 characters
+ */
+export declare function validateWorkspaceContainerId(id: WorkspaceContainerId): void;
+export declare function validateWorkspaceDbVersion(version?: WorkspaceDbVersion): string;
+/**
+ * Parse the name stored in a WorkspaceContainer into the dbName and version number. A single WorkspaceContainer may hold
+ * many versions of the same WorkspaceDb. The name of the Db in the WorkspaceContainer is in the format "name:version". This
+ * function splits them into separate strings.
+ */
+export declare function parseWorkspaceDbFileName(dbFileName: WorkspaceDbFullName): {
+    dbName: WorkspaceDbName;
+    version: WorkspaceDbVersion;
+};
+/** Create a dbName for a WorkspaceDb from its base name and version. This will be in the format "name:version" */
+export declare function makeWorkspaceDbFileName(dbName: WorkspaceDbName, version?: WorkspaceDbVersion): WorkspaceDbName;
+export declare const workspaceManifestProperty: FilePropertyProps;
+export declare function throwWorkspaceDbLoadErrors(msg: string, errors: WorkspaceDbLoadError[]): never;
+export interface OwnedWorkspace extends Workspace {
+    /** Only the owner of a Workspace may close it. */
+    close(): void;
+}
+//# sourceMappingURL=WorkspaceImpl.d.ts.map

package/lib/cjs/internal/workspace/WorkspaceImpl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WorkspaceImpl.d.ts","sourceRoot":"","sources":["../../../../src/internal/workspace/WorkspaceImpl.ts"],"names":[],"mappings":"AAIA;;GAEG;AAOH,OAAO,EAAE,iBAAiB,EAA4C,MAAM,oBAAoB,CAAC;AAMjG,OAAO,EAAe,QAAQ,EAAgE,MAAM,0BAA0B,CAAC;AAE/H,OAAO,EACsB,SAAS,EAAE,kBAAkB,EAAE,oBAAoB,EAA2B,WAAW,EACpH,mBAAmB,EAAE,oBAAoB,EAA8C,eAAe,EAA6B,gBAAgB,EAC1F,kBAAkB,EAAE,aAAa,EAC3F,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAqH,eAAe,EAAE,MAAM,iCAAiC,CAAC;AASrL,4CAA4C;AAC5C,eAAO,MAAM,kBAAkB,oBAAoB,CAAC;AAorBpD,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,gBAAgB,EAAE,SAAS,EAAE,kBAAkB,GAAG,WAAW,CAExG;AAED,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,EAAE,aAAa,GAAG,cAAc,CAE3F;AAED,wBAAgB,wBAAwB,IAAI,eAAe,CAE1D;AAED,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,QAGlE;AAED,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,eAAe,QAK9D;AAED;;;;;;GAMG;AACH,wBAAgB,4BAA4B,CAAC,EAAE,EAAE,oBAAoB,QAGpE;AAED,wBAAgB,0BAA0B,CAAC,OAAO,CAAC,EAAE,kBAAkB,UAWtE;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAC,UAAU,EAAE,mBAAmB,GAAG;IAAE,MAAM,EAAE,eAAe,CAAC;IAAC,OAAO,EAAE,kBAAkB,CAAA;CAAE,CAGlI;AAED,kHAAkH;AAClH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,eAAe,CAE9G;AAED,eAAO,MAAM,yBAAyB,EAAE,iBAAgE,CAAC;AASzG,wBAAgB,0BAA0B,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,oBAAoB,EAAE,GAAG,KAAK,CAI7F;AAED,MAAM,WAAW,cAAe,SAAQ,SAAS;IAC/C,kDAAkD;IAClD,KAAK,IAAI,IAAI,CAAC;CACf"}