{"id":22080043,"url":"https://github.com/superfaceai/parser","last_synced_at":"2025-10-08T18:44:29.339Z","repository":{"id":38197562,"uuid":"264876208","full_name":"superfaceai/parser","owner":"superfaceai","description":"Superface profile and map format parser","archived":false,"fork":false,"pushed_at":"2023-07-19T02:19:00.000Z","size":2211,"stargazers_count":11,"open_issues_count":3,"forks_count":2,"subscribers_count":8,"default_branch":"main","last_synced_at":"2024-11-11T01:57:04.434Z","etag":null,"topics":["api","integration","javascript","parser","parsing","typescript"],"latest_commit_sha":null,"homepage":"https://superface.ai","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/superfaceai.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-05-18T08:27:46.000Z","updated_at":"2024-05-31T16:32:35.000Z","dependencies_parsed_at":"2024-06-18T22:43:03.776Z","dependency_job_id":"2564c525-1e6b-4527-988f-c6b26137f9b3","html_url":"https://github.com/superfaceai/parser","commit_stats":{"total_commits":514,"total_committers":15,"mean_commits":"34.266666666666666","dds":0.7042801556420233,"last_synced_commit":"e59b0feaa344408d75accb11ba268434526c62b7"},"previous_names":[],"tags_count":70,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/superfaceai%2Fparser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/superfaceai%2Fparser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/superfaceai%2Fparser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/superfaceai%2Fparser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/superfaceai","download_url":"https://codeload.github.com/superfaceai/parser/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227448649,"owners_count":17777325,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","integration","javascript","parser","parsing","typescript"],"created_at":"2024-11-30T23:12:02.025Z","updated_at":"2025-10-08T18:44:29.215Z","avatar_url":"https://github.com/superfaceai.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Parser\n\n[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/superfaceai/parser/main.yml)](https://github.com/superfaceai/parser/actions/workflows/main.yml)\n![NPM](https://img.shields.io/npm/v/@superfaceai/parser)\n[![NPM](https://img.shields.io/npm/l/@superfaceai/parser)](LICENSE)\n![TypeScript](https://img.shields.io/badge/%3C%2F%3E-Typescript-blue)\n\n\u003cimg src=\"https://github.com/superfaceai/parser/blob/main/docs/LogoGreen.png\" alt=\"superface logo\" width=\"150\" height=\"150\"\u003e\n\nSuperface Parser compiles Superface profiles and maps into representation that can be interpreter using the Superface SDK.\n\n## Table of Contents\n\n- [Background](#background)\n- [Install](#install)\n- [Usage](#usage)\n- [Security](#security)\n- [Support](#support)\n- [Development](#development)\n- [Maintainers](#maintainers)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Background\n\nSuperface (super-interface) is a higher-order API, an abstraction on top of the modern APIs like GraphQL and REST. Superface is one interface to discover, connect, and query any capabilities available via conventional APIs. \n\nThrough its focus on application-level semantics, Superface decouples the clients from servers, enabling fully autonomous evolution. As such it minimizes the code base as well as errors and downtimes while providing unmatched resiliency and redundancy. \n\nSuperface allows for switching capability providers without development at a runtime in milliseconds. Furthermore, Superface decentralizes the composition and aggregation, and thus creates an Autonomous Integration Mesh.\n\nMotivation behind Superface is nicely described in this [video](https://www.youtube.com/watch?v=BCvq3NXFb94) from APIdays conference.\n\nYou can get more information at https://superface.ai and https://superface.ai/docs.\n \n## Install\n\nInstall the parser into one of your projects:\n\n```shell\nyarn add @superfaceai/parser\n```\n\n## Usage\n\n```ts\nconst { basename } = require('path');\nconst { readFileSync } = require('fs');\nconst { inspect } = require('util');\nconst { Source, parseProfile } = require('@superfaceai/parser');\n\nconst path = process.argv[2];\nconst content = readFileSync(path, 'utf-8');\nconst source = new Source(content, basename(path));\nconst result = parseProfile(source);\n\nconsole.log(inspect(result));\n```\n\n## Security\n\nSuperface is not man-in-the-middle so it does not require any access to secrets that are needed to communicate with provider API. Superface CLI only prepares super.json file with authorization fields in form of environment variable. You just set correct variables and communicate directly with provider API.\n\nYou can find more information in [SDK repository](https://github.com/superfaceai/one-sdk-js/blob/main/SECURITY.md).\n\n## Support\n\nIf you need any additional support, have any questions or you just want to talk you can do that through our [documentation page](https://docs.superface.ai). \n\n## Development\n\nWhen developing, start with cloning the repository using `git clone https://github.com/superfaceai/parser.git` (or `git clone git@github.com:superfaceai/parser.git` if you have repository access).\n\nAfter cloning, the dependencies must be downloaded using `yarn install` or `npm install`.\n\nNow the repository is ready for code changes.\n\nThe `package.json` also contains scripts (runnable by calling `yarn \u003cscript-name\u003e` or `npm run \u003cscript-name\u003e`):\n- `test` - run all tests\n- `lint` - lint the code (use `lint:fix` to run autofix)\n- `format` - check the code formatting (use `format:fix` to autoformat)\n- `prepush` - run `test`, `lint` and `format` checks. This should run without errors before you push anything to git.\n\nLastly, to build a local artifact run `yarn build` or `npm run build`.\n\n## Maintainers\n\n- [@Lukáš Valenta](https://github.com/lukas-valenta)\n- [@Edward](https://github.com/TheEdward162)\n\n## Contributing\n\n**Please open an issue first if you want to make larger changes**\n\nFeel free to contribute! Please follow the [Contribution Guide](CONTRIBUTION_GUIDE.md).\n\n## Licensing\n\nLicenses of `node_modules` are checked during push CI/CD for every commit. Only the following licenses are allowed:\n\n- 0BDS\n- MIT\n- Apache-2.0\n- ISC\n- BSD-3-Clause\n- BSD-2-Clause\n- CC-BY-4.0\n- CC-BY-3.0;BSD\n- CC0-1.0\n- Unlicense\n\nNote: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.\n\n## License\n\nThe Superface Parser is licensed under the [MIT](LICENSE).\n© 2021 Superface\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuperfaceai%2Fparser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsuperfaceai%2Fparser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuperfaceai%2Fparser/lists"}