@azure-tools/typespec-providerhub-controller 0.27.0

package/templates/providerhub/versionCollection.sq

@@ -0,0 +1,28 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+// <auto-generated />
+
+
+using System;
+using System.Collections.Generic;
+using Microsoft.TypeSpec.ProviderHub.Controller;
+
+namespace {{nameSpace}}.Service
+{
+    public class {{serviceName}}ServiceVersions : VersionCollection
+    {
+{{#each versions}}
+        public const string {{versionName this}} = "{{this}}";
+{{/each}}
+        public {{serviceName}}ServiceVersions() 
+        {
+            var versions = new List<string>();
+            Versions = versions;
+{{#each versions as |version index  |}}
+            versions.Add("{{version}}");
+{{/each}}
+        }
+        protected override IReadOnlyList<string> Versions { get; }
+    }
+}

package/templates/providerhub/versionedContractResolver.sq

@@ -0,0 +1,57 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+// <auto-generated />
+
+using System;
+using System.Collections.Generic;
+using System.Runtime.Serialization;
+using Microsoft.TypeSpec.ProviderHub.Controller;
+
+namespace {{nameSpace}}.Service
+{
+    /// <summary>
+    /// Contract resolver for the service.  This is generated to allow extensibility only.
+    /// </summary>
+    public partial class VersionedContractResolver : VersionedContractResolverBase
+    {
+        Func<Type, string> VersionLookup { get; set; }
+
+        /// <summary>
+        /// Extensibility point, allows performing actions befofe the VersionLookup function is initialized.
+        /// </summary>
+        /// <param name="version">The service version</param>
+        /// <param name="versionLookup">The function to look up versioned class information using the service version.</param>
+        partial void OnBeforeInitialize(string version, Func<Type, string> versionLookup);
+
+        /// <summary>
+        /// Extensibility point, allows performing actions after the VersionLookup function is initialized.
+        /// </summary>
+        /// <param name="version">The service version</param>
+        /// <param name="versionLookup">The function to look up versioned class information using the service version.</param>
+        partial void OnAfterInitialize(string version, Func<Type, string> versionLookup);
+
+        /// <summary>
+        /// Construct a contract resolver, using the given version and class version mapping function.
+        /// This constructor is used by the VersionedSerializer to construct the contract.
+        /// </summary>
+        /// <param name="version"></param>
+        /// <param name="versionLookup"></param>
+        public VersionedContractResolver(string version, Func<Type, string> versionLookup) : base(version)
+        {
+            OnBeforeInitialize(version, versionLookup);
+            VersionLookup = versionLookup;
+            OnAfterInitialize(version, versionLookup);
+        }
+
+        /// <summary>
+        /// Implementing contract resolvers must provide a type-> version dictionary for types they support.
+        /// This allows the service to implement service version -> library version type mappings, based on
+        /// the versioned dependency in the API specification.
+        /// </summary>
+        /// <param name="objectType">The Type of the class to provide versioning for</param>
+        /// <returns>The version for the given class</returns>
+        protected override string GetModelVersion(Type objectType) => VersionLookup(objectType);
+    }
+}
+

package/templates/providerhub/versionedSerializer.sq

@@ -0,0 +1,38 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+// <auto-generated />
+
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using Microsoft.TypeSpec.ProviderHub.Controller;
+
+namespace {{nameSpace}}.Service
+{
+    /// <summary>
+    /// The main entry point for serialization
+    /// </summary>
+    public class VersionedSerializer : VersionedSerializerBase<VersionedContractResolver>
+    {
+        /// <summary>
+        /// The main entry point for serialization
+        /// </summary>
+        public static VersionedSerializer Instance { get; } = new VersionedSerializer();
+        public IReadOnlyList<string> ServiceVersions { get; }
+        public VersionComparer ServiceVersionComparer { get; } 
+
+        private VersionedSerializer()
+        {
+            ServiceVersions = new {{serviceName}}ServiceVersions();
+            ServiceVersionComparer = new VersionComparer(new {{serviceName}}ServiceVersions());
+        }
+
+        protected override VersionedContractResolver GetResolver(string version)
+        {
+            if (ServiceVersions.Contains(version, ServiceVersionComparer))
+                return UpdateResolver(new VersionedContractResolver(version, (t) => GetModelVersion(t, version)));
+            throw new ArgumentException($"Version '{version}' is not valid. Please choose from '{string.Join(", ", ServiceVersions)}'");
+        }
+    }
+}