@speakeasy-api/openapi-linter-types 0.1.0

package/README.md

@@ -0,0 +1,141 @@
+# @speakeasy-api/openapi-linter-types
+
+TypeScript types for writing custom OpenAPI linter rules.
+
+## Installation
+
+```bash
+npm install @speakeasy-api/openapi-linter-types
+```
+
+## Usage
+
+Create a TypeScript file with your custom rule:
+
+```typescript
+import { Rule, registerRule, createValidationError } from '@speakeasy-api/openapi-linter-types';
+import type { Context, DocumentInfo, RuleConfig, Severity, ValidationError } from '@speakeasy-api/openapi-linter-types';
+
+class RequireOperationSummary extends Rule {
+  id(): string { return 'custom-require-operation-summary'; }
+  category(): string { return 'style'; }
+  description(): string { return 'All operations must have a summary.'; }
+  summary(): string { return 'Operations must have summary'; }
+  defaultSeverity(): Severity { return 'warning'; }
+
+  run(ctx: Context, docInfo: DocumentInfo, config: RuleConfig): ValidationError[] {
+    const errors: ValidationError[] = [];
+
+    for (const opNode of docInfo.index.operations) {
+      const op = opNode.node;
+      if (!op.getSummary()) {
+        errors.push(createValidationError(
+          config.getSeverity(this.defaultSeverity()),
+          this.id(),
+          'Operation is missing a summary',
+          op.getRootNode()
+        ));
+      }
+    }
+
+    return errors;
+  }
+}
+
+registerRule(new RequireOperationSummary());
+```
+
+## Rule Base Class
+
+Extend the `Rule` base class to create custom rules. The following methods must be implemented:
+
+| Method | Description |
+|--------|-------------|
+| `id()` | Unique identifier for the rule (e.g., `custom-require-summary`) |
+| `category()` | Category for grouping rules (e.g., `style`, `security`, `naming`) |
+| `description()` | Full description of what the rule checks |
+| `summary()` | Short summary for display |
+| `run(ctx, docInfo, config)` | Main rule logic that returns validation errors |
+
+Optional methods with defaults:
+
+| Method | Default | Description |
+|--------|---------|-------------|
+| `link()` | `''` | URL to rule documentation |
+| `defaultSeverity()` | `'warning'` | Default severity (`'error'`, `'warning'`, `'hint'`) |
+| `versions()` | `null` | OpenAPI versions this rule applies to (e.g., `['3.0', '3.1']`) |
+
+## Document Access
+
+The `DocumentInfo` object provides access to the parsed OpenAPI document:
+
+```typescript
+// The OpenAPI document root
+docInfo.document
+
+// File location
+docInfo.location
+
+// Pre-computed index with collections for efficient iteration
+docInfo.index.operations         // All operations
+docInfo.index.componentSchemas   // All component schemas
+docInfo.index.inlineSchemas      // All inline schemas
+docInfo.index.parameters         // All parameters (inline + component)
+docInfo.index.requestBodies      // All request bodies
+docInfo.index.responses          // All responses
+docInfo.index.headers            // All headers
+docInfo.index.securitySchemes    // All security schemes
+// ... and many more collections
+```
+
+## Creating Validation Errors
+
+Use `createValidationError()` to create properly formatted errors:
+
+```typescript
+import { createValidationError } from '@speakeasy-api/openapi-linter-types';
+
+const error = createValidationError(
+  'warning',                    // severity
+  'custom-my-rule',            // rule ID
+  'Description of the issue',  // message
+  node.getRootNode()           // YAML node for location
+);
+```
+
+## Console Logging
+
+The `console` global is available for debugging:
+
+```typescript
+console.log('Processing operation:', op.getOperationID());
+console.warn('Missing recommended field');
+console.error('Invalid configuration');
+```
+
+## Configuration
+
+Configure custom rules in your `lint.yaml`:
+
+```yaml
+extends: recommended
+
+custom_rules:
+  paths:
+    - ./rules/*.ts
+    - ./rules/security/*.ts
+
+rules:
+  - id: custom-require-operation-summary
+    severity: error
+```
+
+## API Notes
+
+- Field and method names use lowercase JavaScript conventions (e.g., `getSummary()`, not `GetSummary()`)
+- All Go struct fields and methods are automatically exposed to JavaScript
+- Arrays from the Index use JavaScript array methods (`.forEach()`, `.map()`, etc.)
+
+## License
+
+Apache-2.0

package/dist/config.d.ts

@@ -0,0 +1,17 @@
+import type { Severity } from './severity';
+/**
+ * RuleConfig provides configuration for a rule execution.
+ */
+export interface RuleConfig {
+    /**
+     * Get the effective severity, respecting user overrides.
+     * @param defaultSeverity The rule's default severity
+     * @returns The severity to use (user override or default)
+     */
+    getSeverity(defaultSeverity: Severity): Severity;
+    /**
+     * Whether the rule is enabled.
+     */
+    enabled(): boolean;
+}
+//# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;;;OAIG;IACH,WAAW,CAAC,eAAe,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAEjD;;OAEG;IACH,OAAO,IAAI,OAAO,CAAC;CACpB"}

package/dist/config.js

@@ -0,0 +1 @@
+export {};

package/dist/context.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Context provides cancellation and deadline information.
+ *
+ * Since JavaScript has no channel equivalent to Go's Done(),
+ * rules performing long operations should poll isCancelled() periodically.
+ */
+export interface Context {
+    /**
+     * Check if the context has been cancelled.
+     * Rules performing long operations should poll this periodically.
+     */
+    isCancelled(): boolean;
+    /**
+     * Deadline in milliseconds since epoch, or undefined if no deadline.
+     */
+    deadline(): number | undefined;
+}
+//# sourceMappingURL=context.d.ts.map

package/dist/context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../src/context.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,WAAW,OAAO;IACtB;;;OAGG;IACH,WAAW,IAAI,OAAO,CAAC;IAEvB;;OAEG;IACH,QAAQ,IAAI,MAAM,GAAG,SAAS,CAAC;CAChC"}

package/dist/context.js

@@ -0,0 +1 @@
+export {};

package/dist/document.d.ts

