@microsoft/app-manifest 1.0.4-alpha.077878d77.0 → 1.0.4-alpha.08ea48cc3.0

package/build/wrappers/APIPluginManifestWrapper.js

@@ -0,0 +1,309 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.APIPluginManifestWrapper = exports.RuntimeType = void 0;
+const generated_types_1 = require("../generated-types");
+const BaseManifest_1 = require("./BaseManifest");
+/**
+ * Runtime type enum for plugin runtimes.
+ * These values match the auto-generated RuntimeType from the schema.
+ * @see RuntimeTypeValue for the type definition
+ */
+exports.RuntimeType = {
+    OpenApi: "OpenApi",
+    LocalPlugin: "LocalPlugin",
+    RemoteMCPServer: "RemoteMCPServer",
+};
+/**
+ * OOP wrapper for API Plugin Manifest.
+ *
+ * Provides a fluent API for manipulating API plugin manifests with
+ * type safety, state tracking, and convenient operations.
+ *
+ * @example
+ * ```typescript
+ * // Read existing manifest
+ * const plugin = await APIPluginManifestWrapper.read("plugin.json");
+ *
+ * // Modify with fluent API
+ * plugin
+ *   .addFunction("getUser", "Get user information")
+ *   .addOpenApiRuntime("openapi.yaml", "Bearer");
+ *
+ * // Save changes
+ * await plugin.save();
+ * ```
+ */
+class APIPluginManifestWrapper extends BaseManifest_1.BaseManifest {
+    constructor(data, filePath) {
+        super(data, filePath);
+    }
+    // ============= Static Factory Methods =============
+    /**
+     * Reads a plugin manifest from a file.
+     * @param filePath - Path to the manifest JSON file.
+     * @returns A new APIPluginManifestWrapper instance.
+     */
+    static async read(filePath) {
+        const data = await generated_types_1.AppManifestUtils.readApiPluginManifest(filePath);
+        return new APIPluginManifestWrapper(data, filePath);
+    }
+    /**
+     * Reads a plugin manifest from a file synchronously.
+     * @param filePath - Path to the manifest JSON file.
+     * @returns A new APIPluginManifestWrapper instance.
+     */
+    static readSync(filePath) {
+        const json = BaseManifest_1.BaseManifest.readJsonFileSync(filePath);
+        const data = generated_types_1.ApiPluginManifestConverter.jsonToManifest(JSON.stringify(json));
+        return new APIPluginManifestWrapper(data, filePath);
+    }
+    /**
+     * Creates an APIPluginManifestWrapper from a JSON string.
+     * @param json - JSON string representing the manifest.
+     * @returns A new APIPluginManifestWrapper instance.
+     */
+    static fromJSON(json) {
+        const data = generated_types_1.ApiPluginManifestConverter.jsonToManifest(json);
+        return new APIPluginManifestWrapper(data);
+    }
+    /**
+     * Creates a new plugin manifest with required fields.
+     * @param init - Initial manifest data with required fields.
+     * @returns A new APIPluginManifestWrapper instance.
+     */
+    static create(init) {
+        var _a;
+        const data = {
+            schema_version: init.schemaVersion,
+            name_for_human: init.nameForHuman,
+            description_for_human: init.descriptionForHuman,
+            namespace: (_a = init.namespace) !== null && _a !== void 0 ? _a : init.nameForHuman.replace(/\s+/g, "_"),
+        };
+        return new APIPluginManifestWrapper(data);
+    }
+    // ============= Getters =============
+    /**
+     * Returns the schema version of the manifest.
+     */
+    get schemaVersion() {
+        return this._data.schema_version;
+    }
+    /**
+     * Returns the human-readable name.
+     */
+    get nameForHuman() {
+        return this._data.name_for_human;
+    }
+    /**
+     * Returns the human-readable description.
+     */
+    get descriptionForHuman() {
+        return this._data.description_for_human;
+    }
+    /**
+     * Returns the namespace (if available in the version).
+     */
+    get namespace() {
+        return this._data.namespace;
+    }
+    /**
+     * Returns a readonly array of functions.
+     */
+    get functions() {
+        var _a;
+        return (_a = this._data.functions) !== null && _a !== void 0 ? _a : [];
+    }
+    /**
+     * Returns a readonly array of runtimes.
+     */
+    get runtimes() {
+        var _a;
+        return (_a = this._data.runtimes) !== null && _a !== void 0 ? _a : [];
+    }
+    // ============= Setters (Fluent API) =============
+    /**
+     * Sets the human-readable name.
+     */
+    setNameForHuman(name) {
+        this._data.name_for_human = name;
+        this.markDirty();
+        return this;
+    }
+    /**
+     * Sets the human-readable description.
+     */
+    setDescriptionForHuman(description) {
+        this._data.description_for_human = description;
+        this.markDirty();
+        return this;
+    }
+    /**
+     * Sets the model description.
+     */
+    setDescriptionForModel(description) {
+        this._data.description_for_model = description;
+        this.markDirty();
+        return this;
+    }
+    /**
+     * Sets the namespace (for latest version).
+     */
+    setNamespace(namespace) {
+        this._data.namespace = namespace;
+        this.markDirty();
+        return this;
+    }
+    // ============= Function Operations =============
+    /**
+     * Adds a function to the manifest.
+     * @param name - The function name (must match operationId in OpenAPI).
+     * @param description - Description for the model.
+     */
+    addFunction(name, description) {
+        if (!this._data.functions) {
+            this._data.functions = [];
+        }
+        const existing = this._data.functions.find((f) => f.name === name);
+        if (!existing) {
+            this._data.functions.push({
+                name,
+                description,
+            });
+            this.markDirty();
+        }
+        return this;
+    }
+    /**
+     * Removes a function by name.
+     * @param name - The name of the function to remove.
+     */
+    removeFunction(name) {
+        if (this._data.functions) {
+            this._data.functions = this._data.functions.filter((f) => f.name !== name);
+            this.markDirty();
+        }
+        return this;
+    }
+    /**
+     * Checks if a function exists by name.
+     */
+    hasFunction(name) {
+        return this.functions.some((f) => f.name === name);
+    }
+    /**
+     * Gets a function by name.
+     */
+    getFunction(name) {
+        return this.functions.find((f) => f.name === name);
+    }
+    // ============= Runtime Operations =============
+    /**
+     * Adds a runtime configuration.
+     * @param runtime - The runtime configuration object.
+     */
+    addRuntime(runtime) {
+        if (!this._data.runtimes) {
+            this._data.runtimes = [];
+        }
+        this._data.runtimes.push(runtime);
+        this.markDirty();
+        return this;
+    }
+    /**
+     * Adds an OpenAPI runtime.
+     * @param specUrl - URL or relative path to the OpenAPI spec.
+     * @param authType - Authentication type.
+     * @param runForFunctions - Optional array of function names or "*" for all.
+     */
+    addOpenApiRuntime(specUrl, authType = "None", runForFunctions) {
+        return this.addRuntime({
+            type: exports.RuntimeType.OpenApi,
+            auth: { type: authType },
+            spec: { url: specUrl },
+            run_for_functions: runForFunctions !== null && runForFunctions !== void 0 ? runForFunctions : ["*"],
+        });
+    }
+    /**
+     * Adds a LocalPlugin runtime.
+     * @param localEndpoint - The local endpoint identifier.
+     * @param runForFunctions - Optional array of function names.
+     */
+    addLocalPluginRuntime(localEndpoint, runForFunctions) {
+        return this.addRuntime({
+            type: exports.RuntimeType.LocalPlugin,
+            auth: { type: "None" },
+            spec: { local_endpoint: localEndpoint },
+            run_for_functions: runForFunctions !== null && runForFunctions !== void 0 ? runForFunctions : ["*"],
+        });
+    }
+    /**
+     * Removes a runtime by spec URL.
+     * @param specUrl - The spec URL of the runtime to remove.
+     */
+    removeRuntimeBySpecUrl(specUrl) {
+        if (this._data.runtimes) {
+            const runtimes = this._data.runtimes;
+            this._data.runtimes = runtimes.filter((rt) => { var _a; return !(((_a = rt.spec) === null || _a === void 0 ? void 0 : _a.url) === specUrl); });
+            this.markDirty();
+        }
+        return this;
+    }
+    // ============= Query Operations =============
+    /**
+     * Returns all API spec paths/URLs from runtimes.
+     */
+    getApiSpecPaths() {
+        return this.runtimes
+            .filter((rt) => rt.type === exports.RuntimeType.OpenApi)
+            .map((rt) => { var _a; return (_a = rt.spec) === null || _a === void 0 ? void 0 : _a.url; })
+            .filter((url) => typeof url === "string");
+    }
+    // ============= Validation =============
+    /**
+     * Validates the manifest against its JSON schema.
+     * @returns Array of validation error messages, empty if valid.
+     */
+    async validate() {
+        return generated_types_1.AppManifestUtils.validateAgainstSchema(this._data);
+    }
+    // ============= Serialization =============
+    /**
+     * Converts the manifest to a formatted JSON string.
+     */
+    toJSON() {
+        return generated_types_1.ApiPluginManifestConverter.manifestToJson(this._data);
+    }
+    /**
+     * Creates a deep clone of this manifest.
+     */
+    clone() {
+        const clonedData = JSON.parse(this.toJSON());
+        return new APIPluginManifestWrapper(clonedData);
+    }
+    /**
+     * Creates a deep clone with partial modifications applied.
+     * Useful for creating a modified copy without mutating the original.
+     * @param changes - Partial manifest data to merge into the clone. Allows additional properties for extensibility.
+     * @returns A new APIPluginManifestWrapper with the changes applied.
+     */
+    cloneWith(changes) {
+        const clonedData = JSON.parse(this.toJSON());
+        Object.assign(clonedData, changes);
+        const wrapper = new APIPluginManifestWrapper(clonedData);
+        wrapper.markDirty();
+        return wrapper;
+    }
+    /**
+     * Returns a mutable reference to the manifest data for direct modification.
+     * Use with caution - prefer using the fluent API methods when possible.
+     * Changes made through this reference will be tracked as dirty.
+     */
+    get mutableData() {
+        this.markDirty();
+        return this._data;
+    }
+}
+exports.APIPluginManifestWrapper = APIPluginManifestWrapper;
+//# sourceMappingURL=APIPluginManifestWrapper.js.map

