@girs/appstreamcompose-1.0 4.2.0 → 4.3.0

package/README.md

@@ -5,25 +5,25 @@
 ![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.2.0.
+GJS TypeScript type definitions for AppStreamCompose-1.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.3.0.
 
 ## Install
 
-To use this type definitions, install them with NPM:
+Install the type definitions with npm:
 ```bash
 npm install @girs/appstreamcompose-1.0
 ```
 
 ## Usage
 
-You can import this package into your project like this:
+Import it like any other module:
 ```ts
 import AppStreamCompose from '@girs/appstreamcompose-1.0';
 ```
 
 ### Ambient Modules
 
-You can also use [ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules) to import this module like you would do this in JavaScript.
+[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:
 
 `index.ts`:
@@ -42,7 +42,7 @@ import '@girs/appstreamcompose-1.0'
 }
 ```
 
-Now you can import the ambient module with TypeScript support: 
+The ambient module now resolves with types:
 
 ```ts
 import AppStreamCompose from 'gi://AppStreamCompose?version=1.0';
@@ -50,7 +50,7 @@ import AppStreamCompose from 'gi://AppStreamCompose?version=1.0';
 
 ### Global import
 
-You can also import the module with Typescript support using the global `imports.gi` object of GJS.
+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:
 
 `index.ts`:
@@ -69,7 +69,7 @@ import '@girs/appstreamcompose-1.0'
 }
 ```
 
-Now you have also type support for this, too:
+That form carries types as well:
 
 ```ts
 const AppStreamCompose = imports.gi.AppStreamCompose;
@@ -77,7 +77,7 @@ const AppStreamCompose = imports.gi.AppStreamCompose;
 
 ### Bundle
 
-Depending on your project configuration, it is recommended to use a bundler like [esbuild](https://esbuild.github.io/). You can find examples using different bundlers [here](https://github.com/gjsify/ts-for-gir/tree/main/examples).
+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.
 
 ## Other packages
 

package/appstreamcompose-1.0.d.ts

@@ -159,14 +159,15 @@ export namespace AppStreamCompose {
 
     /**
      * Builds a global component ID from a component-id
-     * and a (usually MD5) checksum generated from the component data.
+     * and a checksum (usually Blake3) generated from the component data.
      * 
      * The global-id is used as a global, unique identifier for a component.
      * (while the component-ID is local, e.g. for one source).
      * Its primary usecase is to identify a media directory on the filesystem which is
      * associated with this component.
      * @param component_id an AppStream component ID.
-     * @param checksum a MD5 hashsum as string generated from the component's combined metadata.
+     * @param checksum a checksum as string generated from the component's combined metadata.
+     * @returns The new global ID. Free with %g_free.
      */
     function build_component_global_id(component_id: string, checksum: string): string;
 
@@ -175,6 +176,18 @@ export namespace AppStreamCompose {
      */
     function compose_error_quark(): GLib.Quark;
 
+    /**
+     * Compute a checksum for the given content.
+     * 
+     * The output of this function is intended to be used with %asc_build_component_global_id
+     * to form a unique global ID. The generated checksum is intended to be used as content-ID.
+     * Do not assume it is cryptographically secure or has a certain length!
+     * @param data The data to hash.
+     * @param length Length of `data`.
+     * @returns The hash as hexadecimal string. Free with %g_free
+     */
+    function compute_content_checksum_for_data(data: string, length: bigint | number): string;
+
     /**
      * Generate a filename from a web-URL that can be used to store the
      * file on disk after download.
@@ -683,6 +696,9 @@ export namespace AppStreamCompose {
          * This may be useful in case a special language pack layout is used,
          * but is generally not necessary to be set explicitly, as locale
          * will be found in the unit where the metadata is by default.
+         * 
+         * Do not forget to open the locale unit, before running compose
+         * actions with it!
          * @param locale_unit the unit used for locale processing.
          */
         set_locale_unit(locale_unit: Unit): void;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@girs/appstreamcompose-1.0",
-    "version": "4.2.0",
+    "version": "4.3.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.2.0",
-      "@girs/gio-2.0": "^4.2.0",
-      "@girs/gobject-2.0": "^4.2.0",
-      "@girs/glib-2.0": "^4.2.0",
-      "@girs/gmodule-2.0": "^4.2.0",
-      "@girs/appstream-1.0": "^4.2.0"    },
+      "@girs/gjs": "^4.3.0",
+      "@girs/gio-2.0": "^4.3.0",
+      "@girs/gobject-2.0": "^4.3.0",
+      "@girs/glib-2.0": "^4.3.0",
+      "@girs/gmodule-2.0": "^4.3.0",
+      "@girs/appstream-1.0": "^4.3.0"    },
     "devDependencies": {
       "typescript": "*"
     },