oas 38.3.0 → 38.4.0

package/dist/pruner/index.cjs

@@ -0,0 +1,87 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+var _chunkZ2WDQGCUcjs = require('../chunk-Z2WDQGCU.cjs');
+require('../chunk-COHEPMUP.cjs');
+require('../chunk-Y64TRECN.cjs');
+require('../chunk-7WBPPWYI.cjs');
+require('../chunk-6HXOZ5GY.cjs');
+require('../chunk-7PWF3F2W.cjs');
+
+// src/pruner/index.ts
+var OpenAPIPruner = class _OpenAPIPruner extends _chunkZ2WDQGCUcjs.OpenAPITransformer {
+  constructor(definition) {
+    super(definition, {
+      mode: "prune"
+    });
+  }
+  /**
+   * Initialize a new `OpenAPIPruner`. The pruner removes selected tags, paths, operations,
+   * operation IDs, and webhooks together with components and tags that are no longer reachable
+   * from the remaining operations. Removal filters are additive, so an operation matching any
+   * configured filter is removed.
+   *
+   * @param definition OpenAPI definition to prune.
+   */
+  static init(definition) {
+    return new _OpenAPIPruner(definition);
+  }
+  /**
+   * Remove every OpenAPI operation containing a tag. Operations without any tags are retained. Tag
+   * casing does not matter.
+   *
+   * When combined with operation ID, path, operation, or webhook removals, the filters remain
+   * additive. Any operation matching the tag OR another removal filter will be removed.
+   *
+   * @param tag Tag whose operations should be removed.
+   */
+  removeTag(tag) {
+    this.selectTag(tag);
+    return this;
+  }
+  /**
+   * Remove an entire OpenAPI path and all operations that it contains. Path casing does not matter.
+   *
+   * @param path Path to remove.
+   */
+  removePath(path) {
+    this.selectPath(path);
+    return this;
+  }
+  /**
+   * Remove a single OpenAPI operation. Path and method casing does not matter.
+   *
+   * If you previously called `.removePath()` to remove the entire path, calling
+   * `.removeOperation()` will not narrow that selection. The entire path will still be removed.
+   *
+   * @param path Path containing the operation.
+   * @param method HTTP method of the operation to remove.
+   */
+  removeOperation(path, method) {
+    this.selectOperation(path, method);
+    return this;
+  }
+  /**
+   * Remove an OpenAPI operation by its operation ID. IDs are matched exactly. If an operation does
+   * not have an authored ID, the generated ID from `Operation.getOperationId()` can be used instead.
+   *
+   * Operation ID filters are additive with tag, path, operation, and webhook filters.
+   *
+   * @param operationId Operation ID to remove.
+   */
+  removeOperationId(operationId) {
+    this.selectOperationId(operationId);
+    return this;
+  }
+  removeWebhook(webhookName, method) {
+    this.selectWebhook(webhookName, method);
+    return this;
+  }
+  /** Prune the configured tags, paths, operations, operation IDs, and webhooks from the definition. */
+  prune() {
+    return this.transform();
+  }
+};
+
+
+exports.OpenAPIPruner = OpenAPIPruner;
+//# sourceMappingURL=index.cjs.map

