@openlint/ruleset-spectral-oas 0.0.0-stage → 0.1.0

package/dist/oas/functions/oasSchema.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const json_schema_traverse_1 = tslib_1.__importDefault(require("json-schema-traverse"));
+const openlint_functions_1 = require("@openlint/openlint-functions");
+const openlint_core_1 = require("@openlint/openlint-core");
+const openlint_formats_1 = require("@openlint/openlint-formats");
+const json_1 = require("@stoplight/json");
+function rewriteNullable(schema, errors) {
+    for (const error of errors) {
+        if (error.keyword !== 'type')
+            continue;
+        const value = getSchemaProperty(schema, error.schemaPath);
+        if ((0, json_1.isPlainObject)(value) && value.nullable === true) {
+            error.message += ',null';
+        }
+    }
+}
+exports.default = (0, openlint_core_1.createRulesetFunction)({
+    input: null,
+    options: {
+        type: 'object',
+        properties: {
+            schema: {
+                type: 'object',
+            },
+        },
+        additionalProperties: false,
+    },
+}, function oasSchema(targetVal, opts, context) {
+    var _a;
+    const formats = context.document.formats;
+    let { schema } = opts;
+    let dialect = 'draft4';
+    let prepareResults;
+    if (!formats) {
+        dialect = 'auto';
+    }
+    else if (formats.has(openlint_formats_1.oas3_2) || formats.has(openlint_formats_1.oas3_1)) {
+        if ((0, json_1.isPlainObject)(context.document.data) && typeof context.document.data.jsonSchemaDialect === 'string') {
+            dialect =
+                (_a = (0, openlint_formats_1.extractDraftVersion)(context.document.data.jsonSchemaDialect)) !== null && _a !== void 0 ? _a : 'draft2020-12';
+        }
+        else {
+            dialect = 'draft2020-12';
+        }
+    }
+    else if (formats.has(openlint_formats_1.oas3_0)) {
+        prepareResults = rewriteNullable.bind(null, schema);
+    }
+    else if (formats.has(openlint_formats_1.oas2)) {
+        const clonedSchema = JSON.parse(JSON.stringify(schema));
+        (0, json_schema_traverse_1.default)(clonedSchema, visitOAS2);
+        schema = clonedSchema;
+        prepareResults = rewriteNullable.bind(null, clonedSchema);
+    }
+    return (0, openlint_functions_1.schema)(targetVal, {
+        ...opts,
+        schema,
+        prepareResults,
+        dialect,
+    }, context);
+});
+const visitOAS2 = schema => {
+    if (schema['x-nullable'] === true) {
+        schema.nullable = true;
+        delete schema['x-nullable'];
+    }
+};
+function getSchemaProperty(schema, schemaPath) {
+    const path = (0, json_1.pointerToPath)(schemaPath);
+    let value = schema;
+    for (const fragment of path.slice(0, -1)) {
+        if (!(0, json_1.isPlainObject)(value)) {
+            return;
+        }
+        value = value[fragment];
+    }
+    return value;
+}
+//# sourceMappingURL=oasSchema.js.map

