@raycast/api 1.37.0 → 1.38.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/types/index.d.ts CHANGED
@@ -37,10 +37,13 @@ import { RefAttributes } from 'react';
37
37
  * }
38
38
  * ```
39
39
  */
40
- export declare const Action: FunctionComponent<ActionProps> & ConvenienceActions;
40
+ export declare const Action: FunctionComponent<ActionProps> & ConvenienceActions & {
41
+ Style: typeof ActionStyle;
42
+ };
41
43
 
42
44
  export declare namespace Action {
43
45
  export type Props = ActionProps;
46
+ export type Style = ActionStyle;
44
47
  export namespace CopyToClipboard {
45
48
  /**
46
49
  * Props of the {@link Action.CopyToClipboard} React component.
@@ -123,8 +126,9 @@ export declare namespace Action {
123
126
  * sections and can have keyboard shortcuts assigned.
124
127
  *
125
128
  * The first and second action become the primary and secondary action. They automatically get the default keyboard shortcuts assigned.
126
- * In {@link List} and {@link Detail}, this is `↵` for the primary and `⌘` `↵` for the secondary action. In {@link Form} it's `⌘` `↵` for the primary and
129
+ * In {@link List}, {@link Grid}, and {@link Detail}, this is `↵` for the primary and `⌘` `↵` for the secondary action. In {@link Form} it's `⌘` `↵` for the primary and
127
130
  * `⌘` `⇧` `↵` for the secondary.
131
+ * Keep in mind that while you can specify an alternative shortcut for the primary and secondary actions, it won't be displayed in the Action Panel.
128
132
  *
129
133
  * @example
130
134
  * ```typescript
@@ -194,7 +198,9 @@ declare type ActionPanelChildren_2 = ReactElement<ActionPanel.Section.Props> | R
194
198
  /**
195
199
  * @deprecated Use {@link Action} instead.
196
200
  */
197
- export declare const ActionPanelItem: FunctionComponent<ActionProps> & ConvenienceActions;
201
+ export declare const ActionPanelItem: FunctionComponent<ActionProps> & ConvenienceActions & {
202
+ Style: ActionStyle;
203
+ };
198
204
 
199
205
  /**
200
206
  * @deprecated Use {@link Action.Props} instead.
@@ -360,12 +366,23 @@ declare interface ActionProps {
360
366
  * The icon displayed for the action.
361
367
  */
362
368
  icon?: Image.ImageLike | undefined | null;
369
+ /**
370
+ * Defines the visual style of the Action.
371
+ *
372
+ * @remarks
373
+ * Use {@link Action.Style.Regular} for displaying a regular actions.
374
+ * Use {@link Action.Style.Destructive} when your action has something that user should be careful about.
375
+ * Use the confirmation {@link Alert} if the action is doing something that user cannot revert.
376
+ * @defaultValue {@link Action.Style.Regular}
377
+ */
378
+ style?: ActionStyle;
363
379
  /**
364
380
  * The keyboard shortcut for the item.
365
381
  *
366
382
  * @remarks
367
383
  * The first and second action in an {@link ActionPanel} become the primary and secondary action. They automatically get the default keyboard shortcuts assigned.
368
- * In {@link List} and {@link Detail}, this is `↵` for the primary and `⌘` `↵` for the secondary action. In {@link Form} it's `⌘` `↵` for the primary and `⌘` `⇧` `↵` for the secondary.
384
+ * In {@link List}, {@link Grid} ,and {@link Detail}, this is `↵` for the primary and `⌘` `↵` for the secondary action. In {@link Form} it's `⌘` `↵` for the primary and `⌘` `⇧` `↵` for the secondary.
385
+ * Keep in mind that while you can specify an alternative shortcut for the primary and secondary actions, it won't be displayed in the Action Panel.
369
386
  */
370
387
  shortcut?: Keyboard.Shortcut | undefined | null;
