deboa 1.1.1 → 1.2.0

package/dist/cjs/classes/Deboa.js

@@ -18,6 +18,7 @@ const _writeFileFromLines = require("../utils/writeFileFromLines");
 const _deboaFromFile = require("./DeboaFromFile");
 const _stream = require("stream");
 const _addTarEntries = require("../utils/addTarEntries");
+const _changeOwnerToRoot = require("../utils/changeOwnerToRoot");
 function _interopRequireDefault(obj) {
     return obj && obj.__esModule ? obj : {
         default: obj
@@ -98,6 +99,7 @@ function _interopRequireWildcard(obj, nodeInterop) {
     /** See {@link IDeboa.sourceDir} */ sourceDir = null;
     /** See {@link IDeboa.tarballFormat} */ tarballFormat = null;
     /** See {@link IDeboa.targetDir} */ targetDir = null;
+    /** See {@link IDeboa.targetFileName} */ targetFileName = null;
     #appFolderDestination = null;
     #controlFolderDestination = null;
     #dataFolderDestination = null;
@@ -147,7 +149,7 @@ function _interopRequireWildcard(obj, nodeInterop) {
         }
         this.#tempDir = _path.default.join(_os.default.tmpdir(), 'deboa_temp');
         const { architecture , packageName , version  } = this.controlFileOptions;
-        this.#outputFile = _path.default.join(this.targetDir, `${packageName}_${version}_${architecture}.deb`);
+        this.#outputFile = _path.default.join(this.targetDir, `${options.targetFileName || `${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, ...options.installationRoot ? [
@@ -165,7 +167,7 @@ function _interopRequireWildcard(obj, nodeInterop) {
         console.log('Validating options...\n');
         const { controlFileOptions: { shortDescription , maintainer , packageName , version ,  } ,  } = options;
         if (!packageName) {
-            throw new Error('The controlFileOptions.`packageName` field is mandatory');
+            throw new Error('The `controlFileOptions.packageName` field is mandatory');
         }
         if (!version) {
             throw new Error('The `controlFileOptions.version` field is mandatory');
@@ -272,13 +274,7 @@ 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';
+                header = (0, _changeOwnerToRoot.changeOwnerToRoot)(header);
                 // sensible defaults for Windows users
                 if (process.platform === 'win32') {
                     const defaultFilePermission = parseInt('0644', 8);
@@ -314,6 +310,7 @@ function _interopRequireWildcard(obj, nodeInterop) {
         }).pipe(dataFileCompressor).pipe(dataFileWriteStream);
         _tarFs.default.pack(this.#controlFolderDestination, {
             map: (header)=>{
+                header = (0, _changeOwnerToRoot.changeOwnerToRoot)(header);
                 const maintainerScripts = [
                     'postinst',
                     'postrm',

package/dist/cjs/types/classes/Deboa.d.ts

@@ -1,44 +1,46 @@
-/**
- * Some useful references:
- *
- * https://radagast.ca/linux/anatomy_of_a_deb_file.html
- * https://pubs.opengroup.org/onlinepubs/9699919799/utilities/ar.html
- * https://www.unix.com/man-page/opensolaris/3head/ar.h/
- */
-import type { IDeboa } from '../types';
-/**
- * @return IDeboa
- */
-declare class Deboa implements IDeboa {
-    #private;
-    /** See {@link IDeboa.additionalTarEntries} */
-    additionalTarEntries: IDeboa['additionalTarEntries'];
-    /** See {@link IDeboa.beforeCreateDesktopEntry} */
-    beforeCreateDesktopEntry: IDeboa['beforeCreateDesktopEntry'];
-    /** See {@link IDeboa.beforePackage} */
-    beforePackage: IDeboa['beforePackage'];
-    /** See {@link IDeboa.controlFileOptions} */
-    controlFileOptions: IDeboa['controlFileOptions'];
-    /** See {@link IDeboa.icon} */
-    icon: IDeboa['icon'];
-    /** See {@link IDeboa.modifyTarHeader} */
-    modifyTarHeader: IDeboa['modifyTarHeader'];
-    /** See {@link IDeboa.sourceDir} */
-    sourceDir: IDeboa['sourceDir'];
-    /** See {@link IDeboa.tarballFormat} */
-    tarballFormat: IDeboa['tarballFormat'];
-    /** See {@link IDeboa.targetDir} */
-    targetDir: IDeboa['targetDir'];
-    constructor(options: IDeboa);
-    /**
-     * Creates the .deb file.
-     * @return {Promise<string>} outputFile - Absolute path to the generated .deb
-     */
-    package(): Promise<string>;
-    /**
-     * Checks if the values provided to the hook options are file paths
-     * and imports the actual functions from them if necessary.
-     */
-    loadHooks(): Promise<void>;
-}
-export { Deboa };
+/**
+ * Some useful references:
+ *
+ * https://radagast.ca/linux/anatomy_of_a_deb_file.html
+ * https://pubs.opengroup.org/onlinepubs/9699919799/utilities/ar.html
+ * https://www.unix.com/man-page/opensolaris/3head/ar.h/
+ */
+import type { IDeboa } from '../types';
+/**
+ * @return IDeboa
+ */
+declare class Deboa implements IDeboa {
+    #private;
+    /** See {@link IDeboa.additionalTarEntries} */
+    additionalTarEntries: IDeboa['additionalTarEntries'];
+    /** See {@link IDeboa.beforeCreateDesktopEntry} */
+    beforeCreateDesktopEntry: IDeboa['beforeCreateDesktopEntry'];
+    /** See {@link IDeboa.beforePackage} */
+    beforePackage: IDeboa['beforePackage'];
+    /** See {@link IDeboa.controlFileOptions} */
+    controlFileOptions: IDeboa['controlFileOptions'];
+    /** See {@link IDeboa.icon} */
+    icon: IDeboa['icon'];
+    /** See {@link IDeboa.modifyTarHeader} */
+    modifyTarHeader: IDeboa['modifyTarHeader'];
+    /** See {@link IDeboa.sourceDir} */
+    sourceDir: IDeboa['sourceDir'];
+    /** See {@link IDeboa.tarballFormat} */
+    tarballFormat: IDeboa['tarballFormat'];
+    /** See {@link IDeboa.targetDir} */
+    targetDir: IDeboa['targetDir'];
+    /** See {@link IDeboa.targetFileName} */
+    targetFileName: IDeboa['targetFileName'];
+    constructor(options: IDeboa);
+    /**
+     * Creates the .deb file.
+     * @return {Promise<string>} outputFile - Absolute path to the generated .deb
+     */
+    package(): Promise<string>;
+    /**
+     * Checks if the values provided to the hook options are file paths
+     * and imports the actual functions from them if necessary.
+     */
+    loadHooks(): Promise<void>;
+}
+export { Deboa };

package/dist/cjs/types/classes/DeboaFromFile.d.ts

@@ -1,23 +1,23 @@
-/// <reference types="node" />
-import type { ReadStream } from 'fs';
-import type { IWriteToArchive, IDeboaFromFile } from '../types';
-/**
- * @return IDeboaFromFile
- */
-export declare class DeboaFromFile implements IDeboaFromFile {
-    #private;
-    isARFile: IDeboaFromFile['isARFile'];
-    outputFile: IDeboaFromFile['outputFile'];
-    writeStream: IWriteToArchive['writeStream'];
-    constructor(options: IDeboaFromFile);
-    /**
-     * Creates a ReadStream from the input file.
-     * Useful if you need access to the underlying stream.
-     */
-    createReadStream(inputFile: string): Promise<ReadStream>;
-    writeFromStream(readStream: ReadStream): Promise<void>;
-    /**
-     * Writes the input file to the .deb.
-     */
-    writeFromFile(inputFile: string): Promise<void>;
-}
+/// <reference types="node" />
+import type { ReadStream } from 'fs';
+import type { IWriteToArchive, IDeboaFromFile } from '../types';
+/**
+ * @return IDeboaFromFile
+ */
+export declare class DeboaFromFile implements IDeboaFromFile {
+    #private;
+    isARFile: IDeboaFromFile['isARFile'];
+    outputFile: IDeboaFromFile['outputFile'];
+    writeStream: IWriteToArchive['writeStream'];
+    constructor(options: IDeboaFromFile);
+    /**
+     * Creates a ReadStream from the input file.
+     * Useful if you need access to the underlying stream.
+     */
+    createReadStream(inputFile: string): Promise<ReadStream>;
+    writeFromStream(readStream: ReadStream): Promise<void>;
+    /**
+     * Writes the input file to the .deb.
+     */
+    writeFromFile(inputFile: string): Promise<void>;
+}

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

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

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

@@ -1,5 +1,5 @@
-import { Headers as TarStreamHeader, Pack } from 'tar-stream';
-export interface IAddTarEntriesParams {
-    entries: TarStreamHeader[];
-    pack: Pack;
-}
+import { Headers as TarStreamHeader, Pack } from 'tar-stream';
+export interface IAddTarEntriesParams {
+    entries: TarStreamHeader[];
+    pack: Pack;
+}

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

@@ -1,130 +1,130 @@
-import { MaintainerScript } from './MaintainerScript';
-import { Priority } from './Priority';
-import { Section } from './Section';
-/**
- * The descriptions are mostly just shameless copies from the following docs:
- *
- * {@link https://www.debian.org/doc/debian-policy/ch-controlfields.html}
- *
- * {@link https://www.debian.org/doc/debian-policy/ch-maintainerscripts.html}
- *
- * {@link https://www.debian.org/doc/debian-policy/ch-relationships.html}
- */
-export interface IControlFileOptions {
-    /**
-     * Target architecture. Defaults to the current system's architecture.
-     *
-     * {@link https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-architecture}
-     */
-    architecture?: string;
-    /**
-     * {@link https://www.debian.org/doc/debian-policy/ch-relationships.html#s-built-using}
-     */
-    builtUsing?: string;
-    /**
-     * {@link https://www.debian.org/doc/debian-policy/ch-relationships.html}
-     */
-    conflicts?: string[];
-    /**
-     * {@link https://www.debian.org/doc/debian-policy/ch-relationships.html}
-     */
-    depends?: string[];
-    /**
-     * If set to `yes`, then the package management system will refuse to
-     * remove
-     * the package (upgrading and replacing it is still possible). The other
-     * possible value is `no`, which is the same as not having the field at
-     * all.
-     *
-     * {@link https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-essential}
-     */
-    essential?: 'yes' | 'no';
-    /**
-     * Extended description for the package. Defaults to the value provided for
-     * the `shortDescription` option.
-     *
-     * {@link https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-description}
-     */
-    extendedDescription?: string;
-    /**
-     * URL for this package.
-     *
-     * {@link https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-homepage}
-     */
-    homepage?: string;
-    /**
-     * The package maintainer's name and email address. The name must come
-     * first, then the email address inside angle brackets. **This field is
-     * mandatory.**
-     *
-     * {@link https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-maintainer}
-     */
-    maintainer: string;
-    /**
-     * Path to the scripts you want to execute before/after the system
-     * installs/upgrades/removes your package. There are quite a few rules
-     * here,
-     * so please check
-     * {@link
-     * https://www.debian.org/doc/debian-policy/ch-maintainerscripts.html} for
-     * details.
-     */
-    maintainerScripts?: Partial<Record<MaintainerScript, string>>;
-    /**
-     * Binary package name. Must be at least two characters long and must start
-     * with an alphanumeric character. Only lower case letters (a-z), digits
-     * (0-9), plus (+) and minus (-) signs, and periods (.) are allowed. **This
-     * field is mandatory.**
-     *
-     * {@link https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-source}
-     */
-    packageName: string;
-    /**
-     * See {@link
-     * https://www.debian.org/doc/debian-policy/ch-relationships.html} for
-     * details.
-     */
-    preDepends?: string[];
-    /**
-     * This field represents how important it is that the user have the package
-     * installed. Defaults to `optional`.
-     *
-     * {@link https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-priority}
-     */
-    priority?: Priority;
-    /**
-     * {@link https://www.debian.org/doc/debian-policy/ch-relationships.html}
-     */
-    recommends?: string[];
-    /**
-     * This field specifies an application area into which the package has been
-     * classified. This is a recommended field.
-     *
-     * {@link https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-section}
-     */
-    section?: Section;
-    /**
-     * Short, single-line synopsys for the package. Usually ~80 characters.
-     * **This field is mandatory.**
-     *
-     * {@link https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-description}
-     */
-    shortDescription: string;
-    /**
-     * Source package name.
-     *
-     * {@link https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-source}
-     */
-    source?: string;
-    /**
-     * {@link https://www.debian.org/doc/debian-policy/ch-relationships.html}
-     */
-    suggests?: string[];
-    /**
-     * Version number of the package in the
-     * `[epoch:]upstream_version[-debian_revision]` format. See
-     * {@link https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-version}
-     * for details. **This field is mandatory.**
-     */
-    version: string;
-}
+import { MaintainerScript } from './MaintainerScript';
+import { Priority } from './Priority';
+import { Section } from './Section';
+/**
+ * The descriptions are mostly just shameless copies from the following docs:
+ *
+ * {@link https://www.debian.org/doc/debian-policy/ch-controlfields.html}
+ *
+ * {@link https://www.debian.org/doc/debian-policy/ch-maintainerscripts.html}
+ *
+ * {@link https://www.debian.org/doc/debian-policy/ch-relationships.html}
+ */
+export interface IControlFileOptions {
+    /**
+     * Target architecture. Defaults to the current system's architecture.
+     *
+     * {@link https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-architecture}
+     */
+    architecture?: string;
+    /**
+     * {@link https://www.debian.org/doc/debian-policy/ch-relationships.html#s-built-using}
+     */
+    builtUsing?: string;
+    /**
+     * {@link https://www.debian.org/doc/debian-policy/ch-relationships.html}
+     */
+    conflicts?: string[];
+    /**
+     * {@link https://www.debian.org/doc/debian-policy/ch-relationships.html}
+     */
+    depends?: string[];
+    /**
+     * If set to `yes`, then the package management system will refuse to
+     * remove
+     * the package (upgrading and replacing it is still possible). The other
+     * possible value is `no`, which is the same as not having the field at
+     * all.
+     *
+     * {@link https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-essential}
+     */
+    essential?: 'yes' | 'no';
+    /**
+     * Extended description for the package. Defaults to the value provided for
+     * the `shortDescription` option.
+     *
+     * {@link https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-description}
+     */
+    extendedDescription?: string;
+    /**
+     * URL for this package.
+     *
+     * {@link https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-homepage}
+     */
+    homepage?: string;
+    /**
+     * The package maintainer's name and email address. The name must come
+     * first, then the email address inside angle brackets. **This field is
+     * mandatory.**
+     *
+     * {@link https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-maintainer}
+     */
+    maintainer: string;
+    /**
+     * Path to the scripts you want to execute before/after the system
+     * installs/upgrades/removes your package. There are quite a few rules
+     * here,
+     * so please check
+     * {@link
+     * https://www.debian.org/doc/debian-policy/ch-maintainerscripts.html} for
+     * details.
+     */
+    maintainerScripts?: Partial<Record<MaintainerScript, string>>;
+    /**
+     * Binary package name. Must be at least two characters long and must start
+     * with an alphanumeric character. Only lower case letters (a-z), digits
+     * (0-9), plus (+) and minus (-) signs, and periods (.) are allowed. **This
+     * field is mandatory.**
+     *
+     * {@link https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-source}
+     */
+    packageName: string;
+    /**
+     * See {@link
+     * https://www.debian.org/doc/debian-policy/ch-relationships.html} for
+     * details.
+     */
+    preDepends?: string[];
+    /**
+     * This field represents how important it is that the user have the package
+     * installed. Defaults to `optional`.
+     *
+     * {@link https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-priority}
+     */
+    priority?: Priority;
+    /**
+     * {@link https://www.debian.org/doc/debian-policy/ch-relationships.html}
+     */
+    recommends?: string[];
+    /**
+     * This field specifies an application area into which the package has been
+     * classified. This is a recommended field.
+     *
+     * {@link https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-section}
+     */
+    section?: Section;
+    /**
+     * Short, single-line synopsys for the package. Usually ~80 characters.
+     * **This field is mandatory.**
+     *
+     * {@link https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-description}
+     */
+    shortDescription: string;
+    /**
+     * Source package name.
+     *
+     * {@link https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-source}
+     */
+    source?: string;
+    /**
+     * {@link https://www.debian.org/doc/debian-policy/ch-relationships.html}
+     */
+    suggests?: string[];
+    /**
+     * Version number of the package in the
+     * `[epoch:]upstream_version[-debian_revision]` format. See
+     * {@link https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-version}
+     * for details. **This field is mandatory.**
+     */
+    version: string;
+}