Typescript definitions for UXP?

dposin · August 9, 2023, 10:06pm

I know it is possible to build a UXP plugin using Typescript, which I would like to do. Is there an existing @types project for InDesign and InDesign UXP? Is there another project other than @types that might have the definitions?

pklaschka · August 9, 2023, 10:17pm

I got ok-ish to good results with this file:

github.com

pklaschka/indesign-pride-flagger/blob/main/types.d.ts

///
/// MIT License
//
// Copyright (c) 2021 Justin Walsh
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

This file has been truncated. show original

It’s a mix takes the UXP types by @thejustinwalsh (there are also other projects out there that have, some more updated than others, type definitions for the core UXP APIs) and the classic “Types for Adobe” project’s InDesign types for the host-app-specific APIs, removes all the declare keywords in it, and wraps it in a declare module ‘indesign’ {…}.

There’s also currently an active effort by Adobe to have official TypeScript definitions for at least the core UXP APIs, but I’ve had a few issues trying it a few days ago, so it might still take a few days/weeks for those to be usable “without intervention”.

PS: Note that those solutions aren’t super pretty or working perfectly, yet (so using them for strict type checking might cause issues). But it’s better than nothing at least

dposin · August 9, 2023, 10:19pm

I appreciate the help, thank you