package/dist/oas/functions/oasSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"oasSchema.js","sourceRoot":"","sources":["../../../src/oas/functions/oasSchema.ts"],"names":[],"mappings":";;;AACA,wFAA4C;AAC5C,qEAAiF;AACjF,2DAAgE;AAChE,iEAA+F;AAC/F,0CAA+D;AAM/D,SAAS,eAAe,CAAC,MAAoB,EAAE,MAAqB;IAClE,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,IAAI,KAAK,CAAC,OAAO,KAAK,MAAM;YAAE,SAAS;QACvC,MAAM,KAAK,GAAG,iBAAiB,CAAC,MAAM,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QAC1D,IAAI,IAAA,oBAAa,EAAC,KAAK,CAAC,IAAI,KAAK,CAAC,QAAQ,KAAK,IAAI,EAAE,CAAC;YACpD,KAAK,CAAC,OAAO,IAAI,OAAO,CAAC;QAC3B,CAAC;IACH,CAAC;AACH,CAAC;AAED,kBAAe,IAAA,qCAAqB,EAClC;IACE,KAAK,EAAE,IAAI;IACX,OAAO,EAAE;QACP,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,MAAM,EAAE;gBACN,IAAI,EAAE,QAAQ;aACf;SACF;QACD,oBAAoB,EAAE,KAAK;KAC5B;CACF,EACD,SAAS,SAAS,CAAC,SAAS,EAAE,IAAI,EAAE,OAAO;;IACzC,MAAM,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;IAEzC,IAAI,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;IAEtB,IAAI,OAAO,GAA6B,QAAQ,CAAC;IACjD,IAAI,cAA+C,CAAC;IAEpD,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,GAAG,MAAM,CAAC;IACnB,CAAC;SAAM,IAAI,OAAO,CAAC,GAAG,CAAC,yBAAM,CAAC,IAAI,OAAO,CAAC,GAAG,CAAC,yBAAM,CAAC,EAAE,CAAC;QACtD,IAAI,IAAA,oBAAa,EAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,OAAO,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,iBAAiB,KAAK,QAAQ,EAAE,CAAC;YACxG,OAAO;gBACL,MAAC,IAAA,sCAAmB,EAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,iBAAiB,CAA8B,mCAAI,cAAc,CAAC;QACjH,CAAC;aAAM,CAAC;YACN,OAAO,GAAG,cAAc,CAAC;QAC3B,CAAC;IACH,CAAC;SAAM,IAAI,OAAO,CAAC,GAAG,CAAC,yBAAM,CAAC,EAAE,CAAC;QAC/B,cAAc,GAAG,eAAe,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACtD,CAAC;SAAM,IAAI,OAAO,CAAC,GAAG,CAAC,uBAAI,CAAC,EAAE,CAAC;QAC7B,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAkB,CAAC;QACzE,IAAA,8BAAQ,EAAC,YAAY,EAAE,SAAS,CAAC,CAAC;QAClC,MAAM,GAAG,YAAY,CAAC;QACtB,cAAc,GAAG,eAAe,CAAC,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IAC5D,CAAC;IAED,OAAO,IAAA,2BAAQ,EACb,SAAS,EACT;QACE,GAAG,IAAI;QACP,MAAM;QACN,cAAc;QACd,OAAO;KACR,EACD,OAAO,CACR,CAAC;AACJ,CAAC,CACF,CAAC;AAEF,MAAM,SAAS,GAAsB,MAAM,CAAC,EAAE;IAC5C,IAAI,MAAM,CAAC,YAAY,CAAC,KAAK,IAAI,EAAE,CAAC;QAClC,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;QACvB,OAAO,MAAM,CAAC,YAAY,CAAC,CAAC;IAC9B,CAAC;AACH,CAAC,CAAC;AAEF,SAAS,iBAAiB,CAAC,MAAoB,EAAE,UAAkB;IACjE,MAAM,IAAI,GAAG,IAAA,oBAAa,EAAC,UAAU,CAAC,CAAC;IACvC,IAAI,KAAK,GAAY,MAAM,CAAC;IAE5B,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACzC,IAAI,CAAC,IAAA,oBAAa,EAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,OAAO;QACT,CAAC;QAED,KAAK,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC1B,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/oas/functions/oasSecurityDefined.d.ts

@@ -0,0 +1,5 @@
+type Options = {
+    oasVersion: 2 | 3;
+};
+declare const _default: import("@openlint/openlint-core").RulesetFunctionWithValidator<Record<string, string[]>, Options>;
+export default _default;