package/dist/pruner/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["/Users/erunion/code/readme/oas/packages/oas/dist/pruner/index.cjs","../../src/pruner/index.ts"],"names":[],"mappings":"AAAA;AACE;AACF,yDAA8B;AAC9B,iCAA8B;AAC9B,iCAA8B;AAC9B,iCAA8B;AAC9B,iCAA8B;AAC9B,iCAA8B;AAC9B;AACA;ACLO,IAAM,cAAA,EAAN,MAAM,eAAA,QAAsB,qCAAmB;AAAA,EAC5C,WAAA,CAAY,UAAA,EAAyB;AAC3C,IAAA,KAAA,CAAM,UAAA,EAAY;AAAA,MAChB,IAAA,EAAM;AAAA,IACR,CAAC,CAAA;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,OAAO,IAAA,CAAK,UAAA,EAAwC;AAClD,IAAA,OAAO,IAAI,cAAA,CAAc,UAAU,CAAA;AAAA,EACrC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,SAAA,CAAU,GAAA,EAA4B;AACpC,IAAA,IAAA,CAAK,SAAA,CAAU,GAAG,CAAA;AAClB,IAAA,OAAO,IAAA;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,UAAA,CAAW,IAAA,EAA6B;AACtC,IAAA,IAAA,CAAK,UAAA,CAAW,IAAI,CAAA;AACpB,IAAA,OAAO,IAAA;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,eAAA,CAAgB,IAAA,EAAc,MAAA,EAA+B;AAC3D,IAAA,IAAA,CAAK,eAAA,CAAgB,IAAA,EAAM,MAAM,CAAA;AACjC,IAAA,OAAO,IAAA;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,iBAAA,CAAkB,WAAA,EAAoC;AACpD,IAAA,IAAA,CAAK,iBAAA,CAAkB,WAAW,CAAA;AAClC,IAAA,OAAO,IAAA;AAAA,EACT;AAAA,EAoBA,aAAA,CAAc,WAAA,EAAqB,MAAA,EAAgC;AACjE,IAAA,IAAA,CAAK,aAAA,CAAc,WAAA,EAAa,MAAM,CAAA;AACtC,IAAA,OAAO,IAAA;AAAA,EACT;AAAA;AAAA,EAGA,KAAA,CAAA,EAAqB;AACnB,IAAA,OAAO,IAAA,CAAK,SAAA,CAAU,CAAA;AAAA,EACxB;AACF,CAAA;ADlBA;AACE;AACF,sCAAC","file":"/Users/erunion/code/readme/oas/packages/oas/dist/pruner/index.cjs","sourcesContent":[null,"import type { OASDocument } from '../types.js';\n\nimport { OpenAPITransformer } from '../lib/transformer/index.js';\n\nexport class OpenAPIPruner extends OpenAPITransformer {\n  private constructor(definition: OASDocument) {\n    super(definition, {\n      mode: 'prune',\n    });\n  }\n\n  /**\n   * Initialize a new `OpenAPIPruner`. The pruner removes selected tags, paths, operations,\n   * operation IDs, and webhooks together with components and tags that are no longer reachable\n   * from the remaining operations. Removal filters are additive, so an operation matching any\n   * configured filter is removed.\n   *\n   * @param definition OpenAPI definition to prune.\n   */\n  static init(definition: OASDocument): OpenAPIPruner {\n    return new OpenAPIPruner(definition);\n  }\n\n  /**\n   * Remove every OpenAPI operation containing a tag. Operations without any tags are retained. Tag\n   * casing does not matter.\n   *\n   * When combined with operation ID, path, operation, or webhook removals, the filters remain\n   * additive. Any operation matching the tag OR another removal filter will be removed.\n   *\n   * @param tag Tag whose operations should be removed.\n   */\n  removeTag(tag: string): OpenAPIPruner {\n    this.selectTag(tag);\n    return this;\n  }\n\n  /**\n   * Remove an entire OpenAPI path and all operations that it contains. Path casing does not matter.\n   *\n   * @param path Path to remove.\n   */\n  removePath(path: string): OpenAPIPruner {\n    this.selectPath(path);\n    return this;\n  }\n\n  /**\n   * Remove a single OpenAPI operation. Path and method casing does not matter.\n   *\n   * If you previously called `.removePath()` to remove the entire path, calling\n   * `.removeOperation()` will not narrow that selection. The entire path will still be removed.\n   *\n   * @param path Path containing the operation.\n   * @param method HTTP method of the operation to remove.\n   */\n  removeOperation(path: string, method: string): OpenAPIPruner {\n    this.selectOperation(path, method);\n    return this;\n  }\n\n  /**\n   * Remove an OpenAPI operation by its operation ID. IDs are matched exactly. If an operation does\n   * not have an authored ID, the generated ID from `Operation.getOperationId()` can be used instead.\n   *\n   * Operation ID filters are additive with tag, path, operation, and webhook filters.\n   *\n   * @param operationId Operation ID to remove.\n   */\n  removeOperationId(operationId: string): OpenAPIPruner {\n    this.selectOperationId(operationId);\n    return this;\n  }\n\n  /**\n   * Remove an OpenAPI webhook and all operations that it contains. Webhook casing does not matter.\n   *\n   * @param webhookName Webhook to remove.\n   */\n  removeWebhook(webhookName: string): OpenAPIPruner;\n\n  /**\n   * Remove a single OpenAPI webhook operation. Webhook and method casing does not matter.\n   *\n   * If you previously called `.removeWebhook()` to remove the entire webhook, calling it again\n   * with a method will not narrow that selection. The entire webhook will still be removed.\n   *\n   * @param webhookName Webhook containing the operation.\n   * @param method HTTP method of the operation to remove.\n   */\n  removeWebhook(webhookName: string, method: string): OpenAPIPruner;\n\n  removeWebhook(webhookName: string, method?: string): OpenAPIPruner {\n    this.selectWebhook(webhookName, method);\n    return this;\n  }\n\n  /** Prune the configured tags, paths, operations, operation IDs, and webhooks from the definition. */\n  prune(): OASDocument {\n    return this.transform();\n  }\n}\n"]}

