@siredvin/cc-types 1.0.0

package/audio/dfpwm.d.ts

@@ -0,0 +1,8 @@
+/** @noSelfInFile **/
+/** @noResolution **/
+declare module "cc.audio.dfpwm" {
+    export function make_encoder(): (pcm: number[]) => string;
+    export function encode(pcm: number[]): string;
+    export function make_decoder(): (dfpwm: string) => number[];
+    export function decode(dfpwm: string): number[];
+}

package/completion.d.ts

@@ -0,0 +1,13 @@
+/** @noSelfInFile **/
+/** @noResolution **/
+declare module "cc.completion" {
+    export function choice(
+        text: string,
+        choices: string[],
+        add_space?: boolean
+    ): string[];
+    export function peripheral(text: string, add_space?: boolean): string[];
+    export function side(text: string, add_space?: boolean): string[];
+    export function setting(text: string, add_space?: boolean): string[];
+    export function command(text: string, add_space?: boolean): string[];
+}

package/expect.d.ts

@@ -0,0 +1,15 @@
+/** @noSelfInFile **/
+/** @noResolution **/
+declare module "cc/expect" {
+    namespace expect {
+        function expect(index: number, value: any, ...types: string[]): any;
+        function field(
+            tbl: Object | LuaTable,
+            index: string,
+            ...types: string[]
+        ): any;
+        function range(num: number, min?: number, max?: number): number;
+    }
+    function expect(index: number, value: any, ...types: string[]): any;
+    export = expect;
+}

package/image/nft.d.ts

@@ -0,0 +1,13 @@
+/** @noSelfInFile **/
+/** @noResolution **/
+declare module "cc.image.nft" {
+    type Image = { text: string; foreground: string; background: string }[];
+    export function parse(image: string): Image;
+    export function load(path: string): Image;
+    export function draw(
+        image: Image,
+        xPos: number,
+        yPos: number,
+        target?: ITerminal
+    );
+}

package/index.d.ts

@@ -0,0 +1,8 @@
+/// <reference path="audio/dfpwm.d.ts"/>
+/// <reference path="completion.d.ts"/>
+/// <reference path="expect.d.ts"/>
+/// <reference path="image/nft.d.ts"/>
+/// <reference path="pretty.d.ts"/>
+/// <reference path="require.d.ts"/>
+/// <reference path="shell/completion.d.ts"/>
+/// <reference path="strings.d.ts"/>

package/package.json

@@ -0,0 +1,40 @@
+{
+    "name": "@siredvin/cc-types",
+    "version": "1.0.0",
+    "description": "TypeScript type definitions for CraftOS modules.",
+    "types": "index.d.ts",
+    "files": [
+        "./*.d.ts",
+        "./audio",
+        "./image",
+        "./shell"
+    ],
+    "author": "JackMacWindows",
+    "license": "MIT",
+    "scripts": {
+        "lint": "eslint . --ext .ts,.js",
+        "depcheck": "depcheck"
+    },
+    "nx": {
+        "targets": {
+            "lint": {
+                "executor": "@nx/linter:eslint",
+                "outputs": [
+                    "{options.outputFile}"
+                ],
+                "options": {
+                    "lintFilePatterns": [
+                        "packages/cc/**/*.{ts,tsx,js,jsx}"
+                    ]
+                }
+            },
+            "depcheck": {
+                "executor": "nx:run-commands",
+                "options": {
+                    "command": "depcheck",
+                    "cwd": "packages/cc"
+                }
+            }
+        }
+    }
+}

package/pretty.d.ts

@@ -0,0 +1,29 @@
+/** @noSelfInFile **/
+/** @noResolution **/
+declare module "cc.pretty" {
+    type Doc = {};
+    export const empty: Doc;
+    export const space: Doc;
+    export const line: Doc;
+    export const space_line: Doc;
+    export function text(text: string, color?: number): Doc;
+    export function concat(...args: (Doc | string)[]): Doc;
+    export function nest(depth: number, doc: Doc): Doc;
+    export function group(doc: Doc): Doc;
+    export function write(doc: Doc, ribbon_frac?: number): void;
+    export function print(doc: Doc, ribbon_frac?: number): void;
+    export function render(
+        doc: Doc,
+        width?: number,
+        ribbon_frac?: number
+    ): string;
+    export function pretty(
+        obj: any,
+        options?: { function_args?: boolean; function_source: boolean }
+    ): Doc;
+    export function pretty_print(
+        obj: any,
+        options?: { function_args?: boolean; function_source: boolean },
+        ribbon_frac?: number
+    ): void;
+}

package/require.d.ts

@@ -0,0 +1,8 @@
+/** @noSelfInFile **/
+/** @noResolution **/
+declare module "cc.require" {
+    export function make(
+        env: Object | LuaTable,
+        dir: string
+    ): LuaMultiReturn<[(name: string) => any, Object | LuaTable]>;
+}

package/shell/completion.d.ts

@@ -0,0 +1,69 @@
+/** @noSelfInFile **/
+/** @noResolution **/
+declare module "cc.shell.completion" {
+    export function file(shell: Object | LuaTable, text: string): string[];
+    export function dir(shell: Object | LuaTable, text: string): string[];
+    export function dirOrFile(
+        shell: Object | LuaTable,
+        text: string,
+        previous: string[],
+        add_space?: boolean
+    ): string[];
+    export function program(shell: Object | LuaTable, text: string): string[];
+    export function programWithArgs(
+        shell: Object | LuaTable,
+        text: string,
+        previous: string[],
+        starting: number
+    ): string[];
+    export function help(
+        shell: Object | LuaTable,
+        text: string,
+        previous: string[]
+    ): string[];
+    export function choice(
+        shell: Object | LuaTable,
+        text: string,
+        previous: string[],
+        choices: string[],
+        add_space?: boolean
+    ): string[];
+    export function peripheral(
+        shell: Object | LuaTable,
+        text: string,
+        previous: string[],
+        add_space?: boolean
+    ): string[];
+    export function side(
+        shell: Object | LuaTable,
+        text: string,
+        previous: string[],
+        add_space?: boolean
+    ): string[];
+    export function setting(
+        shell: Object | LuaTable,
+        text: string,
+        previous: string[],
+        add_space?: boolean
+    ): string[];
+    export function command(
+        shell: Object | LuaTable,
+        text: string,
+        previous: string[],
+        add_space?: boolean
+    ): string[];
+    export function build(
+        ...args: (
+            | null
+            | ((text: string, previous: string[]) => string[])
+            | [
+                  (
+                      text: string,
+                      previous: string[],
+                      ...args: any[]
+                  ) => string[],
+                  ...any[]
+              ]
+        )[]
+    ): (index: number, arg: string, previous: string[]) => string[];
+}

package/strings.d.ts

@@ -0,0 +1,6 @@
+/** @noSelfInFile **/
+/** @noResolution **/
+declare module "cc.strings" {
+    export function wrap(text: string, width?: number): string[];
+    export function ensure_width(text: string, width?: number): string;
+}