@girs/gcalc-1 4.3.0 → 4.5.0

package/README.md

@@ -4,82 +4,77 @@
 ![version](https://img.shields.io/npm/v/@girs/gcalc-1)
 ![downloads/week](https://img.shields.io/npm/dw/@girs/gcalc-1)
 
+GJS TypeScript type definitions for GCalc-1 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.5.0.
 
-GJS TypeScript type definitions for GCalc-1 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.3.0.
+This package contains type declarations only. It ships no runtime code, so it adds
+nothing to your program and works with any bundler or none at all.
 
 ## Install
 
-Install the type definitions with npm:
 ```bash
 npm install @girs/gcalc-1
 ```
 
-## Usage
+Any package manager works. The package has no dependencies beyond other `@girs/*`
+type packages.
+
+## What it exports
+
+| Import | What you get |
+|---|---|
+| `@girs/gcalc-1` | the namespace as a default export, plus the ambient and global declarations |
+| `@girs/gcalc-1/ambient` | only the `gi://` module declarations |
+| `@girs/gcalc-1/import` | only the `imports.gi` declarations |
+| `@girs/gcalc-1/gcalc-1` | the namespace, without the side-effecting declarations |
+
+## Three ways to import
+
+Which one you use depends on how you write imports elsewhere, not on your toolchain.
+
+### As a module
 
-Import it like any other module:
 ```ts
 import GCalc from '@girs/gcalc-1';
 ```
 
-### Ambient Modules
+### As `gi://`
 
-[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.
-For this you need to include `@girs/gcalc-1` or `@girs/gcalc-1/ambient` in your `tsconfig` or entry point Typescript file:
+GJS resolves `gi://` at runtime. To give it types, reference the package once, either
+from your entry point or from `tsconfig.json`:
 
-`index.ts`:
 ```ts
-import '@girs/gcalc-1'
+import '@girs/gcalc-1';
 ```
 
-`tsconfig.json`:
 ```json
-{
-  "compilerOptions": {
-    ...
-  },
-  "include": ["@girs/gcalc-1"],
-  ...
-}
+{ "include": ["@girs/gcalc-1"] }
 ```
 
-The ambient module now resolves with types:
+Then the runtime spelling type-checks:
 
 ```ts
 import GCalc from 'gi://GCalc?version=1';
 ```
 
-### Global import
-
-GJS's global `imports.gi` works too, with types.
-For this you need to include `@girs/gcalc-1` or `@girs/gcalc-1/import` in your `tsconfig` or entry point Typescript file:
+Referencing `@girs/gcalc-1/ambient` instead pulls in these declarations
+alone. See [ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules).
 
-`index.ts`:
-```ts
-import '@girs/gcalc-1'
-```
-
-`tsconfig.json`:
-```json
-{
-  "compilerOptions": {
-    ...
-  },
-  "include": ["@girs/gcalc-1"],
-  ...
-}
-```
+### As `imports.gi`
 
-That form carries types as well:
+GJS's global object works the same way, via `@girs/gcalc-1/import`:
 
 ```ts
 const GCalc = imports.gi.GCalc;
 ```
 
-### Bundle
+## Building
 
-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.
+The declarations need no build step. If you bundle, every bundler works, since there is
+no runtime code to resolve. The [examples](https://github.com/gjsify/ts-for-gir/tree/main/examples)
+show working setups for several.
 
 ## Other packages
 
-All existing pre-generated packages can be found on [gjsify/types](https://github.com/gjsify/types).
+Every pre-generated package is at [gjsify/types](https://github.com/gjsify/types).
+
 

package/gcalc-1.d.ts

@@ -145,47 +145,47 @@ export namespace GCalc {
      * @gir-type Enum
      */
     enum GParserTokenType {
-        NONE,
-        EOF,
-        IDENTIFIER,
-        INTEGER_LITERAL,
-        REAL_LITERAL,
-        STAR,
-        PLUS,
-        DIV,
-        MINUS,
-        ASSIGN,
-        OPEN_PARENS,
-        CLOSE_PARENS,
-        CARRET,
-        CLOSE_BRACE,
-        CLOSE_BRACKET,
-        OPEN_BRACE,
-        OPEN_BRACKET,
-        STRING_LITERAL,
-        OP_AND,
-        OP_COALESCING,
-        OP_DEC,
-        OP_EQ,
-        OP_GE,
-        OP_GT,
-        OP_INC,
-        OP_LE,
-        OP_LT,
-        OP_NE,
-        OP_NEG,
-        OP_OR,
-        OP_PTR,
-        OP_SHIFT_LEFT,
-        SEMICOLON,
-        TILDE,
-        COLON,
-        COMMA,
-        DOUBLE_COLON,
-        DOT,
-        ELLIPSIS,
-        INTERR,
-        HASH,
+        NONE = 0,
+        EOF = 1,
+        IDENTIFIER = 2,
+        INTEGER_LITERAL = 3,
+        REAL_LITERAL = 4,
+        STAR = 5,
+        PLUS = 6,
+        DIV = 7,
+        MINUS = 8,
+        ASSIGN = 9,
+        OPEN_PARENS = 10,
+        CLOSE_PARENS = 11,
+        CARRET = 12,
+        CLOSE_BRACE = 13,
+        CLOSE_BRACKET = 14,
+        OPEN_BRACE = 15,
+        OPEN_BRACKET = 16,
+        STRING_LITERAL = 17,
+        OP_AND = 18,
+        OP_COALESCING = 19,
+        OP_DEC = 20,
+        OP_EQ = 21,
+        OP_GE = 22,
+        OP_GT = 23,
+        OP_INC = 24,
+        OP_LE = 25,
+        OP_LT = 26,
+        OP_NE = 27,
+        OP_NEG = 28,
+        OP_OR = 29,
+        OP_PTR = 30,
+        OP_SHIFT_LEFT = 31,
+        SEMICOLON = 32,
+        TILDE = 33,
+        COLON = 34,
+        COMMA = 35,
+        DOUBLE_COLON = 36,
+        DOT = 37,
+        ELLIPSIS = 38,
+        INTERR = 39,
+        HASH = 40,
     }
 
 
@@ -200,9 +200,9 @@ export namespace GCalc {
      * @gir-type Enum
      */
     enum GroupLevel {
-        ONE,
-        TWO,
-        THREE,
+        ONE = 0,
+        TWO = 1,
+        THREE = 2,
     }
 
 
@@ -329,6 +329,7 @@ export namespace GCalc {
          * The item type of a {@link Gio.ListModel} can not change during the life of the
          * model.
          * @returns the {@link GObject.GType} of the items contained in `list`.
+         * @since 2.44
          */
         get_item_type(): GObject.GType;
 
@@ -339,6 +340,7 @@ export namespace GCalc {
          * less efficient than iterating the list with increasing values for
          * `position` until `g_list_model_get_item()` returns `null`.
          * @returns the number of items in `list`.
+         * @since 2.44
          */
         get_n_items(): number;
 
@@ -357,6 +359,7 @@ export namespace GCalc {
          * See also: `g_list_model_get_n_items()`
          * @param position the position of the item to fetch
          * @returns the object at `position`.
+         * @since 2.44
          */
         get_item(position: number): A | null;
 
@@ -384,6 +387,7 @@ export namespace GCalc {
          * @param position the position at which `list` changed
          * @param removed the number of items removed
          * @param added the number of items added
+         * @since 2.44
          */
         items_changed(position: number, removed: number, added: number): void;
 
@@ -396,6 +400,7 @@ export namespace GCalc {
          * 
          * The same {@link GObject.Object} instance may not appear more than once in a {@link Gio.ListModel}.
          * @param position the position of the item to fetch
+         * @since 2.44
          * @virtual
          */
         vfunc_get_item(position: number): A | null;
@@ -409,6 +414,7 @@ export namespace GCalc {
          * 
          * The item type of a {@link Gio.ListModel} can not change during the life of the
          * model.
+         * @since 2.44
          * @virtual
          */
         vfunc_get_item_type(): GObject.GType;
@@ -419,6 +425,7 @@ export namespace GCalc {
          * Depending on the model implementation, calling this function may be
          * less efficient than iterating the list with increasing values for
          * `position` until `g_list_model_get_item()` returns `null`.
+         * @since 2.44
          * @virtual
          */
         vfunc_get_n_items(): number;
@@ -1393,6 +1400,9 @@ export namespace GCalc {
         emit<K extends keyof GAssign.SignalSignatures>(signal: K, ...args: GObject.GjsParameters<GAssign.SignalSignatures[K]> extends [any, ...infer Q] ? Q : never): void;
         emit(signal: string, ...args: any[]): void;
 
+        /**
+         * @throws GLib.Error
+         */
         evaluate(): Expression;
     }
 
@@ -1711,6 +1721,9 @@ export namespace GCalc {
         vfunc_evaluate(): Expression;
 
         // Methods
+        /**
+         * @throws GLib.Error
+         */
         evaluate(): Expression;
 
         /**
@@ -1741,6 +1754,9 @@ export namespace GCalc {
         get closed(): boolean;
         set closed(val: boolean);
 
+        /**
+         * @throws GLib.Error
+         */
         verify_params(): boolean;
 
         get_param_types(): ExpressionContainer;
@@ -2100,6 +2116,7 @@ export namespace GCalc {
         /**
          * @param str 
          * @param eqman 
+         * @throws GLib.Error
          */
         parse(str: string, eqman: MathEquationManager): void;
 
@@ -2197,6 +2214,9 @@ export namespace GCalc {
         emit<K extends keyof GPolynomial.SignalSignatures>(signal: K, ...args: GObject.GjsParameters<GPolynomial.SignalSignatures[K]> extends [any, ...infer Q] ? Q : never): void;
         emit(signal: string, ...args: any[]): void;
 
+        /**
+         * @throws GLib.Error
+         */
         evaluate(): Expression;
 
         /**
@@ -2372,6 +2392,9 @@ export namespace GCalc {
         get closed(): boolean;
         set closed(val: boolean);
 
+        /**
+         * @throws GLib.Error
+         */
         evaluate(): Expression;
 
         get_level(): GroupLevel;
@@ -2472,6 +2495,7 @@ export namespace GCalc {
 
         /**
          * @param str 
+         * @throws GLib.Error
          */
         solve(str: string): Result;
 
@@ -2546,9 +2570,13 @@ export namespace GCalc {
 
         /**
          * @param t 
+         * @throws GLib.Error
          */
         add(t: Term): Expression;
 
+        /**
+         * @throws GLib.Error
+         */
         evaluate(): Expression;
 
         /**
@@ -2626,6 +2654,9 @@ export namespace GCalc {
         get bind(): Variable;
         set bind(val: Variable);
 
+        /**
+         * @throws GLib.Error
+         */
         evaluate(): Expression;
 
         get_name(): string;
@@ -3310,6 +3341,9 @@ export namespace GCalc {
     interface Assign extends GObject.Object {
 
         // Methods
+        /**
+         * @throws GLib.Error
+         */
         evaluate(): Expression;
     }
 
@@ -3666,8 +3700,14 @@ export namespace GCalc {
         set closed(val: boolean);
 
         // Methods
+        /**
+         * @throws GLib.Error
+         */
         evaluate(): Expression;
 
+        /**
+         * @throws GLib.Error
+         */
         verify_params(): boolean;
 
         get_param_types(): ExpressionContainer;
@@ -3805,6 +3845,9 @@ export namespace GCalc {
         set closed(val: boolean);
 
         // Methods
+        /**
+         * @throws GLib.Error
+         */
         evaluate(): Expression;
 
         get_level(): GroupLevel;
@@ -4091,6 +4134,9 @@ export namespace GCalc {
     interface Polynomial extends GObject.Object, Polynomial.Interface {
 
         // Methods
+        /**
+         * @throws GLib.Error
+         */
         evaluate(): Expression;
     }
 
@@ -4225,6 +4271,7 @@ export namespace GCalc {
         // Methods
         /**
          * @param str 
+         * @throws GLib.Error
          */
         solve(str: string): Result;
 
@@ -4284,9 +4331,13 @@ export namespace GCalc {
         // Methods
         /**
          * @param t 
+         * @throws GLib.Error
          */
         add(t: Term): Expression;
 
+        /**
+         * @throws GLib.Error
+         */
         evaluate(): Expression;
     }
 
@@ -4376,6 +4427,9 @@ export namespace GCalc {
         set bind(val: Variable);
 
         // Methods
+        /**
+         * @throws GLib.Error
+         */
         evaluate(): Expression;
 
         get_name(): string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@girs/gcalc-1",
-    "version": "4.3.0",
+    "version": "4.5.0",
     "description": "GJS TypeScript type definitions for GCalc-1",
     "type": "module",
     "module": "gcalc-1.js",
@@ -31,12 +31,12 @@
       "test": "tsc --project tsconfig.json"
     },
     "dependencies": {
-      "@girs/gjs": "^4.3.0",
-      "@girs/gobject-2.0": "^4.3.0",
-      "@girs/glib-2.0": "^4.3.0",
-      "@girs/gio-2.0": "^4.3.0",
-      "@girs/gmodule-2.0": "^4.3.0",
-      "@girs/gee-0.8": "^4.3.0"    },
+      "@girs/gjs": "^4.5.0",
+      "@girs/gobject-2.0": "^4.5.0",
+      "@girs/glib-2.0": "^4.5.0",
+      "@girs/gio-2.0": "^4.5.0",
+      "@girs/gmodule-2.0": "^4.5.0",
+      "@girs/gee-0.8": "^4.5.0"    },
     "devDependencies": {
       "typescript": "*"
     },