deboa 1.0.1 → 1.1.1

package/README.md

@@ -96,6 +96,7 @@ For more details, please see the [IDeboa interface](https://github.com/erikian/d
 - `beforePackage`: runs after the files are copied to the temporary directory and before they're packaged. You can use this to add/delete/rename any files before they're packaged.
 - `controlFileOptions`: additional control file fields. See the [IControlFileOptions interface](https://github.com/erikian/deboa/blob/main/src/types/IControlFileOptions.ts) for details.
 - `icon`: path to the image you want to use as your app icon.
+- `installationRoot`: directory your files will be installed to. Defaults to `/usr/lib/${packageName}`.
 - `modifyTarHeader`: allows you to modify the header of a file before it's added to the `data` tar archive. The main use case
   for this option is setting permissions in order to make files executable when creating a .deb on Windows:
 

package/dist/cjs/classes/Deboa.js

@@ -2,15 +2,9 @@
 Object.defineProperty(exports, "__esModule", {
     value: true
 });
-function _export(target, all) {
-    for(var name in all)Object.defineProperty(target, name, {
-        enumerable: true,
-        get: all[name]
-    });
-}
-_export(exports, {
-    default: ()=>_default,
-    Deboa: ()=>Deboa
+Object.defineProperty(exports, "Deboa", {
+    enumerable: true,
+    get: ()=>Deboa
 });
 const _events = require("events");
 const _os = /*#__PURE__*/ _interopRequireDefault(require("os"));
@@ -156,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`
@@ -272,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);
@@ -494,4 +501,3 @@ function _interopRequireWildcard(obj, nodeInterop) {
         }
     }
 }
-var _default = Deboa;

package/dist/cjs/types/Priority.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});

package/dist/cjs/{classes → types/classes}/Deboa.d.ts

@@ -42,4 +42,3 @@ declare class Deboa implements IDeboa {
     loadHooks(): Promise<void>;
 }
 export { Deboa };
-export default Deboa;

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

@@ -1,9 +1,4 @@
-export * from './IAddTarEntriesParams';
-export * from './IControlFileOptions';
-export * from './IDeboa';
-export * from './IDeboaFromFile';
-export * from './INormalizeOptionsLength';
-export * from './IWriteFileFromLinesArgs';
-export * from './IWriteToArchive';
-export * from './MaintainerScript';
-export * from './Section';
+import { Deboa } from './classes/Deboa';
+import { DeboaFromFile } from './classes/DeboaFromFile';
+export { Deboa, DeboaFromFile };
+export * from './types';

package/dist/cjs/types/index.js

@@ -10,6 +10,7 @@ _exportStar(require("./INormalizeOptionsLength"), exports);
 _exportStar(require("./IWriteFileFromLinesArgs"), exports);
 _exportStar(require("./IWriteToArchive"), exports);
 _exportStar(require("./MaintainerScript"), exports);
+_exportStar(require("./Priority"), exports);
 _exportStar(require("./Section"), exports);
 function _exportStar(from, to) {
     Object.keys(from).forEach(function(k) {

package/dist/cjs/types/{IControlFileOptions.d.ts → types/IControlFileOptions.d.ts}

@@ -1,4 +1,5 @@
 import { MaintainerScript } from './MaintainerScript';
+import { Priority } from './Priority';
 import { Section } from './Section';
 /**
  * The descriptions are mostly just shameless copies from the following docs:
@@ -90,7 +91,7 @@ export interface IControlFileOptions {
      *
      * {@link https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-priority}
      */
-    priority?: 'required' | 'important' | 'standard' | 'optional';
+    priority?: Priority;
     /**
      * {@link https://www.debian.org/doc/debian-policy/ch-relationships.html}
      */

package/dist/cjs/types/{IDeboa.d.ts → 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/cjs/types/types/Priority.d.ts

@@ -0,0 +1 @@
+export declare type Priority = 'required' | 'important' | 'standard' | 'optional';

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

@@ -0,0 +1,10 @@
+export * from './IAddTarEntriesParams';
+export * from './IControlFileOptions';
+export * from './IDeboa';
+export * from './IDeboaFromFile';
+export * from './INormalizeOptionsLength';
+export * from './IWriteFileFromLinesArgs';
+export * from './IWriteToArchive';
+export * from './MaintainerScript';
+export * from './Priority';
+export * from './Section';

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);
@@ -437,4 +450,3 @@ import { addTarEntries } from '../utils/addTarEntries';
     }
 }
 export { Deboa };
-export default Deboa;

package/dist/esm/types/Priority.js

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

package/dist/esm/{classes → types/classes}/Deboa.d.ts

@@ -42,4 +42,3 @@ declare class Deboa implements IDeboa {
     loadHooks(): Promise<void>;
 }
 export { Deboa };
-export default Deboa;

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

@@ -1,9 +1,4 @@
-export * from './IAddTarEntriesParams';
-export * from './IControlFileOptions';
-export * from './IDeboa';
-export * from './IDeboaFromFile';
-export * from './INormalizeOptionsLength';
-export * from './IWriteFileFromLinesArgs';
-export * from './IWriteToArchive';
-export * from './MaintainerScript';
-export * from './Section';
+import { Deboa } from './classes/Deboa';
+import { DeboaFromFile } from './classes/DeboaFromFile';
+export { Deboa, DeboaFromFile };
+export * from './types';

package/dist/esm/types/index.js

@@ -6,4 +6,5 @@ export * from './INormalizeOptionsLength';
 export * from './IWriteFileFromLinesArgs';
 export * from './IWriteToArchive';
 export * from './MaintainerScript';
+export * from './Priority';
 export * from './Section';

package/dist/esm/types/{IControlFileOptions.d.ts → types/IControlFileOptions.d.ts}

@@ -1,4 +1,5 @@
 import { MaintainerScript } from './MaintainerScript';
+import { Priority } from './Priority';
 import { Section } from './Section';
 /**
  * The descriptions are mostly just shameless copies from the following docs:
@@ -90,7 +91,7 @@ export interface IControlFileOptions {
      *
      * {@link https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-priority}
      */
-    priority?: 'required' | 'important' | 'standard' | 'optional';
+    priority?: Priority;
     /**
      * {@link https://www.debian.org/doc/debian-policy/ch-relationships.html}
      */

package/dist/esm/types/{IDeboa.d.ts → 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/types/types/Priority.d.ts

@@ -0,0 +1 @@
+export declare type Priority = 'required' | 'important' | 'standard' | 'optional';

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

@@ -0,0 +1,10 @@
+export * from './IAddTarEntriesParams';
+export * from './IControlFileOptions';
+export * from './IDeboa';
+export * from './IDeboaFromFile';
+export * from './INormalizeOptionsLength';
+export * from './IWriteFileFromLinesArgs';
+export * from './IWriteToArchive';
+export * from './MaintainerScript';
+export * from './Priority';
+export * from './Section';

package/package.json

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

package/dist/cjs/index.d.ts

@@ -1,4 +0,0 @@
-import { Deboa } from './classes/Deboa';
-import { DeboaFromFile } from './classes/DeboaFromFile';
-export { Deboa, DeboaFromFile };
-export * from './types';

package/dist/esm/index.d.ts

@@ -1,4 +0,0 @@
-import { Deboa } from './classes/Deboa';
-import { DeboaFromFile } from './classes/DeboaFromFile';
-export { Deboa, DeboaFromFile };
-export * from './types';