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

@hdml/schemas

v0.0.2-alpha.5

Published

The `@hdml/schemas` package is a part of the **HDML-Utilities** monorepo and provides TypeScript types generated by the [FlatBuffers](https://google.github.io/flatbuffers/) tool. These types define the HyperData object model, facilitating consistent data

Downloads

279

Readme

@hdml/schemas

The @hdml/schemas package is a part of the HDML-Utilities monorepo and provides TypeScript types generated by the FlatBuffers tool. These types define the HyperData object model, facilitating consistent data handling and transfer across the HDML ecosystem.

Features

  • FlatBuffers-based: Uses FlatBuffers to ensure efficient and compact serialization and deserialization of data.
  • TypeScript support: Provides strongly typed interfaces for the HyperData object model.
  • Automated updates: Types are auto-generated from FlatBuffers schemas during the build process, ensuring synchronization with the latest schema definitions.

Installation

To include @hdml/schemas in your project, install it using npm or yarn:

npm install @hdml/schemas
# or
yarn add @hdml/schemas

Usage

Import the generated types into your TypeScript project to leverage the HyperData object model:

import { HDOM } from "@hdml/types";
import { ConnectorTypesEnum } from "@hdml/schemas";
import { serialize, deserialize } from "@hdml/buffer";

const hdom: HDOM = {
  includes: [],
  connections: [
    {
      name: "",
      description: null,
      options: {
        connector: ConnectorTypesEnum.Postgres,
        parameters: {
          host: "",
          user: "",
          password: "",
          ssl: false,
        },
      },
    },
  ],
  models: [],
  frames: [],
};
const buf = serialize(hdom);
const struct = deserialize(buf);

Schema Compilation

The @hdml/schemas package is the target for FlatBuffers schema compilation. The schemas are maintained in a separate repository, HDML-Schemas, which is included in the monorepo as a git submodule. This structure ensures a clean separation of schema definitions and their generated outputs.

Development Workflow

  • Update schemas: Make necessary changes to the FlatBuffers schemas in the HDML-Schemas repository.
  • Remap commit: After updating the schemas, remap the corresponding commit from the HDML-Schemas repository to the monorepo by updating the git submodule reference.
  • Compile schemas: Run the build process in the monorepo to generate updated TypeScript types from the schemas.
  • Use updated types: The latest types are now available in the @hdml/schemas package for use in your projects.

License

Apache License Version 2.0