clippium-toolkit - API documentation

Classes

Converter<Plugins>

Type Parameters

Type Parameter
Plugins extends {}

Constructors

new Converter()

new Converter<Plugins>(plugins: Plugins, fnData: FnData<ClippiumData>): Converter<Plugins>

Parameters

Parameter	Type
plugins	Plugins
fnData	FnData<ClippiumData>

Returns

Converter<Plugins>

Methods

fromData()

fromData(key: string): Promise<void>

Parameters

Parameter	Type
key	string

Returns

Promise<void>

toData()

toData(key: string): Promise<void>

Parameters

Parameter	Type
key	string

Returns

Promise<void>

toDataSchema()

toDataSchema(key: string): Promise<void>

Parameters

Parameter	Type
key	string

Returns

Promise<void>

---

ESMFunctions

Implements

• CreateInterface

Constructors

new ESMFunctions()

new ESMFunctions(): ESMFunctions

Returns

ESMFunctions

Methods

convertToData()

convertToData(i: Input, opts?: {
  name: string;
}): Promise<ClippiumData>

Parameters

Parameter	Type
i	Input
opts?	object
opts.name?	string

Returns

Promise<ClippiumData>

Implementation of

CreateInterface.convertToData

---

JSONSchemaGneneric

Implements

• CreateInterface

Constructors

new JSONSchemaGneneric()

new JSONSchemaGneneric(): JSONSchemaGneneric

Returns

JSONSchemaGneneric

Methods

convertFromData()

convertFromData(input: ClippiumData, opts?: {
  output: string;
  type: SchemaType;
}): Promise<string>

Parameters

Parameter	Type
input	ClippiumData
opts?	object
opts.output?	string
opts.type?	SchemaType

Returns

Promise<string>

Implementation of

CreateInterface.convertFromData

convertToData()

convertToData(i: Input): Promise<ClippiumData>

Parameters

Parameter	Type
i	Input

Returns

Promise<ClippiumData>

Implementation of

CreateInterface.convertToData

---

Markdown

Constructors

new Markdown()

new Markdown(): Markdown

Returns

Markdown

Methods

getDocs()

getDocs(input: ClippiumData, opts?: DocsConfig): Promise<string>

Retrieves and processes documentation data from the given ClippiumData input.

Parameters

Parameter	Type	Description
input	ClippiumData	The ClippiumData object that contains the documentation data.
opts?	DocsConfig	Optional configuration for the documentation.

Returns

Promise<string>

A promise that resolves to a string representing the processed documentation.

---

OpenAPI

Implements

• CreateInterface

Constructors

new OpenAPI()

new OpenAPI(): OpenAPI

Returns

OpenAPI

Methods

convertFromData()

convertFromData(_input: ClippiumData): Promise<string>

Parameters

Parameter	Type
_input	ClippiumData

Returns

Promise<string>

Implementation of

CreateInterface.convertFromData

convertToData()

convertToData(i: Input, opts?: ParserOptions): Promise<ClippiumData>

Parameters

Parameter	Type
i	Input
opts?	ParserOptions

Returns

Promise<ClippiumData>

Implementation of

CreateInterface.convertToData

validate()

validate(i: any): Promise<JSONSchema7>

Parameters

Parameter	Type
i	any

Returns

Promise<JSONSchema7>

---

TypeScript

Implements

• CreateInterface

Constructors

new TypeScript()

new TypeScript(): TypeScript

Returns

TypeScript

Methods

convertFromData()

convertFromData(i: ClippiumData, opts: {
  asConst: boolean;
  type: string;
}): Promise<string>

Parameters

Parameter	Type
i	ClippiumData
opts	object
opts.asConst?	boolean
opts.type?	string

Returns

Promise<string>

Implementation of

CreateInterface.convertFromData

convertToData()

convertToData(i: Input, opts: {
  tsconfig: string;
  type: string;
}): Promise<ClippiumData>

Parameters

Parameter	Type
i	Input
opts	object
opts.tsconfig?	string
opts.type	string

Returns

Promise<ClippiumData>

Implementation of

CreateInterface.convertToData

Functions

createPlugin()

function createPlugin<To, From, Docs>(plugin: Plugin<To, From, Docs>): Plugin<To, From, Docs>

Type Parameters

Type Parameter
To extends undefined | Flags$2
From extends undefined | Flags$2
Docs extends undefined | Flags$2

