bin.js

#!/usr/bin/env node
import chalk from 'chalk'
import path from 'path'
import yArgs from 'yargs'
import fs from 'fs'
import { execSync } from 'child_process'

const yargs = yArgs(process.argv)
const __dirname = process.cwd()

const templates = {
	basic: {
		"$schema": {
			"js": [
				{
					"name": "states",
					"ext": "js",
					"type": "file",
					"content": "import { state, collection, computed } from \"@plexusjs/core\"\n// Importing the ChannelData type\n\n// Create a state instance\nexport const userData = state({\n\tname: \"\",\n\tage: -1,\n})\n\n// This collection is used to store the channels, the objects should be of type ChannelData defined above\nexport const channelsCollection = collection({\n\tprimaryKey: \"uuid\", // default value is \"id\"\n})"
				},
				{
					"name": "index",
					"ext": "js",
					"type": "file",
					"content": "// Import your module instances\nimport * as actions from \"./actions\"\nimport * as states from \"./states\"\nimport * as api from \"./api\"\n\n// Export your module instances from a single index.js file\nexport { actions, states, api }"
				},
				{
					"name": "api",
					"ext": "js",
					"type": "file",
					"content": "import { api } from \"@plexusjs/core\"\n\n// You can use the api to make requests to the server at a specific endpoint\nexport const channelBroker = api(\"https://api.example.com/channels\").auth(\"MyCoolAuthToken\", \"bearer\")"
				},
				{
					"name": "actions",
					"ext": "js",
					"type": "file",
					"content": "import { actions } from \"@plexusjs/core\"\n\n// Import your module instances\nimport { channelsCollection } from \"./states\"\nimport { channelBroker } from \"./api\"\n\n// This action is used to fetch the channels from the API\nexport const subscribeToChannel = actions(async ({ onCatch }) => {\n\tonCatch(console.error)\n\tconst { data } = await channelBroker.get(\"/get-channels\")\n\n\tchannelsCollection.collect(data)\n})"
				}
			],
			"ts": [
				{
					"name": "states",
					"ext": "ts",
					"type": "file",
					"content": "import { state, collection, computed } from \"@plexusjs/core\"\n// Importing the ChannelData type\nimport { ChannelData } from \"./types\"\n\n// Create a state instance\nexport const userData = state({\n\tname: \"\",\n\tage: -1,\n})\n\n// This collection is used to store the channels, the objects should be of type ChannelData defined above\nexport const channelsCollection = collection<ChannelData>({\n\tprimaryKey: \"uuid\", // default value is \"id\"\n})"
				},
				{
					"name": "index",
					"ext": "ts",
					"type": "file",
					"content": "// Import your module instances\nimport * as actions from \"./actions\"\nimport * as states from \"./states\"\nimport * as api from \"./api\"\n\n// Export your module instances from a single index.ts file\nexport { actions, states, api }"
				},
				{
					"name": "actions",
					"ext": "ts",
					"type": "file",
					"content": "import { actions } from \"@plexusjs/core\"\n\n// Import your module instances\nimport { channelsCollection } from \"./states\"\nimport { channelBroker } from \"./api\"\n\n// This action is used to fetch the channels from the API\nexport const subscribeToChannel = actions(async ({ onCatch }) => {\n\tonCatch(console.error)\n\tconst { data } = await channelBroker.get(\"/get-channels\")\n\n\tchannelsCollection.collect(data)\n})"
				},
				{
					"name": "api",
					"ext": "ts",
					"type": "file",
					"content": "import { api } from \"@plexusjs/core\"\n\n// You can use the api to make requests to the server at a specific endpoint\nexport const channelBroker = api(\"https://api.example.com/channels\").auth(\"MyCoolAuthToken\", \"bearer\")"
				},
				{
					"name": "types",
					"ext": "ts",
					"type": "file",
					"content": "export interface ChannelData {\n\tuuid: string\n\tname: string\n\tfollowers: number\n}"
				}
			]
		}
	},
	scalable: {
		"$schema": {
			"js": [
				{
					"name": "modules",
					"type": "dir",
					"content": [
						{
							"name": "user",
							"type": "dir",
							"content": [
								{
									"name": "states",
									"ext": "js",
									"type": "file",
									"content": "import { state, collection, computed } from \"@plexusjs/core\"\n\n// Create a state instance\nexport const userData = state({\n\tfirst_name: \"\",\n\tlast_name: \"\",\n\temail: \"\",\n\tuuid: \"\",\n\tstatus: \"offline\",\n})\n\n// This collection is used to store the channels, the objects should be of type ChannelData defined above\nexport const friends = collection({\n\tprimaryKey: \"uuid\", // default value is \"id\"\n})\n\t.createGroups([\"online\", \"offline\"])\n\t.createSelector(\"messaging\")"
								},
								{
									"name": "index",
									"ext": "js",
									"type": "file",
									"content": "// Import your module instances\nimport * as actions from \"./actions\"\nimport * as states from \"./states\"\nimport * as api from \"./api\"\n\n// Export your instances as a module\nexport const user = { actions, states, api }\n\nexport default user"
								},
								{
									"name": "api",
									"ext": "js",
									"type": "file",
									"content": "import { api } from \"@plexusjs/core\"\n\n// You can use the api to make requests to the server at a specific endpoint\nexport const userBroker = api(\"https://api.example.com/users\").auth(\"MySeCrEtToKeN\", \"bearer\")"
								},
								{
									"name": "actions",
									"ext": "js",
									"type": "file",
									"content": "import { action } from \"@plexusjs/core\"\n\n// Import your module's resources\nimport { friends, userData } from \"./states\"\nimport { userBroker } from \"./api\"\n\n// This action is used to message a friend. It takes in a user id and an optional message. We can take that and proccess\nexport const startMessageSession = action(async ({ onCatch }, uuid, message=\"\") => {\n\t// If any part of this action throws an error, it will be caught here\n\tonCatch(console.error)\n\n\t// Retrieve the full friend object from the collection\n\tconst friendToMessage = friends.getItemValue(uuid)\n\t\n\t// Call the api with a post request to send the message; the second param sent as a request body\n\tconst { data } = await userBroker.post(\"/message/send\", {\n\t\tto: friendToMessage.uuid,\n\t\tmessage,\n\t})\n\treturn data\n})\n\n// this action is used to populate the friends collection\nexport const getFriends = action(async ({ onCatch }) => {\n\t// If any part of this action throws an error, it will be caught here\n\tonCatch(console.error)\n\t// Call the api with a post request to send the message; the second param sent as a url query\n\tconst { data, status } = await userBroker.get(\"/friends/of\", {\n\t\tuuid: userData.value.uuid, // The uuid of the current user\n\t})\n\n\t// if the request was successful, we can add the friends to the collection\n\tif (status === 200) {\n\t\tfriends.collect(data.friends)\n\t}\n\t// if the request was not successful, we can handle the error\n\telse if (status > 200) {\n\t\tconsole.error(data)\n\t}\n})"
								}
							]
						}
					]
				},
				{
					"name": "index",
					"type": "file",
					"ext": "js",
					"content": "// Import your module instances\nimport { user } from \"./modules/user\"\n\n// Export your modules from a single index.ts file\nconst core = { user }\n\nexport default core"
				}
			],
			"ts": [
				{
					"name": "modules",
					"type": "dir",
					"content": [
						{
							"name": "user",
							"type": "dir",
							"content": [
								{
									"name": "states",
									"ext": "ts",
									"type": "file",
									"content": "import { state, collection, computed } from \"@plexusjs/core\"\nimport { UserData } from \"./types\"\n\n// Create a state instance\nexport const userData = state<UserData>({\n\tfirst_name: \"\",\n\tlast_name: \"\",\n\temail: \"\",\n\tuuid: \"\",\n\tstatus: \"offline\",\n})\n\n// This collection is used to store the channels, the objects should be of type ChannelData defined above\nexport const friends = collection<UserData>({\n\tprimaryKey: \"uuid\", // default value is \"id\"\n})\n\t.createGroups([\"online\", \"offline\"])\n\t.createSelector(\"messaging\")"
								},
								{
									"name": "index",
									"ext": "ts",
									"type": "file",
									"content": "// Import your module instances\nimport * as actions from \"./actions\"\nimport * as states from \"./states\"\nimport * as api from \"./api\"\n\n// Export your instances as a module\nexport const user = { actions, states, api }\n\nexport default user"
								},
								{
									"name": "actions",
									"ext": "ts",
									"type": "file",
									"content": "import { action } from \"@plexusjs/core\"\n\n// Import your module's resources\nimport { friends, userData } from \"./states\"\nimport { userBroker } from \"./api\"\n\nimport { RetrieveFriendsRes, SendMessageRes } from \"./types\"\n\n// This action is used to message a friend. It takes in a user id and an optional message. We can take that and proccess\nexport const startMessageSession = action(async ({ onCatch }, uuid: string, message?: string) => {\n\t// If any part of this action throws an error, it will be caught here\n\tonCatch(console.error)\n\n\t// Retrieve the full friend object from the collection\n\tconst friendToMessage = friends.getItemValue(uuid)\n\t\n\t// Call the api with a post request to send the message; the second param sent as a request body\n\tconst { data } = await userBroker.post<SendMessageRes>(\"/message/send\", {\n\t\tto: friendToMessage.uuid,\n\t\tmessage,\n\t})\n\treturn data\n})\n\n// this action is used to populate the friends collection\nexport const getFriends = action(async ({ onCatch }) => {\n\t// If any part of this action throws an error, it will be caught here\n\tonCatch(console.error)\n\t// Call the api with a post request to send the message; the second param sent as a url query\n\tconst { data, status } = await userBroker.get<RetrieveFriendsRes>(\"/friends/of\", {\n\t\tuuid: userData.value.uuid, // The uuid of the current user\n\t})\n\n\t// if the request was successful, we can add the friends to the collection\n\tif (status === 200) {\n\t\tfriends.collect(data.friends)\n\t}\n\t// if the request was not successful, we can handle the error\n\telse if (status > 200) {\n\t\tconsole.error(data)\n\t}\n})"
								},
								{
									"name": "api",
									"ext": "ts",
									"type": "file",
									"content": "import { api } from \"@plexusjs/core\"\n\n// You can use the api to make requests to the server at a specific endpoint\nexport const userBroker = api(\"https://api.example.com/users\").auth(\"MySeCrEtToKeN\", \"bearer\")"
								},
								{
									"name": "types",
									"ext": "ts",
									"type": "file",
									"content": "export interface UserData {\n\tuuid: string\n\tfirst_name: string\n\tlast_name: string\n\temail: string\n\tstatus: \"online\" | \"offline\"\n}\nexport type SendMessageRes = {\n\tsuccess: boolean\n\tmessage: string\n\tts: number\n}\n\nexport type RetrieveFriendsRes = {\n\tfriends: UserData[]\n}"
								}
							]
						}
					]
				},
				{
					"name": "index",
					"type": "file",
					"ext": "ts",
					"content": "// Import your module instances\nimport { user } from \"./modules/user\"\n\n// Export your modules from a single index.ts file\nconst core = { user }\n\nexport default core"
				}
			]
		}
	},
}

