Skip to content

Commit

Permalink
fix experimental package build (#2144)
Browse files Browse the repository at this point in the history
Align it with typescript-client/react-hooks packages.
  • Loading branch information
KyleAMathews authored Dec 10, 2024
1 parent 54bbb05 commit eeba768
Show file tree
Hide file tree
Showing 5 changed files with 104 additions and 182 deletions.
69 changes: 37 additions & 32 deletions packages/experimental/package.json
Original file line number Diff line number Diff line change
@@ -1,34 +1,11 @@
{
"name": "@electric-sql/experimental",
"version": "0.1.2-beta.0",
"description": "Experimental TypeScript features for ElectricSQL.",
"type": "module",
"main": "dist/cjs/index.cjs",
"module": "dist/index.legacy-esm.js",
"types": "dist/index.d.ts",
"exports": {
"./package.json": "./package.json",
".": {
"types": "./dist/index.d.ts",
"import": "./dist/index.mjs",
"default": "./dist/cjs/index.cjs"
}
},
"files": [
"dist",
"src"
],
"sideEffects": false,
"repository": {
"type": "git",
"url": "git+https://github.com/electric-sql/electric.git"
},
"version": "0.1.2-beta.0",
"author": "ElectricSQL team and contributors.",
"license": "Apache-2",
"bugs": {
"url": "https://github.com/electric-sql/electric/issues"
},
"homepage": "https://electric-sql.com",
"dependencies": {
"@electric-sql/client": "workspace:*"
},
Expand All @@ -50,22 +27,50 @@
"uuid": "^10.0.0",
"vitest": "^2.0.2"
},
"exports": {
"./package.json": "./package.json",
".": {
"import": {
"types": "./dist/index.d.ts",
"default": "./dist/index.mjs"
},
"require": {
"types": "./dist/cjs/index.d.cts",
"default": "./dist/cjs/index.cjs"
}
}
},
"files": [
"dist",
"src"
],
"homepage": "https://electric-sql.com",
"license": "Apache-2",
"main": "dist/cjs/index.cjs",
"module": "dist/index.legacy-esm.js",
"optionalDependencies": {
"@rollup/rollup-darwin-arm64": "^4.18.1"
},
"repository": {
"type": "git",
"url": "git+https://github.com/electric-sql/electric.git"
},
"scripts": {
"build": "shx rm -rf dist && tsup && tsc -p tsconfig.build.json",
"format": "eslint . --fix",
"prepack": "pnpm build",
"stylecheck": "eslint . --quiet",
"test": "pnpm exec vitest",
"typecheck": "tsc -p tsconfig.json"
},
"sideEffects": false,
"type": "module",
"types": "dist/index.d.ts",
"typesVersions": {
"*": {
"*": [
"./dist/index.d.ts"
]
}
},
"scripts": {
"test": "pnpm exec vitest",
"typecheck": "tsc -p tsconfig.json",
"build": "shx rm -rf dist && concurrently \"tsup\" \"tsc -p tsconfig.build.json\"",
"prepack": "pnpm build",
"stylecheck": "eslint . --quiet",
"format": "eslint . --fix"
}
}
35 changes: 21 additions & 14 deletions packages/experimental/src/match.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import {
type Operation,
type Row,
type Value,
type Message,
} from '@electric-sql/client'

