cloudfire-auth 0.2.0 → 0.3.0

package/dist/types/firebase-admin/user-import.d.ts

@@ -0,0 +1,226 @@
+/*! firebase-admin v13.4.0 */
+/*!
+ * Copyright 2018 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * You can find the code taken from the Firebase Admin SDK in this location of
+ * the firebase-admin 13.4.0 npm package:
+ *
+ * firebase-admin/lib/auth/user-import-builder.d.ts
+ */
+/**
+ * Alterations to Firebase Admin SDK Code
+ *
+ * The Buffer types have been replaced with Uint8Array types. The replacements
+ * have been made to:
+ *
+ * - UserImportOptions.hash.key
+ * - UserImportOptions.hash.saltSeparator
+ * - UserImportRecord.passwordHash
+ * - UserImportRecord.passwordSalt
+ */
+import type { FirebaseArrayIndexError } from "./index.js";
+import type { MultiFactorUpdateSettings } from "./auth-config.js";
+export type HashAlgorithmType = "SCRYPT" | "STANDARD_SCRYPT" | "HMAC_SHA512" | "HMAC_SHA256" | "HMAC_SHA1" | "HMAC_MD5" | "MD5" | "PBKDF_SHA1" | "BCRYPT" | "PBKDF2_SHA256" | "SHA512" | "SHA256" | "SHA1";
+/**
+ * Interface representing the user import options needed for
+ * {@link BaseAuth.importUsers} method. This is used to
+ * provide the password hashing algorithm information.
+ */
+export interface UserImportOptions {
+    /**
+     * The password hashing information.
+     */
+    hash: {
+        /**
+         * The password hashing algorithm identifier. The following algorithm
+         * identifiers are supported:
+         * `SCRYPT`, `STANDARD_SCRYPT`, `HMAC_SHA512`, `HMAC_SHA256`, `HMAC_SHA1`,
+         * `HMAC_MD5`, `MD5`, `PBKDF_SHA1`, `BCRYPT`, `PBKDF2_SHA256`, `SHA512`,
+         * `SHA256` and `SHA1`.
+         */
+        algorithm: HashAlgorithmType;
+        /**
+         * The signing key used in the hash algorithm in buffer bytes.
+         * Required by hashing algorithms `SCRYPT`, `HMAC_SHA512`, `HMAC_SHA256`,
+         * `HAMC_SHA1` and `HMAC_MD5`.
+         */
+        key?: Uint8Array;
+        /**
+         * The salt separator in buffer bytes which is appended to salt when
+         * verifying a password. This is only used by the `SCRYPT` algorithm.
+         */
+        saltSeparator?: Uint8Array;
+        /**
+         * The number of rounds for hashing calculation.
+         * Required for `SCRYPT`, `MD5`, `SHA512`, `SHA256`, `SHA1`, `PBKDF_SHA1` and
+         * `PBKDF2_SHA256`.
+         */
+        rounds?: number;
+        /**
+         * The memory cost required for `SCRYPT` algorithm, or the CPU/memory cost.
+         * Required for `STANDARD_SCRYPT` algorithm.
+         */
+        memoryCost?: number;
+        /**
+         * The parallelization of the hashing algorithm. Required for the
+         * `STANDARD_SCRYPT` algorithm.
+         */
+        parallelization?: number;
+        /**
+         * The block size (normally 8) of the hashing algorithm. Required for the
+         * `STANDARD_SCRYPT` algorithm.
+         */
+        blockSize?: number;
+        /**
+         * The derived key length of the hashing algorithm. Required for the
+         * `STANDARD_SCRYPT` algorithm.
+         */
+        derivedKeyLength?: number;
+    };
+}
+/**
+ * Interface representing the user metadata.
+ */
+export interface UserMetadataRequest {
+    /**
+     * The date the user last signed in, formatted as a UTC string.
+     */
+    lastSignInTime?: string;
+    /**
+     * The date the user was created, formatted as a UTC string.
+     */
+    creationTime?: string;
+}
+/**
+ * Interface representing a user identity provider.
+ */
+export interface UserProviderRequest {
+    /**
+     * The user identifier for the linked provider.
+     */
+    uid: string;
+    /**
+     * The display name for the linked provider.
+     */
+    displayName?: string;
+    /**
+     * The email for the linked provider.
+     */
+    email?: string;
+    /**
+     * The phone number for the linked provider.
+     */
+    phoneNumber?: string;
+    /**
+     * The photo URL for the linked provider.
+     */
+    photoURL?: string;
+    /**
+     * The linked provider ID (for example, "google.com" for the Google provider).
+     */
+    providerId: string;
+}
+/**
+ * Interface representing a user to import to Firebase Auth via the
+ * {@link BaseAuth.importUsers} method.
+ */
+export interface UserImportRecord {
+    /**
+     * The user's `uid`.
+     */
+    uid: string;
+    /**
+     * The user's primary email, if set.
+     */
+    email?: string;
+    /**
+     * Whether or not the user's primary email is verified.
+     */
+    emailVerified?: boolean;
+    /**
+     * The user's display name.
+     */
+    displayName?: string;
+    /**
+     * The user's primary phone number, if set.
+     */
+    phoneNumber?: string;
+    /**
+     * The user's photo URL.
+     */
+    photoURL?: string;
+    /**
+     * Whether or not the user is disabled: `true` for disabled; `false` for
+     * enabled.
+     */
+    disabled?: boolean;
+    /**
+     * Additional metadata about the user.
+     */
+    metadata?: UserMetadataRequest;
+    /**
+     * An array of providers (for example, Google, Facebook) linked to the user.
+     */
+    providerData?: UserProviderRequest[];
+    /**
+     * The user's custom claims object if available, typically used to define
+     * user roles and propagated to an authenticated user's ID token.
+     */
+    customClaims?: {
+        [key: string]: any;
+    };
+    /**
+     * The buffer of bytes representing the user's hashed password.
+     * When a user is to be imported with a password hash,
+     * {@link UserImportOptions} are required to be
+     * specified to identify the hashing algorithm used to generate this hash.
+     */
+    passwordHash?: Uint8Array;
+    /**
+     * The buffer of bytes representing the user's password salt.
+     */
+    passwordSalt?: Uint8Array;
+    /**
+     * The identifier of the tenant where user is to be imported to.
+     * When not provided in an `admin.auth.Auth` context, the user is uploaded to
+     * the default parent project.
+     * When not provided in an `admin.auth.TenantAwareAuth` context, the user is uploaded
+     * to the tenant corresponding to that `TenantAwareAuth` instance's tenant ID.
+     */
+    tenantId?: string;
+    /**
+     * The user's multi-factor related properties.
+     */
+    multiFactor?: MultiFactorUpdateSettings;
+}
+/**
+ * Interface representing the result of the {@link BaseAuth.importUsers} API.
+ */
+export interface UserImportResult {
+    /**
+     * The number of user records that failed to import to Firebase Auth.
+     */
+    failureCount: number;
+    /**
+     * The number of user records that successfully imported to Firebase Auth.
+     */
+    successCount: number;
+    /**
+     * An array of errors corresponding to the provided users to import. The
+     * length of this array is equal to [`failureCount`].
+     */
+    errors: FirebaseArrayIndexError[];
+}

