@girs/passim-1.0 0.1.5-4.0.0

package/README.md

@@ -0,0 +1,104 @@
+
+# Passim-1.0
+
+![version](https://img.shields.io/npm/v/@girs/passim-1.0)
+![downloads/week](https://img.shields.io/npm/dw/@girs/passim-1.0)
+
+
+GJS TypeScript type definitions for Passim-1.0, generated from library version 0.1.5 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0.
+
+
+## Install
+
+To use this type definitions, install them with NPM:
+```bash
+npm install @girs/passim-1.0
+```
+
+## Usage
+
+You can import this package into your project like this:
+```ts
+import Passim from '@girs/passim-1.0';
+```
+
+Or if you prefer CommonJS, you can also use this:
+```ts
+const Passim = require('@girs/passim-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.
+For this you need to include `@girs/passim-1.0` or `@girs/passim-1.0/ambient` in your `tsconfig` or entry point Typescript file:
+
+`index.ts`:
+```ts
+import '@girs/passim-1.0'
+```
+
+`tsconfig.json`:
+```json
+{
+  "compilerOptions": {
+    ...
+  },
+  "include": ["@girs/passim-1.0"],
+  ...
+}
+```
+
+Now you can import the ambient module with TypeScript support: 
+
+```ts
+import Passim from 'gi://Passim?version=1.0';
+```
+
+### Global import
+
+You can also import the module with Typescript support using the global `imports.gi` object of GJS.
+For this you need to include `@girs/passim-1.0` or `@girs/passim-1.0/import` in your `tsconfig` or entry point Typescript file:
+
+`index.ts`:
+```ts
+import '@girs/passim-1.0'
+```
+
+`tsconfig.json`:
+```json
+{
+  "compilerOptions": {
+    ...
+  },
+  "include": ["@girs/passim-1.0"],
+  ...
+}
+```
+
+Now you have also type support for this, too:
+
+```ts
+const Passim = imports.gi.Passim;
+```
+
+
+### ESM vs. CommonJS
+
+GJS supports two different import syntaxes. The new modern ESM syntax and the old global imports syntax.
+
+In TypeScript projects for GJS and GNOME Shell extensions, you have the flexibility to use `ESM` syntax and then decide the import syntax for your bundled file. If your bundler is configured to use `CommonJS`, it will convert to the GJS-specific global imports syntax, like `const moduleName = imports.gi[moduleName]`. This is different from the traditional `require` syntax seen in Node.js. The global imports syntax is chosen because it aligns with the CommonJS format supported by NPM, which is used for the generated type definitions and this package.
+
+On the other hand, if you configure your bundler to use ESM, it will retain the ESM import syntax. It's crucial to ensure that your bundler is set up to correctly translate and bundle these imports into either CommonJS or ESM format, depending on your project's requirements.
+
+This approach is particularly important due to the `@girs` types, which include both `*.cjs `files, using the GJS global imports syntax, and `*.js` files, which utilize the ESM syntax. By appropriately setting up your bundler, you can control which syntax—CommonJS or ESM—is used in your project. The choice of CommonJS in this context is also due to the similarity between the GJS-specific global imports and CommonJS syntax, allowing for easier management and bundling in these specific types of projects.
+
+Since GNOME Shell 45, you should only use ESM, even for GNOME Shell extensions. Before that, extensions had to use the global import syntax, unlike normal GJS applications, where ESM has been available for some time.
+
+### 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).
+
+## Other packages
+
+All existing pre-generated packages can be found on [gjsify/types](https://github.com/gjsify/types).
+

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@girs/passim-1.0",
+  "version": "0.1.5-4.0.0",
+  "description": "GJS TypeScript type definitions for Passim-1.0, generated from library version 0.1.5",
+  "type": "module",
+  "module": "passim-1.0.js",
+  "main": "passim-1.0.js",
+  "exports": {
+    "./ambient": {
+      "types": "./passim-1.0-ambient.d.ts",
+      "import": "./passim-1.0-ambient.js",
+      "default": "./passim-1.0-ambient.js"
+    },
+    "./import": {
+      "types": "./passim-1.0-import.d.ts",
+      "import": "./passim-1.0-import.js",
+      "default": "./passim-1.0-import.js"
+    },
+    ".": {
+      "types": "./passim-1.0.d.ts",
+      "import": "./passim-1.0.js",
+      "default": "./passim-1.0.js"
+    }
+  },
+  "scripts": {
+    "test": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit passim-1.0.d.ts"
+  },
+  "dependencies": {
+    "@girs/gio-2.0": "^2.77.0-4.0.0-beta.1",
+    "@girs/gjs": "^4.0.0-beta.1",
+    "@girs/glib-2.0": "^2.77.0-4.0.0-beta.1",
+    "@girs/gobject-2.0": "^2.77.0-4.0.0-beta.1"
+  },
+  "devDependencies": {
+    "typescript": "*"
+  },
+  "keywords": [
+    "Gir",
+    "TypeScript",
+    "types",
+    "GObject-Introspection",
+    "GJS",
+    "Passim-1.0"
+  ],
+  "author": "ts-for-gir",
+  "license": "MIT",
+  "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/types/tree/main/passim-1.0#readme"
+}

package/passim-1.0-ambient.d.ts

@@ -0,0 +1,12 @@
+
+declare module 'gi://Passim?version=1.0' {
+    import Passim from '@girs/passim-1.0';
+    export default Passim;
+}
+
+declare module 'gi://Passim' {
+    import Passim10 from 'gi://Passim?version=1.0';
+    export default Passim10;
+}
+
+

package/passim-1.0-ambient.js

@@ -0,0 +1,2 @@
+export {}
+

package/passim-1.0-import.d.ts

@@ -0,0 +1,12 @@
+
+import Passim10 from '@girs/passim-1.0';
+
+declare global {
+    export interface GjsGiImports {
+        Passim: typeof Passim10;
+    }
+}
+
+export default GjsGiImports;
+
+

package/passim-1.0-import.js

@@ -0,0 +1,3 @@
+const gi = globalThis.imports?.gi || {};
+export default gi;
+

package/passim-1.0.d.ts

@@ -0,0 +1,342 @@
+/*
+ * 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-gir
+ */
+
+import './passim-1.0-ambient.d.ts';
+
+/**
+ * Passim-1.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 Passim {
+    enum Status {
+        UNKNOWN,
+        STARTING,
+        LOADING,
+        RUNNING,
+        DISABLED_METERED,
+    }
+    const DBUS_INTERFACE: string;
+    const DBUS_PATH: string;
+    const DBUS_SERVICE: string;
+    /**
+     * The item is not active for some reason.
+     */
+    const ITEM_FLAG_DISABLED: number;
+    /**
+     * Only register the item when the machine has been rebooted.
+     */
+    const ITEM_FLAG_NEXT_REBOOT: number;
+    /**
+     * No item flags are set.
+     */
+    const ITEM_FLAG_NONE: number;
+    /**
+     * The compile-time major version
+     */
+    const MAJOR_VERSION: number;
+    /**
+     * The compile-time micro version
+     */
+    const MICRO_VERSION: number;
+    /**
+     * The compile-time minor version
+     */
+    const MINOR_VERSION: number;
+    /**
+     * Gets the libpassim installed runtime version.
+     *
+     * This may be different to the *build-time* version if the daemon and library
+     * objects somehow get out of sync.
+     * @returns version string
+     */
+    function version_string(): string;
+    module Client {
+        // Constructor properties interface
+
+        interface ConstructorProps extends GObject.Object.ConstructorProps {}
+    }
+
+    /**
+     * A shared client.
+     */
+    class Client extends GObject.Object {
+        static $gtype: GObject.GType<Client>;
+
+        // Constructors of Passim.Client
+
+        constructor(properties?: Partial<Client.ConstructorProps>, ...args: any[]);
+
+        _init(...args: any[]): void;
+
+        static ['new'](): Client;
+
+        // Own methods of Passim.Client
+
+        /**
+         * Get items currently published by the daemon.
+         * @returns items, or %NULL for error
+         */
+        get_items(): Item[];
+        /**
+         * Gets the daemon status.
+         * @returns the #PassimStatus
+         */
+        get_status(): Status;
+        /**
+         * Gets the daemon version.
+         * @returns the version string, or %NULL if unset
+         */
+        get_version(): string;
+        /**
+         * Loads the client from a file on disk.
+         * @returns %TRUE for success
+         */
+        load(): boolean;
+        /**
+         * Connects to the remote server.
+         * @param item a #PassimItem
+         * @returns %TRUE for success
+         */
+        publish(item: Item): boolean;
+        /**
+         * Unpublish a file from the index.
+         * @param hash an item hash value
+         * @returns %TRUE for success
+         */
+        unpublish(hash: string): boolean;
+    }
+
+    module Item {
+        // Constructor properties interface
+
+        interface ConstructorProps extends GObject.Object.ConstructorProps {}
+    }
+
+    /**
+     * A shared item.
+     */
+    class Item extends GObject.Object {
+        static $gtype: GObject.GType<Item>;
+
+        // Constructors of Passim.Item
+
+        constructor(properties?: Partial<Item.ConstructorProps>, ...args: any[]);
+
+        _init(...args: any[]): void;
+
+        static ['new'](): Item;
+
+        // Own static methods of Passim.Item
+
+        /**
+         * Converts a string to an enumerated item flag.
+         * @param item_flag a string, e.g. `next-reboot`
+         */
+        static flag_from_string(item_flag?: string | null): ItemFlags;
+        /**
+         * Converts an enumerated item flag to a string.
+         * @param item_flag item flags, e.g. %PASSIM_ITEM_FLAG_NEXT_REBOOT
+         */
+        static flag_to_string(item_flag: ItemFlags): string;
+        /**
+         * Creates a new item using serialized data.
+         * @param value the serialized data
+         */
+        static from_variant(value: GLib.Variant): Item;
+
+        // Own methods of Passim.Item
+
+        /**
+         * Adds a specific item flag to the item.
+         * @param flag the #PassimItemFlags
+         */
+        add_flag(flag: ItemFlags): void;
+        /**
+         * Gets the current file age.
+         * @returns time in seconds, or 0 for invalid.
+         */
+        get_age(): number;
+        /**
+         * Gets the basename of the file that was published.
+         * @returns the test basename, or %NULL if unset
+         */
+        get_basename(): string;
+        /**
+         * Gets the local bytes in the cache.
+         * @returns a #GBytes, or %NULL if unset
+         */
+        get_bytes(): GLib.Bytes;
+        /**
+         * Gets the cmdline of the binary that published the item.
+         * @returns the binary name, or %NULL if unset
+         */
+        get_cmdline(): string;
+        /**
+         * Gets the creation time of the file.
+         * @returns the creation time, or %NULL if unset
+         */
+        get_ctime(): GLib.DateTime;
+        /**
+         * Gets the local file in the cache.
+         * @returns a #GFile, or %NULL if unset
+         */
+        get_file(): Gio.File;
+        /**
+         * Gets the item flags.
+         * @returns item flags, or 0 if unset
+         */
+        get_flags(): number;
+        /**
+         * Gets the item flags.
+         * @returns string
+         */
+        get_flags_as_string(): string;
+        /**
+         * Gets the file hash.
+         * @returns the typically in SHA-256 lowercase form, or %NULL if unset
+         */
+        get_hash(): string;
+        /**
+         * Gets the maximum permitted file age.
+         * @returns time in seconds
+         */
+        get_max_age(): number;
+        /**
+         * Gets the current number of times the item has been shared to other machines.
+         * @returns the count, or 0 if unset
+         */
+        get_share_count(): number;
+        /**
+         * Gets the maximum number of times that the file can be shared.
+         * @returns share limit, or 0 if unset
+         */
+        get_share_limit(): number;
+        /**
+         * Gets the size of the file in bytes.
+         * @returns share limit, or 0 if unset
+         */
+        get_size(): number;
+        /**
+         * Gets the input stream for the item.
+         * @returns a #GInputStream, or %NULL if unset
+         */
+        get_stream(): Gio.InputStream;
+        /**
+         * Finds if the item has a specific item flag.
+         * @param flag a item flag
+         * @returns %TRUE if the flag is set
+         */
+        has_flag(flag: ItemFlags): boolean;
+        /**
+         * Loads the item from a file on disk.
+         * @param filename a filename with full path
+         */
+        load_filename(filename: string): boolean;
+        /**
+         * Removes a specific item flag from the item.
+         * @param flag a item flag
+         */
+        remove_flag(flag: ItemFlags): void;
+        /**
+         * Sets the basename of the file that was published.
+         * @param basename the basename name
+         */
+        set_basename(basename?: string | null): void;
+        /**
+         * Sets the local bytes in the cache.
+         * @param bytes a #GBytes
+         */
+        set_bytes(bytes?: GLib.Bytes | null): void;
+        /**
+         * Sets the cmdline of the binary that published the item.
+         *
+         * NOTE: this is desgined as a hint, and should not be used for security. The command line is
+         * obtained via /proc/<pid>/cmdline and it may be possible to falsify the data by a malicious
+         * binary running as root under certain conditions.
+         * @param cmdline the binary name
+         */
+        set_cmdline(cmdline?: string | null): void;
+        /**
+         * Sets the creation time of the file.
+         * @param ctime a #GDateTime
+         */
+        set_ctime(ctime?: GLib.DateTime | null): void;
+        /**
+         * Sets the local file in the cache.
+         * @param file a #GFile
+         */
+        set_file(file?: Gio.File | null): void;
+        /**
+         * Sets the item flags.
+         * @param flags item flags, e.g. %PASSIM_ITEM_FLAG_NEXT_REBOOT
+         */
+        set_flags(flags: number): void;
+        /**
+         * Sets the file hash.
+         * @param hash the hash, typically in SHA-256 lowercase form
+         */
+        set_hash(hash?: string | null): void;
+        /**
+         * Sets the maximum permitted file age.
+         * @param max_age time in seconds
+         */
+        set_max_age(max_age: number): void;
+        /**
+         * Sets the current number of times the item has been shared to other machines.
+         * @param share_count the count, or 0 to unset
+         */
+        set_share_count(share_count: number): void;
+        /**
+         * Sets the maximum number of times that the file can be shared.
+         * @param share_limit the share limit, or 0
+         */
+        set_share_limit(share_limit: number): void;
+        /**
+         * Sets the size of the file in bytes.
+         * @param size the share limit, or 0
+         */
+        set_size(size: number): void;
+        /**
+         * Sets the input stream stream for the item.
+         *
+         * NOTE: This *MUST* be a #GUnixInputStream, or subclass thereof.
+         * @param stream a #GInputStream
+         */
+        set_stream(stream?: Gio.InputStream | null): void;
+        /**
+         * Builds a text representation of the object.
+         * @returns text, or %NULL for invalid
+         */
+        to_string(): string;
+        /**
+         * Serialize the item data.
+         * @returns the serialized data, or %NULL for error
+         */
+        to_variant(): GLib.Variant;
+    }
+
+    type ClientClass = typeof Client;
+    type ItemClass = typeof Item;
+    type ItemFlags = number;
+    /**
+     * 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 Passim;
+// END

package/passim-1.0.js

@@ -0,0 +1,6 @@
+
+  // @ts-expect-error
+  import Passim from 'gi://Passim?version=1.0';
+  export { Passim };
+  export default Passim;
+

package/tsconfig.json

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

package/typedoc.json

@@ -0,0 +1,7 @@
+{
+    "entryPoints": ["./passim-1.0.d.ts"],
+    "readme": "./README.md",
+    "name": "Passim-1.0",
+    "tsconfig": "./tsconfig.json"
+}
+