package/dist/oas/functions/oasSecurityDefined.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const openlint_core_1 = require("@openlint/openlint-core");
+const json_1 = require("@stoplight/json");
+exports.default = (0, openlint_core_1.createRulesetFunction)({
+    input: {
+        type: 'object',
+        additionalProperties: {
+            type: 'array',
+            items: {
+                type: 'string',
+            },
+        },
+    },
+    options: {
+        type: 'object',
+        properties: {
+            oasVersion: {
+                enum: [2, 3],
+            },
+        },
+        additionalProperties: false,
+    },
+}, function oasSecurityDefined(input, { oasVersion }, { document, path }) {
+    const schemeNames = Object.keys(input);
+    if (schemeNames.length === 0)
+        return;
+    if (!(0, json_1.isPlainObject)(document.data))
+        return;
+    const allDefs = oasVersion === 2
+        ? document.data.securityDefinitions
+        : (0, json_1.isPlainObject)(document.data.components)
+            ? document.data.components.securitySchemes
+            : null;
+    let results;
+    for (const schemeName of schemeNames) {
+        if (!(0, json_1.isPlainObject)(allDefs) || !(schemeName in allDefs)) {
+            const object = path.length == 2 ? 'API' : 'Operation';
+            const location = oasVersion === 2 ? 'securityDefinitions' : 'components.securitySchemes';
+            results !== null && results !== void 0 ? results : (results = []);
+            results.push({
+                message: `${object} "security" values must match a scheme defined in the "${location}" object.`,
+                path: [...path, schemeName],
+            });
+            continue;
+        }
+        const scope = input[schemeName];
+        for (let i = 0; i < scope.length; i++) {
+            const scopeName = scope[i];
+            if (!isScopeDefined(oasVersion, scopeName, allDefs[schemeName])) {
+                results !== null && results !== void 0 ? results : (results = []);
+                results.push({
+                    message: `"${scopeName}" must be listed among scopes.`,
+                    path: [...path, schemeName, i],
+                });
+            }
+        }
+    }
+    return results;
+});
+function isScopeDefined(oasVersion, scopeName, securityScheme) {
+    if (!(0, json_1.isPlainObject)(securityScheme))
+        return false;
+    if (oasVersion === 2) {
+        return (0, json_1.isPlainObject)(securityScheme.scopes) && scopeName in securityScheme.scopes;
+    }
+    if ((0, json_1.isPlainObject)(securityScheme.flows)) {
+        for (const flow of Object.values(securityScheme.flows)) {
+            if ((0, json_1.isPlainObject)(flow) && (0, json_1.isPlainObject)(flow.scopes) && scopeName in flow.scopes) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+//# sourceMappingURL=oasSecurityDefined.js.map

package/dist/oas/functions/oasSecurityDefined.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"oasSecurityDefined.js","sourceRoot":"","sources":["../../../src/oas/functions/oasSecurityDefined.ts"],"names":[],"mappings":";;AAAA,2DAAgE;AAEhE,0CAAgD;AAMhD,kBAAe,IAAA,qCAAqB,EAClC;IACE,KAAK,EAAE;QACL,IAAI,EAAE,QAAQ;QACd,oBAAoB,EAAE;YACpB,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;aACf;SACF;KACF;IACD,OAAO,EAAE;QACP,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,UAAU,EAAE;gBACV,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;aACb;SACF;QACD,oBAAoB,EAAE,KAAK;KAC5B;CACF,EACD,SAAS,kBAAkB,CAAC,KAAK,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE;IACnE,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACvC,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO;IAErC,IAAI,CAAC,IAAA,oBAAa,EAAC,QAAQ,CAAC,IAAI,CAAC;QAAE,OAAO;IAE1C,MAAM,OAAO,GACX,UAAU,KAAK,CAAC;QACd,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,mBAAmB;QACnC,CAAC,CAAC,IAAA,oBAAa,EAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC;YACvC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,eAAe;YAC1C,CAAC,CAAC,IAAI,CAAC;IAEb,IAAI,OAAsC,CAAC;IAE3C,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;QACrC,IAAI,CAAC,IAAA,oBAAa,EAAC,OAAO,CAAC,IAAI,CAAC,CAAC,UAAU,IAAI,OAAO,CAAC,EAAE,CAAC;YACxD,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC;YACtD,MAAM,QAAQ,GAAG,UAAU,KAAK,CAAC,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,4BAA4B,CAAC;YACzF,OAAO,aAAP,OAAO,cAAP,OAAO,IAAP,OAAO,GAAK,EAAE,EAAC;YACf,OAAO,CAAC,IAAI,CAAC;gBACX,OAAO,EAAE,GAAG,MAAM,0DAA0D,QAAQ,WAAW;gBAC/F,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC;aAC5B,CAAC,CAAC;YAEH,SAAS;QACX,CAAC;QAED,MAAM,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;QAChC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACtC,MAAM,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YAC3B,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE,SAAS,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC;gBAChE,OAAO,aAAP,OAAO,cAAP,OAAO,IAAP,OAAO,GAAK,EAAE,EAAC;gBACf,OAAO,CAAC,IAAI,CAAC;oBACX,OAAO,EAAE,IAAI,SAAS,gCAAgC;oBACtD,IAAI,EAAE,CAAC,GAAG,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;iBAC/B,CAAC,CAAC;YACL,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC,CACF,CAAC;AAEF,SAAS,cAAc,CAAC,UAAiB,EAAE,SAAiB,EAAE,cAAuB;IACnF,IAAI,CAAC,IAAA,oBAAa,EAAC,cAAc,CAAC;QAAE,OAAO,KAAK,CAAC;IAEjD,IAAI,UAAU,KAAK,CAAC,EAAE,CAAC;QACrB,OAAO,IAAA,oBAAa,EAAC,cAAc,CAAC,MAAM,CAAC,IAAI,SAAS,IAAI,cAAc,CAAC,MAAM,CAAC;IACpF,CAAC;IAED,IAAI,IAAA,oBAAa,EAAC,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;QACxC,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;YACvD,IAAI,IAAA,oBAAa,EAAC,IAAI,CAAC,IAAI,IAAA,oBAAa,EAAC,IAAI,CAAC,MAAM,CAAC,IAAI,SAAS,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;gBAClF,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/oas/functions/oasTagDefined.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@openlint/openlint-core").RulesetFunctionWithValidator<Record<string, unknown>, null>;
+export default _default;

package/dist/oas/functions/oasTagDefined.js

@@ -0,0 +1,42 @@
+"use strict";
+// This function will check an API doc to verify that any tag that appears on
+// an operation is also present in the global tags array.
+Object.defineProperty(exports, "__esModule", { value: true });
+const openlint_core_1 = require("@openlint/openlint-core");
+const getAllOperations_1 = require("./utils/getAllOperations");
+const isObject_1 = require("./utils/isObject");
+exports.default = (0, openlint_core_1.createRulesetFunction)({
+    input: {
+        type: 'object',
+    },
+    options: null,
+}, function oasTagDefined(targetVal) {
+    const results = [];
+    const globalTags = [];
+    if (Array.isArray(targetVal.tags)) {
+        for (const tag of targetVal.tags) {
+            if ((0, isObject_1.isObject)(tag) && typeof tag.name === 'string') {
+                globalTags.push(tag.name);
+            }
+        }
+    }
+    const { paths } = targetVal;
+    for (const { path, operation, value } of (0, getAllOperations_1.getAllOperations)(paths)) {
+        if (!(0, isObject_1.isObject)(value))
+            continue;
+        const { tags } = value;
+        if (!Array.isArray(tags)) {
+            continue;
+        }
+        for (const [i, tag] of tags.entries()) {
+            if (!globalTags.includes(tag)) {
+                results.push({
+                    message: 'Operation tags must be defined in global tags.',
+                    path: ['paths', path, operation, 'tags', i],
+                });
+            }
+        }
+    }
+    return results;
+});
+//# sourceMappingURL=oasTagDefined.js.map

package/dist/oas/functions/oasTagDefined.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"oasTagDefined.js","sourceRoot":"","sources":["../../../src/oas/functions/oasTagDefined.ts"],"names":[],"mappings":";AAAA,6EAA6E;AAC7E,yDAAyD;;AAGzD,2DAAgE;AAChE,+DAA4D;AAC5D,+CAA4C;AAE5C,kBAAe,IAAA,qCAAqB,EAClC;IACE,KAAK,EAAE;QACL,IAAI,EAAE,QAAQ;KACf;IACD,OAAO,EAAE,IAAI;CACd,EACD,SAAS,aAAa,CAAC,SAAS;IAC9B,MAAM,OAAO,GAAsB,EAAE,CAAC;IAEtC,MAAM,UAAU,GAAa,EAAE,CAAC;IAEhC,IAAI,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC;QAClC,KAAK,MAAM,GAAG,IAAI,SAAS,CAAC,IAAI,EAAE,CAAC;YACjC,IAAI,IAAA,mBAAQ,EAAC,GAAG,CAAC,IAAI,OAAO,GAAG,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAClD,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAC5B,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,EAAE,KAAK,EAAE,GAAG,SAAS,CAAC;IAE5B,KAAK,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,IAAI,IAAA,mCAAgB,EAAC,KAAK,CAAC,EAAE,CAAC;QACjE,IAAI,CAAC,IAAA,mBAAQ,EAAC,KAAK,CAAC;YAAE,SAAS;QAE/B,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;QAEvB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YACzB,SAAS;QACX,CAAC;QAED,KAAK,MAAM,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;YACtC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC9B,OAAO,CAAC,IAAI,CAAC;oBACX,OAAO,EAAE,gDAAgD;oBACzD,IAAI,EAAE,CAAC,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,CAAC;iBAC5C,CAAC,CAAC;YACL,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC,CACF,CAAC"}

package/dist/oas/functions/oasUnusedComponent.d.ts

@@ -0,0 +1,4 @@
+declare const _default: import("@openlint/openlint-core").RulesetFunctionWithValidator<{
+    components: Record<string, unknown>;
+}, null>;
+export default _default;

package/dist/oas/functions/oasUnusedComponent.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const openlint_functions_1 = require("@openlint/openlint-functions");
+const openlint_core_1 = require("@openlint/openlint-core");
+const isObject_1 = require("./utils/isObject");
+exports.default = (0, openlint_core_1.createRulesetFunction)({
+    input: {
+        type: 'object',
+        properties: {
+            components: {
+                type: 'object',
+            },
+        },
+        required: ['components'],
+    },
+    options: null,
+}, function oasUnusedComponent(targetVal, opts, context) {
+    const results = [];
+    const componentTypes = [
+        'schemas',
+        'responses',
+        'parameters',
+        'examples',
+        'requestBodies',
+        'headers',
+        'links',
+        'callbacks',
+    ];
+    for (const type of componentTypes) {
+        const value = targetVal.components[type];
+        if (!(0, isObject_1.isObject)(value))
+            continue;
+        const resultsForType = (0, openlint_functions_1.unreferencedReusableObject)(value, { reusableObjectsLocation: `#/components/${type}` }, context);
+        if (resultsForType !== void 0 && Array.isArray(resultsForType)) {
+            results.push(...resultsForType);
+        }
+    }
+    return results;
+});
+//# sourceMappingURL=oasUnusedComponent.js.map

package/dist/oas/functions/oasUnusedComponent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"oasUnusedComponent.js","sourceRoot":"","sources":["../../../src/oas/functions/oasUnusedComponent.ts"],"names":[],"mappings":";;AAAA,qEAA0E;AAC1E,2DAAiF;AACjF,+CAA4C;AAE5C,kBAAe,IAAA,qCAAqB,EAClC;IACE,KAAK,EAAE;QACL,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,UAAU,EAAE;gBACV,IAAI,EAAE,QAAQ;aACf;SACF;QACD,QAAQ,EAAE,CAAC,YAAY,CAAC;KACzB;IACD,OAAO,EAAE,IAAI;CACd,EACD,SAAS,kBAAkB,CAAC,SAAS,EAAE,IAAI,EAAE,OAAO;IAClD,MAAM,OAAO,GAAsB,EAAE,CAAC;IACtC,MAAM,cAAc,GAAG;QACrB,SAAS;QACT,WAAW;QACX,YAAY;QACZ,UAAU;QACV,eAAe;QACf,SAAS;QACT,OAAO;QACP,WAAW;KACZ,CAAC;IAEF,KAAK,MAAM,IAAI,IAAI,cAAc,EAAE,CAAC;QAClC,MAAM,KAAK,GAAG,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACzC,IAAI,CAAC,IAAA,mBAAQ,EAAC,KAAK,CAAC;YAAE,SAAS;QAE/B,MAAM,cAAc,GAAG,IAAA,+CAA0B,EAC/C,KAAK,EACL,EAAE,uBAAuB,EAAE,gBAAgB,IAAI,EAAE,EAAE,EACnD,OAAO,CACR,CAAC;QACF,IAAI,cAAc,KAAK,KAAK,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC;YAC/D,OAAO,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC,CACF,CAAC"}

