Skip to content

Built for people who want to own their automations. Join the waitlist for an invite.

Package listing

@kody/sessionize

src/index.ts

30 lines · 1.3 KB · TypeScript
import { SESSIONIZE_DEMO_ENDPOINT_ID, SESSIONIZE_VIEWS } from './types.ts'

/**
 * Describe the Sessionize helpers package and its documented export surface.
 *
 * @example
 * import describeSessionize from 'kody:@kody/sessionize'
 * const info = describeSessionize()
 * // => { name: '@kody/sessionize', demoEndpointId: 'jl4ktls0', exports: [...] }
 */
export default function describeSessionize() {
	return {
		name: '@kody/sessionize',
		description:
			'Read Sessionize sessions, speakers, and schedules from an event public JSON API.',
		docs: 'https://sessionize.com/playbook/api',
		demoEndpointId: SESSIONIZE_DEMO_ENDPOINT_ID,
		views: SESSIONIZE_VIEWS,
		exports: [
			{ subpath: './get-event', purpose: 'Joined event: rooms, sessions, speakers' },
			{ subpath: './list-sessions', purpose: 'Flattened sessions with names' },
			{ subpath: './list-speakers', purpose: 'Speakers with session titles' },
			{ subpath: './get-schedule', purpose: 'Schedule grid as days and slots' },
			{ subpath: './find-session', purpose: 'Lookup a session by id or title' },
			{ subpath: './find-speaker', purpose: 'Lookup a speaker by id or name' },
			{ subpath: './request', purpose: 'Raw All/Sessions/Speakers/GridSmart view' },
			{ subpath: './smoke-test', purpose: 'Live read against an endpoint' },
		],
	}
}