feat: theme and config for doc publish (#1525)

peterpeterparker · web-flow · commit 6094d35e1911 · 2022-04-02T18:35:00.000+02:00
* feat: theme and config for doc publish

Signed-off-by: peterpeterparker &lt;david.dalbusco@outlook.com&gt;

* build: update editor

Signed-off-by: peterpeterparker &lt;david.dalbusco@outlook.com&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,11 +5,11 @@
 ### Providers: New
 
 - offline: v0.0.6 ([CHANGELOG](https://github.com/deckgo/deckdeckgo/blob/main/providers/offline/CHANGELOG.md))
-- sync: v0.0.18 ([CHANGELOG](https://github.com/deckgo/deckdeckgo/blob/main/providers/offline/CHANGELOG.md))
+- sync: v0.0.19 ([CHANGELOG](https://github.com/deckgo/deckdeckgo/blob/main/providers/offline/CHANGELOG.md))
 
 ### Providers
 
-- firebase: v4.1.3 ([CHANGELOG](https://github.com/deckgo/deckdeckgo/blob/main/providers/firebase/CHANGELOG.md))
+- firebase: v4.1.4 ([CHANGELOG](https://github.com/deckgo/deckdeckgo/blob/main/providers/firebase/CHANGELOG.md))
 
 ### Providers: Deprecated and integrated into `papyrs`
 
@@ -30,7 +30,7 @@
 ### Others
 
 - deck-utils: v7.0.0 ([CHANGELOG](https://github.com/deckgo/deckdeckgo/blob/main/utils/deck/CHANGELOG.md))
-- editor: v7.8.1 ([CHANGELOG](https://github.com/deckgo/deckdeckgo/blob/main/utils/editor/CHANGELOG.md))
+- editor: v7.9.0 ([CHANGELOG](https://github.com/deckgo/deckdeckgo/blob/main/utils/editor/CHANGELOG.md))
 - styles: v1.4.2 ([CHANGELOG](https://github.com/deckgo/deckdeckgo/blob/main/utils/styles/CHANGELOG.md))
 
 <a name="6.0.0"></a>
diff --git a/package-lock.json b/package-lock.json
diff --git a/providers/firebase/CHANGELOG.md b/providers/firebase/CHANGELOG.md
@@ -1,3 +1,9 @@
+# 4.1.4 (2022-04-02)
+
+### Build
+
+- update `editor` utils
+
 # 4.1.3 (2022-03-19)
 
 ### Build
diff --git a/providers/firebase/package.json b/providers/firebase/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@deckdeckgo/firebase",
-  "version": "4.1.3",
+  "version": "4.1.4",
   "description": "The Firebase connectors of the DeckDeckGo editor for slides",
   "main": "dist/index.cjs.js",
   "module": "dist/index.js",
@@ -25,7 +25,7 @@
   },
   "dependencies": {
     "@deckdeckgo/api": "file:providers/api",
-    "@deckdeckgo/editor": "^7.7.0",
+    "@deckdeckgo/editor": "^7.9.0",
     "firebase": "^8.9.1",
     "idb-keyval": "^6.0.1"
   },
diff --git a/providers/firebase/src/providers/publish/publish.firebase.ts b/providers/firebase/src/providers/publish/publish.firebase.ts
@@ -18,7 +18,7 @@ export const deckPublish: DeckPublish = async ({deck: deckSource, config}: {deck
   return deck;
 };
 
-export const docPublish: DocPublish = async (_params: {doc: Doc}): Promise<Doc> => {
+export const docPublish: DocPublish = async (_params: {doc: Doc; config: Record<string, string>}): Promise<Doc> => {
   throw new Error('Publish operation not supported.');
 };
 
diff --git a/providers/sync/CHANGELOG.md b/providers/sync/CHANGELOG.md
@@ -1,4 +1,10 @@
-# 0.0.17-0.0.18 (2022-03-226)
+# 0.0.19 (2022-04-02)
+
+### Features
+
+- pass `config` to `docPublish`
+
+# 0.0.17-0.0.18 (2022-03-26)
 
 ### Features
 
diff --git a/providers/sync/package.json b/providers/sync/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@deckdeckgo/sync",
-  "version": "0.0.18",
+  "version": "0.0.19",
   "author": "David Dal Busco",
   "description": "Sync data and auth providers for DeckDeckGo editors.",
   "license": "AGPL-3.0-or-later",
@@ -24,7 +24,7 @@
     "README.md"
   ],
   "dependencies": {
-    "@deckdeckgo/editor": "^7.8.1",
+    "@deckdeckgo/editor": "^7.9.0",
     "@deckdeckgo/offline": "^0.0.6",
     "nanoid": "^3.3.1"
   },
diff --git a/providers/sync/src/providers/publish.provider.ts b/providers/sync/src/providers/publish.provider.ts
@@ -52,12 +52,12 @@ export const publishUrl = async (meta: Meta | undefined): Promise<string | undef
   return undefined;
 };
 
-const publishDoc = async ({inputs}: PublishParams): Promise<void> => {
+const publishDoc = async ({inputs, config}: PublishParams): Promise<void> => {
   const doc: Doc = updateDocMeta(inputs);
 
   const {docPublish}: {docPublish: DocPublish} = await cloudProvider<{docPublish: DocPublish}>();
 
-  await docPublish({doc});
+  await docPublish({doc, config});
 };
 
 const publishDeck = async ({inputs, config}: PublishParams): Promise<void> => {
diff --git a/providers/sync/src/types/jszip.d.ts b/providers/sync/src/types/jszip.d.ts
@@ -65,6 +65,11 @@ declare namespace JSZip {
 
     interface JSZipObject {
         name: string;
+        /**
+         * Present for files loadded with `loadAsync`. May contain ".." path components that could
+         * result in a zip-slip attack. See https://snyk.io/research/zip-slip-vulnerability
+         */
+        unsafeOriginalName?: string;
         dir: boolean;
         date: Date;
         comment: string;
diff --git a/utils/editor/CHANGELOG.md b/utils/editor/CHANGELOG.md
@@ -1,3 +1,10 @@
+# 7.9.0 (2022-04-02)
+
+### Features
+
+- add `config` to `DocPublish`
+- add `theme` to `docPublishData`
+
 # 7.8.1 (2022-03-19)
 
 ### Fix
diff --git a/utils/editor/package.json b/utils/editor/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@deckdeckgo/editor",
-  "version": "7.8.1",
+  "version": "7.9.0",
   "author": "David Dal Busco",
   "description": "Types for the DeckDeckGo editor",
   "license": "AGPL-3.0-or-later",
diff --git a/utils/editor/src/providers/publish.provider.ts b/utils/editor/src/providers/publish.provider.ts
@@ -6,7 +6,7 @@ export interface DeckPublish {
 }
 
 export interface DocPublish {
-  ({doc}: {doc: Doc}): Promise<Doc>;
+  ({doc, config}: {doc: Doc; config: Record<string, string>}): Promise<Doc>;
 }
 
 export interface PublishUrl {
diff --git a/utils/editor/src/utils/publish.utils.ts b/utils/editor/src/utils/publish.utils.ts
@@ -27,6 +27,7 @@ export interface DeckPublishData extends PublishData {
 
 export interface DocPublishData extends PublishData {
   paragraphs: string[];
+  theme: string | undefined;
 }
 
 export const deckPublishData = async ({deck, fallbackAuthor}: {deck: Deck; fallbackAuthor: string}): Promise<DeckPublishData> => {
@@ -42,13 +43,22 @@ export const deckPublishData = async ({deck, fallbackAuthor}: {deck: Deck; fallb
   };
 };
 
-export const docPublishData = async ({doc, fallbackAuthor}: {doc: Doc; fallbackAuthor: string}): Promise<DocPublishData> => {
+export const docPublishData = async ({
+  doc,
+  fallbackAuthor,
+  theme
+}: {
+  doc: Doc;
+  fallbackAuthor: string;
+  theme: string | undefined;
+}): Promise<DocPublishData> => {
   const {data} = doc;
   const {meta} = data;
 
   return {
     ...(await publishData({meta, selector: docSelector, fallbackName: data.name, fallbackAuthor})),
-    paragraphs: getParagraphs()
+    paragraphs: getParagraphs(),
+    theme
   };
 };
 
