@adobe/ccweb-add-on-manifest 0.1.0

package/dist/AddOnManifestValidator.js

@@ -0,0 +1,190 @@
+/********************************************************************************
+ * MIT License
+
+ * © Copyright 2023 Adobe. All rights reserved.
+
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ ********************************************************************************/
+import { ManifestVersion } from "./AddOnManifest.js";
+import { AddOnLogLevel, OTHER_MANIFEST_ERRORS } from "./AddOnManifestTypes.js";
+import { developerVersionValidation, getManifestVersion, getValidationErrors } from "./ValidationUtils.js";
+import { validateSchemaV1, validateSchemaV2 } from "./generated/validateManifestSchema.mjs";
+// Add schema validators to the following list ordered by version numbers
+const validatorVersions = [validateSchemaV1, validateSchemaV2];
+export class AddOnManifestValidator {
+    _addOnLogger;
+    _logError;
+    _logWarn;
+    _manifestVersion;
+    constructor(_addOnLogger) {
+        this._addOnLogger = _addOnLogger;
+        this._logError =
+            this._addOnLogger?.get(AddOnLogLevel.error) ??
+                (() => {
+                    return;
+                });
+        this._logWarn =
+            this._addOnLogger?.get(AddOnLogLevel.warning) ??
+                (() => {
+                    return;
+                });
+    }
+    _commonAdditionalValidations(manifest, additionalInfo) {
+        let isValidSchema = true;
+        const validationErrors = [];
+        if (!manifest.entryPoints?.length) {
+            this._logError("At least one entrypoint should be defined");
+            isValidSchema = false;
+            validationErrors.push(OTHER_MANIFEST_ERRORS.EmptyEntrypoint);
+        }
+        if (!additionalInfo.privileged) {
+            if (manifest.requirements?.privilegedApis) {
+                this._logError("Privileged apis are not allowed for this add-on");
+                isValidSchema = false;
+                validationErrors.push(OTHER_MANIFEST_ERRORS.RestrictedPrivilegedApis);
+            }
+            manifest.entryPoints?.forEach((entrypoint) => {
+                const canReadClipboard = entrypoint.permissions?.clipboard?.find(c => c === "clipboard-read") !== undefined;
+                if (canReadClipboard) {
+                    this._logError("Clipboard-read permission is not allowed for the Add-on entrypoint: ", entrypoint.id);
+                    validationErrors.push(OTHER_MANIFEST_ERRORS.InvalidClipboardPermission);
+                    isValidSchema = false;
+                }
+            });
+        }
+        return {
+            success: isValidSchema,
+            errorDetails: validationErrors
+        };
+    }
+    _verifyAdditionalDeveloperValidations(manifest, additionalInfo) {
+        const manifestVersion = manifest.manifestVersion || ManifestVersion.V1;
+        let isValidSchema = true;
+        const validationErrors = [];
+        const validationWarnings = [];
+        const commonValidations = this._commonAdditionalValidations(manifest, additionalInfo);
+        if (!commonValidations.success) {
+            isValidSchema = false;
+            validationErrors.push(...commonValidations.errorDetails);
+        }
+        switch (manifestVersion) {
+            case ManifestVersion.V1: {
+                if (Array.isArray(manifest?.icon) && !manifest.icon?.length) {
+                    this._logWarn("At least one icon should be defined");
+                    validationWarnings.push(OTHER_MANIFEST_ERRORS.EmptyIcon);
+                }
+                break;
+            }
+            default: {
+                if (!manifest.testId) {
+                    this._logError("testId should be defined in manifest for developer workflow");
+                    isValidSchema = false;
+                    validationErrors.push(OTHER_MANIFEST_ERRORS.TestIdRequired);
+                }
+            }
+        }
+        return {
+            success: isValidSchema,
+            errorDetails: validationErrors,
+            warningDetails: validationWarnings
+        };
+    }
+    validateDeveloperSchema(manifest, additionalInfo) {
+        const validationErrors = [];
+        const validationWarnings = [];
+        const schemaValidation = developerVersionValidation(manifest, this._addOnLogger);
+        if (!schemaValidation.success) {
+            this._logError(`Errors in Manifest.json to fix before submission: ${schemaValidation.errorDetails}`);
+            validationErrors.push(...schemaValidation.errorDetails);
+        }
+        const additionValidations = this._verifyAdditionalDeveloperValidations(manifest, additionalInfo);
+        validationWarnings.push(...additionValidations.warningDetails);
+        validationErrors.push(...additionValidations.errorDetails);
+        const success = schemaValidation.success && additionValidations.success;
+        return {
+            success,
+            warningDetails: validationWarnings.length ? validationWarnings : undefined,
+            errorDetails: success ? undefined : validationErrors
+        };
+    }
+    _verifyAdditionalValidations(manifest, additionalInfo) {
+        let isValidSchema = true;
+        const validationErrors = [];
+        if (manifest.requirements.experimentalApis && !additionalInfo.isDeveloperAddOn) {
+            this._logError("Experimental apis are not supported for production add-ons");
+            validationErrors.push(OTHER_MANIFEST_ERRORS.AdditionPropertyExperimentalApis);
+            isValidSchema = false;
+        }
+        const commonValidations = this._commonAdditionalValidations(manifest, additionalInfo);
+        if (!commonValidations.success) {
+            isValidSchema = false;
+            validationErrors.push(...commonValidations.errorDetails);
+        }
+        switch (this._manifestVersion) {
+            case ManifestVersion.V1: {
+                if (Array.isArray(manifest?.icon) && !manifest.icon?.length) {
+                    this._logError("At least one icon should be defined");
+                    validationErrors.push(OTHER_MANIFEST_ERRORS.EmptyIcon);
+                    isValidSchema = false;
+                }
+                break;
+            }
+        }
+        return {
+            success: isValidSchema,
+            errorDetails: validationErrors
+        };
+    }
+    _validateSchema(manifest, additionalInfo) {
+        const schemaValidator = validatorVersions[this._manifestVersion - 1];
+        let isValidSchema = true;
+        let validationErrors = [];
+        if (!schemaValidator(manifest)) {
+            const manifestErrors = schemaValidator.errors;
+            this._logError(`Errors in Manifest.json to fix before submission: ${manifestErrors}`);
+            validationErrors = getValidationErrors(manifestErrors);
+            isValidSchema = false;
+        }
+        const additionalValidations = this._verifyAdditionalValidations(manifest, additionalInfo);
+        if (!additionalValidations.success) {
+            validationErrors.push(...additionalValidations.errorDetails);
+        }
+        const success = isValidSchema && additionalValidations.success;
+        return { success, errorDetails: success ? undefined : validationErrors };
+    }
+    validateManifestSchema(manifest, additionalInfo) {
+        if (!manifest) {
+            return { success: false };
+        }
+        this._manifestVersion = getManifestVersion(manifest, additionalInfo.isDeveloperAddOn);
+        if (isNaN(this._manifestVersion)) {
+            this._logError("Manifest version should be a number");
+            return { success: false, errorDetails: [OTHER_MANIFEST_ERRORS.ManifestVersionType] };
+        }
+        if (this._manifestVersion <= 0) {
+            this._logError(`Incorrect manifest version : ${this._manifestVersion}`);
+            return { success: false, errorDetails: [OTHER_MANIFEST_ERRORS.InvalidManifestVersion] };
+        }
+        if (additionalInfo.isDeveloperAddOn) {
+            return this.validateDeveloperSchema(manifest, additionalInfo);
+        }
+        return this._validateSchema(manifest, additionalInfo);
+    }
+}
+//# sourceMappingURL=AddOnManifestValidator.js.map

