@girs/grlnet-0.3 0.3.0-3.0.0-beta.12

package/README.md

@@ -0,0 +1,33 @@
+
+# GrlNet-0.3
+
+GJS TypeScript type definitions for GrlNet-0.3, generated from library version 0.3.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gjs) v3.0.0-beta.12.
+
+Network classes for Grilo
+
+## Install
+
+To use this type definitions, install them with NPM like this:
+```bash
+npm install @girs/grlnet-0.3
+```
+
+## Usage
+
+You can import this package into your project like this:
+```ts
+import GrlNet from '@girs/grlnet-0.3';
+```
+
+Or if you prefer CommonJS, you can also use this:
+```ts
+const GrlNet = require('@girs/grlnet-0.3');
+```
+
+If you use [ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules), you can also import this module like you would do this in JavaScript:
+
+```ts
+import GrlNet from 'gi://GrlNet?version=0.3';
+```
+
+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).

package/grlnet-0.3.cjs

@@ -0,0 +1,9 @@
+
+
+  imports.gi.versions.GrlNet = '0.3'
+  const GrlNet = imports.gi.GrlNet;
+  
+    module.exports = GrlNet;
+  
+
+

package/grlnet-0.3.d.cts

@@ -0,0 +1,248 @@
+
+/*
+ * Type Definitions for Gjs (https://gjs.guide/)
+ *
+ * These type definitions are automatically generated, do not edit them by hand.
+ * If you found a bug fix it in `ts-for-gir` or create a bug report on https://github.com/gjsify/ts-for-gjs
+ */
+/**
+ * GrlNet-0.3
+ */
+
+import type Soup from '@girs/soup-3.0';
+import type Gio from '@girs/gio-2.0';
+import type GObject from '@girs/gobject-2.0';
+import type GLib from '@girs/glib-2.0';
+
+/**
+ * These constants identify all the available errors managed by
+ * the web client.
+ */
+export enum WcError {
+    /**
+     * Deprecated. For generic errors, you
+     * should check for G_IO_ERROR_FAILED from G_IO_ERROR domain.
+     */
+    UNAVAILABLE,
+    /**
+     * Invalid URI or header
+     */
+    PROTOCOL_ERROR,
+    /**
+     * Required authentication
+     */
+    AUTHENTICATION_REQUIRED,
+    /**
+     * Request resource not found
+     */
+    NOT_FOUND,
+    /**
+     * The entry has been modified since is was
+     * downloaded
+     */
+    CONFLICT,
+    /**
+     * TBD
+     */
+    FORBIDDEN,
+    /**
+     * Cannot connect to the server
+     */
+    NETWORK_ERROR,
+    /**
+     * Deprecated. You should check for
+     * G_IO_ERROR_PROXY_FAILED from G_IO_ERROR domain.
+     */
+    PROXY_ERROR,
+    /**
+     * Deprecated. You should check for
+     * G_IO_ERROR_CANCELLED from G_IO_ERROR domain.
+     */
+    CANCELLED,
+}
+export module Wc {
+
+    // Constructor properties interface
+
+    export interface ConstructorProperties extends GObject.Object.ConstructorProperties {
+
+        // Own constructor properties of GrlNet-0.3.GrlNet.Wc
+
+        cache?: boolean | null
+        cache_size?: number | null
+        loglevel?: number | null
+        throttling?: number | null
+        user_agent?: string | null
+    }
+
+}
+
+export interface Wc {
+
+    // Own properties of GrlNet-0.3.GrlNet.Wc
+
+    cache: boolean
+    cache_size: number
+    loglevel: number
+    throttling: number
+    user_agent: string | null
+
+    // Owm methods of GrlNet-0.3.GrlNet.Wc
+
+    /**
+     * This method will flush all the pending request in the queue.
+     */
+    flush_delayed_requests(): void
+    /**
+     * Request the fetching of a web resource given the `uri`. This request is
+     * asynchronous, thus the result will be returned within the `callback`.
+     * @param uri The URI of the resource to request
+     * @param cancellable a #GCancellable instance or %NULL to ignore
+     * @param callback The callback when the result is ready
+     */
+    request_async(uri: string | null, cancellable: Gio.Cancellable | null, callback: Gio.AsyncReadyCallback<this> | null): void
+    /**
+     * Finishes an asynchronous load of the file's contents.
+     * The contents are placed in contents, and length is set to the size of the
+     * contents string.
+     * 
+     * The content address will be invalidated at the next request. So if you
+     * want to keep it, please copy it into another address.
+     * @param result The result of the request
+     * @returns %TRUE if the request was successfull. If %FALSE an error occurred.
+     */
+    request_finish(result: Gio.AsyncResult): [ /* returnType */ boolean, /* content */ Uint8Array ]
+    /**
+     * Request the fetching of a web resource given the `uri`. This request is
+     * asynchronous, thus the result will be returned within the `callback`.
+     * @param uri The URI of the resource to request
+     * @param headers a set of additional HTTP headers for this request or %NULL to ignore
+     * @param cancellable a #GCancellable instance or %NULL to ignore
+     * @param callback The callback when the result is ready
+     */
+    request_with_headers_async(uri: string | null, headers: GLib.HashTable | null, cancellable: Gio.Cancellable | null, callback: Gio.AsyncReadyCallback<this> | null): void
+    /**
+     * Sets if cache must be used. Note that this will only work if caching is
+     * supporting.  If sets %TRUE, a new cache will be created. If sets to %FALSE,
+     * current cache is clean and removed.
+     * @param use_cache if cache must be used or not
+     */
+    set_cache(use_cache: boolean): void
+    /**
+     * Sets the new maximum size of cache, in Megabytes. Default value is 10. Using
+     * 0 means no cache will be done.
+     * @param cache_size size of cache (in Mb)
+     */
+    set_cache_size(cache_size: number): void
+    /**
+     * Setting the log level the logger feature is added into
+     * the libsoup session.
+     * @param log_level the libsoup log level to set [0,3]
+     */
+    set_log_level(log_level: number): void
+    /**
+     * Setting this property, the #GrlNetWc will queue all the requests and
+     * will dispatch them with a pause between them of this value.
+     * 
+     * Note that if the grl-net library was compiled against libsoup3, changing
+     * the throttling configuration will show a warning if done after the first
+     * request.
+     * @param throttling the number of seconds to wait between requests
+     */
+    set_throttling(throttling: number): void
+
+    // Class property signals of GrlNet-0.3.GrlNet.Wc
+
+    connect(sigName: "notify::cache", callback: (($obj: Wc, pspec: GObject.ParamSpec) => void)): number
+    connect_after(sigName: "notify::cache", callback: (($obj: Wc, pspec: GObject.ParamSpec) => void)): number
+    emit(sigName: "notify::cache", ...args: any[]): void
+    connect(sigName: "notify::cache-size", callback: (($obj: Wc, pspec: GObject.ParamSpec) => void)): number
+    connect_after(sigName: "notify::cache-size", callback: (($obj: Wc, pspec: GObject.ParamSpec) => void)): number
+    emit(sigName: "notify::cache-size", ...args: any[]): void
+    connect(sigName: "notify::loglevel", callback: (($obj: Wc, pspec: GObject.ParamSpec) => void)): number
+    connect_after(sigName: "notify::loglevel", callback: (($obj: Wc, pspec: GObject.ParamSpec) => void)): number
+    emit(sigName: "notify::loglevel", ...args: any[]): void
+    connect(sigName: "notify::throttling", callback: (($obj: Wc, pspec: GObject.ParamSpec) => void)): number
+    connect_after(sigName: "notify::throttling", callback: (($obj: Wc, pspec: GObject.ParamSpec) => void)): number
+    emit(sigName: "notify::throttling", ...args: any[]): void
+    connect(sigName: "notify::user-agent", callback: (($obj: Wc, pspec: GObject.ParamSpec) => void)): number
+    connect_after(sigName: "notify::user-agent", callback: (($obj: Wc, pspec: GObject.ParamSpec) => void)): number
+    emit(sigName: "notify::user-agent", ...args: any[]): void
+    connect(sigName: string, callback: (...args: any[]) => void): number
+    connect_after(sigName: string, callback: (...args: any[]) => void): number
+    emit(sigName: string, ...args: any[]): void
+    disconnect(id: number): void
+}
+
+export class Wc extends GObject.Object {
+
+    // Own properties of GrlNet-0.3.GrlNet.Wc
+
+    static name: string
+    static $gtype: GObject.GType<Wc>
+
+    // Constructors of GrlNet-0.3.GrlNet.Wc
+
+    constructor(config?: Wc.ConstructorProperties) 
+    /**
+     * Creates a new #GrlNetWc.
+     * @constructor 
+     * @returns a new allocated instance of #GrlNetWc. Do g_object_unref() after use it.
+     */
+    constructor() 
+    /**
+     * Creates a new #GrlNetWc.
+     * @constructor 
+     * @returns a new allocated instance of #GrlNetWc. Do g_object_unref() after use it.
+     */
+    static new(): Wc
+    _init(config?: Wc.ConstructorProperties): void
+    static error_quark(): GLib.Quark
+}
+
+export interface WcClass {
+
+    // Own fields of GrlNet-0.3.GrlNet.WcClass
+
+    /**
+     * the parent class structure
+     * @field 
+     */
+    parent_class: GObject.ObjectClass
+}
+
+/**
+ * Grilo web client helper class.
+ * 
+ * It's a simple and thin web client to be used by the sources to download
+ * content from Internet.
+ * @record 
+ */
+export abstract class WcClass {
+
+    // Own properties of GrlNet-0.3.GrlNet.WcClass
+
+    static name: string
+}
+
+export interface WcPrivate {
+}
+
+export class WcPrivate {
+
+    // Own properties of GrlNet-0.3.GrlNet.WcPrivate
+
+    static name: string
+}
+
+/**
+ * Name of the imported GIR library
+ * @see https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L188
+ */
+export const __name__: string
+/**
+ * Version of the imported GIR library
+ * @see https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L189
+ */
+export const __version__: string
+// END

