@gardenfi/utils 2.0.3 → 2.0.5

package/dist/index99.js

@@ -0,0 +1,130 @@
+import { RecursiveReadLimitExceededError as e, PositionOutOfBoundsError as n, NegativeOffsetError as o } from "./index96.js";
+const h = {
+  bytes: new Uint8Array(),
+  dataView: new DataView(new ArrayBuffer(0)),
+  position: 0,
+  positionReadCount: /* @__PURE__ */ new Map(),
+  recursiveReadCount: 0,
+  recursiveReadLimit: Number.POSITIVE_INFINITY,
+  assertReadLimit() {
+    if (this.recursiveReadCount >= this.recursiveReadLimit)
+      throw new e({
+        count: this.recursiveReadCount + 1,
+        limit: this.recursiveReadLimit
+      });
+  },
+  assertPosition(t) {
+    if (t < 0 || t > this.bytes.length - 1)
+      throw new n({
+        length: this.bytes.length,
+        position: t
+      });
+  },
+  decrementPosition(t) {
+    if (t < 0)
+      throw new o({ offset: t });
+    const i = this.position - t;
+    this.assertPosition(i), this.position = i;
+  },
+  getReadCount(t) {
+    return this.positionReadCount.get(t || this.position) || 0;
+  },
+  incrementPosition(t) {
+    if (t < 0)
+      throw new o({ offset: t });
+    const i = this.position + t;
+    this.assertPosition(i), this.position = i;
+  },
+  inspectByte(t) {
+    const i = t ?? this.position;
+    return this.assertPosition(i), this.bytes[i];
+  },
+  inspectBytes(t, i) {
+    const s = i ?? this.position;
+    return this.assertPosition(s + t - 1), this.bytes.subarray(s, s + t);
+  },
+  inspectUint8(t) {
+    const i = t ?? this.position;
+    return this.assertPosition(i), this.bytes[i];
+  },
+  inspectUint16(t) {
+    const i = t ?? this.position;
+    return this.assertPosition(i + 1), this.dataView.getUint16(i);
+  },
+  inspectUint24(t) {
+    const i = t ?? this.position;
+    return this.assertPosition(i + 2), (this.dataView.getUint16(i) << 8) + this.dataView.getUint8(i + 2);
+  },
+  inspectUint32(t) {
+    const i = t ?? this.position;
+    return this.assertPosition(i + 3), this.dataView.getUint32(i);
+  },
+  pushByte(t) {
+    this.assertPosition(this.position), this.bytes[this.position] = t, this.position++;
+  },
+  pushBytes(t) {
+    this.assertPosition(this.position + t.length - 1), this.bytes.set(t, this.position), this.position += t.length;
+  },
+  pushUint8(t) {
+    this.assertPosition(this.position), this.bytes[this.position] = t, this.position++;
+  },
+  pushUint16(t) {
+    this.assertPosition(this.position + 1), this.dataView.setUint16(this.position, t), this.position += 2;
+  },
+  pushUint24(t) {
+    this.assertPosition(this.position + 2), this.dataView.setUint16(this.position, t >> 8), this.dataView.setUint8(this.position + 2, t & 255), this.position += 3;
+  },
+  pushUint32(t) {
+    this.assertPosition(this.position + 3), this.dataView.setUint32(this.position, t), this.position += 4;
+  },
+  readByte() {
+    this.assertReadLimit(), this._touch();
+    const t = this.inspectByte();
+    return this.position++, t;
+  },
+  readBytes(t, i) {
+    this.assertReadLimit(), this._touch();
+    const s = this.inspectBytes(t);
+    return this.position += i ?? t, s;
+  },
+  readUint8() {
+    this.assertReadLimit(), this._touch();
+    const t = this.inspectUint8();
+    return this.position += 1, t;
+  },
+  readUint16() {
+    this.assertReadLimit(), this._touch();
+    const t = this.inspectUint16();
+    return this.position += 2, t;
+  },
+  readUint24() {
+    this.assertReadLimit(), this._touch();
+    const t = this.inspectUint24();
+    return this.position += 3, t;
+  },
+  readUint32() {
+    this.assertReadLimit(), this._touch();
+    const t = this.inspectUint32();
+    return this.position += 4, t;
+  },
+  get remaining() {
+    return this.bytes.length - this.position;
+  },
+  setPosition(t) {
+    const i = this.position;
+    return this.assertPosition(t), this.position = t, () => this.position = i;
+  },
+  _touch() {
+    if (this.recursiveReadLimit === Number.POSITIVE_INFINITY)
+      return;
+    const t = this.getReadCount();
+    this.positionReadCount.set(this.position, t + 1), t > 0 && this.recursiveReadCount++;
+  }
+};
+function a(t, { recursiveReadLimit: i = 8192 } = {}) {
+  const s = Object.create(h);
+  return s.bytes = t, s.dataView = new DataView(t.buffer, t.byteOffset, t.byteLength), s.positionReadCount = /* @__PURE__ */ new Map(), s.recursiveReadLimit = i, s;
+}
+export {
+  a as createCursor
+};

