RIA Packager

Package for creating Adobe AIR packages

Overview

Creates AIR packages from the packaged files, and an AIR SDK if necessary.

When an AIR SDK is necessary, it can use a directory containing an AIR SDK, or an AIR SDK archive (shockpkg package file).

Reading DMG SDK packages is only supported on macOS, using ZIP packages instead is recommended.

Not all possible package formats are supported, and some have individual limitations.

Some packagers have extra features which can optionally be enabled for things the official packager does not support.

This package is not as strict about various things and will allow packaging applications that the official packager would reject as invalid.

Currently there is no option for creating license files for packaging HARMAN SDK runtimes.

Usage

AIR Installer

import {readFile} from 'node:fs/promises';
import {
	PackagerAirInstaller,
	SecurityKeystorePkcs12
} from '@shockpkg/ria-packager';

const packager = new PackagerAirInstaller('application.air');
packager.descriptorFile = 'src/application-app.xml';
packager.keystore = SecurityKeystorePkcs12.decode(
	await readFile('key.p12'),
	'password'
);
packager.timestampUrl = 'http://timestamp.digicert.com/';

// Options:
packager.profile = 'extendedDesktop';

await packager.write(async packager => {
	await packager.addResourceFile('src/main.swf', 'main.swf');
	await packager.addResourceDirectory('src/icons', 'icons');
});

Bundle (Captive Runtime)

Limitations:

• Native extensions not supported.

Bundle Windows

import {readFile} from 'node:fs/promises';
import {
	PackagerBundleWindows,
	SecurityKeystorePkcs12
} from '@shockpkg/ria-packager';

const packager = new PackagerAdlWindows('application');
packager.descriptorFile = 'src/application-app.xml';
packager.sdkPath = 'airsdk-win.zip';
packager.keystore = SecurityKeystorePkcs12.decode(
	await readFile('key.p12'),
	'password'
);
packager.timestampUrl = 'http://timestamp.digicert.com/';

// Options:
packager.applicationIconModern = true;
packager.fileTypeIconModern = true;
packager.frameworkCleanHelpers = true;
packager.fileVersion = '1.2.3.4';
packager.productVersion = '1.2.3.4';
packager.versionStrings = {
	CompanyName: 'Custom Company Name',
	LegalCopyright: 'Custom Legal Copyright'
};
packager.architecture = 'x64';

await packager.write(async packager => {
	await packager.addResourceFile('src/main.swf', 'main.swf');
	await packager.addResourceDirectory('src/icons', 'icons');
});

Bundle Mac

Limitations:

• The default icon format does not include the obsolete ICN# and ics# encoded icons.

import {readFile} from 'node:fs/promises';
import {
	PackagerBundleMac,
	SecurityKeystorePkcs12
} from '@shockpkg/ria-packager';

const packager = new PackagerBundleMac('application.app');
packager.descriptorFile = 'src/application-app.xml';
packager.sdkPath = 'airsdk-mac.zip';
packager.keystore = SecurityKeystorePkcs12.decode(
	await readFile('key.p12'),
	'password'
);
packager.timestampUrl = 'http://timestamp.digicert.com/';

// Options:
packager.applicationIconModern = true;
packager.fileTypeIconModern = true;
packager.frameworkCleanOsFiles = true;

await packager.write(async packager => {
	await packager.addResourceFile('src/main.swf', 'main.swf');
	await packager.addResourceDirectory('src/icons', 'icons');
});

ADL (Debug Launcher)

Limitations:

• Native extensions not supported.

ADL Windows

import {PackagerAdlWindows} from '@shockpkg/ria-packager';

const packager = new PackagerAdlWindows('application');
packager.descriptorFile = 'src/application-app.xml';
packager.sdkPath = 'airsdk-win.zip';

// Options:
packager.profile = 'extendedDesktop';
packager.architecture = 'x64';

await packager.write(async packager => {
	await packager.addResourceFile('src/main.swf', 'main.swf');
	await packager.addResourceDirectory('src/icons', 'icons');
});

ADL Mac

import {PackagerAdlMac} from '@shockpkg/ria-packager';

const packager = new PackagerAdlMac('application');
packager.descriptorFile = 'src/application-app.xml';
packager.sdkPath = 'airsdk-mac.zip';

// Options:
packager.profile = 'extendedDesktop';

await packager.write(async packager => {
	await packager.addResourceFile('src/main.swf', 'main.swf');
	await packager.addResourceDirectory('src/icons', 'icons');
});

Bugs

If you find a bug or have compatibility issues, please open a ticket under issues section for this repository.

License

Copyright (c) 2019-2024 JrMasterModelBuilder

Licensed under the Mozilla Public License, v. 2.0.

If this license does not work for you, feel free to contact me.