@equinor/fusion-framework-cli
Version:
Command-line toolkit for developing, building, and publishing Fusion Framework applications and portal templates. Provides a unified developer experience from local development to production deployment.
98 lines • 4.39 kB
JavaScript
import { z } from 'zod';
/**
* Zod schema for validating the build section of the PortalManifest object.
*
* This schema defines the structure and types for the build metadata used in the portal manifest.
*
* @remarks
* - Maintainers: Update this schema if the build contract changes.
* - This schema is the canonical source for portal build validation and structure.
*/
export const PortalManifestBuildSchema = z.object({
// Main entry point for the portal (required)
templateEntry: z
.string({ message: 'templateEntry must be a string' })
.describe('Main entry point for the portal'),
// Schema file for portal validation (required)
schemaEntry: z
.string({ message: 'schemaEntry must be a string' })
.describe('Schema file for portal validation'),
// Asset path for dev/preview builds (optional)
assetPath: z
.string({ message: 'assetPath must be a string' })
.optional()
.describe('Asset path for dev/preview builds'),
// GitHub repo URL or local git remote (optional)
githubRepo: z
.string({ message: 'githubRepo must be a string' })
.optional()
.describe('GitHub repo URL or local git remote'),
// Version from package.json (required)
version: z.string({ message: 'version must be a string' }).describe('Version from package.json'),
// Current build timestamp (ISO8601, required)
timestamp: z
.string({ message: 'timestamp must be a string' })
.describe('Current build timestamp (ISO8601)'),
// Current git commit SHA (required)
commitSha: z.string({ message: 'commitSha must be a string' }).describe('Current git commit SHA'),
// Optional build annotations (key-value pairs)
// Accepts Record<string, string | null | undefined> and removes undefined values
// while preserving explicit null values from input
annotations: z
.record(z.string(), z.string().nullish())
.optional()
.transform((rec) => {
if (!rec) {
return undefined;
}
return Object.fromEntries(Object.entries(rec).filter(([, value]) => value !== undefined));
})
.describe('Optional build annotations'),
// Optional project homepage
projectPage: z
.string({ message: 'projectPage must be a string' })
.optional()
.describe('Optional project homepage'),
// List of allowed asset extensions (with leading dot, required)
allowedExtensions: z
.array(z.string({ message: 'Each allowed extension must be a string' }), {
message: 'allowedExtensions must be an array of strings',
})
.describe('List of allowed asset extensions (with leading dot)'),
// Optional schema for the portal (record of unknown values)
schema: z.record(z.string(), z.unknown()).optional().describe('Optional schema for the portal'),
// Optional configuration for the portal (record of unknown values)
config: z
.record(z.string(), z.unknown())
.optional()
.describe('Optional configuration for the portal'),
});
/**
* Zod schema for validating the PortalManifest object.
*
* This schema defines the structure and types for the portal manifest used in the Fusion Framework CLI.
* It ensures that the manifest adheres to expected types and provides sensible defaults for build metadata.
*
* @remarks
* - Maintainers: Update this schema if the portal manifest contract changes.
* - This schema is the canonical source for portal manifest validation and structure.
*/
export const PortalManifestSchema = z.object({
// Short app key (unscoped, derived from package name, required)
name: z
.string({ message: 'name must be a string' })
.describe('Short app key (unscoped, derived from package name)'),
// Full package name, may include scope (optional)
displayName: z
.string({ message: 'displayName must be a string' })
.optional()
.describe('Full package name, may include scope'),
// Description of the portal (optional)
description: z
.string({ message: 'description must be a string' })
.optional()
.describe('Description of the portal'),
// Build section (required, validated by PortalManifestBuildSchema)
build: PortalManifestBuildSchema,
});
//# sourceMappingURL=portal-manifest.schema.js.map