@@ -0,0 +1,254 @@
+import type { Index } from './index-types';
+/**
+ * DocumentInfo provides access to the OpenAPI document and its index.
+ *
+ * Note: All field and method names are lowercased when accessed from JavaScript
+ * due to goja's UncapFieldNameMapper.
+ */
+export interface DocumentInfo {
+    /** The parsed OpenAPI document */
+    readonly document: OpenAPI;
+    /** Absolute path or URL of the document */
+    readonly location: string;
+    /** Pre-computed index for efficient document traversal */
+    readonly index: Index;
+}
+/**
+ * OpenAPI document root object.
+ * Access nested elements via fields or getter methods.
+ */
+export interface OpenAPI {
+    /** OpenAPI version (e.g., "3.1.0") */
+    readonly openAPI: string;
+    /** Document info section */
+    getInfo(): Info | null;
+    /** Document paths */
+    getPaths(): Paths | null;
+    /** Document components */
+    getComponents(): Components | null;
+    /** Document servers */
+    getServers(): Server[] | null;
+    /** Document tags */
+    getTags(): Tag[] | null;
+    /** Document security requirements */
+    getSecurity(): SecurityRequirement[] | null;
+    /** Get the root YAML node */
+    getRootNode(): any;
+}
+export interface Info {
+    readonly title: string;
+    readonly version: string;
+    getDescription(): string;
+    getSummary(): string;
+    getTermsOfService(): string;
+    getContact(): Contact | null;
+    getLicense(): License | null;
+    getRootNode(): any;
+}
+export interface Contact {
+    getName(): string;
+    getURL(): string;
+    getEmail(): string;
+    getRootNode(): any;
+}
+export interface License {
+    readonly name: string;
+    getIdentifier(): string;
+    getURL(): string;
+    getRootNode(): any;
+}
+export interface Paths {
+    /** Get all path item entries */
+    all(): IterableIterator<[string, PathItem]>;
+    getRootNode(): any;
+}
+export interface PathItem {
+    getSummary(): string;
+    getDescription(): string;
+    getParameters(): Parameter[];
+    getServers(): Server[];
+    /** Get a specific operation by HTTP method */
+    getOperation(method: string): Operation | null;
+    /** Get all operations */
+    all(): IterableIterator<[string, Operation]>;
+    getRootNode(): any;
+}
+export interface Operation {
+    getOperationID(): string;
+    getSummary(): string;
+    getDescription(): string;
+    getTags(): string[];
+    getParameters(): Parameter[];
+    getRequestBody(): RequestBody | null;
+    getResponses(): Responses | null;
+    getSecurity(): SecurityRequirement[] | null;
+    getServers(): Server[];
+    getDeprecated(): boolean;
+    getRootNode(): any;
+}
+export interface Parameter {
+    readonly name: string;
+    readonly in: string;
+    getDescription(): string;
+    getRequired(): boolean;
+    getDeprecated(): boolean;
+    getSchema(): Schema | null;
+    getRootNode(): any;
+}
+export interface RequestBody {
+    getDescription(): string;
+    getRequired(): boolean;
+    getContent(): Map<string, MediaType>;
+    getRootNode(): any;
+}
+export interface Responses {
+    /** Get all response entries */
+    all(): IterableIterator<[string, Response]>;
+    getDefault(): Response | null;
+    getRootNode(): any;
+}
+export interface Response {
+    readonly description: string;
+    getHeaders(): Map<string, Header>;
+    getContent(): Map<string, MediaType>;
+    getLinks(): Map<string, Link>;
+    getRootNode(): any;
+}
+export interface Header {
+    getDescription(): string;
+    getRequired(): boolean;
+    getDeprecated(): boolean;
+    getSchema(): Schema | null;
+    getRootNode(): any;
+}
+export interface MediaType {
+    getSchema(): Schema | null;
+    getExample(): any;
+    getExamples(): Map<string, Example>;
+    getEncoding(): Map<string, Encoding>;
+    getRootNode(): any;
+}
+export interface Encoding {
+    getContentType(): string;
+    getHeaders(): Map<string, Header>;
+    getStyle(): string;
+    getExplode(): boolean;
+    getAllowReserved(): boolean;
+    getRootNode(): any;
+}
+export interface Example {
+    getSummary(): string;
+    getDescription(): string;
+    getValue(): any;
+    getExternalValue(): string;
+    getRootNode(): any;
+}
+export interface Link {
+    getOperationID(): string;
+    getOperationRef(): string;
+    getDescription(): string;
+    getServer(): Server | null;
+    getRootNode(): any;
+}
+export interface Components {
+    getSchemas(): Map<string, Schema>;
+    getResponses(): Map<string, Response>;
+    getParameters(): Map<string, Parameter>;
+    getRequestBodies(): Map<string, RequestBody>;
+    getHeaders(): Map<string, Header>;
+    getSecuritySchemes(): Map<string, SecurityScheme>;
+    getLinks(): Map<string, Link>;
+    getCallbacks(): Map<string, Callback>;
+    getPathItems(): Map<string, PathItem>;
+    getRootNode(): any;
+}
+export interface Schema {
+    getType(): string | string[];
+    getFormat(): string;
+    getTitle(): string;
+    getDescription(): string;
+    getDefault(): any;
+    getEnum(): any[];
+    getRequired(): string[];
+    getProperties(): Map<string, Schema>;
+    getItems(): Schema | null;
+    getAdditionalProperties(): Schema | boolean | null;
+    getMinimum(): number | null;
+    getMaximum(): number | null;
+    getMinLength(): number | null;
+    getMaxLength(): number | null;
+    getMinItems(): number | null;
+    getMaxItems(): number | null;
+    getPattern(): string;
+    getNullable(): boolean;
+    getDeprecated(): boolean;
+    getAllOf(): Schema[];
+    getAnyOf(): Schema[];
+    getOneOf(): Schema[];
+    getNot(): Schema | null;
+    getRootNode(): any;
+}
+export interface Server {
+    readonly url: string;
+    getDescription(): string;
+    getVariables(): Map<string, ServerVariable>;
+    getRootNode(): any;
+}
+export interface ServerVariable {
+    readonly default: string;
+    getEnum(): string[];
+    getDescription(): string;
+    getRootNode(): any;
+}
+export interface Tag {
+    readonly name: string;
+    getDescription(): string;
+    getExternalDocs(): ExternalDocumentation | null;
+    getRootNode(): any;
+}
+export interface ExternalDocumentation {
+    readonly url: string;
+    getDescription(): string;
+    getRootNode(): any;
+}
+export interface SecurityScheme {
+    readonly type: string;
+    getDescription(): string;
+    getName(): string;
+    getIn(): string;
+    getScheme(): string;
+    getBearerFormat(): string;
+    getFlows(): OAuthFlows | null;
+    getOpenIdConnectUrl(): string;
+    getRootNode(): any;
+}
+export interface OAuthFlows {
+    getImplicit(): OAuthFlow | null;
+    getPassword(): OAuthFlow | null;
+    getClientCredentials(): OAuthFlow | null;
+    getAuthorizationCode(): OAuthFlow | null;
+    getRootNode(): any;
+}
+export interface OAuthFlow {
+    getAuthorizationUrl(): string;
+    getTokenUrl(): string;
+    getRefreshUrl(): string;
+    getScopes(): Map<string, string>;
+    getRootNode(): any;
+}
+export interface SecurityRequirement {
+    /** Get all security requirement entries */
+    all(): IterableIterator<[string, string[]]>;
+    getRootNode(): any;
+}
+export interface Callback {
+    /** Get all callback entries */
+    all(): IterableIterator<[string, PathItem]>;
+    getRootNode(): any;
+}
+export interface Discriminator {
+    readonly propertyName: string;
+    getMapping(): Map<string, string>;
+    getRootNode(): any;
+}
+//# sourceMappingURL=document.d.ts.map

