[WIP] typescript definitions

[PopGoesTheWza]

Issue #245 [Work In Progress]

Types are broken down into two files

• specification.d.ts attempts to follow strictly Stamp Specification v1.6
• index.d.ts exposes stampit extended implementation

For review:

• lookout for special comments // ?, // ! and // TODO

Sample code

import stampit, { compose, init } from 'stampit';

// default instance type (any)

const a = stampit().init(function(options) {
  const a = options.args[0];
  this.getA = () => {
    return a;
  };
});
a(); // Object -- so far so good.
a().getA(); // "a"

// typed instances

  interface CoordsInstance {
    x: number;
    y: number;
    coordsToString: () => string;
  }

  interface ColorInstance {
    color: string;
  }

  const Coords = compose<CoordsInstance>({
    initializers: [
      function({ x, y }) {
        this.x = x;
        this.y = y;
      },
    ],
    methods: {
      coordsToString() {
        return `(${this.x}, ${this.y})`;
      },
    },
  });
  const Point = compose<CoordsInstance & { toString: () => string }>(
    Coords,
    {
      methods: {
        toString() {
          return this.coordsToString();
        },
      },
    },
  );
  const Color = compose<ColorInstance>({
    initializers: [
      function({ color }) {
        this.color = color;
      },
    ],
  });

[koresar]

First of all, this is quite solid ground work! So much new learning for me.

I would leave few comments on the PR, but my TypeScript knowledge is limited (to C#). So, they will likely be irrelevant. :) Sorry!

[koresar]

For streamlining this PR we need to get in sync on stampit's terminology. I'm getting confused with the terminology used in this PR. Let me put it the way I understand:

• Stamp - is a factory function to create plain object instances. A Stamp always has property .compose which is a (copy of) Compose function.
• Instance - a plain JavaScript object created from a Stamp. (We usually do not use the word "instance" in any other context.)
• Descriptor - a JavaScript object (not always plain, can be a function) which contains Stamp's metadata as properties
• Compose function - the function which creates Stamps from composables.
• Composer function - note the R (!) - the function which is kept in the composers metadata of a descriptor
• Composable - either a Stamp or a Descriptor

[PopGoesTheWza]

@koresar All descriptions in specification.d.ts have been reviewed and should now make more sense

[PopGoesTheWza]

This PR is superseeded by #348

[PopGoesTheWza]

Closing this outdated PR