npm - @secretpdf/sdk - Versions diffs - 1.0.0 - Mend

@secretpdf/sdk 1.0.0

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 (403) hide show

package/dist/client.js ADDED Viewed

@@ -0,0 +1,273 @@
+import { Configuration, AuthenticationApi, DocumentsApi, TemplatesApi, } from './api/index';
+/**
+ * Main Secret PDF SDK Client
+ *
+ * @example
+ * ```typescript
+ * import { SecretPDFClient } from '@secretpdf/sdk';
+ *
+ * const client = new SecretPDFClient({
+ *   apiKey: 'your-api-key'
+ * });
+ *
+ * // Generate a PDF
+ * const result = await client.generate({
+ *   templateId: 'template-123',
+ *   data: { name: 'John' }
+ * });
+ * ```
+ */
+export class SecretPDFClient {
+    /**
+     * Creates a new Secret PDF client instance
+     *
+     * @param options - Configuration options for the client
+     */
+    constructor(options = {}) {
+        const { apiKey, accessToken, headers, fetchApi, credentials, } = options;
+        this.config = new Configuration({
+            basePath: 'https://api.secretpdf.io',
+            apiKey,
+            accessToken,
+            headers,
+            fetchApi,
+            credentials,
+        });
+        // Initialize API clients
+        this.auth = new AuthenticationApi(this.config);
+        this.documentsApi = new DocumentsApi(this.config);
+        this.templatesApi = new TemplatesApi(this.config);
+    }
+    /**
+     * Generate a PDF document from a template
+     *
+     * @param templateId - ID of the stored template to use
+     * @param data - Data to inject into the template
+     * @param storage - Optional storage configuration
+     * @param returnFile - If true, return PDF in response (default: true)
+     * @param sandbox - If true, add SECRET watermark and charge 0 credits
+     * @returns Promise with the generated document response
+     *
+     * @example
+     * ```typescript
+     * const result = await client.generate({
+     *   templateId: 'template-123',
+     *   data: { customerName: 'John Doe', amount: 100 }
+     * });
+     * ```
+     */
+    async generate(params) {
+        return this.documentsApi.generateDocument({
+            generateDocumentRequest: {
+                templateId: params.templateId,
+                data: params.data,
+                storage: params.storage,
+                returnFile: params.returnFile,
+                sandbox: params.sandbox,
+            }
+        });
+    }
+    /**
+     * Get overall generation statistics
+     *
+     * @returns Promise with generation statistics
+     *
+     * @example
+     * ```typescript
+     * const stats = await client.getGenerationStats();
+     * console.log(stats.stats);
+     * ```
+     */
+    async getGenerationStats() {
+        return this.documentsApi.getGenerationStats();
+    }
+    /**
+     * Get usage statistics
+     *
+     * @returns Promise with usage statistics
+     *
+     * @example
+     * ```typescript
+     * const usage = await client.getUsageStats();
+     * console.log(usage.stats);
+     * ```
+     */
+    async getUsageStats() {
+        return this.documentsApi.getUsageStats();
+    }
+    /**
+     * List generation records with pagination
+     *
+     * @param page - Page number (default: 1)
+     * @param limit - Items per page (default: 50)
+     * @returns Promise with generation records
+     *
+     * @example
+     * ```typescript
+     * const records = await client.listGenerationRecords({ page: 1, limit: 10 });
+     * ```
+     */
+    async listGenerationRecords(params) {
+        return this.documentsApi.listGenerationRecords({
+            page: params?.page,
+            limit: params?.limit,
+        });
+    }
+    /**
+     * Create a new HTML template
+     *
+     * @param templateContent - HTML template content (required)
+     * @param templateName - Name of the template
+     * @param templateSize - Page size (e.g., A4, Letter, 100mm|100mm)
+     * @returns Promise with created template
+     *
+     * @example
+     * ```typescript
+     * const template = await client.createTemplate({
+     *   templateContent: '<html><body>{{content}}</body></html>',
+     *   templateName: 'Invoice Template',
+     *   templateSize: 'A4'
+     * });
+     * ```
+     */
+    async createTemplate(params) {
+        return this.templatesApi.createTemplate({
+            createTemplateRequest: {
+                templateContent: params.templateContent,
+                templateName: params.templateName,
+                templateSize: params.templateSize,
+            }
+        });
+    }
+    /**
+     * List all templates
+     *
+     * @returns Promise with list of templates
+     *
+     * @example
+     * ```typescript
+     * const templates = await client.listTemplates();
+     * ```
+     */
+    async listTemplates() {
+        return this.templatesApi.listTemplates();
+    }
+    /**
+     * Get a specific template by ID
+     *
+     * @param templateId - The template ID
+     * @returns Promise with template details
+     *
+     * @example
+     * ```typescript
+     * const template = await client.getTemplate('template-123');
+     * ```
+     */
+    async getTemplate(templateId) {
+        return this.templatesApi.getTemplate({ templateId });
+    }
+    /**
+     * Update an existing template
+     *
+     * @param templateId - The template ID
+     * @param templateContent - New HTML content
+     * @param templateName - New template name
+     * @param templateSize - New page size
+     * @returns Promise with updated template
+     *
+     * @example
+     * ```typescript
+     * const updated = await client.updateTemplate({
+     *   templateId: 'template-123',
+     *   templateName: 'Updated Invoice',
+     *   templateContent: '<html>...</html>'
+     * });
+     * ```
+     */
+    async updateTemplate(params) {
+        return this.templatesApi.updateTemplate({
+            templateId: params.templateId,
+            updateTemplateRequest: {
+                templateContent: params.templateContent,
+                templateName: params.templateName,
+                templateSize: params.templateSize,
+            }
+        });
+    }
+    /**
+     * Delete a template
+     *
+     * @param templateId - The template ID to delete
+     * @returns Promise with deletion response
+     *
+     * @example
+     * ```typescript
+     * await client.deleteTemplate('template-123');
+     * ```
+     */
+    async deleteTemplate(templateId) {
+        await this.templatesApi.deleteTemplate({ templateId });
+    }
+    /**
+     * Generate a template from a PDF file
+     *
+     * @param file - The PDF file as a Blob
+     * @returns Promise with generated template
+     *
+     * @example
+     * ```typescript
+     * const file = new Blob([pdfData], { type: 'application/pdf' });
+     * const template = await client.generateTemplateFromPdf(file);
+     * ```
+     */
+    async generateTemplateFromPdf(file) {
+        return this.templatesApi.generateTemplateFromPdf({ file });
+    }
+    /**
+     * Generate a template from a text prompt using AI
+     *
+     * @param prompt - Description of the desired template
+     * @param params - Data fields that will be used as placeholders
+     * @param templateName - Optional name for the generated template
+     * @returns Promise with generated template
+     *
+     * @example
+     * ```typescript
+     * const template = await client.generateTemplateFromPrompt({
+     *   prompt: 'Create an invoice template with header and items table',
+     *   params: { customerName: '', items: [], total: '' },
+     *   templateName: 'AI Invoice Template'
+     * });
+     * ```
+     */
+    async generateTemplateFromPrompt(params) {
+        return this.templatesApi.generateTemplateFromPrompt({
+            generateTemplateFromPromptRequest: {
+                prompt: params.prompt,
+                params: params.params,
+                templateName: params.templateName,
+            }
+        });
+    }
+    /**
+     * Update the client configuration
+     *
+     * @param options - New configuration options
+     */
+    updateConfig(options) {
+        const currentConfig = this.config;
+        this.config = new Configuration({
+            basePath: 'https://api.secretpdf.io',
+            apiKey: options.apiKey !== undefined ? options.apiKey : currentConfig.apiKey?.(''),
+            accessToken: options.accessToken !== undefined ? options.accessToken : currentConfig.accessToken?.(),
+            headers: options.headers || currentConfig.headers,
+            fetchApi: options.fetchApi || currentConfig.fetchApi,
+            credentials: options.credentials || currentConfig.credentials,
+        });
+        // Re-initialize all API clients with new config
+        this.auth['configuration'] = this.config;
+        this.documentsApi['configuration'] = this.config;
+        this.templatesApi['configuration'] = this.config;
+    }
+}
+//# sourceMappingURL=client.js.map