Parameters

Parameter	Type
plugin	Plugin<To, From, Docs>

Returns

Plugin<To, From, Docs>

---

defineConfig()

function defineConfig<C>(config: C): C

Defines and returns the provided configuration object.

Type Parameters

Type Parameter	Description
C extends Config	Must extend from Config.

Parameters

Parameter	Type	Description
config	C	The configuration object to define.

Returns

C

• Returns the provided configuration object.

---

run()

function run(args: string[]): Promise<void>

The main function to run the CLI.

Parameters

Parameter	Type	Description
args	string[]	The argument vector array.

Returns

Promise<void>

• Resolves when the function has finished.

Type Aliases

AnyPlugin

type AnyPlugin: Plugin<Any, Any, Any>;

---

Config

type Config: {
  plugin: Plugins;
};

Type declaration

Name	Type	Description
plugin	Plugins	Set plugins for clippium toolkit

---

Plugin<To, From, Docs>

type Plugin<To, From, Docs>: {
  convert: {
     fromData: {
        examples: ClippiumData["examples"];
        flags: From;
        fn: (utils: PluginUtils<From> & {
           input: ClippiumData;
          }) => Promise<string>;
       };
     toData: {
        examples: ClippiumData["examples"];
        flags: To;
        fn: (utils: PluginUtils<To> & {
           input: string;
          }) => Promise<ClippiumData>;
       };
    };
  desc: string;
  docs: {
     examples: ClippiumData["examples"];
     flags: Docs;
     fn: (utils: PluginUtils<Docs> & {
        input: ClippiumData;
       }) => Promise<string>;
    };
};

Type Parameters

Type Parameter
To extends ClippiumData["flags"]
From extends ClippiumData["flags"]
Docs extends ClippiumData["flags"]

Type declaration

Name	Type	Description
convert?	{ fromData: { examples: ClippiumData["examples"]; flags: From; fn: (utils: PluginUtils<From> & { input: ClippiumData; }) => Promise<string>; }; toData: { examples: ClippiumData["examples"]; flags: To; fn: (utils: PluginUtils<To> & { input: string; }) => Promise<ClippiumData>; }; }	Convert function for plugin
convert.fromData?	{ examples: ClippiumData["examples"]; flags: From; fn: (utils: PluginUtils<From> & { input: ClippiumData; }) => Promise<string>; }	-
convert.fromData.examples?	ClippiumData["examples"]	Add usage examples for the plugin command
convert.fromData.flags?	From	Add custom flags for use in plugin command
convert.fromData.fn	(utils: PluginUtils<From> & { input: ClippiumData; }) => Promise<string>	-
convert.toData?	{ examples: ClippiumData["examples"]; flags: To; fn: (utils: PluginUtils<To> & { input: string; }) => Promise<ClippiumData>; }	-
convert.toData.examples?	ClippiumData["examples"]	Add usage examples for the plugin command
convert.toData.flags?	To	Add custom flags for use in plugin command
convert.toData.fn	(utils: PluginUtils<To> & { input: string; }) => Promise<ClippiumData>	-
desc?	string	Plugin description
docs?	{ examples: ClippiumData["examples"]; flags: Docs; fn: (utils: PluginUtils<Docs> & { input: ClippiumData; }) => Promise<string>; }	Docs function for plugin
docs.examples?	ClippiumData["examples"]	Add usage examples for the plugin command
docs.flags?	Docs	Add custom flags for use in plugin command
docs.fn	(utils: PluginUtils<Docs> & { input: ClippiumData; }) => Promise<string>	-

---

Plugins

type Plugins: Record<string, AnyPlugin>;

Variables

cli