package/dist/types/firebase-admin/user-import.js

@@ -0,0 +1,17 @@
+/*! firebase-admin v13.4.0 */
+/*!
+ * Copyright 2018 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export {};

package/dist/types/firebase-admin/user-record.d.ts

@@ -15,6 +15,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+/**
+ * You can find the code taken from the Firebase Admin SDK in this location of
+ * the firebase-admin 13.4.0 npm package:
+ *
+ * firebase-admin/lib/auth/user-record.d.ts
+ */
 export interface MultiFactorInfoResponse {
     mfaEnrollmentId: string;
     displayName?: string;

package/dist/types/firebase-admin/user-record.js

@@ -1 +1,18 @@
+/*! firebase-admin v13.4.0 */
+/*!
+ * @license
+ * Copyright 2017 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
 export {};

package/dist/types.d.ts

@@ -1,6 +1,6 @@
-import type { DecodedIdToken, UserRecord, UserIdentifier, GetUsersResult, ListUsersResult, CreateRequest, UpdateRequest, DeleteUsersResult } from "./types/firebase-admin/index.js";
+import type { DecodedIdToken, UserRecord, UserIdentifier, GetUsersResult, ListUsersResult, CreateRequest, UpdateRequest, DeleteUsersResult, SessionCookieOptions, AuthProviderConfig, UpdateAuthProviderRequest, AuthProviderConfigFilter, ListProviderConfigResults, ActionCodeSettings, UserImportRecord, UserImportOptions, UserImportResult, HashAlgorithmType, UserMetadataRequest, UserProviderRequest } from "./types/firebase-admin/index.js";
 import type { ServiceAccountKey } from "./types/service-account-key.js";
 import type { SetAccountInfoResponse } from "./types/google-auth.js";
-export type { DecodedIdToken, UserRecord, UserIdentifier, GetUsersResult, ListUsersResult, CreateRequest, UpdateRequest, DeleteUsersResult, };
+export type { DecodedIdToken, UserRecord, UserIdentifier, GetUsersResult, ListUsersResult, CreateRequest, UpdateRequest, DeleteUsersResult, SessionCookieOptions, AuthProviderConfig, UpdateAuthProviderRequest, AuthProviderConfigFilter, ListProviderConfigResults, ActionCodeSettings, UserImportRecord, UserImportOptions, UserImportResult, HashAlgorithmType, UserMetadataRequest, UserProviderRequest, };
 export type { ServiceAccountKey };
 export type { SetAccountInfoResponse };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cloudfire-auth",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "author": "Connor Skelland",
   "license": "MIT",
   "engines": {
@@ -31,7 +31,7 @@
     "build": "tsc",
     "clean": "tsx scripts/publishing/remove-dist.ts",
     "build:watch": "tsc --watch",
-    "prepublishOnly": "npm run clean && npm run build"
+    "prepublishOnly": "npm run test && npm run clean && npm run build"
   },
   "devDependencies": {
     "@cloudflare/workers-types": "^4.20250816.0",