package/dist/client.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,aAAa,EACb,iBAAiB,EACjB,YAAY,EACZ,YAAY,GACb,MAAM,aAAa,CAAC;AA4DrB;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,OAAO,eAAe;IAU1B;;;;OAIG;IACH,YAAY,UAAkC,EAAE;QAC9C,MAAM,EACJ,MAAM,EACN,WAAW,EACX,OAAO,EACP,QAAQ,EACR,WAAW,GACZ,GAAG,OAAO,CAAC;QAEZ,IAAI,CAAC,MAAM,GAAG,IAAI,aAAa,CAAC;YAC9B,QAAQ,EAAE,0BAA0B;YACpC,MAAM;YACN,WAAW;YACX,OAAO;YACP,QAAQ;YACR,WAAW;SACZ,CAAC,CAAC;QAEH,yBAAyB;QACzB,IAAI,CAAC,IAAI,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC/C,IAAI,CAAC,YAAY,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAClD,IAAI,CAAC,YAAY,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,QAAQ,CAAC,MAMd;QACC,OAAO,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC;YACxC,uBAAuB,EAAE;gBACvB,UAAU,EAAE,MAAM,CAAC,UAAU;gBAC7B,IAAI,EAAE,MAAM,CAAC,IAAI;gBACjB,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,UAAU,EAAE,MAAM,CAAC,UAAU;gBAC7B,OAAO,EAAE,MAAM,CAAC,OAAO;aACxB;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,kBAAkB;QACtB,OAAO,IAAI,CAAC,YAAY,CAAC,kBAAkB,EAAE,CAAC;IAChD,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,aAAa;QACjB,OAAO,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,CAAC;IAC3C,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,qBAAqB,CAAC,MAG3B;QACC,OAAO,IAAI,CAAC,YAAY,CAAC,qBAAqB,CAAC;YAC7C,IAAI,EAAE,MAAM,EAAE,IAAI;YAClB,KAAK,EAAE,MAAM,EAAE,KAAK;SACrB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,cAAc,CAAC,MAIpB;QACC,OAAO,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC;YACtC,qBAAqB,EAAE;gBACrB,eAAe,EAAE,MAAM,CAAC,eAAe;gBACvC,YAAY,EAAE,MAAM,CAAC,YAAY;gBACjC,YAAY,EAAE,MAAM,CAAC,YAAY;aAClC;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,aAAa;QACjB,OAAO,IAAI,CAAC,YAAY,CAAC,aAAa,EAAE,CAAC;IAC3C,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,WAAW,CAAC,UAAkB;QAClC,OAAO,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;IACvD,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,cAAc,CAAC,MAKpB;QACC,OAAO,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC;YACtC,UAAU,EAAE,MAAM,CAAC,UAAU;YAC7B,qBAAqB,EAAE;gBACrB,eAAe,EAAE,MAAM,CAAC,eAAe;gBACvC,YAAY,EAAE,MAAM,CAAC,YAAY;gBACjC,YAAY,EAAE,MAAM,CAAC,YAAY;aAClC;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,cAAc,CAAC,UAAkB;QACrC,MAAM,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,uBAAuB,CAAC,IAAU;QACtC,OAAO,IAAI,CAAC,YAAY,CAAC,uBAAuB,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,0BAA0B,CAAC,MAIhC;QACC,OAAO,IAAI,CAAC,YAAY,CAAC,0BAA0B,CAAC;YAClD,iCAAiC,EAAE;gBACjC,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,YAAY,EAAE,MAAM,CAAC,YAAY;aAClC;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,YAAY,CAAC,OAAwC;QACnD,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC;QAElC,IAAI,CAAC,MAAM,GAAG,IAAI,aAAa,CAAC;YAC9B,QAAQ,EAAE,0BAA0B;YACpC,MAAM,EAAE,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,MAAM,EAAE,CAAC,EAAE,CAAC;YAClF,WAAW,EAAE,OAAO,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,aAAa,CAAC,WAAW,EAAE,EAAE;YACpG,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,aAAa,CAAC,OAAO;YACjD,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,aAAa,CAAC,QAAQ;YACpD,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,aAAa,CAAC,WAAW;SAC9D,CAAC,CAAC;QAEH,gDAAgD;QAChD,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;QACzC,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;QACjD,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;IACnD,CAAC;CACF"}

