feat: support pricing model in the manifest file (#749)

* feat: support pricing model in the manifest file * feat: make pricing value case insensitive * Revert "feat: make pricing value case insensitive" This reverts commit 29d1fb4.
microsoft · Oct 21, 2022 · 1dcedef · 1dcedef
1 parent 2589114
commit 1dcedef
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 0 deletions.
diff --git a/src/manifest.ts b/src/manifest.ts
@@ -79,6 +79,7 @@ export interface Manifest {
 	dependencies?: { [name: string]: string };
 	devDependencies?: { [name: string]: string };
 	private?: boolean;
+	pricing?: string;
 
 	// vsce
 	vsce?: any;

diff --git a/src/package.ts b/src/package.ts
@@ -172,6 +172,7 @@ export interface VSIX {
 	localizedLanguages: string;
 	preRelease: boolean;
 	sponsorLink: string;
+	pricing: string;
 }
 
 export class BaseProcessor implements IProcessor {
@@ -475,6 +476,7 @@ export class ManifestProcessor extends BaseProcessor {
 			target,
 			engine: manifest.engines['vscode'],
 			description: manifest.description ?? '',
+			pricing: manifest.pricing ?? 'Free',
 			categories: (manifest.categories ?? []).join(','),
 			flags: flags.join(' '),
 			links: {
@@ -1191,6 +1193,10 @@ export function validateManifest(manifest: Manifest): Manifest {
 		throw new Error('Manifest missing field: version');
 	}
 
+	if (manifest.pricing && !['Free', 'Trial'].includes(manifest.pricing)) {
+		throw new Error('Pricing should be Free or Trial');
+	}
+
 	validateVersion(manifest.version);
 
 	if (!manifest.engines) {
@@ -1404,6 +1410,8 @@ export async function toVsixManifest(vsix: VSIX): Promise<string> {
 						: ''
 				}
 				<Property Id="Microsoft.VisualStudio.Services.GitHubFlavoredMarkdown" Value="${escape(vsix.githubMarkdown)}" />
+				<Property Id="Microsoft.VisualStudio.Services.Content.Pricing" Value="${escape(vsix.pricing)}"/>
+
 				${
 					vsix.enableMarketplaceQnA !== undefined
 						? `<Property Id="Microsoft.VisualStudio.Services.EnableMarketplaceQnA" Value="${escape(

diff --git a/src/test/package.test.ts b/src/test/package.test.ts
@@ -390,6 +390,13 @@ describe('validateManifest', () => {
 		validateManifest(createManifest({ sponsor: { url: 'https://foo.bar' } }));
 		validateManifest(createManifest({ sponsor: { url: 'http://www.foo.com' } }));
 	});
+
+	it('should validate pricing', () => {
+		assert.throws(() => validateManifest(createManifest({ pricing: 'Paid' })));
+		validateManifest(createManifest({ pricing: 'Trial' }));
+		validateManifest(createManifest({ pricing: 'Free' }));
+		validateManifest(createManifest());
+	});
 });
 
 describe('toVsixManifest', () => {
@@ -1724,6 +1731,13 @@ describe('toVsixManifest', () => {
 
 		throw new Error('Should not reach here');
 	});
+
+	it('should identify trial version of an extension', async () => {
+		const manifest = createManifest({ pricing: 'Trial' });
+		var raw = await _toVsixManifest(manifest, []);
+		const xmlManifest = await parseXmlManifest(raw);
+		assertProperty(xmlManifest, 'Microsoft.VisualStudio.Services.Content.Pricing', 'Trial');
+	});
 });
 
 describe('qna', () => {