Support for non-core applications

[jxa-userland]

Support for non-core applications

[LoganDark]

const emacs = <EmacsType> Application('Emacs')

?

[havardh]

@LoganDark your proposal gives me the following error:

[ts]
Type 'typeof Application & _StandardAdditions & AnyValue' cannot be converted to type 'Emacs'.
  Property 'close' is missing in type 'typeof Application & _StandardAdditions & AnyValue'.
(alias) Application(name: string): typeof Application & Application._StandardAdditions & Application.AnyValue (+25 overloads)
export namespace Application

[LoganDark]

Does your type extends App?

Where App is:

JXA/packages/@jxa/types/src/Application.d.ts

Line 29 in 4aa1185

type App = typeof Application & Application._StandardAdditions & Application.AnyValue;

[havardh]

Ah, thanks @LoganDark 👍

I got the following snippet to work:

import "@jxa/global-type";
import {Emacs} from "./types/Emacs";
import Application from "@jxa/types/src/Application";

type App = typeof Application & Application._StandardAdditions & Application.AnyValue;

const emacs = <App & Emacs> Application("Emacs");

Where types/Emacs is the .d.ts made by @jxa/sdef-to-dts.

@azu: Feel free to close this issue or advice me on how this could fit into this library.

[azu]

Maybe, we can provide more generics way.

import "@jxa/global-type";
import {Emacs} from "./types/Emacs";
// Maybe, types export `Application`
import { Application } from "@jxa/types";
// TODO: `Application` support Custom Application by generics.
const emacs = Application<Emacs>("Emacs");
// Emacs is `Application & Application._StandardAdditions & Application.AnyValue & Emacas`;

Implemention:

/**
 * Pass custom Application type as generics
 * Return Application's StandardAdditions & T type
 */
declare function Application<T>(name: string): typeof Application & Application._StandardAdditions & Application.AnyValue & T;

[azu]

I've submit PR #6

[azu]

@havardh I've published 1.2.0
Please try to use this :)

https://github.com/JXA-userland/JXA/releases/tag/v1.2.0

import { Application } from "@jxa/types";
import {Emacs} from "./types/Emacs";
const emacs = Application<Emacs>("Emacs");

[havardh]

@azu Great, I've tested this on 1.2.1 and it works for my use case.

This brings me to the next part of my questions, can we make it more ergonomic to add these types? E.g. an additional repo with these custom types, or a simple npx @jxa/sdef-to-dts Emacs.app => Emacs.t.ds.

[azu]

@havardh Interesting.
If we get sdef file from app name, we can implement this feature.
(I don't know if that's is possible or impossible.)

Please create another issue.