@atlaspack/build-cache 2.13.4-unified-f165f7d09.0 → 2.13.5-dev-inline-requires-reuse-bdc9ca9c3.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaspack/build-cache
 
+## 2.13.4
+
+### Patch Changes
+
+- [#720](https://github.com/atlassian-labs/atlaspack/pull/720) [`d2fd849`](https://github.com/atlassian-labs/atlaspack/commit/d2fd849770fe6305e9c694bd97b1bd905abd9d94) Thanks [@alshdavid](https://github.com/alshdavid)! - Migrate to TypeScript
+
 ## 2.13.3
 
 ### Patch Changes

package/lib/serializer.js

@@ -26,6 +26,10 @@ Object.defineProperty(exports, "serializeRaw", {
 exports.unregisterSerializableClass = unregisterSerializableClass;
 var _buildCache = require("./buildCache");
 var _serializerCore = require("./serializerCore");
+// flow-to-ts helpers
+
+// /flow-to-ts helpers
+
 const nameToCtor = new Map();
 const ctorToName = new Map();
 function registerSerializableClass(name, ctor) {

package/lib/types/buildCache.d.ts

@@ -0,0 +1,2 @@
+export declare function createBuildCache<K, V>(): Map<K, V>;
+export declare function clearBuildCaches(): void;

package/{src/index.js → lib/types/index.d.ts}

@@ -1,5 +1,3 @@
-// @flow
-
 export * from './buildCache';
 export * from './serializer';
 export * from './serializerCore';

package/lib/types/serializer.d.ts

@@ -0,0 +1,11 @@
+export { serializeRaw, deserializeRaw } from './serializerCore';
+export type Class<T> = new (...args: any[]) => T;
+export declare function registerSerializableClass(name: string, ctor: Class<any>): void;
+export declare function unregisterSerializableClass(name: string, ctor: Class<any>): void;
+export declare function prepareForSerialization(object: any): any;
+export declare function restoreDeserializedObject(object: any): any;
+export declare function serialize(object: any): Buffer;
+export declare function deserialize(buffer: Buffer): any;
+export declare function cacheSerializedObject(object: any, buffer?: Buffer): void;
+export declare function deserializeToCache(buffer: Buffer): any;
+export declare function removeSerializedObjectFromCache(object: any): void;

package/lib/types/serializerCore.d.ts

@@ -0,0 +1,2 @@
+export declare let serializeRaw: (arg1?: any) => Buffer;
+export declare let deserializeRaw: (arg1: Buffer) => any;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@atlaspack/build-cache",
   "description": "Serialize and deserialize data structures to a build cache",
-  "version": "2.13.4-unified-f165f7d09.0",
+  "version": "2.13.5-dev-inline-requires-reuse-bdc9ca9c3.0",
   "license": "(MIT OR Apache-2.0)",
   "type": "commonjs",
   "publishConfig": {
@@ -11,10 +11,15 @@
     "type": "git",
     "url": "https://github.com/atlassian-labs/atlaspack.git"
   },
-  "main": "lib/index.js",
-  "source": "src/index.js",
+  "main": "./lib/index.js",
+  "source": "./src/index.ts",
+  "types": "./lib/types/index.d.ts",
   "engines": {
     "node": ">= 16.0.0"
   },
-  "gitHead": "f165f7d09a7970afa669133971ceb2702726c23d"
+  "scripts": {
+    "check-ts": "tsc --emitDeclarationOnly --rootDir src",
+    "build:lib": "gulp build --gulpfile ../../../gulpfile.js --cwd ."
+  },
+  "gitHead": "bdc9ca9c38f45155a6d6f280e343a29e3f030a83"
 }

package/src/{buildCache.js → buildCache.ts}

@@ -1,5 +1,3 @@
-// @flow
-
 const buildCaches: Array<Map<any, any>> = [];
 
 export function createBuildCache<K, V>(): Map<K, V> {

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from './buildCache';
+export * from './serializer';
+export * from './serializerCore';

package/src/{serializer.js → serializer.ts}

@@ -1,9 +1,12 @@
-// @flow
 import {createBuildCache} from './buildCache';
 import {serializeRaw, deserializeRaw} from './serializerCore';
 
 export {serializeRaw, deserializeRaw} from './serializerCore';
 
+// flow-to-ts helpers
+export type Class<T> = new (...args: any[]) => T;
+// /flow-to-ts helpers
+
 const nameToCtor: Map<string, Class<any>> = new Map();
 const ctorToName: Map<Class<any>, string> = new Map();
 
@@ -49,7 +52,7 @@ function shallowCopy(object: any) {
   return object;
 }
 
-function isBuffer(object) {
+function isBuffer(object: any) {
   return (
     object.buffer instanceof ArrayBuffer ||
     (typeof SharedArrayBuffer !== 'undefined' &&
@@ -57,11 +60,11 @@ function isBuffer(object) {
   );
 }
 
-function shouldContinueMapping(value) {
+function shouldContinueMapping(value: any) {
   return value && typeof value === 'object' && value.$$raw !== true;
 }
 
-function mapObject(object: any, fn: (val: any) => any, preOrder = false): any {
+function mapObject(object: any, fn: (val?: any) => any, preOrder = false): any {
   let cache = new Map();
   let memo = new Map();
 
@@ -211,8 +214,8 @@ export function restoreDeserializedObject(object: any): any {
         );
       }
 
-      if (typeof ctor.deserialize === 'function') {
-        return ctor.deserialize(value.value);
+      if (typeof (ctor as any).deserialize === 'function') {
+        return (ctor as any).deserialize(value.value);
       }
 
       value = value.value;
@@ -223,7 +226,7 @@ export function restoreDeserializedObject(object: any): any {
   });
 }
 
-const serializeCache = createBuildCache();
+const serializeCache = createBuildCache<any, Buffer>();
 
 export function serialize(object: any): Buffer {
   let cached = serializeCache.get(object);

package/src/serializerCore.ts

@@ -0,0 +1,4 @@
+import v8 from 'v8';
+
+export let serializeRaw: (arg1?: any) => Buffer = v8.serialize;
+export let deserializeRaw: (arg1: Buffer) => any = v8.deserialize;

package/test/{serializer.test.js → serializer.test.ts}

@@ -1,5 +1,3 @@
-// @flow
-
 import assert from 'assert';
 import sinon from 'sinon';
 
@@ -151,8 +149,8 @@ describe('serializer', () => {
 
   it('should serialize a cyclic class', () => {
     class Foo {
-      x: ?Foo;
-      constructor(x: ?Foo) {
+      x: Foo | null | undefined;
+      constructor(x?: Foo | null) {
         this.x = x;
       }
     }
@@ -193,8 +191,8 @@ describe('serializer', () => {
 
   it('should serialize a cyclic class and copy on write', () => {
     class Foo {
-      x: ?Foo;
-      constructor(x: ?Foo) {
+      x: Foo | null | undefined;
+      constructor(x?: Foo | null) {
         this.x = x;
       }
     }
@@ -257,7 +255,7 @@ describe('serializer', () => {
     class Outer {
       inner: Inner;
 
-      constructor(inner) {
+      constructor(inner: any) {
         this.inner = inner;
       }
 
@@ -272,7 +270,7 @@ describe('serializer', () => {
     class Inner {
       x: number;
 
-      constructor(x) {
+      constructor(x: any) {
         this.x = x;
       }
 

package/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "../../../tsconfig.json",
+  "include": ["src"]
+}

package/src/serializerCore.js

@@ -1,5 +0,0 @@
-// @flow
-import v8 from 'v8';
-
-export let serializeRaw: (any) => Buffer = v8.serialize;
-export let deserializeRaw: (Buffer) => any = v8.deserialize;