@taqueria/protocol
Version:
A TypeScript package which contains types that are to be shared between @taqueria/node-sdk and @taqueria/taqueria.
475 lines • 23.9 kB
TypeScript
import { TaqError } from '@taqueria/protocol/TaqError';
import { FutureInstance } from 'fluture';
import { Task } from '@taqueria/protocol/types';
import { Task as TaskStrict } from '@taqueria/protocol/out/types-strict';
export type { TaskStrict as Task };
export declare const from: (input: unknown) => TaskStrict;
export declare const create: (input: Task) => TaskStrict;
export declare const of: (input: unknown) => FutureInstance<TaqError, TaskStrict>;
export declare const make: (input: Omit<TaskStrict, "__type">) => FutureInstance<TaqError, TaskStrict>;
export declare const schemas: {
rawSchema: import("zod").ZodObject<{
task: import("zod").ZodString;
command: import("zod").ZodString;
aliases: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodUnion<[import("zod").ZodString, import("zod").ZodString]>, "many">>;
description: import("zod").ZodOptional<import("zod").ZodString>;
example: import("zod").ZodOptional<import("zod").ZodString>;
hidden: import("zod").ZodOptional<import("zod").ZodBoolean>;
encoding: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodUnion<[import("zod").ZodLiteral<"none">, import("zod").ZodLiteral<"json">, import("zod").ZodLiteral<"application/json">]>>>;
handler: import("zod").ZodUnion<[import("zod").ZodLiteral<"proxy">, import("zod").ZodString]>;
options: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
shortFlag: import("zod").ZodOptional<import("zod").ZodString>;
flag: import("zod").ZodString;
description: import("zod").ZodString;
defaultValue: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodString, import("zod").ZodNumber, import("zod").ZodBoolean]>>;
type: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodLiteral<"string">, import("zod").ZodLiteral<"number">, import("zod").ZodLiteral<"boolean">, import("zod").ZodLiteral<"count">]>>;
required: import("zod").ZodOptional<import("zod").ZodBoolean>;
boolean: import("zod").ZodOptional<import("zod").ZodBoolean>;
choices: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
}, "strip", import("zod").ZodTypeAny, {
description: string;
flag: string;
boolean?: boolean | undefined;
required?: boolean | undefined;
type?: "string" | "number" | "boolean" | "count" | undefined;
shortFlag?: string | undefined;
defaultValue?: string | number | boolean | undefined;
choices?: string[] | undefined;
}, {
description: string;
flag: string;
boolean?: boolean | undefined;
required?: boolean | undefined;
type?: "string" | "number" | "boolean" | "count" | undefined;
shortFlag?: string | undefined;
defaultValue?: string | number | boolean | undefined;
choices?: string[] | undefined;
}>, "many">>;
positionals: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
placeholder: import("zod").ZodString;
description: import("zod").ZodString;
defaultValue: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodString, import("zod").ZodNumber, import("zod").ZodBoolean]>>;
type: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodLiteral<"string">, import("zod").ZodLiteral<"number">, import("zod").ZodLiteral<"boolean">]>>;
required: import("zod").ZodOptional<import("zod").ZodBoolean>;
}, "strip", import("zod").ZodTypeAny, {
description: string;
placeholder: string;
required?: boolean | undefined;
type?: "string" | "number" | "boolean" | undefined;
defaultValue?: string | number | boolean | undefined;
}, {
description: string;
placeholder: string;
required?: boolean | undefined;
type?: "string" | "number" | "boolean" | undefined;
defaultValue?: string | number | boolean | undefined;
}>, "many">>;
}, "strip", import("zod").ZodTypeAny, {
handler: string;
command: string;
task: string;
description?: string | undefined;
positionals?: {
description: string;
placeholder: string;
required?: boolean | undefined;
type?: "string" | "number" | "boolean" | undefined;
defaultValue?: string | number | boolean | undefined;
}[] | undefined;
options?: {
description: string;
flag: string;
boolean?: boolean | undefined;
required?: boolean | undefined;
type?: "string" | "number" | "boolean" | "count" | undefined;
shortFlag?: string | undefined;
defaultValue?: string | number | boolean | undefined;
choices?: string[] | undefined;
}[] | undefined;
hidden?: boolean | undefined;
encoding?: "none" | "json" | "application/json" | undefined;
aliases?: string[] | undefined;
example?: string | undefined;
}, {
handler: string;
command: string;
task: string;
description?: string | undefined;
positionals?: {
description: string;
placeholder: string;
required?: boolean | undefined;
type?: "string" | "number" | "boolean" | undefined;
defaultValue?: string | number | boolean | undefined;
}[] | undefined;
options?: {
description: string;
flag: string;
boolean?: boolean | undefined;
required?: boolean | undefined;
type?: "string" | "number" | "boolean" | "count" | undefined;
shortFlag?: string | undefined;
defaultValue?: string | number | boolean | undefined;
choices?: string[] | undefined;
}[] | undefined;
hidden?: boolean | undefined;
encoding?: "none" | "json" | "application/json" | undefined;
aliases?: string[] | undefined;
example?: string | undefined;
}>;
schema: import("zod").ZodEffects<import("zod").ZodObject<{
task: import("zod").ZodString;
command: import("zod").ZodString;
aliases: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodUnion<[import("zod").ZodString, import("zod").ZodString]>, "many">>;
description: import("zod").ZodOptional<import("zod").ZodString>;
example: import("zod").ZodOptional<import("zod").ZodString>;
hidden: import("zod").ZodOptional<import("zod").ZodBoolean>;
encoding: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodUnion<[import("zod").ZodLiteral<"none">, import("zod").ZodLiteral<"json">, import("zod").ZodLiteral<"application/json">]>>>;
handler: import("zod").ZodUnion<[import("zod").ZodLiteral<"proxy">, import("zod").ZodString]>;
options: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
shortFlag: import("zod").ZodOptional<import("zod").ZodString>;
flag: import("zod").ZodString;
description: import("zod").ZodString;
defaultValue: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodString, import("zod").ZodNumber, import("zod").ZodBoolean]>>;
type: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodLiteral<"string">, import("zod").ZodLiteral<"number">, import("zod").ZodLiteral<"boolean">, import("zod").ZodLiteral<"count">]>>;
required: import("zod").ZodOptional<import("zod").ZodBoolean>;
boolean: import("zod").ZodOptional<import("zod").ZodBoolean>;
choices: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
}, "strip", import("zod").ZodTypeAny, {
description: string;
flag: string;
boolean?: boolean | undefined;
required?: boolean | undefined;
type?: "string" | "number" | "boolean" | "count" | undefined;
shortFlag?: string | undefined;
defaultValue?: string | number | boolean | undefined;
choices?: string[] | undefined;
}, {
description: string;
flag: string;
boolean?: boolean | undefined;
required?: boolean | undefined;
type?: "string" | "number" | "boolean" | "count" | undefined;
shortFlag?: string | undefined;
defaultValue?: string | number | boolean | undefined;
choices?: string[] | undefined;
}>, "many">>;
positionals: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
placeholder: import("zod").ZodString;
description: import("zod").ZodString;
defaultValue: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodString, import("zod").ZodNumber, import("zod").ZodBoolean]>>;
type: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodLiteral<"string">, import("zod").ZodLiteral<"number">, import("zod").ZodLiteral<"boolean">]>>;
required: import("zod").ZodOptional<import("zod").ZodBoolean>;
}, "strip", import("zod").ZodTypeAny, {
description: string;
placeholder: string;
required?: boolean | undefined;
type?: "string" | "number" | "boolean" | undefined;
defaultValue?: string | number | boolean | undefined;
}, {
description: string;
placeholder: string;
required?: boolean | undefined;
type?: "string" | "number" | "boolean" | undefined;
defaultValue?: string | number | boolean | undefined;
}>, "many">>;
}, "strip", import("zod").ZodTypeAny, {
handler: string;
command: string;
task: string;
description?: string | undefined;
positionals?: {
description: string;
placeholder: string;
required?: boolean | undefined;
type?: "string" | "number" | "boolean" | undefined;
defaultValue?: string | number | boolean | undefined;
}[] | undefined;
options?: {
description: string;
flag: string;
boolean?: boolean | undefined;
required?: boolean | undefined;
type?: "string" | "number" | "boolean" | "count" | undefined;
shortFlag?: string | undefined;
defaultValue?: string | number | boolean | undefined;
choices?: string[] | undefined;
}[] | undefined;
hidden?: boolean | undefined;
encoding?: "none" | "json" | "application/json" | undefined;
aliases?: string[] | undefined;
example?: string | undefined;
}, {
handler: string;
command: string;
task: string;
description?: string | undefined;
positionals?: {
description: string;
placeholder: string;
required?: boolean | undefined;
type?: "string" | "number" | "boolean" | undefined;
defaultValue?: string | number | boolean | undefined;
}[] | undefined;
options?: {
description: string;
flag: string;
boolean?: boolean | undefined;
required?: boolean | undefined;
type?: "string" | "number" | "boolean" | "count" | undefined;
shortFlag?: string | undefined;
defaultValue?: string | number | boolean | undefined;
choices?: string[] | undefined;
}[] | undefined;
hidden?: boolean | undefined;
encoding?: "none" | "json" | "application/json" | undefined;
aliases?: string[] | undefined;
example?: string | undefined;
}>, TaskStrict, {
handler: string;
command: string;
task: string;
description?: string | undefined;
positionals?: {
description: string;
placeholder: string;
required?: boolean | undefined;
type?: "string" | "number" | "boolean" | undefined;
defaultValue?: string | number | boolean | undefined;
}[] | undefined;
options?: {
description: string;
flag: string;
boolean?: boolean | undefined;
required?: boolean | undefined;
type?: "string" | "number" | "boolean" | "count" | undefined;
shortFlag?: string | undefined;
defaultValue?: string | number | boolean | undefined;
choices?: string[] | undefined;
}[] | undefined;
hidden?: boolean | undefined;
encoding?: "none" | "json" | "application/json" | undefined;
aliases?: string[] | undefined;
example?: string | undefined;
}>;
};
export declare const rawSchema: import("zod").ZodObject<{
task: import("zod").ZodString;
command: import("zod").ZodString;
aliases: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodUnion<[import("zod").ZodString, import("zod").ZodString]>, "many">>;
description: import("zod").ZodOptional<import("zod").ZodString>;
example: import("zod").ZodOptional<import("zod").ZodString>;
hidden: import("zod").ZodOptional<import("zod").ZodBoolean>;
encoding: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodUnion<[import("zod").ZodLiteral<"none">, import("zod").ZodLiteral<"json">, import("zod").ZodLiteral<"application/json">]>>>;
handler: import("zod").ZodUnion<[import("zod").ZodLiteral<"proxy">, import("zod").ZodString]>;
options: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
shortFlag: import("zod").ZodOptional<import("zod").ZodString>;
flag: import("zod").ZodString;
description: import("zod").ZodString;
defaultValue: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodString, import("zod").ZodNumber, import("zod").ZodBoolean]>>;
type: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodLiteral<"string">, import("zod").ZodLiteral<"number">, import("zod").ZodLiteral<"boolean">, import("zod").ZodLiteral<"count">]>>;
required: import("zod").ZodOptional<import("zod").ZodBoolean>;
boolean: import("zod").ZodOptional<import("zod").ZodBoolean>;
choices: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
}, "strip", import("zod").ZodTypeAny, {
description: string;
flag: string;
boolean?: boolean | undefined;
required?: boolean | undefined;
type?: "string" | "number" | "boolean" | "count" | undefined;
shortFlag?: string | undefined;
defaultValue?: string | number | boolean | undefined;
choices?: string[] | undefined;
}, {
description: string;
flag: string;
boolean?: boolean | undefined;
required?: boolean | undefined;
type?: "string" | "number" | "boolean" | "count" | undefined;
shortFlag?: string | undefined;
defaultValue?: string | number | boolean | undefined;
choices?: string[] | undefined;
}>, "many">>;
positionals: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
placeholder: import("zod").ZodString;
description: import("zod").ZodString;
defaultValue: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodString, import("zod").ZodNumber, import("zod").ZodBoolean]>>;
type: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodLiteral<"string">, import("zod").ZodLiteral<"number">, import("zod").ZodLiteral<"boolean">]>>;
required: import("zod").ZodOptional<import("zod").ZodBoolean>;
}, "strip", import("zod").ZodTypeAny, {
description: string;
placeholder: string;
required?: boolean | undefined;
type?: "string" | "number" | "boolean" | undefined;
defaultValue?: string | number | boolean | undefined;
}, {
description: string;
placeholder: string;
required?: boolean | undefined;
type?: "string" | "number" | "boolean" | undefined;
defaultValue?: string | number | boolean | undefined;
}>, "many">>;
}, "strip", import("zod").ZodTypeAny, {
handler: string;
command: string;
task: string;
description?: string | undefined;
positionals?: {
description: string;
placeholder: string;
required?: boolean | undefined;
type?: "string" | "number" | "boolean" | undefined;
defaultValue?: string | number | boolean | undefined;
}[] | undefined;
options?: {
description: string;
flag: string;
boolean?: boolean | undefined;
required?: boolean | undefined;
type?: "string" | "number" | "boolean" | "count" | undefined;
shortFlag?: string | undefined;
defaultValue?: string | number | boolean | undefined;
choices?: string[] | undefined;
}[] | undefined;
hidden?: boolean | undefined;
encoding?: "none" | "json" | "application/json" | undefined;
aliases?: string[] | undefined;
example?: string | undefined;
}, {
handler: string;
command: string;
task: string;
description?: string | undefined;
positionals?: {
description: string;
placeholder: string;
required?: boolean | undefined;
type?: "string" | "number" | "boolean" | undefined;
defaultValue?: string | number | boolean | undefined;
}[] | undefined;
options?: {
description: string;
flag: string;
boolean?: boolean | undefined;
required?: boolean | undefined;
type?: "string" | "number" | "boolean" | "count" | undefined;
shortFlag?: string | undefined;
defaultValue?: string | number | boolean | undefined;
choices?: string[] | undefined;
}[] | undefined;
hidden?: boolean | undefined;
encoding?: "none" | "json" | "application/json" | undefined;
aliases?: string[] | undefined;
example?: string | undefined;
}>;
export declare const internalSchema: import("zod").ZodObject<{
task: import("zod").ZodString;
command: import("zod").ZodString;
aliases: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodUnion<[import("zod").ZodString, import("zod").ZodString]>, "many">>;
description: import("zod").ZodOptional<import("zod").ZodString>;
example: import("zod").ZodOptional<import("zod").ZodString>;
hidden: import("zod").ZodOptional<import("zod").ZodBoolean>;
encoding: import("zod").ZodOptional<import("zod").ZodDefault<import("zod").ZodUnion<[import("zod").ZodLiteral<"none">, import("zod").ZodLiteral<"json">, import("zod").ZodLiteral<"application/json">]>>>;
handler: import("zod").ZodUnion<[import("zod").ZodLiteral<"proxy">, import("zod").ZodString]>;
options: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
shortFlag: import("zod").ZodOptional<import("zod").ZodString>;
flag: import("zod").ZodString;
description: import("zod").ZodString;
defaultValue: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodString, import("zod").ZodNumber, import("zod").ZodBoolean]>>;
type: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodLiteral<"string">, import("zod").ZodLiteral<"number">, import("zod").ZodLiteral<"boolean">, import("zod").ZodLiteral<"count">]>>;
required: import("zod").ZodOptional<import("zod").ZodBoolean>;
boolean: import("zod").ZodOptional<import("zod").ZodBoolean>;
choices: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
}, "strip", import("zod").ZodTypeAny, {
description: string;
flag: string;
boolean?: boolean | undefined;
required?: boolean | undefined;
type?: "string" | "number" | "boolean" | "count" | undefined;
shortFlag?: string | undefined;
defaultValue?: string | number | boolean | undefined;
choices?: string[] | undefined;
}, {
description: string;
flag: string;
boolean?: boolean | undefined;
required?: boolean | undefined;
type?: "string" | "number" | "boolean" | "count" | undefined;
shortFlag?: string | undefined;
defaultValue?: string | number | boolean | undefined;
choices?: string[] | undefined;
}>, "many">>;
positionals: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
placeholder: import("zod").ZodString;
description: import("zod").ZodString;
defaultValue: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodString, import("zod").ZodNumber, import("zod").ZodBoolean]>>;
type: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodLiteral<"string">, import("zod").ZodLiteral<"number">, import("zod").ZodLiteral<"boolean">]>>;
required: import("zod").ZodOptional<import("zod").ZodBoolean>;
}, "strip", import("zod").ZodTypeAny, {
description: string;
placeholder: string;
required?: boolean | undefined;
type?: "string" | "number" | "boolean" | undefined;
defaultValue?: string | number | boolean | undefined;
}, {
description: string;
placeholder: string;
required?: boolean | undefined;
type?: "string" | "number" | "boolean" | undefined;
defaultValue?: string | number | boolean | undefined;
}>, "many">>;
}, "strip", import("zod").ZodTypeAny, {
handler: string;
command: string;
task: string;
description?: string | undefined;
positionals?: {
description: string;
placeholder: string;
required?: boolean | undefined;
type?: "string" | "number" | "boolean" | undefined;
defaultValue?: string | number | boolean | undefined;
}[] | undefined;
options?: {
description: string;
flag: string;
boolean?: boolean | undefined;
required?: boolean | undefined;
type?: "string" | "number" | "boolean" | "count" | undefined;
shortFlag?: string | undefined;
defaultValue?: string | number | boolean | undefined;
choices?: string[] | undefined;
}[] | undefined;
hidden?: boolean | undefined;
encoding?: "none" | "json" | "application/json" | undefined;
aliases?: string[] | undefined;
example?: string | undefined;
}, {
handler: string;
command: string;
task: string;
description?: string | undefined;
positionals?: {
description: string;
placeholder: string;
required?: boolean | undefined;
type?: "string" | "number" | "boolean" | undefined;
defaultValue?: string | number | boolean | undefined;
}[] | undefined;
options?: {
description: string;
flag: string;
boolean?: boolean | undefined;
required?: boolean | undefined;
type?: "string" | "number" | "boolean" | "count" | undefined;
shortFlag?: string | undefined;
defaultValue?: string | number | boolean | undefined;
choices?: string[] | undefined;
}[] | undefined;
hidden?: boolean | undefined;
encoding?: "none" | "json" | "application/json" | undefined;
aliases?: string[] | undefined;
example?: string | undefined;
}>;
export type t = TaskStrict;
//# sourceMappingURL=Task.d.ts.map