Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

@storm-stack/serialization

Package Overview
Dependencies
Maintainers
0
Versions
104
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@storm-stack/serialization - npm Package Compare versions

Comparing version 1.18.2 to 1.19.0

dist/index.mjs
dist/serializable.cjs
dist/serializable.d.ts
dist/serializable.mjs
dist/storm-parser.cjs
dist/storm-parser.d.ts
dist/storm-parser.mjs
dist/storm-url-builder.cjs
dist/storm-url-builder.d.ts
dist/storm-url-builder.mjs
dist/types.cjs
dist/types.d.ts
dist/types.mjs

313

dist/index.d.ts

@@ -1,309 +0,4 @@

import SuperJSON from 'superjson';
declare type Class = {
new (...args: any[]): any;
};
export { Class }
export { Class as Class_alias_1 }
declare type ClassInstance = any;
export { ClassInstance }
export { ClassInstance as ClassInstance_alias_1 }
/**
* A class that can be serialized and deserialized
*/
declare interface ClassSerializable<_TData, TJsonValue extends JsonValue = JsonValue> {
/**
* Serialize the class to a JSON object
*
* @returns The data object to serialize
*/
serialize: () => JsonParserResult;
/**
* Deserialize the class from a JSON object
*
* @param json - The JSON object to deserialize from
*/
deserialize: (json: TJsonValue) => void;
}
export { ClassSerializable }
export { ClassSerializable as ClassSerializable_alias_1 }
declare type ClassTypeAnnotation = ["class", string];
export { ClassTypeAnnotation }
export { ClassTypeAnnotation as ClassTypeAnnotation_alias_1 }
declare interface ClassTypeCheckable<T> extends ITyped {
/**
* Run type check on the given value
* @param value - The value to check
* @returns True if the value is of the type of the class
*/
isTypeOf: (value: unknown) => value is T;
}
declare type CompositeTypeAnnotation = TypedArrayAnnotation | ClassTypeAnnotation | SymbolTypeAnnotation | CustomTypeAnnotation;
export { CompositeTypeAnnotation }
export { CompositeTypeAnnotation as CompositeTypeAnnotation_alias_1 }
declare type CustomTypeAnnotation = ["custom", string];
export { CustomTypeAnnotation }
export { CustomTypeAnnotation as CustomTypeAnnotation_alias_1 }
/**
* A class that can be serialized and deserialized
*/
declare interface DataTransformer<TData, TJsonValue extends JsonValue = JsonValue> {
/**
* Serialize the class to a JSON object
*
* @param data - The data object to serialize
* @returns The serialized JSON object
*/
serialize: SerializationFunct<TData, TJsonValue>;
/**
* Deserialize the class from a JSON object
*
* @param json - The JSON object to deserialize from
* @returns The deserialized data
*/
deserialize: DeserializeFunct<TData, TJsonValue>;
}
export { DataTransformer }
export { DataTransformer as DataTransformer_alias_1 }
/**
* A function that can deserialize a certain type of data
*
* @param json - The JSON object to deserialize from
* @returns The deserialized data
*/
declare type DeserializeFunct<TData = any, TJsonValue extends JsonValue = JsonValue> = (json: TJsonValue) => TData;
export { DeserializeFunct }
export { DeserializeFunct as DeserializeFunct_alias_1 }
declare interface IJsonParser {
parse: <TData = any>(strData: string) => TData;
stringify: <TData = any>(data: TData) => string;
serialize: (object: JsonValue) => JsonParserResult;
deserialize: <TData = any>(payload: JsonParserResult) => TData;
register: <TData = any, TJsonValue extends JsonValue = JsonValue>(name: string, serialize: (object: JsonValue) => TJsonValue, deserialize: (payload: TJsonValue) => TData, isApplicable: (data: any) => data is TData) => void;
}
export { IJsonParser }
export { IJsonParser as IJsonParser_alias_1 }
declare type InnerNode<T> = [T, Record<string, Tree<T>>];
export { InnerNode }
export { InnerNode as InnerNode_alias_1 }
declare interface ITyped {
/**
* The type of the record
*/
__typename: string;
}
declare interface JsonArray extends Array<JsonValue> {
}
export { JsonArray }
export { JsonArray as JsonArray_alias_1 }
declare interface JsonObject {
[key: string]: JsonValue;
}
export { JsonObject }
export { JsonObject as JsonObject_alias_1 }
declare interface JsonParserResult {
json: JsonValue;
meta?: {
values?: Tree<TypeAnnotation> | Record<string, Tree<TypeAnnotation>> | undefined;
referentialEqualities?: Record<string, string[]> | [string[]] | [string[], Record<string, string[]>];
};
}
export { JsonParserResult }
export { JsonParserResult as JsonParserResult_alias_1 }
declare type JsonValue = PrimitiveJsonValue | JsonArray | JsonObject;
export { JsonValue }
export { JsonValue as JsonValue_alias_1 }
declare type Leaf<T> = [T];
export { Leaf }
export { Leaf as Leaf_alias_1 }
declare type LeafTypeAnnotation = PrimitiveTypeAnnotation | "regexp" | "Date" | "Error" | "URL";
export { LeafTypeAnnotation }
export { LeafTypeAnnotation as LeafTypeAnnotation_alias_1 }
declare type PrimitiveJsonValue = string | number | boolean | undefined | null;
export { PrimitiveJsonValue }
export { PrimitiveJsonValue as PrimitiveJsonValue_alias_1 }
declare type PrimitiveTypeAnnotation = "number" | "undefined" | "bigint";
export { PrimitiveTypeAnnotation }
export { PrimitiveTypeAnnotation as PrimitiveTypeAnnotation_alias_1 }
declare const Serializable: <TData = any>(options?: {
/**
* The type and/or name of the record
*/
identifier?: string;
}) => <TClass extends new (..._args: any) => any = new (..._args: any) => TData>(target: TClass) => {
new (..._args: any): {
[x: string]: any;
/**
* The name of the class's type
*/
__typename: string;
/**
* Serialize the class to a JSON object
*
* @returns The data object to serialize
*/
serialize: () => JsonParserResult;
/**
* Deserialize the class from a JSON object
*
* @param json - The JSON object to deserialize from
*/
deserialize: (json: JsonValue) => JsonParserResult;
/**
* Convert the class instance to a string
*
* @returns A string version of the class instance
*/
stringify: () => string;
/**
* Convert the stringified class to an instance of the object
*
* @param strObject - A stringified version of the class instance
* @returns An instance of the class converted from the provided string
*/
parse: (strObject: string) => TData;
/**
* Run type check on the given value
* @param value - The value to check
* @returns True if the value is of the type of the class
*/
isTypeOf(value: any): value is TData;
};
/**
* The name of the class's type
*/
__typename: string;
/**
* Run type check on the given value
* @param value - The value to check
* @returns True if the value is of the type of the class
*/
isTypeOf(value: any): value is TData;
/**
* Deserialize the class from a JSON object
*
* @param json - The JSON object to deserialize from
*/
deserialize: (json: JsonValue) => JsonParserResult;
/**
* Convert the stringified class to an instance of the object
*
* @param strObject - A stringified version of the class instance
* @returns An instance of the class converted from the provided string
*/
parse: (strObject: string) => TData;
} & TClass;
export { Serializable }
export { Serializable as Serializable_alias_1 }
declare type SerializableJsonValue = symbol | Set<JsonValue> | Map<JsonValue, JsonValue> | undefined | bigint | Date | ClassInstance | RegExp;
export { SerializableJsonValue }
export { SerializableJsonValue as SerializableJsonValue_alias_1 }
declare type SerializableType<T> = ClassSerializable<T> & ClassTypeCheckable<T> & ITyped & T;
export { SerializableType }
export { SerializableType as SerializableType_alias_1 }
/**
* A function that can serialize a certain type of data
*
* @param data - The data object to serialize
* @returns The serialized JSON object
*/
declare type SerializationFunct<TData = any, TJsonValue extends JsonValue = JsonValue> = (data: TData) => TJsonValue;
export { SerializationFunct }
export { SerializationFunct as SerializationFunct_alias_1 }
declare type SerializationMetadata<T> = DataTransformer<T> & ClassTypeCheckable<T>;
export { SerializationMetadata }
export { SerializationMetadata as SerializationMetadata_alias_1 }
declare type SimpleTypeAnnotation = LeafTypeAnnotation | "map" | "set";
export { SimpleTypeAnnotation }
export { SimpleTypeAnnotation as SimpleTypeAnnotation_alias_1 }
/**
* A static JSON parser class used by Storm Software to serialize and deserialize JSON
*
* @remarks
* This class uses the [SuperJSON](https://github.com/blitz-js/superjson) library
*/
declare class StormParser extends SuperJSON {
private static _instance;
static get instance(): StormParser;
/**
* Deserialize the given value with superjson using the given metadata
*/
static deserialize<TData = unknown>(payload: JsonParserResult): TData;
/**
* Serialize the given value with superjson
*/
static serialize(object: JsonValue): JsonParserResult;
/**
* Parse the given value with superjson using the given metadata
*/
static parse<TData = unknown>(strData: string): TData;
/**
* Stringify the given value with superjson
*/
static stringify(json: any): string;
/**
* Register a custom schema with superjson
*
* @param name - The name of the schema
* @param serialize - The function to serialize the schema
* @param deserialize - The function to deserialize the schema
* @param isApplicable - The function to check if the schema is applicable
*/
static register<TData = any, TJsonObject extends JsonValue = JsonValue>(name: string, serialize: (data: TData) => TJsonObject, deserialize: (json: TJsonObject) => TData, isApplicable: (data: any) => data is TData): void;
/**
* Register a class with superjson
*
* @param classConstructor - The class constructor to register
*/
static registerClass(classConstructor: Class, options?: {
identifier?: string;
allowProps?: string[];
} | string): void;
private constructor();
}
export { StormParser }
export { StormParser as StormParser_alias_1 }
declare type SymbolTypeAnnotation = ["symbol", string];
export { SymbolTypeAnnotation }
export { SymbolTypeAnnotation as SymbolTypeAnnotation_alias_1 }
declare type Tree<T> = InnerNode<T> | Leaf<T>;
export { Tree }
export { Tree as Tree_alias_1 }
declare type TypeAnnotation = SimpleTypeAnnotation | CompositeTypeAnnotation;
export { TypeAnnotation }
export { TypeAnnotation as TypeAnnotation_alias_1 }
declare type TypedArrayAnnotation = ["typed-array", string];
export { TypedArrayAnnotation }
export { TypedArrayAnnotation as TypedArrayAnnotation_alias_1 }
export { }
export * from "./serializable";
export * from "./storm-parser";
export * from "./storm-url-builder";
export * from "./types";

