@prampta/sdk 0.3.2 → 0.4.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,284 +1,146 @@
-# @prampta/sdk
+# PRAMPTA TypeScript SDK
 
-Official Node.js SDK for the PRAMPTA API — create, search, and manage AI prompts with automatic retry logic and TypeScript support.
-
-## Features
-
-- **TypeScript-first** with full type definitions
-- **Automatic retries** with exponential backoff
-- **Request cancellation** via AbortSignal
-- **Rate limit handling** with intelligent retry
-- **Zero dependencies** (uses native fetch)
+Pre-generation authorization for AI content. Verifies operator Ed25519 signatures on decisions — not a blind HTTP wrapper.
 
 ## Installation
 
 ```bash
 npm install @prampta/sdk
-# or
-pnpm add @prampta/sdk
-# or
-yarn add @prampta/sdk
 ```
 
+Requires Node.js ≥ 18 (uses native `crypto.subtle` for SHA-256).
+
 ## Quick Start
 
 ```typescript
-import { Prampta } from '@prampta/sdk';
+import { Prampta } from "@prampta/sdk";
 
-const prampta = new Prampta({
-  apiKey: 'pk_xxxx-xx-xx-xx-xxxxxx', // Get at prampta.com/profile
+const pg = new Prampta({
+  baseUrl: "https://api2.prampta.com",
+  providerId: "my-ai-service",
+  licenseeId: "acme-corp",
+  token: "pair-token",
 });
 
-// Create a prompt
-const result = await prampta.create({
-  content: 'Write a TypeScript function that validates email addresses...',
-  title: 'Email Validator',
+// Option 1: Assert — throws if denied (fail-closed)
+await pg.assertAllowed("leonardo-da-vinci", {
+  prompt: "Da Vinci in a documentary",
+  modality: "image",
+  model: "gpt-image-1",
 });
-console.log('Created:', result.ppCode); // PP-3YGBM5V0HN-4
-
-// Decode a prompt
-const prompt = await prampta.decode('PP-3YGBM5V0HN-4');
-console.log(prompt.content);
 
-// Search prompts
-const { prompts } = await prampta.search({
-  query: 'typescript',
-  category: 'development',
-  limit: 10,
+// Option 2: Verify — returns decision object
+const result = await pg.verify("leonardo-da-vinci", {
+  prompt: "Da Vinci in a documentary",
+  modality: "image",
+  model: "gpt-image-1",
 });
-```
-
-## API Reference
-
-### Constructor
-
-```typescript
-new Prampta(config: PramptaConfig)
-```
-
-| Option | Type | Default | Description |
-|--------|------|---------|-------------|
-| `apiKey` | `string` | (required) | Your API key (starts with `pk_`) |
-| `baseUrl` | `string` | `https://prampta.com` | API base URL |
-| `timeoutMs` | `number` | `30000` | Request timeout in ms |
-| `maxRetries` | `number` | `3` | Max retry attempts |
-
-### Methods
-
-#### `decode(code, options?)`
-
-Get the full prompt content by PP code.
-
-```typescript
-const prompt = await prampta.decode('PP-3YGBM5V0HN-4');
-// Returns: Prompt with content, media, metadata
-```
-
-#### `lookup(code, options?)`
-
-Get prompt metadata without content (increments usage counter).
 
-```typescript
-const metadata = await prampta.lookup('PP-3YGBM5V0HN-4');
-// Returns: PromptMetadata (no content field)
+if (result.allowed) {
+  generate({ obligations: result.obligations });
+} else {
+  console.log(`Denied: ${result.reason}`);
+}
 ```
 
-#### `search(searchOptions?, requestOptions?)`
+## Security Features
 
-Search the public prompt library.
+- **Ed25519 signature verification** on every decision (via `@noble/ed25519`)
+- **Prompt hash binding** — decision is bound to the exact prompt (SHA-256)
+- **Context binding** — decision cannot be replayed for different subject/provider/licensee/modality
+- **Key fingerprint validation** — operator_key_id matches pinned public key
+- **TTL validation** — expired decisions are rejected
+- **Fail-closed** — any error defaults to deny
 