package/dist/pruner/index.d.cts

@@ -0,0 +1,72 @@
+import { OASDocument } from '../types.cjs';
+import { O as OpenAPITransformer } from '../index-Borb1VXh.cjs';
+import 'json-schema';
+import 'openapi-types';
+
+declare class OpenAPIPruner extends OpenAPITransformer {
+    private constructor();
+    /**
+     * Initialize a new `OpenAPIPruner`. The pruner removes selected tags, paths, operations,
+     * operation IDs, and webhooks together with components and tags that are no longer reachable
+     * from the remaining operations. Removal filters are additive, so an operation matching any
+     * configured filter is removed.
+     *
+     * @param definition OpenAPI definition to prune.
+     */
+    static init(definition: OASDocument): OpenAPIPruner;
+    /**
+     * Remove every OpenAPI operation containing a tag. Operations without any tags are retained. Tag
+     * casing does not matter.
+     *
+     * When combined with operation ID, path, operation, or webhook removals, the filters remain
+     * additive. Any operation matching the tag OR another removal filter will be removed.
+     *
+     * @param tag Tag whose operations should be removed.
+     */
+    removeTag(tag: string): OpenAPIPruner;
+    /**
+     * Remove an entire OpenAPI path and all operations that it contains. Path casing does not matter.
+     *
+     * @param path Path to remove.
+     */
+    removePath(path: string): OpenAPIPruner;
+    /**
+     * Remove a single OpenAPI operation. Path and method casing does not matter.
+     *
+     * If you previously called `.removePath()` to remove the entire path, calling
+     * `.removeOperation()` will not narrow that selection. The entire path will still be removed.
+     *
+     * @param path Path containing the operation.
+     * @param method HTTP method of the operation to remove.
+     */
+    removeOperation(path: string, method: string): OpenAPIPruner;
+    /**
+     * Remove an OpenAPI operation by its operation ID. IDs are matched exactly. If an operation does
+     * not have an authored ID, the generated ID from `Operation.getOperationId()` can be used instead.
+     *
+     * Operation ID filters are additive with tag, path, operation, and webhook filters.
+     *
+     * @param operationId Operation ID to remove.
+     */
+    removeOperationId(operationId: string): OpenAPIPruner;
+    /**
+     * Remove an OpenAPI webhook and all operations that it contains. Webhook casing does not matter.
+     *
+     * @param webhookName Webhook to remove.
+     */
+    removeWebhook(webhookName: string): OpenAPIPruner;
+    /**
+     * Remove a single OpenAPI webhook operation. Webhook and method casing does not matter.
+     *
+     * If you previously called `.removeWebhook()` to remove the entire webhook, calling it again
+     * with a method will not narrow that selection. The entire webhook will still be removed.
+     *
+     * @param webhookName Webhook containing the operation.
+     * @param method HTTP method of the operation to remove.
+     */
+    removeWebhook(webhookName: string, method: string): OpenAPIPruner;
+    /** Prune the configured tags, paths, operations, operation IDs, and webhooks from the definition. */
+    prune(): OASDocument;
+}
+
+export { OpenAPIPruner };

