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

ozone-type

v6.2.4

Published

ozone type declaration package

Downloads

4,303

Readme

NPM version

ozone-type

Expose Ozone and Flowr types in typescript

Install

$ npm install ozone-type

Utilities

  • Item: base type for ozone items.
  • OzoneType: decorator for class that extend Item.
  • FromOzone<T extends Item>: template type for Item received from ozone.
  • function toPatch<T extends Item>(item: FromOzone<T>): Patch<T>: transform Item received from ozone to item that can be saved.
  • function toPatchWithUndefinedAsNull<T extends Item>(item: FromOzone<T>): Patch<T>: same as function toPatch but it set filed explicitly undefined to null so that they can be erase on ozone

Usage example

import { toPatch, Patch, UUID, FromOzone } from 'ozone-type'
declare function getMyNewTypeFromOzone(id: UUID): FromOzone<MyNewType>
declare function saveMyNewTypeToOzone(data: Patch<MyNewType>): FromOzone<MyNewType>

const myData = getMyNewTypeFromOzone('myID')
const myDataToUpdate = toPatch(myData)
myDataToUpdate.aLocalizedAttr = {
	fr: 'bonjour',
	en: 'hello'
}
saveMyNewTypeToOzone(myDataToUpdate)

Add one type

Add a file in ozone/model

// import base type
import { OzoneType, Item, UUID } from 'ozone-type'

/**
 * MyNewType is a new ozone object
 */
OzoneType('my.new.type') // decorate to set type by default
export class MyNewType extends Item { // All the dynamic typed ozone object extend Item

	anAttribute?: UUID
	aLocalizedAttr?: {[key: string]: string}
	/**
	 * Recopy constructor
	 * @param src
	 */
	constructor(src: MyNewType) {
		super(src)
		this.anAttribute = src.anAttribute
		this.aLocalizedAttr = src.aLocalizedAttr
	}

	// Use static method for helpers. So that new is not mandatory.
	static getAttrIn(src: MyNewType, language: string): string | undefined {
		src.aLocalizedAttr = src.aLocalizedAttr || {}
		return src.aLocalizedAttr[language]
	}
}

Then add export statment in ozone/model/models.ts

Bulck Update all ozone typings

Generate Ozone Item classes using oz. For example:

oz -u taktik -s https://test.flowr.cloud/ozone -p <password> generate --package "" --target typescript -o ./ozone-components/packages/ozone-helper/ozone-type/ozone/model

Then commit git add ozone/model/*