All Symbols - @hertzg/mymagti-api documentation

mod.ts

Client for the MyMagti API.

Examples

Mocking fetch for tests

import { assertEquals } from "@std/assert";
import { fetchToken } from "@hertzg/mymagti-api";

const mockFetch: typeof fetch = async (_url, _init) => new Response(
  JSON.stringify({
    access_token: "A",
    autoLogin: 0,
    expires_in: 3600,
    jti: "id",
    phoneNo: "5xxxxxxxx",
    refresh_token: "R",
    scope: "*",
    token_type: "bearer",
    userId: 1,
    userIdentifier: "u",
  }),
  { status: 200, headers: { "content-type": "application/json" } },
);

const res = await fetchToken(
  { type: "login", username: "u", password: "p" },
  { fetch: mockFetch },
);

assertEquals(res.result, "success");
if (res.result === "success") {
  assertEquals(typeof res.data.access_token, "string");
}

Functions

fetchToken(

request: FetchTokenRequest,

options?: FetchOauthOptions

): Promise<LoginResult>

Fetches an OAuth token using the provided request.

Interfaces

GenericErrorResponse

Generic error response from OAuth server.

error: string
Error code
error_description: string
Error description

TokenInfo

OAuth token information.

access_token: string
Access token for API requests
autoLogin: number
Auto-login flag
expires_in: number
Token expiration time in seconds
jti: string
JWT ID
phoneNo: string
Phone number
refresh_token: string
Refresh token for getting new access tokens
scope: string
Token scope
token_type: string
Token type
userId: number
User ID
userIdentifier: string
User identifier

Type Aliases

FetchOauthOptions = { fetch?: fetch; url?: string; baseUrl?: string; grantType?: string; clientId?: string; authorization?: string; userAgent?: string; }

Options for OAuth fetch operations.

FetchTokenRequest =

{ type: "login"; username: string; password: string; }
| { type: "refresh"; refreshToken: string; }

Request type for fetching OAuth tokens.

LoginResult =

{ result: "error"; statusCode: number; data: GenericErrorResponse; }
| { result: "success"; statusCode: number; data: TokenInfo; }

Result of login/refresh operations.

Variables

DEFAULT_BASE_URL: "https://oauth.magticom.ge/auth/"

OAuth helpers for MyMagti API.

DEFAULT_USER_AGENT: "MyMagti/11.9.96 (Magticom.MyMagti; build:1; iOS 18.1.0) Alamofire/5.9.1"

Default user agent string for OAuth requests.

DEFAULTS: { login: { url: string; grantType: string; clientId: string; authorization: string; }; refresh: { url: string; grantType: string; clientId: string; authorization: string; }; }

Default OAuth configuration values.

oauth/oauth.ts

OAuth helpers for MyMagti API.

Examples

Mocking fetch for tests

import { assertEquals } from "@std/assert";
import { fetchToken } from "@hertzg/mymagti-api/oauth";

const mockFetch: typeof fetch = async (_url, _init) => new Response(
  JSON.stringify({
    access_token: "A",
    autoLogin: 0,
    expires_in: 3600,
    jti: "id",
    phoneNo: "5xxxxxxxx",
    refresh_token: "R",
    scope: "*",
    token_type: "bearer",
    userId: 1,
    userIdentifier: "u",
  }),
  { status: 200, headers: { "content-type": "application/json" } },
);

const res = await fetchToken(
  { type: "login", username: "u", password: "p" },
  { fetch: mockFetch },
);

assertEquals(res.result, "success");
if (res.result === "success") {
  assertEquals(typeof res.data.access_token, "string");
}