package/build/wrappers/APIPluginManifestWrapper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"APIPluginManifestWrapper.js","sourceRoot":"","sources":["../../src/wrappers/APIPluginManifestWrapper.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAElC,wDAK4B;AAC5B,iDAA8C;AAkB9C;;;;GAIG;AACU,QAAA,WAAW,GAA4C;IAClE,OAAO,EAAE,SAAS;IAClB,WAAW,EAAE,aAAa;IAC1B,eAAe,EAAE,iBAAiB;CAC1B,CAAC;AAEX;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAa,wBAAyB,SAAQ,2BAA+B;IAC3E,YAAoB,IAAuB,EAAE,QAAiB;QAC5D,KAAK,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACxB,CAAC;IAED,qDAAqD;IAErD;;;;OAIG;IACH,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,QAAgB;QAChC,MAAM,IAAI,GAAG,MAAM,kCAAgB,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;QACpE,OAAO,IAAI,wBAAwB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,QAAgB;QAC9B,MAAM,IAAI,GAAG,2BAAY,CAAC,gBAAgB,CAAoB,QAAQ,CAAC,CAAC;QACxE,MAAM,IAAI,GAAG,4CAA0B,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;QAC7E,OAAO,IAAI,wBAAwB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAY;QAC1B,MAAM,IAAI,GAAG,4CAA0B,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QAC7D,OAAO,IAAI,wBAAwB,CAAC,IAAI,CAAC,CAAC;IAC5C,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,MAAM,CAAC,IAKb;;QACC,MAAM,IAAI,GAAsB;YAC9B,cAAc,EAAE,IAAI,CAAC,aAAa;YAClC,cAAc,EAAE,IAAI,CAAC,YAAY;YACjC,qBAAqB,EAAE,IAAI,CAAC,mBAAmB;YAC/C,SAAS,EAAE,MAAA,IAAI,CAAC,SAAS,mCAAI,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC;SAC/C,CAAC;QACvB,OAAO,IAAI,wBAAwB,CAAC,IAAI,CAAC,CAAC;IAC5C,CAAC;IAED,sCAAsC;IAEtC;;OAEG;IACH,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC;IACnC,CAAC;IAED;;OAEG;IACH,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC;IACnC,CAAC;IAED;;OAEG;IACH,IAAI,mBAAmB;QACrB,OAAO,IAAI,CAAC,KAAK,CAAC,qBAAqB,CAAC;IAC1C,CAAC;IAED;;OAEG;IACH,IAAI,SAAS;QACX,OAAQ,IAAI,CAAC,KAA4B,CAAC,SAAS,CAAC;IACtD,CAAC;IAED;;OAEG;IACH,IAAI,SAAS;;QACX,OAAO,MAAC,IAAI,CAAC,KAAK,CAAC,SAA8C,mCAAI,EAAE,CAAC;IAC1E,CAAC;IAED;;OAEG;IACH,IAAI,QAAQ;;QACV,OAAO,MAAC,IAAI,CAAC,KAAK,CAAC,QAAwC,mCAAI,EAAE,CAAC;IACpE,CAAC;IAED,mDAAmD;IAEnD;;OAEG;IACH,eAAe,CAAC,IAAY;QAC1B,IAAI,CAAC,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC;QACjC,IAAI,CAAC,SAAS,EAAE,CAAC;QACjB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,sBAAsB,CAAC,WAAmB;QACxC,IAAI,CAAC,KAAK,CAAC,qBAAqB,GAAG,WAAW,CAAC;QAC/C,IAAI,CAAC,SAAS,EAAE,CAAC;QACjB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,sBAAsB,CAAC,WAAmB;QACxC,IAAI,CAAC,KAAK,CAAC,qBAAqB,GAAG,WAAW,CAAC;QAC/C,IAAI,CAAC,SAAS,EAAE,CAAC;QACjB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,YAAY,CAAC,SAAiB;QAC3B,IAAI,CAAC,KAA4B,CAAC,SAAS,GAAG,SAAS,CAAC;QACzD,IAAI,CAAC,SAAS,EAAE,CAAC;QACjB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,kDAAkD;IAElD;;;;OAIG;IACH,WAAW,CAAC,IAAY,EAAE,WAAoB;QAC5C,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE;YACzB,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,EAAE,CAAC;SAC3B;QACD,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;QACnE,IAAI,CAAC,QAAQ,EAAE;YACZ,IAAI,CAAC,KAAK,CAAC,SAAkC,CAAC,IAAI,CAAC;gBAClD,IAAI;gBACJ,WAAW;aACU,CAAC,CAAC;YACzB,IAAI,CAAC,SAAS,EAAE,CAAC;SAClB;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,cAAc,CAAC,IAAY;QACzB,IAAI,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE;YACxB,IAAI,CAAC,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;YAC3E,IAAI,CAAC,SAAS,EAAE,CAAC;SAClB;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,IAAY;QACtB,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;IACrD,CAAC;IAED;;OAEG;IACH,WAAW,CAAC,IAAY;QACtB,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;IACrD,CAAC;IAED,iDAAiD;IAEjD;;;OAGG;IACH,UAAU,CAAC,OAAsB;QAC/B,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE;YACxB,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,EAAE,CAAC;SAC1B;QACA,IAAI,CAAC,KAAK,CAAC,QAA4B,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvD,IAAI,CAAC,SAAS,EAAE,CAAC;QACjB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,iBAAiB,CACf,OAAe,EACf,WAA8D,MAAM,EACpE,eAA0B;QAE1B,OAAO,IAAI,CAAC,UAAU,CAAC;YACrB,IAAI,EAAE,mBAAW,CAAC,OAAO;YACzB,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;YACxB,IAAI,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE;YACtB,iBAAiB,EAAE,eAAe,aAAf,eAAe,cAAf,eAAe,GAAI,CAAC,GAAG,CAAC;SAC3B,CAAC,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACH,qBAAqB,CAAC,aAAuC,EAAE,eAA0B;QACvF,OAAO,IAAI,CAAC,UAAU,CAAC;YACrB,IAAI,EAAE,mBAAW,CAAC,WAAW;YAC7B,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE;YACtB,IAAI,EAAE,EAAE,cAAc,EAAE,aAAa,EAAE;YACvC,iBAAiB,EAAE,eAAe,aAAf,eAAe,cAAf,eAAe,GAAI,CAAC,GAAG,CAAC;SAC3B,CAAC,CAAC;IACtB,CAAC;IAED;;;OAGG;IACH,sBAAsB,CAAC,OAAe;QACpC,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE;YACvB,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAA2B,CAAC;YACxD,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC,MAAM,CACnC,CAAC,EAAiB,EAAE,EAAE,WAAC,OAAA,CAAC,CAAC,CAAA,MAAC,EAAkC,CAAC,IAAI,0CAAE,GAAG,MAAK,OAAO,CAAC,CAAA,EAAA,CACpF,CAAC;YACF,IAAI,CAAC,SAAS,EAAE,CAAC;SAClB;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,+CAA+C;IAE/C;;OAEG;IACH,eAAe;QACb,OAAO,IAAI,CAAC,QAAQ;aACjB,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,IAAI,KAAK,mBAAW,CAAC,OAAO,CAAC;aAC/C,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,WAAC,OAAA,MAAC,EAAkC,CAAC,IAAI,0CAAE,GAAG,CAAA,EAAA,CAAC;aAC1D,MAAM,CAAC,CAAC,GAAG,EAAiB,EAAE,CAAC,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC;IAC7D,CAAC;IAED,yCAAyC;IAEzC;;;OAGG;IACH,KAAK,CAAC,QAAQ;QACZ,OAAO,kCAAgB,CAAC,qBAAqB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC5D,CAAC;IAED,4CAA4C;IAE5C;;OAEG;IACH,MAAM;QACJ,OAAO,4CAA0B,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACH,KAAK;QACH,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,CAAsB,CAAC;QAClE,OAAO,IAAI,wBAAwB,CAAC,UAAU,CAAC,CAAC;IAClD,CAAC;IAED;;;;;OAKG;IACH,SAAS,CACP,OAA6D;QAE7D,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,CAAsB,CAAC;QAClE,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QACnC,MAAM,OAAO,GAAG,IAAI,wBAAwB,CAAC,UAAU,CAAC,CAAC;QACzD,OAAO,CAAC,SAAS,EAAE,CAAC;QACpB,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACH,IAAI,WAAW;QACb,IAAI,CAAC,SAAS,EAAE,CAAC;QACjB,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;CACF;AA3TD,4DA2TC"}

