awesome-gadgets/scripts/modules/types.d.ts

Storage, management, compilation, and automatic deployment of MediaWiki gadgets.

import {type Mwn} from 'mwn';

interface Api {
	apiInstance: Mwn;
	site: string;
}

interface BuiltFile {
	path: string;
	text: string;
}

type BuiltFiles = BuiltFile[];

interface CredentialsOnlyOAuth {
	apiUrl: string;
	OAuthCredentials: {
		accessToken: string;
		accessSecret: string;
		consumerToken: string;
		consumerSecret: string;
	};
}

interface CredentialsOnlyOAuth2 {
	apiUrl: string;
	OAuth2AccessToken: string;
}

interface CredentialsOnlyPassword {
	apiUrl: string;
	username: string;
	password: string;
}

type Credentials = CredentialsOnlyOAuth | CredentialsOnlyOAuth2 | CredentialsOnlyPassword;

interface DefaultDefinition {
	enable: boolean;
	description: string;
	section: string;
	excludeSites: string[];
	externalPackages: string[];
	actions: string[];
	contentModels: string[];
	default: boolean;
	dependencies: string[];
	hidden: boolean;
	namespaces: number[];
	peers: string[];
	rights: string[];
	skins: string[];
	supportsUrlLoad: boolean;
}

interface DefaultSectionMap {
	[key: DefaultDefinition['section']]: string;
}

type DeploymentDirectTargets = [string, string][];

interface DeploymentTargets {
	[key: string]: {
		excludeSites: DefaultDefinition['excludeSites'];
		description: DefaultDefinition['description'];
		files: DeploymentDirectTargets;
	};
}

interface GlobalSourceFiles {
	[key: string]: {
		enable: boolean;
		sourceCode: string;
		contentType?: 'application/javascript' | 'text/css' | undefined;
		licenseText?: string | undefined;
	};
}

interface SourceFiles {
	[key: string]: {
		definition: DefaultDefinition & {
			requiresES6: boolean;
		};
		license?: string;
		script?: string;
		scripts?: string[];
		style?: string;
		styles?: string[];
	};
}

export type {
	Api,
	BuiltFile,
	BuiltFiles,
	Credentials,
	CredentialsOnlyPassword,
	DefaultDefinition,
	DefaultSectionMap,
	DeploymentDirectTargets,
	DeploymentTargets,
	GlobalSourceFiles,
	SourceFiles,
};