lincd-cli 0.1.0 → 0.1.4

package/README.md

@@ -1,60 +1,24 @@
-# Setup a new dacore module
-
-`npm install -g @dacore/build-tools`
-
-will install this module globally so you can access the `dacore` command in the command line
-
-`dacore init`
-
-will create npm links to you're previously installed workspace setup (no documentation for that yet!)
-
-## tsconfig
-
-create `tsconfig.json`:
-
-    {
-      "compilerOptions": {
-    	"module": "commonjs",
-    	"sourceMap": true,
-    	"target": "es6",
-    	"outDir": "lib",
-    	"declaration": true,
-    	"jsx":"react",
-    	"types": [
-    	]
-      },
-      "files": [
-    	"./src/index.ts"
-      ],
-      "include" : [
-    	"./node_modules/@dacore/core/builds/dacore.core.d.ts"
-      ]
-    }
-
-and `tsconfig-es5.json`
-
-    {
-      "compilerOptions": {
-    	"module": "commonjs",
-    	"sourceMap": true,
-    	"target": "ES5",
-    	"jsx":"react",
-    	"lib": ["es2017", "dom"],//required to make core-js work, however there are some issues with this, as it potentially ignores warning for targets you don't support. Hence be careful to only use core-js features that you know are specifically included in @dacore/core or @dacore/browser-core-es5
-    	"types": [
-    	]
-      },
-      "files": [
-    	"./src/index.ts"
-      ],
-      "include" : [
-    	"./src/definitions/jison.d.ts",
-    	"./node_modules/@dacore/core/builds/dacore.core.d.ts"
-      ]
-    }
-
-Please do not be tempted to create a symbolic link to your local development version of this package. It will cause trouble, for example when creating new modules.
-If you must, remember to undo it after development.
-
-To upgrade to the latest version run `
-
-    yarn upgrade @dacore/build-tools --latest
+#LINCD CLI
+Command Line Interface for the [lincd.js](https://www.lincd.org) library
+
+### Installation
+
+```
+npm install lincd-cli
+```
+
+or
+
+```
+yarn add lincd-cli
+```
+
+### Usage
+
+type
+
+```
+npm exec lincd help
+```
+
+for available commands

package/defaults/defaultModule/Index.tsx

@@ -1,25 +1,25 @@
-import {React,ReactComponent} from "@dacore/core/lib/shapes/ReactComponent";
-import {UriResource} from "@dacore/core/lib/models/UriResource";
-import ${projectName} from "../ontologies/${projectName}";
-import "./Index.scss";
-import style from "./Index.scss.json";
-export default class Index extends ReactComponent<any,any>
-{
-	static viewType: UriResource = ${projectName}.Index;
-
-	render()
-	{
-		return <div className={style.Index}>
-			<hr />
-			<p>Welcome to your new LINCD setup!</p>
-			<p>
-				To start coding:
-				<ul>
-					<li>Go to <code>/modules/${browserTitle}</code> and run <code>yarn lincd dev</code> to start developing your module</li>
-					<li>Open <code>modules/${browserTitle}/src/views/Index.tsx</code> to edit this page.</li>
-					<li>For pages rendered on the initial page request you currently have to restart the server and refresh the page to see the results (for others you can simply refresh)</li>
-				</ul>
-			</p>
-		</div>
-	}
+import {React,ReactComponent} from "@dacore/core/lib/shapes/ReactComponent";
+import {UriResource} from "@dacore/core/lib/models";
+import ${projectName} from "../ontologies/${projectName}";
+import "./Index.scss";
+import style from "./Index.scss.json";
+export default class Index extends ReactComponent<any,any>
+{
+	static viewType: UriResource = ${projectName}.Index;
+
+	render()
+	{
+		return <div className={style.Index}>
+			<hr />
+			<p>Welcome to your new LINCD setup!</p>
+			<p>
+				To start coding:
+				<ul>
+					<li>Go to <code>/modules/${browserTitle}</code> and run <code>yarn lincd dev</code> to start developing your module</li>
+					<li>Open <code>modules/${browserTitle}/src/views/Index.tsx</code> to edit this page.</li>
+					<li>For pages rendered on the initial page request you currently have to restart the server and refresh the page to see the results (for others you can simply refresh)</li>
+				</ul>
+			</p>
+		</div>
+	}
 }

package/defaults/defaultModule/index.ts

@@ -1,5 +1,5 @@
 import {Core} from "@dacore/core/lib/shapes/Core";
-import {UriResource} from "@dacore/core/lib/models/UriResource";
+import {UriResource} from "@dacore/core/lib/models";
 import {JSONLD} from "@dacore/core/lib/utils/JSONLD";
 import * as ${underscore_ontology_name} from "./ontologies/${ontology_name}"
 import * as Index from "./views/Index"

package/defaults/defaultModule/ontology.ts

@@ -1,4 +1,4 @@
-import {UriResource} from "@dacore/core/lib/models/UriResource";
+import {UriResource} from "@dacore/core/lib/models";
 
 declare var require:any;
 import {JSONLD} from "@dacore/core/lib/utils/JSONLD";

package/defaults/index.ts

@@ -1,5 +1,5 @@
 import {Core} from "@dacore/core/lib/shapes/Core";
-import {UriResource} from "@dacore/core/lib/models/UriResource";
+import {UriResource} from "@dacore/core/lib/models";
 import {JSONLD} from "@dacore/core/lib/utils/JSONLD";
 import * as ${underscore_ontology_name} from "./ontologies/${ontology_name}"
 //import * as viewName from "./views/viewName"

package/defaults/module/Gruntfile.js

@@ -0,0 +1,16 @@
+var buildTools = require('lincd-cli');
+module.exports = buildTools.generateGruntConfig('${module_name}', {
+	externals: {
+		react: 'React',
+		'react-dom': 'ReactDOM',
+	}, //list of non lincd modules that are already loaded and made globally available by one of the dependencies of this module
+	//internals: [],//list of lincd modules that you want to INCLUDE in the bundle (as opposed to the module its own bundle being a dependency)
+	//alias:{},//webpack alias -> maps on type of npm path to another
+	//target:"es5"|"es6",
+	//environment:"server"|"frontend",
+	//outputPath:string,
+	//es5Server:boolean
+	//es5:{},//es5 specific config, use same properties as above
+	//es6:{},//es6 specific config, use same properties as above
+	//debug:false,//debug the build process
+});

package/defaults/module/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "${module_name}",
+  "version": "0.1.0",
+  "description": "",
+  "lincd": true,
+  "main": "lib/index.js",
+  "types": "dist/lincd.${name}.d.ts",
+  "author": "",
+  "license": "ISC",
+  "scripts": {
+    "build": "npm exec lincd build",
+    "dev": "npm exec lincd dev",
+    "prepublishOnly": "npm exec lincd build production",
+    "postpublish": "npm exec lincd publish"
+  },
+  "keywords": [
+    "lincd",
+    "linked data",
+    "interoperable",
+    "semantic web",
+    "web3"
+  ],
+  "dependencies": {
+    "lincd": "^0.1"
+  },
+  "devDependencies": {
+    "lincd-cli": "^0.1"
+  }
+}

package/defaults/module/src/components/ExampleComponent.tsx

@@ -0,0 +1,22 @@
+import React from 'react';
+import {ReactComponent} from 'lincd/lib/shapes/ReactComponent';
+import {ExampleShapeClass} from '../shapes/ExampleShapeClass';
+import {linkedComponent} from '../module';
+
+/**
+ * By linking this component to a Shape class (a class that extends Shape) you ensure this.source will be an instance of that class
+ */
+@linkedComponent(ExampleShapeClass)
+//for correct typings, please provide the same class as third type parameter of ReactComponent, after property & state interfaces
+export class ExampleComponent extends ReactComponent<
+	any,
+	any,
+	ExampleShapeClass
+> {
+	render() {
+		let exampleInstance = this.source;
+
+		//get the name of this item from the graph
+		return <h1>Hello {exampleInstance.name}!</h1>;
+	}
+}

package/defaults/module/src/data/example-ontology.json

@@ -0,0 +1,20 @@
+{
+	"@context": {
+		"dc": "http://purl.org/dc/elements/1.1/",
+		"owl": "http://www.w3.org/2002/07/owl#",
+		"rdf": "http://www.w3.org/1999/02/22-rdf-syntax-ns#",
+		"rdfs": "http://www.w3.org/2000/01/rdf-schema#",
+		"test": "http://www.example.com/"
+	},
+	"@graph": [
+		{
+			"@id": "example:ExampleClass",
+			"@type": "rdfs:Class",
+			"rdfs:comment": "This is an example class. You can remove or rename it",
+			"rdfs:isDefinedBy": {
+				"@id": "example:"
+			},
+			"rdfs:label": "Example Class"
+		}
+	]
+}

package/defaults/module/src/data/example-ontology.json.d.ts

@@ -0,0 +1 @@
+export var json: string;

package/defaults/module/src/index.ts

@@ -0,0 +1,7 @@
+import './ontologies/example-ontology';
+
+//SHAPES FIRST
+import './shapes/ExampleShapeClass';
+
+//THEN COMPONENTS
+import './components/ExampleComponent';

package/defaults/module/src/module.ts

@@ -0,0 +1,9 @@
+import {linkedModule} from 'lincd/lib/utils/Module';
+export const {
+	linkedComponent,
+	linkedShape,
+	linkedUtil,
+	linkedOntology,
+	registerModuleExport,
+	moduleExports,
+} = linkedModule('${module_name}');

package/defaults/module/src/ontologies/example-ontology.ts

@@ -0,0 +1,33 @@
+import {NamedNode} from 'lincd/lib/models';
+import {JSONLD} from 'lincd-jsonld/lib/JSONLD';
+import {createNameSpace} from 'lincd/lib/utils/NameSpace';
+import {linkedOntology} from '../module';
+
+export var loadData = () => {
+	return import('../data/example-ontology.json').then((data) =>
+		JSONLD.parse(data),
+	);
+};
+
+export var ns = createNameSpace('${uri_base}');
+
+//It's recommended to export a NamedNode for the ontology itself as well
+export var _self: NamedNode = ns('');
+
+//The main goal though of this file is to export a reference to NamedNode with the correct URI
+// for all the entities (Classes and properties) in the ontology
+export var ExampleClass: NamedNode = ns('ExampleClass');
+export var exampleName: NamedNode = ns('exampleName');
+
+export const exampleOntology = {
+	ExampleClass,
+	exampleName,
+};
+
+//finally, we pass on all the exports, plus the namespace, prefix and data loading function
+// as we register this ontology in the LINCD tree
+import * as _this from './example-ontology';
+
+//as third parameter, provide a prefix (string) that can be used to refer to the full ontology URL.
+//for example: 'schema' refers to https://www.schema.org/
+linkedOntology(_this, ns, 'exampl', loadData);

package/defaults/module/src/shapes/ExampleShapeClass.ts

@@ -0,0 +1,30 @@
+import {Shape} from 'lincd/lib/shapes/Shape';
+import {NamedNode} from 'lincd/lib/models';
+import {linkedShape} from '../module';
+import {literalProperty} from 'lincd/lib/utils/ShapeDecorators';
+import {Literal} from 'lincd/lib/models';
+import {schema} from 'lincd-schema/lib/ontologies/schema';
+import {exampleOntology} from '../ontologies/example-ontology';
+
+@linkedShape
+export class ExampleShapeClass extends Shape {
+	/**
+	 * indicates that instances of this shape need to have this rdf.type
+	 */
+	static targetClass: NamedNode = exampleOntology.ExampleClass;
+
+	/**
+	 * instances of this shape need to have exactly one value defined for the given property
+	 */
+	@literalProperty({
+		path: exampleOntology.exampleName,
+		required: true,
+		maxCount: 1,
+	})
+	get name() {
+		return this.getValue(exampleOntology.exampleName);
+	}
+	set name(val: string) {
+		this.overwrite(exampleOntology.exampleName, new Literal(val));
+	}
+}

package/defaults/module/tsconfig-es5.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "sourceMap": true,
+    "target": "es5",
+    "outDir": "lib",
+    "declaration": false,
+    "esModuleInterop": true,
+    "downlevelIteration": true,
+    "experimentalDecorators": true,
+    "skipLibCheck": true,
+    "jsx": "react",
+    "baseUrl": "./",
+    "rootDir": "src"
+  },
+  "files": [
+    "./src/index.ts"
+  ]
+}

package/defaults/module/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "sourceMap": true,
+    "target": "es6",
+    "outDir": "lib",
+    "declaration": true,
+    "esModuleInterop": true,
+    "downlevelIteration": true,
+    "experimentalDecorators": true,
+    "skipLibCheck": true,
+    "jsx": "react",
+    "baseUrl": "./",
+    "rootDir": "src"
+  },
+  "files": [
+    "./src/index.ts"
+  ]
+}

package/defaults/ontology.ts

@@ -1,4 +1,4 @@
-import {UriResource} from "@dacore/core/lib/models/UriResource";
+import {UriResource} from "@dacore/core/lib/models";
 
 declare var require:any;
 import {JSONLD} from "@dacore/core/lib/utils/JSONLD";

package/defaults/package.json

@@ -1,24 +1,28 @@
-{
-	"name": "@dacore/",
-	"license": "UNLICENSED",
-	"version": "0.1.0",
-	"description": "",
-	"main": "lib/index.js",
-	"scripts": {
-		"build": "dacore build"
-	},
-	"keywords": [
-		"dacore",
-		"semantu",
-		"semantic",
-		"web"
-	],
-	"author": "",
-	"license": "ISC",
-	"dependencies": {
-		"@dacore/core": "1.x"
-	},
-	"devDependencies": {
-		"@dacore/build-tools": "1.x"
-	}
-}
+{
+  "name": "@dacore/",
+  "version": "0.1.0",
+  "description": "",
+  "lincd": true,
+  "main": "lib/index.js",
+  "author": "",
+  "license": "ISC",
+  "scripts": {
+    "build": "npm exec lincd build",
+    "dev": "npm exec lincd dev",
+    "prepare": "npm exec lincd build production",
+    "postpublish": "npm exec lincd publish"
+  },
+  "keywords": [
+    "lincd",
+    "linked data",
+    "interoperable",
+    "semantic web",
+    "web3"
+  ],
+  "dependencies": {
+    "lincd": "^0.1"
+  },
+  "devDependencies": {
+    "lincd-cli": "^0.1"
+  }
+}

package/defaults/site/.gitignore

@@ -0,0 +1,8 @@
+**/node_modules
+**/builds
+modules/**/lib
+storage/logs
+storage/uploads
+storage/cached
+storage/filestores/settings-development.jsonld
+.DS_Store

package/defaults/site/.npmignore

@@ -0,0 +1,10 @@
+**/node_modules
+src
+.idea
+Gruntfile.js
+tsconfig.json
+tsconfig-es5.json
+modules
+storage/cached
+storage/uploads
+storage/logs

package/defaults/site/lib/start-server.js

@@ -0,0 +1,22 @@
+const serverCore = require('@dacore/server-core');
+
+serverCore.default
+  .init()
+  .then(() => {
+    const args = process.argv.slice(2);
+    let method;
+    if (args.length > 0) {
+      // console.log("Applying server method: "+args[0]);
+      method = args[0];
+    } else {
+      method = 'startServer';
+    }
+    if (serverCore.default[method]) {
+      serverCore.default[method]();
+    } else {
+      console.warn(`Method ${method} does not exist`);
+    }
+  })
+  .catch((err) => {
+    console.warn(`Could not start server: ${err.stack}`);
+  });

package/defaults/site/lib/test-server.js

@@ -0,0 +1,10 @@
+const serverCore = require('@dacore/server-core');
+
+serverCore.default
+  .init()
+  .then(() => {
+    serverCore.default.runTests();
+  })
+  .catch((err) => {
+    console.warn(`Could not start server: ${err.stack}`);
+  });

package/defaults/site/package.json

@@ -0,0 +1,40 @@
+{
+	"private": true,
+	"name": "${packageName}",
+	"version": "0.2.0",
+	"description": "Server for ${browserTitle}",
+	"main": "lib/index.js",
+	"license": "UNLICENSED",
+	"scripts": {
+		"dev": "node ./lib/start-server.js",
+		"production": "set NODE_ENV=production&& node ./lib/start-server.js"
+	},
+	"directories": {
+		"lib": "lib"
+	},
+	"workspaces": [
+		"modules/*"
+	],
+	"dependencies": {
+		"@dacore/admin": "^0.2",
+		"@dacore/auth": "^0.2",
+		"@dacore/browser-core": "^0.2",
+		"@dacore/core": "1.x",
+		"@dacore/core-editors": "^0.2",
+		"@dacore/coreviews": "^0.2",
+		"@dacore/core-ui": "^0.2",
+		"@dacore/dcterms": "^0.2",
+		"@dacore/forms": "^0.2",
+		"@dacore/html": "^0.2",
+		"@dacore/icons": "^0.2",
+		"@dacore/rdf4j": "^0.2",
+		"@dacore/server-core": "^0.2",
+		"@dacore/website": "^0.2",
+		"@dacore/website-editors": "^0.2",
+        "react": "^18.1",
+        "react-dom": "^18.1"
+	},
+	"devDependencies": {
+		"@dacore/build-tools": "1.x"
+	}
+}

package/defaults/site/storage/filestores/settings-development.jsonld

@@ -0,0 +1,117 @@
+{
+  "@context": {
+    "owl": "http://www.w3.org/2002/07/owl#",
+    "rdf": "http://www.w3.org/1999/02/22-rdf-syntax-ns#",
+    "rdfs": "http://www.w3.org/2000/01/rdf-schema#",
+    "xsd": "http://www.w3.org/2001/XMLSchema#",
+    "core": "http://data.dacore.org/ontologies/core/",
+    "module": "http://data.dacore.org/ontologies/module/",
+    "storage": "http://data.dacore.org/ontologies/storage/",
+    "rdf4j": "http://data.dacore.org/ontologies/rdf4j/",
+    "node-core": "http://data.dacore.org/ontologies/node-core/",
+    "server-core": "http://data.dacore.org/ontologies/server-core/",
+    "browser-core": "http://data.dacore.org/ontologies/browser-core/"
+  },
+  "@graph": [
+    {
+      "@id": "dacore://store/main",
+      "@type": [
+        "rdf4j:RDF4JStore"
+      ],
+      "storage:publicEndPoint": [
+        {
+          "@value": "http://127.0.0.1:7200/repositories/${repositoryName}"
+        }
+      ]
+    },
+    {
+      "@id": "dacore://system",
+      "@type": "server-core:ServerCore",
+      "rdfs:label" : "${projectName}",
+      "server-core:serves": {
+        "@id": "${uriBase}"
+      },
+      "server-core:port": "${port}",
+      "core:uriBase": "${uriBase}",
+      "storage:defaultStore": {
+        "@id": "dacore://store/main"
+      },
+      "node-core:includeAtStartup": [
+        "@dacore/node-core",
+        "@dacore/rdf4j"
+      ],
+      "core:adminEmail": "${email}",
+      "core:deployment": "development",
+      "core:requiresSetup": {
+        "@type": "xsd:boolean",
+        "@value": "true"
+      },
+      "core:defaultModule": {
+        "@id": "${defaultModuleUri}"
+      },
+      "core:defaultOntology": {
+        "@id": "${defaultOntologyUri}"
+      },
+      "module:maintainsModule": [
+        {
+          "@id": "${defaultModuleUri}"
+        }
+      ],
+      "module:installedModule": [
+        {
+          "@id": "http://data.dacore.org/module/auth"
+        },
+        {
+          "@id": "http://data.dacore.org/module/admin"
+        },
+        {
+          "@id": "http://data.dacore.org/module/browser-core"
+        },
+        {
+          "@id": "http://data.dacore.org/module/core-editors"
+        },
+        {
+          "@id": "http://data.dacore.org/module/core-ui"
+        },
+        {
+          "@id": "http://data.dacore.org/module/core"
+        },
+        {
+          "@id": "http://data.dacore.org/module/coreviews"
+        },
+        {
+          "@id": "http://data.dacore.org/module/dcterms"
+        },
+        {
+          "@id": "http://data.dacore.org/module/forms"
+        },
+        {
+          "@id": "http://data.dacore.org/module/html"
+        },
+        {
+          "@id": "http://data.dacore.org/module/icons"
+        },
+        {
+          "@id": "http://data.dacore.org/module/rdf4j"
+        },
+        {
+          "@id": "http://data.dacore.org/module/server-core"
+        },
+        {
+          "@id": "http://data.dacore.org/module/website"
+        },
+        {
+          "@id": "http://data.dacore.org/module/website-editors"
+        }
+      ]
+    },
+    {
+      "@id": "${uriBase}",
+      "@type":  "browser-core:BrowserCore",
+      "core:uriBase": "${uriBase}",
+      "core:deployment": "development",
+      "browser-core:publicRoot": "${publicRoot}",
+      "browser-core:browserTitle": "${projectName}"
+    }
+  ]
+}