Merge pull request #2026 from codecrafters-io/standard-interface-sig

add sig type standard
codecrafters-io · Jul 28, 2024 · a6388dd · a6388dd
2 parents e0e6f9d + 88cbf55
commit a6388dd
Show file tree

Hide file tree

Showing 148 changed files with 284 additions and 284 deletions.
diff --git a/.prompts/js-to-ts-component.md b/.prompts/js-to-ts-component.md
@@ -21,7 +21,7 @@ import Component from "@glimmer/component";
 import UserModel from "codecrafters-frontend/models/user";
 import { action } from "@ember/object";
 
-type Signature = {
+interface Signature {
   Element: HTMLDivElement;
 
   Args: {

diff --git a/app/components/affiliate-link-page/accept-referral-button.ts b/app/components/affiliate-link-page/accept-referral-button.ts
@@ -8,7 +8,7 @@ import type RouterService from '@ember/routing/router-service';
 import type AuthenticatorService from 'codecrafters-frontend/services/authenticator';
 
 interface Signature {
-  Element: HTMLElement;
+  Element: HTMLButtonElement;
 
   Args: {
     affiliateLink: AffiliateLinkModel;

diff --git a/app/components/affiliate-link-page/accept-referral-container.ts b/app/components/affiliate-link-page/accept-referral-container.ts
@@ -3,7 +3,7 @@ import logoImage from '/assets/images/logo/logomark-color.svg';
 import type AffiliateLinkModel from 'codecrafters-frontend/models/affiliate-link';
 
 interface Signature {
-  Element: HTMLElement;
+  Element: HTMLDivElement;
 
   Args: {
     affiliateLink: AffiliateLinkModel;

diff --git a/app/components/affiliate-link-page/testimonial-list-item.ts b/app/components/affiliate-link-page/testimonial-list-item.ts
@@ -1,7 +1,7 @@
 import Component from '@glimmer/component';
 
 interface Signature {
-  Element: HTMLElement;
+  Element: HTMLDivElement;
 
   Args: {
     testimonial: {

diff --git a/app/components/avatar-image.ts b/app/components/avatar-image.ts
@@ -3,13 +3,13 @@ import UserModel from 'codecrafters-frontend/models/user';
 import { action } from '@ember/object';
 import { tracked } from '@glimmer/tracking';
 
-type Signature = {
+interface Signature {
   Element: HTMLImageElement;
 
   Args: {
     user: UserModel;
   };
-};
+}
 
 export default class AvatarImageComponent extends Component<Signature> {
   @tracked avatarImageFailedToLoad = false;

diff --git a/app/components/blocks/concept-question-block.ts b/app/components/blocks/concept-question-block.ts
@@ -7,7 +7,7 @@ import Prism from 'prismjs';
 import 'prismjs/components/prism-rust'; // This is the only one we use in concepts at the moment
 import { tracked } from '@glimmer/tracking';
 
-type Signature = {
+interface Signature {
   Element: HTMLDivElement;
 
   Args: {
@@ -16,7 +16,7 @@ type Signature = {
     onStepBackButtonClick: () => void;
     isCurrentBlock: boolean;
   };
-};
+}
 
 export default class ConceptQuestionBlockComponent extends Component<Signature> {
   @tracked isSubmitted = false;

diff --git a/app/components/blocks/markdown-block.ts b/app/components/blocks/markdown-block.ts
@@ -2,16 +2,15 @@ import Component from '@glimmer/component';
 import { MarkdownBlock } from 'codecrafters-frontend/utils/blocks';
 import { action } from '@ember/object';
 import Prism from 'prismjs';
-
 import 'prismjs/components/prism-rust'; // This is the only one we use in concepts at the moment
 
-type Signature = {
+interface Signature {
   Element: HTMLDivElement;
 
   Args: {
     model: MarkdownBlock;
   };
-};
+}
 
 export default class MarkdownBlockComponent extends Component<Signature> {
   @action

diff --git a/app/components/code-walkthrough-snippet.ts b/app/components/code-walkthrough-snippet.ts
@@ -10,10 +10,6 @@ interface Signature {
     filePath: string;
     highlightedLines: string;
   };
-
-  Blocks: {
-    default: [];
-  };
 }
 
 export default class CodeWalkthroughSnippetComponent extends Component<Signature> {}

diff --git a/app/components/comment-form.ts b/app/components/comment-form.ts
@@ -13,7 +13,7 @@ import type AuthenticatorService from 'codecrafters-frontend/services/authentica
 import type AnalyticsEventTrackerService from 'codecrafters-frontend/services/analytics-event-tracker';
 import type LanguageModel from 'codecrafters-frontend/models/language';
 
-type Signature = {
+interface Signature {
   Element: HTMLDivElement;
 
   Args: {
@@ -25,7 +25,7 @@ type Signature = {
     onSubmit?: () => void;
     target: CourseStageModel | CommunityCourseStageSolutionModel;
   };
-};
+}
 
 export default class CommentFormComponent extends Component<Signature> {
   @service declare authenticator: AuthenticatorService;

diff --git a/app/components/concept-admin/blocks-page.ts b/app/components/concept-admin/blocks-page.ts
@@ -5,13 +5,13 @@ import { tracked } from '@glimmer/tracking';
 import { action } from '@ember/object';
 import type Transition from '@ember/routing/transition';
 
-type Signature = {
+interface Signature {
   Element: HTMLDivElement;
 
   Args: {
     concept: ConceptModel;
   };
-};
+}
 
 type BlockWithMetadata = {
   id: string;

diff --git a/app/components/concept-admin/blocks-page/editable-block.ts b/app/components/concept-admin/blocks-page/editable-block.ts
@@ -4,7 +4,7 @@ import { tracked } from '@glimmer/tracking';
 import { action } from '@ember/object';
 import { ClickToContinueBlock, ConceptQuestionBlock, MarkdownBlock } from 'codecrafters-frontend/utils/blocks';
 
-type Signature = {
+interface Signature {
   Element: HTMLDivElement;
 
   Args: {
@@ -22,7 +22,7 @@ type Signature = {
   Blocks: {
     dragHandler: [];
   };
-};
+}
 
 export default class EditableBlockComponent extends Component<Signature> {
   @tracked mutableBlock: Block | null = null;

diff --git a/app/components/concept-admin/blocks-page/insert-block-marker-dropdown-item.ts b/app/components/concept-admin/blocks-page/insert-block-marker-dropdown-item.ts
@@ -4,9 +4,9 @@ interface Signature {
   Element: HTMLDivElement;
 
   Args: {
+    description: string;
     icon: string;
     title: string;
-    description: string;
   };
 }
 

diff --git a/app/components/concept-admin/blocks-page/insert-block-marker.ts b/app/components/concept-admin/blocks-page/insert-block-marker.ts
@@ -7,8 +7,8 @@ interface Signature {
   Element: HTMLDivElement;
 
   Args: {
-    onBlockAdded: (block: Block) => void;
     isVisibleWithoutHover: boolean;
+    onBlockAdded: (block: Block) => void;
   };
 }
 

diff --git a/app/components/concept-admin/delete-concept-modal.ts b/app/components/concept-admin/delete-concept-modal.ts
@@ -5,18 +5,18 @@ import type RouterService from '@ember/routing/router-service';
 import type Store from '@ember-data/store';
 import type ConceptModel from 'codecrafters-frontend/models/concept';
 
-type Signature = {
+interface Signature {
   Element: HTMLDivElement;
 
   Args: {
-    onClose?: () => void;
     concept: ConceptModel;
+    onClose?: () => void;
   };
-};
+}
 
 export default class DeleteConceptModalComponent extends Component<Signature> {
-  @service router!: RouterService;
-  @service store!: Store;
+  @service declare router: RouterService;
+  @service declare store: Store;
 
   @action
   async deleteConcept() {

diff --git a/app/components/concept-admin/header.ts b/app/components/concept-admin/header.ts
@@ -3,13 +3,13 @@ import RouterService from '@ember/routing/router-service';
 import { inject as service } from '@ember/service';
 import ConceptModel from 'codecrafters-frontend/models/concept';
 
-type Signature = {
+interface Signature {
   Element: HTMLDivElement;
 
   Args: {
     concept: ConceptModel;
   };
-};
+}
 
 type Tab = {
   icon: string;

diff --git a/app/components/concept-page/question-card.ts b/app/components/concept-page/question-card.ts
@@ -5,14 +5,14 @@ import type ConceptQuestionModel from 'codecrafters-frontend/models/concept-ques
 import type { Option } from 'codecrafters-frontend/models/concept-question';
 import { next } from '@ember/runloop';
 
-type Signature = {
+interface Signature {
   Element: HTMLDivElement;
 
   Args: {
     question: ConceptQuestionModel;
     onSubmit: () => void;
   };
-};
+}
 
 export default class QuestionCardComponent extends Component<Signature> {
   @tracked selectedOptionIndex: number | null = null;

diff --git a/app/components/concept.ts b/app/components/concept.ts
@@ -19,7 +19,7 @@ interface Signature {
     latestConceptEngagement: ConceptEngagementModel;
   };
 
-  Element: HTMLElement;
+  Element: HTMLDivElement;
 }
 
 interface BlockGroup {

diff --git a/app/components/concept/continue-or-step-back.ts b/app/components/concept/continue-or-step-back.ts
@@ -6,12 +6,12 @@ interface Signature {
   Element: HTMLDivElement;
 
   Args: {
+    continueButtonText: string;
     onContinueButtonClick: () => void;
     onStepBackButtonClick: () => void;
     shouldHighlightKeyboardShortcuts: boolean;
-    shouldShowStepBackButton: boolean;
     shouldShowContinueButton: boolean;
-    continueButtonText: string;
+    shouldShowStepBackButton: boolean;
   };
 }
 

diff --git a/app/components/contest-page/header.ts b/app/components/contest-page/header.ts
@@ -5,14 +5,14 @@ import { formatDistanceStrict } from 'date-fns';
 import { formatInTimeZone } from 'date-fns-tz';
 import { inject as service } from '@ember/service';
 
-type Signature = {
+interface Signature {
   Element: HTMLDivElement;
 
   Args: {
     allContests: ContestModel[];
     contest: ContestModel;
   };
-};
+}
 
 export default class ContestPageHeaderComponent extends Component<Signature> {
   @service declare date: DateService;

diff --git a/app/components/contest-page/how-it-works-card.ts b/app/components/contest-page/how-it-works-card.ts
@@ -1,13 +1,13 @@
 import Component from '@glimmer/component';
 import ContestModel from 'codecrafters-frontend/models/contest';
 
-type Signature = {
+interface Signature {
   Element: HTMLDivElement;
 
   Args: {
     contest: ContestModel;
   };
-};
+}
 
 export default class ContestPageHowItWorksCardComponent extends Component<Signature> {}
 

diff --git a/app/components/contest-page/leaderboard-card.ts b/app/components/contest-page/leaderboard-card.ts
@@ -6,7 +6,7 @@ import type LanguageModel from 'codecrafters-frontend/models/language';
 import type LeaderboardEntryModel from 'codecrafters-frontend/models/leaderboard-entry';
 import type UserModel from 'codecrafters-frontend/models/user';
 
-type Signature = {
+interface Signature {
   Element: HTMLDivElement;
 
   Args: {
@@ -15,7 +15,7 @@ type Signature = {
     topEntries: LeaderboardEntryModel[];
     surroundingEntries: LeaderboardEntryModel[];
   };
-};
+}
 
 export default class ContestPageLeaderboardCardComponent extends Component<Signature> {
   @service declare authenticator: AuthenticatorService;

diff --git a/app/components/contest-page/leaderboard-entry.ts b/app/components/contest-page/leaderboard-entry.ts
@@ -4,14 +4,14 @@ import type LanguageModel from 'codecrafters-frontend/models/language';
 import type LeaderboardEntryModel from 'codecrafters-frontend/models/leaderboard-entry';
 import { inject as service } from '@ember/service';
 
-type Signature = {
+interface Signature {
   Element: HTMLAnchorElement;
 
   Args: {
     entry: LeaderboardEntryModel;
     languages: LanguageModel[];
   };
-};
+}
 
 export default class ContestPageLeaderboardEntryComponent extends Component<Signature> {
   @service declare authenticator: AuthenticatorService;

diff --git a/app/components/contest-page/navigation.ts b/app/components/contest-page/navigation.ts
@@ -3,14 +3,14 @@ import ContestModel from 'codecrafters-frontend/models/contest';
 import DateService from 'codecrafters-frontend/services/date';
 import { inject as service } from '@ember/service';
 
-type Signature = {
+interface Signature {
   Element: HTMLDivElement;
 
   Args: {
     allContests: ContestModel[];
     contest: ContestModel;
   };
-};
+}
 
 export default class ContestPageNavigationComponent extends Component<Signature> {
   @service declare date: DateService;

diff --git a/app/components/contest-page/prize-details-card.ts b/app/components/contest-page/prize-details-card.ts
@@ -1,14 +1,14 @@
 import Component from '@glimmer/component';
 import ContestModel from 'codecrafters-frontend/models/contest';
 
-type Signature = {
+interface Signature {
   Element: HTMLDivElement;
 
   Args: {
     allContests: ContestModel[];
     contest: ContestModel;
   };
-};
+}
 
 export default class ContestPagePrizeDetailsCardComponent extends Component<Signature> {}
 

diff --git a/app/components/copyable-code.ts b/app/components/copyable-code.ts
@@ -5,7 +5,7 @@ import { later } from '@ember/runloop';
 import { tracked } from '@glimmer/tracking';
 
 interface Signature {
-  Element: HTMLElement;
+  Element: HTMLDivElement;
 
   Args: {
     backgroundColor?: 'gray' | 'white';

diff --git a/app/components/copyable-terminal-command-with-variants.ts b/app/components/copyable-terminal-command-with-variants.ts
@@ -8,7 +8,7 @@ export type CopyableTerminalCommandVariant = {
 };
 
 interface Signature {
-  Element: HTMLElement;
+  Element: HTMLDivElement;
 
   Args: {
     onCopyButtonClick?: () => void;

diff --git a/app/components/copyable-terminal-command.ts b/app/components/copyable-terminal-command.ts
@@ -6,7 +6,7 @@ import { tracked } from '@glimmer/tracking';
 import fade from 'ember-animated/transitions/fade';
 
 interface Signature {
-  Element: HTMLElement;
+  Element: HTMLDivElement;
 
   Args: {
     commands: string[];

diff --git a/app/components/course-admin/buildpacks-page/buildpack-item.ts b/app/components/course-admin/buildpacks-page/buildpack-item.ts
@@ -3,13 +3,13 @@ import { inject as service } from '@ember/service';
 import RouterService from '@ember/routing/router-service';
 import BuildpackModel from 'codecrafters-frontend/models/buildpack';
 
-type Signature = {
+interface Signature {
   Element: HTMLDivElement;
 
   Args: {
     buildpack: BuildpackModel;
   };
-};
+}
 
 export default class BuildpackComponent extends Component<Signature> {
   @service declare router: RouterService;