const helpString = `
	Usage:
		$ npx create-plexus-core <options>
	Options:
	    --skip-install			Skip the install of the PlexusJS packages
		--typescript			Create TypeScript files
		--react					Install the React package
		--next					Install the Next package
		--template=<template>	Choose the template to use to generate a PlexusJS core

`
function tryIt(fn) {
	try {
		if (fn instanceof Function) {
			const val = fn()
			if (val !== undefined && val !== null) {
				return val
			}
		}
		return true
	} catch (e) { return false }
}

const genFileOrDir = (arr, path = '/core') => {
	if (!Array.isArray(arr)) { return false }
	if (typeof path !== 'string') { return false }


	for (let obj of arr) {
		const fileName = `${obj.name}.${obj.ext || 'js'}`
		let filePath = `${path}/${fileName}`
		let status = 'writing...'
		// if we are creating a file
		if (obj.type === 'file') {

			process.stdout.write(`Creating ${chalk.cyan(`"${path}/${fileName}"`)}... ::`)
			tryIt(() => fs.writeFileSync(`${__dirname}${filePath}`, obj.content))
				? process.stdout.write(chalk.green(`Success!\n`))
				: process.stdout.write(chalk.yellow(`Failure!\n`))
		}
		// if we are creating a directory
		else if (obj.type === 'dir') {
			process.stdout.write(`Creating ${chalk.cyan(`"${path}/${obj.name}/"`)}... ::`)
			tryIt(() => fs.mkdirSync(`${__dirname}${path}/${obj.name}`))
				? process.stdout.write(chalk.green(`Success\n`))
				: process.stdout.write(chalk.yellow(`Failed\n`))
			// recurse into the directory
			genFileOrDir(obj.content, `${path}/${obj.name}`)
		}
	}
	return true
}

