@girs/appstreamcompose-1.0 4.4.0 → 4.5.0

package/README.md

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

@@ -60,19 +60,19 @@ export namespace AppStreamCompose {
         /**
          * Ignore icons of this size.
          */
-        IGNORED,
+        IGNORED = 0,
         /**
          * Create cache for the icon, and provide remote link as well.
          */
-        CACHED_REMOTE,
+        CACHED_REMOTE = 1,
         /**
          * Set if the icon should be stored in an icon tarball and be cached locally.
          */
-        CACHED_ONLY,
+        CACHED_ONLY = 2,
         /**
          * Set if this icon should be stored remotely and fetched on demand.
          */
-        REMOTE_ONLY,
+        REMOTE_ONLY = 3,
     }
 
 
@@ -117,43 +117,43 @@ export namespace AppStreamCompose {
         /**
          * Unknown image format.
          */
-        UNKNOWN,
+        UNKNOWN = 0,
         /**
          * PNG format
          */
-        PNG,
+        PNG = 1,
         /**
          * JPEG-XL format
          */
-        JXL,
+        JXL = 2,
         /**
          * AVIF format
          */
-        AVIF,
+        AVIF = 3,
         /**
          * WebP format
          */
-        WEBP,
+        WEBP = 4,
         /**
          * SVG format
          */
-        SVG,
+        SVG = 5,
         /**
          * Compressed SVG format
          */
-        SVGZ,
+        SVGZ = 6,
         /**
          * JPEG format
          */
-        JPEG,
+        JPEG = 7,
         /**
          * GIF format
          */
-        GIF,
+        GIF = 8,
         /**
          * XPM format
          */
-        XPM,
+        XPM = 9,
     }
 
 
