deboa 1.0.0 → 1.1.0

package/README.md

@@ -29,6 +29,16 @@ any number of metadata/file contents pairs.
 - the `data` file, which contains the actual software
 
 
+# Installation
+
+```shell
+# Yarn
+yarn add --dev deboa
+
+# npm
+npm i -D deboa
+```
+
 # API
 
 ## Creating a .deb from scratch

package/dist/cjs/classes/Deboa.js

@@ -150,7 +150,13 @@ function _interopRequireWildcard(obj, nodeInterop) {
         this.#outputFile = _path.default.join(this.targetDir, `${packageName}_${version}_${architecture}.deb`);
         this.#controlFolderDestination = _path.default.join(this.#tempDir, 'control');
         this.#dataFolderDestination = _path.default.join(this.#tempDir, 'data');
-        this.#appFolderDestination = _path.default.join(this.#dataFolderDestination, 'usr', 'lib', packageName);
+        this.#appFolderDestination = _path.default.join(this.#dataFolderDestination, ...options.installationRoot ? [
+            options.installationRoot
+        ] : [
+            'usr',
+            'lib',
+            packageName
+        ]);
     }
     /**
    * Ensures that all required options are present and that the `packageName`
@@ -266,6 +272,13 @@ function _interopRequireWildcard(obj, nodeInterop) {
         const controlFileWriteStream = _fs.default.createWriteStream(controlFileLocation);
         _tarFs.default.pack(this.#dataFolderDestination, {
             map: (header)=>{
+                // Why: while undocumented, this header accepts options for the header passed to tar-stream's pack function
+                // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                // @ts-ignore
+                header.gname = 'root';
+                // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                // @ts-ignore
+                header.uname = 'root';
                 // sensible defaults for Windows users
                 if (process.platform === 'win32') {
                     const defaultFilePermission = parseInt('0644', 8);

package/dist/cjs/types/types/IDeboa.d.ts

@@ -1,6 +1,7 @@
-import type { Headers as TarFSHeader } from 'tar-fs';
+import type { Headers as OriginalTarFSHeader } from 'tar-fs';
 import type { Headers as TarStreamHeader } from 'tar-stream';
 import { IControlFileOptions } from './IControlFileOptions';
+declare type TarFSHeader = OriginalTarFSHeader & Pick<TarStreamHeader, 'uname' | 'gname'>;
 /**
  * @property {IDeboa["additionalTarEntries"]} [additionalTarEntries] -
  *  Additional entries to be added to the .tar archive. This is useful for
@@ -33,6 +34,10 @@ import { IControlFileOptions } from './IControlFileOptions';
  *  /usr/share/pixmaps. Optional.
  *
  *
+ * @property {IDeboa["installationRoot"]} [installationRoot] -
+ *  Directory your files will be installed to. Defaults to `/usr/lib/${packageName}`.
+ *
+ *
  * @property {IDeboa["modifyTarHeader"]} [modifyTarHeader] -
  *  This callback makes it possible to modify file headers before they're
  *  written to the .tar archive, which is useful for setting permissions.
@@ -92,6 +97,10 @@ export interface IDeboa {
      * /usr/share/pixmaps. Optional.
      */
     icon?: string;
+    /**
+     * Directory your files will be installed to. Defaults to `/usr/lib/${packageName}`.
+     */
+    installationRoot?: string;
     /**
      * This callback makes it possible to modify file headers before they're
      * written to the .tar archive, which is useful for setting permissions.
@@ -121,3 +130,4 @@ export interface IDeboa {
      */
     targetDir: string;
 }
+export {};

package/dist/esm/classes/Deboa.js

@@ -98,7 +98,13 @@ import { addTarEntries } from '../utils/addTarEntries';
         this.#outputFile = path.join(this.targetDir, `${packageName}_${version}_${architecture}.deb`);
         this.#controlFolderDestination = path.join(this.#tempDir, 'control');
         this.#dataFolderDestination = path.join(this.#tempDir, 'data');
-        this.#appFolderDestination = path.join(this.#dataFolderDestination, 'usr', 'lib', packageName);
+        this.#appFolderDestination = path.join(this.#dataFolderDestination, ...options.installationRoot ? [
+            options.installationRoot
+        ] : [
+            'usr',
+            'lib',
+            packageName
+        ]);
     }
     /**
    * Ensures that all required options are present and that the `packageName`
@@ -214,6 +220,13 @@ import { addTarEntries } from '../utils/addTarEntries';
         const controlFileWriteStream = fs.createWriteStream(controlFileLocation);
         tar.pack(this.#dataFolderDestination, {
             map: (header)=>{
+                // Why: while undocumented, this header accepts options for the header passed to tar-stream's pack function
+                // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                // @ts-ignore
+                header.gname = 'root';
+                // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+                // @ts-ignore
+                header.uname = 'root';
                 // sensible defaults for Windows users
                 if (process.platform === 'win32') {
                     const defaultFilePermission = parseInt('0644', 8);

package/dist/esm/types/types/IDeboa.d.ts

@@ -1,6 +1,7 @@
-import type { Headers as TarFSHeader } from 'tar-fs';
+import type { Headers as OriginalTarFSHeader } from 'tar-fs';
 import type { Headers as TarStreamHeader } from 'tar-stream';
 import { IControlFileOptions } from './IControlFileOptions';
+declare type TarFSHeader = OriginalTarFSHeader & Pick<TarStreamHeader, 'uname' | 'gname'>;
 /**
  * @property {IDeboa["additionalTarEntries"]} [additionalTarEntries] -
  *  Additional entries to be added to the .tar archive. This is useful for
@@ -33,6 +34,10 @@ import { IControlFileOptions } from './IControlFileOptions';
  *  /usr/share/pixmaps. Optional.
  *
  *
+ * @property {IDeboa["installationRoot"]} [installationRoot] -
+ *  Directory your files will be installed to. Defaults to `/usr/lib/${packageName}`.
+ *
+ *
  * @property {IDeboa["modifyTarHeader"]} [modifyTarHeader] -
  *  This callback makes it possible to modify file headers before they're
  *  written to the .tar archive, which is useful for setting permissions.
@@ -92,6 +97,10 @@ export interface IDeboa {
      * /usr/share/pixmaps. Optional.
      */
     icon?: string;
+    /**
+     * Directory your files will be installed to. Defaults to `/usr/lib/${packageName}`.
+     */
+    installationRoot?: string;
     /**
      * This callback makes it possible to modify file headers before they're
      * written to the .tar archive, which is useful for setting permissions.
@@ -121,3 +130,4 @@ export interface IDeboa {
      */
     targetDir: string;
 }
+export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "deboa",
   "author": "Erik Moura <erikian@erikian.dev>",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Create .deb files in any platform with Node.js",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",