package/dist/document.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"document.d.ts","sourceRoot":"","sources":["../src/document.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AAE3C;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,kCAAkC;IAClC,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAE3B,2CAA2C;IAC3C,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAE1B,0DAA0D;IAC1D,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB,sCAAsC;IACtC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB,4BAA4B;IAC5B,OAAO,IAAI,IAAI,GAAG,IAAI,CAAC;IAEvB,qBAAqB;IACrB,QAAQ,IAAI,KAAK,GAAG,IAAI,CAAC;IAEzB,0BAA0B;IAC1B,aAAa,IAAI,UAAU,GAAG,IAAI,CAAC;IAEnC,uBAAuB;IACvB,UAAU,IAAI,MAAM,EAAE,GAAG,IAAI,CAAC;IAE9B,oBAAoB;IACpB,OAAO,IAAI,GAAG,EAAE,GAAG,IAAI,CAAC;IAExB,qCAAqC;IACrC,WAAW,IAAI,mBAAmB,EAAE,GAAG,IAAI,CAAC;IAE5C,6BAA6B;IAC7B,WAAW,IAAI,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,IAAI;IACnB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,cAAc,IAAI,MAAM,CAAC;IACzB,UAAU,IAAI,MAAM,CAAC;IACrB,iBAAiB,IAAI,MAAM,CAAC;IAC5B,UAAU,IAAI,OAAO,GAAG,IAAI,CAAC;IAC7B,UAAU,IAAI,OAAO,GAAG,IAAI,CAAC;IAC7B,WAAW,IAAI,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,OAAO;IACtB,OAAO,IAAI,MAAM,CAAC;IAClB,MAAM,IAAI,MAAM,CAAC;IACjB,QAAQ,IAAI,MAAM,CAAC;IACnB,WAAW,IAAI,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,OAAO;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,aAAa,IAAI,MAAM,CAAC;IACxB,MAAM,IAAI,MAAM,CAAC;IACjB,WAAW,IAAI,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,KAAK;IACpB,gCAAgC;IAChC,GAAG,IAAI,gBAAgB,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC5C,WAAW,IAAI,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,QAAQ;IACvB,UAAU,IAAI,MAAM,CAAC;IACrB,cAAc,IAAI,MAAM,CAAC;IACzB,aAAa,IAAI,SAAS,EAAE,CAAC;IAC7B,UAAU,IAAI,MAAM,EAAE,CAAC;IAEvB,8CAA8C;IAC9C,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC;IAE/C,yBAAyB;IACzB,GAAG,IAAI,gBAAgB,CAAC,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;IAE7C,WAAW,IAAI,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,SAAS;IACxB,cAAc,IAAI,MAAM,CAAC;IACzB,UAAU,IAAI,MAAM,CAAC;IACrB,cAAc,IAAI,MAAM,CAAC;IACzB,OAAO,IAAI,MAAM,EAAE,CAAC;IACpB,aAAa,IAAI,SAAS,EAAE,CAAC;IAC7B,cAAc,IAAI,WAAW,GAAG,IAAI,CAAC;IACrC,YAAY,IAAI,SAAS,GAAG,IAAI,CAAC;IACjC,WAAW,IAAI,mBAAmB,EAAE,GAAG,IAAI,CAAC;IAC5C,UAAU,IAAI,MAAM,EAAE,CAAC;IACvB,aAAa,IAAI,OAAO,CAAC;IACzB,WAAW,IAAI,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,cAAc,IAAI,MAAM,CAAC;IACzB,WAAW,IAAI,OAAO,CAAC;IACvB,aAAa,IAAI,OAAO,CAAC;IACzB,SAAS,IAAI,MAAM,GAAG,IAAI,CAAC;IAC3B,WAAW,IAAI,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,WAAW;IAC1B,cAAc,IAAI,MAAM,CAAC;IACzB,WAAW,IAAI,OAAO,CAAC;IACvB,UAAU,IAAI,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACrC,WAAW,IAAI,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,SAAS;IACxB,+BAA+B;IAC/B,GAAG,IAAI,gBAAgB,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC5C,UAAU,IAAI,QAAQ,GAAG,IAAI,CAAC;IAC9B,WAAW,IAAI,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,UAAU,IAAI,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,UAAU,IAAI,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACrC,QAAQ,IAAI,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC9B,WAAW,IAAI,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,MAAM;IACrB,cAAc,IAAI,MAAM,CAAC;IACzB,WAAW,IAAI,OAAO,CAAC;IACvB,aAAa,IAAI,OAAO,CAAC;IACzB,SAAS,IAAI,MAAM,GAAG,IAAI,CAAC;IAC3B,WAAW,IAAI,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,SAAS;IACxB,SAAS,IAAI,MAAM,GAAG,IAAI,CAAC;IAC3B,UAAU,IAAI,GAAG,CAAC;IAClB,WAAW,IAAI,GAAG,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACpC,WAAW,IAAI,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACrC,WAAW,IAAI,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,QAAQ;IACvB,cAAc,IAAI,MAAM,CAAC;IACzB,UAAU,IAAI,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,QAAQ,IAAI,MAAM,CAAC;IACnB,UAAU,IAAI,OAAO,CAAC;IACtB,gBAAgB,IAAI,OAAO,CAAC;IAC5B,WAAW,IAAI,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,OAAO;IACtB,UAAU,IAAI,MAAM,CAAC;IACrB,cAAc,IAAI,MAAM,CAAC;IACzB,QAAQ,IAAI,GAAG,CAAC;IAChB,gBAAgB,IAAI,MAAM,CAAC;IAC3B,WAAW,IAAI,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,IAAI;IACnB,cAAc,IAAI,MAAM,CAAC;IACzB,eAAe,IAAI,MAAM,CAAC;IAC1B,cAAc,IAAI,MAAM,CAAC;IACzB,SAAS,IAAI,MAAM,GAAG,IAAI,CAAC;IAC3B,WAAW,IAAI,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,UAAU;IACzB,UAAU,IAAI,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,YAAY,IAAI,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACtC,aAAa,IAAI,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IACxC,gBAAgB,IAAI,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAC7C,UAAU,IAAI,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,kBAAkB,IAAI,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAClD,QAAQ,IAAI,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IAC9B,YAAY,IAAI,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACtC,YAAY,IAAI,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACtC,WAAW,IAAI,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,MAAM;IACrB,OAAO,IAAI,MAAM,GAAG,MAAM,EAAE,CAAC;IAC7B,SAAS,IAAI,MAAM,CAAC;IACpB,QAAQ,IAAI,MAAM,CAAC;IACnB,cAAc,IAAI,MAAM,CAAC;IACzB,UAAU,IAAI,GAAG,CAAC;IAClB,OAAO,IAAI,GAAG,EAAE,CAAC;IACjB,WAAW,IAAI,MAAM,EAAE,CAAC;IACxB,aAAa,IAAI,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACrC,QAAQ,IAAI,MAAM,GAAG,IAAI,CAAC;IAC1B,uBAAuB,IAAI,MAAM,GAAG,OAAO,GAAG,IAAI,CAAC;IACnD,UAAU,IAAI,MAAM,GAAG,IAAI,CAAC;IAC5B,UAAU,IAAI,MAAM,GAAG,IAAI,CAAC;IAC5B,YAAY,IAAI,MAAM,GAAG,IAAI,CAAC;IAC9B,YAAY,IAAI,MAAM,GAAG,IAAI,CAAC;IAC9B,WAAW,IAAI,MAAM,GAAG,IAAI,CAAC;IAC7B,WAAW,IAAI,MAAM,GAAG,IAAI,CAAC;IAC7B,UAAU,IAAI,MAAM,CAAC;IACrB,WAAW,IAAI,OAAO,CAAC;IACvB,aAAa,IAAI,OAAO,CAAC;IACzB,QAAQ,IAAI,MAAM,EAAE,CAAC;IACrB,QAAQ,IAAI,MAAM,EAAE,CAAC;IACrB,QAAQ,IAAI,MAAM,EAAE,CAAC;IACrB,MAAM,IAAI,MAAM,GAAG,IAAI,CAAC;IACxB,WAAW,IAAI,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,MAAM;IACrB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,cAAc,IAAI,MAAM,CAAC;IACzB,YAAY,IAAI,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAC5C,WAAW,IAAI,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,OAAO,IAAI,MAAM,EAAE,CAAC;IACpB,cAAc,IAAI,MAAM,CAAC;IACzB,WAAW,IAAI,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,GAAG;IAClB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,cAAc,IAAI,MAAM,CAAC;IACzB,eAAe,IAAI,qBAAqB,GAAG,IAAI,CAAC;IAChD,WAAW,IAAI,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,cAAc,IAAI,MAAM,CAAC;IACzB,WAAW,IAAI,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,cAAc,IAAI,MAAM,CAAC;IACzB,OAAO,IAAI,MAAM,CAAC;IAClB,KAAK,IAAI,MAAM,CAAC;IAChB,SAAS,IAAI,MAAM,CAAC;IACpB,eAAe,IAAI,MAAM,CAAC;IAC1B,QAAQ,IAAI,UAAU,GAAG,IAAI,CAAC;IAC9B,mBAAmB,IAAI,MAAM,CAAC;IAC9B,WAAW,IAAI,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,UAAU;IACzB,WAAW,IAAI,SAAS,GAAG,IAAI,CAAC;IAChC,WAAW,IAAI,SAAS,GAAG,IAAI,CAAC;IAChC,oBAAoB,IAAI,SAAS,GAAG,IAAI,CAAC;IACzC,oBAAoB,IAAI,SAAS,GAAG,IAAI,CAAC;IACzC,WAAW,IAAI,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,SAAS;IACxB,mBAAmB,IAAI,MAAM,CAAC;IAC9B,WAAW,IAAI,MAAM,CAAC;IACtB,aAAa,IAAI,MAAM,CAAC;IACxB,SAAS,IAAI,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,WAAW,IAAI,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,mBAAmB;IAClC,2CAA2C;IAC3C,GAAG,IAAI,gBAAgB,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IAC5C,WAAW,IAAI,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,QAAQ;IACvB,+BAA+B;IAC/B,GAAG,IAAI,gBAAgB,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC5C,WAAW,IAAI,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,UAAU,IAAI,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC,WAAW,IAAI,GAAG,CAAC;CACpB"}

