@capawesome/capacitor-apple-sign-in 0.0.1

package/android/src/main/res/drawable/ic_close.xml

@@ -0,0 +1,9 @@
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="24dp"
+    android:height="24dp"
+    android:viewportWidth="24"
+    android:viewportHeight="24">
+    <path
+        android:fillColor="#FF737373"
+        android:pathData="M19,6.41L17.59,5 12,10.59 6.41,5 5,6.41 10.59,12 5,17.59 6.41,19 12,13.41 17.59,19 19,17.59 13.41,12z" />
+</vector>

package/dist/docs.json

@@ -0,0 +1,345 @@
+{
+  "api": {
+    "name": "AppleSignInPlugin",
+    "slug": "applesigninplugin",
+    "docs": "",
+    "tags": [],
+    "methods": [
+      {
+        "name": "initialize",
+        "signature": "(options: InitializeOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "InitializeOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Initialize the plugin.\n\nThis method must be called before `signIn()` on **Android** and **Web**.\n\nOnly available on Android and Web.",
+        "complexTypes": [
+          "InitializeOptions"
+        ],
+        "slug": "initialize"
+      },
+      {
+        "name": "signIn",
+        "signature": "(options?: SignInOptions | undefined) => Promise<SignInResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "SignInOptions | undefined"
+          }
+        ],
+        "returns": "Promise<SignInResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Sign in with Apple.",
+        "complexTypes": [
+          "SignInResult",
+          "SignInOptions"
+        ],
+        "slug": "signin"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "InitializeOptions",
+      "slug": "initializeoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "clientId",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "\"com.example.app.signin\"",
+              "name": "example"
+            }
+          ],
+          "docs": "The Apple Service ID to use for sign-in.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "SignInResult",
+      "slug": "signinresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "authorizationCode",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The authorization code.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "idToken",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The ID token (JWT).",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "user",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "\"001234.abcdef1234567890abcdef1234567890.1234\"",
+              "name": "example"
+            }
+          ],
+          "docs": "The stable Apple user identifier.\n\nOn **Android** and **Web**, this is decoded from the JWT `sub` claim.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "email",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The user's email address.\n\nOn **iOS**, this is only provided on the first sign-in.",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "givenName",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The user's given name.\n\nOn **iOS**, this is only provided on the first sign-in.",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "familyName",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The user's family name.\n\nOn **iOS**, this is only provided on the first sign-in.",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "state",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The state value from the sign-in request.\n\nOnly available on Android and Web.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "realUserStatus",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The real user status.\n\nOnly available on iOS.",
+          "complexTypes": [
+            "RealUserStatus"
+          ],
+          "type": "RealUserStatus"
+        }
+      ]
+    },
+    {
+      "name": "SignInOptions",
+      "slug": "signinoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "redirectUrl",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "\"https://example.com/callback\"",
+              "name": "example"
+            }
+          ],
+          "docs": "The OAuth redirect URL to use for sign-in.\n\nOnly available on Android and Web.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "scopes",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The scopes to request during sign-in.",
+          "complexTypes": [
+            "SignInScope"
+          ],
+          "type": "SignInScope[] | undefined"
+        },
+        {
+          "name": "nonce",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "A nonce for replay protection.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "state",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "A state value for CSRF protection.\n\nOnly available on Android and Web.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    }
+  ],
+  "enums": [
+    {
+      "name": "RealUserStatus",
+      "slug": "realuserstatus",
+      "members": [
+        {
+          "name": "LikelyReal",
+          "value": "'LIKELY_REAL'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The user appears to be a real person."
+        },
+        {
+          "name": "Unknown",
+          "value": "'UNKNOWN'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The system can't determine whether the user is a real person."
+        },
+        {
+          "name": "Unsupported",
+          "value": "'UNSUPPORTED'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The real user status is not supported on this platform."
+        }
+      ]
+    },
+    {
+      "name": "SignInScope",
+      "slug": "signinscope",
+      "members": [
+        {
+          "name": "Email",
+          "value": "'EMAIL'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Request the user's email address."
+        },
+        {
+          "name": "FullName",
+          "value": "'FULL_NAME'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Request the user's full name."
+        }
+      ]
+    }
+  ],
+  "typeAliases": [],
+  "pluginConfigs": []
+}