108

package.json
{
"name": "@storm-stack/serialization",
"version": "1.18.2",
"private": false,
"version": "1.19.0",
"type": "module",
"description": "A package used to support serializing and deserializing data sent between the client and the server.",

@@ -11,25 +11,14 @@ "repository": {

},
"type": "module",
"dependencies": { "buffer": "^6.0.3", "superjson": "2.2.1" },
"devDependencies": { "@types/node": "^20.10.5" },
"publishConfig": { "access": "public" },
"exports": {
".": {
"import": { "types": "./dist/index.d.ts", "default": "./dist/index.js" },
"require": {
"types": "./dist/index.d.cts",
"default": "./dist/index.cjs"
},
"default": { "types": "./dist/index.d.ts", "default": "./dist/index.js" }
},
"./package.json": "./package.json",
"./index": {
"import": { "types": "./dist/index.d.ts", "default": "./dist/index.js" },
"require": {
"types": "./dist/index.d.cts",
"default": "./dist/index.cjs"
},
"default": { "types": "./dist/index.d.ts", "default": "./dist/index.js" }
}
"private": false,
"dependencies": {
"buffer": "^6.0.3",
"superjson": "2.2.1",
"ufo": "^1.5.4"
},
"devDependencies": {
"@types/node": "^22.5.5"
},
"publishConfig": {
"access": "public"
},
"sideEffects": false,

@@ -40,20 +29,11 @@ "funding": {

},
"types": "dist/index.d.ts",
"typings": "dist/index.d.ts",
"typescript": { "definition": "dist/index.d.ts" },
"main": "dist/index.cjs",
"module": "dist/index.js",
"browser": "dist/index.global.js",
"files": ["dist/**/*"],
"homepage": "https://stormsoftware.org",
"files": [
"dist/**/*"
],
"homepage": "https://stormsoftware.com",
"bugs": {
"url": "https://stormsoftware.org/support",
"email": "support@stormsoftware.org"
"url": "https://stormsoftware.com/support",
"email": "support@stormsoftware.com"
},
"author": {
"name": "Storm Software",
"email": "contact@stormsoftware.org",
"url": "https://stormsoftware.org"
},
"license": "Apache License 2.0",
"license": "Apache-2.0",
"keywords": [

@@ -68,12 +48,48 @@ "storm-stack",

"acidic-model",
"impact",
"cyclone-ui",
"nextjs",
"prisma",
"zenstack",
"hasura",
"strapi",
"graphql",
"sullivanpj",
"monorepo"
]
}
],
"author": {
"name": "Storm Software",
"email": "contact@stormsoftware.com",
"url": "https://stormsoftware.com"
},
"contributors": [
{
"name": "Storm Software",
"email": "contact@stormsoftware.com",
"url": "https://stormsoftware.com"
}
],
"exports": {
"./types": {
"import": "./dist/types.mjs",
"require": "./dist/types.cjs",
"types": "./dist/types.d.ts"
},
"./storm-url-builder": {
"import": "./dist/storm-url-builder.mjs",
"require": "./dist/storm-url-builder.cjs",
"types": "./dist/storm-url-builder.d.ts"
},
"./storm-parser": {
"import": "./dist/storm-parser.mjs",
"require": "./dist/storm-parser.cjs",
"types": "./dist/storm-parser.d.ts"
},
"./serializable": {
"import": "./dist/serializable.mjs",
"require": "./dist/serializable.cjs",
"types": "./dist/serializable.d.ts"
},
"./index": {
"import": "./dist/index.mjs",
"require": "./dist/index.cjs",
"types": "./dist/index.d.ts"
}
}
}

