@phantom/sdk-types 0.1.1

package/README.md

@@ -0,0 +1,108 @@
+# @phantom/sdk-types
+
+Common TypeScript types and interfaces used across the Phantom Wallet SDK packages.
+
+## Overview
+
+This package provides centralized type definitions that are shared across multiple Phantom SDK packages, ensuring consistency and reducing duplication.
+
+## Installation
+
+```bash
+npm install @phantom/sdk-types
+```
+
+## Types
+
+### `Stamper`
+
+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>;
+}
+```
+
+**Usage:**
+```typescript
+import type { Stamper } from '@phantom/sdk-types';
+
+class MyStamper implements Stamper {
+  async stamp(params: { data: Buffer; type?: 'PKI' }): Promise<string> {
+    // Implementation for PKI stamping
+    return 'stamp-value';
+  }
+}
+```
+
+### `StamperKeyInfo`
+
+Key information structure returned by stampers.
+
+```typescript
+interface StamperKeyInfo {
+  keyId: string;
+  publicKey: string;
+}
+```
+
+### `StamperWithKeyManagement`
+
+Extended stamper interface for stampers that manage their own cryptographic keys.
+
+```typescript
+interface StamperWithKeyManagement extends Stamper {
+  init(): Promise<StamperKeyInfo>;
+  getKeyInfo(): StamperKeyInfo | null;
+  resetKeyPair?(): Promise<StamperKeyInfo>;
+  clear?(): Promise<void>;
+}
+```
+
+**Usage:**
+```typescript
+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' };
+  }
+  
+  getKeyInfo(): StamperKeyInfo | null {
+    // Return current key info or null if not initialized
+    return { keyId: 'key-id', publicKey: 'public-key' };
+  }
+  
+  async stamp(params: { data: Buffer; type?: 'PKI' }): Promise<string> {
+    // Implementation
+    return 'stamp-value';
+  }
+}
+```
+
+## Package Usage
+
+This package is used by:
+
+- `@phantom/client` - For the base Stamper interface
+- `@phantom/embedded-provider-core` - For StamperWithKeyManagement interface
+- `@phantom/api-key-stamper` - Implements Stamper interface
+- `@phantom/indexed-db-stamper` - Implements StamperWithKeyManagement interface
+- `@phantom/react-native-sdk` - For embedded stampers
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,31 @@
+import { Buffer } from 'buffer';
+import { Algorithm } from '@phantom/openapi-wallet-service';
+export { Algorithm } from '@phantom/openapi-wallet-service';
+
+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>;
+    algorithm: Algorithm;
+}
+interface StamperKeyInfo {
+    keyId: string;
+    publicKey: string;
+}
+interface StamperWithKeyManagement extends Stamper {
+    init(): Promise<StamperKeyInfo>;
+    getKeyInfo(): StamperKeyInfo | null;
+    resetKeyPair?(): Promise<StamperKeyInfo>;
+    clear?(): Promise<void>;
+}
+
+export { Stamper, StamperKeyInfo, StamperWithKeyManagement };

package/dist/index.js

@@ -0,0 +1,30 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  Algorithm: () => import_openapi_wallet_service.Algorithm
+});
+module.exports = __toCommonJS(src_exports);
+var import_openapi_wallet_service = require("@phantom/openapi-wallet-service");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  Algorithm
+});

package/dist/index.mjs

@@ -0,0 +1,5 @@
+// src/index.ts
+import { Algorithm } from "@phantom/openapi-wallet-service";
+export {
+  Algorithm
+};

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@phantom/sdk-types",
+  "version": "0.1.1",
+  "description": "Common types for Phantom SDK packages",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "scripts": {
+    "?pack-release": "When https://github.com/changesets/changesets/issues/432 has a solution we can remove this trick",
+    "pack-release": "rimraf ./_release && yarn pack && mkdir ./_release && tar zxvf ./package.tgz --directory ./_release && rm ./package.tgz",
+    "build": "rimraf ./dist && tsup src/index.ts --format cjs,esm --dts --external buffer",
+    "dev": "tsc --watch",
+    "clean": "rm -rf dist",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "lint": "tsc --noEmit && eslint --cache . --ext .ts,.tsx",
+    "check-types": "tsc --noEmit",
+    "prettier": "prettier --write \"src/**/*.{ts,tsx}\""
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.11.0",
+    "eslint": "8.53.0",
+    "jest": "^29.7.0",
+    "prettier": "^3.5.2",
+    "rimraf": "^6.0.1",
+    "ts-jest": "^29.1.2",
+    "tsup": "^6.7.0",
+    "typescript": "^5.0.4"
+  },
+  "dependencies": {
+    "@phantom/openapi-wallet-service": "^0.1.7",
+    "buffer": "^6.0.3"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "directory": "_release/package"
+  }
+}