@cosmos.gl/graph 2.6.2-rc.0 → 2.7.0-beta.0

package/.eslintrc

@@ -0,0 +1,147 @@
+{
+  "extends": [
+    "plugin:@typescript-eslint/recommended",
+    "standard"
+  ],
+  "env": {
+    "es6": true,
+    "node": true,
+    "browser": true
+  },
+  "plugins": [
+    "import",
+    "unicorn"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "project": "./tsconfig.json"
+  },
+  "rules": {
+    "object-curly-spacing": ["error", "always"],
+    "prefer-template": "error",
+    "no-useless-constructor": "off",
+    "import/extensions": 0,
+    "import/no-extraneous-dependencies": 0,
+    "import/no-default-export": "error",
+    "import/prefer-default-export": 0,
+    "import/first": ["error", "absolute-first"],
+    "import/order": ["error", 
+      {
+        "groups": ["builtin", "external", "internal", "parent", "sibling", "index", "object"],
+        "pathGroups": [
+          {
+            "pattern": "@/**",
+            "group": "internal"
+          }
+        ],
+      }
+    ],
+    "comma-dangle": ["error", {
+      "arrays": "always-multiline",
+      "objects": "always-multiline",
+      "imports": "always-multiline",
+      "exports": "always-multiline",
+      "functions": "never"
+    }],
+    "indent": ["error", 2],
+    "consistent-return": "error",
+    "no-console": ["error", { "allow": ["warn", "error"] }],
+    "no-undef": 0,
+    "no-unused-expressions": "off",
+    "no-multiple-empty-lines": 2,
+    "no-use-before-define": "off",
+    "@typescript-eslint/no-use-before-define": ["error", {"variables": false}],
+    "no-unused-vars": "off",
+    "@typescript-eslint/no-unused-vars": ["error"],
+    "@typescript-eslint/no-unused-expressions": ["error"],
+    "@typescript-eslint/no-explicit-any": ["error"],
+    "@typescript-eslint/indent": "off",
+    "@typescript-eslint/type-annotation-spacing": ["error"],
+    "@typescript-eslint/member-delimiter-style": ["error", {
+      "multiline": {
+        "delimiter": "semi",
+        "requireLast": true
+      },
+      "singleline": {
+        "delimiter": "semi",
+        "requireLast": false
+      }
+    }],
+    "@typescript-eslint/member-ordering": "error",
+    "@typescript-eslint/explicit-member-accessibility": "error",
+    "@typescript-eslint/explicit-function-return-type": "error",
+    "@typescript-eslint/naming-convention": [
+      "error",
+      {
+        "selector": "default",
+        "format": ["camelCase"],
+        "leadingUnderscore": "allow",
+        "trailingUnderscore": "allow"
+      },
+      {
+        "selector": "import",
+        "format": ["camelCase", "PascalCase"]
+      },
+      {
+        "selector": "classProperty",
+        "format": ["camelCase", "UPPER_CASE"],
+        "leadingUnderscore": "allow",
+        "trailingUnderscore": "allow"
+      },
+      {
+        "selector": "classProperty",
+        "types": ["boolean"],
+        "format": ["PascalCase"],
+        "prefix": ["is", "should", "has", "can", "did", "will", "are"],
+        "leadingUnderscore": "allow",
+        "trailingUnderscore": "allow"
+      },
+      {
+        "selector": "function",
+        "format": ["camelCase", "PascalCase"],
+        "modifiers": ["exported"],
+        "leadingUnderscore": "allow",
+        "trailingUnderscore": "allow"
+      },
+      {
+        "selector": "variable",
+        "format": ["camelCase", "UPPER_CASE"],
+        "leadingUnderscore": "allow",
+        "trailingUnderscore": "allow"
+      },
+      {
+        "selector": "variable",
+        "modifiers": ["exported"],
+        "format": ["camelCase", "UPPER_CASE", "PascalCase"]
+      },
+      {
+        "selector": "typeLike",
+        "format": ["PascalCase"]
+      },
+      {
+        "selector": "enumMember",
+        "format": ["PascalCase"]
+      },
+      {
+        "selector": "property",
+        "leadingUnderscore": "allowSingleOrDouble",
+        "format": ["camelCase", "snake_case", "UPPER_CASE"]
+      }
+    ],
+    "max-len": ["warn", { "code": 160, "comments": 160 }],
+    "unicorn/filename-case": "error",
+    "unicorn/no-for-loop": "error",
+    "unicorn/prefer-array-some": "error",
+    "unicorn/no-instanceof-array": "error",
+    "unicorn/prefer-includes": "error",
+    "unicorn/prefer-keyboard-event-key": "error"
+  },
+  "overrides": [
+    {
+      "files": ["src/stories/**/*.ts"],
+      "rules": {
+        "no-console": "off"
+      }
+    }
+  ]
+}

