open-secrets-sdk 0.1.0

package/README.md

@@ -0,0 +1,65 @@
+# Open Secrets SDK
+
+A decentralized protocol for anonymous confessions, built on Nostr.
+
+## Installation
+
+```bash
+npm install open-secrets-sdk
+```
+
+## Usage
+
+### Creating a Post
+
+```typescript
+import { createOpenSecretsTags } from 'open-secrets-sdk';
+
+const tags = createOpenSecretsTags({
+  lang: 'en',
+  gender: 'female',
+  age: 25,
+  country: 'US',
+  client: 'my-awesome-app'
+});
+
+// Use with nostr-tools
+const event = {
+  kind: 1,
+  content: "This is my secret...",
+  tags: tags,
+  created_at: Math.floor(Date.now() / 1000)
+};
+```
+
+### Parsing metadata
+
+```typescript
+import { parseOpenSecretsTags } from 'open-secrets-sdk';
+
+const metadata = parseOpenSecretsTags(event.tags);
+console.log(metadata.gender); // 'female'
+console.log(metadata.client); // 'my-awesome-app'
+```
+
+### Fetching posts
+
+```typescript
+import { getOpenSecretsFilter } from 'open-secrets-sdk';
+
+const filter = getOpenSecretsFilter(100);
+// Query your favorite relays...
+```
+
+## Protocol Details
+
+Open Secrets uses Nostr Kind 1 events with specific tags:
+
+- `#t`: `open-secrets` (The gatekeeper tag)
+- `#l`: Used for namespaced metadata (gender, age, country, lang, etc.)
+- `client`: Identifies the originating application.
+- `content-warning`: Standard Nostr tag for NSFW content.
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,43 @@
+/**
+ * Open Secrets Protocol SDK
+ * A decentralized protocol for anonymous confessions on Nostr.
+ */
+declare const OPEN_SECRETS_TAG = "open-secrets";
+declare const OPEN_SECRETS_NAMESPACE = "open-secrets";
+declare const DEFAULT_RELAYS: string[];
+interface OpenSecretsOptions {
+    externalId?: string;
+    gender?: string;
+    age?: string | number;
+    country?: string;
+    lang?: string;
+    client?: string;
+    isNsfw?: boolean;
+}
+interface OpenSecretsMetadata {
+    externalId?: string;
+    gender?: string;
+    age?: string;
+    country?: string;
+    lang?: string;
+    client?: string;
+    isNsfw: boolean;
+}
+/**
+ * Generates the tags for an Open Secrets post (Nostr Kind 1)
+ */
+declare function createOpenSecretsTags(options?: OpenSecretsOptions): string[][];
+/**
+ * Parses tags from a Nostr event into Open Secrets metadata
+ */
+declare function parseOpenSecretsTags(tags: string[][]): OpenSecretsMetadata;
+/**
+ * Generates a Nostr filter for fetching Open Secrets posts
+ */
+declare function getOpenSecretsFilter(limit?: number): {
+    kinds: number[];
+    '#t': string[];
+    limit: number;
+};
+
+export { DEFAULT_RELAYS, OPEN_SECRETS_NAMESPACE, OPEN_SECRETS_TAG, type OpenSecretsMetadata, type OpenSecretsOptions, createOpenSecretsTags, getOpenSecretsFilter, parseOpenSecretsTags };

package/dist/index.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Open Secrets Protocol SDK
+ * A decentralized protocol for anonymous confessions on Nostr.
+ */
+declare const OPEN_SECRETS_TAG = "open-secrets";
+declare const OPEN_SECRETS_NAMESPACE = "open-secrets";
+declare const DEFAULT_RELAYS: string[];
+interface OpenSecretsOptions {
+    externalId?: string;
+    gender?: string;
+    age?: string | number;
+    country?: string;
+    lang?: string;
+    client?: string;
+    isNsfw?: boolean;
+}
+interface OpenSecretsMetadata {
+    externalId?: string;
+    gender?: string;
+    age?: string;
+    country?: string;
+    lang?: string;
+    client?: string;
+    isNsfw: boolean;
+}
+/**
+ * Generates the tags for an Open Secrets post (Nostr Kind 1)
+ */
+declare function createOpenSecretsTags(options?: OpenSecretsOptions): string[][];
+/**
+ * Parses tags from a Nostr event into Open Secrets metadata
+ */
+declare function parseOpenSecretsTags(tags: string[][]): OpenSecretsMetadata;
+/**
+ * Generates a Nostr filter for fetching Open Secrets posts
+ */
+declare function getOpenSecretsFilter(limit?: number): {
+    kinds: number[];
+    '#t': string[];
+    limit: number;
+};
+
+export { DEFAULT_RELAYS, OPEN_SECRETS_NAMESPACE, OPEN_SECRETS_TAG, type OpenSecretsMetadata, type OpenSecretsOptions, createOpenSecretsTags, getOpenSecretsFilter, parseOpenSecretsTags };

