@openfort/openfort-js 0.0.1

package/.prettierrc

@@ -0,0 +1,6 @@
+{
+  "printWidth": 120,
+  "singleQuote": true,
+  "tabWidth": 4,
+  "trailingComma": "all"
+}

package/README.md

@@ -0,0 +1,33 @@
+# openfort-typescript-client
+
+## Registration of the player session
+1. Create a key pair for the player:
+```typescript
+const playerKey = new KeyPair();
+```
+
+2. Authorize player with the game backend service and pass public key to the `openfortClient.players.createSession` api method
+
+3. Save private key. You can use local storage, file storage or any other type of storaged 
+```typescript
+await keyPair.saveToLocalStorage();
+```
+```typescript
+await keyPair.saveToFile();
+```
+```typescript
+await KeyPair.saveToStorage(customeStorageImplementation);
+```
+
+4. Use the private key to communicate with openfort api.
+
+5. To the future use one of the load methods to load key pair. Depends on the solution, that was chosen in the step 4.
+```typescript
+const playerKey = await KeyPair.loadFromLocalStorage();
+```
+```typescript
+const playerKey = await KeyPair.loadFromFile();
+```
+```typescript
+const playerKey = await KeyPair.loadFromStorage(customeStorageImplementation);
+```

package/jestconfig.json

@@ -0,0 +1,7 @@
+{
+  "transform": {
+    "^.+\\.(t|j)sx?$": "ts-jest"
+  },
+  "testRegex": "(/tests/.*|(\\.|/)(test|spec))\\.ts$",
+  "moduleFileExtensions": ["ts", "tsx", "js", "jsx", "json", "node"]
+}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@openfort/openfort-js",
+  "version": "0.0.1",
+  "description": "",
+  "author": "",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/openfort-xyz/openfort-js.git"
+  },
+  "keywords": [],
+  "license": "MIT",
+  "main": "./dist/index.js",
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "lint": "tslint -p tsconfig.json",
+    "test": "jest --config jestconfig.json"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "@types/node": "^20.2.1",
+    "prettier": "^2.8.8",
+    "tslint": "^6.1.3",
+    "tslint-config-prettier": "^1.18.0",
+    "typescript": "^5.0.4"
+  },
+  "dependencies": {
+    "axios": "^1.4.0",
+    "es6-promise": "^4.2.8",
+    "ethereum-cryptography": "^2.0.0",
+    "path": "^0.12.7"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,30 @@
+{
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src",
+    "sourceMap": true,
+    "noImplicitAny": false,
+    "module": "commonjs",
+    "composite": true,
+    "target": "es2021",
+    "lib": ["es2021", "dom"],
+    "typeRoots": ["node_modules/@types"],
+    "downlevelIteration": true,
+    "experimentalDecorators": true,
+    "declaration": true,
+    "noUnusedLocals": false,
+    "strictNullChecks": true,
+    "newLine": "LF",
+    "noUnusedParameters": false,
+    "emitDecoratorMetadata": true,
+    "noImplicitThis": true,
+    "noImplicitReturns": true,
+    "noFallthroughCasesInSwitch": true,
+    "strictBindCallApply": true,
+    "esModuleInterop": true
+  },
+  "exclude": [
+    "dist",
+    "example"
+  ]
+}

package/tslint.json

@@ -0,0 +1,3 @@
+{
+  "extends": ["tslint:recommended", "tslint-config-prettier"]
+}