package/build/wrappers/BaseManifest.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Abstract base class for manifest wrappers.
+ * Provides common functionality for reading, writing, and tracking changes to manifest files.
+ *
+ * @template T - The manifest type this wrapper handles
+ */
+export declare abstract class BaseManifest<T extends Record<string, unknown>> {
+    protected _data: T;
+    protected _filePath?: string;
+    protected _isDirty: boolean;
+    protected constructor(data: T, filePath?: string);
+    /**
+     * Returns the raw manifest data.
+     */
+    get data(): Readonly<T>;
+    /**
+     * Returns the file path if the manifest was loaded from a file.
+     */
+    get filePath(): string | undefined;
+    /**
+     * Indicates whether the manifest has unsaved changes.
+     */
+    get isDirty(): boolean;
+    /**
+     * Marks the manifest as having unsaved changes.
+     */
+    protected markDirty(): void;
+    /**
+     * Saves the manifest to the specified file path or the original file path.
+     * @param filePath - Optional path to save to. If not provided, uses the original file path.
+     * @throws Error if no file path is available.
+     */
+    save(filePath?: string): Promise<void>;
+    /**
+     * Validates the manifest against its schema.
+     * @returns Array of validation error messages, empty if valid.
+     */
+    abstract validate(): Promise<string[]>;
+    /**
+     * Converts the manifest to a JSON string.
+     */
+    abstract toJSON(): string;
+    /**
+     * Creates a deep clone of this manifest wrapper.
+     */
+    abstract clone(): BaseManifest<T>;
+    /**
+     * Reads a JSON file and returns the parsed object.
+     * @param filePath - Path to the JSON file
+     */
+    protected static readJsonFile<U>(filePath: string): Promise<U>;
+    /**
+     * Reads a JSON file synchronously and returns the parsed object.
+     * @param filePath - Path to the JSON file
+     */
+    protected static readJsonFileSync<U>(filePath: string): U;
+}

