@dorapocket-tech/link-service-sdk 0.1.1

package/README.md

@@ -0,0 +1,43 @@
+# @dorapocket-tech/link-service-sdk
+
+Typed client SDK for interacting with the Dorapocket Link Service API.
+
+## Install
+
+```bash
+npm install @dorapocket-tech/link-service-sdk
+```
+
+## Usage
+
+```ts
+import { LinkServiceClient } from '@dorapocket-tech/link-service-sdk';
+
+const client = LinkServiceClient.configure({
+  environment: 'prod',
+  apiKey: process.env.LINK_SERVICE_API_KEY!,
+});
+
+const created = await client.createLink({
+  url: 'https://example.com',
+  payload: { source: 'campaign-a' },
+});
+
+const payload = await client.resolvePayload(created.code);
+```
+
+## Environments
+
+- `prod` -> `https://api.tinyhub.link`
+- `sandbox` -> `https://api.sandbox.tinyhub.link`
+
+## API
+
+- `LinkServiceClient.configure({ environment, apiKey })`
+- `client.createLink(request, options?)`
+- `client.resolvePayload(codeOrUrl, options?)`
+
+## Requirements
+
+- Node.js 20+
+- Runtime with global `fetch` support

package/dist/constants.d.ts

@@ -0,0 +1,7 @@
+export declare const URL_RESOLUTION_CONSTANTS: {
+    readonly SHORT_CODE_PARAMETER: "_code";
+};
+export declare const API_CONSTANTS: {
+    readonly LINK_MANAGEMENT_BASE_PATH: "links";
+};
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,wBAAwB;;CAE3B,CAAC;AAEX,eAAO,MAAM,aAAa;;CAEhB,CAAC"}

package/dist/errors.d.ts

