[tcgc] unify datetime casing by renaming interface types (Azure#1067)

fixes Azure#799 --------- Co-authored-by: iscai-msft <isabellavcai@gmail.com>
markcowl · Jun 26, 2024 · a1a4bad · a1a4bad
1 parent 8e6e6e6
commit a1a4bad
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 11 deletions.
diff --git a/.chronus/changes/rename_datetime_type-2024-5-24-14-52-19.md b/.chronus/changes/rename_datetime_type-2024-5-24-14-52-19.md
@@ -0,0 +1,7 @@
+---
+changeKind: fix
+packages:
+  - "@azure-tools/typespec-client-generator-core"
+---
+
+Unify casing of datetime spelling to `DateTime`. Change interface names to `SdkDateTimeType`, `SdkUtcDateTimeType`, and `SdkOffsetDateTimeType`
diff --git a/packages/typespec-client-generator-core/doc/types.tsp b/packages/typespec-client-generator-core/doc/types.tsp
@@ -84,7 +84,7 @@ model SdkBuiltInType extends SdkType {
  * @property encode: How to encode the datetime and represent to users
  * @property wireType: What type we end up sending over the wire for a datetime. Can be a string or an int type.
  */
-model SdkDatetimeType extends SdkType {
+model SdkDateTimeType extends SdkType {
   kind: "datetime";
   encode: DateTimeKnownEncoding;
   wireType: SdkType;

diff --git a/packages/typespec-client-generator-core/src/interfaces.ts b/packages/typespec-client-generator-core/src/interfaces.ts
@@ -86,7 +86,7 @@ interface SdkTypeBase {
 
 export type SdkType =
   | SdkBuiltInType
-  | SdkDatetimeType
+  | SdkDateTimeType
   | SdkDurationType
   | SdkArrayType
   | SdkTupleType
@@ -197,26 +197,41 @@ export function isSdkFloatKind(kind: string): kind is keyof typeof SdkFloatKinds
   return kind in SdkFloatKindsEnum;
 }
 
-const SdkDatetimeEncodingsConst = ["rfc3339", "rfc7231", "unixTimestamp"] as const;
+const SdkDateTimeEncodingsConst = ["rfc3339", "rfc7231", "unixTimestamp"] as const;
 
-export function isSdkDatetimeEncodings(encoding: string): encoding is DateTimeKnownEncoding {
-  return SdkDatetimeEncodingsConst.includes(encoding as DateTimeKnownEncoding);
+export function isSdkDateTimeEncodings(encoding: string): encoding is DateTimeKnownEncoding {
+  return SdkDateTimeEncodingsConst.includes(encoding as DateTimeKnownEncoding);
 }
 
-interface SdkDatetimeTypeBase extends SdkTypeBase {
+interface SdkDateTimeTypeBase extends SdkTypeBase {
   encode: DateTimeKnownEncoding;
   wireType: SdkBuiltInType;
 }
 
-interface SdkUtcDatetimeType extends SdkDatetimeTypeBase {
+interface SdkUtcDateTimeType extends SdkDateTimeTypeBase {
   kind: "utcDateTime";
 }
 
-interface SdkOffsetDatetimeType extends SdkDatetimeTypeBase {
+interface SdkOffsetDateTimeType extends SdkDateTimeTypeBase {
   kind: "offsetDateTime";
 }
 
-export type SdkDatetimeType = SdkUtcDatetimeType | SdkOffsetDatetimeType;
+export type SdkDateTimeType = SdkUtcDateTimeType | SdkOffsetDateTimeType;
+
+/**
+ * @deprecated: Use SdkDateTimeType instead.
+ */
+export type SdkDatetimeType = SdkDateTimeType;
+
+/**
+ * @deprecated: Use SdkUtcDateTimeType instead.
+ */
+export type SdkUtcDatetimeType = SdkUtcDateTimeType;
+
+/**
+ * @deprecated Use SdkOffsetDateTimeType instead.
+ */
+export type SdkOffsetDatetimeType = SdkOffsetDateTimeType;
 
 export interface SdkDurationType extends SdkTypeBase {
   kind: "duration";

diff --git a/packages/typespec-client-generator-core/src/types.ts b/packages/typespec-client-generator-core/src/types.ts
@@ -59,7 +59,7 @@ import {
   SdkConstantType,
   SdkCredentialParameter,
   SdkCredentialType,
-  SdkDatetimeType,
+  SdkDateTimeType,
   SdkDictionaryType,
   SdkDurationType,
   SdkEnumType,
@@ -840,7 +840,7 @@ export function getClientTypeWithDiagnostics(
           ...getSdkTypeBaseHelper(context, type, type.name),
           encode: "rfc3339",
           wireType: { ...getSdkTypeBaseHelper(context, type, "string"), encode: "string" },
-        } as SdkDatetimeType;
+        } as SdkDateTimeType;
         break;
       }
       if (type.name === "duration") {