package/build/wrappers/BaseManifest.js

@@ -0,0 +1,84 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseManifest = void 0;
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const strip_bom_1 = __importDefault(require("strip-bom"));
+/**
+ * Abstract base class for manifest wrappers.
+ * Provides common functionality for reading, writing, and tracking changes to manifest files.
+ *
+ * @template T - The manifest type this wrapper handles
+ */
+class BaseManifest {
+    constructor(data, filePath) {
+        this._isDirty = false;
+        this._data = data;
+        this._filePath = filePath;
+    }
+    /**
+     * Returns the raw manifest data.
+     */
+    get data() {
+        return this._data;
+    }
+    /**
+     * Returns the file path if the manifest was loaded from a file.
+     */
+    get filePath() {
+        return this._filePath;
+    }
+    /**
+     * Indicates whether the manifest has unsaved changes.
+     */
+    get isDirty() {
+        return this._isDirty;
+    }
+    /**
+     * Marks the manifest as having unsaved changes.
+     */
+    markDirty() {
+        this._isDirty = true;
+    }
+    /**
+     * Saves the manifest to the specified file path or the original file path.
+     * @param filePath - Optional path to save to. If not provided, uses the original file path.
+     * @throws Error if no file path is available.
+     */
+    async save(filePath) {
+        const targetPath = filePath !== null && filePath !== void 0 ? filePath : this._filePath;
+        if (!targetPath) {
+            throw new Error("No file path specified for saving.");
+        }
+        await fs_extra_1.default.writeFile(targetPath, this.toJSON(), "utf-8");
+        this._filePath = targetPath;
+        this._isDirty = false;
+    }
+    // ============= Static Helpers =============
+    /**
+     * Reads a JSON file and returns the parsed object.
+     * @param filePath - Path to the JSON file
+     */
+    static async readJsonFile(filePath) {
+        const content = await fs_extra_1.default.readFile(filePath, "utf-8");
+        // Strip BOM to handle UTF-8 BOM encoded files
+        const cleanContent = (0, strip_bom_1.default)(content);
+        return JSON.parse(cleanContent);
+    }
+    /**
+     * Reads a JSON file synchronously and returns the parsed object.
+     * @param filePath - Path to the JSON file
+     */
+    static readJsonFileSync(filePath) {
+        const content = fs_extra_1.default.readFileSync(filePath, "utf-8");
+        // Strip BOM to handle UTF-8 BOM encoded files
+        const cleanContent = (0, strip_bom_1.default)(content);
+        return JSON.parse(cleanContent);
+    }
+}
+exports.BaseManifest = BaseManifest;
+//# sourceMappingURL=BaseManifest.js.map

