kozz-module-maker 0.1.1 → 0.1.3

package/src/Socket/Events/Emit/RevokeProxy.ts

@@ -1,15 +0,0 @@
-import { ProxyRevokePayload, Source } from 'kozz-types';
-import { Socket } from 'socket.io-client';
-
-/**
- * Request the revoking of a proxy
- * @param socket
- * @param source
- */
-export const revokeProxy = (socket: Socket, source: Source) => {
-	const payload: ProxyRevokePayload = {
-		source: source,
-	};
-
-	socket.emit('revoke_proxy', payload);
-};

package/src/Socket/Events/Handle/AskResource.ts

@@ -1,37 +0,0 @@
-import { Socket } from 'socket.io-client';
-import { ResourceMap } from '../../../Instance/Common/ResourceMap';
-import { AskResourcePayload, ProvideResourcePayload } from 'kozz-types/dist';
-
-/**
- * Provide the resource asked
- * @param socket
- * @param resourceMap
- */
-export const onAskResource = (socket: Socket, resourceMap: ResourceMap) => {
-	socket.on('ask_resource', (payload: AskResourcePayload) => {
-		const resourceGetter = resourceMap[payload.request.resource];
-		if (!resourceGetter)
-			return socket.emit('reply_resource', {
-				...payload,
-			});
-
-		promisify(resourceGetter(payload.request.data)).then(resource => {
-			const responsePayload: ProvideResourcePayload = {
-				...payload,
-				response: resource,
-			};
-
-			socket.emit('reply_resource', responsePayload);
-		});
-	});
-};
-
-const promisify = (resource: unknown) => {
-	return new Promise(resolve => {
-		if (resource instanceof Promise) {
-			resource.then(resp => resolve(resp));
-		} else {
-			resolve(resource);
-		}
-	});
-};

package/src/Socket/Events/Handle/Command.ts

@@ -1,68 +0,0 @@
-import { Socket } from 'socket.io-client';
-import { Command } from 'kozz-types';
-import { Method } from '../../..';
-import { createMessageObject } from '../../../Message';
-import { isArgsObjectValid } from '../../../Validator';
-import { normalizeString, runUse } from '../../../util';
-import { UseFn } from 'src/Instance/Common';
-
-/**
- * Handles the command received. It will check if the boundary should have it's command handled,
- * find the correct method, parse, typecheck the args, run the middlewares and try to run the method
- * @param socket
- * @param methods
- * @param moduleUseFns
- * @param handlerName
- * @param templatePath
- * @param boundariesToHandle
- */
-export const onCommand = <
-	T extends Record<string, Method<Record<string, any>>>
->(
-	socket: Socket,
-	methods: T,
-	moduleUseFns: UseFn[],
-	handlerName: string,
-	templatePath: string,
-	boundariesToHandle: string[]
-) => {
-	socket.on('command', (command: Command) => {
-		// If the handler doesnt want to handle commands for the provided boundary
-		if (
-			!boundariesToHandle.includes(command.boundaryName) &&
-			!boundariesToHandle.includes('*')
-		) {
-			return;
-		}
-
-		const actualMethod =
-			methods[normalizeString(normalizeString(command.method))] ||
-			methods['fallback'];
-		if (!actualMethod) return;
-
-		if (isArgsObjectValid(command.namedArgs || {}, actualMethod.args)) {
-			const updatedCommand = runUse(moduleUseFns, command);
-
-			const message = createMessageObject(
-				socket,
-				command.message,
-				handlerName,
-				templatePath
-			);
-
-			socket.emit('react_message', {
-				messageId: command.message.id,
-				boundaryId: command.boundaryId,
-				emote: '✔',
-			});
-
-			actualMethod.func(message, updatedCommand.namedArgs || {});
-		} else {
-			socket.emit('react_message', {
-				messageId: command.message.id,
-				boundaryId: command.boundaryId,
-				emote: '❌',
-			});
-		}
-	});
-};

package/src/Socket/Events/Handle/ProxiedMessage.ts

