@apibara/protocol 0.4.7 → 0.4.8

package/dist/cursor.d.ts

@@ -15,8 +15,21 @@ export declare const Cursor: {
      * been invalidated.
      */
     create: (order: string | number | Long, unique: Uint8Array) => ICursor;
+    /**
+     * Creates a new cursor from a plain Javascript object.
+     */
+    fromObject({ orderKey, uniqueKey }: ReturnType<typeof _toObject>): ICursor;
     /**
      * Returns the cursor string representation.
      */
     toString: (cursor?: ICursor | null) => string | undefined;
+    /**
+     * Returns the cursor as plain Javascript object.
+     */
+    toObject: (cursor?: ICursor | null) => ReturnType<typeof _toObject> | undefined;
+};
+declare function _toObject(cursor: ICursor): {
+    orderKey: string;
+    uniqueKey: string;
 };
+export {};

package/dist/cursor.js

@@ -30,14 +30,38 @@ exports.Cursor = {
             uniqueKey: unique,
         };
     },
+    /**
+     * Creates a new cursor from a plain Javascript object.
+     */
+    fromObject({ orderKey, uniqueKey }) {
+        return {
+            orderKey: long_1.default.fromString(orderKey),
+            uniqueKey: Buffer.from(uniqueKey.slice(2), 'hex'),
+        };
+    },
     /**
      * Returns the cursor string representation.
      */
     toString: (cursor) => {
         if (!cursor)
             return;
-        let hash = Buffer.from(cursor.uniqueKey).toString('hex');
-        return `${cursor.orderKey.toString()}/0x${hash}`;
+        const { orderKey, uniqueKey } = _toObject(cursor);
+        return `${orderKey}/${uniqueKey}`;
+    },
+    /**
+     * Returns the cursor as plain Javascript object.
+     */
+    toObject: (cursor) => {
+        if (!cursor)
+            return;
+        return _toObject(cursor);
     },
 };
+function _toObject(cursor) {
+    let hash = Buffer.from(cursor.uniqueKey).toString('hex');
+    return {
+        orderKey: cursor.orderKey.toString(),
+        uniqueKey: `0x${hash}`,
+    };
+}
 //# sourceMappingURL=cursor.js.map

package/dist/cursor.js.map