package/dist/pruner/index.d.ts

@@ -0,0 +1,72 @@
+import { OASDocument } from '../types.js';
+import { O as OpenAPITransformer } from '../index-Br-eJMCh.js';
+import 'json-schema';
+import 'openapi-types';
+
+declare class OpenAPIPruner extends OpenAPITransformer {
+    private constructor();
+    /**
+     * Initialize a new `OpenAPIPruner`. The pruner removes selected tags, paths, operations,
+     * operation IDs, and webhooks together with components and tags that are no longer reachable
+     * from the remaining operations. Removal filters are additive, so an operation matching any
+     * configured filter is removed.
+     *
+     * @param definition OpenAPI definition to prune.
+     */
+    static init(definition: OASDocument): OpenAPIPruner;
+    /**
+     * Remove every OpenAPI operation containing a tag. Operations without any tags are retained. Tag
+     * casing does not matter.
+     *
+     * When combined with operation ID, path, operation, or webhook removals, the filters remain
+     * additive. Any operation matching the tag OR another removal filter will be removed.
+     *
+     * @param tag Tag whose operations should be removed.
+     */
+    removeTag(tag: string): OpenAPIPruner;
+    /**
+     * Remove an entire OpenAPI path and all operations that it contains. Path casing does not matter.
+     *
+     * @param path Path to remove.
+     */
+    removePath(path: string): OpenAPIPruner;
+    /**
+     * Remove a single OpenAPI operation. Path and method casing does not matter.
+     *
+     * If you previously called `.removePath()` to remove the entire path, calling
+     * `.removeOperation()` will not narrow that selection. The entire path will still be removed.
+     *
+     * @param path Path containing the operation.
+     * @param method HTTP method of the operation to remove.
+     */
+    removeOperation(path: string, method: string): OpenAPIPruner;
+    /**
+     * Remove an OpenAPI operation by its operation ID. IDs are matched exactly. If an operation does
+     * not have an authored ID, the generated ID from `Operation.getOperationId()` can be used instead.
+     *
+     * Operation ID filters are additive with tag, path, operation, and webhook filters.
+     *
+     * @param operationId Operation ID to remove.
+     */
+    removeOperationId(operationId: string): OpenAPIPruner;
+    /**
+     * Remove an OpenAPI webhook and all operations that it contains. Webhook casing does not matter.
+     *
+     * @param webhookName Webhook to remove.
+     */
+    removeWebhook(webhookName: string): OpenAPIPruner;
+    /**
+     * Remove a single OpenAPI webhook operation. Webhook and method casing does not matter.
+     *
+     * If you previously called `.removeWebhook()` to remove the entire webhook, calling it again
+     * with a method will not narrow that selection. The entire webhook will still be removed.
+     *
+     * @param webhookName Webhook containing the operation.
+     * @param method HTTP method of the operation to remove.
+     */
+    removeWebhook(webhookName: string, method: string): OpenAPIPruner;
+    /** Prune the configured tags, paths, operations, operation IDs, and webhooks from the definition. */
+    prune(): OASDocument;
+}
+
+export { OpenAPIPruner };

package/dist/pruner/index.js

