@vintr/node-sdk 1.0.0 → 1.1.0

package/README.md

@@ -11,25 +11,31 @@ npm install @vintr/node-sdk
 ## Usage
 
 ```typescript
-import { Vintr } from '@vintr/node-sdk';
+import { Vintr } from "@vintr/node-sdk";
 
-const vintr = new Vintr('vintr_secret_key');
+const vintr = new Vintr("vintr_secret_key");
 
-const location = await vintr.alias.resolve({ alias: 'apple#vintr' });
+const location = await vintr.alias.resolve({
+  alias: "apple#vintr",
+  code: "ABCDEF", // Alias owner-provided 6-letter authorization code
+});
 ```
 
 ## API
 
-### `vintr.alias.resolve({ alias })`
+### `vintr.alias.resolve({ alias, code })`
 
 Resolves an alias to its associated location and metadata.
 
 **Parameters:**
-- `alias` (string): The alias to resolve in full format with suffix (e.g., `apple#vintr`, `asteik#vintr`, `sushi#vintr`)
+
+- `alias` (string, required): The alias to resolve (e.g., `apple#vintr`, `asteik#vintr`, `sushi#vintr`)
+- `code` (string, required): A 6-letter authorization code to resolve the alias
 
 **Returns:** `AliasResponse` with location details, coordinates, and delivery instructions.
 
 **Sample Response:**
+
 ```typescript
 {
   alias: "apple#vintr",
@@ -66,5 +72,11 @@ Resolves an alias to its associated location and metadata.
 Full TypeScript support included with exported types:
 
 ```typescript
-import type { AliasResponse, Location, Address, Geo, Instructions } from '@vintr/node-sdk';
+import type {
+  AliasResponse,
+  Location,
+  Address,
+  Geo,
+  Instructions,
+} from "@vintr/node-sdk";
 ```

package/dist/alias.js

@@ -3,6 +3,6 @@ export class AliasAPI {
         this.client = client;
     }
     async resolve(params) {
-        return this.client.resolveAlias(params.alias);
+        return this.client.resolveAlias(params);
     }
 }

package/dist/client.d.ts

@@ -1,8 +1,8 @@
-import type { AliasResponse } from './types.js';
+import type { AliasResponse, ResolveAliasParams } from './types.js';
 export declare class VintrClient {
     private apiKey;
     private readonly baseUrl;
     constructor(apiKey: string);
     private request;
-    resolveAlias(alias: string): Promise<AliasResponse>;
+    resolveAlias(params: ResolveAliasParams): Promise<AliasResponse>;
 }

package/dist/client.js

@@ -4,18 +4,20 @@ export class VintrClient {
         this.baseUrl = 'https://api.vintr.xyz';
         this.apiKey = apiKey;
     }
-    async request(path) {
+    async request(path, headers) {
         return new Promise((resolve, reject) => {
             const url = new URL(path, this.baseUrl);
+            const defaultHeaders = {
+                'Authorization': `Bearer ${this.apiKey}`,
+                'Content-Type': 'application/json',
+            };
+            const allHeaders = { ...defaultHeaders, ...headers };
             const options = {
                 hostname: url.hostname,
                 port: url.port || 443,
-                path: url.pathname,
+                path: url.pathname + url.search,
                 method: 'GET',
-                headers: {
-                    'Authorization': `Bearer ${this.apiKey}`,
-                    'Content-Type': 'application/json',
-                },
+                headers: allHeaders,
             };
             const req = https.request(options, (res) => {
                 let data = '';
@@ -38,7 +40,9 @@ export class VintrClient {
             req.end();
         });
     }
-    async resolveAlias(alias) {
-        return this.request(`/${alias}`);
+    async resolveAlias(params) {
+        const url = new URL(`/${params.alias}`, this.baseUrl);
+        url.searchParams.append('code', params.code);
+        return this.request(url.pathname + url.search);
     }
 }

package/dist/types.d.ts

@@ -1,38 +1,39 @@
 export interface Address {
-    line1: string;
+    line1?: string;
     line2?: string;
     line3?: string;
-    city: string;
-    state: string;
-    postal_code: string;
-    country: string;
+    city?: string;
+    state?: string;
+    postal_code?: string;
+    country?: string;
 }
 export interface Geo {
-    latitude: number;
-    longitude: number;
-    altitude: number | null;
-    precision_meters: number;
+    latitude?: number;
+    longitude?: number;
+    altitude?: number | null;
+    precision_meters?: number;
 }
 export interface Instructions {
-    general: string;
-    delivery: string;
-    autonomous: string;
+    general?: string;
+    delivery?: string;
+    autonomous?: string;
 }
 export interface Location {
-    address: Address;
-    geo: Geo;
-    instructions: Instructions;
+    address?: Address;
+    geo?: Geo;
+    instructions?: Instructions;
 }
 export interface AliasResponse {
     alias: string;
-    type: 'business' | 'individual';
-    location: Location;
-    createdAt: string;
-    updatedAt: string;
+    type?: 'business' | 'individual';
+    location?: Location;
+    createdAt?: string;
+    updatedAt?: string;
 }
 export interface ErrorResponse {
     error: string;
 }
 export interface ResolveAliasParams {
     alias: string;
+    code: string;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vintr/node-sdk",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Minimal, elegant Vintr API SDK for Node.js",
   "type": "module",
   "main": "dist/index.js",