@callstack/repack-dev-server 1.0.2 → 4.0.0-rc.0

package/package.json

@@ -2,7 +2,7 @@
   "name": "@callstack/repack-dev-server",
   "description": "A bundler-agnostic development server for React Native applications as part of @callstack/repack.",
   "license": "MIT",
-  "version": "1.0.2",
+  "version": "4.0.0-rc.0",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -27,31 +27,20 @@
   ],
   "author": "zamotany <zamotany.oss@gmail.com>",
   "engines": {
-    "node": ">=14.x"
+    "node": ">=18"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
   },
-  "scripts": {
-    "build:js": "babel src --out-dir dist --extensions \".js,.cjs,.ts\" --source-maps --ignore \"**/__tests__/**\" --delete-dir-on-start --copy-files",
-    "build:js:watch": "yarn build:js --watch",
-    "build:ts": "tsc --emitDeclarationOnly",
-    "build:ts:watch": "yarn build:ts --watch --preserveWatchOutput",
-    "build": "yarn build:js && yarn build:ts",
-    "docs": "typedoc",
-    "typecheck": "tsc --noEmit",
-    "lint": "eslint --ext \".js,.ts\" src",
-    "archive": "yarn build && yarn pack --out repack-dev-server-%v-$(git log -1 --format=\"%h\").tgz"
-  },
   "dependencies": {
     "@babel/code-frame": "^7.16.7",
     "@callstack/repack-debugger-app": "^1.0.2",
-    "@fastify/sensible": "^4.1.0",
-    "@fastify/static": "^5.0.2",
-    "fastify": "^3.29.5",
-    "fastify-favicon": "^3.2.0",
-    "fastify-plugin": "^3.0.1",
+    "@fastify/sensible": "^5.5.0",
+    "@fastify/static": "^6.12.0",
+    "fastify": "^4.24.3",
+    "fastify-favicon": "^4.3.0",
+    "fastify-plugin": "^4.5.1",
     "metro-inspector-proxy": "^0.71.0",
     "open": "^8.4.0",
     "open-editor": "^4.0.0",
@@ -60,18 +49,26 @@
     "ws": "^8.7.0"
   },
   "devDependencies": {
-    "@babel/cli": "^7.17.10",
-    "@babel/core": "^7.18.2",
-    "@babel/preset-env": "^7.18.2",
-    "@babel/preset-typescript": "^7.17.12",
-    "@callstack/eslint-config": "^12.0.2",
+    "@babel/cli": "^7.23.9",
+    "@babel/core": "^7.23.9",
     "@types/babel__code-frame": "^7.0.3",
-    "@types/node": "14",
+    "@types/node": "18",
     "@types/ws": "^8.5.3",
     "babel-plugin-add-import-extension": "^1.6.0",
-    "eslint": "^8.16.0",
-    "typedoc": "^0.22.17",
-    "typedoc-plugin-markdown": "^3.12.1",
-    "typescript": "^4.7.2"
+    "eslint": "^8.53.0",
+    "typedoc": "^0.25.3",
+    "typedoc-plugin-markdown": "^3.17.1",
+    "typescript": "^5.2.2"
+  },
+  "scripts": {
+    "build:js": "babel src --out-dir dist --extensions \".js,.cjs,.ts\" --source-maps --ignore \"**/__tests__/**\" --delete-dir-on-start --copy-files",
+    "build:js:watch": "pnpm build:js --watch",
+    "build:ts": "tsc --emitDeclarationOnly",
+    "build:ts:watch": "pnpm build:ts --watch --preserveWatchOutput",
+    "build": "pnpm build:js && pnpm build:ts",
+    "docs": "typedoc",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint --ext \".js,.ts\" src",
+    "archive": "pnpm build && pnpm pack"
   }
-}
+}

package/docs/README.md

@@ -1,28 +0,0 @@
-# @callstack/repack-dev-server
-
-## Table of contents
-
-### Namespaces
-
-- [Internal](modules/Internal.md)
-- [Server](modules/Server.md)
-
-### Interfaces
-
-- [CodeFrame](interfaces/CodeFrame.md)
-- [CompilerDelegate](interfaces/CompilerDelegate.md)
-- [HmrDelegate](interfaces/HmrDelegate.md)
-- [InputStackFrame](interfaces/InputStackFrame.md)
-- [ProgressData](interfaces/ProgressData.md)
-- [ReactNativeStackFrame](interfaces/ReactNativeStackFrame.md)
-- [StackFrame](interfaces/StackFrame.md)
-- [SymbolicatorDelegate](interfaces/SymbolicatorDelegate.md)
-- [SymbolicatorResults](interfaces/SymbolicatorResults.md)
-
-### Type Aliases
-
-- [SendProgress](types/SendProgress.md)
-
-### Functions
-
-- [createServer](functions/createServer.md)