export function matchStream<T extends Row<unknown>>(
Expand All @@ -15,27 +16,33 @@ export function matchStream<T extends Row<unknown>>(
timeout = 60000 // ms
): Promise<ChangeMessage<T>> {
return new Promise<ChangeMessage<T>>((resolve, reject) => {
const unsubscribe: () => void = stream.subscribe((messages) => {
const message = messages.filter(isChangeMessage).find((message) => {
const operation = message.headers.operation

return operations.includes(operation) && matchFn(message)
})

if (message) {
return finish(message)
const unsubscribe: () => void = stream.subscribe(
(messages: Array<unknown>) => {
const message = messages
.filter((msg): msg is ChangeMessage<T> =>
isChangeMessage(msg as Message<Row<never>>)
)
.find((message) => {
const operation: Operation = message.headers.operation

return operations.includes(operation) && matchFn(message)
})

if (message) {
return finish(message)
}
}
})
)

const timeoutId = setTimeout(() => {
const msg = `matchStream timed out after ${timeout}ms`
const timeoutId: NodeJS.Timeout = setTimeout(() => {
const msg: string = `matchStream timed out after ${timeout}ms`

console.error(msg)

reject(msg)
}, timeout)

function finish(message: ChangeMessage<T>) {
function finish(message: ChangeMessage<T>): void {
clearTimeout(timeoutId)

unsubscribe()
Expand All @@ -49,5 +56,5 @@ export function matchBy<T extends Row<unknown>>(
column: string,
value: Value<GetExtensions<T>>
): (message: ChangeMessage<T>) => boolean {
return (message) => message.value[column] === value
return (message: ChangeMessage<T>) => message.value[column] === value
}
7 changes: 6 additions & 1 deletion packages/experimental/tsconfig.build.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
{
"extends": "../../tsconfig.build.json",
"include": ["src/**/*"],
"exclude": ["node_modules", "test", "dist"]
"exclude": ["node_modules", "tests", "dist"],
"compilerOptions": {
"paths": {
"@electric-sql/client": ["../typescript-client/src"]
}
}
}
107 changes: 5 additions & 102 deletions packages/experimental/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,105 +1,8 @@
{
"extends": "../../tsconfig.base.json",
"compilerOptions": {
/* Visit https://aka.ms/tsconfig.json to read more about this file */

/* Projects */
// "incremental": true, /* Enable incremental compilation */
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
// "tsBuildInfoFile": "./", /* Specify the folder for .tsbuildinfo incremental compilation files. */
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects */
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */

/* Language and Environment */
"target": "es2016" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
"lib": [
"ESNext"
] /* Specify a set of bundled library declaration files that describe the target runtime environment. */,
"jsx": "preserve" /* Specify what JSX code is generated. */,
// "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h' */
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using `jsx: react-jsx*`.` */
// "reactNamespace": "", /* Specify the object invoked for `createElement`. This only applies when targeting `react` JSX emit. */
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */

/* Modules */
"module": "commonjs" /* Specify what module code is generated. */,
// "rootDir": "./", /* Specify the root folder within your source files. */
// "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
// "typeRoots": [], /* Specify multiple folders that act like `./node_modules/@types`. */
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
// "resolveJsonModule": true, /* Enable importing .json files */
// "noResolve": true, /* Disallow `import`s, `require`s or `<reference>`s from expanding the number of files TypeScript should add to a project. */

/* JavaScript Support */
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the `checkJS` option to get errors from these files. */
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from `node_modules`. Only applicable with `allowJs`. */

/* Emit */
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If `declaration` is true, also designates a file that bundles all .d.ts output. */
// "outDir": "./", /* Specify an output folder for all emitted files. */
// "removeComments": true, /* Disable emitting comments. */
"noEmit": true, /* Disable emitting files from a compilation. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types */
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
// "newLine": "crlf", /* Set the newline character for emitting files. */
// "stripInternal": true, /* Disable emitting declarations that have `@internal` in their JSDoc comments. */
// "noEmitHelpers": true, /* Disable generating custom helper functions like `__extends` in compiled output. */
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
// "preserveConstEnums": true, /* Disable erasing `const enum` declarations in generated code. */
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */

/* Interop Constraints */
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
"esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */,
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
"forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,

/* Type Checking */
"strict": true /* Enable all strict type-checking options. */,
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied `any` type.. */
// "strictNullChecks": true, /* When type checking, take into account `null` and `undefined`. */
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
// "strictBindCallApply": true, /* Check that the arguments for `bind`, `call`, and `apply` methods match the original function. */
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
// "noImplicitThis": true, /* Enable error reporting when `this` is given the type `any`. */
// "useUnknownInCatchVariables": true, /* Type catch clause variables as 'unknown' instead of 'any'. */
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
// "noUnusedLocals": true, /* Enable error reporting when a local variables aren't read. */
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read */
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
// "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type */
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */

/* Completeness */
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
"skipLibCheck": true /* Skip type checking all .d.ts files. */
},
"include": ["src/**/*", "test/**/*"],
"exclude": ["node_modules", "dist"]
"paths": {
"@electric-sql/client": ["../typescript-client/src"]
}
}
}
68 changes: 35 additions & 33 deletions packages/experimental/tsup.config.ts
Original file line number Diff line number Diff line change
@@ -1,60 +1,62 @@
import type { Options } from 'tsup'
import { defineConfig } from 'tsup'

export default defineConfig((options) => {
const entry = {
index: 'src/index.ts',
}
export default defineConfig((options: Options) => {
const commonOptions: Partial<Options> = {
entry,
entry: {
index: `src/index.ts`,
},
tsconfig: `./tsconfig.build.json`,
sourcemap: true,
external: [`@electric-sql/client`],
...options,
}

return [
// Standard ESM, embedded `process.env.NODE_ENV` checks
// ESM build with .d.ts
{
...commonOptions,
format: ['esm'],
outExtension: () => ({ js: '.mjs' }), // Add dts: '.d.ts' when egoist/tsup#1053 lands
dts: true,
format: [`esm`],
outExtension: () => ({ js: `.mjs` }),
dts: {
entry: commonOptions.entry,
resolve: true,
},
clean: true,
},
// Support Webpack 4 by pointing `"module"` to a file with a `.js` extension
// CJS build with .d.cts
{
...commonOptions,
format: [`cjs`],
outDir: `./dist/cjs/`,
outExtension: () => ({ js: `.cjs` }),
dts: {
entry: commonOptions.entry,
resolve: true,
},
clean: false,
},
// Support Webpack 4 by pointing "module" to a file with a .js extension
{
...commonOptions,
format: ['esm'],
target: 'es2017',
format: [`esm`],
target: `es2017`,
dts: false,
outExtension: () => ({ js: '.js' }),
entry: Object.fromEntries(
Object.entries(entry).map(([key, value]) => [
`${key}.legacy-esm`,
value,
])
),
outExtension: () => ({ js: `.js` }),
entry: { 'index.legacy-esm': `src/index.ts` } as Record<string, string>,
},
// Browser-ready ESM, production + minified
{
...commonOptions,

entry: Object.fromEntries(
Object.entries(entry).map(([key, value]) => [`${key}.browser`, value])
),

define: {
'process.env.NODE_ENV': JSON.stringify('production'),
'process.env.NODE_ENV': JSON.stringify(`production`),
},
format: ['esm'],
outExtension: () => ({ js: '.mjs' }),
format: [`esm`],
outExtension: () => ({ js: `.mjs` }),
minify: true,
},
{
...commonOptions,
format: 'cjs',
outDir: './dist/cjs/',
outExtension: () => ({ js: '.cjs' }),
entry: {
'index.browser': `src/index.ts`,
} as Record<string, string>,
},
]
})

0 comments on commit eeba768

Please sign in to comment.