social-graphics-library - npm Package Compare versions

Comparing version 1.5.11 to 2.0.0

package.json

 {
-    "name": "social-graphics-library",
-    "version": "1.5.11",
-    "description": "A script for generating social media logos and banners",
-    "scripts": {
-        "dev:build": "webpack",
-        "dev:deploy": "npm install && npm run version:update && npm run dev:build && npm run dev:test",
-        "dev:run": "webpack serve",
-        "dev:test": "node tests",
-        "version:update": "sh ./version.sh",
-        "prod:deploy": "npm run dev:deploy && npm publish"
+  "name": "social-graphics-library",
+  "version": "2.0.0",
+  "description": "A script for generating social media logos and banners",
+  "main": "./dist/sgl.js",
+  "types": "dist/sgl.d.ts",
+  "type": "module",
+  "files": [
+    "/dist"
+  ],
+  "scripts": {
+    "dev:build": "tsc",
+    "dev:deploy": "npm install && npm run dev:update && npm run dev:build",
+    "dev:run": "tsc -w",
+    "dev:update": "node ./tools/updateInfo.js",
+    "prod:deploy": "npm run dev:deploy && npm publish"
+  },
+  "module": "src/sgl.ts",
+  "private": false,
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Social-graphics-library/Social-graphics-library"
+  },
+  "keywords": [
+    "sgl",
+    "fearnixx",
+    "josunlp",
+    "fngg",
+    "image-processing",
+    "gaming",
+    "community",
+    "gaming community",
+    "typescript",
+    "javascript",
+    "front-end",
+    "library",
+    "svg",
+    "graphics",
+    "social-media",
+    "webp"
+  ],
+  "author": {
+    "name": "Jonas Pfalzgraf",
+    "email": "[e-mail]",
+    "url": "https://josunlp.de"
+  },
+  "contributors": [
+    {
+      "name": "Jonas Pfalzgraf",
+      "email": "[e-mail]"
     },
-    "main": "./dist/sgl.bundle.js",
-    "module": "src/glc.ts",
-    "private": false,
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/JosunLP/Social-graphics-library"
-    },
-    "keywords": [
-        "sgl",
-        "fearnixx",
-        "josunlp",
-        "fngg",
-        "image-processing",
-        "gaming",
-        "community",
-        "gaming community",
-        "typescript",
-        "javascript",
-        "front-end",
-        "library",
-        "svg",
-        "graphics",
-        "social-media",
-        "webp"
-    ],
-    "author": "josunlp",
-    "license": "MIT",
-    "bugs": {
-        "url": "https://github.com/JosunLP/Social-graphics-library/issues"
-    },
-    "homepage": "https://social-graphics-library.net/",
-    "devDependencies": {
-        "@babel/core": "^7.12.10",
-        "@babel/preset-env": "^7.12.10",
-        "@types/node": "^14.14.16",
-        "babel-loader": "^8.2.2",
-        "buffer": "^6.0.3",
-        "canvas": "^2.6.1",
-        "jsdom": "^16.4.0",
-        "jsdom-global": "^3.0.2",
-        "ts-loader": "^8.0.12",
-        "typescript": "^4.1.3",
-        "webpack": "^5.10.1",
-        "webpack-cli": "^4.3.0",
-        "webpack-dev-server": "^3.11.0"
-    },
-    "dependencies": {}
+    {
+      "name": "Magnus Leßmann",
+      "email": "[e-mail]"
+    }
+  ],
+  "funding": "https://ko-fi.com/josunlp",
+  "license": "MPL-2.0",
+  "bugs": {
+    "url": "https://github.com/Social-graphics-library/Social-graphics-library/issues"
+  },
+  "homepage": "https://social-graphics-library.net/",
+  "devDependencies": {
+    "typescript": "^4.5.2"
+  }
 }

README.md

@@ -21,3 +21,3 @@ # Languages
 
