@taqueria/protocol 0.25.0-alpha → 0.25.4-alpha

package/types.d.ts

@@ -0,0 +1,311 @@
+/** @minLength 1 */
+export type NonEmptyString = string;
+/** @pattern ^[A-Za-z]$ */
+export type SingleChar = NonEmptyString;
+/** @pattern ^[A-Za-z\-\ ]+ */
+export type Verb = NonEmptyString;
+export type Alias = (Verb | SingleChar);
+/** @pattern ^[A-Za-z]+[A-Za-z0-9-_ ]*$ */
+export type HumanReadableIdentifier = NonEmptyString;
+export type SanitizedAbsPath = NonEmptyString;
+export type SanitizedPath = NonEmptyString;
+export type Settings = {
+    consent: 'opt_in' | 'opt_out';
+};
+/**
+ * @minimum 1651846877
+ * @integer
+ */
+export type Timestamp = number;
+/**
+ * @minLength 1
+ * @pattern ^\d([\d_]+\d)?$ */
+export type Tz = NonEmptyString;
+/**
+ * @minLength 1
+ * @pattern ^\d+\.\d+(\.\d+)*$ */
+export type VersionNumber = NonEmptyString;
+/** @format url */
+export type Url = NonEmptyString;
+/** interpreted using yargs @pattern ^([A-Za-z-_ ]+ ?)((\[.+\] ?)|(\<.+\>) ?)*$ */
+export type Command = NonEmptyString;
+export type Option = {
+    shortFlag?: SingleChar;
+    flag: Verb;
+    description: NonEmptyString;
+    defaultValue?: string | number | boolean;
+    type?: 'string' | 'number' | 'boolean';
+    required?: boolean;
+    boolean?: boolean;
+    choices?: NonEmptyString[];
+};
+export type PositionalArg = {
+    placeholder: HumanReadableIdentifier;
+    description: NonEmptyString;
+    defaultValue?: string | number | boolean;
+    type?: 'string' | 'number' | 'boolean';
+    required?: boolean;
+};
+export type InstalledPlugin = {
+    type: 'npm' | 'binary' | 'deno';
+    name: NonEmptyString;
+};
+export type Operation = {
+    operation: Verb;
+    command: Command;
+    description?: NonEmptyString;
+    positionals?: PositionalArg[];
+    options?: Option[];
+    handler?: (args: PersistentState) => (args: RequestArgs) => void;
+};
+export type ParsedOperation = Omit<Operation, 'handler'>;
+export type Template = {
+    template: Verb;
+    command: Command;
+    description: NonEmptyString;
+    hidden?: boolean;
+    options?: Option[];
+    positionals?: PositionalArg[];
+    handler: TemplateHandler;
+    encoding?: PluginResponseEncoding;
+};
+type TemplateHandler = NonEmptyString | ((args: RequestArgs) => PluginJsonResponse | Promise<PluginJsonResponse>) | Promise<void>;
+export type ParsedTemplate = Omit<Template, 'handler'> & {
+    handler: string;
+};
+type PluginSchemaBase = {
+    name: NonEmptyString;
+    version: VersionNumber;
+    schema: VersionNumber;
+    alias: Alias;
+    tasks?: Task[];
+};
+export type PluginInfo = PluginSchemaBase & {
+    operations?: ParsedOperation[];
+    templates?: ParsedTemplate[];
+};
+export type PluginSchema = PluginSchemaBase & {
+    operations?: Operation[];
+    templates?: Template[];
+    proxy?: (args: RequestArgs) => Promise<PluginProxyResponse>;
+    checkRuntimeDependencies?: (args: RequestArgs) => Promise<PluginDependenciesResponse>;
+    installRuntimeDependencies?: (args: RequestArgs) => Promise<PluginDependenciesResponse>;
+};
+export type Task = {
+    task: Verb;
+    command: Command;
+    aliases?: Alias[];
+    /** @minLength 3 */
+    description?: NonEmptyString;
+    example?: NonEmptyString;
+    hidden?: boolean;
+    encoding?: PluginResponseEncoding;
+    handler: 'proxy' | NonEmptyString;
+    options?: Option[];
+    positionals?: PositionalArg[];
+};
+export type RuntimeDependency = {
+    name: HumanReadableIdentifier;
+    path: string;
+    version: string;
+    kind: 'required' | 'optional';
+};
+export type RuntimeDependencyReport = RuntimeDependency & {
+    met: boolean;
+};
+export type PluginDependenciesResponse = {
+    report: RuntimeDependencyReport[];
+};
+export type PluginJsonResponse = {
+    data?: unknown;
+    /** @default none */
+    render: 'none' | 'table' | 'string';
+} | void;
+export type PluginProxyResponse = void | PluginJsonResponse;
+/** @default none */
+export type PluginResponseEncoding = 'none' | 'json' | 'application/json';
+/**
+ * @min 100
+ */
+export type BuildNumber = number;
+export type SanitizedArgs = {
+    _: string[];
+    projectDir: SanitizedPath;
+    maxConcurrency: number;
+    debug: boolean;
+    disableState: boolean;
+    logPluginRequests: boolean;
+    fromVsCode: boolean;
+    version: boolean;
+    build: boolean;
+    help: boolean;
+    yes: boolean;
+    plugin?: NonEmptyString;
+    env: NonEmptyString;
+    quickstart: NonEmptyString;
+    setBuild: NonEmptyString | BuildNumber;
+    setVersion: NonEmptyString;
+};
+export type PluginActionName = 'proxy' | 'pluginInfo' | 'checkRuntimeDependencies' | 'installRuntimeDependencies' | 'proxyTemplate';
+export type RequestArgs = Omit<SanitizedArgs, 'quickstart'> & {
+    taqRun: PluginActionName;
+    config: LoadedConfig;
+};
+export type ProxyTaskArgs = RequestArgs & {
+    task: NonEmptyString;
+};
+export type ProxyTemplateArgs = RequestArgs & {
+    template: NonEmptyString;
+};
+/** @min 1 */
+export type EconomicalProtocolHash = string;
+/** @pattern ^tz\d[A-Za-z0-9]{33}$ */
+export type PublicKeyHash = string;
+/** @pattern ^[A-Fa-f0-9]{64}$ */
+export type SHA256 = string;
+export type Contract = {
+    sourceFile: NonEmptyString;
+    hash: SHA256;
+};
+export type Faucet = {
+    pkh: PublicKeyHash;
+    mnemonic: string[];
+    /** @format email */
+    email: string;
+    password: string;
+    /** @pattern ^\d+$ */
+    amount: string;
+    activation_code: string;
+};
+/** Port number for postgresql container
+ * @default 5432
+ */
+type TzKtConfigPostgresqlPort = number;
+/** Port number for TzKt API
+ * @default 5000
+ */
+type TzKtConfigApiPort = number;
+export type TzKtConfig = {
+    /** Do not start TzKt when sandbox starts */
+    disableAutostartWithSandbox?: boolean;
+    postgresqlPort?: TzKtConfigPostgresqlPort;
+    apiPort?: TzKtConfigApiPort;
+};
+export type Environment = {
+    networks: NonEmptyString[];
+    sandboxes: NonEmptyString[];
+    storage?: Record<string, NonEmptyString>;
+    aliases?: Record<string, Record<string, NonEmptyString>>;
+};
+export type EphemeralState = {
+    build: string;
+    configHash: string;
+    /** Task/Plugin Mapping */
+    tasks: Record<string, InstalledPlugin & Task>;
+    /** Operation/Plugin Mapping */
+    operations: Record<string, InstalledPlugin & ParsedOperation>;
+    /** Templates/Plugin Mapping */
+    templates: Record<string, InstalledPlugin & ParsedTemplate>;
+    plugins: PluginInfo[];
+};
+export type PersistentState = {
+    operations: Record<string, PersistedOperation>;
+    tasks: Record<string, PersistedTask>;
+};
+export type PersistedTask = {
+    task: Verb;
+    plugin: NonEmptyString;
+    time: Timestamp;
+    output?: unknown;
+};
+export type PersistedOperation = {
+    hash: SHA256;
+    time: Timestamp;
+    output?: unknown;
+};
+/**
+ * @minLength 1
+ * @pattern ^[A-Za-z0-9]+[A-Za-z0-9-_]+\.[A-Za-z0-9]+[A-Za-z0-9-_]+\.[A-Za-z0-9]+[A-Za-z0-9-_]+$
+ */
+export type ProvisionerID = string;
+export type Provisioner = {
+    id: ProvisionerID;
+    plugin: NonEmptyString;
+    operation: NonEmptyString | 'custom';
+    command?: string;
+    label?: string;
+    depends_on?: ProvisionerID[];
+};
+export type Provisions = Provisioner[];
+/** @minLength 1 Default environment must reference the name of an existing environment.*/
+type EnvironmentName = NonEmptyString;
+/** @default en */
+type HumanLanguage = 'en' | 'fr';
+/**
+ * @default contracts
+ * @minLength 1
+ */
+export type ConfigContractsDir = string;
+/**
+ * @default artifacts
+ * @minLength 1
+ */
+export type ConfigArtifactsDir = string;
+export type Config = {
+    language?: HumanLanguage;
+    plugins?: InstalledPlugin[];
+    contractsDir?: ConfigContractsDir;
+    artifactsDir?: ConfigArtifactsDir;
+    network?: Record<string, NetworkConfig>;
+    sandbox?: Record<string, SandboxConfig>;
+    environment: Record<string, Environment | EnvironmentName>;
+    accounts?: Record<string, Tz>;
+    contracts?: Record<string, Contract>;
+    metadata?: MetadataConfig;
+};
+export type LoadedConfig = Config & {
+    projectDir: SanitizedAbsPath;
+    configFile: SanitizedAbsPath;
+    hash: SHA256;
+};
+export type MetadataConfig = {
+    name?: string;
+    projectDescription?: string;
+    authors?: string[];
+    license?: string;
+    homepage?: string;
+};
+export type NetworkConfig = {
+    label: HumanReadableIdentifier;
+    rpcUrl: Url;
+    protocol: EconomicalProtocolHash;
+    accounts?: Record<string, NetworkAccountConfig>;
+    faucet?: Faucet;
+};
+export type NetworkAccountConfig = {
+    publicKey: NonEmptyString;
+    publicKeyHash: PublicKeyHash;
+    privateKey: NonEmptyString; /** TODO: Should this be secretKey: @see {SandboxAccountConfig} */
+};
+export type SandboxAccountConfig = {
+    encryptedKey: NonEmptyString;
+    publicKeyHash: PublicKeyHash;
+    secretKey: NonEmptyString;
+};
+export type SandboxConfig = {
+    label: NonEmptyString;
+    rpcUrl: Url;
+    protocol: EconomicalProtocolHash;
+    attributes?: string | number | boolean;
+    plugin?: Verb;
+    accounts?: Record<string, SandboxAccountConfig | NonEmptyString>;
+    tzkt?: TzKtConfig;
+};
+export type ScaffoldConfig = {
+    postInit?: string;
+};
+export type ParsedConfig = Omit<Config, 'sandbox'> & {
+    sandbox: Record<string, SandboxConfig | NonEmptyString>;
+};
+export {};
+//# sourceMappingURL=types.d.ts.map