@@ -1,28 +0,0 @@
-import { Source } from 'kozz-types';
-import { Socket } from 'socket.io-client';
-import {
-	ProxiedMessageObject,
-	createProxiedMessageOject,
-} from 'src/Message/ProxiedMessage';
-
-/**
- * Handles the message proxied to the handler
- * @param socket
- * @param source
- * @param cb
- */
-export const onProxiedMessage = (
-	socket: Socket,
-	source: Source,
-	cb: (message: ProxiedMessageObject) => any
-) => {
-	socket.on('proxied_message', payload => {
-		const proxiedMessageObject = createProxiedMessageOject(
-			socket,
-			source,
-			payload,
-			source.split('/')[0]
-		);
-		cb(proxiedMessageObject);
-	});
-};

package/src/Socket/index.ts

@@ -1,40 +0,0 @@
-import { io } from 'socket.io-client';
-import { introduce } from './Events/Emit/Introduction';
-import { Method } from '../Schema';
-import { UseFn } from '../Instance/Common';
-import { onCommand } from './Events/Handle/Command';
-
-export const connect = <T extends Record<string, any>>(
-	address: string,
-	moduleUseFns: UseFn[],
-	templatePath: string,
-	handlerName: string,
-	methods: T,
-	boundariesToHandle: string[],
-	signature?: string
-) => {
-	const socket = io(address);
-
-	socket.on('connect', () => {
-		introduce(socket, handlerName, methods, signature);
-	});
-
-	const registerMethods = <
-		T extends Record<string, Method<Record<string, any>>>
-	>(
-		methods: T
-	) =>
-		onCommand(
-			socket,
-			methods,
-			moduleUseFns,
-			handlerName,
-			templatePath,
-			boundariesToHandle
-		);
-
-	return {
-		socket,
-		registerMethods,
-	};
-};

package/src/Validator/index.ts

@@ -1,81 +0,0 @@
-import {
-	ArrayTypeString,
-	OptionalTypeString,
-	PrimaryTypeString,
-	TypeString,
-} from '../Schema';
-
-type TypeDescriptor<T extends TypeString> = {
-	array: T extends ArrayTypeString ? true : false;
-	optional: T extends OptionalTypeString ? true : false;
-	type: T extends PrimaryTypeString
-		? T
-		: T extends `${infer Type}[]?`
-		? Type
-		: T extends `${infer Type}?`
-		? Type
-		: T extends `${infer Type}[]`
-		? Type
-		: never;
-};
-
-const typeIsArray = (type: TypeString): type is ArrayTypeString => {
-	return type.includes('[]');
-};
-
-const typeIsOptional = (type: TypeString): type is OptionalTypeString => {
-	return type.includes('?');
-};
-
-const toPrimitiveType = (type: TypeString): PrimaryTypeString => {
-	if (type.includes('boolean')) {
-		return 'boolean';
-	}
-	if (type.includes('number')) {
-		return 'number';
-	}
-	return 'string';
-};
-
-export const describeType = <Type extends TypeString>(type: Type) =>
-	({
-		array: typeIsArray(type),
-		optional: typeIsOptional(type),
-		type: toPrimitiveType(type),
-	} as TypeDescriptor<Type>);
-
-export const isArgValid = <Type extends TypeString>(
-	arg: unknown,
-	typeDescriptor: TypeDescriptor<Type>
-) => {
-	if (arg === undefined && typeDescriptor.optional) {
-		return true;
-	}
-	if (Array.isArray(arg) !== typeDescriptor.array) {
-		return false;
-	}
-	if (Array.isArray(arg) && typeDescriptor.array && arg.length === 0) {
-		return true;
-	}
-	if (Array.isArray(arg) && typeDescriptor.array && arg.length > 0) {
-		return arg.reduce((valid, arg) => {
-			return valid && typeof arg === typeDescriptor.type;
-		}, true);
-	}
-	return typeof arg === typeDescriptor.type;
-};
-
-/**
- * Check ifm the arguments of a provided command are valid
- * @param args
- * @param descriptionMap
- * @returns
- */
-export const isArgsObjectValid = <Type extends TypeString>(
-	args: Record<string, unknown>,
-	descriptionMap: Record<string, Type> = {}
-) => {
-	return Object.entries(descriptionMap).reduce((valid, [argName, argType]) => {
-		return valid && isArgValid(args[argName], describeType(argType));
-	}, true);
-};

