Skip to main content

API Report File for "@kadena/pactjs-generator"

Do not edit this file. It is a report generated by API Extractor.

/// <reference types="node" />
 
import { PathLike } from 'fs';
 
// @alpha (undocumented)
export class FileContractDefinition implements IContractDefinition {
  constructor({
    path,
    namespace,
    logger,
  }: {
    path: PathLike;
    namespace?: string;
    logger?: ILogger;
  });
  // Warning: (ae-forgotten-export) The symbol "Defcap" needs to be exported by the entry point index.d.ts
  //
  // (undocumented)
  getCapabilities(moduleName: string): Record<string, Defcap> | undefined;
  // Warning: (ae-forgotten-export) The symbol "Defun" needs to be exported by the entry point index.d.ts
  //
  // (undocumented)
  getMethods(moduleName: string): Record<string, Defun> | undefined;
  // (undocumented)
  getNamespace(moduleName: string): string;
  // (undocumented)
  get modules(): string[] | undefined;
  // Warning: (ae-forgotten-export) The symbol "Output" needs to be exported by the entry point index.d.ts
  //
  // (undocumented)
  get modulesWithFunctions(): Output;
}
 
// Warning: (ae-forgotten-export) The symbol "IModule" needs to be exported by the entry point index.d.ts
//
// @alpha (undocumented)
export function generateDts(
  moduleFullName: string,
  modules: Record<string, IModule>,
): string;
 
// @alpha (undocumented)
export function generateTemplates(
  templates: {
    name: string;
    template: ITemplate;
  }[],
  version: string,
): string;
 
// @alpha (undocumented)
export interface IContractDefinition {
  // (undocumented)
  getCapabilities(moduleName: string): Record<string, Defcap> | undefined;
  // (undocumented)
  getMethods(moduleName: string): Record<string, Defun> | undefined;
  // (undocumented)
  getNamespace(moduleName: string): string;
  // (undocumented)
  get modules(): string[] | undefined;
  // (undocumented)
  get modulesWithFunctions(): Output;
}
 
// @alpha (undocumented)
export interface ITemplate {
  // (undocumented)
  holes: TemplateHoles;
  // (undocumented)
  parts: TemplateParts;
}
 
// @alpha (undocumented)
export function pactParser({
  contractNames,
  files,
  getContract,
  namespace,
}: {
  contractNames?: string[];
  files?: string[];
  getContract: (fullName: string) => Promise<string>;
  namespace?: string;
}): Promise<{
  [k: string]: IModule;
}>;
 
// @alpha (undocumented)
export function parseTemplate(template: string): ITemplate;
 
// @alpha (undocumented)
export class StringContractDefinition implements IContractDefinition {
  constructor({
    contract,
    namespace,
    logger,
  }: {
    contract: string;
    namespace?: string;
    logger?: ILogger;
  });
  // (undocumented)
  getCapabilities(moduleName: string): Record<string, Defcap> | undefined;
  // (undocumented)
  getMethods(moduleName: string): Record<string, Defun> | undefined;
  // (undocumented)
  getNamespace(moduleName: string): string;
  // (undocumented)
  get modules(): string[] | undefined;
  // (undocumented)
  get modulesWithFunctions(): Output;
}
 
// @alpha (undocumented)
export type TemplateHoles = string[];
 
// @alpha (undocumented)
export type TemplateParts = string[];
 
// Warnings were encountered during analysis:
//
// src/contract/generation/FileContractDefinition.ts:23:5 - (ae-forgotten-export) The symbol "ILogger" needs to be exported by the entry point index.d.ts
 
// (No @packageDocumentation comment for this package)
/// <reference types="node" />
 
import { PathLike } from 'fs';
 
// @alpha (undocumented)
export class FileContractDefinition implements IContractDefinition {
  constructor({
    path,
    namespace,
    logger,
  }: {
    path: PathLike;
    namespace?: string;
    logger?: ILogger;
  });
  // Warning: (ae-forgotten-export) The symbol "Defcap" needs to be exported by the entry point index.d.ts
  //
  // (undocumented)
  getCapabilities(moduleName: string): Record<string, Defcap> | undefined;
  // Warning: (ae-forgotten-export) The symbol "Defun" needs to be exported by the entry point index.d.ts
  //
  // (undocumented)
  getMethods(moduleName: string): Record<string, Defun> | undefined;
  // (undocumented)
  getNamespace(moduleName: string): string;
  // (undocumented)
  get modules(): string[] | undefined;
  // Warning: (ae-forgotten-export) The symbol "Output" needs to be exported by the entry point index.d.ts
  //
  // (undocumented)
  get modulesWithFunctions(): Output;
}
 
// Warning: (ae-forgotten-export) The symbol "IModule" needs to be exported by the entry point index.d.ts
//
// @alpha (undocumented)
export function generateDts(
  moduleFullName: string,
  modules: Record<string, IModule>,
): string;
 
// @alpha (undocumented)
export function generateTemplates(
  templates: {
    name: string;
    template: ITemplate;
  }[],
  version: string,
): string;
 
// @alpha (undocumented)
export interface IContractDefinition {
  // (undocumented)
  getCapabilities(moduleName: string): Record<string, Defcap> | undefined;
  // (undocumented)
  getMethods(moduleName: string): Record<string, Defun> | undefined;
  // (undocumented)
  getNamespace(moduleName: string): string;
  // (undocumented)
  get modules(): string[] | undefined;
  // (undocumented)
  get modulesWithFunctions(): Output;
}
 
// @alpha (undocumented)
export interface ITemplate {
  // (undocumented)
  holes: TemplateHoles;
  // (undocumented)
  parts: TemplateParts;
}
 
// @alpha (undocumented)
export function pactParser({
  contractNames,
  files,
  getContract,
  namespace,
}: {
  contractNames?: string[];
  files?: string[];
  getContract: (fullName: string) => Promise<string>;
  namespace?: string;
}): Promise<{
  [k: string]: IModule;
}>;
 
// @alpha (undocumented)
export function parseTemplate(template: string): ITemplate;
 
// @alpha (undocumented)
export class StringContractDefinition implements IContractDefinition {
  constructor({
    contract,
    namespace,
    logger,
  }: {
    contract: string;
    namespace?: string;
    logger?: ILogger;
  });
  // (undocumented)
  getCapabilities(moduleName: string): Record<string, Defcap> | undefined;
  // (undocumented)
  getMethods(moduleName: string): Record<string, Defun> | undefined;
  // (undocumented)
  getNamespace(moduleName: string): string;
  // (undocumented)
  get modules(): string[] | undefined;
  // (undocumented)
  get modulesWithFunctions(): Output;
}
 
// @alpha (undocumented)
export type TemplateHoles = string[];
 
// @alpha (undocumented)
export type TemplateParts = string[];
 
// Warnings were encountered during analysis:
//
// src/contract/generation/FileContractDefinition.ts:23:5 - (ae-forgotten-export) The symbol "ILogger" needs to be exported by the entry point index.d.ts
 
// (No @packageDocumentation comment for this package)

Receive important developer updates