package/dist/esm/definitions.d.ts

@@ -0,0 +1,181 @@
+export interface AppleSignInPlugin {
+    /**
+     * Initialize the plugin.
+     *
+     * This method must be called before `signIn()` on **Android** and **Web**.
+     *
+     * Only available on Android and Web.
+     *
+     * @since 0.1.0
+     */
+    initialize(options: InitializeOptions): Promise<void>;
+    /**
+     * Sign in with Apple.
+     *
+     * @since 0.1.0
+     */
+    signIn(options?: SignInOptions): Promise<SignInResult>;
+}
+/**
+ * @since 0.1.0
+ */
+export interface InitializeOptions {
+    /**
+     * The Apple Service ID to use for sign-in.
+     *
+     * @since 0.1.0
+     * @example "com.example.app.signin"
+     */
+    clientId: string;
+}
+/**
+ * @since 0.1.0
+ */
+export interface SignInOptions {
+    /**
+     * The OAuth redirect URL to use for sign-in.
+     *
+     * Only available on Android and Web.
+     *
+     * @since 0.1.0
+     * @example "https://example.com/callback"
+     */
+    redirectUrl?: string;
+    /**
+     * The scopes to request during sign-in.
+     *
+     * @since 0.1.0
+     */
+    scopes?: SignInScope[];
+    /**
+     * A nonce for replay protection.
+     *
+     * @since 0.1.0
+     */
+    nonce?: string;
+    /**
+     * A state value for CSRF protection.
+     *
+     * Only available on Android and Web.
+     *
+     * @since 0.1.0
+     */
+    state?: string;
+}
+/**
+ * @since 0.1.0
+ */
+export interface SignInResult {
+    /**
+     * The authorization code.
+     *
+     * @since 0.1.0
+     */
+    authorizationCode: string;
+    /**
+     * The ID token (JWT).
+     *
+     * @since 0.1.0
+     */
+    idToken: string;
+    /**
+     * The stable Apple user identifier.
+     *
+     * On **Android** and **Web**, this is decoded from the JWT `sub` claim.
+     *
+     * @since 0.1.0
+     * @example "001234.abcdef1234567890abcdef1234567890.1234"
+     */
+    user: string;
+    /**
+     * The user's email address.
+     *
+     * On **iOS**, this is only provided on the first sign-in.
+     *
+     * @since 0.1.0
+     */
+    email: string | null;
+    /**
+     * The user's given name.
+     *
+     * On **iOS**, this is only provided on the first sign-in.
+     *
+     * @since 0.1.0
+     */
+    givenName: string | null;
+    /**
+     * The user's family name.
+     *
+     * On **iOS**, this is only provided on the first sign-in.
+     *
+     * @since 0.1.0
+     */
+    familyName: string | null;
+    /**
+     * The state value from the sign-in request.
+     *
+     * Only available on Android and Web.
+     *
+     * @since 0.1.0
+     */
+    state?: string;
+    /**
+     * The real user status.
+     *
+     * Only available on iOS.
+     *
+     * @since 0.1.0
+     */
+    realUserStatus?: RealUserStatus;
+}
+/**
+ * @since 0.1.0
+ */
+export declare enum SignInScope {
+    /**
+     * Request the user's email address.
+     *
+     * @since 0.1.0
+     */
+    Email = "EMAIL",
+    /**
+     * Request the user's full name.
+     *
+     * @since 0.1.0
+     */
+    FullName = "FULL_NAME"
+}
+/**
+ * @since 0.1.0
+ */
+export declare enum RealUserStatus {
+    /**
+     * The user appears to be a real person.
+     *
+     * @since 0.1.0
+     */
+    LikelyReal = "LIKELY_REAL",
+    /**
+     * The system can't determine whether the user is a real person.
+     *
+     * @since 0.1.0
+     */
+    Unknown = "UNKNOWN",
+    /**
+     * The real user status is not supported on this platform.
+     *
+     * @since 0.1.0
+     */
+    Unsupported = "UNSUPPORTED"
+}
+/**
+ * @since 0.1.0
+ */
+export declare enum ErrorCode {
+    /**
+     * The sign-in was canceled by the user.
+     *
+     * @since 0.1.0
+     */
+    SignInCanceled = "SIGN_IN_CANCELED"
+}