package/src/messages.kozz.md

@@ -1,52 +0,0 @@
-> @foo
-
-# This is the foo message
-
-The foo message says "Hi" to {{name}}
-
-_Nice to meet you!_
-
-> ---
-
-> @bar
-
-# This is the bar message
-
-The foo message says "GoodBye" to {{name}}
-
-_See you soon!_
-
-> ---
-
-> @list
-
-# This is the header. It can't interpolate variables.
-
-# This is a list. The items can't interpolate variables or styles yet.
-
-- item 1
-- item 2
-- item 3
-  <br>
-
-# This is a table:
-
-`| Command       | Bot's Response                   |`
-`| ------------- | -------------------------------- |`
-`| !ping         | pong!                            |`
-`| !ping default | pong!                            |`
-`| !ping blah    | Ooops, this method doesn't exist |`
-<br>
-
-_Note:_ Be careful not to make wide tables, most chat's will automatically break lines that become too long.
-<br>
-
-Text _*bold*_ _italic_ and `monospace` can appear in the same line, but you can't mix and match them
-In order to skip a line, use a line with nothing but `"<br>"`
-<br>
-<br>
-<br>
-
-Messages start with `"> @messageName"` and end with `"> ---"`
-
-> ---

package/src/util/index.ts

@@ -1,89 +0,0 @@
-import { Command } from 'kozz-types';
-import { UseFn } from '../Instance/Common';
-import fs from 'fs/promises';
-import crypto from 'crypto';
-
-let privateKey: string | undefined;
-
-export const runUse = (useArr: UseFn[], args: Command) => {
-	return useArr.reduce((res, fn) => {
-		return fn(res);
-	}, args);
-};
-
-export function normalizeString(string: string) {
-	return string.normalize('NFD').replace(/[\u0300-\u036f]/g, '');
-}
-
-export const randomId = () => crypto.randomUUID();
-
-export const signPayload = <T extends Record<string, any>>(
-	payload: T,
-	signature?: string
-) => {
-	if (signature) {
-		return {
-			...payload,
-			signature,
-		};
-	}
-	try {
-		return signInNodeEnvironment(payload);
-	} catch (e) {
-		throw 'Please generate a keypair using the script "scripts/generate_key_pair.sh" and copy the publickey to the  "${projetc_root}/keys/privatekey.pem". Leve the key names as it is';
-	}
-};
-
-/**
- * Useful for when you need to authenticate in the web. Still didn't managed to make it work
- * @param payload
- * @returns
- */
-export const signInBrowser = <T extends Record<string, any>>(payload: T) => {
-	try {
-		// @ts-ignore
-		return fetch('./keys/privatekey.pem')
-			.then((privateKey: any) => privateKey.text())
-			.then((privateKey: string) => {
-				const signature = crypto.sign(
-					'sha256',
-					Buffer.from(JSON.stringify(payload, undefined, '  ')),
-					{ key: privateKey, padding: crypto.constants.RSA_PKCS1_PSS_PADDING }
-				);
-
-				return {
-					...payload,
-					signature,
-				};
-			});
-	} catch (e) {
-		throw 'Please generate a keypair using the script "scripts/generate_key_pair.sh" and copy the publickey to the  "${projetc_root}/keys/privatekey.pem". Leve the key names as it is';
-	}
-};
-/**
- * Sign any payload using fs to retrieve the key
- * @param payload
- * @returns
- */
-export const signInNodeEnvironment = async <T extends Record<string, any>>(
-	payload: T
-) => {
-	try {
-		privateKey = await fs.readFile('./keys/privatekey.pem', {
-			encoding: 'utf-8',
-		});
-	} catch (e) {
-		throw 'Please generate a keypair using the script "scripts/generate_key_pair.sh" and copy the publickey to the  "${project_root}/keys/privatekey.pem". Leve the key names as it is';
-	}
-
-	const signature = crypto.sign(
-		'sha256',
-		Buffer.from(JSON.stringify(payload, undefined, '  ')),
-		{ key: privateKey, padding: crypto.constants.RSA_PKCS1_PSS_PADDING }
-	);
-
-	return {
-		...payload,
-		signature,
-	};
-};