@resoc/create-img - npm Package Compare versions

Comparing version 0.4.1 to 0.4.2

build/compile.d.ts

@@ -7,6 +7,8 @@ import { ImageTemplate, ImageResolution, ParamValues } from '@resoc/core';
 export declare const cachedImageName: (templateDir: string, values: ParamValues, imagePath: string) => Promise<string>;
+export declare const createImage: (templateManifestPath: string, paramValues: ParamValues, resolution: ImageResolution, imagePath: string, options?: LocalTemplateOptions | undefined) => Promise<string>;
 export declare const compileLocalTemplate: (templateManifestPath: string, paramValues: ParamValues, resolution: ImageResolution, imagePath: string, options?: LocalTemplateOptions | undefined) => Promise<string>;
 export declare const isLocalResource: (url: string) => boolean;
+export declare const createImageFromTemplate: (template: ImageTemplate, paramValues: ParamValues, resolution: ImageResolution, imagePath: string, resourcePath?: string | undefined) => Promise<void>;
 export declare const compileTemplate: (template: ImageTemplate, paramValues: ParamValues, resolution: ImageResolution, imagePath: string, resourcePath?: string | undefined) => Promise<void>;
 export declare const urlToImage: (url: string, outputPath: string) => Promise<void>;
 export {};

build/index.d.ts

@@ -1,3 +0,3 @@
-export { compileTemplate, compileLocalTemplate, cachedImageName, fileExists } from "./compile";
+export { createImage, createImageFromTemplate, compileTemplate, compileLocalTemplate, cachedImageName, fileExists } from "./compile";
 export { loadLocalTemplate } from "./local";
 export { parseParameters } from "./parse-parameters";

build/index.es.js

 import { renderTemplateToHtml, ParamType } from '@resoc/core';
 import puppeteer from 'puppeteer';
-import fs from 'fs/promises';
+import { promises } from 'fs';
 import path from 'path';
@@ -93,3 +93,3 @@ import os from 'os';
                 _b = (_a = JSON).parse;
-                return [4 /*yield*/, fs.readFile(manifestPath)];
+                return [4 /*yield*/, promises.readFile(manifestPath)];
             case 1:
@@ -110,3 +110,3 @@ manifest = _b.apply(_a, [(_h.sent()).toString()]);
                 _f = partial;
-                return [4 /*yield*/, fs.readFile(patialpath)];
+                return [4 /*yield*/, promises.readFile(patialpath)];
             case 5:
@@ -166,3 +166,3 @@ _e[_f] = (_h.sent()).toString();
                 _a.trys.push([0, 2, , 3]);
-                return [4 /*yield*/, fs.access(path)];
+                return [4 /*yield*/, promises.access(path)];
             case 1:
@@ -189,3 +189,3 @@ _a.sent();
 }); };
