@onlang-org/onst-schemastore
v1.2.2
Published
Standalone package designed as helper for on-lang. Fetches catalog from SchemStore (www.schemastore.org) and categorises it into different entities based on similarity.
Downloads
34
Maintainers
Readme
@onlang-org/onst-schemastore extension for onst
Built for ONLang
A utility library bundled with superfast CLI for categorizing SchemaStore catalog into entities and list them. The catalog is broken into different entities based on similarity using Levenshtein Distance and Spelling Distance. This is achieved by using the fastest-levenshtein package.
The objective is to provide schema from many systems on the fly for ONLang and osnt
Table of Contents
Installation
npm install -g @onlang-org/onst-schemastore
Usage
Fetch Schema From SchemaStore
const { fetchSchemaFromSchemaStore } = require('@onlang-org/onst-schemastore');
async function exampleUsage() {
try {
const result = await fetchSchemaFromSchemaStore();
console.log(`${answer} has ${result.schema.length} ${result.schema.length === 1 ? 'schema' : 'schemata'}.`);
result.schema.forEach(schema => {
console.log(`- ${schema.name} - ${schema.url}`);
})
} catch (error) {
console.error(`Error fetching schema for ${schemaName}:`, error.message);
}
}
exampleUsage();
Search Schema
const filteredEntities = await findSchema(input, categorizedSchemas)
return filteredEntities.map(schema => {
return {
value: schema,
description: `${schema} selected`
}
})
CLI usage
> onst-ss
> ? Which entity would you want to download? AWS
> AWS has 4 schemata.
- AWS CDK cdk.json - https://json.schemastore.org/cdk.json
- AWS CloudFormation - https://raw.githubusercontent.com/awslabs/goformation/master/schema/cloudformation.schema.json
- AWS CloudFormation Serverless Application Model (SAM) - https://raw.githubusercontent.com/aws/serverless-application-model/main/samtranslator/schema/schema.json
- AWS SAM CLI Samconfig - https://raw.githubusercontent.com/aws/aws-sam-cli/master/schema/samcli.json
License
Copyright (c) 2024 ONLang.org https://github.com/onlang-org (rajatasusual https://github.com/rajatasusual) Read more about the license.
Contributing
Thank you for considering contributing to @onlang-org/onst-schemastore! Your contributions help improve the functionality and usability of this tool. For more details, please refer to CONTRIBUTING.md.