@girs/parquet-1.0 1.0.0-4.0.0-beta.16

package/README.md

@@ -0,0 +1,86 @@
+
+# Parquet-1.0
+
+![version](https://img.shields.io/npm/v/@girs/parquet-1.0)
+![downloads/week](https://img.shields.io/npm/dw/@girs/parquet-1.0)
+
+
+GJS TypeScript type definitions for Parquet-1.0, generated from library version 1.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.16.
+
+
+## Install
+
+To use this type definitions, install them with NPM:
+```bash
+npm install @girs/parquet-1.0
+```
+
+## Usage
+
+You can import this package into your project like this:
+```ts
+import Parquet from '@girs/parquet-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/parquet-1.0` or `@girs/parquet-1.0/ambient` in your `tsconfig` or entry point Typescript file:
+
+`index.ts`:
+```ts
+import '@girs/parquet-1.0'
+```
+
+`tsconfig.json`:
+```json
+{
+  "compilerOptions": {
+    ...
+  },
+  "include": ["@girs/parquet-1.0"],
+  ...
+}
+```
+
+Now you can import the ambient module with TypeScript support: 
+
+```ts
+import Parquet from 'gi://Parquet?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/parquet-1.0` or `@girs/parquet-1.0/import` in your `tsconfig` or entry point Typescript file:
+
+`index.ts`:
+```ts
+import '@girs/parquet-1.0'
+```
+
+`tsconfig.json`:
+```json
+{
+  "compilerOptions": {
+    ...
+  },
+  "include": ["@girs/parquet-1.0"],
+  ...
+}
+```
+
+Now you have also type support for this, too:
+
+```ts
+const Parquet = imports.gi.Parquet;
+```
+
+### 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/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 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
+ *
+ * This template is used to generate the index.d.ts file of each GIR module like Gtk-4.0, GObject-2.0, ...
+ */
+
+import './parquet-1.0-ambient.d.ts';
+
+import './parquet-1.0-import.d.ts';
+
+import Parquet from './parquet-1.0.js';
+export default Parquet;

package/index.js

@@ -0,0 +1,5 @@
+
+// @ts-expect-error
+import Parquet from './parquet-1.0.js';
+export default Parquet;
+

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@girs/parquet-1.0",
+  "version": "1.0.0-4.0.0-beta.16",
+  "description": "GJS TypeScript type definitions for Parquet-1.0, generated from library version 1.0.0",
+  "type": "module",
+  "module": "parquet-1.0.js",
+  "main": "parquet-1.0.js",
+  "exports": {
+    "./ambient": {
+      "types": "./parquet-1.0-ambient.d.ts",
+      "import": "./parquet-1.0-ambient.js",
+      "default": "./parquet-1.0-ambient.js"
+    },
+    "./import": {
+      "types": "./parquet-1.0-import.d.ts",
+      "import": "./parquet-1.0-import.js",
+      "default": "./parquet-1.0-import.js"
+    },
+    "./parquet-1.0": {
+      "types": "./parquet-1.0.d.ts",
+      "import": "./parquet-1.0.js",
+      "default": "./parquet-1.0.js"
+    },
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js",
+      "default": "./index.js"
+    }
+  },
+  "scripts": {
+    "test": "tsc --project tsconfig.json"
+  },
+  "dependencies": {
+    "@girs/arrow-1.0": "^16.1.0-4.0.0-beta.16",
+    "@girs/gio-2.0": "^2.82.0-4.0.0-beta.16",
+    "@girs/gjs": "^4.0.0-beta.16",
+    "@girs/glib-2.0": "^2.82.0-4.0.0-beta.16",
+    "@girs/gmodule-2.0": "^2.0.0-4.0.0-beta.16",
+    "@girs/gobject-2.0": "^2.82.0-4.0.0-beta.16"
+  },
+  "devDependencies": {
+    "typescript": "*"
+  },
+  "keywords": [
+    "Gir",
+    "TypeScript",
+    "types",
+    "GObject-Introspection",
+    "GJS",
+    "Parquet-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/parquet-1.0#readme"
+}

package/parquet-1.0-ambient.d.ts

@@ -0,0 +1,9 @@
+declare module 'gi://Parquet?version=1.0' {
+    import Parquet10 from '@girs/parquet-1.0';
+    export default Parquet10;
+}
+
+declare module 'gi://Parquet' {
+    import Parquet10 from 'gi://Parquet?version=1.0';
+    export default Parquet10;
+}

package/parquet-1.0-ambient.js

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

package/parquet-1.0-import.d.ts

@@ -0,0 +1,9 @@
+import Parquet10 from '@girs/parquet-1.0';
+
+declare global {
+    export interface GjsGiImports {
+        Parquet: typeof Parquet10;
+    }
+}
+
+export default GjsGiImports;

package/parquet-1.0-import.js

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

package/parquet-1.0.d.ts

@@ -0,0 +1,445 @@
+/**
+ * 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
+ *
+ * The based EJS template file is used for the generated .d.ts file of each GIR module like Gtk-4.0, GObject-2.0, ...
+ */
+
+// Module dependencies
+import type Arrow from '@girs/arrow-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';
+import type GModule from '@girs/gmodule-2.0';
+
+export namespace Parquet {
+    /**
+     * Parquet-1.0
+     */
+
+    module ArrowFileReader {
+        // Constructor properties interface
+
+        interface ConstructorProps extends GObject.Object.ConstructorProps {
+            arrow_file_reader: any;
+            arrowFileReader: any;
+        }
+    }
+
+    class ArrowFileReader extends GObject.Object {
+        static $gtype: GObject.GType<ArrowFileReader>;
+
+        // Properties
+
+        set arrow_file_reader(val: any);
+        set arrowFileReader(val: any);
+
+        // Constructors
+
+        constructor(properties?: Partial<ArrowFileReader.ConstructorProps>, ...args: any[]);
+
+        _init(...args: any[]): void;
+
+        static new_arrow(source: Arrow.SeekableInputStream): ArrowFileReader;
+
+        static new_path(path: string): ArrowFileReader;
+
+        // Methods
+
+        get_metadata(): FileMetadata;
+        get_n_row_groups(): number;
+        get_n_rows(): number;
+        get_schema(): Arrow.Schema | null;
+        read_column_data(i: number): Arrow.ChunkedArray | null;
+        read_row_group(row_group_index: number, column_indices?: number[] | null): Arrow.Table | null;
+        read_table(): Arrow.Table | null;
+        set_use_threads(use_threads: boolean): void;
+    }
+
+    module ArrowFileWriter {
+        // Constructor properties interface
+
+        interface ConstructorProps extends GObject.Object.ConstructorProps {
+            arrow_file_writer: any;
+            arrowFileWriter: any;
+        }
+    }
+
+    class ArrowFileWriter extends GObject.Object {
+        static $gtype: GObject.GType<ArrowFileWriter>;
+
+        // Properties
+
+        set arrow_file_writer(val: any);
+        set arrowFileWriter(val: any);
+
+        // Constructors
+
+        constructor(properties?: Partial<ArrowFileWriter.ConstructorProps>, ...args: any[]);
+
+        _init(...args: any[]): void;
+
+        static new_arrow(
+            schema: Arrow.Schema,
+            sink: Arrow.OutputStream,
+            writer_properties?: WriterProperties | null,
+        ): ArrowFileWriter;
+
+        static new_path(
+            schema: Arrow.Schema,
+            path: string,
+            writer_properties?: WriterProperties | null,
+        ): ArrowFileWriter;
+
+        // Methods
+
+        close(): boolean;
+        write_table(table: Arrow.Table, chunk_size: number): boolean;
+    }
+
+    module BooleanStatistics {
+        // Constructor properties interface
+
+        interface ConstructorProps extends Statistics.ConstructorProps {}
+    }
+
+    class BooleanStatistics extends Statistics {
+        static $gtype: GObject.GType<BooleanStatistics>;
+
+        // Constructors
+
+        constructor(properties?: Partial<BooleanStatistics.ConstructorProps>, ...args: any[]);
+
+        _init(...args: any[]): void;
+
+        // Methods
+
+        get_max(): boolean;
+        get_min(): boolean;
+    }
+
+    module ByteArrayStatistics {
+        // Constructor properties interface
+
+        interface ConstructorProps extends Statistics.ConstructorProps {}
+    }
+
+    class ByteArrayStatistics extends Statistics {
+        static $gtype: GObject.GType<ByteArrayStatistics>;
+
+        // Constructors
+
+        constructor(properties?: Partial<ByteArrayStatistics.ConstructorProps>, ...args: any[]);
+
+        _init(...args: any[]): void;
+
+        // Methods
+
+        get_max(): GLib.Bytes;
+        get_min(): GLib.Bytes;
+    }
+
+    module ColumnChunkMetadata {
+        // Constructor properties interface
+
+        interface ConstructorProps extends GObject.Object.ConstructorProps {
+            metadata: any;
+            owner: RowGroupMetadata;
+        }
+    }
+
+    class ColumnChunkMetadata extends GObject.Object {
+        static $gtype: GObject.GType<ColumnChunkMetadata>;
+
+        // Properties
+
+        set metadata(val: any);
+        set owner(val: RowGroupMetadata);
+
+        // Constructors
+
+        constructor(properties?: Partial<ColumnChunkMetadata.ConstructorProps>, ...args: any[]);
+
+        _init(...args: any[]): void;
+
+        // Methods
+
+        can_decompress(): boolean;
+        equal(other_metadata: ColumnChunkMetadata): boolean;
+        get_file_offset(): number;
+        get_statistics(): Statistics | null;
+        get_total_compressed_size(): number;
+        get_total_size(): number;
+    }
+
+    module DoubleStatistics {
+        // Constructor properties interface
+
+        interface ConstructorProps extends Statistics.ConstructorProps {}
+    }
+
+    class DoubleStatistics extends Statistics {
+        static $gtype: GObject.GType<DoubleStatistics>;
+
+        // Constructors
+
+        constructor(properties?: Partial<DoubleStatistics.ConstructorProps>, ...args: any[]);
+
+        _init(...args: any[]): void;
+
+        // Methods
+
+        get_max(): number;
+        get_min(): number;
+    }
+
+    module FileMetadata {
+        // Constructor properties interface
+
+        interface ConstructorProps extends GObject.Object.ConstructorProps {
+            metadata: any;
+        }
+    }
+
+    class FileMetadata extends GObject.Object {
+        static $gtype: GObject.GType<FileMetadata>;
+
+        // Properties
+
+        set metadata(val: any);
+
+        // Constructors
+
+        constructor(properties?: Partial<FileMetadata.ConstructorProps>, ...args: any[]);
+
+        _init(...args: any[]): void;
+
+        // Methods
+
+        can_decompress(): boolean;
+        equal(other_metadata: FileMetadata): boolean;
+        get_created_by(): string;
+        get_n_columns(): number;
+        get_n_row_groups(): number;
+        get_n_rows(): number;
+        get_n_schema_elements(): number;
+        get_row_group(index: number): RowGroupMetadata | null;
+        get_size(): number;
+    }
+
+    module FixedLengthByteArrayStatistics {
+        // Constructor properties interface
+
+        interface ConstructorProps extends Statistics.ConstructorProps {}
+    }
+
+    class FixedLengthByteArrayStatistics extends Statistics {
+        static $gtype: GObject.GType<FixedLengthByteArrayStatistics>;
+
+        // Constructors
+
+        constructor(properties?: Partial<FixedLengthByteArrayStatistics.ConstructorProps>, ...args: any[]);
+
+        _init(...args: any[]): void;
+
+        // Methods
+
+        get_max(): GLib.Bytes;
+        get_min(): GLib.Bytes;
+    }
+
+    module FloatStatistics {
+        // Constructor properties interface
+
+        interface ConstructorProps extends Statistics.ConstructorProps {}
+    }
+
+    class FloatStatistics extends Statistics {
+        static $gtype: GObject.GType<FloatStatistics>;
+
+        // Constructors
+
+        constructor(properties?: Partial<FloatStatistics.ConstructorProps>, ...args: any[]);
+
+        _init(...args: any[]): void;
+
+        // Methods
+
+        get_max(): number;
+        get_min(): number;
+    }
+
+    module Int32Statistics {
+        // Constructor properties interface
+
+        interface ConstructorProps extends Statistics.ConstructorProps {}
+    }
+
+    class Int32Statistics extends Statistics {
+        static $gtype: GObject.GType<Int32Statistics>;
+
+        // Constructors
+
+        constructor(properties?: Partial<Int32Statistics.ConstructorProps>, ...args: any[]);
+
+        _init(...args: any[]): void;
+
+        // Methods
+
+        get_max(): number;
+        get_min(): number;
+    }
+
+    module Int64Statistics {
+        // Constructor properties interface
+
+        interface ConstructorProps extends Statistics.ConstructorProps {}
+    }
+
+    class Int64Statistics extends Statistics {
+        static $gtype: GObject.GType<Int64Statistics>;
+
+        // Constructors
+
+        constructor(properties?: Partial<Int64Statistics.ConstructorProps>, ...args: any[]);
+
+        _init(...args: any[]): void;
+
+        // Methods
+
+        get_max(): number;
+        get_min(): number;
+    }
+
+    module RowGroupMetadata {
+        // Constructor properties interface
+
+        interface ConstructorProps extends GObject.Object.ConstructorProps {
+            metadata: any;
+            owner: FileMetadata;
+        }
+    }
+
+    class RowGroupMetadata extends GObject.Object {
+        static $gtype: GObject.GType<RowGroupMetadata>;
+
+        // Properties
+
+        set metadata(val: any);
+        set owner(val: FileMetadata);
+
+        // Constructors
+
+        constructor(properties?: Partial<RowGroupMetadata.ConstructorProps>, ...args: any[]);
+
+        _init(...args: any[]): void;
+
+        // Methods
+
+        can_decompress(): boolean;
+        equal(other_metadata: RowGroupMetadata): boolean;
+        get_column_chunk(index: number): ColumnChunkMetadata | null;
+        get_file_offset(): number;
+        get_n_columns(): number;
+        get_n_rows(): number;
+        get_total_compressed_size(): number;
+        get_total_size(): number;
+    }
+
+    module Statistics {
+        // Constructor properties interface
+
+        interface ConstructorProps extends GObject.Object.ConstructorProps {
+            statistics: any;
+        }
+    }
+
+    abstract class Statistics extends GObject.Object {
+        static $gtype: GObject.GType<Statistics>;
+
+        // Properties
+
+        set statistics(val: any);
+
+        // Constructors
+
+        constructor(properties?: Partial<Statistics.ConstructorProps>, ...args: any[]);
+
+        _init(...args: any[]): void;
+
+        // Methods
+
+        equal(other_statistics: Statistics): boolean;
+        get_n_distinct_values(): number;
+        get_n_nulls(): number;
+        get_n_values(): number;
+        has_min_max(): boolean;
+        has_n_distinct_values(): boolean;
+        has_n_nulls(): boolean;
+    }
+
+    module WriterProperties {
+        // Constructor properties interface
+
+        interface ConstructorProps extends GObject.Object.ConstructorProps {}
+    }
+
+    class WriterProperties extends GObject.Object {
+        static $gtype: GObject.GType<WriterProperties>;
+
+        // Constructors
+
+        constructor(properties?: Partial<WriterProperties.ConstructorProps>, ...args: any[]);
+
+        _init(...args: any[]): void;
+
+        static ['new'](): WriterProperties;
+
+        // Methods
+
+        disable_dictionary(path?: string | null): void;
+        enable_dictionary(path?: string | null): void;
+        get_batch_size(): number;
+        get_compression_path(path: string): Arrow.CompressionType;
+        get_data_page_size(): number;
+        get_dictionary_page_size_limit(): number;
+        get_max_row_group_length(): number;
+        is_dictionary_enabled(path: string): boolean;
+        set_batch_size(batch_size: number): void;
+        set_compression(compression_type: Arrow.CompressionType, path?: string | null): void;
+        set_data_page_size(data_page_size: number): void;
+        set_dictionary_page_size_limit(limit: number): void;
+        set_max_row_group_length(length: number): void;
+    }
+
+    type ArrowFileReaderClass = typeof ArrowFileReader;
+    type ArrowFileWriterClass = typeof ArrowFileWriter;
+    type BooleanStatisticsClass = typeof BooleanStatistics;
+    type ByteArrayStatisticsClass = typeof ByteArrayStatistics;
+    type ColumnChunkMetadataClass = typeof ColumnChunkMetadata;
+    type DoubleStatisticsClass = typeof DoubleStatistics;
+    type FileMetadataClass = typeof FileMetadata;
+    type FixedLengthByteArrayStatisticsClass = typeof FixedLengthByteArrayStatistics;
+    type FloatStatisticsClass = typeof FloatStatistics;
+    type Int32StatisticsClass = typeof Int32Statistics;
+    type Int64StatisticsClass = typeof Int64Statistics;
+    type RowGroupMetadataClass = typeof RowGroupMetadata;
+    type StatisticsClass = typeof Statistics;
+    type WriterPropertiesClass = typeof WriterProperties;
+    /**
+     * 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 Parquet;
+
+// END

package/parquet-1.0.js

@@ -0,0 +1,5 @@
+
+// @ts-expect-error
+import Parquet from 'gi://Parquet?version=1.0';
+export default Parquet;
+

package/tsconfig.json

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

package/typedoc.json

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