# @types/apple-signin-api

> TypeScript definitions for apple-signin-api

Latest version **1.5.3** (published 2023-11-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/apple-signin-api
pnpm add @types/apple-signin-api
yarn add @types/apple-signin-api
bun add @types/apple-signin-api
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.5.3 |
| Published | 2023-11-06 |
| First published | 2020-02-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 5.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51372 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/apple-signin-api
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/apple-signin-api
- npm.io page: https://npm.io/package/@types/apple-signin-api

## Recent versions

- 1.5.3 (latest) — 2023-11-06
- 1.5.1 (ts3.6) — 2021-07-07
- 1.5.0 (ts3.0) — 2020-05-15
- 1.4.0 (ts2.8) — 2020-02-22
- 1.5.2 — 2023-10-17

## README

# Installation
> `npm install --save @types/apple-signin-api`

# Summary
This package contains type definitions for apple-signin-api (https://developer.apple.com/documentation/signinwithapplejs).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/apple-signin-api.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/apple-signin-api/index.d.ts)
````ts
declare var AppleID: AppleSignInAPI.AppleID;

declare namespace AppleSignInAPI {
    // https://developer.apple.com/documentation/signinwithapplejs/authorizationi
    interface AuthorizationI {
        code: string;
        id_token: string;
        state: string;
        nonce?: string | undefined;
    }
    // https://developer.apple.com/documentation/signinwithapplejs/namei
    interface NameI {
        firstName: string;
        lastName: string;
    }
    // https://developer.apple.com/documentation/signinwithapplejs/signinerrori
    interface SignInErrorI {
        error: string;
    }
    // https://developer.apple.com/documentation/signinwithapplejs/signinresponsei
    interface SignInResponseI {
        authorization: AuthorizationI;
        user?: UserI | undefined;
    }
    // https://developer.apple.com/documentation/signinwithapplejs/useri
    interface UserI {
        email: string;
        name: NameI;
    }
    // https://developer.apple.com/documentation/signinwithapplejs/authi
    interface AuthI {
        init: (config: ClientConfigI) => void;
        signIn: (signInConfig?: ClientConfigI) => Promise<SignInResponseI>;
        renderButton: () => void;
    }
    // https://developer.apple.com/documentation/signinwithapplejs/clientconfigi
    interface ClientConfigI {
        clientId?: string | undefined;
        redirectURI?: string | undefined;
        scope?: string | undefined;
        state?: string | undefined;
        nonce?: string | undefined;
        usePopup?: boolean | undefined;
    }
    interface AppleID {
        auth: AuthI;
    }
}

````

### Additional Details
 * Last updated: Mon, 06 Nov 2023 22:41:04 GMT
 * Dependencies: none

# Credits
These definitions were written by [Julius Lungys](https://github.com/voidpumpkin), and [Koen Punt](https://github.com/koenpunt).

---
_Source: https://npm.io/package/@types/apple-signin-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._