@@ -332,6 +332,7 @@ export namespace AppStreamCompose {
      * @param format Target image format, e.g. {@link AppStreamCompose.ImageFormat.PNG}
      * @param filename Filename to write to.
      * @returns `true` for success
+     * @throws GLib.Error
      */
     function render_svg_to_file(stream: Gio.InputStream, width: number, height: number, format: ImageFormat, filename: string): boolean;
 
@@ -353,20 +354,20 @@ export namespace AppStreamCompose {
      * @gir-type Flags
      */
     enum ComposeFlags {
-        NONE,
-        USE_THREADS,
-        ALLOW_NET,
-        VALIDATE,
-        STORE_SCREENSHOTS,
-        ALLOW_SCREENCASTS,
-        PROCESS_FONTS,
-        PROCESS_TRANSLATIONS,
-        IGNORE_ICONS,
-        PROCESS_UNPAIRED_DESKTOP,
-        PROPAGATE_CUSTOM,
-        PROPAGATE_ARTIFACTS,
-        NO_FINAL_CHECK,
-        NO_PARTIAL_URLS,
+        NONE = 0,
+        USE_THREADS = 1,
+        ALLOW_NET = 2,
+        VALIDATE = 4,
+        STORE_SCREENSHOTS = 8,
+        ALLOW_SCREENCASTS = 16,
+        PROCESS_FONTS = 32,
+        PROCESS_TRANSLATIONS = 64,
+        IGNORE_ICONS = 128,
+        PROCESS_UNPAIRED_DESKTOP = 256,
+        PROPAGATE_CUSTOM = 512,
+        PROPAGATE_ARTIFACTS = 1024,
+        NO_FINAL_CHECK = 2048,
+        NO_PARTIAL_URLS = 4096,
     }
 
 
@@ -385,19 +386,19 @@ export namespace AppStreamCompose {
         /**
          * No special flags set
          */
-        NONE,
+        NONE = 0,
         /**
          * Sharpen the resulting image
          */
-        SHARPEN,
+        SHARPEN = 1,
         /**
          * Allow loading of unsupported image types.
          */
-        ALLOW_UNSUPPORTED,
+        ALLOW_UNSUPPORTED = 2,
         /**
          * Always resize the source image to the perfect size
          */
-        ALWAYS_RESIZE,
+        ALWAYS_RESIZE = 4,
     }
 
 
@@ -416,23 +417,23 @@ export namespace AppStreamCompose {
         /**
          * No special flags set
          */
-        NONE,
+        NONE = 0,
         /**
          * Optimize generated PNG for size
          */
-        OPTIMIZE,
+        OPTIMIZE = 1,
         /**
          * Pad with alpha to 16:9 aspect
          */
-        PAD_16_9,
+        PAD_16_9 = 2,
         /**
          * Sharpen the image to clarify detail
          */
-        SHARPEN,
+        SHARPEN = 4,
         /**
          * Blur the image to clear detail
          */
-        BLUR,
+        BLUR = 8,
     }
 
 
@@ -631,6 +632,7 @@ export namespace AppStreamCompose {
          * found components.
          * @param cancellable a {@link Gio.Cancellable}.
          * @returns The results, or `null` on error
+         * @throws GLib.Error
          */
         run(cancellable: Gio.Cancellable | null): Result[];
 
@@ -960,6 +962,7 @@ export namespace AppStreamCompose {
         /**
          * Loads the icon policy from a textual representation.
          * @param serialized_policy A policy string as returned by %asc_icon_policy_to_string
+         * @throws GLib.Error
          */
         from_string(serialized_policy: string): boolean;
 
@@ -1052,6 +1055,7 @@ export namespace AppStreamCompose {
          * @param src_size_min The smallest source size (width or height) allowed, or 0 for no limit
          * @param flags a {@link AppStreamCompose.ImageLoadFlags}, e.g. {@link AppStreamCompose.ImageLoadFlags.NONE}
          * @returns `true` for success
+         * @throws GLib.Error
          */
         load_filename(filename: string, dest_width: number, dest_height: number, src_size_min: number, flags: ImageLoadFlags): boolean;
 
@@ -1062,6 +1066,7 @@ export namespace AppStreamCompose {
          * @param height target height, or 0 for default
          * @param flags some {@link AppStreamCompose.ImageSaveFlags} values, e.g. {@link AppStreamCompose.ImageSaveFlags.PAD_16_9}
          * @returns `true` for success
+         * @throws GLib.Error
          */
         save_filename(filename: string, width: number, height: number, flags: ImageSaveFlags): boolean;
 
@@ -1144,6 +1149,7 @@ export namespace AppStreamCompose {
          * @param cpt The {@link AppStream.Component} to add.
          * @param bytes Source data used to generate the GCID hash, or `null` if nonexistent.
          * @returns `true` on success.
+         * @throws GLib.Error
          */
         add_component(cpt: AppStream.Component, bytes: GLib.Bytes | Uint8Array): boolean;
 
@@ -1152,6 +1158,7 @@ export namespace AppStreamCompose {
          * @param cpt The {@link AppStream.Component} to add.
          * @param data Source data used to generate the GCID hash, or `null` if nonexistent.
          * @returns `true` on success.
+         * @throws GLib.Error
          */
         add_component_with_string(cpt: AppStream.Component, data: string): boolean;
 
@@ -1467,12 +1474,14 @@ export namespace AppStreamCompose {
 
         /**
          * Open this unit, populating its content listing.
+         * @throws GLib.Error
          */
         open(): boolean;
 
         /**
          * Read the contents of the selected file into memory and return them.
          * @param filename The file to read data for.
+         * @throws GLib.Error
          */
         read_data(filename: string): GLib.Bytes;
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@girs/appstreamcompose-1.0",
-    "version": "4.4.0",
+    "version": "4.5.0",
     "description": "GJS TypeScript type definitions for AppStreamCompose-1.0",
     "type": "module",
     "module": "appstreamcompose-1.0.js",
@@ -31,12 +31,12 @@
       "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/appstream-1.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",
+      "@girs/appstream-1.0": "^4.5.0"    },
     "devDependencies": {
       "typescript": "*"
     },