@larkup/marketplace 0.1.1

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.
package/CHANGELOG.md ADDED
@@ -0,0 +1,14 @@
1
+ # @larkup/marketplace
2
+
3
+ ## 0.1.1
4
+
5
+ ### Patch Changes
6
+
7
+ - 4e54939: feat: add doc-editor tool and canvas preview
8
+ - 8042a54: Index video and audio as multilingual timestamped evidence with adaptive sampling, complete-media notes, outcome-aware retrieval, and durable per-stage live progress.
9
+ - Updated dependencies [efc6810]
10
+ - Updated dependencies [5caaf2f]
11
+ - Updated dependencies [8042a54]
12
+ - Updated dependencies [843ef5c]
13
+ - Updated dependencies [b7bc6fe]
14
+ - @larkup/core@0.2.0
package/FUTURE_TODO.md ADDED
@@ -0,0 +1,131 @@
1
+ # Future Optimizations & Roadmap
2
+
3
+ ## Performance Optimizations
4
+
5
+ ### Bull/Redis Worker Queue
6
+ The current media processing uses in-process `worker_threads`. For production-scale workloads (processing 10,000+ images or long video files simultaneously), consider migrating to Bull + Redis:
7
+ - **Bull** provides persistent job queues with retry, priority, and rate limiting
8
+ - **Redis** as the backing store enables multi-process workers
9
+ - Jobs can survive server restarts
10
+ - Dashboard UI via Bull Board
11
+
12
+ ### Parallel Processing
13
+ - Process multiple media files in parallel with configurable concurrency
14
+ - Use sharp's pipeline mode for batch image thumbnailing
15
+ - Implement streaming upload for large video files
16
+
17
+ ---
18
+
19
+ ## Cloud Storage Providers
20
+
21
+ ### S3 Provider
22
+ ```typescript
23
+ class S3StorageProvider implements StorageProvider {
24
+ // Store files in S3 buckets
25
+ // Pre-signed URLs for secure serving
26
+ // Lifecycle policies for cost management
27
+ }
28
+ ```
29
+
30
+ ### UploadThing Provider
31
+ - Integrate with UploadThing for managed file uploads
32
+ - Automatic CDN distribution
33
+
34
+ ### Google Cloud Storage
35
+ - GCS bucket integration
36
+ - Cloud CDN for low-latency serving
37
+
38
+ ---
39
+
40
+ ## Marketplace Subscription System
41
+
42
+ ### Architecture
43
+ 1. **Remote Registry API** (Larkup Hub):
44
+ - Hosted tool catalog with versioning
45
+ - Subscription validation via license keys
46
+ - Usage metering and billing integration
47
+
48
+ 2. **Pricing Tiers**:
49
+ - `free`: Always available, no restrictions
50
+ - `pro`: Requires active subscription ($X/mo)
51
+ - `enterprise`: Custom pricing, SLA, priority support
52
+
53
+ 3. **Implementation**:
54
+ - `ToolDescriptor.requiresSubscription` flag
55
+ - License key validation on install
56
+ - Periodic subscription status check
57
+ - Graceful degradation on expiry (tool still installed but disabled)
58
+
59
+ ### Revenue Model Ideas
60
+ - Per-tool subscription (individual tool pricing)
61
+ - Bundle pricing (all pro tools for one price)
62
+ - Usage-based (pay per minute of video processed, per image captioned)
63
+ - Freemium with limits (e.g., 100 images free, then subscription)
64
+
65
+ ---
66
+
67
+ ## API Gateway / Proxy Server
68
+
69
+ ### Purpose
70
+ A centralized API gateway to power the marketplace at scale. Currently all tracking is local; this service would enable:
71
+ - **Remote tool registry** — serve tool manifests from a central catalog / CDN
72
+ - **Download/install count tracking** — server-side counters (not local-only)
73
+ - **Pricing & subscription validation** — free vs pro vs enterprise tier enforcement
74
+ - **License key verification** — validate paid tools on install
75
+ - **Tool version checks** — notify users of available updates
76
+ - **Rate limiting & abuse prevention** — protect against malicious installs
77
+ - **Analytics** — track tool popularity, usage patterns, error rates
78
+
79
+ ### Possible Stack
80
+ - **Hono on Cloudflare Workers** (lightweight, edge-deployed)
81
+ - **Alternatively**: Express/Fastify on a VPS, or a serverless function (Vercel/AWS Lambda)
82
+ - **Storage**: Turso (SQLite) or Planetscale for tool metadata + download counts
83
+ - **CDN**: Serve tool icon images via Cloudflare R2 or S3
84
+
85
+ ### Endpoints (Draft)
86
+ ```
87
+ GET /v1/tools → list all available tools
88
+ GET /v1/tools/:id → get tool details + download count
89
+ POST /v1/tools/:id/install → increment download counter
90
+ POST /v1/license/validate → validate license key for paid tools
91
+ GET /v1/tools/:id/icon → serve tool icon image from CDN
92
+ ```
93
+
94
+ ---
95
+
96
+ ## CLIP/SigLIP Native Embeddings
97
+
98
+ ### What It Enables
99
+ - Direct image-to-image similarity search
100
+ - Text-to-image search via shared embedding space
101
+ - No captioning needed for basic image retrieval
102
+
103
+ ### Implementation Path
104
+ 1. Integrate `open-clip-torch` or `@xenova/transformers` (JS)
105
+ 2. Add CLIP vector dimension alongside text embeddings in vector store
106
+ 3. Multi-vector index: text vectors + CLIP vectors
107
+ 4. Hybrid search: combine text similarity + visual similarity scores
108
+ 5. UI: drag-and-drop query image for visual search
109
+
110
+ ### Estimated Model Sizes
111
+ - ViT-B/32: ~340MB
112
+ - ViT-L/14: ~900MB
113
+ - SigLIP ViT-B/16: ~360MB (recommended for accuracy/speed tradeoff)
114
+
115
+ ---
116
+
117
+ ## Additional Future Features
118
+
119
+ ### Real-time Audio Transcription
120
+ - Stream microphone input directly to Whisper
121
+ - Live captioning and indexing during meetings/calls
122
+
123
+ ### Video Scene Segmentation
124
+ - AI-powered scene boundary detection
125
+ - Automatic chapter markers
126
+ - Per-scene captioning instead of fixed-interval frames
127
+
128
+ ### Batch Re-processing
129
+ - Re-caption all media when switching vision models
130
+ - Re-embed with different embedding model
131
+ - Bulk update metadata
package/LICENSE ADDED
@@ -0,0 +1,176 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
package/package.json ADDED
@@ -0,0 +1,23 @@
1
+ {
2
+ "name": "@larkup/marketplace",
3
+ "version": "0.1.1",
4
+ "publishConfig": {
5
+ "access": "public"
6
+ },
7
+ "type": "module",
8
+ "exports": {
9
+ "./types": "./src/types.ts",
10
+ "./registry": "./src/tool-registry.ts",
11
+ "./installer": "./src/tool-installer.ts",
12
+ "./loader": "./src/tool-loader.ts",
13
+ "./storage": "./src/storage-provider.ts",
14
+ "./manifest": "./src/tool-manifest.schema.ts"
15
+ },
16
+ "dependencies": {
17
+ "@larkup/core": "0.2.0"
18
+ },
19
+ "devDependencies": {
20
+ "@types/node": "^24",
21
+ "typescript": "5.7.3"
22
+ }
23
+ }
@@ -0,0 +1,147 @@
1
+ import { promises as fs } from 'node:fs';
2
+ import path from 'node:path';
3
+ import type { StorageProvider, StorageStats } from './types';
4
+ import { STORAGE_WARNING_THRESHOLDS } from './types';
5
+ import { getDataDir, requireDataDir } from '@larkup/core/workspace';
6
+
7
+ /**
8
+ * Local file-based storage provider for media assets.
9
+ *
10
+ * Stores files under `.larkup/servers/<activeServer>/media/`.
11
+ * Designed to be swappable with cloud providers (S3, UploadThing, GCS)
12
+ * in the future via the StorageProvider interface.
13
+ */
14
+
15
+ export class LocalStorageProvider implements StorageProvider {
16
+ readonly id = 'local';
17
+ readonly name = 'Local Storage';
18
+
19
+ private async mediaDir(): Promise<string> {
20
+ const dataDir = await requireDataDir();
21
+ const dir = path.join(dataDir, 'media');
22
+ await fs.mkdir(dir, { recursive: true });
23
+ return dir;
24
+ }
25
+
26
+ async store(key: string, data: Buffer, _mimeType: string): Promise<string> {
27
+ const dir = await this.mediaDir();
28
+ const filePath = path.join(dir, key);
29
+ // Ensure subdirectories exist (e.g., "thumbnails/abc.webp")
30
+ await fs.mkdir(path.dirname(filePath), { recursive: true });
31
+ await fs.writeFile(filePath, data);
32
+ return `local://${key}`;
33
+ }
34
+
35
+ async storeFile(key: string, sourcePath: string, _mimeType: string): Promise<string> {
36
+ const dir = await this.mediaDir();
37
+ const filePath = path.join(dir, key);
38
+ await fs.mkdir(path.dirname(filePath), { recursive: true });
39
+ await fs.copyFile(sourcePath, filePath);
40
+ return `local://${key}`;
41
+ }
42
+
43
+ async retrieve(uri: string): Promise<Buffer> {
44
+ const filePath = await this.resolvePath(uri);
45
+ if (!filePath) throw new Error(`Unsupported local storage URI: ${uri}`);
46
+ return fs.readFile(filePath);
47
+ }
48
+
49
+ async resolvePath(uri: string): Promise<string | undefined> {
50
+ if (!uri.startsWith('local://')) return undefined;
51
+ const key = uri.slice('local://'.length);
52
+ const dir = await this.mediaDir();
53
+ const filePath = path.resolve(dir, key);
54
+ const relative = path.relative(dir, filePath);
55
+ if (relative.startsWith('..') || path.isAbsolute(relative)) {
56
+ throw new Error('Invalid local storage URI');
57
+ }
58
+ return filePath;
59
+ }
60
+
61
+ async delete(uri: string): Promise<void> {
62
+ const key = uri.replace('local://', '');
63
+ const dir = await this.mediaDir();
64
+ try {
65
+ await fs.unlink(path.join(dir, key));
66
+ } catch {
67
+ // File may already be deleted
68
+ }
69
+ }
70
+
71
+ async stats(): Promise<StorageStats> {
72
+ try {
73
+ const dir = await this.mediaDir();
74
+ return await computeDirStats(dir);
75
+ } catch {
76
+ return { usedBytes: 0, fileCount: 0 };
77
+ }
78
+ }
79
+ }
80
+
81
+ /* ------------------------------------------------------------------ */
82
+ /* Helpers */
83
+ /* ------------------------------------------------------------------ */
84
+
85
+ async function computeDirStats(dir: string): Promise<StorageStats> {
86
+ let usedBytes = 0;
87
+ let fileCount = 0;
88
+
89
+ async function walk(d: string) {
90
+ let entries;
91
+ try {
92
+ entries = await fs.readdir(d, { withFileTypes: true });
93
+ } catch {
94
+ return;
95
+ }
96
+ for (const entry of entries) {
97
+ const full = path.join(d, entry.name);
98
+ if (entry.isDirectory()) {
99
+ await walk(full);
100
+ } else {
101
+ try {
102
+ const stat = await fs.stat(full);
103
+ usedBytes += stat.size;
104
+ fileCount++;
105
+ } catch {
106
+ // skip
107
+ }
108
+ }
109
+ }
110
+ }
111
+
112
+ await walk(dir);
113
+ return { usedBytes, fileCount };
114
+ }
115
+
116
+ /**
117
+ * Format bytes for human display.
118
+ */
119
+ export function formatBytes(bytes: number): string {
120
+ if (bytes < 1024) return `${bytes} B`;
121
+ if (bytes < 1024 * 1024) return `${(bytes / 1024).toFixed(1)} KB`;
122
+ if (bytes < 1024 * 1024 * 1024) return `${(bytes / (1024 * 1024)).toFixed(1)} MB`;
123
+ return `${(bytes / (1024 * 1024 * 1024)).toFixed(2)} GB`;
124
+ }
125
+
126
+ /**
127
+ * Check if storage usage exceeds any warning threshold.
128
+ * Returns the highest exceeded threshold or null.
129
+ */
130
+ export function getStorageWarningLevel(usedBytes: number): number | null {
131
+ for (let i = STORAGE_WARNING_THRESHOLDS.length - 1; i >= 0; i--) {
132
+ if (usedBytes >= STORAGE_WARNING_THRESHOLDS[i]) {
133
+ return STORAGE_WARNING_THRESHOLDS[i];
134
+ }
135
+ }
136
+ return null;
137
+ }
138
+
139
+ /**
140
+ * Factory: create the appropriate storage provider from config.
141
+ * For now, always returns LocalStorageProvider. Designed for future
142
+ * expansion to S3, UploadThing, GCS, etc.
143
+ */
144
+ export function createStorageProvider(_config?: Record<string, any>): StorageProvider {
145
+ // Future: switch on config.provider to create S3Provider, etc.
146
+ return new LocalStorageProvider();
147
+ }