package/dist/oas/functions/refSiblings.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("@openlint/openlint-core").RulesetFunctionWithValidator<unknown, null>;
+export default _default;

package/dist/oas/functions/refSiblings.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const openlint_core_1 = require("@openlint/openlint-core");
+const isObject_1 = require("./utils/isObject");
+function getParentValue(document, path) {
+    if (path.length === 0) {
+        return null;
+    }
+    let piece = document;
+    for (let i = 0; i < path.length - 1; i += 1) {
+        if (!(0, isObject_1.isObject)(piece)) {
+            return null;
+        }
+        piece = piece[path[i]];
+    }
+    return piece;
+}
+exports.default = (0, openlint_core_1.createRulesetFunction)({
+    input: null,
+    options: null,
+}, function refSiblings(targetVal, opts, { document, path }) {
+    const value = getParentValue(document.data, path);
+    if (!(0, isObject_1.isObject)(value))
+        return;
+    const keys = Object.keys(value);
+    if (keys.length === 1) {
+        return;
+    }
+    const results = [];
+    const actualObjPath = path.slice(0, -1);
+    for (const key of keys) {
+        if (key === '$ref') {
+            continue;
+        }
+        results.push({
+            message: '$ref must not be placed next to any other properties',
+            path: [...actualObjPath, key],
+        });
+    }
+    return results;
+});
+//# sourceMappingURL=refSiblings.js.map

