@d34/gjs-libs 0.1.0-test.1

package/LICENSE.md

@@ -0,0 +1,26 @@
+The MIT License (MIT)
+=====================
+
+Copyright © `2026` `Deadarius`
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the “Software”), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+

package/README.md

@@ -0,0 +1,194 @@
+# @d34/gjs-libs
+
+Type-safe GObject Introspection for various GTK libraries for TypeScript projects.
+
+## What is this?
+
+This package encapsulates `gi://` protocol imports for GNOME libraries, allowing you to write TypeScript applications that run in the GJS runtime. It re-exports the [@girs](https://github.com/gjsify/types) type definitions while handling the `gi://` imports internally.
+
+**Note:** This package does not include the actual GNOME libraries. They must be installed on the system where the GJS runtime executes your bundled code.
+
+## Intended Use
+
+1. Develop your GJS application using Deno, Bun, or Node with full TypeScript support
+2. Import GNOME libraries from this package with IDE autocompletion and type checking
+3. Bundle your code into a JavaScript file
+4. Execute the bundled output in the GJS runtime
+
+
+## Why not just use `@girs/` packages directly?
+All of the above can be done directly with the @girs packages, hovewer they expect you to use gi:// imports directly in the code, which makes it impossible to produce a reusable JSR package with these imports - this is the problem @d34/gjs-libs is aiming to solve
+
+## Why no JSR package?
+
+JSR (JavaScript Registry) doesn't allow `gi://` protocol imports. This package is distributed via npm to encapsulate those imports, enabling JSR-hosted packages to use GNOME libraries through this dependency.
+
+## Installation
+
+```bash
+# npm
+npm install @d34/gjs-libs
+
+# pnpm
+pnpm add @d34/gjs-libs
+
+# Deno
+deno add npm:@d34/gjs-libs
+```
+
+## Usage
+
+### Importing Libraries
+
+```typescript
+// GTK 4
+import Gtk from "@d34/gjs-libs/gtk-4.0";
+
+// Adwaita
+import Adw from "@d34/gjs-libs/adw-1";
+
+// Core libraries
+import GLib from "@d34/gjs-libs/glib-2.0";
+import GObject from "@d34/gjs-libs/gobject-2.0";
+import Gio from "@d34/gjs-libs/gio-2.0";
+
+// GJS runtime
+import Gjs from "@d34/gjs-libs/gjs";
+```
+
+### Example: Simple GTK 4 Application
+
+```typescript
+import Gtk from "@d34/gjs-libs/gtk-4.0";
+import GLib from "@d34/gjs-libs/glib-2.0";
+
+Gtk.init();
+
+const app = new Gtk.Application({
+  application_id: "com.example.MyApp",
+});
+
+app.connect("activate", () => {
+  const window = new Gtk.ApplicationWindow({ application: app });
+  window.set_title("Hello World");
+  window.set_default_size(400, 300);
+
+  const button = new Gtk.Button({ label: "Click me!" });
+  button.connect("clicked", () => {
+    console.log("Button clicked!");
+  });
+
+  window.set_child(button);
+  window.present();
+});
+
+app.run([]);
+```
+
+### Example: Adwaita Application
+
+```typescript
+import Adw from "@d34/gjs-libs/adw-1";
+import Gtk from "@d34/gjs-libs/gtk-4.0";
+import Gio from "@d34/gjs-libs/gio-2.0";
+
+const app = new Adw.Application({
+  application_id: "com.example.AdwApp",
+});
+
+app.connect("activate", () => {
+  const window = new Adw.ApplicationWindow({ application: app });
+
+  const headerBar = new Adw.HeaderBar();
+  const content = new Gtk.Box({
+    orientation: Gtk.Orientation.VERTICAL,
+    spacing: 12,
+  });
+
+  const toolbar = new Adw.ToolbarView();
+  toolbar.add_top_bar(headerBar);
+  toolbar.set_content(content);
+
+  window.set_content(toolbar);
+  window.present();
+});
+
+app.run([]);
+```
+
+## How It Works
+
+Each module re-exports from both the `gi://` protocol (runtime) and `@girs/*` npm packages (types):
+
+```typescript
+// @ts-types="@girs/gtk-4.0"
+import Gtk from "gi://Gtk?version=4.0";
+export default Gtk;
+export * from "@girs/gtk-4.0";
+```
+
+- **Types** come from the `@girs/*` npm packages via the `@ts-types` directive
+- **Runtime imports** use the `gi://` protocol which GJS resolves to native GNOME libraries
+
+## Bundling and executing
+
+Bundle your TypeScript code for GJS execution using your preferred bundler:
+
+```bash
+# esbuild
+esbuild src/main.ts --bundle --outfile=dist/app.js --format=esm --external:'gi://*'
+
+# Execute bundle in gjs
+gjs dist/app.js
+```
+
+Make sure to mark `gi://*` as external so the bundler preserves these imports for GJS.
+
+
+## Available Libraries
+
+This package includes 665 GNOME/GLib ecosystem libraries. Some commonly used ones:
+
+### Core
+- `glib-2.0` - GLib core utilities
+- `gobject-2.0` - GObject base class system
+- `gio-2.0` - GIO I/O library
+- `gjs` - GJS runtime types
+
+### GUI
+- `gtk-4.0` - GTK 4 toolkit
+- `gtk-3.0` - GTK 3 toolkit (legacy)
+- `adw-1` - Libadwaita (GNOME UI patterns)
+- `gdk-4.0` - GDK 4 (windowing)
+- `gsk-4.0` - GSK 4 (rendering)
+
+### Graphics
+- `cairo-1.0` - Cairo 2D graphics
+- `pango-1.0` - Pango text rendering
+- `graphene-1.0` - Graphene math library
+- `gdkpixbuf-2.0` - Image loading
+
+### Multimedia
+- `gst-1.0` - GStreamer core
+- `gstbase-1.0` - GStreamer base classes
+- `gstaudio-1.0` - GStreamer audio
+- `gstvideo-1.0` - GStreamer video
+
+### Desktop Integration
+- `nm-1.0` - NetworkManager
+- `secret-1` - Secret Service (keyring)
+- `notify-0.7` - Desktop notifications
+- `polkit-1.0` - PolicyKit authorization
+
+### Web
+- `webkit-6.0` - WebKitGTK 6
+- `soup-3.0` - HTTP library
+- `json-1.0` - JSON-GLib
+
+## License
+
+MIT
+
+## Credits
+
+Type definitions provided by [ts-for-gir](https://github.com/gjsify/ts-for-gir) / [@girs](https://github.com/gjsify/types).

package/ambient.d.ts

@@ -0,0 +1,29 @@
+// Ambient module declarations for GJS built-in modules
+// These are required because @girs packages use bare module specifiers like 'cairo'
+
+declare module "cairo" {
+  import Cairo from "@girs/gjs/cairo";
+  export default Cairo;
+}
+
+declare module "system" {
+  export * from "@girs/gjs/system";
+  import System from "@girs/gjs/system";
+  export default System;
+}
+
+declare module "gettext" {
+  export * from "@girs/gjs/gettext";
+  import Gettext from "@girs/gjs/gettext";
+  export default Gettext;
+}
+
+declare module "console" {
+  import Console, {
+    setConsoleLogDomain,
+    getConsoleLogDomain,
+    DEFAULT_LOG_DOMAIN,
+  } from "@girs/gjs/console";
+  export { setConsoleLogDomain, getConsoleLogDomain, DEFAULT_LOG_DOMAIN };
+  export default Console;
+}