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

magic-odata-shared

v1.1.1

Published

Shared interfaces between magic-odata-client and magic-odata-code-gen

Downloads

34

Readme

magic-odata

Magical OData client generation for typescript. No more string. No more any!

Node.js CI NPM Coverage Status License

Install

npm i magic-odata-code-gen --save-dev; npm i magic-odata-client;

  • magic-odata-code-gen is a dev dependency required to generate a client at compile time
    • This tool is small and we recommend installing it locally per project in order to avoid versioning issues
  • magic-odata-client is a dependency of your application. The generated code will use this package

Generate

node node_modules/magic-odata-code-gen/dist/index.js --metadataUrl "https://raw.githubusercontent.com/ShaneGH/magic-odata/main/docs/sampleOdataMetadata.xml"

Use

// import a generated client
import { ODataClient } from "./odataClient.js"

// create a client instance
const oDataClient = new ODataClient({
    // inject a basic Http client
    request: (input, init) => fetch(input, init),

    // add a root URI
    uriRoot: "https://my.odata.server/odata"
})

// use the client!
const popularBlogPosts = oDataClient.BlogPosts
    // Use object deconstruction to choose query tools
    .withQuery((blogPost, {
        $orderby: {orderBy}, 
        $skip, 
        $top
    }) => [ 
        // Combine query tools and fluent operations to build a query
        blogPost.Comments.$count.gt(100).or(blogPost.Likes.gt(100)),
        orderBy(blogPost.Name),
        $skip(0),
        $top(10)
    ])
    .get();

Why?

Write safe, statically typed odata queries in typescript. No more string. No more any!

  • Cut down on runtime errors
  • Explore OData API possibilities in your IDE
  • Runs in the browser or in node
  • No prod dependencies. Small bundle size
    • Generated executable code is tiny. Almost all generated code is type information
    • magic-odata-client minifies and compresses to ~10KB
  • Optional angular mode, for the angular HttpClient

Features

See Features.md

  • Code gen configuration
    • $metadata files protected with authentication
    • Angular mode
  • Client configuration
  • OData GET requests
  • OData URI generation
  • Entity keys
  • Entity path
  • @Parameter aliases
  • Enums
  • Functions
  • Indexed ordered collections
  • Query options
    • $filter
      • fluent comparison operators
    • $select
    • $expand
      • $levels
    • $orderBy
    • $search
    • $skip, $top and $count
    • custom
    • $root
  • Casting
  • $value

Contributing

See Contributing.md