feat: escape only % symbol

Author: DmitryAnansky

packages/core/src/__tests__/ref-utils.test.ts

@@ -168,13 +168,8 @@ describe('ref-utils', () => {
       expect(escapePointerFragment(123)).toStrictEqual(123);
     });
 
-    it('should URI-encode special characters when escaping pointer fragments per https://datatracker.ietf.org/doc/html/rfc6901#section-6', () => {
+    it('should URI-encode percent sign when escaping pointer fragments', () => {
       expect(escapePointerFragment('percent%')).toStrictEqual('percent%25');
-      expect(escapePointerFragment('caret^')).toStrictEqual('caret%5E');
-      expect(escapePointerFragment('pipe|')).toStrictEqual('pipe%7C');
-      expect(escapePointerFragment('doublebackslash\\\\')).toStrictEqual('doublebackslash%5C');
-      expect(escapePointerFragment('backslash\\')).toStrictEqual('backslash%22');
-      expect(escapePointerFragment('space ')).toStrictEqual('space%20');
     });
 
     it('should not URI-encode other special characters when escaping pointer fragments per https://datatracker.ietf.org/doc/html/rfc6901#section-6', () => {

packages/core/src/ref-utils.ts

@@ -41,23 +41,21 @@ export class Location {
 }
 
 export function unescapePointerFragment(fragment: string): string {
-  return decodeURIComponent(fragment).replaceAll('~1', '/').replaceAll('~0', '~');
+  try {
+    return decodeURIComponent(fragment.replaceAll('~1', '/').replaceAll('~0', '~'));
+  } catch (error) {
+    return fragment.replaceAll('~1', '/').replaceAll('~0', '~');
+  }
 }
 
 export function escapePointerFragment<T extends string | number>(fragment: T): T {
   if (typeof fragment === 'number') return fragment;
-  return encodeURIFragmentIdentifier(fragment.replaceAll('~', '~0').replaceAll('/', '~1')) as T;
-}
-
-// RFC 6901: https://datatracker.ietf.org/doc/html/rfc6901#section-6
-function encodeURIFragmentIdentifier(fragment: string): string {
-  return fragment
-    .replaceAll('%', '%25')
-    .replaceAll('^', '%5E')
-    .replaceAll('|', '%7C')
-    .replaceAll('\\\\', '%5C')
-    .replaceAll('\\', '%22')
-    .replaceAll(' ', '%20');
+  let result: string = fragment;
+  // add only % escape if % is present
+  if (result.includes('%')) {
+    result = result.replaceAll('%', '%25');
+  }
+  return result.replaceAll('~', '~0').replaceAll('/', '~1') as T;
 }
 
 export function parseRef(ref: string): { uri: string | null; pointer: string[] } {

packages/core/src/rules/oas3/__tests__/spec-components-invalid-map-name.test.ts

@@ -43,7 +43,7 @@ describe('Oas3 spec-components-invalid-map-name', () => {
         {
           "location": [
             {
-              "pointer": "#/components/parameters/my%20Param",
+              "pointer": "#/components/parameters/my Param",
               "reportOnKey": true,
               "source": Source {
                 "absoluteRef": "",
@@ -79,7 +79,7 @@ describe('Oas3 spec-components-invalid-map-name', () => {
         {
           "location": [
             {
-              "pointer": "#/components/schemas/first%20schema",
+              "pointer": "#/components/schemas/first schema",
               "reportOnKey": true,
               "source": Source {
                 "absoluteRef": "",
@@ -115,7 +115,7 @@ describe('Oas3 spec-components-invalid-map-name', () => {
         {
           "location": [
             {
-              "pointer": "#/components/responses/400%20status",
+              "pointer": "#/components/responses/400 status",
               "reportOnKey": true,
               "source": Source {
                 "absoluteRef": "",
@@ -151,7 +151,7 @@ describe('Oas3 spec-components-invalid-map-name', () => {
         {
           "location": [
             {
-              "pointer": "#/components/examples/invalid%20identifier",
+              "pointer": "#/components/examples/invalid identifier",
               "reportOnKey": true,
               "source": Source {
                 "absoluteRef": "",
@@ -251,7 +251,7 @@ describe('Oas3 spec-components-invalid-map-name', () => {
         {
           "location": [
             {
-              "pointer": "#/components/parameters/my%20Param",
+              "pointer": "#/components/parameters/my Param",
               "reportOnKey": true,
               "source": Source {
                 "absoluteRef": "",