@girs/cally-14 4.4.0 → 4.6.0

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.
Files changed (3) hide show
  1. package/README.md +36 -41
  2. package/cally-14.d.ts +4 -4
  3. package/package.json +19 -19
package/README.md CHANGED
@@ -4,82 +4,77 @@
4
4
  ![version](https://img.shields.io/npm/v/@girs/cally-14)
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/cally-14)
6
6
 
7
+ GJS TypeScript type definitions for Cally-14 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.6.0.
7
8
 
8
- GJS TypeScript type definitions for Cally-14 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.4.0.
9
+ This package contains type declarations only. It ships no runtime code, so it adds
10
+ nothing to your program and works with any bundler or none at all.
9
11
 
10
12
  ## Install
11
13
 
12
- Install the type definitions with npm:
13
14
  ```bash
14
15
  npm install @girs/cally-14
15
16
  ```
16
17
 
17
- ## Usage
18
+ Any package manager works. The package has no dependencies beyond other `@girs/*`
19
+ type packages.
20
+
21
+ ## What it exports
22
+
23
+ | Import | What you get |
24
+ |---|---|
25
+ | `@girs/cally-14` | the namespace as a default export, plus the ambient and global declarations |
26
+ | `@girs/cally-14/ambient` | only the `gi://` module declarations |
27
+ | `@girs/cally-14/import` | only the `imports.gi` declarations |
28
+ | `@girs/cally-14/cally-14` | the namespace, without the side-effecting declarations |
29
+
30
+ ## Three ways to import
31
+
32
+ Which one you use depends on how you write imports elsewhere, not on your toolchain.
33
+
34
+ ### As a module
18
35
 
19
- Import it like any other module:
20
36
  ```ts
21
37
  import Cally from '@girs/cally-14';
22
38
  ```
23
39
 
24
- ### Ambient Modules
40
+ ### As `gi://`
25
41
 
26
- [Ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules) let you write the same import you would in plain JavaScript.
27
- For this you need to include `@girs/cally-14` or `@girs/cally-14/ambient` in your `tsconfig` or entry point Typescript file:
42
+ GJS resolves `gi://` at runtime. To give it types, reference the package once, either
43
+ from your entry point or from `tsconfig.json`:
28
44
 
29
- `index.ts`:
30
45
  ```ts
31
- import '@girs/cally-14'
46
+ import '@girs/cally-14';
32
47
  ```
33
48
 
34
- `tsconfig.json`:
35
49
  ```json
36
- {
37
- "compilerOptions": {
38
- ...
39
- },
40
- "include": ["@girs/cally-14"],
41
- ...
42
- }
50
+ { "include": ["@girs/cally-14"] }
43
51
  ```
44
52
 
45
- The ambient module now resolves with types:
53
+ Then the runtime spelling type-checks:
46
54
 
47
55
  ```ts
48
56
  import Cally from 'gi://Cally?version=14';
49
57
  ```
50
58
 
51
- ### Global import
52
-
53
- GJS's global `imports.gi` works too, with types.
54
- For this you need to include `@girs/cally-14` or `@girs/cally-14/import` in your `tsconfig` or entry point Typescript file:
59
+ Referencing `@girs/cally-14/ambient` instead pulls in these declarations
60
+ alone. See [ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules).
55
61
 
56
- `index.ts`:
57
- ```ts
58
- import '@girs/cally-14'
59
- ```
60
-
61
- `tsconfig.json`:
62
- ```json
63
- {
64
- "compilerOptions": {
65
- ...
66
- },
67
- "include": ["@girs/cally-14"],
68
- ...
69
- }
70
- ```
62
+ ### As `imports.gi`
71
63
 
72
- That form carries types as well:
64
+ GJS's global object works the same way, via `@girs/cally-14/import`:
73
65
 
74
66
  ```ts
75
67
  const Cally = imports.gi.Cally;
76
68
  ```
77
69
 
78
- ### Bundle
70
+ ## Building
79
71
 