const cli: Clippium<{
  commands: {
     add: {
        desc: string;
        examples: {
           desc: 'Add a CLI to "./my-cli.js"';
           value: '$0 -n my-cli -o ./my-cli.js';
          }[];
        flags: {
           desc: {
              desc: 'Set CLI description';
              type: 'string';
             };
           name: {
              alias: string[];
              desc: 'Set CLI name';
              type: 'string';
             };
           output: {
              alias: string[];
              desc: 'Set CLI output file';
              type: 'string';
             };
           project-version: {
              desc: 'Set CLI version';
              type: 'string';
             };
          };
       };
     convert: {
        desc: 'Transform input to and from "clippium data" based on multiple content types';
        examples: {
           desc: 'Convert from OpenAPI to clippium data';
           value: '$0 openapi to-data -i https://petstore.swagger.io/v2/swagger.json -o ./src/data.js';
          }[];
       };
     docs: {
        desc: 'Generate documentation from clippium data';
       };
     init: {
        desc: string;
        examples: {
           desc: 'Prompt to create a new clippium CLI project named "my-cli"';
           value: '$0 --name my-cli';
          }[];
        flags: {
           installer: {
              choices: (
                 | "none"
                 | "deno"
                 | "bun"
                 | "npm"
                 | "pnpm"
                 | "yarn")[];
              desc: 'Manager for installing dependencies';
              type: 'choices';
             };
           name: {
              alias: string[];
              desc: 'Project name';
              type: 'string';
             };
           openEditor: {
              choices: ("none" | "code" | "subl" | "webstorm")[];
              desc: 'Open editor';
              type: 'choices';
             };
           output: {
              alias: string[];
              desc: 'Output directory';
              type: 'string';
             };
           template: {
              choices: ("js" | "ts")[];
              desc: 'Input directory';
              type: 'choices';
             };
          };
       };
    };
  flags: any;
  name: string;
  version: string;
}>;

Type declaration