371
388
  /**
@@ -384,6 +401,19 @@ declare interface ActionsInterface {
384
401
  actions?: ReactNode;
385
402
  }
386
403
 
404
+ /**
405
+ * Defines the visual style of the Action.
406
+ *
407
+ * @remarks
408
+ * Use {@link Action.Style.Regular} for displaying a regular actions.
409
+ * Use {@link Action.Style.Destructive} when your action has something that user should be careful about.
410
+ * Use the confirmation {@link Alert} if the action is doing something that user cannot revert.
411
+ */
412
+ declare enum ActionStyle {
413
+ Regular = "regular",
414
+ Destructive = "destructive"
415
+ }
416
+
387
417
  export declare namespace Alert {
388
418
  /**
389
419
  * The options to create an {@link Alert}.
@@ -506,6 +536,26 @@ export declare interface Application {
506
536
  bundleId?: string;
507
537
  }
508
538
 
539
+ /**
540
+ * A record type holding the arguments (entered in Raycast Root Search Bar) that have been passed to the command.
541
+ */
542
+ declare interface Arguments {
543
+ /**
544
+ * The representation of arguments given that key here is the `name` defined in manifest file and value is the user's input
545
+ */
546
+ [item: string]: any;
547
+ }
548
+
549
+ /**
550
+ * An interface describing top-level props for arguments
551
+ */
552
+ export declare interface ArgumentsLaunchProps {
553
+ /**
554
+ * Use these values to populate the initial state for your command.
555
+ */
556
+ arguments?: Arguments;
557
+ }
558
+
509
559
  /**
510
560
  * Caching abstraction that stores data on disk and supports LRU (least recently used) access.
511
561
  * Since extensions can only consume up to a max. heap memory size, the cache only maintains a lightweight index in memory
@@ -513,7 +563,7 @@ export declare interface Application {
513
563
  *
514
564
  * The Cache class provides CRUD-style methods (get, set, remove) to update and retrieve data synchronously based on a key.
515
565
  * The data must be a string and it is up to the client to decide which serialization format to use.
516
- * (A typical use case would be to use JSON.stringify and JSON.parse.)
566
+ * A typical use case would be to use `JSON.stringify` and `JSON.parse`.
517
567
  *
518
568
  * @remarks By default, the cache is shared between the commands of an extension. Use {@link Cache.Options} to configure
519
569
  * a `namespace` per command if needed (for example, set it to `environment.commandName`).
@@ -576,9 +626,9 @@ export declare class Cache {
576
626
  }): void;
577
627
  /**
578
628
  * Registers a new subscriber that gets notified when cache data is set or removed.
579
- * @returns a function that can be used to remove the subscriber.
629
+ * @returns a function that can be called to remove the subscriber.
580
630
  */
581
- subscribe(subscription: Cache.Subscriber): Cache.Subscription;
631
+ subscribe(subscriber: Cache.Subscriber): Cache.Subscription;
582
632
  private maintainCapacity;
583
633
  private notifySubscribers;
584
634
  }
@@ -596,11 +646,12 @@ export declare namespace Cache {
596
646
  namespace?: string;
597
647
  /**
598
648
  * The parent directory for the cache data.
649
+ * @deprecated this parameter will be removed in the future – use the default directory.
599
650
  */
600
651
  directory?: string;
601
652
  /**
602
653
  * The capacity in bytes. If the stored data exceeds the capacity, the least recently used data is removed.
603
- * @default 10000000 (10 MB)
654
+ * The default capacity is 10 MB.
604
655
  */
605
656
  capacity?: number;
606
657
  }