package/dist/AddOnManifestValidator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AddOnManifestValidator.js","sourceRoot":"","sources":["../src/AddOnManifestValidator.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;kFAsBkF;AAGlF,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAEH,aAAa,EAIb,qBAAqB,EAExB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EAAE,0BAA0B,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAC3G,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,wCAAwC,CAAC;AAE5F,yEAAyE;AACzE,MAAM,iBAAiB,GAAG,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,CAAC;AAE/D,MAAM,OAAO,sBAAsB;IAKF;IAJZ,SAAS,CAAiB;IAC1B,QAAQ,CAAiB;IAClC,gBAAgB,CAAU;IAElC,YAA6B,YAAiD;QAAjD,iBAAY,GAAZ,YAAY,CAAqC;QAC1E,IAAI,CAAC,SAAS;YACV,IAAI,CAAC,YAAY,EAAE,GAAG,CAAC,aAAa,CAAC,KAAK,CAAC;gBAC3C,CAAC,GAAG,EAAE;oBACF,OAAO;gBACX,CAAC,CAAC,CAAC;QACP,IAAI,CAAC,QAAQ;YACT,IAAI,CAAC,YAAY,EAAE,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC;gBAC7C,CAAC,GAAG,EAAE;oBACF,OAAO;gBACX,CAAC,CAAC,CAAC;IACX,CAAC;IAEO,4BAA4B,CAChC,QAAuC,EACvC,cAAmC;QAEnC,IAAI,aAAa,GAAG,IAAI,CAAC;QACzB,MAAM,gBAAgB,GAAoB,EAAE,CAAC;QAC7C,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,EAAE;YAC/B,IAAI,CAAC,SAAS,CAAC,2CAA2C,CAAC,CAAC;YAC5D,aAAa,GAAG,KAAK,CAAC;YACtB,gBAAgB,CAAC,IAAI,CAAC,qBAAqB,CAAC,eAAe,CAAC,CAAC;SAChE;QAED,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE;YAC5B,IAAI,QAAQ,CAAC,YAAY,EAAE,cAAc,EAAE;gBACvC,IAAI,CAAC,SAAS,CAAC,iDAAiD,CAAC,CAAC;gBAClE,aAAa,GAAG,KAAK,CAAC;gBACtB,gBAAgB,CAAC,IAAI,CAAC,qBAAqB,CAAC,wBAAwB,CAAC,CAAC;aACzE;YACD,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC,UAA8B,EAAE,EAAE;gBAC7D,MAAM,gBAAgB,GAClB,UAAU,CAAC,WAAW,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,gBAAgB,CAAC,KAAK,SAAS,CAAC;gBACvF,IAAI,gBAAgB,EAAE;oBAClB,IAAI,CAAC,SAAS,CACV,sEAAsE,EACtE,UAAU,CAAC,EAAE,CAChB,CAAC;oBACF,gBAAgB,CAAC,IAAI,CAAC,qBAAqB,CAAC,0BAA0B,CAAC,CAAC;oBACxE,aAAa,GAAG,KAAK,CAAC;iBACzB;YACL,CAAC,CAAC,CAAC;SACN;QACD,OAAO;YACH,OAAO,EAAE,aAAa;YACtB,YAAY,EAAE,gBAAgB;SACjC,CAAC;IACN,CAAC;IAEO,qCAAqC,CACzC,QAAuC,EACvC,cAAmC;QAEnC,MAAM,eAAe,GAAG,QAAQ,CAAC,eAAe,IAAI,eAAe,CAAC,EAAE,CAAC;QACvE,IAAI,aAAa,GAAG,IAAI,CAAC;QACzB,MAAM,gBAAgB,GAAoB,EAAE,CAAC;QAC7C,MAAM,kBAAkB,GAAoB,EAAE,CAAC;QAC/C,MAAM,iBAAiB,GAAG,IAAI,CAAC,4BAA4B,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;QACtF,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE;YAC5B,aAAa,GAAG,KAAK,CAAC;YACtB,gBAAgB,CAAC,IAAI,CAAC,GAAG,iBAAiB,CAAC,YAAa,CAAC,CAAC;SAC7D;QAED,QAAQ,eAAe,EAAE;YACrB,KAAK,eAAe,CAAC,EAAE,CAAC,CAAC;gBACrB,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE;oBACzD,IAAI,CAAC,QAAQ,CAAC,qCAAqC,CAAC,CAAC;oBACrD,kBAAkB,CAAC,IAAI,CAAC,qBAAqB,CAAC,SAAS,CAAC,CAAC;iBAC5D;gBACD,MAAM;aACT;YACD,OAAO,CAAC,CAAC;gBACL,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE;oBAClB,IAAI,CAAC,SAAS,CAAC,6DAA6D,CAAC,CAAC;oBAC9E,aAAa,GAAG,KAAK,CAAC;oBACtB,gBAAgB,CAAC,IAAI,CAAC,qBAAqB,CAAC,cAAc,CAAC,CAAC;iBAC/D;aACJ;SACJ;QACD,OAAO;YACH,OAAO,EAAE,aAAa;YACtB,YAAY,EAAE,gBAAgB;YAC9B,cAAc,EAAE,kBAAkB;SACrC,CAAC;IACN,CAAC;IAED,uBAAuB,CACnB,QAAuC,EACvC,cAAmC;QAEnC,MAAM,gBAAgB,GAAoB,EAAE,CAAC;QAC7C,MAAM,kBAAkB,GAAoB,EAAE,CAAC;QAC/C,MAAM,gBAAgB,GAAG,0BAA0B,CAAC,QAAQ,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QACjF,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE;YAC3B,IAAI,CAAC,SAAS,CAAC,qDAAqD,gBAAgB,CAAC,YAAY,EAAE,CAAC,CAAC;YACrG,gBAAgB,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC,YAAa,CAAC,CAAC;SAC5D;QACD,MAAM,mBAAmB,GAAG,IAAI,CAAC,qCAAqC,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;QACjG,kBAAkB,CAAC,IAAI,CAAC,GAAG,mBAAmB,CAAC,cAAc,CAAC,CAAC;QAC/D,gBAAgB,CAAC,IAAI,CAAC,GAAG,mBAAmB,CAAC,YAAY,CAAC,CAAC;QAC3D,MAAM,OAAO,GAAG,gBAAgB,CAAC,OAAO,IAAI,mBAAmB,CAAC,OAAO,CAAC;QACxE,OAAO;YACH,OAAO;YACP,cAAc,EAAE,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,SAAS;YAC1E,YAAY,EAAE,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,gBAAgB;SACvD,CAAC;IACN,CAAC;IAEO,4BAA4B,CAChC,QAAuC,EACvC,cAAmC;QAEnC,IAAI,aAAa,GAAG,IAAI,CAAC;QACzB,MAAM,gBAAgB,GAAoB,EAAE,CAAC;QAC7C,IAAI,QAAQ,CAAC,YAAY,CAAC,gBAAgB,IAAI,CAAC,cAAc,CAAC,gBAAgB,EAAE;YAC5E,IAAI,CAAC,SAAS,CAAC,4DAA4D,CAAC,CAAC;YAC7E,gBAAgB,CAAC,IAAI,CAAC,qBAAqB,CAAC,gCAAgC,CAAC,CAAC;YAC9E,aAAa,GAAG,KAAK,CAAC;SACzB;QACD,MAAM,iBAAiB,GAAG,IAAI,CAAC,4BAA4B,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;QACtF,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE;YAC5B,aAAa,GAAG,KAAK,CAAC;YACtB,gBAAgB,CAAC,IAAI,CAAC,GAAG,iBAAiB,CAAC,YAAa,CAAC,CAAC;SAC7D;QAED,QAAQ,IAAI,CAAC,gBAAgB,EAAE;YAC3B,KAAK,eAAe,CAAC,EAAE,CAAC,CAAC;gBACrB,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE;oBACzD,IAAI,CAAC,SAAS,CAAC,qCAAqC,CAAC,CAAC;oBACtD,gBAAgB,CAAC,IAAI,CAAC,qBAAqB,CAAC,SAAS,CAAC,CAAC;oBACvD,aAAa,GAAG,KAAK,CAAC;iBACzB;gBACD,MAAM;aACT;SACJ;QACD,OAAO;YACH,OAAO,EAAE,aAAa;YACtB,YAAY,EAAE,gBAAgB;SACjC,CAAC;IACN,CAAC;IAEO,eAAe,CACnB,QAAuC,EACvC,cAAmC;QAEnC,MAAM,eAAe,GAAG,iBAAiB,CAAC,IAAI,CAAC,gBAAgB,GAAG,CAAC,CAAC,CAAC;QACrE,IAAI,aAAa,GAAG,IAAI,CAAC;QACzB,IAAI,gBAAgB,GAAoB,EAAE,CAAC;QAC3C,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE;YAC5B,MAAM,cAAc,GAAI,eAAoC,CAAC,MAAM,CAAC;YACpE,IAAI,CAAC,SAAS,CAAC,qDAAqD,cAAc,EAAE,CAAC,CAAC;YACtF,gBAAgB,GAAG,mBAAmB,CAAC,cAAc,CAAC,CAAC;YACvD,aAAa,GAAG,KAAK,CAAC;SACzB;QACD,MAAM,qBAAqB,GAAG,IAAI,CAAC,4BAA4B,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;QAC1F,IAAI,CAAC,qBAAqB,CAAC,OAAO,EAAE;YAChC,gBAAgB,CAAC,IAAI,CAAC,GAAG,qBAAqB,CAAC,YAAa,CAAC,CAAC;SACjE;QACD,MAAM,OAAO,GAAG,aAAa,IAAI,qBAAqB,CAAC,OAAO,CAAC;QAC/D,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,gBAAgB,EAAE,CAAC;IAC7E,CAAC;IAED,sBAAsB,CAClB,QAAuC,EACvC,cAAmC;QAEnC,IAAI,CAAC,QAAQ,EAAE;YACX,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;SAC7B;QACD,IAAI,CAAC,gBAAgB,GAAG,kBAAkB,CAAC,QAAQ,EAAE,cAAc,CAAC,gBAAgB,CAAC,CAAC;QACtF,IAAI,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE;YAC9B,IAAI,CAAC,SAAS,CAAC,qCAAqC,CAAC,CAAC;YACtD,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,qBAAqB,CAAC,mBAAmB,CAAC,EAAE,CAAC;SACxF;QACD,IAAI,IAAI,CAAC,gBAAgB,IAAI,CAAC,EAAE;YAC5B,IAAI,CAAC,SAAS,CAAC,gCAAgC,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAC;YACxE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC,qBAAqB,CAAC,sBAAsB,CAAC,EAAE,CAAC;SAC3F;QACD,IAAI,cAAc,CAAC,gBAAgB,EAAE;YACjC,OAAO,IAAI,CAAC,uBAAuB,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;SACjE;QACD,OAAO,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;IAC1D,CAAC;CACJ"}

