balena-cli 23.2.14 → 23.2.15-build-update-compose-7-3-0-97bf26975807627a264274621ffcf8380aea838e-1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "balena-cli",
-  "version": "23.2.14",
+  "version": "23.2.15-build-update-compose-7-3-0-97bf26975807627a264274621ffcf8380aea838e-1",
   "description": "The official balena Command Line Interface",
   "main": "./build/app.js",
   "homepage": "https://github.com/balena-io/balena-cli",
@@ -176,7 +176,7 @@
     "typescript": "^5.9.2"
   },
   "dependencies": {
-    "@balena/compose": "^7.0.10",
+    "@balena/compose": "^7.3.0",
     "@balena/dockerignore": "^1.0.2",
     "@balena/env-parsing": "^1.1.8",
     "@balena/es-version": "^1.0.1",
@@ -262,6 +262,6 @@
     "balena-request": "14.0.6"
   },
   "versionist": {
-    "publishedAt": "2025-12-30T11:51:18.913Z"
+    "publishedAt": "2026-01-05T23:04:56.483Z"
   }
 }

package/src/commands/os/configure.ts

@@ -208,7 +208,7 @@ export default class OsConfigureCmd extends Command {
 			})) as DeviceWithDeviceType & {
 				belongs_to__application: BalenaSdk.PineDeferred;
 			};