package/dist/esm/definitions.js

@@ -0,0 +1,55 @@
+/**
+ * @since 0.1.0
+ */
+export var SignInScope;
+(function (SignInScope) {
+    /**
+     * Request the user's email address.
+     *
+     * @since 0.1.0
+     */
+    SignInScope["Email"] = "EMAIL";
+    /**
+     * Request the user's full name.
+     *
+     * @since 0.1.0
+     */
+    SignInScope["FullName"] = "FULL_NAME";
+})(SignInScope || (SignInScope = {}));
+/**
+ * @since 0.1.0
+ */
+export var RealUserStatus;
+(function (RealUserStatus) {
+    /**
+     * The user appears to be a real person.
+     *
+     * @since 0.1.0
+     */
+    RealUserStatus["LikelyReal"] = "LIKELY_REAL";
+    /**
+     * The system can't determine whether the user is a real person.
+     *
+     * @since 0.1.0
+     */
+    RealUserStatus["Unknown"] = "UNKNOWN";
+    /**
+     * The real user status is not supported on this platform.
+     *
+     * @since 0.1.0
+     */
+    RealUserStatus["Unsupported"] = "UNSUPPORTED";
+})(RealUserStatus || (RealUserStatus = {}));
+/**
+ * @since 0.1.0
+ */
+export var ErrorCode;
+(function (ErrorCode) {
+    /**
+     * The sign-in was canceled by the user.
+     *
+     * @since 0.1.0
+     */
+    ErrorCode["SignInCanceled"] = "SIGN_IN_CANCELED";
+})(ErrorCode || (ErrorCode = {}));
+//# sourceMappingURL=definitions.js.map

package/dist/esm/definitions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"AAsIA;;GAEG;AACH,MAAM,CAAN,IAAY,WAaX;AAbD,WAAY,WAAW;IACrB;;;;OAIG;IACH,8BAAe,CAAA;IACf;;;;OAIG;IACH,qCAAsB,CAAA;AACxB,CAAC,EAbW,WAAW,KAAX,WAAW,QAatB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,cAmBX;AAnBD,WAAY,cAAc;IACxB;;;;OAIG;IACH,4CAA0B,CAAA;IAC1B;;;;OAIG;IACH,qCAAmB,CAAA;IACnB;;;;OAIG;IACH,6CAA2B,CAAA;AAC7B,CAAC,EAnBW,cAAc,KAAd,cAAc,QAmBzB;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,SAOX;AAPD,WAAY,SAAS;IACnB;;;;OAIG;IACH,gDAAmC,CAAA;AACrC,CAAC,EAPW,SAAS,KAAT,SAAS,QAOpB","sourcesContent":["export interface AppleSignInPlugin {\n  /**\n   * Initialize the plugin.\n   *\n   * This method must be called before `signIn()` on **Android** and **Web**.\n   *\n   * Only available on Android and Web.\n   *\n   * @since 0.1.0\n   */\n  initialize(options: InitializeOptions): Promise<void>;\n  /**\n   * Sign in with Apple.\n   *\n   * @since 0.1.0\n   */\n  signIn(options?: SignInOptions): Promise<SignInResult>;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface InitializeOptions {\n  /**\n   * The Apple Service ID to use for sign-in.\n   *\n   * @since 0.1.0\n   * @example \"com.example.app.signin\"\n   */\n  clientId: string;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface SignInOptions {\n  /**\n   * The OAuth redirect URL to use for sign-in.\n   *\n   * Only available on Android and Web.\n   *\n   * @since 0.1.0\n   * @example \"https://example.com/callback\"\n   */\n  redirectUrl?: string;\n  /**\n   * The scopes to request during sign-in.\n   *\n   * @since 0.1.0\n   */\n  scopes?: SignInScope[];\n  /**\n   * A nonce for replay protection.\n   *\n   * @since 0.1.0\n   */\n  nonce?: string;\n  /**\n   * A state value for CSRF protection.\n   *\n   * Only available on Android and Web.\n   *\n   * @since 0.1.0\n   */\n  state?: string;\n}\n\n/**\n * @since 0.1.0\n */\nexport interface SignInResult {\n  /**\n   * The authorization code.\n   *\n   * @since 0.1.0\n   */\n  authorizationCode: string;\n  /**\n   * The ID token (JWT).\n   *\n   * @since 0.1.0\n   */\n  idToken: string;\n  /**\n   * The stable Apple user identifier.\n   *\n   * On **Android** and **Web**, this is decoded from the JWT `sub` claim.\n   *\n   * @since 0.1.0\n   * @example \"001234.abcdef1234567890abcdef1234567890.1234\"\n   */\n  user: string;\n  /**\n   * The user's email address.\n   *\n   * On **iOS**, this is only provided on the first sign-in.\n   *\n   * @since 0.1.0\n   */\n  email: string | null;\n  /**\n   * The user's given name.\n   *\n   * On **iOS**, this is only provided on the first sign-in.\n   *\n   * @since 0.1.0\n   */\n  givenName: string | null;\n  /**\n   * The user's family name.\n   *\n   * On **iOS**, this is only provided on the first sign-in.\n   *\n   * @since 0.1.0\n   */\n  familyName: string | null;\n  /**\n   * The state value from the sign-in request.\n   *\n   * Only available on Android and Web.\n   *\n   * @since 0.1.0\n   */\n  state?: string;\n  /**\n   * The real user status.\n   *\n   * Only available on iOS.\n   *\n   * @since 0.1.0\n   */\n  realUserStatus?: RealUserStatus;\n}\n\n/**\n * @since 0.1.0\n */\nexport enum SignInScope {\n  /**\n   * Request the user's email address.\n   *\n   * @since 0.1.0\n   */\n  Email = 'EMAIL',\n  /**\n   * Request the user's full name.\n   *\n   * @since 0.1.0\n   */\n  FullName = 'FULL_NAME',\n}\n\n/**\n * @since 0.1.0\n */\nexport enum RealUserStatus {\n  /**\n   * The user appears to be a real person.\n   *\n   * @since 0.1.0\n   */\n  LikelyReal = 'LIKELY_REAL',\n  /**\n   * The system can't determine whether the user is a real person.\n   *\n   * @since 0.1.0\n   */\n  Unknown = 'UNKNOWN',\n  /**\n   * The real user status is not supported on this platform.\n   *\n   * @since 0.1.0\n   */\n  Unsupported = 'UNSUPPORTED',\n}\n\n/**\n * @since 0.1.0\n */\nexport enum ErrorCode {\n  /**\n   * The sign-in was canceled by the user.\n   *\n   * @since 0.1.0\n   */\n  SignInCanceled = 'SIGN_IN_CANCELED',\n}\n"]}

