@pristine-ts/gcp-identity-platform 2.0.16

package/dist/types/guards/identity-platform-claim.guard.d.ts

@@ -0,0 +1,19 @@
+import { IdentityInterface, Request } from "@pristine-ts/common";
+import { GuardContextInterface, GuardInterface } from "@pristine-ts/security";
+/**
+ * A guard that checks the authenticated identity has every named custom claim set
+ * to a truthy value. Use with the `@guard` decorator:
+ *
+ * ```ts
+ * @guard(IdentityPlatformClaimGuard, "admin-routes", { claims: ["admin", "billing"] })
+ * ```
+ *
+ * Mirror of `AwsCognitoGroupGuard` — that one checks `cognito:groups`; this one
+ * checks arbitrary top-level claim keys set via `admin.auth().setCustomUserClaims(...)`.
+ */
+export declare class IdentityPlatformClaimGuard implements GuardInterface {
+    keyname: string;
+    guardContext?: GuardContextInterface;
+    setContext(context: any): Promise<void>;
+    isAuthorized(request: Request, identity?: IdentityInterface): Promise<boolean>;
+}

package/dist/types/interfaces/claim.interface.d.ts

@@ -0,0 +1,30 @@
+/**
+ * The standard claims found on a verified Firebase ID token. Custom claims (set via
+ * `admin.auth().setCustomUserClaims(...)`) appear as additional fields beyond these.
+ */
+export interface ClaimInterface {
+    /** Issuer — `https://securetoken.google.com/{projectId}`. */
+    iss: string;
+    /** Audience — the Firebase project id. */
+    aud: string;
+    /** The auth time, in seconds since epoch. */
+    auth_time: number;
+    /** Issued-at time, in seconds since epoch. */
+    iat: number;
+    /** Expiry, in seconds since epoch. */
+    exp: number;
+    /** The Firebase user id. */
+    sub: string;
+    user_id?: string;
+    email?: string;
+    email_verified?: boolean;
+    /** Firebase-specific claims (sign_in_provider, identities, etc.). */
+    firebase?: {
+        identities?: {
+            [key: string]: any;
+        };
+        sign_in_provider?: string;
+        [key: string]: any;
+    };
+    [customClaim: string]: any;
+}

package/dist/types/interfaces/interfaces.d.ts

@@ -0,0 +1,2 @@
+export * from "./claim.interface";
+export * from "./token-header.interface";

package/dist/types/interfaces/token-header.interface.d.ts

@@ -0,0 +1,9 @@
+/**
+ * The JWT header decoded from a Firebase ID token. The `kid` selects which of the
+ * fetched X.509 certs verifies the signature.
+ */
+export interface TokenHeaderInterface {
+    alg: string;
+    typ?: string;
+    kid: string;
+}

package/package.json

@@ -0,0 +1,72 @@
+{
+  "name": "@pristine-ts/gcp-identity-platform",
+  "version": "2.0.16",
+  "description": "",
+  "module": "dist/lib/esm/gcp-identity-platform.module.js",
+  "main": "dist/lib/cjs/gcp-identity-platform.module.js",
+  "types": "dist/types/gcp-identity-platform.module.d.ts",
+  "scripts": {
+    "build": "tsc -p tsconfig.json && tsc -p tsconfig.cjs.json",
+    "prepublish": "npm run build",
+    "test": "jest",
+    "test:cov": "jest --coverage"
+  },
+  "files": [
+    "dist"
+  ],
+  "author": "",
+  "license": "ISC",
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@types/jsonwebtoken": "^9.0.4"
+  },
+  "dependencies": {
+    "@pristine-ts/common": "^2.0.16",
+    "@pristine-ts/http": "^2.0.16",
+    "@pristine-ts/networking": "^2.0.16",
+    "@pristine-ts/security": "^2.0.16",
+    "jsonwebtoken": "^9.0.2"
+  },
+  "jest": {
+    "transform": {
+      ".(ts|tsx)": "ts-jest"
+    },
+    "globals": {
+      "ts-jest": {
+        "tsconfig": {
+          "strictNullChecks": false
+        }
+      }
+    },
+    "testEnvironment": "node",
+    "testRegex": "(/__tests__/.*|\\.(test|spec))\\.(ts|tsx|js)$",
+    "moduleFileExtensions": [
+      "ts",
+      "tsx",
+      "js"
+    ],
+    "coveragePathIgnorePatterns": [
+      "/node_modules/",
+      "/test/"
+    ],
+    "coverageThreshold": {
+      "global": {
+        "branches": 90,
+        "functions": 95,
+        "lines": 95,
+        "statements": 95
+      }
+    },
+    "collectCoverageFrom": [
+      "src/*.{js,ts}"
+    ]
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/magieno/pristine-ts.git",
+    "directory": "packages/gcp-identity-platform"
+  },
+  "gitHead": "a55d7d59862672a8cbbca4088fed090779b37705"
+}

package/readme.md

@@ -0,0 +1,5 @@
+# @pristine-ts/gcp-identity-platform
+
+Authenticator and guard for Firebase Auth / GCP Identity Platform. Mirror of
+`@pristine-ts/aws-cognito`: verifies Firebase ID tokens against Google's public
+X.509 certificate endpoint and gates routes on custom claims.