80
- Most projects want a bundler. [esbuild](https://esbuild.github.io/) is the smallest thing that works; the [examples directory](https://github.com/gjsify/ts-for-gir/tree/main/examples) has setups for several others.
72
+ The declarations need no build step. If you bundle, every bundler works, since there is
73
+ no runtime code to resolve. The [examples](https://github.com/gjsify/ts-for-gir/tree/main/examples)
74
+ show working setups for several.
81
75
 
82
76
  ## Other packages
83
77
 
84
- All existing pre-generated packages can be found on [gjsify/types](https://github.com/gjsify/types).
78
+ Every pre-generated package is at [gjsify/types](https://github.com/gjsify/types).
79
+
85
80
 
package/cally-14.d.ts CHANGED
@@ -70,7 +70,7 @@ export namespace Cally {
70
70
 
71
71
  namespace Actor {
72
72
  // Signal signatures
73
- interface SignalSignatures extends Atk.GObjectAccessible.SignalSignatures {
73
+ interface SignalSignatures extends Atk.GObjectAccessible.SignalSignatures, Atk.Component.SignalSignatures {
74
74
  "notify::accessible-component-layer": (pspec: GObject.ParamSpec) => void;
75
75
  "notify::accessible-component-mdi-zorder": (pspec: GObject.ParamSpec) => void;
76
76
  "notify::accessible-description": (pspec: GObject.ParamSpec) => void;
@@ -668,7 +668,7 @@ export namespace Cally {
668
668
 
669
669
  namespace Clone {
670
670
  // Signal signatures
671
- interface SignalSignatures extends Actor.SignalSignatures {
671
+ interface SignalSignatures extends Actor.SignalSignatures, Atk.Component.SignalSignatures {
672
672
  "notify::accessible-component-layer": (pspec: GObject.ParamSpec) => void;
673
673
  "notify::accessible-component-mdi-zorder": (pspec: GObject.ParamSpec) => void;
674
674
  "notify::accessible-description": (pspec: GObject.ParamSpec) => void;
@@ -1315,7 +1315,7 @@ export namespace Cally {
1315
1315
 
1316
1316
  namespace Stage {
1317
1317
  // Signal signatures
1318
- interface SignalSignatures extends Actor.SignalSignatures {
1318
+ interface SignalSignatures extends Actor.SignalSignatures, Atk.Component.SignalSignatures, Atk.Window.SignalSignatures {
1319
1319
  "notify::accessible-component-layer": (pspec: GObject.ParamSpec) => void;
1320
1320
  "notify::accessible-component-mdi-zorder": (pspec: GObject.ParamSpec) => void;
1321
1321
  "notify::accessible-description": (pspec: GObject.ParamSpec) => void;
@@ -1892,7 +1892,7 @@ export namespace Cally {
1892
1892
 
1893
1893
  namespace Text {
1894
1894
  // Signal signatures
1895
- interface SignalSignatures extends Actor.SignalSignatures {
1895
+ interface SignalSignatures extends Actor.SignalSignatures, Atk.Component.SignalSignatures, Atk.Text.SignalSignatures {
1896
1896
  "notify::accessible-component-layer": (pspec: GObject.ParamSpec) => void;
1897
1897
  "notify::accessible-component-mdi-zorder": (pspec: GObject.ParamSpec) => void;
1898
1898
  "notify::accessible-description": (pspec: GObject.ParamSpec) => void;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/cally-14",
3
- "version": "4.4.0",
3
+ "version": "4.6.0",
4
4
  "description": "GJS TypeScript type definitions for Cally-14",
5
5
  "type": "module",
6
6
  "module": "cally-14.js",
@@ -31,24 +31,24 @@
31
31
  "test": "tsc --project tsconfig.json"
32
32
  },
33
33
  "dependencies": {
34
- "@girs/gjs": "^4.4.0",
35
- "@girs/mtk-14": "^4.4.0",
36
- "@girs/graphene-1.0": "^4.4.0",
37
- "@girs/gobject-2.0": "^4.4.0",
38
- "@girs/glib-2.0": "^4.4.0",
39
- "@girs/coglpango-14": "^4.4.0",
40
- "@girs/pangocairo-1.0": "^4.4.0",
41
- "@girs/cairo-1.0": "^4.4.0",
42
- "@girs/pango-1.0": "^4.4.0",
43
- "@girs/harfbuzz-0.0": "^4.4.0",
44
- "@girs/freetype2-2.0": "^4.4.0",
45
- "@girs/gio-2.0": "^4.4.0",
46
- "@girs/gmodule-2.0": "^4.4.0",
47
- "@girs/cogl-14": "^4.4.0",
48
- "@girs/xlib-2.0": "^4.4.0",
49
- "@girs/gl-1.0": "^4.4.0",
50
- "@girs/clutter-14": "^4.4.0",
51
- "@girs/atk-1.0": "^4.4.0" },
34
+ "@girs/gjs": "^4.6.0",
35
+ "@girs/mtk-14": "^4.6.0",
36
+ "@girs/graphene-1.0": "^4.6.0",
37
+ "@girs/gobject-2.0": "^4.6.0",
38
+ "@girs/glib-2.0": "^4.6.0",
39
+ "@girs/coglpango-14": "^4.6.0",
40
+ "@girs/pangocairo-1.0": "^4.6.0",
41
+ "@girs/cairo-1.0": "^4.6.0",
42
+ "@girs/pango-1.0": "^4.6.0",
43
+ "@girs/harfbuzz-0.0": "^4.6.0",
44
+ "@girs/freetype2-2.0": "^4.6.0",
45
+ "@girs/gio-2.0": "^4.6.0",
46
+ "@girs/gmodule-2.0": "^4.6.0",
47
+ "@girs/cogl-14": "^4.6.0",
48
+ "@girs/xlib-2.0": "^4.6.0",
49
+ "@girs/gl-1.0": "^4.6.0",
50
+ "@girs/clutter-14": "^4.6.0",
51
+ "@girs/atk-1.0": "^4.6.0" },
52
52
  "devDependencies": {
53
53
  "typescript": "*"
54
54
  },