npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@catchfashion/url-catalog-generator

v2.2.0

Published

generates Typescript URL schemas that parse / serialize / support react-router.

Downloads

2

Readme

@catchfashion/url-catalog-generator

generates Typescript URL schemas that parse / serialize / support react-router.

What's this for?

Modern App / Web requires singular url schema
such as https://www.catchfashion.com/category/abcdef and catch://category/abcdef
for this purpose, url-catalog-generator suggest centralized way of managing url schema.
which could be used for

  • frontend routing, (react-router / path-to-regexp)
  • backend routing

(schema.json)

{
  "name": "CATCH",
  "urls": [
    {
      "name": "Home",
      "description": "Home page",
      "pathTemplate": "/:gender",
      "params": {
        "path": { "gender": { "type": "string", "enum": ["men", "women"] } }
      }
    },
    {
      "name": "Category",
      "description": "Category page",
      "pathTemplate": "/category/:categoryId",
      "params": {
        "path": { "categoryId": { "type": "string" } }
      }
    },
  ]
}

run

npm install @catchfashion/url-catalog-generator
url-catalog schema.json ./src

This would automatically generates below files

(urls/Category.ts)

import { URLSchema } from "url-catalog-generator";

type QueryParams = {};
type PathParams = {
  gender: "men" | "women", categoryId: string
};
type AllParams = QueryParams & PathParams;

export class Category {
  public static schema = new URLSchema<QueryParams, PathParams>({
    name: "Category",
    description: "category main show page",
    pathTemplate: "/:gender/category/:categoryId",
    params: {"path":{"gender":{"type":"string","enum":["men","women"]},"categoryId":{"type":"string"}}},
  });

  public static parse(path: string) {
    const params = this.schema.parse(path);
    return params && new this(params);
  }

  public static serialize(params: AllParams) {
    return new this(params).toString();
  }

  constructor(public readonly params: AllParams) {}

  public toString() {
    return Category.schema.serialize(this.params);
  }
}

(urls/Home.ts)

import { URLSchema } from "url-catalog-generator";

type QueryParams = {};
type PathParams = {
  gender: "men" | "women"
};

type AllParams = QueryParams & PathParams;

export class Home {
  public static schema = new URLSchema<QueryParams, PathParams>({
    name: "Home",
    description: "Home page",
    pathTemplate: "/:gender",
    params: {"path":{"gender":{"type":"string","enum":["men","women"]}}},
  });

  public static parse(path: string) {
    const params = this.schema.parse(path);
    return params && new this(params);
  }

  public static serialize(params: AllParams) {
    return new this(params).toString();
  }

  constructor(public readonly params: AllParams) {}

  public toString() {
    return Home.schema.serialize(this.params);
  }
}

Parse

import { URLs } from "./urls";

const url = "some string';

function parseURL(url: string) {
  for (const schema of URLs) {
    let model = schema.parse(url);
    if (model) {
      return model;
    }
  }
}

const parsed = parseURL("/women");
if (parsed instanceof URLs.Home) {
  const gender = parsed.gender; // "men" / "women";
  console.log("its home!");
} else if (parse instanceof URLs.CategoryShow) {
  const categoryId = parsed.categoryId; // 
  console.log("it's category with id : ", categoryId);
}

Serialize

import { URLs } from "./urls";

new URLs.Home({ gender: "women" }).toString(); // "/women";
URLs.Home.serialize({ gender: "women" }); // "/women";

Path-To-Regexp Format

import { URLs } from "./urls";

URLs.Home.schema.toPathToRegexp() === "/:gender(women|men)";