Merge pull request #52 from gjsify/mark-types-for-47

Mark a few types for GNOME 47
gjsify · Sep 23, 2024 · 4e6e386 · 4e6e386
2 parents b6140e1 + faae7c6
commit 4e6e386
Show file tree

Hide file tree

Showing 6 changed files with 63 additions and 49 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -11,5 +11,8 @@
   "cSpell.words": [
     "girs"
   ],
-  "prettier.prettierPath": ".yarn/sdks/prettier/index.cjs"
+  "prettier.prettierPath": ".yarn/sdks/prettier/index.cjs",
+  "[typescript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode"
+  }
 }
diff --git a/packages/gnome-shell/src/misc/signals.d.ts b/packages/gnome-shell/src/misc/signals.d.ts
@@ -1,6 +1,6 @@
 // https://gitlab.gnome.org/GNOME/gnome-shell/-/blob/main/js/misc/signals.js
 // Credits https://github.com/swsnr/gnome-shell-extension-picture-of-the-day/blob/main/%40types/gnome-shell/misc/signals.d.ts
-// TODO Move this SignalMethods to ts-fir-gir / @girs/gjs
+// TODO Move this SignalMethods to ts-for-gir / @girs/gjs
 
 type SignalMap<K> = {
     [Signal in keyof K]: unknown[];
@@ -72,7 +72,7 @@ export interface SignalMethods<S extends SignalMap<S> = any> {
 export interface EventEmitter<S extends SignalMap<S> = any> extends SignalMethods<S> {}
 
 /**
- * @version 46
+ * @version 47
  */
 export class EventEmitter<S extends SignalMap<S> = any> {
     connectObject(...args: any[]): number; // TODO: return type is return type of imports.misc.signalTracker.connectObject

diff --git a/packages/gnome-shell/src/ui/messageTray.d.ts b/packages/gnome-shell/src/ui/messageTray.d.ts
@@ -13,13 +13,13 @@ import type * as MessageList from './messageList.js';
 
 /**
  * @see https://gitlab.gnome.org/GNOME/gnome-shell/-/blob/main/js/ui/messageTray.js#L20
- * @version 46
+ * @version 47
  */
 export const ANIMATION_TIME: number;
 
 /**
  * @see https://gitlab.gnome.org/GNOME/gnome-shell/-/blob/main/js/ui/messageTray.js#L36
- * @version 46
+ * @version 47
  */
 export enum State {
     HIDDEN = 0,
@@ -38,7 +38,7 @@ export enum State {
  * newer version having replaced them.
  *
  * @see https://gitlab.gnome.org/GNOME/gnome-shell/-/blob/main/js/ui/messageTray.js#L51
- * @version 46
+ * @version 47
  */
 export enum NotificationDestroyedReason {
     EXPIRED = 1,
@@ -54,7 +54,7 @@ export enum NotificationDestroyedReason {
  * through the Telepathy client.
  *
  * @see https://gitlab.gnome.org/GNOME/gnome-shell/-/blob/main/js/ui/messageTray.js#L62
- * @version 46
+ * @version 47
  */
 export enum Urgency {
     LOW = 0,
@@ -72,7 +72,7 @@ export enum Urgency {
  * of a notification is shown on the lock screen.
  *
  * @see https://gitlab.gnome.org/GNOME/gnome-shell/-/blob/main/js/ui/messageTray.js#L76
- * @version 46
+ * @version 47
  */
 export enum PrivacyScope {
     USER = 0,
@@ -86,7 +86,7 @@ export enum PrivacyScope {
  * A notification without a policy object will inherit the default one.
  *
  * @see https://gitlab.gnome.org/GNOME/gnome-shell/-/blob/main/js/ui/messageTray.js#L160
- * @version 46
+ * @version 47
  */
 export abstract class NotificationPolicy extends GObject.Object {
     readonly enable: boolean;
@@ -109,7 +109,7 @@ export abstract class NotificationPolicy extends GObject.Object {
 
 /**
  * @see https://gitlab.gnome.org/GNOME/gnome-shell/-/blob/main/js/ui/messageTray.js#L213
- * @version 46
+ * @version 47
  */
 export class NotificationGenericPolicy extends NotificationPolicy {
     public id: string;
@@ -126,7 +126,7 @@ export class NotificationGenericPolicy extends NotificationPolicy {
 
 /**
  * @see https://gitlab.gnome.org/GNOME/gnome-shell/-/blob/main/js/ui/messageTray.js#L243
- * @version 46
+ * @version 47
  */
 export class NotificationApplicationPolicy extends NotificationPolicy {
     public id: string;
@@ -147,7 +147,7 @@ export class NotificationApplicationPolicy extends NotificationPolicy {
 
 /**
  * @see https://gitlab.gnome.org/GNOME/gnome-shell/-/blob/main/js/ui/messageTray.js#L316
- * @version 46
+ * @version 47
  */
 export class Sound extends GObject.Object {
     constructor(file: Gio.File | null | undefined, themedName?: string);
@@ -157,7 +157,7 @@ export class Sound extends GObject.Object {
 
 /**
  * @see https://gitlab.gnome.org/GNOME/gnome-shell/-/blob/main/js/ui/messageTray.js#L335
- * @version 46
+ * @version 47
  */
 export class Action extends GObject.Object {
     constructor(label: string, callback: () => void);
@@ -169,7 +169,7 @@ export class Action extends GObject.Object {
 
 /**
  * @see https://gitlab.gnome.org/GNOME/gnome-shell/-/blob/main/js/ui/messageTray.js#L482
- * @version 46
+ * @version 47
  */
 export declare namespace Source {
     export interface ConstructorProps extends MessageList.Source.ConstructorProps {
@@ -179,7 +179,7 @@ export declare namespace Source {
 
 /**
  * @see https://gitlab.gnome.org/GNOME/gnome-shell/-/blob/main/js/ui/messageTray.js#L499
- * @version 46
+ * @version 47
  */
 export class Source extends MessageList.Source {
     constructor(params?: Partial<Source.ConstructorProps>);
@@ -253,7 +253,7 @@ export declare namespace Notification {
 
 /**
  * @see https://gitlab.gnome.org/GNOME/gnome-shell/-/blob/main/js/ui/messageTray.js#L352
- * @version 46
+ * @version 47
  */
 export class Notification extends GObject.Object implements Notification.ObjectProperties {
     constructor(params?: Notification.ConstructorProps);
@@ -316,7 +316,7 @@ export class Notification extends GObject.Object implements Notification.ObjectP
 
 /**
  * @see https://gitlab.gnome.org/GNOME/gnome-shell/-/blob/main/js/ui/messageTray.js#L676
- * @version 46
+ * @version 47
  */
 export class MessageTray extends St.Widget {
     constructor();
@@ -327,7 +327,7 @@ export class MessageTray extends St.Widget {
 
     public readonly queueCount: number;
 
-    public bannerBlocked: boolean;
+    public set bannerBlocked(v: boolean);
 
     public contains(descendant: Clutter.Actor): boolean;
     public contains(source: Source): boolean;
@@ -392,6 +392,6 @@ export class MessageTray extends St.Widget {
  * The {Source} that should be used to send system notifications.
  *
  * @see https://gitlab.gnome.org/GNOME/gnome-shell/-/blob/main/js/ui/messageTray.js#L1290
- * @version 46
+ * @version 47
  */
 export function getSystemSource(): Source;
diff --git a/packages/gnome-shell/src/ui/modalDialog.d.ts b/packages/gnome-shell/src/ui/modalDialog.d.ts
@@ -9,7 +9,7 @@ import type { ButtonInfo, Dialog } from './dialog.js';
 
 /**
  * @see https://gitlab.gnome.org/GNOME/gnome-shell/-/blob/main/js/ui/modalDialog.js#L19
- * @version 46
+ * @version 47
  */
 export enum State {
     OPENED = 0,
@@ -21,7 +21,7 @@ export enum State {
 
 /**
  * @see https://gitlab.gnome.org/GNOME/gnome-shell/-/blob/main/js/ui/modalDialog.js#L27
- * @version 46
+ * @version 47
  */
 export namespace ModalDialog {
     export interface ConstructorProps extends St.Widget.ConstructorProps {
@@ -35,7 +35,7 @@ export namespace ModalDialog {
 
 /**
  * @see https://gitlab.gnome.org/GNOME/gnome-shell/-/blob/main/js/ui/modalDialog.js#L37
- * @version 46
+ * @version 47
  */
 export class ModalDialog extends St.Widget {
     protected _state: State;
@@ -55,7 +55,7 @@ export class ModalDialog extends St.Widget {
     public dialogLayout: Dialog;
     public contentLayout: Dialog['contentLayout'];
     public buttonLayout: Dialog['buttonLayout'];
-    public state: State;
+    public readonly state: State;
 
     constructor(params?: Partial<ModalDialog.ConstructorProps>);