-Es besteht auch Support über den Discord Server des [WAPS-Framework](https://waps-framework.info), der Einladungslink ist [https://discord.gg/fraspbc](https://discord.gg/fraspbc)
+Es besteht auch Support über den [Software Support Discord Server](https://discord.gg/fraspbc)
 
@@ -27,5 +27,5 @@ ### Aufbau
 Zum generieren einer Grafik wird die statische Funktion `generator`
-auf der Klasse `SocialGraphicsLibrary` aufgerufen:
+auf der Klasse `SGL` aufgerufen:
 
-    new SocialGraphicsLibrary.generator(
+    new SGL.generator(
         teamName,
@@ -40,12 +40,12 @@ playerName,
 
-    new SocialGraphicsLibrary.multiGenerator(tName, pName, [{
-                    mode: 'twitch-title',
-                    containerId: 'img-container-1',
-                    imgMode: 'jpeg'
-                }, {
-                    mode: 'elavate-title',
-                    containerId: 'img-container-2',
-                    imgMode: 'jpeg',
-                    generateLink: true
-                }]
+    new SGL.multiGenerator(tName, pName, [{
+              mode: 'twitch-title',
+              containerId: 'img-container-1',
+              imgMode: 'jpeg'
+          }, {
+              mode: 'elavate-title',
+              containerId: 'img-container-2',
+              imgMode: 'jpeg',
+              generateLink: true
+          }]
 
@@ -88,2 +88,17 @@ ### Modifikatoren
 ---
+### Nur DataURL
+
+Es besteht die möglichkeit, sich nur die dataURL des gewünschten Bildes zu generieren und diese zurück zu geben.
+Hierfür wird die Methode `getImageDataUrl` auf der Klasse `SGL` aufgerufen. Diese gibt die entsprechende DataURL als Promise zurück.
+
+Ein beispielhafter aufruf:
+
+    await new SGL.getImageDataUrl(
+      document.getElementById('M. Mustermann').value,
+      document.getElementById('Mustercorp').value,
+      'logo',
+      'webp'
+    ));
+
+---
 ### Inject Template (Experimentelles Feature)
@@ -93,3 +108,3 @@
 
-    new SocialGraphicsLibrary.inject([
+    new SGL.inject([
       {
@@ -152,3 +167,3 @@ "callName": "template_name",
 
-There is also support via the Discord server of the [WAPS-Framework](https://waps-framework.info), the invitation link is [https://discord.gg/fraspbc](https://discord.gg/fraspbc)
+There is also support via the [Software Support Discord Server](https://discord.gg/fraspbc)
 
@@ -158,5 +173,5 @@ ### Structure
 The static function `generator` is used to generate a graphic
-called on the class `SocialGraphicsLibrary`:
+called on the class `SGL`:
 
-    new SocialGraphicsLibrary.generator(
+    new SGL.generator(
         teamName,
@@ -171,12 +186,12 @@ playerName,
 
-    new SocialGraphicsLibrary.multiGenerator(tName, pName, [{
-                    mode: 'twitch-title',
-                    containerId: 'img-container-1',
-                    imgMode: 'jpeg'
-                }, {
-                    mode: 'elavate-title',
-                    containerId: 'img-container-2',
-                    imgMode: 'jpeg',
-                    generateLink: true
-                }]
+    new SGL.multiGenerator(tName, pName, [{
+              mode: 'twitch-title',
+              containerId: 'img-container-1',
+              imgMode: 'jpeg'
+          }, {
+              mode: 'elavate-title',
+              containerId: 'img-container-2',
+              imgMode: 'jpeg',
+              generateLink: true
+          }]
 
@@ -219,2 +234,17 @@ ### Modifiers
 ---
+### DataURL only
+
+It is possible to generate only the dataURL of the desired image and to return it.
+For this the method `getImageDataUrl` is called on the class`SGL`. This returns the corresponding DataURL as a promise.
+
+An exemplary call:
+
+     await new SGL.getImageDataUrl (
+       document.getElementById ('M. Mustermann'). value,
+       document.getElementById ('Mustercorp'). value,
+       'logo',
+       'webp'
+     ));
+
+---
 ### Inject Template (Experimental Feature)
@@ -224,3 +254,3 @@
 
-    new SocialGraphicsLibrary.inject([
+    new SGL.inject([
       {
@@ -227,0 +257,0 @@ "callName": "template_name",

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Copyleft License

License

(Experimental) Copyleft license information was found.

Found 1 instance in 1 package

Non-permissive License

License

(Experimental) A license not known to be considered permissive was found.

Found 1 instance in 1 package

Improved metrics

Dev dependency count

1

decreased by-92.31%

Number of lines in readme file

290

increased by11.54%

Is type module

Yes

Worsened metrics

Total package byte prevSize

129072

decreased by-97.62%

Number of package files

71

decreased by-6.58%

Number of low license alerts

2

increased byInfinity%

License quality

70

decreased by-30%

Lines of code

1188

decreased by-25.05%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes