ruru-types 2.0.0-rc.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md ADDED
@@ -0,0 +1,14 @@
1
+ # ruru-types
2
+
3
+ ## 2.0.0-rc.5
4
+
5
+ ### Patch Changes
6
+
7
+ - [#2912](https://github.com/graphile/crystal/pull/2912)
8
+ [`ebe1d22`](https://github.com/graphile/crystal/commit/ebe1d22e45156d9ec2274f291bbb824405e02049)
9
+ Thanks [@benjie](https://github.com/benjie)! - Ruru now depends on ruru-types
10
+ package - stripped down vs ruru-components
11
+
12
+ - [#2915](https://github.com/graphile/crystal/pull/2915)
13
+ [`be9792b`](https://github.com/graphile/crystal/commit/be9792bea3b39097533b0f86e1d25ee66208909d)
14
+ Thanks [@benjie](https://github.com/benjie)! - Fix some peerDependencies woes
package/LICENSE.md ADDED
@@ -0,0 +1,20 @@
1
+ # The MIT License (MIT)
2
+
3
+ Copyright © `2026` Benjie Gillam
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy of
6
+ this software and associated documentation files (the “Software”), to deal in
7
+ the Software without restriction, including without limitation the rights to
8
+ use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9
+ the Software, and to permit persons to whom the Software is furnished to do so,
10
+ subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17
+ FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18
+ COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19
+ IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20
+ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,6 @@
1
+ # ruru-types
2
+
3
+ Some TypeScript types from `ruru-components` because `npm` has issues with the
4
+ explorer plugin as a peer depenency (due to `react` version mis-match) and this
5
+ helps avoid that entering the dependency graph. Also minimizes the dependencies
6
+ of `ruru` since most of the complexity is bundled already.
@@ -0,0 +1,42 @@
1
+ import type { Fetcher } from "@graphiql/toolkit";
2
+ import type { GraphiQLProps } from "graphiql";
3
+ export type { Fetcher };
4
+ /**
5
+ * The `EventSource` specification only specifies the `withCredentials` option,
6
+ * but some implementations support additional options. Our configuration
7
+ * allows arbitrary options.
8
+ */
9
+ interface RuruEventSourceInit extends EventSourceInit, Record<string, any> {
10
+ }
11
+ export interface RuruProps extends Pick<GraphiQLProps, "editorTheme" | "defaultTheme" | "maxHistoryLength" | "inputValueDeprecation" | "schemaDescription" | "showPersistHeadersSettings" | "onEditQuery" | "onEditVariables" | "onEditHeaders" | "responseTooltip" | "defaultEditorToolsVisibility" | "isHeadersEditorEnabled" | "forcedTheme" | "confirmCloseTab" | "className" | "initialVariables" | "initialQuery" | "initialHeaders" | "defaultQuery" | "defaultHeaders"> {
12
+ /**
13
+ * Optionally override the fetcher.
14
+ */
15
+ fetcher?: Fetcher;
16
+ /**
17
+ * The URL to the GraphQL endpoint. (http:// or https://)
18
+ */
19
+ endpoint?: string;
20
+ /**
21
+ * The URL to the GraphQL subscriptions endpoint. (ws:// or wss://)
22
+ */
23
+ subscriptionEndpoint?: string;
24
+ /**
25
+ * The list of debug tools available to the user.
26
+ *
27
+ * explain - output the SQL executed
28
+ * plan - output the plan executed
29
+ */
30
+ debugTools?: Array<"explain" | "plan">;
31
+ /**
32
+ * Will be passed to `new EventSource(url, eventSourceInit)`.
33
+ *
34
+ * Per the specification, the only option is `withCredentials`; however, some
35
+ * implementations support additional options. For example:
36
+ *
37
+ * - `reconnectInterval: 1000`
38
+ * - `maxReconnectAttempts: 3`
39
+ */
40
+ eventSourceInit?: RuruEventSourceInit;
41
+ }
42
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAE9C,YAAY,EAAE,OAAO,EAAE,CAAC;AAExB;;;;GAIG;AACH,UAAU,mBAAoB,SAAQ,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAAG;AAE7E,MAAM,WAAW,SACf,SAAQ,IAAI,CACV,aAAa,EACX,aAAa,GACb,cAAc,GACd,kBAAkB,GAClB,uBAAuB,GACvB,mBAAmB,GACnB,4BAA4B,GAC5B,aAAa,GACb,iBAAiB,GACjB,eAAe,GACf,iBAAiB,GACjB,8BAA8B,GAC9B,wBAAwB,GACxB,aAAa,GACb,iBAAiB,GACjB,WAAW,GACX,kBAAkB,GAClB,cAAc,GACd,gBAAgB,GAChB,cAAc,GACd,gBAAgB,CACnB;IACD;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,MAAM,CAAC,CAAC;IAEvC;;;;;;;;OAQG;IACH,eAAe,CAAC,EAAE,mBAAmB,CAAC;CACvC"}
package/dist/index.js ADDED
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}
package/package.json ADDED
@@ -0,0 +1,62 @@
1
+ {
2
+ "name": "ruru-types",
3
+ "version": "2.0.0-rc.5",
4
+ "description": "Some TypeScript types for ruru-components",
5
+ "main": "./dist/index.js",
6
+ "types": "./dist/index.d.ts",
7
+ "exports": {
8
+ ".": {
9
+ "types": "./dist/index.d.ts",
10
+ "node": "./dist/index.js",
11
+ "default": "./dist/index.js"
12
+ }
13
+ },
14
+ "scripts": {
15
+ "prepack": "tsc -b"
16
+ },
17
+ "repository": {
18
+ "type": "git",
19
+ "url": "git+https://github.com/graphile/crystal.git"
20
+ },
21
+ "keywords": [
22
+ "graphiql",
23
+ "ruru",
24
+ "types",
25
+ "typescript"
26
+ ],
27
+ "author": "Benjie Gillam <code@benjiegillam.com>",
28
+ "license": "MIT",
29
+ "bugs": {
30
+ "url": "https://github.com/graphile/crystal/issues"
31
+ },
32
+ "homepage": "https://grafast.org/ruru/",
33
+ "engines": {
34
+ "node": ">=22"
35
+ },
36
+ "files": [
37
+ "dist"
38
+ ],
39
+ "dependencies": {
40
+ "@graphiql/toolkit": "^0.11.3",
41
+ "graphiql": "^5.2.1"
42
+ },
43
+ "peerDependencies": {
44
+ "graphql": "^16.9.0",
45
+ "react": "^18 || ^19",
46
+ "react-dom": "^18 || ^19"
47
+ },
48
+ "peerDependenciesMeta": {
49
+ "react": {
50
+ "optional": true
51
+ },
52
+ "react-dom": {
53
+ "optional": true
54
+ }
55
+ },
56
+ "devDependencies": {
57
+ "graphql": "^16.9.0",
58
+ "react": "^18 || ^19",
59
+ "react-dom": "^18 || ^19",
60
+ "typescript": "^5.9.3"
61
+ }
62
+ }