@phantom/sdk-types 0.1.1 → 0.1.3

package/README.md

@@ -20,29 +20,24 @@ Interface for creating X-Phantom-Stamp header values for API authentication.
 
 ```typescript
 interface Stamper {
-  stamp(params: {
-    data: Buffer;
-    type?: 'PKI';
-    idToken?: never;
-    salt?: never;
-  }): Promise<string>;
-  stamp(params: {
-    data: Buffer;
-    type: 'OIDC';
-    idToken: string;
-    salt: string;
-  }): Promise<string>;
+  stamp(params: { data: Buffer }): Promise<string>;
+  type?: "PKI" | "OIDC"; // Optional, defaults to "PKI"
+  idToken?: string; // Required for OIDC type, optional for PKI
+  salt?: string; // Required for OIDC type, optional for PKI
+  algorithm?: Algorithm; // Optional, defaults to Algorithm.ed25519
 }
 ```
 
 **Usage:**
+
 ```typescript
-import type { Stamper } from '@phantom/sdk-types';
+import type { Stamper } from "@phantom/sdk-types";
 
 class MyStamper implements Stamper {
-  async stamp(params: { data: Buffer; type?: 'PKI' }): Promise<string> {
+  type = "PKI"; // or "OIDC"
+  async stamp(params: { data: Buffer }): Promise<string> {
     // Implementation for PKI stamping
-    return 'stamp-value';
+    return "stamp-value";
   }
 }
 ```
@@ -72,23 +67,24 @@ interface StamperWithKeyManagement extends Stamper {
 ```
 
 **Usage:**
+
 ```typescript
-import type { StamperWithKeyManagement } from '@phantom/sdk-types';
+import type { StamperWithKeyManagement } from "@phantom/sdk-types";
 
 class MyKeyManagedStamper implements StamperWithKeyManagement {
   async init(): Promise<StamperKeyInfo> {
     // Initialize and return key info
-    return { keyId: 'key-id', publicKey: 'public-key' };
+    return { keyId: "key-id", publicKey: "public-key" };
   }
-  
+
   getKeyInfo(): StamperKeyInfo | null {
     // Return current key info or null if not initialized
-    return { keyId: 'key-id', publicKey: 'public-key' };
+    return { keyId: "key-id", publicKey: "public-key" };
   }
-  
-  async stamp(params: { data: Buffer; type?: 'PKI' }): Promise<string> {
+
+  async stamp(params: { data: Buffer }): Promise<string> {
     // Implementation
-    return 'stamp-value';
+    return "stamp-value";
   }
 }
 ```
@@ -105,4 +101,4 @@ This package is used by:
 
 ## License
 
-MIT
+MIT

package/dist/index.d.ts

@@ -5,17 +5,20 @@ export { Algorithm } from '@phantom/openapi-wallet-service';
 interface Stamper {
     stamp(params: {
         data: Buffer;
-        type?: 'PKI';
+        type?: "PKI";
         idToken?: never;
         salt?: never;
     }): Promise<string>;
     stamp(params: {
         data: Buffer;
-        type: 'OIDC';
+        type: "OIDC";
         idToken: string;
         salt: string;
     }): Promise<string>;
     algorithm: Algorithm;
+    type: "PKI" | "OIDC";
+    idToken?: string;
+    salt?: string;
 }
 interface StamperKeyInfo {
     keyId: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@phantom/sdk-types",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Common types for Phantom SDK packages",
   "main": "dist/index.js",
   "module": "dist/index.mjs",