@near-mobile/connector 0.0.1-alpha-1

package/README.md

@@ -0,0 +1,109 @@
+# @near-mobile/connector
+
+Public client library for the **Near Mobile Connector**: create requests, poll for responses, build deep-link URLs, and generate QR codes for wallet connections.
+
+## Installation
+
+```bash
+npm install @near-mobile/connector
+yarn add @near-mobile/connector
+pnpm install @near-mobile/connector
+bun add @near-mobile/connector
+```
+
+## Overview
+
+This package lets you:
+
+- **Create and poll requests** against the Near Mobile Connector API
+- **Build URLs** for opening the Near Mobile Wallet (mobile deep-link or universal link)
+- **Generate QR codes** that encode the request URL for wallet scanning (optional strategy)
+
+## Usage
+
+### Creating and polling a request
+
+```ts
+import { NearMobileConnector } from "@near-mobile/connector";
+
+// Create a new connector request (payload depends on your API)
+const request = await NearMobileConnector.createRequest({
+    // ... your request body
+});
+
+const id = request.id;
+
+// Poll until the user completes the action in the wallet
+const completedRequest = await NearMobileConnector.pollResponse(id);
+
+// Use completedRequest.status and response data
+```
+
+### Building request URLs
+
+Use these URLs to open the wallet (e.g. in a “Open in app” button or redirect):
+
+```ts
+import { buildNearMobileAppRequestUrl, buildNearMobileUniversalRequestUrl } from "@near-mobile/connector";
+
+const requestId = "your-request-id";
+
+// Mobile deep-link (near-mobile-wallet://request?id=...)
+const mobileUrl = buildNearMobileAppRequestUrl(requestId);
+
+// Universal URL (works on web and can redirect to app when installed)
+const universalUrl = buildNearMobileUniversalRequestUrl(requestId);
+```
+
+### QR code strategy
+
+Generate a QR code that encodes the mobile request URL so users can scan it with the wallet app:
+
+```ts
+import { NearMobileQrCode } from "@near-mobile/connector/strategies/qr-code";
+
+const qr = new NearMobileQrCode({
+    requestId: "your-request-id",
+    // ... other qr-code-styling options (except data, image, imageOptions)
+});
+
+// Append SVG to DOM
+const container = document.getElementById("qr-container");
+qr.append(container);
+
+// Or get as blob for download
+const blob = await qr.download({ name: "qr", extension: "png" });
+```
+
+`NearMobileQrCode` extends [qr-code-styling](https://github.com/kozakdenys/qr-code-styling); you can pass any of its options (except `data`, `image`, and `imageOptions`, which are set from the package config).
+
+## API
+
+| Export                                           | Description                                     |
+| ------------------------------------------------ | ----------------------------------------------- |
+| `NearMobileConnector.createRequest(body)`        | Create a new connector request.                 |
+| `NearMobileConnector.getRequest(id)`             | Fetch a request by ID.                          |
+| `NearMobileConnector.pollResponse(id, options?)` | Poll a request until it is no longer `pending`. |
+| `buildNearMobileAppRequestUrl(id)`               | Build the mobile deep-link URL for a request.   |
+| `buildNearMobileUniversalRequestUrl(id)`         | Build the universal request URL.                |
+
+### QR Code Strategy
+
+| Export                                                                | Description                                        |
+| --------------------------------------------------------------------- | -------------------------------------------------- |
+| `NearMobileQrCode` (from `@near-mobile/connector/strategies/qr-code`) | QR code class that encodes the mobile request URL. |
+
+## Publishing
+
+From the repo root (or this package directory):
+
+```bash
+pnpm run build
+pnpm publish --no-git-checks
+```
+
+The package is configured to run `pnpm run build` automatically on `prepublishOnly`. Scoped packages require `publishConfig.access: "public"` (already set) to be published to the public npm registry.
+
+## License
+
+MIT © Peersyst

package/dist/README.md

@@ -0,0 +1,109 @@
+# @near-mobile/connector
+
+Public client library for the **Near Mobile Connector**: create requests, poll for responses, build deep-link URLs, and generate QR codes for wallet connections.
+
+## Installation
+
+```bash
+npm install @near-mobile/connector
+yarn add @near-mobile/connector
+pnpm install @near-mobile/connector
+bun add @near-mobile/connector
+```
+
+## Overview
+
+This package lets you:
+
+- **Create and poll requests** against the Near Mobile Connector API
+- **Build URLs** for opening the Near Mobile Wallet (mobile deep-link or universal link)
+- **Generate QR codes** that encode the request URL for wallet scanning (optional strategy)
+
+## Usage
+
+### Creating and polling a request
+
+```ts
+import { NearMobileConnector } from "@near-mobile/connector";
+
+// Create a new connector request (payload depends on your API)
+const request = await NearMobileConnector.createRequest({
+    // ... your request body
+});
+
+const id = request.id;
+
+// Poll until the user completes the action in the wallet
+const completedRequest = await NearMobileConnector.pollResponse(id);
+
+// Use completedRequest.status and response data
+```
+
+### Building request URLs
+
+Use these URLs to open the wallet (e.g. in a “Open in app” button or redirect):
+
+```ts
+import { buildNearMobileAppRequestUrl, buildNearMobileUniversalRequestUrl } from "@near-mobile/connector";
+
+const requestId = "your-request-id";
+
+// Mobile deep-link (near-mobile-wallet://request?id=...)
+const mobileUrl = buildNearMobileAppRequestUrl(requestId);
+
+// Universal URL (works on web and can redirect to app when installed)
+const universalUrl = buildNearMobileUniversalRequestUrl(requestId);
+```
+
+### QR code strategy
+
+Generate a QR code that encodes the mobile request URL so users can scan it with the wallet app:
+
+```ts
+import { NearMobileQrCode } from "@near-mobile/connector/strategies/qr-code";
+
+const qr = new NearMobileQrCode({
+    requestId: "your-request-id",
+    // ... other qr-code-styling options (except data, image, imageOptions)
+});
+
+// Append SVG to DOM
+const container = document.getElementById("qr-container");
+qr.append(container);
+
+// Or get as blob for download
+const blob = await qr.download({ name: "qr", extension: "png" });
+```
+
+`NearMobileQrCode` extends [qr-code-styling](https://github.com/kozakdenys/qr-code-styling); you can pass any of its options (except `data`, `image`, and `imageOptions`, which are set from the package config).
+
+## API
+
+| Export                                           | Description                                     |
+| ------------------------------------------------ | ----------------------------------------------- |
+| `NearMobileConnector.createRequest(body)`        | Create a new connector request.                 |
+| `NearMobileConnector.getRequest(id)`             | Fetch a request by ID.                          |
+| `NearMobileConnector.pollResponse(id, options?)` | Poll a request until it is no longer `pending`. |
+| `buildNearMobileAppRequestUrl(id)`               | Build the mobile deep-link URL for a request.   |
+| `buildNearMobileUniversalRequestUrl(id)`         | Build the universal request URL.                |
+
+### QR Code Strategy
+
+| Export                                                                | Description                                        |
+| --------------------------------------------------------------------- | -------------------------------------------------- |
+| `NearMobileQrCode` (from `@near-mobile/connector/strategies/qr-code`) | QR code class that encodes the mobile request URL. |
+
+## Publishing
+
+From the repo root (or this package directory):
+
+```bash
+pnpm run build
+pnpm publish --no-git-checks
+```
+
+The package is configured to run `pnpm run build` automatically on `prepublishOnly`. Scoped packages require `publishConfig.access: "public"` (already set) to be published to the public npm registry.
+
+## License
+
+MIT © Peersyst

package/dist/chunk-D2RKH6IN.mjs

@@ -0,0 +1,31 @@
+var __defProp = Object.defineProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+
+// src/config.ts
+var nearMobileConnectorConfig = {
+  apiUrl: "https://near-mobile-connector.aws.peersyst.tech",
+  mobileRequestUrl: "near-mobile-wallet://request?id={id}",
+  universalRequestUrl: "https://near-mobile-production.aws.peersyst.tech/api/deep-link/request?id={id}",
+  responsePolling: {
+    delay: 3e3,
+    maxIterations: 1e3
+  }
+};
+
+// src/utils.ts
+function buildNearMobileAppRequestUrl(id) {
+  return nearMobileConnectorConfig.mobileRequestUrl.replace("{id}", id);
+}
+function buildNearMobileUniversalRequestUrl(id) {
+  return nearMobileConnectorConfig.universalRequestUrl.replace("{id}", id);
+}
+
+export {
+  __export,
+  nearMobileConnectorConfig,
+  buildNearMobileAppRequestUrl,
+  buildNearMobileUniversalRequestUrl
+};

package/dist/chunk-LJHKWETI.js

@@ -0,0 +1,31 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var __defProp = Object.defineProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+
+// src/config.ts
+var nearMobileConnectorConfig = {
+  apiUrl: "https://near-mobile-connector.aws.peersyst.tech",
+  mobileRequestUrl: "near-mobile-wallet://request?id={id}",
+  universalRequestUrl: "https://near-mobile-production.aws.peersyst.tech/api/deep-link/request?id={id}",
+  responsePolling: {
+    delay: 3e3,
+    maxIterations: 1e3
+  }
+};
+
+// src/utils.ts
+function buildNearMobileAppRequestUrl(id) {
+  return nearMobileConnectorConfig.mobileRequestUrl.replace("{id}", id);
+}
+function buildNearMobileUniversalRequestUrl(id) {
+  return nearMobileConnectorConfig.universalRequestUrl.replace("{id}", id);
+}
+
+
+
+
+
+
+exports.__export = __export; exports.nearMobileConnectorConfig = nearMobileConnectorConfig; exports.buildNearMobileAppRequestUrl = buildNearMobileAppRequestUrl; exports.buildNearMobileUniversalRequestUrl = buildNearMobileUniversalRequestUrl;

package/dist/config.d.ts

@@ -0,0 +1,8 @@
+import { PollingOptions } from "@shared/utils";
+export type NearMobileConnectorConfig = {
+    apiUrl: string;
+    mobileRequestUrl: string;
+    universalRequestUrl: string;
+    responsePolling: PollingOptions;
+};
+export declare const nearMobileConnectorConfig: NearMobileConnectorConfig;

package/dist/connector.d.ts

@@ -0,0 +1,5 @@
+import { ConnectorRequestDto, RequestApi } from "@shared/connector";
+import { PollingOptions } from "@shared/utils/polling";
+export declare const createRequest: typeof RequestApi.createRequest;
+export declare const getRequest: typeof RequestApi.getRequest;
+export declare function pollResponse(id: string, options?: PollingOptions): Promise<ConnectorRequestDto>;

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * as NearMobileConnector from "./connector";
+export * from "./utils";
+export * from "./types";