-			deviceTypeSlug = device.is_of__device_type[0].slug;
+			deviceTypeSlug = device.is_of__device_type[0].slug!;
 		} else if (fleetSlugOrId != null) {
 			app = await getApplication(balena, fleetSlugOrId, {
 				$select: 'slug',
@@ -226,7 +226,7 @@ export default class OsConfigureCmd extends Command {
 
 		const deviceTypeManifest = await helpers.getManifest(
 			params.image,
-			deviceTypeSlug,
+			deviceTypeSlug!,
 		);
 
 		const { normalizeOsVersion } = await import('../../utils/normalization');
@@ -242,7 +242,7 @@ export default class OsConfigureCmd extends Command {
 		);
 		await validateSecureBootOptionAndWarn(
 			secureBoot,
-			deviceTypeSlug,
+			deviceTypeSlug!,
 			osVersion,
 		);
 
@@ -258,7 +258,7 @@ export default class OsConfigureCmd extends Command {
 					};
 		const answers: AugmentedAnswers = {
 			...baseAnswers,
-			deviceType: deviceTypeSlug,
+			deviceType: deviceTypeSlug!,
 			version: osVersion,
 			developmentMode: developmentMode,
 			secureBoot: secureBoot,

package/src/commands/release/list.ts

@@ -89,10 +89,10 @@ export default class ReleaseListCmd extends Command {
 				(r) => r.id,
 			);
 
-			const augmentedReleases = releases.map((release) => ({
-				...release,
-				...releasesWithExplicitReadFieldsById[release.id],
-			}));
+			const augmentedReleases = releases.map((release) => {
+				const extra = releasesWithExplicitReadFieldsById[release.id];
+				return typeof extra === 'object' ? { ...release, ...extra } : release;
+			});
 
 			await pipeline(
 				Readable.from(augmentedReleases),

package/src/utils/compose-types.d.ts

@@ -15,10 +15,7 @@
  * limitations under the License.
  */
 
-import type {
-	ImageModel,
-	ReleaseModel,
-} from '@balena/compose/dist/release/models';
+import type { BalenaModel } from 'balena-sdk';
 import type { Composition, ImageDescriptor } from '@balena/compose/dist/parse';
 import type { Pack } from 'tar-stream';
 
@@ -27,25 +24,32 @@ interface Image {
 	tag: string;
 }
 
+interface ImageProperties {
+	dockerfile?: string;
+	projectType?: string;
+	size?: number;
+	startTime?: Date;
+	endTime?: Date;
+}
+
 export interface BuiltImage {
 	logs: string;
 	name: string;
-	props: {
-		dockerfile?: string;
-		projectType?: string;
-		size?: number;
-		startTime?: Date;
-		endTime?: Date;
-	};
+	props: ImageProperties;
 	serviceName: string;
 }
 
+type ServiceImage = Omit<
+	BalenaModel['image']['Read'],
+	'created_at' | 'is_a_build_of__service'
+>;
+
 export interface TaggedImage {
 	localImage: import('dockerode').Image;
-	serviceImage: import('@balena/compose/dist/release/models').ImageModel;
+	serviceImage: ServiceImage;
 	serviceName: string;
 	logs: string;
-	props: BuiltImage.props;
+	props: ImageProperties;
 	registry: string;
 	repo: string;
 }
@@ -82,23 +86,32 @@ export interface ComposeProject {
 export interface Release {
 	client: import('@balena/compose').release.Request['client'];
 	release: Pick<
-		ReleaseModel,
+		BalenaModel['release']['Read'],
 		| 'id'
 		| 'status'
 		| 'commit'
 		| 'composition'
 		| 'source'
 		| 'is_final'
-		| 'contract'
 		| 'semver'
 		| 'start_timestamp'
 		| 'end_timestamp'
-	>;
-	serviceImages: Dictionary<
-		Omit<ImageModel, 'created_at' | 'is_a_build_of__service'>
-	>;
+	> & {
+		contract: Contract | null;
+	};
+	serviceImages: Dictionary<ServiceImage>;
 }
 
+// TODO: The balena contract model for release.contract is `{ [key: string]: JSON } | JSON[] | null`
+// which appears to be incorrect, as a contract is represented as `{ [key: string]: any }`
+// (more specifically, `{ type: string, [key: string]: any }`) when querying a release for its contract.
+// @balena/contrato also defines a ContractObject as the type below, see:
+// https://github.com/balena-io/contrato/blob/543e891249431aa98474e17fecc66617ab9ca8f3/lib/types.ts#L15-L17
+export type Contract = {
+	type: string;
+	[key: string]: any;
+};
+
 interface TarDirectoryOptions {
 	composition?: Composition;
 	convertEol?: boolean;

package/src/utils/compose.ts

@@ -26,6 +26,7 @@ import type {
 	ComposeOpts,
 	ComposeProject,
 	Release,
+	Contract,
 	TaggedImage,
 } from './compose-types';
 import Logger = require('./logger');
@@ -128,7 +129,7 @@ export const createRelease = async function (
 	composition: Composition,
 	draft: boolean,
 	semver: string | undefined,
-	contract: import('@balena/compose/dist/release/models').ReleaseModel['contract'],
+	contract: Contract | undefined,
 	imgDescriptors: ImageDescriptor[],
 ): Promise<Release> {
 	const crypto = require('crypto') as typeof import('crypto');
@@ -165,16 +166,18 @@ export const createRelease = async function (
 		commit: crypto.pseudoRandomBytes(16).toString('hex').toLowerCase(),
 		semver,
 		is_final: !draft,
-		contract,
+		contract: contract ?? undefined,
 		imgDescriptors,
 	});
 
 	for (const serviceImage of Object.values(serviceImages)) {
 		if ('created_at' in serviceImage) {
-			delete serviceImage.created_at;
+			// created_at is not an optional field in the SDK, but we need to delete it
+			serviceImage.created_at = undefined as any;
 		}
 		if ('is_a_build_of__service' in serviceImage) {
-			delete serviceImage.is_a_build_of__service;
+			// is_a_build_of__service is not an optional field in the SDK, but we need to delete it
+			serviceImage.is_a_build_of__service = undefined as any;
 		}
 	}
 
@@ -191,7 +194,7 @@ export const createRelease = async function (
 			'semver',
 			'start_timestamp',
 			'end_timestamp',
-		]),
+		]) as Release['release'],
 		serviceImages,
 	};
 };

package/src/utils/compose_ts.ts

@@ -39,6 +39,8 @@ import type {
 	ComposeProject,
 	TaggedImage,
 	TarDirectoryOptions,
+	Release,
+	Contract,
 } from './compose-types';
 import type { DeviceInfo } from './device/api';
 import { getBalenaSdk, getCliUx, stripIndent } from './lazy';
@@ -1274,7 +1276,7 @@ async function pushAndUpdateServiceImages(
 	token: string,
 	images: TaggedImage[],
 	afterEach: (
-		serviceImage: import('@balena/compose/dist/release/models').ImageModel,
+		serviceImage: TaggedImage['serviceImage'],
 		props: object,
 	) => Promise<void>,
 ) {
@@ -1330,15 +1332,15 @@ async function pushAndUpdateServiceImages(
 			serviceImage.image_size = `${imgInfo.Size}`;
 			serviceImage.content_hash = imgDigest;
 			serviceImage.build_log = logs;
-			serviceImage.dockerfile = props.dockerfile;
-			serviceImage.project_type = props.projectType;
+			serviceImage.dockerfile = props.dockerfile ?? null;
+			serviceImage.project_type = props.projectType ?? null;
 			if (props.startTime) {
-				serviceImage.start_timestamp = props.startTime;
+				serviceImage.start_timestamp = props.startTime.toISOString();
 			}
 			if (props.endTime) {
-				serviceImage.end_timestamp = props.endTime;
+				serviceImage.end_timestamp = props.endTime.toISOString();
 			}
-			serviceImage.push_timestamp = new Date();
+			serviceImage.push_timestamp = new Date().toISOString();
 			serviceImage.status = 'success';
 		} catch (error) {
 			serviceImage.error_message = '' + error;
@@ -1379,7 +1381,7 @@ async function pushServiceImages(
 				`Saving image ${serviceImage.is_stored_at__image_location}`,
 			);
 			if (skipLogUpload) {
-				delete serviceImage.build_log;
+				serviceImage.build_log = null;
 			}
 
 			// These are the only update-able image fields in bC atm, and passing
@@ -1425,7 +1427,7 @@ export async function deployProject(
 	projectPath: string,
 	isDraft: boolean,
 	imgDescriptors: ImageDescriptor[],
-): Promise<import('@balena/compose/dist/release/models').ReleaseModel> {
+): Promise<Release['release']> {
 	const releaseMod = await import('@balena/compose/dist/release');
 	const { createRelease, tagServiceImages } = await import('./compose');
 	const tty = (await import('./tty'))(process.stdout);
@@ -1496,7 +1498,7 @@ export async function deployProject(
 		}
 	} finally {
 		await runSpinner(tty, spinner, `${prefix}Saving release...`, async () => {
-			release.end_timestamp = new Date();
+			release.end_timestamp = new Date().toISOString();
 			if (release.id != null) {
 				await releaseMod.updateRelease(pineClient, release.id, {
 					status: release.status,
@@ -1552,9 +1554,7 @@ export function createRunLoop(tick: (...args: any[]) => void) {
 
 async function getContractContent(
 	filePath: string,
-): Promise<
-	import('@balena/compose/dist/release/models').ReleaseModel['contract']
-> {
+): Promise<Contract | undefined> {
 	let fileContentAsString;
 	try {
 		fileContentAsString = await fs.readFile(filePath, 'utf8');
@@ -1584,7 +1584,7 @@ async function getContractContent(
 	return asJson;
 }
 
-function isContract(obj: any): obj is Dictionary<any> {
+function isContract(obj: any): obj is Contract {
 	return obj?.type && allowedContractTypes.includes(obj.type);
 }