package/grlnet-0.3.d.ts

@@ -0,0 +1,253 @@
+
+/*
+ * Type Definitions for Gjs (https://gjs.guide/)
+ *
+ * These type definitions are automatically generated, do not edit them by hand.
+ * If you found a bug fix it in `ts-for-gir` or create a bug report on https://github.com/gjsify/ts-for-gjs
+ */
+/**
+ * GrlNet-0.3
+ */
+
+import type Soup from '@girs/soup-3.0';
+import type Gio from '@girs/gio-2.0';
+import type GObject from '@girs/gobject-2.0';
+import type GLib from '@girs/glib-2.0';
+
+export namespace GrlNet {
+
+/**
+ * These constants identify all the available errors managed by
+ * the web client.
+ */
+enum WcError {
+    /**
+     * Deprecated. For generic errors, you
+     * should check for G_IO_ERROR_FAILED from G_IO_ERROR domain.
+     */
+    UNAVAILABLE,
+    /**
+     * Invalid URI or header
+     */
+    PROTOCOL_ERROR,
+    /**
+     * Required authentication
+     */
+    AUTHENTICATION_REQUIRED,
+    /**
+     * Request resource not found
+     */
+    NOT_FOUND,
+    /**
+     * The entry has been modified since is was
+     * downloaded
+     */
+    CONFLICT,
+    /**
+     * TBD
+     */
+    FORBIDDEN,
+    /**
+     * Cannot connect to the server
+     */
+    NETWORK_ERROR,
+    /**
+     * Deprecated. You should check for
+     * G_IO_ERROR_PROXY_FAILED from G_IO_ERROR domain.
+     */
+    PROXY_ERROR,
+    /**
+     * Deprecated. You should check for
+     * G_IO_ERROR_CANCELLED from G_IO_ERROR domain.
+     */
+    CANCELLED,
+}
+module Wc {
+
+    // Constructor properties interface
+
+    interface ConstructorProperties extends GObject.Object.ConstructorProperties {
+
+        // Own constructor properties of GrlNet-0.3.GrlNet.Wc
+
+        cache?: boolean | null
+        cache_size?: number | null
+        loglevel?: number | null
+        throttling?: number | null
+        user_agent?: string | null
+    }
+
+}
+
+interface Wc {
+
+    // Own properties of GrlNet-0.3.GrlNet.Wc
+
+    cache: boolean
+    cache_size: number
+    loglevel: number
+    throttling: number
+    user_agent: string | null
+
+    // Owm methods of GrlNet-0.3.GrlNet.Wc
+
+    /**
+     * This method will flush all the pending request in the queue.
+     */
+    flush_delayed_requests(): void
+    /**
+     * Request the fetching of a web resource given the `uri`. This request is
+     * asynchronous, thus the result will be returned within the `callback`.
+     * @param uri The URI of the resource to request
+     * @param cancellable a #GCancellable instance or %NULL to ignore
+     * @param callback The callback when the result is ready
+     */
+    request_async(uri: string | null, cancellable: Gio.Cancellable | null, callback: Gio.AsyncReadyCallback<this> | null): void
+    /**
+     * Finishes an asynchronous load of the file's contents.
+     * The contents are placed in contents, and length is set to the size of the
+     * contents string.
+     * 
+     * The content address will be invalidated at the next request. So if you
+     * want to keep it, please copy it into another address.
+     * @param result The result of the request
+     * @returns %TRUE if the request was successfull. If %FALSE an error occurred.
+     */
+    request_finish(result: Gio.AsyncResult): [ /* returnType */ boolean, /* content */ Uint8Array ]
+    /**
+     * Request the fetching of a web resource given the `uri`. This request is
+     * asynchronous, thus the result will be returned within the `callback`.
+     * @param uri The URI of the resource to request
+     * @param headers a set of additional HTTP headers for this request or %NULL to ignore
+     * @param cancellable a #GCancellable instance or %NULL to ignore
+     * @param callback The callback when the result is ready
+     */
+    request_with_headers_async(uri: string | null, headers: GLib.HashTable | null, cancellable: Gio.Cancellable | null, callback: Gio.AsyncReadyCallback<this> | null): void
+    /**
+     * Sets if cache must be used. Note that this will only work if caching is
+     * supporting.  If sets %TRUE, a new cache will be created. If sets to %FALSE,
+     * current cache is clean and removed.
+     * @param use_cache if cache must be used or not
+     */
+    set_cache(use_cache: boolean): void
+    /**
+     * Sets the new maximum size of cache, in Megabytes. Default value is 10. Using
+     * 0 means no cache will be done.
+     * @param cache_size size of cache (in Mb)
+     */
+    set_cache_size(cache_size: number): void
+    /**
+     * Setting the log level the logger feature is added into
+     * the libsoup session.
+     * @param log_level the libsoup log level to set [0,3]
+     */
+    set_log_level(log_level: number): void
+    /**
+     * Setting this property, the #GrlNetWc will queue all the requests and
+     * will dispatch them with a pause between them of this value.
+     * 
+     * Note that if the grl-net library was compiled against libsoup3, changing
+     * the throttling configuration will show a warning if done after the first
+     * request.
+     * @param throttling the number of seconds to wait between requests
+     */
+    set_throttling(throttling: number): void
+
+    // Class property signals of GrlNet-0.3.GrlNet.Wc
+
+    connect(sigName: "notify::cache", callback: (($obj: Wc, pspec: GObject.ParamSpec) => void)): number
+    connect_after(sigName: "notify::cache", callback: (($obj: Wc, pspec: GObject.ParamSpec) => void)): number
+    emit(sigName: "notify::cache", ...args: any[]): void
+    connect(sigName: "notify::cache-size", callback: (($obj: Wc, pspec: GObject.ParamSpec) => void)): number
+    connect_after(sigName: "notify::cache-size", callback: (($obj: Wc, pspec: GObject.ParamSpec) => void)): number
+    emit(sigName: "notify::cache-size", ...args: any[]): void
+    connect(sigName: "notify::loglevel", callback: (($obj: Wc, pspec: GObject.ParamSpec) => void)): number
+    connect_after(sigName: "notify::loglevel", callback: (($obj: Wc, pspec: GObject.ParamSpec) => void)): number
+    emit(sigName: "notify::loglevel", ...args: any[]): void
+    connect(sigName: "notify::throttling", callback: (($obj: Wc, pspec: GObject.ParamSpec) => void)): number
+    connect_after(sigName: "notify::throttling", callback: (($obj: Wc, pspec: GObject.ParamSpec) => void)): number
+    emit(sigName: "notify::throttling", ...args: any[]): void
+    connect(sigName: "notify::user-agent", callback: (($obj: Wc, pspec: GObject.ParamSpec) => void)): number
+    connect_after(sigName: "notify::user-agent", callback: (($obj: Wc, pspec: GObject.ParamSpec) => void)): number
+    emit(sigName: "notify::user-agent", ...args: any[]): void
+    connect(sigName: string, callback: (...args: any[]) => void): number
+    connect_after(sigName: string, callback: (...args: any[]) => void): number
+    emit(sigName: string, ...args: any[]): void
+    disconnect(id: number): void
+}
+
+class Wc extends GObject.Object {
+
+    // Own properties of GrlNet-0.3.GrlNet.Wc
+
+    static name: string
+    static $gtype: GObject.GType<Wc>
+
+    // Constructors of GrlNet-0.3.GrlNet.Wc
+
+    constructor(config?: Wc.ConstructorProperties) 
+    /**
+     * Creates a new #GrlNetWc.
+     * @constructor 
+     * @returns a new allocated instance of #GrlNetWc. Do g_object_unref() after use it.
+     */
+    constructor() 
+    /**
+     * Creates a new #GrlNetWc.
+     * @constructor 
+     * @returns a new allocated instance of #GrlNetWc. Do g_object_unref() after use it.
+     */
+    static new(): Wc
+    _init(config?: Wc.ConstructorProperties): void
+    static error_quark(): GLib.Quark
+}
+
+interface WcClass {
+
+    // Own fields of GrlNet-0.3.GrlNet.WcClass
+
+    /**
+     * the parent class structure
+     * @field 
+     */
+    parent_class: GObject.ObjectClass
+}
+
+/**
+ * Grilo web client helper class.
+ * 
+ * It's a simple and thin web client to be used by the sources to download
+ * content from Internet.
+ * @record 
+ */
+abstract class WcClass {
+
+    // Own properties of GrlNet-0.3.GrlNet.WcClass
+
+    static name: string
+}
+
+interface WcPrivate {
+}
+
+class WcPrivate {
+
+    // Own properties of GrlNet-0.3.GrlNet.WcPrivate
+
+    static name: string
+}
+
+/**
+ * Name of the imported GIR library
+ * @see https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L188
+ */
+const __name__: string
+/**
+ * Version of the imported GIR library
+ * @see https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L189
+ */
+const __version__: string
+}
+
+export default GrlNet;
+// END