-var compileLocalTemplate = function (templateManifestPath, paramValues, resolution, imagePath, options) { return __awaiter(void 0, void 0, void 0, function () {
+var createImage = function (templateManifestPath, paramValues, resolution, imagePath, options) { return __awaiter(void 0, void 0, void 0, function () {
     var templateDir, template;
@@ -219,2 +219,4 @@ return __generator(this, function (_a) {
 }); };
+// Old name
+var compileLocalTemplate = createImage;
 var isLocalResource = function (url) {
@@ -240,3 +242,3 @@ var up = url.toLowerCase();
                 dest = tmpDir + "/" + v4() + "-" + path.basename(url);
-                return [4 /*yield*/, fs.copyFile(url, dest)];
+                return [4 /*yield*/, promises.copyFile(url, dest)];
             case 2:
@@ -253,7 +255,7 @@ _a.sent();
 }); };
-var compileTemplate = function (template, paramValues, resolution, imagePath, resourcePath) { return __awaiter(void 0, void 0, void 0, function () {
+var createImageFromTemplate = function (template, paramValues, resolution, imagePath, resourcePath) { return __awaiter(void 0, void 0, void 0, function () {
     var tmpDir, html, htmlPath;
     return __generator(this, function (_a) {
         switch (_a.label) {
-            case 0: return [4 /*yield*/, fs.mkdtemp(path.join(os.tmpdir(), 'resoc-compile-'))];
+            case 0: return [4 /*yield*/, promises.mkdtemp(path.join(os.tmpdir(), 'resoc-compile-'))];
             case 1:
@@ -267,3 +269,3 @@ tmpDir = _a.sent();
                 htmlPath = tmpDir + "/content.html";
-                return [4 /*yield*/, fs.writeFile(htmlPath, html)];
+                return [4 /*yield*/, promises.writeFile(htmlPath, html)];
             case 3:
@@ -283,2 +285,4 @@ _a.sent();
 }); };
+// Old name
+var compileTemplate = createImageFromTemplate;
 var urlToImage = function (url, outputPath) { return __awaiter(void 0, void 0, void 0, function () {
@@ -330,3 +334,3 @@ var browser, page, output;
 
-export { cachedImageName, compileLocalTemplate, compileTemplate, fileExists, loadLocalTemplate, parseParameters };
+export { cachedImageName, compileLocalTemplate, compileTemplate, createImage, createImageFromTemplate, fileExists, loadLocalTemplate, parseParameters };
 //# sourceMappingURL=index.es.js.map

build/index.js

@@ -7,3 +7,3 @@ 'use strict';
 var puppeteer = require('puppeteer');
-var fs = require('fs/promises');
+var fs = require('fs');
 var path = require('path');
@@ -20,3 +20,2 @@ var os = require('os');
 var puppeteer__default = /*#__PURE__*/_interopDefaultLegacy(puppeteer);
-var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
 var path__default = /*#__PURE__*/_interopDefaultLegacy(path);
@@ -109,3 +108,3 @@ var os__default = /*#__PURE__*/_interopDefaultLegacy(os);
                 _b = (_a = JSON).parse;
-                return [4 /*yield*/, fs__default['default'].readFile(manifestPath)];
+                return [4 /*yield*/, fs.promises.readFile(manifestPath)];
             case 1:
@@ -126,3 +125,3 @@ manifest = _b.apply(_a, [(_h.sent()).toString()]);
                 _f = partial;
-                return [4 /*yield*/, fs__default['default'].readFile(patialpath)];
+                return [4 /*yield*/, fs.promises.readFile(patialpath)];
             case 5:
@@ -182,3 +181,3 @@ _e[_f] = (_h.sent()).toString();
                 _a.trys.push([0, 2, , 3]);
-                return [4 /*yield*/, fs__default['default'].access(path)];
+                return [4 /*yield*/, fs.promises.access(path)];
             case 1:
@@ -205,3 +204,3 @@ _a.sent();
 }); };
-var compileLocalTemplate = function (templateManifestPath, paramValues, resolution, imagePath, options) { return __awaiter(void 0, void 0, void 0, function () {
+var createImage = function (templateManifestPath, paramValues, resolution, imagePath, options) { return __awaiter(void 0, void 0, void 0, function () {
     var templateDir, template;
@@ -235,2 +234,4 @@ return __generator(this, function (_a) {
 }); };
+// Old name
+var compileLocalTemplate = createImage;
 var isLocalResource = function (url) {
@@ -256,3 +257,3 @@ var up = url.toLowerCase();
                 dest = tmpDir + "/" + uuid.v4() + "-" + path__default['default'].basename(url);
-                return [4 /*yield*/, fs__default['default'].copyFile(url, dest)];
+                return [4 /*yield*/, fs.promises.copyFile(url, dest)];
             case 2:
@@ -269,7 +270,7 @@ _a.sent();
 }); };
-var compileTemplate = function (template, paramValues, resolution, imagePath, resourcePath) { return __awaiter(void 0, void 0, void 0, function () {
+var createImageFromTemplate = function (template, paramValues, resolution, imagePath, resourcePath) { return __awaiter(void 0, void 0, void 0, function () {
     var tmpDir, html, htmlPath;
     return __generator(this, function (_a) {
         switch (_a.label) {
-            case 0: return [4 /*yield*/, fs__default['default'].mkdtemp(path__default['default'].join(os__default['default'].tmpdir(), 'resoc-compile-'))];
+            case 0: return [4 /*yield*/, fs.promises.mkdtemp(path__default['default'].join(os__default['default'].tmpdir(), 'resoc-compile-'))];
             case 1:
@@ -283,3 +284,3 @@ tmpDir = _a.sent();
                 htmlPath = tmpDir + "/content.html";
-                return [4 /*yield*/, fs__default['default'].writeFile(htmlPath, html)];
+                return [4 /*yield*/, fs.promises.writeFile(htmlPath, html)];
             case 3:
@@ -299,2 +300,4 @@ _a.sent();
 }); };
+// Old name
+var compileTemplate = createImageFromTemplate;
 var urlToImage = function (url, outputPath) { return __awaiter(void 0, void 0, void 0, function () {
@@ -349,2 +352,4 @@ var browser, page, output;
 exports.compileTemplate = compileTemplate;
+exports.createImage = createImage;
+exports.createImageFromTemplate = createImageFromTemplate;
 exports.fileExists = fileExists;
@@ -351,0 +356,0 @@ exports.loadLocalTemplate = loadLocalTemplate;

package.json

 {
   "name": "@resoc/create-img",
-  "version": "0.4.1",
+  "version": "0.4.2",
   "description": "Create an image based on a Resoc image template",
@@ -60,3 +60,3 @@ "main": "build/index.js",
   },
-  "gitHead": "8b642b3dc8e2d002fdc7d1ae49e0afe16bab2dcf"
+  "gitHead": "f29af88220ba348501e5ae83b651b26e3824ef02"
 }

src/compile.ts

 import { ImageTemplate, ImageResolution, loadRemoteTemplate, ParamValues, renderTemplateToHtml, TemplateParam, ParamType } from '@resoc/core'
 import puppeteer from 'puppeteer'
-import fs from 'fs/promises'
+import { promises as fs } from 'fs'
 import path from 'path'
@@ -31,3 +31,3 @@ import os from 'os'
 
-export const compileLocalTemplate = async (
+export const createImage = async (
   templateManifestPath: string,
@@ -65,2 +65,5 @@ paramValues: ParamValues,
 
+// Old name
+export const compileLocalTemplate = createImage;
+
 export const isLocalResource = (url: string): boolean => {
@@ -88,3 +91,3 @@ const up = url.toLowerCase();
 
-export const compileTemplate = async (template: ImageTemplate, paramValues: ParamValues, resolution: ImageResolution, imagePath: string, resourcePath?: string): Promise<void> => {
+export const createImageFromTemplate = async (template: ImageTemplate, paramValues: ParamValues, resolution: ImageResolution, imagePath: string, resourcePath?: string): Promise<void> => {
   const tmpDir = await fs.mkdtemp(path.join(os.tmpdir(), 'resoc-compile-'));
@@ -115,2 +118,5 @@
 
+// Old name
+export const compileTemplate = createImageFromTemplate;
+
 export const urlToImage = async (url: string, outputPath: string): Promise<void> => {
@@ -117,0 +123,0 @@ const browser = await puppeteer.launch({

src/index.ts

@@ -1,3 +0,10 @@
-export { compileTemplate, compileLocalTemplate, cachedImageName, fileExists } from "./compile";
+export {
+  createImage,
+  createImageFromTemplate,
+  compileTemplate,
+  compileLocalTemplate,
+  cachedImageName,
+  fileExists
+} from "./compile";
 export { loadLocalTemplate } from "./local";
 export { parseParameters } from "./parse-parameters";

src/local.ts

@@ -1,2 +0,2 @@
-import fs from 'fs/promises'
+import { promises as fs } from 'fs'
 import path from 'path'
@@ -3,0 +3,0 @@ import { ImageTemplate, ParamType, TemplateParam } from "@resoc/core"

New alerts

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Fixed alerts

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

153477

increased by2.19%

Number of package files

43

increased by10.26%

Lines of code

1435

increased by4.82%

No dependency changes