package/dist/oas/functions/refSiblings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"refSiblings.js","sourceRoot":"","sources":["../../../src/oas/functions/refSiblings.ts"],"names":[],"mappings":";;AAAA,2DAAgE;AAGhE,+CAA4C;AAE5C,SAAS,cAAc,CAAC,QAAiB,EAAE,IAAc;IACvD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,KAAK,GAAG,QAAQ,CAAC;IAErB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;QAC5C,IAAI,CAAC,IAAA,mBAAQ,EAAC,KAAK,CAAC,EAAE,CAAC;YACrB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IACzB,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,kBAAe,IAAA,qCAAqB,EAClC;IACE,KAAK,EAAE,IAAI;IACX,OAAO,EAAE,IAAI;CACd,EACD,SAAS,WAAW,CAAC,SAAS,EAAE,IAAI,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE;IACtD,MAAM,KAAK,GAAG,cAAc,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAClD,IAAI,CAAC,IAAA,mBAAQ,EAAC,KAAK,CAAC;QAAE,OAAO;IAE7B,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAChC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,OAAO;IACT,CAAC;IAED,MAAM,OAAO,GAAsB,EAAE,CAAC;IACtC,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAExC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IAAI,GAAG,KAAK,MAAM,EAAE,CAAC;YACnB,SAAS;QACX,CAAC;QACD,OAAO,CAAC,IAAI,CAAC;YACX,OAAO,EAAE,sDAAsD;YAC/D,IAAI,EAAE,CAAC,GAAG,aAAa,EAAE,GAAG,CAAC;SAC9B,CAAC,CAAC;IACL,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC,CACF,CAAC"}

package/dist/oas/functions/typedEnum.d.ts

@@ -0,0 +1,7 @@
+type Input = {
+    enum: unknown[];
+    type: string[] | string;
+    [key: string]: unknown;
+};
+declare const _default: import("@openlint/openlint-core").RulesetFunctionWithValidator<Input, null>;
+export default _default;

package/dist/oas/functions/typedEnum.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const openlint_formats_1 = require("@openlint/openlint-formats");
+const openlint_runtime_1 = require("@openlint/openlint-runtime");
+const openlint_core_1 = require("@openlint/openlint-core");
+function getDataType(input, checkForInteger) {
+    const type = typeof input;
+    switch (type) {
+        case 'string':
+        case 'boolean':
+            return type;
+        case 'number':
+            if (checkForInteger && Number.isInteger(input)) {
+                return 'integer';
+            }
+            return 'number';
+        case 'object':
+            if (input === null) {
+                return 'null';
+            }
+            return Array.isArray(input) ? 'array' : 'object';
+        default:
+            throw TypeError('Unknown input type');
+    }
+}
+function getTypes(input, formats) {
+    const { type } = input;
+    if ((input.nullable === true && (formats === null || formats === void 0 ? void 0 : formats.has(openlint_formats_1.oas3_0)) === true) ||
+        (input['x-nullable'] === true && (formats === null || formats === void 0 ? void 0 : formats.has(openlint_formats_1.oas2)) === true)) {
+        return Array.isArray(type) ? [...type, 'null'] : [type, 'null'];
+    }
+    return type;
+}
+exports.default = (0, openlint_core_1.createRulesetFunction)({
+    input: {
+        type: 'object',
+        properties: {
+            enum: {
+                type: 'array',
+            },
+            type: {
+                oneOf: [
+                    {
+                        type: 'array',
+                        items: {
+                            type: 'string',
+                        },
+                    },
+                    {
+                        type: 'string',
+                    },
+                ],
+            },
+        },
+        required: ['enum', 'type'],
+    },
+    options: null,
+}, function typedEnum(input, opts, context) {
+    const { enum: enumValues } = input;
+    const type = getTypes(input, context.document.formats);
+    const checkForInteger = type === 'integer' || (Array.isArray(type) && type.includes('integer'));
+    let results;
+    enumValues.forEach((value, i) => {
+        const valueType = getDataType(value, checkForInteger);
+        if (valueType === type || (Array.isArray(type) && type.includes(valueType))) {
+            return;
+        }
+        results !== null && results !== void 0 ? results : (results = []);
+        results.push({
+            message: `Enum value ${(0, openlint_runtime_1.printValue)(enumValues[i])} must be "${String(type)}".`,
+            path: [...context.path, 'enum', i],
+        });
+    });
+    return results;
+});
+//# sourceMappingURL=typedEnum.js.map

