sparkling-types 2.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/index.d.ts

@@ -0,0 +1,148 @@
+declare module '@lynx-js/types' {
+    /**
+     * Global properties injected by the Sparkling native SDK into every Lynx
+     * container. Access these at runtime via `lynx.__globalProps`.
+     *
+     * The native layer (iOS / Android) populates these values before the Lynx
+     * bundle starts executing. Some fields are **stable** (set once on app
+     * launch) and some are **unstable** (may change per container or over time).
+     *
+     * @see {@link https://tiktok.github.io/sparkling/apis/global-props/GlobalProps | Full documentation}
+     */
+    interface GlobalProps {
+        /** Screen width in logical points (dp on Android, pt on iOS). */
+        screenWidth: number;
+        /** Screen height in logical points (dp on Android, pt on iOS). */
+        screenHeight: number;
+        /** Height of the system status bar in logical points. */
+        statusBarHeight: number;
+        /**
+         * Height of the system navigation bar in logical points.
+         * @platform Android
+         */
+        navigationBarHeight: number;
+        /**
+         * Height of the top safe-area inset in logical points.
+         * Equivalent to `safeAreaInsets.top` on iOS.
+         * @platform iOS
+         */
+        topHeight: number;
+        /**
+         * Height of the bottom safe-area inset in logical points.
+         * Equivalent to `safeAreaInsets.bottom` on iOS.
+         * @platform iOS
+         */
+        bottomHeight: number;
+        /**
+         * Safe-area height. On iOS this equals `safeAreaInsets.top`;
+         * on Android it is derived from screen metrics.
+         */
+        safeAreaHeight: number;
+        /**
+         * Available content height, excluding top and bottom safe areas.
+         * Computed as `screenHeight - topHeight - bottomHeight`.
+         * @platform iOS
+         */
+        contentHeight: number;
+        /**
+         * Device pixel ratio (e.g. `2.0`, `3.0`).
+         * @platform Android
+         */
+        pixelRatio: number;
+        /**
+         * Operating system identifier.
+         * - `"ios"` on iOS
+         * - `"android"` on Android
+         */
+        os: string;
+        /** OS version string (e.g. `"17.4"`, `"14"`). */
+        osVersion: string;
+        /** Device model identifier in lowercase (e.g. `"iphone15,2"`, `"pixel 8"`). */
+        deviceModel: string;
+        /** `1` if the device is a tablet (iPad / Android tablet), `0` otherwise. */
+        isPad: number;
+        /**
+         * `1` if the device is an iPhone X-series (or later with notch / Dynamic Island),
+         * `0` otherwise. Always `0` on Android.
+         * @platform iOS
+         */
+        isIPhoneX: number;
+        /**
+         * `1` if the device is an iPhone X-series (or later with notch / Dynamic Island),
+         * `0` otherwise. Always `0` on Android.
+         * @remarks Identical to {@link isIPhoneX} in current implementations.
+         * @platform iOS
+         */
+        isIPhoneXMax: number;
+        /** `1` if the device is in low-power / battery-saver mode, `0` otherwise. */
+        isLowPowerMode: number;
+        /**
+         * `true` if the app is currently in the background.
+         * @platform iOS
+         */
+        isAppBackground: boolean;
+        /**
+         * Accessibility mode bitmask.
+         * - Bit 0 (`1`): VoiceOver (iOS) or TalkBack (Android) is active.
+         */
+        accessibleMode: number;
+        /** Preferred language code from the OS (e.g. `"en-US"`, `"zh-Hans"`). */
+        language: string;
+        /**
+         * App-level language setting. Not set by the SDK by default;
+         * available for host apps to inject via `setStableProps()`.
+         */
+        appLanguage?: string;
+        /**
+         * App-level locale setting. Not set by the SDK by default;
+         * available for host apps to inject via `setStableProps()`.
+         */
+        appLocale?: string;
+        /**
+         * Current screen orientation as a string.
+         *
+         * Possible values: `"Portrait"`, `"PortraitUpsideDown"`, `"LandscapeLeft"`,
+         * `"LandscapeRight"`, `"Landscape"`, `"Unknown"`.
+         */
+        screenOrientation: string;
+        /**
+         * Numeric orientation indicator.
+         * `0` = portrait, `1` = landscape.
+         * @platform Android
+         */
+        orientation?: number;
+        /**
+         * Current UI theme: `"dark"` or `"light"`.
+         * @platform Android
+         */
+        theme: string;
+        /**
+         * User-preferred theme setting, if different from the current applied theme.
+         * May be `undefined` if no preference has been set.
+         */
+        preferredTheme?: string;
+        /**
+         * Whether the device has a screen notch or cutout.
+         */
+        isNotchScreen: boolean;
+        /** Unique identifier for this Sparkling container instance. */
+        containerID: string;
+        /** Timestamp (as string) when the container was initialized. */
+        containerInitTime: string;
+        /** Version of the underlying Lynx SDK. */
+        lynxSdkVersion: string;
+        /**
+         * Template resource data passed to the container.
+         * Contents depend on the app's template configuration.
+         * @platform Android
+         */
+        templateResData: string;
+        /**
+         * Query parameters parsed from the container's scheme URL.
+         * Each key-value pair corresponds to a query parameter.
+         */
+        queryItems: Record<string, string>;
+    }
+}
+export type { GlobalProps } from '@lynx-js/types';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,QAAQ,gBAAgB,CAAC;IAC9B;;;;;;;;;OASG;IACH,UAAU,WAAW;QAGnB,iEAAiE;QACjE,WAAW,EAAE,MAAM,CAAC;QAEpB,kEAAkE;QAClE,YAAY,EAAE,MAAM,CAAC;QAErB,yDAAyD;QACzD,eAAe,EAAE,MAAM,CAAC;QAExB;;;WAGG;QACH,mBAAmB,EAAE,MAAM,CAAC;QAE5B;;;;WAIG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;;WAIG;QACH,YAAY,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,cAAc,EAAE,MAAM,CAAC;QAEvB;;;;WAIG;QACH,aAAa,EAAE,MAAM,CAAC;QAEtB;;;WAGG;QACH,UAAU,EAAE,MAAM,CAAC;QAInB;;;;WAIG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX,iDAAiD;QACjD,SAAS,EAAE,MAAM,CAAC;QAElB,+EAA+E;QAC/E,WAAW,EAAE,MAAM,CAAC;QAEpB,4EAA4E;QAC5E,KAAK,EAAE,MAAM,CAAC;QAEd;;;;WAIG;QACH,SAAS,EAAE,MAAM,CAAC;QAElB;;;;;WAKG;QACH,YAAY,EAAE,MAAM,CAAC;QAIrB,6EAA6E;QAC7E,cAAc,EAAE,MAAM,CAAC;QAEvB;;;WAGG;QACH,eAAe,EAAE,OAAO,CAAC;QAEzB;;;WAGG;QACH,cAAc,EAAE,MAAM,CAAC;QAIvB,yEAAyE;QACzE,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAInB;;;;;WAKG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B;;;;WAIG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;;WAGG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,aAAa,EAAE,OAAO,CAAC;QAIvB,+DAA+D;QAC/D,WAAW,EAAE,MAAM,CAAC;QAEpB,gEAAgE;QAChE,iBAAiB,EAAE,MAAM,CAAC;QAE1B,0CAA0C;QAC1C,cAAc,EAAE,MAAM,CAAC;QAEvB;;;;WAIG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;;WAGG;QACH,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;KACpC;CACF;AAED,YAAY,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/index.js