package/dist/esm/index.d.ts

@@ -0,0 +1,4 @@
+import type { AppleSignInPlugin } from './definitions';
+declare const AppleSignIn: AppleSignInPlugin;
+export * from './definitions';
+export { AppleSignIn };

package/dist/esm/index.js

@@ -0,0 +1,7 @@
+import { registerPlugin } from '@capacitor/core';
+const AppleSignIn = registerPlugin('AppleSignIn', {
+    web: () => import('./web').then(m => new m.AppleSignInWeb()),
+});
+export * from './definitions';
+export { AppleSignIn };
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAIjD,MAAM,WAAW,GAAG,cAAc,CAAoB,aAAa,EAAE;IACnE,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,cAAc,EAAE,CAAC;CAC7D,CAAC,CAAC;AAEH,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,WAAW,EAAE,CAAC","sourcesContent":["import { registerPlugin } from '@capacitor/core';\n\nimport type { AppleSignInPlugin } from './definitions';\n\nconst AppleSignIn = registerPlugin<AppleSignInPlugin>('AppleSignIn', {\n  web: () => import('./web').then(m => new m.AppleSignInWeb()),\n});\n\nexport * from './definitions';\nexport { AppleSignIn };\n"]}

package/dist/esm/web.d.ts

@@ -0,0 +1,10 @@
+import { WebPlugin } from '@capacitor/core';
+import type { AppleSignInPlugin, InitializeOptions, SignInOptions, SignInResult } from './definitions';
+export declare class AppleSignInWeb extends WebPlugin implements AppleSignInPlugin {
+    private clientId;
+    private scriptLoaded;
+    initialize(options: InitializeOptions): Promise<void>;
+    signIn(options?: SignInOptions): Promise<SignInResult>;
+    private decodeJwtPayload;
+    private loadScript;
+}