package/dist/index.d.ts ADDED Viewed

@@ -0,0 +1,10 @@
+/**
+ * Secret PDF SDK
+ *
+ * A TypeScript/JavaScript SDK for the Secret PDF API.
+ * Generate PDFs from HTML templates with AI assistance.
+ */
+export * from './api/index';
+export { SecretPDFClient } from './client';
+export type { SecretPDFConfig, SecretPDFClientOptions } from './client';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,cAAc,aAAa,CAAC;AAG5B,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAG3C,YAAY,EACV,eAAe,EACf,sBAAsB,EACvB,MAAM,UAAU,CAAC"}

package/dist/index.js ADDED Viewed

@@ -0,0 +1,11 @@
+/**
+ * Secret PDF SDK
+ *
+ * A TypeScript/JavaScript SDK for the Secret PDF API.
+ * Generate PDFs from HTML templates with AI assistance.
+ */
+// Export all API classes and types from the generated API
+export * from './api/index';
+// Export the main SDK client class
+export { SecretPDFClient } from './client';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,0DAA0D;AAC1D,cAAc,aAAa,CAAC;AAE5B,mCAAmC;AACnC,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC"}

package/package.json ADDED Viewed

@@ -0,0 +1,49 @@
+{
+  "name": "@secretpdf/sdk",
+  "version": "1.0.0",
+  "description": "TypeScript/JavaScript SDK for Secret PDF API - Generate PDFs from HTML templates in one api call.",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "npm run build",
+    "sdk": "rimraf ./src/api && openapi-generator-cli generate -i http://localhost:8080/documentation/json -g typescript-fetch -o ./src/api",
+    "clean": "rimraf ./dist"
+  },
+  "keywords": [
+    "pdf",
+    "pdf-generation",
+    "html-to-pdf",
+    "typescript",
+    "sdk",
+    "api-client",
+    "secretpdf"
+  ],
+  "author": "",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/SecretPDF/secretpdf-js-sdk"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "@openapitools/openapi-generator-cli": "^2.21.2",
+    "rimraf": "^6.0.1",
+    "typescript": "^5.7.2"
+  }
+}