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

@gradiant/xapi-dsl

v1.18.1

Published

Gradiant XAPI constants for xAPI

Downloads

154

Readme

npm version code style: prettier Conventional Commits

Gradiant xAPI DSL

Set of types for easily building xAPI statements.

Overview

This package contains a set of typescript definitions types to work with xAPI statements.

  • Actor
  • Attachment
  • Context
  • Object
  • Result
  • Statement
  • Verb

It also includes some external xAPI vocabulary terms (e.g. verbs, activities and extension identifiers) to be used in a centralized way. Some of the xAPI vocabularies considered here are:

DSL

You can consult the entire DSL at the dsl-definition.json

Getting started

The module exports in the index all the types needed by the xapi as well as the dsl as a nested object

// xapi interfaces...
import { Statement } from '@gradiant/xapi-dsl';

// dsl nested object
import { dsl } from '@gradiant/xapi-dsl';

const statement: Statement = jsonStatement as Statement;

if (statement.verb.id === dsl.activityTypes.smart.essay) {
  // essay activity type URI
  console.log('Smart essay activity');
}

Also, DSL constants can be imported individually from the dsl folder

import { activityTypes, verbs, contextExtensions /* ... */ } from '@gradiant/xapi-dsl/dsl';

Scripts

npm run build

Build the TypeScript files under de src folder into the root folder. It will generate the dsl folder and the types folder. These two folder are auto generated and therefore should not be edited directly.

npm run clean

Remove the following generated directories/files

  • dsl
  • types
  • index.js
  • index.d.ts
  • index.d.ts.map

npm run lint

Run tslint and prettier applying the available fixes

npm run dsl:print

It generates a new version of dsl-definition.json file. This file must be updated to release a new version.