package/dist/ValidationUtils.d.ts

@@ -0,0 +1,29 @@
+/********************************************************************************
+ * MIT License
+
+ * © Copyright 2023 Adobe. All rights reserved.
+
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ ********************************************************************************/
+import type { ErrorObject } from "ajv";
+import { AddOnLogAction, AddOnLogLevel, ManifestError, ManifestValidationResult } from "./AddOnManifestTypes.js";
+export declare function developerVersionValidation(manifest: ReturnType<typeof JSON.parse>, addOnLogger: Map<AddOnLogLevel, AddOnLogAction> | undefined): ManifestValidationResult;
+export declare function getValidationErrors(validationErrors: ErrorObject[] | undefined | null): ManifestError[];
+export declare function getManifestVersion(manifest: ReturnType<typeof JSON.parse>, isDeveloperAddOn: boolean): number;
+//# sourceMappingURL=ValidationUtils.d.ts.map

package/dist/ValidationUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ValidationUtils.d.ts","sourceRoot":"","sources":["../src/ValidationUtils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;kFAsBkF;AAElF,OAAO,KAAK,EAAE,WAAW,EAAoB,MAAM,KAAK,CAAC;AAEzD,OAAO,EAAE,cAAc,EAAE,aAAa,EAAE,aAAa,EAAE,wBAAwB,EAAE,MAAM,yBAAyB,CAAC;AAmBjH,wBAAgB,0BAA0B,CACtC,QAAQ,EAAE,UAAU,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,EACvC,WAAW,EAAE,GAAG,CAAC,aAAa,EAAE,cAAc,CAAC,GAAG,SAAS,GAC5D,wBAAwB,CAO1B;AAED,wBAAgB,mBAAmB,CAAC,gBAAgB,EAAE,WAAW,EAAE,GAAG,SAAS,GAAG,IAAI,GAAG,aAAa,EAAE,CAMvG;AAED,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,UAAU,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,gBAAgB,EAAE,OAAO,GAAG,MAAM,CAK7G"}