package/docs/enums/Internal.EventTypes.md

@@ -1,41 +0,0 @@
-# Enumeration: EventTypes
-
-[Internal](../modules/Internal.md).EventTypes
-
-## Table of contents
-
-### Enumeration Members
-
-- [BuildEnd](Internal.EventTypes.md#buildend)
-- [BuildStart](Internal.EventTypes.md#buildstart)
-- [HmrEvent](Internal.EventTypes.md#hmrevent)
-
-## Enumeration Members
-
-### BuildEnd
-
-• **BuildEnd**
-
-#### Defined in
-
-[types.ts:200](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/types.ts#L200)
-
-___
-
-### BuildStart
-
-• **BuildStart**
-
-#### Defined in
-
-[types.ts:199](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/types.ts#L199)
-
-___
-
-### HmrEvent
-
-• **HmrEvent**
-
-#### Defined in
-
-[types.ts:201](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/types.ts#L201)

package/docs/functions/createServer.md

@@ -1,21 +0,0 @@
-# Function: createServer
-
-▸ **createServer**(`config`): `Promise`<{ `instance`: `FastifyInstance`<`Server`, `IncomingMessage`, `ServerResponse`, `FastifyLoggerInstance`\> & `PromiseLike`<`FastifyInstance`<`Server`, `IncomingMessage`, `ServerResponse`, `FastifyLoggerInstance`\>\> ; `start`: () => `Promise`<`void`\> ; `stop`: () => `Promise`<`void`\>  }\>
-
-Create instance of development server, powered by Fastify.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `config` | [`Config`](../interfaces/Server.Config.md) | Server configuration. |
-
-#### Returns
-
-`Promise`<{ `instance`: `FastifyInstance`<`Server`, `IncomingMessage`, `ServerResponse`, `FastifyLoggerInstance`\> & `PromiseLike`<`FastifyInstance`<`Server`, `IncomingMessage`, `ServerResponse`, `FastifyLoggerInstance`\>\> ; `start`: () => `Promise`<`void`\> ; `stop`: () => `Promise`<`void`\>  }\>
-
-`start` and `stop` functions as well as an underlying Fastify `instance`.
-
-#### Defined in
-
-[createServer.ts:21](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/createServer.ts#L21)

package/docs/interfaces/CodeFrame.md

@@ -1,48 +0,0 @@
-# Interface: CodeFrame
-
-Represents [@babel/core-frame](https://babeljs.io/docs/en/babel-code-frame).
-
-## Table of contents
-
-### Properties
-
-- [content](CodeFrame.md#content)
-- [fileName](CodeFrame.md#filename)
-- [location](CodeFrame.md#location)
-
-## Properties
-
-### content
-
-• **content**: `string`
-
-#### Defined in
-
-[plugins/symbolicate/types.ts:29](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/plugins/symbolicate/types.ts#L29)
-
-___
-
-### fileName
-
-• **fileName**: `string`
-
-#### Defined in
-
-[plugins/symbolicate/types.ts:34](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/plugins/symbolicate/types.ts#L34)
-
-___
-
-### location
-
-• **location**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `column` | `number` |
-| `row` | `number` |
-
-#### Defined in
-
-[plugins/symbolicate/types.ts:30](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/plugins/symbolicate/types.ts#L30)

package/docs/interfaces/CompilerDelegate.md

@@ -1,83 +0,0 @@
-# Interface: CompilerDelegate
-
-Delegate with implementation for compiler-specific functions.
-
-## Table of contents
-
-### Methods
-
-- [getAsset](CompilerDelegate.md#getasset)
-- [getMimeType](CompilerDelegate.md#getmimetype)
-- [inferPlatform](CompilerDelegate.md#inferplatform)
-
-## Methods
-
-### getAsset
-
-▸ **getAsset**(`filename`, `platform`, `sendProgress?`): `Promise`<`string` \| `Buffer`\>
-
-Get compiled asset content.
-
-If the compilation is in progress, it should wait until compilation finishes and then return the asset.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `filename` | `string` | Filename of the asset to get. |
-| `platform` | `string` | Platform of the asset to get. |
-| `sendProgress?` | [`SendProgress`](../types/SendProgress.md) | Function to notify the client who requested the asset about compilation progress. |
-
-#### Returns
-
-`Promise`<`string` \| `Buffer`\>
-
-#### Defined in
-
-[plugins/compiler/types.ts:16](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/plugins/compiler/types.ts#L16)
-
-___
-
-### getMimeType
-
-▸ **getMimeType**(`filename`, `platform`, `data`): `string`
-
-Detect MIME type of the asset from `filename`, `platform` or `data` (or from combination of either).
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `filename` | `string` | Filename of the asset. |
-| `platform` | `string` | Platform of the asset. |
-| `data` | `string` \| `Buffer` | Asset's content. |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[plugins/compiler/types.ts:29](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/plugins/compiler/types.ts#L29)
-
-___
-
-### inferPlatform
-
-▸ `Optional` **inferPlatform**(`uri`): `undefined` \| `string`
-
-Detect the platform from the URI - either from filename, query params or both.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `uri` | `string` | URI string. |
-
-#### Returns
-
-`undefined` \| `string`
-
-#### Defined in
-
-[plugins/compiler/types.ts:40](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/plugins/compiler/types.ts#L40)

package/docs/interfaces/HmrDelegate.md

@@ -1,51 +0,0 @@
-# Interface: HmrDelegate
-
-Delegate with implementation for HMR-specific functions.
-
-## Table of contents
-
-### Methods
-
-- [getUriPath](HmrDelegate.md#geturipath)
-- [onClientConnected](HmrDelegate.md#onclientconnected)
-
-## Methods
-
-### getUriPath
-
-▸ **getUriPath**(): `string`
-
-Get URI under which HMR server will be running, e.g: `/hmr`
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[plugins/wss/types.ts:6](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/plugins/wss/types.ts#L6)
-
-___
-
-### onClientConnected
-
-▸ **onClientConnected**(`platform`, `clientId`): `void`
-
-Callback for when the new HMR client is connected.
-
-Useful for running initial synchronization or any other side effect.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `platform` | `string` | Platform of the connected client. |
-| `clientId` | `string` | Id of the connected client. |
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[plugins/wss/types.ts:16](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/plugins/wss/types.ts#L16)

package/docs/interfaces/InputStackFrame.md

@@ -1,76 +0,0 @@
-# Interface: InputStackFrame
-
-React Native stack frame used as input when processing by {@link Symbolicator}.
-
-## Hierarchy
-
-- [`ReactNativeStackFrame`](ReactNativeStackFrame.md)
-
-  ↳ **`InputStackFrame`**
-
-  ↳↳ [`StackFrame`](StackFrame.md)
-
-## Table of contents
-
-### Properties
-
-- [column](InputStackFrame.md#column)
-- [file](InputStackFrame.md#file)
-- [lineNumber](InputStackFrame.md#linenumber)
-- [methodName](InputStackFrame.md#methodname)
-
-## Properties
-
-### column
-
-• **column**: ``null`` \| `number`
-
-#### Inherited from
-
-[ReactNativeStackFrame](ReactNativeStackFrame.md).[column](ReactNativeStackFrame.md#column)
-
-#### Defined in
-
-[plugins/symbolicate/types.ts:6](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/plugins/symbolicate/types.ts#L6)
-
-___
-
-### file
-
-• **file**: `string`
-
-#### Overrides
-
-[ReactNativeStackFrame](ReactNativeStackFrame.md).[file](ReactNativeStackFrame.md#file)
-
-#### Defined in
-
-[plugins/symbolicate/types.ts:15](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/plugins/symbolicate/types.ts#L15)
-
-___
-
-### lineNumber
-
-• **lineNumber**: ``null`` \| `number`
-
-#### Inherited from
-
-[ReactNativeStackFrame](ReactNativeStackFrame.md).[lineNumber](ReactNativeStackFrame.md#linenumber)
-
-#### Defined in
-
-[plugins/symbolicate/types.ts:5](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/plugins/symbolicate/types.ts#L5)
-
-___
-
-### methodName
-
-• **methodName**: `string`
-
-#### Inherited from
-
-[ReactNativeStackFrame](ReactNativeStackFrame.md).[methodName](ReactNativeStackFrame.md#methodname)
-
-#### Defined in
-
-[plugins/symbolicate/types.ts:8](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/plugins/symbolicate/types.ts#L8)

package/docs/interfaces/ProgressData.md

@@ -1,34 +0,0 @@
-# Interface: ProgressData
-
-Representation of the compilation progress.
-
-## Table of contents
-
-### Properties
-
-- [completed](ProgressData.md#completed)
-- [total](ProgressData.md#total)
-
-## Properties
-
-### completed
-
-• **completed**: `number`
-
-Number of modules built.
-
-#### Defined in
-
-[types.ts:178](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/types.ts#L178)
-
-___
-
-### total
-
-• **total**: `number`
-
-Total number of modules detect as part of compilation.
-
-#### Defined in
-
-[types.ts:181](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/types.ts#L181)

package/docs/interfaces/ReactNativeStackFrame.md

@@ -1,58 +0,0 @@
-# Interface: ReactNativeStackFrame
-
-Raw React Native stack frame.
-
-## Hierarchy
-
-- **`ReactNativeStackFrame`**
-
-  ↳ [`InputStackFrame`](InputStackFrame.md)
-
-## Table of contents
-
-### Properties
-
-- [column](ReactNativeStackFrame.md#column)
-- [file](ReactNativeStackFrame.md#file)
-- [lineNumber](ReactNativeStackFrame.md#linenumber)
-- [methodName](ReactNativeStackFrame.md#methodname)
-
-## Properties
-
-### column
-
-• **column**: ``null`` \| `number`
-
-#### Defined in
-
-[plugins/symbolicate/types.ts:6](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/plugins/symbolicate/types.ts#L6)
-
-___
-
-### file
-
-• **file**: ``null`` \| `string`
-
-#### Defined in
-
-[plugins/symbolicate/types.ts:7](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/plugins/symbolicate/types.ts#L7)
-
-___
-
-### lineNumber
-
-• **lineNumber**: ``null`` \| `number`
-
-#### Defined in
-
-[plugins/symbolicate/types.ts:5](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/plugins/symbolicate/types.ts#L5)
-
-___
-
-### methodName
-
-• **methodName**: `string`
-
-#### Defined in
-
-[plugins/symbolicate/types.ts:8](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/plugins/symbolicate/types.ts#L8)

package/docs/interfaces/Server.Api.Asset.md

@@ -1,36 +0,0 @@
-# Interface: Asset
-
-[Server](../modules/Server.md).[Api](../modules/Server.Api.md).Asset
-
-A compilation asset representation for API clients.
-
-## Indexable
-
-▪ [key: `string`]: `any`
-
-## Table of contents
-
-### Properties
-
-- [name](Server.Api.Asset.md#name)
-- [size](Server.Api.Asset.md#size)
-
-## Properties
-
-### name
-
-• **name**: `string`
-
-#### Defined in
-
-[types.ts:141](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/types.ts#L141)
-
-___
-
-### size
-
-• **size**: `number`
-
-#### Defined in
-
-[types.ts:142](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/types.ts#L142)

package/docs/interfaces/Server.Api.CompilationStats.md

@@ -1,9 +0,0 @@
-# Interface: CompilationStats
-
-[Server](../modules/Server.md).[Api](../modules/Server.Api.md).CompilationStats
-
-A compilation stats representation for API clients.
-
-## Indexable
-
-▪ [key: `string`]: `any`

package/docs/interfaces/Server.Api.Delegate.md

@@ -1,75 +0,0 @@
-# Interface: Delegate
-
-[Server](../modules/Server.md).[Api](../modules/Server.Api.md).Delegate
-
-Delegate with implementation for API endpoints.
-
-## Table of contents
-
-### Methods
-
-- [getAssets](Server.Api.Delegate.md#getassets)
-- [getCompilationStats](Server.Api.Delegate.md#getcompilationstats)
-- [getPlatforms](Server.Api.Delegate.md#getplatforms)
-
-## Methods
-
-### getAssets
-
-▸ **getAssets**(`platform`): `Promise`<[`Asset`](Server.Api.Asset.md)[]\>
-
-Get all assets from compilation for given platform.
-Should return `[]` if the compilation does not exists for given platform.
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `platform` | `string` |
-
-#### Returns
-
-`Promise`<[`Asset`](Server.Api.Asset.md)[]\>
-
-#### Defined in
-
-[types.ts:162](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/types.ts#L162)
-
-___
-
-### getCompilationStats
-
-▸ **getCompilationStats**(`platform`): `Promise`<``null`` \| [`CompilationStats`](Server.Api.CompilationStats.md)\>
-
-Get compilation stats for a given platform.
-Should return `null` if the compilation does not exists for given platform.
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `platform` | `string` |
-
-#### Returns
-
-`Promise`<``null`` \| [`CompilationStats`](Server.Api.CompilationStats.md)\>
-
-#### Defined in
-
-[types.ts:168](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/types.ts#L168)
-
-___
-
-### getPlatforms
-
-▸ **getPlatforms**(): `Promise`<`string`[]\>
-
-Get all platforms - either with already existing compilations or all supported platforms.
-
-#### Returns
-
-`Promise`<`string`[]\>
-
-#### Defined in
-
-[types.ts:156](https://github.com/callstack/repack/blob/81f067f/packages/dev-server/src/types.ts#L156)