camstreamerlib 1.6.2 → 1.7.0

package/CreatePackage.d.ts

@@ -0,0 +1 @@
+export {};

package/CreatePackage.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs = require("fs");
+const Path = require("path");
+const AdmZip = require("adm-zip");
+function isDirectory(path) {
+    const stat = fs.statSync(path);
+    return stat.isDirectory();
+}
+function createZipArchive(zip, folder, options) {
+    const files = fs.readdirSync(folder);
+    for (let file of files) {
+        const path = Path.join(folder, file);
+        const isDir = isDirectory(path);
+        if (file[0] == '.' ||
+            (file == 'node_modules' && !options.includeNodeModules) ||
+            (file == 'src' && options.typeScriptPackage)) {
+            continue;
+        }
+        else if (file == 'dist' && options.typeScriptPackage) {
+            zip.addLocalFolder(path);
+        }
+        else if (isDir) {
+            zip.addLocalFolder(path, file);
+        }
+        else {
+            zip.addLocalFile(path);
+        }
+    }
+}
+function main(args) {
+    const folder = Path.resolve('.');
+    const zipFile = Path.basename(folder) + '.zip';
+    const options = {
+        includeNodeModules: false,
+        typeScriptPackage: false,
+    };
+    for (let arg of args) {
+        if (arg == '-i' || arg == '-includeNodeModules') {
+            options.includeNodeModules = true;
+        }
+    }
+    if (fs.existsSync('dist')) {
+        options.typeScriptPackage = true;
+    }
+    if (fs.existsSync(zipFile)) {
+        try {
+            fs.unlinkSync(zipFile);
+        }
+        catch (error) {
+            console.log('An error occured: ', error);
+            process.exit(1);
+        }
+    }
+    const zip = new AdmZip();
+    createZipArchive(zip, folder, options);
+    zip.writeZip(zipFile);
+}
+main(process.argv.slice(2));

package/README.md

@@ -334,3 +334,17 @@ np
 ```
 The utility will ask you for the prefered version raise and if you are lucky, everything will run just fine.
 Finally, edit GitHub release form.
+
+### Preparing a package to upload to CamScripter
+If you want to create your own package and upload it to CamScripter App, you can use the script CreatePackage. It creates a zip file which contains all required files and directories in your package folder. The script accepts source code written either in JavaScript or TypeScript if the package has the correct structure (more information in https://github.com/CamStreamer/CamScripterApp_examples/#readme). To include this script in your package add the following lines in the file package.json:
+```json
+"scripts": {
+    "create-package": "node node_modules/camstreamerlib/CreatePackage.js"
+  }
+```
+By default, the zipped package does not contain node_modules directory. If you want to include it (required when uploading to CamScripter App on Axis camera), add this:
+```json
+"scripts": {
+    "create-package": "node node_modules/camstreamerlib/CreatePackage.js -includeNodeModules"
+  }
+```

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "camstreamerlib",
-  "version": "1.6.2",
+  "version": "1.7.0",
   "description": "Helper library for CamStreamer ACAP applications.",
   "prettier": "@camstreamer/prettier-config",
   "dependencies": {
     "crypto": "^1.0.1",
     "eventemitter2": "^5.0.1",
     "prettify-xml": "^1.2.0",
+    "adm-zip": "^0.5.9",
     "typescript": "^4.7.4",
     "ws": "^7.4.2",
     "xml2js": "^0.4.19"