package/dist/oas/functions/typedEnum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typedEnum.js","sourceRoot":"","sources":["../../../src/oas/functions/typedEnum.ts"],"names":[],"mappings":";;AAAA,iEAA0D;AAC1D,iEAAwD;AACxD,2DAA2F;AAG3F,SAAS,WAAW,CAClB,KAAc,EACd,eAAwB;IAExB,MAAM,IAAI,GAAG,OAAO,KAAK,CAAC;IAC1B,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,QAAQ,CAAC;QACd,KAAK,SAAS;YACZ,OAAO,IAAI,CAAC;QACd,KAAK,QAAQ;YACX,IAAI,eAAe,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC/C,OAAO,SAAS,CAAC;YACnB,CAAC;YAED,OAAO,QAAQ,CAAC;QAClB,KAAK,QAAQ;YACX,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;gBACnB,OAAO,MAAM,CAAC;YAChB,CAAC;YAED,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC;QACnD;YACE,MAAM,SAAS,CAAC,oBAAoB,CAAC,CAAC;IAC1C,CAAC;AACH,CAAC;AAQD,SAAS,QAAQ,CAAC,KAAY,EAAE,OAA4B;IAC1D,MAAM,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;IAEvB,IACE,CAAC,KAAK,CAAC,QAAQ,KAAK,IAAI,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,GAAG,CAAC,yBAAM,CAAC,MAAK,IAAI,CAAC;QAC1D,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK,IAAI,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,GAAG,CAAC,uBAAI,CAAC,MAAK,IAAI,CAAC,EAC7D,CAAC;QACD,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAClE,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED,kBAAe,IAAA,qCAAqB,EAClC;IACE,KAAK,EAAE;QACL,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,IAAI,EAAE;gBACJ,IAAI,EAAE,OAAO;aACd;YACD,IAAI,EAAE;gBACJ,KAAK,EAAE;oBACL;wBACE,IAAI,EAAE,OAAO;wBACb,KAAK,EAAE;4BACL,IAAI,EAAE,QAAQ;yBACf;qBACF;oBACD;wBACE,IAAI,EAAE,QAAQ;qBACf;iBACF;aACF;SACF;QACD,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC;KAC3B;IACD,OAAO,EAAE,IAAI;CACd,EACD,SAAS,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO;IACrC,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,KAAK,CAAC;IACnC,MAAM,IAAI,GAAG,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;IACvD,MAAM,eAAe,GAAG,IAAI,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;IAEhG,IAAI,OAAsC,CAAC;IAE3C,UAAU,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE;QAC9B,MAAM,SAAS,GAAG,WAAW,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC;QAEtD,IAAI,SAAS,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;YAC5E,OAAO;QACT,CAAC;QAED,OAAO,aAAP,OAAO,cAAP,OAAO,IAAP,OAAO,GAAK,EAAE,EAAC;QACf,OAAO,CAAC,IAAI,CAAC;YACX,OAAO,EAAE,cAAc,IAAA,6BAAU,EAAC,UAAU,CAAC,CAAC,CAAC,CAAC,aAAa,MAAM,CAAC,IAAI,CAAC,IAAI;YAC7E,IAAI,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;SACnC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,OAAO,OAAO,CAAC;AACjB,CAAC,CACF,CAAC"}

