Typings for horizon

[beenotung]

Typings URL: https://github.com/beenotung/typed-horizon

Questions (for new typings):

• Does the README explain the purpose of the typings and have a link
  to the JavaScript project?
• Do the typings follow the source structure (e.g. index.js <->
  index.d.ts)?
  • no, the typing is in a single file
• Are they external or global modules according the source (e.g. see
  README sources)?
  • they are global modules

[beenotung]

The label should be typings request

how to set the label?

[blakeembrey]

Definition files shouldn't contain values (https://github.com/beenotung/typed-horizon/blob/master/src/main.d.ts#L77-L80). Aside from that, is this for the browser API? Is everything global under horizon?

[beenotung]

@blakeembrey: yes, it is for browser, and the npm test script suggests it to be global

[unional]

The test script say it is global because you choose it to be global when you run the generator. (You probably selected "Script Tag" when it asked "How can the package be used?")

I checked the source and I think it is likely umd:
https://horizon.io/api/horizon/

// connect to the Horizon server, after Horizon has been loaded via
// <script> tag or require
const hz = new Horizon();

[unional]

I need to find time to re-do part of the generator, or may be re-write it to be not depends on yeoman. It really tie my hand in properly refactoring the code. 😢

[beenotung]

in this case, it should be in source (root folder) of npm?

[blakeembrey]

Thanks. You can also use classes into of this style: https://github.com/beenotung/typed-horizon/blob/master/global/main.d.ts#L2-L28.

[unional]

It depends on whom you want to support. If you want to support script tag usage, then this is fine.

If you also want to support npm (require) usage, then it is better to also have one for /npm/ folder.

[felixfbecker]

This general question interests me aswell, where should typings for modules go that support both global and commonjs usage?

[beenotung]

the current typing is for browser

I am not sure if the nodejs part is the same, might check out that part later on

I think horizon is not isomorphic, it seperate code under @horizon/server and @horizon/client

[unional]

When talking about npm and require, it is not necessary just server side usage. You can perfectly use npm to get packages and develop your code, then use tools like browserfiy, jspm, webpack etc, and use it on browser.

[unional]

@felixfbecker to both global and npm. The question is what are we going to do with umd typings in [email protected]

[beenotung]

@unional I guess I know your meaning

but the client side horizon javascript is generated from live server on every request (i guess it embed some auth stuff)

and i tried to eval the "client side code" in nodejs and it doesn't really work (cannot setup connect to horizon) becuase it used window.localStorage internally

[unional]

i tried to eval the "client side code" in nodejs

Nope that won't work. Your code will still need to be end up running on the browser, by either loading by script tag, requirejs, systemjs/jspm, etc.

[unional]

In either way, if this is ready, we can merge this and you can create another PR if you want to support npm module usage.

[beenotung]

@blakeembrey when using class, how to indicate the 'default function' ?
https://github.com/beenotung/typed-horizon/blob/master/global/main.d.ts#L7

I know using apply or call can do the trick, but it's not convenience for the user 😕

class Foo {
  apply(name:string):Bar;
}

[blakeembrey]

Oh, I missed that line doing that trick. It's a really weird pattern to do that, so your current code looks right. Also, what about lazyWrites (https://horizon.io/api/horizon/#constructor) and doesn't that function take an argument like new Horizon()('messages')? Let me know if I'm reading the right thing 😄

[beenotung]

the param in constructor is optional already 😄

new(param?:{...})

you reminded me the typing is not completed, i'm just working on it progressively as far as my project cover
i will update them later on

[blakeembrey]

@beenotung I was trying to point to the method you wanted (https://horizon.io/api/horizon/#connect - https://github.com/beenotung/typed-horizon/blob/master/global/main.d.ts#L7) - shouldn't it take a table: string argument?

[beenotung]

@blakeembrey are you talking about the call method?

export interface Horizon {
    call<A>(_this: Horizon, table: string): TableObject<A>;
    <A> (): TableObject<A>;
  }

it works, but the syntax when invoking the method is trivial 😢

let hz = new Horizon();
hz.call(hz,'tablename');

remark:
hz(a) === hz.call(hz,a)

[beenotung]

@blakeembrey I just got you meaning, fixed :)
beenotung/typed-horizon@a3f86d2

[beenotung]

when i use it in another project
this error shows up when compiling

typings/globals/horizon/index.d.ts(4,23): error TS1147: Import declarations in a namespace cannot reference a module.
typings/globals/horizon/index.d.ts(4,23): error TS2307: Cannot find module 'rxjs'.

how should I set the typings.json so that it will lookup under node_modules/ ?

[blakeembrey]

1. Don't do imports in a namespace
2. This one is tricky because no solution here is ideal, but you can do npm:rxjs - it just needs to be installed by npm before resolving