package/build/wrappers/BaseManifest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseManifest.js","sourceRoot":"","sources":["../../src/wrappers/BaseManifest.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;;;;AAElC,wDAA0B;AAC1B,0DAAiC;AAEjC;;;;;GAKG;AACH,MAAsB,YAAY;IAKhC,YAAsB,IAAO,EAAE,QAAiB;QAFtC,aAAQ,GAAG,KAAK,CAAC;QAGzB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;OAEG;IACH,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;OAEG;IACO,SAAS;QACjB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,IAAI,CAAC,QAAiB;QAC1B,MAAM,UAAU,GAAG,QAAQ,aAAR,QAAQ,cAAR,QAAQ,GAAI,IAAI,CAAC,SAAS,CAAC;QAC9C,IAAI,CAAC,UAAU,EAAE;YACf,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;SACvD;QACD,MAAM,kBAAE,CAAC,SAAS,CAAC,UAAU,EAAE,IAAI,CAAC,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;QACvD,IAAI,CAAC,SAAS,GAAG,UAAU,CAAC;QAC5B,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;IACxB,CAAC;IAkBD,6CAA6C;IAE7C;;;OAGG;IACO,MAAM,CAAC,KAAK,CAAC,YAAY,CAAI,QAAgB;QACrD,MAAM,OAAO,GAAG,MAAM,kBAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QACrD,8CAA8C;QAC9C,MAAM,YAAY,GAAG,IAAA,mBAAQ,EAAC,OAAO,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAM,CAAC;IACvC,CAAC;IAED;;;OAGG;IACO,MAAM,CAAC,gBAAgB,CAAI,QAAgB;QACnD,MAAM,OAAO,GAAG,kBAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QACnD,8CAA8C;QAC9C,MAAM,YAAY,GAAG,IAAA,mBAAQ,EAAC,OAAO,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAM,CAAC;IACvC,CAAC;CACF;AA5FD,oCA4FC"}