Name	Type	Default value
commands	{ add: { desc: string; examples: { desc: 'Add a CLI to "./my-cli.js"'; value: '$0 -n my-cli -o ./my-cli.js'; }[]; flags: { desc: { desc: 'Set CLI description'; type: 'string'; }; name: { alias: string[]; desc: 'Set CLI name'; type: 'string'; }; output: { alias: string[]; desc: 'Set CLI output file'; type: 'string'; }; project-version: { desc: 'Set CLI version'; type: 'string'; }; }; }; convert: { desc: 'Transform input to and from "clippium data" based on multiple content types'; examples: { desc: 'Convert from OpenAPI to clippium data'; value: '$0 openapi to-data -i https://petstore.swagger.io/v2/swagger.json -o ./src/data.js'; }[]; }; docs: { desc: 'Generate documentation from clippium data'; }; init: { desc: string; examples: { desc: 'Prompt to create a new clippium CLI project named "my-cli"'; value: '$0 --name my-cli'; }[]; flags: { installer: { choices: ( | "none" | "deno" | "bun" | "npm" | "pnpm" | "yarn")[]; desc: 'Manager for installing dependencies'; type: 'choices'; }; name: { alias: string[]; desc: 'Project name'; type: 'string'; }; openEditor: { choices: ("none" | "code" | "subl" | "webstorm")[]; desc: 'Open editor'; type: 'choices'; }; output: { alias: string[]; desc: 'Output directory'; type: 'string'; }; template: { choices: ("js" | "ts")[]; desc: 'Input directory'; type: 'choices'; }; }; }; }	-
commands.add	{ desc: string; examples: { desc: 'Add a CLI to "./my-cli.js"'; value: '$0 -n my-cli -o ./my-cli.js'; }[]; flags: { desc: { desc: 'Set CLI description'; type: 'string'; }; name: { alias: string[]; desc: 'Set CLI name'; type: 'string'; }; output: { alias: string[]; desc: 'Set CLI output file'; type: 'string'; }; project-version: { desc: 'Set CLI version'; type: 'string'; }; }; }	-
commands.add.desc	string	-
commands.add.examples	{ desc: 'Add a CLI to "./my-cli.js"'; value: '$0 -n my-cli -o ./my-cli.js'; }[]	-
commands.add.flags	{ desc: { desc: 'Set CLI description'; type: 'string'; }; name: { alias: string[]; desc: 'Set CLI name'; type: 'string'; }; output: { alias: string[]; desc: 'Set CLI output file'; type: 'string'; }; project-version: { desc: 'Set CLI version'; type: 'string'; }; }	-
commands.add.flags.desc	{ desc: 'Set CLI description'; type: 'string'; }	-
commands.add.flags.desc.desc	string	'Set CLI description'
commands.add.flags.desc.type	"string"	'string'
commands.add.flags.name	{ alias: string[]; desc: 'Set CLI name'; type: 'string'; }	-
commands.add.flags.name.alias	string[]	-
commands.add.flags.name.desc	string	'Set CLI name'
commands.add.flags.name.type	"string"	'string'
commands.add.flags.output	{ alias: string[]; desc: 'Set CLI output file'; type: 'string'; }	-
commands.add.flags.output.alias	string[]	-
commands.add.flags.output.desc	string	'Set CLI output file'
commands.add.flags.output.type	"string"	'string'
commands.add.flags.project-version	{ desc: 'Set CLI version'; type: 'string'; }	-
commands.add.flags.project-version.desc	string	'Set CLI version'
commands.add.flags.project-version.type	"string"	'string'
commands.convert	{ desc: 'Transform input to and from "clippium data" based on multiple content types'; examples: { desc: 'Convert from OpenAPI to clippium data'; value: '$0 openapi to-data -i https://petstore.swagger.io/v2/swagger.json -o ./src/data.js'; }[]; }	-
commands.convert.desc	string	'Transform input to and from "clippium data" based on multiple content types'
commands.convert.examples	{ desc: 'Convert from OpenAPI to clippium data'; value: '$0 openapi to-data -i https://petstore.swagger.io/v2/swagger.json -o ./src/data.js'; }[]	-
commands.docs	{ desc: 'Generate documentation from clippium data'; }	-
commands.docs.desc	string	'Generate documentation from clippium data'
commands.init	{ desc: string; examples: { desc: 'Prompt to create a new clippium CLI project named "my-cli"'; value: '$0 --name my-cli'; }[]; flags: { installer: { choices: ( | "none" | "deno" | "bun" | "npm" | "pnpm" | "yarn")[]; desc: 'Manager for installing dependencies'; type: 'choices'; }; name: { alias: string[]; desc: 'Project name'; type: 'string'; }; openEditor: { choices: ("none" | "code" | "subl" | "webstorm")[]; desc: 'Open editor'; type: 'choices'; }; output: { alias: string[]; desc: 'Output directory'; type: 'string'; }; template: { choices: ("js" | "ts")[]; desc: 'Input directory'; type: 'choices'; }; }; }	-
commands.init.desc	string	-
commands.init.examples	{ desc: 'Prompt to create a new clippium CLI project named "my-cli"'; value: '$0 --name my-cli'; }[]	-
commands.init.flags	{ installer: { choices: ( | "none" | "deno" | "bun" | "npm" | "pnpm" | "yarn")[]; desc: 'Manager for installing dependencies'; type: 'choices'; }; name: { alias: string[]; desc: 'Project name'; type: 'string'; }; openEditor: { choices: ("none" | "code" | "subl" | "webstorm")[]; desc: 'Open editor'; type: 'choices'; }; output: { alias: string[]; desc: 'Output directory'; type: 'string'; }; template: { choices: ("js" | "ts")[]; desc: 'Input directory'; type: 'choices'; }; }	-
commands.init.flags.installer	{ choices: ( | "none" | "deno" | "bun" | "npm" | "pnpm" | "yarn")[]; desc: 'Manager for installing dependencies'; type: 'choices'; }	-
commands.init.flags.installer.choices	( | "none" | "deno" | "bun" | "npm" | "pnpm" | "yarn")[]	-
commands.init.flags.installer.desc	string	'Manager for installing dependencies'
commands.init.flags.installer.type	"choices"	'choices'
commands.init.flags.name	{ alias: string[]; desc: 'Project name'; type: 'string'; }	-
commands.init.flags.name.alias	string[]	-
commands.init.flags.name.desc	string	'Project name'
commands.init.flags.name.type	"string"	'string'
commands.init.flags.openEditor	{ choices: ("none" | "code" | "subl" | "webstorm")[]; desc: 'Open editor'; type: 'choices'; }	-
commands.init.flags.openEditor.choices	("none" | "code" | "subl" | "webstorm")[]	-
commands.init.flags.openEditor.desc	string	'Open editor'
commands.init.flags.openEditor.type	"choices"	'choices'
commands.init.flags.output	{ alias: string[]; desc: 'Output directory'; type: 'string'; }	-
commands.init.flags.output.alias	string[]	-
commands.init.flags.output.desc	string	'Output directory'
commands.init.flags.output.type	"string"	'string'
commands.init.flags.template	{ choices: ("js" | "ts")[]; desc: 'Input directory'; type: 'choices'; }	-
commands.init.flags.template.choices	("js" | "ts")[]	-
commands.init.flags.template.desc	string	'Input directory'
commands.init.flags.template.type	"choices"	'choices'
flags	any	-
name	string	-
version	string	-