@compilot/js-sdk 2.0.40-dev

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@compilot/js-sdk",
+  "version": "2.0.40-dev",
+  "description": "ComPilot JS SDK",
+  "keywords": [],
+  "license": "ISC",
+  "author": "",
+  "exports": {
+    ".": {
+      "import": "./dist/compilot-js-sdk.esm.js",
+      "require": "./dist/compilot-js-sdk.cjs.js"
+    }
+  },
+  "main": "dist/compilot-js-sdk.cjs.js",
+  "module": "dist/compilot-js-sdk.esm.js",
+  "types": "dist/compilot-js-sdk.cjs.d.ts",
+  "files": [
+    "/dist"
+  ],
+  "eslintConfig": {
+    "extends": [
+      "@unblokttechnology/eslint-config/base"
+    ],
+    "root": true
+  },
+  "dependencies": {
+    "pino": "^9.4.0",
+    "svix": "1.21.0",
+    "zod": "^3.23.8",
+    "@nexeraid/api-client": "1.10.2-dev",
+    "@nexeraid/identity-api-client": "1.3.215-dev",
+    "@nexeraid/identity-schemas": "1.12.38-dev",
+    "@nexeraid/logger": "0.1.2-dev"
+  },
+  "devDependencies": {
+    "prettier": "^3.3.3",
+    "typescript": "^5.6.2",
+    "@unblokttechnology/eslint-config": "0.1.1"
+  },
+  "preconstruct": {
+    "entrypoints": [
+      "index.ts"
+    ]
+  },
+  "scripts": {
+    "build": "preconstruct build && npm run copy-package-json-to-dist",
+    "copy-package-json-to-dist": "copyfiles package.json dist/",
+    "lint": "eslint .",
+    "lint:fix": "pnpm lint --fix",
+    "prepare:release": "sed -i 's/.*\"postinstall\":.*//' package.json",
+    "prepare:release:mac": "sed -i '' 's/.*\"postinstall\":.*//' package.json",
+    "prettier": "prettier 'src/' --check",
+    "prettier:fix": "prettier 'src/' --write",
+    "publish:public": "pnpm run prepare:release && publish --access=public --no-git-checks --registry https://registry.npmjs.org/",
+    "publish:public:mac": "pnpm run prepare:release:mac && publish --access=public --no-git-checks --registry https://registry.npmjs.org/",
+    "test": "vitest --config ./vitest.config.ts",
+    "type-check": "tsc --noEmit"
+  }
+}

package/readme.md

@@ -0,0 +1,69 @@
+# ComPilot JS SDK
+
+- ComPilot JS SDK, use anywhere JS runs.
+
+## How to install
+
+```bash
+npm install @compilot/js-sdk
+```
+
+### First steps
+
+- Access your ComPilot Application's Settings > API page and get the API key.
+
+### How to use
+
+```javascript
+/**
+ * Create an API client and authenticate with your API key
+ */
+const apiClient = createApiClient({
+  apiKey: API_KEY,
+});
+```
+
+#### Self-provided authentication
+
+If you already have your own authentication system, you can create a user session like so:
+
+```javascript
+/*
+ * Get access token
+ * This has to be done from secured server, to avoid leaking API_KEY
+ */
+const sessionRes = await apiClient.createSession({
+  /**
+   * The workflow id that this session will be bound to.
+   * You can find this id in compilot's dashboard.
+   */
+  workflowId: WORKFLOW_ID,
+  /**
+   * The unique identifier to associate this used to.
+   * This id is used to differenciate users on ComPilot and will be
+   * given back to you on every webhook we send.
+   */
+  externalUserId: "35194",
+});
+```
+
+Please find below an example endpoint using express:
+
+```javascript
+const apiClient = createApiClient({
+  apiKey: API_KEY,
+});
+
+app.get('/my-compilot-auth', (req, res) => {
+    const userId = req.userId;
+    const authSession = await apiClient.createSession({
+        workflowId: WORKFLOW_ID,
+        externalUserId: userId,
+    });
+    res.json(authSession);
+});
+```
+
+#### Web3 auth
+
+TODO