package/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["types.ts"],"names":[],"mappings":"AAEA,mBAAmB;AACnB,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC;AAEpC,0BAA0B;AAC1B,MAAM,MAAM,UAAU,GAAG,cAAc,CAAC;AAExC,8BAA8B;AAC9B,MAAM,MAAM,IAAI,GAAG,cAAc,CAAC;AAElC,MAAM,MAAM,KAAK,GAAG,CAAC,IAAI,GAAG,UAAU,CAAC,CAAC;AAExC,0CAA0C;AAC1C,MAAM,MAAM,uBAAuB,GAAG,cAAc,CAAC;AAErD,MAAM,MAAM,gBAAgB,GAAG,cAAc,CAAC;AAE9C,MAAM,MAAM,aAAa,GAAG,cAAc,CAAC;AAE3C,MAAM,MAAM,QAAQ,GAAG;IACtB,OAAO,EAAE,QAAQ,GAAG,SAAS,CAAC;CAC9B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC;AAE/B;;8BAE8B;AAC9B,MAAM,MAAM,EAAE,GAAG,cAAc,CAAC;AAEhC;;iCAEiC;AACjC,MAAM,MAAM,aAAa,GAAG,cAAc,CAAC;AAE3C,kBAAkB;AAClB,MAAM,MAAM,GAAG,GAAG,cAAc,CAAC;AAIjC,kFAAkF;AAClF,MAAM,MAAM,OAAO,GAAG,cAAc,CAAC;AAErC,MAAM,MAAM,MAAM,GAAG;IACpB,SAAS,CAAC,EAAE,UAAU,CAAC;IACvB,IAAI,EAAE,IAAI,CAAC;IACX,WAAW,EAAE,cAAc,CAAC;IAC5B,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;IACzC,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;IACvC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,cAAc,EAAE,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC3B,WAAW,EAAE,uBAAuB,CAAC;IACrC,WAAW,EAAE,cAAc,CAAC;IAC5B,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;IACzC,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;IACvC,QAAQ,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC7B,IAAI,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,CAAC;IAChC,IAAI,EAAE,cAAc,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACvB,SAAS,EAAE,IAAI,CAAC;IAChB,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,CAAC,EAAE,cAAc,CAAC;IAC7B,WAAW,CAAC,EAAE,aAAa,EAAE,CAAC;IAC9B,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,CAAC,EAAE,CAAC,IAAI,EAAE,eAAe,KAAK,CAAC,IAAI,EAAE,WAAW,KAAK,IAAI,CAAC;CACjE,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;AAEzD,MAAM,MAAM,QAAQ,GAAG;IACtB,QAAQ,EAAE,IAAI,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,cAAc,CAAC;IAC5B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,WAAW,CAAC,EAAE,aAAa,EAAE,CAAC;IAC9B,OAAO,EAAE,eAAe,CAAC;IACzB,QAAQ,CAAC,EAAE,sBAAsB,CAAC;CAClC,CAAC;AAEF,KAAK,eAAe,GACjB,cAAc,GACd,CAAC,CAAC,IAAI,EAAE,WAAW,KAClB,kBAAkB,GAClB,OAAO,CAAC,kBAAkB,CAAC,CAAC,GAC7B,OAAO,CAAC,IAAI,CAAC,CAAC;AAEjB,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,GAAG;IACxD,OAAO,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,KAAK,gBAAgB,GAAG;IACvB,IAAI,EAAE,cAAc,CAAC;IACrB,OAAO,EAAE,aAAa,CAAC;IACvB,MAAM,EAAE,aAAa,CAAC;IACtB,KAAK,EAAE,KAAK,CAAC;IACb,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG,gBAAgB,GAAG;IAC3C,UAAU,CAAC,EAAE,eAAe,EAAE,CAAC;IAC/B,SAAS,CAAC,EAAE,cAAc,EAAE,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,gBAAgB,GAAG;IAC7C,UAAU,CAAC,EAAE,SAAS,EAAE,CAAC;IACzB,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAC;IACvB,KAAK,CAAC,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAC5D,wBAAwB,CAAC,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,OAAO,CAAC,0BAA0B,CAAC,CAAC;IACtF,0BAA0B,CAAC,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,OAAO,CAAC,0BAA0B,CAAC,CAAC;CACxF,CAAC;AAEF,MAAM,MAAM,IAAI,GAAG;IAClB,IAAI,EAAE,IAAI,CAAC;IACX,OAAO,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,KAAK,EAAE,CAAC;IAClB,mBAAmB;IACnB,WAAW,CAAC,EAAE,cAAc,CAAC;IAC7B,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,sBAAsB,CAAC;IAClC,OAAO,EAAE,OAAO,GAAG,cAAc,CAAC;IAClC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,WAAW,CAAC,EAAE,aAAa,EAAE,CAAC;CAC9B,CAAC;AAIF,MAAM,MAAM,iBAAiB,GAAG;IAC/B,IAAI,EAAE,uBAAuB,CAAC;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,UAAU,GAAG,UAAU,CAAC;CAC9B,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG,iBAAiB,GAAG;IACzD,GAAG,EAAE,OAAO,CAAC;CACb,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACxC,MAAM,EAAE,uBAAuB,EAAE,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAChC,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf,oBAAoB;IACpB,MAAM,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAC;CACpC,GAAG,IAAI,CAAC;AAET,MAAM,MAAM,mBAAmB,GAAG,IAAI,GAAG,kBAAkB,CAAC;AAE5D,oBAAoB;AACpB,MAAM,MAAM,sBAAsB,GAAG,MAAM,GAAG,MAAM,GAAG,kBAAkB,CAAC;AAE1E;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC;AAEjC,MAAM,MAAM,aAAa,GAAG;IAC3B,CAAC,EAAE,MAAM,EAAE,CAAC;IACZ,UAAU,EAAE,aAAa,CAAC;IAC1B,cAAc,EAAE,MAAM,CAAC;IACvB,KAAK,EAAE,OAAO,CAAC;IACf,YAAY,EAAE,OAAO,CAAC;IACtB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,UAAU,EAAE,OAAO,CAAC;IACpB,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,OAAO,CAAC;IACf,IAAI,EAAE,OAAO,CAAC;IACd,GAAG,EAAE,OAAO,CAAC;IACb,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,GAAG,EAAE,cAAc,CAAC;IACpB,UAAU,EAAE,cAAc,CAAC;IAC3B,QAAQ,EAAE,cAAc,GAAG,WAAW,CAAC;IACvC,UAAU,EAAE,cAAc,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,gBAAgB,GACzB,OAAO,GACP,YAAY,GACZ,0BAA0B,GAC1B,4BAA4B,GAC5B,eAAe,CAAC;AAEnB,MAAM,MAAM,WAAW,GAAG,IAAI,CAAC,aAAa,EAAE,YAAY,CAAC,GAAG;IAC7D,MAAM,EAAE,gBAAgB,CAAC;IAEzB,MAAM,EAAE,YAAY,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,WAAW,GAAG;IACzC,IAAI,EAAE,cAAc,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,WAAW,GAAG;IAC7C,QAAQ,EAAE,cAAc,CAAC;CACzB,CAAC;AAIF,aAAa;AACb,MAAM,MAAM,sBAAsB,GAAG,MAAM,CAAC;AAE5C,qCAAqC;AACrC,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AAEnC,iCAAiC;AACjC,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC;AAI5B,MAAM,MAAM,QAAQ,GAAG;IACtB,UAAU,EAAE,cAAc,CAAC;IAC3B,IAAI,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG;IACpB,GAAG,EAAE,aAAa,CAAC;IACnB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,oBAAoB;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,qBAAqB;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,EAAE,MAAM,CAAC;CACxB,CAAC;AAIF;;GAEG;AACH,KAAK,wBAAwB,GAAG,MAAM,CAAC;AAEvC;;GAEG;AACH,KAAK,iBAAiB,GAAG,MAAM,CAAC;AAEhC,MAAM,MAAM,UAAU,GAAG;IACxB,4CAA4C;IAC5C,2BAA2B,CAAC,EAAE,OAAO,CAAC;IACtC,cAAc,CAAC,EAAE,wBAAwB,CAAC;IAC1C,OAAO,CAAC,EAAE,iBAAiB,CAAC;CAC5B,CAAC;AAIF,MAAM,MAAM,WAAW,GAAG;IACzB,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B,SAAS,EAAE,cAAc,EAAE,CAAC;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACzC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,CAAC;CACzD,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IAInB,0BAA0B;IAC1B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,GAAG,IAAI,CAAC,CAAC;IAC9C,+BAA+B;IAC/B,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,GAAG,eAAe,CAAC,CAAC;IAC9D,+BAA+B;IAC/B,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,GAAG,cAAc,CAAC,CAAC;IAE5D,OAAO,EAAE,UAAU,EAAE,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC7B,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAAC;IAC/C,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;CACrC,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC3B,IAAI,EAAE,IAAI,CAAC;IACX,MAAM,EAAE,cAAc,CAAC;IACvB,IAAI,EAAE,SAAS,CAAC;IAChB,MAAM,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,SAAS,CAAC;IAChB,MAAM,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC;AAEnC,MAAM,MAAM,WAAW,GAAG;IACzB,EAAE,EAAE,aAAa,CAAC;IAClB,MAAM,EAAE,cAAc,CAAC;IACvB,SAAS,EAAE,cAAc,GAAG,QAAQ,CAAC;IACrC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,aAAa,EAAE,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG,WAAW,EAAE,CAAC;AAIvC,0FAA0F;AAC1F,KAAK,eAAe,GAAG,cAAc,CAAC;AAEtC,kBAAkB;AAClB,KAAK,aAAa,GAAG,IAAI,GAAG,IAAI,CAAC;AAEjC;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC;AAExC;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC;AAExC,MAAM,MAAM,MAAM,GAAG;IACpB,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,OAAO,CAAC,EAAE,eAAe,EAAE,CAAC;IAC5B,YAAY,CAAC,EAAE,kBAAkB,CAAC;IAClC,YAAY,CAAC,EAAE,kBAAkB,CAAC;IAClC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IACxC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAMxC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,GAAG,eAAe,CAAC,CAAC;IAC3D,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAC9B,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACrC,QAAQ,CAAC,EAAE,cAAc,CAAC;CAC1B,CAAC;AAGF,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG;IACnC,UAAU,EAAE,gBAAgB,CAAC;IAC7B,UAAU,EAAE,gBAAgB,CAAC;IAC7B,IAAI,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC3B,KAAK,EAAE,uBAAuB,CAAC;IAC/B,MAAM,EAAE,GAAG,CAAC;IACZ,QAAQ,EAAE,sBAAsB,CAAC;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;IAChD,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IAClC,SAAS,EAAE,cAAc,CAAC;IAC1B,aAAa,EAAE,aAAa,CAAC;IAC7B,UAAU,EAAE,cAAc,CAAC,CAAC,kEAAkE;CAC9F,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IAClC,YAAY,EAAE,cAAc,CAAC;IAC7B,aAAa,EAAE,aAAa,CAAC;IAC7B,SAAS,EAAE,cAAc,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC3B,KAAK,EAAE,cAAc,CAAC;IACtB,MAAM,EAAE,GAAG,CAAC;IACZ,QAAQ,EAAE,sBAAsB,CAAC;IACjC,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;IACvC,MAAM,CAAC,EAAE,IAAI,CAAC;IAMd,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,GAAG,cAAc,CAAC,CAAC;IAEjE,IAAI,CAAC,EAAE,UAAU,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG;IACpD,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,GAAG,cAAc,CAAC,CAAC;CACxD,CAAC"}