package/grlnet-0.3.js

@@ -0,0 +1,8 @@
+
+
+  // @ts-expect-error
+  import GrlNet from 'gi://GrlNet?version=0.3';
+  export { GrlNet };
+  export default GrlNet;
+
+

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@girs/grlnet-0.3",
+  "version": "0.3.0-3.0.0-beta.12",
+  "description": "GJS TypeScript type definitions for GrlNet-0.3, generated from library version 0.3.0",
+  "type": "module",
+  "module": "grlnet-0.3.js",
+  "main": "grlnet-0.3.js",
+  "typedoc": {
+    "entryPoint": "./grlnet-0.3.d.ts",
+    "readmeFile": "./README.md",
+    "displayName": "GrlNet-0.3",
+    "tsconfig": "./tsconfig.doc.json"
+  },
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./grlnet-0.3.d.ts",
+        "default": "./grlnet-0.3.js"
+      },
+      "require": {
+        "types": "./grlnet-0.3.d.cts",
+        "default": "./grlnet-0.3.cjs"
+      }
+    }
+  },
+  "scripts": {
+    "test": "yarn test:esm && yarn test:cjs",
+    "test:esm": "tsc --noEmit grlnet-0.3.d.ts",
+    "test:cjs": "tsc --noEmit grlnet-0.3.d.cts"
+  },
+  "dependencies": {
+    "@girs/gio-2.0": "^2.75.1-3.0.0-beta.12",
+    "@girs/glib-2.0": "^2.75.1-3.0.0-beta.12",
+    "@girs/gobject-2.0": "^2.75.1-3.0.0-beta.12",
+    "@girs/soup-3.0": "^3.3.1-3.0.0-beta.12"
+  },
+  "devDependencies": {
+    "typescript": "^*"
+  },
+  "keywords": [
+    "Gir",
+    "TypeScript",
+    "GrlNet-0.3"
+  ],
+  "author": "ts-for-gir",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/gjsify/ts-for-gir.git"
+  },
+  "bugs": {
+    "url": "https://github.com/gjsify/ts-for-gir/issues"
+  },
+  "homepage": "https://github.com/gjsify/ts-for-gir#readme"
+}

package/tsconfig.doc.json

@@ -0,0 +1,19 @@
+{
+  "compilerOptions": {
+    // General settings for code interpretation
+    "target": "ESNext",
+    "module": "ESNext",
+    "experimentalDecorators": true,
+    "moduleResolution": "node",
+    "noEmit": true,
+    "noEmitOnError": false,
+    "baseUrl": "./",
+    "rootDir": ".",
+    // General settings for code generation
+    "removeComments": false,
+    "inlineSourceMap": false,
+    "inlineSources": false,
+    "newLine": "LF"
+  },
+  "include": ["./grlnet-0.3.d.ts"]
+}