200

README.md

@@ -6,24 +6,61 @@ <!-- START header -->

<div align="center"><img src="https://pub-761b436209f44a4d886487c917806c08.r2.dev/storm-banner.gif" width="100%" altText="Storm Software" /></div>
<div align="center"><img src="https://pub-761b436209f44a4d886487c917806c08.r2.dev/storm-banner.gif" width="100%" alt="Storm Software" /></div>
<br />
<br />
<div align="center">
<a href="https://stormsoftware.org" target="_blank">Website</a> | <a href="https://stormsoftware.org/contact" target="_blank">Contact</a> | <a href="https://github.com/storm-software/storm-stack" target="_blank">Repository</a> | <a href="https://storm-software.github.io/storm-stack/" target="_blank">Documentation</a> | <a href="https://github.com/storm-software/storm-stack/issues/new?assignees=&labels=bug&template=bug-report.yml&title=Bug Report%3A+">Report a Bug</a> | <a href="https://github.com/storm-software/storm-stack/issues/new?assignees=&labels=enhancement&template=feature-request.yml&title=Feature Request%3A+">Request a Feature</a> | <a href="https://github.com/storm-software/storm-stack/discussions">Ask a Question</a>
<b>
<a href="https://stormsoftware.com" target="_blank">Website</a> •
<a href="https://github.com/storm-software/storm-stack" target="_blank">GitHub</a> •
<a href="https://discord.gg/MQ6YVzakM5">Discord</a> • <a href="https://stormstack.github.io/stormstack/" target="_blank">Docs</a> • <a href="https://stormsoftware.com/contact" target="_blank">Contact</a> •
<a href="https://github.com/storm-software/storm-stack/issues/new?assignees=&labels=bug&template=bug-report.yml&title=Bug Report%3A+">Report a Bug</a>
</b>
</div>
<br />
This package is part of the <b>⚡storm-stack</b> monorepo. The storm-stack packages include CLI utility applications, tools, and various libraries used to create modern, scalable web applications.
This package is part of the ⚡<b>Storm Stack</b> monorepo. Storm Stack packages include CLI utility applications, tools, and various libraries used to create modern, scalable web applications.
<br />
<h3 align="center">💻 Visit <a href="https://stormsoftware.org" target="_blank">stormsoftware.org</a> to stay up to date with this developer</h3><br />
<h3 align="center">💻 Visit <a href="https://stormsoftware.com" target="_blank">stormsoftware.com</a> to stay up to date with this developer</h3><br />
[![Version](https://img.shields.io/badge/version-1.17.2-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;
[![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with docusaurus](https://img.shields.io/badge/documented_with-docusaurus-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://docusaurus.io/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/storm-ops/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
[![Version](https://img.shields.io/badge/version-1.19.0-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;[![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with Fumadocs](https://img.shields.io/badge/documented_with-fumadocs-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://fumadocs.vercel.app/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/storm-stack/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
> [!IMPORTANT]
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
> [!IMPORTANT]
> This repository, and the apps, libraries, and tools contained within, is still in it's initial development phase. As a result, bugs and issues are expected with it's usage. When the main development phase completes, a proper release will be performed, the packages will be availible through NPM (and other distributions), and this message will be removed. However, in the meantime, please feel free to report any issues you may come across.
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<div align="center">
<b>Be sure to ⭐ this repository on <a href="https://github.com/storm-software/storm-stack" target="_blank">GitHub</a> so you can keep up to date on any daily progress!</b>
</div>
<br />
<!-- START doctoc -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
## Table of Contents
- [Storm Serialization](#storm-serialization)
- [Table of Contents](#table-of-contents)
- [Installing](#installing)
- [Reduced Package Size](#reduced-package-size)
- [Development](#development)
- [Building](#building)
- [Running unit tests](#running-unit-tests)
- [Linting](#linting)
- [Storm Workspaces](#storm-workspaces)
- [Roadmap](#roadmap)
- [Support](#support)
- [License](#license)
- [Changelog](#changelog)
- [Contributing](#contributing)
- [Contributors](#contributors)
<!-- END doctoc -->
<br />
<!-- markdownlint-restore -->

@@ -36,5 +73,27 @@ <!-- prettier-ignore-end -->

This package contains the serialization logic for the Storm project. It is responsible for serializing and deserializing the data that is sent between the client and the server. The code serialization logic is handled by the [SuperJson](https://github.com/blitz-js/superjson) library.
This package contains the serialization logic for the Storm project. It is
responsible for serializing and deserializing the data that is sent between the
client and the server. The code serialization logic is handled by the
[SuperJson](https://github.com/blitz-js/superjson) library.
<!-- START doctoc -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
## Table of Contents
- [Installing](#installing)
- [Reduced Package Size](#reduced-package-size)
- [Development](#development)
- [Building](#building)
- [Running unit tests](#running-unit-tests)
- [Linting](#linting)
- [Storm Workspaces](#storm-workspaces)
- [Roadmap](#roadmap)
- [Support](#support)
- [License](#license)
- [Changelog](#changelog)
- [Contributing](#contributing)
- [Contributors](#contributors)
- [💻 Visit stormsoftware.org to stay up to date with this developer](#-visit-stormsoftwareorg-to-stay-up-to-date-with-this-developer)
<!-- END doctoc -->

@@ -70,7 +129,11 @@

This project uses [tsup](https://tsup.egoist.dev/) to package the source code due to its ability to remove unused code and ship smaller javascript files thanks to code splitting. This helps to greatly reduce the size of the package and to make it easier to use in other projects.
This project uses [tsup](https://tsup.egoist.dev/) to package the source code
due to its ability to remove unused code and ship smaller javascript files
thanks to code splitting. This helps to greatly reduce the size of the package
and to make it easier to use in other projects.
## Development
This project is built using [Nx](https://nx.dev). As a result, many of the usual commands are available to assist in development.
This project is built using [Nx](https://nx.dev). As a result, many of the usual
commands are available to assist in development.

@@ -83,3 +146,4 @@ ### Building

Run `nx test serialization` to execute the unit tests via [Jest](https://jestjs.io).
Run `nx test serialization` to execute the unit tests via
[Jest](https://jestjs.io).

@@ -97,12 +161,26 @@ ### Linting

Storm workspaces are built using <a href="https://nx.dev/" target="_blank">Nx</a>, a set of extensible dev tools for monorepos, which helps you develop like Google, Facebook, and Microsoft. Building on top of Nx, the Open System provides a set of tools and patterns that help you scale your monorepo to many teams while keeping the codebase maintainable.
Storm workspaces are built using
<a href="https://nx.dev/" target="_blank">Nx</a>, a set of extensible dev tools
for monorepos, which helps you develop like Google, Facebook, and Microsoft.
Building on top of Nx, the Open System provides a set of tools and patterns that
help you scale your monorepo to many teams while keeping the codebase
maintainable.
<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
<br />
## Roadmap
See the [open issues](https://github.com/storm-software/storm-stack/issues) for a list of proposed features (and known issues).
See the [open issues](https://github.com/storm-software/storm-stack/issues) for a
list of proposed features (and known issues).
- [Top Feature Requests](https://github.com/storm-software/storm-stack/issues?q=label%3Aenhancement+is%3Aopen+sort%3Areactions-%2B1-desc) (Add your votes using the 👍 reaction)
- [Top Bugs](https://github.com/storm-software/storm-stack/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Areactions-%2B1-desc) (Add your votes using the 👍 reaction)
- [Top Feature Requests](https://github.com/storm-software/storm-stack/issues?q=label%3Aenhancement+is%3Aopen+sort%3Areactions-%2B1-desc)
(Add your votes using the 👍 reaction)
- [Top Bugs](https://github.com/storm-software/storm-stack/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Areactions-%2B1-desc)
(Add your votes using the 👍 reaction)
- [Newest Bugs](https://github.com/storm-software/storm-stack/issues?q=is%3Aopen+is%3Aissue+label%3Abug)
<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
<br />
## Support

@@ -112,19 +190,35 @@

- [Contact](https://stormsoftware.org/contact)
- [Contact](https://stormsoftware.com/contact)
- [GitHub discussions](https://github.com/storm-software/storm-stack/discussions)
- <support@stormsoftware.org>
- <support@stormsoftware.com>
<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
<br />
## License
This project is licensed under the **Apache License 2.0**. Feel free to edit and distribute this template as you like.
This project is licensed under the **Apache License 2.0**. Feel free to edit and
distribute this template as you like.
See [LICENSE](LICENSE) for more information.
<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
<br />
## Changelog
This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). Every release, along with the migration instructions, is documented in the [CHANGELOG](CHANGELOG.md) file
This project adheres to
[Semantic Versioning](https://semver.org/spec/v2.0.0.html). Every release, along
with the migration instructions, is documented in the [CHANGELOG](CHANGELOG.md)
file
<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
<br />
## Contributing
First off, thanks for taking the time to contribute! Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are **greatly appreciated**.
First off, thanks for taking the time to contribute! Contributions are what
makes the open-source community such an amazing place to learn, inspire, and
create. Any contributions you make will benefit everybody else and are **greatly
appreciated**.

@@ -134,3 +228,4 @@ Please try to create bug reports that are:

- _Reproducible._ Include steps to reproduce the problem.
- _Specific._ Include as much detail as possible: which version, what environment, etc.
- _Specific._ Include as much detail as possible: which version, what
environment, etc.
- _Unique._ Do not duplicate existing opened issues.

@@ -141,7 +236,13 @@ - _Scoped to a Single Bug._ One bug per report.

You can use [markdownlint-cli](https://github.com/storm-software/storm-stack/markdownlint-cli) to check for common markdown style inconsistency.
You can use
[markdownlint-cli](https://github.com/storm-software/storm-stack/markdownlint-cli)
to check for common markdown style inconsistency.
<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
<br />
## Contributors
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Thanks goes to these wonderful people
([emoji key](https://allcontributors.org/docs/en/emoji-key)):

@@ -153,5 +254,5 @@ <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->

<tr>
<td align="center" valign="top" width="14.28%"><a href="http://www.sullypat.com/"><img src="https://avatars.githubusercontent.com/u/99053093?v=4?s=100" width="100px;" alt="Patrick Sullivan"/><br /><sub><b>Patrick Sullivan</b></sub></a><br /><a href="#design-sullivanpj" title="Design">🎨</a> <a href="https://github.com/storm-software/storm-ops/commits?author=sullivanpj" title="Code">💻</a> <a href="#tool-sullivanpj" title="Tools">🔧</a> <a href="https://github.com/storm-software/storm-ops/commits?author=sullivanpj" title="Documentation">📖</a> <a href="https://github.com/storm-software/storm-ops/commits?author=sullivanpj" title="Tests">⚠️</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://www.sullypat.com/"><img src="https://avatars.githubusercontent.com/u/99053093?v=4?s=100" width="100px;" alt="Patrick Sullivan"/><br /><sub><b>Patrick Sullivan</b></sub></a><br /><a href="#design-sullivanpj" title="Design">🎨</a> <a href="https://github.com/storm-software/storm-stack/commits?author=sullivanpj" title="Code">💻</a> <a href="#tool-sullivanpj" title="Tools">🔧</a> <a href="https://github.com/storm-software/storm-stack/commits?author=sullivanpj" title="Documentation">📖</a> <a href="https://github.com/storm-software/storm-stack/commits?author=sullivanpj" title="Tests">⚠️</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://tylerbenning.com/"><img src="https://avatars.githubusercontent.com/u/7265547?v=4?s=100" width="100px;" alt="Tyler Benning"/><br /><sub><b>Tyler Benning</b></sub></a><br /><a href="#design-tbenning" title="Design">🎨</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://stormsoftware.org"><img src="https://avatars.githubusercontent.com/u/149802440?v=4?s=100" width="100px;" alt="Stormie"/><br /><sub><b>Stormie</b></sub></a><br /><a href="#maintenance-stormie-bot" title="Maintenance">🚧</a></td>
<td align="center" valign="top" width="14.28%"><a href="http://stormsoftware.com"><img src="https://avatars.githubusercontent.com/u/149802440?v=4?s=100" width="100px;" alt="Stormie"/><br /><sub><b>Stormie</b></sub></a><br /><a href="#maintenance-stormie-bot" title="Maintenance">🚧</a></td>
</tr>

@@ -162,3 +263,3 @@ </tbody>

<td align="center" size="13px" colspan="7">
<img src="https://raw.githubusercontent.com/all-contributors/all-contributors-cli/1b8533af435da9854653492b1327a23a4dbd0a10/assets/logo-small.svg">
<img src="https://raw.githubusercontent.com/all-contributors/all-contributors-cli/1b8533af435da9854653492b1327a23a4dbd0a10/assets/logo-small.svg" alt="All Contributors">
<a href="https://all-contributors.js.org/docs/en/bot/usage">Add your contributions</a>

@@ -173,24 +274,55 @@ </img>

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
This project follows the
[all-contributors](https://github.com/all-contributors/all-contributors)
specification. Contributions of any kind welcome!
<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
<br />
<hr />
<br />
<div align="center">
<img src="https://pub-761b436209f44a4d886487c917806c08.r2.dev/logo-banner.png" width="100%" altText="Storm Software" />
<img src="https://pub-761b436209f44a4d886487c917806c08.r2.dev/logo-banner.png" width="100%" alt="Storm Software" />
</div>
<br />
<div align="center">
<a href="https://stormsoftware.org" target="_blank">Website</a> | <a href="https://stormsoftware.org/contact" target="_blank">Contact</a> | <a href="https://linkedin.com/in/patrick-sullivan-865526b0" target="_blank">LinkedIn</a> | <a href="https://medium.com/@pat.joseph.sullivan" target="_blank">Medium</a> | <a href="https://github.com/storm-software" target="_blank">GitHub</a> | <a href="https://keybase.io/sullivanp" target="_blank">OpenPGP Key</a>
<a href="https://stormsoftware.com" target="_blank">Website</a> • <a href="https://stormsoftware.com/contact" target="_blank">Contact</a> • <a href="https://linkedin.com/in/patrick-sullivan-865526b0" target="_blank">LinkedIn</a> • <a href="https://medium.com/@pat.joseph.sullivan" target="_blank">Medium</a> • <a href="https://github.com/storm-software" target="_blank">GitHub</a> • <a href="https://keybase.io/sullivanp" target="_blank">OpenPGP Key</a>
</div>
<div align="center">
<p><b>Fingerprint:</b> 1BD2 7192 7770 2549 F4C9 F238 E6AD C420 DA5C 4C2D</p>
<b>Fingerprint:</b> 1BD2 7192 7770 2549 F4C9 F238 E6AD C420 DA5C 4C2D
</div>
<br />
Storm Software is an open source software development organization and creator of Acidic, StormStack and StormCloud. Our mission is to make software development more accessible. Our ideal future is one where anyone can create software without years of prior development experience serving as a barrier to entry. We hope to achieve this via LLMs, Generative AI, and intuitive, high-level data modeling/programming languagues.
Storm Software is an open source software development organization and creator
of Acidic, StormStack and StormCloud.
If this sounds interesting, and you would like to help us in creating the next generation of development tools, please reach out on our website!
Our mission is to make software development more accessible. Our ideal future is
one where anyone can create software without years of prior development
experience serving as a barrier to entry. We hope to achieve this via LLMs,
Generative AI, and intuitive, high-level data modeling/programming languages.
<h3 align="center">💻 Visit <a href="https://stormsoftware.org" target="_blank">stormsoftware.org</a> to stay up to date with this developer</h3><br /><br />
Join us on [Discord](https://discord.gg/MQ6YVzakM5) to chat with the team,
receive release notifications, ask questions, and get involved.
If this sounds interesting, and you would like to help us in creating the next
generation of development tools, please reach out on our
[website](https://stormsoftware.com/contact) or join our
[Slack channel](https://join.slack.com/t/storm-software/shared_invite/zt-2gsmk04hs-i6yhK_r6urq0dkZYAwq2pA)!
<br />
<div align="center"><a href="https://stormsoftware.com" target="_blank"><img src="https://pub-761b436209f44a4d886487c917806c08.r2.dev/icon-fill.png" alt="Storm Software" width="200px"/></a></div>
<br />
<div align="center"><a href="https://stormsoftware.com" target="_blank"><img src="https://pub-761b436209f44a4d886487c917806c08.r2.dev/visit-us-text.svg" alt="Visit us at stormsoftware.com" height="90px"/></a></div>
<br />
<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
<br />
<br />
<!-- markdownlint-restore -->

@@ -197,0 +329,0 @@ <!-- prettier-ignore-end -->

dist/index.d.cts
dist/index.global.js
dist/index.js
dist/metafile-cjs.json
dist/metafile-esm.json
dist/metafile-iife.json
dist/index.cjs

Sorry, the diff of this file is not supported yet

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc