@taqueria/protocol 0.2.1 → 0.4.0-rc1

package/Task.ts

@@ -0,0 +1,71 @@
+import * as Alias from '@taqueria/protocol/Alias';
+import createType, { Flatten } from '@taqueria/protocol/Base';
+import * as Command from '@taqueria/protocol/Command';
+import * as Option from '@taqueria/protocol/Option';
+import * as PositionalArg from '@taqueria/protocol/PositionalArg';
+import * as Verb from '@taqueria/protocol/Verb';
+import { z } from 'zod';
+
+const taskEncodingSchema = z.preprocess(
+	(val: unknown) => val ?? 'none',
+	z.union([
+		z.literal('json'),
+		z.literal('application/json'),
+		z.literal('none'),
+	])
+		.default('none')
+		.describe('Task Encoding')
+		.optional(),
+);
+
+const taskHandlerSchema = z.union([
+	z.literal('proxy'),
+	z.string().min(1),
+]);
+
+export const rawSchema = z.object({
+	task: Verb.rawSchema.describe('Task Name'),
+	command: Command.rawSchema.describe('Task Command'),
+	aliases: z.array(Alias.rawSchema).default([]).describe('Task Aliases').optional(),
+	description: z.string({ description: 'Task Description' }).min(3),
+	example: z.string({ description: 'Task Example' }).optional(),
+	hidden: z.boolean({ description: 'Task Is Hidden' }).default(false).optional(),
+	encoding: taskEncodingSchema.describe('Task Encoding'),
+	handler: taskHandlerSchema.describe('Task Handler'),
+	options: z.array(Option.rawSchema).default([]).describe('Task Options').optional(),
+	positionals: z.array(PositionalArg.rawSchema).default([]).describe('Task Positional Args').optional(),
+}).describe('Task');
+
+const internalSchema = z.object({
+	task: Verb.schemas.schema.describe('Task Name'),
+	command: Command.schemas.schema.describe('Task Command'),
+	aliases: z.array(Alias.rawSchema).default([]).describe('Task Aliases').optional(),
+	description: z.string({ description: 'Task Description' }).min(3),
+	example: z.string({ description: 'Task Example' }).optional(),
+	hidden: z.boolean({ description: 'Task Is Hidden' }).default(false).optional(),
+	encoding: taskEncodingSchema.describe('Task Encoding'),
+	handler: taskHandlerSchema.describe('Task Handler'),
+	options: z.preprocess(
+		val => val ?? [],
+		z.array(Option.schemas.schema).describe('Task Options').optional(),
+	),
+	positionals: z.array(PositionalArg.schemas.schema).default([]).describe('Task Positional Args').optional(),
+}).describe('Task');
+
+type RawInput = z.infer<typeof rawSchema>;
+type Input = z.infer<typeof internalSchema>;
+
+export const { schemas: generatedSchemas, factory } = createType<RawInput, Input>({
+	rawSchema,
+	internalSchema,
+	parseErrMsg: (value: unknown) => `The following task is invalid: ${value}`,
+	unknownErrMsg: 'Something went wrong trying to parse the task',
+});
+
+export type Task = z.infer<typeof generatedSchemas.schema>;
+export type t = Task;
+export const { create, make, of } = factory;
+export const schemas = {
+	...generatedSchemas,
+	schema: generatedSchemas.schema.transform(val => val as unknown as Task),
+};

package/Timestamp.ts

@@ -0,0 +1,25 @@
+import createType from '@taqueria/protocol/Base';
+import { z } from 'zod';
+
+export const rawSchema = z
+	.number({ description: 'Timestamp' })
+	.min(1651846877);
+
+type Input = z.infer<typeof rawSchema>;
+
+export const { factory, schemas: generatedSchemas } = createType<Input, Input>({
+	isStringLike: true,
+	rawSchema,
+	parseErrMsg: (value: unknown) => `${value} is an invalid timestamp`,
+	unknownErrMsg: `Something went wrong trying to parse a timestamp`,
+});
+
+export type Timestamp = z.infer<typeof generatedSchemas.schema>;
+export type t = Timestamp;
+export const { create, make, of } = factory;
+export const schemas = {
+	...generatedSchemas,
+	schema: generatedSchemas.schema.transform(val => val as Timestamp),
+};
+
+export const now = () => Date.now() as Timestamp;

package/Tz.ts

