glide-magical-auth

Developer-friendly & type-safe Typescript SDK specifically catered to leverage glide-magical-auth API.

[!IMPORTANT] This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

Magic Auth Aggregator API: API for phone number authentication and verification using digital credentials.

Overview

The Magic Auth Aggregator provides carrier-based phone authentication through TS43 protocol and Link strategy (for Verizon). All carrier information is kept internal for privacy.

Key Features

• Phone number verification without SMS/OTP
• Device phone number retrieval
• Carrier eligibility checking
• Privacy-preserving design (no carrier info exposed)

Authentication Strategies

• TS43: T-Mobile (Chrome/Chromium browsers)
• Link: Verizon (App Clips on iOS)
• Coming Soon: AT&T support

Table of Contents

• glide-magical-auth
  • Overview
  • Key Features
  • Authentication Strategies
  • SDK Installation
  • Requirements
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Standalone functions
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Debugging
• Development
  • Maturity
  • Contributions

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add glide-magical-auth

PNPM

pnpm add glide-magical-auth

Bun

bun add glide-magical-auth

Yarn

yarn add glide-magical-auth

[!NOTE] This package is published with CommonJS and ES Modules (ESM) support.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { MagicalAuth } from "glide-magical-auth";

const magicalAuth = new MagicalAuth();

async function run() {
  const result = await magicalAuth.authentication.getAccessToken({
    grantType: "client_credentials",
  });

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme | Environment Variable | | -------------------------------------------- | ------ | ------------------------------ | ----------------------------------------------------------------------------------- | | clientIDclientSecrettokenURL | oauth2 | OAuth2 Client Credentials Flow | MAGICALAUTH_CLIENT_IDMAGICALAUTH_CLIENT_SECRETMAGICALAUTH_TOKEN_URL |

You can set the security parameters through the security optional parameter when initializing the SDK client instance. For example:

import { MagicalAuth } from "glide-magical-auth";

const magicalAuth = new MagicalAuth({
  security: {
    clientID: process.env["MAGICALAUTH_CLIENT_ID"] ?? "",
    clientSecret: process.env["MAGICALAUTH_CLIENT_SECRET"] ?? "",
  },
});

async function run() {
  const result = await magicalAuth.authentication.getAccessToken({
    grantType: "client_credentials",
  });

  console.log(result);
}

run();

Available Resources and Operations

Authentication

• getAccessToken - Obtain access token
• prepare - Prepare authentication
• verifyPhoneNumber - Verify phone number
• retrievePhoneNumber - Get phone number
• reportInvocation - Report invocation event
• getStatus - Check verification status (protected)

Public

• getStatus - Check verification status (public)

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

• authenticationGetAccessToken - Obtain access token
• authenticationGetStatus - Check verification status (protected)
• authenticationPrepare - Prepare authentication
• authenticationReportInvocation - Report invocation event
• authenticationRetrievePhoneNumber - Get phone number
• authenticationVerifyPhoneNumber - Verify phone number
• publicGetStatus - Check verification status (public)

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { MagicalAuth } from "glide-magical-auth";

const magicalAuth = new MagicalAuth();

async function run() {
  const result = await magicalAuth.authentication.getAccessToken({
    grantType: "client_credentials",
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { MagicalAuth } from "glide-magical-auth";

const magicalAuth = new MagicalAuth({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
});

async function run() {
  const result = await magicalAuth.authentication.getAccessToken({
    grantType: "client_credentials",
  });

  console.log(result);
}

run();

Error Handling

MagicalAuthError is the base class for all HTTP error responses. It has the following properties:

| Property | Type | Description | | ------------------- | ---------- | --------------------------------------------------------------------------------------- | | error.message | string | Error message | | error.statusCode | number | HTTP response status code eg 404 | | error.headers | Headers | HTTP response headers | | error.body | string | HTTP body. Can be empty string if no body is returned. | | error.rawResponse | Response | Raw HTTP response | | error.data$ | | Optional. Some errors may contain structured data. See Error Classes. |

Example

import { MagicalAuth } from "glide-magical-auth";
import * as errors from "glide-magical-auth/models/errors";

const magicalAuth = new MagicalAuth();

async function run() {
  try {
    const result = await magicalAuth.authentication.getAccessToken({
      grantType: "client_credentials",
    });

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.MagicalAuthError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.OAuthError) {
        console.log(error.data$.error); // models.ErrorT
        console.log(error.data$.errorDescription); // string
      }
    }
  }
}

run();

Error Classes

Primary errors:

• MagicalAuthError: The base class for HTTP error responses.
  • ErrorResponse: Bad request - Invalid input parameters. *

Network errors:

• ConnectionError: HTTP client was unable to make a request to a server.
• RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.
• RequestAbortedError: HTTP request was aborted by the client.
• InvalidRequestError: Any input used to create a request is invalid.
• UnexpectedClientError: Unrecognised or unexpected error.

Inherit from MagicalAuthError:

• OAuthError: Invalid request. Applicable to 1 of 7 methods.*
• ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

* Check the method documentation to see if the error is applicable.

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx: number optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

| # | Server | Description | | --- | ----------------------------------- | ----------------- | | 0 | https://api.glideidentity.app | Production server | | 1 | https://api-stg.glideidentity.app | Staging server | | 2 | http://localhost:8080 | Local development |

Example

import { MagicalAuth } from "glide-magical-auth";

const magicalAuth = new MagicalAuth({
  serverIdx: 0,
});

async function run() {
  const result = await magicalAuth.authentication.getAccessToken({
    grantType: "client_credentials",
  });

  console.log(result);
}

run();

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { MagicalAuth } from "glide-magical-auth";

const magicalAuth = new MagicalAuth({
  serverURL: "http://localhost:8080",
});

async function run() {
  const result = await magicalAuth.authentication.getAccessToken({
    grantType: "client_credentials",
  });

  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { MagicalAuth } from "glide-magical-auth";
import { HTTPClient } from "glide-magical-auth/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new MagicalAuth({ httpClient: httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { MagicalAuth } from "glide-magical-auth";

const sdk = new MagicalAuth({ debugLogger: console });

You can also enable a default debug logger by setting an environment variable MAGICALAUTH_DEBUG to true.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

SDK Created by Speakeasy