package/dist/document.js

@@ -0,0 +1 @@
+export {};

package/dist/globals.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Global declarations for the custom rules runtime environment.
+ * These are provided by the Go runtime (goja).
+ *
+ * When you import from '@speakeasy-api/openapi-linter-types', the global
+ * `console` object is automatically typed.
+ */
+/**
+ * Console interface for logging from custom rules.
+ * Messages are routed to the configured Logger in Go.
+ *
+ * @example
+ * ```typescript
+ * console.log('Processing operation:', op.getOperationID());
+ * console.warn('Missing recommended field');
+ * console.error('Invalid configuration');
+ * ```
+ */
+export interface Console {
+    /** Log informational messages */
+    log(...args: any[]): void;
+    /** Log warning messages */
+    warn(...args: any[]): void;
+    /** Log error messages */
+    error(...args: any[]): void;
+}
+declare global {
+    /** Console object for logging. Provided by the goja runtime. */
+    var console: Console;
+}
+//# sourceMappingURL=globals.d.ts.map

package/dist/globals.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"globals.d.ts","sourceRoot":"","sources":["../src/globals.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH;;;;;;;;;;GAUG;AACH,MAAM,WAAW,OAAO;IACtB,iCAAiC;IACjC,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IAC1B,2BAA2B;IAC3B,IAAI,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;IAC3B,yBAAyB;IACzB,KAAK,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;CAC7B;AAID,OAAO,CAAC,MAAM,CAAC;IACb,gEAAgE;IAChE,IAAI,OAAO,EAAE,OAAO,CAAC;CACtB"}

package/dist/globals.js

@@ -0,0 +1,8 @@
+/**
+ * Global declarations for the custom rules runtime environment.
+ * These are provided by the Go runtime (goja).
+ *
+ * When you import from '@speakeasy-api/openapi-linter-types', the global
+ * `console` object is automatically typed.
+ */
+export {};

package/dist/index-types.d.ts

