sidestore-source-types

Fully documented type defintions for SideStore's source format. Based on https://github.com/SideStore/SideStore-Docs/blob/main/references/sources.md.

Web docs are available at https://sidestore.io/sidestore-source-types.

Changelog is available at https://github.com/SideStore/sidestore-source-types/blob/main/CHANGELOG.md.

Usage in normal JSON

We have a JSON schema available at https://github.com/SideStore/sidestore-source-types/raw/main/schema.json.

You can use it like this for editor autocomplete and documentation:

{
    "$schema": "https://github.com/SideStore/sidestore-source-types/raw/main/schema.json",
    "name": "Your Source"
}

Usage in TypeScript

Installing

NPM: npm i -D sidestore-source-types

Yarn: yarn add -D sidestore-source-types

PNPM: pnpm i -D sidestore-source-types

Usage

You should be able to import the types like this:

import type { Source } from "sidestore-source-types";

Available imports:

• Source
• App
• News
• Version
• Permission, PermissionType

Usage Example

See test/index.ts