-```typescript
-const result = await prampta.search({
-  query: 'react hooks',
-  category: 'development', // development, design, marketing, data, writing, business
-  limit: 20,
-  page: 1,
-});
-// Returns: { prompts, total, page, totalPages }
-```
 
-#### `create(options, requestOptions?)`
+## Key Pinning & Rotation (trust anchor)
 
-Create a new prompt.
+Signature verification is only meaningful against a key you obtained out of
+band. **Pin the operator key** — do not rely on the key the API hands you:
 
 ```typescript
-const result = await prampta.create({
-  content: 'Your prompt content here (10-50,000 chars)',
-  title: 'Optional title',
-  media: {
-    'img1': 'data:image/png;base64,...', // Optional media attachments
-  },
+const pg = new Prampta({
+  baseUrl: "https://api2.prampta.com",
+  providerId: "my-ai-service",
+  licenseeId: "acme-corp",
+  token: "pair-token",
+  operatorPublicKeyHex: "<pinned key from PRAMPTA docs>",
 });
-// Returns: { ppCode, title, category, tags }
-```
-
-#### `myPrompts(options?)`
-
-List your own prompts.
-
-```typescript
-const prompts = await prampta.myPrompts();
-// Returns: Prompt[]
-```
-
-#### `register(ppCode, options?)`
-
-Register an existing PP code to your account.
-
-```typescript
-const { registered, prompt } = await prampta.register('PP-3YGBM5V0HN-4');
 ```
 
-#### `healthCheck()`
-
-Check API connectivity and authentication.
+- A decision is trusted only when signed by a pinned key. A decision signed by
+  an **unpinned** key fails closed with an actionable error (no silent trust).
+- **Rotation without downtime:** pin the current *and* the announced next key
+  (comma/space separated). When PRAMPTA rotates, the new key is already trusted.
+- **No pinned key** → trust-on-first-use: the SDK still verifies but logs a
+  warning. The signature proves consistency, not authenticity. Never ship
+  production this way.
 
-```typescript
-const health = await prampta.healthCheck();
-// Returns: { healthy: boolean, latencyMs: number, authenticated: boolean }
-```
+## Configuration
 
-### Request Cancellation
+| Parameter | Env Var | Required | Description |
+|-----------|---------|----------|-------------|
+| `baseUrl` | `PRAMPTA_BASE_URL` | Yes | Registry API URL |
+| `providerId` | `PRAMPTA_PROVIDER_ID` | Yes | Your provider ID |
+| `licenseeId` | `PRAMPTA_LICENSEE_ID` | Yes | Licensee ID |
+| `token` | `PRAMPTA_TOKEN` | Yes | Pair auth token |
+| `operatorPublicKeyHex` | `PRAMPTA_OPERATOR_PUBLIC_KEY` | No | Pinned operator key (recommended for production) |
+| `timeoutMs` | — | No | Default `3000`. Request timeout in ms. |
+| `failClosed` | — | No | Default `true`. Deny on any verification error. |
+| `verifyDecisionSignature` | — | No | Default `true`. Set `false` only for local dev. |
 
-All methods accept an optional `signal` for cancellation:
+## Error Handling
 
 ```typescript
-const controller = new AbortController();
-
-// Cancel after 5 seconds
-setTimeout(() => controller.abort(), 5000);
+import { Prampta, PramptaRefusalError, PramptaSignatureError } from "@prampta/sdk";
 
 try {
-  const prompt = await prampta.decode('PP-xxx', {
-    signal: controller.signal,
-  });
-} catch (err) {
-  if (err.message === 'Request was cancelled') {
-    console.log('Request cancelled');
+  await pg.assertAllowed("subject-id", { prompt: "...", modality: "image" });
+} catch (e) {
+  if (e instanceof PramptaRefusalError) {
+    // License denial — e.reason has the code (PG_NO_LICENSE, PG_SCOPE_VIOLATION, etc.)
+    console.log(e.reason);
+  } else if (e instanceof PramptaSignatureError) {
+    // Operator signature invalid — potential MITM
+    alert("Security: tampered decision");
   }
 }
 ```
 
