Skip to content

Commit e130c52

Browse files
author
RoFlection Bot
committed
Port missing Types, reexport types(#60)
1 parent f1c3fb7 commit e130c52

File tree

6 files changed

+246
-74
lines changed

6 files changed

+246
-74
lines changed

src/init.lua

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,111 @@ exports.queries = queries
3838
exports.queryHelpers = queryHelpers
3939
exports.document = require(script.jsHelpers.document)
4040

41+
-- ROBLOX deviation START: reexport types
42+
local typesModule = require(script.types)
43+
export type within = typesModule.within
44+
export type QueryByBoundAttribute<T = Instance> = typesModule.QueryByBoundAttribute<T>
45+
export type AllByBoundAttribute<T = Instance> = typesModule.AllByBoundAttribute<T>
46+
export type FindAllByBoundAttribute<T = Instance> = typesModule.FindAllByBoundAttribute<T>
47+
export type GetByBoundAttribute<T = Instance> = typesModule.GetByBoundAttribute<T>
48+
export type FindByBoundAttribute<T = Instance> = typesModule.FindByBoundAttribute<T>
49+
export type QueryByText<T = Instance> = typesModule.QueryByText<T>
50+
export type AllByText<T = Instance> = typesModule.AllByText<T>
51+
export type FindAllByText<T = Instance> = typesModule.FindAllByText<T>
52+
export type GetByText<T = Instance> = typesModule.GetByText<T>
53+
export type FindByText<T = Instance> = typesModule.FindByText<T>
54+
export type getByPlaceholderText<T = Instance> = typesModule.getByPlaceholderText<T>
55+
export type getAllByPlaceholderText<T = Instance> = typesModule.getAllByPlaceholderText<T>
56+
export type queryByPlaceholderText<T = Instance> = typesModule.queryByPlaceholderText<T>
57+
export type queryAllByPlaceholderText<T = Instance> = typesModule.queryAllByPlaceholderText<T>
58+
export type findByPlaceholderText<T = Instance> = typesModule.findByPlaceholderText<T>
59+
export type findAllByPlaceholderText<T = Instance> = typesModule.findAllByPlaceholderText<T>
60+
export type getByText<T = Instance> = typesModule.getByText<T>
61+
export type getAllByText<T = Instance> = typesModule.getAllByText<T>
62+
export type queryByText<T = Instance> = typesModule.queryByText<T>
63+
export type queryAllByText<T = Instance> = typesModule.queryAllByText<T>
64+
export type findByText<T = Instance> = typesModule.findByText<T>
65+
export type findAllByText<T = Instance> = typesModule.findAllByText<T>
66+
export type getByDisplayValue<T = Instance> = typesModule.getByDisplayValue<T>
67+
export type getAllByDisplayValue<T = Instance> = typesModule.getAllByDisplayValue<T>
68+
export type queryByDisplayValue<T = Instance> = typesModule.queryByDisplayValue<T>
69+
export type queryAllByDisplayValue<T = Instance> = typesModule.queryAllByDisplayValue<T>
70+
export type findByDisplayValue<T = Instance> = typesModule.findByDisplayValue<T>
71+
export type findAllByDisplayValue<T = Instance> = typesModule.findAllByDisplayValue<T>
72+
export type getByTestId<T = Instance> = typesModule.getByTestId<T>
73+
export type getAllByTestId<T = Instance> = typesModule.getAllByTestId<T>
74+
export type queryByTestId<T = Instance> = typesModule.queryByTestId<T>
75+
export type queryAllByTestId<T = Instance> = typesModule.queryAllByTestId<T>
76+
export type findByTestId<T = Instance> = typesModule.findByTestId<T>
77+
export type findAllByTestId<T = Instance> = typesModule.findAllByTestId<T>
78+
export type WithSuggest = typesModule.WithSuggest
79+
export type GetErrorFunction<Argument = any> = typesModule.GetErrorFunction<Argument>
80+
export type SelectorMatcherOptions = typesModule.SelectorMatcherOptions
81+
export type QueryByAttribute = typesModule.QueryByAttribute
82+
export type AllByAttribute = typesModule.AllByAttribute
83+
export type queryByAttribute = typesModule.queryByAttribute
84+
export type queryAllByAttribute = typesModule.queryAllByAttribute
85+
export type getElementError = typesModule.getElementError
86+
export type QueryMethod<Argument, Return> = typesModule.QueryMethod<Argument, Return>
87+
export type QueryBy<Argument> = typesModule.QueryBy<Argument>
88+
export type GetAllBy<Argument> = typesModule.GetAllBy<Argument>
89+
export type FindAllBy<Argument> = typesModule.FindAllBy<Argument>
90+
export type GetBy<Argument> = typesModule.GetBy<Argument>
91+
export type FindBy<Argument> = typesModule.FindBy<Argument>
92+
export type BuiltQueryMethods<Argument> = typesModule.BuiltQueryMethods<Argument>
93+
export type buildQueries<Argument> = typesModule.buildQueries<Argument>
94+
export type Screen<Q> = typesModule.Screen<Q>
95+
export type screen = typesModule.screen
96+
export type waitForOptions = typesModule.waitForOptions
97+
export type waitFor = typesModule.waitFor
98+
export type waitForElementToBeRemoved<T> = typesModule.waitForElementToBeRemoved<T>
99+
export type MatcherFunction = typesModule.MatcherFunction
100+
export type Matcher = typesModule.Matcher
101+
export type ByRoleMatcher = typesModule.ByRoleMatcher
102+
export type NormalizerFn = typesModule.NormalizerFn
103+
export type NormalizerOptions = typesModule.NormalizerOptions
104+
export type MatcherOptions = typesModule.MatcherOptions
105+
export type Match = typesModule.Match
106+
export type DefaultNormalizerOptions = typesModule.DefaultNormalizerOptions
107+
export type getDefaultNormalizer = typesModule.getDefaultNormalizer
108+
export type getNodeText = typesModule.getNodeText
109+
export type EventType = typesModule.EventType
110+
export type FireFunction = typesModule.FireFunction
111+
export type FireObject = typesModule.FireObject
112+
export type CreateFunction = typesModule.CreateFunction
113+
export type CreateObject = typesModule.CreateObject
114+
export type createEvent = typesModule.createEvent
115+
export type fireEvent = typesModule.fireEvent
116+
export type BoundFunction<T> = typesModule.BoundFunction<T>
117+
export type BoundFunctions<Q> = typesModule.BoundFunctions<Q>
118+
export type Query = typesModule.Query
119+
export type Queries = typesModule.Queries
120+
export type getQueriesForElement = typesModule.getQueriesForElement
121+
export type PrettyDOMOptions = typesModule.PrettyDOMOptions
122+
export type prettyDOM = typesModule.prettyDOM
123+
export type logDOM = typesModule.logDOM
124+
export type prettyFormat_Colors = typesModule.prettyFormat_Colors
125+
export type prettyFormat_CompareKeys = typesModule.prettyFormat_CompareKeys
126+
export type prettyFormat_Options = typesModule.prettyFormat_Options
127+
export type prettyFormat_OptionsReceived = typesModule.prettyFormat_OptionsReceived
128+
export type prettyFormat_OldPlugin = typesModule.prettyFormat_OldPlugin
129+
export type prettyFormat_NewPlugin = typesModule.prettyFormat_NewPlugin
130+
export type prettyFormat_Plugin = typesModule.prettyFormat_Plugin
131+
export type prettyFormat_Plugins = typesModule.prettyFormat_Plugins
132+
export type prettyFormat_PrettyFormatOptions = typesModule.prettyFormat_PrettyFormatOptions
133+
export type prettyFormat_Printer = typesModule.prettyFormat_Printer
134+
export type prettyFormat_Refs = typesModule.prettyFormat_Refs
135+
export type prettyFormat_Theme = typesModule.prettyFormat_Theme
136+
export type Config = typesModule.Config
137+
export type ConfigFn = typesModule.ConfigFn
138+
export type configure = typesModule.configure
139+
export type getConfig = typesModule.getConfig
140+
export type QueryOptions = typesModule.QueryOptions
141+
export type QueryArgs = typesModule.QueryArgs
142+
export type Suggestion = typesModule.Suggestion
143+
export type Variant = typesModule.Variant
144+
export type Method = typesModule.Method
145+
export type getSuggestedQuery = typesModule.getSuggestedQuery
146+
-- ROBLOX deviation END
147+
41148
return exports

src/types/events.lua

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ export type CreateObject = {
107107
[EventType]: (element: Instance, options: { [string]: any }?) -> Event,
108108
}
109109

110-
type createEvent = CreateObject & CreateFunction
111-
type fireEvent = FireFunction & FireObject
110+
export type createEvent = CreateObject & CreateFunction
111+
export type fireEvent = FireFunction & FireObject
112112

113113
return exports

src/types/init.lua

Lines changed: 79 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,12 @@
33
local exports = {}
44
-- TypeScript Version: 3.8
55

6-
-- local getQueriesForElement = require(script["get-queries-for-element"]).getQueriesForElement
7-
8-
-- local within: typeof(getQueriesForElement)
6+
local getQueriesForElementModule = require(script["get-queries-for-element"])
7+
local queriesModule = require(script.queries)
8+
local queryHelpersModule = require(script["query-helpers"])
99

10-
-- exports.within = within
10+
export type within = getQueriesForElementModule.getQueriesForElement
1111

12-
local queriesModule = require(script.queries)
1312
export type QueryByBoundAttribute<T = Instance> = queriesModule.QueryByBoundAttribute<T>
1413
export type AllByBoundAttribute<T = Instance> = queriesModule.AllByBoundAttribute<T>
1514
export type FindAllByBoundAttribute<T = Instance> = queriesModule.FindAllByBoundAttribute<T>
@@ -20,18 +19,20 @@ export type AllByText<T = Instance> = queriesModule.AllByText<T>
2019
export type FindAllByText<T = Instance> = queriesModule.FindAllByText<T>
2120
export type GetByText<T = Instance> = queriesModule.GetByText<T>
2221
export type FindByText<T = Instance> = queriesModule.FindByText<T>
23-
export type ByRoleOptions = queriesModule.ByRoleOptions
24-
export type AllByRole<T = Instance> = queriesModule.AllByRole<T>
25-
export type GetByRole<T = Instance> = queriesModule.GetByRole<T>
26-
export type QueryByRole<T = Instance> = queriesModule.QueryByRole<T>
27-
export type FindByRole<T = Instance> = queriesModule.FindByRole<T>
28-
export type FindAllByRole<T = Instance> = queriesModule.FindAllByRole<T>
29-
export type getByLabelText<T = Instance> = queriesModule.getByLabelText<T>
30-
export type getAllByLabelText<T = Instance> = queriesModule.getAllByLabelText<T>
31-
export type queryByLabelText<T = Instance> = queriesModule.queryByLabelText<T>
32-
export type queryAllByLabelText<T = Instance> = queriesModule.queryAllByLabelText<T>
33-
export type findByLabelText<T = Instance> = queriesModule.findByLabelText<T>
34-
export type findAllByLabelText<T = Instance> = queriesModule.findAllByLabelText<T>
22+
-- ROBLOX deviation START: omit unsupported queries
23+
-- export type ByRoleOptions = queriesModule.ByRoleOptions
24+
-- export type AllByRole<T = Instance> = queriesModule.AllByRole<T>
25+
-- export type GetByRole<T = Instance> = queriesModule.GetByRole<T>
26+
-- export type QueryByRole<T = Instance> = queriesModule.QueryByRole<T>
27+
-- export type FindByRole<T = Instance> = queriesModule.FindByRole<T>
28+
-- export type FindAllByRole<T = Instance> = queriesModule.FindAllByRole<T>
29+
-- export type getByLabelText<T = Instance> = queriesModule.getByLabelText<T>
30+
-- export type getAllByLabelText<T = Instance> = queriesModule.getAllByLabelText<T>
31+
-- export type queryByLabelText<T = Instance> = queriesModule.queryByLabelText<T>
32+
-- export type queryAllByLabelText<T = Instance> = queriesModule.queryAllByLabelText<T>
33+
-- export type findByLabelText<T = Instance> = queriesModule.findByLabelText<T>
34+
-- export type findAllByLabelText<T = Instance> = queriesModule.findAllByLabelText<T>
35+
-- ROBLOX deviation END
3536
export type getByPlaceholderText<T = Instance> = queriesModule.getByPlaceholderText<T>
3637
export type getAllByPlaceholderText<T = Instance> = queriesModule.getAllByPlaceholderText<T>
3738
export type queryByPlaceholderText<T = Instance> = queriesModule.queryByPlaceholderText<T>
@@ -44,38 +45,41 @@ export type queryByText<T = Instance> = queriesModule.queryByText<T>
4445
export type queryAllByText<T = Instance> = queriesModule.queryAllByText<T>
4546
export type findByText<T = Instance> = queriesModule.findByText<T>
4647
export type findAllByText<T = Instance> = queriesModule.findAllByText<T>
47-
export type getByAltText<T = Instance> = queriesModule.getByAltText<T>
48-
export type getAllByAltText<T = Instance> = queriesModule.getAllByAltText<T>
49-
export type queryByAltText<T = Instance> = queriesModule.queryByAltText<T>
50-
export type queryAllByAltText<T = Instance> = queriesModule.queryAllByAltText<T>
51-
export type findByAltText<T = Instance> = queriesModule.findByAltText<T>
52-
export type findAllByAltText<T = Instance> = queriesModule.findAllByAltText<T>
53-
export type getByTitle<T = Instance> = queriesModule.getByTitle<T>
54-
export type getAllByTitle<T = Instance> = queriesModule.getAllByTitle<T>
55-
export type queryByTitle<T = Instance> = queriesModule.queryByTitle<T>
56-
export type queryAllByTitle<T = Instance> = queriesModule.queryAllByTitle<T>
57-
export type findByTitle<T = Instance> = queriesModule.findByTitle<T>
58-
export type findAllByTitle<T = Instance> = queriesModule.findAllByTitle<T>
48+
-- ROBLOX deviation START: omit unsupported queries
49+
-- export type getByAltText<T = Instance> = queriesModule.getByAltText<T>
50+
-- export type getAllByAltText<T = Instance> = queriesModule.getAllByAltText<T>
51+
-- export type queryByAltText<T = Instance> = queriesModule.queryByAltText<T>
52+
-- export type queryAllByAltText<T = Instance> = queriesModule.queryAllByAltText<T>
53+
-- export type findByAltText<T = Instance> = queriesModule.findByAltText<T>
54+
-- export type findAllByAltText<T = Instance> = queriesModule.findAllByAltText<T>
55+
-- export type getByTitle<T = Instance> = queriesModule.getByTitle<T>
56+
-- export type getAllByTitle<T = Instance> = queriesModule.getAllByTitle<T>
57+
-- export type queryByTitle<T = Instance> = queriesModule.queryByTitle<T>
58+
-- export type queryAllByTitle<T = Instance> = queriesModule.queryAllByTitle<T>
59+
-- export type findByTitle<T = Instance> = queriesModule.findByTitle<T>
60+
-- export type findAllByTitle<T = Instance> = queriesModule.findAllByTitle<T>
61+
-- ROBLOX deviation END: omit unsupported queries
5962
export type getByDisplayValue<T = Instance> = queriesModule.getByDisplayValue<T>
6063
export type getAllByDisplayValue<T = Instance> = queriesModule.getAllByDisplayValue<T>
6164
export type queryByDisplayValue<T = Instance> = queriesModule.queryByDisplayValue<T>
6265
export type queryAllByDisplayValue<T = Instance> = queriesModule.queryAllByDisplayValue<T>
6366
export type findByDisplayValue<T = Instance> = queriesModule.findByDisplayValue<T>
6467
export type findAllByDisplayValue<T = Instance> = queriesModule.findAllByDisplayValue<T>
65-
export type getByRole<T = Instance> = queriesModule.getByRole<T>
66-
export type getAllByRole<T = Instance> = queriesModule.getAllByRole<T>
67-
export type queryByRole<T = Instance> = queriesModule.queryByRole<T>
68-
export type queryAllByRole<T = Instance> = queriesModule.queryAllByRole<T>
69-
export type findByRole<T = Instance> = queriesModule.findByRole<T>
70-
export type findAllByRole<T = Instance> = queriesModule.findAllByRole<T>
68+
-- ROBLOX deviation START: omit unsupported queries
69+
-- export type getByRole<T = Instance> = queriesModule.getByRole<T>
70+
-- export type getAllByRole<T = Instance> = queriesModule.getAllByRole<T>
71+
-- export type queryByRole<T = Instance> = queriesModule.queryByRole<T>
72+
-- export type queryAllByRole<T = Instance> = queriesModule.queryAllByRole<T>
73+
-- export type findByRole<T = Instance> = queriesModule.findByRole<T>
74+
-- export type findAllByRole<T = Instance> = queriesModule.findAllByRole<T>
75+
-- ROBLOX deviation END
7176
export type getByTestId<T = Instance> = queriesModule.getByTestId<T>
7277
export type getAllByTestId<T = Instance> = queriesModule.getAllByTestId<T>
7378
export type queryByTestId<T = Instance> = queriesModule.queryByTestId<T>
7479
export type queryAllByTestId<T = Instance> = queriesModule.queryAllByTestId<T>
7580
export type findByTestId<T = Instance> = queriesModule.findByTestId<T>
7681
export type findAllByTestId<T = Instance> = queriesModule.findAllByTestId<T>
7782

78-
local queryHelpersModule = require(script["query-helpers"])
7983
export type WithSuggest = queryHelpersModule.WithSuggest
8084
export type GetErrorFunction<Argument = any> = queryHelpersModule.GetErrorFunction<Argument>
8185
export type SelectorMatcherOptions = queryHelpersModule.SelectorMatcherOptions
@@ -93,11 +97,17 @@ export type FindBy<Argument> = queryHelpersModule.FindBy<Argument>
9397
export type BuiltQueryMethods<Argument> = queryHelpersModule.BuiltQueryMethods<Argument>
9498
export type buildQueries<Argument> = queryHelpersModule.buildQueries<Argument>
9599

96-
-- Object.assign(exports, require(script.screen))
100+
local screenModule = require(script.screen)
101+
export type Screen<Q> = screenModule.Screen<Q>
102+
export type screen = screenModule.screen
103+
97104
local waitForModule = require(script["wait-for"])
98105
export type waitForOptions = waitForModule.waitForOptions
99106
export type waitFor = waitForModule.waitFor
100-
-- Object.assign(exports, require(script["wait-for-element-to-be-removed"]))
107+
108+
local waitForElementToBeRemovedModule = require(script["wait-for-element-to-be-removed"])
109+
export type waitForElementToBeRemoved<T> = waitForElementToBeRemovedModule.waitForElementToBeRemoved<T>
110+
101111
local matchesModule = require(script.matches)
102112
export type MatcherFunction = matchesModule.MatcherFunction
103113
export type Matcher = matchesModule.Matcher
@@ -108,48 +118,59 @@ export type MatcherOptions = matchesModule.MatcherOptions
108118
export type Match = matchesModule.Match
109119
export type DefaultNormalizerOptions = matchesModule.DefaultNormalizerOptions
110120
export type getDefaultNormalizer = matchesModule.getDefaultNormalizer
111-
-- Object.assign(exports, require(script["get-node-text"]))
112-
-- Object.assign(exports, require(script.events))
113-
local getQueriesForElementModule = require(script["get-queries-for-element"])
121+
122+
local getNodeTextModule = require(script["get-node-text"])
123+
export type getNodeText = getNodeTextModule.getNodeText
124+
125+
local eventsModule = require(script.events)
126+
export type EventType = eventsModule.EventType
127+
export type FireFunction = eventsModule.FireFunction
128+
export type FireObject = eventsModule.FireObject
129+
export type CreateFunction = eventsModule.CreateFunction
130+
export type CreateObject = eventsModule.CreateObject
131+
export type createEvent = eventsModule.createEvent
132+
export type fireEvent = eventsModule.fireEvent
133+
114134
export type BoundFunction<T> = getQueriesForElementModule.BoundFunction<T>
115135
export type BoundFunctions<Q> = getQueriesForElementModule.BoundFunctions<Q>
116136
export type Query = getQueriesForElementModule.Query
117137
export type Queries = getQueriesForElementModule.Queries
118138
export type getQueriesForElement = getQueriesForElementModule.getQueriesForElement
139+
119140
local prettyDomModule = require(script["pretty-dom"])
120141
export type PrettyDOMOptions = prettyDomModule.PrettyDOMOptions
121142
export type prettyDOM = (dom: Instance?, maxLength: number?, options: PrettyDOMOptions?) -> string | false
122143
export type logDOM = (dom: Instance?, maxLength: number?, options: PrettyDOMOptions?) -> ()
123-
export type Colors = prettyDomModule.Colors
124-
export type CompareKeys = prettyDomModule.CompareKeys
125-
-- export type Config = prettyDomModule.Config
126-
export type Options = prettyDomModule.Options
127-
export type OptionsReceived = prettyDomModule.OptionsReceived
128-
export type OldPlugin = prettyDomModule.OldPlugin
129-
export type NewPlugin = prettyDomModule.NewPlugin
130-
export type Plugin = prettyDomModule.Plugin
131-
export type Plugins = prettyDomModule.Plugins
132-
export type PrettyFormatOptions = prettyDomModule.PrettyFormatOptions
133-
export type Printer = prettyDomModule.Printer
134-
export type Refs = prettyDomModule.Refs
135-
export type Theme = prettyDomModule.Theme
144+
export type prettyFormat_Colors = prettyDomModule.prettyFormat_Colors
145+
export type prettyFormat_CompareKeys = prettyDomModule.prettyFormat_CompareKeys
146+
export type prettyFormat_Config = prettyDomModule.prettyFormat_Theme
147+
export type prettyFormat_Options = prettyDomModule.prettyFormat_Options
148+
export type prettyFormat_OptionsReceived = prettyDomModule.prettyFormat_OptionsReceived
149+
export type prettyFormat_OldPlugin = prettyDomModule.prettyFormat_OldPlugin
150+
export type prettyFormat_NewPlugin = prettyDomModule.prettyFormat_NewPlugin
151+
export type prettyFormat_Plugin = prettyDomModule.prettyFormat_Plugin
152+
export type prettyFormat_Plugins = prettyDomModule.prettyFormat_Plugins
153+
export type prettyFormat_PrettyFormatOptions = prettyDomModule.prettyFormat_PrettyFormatOptions
154+
export type prettyFormat_Printer = prettyDomModule.prettyFormat_Printer
155+
export type prettyFormat_Refs = prettyDomModule.prettyFormat_Refs
156+
export type prettyFormat_Theme = prettyDomModule.prettyFormat_Theme
157+
158+
-- ROBLOX deviation START: not ported
136159
-- Object.assign(exports, require(script["role-helpers"]))
160+
-- ROBLOX deviation END
161+
137162
local configModule = require(script.config)
138163
export type Config = configModule.Config
139164
export type ConfigFn = configModule.ConfigFn
140165
export type configure = configModule.configure
141166
export type getConfig = configModule.getConfig
142167

143168
local suggestionsModule = require(script.suggestions)
144-
145169
export type QueryOptions = suggestionsModule.QueryOptions
146170
export type QueryArgs = suggestionsModule.QueryArgs
147171
export type Suggestion = suggestionsModule.Suggestion
148172
export type Variant = suggestionsModule.Variant
149173
export type Method = suggestionsModule.Method
150174
export type getSuggestedQuery = suggestionsModule.getSuggestedQuery
151175

152-
local getNodeTextModule = require(script["get-node-text"])
153-
export type getNodeText = getNodeTextModule.getNodeText
154-
155176
return exports

0 commit comments

Comments
 (0)