@@ -0,0 +1,5 @@
+// Copyright (c) 2025 TikTok Pte. Ltd.
+// Licensed under the Apache License Version 2.0 that can be found in the
+// LICENSE file in the root directory of this source tree.
+export {};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,sCAAsC;AACtC,yEAAyE;AACzE,0DAA0D"}

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "sparkling-types",
+  "version": "2.0.0",
+  "description": "GlobalProps type definitions for Sparkling Lynx apps",
+  "homepage": "https://tiktok.github.io/sparkling/",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/tiktok/sparkling",
+    "directory": "packages/sparkling-types"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "peerDependencies": {
+    "@lynx-js/types": ">=3.0.0"
+  },
+  "devDependencies": {
+    "@lynx-js/types": "3.6.0",
+    "typescript": "^5.8.3"
+  },
+  "license": "Apache-2.0",
+  "scripts": {
+    "build": "tsc"
+  }
+}

package/src/index.ts

@@ -0,0 +1,194 @@
+// Copyright (c) 2025 TikTok Pte. Ltd.
+// Licensed under the Apache License Version 2.0 that can be found in the
+// LICENSE file in the root directory of this source tree.
+
+declare module '@lynx-js/types' {
+  /**
+   * Global properties injected by the Sparkling native SDK into every Lynx
+   * container. Access these at runtime via `lynx.__globalProps`.
+   *
+   * The native layer (iOS / Android) populates these values before the Lynx
+   * bundle starts executing. Some fields are **stable** (set once on app
+   * launch) and some are **unstable** (may change per container or over time).
+   *
+   * @see {@link https://tiktok.github.io/sparkling/apis/global-props/GlobalProps | Full documentation}
+   */
+  interface GlobalProps {
+    // ── Device / Screen ────────────────────────────────────────────────
+
+    /** Screen width in logical points (dp on Android, pt on iOS). */
+    screenWidth: number;
+
+    /** Screen height in logical points (dp on Android, pt on iOS). */
+    screenHeight: number;
+
+    /** Height of the system status bar in logical points. */
+    statusBarHeight: number;
+
+    /**
+     * Height of the system navigation bar in logical points.
+     * @platform Android
+     */
+    navigationBarHeight: number;
+
+    /**
+     * Height of the top safe-area inset in logical points.
+     * Equivalent to `safeAreaInsets.top` on iOS.
+     * @platform iOS
+     */
+    topHeight: number;
+
+    /**
+     * Height of the bottom safe-area inset in logical points.
+     * Equivalent to `safeAreaInsets.bottom` on iOS.
+     * @platform iOS
+     */
+    bottomHeight: number;
+
+    /**
+     * Safe-area height. On iOS this equals `safeAreaInsets.top`;
+     * on Android it is derived from screen metrics.
+     */
+    safeAreaHeight: number;
+
+    /**
+     * Available content height, excluding top and bottom safe areas.
+     * Computed as `screenHeight - topHeight - bottomHeight`.
+     * @platform iOS
+     */
+    contentHeight: number;
+
+    /**
+     * Device pixel ratio (e.g. `2.0`, `3.0`).
+     * @platform Android
+     */
+    pixelRatio: number;
+
+    // ── Device Info ────────────────────────────────────────────────────
+
+    /**
+     * Operating system identifier.
+     * - `"ios"` on iOS
+     * - `"android"` on Android
+     */
+    os: string;
+
+    /** OS version string (e.g. `"17.4"`, `"14"`). */
+    osVersion: string;
+
+    /** Device model identifier in lowercase (e.g. `"iphone15,2"`, `"pixel 8"`). */
+    deviceModel: string;
+
+    /** `1` if the device is a tablet (iPad / Android tablet), `0` otherwise. */
+    isPad: number;
+
+    /**
+     * `1` if the device is an iPhone X-series (or later with notch / Dynamic Island),
+     * `0` otherwise. Always `0` on Android.
+     * @platform iOS
+     */
+    isIPhoneX: number;
+
+    /**
+     * `1` if the device is an iPhone X-series (or later with notch / Dynamic Island),
+     * `0` otherwise. Always `0` on Android.
+     * @remarks Identical to {@link isIPhoneX} in current implementations.
+     * @platform iOS
+     */
+    isIPhoneXMax: number;
+
+    // ── System State ───────────────────────────────────────────────────
+
+    /** `1` if the device is in low-power / battery-saver mode, `0` otherwise. */
+    isLowPowerMode: number;
+
+    /**
+     * `true` if the app is currently in the background.
+     * @platform iOS
+     */
+    isAppBackground: boolean;
+
+    /**
+     * Accessibility mode bitmask.
+     * - Bit 0 (`1`): VoiceOver (iOS) or TalkBack (Android) is active.
+     */
+    accessibleMode: number;
+
+    // ── Localization ───────────────────────────────────────────────────
+
+    /** Preferred language code from the OS (e.g. `"en-US"`, `"zh-Hans"`). */
+    language: string;
+
+    /**
+     * App-level language setting. Not set by the SDK by default;
+     * available for host apps to inject via `setStableProps()`.
+     */
+    appLanguage?: string;
+
+    /**
+     * App-level locale setting. Not set by the SDK by default;
+     * available for host apps to inject via `setStableProps()`.
+     */
+    appLocale?: string;
+
+    // ── UI State ───────────────────────────────────────────────────────
+
+    /**
+     * Current screen orientation as a string.
+     *
+     * Possible values: `"Portrait"`, `"PortraitUpsideDown"`, `"LandscapeLeft"`,
+     * `"LandscapeRight"`, `"Landscape"`, `"Unknown"`.
+     */
+    screenOrientation: string;
+
+    /**
+     * Numeric orientation indicator.
+     * `0` = portrait, `1` = landscape.
+     * @platform Android
+     */
+    orientation?: number;
+
+    /**
+     * Current UI theme: `"dark"` or `"light"`.
+     * @platform Android
+     */
+    theme: string;
+
+    /**
+     * User-preferred theme setting, if different from the current applied theme.
+     * May be `undefined` if no preference has been set.
+     */
+    preferredTheme?: string;
+
+    /**
+     * Whether the device has a screen notch or cutout.
+     */
+    isNotchScreen: boolean;
+
+    // ── Container / Runtime ────────────────────────────────────────────
+
+    /** Unique identifier for this Sparkling container instance. */
+    containerID: string;
+
+    /** Timestamp (as string) when the container was initialized. */
+    containerInitTime: string;
+
+    /** Version of the underlying Lynx SDK. */
+    lynxSdkVersion: string;
+
+    /**
+     * Template resource data passed to the container.
+     * Contents depend on the app's template configuration.
+     * @platform Android
+     */
+    templateResData: string;
+
+    /**
+     * Query parameters parsed from the container's scheme URL.
+     * Each key-value pair corresponds to a query parameter.
+     */
+    queryItems: Record<string, string>;
+  }
+}
+
+export type { GlobalProps } from '@lynx-js/types';

package/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "noEmit": false
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}