const installPlexus = () => {
	if (!yargs.argv["skip-install"]) {
		// initialize the prefix with npm install syntax 
		let prefix = 'npm install --save'
		// if we have a yarn.lock file, use yarn to install

		if (fs.existsSync(`${__dirname}/yarn.lock`)) {
			console.log(chalk.cyan.bgWhite(`Using Yarn Package Manager`))
			prefix = "yarn add"
		}
		else {
			console.log(chalk.cyan.bgWhite('Using NPM Package Manager'))
		}
		// install the packages
		tryIt(() => execSync(`${prefix} @plexusjs/core${yargs.argv.react ? ' @plexusjs/react' : yargs.argv.next ? ' @plexusjs/react @plexusjs/next' : ""}`, { stdio: 'inherit' }))
			? console.log(chalk.bgGreen.black('Plexus installed successfully'))
			: console.error(chalk.bgRed.black('Failed to install Plexus Packages'))
	}
	else {
		console.log('Skipping Install...')
	}
}
// make the core directory in the root folder
const lookForCore = () => tryIt(() => !fs.existsSync(`${__dirname} /core`) && !fs.mkdirSync(`${__dirname}/core`))

const genFiles = (template = 'basic') => {
	// check if the template string is one of the available templates
	if (![...Object.keys(templates)].includes(template)) {
		console.error(`Template ${template} not found.`)
		return false
	}
	// make the core directory in the root folder
	lookForCore()

	// copy the core files to the core directory
	// const structRaw = fs.readFileSync(`./data/${template}.json`, { encoding: 'utf8' })

	// const struct = JSON.parse(structRaw)
	const struct = templates[template]

	if (yargs.argv.typescript) {
		console.log(chalk.bgWhite.black('Creating TS Files...'))
		genFileOrDir(struct?.$schema?.ts, '/core')
	}
	else {
		console.log(chalk.bgWhite.black('Creating JS Files...'))
		genFileOrDir(struct?.$schema?.js, '/core')

	}
}

function run() {
	if (yargs.argv.help) {
		console.log(helpString)
		return
	}
	// parse the command line arguments
	if (yargs.argv.template) {
		// try installing the packages
		installPlexus()

		// generate the core files
		if (typeof yargs.argv.template === 'string' || yargs.argv.template === undefined) {
			try {
				switch (yargs.argv.template) {
					case 'scalable': {
						console.log('Using Scalable Template...')
						genFiles('scalable')
						break;
					}
					default: {
						console.log('Using Basic Template...')
						genFiles()
						break;
					}
				}
			}
			catch (e) {
				console.warn(e)
			}
		}
		else {
			console.warn('Invalid Template')
		}

	}
}

run()