@@ -0,0 +1,22 @@
+export interface LinkServiceErrorDetails {
+    status: number;
+    method: string;
+    url: string;
+    responseBody?: unknown;
+    responseText?: string;
+    headers?: Record<string, string | null>;
+    retryAfter?: number;
+    cause?: unknown;
+}
+export declare class LinkServiceError extends Error {
+    readonly status: number;
+    readonly method: string;
+    readonly url: string;
+    readonly responseBody?: unknown;
+    readonly responseText?: string;
+    readonly headers?: Record<string, string | null>;
+    readonly retryAfter?: number;
+    readonly cause?: unknown;
+    constructor(message: string, details: LinkServiceErrorDetails);
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,CAAC;IACxC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,qBAAa,gBAAiB,SAAQ,KAAK;IACzC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;IAChC,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;IAC/B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,CAAC;IACjD,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAC7B,SAAkB,KAAK,CAAC,EAAE,OAAO,CAAC;gBAEtB,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,uBAAuB;CAgB9D"}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export { LinkServiceClient } from './link-service-client.js';
+export { LinkServiceError } from './errors.js';
+export { LINK_SERVICE_ENVIRONMENT_URLS } from './types.js';
+export type { LinkServiceConfigurationOptions, LinkServiceEnvironment, LinkServiceRequestOptions, CreateLinkRequest, CreateLinkResponse, LinkPayload, } from './types.js';
+//# 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":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC/C,OAAO,EAAE,6BAA6B,EAAE,MAAM,YAAY,CAAC;AAC3D,YAAY,EACV,+BAA+B,EAC/B,sBAAsB,EACtB,yBAAyB,EACzB,iBAAiB,EACjB,kBAAkB,EAClB,WAAW,GACZ,MAAM,YAAY,CAAC"}

package/dist/index.js

@@ -0,0 +1,229 @@
+const E = {
+  SHORT_CODE_PARAMETER: "_code"
+}, m = {
+  LINK_MANAGEMENT_BASE_PATH: "links"
+};
+class d extends Error {
+  status;
+  method;
+  url;
+  responseBody;
+  responseText;
+  headers;
+  retryAfter;
+  cause;
+  constructor(e, r) {
+    super(
+      e,
+      r.cause !== void 0 ? { cause: r.cause } : void 0
+    ), this.name = "LinkServiceError", this.status = r.status, this.method = r.method, this.url = r.url, this.responseBody = r.responseBody, this.responseText = r.responseText, this.headers = r.headers, this.retryAfter = r.retryAfter, this.cause = r.cause;
+  }
+}
+const T = {
+  prod: "https://api.tinyhub.link",
+  sandbox: "https://api.sandbox.tinyhub.link"
+}, y = "application/json", w = 3e4, b = (n) => {
+  const e = T[n];
+  if (!e)
+    throw new Error(`Unsupported Link Service environment: "${n}".`);
+  return e;
+}, v = () => {
+  if (typeof DOMException < "u")
+    return new DOMException("Request timed out", "TimeoutError");
+  const n = new Error("Request timed out");
+  return n.name = "TimeoutError", n;
+}, S = (n) => n === 400 ? "Request was invalid. Please check your input." : n === 401 ? "Unauthorized. Please check your API key." : n === 403 ? "Forbidden. Your API key does not have access." : n === 404 ? "Resource not found." : n === 409 ? "Request conflict. Please try again." : n === 429 ? "Too many requests. Please try again later." : n >= 500 ? "Link Service is unavailable. Please try again later." : "Request failed. Please try again.";
+class p {
+  static configure(e) {
+    const r = b(e.environment);
+    return new p({
+      baseUrl: r,
+      apiKey: e.apiKey
+    });
+  }
+  baseUrl;
+  apiKey;
+  fetchImpl;
+  defaultTimeout;
+  defaultHeaders;
+  constructor(e) {
+    if (!e || typeof e != "object")
+      throw new Error("LinkServiceClient options are required");
+    const r = e.baseUrl?.trim();
+    if (!r)
+      throw new Error("LinkServiceClient requires a non-empty baseUrl");
+    try {
+      new URL(r);
+    } catch {
+      throw new Error(`Invalid baseUrl provided: "${e.baseUrl}"`);
+    }
+    const t = this.normalizeToken(e.apiKey, "apiKey"), a = globalThis.fetch;
+    if (typeof a != "function")
+      throw new Error(
+        "No fetch implementation found. Ensure global fetch is available."
+      );
+    this.baseUrl = r.replace(/\/+$/, ""), this.apiKey = t, this.fetchImpl = a.bind(globalThis), this.defaultTimeout = w, this.defaultHeaders = {
+      Accept: y
+    };
+  }
+  async createLink(e, r) {
+    return this.performRequest(
+      "POST",
+      `/${m.LINK_MANAGEMENT_BASE_PATH}`,
+      e,
+      r
+    );
+  }
+  async resolvePayload(e, r) {
+    const t = this.resolveShortCode(e);
+    return this.performRequest(
+      "GET",
+      `/${m.LINK_MANAGEMENT_BASE_PATH}/${t}/payload`,
+      void 0,
+      r
+    );
+  }
+  resolveShortCode(e) {
+    const r = e?.trim();
+    if (!r)
+      throw new Error("Short link code or URL is required");
+    const t = /^https?:\/\//i.test(r);
+    if (t || r.includes(".") && r.includes("/")) {
+      const i = t ? r : `https://${r}`;
+      let s;
+      try {
+        s = new URL(i);
+      } catch (o) {
+        if (t)
+          throw o;
+      }
+      if (s) {
+        const o = E.SHORT_CODE_PARAMETER, c = s.searchParams.get(o)?.trim();
+        if (c)
+          return c;
+        const u = s.pathname.replace(/\/+$/, "").split("/").filter(Boolean).at(-1)?.trim();
+        if (u)
+          return u;
+        throw new Error("Short link URL does not contain a code");
+      }
+    }
+    return r;
+  }
+  normalizeToken(e, r) {
+    if (e == null)
+      throw new Error(`${r} is required`);
+    const t = e.trim();
+    if (!t)
+      throw new Error(`${r} must be a non-empty string`);
+    return t;
+  }
+  resolveTimeout(e) {
+    return e?.timeoutMs !== void 0 && e.timeoutMs >= 0 && Number.isFinite(e.timeoutMs) ? e.timeoutMs : this.defaultTimeout;
+  }
+  createSignal(e, r) {
+    const t = e?.signal;
+    if (!(typeof AbortController < "u" && (r !== void 0 || t)))
+      return { signal: t, cleanup: () => {
+      } };
+    const i = new AbortController();
+    let s, o;
+    t && (t.aborted ? i.abort(
+      t.reason
+    ) : (o = () => i.abort(
+      t.reason
+    ), t.addEventListener("abort", o))), r && r > 0 && (s = setTimeout(() => {
+      i.signal.aborted || i.abort(v());
+    }, r));
+    const c = () => {
+      o && t && t.removeEventListener("abort", o), s && clearTimeout(s);
+    };
+    return {
+      signal: i.signal,
+      cleanup: c
+    };
+  }
+  mergeHeaders(e, r) {
+    const t = {
+      ...this.defaultHeaders,
+      "X-API-Key": this.apiKey,
+      ...r?.headers ?? {}
+    };
+    return e && (t["Content-Type"] = t["Content-Type"] ?? y), t;
+  }
+  async performRequest(e, r, t, a) {
+    const i = this.buildUrl(r), s = this.resolveTimeout(a), { signal: o, cleanup: c } = this.createSignal(a, s), h = t != null;
+    try {
+      const l = await this.fetchImpl(i, {
+        method: e,
+        headers: this.mergeHeaders(h, a),
+        body: h ? JSON.stringify(t) : void 0,
+        signal: o
+      });
+      return await this.handleResponse(l, e, i);
+    } catch (l) {
+      if (l instanceof d)
+        throw l;
+      let u = "Network request failed. Please try again.";
+      if (l && typeof l == "object" && "name" in l) {
+        const f = String(l.name);
+        f === "TimeoutError" ? u = "Request timed out. Please try again." : f === "AbortError" && (u = "Request was cancelled.");
+      }
+      throw new d(
+        u,
+        {
+          status: 0,
+          method: e,
+          url: i,
+          cause: l
+        }
+      );
+    } finally {
+      c();
+    }
+  }
+  buildUrl(e) {
+    return e.startsWith("/") ? `${this.baseUrl}${e}` : `${this.baseUrl}/${e}`;
+  }
+  async handleResponse(e, r, t) {
+    const a = e.headers?.get?.("content-type") ?? e.headers?.get?.("Content-Type") ?? "", s = e.status !== 204 && e.status !== 205 ? await e.text() : "";
+    let o;
+    if (s && a.includes("json"))
+      try {
+        o = JSON.parse(s);
+      } catch (c) {
+        if (e.ok)
+          throw new d(
+            "Unexpected response from Link Service.",
+            {
+              status: e.status,
+              method: r,
+              url: t,
+              cause: c
+            }
+          );
+      }
+    if (!e.ok) {
+      const c = S(e.status);
+      throw new d(c, {
+        status: e.status,
+        method: r,
+        url: t
+      });
+    }
+    if (!o && s && !a.includes("json"))
+      throw new d(
+        "Unexpected response from Link Service.",
+        {
+          status: e.status,
+          method: r,
+          url: t
+        }
+      );
+    return o;
+  }
+}
+export {
+  T as LINK_SERVICE_ENVIRONMENT_URLS,
+  p as LinkServiceClient,
+  d as LinkServiceError
+};

package/dist/link-service-client.d.ts

@@ -0,0 +1,26 @@
+import { CreateLinkRequest, CreateLinkResponse, LinkPayload, LinkServiceConfigurationOptions, LinkServiceRequestOptions } from './types.js';
+type LinkServiceClientInit = {
+    baseUrl: string;
+    apiKey: string;
+};
+export declare class LinkServiceClient {
+    static configure(options: LinkServiceConfigurationOptions): LinkServiceClient;
+    private readonly baseUrl;
+    private readonly apiKey;
+    private readonly fetchImpl;
+    private readonly defaultTimeout;
+    private readonly defaultHeaders;
+    constructor(options: LinkServiceClientInit);
+    createLink(request: CreateLinkRequest, options?: LinkServiceRequestOptions): Promise<CreateLinkResponse>;
+    resolvePayload(code: string, options?: LinkServiceRequestOptions): Promise<LinkPayload>;
+    private resolveShortCode;
+    private normalizeToken;
+    private resolveTimeout;
+    private createSignal;
+    private mergeHeaders;
+    private performRequest;
+    private buildUrl;
+    private handleResponse;
+}
+export {};
+//# sourceMappingURL=link-service-client.d.ts.map

package/dist/link-service-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"link-service-client.d.ts","sourceRoot":"","sources":["../src/link-service-client.ts"],"names":[],"mappings":"AAKA,OAAO,EACL,iBAAiB,EACjB,kBAAkB,EAElB,WAAW,EACX,+BAA+B,EAE/B,yBAAyB,EAC1B,MAAM,YAAY,CAAC;AAiDpB,KAAK,qBAAqB,GAAG;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,qBAAa,iBAAiB;IAC5B,MAAM,CAAC,SAAS,CACd,OAAO,EAAE,+BAA+B,GACvC,iBAAiB;IASpB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAe;IACzC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAS;IACxC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAyB;gBAE5C,OAAO,EAAE,qBAAqB;IAoCpC,UAAU,CACd,OAAO,EAAE,iBAAiB,EAC1B,OAAO,CAAC,EAAE,yBAAyB,GAClC,OAAO,CAAC,kBAAkB,CAAC;IASxB,cAAc,CAClB,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,yBAAyB,GAClC,OAAO,CAAC,WAAW,CAAC;IAUvB,OAAO,CAAC,gBAAgB;IA2CxB,OAAO,CAAC,cAAc;IActB,OAAO,CAAC,cAAc;IAatB,OAAO,CAAC,YAAY;IAsDpB,OAAO,CAAC,YAAY;YAkBN,cAAc;IAiD5B,OAAO,CAAC,QAAQ;YAOF,cAAc;CAuD7B"}

