v3.0.0-rc.13

changelog.md

@@ -1,4 +1,4 @@
-# Unchained Engine v3.0 RC10 ("Odi")
+# Unchained Engine v3.0 RC13 ("Odi")
 
 We are thrilled to announce Unchained Engine v3.0, 5 years after the first version. We started with an overloaded framework approach using Meteor and gradually removed dependency by dependency, getting closer to the metal and in-line with today's standards. Unchained Engine...
 - ...is 100% ESM and self-hosted

docs/package.json

@@ -2,7 +2,7 @@
   "name": "docs",
   "description": "Docs for Unchained Engine",
   "private": true,
-  "version": "3.0.0-rc.12",
+  "version": "3.0.0-rc.13",
   "license": "ISC",
   "scripts": {
     "dev": "docusaurus start",

examples/kitchensink/package.json

@@ -2,7 +2,7 @@
   "name": "example-kitchensink",
   "description": "Kitchensink for Unchained Engine",
   "private": true,
-  "version": "3.0.0-rc.12",
+  "version": "3.0.0-rc.13",
   "license": "EUPL-1.2",
   "type": "module",
   "homepage": "https://unchained.shop",
@@ -35,12 +35,12 @@
   },
   "dependencies": {
     "@graphql-yoga/plugin-response-cache": "^3.12.8",
-    "@unchainedshop/api": "^3.0.0-rc.12",
-    "@unchainedshop/core-delivery": "^3.0.0-rc.12",
-    "@unchainedshop/core-payment": "^3.0.0-rc.12",
-    "@unchainedshop/platform": "^3.0.0-rc.12",
-    "@unchainedshop/plugins": "^3.0.0-rc.12",
-    "@unchainedshop/ticketing": "^3.0.0-rc.12",
+    "@unchainedshop/api": "^3.0.0-rc.13",
+    "@unchainedshop/core-delivery": "^3.0.0-rc.13",
+    "@unchainedshop/core-payment": "^3.0.0-rc.13",
+    "@unchainedshop/platform": "^3.0.0-rc.13",
+    "@unchainedshop/plugins": "^3.0.0-rc.13",
+    "@unchainedshop/ticketing": "^3.0.0-rc.13",
     "bip32": "^4.0.0",
     "bitcoinjs-lib": "^6.1.7",
     "dotenv-extended": "^2.9.0",

examples/minimal/package.json

@@ -2,7 +2,7 @@
   "name": "@unchainedshop/minimal",
   "description": "Kitchensink for Unchained Engine",
   "private": true,
-  "version": "3.0.0-rc.12",
+  "version": "3.0.0-rc.13",
   "license": "EUPL-1.2",
   "type": "module",
   "homepage": "https://unchained.shop",
@@ -36,8 +36,8 @@
   "dependencies": {
     "@fastify/cookie": "^11.0.1",
     "@fastify/session": "^11.0.2",
-    "@unchainedshop/platform": "^3.0.0-rc.12",
-    "@unchainedshop/plugins": "^3.0.0-rc.12",
+    "@unchainedshop/platform": "^3.0.0-rc.13",
+    "@unchainedshop/plugins": "^3.0.0-rc.13",
     "connect-mongo": "^5.1.0",
     "fastify": "^5.2.0"
   },

migration-v2.md

@@ -0,0 +1,44 @@
+# Migration Guide v1 -> v2
+
+1. WHATWG Fetch Support required
+Update Node to 18 or enable Experimental Fetch support on Node.js 16+
+
+2. GraphQL Version & Express backed-in
+```
+npm install graphql@16
+npm uninstall apollo-server-express body-parser graphql-scalars graphql-upload isomorphic-unfetch locale simpl-schema
+```
+
+3. Switch to Battery-Included
+
+Remove custom login-with-single-sign-on and remove all code that involves loading standard plugins and/or gridfs/datatrans webhooks. Furthermore `startPlatform` will not hook into express and it will not start the graphql server automatically anymore. This has been changed to support other backend frameworks than Express and to support Lambda Mode of Apollo. For those reasons, `startPlatform` has been changed and now returns an object containing `unchainedAPI` and the `apolloGraphQLServer`.
+
+To make it boot with express and the default plugins, you have to do the following:
+
+Import the connect functions and the defaultModules:
+
+```
+import { defaultModules, connectDefaultPluginsToExpress4 } from '@unchainedshop/plugins';
+import { connect } from '@unchainedshop/api/express/index.js';
+```
+
+Then pass defaultModules to the „modules“ prop of startPlatform:
+
+```
+const engine = await startPlatform({ modules: defaultModules, … });
+```
+
+Now, start the GraphQL server, connect it to Express and load the custom modules:
+
+```
+const engine = await startPlatform({ … });
+
+await engine.apolloGraphQLServer.start(); // Counterintuitively, this has to be done before the platform is connected to express
+  
+connect(app, engine);
+connectDefaultPluginsToExpress4(app, engine);
+```
+
+5. The userId’s that were used to set some internal db fields about updatedBy / createdBy need to be dropped from various functions. This will most propably affect seed code. Typescript will help you with that.
+
+6. Examine the API Breaking Changes in the Changelog for API incompatibilities between 1.2 and 2.0.