@nextera.one/softid-sdk 1.0.0

package/README.md

@@ -0,0 +1,34 @@
+# SoftID SDK
+
+The official SDK for [SoftID](https://softid.org) — the DNS-based identity standard for software.
+
+## Installation
+
+```bash
+npm install @nextera.one/softid-sdk
+```
+
+## Usage
+
+### Generate a Claim Record
+
+```ts
+import { generateClaimRecord } from '@nextera.one/softid-sdk';
+
+const record = generateClaimRecord({ sid: 'MYAPP' });
+// Output: "v=softid1; sid=MYAPP; nonce=01J4..."
+```
+
+### Verify Ownership (Node.js)
+
+```ts
+import { verifyOwnership } from '@nextera.one/softid-sdk';
+
+const result = await verifyOwnership('VUE', 'vuejs.org');
+
+if (result.verified) {
+  console.log('Verified owner!', result);
+} else {
+  console.error('Verification failed', result.error);
+}
+```

package/dist/index.d.mts

@@ -0,0 +1,80 @@
+export { ulid } from 'ulid';
+
+/**
+ * SoftID SDK Types
+ */
+/**
+ * A valid Software Identifier (SID).
+ * Format: Upper-case alphanumeric, 2-32 chars.
+ */
+type SID = string;
+/**
+ * Result of a SoftID verification attempt.
+ */
+interface VerificationResult {
+    /** Whether the verification was successful */
+    verified: boolean;
+    /** The SID being verified */
+    sid: SID;
+    /** The domain that claimed ownership */
+    domain: string;
+    /** The raw TXT record found (if any) */
+    txtRecord?: string;
+    /** Error message if verification failed */
+    error?: string;
+    /** Nonce found in the record */
+    nonce?: string;
+}
+/**
+ * Represents the components of a parsed SoftID TXT record.
+ */
+interface SoftIDRecord {
+    v: string;
+    sid: SID;
+    nonce: string;
+}
+/**
+ * Options for generating a claim record.
+ */
+interface ClaimOptions {
+    sid: SID;
+    nonce?: string;
+}
+
+/**
+ * SoftID SID Logic
+ */
+/**
+ * Validate if a string is a valid SID.
+ */
+declare function isValidSID(sid: string): boolean;
+/**
+ * Ensure a string is a valid SID, throwing if not.
+ */
+declare function assertValidSID(sid: string): void;
+/**
+ * Parse a SoftID TXT record string.
+ * Format: v=softid1; sid=MYAPP; nonce=...
+ */
+declare function parseTXTRecord(txt: string): Record<string, string> | null;
+
+/**
+ * SoftID Verification Logic
+ */
+
+/**
+ * Generate the required DNS TXT record value for a claim.
+ */
+declare function generateClaimRecord(options: ClaimOptions): string;
+/**
+ * Get the expected DNS TXT record name for a domain.
+ */
+declare function getClaimName(domain: string): string;
+/**
+ * Verify ownership of an SID by a domain.
+ * NOTE: This runs only in Node.js environments due to `dns` module usage.
+ * For browser usage, a DOH (DNS over HTTPS) adapter would be needed.
+ */
+declare function verifyOwnership(sid: string, domain: string): Promise<VerificationResult>;
+
+export { type ClaimOptions, type SID, type SoftIDRecord, type VerificationResult, assertValidSID, generateClaimRecord, getClaimName, isValidSID, parseTXTRecord, verifyOwnership };

package/dist/index.d.ts

@@ -0,0 +1,80 @@
+export { ulid } from 'ulid';
+
+/**
+ * SoftID SDK Types
+ */
+/**
+ * A valid Software Identifier (SID).
+ * Format: Upper-case alphanumeric, 2-32 chars.
+ */
+type SID = string;
+/**
+ * Result of a SoftID verification attempt.
+ */
+interface VerificationResult {
+    /** Whether the verification was successful */
+    verified: boolean;
+    /** The SID being verified */
+    sid: SID;
+    /** The domain that claimed ownership */
+    domain: string;
+    /** The raw TXT record found (if any) */
+    txtRecord?: string;
+    /** Error message if verification failed */
+    error?: string;
+    /** Nonce found in the record */
+    nonce?: string;
+}
+/**
+ * Represents the components of a parsed SoftID TXT record.
+ */
+interface SoftIDRecord {
+    v: string;
+    sid: SID;
+    nonce: string;
+}
+/**
+ * Options for generating a claim record.
+ */
+interface ClaimOptions {
+    sid: SID;
+    nonce?: string;
+}
+
+/**
+ * SoftID SID Logic
+ */
+/**
+ * Validate if a string is a valid SID.
+ */
+declare function isValidSID(sid: string): boolean;
+/**
+ * Ensure a string is a valid SID, throwing if not.
+ */
+declare function assertValidSID(sid: string): void;
+/**
+ * Parse a SoftID TXT record string.
+ * Format: v=softid1; sid=MYAPP; nonce=...
+ */
+declare function parseTXTRecord(txt: string): Record<string, string> | null;
+
+/**
+ * SoftID Verification Logic
+ */
+
+/**
+ * Generate the required DNS TXT record value for a claim.
+ */
+declare function generateClaimRecord(options: ClaimOptions): string;
+/**
+ * Get the expected DNS TXT record name for a domain.
+ */
+declare function getClaimName(domain: string): string;
+/**
+ * Verify ownership of an SID by a domain.
+ * NOTE: This runs only in Node.js environments due to `dns` module usage.
+ * For browser usage, a DOH (DNS over HTTPS) adapter would be needed.
+ */
+declare function verifyOwnership(sid: string, domain: string): Promise<VerificationResult>;
+
+export { type ClaimOptions, type SID, type SoftIDRecord, type VerificationResult, assertValidSID, generateClaimRecord, getClaimName, isValidSID, parseTXTRecord, verifyOwnership };

package/dist/index.js

@@ -0,0 +1 @@
+"use strict";var x=Object.create;var c=Object.defineProperty;var v=Object.getOwnPropertyDescriptor;var R=Object.getOwnPropertyNames;var h=Object.getPrototypeOf,D=Object.prototype.hasOwnProperty;var I=(r,t)=>{for(var o in t)c(r,o,{get:t[o],enumerable:!0})},l=(r,t,o,n)=>{if(t&&typeof t=="object"||typeof t=="function")for(let e of R(t))!D.call(r,e)&&e!==o&&c(r,e,{get:()=>t[e],enumerable:!(n=v(t,e))||n.enumerable});return r};var S=(r,t,o)=>(o=r!=null?x(h(r)):{},l(t||!r||!r.__esModule?c(o,"default",{value:r,enumerable:!0}):o,r)),T=r=>l(c({},"__esModule",{value:!0}),r);var X={};I(X,{assertValidSID:()=>f,generateClaimRecord:()=>V,getClaimName:()=>w,isValidSID:()=>u,parseTXTRecord:()=>a,ulid:()=>g.ulid,verifyOwnership:()=>C});module.exports=T(X);var y=/^[A-Z0-9]{2,32}$/;function u(r){return y.test(r)}function f(r){if(!u(r))throw new Error(`Invalid SID format: "${r}". Must be 2-32 uppercase alphanumeric characters.`)}function a(r){if(!r.includes("v=softid1"))return null;let t=r.split(";"),o={};for(let n of t){let e=n.trim(),[s,i]=e.split("=");s&&i&&(o[s.trim()]=i.trim())}return o}var m=require("ulid"),p=S(require("dns")),d=require("util"),$=(0,d.promisify)(p.resolveTxt);function V(r){f(r.sid);let t=r.nonce||(0,m.ulid)();return`v=softid1; sid=${r.sid}; nonce=${t}`}function w(r){return`_softid.${r}`}async function C(r,t){f(r);let o=`_softid.${t}`;try{let n=await $(o);for(let e of n){let s=e.join(""),i=a(s);if(i&&i.v==="softid1"&&i.sid===r)return{verified:!0,sid:r,domain:t,txtRecord:s,nonce:i.nonce}}return{verified:!1,sid:r,domain:t,error:"No matching SoftID TXT record found."}}catch(n){return{verified:!1,sid:r,domain:t,error:`DNS lookup failed: ${n.message}`}}}var g=require("ulid");0&&(module.exports={assertValidSID,generateClaimRecord,getClaimName,isValidSID,parseTXTRecord,ulid,verifyOwnership});

package/dist/index.mjs

@@ -0,0 +1 @@
+var l=/^[A-Z0-9]{2,32}$/;function u(r){return l.test(r)}function c(r){if(!u(r))throw new Error(`Invalid SID format: "${r}". Must be 2-32 uppercase alphanumeric characters.`)}function f(r){if(!r.includes("v=softid1"))return null;let t=r.split(";"),i={};for(let e of t){let s=e.trim(),[n,o]=s.split("=");n&&o&&(i[n.trim()]=o.trim())}return i}import{ulid as m}from"ulid";import*as a from"dns";import{promisify as p}from"util";var d=p(a.resolveTxt);function h(r){c(r.sid);let t=r.nonce||m();return`v=softid1; sid=${r.sid}; nonce=${t}`}function D(r){return`_softid.${r}`}async function I(r,t){c(r);let i=`_softid.${t}`;try{let e=await d(i);for(let s of e){let n=s.join(""),o=f(n);if(o&&o.v==="softid1"&&o.sid===r)return{verified:!0,sid:r,domain:t,txtRecord:n,nonce:o.nonce}}return{verified:!1,sid:r,domain:t,error:"No matching SoftID TXT record found."}}catch(e){return{verified:!1,sid:r,domain:t,error:`DNS lookup failed: ${e.message}`}}}import{ulid as C}from"ulid";export{c as assertValidSID,h as generateClaimRecord,D as getClaimName,u as isValidSID,f as parseTXTRecord,C as ulid,I as verifyOwnership};

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@nextera.one/softid-sdk",
+  "version": "1.0.0",
+  "description": "TypeScript/JavaScript SDK for SoftID - DNS-based Software Identity",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "test": "vitest run",
+    "prepare": "npm run build"
+  },
+  "keywords": [
+    "softid",
+    "identity",
+    "dns",
+    "verification",
+    "security"
+  ],
+  "author": "SoftID Contributors",
+  "license": "Apache-2.0",
+  "devDependencies": {
+    "@types/node": "^20.10.0",
+    "tsup": "^8.0.1",
+    "typescript": "^5.3.3",
+    "vitest": "^1.1.0"
+  },
+  "dependencies": {
+    "ulid": "^2.3.0"
+  }
+}