@@ -0,0 +1,87 @@
+import {
+  OpenAPITransformer
+} from "../chunk-4CWJNFV5.js";
+import "../chunk-QTPMJRIE.js";
+import "../chunk-5ZBXVQYR.js";
+import "../chunk-ANZIKNVX.js";
+import "../chunk-LZNTJ4ZR.js";
+import "../chunk-XG4HGNCN.js";
+
+// src/pruner/index.ts
+var OpenAPIPruner = class _OpenAPIPruner extends OpenAPITransformer {
+  constructor(definition) {
+    super(definition, {
+      mode: "prune"
+    });
+  }
+  /**
+   * Initialize a new `OpenAPIPruner`. The pruner removes selected tags, paths, operations,
+   * operation IDs, and webhooks together with components and tags that are no longer reachable
+   * from the remaining operations. Removal filters are additive, so an operation matching any
+   * configured filter is removed.
+   *
+   * @param definition OpenAPI definition to prune.
+   */
+  static init(definition) {
+    return new _OpenAPIPruner(definition);
+  }
+  /**
+   * Remove every OpenAPI operation containing a tag. Operations without any tags are retained. Tag
+   * casing does not matter.
+   *
+   * When combined with operation ID, path, operation, or webhook removals, the filters remain
+   * additive. Any operation matching the tag OR another removal filter will be removed.
+   *
+   * @param tag Tag whose operations should be removed.
+   */
+  removeTag(tag) {
+    this.selectTag(tag);
+    return this;
+  }
+  /**
+   * Remove an entire OpenAPI path and all operations that it contains. Path casing does not matter.
+   *
+   * @param path Path to remove.
+   */
+  removePath(path) {
+    this.selectPath(path);
+    return this;
+  }
+  /**
+   * Remove a single OpenAPI operation. Path and method casing does not matter.
+   *
+   * If you previously called `.removePath()` to remove the entire path, calling
+   * `.removeOperation()` will not narrow that selection. The entire path will still be removed.
+   *
+   * @param path Path containing the operation.
+   * @param method HTTP method of the operation to remove.
+   */
+  removeOperation(path, method) {
+    this.selectOperation(path, method);
+    return this;
+  }
+  /**
+   * Remove an OpenAPI operation by its operation ID. IDs are matched exactly. If an operation does
+   * not have an authored ID, the generated ID from `Operation.getOperationId()` can be used instead.
+   *
+   * Operation ID filters are additive with tag, path, operation, and webhook filters.
+   *
+   * @param operationId Operation ID to remove.
+   */
+  removeOperationId(operationId) {
+    this.selectOperationId(operationId);
+    return this;
+  }
+  removeWebhook(webhookName, method) {
+    this.selectWebhook(webhookName, method);
+    return this;
+  }
+  /** Prune the configured tags, paths, operations, operation IDs, and webhooks from the definition. */
+  prune() {
+    return this.transform();
+  }
+};
+export {
+  OpenAPIPruner
+};
+//# sourceMappingURL=index.js.map