@@ -0,0 +1,108 @@
+import type { OpenAPI, Operation, Parameter, Response, RequestBody, Header, Example, Link, Callback, PathItem, SecurityScheme, SecurityRequirement, Server, ServerVariable, Tag, Schema, MediaType, Encoding, ExternalDocumentation, Discriminator } from './document';
+/**
+ * Index provides pre-computed collections of document elements
+ * for efficient rule iteration.
+ *
+ * Note: All field names are lowercased when accessed from JavaScript
+ * due to goja's UncapFieldNameMapper.
+ */
+export interface Index {
+    /** Reference to the root document */
+    readonly doc: OpenAPI;
+    readonly externalDocumentation: IndexNode<ExternalDocumentation>[];
+    readonly tags: IndexNode<Tag>[];
+    readonly servers: IndexNode<Server>[];
+    readonly serverVariables: IndexNode<ServerVariable>[];
+    readonly booleanSchemas: IndexNode<Schema>[];
+    readonly inlineSchemas: IndexNode<Schema>[];
+    readonly componentSchemas: IndexNode<Schema>[];
+    readonly externalSchemas: IndexNode<Schema>[];
+    readonly schemaReferences: IndexNode<Schema>[];
+    readonly inlinePathItems: IndexNode<PathItem>[];
+    readonly componentPathItems: IndexNode<PathItem>[];
+    readonly externalPathItems: IndexNode<PathItem>[];
+    readonly pathItemReferences: IndexNode<PathItem>[];
+    readonly operations: IndexNode<Operation>[];
+    readonly inlineParameters: IndexNode<Parameter>[];
+    readonly componentParameters: IndexNode<Parameter>[];
+    readonly externalParameters: IndexNode<Parameter>[];
+    readonly parameterReferences: IndexNode<Parameter>[];
+    readonly responses: IndexNode<any>[];
+    readonly inlineResponses: IndexNode<Response>[];
+    readonly componentResponses: IndexNode<Response>[];
+    readonly externalResponses: IndexNode<Response>[];
+    readonly responseReferences: IndexNode<Response>[];
+    readonly inlineRequestBodies: IndexNode<RequestBody>[];
+    readonly componentRequestBodies: IndexNode<RequestBody>[];
+    readonly externalRequestBodies: IndexNode<RequestBody>[];
+    readonly requestBodyReferences: IndexNode<RequestBody>[];
+    readonly inlineHeaders: IndexNode<Header>[];
+    readonly componentHeaders: IndexNode<Header>[];
+    readonly externalHeaders: IndexNode<Header>[];
+    readonly headerReferences: IndexNode<Header>[];
+    readonly inlineExamples: IndexNode<Example>[];
+    readonly componentExamples: IndexNode<Example>[];
+    readonly externalExamples: IndexNode<Example>[];
+    readonly exampleReferences: IndexNode<Example>[];
+    readonly inlineLinks: IndexNode<Link>[];
+    readonly componentLinks: IndexNode<Link>[];
+    readonly externalLinks: IndexNode<Link>[];
+    readonly linkReferences: IndexNode<Link>[];
+    readonly inlineCallbacks: IndexNode<Callback>[];
+    readonly componentCallbacks: IndexNode<Callback>[];
+    readonly externalCallbacks: IndexNode<Callback>[];
+    readonly callbackReferences: IndexNode<Callback>[];
+    readonly componentSecuritySchemes: IndexNode<SecurityScheme>[];
+    readonly securitySchemeReferences: IndexNode<SecurityScheme>[];
+    readonly securityRequirements: IndexNode<SecurityRequirement>[];
+    readonly discriminators: IndexNode<Discriminator>[];
+    readonly mediaTypes: IndexNode<MediaType>[];
+    readonly encodings: IndexNode<Encoding>[];
+    readonly descriptionNodes: IndexNode<Descriptioner>[];
+    readonly summaryNodes: IndexNode<Summarizer>[];
+    readonly descriptionAndSummaryNodes: IndexNode<DescriptionAndSummary>[];
+}
+/**
+ * IndexNode wraps a document element with its location.
+ */
+export interface IndexNode<T> {
+    /** The document element */
+    readonly node: T;
+    /** Location path to this element */
+    readonly location: Locations;
+}
+/**
+ * Locations is the path from root to an element.
+ */
+export type Locations = LocationContext[];
+/**
+ * LocationContext represents one level in the path.
+ */
+export interface LocationContext {
+    /** Parent field name (e.g., "paths", "responses") */
+    parentField(): string;
+    /** Parent key if in a map (e.g., "/users/{id}") */
+    parentKey(): string;
+    /** Parent index if in an array */
+    parentIndex(): number;
+    /** Convert to JSON pointer string */
+    toJSONPointer(): string;
+}
+/**
+ * Interface for elements with a description.
+ */
+export interface Descriptioner {
+    getDescription(): string;
+}
+/**
+ * Interface for elements with a summary.
+ */
+export interface Summarizer {
+    getSummary(): string;
+}
+/**
+ * Interface for elements with both description and summary.
+ */
+export interface DescriptionAndSummary extends Descriptioner, Summarizer {
+}
+//# sourceMappingURL=index-types.d.ts.map