@@ -1 +1 @@
-{"version":3,"file":"cursor.js","sourceRoot":"","sources":["../src/cursor.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAuB;AAGV,QAAA,MAAM,GAAG;IACpB;;;;;OAKG;IACH,kBAAkB,EAAE,CAAC,KAA6B,EAAW,EAAE;QAC7D,OAAO;YACL,QAAQ,EAAE,cAAI,CAAC,SAAS,CAAC,KAAK,CAAC;YAC/B,SAAS,EAAE,IAAI,UAAU,EAAE;SAC5B,CAAA;IACH,CAAC;IAED;;;;;OAKG;IACH,MAAM,EAAE,CAAC,KAA6B,EAAE,MAAkB,EAAW,EAAE;QACrE,OAAO;YACL,QAAQ,EAAE,cAAI,CAAC,SAAS,CAAC,KAAK,CAAC;YAC/B,SAAS,EAAE,MAAM;SAClB,CAAA;IACH,CAAC;IAED;;OAEG;IACH,QAAQ,EAAE,CAAC,MAAuB,EAAsB,EAAE;QACxD,IAAI,CAAC,MAAM;YAAE,OAAM;QACnB,IAAI,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;QACxD,OAAO,GAAG,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,IAAI,EAAE,CAAA;IAClD,CAAC;CACF,CAAA"}
+{"version":3,"file":"cursor.js","sourceRoot":"","sources":["../src/cursor.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAuB;AAGV,QAAA,MAAM,GAAG;IACpB;;;;;OAKG;IACH,kBAAkB,EAAE,CAAC,KAA6B,EAAW,EAAE;QAC7D,OAAO;YACL,QAAQ,EAAE,cAAI,CAAC,SAAS,CAAC,KAAK,CAAC;YAC/B,SAAS,EAAE,IAAI,UAAU,EAAE;SAC5B,CAAA;IACH,CAAC;IAED;;;;;OAKG;IACH,MAAM,EAAE,CAAC,KAA6B,EAAE,MAAkB,EAAW,EAAE;QACrE,OAAO;YACL,QAAQ,EAAE,cAAI,CAAC,SAAS,CAAC,KAAK,CAAC;YAC/B,SAAS,EAAE,MAAM;SAClB,CAAA;IACH,CAAC;IAED;;OAEG;IACH,UAAU,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAgC;QAC9D,OAAO;YACL,QAAQ,EAAE,cAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;YACnC,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC;SAClD,CAAA;IACH,CAAC;IAED;;OAEG;IACH,QAAQ,EAAE,CAAC,MAAuB,EAAsB,EAAE;QACxD,IAAI,CAAC,MAAM;YAAE,OAAM;QACnB,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,SAAS,CAAC,MAAM,CAAC,CAAA;QACjD,OAAO,GAAG,QAAQ,IAAI,SAAS,EAAE,CAAA;IACnC,CAAC;IAED;;OAEG;IACH,QAAQ,EAAE,CAAC,MAAuB,EAA4C,EAAE;QAC9E,IAAI,CAAC,MAAM;YAAE,OAAM;QACnB,OAAO,SAAS,CAAC,MAAM,CAAC,CAAA;IAC1B,CAAC;CACF,CAAA;AAED,SAAS,SAAS,CAAC,MAAe;IAChC,IAAI,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;IACxD,OAAO;QACL,QAAQ,EAAE,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE;QACpC,SAAS,EAAE,KAAK,IAAI,EAAE;KACvB,CAAA;AACH,CAAC"}

package/dist/cursor.test.d.ts

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

package/dist/cursor.test.js

@@ -0,0 +1,22 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const long_1 = __importDefault(require("long"));
+const cursor_1 = require("./cursor");
+describe('Cursor', () => {
+    it('can be converted to and from javascript objects', () => {
+        const cursorObject = {
+            orderKey: '1234',
+            uniqueKey: '0x05dd5e4f023a81a8daaf86b8bf3967b04276a89c81b840e8e55d658323854ad7',
+        };
+        const cursor = cursor_1.Cursor.fromObject(cursorObject);
+        expect(cursor.orderKey).toEqual(long_1.default.fromNumber(1234));
+        expect(cursor.uniqueKey).toHaveLength(32);
+        const back = cursor_1.Cursor.toObject(cursor);
+        expect(back.orderKey).toEqual(cursorObject.orderKey);
+        expect(back.uniqueKey).toEqual(cursorObject.uniqueKey);
+    });
+});
+//# sourceMappingURL=cursor.test.js.map

package/dist/cursor.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cursor.test.js","sourceRoot":"","sources":["../src/cursor.test.ts"],"names":[],"mappings":";;;;;AAAA,gDAAuB;AACvB,qCAAiC;AAEjC,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE;IACtB,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;QACzD,MAAM,YAAY,GAAG;YACnB,QAAQ,EAAE,MAAM;YAChB,SAAS,EAAE,oEAAoE;SAChF,CAAA;QAED,MAAM,MAAM,GAAG,eAAM,CAAC,UAAU,CAAC,YAAY,CAAC,CAAA;QAC9C,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,cAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAA;QACtD,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,YAAY,CAAC,EAAE,CAAC,CAAA;QAEzC,MAAM,IAAI,GAAG,eAAM,CAAC,QAAQ,CAAC,MAAM,CAAE,CAAA;QAErC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAA;QACpD,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,SAAS,CAAC,CAAA;IACxD,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apibara/protocol",
-  "version": "0.4.7",
+  "version": "0.4.8",
   "source": "src/index.ts",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/cursor.test.ts

@@ -0,0 +1,20 @@
+import Long from 'long'
+import { Cursor } from './cursor'
+
+describe('Cursor', () => {
+  it('can be converted to and from javascript objects', () => {
+    const cursorObject = {
+      orderKey: '1234',
+      uniqueKey: '0x05dd5e4f023a81a8daaf86b8bf3967b04276a89c81b840e8e55d658323854ad7',
+    }
+
+    const cursor = Cursor.fromObject(cursorObject)
+    expect(cursor.orderKey).toEqual(Long.fromNumber(1234))
+    expect(cursor.uniqueKey).toHaveLength(32)
+
+    const back = Cursor.toObject(cursor)!
+
+    expect(back.orderKey).toEqual(cursorObject.orderKey)
+    expect(back.uniqueKey).toEqual(cursorObject.uniqueKey)
+  })
+})

package/src/cursor.ts

@@ -28,12 +28,38 @@ export const Cursor = {
     }
   },
 
+  /**
+   * Creates a new cursor from a plain Javascript object.
+   */
+  fromObject({ orderKey, uniqueKey }: ReturnType<typeof _toObject>): ICursor {
+    return {
+      orderKey: Long.fromString(orderKey),
+      uniqueKey: Buffer.from(uniqueKey.slice(2), 'hex'),
+    }
+  },
+
   /**
    * Returns the cursor string representation.
    */
   toString: (cursor?: ICursor | null): string | undefined => {
     if (!cursor) return
-    let hash = Buffer.from(cursor.uniqueKey).toString('hex')
-    return `${cursor.orderKey.toString()}/0x${hash}`
+    const { orderKey, uniqueKey } = _toObject(cursor)
+    return `${orderKey}/${uniqueKey}`
   },
+
+  /**
+   * Returns the cursor as plain Javascript object.
+   */
+  toObject: (cursor?: ICursor | null): ReturnType<typeof _toObject> | undefined => {
+    if (!cursor) return
+    return _toObject(cursor)
+  },
+}
+
+function _toObject(cursor: ICursor): { orderKey: string; uniqueKey: string } {
+  let hash = Buffer.from(cursor.uniqueKey).toString('hex')
+  return {
+    orderKey: cursor.orderKey.toString(),
+    uniqueKey: `0x${hash}`,
+  }
 }