Merge pull request #56 from commitd/stuarthendren/separation

Separates rdf and JSONGraph into modules

Author: stuarthendren

.github/workflows/ci.yml

@@ -98,6 +98,8 @@ jobs:
           path: |
             ./packages/all/dist
             ./packages/graph/dist
+            ./packages/graph-rdf/dist
+            ./packages/graph-json/dist
             ./packages/react/dist
           retention-days: 1
   unit-test-scan:
@@ -288,6 +290,11 @@ jobs:
           key: ${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}
           restore-keys: |
             ${{ runner.os }}-npm-
+      - name: Download build artifacts
+        uses: actions/download-artifact@v2
+        with:
+          name: build-output
+          path: packages
       - name: Publish Storybook
         if: github.ref == 'refs/heads/main'
         run: npm run storybook:deploy

README.md

@@ -37,6 +37,8 @@ This builds to the relevant `/dist` folders.
 The project is published as `@committed/components-graph` but is further separated into modules so the non-ui code can be used in the backend.
 
 - `@committed/graph` - contains the graph models, types and API
+- `@committed/graph-rdf` - contains code to create graph models from RDF
+- `@committed/graph-json` - contains code to create graph models from JSONGraph
 - `@committed/component-graph-react` - contains the react specific UI components
 
 ### Storybook

package-lock.json

@@ -94,6 +94,8 @@
     "preset": "rollpkg",
     "projects": [
       "<rootDir>/packages/graph",
+      "<rootDir>/packages/graph-json",
+      "<rootDir>/packages/graph-rdf",
       "<rootDir>/packages/react",
       "<rootDir>/packages/all"
     ],
@@ -170,6 +172,8 @@
   },
   "workspaces": [
     "packages/graph",
+    "packages/graph-rdf",
+    "packages/graph-json",
     "packages/react",
     "packages/all"
   ]

package.json

@@ -26,6 +26,8 @@
   },
   "dependencies": {
     "@committed/graph": "*",
+    "@committed/graph-json": "*",
+    "@committed/graph-rdf": "*",
     "@committed/components-graph-react": "*"
   },
   "scripts": {

packages/all/package.json

@@ -1,2 +1,11 @@
 export * from '@committed/graph'
+export * from '@committed/graph-rdf'
 export * from '@committed/components-graph-react'
+
+import { Json } from '@committed/graph-json'
+import { Rdf } from '@committed/graph-rdf'
+
+export const GraphBuilder = {
+  fromJsonGraph: Json.buildGraph,
+  fromRdfGraph: Rdf.buildGraph,
+}

packages/all/src/index.ts

@@ -0,0 +1,70 @@
+{
+  "name": "@committed/graph-json",
+  "version": "0.0.0-development",
+  "description": "Support for creating GraphModels from JSONGraph",
+  "author": "Committed",
+  "private": false,
+  "license": "MIT",
+  "main": "dist/committed-graph-json.cjs.js",
+  "module": "dist/committed-graph-json.esm.js",
+  "typings": "dist/index.d.ts",
+  "sideEffects": false,
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/commitd/components-graph.git"
+  },
+  "bugs": {
+    "url": "https://github.com/commitd/components-graph/issues"
+  },
+  "homepage": "https://github.com/commitd/components-graph#readme",
+  "engines": {
+    "node": ">=10"
+  },
+  "jest": {
+    "preset": "rollpkg",
+    "collectCoverage": true,
+    "testResultsProcessor": "jest-sonar-reporter",
+    "moduleDirectories": [
+      "node_modules",
+      "src"
+    ],
+    "collectCoverageFrom": [
+      "src/**/*.{ts,tsx}",
+      "!src/types/**/*"
+    ],
+    "coveragePathIgnorePatterns": [
+      "/src/typings.d.ts",
+      "test/*",
+      ".*/index.ts",
+      ".*.test.ts",
+      ".*.test.tsx",
+      ".*.stories.tsx"
+    ]
+  },
+  "lint-staged": {
+    "*.{ts,tsx}": [
+      "jest --bail --passWithNoTests"
+    ]
+  },
+  "scripts": {
+    "clean": "shx rm -rf dist",
+    "build": "rollpkg build --noStats --tsconfig ./tsconfig.build.json",
+    "watch": "rollpkg watch",
+    "lint": "eslint './src/**/*.{ts,tsx}'",
+    "test": "jest --passWithNoTests",
+    "test:ci": "jest --coverage",
+    "test:watch": "jest --watchAll",
+    "precommit": "lint-staged"
+  },
+  "dependencies": {
+    "@committed/graph": "*",
+    "uuid": "^8.3.2"
+  }
+}

