Add typescript definitions #183

twelch · 2021-06-27T04:09:01Z

Type of PR

Feature

What is the Goal of the PR?

Add Typescript type definitions for the top-level geoblaze module. Builds on existing geojson types in DefinitelyTyped. Include them with the published NPM package.

Goal is to meet strict type definitions, no use of any

Checklist:

Add build step to copy the declaration file into the dist folder for distribution. Webpack may be the tool to do it.
Switch types in package.json to point to dist/geoblaze.d.ts
Migrate the GeoRaster class definition over to a declaration file in the georaster package. Could be done as a follow-on for incremental progress.
Ensure both default and named exports work
Review methods with fine toothed comb

Note that I'm uncovering some JSDoc inaccuracies/inconsistencies in the process. I'll create a separate PR for them.

package.json

twelch · 2021-06-27T15:22:15Z

src/geoblaze.d.ts

+export function identify(
+  raster: GeoRaster,
+  geom?: string | InputPoint | null
+): number[];


My read is that while the underlying raster may be represented with smaller byte data types, DataView methods are used to extract and return values, which are of number type, so that is what this function will return. Feedback welcome -- https://microsoft.github.io/PowerBI-JavaScript/interfaces/_node_modules_typedoc_node_modules_typescript_lib_lib_es5_d_.dataview.html#getuint8

Actually I think the type of the pixel values returned can vary based on the raster. For example can be Uint8Array. I'm not positive that is true for this identify method, but getValues() does for the Georaster. I propose a solution over in my georaster PR, and suggest what is here will work for now. I can research and look to improve -- https://github.com/GeoTIFF/georaster/pull/59/files#r670681723

src/geoblaze.d.ts

twelch · 2021-06-27T17:52:23Z

@DanielJDufour I think this is ready for (initial) review when you have time.

I've tested with maybe 1/3 of the methods using just a single float32 raster. I'm curious if my assumption that cell values read from the raster are always number is a good one or the type might vary with the raster cell size.

To test, I simply npm linked my local geoblaze to a typescript project I already have. Something more thorough would be to add a Typescript file to the repo that runs some tests.

src/geoblaze.d.ts

twelch · 2021-06-27T23:00:32Z

Back to WIP. Finding the right structure for it to import the upstream georaster types

twelch · 2021-07-15T17:59:13Z

As I've used more methods I've pushed some fixes. Feeling pretty tight.

…ing index.js internally

twelch · 2021-08-09T19:51:14Z

src/index.d.ts

+type InputPolygon = number[][][] | Polygon | Feature<Polygon>;
+type InputPoint = number[] | Point | Feature<Point>;


Looks like FeatureCollection is also supported according to https://github.com/GeoTIFF/geoblaze/blob/master/src/utils/utils.module.js#L236. Not documented clearly.

Good catch!

DanielJDufour

A very impressive amount of work grappling with the nuances of Typescript and GeoBlaze! Just a left a minor nit-picky comment about spelling of GeoRaster and GeoBlaze. Other than that, I think we would be good to merge into master and publish a "prerelease" or "release candidate" to NPMJS. I could add GeoBlaze to a demo Angular app I made for GeoRasterLayer, so we could add that to the testing you are already doing. I think I could also ask some people I know who use Angular if they can try it out before we do the official next big release!!!

Thank you!!!!!!!

DanielJDufour · 2021-08-13T02:48:20Z

src/index.d.ts

@@ -0,0 +1,108 @@
+import { Point, Polygon, Feature, BBox } from "geojson";
+import { Georaster } from "georaster";


I know it's super picky (and annoying), but could we use GeoRaster instead of Georaster? We've used Georaster before, but I'd like to migrate over to the new spelling. Sorry!

DanielJDufour · 2021-08-13T02:49:46Z

src/index.d.ts

