From de8b8c7944bb600cd996907bd8bac0faffb0e3d5 Mon Sep 17 00:00:00 2001 From: Brian Cleary Date: Fri, 4 Apr 2025 13:13:58 -0400 Subject: [PATCH 1/4] feat: add @turnkey/sdk-types package --- packages/sdk-types/README.md | 0 packages/sdk-types/rollup.config.mjs | 3 +++ packages/sdk-types/tsconfig.json | 13 +++++++++++++ packages/sdk-types/turbo.json | 8 ++++++++ 4 files changed, 24 insertions(+) create mode 100644 packages/sdk-types/README.md create mode 100644 packages/sdk-types/rollup.config.mjs create mode 100644 packages/sdk-types/tsconfig.json create mode 100644 packages/sdk-types/turbo.json diff --git a/packages/sdk-types/README.md b/packages/sdk-types/README.md new file mode 100644 index 000000000..e69de29bb diff --git a/packages/sdk-types/rollup.config.mjs b/packages/sdk-types/rollup.config.mjs new file mode 100644 index 000000000..23fa423e6 --- /dev/null +++ b/packages/sdk-types/rollup.config.mjs @@ -0,0 +1,3 @@ +import rollup from "../../rollup.config.base.mjs"; + +export default (options) => rollup(); diff --git a/packages/sdk-types/tsconfig.json b/packages/sdk-types/tsconfig.json new file mode 100644 index 000000000..fb6b50d4e --- /dev/null +++ b/packages/sdk-types/tsconfig.json @@ -0,0 +1,13 @@ +{ + "extends": "../../tsconfig.base.json", + "compilerOptions": { + "outDir": "./dist", + "rootDir": "./src", + "strict": true, + "esModuleInterop": true, + "skipLibCheck": true, + "forceConsistentCasingInFileNames": true + }, + "include": ["src/**/*"], + "exclude": ["node_modules", "dist"] +} diff --git a/packages/sdk-types/turbo.json b/packages/sdk-types/turbo.json new file mode 100644 index 000000000..35be9c68f --- /dev/null +++ b/packages/sdk-types/turbo.json @@ -0,0 +1,8 @@ +{ + "extends": ["//"], + "tasks": { + "build": { + "outputs": ["dist/**"] + } + } +} From 1389b271eb72931a871dcc1942045b0b73e96843 Mon Sep 17 00:00:00 2001 From: Brian Cleary Date: Fri, 4 Apr 2025 14:30:16 -0400 Subject: [PATCH 2/4] chore: add typecheck and typedoc --- packages/sdk-types/tsconfig.typecheck.json | 8 ++++ packages/sdk-types/typedoc.json | 16 ++++++++ pnpm-lock.yaml | 45 +++++++++++++++++++++- 3 files changed, 68 insertions(+), 1 deletion(-) create mode 100644 packages/sdk-types/tsconfig.typecheck.json create mode 100644 packages/sdk-types/typedoc.json diff --git a/packages/sdk-types/tsconfig.typecheck.json b/packages/sdk-types/tsconfig.typecheck.json new file mode 100644 index 000000000..4632cb856 --- /dev/null +++ b/packages/sdk-types/tsconfig.typecheck.json @@ -0,0 +1,8 @@ +{ + "extends": "../../tsconfig.base.json", + "compilerOptions": { + "noEmit": true, + "tsBuildInfoFile": "./.cache/.typecheck.tsbuildinfo" + }, + "include": ["src/**/*.ts"] +} diff --git a/packages/sdk-types/typedoc.json b/packages/sdk-types/typedoc.json new file mode 100644 index 000000000..15e3cb393 --- /dev/null +++ b/packages/sdk-types/typedoc.json @@ -0,0 +1,16 @@ +{ + "entryPoints": ["src/index.ts"], + "excludeInternal": true, + "includeVersion": true, + "fileExtension": ".mdx", + "plugin": ["typedoc-plugin-markdown"], + "projectDocuments": ["documents/*.md"], + "outputs": [ + { + // requires typedoc-plugin-markdown + "name": "markdown", + "path": "./docs/markdown", + "fileExtension": ".mdx" + } + ] +} diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 0329cdba1..bbbfb77d0 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -741,7 +741,7 @@ importers: specifier: ^2.4.2 version: 2.4.2 viem: - specifier: 2.23.13 + specifier: ^2.23.13 version: 2.23.13(typescript@5.4.3) devDependencies: '@types/prompts': @@ -2002,6 +2002,12 @@ importers: specifier: ^8.0.3 version: 8.1.0 + packages/sdk-types: + devDependencies: + typescript: + specifier: ^5.4.3 + version: 5.4.3 + packages/solana: dependencies: '@solana/web3.js': @@ -14192,6 +14198,20 @@ packages: zod: 3.23.8 dev: false + /abitype@1.0.6(typescript@5.1.3): + resolution: {integrity: sha512-MMSqYh4+C/aVqI2RQaWqbvI4Kxo5cQV40WQ4QFtDnNzCkqChm8MuENhElmynZlO0qUy/ObkEUaXtKqYnx1Kp3A==} + peerDependencies: + typescript: '>=5.0.4' + zod: ^3 >=3.22.0 + peerDependenciesMeta: + typescript: + optional: true + zod: + optional: true + dependencies: + typescript: 5.1.3 + dev: false + /abitype@1.0.6(typescript@5.4.3): resolution: {integrity: sha512-MMSqYh4+C/aVqI2RQaWqbvI4Kxo5cQV40WQ4QFtDnNzCkqChm8MuENhElmynZlO0qUy/ObkEUaXtKqYnx1Kp3A==} peerDependencies: @@ -25293,6 +25313,29 @@ packages: - zod dev: false + /viem@2.23.13(typescript@5.4.3): + resolution: {integrity: sha512-f3RkcrzGhU79GfBb9GHUL0m3e3LUsNudXIQTFp4fit5hUGb0ew9KOYZ6cCY5d4Melj3noBy2zq0K2fV+mp+Cpg==} + peerDependencies: + typescript: '>=5.0.4' + peerDependenciesMeta: + typescript: + optional: true + dependencies: + '@noble/curves': 1.8.1 + '@noble/hashes': 1.7.1 + '@scure/bip32': 1.6.2 + '@scure/bip39': 1.5.4 + abitype: 1.0.8(typescript@5.4.3) + isows: 1.0.6(ws@8.17.1) + ox: 0.6.9(typescript@5.4.3) + typescript: 5.4.3 + ws: 8.17.1(bufferutil@4.0.7)(utf-8-validate@5.0.10) + transitivePeerDependencies: + - bufferutil + - utf-8-validate + - zod + dev: false + /viem@2.7.19(typescript@5.1.5): resolution: {integrity: sha512-UOMeqy+8p2709ra2j9HEOL1NfjsXZzlJ8gwR6YO/zXH8KIZvyzW07t4iQARF5+ShVZ/7+/1ec8oPjVi1M//33A==} peerDependencies: From b0d2202be238ff6cff7e19b69b78ed54400cbe5a Mon Sep 17 00:00:00 2001 From: Brian Cleary Date: Fri, 4 Apr 2025 17:37:25 -0400 Subject: [PATCH 3/4] chore: remove eslint --- pnpm-lock.yaml | 41 ++--------------------------------------- 1 file changed, 2 insertions(+), 39 deletions(-) diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index bbbfb77d0..8069e242e 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -741,7 +741,7 @@ importers: specifier: ^2.4.2 version: 2.4.2 viem: - specifier: ^2.23.13 + specifier: 2.23.13 version: 2.23.13(typescript@5.4.3) devDependencies: '@types/prompts': @@ -13190,7 +13190,7 @@ packages: /@types/prompts@2.4.2: resolution: {integrity: sha512-TwNx7qsjvRIUv/BCx583tqF5IINEVjCNqg9ofKHRlSoUHE62WBHrem4B1HGXcIrG511v29d1kJ9a/t2Esz7MIg==} dependencies: - '@types/node': 22.7.7 + '@types/node': 20.3.1 kleur: 3.0.3 dev: true @@ -14198,20 +14198,6 @@ packages: zod: 3.23.8 dev: false - /abitype@1.0.6(typescript@5.1.3): - resolution: {integrity: sha512-MMSqYh4+C/aVqI2RQaWqbvI4Kxo5cQV40WQ4QFtDnNzCkqChm8MuENhElmynZlO0qUy/ObkEUaXtKqYnx1Kp3A==} - peerDependencies: - typescript: '>=5.0.4' - zod: ^3 >=3.22.0 - peerDependenciesMeta: - typescript: - optional: true - zod: - optional: true - dependencies: - typescript: 5.1.3 - dev: false - /abitype@1.0.6(typescript@5.4.3): resolution: {integrity: sha512-MMSqYh4+C/aVqI2RQaWqbvI4Kxo5cQV40WQ4QFtDnNzCkqChm8MuENhElmynZlO0qUy/ObkEUaXtKqYnx1Kp3A==} peerDependencies: @@ -25313,29 +25299,6 @@ packages: - zod dev: false - /viem@2.23.13(typescript@5.4.3): - resolution: {integrity: sha512-f3RkcrzGhU79GfBb9GHUL0m3e3LUsNudXIQTFp4fit5hUGb0ew9KOYZ6cCY5d4Melj3noBy2zq0K2fV+mp+Cpg==} - peerDependencies: - typescript: '>=5.0.4' - peerDependenciesMeta: - typescript: - optional: true - dependencies: - '@noble/curves': 1.8.1 - '@noble/hashes': 1.7.1 - '@scure/bip32': 1.6.2 - '@scure/bip39': 1.5.4 - abitype: 1.0.8(typescript@5.4.3) - isows: 1.0.6(ws@8.17.1) - ox: 0.6.9(typescript@5.4.3) - typescript: 5.4.3 - ws: 8.17.1(bufferutil@4.0.7)(utf-8-validate@5.0.10) - transitivePeerDependencies: - - bufferutil - - utf-8-validate - - zod - dev: false - /viem@2.7.19(typescript@5.1.5): resolution: {integrity: sha512-UOMeqy+8p2709ra2j9HEOL1NfjsXZzlJ8gwR6YO/zXH8KIZvyzW07t4iQARF5+ShVZ/7+/1ec8oPjVi1M//33A==} peerDependencies: From 5cc101b072f33c2a334b6f47e91dc879c856182e Mon Sep 17 00:00:00 2001 From: Brian Cleary Date: Tue, 8 Apr 2025 15:38:02 -0400 Subject: [PATCH 4/4] chore: add package.json and base types --- packages/sdk-types/package.json | 53 +++++++++++++++++++++++++++++++++ packages/sdk-types/src/index.ts | 12 ++++++++ 2 files changed, 65 insertions(+) create mode 100644 packages/sdk-types/package.json create mode 100644 packages/sdk-types/src/index.ts diff --git a/packages/sdk-types/package.json b/packages/sdk-types/package.json new file mode 100644 index 000000000..9f95a902a --- /dev/null +++ b/packages/sdk-types/package.json @@ -0,0 +1,53 @@ +{ + "name": "@turnkey/sdk-types", + "version": "0.0.1", + "main": "dist/index.js", + "types": "dist/index.d.ts", + "files": [ + "dist/**/*", + "CHANGELOG.md" + ], + "scripts": { + "build": "rollup -c", + "prepublishOnly": "pnpm run build", + "clean": "rimraf ./dist ./.cache", + "typecheck": "tsc -p tsconfig.typecheck.json" + }, + "module": "./dist/index.mjs", + "exports": { + ".": { + "types": "./dist/index.d.ts", + "import": "./dist/index.mjs", + "require": "./dist/index.js", + "default": "./dist/index.mjs" + } + }, + "license": "Apache-2.0", + "description": "Turnkey SDK Types", + "keywords": [ + "Turnkey" + ], + "author": { + "name": "Turnkey", + "url": "https://turnkey.com" + }, + "homepage": "https://github.com/tkhq/sdk/packages/sdk-types#readme", + "bugs": { + "url": "https://github.com/tkhq/sdk/issues" + }, + "repository": { + "type": "git", + "url": "https://github.com/tkhq/sdk.git", + "directory": "packages/sdk-types" + }, + "publishConfig": { + "access": "restricted" + }, + "private": true, + "devDependencies": { + "typescript": "^5.4.3" + }, + "engines": { + "node": ">=18.0.0" + } +} diff --git a/packages/sdk-types/src/index.ts b/packages/sdk-types/src/index.ts new file mode 100644 index 000000000..af03f7d88 --- /dev/null +++ b/packages/sdk-types/src/index.ts @@ -0,0 +1,12 @@ +export enum SessionType { + READ_ONLY = "SESSION_TYPE_READ_ONLY", + READ_WRITE = "SESSION_TYPE_READ_WRITE", +} + +export type Session = { + sessionType: SessionType; + userId: string; + organizationId: string; + expiry: number; + token: string; +};