package/dist/src/index.d.ts

@@ -6,3 +6,4 @@ export * from './lib/utils';
 export * from './lib/approve';
 export * from './lib/blockNumber';
 export * from './lib/eventBroker';
+export * from './lib/result';

package/dist/src/lib/auth/apikey/apikey.d.ts

@@ -0,0 +1,12 @@
+import { Result, AsyncResult } from '@catalogfi/utils';
+import { AuthHeader, IAuth } from '../auth.types';
+
+export declare class ApiKey implements IAuth {
+    private readonly apiKey;
+    constructor(apiKey: string);
+    getToken(): AsyncResult<string, string>;
+    verifyToken(): Result<boolean, string>;
+    private decodeBase64UrlSafe;
+    private extractData;
+    getAuthHeaders(): AsyncResult<AuthHeader, string>;
+}

package/dist/src/lib/auth/auth.types.d.ts

@@ -6,15 +6,28 @@ export type SiweOpts = {
     store?: IStore;
     signingStatement?: string;
 };
-export type AuthHeader = {
-    [key: string]: string;
-};
-export interface ISiwe {
-    getToken(): AsyncResult<string, string>;
-    verifyToken(token: string, account: string): Result<boolean, string>;
+export declare enum AuthHeaderEnum {
+    Authorization = "Authorization",
+    ApiKey = "api-key"
 }
+export type AuthHeader = Record<AuthHeaderEnum.ApiKey, string> | Record<AuthHeaderEnum.Authorization, string>;
 export interface IAuth {
-    siwe?: ISiwe;
-    apiKey?: string;
+    /**
+     * Get a token from store if available or fetch from the wallet
+     * @returns verified token
+     */
+    getToken(): AsyncResult<string, string>;
+    /**
+     * Verify the token expiry and account
+     * @param token The token to verify
+     * @param account The account to verify the token against
+     */
+    verifyToken(token: string, account: string): Result<boolean, string>;
+    /**
+     * Retrieves the authentication token and formats it into the appropriate header object.
+     * Example: For API keys, returns { 'api-key': apiKey }
+     * Example: For SIWE, returns { Authorization: 'Bearer token' }
+     * @returns An AsyncResult containing the formatted auth header object or an error message
+     */
     getAuthHeaders(): AsyncResult<AuthHeader, string>;
 }

package/dist/src/lib/auth/index.d.ts

@@ -1,2 +1,6 @@
 export * from './auth.types';
-export * from './siwe';
+export * from './siwe/siwe';
+export * from './apikey/apikey';
+export * from './passkey/passkey';
+export * from './passkey/passkey.types';
+export * from './passkey/passkeyLogin';

package/dist/src/lib/auth/passkey/passkey.d.ts

@@ -0,0 +1,10 @@
+import { Result, AsyncResult } from '@catalogfi/utils';
+import { AuthHeader, IAuth } from '../auth.types';
+
+export declare class Passkey implements IAuth {
+    private token;
+    constructor(token: string);
+    getToken(): AsyncResult<string, string>;
+    verifyToken(token: string): Result<boolean, string>;
+    getAuthHeaders(): AsyncResult<AuthHeader, string>;
+}

package/dist/src/lib/auth/passkey/passkey.types.d.ts

@@ -0,0 +1,17 @@
+import { PublicKeyCredentialCreationOptionsJSON } from '@simplewebauthn/browser';
+
+export type PasskeyToken = {
+    token: string;
+    gardenUserName: string;
+};
+export type RegisterChallenge = {
+    challenge: {
+        publicKey: PublicKeyCredentialCreationOptionsJSON;
+    };
+};
+export type ConditionalLoginChallenge = {
+    challenge: {
+        publicKey: PublicKeyCredentialCreationOptionsJSON;
+    };
+    login_id: string;
+};

package/dist/src/lib/auth/passkey/passkeyLogin.d.ts

@@ -0,0 +1,37 @@
+import { AsyncResult, Result } from '@catalogfi/utils';
+import { Url } from 'src/lib/url';
+import { PasskeyToken } from './passkey.types';
+import { IStore } from 'src/lib/store';
+
+export declare class PasskeyLogin {
+    private url;
+    private store;
+    private storeKey;
+    private token;
+    private userName;
+    constructor(url: Url, store: IStore);
+    getPasskeyFromStore(): Result<PasskeyToken, string>;
+    /**
+     * Validates the username according to predefined rules.
+     * @param username The username to validate.
+     * @returns Result<string, string> - Ok if valid, Err with message if invalid.
+     */
+    private validateUsername;
+    /**
+     * Handles user registration using WebAuthn passkeys.
+     * @param username The username to register.
+     * @returns AsyncResult<PasskeyToken, string> - Ok if successful, Err if failed.
+     */
+    register(username: string): AsyncResult<PasskeyToken, string>;
+    /**
+     * Handles user login using WebAuthn passkeys.
+     * @param username The username to log in.
+     * @returns AsyncResult<PasskeyToken, string> - Ok if successful, Err if failed.
+     */
+    login(username: string): AsyncResult<PasskeyToken, string>;
+    /**
+     * Handles conditional login (without username) for existing users.
+     * @returns AsyncResult<PasskeyToken, string> - Ok if successful, Err if failed.
+     */
+    conditionalLogin(): AsyncResult<PasskeyToken, string>;
+}

package/dist/src/lib/auth/{siwe.d.ts → siwe/siwe.d.ts}

@@ -1,9 +1,9 @@
-import { AuthHeader, IAuth, ISiwe, SiweOpts } from './auth.types';
+import { AuthHeader, IAuth, SiweOpts } from '../auth.types';
 import { AsyncResult, Result } from '@catalogfi/utils';
-import { Url } from '../url';
+import { Url } from '../../url';
 import { WalletClient } from 'viem';
 
-export declare class Siwe implements ISiwe {
+export declare class Siwe implements IAuth {
     private readonly API;
     private readonly url;
     private store;
@@ -11,20 +11,9 @@ export declare class Siwe implements ISiwe {
     private readonly signingStatement;
     private readonly domain;
     constructor(url: Url, walletClient: WalletClient, opts?: SiweOpts);
+    static fromDigestKey(url: Url, digestKey: string): Siwe;
     verifyToken(token: string, account: string): Result<boolean, string>;
     getToken(): AsyncResult<string, string>;
     private signStatement;
-}
-export declare const parseJwt: (token: string) => {
-    user_id: string;
-    exp: number;
-} | undefined;
-export declare class Auth implements IAuth {
-    siwe?: ISiwe;
-    apiKey?: string;
-    constructor(opts: {
-        siwe?: ISiwe;
-        apiKey?: string;
-    });
     getAuthHeaders(): AsyncResult<AuthHeader, string>;
 }

package/dist/src/lib/result.d.ts

@@ -0,0 +1,16 @@
+export declare class Result<T, E> {
+    #private;
+    constructor(ok: boolean, val: T, error?: E | undefined);
+    get ok(): boolean;
+    get error(): E | undefined;
+    get val(): T;
+}
+export type AsyncResult<T, E> = Promise<Result<T, E>>;
+export declare const Ok: <T>(val: T) => Result<T, never>;
+export declare const Void: undefined;
+/**
+ * Constructs an error result with the given error value.
+ *
+ * If the error value is a string, it can be followed by any number of optional messages which will be concatenated
+ */
+export declare const Err: <E>(error: E, ...optionalMsg: (E extends string ? any : never)[]) => Result<never, E>;

package/dist/src/lib/utils.d.ts

@@ -6,6 +6,7 @@ export declare const with0x: (str: string) => `0x${string}`;
  */
 export declare const Authorization: (authToken: string) => string;
 export declare const sleep: (ms: number) => Promise<unknown>;
+export declare const parseJwt: <T>(token: string) => T | undefined;
 export declare enum Network {
     MAINNET = "mainnet",
     TESTNET = "testnet"
@@ -15,3 +16,5 @@ export declare enum Environment {
     TESTNET = "testnet",
     LOCALNET = "localnet"
 }
+export declare const add0x: (str: string) => `0x${string}`;
+export declare function hexToU32Array(hexString: string, endian?: 'big' | 'little'): number[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gardenfi/utils",
-  "version": "2.0.3",
+  "version": "2.0.5",
   "type": "module",
   "scripts": {
     "build": "vite build",
@@ -35,6 +35,7 @@
   },
   "sideEffects": false,
   "dependencies": {
+    "@simplewebauthn/browser": "^13.1.0",
     "jwt-decode": "^4.0.0",
     "viem": "^2.21.23"
   }