@girs/caja-2.0 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/caja-2.0.d.ts +11 -3
  3. package/package.json +15 -15
package/README.md CHANGED
@@ -4,82 +4,77 @@
4
4
  ![version](https://img.shields.io/npm/v/@girs/caja-2.0)
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/caja-2.0)
6
6
 
7
+ GJS TypeScript type definitions for Caja-2.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.6.0.
7
8
 
8
- GJS TypeScript type definitions for Caja-2.0 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/caja-2.0
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/caja-2.0` | the namespace as a default export, plus the ambient and global declarations |
26
+ | `@girs/caja-2.0/ambient` | only the `gi://` module declarations |
27
+ | `@girs/caja-2.0/import` | only the `imports.gi` declarations |
28
+ | `@girs/caja-2.0/caja-2.0` | 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 Caja from '@girs/caja-2.0';
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/caja-2.0` or `@girs/caja-2.0/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/caja-2.0'
46
+ import '@girs/caja-2.0';
32
47
  ```
33
48
 
34
- `tsconfig.json`:
35
49
  ```json
36
- {
37
- "compilerOptions": {
38
- ...
39
- },
40
- "include": ["@girs/caja-2.0"],
41
- ...
42
- }
50
+ { "include": ["@girs/caja-2.0"] }
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 Caja from 'gi://Caja?version=2.0';
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/caja-2.0` or `@girs/caja-2.0/import` in your `tsconfig` or entry point Typescript file:
59
+ Referencing `@girs/caja-2.0/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/caja-2.0'
59
- ```
60
-
61
- `tsconfig.json`:
62
- ```json
63
- {
64
- "compilerOptions": {
65
- ...
66
- },
67
- "include": ["@girs/caja-2.0"],
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/caja-2.0/import`:
73
65
 
74
66
  ```ts
75
67
  const Caja = imports.gi.Caja;
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/caja-2.0.d.ts CHANGED
@@ -47,17 +47,17 @@ export namespace Caja {
47
47
  * the operation succeeded, and the extension
48
48
  * is done with the request.
49
49
  */
50
- COMPLETE,
50
+ COMPLETE = 0,
51
51
  /**
52
52
  * the operation failed.
53
53
  */
54
- FAILED,
54
+ FAILED = 1,
55
55
  /**
56
56
  * the extension has begin an async operation.
57
57
  * When this value is returned, the extension must set the handle parameter
58
58
  * and call the callback closure when the operation is complete.
59
59
  */
60
- IN_PROGRESS,
60
+ IN_PROGRESS = 2,
61
61
  }
62
62
 
63
63
 
@@ -1039,6 +1039,14 @@ export namespace Caja {
1039
1039
  };
1040
1040
 
1041
1041
  namespace MenuProvider {
1042
+ // Signal signatures
1043
+ interface SignalSignatures {
1044
+ /**
1045
+ * @signal
1046
+ * @run-last
1047
+ */
1048
+ "items-updated": () => void;
1049
+ }
1042
1050
  /**
1043
1051
  * Interface for implementing MenuProvider.
1044
1052
  * Contains only the virtual methods that need to be implemented.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/caja-2.0",
3
- "version": "4.4.0",
3
+ "version": "4.6.0",
4
4
  "description": "GJS TypeScript type definitions for Caja-2.0",
5
5
  "type": "module",
6
6
  "module": "caja-2.0.js",
@@ -31,20 +31,20 @@
31
31
  "test": "tsc --project tsconfig.json"
32
32
  },
33
33
  "dependencies": {
34
- "@girs/gjs": "^4.4.0",
35
- "@girs/gtk-3.0": "^4.4.0",
36
- "@girs/xlib-2.0": "^4.4.0",
37
- "@girs/gdk-3.0": "^4.4.0",
38
- "@girs/cairo-1.0": "^4.4.0",
39
- "@girs/gobject-2.0": "^4.4.0",
40
- "@girs/glib-2.0": "^4.4.0",
41
- "@girs/pango-1.0": "^4.4.0",
42
- "@girs/harfbuzz-0.0": "^4.4.0",
43
- "@girs/freetype2-2.0": "^4.4.0",
44
- "@girs/gio-2.0": "^4.4.0",
45
- "@girs/gmodule-2.0": "^4.4.0",
46
- "@girs/gdkpixbuf-2.0": "^4.4.0",
47
- "@girs/atk-1.0": "^4.4.0" },
34
+ "@girs/gjs": "^4.6.0",
35
+ "@girs/gtk-3.0": "^4.6.0",
36
+ "@girs/xlib-2.0": "^4.6.0",
37
+ "@girs/gdk-3.0": "^4.6.0",
38
+ "@girs/cairo-1.0": "^4.6.0",
39
+ "@girs/gobject-2.0": "^4.6.0",
40
+ "@girs/glib-2.0": "^4.6.0",
41
+ "@girs/pango-1.0": "^4.6.0",
42
+ "@girs/harfbuzz-0.0": "^4.6.0",
43
+ "@girs/freetype2-2.0": "^4.6.0",
44
+ "@girs/gio-2.0": "^4.6.0",
45
+ "@girs/gmodule-2.0": "^4.6.0",
46
+ "@girs/gdkpixbuf-2.0": "^4.6.0",
47
+ "@girs/atk-1.0": "^4.6.0" },
48
48
  "devDependencies": {
49
49
  "typescript": "*"
50
50
  },