package/dist/ValidationUtils.js

@@ -0,0 +1,59 @@
+/********************************************************************************
+ * MIT License
+
+ * © Copyright 2023 Adobe. All rights reserved.
+
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ ********************************************************************************/
+import { ManifestVersion } from "./AddOnManifest.js";
+import { AddOnLogLevel } from "./AddOnManifestTypes.js";
+import { validateSchemaDeveloperV1, validateSchemaV2 } from "./generated/validateManifestSchema.mjs";
+// Add schema validators to the following list ordered by version numbers
+const developerValidatorVersions = [validateSchemaDeveloperV1, validateSchemaV2];
+function getErrors(validateSchema, addOnLogger) {
+    const manifestErrors = validateSchema.errors;
+    const logError = addOnLogger?.get(AddOnLogLevel.error);
+    if (logError !== undefined) {
+        logError(manifestErrors);
+    }
+    const validationErrors = getValidationErrors(manifestErrors);
+    return { success: false, errorDetails: validationErrors };
+}
+export function developerVersionValidation(manifest, addOnLogger) {
+    const manifestVersion = manifest.manifestVersion || ManifestVersion.V1;
+    const schemaValidator = developerValidatorVersions[manifestVersion - 1];
+    if (!schemaValidator(manifest)) {
+        return getErrors(schemaValidator, addOnLogger);
+    }
+    return { success: true };
+}
+export function getValidationErrors(validationErrors) {
+    const errors = [];
+    validationErrors?.forEach(i => {
+        errors.push({ instancePath: i.instancePath, keyword: i.keyword, params: i.params, message: i.message });
+    });
+    return errors;
+}
+export function getManifestVersion(manifest, isDeveloperAddOn) {
+    if (isDeveloperAddOn) {
+        return manifest.manifestVersion ?? ManifestVersion.V1;
+    }
+    return manifest.manifestVersion;
+}
+//# sourceMappingURL=ValidationUtils.js.map