package/.github/SECURITY.md

@@ -0,0 +1,13 @@
+# Security Policy
+
+## Supported Versions
+
+Security updates are applied only to the latest release.
+
+## Reporting a Vulnerability
+
+If you have discovered a security vulnerability in this project, please report it privately. **Do not disclose it as a public issue.** This gives us time to work with you to fix the issue before public exposure, reducing the chance that the exploit will be used before a patch is released.
+
+Please disclose it at [security advisory](https://github.com/cosmograph-org/cosmos/security/advisories/new).
+
+This project is maintained by a team of volunteers on a reasonable-effort basis. As such, please give us at least 90 days to work on a fix before public exposure.

package/.github/dco.yml

@@ -0,0 +1,4 @@
+allowRemediationCommits:
+  individual: true
+require:
+  members: false

package/.github/workflows/github_pages.yml

@@ -0,0 +1,54 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Cache dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.npm
+          key: npm-${{ hashFiles('package-lock.json') }}
+          restore-keys: npm-
+      - name: Build
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+      - run: npm install -g npm@10
+      - run: npm ci
+      - run: npm run build:storybook -- -o _site
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

package/.storybook/main.ts

@@ -0,0 +1,26 @@
+import type { StorybookConfig } from "@storybook/html-vite";
+import remarkGfm from 'remark-gfm';
+
+const config: StorybookConfig = {
+  stories: ["../src/**/*.mdx", "../src/**/*.stories.@(js|jsx|mjs|ts|tsx)"],
+  addons: [
+    "@jls-digital/storybook-addon-code",
+    "@storybook/addon-essentials",
+    "@storybook/addon-interactions",
+    {
+      name: '@storybook/addon-docs',
+      options: {
+        mdxPluginOptions: {
+          mdxCompileOptions: {
+            remarkPlugins: [remarkGfm],
+          },
+        },
+      },
+    },
+  ],
+  framework: {
+    name: "@storybook/html-vite",
+    options: {},
+  },
+};
+export default config;

package/.storybook/manager-head.html

@@ -0,0 +1 @@
+<link rel="icon" type="image/png" href="https://cosmograph.app/img/favicon.png" />

package/.storybook/manager.ts

@@ -0,0 +1,14 @@
+import { addons } from '@storybook/manager-api';
+import { create } from '@storybook/theming';
+ 
+const theme = create({
+  base: 'dark',
+  brandTitle: 'cosmos.gl',
+  brandUrl: 'https://cosmosgl.github.io/graph',
+  brandImage: 'https://d.cosmograph.app/cosmos-dark-theme.svg',
+  brandTarget: '_self',
+});
+
+addons.setConfig({
+  theme,
+});

package/.storybook/preview.ts

@@ -0,0 +1,29 @@
+import type { Preview } from "@storybook/html";
+import { themes } from '@storybook/theming';
+
+import './style.css';
+
+const preview: Preview = {
+  parameters: {
+    layout: 'fullscreen',
+    controls: {
+      disable: true,
+      matchers: {
+        color: /(background|color)$/i,
+        date: /Date$/i,
+      },
+    },
+    docs: {
+      theme: themes.dark,
+    },
+    backgrounds: {
+      default: 'dark',
+      values: [
+        { name: 'light', value: '#fff' },
+        { name: 'dark', value: '#192132' },
+      ],
+    },
+  },
+};
+
+export default preview;

package/.storybook/style.css

@@ -0,0 +1,3 @@
+tr:nth-of-type(2n) {
+  background-color: #1e2326;
+}

package/CHARTER.md

@@ -0,0 +1,69 @@
+# cosmos.gl Charter
+
+## **Section 0: Guiding Principles**
+
+**Mission:** Provide the web development community with a high-performance framework for visualizing network graphs and scatter plots.
+
+**Vision:** Deliver fast, robust, open-source data visualization tools that empower interactive, scalable analysis in the browser.
+
+**Values:**
+
+- **Performance First:** Prioritize speed and efficiency in every feature and implementation.  
+- **Accessibility:** Ensure the API is intuitive and the tooling easy to adopt, lowering barriers for developers.  
+- **Community:** Foster open collaboration, welcoming contributions and feedback.  
+- **Transparency:** Maintain clear documentation, benchmarks, and decision-making processes.
+
+## **Section 1: Scope**
+
+cosmos.gl is a browser-native, GPU-accelerated force-directed graph layout and rendering engine designed to visualize and interact with massive, complex datasets at scale. By leveraging WebGL, it delivers fast simulations and real-time rendering of millions of nodes and edges directly in the browser. cosmos.gl bridges the gap between high-performance data visualization and interactive web-based research workflows, serving developers, researchers, and analysts. Its value lies in unlocking scalable, explainable graph exploration for AI, biotech, finance, and data science stakeholders.
+
+### **1.1: In-scope**
+
+- GPU-accelerated graph algorithms  
+- WebGL- and WebGPU-based rendering of large-scale network graph and machine learning embeddings  
+- Browser-native integration with frontend tooling and workflows
+
+### **1.2: Out-of-Scope**
+
+- Server-side computation, backend data processing and pipelines
+- Native desktop or mobile applications (outside browser environment)
+- Direct integration with domain-specific tools
+
+## **Section 2: Relationship with OpenJS Foundation CPC**
+
+Technical leadership of the cosmos.gl project is delegated to the cosmos.gl Technical Steering Committee (TSC) by the OpenJS Cross Project Council (CPC). Amendments to this charter require approval from both the CPC, through its [decision-making process](https://github.com/openjs-foundation/cross-project-council/blob/master/CPC-CHARTER.md#section-9-decision-making), and the TSC.
+
+## **Section 3: Technical Steering Committee (TSC)**
+
+TSC members may attend meetings, participate in discussions, and vote on all matters before the TSC.
+
+TSC memberships are not time-limited. There is no maximum size of the TSC. 
+
+There is no specific set of requirements or qualifications for TSC membership beyond these rules. A TSC member can be removed from the TSC by voluntary resignation or by a standard TSC motion.
+
+The TSC shall meet regularly using tools that enable participation by the community. The meeting shall be directed by the TSC chairperson. Responsibility for directing individual meetings may be delegated by the TSC chairperson to any other TSC member. Minutes or an appropriate recording shall be taken and made available to the community through accessible public postings.
+
+TSC members are expected to regularly participate in TSC activities.
+
+The TSC chairperson is elected by a simple majority vote of all TSC members. The chairperson serves until they resign or are replaced by a TSC vote. Any TSC member may call for a vote at any time, provided the proposal is made in writing and shared with the full TSC. Votes may be held in meetings or asynchronously using any communication tool commonly used by the TSC.
+
+## **Section 4: Roles & Responsibilities**
+The roles and responsibilities of cosmos.gl's TSC are described in [GOVERNANCE.md](./GOVERNANCE.md).
+
+### **Section 4.1 Project Operations & Management**
+The Project Operations & Management processes are defined in [GOVERNANCE.md](./GOVERNANCE.md).
+
+### **Section 4.2: Decision-making, Voting, and/or Elections**
+
+Project decisions shall operate under a model of Lazy Consensus by default. The TSC shall define appropriate guidelines for implementing Lazy Consensus (e.g., notification periods, review windows) within the development process.
+
+When consensus cannot be reached, the TSC shall decide via public voting.
+
+Each vote presents the available options in a format that supports clear expression of member preferences—this may include polls, emoji reactions, checklists, or comparable methods. TSC members may vote for one or more options or abstain. Unless otherwise specified, the winning option is the one that receives the greatest support among participating members.
+
+For decisions involving three or more options, the TSC may optionally conduct pairwise comparisons between all candidates. In such cases, the winner is the candidate who secures a simple majority against every other candidate in head-to-head matchups (Condorcet winner). All votes are public, and voting activity may be adjusted until the close of the voting period.
+
+## **Section 5: Definitions**
+### **Agenda Item**
+
+An agenda item is a specific topic, proposal, or issue scheduled for discussion or decision during a TSC meeting. Examples include proposed technical changes, governance matters, or any subject requiring TSC review or input. Agenda items are published in advance to allow TSC members and the community to prepare for discussion or decision-making.

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,178 @@
+# Code of Conduct
+
+Cosmos, as member project of the OpenJS Foundation, use [Contributor Covenant
+v2.0](https://contributor-covenant.org/version/2/0/code_of_conduct) as their
+code of conduct. The full text is included
+[below](#contributor-covenant-code-of-conduct) in English, and translations are
+available from the Contributor Covenant organisation:
+
+- [contributor-covenant.org/translations](https://www.contributor-covenant.org/translations)
+- [github.com/ContributorCovenant](https://github.com/ContributorCovenant/contributor_covenant/tree/release/content/version/2/0)
+
+Refer to the sections on reporting and escalation in this document for the
+specific emails that can be used to report and escalate issues.
+
+## Reporting
+
+### Project Spaces
+
+For reporting issues in spaces related to cosmos.gl please use the email
+`cosmosgl@rokotyan.com`. Cosmos.gl handles CoC issues
+related to the spaces that it maintains. Projects maintainers commit to:
+
+- maintain the confidentiality with regard to the reporter of an incident
+- to participate in the path for escalation as outlined in the section on
+  Escalation when required.
+
+### Foundation Spaces
+
+For reporting issues in spaces managed by the OpenJS Foundation, for example,
+repositories within the OpenJS organization, use the email
+`report@lists.openjsf.org`. The Cross Project Council (CPC) is responsible for
+managing these reports and commits to:
+
+- maintain the confidentiality with regard to the reporter of an incident
+- to participate in the path for escalation as outlined in the section on
+  Escalation when required.
+
+## Escalation
+
+The OpenJS Foundation maintains a Code of Conduct Panel (CoCP). This is a
+foundation-wide team established to manage escalation when a reporter believes
+that a report to a member project or the CPC has not been properly handled. In
+order to escalate to the CoCP send an email to
+`coc-escalation@lists.openjsf.org`.
+
+For more information, refer to the full [Code of Conduct governance
+document](https://github.com/openjs-foundation/cross-project-council/blob/HEAD/CODE_OF_CONDUCT.md).
+
+---
+
+## Contributor Covenant Code of Conduct v2.0
+
+### Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+### Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+### Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+### Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+### Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at the email
+addresses listed above in the [Reporting](#reporting) and
+[Escalation](#escalation) sections. All complaints will be reviewed and
+investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+### Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+#### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+#### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+#### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+#### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+project community.
+
+### Attribution
+
+This Code of Conduct is adapted from the [Contributor
+Covenant](https://www.contributor-covenant.org), version 2.0, available at
+[contributor-covenant.org/version/2/0/code_of_conduct](https://www.contributor-covenant.org/version/2/0/code_of_conduct).
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+For answers to common questions about this code of conduct, see the FAQ at
+[contributor-covenant.org/faq](https://www.contributor-covenant.org/faq).
+Translations are available at
+[contributor-covenant.org/translations](https://www.contributor-covenant.org/translations).

package/CONTRIBUTING.md

@@ -0,0 +1,22 @@
+# Contributing to _Cosmos_
+We want to make contributing to this project as easy and transparent as possible.
+
+## Code of Conduct
+cosmos.gl has a Code of Conduct that we expect project participants to adhere
+to. Please read [the full text](https://github.com/cosmos.gl/graph/CODE_OF_CONDUCT.md) so that you can understand
+what actions will and will not be tolerated.
+
+## Our Development Process
+We use Storybook to simplify the development process. You can start it by running `npm run storybook` in the root directory.
+If you've added a new feature, changed the configuration or public methods, please add a new example with its source code to Storybook if applicable and suggest changes to the docs.
+
+## Pull Requests
+We actively welcome pull requests. If you want to submit one, please follow the following process:
+
+1. Fork the repo and create your branch from `main`;
+2. Code;
+3. Make sure the project lints and builds after your changes;
+4. Submit your PR!
+
+## License
+By contributing to _Cosmos_, you agree that your contributions will be licensed its MIT license.

package/GOVERNANCE.md

@@ -0,0 +1,21 @@
+# cosmos.gl Governance Guidelines
+
+The [TSC Charter](./CHARTER.md) governs the operations of the TSC. All changes to the Charter need approval by the OpenJS Foundation Cross-Project Council (CPC).
+
+The TSC oversees all technical development in the cosmos.gl project, as long as it follows policies set by CPC, including:
+- Setting release dates.  
+- Release quality standards.  
+- Technical direction.  
+- Project governance and process.  
+- GitHub repository hosting.  
+- Conduct guidelines.  
+- Maintaining the list of additional collaborators.  
+- Development process and any coding standards.  
+- Mediating technical conflicts between collaborators or foundation projects.
+
+The TSC will define cosmos.gl project’s release vehicles.
+
+### **Project Operations & Management**
+The TSC will establish and maintain a development process for the cosmos.gl project. The development process will establish guidelines for how the developers and community will operate. It will, for example, establish appropriate timelines for TSC review (e.g. agenda items must be published at least a certain number of hours in advance of a TSC meeting).
+
+The TSC and entire technical community will follow any processes as may be specified by the OpenJS Foundation Board relating to the intake and license compliance review of contributions, including the OpenJS Foundation IP Policy.