@sigmacomputing/plugin 1.0.0-rc.3 → 1.0.0

package/README.md

@@ -14,6 +14,13 @@ Plugins are built using Sigma’s Plugin API. This API communicates data and
 interaction events between a Sigma workbook and the plugin. Plugins are hosted
 by their developer and rendered in an iframe in Sigma.
 
+#### Warning: Breaking Changes
+
+`@sigmacomputing/plugin` has moved to https://github.com/sigmacomputing/plugin and
+is now open source. Please read our
+[CHANGELOG.md](https://github.com/sigmacomputing/plugin/blob/main/CHANGELOG.md)
+to review any breaking changes that have been made.
+
 ## Requirements
 
 To test your plugin in Sigma Plugin Dev Playground, you must:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sigmacomputing/plugin",
-  "version": "1.0.0-rc.3",
+  "version": "1.0.0",
   "description": "Sigma Computing Plugin Client API",
   "license": "MIT",
   "homepage": "https://github.com/sigmacomputing/plugin",

package/.gitignore

@@ -1,30 +0,0 @@
-# See https://help.github.com/ignore-files/ for more about ignoring files.
-
-# dependencies
-node_modules/
-
-# testing
-coverage/
-
-# production
-dist/
-
-# misc
-.DS_Store
-.env.local
-.envrc
-eslint_output.json
-tsc_output
-
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-
-# vim
-*.swp
-
-# IDE files
-.idea
-
-# typescript
-tsconfig*.tsbuildinfo

package/.lintstagedrc

@@ -1,3 +0,0 @@
-{
-  "*.{js,ts,tsx}": "yarn prettier --write"
-}

package/.nvmrc

@@ -1 +0,0 @@
-v16.13.1

package/.prettierrc

@@ -1,5 +0,0 @@
-{
-  "arrowParens": "avoid",
-  "singleQuote": true,
-  "trailingComma": "all"
-}

package/CHANGELOG.md

@@ -1,25 +0,0 @@
-## v1.0.0 (September 2nd, 2022)
-
-`@sigmacomputing/plugin` has moved to https://github.com/sigmacomputing/plugin and
-is now open source. Feel free to create an issue or contribute by opening a pull
-request. Read out `CONTRIBUTING.md` guide to get started.
-
-#### Breaking Changes
-
-- `@sigmacomputing/plugin-types` has been merged with `@sigmacomputing/plugin`
-  and will no longer received updates in the future. Please use only
-  `@sigmacomputing/plugin` going forward.
-
-- All `react` exports (`SigmaClientProvider` and all hooks) have been moved to
-  a separate explicit export. This will allow better bundle splitting by not
-  including `react` specific code for plugins that do not use `react`.
-
-  ```ts
-  // before
-  import { SigmaClientProvider, usePlugin } from '@sigmacomputing/plugin';
-
-  // after
-  import { SigmaClientProvider, usePlugin } from '@sigmacomputing/plugin/react';
-  ```
-
-  All types can be imported from either `@sigmacomputing/plugin` or `@sigmacomputing/plugin/react`

package/CONTRIBUTING.md

@@ -1,60 +0,0 @@
-## Initial setup
-
-Start by forking the `@sigmacomputing/plugin` repo and cloning it locally.
-
-```shs
-git clone https://github.com/your-username/sigmacomputing-plugin.git
-```
-
-Navigate to the `sigmacomputing-plugin` directory and install the required
-dependencies with the following commands:
-
-```sh
-# Ensure you have node version 16 installed (suggestion: v16.13.1).
-nvm install
-yarn install
-```
-
-## Start Developing
-
-You can run any of the scripts located in the `package.json` using:
-
-```sh
-yarn <script-name>
-```
-
-For example, you can run the build process with
-
-```sh
-yarn build
-# Or in watch mode
-yarn build:watch
-```
-
-### Add tests
-
-Unit tests ensure that `@sigmacomputing/plugin` doesn't break accidentally. If
-your code can regress in non-obvious ways, include unit tests with your PR. Use
-the following naming convention:
-
-```
-+-- parentFolder
-|   +-- __tests__
-|       +-- [filename].test.ts
-|   +-- [filename].ts
-```
-
-Our unit test suite uses [jest](https://jestjs.io/)
-
-## Submit a pull request
-
-Before submitting your contribution, run the test suite one last time with:
-
-```sh
-yarn test
-```
-
-Doing this prevents last-minute bugs and is also a great way to get your
-contribution merged faster once you submit your pull request. Failing to do so
-will lead to one of the maintainers mark the pull request with the Work in
-Progress label until all tests pass.

package/assets/sigma-logo-dark.svg

@@ -1,54 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!-- Generator: Adobe Illustrator 24.2.1, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
-<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px"
-	y="0px" viewBox="0 0 841.9 595.3" style="enable-background:new 0 0 841.9 595.3;" xml:space="preserve">
-	<style type="text/css">
-		.st0 {
-			fill: #00C3AF;
-		}
-
-		.st1 {
-			fill: #FFFFFF;
-		}
-	</style>
-	<g>
-		<g>
-			<polygon class="st0" points="279.2,379.8 205.4,347.7 253.1,347.7 		" />
-			<polygon class="st0" points="233.3,315.1 285.6,379.2 264.8,281.4 		" />
-			<polygon class="st0" points="164.4,246.8 229.5,311.3 261,277.7 		" />
-			<polygon class="st0" points="289.8,247.5 265.4,273.6 241.8,266.1 		" />
-			<polygon class="st0" points="295,249.8 281.1,263.8 318.8,264.5 		" />
-		</g>
-		<g>
-			<g>
-				<path class="st1" d="M372.1,291.1h15v60.2h-15V291.1z" />
-			</g>
-			<g>
-				<path class="st1" d="M459.7,291.1v51.7c0,27.1-12.8,38.8-33,38.8c-12.1,0-22.7-6.7-27.8-17.7l12.1-5.7c2.9,5.9,9.3,9.8,15.7,9.8
-				c11.3,0,18.4-6.7,18.4-23.8v-0.9c-4.2,6.2-12.3,9.3-19.5,9.3c-15.5,0-28.9-12.2-28.9-31.5c0-19.3,13.3-31.3,28.8-31.3
-				c7.6,0,15.5,3,19.6,9.2v-7.9H459.7z M444.8,321c0-10.6-8.6-17.3-17-17.3c-9.1,0-16.5,7.2-16.5,17.3s7.4,17.5,16.5,17.5
-				C436.8,338.5,444.8,331.6,444.8,321z" />
-			</g>
-			<g>
-				<path class="st1" d="M567.5,317.5v33.8h-14.8v-32.6c0-9.7-5-14.4-12-14.4c-8.6,0-14.1,6.4-13.4,17.3l-0.1-0.5v30.3h-15v-32.6
-				c0-9.7-5-14.4-11.5-14.4c-7,0-13.9,3.9-13.9,15.3v31.7h-15v-60.2h15v10.3c2.2-7.6,10.4-11.6,17.9-11.6c8.8,0,16,4.1,19.5,11.9
-				c4.8-9.5,14.2-11.9,20.2-11.9C559.5,289.8,567.5,300,567.5,317.5z" />
-			</g>
-			<g>
-				<path class="st1"
-					d="M312.1,332.6H327c0,4.1,3.8,8,10.5,8c6.3,0,10.4-2.7,10.4-6.6c0-3.4-2.7-4.9-7.5-5.9l-8.5-2.1
-				c-14.3-3.6-18-10.8-18-18.4c0-9.4,9.8-17.7,23.7-17.7c11.3,0,24.1,5.3,24,18.8h-15.1c0-4.3-4-6.8-8.5-6.8c-4.9,0-8.3,2.6-8.3,6.3
-				c0,3.1,3.1,4.9,6.8,5.7l10.2,2.6c14.3,3.5,16.9,12,16.9,17.5c0,12.2-13,18.7-25.9,18.7C325.1,352.7,312.4,345.5,312.1,332.6z" />
-			</g>
-			<g>
-				<ellipse class="st1" cx="379.6" cy="276.5" rx="9" ry="9.3" />
-			</g>
-			<g>
-				<path class="st1" d="M632.6,315.3v36h-14.7v-8c-4,5.5-12.6,9.3-20.6,9.3c-12.5,0-21.5-7.3-21.5-18.7c0-12.1,10.4-18.8,23.7-18.8
-				c6.8,0,13.7,1.7,18.4,4.3v-3.6c0-7.6-5.2-12.9-13.6-12.9c-7.2,0-14,2.7-17.1,6.4l-8.1-8.5c4.9-6.6,15.1-11,26.1-11
-				C621.1,289.8,632.6,298.8,632.6,315.3z M617.9,331.8v-2.4c-3.9-2.4-10.1-4-15.8-4c-8.2,0-12.3,3.6-12.3,7.9
-				c0,4.3,3.9,7.1,10.3,7.1C606.6,340.4,614.3,337.1,617.9,331.8z" />
-			</g>
-		</g>
-	</g>
-</svg>

package/assets/sigma-logo-light.svg

@@ -1,50 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!-- Generator: Adobe Illustrator 24.2.1, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
-<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px"
-	y="0px" viewBox="0 0 841.9 595.3" style="enable-background:new 0 0 841.9 595.3;" xml:space="preserve">
-	<style type="text/css">
-		.st0 {
-			fill: #00C3AF;
-		}
-	</style>
-	<g>
-		<g>
-			<polygon class="st0" points="255.8,388.4 153.6,344 219.7,344 		" />
-			<polygon class="st0" points="192.3,298.8 264.6,387.6 235.9,252.2 		" />
-			<polygon class="st0" points="96.9,204.4 187,293.7 230.6,247.1 		" />
-			<polygon class="st0" points="270.4,205.3 236.6,241.4 204.1,231 		" />
-			<polygon class="st0" points="277.6,208.4 258.5,227.8 310.6,228.8 		" />
-		</g>
-		<g>
-			<g>
-				<path d="M384.4,265.7h20.7V349h-20.7V265.7z" />
-			</g>
-			<g>
-				<path d="M505.6,265.7v71.6c0,37.5-17.8,53.7-45.6,53.7c-16.7,0-31.4-9.3-38.5-24.4l16.7-7.9c4,8.2,12.9,13.6,21.8,13.6
-				c15.7,0,25.4-9.3,25.4-33v-1.2c-5.7,8.6-17.1,12.8-27,12.8c-21.4,0-40.1-17-40.1-43.5c0-26.8,18.5-43.4,39.9-43.4
-				c10.5,0,21.4,4.1,27.2,12.7v-10.9H505.6z M485,307c0-14.6-11.8-23.9-23.5-23.9c-12.5,0-22.8,10-22.8,23.9s10.3,24.3,22.8,24.3
-				C473.9,331.3,485,321.7,485,307z" />
-			</g>
-			<g>
-				<path d="M654.8,302.2V349h-20.5v-45.1c0-13.4-7-20-16.6-20c-12,0-19.4,8.9-18.6,23.9L599,307V349h-20.7v-45.1
-				c0-13.4-7-20-15.9-20c-9.6,0-19.3,5.4-19.3,21.2V349h-20.7v-83.3h20.7v14.3c3-10.5,14.5-16.1,24.8-16.1
-				c12.1,0,22.1,5.7,26.9,16.4c6.6-13.2,19.6-16.4,28-16.4C643.8,263.9,654.8,278,654.8,302.2z" />
-			</g>
-			<g>
-				<path d="M301.4,323.1h20.6c0,5.7,5.3,11.1,14.5,11.1c8.7,0,14.3-3.7,14.3-9.1c0-4.6-3.8-6.8-10.4-8.2l-11.7-2.9
-				c-19.8-5-24.9-15-24.9-25.5c0-13,13.6-24.4,32.8-24.4c15.7,0,33.4,7.3,33.2,26.1h-20.9c0-5.9-5.5-9.5-11.7-9.5
-				c-6.8,0-11.5,3.6-11.5,8.7c0,4.3,4.3,6.8,9.4,7.9l14.2,3.6c19.8,4.8,23.4,16.6,23.4,24.3c0,17-17.9,25.9-35.9,25.9
-				C319.3,351,301.7,341,301.4,323.1z" />
-			</g>
-			<g>
-				<ellipse cx="394.7" cy="245.4" rx="12.4" ry="12.9" />
-			</g>
-			<g>
-				<path d="M744.9,299.2V349h-20.4v-11.1c-5.6,7.7-17.5,12.8-28.5,12.8c-17.3,0-29.7-10.2-29.7-25.9c0-16.8,14.4-26.1,32.8-26.1
-				c9.3,0,19,2.3,25.5,5.9v-5c0-10.5-7.1-17.8-18.9-17.8c-10,0-19.4,3.7-23.6,8.9L670.9,279c6.8-9.1,20.9-15.2,36.2-15.2
-				C729,263.9,744.9,276.4,744.9,299.2z M724.6,322v-3.4c-5.4-3.4-13.9-5.5-21.9-5.5c-11.4,0-17,5-17,10.9c0,5.9,5.4,9.8,14.3,9.8
-				C708.9,333.8,719.6,329.3,724.6,322z" />
-			</g>
-		</g>
-	</g>
-</svg>

package/jest.config.ts

@@ -1,22 +0,0 @@
-import path from 'path';
-import { Config } from '@jest/types';
-
-const config: Config.InitialOptions = {
-  globals: {
-    'ts-jest': {
-      tsconfig: path.resolve(__dirname, 'tsconfig.json'),
-      isolatedModules: true,
-    },
-  },
-
-  preset: 'ts-jest',
-  testEnvironment: 'jsdom',
-  testMatch: ['<rootDir>/src/**/*.{spec,test}.{js,jsx,ts,tsx}'],
-
-  watchPlugins: [
-    'jest-watch-typeahead/filename',
-    'jest-watch-typeahead/testname',
-  ],
-};
-
-export default config;

package/src/client/__tests__/initialize.test.ts

@@ -1,30 +0,0 @@
-import { initialize } from '../initialize';
-
-describe('initialize', () => {
-  let originalAddEventListener: any;
-  let originalRemoveEventListener: any;
-
-  beforeAll(() => {
-    originalAddEventListener = window.addEventListener;
-    originalRemoveEventListener = window.removeEventListener;
-    window.addEventListener = jest.fn();
-    window.removeEventListener = jest.fn();
-  });
-
-  beforeEach(() => {
-    jest.resetAllMocks();
-  });
-
-  it('should initialize and be destroyable', () => {
-    const client = initialize();
-    expect(window.addEventListener).toHaveBeenCalled();
-
-    client.destroy();
-    expect(window.removeEventListener).toHaveBeenCalled();
-  });
-
-  afterAll(() => {
-    window.addEventListener = originalAddEventListener;
-    window.removeEventListener = originalRemoveEventListener;
-  });
-});

package/tsconfig.build.json

@@ -1,9 +0,0 @@
-{
-  "extends": "./tsconfig",
-  "compilerOptions": {
-    "outDir": "./dist",
-    "rootDir": "./src"
-  },
-  "include": ["src"],
-  "exclude": ["node_modules", "src/**/__tests__/**"]
-}

package/tsconfig.json

@@ -1,36 +0,0 @@
-{
-  "compilerOptions": {
-    "lib": ["ESNext", "DOM", "DOM.Iterable"],
-    "module": "CommonJS",
-    "moduleResolution": "node",
-    "target": "ES2015",
-
-    "baseUrl": "./",
-    "paths": {
-      "*": ["src/*"]
-    },
-
-    "declaration": true,
-    "declarationMap": true,
-
-    "jsx": "react-jsx",
-    "downlevelIteration": true,
-    "noImplicitAny": true,
-    "strict": true,
-
-    "allowSyntheticDefaultImports": true,
-    "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": true,
-    "skipLibCheck": true,
-    "resolveJsonModule": true,
-
-    "plugins": [
-      {
-        "transform": "typescript-transform-paths",
-        "exclude": ["**/node_modules/**"],
-        "afterDeclarations": true
-      }
-    ]
-  },
-  "include": ["src", "jest.config.ts"]
-}