package/dist/index-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-types.d.ts","sourceRoot":"","sources":["../src/index-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,OAAO,EACP,SAAS,EACT,SAAS,EACT,QAAQ,EACR,WAAW,EACX,MAAM,EACN,OAAO,EACP,IAAI,EACJ,QAAQ,EACR,QAAQ,EACR,cAAc,EACd,mBAAmB,EACnB,MAAM,EACN,cAAc,EACd,GAAG,EACH,MAAM,EACN,SAAS,EACT,QAAQ,EACR,qBAAqB,EACrB,aAAa,EACd,MAAM,YAAY,CAAC;AAEpB;;;;;;GAMG;AACH,MAAM,WAAW,KAAK;IACpB,qCAAqC;IACrC,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC;IAGtB,QAAQ,CAAC,qBAAqB,EAAE,SAAS,CAAC,qBAAqB,CAAC,EAAE,CAAC;IAGnE,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;IAGhC,QAAQ,CAAC,OAAO,EAAE,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;IACtC,QAAQ,CAAC,eAAe,EAAE,SAAS,CAAC,cAAc,CAAC,EAAE,CAAC;IAGtD,QAAQ,CAAC,cAAc,EAAE,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;IAC7C,QAAQ,CAAC,aAAa,EAAE,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;IAC5C,QAAQ,CAAC,gBAAgB,EAAE,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;IAC/C,QAAQ,CAAC,eAAe,EAAE,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;IAC9C,QAAQ,CAAC,gBAAgB,EAAE,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;IAG/C,QAAQ,CAAC,eAAe,EAAE,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC;IAChD,QAAQ,CAAC,kBAAkB,EAAE,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC;IACnD,QAAQ,CAAC,iBAAiB,EAAE,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC;IAClD,QAAQ,CAAC,kBAAkB,EAAE,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC;IAGnD,QAAQ,CAAC,UAAU,EAAE,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;IAG5C,QAAQ,CAAC,gBAAgB,EAAE,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;IAClD,QAAQ,CAAC,mBAAmB,EAAE,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;IACrD,QAAQ,CAAC,kBAAkB,EAAE,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;IACpD,QAAQ,CAAC,mBAAmB,EAAE,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;IAGrD,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC,GAAG,CAAC,EAAE,CAAC;IACrC,QAAQ,CAAC,eAAe,EAAE,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC;IAChD,QAAQ,CAAC,kBAAkB,EAAE,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC;IACnD,QAAQ,CAAC,iBAAiB,EAAE,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC;IAClD,QAAQ,CAAC,kBAAkB,EAAE,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC;IAGnD,QAAQ,CAAC,mBAAmB,EAAE,SAAS,CAAC,WAAW,CAAC,EAAE,CAAC;IACvD,QAAQ,CAAC,sBAAsB,EAAE,SAAS,CAAC,WAAW,CAAC,EAAE,CAAC;IAC1D,QAAQ,CAAC,qBAAqB,EAAE,SAAS,CAAC,WAAW,CAAC,EAAE,CAAC;IACzD,QAAQ,CAAC,qBAAqB,EAAE,SAAS,CAAC,WAAW,CAAC,EAAE,CAAC;IAGzD,QAAQ,CAAC,aAAa,EAAE,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;IAC5C,QAAQ,CAAC,gBAAgB,EAAE,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;IAC/C,QAAQ,CAAC,eAAe,EAAE,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;IAC9C,QAAQ,CAAC,gBAAgB,EAAE,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;IAG/C,QAAQ,CAAC,cAAc,EAAE,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;IAC9C,QAAQ,CAAC,iBAAiB,EAAE,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;IACjD,QAAQ,CAAC,gBAAgB,EAAE,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;IAChD,QAAQ,CAAC,iBAAiB,EAAE,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;IAGjD,QAAQ,CAAC,WAAW,EAAE,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;IACxC,QAAQ,CAAC,cAAc,EAAE,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;IAC3C,QAAQ,CAAC,aAAa,EAAE,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;IAC1C,QAAQ,CAAC,cAAc,EAAE,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;IAG3C,QAAQ,CAAC,eAAe,EAAE,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC;IAChD,QAAQ,CAAC,kBAAkB,EAAE,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC;IACnD,QAAQ,CAAC,iBAAiB,EAAE,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC;IAClD,QAAQ,CAAC,kBAAkB,EAAE,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC;IAGnD,QAAQ,CAAC,wBAAwB,EAAE,SAAS,CAAC,cAAc,CAAC,EAAE,CAAC;IAC/D,QAAQ,CAAC,wBAAwB,EAAE,SAAS,CAAC,cAAc,CAAC,EAAE,CAAC;IAC/D,QAAQ,CAAC,oBAAoB,EAAE,SAAS,CAAC,mBAAmB,CAAC,EAAE,CAAC;IAGhE,QAAQ,CAAC,cAAc,EAAE,SAAS,CAAC,aAAa,CAAC,EAAE,CAAC;IACpD,QAAQ,CAAC,UAAU,EAAE,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;IAC5C,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC;IAG1C,QAAQ,CAAC,gBAAgB,EAAE,SAAS,CAAC,aAAa,CAAC,EAAE,CAAC;IACtD,QAAQ,CAAC,YAAY,EAAE,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC;IAC/C,QAAQ,CAAC,0BAA0B,EAAE,SAAS,CAAC,qBAAqB,CAAC,EAAE,CAAC;CACzE;AAED;;GAEG;AACH,MAAM,WAAW,SAAS,CAAC,CAAC;IAC1B,2BAA2B;IAC3B,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;IAEjB,oCAAoC;IACpC,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,eAAe,EAAE,CAAC;AAE1C;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,qDAAqD;IACrD,WAAW,IAAI,MAAM,CAAC;IAEtB,mDAAmD;IACnD,SAAS,IAAI,MAAM,CAAC;IAEpB,kCAAkC;IAClC,WAAW,IAAI,MAAM,CAAC;IAEtB,qCAAqC;IACrC,aAAa,IAAI,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,cAAc,IAAI,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,UAAU,IAAI,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,aAAa,EAAE,UAAU;CAAG"}

package/dist/index-types.js

@@ -0,0 +1 @@
+export {};

package/dist/index.d.ts

@@ -0,0 +1,51 @@
+/**
+ * @speakeasy-api/openapi-linter-types
+ *
+ * TypeScript types for writing custom OpenAPI linter rules.
+ *
+ * @example
+ * ```typescript
+ * import { Rule, registerRule, createValidationError } from '@speakeasy-api/openapi-linter-types';
+ * import type { Context, DocumentInfo, RuleConfig, Severity, ValidationError } from '@speakeasy-api/openapi-linter-types';
+ *
+ * class RequireOperationSummary extends Rule {
+ *   id(): string { return 'custom-require-operation-summary'; }
+ *   category(): string { return 'style'; }
+ *   description(): string { return 'All operations must have a summary.'; }
+ *   summary(): string { return 'Operations must have summary'; }
+ *
+ *   run(ctx: Context, docInfo: DocumentInfo, config: RuleConfig): ValidationError[] {
+ *     const errors: ValidationError[] = [];
+ *
+ *     for (const opNode of docInfo.index.operations) {
+ *       const op = opNode.node;
+ *       if (!op.getSummary()) {
+ *         errors.push(createValidationError(
+ *           config.getSeverity(this.defaultSeverity()),
+ *           this.id(),
+ *           'Operation is missing a summary',
+ *           op.getRootNode()
+ *         ));
+ *       }
+ *     }
+ *
+ *     return errors;
+ *   }
+ * }
+ *
+ * registerRule(new RequireOperationSummary());
+ * ```
+ */
+export type { Severity } from './severity';
+export type { Context } from './context';
+export type { RuleConfig } from './config';
+export { Rule, registerRule } from './rule';
+export type { RuleRunner } from './rule';
+export { createValidationError } from './validation';
+export type { ValidationError, YamlNode } from './validation';
+export type { DocumentInfo } from './document';
+export type { OpenAPI, Info, Contact, License, Paths, PathItem, Operation, Parameter, RequestBody, Responses, Response, Header, MediaType, Encoding, Example, Link, Components, Schema, Server, ServerVariable, Tag, ExternalDocumentation, SecurityScheme, OAuthFlows, OAuthFlow, SecurityRequirement, Callback, Discriminator, } from './document';
+export type { Index, IndexNode, Locations, LocationContext, Descriptioner, Summarizer, DescriptionAndSummary, } from './index-types';
+import './globals';
+export type { Console } from './globals';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AAGH,YAAY,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,YAAY,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACzC,YAAY,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAG3C,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAC5C,YAAY,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAGzC,OAAO,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAC;AACrD,YAAY,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAG9D,YAAY,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC/C,YAAY,EACV,OAAO,EACP,IAAI,EACJ,OAAO,EACP,OAAO,EACP,KAAK,EACL,QAAQ,EACR,SAAS,EACT,SAAS,EACT,WAAW,EACX,SAAS,EACT,QAAQ,EACR,MAAM,EACN,SAAS,EACT,QAAQ,EACR,OAAO,EACP,IAAI,EACJ,UAAU,EACV,MAAM,EACN,MAAM,EACN,cAAc,EACd,GAAG,EACH,qBAAqB,EACrB,cAAc,EACd,UAAU,EACV,SAAS,EACT,mBAAmB,EACnB,QAAQ,EACR,aAAa,GACd,MAAM,YAAY,CAAC;AAGpB,YAAY,EACV,KAAK,EACL,SAAS,EACT,SAAS,EACT,eAAe,EACf,aAAa,EACb,UAAU,EACV,qBAAqB,GACtB,MAAM,eAAe,CAAC;AAIvB,OAAO,WAAW,CAAC;AACnB,YAAY,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC"}