package/dist/oas/functions/utils/getAllOperations.d.ts

@@ -0,0 +1,7 @@
+type Item = {
+    path: string;
+    operation: string;
+    value: unknown;
+};
+export declare function getAllOperations(paths: unknown): IterableIterator<Item>;
+export {};

package/dist/oas/functions/utils/getAllOperations.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAllOperations = getAllOperations;
+const json_1 = require("@stoplight/json");
+const validOperationKeys = ['get', 'head', 'post', 'put', 'patch', 'delete', 'options', 'trace'];
+function* getAllOperations(paths) {
+    if (!(0, json_1.isPlainObject)(paths)) {
+        return;
+    }
+    const item = {
+        path: '',
+        operation: '',
+        value: null,
+    };
+    for (const path of Object.keys(paths)) {
+        const operations = paths[path];
+        if (!(0, json_1.isPlainObject)(operations)) {
+            continue;
+        }
+        item.path = path;
+        for (const operation of Object.keys(operations)) {
+            if (!(0, json_1.isPlainObject)(operations[operation]) || !validOperationKeys.includes(operation)) {
+                continue;
+            }
+            item.operation = operation;
+            item.value = operations[operation];
+            yield item;
+        }
+    }
+}
+//# sourceMappingURL=getAllOperations.js.map

package/dist/oas/functions/utils/getAllOperations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getAllOperations.js","sourceRoot":"","sources":["../../../../src/oas/functions/utils/getAllOperations.ts"],"names":[],"mappings":";;AAMA,4CA8BC;AApCD,0CAAgD;AAEhD,MAAM,kBAAkB,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;AAIjG,QAAe,CAAC,CAAC,gBAAgB,CAAC,KAAc;IAC9C,IAAI,CAAC,IAAA,oBAAa,EAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO;IACT,CAAC;IAED,MAAM,IAAI,GAAS;QACjB,IAAI,EAAE,EAAE;QACR,SAAS,EAAE,EAAE;QACb,KAAK,EAAE,IAAI;KACZ,CAAC;IAEF,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACtC,MAAM,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;QAC/B,IAAI,CAAC,IAAA,oBAAa,EAAC,UAAU,CAAC,EAAE,CAAC;YAC/B,SAAS;QACX,CAAC;QAED,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QAEjB,KAAK,MAAM,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YAChD,IAAI,CAAC,IAAA,oBAAa,EAAC,UAAU,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;gBACrF,SAAS;YACX,CAAC;YAED,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;YAC3B,IAAI,CAAC,KAAK,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC;YAEnC,MAAM,IAAI,CAAC;QACb,CAAC;IACH,CAAC;AACH,CAAC"}

package/dist/oas/functions/utils/isObject.d.ts

@@ -0,0 +1,2 @@
+import type { Dictionary } from '@stoplight/types';
+export declare function isObject(value: unknown): value is Dictionary<unknown>;

package/dist/oas/functions/utils/isObject.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isObject = isObject;
+function isObject(value) {
+    return value !== null && typeof value === 'object';
+}
+//# sourceMappingURL=isObject.js.map

package/dist/oas/functions/utils/isObject.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"isObject.js","sourceRoot":"","sources":["../../../../src/oas/functions/utils/isObject.ts"],"names":[],"mappings":";;AAEA,4BAEC;AAFD,SAAgB,QAAQ,CAAC,KAAc;IACrC,OAAO,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC;AACrD,CAAC"}