@@ -0,0 +1,22 @@
+import createType from '@taqueria/protocol/Base';
+import { z } from 'zod';
+
+export const rawSchema = z.string({ description: 'Tz' }).min(1).regex(/^\d([\d_]+\d)?$/);
+
+type RawInput = z.infer<typeof rawSchema>;
+
+export const { schemas: generatedSchemas, factory } = createType<RawInput, RawInput>({
+	isStringLike: true,
+	rawSchema,
+	parseErrMsg: (value: unknown) => `${value} is an invalid Tz amount`,
+	unknownErrMsg: 'Something went wrong when parsing the Tz amount',
+});
+
+export type Tz = z.infer<typeof generatedSchemas.schema>;
+
+export const { create, of, make } = factory;
+
+export const schemas = {
+	...generatedSchemas,
+	schema: generatedSchemas.schema.transform(val => val as Tz),
+};

package/Url.ts

@@ -0,0 +1,28 @@
+import createType from '@taqueria/protocol/Base';
+import { z } from 'zod';
+
+export const rawSchema = z
+	.string({ description: 'Url' })
+	.url();
+
+type RawInput = z.infer<typeof rawSchema>;
+
+export const { schemas: generatedSchemas, factory } = createType<RawInput, RawInput>({
+	rawSchema,
+	isStringLike: true,
+	parseErrMsg: (value: unknown) => `${value} is an invalid url`,
+	unknownErrMsg: 'Something went wrong trying to parse the url',
+});
+
+export const toComponents = (url: Url) => {
+	const parts = new URL(url.toString());
+	return parts;
+};
+
+export type Url = z.infer<typeof generatedSchemas.schema>;
+export type t = Url;
+export const { create, of, make } = factory;
+export const schemas = {
+	...generatedSchemas,
+	schema: generatedSchemas.schema.transform(val => val as Url),
+};

package/Verb.ts

@@ -0,0 +1,23 @@
+import createType from '@taqueria/protocol/Base';
+import { z } from 'zod';
+
+export const rawSchema = z
+	.string({ description: 'Verb' })
+	.min(1, 'Must be a valid verb')
+	.regex(/^[A-Za-z\-\ ]+/, 'Must be a valid verb');
+
+type Input = z.infer<typeof rawSchema>;
+
+export const { factory, schemas: generatedSchemas } = createType<Input, Input>({
+	isStringLike: true,
+	rawSchema,
+	parseErrMsg: (value: unknown) => `${value} is not an invalid verb`,
+	unknownErrMsg: `Something went wrong trying to parse a verb`,
+});
+export type Verb = z.infer<typeof generatedSchemas.schema>;
+export type t = Verb;
+export const { create, make, of } = factory;
+export const schemas = {
+	...generatedSchemas,
+	schema: generatedSchemas.schema.transform(val => val as Verb),
+};

package/VersionNumber.ts

@@ -0,0 +1,23 @@
+import createType from '@taqueria/protocol/Base';
+import { z } from 'zod';
+
+export const rawSchema = z.string({ description: 'Version Number' })
+	.min(1)
+	.regex(/^\d+\.\d+(\.\d+)*$/);
+
+type RawInput = z.infer<typeof rawSchema>;
+
+const { schemas: generatedSchemas, factory } = createType<RawInput, RawInput>({
+	isStringLike: true,
+	rawSchema,
+	parseErrMsg: (value: unknown) => `${value} is an invalid version number`,
+	unknownErrMsg: 'Something went wrong trying to parse the version number',
+});
+
+export type VersionNumber = z.infer<typeof generatedSchemas.schema>;
+export type t = VersionNumber;
+export const { create, of, make } = factory;
+export const schemas = {
+	...generatedSchemas,
+	schema: generatedSchemas.schema.transform(val => val as VersionNumber),
+};

package/i18n.ts