package/dist/index.js

@@ -0,0 +1,45 @@
+/**
+ * @speakeasy-api/openapi-linter-types
+ *
+ * TypeScript types for writing custom OpenAPI linter rules.
+ *
+ * @example
+ * ```typescript
+ * import { Rule, registerRule, createValidationError } from '@speakeasy-api/openapi-linter-types';
+ * import type { Context, DocumentInfo, RuleConfig, Severity, ValidationError } from '@speakeasy-api/openapi-linter-types';
+ *
+ * class RequireOperationSummary extends Rule {
+ *   id(): string { return 'custom-require-operation-summary'; }
+ *   category(): string { return 'style'; }
+ *   description(): string { return 'All operations must have a summary.'; }
+ *   summary(): string { return 'Operations must have summary'; }
+ *
+ *   run(ctx: Context, docInfo: DocumentInfo, config: RuleConfig): ValidationError[] {
+ *     const errors: ValidationError[] = [];
+ *
+ *     for (const opNode of docInfo.index.operations) {
+ *       const op = opNode.node;
+ *       if (!op.getSummary()) {
+ *         errors.push(createValidationError(
+ *           config.getSeverity(this.defaultSeverity()),
+ *           this.id(),
+ *           'Operation is missing a summary',
+ *           op.getRootNode()
+ *         ));
+ *       }
+ *     }
+ *
+ *     return errors;
+ *   }
+ * }
+ *
+ * registerRule(new RequireOperationSummary());
+ * ```
+ */
+// Rule interface and base class
+export { Rule, registerRule } from './rule';
+// Validation errors
+export { createValidationError } from './validation';
+// Global runtime types (console, etc.)
+// Import for side effects to register global types
+import './globals';

package/dist/rule.d.ts

@@ -0,0 +1,108 @@
+import type { Context } from './context';
+import type { RuleConfig } from './config';
+import type { DocumentInfo } from './document';
+import type { Severity } from './severity';
+import type { ValidationError } from './validation';
+/**
+ * RuleRunner is the interface that custom rules must implement.
+ */
+export interface RuleRunner {
+    /**
+     * Unique identifier for this rule (e.g., "custom-require-summary").
+     * Should be prefixed with "custom-" to avoid conflicts with built-in rules.
+     */
+    id(): string;
+    /**
+     * Rule category (e.g., "style", "semantic", "security", "schemas").
+     */
+    category(): string;
+    /**
+     * Detailed description of what the rule checks.
+     */
+    description(): string;
+    /**
+     * Short summary of what the rule checks.
+     */
+    summary(): string;
+    /**
+     * Optional URL to documentation for this rule.
+     */
+    link(): string;
+    /**
+     * Default severity level for this rule.
+     */
+    defaultSeverity(): Severity;
+    /**
+     * OpenAPI versions this rule applies to, or null for all versions.
+     * Example: ["3.0", "3.1"] to only run on OpenAPI 3.x documents.
+     */
+    versions(): string[] | null;
+    /**
+     * Execute the rule against the document.
+     *
+     * @param ctx - Context for cancellation checking
+     * @param docInfo - Document information including the parsed document and index
+     * @param config - Rule configuration including severity overrides
+     * @returns Array of validation errors found
+     */
+    run(ctx: Context, docInfo: DocumentInfo, config: RuleConfig): ValidationError[];
+}
+/**
+ * Base class for implementing custom rules.
+ * Provides default implementations for optional methods.
+ *
+ * @example
+ * ```typescript
+ * class RequireOperationSummary extends Rule {
+ *   id(): string { return 'custom-require-operation-summary'; }
+ *   category(): string { return 'style'; }
+ *   description(): string { return 'All operations must have a summary.'; }
+ *   summary(): string { return 'Operations must have summary'; }
+ *
+ *   run(ctx: Context, docInfo: DocumentInfo, config: RuleConfig) {
+ *     const errors: ValidationError[] = [];
+ *     for (const opNode of docInfo.index.operations) {
+ *       const op = opNode.node;
+ *       if (!op.getSummary()) {
+ *         errors.push(createValidationError(
+ *           config.getSeverity(this.defaultSeverity()),
+ *           this.id(),
+ *           'Operation is missing a summary',
+ *           op.getRootNode()
+ *         ));
+ *       }
+ *     }
+ *     return errors;
+ *   }
+ * }
+ *
+ * registerRule(new RequireOperationSummary());
+ * ```
+ */
+export declare abstract class Rule implements RuleRunner {
+    abstract id(): string;
+    abstract category(): string;
+    abstract description(): string;
+    abstract summary(): string;
+    /** Default implementation returns empty string (no documentation link). */
+    link(): string;
+    /** Default implementation returns 'warning'. */
+    defaultSeverity(): Severity;
+    /** Default implementation returns null (applies to all versions). */
+    versions(): string[] | null;
+    abstract run(ctx: Context, docInfo: DocumentInfo, config: RuleConfig): ValidationError[];
+}
+/**
+ * Register a rule with the linter.
+ * Call this at the end of your rule file to make it available.
+ *
+ * @param rule - The rule instance to register
+ *
+ * @example
+ * ```typescript
+ * registerRule(new MyCustomRule());
+ * ```
+ */
+declare function registerRule(rule: RuleRunner): void;
+export { registerRule };
+//# sourceMappingURL=rule.d.ts.map