@@ -1175,13 +1226,10 @@ declare interface ConvenienceActions {
1175
1226
  * <List>
1176
1227
  * <List.Item
1177
1228
  * title="Preview me"
1229
+ * quickLook={{ path: "~/Downloads/Raycast.dmg", name: "Some file" }}
1178
1230
  * actions={
1179
1231
  * <ActionPanel>
1180
- * <Action.ToggleQuickLook
1181
- * name="Some file"
1182
- * path="~/Downloads/Raycast.dmg"
1183
- * shortcut={{ modifiers: ["cmd"], key: "y" }}
1184
- * />
1232
+ * <Action.ToggleQuickLook shortcut={{ modifiers: ["cmd"], key: "y" }} />
1185
1233
  * </ActionPanel>
1186
1234
  * }
1187
1235
  * />
@@ -2080,6 +2128,10 @@ export declare interface Environment {
2080
2128
  * The theme used by the Raycast application.
2081
2129
  */
2082
2130
  theme: "light" | "dark";
2131
+ /**
2132
+ * The type of launch for the command (user initiated or background).
2133
+ */
2134
+ launchType: LaunchType;
2083
2135
  }
2084
2136
 
2085
2137
  /**
@@ -2096,6 +2148,7 @@ export declare interface Environment {
2096
2148
  * console.log(`Support path: ${environment.supportPath}`);
2097
2149
  * console.log(`Is development mode: ${environment.isDevelopment}`);
2098
2150
  * console.log(`Raycast theme: ${environment.theme}`);
2151
+ * console.log(`Raycast launchType: ${environment.launchType}`);
2099
2152
  * ```
2100
2153
  */
2101
2154
  export declare const environment: Environment;
@@ -3434,6 +3487,7 @@ export declare interface FormProps extends Form.Props {
3434
3487
  declare interface FormProps_2 extends ActionsInterface, NavigationChildInterface {
3435
3488
  /**
3436
3489
  * Defines whether the Form.Items values will be preserved when user exits the screen.
3490
+ * @remarks Keep in mind that drafts for forms nested in navigation is not supported yet. In the case you will see a warning about it.
3437
3491
  * @defaultValue `false`
3438
3492
  */
3439
3493
  enableDrafts?: boolean;
@@ -3899,11 +3953,10 @@ declare interface GridMembers {
3899
3953
  * import { Grid } from "@raycast/api";
3900
3954
  *
3901
3955
  * function DrinkDropdown(props: DrinkDropdownProps) {
3902
- * const { isLoading = false, drinkTypes, onDrinkTypeChange } = props;
3956
+ * const { drinkTypes, onDrinkTypeChange } = props;
3903
3957
  * return (
3904
3958
  * <Grid.Dropdown
3905
3959
  * tooltip="Select Drink Type"
3906
- * disabled={isLoading}
3907
3960
  * storeValue={true}
3908
3961
  * onChange={(newValue) => {
3909
3962
  * onDrinkTypeChange(newValue);
@@ -4021,55 +4074,427 @@ declare interface GridProps extends ActionsInterface, NavigationChildInterface {
4021
4074
  * ```
4022
4075
  */
4023
4076
  export declare enum Icon {
4077
+ AddPerson = "add-person-16",
4078
+ Airplane = "airplane-16",
4079
+ AirplaneFilled = "airplane-filled-16",
4080
+ AirplaneLanding = "airplane-landing-16",
4081
+ AirplaneTakeoff = "airplane-takeoff-16",
4082
+ Airpods = "airpods-16",
4083
+ Alarm = "alarm-16",
4084
+ AlarmRinging = "alarm-ringing-16",
4085
+ AlignCentre = "align-centre-16",
4086
+ AlignLeft = "align-left-16",
4087
+ AlignRight = "align-right-16",
4088
+ AmericanFootball = "american-football-16",
4089
+ Anchor = "anchor-16",
4090
+ AppWindow = "app-window-16",
4091
+ AppWindowGrid2x2 = "app-window-grid-2x2-16",
4092
+ AppWindowGrid3x3 = "app-window-grid-3x3-16",
4093
+ AppWindowList = "app-window-list-16",
4094
+ AppWindowSidebarLeft = "app-window-sidebar-left-16",
4095
+ AppWindowSidebarRight = "app-window-sidebar-right-16",
4024
4096
  ArrowClockwise = "arrow-clockwise-16",
4025
- TwoArrowsClockwise = "arrow-2-clockwise-16",
4097
+ ArrowCounterClockwise = "arrow-counter-clockwise-16",
4098
+ ArrowDown = "arrow-down-16",
4099
+ ArrowDownCircle = "arrow-down-circle-16",
4100
+ ArrowDownCircleFilled = "arrow-down-circle-filled-16",
4101
+ ArrowLeft = "arrow-left-16",
4102
+ ArrowLeftCircle = "arrow-left-circle-16",
4103
+ ArrowLeftCircleFilled = "arrow-left-circle-filled-16",
4104
+ ArrowNe = "arrow-ne-16",
4026
4105
  ArrowRight = "arrow-right-16",
4106
+ ArrowRightCircle = "arrow-right-circle-16",
4107
+ ArrowRightCircleFilled = "arrow-right-circle-filled-16",
4108
+ ArrowUp = "arrow-up-16",
4109
+ ArrowUpCircle = "arrow-up-circle-16",
4110
+ ArrowUpCircleFilled = "arrow-up-circle-filled-16",
4111
+ AtSymbol = "at-symbol-16",
4112
+ BandAid = "band-aid-16",
4113
+ BankNote = "bank-note-16",
4114
+ BarChart = "bar-chart-16",
4115
+ BarCode = "bar-code-16",
4116
+ BathTub = "bath-tub-16",
4117
+ Battery = "battery-16",
4118
+ BatteryCharging = "battery-charging-16",
4119
+ BatteryDisabled = "battery-disabled-16",
4120
+ Bell = "bell-16",
4121
+ BellDisabled = "bell-disabled-16",
4122
+ Bike = "bike-16",
4027
4123
  Binoculars = "binoculars-16",
4028
- Bubble = "bubble-left-16",
4124
+ BlankDocument = "blank-document-16",
4125
+ Bluetooth = "bluetooth-16",
4126
+ Boat = "boat-16",
4127
+ Bold = "bold-16",
4128
+ Bolt = "bolt-16",
4129
+ BoltDisabled = "bolt-disabled-16",
4130
+ Book = "book-16",
4131
+ Bookmark = "bookmark-16",
4132
+ Box = "box-16",
4133
+ Brush = "brush-16",
4134
+ Bubble = "speech-bubble-16",
4135
+ Bug = "bug-16",
4136
+ BulletPoints = "bullet-points-16",
4137
+ BullsEye = "bulls-eye-16",
4138
+ Buoy = "buoy-16",
4139
+ Calculator = "calculator-16",
4029
4140
  Calendar = "calendar-16",
4030
- Checkmark = "checkmark-circle-16",
4141
+ Camera = "camera-16",
4142
+ Car = "car-16",
4143
+ Cart = "cart-16",
4144
+ Cd = "cd-16",
4145
+ Center = "center-16",
4146
+ Check = "check-16",
4147
+ CheckCircle = "check-circle-16",
4148
+ Checkmark = "check-circle-16",
4149
+ ChessPiece = "chess-piece-16",
4031
4150
  ChevronDown = "chevron-down-16",
4151
+ ChevronLeft = "chevron-left-16",
4152
+ ChevronRight = "chevron-right-16",
4032
4153
  ChevronUp = "chevron-up-16",
4033
4154
  Circle = "circle-16",
4034
- Clipboard = "doc-on-clipboard-16",
4155
+ CircleEllipsis = "circle-ellipsis-16",
4156
+ CircleFilled = "circle-filled-16",
4157
+ CircleProgress = "circle-progress-16",
4158
+ CircleProgress100 = "circle-progress-100-16",
4159
+ CircleProgress25 = "circle-progress-25-16",
4160
+ CircleProgress50 = "circle-progress-50-16",
4161
+ CircleProgress75 = "circle-progress-75-16",
4162
+ ClearFormatting = "clear-formatting-16",
4163
+ Clipboard = "copy-clipboard-16",
4035
4164
  Clock = "clock-16",
4036
- Desktop = "desktopcomputer-16",
4037
- Document = "doc-16",
4165
+ Cloud = "cloud-16",
4166
+ CloudLightning = "cloud-lightning-16",
4167
+ CloudRain = "cloud-rain-16",
4168
+ CloudSnow = "cloud-snow-16",
4169
+ CloudSun = "cloud-sun-16",
4170
+ Code = "code-16",
4171
+ CodeBlock = "code-block-16",
4172
+ Cog = "cog-16",
4173
+ Coin = "coin-16",
4174
+ Coins = "coins-16",
4175
+ Compass = "compass-16",
4176
+ ComputerChip = "computer-chip-16",
4177
+ Contrast = "contrast-16",
4178
+ CopyClipboard = "copy-clipboard-16",
4179
+ CreditCard = "credit-card-16",
4180
+ CricketBall = "cricket-ball-16",
4181
+ Crop = "crop-16",
4182
+ Crown = "crown-16",
4183
+ Crypto = "crypto-16",
4184
+ DeleteDocument = "delete-document-16",
4185
+ Desktop = "desktop-16",
4186
+ Dna = "dna-16",
4187
+ Document = "blank-document-16",
4038
4188
  Dot = "dot-16",
4039
- Download = "square-and-arrow-down-16",
4189
+ Download = "download-16",
4190
+ EditShape = "edit-shape-16",
4191
+ Eject = "eject-16",
4192
+ Ellipsis = "ellipsis-16",
4193
+ Emoji = "emoji-16",
4040
4194
  Envelope = "envelope-16",
4041
- ExclamationMark = "exclamation-mark-triangle-16",
4195
+ Eraser = "eraser-16",
4196
+ ExclamationMark = "important-01-16",
4197
+ Exclamationmark = "exclamationmark-16",
4198
+ Exclamationmark2 = "exclamationmark-2-16",
4199
+ Exclamationmark3 = "exclamationmark-3-16",
4042
4200
  Eye = "eye-16",
4043
- EyeSlash = "eye-slash-16",
4201
+ EyeDisabled = "eye-disabled-16",
4202
+ EyeDropper = "eye-dropper-16",
4203
+ Female = "female-16",
4204
+ FilmStrip = "film-strip-16",
4205
+ Filter = "filter-16",
4044
4206
  Finder = "finder-16",
4045
- Gear = "gearshape-16",
4046
- Globe = "globe-16",
4207
+ Fingerprint = "fingerprint-16",
4208
+ Folder = "folder-16",
4209
+ Footprints = "footprints-16",
4210
+ Forward = "forward-16",
4211
+ ForwardFilled = "forward-filled-16",
4212
+ FountainTip = "fountain-tip-16",
4213
+ FullSignal = "full-signal-16",
4214
+ GameController = "game-controller-16",
4215
+ Gauge = "gauge-16",
4216
+ Gear = "cog-16",
4217
+ Geopin = "geopin-16",
4218
+ Germ = "germ-16",
4219
+ Gift = "gift-16",
4220
+ Glasses = "glasses-16",
4221
+ Globe = "globe-01-16",
4222
+ Goal = "goal-16",
4047
4223
  Hammer = "hammer-16",
4048
- LevelMeter = "level-meter-16",
4224
+ HardDrive = "hard-drive-16",
4225
+ Hashtag = "hashtag-16",
4226
+ Headphones = "headphones-16",
4227
+ Heart = "heart-16",
4228
+ HeartDisabled = "heart-disabled-16",
4229
+ Heartbeat = "heartbeat-16",
4230
+ Highlight = "highlight-16",
4231
+ Hourglass = "hourglass-16",
4232
+ House = "house-16",
4233
+ Image = "image-16",
4234
+ Important = "important-01-16",
4235
+ Info = "info-01-16",
4236
+ Italics = "italics-16",
4237
+ Key = "key-16",
4238
+ Keyboard = "keyboard-16",
4239
+ Layers = "layers-16",
4240
+ Leaderboard = "leaderboard-16",
4241
+ Leaf = "leaf-16",
4242
+ LevelMeter = "signal-2-16",
4243
+ LightBulb = "light-bulb-16",
4244
+ LightBulbOff = "light-bulb-off-16",
4245
+ LineChart = "line-chart-16",
4049
4246
  Link = "link-16",
4050
- List = "main-list-view-16",
4051
- MagnifyingGlass = "magnifyingglass-16",
4052
- MemoryChip = "memorychip-16",
4053
- Message = "message-16",
4247
+ List = "app-window-list-16",
4248
+ Livestream = "livestream-01-16",
4249
+ Lock = "lock-16",
4250
+ LockDisabled = "lock-disabled-16",
4251
+ LockUnlocked = "lock-unlocked-16",
4252
+ Logout = "logout-16",
4253
+ Lorry = "lorry-16",
4254
+ Lowercase = "lowercase-16",
4255
+ MagnifyingGlass = "magnifying-glass-16",
4256
+ Male = "male-16",
4257
+ Map = "map-16",
4258
+ Mask = "mask-16",
4259
+ Maximize = "maximize-16",
4260
+ MedicalSupport = "medical-support-16",
4261
+ Megaphone = "megaphone-16",
4262
+ MemoryChip = "computer-chip-16",
4263
+ MemoryStick = "memory-stick-16",
4264
+ Message = "speech-bubble-16",
4265
+ Microphone = "microphone-16",
4266
+ MicrophoneDisabled = "microphone-disabled-16",
4267
+ Minimize = "minimize-16",
4268
+ Minus = "minus-16",
4269
+ MinusCircle = "minus-circle-16",
4270
+ MinusCircleFilled = "minus-circle-filled-16",
4271
+ Mobile = "mobile-16",
4272
+ Monitor = "monitor-16",
4273
+ Moon = "moon-16",
4274
+ Mountain = "mountain-16",
4275
+ Mouse = "mouse-16",
4276
+ Multiply = "multiply-16",
4277
+ Music = "music-16",
4278
+ Network = "network-16",
4279
+ NewDocument = "new-document-16",
4280
+ NewFolder = "new-folder-16",
4281
+ Number00 = "number-00-16",
4282
+ Number01 = "number-01-16",
4283
+ Number02 = "number-02-16",
4284
+ Number03 = "number-03-16",
4285
+ Number04 = "number-04-16",
4286
+ Number05 = "number-05-16",
4287
+ Number06 = "number-06-16",
4288
+ Number07 = "number-07-16",
4289
+ Number08 = "number-08-16",
4290
+ Number09 = "number-09-16",
4291
+ Number10 = "number-10-16",
4292
+ Number11 = "number-11-16",
4293
+ Number12 = "number-12-16",
4294
+ Number13 = "number-13-16",
4295
+ Number14 = "number-14-16",
4296
+ Number15 = "number-15-16",
4297
+ Number16 = "number-16-16",
4298
+ Number17 = "number-17-16",
4299
+ Number18 = "number-18-16",
4300
+ Number19 = "number-19-16",
4301
+ Number20 = "number-20-16",
4302
+ Number21 = "number-21-16",
4303
+ Number22 = "number-22-16",
4304
+ Number23 = "number-23-16",
4305
+ Number24 = "number-24-16",
4306
+ Number25 = "number-25-16",
4307
+ Number26 = "number-26-16",
4308
+ Number27 = "number-27-16",
4309
+ Number28 = "number-28-16",
4310
+ Number29 = "number-29-16",
4311
+ Number30 = "number-30-16",
4312
+ Number31 = "number-31-16",
4313
+ Number32 = "number-32-16",
4314
+ Number33 = "number-33-16",
4315
+ Number34 = "number-34-16",
4316
+ Number35 = "number-35-16",
4317
+ Number36 = "number-36-16",
4318
+ Number37 = "number-37-16",
4319
+ Number38 = "number-38-16",
4320
+ Number39 = "number-39-16",
4321
+ Number40 = "number-40-16",
4322
+ Number41 = "number-41-16",
4323
+ Number42 = "number-42-16",
4324
+ Number43 = "number-43-16",
4325
+ Number44 = "number-44-16",
4326
+ Number45 = "number-45-16",
4327
+ Number46 = "number-46-16",
4328
+ Number47 = "number-47-16",
4329
+ Number48 = "number-48-16",
4330
+ Number49 = "number-49-16",
4331
+ Number50 = "number-50-16",
4332
+ Number51 = "number-51-16",
4333
+ Number52 = "number-52-16",
4334
+ Number53 = "number-53-16",
4335
+ Number54 = "number-54-16",
4336
+ Number55 = "number-55-16",
4337
+ Number56 = "number-56-16",
4338
+ Number57 = "number-57-16",
4339
+ Number58 = "number-58-16",
4340
+ Number59 = "number-59-16",
4341
+ Number60 = "number-60-16",
4342
+ Number61 = "number-61-16",
4343
+ Number62 = "number-62-16",
4344
+ Number63 = "number-63-16",
4345
+ Number64 = "number-64-16",
4346
+ Number65 = "number-65-16",
4347
+ Number66 = "number-66-16",
4348
+ Number67 = "number-67-16",
4349
+ Number68 = "number-68-16",
4350
+ Number69 = "number-69-16",
4351
+ Number70 = "number-70-16",
4352
+ Number71 = "number-71-16",
4353
+ Number72 = "number-72-16",
4354
+ Number73 = "number-73-16",
4355
+ Number74 = "number-74-16",
4356
+ Number75 = "number-75-16",
4357
+ Number76 = "number-76-16",
4358
+ Number77 = "number-77-16",
4359
+ Number78 = "number-78-16",
4360
+ Number79 = "number-79-16",
4361
+ Number80 = "number-80-16",
4362
+ Number81 = "number-81-16",
4363
+ Number82 = "number-82-16",
4364
+ Number83 = "number-83-16",
4365
+ Number84 = "number-84-16",
4366
+ Number85 = "number-85-16",
4367
+ Number86 = "number-86-16",
4368
+ Number87 = "number-87-16",
4369
+ Number88 = "number-88-16",
4370
+ Number89 = "number-89-16",
4371
+ Number90 = "number-90-16",
4372
+ Number91 = "number-91-16",
4373
+ Number92 = "number-92-16",
4374
+ Number93 = "number-93-16",
4375
+ Number94 = "number-94-16",
4376
+ Number95 = "number-95-16",
4377
+ Number96 = "number-96-16",
4378
+ Number97 = "number-97-16",
4379
+ Number98 = "number-98-16",
4380
+ Number99 = "number-99-16",
4381
+ Paperclip = "paperclip-16",
4382
+ Patch = "patch-16",
4383
+ Pause = "pause-16",
4384
+ PauseFilled = "pause-filled-16",
4054
4385
  Pencil = "pencil-16",
4055
- Person = "person-crop-circle-16",
4386
+ Person = "person-16",
4387
+ PersonCircle = "person-circle-16",
4056
4388
  Phone = "phone-16",
4389
+ PhoneRinging = "phone-ringing-16",
4390
+ PieChart = "pie-chart-16",
4391
+ Pill = "pill-16",
4057
4392
  Pin = "pin-16",
4393
+ PinDisabled = "pin-disabled-16",
4394
+ Play = "play-16",
4395
+ PlayFilled = "play-filled-16",
4396
+ Plug = "plug-16",
4058
4397
  Plus = "plus-16",
4059
- Sidebar = "sidebar-right-16",
4060
- SpeakerArrowDown = "speaker-arrow-down-16",
4061
- SpeakerArrowUp = "speaker-arrow-up-16",
4062
- SpeakerSlash = "speaker-slash-16",
4398
+ PlusCircle = "plus-circle-16",
4399
+ PlusCircleFilled = "plus-circle-filled-16",
4400
+ PlusMinusDivideMultiply = "plus-minus-divide-multiply-16",
4401
+ Power = "power-16",
4402
+ Print = "print-16",
4403
+ QuestionMark = "question-mark-circle-16",
4404
+ QuestionMarkCircle = "question-mark-circle-16",
4405
+ QuotationMarks = "quotation-marks-16",
4406
+ QuoteBlock = "quote-block-16",
4407
+ Racket = "racket-16",
4408
+ Raindrop = "raindrop-16",
4409
+ RaycastLogoNeg = "raycast-logo-neg-16",
4410
+ RaycastLogoPos = "raycast-logo-pos-16",
4411
+ Receipt = "receipt-16",
4412
+ Redo = "redo-16",
4413
+ RemovePerson = "remove-person-16",
4414
+ Repeat = "repeat-16",
4415
+ Reply = "reply-16",
4416
+ Rewind = "rewind-16",
4417
+ RewindFilled = "rewind-filled-16",
4418
+ Rocket = "rocket-16",
4419
+ Rosette = "rosette-16",
4420
+ RotateAntiClockwise = "rotate-anti-clockwise-16",
4421
+ RotateClockwise = "rotate-clockwise-16",
4422
+ Ruler = "ruler-16",
4423
+ SaveDocument = "save-document-16",
4424
+ Shield = "shield-01-16",
4425
+ Shuffle = "shuffle-16",
4426
+ Sidebar = "app-window-sidebar-right-16",
4427
+ Signal1 = "signal-1-16",
4428
+ Signal2 = "signal-2-16",
4429
+ Signal3 = "signal-3-16",
4430
+ Snippets = "snippets-16",
4431
+ Snowflake = "snowflake-16",
4432
+ SoccerBall = "soccer-ball-16",
4433
+ SpeakerDown = "speaker-down-16",
4434
+ SpeakerHigh = "speaker-high-16",
4435
+ SpeakerLow = "speaker-low-16",
4436
+ SpeakerOff = "speaker-off-16",
4437
+ SpeakerOn = "speaker-on-16",
4438
+ SpeakerUp = "speaker-up-16",
4439
+ SpeechBubble = "speech-bubble-16",
4440
+ SpeechBubbleActive = "speech-bubble-active-16",
4441
+ SpeechBubbleImportant = "speech-bubble-important-16",
4063
4442
  Star = "star-16",
4064
- Text = "text-alignleft-16",
4065
- TextDocument = "doc-plaintext-16",
4066
- QuestionMark = "questionmark-circle-16",
4443
+ StarCircle = "star-circle-16",
4444
+ StarDisabled = "star-disabled-16",
4445
+ Stars = "stars-16",
4446
+ Stop = "stop-16",
4447
+ StopFilled = "stop-filled-16",
4448
+ Stopwatch = "stopwatch-16",
4449
+ Store = "store-16",
4450
+ StrikeThrough = "strike-through-16",
4451
+ Sun = "sun-16",
4452
+ Sunrise = "sunrise-16",
4453
+ Swatch = "swatch-16",
4454
+ Switch = "switch-16",
4455
+ Syringe = "syringe-16",
4456
+ Tag = "tag-16",
4457
+ Temperature = "temperature-16",
4458
+ TennisBall = "tennis-ball-16",
4067
4459
  Terminal = "terminal-16",
4460
+ Text = "text-16",
4461
+ TextCursor = "text-cursor-16",
4462
+ Torch = "torch-16",
4463
+ Train = "train-16",
4068
4464
  Trash = "trash-16",
4069
- Upload = "square-and-arrow-up-16",
4465
+ Tray = "tray-16",
4466
+ Tree = "tree-16",
4467
+ Trophy = "trophy-16",
4468
+ TwoPeople = "two-people-16",
4469
+ Umbrella = "umbrella-16",
4470
+ Underline = "underline-16",
4471
+ Undo = "undo-16",
4472
+ Upload = "upload-16",
4473
+ Uppercase = "uppercase-16",
4070
4474
  Video = "video-16",
4071
- Window = "macwindow-16",
4072
- XmarkCircle = "xmark-circle-16"
4475
+ Wallet = "wallet-16",
4476
+ Wand = "wand-16",
4477
+ Warning = "warning-16",
4478
+ Weights = "weights-16",
4479
+ Wifi = "wifi-16",
4480
+ WifiDisabled = "wifi-disabled-16",
4481
+ Window = "app-window-16",
4482
+ WrenchScrewdriver = "wrench-screwdriver-16",
4483
+ WristWatch = "wrist-watch-16",
4484
+ XMarkCircle = "x-mark-circle-16",
4485
+ XMarkCircleFilled = "x-mark-circle-filled-16",
4486
+ /** @deprecated Use {@link Icon.ArrowClockwise} instead. */
4487
+ TwoArrowsClockwise = "arrow-clockwise-16",
4488
+ /** @deprecated Use {@link Icon.EyeDisabled} instead. */
4489
+ EyeSlash = "eye-disabled-16",
4490
+ /** @deprecated Use {@link Icon.SpeakerDown} instead. */
4491
+ SpeakerArrowDown = "speaker-down-16",
4492
+ /** @deprecated Use {@link Icon.SpeakerUp} instead. */
4493
+ SpeakerArrowUp = "speaker-up-16",
4494
+ /** @deprecated Use {@link Icon.SpeakerOff} instead. */
4495
+ SpeakerSlash = "speaker-off-16",
4496
+ /** @deprecated Use {@link Icon.BlankDocument} instead. */
4497
+ TextDocument = "blank-document-16"
4073
4498
  }
4074
4499
 
4075
4500
  /**
@@ -4263,6 +4688,11 @@ declare const Item: FunctionComponent<ItemProps> & ItemMembers;
4263
4688
  */
4264
4689
  declare const Item_2: FunctionComponent<ItemProps_2>;
4265
4690
 
4691
+ /**
4692
+ * See {@link MenuBarExtra.Item}
4693
+ */
4694
+ declare const Item_3: FunctionComponent<ItemProps_3>;
4695
+
4266
4696
  declare type ItemAccessory = ({
4267
4697
  /**
4268
4698
  * An optional text that will be used as the label.
@@ -4363,7 +4793,7 @@ declare interface ItemProps extends ActionsInterface {
4363
4793
  */
4364
4794
  detail?: ReactNode;
4365
4795
  /**
4366
- * Optional information to preview files with Quick Look. Toggle the preview ith {@link Action.ToggleQuickLook}.
4796
+ * Optional information to preview files with Quick Look. Toggle the preview with {@link Action.ToggleQuickLook}.
4367
4797
  *
4368
4798
  * @remarks
4369
4799
  * If no `name` is specified, the file name of the given path is used.
@@ -4420,6 +4850,14 @@ declare interface ItemProps_2 extends ActionsInterface {
4420
4850
  actions?: ReactNode | null;
4421
4851
  }
4422
4852
 
4853
+ declare interface ItemProps_3 {
4854
+ title: string;
4855
+ icon?: Image.ImageLike;
4856
+ tooltip?: string;
4857
+ onAction?: () => void;
4858
+ shortcut?: Keyboard.Shortcut;
4859
+ }
4860
+
4423
4861
  export declare namespace Keyboard {
4424
4862
  /**
4425
4863
  * A keyboard shortcut is defined by one or more modifier keys (command, control, etc.) and a single key equivalent (a character or special key).
@@ -4538,7 +4976,18 @@ declare interface LabelProps_2 {
4538
4976
  /**
4539
4977
  * The top-level props that a Command receives on launch
4540
4978
  */
4541
- export declare type LaunchProps = FormLaunchProps;
4979
+ export declare type LaunchProps = ArgumentsLaunchProps | FormLaunchProps;
4980
+
4981
+ export declare enum LaunchType {
4982
+ /**
4983
+ * A regular launch through user interaction
4984
+ */
4985
+ UserInitiated = "userInitiated",
4986
+ /**
4987
+ * Scheduled through an interval and launched from background
4988
+ */
4989
+ Background = "background"
4990
+ }
4542
4991
 
4543
4992
  /**
4544
4993
  * See {@link Detail.Metadata.Link}
@@ -4785,11 +5234,10 @@ declare interface ListMembers {
4785
5234
  * import { List } from "@raycast/api";
4786
5235
  *
4787
5236
  * function DrinkDropdown(props: DrinkDropdownProps) {
4788
- * const { isLoading = false, drinkTypes, onDrinkTypeChange } = props;
5237
+ * const { drinkTypes, onDrinkTypeChange } = props;
4789
5238
  * return (
4790
5239
  * <List.Dropdown
4791
5240
  * tooltip="Select Drink Type"
4792
- * disabled={isLoading}
4793
5241
  * storeValue={true}
4794
5242
  * onChange={(newValue) => {
4795
5243
  * onDrinkTypeChange(newValue);
@@ -5033,6 +5481,29 @@ export declare type LocalStorageValue = LocalStorage.Value;
5033
5481
  export declare interface LocalStorageValues extends LocalStorage.Values {
5034
5482
  }
5035
5483
 
5484
+ export declare const MenuBarExtra: FunctionComponent<MenuBarExtraProps> & MenuBarExtraMembers;
5485
+
5486
+ export declare namespace MenuBarExtra {
5487
+ export type Props = MenuBarExtraProps;
5488
+ }
5489
+
5490
+ declare interface MenuBarExtraMembers {
5491
+ Item: typeof Item_3;
5492
+ Separator: typeof Separator_4;
5493
+ Submenu: typeof Submenu_2;
5494
+ }
5495
+
5496
+ declare interface MenuBarExtraProps {
5497
+ /**
5498
+ * @defaultValue `false`
5499
+ */
5500
+ isLoading?: boolean;
5501
+ title?: string;
5502
+ tooltip?: string;
5503
+ icon?: Image.ImageLike;
5504
+ children?: ReactNode;
5505
+ }
5506
+
5036
5507
  /**
5037
5508
  * See {@link Detail.Metadata}
5038
5509
  */
@@ -5995,6 +6466,11 @@ declare const Separator_2: FunctionComponent<SeparatorProps_2>;
5995
6466
  */
5996
6467
  declare const Separator_3: FunctionComponent<SeparatorProps_3>;
5997
6468
 
6469
+ /**
6470
+ * See {@link MenuBarExtra.Separator}
6471
+ */
6472
+ declare const Separator_4: FunctionComponent<SeparatorProps_4>;
6473
+
5998
6474
  /**
5999
6475
  * See {@link Form.Separator.Props}
6000
6476
  */
@@ -6007,6 +6483,9 @@ declare interface SeparatorProps_2 {
6007
6483
  declare interface SeparatorProps_3 {
6008
6484
  }
6009
6485
 
6486
+ declare interface SeparatorProps_4 {
6487
+ }
6488
+
6010
6489
  /**
6011
6490
  * @deprecated Use {@link LocalStorage.setItem} instead
6012
6491
  */
@@ -6168,6 +6647,11 @@ export declare const specialKeys: any;
6168
6647
  */
6169
6648
  declare const Submenu: FunctionComponent<SubmenuProps>;
6170
6649
 
6650
+ /**
6651
+ * See {@link MenuBarExtra.Submenu}
6652
+ */
6653
+ declare const Submenu_2: FunctionComponent<SubmenuProps_2>;
6654
+
6171
6655
  declare type SubmenuChildren = ReactElement<SectionProps> | ReactElement<SectionProps>[] | SectionChildren | null;
6172
6656
 
6173
6657
  /**
@@ -6225,6 +6709,15 @@ declare interface SubmenuProps {
6225
6709
  onOpen?: () => void;
6226
6710
  }
6227
6711
 
6712
+ declare interface SubmenuProps_2 {
6713
+ title: string | {
6714
+ value: string;
6715
+ tooltip: string;
6716
+ };
6717
+ icon?: Image.ImageLike;
6718
+ children?: ReactNode;
6719
+ }
6720
+
6228
6721
  /**
6229
6722
  * See {@link Action.SubmitForm.Props}
6230
6723
  */
@@ -6603,7 +7096,7 @@ export declare const ToastStyle: typeof Toast.Style;
6603
7096
  declare const ToggleQuickLook: FunctionComponent<ToggleQuickLookProps>;
6604
7097
 
6605
7098
  /**
6606
- * See {@link Action.Open.Props}
7099
+ * See {@link Action.ToggleQuickLook.Props}
6607
7100
  */
6608
7101
  declare interface ToggleQuickLookProps {
6609
7102
  /**
@@ -6694,6 +7187,28 @@ declare interface TrashProps {
6694
7187
  onTrash?: (paths: PathLike | PathLike[]) => void;
6695
7188
  }
6696
7189
 
7190
+ /**
7191
+ * Update the values of properties declared in the manifest of a command.
7192
+ *
7193
+ * @param metadata - An object with the values for the manifest properties to update.
7194
+ * Note that currently only `subtitle` is supported. Pass `null` to clear the custom subtitle.
7195
+ * @returns A Promise that resolves when the metadata has been updated.
7196
+ *
7197
+ * @example
7198
+ * ```typescript
7199
+ * import { open } from "@raycast/api";
7200
+ *
7201
+ * export default async () => {
7202
+ * await updateCommandMetadata({ subtitle: "My new subtitle" });
7203
+ * };
7204
+ * ```
7205
+ * @remarks The actual manifest file is not modified, so the update applies as
7206
+ * long as the command remains installed.
7207
+ */
7208
+ export declare function updateCommandMetadata(metadata: {
7209
+ subtitle?: string | null;
7210
+ }): Promise<void>;
7211
+
6697
7212
  /**
6698
7213
  * @deprecated No alternative :(
6699
7214
  */