@clarigen/cli 4.0.0 → 4.0.2-alpha.0

package/dist/index.d.cts

@@ -1,322 +1,252 @@
-import { ClarityAbi, ClarityAbiFunction, ClarityAbiMap, ClarityAbiVariable, ClarityAbiArg, ClarityAbiType } from '@clarigen/core';
-import * as arktype_internal_variants_object_ts from 'arktype/internal/variants/object.ts';
-import { Simnet } from '@stacks/clarinet-sdk';
-import { inspect, InspectOptions } from 'util';
+/// <reference types="node" />
+import { ClarityAbi, ClarityAbiArg, ClarityAbiFunction, ClarityAbiMap, ClarityAbiType, ClarityAbiVariable, DeploymentPlan } from "@clarigen/core";
+import * as arktype_internal_variants_object_ts0 from "arktype/internal/variants/object.ts";
+import { Simnet } from "@stacks/clarinet-sdk";
+import { InspectOptions } from "util";
 
+//#region src/session.d.ts
 interface SessionContract {
-    contract_id: string;
-    contract_interface: ClarityAbi;
-    source: string;
+  contract_id: string;
+  contract_interface: ClarityAbi;
+  source: string;
 }
 type EpochType = ClarityAbi;
 type SessionAccount = {
-    address: string;
-    balance: string;
-    name: string;
+  address: string;
+  balance: string;
+  name: string;
 };
 interface Session {
-    session_id: number;
-    accounts: SessionAccount[];
-    contracts: SessionContract[];
+  session_id: number;
+  accounts: SessionAccount[];
+  contracts: SessionContract[];
 }
 interface SessionWithVariables extends Session {
-    variables: string[];
-}
-
-declare const ClarinetConfig: arktype_internal_variants_object_ts.ObjectType<{
-    project: {
-        requirements?: {
-            contract_id: string;
-        }[] | undefined;
-        cache_location?: {
-            path: string;
-        } | undefined;
-    };
-    contracts?: {
-        [x: string]: {
-            path: string;
-        };
+  variables: string[];
+}
+//#endregion
+//#region src/clarinet-config.d.ts
+declare const ClarinetConfig: arktype_internal_variants_object_ts0.ObjectType<{
+  project: {
+    requirements?: {
+      contract_id: string;
+    }[] | undefined;
+    cache_location?: {
+      path: string;
     } | undefined;
+  };
+  contracts?: {
+    [x: string]: {
+      path: string;
+    };
+  } | undefined;
 }, {}>;
 type ClarinetConfig = typeof ClarinetConfig.infer;
 declare function getClarinetConfig(path: string): Promise<ClarinetConfig>;
-
+//#endregion
+//#region src/config.d.ts
 declare const CONFIG_FILE: "Clarigen.toml";
 declare enum OutputType {
-    ESM = "types",
-    ESM_OLD = "esm",
-    Docs = "docs"
-}
-declare const ConfigFile: arktype_internal_variants_object_ts.ObjectType<{
-    clarinet: string;
-    types?: {
-        output?: string | undefined;
-        outputs?: string[] | undefined;
-        include_accounts?: boolean | undefined;
-        after?: string | undefined;
-        include_boot_contracts?: boolean | undefined;
-        watch_folders?: string[] | undefined;
-    } | undefined;
-    esm?: {
-        output?: string | undefined;
-        outputs?: string[] | undefined;
-        include_accounts?: boolean | undefined;
-        after?: string | undefined;
-        include_boot_contracts?: boolean | undefined;
-        watch_folders?: string[] | undefined;
-    } | undefined;
-    docs?: {
-        output?: string | undefined;
-        outputs?: string[] | undefined;
-        exclude?: string[] | undefined;
-        after?: string | undefined;
-    } | undefined;
+  ESM = "types",
+  ESM_OLD = "esm",
+  Docs = "docs",
+}
+declare const ConfigFile: arktype_internal_variants_object_ts0.ObjectType<{
+  clarinet: string;
+  types?: {
+    output?: string | undefined;
+    outputs?: string[] | undefined;
+    include_accounts?: boolean | undefined;
+    after?: string | undefined;
+    include_boot_contracts?: boolean | undefined;
+    watch_folders?: string[] | undefined;
+  } | undefined;
+  esm?: {
+    output?: string | undefined;
+    outputs?: string[] | undefined;
+    include_accounts?: boolean | undefined;
+    after?: string | undefined;
+    include_boot_contracts?: boolean | undefined;
+    watch_folders?: string[] | undefined;
+  } | undefined;
+  docs?: {
+    output?: string | undefined;
+    outputs?: string[] | undefined;
+    exclude?: string[] | undefined;
+    after?: string | undefined;
+  } | undefined;
 }, {}>;
 type ConfigFile = typeof ConfigFile.infer;
 declare const defaultConfigFile: ConfigFile;
 declare class Config {
-    configFile: ConfigFile;
-    clarinet: ClarinetConfig;
-    cwd: string;
-    constructor(config: ConfigFile, clarinet: ClarinetConfig, cwd?: string);
-    static load(cwd?: string): Promise<Config>;
-    getOutputs(type: OutputType): string[];
-    outputResolve(type: OutputType, filePath?: string): string[] | null;
-    writeOutput(type: OutputType, contents: string, filePath?: string): Promise<string[] | null>;
-    supports(type: OutputType): boolean;
-    type(type: OutputType): {
-        output?: string | undefined;
-        outputs?: string[] | undefined;
-        include_accounts?: boolean | undefined;
-        after?: string | undefined;
-        include_boot_contracts?: boolean | undefined;
-        watch_folders?: string[] | undefined;
-    } | {
-        output?: string | undefined;
-        outputs?: string[] | undefined;
-        exclude?: string[] | undefined;
-        after?: string | undefined;
-    } | undefined;
-    get esm(): {
-        output?: string | undefined;
-        outputs?: string[] | undefined;
-        include_accounts?: boolean | undefined;
-        after?: string | undefined;
-        include_boot_contracts?: boolean | undefined;
-        watch_folders?: string[] | undefined;
-    } | undefined;
-    get docs(): {
-        output?: string | undefined;
-        outputs?: string[] | undefined;
-        exclude?: string[] | undefined;
-        after?: string | undefined;
-    } | undefined;
-    clarinetFile(): string;
-    joinFromClarinet(filePath: string): string;
+  configFile: ConfigFile;
+  clarinet: ClarinetConfig;
+  cwd: string;
+  constructor(config: ConfigFile, clarinet: ClarinetConfig, cwd?: string);
+  static load(cwd?: string): Promise<Config>;
+  getOutputs(type: OutputType): string[];
+  outputResolve(type: OutputType, filePath?: string): string[] | null;
+  writeOutput(type: OutputType, contents: string, filePath?: string): Promise<string[] | null>;
+  supports(type: OutputType): boolean;
+  type(type: OutputType): {
+    output?: string | undefined;
+    outputs?: string[] | undefined;
+    include_accounts?: boolean | undefined;
+    after?: string | undefined;
+    include_boot_contracts?: boolean | undefined;
+    watch_folders?: string[] | undefined;
+  } | {
+    output?: string | undefined;
+    outputs?: string[] | undefined;
+    exclude?: string[] | undefined;
+    after?: string | undefined;
+  } | undefined;
+  get esm(): {
+    output?: string | undefined;
+    outputs?: string[] | undefined;
+    include_accounts?: boolean | undefined;
+    after?: string | undefined;
+    include_boot_contracts?: boolean | undefined;
+    watch_folders?: string[] | undefined;
+  } | undefined;
+  get docs(): {
+    output?: string | undefined;
+    outputs?: string[] | undefined;
+    exclude?: string[] | undefined;
+    after?: string | undefined;
+  } | undefined;
+  clarinetFile(): string;
+  joinFromClarinet(filePath: string): string;
 }
 declare function configFilePath(cwd?: string): string;
 declare function saveConfig(config: ConfigFile): Promise<void>;
 declare function getConfig(cwd?: string): Promise<ConfigFile>;
-
+//#endregion
+//#region src/docs/index.d.ts
 declare const FN_TYPES: readonly ["read-only", "public", "private"];
 declare const VAR_TYPES: readonly ["map", "data-var", "constant"];
 type ClarityAbiItem = ClarityAbiFunction | ClarityAbiMap | ClarityAbiVariable;
 type ClaridocItemType<T extends ClarityAbiItem> = {
-    abi: T;
-    comments: Comments;
-    startLine: number;
-    source: string[];
+  abi: T;
+  comments: Comments;
+  startLine: number;
+  source: string[];
 };
 type ClaridocFunction = ClaridocItemType<ClarityAbiFunction>;
 type ClaridocMap = ClaridocItemType<ClarityAbiMap>;
 type ClaridocVariable = ClaridocItemType<ClarityAbiVariable>;
 interface ClaridocItem {
-    abi: ClarityAbiItem;
-    comments: Comments;
-    startLine: number;
-    source: string[];
+  abi: ClarityAbiItem;
+  comments: Comments;
+  startLine: number;
+  source: string[];
 }
 interface Comments {
-    params: Record<string, ClaridocParam>;
-    text: string[];
+  params: Record<string, ClaridocParam>;
+  text: string[];
 }
 interface ClaridocContract {
-    functions: ClaridocFunction[];
-    maps: ClaridocMap[];
-    variables: ClaridocVariable[];
-    comments: string[];
+  functions: ClaridocFunction[];
+  maps: ClaridocMap[];
+  variables: ClaridocVariable[];
+  comments: string[];
 }
 interface ClaridocParam {
-    abi: ClarityAbiArg;
-    comments: string[];
-}
-declare function createContractDocInfo({ contractSrc, abi, }: {
-    contractSrc: string;
-    abi: ClarityAbi;
+  abi: ClarityAbiArg;
+  comments: string[];
+}
+declare function createContractDocInfo({
+  contractSrc,
+  abi
+}: {
+  contractSrc: string;
+  abi: ClarityAbi;
 }): ClaridocContract;
 declare function isComment(line: string): boolean;
 declare function getFnName(line: string): string | undefined;
 declare function traceParens(line: string, count: number): number;
 declare function parseComments(comments: string[], abi: ClarityAbiItem): Comments;
 declare function afterDocs(config: Config): Promise<void>;
-
-declare function generateMarkdown({ contract, contractFile, withToc, }: {
-    contract: SessionContract;
-    contractFile?: string;
-    withToc?: boolean;
+//#endregion
+//#region src/docs/markdown.d.ts
+declare function generateMarkdown({
+  contract,
+  contractFile,
+  withToc
+}: {
+  contract: SessionContract;
+  contractFile?: string;
+  withToc?: boolean;
 }): string;
 declare function markdownFunction(fn: ClaridocFunction, contractFile?: string): string;
 declare function generateReadme(session: Session, excluded: Record<string, boolean>): string;
-
-declare function generateDocs({ session, config, }: {
-    session: SessionWithVariables;
-    config: Config;
+//#endregion
+//#region src/files/docs.d.ts
+declare function generateDocs({
+  session,
+  config
+}: {
+  session: SessionWithVariables;
+  config: Config;
 }): Promise<void>;
-
+//#endregion
+//#region src/files/variables.d.ts
 declare function getVariablesV2(contract: SessionContract, simnet: Simnet, verbose?: boolean): any;
 declare function mapVariables(session: Session, simnet: Simnet): string[];
-
+//#endregion
+//#region src/files/base.d.ts
 declare function generateContractMeta(contract: SessionContract, constants: string): string;
 declare const TYPE_IMPORTS = "import type { TypedAbiArg, TypedAbiFunction, TypedAbiMap, TypedAbiVariable, Response } from '@clarigen/core';";
 declare function generateBaseFile(session: SessionWithVariables): string;
 declare function encodeVariables(variables: ClarityAbiVariable[]): string[];
 declare global {
-    interface Uint8Array {
-        [inspect.custom](depth: number, options: InspectOptions): string;
-    }
+  interface Uint8Array {
+    [inspect.custom](depth: number, options: InspectOptions): string;
+  }
 }
 declare function serialize(obj: any): string;
-
-interface EmulatedContractPublishTransaction {
-    'emulated-contract-publish': {
-        'contract-name': string;
-        'emulated-sender': string;
-        path: string;
-    };
-}
-interface RequirementPublishTransaction {
-    'requirement-publish': {
-        'contract-id': string;
-        'remap-sender': string;
-        'remap-principals': Record<string, string>;
-        path: string;
-    };
-}
-interface ContractPublishTransaction {
-    'contract-publish': {
-        'contract-name': string;
-        'expected-sender': string;
-        path: string;
-    };
-}
-interface ContractCallTransaction {
-    'contract-call': {
-        'contract-id': string;
-        'expected-sender': string;
-        parameters: Readonly<string[]>;
-        method: string;
-    };
-}
-interface EmulatedContractCallTransaction {
-    'emulated-contract-call': {
-        'contract-id': string;
-        'emulated-sender': string;
-        parameters: Readonly<string[]>;
-        method: string;
-    };
-}
-interface BtcTransferTransaction {
-    'btc-transfer': {
-        'expected-sender': string;
-        recipient: string;
-        'sats-per-byte': string;
-        'sats-amount': string;
-    };
-}
-type Transaction = EmulatedContractPublishTransaction | RequirementPublishTransaction | ContractPublishTransaction | EmulatedContractCallTransaction | BtcTransferTransaction | ContractCallTransaction;
-type ContractTransaction = EmulatedContractPublishTransaction | RequirementPublishTransaction | ContractPublishTransaction;
-interface Batch<T extends Transaction> {
-    id: number;
-    transactions: Readonly<T[]>;
-}
-interface SimnetAccount {
-    address: string;
-    name: string;
-    balance: string;
-}
-interface SimnetAccountDeployer extends SimnetAccount {
-    name: 'deployer';
-}
-interface SimnetDeploymentPlan {
-    network: 'simnet';
-    genesis: {
-        wallets: Readonly<[SimnetAccountDeployer, ...SimnetAccount[]]>;
-        contracts: Readonly<string[]>;
-    };
-    plan: {
-        batches: Readonly<Batch<EmulatedContractPublishTransaction | EmulatedContractCallTransaction>[]>;
-    };
-}
-interface DevnetDeploymentPlan {
-    network: 'devnet';
-    plan: {
-        batches: Readonly<Batch<RequirementPublishTransaction | ContractPublishTransaction | ContractCallTransaction | BtcTransferTransaction>[]>;
-    };
-}
-type TestnetDeploymentPlan = Omit<DevnetDeploymentPlan, 'network'> & {
-    network: 'testnet';
-};
-interface MainnetDeploymentPlan {
-    network: 'mainnet';
-    plan: {
-        batches: Readonly<Batch<ContractPublishTransaction | ContractCallTransaction | BtcTransferTransaction>[]>;
-    };
-}
-type DeploymentPlan = SimnetDeploymentPlan | DevnetDeploymentPlan | TestnetDeploymentPlan | MainnetDeploymentPlan;
-declare function flatBatch<T extends Transaction>(batches: Batch<T>[]): T[];
-declare function getContractTxs(batches: Batch<Transaction>[]): ContractTransaction[];
-declare function getDeploymentContract(contractName: string, deployment: DeploymentPlan): ContractTransaction;
-declare function getDeploymentTxPath(tx: ContractTransaction): string;
-declare function getIdentifier(tx: ContractTransaction): string;
-declare function isContractTx(tx: Transaction): tx is ContractTransaction;
-
+//#endregion
+//#region src/files/esm.d.ts
 declare function parseDeployment(path: string): Promise<Plan>;
 declare const DEPLOYMENT_NETWORKS: readonly ["devnet", "simnet", "testnet", "mainnet"];
 type DeploymentNetwork = (typeof DEPLOYMENT_NETWORKS)[number];
 type Plan = DeploymentPlan | undefined;
-type DeploymentsMap = {
-    [key in DeploymentNetwork]: Plan;
-};
+type DeploymentsMap = { [key in DeploymentNetwork]: Plan };
 declare function getDeployments(config: Config): Promise<DeploymentsMap>;
-declare function generateESMFile({ baseFile, session, config, }: {
-    baseFile: string;
-    session: Session;
-    config: Config;
+declare function generateESMFile({
+  baseFile,
+  session,
+  config
+}: {
+  baseFile: string;
+  session: Session;
+  config: Config;
 }): Promise<string>;
-type ContractDeployments = {
-    [key in DeploymentNetwork]: string | null;
-};
+type ContractDeployments = { [key in DeploymentNetwork]: string | null };
 type FullContractDeployments = {
-    [contractName: string]: ContractDeployments;
+  [contractName: string]: ContractDeployments;
 };
 declare function collectContractDeployments(session: Session, deployments: DeploymentsMap, config: Config): FullContractDeployments;
 declare function collectDeploymentFiles(deployments: DeploymentsMap, clarinetFolder: string, cwd: string): {
-    identifier: string;
-    file: string;
+  identifier: string;
+  file: string;
 }[];
 declare function afterESM(config: Config): Promise<void>;
-
+//#endregion
+//#region src/declaration.d.ts
 declare const jsTypeFromAbiType: (val: ClarityAbiType, isArgument?: boolean) => string;
 declare function abiArgType(arg: ClarityAbiArg): string;
 declare function abiFunctionType(abiFunction: ClarityAbiFunction): string;
 declare function getArgName(name: string): string;
-
+//#endregion
+//#region src/utils.d.ts
 declare function encodeVariableName(name: string): string;
 declare function fileExists(filename: string): Promise<boolean>;
 declare function writeFile(path: string, contents: string): Promise<string>;
 declare function cwdRelative(path: string): string;
 declare function sortContracts<T extends {
-    contract_id: string;
+  contract_id: string;
 }>(contracts: T[]): T[];
-
-export { type Batch, CONFIG_FILE, type ClaridocContract, type ClaridocFunction, type ClaridocItem, type ClaridocMap, type ClaridocParam, type ClaridocVariable, ClarinetConfig, type Comments, Config, ConfigFile, type ContractDeployments, type ContractTransaction, DEPLOYMENT_NETWORKS, type DeploymentNetwork, type DeploymentPlan, type DevnetDeploymentPlan, type EpochType, FN_TYPES, type FullContractDeployments, type MainnetDeploymentPlan, OutputType, type Session, type SessionAccount, type SessionContract, type SessionWithVariables, type SimnetAccountDeployer, type SimnetDeploymentPlan, TYPE_IMPORTS, type TestnetDeploymentPlan, type Transaction, VAR_TYPES, abiArgType, abiFunctionType, afterDocs, afterESM, collectContractDeployments, collectDeploymentFiles, configFilePath, createContractDocInfo, cwdRelative, defaultConfigFile, encodeVariableName, encodeVariables, fileExists, flatBatch, generateBaseFile, generateContractMeta, generateDocs, generateESMFile, generateMarkdown, generateReadme, getArgName, getClarinetConfig, getConfig, getContractTxs, getDeploymentContract, getDeploymentTxPath, getDeployments, getFnName, getIdentifier, getVariablesV2, isComment, isContractTx, jsTypeFromAbiType, mapVariables, markdownFunction, parseComments, parseDeployment, saveConfig, serialize, sortContracts, traceParens, writeFile };
+//#endregion
+export { CONFIG_FILE, ClaridocContract, ClaridocFunction, ClaridocItem, ClaridocMap, ClaridocParam, ClaridocVariable, ClarinetConfig, Comments, Config, ConfigFile, ContractDeployments, DEPLOYMENT_NETWORKS, DeploymentNetwork, EpochType, FN_TYPES, FullContractDeployments, OutputType, Session, SessionAccount, SessionContract, SessionWithVariables, TYPE_IMPORTS, VAR_TYPES, abiArgType, abiFunctionType, afterDocs, afterESM, collectContractDeployments, collectDeploymentFiles, configFilePath, createContractDocInfo, cwdRelative, defaultConfigFile, encodeVariableName, encodeVariables, fileExists, generateBaseFile, generateContractMeta, generateDocs, generateESMFile, generateMarkdown, generateReadme, getArgName, getClarinetConfig, getConfig, getDeployments, getFnName, getVariablesV2, isComment, jsTypeFromAbiType, mapVariables, markdownFunction, parseComments, parseDeployment, saveConfig, serialize, sortContracts, traceParens, writeFile };
+//# sourceMappingURL=index.d.cts.map