@@ -0,0 +1,63 @@
+import i18next from 'i18next';
+
+export interface i18n {
+	__: (...args: unknown[]) => string;
+}
+
+export type t = i18n;
+
+export default async (): Promise<i18n> => {
+	// TODO: i18next is feature-rich, but rather large. Determine whether you need all of the functionality
+	const i18n = {
+		...await i18next.init({
+			lng: 'en',
+			debug: false,
+			resources: {
+				// TODO: Move to separate language files
+				en: {
+					translation: {
+						'appName': 'Taqueria',
+						'appDesc': 'Taqueria is an integrated environment for compiling, testing, and deploying Tezos software.',
+						'versionDesc': 'Display the version number of the Taqueria program',
+						'betaWarning': "Taqueria is currently in BETA. You've been warned. :)",
+						'configDirDesc': 'Config directory (default ./.taq)',
+						'initDesc': 'Initialize a new project',
+						'initPathDesc': 'Path to your project directory',
+						'scaffoldDesc': 'Generate a new project using pre-made scaffold',
+						'scaffoldUrlDesc': 'Alias or Url for the scaffold project',
+						'scaffoldProjectDirDesc': 'Path where to create the new project. This must be a new directory.',
+						'scaffoldDoneMsg': 'The project was created using the scaffold.',
+						'installDesc': 'Install a plugin',
+						'pluginInstalled': 'Plugin installed successfully',
+						'pluginUninstalled': 'Plugin uninstalled successfully',
+						'uninstallDesc': 'Uninstall a plugin',
+						'pluginNameDesc': 'The name of the plugin',
+						'promptForTask':
+							"Please specify which task you would like to execute. If you're starting a new project, please run 'init'.\n",
+						'pluginKindDesc': 'Kind of plugin (NPM, Binary)',
+						'pluginAlreadyInstalled': 'That plugin is already installed.',
+						'pluginOptionDesc': 'Use the task from this plugin',
+						'bootstrapMsg': "Project taq'ified!",
+						'maxConcurrencyDesc': 'Set the maximum concurrency limit used internally',
+						'providedByMany': 'Provided by more than one plugin. The option --plugin is required.',
+						'pluginDesc':
+							'Specify what plugin should execute this command. Use this when more than one plugin provide a task of the same name.',
+						'listNetworks': 'List known networks',
+						'envDesc': 'Specify an environment configuration',
+						'disableStateDesc': 'Does not use the saved state.json file. State is computed for each execution.',
+						'logPluginCallsDesc': 'Logs any execution calls to a plugin to the console',
+						'npmInitRequired': "This project isn't a valid NPM project. Please run: npm init",
+						'testFromVsCode': 'An internal command used by VS Code to test for the taq binary',
+						'fromVsCode': 'An internal flag used to indicate that taq is executed via vscode',
+						'buildDesc': 'Display build information about the current version',
+						'pluginOption': "Use to specify what plugin you'd like when running this task.",
+						'yesOptionDesc': 'Select "yes" to any prompt',
+					},
+				},
+			},
+		}),
+		__: i18next.t,
+	};
+
+	return i18n;
+};

package/package.json

@@ -1,34 +1,41 @@
 {
-  "name": "@taqueria/protocol",
-  "version": "0.2.1",
-  "description": "A TypeScript package which contains types that are to be shared between @taqueria/node-sdk and @taqueria/taqueria.",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "echo 'Nothing to build.' && exit 0 "
-  },
-  "keywords": [
-    "taqueria",
-    "tezos",
-    "build",
-    "test",
-    "deploy",
-    "ecad",
-    "ecadlabs",
-    "protocol"
-  ],
-  "author": "ECAD Labs",
-  "license": "Apache-2.0",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/ecadlabs/taqueria.git",
-    "directory": "taqueria-protocol"
-  },
-  "bugs": {
-    "url": "https://github.com/ecadlabs/taqueria/issues"
-  },
-  "homepage": "https://github.com/ecadlabs/taqueria#readme",
-  "devDependencies": {
-    "typescript": "4.5.4"
-  }
+	"name": "@taqueria/protocol",
+	"version": "0.4.0-rc1",
+	"description": "A TypeScript package which contains types that are to be shared between @taqueria/node-sdk and @taqueria/taqueria.",
+	"main": "index.js",
+	"scripts": {
+		"test": "echo \"Error: no test specified\" && exit 1",
+		"build": "echo 'Nothing to build.' && exit 0 "
+	},
+	"keywords": [
+		"taqueria",
+		"tezos",
+		"build",
+		"test",
+		"deploy",
+		"ecad",
+		"ecadlabs",
+		"protocol"
+	],
+	"author": "ECAD Labs",
+	"license": "Apache-2.0",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/ecadlabs/taqueria.git",
+		"directory": "taqueria-protocol"
+	},
+	"bugs": {
+		"url": "https://github.com/ecadlabs/taqueria/issues"
+	},
+	"homepage": "https://github.com/ecadlabs/taqueria#readme",
+	"devDependencies": {
+		"typescript": "^4.7.2"
+	},
+	"dependencies": {
+		"@peculiar/webcrypto": "^1.4.0",
+		"batching-toposort": "^1.2.0",
+		"fluture": "^14.0.0",
+		"remeda": "^0.0.34",
+		"zod": "^3.17.3"
+	}
 }