package/dist/package.json

@@ -0,0 +1,82 @@
+{
+  "name": "@dorapocket-tech/link-service-sdk",
+  "version": "0.1.1",
+  "description": "Typed client SDK for interacting with the Dorapocket link service API.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dorapocket-tech/dorapocket-service.git",
+    "directory": "apps/link-service-sdk"
+  },
+  "homepage": "https://github.com/dorapocket-tech/dorapocket-service/tree/main/apps/link-service-sdk#readme",
+  "bugs": {
+    "url": "https://github.com/dorapocket-tech/dorapocket-service/issues"
+  },
+  "keywords": [
+    "dorapocket",
+    "sdk",
+    "link-service",
+    "typescript"
+  ],
+  "type": "module",
+  "private": false,
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "vite build",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "eslint ."
+  },
+  "devDependencies": {
+    "typescript": "^5.8.2",
+    "vitest": "^3.0.0"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "nx": {
+    "sourceRoot": "apps/link-service-sdk/src",
+    "projectType": "library",
+    "tags": [
+      "scope:sdk",
+      "type:lib"
+    ],
+    "targets": {
+      "build": {
+        "executor": "@nx/vite:build",
+        "outputs": [
+          "{options.outputPath}"
+        ],
+        "options": {
+          "outputPath": "apps/link-service-sdk/dist"
+        }
+      },
+      "test": {
+        "executor": "@nx/vite:test",
+        "outputs": [
+          "{options.reportsDirectory}"
+        ],
+        "options": {
+          "passWithNoTests": false,
+          "reportsDirectory": "../../coverage/apps/link-service-sdk"
+        }
+      }
+    }
+  }
+}