packages/graph-json/package.json

@@ -1,13 +1,9 @@
-import {
-  largeGraph,
-  smallGraph,
-  veryLargeGraph,
-} from 'test/data/jsonGraphExamples'
-import { fromJsonGraph } from './fromJsonGraph'
-import { JSONGraph, ModelNode } from './types'
+import { largeGraph, smallGraph, veryLargeGraph } from 'examples'
+import { buildGraph, Graph as JSONGraph } from 'JsonGraph'
+import { ModelNode } from '@committed/graph'
 
 it('Create from json graph spec graph values', () => {
-  const contentModel = fromJsonGraph(smallGraph)
+  const contentModel = buildGraph(smallGraph)
   expect(Object.keys(contentModel.nodes)).toHaveLength(4)
   expect(Object.keys(contentModel.edges)).toHaveLength(2)
 
@@ -23,7 +19,7 @@ it('Create from json graph spec graph values', () => {
 })
 
 it('Create from json graph', () => {
-  const contentModel = fromJsonGraph({
+  const contentModel = buildGraph({
     nodes: {
       n1: {
         metadata: { a1: true, a2: 10, a3: 'test', a4: { object: 'example' } },
@@ -55,40 +51,40 @@ it('Create from json graph', () => {
 })
 
 it('Create from json graph spec graph values', () => {
-  const contentModel = fromJsonGraph(largeGraph)
+  const contentModel = buildGraph(largeGraph)
   expect(Object.keys(contentModel.nodes)).toHaveLength(9)
   expect(Object.keys(contentModel.edges)).toHaveLength(8)
 })
 
 it('ContentModel does support single from graphs', () => {
-  const contentModel = fromJsonGraph({
+  const contentModel = buildGraph({
     graphs: [smallGraph.graph as JSONGraph],
   })
   expect(Object.keys(contentModel.nodes)).toHaveLength(4)
   expect(Object.keys(contentModel.edges)).toHaveLength(2)
 })
 
 it('Create from json graph spec graph directly', () => {
-  const contentModel = fromJsonGraph(largeGraph.graph as JSONGraph)
+  const contentModel = buildGraph(largeGraph.graph as JSONGraph)
   expect(Object.keys(contentModel.nodes)).toHaveLength(9)
   expect(Object.keys(contentModel.edges)).toHaveLength(8)
 })
 
 it('ContentModel does not support empty from graphs', () => {
   expect(() =>
-    fromJsonGraph({
+    buildGraph({
       graphs: [],
     })
   ).toThrow()
 })
 
 it('ContentModel does not support empty model', () => {
-  expect(() => fromJsonGraph({})).toThrow()
+  expect(() => buildGraph({})).toThrow()
 })
 
 it('ContentModel does not support multiple from graphs', () => {
   expect(() =>
-    fromJsonGraph({
+    buildGraph({
       graphs: [smallGraph.graph as JSONGraph, largeGraph.graph as JSONGraph],
     })
   ).toThrow()
@@ -100,14 +96,14 @@ it('ContentModel does not support hyperedges from graphs', () => {
     hyperedges: smallGraph.graph?.edges,
   } as unknown as JSONGraph
   expect(() =>
-    fromJsonGraph({
+    buildGraph({
       graph: hyperGraph,
     })
   ).toThrow()
 })
 
 it('loads very large graph', () => {
-  const contentModel = fromJsonGraph(veryLargeGraph)
+  const contentModel = buildGraph(veryLargeGraph)
   expect(Object.keys(contentModel.nodes)).toHaveLength(1000)
   expect(Object.keys(contentModel.edges)).toHaveLength(1000)
 })