Still accept title instead of label for now, mark as deprecated

interval · Mar 10, 2023 · 96a618b · 96a618b
1 parent 3e3b30f
commit 96a618b
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 7 deletions.
diff --git a/src/classes/TransactionLoadingState.ts b/src/classes/TransactionLoadingState.ts
@@ -1,15 +1,18 @@
-import { LoadingOptions, LoadingState } from '../internalRpcSchema'
+import {
+  BackwardCompatibleLoadingOptions,
+  BackwardCompatibleLoadingState,
+} from '../internalRpcSchema'
 import Logger from './Logger'
 
 export interface TransactionLoadingStateConfig {
   logger: Logger
-  send: (loadingState: LoadingState) => Promise<void>
+  send: (loadingState: BackwardCompatibleLoadingState) => Promise<void>
 }
 
 export default class TransactionLoadingState {
   #logger: Logger
   #sender: TransactionLoadingStateConfig['send']
-  #state: LoadingState | undefined
+  #state: BackwardCompatibleLoadingState | undefined
   #sendTimeout: NodeJS.Timeout | null = null
   #sendTimeoutMs = 100
 
@@ -49,7 +52,7 @@ export default class TransactionLoadingState {
    * await ctx.loading.start("Label only shorthand");
    *```
    */
-  async start(options?: string | LoadingOptions) {
+  async start(options?: string | BackwardCompatibleLoadingOptions) {
     if (typeof options === 'string') {
       options = { label: options }
     } else if (options === undefined) {
@@ -81,7 +84,7 @@ export default class TransactionLoadingState {
    * });
    *```
    */
-  async update(options?: string | LoadingOptions) {
+  async update(options?: string | BackwardCompatibleLoadingOptions) {
     if (!this.#state) {
       this.#logger.warn('Please call `loading.start` before `loading.update`')
       return this.start(options)

diff --git a/src/components/displayGrid.ts b/src/components/displayGrid.ts
@@ -6,7 +6,10 @@ type PublicProps<Row = any> = Omit<
   T_IO_PROPS<'DISPLAY_GRID'>,
   'data' | 'totalRecords' | 'isAsync'
 > & {
-  renderItem: (row: Row) => GridItem
+  renderItem: (row: Row) => GridItem & {
+    /** @deprecated Please use `label` instead. */
+    title?: string | null
+  }
 } & (
     | {
         data: Row[]

diff --git a/src/internalRpcSchema.ts b/src/internalRpcSchema.ts
@@ -51,7 +51,7 @@ const LOADING_STATE = z.object({
 
 const BACKWARD_COMPATIBLE_LOADING_STATE = LOADING_STATE.merge(
   z.object({
-    // @deprecated in favor of `label` (for real this time)
+    /** @deprecated in favor of `label` (for real this time) */
     title: z.string().optional(),
   })
 )
@@ -65,6 +65,10 @@ const SDK_ALERT = z.object({
 export type SdkAlert = z.infer<typeof SDK_ALERT>
 
 export type LoadingOptions = z.input<typeof LOADING_OPTIONS>
+export type BackwardCompatibleLoadingOptions = LoadingOptions & {
+  /** @deprecated Please use `label` instead. */
+  title?: string
+}
 export type LoadingState = z.input<typeof LOADING_STATE>
 export type BackwardCompatibleLoadingState = z.input<
   typeof BACKWARD_COMPATIBLE_LOADING_STATE