+// re-rexport for easy access by downstream user
+export { Georaster } from "georaster"
+
+type GeoblazeBBox = {


Similar to above, could we use GeoBlaze... instead of Geoblaze? I know I've done a bad job of standardizing spelling, but would like to use GeoBlaze moving forward. Sorry again!

DanielJDufour · 2021-08-13T02:51:00Z

src/index.d.ts

+type InputPolygon = number[][][] | Polygon | Feature<Polygon>;
+type InputPoint = number[] | Point | Feature<Point>;


Good catch!

mjernil · 2023-06-15T09:06:17Z

Hello, Is this PR active? I'm using typescript and this would be very useful for me

lamabiker · 2023-06-22T14:22:31Z

Hello, my team would also greatly benefit from having these TS defs. I can also help out if need be. Thanks!

acao · 2023-06-22T20:06:59Z

I finished up these type definitions at my last job and had intended to contribute to them, but there were layoffs, I will ask my former manager if he can contribute them, it only took a few hours!

lamabiker · 2023-06-23T13:38:38Z

Thank you very much! 🙏

…

On Thu, 22 Jun 2023, 22:07 Rikki Schulte, ***@***.***> wrote: I finished up & perfected these type definitions at my last job and had intended to contribute to them, but there were layoffs, I will ask my former manager if he can contribute them, it only took a few hours! — Reply to this email directly, view it on GitHub <#183 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ACLNPQCFSSQV4UR4H6H4LOTXMSQW5ANCNFSM47L7YYNA> . You are receiving this because you commented.Message ID: ***@***.***>

DanielJDufour · 2023-06-23T16:21:17Z

Thank you!

StevenLangbroek · 2023-06-23T16:33:33Z

I finished up these type definitions at my last job and had intended to contribute to them, but there were layoffs, I will ask my former manager if he can contribute them, it only took a few hours!

Here you go: https://gist.github.com/StevenLangbroek/3de4e7e67cf49c764edf449da319bf69

I had to make a small tweak for our use-case; I named the histogram key of the BlazeStats type, but since there was already a Histogram interface I gave it the clunky BlazeHistogram name. Not ideal, but I'm sure y'all can come up with a better name ✌️

twelch added 10 commits June 26, 2021 20:48

initial declaration file push

5666191

bandArithmetic

9156484

change dec filename, add test, migrate to unknown cell value

eda21e5

rasterCalc, georaster note

26993ae

identify return number

9207c1c

Rework Georaster interface

45e1d03

improve rasterCalculator operation

664af2e

add mins, maxs, ranges

9dd5fb8

sum improve

c180a9a

Make geom optional for all

b89cde9

twelch commented Jun 27, 2021

View reviewed changes

twelch marked this pull request as ready for review June 27, 2021 17:37

twelch commented Jun 27, 2021

View reviewed changes

src/geoblaze.d.ts Outdated Show resolved Hide resolved

twelch commented Jun 27, 2021

View reviewed changes

src/geoblaze.d.ts Outdated Show resolved Hide resolved

twelch mentioned this pull request Jun 27, 2021

Add Typescript definitions GeoTIFF/georaster#59

Open

4 tasks

migrate georaster bits upstream and refactor function signatures

a1f5b36

twelch marked this pull request as draft June 27, 2021 22:52

twelch added 2 commits June 27, 2021 17:17

solve default export object

f82a531

comments

5fc1962

twelch marked this pull request as ready for review June 28, 2021 00:32

twelch added 4 commits June 28, 2021 09:22

type fixes

958810c

get - add missing dimension

77146d7

get - add missing dimension for flat

dd695a5

fix histogram

033c9d1

change declaration file name to support automatic type import when us…

cfb0771

…ing index.js internally

twelch commented Aug 9, 2021

View reviewed changes

DanielJDufour requested changes Aug 13, 2021

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add typescript definitions #183

Add typescript definitions #183

twelch commented Jun 27, 2021 •

edited

Loading

twelch Jun 27, 2021

twelch Jul 15, 2021 •

edited

Loading

twelch commented Jun 27, 2021 •

edited

Loading

twelch commented Jun 27, 2021

twelch commented Jul 15, 2021

twelch Aug 9, 2021

DanielJDufour Aug 13, 2021

DanielJDufour left a comment

DanielJDufour Aug 13, 2021

DanielJDufour Aug 13, 2021

DanielJDufour Aug 13, 2021

mjernil commented Jun 15, 2023

lamabiker commented Jun 22, 2023

acao commented Jun 22, 2023 •

edited

Loading

lamabiker commented Jun 23, 2023 via email

DanielJDufour commented Jun 23, 2023

StevenLangbroek commented Jun 23, 2023

		type InputPolygon = number[][][] \| Polygon \| Feature<Polygon>;
		type InputPoint = number[] \| Point \| Feature<Point>;

		@@ -0,0 +1,108 @@
		import { Point, Polygon, Feature, BBox } from "geojson";
		import { Georaster } from "georaster";

Add typescript definitions #183

Are you sure you want to change the base?

Add typescript definitions #183

Conversation

twelch commented Jun 27, 2021 • edited Loading

Type of PR

What is the Goal of the PR?

twelch Jun 27, 2021

Choose a reason for hiding this comment

twelch Jul 15, 2021 • edited Loading

Choose a reason for hiding this comment

twelch commented Jun 27, 2021 • edited Loading

twelch commented Jun 27, 2021

twelch commented Jul 15, 2021

twelch Aug 9, 2021

Choose a reason for hiding this comment

DanielJDufour Aug 13, 2021

Choose a reason for hiding this comment

DanielJDufour left a comment

Choose a reason for hiding this comment

DanielJDufour Aug 13, 2021

Choose a reason for hiding this comment

DanielJDufour Aug 13, 2021

Choose a reason for hiding this comment

DanielJDufour Aug 13, 2021

Choose a reason for hiding this comment

mjernil commented Jun 15, 2023

lamabiker commented Jun 22, 2023

acao commented Jun 22, 2023 • edited Loading

lamabiker commented Jun 23, 2023 via email

DanielJDufour commented Jun 23, 2023

StevenLangbroek commented Jun 23, 2023

twelch commented Jun 27, 2021 •

edited

Loading

twelch Jul 15, 2021 •

edited

Loading

twelch commented Jun 27, 2021 •

edited

Loading

acao commented Jun 22, 2023 •

edited

Loading