moved more interfaces to global declaration file

Author: Oaphi

app/assets/javascripts/filters.js

@@ -122,7 +122,7 @@ $(() => {
     async function saveFilter() {
       if (!$form[0].reportValidity()) { return; }
 
-      const filter = /** @type {Filter} */({});
+      const filter = /** @type {QPixelFlag} */({});
 
       for (const el of $formFilters) {
         filter[el.dataset.name] = $(el).val();

app/assets/javascripts/qpixel_api.js

@@ -6,31 +6,6 @@ const validators = [];
 /** Counts notifications popped up at any time. */
 let popped_modals_ct = 0;
 
-/**
- * @typedef {{
- *  min_score: number | null,
- *  max_score: number | null,
- *  min_answers: number | null,
- *  max_answers: number | null,
- *  include_tags: [string, number][],
- *  exclude_tags: [string, number][],
- *  status: 'any' | 'closed' | 'open',
- *  system: boolean,
- * }} Filter
- *
- * @typedef {{
- *  id: number,
- *  username: string,
- *  is_standard: boolean,
- *  is_moderator: boolean,
- *  is_admin: boolean,
- *  is_global_moderator: boolean,
- *  is_global_admin: boolean,
- *  trust_level: number,
- *  se_acct_id: string | null,
- * }} User
- */
-
 window.QPixel = {
   csrfToken: () => {
     const token = $('meta[name="csrf-token"]').attr('content');
@@ -135,7 +110,7 @@ window.QPixel = {
   },
 
   /**
-   * @type {Filter[]|null}
+   * @type {QPixelFlag[]|null}
    */
   _filters: null,
 
@@ -146,7 +121,7 @@ window.QPixel = {
   _pendingUserResponse: null,
 
   /**
-   * @type {User|null}
+   * @type {QPixelUser|null}
    */
   _user: null,
 

app/assets/javascripts/suggested_edit.js

@@ -1,11 +1,3 @@
-/**
- * @typedef {{
- *  message?: string
- *  redirect_url?: string
- *  status: 'success' | 'error'
- * }} SuggestedEditActionResult
- */
-
 $(() => {
   $('[data-suggested-edit-approve]').on('click', async (ev) => {
     ev.preventDefault();
@@ -15,7 +7,7 @@ $(() => {
 
     const resp = await QPixel.fetchJSON(`/posts/suggested-edit/${editId}/approve`, { comment });
 
-    /** @type {SuggestedEditActionResult} */
+    /** @type {QPixelSuggestedEditActionResult} */
     const data = await resp.json();
 
     if (data.status !== 'success') {
@@ -40,7 +32,7 @@ $(() => {
 
     const resp = await QPixel.fetchJSON(`/posts/suggested-edit/${editId}/reject`, { rejection_comment: comment });
 
-    /** @type {SuggestedEditActionResult} */
+    /** @type {QPixelSuggestedEditActionResult} */
     const data = await resp.json();
 
     if (data.status !== 'success') {
@@ -50,4 +42,4 @@ $(() => {
       location.href = data.redirect_url;
     }
   });
-});  
+});

app/assets/javascripts/tags.js

@@ -1,27 +1,9 @@
 /**
- * @typedef {{
- *  name: string
- * }} RemoteTagSynonym
- * 
- * @typedef {{
- *  id: number
- *  community_id: number
- *  parent_id: number | null
- *  tag_set_id: number
- *  excerpt: string
- *  name: string
- *  tag_synonyms: RemoteTagSynonym[]
- *  wiki: string | null
- *  wiki_markdown: string
- *  created_at: string
- *  updated_at: string
- * }} RemoteTag
- * 
  * @typedef {{
  *  id: number | string
  *  text: string
  *  desc: string
- *  synonyms?: string | RemoteTagSynonym[]
+ *  synonyms?: string | QPixelTagSynonym[]
  * }} ProcessedTag
  */
 
@@ -87,7 +69,7 @@ $(() => {
         headers: { 'Accept': 'application/json' },
         delay: 100,
         /**
-         * @param {RemoteTag[]} data
+         * @param {QPixelTag[]} data
          * @returns {Select2.ProcessedResult<ProcessedTag>}
          */
         processResults: (data) => {
@@ -120,8 +102,8 @@ $(() => {
 
   /**
    * @param {JQuery} $search
-   * @param {RemoteTagSynonym[]} synonyms
-   * @returns {string | RemoteTagSynonym[]}
+   * @param {QPixelTagSynonym[]} synonyms
+   * @returns {string | QPixelTagSynonym[]}
    */
   function processSynonyms($search, synonyms) {
     if (!synonyms) return synonyms;

global.d.ts

@@ -201,6 +201,53 @@ type QPixelComment = {
   references_comment_id: string | null
 }
 
+type QPixelFlag = {
+  exclude_tags: [string, number][]
+  include_tags: [string, number][]
+  max_answers: number | null
+  max_score: number | null
+  min_answers: number | null
+  min_score: number | null
+  status: 'any' | 'closed' | 'open'
+  system: boolean
+}
+
+type QPixelSuggestedEditActionResult = {
+  message?: string
+  redirect_url?: string
+  status: 'success' | 'error'
+}
+
+type QPixelTag = {
+  community_id: number
+  created_at: string
+  excerpt: string
+  id: number
+  name: string
+  parent_id: number | null
+  tag_set_id: number
+  tag_synonyms: QPixelTagSynonym[]
+  updated_at: string
+  wiki: string | null
+  wiki_markdown: string
+}
+
+type QPixelTagSynonym = {
+  name: string
+}
+
+type QPixelUser = {
+  id: number
+  is_standard: boolean
+  is_moderator: boolean
+  is_admin: boolean
+  is_global_moderator: boolean
+  is_global_admin: boolean
+  se_acct_id: string | null
+  trust_level: number
+  username: string
+}
+
 type QPixelFlagData = {
   flag_type: number | null
   post_id: string
@@ -215,11 +262,11 @@ interface GetThreadContentOptions {
 
 interface QPixel {
   // private properties
-  _filters?: Filter[] | null;
+  _filters?: QPixelFlag[] | null;
   _pendingUserResponse?: Promise<Response> | null;
   _popups?: Record<string, QPixelPopup>;
   _preferences?: UserPreferences | null;
-  _user?: User | null;
+  _user?: QPixelUser | null;
 
   // private methods
 
@@ -309,7 +356,7 @@ interface QPixel {
    */
   defaultFilter?: (categoryId: string) => Promise<string>;
   deleteFilter?: (name: string, system?: boolean) => Promise<void>;
-  filters?: () => Promise<Record<string, Filter>>;
+  filters?: () => Promise<Record<string, QPixelFlag>>;
 
   /**
    * Get the absolute offset of an element.
@@ -332,7 +379,7 @@ interface QPixel {
    * @param text the text with which to replace the selection
    */
   replaceSelection?: ($field: JQuery<HTMLInputElement | HTMLTextAreaElement>, text: string) => void;
-  setFilter?: (name: string, filter: Filter, category: string, isDefault: boolean) => Promise<void>;
+  setFilter?: (name: string, filter: QPixelFlag, category: string, isDefault: boolean) => Promise<void>;
   setFilterAsDefault?: (categoryId: string, name: string) => Promise<void>;
 
   /**
@@ -347,7 +394,7 @@ interface QPixel {
    * Get the user object for the current user.
    * @returns JSON object containing user details
    */
-  user?: () => Promise<User>;
+  user?: () => Promise<QPixelUser>;
 
   /**
    * Internal. Called just before a post is sent to the server to validate that it passes