package/dist/pruner/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/pruner/index.ts"],"sourcesContent":["import type { OASDocument } from '../types.js';\n\nimport { OpenAPITransformer } from '../lib/transformer/index.js';\n\nexport class OpenAPIPruner extends OpenAPITransformer {\n  private constructor(definition: OASDocument) {\n    super(definition, {\n      mode: 'prune',\n    });\n  }\n\n  /**\n   * Initialize a new `OpenAPIPruner`. The pruner removes selected tags, paths, operations,\n   * operation IDs, and webhooks together with components and tags that are no longer reachable\n   * from the remaining operations. Removal filters are additive, so an operation matching any\n   * configured filter is removed.\n   *\n   * @param definition OpenAPI definition to prune.\n   */\n  static init(definition: OASDocument): OpenAPIPruner {\n    return new OpenAPIPruner(definition);\n  }\n\n  /**\n   * Remove every OpenAPI operation containing a tag. Operations without any tags are retained. Tag\n   * casing does not matter.\n   *\n   * When combined with operation ID, path, operation, or webhook removals, the filters remain\n   * additive. Any operation matching the tag OR another removal filter will be removed.\n   *\n   * @param tag Tag whose operations should be removed.\n   */\n  removeTag(tag: string): OpenAPIPruner {\n    this.selectTag(tag);\n    return this;\n  }\n\n  /**\n   * Remove an entire OpenAPI path and all operations that it contains. Path casing does not matter.\n   *\n   * @param path Path to remove.\n   */\n  removePath(path: string): OpenAPIPruner {\n    this.selectPath(path);\n    return this;\n  }\n\n  /**\n   * Remove a single OpenAPI operation. Path and method casing does not matter.\n   *\n   * If you previously called `.removePath()` to remove the entire path, calling\n   * `.removeOperation()` will not narrow that selection. The entire path will still be removed.\n   *\n   * @param path Path containing the operation.\n   * @param method HTTP method of the operation to remove.\n   */\n  removeOperation(path: string, method: string): OpenAPIPruner {\n    this.selectOperation(path, method);\n    return this;\n  }\n\n  /**\n   * Remove an OpenAPI operation by its operation ID. IDs are matched exactly. If an operation does\n   * not have an authored ID, the generated ID from `Operation.getOperationId()` can be used instead.\n   *\n   * Operation ID filters are additive with tag, path, operation, and webhook filters.\n   *\n   * @param operationId Operation ID to remove.\n   */\n  removeOperationId(operationId: string): OpenAPIPruner {\n    this.selectOperationId(operationId);\n    return this;\n  }\n\n  /**\n   * Remove an OpenAPI webhook and all operations that it contains. Webhook casing does not matter.\n   *\n   * @param webhookName Webhook to remove.\n   */\n  removeWebhook(webhookName: string): OpenAPIPruner;\n\n  /**\n   * Remove a single OpenAPI webhook operation. Webhook and method casing does not matter.\n   *\n   * If you previously called `.removeWebhook()` to remove the entire webhook, calling it again\n   * with a method will not narrow that selection. The entire webhook will still be removed.\n   *\n   * @param webhookName Webhook containing the operation.\n   * @param method HTTP method of the operation to remove.\n   */\n  removeWebhook(webhookName: string, method: string): OpenAPIPruner;\n\n  removeWebhook(webhookName: string, method?: string): OpenAPIPruner {\n    this.selectWebhook(webhookName, method);\n    return this;\n  }\n\n  /** Prune the configured tags, paths, operations, operation IDs, and webhooks from the definition. */\n  prune(): OASDocument {\n    return this.transform();\n  }\n}\n"],"mappings":";;;;;;;;;;AAIO,IAAM,gBAAN,MAAM,uBAAsB,mBAAmB;AAAA,EAC5C,YAAY,YAAyB;AAC3C,UAAM,YAAY;AAAA,MAChB,MAAM;AAAA,IACR,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,OAAO,KAAK,YAAwC;AAClD,WAAO,IAAI,eAAc,UAAU;AAAA,EACrC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,UAAU,KAA4B;AACpC,SAAK,UAAU,GAAG;AAClB,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,WAAW,MAA6B;AACtC,SAAK,WAAW,IAAI;AACpB,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,gBAAgB,MAAc,QAA+B;AAC3D,SAAK,gBAAgB,MAAM,MAAM;AACjC,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,kBAAkB,aAAoC;AACpD,SAAK,kBAAkB,WAAW;AAClC,WAAO;AAAA,EACT;AAAA,EAoBA,cAAc,aAAqB,QAAgC;AACjE,SAAK,cAAc,aAAa,MAAM;AACtC,WAAO;AAAA,EACT;AAAA;AAAA,EAGA,QAAqB;AACnB,WAAO,KAAK,UAAU;AAAA,EACxB;AACF;","names":[]}