Skip to content

Commit

Permalink
file update~
Browse files Browse the repository at this point in the history
  • Loading branch information
@Taromatibot
Taromatibot committed Mar 1, 2024
1 parent ddc3c15 commit f06e875
Show file tree
Hide file tree
Showing 3 changed files with 99 additions and 45 deletions.
48 changes: 33 additions & 15 deletions dist/cn/jsstp.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,7 @@ interface ExtensibleFunction<args_T extends Array<any>, return_T> {
type security_level_t = "local" | "external";
/**
* SSTP 返回码
* 和 HTTP 一样，200 系列是正常接受，其他的是错误。
* 200 系列是正常接受，其他的是错误。
* 和 HTTP 一样，200 系列是正常接受，其他的是错误。
* @enum {number}
*/
declare enum documented_sstp_return_code_t {
Expand Down Expand Up @@ -105,11 +104,10 @@ declare enum documented_sstp_return_code_t {
}
/**
* SSTP 返回码
* 和 HTTP 一样，200 系列是正常接受，其他的是错误。
* 200 系列是正常接受，其他的是错误。
* 和 HTTP 一样，200 系列是正常接受，其他的是错误。
* @enum {number}
*/
type sstp_return_code_t = documented_sstp_return_code_t | number;
type sstp_return_code_t = number & documented_sstp_return_code_t;
/**
* 基本的SSTP包
* @see {@link https://ssp.shillest.net/ukadoc/manual/spec_sstp.html#req_res}
Expand Down Expand Up @@ -271,7 +269,7 @@ declare enum documented_sstp_command_name_t {
GetPluginNameList = "GetPluginNameList",
/**
* 返回基础软件（运行人格的软件）的版本，以点分隔的版本号的格式
* 这可以和version.json的ssp.full.version等简单比较，就可以检查是否是最新版
* 这可以和[version.json](https://ssp.shillest.net/archive/version.json)的`ssp.full.version`等简单比较，就可以检查是否是最新版
*/
GetShortVersion = "GetShortVersion",
/**
Expand Down Expand Up @@ -299,24 +297,24 @@ declare enum documented_sstp_command_name_t {
*/
ExtractArchive = "ExtractArchive",
/**
* 将合成好的表面图片输出到指定的目录。参数和\![execute,dumpsurface]相同
* 将合成好的表面图片输出到指定的目录。参数和`\![execute,dumpsurface]`相同
* 响应会在处理结束后才返回，注意
* 没有附加数据（状态码200系列表示成功）
*/
DumpSurface = "DumpSurface",
/**
* 不通过Sakura Script执行和\![moveasync]相同的事情。参数指定方法和Sakura Script版相同
* 不通过Sakura Script执行和`\![moveasync]`相同的事情。参数指定方法和Sakura Script版相同
* 因为不能在SSTP的超时时间内返回响应，而且会导致死锁，所以不能执行没有async的move
* 没有附加数据（状态码200系列表示成功）
*/
MoveAsync = "MoveAsync",
/**
* 不通过Sakura Script执行和\![set,tasktrayicon]相同的事情。参数指定方法和Sakura Script版相同
* 不通过Sakura Script执行和`\![set,tasktrayicon]`相同的事情。参数指定方法和Sakura Script版相同
* 没有附加数据（状态码200系列表示成功）
*/
SetTrayIcon = "SetTrayIcon",
/**
* 不通过Sakura Script执行和\![set,trayballoon]相同的事情。参数指定方法和Sakura Script版相同
* 不通过Sakura Script执行和`\![set,trayballoon]`相同的事情。参数指定方法和Sakura Script版相同
* 没有附加数据（状态码200系列表示成功）
*/
SetTrayBalloon = "SetTrayBalloon",
Expand Down Expand Up @@ -352,7 +350,7 @@ declare enum documented_sstp_command_name_t {
* SSTP命令名称
* @enum {string}
*/
type sstp_command_name_t = documented_sstp_command_name_t | string;
type sstp_command_name_t = string & documented_sstp_command_name_t;
/**
* 常见的SSTP执行包内容
* @see {@link https://ssp.shillest.net/ukadoc/manual/spec_sstp.html#method_execute}
Expand Down Expand Up @@ -748,7 +746,12 @@ interface base_keyed_method_caller<T = sstp_info_t, Rest extends any[] = [Object
* 对调用参数进行简易处理的可扩展调用器
* @group callers
*/
interface simple_keyed_method_caller<result_T> extends base_keyed_method_caller<result_T, any[]> { }
interface simple_keyed_method_caller<result_T> extends base_keyed_method_caller<result_T, any[]> {
/**
* 扩展调用器
*/
[uuid: string]: simple_keyed_method_caller<result_T>
}
/**
* 简易事件调用器
* 直接调用以触发事件！
Expand All @@ -762,7 +765,12 @@ interface simple_keyed_method_caller<result_T> extends base_keyed_method_caller<
* });
* @group callers
*/
interface simple_event_caller extends simple_keyed_method_caller<sstp_info_t> { }
interface simple_event_caller extends simple_keyed_method_caller<sstp_info_t> {
/**
* 扩展调用器
*/
[uuid: string]: simple_event_caller
}
/**
* 简易命令调用器
* @example
Expand All @@ -775,7 +783,12 @@ interface simple_event_caller extends simple_keyed_method_caller<sstp_info_t> {
* });
* @group callers
*/
interface simple_command_caller extends simple_keyed_method_caller<sstp_info_t> { }
interface simple_command_caller extends simple_keyed_method_caller<sstp_info_t> {
/**
* 扩展调用器
*/
[uuid: string]: simple_command_caller
}
/**
* 对参数进行简易处理的列表返值命令执行器
* @example
Expand All @@ -786,7 +799,12 @@ interface simple_command_caller extends simple_keyed_method_caller<sstp_info_t>
* });
* @group callers
*/
interface simple_list_command_caller extends simple_keyed_method_caller<list_info_t> { }
interface simple_list_command_caller extends simple_keyed_method_caller<list_info_t> {
/**
* 扩展调用器
*/
[uuid: string]: simple_list_command_caller
}

/**
* 比{@link jsstp_t}多了一个ghost_info属性
Expand Down
48 changes: 33 additions & 15 deletions dist/en/jsstp.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,7 @@ interface ExtensibleFunction<args_T extends Array<any>, return_T> {
type security_level_t = "local" | "external";
/**
* SSTP return codes
* Same as HTTP, 200s are OK, others are errors.
* 200s are OK, others are errors.
* Same as HTTP, 200s are OK, others are errors.
* @enum {number}
*/
declare enum documented_sstp_return_code_t {
Expand Down Expand Up @@ -105,11 +104,10 @@ declare enum documented_sstp_return_code_t {
}
/**
* SSTP return codes
* Same as HTTP, 200s are OK, others are errors.
* 200s are OK, others are errors.
* Same as HTTP, 200s are OK, others are errors.
* @enum {number}
*/
type sstp_return_code_t = documented_sstp_return_code_t | number;
type sstp_return_code_t = number & documented_sstp_return_code_t;
/**
* Basic SSTP packet
* @see {@link https://ssp.shillest.net/ukadoc/manual/spec_sstp.html#req_res}
Expand Down Expand Up @@ -271,7 +269,7 @@ declare enum documented_sstp_command_name_t {
GetPluginNameList = "GetPluginNameList",
/**
* Returns the version of the base ware (the software that runs the ghost) in the format of only the version number separated by periods.
* This can be used to check if the base ware is the latest version by simply comparing it with ssp.full.version in version.json or similar.
* This can be used to check if the base ware is the latest version by simply comparing it with `ssp.full.version` in [version.json](https://ssp.shillest.net/archive/version.json) or similar.
*/
GetShortVersion = "GetShortVersion",
/**
Expand Down Expand Up @@ -299,24 +297,24 @@ declare enum documented_sstp_command_name_t {
*/
ExtractArchive = "ExtractArchive",
/**
* Outputs the synthesized surface image to the specified directory. The parameters are the same as \![execute,dumpsurface].
* Outputs the synthesized surface image to the specified directory. The parameters are the same as `\![execute,dumpsurface]`.
* The response is not returned until the process is finished, so be careful.
* No additional data (success with status code 200 series).
*/
DumpSurface = "DumpSurface",
/**
* Executes the same thing as \![moveasync] without using Sakura Script. The parameter specification method is the same as the Sakura Script version.
* Executes the same thing as `\![moveasync]` without using Sakura Script. The parameter specification method is the same as the Sakura Script version.
* Move without async cannot be executed because it cannot return a response before the SSTP timeout and causes a deadlock.
* No additional data (success with status code 200 series).
*/
MoveAsync = "MoveAsync",
/**
* Executes the same thing as \![set,tasktrayicon] without using Sakura Script. The parameter specification method is the same as the Sakura Script version.
* Executes the same thing as `\![set,tasktrayicon]` without using Sakura Script. The parameter specification method is the same as the Sakura Script version.
* No additional data (success with status code 200 series).
*/
SetTrayIcon = "SetTrayIcon",
/**
* Executes the same thing as \![set,trayballoon] without using Sakura Script. The parameter specification method is the same as the Sakura Script version.
* Executes the same thing as `\![set,trayballoon]` without using Sakura Script. The parameter specification method is the same as the Sakura Script version.
* No additional data (success with status code 200 series).
*/
SetTrayBalloon = "SetTrayBalloon",
Expand Down Expand Up @@ -352,7 +350,7 @@ declare enum documented_sstp_command_name_t {
* SSTP command name
* @enum {string}
*/
type sstp_command_name_t = documented_sstp_command_name_t | string;
type sstp_command_name_t = string & documented_sstp_command_name_t;
/**
* Common SSTP execute packet content
* @see {@link https://ssp.shillest.net/ukadoc/manual/spec_sstp.html#method_execute}
Expand Down Expand Up @@ -743,7 +741,12 @@ interface base_keyed_method_caller<T = sstp_info_t, Rest extends any[] = [Object
* An extensible caller that performs simple processing on call parameters
* @group callers
*/
interface simple_keyed_method_caller<result_T> extends base_keyed_method_caller<result_T, any[]> { }
interface simple_keyed_method_caller<result_T> extends base_keyed_method_caller<result_T, any[]> {
/**
* Extensible caller
*/
[uuid: string]: simple_keyed_method_caller<result_T>
}
/**
* Simple Event Caller
* Directly call to trigger an event!
Expand All @@ -757,7 +760,12 @@ interface simple_keyed_method_caller<result_T> extends base_keyed_method_caller<
* });
* @group callers
*/
interface simple_event_caller extends simple_keyed_method_caller<sstp_info_t> { }
interface simple_event_caller extends simple_keyed_method_caller<sstp_info_t> {
/**
* Extensible caller
*/
[uuid: string]: simple_event_caller
}
/**
* Simple Command Caller
* @example
Expand All @@ -770,7 +778,12 @@ interface simple_event_caller extends simple_keyed_method_caller<sstp_info_t> {
* });
* @group callers
*/
interface simple_command_caller extends simple_keyed_method_caller<sstp_info_t> { }
interface simple_command_caller extends simple_keyed_method_caller<sstp_info_t> {
/**
* Extensible caller
*/
[uuid: string]: simple_command_caller
}
/**
* List Return Command Executor with Simple Parameter Processing
* @example
Expand All @@ -781,7 +794,12 @@ interface simple_command_caller extends simple_keyed_method_caller<sstp_info_t>
* });
* @group callers
*/
interface simple_list_command_caller extends simple_keyed_method_caller<list_info_t> { }
interface simple_list_command_caller extends simple_keyed_method_caller<list_info_t> {
/**
* Extensible caller
*/
[uuid: string]: simple_list_command_caller
}

/**
* One more ghost_info attribute than {@link jsstp_t}
Expand Down
48 changes: 33 additions & 15 deletions dist/jp/jsstp.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,7 @@ interface ExtensibleFunction<args_T extends Array<any>, return_T> {
type security_level_t = "local" | "external";
/**
* SSTP return codes
* HTTPと同じく、200番台は正常受理、その他はエラー。
* 200番台は正常受理、その他はエラー。
* HTTPと同じく、200番台は正常受理、その他はエラー。
* @enum {number}
*/
declare enum documented_sstp_return_code_t {
Expand Down Expand Up @@ -105,11 +104,10 @@ declare enum documented_sstp_return_code_t {
}
/**
* SSTP return codes
* HTTPと同じく、200番台は正常受理、その他はエラー。
* 200番台は正常受理、その他はエラー。
* HTTPと同じく、200番台は正常受理、その他はエラー。
* @enum {number}
*/
type sstp_return_code_t = documented_sstp_return_code_t | number;
type sstp_return_code_t = number & documented_sstp_return_code_t;
/**
* 基本的な SSTP パケット
* @see {@link https://ssp.shillest.net/ukadoc/manual/spec_sstp.html#req_res}
Expand Down Expand Up @@ -271,7 +269,7 @@ declare enum documented_sstp_command_name_t {
GetPluginNameList = "GetPluginNameList",
/**
* ベースウェア（ゴーストを実行するソフト）のバージョンを、ピリオド区切りのバージョン番号のみの形式で返す
* これをversion.jsonのssp.full.versionなどと単純比較すると最新版かどうかチェックできる
* これを[version.json](https://ssp.shillest.net/archive/version.json)の`ssp.full.version`などと単純比較すると最新版かどうかチェックできる
*/
GetShortVersion = "GetShortVersion",
/**
Expand Down Expand Up @@ -299,24 +297,24 @@ declare enum documented_sstp_command_name_t {
*/
ExtractArchive = "ExtractArchive",
/**
* 合成済みのサーフェス画像を指定したディレクトリに出力する。パラメータは\![execute,dumpsurface]と同じ
* 合成済みのサーフェス画像を指定したディレクトリに出力する。パラメータは`\![execute,dumpsurface]`と同じ
* 処理が終わるまでレスポンスが返らないので注意
* 追加データなし（ステータスコード200番台で成功）
*/
DumpSurface = "DumpSurface",
/**
* \![moveasync]と同じことをSakura Scriptを介さずに実行する。パラメータ指定方法はSakura Script版と同じ
* `\![moveasync]`と同じことをSakura Scriptを介さずに実行する。パラメータ指定方法はSakura Script版と同じ
* SSTPのタイムアウトまでにresponseを返せないのとデッドロックの原因になるため、asyncなしのmoveは実行できない
* 追加データなし（ステータスコード200番台で成功）
*/
MoveAsync = "MoveAsync",
/**
* \![set,tasktrayicon]と同じことをSakura Scriptを介さずに実行する。パラメータ指定方法はSakura Script版と同じ
* `\![set,tasktrayicon]`と同じことをSakura Scriptを介さずに実行する。パラメータ指定方法はSakura Script版と同じ
* 追加データなし（ステータスコード200番台で成功）
*/
SetTrayIcon = "SetTrayIcon",
/**
* \![set,trayballoon]と同じことをSakura Scriptを介さずに実行する。パラメータ指定方法はSakura Script版と同じ
* `\![set,trayballoon]`と同じことをSakura Scriptを介さずに実行する。パラメータ指定方法はSakura Script版と同じ
* 追加データなし（ステータスコード200番台で成功）
*/
SetTrayBalloon = "SetTrayBalloon",
Expand Down Expand Up @@ -352,7 +350,7 @@ declare enum documented_sstp_command_name_t {
* SSTPコマンド名
* @enum {string}
*/
type sstp_command_name_t = documented_sstp_command_name_t | string;
type sstp_command_name_t = string & documented_sstp_command_name_t;
/**
* 一般的なSSTP実行パケットの内容
* @see {@link https://ssp.shillest.net/ukadoc/manual/spec_sstp.html#method_execute}
Expand Down Expand Up @@ -743,7 +741,12 @@ interface base_keyed_method_caller<T = sstp_info_t, Rest extends any[] = [Object
* 呼び出しパラメータを簡単に扱うための拡張可能な呼び出し元
* @group callers
*/
interface simple_keyed_method_caller<result_T> extends base_keyed_method_caller<result_T, any[]> { }
interface simple_keyed_method_caller<result_T> extends base_keyed_method_caller<result_T, any[]> {
/**
* 拡張呼び出し元
*/
[uuid: string]: simple_keyed_method_caller<result_T>
}
/**
* 単純なイベント呼び出し元
* イベントをトリガーするために直接呼び出される！
Expand All @@ -757,7 +760,12 @@ interface simple_keyed_method_caller<result_T> extends base_keyed_method_caller<
* });
* @group callers
*/
interface simple_event_caller extends simple_keyed_method_caller<sstp_info_t> { }
interface simple_event_caller extends simple_keyed_method_caller<sstp_info_t> {
/**
* 拡張呼び出し元
*/
[uuid: string]: simple_event_caller
}
/**
* シンプルなコマンド呼び出し元
* @example
Expand All @@ -770,7 +778,12 @@ interface simple_event_caller extends simple_keyed_method_caller<sstp_info_t> {
* });
* @group callers
*/
interface simple_command_caller extends simple_keyed_method_caller<sstp_info_t> { }
interface simple_command_caller extends simple_keyed_method_caller<sstp_info_t> {
/**
* 拡張呼び出し元
*/
[uuid: string]: simple_command_caller
}
/**
* パラメータを簡単に処理できるリスト戻り値コマンド実行
* @example
Expand All @@ -781,7 +794,12 @@ interface simple_command_caller extends simple_keyed_method_caller<sstp_info_t>
* });
* @group callers
*/
interface simple_list_command_caller extends simple_keyed_method_caller<list_info_t> { }
interface simple_list_command_caller extends simple_keyed_method_caller<list_info_t> {
/**
* 拡張呼び出し元
*/
[uuid: string]: simple_list_command_caller
}

/**
* link jsstp_t} よりも ghost_info 属性が1つ多い。
Expand Down

0 comments on commit f06e875

Please sign in to comment.