feat: implement encodePointerUriFragment and consume it in pathToPointer (#122)

Author: P0lip

src/__tests__/bundle.spec.ts

@@ -1021,6 +1021,60 @@ describe('bundleTargetPath()', () => {
     });
   });
 
+  it('should encode pointers', () => {
+    const document = {
+      definitions: {
+        'User Admin': {
+          id: 'foo',
+          address: {
+            $ref: '#/definitions/%25Address',
+          },
+        },
+        '%Address': {
+          street: 'foo',
+          user: {
+            $ref: '#/definitions/user',
+          },
+        },
+        card: {
+          zip: '20815',
+        },
+      },
+      __target__: {
+        entity: {
+          $ref: '#/definitions/User%20Admin',
+        },
+      },
+    };
+
+    const clone = cloneDeep(document);
+
+    const result = bundleTarget({
+      document: clone,
+      path: '#/__target__',
+    });
+
+    expect(result).toEqual({
+      __bundled__: {
+        '%Address': {
+          street: 'foo',
+          user: {
+            $ref: '#/definitions/user',
+          },
+        },
+        'User Admin': {
+          address: {
+            $ref: '#/__bundled__/%25Address',
+          },
+          id: 'foo',
+        },
+      },
+      entity: {
+        $ref: '#/__bundled__/User%20Admin',
+      },
+    });
+  });
+
   describe('when custom keyProvider is provided', () => {
     it('should work', () => {
       const document = {

src/__tests__/pathToPointer.ts

@@ -8,6 +8,10 @@ test('pathToPointer', () => {
   expect(pathToPointer(['paths', 'foo~users'])).toEqual('#/paths/foo~0users');
   expect(pathToPointer([])).toEqual('#');
   expect(pathToPointer([''])).toEqual('#/');
-  expect(pathToPointer(['paths', '/user/{userId}'])).toEqual('#/paths/~1user~1{userId}');
-  expect(pathToPointer(['paths', '/user/{userId}/~foo'])).toEqual('#/paths/~1user~1{userId}~1~0foo');
+  expect(pathToPointer(['paths', '/user/{userId}'])).toEqual('#/paths/~1user~1%7BuserId%7D');
+  expect(pathToPointer(['paths', '/user/{userId}/~foo'])).toEqual('#/paths/~1user~1%7BuserId%7D~1~0foo');
+  expect(pathToPointer(['$defs', 'User Model'])).toEqual('#/%24defs/User%20Model');
+  expect(pathToPointer(['\uD803\uDE6D', 'valid-pair'])).toEqual('#/%F0%90%B9%AD/valid-pair');
+  expect(pathToPointer(['\uD83D', 'unmatched-surrogate'])).toEqual('#/\uD83D/unmatched-surrogate');
+  expect(pathToPointer(['\uD83D', '\uDC00unmatched-surrogate'])).toEqual('#/\uD83D/\uDC00unmatched-surrogate');
 });

src/decodePointerUriFragment.ts

@@ -0,0 +1 @@
+export { decodePointer as decodePointerUriFragment } from './decodePointer';

src/encodePointerUriFragment.ts

@@ -0,0 +1,15 @@
+import { Segment } from '@stoplight/types';
+
+import { encodePointerFragment } from './encodePointerFragment';
+import { encodeUriPointer } from './encodeUriPointer';
+
+/**
+ * Escapes special json pointer characters in a value.
+ * Percent-encode characters.
+ *
+ * @example encodePointer('/paths/~users) => '~1paths~1~0users'
+ */
+export const encodePointerUriFragment = (value: Segment): Segment => {
+  const encoded = encodePointerFragment(value);
+  return typeof encoded === 'number' ? encoded : encodeUriPointer(encoded);
+};

src/encodeUriPointer.ts

@@ -0,0 +1,10 @@
+const ENCODABLE_CHAR = /[^a-zA–Z0–9_.!~*'()\/\-\u{D800}-\u{DFFF}]/gu;
+
+/**
+ * Percent-encode a JSON Pointer.
+ *
+ * encodePointer('paths/users) => '#/paths/~1users'
+ */
+export function encodeUriPointer(pointer: string): string {
+  return pointer.replace(ENCODABLE_CHAR, encodeURIComponent);
+}

src/index.ts

@@ -1,9 +1,12 @@
 export * from './bundle';
 export * from './decodePointer';
 export * from './decodePointerFragment';
+export * from './decodePointerUriFragment';
 export * from './decycle';
 export * from './encodePointer';
 export * from './encodePointerFragment';
+export * from './encodePointerUriFragment';
+export * from './encodeUriPointer';
 export * from './extractPointerFromRef';
 export * from './extractSourceFromRef';
 export * from './getFirstPrimitiveProperty';

src/pathToPointer.ts

@@ -1,6 +1,6 @@
 import { JsonPath } from '@stoplight/types';
 
-import { encodePointerFragment } from './encodePointerFragment';
+import { encodePointerUriFragment } from './encodePointerUriFragment';
 
 export const pathToPointer = (path: JsonPath): string => {
   return encodeUriFragmentIdentifier(path);
@@ -15,5 +15,5 @@ const encodeUriFragmentIdentifier = (path: JsonPath): string => {
     return '#';
   }
 
-  return `#/${path.map(encodePointerFragment).join('/')}`;
+  return `#/${path.map(encodePointerUriFragment).join('/')}`;
 };

src/pointerToPath.ts

@@ -1,6 +1,6 @@
 import { JsonPath } from '@stoplight/types';
 
-import { decodePointer } from './decodePointer';
+import { decodePointerUriFragment } from './decodePointerUriFragment';
 
 export const pointerToPath = (pointer: string): JsonPath => {
   return decodeUriFragmentIdentifier(pointer);
@@ -12,7 +12,7 @@ const decodeFragmentSegments = (segments: string[]): string[] => {
   let i = -1;
 
   while (++i < len) {
-    res.push(decodePointer(segments[i]));
+    res.push(decodePointerUriFragment(segments[i]));
   }
 
   return res;