package/dist/rule.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rule.d.ts","sourceRoot":"","sources":["../src/rule.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC/C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAEpD;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;;OAGG;IACH,EAAE,IAAI,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,IAAI,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,IAAI,MAAM,CAAC;IAEtB;;OAEG;IACH,OAAO,IAAI,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,IAAI,MAAM,CAAC;IAEf;;OAEG;IACH,eAAe,IAAI,QAAQ,CAAC;IAE5B;;;OAGG;IACH,QAAQ,IAAI,MAAM,EAAE,GAAG,IAAI,CAAC;IAE5B;;;;;;;OAOG;IACH,GAAG,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,UAAU,GAAG,eAAe,EAAE,CAAC;CACjF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,8BAAsB,IAAK,YAAW,UAAU;IAC9C,QAAQ,CAAC,EAAE,IAAI,MAAM;IACrB,QAAQ,CAAC,QAAQ,IAAI,MAAM;IAC3B,QAAQ,CAAC,WAAW,IAAI,MAAM;IAC9B,QAAQ,CAAC,OAAO,IAAI,MAAM;IAE1B,2EAA2E;IAC3E,IAAI,IAAI,MAAM;IAId,gDAAgD;IAChD,eAAe,IAAI,QAAQ;IAI3B,qEAAqE;IACrE,QAAQ,IAAI,MAAM,EAAE,GAAG,IAAI;IAI3B,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,UAAU,GAAG,eAAe,EAAE;CACzF;AAED;;;;;;;;;;GAUG;AACH,OAAO,UAAU,YAAY,CAAC,IAAI,EAAE,UAAU,GAAG,IAAI,CAAC;AAEtD,OAAO,EAAE,YAAY,EAAE,CAAC"}

package/dist/rule.js

@@ -0,0 +1,47 @@
+/**
+ * Base class for implementing custom rules.
+ * Provides default implementations for optional methods.
+ *
+ * @example
+ * ```typescript
+ * class RequireOperationSummary extends Rule {
+ *   id(): string { return 'custom-require-operation-summary'; }
+ *   category(): string { return 'style'; }
+ *   description(): string { return 'All operations must have a summary.'; }
+ *   summary(): string { return 'Operations must have summary'; }
+ *
+ *   run(ctx: Context, docInfo: DocumentInfo, config: RuleConfig) {
+ *     const errors: ValidationError[] = [];
+ *     for (const opNode of docInfo.index.operations) {
+ *       const op = opNode.node;
+ *       if (!op.getSummary()) {
+ *         errors.push(createValidationError(
+ *           config.getSeverity(this.defaultSeverity()),
+ *           this.id(),
+ *           'Operation is missing a summary',
+ *           op.getRootNode()
+ *         ));
+ *       }
+ *     }
+ *     return errors;
+ *   }
+ * }
+ *
+ * registerRule(new RequireOperationSummary());
+ * ```
+ */
+export class Rule {
+    /** Default implementation returns empty string (no documentation link). */
+    link() {
+        return '';
+    }
+    /** Default implementation returns 'warning'. */
+    defaultSeverity() {
+        return 'warning';
+    }
+    /** Default implementation returns null (applies to all versions). */
+    versions() {
+        return null;
+    }
+}
+export { registerRule };

package/dist/severity.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Severity levels for validation errors.
+ */
+export type Severity = 'error' | 'warning' | 'hint';
+//# sourceMappingURL=severity.d.ts.map

package/dist/severity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"severity.d.ts","sourceRoot":"","sources":["../src/severity.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC"}

package/dist/severity.js

@@ -0,0 +1 @@
+export {};

package/dist/validation.d.ts

@@ -0,0 +1,55 @@
+import type { Severity } from './severity';
+/**
+ * ValidationError represents a linting error.
+ * Created using createValidationError().
+ */
+export interface ValidationError {
+    /** Error message */
+    error(): string;
+    /** Rule ID that produced this error */
+    rule: string;
+    /** Severity level */
+    severity: Severity;
+    /** Line number (1-indexed) */
+    getLineNumber(): number;
+    /** Column number (1-indexed) */
+    getColumnNumber(): number;
+}
+/**
+ * YamlNode represents a YAML node from the parsed document.
+ * This is the node type returned by getRootNode() methods.
+ */
+export interface YamlNode {
+    /** Node kind (scalar, mapping, sequence, etc.) */
+    kind: number;
+    /** Line number where this node starts (1-indexed) */
+    line: number;
+    /** Column number where this node starts (1-indexed) */
+    column: number;
+    /** Node value for scalar nodes */
+    value?: string;
+    /** Node tag */
+    tag?: string;
+}
+/**
+ * Creates a validation error that can be returned from a rule's run() method.
+ *
+ * @param severity - The error severity ('error', 'warning', or 'hint')
+ * @param ruleId - The rule ID (should match rule.id())
+ * @param message - The error message
+ * @param node - The YAML node where the error occurred (from getRootNode())
+ * @returns A validation error object
+ *
+ * @example
+ * ```typescript
+ * const error = createValidationError(
+ *   'warning',
+ *   this.id(),
+ *   'Operation is missing a summary',
+ *   operation.getRootNode()
+ * );
+ * ```
+ */
+declare function createValidationError(severity: Severity, ruleId: string, message: string, node: YamlNode | null): ValidationError;
+export { createValidationError };
+//# sourceMappingURL=validation.d.ts.map

package/dist/validation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../src/validation.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,oBAAoB;IACpB,KAAK,IAAI,MAAM,CAAC;IAEhB,uCAAuC;IACvC,IAAI,EAAE,MAAM,CAAC;IAEb,qBAAqB;IACrB,QAAQ,EAAE,QAAQ,CAAC;IAEnB,8BAA8B;IAC9B,aAAa,IAAI,MAAM,CAAC;IAExB,gCAAgC;IAChC,eAAe,IAAI,MAAM,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB,kDAAkD;IAClD,IAAI,EAAE,MAAM,CAAC;IAEb,qDAAqD;IACrD,IAAI,EAAE,MAAM,CAAC;IAEb,uDAAuD;IACvD,MAAM,EAAE,MAAM,CAAC;IAEf,kCAAkC;IAClC,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,eAAe;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,OAAO,UAAU,qBAAqB,CACpC,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,QAAQ,GAAG,IAAI,GACpB,eAAe,CAAC;AAEnB,OAAO,EAAE,qBAAqB,EAAE,CAAC"}

package/dist/validation.js

@@ -0,0 +1 @@
+export { createValidationError };

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@speakeasy-api/openapi-linter-types",
+  "version": "0.1.0",
+  "description": "TypeScript types for writing custom OpenAPI linter rules",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build"
+  },
+  "devDependencies": {
+    "typescript": "^5.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/speakeasy-api/openapi.git",
+    "directory": "openapi/linter/customrules/types"
+  },
+  "keywords": [
+    "openapi",
+    "linter",
+    "types",
+    "typescript",
+    "custom-rules"
+  ],
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  }
+}