Types for the `frontity` state

orballo · 6 July 2019 23:17

Hi folks!

I’m trying to migrate the existent mars-theme to typescript as a starting point for a new theme and I noticed there is no way to know the types of the state.frontity fields. Should I define them manually in my theme’s types or should they be defined somewhere else?

EDIT: Also, I noticed that tiny-router is importing @frontity/router types, but that package is declared as a dev dependency, so when you do npm i inside a Frontity project, those packages are not installed and you will have TypeScript complaining.

github.com

frontity/frontity/blob/8ff8b1b0991a38318046704fd5e54fa324f25564/packages/tiny-router/package.json#L30-L31


"@frontity/router": "^1.0.11",
"@frontity/source": "^1.0.10",

luisherranz · 8 July 2019 10:24

Uh, TypeScript in Mars!

Good question. I’ve only defined url because I’m not sure which ones should be the standard.

github.com

frontity/frontity/blob/dev/packages/types/src/package.ts#L18


};
state?: {
  frontity?: {
    // Automatically populated:
    name?: string;
    mode?: string;
    initialLink?: string;
    packages?: string[];
    platform?: "client" | "server";
    // Populated by the user:
    url?: string;
  };
  [namespace: string]: {
    [key: string]: any;
  };
};
actions?: {
  [namespace: string]: {
    [action: string]:
      | (({
          state,

I won’t like to add too many things to the “standard”. Maybe title and description are basic, since you won’t usually want to retrieve them from the REST API, right?

What other state.frontity fields do you miss?

Oh, feel free to fix that then

orballo · 8 July 2019 10:37

I didn’t miss anything else. It’s just a bit weird to define some fields under the frontity namespace, and then to type them in the theme, but I guess that if we cover those 3, people will define the new ones under the theme namespace.

If you want me to add those types in a PR let me know

luisherranz · 8 July 2019 13:20

Sure, go ahead

Konstantin · 31 October 2019 20:48

Hey mate,

did you ever succeed in creating the TS version of the mars theme? And if so, would you mind sharing? I was about to start working on this when I realised that I am likely not the first one who thought about this and found your old post.

Cheers!

orballo · 1 November 2019 11:21

Hi! I’m afraid I stopped working on that. But I didn’t actually ported mars-theme to TypeScript, I built another theme from it. So you can proceed with your theme!

If you have any doubt I might be able to help.

orballo · 1 November 2019 21:33

I opened Problems when starting a Frontity project with TypeScript to continue the conversation there.