package/dist/index.js

@@ -0,0 +1,105 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  DEFAULT_RELAYS: () => DEFAULT_RELAYS,
+  OPEN_SECRETS_NAMESPACE: () => OPEN_SECRETS_NAMESPACE,
+  OPEN_SECRETS_TAG: () => OPEN_SECRETS_TAG,
+  createOpenSecretsTags: () => createOpenSecretsTags,
+  getOpenSecretsFilter: () => getOpenSecretsFilter,
+  parseOpenSecretsTags: () => parseOpenSecretsTags
+});
+module.exports = __toCommonJS(index_exports);
+var OPEN_SECRETS_TAG = "open-secrets";
+var OPEN_SECRETS_NAMESPACE = "open-secrets";
+var DEFAULT_RELAYS = ["wss://nos.lol", "wss://relay.damus.io", "wss://relay.snort.social"];
+function createOpenSecretsTags(options = {}) {
+  const tags = [
+    ["t", OPEN_SECRETS_TAG]
+  ];
+  if (options.lang) {
+    tags.push(["l", options.lang]);
+    tags.push(["l", `lang:${options.lang}`, OPEN_SECRETS_NAMESPACE]);
+  }
+  if (options.externalId) {
+    tags.push(["i", `supabase:${options.externalId}`]);
+  }
+  if (options.gender) {
+    tags.push(["l", `gender:${options.gender}`, OPEN_SECRETS_NAMESPACE]);
+  }
+  if (options.age) {
+    tags.push(["l", `age:${options.age}`, OPEN_SECRETS_NAMESPACE]);
+  }
+  if (options.country) {
+    tags.push(["l", `country:${options.country}`, OPEN_SECRETS_NAMESPACE]);
+  }
+  if (options.client) {
+    tags.push(["client", options.client]);
+  }
+  if (options.isNsfw) {
+    tags.push(["l", "nsfw:true", OPEN_SECRETS_NAMESPACE]);
+    tags.push(["content-warning", "NSFW"]);
+  }
+  return tags;
+}
+function parseOpenSecretsTags(tags) {
+  var _a, _b, _c, _d;
+  const getLabel = (prefix) => {
+    const tag = tags.find(
+      (t) => {
+        var _a2;
+        return t[0] === "l" && ((_a2 = t[1]) == null ? void 0 : _a2.startsWith(`${prefix}:`)) && t[2] === OPEN_SECRETS_NAMESPACE;
+      }
+    );
+    return tag ? tag[1].split(":")[1] : void 0;
+  };
+  const langTag = (_a = tags.find((t) => {
+    var _a2;
+    return t[0] === "l" && ((_a2 = t[1]) == null ? void 0 : _a2.length) === 2;
+  })) == null ? void 0 : _a[1];
+  return {
+    externalId: (_c = (_b = tags.find((t) => {
+      var _a2;
+      return t[0] === "i" && ((_a2 = t[1]) == null ? void 0 : _a2.startsWith("supabase:"));
+    })) == null ? void 0 : _b[1]) == null ? void 0 : _c.split(":")[1],
+    gender: getLabel("gender"),
+    age: getLabel("age"),
+    country: getLabel("country"),
+    lang: getLabel("lang") || langTag,
+    client: (_d = tags.find((t) => t[0] === "client")) == null ? void 0 : _d[1],
+    isNsfw: tags.some((t) => t[0] === "content-warning" || t[0] === "l" && t[1] === "nsfw:true")
+  };
+}
+function getOpenSecretsFilter(limit = 100) {
+  return {
+    kinds: [1],
+    "#t": [OPEN_SECRETS_TAG],
+    limit
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  DEFAULT_RELAYS,
+  OPEN_SECRETS_NAMESPACE,
+  OPEN_SECRETS_TAG,
+  createOpenSecretsTags,
+  getOpenSecretsFilter,
+  parseOpenSecretsTags
+});