-### Error Handling
-
-```typescript
-import { Prampta, PramptaError } from '@prampta/sdk';
-
-try {
-  const prompt = await prampta.decode('PP-invalid');
-} catch (err) {
-  if (err instanceof PramptaError) {
-    console.error(`API error ${err.status}: ${err.message}`);
-    
-    if (err.status === 404) {
-      console.log('Prompt not found');
-    } else if (err.status === 429) {
-      console.log('Rate limited, try again later');
-    } else if (err.status === 401) {
-      console.log('Invalid API key');
-    }
-  }
-}
-```
+## Pre-hashed Prompts
 
-## Types
+If you hash prompts yourself (e.g., for privacy), pass `promptHash` instead of `prompt`:
 
 ```typescript
-interface Prompt {
-  id: string;
-  ppCode: string;
-  title: string;
-  content: string;
-  category: string;
-  tags: string[];
-  authorName: string | null;
-  uses: number;
-  likes: number;
-  visibility: 'public' | 'private';
-  createdAt: number;
-  media?: Record<string, string>;
-}
-
-interface CreateOptions {
-  content: string;     // 10-50,000 characters
-  title?: string;      // Max 200 characters
-  media?: Record<string, string>; // Base64 data URLs
-}
-
-interface SearchOptions {
-  query?: string;
-  category?: 'development' | 'design' | 'marketing' | 'data' | 'writing' | 'business';
-  limit?: number;  // 1-100
-  page?: number;
-}
-```
+import { hashPrompt } from "@prampta/sdk";
 
-## Examples
-
-### With Express.js
-
-```typescript
-import express from 'express';
-import { Prampta } from '@prampta/sdk';
-
-const app = express();
-const prampta = new Prampta({ apiKey: process.env.PRAMPTA_API_KEY! });
-
-app.get('/prompt/:code', async (req, res) => {
-  try {
-    const prompt = await prampta.decode(req.params.code);
-    res.json(prompt);
-  } catch (err) {
-    res.status(err.status || 500).json({ error: err.message });
-  }
+const hash = await hashPrompt("Da Vinci in a documentary");
+const result = await pg.verify("leonardo-da-vinci", {
+  promptHash: hash,
+  modality: "image",
 });
 ```
 
-### With Next.js API Routes
-
-```typescript
-// app/api/prompts/route.ts
-import { NextResponse } from 'next/server';
-import { Prampta } from '@prampta/sdk';
-
-const prampta = new Prampta({ apiKey: process.env.PRAMPTA_API_KEY! });
-
-export async function GET(request: Request) {
-  const { searchParams } = new URL(request.url);
-  const query = searchParams.get('q') || '';
-  
-  const result = await prampta.search({ query });
-  return NextResponse.json(result);
-}
-```
-
-### Batch Operations
+## API Reference
 
-```typescript
-const codes = ['PP-xxx', 'PP-yyy', 'PP-zzz'];
+### `new Prampta(config)`
 
-// Parallel fetching with error handling
-const results = await Promise.allSettled(
-  codes.map(code => prampta.decode(code))
-);
+Creates a client instance.
 
-const prompts = results
-  .filter((r): r is PromiseFulfilledResult<Prompt> => r.status === 'fulfilled')
-  .map(r => r.value);
-```
+### `pg.verify(subjectId, options)`
 
-## Rate Limits
+Returns `Promise<SignedDecision>`:
+- `allowed` — generation authorized
+- `reason` — refusal code (`PG_NO_LICENSE`, `PG_SCOPE_VIOLATION`, `PG_SUBJECT_OPTED_OUT`)
+- `licenseId` — the authorizing license
+- `decisionId` — unique decision ID for audit
+- `obligations` — required obligations (attribution, watermark, etc.)
+- `operatorSignature` — Ed25519 signature over decision
 
-| Limit | Value |
-|-------|-------|
-| Requests per minute | 200 |
-| Requests per day | 5,000 |
-| Max prompt size | 50,000 chars |
-| Max media per prompt | 8 files |
-| Max media size | 2MB per file |
+### `pg.assertAllowed(subjectId, options)`
 
-The SDK automatically handles rate limiting with retries.
+Same as `verify()` but throws `PramptaRefusalError` if not allowed.
 
-## License
+### `pg.health()` / `pg.version()`
 
-MIT
+Registry health check and version info.