package/dist/types.d.ts

@@ -0,0 +1,46 @@
+export declare const LINK_SERVICE_ENVIRONMENT_URLS: {
+    readonly prod: "https://api.tinyhub.link";
+    readonly sandbox: "https://api.sandbox.tinyhub.link";
+};
+export type LinkServiceEnvironment = keyof typeof LINK_SERVICE_ENVIRONMENT_URLS;
+export interface LinkServiceConfigurationOptions {
+    /**
+     * Named environment shortcut.
+     */
+    environment: LinkServiceEnvironment;
+    /**
+     * API key issued for the customer application.
+     */
+    apiKey: string;
+}
+export interface LinkServiceRequestOptions {
+    /**
+     * Advanced per-request options.
+     */
+    /**
+     * Optional AbortSignal that cancels the request.
+     */
+    signal?: AbortSignal;
+    /**
+     * Additional headers to merge for this specific call.
+     */
+    headers?: Record<string, string>;
+    /**
+     * Override timeout (in milliseconds) for this call.
+     */
+    timeoutMs?: number;
+}
+export interface CreateLinkRequest {
+    url: string;
+    payload?: Record<string, unknown>;
+    expiresIn?: string;
+    maxUses?: number;
+}
+export interface CreateLinkResponse {
+    shortUrl: string;
+    code: string;
+    expiresAt?: string;
+    maxUses?: number;
+}
+export type LinkPayload = Record<string, unknown>;
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,6BAA6B;;;CAGhC,CAAC;AAEX,MAAM,MAAM,sBAAsB,GAChC,MAAM,OAAO,6BAA6B,CAAC;AAE7C,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,WAAW,EAAE,sBAAsB,CAAC;IACpC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,82 @@
+{
+  "name": "@dorapocket-tech/link-service-sdk",
+  "version": "0.1.1",
+  "description": "Typed client SDK for interacting with the Dorapocket link service API.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dorapocket-tech/dorapocket-service.git",
+    "directory": "apps/link-service-sdk"
+  },
+  "homepage": "https://github.com/dorapocket-tech/dorapocket-service/tree/main/apps/link-service-sdk#readme",
+  "bugs": {
+    "url": "https://github.com/dorapocket-tech/dorapocket-service/issues"
+  },
+  "keywords": [
+    "dorapocket",
+    "sdk",
+    "link-service",
+    "typescript"
+  ],
+  "type": "module",
+  "private": false,
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "vite build",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "lint": "eslint ."
+  },
+  "devDependencies": {
+    "typescript": "^5.8.2",
+    "vitest": "^3.0.0"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "nx": {
+    "sourceRoot": "apps/link-service-sdk/src",
+    "projectType": "library",
+    "tags": [
+      "scope:sdk",
+      "type:lib"
+    ],
+    "targets": {
+      "build": {
+        "executor": "@nx/vite:build",
+        "outputs": [
+          "{options.outputPath}"
+        ],
+        "options": {
+          "outputPath": "apps/link-service-sdk/dist"
+        }
+      },
+      "test": {
+        "executor": "@nx/vite:test",
+        "outputs": [
+          "{options.reportsDirectory}"
+        ],
+        "options": {
+          "passWithNoTests": false,
+          "reportsDirectory": "../../coverage/apps/link-service-sdk"
+        }
+      }
+    }
+  }
+}