@taqueria/protocol 0.0.8 → 0.1.2

package/README.md

@@ -1,7 +1,7 @@
-# README
+# Taqueria Protocol
 
-Provides a shared collection of TypeScript types used in Taqueria.
+Provides a shared collection of TypeScript types used in Taqueria
 
-This package is consumed by `taqueria` itself, as well as `taqueria-sdk`.
+This package is consumed by `taqueria` itself, as well as `taqueria-sdk`
 
-This package can be consumed as an NPM package, and too included as a Deno module.
+This package can be consumed as an NPM package or included as a Deno module

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@taqueria/protocol",
-  "version": "0.0.8",
+  "version": "0.1.2",
   "description": "A TypeScript package which contains types that are to be shared between @taqueria/node-sdk and @taqueria/taqueria.",
   "main": "index.js",
   "scripts": {
@@ -29,6 +29,6 @@
   },
   "homepage": "https://github.com/ecadlabs/taqueria#readme",
   "devDependencies": {
-    "typescript": "^4.5.4"
+    "typescript": "4.5.4"
   }
 }

package/taqueria-protocol-types.ts

@@ -454,7 +454,7 @@ export class Option {
 export interface AccountKeys {
     alias: string
     encryptedKey: string
-    publicKey: string
+    publicKeyHash: string
     secretKey: string
 }
 
@@ -586,4 +586,38 @@ export interface Environment {
     readonly storage: Record<string, unknown>
 }
 
-export type Action = "checkRuntimeDependencies" | "installRuntimeDependencies" | "proxy" | "pluginInfo" | string
+export type PluginAction = "checkRuntimeDependencies" | "installRuntimeDependencies" | "proxy" | "pluginInfo" | string
+
+export interface RuntimeDependencyReport extends RuntimeDependency {
+    readonly met: boolean
+}
+
+export interface CheckRuntimeDependenciesAction {
+    readonly status: PluginResponseCode,
+    readonly report: RuntimeDependencyReport[]
+}
+
+export interface InstallRuntimeDependenciesAction {
+    readonly status: PluginResponseCode,
+    readonly report: RuntimeDependencyReport[]
+}
+
+export type PluginResponseCode = "success" | "failed" | "notSupported"
+
+export type PluginActionNotSupported = {
+    readonly status: "notSupported",
+    readonly msg: string
+}
+
+export interface ProxyAction {
+    readonly status: PluginResponseCode,
+    readonly stdout: string | unknown,
+    readonly stderr: string,
+    readonly render?: 'none' | 'string' | 'table'
+}
+
+export interface ActionPluginInfo extends UnvalidatedPluginInfo {
+    readonly status: PluginResponseCode,
+}
+
+export type PluginResponse = ProxyAction | CheckRuntimeDependenciesAction | InstallRuntimeDependenciesAction | ActionPluginInfo | PluginActionNotSupported