@girs/cvc-1.0 4.4.0 → 4.5.0

package/README.md

@@ -4,82 +4,77 @@
 ![version](https://img.shields.io/npm/v/@girs/cvc-1.0)
 ![downloads/week](https://img.shields.io/npm/dw/@girs/cvc-1.0)
 
+GJS TypeScript type definitions for Cvc-1.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.5.0.
 
-GJS TypeScript type definitions for Cvc-1.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.4.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/cvc-1.0
 ```
 
-## Usage
+Any package manager works. The package has no dependencies beyond other `@girs/*`
+type packages.
+
+## What it exports
+
+| Import | What you get |
+|---|---|
+| `@girs/cvc-1.0` | the namespace as a default export, plus the ambient and global declarations |
+| `@girs/cvc-1.0/ambient` | only the `gi://` module declarations |
+| `@girs/cvc-1.0/import` | only the `imports.gi` declarations |
+| `@girs/cvc-1.0/cvc-1.0` | 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 Cvc from '@girs/cvc-1.0';
 ```
 
-### 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/cvc-1.0` or `@girs/cvc-1.0/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/cvc-1.0'
+import '@girs/cvc-1.0';
 ```
 
-`tsconfig.json`:
 ```json
-{
-  "compilerOptions": {
-    ...
-  },
-  "include": ["@girs/cvc-1.0"],
-  ...
-}
+{ "include": ["@girs/cvc-1.0"] }
 ```
 
-The ambient module now resolves with types:
+Then the runtime spelling type-checks:
 
 ```ts
 import Cvc from 'gi://Cvc?version=1.0';
 ```
 
-### Global import
-
-GJS's global `imports.gi` works too, with types.
-For this you need to include `@girs/cvc-1.0` or `@girs/cvc-1.0/import` in your `tsconfig` or entry point Typescript file:
+Referencing `@girs/cvc-1.0/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/cvc-1.0'
-```
-
-`tsconfig.json`:
-```json
-{
-  "compilerOptions": {
-    ...
-  },
-  "include": ["@girs/cvc-1.0"],
-  ...
-}
-```
+### As `imports.gi`
 
-That form carries types as well:
+GJS's global object works the same way, via `@girs/cvc-1.0/import`:
 
 ```ts
 const Cvc = imports.gi.Cvc;
 ```
 
-### 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/cvc-1.0.d.ts

@@ -34,10 +34,10 @@ export namespace Cvc {
      * @gir-type Enum
      */
     enum MixerControlState {
-        CLOSED,
-        READY,
-        CONNECTING,
-        FAILED,
+        CLOSED = 0,
+        READY = 1,
+        CONNECTING = 2,
+        FAILED = 3,
     }
 
 
@@ -52,10 +52,10 @@ export namespace Cvc {
      * @gir-type Enum
      */
     enum MixerStreamState {
-        INVALID,
-        RUNNING,
-        IDLE,
-        SUSPENDED,
+        INVALID = 0,
+        RUNNING = 1,
+        IDLE = 2,
+        SUSPENDED = 3,
     }
 
 
@@ -70,11 +70,14 @@ export namespace Cvc {
      * @gir-type Enum
      */
     enum MixerUIDeviceDirection {
-        INPUT,
-        OUTPUT,
+        INPUT = 0,
+        OUTPUT = 1,
     }
 
 
+    /**
+     * @default 0
+     */
     const MIXER_UI_DEVICE_INVALID: number;
 
     /**
@@ -88,10 +91,10 @@ export namespace Cvc {
      * @gir-type Flags
      */
     enum HeadsetPortChoice {
-        NONE,
-        HEADPHONES,
-        HEADSET,
-        MIC,
+        NONE = 0,
+        HEADPHONES = 1,
+        HEADSET = 2,
+        MIC = 4,
     }
 
 
@@ -102,7 +105,7 @@ export namespace Cvc {
              * @signal
              * @run-last
              */
-            "volume-changed": (arg0: boolean) => void;
+            "volume-changed": (object: boolean) => void;
         }
 
         // Constructor properties interface
@@ -367,77 +370,77 @@ export namespace Cvc {
              * @signal
              * @run-last
              */
-            "active-input-update": (arg0: number) => void;
+            "active-input-update": (object: number) => void;
             /**
              * @signal
              * @run-last
              */
-            "active-output-update": (arg0: number) => void;
+            "active-output-update": (object: number) => void;
             /**
              * @signal
              * @run-last
              */
-            "audio-device-selection-needed": (arg0: number, arg1: boolean, arg2: number) => void;
+            "audio-device-selection-needed": (object: number, p0: boolean, p1: number) => void;
             /**
              * @signal
              * @run-last
              */
-            "card-added": (arg0: number) => void;
+            "card-added": (object: number) => void;
             /**
              * @signal
              * @run-last
              */
-            "card-removed": (arg0: number) => void;
+            "card-removed": (object: number) => void;
             /**
              * @signal
              * @run-last
              */
-            "default-sink-changed": (arg0: number) => void;
+            "default-sink-changed": (object: number) => void;
             /**
              * @signal
              * @run-last
              */
-            "default-source-changed": (arg0: number) => void;
+            "default-source-changed": (object: number) => void;
             /**
              * @signal
              * @run-last
              */
-            "input-added": (arg0: number) => void;
+            "input-added": (object: number) => void;
             /**
              * @signal
              * @run-last
              */
-            "input-removed": (arg0: number) => void;
+            "input-removed": (object: number) => void;
             /**
              * @signal
              * @run-last
              */
-            "output-added": (arg0: number) => void;
+            "output-added": (object: number) => void;
             /**
              * @signal
              * @run-last
              */
-            "output-removed": (arg0: number) => void;
+            "output-removed": (object: number) => void;
             /**
              * @signal
              * @run-last
              */
-            "state-changed": (arg0: number) => void;
+            "state-changed": (object: number) => void;
             /**
              * @signal
              * @run-last
              */
-            "stream-added": (arg0: number) => void;
+            "stream-added": (object: number) => void;
             /**
              * @signal
              * @run-last
              */
-            "stream-changed": (arg0: number) => void;
+            "stream-changed": (object: number) => void;
             /**
              * @signal
              * @run-last
              */
-            "stream-removed": (arg0: number) => void;
+            "stream-removed": (object: number) => void;
             "notify::name": (pspec: GObject.ParamSpec) => void;
         }
 
@@ -1014,7 +1017,7 @@ export namespace Cvc {
              * @signal
              * @run-last
              */
-            "monitor-update": (arg0: number) => void;
+            "monitor-update": (object: number) => void;
             "notify::application-id": (pspec: GObject.ParamSpec) => void;
             "notify::can-decibel": (pspec: GObject.ParamSpec) => void;
             "notify::card-index": (pspec: GObject.ParamSpec) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@girs/cvc-1.0",
-    "version": "4.4.0",
+    "version": "4.5.0",
     "description": "GJS TypeScript type definitions for Cvc-1.0",
     "type": "module",
     "module": "cvc-1.0.js",
@@ -31,11 +31,11 @@
       "test": "tsc --project tsconfig.json"
     },
     "dependencies": {
-      "@girs/gjs": "^4.4.0",
-      "@girs/gio-2.0": "^4.4.0",
-      "@girs/gobject-2.0": "^4.4.0",
-      "@girs/glib-2.0": "^4.4.0",
-      "@girs/gmodule-2.0": "^4.4.0"    },
+      "@girs/gjs": "^4.5.0",
+      "@girs/gio-2.0": "^4.5.0",
+      "@girs/gobject-2.0": "^4.5.0",
+      "@girs/glib-2.0": "^4.5.0",
+      "@girs/gmodule-2.0": "^4.5.0"    },
     "devDependencies": {
       "typescript": "*"
     },