@arkyc/types 1.2.0 → 1.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +19 -0
  2. package/package.json +20 -1
package/README.md ADDED
@@ -0,0 +1,19 @@
1
+ # @arkyc/types
2
+
3
+ Shared domain types and contracts for [Arkyc](https://github.com/arkstack-hq/arkyc) —
4
+ an open-source, multi-tenant identity-verification platform. Zero-runtime
5
+ TypeScript types (sessions, workflows, provider results, webhooks) plus small
6
+ pure helpers, shared across the `@arkyc/*` packages and apps.
7
+
8
+ ## Install
9
+
10
+ ```bash
11
+ npm install @arkyc/types
12
+ ```
13
+
14
+ ```ts
15
+ import type { VerificationDecision, WorkflowConfig } from '@arkyc/types'
16
+ import { workflowAddressConfig } from '@arkyc/types'
17
+ ```
18
+
19
+ Docs: <https://docs.arkyc.toneflix.net>
package/package.json CHANGED
@@ -1,8 +1,27 @@
1
1
  {
2
2
  "name": "@arkyc/types",
3
- "version": "1.2.0",
3
+ "version": "1.2.2",
4
4
  "description": "Shared domain types and contracts for Arkyc",
5
5
  "license": "MIT",
6
+ "keywords": [
7
+ "arkyc",
8
+ "kyc",
9
+ "identity-verification",
10
+ "identity",
11
+ "verification",
12
+ "types",
13
+ "typescript",
14
+ "contracts"
15
+ ],
16
+ "homepage": "https://docs.arkyc.toneflix.net",
17
+ "repository": {
18
+ "type": "git",
19
+ "url": "git+https://github.com/arkstack-hq/arkyc.git",
20
+ "directory": "packages/types"
21
+ },
22
+ "bugs": {
23
+ "url": "https://github.com/arkstack-hq/arkyc/issues"
24
+ },
6
25
  "type": "module",
7
26
  "main": "./dist/index.mjs",
8
27
  "module": "./dist/index.mjs",