package/types.js

@@ -0,0 +1,19 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// types.ts
+var types_exports = {};
+module.exports = __toCommonJS(types_exports);
+//# sourceMappingURL=types.js.map

package/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["types.ts"],"sourcesContent":["// ---- Simple Types & Type Fragments ----\n\n/** @minLength 1 */\nexport type NonEmptyString = string;\n\n/** @pattern ^[A-Za-z]$ */\nexport type SingleChar = NonEmptyString;\n\n/** @pattern ^[A-Za-z\\-\\ ]+ */\nexport type Verb = NonEmptyString;\n\nexport type Alias = (Verb | SingleChar);\n\n/** @pattern ^[A-Za-z]+[A-Za-z0-9-_ ]*$ */\nexport type HumanReadableIdentifier = NonEmptyString;\n\nexport type SanitizedAbsPath = NonEmptyString;\n\nexport type SanitizedPath = NonEmptyString;\n\nexport type Settings = {\n\tconsent: 'opt_in' | 'opt_out';\n};\n\n/**\n * @minimum 1651846877\n * @integer\n */\nexport type Timestamp = number;\n\n/**\n * @minLength 1\n * @pattern ^\\d([\\d_]+\\d)?$ */\nexport type Tz = NonEmptyString;\n\n/**\n * @minLength 1\n * @pattern ^\\d+\\.\\d+(\\.\\d+)*$ */\nexport type VersionNumber = NonEmptyString;\n\n/** @format url */\nexport type Url = NonEmptyString;\n\n// ---- Plugin Definition Types ----\n\n/** interpreted using yargs @pattern ^([A-Za-z-_ ]+ ?)((\\[.+\\] ?)|(\\<.+\\>) ?)*$ */\nexport type Command = NonEmptyString;\n\nexport type Option = {\n\tshortFlag?: SingleChar;\n\tflag: Verb;\n\tdescription: NonEmptyString;\n\tdefaultValue?: string | number | boolean;\n\ttype?: 'string' | 'number' | 'boolean';\n\trequired?: boolean;\n\tboolean?: boolean;\n\tchoices?: NonEmptyString[];\n};\n\nexport type PositionalArg = {\n\tplaceholder: HumanReadableIdentifier;\n\tdescription: NonEmptyString;\n\tdefaultValue?: string | number | boolean;\n\ttype?: 'string' | 'number' | 'boolean';\n\trequired?: boolean;\n};\n\nexport type InstalledPlugin = {\n\ttype: 'npm' | 'binary' | 'deno';\n\tname: NonEmptyString;\n};\n\nexport type Operation = {\n\toperation: Verb;\n\tcommand: Command;\n\tdescription?: NonEmptyString;\n\tpositionals?: PositionalArg[];\n\toptions?: Option[];\n\thandler?: (args: PersistentState) => (args: RequestArgs) => void;\n};\n\nexport type ParsedOperation = Omit<Operation, 'handler'>;\n\nexport type Template = {\n\ttemplate: Verb;\n\tcommand: Command;\n\tdescription: NonEmptyString;\n\thidden?: boolean;\n\toptions?: Option[];\n\tpositionals?: PositionalArg[];\n\thandler: TemplateHandler;\n\tencoding?: PluginResponseEncoding;\n};\n\ntype TemplateHandler =\n\t| NonEmptyString // TODO: should this be Verb?\n\t| ((args: RequestArgs) =>\n\t\t| PluginJsonResponse\n\t\t| Promise<PluginJsonResponse>)\n\t| Promise<void>;\n\nexport type ParsedTemplate = Omit<Template, 'handler'> & {\n\thandler: string;\n};\n\ntype PluginSchemaBase = {\n\tname: NonEmptyString;\n\tversion: VersionNumber;\n\tschema: VersionNumber;\n\talias: Alias;\n\ttasks?: Task[];\n};\n\nexport type PluginInfo = PluginSchemaBase & {\n\toperations?: ParsedOperation[];\n\ttemplates?: ParsedTemplate[];\n};\n\nexport type PluginSchema = PluginSchemaBase & {\n\toperations?: Operation[];\n\ttemplates?: Template[];\n\tproxy?: (args: RequestArgs) => Promise<PluginProxyResponse>;\n\tcheckRuntimeDependencies?: (args: RequestArgs) => Promise<PluginDependenciesResponse>;\n\tinstallRuntimeDependencies?: (args: RequestArgs) => Promise<PluginDependenciesResponse>;\n};\n\nexport type Task = {\n\ttask: Verb;\n\tcommand: Command;\n\taliases?: Alias[];\n\t/** @minLength 3 */\n\tdescription?: NonEmptyString;\n\texample?: NonEmptyString;\n\thidden?: boolean;\n\tencoding?: PluginResponseEncoding;\n\thandler: 'proxy' | NonEmptyString;\n\toptions?: Option[];\n\tpositionals?: PositionalArg[];\n};\n\n// ---- Process Interop ----\n\nexport type RuntimeDependency = {\n\tname: HumanReadableIdentifier;\n\tpath: string;\n\tversion: string;\n\tkind: 'required' | 'optional';\n};\n\nexport type RuntimeDependencyReport = RuntimeDependency & {\n\tmet: boolean;\n};\n\nexport type PluginDependenciesResponse = {\n\treport: RuntimeDependencyReport[];\n};\n\nexport type PluginJsonResponse = {\n\tdata?: unknown;\n\n\t/** @default none */\n\trender: 'none' | 'table' | 'string';\n} | void;\n\nexport type PluginProxyResponse = void | PluginJsonResponse;\n\n/** @default none */\nexport type PluginResponseEncoding = 'none' | 'json' | 'application/json';\n\n/**\n * @min 100\n */\nexport type BuildNumber = number;\n\nexport type SanitizedArgs = {\n\t_: string[];\n\tprojectDir: SanitizedPath;\n\tmaxConcurrency: number;\n\tdebug: boolean;\n\tdisableState: boolean;\n\tlogPluginRequests: boolean;\n\tfromVsCode: boolean;\n\tversion: boolean;\n\tbuild: boolean;\n\thelp: boolean;\n\tyes: boolean;\n\tplugin?: NonEmptyString;\n\tenv: NonEmptyString;\n\tquickstart: NonEmptyString;\n\tsetBuild: NonEmptyString | BuildNumber;\n\tsetVersion: NonEmptyString;\n};\n\nexport type PluginActionName =\n\t| 'proxy'\n\t| 'pluginInfo'\n\t| 'checkRuntimeDependencies'\n\t| 'installRuntimeDependencies'\n\t| 'proxyTemplate';\n\nexport type RequestArgs = Omit<SanitizedArgs, 'quickstart'> & {\n\ttaqRun: PluginActionName;\n\t// TODO: JSON.parse if string\n\tconfig: LoadedConfig;\n};\n\nexport type ProxyTaskArgs = RequestArgs & {\n\ttask: NonEmptyString;\n};\n\nexport type ProxyTemplateArgs = RequestArgs & {\n\ttemplate: NonEmptyString;\n};\n\n// ---- Hash Types ----\n\n/** @min 1 */\nexport type EconomicalProtocolHash = string;\n\n/** @pattern ^tz\\d[A-Za-z0-9]{33}$ */\nexport type PublicKeyHash = string;\n\n/** @pattern ^[A-Fa-f0-9]{64}$ */\nexport type SHA256 = string;\n\n// ---- Contract Objects ----\n\nexport type Contract = {\n\tsourceFile: NonEmptyString;\n\thash: SHA256;\n};\n\nexport type Faucet = {\n\tpkh: PublicKeyHash;\n\tmnemonic: string[];\n\t/** @format email */\n\temail: string;\n\tpassword: string;\n\t/** @pattern ^\\d+$ */\n\tamount: string;\n\tactivation_code: string;\n};\n\n// ---- External ----\n\n/** Port number for postgresql container\n * @default 5432\n */\ntype TzKtConfigPostgresqlPort = number;\n\n/** Port number for TzKt API\n * @default 5000\n */\ntype TzKtConfigApiPort = number;\n\nexport type TzKtConfig = {\n\t/** Do not start TzKt when sandbox starts */\n\tdisableAutostartWithSandbox?: boolean;\n\tpostgresqlPort?: TzKtConfigPostgresqlPort;\n\tapiPort?: TzKtConfigApiPort;\n};\n\n// ---- Project Files ----\n\nexport type Environment = {\n\tnetworks: NonEmptyString[];\n\tsandboxes: NonEmptyString[];\n\tstorage?: Record<string, NonEmptyString>;\n\taliases?: Record<string, Record<string, NonEmptyString>>;\n};\n\nexport type EphemeralState = {\n\tbuild: string;\n\tconfigHash: string;\n\n\t// Note: these were changed from a union(either type) to intersection(both types): i.e. InstalledPlugin | Task is not correct\n\n\t/** Task/Plugin Mapping */\n\ttasks: Record<string, InstalledPlugin & Task>;\n\t/** Operation/Plugin Mapping */\n\toperations: Record<string, InstalledPlugin & ParsedOperation>;\n\t/** Templates/Plugin Mapping */\n\ttemplates: Record<string, InstalledPlugin & ParsedTemplate>;\n\n\tplugins: PluginInfo[];\n};\n\nexport type PersistentState = {\n\toperations: Record<string, PersistedOperation>;\n\ttasks: Record<string, PersistedTask>;\n};\n\nexport type PersistedTask = {\n\ttask: Verb;\n\tplugin: NonEmptyString;\n\ttime: Timestamp;\n\toutput?: unknown;\n};\n\nexport type PersistedOperation = {\n\thash: SHA256;\n\ttime: Timestamp;\n\toutput?: unknown;\n};\n\n/**\n * @minLength 1\n * @pattern ^[A-Za-z0-9]+[A-Za-z0-9-_]+\\.[A-Za-z0-9]+[A-Za-z0-9-_]+\\.[A-Za-z0-9]+[A-Za-z0-9-_]+$\n */\nexport type ProvisionerID = string;\n\nexport type Provisioner = {\n\tid: ProvisionerID;\n\tplugin: NonEmptyString;\n\toperation: NonEmptyString | 'custom';\n\tcommand?: string;\n\tlabel?: string;\n\tdepends_on?: ProvisionerID[];\n};\n\nexport type Provisions = Provisioner[];\n\n// ---- Project Files: Config ----\n\n/** @minLength 1 Default environment must reference the name of an existing environment.*/\ntype EnvironmentName = NonEmptyString;\n\n/** @default en */\ntype HumanLanguage = 'en' | 'fr';\n\n/**\n * @default contracts\n * @minLength 1\n */\nexport type ConfigContractsDir = string;\n\n/**\n * @default artifacts\n * @minLength 1\n */\nexport type ConfigArtifactsDir = string;\n\nexport type Config = {\n\tlanguage?: HumanLanguage;\n\tplugins?: InstalledPlugin[];\n\tcontractsDir?: ConfigContractsDir;\n\tartifactsDir?: ConfigArtifactsDir;\n\tnetwork?: Record<string, NetworkConfig>;\n\tsandbox?: Record<string, SandboxConfig>;\n\n\t// TODO: This causes a type conflict and is not supported\n\t// accounts?: {\n\t// \tdefault: EnvironmentName;\n\t// } & Record<string, Environment>;\n\tenvironment: Record<string, Environment | EnvironmentName>;\n\taccounts?: Record<string, Tz>;\n\tcontracts?: Record<string, Contract>;\n\tmetadata?: MetadataConfig;\n};\n\n// TODO: sandbox breaks ts-to-zod\nexport type LoadedConfig = Config & {\n\tprojectDir: SanitizedAbsPath;\n\tconfigFile: SanitizedAbsPath;\n\thash: SHA256;\n};\n\nexport type MetadataConfig = {\n\tname?: string;\n\tprojectDescription?: string;\n\tauthors?: string[];\n\tlicense?: string;\n\thomepage?: string;\n};\n\nexport type NetworkConfig = {\n\tlabel: HumanReadableIdentifier;\n\trpcUrl: Url;\n\tprotocol: EconomicalProtocolHash;\n\taccounts?: Record<string, NetworkAccountConfig>;\n\tfaucet?: Faucet;\n};\n\nexport type NetworkAccountConfig = {\n\tpublicKey: NonEmptyString;\n\tpublicKeyHash: PublicKeyHash;\n\tprivateKey: NonEmptyString; /** TODO: Should this be secretKey: @see {SandboxAccountConfig} */\n};\n\nexport type SandboxAccountConfig = {\n\tencryptedKey: NonEmptyString;\n\tpublicKeyHash: PublicKeyHash;\n\tsecretKey: NonEmptyString;\n};\n\nexport type SandboxConfig = {\n\tlabel: NonEmptyString;\n\trpcUrl: Url;\n\tprotocol: EconomicalProtocolHash;\n\tattributes?: string | number | boolean;\n\tplugin?: Verb;\n\n\t// TODO: This causes a type conflict and is not supported\n\t// accounts?: {\n\t// \tdefault: NonEmptyString;\n\t// } & Record<string, SandboxAccountConfig>;\n\taccounts?: Record<string, SandboxAccountConfig | NonEmptyString>;\n\n\ttzkt?: TzKtConfig;\n};\n\nexport type ScaffoldConfig = {\n\tpostInit?: string;\n};\n\nexport type ParsedConfig = Omit<Config, 'sandbox'> & {\n\tsandbox: Record<string, SandboxConfig | NonEmptyString>;\n};\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/types.mjs

@@ -0,0 +1 @@
+//# sourceMappingURL=types.mjs.map

package/types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/tzkt-config.d.ts

@@ -20,7 +20,7 @@ export declare const generatedSchemas: {
         postgresqlPort: number;
         apiPort: number;
     } & {
-        readonly __kind: any;
+        readonly __type: any;
     }, any>;
 }, factory: {
     make: (input: {
@@ -32,14 +32,14 @@ export declare const generatedSchemas: {
         postgresqlPort: number;
         apiPort: number;
     } & {
-        readonly __kind: any;
+        readonly __type: any;
     }>;
     of: (input: unknown) => import("fluture").FutureInstance<import("./TaqError").TaqError, {
         disableAutostartWithSandbox: boolean;
         postgresqlPort: number;
         apiPort: number;
     } & {
-        readonly __kind: any;
+        readonly __type: any;
     }>;
     create: (input: {
         disableAutostartWithSandbox: boolean;
@@ -50,14 +50,14 @@ export declare const generatedSchemas: {
         postgresqlPort: number;
         apiPort: number;
     } & {
-        readonly __kind: any;
+        readonly __type: any;
     };
     from: (input: unknown) => {
         disableAutostartWithSandbox: boolean;
         postgresqlPort: number;
         apiPort: number;
     } & {
-        readonly __kind: any;
+        readonly __type: any;
     };
 };
 export type TzKtConfig = z.infer<typeof generatedSchemas.schema>;
@@ -71,13 +71,13 @@ export declare const create: (input: {
     postgresqlPort: number;
     apiPort: number;
 } & {
-    readonly __kind: any;
+    readonly __type: any;
 }, of: (input: unknown) => import("fluture").FutureInstance<import("./TaqError").TaqError, {
     disableAutostartWithSandbox: boolean;
     postgresqlPort: number;
     apiPort: number;
 } & {
-    readonly __kind: any;
+    readonly __type: any;
 }>, make: (input: {
     disableAutostartWithSandbox: boolean;
     postgresqlPort: number;
@@ -87,7 +87,7 @@ export declare const create: (input: {
     postgresqlPort: number;
     apiPort: number;
 } & {
-    readonly __kind: any;
+    readonly __type: any;
 }>;
 export declare const schemas: {
     schema: z.ZodEffects<z.ZodEffects<z.ZodType<any, z.ZodTypeDef, any>, {
@@ -95,13 +95,13 @@ export declare const schemas: {
         postgresqlPort: number;
         apiPort: number;
     } & {
-        readonly __kind: any;
+        readonly __type: any;
     }, any>, {
         disableAutostartWithSandbox: boolean;
         postgresqlPort: number;
         apiPort: number;
     } & {
-        readonly __kind: any;
+        readonly __type: any;
     }, any>;
     rawSchema: z.ZodType<any, z.ZodTypeDef, any>;
     internalSchema: z.ZodType<any, z.ZodTypeDef, any>;