package/dist/index.mjs

@@ -0,0 +1,76 @@
+// src/index.ts
+var OPEN_SECRETS_TAG = "open-secrets";
+var OPEN_SECRETS_NAMESPACE = "open-secrets";
+var DEFAULT_RELAYS = ["wss://nos.lol", "wss://relay.damus.io", "wss://relay.snort.social"];
+function createOpenSecretsTags(options = {}) {
+  const tags = [
+    ["t", OPEN_SECRETS_TAG]
+  ];
+  if (options.lang) {
+    tags.push(["l", options.lang]);
+    tags.push(["l", `lang:${options.lang}`, OPEN_SECRETS_NAMESPACE]);
+  }
+  if (options.externalId) {
+    tags.push(["i", `supabase:${options.externalId}`]);
+  }
+  if (options.gender) {
+    tags.push(["l", `gender:${options.gender}`, OPEN_SECRETS_NAMESPACE]);
+  }
+  if (options.age) {
+    tags.push(["l", `age:${options.age}`, OPEN_SECRETS_NAMESPACE]);
+  }
+  if (options.country) {
+    tags.push(["l", `country:${options.country}`, OPEN_SECRETS_NAMESPACE]);
+  }
+  if (options.client) {
+    tags.push(["client", options.client]);
+  }
+  if (options.isNsfw) {
+    tags.push(["l", "nsfw:true", OPEN_SECRETS_NAMESPACE]);
+    tags.push(["content-warning", "NSFW"]);
+  }
+  return tags;
+}
+function parseOpenSecretsTags(tags) {
+  var _a, _b, _c, _d;
+  const getLabel = (prefix) => {
+    const tag = tags.find(
+      (t) => {
+        var _a2;
+        return t[0] === "l" && ((_a2 = t[1]) == null ? void 0 : _a2.startsWith(`${prefix}:`)) && t[2] === OPEN_SECRETS_NAMESPACE;
+      }
+    );
+    return tag ? tag[1].split(":")[1] : void 0;
+  };
+  const langTag = (_a = tags.find((t) => {
+    var _a2;
+    return t[0] === "l" && ((_a2 = t[1]) == null ? void 0 : _a2.length) === 2;
+  })) == null ? void 0 : _a[1];
+  return {
+    externalId: (_c = (_b = tags.find((t) => {
+      var _a2;
+      return t[0] === "i" && ((_a2 = t[1]) == null ? void 0 : _a2.startsWith("supabase:"));
+    })) == null ? void 0 : _b[1]) == null ? void 0 : _c.split(":")[1],
+    gender: getLabel("gender"),
+    age: getLabel("age"),
+    country: getLabel("country"),
+    lang: getLabel("lang") || langTag,
+    client: (_d = tags.find((t) => t[0] === "client")) == null ? void 0 : _d[1],
+    isNsfw: tags.some((t) => t[0] === "content-warning" || t[0] === "l" && t[1] === "nsfw:true")
+  };
+}
+function getOpenSecretsFilter(limit = 100) {
+  return {
+    kinds: [1],
+    "#t": [OPEN_SECRETS_TAG],
+    limit
+  };
+}
+export {
+  DEFAULT_RELAYS,
+  OPEN_SECRETS_NAMESPACE,
+  OPEN_SECRETS_TAG,
+  createOpenSecretsTags,
+  getOpenSecretsFilter,
+  parseOpenSecretsTags
+};

package/package.json

@@ -0,0 +1,32 @@
+{
+    "name": "open-secrets-sdk",
+    "version": "0.1.0",
+    "description": "SDK for the Open Secrets protocol on Nostr",
+    "main": "dist/index.js",
+    "module": "dist/index.mjs",
+    "types": "dist/index.d.ts",
+    "files": [
+        "dist"
+    ],
+    "scripts": {
+        "build": "tsup src/index.ts --format cjs,esm --dts",
+        "dev": "tsup src/index.ts --format cjs,esm --watch --dts",
+        "lint": "eslint src"
+    },
+    "keywords": [
+        "nostr",
+        "confessions",
+        "anonymous",
+        "protocol",
+        "open-secrets"
+    ],
+    "author": "",
+    "license": "MIT",
+    "devDependencies": {
+        "tsup": "^8.0.0",
+        "typescript": "^5.0.0"
+    },
+    "peerDependencies": {
+        "nostr-tools": "^2.0.0"
+    }
+}