Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/plugin-sdk/package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@sigmacomputing/plugin",
"name": "@sigmacomputing/plugin-sdk",
"version": "1.2.0",
"description": "Sigma Computing Plugin Client SDK",
"license": "MIT",
Expand Down
15 changes: 1 addition & 14 deletions packages/plugin-sdk/tsdown.config.ts
Original file line number Diff line number Diff line change
@@ -1,15 +1,2 @@
import { defineConfig, mergeConfig } from 'tsdown';

// @ts-ignore - base config is defined outside of this package
import baseConfig from '../../tsdown.base.ts';

import packageJson from './package.json' with { type: 'json' };

export default mergeConfig(
baseConfig,
defineConfig({
define: {
__VERSION__: JSON.stringify(packageJson.version),
},
}),
);
export { default } from '../../tsdown.base.ts';
15 changes: 1 addition & 14 deletions packages/plugin-sdk/vitest.config.ts
Original file line number Diff line number Diff line change
@@ -1,15 +1,2 @@
import { defineConfig, mergeConfig } from 'vitest/config';

// @ts-ignore - base config is defined outside of this package
import baseConfig from '../../vitest.base.ts';

import packageJson from './package.json' with { type: 'json' };

export default mergeConfig(
baseConfig,
defineConfig({
define: {
__VERSION__: JSON.stringify(packageJson.version),
},
}),
);
export { default } from '../../vitest.base.ts';
37 changes: 37 additions & 0 deletions packages/plugin/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# `@sigmacomputing/plugin` is deprecated

> **This package has been renamed to [`@sigmacomputing/plugin-sdk`](https://www.npmjs.com/package/@sigmacomputing/plugin-sdk).**
>
> `@sigmacomputing/plugin` will no longer receive updates. Please migrate your
> projects to `@sigmacomputing/plugin-sdk` to continue receiving new features
> and bug fixes.

This package is now a thin compatibility shim that re-exports everything from
`@sigmacomputing/plugin-sdk`. It emits a `console.warn` at import time to
remind consumers to migrate.

## Migrating

Replace your dependency on `@sigmacomputing/plugin` with `@sigmacomputing/plugin-sdk`:

```sh
yarn remove @sigmacomputing/plugin
yarn add @sigmacomputing/plugin-sdk
```

```sh
npm uninstall @sigmacomputing/plugin
npm install @sigmacomputing/plugin-sdk
```

Then update your imports:

```diff
-import { client, initialize } from '@sigmacomputing/plugin';
+import { client, initialize } from '@sigmacomputing/plugin-sdk';
```

The public API is unchanged — only the package name is different.

For documentation, examples, and the changelog, see the
[`@sigmacomputing/plugin-sdk`](https://github.com/sigmacomputing/plugin) repository.
54 changes: 54 additions & 0 deletions packages/plugin/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
{
"name": "@sigmacomputing/plugin",
"version": "1.2.0",
"description": "Deprecated: use @sigmacomputing/plugin-sdk instead.",
"license": "MIT",
"type": "module",
"scripts": {
"build": "tsdown",
"build:watch": "tsdown --watch",
"format": "yarn g:format",
"lint": "yarn g:lint",
"publish": "yarn g:publlish",
"types": "yarn g:types"
},
"dependencies": {
"@sigmacomputing/plugin-sdk": "^1.2.0"
},
"peerDependencies": {
"react": "^16.8.0 || ^17.0.0 || ^18.0.0 || ^19.0.0"
},
"peerDependenciesMeta": {
"react": {
"optional": true
}
},
"devDependencies": {
"tsdown": "^0.21.10"
},
"main": "./dist/cjs/index.cjs",
"module": "./dist/esm/index.js",
"types": "./dist/cjs/index.d.cts",
"unpkg": "./dist/umd/sigmacomputing-plugin.umd.js",
"jsdelivr": "./dist/umd/sigmacomputing-plugin.umd.js",
"exports": {
".": {
"import": {
"types": "./dist/esm/index.d.ts",
"default": "./dist/esm/index.js"
},
"require": {
"types": "./dist/cjs/index.d.cts",
"default": "./dist/cjs/index.cjs"
}
},
"./package.json": "./package.json"
},
"files": [
"dist/**/*",
"src/**/*"
],
"publishConfig": {
"access": "public"
}
}
6 changes: 6 additions & 0 deletions packages/plugin/src/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
console.warn(
'[@sigmacomputing/plugin] This package is deprecated and will no longer receive updates. ' +
'Please migrate to @sigmacomputing/plugin-sdk: https://github.com/sigmacomputing/plugin',
);

export * from '@sigmacomputing/plugin-sdk';
7 changes: 7 additions & 0 deletions packages/plugin/tsconfig.app.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"extends": "../../tsconfig.app.json",
"compilerOptions": {
"tsBuildInfoFile": "./node_modules/.tmp/tsconfig.app.tsbuildinfo"
},
"include": ["src"]
}
12 changes: 12 additions & 0 deletions packages/plugin/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"compilerOptions": {
"tsBuildInfoFile": "./node_modules/.tmp/tsconfig.tsbuildinfo",

"noEmit": true
},
"files": [],
"references": [
{ "path": "./tsconfig.app.json" },
{ "path": "./tsconfig.node.json" }
]
}
7 changes: 7 additions & 0 deletions packages/plugin/tsconfig.node.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"extends": "../../tsconfig.node.json",
"compilerOptions": {
"tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo"
},
"include": ["tsdown.config.ts"]
}
2 changes: 2 additions & 0 deletions packages/plugin/tsdown.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
// @ts-ignore - base config is defined outside of this package
export { default } from '../../tsdown.base.ts';
16 changes: 15 additions & 1 deletion scripts/bump-version.ts
Original file line number Diff line number Diff line change
Expand Up @@ -100,13 +100,27 @@ const readCurrentVersion = (): semver.SemVer => {
return parsed;
};

const WORKSPACE_DEP_SCOPE = '@sigmacomputing/';

const writeNewVersion = (pkgPath: string, version: string): void => {
const raw = readFileSync(pkgPath, 'utf8');
const pattern = /("version"\s*:\s*")[^"]+(")/;
if (!pattern.test(raw)) {
throw new Error(`Failed to locate "version" field in ${pkgPath}`);
}
writeFileSync(pkgPath, raw.replace(pattern, `$1${version}$2`));
const withVersion = raw.replace(pattern, `$1${version}$2`);

const escaped = WORKSPACE_DEP_SCOPE.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
const depPattern = new RegExp(
`("${escaped}[^"]+"\\s*:\\s*")(\\^|~)?[^"]+(")`,
'g',
);
const withDeps = withVersion.replace(
depPattern,
(_match, prefix, range, suffix) => `${prefix}${range ?? '^'}${version}${suffix}`,
);

writeFileSync(pkgPath, withDeps);
};

type TurboQueryLsResponse = {
Expand Down
3 changes: 3 additions & 0 deletions vitest.base.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
import { playwright } from '@vitest/browser-playwright';
import { defineConfig } from 'vitest/config';

import packageJson from './package.json' with { type: 'json' };

export default defineConfig({
define: {
__VERSION__: JSON.stringify(packageJson.version),
__VITEST_BROWSER__: true.toString(),
},
oxc: {
Expand Down
Loading