package/dist/ValidationUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ValidationUtils.js","sourceRoot":"","sources":["../src/ValidationUtils.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;kFAsBkF;AAGlF,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAkB,aAAa,EAA2C,MAAM,yBAAyB,CAAC;AACjH,OAAO,EAAE,yBAAyB,EAAE,gBAAgB,EAAE,MAAM,wCAAwC,CAAC;AAErG,yEAAyE;AACzE,MAAM,0BAA0B,GAAG,CAAC,yBAAyB,EAAE,gBAAgB,CAAC,CAAC;AAEjF,SAAS,SAAS,CACd,cAAuB,EACvB,WAA2D;IAE3D,MAAM,cAAc,GAAI,cAAmC,CAAC,MAAM,CAAC;IACnE,MAAM,QAAQ,GAAG,WAAW,EAAE,GAAG,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IACvD,IAAI,QAAQ,KAAK,SAAS,EAAE;QACxB,QAAQ,CAAC,cAAc,CAAC,CAAC;KAC5B;IACD,MAAM,gBAAgB,GAAG,mBAAmB,CAAC,cAAc,CAAC,CAAC;IAC7D,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,gBAAgB,EAAE,CAAC;AAC9D,CAAC;AAED,MAAM,UAAU,0BAA0B,CACtC,QAAuC,EACvC,WAA2D;IAE3D,MAAM,eAAe,GAAG,QAAQ,CAAC,eAAe,IAAI,eAAe,CAAC,EAAE,CAAC;IACvE,MAAM,eAAe,GAAG,0BAA0B,CAAC,eAAe,GAAG,CAAC,CAAC,CAAC;IACxE,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE;QAC5B,OAAO,SAAS,CAAC,eAAe,EAAE,WAAW,CAAC,CAAC;KAClD;IACD,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;AAC7B,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,gBAAkD;IAClF,MAAM,MAAM,GAAoB,EAAE,CAAC;IACnC,gBAAgB,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE;QAC1B,MAAM,CAAC,IAAI,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC,YAAY,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;IAC5G,CAAC,CAAC,CAAC;IACH,OAAO,MAAM,CAAC;AAClB,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,QAAuC,EAAE,gBAAyB;IACjG,IAAI,gBAAgB,EAAE;QAClB,OAAO,QAAQ,CAAC,eAAe,IAAI,eAAe,CAAC,EAAE,CAAC;KACzD;IACD,OAAO,QAAQ,CAAC,eAAe,CAAC;AACpC,CAAC"}

package/dist/generated/validateManifestSchema.d.mts

@@ -0,0 +1,19 @@
+export function validateSchemaV1(data: any, { instancePath, parentData, parentDataProperty, rootData }?: {
+    instancePath?: string | undefined;
+    parentData: any;
+    parentDataProperty: any;
+    rootData?: any;
+}): boolean;
+export function validateSchemaDeveloperV1(data: any, { instancePath, parentData, parentDataProperty, rootData }?: {
+    instancePath?: string | undefined;
+    parentData: any;
+    parentDataProperty: any;
+    rootData?: any;
+}): boolean;
+export function validateSchemaV2(data: any, { instancePath, parentData, parentDataProperty, rootData }?: {
+    instancePath?: string | undefined;
+    parentData: any;
+    parentDataProperty: any;
+    rootData?: any;
+}): boolean;
+//# sourceMappingURL=validateManifestSchema.d.mts.map

package/dist/generated/validateManifestSchema.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validateManifestSchema.d.mts","sourceRoot":"","sources":["../../src/generated/validateManifestSchema.mjs"],"names":[],"mappings":"AAA4sF;;;;;YAAkugC;AAAm5E;;;;;YAAiy/B;AAAi+D;;;;;YAA47nB"}