payid-types 0.1.0

package/README.md

@@ -0,0 +1,15 @@
+# types
+
+To install dependencies:
+
+```bash
+bun install
+```
+
+To run:
+
+```bash
+bun run index.ts
+```
+
+This project was created using `bun init` in bun v1.2.21. [Bun](https://bun.com) is a fast all-in-one JavaScript runtime.

package/index.ts

@@ -0,0 +1 @@
+export * from "./src";

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "payid-types",
+  "version": "0.1.0",
+  "private": false,
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "bun build src/index.ts --outdir dist --target node"
+  },
+  "devDependencies": {
+    "@types/bun": "latest"
+  },
+  "peerDependencies": {
+    "typescript": "^5"
+  }
+}

package/src/context.v1.ts

@@ -0,0 +1,31 @@
+export interface RuleContext {
+  tx: {
+    sender?: string;
+    asset: string;
+    amount: string;
+    chainId: number;
+    receiver?: string;
+  };
+  payId?: {
+    id: string;
+    owner: string;
+  };
+}
+export interface TxContext {
+  sender: string;
+  receiver: string;
+  asset: string;
+  amount: string;
+  chainId: number;
+  memo?: string;
+}
+
+export interface PayIdContext {
+  id: string;
+  owner: string;
+}
+
+export interface ContextV1 {
+  tx: TxContext;
+  payId: PayIdContext;
+}

package/src/context.v2.ts

@@ -0,0 +1,43 @@
+import type { ContextV1 } from "./context.v1";
+
+export interface Attestation {
+  issuer: string;
+  issuedAt: number;
+  expiresAt: number;
+  signature: string;
+}
+
+/* ---- Extensions ---- */
+
+export interface EnvContext {
+  timestamp: number;
+  proof: Attestation;
+}
+
+export interface StateContext {
+  spentToday: string;
+  period: string;
+  proof: Attestation;
+}
+
+export interface OracleContext {
+  [key: string]: string | number | Attestation;
+  proof: Attestation;
+}
+
+export interface RiskContext {
+  score: number;
+  category: string;
+  proof: Attestation & {
+    modelHash: string;
+  };
+}
+
+/* ---- Final Context ---- */
+
+export interface ContextV2 extends ContextV1 {
+  env?: EnvContext;
+  state?: StateContext;
+  oracle?: OracleContext;
+  risk?: RiskContext;
+}

package/src/index.ts

@@ -0,0 +1,4 @@
+export * from "./context.v1";
+export * from "./context.v2";
+export * from "./result";
+export * from "./rule";

package/src/result.ts

@@ -0,0 +1,5 @@
+export interface RuleResult {
+  decision: "ALLOW" | "REJECT";
+  code: string;
+  reason?: string;
+}

package/src/rule.ts

@@ -0,0 +1,17 @@
+export interface RuleCondition {
+  field: string;
+  op: string;
+  value: any;
+}
+
+export interface Rule {
+  id: string;
+  if: RuleCondition;
+}
+
+export interface RuleConfig {
+  version?: string;
+  logic: "AND" | "OR";
+  rules: Rule[];
+  requires?: string[];
+}

package/tsconfig.json

@@ -0,0 +1,29 @@
+{
+  "compilerOptions": {
+    // Environment setup & latest features
+    "lib": ["ESNext"],
+    "target": "ESNext",
+    "module": "Preserve",
+    "moduleDetection": "force",
+    "jsx": "react-jsx",
+    "allowJs": true,
+
+    // Bundler mode
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "verbatimModuleSyntax": true,
+    "noEmit": true,
+
+    // Best practices
+    "strict": true,
+    "skipLibCheck": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedIndexedAccess": true,
+    "noImplicitOverride": true,
+
+    // Some stricter flags (disabled by default)
+    "noUnusedLocals": false,
+    "noUnusedParameters": false,
+    "noPropertyAccessFromIndexSignature": false
+  }
+}