tatsh / jxa-lib Goto Github PK

npm install jxa-lib inside a project does not result in a usable, importable package from within node_modules.

Update the following to work with this library when npm install works:

• itunes-clear-orphaned
• facetime-clear-badge
• Maybe clem2itunes

Does your webpack configuration for jxa-lib allow keeping the run function global for passing in CLI arguments?

This library for example has a webpack config file + custom webpack plugin that allows for this: https://github.com/pahund/patricks-little-jxa-helpers

The entire module gets set to main and then the global run function gets defined as such: function run(args) { this.main(args); }.

• whose
• ObjC C typing
• Byte type guard

whose filter on Array

Apple has a whose filter for arrays. It is basically filter with an object predicate.

// documentation only gives string and num; we are guessing here
type JXAPrimitive = string | number | boolean | void
interface JXAWhosePredicateExpression {
  // equals, beginsWith...
}
type JXALogical= '_and' | '_or' | '_not'
interface JXAWhosePredicate {
  [logi: JXALogical]: JXAWhosePredicate[],
  [key: string]?: string | number | boolean | JXAWhosePredicateExpression
}
interface JXAArray<T> extends Array<T>, JXAReadonlyArray<T> {}
interface JXAReadonlyArray<T> extends ReadonlyArray<T> {
    /**
     * Returns the elements of an array that meet the condition specified in a filter predicate.
     */
  whose(predicate: JXAWhosePredicate, thisArg?: any): JXAArray<T>;
}

It is possible that they went forward and changed the entire Array.prototype. In that case just remove the extends BS.

ObjC FFI types

Currently bindFunction and registerSubclass do not have type signatures. Judging from the doc it should resemble:

type ObjCType = string | RefType
type ObjCSignature = [ObjCType, ObjCType []]
interface ObjCClass {
  name: string
  properties: {
    [key: string]: string
  }
  methods: (...x?: any[]) => any | {
    type: ObjCSignature
    implementation: (...x?: any[]) => any
  }
}
namespace ObjC {
  export function bindFunction(name: string, args: ObjCSignature);
  export function registerSubclass(class: ObjCClass);
}

Byte concept

Since Ref operates on bytes (uint8_t), it might be a good idea to define a concept of bytes somewhere so it becomes more clear. We will also need utility functions for reading/writing longer integer types and even floats.

Unfortunately the typing part is not something we can do perfectly right now; see microsoft/TypeScript#15480.