feat: add XLTS (extended-LTS) option

Author: mob-sakai

src/cli.ts

@@ -52,16 +52,17 @@ new Command()
       .example("unity-changeset list --lts --latest-patch", "List changesets of the latest patch versions (LTS only).")
       // Search options.
       .group("Search options")
-      .option("--all", "Search all changesets (alpha/beta included)", { conflicts: ["pre-release"] })
-      .option("--pre-release, --beta", "Search only pre-release (alpha/beta) changesets", { conflicts: ["all"] })
+      .option("--all", "Search all changesets (alpha/beta included)")
+      .option("--pre-release, --beta", "Search only pre-release (alpha/beta) changesets", { conflicts: ["all", "lts", "xlts"] })
+      .option("--lts", "Only the LTS versions", { conflicts: ["all", "pre-release", "xlts"] })
+      .option("--xlts", "Only the LTS/XLTS versions (require 'Enterprise' or 'Industry' license to install XLTS version)", { conflicts: ["all", "pre-release", "lts"] })
       // Filter options.
       .group("Filter options")
       .option("--min <version>", "Minimum version (included)")
       .option("--max <version>", "Maximum version (included)")
       .option("--grep <regex>", "Regular expression (e.g. '20(18|19).4.*')")
       .option("--latest-lifecycle", "Only the latest lifecycle (default)")
       .option("--all-lifecycles", "All lifecycles", { conflicts: ["latest-lifecycle"] })
-      .option("--lts", "Only the LTS versions", { conflicts: ["pre-release"] })
       // Group options.
       .group("Group options")
       .option("--latest-patch", "The latest patch versions only")
@@ -79,8 +80,10 @@ new Command()
           : options.preRelease
             ? SearchMode.PreRelease
             : options.lts
-             ? SearchMode.LTS
-             : SearchMode.Default;
+              ? SearchMode.LTS
+              : options.xlts
+                ? SearchMode.XLTS
+                : SearchMode.Default;
 
         // Group mode.
         const groupMode = (options.latestPatch || options.minorVersionOnly)

src/index.ts

@@ -1,5 +1,5 @@
 import { UnityChangeset as UnityChangesetClass } from "./unityChangeset.ts";
-import { getUnityReleases, getUnityReleasesInLTS, UnityReleaseStream } from "./unityGraphQL.ts";
+import { getUnityReleases, getUnityReleasesInLTS, UnityReleaseEntitlement, UnityReleaseStream } from "./unityGraphQL.ts";
 
 export const UnityChangeset = UnityChangesetClass;
 export type UnityChangeset = UnityChangesetClass;
@@ -33,6 +33,7 @@ export enum SearchMode {
   Default = 2,
   PreRelease = 3,
   LTS = 4,
+  XLTS = 5,
 }
 
 /*
@@ -154,6 +155,8 @@ export function searchChangesets(
       ]);
     case SearchMode.LTS:
       return getUnityReleasesInLTS();
+    case SearchMode.XLTS:
+      return getUnityReleasesInLTS([UnityReleaseEntitlement.XLTS]);
     default:
       throw Error(`The given search mode '${searchMode}' was not supported`);
   }

src/unityGraphQL.ts

@@ -10,6 +10,11 @@ export enum UnityReleaseStream {
   ALPHA = "ALPHA",
 }
 
+export enum UnityReleaseEntitlement {
+  XLTS = "XLTS",
+  U7_ALPHA = "U7_ALPHA",
+}
+
 interface UnityReleasesResponse {
   getUnityReleases: {
     totalCount: number;
@@ -25,17 +30,18 @@ interface UnityReleasesMajorVersionsResponse {
 export async function getUnityReleases(
   version: string,
   stream: UnityReleaseStream[] = [],
+  entitlements: UnityReleaseEntitlement[] = []
 ): Promise<UnityChangeset[]> {
   const client = new GraphQLClient(UNITY_GRAPHQL_ENDPOINT);
   const query = gql`
-query GetRelease($limit: Int, $skip: Int, $version: String!, $stream: [UnityReleaseStream!])
+query GetRelease($limit: Int, $skip: Int, $version: String!, $stream: [UnityReleaseStream!], $entitlements: [UnityReleaseEntitlement!])
 {
   getUnityReleases(
     limit: $limit
     skip: $skip
     stream: $stream
     version: $version
-    entitlements: []
+    entitlements: $entitlements
   ) {
     totalCount
     edges {
@@ -51,11 +57,13 @@ query GetRelease($limit: Int, $skip: Int, $version: String!, $stream: [UnityRele
   }
 }
 `;
+
   const variables = {
     limit: 1000,
     skip: 0,
     version: version,
     stream: stream,
+    entitlements: entitlements,
   };
 
   const results: UnityChangeset[] = [];
@@ -76,25 +84,33 @@ query GetRelease($limit: Int, $skip: Int, $version: String!, $stream: [UnityRele
   return results;
 }
 
-export async function getUnityReleasesInLTS(): Promise<UnityChangeset[]> {
+export async function getUnityReleasesInLTS(
+  entitlements: UnityReleaseEntitlement[] = [],
+): Promise<UnityChangeset[]> {
   const client = new GraphQLClient(UNITY_GRAPHQL_ENDPOINT);
   const query = gql`
-query {
+query GetReleaseMajorVersions($entitlements: [UnityReleaseEntitlement!])
+{
   getUnityReleaseMajorVersions(
     stream: []
     platform: []
     architecture: []
-    entitlements: []
+    entitlements: $entitlements
   ) {
     version
   }
 }
 `;
-  const data: UnityReleasesMajorVersionsResponse = await client.request(query);
+
+  const variables = {
+    entitlements: entitlements,
+  };
+
+  const data: UnityReleasesMajorVersionsResponse = await client.request(query, variables);
   const results = await Promise.all(data.getUnityReleaseMajorVersions
     .map(async (v) => {
-      return await getUnityReleases(v.version, [UnityReleaseStream.LTS]);
-}));
+      return await getUnityReleases(v.version, [UnityReleaseStream.LTS], entitlements);
+    }));
 
   return results.flat();
 }